@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.
Files changed (96) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/dist/entities/cookie/cookie.d.ts +2 -2
  3. package/dist/entities/cookie/cookie.js +1 -1
  4. package/dist/entities/environment/environment.d.ts +2 -2
  5. package/dist/entities/environment/environment.js +1 -1
  6. package/dist/entities/shared/utility.d.ts +13 -1
  7. package/dist/entities/shared/utility.d.ts.map +1 -1
  8. package/dist/entities/shared/utility.js +4 -1
  9. package/dist/entities/spec/collection.d.ts +199 -155
  10. package/dist/entities/spec/collection.d.ts.map +1 -1
  11. package/dist/entities/spec/collection.js +15 -17
  12. package/dist/entities/spec/index.js +1 -1
  13. package/dist/entities/spec/operation.d.ts +34 -28
  14. package/dist/entities/spec/operation.d.ts.map +1 -1
  15. package/dist/entities/spec/parameters.d.ts +4 -4
  16. package/dist/entities/spec/request-examples.d.ts +5 -5
  17. package/dist/entities/spec/request-examples.d.ts.map +1 -1
  18. package/dist/entities/spec/request-examples.js +37 -71
  19. package/dist/entities/spec/requests.d.ts +54 -42
  20. package/dist/entities/spec/requests.d.ts.map +1 -1
  21. package/dist/entities/spec/requests.js +6 -18
  22. package/dist/entities/spec/security.d.ts +22 -22
  23. package/dist/entities/spec/security.d.ts.map +1 -1
  24. package/dist/entities/spec/security.js +7 -22
  25. package/dist/entities/spec/server.d.ts +2 -2
  26. package/dist/entities/spec/server.d.ts.map +1 -1
  27. package/dist/entities/spec/server.js +3 -5
  28. package/dist/entities/spec/spec-objects.d.ts +150 -78
  29. package/dist/entities/spec/spec-objects.d.ts.map +1 -1
  30. package/dist/entities/spec/spec-objects.js +68 -45
  31. package/dist/entities/spec/x-scalar-secrets.d.ts +4 -4
  32. package/dist/entities/spec/x-scalar-secrets.d.ts.map +1 -1
  33. package/dist/entities/workspace/workspace.d.ts +7 -7
  34. package/dist/entities/workspace/workspace.d.ts.map +1 -1
  35. package/dist/entities/workspace/workspace.js +5 -5
  36. package/dist/helpers/fetchSpecFromUrl.d.ts.map +1 -1
  37. package/dist/helpers/fetchSpecFromUrl.js +1 -1
  38. package/dist/helpers/fetchWithProxyFallback.d.ts.map +1 -1
  39. package/dist/helpers/findVariables.d.ts.map +1 -1
  40. package/dist/helpers/findVariables.js +1 -1
  41. package/dist/helpers/httpMethods.d.ts.map +1 -1
  42. package/dist/helpers/is-defined.d.ts.map +1 -1
  43. package/dist/helpers/iterateTitle.d.ts.map +1 -1
  44. package/dist/helpers/json2xml.d.ts.map +1 -1
  45. package/dist/helpers/json2xml.js +3 -7
  46. package/dist/helpers/makeUrlAbsolute.d.ts.map +1 -1
  47. package/dist/helpers/makeUrlAbsolute.js +1 -4
  48. package/dist/helpers/merge-urls.d.ts.map +1 -1
  49. package/dist/helpers/normalizeMimeTypeObject.d.ts +1 -0
  50. package/dist/helpers/normalizeMimeTypeObject.d.ts.map +1 -1
  51. package/dist/helpers/object.d.ts.map +1 -1
  52. package/dist/helpers/parse.d.ts.map +1 -1
  53. package/dist/helpers/prettyPrintJson.d.ts.map +1 -1
  54. package/dist/helpers/replaceVariables.d.ts.map +1 -1
  55. package/dist/helpers/replaceVariables.js +1 -3
  56. package/dist/helpers/ssrState.d.ts.map +1 -1
  57. package/dist/helpers/ssrState.js +1 -3
  58. package/dist/migrations/local-storage.d.ts.map +1 -1
  59. package/dist/migrations/migrator.d.ts +1 -1
  60. package/dist/migrations/migrator.d.ts.map +1 -1
  61. package/dist/migrations/semver.d.ts.map +1 -1
  62. package/dist/migrations/semver.js +1 -3
  63. package/dist/migrations/v-0.0.0/types.generated.d.ts.map +1 -1
  64. package/dist/migrations/v-2.1.0/migration.d.ts.map +1 -1
  65. package/dist/migrations/v-2.1.0/migration.js +1 -4
  66. package/dist/migrations/v-2.1.0/types.generated.d.ts.map +1 -1
  67. package/dist/migrations/v-2.2.0/migration.d.ts.map +1 -1
  68. package/dist/migrations/v-2.2.0/migration.js +2 -4
  69. package/dist/migrations/v-2.2.0/types.generated.d.ts.map +1 -1
  70. package/dist/migrations/v-2.3.0/migration.d.ts.map +1 -1
  71. package/dist/migrations/v-2.3.0/migration.js +3 -8
  72. package/dist/migrations/v-2.3.0/types.generated.d.ts.map +1 -1
  73. package/dist/migrations/v-2.4.0/migration.d.ts.map +1 -1
  74. package/dist/migrations/v-2.4.0/types.generated.d.ts.map +1 -1
  75. package/dist/migrations/v-2.5.0/migration.d.ts +1 -1
  76. package/dist/migrations/v-2.5.0/migration.d.ts.map +1 -1
  77. package/dist/migrations/v-2.5.0/migration.js +70 -3
  78. package/dist/migrations/v-2.5.0/types.generated.d.ts +17 -17
  79. package/dist/migrations/v-2.5.0/types.generated.d.ts.map +1 -1
  80. package/dist/spec-getters/getExampleFromSchema.d.ts.map +1 -1
  81. package/dist/spec-getters/getExampleFromSchema.js +8 -22
  82. package/dist/spec-getters/getParametersFromOperation.d.ts.map +1 -1
  83. package/dist/spec-getters/getParametersFromOperation.js +1 -4
  84. package/dist/spec-getters/getRequestBodyFromOperation.d.ts.map +1 -1
  85. package/dist/spec-getters/getRequestBodyFromOperation.js +4 -9
  86. package/dist/spec-getters/getServerVariableExamples.js +3 -1
  87. package/dist/transforms/import-spec.d.ts +2 -1
  88. package/dist/transforms/import-spec.d.ts.map +1 -1
  89. package/dist/transforms/import-spec.js +13 -35
  90. package/dist/transforms/index.d.ts +0 -1
  91. package/dist/transforms/index.d.ts.map +1 -1
  92. package/dist/transforms/index.js +0 -1
  93. package/package.json +7 -7
  94. package/dist/transforms/export-spec.d.ts +0 -17
  95. package/dist/transforms/export-spec.d.ts.map +0 -1
  96. package/dist/transforms/export-spec.js +0 -73
@@ -8,38 +8,54 @@ export declare const oasCollectionSchema: z.ZodObject<{
8
8
  type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"collection">>>;
9
9
  openapi: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<"3.0.0">, z.ZodLiteral<"3.1.0">, z.ZodLiteral<"4.0.0">]>>>;
10
10
  jsonSchemaDialect: z.ZodOptional<z.ZodString>;
11
- info: z.ZodOptional<z.ZodObject<{
12
- title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
13
- summary: z.ZodOptional<z.ZodString>;
14
- description: z.ZodOptional<z.ZodString>;
15
- termsOfService: z.ZodOptional<z.ZodString>;
16
- contact: z.ZodOptional<z.ZodObject<{
11
+ info: z.ZodCatch<z.ZodEffects<z.ZodObject<{
12
+ title: z.ZodCatch<z.ZodString>;
13
+ summary: z.ZodCatch<z.ZodOptional<z.ZodString>>;
14
+ description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
15
+ termsOfService: z.ZodCatch<z.ZodOptional<z.ZodString>>;
16
+ contact: z.ZodCatch<z.ZodOptional<z.ZodEffects<z.ZodObject<{
17
17
  name: z.ZodOptional<z.ZodString>;
18
- url: z.ZodOptional<z.ZodString>;
19
- email: z.ZodOptional<z.ZodString>;
18
+ url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
19
+ email: z.ZodCatch<z.ZodOptional<z.ZodString>>;
20
20
  }, "strip", z.ZodTypeAny, {
21
21
  name?: string | undefined;
22
22
  url?: string | undefined;
23
23
  email?: string | undefined;
24
24
  }, {
25
+ name?: string | undefined;
26
+ url?: unknown;
27
+ email?: unknown;
28
+ }>, {
25
29
  name?: string | undefined;
26
30
  url?: string | undefined;
27
31
  email?: string | undefined;
28
- }>>;
29
- license: z.ZodOptional<z.ZodObject<{
30
- name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
31
- identifier: z.ZodOptional<z.ZodString>;
32
- url: z.ZodOptional<z.ZodString>;
32
+ }, {
33
+ name?: string | undefined;
34
+ url?: unknown;
35
+ email?: unknown;
36
+ }>>>;
37
+ license: z.ZodCatch<z.ZodOptional<z.ZodEffects<z.ZodObject<{
38
+ name: z.ZodCatch<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
39
+ identifier: z.ZodCatch<z.ZodOptional<z.ZodString>>;
40
+ url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
33
41
  }, "strip", z.ZodTypeAny, {
34
- name: string;
42
+ name?: string | null | undefined;
35
43
  identifier?: string | undefined;
36
44
  url?: string | undefined;
37
45
  }, {
38
- name?: string | undefined;
46
+ name?: unknown;
47
+ identifier?: unknown;
48
+ url?: unknown;
49
+ }>, {
50
+ name?: string | null | undefined;
39
51
  identifier?: string | undefined;
40
52
  url?: string | undefined;
41
- }>>;
42
- version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
53
+ }, {
54
+ name?: unknown;
55
+ identifier?: unknown;
56
+ url?: unknown;
57
+ }>>>;
58
+ version: z.ZodCatch<z.ZodString>;
43
59
  }, "strip", z.ZodTypeAny, {
44
60
  title: string;
45
61
  version: string;
@@ -52,13 +68,22 @@ export declare const oasCollectionSchema: z.ZodObject<{
52
68
  email?: string | undefined;
53
69
  } | undefined;
54
70
  license?: {
55
- name: string;
71
+ name?: string | null | undefined;
56
72
  identifier?: string | undefined;
57
73
  url?: string | undefined;
58
74
  } | undefined;
59
75
  }, {
76
+ description?: unknown;
77
+ title?: unknown;
78
+ summary?: unknown;
79
+ termsOfService?: unknown;
80
+ contact?: unknown;
81
+ license?: unknown;
82
+ version?: unknown;
83
+ }>, {
84
+ title: string;
85
+ version: string;
60
86
  description?: string | undefined;
61
- title?: string | undefined;
62
87
  summary?: string | undefined;
63
88
  termsOfService?: string | undefined;
64
89
  contact?: {
@@ -67,11 +92,18 @@ export declare const oasCollectionSchema: z.ZodObject<{
67
92
  email?: string | undefined;
68
93
  } | undefined;
69
94
  license?: {
70
- name?: string | undefined;
95
+ name?: string | null | undefined;
71
96
  identifier?: string | undefined;
72
97
  url?: string | undefined;
73
98
  } | undefined;
74
- version?: string | undefined;
99
+ }, {
100
+ description?: unknown;
101
+ title?: unknown;
102
+ summary?: unknown;
103
+ termsOfService?: unknown;
104
+ contact?: unknown;
105
+ license?: unknown;
106
+ version?: unknown;
75
107
  }>>;
76
108
  /**
77
109
  * A declaration of which security mechanisms can be used across the API. The list of
@@ -81,15 +113,21 @@ export declare const oasCollectionSchema: z.ZodObject<{
81
113
  * security requirement ({}) can be included in the array.
82
114
  */
83
115
  security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>>;
84
- externalDocs: z.ZodOptional<z.ZodObject<{
85
- description: z.ZodOptional<z.ZodString>;
86
- url: z.ZodDefault<z.ZodString>;
116
+ externalDocs: z.ZodOptional<z.ZodEffects<z.ZodObject<{
117
+ description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
118
+ url: z.ZodString;
87
119
  }, "strip", z.ZodTypeAny, {
88
120
  url: string;
89
121
  description?: string | undefined;
90
122
  }, {
123
+ url: string;
124
+ description?: unknown;
125
+ }>, {
126
+ url: string;
91
127
  description?: string | undefined;
92
- url?: string | undefined;
128
+ }, {
129
+ url: string;
130
+ description?: unknown;
93
131
  }>>;
94
132
  /** TODO: Type these */
95
133
  components: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -130,23 +168,16 @@ export declare const oasCollectionSchema: z.ZodObject<{
130
168
  description: z.ZodOptional<z.ZodString>;
131
169
  example: z.ZodOptional<z.ZodString>;
132
170
  }, "strip", z.ZodTypeAny, {
133
- description?: string | undefined;
134
171
  example?: string | undefined;
135
- }, {
136
172
  description?: string | undefined;
173
+ }, {
137
174
  example?: string | undefined;
175
+ description?: string | undefined;
138
176
  }>>>;
139
177
  }, "strip", z.ZodTypeAny, {
140
178
  type: "collection";
141
179
  openapi: string;
142
- security: Record<string, string[]>[];
143
- 'x-scalar-icon': string;
144
- externalDocs?: {
145
- url: string;
146
- description?: string | undefined;
147
- } | undefined;
148
- jsonSchemaDialect?: string | undefined;
149
- info?: {
180
+ info: {
150
181
  title: string;
151
182
  version: string;
152
183
  description?: string | undefined;
@@ -158,11 +189,18 @@ export declare const oasCollectionSchema: z.ZodObject<{
158
189
  email?: string | undefined;
159
190
  } | undefined;
160
191
  license?: {
161
- name: string;
192
+ name?: string | null | undefined;
162
193
  identifier?: string | undefined;
163
194
  url?: string | undefined;
164
195
  } | undefined;
196
+ };
197
+ security: Record<string, string[]>[];
198
+ 'x-scalar-icon': string;
199
+ externalDocs?: {
200
+ url: string;
201
+ description?: string | undefined;
165
202
  } | undefined;
203
+ jsonSchemaDialect?: string | undefined;
166
204
  components?: Record<string, unknown> | undefined;
167
205
  webhooks?: Record<string, unknown> | undefined;
168
206
  'x-scalar-active-environment'?: string | undefined;
@@ -175,34 +213,18 @@ export declare const oasCollectionSchema: z.ZodObject<{
175
213
  color?: string | undefined;
176
214
  }> | undefined;
177
215
  'x-scalar-secrets'?: Record<string, {
178
- description?: string | undefined;
179
216
  example?: string | undefined;
217
+ description?: string | undefined;
180
218
  }> | undefined;
181
219
  }, {
182
220
  type?: "collection" | undefined;
183
221
  externalDocs?: {
184
- description?: string | undefined;
185
- url?: string | undefined;
222
+ url: string;
223
+ description?: unknown;
186
224
  } | undefined;
187
225
  openapi?: string | undefined;
188
226
  jsonSchemaDialect?: string | undefined;
189
- info?: {
190
- description?: string | undefined;
191
- title?: string | undefined;
192
- summary?: string | undefined;
193
- termsOfService?: string | undefined;
194
- contact?: {
195
- name?: string | undefined;
196
- url?: string | undefined;
197
- email?: string | undefined;
198
- } | undefined;
199
- license?: {
200
- name?: string | undefined;
201
- identifier?: string | undefined;
202
- url?: string | undefined;
203
- } | undefined;
204
- version?: string | undefined;
205
- } | undefined;
227
+ info?: unknown;
206
228
  security?: Record<string, string[] | undefined>[] | undefined;
207
229
  components?: Record<string, unknown> | undefined;
208
230
  webhooks?: Record<string, unknown> | undefined;
@@ -217,26 +239,26 @@ export declare const oasCollectionSchema: z.ZodObject<{
217
239
  color?: string | undefined;
218
240
  }> | undefined;
219
241
  'x-scalar-secrets'?: Record<string, {
220
- description?: string | undefined;
221
242
  example?: string | undefined;
243
+ description?: string | undefined;
222
244
  }> | undefined;
223
245
  }>;
224
246
  export declare const extendedCollectionSchema: z.ZodObject<{
225
- uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
247
+ uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "collection">;
226
248
  /** A list of security schemes UIDs associated with the collection */
227
249
  securitySchemes: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
228
250
  /** List of currently selected security scheme UIDs, these can be overridden per request */
229
- selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodDefault<z.ZodOptional<z.ZodString>>, z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">]>, "many">>;
251
+ selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodBranded<z.ZodString, "securityScheme">, z.ZodArray<z.ZodBranded<z.ZodString, "securityScheme">, "many">]>, "many">>;
230
252
  /** The currently selected server */
231
- selectedServerUid: z.ZodDefault<z.ZodString>;
253
+ selectedServerUid: z.ZodOptional<z.ZodBranded<z.ZodString, "server">>;
232
254
  /** UIDs which refer to servers on the workspace base */
233
- servers: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
255
+ servers: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "server">, "many">>;
234
256
  /** Request UIDs associated with a collection */
235
- requests: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
257
+ requests: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "operation">, "many">>;
236
258
  /** Tag UIDs associated with the collection */
237
- tags: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
259
+ tags: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "tag">, "many">>;
238
260
  /** List of requests without tags and top level tag "folders" */
239
- children: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
261
+ children: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodBranded<z.ZodString, "operation">, z.ZodBranded<z.ZodString, "tag">]>, "many">>;
240
262
  /**
241
263
  * A link to where this document is stored
242
264
  *
@@ -259,27 +281,27 @@ export declare const extendedCollectionSchema: z.ZodObject<{
259
281
  */
260
282
  watchModeStatus: z.ZodDefault<z.ZodOptional<z.ZodEnum<["IDLE", "WATCHING", "ERROR"]>>>;
261
283
  }, "strip", z.ZodTypeAny, {
262
- uid: string;
263
- children: string[];
284
+ uid: string & z.BRAND<"collection">;
285
+ children: ((string & z.BRAND<"tag">) | (string & z.BRAND<"operation">))[];
264
286
  securitySchemes: string[];
265
- selectedSecuritySchemeUids: (string | string[])[];
266
- selectedServerUid: string;
267
- servers: string[];
268
- requests: string[];
269
- tags: string[];
287
+ selectedSecuritySchemeUids: ((string & z.BRAND<"securityScheme">) | (string & z.BRAND<"securityScheme">)[])[];
288
+ servers: (string & z.BRAND<"server">)[];
289
+ requests: (string & z.BRAND<"operation">)[];
290
+ tags: (string & z.BRAND<"tag">)[];
270
291
  watchMode: boolean;
271
292
  watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
293
+ selectedServerUid?: (string & z.BRAND<"server">) | undefined;
272
294
  documentUrl?: string | undefined;
273
295
  integration?: string | null | undefined;
274
296
  }, {
275
297
  uid?: string | undefined;
276
- children?: (string | undefined)[] | undefined;
298
+ children?: string[] | undefined;
277
299
  securitySchemes?: string[] | undefined;
278
- selectedSecuritySchemeUids?: (string | (string | undefined)[] | undefined)[] | undefined;
300
+ selectedSecuritySchemeUids?: (string | string[])[] | undefined;
279
301
  selectedServerUid?: string | undefined;
280
- servers?: (string | undefined)[] | undefined;
281
- requests?: (string | undefined)[] | undefined;
282
- tags?: (string | undefined)[] | undefined;
302
+ servers?: string[] | undefined;
303
+ requests?: string[] | undefined;
304
+ tags?: string[] | undefined;
283
305
  documentUrl?: string | undefined;
284
306
  watchMode?: boolean | undefined;
285
307
  integration?: string | null | undefined;
@@ -294,38 +316,54 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
294
316
  type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"collection">>>;
295
317
  openapi: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodLiteral<"3.0.0">, z.ZodLiteral<"3.1.0">, z.ZodLiteral<"4.0.0">]>>>;
296
318
  jsonSchemaDialect: z.ZodOptional<z.ZodString>;
297
- info: z.ZodOptional<z.ZodObject<{
298
- title: z.ZodDefault<z.ZodOptional<z.ZodString>>;
299
- summary: z.ZodOptional<z.ZodString>;
300
- description: z.ZodOptional<z.ZodString>;
301
- termsOfService: z.ZodOptional<z.ZodString>;
302
- contact: z.ZodOptional<z.ZodObject<{
319
+ info: z.ZodCatch<z.ZodEffects<z.ZodObject<{
320
+ title: z.ZodCatch<z.ZodString>;
321
+ summary: z.ZodCatch<z.ZodOptional<z.ZodString>>;
322
+ description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
323
+ termsOfService: z.ZodCatch<z.ZodOptional<z.ZodString>>;
324
+ contact: z.ZodCatch<z.ZodOptional<z.ZodEffects<z.ZodObject<{
303
325
  name: z.ZodOptional<z.ZodString>;
304
- url: z.ZodOptional<z.ZodString>;
305
- email: z.ZodOptional<z.ZodString>;
326
+ url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
327
+ email: z.ZodCatch<z.ZodOptional<z.ZodString>>;
306
328
  }, "strip", z.ZodTypeAny, {
307
329
  name?: string | undefined;
308
330
  url?: string | undefined;
309
331
  email?: string | undefined;
310
332
  }, {
333
+ name?: string | undefined;
334
+ url?: unknown;
335
+ email?: unknown;
336
+ }>, {
311
337
  name?: string | undefined;
312
338
  url?: string | undefined;
313
339
  email?: string | undefined;
314
- }>>;
315
- license: z.ZodOptional<z.ZodObject<{
316
- name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
317
- identifier: z.ZodOptional<z.ZodString>;
318
- url: z.ZodOptional<z.ZodString>;
340
+ }, {
341
+ name?: string | undefined;
342
+ url?: unknown;
343
+ email?: unknown;
344
+ }>>>;
345
+ license: z.ZodCatch<z.ZodOptional<z.ZodEffects<z.ZodObject<{
346
+ name: z.ZodCatch<z.ZodNullable<z.ZodOptional<z.ZodString>>>;
347
+ identifier: z.ZodCatch<z.ZodOptional<z.ZodString>>;
348
+ url: z.ZodCatch<z.ZodOptional<z.ZodString>>;
319
349
  }, "strip", z.ZodTypeAny, {
320
- name: string;
350
+ name?: string | null | undefined;
321
351
  identifier?: string | undefined;
322
352
  url?: string | undefined;
323
353
  }, {
324
- name?: string | undefined;
354
+ name?: unknown;
355
+ identifier?: unknown;
356
+ url?: unknown;
357
+ }>, {
358
+ name?: string | null | undefined;
325
359
  identifier?: string | undefined;
326
360
  url?: string | undefined;
327
- }>>;
328
- version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
361
+ }, {
362
+ name?: unknown;
363
+ identifier?: unknown;
364
+ url?: unknown;
365
+ }>>>;
366
+ version: z.ZodCatch<z.ZodString>;
329
367
  }, "strip", z.ZodTypeAny, {
330
368
  title: string;
331
369
  version: string;
@@ -338,13 +376,22 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
338
376
  email?: string | undefined;
339
377
  } | undefined;
340
378
  license?: {
341
- name: string;
379
+ name?: string | null | undefined;
342
380
  identifier?: string | undefined;
343
381
  url?: string | undefined;
344
382
  } | undefined;
345
383
  }, {
384
+ description?: unknown;
385
+ title?: unknown;
386
+ summary?: unknown;
387
+ termsOfService?: unknown;
388
+ contact?: unknown;
389
+ license?: unknown;
390
+ version?: unknown;
391
+ }>, {
392
+ title: string;
393
+ version: string;
346
394
  description?: string | undefined;
347
- title?: string | undefined;
348
395
  summary?: string | undefined;
349
396
  termsOfService?: string | undefined;
350
397
  contact?: {
@@ -353,11 +400,18 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
353
400
  email?: string | undefined;
354
401
  } | undefined;
355
402
  license?: {
356
- name?: string | undefined;
403
+ name?: string | null | undefined;
357
404
  identifier?: string | undefined;
358
405
  url?: string | undefined;
359
406
  } | undefined;
360
- version?: string | undefined;
407
+ }, {
408
+ description?: unknown;
409
+ title?: unknown;
410
+ summary?: unknown;
411
+ termsOfService?: unknown;
412
+ contact?: unknown;
413
+ license?: unknown;
414
+ version?: unknown;
361
415
  }>>;
362
416
  /**
363
417
  * A declaration of which security mechanisms can be used across the API. The list of
@@ -367,15 +421,21 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
367
421
  * security requirement ({}) can be included in the array.
368
422
  */
369
423
  security: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>>, "many">>>;
370
- externalDocs: z.ZodOptional<z.ZodObject<{
371
- description: z.ZodOptional<z.ZodString>;
372
- url: z.ZodDefault<z.ZodString>;
424
+ externalDocs: z.ZodOptional<z.ZodEffects<z.ZodObject<{
425
+ description: z.ZodCatch<z.ZodOptional<z.ZodString>>;
426
+ url: z.ZodString;
373
427
  }, "strip", z.ZodTypeAny, {
374
428
  url: string;
375
429
  description?: string | undefined;
376
430
  }, {
431
+ url: string;
432
+ description?: unknown;
433
+ }>, {
434
+ url: string;
377
435
  description?: string | undefined;
378
- url?: string | undefined;
436
+ }, {
437
+ url: string;
438
+ description?: unknown;
379
439
  }>>;
380
440
  /** TODO: Type these */
381
441
  components: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -416,28 +476,28 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
416
476
  description: z.ZodOptional<z.ZodString>;
417
477
  example: z.ZodOptional<z.ZodString>;
418
478
  }, "strip", z.ZodTypeAny, {
419
- description?: string | undefined;
420
479
  example?: string | undefined;
421
- }, {
422
480
  description?: string | undefined;
481
+ }, {
423
482
  example?: string | undefined;
483
+ description?: string | undefined;
424
484
  }>>>;
425
485
  }, {
426
- uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
486
+ uid: z.ZodBranded<z.ZodDefault<z.ZodOptional<z.ZodString>>, "collection">;
427
487
  /** A list of security schemes UIDs associated with the collection */
428
488
  securitySchemes: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
429
489
  /** List of currently selected security scheme UIDs, these can be overridden per request */
430
- selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodDefault<z.ZodOptional<z.ZodString>>, z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">]>, "many">>;
490
+ selectedSecuritySchemeUids: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodBranded<z.ZodString, "securityScheme">, z.ZodArray<z.ZodBranded<z.ZodString, "securityScheme">, "many">]>, "many">>;
431
491
  /** The currently selected server */
432
- selectedServerUid: z.ZodDefault<z.ZodString>;
492
+ selectedServerUid: z.ZodOptional<z.ZodBranded<z.ZodString, "server">>;
433
493
  /** UIDs which refer to servers on the workspace base */
434
- servers: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
494
+ servers: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "server">, "many">>;
435
495
  /** Request UIDs associated with a collection */
436
- requests: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
496
+ requests: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "operation">, "many">>;
437
497
  /** Tag UIDs associated with the collection */
438
- tags: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
498
+ tags: z.ZodDefault<z.ZodArray<z.ZodBranded<z.ZodString, "tag">, "many">>;
439
499
  /** List of requests without tags and top level tag "folders" */
440
- children: z.ZodDefault<z.ZodArray<z.ZodDefault<z.ZodOptional<z.ZodString>>, "many">>;
500
+ children: z.ZodDefault<z.ZodArray<z.ZodUnion<[z.ZodBranded<z.ZodString, "operation">, z.ZodBranded<z.ZodString, "tag">]>, "many">>;
441
501
  /**
442
502
  * A link to where this document is stored
443
503
  *
@@ -461,25 +521,10 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
461
521
  watchModeStatus: z.ZodDefault<z.ZodOptional<z.ZodEnum<["IDLE", "WATCHING", "ERROR"]>>>;
462
522
  }>, "strip", z.ZodTypeAny, {
463
523
  type: "collection";
464
- uid: string;
465
- children: string[];
524
+ uid: string & z.BRAND<"collection">;
525
+ children: ((string & z.BRAND<"tag">) | (string & z.BRAND<"operation">))[];
466
526
  openapi: string;
467
- security: Record<string, string[]>[];
468
- 'x-scalar-icon': string;
469
- securitySchemes: string[];
470
- selectedSecuritySchemeUids: (string | string[])[];
471
- selectedServerUid: string;
472
- servers: string[];
473
- requests: string[];
474
- tags: string[];
475
- watchMode: boolean;
476
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
477
- externalDocs?: {
478
- url: string;
479
- description?: string | undefined;
480
- } | undefined;
481
- jsonSchemaDialect?: string | undefined;
482
- info?: {
527
+ info: {
483
528
  title: string;
484
529
  version: string;
485
530
  description?: string | undefined;
@@ -491,11 +536,25 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
491
536
  email?: string | undefined;
492
537
  } | undefined;
493
538
  license?: {
494
- name: string;
539
+ name?: string | null | undefined;
495
540
  identifier?: string | undefined;
496
541
  url?: string | undefined;
497
542
  } | undefined;
543
+ };
544
+ security: Record<string, string[]>[];
545
+ 'x-scalar-icon': string;
546
+ securitySchemes: string[];
547
+ selectedSecuritySchemeUids: ((string & z.BRAND<"securityScheme">) | (string & z.BRAND<"securityScheme">)[])[];
548
+ servers: (string & z.BRAND<"server">)[];
549
+ requests: (string & z.BRAND<"operation">)[];
550
+ tags: (string & z.BRAND<"tag">)[];
551
+ watchMode: boolean;
552
+ watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
553
+ externalDocs?: {
554
+ url: string;
555
+ description?: string | undefined;
498
556
  } | undefined;
557
+ jsonSchemaDialect?: string | undefined;
499
558
  components?: Record<string, unknown> | undefined;
500
559
  webhooks?: Record<string, unknown> | undefined;
501
560
  'x-scalar-active-environment'?: string | undefined;
@@ -508,38 +567,23 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
508
567
  color?: string | undefined;
509
568
  }> | undefined;
510
569
  'x-scalar-secrets'?: Record<string, {
511
- description?: string | undefined;
512
570
  example?: string | undefined;
571
+ description?: string | undefined;
513
572
  }> | undefined;
573
+ selectedServerUid?: (string & z.BRAND<"server">) | undefined;
514
574
  documentUrl?: string | undefined;
515
575
  integration?: string | null | undefined;
516
576
  }, {
517
577
  type?: "collection" | undefined;
518
578
  uid?: string | undefined;
519
579
  externalDocs?: {
520
- description?: string | undefined;
521
- url?: string | undefined;
580
+ url: string;
581
+ description?: unknown;
522
582
  } | undefined;
523
- children?: (string | undefined)[] | undefined;
583
+ children?: string[] | undefined;
524
584
  openapi?: string | undefined;
525
585
  jsonSchemaDialect?: string | undefined;
526
- info?: {
527
- description?: string | undefined;
528
- title?: string | undefined;
529
- summary?: string | undefined;
530
- termsOfService?: string | undefined;
531
- contact?: {
532
- name?: string | undefined;
533
- url?: string | undefined;
534
- email?: string | undefined;
535
- } | undefined;
536
- license?: {
537
- name?: string | undefined;
538
- identifier?: string | undefined;
539
- url?: string | undefined;
540
- } | undefined;
541
- version?: string | undefined;
542
- } | undefined;
586
+ info?: unknown;
543
587
  security?: Record<string, string[] | undefined>[] | undefined;
544
588
  components?: Record<string, unknown> | undefined;
545
589
  webhooks?: Record<string, unknown> | undefined;
@@ -554,15 +598,15 @@ export declare const collectionSchema: z.ZodObject<z.objectUtil.extendShape<{
554
598
  color?: string | undefined;
555
599
  }> | undefined;
556
600
  'x-scalar-secrets'?: Record<string, {
557
- description?: string | undefined;
558
601
  example?: string | undefined;
602
+ description?: string | undefined;
559
603
  }> | undefined;
560
604
  securitySchemes?: string[] | undefined;
561
- selectedSecuritySchemeUids?: (string | (string | undefined)[] | undefined)[] | undefined;
605
+ selectedSecuritySchemeUids?: (string | string[])[] | undefined;
562
606
  selectedServerUid?: string | undefined;
563
- servers?: (string | undefined)[] | undefined;
564
- requests?: (string | undefined)[] | undefined;
565
- tags?: (string | undefined)[] | undefined;
607
+ servers?: string[] | undefined;
608
+ requests?: string[] | undefined;
609
+ tags?: string[] | undefined;
566
610
  documentUrl?: string | undefined;
567
611
  watchMode?: boolean | undefined;
568
612
  integration?: string | null | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/collection.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,eAAO,MAAM,mBAAmB;IAC9B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWhD,CAAA;AAEF,eAAO,MAAM,wBAAwB;;IAEnC,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;IAEH;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKH,CAAA;AAEF,eAAO,MAAM,gBAAgB;IArF3B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAaH;;;;;;OAMG;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAehD,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAEhE;;;;;OAKG;;IAEH;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASJ,CAAA;AACD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}
1
+ {"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/collection.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,eAAO,MAAM,mBAAmB;IAC9B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAWH;;;;;;OAMG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAWhD,CAAA;AAEF,eAAO,MAAM,wBAAwB;;IAEnC,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAKhE;;;;;OAKG;;IAEH;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAEH,CAAA;AAEF,eAAO,MAAM,gBAAgB;IAnF3B;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAWH;;;;;;OAMG;;;;;;;;;;;;;;;;;;IAGH,uBAAuB;;IAEvB,uBAAuB;;IAEvB,gDAAgD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAehD,qEAAqE;;IAErE,2FAA2F;;IAE3F,oCAAoC;;IAEpC,wDAAwD;;IAExD,gDAAgD;;IAEhD,8CAA8C;;IAE9C,gEAAgE;;IAKhE;;;;;OAKG;;IAEH;;;;OAIG;;IAEH,kFAAkF;;IAElF;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAI8E,CAAA;AACnF,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AACzD,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}