@hunt-labs/bytekit-sdk 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 export { ByteKit, ByteKitError, ByteKitConnectionError } from './client.js';
-export type { ByteKitOptions, RequestOptions, ApiResponse, ConnectionErrorCode } from './client.js';
+export type { ByteKitOptions, RequestOptions, ApiResponse, ConnectionErrorCode, ByteKitErrorDetails, } from './client.js';
 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 { ScrapeCookie, ScrapeCreateResponse, ScrapeGetResponse, ScrapeBulkCreateRequest, ScrapeBulkCreateResponse, ScrapeBulkGetResponse, } from './resources/scrape.js';
+export type { ScrapeCookie, ScrapeOpts, MarkdownMode, MarkdownLinks, MarkdownImages, TokenEncoding, 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/account.js

@@ -1,3 +1,4 @@
+import { buildPath } from '../client.js';
 export class AccountResource {
     client;
     apiKeys;
@@ -35,11 +36,11 @@ class ApiKeysResource {
     }
     /** GET /v1/account/api-keys/{id} — get an API key by ID */
     get(id, requestOptions) {
-        return this.client.request('GET', `/v1/account/api-keys/${id}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/account/api-keys/{id}', { segments: { id } }), undefined, requestOptions);
     }
     /** PATCH /v1/account/api-keys/{id} — update an API key */
     update(id, opts, requestOptions) {
-        return this.client.request('PATCH', `/v1/account/api-keys/${id}`, opts, requestOptions);
+        return this.client.request('PATCH', buildPath('/v1/account/api-keys/{id}', { segments: { id } }), opts, requestOptions);
     }
     /**
      * DELETE /v1/account/api-keys/{id} — revoke an API key (idempotent).
@@ -53,10 +54,10 @@ class ApiKeysResource {
      * method resolves cleanly on the gateway's empty 204 body.
      */
     revoke(id, requestOptions) {
-        return this.client.request('DELETE', `/v1/account/api-keys/${id}`, undefined, requestOptions);
+        return this.client.request('DELETE', buildPath('/v1/account/api-keys/{id}', { segments: { id } }), undefined, requestOptions);
     }
     /** POST /v1/account/api-keys/{id}/reveal — reveal the plaintext API key value */
     reveal(id, requestOptions) {
-        return this.client.request('POST', `/v1/account/api-keys/${id}/reveal`, undefined, requestOptions);
+        return this.client.request('POST', buildPath('/v1/account/api-keys/{id}/reveal', { segments: { id } }), undefined, requestOptions);
     }
 }

package/dist/resources/bulk.js

@@ -1,3 +1,4 @@
+import { buildPath } from '../client.js';
 export class BulkResource {
     client;
     screenshots;
@@ -16,11 +17,11 @@ export class BulkResource {
     }
     /** GET /v1/bulk/{id} — get a bulk job status */
     get(id, requestOptions) {
-        return this.client.request('GET', `/v1/bulk/${id}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/bulk/{id}', { segments: { id } }), undefined, requestOptions);
     }
     /** DELETE /v1/bulk/{id} — cancel an in-flight bulk job */
     cancel(id, requestOptions) {
-        return this.client.request('DELETE', `/v1/bulk/${id}`, undefined, requestOptions);
+        return this.client.request('DELETE', buildPath('/v1/bulk/{id}', { segments: { id } }), undefined, requestOptions);
     }
 }
 class BulkScreenshotsResource {
@@ -30,6 +31,6 @@ class BulkScreenshotsResource {
     }
     /** GET /v1/bulk/{id}/screenshots — list screenshots in a bulk job */
     list(id, requestOptions) {
-        return this.client.request('GET', `/v1/bulk/${id}/screenshots`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/bulk/{id}/screenshots', { segments: { id } }), undefined, requestOptions);
     }
 }

package/dist/resources/fetch.js

@@ -1,3 +1,4 @@
+import { buildPath } from '../client.js';
 /**
  * The query params `GET /v1/fetch` accepts, in serialization order.
  *
@@ -14,7 +15,10 @@ const CACHE_STATUSES = ['hit', 'miss', 'bypass'];
 function toFetchResult(raw) {
     const { body, bytes, headers } = raw;
     const creditsRaw = headers.get('X-Fetch-Credits-Charged');
-    const credits = creditsRaw === null ? NaN : Number(creditsRaw);
+    // An empty-but-present header must be treated the same as an absent one: `Number('')`
+    // is `0` (finite), so without this check an empty header parsed as a real zero-credit
+    // charge instead of "unparseable" (#2595).
+    const credits = creditsRaw === null || creditsRaw.trim() === '' ? NaN : Number(creditsRaw);
     const cacheRaw = headers.get('X-Fetch-Cache');
     return {
         body,
@@ -77,7 +81,7 @@ export class FetchResource {
             if (value !== undefined)
                 params.set(key, String(value));
         }
-        return toFetchResult(await this.client.requestRaw('GET', `/v1/fetch?${params.toString()}`, undefined, requestOptions));
+        return toFetchResult(await this.client.requestRaw('GET', buildPath('/v1/fetch', { query: `?${params.toString()}` }), undefined, requestOptions));
     }
 }
 class FetchBulkResource {
@@ -91,6 +95,6 @@ class FetchBulkResource {
     }
     /** GET /v1/fetch/bulk/{id} — get a bulk fetch job */
     get(id, requestOptions) {
-        return this.client.request('GET', `/v1/fetch/bulk/${id}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/fetch/bulk/{id}', { segments: { id } }), undefined, requestOptions);
     }
 }

package/dist/resources/monitors.d.ts

@@ -46,6 +46,19 @@ export type MonitorUpdateRequest = operations['updateMonitor']['requestBody']['c
 export type UpdateMonitorResponse = operations['updateMonitor']['responses'][200]['content']['application/json'];
 /** 200 payload of GET /v1/monitors/{id}/captures — the paginated capture list. */
 export type ListMonitorCapturesResponse = operations['listMonitorCaptures']['responses'][200]['content']['application/json'];
+/**
+ * Query params of GET /v1/monitors/{id}/captures — `limit`/`cursor`, both optional and
+ * omitted when unset.
+ *
+ * DERIVED from the generated `listMonitorCaptures` query type (#2594), mirroring
+ * {@link ListMonitorsParams} — never hand-authored, so a spec drift (a renamed/removed query
+ * param) surfaces as a `tsc` error here rather than a silent request-shape mismatch (E1).
+ *
+ * Still a `type` alias (not an `interface`), for the same implicit-index-signature reason as
+ * {@link ListMonitorsParams} — it must stay assignable to {@link toQueryString}'s
+ * `Record<string, string | number | undefined>` param.
+ */
+export type ListMonitorCapturesParams = NonNullable<operations['listMonitorCaptures']['parameters']['query']>;
 export declare class MonitorsResource {
     private readonly client;
     readonly captures: MonitorCapturesResource;
@@ -79,7 +92,13 @@ export declare class MonitorsResource {
 declare class MonitorCapturesResource {
     private readonly client;
     constructor(client: ByteKit);
-    /** GET /v1/monitors/{id}/captures — list captures for a monitor */
-    list(id: MonitorId, requestOptions?: RequestOptions): Promise<ListMonitorCapturesResponse>;
+    /**
+     * GET /v1/monitors/{id}/captures — list captures for a monitor.
+     *
+     * `params` is optional and each key is omitted-when-absent (#2594), so `list(id)` with no
+     * second argument serializes the bare `/v1/monitors/{id}/captures` URL unchanged — existing
+     * zero-arg callers are unaffected (inverse case).
+     */
+    list(id: MonitorId, params?: ListMonitorCapturesParams, requestOptions?: RequestOptions): Promise<ListMonitorCapturesResponse>;
 }
 export {};

package/dist/resources/monitors.js

@@ -1,4 +1,5 @@
 import { toQueryString } from './query-string.js';
+import { buildPath } from '../client.js';
 export class MonitorsResource {
     client;
     captures;
@@ -20,15 +21,15 @@ export class MonitorsResource {
      * serializes the bare `/v1/monitors` URL unchanged — existing zero-arg callers are unaffected.
      */
     list(params, requestOptions) {
-        return this.client.request('GET', `/v1/monitors${toQueryString(params)}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/monitors', { query: toQueryString(params) }), undefined, requestOptions);
     }
     /** GET /v1/monitors/{id} — get a monitor by ID */
     get(id, requestOptions) {
-        return this.client.request('GET', `/v1/monitors/${id}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/monitors/{id}', { segments: { id } }), undefined, requestOptions);
     }
     /** PATCH /v1/monitors/{id} — update a monitor */
     update(id, opts, requestOptions) {
-        return this.client.request('PATCH', `/v1/monitors/${id}`, opts, requestOptions);
+        return this.client.request('PATCH', buildPath('/v1/monitors/{id}', { segments: { id } }), opts, requestOptions);
     }
     /**
      * DELETE /v1/monitors/{id} — delete a monitor.
@@ -39,7 +40,7 @@ export class MonitorsResource {
      * body to `undefined` before it would parse as JSON (#2450).
      */
     delete(id, requestOptions) {
-        return this.client.request('DELETE', `/v1/monitors/${id}`, undefined, requestOptions);
+        return this.client.request('DELETE', buildPath('/v1/monitors/{id}', { segments: { id } }), undefined, requestOptions);
     }
 }
 class MonitorCapturesResource {
@@ -47,8 +48,14 @@ class MonitorCapturesResource {
     constructor(client) {
         this.client = client;
     }
-    /** GET /v1/monitors/{id}/captures — list captures for a monitor */
-    list(id, requestOptions) {
-        return this.client.request('GET', `/v1/monitors/${id}/captures`, undefined, requestOptions);
+    /**
+     * GET /v1/monitors/{id}/captures — list captures for a monitor.
+     *
+     * `params` is optional and each key is omitted-when-absent (#2594), so `list(id)` with no
+     * second argument serializes the bare `/v1/monitors/{id}/captures` URL unchanged — existing
+     * zero-arg callers are unaffected (inverse case).
+     */
+    list(id, params, requestOptions) {
+        return this.client.request('GET', buildPath('/v1/monitors/{id}/captures', { segments: { id }, query: toQueryString(params) }), undefined, requestOptions);
     }
 }

package/dist/resources/scrape.js

@@ -1,3 +1,4 @@
+import { buildPath } from '../client.js';
 export class ScrapeResource {
     client;
     bulk;
@@ -35,7 +36,7 @@ export class ScrapeResource {
      * gateway and is out of this ticket's scope.
      */
     get(id, requestOptions) {
-        return this.client.request('GET', `/v1/scrape/${id}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/scrape/{id}', { segments: { id } }), undefined, requestOptions);
     }
 }
 class ScrapeBulkResource {
@@ -54,6 +55,6 @@ class ScrapeBulkResource {
     }
     /** GET /v1/scrape/bulk/{id} — get a bulk scrape job */
     get(id, requestOptions) {
-        return this.client.request('GET', `/v1/scrape/bulk/${id}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/scrape/bulk/{id}', { segments: { id } }), undefined, requestOptions);
     }
 }

package/dist/resources/screenshots.js

@@ -1,3 +1,4 @@
+import { buildPath } from '../client.js';
 export class ScreenshotsResource {
     client;
     constructor(client) {
@@ -17,7 +18,7 @@ export class ScreenshotsResource {
      */
     create(opts, params, requestOptions) {
         const suffix = params?.async === true ? '?async=true' : '';
-        return this.client.request('POST', `/v1/screenshots${suffix}`, opts, requestOptions);
+        return this.client.request('POST', buildPath('/v1/screenshots', { query: suffix }), opts, requestOptions);
     }
     /**
      * GET /v1/screenshots/{id} — poll a screenshot by ID.
@@ -26,7 +27,7 @@ export class ScreenshotsResource {
      * (issue #2027), so narrow the result before reading `image_url`.
      */
     get(id, requestOptions) {
-        return this.client.request('GET', `/v1/screenshots/${id}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/screenshots/{id}', { segments: { id } }), undefined, requestOptions);
     }
     /**
      * POST /v1/screenshots, returning the header set alongside the body (#2547).
@@ -42,7 +43,7 @@ export class ScreenshotsResource {
      */
     createWithResponse(opts, params, requestOptions) {
         const suffix = params?.async === true ? '?async=true' : '';
-        return this.client.requestWithResponse('POST', `/v1/screenshots${suffix}`, opts, requestOptions);
+        return this.client.requestWithResponse('POST', buildPath('/v1/screenshots', { query: suffix }), opts, requestOptions);
     }
     /**
      * GET /v1/screenshots/{id}, returning the header set alongside the body (#2547).
@@ -53,6 +54,6 @@ export class ScreenshotsResource {
      * `X-Raw-Bytes`, `X-Billable-Bytes` and `X-Billing-Multiplier` headers are on `headers`.
      */
     getWithResponse(id, requestOptions) {
-        return this.client.requestWithResponse('GET', `/v1/screenshots/${id}`, undefined, requestOptions);
+        return this.client.requestWithResponse('GET', buildPath('/v1/screenshots/{id}', { segments: { id } }), undefined, requestOptions);
     }
 }

package/dist/resources/sitemap.js

@@ -1,3 +1,4 @@
+import { buildPath } from '../client.js';
 export class SitemapResource {
     client;
     constructor(client) {
@@ -14,7 +15,7 @@ export class SitemapResource {
     }
     /** GET /v1/sitemap/{id} — get a sitemap job by ID */
     get(id, requestOptions) {
-        return this.client.request('GET', `/v1/sitemap/${id}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/sitemap/{id}', { segments: { id } }), undefined, requestOptions);
     }
     /**
      * GET /v1/sitemap/{id}, returning the header set alongside the body (#2547).
@@ -27,6 +28,6 @@ export class SitemapResource {
      * `X-Billable-Bytes` on this endpoint's 200; every one of them is on `headers`.
      */
     getWithResponse(id, requestOptions) {
-        return this.client.requestWithResponse('GET', `/v1/sitemap/${id}`, undefined, requestOptions);
+        return this.client.requestWithResponse('GET', buildPath('/v1/sitemap/{id}', { segments: { id } }), undefined, requestOptions);
     }
 }

package/dist/resources/usage.js

@@ -1,4 +1,5 @@
 import { toQueryString } from './query-string.js';
+import { buildPath } from '../client.js';
 export class UsageResource {
     client;
     constructor(client) {
@@ -18,13 +19,13 @@ export class UsageResource {
      * Default range is the last 30 days; max range is 366 days.
      */
     daily(params, requestOptions) {
-        return this.client.request('GET', `/v1/usage/daily${toQueryString(params)}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/usage/daily', { query: toQueryString(params) }), undefined, requestOptions);
     }
     /**
      * GET /v1/usage/by-endpoint — get per-endpoint bandwidth breakdown.
      * Default range is the last 30 days; max range is 366 days.
      */
     byEndpoint(params, requestOptions) {
-        return this.client.request('GET', `/v1/usage/by-endpoint${toQueryString(params)}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/usage/by-endpoint', { query: toQueryString(params) }), undefined, requestOptions);
     }
 }

package/dist/resources/webhooks.js

@@ -1,4 +1,5 @@
 import { toQueryString } from './query-string.js';
+import { buildPath } from '../client.js';
 export class WebhooksResource {
     client;
     constructor(client) {
@@ -11,10 +12,10 @@ export class WebhooksResource {
      * optional caller `signal`; both override the constructor's `timeoutMs` default.
      */
     list(params, requestOptions) {
-        return this.client.request('GET', `/v1/webhook-deliveries${toQueryString(params)}`, undefined, requestOptions);
+        return this.client.request('GET', buildPath('/v1/webhook-deliveries', { query: toQueryString(params) }), undefined, requestOptions);
     }
     /** POST /v1/webhook-deliveries/{id}/retry — requeue a failed or exhausted delivery. */
     retry(id, requestOptions) {
-        return this.client.request('POST', `/v1/webhook-deliveries/${id}/retry`, undefined, requestOptions);
+        return this.client.request('POST', buildPath('/v1/webhook-deliveries/{id}/retry', { segments: { id } }), undefined, requestOptions);
     }
 }

package/dist/types.d.ts

@@ -64,8 +64,12 @@ export interface SearchResult {
     position: number;
     title: string;
     url: string;
-    /** Short text excerpt for the result. Omitted for `images` results. */
-    snippet: string;
+    /**
+     * Short text excerpt for the result. Present for `web` and `news` results;
+     * omitted entirely (`undefined`) for `images` results — read it behind a
+     * guard, exactly like `date` (#2678).
+     */
+    snippet?: string;
     /**
      * Published date when the provider reports one, else `null`. Present for
      * `web`/`news` results; omitted entirely (`undefined`) for `images` results.

package/package.json

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