@scalar/oas-utils 0.2.7 → 0.2.9

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 (10) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/entities/workspace/cookie/cookie.d.ts +6 -6
  3. package/dist/entities/workspace/cookie/cookie.d.ts.map +1 -1
  4. package/dist/entities/workspace/cookie/cookie.js +5 -3
  5. package/dist/entities/workspace/spec/request-examples.d.ts +46 -0
  6. package/dist/entities/workspace/spec/request-examples.d.ts.map +1 -1
  7. package/dist/entities/workspace/spec/request-examples.js +1 -0
  8. package/dist/transforms/import-spec.d.ts.map +1 -1
  9. package/dist/transforms/import-spec.js +6 -1
  10. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # @scalar/oas-utils
2
2
 
3
+ ## 0.2.9
4
+
5
+ ### Patch Changes
6
+
7
+ - d6a2a4d: feat: oas-utils request example parameters enum
8
+ - 632d6f7: fix: add cookie handler and schema
9
+
10
+ ## 0.2.8
11
+
12
+ ### Patch Changes
13
+
14
+ - a01df62: fix: ensure path and operation params are merged on import
15
+
3
16
  ## 0.2.7
4
17
 
5
18
  ### Patch Changes
package/dist/entities/workspace/cookie/cookie.d.ts CHANGED
@@ -2,8 +2,8 @@ import { z } from 'zod';
2
2
  declare const cookieSchema: z.ZodObject<{
3
3
  uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
4
4
  /** Defines the cookie name and its value. A cookie definition begins with a name-value pair. */
5
- name: z.ZodString;
6
- value: z.ZodString;
5
+ name: z.ZodDefault<z.ZodString>;
6
+ value: z.ZodDefault<z.ZodString>;
7
7
  /** Defines the host to which the cookie will be sent. */
8
8
  domain: z.ZodOptional<z.ZodString>;
9
9
  /** Indicates the maximum lifetime of the cookie as an HTTP-date timestamp. See Date for the required formatting. */
@@ -30,7 +30,7 @@ declare const cookieSchema: z.ZodObject<{
30
30
  * Controls whether or not a cookie is sent with cross-site requests, providing some protection against cross-site
31
31
  * request forgery attacks (CSRF).
32
32
  */
33
- sameSite: z.ZodUnion<[z.ZodLiteral<"Lax">, z.ZodLiteral<"Strict">, z.ZodLiteral<"None">]>;
33
+ sameSite: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"Lax">, z.ZodLiteral<"Strict">, z.ZodLiteral<"None">]>>;
34
34
  /**
35
35
  * Indicates that the cookie is sent to the server only when a request is made with the https: scheme (except on
36
36
  * localhost), and therefore, is more resistant to man-in-the-middle attacks.
@@ -49,16 +49,16 @@ declare const cookieSchema: z.ZodObject<{
49
49
  partitioned?: boolean | undefined;
50
50
  secure?: boolean | undefined;
51
51
  }, {
52
- value: string;
53
- name: string;
54
- sameSite: "Lax" | "Strict" | "None";
55
52
  path?: string | undefined;
53
+ value?: string | undefined;
56
54
  uid?: string | undefined;
55
+ name?: string | undefined;
57
56
  domain?: string | undefined;
58
57
  expires?: Date | undefined;
59
58
  httpOnly?: boolean | undefined;
60
59
  maxAge?: number | undefined;
61
60
  partitioned?: boolean | undefined;
61
+ sameSite?: "Lax" | "Strict" | "None" | undefined;
62
62
  secure?: boolean | undefined;
63
63
  }>;
64
64
  /**
package/dist/entities/workspace/cookie/cookie.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cookie.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/cookie/cookie.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB,QAAA,MAAM,YAAY;;IAEhB,kGAAkG;;;IAGlG,yDAAyD;;IAEzD,oHAAoH;;IAEpH;;;;OAIG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,yGAAyG;;IAEzG;;;OAGG;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAA;AAEF;;;;GAIG;AACH,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;AAExD,2BAA2B;AAC3B,eAAO,MAAM,YAAY,YAAa,aAAa;;;;;;;;;;;;CACP,CAAA"}
1
+ {"version":3,"file":"cookie.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/cookie/cookie.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB,QAAA,MAAM,YAAY;;IAEhB,kGAAkG;;;IAGlG,yDAAyD;;IAEzD,oHAAoH;;IAEpH;;;;OAIG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH,yGAAyG;;IAEzG;;;OAGG;;IAIH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAA;AAEF;;;;GAIG;AACH,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;AAExD,2BAA2B;AAC3B,eAAO,MAAM,YAAY,YAAa,aAAa;;;;;;;;;;;;CACP,CAAA"}
package/dist/entities/workspace/cookie/cookie.js CHANGED
@@ -5,8 +5,8 @@ import { deepMerge } from '../../../helpers/deepMerge.js';
5
5
  const cookieSchema = z.object({
6
6
  uid: nanoidSchema,
7
7
  /** Defines the cookie name and its value. A cookie definition begins with a name-value pair. */
8
- name: z.string(),
9
- value: z.string(),
8
+ name: z.string().default('Default Cookie'),
9
+ value: z.string().default('Default Value'),
10
10
  /** Defines the host to which the cookie will be sent. */
11
11
  domain: z.string().optional(),
12
12
  /** Indicates the maximum lifetime of the cookie as an HTTP-date timestamp. See Date for the required formatting. */
@@ -33,7 +33,9 @@ const cookieSchema = z.object({
33
33
  * Controls whether or not a cookie is sent with cross-site requests, providing some protection against cross-site
34
34
  * request forgery attacks (CSRF).
35
35
  */
36
- sameSite: z.union([z.literal('Lax'), z.literal('Strict'), z.literal('None')]),
36
+ sameSite: z
37
+ .union([z.literal('Lax'), z.literal('Strict'), z.literal('None')])
38
+ .default('None'),
37
39
  /**
38
40
  * Indicates that the cookie is sent to the server only when a request is made with the https: scheme (except on
39
41
  * localhost), and therefore, is more resistant to man-in-the-middle attacks.
package/dist/entities/workspace/spec/request-examples.d.ts CHANGED
@@ -8,11 +8,13 @@ declare const requestExampleParametersSchema: z.ZodObject<{
8
8
  /** Params are linked to parents such as path params and global headers/cookies */
9
9
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
10
10
  required: z.ZodOptional<z.ZodBoolean>;
11
+ enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
11
12
  }, "strip", z.ZodTypeAny, {
12
13
  value: string;
13
14
  key: string;
14
15
  enabled: boolean;
15
16
  description?: string | undefined;
17
+ enum?: string[] | undefined;
16
18
  required?: boolean | undefined;
17
19
  file?: File | undefined;
18
20
  refUid?: string | undefined;
@@ -20,6 +22,7 @@ declare const requestExampleParametersSchema: z.ZodObject<{
20
22
  value?: string | number | undefined;
21
23
  description?: string | undefined;
22
24
  key?: string | undefined;
25
+ enum?: string[] | undefined;
23
26
  required?: boolean | undefined;
24
27
  enabled?: boolean | undefined;
25
28
  file?: File | undefined;
@@ -34,6 +37,7 @@ export declare const createRequestExampleParameter: (payload: RequestExamplePara
34
37
  key: string;
35
38
  enabled: boolean;
36
39
  description?: string | undefined;
40
+ enum?: string[] | undefined;
37
41
  required?: boolean | undefined;
38
42
  file?: File | undefined;
39
43
  refUid?: string | undefined;
@@ -64,11 +68,13 @@ declare const requestExampleSchema: z.ZodObject<{
64
68
  /** Params are linked to parents such as path params and global headers/cookies */
65
69
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
66
70
  required: z.ZodOptional<z.ZodBoolean>;
71
+ enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
67
72
  }, "strip", z.ZodTypeAny, {
68
73
  value: string;
69
74
  key: string;
70
75
  enabled: boolean;
71
76
  description?: string | undefined;
77
+ enum?: string[] | undefined;
72
78
  required?: boolean | undefined;
73
79
  file?: File | undefined;
74
80
  refUid?: string | undefined;
@@ -76,6 +82,7 @@ declare const requestExampleSchema: z.ZodObject<{
76
82
  value?: string | number | undefined;
77
83
  description?: string | undefined;
78
84
  key?: string | undefined;
85
+ enum?: string[] | undefined;
79
86
  required?: boolean | undefined;
80
87
  enabled?: boolean | undefined;
81
88
  file?: File | undefined;
@@ -87,6 +94,7 @@ declare const requestExampleSchema: z.ZodObject<{
87
94
  key: string;
88
95
  enabled: boolean;
89
96
  description?: string | undefined;
97
+ enum?: string[] | undefined;
90
98
  required?: boolean | undefined;
91
99
  file?: File | undefined;
92
100
  refUid?: string | undefined;
@@ -97,6 +105,7 @@ declare const requestExampleSchema: z.ZodObject<{
97
105
  value?: string | number | undefined;
98
106
  description?: string | undefined;
99
107
  key?: string | undefined;
108
+ enum?: string[] | undefined;
100
109
  required?: boolean | undefined;
101
110
  enabled?: boolean | undefined;
102
111
  file?: File | undefined;
@@ -117,6 +126,7 @@ declare const requestExampleSchema: z.ZodObject<{
117
126
  key: string;
118
127
  enabled: boolean;
119
128
  description?: string | undefined;
129
+ enum?: string[] | undefined;
120
130
  required?: boolean | undefined;
121
131
  file?: File | undefined;
122
132
  refUid?: string | undefined;
@@ -135,6 +145,7 @@ declare const requestExampleSchema: z.ZodObject<{
135
145
  value?: string | number | undefined;
136
146
  description?: string | undefined;
137
147
  key?: string | undefined;
148
+ enum?: string[] | undefined;
138
149
  required?: boolean | undefined;
139
150
  enabled?: boolean | undefined;
140
151
  file?: File | undefined;
@@ -155,11 +166,13 @@ declare const requestExampleSchema: z.ZodObject<{
155
166
  /** Params are linked to parents such as path params and global headers/cookies */
156
167
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
157
168
  required: z.ZodOptional<z.ZodBoolean>;
169
+ enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
158
170
  }, "strip", z.ZodTypeAny, {
159
171
  value: string;
160
172
  key: string;
161
173
  enabled: boolean;
162
174
  description?: string | undefined;
175
+ enum?: string[] | undefined;
163
176
  required?: boolean | undefined;
164
177
  file?: File | undefined;
165
178
  refUid?: string | undefined;
@@ -167,6 +180,7 @@ declare const requestExampleSchema: z.ZodObject<{
167
180
  value?: string | number | undefined;
168
181
  description?: string | undefined;
169
182
  key?: string | undefined;
183
+ enum?: string[] | undefined;
170
184
  required?: boolean | undefined;
171
185
  enabled?: boolean | undefined;
172
186
  file?: File | undefined;
@@ -181,11 +195,13 @@ declare const requestExampleSchema: z.ZodObject<{
181
195
  /** Params are linked to parents such as path params and global headers/cookies */
182
196
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
183
197
  required: z.ZodOptional<z.ZodBoolean>;
198
+ enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
184
199
  }, "strip", z.ZodTypeAny, {
185
200
  value: string;
186
201
  key: string;
187
202
  enabled: boolean;
188
203
  description?: string | undefined;
204
+ enum?: string[] | undefined;
189
205
  required?: boolean | undefined;
190
206
  file?: File | undefined;
191
207
  refUid?: string | undefined;
@@ -193,6 +209,7 @@ declare const requestExampleSchema: z.ZodObject<{
193
209
  value?: string | number | undefined;
194
210
  description?: string | undefined;
195
211
  key?: string | undefined;
212
+ enum?: string[] | undefined;
196
213
  required?: boolean | undefined;
197
214
  enabled?: boolean | undefined;
198
215
  file?: File | undefined;
@@ -207,11 +224,13 @@ declare const requestExampleSchema: z.ZodObject<{
207
224
  /** Params are linked to parents such as path params and global headers/cookies */
208
225
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
209
226
  required: z.ZodOptional<z.ZodBoolean>;
227
+ enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
210
228
  }, "strip", z.ZodTypeAny, {
211
229
  value: string;
212
230
  key: string;
213
231
  enabled: boolean;
214
232
  description?: string | undefined;
233
+ enum?: string[] | undefined;
215
234
  required?: boolean | undefined;
216
235
  file?: File | undefined;
217
236
  refUid?: string | undefined;
@@ -219,6 +238,7 @@ declare const requestExampleSchema: z.ZodObject<{
219
238
  value?: string | number | undefined;
220
239
  description?: string | undefined;
221
240
  key?: string | undefined;
241
+ enum?: string[] | undefined;
222
242
  required?: boolean | undefined;
223
243
  enabled?: boolean | undefined;
224
244
  file?: File | undefined;
@@ -233,11 +253,13 @@ declare const requestExampleSchema: z.ZodObject<{
233
253
  /** Params are linked to parents such as path params and global headers/cookies */
234
254
  refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
235
255
  required: z.ZodOptional<z.ZodBoolean>;
256
+ enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
236
257
  }, "strip", z.ZodTypeAny, {
237
258
  value: string;
238
259
  key: string;
239
260
  enabled: boolean;
240
261
  description?: string | undefined;
262
+ enum?: string[] | undefined;
241
263
  required?: boolean | undefined;
242
264
  file?: File | undefined;
243
265
  refUid?: string | undefined;
@@ -245,6 +267,7 @@ declare const requestExampleSchema: z.ZodObject<{
245
267
  value?: string | number | undefined;
246
268
  description?: string | undefined;
247
269
  key?: string | undefined;
270
+ enum?: string[] | undefined;
248
271
  required?: boolean | undefined;
249
272
  enabled?: boolean | undefined;
250
273
  file?: File | undefined;
@@ -256,6 +279,7 @@ declare const requestExampleSchema: z.ZodObject<{
256
279
  key: string;
257
280
  enabled: boolean;
258
281
  description?: string | undefined;
282
+ enum?: string[] | undefined;
259
283
  required?: boolean | undefined;
260
284
  file?: File | undefined;
261
285
  refUid?: string | undefined;
@@ -265,6 +289,7 @@ declare const requestExampleSchema: z.ZodObject<{
265
289
  key: string;
266
290
  enabled: boolean;
267
291
  description?: string | undefined;
292
+ enum?: string[] | undefined;
268
293
  required?: boolean | undefined;
269
294
  file?: File | undefined;
270
295
  refUid?: string | undefined;
@@ -274,6 +299,7 @@ declare const requestExampleSchema: z.ZodObject<{
274
299
  key: string;
275
300
  enabled: boolean;
276
301
  description?: string | undefined;
302
+ enum?: string[] | undefined;
277
303
  required?: boolean | undefined;
278
304
  file?: File | undefined;
279
305
  refUid?: string | undefined;
@@ -283,6 +309,7 @@ declare const requestExampleSchema: z.ZodObject<{
283
309
  key: string;
284
310
  enabled: boolean;
285
311
  description?: string | undefined;
312
+ enum?: string[] | undefined;
286
313
  required?: boolean | undefined;
287
314
  file?: File | undefined;
288
315
  refUid?: string | undefined;
@@ -292,6 +319,7 @@ declare const requestExampleSchema: z.ZodObject<{
292
319
  value?: string | number | undefined;
293
320
  description?: string | undefined;
294
321
  key?: string | undefined;
322
+ enum?: string[] | undefined;
295
323
  required?: boolean | undefined;
296
324
  enabled?: boolean | undefined;
297
325
  file?: File | undefined;
@@ -301,6 +329,7 @@ declare const requestExampleSchema: z.ZodObject<{
301
329
  value?: string | number | undefined;
302
330
  description?: string | undefined;
303
331
  key?: string | undefined;
332
+ enum?: string[] | undefined;
304
333
  required?: boolean | undefined;
305
334
  enabled?: boolean | undefined;
306
335
  file?: File | undefined;
@@ -310,6 +339,7 @@ declare const requestExampleSchema: z.ZodObject<{
310
339
  value?: string | number | undefined;
311
340
  description?: string | undefined;
312
341
  key?: string | undefined;
342
+ enum?: string[] | undefined;
313
343
  required?: boolean | undefined;
314
344
  enabled?: boolean | undefined;
315
345
  file?: File | undefined;
@@ -319,6 +349,7 @@ declare const requestExampleSchema: z.ZodObject<{
319
349
  value?: string | number | undefined;
320
350
  description?: string | undefined;
321
351
  key?: string | undefined;
352
+ enum?: string[] | undefined;
322
353
  required?: boolean | undefined;
323
354
  enabled?: boolean | undefined;
324
355
  file?: File | undefined;
@@ -335,6 +366,7 @@ declare const requestExampleSchema: z.ZodObject<{
335
366
  key: string;
336
367
  enabled: boolean;
337
368
  description?: string | undefined;
369
+ enum?: string[] | undefined;
338
370
  required?: boolean | undefined;
339
371
  file?: File | undefined;
340
372
  refUid?: string | undefined;
@@ -344,6 +376,7 @@ declare const requestExampleSchema: z.ZodObject<{
344
376
  key: string;
345
377
  enabled: boolean;
346
378
  description?: string | undefined;
379
+ enum?: string[] | undefined;
347
380
  required?: boolean | undefined;
348
381
  file?: File | undefined;
349
382
  refUid?: string | undefined;
@@ -353,6 +386,7 @@ declare const requestExampleSchema: z.ZodObject<{
353
386
  key: string;
354
387
  enabled: boolean;
355
388
  description?: string | undefined;
389
+ enum?: string[] | undefined;
356
390
  required?: boolean | undefined;
357
391
  file?: File | undefined;
358
392
  refUid?: string | undefined;
@@ -362,6 +396,7 @@ declare const requestExampleSchema: z.ZodObject<{
362
396
  key: string;
363
397
  enabled: boolean;
364
398
  description?: string | undefined;
399
+ enum?: string[] | undefined;
365
400
  required?: boolean | undefined;
366
401
  file?: File | undefined;
367
402
  refUid?: string | undefined;
@@ -379,6 +414,7 @@ declare const requestExampleSchema: z.ZodObject<{
379
414
  key: string;
380
415
  enabled: boolean;
381
416
  description?: string | undefined;
417
+ enum?: string[] | undefined;
382
418
  required?: boolean | undefined;
383
419
  file?: File | undefined;
384
420
  refUid?: string | undefined;
@@ -398,6 +434,7 @@ declare const requestExampleSchema: z.ZodObject<{
398
434
  value?: string | number | undefined;
399
435
  description?: string | undefined;
400
436
  key?: string | undefined;
437
+ enum?: string[] | undefined;
401
438
  required?: boolean | undefined;
402
439
  enabled?: boolean | undefined;
403
440
  file?: File | undefined;
@@ -407,6 +444,7 @@ declare const requestExampleSchema: z.ZodObject<{
407
444
  value?: string | number | undefined;
408
445
  description?: string | undefined;
409
446
  key?: string | undefined;
447
+ enum?: string[] | undefined;
410
448
  required?: boolean | undefined;
411
449
  enabled?: boolean | undefined;
412
450
  file?: File | undefined;
@@ -416,6 +454,7 @@ declare const requestExampleSchema: z.ZodObject<{
416
454
  value?: string | number | undefined;
417
455
  description?: string | undefined;
418
456
  key?: string | undefined;
457
+ enum?: string[] | undefined;
419
458
  required?: boolean | undefined;
420
459
  enabled?: boolean | undefined;
421
460
  file?: File | undefined;
@@ -425,6 +464,7 @@ declare const requestExampleSchema: z.ZodObject<{
425
464
  value?: string | number | undefined;
426
465
  description?: string | undefined;
427
466
  key?: string | undefined;
467
+ enum?: string[] | undefined;
428
468
  required?: boolean | undefined;
429
469
  enabled?: boolean | undefined;
430
470
  file?: File | undefined;
@@ -441,6 +481,7 @@ declare const requestExampleSchema: z.ZodObject<{
441
481
  value?: string | number | undefined;
442
482
  description?: string | undefined;
443
483
  key?: string | undefined;
484
+ enum?: string[] | undefined;
444
485
  required?: boolean | undefined;
445
486
  enabled?: boolean | undefined;
446
487
  file?: File | undefined;
@@ -466,6 +507,7 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
466
507
  key: string;
467
508
  enabled: boolean;
468
509
  description?: string | undefined;
510
+ enum?: string[] | undefined;
469
511
  required?: boolean | undefined;
470
512
  file?: File | undefined;
471
513
  refUid?: string | undefined;
@@ -475,6 +517,7 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
475
517
  key: string;
476
518
  enabled: boolean;
477
519
  description?: string | undefined;
520
+ enum?: string[] | undefined;
478
521
  required?: boolean | undefined;
479
522
  file?: File | undefined;
480
523
  refUid?: string | undefined;
@@ -484,6 +527,7 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
484
527
  key: string;
485
528
  enabled: boolean;
486
529
  description?: string | undefined;
530
+ enum?: string[] | undefined;
487
531
  required?: boolean | undefined;
488
532
  file?: File | undefined;
489
533
  refUid?: string | undefined;
@@ -493,6 +537,7 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
493
537
  key: string;
494
538
  enabled: boolean;
495
539
  description?: string | undefined;
540
+ enum?: string[] | undefined;
496
541
  required?: boolean | undefined;
497
542
  file?: File | undefined;
498
543
  refUid?: string | undefined;
@@ -510,6 +555,7 @@ export declare const createRequestExample: (payload: RequestExamplePayload) => {
510
555
  key: string;
511
556
  enabled: boolean;
512
557
  description?: string | undefined;
558
+ enum?: string[] | undefined;
513
559
  required?: boolean | undefined;
514
560
  file?: File | undefined;
515
561
  refUid?: string | undefined;
package/dist/entities/workspace/spec/request-examples.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/request-examples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,QAAA,MAAM,8BAA8B;;;;;;IAMlC,kFAAkF;;;;;;;;;;;;;;;;;;;EAGlF,CAAA;AAEF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AACD,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,8CAA8C;AAC9C,eAAO,MAAM,6BAA6B,YAC/B,8BAA8B;;;;;;;;CACwB,CAAA;AAEjE,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;gBAlBxB,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkElF,CAAA;AAEF,mDAAmD;AACnD,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;AAExE,oCAAoC;AACpC,eAAO,MAAM,oBAAoB,YAAa,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIhE,CAAA"}
1
+ {"version":3,"file":"request-examples.d.ts","sourceRoot":"","sources":["../../../../src/entities/workspace/spec/request-examples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,QAAA,MAAM,8BAA8B;;;;;;IAMlC,kFAAkF;;;;;;;;;;;;;;;;;;;;;;EAIlF,CAAA;AAEF,kFAAkF;AAClF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACtC,CAAA;AACD,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAClD,OAAO,8BAA8B,CACtC,CAAA;AAED,8CAA8C;AAC9C,eAAO,MAAM,6BAA6B,YAC/B,8BAA8B;;;;;;;;;CACwB,CAAA;AAEjE,QAAA,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;gBAnBxB,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAAlF,kFAAkF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAmElF,CAAA;AAEF,mDAAmD;AACnD,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;AAExE,oCAAoC;AACpC,eAAO,MAAM,oBAAoB,YAAa,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAIhE,CAAA"}
package/dist/entities/workspace/spec/request-examples.js CHANGED
@@ -11,6 +11,7 @@ const requestExampleParametersSchema = z.object({
11
11
  /** Params are linked to parents such as path params and global headers/cookies */
12
12
  refUid: nanoidSchema.optional(),
13
13
  required: z.boolean().optional(),
14
+ enum: z.array(z.string()).optional(),
14
15
  });
15
16
  /** Create request example parameter helper */
16
17
  const createRequestExampleParameter = (payload) => deepMerge(requestExampleParametersSchema.parse({}), payload);
package/dist/transforms/import-spec.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,2BAA2B,CAAA;AAKvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAWxC,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,SAAgB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiLnE,CAAA"}
1
+ {"version":3,"file":"import-spec.d.ts","sourceRoot":"","sources":["../../src/transforms/import-spec.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,OAAO,EAAiB,MAAM,2BAA2B,CAAA;AAKvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAWxC,uEAAuE;AACvE,eAAO,MAAM,qBAAqB,SAAgB,MAAM,GAAG,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuLnE,CAAA"}
package/dist/transforms/import-spec.js CHANGED
@@ -54,8 +54,13 @@ const importSpecToWorkspace = async (spec) => {
54
54
  headers: {},
55
55
  cookies: {},
56
56
  };
57
+ // An operation can have component level parameters as well :)
58
+ const pathAndOperationParameters = [
59
+ ...(path.parameters || []),
60
+ ...(operation.parameters || []),
61
+ ].filter((p) => p);
57
62
  // Loop over params to set request params
58
- operation.parameters?.forEach((_param) => {
63
+ pathAndOperationParameters.forEach((_param) => {
59
64
  const param = _param;
60
65
  if ('name' in param &&
61
66
  PARAM_DICTIONARY[param.in]) {
package/package.json CHANGED
@@ -16,7 +16,7 @@
16
16
  "specification",
17
17
  "yaml"
18
18
  ],
19
- "version": "0.2.7",
19
+ "version": "0.2.9",
20
20
  "engines": {
21
21
  "node": ">=18"
22
22
  },
@@ -101,7 +101,7 @@
101
101
  "type-fest": "^4.20.0",
102
102
  "vite": "^5.2.10",
103
103
  "vitest": "^1.6.0",
104
- "@scalar/build-tooling": "0.1.7"
104
+ "@scalar/build-tooling": "0.1.8"
105
105
  },
106
106
  "scripts": {
107
107
  "build": "scalar-build-rollup",