@scalar/types 0.1.13 → 0.1.15

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

@@ -1,217 +1,211 @@
-import { z } from 'zod';
-import { ApiReferencePluginSchema } from './api-reference-plugin.js';
-import { migrateThemeVariables } from './helpers/migrate-theme-variables.js';
-
-/** Available theme presets for the API reference */
+import { z } from "zod";
+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',
+  "alternate",
+  "default",
+  "moon",
+  "purple",
+  "solarized",
+  "bluePlanet",
+  "deepSpace",
+  "saturn",
+  "kepler",
+  "elysiajs",
+  "fastify",
+  "mars",
+  "laserwave",
+  "none"
 ]);
-/** Valid keys that can be used with CTRL/CMD to open the search modal */
 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',
+  "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"
 ]);
-/** Supported integration types */
-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();
-/** Configuration for the OpenAPI/Swagger specification */
+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(),
-    /**
-     * 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.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
-    /**
-     * The title of the OpenAPI document.
-     *
-     * @example 'Scalar Galaxy'
-     *
-     * @deprecated Please move `title` to the top level and remove the `spec` prefix.
-     */
-    title: z.string().optional(),
-    /**
-     * 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.string().optional(),
+  /**
+   * 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(),
+  /**
+   * 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.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
+  /**
+   * The title of the OpenAPI document.
+   *
+   * @example 'Scalar Galaxy'
+   *
+   * @deprecated Please move `title` to the top level and remove the `spec` prefix.
+   */
+  title: z.string().optional(),
+  /**
+   * 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.string().optional()
 });
-/** Configuration for path-based routing */
 const pathRoutingSchema = z.object({
-    /** Base path for the API reference */
-    basePath: z.string(),
+  /** Base path for the API reference */
+  basePath: z.string()
 });
-/** Configuration for the Api Client */
 const apiClientConfigurationSchema = z.object({
-    /**
-     * URL to an OpenAPI/Swagger document
-     **/
-    url: z.string().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.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
-    /**
-     * The title of the OpenAPI document.
-     *
-     * @example 'Scalar Galaxy'
-     */
-    title: z.string().optional(),
-    /**
-     * 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.string().optional(),
-    /**
-     * The OpenAPI/Swagger document to render
-     *
-     * @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
-    /**
-     * Whether to show the sidebar
-     * @default true
-     */
-    showSidebar: z.boolean().optional().default(true).catch(true),
-    /** 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().args(z.string()).returns(z.void()).optional(),
+  /**
+   * URL to an OpenAPI/Swagger document
+   **/
+  url: z.string().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.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),
+  /**
+   * The title of the OpenAPI document.
+   *
+   * @example 'Scalar Galaxy'
+   */
+  title: z.string().optional(),
+  /**
+   * 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.string().optional(),
+  /**
+   * The OpenAPI/Swagger document to render
+   *
+   * @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
+  /**
+   * Whether to show the sidebar
+   * @default true
+   */
+  showSidebar: z.boolean().optional().default(true).catch(true),
+  /** 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().args(z.string()).returns(z.void()).optional(),
+  /** Whether to persist auth to local storage */
+  persistAuth: z.boolean().optional().default(false).catch(false)
 });
-/** Configuration for the Api Client without the transform since it cannot be merged */
-const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.object({
+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'),
+    layout: z.enum(["modern", "classic"]).optional().default("modern").catch("modern"),
     /**
      * URL to a request proxy for the API client
      * @deprecated Use proxyUrl instead
@@ -222,7 +216,7 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      */
     plugins: z.array(ApiReferencePluginSchema).optional(),
     /**
-     * Whether the spec input should show
+     * Allows the user to inject an editor for the spec
      * @default false
      */
     isEditable: z.boolean().optional().default(false).catch(false),
@@ -254,7 +248,7 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
     /** 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(),
+    forceDarkModeState: z.enum(["dark", "light"]).optional(),
     /**
      * Whether to show the dark mode toggle
      * @default false
@@ -264,7 +258,8 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      * 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
+    metaData: z.any().optional(),
+    // Using any for UseSeoMetaInput since it's an external type
     /**
      * Path to a favicon image
      * @default undefined
@@ -275,16 +270,12 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      * 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.union([z.boolean(), z.array(z.string())])), z.array(z.string()), z.literal(true)])
-        .optional(),
+    hiddenClients: z.union([z.record(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(),
+    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 */
@@ -318,69 +309,59 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      * @returns A string ID used to generate the URL hash
      * @default (heading) => `#description/${heading.slug}`
      */
-    generateHeadingSlug: z
-        .function()
-        .args(z.object({
-        slug: z.string().default('headingSlug'),
-    }))
-        .returns(z.string())
-        .optional(),
+    generateHeadingSlug: z.function().args(
+      z.object({
+        slug: z.string().default("headingSlug")
+      })
+    ).returns(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()
-        .args(z.object({
-        name: z.string().default('modelName'),
-    }))
-        .returns(z.string())
-        .optional(),
+    generateModelSlug: z.function().args(
+      z.object({
+        name: z.string().default("modelName")
+      })
+    ).returns(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()
-        .args(z.object({
-        name: z.string().default('tagName'),
-    }))
-        .returns(z.string())
-        .optional(),
+    generateTagSlug: z.function().args(
+      z.object({
+        name: z.string().default("tagName")
+      })
+    ).returns(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()
-        .args(z.object({
+    generateOperationSlug: z.function().args(
+      z.object({
         path: z.string(),
         operationId: z.string().optional(),
         method: z.string(),
-        summary: z.string().optional(),
-    }))
-        .returns(z.string())
-        .optional(),
+        summary: z.string().optional()
+      })
+    ).returns(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()
-        .args(z.object({
+    generateWebhookSlug: z.function().args(
+      z.object({
         name: z.string(),
-        method: z.string().optional(),
-    }))
-        .returns(z.string())
-        .optional(),
+        method: z.string().optional()
+      })
+    ).returns(z.string()).optional(),
     /**
      * To handle redirects, pass a function that will recieve:
      * - The current path with hash if pathRouting is enabled
@@ -413,54 +394,57 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      * Function to sort tags
      * @default 'alpha' for alphabetical sorting
      */
-    tagsSorter: z.union([z.literal('alpha'), z.function().args(z.any(), z.any()).returns(z.number())]).optional(),
+    tagsSorter: z.union([z.literal("alpha"), z.function().args(z.any(), z.any()).returns(z.number())]).optional(),
     /**
      * Function to sort operations
      * @default 'alpha' for alphabetical sorting
      */
-    operationsSorter: z
-        .union([z.literal('alpha'), z.literal('method'), z.function().args(z.any(), z.any()).returns(z.number())])
-        .optional(),
-}));
-const OLD_PROXY_URL = 'https://api.scalar.com/request-proxy';
-const NEW_PROXY_URL = 'https://proxy.scalar.com';
-/** Migrate the configuration through a transform */
+    operationsSorter: z.union([z.literal("alpha"), z.literal("method"), z.function().args(z.any(), z.any()).returns(z.number())]).optional()
+  })
+);
+const OLD_PROXY_URL = "https://api.scalar.com/request-proxy";
+const NEW_PROXY_URL = "https://proxy.scalar.com";
 const migrateConfiguration = (_configuration) => {
-    const configuration = { ..._configuration };
-    // Remove the spec prefix
-    if (configuration.spec?.url) {
-        console.warn(`[DEPRECATED] You're using the deprecated 'spec.url' attribute. Remove the spec prefix and move the 'url' attribute to the top level.`);
-        configuration.url = configuration.spec.url;
-        delete configuration.spec;
-    }
-    if (configuration.spec?.content) {
-        console.warn(`[DEPRECATED] You're using the deprecated 'spec.content' attribute. Remove the spec prefix and move the 'content' attribute to the top level.`);
-        configuration.content = configuration.spec.content;
-        delete configuration.spec;
-    }
-    // Migrate legacy theme variables
-    if (configuration.customCss) {
-        configuration.customCss = migrateThemeVariables(configuration.customCss);
+  const configuration = { ..._configuration };
+  if (configuration.spec?.url) {
+    console.warn(
+      `[DEPRECATED] You're using the deprecated 'spec.url' attribute. Remove the spec prefix and move the 'url' attribute to the top level.`
+    );
+    configuration.url = configuration.spec.url;
+    delete configuration.spec;
+  }
+  if (configuration.spec?.content) {
+    console.warn(
+      `[DEPRECATED] You're using the deprecated 'spec.content' attribute. Remove the spec prefix and move the 'content' attribute to the top level.`
+    );
+    configuration.content = configuration.spec.content;
+    delete configuration.spec;
+  }
+  if (configuration.proxy) {
+    console.warn(
+      `[DEPRECATED] You're using the deprecated 'proxy' attribute, rename it to 'proxyUrl' or update the package.`
+    );
+    if (!configuration.proxyUrl) {
+      configuration.proxyUrl = configuration.proxy;
     }
-    // Migrate proxy URL
-    if (configuration.proxy) {
-        console.warn(`[DEPRECATED] You're using the deprecated 'proxy' attribute, rename it to 'proxyUrl' or update the package.`);
-        if (!configuration.proxyUrl) {
-            configuration.proxyUrl = configuration.proxy;
-        }
-        delete configuration.proxy;
-    }
-    if (configuration.proxyUrl === OLD_PROXY_URL) {
-        console.warn(`[DEPRECATED] Warning: configuration.proxyUrl points to our old proxy (${OLD_PROXY_URL}).`);
-        console.warn(`[DEPRECATED] We are overwriting the value and use the new proxy URL (${NEW_PROXY_URL}) instead.`);
-        console.warn(`[DEPRECATED] Action Required: You should manually update your configuration to use the new URL (${NEW_PROXY_URL}). Read more: https://github.com/scalar/scalar`);
-        configuration.proxyUrl = NEW_PROXY_URL;
-    }
-    return configuration;
+    delete configuration.proxy;
+  }
+  if (configuration.proxyUrl === OLD_PROXY_URL) {
+    console.warn(`[DEPRECATED] Warning: configuration.proxyUrl points to our old proxy (${OLD_PROXY_URL}).`);
+    console.warn(`[DEPRECATED] We are overwriting the value and use the new proxy URL (${NEW_PROXY_URL}) instead.`);
+    console.warn(
+      `[DEPRECATED] Action Required: You should manually update your configuration to use the new URL (${NEW_PROXY_URL}). Read more: https://github.com/scalar/scalar`
+    );
+    configuration.proxyUrl = NEW_PROXY_URL;
+  }
+  return configuration;
 };
-/** Configuration for the Api Reference */
 const apiReferenceConfigurationSchema = _apiReferenceConfigurationSchema.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, isConfigurationWithSources, specConfigurationSchema };
+const isConfigurationWithSources = (config) => Boolean(!Array.isArray(config) && config && "sources" in config && Array.isArray(config.sources));
+export {
+  apiClientConfigurationSchema,
+  apiReferenceConfigurationSchema,
+  isConfigurationWithSources,
+  specConfigurationSchema
+};
+//# sourceMappingURL=api-reference-configuration.js.map