@scalar/types 0.3.0 → 0.3.2

package/dist/api-reference/api-reference-configuration.d.ts

@@ -1,157 +1,27 @@
-import { z } from 'zod';
+import { type ZodType, z } from 'zod';
 import type { AuthenticationConfiguration } from './authentication-configuration.js';
-/** Configuration for the OpenAPI/Swagger specification */
-export declare const specConfigurationSchema: z.ZodObject<{
-    url: z.ZodOptional<z.ZodString>;
-    content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
+import { type SourceConfiguration } from './source-configuration.js';
+/**
+ * Standard configuration for the Api Reference.
+ *
+ * This is used internally to the configure the applications and does not include the sources.
+ *
+ * Sources should only be specified in the user facing configurations.
+ *
+ * In the the future it is likely sources will be removed completely from the configuration and instead
+ * specified through a separate addDocument interface.
+ */
+export declare const apiReferenceConfigurationSchema: z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
     slug: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-export type SpecConfiguration = z.infer<typeof specConfigurationSchema>;
-/** Configuration for the Api Client */
-export declare const apiClientConfigurationSchema: z.ZodObject<{
-    url: z.ZodOptional<z.ZodString>;
-    content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
-    title: z.ZodOptional<z.ZodString>;
-    slug: z.ZodOptional<z.ZodString>;
-    spec: z.ZodOptional<z.ZodObject<{
-        url: z.ZodOptional<z.ZodString>;
-        content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
-        title: z.ZodOptional<z.ZodString>;
-        slug: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
     authentication: z.ZodOptional<z.ZodAny>;
     baseServerURL: z.ZodOptional<z.ZodString>;
     hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
     proxyUrl: z.ZodOptional<z.ZodString>;
     searchHotKey: z.ZodOptional<z.ZodEnum<{
-        c: "c";
-        r: "r";
         a: "a";
         b: "b";
-        d: "d";
-        e: "e";
-        f: "f";
-        g: "g";
-        h: "h";
-        i: "i";
-        j: "j";
-        k: "k";
-        l: "l";
-        m: "m";
-        n: "n";
-        o: "o";
-        p: "p";
-        q: "q";
-        s: "s";
-        t: "t";
-        u: "u";
-        v: "v";
-        w: "w";
-        x: "x";
-        y: "y";
-        z: "z";
-    }>>;
-    servers: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-    showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    showToolbar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        never: "never";
-        always: "always";
-        localhost: "localhost";
-    }>>>>;
-    operationTitleSource: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        summary: "summary";
-        path: "path";
-    }>>>>;
-    theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        default: "default";
-        alternate: "alternate";
-        moon: "moon";
-        purple: "purple";
-        solarized: "solarized";
-        bluePlanet: "bluePlanet";
-        deepSpace: "deepSpace";
-        saturn: "saturn";
-        kepler: "kepler";
-        elysiajs: "elysiajs";
-        fastify: "fastify";
-        mars: "mars";
-        laserwave: "laserwave";
-        none: "none";
-    }>>>>;
-    _integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-        go: "go";
-        rust: "rust";
-        elysiajs: "elysiajs";
-        fastify: "fastify";
-        adonisjs: "adonisjs";
-        docusaurus: "docusaurus";
-        dotnet: "dotnet";
-        express: "express";
-        fastapi: "fastapi";
-        hono: "hono";
-        html: "html";
-        laravel: "laravel";
-        litestar: "litestar";
-        nestjs: "nestjs";
-        nextjs: "nextjs";
-        nitro: "nitro";
-        nuxt: "nuxt";
-        platformatic: "platformatic";
-        react: "react";
-        svelte: "svelte";
-        vue: "vue";
-    }>>>;
-    onRequestSent: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>;
-    persistAuth: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
-        name: z.ZodString;
-        views: z.ZodOptional<z.ZodObject<{
-            'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
-                title: z.ZodOptional<z.ZodString>;
-                component: z.ZodUnknown;
-                props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-            }, z.core.$strip>>>;
-            'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
-                title: z.ZodOptional<z.ZodString>;
-                component: z.ZodUnknown;
-                props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-            }, z.core.$strip>>>;
-        }, z.core.$strip>>;
-        hooks: z.ZodOptional<z.ZodObject<{
-            onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
-                request: z.ZodCustom<Request, Request>;
-            }, z.core.$strip>], null>, z.ZodUnion<readonly [z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
-            onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
-                response: z.ZodCustom<Response, Response>;
-                operation: z.ZodRecord<z.ZodString, z.ZodAny>;
-            }, z.core.$strip>], null>, z.ZodUnion<readonly [z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>>>>;
-    telemetry: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-}, z.core.$strip>;
-export type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>;
-/** Configuration for the Api Client without the transform since it cannot be merged */
-declare const _apiReferenceConfigurationSchema: z.ZodObject<{
-    url: z.ZodOptional<z.ZodString>;
-    content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
-    title: z.ZodOptional<z.ZodString>;
-    slug: z.ZodOptional<z.ZodString>;
-    spec: z.ZodOptional<z.ZodObject<{
-        url: z.ZodOptional<z.ZodString>;
-        content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
-        title: z.ZodOptional<z.ZodString>;
-        slug: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
-    authentication: z.ZodOptional<z.ZodAny>;
-    baseServerURL: z.ZodOptional<z.ZodString>;
-    hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    proxyUrl: z.ZodOptional<z.ZodString>;
-    searchHotKey: z.ZodOptional<z.ZodEnum<{
         c: "c";
-        r: "r";
-        a: "a";
-        b: "b";
         d: "d";
         e: "e";
         f: "f";
@@ -166,6 +36,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<{
         o: "o";
         p: "p";
         q: "q";
+        r: "r";
         s: "s";
         t: "t";
         u: "u";
@@ -203,8 +74,6 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<{
         none: "none";
     }>>>>;
     _integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-        go: "go";
-        rust: "rust";
         elysiajs: "elysiajs";
         fastify: "fastify";
         adonisjs: "adonisjs";
@@ -212,6 +81,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<{
         dotnet: "dotnet";
         express: "express";
         fastapi: "fastapi";
+        go: "go";
         hono: "hono";
         html: "html";
         laravel: "laravel";
@@ -222,6 +92,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<{
         nuxt: "nuxt";
         platformatic: "platformatic";
         react: "react";
+        rust: "rust";
         svelte: "svelte";
         vue: "vue";
     }>>>;
@@ -266,7 +137,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<{
     favicon: z.ZodOptional<z.ZodString>;
     hiddenClients: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>, z.ZodArray<z.ZodString>, z.ZodLiteral<true>]>>;
     defaultHttpClient: z.ZodOptional<z.ZodObject<{
-        targetKey: z.ZodCustom<"c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift", "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift">;
+        targetKey: z.ZodCustom<"c" | "r" | "go" | "rust" | "clojure" | "csharp" | "dart" | "http" | "fsharp" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "ruby" | "shell" | "swift", "c" | "r" | "go" | "rust" | "clojure" | "csharp" | "dart" | "http" | "fsharp" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "ruby" | "shell" | "swift">;
         clientKey: z.ZodString;
     }, z.core.$strip>>;
     customCss: z.ZodOptional<z.ZodString>;
@@ -311,394 +182,56 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<{
     orderSchemaPropertiesBy: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"alpha">, z.ZodLiteral<"preserve">]>>>>;
     orderRequiredPropertiesFirst: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
 }, z.core.$strip>;
+/**
+ * Configuration for the Scalar Api Reference integrations
+ *
+ * See the type `ApiReferenceConfigurationWithSource` or `AnyApiReferenceConfiguration`\
+ * for the configuration that includes the sources for you OpenAPI documents
+ */
+export type ApiReferenceConfiguration = Omit<z.infer<typeof apiReferenceConfigurationSchema>, // Remove deprecated attributes
+// Remove deprecated attributes
+'proxy' | 'spec' | 'authentication'> & {
+    authentication?: AuthenticationConfiguration;
+} & {
+    /** @deprecated
+     * This type now refers to the base configuration that does not include the sources.
+     * Use the type `ApiReferenceConfigurationWithSource` instead.
+     */
+    url?: SourceConfiguration['url'];
+    /** @deprecated
+     * This type now refers to the base configuration that does not include the sources.
+     * Use the type `ApiReferenceConfigurationWithSource` instead.
+     */
+    content?: SourceConfiguration['content'];
+};
+/** Migrate the configuration through a transform */
 /** Configuration for the Api Reference */
-export declare const apiReferenceConfigurationSchema: z.ZodPipe<z.ZodObject<{
-    url: z.ZodOptional<z.ZodString>;
-    content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
-    title: z.ZodOptional<z.ZodString>;
-    slug: z.ZodOptional<z.ZodString>;
-    spec: z.ZodOptional<z.ZodObject<{
-        url: z.ZodOptional<z.ZodString>;
-        content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
-        title: z.ZodOptional<z.ZodString>;
-        slug: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>>;
-    authentication: z.ZodOptional<z.ZodAny>;
-    baseServerURL: z.ZodOptional<z.ZodString>;
-    hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    proxyUrl: z.ZodOptional<z.ZodString>;
-    searchHotKey: z.ZodOptional<z.ZodEnum<{
-        c: "c";
-        r: "r";
-        a: "a";
-        b: "b";
-        d: "d";
-        e: "e";
-        f: "f";
-        g: "g";
-        h: "h";
-        i: "i";
-        j: "j";
-        k: "k";
-        l: "l";
-        m: "m";
-        n: "n";
-        o: "o";
-        p: "p";
-        q: "q";
-        s: "s";
-        t: "t";
-        u: "u";
-        v: "v";
-        w: "w";
-        x: "x";
-        y: "y";
-        z: "z";
-    }>>;
-    servers: z.ZodOptional<z.ZodArray<z.ZodAny>>;
-    showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    showToolbar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        never: "never";
-        always: "always";
-        localhost: "localhost";
-    }>>>>;
-    operationTitleSource: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        summary: "summary";
-        path: "path";
-    }>>>>;
-    theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        default: "default";
-        alternate: "alternate";
-        moon: "moon";
-        purple: "purple";
-        solarized: "solarized";
-        bluePlanet: "bluePlanet";
-        deepSpace: "deepSpace";
-        saturn: "saturn";
-        kepler: "kepler";
-        elysiajs: "elysiajs";
-        fastify: "fastify";
-        mars: "mars";
-        laserwave: "laserwave";
-        none: "none";
-    }>>>>;
-    _integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
-        go: "go";
-        rust: "rust";
-        elysiajs: "elysiajs";
-        fastify: "fastify";
-        adonisjs: "adonisjs";
-        docusaurus: "docusaurus";
-        dotnet: "dotnet";
-        express: "express";
-        fastapi: "fastapi";
-        hono: "hono";
-        html: "html";
-        laravel: "laravel";
-        litestar: "litestar";
-        nestjs: "nestjs";
-        nextjs: "nextjs";
-        nitro: "nitro";
-        nuxt: "nuxt";
-        platformatic: "platformatic";
-        react: "react";
-        svelte: "svelte";
-        vue: "vue";
-    }>>>;
-    onRequestSent: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>;
-    persistAuth: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    telemetry: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    layout: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        modern: "modern";
-        classic: "classic";
-    }>>>>;
-    proxy: z.ZodOptional<z.ZodString>;
-    fetch: z.ZodOptional<z.ZodCustom<(input: string | URL | Request, init?: RequestInit) => Promise<Response>, (input: string | URL | Request, init?: RequestInit) => Promise<Response>>>;
-    plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
-        name: z.ZodString;
-        extensions: z.ZodArray<z.ZodObject<{
-            name: z.ZodString;
-            component: z.ZodUnknown;
-            renderer: z.ZodOptional<z.ZodUnknown>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>>>>;
-    isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    isLoading: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    hideModels: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    documentDownloadType: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
-        none: "none";
-        yaml: "yaml";
-        json: "json";
-        both: "both";
-        direct: "direct";
-    }>>>>;
-    hideDownloadButton: z.ZodOptional<z.ZodBoolean>;
-    hideTestRequestButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    hideSearch: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    showOperationId: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    darkMode: z.ZodOptional<z.ZodBoolean>;
-    forceDarkModeState: z.ZodOptional<z.ZodEnum<{
-        dark: "dark";
-        light: "light";
-    }>>;
-    hideDarkModeToggle: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    metaData: z.ZodOptional<z.ZodAny>;
-    favicon: z.ZodOptional<z.ZodString>;
-    hiddenClients: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>, z.ZodArray<z.ZodString>, z.ZodLiteral<true>]>>;
-    defaultHttpClient: z.ZodOptional<z.ZodObject<{
-        targetKey: z.ZodCustom<"c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift", "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift">;
-        clientKey: z.ZodString;
-    }, z.core.$strip>>;
-    customCss: z.ZodOptional<z.ZodString>;
-    onSpecUpdate: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>;
-    onServerChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>;
-    onDocumentSelect: z.ZodType<(() => Promise<void> | void) | undefined>;
-    onLoaded: z.ZodType<(() => Promise<void> | void) | undefined>;
-    onBeforeRequest: z.ZodType<((a: {
-        request: Request;
-    }) => Promise<void> | void) | undefined>;
-    onShowMore: z.ZodType<((a: string) => Promise<void> | void) | undefined>;
-    onSidebarClick: z.ZodType<((a: string) => Promise<void> | void) | undefined>;
-    pathRouting: z.ZodOptional<z.ZodObject<{
-        basePath: z.ZodString;
-    }, z.core.$strip>>;
-    generateHeadingSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
-        slug: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString>>;
-    generateModelSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString>>;
-    generateTagSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString>>;
-    generateOperationSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
-        path: z.ZodString;
-        operationId: z.ZodOptional<z.ZodString>;
-        method: z.ZodString;
-        summary: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString>>;
-    generateWebhookSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodString;
-        method: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString>>;
-    redirect: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodOptional<z.ZodNullable<z.ZodString>>>>;
-    withDefaultFonts: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    defaultOpenAllTags: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    expandAllModelSections: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    expandAllResponses: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    tagsSorter: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"alpha">, z.ZodFunction<z.ZodTuple<readonly [z.ZodAny, z.ZodAny], null>, z.ZodNumber>]>>;
-    operationsSorter: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"alpha">, z.ZodLiteral<"method">, z.ZodFunction<z.ZodTuple<readonly [z.ZodAny, z.ZodAny], null>, z.ZodNumber>]>>;
-    orderSchemaPropertiesBy: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"alpha">, z.ZodLiteral<"preserve">]>>>>;
-    orderRequiredPropertiesFirst: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-}, z.core.$strip>, z.ZodTransform<{
-    hideClientButton: boolean;
-    showSidebar: boolean;
-    showToolbar: "never" | "always" | "localhost";
-    operationTitleSource: "summary" | "path";
-    theme: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
-    persistAuth: boolean;
-    telemetry: boolean;
-    layout: "modern" | "classic";
-    isEditable: boolean;
-    isLoading: boolean;
-    hideModels: boolean;
-    documentDownloadType: "none" | "yaml" | "json" | "both" | "direct";
-    hideTestRequestButton: boolean;
-    hideSearch: boolean;
-    showOperationId: boolean;
-    hideDarkModeToggle: boolean;
-    onDocumentSelect: (() => Promise<void> | void) | undefined;
-    onLoaded: (() => Promise<void> | void) | undefined;
-    onBeforeRequest: ((a: {
-        request: Request;
-    }) => Promise<void> | void) | undefined;
-    onShowMore: ((a: string) => Promise<void> | void) | undefined;
-    onSidebarClick: ((a: string) => Promise<void> | void) | undefined;
-    withDefaultFonts: boolean;
-    defaultOpenAllTags: boolean;
-    expandAllModelSections: boolean;
-    expandAllResponses: boolean;
-    orderSchemaPropertiesBy: "alpha" | "preserve";
-    orderRequiredPropertiesFirst: boolean;
-    url?: string | undefined;
-    content?: string | Record<string, any> | z.core.$InferOuterFunctionType<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>> | null | undefined;
-    title?: string | undefined;
-    slug?: string | undefined;
-    spec?: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | z.core.$InferOuterFunctionType<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>> | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    } | undefined;
-    authentication?: any;
-    baseServerURL?: string | undefined;
-    proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
-    servers?: any[] | undefined;
-    _integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
-    onRequestSent?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid> | undefined;
-    proxy?: string | undefined;
-    fetch?: ((input: string | URL | Request, init?: RequestInit) => Promise<Response>) | undefined;
-    plugins?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [], null>, z.ZodObject<{
-        name: z.ZodString;
-        extensions: z.ZodArray<z.ZodObject<{
-            name: z.ZodString;
-            component: z.ZodUnknown;
-            renderer: z.ZodOptional<z.ZodUnknown>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>>[] | undefined;
-    hideDownloadButton?: boolean | undefined;
-    darkMode?: boolean | undefined;
-    forceDarkModeState?: "dark" | "light" | undefined;
-    metaData?: any;
-    favicon?: string | undefined;
-    hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
-    defaultHttpClient?: {
-        targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
-        clientKey: string;
-    } | undefined;
-    customCss?: string | undefined;
-    onSpecUpdate?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid> | undefined;
-    onServerChange?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid> | undefined;
-    pathRouting?: {
-        basePath: string;
-    } | undefined;
-    generateHeadingSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        slug: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    generateModelSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    generateTagSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    generateOperationSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        path: z.ZodString;
-        operationId: z.ZodOptional<z.ZodString>;
-        method: z.ZodString;
-        summary: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    generateWebhookSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodString;
-        method: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    redirect?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodString], null>, z.ZodOptional<z.ZodNullable<z.ZodString>>> | undefined;
-    tagsSorter?: "alpha" | z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodAny, z.ZodAny], null>, z.ZodNumber> | undefined;
-    operationsSorter?: "method" | "alpha" | z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodAny, z.ZodAny], null>, z.ZodNumber> | undefined;
-}, {
-    hideClientButton: boolean;
-    showSidebar: boolean;
-    showToolbar: "never" | "always" | "localhost";
-    operationTitleSource: "summary" | "path";
-    theme: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
-    persistAuth: boolean;
-    telemetry: boolean;
-    layout: "modern" | "classic";
-    isEditable: boolean;
-    isLoading: boolean;
-    hideModels: boolean;
-    documentDownloadType: "none" | "yaml" | "json" | "both" | "direct";
-    hideTestRequestButton: boolean;
-    hideSearch: boolean;
-    showOperationId: boolean;
-    hideDarkModeToggle: boolean;
-    onDocumentSelect: (() => Promise<void> | void) | undefined;
-    onLoaded: (() => Promise<void> | void) | undefined;
-    onBeforeRequest: ((a: {
-        request: Request;
-    }) => Promise<void> | void) | undefined;
-    onShowMore: ((a: string) => Promise<void> | void) | undefined;
-    onSidebarClick: ((a: string) => Promise<void> | void) | undefined;
-    withDefaultFonts: boolean;
-    defaultOpenAllTags: boolean;
-    expandAllModelSections: boolean;
-    expandAllResponses: boolean;
-    orderSchemaPropertiesBy: "alpha" | "preserve";
-    orderRequiredPropertiesFirst: boolean;
-    url?: string | undefined;
-    content?: string | Record<string, any> | z.core.$InferOuterFunctionType<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>> | null | undefined;
-    title?: string | undefined;
-    slug?: string | undefined;
-    spec?: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | z.core.$InferOuterFunctionType<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>> | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    } | undefined;
-    authentication?: any;
-    baseServerURL?: string | undefined;
-    proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
-    servers?: any[] | undefined;
-    _integration?: "go" | "rust" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "svelte" | "vue" | null | undefined;
-    onRequestSent?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid> | undefined;
-    proxy?: string | undefined;
-    fetch?: ((input: string | URL | Request, init?: RequestInit) => Promise<Response>) | undefined;
-    plugins?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [], null>, z.ZodObject<{
-        name: z.ZodString;
-        extensions: z.ZodArray<z.ZodObject<{
-            name: z.ZodString;
-            component: z.ZodUnknown;
-            renderer: z.ZodOptional<z.ZodUnknown>;
-        }, z.core.$strip>>;
-    }, z.core.$strip>>[] | undefined;
-    hideDownloadButton?: boolean | undefined;
-    darkMode?: boolean | undefined;
-    forceDarkModeState?: "dark" | "light" | undefined;
-    metaData?: any;
-    favicon?: string | undefined;
-    hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
-    defaultHttpClient?: {
-        targetKey: "c" | "clojure" | "csharp" | "dart" | "http" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "rust" | "shell" | "swift";
-        clientKey: string;
-    } | undefined;
-    customCss?: string | undefined;
-    onSpecUpdate?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid> | undefined;
-    onServerChange?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid> | undefined;
-    pathRouting?: {
-        basePath: string;
-    } | undefined;
-    generateHeadingSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        slug: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    generateModelSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    generateTagSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    generateOperationSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        path: z.ZodString;
-        operationId: z.ZodOptional<z.ZodString>;
-        method: z.ZodString;
-        summary: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    generateWebhookSlug?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodObject<{
-        name: z.ZodString;
-        method: z.ZodOptional<z.ZodString>;
-    }, z.core.$strip>], null>, z.ZodString> | undefined;
-    redirect?: z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodString], null>, z.ZodOptional<z.ZodNullable<z.ZodString>>> | undefined;
-    tagsSorter?: "alpha" | z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodAny, z.ZodAny], null>, z.ZodNumber> | undefined;
-    operationsSorter?: "method" | "alpha" | z.core.$InferOuterFunctionType<z.ZodTuple<readonly [z.ZodAny, z.ZodAny], null>, z.ZodNumber> | undefined;
-}>>;
-/** Configuration after parsing, this is the main type */
-export type ApiReferenceConfiguration = Omit<z.infer<typeof _apiReferenceConfigurationSchema>, 'proxy' | 'spec' | 'authentication'> & {
+export declare const apiReferenceConfigurationWithSourceSchema: ZodType<Omit<ApiReferenceConfiguration, 'url' | 'content'> & SourceConfiguration>;
+/**
+ * User facing configuration that includes the document source configuration
+ */
+export type ApiReferenceConfigurationWithSource = Omit<z.infer<typeof apiReferenceConfigurationWithSourceSchema>, 'proxy' | 'spec' | 'authentication'> & {
     authentication?: AuthenticationConfiguration;
 };
-/** Api Config which includes the default config */
-type ApiReferenceConfigurationWithDefault = ApiReferenceConfiguration & {
+/**
+ * When providing an array of configurations we extend with the default attribute
+ * which indicates which configuration should be used as the default one
+ */
+export type ApiReferenceConfigurationWithDefault = ApiReferenceConfigurationWithSource & {
     /** Whether to use this config as the default one */
     default?: boolean;
 };
-/** Configuration for a single config with sources */
-export type ApiReferenceConfigurationWithSources = Omit<ApiReferenceConfigurationWithDefault, 'default'> & {
-    sources: (SpecConfiguration & {
+/**
+ * Configuration for a single config with multiple sources
+ * The configuration will be shared between the documents
+ */
+export type ApiReferenceConfigurationWithMultipleSources = ApiReferenceConfigurationWithSource & {
+    sources: (SourceConfiguration & {
         default?: boolean;
     })[];
 };
 /** Configuration for multiple Api References */
-export type AnyApiReferenceConfiguration = Partial<ApiReferenceConfiguration> | Partial<ApiReferenceConfigurationWithSources> | Partial<ApiReferenceConfigurationWithDefault>[] | Partial<ApiReferenceConfigurationWithSources>[];
+export type AnyApiReferenceConfiguration = Partial<ApiReferenceConfigurationWithSource> | Partial<ApiReferenceConfigurationWithMultipleSources> | Partial<ApiReferenceConfigurationWithDefault>[] | Partial<ApiReferenceConfigurationWithMultipleSources>[];
 /** Typeguard to check to narrow the configs to the one with sources */
-export declare const isConfigurationWithSources: (config: AnyApiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithSources>;
-export {};
+export declare const isConfigurationWithSources: (config: AnyApiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithMultipleSources>;
 //# sourceMappingURL=api-reference-configuration.d.ts.map