@scalar/types 0.1.3 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/types
 
+## 0.1.4
+
+### Patch Changes
+
+- 8efedf3: fix: allow async functions in onDocumentSelect
+- 82a4ba8: chore: move security schemes into types package for future reference
+- 57feba6: feat: added new auth config (v2)
+
 ## 0.1.3
 
 ### Patch Changes

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

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import type { AuthenticationConfiguration } from '../api-reference/authentication-configuration.ts';
 /** Configuration for the OpenAPI/Swagger specification */
 export declare const specConfigurationSchema: z.ZodObject<{
     /**
@@ -222,7 +223,7 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
     authentication?: any;
     baseServerURL?: string | undefined;
     proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
+    searchHotKey?: "o" | "n" | "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
     servers?: any[] | undefined;
     _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
 }, {
@@ -240,7 +241,7 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
     baseServerURL?: string | undefined;
     hideClientButton?: unknown;
     proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
+    searchHotKey?: "o" | "n" | "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
     servers?: any[] | undefined;
     showSidebar?: unknown;
     theme?: unknown;
@@ -446,13 +447,13 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     hiddenClients: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>, z.ZodArray<z.ZodString, "many">, z.ZodLiteral<true>]>>;
     /** Determine the HTTP client that's selected by default */
     defaultHttpClient: z.ZodOptional<z.ZodObject<{
-        targetKey: z.ZodType<"c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart", z.ZodTypeDef, "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart">;
+        targetKey: z.ZodType<"http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart", z.ZodTypeDef, "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart">;
         clientKey: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
+        targetKey: "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
         clientKey: string;
     }, {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
+        targetKey: "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
         clientKey: string;
     }>>;
     /** Custom CSS to be added to the page */
@@ -462,7 +463,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     /** onServerChange is fired on selected server change */
     onServerChange: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
     /** onDocumentSelect is fired when the config is selected */
-    onDocumentSelect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodVoid>>;
+    onDocumentSelect: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>>;
     /**
      * Route using paths instead of hashes, your server MUST support this
      * @example '/standalone-api-reference/:custom(.*)?'
@@ -620,7 +621,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     authentication?: any;
     baseServerURL?: string | undefined;
     proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
+    searchHotKey?: "o" | "n" | "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
     servers?: any[] | undefined;
     _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
     proxy?: string | undefined;
@@ -630,13 +631,13 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     favicon?: string | undefined;
     hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
     defaultHttpClient?: {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
+        targetKey: "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
         clientKey: string;
     } | undefined;
     customCss?: string | undefined;
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    onDocumentSelect?: ((...args: unknown[]) => void) | undefined;
+    onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -679,7 +680,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     baseServerURL?: string | undefined;
     hideClientButton?: unknown;
     proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
+    searchHotKey?: "o" | "n" | "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
     servers?: any[] | undefined;
     showSidebar?: unknown;
     theme?: unknown;
@@ -699,13 +700,13 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     favicon?: string | undefined;
     hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
     defaultHttpClient?: {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
+        targetKey: "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
         clientKey: string;
     } | undefined;
     customCss?: string | undefined;
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    onDocumentSelect?: ((...args: unknown[]) => void) | undefined;
+    onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -760,7 +761,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     authentication?: any;
     baseServerURL?: string | undefined;
     proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
+    searchHotKey?: "o" | "n" | "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
     servers?: any[] | undefined;
     _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
     proxy?: string | undefined;
@@ -770,13 +771,13 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     favicon?: string | undefined;
     hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
     defaultHttpClient?: {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
+        targetKey: "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
         clientKey: string;
     } | undefined;
     customCss?: string | undefined;
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    onDocumentSelect?: ((...args: unknown[]) => void) | undefined;
+    onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -819,7 +820,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     baseServerURL?: string | undefined;
     hideClientButton?: unknown;
     proxyUrl?: string | undefined;
-    searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
+    searchHotKey?: "o" | "n" | "c" | "r" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
     servers?: any[] | undefined;
     showSidebar?: unknown;
     theme?: unknown;
@@ -839,13 +840,13 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     favicon?: string | undefined;
     hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
     defaultHttpClient?: {
-        targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
+        targetKey: "http" | "c" | "clojure" | "csharp" | "go" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
         clientKey: string;
     } | undefined;
     customCss?: string | undefined;
     onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
     onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
-    onDocumentSelect?: ((...args: unknown[]) => void) | undefined;
+    onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
     pathRouting?: {
         basePath: string;
     } | undefined;
@@ -876,7 +877,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
     operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
 }>;
 /** Configuration after parsing, this is the main type */
-export type ApiReferenceConfiguration = Omit<z.infer<typeof apiReferenceConfigurationSchema>, 'proxy' | 'spec'>;
+export type ApiReferenceConfiguration = Omit<z.infer<typeof apiReferenceConfigurationSchema>, 'proxy' | 'spec'> & {
+    authentication?: AuthenticationConfiguration;
+};
 /** Api Config which includes the default config */
 type ApiReferenceConfigurationWithDefault = ApiReferenceConfiguration & {
     /** Whether to use this config as the default one */

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;AA8EvB,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,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,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;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,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

@@ -285,7 +285,7 @@ const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(z.ob
     /** onServerChange is fired on selected server change */
     onServerChange: z.function().args(z.string()).returns(z.void()).optional(),
     /** onDocumentSelect is fired when the config is selected */
-    onDocumentSelect: z.function().returns(z.void()).optional(),
+    onDocumentSelect: z.function().returns(z.void().or(z.void().promise())).optional(),
     /**
      * Route using paths instead of hashes, your server MUST support this
      * @example '/standalone-api-reference/:custom(.*)?'

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

@@ -0,0 +1,53 @@
+import type { SecurityScheme } from '../entities/security-scheme.ts';
+import type { PartialDeep } from 'type-fest/source/partial-deep.ts';
+/**
+ * Authentication configuration for the API reference.
+ * This config is not validated so does not need a zod schema
+ */
+export type AuthenticationConfiguration = {
+    /**
+     * Specifies the preferred security scheme(s) to use for authentication.
+     * Can be one of:
+     * - A single security scheme name (string)
+     * - An array of security scheme names (OR relationship)
+     * - An array containing strings or arrays of strings (AND/OR relationship)
+     */
+    preferredSecurityScheme?: string | (string | string[])[] | null;
+    /**
+     * Setting security schemes this way will allow you to override any value in your openapi document
+     * You will also be able to set additional values such as api tokens etc.
+     *
+     * Set them via the nameKey in your components.securitySchemes.[nameKey]
+     *
+     * @example
+     * ```ts
+     * {
+     *   authentication: {
+     *     preferredSecurityScheme: 'apiKeyHeader',
+     *     securitySchemes: {
+     *       apiKeyHeader: {
+     *         value: 'tokenValue'
+     *       },
+     *       httpBearer: {
+     *         token: 'xyz token value'
+     *       },
+     *       httpBasic: {
+     *         username: 'username',
+     *         password: 'password'
+     *       },
+     *       oauth2: {
+     *         flows: {
+     *           authorizationCode: {
+     *             token: 'auth code token'
+     *           }
+     *         }
+     *       },
+     *     },
+     *   }
+     * }
+     * ```
+     *
+     */
+    securitySchemes?: Record<string, PartialDeep<SecurityScheme>>;
+};
+//# sourceMappingURL=authentication-configuration.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"authentication-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/authentication-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAA;AAEnE;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,GAAG,IAAI,CAAA;IAE/D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC,CAAA;CAC9D,CAAA"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=authentication-configuration.test-d.d.ts.map

package/dist/api-reference/authentication-configuration.test-d.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authentication-configuration.test-d.d.ts","sourceRoot":"","sources":["../../src/api-reference/authentication-configuration.test-d.ts"],"names":[],"mappings":""}

package/dist/entities/index.d.ts

@@ -0,0 +1,2 @@
+export { type Oauth2Flow, type Oauth2FlowPayload, type SecuritySchemaHttp, type SecuritySchemaOpenId, type SecurityScheme, type SecuritySchemeApiKey, type SecuritySchemeOauth2, type SecuritySchemeOauth2Payload, type SecuritySchemePayload, oasSecurityRequirementSchema, oasSecuritySchemeSchema, pkceOptions, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeSchema, } from './security-scheme.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/entities/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/entities/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,qBAAqB,EAC1B,4BAA4B,EAC5B,uBAAuB,EACvB,WAAW,EACX,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,sBAAsB,CAAA"}

package/dist/entities/index.js

@@ -0,0 +1 @@
+export { oasSecurityRequirementSchema, oasSecuritySchemeSchema, pkceOptions, securityApiKeySchema, securityHttpSchema, securityOauthSchema, securityOpenIdSchema, securitySchemeSchema } from './security-scheme.js';