blume 2.0.3 → 2.1.1

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

@@ -1,10 +1,20 @@
 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 {
-    /** Code-sample languages shown per operation. Defaults to `["curl", "js", "python"]`. */
-    codeSamples?: string[];
+    /**
+     * 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.
+     */
+    codeSamples?: string[] | false;
     /**
      * URL of the live GraphQL endpoint the playground and code samples target —
      * a schema, unlike an OpenAPI document, names no server. Applies to every
@@ -33,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>;
@@ -42,9 +61,18 @@ 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.ZodArray<z.ZodString>>;
+    codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, 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]>>;
@@ -66,17 +94,25 @@ 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: string[];
+    codeSamples: false | string[];
     playground: {
         enabled: boolean;
         proxy: string | boolean;
     };
     route: string;
+    auth?: {
+        method: "none" | "key" | "bearer" | "basic";
+        name?: string | undefined;
+    } | undefined;
     endpoint?: string | undefined;
     spec?: string | undefined;
-}, "spec">, {
+}, "spec" | "overlays">, {
     sources: {
         includeInLlms: boolean;
         includeInSearch: boolean;
@@ -85,14 +121,22 @@ 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: string[];
+    codeSamples: false | string[];
     playground: {
         enabled: boolean;
         proxy: string | boolean;
     };
     route: string;
+    auth?: {
+        method: "none" | "key" | "bearer" | "basic";
+        name?: string | undefined;
+    } | undefined;
     endpoint?: string | undefined;
     spec?: string | undefined;
 }>>;
@@ -104,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>;
@@ -113,9 +166,18 @@ 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.ZodArray<z.ZodString>>;
+        codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, 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]>>;
@@ -137,17 +199,25 @@ 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: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        auth?: {
+            method: "none" | "key" | "bearer" | "basic";
+            name?: string | undefined;
+        } | undefined;
         endpoint?: string | undefined;
         spec?: string | undefined;
-    }, "spec">, {
+    }, "spec" | "overlays">, {
         sources: {
             includeInLlms: boolean;
             includeInSearch: boolean;
@@ -156,14 +226,22 @@ 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: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             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

@@ -1,10 +1,14 @@
 import { z } from "zod";
 import type { AdapterDescriptor } from "../core/adapter.ts";
-import type { PlaygroundOptions, ReferenceSourceOptions } from "./options.ts";
+import type { OpenApiSourceOptions, PlaygroundOptions } from "./options.ts";
 /** Options for {@link openapi}. */
 export interface OpenApiOptions {
-    /** Code-sample languages shown per operation (Blume renderer). Defaults to `["curl", "js", "python"]`. */
-    codeSamples?: string[];
+    /**
+     * Code-sample languages generated per operation (Blume renderer), in
+     * 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`. */
     expandSchemas?: boolean;
     /**
@@ -15,15 +19,21 @@ export interface OpenApiOptions {
      * `vercel()` in `deployment`).
      */
     playground?: PlaygroundOptions;
+    /**
+     * OpenAPI Overlay documents for `spec`, applied in order before it renders.
+     * With `sources`, each source takes its own `overlays`.
+     */
+    overlays?: string[];
     /** Where the reference mounts. Defaults to `/reference`. */
     route?: string;
     /** One or more specs; each renders on its own route by default. */
-    sources?: ReferenceSourceOptions[];
+    sources?: OpenApiSourceOptions[];
     /** Shorthand for a single source: `sources: [{ spec }]`. */
     spec?: string;
 }
 export declare const openapiOptionsSchema: z.ZodPipe<z.ZodObject<{
     expandSchemas: z.ZodDefault<z.ZodBoolean>;
+    overlays: z.ZodOptional<z.ZodArray<z.ZodString>>;
     sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
         includeInLlms: z.ZodDefault<z.ZodBoolean>;
         includeInSearch: z.ZodDefault<z.ZodBoolean>;
@@ -32,8 +42,9 @@ export declare const openapiOptionsSchema: z.ZodPipe<z.ZodObject<{
         route: z.ZodOptional<z.ZodString>;
         seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
         spec: z.ZodString;
+        overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
     }, z.core.$strict>>>;
-    codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, 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]>>;
@@ -54,17 +65,19 @@ export declare const openapiOptionsSchema: z.ZodPipe<z.ZodObject<{
         noindex: boolean;
         seoDescriptionSuffix: boolean;
         spec: string;
+        overlays: string[];
         label?: string | undefined;
         route?: string | undefined;
     }[];
-    codeSamples: string[];
+    codeSamples: false | string[];
     playground: {
         enabled: boolean;
         proxy: string | boolean;
     };
     route: string;
+    overlays?: string[] | undefined;
     spec?: string | undefined;
-}, "spec">, {
+}, "spec" | "overlays">, {
     expandSchemas: boolean;
     sources: {
         includeInLlms: boolean;
@@ -72,15 +85,17 @@ export declare const openapiOptionsSchema: z.ZodPipe<z.ZodObject<{
         noindex: boolean;
         seoDescriptionSuffix: boolean;
         spec: string;
+        overlays: string[];
         label?: string | undefined;
         route?: string | undefined;
     }[];
-    codeSamples: string[];
+    codeSamples: false | string[];
     playground: {
         enabled: boolean;
         proxy: string | boolean;
     };
     route: string;
+    overlays?: string[] | undefined;
     spec?: string | undefined;
 }>>;
 /** `openapi()` options with every default applied and `spec` folded into `sources`. */
@@ -92,6 +107,7 @@ export declare const openapiAdapterSchema: z.ZodObject<{
     kind: z.ZodLiteral<"openapi">;
     options: z.ZodPipe<z.ZodObject<{
         expandSchemas: z.ZodDefault<z.ZodBoolean>;
+        overlays: z.ZodOptional<z.ZodArray<z.ZodString>>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             includeInLlms: z.ZodDefault<z.ZodBoolean>;
             includeInSearch: z.ZodDefault<z.ZodBoolean>;
@@ -100,8 +116,9 @@ export declare const openapiAdapterSchema: z.ZodObject<{
             route: z.ZodOptional<z.ZodString>;
             seoDescriptionSuffix: z.ZodDefault<z.ZodBoolean>;
             spec: z.ZodString;
+            overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
         }, z.core.$strict>>>;
-        codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+        codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, 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]>>;
@@ -122,17 +139,19 @@ export declare const openapiAdapterSchema: z.ZodObject<{
             noindex: boolean;
             seoDescriptionSuffix: boolean;
             spec: string;
+            overlays: string[];
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        overlays?: string[] | undefined;
         spec?: string | undefined;
-    }, "spec">, {
+    }, "spec" | "overlays">, {
         expandSchemas: boolean;
         sources: {
             includeInLlms: boolean;
@@ -140,15 +159,17 @@ export declare const openapiAdapterSchema: z.ZodObject<{
             noindex: boolean;
             seoDescriptionSuffix: boolean;
             spec: string;
+            overlays: string[];
             label?: string | undefined;
             route?: string | undefined;
         }[];
-        codeSamples: string[];
+        codeSamples: false | string[];
         playground: {
             enabled: boolean;
             proxy: string | boolean;
         };
         route: string;
+        overlays?: string[] | undefined;
         spec?: string | undefined;
     }>>;
     requiredSecrets: z.ZodArray<z.ZodString>;

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
@@ -36,10 +37,69 @@ export interface ReferenceSourceOptions {
 }
 /** A spec source with every default applied. */
 export type ResolvedReferenceSource = z.output<typeof referenceSourceSchema>;
+/**
+ * [OpenAPI Overlay](https://spec.openapis.org/overlay/latest.html) documents
+ * (local paths or `http(s)` URLs) applied in order to an OpenAPI spec before
+ * it renders: changes to a spec you don't edit by hand.
+ */
+export declare const overlaysSchema: z.ZodDefault<z.ZodArray<z.ZodString>>;
+/** Whether adapter-level `overlays` has the `spec` it belongs to. */
+export declare const overlaysHaveSpec: (options: {
+    overlays?: string[];
+    spec?: string;
+}) => boolean;
+/** The refinement issue for `overlays` set beside `sources` instead of `spec`. */
+export declare const overlaysNeedSpecIssue: {
+    message: string;
+    path: string[];
+};
+/** An OpenAPI spec source: the shared shape plus its `overlays`. */
+export declare const openapiSourceSchema: 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;
+    overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+/** One OpenAPI spec source, as `openapi()` accepts it. */
+export interface OpenApiSourceOptions extends ReferenceSourceOptions {
+    /**
+     * OpenAPI Overlay documents (local paths or `http(s)` URLs) applied in
+     * order to the spec before it renders.
+     */
+    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>;
@@ -49,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;
 }
@@ -110,8 +181,11 @@ export declare const sharedOptions: (defaults: {
     codeSamples: string[];
     route: string;
 }) => {
-    /** Code-sample languages/tools shown per operation (Blume renderer). */
-    codeSamples: z.ZodDefault<z.ZodArray<z.ZodString>>;
+    /**
+     * Code-sample languages/tools shown per operation (Blume renderer), or
+     * `false` for none: only the spec's own `x-codeSamples` then.
+     */
+    codeSamples: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<false>, z.ZodArray<z.ZodString>]>>;
     /** The "Try it" panel; see {@link playgroundSchema}. */
     playground: z.ZodPipe<z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
@@ -129,8 +203,9 @@ export declare const sharedOptions: (defaults: {
     spec: z.ZodOptional<z.ZodString>;
 };
 /**
- * Resolve the `spec` shorthand into `sources` so downstream code reads one
- * field: the shorthand becomes the first source (with the source defaults
+ * Resolve the `spec` shorthand (and, on OpenAPI kinds, the `overlays` beside
+ * it) into `sources` so downstream code reads one field: the shorthand becomes
+ * the first source (with the source defaults
  * applied through the source schema itself, so the two can never drift) and
  * the `spec` key is dropped. An adapter with neither renders nothing, which
  * is a config mistake rather than a choice — `refine` it away with
@@ -143,7 +218,8 @@ export declare const liftSpec: <Source extends {
 }>) => <Options extends {
     sources: Source[];
     spec?: string;
-}>({ spec, ...options }: Options) => Omit<Options, "spec">;
+    overlays?: string[];
+}>({ overlays, spec, ...options }: Options) => Omit<Options, "spec" | "overlays">;
 /** Whether an adapter has anything to render; pairs with {@link missingSourcesIssue}. */
 export declare const hasSources: (options: {
     sources: {

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

@@ -15,6 +15,7 @@ export declare const SCALAR_RUNTIME_DEPS: readonly string[];
 export declare const scalarSourceSchema: z.ZodObject<{
     label: z.ZodOptional<z.ZodString>;
     noindex: z.ZodDefault<z.ZodBoolean>;
+    overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
     route: z.ZodOptional<z.ZodString>;
     spec: z.ZodString;
 }, z.core.$strict>;
@@ -24,6 +25,8 @@ export interface ScalarSourceOptions {
     label?: string;
     /** Emit noindex metadata and omit the page from the sitemap. Defaults to `false`. */
     noindex?: boolean;
+    /** OpenAPI Overlay documents applied in order to the document before it's embedded. */
+    overlays?: string[];
     /** Per-source route; defaults to the adapter's `route` (or a derived path). */
     route?: string;
     /** Local path or `http(s)` URL to the OpenAPI or AsyncAPI document. */
@@ -44,6 +47,8 @@ export type ResolvedScalarOptions = {
 };
 /** The options {@link scalar} maps itself. */
 export interface ScalarNamedOptions {
+    /** OpenAPI Overlay documents for `spec`; with `sources`, each takes its own. */
+    overlays?: string[];
     /** Where the reference mounts. Defaults to `/reference`. */
     route?: string;
     /** One or more documents; each renders on its own route by default. */
@@ -73,10 +78,12 @@ export type ScalarOptions = ScalarNamedOptions & {
  * the named ones is Scalar configuration and passes through untouched.
  */
 export declare const scalarOptionsSchema: z.ZodPipe<z.ZodObject<{
+    overlays: z.ZodOptional<z.ZodArray<z.ZodString>>;
     route: z.ZodDefault<z.ZodString>;
     sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
         label: z.ZodOptional<z.ZodString>;
         noindex: z.ZodDefault<z.ZodBoolean>;
+        overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
         route: z.ZodOptional<z.ZodString>;
         spec: z.ZodString;
     }, z.core.$strict>>>;
@@ -87,10 +94,12 @@ export declare const scalarOptionsSchema: z.ZodPipe<z.ZodObject<{
     route: string;
     sources: {
         noindex: boolean;
+        overlays: string[];
         spec: string;
         label?: string | undefined;
         route?: string | undefined;
     }[];
+    overlays?: string[] | undefined;
     spec?: string | undefined;
     theme?: string | undefined;
 }>>;
@@ -100,10 +109,12 @@ export type ResolvedScalarAdapter = AdapterDescriptor<"scalar", ResolvedScalarOp
 export declare const scalarAdapterSchema: z.ZodObject<{
     kind: z.ZodLiteral<"scalar">;
     options: z.ZodPipe<z.ZodObject<{
+        overlays: z.ZodOptional<z.ZodArray<z.ZodString>>;
         route: z.ZodDefault<z.ZodString>;
         sources: z.ZodDefault<z.ZodArray<z.ZodObject<{
             label: z.ZodOptional<z.ZodString>;
             noindex: z.ZodDefault<z.ZodBoolean>;
+            overlays: z.ZodDefault<z.ZodArray<z.ZodString>>;
             route: z.ZodOptional<z.ZodString>;
             spec: z.ZodString;
         }, z.core.$strict>>>;
@@ -114,10 +125,12 @@ export declare const scalarAdapterSchema: z.ZodObject<{
         route: string;
         sources: {
             noindex: boolean;
+            overlays: string[];
             spec: string;
             label?: string | undefined;
             route?: string | undefined;
         }[];
+        overlays?: string[] | undefined;
         spec?: string | undefined;
         theme?: string | undefined;
     }>>;