@hunt-labs/bytekit-sdk 0.11.5 → 0.11.6

package/CHANGELOG.md

@@ -10,6 +10,15 @@ today, see [README.md](./README.md), which remains the authoritative usage guide
 
 ## [Unreleased]
 
+## [0.11.6] - 2026-09-24
+
+### Changed
+
+- Regenerated `src/generated/api.d.ts` (#4865): a documentation-wording correction to the
+  `POST /v1/schema` billing description, which now says the page bandwidth is billed at its
+  upstream wire bytes with no endpoint factor instead of "exactly like `/v1/scrape`". No
+  behavior change: doc comments only, no SDK signature moves.
+
 ## [0.11.5] - 2026-09-22
 
 ### Changed

package/README.md

@@ -358,7 +358,7 @@ try {
 
 Note that `details` is populated only from the API's canonical
 `{ error: { … } }` envelope. A few endpoints answer with a flat, vendor-masked
-body instead (`/v1/search` returns `502 {"error":"search_provider_error"}`);
+body instead (`/v1/search` returns `503 {"error":"search_provider_error"}`);
 those carry no structured detail, so `err.details` stays `undefined` there —
 `err.code` is still the machine-readable reason.
 

package/dist/client.d.ts

@@ -103,7 +103,7 @@ export declare class ByteKitError extends Error {
      * The envelope's `error.details`, when it carried one — `undefined` otherwise.
      *
      * Populated ONLY from the canonical `{ error: { … } }` envelope. A flat
-     * vendor-masked body (`/v1/search` 502 `{"error":"search_provider_error"}`)
+     * vendor-masked body (`/v1/search` 503 `{"error":"search_provider_error"}`)
      * has no envelope to read a detail from, so it never grows one (#2685 E3).
      *
      * A `details` that is not a JSON object — which the untyped spec field

package/dist/client.js

@@ -470,9 +470,9 @@ export class ByteKit {
                         }
                     }
                     else if (typeof json.error === 'string' && json.error.length > 0) {
-                        // Flat vendor-masked shape, e.g. /v1/search 502
+                        // Flat vendor-masked shape, e.g. /v1/search 503
                         // {"error":"search_provider_error"} (docs/api/openapi.yaml §/v1/search
-                        // 502). The string IS the error code. `message` falls back to it only
+                        // 503). The string IS the error code. `message` falls back to it only
                         // when the response carried no statusText, so the thrown error is
                         // never message-empty.
                         code = json.error;

package/dist/generated/api.d.ts

@@ -640,7 +640,8 @@ export interface paths {
          *     `wait_for_selector`) cause a `400 unsupported_option`.
          *
          *     Dual-axis billing: a fixed per-request credit charge **plus** the
-         *     underlying page's bandwidth, billed exactly like `/v1/scrape`. The
+         *     underlying page's bandwidth, billed at its upstream wire bytes with no
+         *     endpoint factor (a 100 KiB estimate is pre-charged, then reconciled). The
          *     bandwidth is still billed when the scrape succeeds but extraction later
          *     fails; both axes are refunded only when the scrape itself never runs.
          *
@@ -4175,35 +4176,20 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /**
-             * @description Content transform failed, or a non-2xx upstream response relayed as the unified
-             *     Error envelope. On an upstream relay the HTTP status equals the upstream status
-             *     (code `upstream_error`), so any 4xx/5xx the target returns surfaces here as an
-             *     Error envelope rather than a raw body (#1462).
-             *
-             *     **One divergence.** An upstream `502` is relayed at HTTP `503`, not `502` — see
-             *     the `503` response below. A fetch service that cannot be reached also answers
-             *     `503`, not `502` (#3373); this status no longer covers that condition.
-             */
-            502: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
             /**
              * @description Two distinct conditions answer `503`, and they disagree about what the body's
              *     `error.http_status` reports. Read `error.code` to tell them apart.
              *
-             *     - **`upstream_error`** — the target returned HTTP `502`, relayed here as `503`.
-             *       Cloudflare fronts this API and replaces a clean origin 502 with its own generic
-             *       `text/plain` error page, discarding the envelope before it reaches you, while a
-             *       503 is passed through unchanged. The body's `error.http_status` still reports
-             *       the **true upstream status**, `502` — not `503` — and is the only surviving
-             *       record of what the target answered, so the body rather than the HTTP status is
-             *       authoritative here (#3355).
+             *     - **`upstream_error`** — the target returned HTTP `502` or `504`, relayed here as
+             *       `503`. Cloudflare fronts this API and replaces a clean origin 502 or 504 with its
+             *       own generic `text/plain` error page, discarding the envelope before it reaches
+             *       you, while a 503 is passed through unchanged. The body's `error.http_status`
+             *       still reports the **true upstream status**, `502` or `504` — not `503` — and is
+             *       the only surviving record of what the target answered, so the body rather than
+             *       the HTTP status is authoritative here (#3355, #4891). Every other non-2xx
+             *       upstream response is relayed at its own HTTP status with the same
+             *       `upstream_error` envelope, so any other 4xx/5xx the target returns surfaces as an
+             *       Error envelope rather than a raw body (#1462).
              *     - **`internal_error`** (message `Fetch service unavailable.`) — no fetch service
              *       endpoint could be resolved on this deployment, a fault of this API and not of the
              *       target. There is no upstream status to preserve: the `503` is this API's own
@@ -4325,35 +4311,20 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /**
-             * @description Content transform failed, or a non-2xx upstream response relayed as the unified
-             *     Error envelope. On an upstream relay the HTTP status equals the upstream status
-             *     (code `upstream_error`), so any 4xx/5xx the target returns surfaces here as an
-             *     Error envelope rather than a raw body (#1462).
-             *
-             *     **One divergence.** An upstream `502` is relayed at HTTP `503`, not `502` — see
-             *     the `503` response below. A fetch service that cannot be reached also answers
-             *     `503`, not `502` (#3373); this status no longer covers that condition.
-             */
-            502: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
             /**
              * @description Two distinct conditions answer `503`, and they disagree about what the body's
              *     `error.http_status` reports. Read `error.code` to tell them apart.
              *
-             *     - **`upstream_error`** — the target returned HTTP `502`, relayed here as `503`.
-             *       Cloudflare fronts this API and replaces a clean origin 502 with its own generic
-             *       `text/plain` error page, discarding the envelope before it reaches you, while a
-             *       503 is passed through unchanged. The body's `error.http_status` still reports
-             *       the **true upstream status**, `502` — not `503` — and is the only surviving
-             *       record of what the target answered, so the body rather than the HTTP status is
-             *       authoritative here (#3355).
+             *     - **`upstream_error`** — the target returned HTTP `502` or `504`, relayed here as
+             *       `503`. Cloudflare fronts this API and replaces a clean origin 502 or 504 with its
+             *       own generic `text/plain` error page, discarding the envelope before it reaches
+             *       you, while a 503 is passed through unchanged. The body's `error.http_status`
+             *       still reports the **true upstream status**, `502` or `504` — not `503` — and is
+             *       the only surviving record of what the target answered, so the body rather than
+             *       the HTTP status is authoritative here (#3355, #4891). Every other non-2xx
+             *       upstream response is relayed at its own HTTP status with the same
+             *       `upstream_error` envelope, so any other 4xx/5xx the target returns surfaces as an
+             *       Error envelope rather than a raw body (#1462).
              *     - **`internal_error`** (message `Fetch service unavailable.`) — no fetch service
              *       endpoint could be resolved on this deployment, a fault of this API and not of the
              *       target. There is no upstream status to preserve: the `503` is this API's own
@@ -5737,13 +5708,14 @@ export interface operations {
                 };
             };
             /**
-             * @description Upstream search provider error. The body is a fixed,
+             * @description Upstream search provider error, answered at `503` rather than `502` because
+             *     Cloudflare replaces an origin 502 body with its own page (#4891). The body is a fixed,
              *     vendor-masked shape — deliberately NOT the unified `Error`
              *     envelope. The upstream provider's identity and message are
              *     never surfaced, so the response carries only the constant
              *     `error` code `search_provider_error`.
              */
-            502: {
+            503: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -5903,16 +5875,15 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description Underlying scrape failed (`scrape_failed`) or upstream provider error (`provider_error`). */
-            502: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
-            /** @description Extraction provider unconfigured (`provider_unavailable`). */
+            /**
+             * @description Read `error.code` to tell the conditions apart: underlying scrape failed or the
+             *     extraction service was unreachable (`scrape_failed`), upstream provider error
+             *     (`provider_error`), extraction provider unconfigured (`provider_unavailable`), or
+             *     upstream provider timed out (`provider_timeout`). None of these answers `502` or
+             *     `504`: Cloudflare fronts this API and replaces an origin 502 or 504 with its own
+             *     `text/plain` page, discarding the error envelope, while a 503 passes through
+             *     unchanged (#4891).
+             */
             503: {
                 headers: {
                     [name: string]: unknown;
@@ -5921,15 +5892,6 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description Upstream provider timed out (`provider_timeout`). */
-            504: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["Error"];
-                };
-            };
         };
     };
     getUsage: {
@@ -6401,8 +6363,8 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description Stripe error creating the Checkout session. */
-            502: {
+            /** @description Stripe error creating the Checkout session (`stripe_error`). Answered at `503`, not `502`, because Cloudflare replaces an origin 502 body with its own page (#4891). */
+            503: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -6473,8 +6435,8 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description The Stripe subscription schedule could not be read. */
-            502: {
+            /** @description The Stripe subscription schedule could not be read (`stripe_error`). Answered at `503`, not `502`, because Cloudflare replaces an origin 502 body with its own page (#4891). */
+            503: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -6871,8 +6833,8 @@ export interface operations {
                     "application/json": components["schemas"]["Error"];
                 };
             };
-            /** @description Stripe API error. */
-            502: {
+            /** @description Stripe API error (`stripe_error`). Answered at `503`, not `502`, because Cloudflare replaces an origin 502 body with its own page (#4891). */
+            503: {
                 headers: {
                     [name: string]: unknown;
                 };

package/dist/version.d.ts

@@ -5,4 +5,4 @@
  * outbound request carries — see the emit site in `client.ts`. The header name is spelled
  * only there, so issue #2905's pre-merge gate 1 counts exactly one occurrence in `src/`.
  */
-export declare const SDK_VERSION = "0.11.5";
+export declare const SDK_VERSION = "0.11.6";

package/dist/version.js

@@ -9,4 +9,4 @@
  * outbound request carries — see the emit site in `client.ts`. The header name is spelled
  * only there, so issue #2905's pre-merge gate 1 counts exactly one occurrence in `src/`.
  */
-export const SDK_VERSION = '0.11.5';
+export const SDK_VERSION = '0.11.6';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hunt-labs/bytekit-sdk",
-  "version": "0.11.5",
+  "version": "0.11.6",
   "description": "Official TypeScript SDK for the ByteKit API",
   "license": "MIT",
   "type": "module",