@hunt-labs/bytekit-sdk 0.11.10 → 0.11.12

package/CHANGELOG.md

@@ -10,6 +10,41 @@ today, see [README.md](./README.md), which remains the authoritative usage guide
 
 ## [Unreleased]
 
+## [0.11.12] - 2026-10-20
+
+### Added
+
+- **`ScrapeJsonFormat` is now exported from the package entry (#5455).** The type of the
+  `{ type: 'json', schema, model?, prompt? }` entry in `ScrapeOpts['formats']`, which the
+  `scrape.create` reference already names, was module-private; it now imports from
+  `@hunt-labs/bytekit-sdk`. Type-only; no runtime or method signature moves.
+
+### Changed
+
+- **`artifact_warnings` on a `/v1/bulk/{id}/screenshots` scrape item now documents the extraction
+  warnings (#5458).** The field also carries the `json` extraction's own warning codes
+  (whether or not the output validated), after any `artifact_unavailable` entry; its description said it reported
+  artifact reference failures only. Regenerated `src/generated/api.d.ts`; description text only,
+  no SDK method signature moves.
+
+## [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

package/dist/generated/api.d.ts

@@ -1207,8 +1207,11 @@ export interface paths {
         put?: never;
         /**
          * Bootstrap account
-         * @description First-time account creation for a Clerk-authenticated user.
-         *     Idempotent — returns 200 if the account already exists, 201 on first creation.
+         * @description First-time bootstrap for a Clerk-authenticated user: the caller joins the
+         *     account of the newest pending invite for the session email (on a live
+         *     account), or, with no such invite, a new account is created.
+         *     Idempotent — returns 200 if the account already exists, 201 on the first
+         *     successful bootstrap (either outcome).
          *     Does not require an existing membership (allowNoMembership=true).
          */
         post: operations["bootstrapAccount"];
@@ -1578,6 +1581,10 @@ export interface components {
             formats?: {
                 raw?: string | null;
                 markdown?: string | null;
+                /** @description The item's `formats.json` result (`data`, `validated`, `model`), present only when the job requested a `json` format and the serialized result fits the 8,192-character bound; `null` when the item has no result. */
+                json?: {
+                    [key: string]: unknown;
+                } | null;
                 links?: null | (string | components["schemas"]["ScrapeScoredLink"])[];
                 images?: null | (string | components["schemas"]["ScrapeScoredImage"])[];
             };
@@ -1770,10 +1777,10 @@ export interface components {
              *     or `images`) or a `json` object entry that extracts structured data from the page.
              *     The string `"json"` is not a format value; the `json` entry is an object, described
              *     by `ScrapeRequestJsonFormat`. A list may hold at most one `json` entry, and a list
-             *     holding only the `json` entry still captures `raw`. The `json` entry exists on
-             *     `POST /v1/scrape` only: the bulk and monitor `formats` fields accept the string
-             *     formats alone. Its result is `formats.json` on the response, and its price is
-             *     described on `ScrapeRequestJsonFormat`.
+             *     holding only the `json` entry still captures `raw`. The `json` entry is accepted on
+             *     `POST /v1/scrape`, `POST /v1/scrape/bulk` and `POST /v1/bulk` (scrape entries);
+             *     monitor `formats` accept the string formats alone. Its result is `formats.json` on the
+             *     response, and its charge is described on `ScrapeRequestJsonFormat`.
              * @default [
              *       "raw"
              *     ]
@@ -1903,11 +1910,17 @@ export interface components {
          * @description The `json` entry of `ScrapeRequest.formats`: structured extraction over the scraped
          *     page, using the same extractor as `POST /v1/schema`.
          *
-         *     **Price.** Each `json` entry costs 10 credits, charged only when the extraction
-         *     validates (`formats.json.validated` is `true`). The charge is on top of the scrape's
-         *     own charge and is never scaled by the scrape's factors. The 10 credits are reserved at
-         *     admission in every billing mode and released again when the extraction does not
-         *     validate. This price is provisional.
+         *     **Charge.** Each `json` entry carries a flat per-extraction credit charge, on top of the
+         *     scrape's own bandwidth charge and never scaled by the scrape's factors. It is charged
+         *     only when the extraction validates (`formats.json.validated` is `true`). The credits are
+         *     reserved at admission in every billing mode and released again when the extraction does
+         *     not validate.
+         *
+         *     **Where it applies.** The entry is accepted in `formats` on `POST /v1/scrape`, in
+         *     `defaults.formats` and each `items[].formats` of `POST /v1/scrape/bulk`, and in the same
+         *     fields of scrape entries on `POST /v1/bulk`. A list holds at most one `json` entry. On
+         *     the bulk endpoints each scrape item carries its own `formats.json` result; an item's own
+         *     `json` entry replaces the one in `defaults`.
          *
          *     **Errors.** A `schema` the extractor cannot take is refused with
          *     `422 schema_incompatible`, and a deployment with no extraction provider refuses the
@@ -1925,13 +1938,14 @@ export interface components {
              *     most 8, it must compile under Ajv, and it must be normalizable into the extractor's
              *     strict subset (root `type: object`, and only the keyword allowlist given there).
              */
-            schema: Record<string, never>;
+            schema: {
+                [key: string]: unknown;
+            };
             /**
-             * @description Extraction model.
-             * @default openai/gpt-oss-20b
+             * @description Extraction model. Defaults to `openai/gpt-oss-20b` when omitted.
              * @enum {string}
              */
-            model: "openai/gpt-oss-20b" | "openai/gpt-oss-120b";
+            model?: "openai/gpt-oss-20b" | "openai/gpt-oss-120b";
             /** @description Optional natural-language extraction hint. */
             prompt?: string;
         };
@@ -1995,7 +2009,9 @@ export interface components {
              */
             json?: {
                 /** @description The extracted object, or `null` whenever `validated` is `false`. */
-                data: Record<string, never> | null;
+                data: {
+                    [key: string]: unknown;
+                } | null;
                 /** @description Whether the extraction produced output matching the schema. The `json` credits are charged only when `true`. */
                 validated: boolean;
                 /** @description The extraction model that ran. */
@@ -4192,7 +4208,7 @@ export interface operations {
                     items?: {
                         /** Format: uri */
                         url: string;
-                        formats?: ("raw" | "markdown" | "links" | "images")[];
+                        formats?: (("raw" | "markdown" | "links" | "images") | components["schemas"]["ScrapeRequestJsonFormat"])[];
                         country?: string;
                         delay_ms?: number;
                         timeout_ms?: number;
@@ -4225,7 +4241,7 @@ export interface operations {
                          *       "raw"
                          *     ]
                          */
-                        formats?: ("raw" | "markdown" | "links" | "images")[];
+                        formats?: (("raw" | "markdown" | "links" | "images") | components["schemas"]["ScrapeRequestJsonFormat"])[];
                         /** @default US */
                         country?: string;
                         /** @default 0 */
@@ -5273,7 +5289,7 @@ export interface operations {
                         language?: string | null;
                         dark_mode?: boolean;
                         /** @description Scrape output formats (scrape entries). */
-                        formats?: ("raw" | "markdown" | "links" | "images")[];
+                        formats?: (("raw" | "markdown" | "links" | "images") | components["schemas"]["ScrapeRequestJsonFormat"])[];
                         /** @enum {string} */
                         wait_until?: "load" | "domcontentloaded" | "networkidle";
                         wait_for_selector?: string | null;
@@ -5326,7 +5342,7 @@ export interface operations {
                         language?: string | null;
                         /** @default false */
                         dark_mode?: boolean;
-                        formats?: ("raw" | "markdown" | "links" | "images")[];
+                        formats?: (("raw" | "markdown" | "links" | "images") | components["schemas"]["ScrapeRequestJsonFormat"])[];
                         /**
                          * @default load
                          * @enum {string}
@@ -5700,14 +5716,18 @@ export interface operations {
                             markdown?: string | null;
                             /** @description `type: scrape` only. Pre-signed download URL for the markdown rendering of the page, valid for 600 seconds (10 minutes) from the moment this response was generated — the same signing TTL as `content_url` and `image_url` above. A new signature is minted on every poll for a completed item with a markdown key. For every other item the stored value is returned unchanged — `null` while no markdown has been stored, and otherwise a private, unsigned storage URL that returns 401 on download. No `artifact_warnings` entry is raised for this field; unlike `GET /v1/fetch/bulk/{id}`, this endpoint reports no `artifact_unavailable` when signing fails. */
                             markdown_url?: string | null;
-                            /** @description `type: scrape` only. Exact requested artifact values or signed references. Every key is present; unrequested or unavailable values are null, with nonfatal reference failures in `artifact_warnings`. */
+                            /** @description `type: scrape` only. Exact requested artifact values or signed references. `raw`, `markdown`, `links` and `images` are always present; unrequested or unavailable values are null, with nonfatal warnings in `artifact_warnings`. `json` is present only on an item that requested a `json` format. */
                             artifacts?: {
                                 raw: string | null;
                                 markdown: string | null;
+                                /** @description The item's `json` format result (`data`, `validated`, `model`); `null` while the item has stored none. */
+                                json?: {
+                                    [key: string]: unknown;
+                                } | null;
                                 links: null | (string | components["schemas"]["ScrapeScoredLink"])[];
                                 images: null | (string | components["schemas"]["ScrapeScoredImage"])[];
                             };
-                            /** @description Nonfatal artifact reference failures for this scrape item. */
+                            /** @description Nonfatal warnings for this scrape item. An `artifact_unavailable` entry reports a requested artifact whose reference failed, and comes first. For a `json` format, the extraction's own warning codes follow, with `element: null`, whether or not the output validated (`content_truncated` can accompany a validated result); `artifacts.json` is still returned as stored. */
                             artifact_warnings?: components["schemas"]["ScrapeWarning"][];
                         } | {
                             /** @description Prefixed id — `ss_` / `rec_` / `sc_` per `type`. The same stable identity the ordinary item carries. */
@@ -7752,7 +7772,7 @@ export interface operations {
                     "application/json": components["schemas"]["Account"];
                 };
             };
-            /** @description Account created. */
+            /** @description First successful bootstrap: the caller joined a pending invite's account, or a new account was created. */
             201: {
                 headers: {
                     [name: string]: unknown;

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export type { ByteKitOptions, RequestOptions, ApiResponse, ConnectionErrorCode,
 export { V01_METHODS } from './allowlist.js';
 export type { V01Method } from './allowlist.js';
 export type { ScrapeId, ScreenshotId, BulkId, MonitorId, SitemapId, ApiKeyId, WebhookDeliveryId, SearchType, SearchDateRange, SearchOpts, SearchResult, SearchResultImage, SearchResponse, } from './types.js';
-export type { ScrapeOpts, MarkdownMode, MarkdownLinks, MarkdownImages, TokenEncoding, ScrapeCreateResponse, ScrapeGetResponse, ScrapeBulkCreateRequest, ScrapeBulkCreateResponse, ScrapeBulkGetResponse, } from './resources/scrape.js';
+export type { ScrapeOpts, MarkdownMode, MarkdownLinks, MarkdownImages, TokenEncoding, ScrapeJsonFormat, ScrapeCreateResponse, ScrapeGetResponse, ScrapeBulkCreateRequest, ScrapeBulkCreateResponse, ScrapeBulkGetResponse, } from './resources/scrape.js';
 export type { ScreenshotCreateRequest, ScreenshotCreateResponse, ScreenshotGetResponse, } from './resources/screenshots.js';
 export type { FetchOpts, FetchGetOpts, FetchResult, FetchCacheStatus, FetchBulkCreateRequest, FetchBulkCreateResponse, FetchBulkGetResponse, } from './resources/fetch.js';
 export type { MonitorCreateRequest, MonitorCreateResponse, ListMonitorsParams, MonitorStatus, ListMonitorsResponse, MonitorResponse, MonitorUpdateRequest, UpdateMonitorResponse, ListMonitorCapturesResponse, } from './resources/monitors.js';

package/dist/resources/scrape.d.ts

@@ -1,5 +1,5 @@
 import type { ByteKit, RequestOptions } from '../client.js';
-import type { operations } from '../generated/api.js';
+import type { components, operations } from '../generated/api.js';
 import type { ScrapeId, BulkId } from '../types.js';
 /**
  * Response of POST /v1/scrape — the WIRE union: a 200 terminal envelope or a 202
@@ -48,10 +48,13 @@ export type MarkdownLinks = 'inline' | 'references' | 'none' | 'text';
 export type MarkdownImages = 'inline' | 'references' | 'none' | 'text';
 /** Tokenizer encoding hint for `token_budget`. */
 export type TokenEncoding = 'cl100k_base' | 'o200k_base';
+/** The `{ type: 'json', schema }` entry of `formats`, typed from the spec. */
+export type ScrapeJsonFormat = components['schemas']['ScrapeRequestJsonFormat'];
 /** Options for POST /v1/scrape. */
 export interface ScrapeOpts {
     url: string;
-    formats?: Array<'raw' | 'markdown' | 'links' | 'images'>;
+    /** String formats, plus at most one `{ type: 'json', schema }` entry for structured extraction (the entry's result is `formats.json`). */
+    formats?: Array<'raw' | 'markdown' | 'links' | 'images' | ScrapeJsonFormat>;
     country?: string;
     delay_ms?: number;
     /** SERVER-side scrape budget in ms — how long the server may spend on the scrape itself. For the CLIENT-side abort budget (when this SDK gives up on the wire), see `RequestOptions.requestTimeoutMs`. */

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.10";
+export declare const SDK_VERSION = "0.11.12";

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.10';
+export const SDK_VERSION = '0.11.12';

package/package.json

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