@scalar/oas-utils 0.2.106 → 0.2.108
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/dist/entities/cookie/cookie.d.ts +2 -2
- package/dist/entities/cookie/cookie.js +1 -1
- package/dist/entities/environment/environment.d.ts +2 -2
- package/dist/entities/environment/environment.js +1 -1
- package/dist/entities/shared/utility.d.ts +13 -1
- package/dist/entities/shared/utility.d.ts.map +1 -1
- package/dist/entities/shared/utility.js +4 -1
- package/dist/entities/spec/collection.d.ts +199 -155
- package/dist/entities/spec/collection.d.ts.map +1 -1
- package/dist/entities/spec/collection.js +15 -17
- package/dist/entities/spec/index.js +1 -1
- package/dist/entities/spec/operation.d.ts +34 -28
- package/dist/entities/spec/operation.d.ts.map +1 -1
- package/dist/entities/spec/parameters.d.ts +4 -4
- package/dist/entities/spec/request-examples.d.ts +5 -5
- package/dist/entities/spec/request-examples.d.ts.map +1 -1
- package/dist/entities/spec/request-examples.js +37 -71
- package/dist/entities/spec/requests.d.ts +54 -42
- package/dist/entities/spec/requests.d.ts.map +1 -1
- package/dist/entities/spec/requests.js +6 -18
- package/dist/entities/spec/security.d.ts +22 -22
- package/dist/entities/spec/security.d.ts.map +1 -1
- package/dist/entities/spec/security.js +7 -22
- package/dist/entities/spec/server.d.ts +2 -2
- package/dist/entities/spec/server.d.ts.map +1 -1
- package/dist/entities/spec/server.js +3 -5
- package/dist/entities/spec/spec-objects.d.ts +150 -78
- package/dist/entities/spec/spec-objects.d.ts.map +1 -1
- package/dist/entities/spec/spec-objects.js +68 -45
- package/dist/entities/spec/x-scalar-secrets.d.ts +4 -4
- package/dist/entities/spec/x-scalar-secrets.d.ts.map +1 -1
- package/dist/entities/workspace/workspace.d.ts +7 -7
- package/dist/entities/workspace/workspace.d.ts.map +1 -1
- package/dist/entities/workspace/workspace.js +5 -5
- package/dist/helpers/fetchSpecFromUrl.d.ts.map +1 -1
- package/dist/helpers/fetchSpecFromUrl.js +1 -1
- package/dist/helpers/fetchWithProxyFallback.d.ts.map +1 -1
- package/dist/helpers/findVariables.d.ts.map +1 -1
- package/dist/helpers/findVariables.js +1 -1
- package/dist/helpers/httpMethods.d.ts.map +1 -1
- package/dist/helpers/is-defined.d.ts.map +1 -1
- package/dist/helpers/iterateTitle.d.ts.map +1 -1
- package/dist/helpers/json2xml.d.ts.map +1 -1
- package/dist/helpers/json2xml.js +3 -7
- package/dist/helpers/makeUrlAbsolute.d.ts.map +1 -1
- package/dist/helpers/makeUrlAbsolute.js +1 -4
- package/dist/helpers/merge-urls.d.ts.map +1 -1
- package/dist/helpers/normalizeMimeTypeObject.d.ts +1 -0
- package/dist/helpers/normalizeMimeTypeObject.d.ts.map +1 -1
- package/dist/helpers/object.d.ts.map +1 -1
- package/dist/helpers/parse.d.ts.map +1 -1
- package/dist/helpers/prettyPrintJson.d.ts.map +1 -1
- package/dist/helpers/replaceVariables.d.ts.map +1 -1
- package/dist/helpers/replaceVariables.js +1 -3
- package/dist/helpers/ssrState.d.ts.map +1 -1
- package/dist/helpers/ssrState.js +1 -3
- package/dist/migrations/local-storage.d.ts.map +1 -1
- package/dist/migrations/migrator.d.ts +1 -1
- package/dist/migrations/migrator.d.ts.map +1 -1
- package/dist/migrations/semver.d.ts.map +1 -1
- package/dist/migrations/semver.js +1 -3
- package/dist/migrations/v-0.0.0/types.generated.d.ts.map +1 -1
- package/dist/migrations/v-2.1.0/migration.d.ts.map +1 -1
- package/dist/migrations/v-2.1.0/migration.js +1 -4
- package/dist/migrations/v-2.1.0/types.generated.d.ts.map +1 -1
- package/dist/migrations/v-2.2.0/migration.d.ts.map +1 -1
- package/dist/migrations/v-2.2.0/migration.js +2 -4
- package/dist/migrations/v-2.2.0/types.generated.d.ts.map +1 -1
- package/dist/migrations/v-2.3.0/migration.d.ts.map +1 -1
- package/dist/migrations/v-2.3.0/migration.js +3 -8
- package/dist/migrations/v-2.3.0/types.generated.d.ts.map +1 -1
- package/dist/migrations/v-2.4.0/migration.d.ts.map +1 -1
- package/dist/migrations/v-2.4.0/types.generated.d.ts.map +1 -1
- package/dist/migrations/v-2.5.0/migration.d.ts +1 -1
- package/dist/migrations/v-2.5.0/migration.d.ts.map +1 -1
- package/dist/migrations/v-2.5.0/migration.js +70 -3
- package/dist/migrations/v-2.5.0/types.generated.d.ts +17 -17
- package/dist/migrations/v-2.5.0/types.generated.d.ts.map +1 -1
- package/dist/spec-getters/getExampleFromSchema.d.ts.map +1 -1
- package/dist/spec-getters/getExampleFromSchema.js +8 -22
- package/dist/spec-getters/getParametersFromOperation.d.ts.map +1 -1
- package/dist/spec-getters/getParametersFromOperation.js +1 -4
- package/dist/spec-getters/getRequestBodyFromOperation.d.ts.map +1 -1
- package/dist/spec-getters/getRequestBodyFromOperation.js +4 -9
- package/dist/spec-getters/getServerVariableExamples.js +3 -1
- package/dist/transforms/import-spec.d.ts +2 -1
- package/dist/transforms/import-spec.d.ts.map +1 -1
- package/dist/transforms/import-spec.js +13 -35
- package/dist/transforms/index.d.ts +0 -1
- package/dist/transforms/index.d.ts.map +1 -1
- package/dist/transforms/index.js +0 -1
- package/package.json +7 -7
- package/dist/transforms/export-spec.d.ts +0 -17
- package/dist/transforms/export-spec.d.ts.map +0 -1
- package/dist/transforms/export-spec.js +0 -73
|
@@ -87,10 +87,10 @@ export declare const oasRequestSchema: z.ZodObject<{
|
|
|
87
87
|
}, "strip", z.ZodTypeAny, {
|
|
88
88
|
required: boolean;
|
|
89
89
|
name: string;
|
|
90
|
-
in: "path" | "
|
|
90
|
+
in: "path" | "cookie" | "query" | "header";
|
|
91
91
|
deprecated: boolean;
|
|
92
|
-
description?: string | undefined;
|
|
93
92
|
example?: unknown;
|
|
93
|
+
description?: string | undefined;
|
|
94
94
|
schema?: unknown;
|
|
95
95
|
content?: unknown;
|
|
96
96
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
@@ -100,10 +100,10 @@ export declare const oasRequestSchema: z.ZodObject<{
|
|
|
100
100
|
}> | undefined;
|
|
101
101
|
}, {
|
|
102
102
|
name: string;
|
|
103
|
-
in: "path" | "
|
|
103
|
+
in: "path" | "cookie" | "query" | "header";
|
|
104
|
+
example?: unknown;
|
|
104
105
|
required?: boolean | undefined;
|
|
105
106
|
description?: string | undefined;
|
|
106
|
-
example?: unknown;
|
|
107
107
|
deprecated?: boolean | undefined;
|
|
108
108
|
schema?: unknown;
|
|
109
109
|
content?: unknown;
|
|
@@ -116,15 +116,21 @@ export declare const oasRequestSchema: z.ZodObject<{
|
|
|
116
116
|
/**
|
|
117
117
|
* External documentation object
|
|
118
118
|
*/
|
|
119
|
-
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
120
|
-
description: z.ZodOptional<z.ZodString
|
|
121
|
-
url: z.
|
|
119
|
+
externalDocs: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
120
|
+
description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
121
|
+
url: z.ZodString;
|
|
122
122
|
}, "strip", z.ZodTypeAny, {
|
|
123
123
|
url: string;
|
|
124
124
|
description?: string | undefined;
|
|
125
125
|
}, {
|
|
126
|
+
url: string;
|
|
127
|
+
description?: unknown;
|
|
128
|
+
}>, {
|
|
129
|
+
url: string;
|
|
126
130
|
description?: string | undefined;
|
|
127
|
-
|
|
131
|
+
}, {
|
|
132
|
+
url: string;
|
|
133
|
+
description?: unknown;
|
|
128
134
|
}>>;
|
|
129
135
|
deprecated: z.ZodOptional<z.ZodBoolean>;
|
|
130
136
|
/** Response formats */
|
|
@@ -228,10 +234,10 @@ export declare const oasRequestSchema: z.ZodObject<{
|
|
|
228
234
|
parameters?: {
|
|
229
235
|
required: boolean;
|
|
230
236
|
name: string;
|
|
231
|
-
in: "path" | "
|
|
237
|
+
in: "path" | "cookie" | "query" | "header";
|
|
232
238
|
deprecated: boolean;
|
|
233
|
-
description?: string | undefined;
|
|
234
239
|
example?: unknown;
|
|
240
|
+
description?: string | undefined;
|
|
235
241
|
schema?: unknown;
|
|
236
242
|
content?: unknown;
|
|
237
243
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
@@ -263,8 +269,8 @@ export declare const oasRequestSchema: z.ZodObject<{
|
|
|
263
269
|
description?: string | undefined;
|
|
264
270
|
summary?: string | undefined;
|
|
265
271
|
externalDocs?: {
|
|
266
|
-
|
|
267
|
-
|
|
272
|
+
url: string;
|
|
273
|
+
description?: unknown;
|
|
268
274
|
} | undefined;
|
|
269
275
|
'x-internal'?: boolean | undefined;
|
|
270
276
|
'x-scalar-ignore'?: boolean | undefined;
|
|
@@ -274,10 +280,10 @@ export declare const oasRequestSchema: z.ZodObject<{
|
|
|
274
280
|
operationId?: string | undefined;
|
|
275
281
|
parameters?: {
|
|
276
282
|
name: string;
|
|
277
|
-
in: "path" | "
|
|
283
|
+
in: "path" | "cookie" | "query" | "header";
|
|
284
|
+
example?: unknown;
|
|
278
285
|
required?: boolean | undefined;
|
|
279
286
|
description?: string | undefined;
|
|
280
|
-
example?: unknown;
|
|
281
287
|
deprecated?: boolean | undefined;
|
|
282
288
|
schema?: unknown;
|
|
283
289
|
content?: unknown;
|
|
@@ -367,10 +373,10 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
|
|
|
367
373
|
}, "strip", z.ZodTypeAny, {
|
|
368
374
|
required: boolean;
|
|
369
375
|
name: string;
|
|
370
|
-
in: "path" | "
|
|
376
|
+
in: "path" | "cookie" | "query" | "header";
|
|
371
377
|
deprecated: boolean;
|
|
372
|
-
description?: string | undefined;
|
|
373
378
|
example?: unknown;
|
|
379
|
+
description?: string | undefined;
|
|
374
380
|
schema?: unknown;
|
|
375
381
|
content?: unknown;
|
|
376
382
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
@@ -380,10 +386,10 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
|
|
|
380
386
|
}> | undefined;
|
|
381
387
|
}, {
|
|
382
388
|
name: string;
|
|
383
|
-
in: "path" | "
|
|
389
|
+
in: "path" | "cookie" | "query" | "header";
|
|
390
|
+
example?: unknown;
|
|
384
391
|
required?: boolean | undefined;
|
|
385
392
|
description?: string | undefined;
|
|
386
|
-
example?: unknown;
|
|
387
393
|
deprecated?: boolean | undefined;
|
|
388
394
|
schema?: unknown;
|
|
389
395
|
content?: unknown;
|
|
@@ -396,15 +402,21 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
|
|
|
396
402
|
/**
|
|
397
403
|
* External documentation object
|
|
398
404
|
*/
|
|
399
|
-
externalDocs: z.ZodOptional<z.ZodObject<{
|
|
400
|
-
description: z.ZodOptional<z.ZodString
|
|
401
|
-
url: z.
|
|
405
|
+
externalDocs: z.ZodOptional<z.ZodEffects<z.ZodObject<{
|
|
406
|
+
description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
|
|
407
|
+
url: z.ZodString;
|
|
402
408
|
}, "strip", z.ZodTypeAny, {
|
|
403
409
|
url: string;
|
|
404
410
|
description?: string | undefined;
|
|
405
411
|
}, {
|
|
412
|
+
url: string;
|
|
413
|
+
description?: unknown;
|
|
414
|
+
}>, {
|
|
415
|
+
url: string;
|
|
406
416
|
description?: string | undefined;
|
|
407
|
-
|
|
417
|
+
}, {
|
|
418
|
+
url: string;
|
|
419
|
+
description?: unknown;
|
|
408
420
|
}>>;
|
|
409
421
|
deprecated: z.ZodOptional<z.ZodBoolean>;
|
|
410
422
|
/** Response formats */
|
|
@@ -494,27 +506,27 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
|
|
|
494
506
|
'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
|
|
495
507
|
}, "x-scalar-examples">, {
|
|
496
508
|
type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"request">>>;
|
|
497
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
509
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "operation">;
|
|
498
510
|
/** Path Key */
|
|
499
511
|
path: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
500
512
|
/** Request Method */
|
|
501
513
|
method: z.ZodDefault<z.ZodEnum<["connect", "delete", "get", "head", "options", "patch", "post", "put", "trace"]>>;
|
|
502
514
|
/** List of server UIDs specific to the request */
|
|
503
|
-
servers: z.ZodDefault<z.ZodArray<z.
|
|
515
|
+
servers: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "server">, "many">>;
|
|
504
516
|
/** The currently selected server */
|
|
505
|
-
selectedServerUid: z.ZodDefault<z.ZodString
|
|
517
|
+
selectedServerUid: z.ZodDefault<z.ZodNullable<z.ZodOptional<z.ZodBranded<z.ZodString, "server">>>>;
|
|
506
518
|
/** List of example UIDs associated with the request */
|
|
507
|
-
examples: z.ZodDefault<z.ZodArray<z.
|
|
519
|
+
examples: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "example">, "many">>;
|
|
508
520
|
/** List of security scheme UIDs associated with the request */
|
|
509
|
-
selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.
|
|
521
|
+
selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodBranded<z.ZodString, "securityScheme">, z.ZodArray<z.ZodBranded<z.ZodString, "securityScheme">, "many">]>, "many">>;
|
|
510
522
|
}>, "strip", z.ZodTypeAny, {
|
|
511
523
|
path: string;
|
|
512
524
|
type: "request";
|
|
513
|
-
uid: string
|
|
514
|
-
selectedSecuritySchemeUids: (string | string[])[];
|
|
515
|
-
selectedServerUid: string;
|
|
516
|
-
servers: string[];
|
|
517
|
-
examples: string[];
|
|
525
|
+
uid: string & z.BRAND<"operation">;
|
|
526
|
+
selectedSecuritySchemeUids: ((string & z.BRAND<"securityScheme">) | (string & z.BRAND<"securityScheme">)[])[];
|
|
527
|
+
selectedServerUid: (string & z.BRAND<"server">) | null;
|
|
528
|
+
servers: (string & z.BRAND<"server">)[];
|
|
529
|
+
examples: (string & z.BRAND<"example">)[];
|
|
518
530
|
method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
|
|
519
531
|
description?: string | undefined;
|
|
520
532
|
summary?: string | undefined;
|
|
@@ -531,10 +543,10 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
|
|
|
531
543
|
parameters?: {
|
|
532
544
|
required: boolean;
|
|
533
545
|
name: string;
|
|
534
|
-
in: "path" | "
|
|
546
|
+
in: "path" | "cookie" | "query" | "header";
|
|
535
547
|
deprecated: boolean;
|
|
536
|
-
description?: string | undefined;
|
|
537
548
|
example?: unknown;
|
|
549
|
+
description?: string | undefined;
|
|
538
550
|
schema?: unknown;
|
|
539
551
|
content?: unknown;
|
|
540
552
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
@@ -552,25 +564,25 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
|
|
|
552
564
|
description?: string | undefined;
|
|
553
565
|
summary?: string | undefined;
|
|
554
566
|
externalDocs?: {
|
|
555
|
-
|
|
556
|
-
|
|
567
|
+
url: string;
|
|
568
|
+
description?: unknown;
|
|
557
569
|
} | undefined;
|
|
558
570
|
'x-internal'?: boolean | undefined;
|
|
559
571
|
'x-scalar-ignore'?: boolean | undefined;
|
|
560
572
|
security?: Record<string, string[] | undefined>[] | undefined;
|
|
561
|
-
selectedSecuritySchemeUids?: (string |
|
|
562
|
-
selectedServerUid?: string | undefined;
|
|
563
|
-
servers?:
|
|
573
|
+
selectedSecuritySchemeUids?: (string | string[])[] | undefined;
|
|
574
|
+
selectedServerUid?: string | null | undefined;
|
|
575
|
+
servers?: string[] | undefined;
|
|
564
576
|
tags?: string[] | undefined;
|
|
565
577
|
deprecated?: boolean | undefined;
|
|
566
|
-
examples?:
|
|
578
|
+
examples?: string[] | undefined;
|
|
567
579
|
operationId?: string | undefined;
|
|
568
580
|
parameters?: {
|
|
569
581
|
name: string;
|
|
570
|
-
in: "path" | "
|
|
582
|
+
in: "path" | "cookie" | "query" | "header";
|
|
583
|
+
example?: unknown;
|
|
571
584
|
required?: boolean | undefined;
|
|
572
585
|
description?: string | undefined;
|
|
573
|
-
example?: unknown;
|
|
574
586
|
deprecated?: boolean | undefined;
|
|
575
587
|
schema?: unknown;
|
|
576
588
|
content?: unknown;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvC,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAI9E,eAAO,MAAM,cAAc,2FAA4F,CAAA;AAEvH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAMD,2CAA2C;AAC3C,eAAO,MAAM,gBAAgB;IAC3B;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG2B,CAAA;AA0BnD,8CAA8C;AAC9C,eAAO,MAAM,aAAa;IA3ExB;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEvB,sBAAsB;;;;;;IAetB,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK6C,CAAA;AAE9G,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}
|
|
@@ -5,17 +5,7 @@ import { xScalarExampleSchema } from './request-examples.js';
|
|
|
5
5
|
import { oasSecurityRequirementSchema } from './security.js';
|
|
6
6
|
import { oasExternalDocumentationSchema } from './spec-objects.js';
|
|
7
7
|
|
|
8
|
-
const requestMethods = [
|
|
9
|
-
'connect',
|
|
10
|
-
'delete',
|
|
11
|
-
'get',
|
|
12
|
-
'head',
|
|
13
|
-
'options',
|
|
14
|
-
'patch',
|
|
15
|
-
'post',
|
|
16
|
-
'put',
|
|
17
|
-
'trace',
|
|
18
|
-
];
|
|
8
|
+
const requestMethods = ['connect', 'delete', 'get', 'head', 'options', 'patch', 'post', 'put', 'trace'];
|
|
19
9
|
const requestBodySchema = z.any();
|
|
20
10
|
/** Open API Compliant Request Validator */
|
|
21
11
|
const oasRequestSchema = z.object({
|
|
@@ -77,23 +67,21 @@ const oasRequestSchema = z.object({
|
|
|
77
67
|
*/
|
|
78
68
|
const extendedRequestSchema = z.object({
|
|
79
69
|
type: z.literal('request').optional().default('request'),
|
|
80
|
-
uid: nanoidSchema,
|
|
70
|
+
uid: nanoidSchema.brand(),
|
|
81
71
|
/** Path Key */
|
|
82
72
|
path: z.string().optional().default(''),
|
|
83
73
|
/** Request Method */
|
|
84
74
|
method: z.enum(requestMethods).default('get'),
|
|
85
75
|
/** List of server UIDs specific to the request */
|
|
86
|
-
servers:
|
|
76
|
+
servers: z.string().brand().array().default([]),
|
|
87
77
|
/** The currently selected server */
|
|
88
|
-
selectedServerUid: z.string().default(
|
|
78
|
+
selectedServerUid: z.string().brand().optional().nullable().default(null),
|
|
89
79
|
/** List of example UIDs associated with the request */
|
|
90
|
-
examples:
|
|
80
|
+
examples: z.string().brand().array().default([]),
|
|
91
81
|
/** List of security scheme UIDs associated with the request */
|
|
92
82
|
selectedSecuritySchemeUids: selectedSecuritySchemeUidSchema,
|
|
93
83
|
});
|
|
94
84
|
/** Unified request schema for client usage */
|
|
95
|
-
const requestSchema = oasRequestSchema
|
|
96
|
-
.omit({ 'x-scalar-examples': true })
|
|
97
|
-
.merge(extendedRequestSchema);
|
|
85
|
+
const requestSchema = oasRequestSchema.omit({ 'x-scalar-examples': true }).merge(extendedRequestSchema);
|
|
98
86
|
|
|
99
87
|
export { oasRequestSchema, requestMethods, requestSchema };
|
|
@@ -9,7 +9,7 @@ export declare const securityApiKeySchema: z.ZodObject<z.objectUtil.extendShape<
|
|
|
9
9
|
/** REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". */
|
|
10
10
|
in: z.ZodDefault<z.ZodOptional<z.ZodEnum<["query", "header", "cookie"]>>>;
|
|
11
11
|
}>, {
|
|
12
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
12
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "securityScheme">;
|
|
13
13
|
/** The name key that links a security requirement to a security object */
|
|
14
14
|
nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
15
15
|
}>, {
|
|
@@ -17,10 +17,10 @@ export declare const securityApiKeySchema: z.ZodObject<z.objectUtil.extendShape<
|
|
|
17
17
|
}>, "strip", z.ZodTypeAny, {
|
|
18
18
|
type: "apiKey";
|
|
19
19
|
value: string;
|
|
20
|
-
uid: string
|
|
20
|
+
uid: string & z.BRAND<"securityScheme">;
|
|
21
21
|
name: string;
|
|
22
22
|
nameKey: string;
|
|
23
|
-
in: "
|
|
23
|
+
in: "cookie" | "query" | "header";
|
|
24
24
|
description?: string | undefined;
|
|
25
25
|
}, {
|
|
26
26
|
type: "apiKey";
|
|
@@ -29,7 +29,7 @@ export declare const securityApiKeySchema: z.ZodObject<z.objectUtil.extendShape<
|
|
|
29
29
|
name?: string | undefined;
|
|
30
30
|
description?: string | undefined;
|
|
31
31
|
nameKey?: string | undefined;
|
|
32
|
-
in?: "
|
|
32
|
+
in?: "cookie" | "query" | "header" | undefined;
|
|
33
33
|
}>;
|
|
34
34
|
export type SecuritySchemeApiKey = z.infer<typeof securityApiKeySchema>;
|
|
35
35
|
export declare const securityHttpSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
@@ -48,7 +48,7 @@ export declare const securityHttpSchema: z.ZodObject<z.objectUtil.extendShape<z.
|
|
|
48
48
|
*/
|
|
49
49
|
bearerFormat: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"JWT">, z.ZodString]>>>;
|
|
50
50
|
}>, {
|
|
51
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
51
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "securityScheme">;
|
|
52
52
|
/** The name key that links a security requirement to a security object */
|
|
53
53
|
nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
54
54
|
}>, {
|
|
@@ -57,7 +57,7 @@ export declare const securityHttpSchema: z.ZodObject<z.objectUtil.extendShape<z.
|
|
|
57
57
|
token: z.ZodDefault<z.ZodString>;
|
|
58
58
|
}>, "strip", z.ZodTypeAny, {
|
|
59
59
|
type: "http";
|
|
60
|
-
uid: string
|
|
60
|
+
uid: string & z.BRAND<"securityScheme">;
|
|
61
61
|
nameKey: string;
|
|
62
62
|
scheme: "basic" | "bearer";
|
|
63
63
|
bearerFormat: string;
|
|
@@ -87,12 +87,12 @@ export declare const securityOpenIdSchema: z.ZodObject<z.objectUtil.extendShape<
|
|
|
87
87
|
*/
|
|
88
88
|
openIdConnectUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
89
89
|
}>, {
|
|
90
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
90
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "securityScheme">;
|
|
91
91
|
/** The name key that links a security requirement to a security object */
|
|
92
92
|
nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
93
93
|
}>, "strip", z.ZodTypeAny, {
|
|
94
94
|
type: "openIdConnect";
|
|
95
|
-
uid: string
|
|
95
|
+
uid: string & z.BRAND<"securityScheme">;
|
|
96
96
|
nameKey: string;
|
|
97
97
|
openIdConnectUrl: string;
|
|
98
98
|
description?: string | undefined;
|
|
@@ -382,12 +382,12 @@ export declare const securityOauthSchema: z.ZodObject<z.objectUtil.extendShape<z
|
|
|
382
382
|
} | undefined;
|
|
383
383
|
}>>;
|
|
384
384
|
}>, {
|
|
385
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
385
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "securityScheme">;
|
|
386
386
|
/** The name key that links a security requirement to a security object */
|
|
387
387
|
nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
388
388
|
}>, "strip", z.ZodTypeAny, {
|
|
389
389
|
type: "oauth2";
|
|
390
|
-
uid: string
|
|
390
|
+
uid: string & z.BRAND<"securityScheme">;
|
|
391
391
|
nameKey: string;
|
|
392
392
|
flows: {
|
|
393
393
|
password?: {
|
|
@@ -518,13 +518,13 @@ export declare const oasSecuritySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUt
|
|
|
518
518
|
}>, "strip", z.ZodTypeAny, {
|
|
519
519
|
type: "apiKey";
|
|
520
520
|
name: string;
|
|
521
|
-
in: "
|
|
521
|
+
in: "cookie" | "query" | "header";
|
|
522
522
|
description?: string | undefined;
|
|
523
523
|
}, {
|
|
524
524
|
type: "apiKey";
|
|
525
525
|
name?: string | undefined;
|
|
526
526
|
description?: string | undefined;
|
|
527
|
-
in?: "
|
|
527
|
+
in?: "cookie" | "query" | "header" | undefined;
|
|
528
528
|
}>, z.ZodObject<z.objectUtil.extendShape<{
|
|
529
529
|
description: z.ZodOptional<z.ZodString>;
|
|
530
530
|
}, {
|
|
@@ -953,7 +953,7 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
|
|
|
953
953
|
/** REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie". */
|
|
954
954
|
in: z.ZodDefault<z.ZodOptional<z.ZodEnum<["query", "header", "cookie"]>>>;
|
|
955
955
|
}>, {
|
|
956
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
956
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "securityScheme">;
|
|
957
957
|
/** The name key that links a security requirement to a security object */
|
|
958
958
|
nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
959
959
|
}>, {
|
|
@@ -961,10 +961,10 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
|
|
|
961
961
|
}>, "strip", z.ZodTypeAny, {
|
|
962
962
|
type: "apiKey";
|
|
963
963
|
value: string;
|
|
964
|
-
uid: string
|
|
964
|
+
uid: string & z.BRAND<"securityScheme">;
|
|
965
965
|
name: string;
|
|
966
966
|
nameKey: string;
|
|
967
|
-
in: "
|
|
967
|
+
in: "cookie" | "query" | "header";
|
|
968
968
|
description?: string | undefined;
|
|
969
969
|
}, {
|
|
970
970
|
type: "apiKey";
|
|
@@ -973,7 +973,7 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
|
|
|
973
973
|
name?: string | undefined;
|
|
974
974
|
description?: string | undefined;
|
|
975
975
|
nameKey?: string | undefined;
|
|
976
|
-
in?: "
|
|
976
|
+
in?: "cookie" | "query" | "header" | undefined;
|
|
977
977
|
}>, z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
|
|
978
978
|
description: z.ZodOptional<z.ZodString>;
|
|
979
979
|
}, {
|
|
@@ -990,7 +990,7 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
|
|
|
990
990
|
*/
|
|
991
991
|
bearerFormat: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"JWT">, z.ZodString]>>>;
|
|
992
992
|
}>, {
|
|
993
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
993
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "securityScheme">;
|
|
994
994
|
/** The name key that links a security requirement to a security object */
|
|
995
995
|
nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
996
996
|
}>, {
|
|
@@ -999,7 +999,7 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
|
|
|
999
999
|
token: z.ZodDefault<z.ZodString>;
|
|
1000
1000
|
}>, "strip", z.ZodTypeAny, {
|
|
1001
1001
|
type: "http";
|
|
1002
|
-
uid: string
|
|
1002
|
+
uid: string & z.BRAND<"securityScheme">;
|
|
1003
1003
|
nameKey: string;
|
|
1004
1004
|
scheme: "basic" | "bearer";
|
|
1005
1005
|
bearerFormat: string;
|
|
@@ -1027,12 +1027,12 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
|
|
|
1027
1027
|
*/
|
|
1028
1028
|
openIdConnectUrl: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
1029
1029
|
}>, {
|
|
1030
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
1030
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "securityScheme">;
|
|
1031
1031
|
/** The name key that links a security requirement to a security object */
|
|
1032
1032
|
nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
1033
1033
|
}>, "strip", z.ZodTypeAny, {
|
|
1034
1034
|
type: "openIdConnect";
|
|
1035
|
-
uid: string
|
|
1035
|
+
uid: string & z.BRAND<"securityScheme">;
|
|
1036
1036
|
nameKey: string;
|
|
1037
1037
|
openIdConnectUrl: string;
|
|
1038
1038
|
description?: string | undefined;
|
|
@@ -1318,12 +1318,12 @@ export declare const securitySchemeSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.
|
|
|
1318
1318
|
} | undefined;
|
|
1319
1319
|
}>>;
|
|
1320
1320
|
}>, {
|
|
1321
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
1321
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "securityScheme">;
|
|
1322
1322
|
/** The name key that links a security requirement to a security object */
|
|
1323
1323
|
nameKey: z.ZodDefault<z.ZodOptional<z.ZodString>>;
|
|
1324
1324
|
}>, "strip", z.ZodTypeAny, {
|
|
1325
1325
|
type: "oauth2";
|
|
1326
|
-
uid: string
|
|
1326
|
+
uid: string & z.BRAND<"securityScheme">;
|
|
1327
1327
|
nameKey: string;
|
|
1328
1328
|
flows: {
|
|
1329
1329
|
password?: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/security.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;
|
|
1
|
+
{"version":3,"file":"security.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/security.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAuBvB,eAAO,MAAM,sBAAsB,wCAAyC,CAAA;AAc5E,eAAO,MAAM,oBAAoB;;;;IAV/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;EAqBsC,CAAA;AAClH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAkCvE,eAAO,MAAM,kBAAkB;;;;IA3B7B;;;OAGG;;IAOH;;;;OAIG;;;;IA3CH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDgC,CAAA;AAC5G,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAanE,eAAO,MAAM,oBAAoB;;;;IAP/B;;;OAGG;;;;IAlEH,0EAA0E;;;;;;;;;;;;;;EAsEa,CAAA;AACzF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAsCvE,0CAA0C;AAC1C,eAAO,MAAM,WAAW,qCAAsC,CAAA;AAiD9D,eAAO,MAAM,mBAAmB;;;;IA5C9B,6FAA6F;;;YA1B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YAwCf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAlJT,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+JY,CAAA;AAExF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AACtE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAC7E,MAAM,MAAM,UAAU,GAAG,WAAW,CAClC,oBAAoB,CAAC,OAAO,CAAC,CAAC,mBAAmB,GAAG,mBAAmB,GAAG,UAAU,GAAG,UAAU,CAAC,CACnG,CAAA;AACD,iDAAiD;AACjD,MAAM,MAAM,iBAAiB,GAAG,WAAW,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,CAC7E,mBAAmB,GACnB,mBAAmB,GACnB,UAAU,GACV,UAAU,CAAC,GACb,MAAM,CAAC,KAAK,MAAM,EAAE,EAAE,MAAM,CAAC,CAAA;AAK/B;;;;;;;;;GASG;AACH,eAAO,MAAM,4BAA4B,wFAAmE,CAAA;AAE5G,qCAAqC;AACrC,eAAO,MAAM,uBAAuB;;;;IAnLlC,8EAA8E;;IAE9E,6FAA6F;;;;;;;;;;;;;;;;IAgB7F;;;OAGG;;IAOH;;;;OAIG;;;;;;;;;;;;;;;;IAwEH,6FAA6F;;;YA1B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YAwCf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAnFT;;;OAGG;;;;;;;;;;IAiIH,CAAA;AAEF,oDAAoD;AACpD,eAAO,MAAM,oBAAoB;;;;IA3L/B,8EAA8E;;IAE9E,6FAA6F;;;;IAb7F,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;IA6B1E;;;OAGG;;IAOH;;;;OAIG;;;;IA3CH,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA+D1E;;;OAGG;;;;IAlEH,0EAA0E;;;;;;;;;;;;;;;;;;IAmH1E,6FAA6F;;;YA1B7F;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;YAbrB;;;eAGG;;YAEH;;;eAGG;;;YAGH,oEAAoE;;YAEpE,qBAAqB;;;;;YAwCf;;;;eAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAlJT,0EAA0E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA2M1E,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA"}
|
|
@@ -9,7 +9,7 @@ const commonProps = z.object({
|
|
|
9
9
|
description: z.string().optional(),
|
|
10
10
|
});
|
|
11
11
|
const extendedSecuritySchema = z.object({
|
|
12
|
-
uid: nanoidSchema,
|
|
12
|
+
uid: nanoidSchema.brand(),
|
|
13
13
|
/** The name key that links a security requirement to a security object */
|
|
14
14
|
nameKey: z.string().optional().default(''),
|
|
15
15
|
});
|
|
@@ -26,9 +26,7 @@ const oasSecuritySchemeApiKey = commonProps.extend({
|
|
|
26
26
|
const apiKeyValueSchema = z.object({
|
|
27
27
|
value: z.string().default(''),
|
|
28
28
|
});
|
|
29
|
-
const securityApiKeySchema = oasSecuritySchemeApiKey
|
|
30
|
-
.merge(extendedSecuritySchema)
|
|
31
|
-
.merge(apiKeyValueSchema);
|
|
29
|
+
const securityApiKeySchema = oasSecuritySchemeApiKey.merge(extendedSecuritySchema).merge(apiKeyValueSchema);
|
|
32
30
|
// ---------------------------------------------------------------------------
|
|
33
31
|
// HTTP
|
|
34
32
|
const oasSecuritySchemeHttp = commonProps.extend({
|
|
@@ -58,9 +56,7 @@ const httpValueSchema = z.object({
|
|
|
58
56
|
password: z.string().default(''),
|
|
59
57
|
token: z.string().default(''),
|
|
60
58
|
});
|
|
61
|
-
const securityHttpSchema = oasSecuritySchemeHttp
|
|
62
|
-
.merge(extendedSecuritySchema)
|
|
63
|
-
.merge(httpValueSchema);
|
|
59
|
+
const securityHttpSchema = oasSecuritySchemeHttp.merge(extendedSecuritySchema).merge(httpValueSchema);
|
|
64
60
|
// ---------------------------------------------------------------------------
|
|
65
61
|
// OPENID CONNECT
|
|
66
62
|
const oasSecuritySchemeOpenId = commonProps.extend({
|
|
@@ -94,10 +90,7 @@ const flowsCommon = z.object({
|
|
|
94
90
|
* REQUIRED. The available scopes for the OAuth2 security scheme. A map
|
|
95
91
|
* between the scope name and a short description for it. The map MAY be empty.
|
|
96
92
|
*/
|
|
97
|
-
'scopes': z
|
|
98
|
-
.record(z.string(), z.string().optional().default(''))
|
|
99
|
-
.optional()
|
|
100
|
-
.default({}),
|
|
93
|
+
'scopes': z.record(z.string(), z.string().optional().default('')).optional().default({}),
|
|
101
94
|
'selectedScopes': z.array(z.string()).optional().default([]),
|
|
102
95
|
/** Extension to save the client Id associated with an oauth flow */
|
|
103
96
|
'x-scalar-client-id': z.string().optional().default(''),
|
|
@@ -105,9 +98,7 @@ const flowsCommon = z.object({
|
|
|
105
98
|
'token': z.string().default(''),
|
|
106
99
|
});
|
|
107
100
|
/** Setup a default redirect uri if we can */
|
|
108
|
-
const defaultRedirectUri = typeof window !== 'undefined'
|
|
109
|
-
? window.location.origin + window.location.pathname
|
|
110
|
-
: '';
|
|
101
|
+
const defaultRedirectUri = typeof window !== 'undefined' ? window.location.origin + window.location.pathname : '';
|
|
111
102
|
/** Options for the x-usePkce extension */
|
|
112
103
|
const pkceOptions = ['SHA-256', 'plain', 'no'];
|
|
113
104
|
/** Oauth2 security scheme */
|
|
@@ -120,10 +111,7 @@ const oasSecuritySchemeOauth2 = commonProps.extend({
|
|
|
120
111
|
implicit: flowsCommon.extend({
|
|
121
112
|
'type': z.literal('implicit'),
|
|
122
113
|
authorizationUrl,
|
|
123
|
-
'x-scalar-redirect-uri': z
|
|
124
|
-
.string()
|
|
125
|
-
.optional()
|
|
126
|
-
.default(defaultRedirectUri),
|
|
114
|
+
'x-scalar-redirect-uri': z.string().optional().default(defaultRedirectUri),
|
|
127
115
|
}),
|
|
128
116
|
/** Configuration for the OAuth Resource Owner Password flow */
|
|
129
117
|
password: flowsCommon.extend({
|
|
@@ -149,10 +137,7 @@ const oasSecuritySchemeOauth2 = commonProps.extend({
|
|
|
149
137
|
* TODO: add docs
|
|
150
138
|
*/
|
|
151
139
|
'x-usePkce': z.enum(pkceOptions).optional().default('no'),
|
|
152
|
-
'x-scalar-redirect-uri': z
|
|
153
|
-
.string()
|
|
154
|
-
.optional()
|
|
155
|
-
.default(defaultRedirectUri),
|
|
140
|
+
'x-scalar-redirect-uri': z.string().optional().default(defaultRedirectUri),
|
|
156
141
|
tokenUrl,
|
|
157
142
|
'clientSecret': z.string().default(''),
|
|
158
143
|
}),
|
|
@@ -94,9 +94,9 @@ export declare const serverSchema: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
94
94
|
value?: string;
|
|
95
95
|
}>>>;
|
|
96
96
|
}, {
|
|
97
|
-
uid: z.ZodDefault<z.ZodOptional<z.ZodString
|
|
97
|
+
uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "server">;
|
|
98
98
|
}>, "strip", z.ZodTypeAny, {
|
|
99
|
-
uid: string
|
|
99
|
+
uid: string & z.BRAND<"server">;
|
|
100
100
|
url: string;
|
|
101
101
|
description?: string | undefined;
|
|
102
102
|
variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/server.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,KAAK,SAAS,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvC;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;IAClC;;OAEG;;IAEH;;;;OAIG;;IAEH;;OAEG;;;;;;;;;;EAEH,CAAA;
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/server.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,KAAK,SAAS,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvC;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB;IAClC;;OAEG;;IAEH;;;;OAIG;;IAEH;;OAEG;;;;;;;;;;EAEH,CAAA;AA2BF;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;IAC1B;;;;OAIG;;IAEH;;;OAGG;;IAEH,oHAAoH;;eAxB3G,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpB,MAAM;;eADP,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpB,MAAM;;;;;;eADP,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpB,MAAM;;;;;;eADP,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpB,MAAM;;EAyB8B,CAAA;AAEhD,eAAO,MAAM,YAAY;IAfvB;;;;OAIG;;IAEH;;;OAGG;;IAEH,oHAAoH;;eAxB3G,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpB,MAAM;;eADP,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpB,MAAM;;;;;;;;;eADP,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpB,MAAM;;;;;;;eADP,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC;gBACpB,MAAM;;EA6BhB,CAAA;AAEF,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AACjD,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { z } from 'zod';
|
|
2
1
|
import { nanoidSchema } from '../shared/utility.js';
|
|
2
|
+
import { z } from 'zod';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Server Variable Object
|
|
@@ -32,9 +32,7 @@ const extendedServerVariableSchema = oasServerVariableSchema
|
|
|
32
32
|
})
|
|
33
33
|
.refine((data) => {
|
|
34
34
|
// Set default to the first enum value if invalid
|
|
35
|
-
if (Array.isArray(data.enum) &&
|
|
36
|
-
!data.enum.includes(data.default ?? '') &&
|
|
37
|
-
data.enum.length > 0) {
|
|
35
|
+
if (Array.isArray(data.enum) && !data.enum.includes(data.default ?? '') && data.enum.length > 0) {
|
|
38
36
|
data.default = data.enum[0];
|
|
39
37
|
}
|
|
40
38
|
if (Array.isArray(data.enum) && data.enum.length === 0) {
|
|
@@ -66,7 +64,7 @@ const oasServerSchema = z.object({
|
|
|
66
64
|
variables: z.record(z.string(), extendedServerVariableSchema).optional(),
|
|
67
65
|
});
|
|
68
66
|
const serverSchema = oasServerSchema.extend({
|
|
69
|
-
uid: nanoidSchema,
|
|
67
|
+
uid: nanoidSchema.brand(),
|
|
70
68
|
});
|
|
71
69
|
|
|
72
70
|
export { oasServerSchema, oasServerVariableSchema, serverSchema };
|