@expandai/sdk 0.17.2 → 0.19.0

package/README.md

@@ -109,6 +109,8 @@ while (status.batchedStatus === 'RUNNING' || status.batchedStatus === 'QUEUED')
 console.log(status.results)
 ```
 
+Each result has a persisted `status` (`QUEUED`, `RUNNING`, `SUCCEEDED`, `FAILED`, or `CANCELLED`) alongside its `data`.
+
 ### Effect service
 
 ```ts
@@ -132,6 +134,8 @@ const program = Effect.gen(function* () {
 NodeRuntime.runMain(program.pipe(Effect.provide(ExpandService.layer({ apiKey: process.env.EXPAND_API_KEY }))))
 ```
 
+The SDK generates an idempotency key and reuses it for automatic retries when one is omitted. Supply a stable `idempotencyKey` to deduplicate separate calls or calls made after a process restart. Reusing a key with a different payload returns `409 BatchedIdempotencyConflict`.
+
 ## License
 
 [Apache 2.0](./LICENSE)

package/build/dts/Client.d.ts

@@ -1,5 +1,5 @@
-import { type BatchedParams, type BatchedResponse, type ExpandServiceOptions, type FetchJsonParams, type FetchJsonRequestOptions, type FetchJsonResponse, type FetchParams, type FetchRequestOptions, type FetchResponse, type FetchSearchParams, type FetchSearchResponse, type GetBatchedParams, type GetBatchedResponse, type RequestOptions } from './Service.js';
-export type { BatchedParams, BatchedResponse, FetchJsonParams, FetchJsonRequestOptions, FetchJsonResponse, FetchParams, FetchRequestOptions, FetchResponse, FetchSearchParams, FetchSearchResponse, GetBatchedParams, GetBatchedResponse, } from './Service.js';
+import { type BatchedParams, type BatchedRequestOptions, type BatchedResponse, type CancelBatchedResponse, type ExpandServiceOptions, type FetchJsonParams, type FetchJsonRequestOptions, type FetchJsonResponse, type FetchParams, type FetchRequestOptions, type FetchResponse, type FetchSearchParams, type FetchSearchResponse, type GetBatchedParams, type GetBatchedResponse, type RequestOptions } from './Service.js';
+export type { BatchedParams, BatchedRequestOptions, BatchedResponse, CancelBatchedResponse, FetchJsonParams, FetchJsonRequestOptions, FetchJsonResponse, FetchParams, FetchRequestOptions, FetchResponse, FetchSearchParams, FetchSearchResponse, GetBatchedParams, GetBatchedResponse, } from './Service.js';
 /** Options for constructing an {@link ExpandClient}. Same shape as `ExpandServiceOptions`. */
 export type ExpandClientOptions = ExpandServiceOptions;
 /**
@@ -39,14 +39,16 @@ export declare class ExpandClient {
      * Kick off an asynchronous batched fetch over one or more URLs. Returns a batched-run ID that can
      * be polled via {@link getBatched}.
      *
-     * Retries are disabled by default. Pass `{ maxRetries: N }` to opt in.
+     * When `idempotencyKey` is omitted, the client generates one and reuses it for automatic retries.
+     * Provide a stable key to deduplicate separate calls or calls made after a process restart. Reusing
+     * a key with a different payload surfaces an idempotency conflict.
      *
      * @throws {ExpandClientApiError} on 4xx/5xx responses
      * @throws {ExpandClientTimeoutError} when the request exceeds `timeoutMs`
      * @throws {ExpandClientConnectionError} on network failures
      * @throws {ExpandClientError} for any other failure
      */
-    batched(params: BatchedParams, options?: RequestOptions): Promise<BatchedResponse>;
+    batched(params: BatchedParams, options?: BatchedRequestOptions): Promise<BatchedResponse>;
     /**
      * Fetch the status and accumulated results for a batched run previously started by {@link batched}.
      *
@@ -56,6 +58,10 @@ export declare class ExpandClient {
      * @throws {ExpandClientError} for any other failure
      */
     getBatched(id: string, options?: GetBatchedParams & RequestOptions): Promise<GetBatchedResponse>;
+    /**
+     * Request cancellation of a batched run. The command is idempotent and uses the configured retry policy.
+     */
+    cancelBatched(id: string, options?: RequestOptions): Promise<CancelBatchedResponse>;
     private run;
 }
 //# sourceMappingURL=Client.d.ts.map

package/build/dts/Client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../src/Client.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,KAAK,aAAa,EAClB,KAAK,eAAe,EAEpB,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,MAAM,cAAc,CAAA;AAErB,YAAY,EACX,aAAa,EACb,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,iBAAiB,EACjB,WAAW,EACX,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,GAClB,MAAM,cAAc,CAAA;AAErB,8FAA8F;AAC9F,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAA;AAEtD;;;;;;;;;;GAUG;AACH,qBAAa,YAAY;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA6B;gBAEvC,OAAO,GAAE,mBAAwB;IAa7C;;;;;;;OAOG;IACG,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,aAAa,CAAC;IAI3F;;;;OAIG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,GAAE,uBAA4B,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI3G;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIxG;;;;;;;;;;OAUG;IACG,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,eAAe,CAAC;IAI5F;;;;;;;OAOG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAgB,GAAG,cAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC;YAI5F,GAAG;CAOjB"}
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../src/Client.ts"],"names":[],"mappings":"AAEA,OAAO,EACN,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EAEpB,KAAK,qBAAqB,EAC1B,KAAK,oBAAoB,EACzB,KAAK,eAAe,EACpB,KAAK,uBAAuB,EAC5B,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,aAAa,EAClB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,MAAM,cAAc,CAAA;AAErB,YAAY,EACX,aAAa,EACb,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,uBAAuB,EACvB,iBAAiB,EACjB,WAAW,EACX,mBAAmB,EACnB,aAAa,EACb,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,GAClB,MAAM,cAAc,CAAA;AAErB,8FAA8F;AAC9F,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,CAAA;AAEtD;;;;;;;;;;GAUG;AACH,qBAAa,YAAY;IACxB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA6B;IAEnD,YAAY,OAAO,GAAE,mBAAwB,EAW5C;IAED;;;;;;;OAOG;IACG,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,aAAa,CAAC,CAE1F;IAED;;;;OAIG;IACG,SAAS,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,GAAE,uBAA4B,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAE1G;IAED;;OAEG;IACG,WAAW,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAEvG;IAED;;;;;;;;;;;;OAYG;IACG,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,eAAe,CAAC,CAElG;IAED;;;;;;;OAOG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,gBAAgB,GAAG,cAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAEzG;IAED;;OAEG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAE5F;YAEa,GAAG;CAOjB"}

package/build/dts/Error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;;;;;;;AAE/B;;GAEG;AACH,qBAAa,cAAe,SAAQ,mBAGlC;IACD,aAAa;CAGb;;;;;;;;;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,mBAKlC;IACD,aAAa;CAGb;;;;;;;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,0BAGzC;IACD,aAAa;CAGb;;;;;;;;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,uBAItC;IACD,aAAa;CAGb;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,cAAc,GAAG,qBAAqB,GAAG,kBAAkB,CAAA;AAEtG;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB;CAIvD;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,iBAAiB;IAC1D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;gBAEV,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE;CAMzG;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,iBAAiB;gBACrD,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB;CAIvD;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,2BAA2B;IACxE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;gBAEd,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG;QAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAAE;CAKnF"}
+{"version":3,"file":"Error.d.ts","sourceRoot":"","sources":["../../src/Error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;;;;;;;AAE/B;;GAEG;AACH,qBAAa,cAAe,SAAQ,mBAGlC;IACD,aAAa,sBAEZ;CACD;;;;;;;;;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,mBAKlC;IACD,aAAa,yBAEZ;CACD;;;;;;;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,0BAGzC;IACD,aAAa,gCAEZ;CACD;;;;;;;;AAED;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,uBAItC;IACD,aAAa,6BAEZ;CACD;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,cAAc,GAAG,cAAc,GAAG,qBAAqB,GAAG,kBAAkB,CAAA;AAEtG;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,KAAK;IAC3C,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,EAGtD;CACD;AAED;;GAEG;AACH,qBAAa,oBAAqB,SAAQ,iBAAiB;IAC1D,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IAEtB,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG;QAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,EAKxG;CACD;AAED;;GAEG;AACH,qBAAa,2BAA4B,SAAQ,iBAAiB;IACjE,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,EAGtD;CACD;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,2BAA2B;IACxE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,YAAY,GAAG;QAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EAIlF;CACD"}

package/build/dts/FetchJson.d.ts

@@ -9,16 +9,19 @@ export declare const FetchSearchSnippetWithJson: S.Struct<{
     }>;
     source: S.Literal<["markdown", "appendix", "statejson"]>;
     text: typeof S.String;
-    json: S.optionalWith<typeof S.Unknown, {
-        nullable: true;
-    }>;
     score: S.filter<S.filter<typeof S.Number>>;
     location: S.optionalWith<typeof Generated.FetchSearchSnippetLocation, {
         nullable: true;
     }>;
+    json: S.optionalWith<typeof S.Unknown, {
+        nullable: true;
+    }>;
 }>;
 export declare const FetchSearchResultWithJson: S.Struct<{
     query: typeof S.String;
+    meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+        nullable: true;
+    }>;
     snippets: S.Array$<S.Struct<{
         type: S.optionalWith<S.Literal<["text"]>, {
             nullable: true;
@@ -26,17 +29,14 @@ export declare const FetchSearchResultWithJson: S.Struct<{
         }>;
         source: S.Literal<["markdown", "appendix", "statejson"]>;
         text: typeof S.String;
-        json: S.optionalWith<typeof S.Unknown, {
-            nullable: true;
-        }>;
         score: S.filter<S.filter<typeof S.Number>>;
         location: S.optionalWith<typeof Generated.FetchSearchSnippetLocation, {
             nullable: true;
         }>;
+        json: S.optionalWith<typeof S.Unknown, {
+            nullable: true;
+        }>;
     }>>;
-    meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
-        nullable: true;
-    }>;
 }>;
 declare const FetchObjectModeResultWithJson_base: S.Class<FetchObjectModeResultWithJson, {
     meta: typeof Generated.FetchObjectModeMeta;
@@ -46,11 +46,20 @@ declare const FetchObjectModeResultWithJson_base: S.Class<FetchObjectModeResultW
         assets: S.optionalWith<S.Array$<typeof Generated.FetchAssetReference>, {
             nullable: true;
         }>;
-        captureTelemetry: S.optionalWith<typeof Generated.CaptureTelemetryInfo, {
+        degraded: S.optionalWith<typeof Generated.FetchDegradedInfo, {
+            nullable: true;
+        }>;
+        screenshot: S.optionalWith<S.Struct<{
+            url: typeof S.String;
+            fullPage: typeof S.Boolean;
+        }>, {
             nullable: true;
         }>;
         search: S.optionalWith<S.Struct<{
             query: typeof S.String;
+            meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+                nullable: true;
+            }>;
             snippets: S.Array$<S.Struct<{
                 type: S.optionalWith<S.Literal<["text"]>, {
                     nullable: true;
@@ -58,17 +67,14 @@ declare const FetchObjectModeResultWithJson_base: S.Class<FetchObjectModeResultW
                 }>;
                 source: S.Literal<["markdown", "appendix", "statejson"]>;
                 text: typeof S.String;
-                json: S.optionalWith<typeof S.Unknown, {
-                    nullable: true;
-                }>;
                 score: S.filter<S.filter<typeof S.Number>>;
                 location: S.optionalWith<typeof Generated.FetchSearchSnippetLocation, {
                     nullable: true;
                 }>;
+                json: S.optionalWith<typeof S.Unknown, {
+                    nullable: true;
+                }>;
             }>>;
-            meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
-                nullable: true;
-            }>;
         }>, {
             nullable: true;
         }>;
@@ -83,11 +89,20 @@ declare const FetchObjectModeResultWithJson_base: S.Class<FetchObjectModeResultW
         assets: S.optionalWith<S.Array$<typeof Generated.FetchAssetReference>, {
             nullable: true;
         }>;
-        captureTelemetry: S.optionalWith<typeof Generated.CaptureTelemetryInfo, {
+        degraded: S.optionalWith<typeof Generated.FetchDegradedInfo, {
+            nullable: true;
+        }>;
+        screenshot: S.optionalWith<S.Struct<{
+            url: typeof S.String;
+            fullPage: typeof S.Boolean;
+        }>, {
             nullable: true;
         }>;
         search: S.optionalWith<S.Struct<{
             query: typeof S.String;
+            meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+                nullable: true;
+            }>;
             snippets: S.Array$<S.Struct<{
                 type: S.optionalWith<S.Literal<["text"]>, {
                     nullable: true;
@@ -95,17 +110,14 @@ declare const FetchObjectModeResultWithJson_base: S.Class<FetchObjectModeResultW
                 }>;
                 source: S.Literal<["markdown", "appendix", "statejson"]>;
                 text: typeof S.String;
-                json: S.optionalWith<typeof S.Unknown, {
-                    nullable: true;
-                }>;
                 score: S.filter<S.filter<typeof S.Number>>;
                 location: S.optionalWith<typeof Generated.FetchSearchSnippetLocation, {
                     nullable: true;
                 }>;
+                json: S.optionalWith<typeof S.Unknown, {
+                    nullable: true;
+                }>;
             }>>;
-            meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
-                nullable: true;
-            }>;
         }>, {
             nullable: true;
         }>;
@@ -113,108 +125,109 @@ declare const FetchObjectModeResultWithJson_base: S.Class<FetchObjectModeResultW
         nullable: true;
     }>;
 }>, never, {
-    readonly markdown: string;
-} & {
-    readonly meta: {
-        readonly url: string;
-        readonly markdown?: {
-            readonly url: string;
-            readonly moreTokens: number;
+    readonly data?: {
+        readonly assets?: readonly {
+            readonly id: string;
+            readonly kind: "data-url";
+            readonly placeholder: string;
+            readonly archiveKey: string;
+            readonly mimeType: string;
+            readonly sha256: string;
+            readonly bytes: number;
+        }[] | undefined;
+        readonly degraded?: {
+            readonly reason: "modelInputTooLarge" | "pageTooLarge";
+            readonly skipped: readonly "hfc"[];
+            readonly limitKind: "ast_bytes" | "domsnapshot_bytes" | "hfc_tokens";
+            readonly measuredBytes?: number | undefined;
+            readonly thresholdBytes?: number | undefined;
+            readonly measuredTokens?: number | undefined;
+            readonly thresholdTokens?: number | undefined;
         } | undefined;
-        readonly appendix?: {
+        readonly screenshot?: {
             readonly url: string;
-            readonly links: {
-                readonly sameDomain: number;
-                readonly external: number;
-            };
+            readonly fullPage: boolean;
         } | undefined;
-        readonly description?: string | undefined;
-        readonly version: 1;
-        readonly capturedAt: string;
-        readonly snapshotId: string;
-        readonly lang: string;
-        readonly pageType: string;
-        readonly playground: string;
-        readonly title?: string | undefined;
-        readonly finalUrl?: string | undefined;
-        readonly canonical?: string | undefined;
-        readonly author?: string | undefined;
-        readonly createdAt?: string | undefined;
-        readonly updatedAt?: string | undefined;
-        readonly image?: string | undefined;
-        readonly paginationNext?: string | undefined;
-        readonly stateJson?: {
-            readonly moreTokens: number;
-        } | undefined;
-        readonly blocked?: string | undefined;
-        readonly loadingStatus?: string | undefined;
-    };
-} & {
-    readonly json: readonly {
-        readonly keys?: readonly string[] | undefined;
-        readonly url?: string | undefined;
-        readonly moreTokens?: number | undefined;
-        readonly id: number;
-        readonly kind: "inline" | "network";
-        readonly role: "ld+json" | "next-data" | "nuxt" | "apollo-state" | "initial-state" | "application-json" | "script-tag" | "data-attribute" | "network-json" | "network-response" | "other";
-        readonly score: number;
-        readonly method?: string | undefined;
-    }[];
-} & {
-    readonly data?: {
         readonly search?: {
+            readonly query: string;
             readonly meta?: {
                 readonly durationMs: number;
                 readonly sources: readonly {
-                    readonly source: "markdown" | "appendix" | "statejson";
+                    readonly source: "appendix" | "markdown" | "statejson";
                     readonly chunkCount: number;
                     readonly batchCount: number;
-                    readonly ranker: "zeroentropy" | "local_lexical";
+                    readonly ranker: "local_lexical" | "mixedbread" | "zeroentropy";
                     readonly fallback: boolean;
-                    readonly fallbackReason?: "timeout" | "error" | undefined;
+                    readonly fallbackReason?: "error" | "timeout" | undefined;
                     readonly durationMs: number;
                 }[];
             } | undefined;
-            readonly query: string;
             readonly snippets: readonly {
-                readonly json?: unknown;
-                readonly score: number;
-                readonly source: "markdown" | "appendix" | "statejson";
                 readonly type: "text";
+                readonly source: "appendix" | "markdown" | "statejson";
                 readonly text: string;
+                readonly score: number;
                 readonly location?: {
+                    readonly evidenceId?: number | undefined;
                     readonly markdownBlockId?: string | undefined;
                     readonly nodeIds?: readonly number[] | undefined;
                     readonly stateJsonSourceId?: number | undefined;
                     readonly jsonPath?: string | undefined;
                 } | undefined;
+                readonly json?: unknown;
             }[];
         } | undefined;
-        readonly assets?: readonly {
-            readonly id: string;
-            readonly kind: "data-url";
-            readonly placeholder: string;
-            readonly archiveKey: string;
-            readonly mimeType: string;
-            readonly sha256: string;
-            readonly bytes: number;
-        }[] | undefined;
-        readonly captureTelemetry?: {
-            readonly requestedStyleMode?: "compat_full" | "native_default" | undefined;
-            readonly selected: "rust";
-            readonly actual: "rust";
-            readonly actualStyleMode?: "compat_full" | "native_default" | undefined;
-            readonly rolloutApplied: boolean;
-            readonly preparedSessionHit?: boolean | undefined;
-            readonly nativePoolHit?: boolean | undefined;
-            readonly nativePoolCapacity?: number | undefined;
-            readonly nativePoolProfile?: string | undefined;
-            readonly poolHit?: boolean | undefined;
-            readonly connectMs?: number | undefined;
-            readonly warmConnectionAgeMs?: number | undefined;
-            readonly iconBackendDecision?: "cpu" | "remote_gpu" | undefined;
-        } | undefined;
     } | undefined;
+} & {
+    readonly json: readonly {
+        readonly id: number;
+        readonly kind: "inline" | "network";
+        readonly role: "apollo-state" | "application-json" | "data-attribute" | "initial-state" | "ld+json" | "network-json" | "network-response" | "next-data" | "nuxt" | "other" | "script-tag";
+        readonly score: number;
+        readonly url?: string | undefined;
+        readonly method?: string | undefined;
+        readonly moreTokens?: number | undefined;
+        readonly keys?: readonly string[] | undefined;
+        readonly urlRedacted?: true | undefined;
+        readonly urlOmitted?: "invalid" | "too-long" | "unsafe" | undefined;
+    }[];
+} & {
+    readonly markdown: string;
+} & {
+    readonly meta: {
+        readonly version: 1;
+        readonly url: string;
+        readonly capturedAt: string;
+        readonly snapshotId: string;
+        readonly lang: string;
+        readonly pageType: string;
+        readonly playground: string;
+        readonly title?: string | undefined;
+        readonly finalUrl?: string | undefined;
+        readonly canonical?: string | undefined;
+        readonly description?: string | undefined;
+        readonly author?: string | undefined;
+        readonly createdAt?: string | undefined;
+        readonly updatedAt?: string | undefined;
+        readonly image?: string | undefined;
+        readonly paginationNext?: string | undefined;
+        readonly appendix?: {
+            readonly url: string;
+            readonly links: {
+                readonly sameDomain: number;
+                readonly external: number;
+            };
+        } | undefined;
+        readonly stateJson?: {
+            readonly moreTokens: number;
+        } | undefined;
+        readonly markdown?: {
+            readonly url: string;
+            readonly moreTokens?: number | undefined;
+        } | undefined;
+        readonly blocked?: string | undefined;
+        readonly loadingStatus?: string | undefined;
+    };
 }, {}, {}>;
 export declare class FetchObjectModeResultWithJson extends FetchObjectModeResultWithJson_base {
 }
@@ -223,6 +236,9 @@ declare const FetchSnapshotSearchResultWithJson_base: S.Class<FetchSnapshotSearc
     response: typeof Generated.ResponseInfo;
     search: S.Struct<{
         query: typeof S.String;
+        meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+            nullable: true;
+        }>;
         snippets: S.Array$<S.Struct<{
             type: S.optionalWith<S.Literal<["text"]>, {
                 nullable: true;
@@ -230,24 +246,25 @@ declare const FetchSnapshotSearchResultWithJson_base: S.Class<FetchSnapshotSearc
             }>;
             source: S.Literal<["markdown", "appendix", "statejson"]>;
             text: typeof S.String;
-            json: S.optionalWith<typeof S.Unknown, {
-                nullable: true;
-            }>;
             score: S.filter<S.filter<typeof S.Number>>;
             location: S.optionalWith<typeof Generated.FetchSearchSnippetLocation, {
                 nullable: true;
             }>;
+            json: S.optionalWith<typeof S.Unknown, {
+                nullable: true;
+            }>;
         }>>;
-        meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
-            nullable: true;
-        }>;
     }>;
     durationMs: S.filter<typeof S.Number>;
+    playground: typeof S.String;
 }, S.Struct.Encoded<{
     snapshotId: S.filter<typeof S.String>;
     response: typeof Generated.ResponseInfo;
     search: S.Struct<{
         query: typeof S.String;
+        meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+            nullable: true;
+        }>;
         snippets: S.Array$<S.Struct<{
             type: S.optionalWith<S.Literal<["text"]>, {
                 nullable: true;
@@ -255,60 +272,61 @@ declare const FetchSnapshotSearchResultWithJson_base: S.Class<FetchSnapshotSearc
             }>;
             source: S.Literal<["markdown", "appendix", "statejson"]>;
             text: typeof S.String;
-            json: S.optionalWith<typeof S.Unknown, {
-                nullable: true;
-            }>;
             score: S.filter<S.filter<typeof S.Number>>;
             location: S.optionalWith<typeof Generated.FetchSearchSnippetLocation, {
                 nullable: true;
             }>;
+            json: S.optionalWith<typeof S.Unknown, {
+                nullable: true;
+            }>;
         }>>;
-        meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
-            nullable: true;
-        }>;
     }>;
     durationMs: S.filter<typeof S.Number>;
+    playground: typeof S.String;
 }>, never, {
+    readonly durationMs: number;
+} & {
+    readonly playground: string;
+} & {
+    readonly response: {
+        readonly url: string;
+        readonly requestedUrl?: string | undefined;
+        readonly originStatusCode?: number | undefined;
+        readonly redirectStatusCode?: number | undefined;
+        readonly headers?: {} | undefined;
+    };
+} & {
     readonly search: {
+        readonly query: string;
         readonly meta?: {
             readonly durationMs: number;
             readonly sources: readonly {
-                readonly source: "markdown" | "appendix" | "statejson";
+                readonly source: "appendix" | "markdown" | "statejson";
                 readonly chunkCount: number;
                 readonly batchCount: number;
-                readonly ranker: "zeroentropy" | "local_lexical";
+                readonly ranker: "local_lexical" | "mixedbread" | "zeroentropy";
                 readonly fallback: boolean;
-                readonly fallbackReason?: "timeout" | "error" | undefined;
+                readonly fallbackReason?: "error" | "timeout" | undefined;
                 readonly durationMs: number;
             }[];
         } | undefined;
-        readonly query: string;
         readonly snippets: readonly {
-            readonly json?: unknown;
-            readonly score: number;
-            readonly source: "markdown" | "appendix" | "statejson";
             readonly type: "text";
+            readonly source: "appendix" | "markdown" | "statejson";
             readonly text: string;
+            readonly score: number;
             readonly location?: {
+                readonly evidenceId?: number | undefined;
                 readonly markdownBlockId?: string | undefined;
                 readonly nodeIds?: readonly number[] | undefined;
                 readonly stateJsonSourceId?: number | undefined;
                 readonly jsonPath?: string | undefined;
             } | undefined;
+            readonly json?: unknown;
         }[];
     };
-} & {
-    readonly response: {
-        readonly url: string;
-        readonly requestedUrl?: string | undefined;
-        readonly originStatusCode?: number | undefined;
-        readonly redirectStatusCode?: number | undefined;
-        readonly headers?: {} | undefined;
-    };
 } & {
     readonly snapshotId: string;
-} & {
-    readonly durationMs: number;
 }, {}, {}>;
 export declare class FetchSnapshotSearchResultWithJson extends FetchSnapshotSearchResultWithJson_base {
 }
@@ -316,48 +334,52 @@ export declare class FetchSnapshotSearchResultWithJson extends FetchSnapshotSear
 export declare const fetchObjectModeJson: (httpClient: HttpClient.HttpClient, options: {
     readonly params: typeof Generated.FetchFetchJsonParams.Encoded;
     readonly payload: typeof Generated.FetchFetchJsonRequest.Encoded;
-}) => Effect.Effect<FetchObjectModeResultWithJson, {
-    readonly message: string;
-    readonly _tag: "HttpApiDecodeError";
+}) => Effect.Effect<FetchObjectModeResultWithJson, Generated.AuthFailed | Generated.FetchCapacityTimeout | Generated.FetchCaptureTimeout | Generated.FetchNavigationFailed | Generated.InternalError | import("effect/ParseResult").ParseError | Generated.ServiceUnavailable | Generated.TooManyRequests | {
     readonly issues: readonly {
-        readonly message: string;
-        readonly _tag: "Type" | "Pointer" | "Unexpected" | "Missing" | "Composite" | "Refinement" | "Transformation" | "Forbidden";
+        readonly _tag: "Composite" | "Forbidden" | "Missing" | "Pointer" | "Refinement" | "Transformation" | "Type" | "Unexpected";
         readonly path: readonly (string | number | {
             readonly _tag: "symbol";
             readonly key: string;
         })[];
+        readonly message: string;
     }[];
+    readonly message: string;
+    readonly _tag: "HttpApiDecodeError";
 } | {
     readonly message: string;
     readonly _tag: "BadRequest";
-} | Generated.AuthFailed | {
-    readonly _tag: "FetchBlocked";
-    readonly url: string;
-    readonly blockedType?: string | undefined;
-} | Generated.PayloadTooLarge | Generated.TooManyRequests | Generated.InternalError | Generated.ServiceUnavailable | {
-    readonly _tag: "AccessBlocked";
+} | {
     readonly organizationId: string;
     readonly blockedUntil?: string | null | undefined;
-} | import("@effect/platform/HttpClientError").HttpClientError | import("effect/ParseResult").ParseError, never>;
+    readonly _tag: "AccessBlocked";
+} | {
+    readonly url: string;
+    readonly blockedType?: string | undefined;
+    readonly _tag: "FetchBlocked";
+} | {
+    readonly _tag: "PayloadTooLarge";
+} | import("@effect/platform/HttpClientError").HttpClientError, never>;
 /** Mirrors `Generated.Client['fetchFetchSearch']` but decodes the 200 body with `json` preserved. */
-export declare const fetchSnapshotSearch: (httpClient: HttpClient.HttpClient, options: typeof Generated.FetchFetchSearchRequest.Encoded) => Effect.Effect<FetchSnapshotSearchResultWithJson, {
-    readonly message: string;
-    readonly _tag: "HttpApiDecodeError";
+export declare const fetchSnapshotSearch: (httpClient: HttpClient.HttpClient, options: typeof Generated.FetchFetchSearchRequest.Encoded) => Effect.Effect<FetchSnapshotSearchResultWithJson, Generated.AuthFailed | Generated.FetchSnapshotSearchNotFound | Generated.InternalError | import("effect/ParseResult").ParseError | Generated.ServiceUnavailable | Generated.TooManyRequests | {
     readonly issues: readonly {
-        readonly message: string;
-        readonly _tag: "Type" | "Pointer" | "Unexpected" | "Missing" | "Composite" | "Refinement" | "Transformation" | "Forbidden";
+        readonly _tag: "Composite" | "Forbidden" | "Missing" | "Pointer" | "Refinement" | "Transformation" | "Type" | "Unexpected";
         readonly path: readonly (string | number | {
             readonly _tag: "symbol";
             readonly key: string;
         })[];
+        readonly message: string;
     }[];
+    readonly message: string;
+    readonly _tag: "HttpApiDecodeError";
 } | {
     readonly message: string;
     readonly _tag: "BadRequest";
-} | Generated.AuthFailed | Generated.PayloadTooLarge | Generated.TooManyRequests | Generated.InternalError | Generated.ServiceUnavailable | {
-    readonly _tag: "AccessBlocked";
+} | {
+    readonly _tag: "PayloadTooLarge";
+} | {
     readonly organizationId: string;
     readonly blockedUntil?: string | null | undefined;
-} | Generated.FetchSnapshotSearchNotFound | import("@effect/platform/HttpClientError").HttpClientError | import("effect/ParseResult").ParseError, never>;
+    readonly _tag: "AccessBlocked";
+} | import("@effect/platform/HttpClientError").HttpClientError, never>;
 export {};
 //# sourceMappingURL=FetchJson.d.ts.map

package/build/dts/FetchJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FetchJson.d.ts","sourceRoot":"","sources":["../../src/FetchJson.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAyC,MAAM,kBAAkB,CAAA;AACpF,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAG3C,0FAA0F;AAC1F,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;EAOrC,CAAA;AAEF,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;EAIpC,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEF,qBAAa,6BAA8B,SAAQ,kCAcjD;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,qBAAa,iCAAkC,SAAQ,sCAOrD;CAAG;AAEL,mGAAmG;AACnG,eAAO,MAAM,mBAAmB,GAC/B,YAAY,UAAU,CAAC,UAAU,EACjC,SAAS;IACR,QAAQ,CAAC,MAAM,EAAE,OAAO,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAA;IAC9D,QAAQ,CAAC,OAAO,EAAE,OAAO,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAA;CAChE;;;;;;;;;;;;;;;;;;;;;;gHAqBA,CAAA;AAEF,qGAAqG;AACrG,eAAO,MAAM,mBAAmB,GAC/B,YAAY,UAAU,CAAC,UAAU,EACjC,SAAS,OAAO,SAAS,CAAC,uBAAuB,CAAC,OAAO;;;;;;;;;;;;;;;;;;wJAqBxD,CAAA"}
+{"version":3,"file":"FetchJson.d.ts","sourceRoot":"","sources":["../../src/FetchJson.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAyC,MAAM,kBAAkB,CAAA;AACpF,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC5C,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAG3C,0FAA0F;AAC1F,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;EAGrC,CAAA;AAEF,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;EAGpC,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEF,qBAAa,6BAA8B,SAAQ,kCAWjD;CAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEL,qBAAa,iCAAkC,SAAQ,sCAQrD;CAAG;AAEL,mGAAmG;AACnG,eAAO,MAAM,mBAAmB,eACnB,UAAU,CAAC,UAAU,WACxB;IACR,QAAQ,CAAC,MAAM,EAAE,OAAO,SAAS,CAAC,oBAAoB,CAAC,OAAO,CAAA;IAC9D,QAAQ,CAAC,OAAO,EAAE,OAAO,SAAS,CAAC,qBAAqB,CAAC,OAAO,CAAA;CAChE;;;;;;;;;;;;;;;;;;;;;;;;sEAwBA,CAAA;AAEF,qGAAqG;AACrG,eAAO,MAAM,mBAAmB,eACnB,UAAU,CAAC,UAAU,WACxB,OAAO,SAAS,CAAC,uBAAuB,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;sEAqBxD,CAAA"}