@hunt-labs/bytekit-sdk 0.11.11 → 0.11.13

package/CHANGELOG.md

@@ -10,6 +10,34 @@ today, see [README.md](./README.md), which remains the authoritative usage guide
 
 ## [Unreleased]
 
+## [0.11.13] - 2026-10-21
+
+### Changed
+
+- **The scrape envelope's `warnings` description now names the `json` extraction codes (#5469).**
+  A request carrying a `json` format can get `extract_validation_failed`, `exhausted_retries`,
+  `content_truncated`, `model_refusal` and `empty_extraction` in `warnings`, without
+  `markdown_include_warnings`, whether or not the extraction validated; the description listed only
+  markdown-pipeline, tag-filter and `artifact_unavailable` warnings. Regenerated
+  `src/generated/api.d.ts`; description text only, no SDK method signature moves.
+
+## [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

package/dist/generated/api.d.ts

@@ -2139,7 +2139,7 @@ export interface components {
             metadata: components["schemas"]["ScrapeMetadata"];
             /** @description Tables extracted from the page. Present only when markdown_include_media=true. Present only on the synchronous response and webhook delivery. Not included in `GET /v1/scrape/:id`, bulk results, or cached hits. */
             tables?: components["schemas"]["ScrapeTable"][];
-            /** @description Warnings about markdown processing, tag filtering, or requested persisted artifacts. Markdown-pipeline and tag-filter warnings require `markdown_include_warnings=true`; `artifact_unavailable` may appear independently when a requested persisted format cannot be rehydrated. */
+            /** @description Warnings about markdown processing, tag filtering, requested persisted artifacts, or the `json` format's extraction. Markdown-pipeline and tag-filter warnings require `markdown_include_warnings=true`; `artifact_unavailable` may appear independently when a requested persisted format cannot be rehydrated. A request carrying a `json` format can also get the extraction's own warning codes here (`extract_validation_failed`, `exhausted_retries`, `content_truncated`, `model_refusal`, `empty_extraction`), whether or not `markdown_include_warnings` is set and whether or not the extraction validated: `content_truncated` can accompany a validated result, so a warning here does not by itself mean the extraction failed. */
             warnings?: components["schemas"]["ScrapeWarning"][];
             /** @description Processing stats. Present only when markdown_include_stats=true. Present only on the synchronous response and webhook delivery. Not included in `GET /v1/scrape/:id`, bulk results, or cached hits. */
             stats?: components["schemas"]["ScrapeStats"];
@@ -5716,7 +5716,7 @@ 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. `raw`, `markdown`, `links` and `images` are always present; unrequested or unavailable values are null, with nonfatal reference failures in `artifact_warnings`. `json` is present only on an item that requested a `json` format. */
+                            /** @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;
@@ -5727,7 +5727,7 @@ export interface operations {
                                 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. */

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

@@ -49,7 +49,7 @@ 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. */
-type ScrapeJsonFormat = components['schemas']['ScrapeRequestJsonFormat'];
+export type ScrapeJsonFormat = components['schemas']['ScrapeRequestJsonFormat'];
 /** Options for POST /v1/scrape. */
 export interface ScrapeOpts {
     url: string;

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

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

package/package.json

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