@scalar/types 0.9.6 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @scalar/types
2
2
 
3
+ ## 0.11.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#9211](https://github.com/scalar/scalar/pull/9211): feat: write pure types without using the zod schemas
8
+
9
+ ## 0.10.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [#8844](https://github.com/scalar/scalar/pull/8844): feat: write pure types without using the zod schemas
14
+
3
15
  ## 0.9.6
4
16
 
5
17
  ## 0.9.5
@@ -50,14 +50,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodObject<{
50
50
  servers: z.ZodOptional<z.ZodArray<z.ZodAny>>;
51
51
  showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
52
52
  showDeveloperTools: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
53
- never: "never";
54
- always: "always";
55
53
  localhost: "localhost";
54
+ always: "always";
55
+ never: "never";
56
56
  }>>>>;
57
57
  showToolbar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
58
- never: "never";
59
- always: "always";
60
58
  localhost: "localhost";
59
+ always: "always";
60
+ never: "never";
61
61
  }>>>>;
62
62
  operationTitleSource: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
63
63
  summary: "summary";
@@ -173,14 +173,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodObject<{
173
173
  servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
174
174
  showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
175
175
  showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
176
- never: "never";
177
- always: "always";
178
176
  localhost: "localhost";
177
+ always: "always";
178
+ never: "never";
179
179
  }>>>>>;
180
180
  showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
181
- never: "never";
182
- always: "always";
183
181
  localhost: "localhost";
182
+ always: "always";
183
+ never: "never";
184
184
  }>>>>>;
185
185
  operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
186
186
  summary: "summary";
@@ -301,14 +301,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodObject<{
301
301
  servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
302
302
  showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
303
303
  showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
304
- never: "never";
305
- always: "always";
306
304
  localhost: "localhost";
305
+ always: "always";
306
+ never: "never";
307
307
  }>>>>>;
308
308
  showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
309
- never: "never";
310
- always: "always";
311
309
  localhost: "localhost";
310
+ always: "always";
311
+ never: "never";
312
312
  }>>>>>;
313
313
  operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
314
314
  summary: "summary";
@@ -398,9 +398,9 @@ export declare const apiReferenceConfigurationSchema: z.ZodObject<{
398
398
  hideModels: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
399
399
  documentDownloadType: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
400
400
  none: "none";
401
+ both: "both";
401
402
  yaml: "yaml";
402
403
  json: "json";
403
- both: "both";
404
404
  direct: "direct";
405
405
  }>>>>;
406
406
  hideDownloadButton: z.ZodOptional<z.ZodBoolean>;
@@ -417,7 +417,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodObject<{
417
417
  favicon: z.ZodOptional<z.ZodString>;
418
418
  hiddenClients: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>, z.ZodArray<z.ZodString>, z.ZodLiteral<true>]>>;
419
419
  defaultHttpClient: z.ZodOptional<z.ZodObject<{
420
- targetKey: z.ZodCustom<"c" | "r" | "go" | "rust" | "http" | "clojure" | "csharp" | "dart" | "fsharp" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "ruby" | "shell" | "swift", "c" | "r" | "go" | "rust" | "http" | "clojure" | "csharp" | "dart" | "fsharp" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "ruby" | "shell" | "swift">;
420
+ targetKey: z.ZodCustom<"http" | "c" | "r" | "go" | "rust" | "clojure" | "csharp" | "dart" | "fsharp" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "ruby" | "shell" | "swift", "http" | "c" | "r" | "go" | "rust" | "clojure" | "csharp" | "dart" | "fsharp" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "ruby" | "shell" | "swift">;
421
421
  clientKey: z.ZodString;
422
422
  }, z.core.$strip>>;
423
423
  customCss: z.ZodOptional<z.ZodString>;
@@ -541,6 +541,4 @@ export type ApiReferenceConfigurationWithMultipleSources = ApiReferenceConfigura
541
541
  };
542
542
  /** Configuration for multiple Api References */
543
543
  export type AnyApiReferenceConfiguration = Partial<ApiReferenceConfigurationWithSource> | Partial<ApiReferenceConfigurationWithMultipleSources> | Partial<ApiReferenceConfigurationWithSource>[] | Partial<ApiReferenceConfigurationWithMultipleSources>[];
544
- /** Typeguard to check to narrow the configs to the one with sources */
545
- export declare const isConfigurationWithSources: (config: AnyApiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithMultipleSources>;
546
544
  //# sourceMappingURL=api-reference-configuration.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIrC,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AAEjF,OAAO,EAAE,KAAK,mBAAmB,EAA6B,MAAM,wBAAwB,CAAA;AAK5F;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6CAZH,MAAM,GAAG,GAAG,GAAG,OAAO,SAAS,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,UAAhE,MAAM,GAAG,GAAG,GAAG,OAAO,SAAS,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAoItF,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;cAE/B,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;qBAcnF,CAAC,CAAC,OAAO,CACtB,CAAC,CAAC,CAAC,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,cAAc,EAAE,GAAG,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAC9G,SAAS,CACZ;gBAWgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;oBAW5D,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoM7E,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,EAAE,+BAA+B;AAChF,AADiD,+BAA+B;AAChF,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CACpD,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,GAAG;IACrE;;;OAGG;IACH,GAAG,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QACxB,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,GAAG,CAAA;QACnB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;CACvC,CAAA;AAED,oDAAoD;AAGpD,0CAA0C;AAC1C,eAAO,MAAM,yCAAyC,EAAE,OAAO,CAC7D,IAAI,CAAC,yBAAyB,EAAE,KAAK,GAAG,SAAS,CAAC,GAAG,mBAAmB,CAgExE,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,IAAI,CACpD,CAAC,CAAC,KAAK,CAAC,OAAO,yCAAyC,CAAC,EAEzD,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CACpD,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GAAG,mCAAmC,GAAG;IAC/F,OAAO,EAAE,mBAAmB,EAAE,CAAA;CAC/B,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,OAAO,CAAC,mCAAmC,CAAC,GAC5C,OAAO,CAAC,4CAA4C,CAAC,GACrD,OAAO,CAAC,mCAAmC,CAAC,EAAE,GAC9C,OAAO,CAAC,4CAA4C,CAAC,EAAE,CAAA;AAE3D,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,GACrC,QAAQ,4BAA4B,KACnC,MAAM,IAAI,OAAO,CAAC,4CAA4C,CACkC,CAAA"}
1
+ {"version":3,"file":"api-reference-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-reference-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIrC,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AAEjF,OAAO,EAAE,KAAK,mBAAmB,EAA6B,MAAM,wBAAwB,CAAA;AAK5F;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6CAZH,MAAM,GAAG,GAAG,GAAG,OAAO,SAAS,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,UAAhE,MAAM,GAAG,GAAG,GAAG,OAAO,SAAS,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAoItF,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;cAE/B,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;qBAcnF,CAAC,CAAC,OAAO,CACtB,CAAC,CAAC,CAAC,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,cAAc,EAAE,GAAG,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAC9G,SAAS,CACZ;gBAWgB,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;oBAW5D,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoM7E,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,EAAE,+BAA+B;AAChF,AADiD,+BAA+B;AAChF,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CACpD,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,GAAG;IACrE;;;OAGG;IACH,GAAG,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QACxB,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,GAAG,CAAA;QACnB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;CACvC,CAAA;AAED,oDAAoD;AAGpD,0CAA0C;AAC1C,eAAO,MAAM,yCAAyC,EAAE,OAAO,CAC7D,IAAI,CAAC,yBAAyB,EAAE,KAAK,GAAG,SAAS,CAAC,GAAG,mBAAmB,CAgExE,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,IAAI,CACpD,CAAC,CAAC,KAAK,CAAC,OAAO,yCAAyC,CAAC,EAEzD,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CACpD,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GAAG,mCAAmC,GAAG;IAC/F,OAAO,EAAE,mBAAmB,EAAE,CAAA;CAC/B,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,OAAO,CAAC,mCAAmC,CAAC,GAC5C,OAAO,CAAC,4CAA4C,CAAC,GACrD,OAAO,CAAC,mCAAmC,CAAC,EAAE,GAC9C,OAAO,CAAC,4CAA4C,CAAC,EAAE,CAAA"}
@@ -412,5 +412,3 @@ export const apiReferenceConfigurationWithSourceSchema = apiReferenceConfigurati
412
412
  }
413
413
  return configuration;
414
414
  });
415
- /** Typeguard to check to narrow the configs to the one with sources */
416
- export const isConfigurationWithSources = (config) => Boolean(!Array.isArray(config) && config && 'sources' in config && Array.isArray(config.sources));
@@ -50,14 +50,14 @@ declare const lifecycleHooksSchema: z.ZodObject<{
50
50
  servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
51
51
  showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
52
52
  showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
53
- never: "never";
54
- always: "always";
55
53
  localhost: "localhost";
54
+ always: "always";
55
+ never: "never";
56
56
  }>>>>>;
57
57
  showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
58
- never: "never";
59
- always: "always";
60
58
  localhost: "localhost";
59
+ always: "always";
60
+ never: "never";
61
61
  }>>>>>;
62
62
  operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
63
63
  summary: "summary";
@@ -178,14 +178,14 @@ declare const lifecycleHooksSchema: z.ZodObject<{
178
178
  servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
179
179
  showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
180
180
  showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
181
- never: "never";
182
- always: "always";
183
181
  localhost: "localhost";
182
+ always: "always";
183
+ never: "never";
184
184
  }>>>>>;
185
185
  showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
186
- never: "never";
187
- always: "always";
188
186
  localhost: "localhost";
187
+ always: "always";
188
+ never: "never";
189
189
  }>>>>>;
190
190
  operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
191
191
  summary: "summary";
@@ -323,14 +323,14 @@ export declare const apiReferencePluginSchema: z.ZodFunction<z.ZodTuple<readonly
323
323
  servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
324
324
  showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
325
325
  showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
326
- never: "never";
327
- always: "always";
328
326
  localhost: "localhost";
327
+ always: "always";
328
+ never: "never";
329
329
  }>>>>>;
330
330
  showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
331
- never: "never";
332
- always: "always";
333
331
  localhost: "localhost";
332
+ always: "always";
333
+ never: "never";
334
334
  }>>>>>;
335
335
  operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
336
336
  summary: "summary";
@@ -451,14 +451,14 @@ export declare const apiReferencePluginSchema: z.ZodFunction<z.ZodTuple<readonly
451
451
  servers: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodAny>>>;
452
452
  showSidebar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>>;
453
453
  showDeveloperTools: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
454
- never: "never";
455
- always: "always";
456
454
  localhost: "localhost";
455
+ always: "always";
456
+ never: "never";
457
457
  }>>>>>;
458
458
  showToolbar: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
459
- never: "never";
460
- always: "always";
461
459
  localhost: "localhost";
460
+ always: "always";
461
+ never: "never";
462
462
  }>>>>>;
463
463
  operationTitleSource: z.ZodOptional<z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
464
464
  summary: "summary";
@@ -49,14 +49,14 @@ export declare const baseConfigurationSchema: z.ZodObject<{
49
49
  servers: z.ZodOptional<z.ZodArray<z.ZodAny>>;
50
50
  showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
51
51
  showDeveloperTools: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
52
- never: "never";
53
- always: "always";
54
52
  localhost: "localhost";
53
+ always: "always";
54
+ never: "never";
55
55
  }>>>>;
56
56
  showToolbar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
57
- never: "never";
58
- always: "always";
59
57
  localhost: "localhost";
58
+ always: "always";
59
+ never: "never";
60
60
  }>>>>;
61
61
  operationTitleSource: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
62
62
  summary: "summary";
@@ -1,4 +1,4 @@
1
- import type { AnyApiReferenceConfiguration } from './api-reference-configuration.js';
1
+ import type { AnyApiReferenceConfiguration } from './types.js';
2
2
  /**
3
3
  * This is a subset of the vue app type
4
4
  * Didn't want to add vue as a dependency just for this type so we stub whatever we need for the html api
@@ -1 +1 @@
1
- {"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../src/api-reference/html-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAA;AAEjF;;;GAGG;AACH,KAAK,GAAG,CAAC,WAAW,GAAG,GAAG,IAAI;IAC5B,KAAK,CAAC,aAAa,EAAE,WAAW,GAAG,MAAM,GAAG,OAAO,CAAA;IACnD,OAAO,IAAI,IAAI,CAAA;IACf,SAAS,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAA;CAChC,CAAA;AAED,wDAAwD;AACxD,MAAM,MAAM,oBAAoB,GAAG;IACjC,2BAA2B;IAC3B,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACjB,iDAAiD;IACjD,OAAO,EAAE,MAAM,IAAI,CAAA;IACnB,uCAAuC;IACvC,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;IACpD,kCAAkC;IAClC,mBAAmB,EAAE,CAAC,SAAS,EAAE,4BAA4B,KAAK,IAAI,CAAA;CACvE,CAAA;AAED,sFAAsF;AACtF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,qCAAqC;IACrC,CAAC,aAAa,EAAE,4BAA4B,GAAG,oBAAoB,CAAA;IACnE,wDAAwD;IACxD,CAAC,iBAAiB,EAAE,OAAO,GAAG,MAAM,EAAE,aAAa,EAAE,4BAA4B,GAAG,oBAAoB,CAAA;CACzG,CAAA"}
1
+ {"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../src/api-reference/html-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAA;AAE3D;;;GAGG;AACH,KAAK,GAAG,CAAC,WAAW,GAAG,GAAG,IAAI;IAC5B,KAAK,CAAC,aAAa,EAAE,WAAW,GAAG,MAAM,GAAG,OAAO,CAAA;IACnD,OAAO,IAAI,IAAI,CAAA;IACf,SAAS,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI,CAAA;CAChC,CAAA;AAED,wDAAwD;AACxD,MAAM,MAAM,oBAAoB,GAAG;IACjC,2BAA2B;IAC3B,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACjB,iDAAiD;IACjD,OAAO,EAAE,MAAM,IAAI,CAAA;IACnB,uCAAuC;IACvC,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;IACpD,kCAAkC;IAClC,mBAAmB,EAAE,CAAC,SAAS,EAAE,4BAA4B,KAAK,IAAI,CAAA;CACvE,CAAA;AAED,sFAAsF;AACtF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,qCAAqC;IACrC,CAAC,aAAa,EAAE,4BAA4B,GAAG,oBAAoB,CAAA;IACnE,wDAAwD;IACxD,CAAC,iBAAiB,EAAE,OAAO,GAAG,MAAM,EAAE,aAAa,EAAE,4BAA4B,GAAG,oBAAoB,CAAA;CACzG,CAAA"}
@@ -1,16 +1,11 @@
1
- import { z } from 'zod';
2
- import type { ApiReferenceConfigurationWithMultipleSources } from './api-reference-configuration.js';
3
- /**
4
- * Zod schema for HTML rendering configuration
5
- */
6
- export declare const htmlRenderingConfigurationSchema: z.ZodObject<{
7
- cdn: z.ZodDefault<z.ZodOptional<z.ZodString>>;
8
- pageTitle: z.ZodDefault<z.ZodOptional<z.ZodString>>;
9
- }, z.core.$strip>;
1
+ import type { ApiReferenceConfigurationWithMultipleSources } from './types.js';
10
2
  /**
11
3
  * The configuration for the static HTML rendering using the CDN.
12
4
  *
13
5
  * It's the ApiReferenceConfiguration, but extended with the `pageTitle` and `cdn` options.
14
6
  */
15
- export type HtmlRenderingConfiguration = Partial<ApiReferenceConfigurationWithMultipleSources> & z.infer<typeof htmlRenderingConfigurationSchema>;
7
+ export type HtmlRenderingConfiguration = Partial<ApiReferenceConfigurationWithMultipleSources> & {
8
+ pageTitle: string;
9
+ cdn: string;
10
+ };
16
11
  //# sourceMappingURL=html-rendering-configuration.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"html-rendering-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/html-rendering-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,KAAK,EAAE,4CAA4C,EAAE,MAAM,+BAA+B,CAAA;AAEjG;;GAEG;AACH,eAAO,MAAM,gCAAgC;;;iBAe3C,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC,4CAA4C,CAAC,GAC5F,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA"}
1
+ {"version":3,"file":"html-rendering-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/html-rendering-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4CAA4C,EAAE,MAAM,SAAS,CAAA;AAE3E;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAAC,4CAA4C,CAAC,GAAG;IAC/F,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA"}
@@ -1,20 +1 @@
1
- import { z } from 'zod';
2
- /**
3
- * Zod schema for HTML rendering configuration
4
- */
5
- export const htmlRenderingConfigurationSchema = z.object({
6
- /**
7
- * The URL to the Scalar API Reference JS CDN.
8
- *
9
- * Use this to pin a specific version of the Scalar API Reference.
10
- *
11
- * @default https://cdn.jsdelivr.net/npm/@scalar/api-reference
12
- *
13
- * @example https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.25.122
14
- */
15
- cdn: z.string().optional().default('https://cdn.jsdelivr.net/npm/@scalar/api-reference'),
16
- /**
17
- * The title of the page.
18
- */
19
- pageTitle: z.string().optional().default('Scalar API Reference'),
20
- });
1
+ export {};
@@ -1,10 +1,5 @@
1
- export { type ApiClientConfiguration, apiClientConfigurationSchema, } from './api-client-configuration.js';
2
- export { type ApiClientPlugin, apiClientPluginSchema, hooksSchema } from './api-client-plugin.js';
3
- export { type AnyApiReferenceConfiguration, type ApiReferenceConfiguration, type ApiReferenceConfigurationRaw, type ApiReferenceConfigurationWithMultipleSources, type ApiReferenceConfigurationWithSource, apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourceSchema, isConfigurationWithSources, } from './api-reference-configuration.js';
4
- export type { ApiReferencePlugin, LifecycleHooks, SpecificationExtension, ViewComponent, } from './api-reference-plugin.js';
5
- export type { AuthenticationConfiguration } from './authentication-configuration.js';
6
- export type { BaseConfiguration, ExternalUrls } from './base-configuration.js';
7
1
  export type { ApiReferenceInstance, CreateApiReference } from './html-api.js';
8
- export { type HtmlRenderingConfiguration, htmlRenderingConfigurationSchema, } from './html-rendering-configuration.js';
9
- export { type SourceConfiguration, sourceConfigurationSchema, } from './source-configuration.js';
2
+ export type { HtmlRenderingConfiguration } from './html-rendering-configuration.js';
3
+ export type { AnyApiReferenceConfiguration, ApiClientConfiguration, ApiReferenceConfiguration, ApiReferenceConfigurationRaw, ApiReferenceConfigurationWithMultipleSources, ApiReferenceConfigurationWithSource, ApiReferencePlugin, AuthenticationConfiguration, BaseConfiguration, ExternalUrls, LifecycleHooks, SecurityScheme, SecuritySchemeApiKey, SecuritySchemeHttp, SecuritySchemeOauth2, SecuritySchemeOpenIdConnect, SourceConfiguration, SpecificationExtension, ViewComponent, } from './types.js';
4
+ export { isConfigurationWithSources } from './types.js';
10
5
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,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,4BAA4B,EACjC,KAAK,4CAA4C,EACjD,KAAK,mCAAmC,EACxC,+BAA+B,EAC/B,yCAAyC,EACzC,0BAA0B,GAC3B,MAAM,+BAA+B,CAAA;AACtC,YAAY,EACV,kBAAkB,EAClB,cAAc,EACd,sBAAsB,EACtB,aAAa,GACd,MAAM,wBAAwB,CAAA;AAC/B,YAAY,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AACjF,YAAY,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC3E,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"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-reference/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAC1E,YAAY,EAAE,0BAA0B,EAAE,MAAM,gCAAgC,CAAA;AAChF,YAAY,EACV,4BAA4B,EAC5B,sBAAsB,EACtB,yBAAyB,EACzB,4BAA4B,EAC5B,4CAA4C,EAC5C,mCAAmC,EACnC,kBAAkB,EAClB,2BAA2B,EAC3B,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,2BAA2B,EAC3B,mBAAmB,EACnB,sBAAsB,EACtB,aAAa,GACd,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAA"}
@@ -1,5 +1 @@
1
- export { apiClientConfigurationSchema, } from './api-client-configuration.js';
2
- export { apiClientPluginSchema, hooksSchema } from './api-client-plugin.js';
3
- export { apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourceSchema, isConfigurationWithSources, } from './api-reference-configuration.js';
4
- export { htmlRenderingConfigurationSchema, } from './html-rendering-configuration.js';
5
- export { sourceConfigurationSchema, } from './source-configuration.js';
1
+ export { isConfigurationWithSources } from './types.js';
@@ -0,0 +1,434 @@
1
+ import type { PartialDeep } from 'type-fest';
2
+ /** Some common properties used in all security schemes */
3
+ type SecuirtySchemeCommon = {
4
+ description: string | undefined;
5
+ };
6
+ type ExtendedSecurityScheme = {
7
+ uid: any;
8
+ /** The name key that links a security requirement to a security object */
9
+ nameKey: string;
10
+ };
11
+ type SecuritySchemeApiKeyIn = 'query' | 'header' | 'cookie';
12
+ type OasSecurityApiKey = {
13
+ type: 'apiKey';
14
+ /** REQUIRED. The name of the header, query or cookie parameter to be used. */
15
+ name: string;
16
+ /** REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". */
17
+ in: SecuritySchemeApiKeyIn;
18
+ /** REQUIRED. The API key to be sent in the Authorization header or as a cookie. */
19
+ value: string;
20
+ };
21
+ export type SecuritySchemeApiKey = SecuirtySchemeCommon & ExtendedSecurityScheme & OasSecurityApiKey;
22
+ type OasSecurityHttp = {
23
+ type: 'http';
24
+ /** REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in
25
+ * [RFC7235]. The values used SHOULD be registered in the IANA Authentication Scheme registry. */
26
+ scheme: 'basic' | 'bearer';
27
+ /** A hint to the client to identify how the bearer token is formatted.
28
+ * Bearer tokens are usually generated by an authorization server, so
29
+ * this information is primarily for documentation purposes. */
30
+ bearerFormat: 'JWT' | string;
31
+ /** The username to be sent in the Authorization header. */
32
+ username: string;
33
+ /** The password to be sent in the Authorization header. */
34
+ password: string;
35
+ /** The token to be sent in the Authorization header. */
36
+ token: string;
37
+ };
38
+ export type SecuritySchemeHttp = SecuirtySchemeCommon & ExtendedSecurityScheme & OasSecurityHttp;
39
+ type OasSecurityOpenIdConnect = {
40
+ type: 'openIdConnect';
41
+ /** REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the
42
+ * form of a URL. The OpenID Connect standard requires the use of TLS. */
43
+ openIdConnectUrl: string;
44
+ };
45
+ export type SecuritySchemeOpenIdConnect = SecuirtySchemeCommon & ExtendedSecurityScheme & OasSecurityOpenIdConnect;
46
+ type FlowsCommon = {
47
+ /**
48
+ * The URL to be used for obtaining refresh tokens. This MUST be in the form of a
49
+ * URL. The OAuth2 standard requires the use of TLS.
50
+ */
51
+ 'refreshUrl'?: string;
52
+ /**
53
+ * REQUIRED. The available scopes for the OAuth2 security scheme. A map
54
+ * between the scope name and a short description for it. The map MAY be empty.
55
+ */
56
+ 'scopes'?: Record<string, string>;
57
+ 'selectedScopes'?: string[];
58
+ /** Extension to save the client Id associated with an oauth flow */
59
+ 'x-scalar-client-id'?: string;
60
+ /** The auth token */
61
+ 'token'?: string;
62
+ /** Additional query parameters for the OAuth authorization request. Example: { prompt: 'consent', audience: 'scalar' }. */
63
+ 'x-scalar-security-query'?: Record<string, string>;
64
+ /** Additional body parameters for the OAuth token request. Example: { audience: 'foo' }. */
65
+ 'x-scalar-security-body'?: Record<string, string>;
66
+ /** Extension to specify custom token name in the response (defaults to 'access_token') */
67
+ 'x-tokenName'?: string;
68
+ };
69
+ type PkceOptions = 'SHA-256' | 'plain' | 'no';
70
+ type CredentialsLocationExtension = 'header' | 'body';
71
+ type OasSecurityOauth2FlowImplicit = {
72
+ type: 'oauth2';
73
+ 'x-default-scopes'?: string[];
74
+ flows: {
75
+ implicit: FlowsCommon & {
76
+ type: 'implicit';
77
+ authorizationUrl: string;
78
+ 'x-scalar-redirect-uri'?: string;
79
+ };
80
+ password: FlowsCommon & {
81
+ type: 'password';
82
+ tokenUrl: string;
83
+ clientSecret: string;
84
+ username: string;
85
+ password: string;
86
+ 'x-scalar-credentials-location'?: CredentialsLocationExtension;
87
+ };
88
+ clientCredentials: FlowsCommon & {
89
+ type: 'clientCredentials';
90
+ tokenUrl: string;
91
+ clientSecret: string;
92
+ 'x-scalar-credentials-location'?: CredentialsLocationExtension;
93
+ };
94
+ authorizationCode: FlowsCommon & {
95
+ type: 'authorizationCode';
96
+ authorizationUrl: string;
97
+ tokenUrl: string;
98
+ clientSecret: string;
99
+ 'x-scalar-credentials-location'?: CredentialsLocationExtension;
100
+ 'x-usePkce'?: PkceOptions;
101
+ 'x-scalar-redirect-uri'?: string;
102
+ };
103
+ };
104
+ };
105
+ export type SecuritySchemeOauth2 = SecuirtySchemeCommon & ExtendedSecurityScheme & OasSecurityOauth2FlowImplicit;
106
+ export type SecurityScheme = SecuritySchemeApiKey | SecuritySchemeHttp | SecuritySchemeOpenIdConnect | SecuritySchemeOauth2;
107
+ /**
108
+ * Authentication configuration for the API reference.
109
+ * This config is not validated so does not need a zod schema
110
+ */
111
+ export type AuthenticationConfiguration = {
112
+ /**
113
+ * Specifies the preferred security scheme(s) to use for authentication.
114
+ * Can be one of:
115
+ * - A single security scheme name (string)
116
+ * - An array of security scheme names (OR relationship)
117
+ * - An array containing strings or arrays of strings (AND/OR relationship)
118
+ */
119
+ preferredSecurityScheme?: string | (string | string[])[] | null;
120
+ /**
121
+ * Setting security schemes this way will allow you to override any value in your openapi document
122
+ * You will also be able to set additional values such as api tokens etc.
123
+ *
124
+ * Set them via the nameKey in your components.securitySchemes.[nameKey]
125
+ *
126
+ * @example
127
+ * ```ts
128
+ * {
129
+ * authentication: {
130
+ * preferredSecurityScheme: 'apiKeyHeader',
131
+ * securitySchemes: {
132
+ * apiKeyHeader: {
133
+ * value: 'tokenValue'
134
+ * },
135
+ * httpBearer: {
136
+ * token: 'xyz token value'
137
+ * },
138
+ * httpBasic: {
139
+ * username: 'username',
140
+ * password: 'password'
141
+ * },
142
+ * oauth2: {
143
+ * flows: {
144
+ * authorizationCode: {
145
+ * token: 'auth code token'
146
+ * }
147
+ * }
148
+ * },
149
+ * },
150
+ * }
151
+ * }
152
+ * ```
153
+ *
154
+ */
155
+ securitySchemes?: Record<string, PartialDeep<SecurityScheme>>;
156
+ /**
157
+ * Allows adding authentication which is not in the document.
158
+ * When true, generic options (API Key, HTTP Basic, OAuth2, etc.) are shown in the auth dropdown.
159
+ * @default false
160
+ */
161
+ createAnySecurityScheme?: boolean;
162
+ };
163
+ export type SpecificationExtension = {
164
+ name: string;
165
+ component: unknown;
166
+ renderer?: unknown;
167
+ };
168
+ export type ViewComponent = {
169
+ component: unknown;
170
+ renderer?: unknown;
171
+ props?: Record<string, any>;
172
+ };
173
+ export type LifecycleHooks = {
174
+ onInit?: ({ config }: {
175
+ config: Partial<BaseConfiguration>;
176
+ }) => void;
177
+ onConfigChange?: ({ config }: {
178
+ config: Partial<BaseConfiguration>;
179
+ }) => void;
180
+ onDestroy?: () => void;
181
+ };
182
+ export type ApiReferencePlugin = () => {
183
+ name: string;
184
+ extensions: SpecificationExtension[];
185
+ views?: {
186
+ 'content.end'?: ViewComponent[];
187
+ };
188
+ hooks?: LifecycleHooks;
189
+ apiClientPlugins?: any[];
190
+ };
191
+ export type ExternalUrls = {
192
+ dashboardUrl: string;
193
+ registryUrl: string;
194
+ proxyUrl: string;
195
+ apiBaseUrl: string;
196
+ };
197
+ export type BaseConfiguration = {
198
+ /** The title of the OpenAPI document. */
199
+ title?: string;
200
+ /** 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 will just use the index. */
201
+ slug?: string;
202
+ /** Prefill authentication */
203
+ authentication?: any;
204
+ /** Base URL for the API server */
205
+ baseServerURL?: string;
206
+ /** Whether to hide the client button */
207
+ hideClientButton: boolean;
208
+ /** URL to a request proxy for the API client */
209
+ proxyUrl?: string;
210
+ /** Default OAuth 2.0 redirect URI used to prefill auth flows in the API client. */
211
+ oauth2RedirectUri?: string;
212
+ /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
213
+ searchHotKey?: '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';
214
+ /** List of OpenAPI server objects */
215
+ servers?: any[];
216
+ /** Whether to show the sidebar */
217
+ showSidebar: boolean;
218
+ /** Whether and when to show the developer tools. */
219
+ showDeveloperTools: 'localhost' | 'always' | 'never';
220
+ /** @deprecated Use showDeveloperTools instead */
221
+ showToolbar: 'localhost' | 'always' | 'never';
222
+ /** Whether to use the operation summary or the operation path for the sidebar and search */
223
+ operationTitleSource: 'summary' | 'path';
224
+ /** A string to use one of the color presets */
225
+ theme: 'default' | 'alternate' | 'moon' | 'purple' | 'solarized' | 'bluePlanet' | 'deepSpace' | 'saturn' | 'kepler' | 'elysiajs' | 'fastify' | 'mars' | 'laserwave' | 'none';
226
+ /** Integration type identifier */
227
+ _integration?: 'adonisjs' | 'astro' | 'docusaurus' | 'dotnet' | 'elysiajs' | 'express' | 'fastapi' | 'fastify' | 'go' | 'hono' | 'html' | 'laravel' | 'litestar' | 'nestjs' | 'nextjs' | 'nitro' | 'nuxt' | 'platformatic' | 'react' | 'rust' | 'svelte' | 'vue' | null;
228
+ /** onRequestSent is fired when a request is sent */
229
+ onRequestSent?: (input: string) => void;
230
+ /** Whether to persist auth to local storage */
231
+ persistAuth: boolean;
232
+ /** Enables / disables telemetry */
233
+ telemetry: boolean;
234
+ /** External service URLs used by Scalar packages */
235
+ externalUrls: ExternalUrls;
236
+ };
237
+ type ExtendedConfiguration = {
238
+ /** The layout to use for the references */
239
+ layout: 'modern' | 'classic';
240
+ /** @deprecated Use proxyUrl instead */
241
+ proxy?: string;
242
+ /** Custom fetch function for custom logic. Can be used to add custom headers, handle auth, etc. */
243
+ fetch?: typeof fetch;
244
+ /** Plugins for the API reference */
245
+ plugins?: ApiReferencePlugin[];
246
+ /** Allows the user to inject an editor for the spec */
247
+ isEditable: boolean;
248
+ /** Controls whether the references show a loading state in the intro */
249
+ isLoading: boolean;
250
+ /** Whether to show models in the sidebar, search, and content. */
251
+ hideModels: boolean;
252
+ /** Sets the file type of the document to download, set to `none` to hide the download button */
253
+ documentDownloadType: 'both' | 'yaml' | 'json' | 'direct' | 'none';
254
+ /** @deprecated Use `documentDownloadType: 'none'` instead */
255
+ hideDownloadButton?: boolean;
256
+ /** Whether to show the "Test Request" button */
257
+ hideTestRequestButton: boolean;
258
+ /** Whether to show the sidebar search bar */
259
+ hideSearch: boolean;
260
+ /** Whether to show the operationId */
261
+ showOperationId: boolean;
262
+ /** Whether dark mode is on or off initially (light mode) */
263
+ darkMode?: boolean;
264
+ /** forceDarkModeState makes it always this state no matter what */
265
+ forceDarkModeState?: 'dark' | 'light';
266
+ /** Whether to show the dark mode toggle */
267
+ hideDarkModeToggle: boolean;
268
+ /** If used, passed data will be added to the HTML header. @see https://unhead.unjs.io/usage/composables/use-seo-meta */
269
+ metaData?: any;
270
+ /** Path to a favicon image */
271
+ favicon?: string;
272
+ /** List of httpsnippet clients to hide from the clients menu. By default hides Unirest, pass `[]` to show all clients */
273
+ hiddenClients?: Record<string, boolean | string[]> | string[] | true;
274
+ /** Determine the HTTP client that is selected by default */
275
+ defaultHttpClient?: {
276
+ targetKey: string;
277
+ clientKey: string;
278
+ };
279
+ /** Custom CSS to be added to the page */
280
+ customCss?: string;
281
+ /** onSpecUpdate is fired on spec/swagger content change */
282
+ onSpecUpdate?: (input: string) => void;
283
+ /** onServerChange is fired on selected server change */
284
+ onServerChange?: (input: string) => void;
285
+ /** onDocumentSelect is fired when the config is selected */
286
+ onDocumentSelect?: () => void | Promise<void>;
287
+ /** Callback fired when the reference is fully loaded */
288
+ onLoaded?: (slug: string) => void | Promise<void>;
289
+ /** Fired before the outbound request is built; callback receives a mutable request builder. Experimental API. */
290
+ onBeforeRequest?: ((input: {
291
+ request: Request;
292
+ requestBuilder: any;
293
+ envVariables: Record<string, string>;
294
+ }) => void | Promise<void>) | undefined;
295
+ /** onShowMore is fired when the user clicks the "Show more" button on the references */
296
+ onShowMore?: (tagId: string) => void | Promise<void>;
297
+ /** onSidebarClick is fired when the user clicks on a sidebar item */
298
+ onSidebarClick?: (href: string) => void | Promise<void>;
299
+ /** Route using paths instead of hashes, your server MUST support this. @experimental */
300
+ pathRouting?: {
301
+ basePath: string;
302
+ };
303
+ /** MCP (Model Context Protocol) configuration. When provided, enables MCP integration with the given name and url. */
304
+ mcp?: {
305
+ /** Display name for the MCP server */
306
+ name?: string;
307
+ /** URL of the MCP server */
308
+ url?: string;
309
+ /** When true, disables the MCP integration */
310
+ disabled?: boolean;
311
+ };
312
+ /** Customize the heading portion of the hash */
313
+ generateHeadingSlug?: (input: {
314
+ slug?: string;
315
+ }) => string;
316
+ /** Customize the model portion of the hash */
317
+ generateModelSlug?: (input: {
318
+ name?: string;
319
+ }) => string;
320
+ /** Customize the tag portion of the hash */
321
+ generateTagSlug?: (input: {
322
+ name?: string;
323
+ }) => string;
324
+ /** Customize the operation portion of the hash */
325
+ generateOperationSlug?: (input: {
326
+ path: string;
327
+ operationId?: string;
328
+ method: string;
329
+ summary?: string;
330
+ }) => string;
331
+ /** Customize the webhook portion of the hash */
332
+ generateWebhookSlug?: (input: {
333
+ name: string;
334
+ method?: string;
335
+ }) => string;
336
+ /** To handle redirects, pass a function that receives the current path/hash and passes that to history.replaceState */
337
+ redirect?: (input: string) => string | null | undefined;
338
+ /** Whether to include default fonts */
339
+ withDefaultFonts: boolean;
340
+ /** Whether to expand the first tag in the sidebar when no specific URL target is present */
341
+ defaultOpenFirstTag: boolean;
342
+ /** Whether to expand all tags by default. Warning: this can cause performance issues on big documents */
343
+ defaultOpenAllTags: boolean;
344
+ /** Whether to expand all models by default. Warning: this can cause performance issues on big documents */
345
+ expandAllModelSections: boolean;
346
+ /** Whether to expand all responses by default. Warning: this can cause performance issues on big documents */
347
+ expandAllResponses: boolean;
348
+ /** Function to sort tags */
349
+ tagsSorter?: 'alpha' | ((a: any, b: any) => number);
350
+ /** Function to sort operations */
351
+ operationsSorter?: 'alpha' | 'method' | ((a: any, b: any) => number);
352
+ /** Order the schema properties by */
353
+ orderSchemaPropertiesBy: 'alpha' | 'preserve';
354
+ /** Sort the schema properties by required ones first */
355
+ orderRequiredPropertiesFirst: boolean;
356
+ };
357
+ export type SourceConfiguration = {
358
+ default?: boolean;
359
+ /** URL to an OpenAPI/Swagger document */
360
+ url?: string;
361
+ /** Directly embed the OpenAPI document. Can be a string, object, function returning an object, or null. It is recommended to pass a URL instead of content. */
362
+ content?: string | null | Record<string, any> | (() => string | any);
363
+ /** The title of the OpenAPI document. @deprecated Please move `title` to the top level and remove the `spec` prefix. */
364
+ title?: string;
365
+ /** The slug of the OpenAPI document used in the URL. @deprecated Please move `slug` to the top level and remove the `spec` prefix. */
366
+ slug?: string;
367
+ /** @deprecated Use `url` and `content` on the top level instead. */
368
+ spec?: {
369
+ url?: string;
370
+ content?: string | null | Record<string, any> | (() => string | any);
371
+ };
372
+ /** Agent Scalar configuration */
373
+ agent?: {
374
+ key?: string;
375
+ disabled?: boolean;
376
+ /** When true, hide the control to add more APIs in the agent chat. Only preloaded/registry documents are shown; the public API list is not offered. */
377
+ hideAddApi?: boolean;
378
+ };
379
+ };
380
+ export type ApiReferenceConfigurationRaw = Omit<BaseConfiguration & ExtendedConfiguration, 'proxy' | 'spec' | 'authentication' | 'showToolbar'> & {
381
+ authentication?: AuthenticationConfiguration;
382
+ };
383
+ export type ApiReferenceConfiguration = ApiReferenceConfigurationRaw & {
384
+ /** @deprecated
385
+ * This type now refers to the base configuration that does not include the sources.
386
+ * Use the type `ApiReferenceConfigurationWithSource` instead.
387
+ */
388
+ url?: SourceConfiguration['url'];
389
+ /** @deprecated
390
+ * This type now refers to the base configuration that does not include the sources.
391
+ * Use the type `ApiReferenceConfigurationWithSource` instead.
392
+ */
393
+ content?: SourceConfiguration['content'];
394
+ /**
395
+ * Fired before the outbound request is built and sent. Mutate the **request builder** so the eventual fetch call
396
+ * reflects your changes (method, path, headers, body, and related fields).
397
+ *
398
+ * **Experimental:** The builder matches {@link https://github.com/scalar/scalar/blob/main/packages/workspace-store/src/request-example/builder/request-factory.ts RequestFactory}
399
+ * (`import type { RequestFactory } from '@scalar/workspace-store/request-example'`). That shape is still experimental and may change in minor releases.
400
+ *
401
+ * @param input - Hook argument from the integration layer.
402
+ * @param input.request - **Deprecated** when treated as a fetch API `Request`. Prefer thinking of this value as the
403
+ * mutable builder ({@link https://github.com/scalar/scalar/blob/main/packages/workspace-store/src/request-example/builder/request-factory.ts RequestFactory}).
404
+ * Some call sites only pass this property.
405
+ * @param input.requestBuilder - The same builder when exposed under this name; **prefer** mutating this when your integration provides it.
406
+ * @returns void or a promise that resolves when the hook finishes
407
+ * @example
408
+ * ```ts
409
+ * onBeforeRequest: ({ request: builder }) => {
410
+ * builder.headers.set('Authorization', 'Bearer <token>')
411
+ * }
412
+ * ```
413
+ */
414
+ onBeforeRequest?: (input: {
415
+ request: Request;
416
+ requestBuilder: any;
417
+ envVariables: Record<string, string>;
418
+ }) => void | Promise<void> | undefined;
419
+ };
420
+ export type ApiReferenceConfigurationWithSource = Omit<ApiReferenceConfiguration, 'url' | 'content'> & SourceConfiguration;
421
+ /**
422
+ * Configuration for a single config with multiple sources
423
+ * The configuration will be shared between the documents
424
+ */
425
+ export type ApiReferenceConfigurationWithMultipleSources = ApiReferenceConfigurationWithSource & {
426
+ sources: SourceConfiguration[];
427
+ };
428
+ /** Configuration for multiple Api References */
429
+ export type AnyApiReferenceConfiguration = Partial<ApiReferenceConfigurationWithSource> | Partial<ApiReferenceConfigurationWithMultipleSources> | Partial<ApiReferenceConfigurationWithSource>[] | Partial<ApiReferenceConfigurationWithMultipleSources>[];
430
+ /** Typeguard to check to narrow the configs to the one with sources */
431
+ export declare const isConfigurationWithSources: (config: AnyApiReferenceConfiguration) => config is Partial<ApiReferenceConfigurationWithMultipleSources>;
432
+ export type ApiClientConfiguration = BaseConfiguration & SourceConfiguration;
433
+ export {};
434
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/api-reference/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAE5C,0DAA0D;AAC1D,KAAK,oBAAoB,GAAG;IAE1B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CAChC,CAAA;AAGD,KAAK,sBAAsB,GAAG;IAC5B,GAAG,EAAE,GAAG,CAAA;IACR,0EAA0E;IAC1E,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,sBAAsB,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAE3D,KAAK,iBAAiB,GAAG;IACvB,IAAI,EAAE,QAAQ,CAAA;IACd,8EAA8E;IAC9E,IAAI,EAAE,MAAM,CAAA;IACZ,6FAA6F;IAC7F,EAAE,EAAE,sBAAsB,CAAA;IAC1B,mFAAmF;IACnF,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,iBAAiB,CAAA;AAGpG,KAAK,eAAe,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ;qGACiG;IACjG,MAAM,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC1B;;mEAE+D;IAC/D,YAAY,EAAE,KAAK,GAAG,MAAM,CAAA;IAC5B,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAA;IAChB,2DAA2D;IAC3D,QAAQ,EAAE,MAAM,CAAA;IAChB,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,eAAe,CAAA;AAIhG,KAAK,wBAAwB,GAAG;IAC9B,IAAI,EAAE,eAAe,CAAA;IACrB;6EACyE;IACzE,gBAAgB,EAAE,MAAM,CAAA;CACzB,CAAA;AACD,MAAM,MAAM,2BAA2B,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,wBAAwB,CAAA;AAIlH,KAAK,WAAW,GAAG;IACjB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACjC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,MAAM,CAAA;IAC7B,qBAAqB;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,2HAA2H;IAC3H,yBAAyB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClD,4FAA4F;IAC5F,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACjD,0FAA0F;IAC1F,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED,KAAK,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAAA;AAE7C,KAAK,4BAA4B,GAAG,QAAQ,GAAG,MAAM,CAAA;AAErD,KAAK,6BAA6B,GAAG;IACnC,IAAI,EAAE,QAAQ,CAAA;IACd,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC7B,KAAK,EAAE;QACL,QAAQ,EAAE,WAAW,GAAG;YACtB,IAAI,EAAE,UAAU,CAAA;YAChB,gBAAgB,EAAE,MAAM,CAAA;YACxB,uBAAuB,CAAC,EAAE,MAAM,CAAA;SACjC,CAAA;QACD,QAAQ,EAAE,WAAW,GAAG;YACtB,IAAI,EAAE,UAAU,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;YAChB,YAAY,EAAE,MAAM,CAAA;YACpB,QAAQ,EAAE,MAAM,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;YAChB,+BAA+B,CAAC,EAAE,4BAA4B,CAAA;SAC/D,CAAA;QACD,iBAAiB,EAAE,WAAW,GAAG;YAC/B,IAAI,EAAE,mBAAmB,CAAA;YACzB,QAAQ,EAAE,MAAM,CAAA;YAChB,YAAY,EAAE,MAAM,CAAA;YACpB,+BAA+B,CAAC,EAAE,4BAA4B,CAAA;SAC/D,CAAA;QACD,iBAAiB,EAAE,WAAW,GAAG;YAC/B,IAAI,EAAE,mBAAmB,CAAA;YACzB,gBAAgB,EAAE,MAAM,CAAA;YACxB,QAAQ,EAAE,MAAM,CAAA;YAChB,YAAY,EAAE,MAAM,CAAA;YACpB,+BAA+B,CAAC,EAAE,4BAA4B,CAAA;YAC9D,WAAW,CAAC,EAAE,WAAW,CAAA;YACzB,uBAAuB,CAAC,EAAE,MAAM,CAAA;SACjC,CAAA;KACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,GAAG,sBAAsB,GAAG,6BAA6B,CAAA;AAGhH,MAAM,MAAM,cAAc,GACtB,oBAAoB,GACpB,kBAAkB,GAClB,2BAA2B,GAC3B,oBAAoB,CAAA;AAExB;;;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;IAC7D;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IACrE,cAAc,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE;QAAE,MAAM,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IAC7E,SAAS,CAAC,EAAE,MAAM,IAAI,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,MAAM;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,sBAAsB,EAAE,CAAA;IACpC,KAAK,CAAC,EAAE;QACN,aAAa,CAAC,EAAE,aAAa,EAAE,CAAA;KAChC,CAAA;IACD,KAAK,CAAC,EAAE,cAAc,CAAA;IACtB,gBAAgB,CAAC,EAAE,GAAG,EAAE,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,oJAAoJ;IACpJ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,6BAA6B;IAC7B,cAAc,CAAC,EAAE,GAAG,CAAA;IACpB,kCAAkC;IAClC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,wCAAwC;IACxC,gBAAgB,EAAE,OAAO,CAAA;IACzB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,mFAAmF;IACnF,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B,mFAAmF;IACnF,YAAY,CAAC,EACT,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA;IACP,qCAAqC;IACrC,OAAO,CAAC,EAAE,GAAG,EAAE,CAAA;IACf,kCAAkC;IAClC,WAAW,EAAE,OAAO,CAAA;IACpB,oDAAoD;IACpD,kBAAkB,EAAE,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAA;IACpD,iDAAiD;IACjD,WAAW,EAAE,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAA;IAC7C,4FAA4F;IAC5F,oBAAoB,EAAE,SAAS,GAAG,MAAM,CAAA;IACxC,+CAA+C;IAC/C,KAAK,EACD,SAAS,GACT,WAAW,GACX,MAAM,GACN,QAAQ,GACR,WAAW,GACX,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,UAAU,GACV,SAAS,GACT,MAAM,GACN,WAAW,GACX,MAAM,CAAA;IACV,kCAAkC;IAClC,YAAY,CAAC,EACT,UAAU,GACV,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,UAAU,GACV,SAAS,GACT,SAAS,GACT,SAAS,GACT,IAAI,GACJ,MAAM,GACN,MAAM,GACN,SAAS,GACT,UAAU,GACV,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,cAAc,GACd,OAAO,GACP,MAAM,GACN,QAAQ,GACR,KAAK,GACL,IAAI,CAAA;IACR,oDAAoD;IACpD,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACvC,+CAA+C;IAC/C,WAAW,EAAE,OAAO,CAAA;IACpB,mCAAmC;IACnC,SAAS,EAAE,OAAO,CAAA;IAClB,oDAAoD;IACpD,YAAY,EAAE,YAAY,CAAA;CAC3B,CAAA;AAED,KAAK,qBAAqB,GAAG;IAC3B,2CAA2C;IAC3C,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC5B,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,mGAAmG;IACnG,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;IACpB,oCAAoC;IACpC,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAC9B,uDAAuD;IACvD,UAAU,EAAE,OAAO,CAAA;IACnB,wEAAwE;IACxE,SAAS,EAAE,OAAO,CAAA;IAClB,kEAAkE;IAClE,UAAU,EAAE,OAAO,CAAA;IACnB,gGAAgG;IAChG,oBAAoB,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAA;IAClE,6DAA6D;IAC7D,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,gDAAgD;IAChD,qBAAqB,EAAE,OAAO,CAAA;IAC9B,6CAA6C;IAC7C,UAAU,EAAE,OAAO,CAAA;IACnB,sCAAsC;IACtC,eAAe,EAAE,OAAO,CAAA;IACxB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,mEAAmE;IACnE,kBAAkB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IACrC,2CAA2C;IAC3C,kBAAkB,EAAE,OAAO,CAAA;IAC3B,wHAAwH;IACxH,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,yHAAyH;IACzH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IACpE,4DAA4D;IAC5D,iBAAiB,CAAC,EAAE;QAClB,SAAS,EAAE,MAAM,CAAA;QACjB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACtC,wDAAwD;IACxD,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACxC,4DAA4D;IAC5D,gBAAgB,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC7C,wDAAwD;IACxD,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACjD,iHAAiH;IACjH,eAAe,CAAC,EACZ,CAAC,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,cAAc,EAAE,GAAG,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,GAClH,SAAS,CAAA;IACb,wFAAwF;IACxF,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpD,qEAAqE;IACrE,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACvD,wFAAwF;IACxF,WAAW,CAAC,EAAE;QACZ,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,sHAAsH;IACtH,GAAG,CAAC,EAAE;QACJ,sCAAsC;QACtC,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,4BAA4B;QAC5B,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,8CAA8C;QAC9C,QAAQ,CAAC,EAAE,OAAO,CAAA;KACnB,CAAA;IACD,gDAAgD;IAChD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAC1D,8CAA8C;IAC9C,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IACxD,4CAA4C;IAC5C,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IACtD,kDAAkD;IAClD,qBAAqB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IACnH,gDAAgD;IAChD,mBAAmB,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,CAAA;IAC1E,uHAAuH;IACvH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IACvD,uCAAuC;IACvC,gBAAgB,EAAE,OAAO,CAAA;IACzB,4FAA4F;IAC5F,mBAAmB,EAAE,OAAO,CAAA;IAC5B,yGAAyG;IACzG,kBAAkB,EAAE,OAAO,CAAA;IAC3B,2GAA2G;IAC3G,sBAAsB,EAAE,OAAO,CAAA;IAC/B,8GAA8G;IAC9G,kBAAkB,EAAE,OAAO,CAAA;IAC3B,4BAA4B;IAC5B,UAAU,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,CAAA;IACnD,kCAAkC;IAClC,gBAAgB,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,MAAM,CAAC,CAAA;IACpE,qCAAqC;IACrC,uBAAuB,EAAE,OAAO,GAAG,UAAU,CAAA;IAC7C,wDAAwD;IACxD,4BAA4B,EAAE,OAAO,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,+JAA+J;IAC/J,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,GAAG,GAAG,CAAC,CAAA;IACpE,wHAAwH;IACxH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sIAAsI;IACtI,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oEAAoE;IACpE,IAAI,CAAC,EAAE;QACL,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,GAAG,GAAG,CAAC,CAAA;KACrE,CAAA;IACD,iCAAiC;IACjC,KAAK,CAAC,EAAE;QACN,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB,uJAAuJ;QACvJ,UAAU,CAAC,EAAE,OAAO,CAAA;KACrB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG,IAAI,CAC7C,iBAAiB,GAAG,qBAAqB,EACzC,OAAO,GAAG,MAAM,GAAG,gBAAgB,GAAG,aAAa,CACpD,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,4BAA4B,GAAG;IACrE;;;OAGG;IACH,GAAG,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACxC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE;QACxB,OAAO,EAAE,OAAO,CAAA;QAChB,cAAc,EAAE,GAAG,CAAA;QACnB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KACrC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,mCAAmC,GAAG,IAAI,CAAC,yBAAyB,EAAE,KAAK,GAAG,SAAS,CAAC,GAClG,mBAAmB,CAAA;AAErB;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GAAG,mCAAmC,GAAG;IAC/F,OAAO,EAAE,mBAAmB,EAAE,CAAA;CAC/B,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,OAAO,CAAC,mCAAmC,CAAC,GAC5C,OAAO,CAAC,4CAA4C,CAAC,GACrD,OAAO,CAAC,mCAAmC,CAAC,EAAE,GAC9C,OAAO,CAAC,4CAA4C,CAAC,EAAE,CAAA;AAE3D,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,GACrC,QAAQ,4BAA4B,KACnC,MAAM,IAAI,OAAO,CAAC,4CAA4C,CACkC,CAAA;AAEnG,MAAM,MAAM,sBAAsB,GAAG,iBAAiB,GAAG,mBAAmB,CAAA"}
@@ -0,0 +1,2 @@
1
+ /** Typeguard to check to narrow the configs to the one with sources */
2
+ export const isConfigurationWithSources = (config) => Boolean(!Array.isArray(config) && config && 'sources' in config && Array.isArray(config.sources));
@@ -4,9 +4,9 @@ export declare const securityApiKeySchema: z.ZodObject<{
4
4
  type: z.ZodLiteral<"apiKey">;
5
5
  name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
6
6
  in: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
7
- cookie: "cookie";
8
7
  query: "query";
9
8
  header: "header";
9
+ cookie: "cookie";
10
10
  }>>>>;
11
11
  uid: z.core.$ZodBranded<z.ZodDefault<z.ZodString>, "securityScheme", "out">;
12
12
  nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -142,9 +142,9 @@ export declare const oasSecuritySchemeSchema: z.ZodUnion<readonly [z.ZodObject<{
142
142
  type: z.ZodLiteral<"apiKey">;
143
143
  name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
144
144
  in: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
145
- cookie: "cookie";
146
145
  query: "query";
147
146
  header: "header";
147
+ cookie: "cookie";
148
148
  }>>>>;
149
149
  }, z.core.$strip>, z.ZodObject<{
150
150
  description: z.ZodOptional<z.ZodString>;
@@ -244,9 +244,9 @@ export declare const securitySchemeSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.
244
244
  type: z.ZodLiteral<"apiKey">;
245
245
  name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
246
246
  in: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
247
- cookie: "cookie";
248
247
  query: "query";
249
248
  header: "header";
249
+ cookie: "cookie";
250
250
  }>>>>;
251
251
  uid: z.core.$ZodBranded<z.ZodDefault<z.ZodString>, "securityScheme", "out">;
252
252
  nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -354,7 +354,7 @@ export declare const securitySchemeSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.
354
354
  }, z.core.$strip>], "type">, z.ZodTransform<{
355
355
  type: "apiKey";
356
356
  name: string;
357
- in: "cookie" | "query" | "header";
357
+ in: "query" | "header" | "cookie";
358
358
  uid: string & z.core.$brand<"securityScheme">;
359
359
  nameKey: string;
360
360
  value: string;
@@ -446,7 +446,7 @@ export declare const securitySchemeSchema: z.ZodPipe<z.ZodDiscriminatedUnion<[z.
446
446
  }, {
447
447
  type: "apiKey";
448
448
  name: string;
449
- in: "cookie" | "query" | "header";
449
+ in: "query" | "header" | "cookie";
450
450
  uid: string & z.core.$brand<"securityScheme">;
451
451
  nameKey: string;
452
452
  value: string;
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * We should not use these exports anymore, but we need them for commonjs compatibility.
3
3
  */
4
- export type { AnyApiReferenceConfiguration, ApiClientConfiguration, ApiClientPlugin, ApiReferenceConfiguration, ApiReferenceConfigurationRaw, ApiReferenceConfigurationWithMultipleSources, ApiReferenceConfigurationWithSource, ApiReferenceInstance, ApiReferencePlugin, AuthenticationConfiguration, CreateApiReference, ExternalUrls, HtmlRenderingConfiguration, SourceConfiguration, SpecificationExtension, ViewComponent, } from './api-reference/index.js';
5
- export { apiClientConfigurationSchema, apiClientPluginSchema, apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourceSchema, hooksSchema, htmlRenderingConfigurationSchema, isConfigurationWithSources, sourceConfigurationSchema, } from './api-reference/index.js';
4
+ export type { AnyApiReferenceConfiguration, ApiClientConfiguration, ApiReferenceConfiguration, ApiReferenceConfigurationRaw, ApiReferenceConfigurationWithMultipleSources, ApiReferenceConfigurationWithSource, ApiReferenceInstance, ApiReferencePlugin, AuthenticationConfiguration, BaseConfiguration, CreateApiReference, ExternalUrls, HtmlRenderingConfiguration, LifecycleHooks, SecurityScheme, SecuritySchemeApiKey, SecuritySchemeHttp, SecuritySchemeOauth2, SecuritySchemeOpenIdConnect, SourceConfiguration, SpecificationExtension, ViewComponent, } from './api-reference/index.js';
5
+ export { isConfigurationWithSources } from './api-reference/index.js';
6
6
  export { XScalarStability } from './legacy/index.js';
7
7
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,YAAY,EACV,4BAA4B,EAC5B,sBAAsB,EACtB,eAAe,EACf,yBAAyB,EACzB,4BAA4B,EAC5B,4CAA4C,EAC5C,mCAAmC,EACnC,oBAAoB,EACpB,kBAAkB,EAClB,2BAA2B,EAC3B,kBAAkB,EAClB,YAAY,EACZ,0BAA0B,EAC1B,mBAAmB,EACnB,sBAAsB,EACtB,aAAa,GACd,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,EACrB,+BAA+B,EAC/B,yCAAyC,EACzC,WAAW,EACX,gCAAgC,EAChC,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,YAAY,EACV,4BAA4B,EAC5B,sBAAsB,EACtB,yBAAyB,EACzB,4BAA4B,EAC5B,4CAA4C,EAC5C,mCAAmC,EACnC,oBAAoB,EACpB,kBAAkB,EAClB,2BAA2B,EAC3B,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,EACZ,0BAA0B,EAC1B,cAAc,EACd,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,EACpB,2BAA2B,EAC3B,mBAAmB,EACnB,sBAAsB,EACtB,aAAa,GACd,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA"}
package/dist/index.js CHANGED
@@ -1,2 +1,2 @@
1
- export { apiClientConfigurationSchema, apiClientPluginSchema, apiReferenceConfigurationSchema, apiReferenceConfigurationWithSourceSchema, hooksSchema, htmlRenderingConfigurationSchema, isConfigurationWithSources, sourceConfigurationSchema, } from './api-reference/index.js';
1
+ export { isConfigurationWithSources } from './api-reference/index.js';
2
2
  export { XScalarStability } from './legacy/index.js';
@@ -34,7 +34,7 @@ export declare const GROUPED_CLIENTS: {
34
34
  * Flat array of all available client identifiers.
35
35
  * Each identifier follows the format `target/client` (e.g., `js/fetch`, `python/requests`).
36
36
  */
37
- export declare const AVAILABLE_CLIENTS: ("c/laravel" | "c/libcurl" | "c/clj_http" | "c/httpclient" | "c/restsharp" | "c/http" | "c/native" | "c/http1.1" | "c/asynchttp" | "c/nethttp" | "c/okhttp" | "c/unirest" | "c/axios" | "c/fetch" | "c/jquery" | "c/ofetch" | "c/xhr" | "c/undici" | "c/nsurlsession" | "c/cohttp" | "c/curl" | "c/guzzle" | "c/restmethod" | "c/webrequest" | "c/python3" | "c/requests" | "c/aiohttp" | "c/httpx_sync" | "c/httpx_async" | "c/httr2" | "c/reqwest" | "c/httpie" | "c/wget" | "r/laravel" | "r/libcurl" | "r/clj_http" | "r/httpclient" | "r/restsharp" | "r/http" | "r/native" | "r/http1.1" | "r/asynchttp" | "r/nethttp" | "r/okhttp" | "r/unirest" | "r/axios" | "r/fetch" | "r/jquery" | "r/ofetch" | "r/xhr" | "r/undici" | "r/nsurlsession" | "r/cohttp" | "r/curl" | "r/guzzle" | "r/restmethod" | "r/webrequest" | "r/python3" | "r/requests" | "r/aiohttp" | "r/httpx_sync" | "r/httpx_async" | "r/httr2" | "r/reqwest" | "r/httpie" | "r/wget" | "go/laravel" | "go/libcurl" | "go/clj_http" | "go/httpclient" | "go/restsharp" | "go/http" | "go/native" | "go/http1.1" | "go/asynchttp" | "go/nethttp" | "go/okhttp" | "go/unirest" | "go/axios" | "go/fetch" | "go/jquery" | "go/ofetch" | "go/xhr" | "go/undici" | "go/nsurlsession" | "go/cohttp" | "go/curl" | "go/guzzle" | "go/restmethod" | "go/webrequest" | "go/python3" | "go/requests" | "go/aiohttp" | "go/httpx_sync" | "go/httpx_async" | "go/httr2" | "go/reqwest" | "go/httpie" | "go/wget" | "rust/laravel" | "rust/libcurl" | "rust/clj_http" | "rust/httpclient" | "rust/restsharp" | "rust/http" | "rust/native" | "rust/http1.1" | "rust/asynchttp" | "rust/nethttp" | "rust/okhttp" | "rust/unirest" | "rust/axios" | "rust/fetch" | "rust/jquery" | "rust/ofetch" | "rust/xhr" | "rust/undici" | "rust/nsurlsession" | "rust/cohttp" | "rust/curl" | "rust/guzzle" | "rust/restmethod" | "rust/webrequest" | "rust/python3" | "rust/requests" | "rust/aiohttp" | "rust/httpx_sync" | "rust/httpx_async" | "rust/httr2" | "rust/reqwest" | "rust/httpie" | "rust/wget" | "http/laravel" | "http/libcurl" | "http/clj_http" | "http/httpclient" | "http/restsharp" | "http/http" | "http/native" | "http/http1.1" | "http/asynchttp" | "http/nethttp" | "http/okhttp" | "http/unirest" | "http/axios" | "http/fetch" | "http/jquery" | "http/ofetch" | "http/xhr" | "http/undici" | "http/nsurlsession" | "http/cohttp" | "http/curl" | "http/guzzle" | "http/restmethod" | "http/webrequest" | "http/python3" | "http/requests" | "http/aiohttp" | "http/httpx_sync" | "http/httpx_async" | "http/httr2" | "http/reqwest" | "http/httpie" | "http/wget" | "clojure/laravel" | "clojure/libcurl" | "clojure/clj_http" | "clojure/httpclient" | "clojure/restsharp" | "clojure/http" | "clojure/native" | "clojure/http1.1" | "clojure/asynchttp" | "clojure/nethttp" | "clojure/okhttp" | "clojure/unirest" | "clojure/axios" | "clojure/fetch" | "clojure/jquery" | "clojure/ofetch" | "clojure/xhr" | "clojure/undici" | "clojure/nsurlsession" | "clojure/cohttp" | "clojure/curl" | "clojure/guzzle" | "clojure/restmethod" | "clojure/webrequest" | "clojure/python3" | "clojure/requests" | "clojure/aiohttp" | "clojure/httpx_sync" | "clojure/httpx_async" | "clojure/httr2" | "clojure/reqwest" | "clojure/httpie" | "clojure/wget" | "csharp/laravel" | "csharp/libcurl" | "csharp/clj_http" | "csharp/httpclient" | "csharp/restsharp" | "csharp/http" | "csharp/native" | "csharp/http1.1" | "csharp/asynchttp" | "csharp/nethttp" | "csharp/okhttp" | "csharp/unirest" | "csharp/axios" | "csharp/fetch" | "csharp/jquery" | "csharp/ofetch" | "csharp/xhr" | "csharp/undici" | "csharp/nsurlsession" | "csharp/cohttp" | "csharp/curl" | "csharp/guzzle" | "csharp/restmethod" | "csharp/webrequest" | "csharp/python3" | "csharp/requests" | "csharp/aiohttp" | "csharp/httpx_sync" | "csharp/httpx_async" | "csharp/httr2" | "csharp/reqwest" | "csharp/httpie" | "csharp/wget" | "dart/laravel" | "dart/libcurl" | "dart/clj_http" | "dart/httpclient" | "dart/restsharp" | "dart/http" | "dart/native" | "dart/http1.1" | "dart/asynchttp" | "dart/nethttp" | "dart/okhttp" | "dart/unirest" | "dart/axios" | "dart/fetch" | "dart/jquery" | "dart/ofetch" | "dart/xhr" | "dart/undici" | "dart/nsurlsession" | "dart/cohttp" | "dart/curl" | "dart/guzzle" | "dart/restmethod" | "dart/webrequest" | "dart/python3" | "dart/requests" | "dart/aiohttp" | "dart/httpx_sync" | "dart/httpx_async" | "dart/httr2" | "dart/reqwest" | "dart/httpie" | "dart/wget" | "fsharp/laravel" | "fsharp/libcurl" | "fsharp/clj_http" | "fsharp/httpclient" | "fsharp/restsharp" | "fsharp/http" | "fsharp/native" | "fsharp/http1.1" | "fsharp/asynchttp" | "fsharp/nethttp" | "fsharp/okhttp" | "fsharp/unirest" | "fsharp/axios" | "fsharp/fetch" | "fsharp/jquery" | "fsharp/ofetch" | "fsharp/xhr" | "fsharp/undici" | "fsharp/nsurlsession" | "fsharp/cohttp" | "fsharp/curl" | "fsharp/guzzle" | "fsharp/restmethod" | "fsharp/webrequest" | "fsharp/python3" | "fsharp/requests" | "fsharp/aiohttp" | "fsharp/httpx_sync" | "fsharp/httpx_async" | "fsharp/httr2" | "fsharp/reqwest" | "fsharp/httpie" | "fsharp/wget" | "java/laravel" | "java/libcurl" | "java/clj_http" | "java/httpclient" | "java/restsharp" | "java/http" | "java/native" | "java/http1.1" | "java/asynchttp" | "java/nethttp" | "java/okhttp" | "java/unirest" | "java/axios" | "java/fetch" | "java/jquery" | "java/ofetch" | "java/xhr" | "java/undici" | "java/nsurlsession" | "java/cohttp" | "java/curl" | "java/guzzle" | "java/restmethod" | "java/webrequest" | "java/python3" | "java/requests" | "java/aiohttp" | "java/httpx_sync" | "java/httpx_async" | "java/httr2" | "java/reqwest" | "java/httpie" | "java/wget" | "js/laravel" | "js/libcurl" | "js/clj_http" | "js/httpclient" | "js/restsharp" | "js/http" | "js/native" | "js/http1.1" | "js/asynchttp" | "js/nethttp" | "js/okhttp" | "js/unirest" | "js/axios" | "js/fetch" | "js/jquery" | "js/ofetch" | "js/xhr" | "js/undici" | "js/nsurlsession" | "js/cohttp" | "js/curl" | "js/guzzle" | "js/restmethod" | "js/webrequest" | "js/python3" | "js/requests" | "js/aiohttp" | "js/httpx_sync" | "js/httpx_async" | "js/httr2" | "js/reqwest" | "js/httpie" | "js/wget" | "kotlin/laravel" | "kotlin/libcurl" | "kotlin/clj_http" | "kotlin/httpclient" | "kotlin/restsharp" | "kotlin/http" | "kotlin/native" | "kotlin/http1.1" | "kotlin/asynchttp" | "kotlin/nethttp" | "kotlin/okhttp" | "kotlin/unirest" | "kotlin/axios" | "kotlin/fetch" | "kotlin/jquery" | "kotlin/ofetch" | "kotlin/xhr" | "kotlin/undici" | "kotlin/nsurlsession" | "kotlin/cohttp" | "kotlin/curl" | "kotlin/guzzle" | "kotlin/restmethod" | "kotlin/webrequest" | "kotlin/python3" | "kotlin/requests" | "kotlin/aiohttp" | "kotlin/httpx_sync" | "kotlin/httpx_async" | "kotlin/httr2" | "kotlin/reqwest" | "kotlin/httpie" | "kotlin/wget" | "node/laravel" | "node/libcurl" | "node/clj_http" | "node/httpclient" | "node/restsharp" | "node/http" | "node/native" | "node/http1.1" | "node/asynchttp" | "node/nethttp" | "node/okhttp" | "node/unirest" | "node/axios" | "node/fetch" | "node/jquery" | "node/ofetch" | "node/xhr" | "node/undici" | "node/nsurlsession" | "node/cohttp" | "node/curl" | "node/guzzle" | "node/restmethod" | "node/webrequest" | "node/python3" | "node/requests" | "node/aiohttp" | "node/httpx_sync" | "node/httpx_async" | "node/httr2" | "node/reqwest" | "node/httpie" | "node/wget" | "objc/laravel" | "objc/libcurl" | "objc/clj_http" | "objc/httpclient" | "objc/restsharp" | "objc/http" | "objc/native" | "objc/http1.1" | "objc/asynchttp" | "objc/nethttp" | "objc/okhttp" | "objc/unirest" | "objc/axios" | "objc/fetch" | "objc/jquery" | "objc/ofetch" | "objc/xhr" | "objc/undici" | "objc/nsurlsession" | "objc/cohttp" | "objc/curl" | "objc/guzzle" | "objc/restmethod" | "objc/webrequest" | "objc/python3" | "objc/requests" | "objc/aiohttp" | "objc/httpx_sync" | "objc/httpx_async" | "objc/httr2" | "objc/reqwest" | "objc/httpie" | "objc/wget" | "ocaml/laravel" | "ocaml/libcurl" | "ocaml/clj_http" | "ocaml/httpclient" | "ocaml/restsharp" | "ocaml/http" | "ocaml/native" | "ocaml/http1.1" | "ocaml/asynchttp" | "ocaml/nethttp" | "ocaml/okhttp" | "ocaml/unirest" | "ocaml/axios" | "ocaml/fetch" | "ocaml/jquery" | "ocaml/ofetch" | "ocaml/xhr" | "ocaml/undici" | "ocaml/nsurlsession" | "ocaml/cohttp" | "ocaml/curl" | "ocaml/guzzle" | "ocaml/restmethod" | "ocaml/webrequest" | "ocaml/python3" | "ocaml/requests" | "ocaml/aiohttp" | "ocaml/httpx_sync" | "ocaml/httpx_async" | "ocaml/httr2" | "ocaml/reqwest" | "ocaml/httpie" | "ocaml/wget" | "php/laravel" | "php/libcurl" | "php/clj_http" | "php/httpclient" | "php/restsharp" | "php/http" | "php/native" | "php/http1.1" | "php/asynchttp" | "php/nethttp" | "php/okhttp" | "php/unirest" | "php/axios" | "php/fetch" | "php/jquery" | "php/ofetch" | "php/xhr" | "php/undici" | "php/nsurlsession" | "php/cohttp" | "php/curl" | "php/guzzle" | "php/restmethod" | "php/webrequest" | "php/python3" | "php/requests" | "php/aiohttp" | "php/httpx_sync" | "php/httpx_async" | "php/httr2" | "php/reqwest" | "php/httpie" | "php/wget" | "powershell/laravel" | "powershell/libcurl" | "powershell/clj_http" | "powershell/httpclient" | "powershell/restsharp" | "powershell/http" | "powershell/native" | "powershell/http1.1" | "powershell/asynchttp" | "powershell/nethttp" | "powershell/okhttp" | "powershell/unirest" | "powershell/axios" | "powershell/fetch" | "powershell/jquery" | "powershell/ofetch" | "powershell/xhr" | "powershell/undici" | "powershell/nsurlsession" | "powershell/cohttp" | "powershell/curl" | "powershell/guzzle" | "powershell/restmethod" | "powershell/webrequest" | "powershell/python3" | "powershell/requests" | "powershell/aiohttp" | "powershell/httpx_sync" | "powershell/httpx_async" | "powershell/httr2" | "powershell/reqwest" | "powershell/httpie" | "powershell/wget" | "python/laravel" | "python/libcurl" | "python/clj_http" | "python/httpclient" | "python/restsharp" | "python/http" | "python/native" | "python/http1.1" | "python/asynchttp" | "python/nethttp" | "python/okhttp" | "python/unirest" | "python/axios" | "python/fetch" | "python/jquery" | "python/ofetch" | "python/xhr" | "python/undici" | "python/nsurlsession" | "python/cohttp" | "python/curl" | "python/guzzle" | "python/restmethod" | "python/webrequest" | "python/python3" | "python/requests" | "python/aiohttp" | "python/httpx_sync" | "python/httpx_async" | "python/httr2" | "python/reqwest" | "python/httpie" | "python/wget" | "ruby/laravel" | "ruby/libcurl" | "ruby/clj_http" | "ruby/httpclient" | "ruby/restsharp" | "ruby/http" | "ruby/native" | "ruby/http1.1" | "ruby/asynchttp" | "ruby/nethttp" | "ruby/okhttp" | "ruby/unirest" | "ruby/axios" | "ruby/fetch" | "ruby/jquery" | "ruby/ofetch" | "ruby/xhr" | "ruby/undici" | "ruby/nsurlsession" | "ruby/cohttp" | "ruby/curl" | "ruby/guzzle" | "ruby/restmethod" | "ruby/webrequest" | "ruby/python3" | "ruby/requests" | "ruby/aiohttp" | "ruby/httpx_sync" | "ruby/httpx_async" | "ruby/httr2" | "ruby/reqwest" | "ruby/httpie" | "ruby/wget" | "shell/laravel" | "shell/libcurl" | "shell/clj_http" | "shell/httpclient" | "shell/restsharp" | "shell/http" | "shell/native" | "shell/http1.1" | "shell/asynchttp" | "shell/nethttp" | "shell/okhttp" | "shell/unirest" | "shell/axios" | "shell/fetch" | "shell/jquery" | "shell/ofetch" | "shell/xhr" | "shell/undici" | "shell/nsurlsession" | "shell/cohttp" | "shell/curl" | "shell/guzzle" | "shell/restmethod" | "shell/webrequest" | "shell/python3" | "shell/requests" | "shell/aiohttp" | "shell/httpx_sync" | "shell/httpx_async" | "shell/httr2" | "shell/reqwest" | "shell/httpie" | "shell/wget" | "swift/laravel" | "swift/libcurl" | "swift/clj_http" | "swift/httpclient" | "swift/restsharp" | "swift/http" | "swift/native" | "swift/http1.1" | "swift/asynchttp" | "swift/nethttp" | "swift/okhttp" | "swift/unirest" | "swift/axios" | "swift/fetch" | "swift/jquery" | "swift/ofetch" | "swift/xhr" | "swift/undici" | "swift/nsurlsession" | "swift/cohttp" | "swift/curl" | "swift/guzzle" | "swift/restmethod" | "swift/webrequest" | "swift/python3" | "swift/requests" | "swift/aiohttp" | "swift/httpx_sync" | "swift/httpx_async" | "swift/httr2" | "swift/reqwest" | "swift/httpie" | "swift/wget")[];
37
+ export declare const AVAILABLE_CLIENTS: ("http/http" | "http/laravel" | "http/fetch" | "http/libcurl" | "http/clj_http" | "http/httpclient" | "http/restsharp" | "http/native" | "http/http1.1" | "http/asynchttp" | "http/nethttp" | "http/okhttp" | "http/unirest" | "http/axios" | "http/jquery" | "http/ofetch" | "http/xhr" | "http/undici" | "http/nsurlsession" | "http/cohttp" | "http/curl" | "http/guzzle" | "http/restmethod" | "http/webrequest" | "http/python3" | "http/requests" | "http/aiohttp" | "http/httpx_sync" | "http/httpx_async" | "http/httr2" | "http/reqwest" | "http/httpie" | "http/wget" | "c/http" | "c/laravel" | "c/fetch" | "c/libcurl" | "c/clj_http" | "c/httpclient" | "c/restsharp" | "c/native" | "c/http1.1" | "c/asynchttp" | "c/nethttp" | "c/okhttp" | "c/unirest" | "c/axios" | "c/jquery" | "c/ofetch" | "c/xhr" | "c/undici" | "c/nsurlsession" | "c/cohttp" | "c/curl" | "c/guzzle" | "c/restmethod" | "c/webrequest" | "c/python3" | "c/requests" | "c/aiohttp" | "c/httpx_sync" | "c/httpx_async" | "c/httr2" | "c/reqwest" | "c/httpie" | "c/wget" | "r/http" | "r/laravel" | "r/fetch" | "r/libcurl" | "r/clj_http" | "r/httpclient" | "r/restsharp" | "r/native" | "r/http1.1" | "r/asynchttp" | "r/nethttp" | "r/okhttp" | "r/unirest" | "r/axios" | "r/jquery" | "r/ofetch" | "r/xhr" | "r/undici" | "r/nsurlsession" | "r/cohttp" | "r/curl" | "r/guzzle" | "r/restmethod" | "r/webrequest" | "r/python3" | "r/requests" | "r/aiohttp" | "r/httpx_sync" | "r/httpx_async" | "r/httr2" | "r/reqwest" | "r/httpie" | "r/wget" | "go/http" | "go/laravel" | "go/fetch" | "go/libcurl" | "go/clj_http" | "go/httpclient" | "go/restsharp" | "go/native" | "go/http1.1" | "go/asynchttp" | "go/nethttp" | "go/okhttp" | "go/unirest" | "go/axios" | "go/jquery" | "go/ofetch" | "go/xhr" | "go/undici" | "go/nsurlsession" | "go/cohttp" | "go/curl" | "go/guzzle" | "go/restmethod" | "go/webrequest" | "go/python3" | "go/requests" | "go/aiohttp" | "go/httpx_sync" | "go/httpx_async" | "go/httr2" | "go/reqwest" | "go/httpie" | "go/wget" | "rust/http" | "rust/laravel" | "rust/fetch" | "rust/libcurl" | "rust/clj_http" | "rust/httpclient" | "rust/restsharp" | "rust/native" | "rust/http1.1" | "rust/asynchttp" | "rust/nethttp" | "rust/okhttp" | "rust/unirest" | "rust/axios" | "rust/jquery" | "rust/ofetch" | "rust/xhr" | "rust/undici" | "rust/nsurlsession" | "rust/cohttp" | "rust/curl" | "rust/guzzle" | "rust/restmethod" | "rust/webrequest" | "rust/python3" | "rust/requests" | "rust/aiohttp" | "rust/httpx_sync" | "rust/httpx_async" | "rust/httr2" | "rust/reqwest" | "rust/httpie" | "rust/wget" | "clojure/http" | "clojure/laravel" | "clojure/fetch" | "clojure/libcurl" | "clojure/clj_http" | "clojure/httpclient" | "clojure/restsharp" | "clojure/native" | "clojure/http1.1" | "clojure/asynchttp" | "clojure/nethttp" | "clojure/okhttp" | "clojure/unirest" | "clojure/axios" | "clojure/jquery" | "clojure/ofetch" | "clojure/xhr" | "clojure/undici" | "clojure/nsurlsession" | "clojure/cohttp" | "clojure/curl" | "clojure/guzzle" | "clojure/restmethod" | "clojure/webrequest" | "clojure/python3" | "clojure/requests" | "clojure/aiohttp" | "clojure/httpx_sync" | "clojure/httpx_async" | "clojure/httr2" | "clojure/reqwest" | "clojure/httpie" | "clojure/wget" | "csharp/http" | "csharp/laravel" | "csharp/fetch" | "csharp/libcurl" | "csharp/clj_http" | "csharp/httpclient" | "csharp/restsharp" | "csharp/native" | "csharp/http1.1" | "csharp/asynchttp" | "csharp/nethttp" | "csharp/okhttp" | "csharp/unirest" | "csharp/axios" | "csharp/jquery" | "csharp/ofetch" | "csharp/xhr" | "csharp/undici" | "csharp/nsurlsession" | "csharp/cohttp" | "csharp/curl" | "csharp/guzzle" | "csharp/restmethod" | "csharp/webrequest" | "csharp/python3" | "csharp/requests" | "csharp/aiohttp" | "csharp/httpx_sync" | "csharp/httpx_async" | "csharp/httr2" | "csharp/reqwest" | "csharp/httpie" | "csharp/wget" | "dart/http" | "dart/laravel" | "dart/fetch" | "dart/libcurl" | "dart/clj_http" | "dart/httpclient" | "dart/restsharp" | "dart/native" | "dart/http1.1" | "dart/asynchttp" | "dart/nethttp" | "dart/okhttp" | "dart/unirest" | "dart/axios" | "dart/jquery" | "dart/ofetch" | "dart/xhr" | "dart/undici" | "dart/nsurlsession" | "dart/cohttp" | "dart/curl" | "dart/guzzle" | "dart/restmethod" | "dart/webrequest" | "dart/python3" | "dart/requests" | "dart/aiohttp" | "dart/httpx_sync" | "dart/httpx_async" | "dart/httr2" | "dart/reqwest" | "dart/httpie" | "dart/wget" | "fsharp/http" | "fsharp/laravel" | "fsharp/fetch" | "fsharp/libcurl" | "fsharp/clj_http" | "fsharp/httpclient" | "fsharp/restsharp" | "fsharp/native" | "fsharp/http1.1" | "fsharp/asynchttp" | "fsharp/nethttp" | "fsharp/okhttp" | "fsharp/unirest" | "fsharp/axios" | "fsharp/jquery" | "fsharp/ofetch" | "fsharp/xhr" | "fsharp/undici" | "fsharp/nsurlsession" | "fsharp/cohttp" | "fsharp/curl" | "fsharp/guzzle" | "fsharp/restmethod" | "fsharp/webrequest" | "fsharp/python3" | "fsharp/requests" | "fsharp/aiohttp" | "fsharp/httpx_sync" | "fsharp/httpx_async" | "fsharp/httr2" | "fsharp/reqwest" | "fsharp/httpie" | "fsharp/wget" | "java/http" | "java/laravel" | "java/fetch" | "java/libcurl" | "java/clj_http" | "java/httpclient" | "java/restsharp" | "java/native" | "java/http1.1" | "java/asynchttp" | "java/nethttp" | "java/okhttp" | "java/unirest" | "java/axios" | "java/jquery" | "java/ofetch" | "java/xhr" | "java/undici" | "java/nsurlsession" | "java/cohttp" | "java/curl" | "java/guzzle" | "java/restmethod" | "java/webrequest" | "java/python3" | "java/requests" | "java/aiohttp" | "java/httpx_sync" | "java/httpx_async" | "java/httr2" | "java/reqwest" | "java/httpie" | "java/wget" | "js/http" | "js/laravel" | "js/fetch" | "js/libcurl" | "js/clj_http" | "js/httpclient" | "js/restsharp" | "js/native" | "js/http1.1" | "js/asynchttp" | "js/nethttp" | "js/okhttp" | "js/unirest" | "js/axios" | "js/jquery" | "js/ofetch" | "js/xhr" | "js/undici" | "js/nsurlsession" | "js/cohttp" | "js/curl" | "js/guzzle" | "js/restmethod" | "js/webrequest" | "js/python3" | "js/requests" | "js/aiohttp" | "js/httpx_sync" | "js/httpx_async" | "js/httr2" | "js/reqwest" | "js/httpie" | "js/wget" | "kotlin/http" | "kotlin/laravel" | "kotlin/fetch" | "kotlin/libcurl" | "kotlin/clj_http" | "kotlin/httpclient" | "kotlin/restsharp" | "kotlin/native" | "kotlin/http1.1" | "kotlin/asynchttp" | "kotlin/nethttp" | "kotlin/okhttp" | "kotlin/unirest" | "kotlin/axios" | "kotlin/jquery" | "kotlin/ofetch" | "kotlin/xhr" | "kotlin/undici" | "kotlin/nsurlsession" | "kotlin/cohttp" | "kotlin/curl" | "kotlin/guzzle" | "kotlin/restmethod" | "kotlin/webrequest" | "kotlin/python3" | "kotlin/requests" | "kotlin/aiohttp" | "kotlin/httpx_sync" | "kotlin/httpx_async" | "kotlin/httr2" | "kotlin/reqwest" | "kotlin/httpie" | "kotlin/wget" | "node/http" | "node/laravel" | "node/fetch" | "node/libcurl" | "node/clj_http" | "node/httpclient" | "node/restsharp" | "node/native" | "node/http1.1" | "node/asynchttp" | "node/nethttp" | "node/okhttp" | "node/unirest" | "node/axios" | "node/jquery" | "node/ofetch" | "node/xhr" | "node/undici" | "node/nsurlsession" | "node/cohttp" | "node/curl" | "node/guzzle" | "node/restmethod" | "node/webrequest" | "node/python3" | "node/requests" | "node/aiohttp" | "node/httpx_sync" | "node/httpx_async" | "node/httr2" | "node/reqwest" | "node/httpie" | "node/wget" | "objc/http" | "objc/laravel" | "objc/fetch" | "objc/libcurl" | "objc/clj_http" | "objc/httpclient" | "objc/restsharp" | "objc/native" | "objc/http1.1" | "objc/asynchttp" | "objc/nethttp" | "objc/okhttp" | "objc/unirest" | "objc/axios" | "objc/jquery" | "objc/ofetch" | "objc/xhr" | "objc/undici" | "objc/nsurlsession" | "objc/cohttp" | "objc/curl" | "objc/guzzle" | "objc/restmethod" | "objc/webrequest" | "objc/python3" | "objc/requests" | "objc/aiohttp" | "objc/httpx_sync" | "objc/httpx_async" | "objc/httr2" | "objc/reqwest" | "objc/httpie" | "objc/wget" | "ocaml/http" | "ocaml/laravel" | "ocaml/fetch" | "ocaml/libcurl" | "ocaml/clj_http" | "ocaml/httpclient" | "ocaml/restsharp" | "ocaml/native" | "ocaml/http1.1" | "ocaml/asynchttp" | "ocaml/nethttp" | "ocaml/okhttp" | "ocaml/unirest" | "ocaml/axios" | "ocaml/jquery" | "ocaml/ofetch" | "ocaml/xhr" | "ocaml/undici" | "ocaml/nsurlsession" | "ocaml/cohttp" | "ocaml/curl" | "ocaml/guzzle" | "ocaml/restmethod" | "ocaml/webrequest" | "ocaml/python3" | "ocaml/requests" | "ocaml/aiohttp" | "ocaml/httpx_sync" | "ocaml/httpx_async" | "ocaml/httr2" | "ocaml/reqwest" | "ocaml/httpie" | "ocaml/wget" | "php/http" | "php/laravel" | "php/fetch" | "php/libcurl" | "php/clj_http" | "php/httpclient" | "php/restsharp" | "php/native" | "php/http1.1" | "php/asynchttp" | "php/nethttp" | "php/okhttp" | "php/unirest" | "php/axios" | "php/jquery" | "php/ofetch" | "php/xhr" | "php/undici" | "php/nsurlsession" | "php/cohttp" | "php/curl" | "php/guzzle" | "php/restmethod" | "php/webrequest" | "php/python3" | "php/requests" | "php/aiohttp" | "php/httpx_sync" | "php/httpx_async" | "php/httr2" | "php/reqwest" | "php/httpie" | "php/wget" | "powershell/http" | "powershell/laravel" | "powershell/fetch" | "powershell/libcurl" | "powershell/clj_http" | "powershell/httpclient" | "powershell/restsharp" | "powershell/native" | "powershell/http1.1" | "powershell/asynchttp" | "powershell/nethttp" | "powershell/okhttp" | "powershell/unirest" | "powershell/axios" | "powershell/jquery" | "powershell/ofetch" | "powershell/xhr" | "powershell/undici" | "powershell/nsurlsession" | "powershell/cohttp" | "powershell/curl" | "powershell/guzzle" | "powershell/restmethod" | "powershell/webrequest" | "powershell/python3" | "powershell/requests" | "powershell/aiohttp" | "powershell/httpx_sync" | "powershell/httpx_async" | "powershell/httr2" | "powershell/reqwest" | "powershell/httpie" | "powershell/wget" | "python/http" | "python/laravel" | "python/fetch" | "python/libcurl" | "python/clj_http" | "python/httpclient" | "python/restsharp" | "python/native" | "python/http1.1" | "python/asynchttp" | "python/nethttp" | "python/okhttp" | "python/unirest" | "python/axios" | "python/jquery" | "python/ofetch" | "python/xhr" | "python/undici" | "python/nsurlsession" | "python/cohttp" | "python/curl" | "python/guzzle" | "python/restmethod" | "python/webrequest" | "python/python3" | "python/requests" | "python/aiohttp" | "python/httpx_sync" | "python/httpx_async" | "python/httr2" | "python/reqwest" | "python/httpie" | "python/wget" | "ruby/http" | "ruby/laravel" | "ruby/fetch" | "ruby/libcurl" | "ruby/clj_http" | "ruby/httpclient" | "ruby/restsharp" | "ruby/native" | "ruby/http1.1" | "ruby/asynchttp" | "ruby/nethttp" | "ruby/okhttp" | "ruby/unirest" | "ruby/axios" | "ruby/jquery" | "ruby/ofetch" | "ruby/xhr" | "ruby/undici" | "ruby/nsurlsession" | "ruby/cohttp" | "ruby/curl" | "ruby/guzzle" | "ruby/restmethod" | "ruby/webrequest" | "ruby/python3" | "ruby/requests" | "ruby/aiohttp" | "ruby/httpx_sync" | "ruby/httpx_async" | "ruby/httr2" | "ruby/reqwest" | "ruby/httpie" | "ruby/wget" | "shell/http" | "shell/laravel" | "shell/fetch" | "shell/libcurl" | "shell/clj_http" | "shell/httpclient" | "shell/restsharp" | "shell/native" | "shell/http1.1" | "shell/asynchttp" | "shell/nethttp" | "shell/okhttp" | "shell/unirest" | "shell/axios" | "shell/jquery" | "shell/ofetch" | "shell/xhr" | "shell/undici" | "shell/nsurlsession" | "shell/cohttp" | "shell/curl" | "shell/guzzle" | "shell/restmethod" | "shell/webrequest" | "shell/python3" | "shell/requests" | "shell/aiohttp" | "shell/httpx_sync" | "shell/httpx_async" | "shell/httr2" | "shell/reqwest" | "shell/httpie" | "shell/wget" | "swift/http" | "swift/laravel" | "swift/fetch" | "swift/libcurl" | "swift/clj_http" | "swift/httpclient" | "swift/restsharp" | "swift/native" | "swift/http1.1" | "swift/asynchttp" | "swift/nethttp" | "swift/okhttp" | "swift/unirest" | "swift/axios" | "swift/jquery" | "swift/ofetch" | "swift/xhr" | "swift/undici" | "swift/nsurlsession" | "swift/cohttp" | "swift/curl" | "swift/guzzle" | "swift/restmethod" | "swift/webrequest" | "swift/python3" | "swift/requests" | "swift/aiohttp" | "swift/httpx_sync" | "swift/httpx_async" | "swift/httr2" | "swift/reqwest" | "swift/httpie" | "swift/wget")[];
38
38
  /**
39
39
  * All available client identifiers in array format
40
40
  * @example
package/package.json CHANGED
@@ -16,7 +16,7 @@
16
16
  "scalar",
17
17
  "references"
18
18
  ],
19
- "version": "0.9.6",
19
+ "version": "0.11.0",
20
20
  "engines": {
21
21
  "node": ">=22"
22
22
  },
@@ -62,7 +62,7 @@
62
62
  "nanoid": "^5.1.6",
63
63
  "type-fest": "^5.3.1",
64
64
  "zod": "^4.3.5",
65
- "@scalar/helpers": "0.6.0"
65
+ "@scalar/helpers": "0.8.0"
66
66
  },
67
67
  "devDependencies": {
68
68
  "@types/har-format": "^1.2.16",
@@ -1,141 +0,0 @@
1
- import type z from 'zod';
2
- export declare const apiClientConfigurationSchema: z.ZodObject<{
3
- authentication: z.ZodOptional<z.ZodAny>;
4
- baseServerURL: z.ZodOptional<z.ZodString>;
5
- hideClientButton: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
6
- proxyUrl: z.ZodOptional<z.ZodString>;
7
- oauth2RedirectUri: z.ZodOptional<z.ZodString>;
8
- searchHotKey: z.ZodOptional<z.ZodEnum<{
9
- a: "a";
10
- b: "b";
11
- c: "c";
12
- d: "d";
13
- e: "e";
14
- f: "f";
15
- g: "g";
16
- h: "h";
17
- i: "i";
18
- j: "j";
19
- k: "k";
20
- l: "l";
21
- m: "m";
22
- n: "n";
23
- o: "o";
24
- p: "p";
25
- q: "q";
26
- r: "r";
27
- s: "s";
28
- t: "t";
29
- u: "u";
30
- v: "v";
31
- w: "w";
32
- x: "x";
33
- y: "y";
34
- z: "z";
35
- }>>;
36
- servers: z.ZodOptional<z.ZodArray<z.ZodAny>>;
37
- showSidebar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
38
- showDeveloperTools: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
39
- never: "never";
40
- always: "always";
41
- localhost: "localhost";
42
- }>>>>;
43
- showToolbar: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
44
- never: "never";
45
- always: "always";
46
- localhost: "localhost";
47
- }>>>>;
48
- operationTitleSource: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
49
- summary: "summary";
50
- path: "path";
51
- }>>>>;
52
- theme: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<{
53
- default: "default";
54
- alternate: "alternate";
55
- moon: "moon";
56
- purple: "purple";
57
- solarized: "solarized";
58
- bluePlanet: "bluePlanet";
59
- deepSpace: "deepSpace";
60
- saturn: "saturn";
61
- kepler: "kepler";
62
- elysiajs: "elysiajs";
63
- fastify: "fastify";
64
- mars: "mars";
65
- laserwave: "laserwave";
66
- none: "none";
67
- }>>>>;
68
- _integration: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
69
- elysiajs: "elysiajs";
70
- fastify: "fastify";
71
- adonisjs: "adonisjs";
72
- astro: "astro";
73
- docusaurus: "docusaurus";
74
- dotnet: "dotnet";
75
- express: "express";
76
- fastapi: "fastapi";
77
- go: "go";
78
- hono: "hono";
79
- html: "html";
80
- laravel: "laravel";
81
- litestar: "litestar";
82
- nestjs: "nestjs";
83
- nextjs: "nextjs";
84
- nitro: "nitro";
85
- nuxt: "nuxt";
86
- platformatic: "platformatic";
87
- react: "react";
88
- rust: "rust";
89
- svelte: "svelte";
90
- vue: "vue";
91
- }>>>;
92
- onRequestSent: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodString], null>, z.ZodVoid>>;
93
- persistAuth: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
94
- plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<readonly [], null>, z.ZodObject<{
95
- name: z.ZodString;
96
- views: z.ZodOptional<z.ZodObject<{
97
- 'request.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
98
- title: z.ZodOptional<z.ZodString>;
99
- component: z.ZodUnknown;
100
- props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
101
- }, z.core.$strip>>>;
102
- 'response.section': z.ZodOptional<z.ZodArray<z.ZodObject<{
103
- title: z.ZodOptional<z.ZodString>;
104
- component: z.ZodUnknown;
105
- props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
106
- }, z.core.$strip>>>;
107
- }, z.core.$strip>>;
108
- hooks: z.ZodOptional<z.ZodObject<{
109
- onBeforeRequest: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
110
- request: z.ZodAny;
111
- }, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
112
- onResponseReceived: z.ZodOptional<z.ZodFunction<z.ZodTuple<readonly [z.ZodObject<{
113
- response: z.ZodCustom<Response, Response>;
114
- operation: z.ZodRecord<z.ZodString, z.ZodAny>;
115
- }, z.core.$strip>], null>, z.core.$ZodFunctionOut>>;
116
- }, z.core.$strip>>;
117
- }, z.core.$strip>>>>;
118
- telemetry: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
119
- externalUrls: z.ZodPrefault<z.ZodObject<{
120
- dashboardUrl: z.ZodPrefault<z.ZodString>;
121
- registryUrl: z.ZodPrefault<z.ZodString>;
122
- proxyUrl: z.ZodPrefault<z.ZodString>;
123
- apiBaseUrl: z.ZodPrefault<z.ZodString>;
124
- }, z.core.$strip>>;
125
- default: z.ZodCatch<z.ZodOptional<z.ZodDefault<z.ZodBoolean>>>;
126
- url: z.ZodOptional<z.ZodString>;
127
- 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>>]>>;
128
- title: z.ZodOptional<z.ZodString>;
129
- slug: z.ZodOptional<z.ZodString>;
130
- spec: z.ZodOptional<z.ZodObject<{
131
- url: z.ZodOptional<z.ZodString>;
132
- 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>>]>>;
133
- }, z.core.$strip>>;
134
- agent: z.ZodOptional<z.ZodObject<{
135
- key: z.ZodOptional<z.ZodString>;
136
- disabled: z.ZodOptional<z.ZodBoolean>;
137
- hideAddApi: z.ZodOptional<z.ZodBoolean>;
138
- }, z.core.$strip>>;
139
- }, z.core.$strip>;
140
- export type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>;
141
- //# sourceMappingURL=api-client-configuration.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"api-client-configuration.d.ts","sourceRoot":"","sources":["../../src/api-reference/api-client-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAKxB,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAAkE,CAAA;AAE3G,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA"}
@@ -1,3 +0,0 @@
1
- import { baseConfigurationSchema } from './base-configuration.js';
2
- import { sourceConfigurationSchema } from './source-configuration.js';
3
- export const apiClientConfigurationSchema = baseConfigurationSchema.extend(sourceConfigurationSchema.shape);