@hunt-labs/bytekit-sdk 0.11.9 → 0.11.11

package/CHANGELOG.md

@@ -10,6 +10,92 @@ today, see [README.md](./README.md), which remains the authoritative usage guide
 
 ## [Unreleased]
 
+## [0.11.11] - 2026-10-14
+
+### Changed
+
+- **`scrape.create` takes the `json` format (#5133).** `ScrapeOpts.formats` now accepts one
+  `{ type: 'json', schema, model?, prompt? }` entry beside the string formats; before, the option
+  type rejected it at compile time. The generated bulk create types (`scrape.bulk.create`,
+  `bulk.create`) take the same entry in `defaults.formats` and `items[].formats`, and
+  `ScrapeRequestJsonFormat` is now usable as written: `schema` is a free-form object (it generated
+  as `Record<string, never>`, which no schema could satisfy) and `model` is optional (the spec's
+  `default` keyword typed it as required; the default is now stated in its description). Regenerated
+  `src/generated/api.d.ts`; a request with string formats only is unchanged.
+
+- **`POST /v1/account/bootstrap` types describe the joined-invite outcome (#5093).** The internal
+  operation's description and `201` response said only "account created"; since #5058 a `201`
+  also means the caller joined the newest pending invite's account. Regenerated
+  `src/generated/api.d.ts`; description text only, no SDK method signature moves.
+
+## [0.11.10] - 2026-10-02
+
+### Changed
+
+- **`GET /v1/scrape/{id}` types now declare the response headers it sends (#4425).** The `200`
+  response of `getScrape` carried no `headers` map, so the `X-Scrape-*` and billing headers the
+  endpoint already emitted were invisible to typed clients. They are now declared, all optional (a
+  queued or processing poll carries none). Regenerated `src/generated/api.d.ts`; no SDK method
+  signature moves.
+- **`POST /v1/schema` types no longer describe a feature flag (#4972).** The endpoint is always
+  registered, so the "gated by a server-side feature flag" doc comment and the `404` "feature flag
+  disabled" response are removed from `src/generated/api.d.ts`. No SDK method signature moves.
+- **Internal billing types follow the in-app card flow (#5101).** The internal
+  `POST /v1/billing/register` operation is now a legacy terminal: its types carry no request body
+  and a single `410` response (card setup moved to `POST /v1/billing/payment-methods/setup`). The
+  internal `DELETE /v1/billing/payment-methods/{id}` description adds that removing the last card
+  turns auto-topup off. Regenerated `src/generated/api.d.ts`; no public SDK method signature moves.
+- **Internal top-up types follow the in-app payment (#5102).** The internal
+  `POST /v1/billing/topup` operation now takes `{ amount_cents, return_url }` (no
+  `success_url`/`cancel_url`) and answers `{ client_secret, session_id }` instead of
+  `{ checkout_url, session_id }`. Regenerated `src/generated/api.d.ts`; no public SDK method
+  signature moves.
+- **Internal billing types follow the retired portal (#5106).** The internal
+  `POST /v1/billing/portal` operation is now a legacy terminal: its types carry no request body
+  and a single `410` response (billing actions stay in the dashboard), and the `portal_url`
+  response field is gone. The internal `GET /v1/billing/invoices` description now says invoices
+  are newest first and are paged with `starting_after`, and `has_more` is documented. Regenerated
+  `src/generated/api.d.ts`; no public SDK method signature moves.
+- **Bearer operations now type a `401` response (#5114).** Every non-deprecated bearer
+  operation declares `401` (the shared `Unauthorized` response, an `Error` envelope whose
+  `error.code` is `invalid_api_key` or `unauthorized`) in `src/generated/api.d.ts`. No SDK method
+  signature or runtime behavior moves: a `401` still throws `ByteKitError`.
+- **The `401` description lists expired keys (#5242).** The shared `Unauthorized` response now
+  says `invalid_api_key` is returned for an unknown, revoked, expired or malformed key, matching
+  the key lookup. Regenerated `src/generated/api.d.ts`; description text only, no type or SDK
+  method signature moves.
+- **`ScrapeWarning.code` gains the five extraction codes (#5130).** `extract_validation_failed`,
+  `exhausted_retries`, `content_truncated`, `model_refusal` and `empty_extraction` can now appear
+  in a scrape's `warnings[]`, matching what the server emits. Regenerated
+  `src/generated/api.d.ts`; the code union widens, no SDK
+  method signature moves.
+- **`POST /v1/scrape` and `POST /v1/screenshots` accept `async` in the body or the query string
+  (#5349).** The request is async when either spelling says `true`; `false` in one never cancels
+  `true` in the other. Regenerated `src/generated/api.d.ts` (`ScreenshotRequest` gains `async`;
+  `createScrape` gains an `async` query parameter). No SDK method signature moves: the existing
+  screenshots `{ async }` option keeps sending `?async=true`.
+- **`WebhookDeliveryResponse.event_type` gains `monitor.suspended` (#5408).** The worker sends
+  this event (header `X-ByteKit-Event`) when a monitor is suspended because the account ran out of
+  balance, and `GET /v1/webhook-deliveries` can return it; the spec's enum now lists it. Regenerated
+  `src/generated/api.d.ts`; the union widens, no SDK method signature moves.
+- **Generated types follow the corrected spec for screenshots, search, fetch, the bulk creates,
+  sitemap, schema and the `json` format entry (#5410).** `ScrapeRequest.formats` items are now
+  `ScrapeRequestFormatsItem | ScrapeRequestJsonFormat` (the four string formats, or the `json`
+  object entry), `ScrapeFormats` gains `json`, and the new `ScrapeRequestJsonFormat` component
+  types the entry. `createScreenshot` and `createSitemap` type a `403` (`host_forbidden` /
+  `path_forbidden`), the three bulk creates a `403` `url_forbidden` body, `createScrape` a `503`
+  `provider_unavailable`, `createSearch` a `503` that is either the vendor-masked body or the
+  `Error` envelope, `createSchemaExtraction` a `500`, and `getFetch` a `custom` query parameter
+  (not exposed by `fetch.get`, which keeps `custom` a `create()` option). `query` is capped at
+  2048 characters, `country` on `/v1/fetch` takes either case, and the descriptions of the
+  `/v1/fetch`, bulk, sitemap and schema operations are corrected. Regenerated
+  `src/generated/api.d.ts`; no SDK method signature moves.
+- **`X-Raw-Bytes` on `createScrape` and `getScrape` is described as compressed wire bytes (#5424).**
+  The `200` header description read "Uncompressed body byte count"; the gateway sends the
+  compressed wire-byte billing basis, so the description now says that and that it is not the
+  decompressed size. Regenerated `src/generated/api.d.ts`; description text only, no SDK method
+  signature moves.
+
 ## [0.11.9] - 2026-10-02
 
 ### Changed