@expandai/sdk 0.17.0 → 0.17.1

package/build/dts/FetchJson.d.ts

@@ -0,0 +1,364 @@
+import { HttpClient } from '@effect/platform';
+import * as Generated from '@expandai/sdk/Generated';
+import { Effect, Schema as S } from 'effect';
+/** Search snippet with the extracted `json` value preserved (statejson snippets only). */
+export declare const FetchSearchSnippetWithJson: S.Struct<{
+    type: S.optionalWith<S.Literal<["text"]>, {
+        nullable: true;
+        default: () => "text";
+    }>;
+    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;
+    }>;
+}>;
+export declare const FetchSearchResultWithJson: S.Struct<{
+    query: typeof S.String;
+    snippets: S.Array$<S.Struct<{
+        type: S.optionalWith<S.Literal<["text"]>, {
+            nullable: true;
+            default: () => "text";
+        }>;
+        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;
+        }>;
+    }>>;
+    meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+        nullable: true;
+    }>;
+}>;
+declare const FetchObjectModeResultWithJson_base: S.Class<FetchObjectModeResultWithJson, {
+    meta: typeof Generated.FetchObjectModeMeta;
+    markdown: typeof S.String;
+    json: S.Array$<typeof Generated.FetchObjectModeEvidence>;
+    data: S.optionalWith<S.Struct<{
+        assets: S.optionalWith<S.Array$<typeof Generated.FetchAssetReference>, {
+            nullable: true;
+        }>;
+        captureTelemetry: S.optionalWith<typeof Generated.CaptureTelemetryInfo, {
+            nullable: true;
+        }>;
+        search: S.optionalWith<S.Struct<{
+            query: typeof S.String;
+            snippets: S.Array$<S.Struct<{
+                type: S.optionalWith<S.Literal<["text"]>, {
+                    nullable: true;
+                    default: () => "text";
+                }>;
+                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;
+                }>;
+            }>>;
+            meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+                nullable: true;
+            }>;
+        }>, {
+            nullable: true;
+        }>;
+    }>, {
+        nullable: true;
+    }>;
+}, S.Struct.Encoded<{
+    meta: typeof Generated.FetchObjectModeMeta;
+    markdown: typeof S.String;
+    json: S.Array$<typeof Generated.FetchObjectModeEvidence>;
+    data: S.optionalWith<S.Struct<{
+        assets: S.optionalWith<S.Array$<typeof Generated.FetchAssetReference>, {
+            nullable: true;
+        }>;
+        captureTelemetry: S.optionalWith<typeof Generated.CaptureTelemetryInfo, {
+            nullable: true;
+        }>;
+        search: S.optionalWith<S.Struct<{
+            query: typeof S.String;
+            snippets: S.Array$<S.Struct<{
+                type: S.optionalWith<S.Literal<["text"]>, {
+                    nullable: true;
+                    default: () => "text";
+                }>;
+                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;
+                }>;
+            }>>;
+            meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+                nullable: true;
+            }>;
+        }>, {
+            nullable: true;
+        }>;
+    }>, {
+        nullable: true;
+    }>;
+}>, never, {
+    readonly markdown: string;
+} & {
+    readonly meta: {
+        readonly url: string;
+        readonly markdown?: {
+            readonly url: string;
+            readonly moreTokens: number;
+        } | undefined;
+        readonly appendix?: {
+            readonly url: string;
+            readonly links: {
+                readonly sameDomain: number;
+                readonly external: number;
+            };
+        } | 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 meta?: {
+                readonly durationMs: number;
+                readonly sources: readonly {
+                    readonly source: "markdown" | "appendix" | "statejson";
+                    readonly chunkCount: number;
+                    readonly batchCount: number;
+                    readonly ranker: "zeroentropy" | "local_lexical";
+                    readonly fallback: boolean;
+                    readonly fallbackReason?: "timeout" | "error" | 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 text: string;
+                readonly location?: {
+                    readonly markdownBlockId?: string | undefined;
+                    readonly nodeIds?: readonly number[] | undefined;
+                    readonly stateJsonSourceId?: number | undefined;
+                    readonly jsonPath?: string | undefined;
+                } | undefined;
+            }[];
+        } | 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 preparedPageHit?: 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;
+}, {}, {}>;
+export declare class FetchObjectModeResultWithJson extends FetchObjectModeResultWithJson_base {
+}
+declare const FetchSnapshotSearchResultWithJson_base: S.Class<FetchSnapshotSearchResultWithJson, {
+    snapshotId: S.filter<typeof S.String>;
+    response: typeof Generated.ResponseInfo;
+    search: S.Struct<{
+        query: typeof S.String;
+        snippets: S.Array$<S.Struct<{
+            type: S.optionalWith<S.Literal<["text"]>, {
+                nullable: true;
+                default: () => "text";
+            }>;
+            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;
+            }>;
+        }>>;
+        meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+            nullable: true;
+        }>;
+    }>;
+    durationMs: S.filter<typeof S.Number>;
+}, S.Struct.Encoded<{
+    snapshotId: S.filter<typeof S.String>;
+    response: typeof Generated.ResponseInfo;
+    search: S.Struct<{
+        query: typeof S.String;
+        snippets: S.Array$<S.Struct<{
+            type: S.optionalWith<S.Literal<["text"]>, {
+                nullable: true;
+                default: () => "text";
+            }>;
+            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;
+            }>;
+        }>>;
+        meta: S.optionalWith<typeof Generated.FetchSearchMeta, {
+            nullable: true;
+        }>;
+    }>;
+    durationMs: S.filter<typeof S.Number>;
+}>, never, {
+    readonly search: {
+        readonly meta?: {
+            readonly durationMs: number;
+            readonly sources: readonly {
+                readonly source: "markdown" | "appendix" | "statejson";
+                readonly chunkCount: number;
+                readonly batchCount: number;
+                readonly ranker: "zeroentropy" | "local_lexical";
+                readonly fallback: boolean;
+                readonly fallbackReason?: "timeout" | "error" | 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 text: string;
+            readonly location?: {
+                readonly markdownBlockId?: string | undefined;
+                readonly nodeIds?: readonly number[] | undefined;
+                readonly stateJsonSourceId?: number | undefined;
+                readonly jsonPath?: string | undefined;
+            } | undefined;
+        }[];
+    };
+} & {
+    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 {
+}
+/** Mirrors `Generated.Client['fetchFetchJson']` but decodes the 200 body with `json` preserved. */
+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";
+    readonly issues: readonly {
+        readonly message: string;
+        readonly _tag: "Type" | "Pointer" | "Unexpected" | "Missing" | "Composite" | "Refinement" | "Transformation" | "Forbidden";
+        readonly path: readonly (string | number | {
+            readonly _tag: "symbol";
+            readonly key: string;
+        })[];
+    }[];
+} | {
+    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>;
+/** 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";
+    readonly issues: readonly {
+        readonly message: string;
+        readonly _tag: "Type" | "Pointer" | "Unexpected" | "Missing" | "Composite" | "Refinement" | "Transformation" | "Forbidden";
+        readonly path: readonly (string | number | {
+            readonly _tag: "symbol";
+            readonly key: string;
+        })[];
+    }[];
+} | {
+    readonly message: string;
+    readonly _tag: "BadRequest";
+} | Generated.AuthFailed | Generated.PayloadTooLarge | Generated.TooManyRequests | Generated.InternalError | Generated.ServiceUnavailable | {
+    readonly _tag: "AccessBlocked";
+    readonly organizationId: string;
+    readonly blockedUntil?: string | null | undefined;
+} | Generated.FetchSnapshotSearchNotFound | import("@effect/platform/HttpClientError").HttpClientError | import("effect/ParseResult").ParseError, never>;
+export {};
+//# sourceMappingURL=FetchJson.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"FetchJson.d.ts","sourceRoot":"","sources":["../../src/FetchJson.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAyC,MAAM,kBAAkB,CAAA;AACpF,OAAO,KAAK,SAAS,MAAM,yBAAyB,CAAA;AAEpD,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE5C,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"}