@scalar/types 0.1.16 → 0.2.1

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.
Files changed (15) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/dist/api-client/api-client-plugin.d.ts +123 -0
  3. package/dist/api-client/api-client-plugin.d.ts.map +1 -0
  4. package/dist/api-client/api-client-plugin.js +32 -0
  5. package/dist/api-client/api-client-plugin.js.map +7 -0
  6. package/dist/api-client/index.d.ts +2 -0
  7. package/dist/api-client/index.d.ts.map +1 -0
  8. package/dist/api-client/index.js +5 -0
  9. package/dist/api-client/index.js.map +7 -0
  10. package/dist/api-reference/api-reference-configuration.d.ts +440 -33
  11. package/dist/api-reference/api-reference-configuration.d.ts.map +1 -1
  12. package/dist/api-reference/api-reference-configuration.js +4 -1
  13. package/dist/api-reference/api-reference-configuration.js.map +2 -2
  14. package/dist/entities/security-scheme.d.ts +10 -10
  15. package/package.json +9 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
1
1
  # @scalar/types
2
2
 
3
+ ## 0.2.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 4440949: chore: bumping packages
8
+ - Updated dependencies [4440949]
9
+ - @scalar/openapi-types@0.3.1
10
+
11
+ ## 0.2.0
12
+
13
+ ### Minor Changes
14
+
15
+ - 483ca93: chore: require Node 20 (or above)
16
+
17
+ ### Patch Changes
18
+
19
+ - Updated dependencies [483ca93]
20
+ - @scalar/openapi-types@0.3.0
21
+
3
22
  ## 0.1.16
4
23
 
5
24
  ### Patch Changes
package/dist/api-client/api-client-plugin.d.ts ADDED
@@ -0,0 +1,123 @@
1
+ import { z } from 'zod';
2
+ export declare const ApiClientPluginSchema: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
3
+ name: z.ZodString;
4
+ views: z.ZodObject<{
5
+ 'request.section': z.ZodArray<z.ZodObject<{
6
+ title: z.ZodOptional<z.ZodString>;
7
+ component: z.ZodUnknown;
8
+ props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
9
+ }, "strip", z.ZodTypeAny, {
10
+ title?: string | undefined;
11
+ component?: unknown;
12
+ props?: Record<string, any> | undefined;
13
+ }, {
14
+ title?: string | undefined;
15
+ component?: unknown;
16
+ props?: Record<string, any> | undefined;
17
+ }>, "many">;
18
+ 'response.section': z.ZodArray<z.ZodObject<{
19
+ title: z.ZodOptional<z.ZodString>;
20
+ component: z.ZodUnknown;
21
+ props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
22
+ }, "strip", z.ZodTypeAny, {
23
+ title?: string | undefined;
24
+ component?: unknown;
25
+ props?: Record<string, any> | undefined;
26
+ }, {
27
+ title?: string | undefined;
28
+ component?: unknown;
29
+ props?: Record<string, any> | undefined;
30
+ }>, "many">;
31
+ }, "strip", z.ZodTypeAny, {
32
+ 'request.section': {
33
+ title?: string | undefined;
34
+ component?: unknown;
35
+ props?: Record<string, any> | undefined;
36
+ }[];
37
+ 'response.section': {
38
+ title?: string | undefined;
39
+ component?: unknown;
40
+ props?: Record<string, any> | undefined;
41
+ }[];
42
+ }, {
43
+ 'request.section': {
44
+ title?: string | undefined;
45
+ component?: unknown;
46
+ props?: Record<string, any> | undefined;
47
+ }[];
48
+ 'response.section': {
49
+ title?: string | undefined;
50
+ component?: unknown;
51
+ props?: Record<string, any> | undefined;
52
+ }[];
53
+ }>;
54
+ hooks: z.ZodObject<{
55
+ onBeforeRequest: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
56
+ onResponseReceived: z.ZodFunction<z.ZodTuple<[z.ZodObject<{
57
+ response: z.ZodType<Response, z.ZodTypeDef, Response>;
58
+ operation: z.ZodRecord<z.ZodString, z.ZodAny>;
59
+ }, "strip", z.ZodTypeAny, {
60
+ response: Response;
61
+ operation: Record<string, any>;
62
+ }, {
63
+ response: Response;
64
+ operation: Record<string, any>;
65
+ }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
66
+ }, "strip", z.ZodTypeAny, {
67
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
68
+ onResponseReceived: (args_0: {
69
+ response: Response;
70
+ operation: Record<string, any>;
71
+ }, ...args: unknown[]) => void | Promise<void>;
72
+ }, {
73
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
74
+ onResponseReceived: (args_0: {
75
+ response: Response;
76
+ operation: Record<string, any>;
77
+ }, ...args: unknown[]) => void | Promise<void>;
78
+ }>;
79
+ }, "strip", z.ZodTypeAny, {
80
+ name: string;
81
+ views: {
82
+ 'request.section': {
83
+ title?: string | undefined;
84
+ component?: unknown;
85
+ props?: Record<string, any> | undefined;
86
+ }[];
87
+ 'response.section': {
88
+ title?: string | undefined;
89
+ component?: unknown;
90
+ props?: Record<string, any> | undefined;
91
+ }[];
92
+ };
93
+ hooks: {
94
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
95
+ onResponseReceived: (args_0: {
96
+ response: Response;
97
+ operation: Record<string, any>;
98
+ }, ...args: unknown[]) => void | Promise<void>;
99
+ };
100
+ }, {
101
+ name: string;
102
+ views: {
103
+ 'request.section': {
104
+ title?: string | undefined;
105
+ component?: unknown;
106
+ props?: Record<string, any> | undefined;
107
+ }[];
108
+ 'response.section': {
109
+ title?: string | undefined;
110
+ component?: unknown;
111
+ props?: Record<string, any> | undefined;
112
+ }[];
113
+ };
114
+ hooks: {
115
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
116
+ onResponseReceived: (args_0: {
117
+ response: Response;
118
+ operation: Record<string, any>;
119
+ }, ...args: unknown[]) => void | Promise<void>;
120
+ };
121
+ }>>;
122
+ export type ApiClientPlugin = z.infer<typeof ApiClientPluginSchema>;
123
+ //# sourceMappingURL=api-client-plugin.d.ts.map
package/dist/api-client/api-client-plugin.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-client-plugin.d.ts","sourceRoot":"","sources":["../../src/api-client/api-client-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AA4BvB,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAMjC,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA"}
package/dist/api-client/api-client-plugin.js ADDED
@@ -0,0 +1,32 @@
1
+ import { z } from "zod";
2
+ const SectionViewSchema = z.object({
3
+ title: z.string().optional(),
4
+ // Since this is meant to be a Vue component, we'll use unknown
5
+ component: z.unknown(),
6
+ props: z.record(z.any()).optional()
7
+ });
8
+ const ViewsSchema = z.object({
9
+ "request.section": z.array(SectionViewSchema),
10
+ "response.section": z.array(SectionViewSchema)
11
+ });
12
+ const HooksSchema = z.object({
13
+ onBeforeRequest: z.function().returns(z.union([z.void(), z.promise(z.void())])),
14
+ onResponseReceived: z.function().args(
15
+ z.object({
16
+ response: z.instanceof(Response),
17
+ // Ideally, we'd have the Operation type here, but we don't.
18
+ operation: z.record(z.any())
19
+ })
20
+ ).returns(z.union([z.void(), z.promise(z.void())]))
21
+ });
22
+ const ApiClientPluginSchema = z.function().returns(
23
+ z.object({
24
+ name: z.string(),
25
+ views: ViewsSchema,
26
+ hooks: HooksSchema
27
+ })
28
+ );
29
+ export {
30
+ ApiClientPluginSchema
31
+ };
32
+ //# sourceMappingURL=api-client-plugin.js.map
package/dist/api-client/api-client-plugin.js.map ADDED
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../src/api-client/api-client-plugin.ts"],
4
+ "sourcesContent": ["import { z } from 'zod'\n\nconst SectionViewSchema = z.object({\n title: z.string().optional(),\n // Since this is meant to be a Vue component, we'll use unknown\n component: z.unknown(),\n props: z.record(z.any()).optional(),\n})\n\nconst ViewsSchema = z.object({\n 'request.section': z.array(SectionViewSchema),\n 'response.section': z.array(SectionViewSchema),\n})\n\nconst HooksSchema = z.object({\n onBeforeRequest: z.function().returns(z.union([z.void(), z.promise(z.void())])),\n onResponseReceived: z\n .function()\n .args(\n z.object({\n response: z.instanceof(Response),\n // Ideally, we'd have the Operation type here, but we don't.\n operation: z.record(z.any()),\n }),\n )\n .returns(z.union([z.void(), z.promise(z.void())])),\n})\n\nexport const ApiClientPluginSchema = z.function().returns(\n z.object({\n name: z.string(),\n views: ViewsSchema,\n hooks: HooksSchema,\n }),\n)\n\nexport type ApiClientPlugin = z.infer<typeof ApiClientPluginSchema>\n"],
5
+ "mappings": "AAAA,SAAS,SAAS;AAElB,MAAM,oBAAoB,EAAE,OAAO;AAAA,EACjC,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE3B,WAAW,EAAE,QAAQ;AAAA,EACrB,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,SAAS;AACpC,CAAC;AAED,MAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,mBAAmB,EAAE,MAAM,iBAAiB;AAAA,EAC5C,oBAAoB,EAAE,MAAM,iBAAiB;AAC/C,CAAC;AAED,MAAM,cAAc,EAAE,OAAO;AAAA,EAC3B,iBAAiB,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAAA,EAC9E,oBAAoB,EACjB,SAAS,EACT;AAAA,IACC,EAAE,OAAO;AAAA,MACP,UAAU,EAAE,WAAW,QAAQ;AAAA;AAAA,MAE/B,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC;AAAA,IAC7B,CAAC;AAAA,EACH,EACC,QAAQ,EAAE,MAAM,CAAC,EAAE,KAAK,GAAG,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AACrD,CAAC;AAEM,MAAM,wBAAwB,EAAE,SAAS,EAAE;AAAA,EAChD,EAAE,OAAO;AAAA,IACP,MAAM,EAAE,OAAO;AAAA,IACf,OAAO;AAAA,IACP,OAAO;AAAA,EACT,CAAC;AACH;",
6
+ "names": []
7
+ }
package/dist/api-client/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export { type ApiClientPlugin, ApiClientPluginSchema } from './api-client-plugin.js';
2
+ //# sourceMappingURL=index.d.ts.map
package/dist/api-client/index.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-client/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA"}
package/dist/api-client/index.js ADDED
@@ -0,0 +1,5 @@
1
+ import { ApiClientPluginSchema } from "./api-client-plugin.js";
2
+ export {
3
+ ApiClientPluginSchema
4
+ };
5
+ //# sourceMappingURL=index.js.map
package/dist/api-client/index.js.map ADDED
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../src/api-client/index.ts"],
4
+ "sourcesContent": ["export { type ApiClientPlugin, ApiClientPluginSchema } from './api-client-plugin'\n"],
5
+ "mappings": "AAAA,SAA+B,6BAA6B;",
6
+ "names": []
7
+ }
package/dist/api-reference/api-reference-configuration.d.ts CHANGED
@@ -64,14 +64,14 @@ export declare const specConfigurationSchema: z.ZodObject<{
64
64
  */
65
65
  slug: z.ZodOptional<z.ZodString>;
66
66
  }, "strip", z.ZodTypeAny, {
67
+ title?: string | undefined;
67
68
  url?: string | undefined;
68
69
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
69
- title?: string | undefined;
70
70
  slug?: string | undefined;
71
71
  }, {
72
+ title?: string | undefined;
72
73
  url?: string | undefined;
73
74
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
74
- title?: string | undefined;
75
75
  slug?: string | undefined;
76
76
  }>;
77
77
  export type SpecConfiguration = z.infer<typeof specConfigurationSchema>;
@@ -172,14 +172,14 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
172
172
  */
173
173
  slug: z.ZodOptional<z.ZodString>;
174
174
  }, "strip", z.ZodTypeAny, {
175
+ title?: string | undefined;
175
176
  url?: string | undefined;
176
177
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
177
- title?: string | undefined;
178
178
  slug?: string | undefined;
179
179
  }, {
180
+ title?: string | undefined;
180
181
  url?: string | undefined;
181
182
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
182
- title?: string | undefined;
183
183
  slug?: string | undefined;
184
184
  }>>;
185
185
  /** Prefill authentication */
@@ -210,19 +210,140 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
210
210
  onRequestSent: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
211
211
  /** Whether to persist auth to local storage */
212
212
  persistAuth: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
213
+ /** Plugins for the API client */
214
+ plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
215
+ name: z.ZodString;
216
+ views: z.ZodObject<{
217
+ 'request.section': z.ZodArray<z.ZodObject<{
218
+ title: z.ZodOptional<z.ZodString>;
219
+ component: z.ZodUnknown;
220
+ props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
221
+ }, "strip", z.ZodTypeAny, {
222
+ title?: string | undefined;
223
+ component?: unknown;
224
+ props?: Record<string, any> | undefined;
225
+ }, {
226
+ title?: string | undefined;
227
+ component?: unknown;
228
+ props?: Record<string, any> | undefined;
229
+ }>, "many">;
230
+ 'response.section': z.ZodArray<z.ZodObject<{
231
+ title: z.ZodOptional<z.ZodString>;
232
+ component: z.ZodUnknown;
233
+ props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
234
+ }, "strip", z.ZodTypeAny, {
235
+ title?: string | undefined;
236
+ component?: unknown;
237
+ props?: Record<string, any> | undefined;
238
+ }, {
239
+ title?: string | undefined;
240
+ component?: unknown;
241
+ props?: Record<string, any> | undefined;
242
+ }>, "many">;
243
+ }, "strip", z.ZodTypeAny, {
244
+ 'request.section': {
245
+ title?: string | undefined;
246
+ component?: unknown;
247
+ props?: Record<string, any> | undefined;
248
+ }[];
249
+ 'response.section': {
250
+ title?: string | undefined;
251
+ component?: unknown;
252
+ props?: Record<string, any> | undefined;
253
+ }[];
254
+ }, {
255
+ 'request.section': {
256
+ title?: string | undefined;
257
+ component?: unknown;
258
+ props?: Record<string, any> | undefined;
259
+ }[];
260
+ 'response.section': {
261
+ title?: string | undefined;
262
+ component?: unknown;
263
+ props?: Record<string, any> | undefined;
264
+ }[];
265
+ }>;
266
+ hooks: z.ZodObject<{
267
+ onBeforeRequest: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
268
+ onResponseReceived: z.ZodFunction<z.ZodTuple<[z.ZodObject<{
269
+ response: z.ZodType<Response, z.ZodTypeDef, Response>;
270
+ operation: z.ZodRecord<z.ZodString, z.ZodAny>;
271
+ }, "strip", z.ZodTypeAny, {
272
+ response: Response;
273
+ operation: Record<string, any>;
274
+ }, {
275
+ response: Response;
276
+ operation: Record<string, any>;
277
+ }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
278
+ }, "strip", z.ZodTypeAny, {
279
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
280
+ onResponseReceived: (args_0: {
281
+ response: Response;
282
+ operation: Record<string, any>;
283
+ }, ...args: unknown[]) => void | Promise<void>;
284
+ }, {
285
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
286
+ onResponseReceived: (args_0: {
287
+ response: Response;
288
+ operation: Record<string, any>;
289
+ }, ...args: unknown[]) => void | Promise<void>;
290
+ }>;
291
+ }, "strip", z.ZodTypeAny, {
292
+ name: string;
293
+ views: {
294
+ 'request.section': {
295
+ title?: string | undefined;
296
+ component?: unknown;
297
+ props?: Record<string, any> | undefined;
298
+ }[];
299
+ 'response.section': {
300
+ title?: string | undefined;
301
+ component?: unknown;
302
+ props?: Record<string, any> | undefined;
303
+ }[];
304
+ };
305
+ hooks: {
306
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
307
+ onResponseReceived: (args_0: {
308
+ response: Response;
309
+ operation: Record<string, any>;
310
+ }, ...args: unknown[]) => void | Promise<void>;
311
+ };
312
+ }, {
313
+ name: string;
314
+ views: {
315
+ 'request.section': {
316
+ title?: string | undefined;
317
+ component?: unknown;
318
+ props?: Record<string, any> | undefined;
319
+ }[];
320
+ 'response.section': {
321
+ title?: string | undefined;
322
+ component?: unknown;
323
+ props?: Record<string, any> | undefined;
324
+ }[];
325
+ };
326
+ hooks: {
327
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
328
+ onResponseReceived: (args_0: {
329
+ response: Response;
330
+ operation: Record<string, any>;
331
+ }, ...args: unknown[]) => void | Promise<void>;
332
+ };
333
+ }>>, "many">>;
213
334
  }, "strip", z.ZodTypeAny, {
214
335
  hideClientButton: boolean;
215
336
  showSidebar: boolean;
216
337
  theme: "alternate" | "default" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none";
217
338
  persistAuth: boolean;
339
+ title?: string | undefined;
218
340
  url?: string | undefined;
219
341
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
220
- title?: string | undefined;
221
342
  slug?: string | undefined;
222
343
  spec?: {
344
+ title?: string | undefined;
223
345
  url?: string | undefined;
224
346
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
225
- title?: string | undefined;
226
347
  slug?: string | undefined;
227
348
  } | undefined;
228
349
  authentication?: any;
@@ -232,15 +353,37 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
232
353
  servers?: any[] | undefined;
233
354
  _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
234
355
  onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
356
+ plugins?: ((...args: unknown[]) => {
357
+ name: string;
358
+ views: {
359
+ 'request.section': {
360
+ title?: string | undefined;
361
+ component?: unknown;
362
+ props?: Record<string, any> | undefined;
363
+ }[];
364
+ 'response.section': {
365
+ title?: string | undefined;
366
+ component?: unknown;
367
+ props?: Record<string, any> | undefined;
368
+ }[];
369
+ };
370
+ hooks: {
371
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
372
+ onResponseReceived: (args_0: {
373
+ response: Response;
374
+ operation: Record<string, any>;
375
+ }, ...args: unknown[]) => void | Promise<void>;
376
+ };
377
+ })[] | undefined;
235
378
  }, {
379
+ title?: string | undefined;
236
380
  url?: string | undefined;
237
381
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
238
- title?: string | undefined;
239
382
  slug?: string | undefined;
240
383
  spec?: {
384
+ title?: string | undefined;
241
385
  url?: string | undefined;
242
386
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
243
- title?: string | undefined;
244
387
  slug?: string | undefined;
245
388
  } | undefined;
246
389
  authentication?: any;
@@ -254,6 +397,28 @@ export declare const apiClientConfigurationSchema: z.ZodObject<{
254
397
  _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
255
398
  onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
256
399
  persistAuth?: unknown;
400
+ plugins?: ((...args: unknown[]) => {
401
+ name: string;
402
+ views: {
403
+ 'request.section': {
404
+ title?: string | undefined;
405
+ component?: unknown;
406
+ props?: Record<string, any> | undefined;
407
+ }[];
408
+ 'response.section': {
409
+ title?: string | undefined;
410
+ component?: unknown;
411
+ props?: Record<string, any> | undefined;
412
+ }[];
413
+ };
414
+ hooks: {
415
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
416
+ onResponseReceived: (args_0: {
417
+ response: Response;
418
+ operation: Record<string, any>;
419
+ }, ...args: unknown[]) => void | Promise<void>;
420
+ };
421
+ })[] | undefined;
257
422
  }>;
258
423
  export type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>;
259
424
  /** Configuration for the Api Client without the transform since it cannot be merged */
@@ -353,14 +518,14 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
353
518
  */
354
519
  slug: z.ZodOptional<z.ZodString>;
355
520
  }, "strip", z.ZodTypeAny, {
521
+ title?: string | undefined;
356
522
  url?: string | undefined;
357
523
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
358
- title?: string | undefined;
359
524
  slug?: string | undefined;
360
525
  }, {
526
+ title?: string | undefined;
361
527
  url?: string | undefined;
362
528
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
363
- title?: string | undefined;
364
529
  slug?: string | undefined;
365
530
  }>>;
366
531
  /** Prefill authentication */
@@ -391,6 +556,127 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
391
556
  onRequestSent: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
392
557
  /** Whether to persist auth to local storage */
393
558
  persistAuth: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
559
+ /** Plugins for the API client */
560
+ plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
561
+ name: z.ZodString;
562
+ views: z.ZodObject<{
563
+ 'request.section': z.ZodArray<z.ZodObject<{
564
+ title: z.ZodOptional<z.ZodString>;
565
+ component: z.ZodUnknown;
566
+ props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
567
+ }, "strip", z.ZodTypeAny, {
568
+ title?: string | undefined;
569
+ component?: unknown;
570
+ props?: Record<string, any> | undefined;
571
+ }, {
572
+ title?: string | undefined;
573
+ component?: unknown;
574
+ props?: Record<string, any> | undefined;
575
+ }>, "many">;
576
+ 'response.section': z.ZodArray<z.ZodObject<{
577
+ title: z.ZodOptional<z.ZodString>;
578
+ component: z.ZodUnknown;
579
+ props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
580
+ }, "strip", z.ZodTypeAny, {
581
+ title?: string | undefined;
582
+ component?: unknown;
583
+ props?: Record<string, any> | undefined;
584
+ }, {
585
+ title?: string | undefined;
586
+ component?: unknown;
587
+ props?: Record<string, any> | undefined;
588
+ }>, "many">;
589
+ }, "strip", z.ZodTypeAny, {
590
+ 'request.section': {
591
+ title?: string | undefined;
592
+ component?: unknown;
593
+ props?: Record<string, any> | undefined;
594
+ }[];
595
+ 'response.section': {
596
+ title?: string | undefined;
597
+ component?: unknown;
598
+ props?: Record<string, any> | undefined;
599
+ }[];
600
+ }, {
601
+ 'request.section': {
602
+ title?: string | undefined;
603
+ component?: unknown;
604
+ props?: Record<string, any> | undefined;
605
+ }[];
606
+ 'response.section': {
607
+ title?: string | undefined;
608
+ component?: unknown;
609
+ props?: Record<string, any> | undefined;
610
+ }[];
611
+ }>;
612
+ hooks: z.ZodObject<{
613
+ onBeforeRequest: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
614
+ onResponseReceived: z.ZodFunction<z.ZodTuple<[z.ZodObject<{
615
+ response: z.ZodType<Response, z.ZodTypeDef, Response>;
616
+ operation: z.ZodRecord<z.ZodString, z.ZodAny>;
617
+ }, "strip", z.ZodTypeAny, {
618
+ response: Response;
619
+ operation: Record<string, any>;
620
+ }, {
621
+ response: Response;
622
+ operation: Record<string, any>;
623
+ }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
624
+ }, "strip", z.ZodTypeAny, {
625
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
626
+ onResponseReceived: (args_0: {
627
+ response: Response;
628
+ operation: Record<string, any>;
629
+ }, ...args: unknown[]) => void | Promise<void>;
630
+ }, {
631
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
632
+ onResponseReceived: (args_0: {
633
+ response: Response;
634
+ operation: Record<string, any>;
635
+ }, ...args: unknown[]) => void | Promise<void>;
636
+ }>;
637
+ }, "strip", z.ZodTypeAny, {
638
+ name: string;
639
+ views: {
640
+ 'request.section': {
641
+ title?: string | undefined;
642
+ component?: unknown;
643
+ props?: Record<string, any> | undefined;
644
+ }[];
645
+ 'response.section': {
646
+ title?: string | undefined;
647
+ component?: unknown;
648
+ props?: Record<string, any> | undefined;
649
+ }[];
650
+ };
651
+ hooks: {
652
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
653
+ onResponseReceived: (args_0: {
654
+ response: Response;
655
+ operation: Record<string, any>;
656
+ }, ...args: unknown[]) => void | Promise<void>;
657
+ };
658
+ }, {
659
+ name: string;
660
+ views: {
661
+ 'request.section': {
662
+ title?: string | undefined;
663
+ component?: unknown;
664
+ props?: Record<string, any> | undefined;
665
+ }[];
666
+ 'response.section': {
667
+ title?: string | undefined;
668
+ component?: unknown;
669
+ props?: Record<string, any> | undefined;
670
+ }[];
671
+ };
672
+ hooks: {
673
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
674
+ onResponseReceived: (args_0: {
675
+ response: Response;
676
+ operation: Record<string, any>;
677
+ }, ...args: unknown[]) => void | Promise<void>;
678
+ };
679
+ }>>, "many">>;
394
680
  }, {
395
681
  /**
396
682
  * The layout to use for the references
@@ -664,14 +950,14 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
664
950
  hideSearch: boolean;
665
951
  hideDarkModeToggle: boolean;
666
952
  withDefaultFonts: boolean;
953
+ title?: string | undefined;
667
954
  url?: string | undefined;
668
955
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
669
- title?: string | undefined;
670
956
  slug?: string | undefined;
671
957
  spec?: {
958
+ title?: string | undefined;
672
959
  url?: string | undefined;
673
960
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
674
- title?: string | undefined;
675
961
  slug?: string | undefined;
676
962
  } | undefined;
677
963
  authentication?: any;
@@ -681,7 +967,6 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
681
967
  servers?: any[] | undefined;
682
968
  _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
683
969
  onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
684
- proxy?: string | undefined;
685
970
  plugins?: ((...args: unknown[]) => {
686
971
  name: string;
687
972
  extensions: {
@@ -690,6 +975,7 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
690
975
  renderer?: unknown;
691
976
  }[];
692
977
  })[] | undefined;
978
+ proxy?: string | undefined;
693
979
  darkMode?: boolean | undefined;
694
980
  forceDarkModeState?: "dark" | "light" | undefined;
695
981
  metaData?: any;
@@ -733,14 +1019,14 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
733
1019
  tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
734
1020
  operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
735
1021
  }, {
1022
+ title?: string | undefined;
736
1023
  url?: string | undefined;
737
1024
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
738
- title?: string | undefined;
739
1025
  slug?: string | undefined;
740
1026
  spec?: {
1027
+ title?: string | undefined;
741
1028
  url?: string | undefined;
742
1029
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
743
- title?: string | undefined;
744
1030
  slug?: string | undefined;
745
1031
  } | undefined;
746
1032
  authentication?: any;
@@ -754,8 +1040,6 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
754
1040
  _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
755
1041
  onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
756
1042
  persistAuth?: unknown;
757
- layout?: unknown;
758
- proxy?: string | undefined;
759
1043
  plugins?: ((...args: unknown[]) => {
760
1044
  name: string;
761
1045
  extensions: {
@@ -764,6 +1048,8 @@ declare const _apiReferenceConfigurationSchema: z.ZodObject<z.objectUtil.extendS
764
1048
  renderer?: unknown;
765
1049
  }[];
766
1050
  })[] | undefined;
1051
+ layout?: unknown;
1052
+ proxy?: string | undefined;
767
1053
  isEditable?: unknown;
768
1054
  isLoading?: unknown;
769
1055
  hideModels?: unknown;
@@ -912,14 +1198,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
912
1198
  */
913
1199
  slug: z.ZodOptional<z.ZodString>;
914
1200
  }, "strip", z.ZodTypeAny, {
1201
+ title?: string | undefined;
915
1202
  url?: string | undefined;
916
1203
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
917
- title?: string | undefined;
918
1204
  slug?: string | undefined;
919
1205
  }, {
1206
+ title?: string | undefined;
920
1207
  url?: string | undefined;
921
1208
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
922
- title?: string | undefined;
923
1209
  slug?: string | undefined;
924
1210
  }>>;
925
1211
  /** Prefill authentication */
@@ -950,6 +1236,127 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
950
1236
  onRequestSent: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodVoid>>;
951
1237
  /** Whether to persist auth to local storage */
952
1238
  persistAuth: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
1239
+ /** Plugins for the API client */
1240
+ plugins: z.ZodOptional<z.ZodArray<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodObject<{
1241
+ name: z.ZodString;
1242
+ views: z.ZodObject<{
1243
+ 'request.section': z.ZodArray<z.ZodObject<{
1244
+ title: z.ZodOptional<z.ZodString>;
1245
+ component: z.ZodUnknown;
1246
+ props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1247
+ }, "strip", z.ZodTypeAny, {
1248
+ title?: string | undefined;
1249
+ component?: unknown;
1250
+ props?: Record<string, any> | undefined;
1251
+ }, {
1252
+ title?: string | undefined;
1253
+ component?: unknown;
1254
+ props?: Record<string, any> | undefined;
1255
+ }>, "many">;
1256
+ 'response.section': z.ZodArray<z.ZodObject<{
1257
+ title: z.ZodOptional<z.ZodString>;
1258
+ component: z.ZodUnknown;
1259
+ props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
1260
+ }, "strip", z.ZodTypeAny, {
1261
+ title?: string | undefined;
1262
+ component?: unknown;
1263
+ props?: Record<string, any> | undefined;
1264
+ }, {
1265
+ title?: string | undefined;
1266
+ component?: unknown;
1267
+ props?: Record<string, any> | undefined;
1268
+ }>, "many">;
1269
+ }, "strip", z.ZodTypeAny, {
1270
+ 'request.section': {
1271
+ title?: string | undefined;
1272
+ component?: unknown;
1273
+ props?: Record<string, any> | undefined;
1274
+ }[];
1275
+ 'response.section': {
1276
+ title?: string | undefined;
1277
+ component?: unknown;
1278
+ props?: Record<string, any> | undefined;
1279
+ }[];
1280
+ }, {
1281
+ 'request.section': {
1282
+ title?: string | undefined;
1283
+ component?: unknown;
1284
+ props?: Record<string, any> | undefined;
1285
+ }[];
1286
+ 'response.section': {
1287
+ title?: string | undefined;
1288
+ component?: unknown;
1289
+ props?: Record<string, any> | undefined;
1290
+ }[];
1291
+ }>;
1292
+ hooks: z.ZodObject<{
1293
+ onBeforeRequest: z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
1294
+ onResponseReceived: z.ZodFunction<z.ZodTuple<[z.ZodObject<{
1295
+ response: z.ZodType<Response, z.ZodTypeDef, Response>;
1296
+ operation: z.ZodRecord<z.ZodString, z.ZodAny>;
1297
+ }, "strip", z.ZodTypeAny, {
1298
+ response: Response;
1299
+ operation: Record<string, any>;
1300
+ }, {
1301
+ response: Response;
1302
+ operation: Record<string, any>;
1303
+ }>], z.ZodUnknown>, z.ZodUnion<[z.ZodVoid, z.ZodPromise<z.ZodVoid>]>>;
1304
+ }, "strip", z.ZodTypeAny, {
1305
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
1306
+ onResponseReceived: (args_0: {
1307
+ response: Response;
1308
+ operation: Record<string, any>;
1309
+ }, ...args: unknown[]) => void | Promise<void>;
1310
+ }, {
1311
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
1312
+ onResponseReceived: (args_0: {
1313
+ response: Response;
1314
+ operation: Record<string, any>;
1315
+ }, ...args: unknown[]) => void | Promise<void>;
1316
+ }>;
1317
+ }, "strip", z.ZodTypeAny, {
1318
+ name: string;
1319
+ views: {
1320
+ 'request.section': {
1321
+ title?: string | undefined;
1322
+ component?: unknown;
1323
+ props?: Record<string, any> | undefined;
1324
+ }[];
1325
+ 'response.section': {
1326
+ title?: string | undefined;
1327
+ component?: unknown;
1328
+ props?: Record<string, any> | undefined;
1329
+ }[];
1330
+ };
1331
+ hooks: {
1332
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
1333
+ onResponseReceived: (args_0: {
1334
+ response: Response;
1335
+ operation: Record<string, any>;
1336
+ }, ...args: unknown[]) => void | Promise<void>;
1337
+ };
1338
+ }, {
1339
+ name: string;
1340
+ views: {
1341
+ 'request.section': {
1342
+ title?: string | undefined;
1343
+ component?: unknown;
1344
+ props?: Record<string, any> | undefined;
1345
+ }[];
1346
+ 'response.section': {
1347
+ title?: string | undefined;
1348
+ component?: unknown;
1349
+ props?: Record<string, any> | undefined;
1350
+ }[];
1351
+ };
1352
+ hooks: {
1353
+ onBeforeRequest: (...args: unknown[]) => void | Promise<void>;
1354
+ onResponseReceived: (args_0: {
1355
+ response: Response;
1356
+ operation: Record<string, any>;
1357
+ }, ...args: unknown[]) => void | Promise<void>;
1358
+ };
1359
+ }>>, "many">>;
953
1360
  }, {
954
1361
  /**
955
1362
  * The layout to use for the references
@@ -1223,14 +1630,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1223
1630
  hideSearch: boolean;
1224
1631
  hideDarkModeToggle: boolean;
1225
1632
  withDefaultFonts: boolean;
1633
+ title?: string | undefined;
1226
1634
  url?: string | undefined;
1227
1635
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
1228
- title?: string | undefined;
1229
1636
  slug?: string | undefined;
1230
1637
  spec?: {
1638
+ title?: string | undefined;
1231
1639
  url?: string | undefined;
1232
1640
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
1233
- title?: string | undefined;
1234
1641
  slug?: string | undefined;
1235
1642
  } | undefined;
1236
1643
  authentication?: any;
@@ -1240,7 +1647,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1240
1647
  servers?: any[] | undefined;
1241
1648
  _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
1242
1649
  onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
1243
- proxy?: string | undefined;
1244
1650
  plugins?: ((...args: unknown[]) => {
1245
1651
  name: string;
1246
1652
  extensions: {
@@ -1249,6 +1655,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1249
1655
  renderer?: unknown;
1250
1656
  }[];
1251
1657
  })[] | undefined;
1658
+ proxy?: string | undefined;
1252
1659
  darkMode?: boolean | undefined;
1253
1660
  forceDarkModeState?: "dark" | "light" | undefined;
1254
1661
  metaData?: any;
@@ -1292,14 +1699,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1292
1699
  tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
1293
1700
  operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
1294
1701
  }, {
1702
+ title?: string | undefined;
1295
1703
  url?: string | undefined;
1296
1704
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
1297
- title?: string | undefined;
1298
1705
  slug?: string | undefined;
1299
1706
  spec?: {
1707
+ title?: string | undefined;
1300
1708
  url?: string | undefined;
1301
1709
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
1302
- title?: string | undefined;
1303
1710
  slug?: string | undefined;
1304
1711
  } | undefined;
1305
1712
  authentication?: any;
@@ -1313,8 +1720,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1313
1720
  _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
1314
1721
  onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
1315
1722
  persistAuth?: unknown;
1316
- layout?: unknown;
1317
- proxy?: string | undefined;
1318
1723
  plugins?: ((...args: unknown[]) => {
1319
1724
  name: string;
1320
1725
  extensions: {
@@ -1323,6 +1728,8 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1323
1728
  renderer?: unknown;
1324
1729
  }[];
1325
1730
  })[] | undefined;
1731
+ layout?: unknown;
1732
+ proxy?: string | undefined;
1326
1733
  isEditable?: unknown;
1327
1734
  isLoading?: unknown;
1328
1735
  hideModels?: unknown;
@@ -1387,14 +1794,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1387
1794
  hideSearch: boolean;
1388
1795
  hideDarkModeToggle: boolean;
1389
1796
  withDefaultFonts: boolean;
1797
+ title?: string | undefined;
1390
1798
  url?: string | undefined;
1391
1799
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
1392
- title?: string | undefined;
1393
1800
  slug?: string | undefined;
1394
1801
  spec?: {
1802
+ title?: string | undefined;
1395
1803
  url?: string | undefined;
1396
1804
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
1397
- title?: string | undefined;
1398
1805
  slug?: string | undefined;
1399
1806
  } | undefined;
1400
1807
  authentication?: any;
@@ -1404,7 +1811,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1404
1811
  servers?: any[] | undefined;
1405
1812
  _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
1406
1813
  onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
1407
- proxy?: string | undefined;
1408
1814
  plugins?: ((...args: unknown[]) => {
1409
1815
  name: string;
1410
1816
  extensions: {
@@ -1413,6 +1819,7 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1413
1819
  renderer?: unknown;
1414
1820
  }[];
1415
1821
  })[] | undefined;
1822
+ proxy?: string | undefined;
1416
1823
  darkMode?: boolean | undefined;
1417
1824
  forceDarkModeState?: "dark" | "light" | undefined;
1418
1825
  metaData?: any;
@@ -1456,14 +1863,14 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1456
1863
  tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
1457
1864
  operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
1458
1865
  }, {
1866
+ title?: string | undefined;
1459
1867
  url?: string | undefined;
1460
1868
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
1461
- title?: string | undefined;
1462
1869
  slug?: string | undefined;
1463
1870
  spec?: {
1871
+ title?: string | undefined;
1464
1872
  url?: string | undefined;
1465
1873
  content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
1466
- title?: string | undefined;
1467
1874
  slug?: string | undefined;
1468
1875
  } | undefined;
1469
1876
  authentication?: any;
@@ -1477,8 +1884,6 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1477
1884
  _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
1478
1885
  onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
1479
1886
  persistAuth?: unknown;
1480
- layout?: unknown;
1481
- proxy?: string | undefined;
1482
1887
  plugins?: ((...args: unknown[]) => {
1483
1888
  name: string;
1484
1889
  extensions: {
@@ -1487,6 +1892,8 @@ export declare const apiReferenceConfigurationSchema: z.ZodEffects<z.ZodObject<z
1487
1892
  renderer?: unknown;
1488
1893
  }[];
1489
1894
  })[] | undefined;
1895
+ layout?: unknown;
1896
+ proxy?: string | undefined;
1490
1897
  isEditable?: unknown;
1491
1898
  isLoading?: unknown;
1492
1899
  hideModels?: unknown;
package/dist/api-reference/api-reference-configuration.d.ts.map CHANGED
@@ -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,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AA6EjF,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB;IAClC;;;;;;;;;;;;;;;;;QAiBI;;IAEJ;;;;;;;;;;;;;;;;;;;;QAoBI;;IAEJ;;;;;;OAMG;;IAEH;;;;;;;;;;OAUG;;;;;;;;;;;;EAEH,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAQvE,uCAAuC;AACvC,eAAO,MAAM,4BAA4B;IACvC;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;IAElC,oDAAoD;;IAEpD,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE/C,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEjF,uFAAuF;AACvF,QAAA,MAAM,gCAAgC;IAlEpC;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;IAElC,oDAAoD;;IAEpD,+CAA+C;;;IAS7C;;;OAGG;;IAEH;;;OAGG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD,4DAA4D;;IAE5D,wDAAwD;;IAExD;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;;OAKG;;QAjLL,sCAAsC;;;;;;;IAmLpC;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKN,CAAA;AAsDD,0CAA0C;AAC1C,eAAO,MAAM,+BAA+B;IA5V1C;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;IAElC,oDAAoD;;IAEpD,+CAA+C;;;IAS7C;;;OAGG;;IAEH;;;OAGG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD,4DAA4D;;IAE5D,wDAAwD;;IAExD;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;;OAKG;;QAjLL,sCAAsC;;;;;;;IAmLpC;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4DwG,CAAA;AAE/G,yDAAyD;AACzD,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,EAEhD,OAAO,GAAG,MAAM,GAAG,gBAAgB,CACpC,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED,mDAAmD;AACnD,KAAK,oCAAoC,GAAG,yBAAyB,GAAG;IACtE,oDAAoD;IACpD,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,qDAAqD;AACrD,MAAM,MAAM,oCAAoC,GAAG,IAAI,CAAC,oCAAoC,EAAE,SAAS,CAAC,GAAG;IACzG,OAAO,EAAE,CAAC,iBAAiB,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,EAAE,CAAA;CACvD,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,OAAO,CAAC,yBAAyB,CAAC,GAClC,OAAO,CAAC,oCAAoC,CAAC,GAC7C,OAAO,CAAC,oCAAoC,CAAC,EAAE,GAC/C,OAAO,CAAC,oCAAoC,CAAC,EAAE,CAAA;AAEnD,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,WAC7B,4BAA4B,KACnC,MAAM,IAAI,OAAO,CAAC,oCAAoC,CAC0C,CAAA"}
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;AAKvB,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AA6EjF,0DAA0D;AAC1D,eAAO,MAAM,uBAAuB;IAClC;;;;;;;;;;;;;;;;;QAiBI;;IAEJ;;;;;;;;;;;;;;;;;;;;QAoBI;;IAEJ;;;;;;OAMG;;IAEH;;;;;;;;;;OAUG;;;;;;;;;;;;EAEH,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAQvE,uCAAuC;AACvC,eAAO,MAAM,4BAA4B;IACvC;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;IAElC,oDAAoD;;IAEpD,+CAA+C;;IAE/C,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEjC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEjF,uFAAuF;AACvF,QAAA,MAAM,gCAAgC;IApEpC;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;IAElC,oDAAoD;;IAEpD,+CAA+C;;IAE/C,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAS/B;;;OAGG;;IAEH;;;OAGG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD,4DAA4D;;IAE5D,wDAAwD;;IAExD;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;;OAKG;;QAnLL,sCAAsC;;;;;;;IAqLpC;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKN,CAAA;AAsDD,0CAA0C;AAC1C,eAAO,MAAM,+BAA+B;IA9V1C;;QAEI;;IAEJ;;;;;QAKI;;IAEJ;;;;OAIG;;IAEH;;;;;;;;OAQG;;IAEH;;;;QAII;;QAvGJ;;;;;;;;;;;;;;;;;YAiBI;;QAEJ;;;;;;;;;;;;;;;;;;;;YAoBI;;QAEJ;;;;;;WAMG;;QAEH;;;;;;;;;;WAUG;;;;;;;;;;;;;IA8CH,6BAA6B;;IAE7B,kCAAkC;;IAElC;;;OAGG;;IAEH,gDAAgD;;IAEhD,mFAAmF;;IAEnF,qCAAqC;;IAErC;;;OAGG;;IAEH,+CAA+C;;IAE/C,kCAAkC;;IAElC,oDAAoD;;IAEpD,+CAA+C;;IAE/C,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAS/B;;;OAGG;;IAEH;;;OAGG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,4DAA4D;;IAE5D,mEAAmE;;IAEnE;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;OAIG;;IAEH;;;OAGG;;IAIH,2DAA2D;;;;;;;;;;;IAO3D,yCAAyC;;IAEzC,2DAA2D;;IAE3D,wDAAwD;;IAExD,4DAA4D;;IAE5D,wDAAwD;;IAExD;;;OAGG;;IAEH;;;OAGG;;IAEH;;;;;OAKG;;QAnLL,sCAAsC;;;;;;;IAqLpC;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;IAUH;;;;;OAKG;;;;;;;;;;;;;;;;;IAaH;;;;;OAKG;;;;;;;;;;;IAWH;;;;;;;;;;;;;;;;;;;OAmBG;;IAEH;;;OAGG;;IAEH,4CAA4C;;IAE5C;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4DwG,CAAA;AAE/G,yDAAyD;AACzD,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,EAEhD,OAAO,GAAG,MAAM,GAAG,gBAAgB,CACpC,GAAG;IACF,cAAc,CAAC,EAAE,2BAA2B,CAAA;CAC7C,CAAA;AAED,mDAAmD;AACnD,KAAK,oCAAoC,GAAG,yBAAyB,GAAG;IACtE,oDAAoD;IACpD,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,qDAAqD;AACrD,MAAM,MAAM,oCAAoC,GAAG,IAAI,CAAC,oCAAoC,EAAE,SAAS,CAAC,GAAG;IACzG,OAAO,EAAE,CAAC,iBAAiB,GAAG;QAAE,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,EAAE,CAAA;CACvD,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,4BAA4B,GACpC,OAAO,CAAC,yBAAyB,CAAC,GAClC,OAAO,CAAC,oCAAoC,CAAC,GAC7C,OAAO,CAAC,oCAAoC,CAAC,EAAE,GAC/C,OAAO,CAAC,oCAAoC,CAAC,EAAE,CAAA;AAEnD,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,WAC7B,4BAA4B,KACnC,MAAM,IAAI,OAAO,CAAC,oCAAoC,CAC0C,CAAA"}
package/dist/api-reference/api-reference-configuration.js CHANGED
@@ -1,4 +1,5 @@
1
1
  import { z } from "zod";
2
+ import { ApiClientPluginSchema } from "../api-client/index.js";
2
3
  import { ApiReferencePluginSchema } from "./api-reference-plugin.js";
3
4
  const themeIdEnum = z.enum([
4
5
  "alternate",
@@ -197,7 +198,9 @@ const apiClientConfigurationSchema = z.object({
197
198
  /** onRequestSent is fired when a request is sent */
198
199
  onRequestSent: z.function().args(z.string()).returns(z.void()).optional(),
199
200
  /** Whether to persist auth to local storage */
200
- persistAuth: z.boolean().optional().default(false).catch(false)
201
+ persistAuth: z.boolean().optional().default(false).catch(false),
202
+ /** Plugins for the API client */
203
+ plugins: z.array(ApiClientPluginSchema).optional()
201
204
  });
202
205
  const _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(
203
206
  z.object({
package/dist/api-reference/api-reference-configuration.js.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../src/api-reference/api-reference-configuration.ts"],
4
- "sourcesContent": ["import { z } from 'zod'\n\nimport { ApiReferencePluginSchema } from './api-reference-plugin'\nimport type { TargetId } from '../snippetz/index'\nimport type { AuthenticationConfiguration } from './authentication-configuration'\n\n/** Available theme presets for the API reference */\nconst themeIdEnum = z.enum([\n 'alternate',\n 'default',\n 'moon',\n 'purple',\n 'solarized',\n 'bluePlanet',\n 'deepSpace',\n 'saturn',\n 'kepler',\n 'elysiajs',\n 'fastify',\n 'mars',\n 'laserwave',\n 'none',\n])\n\n/** Valid keys that can be used with CTRL/CMD to open the search modal */\nconst searchHotKeyEnum = z.enum([\n 'a',\n 'b',\n 'c',\n 'd',\n 'e',\n 'f',\n 'g',\n 'h',\n 'i',\n 'j',\n 'k',\n 'l',\n 'm',\n 'n',\n 'o',\n 'p',\n 'q',\n 'r',\n 's',\n 't',\n 'u',\n 'v',\n 'w',\n 'x',\n 'y',\n 'z',\n])\n\n/** Supported integration types */\nconst integrationEnum = z\n .enum([\n 'adonisjs',\n 'docusaurus',\n 'dotnet',\n 'elysiajs',\n 'express',\n 'fastapi',\n 'fastify',\n 'go',\n 'hono',\n 'html',\n 'laravel',\n 'litestar',\n 'nestjs',\n 'nextjs',\n 'nitro',\n 'nuxt',\n 'platformatic',\n 'react',\n 'rust',\n 'svelte',\n 'vue',\n ])\n .nullable()\n\n/** Configuration for the OpenAPI/Swagger specification */\nexport const specConfigurationSchema = z.object({\n /**\n * URL to an OpenAPI/Swagger document\n *\n * @deprecated Please move `url` to the top level and remove the `spec` prefix.\n *\n * @example\n * ```ts\n * const oldConfiguration = {\n * spec: {\n * url: 'https://example.com/openapi.json',\n * },\n * }\n *\n * const newConfiguration = {\n * url: 'https://example.com/openapi.json',\n * }\n * ```\n **/\n url: z.string().optional(),\n /**\n * Directly embed the OpenAPI document.\n * Can be a string, object, function returning an object, or null.\n *\n * @remarks It's recommended to pass a URL instead of content.\n *\n * @deprecated Please move `content` to the top level and remove the `spec` prefix.\n *\n * @example\n * ```ts\n * const oldConfiguration = {\n * spec: {\n * content: '\u2026',\n * },\n * }\n *\n * const newConfiguration = {\n * content: '\u2026',\n * }\n * ```\n **/\n content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),\n /**\n * The title of the OpenAPI document.\n *\n * @example 'Scalar Galaxy'\n *\n * @deprecated Please move `title` to the top level and remove the `spec` prefix.\n */\n title: z.string().optional(),\n /**\n * The slug of the OpenAPI document used in the URL.\n *\n * If none is passed, the title will be used.\n *\n * If no title is used, it'll just use the index.\n *\n * @example 'scalar-galaxy'\n *\n * @deprecated Please move `slug` to the top level and remove the `spec` prefix.\n */\n slug: z.string().optional(),\n})\nexport type SpecConfiguration = z.infer<typeof specConfigurationSchema>\n\n/** Configuration for path-based routing */\nconst pathRoutingSchema = z.object({\n /** Base path for the API reference */\n basePath: z.string(),\n})\n\n/** Configuration for the Api Client */\nexport const apiClientConfigurationSchema = z.object({\n /**\n * URL to an OpenAPI/Swagger document\n **/\n url: z.string().optional(),\n /**\n * Directly embed the OpenAPI document.\n * Can be a string, object, function returning an object, or null.\n *\n * @remarks It's recommended to pass a URL instead of content.\n **/\n content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),\n /**\n * The title of the OpenAPI document.\n *\n * @example 'Scalar Galaxy'\n */\n title: z.string().optional(),\n /**\n * The slug of the OpenAPI document used in the URL.\n *\n * If none is passed, the title will be used.\n *\n * If no title is used, it'll just use the index.\n *\n * @example 'scalar-galaxy'\n */\n slug: z.string().optional(),\n /**\n * The OpenAPI/Swagger document to render\n *\n * @deprecated Use `url` and `content` on the top level instead.\n **/\n spec: specConfigurationSchema.optional(),\n /** Prefill authentication */\n authentication: z.any().optional(), // Temp until we bring in the new auth\n /** Base URL for the API server */\n baseServerURL: z.string().optional(),\n /**\n * Whether to hide the client button\n * @default false\n */\n hideClientButton: z.boolean().optional().default(false).catch(false),\n /** URL to a request proxy for the API client */\n proxyUrl: z.string().optional(),\n /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */\n searchHotKey: searchHotKeyEnum.optional(),\n /** List of OpenAPI server objects */\n servers: z.array(z.any()).optional(), // Using any for OpenAPIV3_1.ServerObject\n /**\n * Whether to show the sidebar\n * @default true\n */\n showSidebar: z.boolean().optional().default(true).catch(true),\n /** A string to use one of the color presets */\n theme: themeIdEnum.optional().default('default').catch('default'),\n /** Integration type identifier */\n _integration: integrationEnum.optional(),\n /** onRequestSent is fired when a request is sent */\n onRequestSent: z.function().args(z.string()).returns(z.void()).optional(),\n /** Whether to persist auth to local storage */\n persistAuth: z.boolean().optional().default(false).catch(false),\n})\n\nexport type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>\n\n/** Configuration for the Api Client without the transform since it cannot be merged */\nconst _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(\n z.object({\n /**\n * The layout to use for the references\n * @default 'modern'\n */\n layout: z.enum(['modern', 'classic']).optional().default('modern').catch('modern'),\n /**\n * URL to a request proxy for the API client\n * @deprecated Use proxyUrl instead\n */\n proxy: z.string().optional(),\n /**\n * Plugins for the API reference\n */\n plugins: z.array(ApiReferencePluginSchema).optional(),\n /**\n * Allows the user to inject an editor for the spec\n * @default false\n */\n isEditable: z.boolean().optional().default(false).catch(false),\n /**\n * Controls whether the references show a loading state in the intro\n * @default false\n */\n isLoading: z.boolean().optional().default(false).catch(false),\n /**\n * Whether to show models in the sidebar, search, and content.\n * @default false\n */\n hideModels: z.boolean().optional().default(false).catch(false),\n /**\n * Whether to show the \"Download OpenAPI Document\" button\n * @default false\n */\n hideDownloadButton: z.boolean().optional().default(false).catch(false),\n /**\n * Whether to show the \"Test Request\" button\n * @default false\n */\n hideTestRequestButton: z.boolean().optional().default(false).catch(false),\n /**\n * Whether to show the sidebar search bar\n * @default false\n */\n hideSearch: z.boolean().optional().default(false).catch(false),\n /** Whether dark mode is on or off initially (light mode) */\n darkMode: z.boolean().optional(),\n /** forceDarkModeState makes it always this state no matter what */\n forceDarkModeState: z.enum(['dark', 'light']).optional(),\n /**\n * Whether to show the dark mode toggle\n * @default false\n */\n hideDarkModeToggle: z.boolean().optional().default(false).catch(false),\n /**\n * If used, passed data will be added to the HTML header\n * @see https://unhead.unjs.io/usage/composables/use-seo-meta\n */\n metaData: z.any().optional(), // Using any for UseSeoMetaInput since it's an external type\n /**\n * Path to a favicon image\n * @default undefined\n * @example '/favicon.svg'\n */\n favicon: z.string().optional(),\n /**\n * List of httpsnippet clients to hide from the clients menu\n * By default hides Unirest, pass `[]` to show all clients\n */\n hiddenClients: z\n .union([z.record(z.union([z.boolean(), z.array(z.string())])), z.array(z.string()), z.literal(true)])\n .optional(),\n /** Determine the HTTP client that's selected by default */\n defaultHttpClient: z\n .object({\n targetKey: z.custom<TargetId>(),\n clientKey: z.string(),\n })\n .optional(),\n /** Custom CSS to be added to the page */\n customCss: z.string().optional(),\n /** onSpecUpdate is fired on spec/swagger content change */\n onSpecUpdate: z.function().args(z.string()).returns(z.void()).optional(),\n /** onServerChange is fired on selected server change */\n onServerChange: z.function().args(z.string()).returns(z.void()).optional(),\n /** onDocumentSelect is fired when the config is selected */\n onDocumentSelect: z.function().returns(z.void().or(z.void().promise())).optional(),\n /** Callback fired when the reference is fully loaded */\n onLoaded: z.function().returns(z.void().or(z.void().promise())).optional(),\n /**\n * onShowMore is fired when the user clicks the \"Show more\" button on the references\n * @param tagId - The ID of the tag that was clicked\n */\n onShowMore: z.function().args(z.string()).returns(z.void().or(z.void().promise())).optional(),\n /**\n * onSidebarClick is fired when the user clicks on a sidebar item\n * @param href - The href of the sidebar item that was clicked\n */\n onSidebarClick: z.function().args(z.string()).returns(z.void().or(z.void().promise())).optional(),\n /**\n * Route using paths instead of hashes, your server MUST support this\n * @example '/standalone-api-reference/:custom(.*)?'\n * @experimental\n * @default undefined\n */\n pathRouting: pathRoutingSchema.optional(),\n /**\n * Customize the heading portion of the hash\n * @param heading - The heading object\n * @returns A string ID used to generate the URL hash\n * @default (heading) => `#description/${heading.slug}`\n */\n generateHeadingSlug: z\n .function()\n .args(\n z.object({\n slug: z.string().default('headingSlug'),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * Customize the model portion of the hash\n * @param model - The model object with a name property\n * @returns A string ID used to generate the URL hash\n * @default (model) => slug(model.name)\n */\n generateModelSlug: z\n .function()\n .args(\n z.object({\n name: z.string().default('modelName'),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * Customize the tag portion of the hash\n * @param tag - The tag object\n * @returns A string ID used to generate the URL hash\n * @default (tag) => slug(tag.name)\n */\n generateTagSlug: z\n .function()\n .args(\n z.object({\n name: z.string().default('tagName'),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * Customize the operation portion of the hash\n * @param operation - The operation object\n * @returns A string ID used to generate the URL hash\n * @default (operation) => `${operation.method}${operation.path}`\n */\n generateOperationSlug: z\n .function()\n .args(\n z.object({\n path: z.string(),\n operationId: z.string().optional(),\n method: z.string(),\n summary: z.string().optional(),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * Customize the webhook portion of the hash\n * @param webhook - The webhook object\n * @returns A string ID used to generate the URL hash\n * @default (webhook) => slug(webhook.name)\n */\n generateWebhookSlug: z\n .function()\n .args(\n z.object({\n name: z.string(),\n method: z.string().optional(),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * To handle redirects, pass a function that will recieve:\n * - The current path with hash if pathRouting is enabled\n * - The current hash if hashRouting (default)\n * And then passes that to history.replaceState\n *\n * @example hashRouting (default)\n * ```ts\n * redirect: (hash: string) => hash.replace('#v1/old-path', '#v2/new-path')\n * ```\n * @example pathRouting\n * ```ts\n * redirect: (pathWithHash: string) => {\n * if (pathWithHash.includes('#')) {\n * return pathWithHash.replace('/v1/tags/user#operation/get-user', '/v1/tags/user/operation/get-user')\n * }\n * return null\n * }\n * ```\n */\n redirect: z.function().args(z.string()).returns(z.string().nullable().optional()).optional(),\n /**\n * Whether to include default fonts\n * @default true\n */\n withDefaultFonts: z.boolean().optional().default(true).catch(true),\n /** Whether to expand all tags by default */\n defaultOpenAllTags: z.boolean().optional(),\n /**\n * Function to sort tags\n * @default 'alpha' for alphabetical sorting\n */\n tagsSorter: z.union([z.literal('alpha'), z.function().args(z.any(), z.any()).returns(z.number())]).optional(),\n /**\n * Function to sort operations\n * @default 'alpha' for alphabetical sorting\n */\n operationsSorter: z\n .union([z.literal('alpha'), z.literal('method'), z.function().args(z.any(), z.any()).returns(z.number())])\n .optional(),\n }),\n)\n\nconst OLD_PROXY_URL = 'https://api.scalar.com/request-proxy'\nconst NEW_PROXY_URL = 'https://proxy.scalar.com'\n\n/** Migrate the configuration through a transform */\nconst migrateConfiguration = <T extends z.infer<typeof _apiReferenceConfigurationSchema>>(_configuration: T): T => {\n const configuration = { ..._configuration }\n\n // Remove the spec prefix\n if (configuration.spec?.url) {\n console.warn(\n `[DEPRECATED] You're using the deprecated 'spec.url' attribute. Remove the spec prefix and move the 'url' attribute to the top level.`,\n )\n\n configuration.url = configuration.spec.url\n delete configuration.spec\n }\n\n if (configuration.spec?.content) {\n console.warn(\n `[DEPRECATED] You're using the deprecated 'spec.content' attribute. Remove the spec prefix and move the 'content' attribute to the top level.`,\n )\n\n configuration.content = configuration.spec.content\n delete configuration.spec\n }\n\n // Migrate proxy URL\n if (configuration.proxy) {\n console.warn(\n `[DEPRECATED] You're using the deprecated 'proxy' attribute, rename it to 'proxyUrl' or update the package.`,\n )\n\n if (!configuration.proxyUrl) {\n configuration.proxyUrl = configuration.proxy\n }\n\n delete configuration.proxy\n }\n\n if (configuration.proxyUrl === OLD_PROXY_URL) {\n console.warn(`[DEPRECATED] Warning: configuration.proxyUrl points to our old proxy (${OLD_PROXY_URL}).`)\n console.warn(`[DEPRECATED] We are overwriting the value and use the new proxy URL (${NEW_PROXY_URL}) instead.`)\n console.warn(\n `[DEPRECATED] Action Required: You should manually update your configuration to use the new URL (${NEW_PROXY_URL}). Read more: https://github.com/scalar/scalar`,\n )\n\n configuration.proxyUrl = NEW_PROXY_URL\n }\n\n return configuration\n}\n\n/** Configuration for the Api Reference */\nexport const apiReferenceConfigurationSchema = _apiReferenceConfigurationSchema.transform(migrateConfiguration)\n\n/** Configuration after parsing, this is the main type */\nexport type ApiReferenceConfiguration = Omit<\n z.infer<typeof _apiReferenceConfigurationSchema>,\n // Remove deprecated attributes\n 'proxy' | 'spec' | 'authentication'\n> & {\n authentication?: AuthenticationConfiguration\n}\n\n/** Api Config which includes the default config */\ntype ApiReferenceConfigurationWithDefault = ApiReferenceConfiguration & {\n /** Whether to use this config as the default one */\n default?: boolean\n}\n\n/** Configuration for a single config with sources */\nexport type ApiReferenceConfigurationWithSources = Omit<ApiReferenceConfigurationWithDefault, 'default'> & {\n sources: (SpecConfiguration & { default?: boolean })[]\n}\n\n/** Configuration for multiple Api References */\nexport type AnyApiReferenceConfiguration =\n | Partial<ApiReferenceConfiguration>\n | Partial<ApiReferenceConfigurationWithSources>\n | Partial<ApiReferenceConfigurationWithDefault>[]\n | Partial<ApiReferenceConfigurationWithSources>[]\n\n/** Typeguard to check to narrow the configs to the one with sources */\nexport const isConfigurationWithSources = (\n config: AnyApiReferenceConfiguration,\n): config is Partial<ApiReferenceConfigurationWithSources> =>\n Boolean(!Array.isArray(config) && config && 'sources' in config && Array.isArray(config.sources))\n"],
5
- "mappings": "AAAA,SAAS,SAAS;AAElB,SAAS,gCAAgC;AAKzC,MAAM,cAAc,EAAE,KAAK;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAGD,MAAM,mBAAmB,EAAE,KAAK;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAGD,MAAM,kBAAkB,EACrB,KAAK;AAAA,EACJ;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC,EACA,SAAS;AAGL,MAAM,0BAA0B,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmB9C,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBzB,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9G,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY3B,MAAM,EAAE,OAAO,EAAE,SAAS;AAC5B,CAAC;AAID,MAAM,oBAAoB,EAAE,OAAO;AAAA;AAAA,EAEjC,UAAU,EAAE,OAAO;AACrB,CAAC;AAGM,MAAM,+BAA+B,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAInD,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOzB,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM9G,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAU3B,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM1B,MAAM,wBAAwB,SAAS;AAAA;AAAA,EAEvC,gBAAgB,EAAE,IAAI,EAAE,SAAS;AAAA;AAAA;AAAA,EAEjC,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnC,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA,EAEnE,UAAU,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE9B,cAAc,iBAAiB,SAAS;AAAA;AAAA,EAExC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnC,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,IAAI,EAAE,MAAM,IAAI;AAAA;AAAA,EAE5D,OAAO,YAAY,SAAS,EAAE,QAAQ,SAAS,EAAE,MAAM,SAAS;AAAA;AAAA,EAEhE,cAAc,gBAAgB,SAAS;AAAA;AAAA,EAEvC,eAAe,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,SAAS;AAAA;AAAA,EAExE,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAChE,CAAC;AAKD,MAAM,mCAAmC,6BAA6B;AAAA,EACpE,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,IAKP,QAAQ,EAAE,KAAK,CAAC,UAAU,SAAS,CAAC,EAAE,SAAS,EAAE,QAAQ,QAAQ,EAAE,MAAM,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA,IAKjF,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,IAI3B,SAAS,EAAE,MAAM,wBAAwB,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAKpD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAK5D,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,oBAAoB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAKrE,uBAAuB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAKxE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA,IAE7D,UAAU,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA,IAE/B,oBAAoB,EAAE,KAAK,CAAC,QAAQ,OAAO,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAKvD,oBAAoB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAKrE,UAAU,EAAE,IAAI,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM3B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7B,eAAe,EACZ,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,QAAQ,IAAI,CAAC,CAAC,EACnG,SAAS;AAAA;AAAA,IAEZ,mBAAmB,EAChB,OAAO;AAAA,MACN,WAAW,EAAE,OAAiB;AAAA,MAC9B,WAAW,EAAE,OAAO;AAAA,IACtB,CAAC,EACA,SAAS;AAAA;AAAA,IAEZ,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,IAE/B,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,SAAS;AAAA;AAAA,IAEvE,gBAAgB,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,SAAS;AAAA;AAAA,IAEzE,kBAAkB,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA,IAEjF,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAKzE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAK5F,gBAAgB,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOhG,aAAa,kBAAkB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOxC,qBAAqB,EAClB,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO,EAAE,QAAQ,aAAa;AAAA,MACxC,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOZ,mBAAmB,EAChB,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO,EAAE,QAAQ,WAAW;AAAA,MACtC,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOZ,iBAAiB,EACd,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO,EAAE,QAAQ,SAAS;AAAA,MACpC,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOZ,uBAAuB,EACpB,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO;AAAA,QACf,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,QACjC,QAAQ,EAAE,OAAO;AAAA,QACjB,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,MAC/B,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOZ,qBAAqB,EAClB,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO;AAAA,QACf,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,MAC9B,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAqBZ,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAK3F,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,IAAI,EAAE,MAAM,IAAI;AAAA;AAAA,IAEjE,oBAAoB,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAKzC,YAAY,EAAE,MAAM,CAAC,EAAE,QAAQ,OAAO,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAK5G,kBAAkB,EACf,MAAM,CAAC,EAAE,QAAQ,OAAO,GAAG,EAAE,QAAQ,QAAQ,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EACxG,SAAS;AAAA,EACd,CAAC;AACH;AAEA,MAAM,gBAAgB;AACtB,MAAM,gBAAgB;AAGtB,MAAM,uBAAuB,CAA6D,mBAAyB;AACjH,QAAM,gBAAgB,EAAE,GAAG,eAAe;AAG1C,MAAI,cAAc,MAAM,KAAK;AAC3B,YAAQ;AAAA,MACN;AAAA,IACF;AAEA,kBAAc,MAAM,cAAc,KAAK;AACvC,WAAO,cAAc;AAAA,EACvB;AAEA,MAAI,cAAc,MAAM,SAAS;AAC/B,YAAQ;AAAA,MACN;AAAA,IACF;AAEA,kBAAc,UAAU,cAAc,KAAK;AAC3C,WAAO,cAAc;AAAA,EACvB;AAGA,MAAI,cAAc,OAAO;AACvB,YAAQ;AAAA,MACN;AAAA,IACF;AAEA,QAAI,CAAC,cAAc,UAAU;AAC3B,oBAAc,WAAW,cAAc;AAAA,IACzC;AAEA,WAAO,cAAc;AAAA,EACvB;AAEA,MAAI,cAAc,aAAa,eAAe;AAC5C,YAAQ,KAAK,yEAAyE,aAAa,IAAI;AACvG,YAAQ,KAAK,wEAAwE,aAAa,YAAY;AAC9G,YAAQ;AAAA,MACN,mGAAmG,aAAa;AAAA,IAClH;AAEA,kBAAc,WAAW;AAAA,EAC3B;AAEA,SAAO;AACT;AAGO,MAAM,kCAAkC,iCAAiC,UAAU,oBAAoB;AA8BvG,MAAM,6BAA6B,CACxC,WAEA,QAAQ,CAAC,MAAM,QAAQ,MAAM,KAAK,UAAU,aAAa,UAAU,MAAM,QAAQ,OAAO,OAAO,CAAC;",
4
+ "sourcesContent": ["import { z } from 'zod'\n\nimport { ApiClientPluginSchema } from '../api-client'\nimport type { TargetId } from '../snippetz'\nimport { ApiReferencePluginSchema } from './api-reference-plugin'\nimport type { AuthenticationConfiguration } from './authentication-configuration'\n\n/** Available theme presets for the API reference */\nconst themeIdEnum = z.enum([\n 'alternate',\n 'default',\n 'moon',\n 'purple',\n 'solarized',\n 'bluePlanet',\n 'deepSpace',\n 'saturn',\n 'kepler',\n 'elysiajs',\n 'fastify',\n 'mars',\n 'laserwave',\n 'none',\n])\n\n/** Valid keys that can be used with CTRL/CMD to open the search modal */\nconst searchHotKeyEnum = z.enum([\n 'a',\n 'b',\n 'c',\n 'd',\n 'e',\n 'f',\n 'g',\n 'h',\n 'i',\n 'j',\n 'k',\n 'l',\n 'm',\n 'n',\n 'o',\n 'p',\n 'q',\n 'r',\n 's',\n 't',\n 'u',\n 'v',\n 'w',\n 'x',\n 'y',\n 'z',\n])\n\n/** Supported integration types */\nconst integrationEnum = z\n .enum([\n 'adonisjs',\n 'docusaurus',\n 'dotnet',\n 'elysiajs',\n 'express',\n 'fastapi',\n 'fastify',\n 'go',\n 'hono',\n 'html',\n 'laravel',\n 'litestar',\n 'nestjs',\n 'nextjs',\n 'nitro',\n 'nuxt',\n 'platformatic',\n 'react',\n 'rust',\n 'svelte',\n 'vue',\n ])\n .nullable()\n\n/** Configuration for the OpenAPI/Swagger specification */\nexport const specConfigurationSchema = z.object({\n /**\n * URL to an OpenAPI/Swagger document\n *\n * @deprecated Please move `url` to the top level and remove the `spec` prefix.\n *\n * @example\n * ```ts\n * const oldConfiguration = {\n * spec: {\n * url: 'https://example.com/openapi.json',\n * },\n * }\n *\n * const newConfiguration = {\n * url: 'https://example.com/openapi.json',\n * }\n * ```\n **/\n url: z.string().optional(),\n /**\n * Directly embed the OpenAPI document.\n * Can be a string, object, function returning an object, or null.\n *\n * @remarks It's recommended to pass a URL instead of content.\n *\n * @deprecated Please move `content` to the top level and remove the `spec` prefix.\n *\n * @example\n * ```ts\n * const oldConfiguration = {\n * spec: {\n * content: '\u2026',\n * },\n * }\n *\n * const newConfiguration = {\n * content: '\u2026',\n * }\n * ```\n **/\n content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),\n /**\n * The title of the OpenAPI document.\n *\n * @example 'Scalar Galaxy'\n *\n * @deprecated Please move `title` to the top level and remove the `spec` prefix.\n */\n title: z.string().optional(),\n /**\n * The slug of the OpenAPI document used in the URL.\n *\n * If none is passed, the title will be used.\n *\n * If no title is used, it'll just use the index.\n *\n * @example 'scalar-galaxy'\n *\n * @deprecated Please move `slug` to the top level and remove the `spec` prefix.\n */\n slug: z.string().optional(),\n})\nexport type SpecConfiguration = z.infer<typeof specConfigurationSchema>\n\n/** Configuration for path-based routing */\nconst pathRoutingSchema = z.object({\n /** Base path for the API reference */\n basePath: z.string(),\n})\n\n/** Configuration for the Api Client */\nexport const apiClientConfigurationSchema = z.object({\n /**\n * URL to an OpenAPI/Swagger document\n **/\n url: z.string().optional(),\n /**\n * Directly embed the OpenAPI document.\n * Can be a string, object, function returning an object, or null.\n *\n * @remarks It's recommended to pass a URL instead of content.\n **/\n content: z.union([z.string(), z.record(z.any()), z.function().returns(z.record(z.any())), z.null()]).optional(),\n /**\n * The title of the OpenAPI document.\n *\n * @example 'Scalar Galaxy'\n */\n title: z.string().optional(),\n /**\n * The slug of the OpenAPI document used in the URL.\n *\n * If none is passed, the title will be used.\n *\n * If no title is used, it'll just use the index.\n *\n * @example 'scalar-galaxy'\n */\n slug: z.string().optional(),\n /**\n * The OpenAPI/Swagger document to render\n *\n * @deprecated Use `url` and `content` on the top level instead.\n **/\n spec: specConfigurationSchema.optional(),\n /** Prefill authentication */\n authentication: z.any().optional(), // Temp until we bring in the new auth\n /** Base URL for the API server */\n baseServerURL: z.string().optional(),\n /**\n * Whether to hide the client button\n * @default false\n */\n hideClientButton: z.boolean().optional().default(false).catch(false),\n /** URL to a request proxy for the API client */\n proxyUrl: z.string().optional(),\n /** Key used with CTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */\n searchHotKey: searchHotKeyEnum.optional(),\n /** List of OpenAPI server objects */\n servers: z.array(z.any()).optional(), // Using any for OpenAPIV3_1.ServerObject\n /**\n * Whether to show the sidebar\n * @default true\n */\n showSidebar: z.boolean().optional().default(true).catch(true),\n /** A string to use one of the color presets */\n theme: themeIdEnum.optional().default('default').catch('default'),\n /** Integration type identifier */\n _integration: integrationEnum.optional(),\n /** onRequestSent is fired when a request is sent */\n onRequestSent: z.function().args(z.string()).returns(z.void()).optional(),\n /** Whether to persist auth to local storage */\n persistAuth: z.boolean().optional().default(false).catch(false),\n /** Plugins for the API client */\n plugins: z.array(ApiClientPluginSchema).optional(),\n})\n\nexport type ApiClientConfiguration = z.infer<typeof apiClientConfigurationSchema>\n\n/** Configuration for the Api Client without the transform since it cannot be merged */\nconst _apiReferenceConfigurationSchema = apiClientConfigurationSchema.merge(\n z.object({\n /**\n * The layout to use for the references\n * @default 'modern'\n */\n layout: z.enum(['modern', 'classic']).optional().default('modern').catch('modern'),\n /**\n * URL to a request proxy for the API client\n * @deprecated Use proxyUrl instead\n */\n proxy: z.string().optional(),\n /**\n * Plugins for the API reference\n */\n plugins: z.array(ApiReferencePluginSchema).optional(),\n /**\n * Allows the user to inject an editor for the spec\n * @default false\n */\n isEditable: z.boolean().optional().default(false).catch(false),\n /**\n * Controls whether the references show a loading state in the intro\n * @default false\n */\n isLoading: z.boolean().optional().default(false).catch(false),\n /**\n * Whether to show models in the sidebar, search, and content.\n * @default false\n */\n hideModels: z.boolean().optional().default(false).catch(false),\n /**\n * Whether to show the \"Download OpenAPI Document\" button\n * @default false\n */\n hideDownloadButton: z.boolean().optional().default(false).catch(false),\n /**\n * Whether to show the \"Test Request\" button\n * @default false\n */\n hideTestRequestButton: z.boolean().optional().default(false).catch(false),\n /**\n * Whether to show the sidebar search bar\n * @default false\n */\n hideSearch: z.boolean().optional().default(false).catch(false),\n /** Whether dark mode is on or off initially (light mode) */\n darkMode: z.boolean().optional(),\n /** forceDarkModeState makes it always this state no matter what */\n forceDarkModeState: z.enum(['dark', 'light']).optional(),\n /**\n * Whether to show the dark mode toggle\n * @default false\n */\n hideDarkModeToggle: z.boolean().optional().default(false).catch(false),\n /**\n * If used, passed data will be added to the HTML header\n * @see https://unhead.unjs.io/usage/composables/use-seo-meta\n */\n metaData: z.any().optional(), // Using any for UseSeoMetaInput since it's an external type\n /**\n * Path to a favicon image\n * @default undefined\n * @example '/favicon.svg'\n */\n favicon: z.string().optional(),\n /**\n * List of httpsnippet clients to hide from the clients menu\n * By default hides Unirest, pass `[]` to show all clients\n */\n hiddenClients: z\n .union([z.record(z.union([z.boolean(), z.array(z.string())])), z.array(z.string()), z.literal(true)])\n .optional(),\n /** Determine the HTTP client that's selected by default */\n defaultHttpClient: z\n .object({\n targetKey: z.custom<TargetId>(),\n clientKey: z.string(),\n })\n .optional(),\n /** Custom CSS to be added to the page */\n customCss: z.string().optional(),\n /** onSpecUpdate is fired on spec/swagger content change */\n onSpecUpdate: z.function().args(z.string()).returns(z.void()).optional(),\n /** onServerChange is fired on selected server change */\n onServerChange: z.function().args(z.string()).returns(z.void()).optional(),\n /** onDocumentSelect is fired when the config is selected */\n onDocumentSelect: z.function().returns(z.void().or(z.void().promise())).optional(),\n /** Callback fired when the reference is fully loaded */\n onLoaded: z.function().returns(z.void().or(z.void().promise())).optional(),\n /**\n * onShowMore is fired when the user clicks the \"Show more\" button on the references\n * @param tagId - The ID of the tag that was clicked\n */\n onShowMore: z.function().args(z.string()).returns(z.void().or(z.void().promise())).optional(),\n /**\n * onSidebarClick is fired when the user clicks on a sidebar item\n * @param href - The href of the sidebar item that was clicked\n */\n onSidebarClick: z.function().args(z.string()).returns(z.void().or(z.void().promise())).optional(),\n /**\n * Route using paths instead of hashes, your server MUST support this\n * @example '/standalone-api-reference/:custom(.*)?'\n * @experimental\n * @default undefined\n */\n pathRouting: pathRoutingSchema.optional(),\n /**\n * Customize the heading portion of the hash\n * @param heading - The heading object\n * @returns A string ID used to generate the URL hash\n * @default (heading) => `#description/${heading.slug}`\n */\n generateHeadingSlug: z\n .function()\n .args(\n z.object({\n slug: z.string().default('headingSlug'),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * Customize the model portion of the hash\n * @param model - The model object with a name property\n * @returns A string ID used to generate the URL hash\n * @default (model) => slug(model.name)\n */\n generateModelSlug: z\n .function()\n .args(\n z.object({\n name: z.string().default('modelName'),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * Customize the tag portion of the hash\n * @param tag - The tag object\n * @returns A string ID used to generate the URL hash\n * @default (tag) => slug(tag.name)\n */\n generateTagSlug: z\n .function()\n .args(\n z.object({\n name: z.string().default('tagName'),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * Customize the operation portion of the hash\n * @param operation - The operation object\n * @returns A string ID used to generate the URL hash\n * @default (operation) => `${operation.method}${operation.path}`\n */\n generateOperationSlug: z\n .function()\n .args(\n z.object({\n path: z.string(),\n operationId: z.string().optional(),\n method: z.string(),\n summary: z.string().optional(),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * Customize the webhook portion of the hash\n * @param webhook - The webhook object\n * @returns A string ID used to generate the URL hash\n * @default (webhook) => slug(webhook.name)\n */\n generateWebhookSlug: z\n .function()\n .args(\n z.object({\n name: z.string(),\n method: z.string().optional(),\n }),\n )\n .returns(z.string())\n .optional(),\n /**\n * To handle redirects, pass a function that will recieve:\n * - The current path with hash if pathRouting is enabled\n * - The current hash if hashRouting (default)\n * And then passes that to history.replaceState\n *\n * @example hashRouting (default)\n * ```ts\n * redirect: (hash: string) => hash.replace('#v1/old-path', '#v2/new-path')\n * ```\n * @example pathRouting\n * ```ts\n * redirect: (pathWithHash: string) => {\n * if (pathWithHash.includes('#')) {\n * return pathWithHash.replace('/v1/tags/user#operation/get-user', '/v1/tags/user/operation/get-user')\n * }\n * return null\n * }\n * ```\n */\n redirect: z.function().args(z.string()).returns(z.string().nullable().optional()).optional(),\n /**\n * Whether to include default fonts\n * @default true\n */\n withDefaultFonts: z.boolean().optional().default(true).catch(true),\n /** Whether to expand all tags by default */\n defaultOpenAllTags: z.boolean().optional(),\n /**\n * Function to sort tags\n * @default 'alpha' for alphabetical sorting\n */\n tagsSorter: z.union([z.literal('alpha'), z.function().args(z.any(), z.any()).returns(z.number())]).optional(),\n /**\n * Function to sort operations\n * @default 'alpha' for alphabetical sorting\n */\n operationsSorter: z\n .union([z.literal('alpha'), z.literal('method'), z.function().args(z.any(), z.any()).returns(z.number())])\n .optional(),\n }),\n)\n\nconst OLD_PROXY_URL = 'https://api.scalar.com/request-proxy'\nconst NEW_PROXY_URL = 'https://proxy.scalar.com'\n\n/** Migrate the configuration through a transform */\nconst migrateConfiguration = <T extends z.infer<typeof _apiReferenceConfigurationSchema>>(_configuration: T): T => {\n const configuration = { ..._configuration }\n\n // Remove the spec prefix\n if (configuration.spec?.url) {\n console.warn(\n `[DEPRECATED] You're using the deprecated 'spec.url' attribute. Remove the spec prefix and move the 'url' attribute to the top level.`,\n )\n\n configuration.url = configuration.spec.url\n delete configuration.spec\n }\n\n if (configuration.spec?.content) {\n console.warn(\n `[DEPRECATED] You're using the deprecated 'spec.content' attribute. Remove the spec prefix and move the 'content' attribute to the top level.`,\n )\n\n configuration.content = configuration.spec.content\n delete configuration.spec\n }\n\n // Migrate proxy URL\n if (configuration.proxy) {\n console.warn(\n `[DEPRECATED] You're using the deprecated 'proxy' attribute, rename it to 'proxyUrl' or update the package.`,\n )\n\n if (!configuration.proxyUrl) {\n configuration.proxyUrl = configuration.proxy\n }\n\n delete configuration.proxy\n }\n\n if (configuration.proxyUrl === OLD_PROXY_URL) {\n console.warn(`[DEPRECATED] Warning: configuration.proxyUrl points to our old proxy (${OLD_PROXY_URL}).`)\n console.warn(`[DEPRECATED] We are overwriting the value and use the new proxy URL (${NEW_PROXY_URL}) instead.`)\n console.warn(\n `[DEPRECATED] Action Required: You should manually update your configuration to use the new URL (${NEW_PROXY_URL}). Read more: https://github.com/scalar/scalar`,\n )\n\n configuration.proxyUrl = NEW_PROXY_URL\n }\n\n return configuration\n}\n\n/** Configuration for the Api Reference */\nexport const apiReferenceConfigurationSchema = _apiReferenceConfigurationSchema.transform(migrateConfiguration)\n\n/** Configuration after parsing, this is the main type */\nexport type ApiReferenceConfiguration = Omit<\n z.infer<typeof _apiReferenceConfigurationSchema>,\n // Remove deprecated attributes\n 'proxy' | 'spec' | 'authentication'\n> & {\n authentication?: AuthenticationConfiguration\n}\n\n/** Api Config which includes the default config */\ntype ApiReferenceConfigurationWithDefault = ApiReferenceConfiguration & {\n /** Whether to use this config as the default one */\n default?: boolean\n}\n\n/** Configuration for a single config with sources */\nexport type ApiReferenceConfigurationWithSources = Omit<ApiReferenceConfigurationWithDefault, 'default'> & {\n sources: (SpecConfiguration & { default?: boolean })[]\n}\n\n/** Configuration for multiple Api References */\nexport type AnyApiReferenceConfiguration =\n | Partial<ApiReferenceConfiguration>\n | Partial<ApiReferenceConfigurationWithSources>\n | Partial<ApiReferenceConfigurationWithDefault>[]\n | Partial<ApiReferenceConfigurationWithSources>[]\n\n/** Typeguard to check to narrow the configs to the one with sources */\nexport const isConfigurationWithSources = (\n config: AnyApiReferenceConfiguration,\n): config is Partial<ApiReferenceConfigurationWithSources> =>\n Boolean(!Array.isArray(config) && config && 'sources' in config && Array.isArray(config.sources))\n"],
5
+ "mappings": "AAAA,SAAS,SAAS;AAElB,SAAS,6BAA6B;AAEtC,SAAS,gCAAgC;AAIzC,MAAM,cAAc,EAAE,KAAK;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAGD,MAAM,mBAAmB,EAAE,KAAK;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;AAGD,MAAM,kBAAkB,EACrB,KAAK;AAAA,EACJ;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC,EACA,SAAS;AAGL,MAAM,0BAA0B,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAmB9C,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBzB,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ9G,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAY3B,MAAM,EAAE,OAAO,EAAE,SAAS;AAC5B,CAAC;AAID,MAAM,oBAAoB,EAAE,OAAO;AAAA;AAAA,EAEjC,UAAU,EAAE,OAAO;AACrB,CAAC;AAGM,MAAM,+BAA+B,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAInD,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOzB,SAAS,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM9G,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAU3B,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM1B,MAAM,wBAAwB,SAAS;AAAA;AAAA,EAEvC,gBAAgB,EAAE,IAAI,EAAE,SAAS;AAAA;AAAA;AAAA,EAEjC,eAAe,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnC,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA,EAEnE,UAAU,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,EAE9B,cAAc,iBAAiB,SAAS;AAAA;AAAA,EAExC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnC,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,IAAI,EAAE,MAAM,IAAI;AAAA;AAAA,EAE5D,OAAO,YAAY,SAAS,EAAE,QAAQ,SAAS,EAAE,MAAM,SAAS;AAAA;AAAA,EAEhE,cAAc,gBAAgB,SAAS;AAAA;AAAA,EAEvC,eAAe,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,SAAS;AAAA;AAAA,EAExE,aAAa,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA,EAE9D,SAAS,EAAE,MAAM,qBAAqB,EAAE,SAAS;AACnD,CAAC;AAKD,MAAM,mCAAmC,6BAA6B;AAAA,EACpE,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,IAKP,QAAQ,EAAE,KAAK,CAAC,UAAU,SAAS,CAAC,EAAE,SAAS,EAAE,QAAQ,QAAQ,EAAE,MAAM,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA,IAKjF,OAAO,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,IAI3B,SAAS,EAAE,MAAM,wBAAwB,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAKpD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAK5D,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7D,oBAAoB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAKrE,uBAAuB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAKxE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA,IAE7D,UAAU,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA,IAE/B,oBAAoB,EAAE,KAAK,CAAC,QAAQ,OAAO,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAKvD,oBAAoB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,KAAK,EAAE,MAAM,KAAK;AAAA;AAAA;AAAA;AAAA;AAAA,IAKrE,UAAU,EAAE,IAAI,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAM3B,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAK7B,eAAe,EACZ,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE,QAAQ,IAAI,CAAC,CAAC,EACnG,SAAS;AAAA;AAAA,IAEZ,mBAAmB,EAChB,OAAO;AAAA,MACN,WAAW,EAAE,OAAiB;AAAA,MAC9B,WAAW,EAAE,OAAO;AAAA,IACtB,CAAC,EACA,SAAS;AAAA;AAAA,IAEZ,WAAW,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA,IAE/B,cAAc,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,SAAS;AAAA;AAAA,IAEvE,gBAAgB,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,SAAS;AAAA;AAAA,IAEzE,kBAAkB,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA,IAEjF,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAKzE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAK5F,gBAAgB,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOhG,aAAa,kBAAkB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOxC,qBAAqB,EAClB,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO,EAAE,QAAQ,aAAa;AAAA,MACxC,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOZ,mBAAmB,EAChB,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO,EAAE,QAAQ,WAAW;AAAA,MACtC,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOZ,iBAAiB,EACd,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO,EAAE,QAAQ,SAAS;AAAA,MACpC,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOZ,uBAAuB,EACpB,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO;AAAA,QACf,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA,QACjC,QAAQ,EAAE,OAAO;AAAA,QACjB,SAAS,EAAE,OAAO,EAAE,SAAS;AAAA,MAC/B,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAOZ,qBAAqB,EAClB,SAAS,EACT;AAAA,MACC,EAAE,OAAO;AAAA,QACP,MAAM,EAAE,OAAO;AAAA,QACf,QAAQ,EAAE,OAAO,EAAE,SAAS;AAAA,MAC9B,CAAC;AAAA,IACH,EACC,QAAQ,EAAE,OAAO,CAAC,EAClB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAqBZ,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAK3F,kBAAkB,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,IAAI,EAAE,MAAM,IAAI;AAAA;AAAA,IAEjE,oBAAoB,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAKzC,YAAY,EAAE,MAAM,CAAC,EAAE,QAAQ,OAAO,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,IAK5G,kBAAkB,EACf,MAAM,CAAC,EAAE,QAAQ,OAAO,GAAG,EAAE,QAAQ,QAAQ,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,IAAI,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EACxG,SAAS;AAAA,EACd,CAAC;AACH;AAEA,MAAM,gBAAgB;AACtB,MAAM,gBAAgB;AAGtB,MAAM,uBAAuB,CAA6D,mBAAyB;AACjH,QAAM,gBAAgB,EAAE,GAAG,eAAe;AAG1C,MAAI,cAAc,MAAM,KAAK;AAC3B,YAAQ;AAAA,MACN;AAAA,IACF;AAEA,kBAAc,MAAM,cAAc,KAAK;AACvC,WAAO,cAAc;AAAA,EACvB;AAEA,MAAI,cAAc,MAAM,SAAS;AAC/B,YAAQ;AAAA,MACN;AAAA,IACF;AAEA,kBAAc,UAAU,cAAc,KAAK;AAC3C,WAAO,cAAc;AAAA,EACvB;AAGA,MAAI,cAAc,OAAO;AACvB,YAAQ;AAAA,MACN;AAAA,IACF;AAEA,QAAI,CAAC,cAAc,UAAU;AAC3B,oBAAc,WAAW,cAAc;AAAA,IACzC;AAEA,WAAO,cAAc;AAAA,EACvB;AAEA,MAAI,cAAc,aAAa,eAAe;AAC5C,YAAQ,KAAK,yEAAyE,aAAa,IAAI;AACvG,YAAQ,KAAK,wEAAwE,aAAa,YAAY;AAC9G,YAAQ;AAAA,MACN,mGAAmG,aAAa;AAAA,IAClH;AAEA,kBAAc,WAAW;AAAA,EAC3B;AAEA,SAAO;AACT;AAGO,MAAM,kCAAkC,iCAAiC,UAAU,oBAAoB;AA8BvG,MAAM,6BAA6B,CACxC,WAEA,QAAQ,CAAC,MAAM,QAAQ,MAAM,KAAK,UAAU,aAAa,UAAU,MAAM,QAAQ,OAAO,OAAO,CAAC;",
6
6
  "names": []
7
7
  }
package/dist/entities/security-scheme.d.ts CHANGED
@@ -15,17 +15,17 @@ export declare const securityApiKeySchema: z.ZodObject<z.objectUtil.extendShape<
15
15
  }>, {
16
16
  value: z.ZodDefault<z.ZodString>;
17
17
  }>, "strip", z.ZodTypeAny, {
18
- name: string;
19
- value: string;
20
18
  type: "apiKey";
19
+ value: string;
20
+ name: string;
21
21
  uid: string & z.BRAND<"securityScheme">;
22
22
  nameKey: string;
23
23
  in: "cookie" | "query" | "header";
24
24
  description?: string | undefined;
25
25
  }, {
26
26
  type: "apiKey";
27
- name?: string | undefined;
28
27
  value?: string | undefined;
28
+ name?: string | undefined;
29
29
  description?: string | undefined;
30
30
  uid?: string | undefined;
31
31
  nameKey?: string | undefined;
@@ -547,8 +547,8 @@ export declare const oasSecuritySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUt
547
547
  /** REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". */
548
548
  in: z.ZodCatch<z.ZodDefault<z.ZodOptional<z.ZodEnum<["query", "header", "cookie"]>>>>;
549
549
  }>, "strip", z.ZodTypeAny, {
550
- name: string;
551
550
  type: "apiKey";
551
+ name: string;
552
552
  in: "cookie" | "query" | "header";
553
553
  description?: string | undefined;
554
554
  }, {
@@ -1021,17 +1021,17 @@ export declare const securitySchemeSchema: z.ZodEffects<z.ZodDiscriminatedUnion<
1021
1021
  }>, {
1022
1022
  value: z.ZodDefault<z.ZodString>;
1023
1023
  }>, "strip", z.ZodTypeAny, {
1024
- name: string;
1025
- value: string;
1026
1024
  type: "apiKey";
1025
+ value: string;
1026
+ name: string;
1027
1027
  uid: string & z.BRAND<"securityScheme">;
1028
1028
  nameKey: string;
1029
1029
  in: "cookie" | "query" | "header";
1030
1030
  description?: string | undefined;
1031
1031
  }, {
1032
1032
  type: "apiKey";
1033
- name?: string | undefined;
1034
1033
  value?: string | undefined;
1034
+ name?: string | undefined;
1035
1035
  description?: string | undefined;
1036
1036
  uid?: string | undefined;
1037
1037
  nameKey?: string | undefined;
@@ -1519,9 +1519,9 @@ export declare const securitySchemeSchema: z.ZodEffects<z.ZodDiscriminatedUnion<
1519
1519
  } | undefined;
1520
1520
  } | undefined;
1521
1521
  }>]>, {
1522
- name: string;
1523
- value: string;
1524
1522
  type: "apiKey";
1523
+ value: string;
1524
+ name: string;
1525
1525
  uid: string & z.BRAND<"securityScheme">;
1526
1526
  nameKey: string;
1527
1527
  in: "cookie" | "query" | "header";
@@ -1601,8 +1601,8 @@ export declare const securitySchemeSchema: z.ZodEffects<z.ZodDiscriminatedUnion<
1601
1601
  'x-default-scopes'?: string | string[] | undefined;
1602
1602
  }, {
1603
1603
  type: "apiKey";
1604
- name?: string | undefined;
1605
1604
  value?: string | undefined;
1605
+ name?: string | undefined;
1606
1606
  description?: string | undefined;
1607
1607
  uid?: string | undefined;
1608
1608
  nameKey?: string | undefined;
package/package.json CHANGED
@@ -16,9 +16,9 @@
16
16
  "scalar",
17
17
  "references"
18
18
  ],
19
- "version": "0.1.16",
19
+ "version": "0.2.1",
20
20
  "engines": {
21
- "node": ">=18"
21
+ "node": ">=20"
22
22
  },
23
23
  "type": "module",
24
24
  "types": "dist/index.d.ts",
@@ -28,6 +28,11 @@
28
28
  "types": "./dist/index.d.ts",
29
29
  "default": "./dist/index.js"
30
30
  },
31
+ "./api-client": {
32
+ "import": "./dist/api-client/index.js",
33
+ "types": "./dist/api-client/index.d.ts",
34
+ "default": "./dist/api-client/index.js"
35
+ },
31
36
  "./api-reference": {
32
37
  "import": "./dist/api-reference/index.js",
33
38
  "types": "./dist/api-reference/index.d.ts",
@@ -61,13 +66,13 @@
61
66
  "dependencies": {
62
67
  "nanoid": "^5.1.5",
63
68
  "zod": "3.24.1",
64
- "@scalar/openapi-types": "0.2.3"
69
+ "@scalar/openapi-types": "0.3.1"
65
70
  },
66
71
  "devDependencies": {
67
72
  "@types/har-format": "^1.2.15",
68
73
  "type-fest": "^4.20.0",
69
74
  "vite": "5.4.19",
70
- "@scalar/build-tooling": "0.1.19"
75
+ "@scalar/build-tooling": "0.2.0"
71
76
  },
72
77
  "scripts": {
73
78
  "build": "scalar-build-esbuild",