@scalar/types 0.3.0 → 0.3.1

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

@@ -1,527 +1,292 @@
 import { z } from "zod";
-import { ApiClientPluginSchema } from "../api-client/index.js";
-import { ApiReferencePluginSchema } from "./api-reference-plugin.js";
-const themeIdEnum = z.enum([
-  "alternate",
-  "default",
-  "moon",
-  "purple",
-  "solarized",
-  "bluePlanet",
-  "deepSpace",
-  "saturn",
-  "kepler",
-  "elysiajs",
-  "fastify",
-  "mars",
-  "laserwave",
-  "none"
-]);
-const operationTitleEnum = z.enum(["summary", "path"]);
-const searchHotKeyEnum = z.enum([
-  "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"
-]);
-const integrationEnum = z.enum([
-  "adonisjs",
-  "docusaurus",
-  "dotnet",
-  "elysiajs",
-  "express",
-  "fastapi",
-  "fastify",
-  "go",
-  "hono",
-  "html",
-  "laravel",
-  "litestar",
-  "nestjs",
-  "nextjs",
-  "nitro",
-  "nuxt",
-  "platformatic",
-  "react",
-  "rust",
-  "svelte",
-  "vue"
-]).nullable();
-const specConfigurationSchema = z.object({
-  /**
-   * 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.string().optional(),
+import { apiReferencePluginSchema } from "./api-reference-plugin.js";
+import { NEW_PROXY_URL, OLD_PROXY_URL, baseConfigurationSchema } from "./base-configuration.js";
+import { sourceConfigurationSchema } from "./source-configuration.js";
+const fetchLikeSchema = z.custom();
+const apiReferenceConfigurationSchema = baseConfigurationSchema.extend({
   /**
-   * 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.union([
-    z.string(),
-    z.null(),
-    z.record(z.string(), z.any()),
-    z.function({
-      input: [],
-      output: z.record(z.string(), z.any())
-    })
-  ]).optional(),
+   * The layout to use for the references
+   * @default 'modern'
+   */
+  layout: z.enum(["modern", "classic"]).optional().default("modern").catch("modern"),
   /**
-   * The title of the OpenAPI document.
-   *
-   * @example 'Scalar Galaxy'
-   *
-   * @deprecated Please move `title` to the top level and remove the `spec` prefix.
+   * URL to a request proxy for the API client
+   * @deprecated Use proxyUrl instead
    */
-  title: z.string().optional(),
+  proxy: z.string().optional(),
   /**
-   * The slug of the OpenAPI document used in the URL.
+   * Custom fetch function for custom logic
    *
-   * 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.
+   * Can be used to add custom headers, handle auth, etc.
    */
-  slug: z.string().optional()
-});
-const pathRoutingSchema = z.object({
-  /** Base path for the API reference */
-  basePath: z.string()
-});
-const apiClientConfigurationSchema = z.object({
+  fetch: fetchLikeSchema.optional(),
   /**
-   * URL to an OpenAPI/Swagger document
-   **/
-  url: z.string().optional(),
+   * Plugins for the API reference
+   */
+  plugins: z.array(apiReferencePluginSchema).optional(),
   /**
-   * 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.union([
-    z.string(),
-    z.null(),
-    z.record(z.string(), z.any()),
-    z.function({
-      input: [],
-      output: z.record(z.string(), z.any())
-    })
-  ]).optional(),
+   * Allows the user to inject an editor for the spec
+   * @default false
+   */
+  isEditable: z.boolean().optional().default(false).catch(false),
   /**
-   * The title of the OpenAPI document.
-   *
-   * @example 'Scalar Galaxy'
+   * Controls whether the references show a loading state in the intro
+   * @default false
    */
-  title: z.string().optional(),
+  isLoading: z.boolean().optional().default(false).catch(false),
   /**
-   * 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'
+   * Whether to show models in the sidebar, search, and content.
+   * @default false
+   */
+  hideModels: z.boolean().optional().default(false).catch(false),
+  /**
+   * Sets the file type of the document to download, set to `none` to hide the download button
+   * @default 'both'
+   */
+  documentDownloadType: z.enum(["yaml", "json", "both", "direct", "none"]).optional().default("both").catch("both"),
+  /**
+   * Whether to show the "Download OpenAPI Document" button
+   * @default false
+   * @deprecated Use `documentDownloadType: 'none'` instead
+   */
+  hideDownloadButton: z.boolean().optional(),
+  /**
+   * Whether to show the "Test Request" button
+   * @default false
+   */
+  hideTestRequestButton: z.boolean().optional().default(false).catch(false),
+  /**
+   * Whether to show the sidebar search bar
+   * @default false
    */
-  slug: z.string().optional(),
+  hideSearch: z.boolean().optional().default(false).catch(false),
   /**
-   * The OpenAPI/Swagger document to render
+   * Whether to show the operationId
    *
-   * @deprecated Use `url` and `content` on the top level instead.
-   **/
-  spec: specConfigurationSchema.optional(),
-  /** Prefill authentication */
-  authentication: z.any().optional(),
-  // Temp until we bring in the new auth
-  /** Base URL for the API server */
-  baseServerURL: z.string().optional(),
-  /**
-   * Whether to hide the client button
    * @default false
    */
-  hideClientButton: z.boolean().optional().default(false).catch(false),
-  /** URL to a request proxy for the API client */
-  proxyUrl: z.string().optional(),
-  /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
-  searchHotKey: searchHotKeyEnum.optional(),
-  /** List of OpenAPI server objects */
-  servers: z.array(z.any()).optional(),
-  // Using any for OpenAPIV3_1.ServerObject
+  showOperationId: z.boolean().optional().default(false).catch(false),
+  /** Whether dark mode is on or off initially (light mode) */
+  darkMode: z.boolean().optional(),
+  /** forceDarkModeState makes it always this state no matter what */
+  forceDarkModeState: z.enum(["dark", "light"]).optional(),
   /**
-   * Whether to show the sidebar
-   * @default true
+   * Whether to show the dark mode toggle
+   * @default false
+   */
+  hideDarkModeToggle: z.boolean().optional().default(false).catch(false),
+  /**
+   * If used, passed data will be added to the HTML header
+   * @see https://unhead.unjs.io/usage/composables/use-seo-meta
    */
-  showSidebar: z.boolean().optional().default(true).catch(true),
+  metaData: z.any().optional(),
+  // Using any for UseSeoMetaInput since it's an external type
   /**
-   * Sets the visibility of the developer tools
-   * @default 'localhost' to only show the toolbar on localhost or similar hosts
+   * Path to a favicon image
+   * @default undefined
+   * @example '/favicon.svg'
    */
-  showToolbar: z.enum(["always", "localhost", "never"]).optional().default("localhost").catch("localhost"),
+  favicon: z.string().optional(),
   /**
-   * Whether to use the operation summary or the operation path for the sidebar and search
-   * @default 'summary'
+   * List of httpsnippet clients to hide from the clients menu
+   * By default hides Unirest, pass `[]` to show all clients
    */
-  operationTitleSource: operationTitleEnum.optional().default("summary").catch("summary"),
-  /** A string to use one of the color presets */
-  theme: themeIdEnum.optional().default("default").catch("default"),
-  /** Integration type identifier */
-  _integration: integrationEnum.optional(),
-  /** onRequestSent is fired when a request is sent */
-  onRequestSent: z.function({
+  hiddenClients: z.union([z.record(z.string(), z.union([z.boolean(), z.array(z.string())])), z.array(z.string()), z.literal(true)]).optional(),
+  /** Determine the HTTP client that's selected by default */
+  defaultHttpClient: z.object({
+    targetKey: z.custom(),
+    clientKey: z.string()
+  }).optional(),
+  /** Custom CSS to be added to the page */
+  customCss: z.string().optional(),
+  /** onSpecUpdate is fired on spec/swagger content change */
+  onSpecUpdate: z.function({
     input: [z.string()],
     output: z.void()
   }).optional(),
-  /** Whether to persist auth to local storage */
-  persistAuth: z.boolean().optional().default(false).catch(false),
-  /** Plugins for the API client */
-  plugins: z.array(ApiClientPluginSchema).optional(),
-  /** Enables / disables telemetry*/
-  telemetry: z.boolean().optional().default(true)
-});
-const FetchLikeSchema = z.custom();
-const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(
-  z.object({
-    /**
-     * The layout to use for the references
-     * @default 'modern'
-     */
-    layout: z.enum(["modern", "classic"]).optional().default("modern").catch("modern"),
-    /**
-     * URL to a request proxy for the API client
-     * @deprecated Use proxyUrl instead
-     */
-    proxy: z.string().optional(),
-    /**
-     * Custom fetch function for custom logic
-     *
-     * Can be used to add custom headers, handle auth, etc.
-     */
-    fetch: FetchLikeSchema.optional(),
-    /**
-     * Plugins for the API reference
-     */
-    plugins: z.array(ApiReferencePluginSchema).optional(),
-    /**
-     * Allows the user to inject an editor for the spec
-     * @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
-     */
-    hideModels: z.boolean().optional().default(false).catch(false),
-    /**
-     * Sets the file type of the document to download, set to `none` to hide the download button
-     * @default 'both'
-     */
-    documentDownloadType: z.enum(["yaml", "json", "both", "direct", "none"]).optional().default("both").catch("both"),
-    /**
-     * Whether to show the "Download OpenAPI Document" button
-     * @default false
-     * @deprecated Use `documentDownloadType: 'none'` instead
-     */
-    hideDownloadButton: z.boolean().optional(),
-    /**
-     * Whether to show the "Test Request" button
-     * @default false
-     */
-    hideTestRequestButton: z.boolean().optional().default(false).catch(false),
-    /**
-     * Whether to show the sidebar search bar
-     * @default false
-     */
-    hideSearch: z.boolean().optional().default(false).catch(false),
-    /**
-     * Whether to show the operationId
-     *
-     * @default false
-     */
-    showOperationId: z.boolean().optional().default(false).catch(false),
-    /** Whether dark mode is on or off initially (light mode) */
-    darkMode: z.boolean().optional(),
-    /** forceDarkModeState makes it always this state no matter what */
-    forceDarkModeState: z.enum(["dark", "light"]).optional(),
-    /**
-     * Whether to show the dark mode toggle
-     * @default false
-     */
-    hideDarkModeToggle: z.boolean().optional().default(false).catch(false),
-    /**
-     * If used, passed data will be added to the HTML header
-     * @see https://unhead.unjs.io/usage/composables/use-seo-meta
-     */
-    metaData: z.any().optional(),
-    // Using any for UseSeoMetaInput since it's an external type
-    /**
-     * Path to a favicon image
-     * @default undefined
-     * @example '/favicon.svg'
-     */
-    favicon: z.string().optional(),
-    /**
-     * List of httpsnippet clients to hide from the clients menu
-     * By default hides Unirest, pass `[]` to show all clients
-     */
-    hiddenClients: z.union([z.record(z.string(), z.union([z.boolean(), z.array(z.string())])), z.array(z.string()), z.literal(true)]).optional(),
-    /** Determine the HTTP client that's selected by default */
-    defaultHttpClient: z.object({
-      targetKey: z.custom(),
-      clientKey: z.string()
-    }).optional(),
-    /** Custom CSS to be added to the page */
-    customCss: z.string().optional(),
-    /** onSpecUpdate is fired on spec/swagger content change */
-    onSpecUpdate: z.function({
-      input: [z.string()],
-      output: z.void()
-    }).optional(),
-    /** onServerChange is fired on selected server change */
-    onServerChange: z.function({
-      input: [z.string()],
-      output: z.void()
-    }).optional(),
-    /** onDocumentSelect is fired when the config is selected */
-    onDocumentSelect: z.function().optional(),
-    /** Callback fired when the reference is fully loaded */
-    onLoaded: z.function().optional(),
-    /** onBeforeRequest is fired before the request is sent. You can modify the request here. */
-    onBeforeRequest: z.function({ input: [z.object({ request: z.instanceof(Request) })], output: z.void() }).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({
-      input: [z.string()],
-      output: z.void()
-    }).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({
-      input: [z.string()],
-      output: z.void()
-    }).optional(),
-    /**
-     * Route using paths instead of hashes, your server MUST support this
-     * @example '/standalone-api-reference/:custom(.*)?'
-     * @experimental
-     * @default undefined
-     */
-    pathRouting: pathRoutingSchema.optional(),
-    /**
-     * 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.function({
-      input: [z.object({ slug: z.string().default("headingSlug") })],
-      output: z.string()
-    }).optional(),
-    /**
-     * 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.function({
-      input: [z.object({ name: z.string().default("modelName") })],
-      output: z.string()
-    }).optional(),
-    /**
-     * 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.function({
-      input: [z.object({ name: z.string().default("tagName") })],
-      output: z.string()
-    }).optional(),
-    /**
-     * 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.function({
-      input: [
-        z.object({
-          path: z.string(),
-          operationId: z.string().optional(),
-          method: z.string(),
-          summary: z.string().optional()
-        })
-      ],
-      output: z.string()
-    }).optional(),
-    /**
-     * 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.function({
-      input: [
-        z.object({
-          name: z.string(),
-          method: z.string().optional()
-        })
-      ],
-      output: z.string()
-    }).optional(),
-    /**
-     * 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.function({
-      input: [z.string()],
-      output: z.string().nullable().optional()
-    }).optional(),
-    /**
-     * Whether to include default fonts
-     * @default true
-     */
-    withDefaultFonts: z.boolean().optional().default(true).catch(true),
-    /**
-     * Whether to expand all tags by default
-     *
-     * Warning this can cause performance issues on big documents
-     * @default false
-     */
-    defaultOpenAllTags: z.boolean().optional().default(false).catch(false),
-    /**
-     * Whether to expand all models by default
-     *
-     * Warning this can cause performance issues on big documents
-     * @default false
-     */
-    expandAllModelSections: z.boolean().optional().default(false).catch(false),
-    /**
-     * Whether to expand all responses by default
-     *
-     * Warning this can cause performance issues on big documents
-     * @default false
-     */
-    expandAllResponses: z.boolean().optional().default(false).catch(false),
-    /**
-     * Function to sort tags
-     * @default 'alpha' for alphabetical sorting
-     */
-    tagsSorter: z.union([
-      z.literal("alpha"),
-      z.function({
-        input: [z.any(), z.any()],
-        output: z.number()
+  /** onServerChange is fired on selected server change */
+  onServerChange: z.function({
+    input: [z.string()],
+    output: z.void()
+  }).optional(),
+  /** onDocumentSelect is fired when the config is selected */
+  onDocumentSelect: z.function().optional(),
+  /** Callback fired when the reference is fully loaded */
+  onLoaded: z.function().optional(),
+  /** onBeforeRequest is fired before the request is sent. You can modify the request here. */
+  onBeforeRequest: z.function({ input: [z.object({ request: z.instanceof(Request) })], output: z.void() }).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({
+    input: [z.string()],
+    output: z.void()
+  }).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({
+    input: [z.string()],
+    output: z.void()
+  }).optional(),
+  /**
+   * Route using paths instead of hashes, your server MUST support this
+   * @example '/standalone-api-reference/:custom(.*)?'
+   * @experimental
+   * @default undefined
+   */
+  pathRouting: z.object({
+    basePath: z.string()
+  }).optional(),
+  /**
+   * 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.function({
+    input: [z.object({ slug: z.string().default("headingSlug") })],
+    output: z.string()
+  }).optional(),
+  /**
+   * 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.function({
+    input: [z.object({ name: z.string().default("modelName") })],
+    output: z.string()
+  }).optional(),
+  /**
+   * 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.function({
+    input: [z.object({ name: z.string().default("tagName") })],
+    output: z.string()
+  }).optional(),
+  /**
+   * 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.function({
+    input: [
+      z.object({
+        path: z.string(),
+        operationId: z.string().optional(),
+        method: z.string(),
+        summary: z.string().optional()
       })
-    ]).optional(),
-    /**
-     * Function to sort operations
-     * @default 'alpha' for alphabetical sorting
-     */
-    operationsSorter: z.union([
-      z.literal("alpha"),
-      z.literal("method"),
-      z.function({
-        input: [z.any(), z.any()],
-        output: z.number()
+    ],
+    output: z.string()
+  }).optional(),
+  /**
+   * 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.function({
+    input: [
+      z.object({
+        name: z.string(),
+        method: z.string().optional()
       })
-    ]).optional(),
-    /**
-     * Order the schema properties by
-     * @default 'alpha' for alphabetical sorting
-     */
-    orderSchemaPropertiesBy: z.union([z.literal("alpha"), z.literal("preserve")]).optional().default("alpha").catch("alpha"),
-    /**
-     * Sort the schema properties by required ones first
-     * @default true
-     */
-    orderRequiredPropertiesFirst: z.boolean().optional().default(true).catch(true)
-  })
-);
-const OLD_PROXY_URL = "https://api.scalar.com/request-proxy";
-const NEW_PROXY_URL = "https://proxy.scalar.com";
-const migrateConfiguration = (_configuration) => {
-  const configuration = { ..._configuration };
+    ],
+    output: z.string()
+  }).optional(),
+  /**
+   * 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.function({
+    input: [z.string()],
+    output: z.string().nullable().optional()
+  }).optional(),
+  /**
+   * Whether to include default fonts
+   * @default true
+   */
+  withDefaultFonts: z.boolean().optional().default(true).catch(true),
+  /**
+   * Whether to expand all tags by default
+   *
+   * Warning this can cause performance issues on big documents
+   * @default false
+   */
+  defaultOpenAllTags: z.boolean().optional().default(false).catch(false),
+  /**
+   * Whether to expand all models by default
+   *
+   * Warning this can cause performance issues on big documents
+   * @default false
+   */
+  expandAllModelSections: z.boolean().optional().default(false).catch(false),
+  /**
+   * Whether to expand all responses by default
+   *
+   * Warning this can cause performance issues on big documents
+   * @default false
+   */
+  expandAllResponses: z.boolean().optional().default(false).catch(false),
+  /**
+   * Function to sort tags
+   * @default 'alpha' for alphabetical sorting
+   */
+  tagsSorter: z.union([
+    z.literal("alpha"),
+    z.function({
+      input: [z.any(), z.any()],
+      output: z.number()
+    })
+  ]).optional(),
+  /**
+   * Function to sort operations
+   * @default 'alpha' for alphabetical sorting
+   */
+  operationsSorter: z.union([
+    z.literal("alpha"),
+    z.literal("method"),
+    z.function({
+      input: [z.any(), z.any()],
+      output: z.number()
+    })
+  ]).optional(),
+  /**
+   * Order the schema properties by
+   * @default 'alpha' for alphabetical sorting
+   */
+  orderSchemaPropertiesBy: z.union([z.literal("alpha"), z.literal("preserve")]).optional().default("alpha").catch("alpha"),
+  /**
+   * Sort the schema properties by required ones first
+   * @default true
+   */
+  orderRequiredPropertiesFirst: z.boolean().optional().default(true).catch(true)
+});
+const apiReferenceConfigurationWithSourceSchema = apiReferenceConfigurationSchema.extend(sourceConfigurationSchema.shape).transform((configuration) => {
   if (configuration.hideDownloadButton) {
     console.warn(
       `[DEPRECATED] You're using the deprecated 'hideDownloadButton' attribute. Use 'documentDownloadType: 'none'' instead.`
@@ -560,13 +325,11 @@ const migrateConfiguration = (_configuration) => {
     configuration.proxyUrl = NEW_PROXY_URL;
   }
   return configuration;
-};
-const apiReferenceConfigurationSchema = _apiReferenceConfigurationSchema.transform(migrateConfiguration);
+});
 const isConfigurationWithSources = (config) => Boolean(!Array.isArray(config) && config && "sources" in config && Array.isArray(config.sources));
 export {
-  apiClientConfigurationSchema,
   apiReferenceConfigurationSchema,
-  isConfigurationWithSources,
-  specConfigurationSchema
+  apiReferenceConfigurationWithSourceSchema,
+  isConfigurationWithSources
 };
 //# sourceMappingURL=api-reference-configuration.js.map