@browserless.io/browserless 2.3.0-beta-2 → 2.4.0-beta-1

package/CHANGELOG.md

@@ -1,4 +1,12 @@
-# [Latest](https://github.com/browserless/chrome/compare/v2.2.0...main)
+# [Latest](https://github.com/browserless/chrome/compare/v2.3.0...main)
+- Dependency updates.
+
+# [v2.3.0](https://github.com/browserless/chrome/compare/v2.2.0...v2.3.0)
+**Potentially Breaking**
+- Routes must define a unique `name` property in order to remove them in SDK projects.
+- A new `browserless` object in the SDK `package.json` file can specify module overrides, in camelCase, instead of using a path-based semantic.
+- Fixes issues with `npx playwright-core install...` potentially installing other browser versions than what is a dependency of Browserless.
+- Fixes and other general improvements.
 - Dependency updates.
 
 # [v2.2.0](https://github.com/browserless/chrome/compare/v2.1.0...v2.2.0)

package/bin/browserless.js

@@ -319,6 +319,8 @@ const start = async (dev = false) => {
     webhooks,
   });
 
+  browserless.setStaticSDKDir(path.join(projectDir, 'static'));
+
   if (disabledRoutes !== undefined) {
     if (!Array.isArray(disabledRoutes)) {
       throw new Error(

package/bin/scaffold/README.md

@@ -13,7 +13,8 @@ Finally, this SDK and Browserless.io are built to support businesses and enterpr
 - [Routing](#routing)
 - [Utilities](#utilities)
 - [Extending Modules](#extending-modules)
-- [Disabling Routes](#dis)
+- [Disabling Routes](#disabling-routes)
+- [Serving Static Files](#serving-static-files)
 - [Running in Development](#running-in-development)
 - [Building for Production](#building-for-production)
 - [Running without Building](#running-without-building)
@@ -397,6 +398,28 @@ Disabling a route will do several things:
 
 All of Browserless' internal routes are side-effect free, meaning their largely state-less and don't do exhibit kind of behavior aside from route handling and metrics reporting. Having them in Node's module cache is fine since they're never mounted in the router and set up as a potential route.
 
+## Serving Static Files
+
+Aside from the static files Browserless serves for documentation, and a few other APIs, SDK projects can also provide static files to be served. To do so, simply create a "static" directory in the root of your project with the files you wish to serve. These will then be served based upon their location in the directory and the file name. Unless that is, of course, you've disabled the static route. Don't be silly.
+
+Care should be taken _not_ to create the same filenames that Browserless serves and uses as internal static files takes precedence over SDK files. In short, the list is:
+
+- `assets/*`
+- `devtools/*`
+- `docs/*`
+- `function/*`
+- `favicon-32x32.png`
+
+Anything else is fair game and will be served properly. An easy way to "scope" files into a path is to simply create a subpath, for instance:
+
+`static/enterprise/docs`
+
+Will be available to be served under:
+
+`http://YOUR-HOST:YOUR-PORT/enterprise/docs`
+
+Which prevents this route from colliding with our internal `/docs` route.
+
 ## Running in Development
 
 After the project has been set up, you can use npm commands to build and run your code. The most important of these is the `npm run dev` command, which will do the following:

package/build/browserless.d.ts

@@ -12,6 +12,7 @@ export declare class Browserless {
     protected router: Router;
     protected token: Token;
     protected webhooks: WebHooks;
+    protected staticSDKDir: string | null;
     disabledRouteNames: string[];
     webSocketRouteFiles: string[];
     httpRouteFiles: string[];
@@ -32,6 +33,7 @@ export declare class Browserless {
     protected saveMetrics: () => Promise<void>;
     setMetricsSaveInterval: (interval: number) => void;
     private routeIsDisabled;
+    setStaticSDKDir(dir: string): void;
     disableRoutes(...routeNames: string[]): void;
     addHTTPRoute(httpRouteFilePath: string): void;
     addWebSocketRoute(webSocketRouteFilePath: string): void;

package/build/browserless.js

@@ -14,6 +14,7 @@ export class Browserless {
     router;
     token;
     webhooks;
+    staticSDKDir = null;
     disabledRouteNames = [];
     webSocketRouteFiles = [];
     httpRouteFiles = [];
@@ -73,6 +74,9 @@ export class Browserless {
     routeIsDisabled(route) {
         return this.disabledRouteNames.some((name) => name === route.name);
     }
+    setStaticSDKDir(dir) {
+        this.staticSDKDir = dir;
+    }
     disableRoutes(...routeNames) {
         this.disabledRouteNames.push(...routeNames);
     }
@@ -121,7 +125,7 @@ export class Browserless {
                 const routeImport = `${this.config.getIsWin() ? 'file:///' : ''}${httpRoute}`;
                 const logger = createLogger(`http:${name}`);
                 const { default: Route, } = await import(routeImport + `?cb=${Date.now()}`);
-                const route = new Route(this.browserManager, this.config, this.fileSystem, logger, this.metrics, this.monitoring);
+                const route = new Route(this.browserManager, this.config, this.fileSystem, logger, this.metrics, this.monitoring, this.staticSDKDir);
                 if (!this.routeIsDisabled(route)) {
                     route.bodySchema = safeParse(bodySchema);
                     route.querySchema = safeParse(querySchema);
@@ -130,6 +134,7 @@ export class Browserless {
                     route.monitoring = () => this.monitoring;
                     route.fileSystem = () => this.fileSystem;
                     route.debug = () => logger;
+                    route.staticSDKDir = () => this.staticSDKDir;
                     httpRoutes.push(route);
                 }
             }
@@ -149,7 +154,7 @@ export class Browserless {
                 const wsImport = `${this.config.getIsWin() ? 'file:///' : ''}${wsRoute}`;
                 const logger = createLogger(`ws:${name}`);
                 const { default: Route, } = await import(wsImport + `?cb=${Date.now()}`);
-                const route = new Route(this.browserManager, this.config, this.fileSystem, logger, this.metrics, this.monitoring);
+                const route = new Route(this.browserManager, this.config, this.fileSystem, logger, this.metrics, this.monitoring, this.staticSDKDir);
                 if (!this.routeIsDisabled(route)) {
                     route.querySchema = safeParse(querySchema);
                     route.config = () => this.config;
@@ -157,6 +162,7 @@ export class Browserless {
                     route.monitoring = () => this.monitoring;
                     route.fileSystem = () => this.fileSystem;
                     route.debug = () => logger;
+                    route.staticSDKDir = () => this.staticSDKDir;
                     wsRoutes.push(route);
                 }
             }