@scrapa/sdk 0.2.2 → 0.3.0

package/dist/generated/params.d.ts

@@ -1,35 +1,50 @@
 /** Arguments for `scrape()`. */
 export interface ScrapeParams {
-    /** The page to read. An http(s) URL — private and loopback hosts are refused. */
+    /** The page to read. An http(s) URL. Private and loopback hosts are refused. */
     url: string;
     /** How to read it. "fetch" is a plain HTTP request; "browser" renders the page in a real
-     *  Chromium; "auto" fetches first and escalates to the browser when the body turns out to be a
-     *  JavaScript shell, billing whichever engine answered. */
+     *  Chromium; "auto" (the default) fetches first and escalates to the browser when the body
+     *  turns out to be a JavaScript shell, billing whichever engine answered. A POST and "raw"
+     *  always use "fetch", so leave it out for them. */
     engine?: "auto" | "fetch" | "browser";
-    /** Whether to try again a different way when the first attempt is blocked. `false` stops after
-     *  one try — the site's refusal is your answer, and it costs nothing. It is how you bound a
-     *  call: with `auto`, trying again is what charges the browser price instead of the fetch one. */
+    /** Whether to try again a different way when the first attempt is blocked. On by default.
+     *  `false` stops after one try. The site's refusal is your answer, and it costs nothing. It is
+     *  how you bound a call: with `auto`, trying again is what charges the browser price instead of
+     *  the fetch one. A POST is sent once, so it is off for a POST. */
     escalate?: boolean;
+    /** The HTTP method. "POST" sends `body` to the URL, for a search form or a JSON query. It is
+     *  sent once: never retried and never sent again another way, because sending it twice could
+     *  repeat what it did. */
+    method?: "GET" | "POST";
+    /** What a POST sends, at most 64 KB. Set its type in `headers`: `{"content-type":
+     *  "application/json"}` for JSON, or `application/x-www-form-urlencoded` for a form. If the
+     *  site redirects, a 301, 302 or 303 reads the next page with GET and without the body; a 307
+     *  or 308 sends it again only if the protocol, host and port stay the same, and otherwise stops
+     *  and names the new address. */
+    body?: string;
     /** How many extra tries to give a page the site blocks, each from a different address. 0 (the
      *  default) takes the site's first no as the answer. A blocked page costs nothing, so a try
-     *  that is blocked again is free — but it takes as long as the first one did, so the call can
+     *  that is blocked again is free, but it takes as long as the first one did, so the call can
      *  run that many times longer. */
     retry?: number;
     /** What to hand back. "screenshot" and "pdf" come back as base64 and need the browser engine;
      *  asking for both costs no more than one. "extract" is the page read into fields by a model,
-     *  and needs an `extract` block saying which ones. */
-    formats?: ("markdown" | "html" | "text" | "links" | "screenshot" | "pdf" | "extract")[];
+     *  and needs an `extract` block saying which ones. "raw" is the file exactly as the site sent
+     *  it, as base64 with its content type: a PDF report, an image, a spreadsheet. It uses the
+     *  fetch engine and holds up to 5 MB; a larger file answers FILE_TOO_LARGE at no charge, never
+     *  cut short. */
+    formats?: ("markdown" | "html" | "text" | "links" | "screenshot" | "pdf" | "extract" | "raw")[];
     /** What the page should answer with. Set `"json"` when you are reading an API: anything else
-     *  that comes back — a maintenance notice, a "checking your browser" page, a login form — is
-     *  then not your answer. It costs nothing, and we try again from another address instead of
-     *  handing you a page you cannot parse. Without it, whatever the page returns is your answer. */
+     *  that comes back (a maintenance notice, a "checking your browser" page, a login form) is then
+     *  not your answer. It costs nothing, and we try again from another address instead of handing
+     *  you a page you cannot parse. Without it, whatever the page returns is your answer. */
     expect?: "json";
     /** What to pull out of the page, for the "extract" format. A model reads the page and fills in
-     *  the shape you asked for — give it a JSON Schema, a sentence, or both. It reads what the page
+     *  the shape you asked for. Give it a JSON Schema, a sentence, or both. It reads what the page
      *  says; it does not do arithmetic over it, so ask for the numbers and add them up in your own
      *  code. */
     extract?: {
-        /** The shape you want back, as JSON Schema — an object whose properties are the fields you
+        /** The shape you want back, as JSON Schema: an object whose properties are the fields you
          *  need. A field the page does not mention comes back null; nothing is invented to fill it. */
         schema?: Record<string, unknown>;
         /** What to pull out, in your own words: `the price, the author and the date it was
@@ -40,7 +55,7 @@ export interface ScrapeParams {
     /** Where the request leaves from. Defaults to the managed residential pool. */
     proxy?: {
         /** Which exit to leave through. "residential" is the managed pool, metered by the megabyte;
-         *  "custom" is your own proxy — free on every plan, bytes never billed. */
+         *  "custom" is your own proxy, free on every plan, bytes never billed. */
         pool?: "residential" | "custom";
         /** Your own proxy, `http(s)://[user:pass@]host:port`. Required for pool "custom", refused
          *  for the managed one. */
@@ -60,7 +75,7 @@ export interface ScrapeParams {
          *  charge; ask for the state or the country alone. */
         city?: string;
     };
-    /** How to render it. Only the browser engine reads these — with `auto` they apply if the page
+    /** How to render it. Only the browser engine reads these. With `auto` they apply if the page
      *  turns out to need one. */
     browser?: {
         /** When the page counts as loaded. "load" (the default) waits for images and stylesheets;
@@ -68,9 +83,9 @@ export interface ScrapeParams {
          *  page stops asking for things. Every page gets a short settle after this whichever you
          *  pick. */
         waitUntil?: "load" | "domcontentloaded" | "networkidle";
-        /** Wait until this CSS selector is on the page — the dependable way to read something a
-         *  script draws. If it never shows up the call comes back as a timeout at no charge, rather
-         *  than the half-built page. */
+        /** Wait until this CSS selector is on the page. It is the dependable way to read something
+         *  a script draws. If it never shows up, the call comes back as a timeout at no charge,
+         *  rather than the half-built page. */
         waitForSelector?: string;
         /** Wait this many milliseconds after the page settles, for the scripts no selector
          *  describes. It comes out of `timeoutMs`, never on top of it. */
@@ -82,11 +97,11 @@ export interface ScrapeParams {
             height: number;
         };
         /** Screenshot the whole scrollable page instead of just the window. A long page makes a
-         *  large answer — the image comes back as base64 inside the response. */
+         *  large answer: the image comes back as base64 inside the response. */
         fullPage?: boolean;
     };
-    /** Extra request headers to send to the page — an authorization token, a cookie, a custom user
-     *  agent. The connection's own headers cannot be set. */
+    /** Extra request headers to send to the page, such as an authorization token, a cookie or a
+     *  custom user agent. The connection's own headers cannot be set. */
     headers?: Record<string, string>;
     /** How long to give the page before giving up, in milliseconds. A page that never arrives is a
      *  free outcome. */
@@ -94,36 +109,51 @@ export interface ScrapeParams {
 }
 /** Arguments for `quote()`. */
 export interface QuoteScrapeParams {
-    /** The page to read. An http(s) URL — private and loopback hosts are refused. */
+    /** The page to read. An http(s) URL. Private and loopback hosts are refused. */
     url: string;
     /** How to read it. "fetch" is a plain HTTP request; "browser" renders the page in a real
-     *  Chromium; "auto" fetches first and escalates to the browser when the body turns out to be a
-     *  JavaScript shell, billing whichever engine answered. */
+     *  Chromium; "auto" (the default) fetches first and escalates to the browser when the body
+     *  turns out to be a JavaScript shell, billing whichever engine answered. A POST and "raw"
+     *  always use "fetch", so leave it out for them. */
     engine?: "auto" | "fetch" | "browser";
-    /** Whether to try again a different way when the first attempt is blocked. `false` stops after
-     *  one try — the site's refusal is your answer, and it costs nothing. It is how you bound a
-     *  call: with `auto`, trying again is what charges the browser price instead of the fetch one. */
+    /** Whether to try again a different way when the first attempt is blocked. On by default.
+     *  `false` stops after one try. The site's refusal is your answer, and it costs nothing. It is
+     *  how you bound a call: with `auto`, trying again is what charges the browser price instead of
+     *  the fetch one. A POST is sent once, so it is off for a POST. */
     escalate?: boolean;
+    /** The HTTP method. "POST" sends `body` to the URL, for a search form or a JSON query. It is
+     *  sent once: never retried and never sent again another way, because sending it twice could
+     *  repeat what it did. */
+    method?: "GET" | "POST";
+    /** What a POST sends, at most 64 KB. Set its type in `headers`: `{"content-type":
+     *  "application/json"}` for JSON, or `application/x-www-form-urlencoded` for a form. If the
+     *  site redirects, a 301, 302 or 303 reads the next page with GET and without the body; a 307
+     *  or 308 sends it again only if the protocol, host and port stay the same, and otherwise stops
+     *  and names the new address. */
+    body?: string;
     /** How many extra tries to give a page the site blocks, each from a different address. 0 (the
      *  default) takes the site's first no as the answer. A blocked page costs nothing, so a try
-     *  that is blocked again is free — but it takes as long as the first one did, so the call can
+     *  that is blocked again is free, but it takes as long as the first one did, so the call can
      *  run that many times longer. */
     retry?: number;
     /** What to hand back. "screenshot" and "pdf" come back as base64 and need the browser engine;
      *  asking for both costs no more than one. "extract" is the page read into fields by a model,
-     *  and needs an `extract` block saying which ones. */
-    formats?: ("markdown" | "html" | "text" | "links" | "screenshot" | "pdf" | "extract")[];
+     *  and needs an `extract` block saying which ones. "raw" is the file exactly as the site sent
+     *  it, as base64 with its content type: a PDF report, an image, a spreadsheet. It uses the
+     *  fetch engine and holds up to 5 MB; a larger file answers FILE_TOO_LARGE at no charge, never
+     *  cut short. */
+    formats?: ("markdown" | "html" | "text" | "links" | "screenshot" | "pdf" | "extract" | "raw")[];
     /** What the page should answer with. Set `"json"` when you are reading an API: anything else
-     *  that comes back — a maintenance notice, a "checking your browser" page, a login form — is
-     *  then not your answer. It costs nothing, and we try again from another address instead of
-     *  handing you a page you cannot parse. Without it, whatever the page returns is your answer. */
+     *  that comes back (a maintenance notice, a "checking your browser" page, a login form) is then
+     *  not your answer. It costs nothing, and we try again from another address instead of handing
+     *  you a page you cannot parse. Without it, whatever the page returns is your answer. */
     expect?: "json";
     /** What to pull out of the page, for the "extract" format. A model reads the page and fills in
-     *  the shape you asked for — give it a JSON Schema, a sentence, or both. It reads what the page
+     *  the shape you asked for. Give it a JSON Schema, a sentence, or both. It reads what the page
      *  says; it does not do arithmetic over it, so ask for the numbers and add them up in your own
      *  code. */
     extract?: {
-        /** The shape you want back, as JSON Schema — an object whose properties are the fields you
+        /** The shape you want back, as JSON Schema: an object whose properties are the fields you
          *  need. A field the page does not mention comes back null; nothing is invented to fill it. */
         schema?: Record<string, unknown>;
         /** What to pull out, in your own words: `the price, the author and the date it was
@@ -134,7 +164,7 @@ export interface QuoteScrapeParams {
     /** Where the request leaves from. Defaults to the managed residential pool. */
     proxy?: {
         /** Which exit to leave through. "residential" is the managed pool, metered by the megabyte;
-         *  "custom" is your own proxy — free on every plan, bytes never billed. */
+         *  "custom" is your own proxy, free on every plan, bytes never billed. */
         pool?: "residential" | "custom";
         /** Your own proxy, `http(s)://[user:pass@]host:port`. Required for pool "custom", refused
          *  for the managed one. */
@@ -154,7 +184,7 @@ export interface QuoteScrapeParams {
          *  charge; ask for the state or the country alone. */
         city?: string;
     };
-    /** How to render it. Only the browser engine reads these — with `auto` they apply if the page
+    /** How to render it. Only the browser engine reads these. With `auto` they apply if the page
      *  turns out to need one. */
     browser?: {
         /** When the page counts as loaded. "load" (the default) waits for images and stylesheets;
@@ -162,9 +192,9 @@ export interface QuoteScrapeParams {
          *  page stops asking for things. Every page gets a short settle after this whichever you
          *  pick. */
         waitUntil?: "load" | "domcontentloaded" | "networkidle";
-        /** Wait until this CSS selector is on the page — the dependable way to read something a
-         *  script draws. If it never shows up the call comes back as a timeout at no charge, rather
-         *  than the half-built page. */
+        /** Wait until this CSS selector is on the page. It is the dependable way to read something
+         *  a script draws. If it never shows up, the call comes back as a timeout at no charge,
+         *  rather than the half-built page. */
         waitForSelector?: string;
         /** Wait this many milliseconds after the page settles, for the scripts no selector
          *  describes. It comes out of `timeoutMs`, never on top of it. */
@@ -176,11 +206,11 @@ export interface QuoteScrapeParams {
             height: number;
         };
         /** Screenshot the whole scrollable page instead of just the window. A long page makes a
-         *  large answer — the image comes back as base64 inside the response. */
+         *  large answer: the image comes back as base64 inside the response. */
         fullPage?: boolean;
     };
-    /** Extra request headers to send to the page — an authorization token, a cookie, a custom user
-     *  agent. The connection's own headers cannot be set. */
+    /** Extra request headers to send to the page, such as an authorization token, a cookie or a
+     *  custom user agent. The connection's own headers cannot be set. */
     headers?: Record<string, string>;
     /** How long to give the page before giving up, in milliseconds. A page that never arrives is a
      *  free outcome. */
@@ -188,10 +218,10 @@ export interface QuoteScrapeParams {
 }
 /** Arguments for `search()`. */
 export interface SearchParams {
-    /** What to search for, in plain words — the same thing you would type. */
+    /** What to search for, in plain words: the same thing you would type. */
     query: string;
     /** How many results to hand back at most, 1–20. Billed per 10, so asking for more than 10 costs
-     *  a second row. Fewer can come back than you asked for — an index has what it has, and
+     *  a second row. Fewer can come back than you asked for: an index has what it has, and
      *  `includeDomains` filters what it returns. */
     limit?: number;
     /** What kind of results. "general" is the web; "news" is dated journalism, and the only topic
@@ -199,18 +229,18 @@ export interface SearchParams {
     topic?: "general" | "news";
     /** Only pages from the last day, week, month or year. Absent is any time. */
     timeRange?: "day" | "week" | "month" | "year";
-    /** Only results on these hosts, bare (`linkedin.com`) — subdomains included. Asked of the
+    /** Only results on these hosts, bare (`linkedin.com`). Subdomains are included. Asked of the
      *  search front AND enforced on the answer, so what comes back is on your list whatever the
      *  front did with it. */
     includeDomains?: string[];
     /** Also write a short paragraph answering the query from the results, in the query's language.
      *  Costs one extra credit; leave it off when your own model reads the snippets. */
     answer?: boolean;
-    /** Where the search leaves from. `country` picks the exit AND the market the front answers for
-     *  — `br` gets Brazilian results in Portuguese. */
+    /** Where the search leaves from. `country` picks the exit AND the market the front answers for.
+     *  `br` gets Brazilian results in Portuguese. */
     proxy?: {
         /** Which exit to leave through. "residential" is the managed pool, metered by the megabyte;
-         *  "custom" is your own proxy — free on every plan, bytes never billed. */
+         *  "custom" is your own proxy, free on every plan, bytes never billed. */
         pool?: "residential" | "custom";
         /** Your own proxy, `http(s)://[user:pass@]host:port`. Required for pool "custom", refused
          *  for the managed one. */
@@ -225,33 +255,38 @@ export interface SearchParams {
 /** Arguments for `batches.create()`. */
 export interface CreateBatchParams {
     /** How to read it. "fetch" is a plain HTTP request; "browser" renders the page in a real
-     *  Chromium; "auto" fetches first and escalates to the browser when the body turns out to be a
-     *  JavaScript shell, billing whichever engine answered. */
+     *  Chromium; "auto" (the default) fetches first and escalates to the browser when the body
+     *  turns out to be a JavaScript shell, billing whichever engine answered. A POST and "raw"
+     *  always use "fetch", so leave it out for them. */
     engine?: "auto" | "fetch" | "browser";
-    /** Whether to try again a different way when the first attempt is blocked. `false` stops after
-     *  one try — the site's refusal is your answer, and it costs nothing. It is how you bound a
-     *  call: with `auto`, trying again is what charges the browser price instead of the fetch one. */
+    /** Whether to try again a different way when the first attempt is blocked. On by default.
+     *  `false` stops after one try. The site's refusal is your answer, and it costs nothing. It is
+     *  how you bound a call: with `auto`, trying again is what charges the browser price instead of
+     *  the fetch one. A POST is sent once, so it is off for a POST. */
     escalate?: boolean;
     /** How many extra tries to give a page the site blocks, each from a different address. 0 (the
      *  default) takes the site's first no as the answer. A blocked page costs nothing, so a try
-     *  that is blocked again is free — but it takes as long as the first one did, so the call can
+     *  that is blocked again is free, but it takes as long as the first one did, so the call can
      *  run that many times longer. */
     retry?: number;
     /** What to hand back. "screenshot" and "pdf" come back as base64 and need the browser engine;
      *  asking for both costs no more than one. "extract" is the page read into fields by a model,
-     *  and needs an `extract` block saying which ones. */
-    formats?: ("markdown" | "html" | "text" | "links" | "screenshot" | "pdf" | "extract")[];
+     *  and needs an `extract` block saying which ones. "raw" is the file exactly as the site sent
+     *  it, as base64 with its content type: a PDF report, an image, a spreadsheet. It uses the
+     *  fetch engine and holds up to 5 MB; a larger file answers FILE_TOO_LARGE at no charge, never
+     *  cut short. */
+    formats?: ("markdown" | "html" | "text" | "links" | "screenshot" | "pdf" | "extract" | "raw")[];
     /** What the page should answer with. Set `"json"` when you are reading an API: anything else
-     *  that comes back — a maintenance notice, a "checking your browser" page, a login form — is
-     *  then not your answer. It costs nothing, and we try again from another address instead of
-     *  handing you a page you cannot parse. Without it, whatever the page returns is your answer. */
+     *  that comes back (a maintenance notice, a "checking your browser" page, a login form) is then
+     *  not your answer. It costs nothing, and we try again from another address instead of handing
+     *  you a page you cannot parse. Without it, whatever the page returns is your answer. */
     expect?: "json";
     /** What to pull out of the page, for the "extract" format. A model reads the page and fills in
-     *  the shape you asked for — give it a JSON Schema, a sentence, or both. It reads what the page
+     *  the shape you asked for. Give it a JSON Schema, a sentence, or both. It reads what the page
      *  says; it does not do arithmetic over it, so ask for the numbers and add them up in your own
      *  code. */
     extract?: {
-        /** The shape you want back, as JSON Schema — an object whose properties are the fields you
+        /** The shape you want back, as JSON Schema: an object whose properties are the fields you
          *  need. A field the page does not mention comes back null; nothing is invented to fill it. */
         schema?: Record<string, unknown>;
         /** What to pull out, in your own words: `the price, the author and the date it was
@@ -262,7 +297,7 @@ export interface CreateBatchParams {
     /** Where the request leaves from. Defaults to the managed residential pool. */
     proxy?: {
         /** Which exit to leave through. "residential" is the managed pool, metered by the megabyte;
-         *  "custom" is your own proxy — free on every plan, bytes never billed. */
+         *  "custom" is your own proxy, free on every plan, bytes never billed. */
         pool?: "residential" | "custom";
         /** Your own proxy, `http(s)://[user:pass@]host:port`. Required for pool "custom", refused
          *  for the managed one. */
@@ -282,7 +317,7 @@ export interface CreateBatchParams {
          *  charge; ask for the state or the country alone. */
         city?: string;
     };
-    /** How to render it. Only the browser engine reads these — with `auto` they apply if the page
+    /** How to render it. Only the browser engine reads these. With `auto` they apply if the page
      *  turns out to need one. */
     browser?: {
         /** When the page counts as loaded. "load" (the default) waits for images and stylesheets;
@@ -290,9 +325,9 @@ export interface CreateBatchParams {
          *  page stops asking for things. Every page gets a short settle after this whichever you
          *  pick. */
         waitUntil?: "load" | "domcontentloaded" | "networkidle";
-        /** Wait until this CSS selector is on the page — the dependable way to read something a
-         *  script draws. If it never shows up the call comes back as a timeout at no charge, rather
-         *  than the half-built page. */
+        /** Wait until this CSS selector is on the page. It is the dependable way to read something
+         *  a script draws. If it never shows up, the call comes back as a timeout at no charge,
+         *  rather than the half-built page. */
         waitForSelector?: string;
         /** Wait this many milliseconds after the page settles, for the scripts no selector
          *  describes. It comes out of `timeoutMs`, never on top of it. */
@@ -304,11 +339,11 @@ export interface CreateBatchParams {
             height: number;
         };
         /** Screenshot the whole scrollable page instead of just the window. A long page makes a
-         *  large answer — the image comes back as base64 inside the response. */
+         *  large answer: the image comes back as base64 inside the response. */
         fullPage?: boolean;
     };
-    /** Extra request headers to send to the page — an authorization token, a cookie, a custom user
-     *  agent. The connection's own headers cannot be set. */
+    /** Extra request headers to send to the page, such as an authorization token, a cookie or a
+     *  custom user agent. The connection's own headers cannot be set. */
     headers?: Record<string, string>;
     /** How long to give the page before giving up, in milliseconds. A page that never arrives is a
      *  free outcome. */
@@ -325,41 +360,46 @@ export interface CreateBatchParams {
         url: string;
         /** What to call about. "batch.completed" fires once: when every URL has a verdict, or when
          *  we could not finish the batch. `batch.status` says which: `completed` or `failed`.
-         *  "batch.item.completed" fires per URL — one request from us per item, which is what makes
-         *  a long batch usable before it ends, so ask for it deliberately. */
+         *  "batch.item.completed" fires per URL, with one request from us per item. That makes a
+         *  long batch usable before it ends, so ask for it deliberately. */
         events?: ("batch.completed" | "batch.item.completed")[];
     };
 }
 /** Arguments for `batches.quote()`. */
 export interface QuoteBatchParams {
     /** How to read it. "fetch" is a plain HTTP request; "browser" renders the page in a real
-     *  Chromium; "auto" fetches first and escalates to the browser when the body turns out to be a
-     *  JavaScript shell, billing whichever engine answered. */
+     *  Chromium; "auto" (the default) fetches first and escalates to the browser when the body
+     *  turns out to be a JavaScript shell, billing whichever engine answered. A POST and "raw"
+     *  always use "fetch", so leave it out for them. */
     engine?: "auto" | "fetch" | "browser";
-    /** Whether to try again a different way when the first attempt is blocked. `false` stops after
-     *  one try — the site's refusal is your answer, and it costs nothing. It is how you bound a
-     *  call: with `auto`, trying again is what charges the browser price instead of the fetch one. */
+    /** Whether to try again a different way when the first attempt is blocked. On by default.
+     *  `false` stops after one try. The site's refusal is your answer, and it costs nothing. It is
+     *  how you bound a call: with `auto`, trying again is what charges the browser price instead of
+     *  the fetch one. A POST is sent once, so it is off for a POST. */
     escalate?: boolean;
     /** How many extra tries to give a page the site blocks, each from a different address. 0 (the
      *  default) takes the site's first no as the answer. A blocked page costs nothing, so a try
-     *  that is blocked again is free — but it takes as long as the first one did, so the call can
+     *  that is blocked again is free, but it takes as long as the first one did, so the call can
      *  run that many times longer. */
     retry?: number;
     /** What to hand back. "screenshot" and "pdf" come back as base64 and need the browser engine;
      *  asking for both costs no more than one. "extract" is the page read into fields by a model,
-     *  and needs an `extract` block saying which ones. */
-    formats?: ("markdown" | "html" | "text" | "links" | "screenshot" | "pdf" | "extract")[];
+     *  and needs an `extract` block saying which ones. "raw" is the file exactly as the site sent
+     *  it, as base64 with its content type: a PDF report, an image, a spreadsheet. It uses the
+     *  fetch engine and holds up to 5 MB; a larger file answers FILE_TOO_LARGE at no charge, never
+     *  cut short. */
+    formats?: ("markdown" | "html" | "text" | "links" | "screenshot" | "pdf" | "extract" | "raw")[];
     /** What the page should answer with. Set `"json"` when you are reading an API: anything else
-     *  that comes back — a maintenance notice, a "checking your browser" page, a login form — is
-     *  then not your answer. It costs nothing, and we try again from another address instead of
-     *  handing you a page you cannot parse. Without it, whatever the page returns is your answer. */
+     *  that comes back (a maintenance notice, a "checking your browser" page, a login form) is then
+     *  not your answer. It costs nothing, and we try again from another address instead of handing
+     *  you a page you cannot parse. Without it, whatever the page returns is your answer. */
     expect?: "json";
     /** What to pull out of the page, for the "extract" format. A model reads the page and fills in
-     *  the shape you asked for — give it a JSON Schema, a sentence, or both. It reads what the page
+     *  the shape you asked for. Give it a JSON Schema, a sentence, or both. It reads what the page
      *  says; it does not do arithmetic over it, so ask for the numbers and add them up in your own
      *  code. */
     extract?: {
-        /** The shape you want back, as JSON Schema — an object whose properties are the fields you
+        /** The shape you want back, as JSON Schema: an object whose properties are the fields you
          *  need. A field the page does not mention comes back null; nothing is invented to fill it. */
         schema?: Record<string, unknown>;
         /** What to pull out, in your own words: `the price, the author and the date it was
@@ -370,7 +410,7 @@ export interface QuoteBatchParams {
     /** Where the request leaves from. Defaults to the managed residential pool. */
     proxy?: {
         /** Which exit to leave through. "residential" is the managed pool, metered by the megabyte;
-         *  "custom" is your own proxy — free on every plan, bytes never billed. */
+         *  "custom" is your own proxy, free on every plan, bytes never billed. */
         pool?: "residential" | "custom";
         /** Your own proxy, `http(s)://[user:pass@]host:port`. Required for pool "custom", refused
          *  for the managed one. */
@@ -390,7 +430,7 @@ export interface QuoteBatchParams {
          *  charge; ask for the state or the country alone. */
         city?: string;
     };
-    /** How to render it. Only the browser engine reads these — with `auto` they apply if the page
+    /** How to render it. Only the browser engine reads these. With `auto` they apply if the page
      *  turns out to need one. */
     browser?: {
         /** When the page counts as loaded. "load" (the default) waits for images and stylesheets;
@@ -398,9 +438,9 @@ export interface QuoteBatchParams {
          *  page stops asking for things. Every page gets a short settle after this whichever you
          *  pick. */
         waitUntil?: "load" | "domcontentloaded" | "networkidle";
-        /** Wait until this CSS selector is on the page — the dependable way to read something a
-         *  script draws. If it never shows up the call comes back as a timeout at no charge, rather
-         *  than the half-built page. */
+        /** Wait until this CSS selector is on the page. It is the dependable way to read something
+         *  a script draws. If it never shows up, the call comes back as a timeout at no charge,
+         *  rather than the half-built page. */
         waitForSelector?: string;
         /** Wait this many milliseconds after the page settles, for the scripts no selector
          *  describes. It comes out of `timeoutMs`, never on top of it. */
@@ -412,11 +452,11 @@ export interface QuoteBatchParams {
             height: number;
         };
         /** Screenshot the whole scrollable page instead of just the window. A long page makes a
-         *  large answer — the image comes back as base64 inside the response. */
+         *  large answer: the image comes back as base64 inside the response. */
         fullPage?: boolean;
     };
-    /** Extra request headers to send to the page — an authorization token, a cookie, a custom user
-     *  agent. The connection's own headers cannot be set. */
+    /** Extra request headers to send to the page, such as an authorization token, a cookie or a
+     *  custom user agent. The connection's own headers cannot be set. */
     headers?: Record<string, string>;
     /** How long to give the page before giving up, in milliseconds. A page that never arrives is a
      *  free outcome. */
@@ -433,8 +473,8 @@ export interface QuoteBatchParams {
         url: string;
         /** What to call about. "batch.completed" fires once: when every URL has a verdict, or when
          *  we could not finish the batch. `batch.status` says which: `completed` or `failed`.
-         *  "batch.item.completed" fires per URL — one request from us per item, which is what makes
-         *  a long batch usable before it ends, so ask for it deliberately. */
+         *  "batch.item.completed" fires per URL, with one request from us per item. That makes a
+         *  long batch usable before it ends, so ask for it deliberately. */
         events?: ("batch.completed" | "batch.item.completed")[];
     };
 }
@@ -469,7 +509,7 @@ export interface CreateSessionParams {
      *  pool. */
     proxy?: {
         /** Which exit to leave through. "residential" is the managed pool, metered by the megabyte;
-         *  "custom" is your own proxy — free on every plan, bytes never billed. */
+         *  "custom" is your own proxy, free on every plan, bytes never billed. */
         pool?: "residential" | "custom";
         /** Your own proxy, `http(s)://[user:pass@]host:port`. Required for pool "custom", refused
          *  for the managed one. */
@@ -500,7 +540,7 @@ export interface QuoteSessionParams {
      *  pool. */
     proxy?: {
         /** Which exit to leave through. "residential" is the managed pool, metered by the megabyte;
-         *  "custom" is your own proxy — free on every plan, bytes never billed. */
+         *  "custom" is your own proxy, free on every plan, bytes never billed. */
         pool?: "residential" | "custom";
         /** Your own proxy, `http(s)://[user:pass@]host:port`. Required for pool "custom", refused
          *  for the managed one. */

package/dist/generated/params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../src/generated/params.ts"],"names":[],"mappings":"AAMA,gCAAgC;AAChC,MAAM,WAAW,YAAY;IACzB,iFAAiF;IACjF,GAAG,EAAE,MAAM,CAAC;IACZ;;+DAE2D;IAC3D,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtC;;sGAEkG;IAClG,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;sCAGkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;0DAEsD;IACtD,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IACxF;;;qGAGiG;IACjG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;gBAGY;IACZ,OAAO,CAAC,EAAE;QACN;uGAC+F;QAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC;;qBAEa;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,+EAA+E;IAC/E,KAAK,CAAC,EAAE;QACJ;mFAC2E;QAC3E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;iCAC6B;IAC7B,OAAO,CAAC,EAAE;QACN;;;oBAGY;QACZ,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,aAAa,CAAC;QACxD;;wCAEgC;QAChC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;0EACkE;QAClE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;kDAC0C;QAC1C,QAAQ,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;iFACyE;QACzE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF;6DACyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;wBACoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,+BAA+B;AAC/B,MAAM,WAAW,iBAAiB;IAC9B,iFAAiF;IACjF,GAAG,EAAE,MAAM,CAAC;IACZ;;+DAE2D;IAC3D,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtC;;sGAEkG;IAClG,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;sCAGkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;0DAEsD;IACtD,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IACxF;;;qGAGiG;IACjG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;gBAGY;IACZ,OAAO,CAAC,EAAE;QACN;uGAC+F;QAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC;;qBAEa;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,+EAA+E;IAC/E,KAAK,CAAC,EAAE;QACJ;mFAC2E;QAC3E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;iCAC6B;IAC7B,OAAO,CAAC,EAAE;QACN;;;oBAGY;QACZ,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,aAAa,CAAC;QACxD;;wCAEgC;QAChC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;0EACkE;QAClE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;kDAC0C;QAC1C,QAAQ,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;iFACyE;QACzE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF;6DACyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;wBACoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,gCAAgC;AAChC,MAAM,WAAW,YAAY;IACzB,0EAA0E;IAC1E,KAAK,EAAE,MAAM,CAAC;IACd;;oDAEgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;+CAC2C;IAC3C,KAAK,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAC3B,6EAA6E;IAC7E,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAC9C;;6BAEyB;IACzB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;uFACmF;IACnF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;uDACmD;IACnD,KAAK,CAAC,EAAE;QACJ;mFAC2E;QAC3E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACL;AAED,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAC9B;;+DAE2D;IAC3D,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtC;;sGAEkG;IAClG,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;sCAGkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;0DAEsD;IACtD,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IACxF;;;qGAGiG;IACjG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;gBAGY;IACZ,OAAO,CAAC,EAAE;QACN;uGAC+F;QAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC;;qBAEa;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,+EAA+E;IAC/E,KAAK,CAAC,EAAE;QACJ;mFAC2E;QAC3E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;iCAC6B;IAC7B,OAAO,CAAC,EAAE;QACN;;;oBAGY;QACZ,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,aAAa,CAAC;QACxD;;wCAEgC;QAChC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;0EACkE;QAClE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;kDAC0C;QAC1C,QAAQ,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;iFACyE;QACzE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF;6DACyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;wBACoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;qBAEiB;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;4BACwB;IACxB,OAAO,CAAC,EAAE;QACN;qEAC6D;QAC7D,GAAG,EAAE,MAAM,CAAC;QACZ;;;8EAGsE;QACtE,MAAM,CAAC,EAAE,CAAC,iBAAiB,GAAG,sBAAsB,CAAC,EAAE,CAAC;KAC3D,CAAC;CACL;AAED,uCAAuC;AACvC,MAAM,WAAW,gBAAgB;IAC7B;;+DAE2D;IAC3D,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtC;;sGAEkG;IAClG,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;sCAGkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;0DAEsD;IACtD,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,SAAS,CAAC,EAAE,CAAC;IACxF;;;qGAGiG;IACjG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;gBAGY;IACZ,OAAO,CAAC,EAAE;QACN;uGAC+F;QAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC;;qBAEa;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,+EAA+E;IAC/E,KAAK,CAAC,EAAE;QACJ;mFAC2E;QAC3E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;iCAC6B;IAC7B,OAAO,CAAC,EAAE;QACN;;;oBAGY;QACZ,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,aAAa,CAAC;QACxD;;wCAEgC;QAChC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;0EACkE;QAClE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;kDAC0C;QAC1C,QAAQ,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;iFACyE;QACzE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF;6DACyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;wBACoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;qBAEiB;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;4BACwB;IACxB,OAAO,CAAC,EAAE;QACN;qEAC6D;QAC7D,GAAG,EAAE,MAAM,CAAC;QACZ;;;8EAGsE;QACtE,MAAM,CAAC,EAAE,CAAC,iBAAiB,GAAG,sBAAsB,CAAC,EAAE,CAAC;KAC3D,CAAC;CACL;AAED,sCAAsC;AACtC,MAAM,WAAW,iBAAiB;IAC9B,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC3B,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX;kEAC8D;IAC9D,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;uFACmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAC9B,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;CACd;AAED,yCAAyC;AACzC,MAAM,WAAW,mBAAmB;IAChC;;yFAEqF;IACrF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;gBACY;IACZ,KAAK,CAAC,EAAE;QACJ;mFAC2E;QAC3E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACL;AAED,wCAAwC;AACxC,MAAM,WAAW,kBAAkB;IAC/B;;yFAEqF;IACrF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;gBACY;IACZ,KAAK,CAAC,EAAE;QACJ;mFAC2E;QAC3E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACL;AAED,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IAC/B,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,sCAAsC;AACtC,MAAM,WAAW,gBAAgB;IAC7B,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;CACd;AAED,wCAAwC;AACxC,MAAM,WAAW,kBAAkB;IAC/B,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["../../src/generated/params.ts"],"names":[],"mappings":"AAMA,gCAAgC;AAChC,MAAM,WAAW,YAAY;IACzB,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IACZ;;;wDAGoD;IACpD,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtC;;;uEAGmE;IACnE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;8BAE0B;IAC1B,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACxB;;;;qCAIiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;sCAGkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;qBAKiB;IACjB,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC;IAChG;;;6FAGyF;IACzF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;gBAGY;IACZ,OAAO,CAAC,EAAE;QACN;uGAC+F;QAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC;;qBAEa;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,+EAA+E;IAC/E,KAAK,CAAC,EAAE;QACJ;kFAC0E;QAC1E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;iCAC6B;IAC7B,OAAO,CAAC,EAAE;QACN;;;oBAGY;QACZ,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,aAAa,CAAC;QACxD;;+CAEuC;QACvC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;0EACkE;QAClE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;kDAC0C;QAC1C,QAAQ,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;gFACwE;QACxE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF;yEACqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;wBACoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,+BAA+B;AAC/B,MAAM,WAAW,iBAAiB;IAC9B,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IACZ;;;wDAGoD;IACpD,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtC;;;uEAGmE;IACnE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;8BAE0B;IAC1B,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACxB;;;;qCAIiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;sCAGkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;qBAKiB;IACjB,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC;IAChG;;;6FAGyF;IACzF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;gBAGY;IACZ,OAAO,CAAC,EAAE;QACN;uGAC+F;QAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC;;qBAEa;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,+EAA+E;IAC/E,KAAK,CAAC,EAAE;QACJ;kFAC0E;QAC1E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;iCAC6B;IAC7B,OAAO,CAAC,EAAE;QACN;;;oBAGY;QACZ,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,aAAa,CAAC;QACxD;;+CAEuC;QACvC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;0EACkE;QAClE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;kDAC0C;QAC1C,QAAQ,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;gFACwE;QACxE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF;yEACqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;wBACoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,gCAAgC;AAChC,MAAM,WAAW,YAAY;IACzB,yEAAyE;IACzE,KAAK,EAAE,MAAM,CAAC;IACd;;oDAEgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;+CAC2C;IAC3C,KAAK,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAC3B,6EAA6E;IAC7E,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAC9C;;6BAEyB;IACzB,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;uFACmF;IACnF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;qDACiD;IACjD,KAAK,CAAC,EAAE;QACJ;kFAC0E;QAC1E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACL;AAED,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAC9B;;;wDAGoD;IACpD,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtC;;;uEAGmE;IACnE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;sCAGkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;qBAKiB;IACjB,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC;IAChG;;;6FAGyF;IACzF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;gBAGY;IACZ,OAAO,CAAC,EAAE;QACN;uGAC+F;QAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC;;qBAEa;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,+EAA+E;IAC/E,KAAK,CAAC,EAAE;QACJ;kFAC0E;QAC1E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;iCAC6B;IAC7B,OAAO,CAAC,EAAE;QACN;;;oBAGY;QACZ,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,aAAa,CAAC;QACxD;;+CAEuC;QACvC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;0EACkE;QAClE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;kDAC0C;QAC1C,QAAQ,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;gFACwE;QACxE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF;yEACqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;wBACoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;qBAEiB;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;4BACwB;IACxB,OAAO,CAAC,EAAE;QACN;qEAC6D;QAC7D,GAAG,EAAE,MAAM,CAAC;QACZ;;;4EAGoE;QACpE,MAAM,CAAC,EAAE,CAAC,iBAAiB,GAAG,sBAAsB,CAAC,EAAE,CAAC;KAC3D,CAAC;CACL;AAED,uCAAuC;AACvC,MAAM,WAAW,gBAAgB;IAC7B;;;wDAGoD;IACpD,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;IACtC;;;uEAGmE;IACnE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;sCAGkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;qBAKiB;IACjB,OAAO,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC,EAAE,CAAC;IAChG;;;6FAGyF;IACzF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;gBAGY;IACZ,OAAO,CAAC,EAAE;QACN;uGAC+F;QAC/F,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjC;;qBAEa;QACb,MAAM,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,+EAA+E;IAC/E,KAAK,CAAC,EAAE;QACJ;kFAC0E;QAC1E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;iCAC6B;IAC7B,OAAO,CAAC,EAAE;QACN;;;oBAGY;QACZ,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,aAAa,CAAC;QACxD;;+CAEuC;QACvC,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB;0EACkE;QAClE,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;kDAC0C;QAC1C,QAAQ,CAAC,EAAE;YACP,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC;SAClB,CAAC;QACF;gFACwE;QACxE,QAAQ,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;IACF;yEACqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;wBACoB;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;qBAEiB;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;4BACwB;IACxB,OAAO,CAAC,EAAE;QACN;qEAC6D;QAC7D,GAAG,EAAE,MAAM,CAAC;QACZ;;;4EAGoE;QACpE,MAAM,CAAC,EAAE,CAAC,iBAAiB,GAAG,sBAAsB,CAAC,EAAE,CAAC;KAC3D,CAAC;CACL;AAED,sCAAsC;AACtC,MAAM,WAAW,iBAAiB;IAC9B,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qCAAqC;AACrC,MAAM,WAAW,cAAc;IAC3B,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX;kEAC8D;IAC9D,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;uFACmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wCAAwC;AACxC,MAAM,WAAW,iBAAiB;IAC9B,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;CACd;AAED,yCAAyC;AACzC,MAAM,WAAW,mBAAmB;IAChC;;yFAEqF;IACrF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;gBACY;IACZ,KAAK,CAAC,EAAE;QACJ;kFAC0E;QAC1E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACL;AAED,wCAAwC;AACxC,MAAM,WAAW,kBAAkB;IAC/B;;yFAEqF;IACrF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;gBACY;IACZ,KAAK,CAAC,EAAE;QACJ;kFAC0E;QAC1E,IAAI,CAAC,EAAE,aAAa,GAAG,QAAQ,CAAC;QAChC;mCAC2B;QAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB;;;6BAGqB;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;4DAEoD;QACpD,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;8DAGsD;QACtD,IAAI,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACL;AAED,uCAAuC;AACvC,MAAM,WAAW,kBAAkB;IAC/B,kEAAkE;IAClE,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,sCAAsC;AACtC,MAAM,WAAW,gBAAgB;IAC7B,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;CACd;AAED,wCAAwC;AACxC,MAAM,WAAW,kBAAkB;IAC/B,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;CACd"}

package/dist/generated/retry.d.ts

@@ -36,9 +36,9 @@ export interface RetryOptions {
 /**
  * Should this failure be retried?
  *
- *     if (attempt < 3 && shouldRetry(error, { repeatable: method === "GET" || !!key }))
+ *     if (attempt < 3 && isRetryable(error, { repeatable: method === "GET" || !!key }))
  */
-export declare function shouldRetry(error: unknown, options: RetryOptions): boolean;
+export declare function isRetryable(error: unknown, options: RetryOptions): boolean;
 /**
  * How long before retry number `attemptIndex` (0 for the first): the server's stated wait when
  * there is one, an exponential backoff otherwise, and never less than the backoff. A

package/dist/generated/retry.js

@@ -9,9 +9,9 @@ const DEFAULT_MAX_WAIT_SECS = 10;
 /**
  * Should this failure be retried?
  *
- *     if (attempt < 3 && shouldRetry(error, { repeatable: method === "GET" || !!key }))
+ *     if (attempt < 3 && isRetryable(error, { repeatable: method === "GET" || !!key }))
  */
-export function shouldRetry(error, options) {
+export function isRetryable(error, options) {
     const { repeatable, durableCodes = [], maxWaitSecs = DEFAULT_MAX_WAIT_SECS } = options;
     const status = statusOf(error);
     // No answer at all: nothing about it is a refusal, but a write may have landed before the
@@ -104,7 +104,7 @@ export function parseRetryAfter(value) {
  * frees when another job ends. Present-and-`null` is the whole test; an absent key said nothing.
  *
  * Not exported. It is not "is this refusal durable?": it knows nothing of `durableCodes` or of a
- * wait too long to hold, so a screen branching on it would disagree with `shouldRetry`.
+ * wait too long to hold, so a screen branching on it would disagree with `isRetryable`.
  */
 function waitingNeverHelps(error) {
     const details = field(error, "details");

package/dist/generated/transport.js

@@ -23,7 +23,7 @@
  * - **The header is read first, in both its forms.** Two copies read the body's wait before the
  *   `Retry-After` header, and read the header only as seconds, so an HTTP date was no wait at all.
  */
-import { parseRetryAfter, retryDelayMs, shouldRetry } from "./retry.js";
+import { parseRetryAfter, retryDelayMs, isRetryable } from "./retry.js";
 const DEFAULT_TIMEOUT_MS = 30_000;
 const DEFAULT_MAX_RETRIES = 2;
 /**
@@ -75,7 +75,7 @@ export async function send(transport, spec, params = {}, opts = {}) {
             retryAfterSecs: failure.retryAfterSecs,
         };
         const again = attempt < maxRetries &&
-            shouldRetry(answer, { repeatable, durableCodes: transport.durableCodes });
+            isRetryable(answer, { repeatable, durableCodes: transport.durableCodes });
         if (!again)
             throw transport.error(failure);
         await sleep(retryDelayMs(attempt, answer), signal);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@scrapa/sdk",
-    "version": "0.2.2",
-    "description": "Official TypeScript client for scrapa.app — scrape any web page as markdown, HTML, text, links, a screenshot or a PDF, search the web, and drive a real browser over CDP.",
+    "version": "0.3.0",
+    "description": "Official TypeScript client for scrapa.app. Scrape any web page as markdown, HTML, text, links, a screenshot or a PDF, search the web, and drive a real browser over CDP.",
     "license": "MIT",
     "homepage": "https://scrapa.app",
     "keywords": [

package/src/client.ts

@@ -116,11 +116,11 @@ export class Scrapa extends GeneratedOperations {
         const opts = typeof options === "string" ? { apiKey: options } : options;
         if (!opts.apiKey)
             throw new TypeError(
-                "scrapa: an API key is required — create one at https://console.scrapa.app/keys",
+                "scrapa: an API key is required. Create one at https://console.scrapa.app/keys",
             );
         if (typeof (opts.fetch ?? globalThis.fetch) !== "function")
             throw new TypeError(
-                "scrapa: no global fetch — use Node 20+, or pass `fetch` in the options.",
+                "scrapa: no global fetch. Use Node 20+, or pass `fetch` in the options.",
             );
         const baseUrl = opts.baseUrl ?? DEFAULT_BASE_URL;
         const host = new URL(baseUrl).host;