@browserless.io/browserless 2.34.1 → 2.36.0

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

@@ -126,7 +126,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -595,6 +608,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {

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

@@ -132,7 +132,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -497,6 +510,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {

package/build/routes/chromium/http/scrape.post.response.json

@@ -179,18 +179,6 @@
       "description": "Represents a cookie object.",
       "type": "object",
       "properties": {
-        "name": {
-          "description": "Cookie name.",
-          "type": "string"
-        },
-        "value": {
-          "description": "Cookie value.",
-          "type": "string"
-        },
-        "domain": {
-          "description": "Cookie domain.",
-          "type": "string"
-        },
         "path": {
           "description": "Cookie path.",
           "type": "string"
@@ -203,10 +191,6 @@
           "description": "Cookie size.",
           "type": "number"
         },
-        "httpOnly": {
-          "description": "True if cookie is http-only.",
-          "type": "boolean"
-        },
         "secure": {
           "description": "True if cookie is secure.",
           "type": "boolean"
@@ -215,6 +199,26 @@
           "description": "True in case of session cookie.",
           "type": "boolean"
         },
+        "partitionKeyOpaque": {
+          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
+          "type": "boolean"
+        },
+        "name": {
+          "description": "Cookie name.",
+          "type": "string"
+        },
+        "value": {
+          "description": "Cookie value.",
+          "type": "string"
+        },
+        "domain": {
+          "description": "Cookie domain.",
+          "type": "string"
+        },
+        "httpOnly": {
+          "description": "True if cookie is http-only.",
+          "type": "boolean"
+        },
         "sameSite": {
           "description": "Cookie SameSite type.",
           "enum": [
@@ -247,7 +251,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
           "anyOf": [
             {
               "$ref": "#/definitions/CookiePartitionKey"
@@ -256,17 +260,12 @@
               "type": "string"
             }
           ]
-        },
-        "partitionKeyOpaque": {
-          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
-          "type": "boolean"
         }
       },
       "additionalProperties": false,
       "required": [
         "domain",
         "expires",
-        "httpOnly",
         "name",
         "path",
         "secure",

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

@@ -132,7 +132,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -553,6 +566,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {

package/build/routes/chromium/tests/scrape.spec.js

@@ -351,4 +351,45 @@ describe('/chromium/scrape API', function () {
             expect(res.status).to.equal(200);
         });
     });
+    it('handles bestAttempt with failing selectors', async () => {
+        const config = new Config();
+        config.setToken('browserless');
+        const metrics = new Metrics();
+        await start({ config, metrics });
+        const body = {
+            bestAttempt: true,
+            elements: [
+                {
+                    selector: 'a',
+                },
+                {
+                    selector: 'nonexistent-element',
+                    timeout: 1000,
+                },
+                {
+                    selector: 'h1',
+                },
+            ],
+            url: 'https://one.one.one.one',
+        };
+        await fetch('http://localhost:3000/chromium/scrape?token=browserless', {
+            body: JSON.stringify(body),
+            headers: {
+                'content-type': 'application/json',
+            },
+            method: 'POST',
+        }).then(async (res) => {
+            expect(res.status).to.equal(200);
+            expect(res.headers.get('content-type')).to.equal('application/json; charset=UTF-8');
+            const json = await res.json();
+            expect(json.data).to.be.an('array');
+            expect(json.data).to.have.length(3);
+            const aResults = json.data.find((item) => item.selector === 'a');
+            const nonexistentResults = json.data.find((item) => item.selector === 'nonexistent-element');
+            const h1Results = json.data.find((item) => item.selector === 'h1');
+            expect(aResults.results).to.be.an('array');
+            expect(nonexistentResults.results).to.be.an('array').that.is.empty;
+            expect(h1Results.results).to.be.an('array');
+        });
+    });
 });

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

@@ -124,7 +124,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -450,6 +463,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {

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

@@ -126,7 +126,20 @@
       "type": "string"
     },
     "userAgent": {
-      "type": "string"
+      "type": "object",
+      "properties": {
+        "userAgent": {
+          "type": "string"
+        },
+        "userAgentMetadata": {
+          "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+          "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+        },
+        "platform": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
     },
     "viewport": {
       "anyOf": [
@@ -595,6 +608,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {