@scalar/types 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scalar/types
 
+## 0.1.3
+
+### Patch Changes
+
+- 543a16c: feat: allow to explicitly set the default source
+- 57e96a0: feat: add onDocumentSelect callback when switching multi configs
+
+## 0.1.2
+
+### Patch Changes
+
+- 7a8965c: chore: remove spec prefix
+- 49dffff: feat: expose the isLoading prop to control loading of references
+
 ## 0.1.1
 
 ### Patch Changes

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

@@ -395,620 +395,10 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
      */
     isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
     /**
-     * Whether to show models in the sidebar, search, and content.
-     * @default false
-     */
-    hideModels: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    /**
-     * Whether to show the "Download OpenAPI Document" button
-     * @default false
-     */
-    hideDownloadButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    /**
-     * Whether to show the "Test Request" button
-     * @default false
-     */
-    hideTestRequestButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    /**
-     * Whether to show the sidebar search bar
-     * @default false
-     */
-    hideSearch: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    /** Whether dark mode is on or off initially (light mode) */
-    darkMode: z.ZodOptional<z.ZodBoolean>;
-    /** forceDarkModeState makes it always this state no matter what */
-    forceDarkModeState: z.ZodOptional<z.ZodEnum<["dark", "light"]>>;
-    /**
-     * Whether to show the dark mode toggle
-     * @default false
-     */
-    hideDarkModeToggle: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    /**
-     * If used, passed data will be added to the HTML header
-     * @see https://unhead.unjs.io/usage/composables/use-seo-meta
-     */
-    metaData: z.ZodOptional<z.ZodAny>;
-    /**
-     * Path to a favicon image
-     * @default undefined
-     * @example '/favicon.svg'
-     */
-    favicon: z.ZodOptional<z.ZodString>;
-    /**
-     * List of httpsnippet clients to hide from the clients menu
-     * By default hides Unirest, pass `[]` to show all clients
-     */
-    hiddenClients: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>, z.ZodArray<z.ZodString, "many">, z.ZodLiteral<true>]>>;
-    /** Determine the HTTP client that's selected by default */
-    defaultHttpClient: z.ZodOptional<z.ZodObject<{
-        targetKey: z.ZodType<"c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart", z.ZodTypeDef, "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart">;
-        clientKey: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
-        clientKey: string;
-    }, {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
-        clientKey: string;
-    }>>;
-    /** Custom CSS to be added to the page */
-    customCss: z.ZodOptional<z.ZodString>;
-    /** onSpecUpdate is fired on spec/swagger content change */
-    onSpecUpdate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
-    /** onServerChange is fired on selected server change */
-    onServerChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
-    /**
-     * Route using paths instead of hashes, your server MUST support this
-     * @example '/standalone-api-reference/:custom(.*)?'
-     * @experimental
-     * @default undefined
-     */
-    pathRouting: z.ZodOptional<z.ZodObject<{
-        /** Base path for the API reference */
-        basePath: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        basePath: string;
-    }, {
-        basePath: string;
-    }>>;
-    /**
-     * Customize the heading portion of the hash
-     * @param heading - The heading object
-     * @returns A string ID used to generate the URL hash
-     * @default (heading) => `#description/${heading.slug}`
-     */
-    generateHeadingSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
-        slug: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        slug: string;
-    }, {
-        slug?: string | undefined;
-    }>], z.ZodUnknown>, z.ZodString>>;
-    /**
-     * Customize the model portion of the hash
-     * @param model - The model object with a name property
-     * @returns A string ID used to generate the URL hash
-     * @default (model) => slug(model.name)
-     */
-    generateModelSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-    }, {
-        name?: string | undefined;
-    }>], z.ZodUnknown>, z.ZodString>>;
-    /**
-     * Customize the tag portion of the hash
-     * @param tag - The tag object
-     * @returns A string ID used to generate the URL hash
-     * @default (tag) => slug(tag.name)
-     */
-    generateTagSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
-        name: z.ZodDefault<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-    }, {
-        name?: string | undefined;
-    }>], z.ZodUnknown>, z.ZodString>>;
-    /**
-     * Customize the operation portion of the hash
-     * @param operation - The operation object
-     * @returns A string ID used to generate the URL hash
-     * @default (operation) => `${operation.method}${operation.path}`
-     */
-    generateOperationSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
-        path: z.ZodString;
-        operationId: z.ZodOptional<z.ZodString>;
-        method: z.ZodString;
-        summary: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        path: string;
-        method: string;
-        operationId?: string | undefined;
-        summary?: string | undefined;
-    }, {
-        path: string;
-        method: string;
-        operationId?: string | undefined;
-        summary?: string | undefined;
-    }>], z.ZodUnknown>, z.ZodString>>;
-    /**
-     * Customize the webhook portion of the hash
-     * @param webhook - The webhook object
-     * @returns A string ID used to generate the URL hash
-     * @default (webhook) => slug(webhook.name)
-     */
-    generateWebhookSlug: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
-        name: z.ZodString;
-        method: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        method?: string | undefined;
-    }, {
-        name: string;
-        method?: string | undefined;
-    }>], z.ZodUnknown>, z.ZodString>>;
-    /** Callback fired when the reference is fully loaded */
-    onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
-    /**
-     * To handle redirects, pass a function that will recieve:
-     * - The current path with hash if pathRouting is enabled
-     * - The current hash if hashRouting (default)
-     * And then passes that to history.replaceState
-     *
-     * @example hashRouting (default)
-     * ```ts
-     * redirect: (hash: string) => hash.replace('#v1/old-path', '#v2/new-path')
-     * ```
-     * @example pathRouting
-     * ```ts
-     * redirect: (pathWithHash: string) => {
-     *   if (pathWithHash.includes('#')) {
-     *     return pathWithHash.replace('/v1/tags/user#operation/get-user', '/v1/tags/user/operation/get-user')
-     *   }
-     *   return null
-     * }
-     * ```
-     */
-    redirect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodOptional<z.ZodNullable<z.ZodString>>>>;
-    /**
-     * Whether to include default fonts
-     * @default true
-     */
-    withDefaultFonts: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    /** Whether to expand all tags by default */
-    defaultOpenAllTags: z.ZodOptional<z.ZodBoolean>;
-    /**
-     * Function to sort tags
-     * @default 'alpha' for alphabetical sorting
-     */
-    tagsSorter: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"alpha">, z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodNumber>]>>;
-    /**
-     * Function to sort operations
-     * @default 'alpha' for alphabetical sorting
-     */
-    operationsSorter: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"alpha">, z.ZodLiteral<"method">, z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodNumber>]>>;
-}>, "strip", z.ZodTypeAny, {
-    hideClientButton: boolean;
-    showSidebar: boolean;
-    theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
-    layout: "modern" | "classic";
-    isEditable: boolean;
-    hideModels: boolean;
-    hideDownloadButton: boolean;
-    hideTestRequestButton: boolean;
-    hideSearch: boolean;
-    hideDarkModeToggle: boolean;
-    withDefaultFonts: boolean;
-    url?: string | undefined;
-    content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-    title?: string | undefined;
-    slug?: string | undefined;
-    spec?: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    } | undefined;
-    authentication?: any;
-    baseServerURL?: string | undefined;
-    proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
-    servers?: any[] | undefined;
-    _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
-    proxy?: string | 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" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
-        clientKey: string;
-    } | undefined;
-    customCss?: string | undefined;
-    onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    pathRouting?: {
-        basePath: string;
-    } | undefined;
-    generateHeadingSlug?: ((args_0: {
-        slug?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateModelSlug?: ((args_0: {
-        name?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateTagSlug?: ((args_0: {
-        name?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateOperationSlug?: ((args_0: {
-        path: string;
-        method: string;
-        operationId?: string | undefined;
-        summary?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateWebhookSlug?: ((args_0: {
-        name: string;
-        method?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    onLoaded?: ((...args: unknown[]) => void) | undefined;
-    redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
-    defaultOpenAllTags?: boolean | undefined;
-    tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-    operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-}, {
-    url?: string | undefined;
-    content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-    title?: string | undefined;
-    slug?: string | undefined;
-    spec?: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    } | undefined;
-    authentication?: any;
-    baseServerURL?: string | undefined;
-    hideClientButton?: unknown;
-    proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
-    servers?: any[] | undefined;
-    showSidebar?: unknown;
-    theme?: unknown;
-    _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
-    layout?: unknown;
-    proxy?: string | undefined;
-    isEditable?: unknown;
-    hideModels?: unknown;
-    hideDownloadButton?: unknown;
-    hideTestRequestButton?: unknown;
-    hideSearch?: unknown;
-    darkMode?: boolean | undefined;
-    forceDarkModeState?: "dark" | "light" | undefined;
-    hideDarkModeToggle?: unknown;
-    metaData?: any;
-    favicon?: string | undefined;
-    hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
-    defaultHttpClient?: {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
-        clientKey: string;
-    } | undefined;
-    customCss?: string | undefined;
-    onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    pathRouting?: {
-        basePath: string;
-    } | undefined;
-    generateHeadingSlug?: ((args_0: {
-        slug: string;
-    }, ...args: unknown[]) => string) | undefined;
-    generateModelSlug?: ((args_0: {
-        name: string;
-    }, ...args: unknown[]) => string) | undefined;
-    generateTagSlug?: ((args_0: {
-        name: string;
-    }, ...args: unknown[]) => string) | undefined;
-    generateOperationSlug?: ((args_0: {
-        path: string;
-        method: string;
-        operationId?: string | undefined;
-        summary?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateWebhookSlug?: ((args_0: {
-        name: string;
-        method?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    onLoaded?: ((...args: unknown[]) => void) | undefined;
-    redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
-    withDefaultFonts?: unknown;
-    defaultOpenAllTags?: boolean | undefined;
-    tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-    operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-}>, {
-    hideClientButton: boolean;
-    showSidebar: boolean;
-    theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
-    layout: "modern" | "classic";
-    isEditable: boolean;
-    hideModels: boolean;
-    hideDownloadButton: boolean;
-    hideTestRequestButton: boolean;
-    hideSearch: boolean;
-    hideDarkModeToggle: boolean;
-    withDefaultFonts: boolean;
-    url?: string | undefined;
-    content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-    title?: string | undefined;
-    slug?: string | undefined;
-    spec?: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    } | undefined;
-    authentication?: any;
-    baseServerURL?: string | undefined;
-    proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
-    servers?: any[] | undefined;
-    _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
-    proxy?: string | 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" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
-        clientKey: string;
-    } | undefined;
-    customCss?: string | undefined;
-    onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    pathRouting?: {
-        basePath: string;
-    } | undefined;
-    generateHeadingSlug?: ((args_0: {
-        slug?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateModelSlug?: ((args_0: {
-        name?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateTagSlug?: ((args_0: {
-        name?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateOperationSlug?: ((args_0: {
-        path: string;
-        method: string;
-        operationId?: string | undefined;
-        summary?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateWebhookSlug?: ((args_0: {
-        name: string;
-        method?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    onLoaded?: ((...args: unknown[]) => void) | undefined;
-    redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
-    defaultOpenAllTags?: boolean | undefined;
-    tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-    operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-}, {
-    url?: string | undefined;
-    content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-    title?: string | undefined;
-    slug?: string | undefined;
-    spec?: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    } | undefined;
-    authentication?: any;
-    baseServerURL?: string | undefined;
-    hideClientButton?: unknown;
-    proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
-    servers?: any[] | undefined;
-    showSidebar?: unknown;
-    theme?: unknown;
-    _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
-    layout?: unknown;
-    proxy?: string | undefined;
-    isEditable?: unknown;
-    hideModels?: unknown;
-    hideDownloadButton?: unknown;
-    hideTestRequestButton?: unknown;
-    hideSearch?: unknown;
-    darkMode?: boolean | undefined;
-    forceDarkModeState?: "dark" | "light" | undefined;
-    hideDarkModeToggle?: unknown;
-    metaData?: any;
-    favicon?: string | undefined;
-    hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
-    defaultHttpClient?: {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
-        clientKey: string;
-    } | undefined;
-    customCss?: string | undefined;
-    onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    pathRouting?: {
-        basePath: string;
-    } | undefined;
-    generateHeadingSlug?: ((args_0: {
-        slug: string;
-    }, ...args: unknown[]) => string) | undefined;
-    generateModelSlug?: ((args_0: {
-        name: string;
-    }, ...args: unknown[]) => string) | undefined;
-    generateTagSlug?: ((args_0: {
-        name: string;
-    }, ...args: unknown[]) => string) | undefined;
-    generateOperationSlug?: ((args_0: {
-        path: string;
-        method: string;
-        operationId?: string | undefined;
-        summary?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    generateWebhookSlug?: ((args_0: {
-        name: string;
-        method?: string | undefined;
-    }, ...args: unknown[]) => string) | undefined;
-    onLoaded?: ((...args: unknown[]) => void) | undefined;
-    redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
-    withDefaultFonts?: unknown;
-    defaultOpenAllTags?: boolean | undefined;
-    tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-    operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
-}>;
-/** Configuration after parsing, this is the main type */
-export type ApiReferenceConfiguration = Omit<z.infer<typeof apiReferenceConfigurationSchema>, 'proxy' | 'spec'>;
-/** Props for the ApiReference components, coming from user input */
-export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
-    /**
-     * URL to an OpenAPI/Swagger document
-     **/
-    url: z.ZodOptional<z.ZodString>;
-    /**
-     * Directly embed the OpenAPI document.
-     * Can be a string, object, function returning an object, or null.
-     *
-     * @remarks It’s recommended to pass a URL instead of content.
-     **/
-    content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
-    /**
-     * The title of the OpenAPI document.
-     *
-     * @example 'Scalar Galaxy'
-     */
-    title: z.ZodOptional<z.ZodString>;
-    /**
-     * The slug of the OpenAPI document used in the URL.
-     *
-     * If none is passed, the title will be used.
-     *
-     * If no title is used, it’ll just use the index.
-     *
-     * @example 'scalar-galaxy'
-     */
-    slug: z.ZodOptional<z.ZodString>;
-    /**
-     * The OpenAPI/Swagger document to render
-     *
-     * @deprecated Use `url` and `content` on the top level instead.
-     **/
-    spec: z.ZodOptional<z.ZodObject<{
-        /**
-         * URL to an OpenAPI/Swagger document
-         *
-         * @deprecated Please move `url` to the top level and remove the `spec` prefix.
-         *
-         * @example
-         * ```ts
-         * const oldConfiguration = {
-         *   spec: {
-         *     url: 'https://example.com/openapi.json',
-         *   },
-         * }
-         *
-         * const newConfiguration = {
-         *   url: 'https://example.com/openapi.json',
-         * }
-         * ```
-         **/
-        url: z.ZodOptional<z.ZodString>;
-        /**
-         * Directly embed the OpenAPI document.
-         * Can be a string, object, function returning an object, or null.
-         *
-         * @remarks It's recommended to pass a URL instead of content.
-         *
-         * @deprecated Please move `content` to the top level and remove the `spec` prefix.
-         *
-         * @example
-         * ```ts
-         * const oldConfiguration = {
-         *   spec: {
-         *     content: '…',
-         *   },
-         * }
-         *
-         * const newConfiguration = {
-         *   content: '…',
-         * }
-         * ```
-         **/
-        content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
-        /**
-         * The title of the OpenAPI document.
-         *
-         * @example 'Scalar Galaxy'
-         *
-         * @deprecated Please move `title` to the top level and remove the `spec` prefix.
-         */
-        title: z.ZodOptional<z.ZodString>;
-        /**
-         * The slug of the OpenAPI document used in the URL.
-         *
-         * If none is passed, the title will be used.
-         *
-         * If no title is used, it’ll just use the index.
-         *
-         * @example 'scalar-galaxy'
-         *
-         * @deprecated Please move `slug` to the top level and remove the `spec` prefix.
-         */
-        slug: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }, {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }>>;
-    /** Prefill authentication */
-    authentication: z.ZodOptional<z.ZodAny>;
-    /** Base URL for the API server */
-    baseServerURL: z.ZodOptional<z.ZodString>;
-    /**
-     * Whether to hide the client button
-     * @default false
-     */
-    hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    /** URL to a request proxy for the API client */
-    proxyUrl: z.ZodOptional<z.ZodString>;
-    /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
-    searchHotKey: z.ZodOptional<z.ZodEnum<["a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"]>>;
-    /** List of OpenAPI server objects */
-    servers: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
-    /**
-     * Whether to show the sidebar
-     * @default true
-     */
-    showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
-    /** A string to use one of the color presets */
-    theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["alternate", "default", "moon", "purple", "solarized", "bluePlanet", "deepSpace", "saturn", "kepler", "elysiajs", "fastify", "mars", "none"]>>>>;
-    /** Integration type identifier */
-    _integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<["adonisjs", "docusaurus", "dotnet", "elysiajs", "express", "fastapi", "fastify", "go", "hono", "html", "laravel", "litestar", "nestjs", "nextjs", "nitro", "nuxt", "platformatic", "react", "rust", "vue"]>>>;
-}, {
-    /**
-     * The layout to use for the references
-     * @default 'modern'
-     */
-    layout: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["modern", "classic"]>>>>;
-    /**
-     * URL to a request proxy for the API client
-     * @deprecated Use proxyUrl instead
-     */
-    proxy: z.ZodOptional<z.ZodString>;
-    /**
-     * Whether the spec input should show
+     * Controls whether the references show a loading state in the intro
      * @default false
      */
-    isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
+    isLoading: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
     /**
      * Whether to show models in the sidebar, search, and content.
      * @default false
@@ -1071,6 +461,8 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     onSpecUpdate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
     /** onServerChange is fired on selected server change */
     onServerChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
+    /** onDocumentSelect is fired when the config is selected */
+    onDocumentSelect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
     /**
      * Route using paths instead of hashes, your server MUST support this
      * @example '/standalone-api-reference/:custom(.*)?'
@@ -1202,98 +594,19 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
      * @default 'alpha' for alphabetical sorting
      */
     operationsSorter: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"alpha">, z.ZodLiteral<"method">, z.ZodFunction<z.ZodTuple<[z.ZodAny, z.ZodAny], z.ZodUnknown>, z.ZodNumber>]>>;
-}>, {
-    sources: z.ZodArray<z.ZodObject<{
-        /**
-         * URL to an OpenAPI/Swagger document
-         *
-         * @deprecated Please move `url` to the top level and remove the `spec` prefix.
-         *
-         * @example
-         * ```ts
-         * const oldConfiguration = {
-         *   spec: {
-         *     url: 'https://example.com/openapi.json',
-         *   },
-         * }
-         *
-         * const newConfiguration = {
-         *   url: 'https://example.com/openapi.json',
-         * }
-         * ```
-         **/
-        url: z.ZodOptional<z.ZodString>;
-        /**
-         * Directly embed the OpenAPI document.
-         * Can be a string, object, function returning an object, or null.
-         *
-         * @remarks It's recommended to pass a URL instead of content.
-         *
-         * @deprecated Please move `content` to the top level and remove the `spec` prefix.
-         *
-         * @example
-         * ```ts
-         * const oldConfiguration = {
-         *   spec: {
-         *     content: '…',
-         *   },
-         * }
-         *
-         * const newConfiguration = {
-         *   content: '…',
-         * }
-         * ```
-         **/
-        content: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodNull]>>;
-        /**
-         * The title of the OpenAPI document.
-         *
-         * @example 'Scalar Galaxy'
-         *
-         * @deprecated Please move `title` to the top level and remove the `spec` prefix.
-         */
-        title: z.ZodOptional<z.ZodString>;
-        /**
-         * The slug of the OpenAPI document used in the URL.
-         *
-         * If none is passed, the title will be used.
-         *
-         * If no title is used, it’ll just use the index.
-         *
-         * @example 'scalar-galaxy'
-         *
-         * @deprecated Please move `slug` to the top level and remove the `spec` prefix.
-         */
-        slug: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }, {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }>, "many">;
 }>, "strip", z.ZodTypeAny, {
     hideClientButton: boolean;
     showSidebar: boolean;
     theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
     layout: "modern" | "classic";
     isEditable: boolean;
+    isLoading: boolean;
     hideModels: boolean;
     hideDownloadButton: boolean;
     hideTestRequestButton: boolean;
     hideSearch: boolean;
     hideDarkModeToggle: boolean;
     withDefaultFonts: boolean;
-    sources: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }[];
     url?: string | undefined;
     content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
     title?: string | undefined;
@@ -1323,6 +636,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     customCss?: string | undefined;
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
+    onDocumentSelect?: ((...args: unknown[]) => void) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -1351,12 +665,6 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
     operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
 }, {
-    sources: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }[];
     url?: string | undefined;
     content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
     title?: string | undefined;
@@ -1379,6 +687,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     layout?: unknown;
     proxy?: string | undefined;
     isEditable?: unknown;
+    isLoading?: unknown;
     hideModels?: unknown;
     hideDownloadButton?: unknown;
     hideTestRequestButton?: unknown;
@@ -1396,6 +705,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     customCss?: string | undefined;
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
+    onDocumentSelect?: ((...args: unknown[]) => void) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -1430,18 +740,13 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
     layout: "modern" | "classic";
     isEditable: boolean;
+    isLoading: boolean;
     hideModels: boolean;
     hideDownloadButton: boolean;
     hideTestRequestButton: boolean;
     hideSearch: boolean;
     hideDarkModeToggle: boolean;
     withDefaultFonts: boolean;
-    sources: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }[];
     url?: string | undefined;
     content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
     title?: string | undefined;
@@ -1471,6 +776,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     customCss?: string | undefined;
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
+    onDocumentSelect?: ((...args: unknown[]) => void) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -1499,12 +805,6 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
     operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
 }, {
-    sources: {
-        url?: string | undefined;
-        content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
-        title?: string | undefined;
-        slug?: string | undefined;
-    }[];
     url?: string | undefined;
     content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
     title?: string | undefined;
@@ -1527,6 +827,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     layout?: unknown;
     proxy?: string | undefined;
     isEditable?: unknown;
+    isLoading?: unknown;
     hideModels?: unknown;
     hideDownloadButton?: unknown;
     hideTestRequestButton?: unknown;
@@ -1544,6 +845,7 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     customCss?: string | undefined;
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
+    onDocumentSelect?: ((...args: unknown[]) => void) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -1573,9 +875,22 @@ export declare const apiReferenceConfigurationWithSourcesSchema: z.ZodEffects<z.
     tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
     operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
 }>;
-export type ApiReferenceConfigurationWithSources = Omit<z.infer<typeof apiReferenceConfigurationWithSourcesSchema>, 'proxy' | 'spec'>;
+/** Configuration after parsing, this is the main type */
+export type ApiReferenceConfiguration = Omit<z.infer<typeof apiReferenceConfigurationSchema>, 'proxy' | 'spec'>;
+/** Api Config which includes the default config */
+type ApiReferenceConfigurationWithDefault = ApiReferenceConfiguration & {
+    /** 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 & {
+        default?: boolean;
+    })[];
+};
 /** Configuration for multiple Api References */
-export type MultiReferenceConfiguration = Partial<ApiReferenceConfiguration> | Partial<ApiReferenceConfiguration>[] | Partial<ApiReferenceConfigurationWithSources>;
+export type AnyApiReferenceConfiguration = Partial<ApiReferenceConfiguration> | Partial<ApiReferenceConfigurationWithSources> | Partial<ApiReferenceConfigurationWithDefault>[];
 /** Typeguard to check to narrow the configs to the one with sources */
-export declare const isConfigurationWithSources: (config: MultiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithSources>;
+export declare const isConfigurationWithSources: (config: AnyApiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithSources>;
+export {};
 //# sourceMappingURL=api-reference-configuration.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA8EvB,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB;IAClC;;;;;;;;;;;;;;;;;QAiBI;;IAEJ;;;;;;;;;;;;;;;;;;;;QAoBI;;IAEJ;;;;;;OAMG;;IAEH;;;;;;;;;;OAUG;;;;;;;;;;;;EAEH,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAQvE,uCAAuC;AACvC,eAAO,MAAM,4BAA4B;IACvC;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAElC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AA2QjF,0CAA0C;AAC1C,eAAO,MAAM,+BAA+B;IAvU1C;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;IAYhC;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD;;;;;OAKG;;QAzJL,sCAAsC;;;;;;;IA2JpC;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH,wDAAwD;;IAExD;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyEwG,CAAA;AAE/G,yDAAyD;AACzD,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,EAE/C,OAAO,GAAG,MAAM,CACjB,CAAA;AAED,oEAAoE;AACpE,eAAO,MAAM,0CAA0C;IAjVrD;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;IAYhC;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD;;;;;OAKG;;QAzJL,sCAAsC;;;;;;;IA2JpC;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH,wDAAwD;;IAExD;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;QAtUL;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+VwE,CAAA;AAC7E,MAAM,MAAM,oCAAoC,GAAG,IAAI,CACrD,CAAC,CAAC,KAAK,CAAC,OAAO,0CAA0C,CAAC,EAE1D,OAAO,GAAG,MAAM,CACjB,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,2BAA2B,GACnC,OAAO,CAAC,yBAAyB,CAAC,GAClC,OAAO,CAAC,yBAAyB,CAAC,EAAE,GACpC,OAAO,CAAC,oCAAoC,CAAC,CAAA;AAEjD,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,WAC7B,2BAA2B,KAClC,MAAM,IAAI,OAAO,CAAC,oCAAoC,CAC0C,CAAA"}
+{"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA8EvB,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB;IAClC;;;;;;;;;;;;;;;;;QAiBI;;IAEJ;;;;;;;;;;;;;;;;;;;;QAoBI;;IAEJ;;;;;;OAMG;;IAEH;;;;;;;;;;OAUG;;;;;;;;;;;;EAEH,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAQvE,uCAAuC;AACvC,eAAO,MAAM,4BAA4B;IACvC;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAElC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAuQjF,0CAA0C;AAC1C,eAAO,MAAM,+BAA+B;IAnU1C;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;;IAYhC;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD,4DAA4D;;IAE5D;;;;;OAKG;;QAhKL,sCAAsC;;;;;;;IAkKpC;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH,wDAAwD;;IAExD;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA8DwG,CAAA;AAE/G,yDAAyD;AACzD,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,EAE/C,OAAO,GAAG,MAAM,CACjB,CAAA;AAED,mDAAmD;AACnD,KAAK,oCAAoC,GAAG,yBAAyB,GAAG;IACtE,oDAAoD;IACpD,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,qDAAqD;AACrD,MAAM,MAAM,oCAAoC,GAAG,IAAI,CAAC,oCAAoC,EAAE,SAAS,CAAC,GAAG;IACzG,OAAO,EAAE,CAAC,iBAAiB,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,EAAE,CAAA;CACvD,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,OAAO,CAAC,yBAAyB,CAAC,GAClC,OAAO,CAAC,oCAAoC,CAAC,GAC7C,OAAO,CAAC,oCAAoC,CAAC,EAAE,CAAA;AAEnD,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,WAC7B,4BAA4B,KACnC,MAAM,IAAI,OAAO,CAAC,oCAAoC,CAC0C,CAAA"}

package/dist/api-reference/api-reference-configuration.js

@@ -202,7 +202,7 @@ const apiClientConfigurationSchema = z.object({
 });
 const OLD_PROXY_URL = 'https://api.scalar.com/request-proxy';
 const NEW_PROXY_URL = 'https://proxy.scalar.com';
-/** Configuration for the Api Reference without the transform since it cannot be merged */
+/** Configuration for the Api Client without the transform since it cannot be merged */
 const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.object({
     /**
      * The layout to use for the references
@@ -219,6 +219,11 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      * @default false
      */
     isEditable: z.boolean().optional().default(false).catch(false),
+    /**
+     * Controls whether the references show a loading state in the intro
+     * @default false
+     */
+    isLoading: z.boolean().optional().default(false).catch(false),
     /**
      * Whether to show models in the sidebar, search, and content.
      * @default false
@@ -279,6 +284,8 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
     onSpecUpdate: z.function().args(z.string()).returns(z.void()).optional(),
     /** onServerChange is fired on selected server change */
     onServerChange: z.function().args(z.string()).returns(z.void()).optional(),
+    /** onDocumentSelect is fired when the config is selected */
+    onDocumentSelect: z.function().returns(z.void()).optional(),
     /**
      * Route using paths instead of hashes, your server MUST support this
      * @example '/standalone-api-reference/:custom(.*)?'
@@ -392,10 +399,6 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
         .union([z.literal('alpha'), z.literal('method'), z.function().args(z.any(), z.any()).returns(z.number())])
         .optional(),
 }));
-/** Configuration for the Api Reference with sources before transforming */
-const _apiReferenceConfigurationWithSourcesSchema = _apiReferenceConfigurationSchema.merge(z.object({
-    sources: z.array(specConfigurationSchema),
-}));
 /** Migrate the configuration through a transform */
 const migrateConfiguration = (_configuration) => {
     const configuration = { ..._configuration };
@@ -432,9 +435,7 @@ const migrateConfiguration = (_configuration) => {
 };
 /** Configuration for the Api Reference */
 const apiReferenceConfigurationSchema = _apiReferenceConfigurationSchema.transform(migrateConfiguration);
-/** Props for the ApiReference components, coming from user input */
-const apiReferenceConfigurationWithSourcesSchema = _apiReferenceConfigurationWithSourcesSchema.transform(migrateConfiguration);
 /** Typeguard to check to narrow the configs to the one with sources */
 const isConfigurationWithSources = (config) => Boolean(!Array.isArray(config) && config && 'sources' in config && Array.isArray(config.sources));
 
-export { apiClientConfigurationSchema, apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourcesSchema, isConfigurationWithSources, specConfigurationSchema };
+export { apiClientConfigurationSchema, apiReferenceConfigurationSchema, isConfigurationWithSources, specConfigurationSchema };

package/dist/api-reference/helpers/migrate-theme-variables.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migrate-theme-variables.d.ts","sourceRoot":"","sources":["../../../src/api-reference/helpers/migrate-theme-variables.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,eAAO,MAAM,iBAAiB,6FAGpB,CAAA;AAEV,eAAO,MAAM,eAAe,+BAA8C,CAAA;AAE1E;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D"}
+{"version":3,"file":"migrate-theme-variables.d.ts","sourceRoot":"","sources":["../../../src/api-reference/helpers/migrate-theme-variables.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,eAAO,MAAM,iBAAiB,6FAGpB,CAAA;AAEV,eAAO,MAAM,eAAe,+BAA8C,CAAA;AAE1E;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAY5D"}

package/dist/api-reference/helpers/migrate-theme-variables.js

@@ -11,8 +11,9 @@ const LEGACY_PREFIXES = PREFIX_MIGRATIONS.map(([legacy]) => legacy);
  */
 function migrateThemeVariables(styles) {
     const hasLegacyPrefixes = LEGACY_PREFIXES.some((p) => styles.includes(p));
-    if (!hasLegacyPrefixes)
+    if (!hasLegacyPrefixes) {
         return styles;
+    }
     console.warn(`DEPRECATION WARNING: It looks like you're using legacy CSS variables in your custom CSS string. Please migrate them to use the updated prefixes. See https://github.com/scalar/scalar/blob/main/documentation/themes.md#theme-prefix-changes`);
     // Replaces each old variable in the prefix migrations
     return PREFIX_MIGRATIONS.reduce((s, [o, n]) => s.replaceAll(o, n), styles);

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

@@ -1,4 +1,4 @@
-export { type ApiClientConfiguration, type ApiReferenceConfiguration, type ApiReferenceConfigurationWithSources, type MultiReferenceConfiguration, type SpecConfiguration, apiClientConfigurationSchema, apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourcesSchema, specConfigurationSchema, isConfigurationWithSources, } from './api-reference-configuration.ts';
+export { type ApiClientConfiguration, type ApiReferenceConfiguration, type ApiReferenceConfigurationWithSources, type AnyApiReferenceConfiguration, type SpecConfiguration, apiClientConfigurationSchema, apiReferenceConfigurationSchema, specConfigurationSchema, isConfigurationWithSources, } from './api-reference-configuration.ts';
 export { type HtmlRenderingConfiguration, htmlRenderingConfigurationSchema, } from './html-rendering-configuration.ts';
 export { migrateThemeVariables } from './helpers/migrate-theme-variables.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/api-reference/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,EACzC,KAAK,2BAA2B,EAChC,KAAK,iBAAiB,EACtB,4BAA4B,EAC5B,+BAA+B,EAC/B,0CAA0C,EAC1C,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,kCAAkC,CAAA;AAEzC,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,EACzC,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,4BAA4B,EAC5B,+BAA+B,EAC/B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,kCAAkC,CAAA;AAEzC,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAA"}

package/dist/api-reference/index.js

@@ -1,3 +1,3 @@
-export { apiClientConfigurationSchema, apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourcesSchema, isConfigurationWithSources, specConfigurationSchema } from './api-reference-configuration.js';
+export { apiClientConfigurationSchema, apiReferenceConfigurationSchema, isConfigurationWithSources, specConfigurationSchema } from './api-reference-configuration.js';
 export { htmlRenderingConfigurationSchema } from './html-rendering-configuration.js';
 export { migrateThemeVariables } from './helpers/migrate-theme-variables.js';

package/package.json

@@ -16,7 +16,7 @@
     "scalar",
     "references"
   ],
-  "version": "0.1.1",
+  "version": "0.1.3",
   "engines": {
     "node": ">=18"
   },