@scalar/oas-utils 0.2.96 → 0.2.97

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 (19) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/entities/spec/request-examples.d.ts +79 -79
  3. package/dist/entities/spec/requests.d.ts +24 -10
  4. package/dist/entities/spec/requests.d.ts.map +1 -1
  5. package/dist/entities/spec/requests.js +3 -0
  6. package/dist/entities/spec/spec-objects.d.ts +14 -0
  7. package/dist/entities/spec/spec-objects.d.ts.map +1 -1
  8. package/dist/entities/spec/spec-objects.js +3 -0
  9. package/dist/helpers/index.d.ts +2 -1
  10. package/dist/helpers/index.d.ts.map +1 -1
  11. package/dist/helpers/index.js +2 -1
  12. package/dist/helpers/shouldIgnoreEntity.d.ts +7 -0
  13. package/dist/helpers/shouldIgnoreEntity.d.ts.map +1 -0
  14. package/dist/helpers/shouldIgnoreEntity.js +8 -0
  15. package/dist/migrations/v-2.2.0/types.generated.d.ts +339 -27
  16. package/dist/migrations/v-2.2.0/types.generated.d.ts.map +1 -1
  17. package/dist/migrations/v-2.3.0/types.generated.d.ts +360 -24
  18. package/dist/migrations/v-2.3.0/types.generated.d.ts.map +1 -1
  19. package/package.json +7 -7
package/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # @scalar/oas-utils
2
2
 
3
+ ## 0.2.97
4
+
5
+ ### Patch Changes
6
+
7
+ - 7df4472: fix: generate types for past migrations, add tests and docs
8
+ - Updated dependencies [60cd6f1]
9
+ - Updated dependencies [60cd6f1]
10
+ - Updated dependencies [e866487]
11
+ - Updated dependencies [13333e6]
12
+ - @scalar/types@0.0.26
13
+ - @scalar/themes@0.9.60
14
+ - @scalar/openapi-types@0.1.6
15
+
3
16
  ## 0.2.96
4
17
 
5
18
  ### Patch Changes
package/dist/entities/spec/request-examples.d.ts CHANGED
@@ -46,9 +46,9 @@ export declare const requestExampleParametersSchema: z.ZodObject<{
46
46
  description?: string | undefined;
47
47
  enum?: string[] | undefined;
48
48
  format?: string | undefined;
49
+ file?: any;
49
50
  key?: string | undefined;
50
51
  enabled?: boolean | undefined;
51
- file?: any;
52
52
  nullable?: boolean | undefined;
53
53
  }>;
54
54
  /** Request examples - formerly known as instances - are "children" of requests */
@@ -173,9 +173,9 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
173
173
  description?: string | undefined;
174
174
  enum?: string[] | undefined;
175
175
  format?: string | undefined;
176
+ file?: any;
176
177
  key?: string | undefined;
177
178
  enabled?: boolean | undefined;
178
- file?: any;
179
179
  nullable?: boolean | undefined;
180
180
  }>, "many">>;
181
181
  }, "strip", z.ZodTypeAny, {
@@ -206,9 +206,9 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
206
206
  description?: string | undefined;
207
207
  enum?: string[] | undefined;
208
208
  format?: string | undefined;
209
+ file?: any;
209
210
  key?: string | undefined;
210
211
  enabled?: boolean | undefined;
211
- file?: any;
212
212
  nullable?: boolean | undefined;
213
213
  }[] | undefined;
214
214
  encoding?: "form-data" | "urlencoded" | undefined;
@@ -216,7 +216,8 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
216
216
  binary: z.ZodOptional<z.ZodType<Blob, z.ZodTypeDef, Blob>>;
217
217
  activeBody: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"raw">, z.ZodLiteral<"formData">, z.ZodLiteral<"binary">]>>;
218
218
  }, "strip", z.ZodTypeAny, {
219
- activeBody: "formData" | "binary" | "raw";
219
+ activeBody: "binary" | "formData" | "raw";
220
+ binary?: Blob | undefined;
220
221
  formData?: {
221
222
  value: {
222
223
  value: string;
@@ -235,12 +236,12 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
235
236
  }[];
236
237
  encoding: "form-data" | "urlencoded";
237
238
  } | undefined;
238
- binary?: Blob | undefined;
239
239
  raw?: {
240
240
  value: string;
241
241
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
242
242
  } | undefined;
243
243
  }, {
244
+ binary?: Blob | undefined;
244
245
  formData?: {
245
246
  value?: {
246
247
  minimum?: number | undefined;
@@ -252,19 +253,18 @@ export declare const exampleRequestBodySchema: z.ZodObject<{
252
253
  description?: string | undefined;
253
254
  enum?: string[] | undefined;
254
255
  format?: string | undefined;
256
+ file?: any;
255
257
  key?: string | undefined;
256
258
  enabled?: boolean | undefined;
257
- file?: any;
258
259
  nullable?: boolean | undefined;
259
260
  }[] | undefined;
260
261
  encoding?: "form-data" | "urlencoded" | undefined;
261
262
  } | undefined;
262
- binary?: Blob | undefined;
263
263
  raw?: {
264
264
  value?: string | undefined;
265
265
  encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
266
266
  } | undefined;
267
- activeBody?: "formData" | "binary" | "raw" | undefined;
267
+ activeBody?: "binary" | "formData" | "raw" | undefined;
268
268
  }>;
269
269
  export type ExampleRequestBody = z.infer<typeof exampleRequestBodySchema>;
270
270
  /** Schema for the OAS serialization of request example bodies */
@@ -289,18 +289,18 @@ export declare const xScalarExampleBodySchema: z.ZodObject<{
289
289
  }>>>;
290
290
  }, "strip", z.ZodTypeAny, {
291
291
  content: string | Record<string, any>;
292
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
292
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
293
293
  file?: {
294
294
  url: string;
295
295
  base64?: string | undefined;
296
296
  } | null | undefined;
297
297
  }, {
298
298
  content: string | Record<string, any>;
299
+ encoding?: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary" | undefined;
299
300
  file?: {
300
301
  url: string;
301
302
  base64?: string | undefined;
302
303
  } | null | undefined;
303
- encoding?: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary" | undefined;
304
304
  }>;
305
305
  export type XScalarExampleBody = z.infer<typeof xScalarExampleBodySchema>;
306
306
  export declare const requestExampleSchema: z.ZodObject<{
@@ -359,9 +359,9 @@ export declare const requestExampleSchema: z.ZodObject<{
359
359
  description?: string | undefined;
360
360
  enum?: string[] | undefined;
361
361
  format?: string | undefined;
362
+ file?: any;
362
363
  key?: string | undefined;
363
364
  enabled?: boolean | undefined;
364
- file?: any;
365
365
  nullable?: boolean | undefined;
366
366
  }>, "many">>;
367
367
  }, "strip", z.ZodTypeAny, {
@@ -392,9 +392,9 @@ export declare const requestExampleSchema: z.ZodObject<{
392
392
  description?: string | undefined;
393
393
  enum?: string[] | undefined;
394
394
  format?: string | undefined;
395
+ file?: any;
395
396
  key?: string | undefined;
396
397
  enabled?: boolean | undefined;
397
- file?: any;
398
398
  nullable?: boolean | undefined;
399
399
  }[] | undefined;
400
400
  encoding?: "form-data" | "urlencoded" | undefined;
@@ -402,7 +402,8 @@ export declare const requestExampleSchema: z.ZodObject<{
402
402
  binary: z.ZodOptional<z.ZodType<Blob, z.ZodTypeDef, Blob>>;
403
403
  activeBody: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"raw">, z.ZodLiteral<"formData">, z.ZodLiteral<"binary">]>>;
404
404
  }, "strip", z.ZodTypeAny, {
405
- activeBody: "formData" | "binary" | "raw";
405
+ activeBody: "binary" | "formData" | "raw";
406
+ binary?: Blob | undefined;
406
407
  formData?: {
407
408
  value: {
408
409
  value: string;
@@ -421,12 +422,12 @@ export declare const requestExampleSchema: z.ZodObject<{
421
422
  }[];
422
423
  encoding: "form-data" | "urlencoded";
423
424
  } | undefined;
424
- binary?: Blob | undefined;
425
425
  raw?: {
426
426
  value: string;
427
427
  encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
428
428
  } | undefined;
429
429
  }, {
430
+ binary?: Blob | undefined;
430
431
  formData?: {
431
432
  value?: {
432
433
  minimum?: number | undefined;
@@ -438,19 +439,18 @@ export declare const requestExampleSchema: z.ZodObject<{
438
439
  description?: string | undefined;
439
440
  enum?: string[] | undefined;
440
441
  format?: string | undefined;
442
+ file?: any;
441
443
  key?: string | undefined;
442
444
  enabled?: boolean | undefined;
443
- file?: any;
444
445
  nullable?: boolean | undefined;
445
446
  }[] | undefined;
446
447
  encoding?: "form-data" | "urlencoded" | undefined;
447
448
  } | undefined;
448
- binary?: Blob | undefined;
449
449
  raw?: {
450
450
  value?: string | undefined;
451
451
  encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
452
452
  } | undefined;
453
- activeBody?: "formData" | "binary" | "raw" | undefined;
453
+ activeBody?: "binary" | "formData" | "raw" | undefined;
454
454
  }>>>;
455
455
  parameters: z.ZodDefault<z.ZodOptional<z.ZodObject<{
456
456
  path: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -491,9 +491,9 @@ export declare const requestExampleSchema: z.ZodObject<{
491
491
  description?: string | undefined;
492
492
  enum?: string[] | undefined;
493
493
  format?: string | undefined;
494
+ file?: any;
494
495
  key?: string | undefined;
495
496
  enabled?: boolean | undefined;
496
- file?: any;
497
497
  nullable?: boolean | undefined;
498
498
  }>, "many">>;
499
499
  query: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -534,9 +534,9 @@ export declare const requestExampleSchema: z.ZodObject<{
534
534
  description?: string | undefined;
535
535
  enum?: string[] | undefined;
536
536
  format?: string | undefined;
537
+ file?: any;
537
538
  key?: string | undefined;
538
539
  enabled?: boolean | undefined;
539
- file?: any;
540
540
  nullable?: boolean | undefined;
541
541
  }>, "many">>;
542
542
  headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -577,9 +577,9 @@ export declare const requestExampleSchema: z.ZodObject<{
577
577
  description?: string | undefined;
578
578
  enum?: string[] | undefined;
579
579
  format?: string | undefined;
580
+ file?: any;
580
581
  key?: string | undefined;
581
582
  enabled?: boolean | undefined;
582
- file?: any;
583
583
  nullable?: boolean | undefined;
584
584
  }>, "many">>;
585
585
  cookies: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -620,9 +620,9 @@ export declare const requestExampleSchema: z.ZodObject<{
620
620
  description?: string | undefined;
621
621
  enum?: string[] | undefined;
622
622
  format?: string | undefined;
623
+ file?: any;
623
624
  key?: string | undefined;
624
625
  enabled?: boolean | undefined;
625
- file?: any;
626
626
  nullable?: boolean | undefined;
627
627
  }>, "many">>;
628
628
  }, "strip", z.ZodTypeAny, {
@@ -697,9 +697,9 @@ export declare const requestExampleSchema: z.ZodObject<{
697
697
  description?: string | undefined;
698
698
  enum?: string[] | undefined;
699
699
  format?: string | undefined;
700
+ file?: any;
700
701
  key?: string | undefined;
701
702
  enabled?: boolean | undefined;
702
- file?: any;
703
703
  nullable?: boolean | undefined;
704
704
  }[] | undefined;
705
705
  cookies?: {
@@ -712,9 +712,9 @@ export declare const requestExampleSchema: z.ZodObject<{
712
712
  description?: string | undefined;
713
713
  enum?: string[] | undefined;
714
714
  format?: string | undefined;
715
+ file?: any;
715
716
  key?: string | undefined;
716
717
  enabled?: boolean | undefined;
717
- file?: any;
718
718
  nullable?: boolean | undefined;
719
719
  }[] | undefined;
720
720
  query?: {
@@ -727,9 +727,9 @@ export declare const requestExampleSchema: z.ZodObject<{
727
727
  description?: string | undefined;
728
728
  enum?: string[] | undefined;
729
729
  format?: string | undefined;
730
+ file?: any;
730
731
  key?: string | undefined;
731
732
  enabled?: boolean | undefined;
732
- file?: any;
733
733
  nullable?: boolean | undefined;
734
734
  }[] | undefined;
735
735
  headers?: {
@@ -742,9 +742,9 @@ export declare const requestExampleSchema: z.ZodObject<{
742
742
  description?: string | undefined;
743
743
  enum?: string[] | undefined;
744
744
  format?: string | undefined;
745
+ file?: any;
745
746
  key?: string | undefined;
746
747
  enabled?: boolean | undefined;
747
- file?: any;
748
748
  nullable?: boolean | undefined;
749
749
  }[] | undefined;
750
750
  }>>>;
@@ -754,33 +754,6 @@ export declare const requestExampleSchema: z.ZodObject<{
754
754
  type: "requestExample";
755
755
  uid: string;
756
756
  name: string;
757
- body: {
758
- activeBody: "formData" | "binary" | "raw";
759
- formData?: {
760
- value: {
761
- value: string;
762
- key: string;
763
- enabled: boolean;
764
- minimum?: number | undefined;
765
- type?: string | undefined;
766
- maximum?: number | undefined;
767
- default?: any;
768
- required?: boolean | undefined;
769
- description?: string | undefined;
770
- enum?: string[] | undefined;
771
- format?: string | undefined;
772
- file?: any;
773
- nullable?: boolean | undefined;
774
- }[];
775
- encoding: "form-data" | "urlencoded";
776
- } | undefined;
777
- binary?: Blob | undefined;
778
- raw?: {
779
- value: string;
780
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
781
- } | undefined;
782
- };
783
- requestUid: string;
784
757
  parameters: {
785
758
  path: {
786
759
  value: string;
@@ -843,38 +816,38 @@ export declare const requestExampleSchema: z.ZodObject<{
843
816
  nullable?: boolean | undefined;
844
817
  }[];
845
818
  };
846
- serverVariables?: Record<string, string[]> | undefined;
847
- }, {
848
- type?: "requestExample" | undefined;
849
- uid?: string | undefined;
850
- name?: string | undefined;
851
- body?: {
819
+ body: {
820
+ activeBody: "binary" | "formData" | "raw";
821
+ binary?: Blob | undefined;
852
822
  formData?: {
853
- value?: {
823
+ value: {
824
+ value: string;
825
+ key: string;
826
+ enabled: boolean;
854
827
  minimum?: number | undefined;
855
828
  type?: string | undefined;
856
829
  maximum?: number | undefined;
857
- value?: string | undefined;
858
830
  default?: any;
859
831
  required?: boolean | undefined;
860
832
  description?: string | undefined;
861
833
  enum?: string[] | undefined;
862
834
  format?: string | undefined;
863
- key?: string | undefined;
864
- enabled?: boolean | undefined;
865
835
  file?: any;
866
836
  nullable?: boolean | undefined;
867
- }[] | undefined;
868
- encoding?: "form-data" | "urlencoded" | undefined;
837
+ }[];
838
+ encoding: "form-data" | "urlencoded";
869
839
  } | undefined;
870
- binary?: Blob | undefined;
871
840
  raw?: {
872
- value?: string | undefined;
873
- encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
841
+ value: string;
842
+ encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
874
843
  } | undefined;
875
- activeBody?: "formData" | "binary" | "raw" | undefined;
876
- } | undefined;
877
- requestUid?: string | undefined;
844
+ };
845
+ requestUid: string;
846
+ serverVariables?: Record<string, string[]> | undefined;
847
+ }, {
848
+ type?: "requestExample" | undefined;
849
+ uid?: string | undefined;
850
+ name?: string | undefined;
878
851
  parameters?: {
879
852
  path?: {
880
853
  minimum?: number | undefined;
@@ -886,9 +859,9 @@ export declare const requestExampleSchema: z.ZodObject<{
886
859
  description?: string | undefined;
887
860
  enum?: string[] | undefined;
888
861
  format?: string | undefined;
862
+ file?: any;
889
863
  key?: string | undefined;
890
864
  enabled?: boolean | undefined;
891
- file?: any;
892
865
  nullable?: boolean | undefined;
893
866
  }[] | undefined;
894
867
  cookies?: {
@@ -901,9 +874,9 @@ export declare const requestExampleSchema: z.ZodObject<{
901
874
  description?: string | undefined;
902
875
  enum?: string[] | undefined;
903
876
  format?: string | undefined;
877
+ file?: any;
904
878
  key?: string | undefined;
905
879
  enabled?: boolean | undefined;
906
- file?: any;
907
880
  nullable?: boolean | undefined;
908
881
  }[] | undefined;
909
882
  query?: {
@@ -916,9 +889,9 @@ export declare const requestExampleSchema: z.ZodObject<{
916
889
  description?: string | undefined;
917
890
  enum?: string[] | undefined;
918
891
  format?: string | undefined;
892
+ file?: any;
919
893
  key?: string | undefined;
920
894
  enabled?: boolean | undefined;
921
- file?: any;
922
895
  nullable?: boolean | undefined;
923
896
  }[] | undefined;
924
897
  headers?: {
@@ -931,12 +904,39 @@ export declare const requestExampleSchema: z.ZodObject<{
931
904
  description?: string | undefined;
932
905
  enum?: string[] | undefined;
933
906
  format?: string | undefined;
907
+ file?: any;
934
908
  key?: string | undefined;
935
909
  enabled?: boolean | undefined;
936
- file?: any;
937
910
  nullable?: boolean | undefined;
938
911
  }[] | undefined;
939
912
  } | undefined;
913
+ body?: {
914
+ binary?: Blob | undefined;
915
+ formData?: {
916
+ value?: {
917
+ minimum?: number | undefined;
918
+ type?: string | undefined;
919
+ maximum?: number | undefined;
920
+ value?: string | undefined;
921
+ default?: any;
922
+ required?: boolean | undefined;
923
+ description?: string | undefined;
924
+ enum?: string[] | undefined;
925
+ format?: string | undefined;
926
+ file?: any;
927
+ key?: string | undefined;
928
+ enabled?: boolean | undefined;
929
+ nullable?: boolean | undefined;
930
+ }[] | undefined;
931
+ encoding?: "form-data" | "urlencoded" | undefined;
932
+ } | undefined;
933
+ raw?: {
934
+ value?: string | undefined;
935
+ encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
936
+ } | undefined;
937
+ activeBody?: "binary" | "formData" | "raw" | undefined;
938
+ } | undefined;
939
+ requestUid?: string | undefined;
940
940
  serverVariables?: Record<string, string[]> | undefined;
941
941
  }>;
942
942
  export type RequestExample = z.infer<typeof requestExampleSchema>;
@@ -965,18 +965,18 @@ export declare const xScalarExampleSchema: z.ZodObject<{
965
965
  }>>>;
966
966
  }, "strip", z.ZodTypeAny, {
967
967
  content: string | Record<string, any>;
968
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
968
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
969
969
  file?: {
970
970
  url: string;
971
971
  base64?: string | undefined;
972
972
  } | null | undefined;
973
973
  }, {
974
974
  content: string | Record<string, any>;
975
+ encoding?: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary" | undefined;
975
976
  file?: {
976
977
  url: string;
977
978
  base64?: string | undefined;
978
979
  } | null | undefined;
979
- encoding?: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary" | undefined;
980
980
  }>>;
981
981
  parameters: z.ZodObject<{
982
982
  path: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
@@ -1004,7 +1004,7 @@ export declare const xScalarExampleSchema: z.ZodObject<{
1004
1004
  name?: string | undefined;
1005
1005
  body?: {
1006
1006
  content: string | Record<string, any>;
1007
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
1007
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
1008
1008
  file?: {
1009
1009
  url: string;
1010
1010
  base64?: string | undefined;
@@ -1020,11 +1020,11 @@ export declare const xScalarExampleSchema: z.ZodObject<{
1020
1020
  name?: string | undefined;
1021
1021
  body?: {
1022
1022
  content: string | Record<string, any>;
1023
+ encoding?: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary" | undefined;
1023
1024
  file?: {
1024
1025
  url: string;
1025
1026
  base64?: string | undefined;
1026
1027
  } | null | undefined;
1027
- encoding?: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary" | undefined;
1028
1028
  } | undefined;
1029
1029
  }>;
1030
1030
  export type XScalarExample = z.infer<typeof xScalarExampleSchema>;
@@ -1043,7 +1043,7 @@ export declare function convertExampleToXScalar(example: RequestExample): {
1043
1043
  name?: string | undefined;
1044
1044
  body?: {
1045
1045
  content: string | Record<string, any>;
1046
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
1046
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
1047
1047
  file?: {
1048
1048
  url: string;
1049
1049
  base64?: string | undefined;
package/dist/entities/spec/requests.d.ts CHANGED
@@ -147,18 +147,18 @@ export declare const oasRequestSchema: z.ZodObject<{
147
147
  }>>>;
148
148
  }, "strip", z.ZodTypeAny, {
149
149
  content: string | Record<string, any>;
150
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
150
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
151
151
  file?: {
152
152
  url: string;
153
153
  base64?: string | undefined;
154
154
  } | null | undefined;
155
155
  }, {
156
156
  content: string | Record<string, any>;
157
+ encoding?: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary" | undefined;
157
158
  file?: {
158
159
  url: string;
159
160
  base64?: string | undefined;
160
161
  } | null | undefined;
161
- encoding?: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary" | undefined;
162
162
  }>>;
163
163
  parameters: z.ZodObject<{
164
164
  path: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
@@ -186,7 +186,7 @@ export declare const oasRequestSchema: z.ZodObject<{
186
186
  name?: string | undefined;
187
187
  body?: {
188
188
  content: string | Record<string, any>;
189
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
189
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
190
190
  file?: {
191
191
  url: string;
192
192
  base64?: string | undefined;
@@ -202,13 +202,16 @@ export declare const oasRequestSchema: z.ZodObject<{
202
202
  name?: string | undefined;
203
203
  body?: {
204
204
  content: string | Record<string, any>;
205
+ encoding?: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary" | undefined;
205
206
  file?: {
206
207
  url: string;
207
208
  base64?: string | undefined;
208
209
  } | null | undefined;
209
- encoding?: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary" | undefined;
210
210
  } | undefined;
211
211
  }>>>;
212
+ /** Hide operations */
213
+ 'x-internal': z.ZodOptional<z.ZodBoolean>;
214
+ 'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
212
215
  }, "strip", z.ZodTypeAny, {
213
216
  description?: string | undefined;
214
217
  summary?: string | undefined;
@@ -216,6 +219,8 @@ export declare const oasRequestSchema: z.ZodObject<{
216
219
  url: string;
217
220
  description?: string | undefined;
218
221
  } | undefined;
222
+ 'x-internal'?: boolean | undefined;
223
+ 'x-scalar-ignore'?: boolean | undefined;
219
224
  security?: Record<string, string[]>[] | undefined;
220
225
  tags?: string[] | undefined;
221
226
  deprecated?: boolean | undefined;
@@ -247,7 +252,7 @@ export declare const oasRequestSchema: z.ZodObject<{
247
252
  name?: string | undefined;
248
253
  body?: {
249
254
  content: string | Record<string, any>;
250
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
255
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
251
256
  file?: {
252
257
  url: string;
253
258
  base64?: string | undefined;
@@ -261,6 +266,8 @@ export declare const oasRequestSchema: z.ZodObject<{
261
266
  description?: string | undefined;
262
267
  url?: string | undefined;
263
268
  } | undefined;
269
+ 'x-internal'?: boolean | undefined;
270
+ 'x-scalar-ignore'?: boolean | undefined;
264
271
  security?: Record<string, string[] | undefined>[] | undefined;
265
272
  tags?: string[] | undefined;
266
273
  deprecated?: boolean | undefined;
@@ -292,11 +299,11 @@ export declare const oasRequestSchema: z.ZodObject<{
292
299
  name?: string | undefined;
293
300
  body?: {
294
301
  content: string | Record<string, any>;
302
+ encoding?: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary" | undefined;
295
303
  file?: {
296
304
  url: string;
297
305
  base64?: string | undefined;
298
306
  } | null | undefined;
299
- encoding?: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary" | undefined;
300
307
  } | undefined;
301
308
  }> | undefined;
302
309
  }>;
@@ -420,18 +427,18 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
420
427
  }>>>;
421
428
  }, "strip", z.ZodTypeAny, {
422
429
  content: string | Record<string, any>;
423
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
430
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
424
431
  file?: {
425
432
  url: string;
426
433
  base64?: string | undefined;
427
434
  } | null | undefined;
428
435
  }, {
429
436
  content: string | Record<string, any>;
437
+ encoding?: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary" | undefined;
430
438
  file?: {
431
439
  url: string;
432
440
  base64?: string | undefined;
433
441
  } | null | undefined;
434
- encoding?: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary" | undefined;
435
442
  }>>;
436
443
  parameters: z.ZodObject<{
437
444
  path: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
@@ -459,7 +466,7 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
459
466
  name?: string | undefined;
460
467
  body?: {
461
468
  content: string | Record<string, any>;
462
- encoding: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary";
469
+ encoding: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary";
463
470
  file?: {
464
471
  url: string;
465
472
  base64?: string | undefined;
@@ -475,13 +482,16 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
475
482
  name?: string | undefined;
476
483
  body?: {
477
484
  content: string | Record<string, any>;
485
+ encoding?: "application/json" | "text/plain" | "text/html" | "application/javascript" | "application/xml" | "application/yaml" | "application/edn" | "application/octet-stream" | "application/x-www-form-urlencoded" | "multipart/form-data" | "binary" | undefined;
478
486
  file?: {
479
487
  url: string;
480
488
  base64?: string | undefined;
481
489
  } | null | undefined;
482
- encoding?: "application/json" | "application/octet-stream" | "application/x-www-form-urlencoded" | "application/xml" | "multipart/form-data" | "text/plain" | "text/html" | "application/javascript" | "application/yaml" | "application/edn" | "binary" | undefined;
483
490
  } | undefined;
484
491
  }>>>;
492
+ /** Hide operations */
493
+ 'x-internal': z.ZodOptional<z.ZodBoolean>;
494
+ 'x-scalar-ignore': z.ZodOptional<z.ZodBoolean>;
485
495
  }, "x-scalar-examples">, {
486
496
  type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"request">>>;
487
497
  uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
@@ -512,6 +522,8 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
512
522
  url: string;
513
523
  description?: string | undefined;
514
524
  } | undefined;
525
+ 'x-internal'?: boolean | undefined;
526
+ 'x-scalar-ignore'?: boolean | undefined;
515
527
  security?: Record<string, string[]>[] | undefined;
516
528
  tags?: string[] | undefined;
517
529
  deprecated?: boolean | undefined;
@@ -543,6 +555,8 @@ export declare const requestSchema: z.ZodObject<z.objectUtil.extendShape<Omit<{
543
555
  description?: string | undefined;
544
556
  url?: string | undefined;
545
557
  } | undefined;
558
+ 'x-internal'?: boolean | undefined;
559
+ 'x-scalar-ignore'?: boolean | undefined;
546
560
  security?: Record<string, string[] | undefined>[] | undefined;
547
561
  selectedSecuritySchemeUids?: (string | undefined)[] | undefined;
548
562
  selectedServerUid?: string | undefined;
package/dist/entities/spec/requests.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvC,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAI9E,eAAO,MAAM,cAAc,2FAUjB,CAAA;AAEV,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE0B,CAAA;AA0BnD,8CAA8C;AAC9C,eAAO,MAAM,aAAa;IAxExB;;;;;OAKG;;IAEH,kDAAkD;;IAElD,mHAAmH;;IAEnH;;;;OAIG;;IAEH;;;;;;OAMG;;IAEH;;;;;OAKG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAcvB,eAAe;;IAEf,qBAAqB;;IAErB,kDAAkD;;IAElD,oCAAoC;;IAEpC,uDAAuD;;IAEvD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOlC,CAAA;AAE/B,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"}
1
+ {"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvC,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAI9E,eAAO,MAAM,cAAc,2FAUjB,CAAA;AAEV,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAOlC,CAAA;AAE/B,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"}