@scalar/types 0.2.16 → 0.3.1

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,sBAAsB,EAC3B,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,EACzC,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EACtB,4BAA4B,EAC5B,+BAA+B,EAC/B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,gCAAgC,CAAA;AAEvC,YAAY,EACV,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,wBAAwB,CAAA;AAE/B,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,sBAAsB,EAC3B,4BAA4B,GAC7B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,KAAK,eAAe,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC9F,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,oCAAoC,EACzC,KAAK,4CAA4C,EACjD,KAAK,mCAAmC,EACxC,+BAA+B,EAC/B,yCAAyC,EACzC,0BAA0B,GAC3B,MAAM,+BAA+B,CAAA;AACtC,YAAY,EACV,kBAAkB,EAClB,sBAAsB,GACvB,MAAM,wBAAwB,CAAA;AAC/B,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC1E,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,gCAAgC,CAAA;AACvC,OAAO,EACL,KAAK,mBAAmB,EACxB,yBAAyB,GAC1B,MAAM,wBAAwB,CAAA"}

package/dist/api-reference/index.js

@@ -1,17 +1,26 @@
 import {
-  apiClientConfigurationSchema,
+  apiClientConfigurationSchema
+} from "./api-client-configuration.js";
+import { apiClientPluginSchema, hooksSchema } from "./api-client-plugin.js";
+import {
   apiReferenceConfigurationSchema,
-  specConfigurationSchema,
+  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,
-  specConfigurationSchema
+  sourceConfigurationSchema
 };
 //# sourceMappingURL=index.js.map

package/dist/api-reference/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/api-reference/index.ts"],
-  "sourcesContent": ["export {\n  type ApiClientConfiguration,\n  type ApiReferenceConfiguration,\n  type ApiReferenceConfigurationWithSources,\n  type AnyApiReferenceConfiguration,\n  type SpecConfiguration,\n  apiClientConfigurationSchema,\n  apiReferenceConfigurationSchema,\n  specConfigurationSchema,\n  isConfigurationWithSources,\n} from './api-reference-configuration'\n\nexport {\n  type HtmlRenderingConfiguration,\n  htmlRenderingConfigurationSchema,\n} from './html-rendering-configuration'\n\nexport type {\n  SpecificationExtension,\n  ApiReferencePlugin,\n} from './api-reference-plugin'\n\nexport type { ApiReferenceInstance, CreateApiReference } from './html-api'\n"],
-  "mappings": "AAAA;AAAA,EAME;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP;AAAA,EAEE;AAAA,OACK;",
+  "sourcesContent": ["// biome-ignore lint/performance/noBarrelFile: exporting from a block\nexport {\n  type ApiClientConfiguration,\n  apiClientConfigurationSchema,\n} from './api-client-configuration'\nexport { type ApiClientPlugin, apiClientPluginSchema, hooksSchema } from './api-client-plugin'\nexport {\n  type AnyApiReferenceConfiguration,\n  type ApiReferenceConfiguration,\n  type ApiReferenceConfigurationWithDefault,\n  type ApiReferenceConfigurationWithMultipleSources,\n  type ApiReferenceConfigurationWithSource,\n  apiReferenceConfigurationSchema,\n  apiReferenceConfigurationWithSourceSchema,\n  isConfigurationWithSources,\n} from './api-reference-configuration'\nexport type {\n  ApiReferencePlugin,\n  SpecificationExtension,\n} from './api-reference-plugin'\nexport type { ApiReferenceInstance, CreateApiReference } from './html-api'\nexport {\n  type HtmlRenderingConfiguration,\n  htmlRenderingConfigurationSchema,\n} from './html-rendering-configuration'\nexport {\n  type SourceConfiguration,\n  sourceConfigurationSchema,\n} from './source-configuration'\n"],
+  "mappings": "AACA;AAAA,EAEE;AAAA,OACK;AACP,SAA+B,uBAAuB,mBAAmB;AACzE;AAAA,EAME;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAMP;AAAA,EAEE;AAAA,OACK;AACP;AAAA,EAEE;AAAA,OACK;",
   "names": []
 }

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

@@ -0,0 +1,18 @@
+import z from 'zod';
+/**
+ * A source is any potential document input used for API Reference
+ * and API Client integrations. Sources may be specified in the configuration
+ * or used independently. Some configurations may have multiple sources.
+ */
+export declare const sourceConfigurationSchema: z.ZodObject<{
+    url: z.ZodOptional<z.ZodString>;
+    content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
+    title: z.ZodOptional<z.ZodString>;
+    slug: z.ZodOptional<z.ZodString>;
+    spec: z.ZodOptional<z.ZodObject<{
+        url: z.ZodOptional<z.ZodString>;
+        content: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNull, z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodRecord<z.ZodString, z.ZodAny>>]>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SourceConfiguration = z.infer<typeof sourceConfigurationSchema>;
+//# sourceMappingURL=source-configuration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"source-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/source-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,KAAK,CAAA;AAEnB;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;iBAuFpC,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA"}

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

@@ -0,0 +1,87 @@
+import z from "zod";
+const sourceConfigurationSchema = z.object({
+  /**
+   * URL to an OpenAPI/Swagger document
+   * @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.
+   * @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 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(),
+  /**
+   * The OpenAPI/Swagger document to render
+   *
+   * @deprecated Use `url` and `content` on the top level instead.
+   **/
+  spec: z.object({
+    url: z.string().optional(),
+    content: z.union([
+      z.string(),
+      z.null(),
+      z.record(z.string(), z.any()),
+      z.function({
+        input: [],
+        output: z.record(z.string(), z.any())
+      })
+    ]).optional()
+  }).optional()
+});
+export {
+  sourceConfigurationSchema
+};
+//# sourceMappingURL=source-configuration.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/api-reference/source-configuration.ts"],
+  "sourcesContent": ["import z from 'zod'\n\n/**\n * A source is any potential document input used for API Reference\n * and API Client integrations. Sources may be specified in the configuration\n * or used independently. Some configurations may have multiple sources.\n */\nexport const sourceConfigurationSchema = z.object({\n  /**\n   * URL to an OpenAPI/Swagger document\n   * @example\n   * ```ts\n   * const oldConfiguration = {\n   *   spec: {\n   *     url: 'https://example.com/openapi.json',\n   *   },\n   * }\n   *\n   * const newConfiguration = {\n   *   url: 'https://example.com/openapi.json',\n   * }\n   * ```\n   **/\n  url: z.string().optional(),\n  /**\n   * Directly embed the OpenAPI document.\n   * Can be a string, object, function returning an object, or null.\n   *\n   * @remarks It's recommended to pass a URL instead of content.\n   * @example\n   * ```ts\n   * const oldConfiguration = {\n   *   spec: {\n   *     content: '\u2026',\n   *   },\n   * }\n   *\n   * const newConfiguration = {\n   *   content: '\u2026',\n   * }\n   * ```\n   **/\n  content: z\n    .union([\n      z.string(),\n      z.null(),\n      z.record(z.string(), z.any()),\n      z.function({\n        input: [],\n        output: z.record(z.string(), z.any()),\n      }),\n    ])\n    .optional(),\n  /**\n   * The title of the OpenAPI document.\n   *\n   * @example 'Scalar Galaxy'\n   *\n   * @deprecated Please move `title` to the top level and remove the `spec` prefix.\n   */\n  title: z.string().optional(),\n  /**\n   * The slug of the OpenAPI document used in the URL.\n   *\n   * If none is passed, the title will be used.\n   *\n   * If no title is used, it'll just use the index.\n   *\n   * @example 'scalar-galaxy'\n   *\n   * @deprecated Please move `slug` to the top level and remove the `spec` prefix.\n   */\n  slug: z.string().optional(),\n  /**\n   * The OpenAPI/Swagger document to render\n   *\n   * @deprecated Use `url` and `content` on the top level instead.\n   **/\n  spec: z\n    .object({\n      url: z.string().optional(),\n      content: z\n        .union([\n          z.string(),\n          z.null(),\n          z.record(z.string(), z.any()),\n          z.function({\n            input: [],\n            output: z.record(z.string(), z.any()),\n          }),\n        ])\n        .optional(),\n    })\n    .optional(),\n})\n\nexport type SourceConfiguration = z.infer<typeof sourceConfigurationSchema>\n"],
+  "mappings": "AAAA,OAAO,OAAO;AAOP,MAAM,4BAA4B,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBhD,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmBzB,SAAS,EACN,MAAM;AAAA,IACL,EAAE,OAAO;AAAA,IACT,EAAE,KAAK;AAAA,IACP,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC;AAAA,IAC5B,EAAE,SAAS;AAAA,MACT,OAAO,CAAC;AAAA,MACR,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC;AAAA,IACtC,CAAC;AAAA,EACH,CAAC,EACA,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQZ,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY3B,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM1B,MAAM,EACH,OAAO;AAAA,IACN,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA,IACzB,SAAS,EACN,MAAM;AAAA,MACL,EAAE,OAAO;AAAA,MACT,EAAE,KAAK;AAAA,MACP,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC;AAAA,MAC5B,EAAE,SAAS;AAAA,QACT,OAAO,CAAC;AAAA,QACR,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,IAAI,CAAC;AAAA,MACtC,CAAC;AAAA,IACH,CAAC,EACA,SAAS;AAAA,EACd,CAAC,EACA,SAAS;AACd,CAAC;",
+  "names": []
+}