@browserless.io/browserless 2.30.0 → 2.30.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserless.io/browserless",
-  "version": "2.30.0",
+  "version": "2.30.1",
   "license": "SSPL",
   "description": "The browserless platform",
   "author": "browserless.io",
@@ -48,7 +48,7 @@
     "tsconfig.json"
   ],
   "dependencies": {
-    "debug": "^4.4.0",
+    "debug": "^4.4.1",
     "del": "^8.0.0",
     "enjoi": "^9.0.1",
     "file-type": "^20.5.0",
@@ -76,7 +76,7 @@
     "@types/http-proxy": "^1.17.16",
     "@types/micromatch": "^4.0.9",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^22.15.17",
+    "@types/node": "^22.15.18",
     "@types/sinon": "^17.0.4",
     "@typescript-eslint/eslint-plugin": "^8.32.1",
     "@typescript-eslint/parser": "^8.32.1",

package/scripts/build-open-api.js

@@ -108,9 +108,10 @@ const buildOpenAPI = async (
         const query = routeModule.replace('.js', '.query.json');
         const response = routeModule.replace('.js', '.response.json');
         const isWebSocket = routeModule.includes('/ws/') || name.endsWith('ws');
-        const path = (
-          Array.isArray(route.path) ? route.path.join(' ') : route.path
-        ).replace(/\?\(\/\)/g, '');
+        const paths = (Array.isArray(route.path) ? route.path : [route.path])
+          .sort((a, b) => b.length - a.length)
+          .map((p) => p.replace(/\?\(\/\)/g, ''));
+        const [path, ...alternativePaths] = paths;
 
         const {
           tags,
@@ -122,12 +123,23 @@ const buildOpenAPI = async (
           title,
         } = route;
 
+        const routeDocs = [description];
+
+        if (alternativePaths.length > 0) {
+          const altPathsText = alternativePaths
+            .map((p) => `\`${p}\``)
+            .join(', ');
+
+          const compatNote = `**Note:** This endpoint is also available at: ${altPathsText} for backwards compatibility.`;
+          routeDocs.push(compatNote);
+        }
+        console.log(alternativePaths.length, routeDocs);
         return {
           accepts,
           auth,
           body: isWebSocket ? null : JSON.parse(await readFileOrNull(body)),
           contentTypes,
-          description,
+          description: routeDocs.join('\n\n'),
           isWebSocket,
           method,
           path,

package/src/limiter.ts

@@ -139,7 +139,10 @@ export class Limiter extends q {
       req: job.args[0],
       start: job.start,
       status: 'error',
-      error: error instanceof Error ? error : new Error(error?.toString() ?? 'Unknown Error'),
+      error:
+        error instanceof Error
+          ? error
+          : new Error(error?.toString() ?? 'Unknown Error'),
     } as AfterResponse);
   }
 
@@ -203,7 +206,9 @@ export class Limiter extends q {
           const concurrencyLimit = this.concurrency;
           const queueLimit = this.queued;
           return rej(
-            new TooManyRequests(`Concurrency limit of ${concurrencyLimit} and queue limit of ${queueLimit} reached. Possible causes: 1) Your token has reached maximum capacity, 2) Your token may not have access to this version, 3) Your requests are coming too quickly.`),
+            new TooManyRequests(
+              `Concurrency limit of ${concurrencyLimit} and queue limit of ${queueLimit} reached. Possible causes: 1) Your token has reached maximum capacity, 2) Your token may not have access to this version, 3) Your requests are coming too quickly.`,
+            ),
           );
         }