feat: NodeJS SDK (#3723)

* Move gulp over to TS and use src for builds

* Fix gulpfiles

* WIP: Move to @browserless.io/browserless for self-packages

* WIP: Moving to more npm like imports

* Fix npm run build

* Fixes for object init

* WIP: Dev build

* Consolidate build tools, remove gulp, cleanup root

* Fix links and docker builds

* Fix final build scripts

* Fix bad build command

* Fix puppeteer on latest, clean npm fixes and building functions

* More work on enabling better NodeJS SDK devex

* Dev command done!

* Fix module import in browserless

* WIP Docker for sdk

* Remove pw install path from app_dir

* Move playwright browsers into accessible location

* Updating SDK dockerfile

* Add prepare task to build project for npm

* Move to prepack vs prepare

* 2.0.0-beta-1

* Add in Token class, build upon docker commands, arg parsing

* Import any token overrides

* Refactor out router to be extensible, private -> protected members

* Refactor to make route modules more elegant, docs

* 2.0.0-beta-2

* Fix file:/ in package.json

* 2.0.0-beta-3

* Re-fix baseURL for downstream packages

* 2.0.0-beta-4

* Fix exporting @browserless.io namespace

* 2.0.0-beta-5

* Drop nodemon

* Drop nodemon from package-lock

* Make scanning for routes recursive

* Refactor to Class-based syntax for Routes + docs and scaffolding

* More work on docs for SDK

* More work on docs and READMEs

* 2.0.0-beta-6

* Add types and update package dependency

* Make sure to use the included version of the package.json

* Fix npm install promises not awaiting

* 2.0.0-beta-7

* Enable debugging for CLI usage by default

* 2.0.0-beta-8

* Add link in main readme to SDK README

Author: joelgriffith

.env.test

@@ -15,4 +15,4 @@ jobs:
       run: docker build --build-arg VERSION=latest -f ./docker/chrome/Dockerfile -t ghcr.io/browserless/chrome:latest .
 
     - name: Test the Chrome image
-      run: docker run --ipc=host -e CI=true --entrypoint ./test.sh ghcr.io/browserless/chrome:latest
+      run: docker run --ipc=host -e CI=true --entrypoint ./scripts/test.sh ghcr.io/browserless/chrome:latest

.eslintrc

@@ -15,4 +15,4 @@ jobs:
       run: docker build --build-arg VERSION=latest -f ./docker/firefox/Dockerfile -t ghcr.io/browserless/firefox:latest .
 
     - name: Test the Firefox image
-      run: docker run --ipc=host -e CI=true --entrypoint ./test.sh ghcr.io/browserless/firefox:latest
+      run: docker run --ipc=host -e CI=true --entrypoint ./scripts/test.sh ghcr.io/browserless/firefox:latest

.github/workflows/docker-chromium.yml

@@ -15,4 +15,4 @@ jobs:
       run: docker build --build-arg VERSION=latest -f ./docker/multi/Dockerfile -t ghcr.io/browserless/multi:latest .
 
     - name: Test the multi image
-      run: docker run --ipc=host -e CI=true --entrypoint ./test.sh ghcr.io/browserless/multi:latest
+      run: docker run --ipc=host -e CI=true --entrypoint ./scripts/test.sh ghcr.io/browserless/multi:latest

.github/workflows/docker-firefox.yml

@@ -15,4 +15,4 @@ jobs:
       run: docker build --build-arg VERSION=latest -f ./docker/webkit/Dockerfile -t ghcr.io/browserless/webkit:latest .
 
     - name: Test the Webkit image
-      run: docker run --ipc=host -e CI=true --entrypoint ./test.sh ghcr.io/browserless/webkit:latest
+      run: docker run --ipc=host -e CI=true --entrypoint ./scripts/test.sh ghcr.io/browserless/webkit:latest

.github/workflows/docker-multi.yml

@@ -6,6 +6,9 @@ browser.json
 metrics.json
 extensions/ublock
 
+# npm pack
+browserless.io-browserless-*.tgz
+
 # MAC
 .DS_Store
 

.github/workflows/docker-webkit.yml

@@ -1,5 +1,5 @@
 Browserless
-(c) 2022, browserless.io
+(c) 2023, browserless.io
 
 This project includes code from GitHub user "wanhose", from their "Cookie
 Dialog Monster" project, under the MIT License.

.gitignore

@@ -15,7 +15,7 @@ Browserless allows remote clients to connect and execute headless work, all insi
 
 We take care of common issues such as missing system-fonts, missing external libraries, and performance improvements, along with edge-cases like downloading files and managing sessions. For details, check out the documentation site built into the project which includes Open API docs.
 
-If you've been struggling to deploy headless browsers without running into issues or bloated resource requirements, then Browserless was built for you. Run the browsers in [our cloud](https://browserless.io/) or your own, [free for non-commercial uses](https://github.com/browserless/browserless#licensing). 
+If you've been struggling to deploy headless browsers without running into issues or bloated resource requirements, then Browserless was built for you. Run the browsers in [our cloud](https://browserless.io/) or your own, [free for non-commercial uses](https://github.com/browserless/browserless#licensing).
 # Table of Contents
 
 1. [Features](#features)
@@ -24,8 +24,9 @@ If you've been struggling to deploy headless browsers without running into issue
 4. [Hosting](#hosting-providers)
 5. [Puppeteer](#puppeteer)
 6. [Playwright](#playwright)
-7. [Licensing](#licensing)
-8. [Changelog](https://github.com/browserless/chrome/blob/master/CHANGELOG.md)
+7. [Extending with NodeJS SDK](#extending-nodejs-skd)
+8. [Licensing](#licensing)
+9. [Changelog](https://github.com/browserless/chrome/blob/master/CHANGELOG.md)
 
 ## External links
 
@@ -102,6 +103,10 @@ const browser = await pw.chromium.connectOverCDP('ws://localhost:3000');
 
 After that, the rest of your code remains the same with no other changes required.
 
+# Extending (NodeJS SKD)
+
+Browserless comes with built-in extension capabilities, and allows for extending nearly any aspect of the system (for Version 2+). For more details on how to write your own routes, build docker images, and more, [see our SDK README.md](/bin/scaffold/README.md) or simply run "npx @browserless.io/browserless create" in a terminal and follow the onscreen prompts.
+
 # Usage with other libraries
 
 Most libraries allow you to specify a remote instance of Chrome to interact with. They are either looking for a websocket endpoint, a host and port, or some address. Browserless supports these by default, however if you're having issues please make an issue in this project and we'll try and work with the library authors to get them integrated with browserless. Please note that in V2 we no longer support selenium or webdriver integrations.