@browserless.io/browserless 2.34.0-beta-0 → 2.34.1

package/build/routes/edge/http/content.post.body.json

@@ -86,7 +86,24 @@
             "type": "string"
           },
           "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+              "headers": {
+                "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
+                "$ref": "#/definitions/Record<string,unknown>"
+              },
+              "status": {
+                "type": "number"
+              },
+              "contentType": {
+                "type": "string"
+              },
+              "body": {
+                "description": "A string representation of the body to return. Can be a base64-encoded\nstring but please omit any leading content-type data (eg \"data:image/png;base64,\").",
+                "type": "string"
+              }
+            }
           }
         },
         "additionalProperties": false,
@@ -425,118 +442,10 @@
         "reason"
       ]
     },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@324755": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@324755",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Record<string,unknown>": {
       "type": "object",
       "additionalProperties": false
     },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@324755": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@324755",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@334238": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@324755": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@334238",
-        "__@toStringTag@324755",
-        "byteLength"
-      ]
-    },
     "Record<string,string>": {
       "type": "object",
       "additionalProperties": false

package/build/routes/edge/http/pdf.post.body.json

@@ -89,7 +89,24 @@
             "type": "string"
           },
           "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+              "headers": {
+                "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
+                "$ref": "#/definitions/Record<string,unknown>"
+              },
+              "status": {
+                "type": "number"
+              },
+              "contentType": {
+                "type": "string"
+              },
+              "body": {
+                "description": "A string representation of the body to return. Can be a base64-encoded\nstring but please omit any leading content-type data (eg \"data:image/png;base64,\").",
+                "type": "string"
+              }
+            }
           }
         },
         "additionalProperties": false,
@@ -570,118 +587,10 @@
       },
       "additionalProperties": false
     },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@563136": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@563136",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Record<string,unknown>": {
       "type": "object",
       "additionalProperties": false
     },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@563136": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@563136",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@572642": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@563136": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@572642",
-        "__@toStringTag@563136",
-        "byteLength"
-      ]
-    },
     "Record<string,string>": {
       "type": "object",
       "additionalProperties": false

package/build/routes/edge/http/scrape.post.body.json

@@ -95,7 +95,24 @@
             "type": "string"
           },
           "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+              "headers": {
+                "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
+                "$ref": "#/definitions/Record<string,unknown>"
+              },
+              "status": {
+                "type": "number"
+              },
+              "contentType": {
+                "type": "string"
+              },
+              "body": {
+                "description": "A string representation of the body to return. Can be a base64-encoded\nstring but please omit any leading content-type data (eg \"data:image/png;base64,\").",
+                "type": "string"
+              }
+            }
           }
         },
         "additionalProperties": false,
@@ -472,118 +489,10 @@
         "reason"
       ]
     },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@451852": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@451852",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Record<string,unknown>": {
       "type": "object",
       "additionalProperties": false
     },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@451852": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@451852",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@461345": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@451852": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@461345",
-        "__@toStringTag@451852",
-        "byteLength"
-      ]
-    },
     "Record<string,string>": {
       "type": "object",
       "additionalProperties": false

package/build/routes/edge/http/screenshot.post.body.json

@@ -89,7 +89,24 @@
             "type": "string"
           },
           "response": {
-            "$ref": "#/definitions/Partial<ResponseForRequest>"
+            "additionalProperties": false,
+            "type": "object",
+            "properties": {
+              "headers": {
+                "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
+                "$ref": "#/definitions/Record<string,unknown>"
+              },
+              "status": {
+                "type": "number"
+              },
+              "contentType": {
+                "type": "string"
+              },
+              "body": {
+                "description": "A string representation of the body to return. Can be a base64-encoded\nstring but please omit any leading content-type data (eg \"data:image/png;base64,\").",
+                "type": "string"
+              }
+            }
           }
         },
         "additionalProperties": false,
@@ -528,118 +545,10 @@
         "y"
       ]
     },
-    "Partial<ResponseForRequest>": {
-      "type": "object",
-      "properties": {
-        "status": {
-          "type": "number"
-        },
-        "headers": {
-          "description": "Optional response headers.\n\nThe record values will be converted to string following:\nArrays' values will be mapped to String\n(Used when you need multiple headers with the same name).\nNon-arrays will be converted to String.",
-          "$ref": "#/definitions/Record<string,unknown>"
-        },
-        "contentType": {
-          "type": "string"
-        },
-        "body": {
-          "anyOf": [
-            {
-              "type": "object",
-              "additionalProperties": false,
-              "patternProperties": {
-                "^[0-9]+$": {
-                  "type": "number"
-                }
-              },
-              "properties": {
-                "BYTES_PER_ELEMENT": {
-                  "type": "number"
-                },
-                "buffer": {
-                  "$ref": "#/definitions/ArrayBufferLike"
-                },
-                "byteLength": {
-                  "type": "number"
-                },
-                "byteOffset": {
-                  "type": "number"
-                },
-                "length": {
-                  "type": "number"
-                },
-                "__@toStringTag@467957": {
-                  "type": "string",
-                  "const": "Uint8Array"
-                }
-              },
-              "required": [
-                "BYTES_PER_ELEMENT",
-                "__@toStringTag@467957",
-                "buffer",
-                "byteLength",
-                "byteOffset",
-                "length"
-              ]
-            },
-            {
-              "type": "string"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
-    },
     "Record<string,unknown>": {
       "type": "object",
       "additionalProperties": false
     },
-    "ArrayBufferLike": {
-      "anyOf": [
-        {
-          "$ref": "#/definitions/ArrayBuffer"
-        },
-        {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        }
-      ]
-    },
-    "ArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@toStringTag@467957": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@toStringTag@467957",
-        "byteLength"
-      ]
-    },
-    "SharedArrayBuffer": {
-      "type": "object",
-      "properties": {
-        "byteLength": {
-          "type": "number"
-        },
-        "__@species@477461": {
-          "$ref": "#/definitions/SharedArrayBuffer"
-        },
-        "__@toStringTag@467957": {
-          "type": "string",
-          "const": "SharedArrayBuffer"
-        }
-      },
-      "additionalProperties": false,
-      "required": [
-        "__@species@477461",
-        "__@toStringTag@467957",
-        "byteLength"
-      ]
-    },
     "Record<string,string>": {
       "type": "object",
       "additionalProperties": false

package/build/shared/content.http.js

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, isBase64Encoded, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, writeResponse, } from '@browserless.io/browserless';
 export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
     name = BrowserlessRoutes.ChromiumContentPostRoute;
     accepts = [contentTypes.json];
@@ -59,7 +59,14 @@ export default class ChromiumContentPostRoute extends BrowserHTTPRoute {
                 }
                 const interceptor = requestInterceptors.find((r) => req.url().match(r.pattern));
                 if (interceptor) {
-                    return req.respond(interceptor.response);
+                    return req.respond({
+                        ...interceptor.response,
+                        body: interceptor.response.body
+                            ? isBase64Encoded(interceptor.response.body)
+                                ? Buffer.from(interceptor.response.body, 'base64')
+                                : interceptor.response.body
+                            : undefined,
+                    });
                 }
                 return req.continue();
             });

package/build/shared/pdf.http.js

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, isBase64Encoded, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
     name = BrowserlessRoutes.ChromiumPDFPostRoute;
     accepts = [contentTypes.json];
@@ -64,7 +64,14 @@ export default class ChromiumPDFPostRoute extends BrowserHTTPRoute {
                 }
                 const interceptor = requestInterceptors.find((r) => req.url().match(r.pattern));
                 if (interceptor) {
-                    return req.respond(interceptor.response);
+                    return req.respond({
+                        ...interceptor.response,
+                        body: interceptor.response.body
+                            ? isBase64Encoded(interceptor.response.body)
+                                ? Buffer.from(interceptor.response.body, 'base64')
+                                : interceptor.response.body
+                            : undefined,
+                    });
                 }
                 return req.continue();
             });

package/build/shared/scrape.http.js

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, jsonResponse, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, Timeout, bestAttemptCatch, contentTypes, debugScreenshotOpts, dedent, isBase64Encoded, jsonResponse, noop, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 const scrape = async (elements) => {
     const wait = (selector, timeout = 30000) => {
         return new Promise((resolve, reject) => {
@@ -127,7 +127,14 @@ export default class ChromiumScrapePostRoute extends BrowserHTTPRoute {
                 }
                 const interceptor = requestInterceptors.find((r) => req.url().match(r.pattern));
                 if (interceptor) {
-                    return req.respond(interceptor.response);
+                    return req.respond({
+                        ...interceptor.response,
+                        body: interceptor.response.body
+                            ? isBase64Encoded(interceptor.response.body)
+                                ? Buffer.from(interceptor.response.body, 'base64')
+                                : interceptor.response.body
+                            : undefined,
+                    });
                 }
                 return req.continue();
             });

package/build/shared/screenshot.http.js

@@ -1,4 +1,4 @@
-import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, noop, scrollThroughPage, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
+import { APITags, BadRequest, BrowserHTTPRoute, BrowserlessRoutes, ChromiumCDP, HTTPRoutes, Methods, bestAttemptCatch, contentTypes, dedent, isBase64Encoded, noop, scrollThroughPage, sleep, waitForEvent as waitForEvt, waitForFunction as waitForFn, } from '@browserless.io/browserless';
 import Stream from 'stream';
 export default class ScreenshotPost extends BrowserHTTPRoute {
     name = BrowserlessRoutes.ChromiumScreenshotPostRoute;
@@ -67,7 +67,14 @@ export default class ScreenshotPost extends BrowserHTTPRoute {
                 }
                 const interceptor = requestInterceptors.find((r) => req.url().match(r.pattern));
                 if (interceptor) {
-                    return req.respond(interceptor.response);
+                    return req.respond({
+                        ...interceptor.response,
+                        body: interceptor.response.body
+                            ? isBase64Encoded(interceptor.response.body)
+                                ? Buffer.from(interceptor.response.body, 'base64')
+                                : interceptor.response.body
+                            : undefined,
+                    });
                 }
                 return req.continue();
             });

package/build/types.d.ts

@@ -406,7 +406,13 @@ export type requestInterceptors = {
      * corresponding responses to use in order to fulfill those requests.
      */
     pattern: string;
-    response: Partial<ResponseForRequest>;
+    response: Partial<Omit<ResponseForRequest, 'body'>> & {
+        /**
+         * A string representation of the body to return. Can be a base64-encoded
+         * string but please omit any leading content-type data (eg "data:image/png;base64,").
+         */
+        body?: string;
+    };
 };
 export interface IResourceLoad {
     cpu: number | null;