@scalar/types 0.1.5 → 0.1.7

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,GAC/C,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;AAIvB,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,mCAAmC,CAAA;AA2EpF,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;;IAElC,oDAAoD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEpD,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAKjF,uFAAuF;AACvF,QAAA,MAAM,gCAAgC;IAnEpC;;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;;IAElC,oDAAoD;;;IAYlD;;;OAGG;;IAEH;;;OAGG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;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;;QAlLL,sCAAsC;;;;;;;IAoLpC;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKN,CAAA;AAwDD,0CAA0C;AAC1C,eAAO,MAAM,+BAA+B;IA/V1C;;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;;IAElC,oDAAoD;;;IAYlD;;;OAGG;;IAEH;;;OAGG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;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;;QAlLL,sCAAsC;;;;;;;IAoLpC;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;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

@@ -1,4 +1,5 @@
 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 */
@@ -127,7 +128,7 @@ const specConfigurationSchema = z.object({
      *
      * If none is passed, the title will be used.
      *
-     * If no title is used, it’ll just use the index.
+     * If no title is used, it'll just use the index.
      *
      * @example 'scalar-galaxy'
      *
@@ -150,7 +151,7 @@ const apiClientConfigurationSchema = z.object({
      * 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.
+     * @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(),
     /**
@@ -164,7 +165,7 @@ const apiClientConfigurationSchema = z.object({
      *
      * If none is passed, the title will be used.
      *
-     * If no title is used, it’ll just use the index.
+     * If no title is used, it'll just use the index.
      *
      * @example 'scalar-galaxy'
      */
@@ -199,6 +200,8 @@ const apiClientConfigurationSchema = z.object({
     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(),
 });
 const OLD_PROXY_URL = 'https://api.scalar.com/request-proxy';
 const NEW_PROXY_URL = 'https://proxy.scalar.com';
@@ -214,6 +217,10 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      * @deprecated Use proxyUrl instead
      */
     proxy: z.string().optional(),
+    /**
+     * Plugins for the API reference
+     */
+    plugins: z.array(ApiReferencePluginSchema).optional(),
     /**
      * Whether the spec input should show
      * @default false
@@ -286,6 +293,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(.*)?'
@@ -301,7 +320,9 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      */
     generateHeadingSlug: z
         .function()
-        .args(z.object({ slug: z.string().default('headingSlug') }))
+        .args(z.object({
+        slug: z.string().default('headingSlug'),
+    }))
         .returns(z.string())
         .optional(),
     /**
@@ -312,7 +333,9 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      */
     generateModelSlug: z
         .function()
-        .args(z.object({ name: z.string().default('modelName') }))
+        .args(z.object({
+        name: z.string().default('modelName'),
+    }))
         .returns(z.string())
         .optional(),
     /**
@@ -323,7 +346,9 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
      */
     generateTagSlug: z
         .function()
-        .args(z.object({ name: z.string().default('tagName') }))
+        .args(z.object({
+        name: z.string().default('tagName'),
+    }))
         .returns(z.string())
         .optional(),
     /**
@@ -356,8 +381,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
@@ -404,12 +427,12 @@ 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.`);
+        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.`);
+        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;
     }
@@ -419,7 +442,7 @@ const migrateConfiguration = (_configuration) => {
     }
     // Migrate proxy URL
     if (configuration.proxy) {
-        console.warn(`[DEPRECATED] You’re using the deprecated 'proxy' attribute, rename it to 'proxyUrl' or update the package.`);
+        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;
         }

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

@@ -0,0 +1,61 @@
+import { z } from 'zod';
+export declare const OpenApiExtensionSchema: z.ZodObject<{
+    /**
+     * Name of specification extension property. Has to start with `x-`.
+     *
+     * @example
+     * ```yaml
+     * x-custom-extension: foobar
+     * ```
+     */
+    name: z.ZodString;
+    /**
+     * Vue component to render the OpenAPI extension
+     */
+    component: z.ZodUnknown;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    component?: unknown;
+}, {
+    name: string;
+    component?: unknown;
+}>;
+export declare const ApiReferencePluginSchema: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
+    name: z.ZodString;
+    extensions: z.ZodArray<z.ZodObject<{
+        /**
+         * Name of specification extension property. Has to start with `x-`.
+         *
+         * @example
+         * ```yaml
+         * x-custom-extension: foobar
+         * ```
+         */
+        name: z.ZodString;
+        /**
+         * Vue component to render the OpenAPI extension
+         */
+        component: z.ZodUnknown;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        component?: unknown;
+    }, {
+        name: string;
+        component?: unknown;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    extensions: {
+        name: string;
+        component?: unknown;
+    }[];
+}, {
+    name: string;
+    extensions: {
+        name: string;
+        component?: unknown;
+    }[];
+}>>;
+export type SpecificationExtension = z.infer<typeof OpenApiExtensionSchema>;
+export type ApiReferencePlugin = z.infer<typeof ApiReferencePluginSchema>;
+//# sourceMappingURL=api-reference-plugin.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-reference-plugin.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-plugin.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,sBAAsB;IACjC;;;;;;;OAOG;;IAEH;;OAEG;;;;;;;;EAEH,CAAA;AAEF,eAAO,MAAM,wBAAwB;;;QAfnC;;;;;;;WAOG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;;GASJ,CAAA;AAGD,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAA;AAC3E,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}

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

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+
+// TODO: Oh, do we really want to make this a dependency?
+// import type { Component } from 'vue'
+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 OpenAPI extension
+     */
+    component: z.unknown(),
+});
+const ApiReferencePluginSchema = z.function().returns(z.object({
+    name: z.string(),
+    extensions: z.array(OpenApiExtensionSchema),
+}));
+
+export { ApiReferencePluginSchema, OpenApiExtensionSchema };

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

@@ -1,4 +1,5 @@
 export { type ApiClientConfiguration, type ApiReferenceConfiguration, type ApiReferenceConfigurationWithSources, type AnyApiReferenceConfiguration, type SpecConfiguration, apiClientConfigurationSchema, apiReferenceConfigurationSchema, specConfigurationSchema, isConfigurationWithSources, } from './api-reference-configuration.ts';
 export { type HtmlRenderingConfiguration, htmlRenderingConfigurationSchema, } from './html-rendering-configuration.ts';
 export { migrateThemeVariables } from './helpers/migrate-theme-variables.ts';
+export type { SpecificationExtension, ApiReferencePlugin, } from './api-reference-plugin.ts';
 //# sourceMappingURL=index.d.ts.map

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,kCAAkC,CAAA;AAEzC,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAA"}
+{"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,kCAAkC,CAAA;AAEzC,OAAO,EACL,KAAK,0BAA0B,EAC/B,gCAAgC,GACjC,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAA;AAE5E,YAAY,EACV,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,2BAA2B,CAAA"}

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

@@ -15,20 +15,20 @@ export declare const securityApiKeySchema: z.ZodObject<z.objectUtil.extendShape<
 }>, {
     value: z.ZodDefault<z.ZodString>;
 }>, "strip", z.ZodTypeAny, {
+    name: string;
     type: "apiKey";
     value: string;
     uid: string & z.BRAND<"securityScheme">;
     nameKey: string;
-    name: string;
     in: "cookie" | "query" | "header";
     description?: string | undefined;
 }, {
     type: "apiKey";
+    name?: string | undefined;
     value?: string | undefined;
     description?: string | undefined;
     uid?: string | undefined;
     nameKey?: string | undefined;
-    name?: string | undefined;
     in?: unknown;
 }>;
 export type SecuritySchemeApiKey = z.infer<typeof securityApiKeySchema>;
@@ -520,14 +520,14 @@ export declare const oasSecuritySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUt
     /** REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". */
     in: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["query", "header", "cookie"]>>>>;
 }>, "strip", z.ZodTypeAny, {
-    type: "apiKey";
     name: string;
+    type: "apiKey";
     in: "cookie" | "query" | "header";
     description?: string | undefined;
 }, {
     type: "apiKey";
-    description?: string | undefined;
     name?: string | undefined;
+    description?: string | undefined;
     in?: unknown;
 }>, z.ZodObject<z.objectUtil.extendShape<{
     description: z.ZodOptional<z.ZodString>;
@@ -967,20 +967,20 @@ export declare const securitySchemeSchema: z.ZodEffects<z.ZodUnion<[z.ZodObject<
 }>, {
     value: z.ZodDefault<z.ZodString>;
 }>, "strip", z.ZodTypeAny, {
+    name: string;
     type: "apiKey";
     value: string;
     uid: string & z.BRAND<"securityScheme">;
     nameKey: string;
-    name: string;
     in: "cookie" | "query" | "header";
     description?: string | undefined;
 }, {
     type: "apiKey";
+    name?: string | undefined;
     value?: string | undefined;
     description?: string | undefined;
     uid?: string | undefined;
     nameKey?: string | undefined;
-    name?: string | undefined;
     in?: unknown;
 }>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
     description: z.ZodOptional<z.ZodString>;
@@ -1438,11 +1438,11 @@ export declare const securitySchemeSchema: z.ZodEffects<z.ZodUnion<[z.ZodObject<
         } | undefined;
     } | undefined;
 }>]>, {
+    name: string;
     type: "apiKey";
     value: string;
     uid: string & z.BRAND<"securityScheme">;
     nameKey: string;
-    name: string;
     in: "cookie" | "query" | "header";
     description?: string | undefined;
 } | {
@@ -1516,11 +1516,11 @@ export declare const securitySchemeSchema: z.ZodEffects<z.ZodUnion<[z.ZodObject<
     'x-default-scopes'?: string | string[] | undefined;
 }, {
     type: "apiKey";
+    name?: string | undefined;
     value?: string | undefined;
     description?: string | undefined;
     uid?: string | undefined;
     nameKey?: string | undefined;
-    name?: string | undefined;
     in?: unknown;
 } | {
     type: "http";

package/package.json

@@ -16,7 +16,7 @@
     "scalar",
     "references"
   ],
-  "version": "0.1.5",
+  "version": "0.1.7",
   "engines": {
     "node": ">=18"
   },
@@ -28,30 +28,30 @@
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
-    "./utils": {
-      "import": "./dist/utils/index.js",
-      "types": "./dist/utils/index.d.ts",
-      "default": "./dist/utils/index.js"
+    "./api-reference": {
+      "import": "./dist/api-reference/index.js",
+      "types": "./dist/api-reference/index.d.ts",
+      "default": "./dist/api-reference/index.js"
     },
-    "./snippetz": {
-      "import": "./dist/snippetz/index.js",
-      "types": "./dist/snippetz/index.d.ts",
-      "default": "./dist/snippetz/index.js"
+    "./entities": {
+      "import": "./dist/entities/index.js",
+      "types": "./dist/entities/index.d.ts",
+      "default": "./dist/entities/index.js"
     },
     "./legacy": {
       "import": "./dist/legacy/index.js",
       "types": "./dist/legacy/index.d.ts",
       "default": "./dist/legacy/index.js"
     },
-    "./entities": {
-      "import": "./dist/entities/index.js",
-      "types": "./dist/entities/index.d.ts",
-      "default": "./dist/entities/index.js"
+    "./snippetz": {
+      "import": "./dist/snippetz/index.js",
+      "types": "./dist/snippetz/index.d.ts",
+      "default": "./dist/snippetz/index.js"
     },
-    "./api-reference": {
-      "import": "./dist/api-reference/index.js",
-      "types": "./dist/api-reference/index.d.ts",
-      "default": "./dist/api-reference/index.js"
+    "./utils": {
+      "import": "./dist/utils/index.js",
+      "types": "./dist/utils/index.d.ts",
+      "default": "./dist/utils/index.js"
     }
   },
   "files": [