@scrapa/sdk 0.4.0 → 0.5.0

package/dist/generated/operations.js

@@ -4,7 +4,7 @@
 // One method per capability, grouped the way the docs group them, returning the
 // DTO the operation declares. `Scrapa` in ../client.ts supplies request().
 /** The version this client reports in `x-scrapa-client`. */
-export const SDK_VERSION = "0.4.0";
+export const SDK_VERSION = "0.5.0";
 /** The hosted API. */
 export const DEFAULT_BASE_URL = "https://api.scrapa.app/v1";
 export class GeneratedOperations {
@@ -17,14 +17,18 @@ export class GeneratedOperations {
      * turns out to be a JavaScript shell, so you pay for a browser only when the page needed one.
      * To send a search form or a JSON query, use `method: "POST"` with a `body`; to download a
      * file exactly as the site sent it, ask for `formats: ["raw"]`. A link to a PDF or a Word file
-     * is read into text too, headings and paragraphs included. Every request leaves through a
-     * residential proxy, or through your own with `proxy: { pool: "custom", server }`. The answer
-     * says which engine replied, where the page finally was and what it cost.
+     * is read into text too, headings and paragraphs included. To click a cookie banner, type into
+     * a search box or run a script before the page is read, send `browser.actions`. Every request
+     * leaves through a residential proxy, or through your own with `proxy: { pool: "custom",
+     * server }`. The answer says which engine replied, where the page finally was and what it
+     * cost.
      *
      * Credits: 1 credit with the fetch engine, 5 with the browser (a screenshot or a PDF is
      * included, never a surcharge), 5 more when you ask for `extract`, plus managed-proxy
-     * bandwidth past the first megabyte. A page the site blocked, a URL our policy refused and
-     * anything we broke all cost nothing.
+     * bandwidth past the first megabyte. A page the site blocked and a URL our policy refused cost
+     * nothing, unless your own `browser.actions` script ran in the page first. Anything we broke
+     * costs nothing, and neither does a page served from a copy you read earlier (`maxAge`),
+     * though `extract` on it is still charged.
      *
      * `POST /v1/scrape`
      */
@@ -42,7 +46,8 @@ export class GeneratedOperations {
      * What the same request would cost, without making it. Free, and refused by the same guards a
      * real call meets, so a quote is never a price for a call that would be denied. `maxCost` is
      * the ceiling: for `auto` it is the browser's price, which is only charged if the page turns
-     * out to need one.
+     * out to need one. With `maxAge`, the quote is the price of reading the page now; if a copy is
+     * there, the page costs nothing and only `extract` is charged.
      *
      * Credits: 0 credits. Pricing a call is free.
      *
@@ -68,7 +73,8 @@ export class GeneratedOperations {
      *
      * Credits: 2 credits, plus managed-proxy bandwidth past the first megabyte, every file the map
      * read counted together. A site that lists nothing is charged, because it answered. A site
-     * that refused every file, and anything we broke, cost nothing.
+     * that refused every file, and anything we broke, cost nothing. When our side fails partway,
+     * you still get the URLs found so far, with `truncated: true`.
      *
      * `POST /v1/map`
      */
@@ -106,9 +112,9 @@ export class GeneratedOperations {
      * holds. They are read live off a real search front through a residential exit, never a
      * reseller's cache. `country` picks both the exit and the market, so `br` returns what
      * somebody in Brazil would see. Narrow to your own list of hosts with `includeDomains`, ask
-     * for `topic: "news"` when you want dated journalism, and add `answer: true` when you want a
-     * paragraph written over the results instead of writing it yourself. To read a result, pass
-     * its URL to `scrape`.
+     * for `topic: "news"` when you want dated journalism or `topic: "images"` when you want
+     * pictures, and add `answer: true` when you want a paragraph written over the results instead
+     * of writing it yourself. To read a result, pass its URL to `scrape`.
      *
      * Credits: 4 credits per 10 results, so a `limit` above 10 costs two rows, plus 1 for `answer:
      * true`. A search every front refused, and anything we broke, cost nothing; a search that ran
@@ -131,15 +137,17 @@ export class GeneratedOperations {
          *
          * Hand us a list of URLs and stop holding a connection open. Every one is read with the
          * options you pass here. It uses the same engines, the same exit and the same meter as a
-         * single `scrape`, and a page the site blocked costs nothing here too. Nothing is charged
-         * when you submit: a batch spends as it goes, so use `quote` for the ceiling. Poll `get`
-         * for progress, or pass a `webhook` and we will call you instead. Results are readable for
-         * 24 hours.
+         * single `scrape`, and a page the site blocked costs nothing here too, unless your own
+         * `browser.actions` script ran in the page first. Nothing is charged when you submit: a
+         * batch spends as it goes, so use `quote` for the ceiling. Poll `get` for progress, or
+         * pass a `webhook` and we will call you instead. Results are readable for 24 hours from
+         * when you submit. A batch still running then stops, and the URLs it has not read are
+         * `skipped`, free.
          *
          * Credits: Creating a batch is free, and nothing is held: each URL then costs exactly what
          * the same call would have cost on its own, and the pages the web refused cost nothing
-         * here too. What the batch has spent so far is on the batch itself, and it grows while it
-         * runs.
+         * here too, unless your own `browser.actions` script ran in them first. What the batch has
+         * spent so far is on the batch itself, and it grows while it runs.
          *
          * `POST /v1/batches`
          */
@@ -153,9 +161,11 @@ export class GeneratedOperations {
          * Price a batch
          *
          * What that submission would cost at most, without submitting it. `maxCost` prices every
-         * URL at the ceiling one page could reach, so the real bill comes in lower by whatever the
-         * web refuses for free and by every page that never needed a browser. Bandwidth is on top
-         * and cannot be quoted, because it depends on what the pages weigh.
+         * URL at the ceiling one page could reach. The real bill comes in lower by every page that
+         * never needed a browser and by every outcome that costs nothing: a page the site blocked
+         * or our policy refused (unless your own `browser.actions` script ran in it first) and
+         * anything we broke. Bandwidth is on top and cannot be quoted, because it depends on what
+         * the pages weigh.
          *
          * Credits: 0 credits. Pricing a batch is free.
          *

package/dist/generated/operations.js.map

@@ -1 +1 @@
-{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../src/generated/operations.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,0DAA0D;AAC1D,EAAE;AACF,gFAAgF;AAChF,2EAA2E;AAmC3E,4DAA4D;AAC5D,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC;AAEnC,sBAAsB;AACtB,MAAM,CAAC,MAAM,gBAAgB,GAAG,2BAA2B,CAAC;AAE5D,MAAM,OAAgB,mBAAmB;IAOrC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACF,MAAoB,EACpB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CACD,MAAyB,EACzB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,eAAe;YACrB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,GAAG,CACC,MAAqB,EACrB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;SACvC,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACJ,MAAsB,EACtB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;SACvC,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACF,MAAoB,EACpB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;SACvC,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAEQ,OAAO,GAAG;QACf;;;;;;;;;;;;;;;;WAgBG;QACH,MAAM,EAAE,CACJ,MAAyB,EACzB,IAA6C,EACrB,EAAE,CAC1B,IAAI,CAAC,OAAO,CACR;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP;QACL;;;;;;;;;;;WAWG;QACH,KAAK,EAAE,CACH,MAAwB,EACxB,IAA6C,EACvB,EAAE,CACxB,IAAI,CAAC,OAAO,CACR;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gBAAgB;YACtB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP;QACL;;;;;;;;;WASG;QACH,IAAI,EAAE,CACF,MAA0B,EAC1B,IAA6C,EAC1B,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC;QACzF;;;;;;;;;;;;;;WAcG;QACH,GAAG,EAAE,CACD,MAAsB,EACtB,IAA6C,EAC5B,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC;QAC3F;;;;;;;;;;;WAWG;QACH,MAAM,EAAE,CACJ,MAAyB,EACzB,IAA6C,EAC5B,EAAE,CACnB,IAAI,CAAC,OAAO,CACR,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,EAAE,EAC5D,MAAM,EACN,IAAI,CACP;KACR,CAAC;IAEO,QAAQ,GAAG;QAChB;;;;;;;;;;;;;;;;WAgBG;QACH,MAAM,EAAE,CACJ,MAA4B,EAC5B,IAA6C,EACtB,EAAE,CACzB,IAAI,CAAC,OAAO,CACR;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP;QACL;;;;;;;;;;WAUG;QACH,KAAK,EAAE,CACH,MAA2B,EAC3B,IAA6C,EACrB,EAAE,CAC1B,IAAI,CAAC,OAAO,CACR;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP;QACL;;;;;;;;;WASG;QACH,IAAI,EAAE,CACF,MAA2B,EAC3B,IAA6C,EACxB,EAAE,CACvB,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC;QACpE;;;;;;;;;;WAUG;QACH,GAAG,EAAE,CACD,MAAwB,EACxB,IAA6C,EAC1B,EAAE,CACrB,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC;QACxE;;;;;;;;;;;WAWG;QACH,KAAK,EAAE,CACH,MAA0B,EAC1B,IAA6C,EAC1B,EAAE,CACrB,IAAI,CAAC,OAAO,CACR,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,EAC7D,MAAM,EACN,IAAI,CACP;KACR,CAAC;IAEO,KAAK,GAAG;QACb;;;;;;;;;;WAUG;QACH,GAAG,EAAE,CAAC,IAA6C,EAAqB,EAAE,CACtE,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC;KACvE,CAAC;CACL"}
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../src/generated/operations.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,0DAA0D;AAC1D,EAAE;AACF,gFAAgF;AAChF,2EAA2E;AAmC3E,4DAA4D;AAC5D,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC;AAEnC,sBAAsB;AACtB,MAAM,CAAC,MAAM,gBAAgB,GAAG,2BAA2B,CAAC;AAE5D,MAAM,OAAgB,mBAAmB;IAOrC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CACF,MAAoB,EACpB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CACD,MAAyB,EACzB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,eAAe;YACrB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CACC,MAAqB,EACrB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,MAAM;YACZ,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;SACvC,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACJ,MAAsB,EACtB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;SACvC,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACF,MAAoB,EACpB,IAA6C;QAE7C,OAAO,IAAI,CAAC,OAAO,CACf;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;SACvC,EACD,MAAM,EACN,IAAI,CACP,CAAC;IACN,CAAC;IAEQ,OAAO,GAAG;QACf;;;;;;;;;;;;;;;;;;WAkBG;QACH,MAAM,EAAE,CACJ,MAAyB,EACzB,IAA6C,EACrB,EAAE,CAC1B,IAAI,CAAC,OAAO,CACR;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU;YAChB,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP;QACL;;;;;;;;;;;;;WAaG;QACH,KAAK,EAAE,CACH,MAAwB,EACxB,IAA6C,EACvB,EAAE,CACxB,IAAI,CAAC,OAAO,CACR;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gBAAgB;YACtB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP;QACL;;;;;;;;;WASG;QACH,IAAI,EAAE,CACF,MAA0B,EAC1B,IAA6C,EAC1B,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC;QACzF;;;;;;;;;;;;;;WAcG;QACH,GAAG,EAAE,CACD,MAAsB,EACtB,IAA6C,EAC5B,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC;QAC3F;;;;;;;;;;;WAWG;QACH,MAAM,EAAE,CACJ,MAAyB,EACzB,IAA6C,EAC5B,EAAE,CACnB,IAAI,CAAC,OAAO,CACR,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,IAAI,EAAE,EAC5D,MAAM,EACN,IAAI,CACP;KACR,CAAC;IAEO,QAAQ,GAAG;QAChB;;;;;;;;;;;;;;;;WAgBG;QACH,MAAM,EAAE,CACJ,MAA4B,EAC5B,IAA6C,EACtB,EAAE,CACzB,IAAI,CAAC,OAAO,CACR;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE,KAAK;YACjB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP;QACL;;;;;;;;;;WAUG;QACH,KAAK,EAAE,CACH,MAA2B,EAC3B,IAA6C,EACrB,EAAE,CAC1B,IAAI,CAAC,OAAO,CACR;YACI,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,iBAAiB;YACvB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC;SACxD,EACD,MAAM,EACN,IAAI,CACP;QACL;;;;;;;;;WASG;QACH,IAAI,EAAE,CACF,MAA2B,EAC3B,IAA6C,EACxB,EAAE,CACvB,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC;QACpE;;;;;;;;;;WAUG;QACH,GAAG,EAAE,CACD,MAAwB,EACxB,IAA6C,EAC1B,EAAE,CACrB,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC;QACxE;;;;;;;;;;;WAWG;QACH,KAAK,EAAE,CACH,MAA0B,EAC1B,IAA6C,EAC1B,EAAE,CACrB,IAAI,CAAC,OAAO,CACR,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,eAAe,EAAE,UAAU,EAAE,IAAI,EAAE,EAC7D,MAAM,EACN,IAAI,CACP;KACR,CAAC;IAEO,KAAK,GAAG;QACb;;;;;;;;;;WAUG;QACH,GAAG,EAAE,CAAC,IAA6C,EAAqB,EAAE,CACtE,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC;KACvE,CAAC;CACL"}