blume 1.7.2 → 2.0.0

package/dist/types/reference/schema.d.ts

@@ -0,0 +1,630 @@
+import { z } from "zod";
+import type { AsyncApiAdapter, ResolvedAsyncApiAdapter } from "./asyncapi.ts";
+import type { GraphqlAdapter, ResolvedGraphqlAdapter } from "./graphql.ts";
+import type { OpenApiAdapter, ResolvedOpenApiAdapter } from "./openapi.ts";
+import type { ResolvedScalarAdapter, ScalarAdapter } from "./scalar.ts";
+/** Every descriptor a `blume/reference` factory can return. */
+export type ReferenceAdapter = AsyncApiAdapter | GraphqlAdapter | OpenApiAdapter | ScalarAdapter;
+/** What `config.reference` holds: each descriptor with its options resolved. */
+export type ResolvedReferenceAdapter = ResolvedAsyncApiAdapter | ResolvedGraphqlAdapter | ResolvedOpenApiAdapter | ResolvedScalarAdapter;
+/**
+ * One configured reference adapter, as its factory returned it. Only `kind`
+ * and `options` carry information — the metadata lists are validated for
+ * shape, then re-derived from the resolved options so a descriptor that went
+ * through JSON resolves to the same canonical metadata the factory ships.
+ */
+export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"asyncapi">;
+    options: z.ZodPipe<z.ZodObject<{
+        expandSchemas: z.ZodDefault<z.ZodBoolean>;
+        sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            includeInLlms: z.ZodDefault<z.ZodBoolean>;
+            includeInSearch: z.ZodDefault<z.ZodBoolean>;
+            label: z.ZodOptional<z.ZodString>;
+            noindex: z.ZodDefault<z.ZodBoolean>;
+            route: z.ZodOptional<z.ZodString>;
+            seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
+            spec: z.ZodString;
+        }, z.core.$strict>>>;
+        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+        }, z.core.$strict>]>>, z.ZodTransform<{
+            enabled: boolean;
+            proxy: string | boolean;
+        }, boolean | {
+            enabled: boolean;
+            proxy: string | boolean;
+        }>>;
+        route: z.ZodDefault<z.ZodString>;
+        spec: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodTransform<Omit<{
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }, "spec">, {
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }>>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"graphql">;
+    options: z.ZodPipe<z.ZodObject<{
+        endpoint: z.ZodOptional<z.ZodString>;
+        sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            includeInLlms: z.ZodDefault<z.ZodBoolean>;
+            includeInSearch: z.ZodDefault<z.ZodBoolean>;
+            label: z.ZodOptional<z.ZodString>;
+            noindex: z.ZodDefault<z.ZodBoolean>;
+            route: z.ZodOptional<z.ZodString>;
+            seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
+            spec: z.ZodString;
+            endpoint: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+        }, z.core.$strict>]>>, z.ZodTransform<{
+            enabled: boolean;
+            proxy: string | boolean;
+        }, boolean | {
+            enabled: boolean;
+            proxy: string | boolean;
+        }>>;
+        route: z.ZodDefault<z.ZodString>;
+        spec: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodTransform<Omit<{
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+            endpoint?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        endpoint?: string | undefined;
+        spec?: string | undefined;
+    }, "spec">, {
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+            endpoint?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        endpoint?: string | undefined;
+        spec?: string | undefined;
+    }>>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"openapi">;
+    options: z.ZodPipe<z.ZodObject<{
+        expandSchemas: z.ZodDefault<z.ZodBoolean>;
+        sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            includeInLlms: z.ZodDefault<z.ZodBoolean>;
+            includeInSearch: z.ZodDefault<z.ZodBoolean>;
+            label: z.ZodOptional<z.ZodString>;
+            noindex: z.ZodDefault<z.ZodBoolean>;
+            route: z.ZodOptional<z.ZodString>;
+            seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
+            spec: z.ZodString;
+        }, z.core.$strict>>>;
+        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+        }, z.core.$strict>]>>, z.ZodTransform<{
+            enabled: boolean;
+            proxy: string | boolean;
+        }, boolean | {
+            enabled: boolean;
+            proxy: string | boolean;
+        }>>;
+        route: z.ZodDefault<z.ZodString>;
+        spec: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodTransform<Omit<{
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }, "spec">, {
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }>>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"scalar">;
+    options: z.ZodPipe<z.ZodObject<{
+        route: z.ZodDefault<z.ZodString>;
+        sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            label: z.ZodOptional<z.ZodString>;
+            noindex: z.ZodDefault<z.ZodBoolean>;
+            route: z.ZodOptional<z.ZodString>;
+            spec: z.ZodString;
+        }, z.core.$strict>>>;
+        spec: z.ZodOptional<z.ZodString>;
+        theme: z.ZodOptional<z.ZodString>;
+    }, z.core.$catchall<z.ZodJSONSchema>>, z.ZodTransform<import("./scalar.ts").ResolvedScalarOptions, {
+        [x: string]: z.core.util.JSONType;
+        route: string;
+        sources: {
+            noindex: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        spec?: string | undefined;
+        theme?: string | undefined;
+    }>>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>], "kind">, z.ZodTransform<ResolvedScalarAdapter | ResolvedAsyncApiAdapter | ResolvedGraphqlAdapter | ResolvedOpenApiAdapter, {
+    kind: "scalar";
+    options: import("./scalar.ts").ResolvedScalarOptions;
+    requiredSecrets: string[];
+    runtimeDeps: string[];
+} | {
+    kind: "asyncapi";
+    options: Omit<{
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }, "spec">;
+    requiredSecrets: string[];
+    runtimeDeps: string[];
+} | {
+    kind: "graphql";
+    options: Omit<{
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+            endpoint?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        endpoint?: string | undefined;
+        spec?: string | undefined;
+    }, "spec">;
+    requiredSecrets: string[];
+    runtimeDeps: string[];
+} | {
+    kind: "openapi";
+    options: Omit<{
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }, "spec">;
+    requiredSecrets: string[];
+    runtimeDeps: string[];
+}>>;
+/**
+ * `blume.config.reference`: the API references to render, in order. Unset
+ * means none. A non-array fails with the list hint; element errors keep their
+ * own messages.
+ */
+export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    kind: z.ZodLiteral<"asyncapi">;
+    options: z.ZodPipe<z.ZodObject<{
+        expandSchemas: z.ZodDefault<z.ZodBoolean>;
+        sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            includeInLlms: z.ZodDefault<z.ZodBoolean>;
+            includeInSearch: z.ZodDefault<z.ZodBoolean>;
+            label: z.ZodOptional<z.ZodString>;
+            noindex: z.ZodDefault<z.ZodBoolean>;
+            route: z.ZodOptional<z.ZodString>;
+            seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
+            spec: z.ZodString;
+        }, z.core.$strict>>>;
+        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+        }, z.core.$strict>]>>, z.ZodTransform<{
+            enabled: boolean;
+            proxy: string | boolean;
+        }, boolean | {
+            enabled: boolean;
+            proxy: string | boolean;
+        }>>;
+        route: z.ZodDefault<z.ZodString>;
+        spec: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodTransform<Omit<{
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }, "spec">, {
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }>>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"graphql">;
+    options: z.ZodPipe<z.ZodObject<{
+        endpoint: z.ZodOptional<z.ZodString>;
+        sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            includeInLlms: z.ZodDefault<z.ZodBoolean>;
+            includeInSearch: z.ZodDefault<z.ZodBoolean>;
+            label: z.ZodOptional<z.ZodString>;
+            noindex: z.ZodDefault<z.ZodBoolean>;
+            route: z.ZodOptional<z.ZodString>;
+            seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
+            spec: z.ZodString;
+            endpoint: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>>;
+        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+        }, z.core.$strict>]>>, z.ZodTransform<{
+            enabled: boolean;
+            proxy: string | boolean;
+        }, boolean | {
+            enabled: boolean;
+            proxy: string | boolean;
+        }>>;
+        route: z.ZodDefault<z.ZodString>;
+        spec: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodTransform<Omit<{
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+            endpoint?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        endpoint?: string | undefined;
+        spec?: string | undefined;
+    }, "spec">, {
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+            endpoint?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        endpoint?: string | undefined;
+        spec?: string | undefined;
+    }>>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"openapi">;
+    options: z.ZodPipe<z.ZodObject<{
+        expandSchemas: z.ZodDefault<z.ZodBoolean>;
+        sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            includeInLlms: z.ZodDefault<z.ZodBoolean>;
+            includeInSearch: z.ZodDefault<z.ZodBoolean>;
+            label: z.ZodOptional<z.ZodString>;
+            noindex: z.ZodDefault<z.ZodBoolean>;
+            route: z.ZodOptional<z.ZodString>;
+            seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
+            spec: z.ZodString;
+        }, z.core.$strict>>>;
+        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            proxy: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
+        }, z.core.$strict>]>>, z.ZodTransform<{
+            enabled: boolean;
+            proxy: string | boolean;
+        }, boolean | {
+            enabled: boolean;
+            proxy: string | boolean;
+        }>>;
+        route: z.ZodDefault<z.ZodString>;
+        spec: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodTransform<Omit<{
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }, "spec">, {
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }>>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    kind: z.ZodLiteral<"scalar">;
+    options: z.ZodPipe<z.ZodObject<{
+        route: z.ZodDefault<z.ZodString>;
+        sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            label: z.ZodOptional<z.ZodString>;
+            noindex: z.ZodDefault<z.ZodBoolean>;
+            route: z.ZodOptional<z.ZodString>;
+            spec: z.ZodString;
+        }, z.core.$strict>>>;
+        spec: z.ZodOptional<z.ZodString>;
+        theme: z.ZodOptional<z.ZodString>;
+    }, z.core.$catchall<z.ZodJSONSchema>>, z.ZodTransform<import("./scalar.ts").ResolvedScalarOptions, {
+        [x: string]: z.core.util.JSONType;
+        route: string;
+        sources: {
+            noindex: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        spec?: string | undefined;
+        theme?: string | undefined;
+    }>>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>], "kind">, z.ZodTransform<ResolvedScalarAdapter | ResolvedAsyncApiAdapter | ResolvedGraphqlAdapter | ResolvedOpenApiAdapter, {
+    kind: "scalar";
+    options: import("./scalar.ts").ResolvedScalarOptions;
+    requiredSecrets: string[];
+    runtimeDeps: string[];
+} | {
+    kind: "asyncapi";
+    options: Omit<{
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }, "spec">;
+    requiredSecrets: string[];
+    runtimeDeps: string[];
+} | {
+    kind: "graphql";
+    options: Omit<{
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+            endpoint?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        endpoint?: string | undefined;
+        spec?: string | undefined;
+    }, "spec">;
+    requiredSecrets: string[];
+    runtimeDeps: string[];
+} | {
+    kind: "openapi";
+    options: Omit<{
+        expandSchemas: boolean;
+        sources: {
+            includeInLlms: boolean;
+            includeInSearch: boolean;
+            noindex: boolean;
+            seoDescriptionSuffix: boolean;
+            spec: string;
+            label?: string | undefined;
+            route?: string | undefined;
+        }[];
+        codeSamples: string[];
+        playground: {
+            enabled: boolean;
+            proxy: string | boolean;
+        };
+        route: string;
+        spec?: string | undefined;
+    }, "spec">;
+    requiredSecrets: string[];
+    runtimeDeps: string[];
+}>>>>;
+/**
+ * The hint for a config still carrying the 1.x `openapi`/`asyncapi`/`graphql`
+ * blocks, or `undefined` when none of the unrecognized keys is one of them
+ * (so the default "unrecognized key" message applies). Wired into the root
+ * config object's error hook: the keys are gone from the schema, so without
+ * this a migrating site would see only "Unrecognized key". Any other unknown
+ * key keeps Zod's wording beside the hint, and the rest of the config is
+ * still validated in the same run.
+ */
+export declare const removedReferenceKeysHint: (keys: string[]) => string | undefined;

package/dist/types/search/adapters/algolia.d.ts

@@ -0,0 +1,32 @@
+import { z } from "zod";
+import type { JsonValue } from "../../core/adapter.ts";
+import type { SearchAdapter } from "./types.ts";
+/**
+ * Public Algolia credentials. The browser queries the index with the
+ * search-only `apiKey`; the build-time sync replaces the index with the admin
+ * key from `ALGOLIA_ADMIN_API_KEY`, which never enters the config.
+ */
+export interface AlgoliaNamedOptions {
+    appId: string;
+    /** The search-only API key (public — it ships to the browser). */
+    apiKey: string;
+    indexName: string;
+}
+/**
+ * Options for {@link algolia}: the named options plus any other client
+ * option, forwarded to the browser verbatim. JSON values only.
+ */
+export type AlgoliaOptions = AlgoliaNamedOptions & {
+    [option: string]: JsonValue;
+};
+export type AlgoliaAdapter = SearchAdapter<"algolia", "hosted", AlgoliaOptions>;
+export declare const algoliaOptionsSchema: z.ZodObject<{
+    apiKey: z.ZodString;
+    appId: z.ZodString;
+    indexName: z.ZodString;
+}, z.core.$catchall<z.ZodJSONSchema>>;
+/**
+ * Hosted search on Algolia. Each `blume build` replaces the whole index with
+ * the current records, so deleted or renamed pages don't linger as stale hits.
+ */
+export declare const algolia: (options: AlgoliaOptions) => AlgoliaAdapter;

package/dist/types/search/adapters/flexsearch.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+import type { KeylessSearchOptions, SearchAdapter } from "./types.ts";
+/** FlexSearch takes no options; unknown keys fail config validation. */
+export type FlexsearchOptions = KeylessSearchOptions;
+export type FlexsearchAdapter = SearchAdapter<"flexsearch", "static", FlexsearchOptions>;
+export declare const flexsearchOptionsSchema: z.ZodObject<{}, z.core.$strict>;
+/**
+ * A second keyless, client-side engine. It loads the same `/blume-search.json`
+ * index Orama ships and builds a FlexSearch document index in the browser.
+ * No locale-aware tokenizer, so prefer Orama for non-Latin scripts.
+ */
+export declare const flexsearch: (options?: FlexsearchOptions) => FlexsearchAdapter;