@scalar/types 0.1.4 → 0.1.6

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @scalar/types
 
+## 0.1.6
+
+### Patch Changes
+
+- 3783345: feat: add some callbacks to sidebar items
+
+## 0.1.5
+
+### Patch Changes
+
+- e09dab3: feat: multiple configurations with multiple sources
+- 04e27a1: feat: support x-default-scopes
+- Updated dependencies [e62e677]
+- Updated dependencies [82f16a5]
+  - @scalar/openapi-types@0.2.0
+
 ## 0.1.4
 
 ### Patch Changes

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

@@ -248,6 +248,508 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
     _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
 }>;
 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<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
+     * @default false
+     */
+    isEditable: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
+    /**
+     * Controls whether the references show a loading state in the intro
+     * @default false
+     */
+    isLoading: 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<"http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart", z.ZodTypeDef, "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart">;
+        clientKey: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        targetKey: "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
+        clientKey: string;
+    }, {
+        targetKey: "http" | "c" | "clojure" | "csharp" | "go" | "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>>;
+    /** onDocumentSelect is fired when the config is selected */
+    onDocumentSelect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+    /** Callback fired when the reference is fully loaded */
+    onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+    /**
+     * onShowMore is fired when the user clicks the "Show more" button on the references
+     * @param tagId - The ID of the tag that was clicked
+     */
+    onShowMore: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+    /**
+     * onSidebarClick is fired when the user clicks on a sidebar item
+     * @param href - The href of the sidebar item that was clicked
+     */
+    onSidebarClick: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<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>>;
+    /**
+     * 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;
+    isLoading: 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?: "o" | "n" | "c" | "r" | "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: "http" | "c" | "clojure" | "csharp" | "go" | "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;
+    onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onLoaded?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onShowMore?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
+    onSidebarClick?: ((args_0: string, ...args: unknown[]) => void | Promise<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;
+    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?: "o" | "n" | "c" | "r" | "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;
+    isLoading?: 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: "http" | "c" | "clojure" | "csharp" | "go" | "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;
+    onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onLoaded?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onShowMore?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
+    onSidebarClick?: ((args_0: string, ...args: unknown[]) => void | Promise<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;
+    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 for the Api Reference */
 export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<{
     /**
@@ -464,6 +966,18 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     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.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+    /** Callback fired when the reference is fully loaded */
+    onLoaded: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+    /**
+     * onShowMore is fired when the user clicks the "Show more" button on the references
+     * @param tagId - The ID of the tag that was clicked
+     */
+    onShowMore: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
+    /**
+     * onSidebarClick is fired when the user clicks on a sidebar item
+     * @param href - The href of the sidebar item that was clicked
+     */
+    onSidebarClick: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
     /**
      * Route using paths instead of hashes, your server MUST support this
      * @example '/standalone-api-reference/:custom(.*)?'
@@ -555,8 +1069,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
         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
@@ -638,6 +1150,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onLoaded?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onShowMore?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
+    onSidebarClick?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -660,7 +1175,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
         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;
@@ -707,6 +1221,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onLoaded?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onShowMore?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
+    onSidebarClick?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -729,7 +1246,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
         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;
@@ -778,6 +1294,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onLoaded?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onShowMore?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
+    onSidebarClick?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -800,7 +1319,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
         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;
@@ -847,6 +1365,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onLoaded?: ((...args: unknown[]) => void | Promise<void>) | undefined;
+    onShowMore?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
+    onSidebarClick?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -869,7 +1390,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
         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;
@@ -877,7 +1397,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     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'> & {
+export type ApiReferenceConfiguration = Omit<z.infer<typeof _apiReferenceConfigurationSchema>, 'proxy' | 'spec'> & {
     authentication?: AuthenticationConfiguration;
 };
 /** Api Config which includes the default config */
@@ -892,7 +1412,7 @@ export type ApiReferenceConfigurationWithSources = Omit<ApiReferenceConfiguratio
     })[];
 };
 /** Configuration for multiple Api References */
-export type AnyApiReferenceConfiguration = Partial<ApiReferenceConfiguration> | Partial<ApiReferenceConfigurationWithSources> | Partial<ApiReferenceConfigurationWithDefault>[];
+export type AnyApiReferenceConfiguration = Partial<ApiReferenceConfiguration> | Partial<ApiReferenceConfigurationWithSources> | Partial<ApiReferenceConfigurationWithDefault>[] | Partial<ApiReferenceConfigurationWithSources>[];
 /** Typeguard to check to narrow the configs to the one with sources */
 export declare const isConfigurationWithSources: (config: AnyApiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithSources>;
 export {};

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;AAEvB,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,iDAAiD,CAAA;AA6ElG,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,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,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"}
+{"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;AAEvB,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,iDAAiD,CAAA;AA6ElG,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;AAKjF,uFAAuF;AACvF,QAAA,MAAM,gCAAgC;IAjEpC;;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,wDAAwD;;IAExD;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;;OAKG;;QA5KL,sCAAsC;;;;;;;IA8KpC;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKN,CAAA;AAwDD,0CAA0C;AAC1C,eAAO,MAAM,+BAA+B;IA7U1C;;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,wDAAwD;;IAExD;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;;OAKG;;QA5KL,sCAAsC;;;;;;;IA8KpC;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;IAMH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH;;;;;;;;;;;;;;;;;;;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,gCAAgC,CAAC,EAEhD,OAAO,GAAG,MAAM,CACjB,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,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,GAC/C,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

@@ -286,6 +286,18 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
     onServerChange: z.function().args(z.string()).returns(z.void()).optional(),
     /** onDocumentSelect is fired when the config is selected */
     onDocumentSelect: z.function().returns(z.void().or(z.void().promise())).optional(),
+    /** Callback fired when the reference is fully loaded */
+    onLoaded: z.function().returns(z.void().or(z.void().promise())).optional(),
+    /**
+     * onShowMore is fired when the user clicks the "Show more" button on the references
+     * @param tagId - The ID of the tag that was clicked
+     */
+    onShowMore: z.function().args(z.string()).returns(z.void().or(z.void().promise())).optional(),
+    /**
+     * onSidebarClick is fired when the user clicks on a sidebar item
+     * @param href - The href of the sidebar item that was clicked
+     */
+    onSidebarClick: z.function().args(z.string()).returns(z.void().or(z.void().promise())).optional(),
     /**
      * Route using paths instead of hashes, your server MUST support this
      * @example '/standalone-api-reference/:custom(.*)?'
@@ -356,8 +368,6 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
     }))
         .returns(z.string())
         .optional(),
-    /** Callback fired when the reference is fully loaded */
-    onLoaded: z.function().returns(z.void()).optional(),
     /**
      * To handle redirects, pass a function that will recieve:
      * - The current path with hash if pathRouting is enabled

package/dist/entities/security-scheme.d.ts

@@ -110,6 +110,8 @@ export declare const securityOauthSchema: z.ZodObject<z.objectUtil.extendShape<z
     description: z.ZodOptional<z.ZodString>;
 }, {
     type: z.ZodLiteral<"oauth2">;
+    /** The default scopes for the oauth flow */
+    'x-default-scopes': z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     /** REQUIRED. An object containing configuration information for the flow types supported. */
     flows: z.ZodDefault<z.ZodObject<{
         implicit: z.ZodOptional<z.ZodObject<z.objectUtil.extendShape<{
@@ -437,11 +439,13 @@ export declare const securityOauthSchema: z.ZodObject<z.objectUtil.extendShape<z
         } | undefined;
     };
     description?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
 }, {
     type: "oauth2";
     description?: string | undefined;
     uid?: string | undefined;
     nameKey?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
     flows?: {
         password?: {
             type?: "password" | undefined;
@@ -554,6 +558,8 @@ export declare const oasSecuritySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUt
     description: z.ZodOptional<z.ZodString>;
 }, {
     type: z.ZodLiteral<"oauth2">;
+    /** The default scopes for the oauth flow */
+    'x-default-scopes': z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     /** REQUIRED. An object containing configuration information for the flow types supported. */
     flows: z.ZodDefault<z.ZodObject<{
         implicit: z.ZodOptional<z.ZodObject<z.objectUtil.extendShape<{
@@ -875,9 +881,11 @@ export declare const oasSecuritySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUt
         } | undefined;
     };
     description?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
 }, {
     type: "oauth2";
     description?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
     flows?: {
         password?: {
             type?: "password" | undefined;
@@ -944,7 +952,7 @@ export declare const oasSecuritySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUt
     openIdConnectUrl?: string | undefined;
 }>]>;
 /** Extended security schemes for workspace usage */
-export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+export declare const securitySchemeSchema: z.ZodEffects<z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
     description: z.ZodOptional<z.ZodString>;
 }, {
     type: z.ZodLiteral<"apiKey">;
@@ -1046,6 +1054,8 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
     description: z.ZodOptional<z.ZodString>;
 }, {
     type: z.ZodLiteral<"oauth2">;
+    /** The default scopes for the oauth flow */
+    'x-default-scopes': z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     /** REQUIRED. An object containing configuration information for the flow types supported. */
     flows: z.ZodDefault<z.ZodObject<{
         implicit: z.ZodOptional<z.ZodObject<z.objectUtil.extendShape<{
@@ -1373,11 +1383,13 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
         } | undefined;
     };
     description?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
 }, {
     type: "oauth2";
     description?: string | undefined;
     uid?: string | undefined;
     nameKey?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
     flows?: {
         password?: {
             type?: "password" | undefined;
@@ -1425,7 +1437,161 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
             'x-usePkce'?: "SHA-256" | "plain" | "no" | undefined;
         } | undefined;
     } | undefined;
-}>]>;
+}>]>, {
+    type: "apiKey";
+    value: string;
+    uid: string & z.BRAND<"securityScheme">;
+    nameKey: string;
+    name: string;
+    in: "cookie" | "query" | "header";
+    description?: string | undefined;
+} | {
+    type: "http";
+    uid: string & z.BRAND<"securityScheme">;
+    nameKey: string;
+    scheme: "basic" | "bearer";
+    bearerFormat: string;
+    username: string;
+    password: string;
+    token: string;
+    description?: string | undefined;
+} | {
+    type: "openIdConnect";
+    uid: string & z.BRAND<"securityScheme">;
+    nameKey: string;
+    openIdConnectUrl: string;
+    description?: string | undefined;
+} | {
+    type: "oauth2";
+    uid: string & z.BRAND<"securityScheme">;
+    nameKey: string;
+    flows: {
+        password?: {
+            type: "password";
+            username: string;
+            password: string;
+            token: string;
+            refreshUrl: string;
+            scopes: Record<string, string>;
+            selectedScopes: string[];
+            'x-scalar-client-id': string;
+            tokenUrl: string;
+            clientSecret: string;
+        } | undefined;
+        implicit?: {
+            type: "implicit";
+            token: string;
+            refreshUrl: string;
+            scopes: Record<string, string>;
+            selectedScopes: string[];
+            'x-scalar-client-id': string;
+            authorizationUrl: string;
+            'x-scalar-redirect-uri': string;
+        } | undefined;
+        clientCredentials?: {
+            type: "clientCredentials";
+            token: string;
+            refreshUrl: string;
+            scopes: Record<string, string>;
+            selectedScopes: string[];
+            'x-scalar-client-id': string;
+            tokenUrl: string;
+            clientSecret: string;
+        } | undefined;
+        authorizationCode?: {
+            type: "authorizationCode";
+            token: string;
+            refreshUrl: string;
+            scopes: Record<string, string>;
+            selectedScopes: string[];
+            'x-scalar-client-id': string;
+            authorizationUrl: string;
+            'x-scalar-redirect-uri': string;
+            tokenUrl: string;
+            clientSecret: string;
+            'x-usePkce': "SHA-256" | "plain" | "no";
+        } | undefined;
+    };
+    description?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
+}, {
+    type: "apiKey";
+    value?: string | undefined;
+    description?: string | undefined;
+    uid?: string | undefined;
+    nameKey?: string | undefined;
+    name?: string | undefined;
+    in?: unknown;
+} | {
+    type: "http";
+    description?: string | undefined;
+    uid?: string | undefined;
+    nameKey?: string | undefined;
+    scheme?: string | undefined;
+    bearerFormat?: string | undefined;
+    username?: string | undefined;
+    password?: string | undefined;
+    token?: string | undefined;
+} | {
+    type: "openIdConnect";
+    description?: string | undefined;
+    uid?: string | undefined;
+    nameKey?: string | undefined;
+    openIdConnectUrl?: string | undefined;
+} | {
+    type: "oauth2";
+    description?: string | undefined;
+    uid?: string | undefined;
+    nameKey?: string | undefined;
+    'x-default-scopes'?: string | string[] | undefined;
+    flows?: {
+        password?: {
+            type?: "password" | undefined;
+            username?: string | undefined;
+            password?: string | undefined;
+            token?: string | undefined;
+            refreshUrl?: string | undefined;
+            scopes?: unknown;
+            selectedScopes?: string[] | undefined;
+            'x-scalar-client-id'?: string | undefined;
+            tokenUrl?: string | undefined;
+            clientSecret?: string | undefined;
+        } | undefined;
+        implicit?: {
+            type?: "implicit" | undefined;
+            token?: string | undefined;
+            refreshUrl?: string | undefined;
+            scopes?: unknown;
+            selectedScopes?: string[] | undefined;
+            'x-scalar-client-id'?: string | undefined;
+            authorizationUrl?: string | undefined;
+            'x-scalar-redirect-uri'?: string | undefined;
+        } | undefined;
+        clientCredentials?: {
+            type?: "clientCredentials" | undefined;
+            token?: string | undefined;
+            refreshUrl?: string | undefined;
+            scopes?: unknown;
+            selectedScopes?: string[] | undefined;
+            'x-scalar-client-id'?: string | undefined;
+            tokenUrl?: string | undefined;
+            clientSecret?: string | undefined;
+        } | undefined;
+        authorizationCode?: {
+            type?: "authorizationCode" | undefined;
+            token?: string | undefined;
+            refreshUrl?: string | undefined;
+            scopes?: unknown;
+            selectedScopes?: string[] | undefined;
+            'x-scalar-client-id'?: string | undefined;
+            authorizationUrl?: string | undefined;
+            'x-scalar-redirect-uri'?: string | undefined;
+            tokenUrl?: string | undefined;
+            clientSecret?: string | undefined;
+            'x-usePkce'?: "SHA-256" | "plain" | "no" | undefined;
+        } | undefined;
+    } | undefined;
+}>;
 /**
  * Security Scheme Object
  *

package/dist/entities/security-scheme.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"security-scheme.d.ts","sourceRoot":"","sources":["../../src/entities/security-scheme.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAsBvB,eAAO,MAAM,sBAAsB,wCAAyC,CAAA;AAc5E,eAAO,MAAM,oBAAoB;;;;IAV/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;EAqBsC,CAAA;AAClH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAkCvE,eAAO,MAAM,kBAAkB;;;;IA3B7B;;;OAGG;;IAOH;;;;OAIG;;;;IA3CH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDgC,CAAA;AAC5G,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAanE,eAAO,MAAM,oBAAoB;;;;IAP/B;;;OAGG;;;;IAlEH,0EAA0E;;;;;;;;;;;;;;EAsEa,CAAA;AACzF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAsCvE,0CAA0C;AAC1C,eAAO,MAAM,WAAW,qCAAsC,CAAA;AAiD9D,eAAO,MAAM,mBAAmB;;;;IA5C9B,6FAA6F;;;YA1B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YAwCf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAlJT,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+JY,CAAA;AAExF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AACtE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAC7E,MAAM,MAAM,UAAU,GAAG,WAAW,CAClC,oBAAoB,CAAC,OAAO,CAAC,CAAC,mBAAmB,GAAG,mBAAmB,GAAG,UAAU,GAAG,UAAU,CAAC,CACnG,CAAA;AACD,iDAAiD;AACjD,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAC7E,mBAAmB,GACnB,mBAAmB,GACnB,UAAU,GACV,UAAU,CAAC,GACb,MAAM,CAAC,KAAK,MAAM,EAAE,EAAE,MAAM,CAAC,CAAA;AAK/B;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,wFAAmE,CAAA;AAE5G,qCAAqC;AACrC,eAAO,MAAM,uBAAuB;;;;IAnLlC,8EAA8E;;IAE9E,6FAA6F;;;;;;;;;;;;;;;;IAgB7F;;;OAGG;;IAOH;;;;OAIG;;;;;;;;;;;;;;;;IAwEH,6FAA6F;;;YA1B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YAwCf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAnFT;;;OAGG;;;;;;;;;;IAiIH,CAAA;AAEF,oDAAoD;AACpD,eAAO,MAAM,oBAAoB;;;;IA3L/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;IA6B1E;;;OAGG;;IAOH;;;;OAIG;;;;IA3CH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+D1E;;;OAGG;;;;IAlEH,0EAA0E;;;;;;;;;;;;;;;;;;IAmH1E,6FAA6F;;;YA1B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YAwCf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAlJT,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2M1E,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}
+{"version":3,"file":"security-scheme.d.ts","sourceRoot":"","sources":["../../src/entities/security-scheme.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAsBvB,eAAO,MAAM,sBAAsB,wCAAyC,CAAA;AAc5E,eAAO,MAAM,oBAAoB;;;;IAV/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;EAqBsC,CAAA;AAClH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAkCvE,eAAO,MAAM,kBAAkB;;;;IA3B7B;;;OAGG;;IAOH;;;;OAIG;;;;IA3CH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDgC,CAAA;AAC5G,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAanE,eAAO,MAAM,oBAAoB;;;;IAP/B;;;OAGG;;;;IAlEH,0EAA0E;;;;;;;;;;;;;;EAsEa,CAAA;AACzF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAsCvE,0CAA0C;AAC1C,eAAO,MAAM,WAAW,qCAAsC,CAAA;AAmD9D,eAAO,MAAM,mBAAmB;;;;IA9C9B,4CAA4C;;IAE5C,6FAA6F;;;YA5B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YA0Cf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IApJT,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiKY,CAAA;AAExF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AACtE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAC7E,MAAM,MAAM,UAAU,GAAG,WAAW,CAClC,oBAAoB,CAAC,OAAO,CAAC,CAAC,mBAAmB,GAAG,mBAAmB,GAAG,UAAU,GAAG,UAAU,CAAC,CACnG,CAAA;AACD,iDAAiD;AACjD,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAC7E,mBAAmB,GACnB,mBAAmB,GACnB,UAAU,GACV,UAAU,CAAC,GACb,MAAM,CAAC,KAAK,MAAM,EAAE,EAAE,MAAM,CAAC,CAAA;AAK/B;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,wFAAmE,CAAA;AAE5G,qCAAqC;AACrC,eAAO,MAAM,uBAAuB;;;;IArLlC,8EAA8E;;IAE9E,6FAA6F;;;;;;;;;;;;;;;;IAgB7F;;;OAGG;;IAOH;;;;OAIG;;;;;;;;;;;;;;;;IAwEH,4CAA4C;;IAE5C,6FAA6F;;;YA5B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YA0Cf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IArFT;;;OAGG;;;;;;;;;;IAmIH,CAAA;AAEF,oDAAoD;AACpD,eAAO,MAAM,oBAAoB;;;;IA7L/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;IA6B1E;;;OAGG;;IAOH;;;;OAIG;;;;IA3CH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+D1E;;;OAGG;;;;IAlEH,0EAA0E;;;;;;;;;;;;;;;;;;IAmH1E,4CAA4C;;IAE5C,6FAA6F;;;YA5B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YA0Cf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IApJT,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqNxE,CAAA;AAEJ;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}

package/dist/entities/security-scheme.js

@@ -104,6 +104,8 @@ const pkceOptions = ['SHA-256', 'plain', 'no'];
 /** Oauth2 security scheme */
 const oasSecuritySchemeOauth2 = commonProps.extend({
     type: z.literal('oauth2'),
+    /** The default scopes for the oauth flow */
+    'x-default-scopes': z.string().or(z.array(z.string())).optional(),
     /** REQUIRED. An object containing configuration information for the flow types supported. */
     flows: z
         .object({
@@ -169,11 +171,19 @@ const oasSecuritySchemeSchema = z.union([
     oasSecuritySchemeOpenId,
 ]);
 /** Extended security schemes for workspace usage */
-const securitySchemeSchema = z.union([
-    securityApiKeySchema,
-    securityHttpSchema,
-    securityOpenIdSchema,
-    securityOauthSchema,
-]);
+const securitySchemeSchema = z
+    .union([securityApiKeySchema, securityHttpSchema, securityOpenIdSchema, securityOauthSchema])
+    .transform((data) => {
+    // Set selected scopes from x-default-scopes
+    if (data.type === 'oauth2' && data['x-default-scopes']?.length) {
+        const keys = Object.keys(data.flows);
+        keys.forEach((key) => {
+            if (data.flows[key]?.selectedScopes && data['x-default-scopes']) {
+                data.flows[key].selectedScopes = [data['x-default-scopes']].flat();
+            }
+        });
+    }
+    return data;
+});
 
 export { oasSecurityRequirementSchema, oasSecuritySchemeSchema, pkceOptions, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeApiKeyIn, securitySchemeSchema };

package/package.json

@@ -16,7 +16,7 @@
     "scalar",
     "references"
   ],
-  "version": "0.1.4",
+  "version": "0.1.6",
   "engines": {
     "node": ">=18"
   },
@@ -63,7 +63,7 @@
     "nanoid": "^5.1.5",
     "type-fest": "^4.20.0",
     "zod": "^3.23.8",
-    "@scalar/openapi-types": "0.1.9"
+    "@scalar/openapi-types": "0.2.0"
   },
   "devDependencies": {
     "@types/har-format": "^1.2.15",