blume 2.1.0 → 2.1.1

package/dist/types/openapi/model.d.ts

@@ -1,4 +1,5 @@
-import type { Document, OperationObject } from "@scalar/openapi-types/3.1";
+import type { Document, OperationObject } from "@scalar/openapi-types/3.2";
+import type { GraphqlAuthOptions } from "../reference/options.ts";
 import type { AsyncApiAction, AsyncApiDocument, AsyncApiSpecValue } from "./asyncapi.ts";
 import type { GraphqlDocument, GraphqlMember } from "./graphql.ts";
 import type { ReferenceKind } from "./references.ts";
@@ -12,10 +13,18 @@ export { slugify } from "./references.ts";
  * Each operation is flattened into an {@link ApiOperationRef} with a real,
  * per-operation route so it becomes a first-class Blume page.
  */
-/** A normalized OpenAPI 3.1 document, internal `$ref`s intact. */
+/**
+ * A normalized OpenAPI document, internal `$ref`s intact. Typed as 3.2, which
+ * is backward compatible with 3.1, so one type covers both the upgraded 3.1
+ * documents and the 3.2 ones read as written.
+ */
 export type ApiDocument = Document;
-/** The HTTP methods an OpenAPI path item may declare, in spec order. */
-export declare const HTTP_METHODS: readonly ["get", "put", "post", "delete", "options", "head", "patch", "trace"];
+/**
+ * The HTTP methods an OpenAPI path item may declare, in spec order. `query`
+ * is OpenAPI 3.2's (the QUERY method: a safe request that carries a body); a
+ * 3.1 path item can't declare it, so listing it changes nothing there.
+ */
+export declare const HTTP_METHODS: readonly ["get", "put", "post", "delete", "options", "head", "patch", "trace", "query"];
 export type HttpMethod = (typeof HTTP_METHODS)[number];
 /** A stable, URL-safe key for an operation: its `operationId`, else method+path. */
 export declare const operationKey: (method: string, path: string, operationId?: string) => string;
@@ -79,6 +88,8 @@ export interface ApiSpecData {
      * (GraphQL only; OpenAPI documents carry their servers in the document).
      */
     endpoint?: string;
+    /** How the GraphQL endpoint authenticates (GraphQL only). */
+    auth?: GraphqlAuthOptions;
     /** Operations keyed by {@link ApiOperationRef.key}. */
     operations: Record<string, ApiOperationRef>;
     tags: ApiTagRef[];

package/dist/types/openapi/parse.d.ts

@@ -1,8 +1,11 @@
 import type { AsyncApiDocument } from "./asyncapi.ts";
+import type { SpecIssue } from "./checks.ts";
 import type { GraphqlDocument } from "./graphql.ts";
 import type { ApiDocument } from "./model.ts";
 export interface ParsedSpec {
     document: ApiDocument;
+    /** `x-codeSamples` entries whose `$ref` couldn't be inlined. */
+    issues: SpecIssue[];
     warnings: string[];
 }
 /**

package/dist/types/openapi/references.d.ts

@@ -1,4 +1,5 @@
 import type { ResolvedConfig } from "../core/schema.ts";
+import type { GraphqlAuthOptions } from "../reference/options.ts";
 import type { ScalarOptions } from "../reference/scalar.ts";
 import type { ResolvedReferenceAdapter } from "../reference/schema.ts";
 export { normalizeRoute } from "../core/base-path.ts";
@@ -47,6 +48,12 @@ export interface ReferenceSource {
      */
     basePath: string;
     label: string;
+    /**
+     * The source's own `label`, when it sets one: it names the sidebar group
+     * of the source's route. An unlabeled source's group keeps the name its
+     * route gives it.
+     */
+    groupLabel?: string;
     /** Whether generated pages are included in llms.txt/llms-full.txt. */
     includeInLlms: boolean;
     /** Whether generated pages are included in site search. */
@@ -70,6 +77,8 @@ export interface ReferenceSource {
      * (GraphQL only — a schema, unlike an OpenAPI document, names no server).
      */
     endpoint?: string;
+    /** How the GraphQL endpoint authenticates (GraphQL only). */
+    auth?: GraphqlAuthOptions;
     /**
      * The `scalar()` adapter's own options (`scalar` kind only): `theme` plus
      * any Scalar config forwarded verbatim to `<ScalarComponent>`, which takes
@@ -112,6 +121,13 @@ export declare const resolveReferences: (config: ResolvedConfig) => ReferenceSou
 export declare const referenceRoutes: (config: ResolvedConfig) => string[];
 /** Blume-rendered references (every kind but Scalar), deduped by route (first wins). */
 export declare const blumeReferences: (config: ResolvedConfig) => BlumeReferenceSource[];
+/**
+ * The local files every reference reads, as absolute paths: each spec and
+ * overlay that isn't an `http(s)` URL, resolved from the project root the way
+ * the parser resolves them. `blume dev` watches these, so an edit to a spec
+ * regenerates its reference like an edit to a page does.
+ */
+export declare const referenceSpecFiles: (config: ResolvedConfig, root: string) => string[];
 /** Whether any reference is Scalar-rendered (gates the Scalar pages). */
 export declare const hasScalarReferences: (config: ResolvedConfig) => boolean;
 /**

package/dist/types/ratelimit/index.d.ts

@@ -24,4 +24,4 @@ export { memory } from "./memory.ts";
 export type { MemoryAdapter, RateLimitOptions } from "./memory.ts";
 export type { RateLimitAdapter } from "./schema.ts";
 export { upstash } from "./upstash.ts";
-export type { UpstashAdapter } from "./upstash.ts";
+export type { UpstashAdapter, UpstashOptions } from "./upstash.ts";

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

@@ -22,6 +22,8 @@ export declare const rateLimitAdapterSchema: z.ZodDiscriminatedUnion<[z.ZodObjec
     options: z.ZodObject<{
         requests: z.ZodOptional<z.ZodNumber>;
         window: z.ZodOptional<z.ZodNumber>;
+        tokenEnv: z.ZodOptional<z.ZodString>;
+        urlEnv: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>;
     requiredSecrets: z.ZodArray<z.ZodString>;
     runtimeDeps: z.ZodArray<z.ZodString>;
@@ -55,6 +57,8 @@ export declare const rateLimitConfigSchema: z.ZodPipe<z.ZodOptional<z.ZodUnion<r
     options: z.ZodObject<{
         requests: z.ZodOptional<z.ZodNumber>;
         window: z.ZodOptional<z.ZodNumber>;
+        tokenEnv: z.ZodOptional<z.ZodString>;
+        urlEnv: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>;
     requiredSecrets: z.ZodArray<z.ZodString>;
     runtimeDeps: z.ZodArray<z.ZodString>;
@@ -80,6 +84,8 @@ export declare const rateLimitConfigSchema: z.ZodPipe<z.ZodOptional<z.ZodUnion<r
     options: {
         requests?: number | undefined;
         window?: number | undefined;
+        tokenEnv?: string | undefined;
+        urlEnv?: string | undefined;
     };
     requiredSecrets: string[];
     runtimeDeps: string[];
@@ -105,6 +111,8 @@ export declare const rateLimitConfigSchema: z.ZodPipe<z.ZodOptional<z.ZodUnion<r
     options: {
         requests?: number | undefined;
         window?: number | undefined;
+        tokenEnv?: string | undefined;
+        urlEnv?: string | undefined;
     };
     requiredSecrets: string[];
     runtimeDeps: string[];

package/dist/types/ratelimit/upstash.d.ts

@@ -1,21 +1,46 @@
+import { z } from "zod";
 import type { AdapterDescriptor } from "../core/adapter.ts";
 import type { RateLimitOptions } from "./memory.ts";
-/** The env vars holding the Upstash Redis REST endpoint and its token. */
-export declare const UPSTASH_SECRETS: readonly ["UPSTASH_REDIS_REST_URL", "UPSTASH_REDIS_REST_TOKEN"];
-export type UpstashAdapter = AdapterDescriptor<"upstash", RateLimitOptions>;
-export declare const upstashAdapterSchema: import("zod").ZodObject<{
-    kind: import("zod").ZodLiteral<"upstash">;
-    options: import("zod").ZodObject<{
-        requests: import("zod").ZodOptional<import("zod").ZodNumber>;
-        window: import("zod").ZodOptional<import("zod").ZodNumber>;
-    }, import("zod/v4/core").$strict>;
-    requiredSecrets: import("zod").ZodArray<import("zod").ZodString>;
-    runtimeDeps: import("zod").ZodArray<import("zod").ZodString>;
-}, import("zod/v4/core").$strict>;
+/** Options for {@link upstash}. */
+export interface UpstashOptions extends RateLimitOptions {
+    /**
+     * Name of the env var holding the REST token. Defaults to
+     * `UPSTASH_REDIS_REST_TOKEN`; a database added from Vercel's Marketplace
+     * sets `KV_REST_API_TOKEN`.
+     */
+    tokenEnv?: string;
+    /**
+     * Name of the env var holding the REST endpoint. Defaults to
+     * `UPSTASH_REDIS_REST_URL`; a database added from Vercel's Marketplace
+     * sets `KV_REST_API_URL`.
+     */
+    urlEnv?: string;
+}
+export declare const upstashOptionsSchema: z.ZodObject<{
+    requests: z.ZodOptional<z.ZodNumber>;
+    window: z.ZodOptional<z.ZodNumber>;
+    tokenEnv: z.ZodOptional<z.ZodString>;
+    urlEnv: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type UpstashAdapter = AdapterDescriptor<"upstash", UpstashOptions>;
+export declare const upstashAdapterSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"upstash">;
+    options: z.ZodObject<{
+        requests: z.ZodOptional<z.ZodNumber>;
+        window: z.ZodOptional<z.ZodNumber>;
+        tokenEnv: z.ZodOptional<z.ZodString>;
+        urlEnv: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    requiredSecrets: z.ZodArray<z.ZodString>;
+    runtimeDeps: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+/** The env vars the endpoint and its token are read from, in that order. */
+export declare const upstashSecrets: (options: UpstashOptions) => [string, string];
 /**
  * Keeps the count in Upstash Redis, which every instance on every host shares,
  * so the limit holds exactly. It talks to Upstash's REST API, so there is
  * nothing to install; the endpoint and token come from
- * `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN`.
+ * `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN`, or the env vars
+ * `urlEnv` and `tokenEnv` name.
  */
-export declare const upstash: (options?: RateLimitOptions) => UpstashAdapter;
+export declare const upstash: (options?: UpstashOptions) => UpstashAdapter;

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

@@ -1,8 +1,15 @@
 import { z } from "zod";
 import type { AdapterDescriptor } from "../core/adapter.ts";
-import type { GraphqlSourceOptions, PlaygroundOptions } from "./options.ts";
+import type { GraphqlAuthOptions, GraphqlSourceOptions, PlaygroundOptions } from "./options.ts";
 /** Options for {@link graphql}. */
 export interface GraphqlOptions {
+    /**
+     * How the endpoint authenticates, like the site's `api.auth`: `bearer`,
+     * `basic`, or `key` (sent in the `name` header, `x-api-key` by default).
+     * The Try it panel gets a field for the credential and the code samples
+     * send a placeholder. Applies to every source; a per-source `auth` wins.
+     */
+    auth?: GraphqlAuthOptions;
     /**
      * Code-sample languages shown per operation, in order. Defaults to
      * `["curl", "js", "python"]`; `false` shows none.
@@ -36,6 +43,15 @@ export interface GraphqlOptions {
  * AsyncAPI documents only.
  */
 export declare const graphqlOptionsSchema: z.ZodPipe<z.ZodObject<{
+    auth: z.ZodOptional<z.ZodObject<{
+        method: z.ZodEnum<{
+            none: "none";
+            key: "key";
+            bearer: "bearer";
+            basic: "basic";
+        }>;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
     endpoint: z.ZodOptional<z.ZodString>;
     sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
         includeInLlms: z.ZodDefault<z.ZodBoolean>;
@@ -45,6 +61,15 @@ export declare const graphqlOptionsSchema: z.ZodPipe<z.ZodObject<{
         route: z.ZodOptional<z.ZodString>;
         seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
         spec: z.ZodString;
+        auth: z.ZodOptional<z.ZodObject<{
+            method: z.ZodEnum<{
+                none: "none";
+                key: "key";
+                bearer: "bearer";
+                basic: "basic";
+            }>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
         endpoint: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>>>;
     codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
@@ -69,6 +94,10 @@ export declare const graphqlOptionsSchema: z.ZodPipe<z.ZodObject<{
         spec: string;
         label?: string | undefined;
         route?: string | undefined;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
     }[];
     codeSamples: false | string[];
@@ -77,6 +106,10 @@ export declare const graphqlOptionsSchema: z.ZodPipe<z.ZodObject<{
         proxy: string | boolean;
     };
     route: string;
+    auth?: {
+        method: "none" | "key" | "bearer" | "basic";
+        name?: string | undefined;
+    } | undefined;
     endpoint?: string | undefined;
     spec?: string | undefined;
 }, "spec" | "overlays">, {
@@ -88,6 +121,10 @@ export declare const graphqlOptionsSchema: z.ZodPipe<z.ZodObject<{
         spec: string;
         label?: string | undefined;
         route?: string | undefined;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
     }[];
     codeSamples: false | string[];
@@ -96,6 +133,10 @@ export declare const graphqlOptionsSchema: z.ZodPipe<z.ZodObject<{
         proxy: string | boolean;
     };
     route: string;
+    auth?: {
+        method: "none" | "key" | "bearer" | "basic";
+        name?: string | undefined;
+    } | undefined;
     endpoint?: string | undefined;
     spec?: string | undefined;
 }>>;
@@ -107,6 +148,15 @@ export type ResolvedGraphqlAdapter = AdapterDescriptor<"graphql", ResolvedGraphq
 export declare const graphqlAdapterSchema: z.ZodObject<{
     kind: z.ZodLiteral<"graphql">;
     options: z.ZodPipe<z.ZodObject<{
+        auth: z.ZodOptional<z.ZodObject<{
+            method: z.ZodEnum<{
+                none: "none";
+                key: "key";
+                bearer: "bearer";
+                basic: "basic";
+            }>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
         endpoint: z.ZodOptional<z.ZodString>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             includeInLlms: z.ZodDefault<z.ZodBoolean>;
@@ -116,6 +166,15 @@ export declare const graphqlAdapterSchema: z.ZodObject<{
             route: z.ZodOptional<z.ZodString>;
             seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
             spec: z.ZodString;
+            auth: z.ZodOptional<z.ZodObject<{
+                method: z.ZodEnum<{
+                    none: "none";
+                    key: "key";
+                    bearer: "bearer";
+                    basic: "basic";
+                }>;
+                name: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>>;
             endpoint: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>;
         codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
@@ -140,6 +199,10 @@ export declare const graphqlAdapterSchema: z.ZodObject<{
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
+            auth?: {
+                method: "none" | "key" | "bearer" | "basic";
+                name?: string | undefined;
+            } | undefined;
             endpoint?: string | undefined;
         }[];
         codeSamples: false | string[];
@@ -148,6 +211,10 @@ export declare const graphqlAdapterSchema: z.ZodObject<{
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
     }, "spec" | "overlays">, {
@@ -159,6 +226,10 @@ export declare const graphqlAdapterSchema: z.ZodObject<{
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
+            auth?: {
+                method: "none" | "key" | "bearer" | "basic";
+                name?: string | undefined;
+            } | undefined;
             endpoint?: string | undefined;
         }[];
         codeSamples: false | string[];
@@ -167,6 +238,10 @@ export declare const graphqlAdapterSchema: z.ZodObject<{
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
     }>>;

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

@@ -26,7 +26,7 @@ export { graphql } from "./graphql.ts";
 export type { GraphqlAdapter, GraphqlOptions } from "./graphql.ts";
 export { openapi } from "./openapi.ts";
 export type { OpenApiAdapter, OpenApiOptions } from "./openapi.ts";
-export type { GraphqlSourceOptions, PlaygroundOptions, ReferenceSourceOptions, } from "./options.ts";
+export type { GraphqlAuthOptions, GraphqlSourceOptions, PlaygroundOptions, ReferenceSourceOptions, } from "./options.ts";
 export { scalar } from "./scalar.ts";
 export type { ScalarAdapter, ScalarOptions, ScalarSourceOptions, } from "./scalar.ts";
 export type { ReferenceAdapter, ResolvedReferenceAdapter } from "./schema.ts";

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

@@ -5,8 +5,8 @@ import type { OpenApiSourceOptions, PlaygroundOptions } from "./options.ts";
 export interface OpenApiOptions {
     /**
      * Code-sample languages generated per operation (Blume renderer), in
-     * order. Defaults to `["curl", "js", "python"]`; `false` generates none, so
-     * only the spec's own `x-codeSamples` show.
+     * order. Defaults to `["curl", "js", "python"]`; `false` (or an empty list)
+     * generates none, so only the spec's own `x-codeSamples` show.
      */
     codeSamples?: string[] | false;
     /** Start nested schema rows expanded rather than collapsed (Blume renderer). Defaults to `false`. */

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

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import type { AuthMethod } from "../components/content/api-page.ts";
 /**
  * A single spec rendered by a reference. `spec` is a local path or an
  * `http(s)` URL (an OpenAPI document for `openapi()`, an AsyncAPI document
@@ -71,10 +72,34 @@ export interface OpenApiSourceOptions extends ReferenceSourceOptions {
      */
     overlays?: string[];
 }
+/**
+ * How a GraphQL endpoint authenticates, in the shape the site's `api.auth`
+ * takes for hand-written endpoints: `bearer`, `basic`, or `key` (sent in the
+ * `name` header, `x-api-key` by default). A schema, unlike an OpenAPI
+ * document, declares no security schemes, so this is what gives the Try it
+ * panel its credential field.
+ */
+export declare const graphqlAuthSchema: z.ZodObject<{
+    method: z.ZodEnum<{
+        none: "none";
+        key: "key";
+        bearer: "bearer";
+        basic: "basic";
+    }>;
+    name: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** The `auth` option of `graphql()` and its sources. */
+export interface GraphqlAuthOptions {
+    /** `bearer`, `basic`, `key`, or `none`. */
+    method: AuthMethod;
+    /** The header an API key goes in. Defaults to `x-api-key`. */
+    name?: string;
+}
 /**
  * A single GraphQL schema: the shared source shape plus `endpoint`, the live
  * GraphQL API URL the playground and code samples target (a schema, unlike an
- * OpenAPI document, names no server).
+ * OpenAPI document, names no server), and `auth`, how that endpoint
+ * authenticates.
  */
 export declare const graphqlSourceSchema: z.ZodObject<{
     includeInLlms: z.ZodDefault<z.ZodBoolean>;
@@ -84,10 +109,21 @@ export declare const graphqlSourceSchema: z.ZodObject<{
     route: z.ZodOptional<z.ZodString>;
     seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
     spec: z.ZodString;
+    auth: z.ZodOptional<z.ZodObject<{
+        method: z.ZodEnum<{
+            none: "none";
+            key: "key";
+            bearer: "bearer";
+            basic: "basic";
+        }>;
+        name: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
     endpoint: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>;
 /** One schema source, as `graphql()` accepts it. */
 export interface GraphqlSourceOptions extends ReferenceSourceOptions {
+    /** How the endpoint authenticates; wins over the adapter's `auth`. */
+    auth?: GraphqlAuthOptions;
     /** URL of the live GraphQL endpoint (playground + code samples); wins over the adapter's `endpoint`. */
     endpoint?: string;
 }

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

@@ -81,6 +81,15 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
 }, z.core.$strict>, z.ZodObject<{
     kind: z.ZodLiteral<"graphql">;
     options: z.ZodPipe<z.ZodObject<{
+        auth: z.ZodOptional<z.ZodObject<{
+            method: z.ZodEnum<{
+                none: "none";
+                key: "key";
+                bearer: "bearer";
+                basic: "basic";
+            }>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
         endpoint: z.ZodOptional<z.ZodString>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             includeInLlms: z.ZodDefault<z.ZodBoolean>;
@@ -90,6 +99,15 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             route: z.ZodOptional<z.ZodString>;
             seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
             spec: z.ZodString;
+            auth: z.ZodOptional<z.ZodObject<{
+                method: z.ZodEnum<{
+                    none: "none";
+                    key: "key";
+                    bearer: "bearer";
+                    basic: "basic";
+                }>;
+                name: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>>;
             endpoint: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>;
         codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
@@ -114,6 +132,10 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
+            auth?: {
+                method: "none" | "key" | "bearer" | "basic";
+                name?: string | undefined;
+            } | undefined;
             endpoint?: string | undefined;
         }[];
         codeSamples: false | string[];
@@ -122,6 +144,10 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
     }, "spec" | "overlays">, {
@@ -133,6 +159,10 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
+            auth?: {
+                method: "none" | "key" | "bearer" | "basic";
+                name?: string | undefined;
+            } | undefined;
             endpoint?: string | undefined;
         }[];
         codeSamples: false | string[];
@@ -141,6 +171,10 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
     }>>;
@@ -286,6 +320,10 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
+            auth?: {
+                method: "none" | "key" | "bearer" | "basic";
+                name?: string | undefined;
+            } | undefined;
             endpoint?: string | undefined;
         }[];
         codeSamples: false | string[];
@@ -294,6 +332,10 @@ export declare const referenceAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
     }, "spec" | "overlays">;
@@ -398,6 +440,15 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
 }, z.core.$strict>, z.ZodObject<{
     kind: z.ZodLiteral<"graphql">;
     options: z.ZodPipe<z.ZodObject<{
+        auth: z.ZodOptional<z.ZodObject<{
+            method: z.ZodEnum<{
+                none: "none";
+                key: "key";
+                bearer: "bearer";
+                basic: "basic";
+            }>;
+            name: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
         endpoint: z.ZodOptional<z.ZodString>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             includeInLlms: z.ZodDefault<z.ZodBoolean>;
@@ -407,6 +458,15 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             route: z.ZodOptional<z.ZodString>;
             seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
             spec: z.ZodString;
+            auth: z.ZodOptional<z.ZodObject<{
+                method: z.ZodEnum<{
+                    none: "none";
+                    key: "key";
+                    bearer: "bearer";
+                    basic: "basic";
+                }>;
+                name: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>>;
             endpoint: z.ZodOptional<z.ZodString>;
         }, z.core.$strict>>>;
         codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
@@ -431,6 +491,10 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
+            auth?: {
+                method: "none" | "key" | "bearer" | "basic";
+                name?: string | undefined;
+            } | undefined;
             endpoint?: string | undefined;
         }[];
         codeSamples: false | string[];
@@ -439,6 +503,10 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
     }, "spec" | "overlays">, {
@@ -450,6 +518,10 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
+            auth?: {
+                method: "none" | "key" | "bearer" | "basic";
+                name?: string | undefined;
+            } | undefined;
             endpoint?: string | undefined;
         }[];
         codeSamples: false | string[];
@@ -458,6 +530,10 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
     }>>;
@@ -603,6 +679,10 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
+            auth?: {
+                method: "none" | "key" | "bearer" | "basic";
+                name?: string | undefined;
+            } | undefined;
             endpoint?: string | undefined;
         }[];
         codeSamples: false | string[];
@@ -611,6 +691,10 @@ export declare const referenceConfigSchema: z.ZodDefault<z.ZodArray<z.ZodPipe<z.
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
     }, "spec" | "overlays">;

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

@@ -69,6 +69,7 @@ declare const adapterVariants: readonly [z.ZodObject<{
         apiKey: z.ZodString;
         collection: z.ZodString;
         host: z.ZodString;
+        locale: z.ZodOptional<z.ZodString>;
         port: z.ZodOptional<z.ZodNumber>;
         protocol: z.ZodOptional<z.ZodEnum<{
             http: "http";
@@ -141,6 +142,7 @@ export declare const resolvedSearchAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUn
         apiKey: z.ZodString;
         collection: z.ZodString;
         host: z.ZodString;
+        locale: z.ZodOptional<z.ZodString>;
         port: z.ZodOptional<z.ZodNumber>;
         protocol: z.ZodOptional<z.ZodEnum<{
             http: "http";
@@ -212,6 +214,7 @@ export declare const resolvedSearchAdapterSchema: z.ZodPipe<z.ZodDiscriminatedUn
         apiKey: string;
         collection: string;
         host: string;
+        locale?: string | undefined;
         port?: number | undefined;
         protocol?: "http" | "https" | undefined;
     };