@scalar/api-client 2.3.8 → 2.3.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 (78) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/dist/components/CodeInput/CodeInput.vue.d.ts +1 -1
  3. package/dist/components/CodeInput/CodeInput.vue.d.ts.map +1 -1
  4. package/dist/components/CodeInput/CodeInput.vue.js +2 -2
  5. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +8 -8
  6. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
  7. package/dist/components/ScalarHotkey.vue.d.ts +1 -1
  8. package/dist/components/ScalarHotkey.vue.d.ts.map +1 -1
  9. package/dist/components/Server/ServerDropdownItem.vue.d.ts.map +1 -1
  10. package/dist/components/Server/ServerDropdownItem.vue.js +2 -2
  11. package/dist/components/ViewLayout/ViewLayoutSection.test.d.ts +2 -0
  12. package/dist/components/ViewLayout/ViewLayoutSection.test.d.ts.map +1 -0
  13. package/dist/components/ViewLayout/ViewLayoutSection.vue.d.ts.map +1 -1
  14. package/dist/components/ViewLayout/ViewLayoutSection.vue.js +8 -8
  15. package/dist/layouts/App/create-api-client-app.d.ts +638 -466
  16. package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
  17. package/dist/layouts/Modal/create-api-client-modal.d.ts +1297 -953
  18. package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
  19. package/dist/layouts/Web/create-api-client-web.d.ts +638 -466
  20. package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
  21. package/dist/libs/create-client.d.ts +631 -459
  22. package/dist/libs/create-client.d.ts.map +1 -1
  23. package/dist/libs/find-request.d.ts +4 -4
  24. package/dist/libs/find-request.d.ts.map +1 -1
  25. package/dist/libs/hot-keys.d.ts +2 -2
  26. package/dist/libs/send-request/build-request-security.d.ts +2 -2
  27. package/dist/libs/send-request/create-request-operation.test.d.ts +49 -47
  28. package/dist/libs/send-request/create-request-operation.test.d.ts.map +1 -1
  29. package/dist/store/active-entities.d.ts +65 -61
  30. package/dist/store/active-entities.d.ts.map +1 -1
  31. package/dist/store/collections.d.ts +30 -30
  32. package/dist/store/collections.d.ts.map +1 -1
  33. package/dist/store/cookies.d.ts +18 -18
  34. package/dist/store/environment.d.ts +9 -9
  35. package/dist/store/import-spec.d.ts +154 -2
  36. package/dist/store/import-spec.d.ts.map +1 -1
  37. package/dist/store/request-example.d.ts +272 -272
  38. package/dist/store/request-example.d.ts.map +1 -1
  39. package/dist/store/requests.d.ts +44 -44
  40. package/dist/store/requests.d.ts.map +1 -1
  41. package/dist/store/security-schemes.d.ts +10 -10
  42. package/dist/store/security-schemes.d.ts.map +1 -1
  43. package/dist/store/servers.d.ts +50 -30
  44. package/dist/store/servers.d.ts.map +1 -1
  45. package/dist/store/store.d.ts +635 -463
  46. package/dist/store/store.d.ts.map +1 -1
  47. package/dist/store/tags.d.ts +10 -10
  48. package/dist/store/workspace.d.ts +44 -44
  49. package/dist/style.css +1 -1
  50. package/dist/views/Collection/CollectionServerForm.vue.d.ts.map +1 -1
  51. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthTab.vue.d.ts +1 -1
  52. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthTab.vue.d.ts.map +1 -1
  53. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthTab.vue.js +2 -2
  54. package/dist/views/Request/RequestSection/RequestBody.vue.d.ts +1 -1
  55. package/dist/views/Request/RequestSection/RequestBody.vue.d.ts.map +1 -1
  56. package/dist/views/Request/RequestSection/RequestBody.vue.js +2 -2
  57. package/dist/views/Request/RequestSection/RequestCodeExample.vue.d.ts +1 -1
  58. package/dist/views/Request/RequestSection/RequestCodeExample.vue.d.ts.map +1 -1
  59. package/dist/views/Request/RequestSection/RequestCodeExample.vue.js +2 -2
  60. package/dist/views/Request/RequestSection/RequestPathParams.vue.d.ts +1 -1
  61. package/dist/views/Request/RequestSection/RequestPathParams.vue.d.ts.map +1 -1
  62. package/dist/views/Request/RequestSection/RequestSection.test.d.ts +2 -0
  63. package/dist/views/Request/RequestSection/RequestSection.test.d.ts.map +1 -0
  64. package/dist/views/Request/RequestSection/RequestSection.vue.d.ts +1 -1
  65. package/dist/views/Request/RequestSection/RequestSection.vue.d.ts.map +1 -1
  66. package/dist/views/Request/RequestSection/RequestSection.vue.js +2 -2
  67. package/dist/views/Request/RequestSection/RequestSection.vue2.js +26 -19
  68. package/dist/views/Request/RequestSection/RequestTable.vue.d.ts +1 -1
  69. package/dist/views/Request/RequestSection/RequestTable.vue.d.ts.map +1 -1
  70. package/dist/views/Request/RequestSection/RequestTable.vue.js +2 -2
  71. package/dist/views/Request/RequestSection/RequestTable.vue2.js +191 -193
  72. package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
  73. package/dist/views/Request/ResponseSection/ResponseSection.test.d.ts +2 -0
  74. package/dist/views/Request/ResponseSection/ResponseSection.test.d.ts.map +1 -0
  75. package/dist/views/Request/ResponseSection/ResponseSection.vue.d.ts.map +1 -1
  76. package/dist/views/Request/ResponseSection/ResponseSection.vue.js +2 -2
  77. package/dist/views/Request/ResponseSection/ResponseSection.vue2.js +50 -47
  78. package/package.json +12 -12
package/dist/store/request-example.d.ts CHANGED
@@ -3,9 +3,37 @@ import { type Request, type RequestExample } from '@scalar/oas-utils/entities/sp
3
3
  /** Create top level examples storage for the workspace */
4
4
  export declare function createStoreRequestExamples(useLocalStorage: boolean): {
5
5
  requestExamples: Record<string, {
6
- type: "requestExample";
7
6
  uid: string & import("zod").BRAND<"example">;
8
7
  name: string;
8
+ type: "requestExample";
9
+ body: {
10
+ activeBody: "formData" | "binary" | "raw";
11
+ formData?: {
12
+ value: {
13
+ value: string;
14
+ key: string;
15
+ enabled: boolean;
16
+ minimum?: number | undefined;
17
+ type?: string | string[] | undefined;
18
+ maximum?: number | undefined;
19
+ description?: string | undefined;
20
+ default?: any;
21
+ required?: boolean | undefined;
22
+ examples?: string[] | undefined;
23
+ format?: string | undefined;
24
+ enum?: string[] | undefined;
25
+ file?: any;
26
+ nullable?: boolean | undefined;
27
+ }[];
28
+ encoding: "form-data" | "urlencoded";
29
+ } | undefined;
30
+ binary?: Blob | undefined;
31
+ raw?: {
32
+ value: string;
33
+ encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
34
+ mimeType?: string | undefined;
35
+ } | undefined;
36
+ };
9
37
  parameters: {
10
38
  path: {
11
39
  value: string;
@@ -14,100 +42,100 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
14
42
  minimum?: number | undefined;
15
43
  type?: string | string[] | undefined;
16
44
  maximum?: number | undefined;
45
+ description?: string | undefined;
17
46
  default?: any;
18
47
  required?: boolean | undefined;
19
- description?: string | undefined;
20
- enum?: string[] | undefined;
21
48
  examples?: string[] | undefined;
22
49
  format?: string | undefined;
50
+ enum?: string[] | undefined;
23
51
  file?: any;
24
52
  nullable?: boolean | undefined;
25
53
  }[];
26
- cookies: {
54
+ query: {
27
55
  value: string;
28
56
  key: string;
29
57
  enabled: boolean;
30
58
  minimum?: number | undefined;
31
59
  type?: string | string[] | undefined;
32
60
  maximum?: number | undefined;
61
+ description?: string | undefined;
33
62
  default?: any;
34
63
  required?: boolean | undefined;
35
- description?: string | undefined;
36
- enum?: string[] | undefined;
37
64
  examples?: string[] | undefined;
38
65
  format?: string | undefined;
66
+ enum?: string[] | undefined;
39
67
  file?: any;
40
68
  nullable?: boolean | undefined;
41
69
  }[];
42
- query: {
70
+ headers: {
43
71
  value: string;
44
72
  key: string;
45
73
  enabled: boolean;
46
74
  minimum?: number | undefined;
47
75
  type?: string | string[] | undefined;
48
76
  maximum?: number | undefined;
77
+ description?: string | undefined;
49
78
  default?: any;
50
79
  required?: boolean | undefined;
51
- description?: string | undefined;
52
- enum?: string[] | undefined;
53
80
  examples?: string[] | undefined;
54
81
  format?: string | undefined;
82
+ enum?: string[] | undefined;
55
83
  file?: any;
56
84
  nullable?: boolean | undefined;
57
85
  }[];
58
- headers: {
86
+ cookies: {
59
87
  value: string;
60
88
  key: string;
61
89
  enabled: boolean;
62
90
  minimum?: number | undefined;
63
91
  type?: string | string[] | undefined;
64
92
  maximum?: number | undefined;
93
+ description?: string | undefined;
65
94
  default?: any;
66
95
  required?: boolean | undefined;
67
- description?: string | undefined;
68
- enum?: string[] | undefined;
69
96
  examples?: string[] | undefined;
70
97
  format?: string | undefined;
98
+ enum?: string[] | undefined;
71
99
  file?: any;
72
100
  nullable?: boolean | undefined;
73
101
  }[];
74
102
  };
75
- body: {
76
- activeBody: "binary" | "formData" | "raw";
77
- binary?: Blob | undefined;
78
- formData?: {
79
- value: {
80
- value: string;
81
- key: string;
82
- enabled: boolean;
83
- minimum?: number | undefined;
84
- type?: string | string[] | undefined;
85
- maximum?: number | undefined;
86
- default?: any;
87
- required?: boolean | undefined;
88
- description?: string | undefined;
89
- enum?: string[] | undefined;
90
- examples?: string[] | undefined;
91
- format?: string | undefined;
92
- file?: any;
93
- nullable?: boolean | undefined;
94
- }[];
95
- encoding: "form-data" | "urlencoded";
96
- } | undefined;
97
- raw?: {
98
- value: string;
99
- encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
100
- mimeType?: string | undefined;
101
- } | undefined;
102
- };
103
103
  requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
104
104
  serverVariables?: Record<string, string[]> | undefined;
105
105
  }>;
106
106
  requestExampleMutators: {
107
107
  add: (item: {
108
- type: "requestExample";
109
108
  uid: string & import("zod").BRAND<"example">;
110
109
  name: string;
110
+ type: "requestExample";
111
+ body: {
112
+ activeBody: "formData" | "binary" | "raw";
113
+ formData?: {
114
+ value: {
115
+ value: string;
116
+ key: string;
117
+ enabled: boolean;
118
+ minimum?: number | undefined;
119
+ type?: string | string[] | undefined;
120
+ maximum?: number | undefined;
121
+ description?: string | undefined;
122
+ default?: any;
123
+ required?: boolean | undefined;
124
+ examples?: string[] | undefined;
125
+ format?: string | undefined;
126
+ enum?: string[] | undefined;
127
+ file?: any;
128
+ nullable?: boolean | undefined;
129
+ }[];
130
+ encoding: "form-data" | "urlencoded";
131
+ } | undefined;
132
+ binary?: Blob | undefined;
133
+ raw?: {
134
+ value: string;
135
+ encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
136
+ mimeType?: string | undefined;
137
+ } | undefined;
138
+ };
111
139
  parameters: {
112
140
  path: {
113
141
  value: string;
@@ -116,67 +144,74 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
116
144
  minimum?: number | undefined;
117
145
  type?: string | string[] | undefined;
118
146
  maximum?: number | undefined;
147
+ description?: string | undefined;
119
148
  default?: any;
120
149
  required?: boolean | undefined;
121
- description?: string | undefined;
122
- enum?: string[] | undefined;
123
150
  examples?: string[] | undefined;
124
151
  format?: string | undefined;
152
+ enum?: string[] | undefined;
125
153
  file?: any;
126
154
  nullable?: boolean | undefined;
127
155
  }[];
128
- cookies: {
156
+ query: {
129
157
  value: string;
130
158
  key: string;
131
159
  enabled: boolean;
132
160
  minimum?: number | undefined;
133
161
  type?: string | string[] | undefined;
134
162
  maximum?: number | undefined;
163
+ description?: string | undefined;
135
164
  default?: any;
136
165
  required?: boolean | undefined;
137
- description?: string | undefined;
138
- enum?: string[] | undefined;
139
166
  examples?: string[] | undefined;
140
167
  format?: string | undefined;
168
+ enum?: string[] | undefined;
141
169
  file?: any;
142
170
  nullable?: boolean | undefined;
143
171
  }[];
144
- query: {
172
+ headers: {
145
173
  value: string;
146
174
  key: string;
147
175
  enabled: boolean;
148
176
  minimum?: number | undefined;
149
177
  type?: string | string[] | undefined;
150
178
  maximum?: number | undefined;
179
+ description?: string | undefined;
151
180
  default?: any;
152
181
  required?: boolean | undefined;
153
- description?: string | undefined;
154
- enum?: string[] | undefined;
155
182
  examples?: string[] | undefined;
156
183
  format?: string | undefined;
184
+ enum?: string[] | undefined;
157
185
  file?: any;
158
186
  nullable?: boolean | undefined;
159
187
  }[];
160
- headers: {
188
+ cookies: {
161
189
  value: string;
162
190
  key: string;
163
191
  enabled: boolean;
164
192
  minimum?: number | undefined;
165
193
  type?: string | string[] | undefined;
166
194
  maximum?: number | undefined;
195
+ description?: string | undefined;
167
196
  default?: any;
168
197
  required?: boolean | undefined;
169
- description?: string | undefined;
170
- enum?: string[] | undefined;
171
198
  examples?: string[] | undefined;
172
199
  format?: string | undefined;
200
+ enum?: string[] | undefined;
173
201
  file?: any;
174
202
  nullable?: boolean | undefined;
175
203
  }[];
176
204
  };
205
+ requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
206
+ serverVariables?: Record<string, string[]> | undefined;
207
+ }) => void;
208
+ delete: (uid: (string & import("zod").BRAND<"example">) | null | undefined) => void;
209
+ set: (item: {
210
+ uid: string & import("zod").BRAND<"example">;
211
+ name: string;
212
+ type: "requestExample";
177
213
  body: {
178
- activeBody: "binary" | "formData" | "raw";
179
- binary?: Blob | undefined;
214
+ activeBody: "formData" | "binary" | "raw";
180
215
  formData?: {
181
216
  value: {
182
217
  value: string;
@@ -185,31 +220,24 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
185
220
  minimum?: number | undefined;
186
221
  type?: string | string[] | undefined;
187
222
  maximum?: number | undefined;
223
+ description?: string | undefined;
188
224
  default?: any;
189
225
  required?: boolean | undefined;
190
- description?: string | undefined;
191
- enum?: string[] | undefined;
192
226
  examples?: string[] | undefined;
193
227
  format?: string | undefined;
228
+ enum?: string[] | undefined;
194
229
  file?: any;
195
230
  nullable?: boolean | undefined;
196
231
  }[];
197
232
  encoding: "form-data" | "urlencoded";
198
233
  } | undefined;
234
+ binary?: Blob | undefined;
199
235
  raw?: {
200
236
  value: string;
201
237
  encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
202
238
  mimeType?: string | undefined;
203
239
  } | undefined;
204
240
  };
205
- requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
206
- serverVariables?: Record<string, string[]> | undefined;
207
- }) => void;
208
- delete: (uid: (string & import("zod").BRAND<"example">) | null | undefined) => void;
209
- set: (item: {
210
- type: "requestExample";
211
- uid: string & import("zod").BRAND<"example">;
212
- name: string;
213
241
  parameters: {
214
242
  path: {
215
243
  value: string;
@@ -218,67 +246,73 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
218
246
  minimum?: number | undefined;
219
247
  type?: string | string[] | undefined;
220
248
  maximum?: number | undefined;
249
+ description?: string | undefined;
221
250
  default?: any;
222
251
  required?: boolean | undefined;
223
- description?: string | undefined;
224
- enum?: string[] | undefined;
225
252
  examples?: string[] | undefined;
226
253
  format?: string | undefined;
254
+ enum?: string[] | undefined;
227
255
  file?: any;
228
256
  nullable?: boolean | undefined;
229
257
  }[];
230
- cookies: {
258
+ query: {
231
259
  value: string;
232
260
  key: string;
233
261
  enabled: boolean;
234
262
  minimum?: number | undefined;
235
263
  type?: string | string[] | undefined;
236
264
  maximum?: number | undefined;
265
+ description?: string | undefined;
237
266
  default?: any;
238
267
  required?: boolean | undefined;
239
- description?: string | undefined;
240
- enum?: string[] | undefined;
241
268
  examples?: string[] | undefined;
242
269
  format?: string | undefined;
270
+ enum?: string[] | undefined;
243
271
  file?: any;
244
272
  nullable?: boolean | undefined;
245
273
  }[];
246
- query: {
274
+ headers: {
247
275
  value: string;
248
276
  key: string;
249
277
  enabled: boolean;
250
278
  minimum?: number | undefined;
251
279
  type?: string | string[] | undefined;
252
280
  maximum?: number | undefined;
281
+ description?: string | undefined;
253
282
  default?: any;
254
283
  required?: boolean | undefined;
255
- description?: string | undefined;
256
- enum?: string[] | undefined;
257
284
  examples?: string[] | undefined;
258
285
  format?: string | undefined;
286
+ enum?: string[] | undefined;
259
287
  file?: any;
260
288
  nullable?: boolean | undefined;
261
289
  }[];
262
- headers: {
290
+ cookies: {
263
291
  value: string;
264
292
  key: string;
265
293
  enabled: boolean;
266
294
  minimum?: number | undefined;
267
295
  type?: string | string[] | undefined;
268
296
  maximum?: number | undefined;
297
+ description?: string | undefined;
269
298
  default?: any;
270
299
  required?: boolean | undefined;
271
- description?: string | undefined;
272
- enum?: string[] | undefined;
273
300
  examples?: string[] | undefined;
274
301
  format?: string | undefined;
302
+ enum?: string[] | undefined;
275
303
  file?: any;
276
304
  nullable?: boolean | undefined;
277
305
  }[];
278
306
  };
307
+ requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
308
+ serverVariables?: Record<string, string[]> | undefined;
309
+ }) => void;
310
+ edit: <P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | "body.formData" | "body.binary" | "body.raw" | "body.activeBody" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | "body.binary.size" | "body.binary.type" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: (string & import("zod").BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? {
311
+ uid: string & import("zod").BRAND<"example">;
312
+ name: string;
313
+ type: "requestExample";
279
314
  body: {
280
- activeBody: "binary" | "formData" | "raw";
281
- binary?: Blob | undefined;
315
+ activeBody: "formData" | "binary" | "raw";
282
316
  formData?: {
283
317
  value: {
284
318
  value: string;
@@ -287,30 +321,24 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
287
321
  minimum?: number | undefined;
288
322
  type?: string | string[] | undefined;
289
323
  maximum?: number | undefined;
324
+ description?: string | undefined;
290
325
  default?: any;
291
326
  required?: boolean | undefined;
292
- description?: string | undefined;
293
- enum?: string[] | undefined;
294
327
  examples?: string[] | undefined;
295
328
  format?: string | undefined;
329
+ enum?: string[] | undefined;
296
330
  file?: any;
297
331
  nullable?: boolean | undefined;
298
332
  }[];
299
333
  encoding: "form-data" | "urlencoded";
300
334
  } | undefined;
335
+ binary?: Blob | undefined;
301
336
  raw?: {
302
337
  value: string;
303
338
  encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
304
339
  mimeType?: string | undefined;
305
340
  } | undefined;
306
341
  };
307
- requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
308
- serverVariables?: Record<string, string[]> | undefined;
309
- }) => void;
310
- edit: <P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.type" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: (string & import("zod").BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? {
311
- type: "requestExample";
312
- uid: string & import("zod").BRAND<"example">;
313
- name: string;
314
342
  parameters: {
315
343
  path: {
316
344
  value: string;
@@ -319,67 +347,72 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
319
347
  minimum?: number | undefined;
320
348
  type?: string | string[] | undefined;
321
349
  maximum?: number | undefined;
350
+ description?: string | undefined;
322
351
  default?: any;
323
352
  required?: boolean | undefined;
324
- description?: string | undefined;
325
- enum?: string[] | undefined;
326
353
  examples?: string[] | undefined;
327
354
  format?: string | undefined;
355
+ enum?: string[] | undefined;
328
356
  file?: any;
329
357
  nullable?: boolean | undefined;
330
358
  }[];
331
- cookies: {
359
+ query: {
332
360
  value: string;
333
361
  key: string;
334
362
  enabled: boolean;
335
363
  minimum?: number | undefined;
336
364
  type?: string | string[] | undefined;
337
365
  maximum?: number | undefined;
366
+ description?: string | undefined;
338
367
  default?: any;
339
368
  required?: boolean | undefined;
340
- description?: string | undefined;
341
- enum?: string[] | undefined;
342
369
  examples?: string[] | undefined;
343
370
  format?: string | undefined;
371
+ enum?: string[] | undefined;
344
372
  file?: any;
345
373
  nullable?: boolean | undefined;
346
374
  }[];
347
- query: {
375
+ headers: {
348
376
  value: string;
349
377
  key: string;
350
378
  enabled: boolean;
351
379
  minimum?: number | undefined;
352
380
  type?: string | string[] | undefined;
353
381
  maximum?: number | undefined;
382
+ description?: string | undefined;
354
383
  default?: any;
355
384
  required?: boolean | undefined;
356
- description?: string | undefined;
357
- enum?: string[] | undefined;
358
385
  examples?: string[] | undefined;
359
386
  format?: string | undefined;
387
+ enum?: string[] | undefined;
360
388
  file?: any;
361
389
  nullable?: boolean | undefined;
362
390
  }[];
363
- headers: {
391
+ cookies: {
364
392
  value: string;
365
393
  key: string;
366
394
  enabled: boolean;
367
395
  minimum?: number | undefined;
368
396
  type?: string | string[] | undefined;
369
397
  maximum?: number | undefined;
398
+ description?: string | undefined;
370
399
  default?: any;
371
400
  required?: boolean | undefined;
372
- description?: string | undefined;
373
- enum?: string[] | undefined;
374
401
  examples?: string[] | undefined;
375
402
  format?: string | undefined;
403
+ enum?: string[] | undefined;
376
404
  file?: any;
377
405
  nullable?: boolean | undefined;
378
406
  }[];
379
407
  };
408
+ requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
409
+ serverVariables?: Record<string, string[]> | undefined;
410
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
411
+ uid: string & import("zod").BRAND<"example">;
412
+ name: string;
413
+ type: "requestExample";
380
414
  body: {
381
- activeBody: "binary" | "formData" | "raw";
382
- binary?: Blob | undefined;
415
+ activeBody: "formData" | "binary" | "raw";
383
416
  formData?: {
384
417
  value: {
385
418
  value: string;
@@ -388,29 +421,24 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
388
421
  minimum?: number | undefined;
389
422
  type?: string | string[] | undefined;
390
423
  maximum?: number | undefined;
424
+ description?: string | undefined;
391
425
  default?: any;
392
426
  required?: boolean | undefined;
393
- description?: string | undefined;
394
- enum?: string[] | undefined;
395
427
  examples?: string[] | undefined;
396
428
  format?: string | undefined;
429
+ enum?: string[] | undefined;
397
430
  file?: any;
398
431
  nullable?: boolean | undefined;
399
432
  }[];
400
433
  encoding: "form-data" | "urlencoded";
401
434
  } | undefined;
435
+ binary?: Blob | undefined;
402
436
  raw?: {
403
437
  value: string;
404
438
  encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
405
439
  mimeType?: string | undefined;
406
440
  } | undefined;
407
441
  };
408
- requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
409
- serverVariables?: Record<string, string[]> | undefined;
410
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
411
- type: "requestExample";
412
- uid: string & import("zod").BRAND<"example">;
413
- name: string;
414
442
  parameters: {
415
443
  path: {
416
444
  value: string;
@@ -419,67 +447,72 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
419
447
  minimum?: number | undefined;
420
448
  type?: string | string[] | undefined;
421
449
  maximum?: number | undefined;
450
+ description?: string | undefined;
422
451
  default?: any;
423
452
  required?: boolean | undefined;
424
- description?: string | undefined;
425
- enum?: string[] | undefined;
426
453
  examples?: string[] | undefined;
427
454
  format?: string | undefined;
455
+ enum?: string[] | undefined;
428
456
  file?: any;
429
457
  nullable?: boolean | undefined;
430
458
  }[];
431
- cookies: {
459
+ query: {
432
460
  value: string;
433
461
  key: string;
434
462
  enabled: boolean;
435
463
  minimum?: number | undefined;
436
464
  type?: string | string[] | undefined;
437
465
  maximum?: number | undefined;
466
+ description?: string | undefined;
438
467
  default?: any;
439
468
  required?: boolean | undefined;
440
- description?: string | undefined;
441
- enum?: string[] | undefined;
442
469
  examples?: string[] | undefined;
443
470
  format?: string | undefined;
471
+ enum?: string[] | undefined;
444
472
  file?: any;
445
473
  nullable?: boolean | undefined;
446
474
  }[];
447
- query: {
475
+ headers: {
448
476
  value: string;
449
477
  key: string;
450
478
  enabled: boolean;
451
479
  minimum?: number | undefined;
452
480
  type?: string | string[] | undefined;
453
481
  maximum?: number | undefined;
482
+ description?: string | undefined;
454
483
  default?: any;
455
484
  required?: boolean | undefined;
456
- description?: string | undefined;
457
- enum?: string[] | undefined;
458
485
  examples?: string[] | undefined;
459
486
  format?: string | undefined;
487
+ enum?: string[] | undefined;
460
488
  file?: any;
461
489
  nullable?: boolean | undefined;
462
490
  }[];
463
- headers: {
491
+ cookies: {
464
492
  value: string;
465
493
  key: string;
466
494
  enabled: boolean;
467
495
  minimum?: number | undefined;
468
496
  type?: string | string[] | undefined;
469
497
  maximum?: number | undefined;
498
+ description?: string | undefined;
470
499
  default?: any;
471
500
  required?: boolean | undefined;
472
- description?: string | undefined;
473
- enum?: string[] | undefined;
474
501
  examples?: string[] | undefined;
475
502
  format?: string | undefined;
503
+ enum?: string[] | undefined;
476
504
  file?: any;
477
505
  nullable?: boolean | undefined;
478
506
  }[];
479
507
  };
508
+ requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
509
+ serverVariables?: Record<string, string[]> | undefined;
510
+ }[K]> ? import("@scalar/object-utils/nested").PathValue<{
511
+ uid: string & import("zod").BRAND<"example">;
512
+ name: string;
513
+ type: "requestExample";
480
514
  body: {
481
- activeBody: "binary" | "formData" | "raw";
482
- binary?: Blob | undefined;
515
+ activeBody: "formData" | "binary" | "raw";
483
516
  formData?: {
484
517
  value: {
485
518
  value: string;
@@ -488,29 +521,24 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
488
521
  minimum?: number | undefined;
489
522
  type?: string | string[] | undefined;
490
523
  maximum?: number | undefined;
491
- default?: any;
492
- required?: boolean | undefined;
493
524
  description?: string | undefined;
494
- enum?: string[] | undefined;
525
+ default?: any;
526
+ required?: boolean | undefined;
495
527
  examples?: string[] | undefined;
496
528
  format?: string | undefined;
529
+ enum?: string[] | undefined;
497
530
  file?: any;
498
531
  nullable?: boolean | undefined;
499
532
  }[];
500
533
  encoding: "form-data" | "urlencoded";
501
534
  } | undefined;
535
+ binary?: Blob | undefined;
502
536
  raw?: {
503
537
  value: string;
504
538
  encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
505
539
  mimeType?: string | undefined;
506
540
  } | undefined;
507
541
  };
508
- requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
509
- serverVariables?: Record<string, string[]> | undefined;
510
- }[K]> ? import("@scalar/object-utils/nested").PathValue<{
511
- type: "requestExample";
512
- uid: string & import("zod").BRAND<"example">;
513
- name: string;
514
542
  parameters: {
515
543
  path: {
516
544
  value: string;
@@ -519,67 +547,73 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
519
547
  minimum?: number | undefined;
520
548
  type?: string | string[] | undefined;
521
549
  maximum?: number | undefined;
550
+ description?: string | undefined;
522
551
  default?: any;
523
552
  required?: boolean | undefined;
524
- description?: string | undefined;
525
- enum?: string[] | undefined;
526
553
  examples?: string[] | undefined;
527
554
  format?: string | undefined;
555
+ enum?: string[] | undefined;
528
556
  file?: any;
529
557
  nullable?: boolean | undefined;
530
558
  }[];
531
- cookies: {
559
+ query: {
532
560
  value: string;
533
561
  key: string;
534
562
  enabled: boolean;
535
563
  minimum?: number | undefined;
536
564
  type?: string | string[] | undefined;
537
565
  maximum?: number | undefined;
566
+ description?: string | undefined;
538
567
  default?: any;
539
568
  required?: boolean | undefined;
540
- description?: string | undefined;
541
- enum?: string[] | undefined;
542
569
  examples?: string[] | undefined;
543
570
  format?: string | undefined;
571
+ enum?: string[] | undefined;
544
572
  file?: any;
545
573
  nullable?: boolean | undefined;
546
574
  }[];
547
- query: {
575
+ headers: {
548
576
  value: string;
549
577
  key: string;
550
578
  enabled: boolean;
551
579
  minimum?: number | undefined;
552
580
  type?: string | string[] | undefined;
553
581
  maximum?: number | undefined;
582
+ description?: string | undefined;
554
583
  default?: any;
555
584
  required?: boolean | undefined;
556
- description?: string | undefined;
557
- enum?: string[] | undefined;
558
585
  examples?: string[] | undefined;
559
586
  format?: string | undefined;
587
+ enum?: string[] | undefined;
560
588
  file?: any;
561
589
  nullable?: boolean | undefined;
562
590
  }[];
563
- headers: {
591
+ cookies: {
564
592
  value: string;
565
593
  key: string;
566
594
  enabled: boolean;
567
595
  minimum?: number | undefined;
568
596
  type?: string | string[] | undefined;
569
597
  maximum?: number | undefined;
598
+ description?: string | undefined;
570
599
  default?: any;
571
600
  required?: boolean | undefined;
572
- description?: string | undefined;
573
- enum?: string[] | undefined;
574
601
  examples?: string[] | undefined;
575
602
  format?: string | undefined;
603
+ enum?: string[] | undefined;
576
604
  file?: any;
577
605
  nullable?: boolean | undefined;
578
606
  }[];
579
607
  };
608
+ requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
609
+ serverVariables?: Record<string, string[]> | undefined;
610
+ }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
611
+ untrackedEdit: <P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | "body.formData" | "body.binary" | "body.raw" | "body.activeBody" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | "body.binary.size" | "body.binary.type" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: string & import("zod").BRAND<"example">, path: P, value: P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? {
612
+ uid: string & import("zod").BRAND<"example">;
613
+ name: string;
614
+ type: "requestExample";
580
615
  body: {
581
- activeBody: "binary" | "formData" | "raw";
582
- binary?: Blob | undefined;
616
+ activeBody: "formData" | "binary" | "raw";
583
617
  formData?: {
584
618
  value: {
585
619
  value: string;
@@ -588,30 +622,24 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
588
622
  minimum?: number | undefined;
589
623
  type?: string | string[] | undefined;
590
624
  maximum?: number | undefined;
625
+ description?: string | undefined;
591
626
  default?: any;
592
627
  required?: boolean | undefined;
593
- description?: string | undefined;
594
- enum?: string[] | undefined;
595
628
  examples?: string[] | undefined;
596
629
  format?: string | undefined;
630
+ enum?: string[] | undefined;
597
631
  file?: any;
598
632
  nullable?: boolean | undefined;
599
633
  }[];
600
634
  encoding: "form-data" | "urlencoded";
601
635
  } | undefined;
636
+ binary?: Blob | undefined;
602
637
  raw?: {
603
638
  value: string;
604
639
  encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
605
640
  mimeType?: string | undefined;
606
641
  } | undefined;
607
642
  };
608
- requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
609
- serverVariables?: Record<string, string[]> | undefined;
610
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
611
- untrackedEdit: <P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.type" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: string & import("zod").BRAND<"example">, path: P, value: P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? {
612
- type: "requestExample";
613
- uid: string & import("zod").BRAND<"example">;
614
- name: string;
615
643
  parameters: {
616
644
  path: {
617
645
  value: string;
@@ -620,67 +648,72 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
620
648
  minimum?: number | undefined;
621
649
  type?: string | string[] | undefined;
622
650
  maximum?: number | undefined;
651
+ description?: string | undefined;
623
652
  default?: any;
624
653
  required?: boolean | undefined;
625
- description?: string | undefined;
626
- enum?: string[] | undefined;
627
654
  examples?: string[] | undefined;
628
655
  format?: string | undefined;
656
+ enum?: string[] | undefined;
629
657
  file?: any;
630
658
  nullable?: boolean | undefined;
631
659
  }[];
632
- cookies: {
660
+ query: {
633
661
  value: string;
634
662
  key: string;
635
663
  enabled: boolean;
636
664
  minimum?: number | undefined;
637
665
  type?: string | string[] | undefined;
638
666
  maximum?: number | undefined;
667
+ description?: string | undefined;
639
668
  default?: any;
640
669
  required?: boolean | undefined;
641
- description?: string | undefined;
642
- enum?: string[] | undefined;
643
670
  examples?: string[] | undefined;
644
671
  format?: string | undefined;
672
+ enum?: string[] | undefined;
645
673
  file?: any;
646
674
  nullable?: boolean | undefined;
647
675
  }[];
648
- query: {
676
+ headers: {
649
677
  value: string;
650
678
  key: string;
651
679
  enabled: boolean;
652
680
  minimum?: number | undefined;
653
681
  type?: string | string[] | undefined;
654
682
  maximum?: number | undefined;
683
+ description?: string | undefined;
655
684
  default?: any;
656
685
  required?: boolean | undefined;
657
- description?: string | undefined;
658
- enum?: string[] | undefined;
659
686
  examples?: string[] | undefined;
660
687
  format?: string | undefined;
688
+ enum?: string[] | undefined;
661
689
  file?: any;
662
690
  nullable?: boolean | undefined;
663
691
  }[];
664
- headers: {
692
+ cookies: {
665
693
  value: string;
666
694
  key: string;
667
695
  enabled: boolean;
668
696
  minimum?: number | undefined;
669
697
  type?: string | string[] | undefined;
670
698
  maximum?: number | undefined;
699
+ description?: string | undefined;
671
700
  default?: any;
672
701
  required?: boolean | undefined;
673
- description?: string | undefined;
674
- enum?: string[] | undefined;
675
702
  examples?: string[] | undefined;
676
703
  format?: string | undefined;
704
+ enum?: string[] | undefined;
677
705
  file?: any;
678
706
  nullable?: boolean | undefined;
679
707
  }[];
680
708
  };
709
+ requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
710
+ serverVariables?: Record<string, string[]> | undefined;
711
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
712
+ uid: string & import("zod").BRAND<"example">;
713
+ name: string;
714
+ type: "requestExample";
681
715
  body: {
682
- activeBody: "binary" | "formData" | "raw";
683
- binary?: Blob | undefined;
716
+ activeBody: "formData" | "binary" | "raw";
684
717
  formData?: {
685
718
  value: {
686
719
  value: string;
@@ -689,29 +722,24 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
689
722
  minimum?: number | undefined;
690
723
  type?: string | string[] | undefined;
691
724
  maximum?: number | undefined;
725
+ description?: string | undefined;
692
726
  default?: any;
693
727
  required?: boolean | undefined;
694
- description?: string | undefined;
695
- enum?: string[] | undefined;
696
728
  examples?: string[] | undefined;
697
729
  format?: string | undefined;
730
+ enum?: string[] | undefined;
698
731
  file?: any;
699
732
  nullable?: boolean | undefined;
700
733
  }[];
701
734
  encoding: "form-data" | "urlencoded";
702
735
  } | undefined;
736
+ binary?: Blob | undefined;
703
737
  raw?: {
704
738
  value: string;
705
739
  encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
706
740
  mimeType?: string | undefined;
707
741
  } | undefined;
708
742
  };
709
- requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
710
- serverVariables?: Record<string, string[]> | undefined;
711
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
712
- type: "requestExample";
713
- uid: string & import("zod").BRAND<"example">;
714
- name: string;
715
743
  parameters: {
716
744
  path: {
717
745
  value: string;
@@ -720,67 +748,72 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
720
748
  minimum?: number | undefined;
721
749
  type?: string | string[] | undefined;
722
750
  maximum?: number | undefined;
751
+ description?: string | undefined;
723
752
  default?: any;
724
753
  required?: boolean | undefined;
725
- description?: string | undefined;
726
- enum?: string[] | undefined;
727
754
  examples?: string[] | undefined;
728
755
  format?: string | undefined;
756
+ enum?: string[] | undefined;
729
757
  file?: any;
730
758
  nullable?: boolean | undefined;
731
759
  }[];
732
- cookies: {
760
+ query: {
733
761
  value: string;
734
762
  key: string;
735
763
  enabled: boolean;
736
764
  minimum?: number | undefined;
737
765
  type?: string | string[] | undefined;
738
766
  maximum?: number | undefined;
767
+ description?: string | undefined;
739
768
  default?: any;
740
769
  required?: boolean | undefined;
741
- description?: string | undefined;
742
- enum?: string[] | undefined;
743
770
  examples?: string[] | undefined;
744
771
  format?: string | undefined;
772
+ enum?: string[] | undefined;
745
773
  file?: any;
746
774
  nullable?: boolean | undefined;
747
775
  }[];
748
- query: {
776
+ headers: {
749
777
  value: string;
750
778
  key: string;
751
779
  enabled: boolean;
752
780
  minimum?: number | undefined;
753
781
  type?: string | string[] | undefined;
754
782
  maximum?: number | undefined;
783
+ description?: string | undefined;
755
784
  default?: any;
756
785
  required?: boolean | undefined;
757
- description?: string | undefined;
758
- enum?: string[] | undefined;
759
786
  examples?: string[] | undefined;
760
787
  format?: string | undefined;
788
+ enum?: string[] | undefined;
761
789
  file?: any;
762
790
  nullable?: boolean | undefined;
763
791
  }[];
764
- headers: {
792
+ cookies: {
765
793
  value: string;
766
794
  key: string;
767
795
  enabled: boolean;
768
796
  minimum?: number | undefined;
769
797
  type?: string | string[] | undefined;
770
798
  maximum?: number | undefined;
799
+ description?: string | undefined;
771
800
  default?: any;
772
801
  required?: boolean | undefined;
773
- description?: string | undefined;
774
- enum?: string[] | undefined;
775
802
  examples?: string[] | undefined;
776
803
  format?: string | undefined;
804
+ enum?: string[] | undefined;
777
805
  file?: any;
778
806
  nullable?: boolean | undefined;
779
807
  }[];
780
808
  };
809
+ requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
810
+ serverVariables?: Record<string, string[]> | undefined;
811
+ }[K]> ? import("@scalar/object-utils/nested").PathValue<{
812
+ uid: string & import("zod").BRAND<"example">;
813
+ name: string;
814
+ type: "requestExample";
781
815
  body: {
782
- activeBody: "binary" | "formData" | "raw";
783
- binary?: Blob | undefined;
816
+ activeBody: "formData" | "binary" | "raw";
784
817
  formData?: {
785
818
  value: {
786
819
  value: string;
@@ -789,29 +822,24 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
789
822
  minimum?: number | undefined;
790
823
  type?: string | string[] | undefined;
791
824
  maximum?: number | undefined;
825
+ description?: string | undefined;
792
826
  default?: any;
793
827
  required?: boolean | undefined;
794
- description?: string | undefined;
795
- enum?: string[] | undefined;
796
828
  examples?: string[] | undefined;
797
829
  format?: string | undefined;
830
+ enum?: string[] | undefined;
798
831
  file?: any;
799
832
  nullable?: boolean | undefined;
800
833
  }[];
801
834
  encoding: "form-data" | "urlencoded";
802
835
  } | undefined;
836
+ binary?: Blob | undefined;
803
837
  raw?: {
804
838
  value: string;
805
839
  encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
806
840
  mimeType?: string | undefined;
807
841
  } | undefined;
808
842
  };
809
- requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
810
- serverVariables?: Record<string, string[]> | undefined;
811
- }[K]> ? import("@scalar/object-utils/nested").PathValue<{
812
- type: "requestExample";
813
- uid: string & import("zod").BRAND<"example">;
814
- name: string;
815
843
  parameters: {
816
844
  path: {
817
845
  value: string;
@@ -820,92 +848,64 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
820
848
  minimum?: number | undefined;
821
849
  type?: string | string[] | undefined;
822
850
  maximum?: number | undefined;
851
+ description?: string | undefined;
823
852
  default?: any;
824
853
  required?: boolean | undefined;
825
- description?: string | undefined;
826
- enum?: string[] | undefined;
827
854
  examples?: string[] | undefined;
828
855
  format?: string | undefined;
856
+ enum?: string[] | undefined;
829
857
  file?: any;
830
858
  nullable?: boolean | undefined;
831
859
  }[];
832
- cookies: {
860
+ query: {
833
861
  value: string;
834
862
  key: string;
835
863
  enabled: boolean;
836
864
  minimum?: number | undefined;
837
865
  type?: string | string[] | undefined;
838
866
  maximum?: number | undefined;
867
+ description?: string | undefined;
839
868
  default?: any;
840
869
  required?: boolean | undefined;
841
- description?: string | undefined;
842
- enum?: string[] | undefined;
843
870
  examples?: string[] | undefined;
844
871
  format?: string | undefined;
872
+ enum?: string[] | undefined;
845
873
  file?: any;
846
874
  nullable?: boolean | undefined;
847
875
  }[];
848
- query: {
876
+ headers: {
849
877
  value: string;
850
878
  key: string;
851
879
  enabled: boolean;
852
880
  minimum?: number | undefined;
853
881
  type?: string | string[] | undefined;
854
882
  maximum?: number | undefined;
883
+ description?: string | undefined;
855
884
  default?: any;
856
885
  required?: boolean | undefined;
857
- description?: string | undefined;
858
- enum?: string[] | undefined;
859
886
  examples?: string[] | undefined;
860
887
  format?: string | undefined;
888
+ enum?: string[] | undefined;
861
889
  file?: any;
862
890
  nullable?: boolean | undefined;
863
891
  }[];
864
- headers: {
892
+ cookies: {
865
893
  value: string;
866
894
  key: string;
867
895
  enabled: boolean;
868
896
  minimum?: number | undefined;
869
897
  type?: string | string[] | undefined;
870
898
  maximum?: number | undefined;
899
+ description?: string | undefined;
871
900
  default?: any;
872
901
  required?: boolean | undefined;
873
- description?: string | undefined;
874
- enum?: string[] | undefined;
875
902
  examples?: string[] | undefined;
876
903
  format?: string | undefined;
904
+ enum?: string[] | undefined;
877
905
  file?: any;
878
906
  nullable?: boolean | undefined;
879
907
  }[];
880
908
  };
881
- body: {
882
- activeBody: "binary" | "formData" | "raw";
883
- binary?: Blob | undefined;
884
- formData?: {
885
- value: {
886
- value: string;
887
- key: string;
888
- enabled: boolean;
889
- minimum?: number | undefined;
890
- type?: string | string[] | undefined;
891
- maximum?: number | undefined;
892
- default?: any;
893
- required?: boolean | undefined;
894
- description?: string | undefined;
895
- enum?: string[] | undefined;
896
- examples?: string[] | undefined;
897
- format?: string | undefined;
898
- file?: any;
899
- nullable?: boolean | undefined;
900
- }[];
901
- encoding: "form-data" | "urlencoded";
902
- } | undefined;
903
- raw?: {
904
- value: string;
905
- encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
906
- mimeType?: string | undefined;
907
- } | undefined;
908
- };
909
909
  requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
910
910
  serverVariables?: Record<string, string[]> | undefined;
911
911
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
@@ -917,9 +917,37 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
917
917
  /** Extended example data that needs store context */
918
918
  export declare function extendedExampleDataFactory({ requestExamples, requestExampleMutators, requestMutators, requests, }: StoreContext): {
919
919
  addRequestExample: (request: Request, _name?: string) => {
920
- type: "requestExample";
921
920
  uid: string & import("zod").BRAND<"example">;
922
921
  name: string;
922
+ type: "requestExample";
923
+ body: {
924
+ activeBody: "formData" | "binary" | "raw";
925
+ formData?: {
926
+ value: {
927
+ value: string;
928
+ key: string;
929
+ enabled: boolean;
930
+ minimum?: number | undefined;
931
+ type?: string | string[] | undefined;
932
+ maximum?: number | undefined;
933
+ description?: string | undefined;
934
+ default?: any;
935
+ required?: boolean | undefined;
936
+ examples?: string[] | undefined;
937
+ format?: string | undefined;
938
+ enum?: string[] | undefined;
939
+ file?: any;
940
+ nullable?: boolean | undefined;
941
+ }[];
942
+ encoding: "form-data" | "urlencoded";
943
+ } | undefined;
944
+ binary?: Blob | undefined;
945
+ raw?: {
946
+ value: string;
947
+ encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
948
+ mimeType?: string | undefined;
949
+ } | undefined;
950
+ };
923
951
  parameters: {
924
952
  path: {
925
953
  value: string;
@@ -928,92 +956,64 @@ export declare function extendedExampleDataFactory({ requestExamples, requestExa
928
956
  minimum?: number | undefined;
929
957
  type?: string | string[] | undefined;
930
958
  maximum?: number | undefined;
959
+ description?: string | undefined;
931
960
  default?: any;
932
961
  required?: boolean | undefined;
933
- description?: string | undefined;
934
- enum?: string[] | undefined;
935
962
  examples?: string[] | undefined;
936
963
  format?: string | undefined;
964
+ enum?: string[] | undefined;
937
965
  file?: any;
938
966
  nullable?: boolean | undefined;
939
967
  }[];
940
- cookies: {
968
+ query: {
941
969
  value: string;
942
970
  key: string;
943
971
  enabled: boolean;
944
972
  minimum?: number | undefined;
945
973
  type?: string | string[] | undefined;
946
974
  maximum?: number | undefined;
975
+ description?: string | undefined;
947
976
  default?: any;
948
977
  required?: boolean | undefined;
949
- description?: string | undefined;
950
- enum?: string[] | undefined;
951
978
  examples?: string[] | undefined;
952
979
  format?: string | undefined;
980
+ enum?: string[] | undefined;
953
981
  file?: any;
954
982
  nullable?: boolean | undefined;
955
983
  }[];
956
- query: {
984
+ headers: {
957
985
  value: string;
958
986
  key: string;
959
987
  enabled: boolean;
960
988
  minimum?: number | undefined;
961
989
  type?: string | string[] | undefined;
962
990
  maximum?: number | undefined;
991
+ description?: string | undefined;
963
992
  default?: any;
964
993
  required?: boolean | undefined;
965
- description?: string | undefined;
966
- enum?: string[] | undefined;
967
994
  examples?: string[] | undefined;
968
995
  format?: string | undefined;
996
+ enum?: string[] | undefined;
969
997
  file?: any;
970
998
  nullable?: boolean | undefined;
971
999
  }[];
972
- headers: {
1000
+ cookies: {
973
1001
  value: string;
974
1002
  key: string;
975
1003
  enabled: boolean;
976
1004
  minimum?: number | undefined;
977
1005
  type?: string | string[] | undefined;
978
1006
  maximum?: number | undefined;
1007
+ description?: string | undefined;
979
1008
  default?: any;
980
1009
  required?: boolean | undefined;
981
- description?: string | undefined;
982
- enum?: string[] | undefined;
983
1010
  examples?: string[] | undefined;
984
1011
  format?: string | undefined;
1012
+ enum?: string[] | undefined;
985
1013
  file?: any;
986
1014
  nullable?: boolean | undefined;
987
1015
  }[];
988
1016
  };
989
- body: {
990
- activeBody: "binary" | "formData" | "raw";
991
- binary?: Blob | undefined;
992
- formData?: {
993
- value: {
994
- value: string;
995
- key: string;
996
- enabled: boolean;
997
- minimum?: number | undefined;
998
- type?: string | string[] | undefined;
999
- maximum?: number | undefined;
1000
- default?: any;
1001
- required?: boolean | undefined;
1002
- description?: string | undefined;
1003
- enum?: string[] | undefined;
1004
- examples?: string[] | undefined;
1005
- format?: string | undefined;
1006
- file?: any;
1007
- nullable?: boolean | undefined;
1008
- }[];
1009
- encoding: "form-data" | "urlencoded";
1010
- } | undefined;
1011
- raw?: {
1012
- value: string;
1013
- encoding: "xml" | "json" | "text" | "html" | "javascript" | "yaml" | "edn";
1014
- mimeType?: string | undefined;
1015
- } | undefined;
1016
- };
1017
1017
  requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
1018
1018
  serverVariables?: Record<string, string[]> | undefined;
1019
1019
  };