@scalar/types 0.7.3 → 0.7.4

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

@@ -1,55 +1,51 @@
-import { z } from "zod";
+import { z } from 'zod';
 const openApiExtensionSchema = z.object({
-  /**
-   * Name of specification extension property. Has to start with `x-`.
-   *
-   * @example
-   * ```yaml
-   * x-custom-extension: foobar
-   * ```
-   */
-  name: z.string().regex(/^x-/),
-  /**
-   * Vue component to render the specification extension
-   */
-  component: z.unknown(),
-  /**
-   * Custom renderer to render the specification extension
-   */
-  renderer: z.unknown().optional()
+    /**
+     * Name of specification extension property. Has to start with `x-`.
+     *
+     * @example
+     * ```yaml
+     * x-custom-extension: foobar
+     * ```
+     */
+    name: z.string().regex(/^x-/),
+    /**
+     * Vue component to render the specification extension
+     */
+    component: z.unknown(),
+    /**
+     * Custom renderer to render the specification extension
+     */
+    renderer: z.unknown().optional(),
 });
 const viewComponentSchema = z.object({
-  /**
-   * Vue component to render in the view
-   */
-  component: z.unknown(),
-  /**
-   * Custom renderer to render the view component (e.g., ReactRenderer)
-   */
-  renderer: z.unknown().optional(),
-  /**
-   * Additional props to pass to the component
-   */
-  props: z.record(z.string(), z.any()).optional()
+    /**
+     * Vue component to render in the view
+     */
+    component: z.unknown(),
+    /**
+     * Custom renderer to render the view component (e.g., ReactRenderer)
+     */
+    renderer: z.unknown().optional(),
+    /**
+     * Additional props to pass to the component
+     */
+    props: z.record(z.string(), z.any()).optional(),
 });
 const viewsSchema = z.object({
-  /**
-   * Renders after the Models section
-   */
-  "content.end": z.array(viewComponentSchema).optional()
-});
-const apiReferencePluginSchema = z.function({
-  input: [],
-  output: z.object({
-    name: z.string(),
-    extensions: z.array(openApiExtensionSchema),
     /**
-     * Components to render at specific views in the API Reference
+     * Renders after the Models section
      */
-    views: viewsSchema.optional()
-  })
+    'content.end': z.array(viewComponentSchema).optional(),
+});
+export const apiReferencePluginSchema = z.function({
+    input: [],
+    output: z.object({
+        name: z.string(),
+        extensions: z.array(openApiExtensionSchema),
+        /**
+         * Components to render at specific views in the API Reference
+         */
+        views: viewsSchema.optional(),
+    }),
 });
-export {
-  apiReferencePluginSchema
-};
-//# sourceMappingURL=api-reference-plugin.js.map

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

@@ -1 +1 @@
-//# sourceMappingURL=authentication-configuration.js.map
+export {};

package/dist/api-reference/authentication-configuration.test-d.js

@@ -1,45 +1,44 @@
-import { assertType, describe, it } from "vitest";
-describe("ApiReferenceConfiguration", () => {
-  it("ensure we are generating correct types for preferredSecurityScheme", () => {
-    assertType({ preferredSecurityScheme: "apiKey" });
-    assertType({ preferredSecurityScheme: ["apiKey", "bearerAuth"] });
-    assertType({
-      preferredSecurityScheme: ["apiKey", ["basic", "oauth2"], ["apiKey", "bearerAuth", "oauth2"]]
+import { assertType, describe, it } from 'vitest';
+describe('ApiReferenceConfiguration', () => {
+    it('ensure we are generating correct types for preferredSecurityScheme', () => {
+        assertType({ preferredSecurityScheme: 'apiKey' });
+        assertType({ preferredSecurityScheme: ['apiKey', 'bearerAuth'] });
+        assertType({
+            preferredSecurityScheme: ['apiKey', ['basic', 'oauth2'], ['apiKey', 'bearerAuth', 'oauth2']],
+        });
+        assertType({
+            // @ts-expect-error incorrect type
+            preferredSecurityScheme: 47,
+        });
+        assertType({
+            // @ts-expect-error incorrect type
+            preferredSecurityScheme: [22, null],
+        });
     });
-    assertType({
-      // @ts-expect-error incorrect type
-      preferredSecurityScheme: 47
+    it('ensure we are generating correct types for securitySchemes', () => {
+        assertType({
+            securitySchemes: {
+                apiKey: { type: 'apiKey', name: 'api_key', in: 'header' },
+            },
+        });
+        assertType({
+            securitySchemes: {
+                bearerAuth: { type: 'http', scheme: 'bearer', bearerFormat: 'JWT' },
+            },
+        });
+        assertType({
+            securitySchemes: {
+                oauth2: {
+                    type: 'oauth2',
+                    flows: {
+                        implicit: { scopes: { 'read:items': 'Read access to items' } },
+                        password: {
+                            username: 'username',
+                            password: 'password',
+                        },
+                    },
+                },
+            },
+        });
     });
-    assertType({
-      // @ts-expect-error incorrect type
-      preferredSecurityScheme: [22, null]
-    });
-  });
-  it("ensure we are generating correct types for securitySchemes", () => {
-    assertType({
-      securitySchemes: {
-        apiKey: { type: "apiKey", name: "api_key", in: "header" }
-      }
-    });
-    assertType({
-      securitySchemes: {
-        bearerAuth: { type: "http", scheme: "bearer", bearerFormat: "JWT" }
-      }
-    });
-    assertType({
-      securitySchemes: {
-        oauth2: {
-          type: "oauth2",
-          flows: {
-            implicit: { scopes: { "read:items": "Read access to items" } },
-            password: {
-              username: "username",
-              password: "password"
-            }
-          }
-        }
-      }
-    });
-  });
 });
-//# sourceMappingURL=authentication-configuration.test-d.js.map

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

@@ -1,147 +1,151 @@
-import z from "zod";
-import { apiClientPluginSchema } from "./api-client-plugin.js";
-const OLD_PROXY_URL = "https://api.scalar.com/request-proxy";
-const NEW_PROXY_URL = "https://proxy.scalar.com";
-const baseConfigurationSchema = z.object({
-  /**
-   * 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(),
-  /** 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: 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"
-  ]).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),
-  /**
-   * Whether and when to show the developer tools.
-   *
-   * @default 'localhost' to only show the toolbar on localhost or similar hosts
-   */
-  showDeveloperTools: z.enum(["always", "localhost", "never"]).optional().default("localhost").catch("localhost"),
-  /**
-   * Sets the visibility of the developer tools
-   * @default 'localhost' to only show the toolbar on localhost or similar hosts
-   * @deprecated Use showDeveloperTools instead
-   */
-  showToolbar: z.enum(["always", "localhost", "never"]).optional().default("localhost").catch("localhost"),
-  /**
-   * Whether to use the operation summary or the operation path for the sidebar and search
-   * @default 'summary'
-   */
-  operationTitleSource: z.enum(["summary", "path"]).optional().default("summary").catch("summary"),
-  /** A string to use one of the color presets */
-  theme: z.enum([
-    "alternate",
-    "default",
-    "moon",
-    "purple",
-    "solarized",
-    "bluePlanet",
-    "deepSpace",
-    "saturn",
-    "kepler",
-    "elysiajs",
-    "fastify",
-    "mars",
-    "laserwave",
-    "none"
-  ]).optional().default("default").catch("default"),
-  /** Integration type identifier */
-  _integration: z.enum([
-    "adonisjs",
-    "astro",
-    "docusaurus",
-    "dotnet",
-    "elysiajs",
-    "express",
-    "fastapi",
-    "fastify",
-    "go",
-    "hono",
-    "html",
-    "laravel",
-    "litestar",
-    "nestjs",
-    "nextjs",
-    "nitro",
-    "nuxt",
-    "platformatic",
-    "react",
-    "rust",
-    "svelte",
-    "vue"
-  ]).nullable().optional(),
-  /** onRequestSent is fired when a request is sent */
-  onRequestSent: 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)
+import z from 'zod';
+import { apiClientPluginSchema } from './api-client-plugin.js';
+export const OLD_PROXY_URL = 'https://api.scalar.com/request-proxy';
+export const NEW_PROXY_URL = 'https://proxy.scalar.com';
+/** Shared configuration for the Api Reference and Api Client */
+export const baseConfigurationSchema = z.object({
+    /**
+     * 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(),
+    /** 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: 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',
+    ])
+        .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),
+    /**
+     * Whether and when to show the developer tools.
+     *
+     * @default 'localhost' to only show the toolbar on localhost or similar hosts
+     */
+    showDeveloperTools: z.enum(['always', 'localhost', 'never']).optional().default('localhost').catch('localhost'),
+    /**
+     * Sets the visibility of the developer tools
+     * @default 'localhost' to only show the toolbar on localhost or similar hosts
+     * @deprecated Use showDeveloperTools instead
+     */
+    showToolbar: z.enum(['always', 'localhost', 'never']).optional().default('localhost').catch('localhost'),
+    /**
+     * Whether to use the operation summary or the operation path for the sidebar and search
+     * @default 'summary'
+     */
+    operationTitleSource: z.enum(['summary', 'path']).optional().default('summary').catch('summary'),
+    /** A string to use one of the color presets */
+    theme: z
+        .enum([
+        'alternate',
+        'default',
+        'moon',
+        'purple',
+        'solarized',
+        'bluePlanet',
+        'deepSpace',
+        'saturn',
+        'kepler',
+        'elysiajs',
+        'fastify',
+        'mars',
+        'laserwave',
+        'none',
+    ])
+        .optional()
+        .default('default')
+        .catch('default'),
+    /** Integration type identifier */
+    _integration: z
+        .enum([
+        'adonisjs',
+        'astro',
+        'docusaurus',
+        'dotnet',
+        'elysiajs',
+        'express',
+        'fastapi',
+        'fastify',
+        'go',
+        'hono',
+        'html',
+        'laravel',
+        'litestar',
+        'nestjs',
+        'nextjs',
+        'nitro',
+        'nuxt',
+        'platformatic',
+        'react',
+        'rust',
+        'svelte',
+        'vue',
+    ])
+        .nullable()
+        .optional(),
+    /** onRequestSent is fired when a request is sent */
+    onRequestSent: 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),
 });
-export {
-  NEW_PROXY_URL,
-  OLD_PROXY_URL,
-  baseConfigurationSchema
-};
-//# sourceMappingURL=base-configuration.js.map

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

@@ -1 +1 @@
-//# sourceMappingURL=html-api.js.map
+export {};

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

@@ -1,21 +1,20 @@
-import { z } from "zod";
-const htmlRenderingConfigurationSchema = z.object({
-  /**
-   * The URL to the Scalar API Reference JS CDN.
-   *
-   * Use this to pin a specific version of the Scalar API Reference.
-   *
-   * @default https://cdn.jsdelivr.net/npm/@scalar/api-reference
-   *
-   * @example https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.25.122
-   */
-  cdn: z.string().optional().default("https://cdn.jsdelivr.net/npm/@scalar/api-reference"),
-  /**
-   * The title of the page.
-   */
-  pageTitle: z.string().optional().default("Scalar API Reference")
+import { z } from 'zod';
+/**
+ * Zod schema for HTML rendering configuration
+ */
+export const htmlRenderingConfigurationSchema = z.object({
+    /**
+     * The URL to the Scalar API Reference JS CDN.
+     *
+     * Use this to pin a specific version of the Scalar API Reference.
+     *
+     * @default https://cdn.jsdelivr.net/npm/@scalar/api-reference
+     *
+     * @example https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.25.122
+     */
+    cdn: z.string().optional().default('https://cdn.jsdelivr.net/npm/@scalar/api-reference'),
+    /**
+     * The title of the page.
+     */
+    pageTitle: z.string().optional().default('Scalar API Reference'),
 });
-export {
-  htmlRenderingConfigurationSchema
-};
-//# sourceMappingURL=html-rendering-configuration.js.map

package/dist/api-reference/index.js

@@ -1,26 +1,5 @@
-import {
-  apiClientConfigurationSchema
-} from "./api-client-configuration.js";
-import { apiClientPluginSchema, hooksSchema } from "./api-client-plugin.js";
-import {
-  apiReferenceConfigurationSchema,
-  apiReferenceConfigurationWithSourceSchema,
-  isConfigurationWithSources
-} from "./api-reference-configuration.js";
-import {
-  htmlRenderingConfigurationSchema
-} from "./html-rendering-configuration.js";
-import {
-  sourceConfigurationSchema
-} from "./source-configuration.js";
-export {
-  apiClientConfigurationSchema,
-  apiClientPluginSchema,
-  apiReferenceConfigurationSchema,
-  apiReferenceConfigurationWithSourceSchema,
-  hooksSchema,
-  htmlRenderingConfigurationSchema,
-  isConfigurationWithSources,
-  sourceConfigurationSchema
-};
-//# sourceMappingURL=index.js.map
+export { apiClientConfigurationSchema, } from './api-client-configuration.js';
+export { apiClientPluginSchema, hooksSchema } from './api-client-plugin.js';
+export { apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourceSchema, isConfigurationWithSources, } from './api-reference-configuration.js';
+export { htmlRenderingConfigurationSchema, } from './html-rendering-configuration.js';
+export { sourceConfigurationSchema, } from './source-configuration.js';