@scalar/api-client-react 1.1.31 → 1.1.32

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 (11) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/README.md +2 -8
  3. package/dist/ApiClientModalProvider.d.ts +20 -0
  4. package/dist/ApiClientModalProvider.d.ts.map +1 -0
  5. package/dist/ApiClientModalProvider.js +2 -10
  6. package/dist/client-store.d.ts +12 -0
  7. package/dist/client-store.d.ts.map +1 -0
  8. package/dist/index.d.ts +2 -3614
  9. package/dist/index.d.ts.map +1 -0
  10. package/dist/style.css +1 -1
  11. package/package.json +8 -11
package/dist/index.d.ts CHANGED
@@ -1,3614 +1,2 @@
1
- import { App } from 'vue';
2
- import { BRAND } from 'zod';
3
- import { ClientConfiguration } from '@scalar/api-client/libs';
4
- import { Collection } from '@scalar/oas-utils/entities/spec';
5
- import { CollectionPayload } from '@scalar/oas-utils/entities/spec';
6
- import { CommandPaletteEvent } from 'node_modules/@scalar/api-client/dist/components/CommandPalette/TheCommandPalette.vue';
7
- import { default as default_2 } from 'react';
8
- import { Environment } from '@scalar/oas-utils/entities/environment';
9
- import { ErrorResponse } from '@scalar/api-client/libs';
10
- import { EventBus } from '@scalar/api-client/libs';
11
- import { OpenAPIV3_1 } from '@scalar/openapi-types';
12
- import { OpenClientPayload } from '@scalar/api-client/libs';
13
- import { Path } from '@scalar/object-utils/nested';
14
- import { PathValue } from '@scalar/object-utils/nested';
15
- import { PropsWithChildren } from 'react';
16
- import { Reactive } from 'vue';
17
- import { Ref } from 'vue';
18
- import { ReferenceConfiguration } from '@scalar/types';
19
- import { Request as Request_2 } from '@scalar/oas-utils/entities/spec';
20
- import { RequestEvent } from '@scalar/oas-utils/entities/spec';
21
- import { RequestExample } from '@scalar/oas-utils/entities/spec';
22
- import { RequestPayload } from '@scalar/oas-utils/entities/spec';
23
- import { RequestStatus } from '@scalar/api-client/libs';
24
- import { SecurityScheme } from '@scalar/oas-utils/entities/spec';
25
- import { SecuritySchemePayload } from '@scalar/oas-utils/entities/spec';
26
- import { Server } from '@scalar/oas-utils/entities/spec';
27
- import { ServerPayload } from '@scalar/oas-utils/entities/spec';
28
- import { SpecConfiguration } from '@scalar/types';
29
- import { Tag } from '@scalar/oas-utils/entities/spec';
30
- import { TagPayload } from '@scalar/oas-utils/entities/spec';
31
- import { Workspace } from '@scalar/oas-utils/entities';
32
- import { XScalarEnvironment } from '@scalar/oas-utils/entities/spec';
33
-
34
- /**
35
- * Api Client Modal React
36
- *
37
- * Provider which mounts the Scalar Api Client Modal vue app.
38
- * Rebuilt to support multiple instances when using a unique spec.url
39
- */
40
- export declare const ApiClientModalProvider: ({ children, initialRequest, configuration, }: Props) => default_2.JSX.Element;
41
-
42
- declare type Props = PropsWithChildren<{
43
- /** Choose a request to initially route to */
44
- initialRequest?: OpenClientPayload;
45
- /** Configuration for the Api Client */
46
- configuration?: ClientConfiguration;
47
- }>;
48
-
49
- export declare const useApiClientModal: () => {
50
- app: App<Element>;
51
- updateSpec: (spec: SpecConfiguration) => Promise<void>;
52
- updateConfig(newConfig: ClientConfiguration, mergeConfigs?: boolean): void;
53
- updateServer: (serverUrl: string) => void;
54
- onUpdateServer: (callback: (url: string) => void) => void;
55
- updateAuth: <P extends Path<SecurityScheme>>({ nameKey, propertyKey, value, }: {
56
- nameKey: string;
57
- propertyKey: P;
58
- value: NonNullable<PathValue<SecurityScheme, P>>;
59
- }) => void;
60
- route: (payload?: OpenClientPayload) => void;
61
- open: (payload?: OpenClientPayload) => void;
62
- mount: (mountingEl?: HTMLElement | null) => void;
63
- modalState: {
64
- open: boolean;
65
- show: () => void;
66
- hide: () => void;
67
- };
68
- store: {
69
- workspaces: Record<string, {
70
- uid: string & BRAND<"workspace">;
71
- name: string;
72
- description: string;
73
- collections: (string & BRAND<"collection">)[];
74
- environments: Record<string, string>;
75
- activeEnvironmentId: string;
76
- cookies: (string & BRAND<"cookie">)[];
77
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
78
- selectedHttpClient: {
79
- targetKey: string;
80
- clientKey: string;
81
- };
82
- hotKeyConfig?: {
83
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
84
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
85
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
86
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
87
- }>> | undefined;
88
- } | undefined;
89
- proxyUrl?: string | undefined;
90
- }>;
91
- collections: Record<string, {
92
- type: "collection";
93
- uid: string & BRAND<"collection">;
94
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
95
- openapi: string;
96
- security: Record<string, string[]>[];
97
- "x-scalar-icon": string;
98
- securitySchemes: string[];
99
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
100
- servers: (string & BRAND<"server">)[];
101
- requests: (string & BRAND<"operation">)[];
102
- tags: (string & BRAND<"tag">)[];
103
- watchMode: boolean;
104
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
105
- externalDocs?: {
106
- url: string;
107
- description?: string | undefined;
108
- } | undefined;
109
- jsonSchemaDialect?: string | undefined;
110
- info?: {
111
- title: string;
112
- version: string;
113
- description?: string | undefined;
114
- summary?: string | undefined;
115
- termsOfService?: string | undefined;
116
- contact?: {
117
- name?: string | undefined;
118
- url?: string | undefined;
119
- email?: string | undefined;
120
- } | undefined;
121
- license?: {
122
- name: string;
123
- identifier?: string | undefined;
124
- url?: string | undefined;
125
- } | undefined;
126
- } | undefined;
127
- components?: Record<string, unknown> | undefined;
128
- webhooks?: Record<string, unknown> | undefined;
129
- "x-scalar-active-environment"?: string | undefined;
130
- "x-scalar-environments"?: Record<string, {
131
- variables: Record<string, string | {
132
- default: string;
133
- description?: string | undefined;
134
- }>;
135
- description?: string | undefined;
136
- color?: string | undefined;
137
- }> | undefined;
138
- "x-scalar-secrets"?: Record<string, {
139
- example?: string | undefined;
140
- description?: string | undefined;
141
- }> | undefined;
142
- selectedServerUid?: (string & BRAND<"server">) | undefined;
143
- documentUrl?: string | undefined;
144
- integration?: string | null | undefined;
145
- }>;
146
- tags: Record<string, {
147
- type: "tag";
148
- uid: string & BRAND<"tag">;
149
- name: string;
150
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
151
- description?: string | undefined;
152
- externalDocs?: {
153
- url: string;
154
- description?: string | undefined;
155
- } | undefined;
156
- "x-scalar-children"?: {
157
- tagName: string;
158
- }[] | undefined;
159
- "x-internal"?: boolean | undefined;
160
- "x-scalar-ignore"?: boolean | undefined;
161
- }>;
162
- cookies: Record<string, {
163
- value: string;
164
- uid: string & BRAND<"cookie">;
165
- name: string;
166
- path?: string | undefined;
167
- domain?: string | undefined;
168
- }>;
169
- environments: Record<string, {
170
- value: string;
171
- uid: string & BRAND<"environment">;
172
- name: string;
173
- color: string;
174
- isDefault?: boolean | undefined;
175
- }>;
176
- requestExamples: Record<string, {
177
- type: "requestExample";
178
- uid: string & BRAND<"example">;
179
- name: string;
180
- parameters: {
181
- path: {
182
- value: string;
183
- key: string;
184
- enabled: boolean;
185
- minimum?: number | undefined;
186
- type?: string | string[] | undefined;
187
- maximum?: number | undefined;
188
- default?: any;
189
- required?: boolean | undefined;
190
- description?: string | undefined;
191
- enum?: string[] | undefined;
192
- examples?: string[] | undefined;
193
- format?: string | undefined;
194
- file?: any;
195
- nullable?: boolean | undefined;
196
- }[];
197
- cookies: {
198
- value: string;
199
- key: string;
200
- enabled: boolean;
201
- minimum?: number | undefined;
202
- type?: string | string[] | undefined;
203
- maximum?: number | undefined;
204
- default?: any;
205
- required?: boolean | undefined;
206
- description?: string | undefined;
207
- enum?: string[] | undefined;
208
- examples?: string[] | undefined;
209
- format?: string | undefined;
210
- file?: any;
211
- nullable?: boolean | undefined;
212
- }[];
213
- query: {
214
- value: string;
215
- key: string;
216
- enabled: boolean;
217
- minimum?: number | undefined;
218
- type?: string | string[] | undefined;
219
- maximum?: number | undefined;
220
- default?: any;
221
- required?: boolean | undefined;
222
- description?: string | undefined;
223
- enum?: string[] | undefined;
224
- examples?: string[] | undefined;
225
- format?: string | undefined;
226
- file?: any;
227
- nullable?: boolean | undefined;
228
- }[];
229
- headers: {
230
- value: string;
231
- key: string;
232
- enabled: boolean;
233
- minimum?: number | undefined;
234
- type?: string | string[] | undefined;
235
- maximum?: number | undefined;
236
- default?: any;
237
- required?: boolean | undefined;
238
- description?: string | undefined;
239
- enum?: string[] | undefined;
240
- examples?: string[] | undefined;
241
- format?: string | undefined;
242
- file?: any;
243
- nullable?: boolean | undefined;
244
- }[];
245
- };
246
- body: {
247
- activeBody: "binary" | "formData" | "raw";
248
- binary?: Blob | undefined;
249
- formData?: {
250
- value: {
251
- value: string;
252
- key: string;
253
- enabled: boolean;
254
- minimum?: number | undefined;
255
- type?: string | string[] | undefined;
256
- maximum?: number | undefined;
257
- default?: any;
258
- required?: boolean | undefined;
259
- description?: string | undefined;
260
- enum?: string[] | undefined;
261
- examples?: string[] | undefined;
262
- format?: string | undefined;
263
- file?: any;
264
- nullable?: boolean | undefined;
265
- }[];
266
- encoding: "form-data" | "urlencoded";
267
- } | undefined;
268
- raw?: {
269
- value: string;
270
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
271
- } | undefined;
272
- };
273
- requestUid?: (string & BRAND<"operation">) | undefined;
274
- serverVariables?: Record<string, string[]> | undefined;
275
- }>;
276
- requests: Record<string, {
277
- path: string;
278
- type: "request";
279
- uid: string & BRAND<"operation">;
280
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
281
- selectedServerUid: (string & BRAND<"server">) | null;
282
- servers: (string & BRAND<"server">)[];
283
- examples: (string & BRAND<"example">)[];
284
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
285
- description?: string | undefined;
286
- summary?: string | undefined;
287
- externalDocs?: {
288
- url: string;
289
- description?: string | undefined;
290
- } | undefined;
291
- "x-internal"?: boolean | undefined;
292
- "x-scalar-ignore"?: boolean | undefined;
293
- security?: Record<string, string[]>[] | undefined;
294
- tags?: string[] | undefined;
295
- deprecated?: boolean | undefined;
296
- operationId?: string | undefined;
297
- parameters?: {
298
- required: boolean;
299
- name: string;
300
- in: "path" | "cookie" | "query" | "header";
301
- deprecated: boolean;
302
- example?: unknown;
303
- description?: string | undefined;
304
- schema?: unknown;
305
- content?: unknown;
306
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
307
- examples?: Record<string, {
308
- value?: unknown;
309
- summary?: string | undefined;
310
- }> | undefined;
311
- }[] | undefined;
312
- requestBody?: any;
313
- responses?: Record<string, any> | undefined;
314
- }>;
315
- servers: Record<string, {
316
- uid: string & BRAND<"server">;
317
- url: string;
318
- description?: string | undefined;
319
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
320
- enum?: [string, ...string[]];
321
- value?: string;
322
- }> | undefined;
323
- }>;
324
- securitySchemes: Record<string, {
325
- type: "apiKey";
326
- value: string;
327
- uid: string & BRAND<"securityScheme">;
328
- name: string;
329
- nameKey: string;
330
- in: "cookie" | "query" | "header";
331
- description?: string | undefined;
332
- } | {
333
- type: "http";
334
- uid: string & BRAND<"securityScheme">;
335
- nameKey: string;
336
- scheme: "basic" | "bearer";
337
- bearerFormat: string;
338
- username: string;
339
- password: string;
340
- token: string;
341
- description?: string | undefined;
342
- } | {
343
- type: "openIdConnect";
344
- uid: string & BRAND<"securityScheme">;
345
- nameKey: string;
346
- openIdConnectUrl: string;
347
- description?: string | undefined;
348
- } | {
349
- type: "oauth2";
350
- uid: string & BRAND<"securityScheme">;
351
- nameKey: string;
352
- flows: {
353
- password?: {
354
- type: "password";
355
- username: string;
356
- password: string;
357
- token: string;
358
- refreshUrl: string;
359
- scopes: Record<string, string>;
360
- selectedScopes: string[];
361
- "x-scalar-client-id": string;
362
- tokenUrl: string;
363
- clientSecret: string;
364
- } | undefined;
365
- implicit?: {
366
- type: "implicit";
367
- token: string;
368
- refreshUrl: string;
369
- scopes: Record<string, string>;
370
- selectedScopes: string[];
371
- "x-scalar-client-id": string;
372
- authorizationUrl: string;
373
- "x-scalar-redirect-uri": string;
374
- } | undefined;
375
- clientCredentials?: {
376
- type: "clientCredentials";
377
- token: string;
378
- refreshUrl: string;
379
- scopes: Record<string, string>;
380
- selectedScopes: string[];
381
- "x-scalar-client-id": string;
382
- tokenUrl: string;
383
- clientSecret: string;
384
- } | undefined;
385
- authorizationCode?: {
386
- type: "authorizationCode";
387
- token: string;
388
- refreshUrl: string;
389
- scopes: Record<string, string>;
390
- selectedScopes: string[];
391
- "x-scalar-client-id": string;
392
- authorizationUrl: string;
393
- "x-scalar-redirect-uri": string;
394
- tokenUrl: string;
395
- clientSecret: string;
396
- "x-usePkce": "SHA-256" | "plain" | "no";
397
- } | undefined;
398
- };
399
- description?: string | undefined;
400
- }>;
401
- modalState: {
402
- open: boolean;
403
- show: () => void;
404
- hide: () => void;
405
- };
406
- events: {
407
- executeRequest: EventBus< {
408
- requestUid?: string;
409
- }>;
410
- cancelRequest: EventBus<any>;
411
- requestStatus: EventBus<RequestStatus>;
412
- commandPalette: EventBus<CommandPaletteEvent>;
413
- hotKeys: EventBus<Partial<Record<"addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar", KeyboardEvent>>>;
414
- };
415
- sidebarWidth: Ref<string, string>;
416
- setSidebarWidth: (width: string) => void;
417
- proxyUrl: string | undefined;
418
- hideClientButton: boolean;
419
- showSidebar: boolean;
420
- integration: "elysiajs" | "fastify" | "vue" | "html" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "go" | "hono" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | null | undefined;
421
- importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
422
- type?: "collection" | undefined;
423
- uid?: string | undefined;
424
- externalDocs?: {
425
- description?: string | undefined;
426
- url?: string | undefined;
427
- } | undefined;
428
- children?: string[] | undefined;
429
- openapi?: string | undefined;
430
- jsonSchemaDialect?: string | undefined;
431
- info?: {
432
- description?: string | undefined;
433
- title?: string | undefined;
434
- summary?: string | undefined;
435
- termsOfService?: string | undefined;
436
- contact?: {
437
- name?: string | undefined;
438
- url?: string | undefined;
439
- email?: string | undefined;
440
- } | undefined;
441
- license?: {
442
- name?: string | undefined;
443
- identifier?: string | undefined;
444
- url?: string | undefined;
445
- } | undefined;
446
- version?: string | undefined;
447
- } | undefined;
448
- security?: Record<string, string[] | undefined>[] | undefined;
449
- components?: Record<string, unknown> | undefined;
450
- webhooks?: Record<string, unknown> | undefined;
451
- "x-scalar-icon"?: string | undefined;
452
- "x-scalar-active-environment"?: string | undefined;
453
- "x-scalar-environments"?: Record<string, {
454
- variables: Record<string, string | {
455
- default?: string | undefined;
456
- description?: string | undefined;
457
- }>;
458
- description?: string | undefined;
459
- color?: string | undefined;
460
- }> | undefined;
461
- "x-scalar-secrets"?: Record<string, {
462
- example?: string | undefined;
463
- description?: string | undefined;
464
- }> | undefined;
465
- securitySchemes?: string[] | undefined;
466
- selectedSecuritySchemeUids?: (string | string[])[] | undefined;
467
- selectedServerUid?: string | undefined;
468
- servers?: string[] | undefined;
469
- requests?: string[] | undefined;
470
- tags?: string[] | undefined;
471
- documentUrl?: string | undefined;
472
- watchMode?: boolean | undefined;
473
- integration?: string | null | undefined;
474
- watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
475
- }, "watchMode" | "documentUrl"> & Pick<ReferenceConfiguration, "servers" | "authentication" | "baseServerURL"> & {
476
- setCollectionSecurity?: boolean;
477
- shouldLoad?: boolean;
478
- } & Pick<ReferenceConfiguration, "servers">) => Promise<{
479
- error: false;
480
- collection: Collection;
481
- requests: Request_2[];
482
- schema: OpenAPIV3_1.Document;
483
- examples: RequestExample[];
484
- servers: Server[];
485
- tags: Tag[];
486
- securitySchemes: SecurityScheme[];
487
- } | undefined>;
488
- importSpecFromUrl: (url: string, workspaceUid: string, { proxyUrl, ...options }?: Omit<Pick<{
489
- type?: "collection" | undefined;
490
- uid?: string | undefined;
491
- externalDocs?: {
492
- description?: string | undefined;
493
- url?: string | undefined;
494
- } | undefined;
495
- children?: string[] | undefined;
496
- openapi?: string | undefined;
497
- jsonSchemaDialect?: string | undefined;
498
- info?: {
499
- description?: string | undefined;
500
- title?: string | undefined;
501
- summary?: string | undefined;
502
- termsOfService?: string | undefined;
503
- contact?: {
504
- name?: string | undefined;
505
- url?: string | undefined;
506
- email?: string | undefined;
507
- } | undefined;
508
- license?: {
509
- name?: string | undefined;
510
- identifier?: string | undefined;
511
- url?: string | undefined;
512
- } | undefined;
513
- version?: string | undefined;
514
- } | undefined;
515
- security?: Record<string, string[] | undefined>[] | undefined;
516
- components?: Record<string, unknown> | undefined;
517
- webhooks?: Record<string, unknown> | undefined;
518
- "x-scalar-icon"?: string | undefined;
519
- "x-scalar-active-environment"?: string | undefined;
520
- "x-scalar-environments"?: Record<string, {
521
- variables: Record<string, string | {
522
- default?: string | undefined;
523
- description?: string | undefined;
524
- }>;
525
- description?: string | undefined;
526
- color?: string | undefined;
527
- }> | undefined;
528
- "x-scalar-secrets"?: Record<string, {
529
- example?: string | undefined;
530
- description?: string | undefined;
531
- }> | undefined;
532
- securitySchemes?: string[] | undefined;
533
- selectedSecuritySchemeUids?: (string | string[])[] | undefined;
534
- selectedServerUid?: string | undefined;
535
- servers?: string[] | undefined;
536
- requests?: string[] | undefined;
537
- tags?: string[] | undefined;
538
- documentUrl?: string | undefined;
539
- watchMode?: boolean | undefined;
540
- integration?: string | null | undefined;
541
- watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
542
- }, "watchMode" | "documentUrl"> & Pick<ReferenceConfiguration, "servers" | "authentication" | "baseServerURL"> & {
543
- setCollectionSecurity?: boolean;
544
- shouldLoad?: boolean;
545
- } & Pick<ReferenceConfiguration, "servers">, "documentUrl"> & Pick<ReferenceConfiguration, "proxyUrl">) => Promise<ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
546
- type?: "collection" | undefined;
547
- uid?: string | undefined;
548
- externalDocs?: {
549
- description?: string | undefined;
550
- url?: string | undefined;
551
- } | undefined;
552
- children?: string[] | undefined;
553
- openapi?: string | undefined;
554
- jsonSchemaDialect?: string | undefined;
555
- info?: {
556
- description?: string | undefined;
557
- title?: string | undefined;
558
- summary?: string | undefined;
559
- termsOfService?: string | undefined;
560
- contact?: {
561
- name?: string | undefined;
562
- url?: string | undefined;
563
- email?: string | undefined;
564
- } | undefined;
565
- license?: {
566
- name?: string | undefined;
567
- identifier?: string | undefined;
568
- url?: string | undefined;
569
- } | undefined;
570
- version?: string | undefined;
571
- } | undefined;
572
- security?: Record<string, string[] | undefined>[] | undefined;
573
- components?: Record<string, unknown> | undefined;
574
- webhooks?: Record<string, unknown> | undefined;
575
- "x-scalar-icon"?: string | undefined;
576
- "x-scalar-active-environment"?: string | undefined;
577
- "x-scalar-environments"?: Record<string, {
578
- variables: Record<string, string | {
579
- default?: string | undefined;
580
- description?: string | undefined;
581
- }>;
582
- description?: string | undefined;
583
- color?: string | undefined;
584
- }> | undefined;
585
- "x-scalar-secrets"?: Record<string, {
586
- example?: string | undefined;
587
- description?: string | undefined;
588
- }> | undefined;
589
- securitySchemes?: string[] | undefined;
590
- selectedSecuritySchemeUids?: (string | string[])[] | undefined;
591
- selectedServerUid?: string | undefined;
592
- servers?: string[] | undefined;
593
- requests?: string[] | undefined;
594
- tags?: string[] | undefined;
595
- documentUrl?: string | undefined;
596
- watchMode?: boolean | undefined;
597
- integration?: string | null | undefined;
598
- watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
599
- }, "watchMode" | "documentUrl"> & Pick<ReferenceConfiguration, "servers" | "authentication" | "baseServerURL"> & {
600
- setCollectionSecurity?: boolean;
601
- shouldLoad?: boolean;
602
- } & Pick<ReferenceConfiguration, "servers">) => Promise<{
603
- error: false;
604
- collection: Collection;
605
- requests: Request_2[];
606
- schema: OpenAPIV3_1.Document;
607
- examples: RequestExample[];
608
- servers: Server[];
609
- tags: Tag[];
610
- securitySchemes: SecurityScheme[];
611
- } | undefined>>>>>;
612
- cookieMutators: {
613
- add: (item: {
614
- value: string;
615
- uid: string & BRAND<"cookie">;
616
- name: string;
617
- path?: string | undefined;
618
- domain?: string | undefined;
619
- }) => void;
620
- delete: (uid: (string & BRAND<"cookie">) | null | undefined) => void;
621
- set: (item: {
622
- value: string;
623
- uid: string & BRAND<"cookie">;
624
- name: string;
625
- path?: string | undefined;
626
- domain?: string | undefined;
627
- }) => void;
628
- edit: <P extends "name" | "uid" | "path" | "value" | "domain">(uid: (string & BRAND<"cookie">) | null | undefined, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" ? {
629
- value: string;
630
- uid: string & BRAND<"cookie">;
631
- name: string;
632
- path?: string | undefined;
633
- domain?: string | undefined;
634
- }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" ? R extends Path< {
635
- value: string;
636
- uid: string & BRAND<"cookie">;
637
- name: string;
638
- path?: string | undefined;
639
- domain?: string | undefined;
640
- }[K]> ? PathValue< {
641
- value: string;
642
- uid: string & BRAND<"cookie">;
643
- name: string;
644
- path?: string | undefined;
645
- domain?: string | undefined;
646
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
647
- untrackedEdit: <P extends "name" | "uid" | "path" | "value" | "domain">(uid: string & BRAND<"cookie">, path: P, value: P extends "name" | "uid" | "path" | "value" | "domain" ? {
648
- value: string;
649
- uid: string & BRAND<"cookie">;
650
- name: string;
651
- path?: string | undefined;
652
- domain?: string | undefined;
653
- }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "path" | "value" | "domain" ? R extends Path< {
654
- value: string;
655
- uid: string & BRAND<"cookie">;
656
- name: string;
657
- path?: string | undefined;
658
- domain?: string | undefined;
659
- }[K]> ? PathValue< {
660
- value: string;
661
- uid: string & BRAND<"cookie">;
662
- name: string;
663
- path?: string | undefined;
664
- domain?: string | undefined;
665
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
666
- undo: (uid: string & BRAND<"cookie">) => void;
667
- redo: (uid: string & BRAND<"cookie">) => void;
668
- reset: () => void;
669
- };
670
- collectionMutators: {
671
- rawAdd: (item: {
672
- type: "collection";
673
- uid: string & BRAND<"collection">;
674
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
675
- openapi: string;
676
- security: Record<string, string[]>[];
677
- "x-scalar-icon": string;
678
- securitySchemes: string[];
679
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
680
- servers: (string & BRAND<"server">)[];
681
- requests: (string & BRAND<"operation">)[];
682
- tags: (string & BRAND<"tag">)[];
683
- watchMode: boolean;
684
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
685
- externalDocs?: {
686
- url: string;
687
- description?: string | undefined;
688
- } | undefined;
689
- jsonSchemaDialect?: string | undefined;
690
- info?: {
691
- title: string;
692
- version: string;
693
- description?: string | undefined;
694
- summary?: string | undefined;
695
- termsOfService?: string | undefined;
696
- contact?: {
697
- name?: string | undefined;
698
- url?: string | undefined;
699
- email?: string | undefined;
700
- } | undefined;
701
- license?: {
702
- name: string;
703
- identifier?: string | undefined;
704
- url?: string | undefined;
705
- } | undefined;
706
- } | undefined;
707
- components?: Record<string, unknown> | undefined;
708
- webhooks?: Record<string, unknown> | undefined;
709
- "x-scalar-active-environment"?: string | undefined;
710
- "x-scalar-environments"?: Record<string, {
711
- variables: Record<string, string | {
712
- default: string;
713
- description?: string | undefined;
714
- }>;
715
- description?: string | undefined;
716
- color?: string | undefined;
717
- }> | undefined;
718
- "x-scalar-secrets"?: Record<string, {
719
- example?: string | undefined;
720
- description?: string | undefined;
721
- }> | undefined;
722
- selectedServerUid?: (string & BRAND<"server">) | undefined;
723
- documentUrl?: string | undefined;
724
- integration?: string | null | undefined;
725
- }) => void;
726
- add: (payload: CollectionPayload, workspaceUid: Workspace["uid"]) => {
727
- type: "collection";
728
- uid: string & BRAND<"collection">;
729
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
730
- openapi: string;
731
- security: Record<string, string[]>[];
732
- "x-scalar-icon": string;
733
- securitySchemes: string[];
734
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
735
- servers: (string & BRAND<"server">)[];
736
- requests: (string & BRAND<"operation">)[];
737
- tags: (string & BRAND<"tag">)[];
738
- watchMode: boolean;
739
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
740
- externalDocs?: {
741
- url: string;
742
- description?: string | undefined;
743
- } | undefined;
744
- jsonSchemaDialect?: string | undefined;
745
- info?: {
746
- title: string;
747
- version: string;
748
- description?: string | undefined;
749
- summary?: string | undefined;
750
- termsOfService?: string | undefined;
751
- contact?: {
752
- name?: string | undefined;
753
- url?: string | undefined;
754
- email?: string | undefined;
755
- } | undefined;
756
- license?: {
757
- name: string;
758
- identifier?: string | undefined;
759
- url?: string | undefined;
760
- } | undefined;
761
- } | undefined;
762
- components?: Record<string, unknown> | undefined;
763
- webhooks?: Record<string, unknown> | undefined;
764
- "x-scalar-active-environment"?: string | undefined;
765
- "x-scalar-environments"?: Record<string, {
766
- variables: Record<string, string | {
767
- default: string;
768
- description?: string | undefined;
769
- }>;
770
- description?: string | undefined;
771
- color?: string | undefined;
772
- }> | undefined;
773
- "x-scalar-secrets"?: Record<string, {
774
- example?: string | undefined;
775
- description?: string | undefined;
776
- }> | undefined;
777
- selectedServerUid?: (string & BRAND<"server">) | undefined;
778
- documentUrl?: string | undefined;
779
- integration?: string | null | undefined;
780
- };
781
- delete: (collection: Collection, workspace: Workspace) => void;
782
- addEnvironment: (environmentName: string, environment: XScalarEnvironment, collectionUid: Collection["uid"]) => void;
783
- removeEnvironment: (environmentName: string, collectionUid: Collection["uid"]) => void;
784
- set: (item: {
785
- type: "collection";
786
- uid: string & BRAND<"collection">;
787
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
788
- openapi: string;
789
- security: Record<string, string[]>[];
790
- "x-scalar-icon": string;
791
- securitySchemes: string[];
792
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
793
- servers: (string & BRAND<"server">)[];
794
- requests: (string & BRAND<"operation">)[];
795
- tags: (string & BRAND<"tag">)[];
796
- watchMode: boolean;
797
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
798
- externalDocs?: {
799
- url: string;
800
- description?: string | undefined;
801
- } | undefined;
802
- jsonSchemaDialect?: string | undefined;
803
- info?: {
804
- title: string;
805
- version: string;
806
- description?: string | undefined;
807
- summary?: string | undefined;
808
- termsOfService?: string | undefined;
809
- contact?: {
810
- name?: string | undefined;
811
- url?: string | undefined;
812
- email?: string | undefined;
813
- } | undefined;
814
- license?: {
815
- name: string;
816
- identifier?: string | undefined;
817
- url?: string | undefined;
818
- } | undefined;
819
- } | undefined;
820
- components?: Record<string, unknown> | undefined;
821
- webhooks?: Record<string, unknown> | undefined;
822
- "x-scalar-active-environment"?: string | undefined;
823
- "x-scalar-environments"?: Record<string, {
824
- variables: Record<string, string | {
825
- default: string;
826
- description?: string | undefined;
827
- }>;
828
- description?: string | undefined;
829
- color?: string | undefined;
830
- }> | undefined;
831
- "x-scalar-secrets"?: Record<string, {
832
- example?: string | undefined;
833
- description?: string | undefined;
834
- }> | undefined;
835
- selectedServerUid?: (string & BRAND<"server">) | undefined;
836
- documentUrl?: string | undefined;
837
- integration?: string | null | undefined;
838
- }) => void;
839
- edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & BRAND<"collection">) | null | undefined, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
840
- type: "collection";
841
- uid: string & BRAND<"collection">;
842
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
843
- openapi: string;
844
- security: Record<string, string[]>[];
845
- "x-scalar-icon": string;
846
- securitySchemes: string[];
847
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
848
- servers: (string & BRAND<"server">)[];
849
- requests: (string & BRAND<"operation">)[];
850
- tags: (string & BRAND<"tag">)[];
851
- watchMode: boolean;
852
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
853
- externalDocs?: {
854
- url: string;
855
- description?: string | undefined;
856
- } | undefined;
857
- jsonSchemaDialect?: string | undefined;
858
- info?: {
859
- title: string;
860
- version: string;
861
- description?: string | undefined;
862
- summary?: string | undefined;
863
- termsOfService?: string | undefined;
864
- contact?: {
865
- name?: string | undefined;
866
- url?: string | undefined;
867
- email?: string | undefined;
868
- } | undefined;
869
- license?: {
870
- name: string;
871
- identifier?: string | undefined;
872
- url?: string | undefined;
873
- } | undefined;
874
- } | undefined;
875
- components?: Record<string, unknown> | undefined;
876
- webhooks?: Record<string, unknown> | undefined;
877
- "x-scalar-active-environment"?: string | undefined;
878
- "x-scalar-environments"?: Record<string, {
879
- variables: Record<string, string | {
880
- default: string;
881
- description?: string | undefined;
882
- }>;
883
- description?: string | undefined;
884
- color?: string | undefined;
885
- }> | undefined;
886
- "x-scalar-secrets"?: Record<string, {
887
- example?: string | undefined;
888
- description?: string | undefined;
889
- }> | undefined;
890
- selectedServerUid?: (string & BRAND<"server">) | undefined;
891
- documentUrl?: string | undefined;
892
- integration?: string | null | undefined;
893
- }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends Path< {
894
- type: "collection";
895
- uid: string & BRAND<"collection">;
896
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
897
- openapi: string;
898
- security: Record<string, string[]>[];
899
- "x-scalar-icon": string;
900
- securitySchemes: string[];
901
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
902
- servers: (string & BRAND<"server">)[];
903
- requests: (string & BRAND<"operation">)[];
904
- tags: (string & BRAND<"tag">)[];
905
- watchMode: boolean;
906
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
907
- externalDocs?: {
908
- url: string;
909
- description?: string | undefined;
910
- } | undefined;
911
- jsonSchemaDialect?: string | undefined;
912
- info?: {
913
- title: string;
914
- version: string;
915
- description?: string | undefined;
916
- summary?: string | undefined;
917
- termsOfService?: string | undefined;
918
- contact?: {
919
- name?: string | undefined;
920
- url?: string | undefined;
921
- email?: string | undefined;
922
- } | undefined;
923
- license?: {
924
- name: string;
925
- identifier?: string | undefined;
926
- url?: string | undefined;
927
- } | undefined;
928
- } | undefined;
929
- components?: Record<string, unknown> | undefined;
930
- webhooks?: Record<string, unknown> | undefined;
931
- "x-scalar-active-environment"?: string | undefined;
932
- "x-scalar-environments"?: Record<string, {
933
- variables: Record<string, string | {
934
- default: string;
935
- description?: string | undefined;
936
- }>;
937
- description?: string | undefined;
938
- color?: string | undefined;
939
- }> | undefined;
940
- "x-scalar-secrets"?: Record<string, {
941
- example?: string | undefined;
942
- description?: string | undefined;
943
- }> | undefined;
944
- selectedServerUid?: (string & BRAND<"server">) | undefined;
945
- documentUrl?: string | undefined;
946
- integration?: string | null | undefined;
947
- }[K]> ? PathValue< {
948
- type: "collection";
949
- uid: string & BRAND<"collection">;
950
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
951
- openapi: string;
952
- security: Record<string, string[]>[];
953
- "x-scalar-icon": string;
954
- securitySchemes: string[];
955
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
956
- servers: (string & BRAND<"server">)[];
957
- requests: (string & BRAND<"operation">)[];
958
- tags: (string & BRAND<"tag">)[];
959
- watchMode: boolean;
960
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
961
- externalDocs?: {
962
- url: string;
963
- description?: string | undefined;
964
- } | undefined;
965
- jsonSchemaDialect?: string | undefined;
966
- info?: {
967
- title: string;
968
- version: string;
969
- description?: string | undefined;
970
- summary?: string | undefined;
971
- termsOfService?: string | undefined;
972
- contact?: {
973
- name?: string | undefined;
974
- url?: string | undefined;
975
- email?: string | undefined;
976
- } | undefined;
977
- license?: {
978
- name: string;
979
- identifier?: string | undefined;
980
- url?: string | undefined;
981
- } | undefined;
982
- } | undefined;
983
- components?: Record<string, unknown> | undefined;
984
- webhooks?: Record<string, unknown> | undefined;
985
- "x-scalar-active-environment"?: string | undefined;
986
- "x-scalar-environments"?: Record<string, {
987
- variables: Record<string, string | {
988
- default: string;
989
- description?: string | undefined;
990
- }>;
991
- description?: string | undefined;
992
- color?: string | undefined;
993
- }> | undefined;
994
- "x-scalar-secrets"?: Record<string, {
995
- example?: string | undefined;
996
- description?: string | undefined;
997
- }> | undefined;
998
- selectedServerUid?: (string & BRAND<"server">) | undefined;
999
- documentUrl?: string | undefined;
1000
- integration?: string | null | undefined;
1001
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1002
- untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | `securitySchemes.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "info.summary" | "info.description" | "info.title" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.contact.name" | "info.contact.url" | "info.contact.email" | "info.license.name" | "info.license.url" | "info.license.identifier" | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & BRAND<"collection">, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? {
1003
- type: "collection";
1004
- uid: string & BRAND<"collection">;
1005
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
1006
- openapi: string;
1007
- security: Record<string, string[]>[];
1008
- "x-scalar-icon": string;
1009
- securitySchemes: string[];
1010
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1011
- servers: (string & BRAND<"server">)[];
1012
- requests: (string & BRAND<"operation">)[];
1013
- tags: (string & BRAND<"tag">)[];
1014
- watchMode: boolean;
1015
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
1016
- externalDocs?: {
1017
- url: string;
1018
- description?: string | undefined;
1019
- } | undefined;
1020
- jsonSchemaDialect?: string | undefined;
1021
- info?: {
1022
- title: string;
1023
- version: string;
1024
- description?: string | undefined;
1025
- summary?: string | undefined;
1026
- termsOfService?: string | undefined;
1027
- contact?: {
1028
- name?: string | undefined;
1029
- url?: string | undefined;
1030
- email?: string | undefined;
1031
- } | undefined;
1032
- license?: {
1033
- name: string;
1034
- identifier?: string | undefined;
1035
- url?: string | undefined;
1036
- } | undefined;
1037
- } | undefined;
1038
- components?: Record<string, unknown> | undefined;
1039
- webhooks?: Record<string, unknown> | undefined;
1040
- "x-scalar-active-environment"?: string | undefined;
1041
- "x-scalar-environments"?: Record<string, {
1042
- variables: Record<string, string | {
1043
- default: string;
1044
- description?: string | undefined;
1045
- }>;
1046
- description?: string | undefined;
1047
- color?: string | undefined;
1048
- }> | undefined;
1049
- "x-scalar-secrets"?: Record<string, {
1050
- example?: string | undefined;
1051
- description?: string | undefined;
1052
- }> | undefined;
1053
- selectedServerUid?: (string & BRAND<"server">) | undefined;
1054
- documentUrl?: string | undefined;
1055
- integration?: string | null | undefined;
1056
- }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "x-scalar-icon" | "securitySchemes" | "selectedSecuritySchemeUids" | "watchMode" | "watchModeStatus" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "selectedServerUid" | "documentUrl" | "integration" ? R extends Path< {
1057
- type: "collection";
1058
- uid: string & BRAND<"collection">;
1059
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
1060
- openapi: string;
1061
- security: Record<string, string[]>[];
1062
- "x-scalar-icon": string;
1063
- securitySchemes: string[];
1064
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1065
- servers: (string & BRAND<"server">)[];
1066
- requests: (string & BRAND<"operation">)[];
1067
- tags: (string & BRAND<"tag">)[];
1068
- watchMode: boolean;
1069
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
1070
- externalDocs?: {
1071
- url: string;
1072
- description?: string | undefined;
1073
- } | undefined;
1074
- jsonSchemaDialect?: string | undefined;
1075
- info?: {
1076
- title: string;
1077
- version: string;
1078
- description?: string | undefined;
1079
- summary?: string | undefined;
1080
- termsOfService?: string | undefined;
1081
- contact?: {
1082
- name?: string | undefined;
1083
- url?: string | undefined;
1084
- email?: string | undefined;
1085
- } | undefined;
1086
- license?: {
1087
- name: string;
1088
- identifier?: string | undefined;
1089
- url?: string | undefined;
1090
- } | undefined;
1091
- } | undefined;
1092
- components?: Record<string, unknown> | undefined;
1093
- webhooks?: Record<string, unknown> | undefined;
1094
- "x-scalar-active-environment"?: string | undefined;
1095
- "x-scalar-environments"?: Record<string, {
1096
- variables: Record<string, string | {
1097
- default: string;
1098
- description?: string | undefined;
1099
- }>;
1100
- description?: string | undefined;
1101
- color?: string | undefined;
1102
- }> | undefined;
1103
- "x-scalar-secrets"?: Record<string, {
1104
- example?: string | undefined;
1105
- description?: string | undefined;
1106
- }> | undefined;
1107
- selectedServerUid?: (string & BRAND<"server">) | undefined;
1108
- documentUrl?: string | undefined;
1109
- integration?: string | null | undefined;
1110
- }[K]> ? PathValue< {
1111
- type: "collection";
1112
- uid: string & BRAND<"collection">;
1113
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
1114
- openapi: string;
1115
- security: Record<string, string[]>[];
1116
- "x-scalar-icon": string;
1117
- securitySchemes: string[];
1118
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1119
- servers: (string & BRAND<"server">)[];
1120
- requests: (string & BRAND<"operation">)[];
1121
- tags: (string & BRAND<"tag">)[];
1122
- watchMode: boolean;
1123
- watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
1124
- externalDocs?: {
1125
- url: string;
1126
- description?: string | undefined;
1127
- } | undefined;
1128
- jsonSchemaDialect?: string | undefined;
1129
- info?: {
1130
- title: string;
1131
- version: string;
1132
- description?: string | undefined;
1133
- summary?: string | undefined;
1134
- termsOfService?: string | undefined;
1135
- contact?: {
1136
- name?: string | undefined;
1137
- url?: string | undefined;
1138
- email?: string | undefined;
1139
- } | undefined;
1140
- license?: {
1141
- name: string;
1142
- identifier?: string | undefined;
1143
- url?: string | undefined;
1144
- } | undefined;
1145
- } | undefined;
1146
- components?: Record<string, unknown> | undefined;
1147
- webhooks?: Record<string, unknown> | undefined;
1148
- "x-scalar-active-environment"?: string | undefined;
1149
- "x-scalar-environments"?: Record<string, {
1150
- variables: Record<string, string | {
1151
- default: string;
1152
- description?: string | undefined;
1153
- }>;
1154
- description?: string | undefined;
1155
- color?: string | undefined;
1156
- }> | undefined;
1157
- "x-scalar-secrets"?: Record<string, {
1158
- example?: string | undefined;
1159
- description?: string | undefined;
1160
- }> | undefined;
1161
- selectedServerUid?: (string & BRAND<"server">) | undefined;
1162
- documentUrl?: string | undefined;
1163
- integration?: string | null | undefined;
1164
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1165
- undo: (uid: string & BRAND<"collection">) => void;
1166
- redo: (uid: string & BRAND<"collection">) => void;
1167
- reset: () => void;
1168
- };
1169
- environmentMutators: {
1170
- delete: (uid: Environment["uid"]) => void;
1171
- add: (item: {
1172
- value: string;
1173
- uid: string & BRAND<"environment">;
1174
- name: string;
1175
- color: string;
1176
- isDefault?: boolean | undefined;
1177
- }) => void;
1178
- set: (item: {
1179
- value: string;
1180
- uid: string & BRAND<"environment">;
1181
- name: string;
1182
- color: string;
1183
- isDefault?: boolean | undefined;
1184
- }) => void;
1185
- edit: <P extends "name" | "uid" | "color" | "value" | "isDefault">(uid: (string & BRAND<"environment">) | null | undefined, path: P, value: P extends "name" | "uid" | "color" | "value" | "isDefault" ? {
1186
- value: string;
1187
- uid: string & BRAND<"environment">;
1188
- name: string;
1189
- color: string;
1190
- isDefault?: boolean | undefined;
1191
- }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "color" | "value" | "isDefault" ? R extends Path< {
1192
- value: string;
1193
- uid: string & BRAND<"environment">;
1194
- name: string;
1195
- color: string;
1196
- isDefault?: boolean | undefined;
1197
- }[K]> ? PathValue< {
1198
- value: string;
1199
- uid: string & BRAND<"environment">;
1200
- name: string;
1201
- color: string;
1202
- isDefault?: boolean | undefined;
1203
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1204
- untrackedEdit: <P extends "name" | "uid" | "color" | "value" | "isDefault">(uid: string & BRAND<"environment">, path: P, value: P extends "name" | "uid" | "color" | "value" | "isDefault" ? {
1205
- value: string;
1206
- uid: string & BRAND<"environment">;
1207
- name: string;
1208
- color: string;
1209
- isDefault?: boolean | undefined;
1210
- }[P] : P extends `${infer K}.${infer R}` ? K extends "name" | "uid" | "color" | "value" | "isDefault" ? R extends Path< {
1211
- value: string;
1212
- uid: string & BRAND<"environment">;
1213
- name: string;
1214
- color: string;
1215
- isDefault?: boolean | undefined;
1216
- }[K]> ? PathValue< {
1217
- value: string;
1218
- uid: string & BRAND<"environment">;
1219
- name: string;
1220
- color: string;
1221
- isDefault?: boolean | undefined;
1222
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1223
- undo: (uid: string & BRAND<"environment">) => void;
1224
- redo: (uid: string & BRAND<"environment">) => void;
1225
- reset: () => void;
1226
- };
1227
- requestMutators: {
1228
- rawAdd: (item: {
1229
- path: string;
1230
- type: "request";
1231
- uid: string & BRAND<"operation">;
1232
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1233
- selectedServerUid: (string & BRAND<"server">) | null;
1234
- servers: (string & BRAND<"server">)[];
1235
- examples: (string & BRAND<"example">)[];
1236
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1237
- description?: string | undefined;
1238
- summary?: string | undefined;
1239
- externalDocs?: {
1240
- url: string;
1241
- description?: string | undefined;
1242
- } | undefined;
1243
- "x-internal"?: boolean | undefined;
1244
- "x-scalar-ignore"?: boolean | undefined;
1245
- security?: Record<string, string[]>[] | undefined;
1246
- tags?: string[] | undefined;
1247
- deprecated?: boolean | undefined;
1248
- operationId?: string | undefined;
1249
- parameters?: {
1250
- required: boolean;
1251
- name: string;
1252
- in: "path" | "cookie" | "query" | "header";
1253
- deprecated: boolean;
1254
- example?: unknown;
1255
- description?: string | undefined;
1256
- schema?: unknown;
1257
- content?: unknown;
1258
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1259
- examples?: Record<string, {
1260
- value?: unknown;
1261
- summary?: string | undefined;
1262
- }> | undefined;
1263
- }[] | undefined;
1264
- requestBody?: any;
1265
- responses?: Record<string, any> | undefined;
1266
- }) => void;
1267
- add: (payload: RequestPayload, collectionUid: Collection["uid"]) => void | {
1268
- path: string;
1269
- type: "request";
1270
- uid: string & BRAND<"operation">;
1271
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1272
- selectedServerUid: (string & BRAND<"server">) | null;
1273
- servers: (string & BRAND<"server">)[];
1274
- examples: (string & BRAND<"example">)[];
1275
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1276
- description?: string | undefined;
1277
- summary?: string | undefined;
1278
- externalDocs?: {
1279
- url: string;
1280
- description?: string | undefined;
1281
- } | undefined;
1282
- "x-internal"?: boolean | undefined;
1283
- "x-scalar-ignore"?: boolean | undefined;
1284
- security?: Record<string, string[]>[] | undefined;
1285
- tags?: string[] | undefined;
1286
- deprecated?: boolean | undefined;
1287
- operationId?: string | undefined;
1288
- parameters?: {
1289
- required: boolean;
1290
- name: string;
1291
- in: "path" | "cookie" | "query" | "header";
1292
- deprecated: boolean;
1293
- example?: unknown;
1294
- description?: string | undefined;
1295
- schema?: unknown;
1296
- content?: unknown;
1297
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1298
- examples?: Record<string, {
1299
- value?: unknown;
1300
- summary?: string | undefined;
1301
- }> | undefined;
1302
- }[] | undefined;
1303
- requestBody?: any;
1304
- responses?: Record<string, any> | undefined;
1305
- };
1306
- delete: (request: Request_2, collectionUid: Collection["uid"]) => void;
1307
- set: (item: {
1308
- path: string;
1309
- type: "request";
1310
- uid: string & BRAND<"operation">;
1311
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1312
- selectedServerUid: (string & BRAND<"server">) | null;
1313
- servers: (string & BRAND<"server">)[];
1314
- examples: (string & BRAND<"example">)[];
1315
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1316
- description?: string | undefined;
1317
- summary?: string | undefined;
1318
- externalDocs?: {
1319
- url: string;
1320
- description?: string | undefined;
1321
- } | undefined;
1322
- "x-internal"?: boolean | undefined;
1323
- "x-scalar-ignore"?: boolean | undefined;
1324
- security?: Record<string, string[]>[] | undefined;
1325
- tags?: string[] | undefined;
1326
- deprecated?: boolean | undefined;
1327
- operationId?: string | undefined;
1328
- parameters?: {
1329
- required: boolean;
1330
- name: string;
1331
- in: "path" | "cookie" | "query" | "header";
1332
- deprecated: boolean;
1333
- example?: unknown;
1334
- description?: string | undefined;
1335
- schema?: unknown;
1336
- content?: unknown;
1337
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1338
- examples?: Record<string, {
1339
- value?: unknown;
1340
- summary?: string | undefined;
1341
- }> | undefined;
1342
- }[] | undefined;
1343
- requestBody?: any;
1344
- responses?: Record<string, any> | undefined;
1345
- }) => void;
1346
- edit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "path" | "method" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: (string & BRAND<"operation">) | null | undefined, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "path" | "method" | "examples" ? {
1347
- path: string;
1348
- type: "request";
1349
- uid: string & BRAND<"operation">;
1350
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1351
- selectedServerUid: (string & BRAND<"server">) | null;
1352
- servers: (string & BRAND<"server">)[];
1353
- examples: (string & BRAND<"example">)[];
1354
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1355
- description?: string | undefined;
1356
- summary?: string | undefined;
1357
- externalDocs?: {
1358
- url: string;
1359
- description?: string | undefined;
1360
- } | undefined;
1361
- "x-internal"?: boolean | undefined;
1362
- "x-scalar-ignore"?: boolean | undefined;
1363
- security?: Record<string, string[]>[] | undefined;
1364
- tags?: string[] | undefined;
1365
- deprecated?: boolean | undefined;
1366
- operationId?: string | undefined;
1367
- parameters?: {
1368
- required: boolean;
1369
- name: string;
1370
- in: "path" | "cookie" | "query" | "header";
1371
- deprecated: boolean;
1372
- example?: unknown;
1373
- description?: string | undefined;
1374
- schema?: unknown;
1375
- content?: unknown;
1376
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1377
- examples?: Record<string, {
1378
- value?: unknown;
1379
- summary?: string | undefined;
1380
- }> | undefined;
1381
- }[] | undefined;
1382
- requestBody?: any;
1383
- responses?: Record<string, any> | undefined;
1384
- }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "path" | "method" | "examples" ? R extends Path< {
1385
- path: string;
1386
- type: "request";
1387
- uid: string & BRAND<"operation">;
1388
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1389
- selectedServerUid: (string & BRAND<"server">) | null;
1390
- servers: (string & BRAND<"server">)[];
1391
- examples: (string & BRAND<"example">)[];
1392
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1393
- description?: string | undefined;
1394
- summary?: string | undefined;
1395
- externalDocs?: {
1396
- url: string;
1397
- description?: string | undefined;
1398
- } | undefined;
1399
- "x-internal"?: boolean | undefined;
1400
- "x-scalar-ignore"?: boolean | undefined;
1401
- security?: Record<string, string[]>[] | undefined;
1402
- tags?: string[] | undefined;
1403
- deprecated?: boolean | undefined;
1404
- operationId?: string | undefined;
1405
- parameters?: {
1406
- required: boolean;
1407
- name: string;
1408
- in: "path" | "cookie" | "query" | "header";
1409
- deprecated: boolean;
1410
- example?: unknown;
1411
- description?: string | undefined;
1412
- schema?: unknown;
1413
- content?: unknown;
1414
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1415
- examples?: Record<string, {
1416
- value?: unknown;
1417
- summary?: string | undefined;
1418
- }> | undefined;
1419
- }[] | undefined;
1420
- requestBody?: any;
1421
- responses?: Record<string, any> | undefined;
1422
- }[K]> ? PathValue< {
1423
- path: string;
1424
- type: "request";
1425
- uid: string & BRAND<"operation">;
1426
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1427
- selectedServerUid: (string & BRAND<"server">) | null;
1428
- servers: (string & BRAND<"server">)[];
1429
- examples: (string & BRAND<"example">)[];
1430
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1431
- description?: string | undefined;
1432
- summary?: string | undefined;
1433
- externalDocs?: {
1434
- url: string;
1435
- description?: string | undefined;
1436
- } | undefined;
1437
- "x-internal"?: boolean | undefined;
1438
- "x-scalar-ignore"?: boolean | undefined;
1439
- security?: Record<string, string[]>[] | undefined;
1440
- tags?: string[] | undefined;
1441
- deprecated?: boolean | undefined;
1442
- operationId?: string | undefined;
1443
- parameters?: {
1444
- required: boolean;
1445
- name: string;
1446
- in: "path" | "cookie" | "query" | "header";
1447
- deprecated: boolean;
1448
- example?: unknown;
1449
- description?: string | undefined;
1450
- schema?: unknown;
1451
- content?: unknown;
1452
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1453
- examples?: Record<string, {
1454
- value?: unknown;
1455
- summary?: string | undefined;
1456
- }> | undefined;
1457
- }[] | undefined;
1458
- requestBody?: any;
1459
- responses?: Record<string, any> | undefined;
1460
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1461
- untrackedEdit: <P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "path" | "method" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string & BRAND<"operation">, path: P, value: P extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "path" | "method" | "examples" ? {
1462
- path: string;
1463
- type: "request";
1464
- uid: string & BRAND<"operation">;
1465
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1466
- selectedServerUid: (string & BRAND<"server">) | null;
1467
- servers: (string & BRAND<"server">)[];
1468
- examples: (string & BRAND<"example">)[];
1469
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1470
- description?: string | undefined;
1471
- summary?: string | undefined;
1472
- externalDocs?: {
1473
- url: string;
1474
- description?: string | undefined;
1475
- } | undefined;
1476
- "x-internal"?: boolean | undefined;
1477
- "x-scalar-ignore"?: boolean | undefined;
1478
- security?: Record<string, string[]>[] | undefined;
1479
- tags?: string[] | undefined;
1480
- deprecated?: boolean | undefined;
1481
- operationId?: string | undefined;
1482
- parameters?: {
1483
- required: boolean;
1484
- name: string;
1485
- in: "path" | "cookie" | "query" | "header";
1486
- deprecated: boolean;
1487
- example?: unknown;
1488
- description?: string | undefined;
1489
- schema?: unknown;
1490
- content?: unknown;
1491
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1492
- examples?: Record<string, {
1493
- value?: unknown;
1494
- summary?: string | undefined;
1495
- }> | undefined;
1496
- }[] | undefined;
1497
- requestBody?: any;
1498
- responses?: Record<string, any> | undefined;
1499
- }[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "selectedServerUid" | "path" | "method" | "examples" ? R extends Path< {
1500
- path: string;
1501
- type: "request";
1502
- uid: string & BRAND<"operation">;
1503
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1504
- selectedServerUid: (string & BRAND<"server">) | null;
1505
- servers: (string & BRAND<"server">)[];
1506
- examples: (string & BRAND<"example">)[];
1507
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1508
- description?: string | undefined;
1509
- summary?: string | undefined;
1510
- externalDocs?: {
1511
- url: string;
1512
- description?: string | undefined;
1513
- } | undefined;
1514
- "x-internal"?: boolean | undefined;
1515
- "x-scalar-ignore"?: boolean | undefined;
1516
- security?: Record<string, string[]>[] | undefined;
1517
- tags?: string[] | undefined;
1518
- deprecated?: boolean | undefined;
1519
- operationId?: string | undefined;
1520
- parameters?: {
1521
- required: boolean;
1522
- name: string;
1523
- in: "path" | "cookie" | "query" | "header";
1524
- deprecated: boolean;
1525
- example?: unknown;
1526
- description?: string | undefined;
1527
- schema?: unknown;
1528
- content?: unknown;
1529
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1530
- examples?: Record<string, {
1531
- value?: unknown;
1532
- summary?: string | undefined;
1533
- }> | undefined;
1534
- }[] | undefined;
1535
- requestBody?: any;
1536
- responses?: Record<string, any> | undefined;
1537
- }[K]> ? PathValue< {
1538
- path: string;
1539
- type: "request";
1540
- uid: string & BRAND<"operation">;
1541
- selectedSecuritySchemeUids: ((string & BRAND<"securityScheme">) | (string & BRAND<"securityScheme">)[])[];
1542
- selectedServerUid: (string & BRAND<"server">) | null;
1543
- servers: (string & BRAND<"server">)[];
1544
- examples: (string & BRAND<"example">)[];
1545
- method: "options" | "connect" | "delete" | "get" | "head" | "patch" | "post" | "put" | "trace";
1546
- description?: string | undefined;
1547
- summary?: string | undefined;
1548
- externalDocs?: {
1549
- url: string;
1550
- description?: string | undefined;
1551
- } | undefined;
1552
- "x-internal"?: boolean | undefined;
1553
- "x-scalar-ignore"?: boolean | undefined;
1554
- security?: Record<string, string[]>[] | undefined;
1555
- tags?: string[] | undefined;
1556
- deprecated?: boolean | undefined;
1557
- operationId?: string | undefined;
1558
- parameters?: {
1559
- required: boolean;
1560
- name: string;
1561
- in: "path" | "cookie" | "query" | "header";
1562
- deprecated: boolean;
1563
- example?: unknown;
1564
- description?: string | undefined;
1565
- schema?: unknown;
1566
- content?: unknown;
1567
- style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1568
- examples?: Record<string, {
1569
- value?: unknown;
1570
- summary?: string | undefined;
1571
- }> | undefined;
1572
- }[] | undefined;
1573
- requestBody?: any;
1574
- responses?: Record<string, any> | undefined;
1575
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1576
- undo: (uid: string & BRAND<"operation">) => void;
1577
- redo: (uid: string & BRAND<"operation">) => void;
1578
- reset: () => void;
1579
- };
1580
- findRequestParents: (r: Request_2) => string[];
1581
- requestExampleMutators: {
1582
- rawAdd: (item: {
1583
- type: "requestExample";
1584
- uid: string & BRAND<"example">;
1585
- name: string;
1586
- parameters: {
1587
- path: {
1588
- value: string;
1589
- key: string;
1590
- enabled: boolean;
1591
- minimum?: number | undefined;
1592
- type?: string | string[] | undefined;
1593
- maximum?: number | undefined;
1594
- default?: any;
1595
- required?: boolean | undefined;
1596
- description?: string | undefined;
1597
- enum?: string[] | undefined;
1598
- examples?: string[] | undefined;
1599
- format?: string | undefined;
1600
- file?: any;
1601
- nullable?: boolean | undefined;
1602
- }[];
1603
- cookies: {
1604
- value: string;
1605
- key: string;
1606
- enabled: boolean;
1607
- minimum?: number | undefined;
1608
- type?: string | string[] | undefined;
1609
- maximum?: number | undefined;
1610
- default?: any;
1611
- required?: boolean | undefined;
1612
- description?: string | undefined;
1613
- enum?: string[] | undefined;
1614
- examples?: string[] | undefined;
1615
- format?: string | undefined;
1616
- file?: any;
1617
- nullable?: boolean | undefined;
1618
- }[];
1619
- query: {
1620
- value: string;
1621
- key: string;
1622
- enabled: boolean;
1623
- minimum?: number | undefined;
1624
- type?: string | string[] | undefined;
1625
- maximum?: number | undefined;
1626
- default?: any;
1627
- required?: boolean | undefined;
1628
- description?: string | undefined;
1629
- enum?: string[] | undefined;
1630
- examples?: string[] | undefined;
1631
- format?: string | undefined;
1632
- file?: any;
1633
- nullable?: boolean | undefined;
1634
- }[];
1635
- headers: {
1636
- value: string;
1637
- key: string;
1638
- enabled: boolean;
1639
- minimum?: number | undefined;
1640
- type?: string | string[] | undefined;
1641
- maximum?: number | undefined;
1642
- default?: any;
1643
- required?: boolean | undefined;
1644
- description?: string | undefined;
1645
- enum?: string[] | undefined;
1646
- examples?: string[] | undefined;
1647
- format?: string | undefined;
1648
- file?: any;
1649
- nullable?: boolean | undefined;
1650
- }[];
1651
- };
1652
- body: {
1653
- activeBody: "binary" | "formData" | "raw";
1654
- binary?: Blob | undefined;
1655
- formData?: {
1656
- value: {
1657
- value: string;
1658
- key: string;
1659
- enabled: boolean;
1660
- minimum?: number | undefined;
1661
- type?: string | string[] | undefined;
1662
- maximum?: number | undefined;
1663
- default?: any;
1664
- required?: boolean | undefined;
1665
- description?: string | undefined;
1666
- enum?: string[] | undefined;
1667
- examples?: string[] | undefined;
1668
- format?: string | undefined;
1669
- file?: any;
1670
- nullable?: boolean | undefined;
1671
- }[];
1672
- encoding: "form-data" | "urlencoded";
1673
- } | undefined;
1674
- raw?: {
1675
- value: string;
1676
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1677
- } | undefined;
1678
- };
1679
- requestUid?: (string & BRAND<"operation">) | undefined;
1680
- serverVariables?: Record<string, string[]> | undefined;
1681
- }) => void;
1682
- add: (request: Request_2, _name?: string) => {
1683
- type: "requestExample";
1684
- uid: string & BRAND<"example">;
1685
- name: string;
1686
- parameters: {
1687
- path: {
1688
- value: string;
1689
- key: string;
1690
- enabled: boolean;
1691
- minimum?: number | undefined;
1692
- type?: string | string[] | undefined;
1693
- maximum?: number | undefined;
1694
- default?: any;
1695
- required?: boolean | undefined;
1696
- description?: string | undefined;
1697
- enum?: string[] | undefined;
1698
- examples?: string[] | undefined;
1699
- format?: string | undefined;
1700
- file?: any;
1701
- nullable?: boolean | undefined;
1702
- }[];
1703
- cookies: {
1704
- value: string;
1705
- key: string;
1706
- enabled: boolean;
1707
- minimum?: number | undefined;
1708
- type?: string | string[] | undefined;
1709
- maximum?: number | undefined;
1710
- default?: any;
1711
- required?: boolean | undefined;
1712
- description?: string | undefined;
1713
- enum?: string[] | undefined;
1714
- examples?: string[] | undefined;
1715
- format?: string | undefined;
1716
- file?: any;
1717
- nullable?: boolean | undefined;
1718
- }[];
1719
- query: {
1720
- value: string;
1721
- key: string;
1722
- enabled: boolean;
1723
- minimum?: number | undefined;
1724
- type?: string | string[] | undefined;
1725
- maximum?: number | undefined;
1726
- default?: any;
1727
- required?: boolean | undefined;
1728
- description?: string | undefined;
1729
- enum?: string[] | undefined;
1730
- examples?: string[] | undefined;
1731
- format?: string | undefined;
1732
- file?: any;
1733
- nullable?: boolean | undefined;
1734
- }[];
1735
- headers: {
1736
- value: string;
1737
- key: string;
1738
- enabled: boolean;
1739
- minimum?: number | undefined;
1740
- type?: string | string[] | undefined;
1741
- maximum?: number | undefined;
1742
- default?: any;
1743
- required?: boolean | undefined;
1744
- description?: string | undefined;
1745
- enum?: string[] | undefined;
1746
- examples?: string[] | undefined;
1747
- format?: string | undefined;
1748
- file?: any;
1749
- nullable?: boolean | undefined;
1750
- }[];
1751
- };
1752
- body: {
1753
- activeBody: "binary" | "formData" | "raw";
1754
- binary?: Blob | undefined;
1755
- formData?: {
1756
- value: {
1757
- value: string;
1758
- key: string;
1759
- enabled: boolean;
1760
- minimum?: number | undefined;
1761
- type?: string | string[] | undefined;
1762
- maximum?: number | undefined;
1763
- default?: any;
1764
- required?: boolean | undefined;
1765
- description?: string | undefined;
1766
- enum?: string[] | undefined;
1767
- examples?: string[] | undefined;
1768
- format?: string | undefined;
1769
- file?: any;
1770
- nullable?: boolean | undefined;
1771
- }[];
1772
- encoding: "form-data" | "urlencoded";
1773
- } | undefined;
1774
- raw?: {
1775
- value: string;
1776
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1777
- } | undefined;
1778
- };
1779
- requestUid?: (string & BRAND<"operation">) | undefined;
1780
- serverVariables?: Record<string, string[]> | undefined;
1781
- };
1782
- delete: (requestExample: RequestExample) => void;
1783
- set: (item: {
1784
- type: "requestExample";
1785
- uid: string & BRAND<"example">;
1786
- name: string;
1787
- parameters: {
1788
- path: {
1789
- value: string;
1790
- key: string;
1791
- enabled: boolean;
1792
- minimum?: number | undefined;
1793
- type?: string | string[] | undefined;
1794
- maximum?: number | undefined;
1795
- default?: any;
1796
- required?: boolean | undefined;
1797
- description?: string | undefined;
1798
- enum?: string[] | undefined;
1799
- examples?: string[] | undefined;
1800
- format?: string | undefined;
1801
- file?: any;
1802
- nullable?: boolean | undefined;
1803
- }[];
1804
- cookies: {
1805
- value: string;
1806
- key: string;
1807
- enabled: boolean;
1808
- minimum?: number | undefined;
1809
- type?: string | string[] | undefined;
1810
- maximum?: number | undefined;
1811
- default?: any;
1812
- required?: boolean | undefined;
1813
- description?: string | undefined;
1814
- enum?: string[] | undefined;
1815
- examples?: string[] | undefined;
1816
- format?: string | undefined;
1817
- file?: any;
1818
- nullable?: boolean | undefined;
1819
- }[];
1820
- query: {
1821
- value: string;
1822
- key: string;
1823
- enabled: boolean;
1824
- minimum?: number | undefined;
1825
- type?: string | string[] | undefined;
1826
- maximum?: number | undefined;
1827
- default?: any;
1828
- required?: boolean | undefined;
1829
- description?: string | undefined;
1830
- enum?: string[] | undefined;
1831
- examples?: string[] | undefined;
1832
- format?: string | undefined;
1833
- file?: any;
1834
- nullable?: boolean | undefined;
1835
- }[];
1836
- headers: {
1837
- value: string;
1838
- key: string;
1839
- enabled: boolean;
1840
- minimum?: number | undefined;
1841
- type?: string | string[] | undefined;
1842
- maximum?: number | undefined;
1843
- default?: any;
1844
- required?: boolean | undefined;
1845
- description?: string | undefined;
1846
- enum?: string[] | undefined;
1847
- examples?: string[] | undefined;
1848
- format?: string | undefined;
1849
- file?: any;
1850
- nullable?: boolean | undefined;
1851
- }[];
1852
- };
1853
- body: {
1854
- activeBody: "binary" | "formData" | "raw";
1855
- binary?: Blob | undefined;
1856
- formData?: {
1857
- value: {
1858
- value: string;
1859
- key: string;
1860
- enabled: boolean;
1861
- minimum?: number | undefined;
1862
- type?: string | string[] | undefined;
1863
- maximum?: number | undefined;
1864
- default?: any;
1865
- required?: boolean | undefined;
1866
- description?: string | undefined;
1867
- enum?: string[] | undefined;
1868
- examples?: string[] | undefined;
1869
- format?: string | undefined;
1870
- file?: any;
1871
- nullable?: boolean | undefined;
1872
- }[];
1873
- encoding: "form-data" | "urlencoded";
1874
- } | undefined;
1875
- raw?: {
1876
- value: string;
1877
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1878
- } | undefined;
1879
- };
1880
- requestUid?: (string & BRAND<"operation">) | undefined;
1881
- serverVariables?: Record<string, string[]> | undefined;
1882
- }) => void;
1883
- edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.formData.value" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.examples.${number}` | `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.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.required` | `parameters.path.${number}.examples` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.examples.${number}` | `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.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.required` | `parameters.query.${number}.examples` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `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}.examples.${number}` | `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" | `serverVariables.${string}`>(uid: (string & BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
1884
- type: "requestExample";
1885
- uid: string & BRAND<"example">;
1886
- name: string;
1887
- parameters: {
1888
- path: {
1889
- value: string;
1890
- key: string;
1891
- enabled: boolean;
1892
- minimum?: number | undefined;
1893
- type?: string | string[] | undefined;
1894
- maximum?: number | undefined;
1895
- default?: any;
1896
- required?: boolean | undefined;
1897
- description?: string | undefined;
1898
- enum?: string[] | undefined;
1899
- examples?: string[] | undefined;
1900
- format?: string | undefined;
1901
- file?: any;
1902
- nullable?: boolean | undefined;
1903
- }[];
1904
- cookies: {
1905
- value: string;
1906
- key: string;
1907
- enabled: boolean;
1908
- minimum?: number | undefined;
1909
- type?: string | string[] | undefined;
1910
- maximum?: number | undefined;
1911
- default?: any;
1912
- required?: boolean | undefined;
1913
- description?: string | undefined;
1914
- enum?: string[] | undefined;
1915
- examples?: string[] | undefined;
1916
- format?: string | undefined;
1917
- file?: any;
1918
- nullable?: boolean | undefined;
1919
- }[];
1920
- query: {
1921
- value: string;
1922
- key: string;
1923
- enabled: boolean;
1924
- minimum?: number | undefined;
1925
- type?: string | string[] | undefined;
1926
- maximum?: number | undefined;
1927
- default?: any;
1928
- required?: boolean | undefined;
1929
- description?: string | undefined;
1930
- enum?: string[] | undefined;
1931
- examples?: string[] | undefined;
1932
- format?: string | undefined;
1933
- file?: any;
1934
- nullable?: boolean | undefined;
1935
- }[];
1936
- headers: {
1937
- value: string;
1938
- key: string;
1939
- enabled: boolean;
1940
- minimum?: number | undefined;
1941
- type?: string | string[] | undefined;
1942
- maximum?: number | undefined;
1943
- default?: any;
1944
- required?: boolean | undefined;
1945
- description?: string | undefined;
1946
- enum?: string[] | undefined;
1947
- examples?: string[] | undefined;
1948
- format?: string | undefined;
1949
- file?: any;
1950
- nullable?: boolean | undefined;
1951
- }[];
1952
- };
1953
- body: {
1954
- activeBody: "binary" | "formData" | "raw";
1955
- binary?: Blob | undefined;
1956
- formData?: {
1957
- value: {
1958
- value: string;
1959
- key: string;
1960
- enabled: boolean;
1961
- minimum?: number | undefined;
1962
- type?: string | string[] | undefined;
1963
- maximum?: number | undefined;
1964
- default?: any;
1965
- required?: boolean | undefined;
1966
- description?: string | undefined;
1967
- enum?: string[] | undefined;
1968
- examples?: string[] | undefined;
1969
- format?: string | undefined;
1970
- file?: any;
1971
- nullable?: boolean | undefined;
1972
- }[];
1973
- encoding: "form-data" | "urlencoded";
1974
- } | undefined;
1975
- raw?: {
1976
- value: string;
1977
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
1978
- } | undefined;
1979
- };
1980
- requestUid?: (string & BRAND<"operation">) | undefined;
1981
- serverVariables?: Record<string, string[]> | undefined;
1982
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path< {
1983
- type: "requestExample";
1984
- uid: string & BRAND<"example">;
1985
- name: string;
1986
- parameters: {
1987
- path: {
1988
- value: string;
1989
- key: string;
1990
- enabled: boolean;
1991
- minimum?: number | undefined;
1992
- type?: string | string[] | undefined;
1993
- maximum?: number | undefined;
1994
- default?: any;
1995
- required?: boolean | undefined;
1996
- description?: string | undefined;
1997
- enum?: string[] | undefined;
1998
- examples?: string[] | undefined;
1999
- format?: string | undefined;
2000
- file?: any;
2001
- nullable?: boolean | undefined;
2002
- }[];
2003
- cookies: {
2004
- value: string;
2005
- key: string;
2006
- enabled: boolean;
2007
- minimum?: number | undefined;
2008
- type?: string | string[] | undefined;
2009
- maximum?: number | undefined;
2010
- default?: any;
2011
- required?: boolean | undefined;
2012
- description?: string | undefined;
2013
- enum?: string[] | undefined;
2014
- examples?: string[] | undefined;
2015
- format?: string | undefined;
2016
- file?: any;
2017
- nullable?: boolean | undefined;
2018
- }[];
2019
- query: {
2020
- value: string;
2021
- key: string;
2022
- enabled: boolean;
2023
- minimum?: number | undefined;
2024
- type?: string | string[] | undefined;
2025
- maximum?: number | undefined;
2026
- default?: any;
2027
- required?: boolean | undefined;
2028
- description?: string | undefined;
2029
- enum?: string[] | undefined;
2030
- examples?: string[] | undefined;
2031
- format?: string | undefined;
2032
- file?: any;
2033
- nullable?: boolean | undefined;
2034
- }[];
2035
- headers: {
2036
- value: string;
2037
- key: string;
2038
- enabled: boolean;
2039
- minimum?: number | undefined;
2040
- type?: string | string[] | undefined;
2041
- maximum?: number | undefined;
2042
- default?: any;
2043
- required?: boolean | undefined;
2044
- description?: string | undefined;
2045
- enum?: string[] | undefined;
2046
- examples?: string[] | undefined;
2047
- format?: string | undefined;
2048
- file?: any;
2049
- nullable?: boolean | undefined;
2050
- }[];
2051
- };
2052
- body: {
2053
- activeBody: "binary" | "formData" | "raw";
2054
- binary?: Blob | undefined;
2055
- formData?: {
2056
- value: {
2057
- value: string;
2058
- key: string;
2059
- enabled: boolean;
2060
- minimum?: number | undefined;
2061
- type?: string | string[] | undefined;
2062
- maximum?: number | undefined;
2063
- default?: any;
2064
- required?: boolean | undefined;
2065
- description?: string | undefined;
2066
- enum?: string[] | undefined;
2067
- examples?: string[] | undefined;
2068
- format?: string | undefined;
2069
- file?: any;
2070
- nullable?: boolean | undefined;
2071
- }[];
2072
- encoding: "form-data" | "urlencoded";
2073
- } | undefined;
2074
- raw?: {
2075
- value: string;
2076
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2077
- } | undefined;
2078
- };
2079
- requestUid?: (string & BRAND<"operation">) | undefined;
2080
- serverVariables?: Record<string, string[]> | undefined;
2081
- }[K]> ? PathValue< {
2082
- type: "requestExample";
2083
- uid: string & BRAND<"example">;
2084
- name: string;
2085
- parameters: {
2086
- path: {
2087
- value: string;
2088
- key: string;
2089
- enabled: boolean;
2090
- minimum?: number | undefined;
2091
- type?: string | string[] | undefined;
2092
- maximum?: number | undefined;
2093
- default?: any;
2094
- required?: boolean | undefined;
2095
- description?: string | undefined;
2096
- enum?: string[] | undefined;
2097
- examples?: string[] | undefined;
2098
- format?: string | undefined;
2099
- file?: any;
2100
- nullable?: boolean | undefined;
2101
- }[];
2102
- cookies: {
2103
- value: string;
2104
- key: string;
2105
- enabled: boolean;
2106
- minimum?: number | undefined;
2107
- type?: string | string[] | undefined;
2108
- maximum?: number | undefined;
2109
- default?: any;
2110
- required?: boolean | undefined;
2111
- description?: string | undefined;
2112
- enum?: string[] | undefined;
2113
- examples?: string[] | undefined;
2114
- format?: string | undefined;
2115
- file?: any;
2116
- nullable?: boolean | undefined;
2117
- }[];
2118
- query: {
2119
- value: string;
2120
- key: string;
2121
- enabled: boolean;
2122
- minimum?: number | undefined;
2123
- type?: string | string[] | undefined;
2124
- maximum?: number | undefined;
2125
- default?: any;
2126
- required?: boolean | undefined;
2127
- description?: string | undefined;
2128
- enum?: string[] | undefined;
2129
- examples?: string[] | undefined;
2130
- format?: string | undefined;
2131
- file?: any;
2132
- nullable?: boolean | undefined;
2133
- }[];
2134
- headers: {
2135
- value: string;
2136
- key: string;
2137
- enabled: boolean;
2138
- minimum?: number | undefined;
2139
- type?: string | string[] | undefined;
2140
- maximum?: number | undefined;
2141
- default?: any;
2142
- required?: boolean | undefined;
2143
- description?: string | undefined;
2144
- enum?: string[] | undefined;
2145
- examples?: string[] | undefined;
2146
- format?: string | undefined;
2147
- file?: any;
2148
- nullable?: boolean | undefined;
2149
- }[];
2150
- };
2151
- body: {
2152
- activeBody: "binary" | "formData" | "raw";
2153
- binary?: Blob | undefined;
2154
- formData?: {
2155
- value: {
2156
- value: string;
2157
- key: string;
2158
- enabled: boolean;
2159
- minimum?: number | undefined;
2160
- type?: string | string[] | undefined;
2161
- maximum?: number | undefined;
2162
- default?: any;
2163
- required?: boolean | undefined;
2164
- description?: string | undefined;
2165
- enum?: string[] | undefined;
2166
- examples?: string[] | undefined;
2167
- format?: string | undefined;
2168
- file?: any;
2169
- nullable?: boolean | undefined;
2170
- }[];
2171
- encoding: "form-data" | "urlencoded";
2172
- } | undefined;
2173
- raw?: {
2174
- value: string;
2175
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2176
- } | undefined;
2177
- };
2178
- requestUid?: (string & BRAND<"operation">) | undefined;
2179
- serverVariables?: Record<string, string[]> | undefined;
2180
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2181
- untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "body.formData.value" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.path" | "parameters.headers" | "parameters.query" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.examples.${number}` | `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.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.required` | `parameters.path.${number}.examples` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.value` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.examples.${number}` | `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.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.value` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.required` | `parameters.query.${number}.examples` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.value` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.type" | "body.binary.size" | "body.binary.slice" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.value` | `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}.examples.${number}` | `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" | `serverVariables.${string}`>(uid: string & BRAND<"example">, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
2182
- type: "requestExample";
2183
- uid: string & BRAND<"example">;
2184
- name: string;
2185
- parameters: {
2186
- path: {
2187
- value: string;
2188
- key: string;
2189
- enabled: boolean;
2190
- minimum?: number | undefined;
2191
- type?: string | string[] | undefined;
2192
- maximum?: number | undefined;
2193
- default?: any;
2194
- required?: boolean | undefined;
2195
- description?: string | undefined;
2196
- enum?: string[] | undefined;
2197
- examples?: string[] | undefined;
2198
- format?: string | undefined;
2199
- file?: any;
2200
- nullable?: boolean | undefined;
2201
- }[];
2202
- cookies: {
2203
- value: string;
2204
- key: string;
2205
- enabled: boolean;
2206
- minimum?: number | undefined;
2207
- type?: string | string[] | undefined;
2208
- maximum?: number | undefined;
2209
- default?: any;
2210
- required?: boolean | undefined;
2211
- description?: string | undefined;
2212
- enum?: string[] | undefined;
2213
- examples?: string[] | undefined;
2214
- format?: string | undefined;
2215
- file?: any;
2216
- nullable?: boolean | undefined;
2217
- }[];
2218
- query: {
2219
- value: string;
2220
- key: string;
2221
- enabled: boolean;
2222
- minimum?: number | undefined;
2223
- type?: string | string[] | undefined;
2224
- maximum?: number | undefined;
2225
- default?: any;
2226
- required?: boolean | undefined;
2227
- description?: string | undefined;
2228
- enum?: string[] | undefined;
2229
- examples?: string[] | undefined;
2230
- format?: string | undefined;
2231
- file?: any;
2232
- nullable?: boolean | undefined;
2233
- }[];
2234
- headers: {
2235
- value: string;
2236
- key: string;
2237
- enabled: boolean;
2238
- minimum?: number | undefined;
2239
- type?: string | string[] | undefined;
2240
- maximum?: number | undefined;
2241
- default?: any;
2242
- required?: boolean | undefined;
2243
- description?: string | undefined;
2244
- enum?: string[] | undefined;
2245
- examples?: string[] | undefined;
2246
- format?: string | undefined;
2247
- file?: any;
2248
- nullable?: boolean | undefined;
2249
- }[];
2250
- };
2251
- body: {
2252
- activeBody: "binary" | "formData" | "raw";
2253
- binary?: Blob | undefined;
2254
- formData?: {
2255
- value: {
2256
- value: string;
2257
- key: string;
2258
- enabled: boolean;
2259
- minimum?: number | undefined;
2260
- type?: string | string[] | undefined;
2261
- maximum?: number | undefined;
2262
- default?: any;
2263
- required?: boolean | undefined;
2264
- description?: string | undefined;
2265
- enum?: string[] | undefined;
2266
- examples?: string[] | undefined;
2267
- format?: string | undefined;
2268
- file?: any;
2269
- nullable?: boolean | undefined;
2270
- }[];
2271
- encoding: "form-data" | "urlencoded";
2272
- } | undefined;
2273
- raw?: {
2274
- value: string;
2275
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2276
- } | undefined;
2277
- };
2278
- requestUid?: (string & BRAND<"operation">) | undefined;
2279
- serverVariables?: Record<string, string[]> | undefined;
2280
- }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends Path< {
2281
- type: "requestExample";
2282
- uid: string & BRAND<"example">;
2283
- name: string;
2284
- parameters: {
2285
- path: {
2286
- value: string;
2287
- key: string;
2288
- enabled: boolean;
2289
- minimum?: number | undefined;
2290
- type?: string | string[] | undefined;
2291
- maximum?: number | undefined;
2292
- default?: any;
2293
- required?: boolean | undefined;
2294
- description?: string | undefined;
2295
- enum?: string[] | undefined;
2296
- examples?: string[] | undefined;
2297
- format?: string | undefined;
2298
- file?: any;
2299
- nullable?: boolean | undefined;
2300
- }[];
2301
- cookies: {
2302
- value: string;
2303
- key: string;
2304
- enabled: boolean;
2305
- minimum?: number | undefined;
2306
- type?: string | string[] | undefined;
2307
- maximum?: number | undefined;
2308
- default?: any;
2309
- required?: boolean | undefined;
2310
- description?: string | undefined;
2311
- enum?: string[] | undefined;
2312
- examples?: string[] | undefined;
2313
- format?: string | undefined;
2314
- file?: any;
2315
- nullable?: boolean | undefined;
2316
- }[];
2317
- query: {
2318
- value: string;
2319
- key: string;
2320
- enabled: boolean;
2321
- minimum?: number | undefined;
2322
- type?: string | string[] | undefined;
2323
- maximum?: number | undefined;
2324
- default?: any;
2325
- required?: boolean | undefined;
2326
- description?: string | undefined;
2327
- enum?: string[] | undefined;
2328
- examples?: string[] | undefined;
2329
- format?: string | undefined;
2330
- file?: any;
2331
- nullable?: boolean | undefined;
2332
- }[];
2333
- headers: {
2334
- value: string;
2335
- key: string;
2336
- enabled: boolean;
2337
- minimum?: number | undefined;
2338
- type?: string | string[] | undefined;
2339
- maximum?: number | undefined;
2340
- default?: any;
2341
- required?: boolean | undefined;
2342
- description?: string | undefined;
2343
- enum?: string[] | undefined;
2344
- examples?: string[] | undefined;
2345
- format?: string | undefined;
2346
- file?: any;
2347
- nullable?: boolean | undefined;
2348
- }[];
2349
- };
2350
- body: {
2351
- activeBody: "binary" | "formData" | "raw";
2352
- binary?: Blob | undefined;
2353
- formData?: {
2354
- value: {
2355
- value: string;
2356
- key: string;
2357
- enabled: boolean;
2358
- minimum?: number | undefined;
2359
- type?: string | string[] | undefined;
2360
- maximum?: number | undefined;
2361
- default?: any;
2362
- required?: boolean | undefined;
2363
- description?: string | undefined;
2364
- enum?: string[] | undefined;
2365
- examples?: string[] | undefined;
2366
- format?: string | undefined;
2367
- file?: any;
2368
- nullable?: boolean | undefined;
2369
- }[];
2370
- encoding: "form-data" | "urlencoded";
2371
- } | undefined;
2372
- raw?: {
2373
- value: string;
2374
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2375
- } | undefined;
2376
- };
2377
- requestUid?: (string & BRAND<"operation">) | undefined;
2378
- serverVariables?: Record<string, string[]> | undefined;
2379
- }[K]> ? PathValue< {
2380
- type: "requestExample";
2381
- uid: string & BRAND<"example">;
2382
- name: string;
2383
- parameters: {
2384
- path: {
2385
- value: string;
2386
- key: string;
2387
- enabled: boolean;
2388
- minimum?: number | undefined;
2389
- type?: string | string[] | undefined;
2390
- maximum?: number | undefined;
2391
- default?: any;
2392
- required?: boolean | undefined;
2393
- description?: string | undefined;
2394
- enum?: string[] | undefined;
2395
- examples?: string[] | undefined;
2396
- format?: string | undefined;
2397
- file?: any;
2398
- nullable?: boolean | undefined;
2399
- }[];
2400
- cookies: {
2401
- value: string;
2402
- key: string;
2403
- enabled: boolean;
2404
- minimum?: number | undefined;
2405
- type?: string | string[] | undefined;
2406
- maximum?: number | undefined;
2407
- default?: any;
2408
- required?: boolean | undefined;
2409
- description?: string | undefined;
2410
- enum?: string[] | undefined;
2411
- examples?: string[] | undefined;
2412
- format?: string | undefined;
2413
- file?: any;
2414
- nullable?: boolean | undefined;
2415
- }[];
2416
- query: {
2417
- value: string;
2418
- key: string;
2419
- enabled: boolean;
2420
- minimum?: number | undefined;
2421
- type?: string | string[] | undefined;
2422
- maximum?: number | undefined;
2423
- default?: any;
2424
- required?: boolean | undefined;
2425
- description?: string | undefined;
2426
- enum?: string[] | undefined;
2427
- examples?: string[] | undefined;
2428
- format?: string | undefined;
2429
- file?: any;
2430
- nullable?: boolean | undefined;
2431
- }[];
2432
- headers: {
2433
- value: string;
2434
- key: string;
2435
- enabled: boolean;
2436
- minimum?: number | undefined;
2437
- type?: string | string[] | undefined;
2438
- maximum?: number | undefined;
2439
- default?: any;
2440
- required?: boolean | undefined;
2441
- description?: string | undefined;
2442
- enum?: string[] | undefined;
2443
- examples?: string[] | undefined;
2444
- format?: string | undefined;
2445
- file?: any;
2446
- nullable?: boolean | undefined;
2447
- }[];
2448
- };
2449
- body: {
2450
- activeBody: "binary" | "formData" | "raw";
2451
- binary?: Blob | undefined;
2452
- formData?: {
2453
- value: {
2454
- value: string;
2455
- key: string;
2456
- enabled: boolean;
2457
- minimum?: number | undefined;
2458
- type?: string | string[] | undefined;
2459
- maximum?: number | undefined;
2460
- default?: any;
2461
- required?: boolean | undefined;
2462
- description?: string | undefined;
2463
- enum?: string[] | undefined;
2464
- examples?: string[] | undefined;
2465
- format?: string | undefined;
2466
- file?: any;
2467
- nullable?: boolean | undefined;
2468
- }[];
2469
- encoding: "form-data" | "urlencoded";
2470
- } | undefined;
2471
- raw?: {
2472
- value: string;
2473
- encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
2474
- } | undefined;
2475
- };
2476
- requestUid?: (string & BRAND<"operation">) | undefined;
2477
- serverVariables?: Record<string, string[]> | undefined;
2478
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2479
- undo: (uid: string & BRAND<"example">) => void;
2480
- redo: (uid: string & BRAND<"example">) => void;
2481
- reset: () => void;
2482
- };
2483
- requestHistory: Reactive<RequestEvent[]>;
2484
- securitySchemeMutators: {
2485
- rawAdd: (item: {
2486
- type: "apiKey";
2487
- value: string;
2488
- uid: string & BRAND<"securityScheme">;
2489
- name: string;
2490
- nameKey: string;
2491
- in: "cookie" | "query" | "header";
2492
- description?: string | undefined;
2493
- } | {
2494
- type: "http";
2495
- uid: string & BRAND<"securityScheme">;
2496
- nameKey: string;
2497
- scheme: "basic" | "bearer";
2498
- bearerFormat: string;
2499
- username: string;
2500
- password: string;
2501
- token: string;
2502
- description?: string | undefined;
2503
- } | {
2504
- type: "openIdConnect";
2505
- uid: string & BRAND<"securityScheme">;
2506
- nameKey: string;
2507
- openIdConnectUrl: string;
2508
- description?: string | undefined;
2509
- } | {
2510
- type: "oauth2";
2511
- uid: string & BRAND<"securityScheme">;
2512
- nameKey: string;
2513
- flows: {
2514
- password?: {
2515
- type: "password";
2516
- username: string;
2517
- password: string;
2518
- token: string;
2519
- refreshUrl: string;
2520
- scopes: Record<string, string>;
2521
- selectedScopes: string[];
2522
- "x-scalar-client-id": string;
2523
- tokenUrl: string;
2524
- clientSecret: string;
2525
- } | undefined;
2526
- implicit?: {
2527
- type: "implicit";
2528
- token: string;
2529
- refreshUrl: string;
2530
- scopes: Record<string, string>;
2531
- selectedScopes: string[];
2532
- "x-scalar-client-id": string;
2533
- authorizationUrl: string;
2534
- "x-scalar-redirect-uri": string;
2535
- } | undefined;
2536
- clientCredentials?: {
2537
- type: "clientCredentials";
2538
- token: string;
2539
- refreshUrl: string;
2540
- scopes: Record<string, string>;
2541
- selectedScopes: string[];
2542
- "x-scalar-client-id": string;
2543
- tokenUrl: string;
2544
- clientSecret: string;
2545
- } | undefined;
2546
- authorizationCode?: {
2547
- type: "authorizationCode";
2548
- token: string;
2549
- refreshUrl: string;
2550
- scopes: Record<string, string>;
2551
- selectedScopes: string[];
2552
- "x-scalar-client-id": string;
2553
- authorizationUrl: string;
2554
- "x-scalar-redirect-uri": string;
2555
- tokenUrl: string;
2556
- clientSecret: string;
2557
- "x-usePkce": "SHA-256" | "plain" | "no";
2558
- } | undefined;
2559
- };
2560
- description?: string | undefined;
2561
- }) => void;
2562
- add: (payload: SecuritySchemePayload, collectionUid: Collection["uid"]) => {
2563
- type: "apiKey";
2564
- value: string;
2565
- uid: string & BRAND<"securityScheme">;
2566
- name: string;
2567
- nameKey: string;
2568
- in: "cookie" | "query" | "header";
2569
- description?: string | undefined;
2570
- } | {
2571
- type: "http";
2572
- uid: string & BRAND<"securityScheme">;
2573
- nameKey: string;
2574
- scheme: "basic" | "bearer";
2575
- bearerFormat: string;
2576
- username: string;
2577
- password: string;
2578
- token: string;
2579
- description?: string | undefined;
2580
- } | {
2581
- type: "openIdConnect";
2582
- uid: string & BRAND<"securityScheme">;
2583
- nameKey: string;
2584
- openIdConnectUrl: string;
2585
- description?: string | undefined;
2586
- } | {
2587
- type: "oauth2";
2588
- uid: string & BRAND<"securityScheme">;
2589
- nameKey: string;
2590
- flows: {
2591
- password?: {
2592
- type: "password";
2593
- username: string;
2594
- password: string;
2595
- token: string;
2596
- refreshUrl: string;
2597
- scopes: Record<string, string>;
2598
- selectedScopes: string[];
2599
- "x-scalar-client-id": string;
2600
- tokenUrl: string;
2601
- clientSecret: string;
2602
- } | undefined;
2603
- implicit?: {
2604
- type: "implicit";
2605
- token: string;
2606
- refreshUrl: string;
2607
- scopes: Record<string, string>;
2608
- selectedScopes: string[];
2609
- "x-scalar-client-id": string;
2610
- authorizationUrl: string;
2611
- "x-scalar-redirect-uri": string;
2612
- } | undefined;
2613
- clientCredentials?: {
2614
- type: "clientCredentials";
2615
- token: string;
2616
- refreshUrl: string;
2617
- scopes: Record<string, string>;
2618
- selectedScopes: string[];
2619
- "x-scalar-client-id": string;
2620
- tokenUrl: string;
2621
- clientSecret: string;
2622
- } | undefined;
2623
- authorizationCode?: {
2624
- type: "authorizationCode";
2625
- token: string;
2626
- refreshUrl: string;
2627
- scopes: Record<string, string>;
2628
- selectedScopes: string[];
2629
- "x-scalar-client-id": string;
2630
- authorizationUrl: string;
2631
- "x-scalar-redirect-uri": string;
2632
- tokenUrl: string;
2633
- clientSecret: string;
2634
- "x-usePkce": "SHA-256" | "plain" | "no";
2635
- } | undefined;
2636
- };
2637
- description?: string | undefined;
2638
- };
2639
- delete: (schemeUid: SecurityScheme["uid"]) => void;
2640
- set: (item: {
2641
- type: "apiKey";
2642
- value: string;
2643
- uid: string & BRAND<"securityScheme">;
2644
- name: string;
2645
- nameKey: string;
2646
- in: "cookie" | "query" | "header";
2647
- description?: string | undefined;
2648
- } | {
2649
- type: "http";
2650
- uid: string & BRAND<"securityScheme">;
2651
- nameKey: string;
2652
- scheme: "basic" | "bearer";
2653
- bearerFormat: string;
2654
- username: string;
2655
- password: string;
2656
- token: string;
2657
- description?: string | undefined;
2658
- } | {
2659
- type: "openIdConnect";
2660
- uid: string & BRAND<"securityScheme">;
2661
- nameKey: string;
2662
- openIdConnectUrl: string;
2663
- description?: string | undefined;
2664
- } | {
2665
- type: "oauth2";
2666
- uid: string & BRAND<"securityScheme">;
2667
- nameKey: string;
2668
- flows: {
2669
- password?: {
2670
- type: "password";
2671
- username: string;
2672
- password: string;
2673
- token: string;
2674
- refreshUrl: string;
2675
- scopes: Record<string, string>;
2676
- selectedScopes: string[];
2677
- "x-scalar-client-id": string;
2678
- tokenUrl: string;
2679
- clientSecret: string;
2680
- } | undefined;
2681
- implicit?: {
2682
- type: "implicit";
2683
- token: string;
2684
- refreshUrl: string;
2685
- scopes: Record<string, string>;
2686
- selectedScopes: string[];
2687
- "x-scalar-client-id": string;
2688
- authorizationUrl: string;
2689
- "x-scalar-redirect-uri": string;
2690
- } | undefined;
2691
- clientCredentials?: {
2692
- type: "clientCredentials";
2693
- token: string;
2694
- refreshUrl: string;
2695
- scopes: Record<string, string>;
2696
- selectedScopes: string[];
2697
- "x-scalar-client-id": string;
2698
- tokenUrl: string;
2699
- clientSecret: string;
2700
- } | undefined;
2701
- authorizationCode?: {
2702
- type: "authorizationCode";
2703
- token: string;
2704
- refreshUrl: string;
2705
- scopes: Record<string, string>;
2706
- selectedScopes: string[];
2707
- "x-scalar-client-id": string;
2708
- authorizationUrl: string;
2709
- "x-scalar-redirect-uri": string;
2710
- tokenUrl: string;
2711
- clientSecret: string;
2712
- "x-usePkce": "SHA-256" | "plain" | "no";
2713
- } | undefined;
2714
- };
2715
- description?: string | undefined;
2716
- }) => void;
2717
- edit: <P extends "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "flows" | "password" | "username" | "value" | "token" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: (string & BRAND<"securityScheme">) | null | undefined, path: P, value: (P extends "description" | "type" | "name" | "in" | "uid" | "nameKey" | "value" ? {
2718
- type: "apiKey";
2719
- value: string;
2720
- uid: string & BRAND<"securityScheme">;
2721
- name: string;
2722
- nameKey: string;
2723
- in: "cookie" | "query" | "header";
2724
- description?: string | undefined;
2725
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "type" | "name" | "in" | "uid" | "nameKey" | "value" ? R extends Path< {
2726
- type: "apiKey";
2727
- value: string;
2728
- uid: string & BRAND<"securityScheme">;
2729
- name: string;
2730
- nameKey: string;
2731
- in: "cookie" | "query" | "header";
2732
- description?: string | undefined;
2733
- }[K]> ? PathValue< {
2734
- type: "apiKey";
2735
- value: string;
2736
- uid: string & BRAND<"securityScheme">;
2737
- name: string;
2738
- nameKey: string;
2739
- in: "cookie" | "query" | "header";
2740
- description?: string | undefined;
2741
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "password" | "username" | "token" ? {
2742
- type: "http";
2743
- uid: string & BRAND<"securityScheme">;
2744
- nameKey: string;
2745
- scheme: "basic" | "bearer";
2746
- bearerFormat: string;
2747
- username: string;
2748
- password: string;
2749
- token: string;
2750
- description?: string | undefined;
2751
- }[P] : P extends `${infer K}.${infer R_1}` ? K extends "description" | "type" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "password" | "username" | "token" ? R_1 extends Path< {
2752
- type: "http";
2753
- uid: string & BRAND<"securityScheme">;
2754
- nameKey: string;
2755
- scheme: "basic" | "bearer";
2756
- bearerFormat: string;
2757
- username: string;
2758
- password: string;
2759
- token: string;
2760
- description?: string | undefined;
2761
- }[K]> ? PathValue< {
2762
- type: "http";
2763
- uid: string & BRAND<"securityScheme">;
2764
- nameKey: string;
2765
- scheme: "basic" | "bearer";
2766
- bearerFormat: string;
2767
- username: string;
2768
- password: string;
2769
- token: string;
2770
- description?: string | undefined;
2771
- }[K], R_1> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "openIdConnectUrl" ? {
2772
- type: "openIdConnect";
2773
- uid: string & BRAND<"securityScheme">;
2774
- nameKey: string;
2775
- openIdConnectUrl: string;
2776
- description?: string | undefined;
2777
- }[P] : P extends `${infer K}.${infer R_2}` ? K extends "description" | "type" | "uid" | "nameKey" | "openIdConnectUrl" ? R_2 extends Path< {
2778
- type: "openIdConnect";
2779
- uid: string & BRAND<"securityScheme">;
2780
- nameKey: string;
2781
- openIdConnectUrl: string;
2782
- description?: string | undefined;
2783
- }[K]> ? PathValue< {
2784
- type: "openIdConnect";
2785
- uid: string & BRAND<"securityScheme">;
2786
- nameKey: string;
2787
- openIdConnectUrl: string;
2788
- description?: string | undefined;
2789
- }[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "flows" ? {
2790
- type: "oauth2";
2791
- uid: string & BRAND<"securityScheme">;
2792
- nameKey: string;
2793
- flows: {
2794
- password?: {
2795
- type: "password";
2796
- username: string;
2797
- password: string;
2798
- token: string;
2799
- refreshUrl: string;
2800
- scopes: Record<string, string>;
2801
- selectedScopes: string[];
2802
- "x-scalar-client-id": string;
2803
- tokenUrl: string;
2804
- clientSecret: string;
2805
- } | undefined;
2806
- implicit?: {
2807
- type: "implicit";
2808
- token: string;
2809
- refreshUrl: string;
2810
- scopes: Record<string, string>;
2811
- selectedScopes: string[];
2812
- "x-scalar-client-id": string;
2813
- authorizationUrl: string;
2814
- "x-scalar-redirect-uri": string;
2815
- } | undefined;
2816
- clientCredentials?: {
2817
- type: "clientCredentials";
2818
- token: string;
2819
- refreshUrl: string;
2820
- scopes: Record<string, string>;
2821
- selectedScopes: string[];
2822
- "x-scalar-client-id": string;
2823
- tokenUrl: string;
2824
- clientSecret: string;
2825
- } | undefined;
2826
- authorizationCode?: {
2827
- type: "authorizationCode";
2828
- token: string;
2829
- refreshUrl: string;
2830
- scopes: Record<string, string>;
2831
- selectedScopes: string[];
2832
- "x-scalar-client-id": string;
2833
- authorizationUrl: string;
2834
- "x-scalar-redirect-uri": string;
2835
- tokenUrl: string;
2836
- clientSecret: string;
2837
- "x-usePkce": "SHA-256" | "plain" | "no";
2838
- } | undefined;
2839
- };
2840
- description?: string | undefined;
2841
- }[P] : P extends `${infer K}.${infer R_3}` ? K extends "description" | "type" | "uid" | "nameKey" | "flows" ? R_3 extends Path< {
2842
- type: "oauth2";
2843
- uid: string & BRAND<"securityScheme">;
2844
- nameKey: string;
2845
- flows: {
2846
- password?: {
2847
- type: "password";
2848
- username: string;
2849
- password: string;
2850
- token: string;
2851
- refreshUrl: string;
2852
- scopes: Record<string, string>;
2853
- selectedScopes: string[];
2854
- "x-scalar-client-id": string;
2855
- tokenUrl: string;
2856
- clientSecret: string;
2857
- } | undefined;
2858
- implicit?: {
2859
- type: "implicit";
2860
- token: string;
2861
- refreshUrl: string;
2862
- scopes: Record<string, string>;
2863
- selectedScopes: string[];
2864
- "x-scalar-client-id": string;
2865
- authorizationUrl: string;
2866
- "x-scalar-redirect-uri": string;
2867
- } | undefined;
2868
- clientCredentials?: {
2869
- type: "clientCredentials";
2870
- token: string;
2871
- refreshUrl: string;
2872
- scopes: Record<string, string>;
2873
- selectedScopes: string[];
2874
- "x-scalar-client-id": string;
2875
- tokenUrl: string;
2876
- clientSecret: string;
2877
- } | undefined;
2878
- authorizationCode?: {
2879
- type: "authorizationCode";
2880
- token: string;
2881
- refreshUrl: string;
2882
- scopes: Record<string, string>;
2883
- selectedScopes: string[];
2884
- "x-scalar-client-id": string;
2885
- authorizationUrl: string;
2886
- "x-scalar-redirect-uri": string;
2887
- tokenUrl: string;
2888
- clientSecret: string;
2889
- "x-usePkce": "SHA-256" | "plain" | "no";
2890
- } | undefined;
2891
- };
2892
- description?: string | undefined;
2893
- }[K]> ? PathValue< {
2894
- type: "oauth2";
2895
- uid: string & BRAND<"securityScheme">;
2896
- nameKey: string;
2897
- flows: {
2898
- password?: {
2899
- type: "password";
2900
- username: string;
2901
- password: string;
2902
- token: string;
2903
- refreshUrl: string;
2904
- scopes: Record<string, string>;
2905
- selectedScopes: string[];
2906
- "x-scalar-client-id": string;
2907
- tokenUrl: string;
2908
- clientSecret: string;
2909
- } | undefined;
2910
- implicit?: {
2911
- type: "implicit";
2912
- token: string;
2913
- refreshUrl: string;
2914
- scopes: Record<string, string>;
2915
- selectedScopes: string[];
2916
- "x-scalar-client-id": string;
2917
- authorizationUrl: string;
2918
- "x-scalar-redirect-uri": string;
2919
- } | undefined;
2920
- clientCredentials?: {
2921
- type: "clientCredentials";
2922
- token: string;
2923
- refreshUrl: string;
2924
- scopes: Record<string, string>;
2925
- selectedScopes: string[];
2926
- "x-scalar-client-id": string;
2927
- tokenUrl: string;
2928
- clientSecret: string;
2929
- } | undefined;
2930
- authorizationCode?: {
2931
- type: "authorizationCode";
2932
- token: string;
2933
- refreshUrl: string;
2934
- scopes: Record<string, string>;
2935
- selectedScopes: string[];
2936
- "x-scalar-client-id": string;
2937
- authorizationUrl: string;
2938
- "x-scalar-redirect-uri": string;
2939
- tokenUrl: string;
2940
- clientSecret: string;
2941
- "x-usePkce": "SHA-256" | "plain" | "no";
2942
- } | undefined;
2943
- };
2944
- description?: string | undefined;
2945
- }[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
2946
- untrackedEdit: <P extends "description" | "type" | "name" | "in" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "openIdConnectUrl" | "flows" | "password" | "username" | "value" | "token" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.type" | "flows.password.password" | "flows.password.username" | "flows.password.token" | "flows.password.refreshUrl" | "flows.password.scopes" | "flows.password.selectedScopes" | "flows.password.x-scalar-client-id" | "flows.password.tokenUrl" | "flows.password.clientSecret" | `flows.password.scopes.${string}` | `flows.password.selectedScopes.${number}` | "flows.implicit.type" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | "flows.implicit.selectedScopes" | "flows.implicit.x-scalar-client-id" | `flows.implicit.scopes.${string}` | `flows.implicit.selectedScopes.${number}` | "flows.implicit.authorizationUrl" | "flows.implicit.x-scalar-redirect-uri" | "flows.clientCredentials.type" | "flows.clientCredentials.token" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.x-scalar-client-id" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | `flows.clientCredentials.scopes.${string}` | `flows.clientCredentials.selectedScopes.${number}` | "flows.authorizationCode.type" | "flows.authorizationCode.token" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.x-scalar-client-id" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | `flows.authorizationCode.scopes.${string}` | `flows.authorizationCode.selectedScopes.${number}` | "flows.authorizationCode.authorizationUrl" | "flows.authorizationCode.x-scalar-redirect-uri" | "flows.authorizationCode.x-usePkce">(uid: string & BRAND<"securityScheme">, path: P, value: (P extends "description" | "type" | "name" | "in" | "uid" | "nameKey" | "value" ? {
2947
- type: "apiKey";
2948
- value: string;
2949
- uid: string & BRAND<"securityScheme">;
2950
- name: string;
2951
- nameKey: string;
2952
- in: "cookie" | "query" | "header";
2953
- description?: string | undefined;
2954
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "type" | "name" | "in" | "uid" | "nameKey" | "value" ? R extends Path< {
2955
- type: "apiKey";
2956
- value: string;
2957
- uid: string & BRAND<"securityScheme">;
2958
- name: string;
2959
- nameKey: string;
2960
- in: "cookie" | "query" | "header";
2961
- description?: string | undefined;
2962
- }[K]> ? PathValue< {
2963
- type: "apiKey";
2964
- value: string;
2965
- uid: string & BRAND<"securityScheme">;
2966
- name: string;
2967
- nameKey: string;
2968
- in: "cookie" | "query" | "header";
2969
- description?: string | undefined;
2970
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "password" | "username" | "token" ? {
2971
- type: "http";
2972
- uid: string & BRAND<"securityScheme">;
2973
- nameKey: string;
2974
- scheme: "basic" | "bearer";
2975
- bearerFormat: string;
2976
- username: string;
2977
- password: string;
2978
- token: string;
2979
- description?: string | undefined;
2980
- }[P] : P extends `${infer K}.${infer R_1}` ? K extends "description" | "type" | "uid" | "nameKey" | "scheme" | "bearerFormat" | "password" | "username" | "token" ? R_1 extends Path< {
2981
- type: "http";
2982
- uid: string & BRAND<"securityScheme">;
2983
- nameKey: string;
2984
- scheme: "basic" | "bearer";
2985
- bearerFormat: string;
2986
- username: string;
2987
- password: string;
2988
- token: string;
2989
- description?: string | undefined;
2990
- }[K]> ? PathValue< {
2991
- type: "http";
2992
- uid: string & BRAND<"securityScheme">;
2993
- nameKey: string;
2994
- scheme: "basic" | "bearer";
2995
- bearerFormat: string;
2996
- username: string;
2997
- password: string;
2998
- token: string;
2999
- description?: string | undefined;
3000
- }[K], R_1> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "openIdConnectUrl" ? {
3001
- type: "openIdConnect";
3002
- uid: string & BRAND<"securityScheme">;
3003
- nameKey: string;
3004
- openIdConnectUrl: string;
3005
- description?: string | undefined;
3006
- }[P] : P extends `${infer K}.${infer R_2}` ? K extends "description" | "type" | "uid" | "nameKey" | "openIdConnectUrl" ? R_2 extends Path< {
3007
- type: "openIdConnect";
3008
- uid: string & BRAND<"securityScheme">;
3009
- nameKey: string;
3010
- openIdConnectUrl: string;
3011
- description?: string | undefined;
3012
- }[K]> ? PathValue< {
3013
- type: "openIdConnect";
3014
- uid: string & BRAND<"securityScheme">;
3015
- nameKey: string;
3016
- openIdConnectUrl: string;
3017
- description?: string | undefined;
3018
- }[K], R_2> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "description" | "type" | "uid" | "nameKey" | "flows" ? {
3019
- type: "oauth2";
3020
- uid: string & BRAND<"securityScheme">;
3021
- nameKey: string;
3022
- flows: {
3023
- password?: {
3024
- type: "password";
3025
- username: string;
3026
- password: string;
3027
- token: string;
3028
- refreshUrl: string;
3029
- scopes: Record<string, string>;
3030
- selectedScopes: string[];
3031
- "x-scalar-client-id": string;
3032
- tokenUrl: string;
3033
- clientSecret: string;
3034
- } | undefined;
3035
- implicit?: {
3036
- type: "implicit";
3037
- token: string;
3038
- refreshUrl: string;
3039
- scopes: Record<string, string>;
3040
- selectedScopes: string[];
3041
- "x-scalar-client-id": string;
3042
- authorizationUrl: string;
3043
- "x-scalar-redirect-uri": string;
3044
- } | undefined;
3045
- clientCredentials?: {
3046
- type: "clientCredentials";
3047
- token: string;
3048
- refreshUrl: string;
3049
- scopes: Record<string, string>;
3050
- selectedScopes: string[];
3051
- "x-scalar-client-id": string;
3052
- tokenUrl: string;
3053
- clientSecret: string;
3054
- } | undefined;
3055
- authorizationCode?: {
3056
- type: "authorizationCode";
3057
- token: string;
3058
- refreshUrl: string;
3059
- scopes: Record<string, string>;
3060
- selectedScopes: string[];
3061
- "x-scalar-client-id": string;
3062
- authorizationUrl: string;
3063
- "x-scalar-redirect-uri": string;
3064
- tokenUrl: string;
3065
- clientSecret: string;
3066
- "x-usePkce": "SHA-256" | "plain" | "no";
3067
- } | undefined;
3068
- };
3069
- description?: string | undefined;
3070
- }[P] : P extends `${infer K}.${infer R_3}` ? K extends "description" | "type" | "uid" | "nameKey" | "flows" ? R_3 extends Path< {
3071
- type: "oauth2";
3072
- uid: string & BRAND<"securityScheme">;
3073
- nameKey: string;
3074
- flows: {
3075
- password?: {
3076
- type: "password";
3077
- username: string;
3078
- password: string;
3079
- token: string;
3080
- refreshUrl: string;
3081
- scopes: Record<string, string>;
3082
- selectedScopes: string[];
3083
- "x-scalar-client-id": string;
3084
- tokenUrl: string;
3085
- clientSecret: string;
3086
- } | undefined;
3087
- implicit?: {
3088
- type: "implicit";
3089
- token: string;
3090
- refreshUrl: string;
3091
- scopes: Record<string, string>;
3092
- selectedScopes: string[];
3093
- "x-scalar-client-id": string;
3094
- authorizationUrl: string;
3095
- "x-scalar-redirect-uri": string;
3096
- } | undefined;
3097
- clientCredentials?: {
3098
- type: "clientCredentials";
3099
- token: string;
3100
- refreshUrl: string;
3101
- scopes: Record<string, string>;
3102
- selectedScopes: string[];
3103
- "x-scalar-client-id": string;
3104
- tokenUrl: string;
3105
- clientSecret: string;
3106
- } | undefined;
3107
- authorizationCode?: {
3108
- type: "authorizationCode";
3109
- token: string;
3110
- refreshUrl: string;
3111
- scopes: Record<string, string>;
3112
- selectedScopes: string[];
3113
- "x-scalar-client-id": string;
3114
- authorizationUrl: string;
3115
- "x-scalar-redirect-uri": string;
3116
- tokenUrl: string;
3117
- clientSecret: string;
3118
- "x-usePkce": "SHA-256" | "plain" | "no";
3119
- } | undefined;
3120
- };
3121
- description?: string | undefined;
3122
- }[K]> ? PathValue< {
3123
- type: "oauth2";
3124
- uid: string & BRAND<"securityScheme">;
3125
- nameKey: string;
3126
- flows: {
3127
- password?: {
3128
- type: "password";
3129
- username: string;
3130
- password: string;
3131
- token: string;
3132
- refreshUrl: string;
3133
- scopes: Record<string, string>;
3134
- selectedScopes: string[];
3135
- "x-scalar-client-id": string;
3136
- tokenUrl: string;
3137
- clientSecret: string;
3138
- } | undefined;
3139
- implicit?: {
3140
- type: "implicit";
3141
- token: string;
3142
- refreshUrl: string;
3143
- scopes: Record<string, string>;
3144
- selectedScopes: string[];
3145
- "x-scalar-client-id": string;
3146
- authorizationUrl: string;
3147
- "x-scalar-redirect-uri": string;
3148
- } | undefined;
3149
- clientCredentials?: {
3150
- type: "clientCredentials";
3151
- token: string;
3152
- refreshUrl: string;
3153
- scopes: Record<string, string>;
3154
- selectedScopes: string[];
3155
- "x-scalar-client-id": string;
3156
- tokenUrl: string;
3157
- clientSecret: string;
3158
- } | undefined;
3159
- authorizationCode?: {
3160
- type: "authorizationCode";
3161
- token: string;
3162
- refreshUrl: string;
3163
- scopes: Record<string, string>;
3164
- selectedScopes: string[];
3165
- "x-scalar-client-id": string;
3166
- authorizationUrl: string;
3167
- "x-scalar-redirect-uri": string;
3168
- tokenUrl: string;
3169
- clientSecret: string;
3170
- "x-usePkce": "SHA-256" | "plain" | "no";
3171
- } | undefined;
3172
- };
3173
- description?: string | undefined;
3174
- }[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
3175
- undo: (uid: string & BRAND<"securityScheme">) => void;
3176
- redo: (uid: string & BRAND<"securityScheme">) => void;
3177
- reset: () => void;
3178
- };
3179
- serverMutators: {
3180
- rawAdd: (item: {
3181
- uid: string & BRAND<"server">;
3182
- url: string;
3183
- description?: string | undefined;
3184
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3185
- enum?: [string, ...string[]];
3186
- value?: string;
3187
- }> | undefined;
3188
- }) => void;
3189
- add: (payload: ServerPayload, parentUid: string) => {
3190
- uid: string & BRAND<"server">;
3191
- url: string;
3192
- description?: string | undefined;
3193
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3194
- enum?: [string, ...string[]];
3195
- value?: string;
3196
- }> | undefined;
3197
- };
3198
- delete: (serverUid: Server["uid"], collectionUid: Collection["uid"]) => void;
3199
- set: (item: {
3200
- uid: string & BRAND<"server">;
3201
- url: string;
3202
- description?: string | undefined;
3203
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3204
- enum?: [string, ...string[]];
3205
- value?: string;
3206
- }> | undefined;
3207
- }) => void;
3208
- edit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: (string & BRAND<"server">) | null | undefined, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
3209
- uid: string & BRAND<"server">;
3210
- url: string;
3211
- description?: string | undefined;
3212
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3213
- enum?: [string, ...string[]];
3214
- value?: string;
3215
- }> | undefined;
3216
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends Path< {
3217
- uid: string & BRAND<"server">;
3218
- url: string;
3219
- description?: string | undefined;
3220
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3221
- enum?: [string, ...string[]];
3222
- value?: string;
3223
- }> | undefined;
3224
- }[K]> ? PathValue< {
3225
- uid: string & BRAND<"server">;
3226
- url: string;
3227
- description?: string | undefined;
3228
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3229
- enum?: [string, ...string[]];
3230
- value?: string;
3231
- }> | undefined;
3232
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3233
- untrackedEdit: <P extends "description" | "uid" | "url" | "variables" | `variables.${string}`>(uid: string & BRAND<"server">, path: P, value: P extends "description" | "uid" | "url" | "variables" ? {
3234
- uid: string & BRAND<"server">;
3235
- url: string;
3236
- description?: string | undefined;
3237
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3238
- enum?: [string, ...string[]];
3239
- value?: string;
3240
- }> | undefined;
3241
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "uid" | "url" | "variables" ? R extends Path< {
3242
- uid: string & BRAND<"server">;
3243
- url: string;
3244
- description?: string | undefined;
3245
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3246
- enum?: [string, ...string[]];
3247
- value?: string;
3248
- }> | undefined;
3249
- }[K]> ? PathValue< {
3250
- uid: string & BRAND<"server">;
3251
- url: string;
3252
- description?: string | undefined;
3253
- variables?: Record<string, Omit<OpenAPIV3_1.ServerVariableObject, "enum"> & {
3254
- enum?: [string, ...string[]];
3255
- value?: string;
3256
- }> | undefined;
3257
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3258
- undo: (uid: string & BRAND<"server">) => void;
3259
- redo: (uid: string & BRAND<"server">) => void;
3260
- reset: () => void;
3261
- };
3262
- tagMutators: {
3263
- rawAdd: (item: {
3264
- type: "tag";
3265
- uid: string & BRAND<"tag">;
3266
- name: string;
3267
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3268
- description?: string | undefined;
3269
- externalDocs?: {
3270
- url: string;
3271
- description?: string | undefined;
3272
- } | undefined;
3273
- "x-scalar-children"?: {
3274
- tagName: string;
3275
- }[] | undefined;
3276
- "x-internal"?: boolean | undefined;
3277
- "x-scalar-ignore"?: boolean | undefined;
3278
- }) => void;
3279
- add: (payload: TagPayload, collectionUid: Collection["uid"]) => void | {
3280
- type: "tag";
3281
- uid: string & BRAND<"tag">;
3282
- name: string;
3283
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3284
- description?: string | undefined;
3285
- externalDocs?: {
3286
- url: string;
3287
- description?: string | undefined;
3288
- } | undefined;
3289
- "x-scalar-children"?: {
3290
- tagName: string;
3291
- }[] | undefined;
3292
- "x-internal"?: boolean | undefined;
3293
- "x-scalar-ignore"?: boolean | undefined;
3294
- };
3295
- delete: (tag: Tag, collectionUid: Collection["uid"]) => void;
3296
- set: (item: {
3297
- type: "tag";
3298
- uid: string & BRAND<"tag">;
3299
- name: string;
3300
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3301
- description?: string | undefined;
3302
- externalDocs?: {
3303
- url: string;
3304
- description?: string | undefined;
3305
- } | undefined;
3306
- "x-scalar-children"?: {
3307
- tagName: string;
3308
- }[] | undefined;
3309
- "x-internal"?: boolean | undefined;
3310
- "x-scalar-ignore"?: boolean | undefined;
3311
- }) => void;
3312
- edit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: (string & BRAND<"tag">) | null | undefined, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
3313
- type: "tag";
3314
- uid: string & BRAND<"tag">;
3315
- name: string;
3316
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3317
- description?: string | undefined;
3318
- externalDocs?: {
3319
- url: string;
3320
- description?: string | undefined;
3321
- } | undefined;
3322
- "x-scalar-children"?: {
3323
- tagName: string;
3324
- }[] | undefined;
3325
- "x-internal"?: boolean | undefined;
3326
- "x-scalar-ignore"?: boolean | undefined;
3327
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path< {
3328
- type: "tag";
3329
- uid: string & BRAND<"tag">;
3330
- name: string;
3331
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3332
- description?: string | undefined;
3333
- externalDocs?: {
3334
- url: string;
3335
- description?: string | undefined;
3336
- } | undefined;
3337
- "x-scalar-children"?: {
3338
- tagName: string;
3339
- }[] | undefined;
3340
- "x-internal"?: boolean | undefined;
3341
- "x-scalar-ignore"?: boolean | undefined;
3342
- }[K]> ? PathValue< {
3343
- type: "tag";
3344
- uid: string & BRAND<"tag">;
3345
- name: string;
3346
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3347
- description?: string | undefined;
3348
- externalDocs?: {
3349
- url: string;
3350
- description?: string | undefined;
3351
- } | undefined;
3352
- "x-scalar-children"?: {
3353
- tagName: string;
3354
- }[] | undefined;
3355
- "x-internal"?: boolean | undefined;
3356
- "x-scalar-ignore"?: boolean | undefined;
3357
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3358
- untrackedEdit: <P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "externalDocs.description" | "externalDocs.url" | `children.${number}` | "x-scalar-children" | `x-scalar-children.${number}` | `x-scalar-children.${number}.tagName`>(uid: string & BRAND<"tag">, path: P, value: P extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? {
3359
- type: "tag";
3360
- uid: string & BRAND<"tag">;
3361
- name: string;
3362
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3363
- description?: string | undefined;
3364
- externalDocs?: {
3365
- url: string;
3366
- description?: string | undefined;
3367
- } | undefined;
3368
- "x-scalar-children"?: {
3369
- tagName: string;
3370
- }[] | undefined;
3371
- "x-internal"?: boolean | undefined;
3372
- "x-scalar-ignore"?: boolean | undefined;
3373
- }[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "externalDocs" | "x-internal" | "x-scalar-ignore" | "type" | "name" | "uid" | "children" | "x-scalar-children" ? R extends Path< {
3374
- type: "tag";
3375
- uid: string & BRAND<"tag">;
3376
- name: string;
3377
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3378
- description?: string | undefined;
3379
- externalDocs?: {
3380
- url: string;
3381
- description?: string | undefined;
3382
- } | undefined;
3383
- "x-scalar-children"?: {
3384
- tagName: string;
3385
- }[] | undefined;
3386
- "x-internal"?: boolean | undefined;
3387
- "x-scalar-ignore"?: boolean | undefined;
3388
- }[K]> ? PathValue< {
3389
- type: "tag";
3390
- uid: string & BRAND<"tag">;
3391
- name: string;
3392
- children: ((string & BRAND<"tag">) | (string & BRAND<"operation">))[];
3393
- description?: string | undefined;
3394
- externalDocs?: {
3395
- url: string;
3396
- description?: string | undefined;
3397
- } | undefined;
3398
- "x-scalar-children"?: {
3399
- tagName: string;
3400
- }[] | undefined;
3401
- "x-internal"?: boolean | undefined;
3402
- "x-scalar-ignore"?: boolean | undefined;
3403
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3404
- undo: (uid: string & BRAND<"tag">) => void;
3405
- redo: (uid: string & BRAND<"tag">) => void;
3406
- reset: () => void;
3407
- };
3408
- workspaceMutators: {
3409
- rawAdd: (item: {
3410
- uid: string & BRAND<"workspace">;
3411
- name: string;
3412
- description: string;
3413
- collections: (string & BRAND<"collection">)[];
3414
- environments: Record<string, string>;
3415
- activeEnvironmentId: string;
3416
- cookies: (string & BRAND<"cookie">)[];
3417
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3418
- selectedHttpClient: {
3419
- targetKey: string;
3420
- clientKey: string;
3421
- };
3422
- hotKeyConfig?: {
3423
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3424
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3425
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3426
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3427
- }>> | undefined;
3428
- } | undefined;
3429
- proxyUrl?: string | undefined;
3430
- }) => void;
3431
- add: (payload?: Partial<Workspace>) => {
3432
- uid: string & BRAND<"workspace">;
3433
- name: string;
3434
- description: string;
3435
- collections: (string & BRAND<"collection">)[];
3436
- environments: Record<string, string>;
3437
- activeEnvironmentId: string;
3438
- cookies: (string & BRAND<"cookie">)[];
3439
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3440
- selectedHttpClient: {
3441
- targetKey: string;
3442
- clientKey: string;
3443
- };
3444
- hotKeyConfig?: {
3445
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3446
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3447
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3448
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3449
- }>> | undefined;
3450
- } | undefined;
3451
- proxyUrl?: string | undefined;
3452
- };
3453
- delete: (uid: Workspace["uid"]) => void;
3454
- set: (item: {
3455
- uid: string & BRAND<"workspace">;
3456
- name: string;
3457
- description: string;
3458
- collections: (string & BRAND<"collection">)[];
3459
- environments: Record<string, string>;
3460
- activeEnvironmentId: string;
3461
- cookies: (string & BRAND<"cookie">)[];
3462
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3463
- selectedHttpClient: {
3464
- targetKey: string;
3465
- clientKey: string;
3466
- };
3467
- hotKeyConfig?: {
3468
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3469
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3470
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3471
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3472
- }>> | undefined;
3473
- } | undefined;
3474
- proxyUrl?: string | undefined;
3475
- }) => void;
3476
- edit: <P extends "cookies" | "description" | "name" | "uid" | "collections" | "environments" | "activeEnvironmentId" | "themeId" | "selectedHttpClient" | "hotKeyConfig" | "proxyUrl" | `cookies.${number}` | `collections.${number}` | `environments.${string}` | "selectedHttpClient.targetKey" | "selectedHttpClient.clientKey" | "hotKeyConfig.modifiers" | "hotKeyConfig.hotKeys" | `hotKeyConfig.modifiers.${number}` | "hotKeyConfig.hotKeys." | "hotKeyConfig.hotKeys./" | "hotKeyConfig.hotKeys.Space" | "hotKeyConfig.hotKeys.Backspace" | "hotKeyConfig.hotKeys.Tab" | "hotKeyConfig.hotKeys.Enter" | "hotKeyConfig.hotKeys.Escape" | "hotKeyConfig.hotKeys.ArrowDown" | "hotKeyConfig.hotKeys.ArrowLeft" | "hotKeyConfig.hotKeys.ArrowRight" | "hotKeyConfig.hotKeys.ArrowUp" | "hotKeyConfig.hotKeys.End" | "hotKeyConfig.hotKeys.Home" | "hotKeyConfig.hotKeys.PageDown" | "hotKeyConfig.hotKeys.PageUp" | "hotKeyConfig.hotKeys.Delete" | "hotKeyConfig.hotKeys.0" | "hotKeyConfig.hotKeys.1" | "hotKeyConfig.hotKeys.2" | "hotKeyConfig.hotKeys.3" | "hotKeyConfig.hotKeys.4" | "hotKeyConfig.hotKeys.5" | "hotKeyConfig.hotKeys.6" | "hotKeyConfig.hotKeys.7" | "hotKeyConfig.hotKeys.8" | "hotKeyConfig.hotKeys.9" | "hotKeyConfig.hotKeys.a" | "hotKeyConfig.hotKeys.b" | "hotKeyConfig.hotKeys.c" | "hotKeyConfig.hotKeys.d" | "hotKeyConfig.hotKeys.e" | "hotKeyConfig.hotKeys.f" | "hotKeyConfig.hotKeys.g" | "hotKeyConfig.hotKeys.h" | "hotKeyConfig.hotKeys.i" | "hotKeyConfig.hotKeys.j" | "hotKeyConfig.hotKeys.k" | "hotKeyConfig.hotKeys.l" | "hotKeyConfig.hotKeys.m" | "hotKeyConfig.hotKeys.n" | "hotKeyConfig.hotKeys.o" | "hotKeyConfig.hotKeys.p" | "hotKeyConfig.hotKeys.q" | "hotKeyConfig.hotKeys.r" | "hotKeyConfig.hotKeys.s" | "hotKeyConfig.hotKeys.t" | "hotKeyConfig.hotKeys.u" | "hotKeyConfig.hotKeys.v" | "hotKeyConfig.hotKeys.w" | "hotKeyConfig.hotKeys.x" | "hotKeyConfig.hotKeys.y" | "hotKeyConfig.hotKeys.z" | "hotKeyConfig.hotKeys.*" | "hotKeyConfig.hotKeys.+" | "hotKeyConfig.hotKeys.-" | "hotKeyConfig.hotKeys.." | "hotKeyConfig.hotKeys.F1" | "hotKeyConfig.hotKeys.F2" | "hotKeyConfig.hotKeys.F3" | "hotKeyConfig.hotKeys.F4" | "hotKeyConfig.hotKeys.F5" | "hotKeyConfig.hotKeys.F6" | "hotKeyConfig.hotKeys.F7" | "hotKeyConfig.hotKeys.F8" | "hotKeyConfig.hotKeys.F9" | "hotKeyConfig.hotKeys.F10" | "hotKeyConfig.hotKeys.F11" | "hotKeyConfig.hotKeys.F12" | "hotKeyConfig.hotKeys.;" | "hotKeyConfig.hotKeys.=" | "hotKeyConfig.hotKeys.," | "hotKeyConfig.hotKeys.`" | "hotKeyConfig.hotKeys.[" | "hotKeyConfig.hotKeys.\\" | "hotKeyConfig.hotKeys.]" | "hotKeyConfig.hotKeys..modifiers" | `hotKeyConfig.hotKeys..modifiers.${number}` | "hotKeyConfig.hotKeys..event" | "hotKeyConfig.hotKeys./.modifiers" | `hotKeyConfig.hotKeys./.modifiers.${number}` | "hotKeyConfig.hotKeys./.event" | "hotKeyConfig.hotKeys.Space.modifiers" | `hotKeyConfig.hotKeys.Space.modifiers.${number}` | "hotKeyConfig.hotKeys.Space.event" | "hotKeyConfig.hotKeys.Backspace.modifiers" | `hotKeyConfig.hotKeys.Backspace.modifiers.${number}` | "hotKeyConfig.hotKeys.Backspace.event" | "hotKeyConfig.hotKeys.Tab.modifiers" | `hotKeyConfig.hotKeys.Tab.modifiers.${number}` | "hotKeyConfig.hotKeys.Tab.event" | "hotKeyConfig.hotKeys.Enter.modifiers" | `hotKeyConfig.hotKeys.Enter.modifiers.${number}` | "hotKeyConfig.hotKeys.Enter.event" | "hotKeyConfig.hotKeys.Escape.modifiers" | `hotKeyConfig.hotKeys.Escape.modifiers.${number}` | "hotKeyConfig.hotKeys.Escape.event" | "hotKeyConfig.hotKeys.ArrowDown.modifiers" | `hotKeyConfig.hotKeys.ArrowDown.modifiers.${number}` | "hotKeyConfig.hotKeys.ArrowDown.event" | "hotKeyConfig.hotKeys.ArrowLeft.modifiers" | `hotKeyConfig.hotKeys.ArrowLeft.modifiers.${number}` | "hotKeyConfig.hotKeys.ArrowLeft.event" | "hotKeyConfig.hotKeys.ArrowRight.modifiers" | `hotKeyConfig.hotKeys.ArrowRight.modifiers.${number}` | "hotKeyConfig.hotKeys.ArrowRight.event" | "hotKeyConfig.hotKeys.ArrowUp.modifiers" | `hotKeyConfig.hotKeys.ArrowUp.modifiers.${number}` | "hotKeyConfig.hotKeys.ArrowUp.event" | "hotKeyConfig.hotKeys.End.modifiers" | `hotKeyConfig.hotKeys.End.modifiers.${number}` | "hotKeyConfig.hotKeys.End.event" | "hotKeyConfig.hotKeys.Home.modifiers" | `hotKeyConfig.hotKeys.Home.modifiers.${number}` | "hotKeyConfig.hotKeys.Home.event" | "hotKeyConfig.hotKeys.PageDown.modifiers" | `hotKeyConfig.hotKeys.PageDown.modifiers.${number}` | "hotKeyConfig.hotKeys.PageDown.event" | "hotKeyConfig.hotKeys.PageUp.modifiers" | `hotKeyConfig.hotKeys.PageUp.modifiers.${number}` | "hotKeyConfig.hotKeys.PageUp.event" | "hotKeyConfig.hotKeys.Delete.modifiers" | `hotKeyConfig.hotKeys.Delete.modifiers.${number}` | "hotKeyConfig.hotKeys.Delete.event" | "hotKeyConfig.hotKeys.0.modifiers" | `hotKeyConfig.hotKeys.0.modifiers.${number}` | "hotKeyConfig.hotKeys.0.event" | "hotKeyConfig.hotKeys.1.modifiers" | `hotKeyConfig.hotKeys.1.modifiers.${number}` | "hotKeyConfig.hotKeys.1.event" | "hotKeyConfig.hotKeys.2.modifiers" | `hotKeyConfig.hotKeys.2.modifiers.${number}` | "hotKeyConfig.hotKeys.2.event" | "hotKeyConfig.hotKeys.3.modifiers" | `hotKeyConfig.hotKeys.3.modifiers.${number}` | "hotKeyConfig.hotKeys.3.event" | "hotKeyConfig.hotKeys.4.modifiers" | `hotKeyConfig.hotKeys.4.modifiers.${number}` | "hotKeyConfig.hotKeys.4.event" | "hotKeyConfig.hotKeys.5.modifiers" | `hotKeyConfig.hotKeys.5.modifiers.${number}` | "hotKeyConfig.hotKeys.5.event" | "hotKeyConfig.hotKeys.6.modifiers" | `hotKeyConfig.hotKeys.6.modifiers.${number}` | "hotKeyConfig.hotKeys.6.event" | "hotKeyConfig.hotKeys.7.modifiers" | `hotKeyConfig.hotKeys.7.modifiers.${number}` | "hotKeyConfig.hotKeys.7.event" | "hotKeyConfig.hotKeys.8.modifiers" | `hotKeyConfig.hotKeys.8.modifiers.${number}` | "hotKeyConfig.hotKeys.8.event" | "hotKeyConfig.hotKeys.9.modifiers" | `hotKeyConfig.hotKeys.9.modifiers.${number}` | "hotKeyConfig.hotKeys.9.event" | "hotKeyConfig.hotKeys.a.modifiers" | `hotKeyConfig.hotKeys.a.modifiers.${number}` | "hotKeyConfig.hotKeys.a.event" | "hotKeyConfig.hotKeys.b.modifiers" | `hotKeyConfig.hotKeys.b.modifiers.${number}` | "hotKeyConfig.hotKeys.b.event" | "hotKeyConfig.hotKeys.c.modifiers" | `hotKeyConfig.hotKeys.c.modifiers.${number}` | "hotKeyConfig.hotKeys.c.event" | "hotKeyConfig.hotKeys.d.modifiers" | `hotKeyConfig.hotKeys.d.modifiers.${number}` | "hotKeyConfig.hotKeys.d.event" | "hotKeyConfig.hotKeys.e.modifiers" | `hotKeyConfig.hotKeys.e.modifiers.${number}` | "hotKeyConfig.hotKeys.e.event" | "hotKeyConfig.hotKeys.f.modifiers" | `hotKeyConfig.hotKeys.f.modifiers.${number}` | "hotKeyConfig.hotKeys.f.event" | "hotKeyConfig.hotKeys.g.modifiers" | `hotKeyConfig.hotKeys.g.modifiers.${number}` | "hotKeyConfig.hotKeys.g.event" | "hotKeyConfig.hotKeys.h.modifiers" | `hotKeyConfig.hotKeys.h.modifiers.${number}` | "hotKeyConfig.hotKeys.h.event" | "hotKeyConfig.hotKeys.i.modifiers" | `hotKeyConfig.hotKeys.i.modifiers.${number}` | "hotKeyConfig.hotKeys.i.event" | "hotKeyConfig.hotKeys.j.modifiers" | `hotKeyConfig.hotKeys.j.modifiers.${number}` | "hotKeyConfig.hotKeys.j.event" | "hotKeyConfig.hotKeys.k.modifiers" | `hotKeyConfig.hotKeys.k.modifiers.${number}` | "hotKeyConfig.hotKeys.k.event" | "hotKeyConfig.hotKeys.l.modifiers" | `hotKeyConfig.hotKeys.l.modifiers.${number}` | "hotKeyConfig.hotKeys.l.event" | "hotKeyConfig.hotKeys.m.modifiers" | `hotKeyConfig.hotKeys.m.modifiers.${number}` | "hotKeyConfig.hotKeys.m.event" | "hotKeyConfig.hotKeys.n.modifiers" | `hotKeyConfig.hotKeys.n.modifiers.${number}` | "hotKeyConfig.hotKeys.n.event" | "hotKeyConfig.hotKeys.o.modifiers" | `hotKeyConfig.hotKeys.o.modifiers.${number}` | "hotKeyConfig.hotKeys.o.event" | "hotKeyConfig.hotKeys.p.modifiers" | `hotKeyConfig.hotKeys.p.modifiers.${number}` | "hotKeyConfig.hotKeys.p.event" | "hotKeyConfig.hotKeys.q.modifiers" | `hotKeyConfig.hotKeys.q.modifiers.${number}` | "hotKeyConfig.hotKeys.q.event" | "hotKeyConfig.hotKeys.r.modifiers" | `hotKeyConfig.hotKeys.r.modifiers.${number}` | "hotKeyConfig.hotKeys.r.event" | "hotKeyConfig.hotKeys.s.modifiers" | `hotKeyConfig.hotKeys.s.modifiers.${number}` | "hotKeyConfig.hotKeys.s.event" | "hotKeyConfig.hotKeys.t.modifiers" | `hotKeyConfig.hotKeys.t.modifiers.${number}` | "hotKeyConfig.hotKeys.t.event" | "hotKeyConfig.hotKeys.u.modifiers" | `hotKeyConfig.hotKeys.u.modifiers.${number}` | "hotKeyConfig.hotKeys.u.event" | "hotKeyConfig.hotKeys.v.modifiers" | `hotKeyConfig.hotKeys.v.modifiers.${number}` | "hotKeyConfig.hotKeys.v.event" | "hotKeyConfig.hotKeys.w.modifiers" | `hotKeyConfig.hotKeys.w.modifiers.${number}` | "hotKeyConfig.hotKeys.w.event" | "hotKeyConfig.hotKeys.x.modifiers" | `hotKeyConfig.hotKeys.x.modifiers.${number}` | "hotKeyConfig.hotKeys.x.event" | "hotKeyConfig.hotKeys.y.modifiers" | `hotKeyConfig.hotKeys.y.modifiers.${number}` | "hotKeyConfig.hotKeys.y.event" | "hotKeyConfig.hotKeys.z.modifiers" | `hotKeyConfig.hotKeys.z.modifiers.${number}` | "hotKeyConfig.hotKeys.z.event" | "hotKeyConfig.hotKeys.*.modifiers" | `hotKeyConfig.hotKeys.*.modifiers.${number}` | "hotKeyConfig.hotKeys.*.event" | "hotKeyConfig.hotKeys.+.modifiers" | `hotKeyConfig.hotKeys.+.modifiers.${number}` | "hotKeyConfig.hotKeys.+.event" | "hotKeyConfig.hotKeys.-.modifiers" | `hotKeyConfig.hotKeys.-.modifiers.${number}` | "hotKeyConfig.hotKeys.-.event" | "hotKeyConfig.hotKeys...modifiers" | `hotKeyConfig.hotKeys...modifiers.${number}` | "hotKeyConfig.hotKeys...event" | "hotKeyConfig.hotKeys.F1.modifiers" | `hotKeyConfig.hotKeys.F1.modifiers.${number}` | "hotKeyConfig.hotKeys.F1.event" | "hotKeyConfig.hotKeys.F2.modifiers" | `hotKeyConfig.hotKeys.F2.modifiers.${number}` | "hotKeyConfig.hotKeys.F2.event" | "hotKeyConfig.hotKeys.F3.modifiers" | `hotKeyConfig.hotKeys.F3.modifiers.${number}` | "hotKeyConfig.hotKeys.F3.event" | "hotKeyConfig.hotKeys.F4.modifiers" | `hotKeyConfig.hotKeys.F4.modifiers.${number}` | "hotKeyConfig.hotKeys.F4.event" | "hotKeyConfig.hotKeys.F5.modifiers" | `hotKeyConfig.hotKeys.F5.modifiers.${number}` | "hotKeyConfig.hotKeys.F5.event" | "hotKeyConfig.hotKeys.F6.modifiers" | `hotKeyConfig.hotKeys.F6.modifiers.${number}` | "hotKeyConfig.hotKeys.F6.event" | "hotKeyConfig.hotKeys.F7.modifiers" | `hotKeyConfig.hotKeys.F7.modifiers.${number}` | "hotKeyConfig.hotKeys.F7.event" | "hotKeyConfig.hotKeys.F8.modifiers" | `hotKeyConfig.hotKeys.F8.modifiers.${number}` | "hotKeyConfig.hotKeys.F8.event" | "hotKeyConfig.hotKeys.F9.modifiers" | `hotKeyConfig.hotKeys.F9.modifiers.${number}` | "hotKeyConfig.hotKeys.F9.event" | "hotKeyConfig.hotKeys.F10.modifiers" | `hotKeyConfig.hotKeys.F10.modifiers.${number}` | "hotKeyConfig.hotKeys.F10.event" | "hotKeyConfig.hotKeys.F11.modifiers" | `hotKeyConfig.hotKeys.F11.modifiers.${number}` | "hotKeyConfig.hotKeys.F11.event" | "hotKeyConfig.hotKeys.F12.modifiers" | `hotKeyConfig.hotKeys.F12.modifiers.${number}` | "hotKeyConfig.hotKeys.F12.event" | "hotKeyConfig.hotKeys.;.modifiers" | `hotKeyConfig.hotKeys.;.modifiers.${number}` | "hotKeyConfig.hotKeys.;.event" | "hotKeyConfig.hotKeys.=.modifiers" | `hotKeyConfig.hotKeys.=.modifiers.${number}` | "hotKeyConfig.hotKeys.=.event" | "hotKeyConfig.hotKeys.,.modifiers" | `hotKeyConfig.hotKeys.,.modifiers.${number}` | "hotKeyConfig.hotKeys.,.event" | "hotKeyConfig.hotKeys.`.modifiers" | `hotKeyConfig.hotKeys.\`.modifiers.${number}` | "hotKeyConfig.hotKeys.`.event" | "hotKeyConfig.hotKeys.[.modifiers" | `hotKeyConfig.hotKeys.[.modifiers.${number}` | "hotKeyConfig.hotKeys.[.event" | "hotKeyConfig.hotKeys.\\.modifiers" | `hotKeyConfig.hotKeys.\\.modifiers.${number}` | "hotKeyConfig.hotKeys.\\.event" | "hotKeyConfig.hotKeys.].modifiers" | `hotKeyConfig.hotKeys.].modifiers.${number}` | "hotKeyConfig.hotKeys.].event">(uid: (string & BRAND<"workspace">) | null | undefined, path: P, value: P extends "cookies" | "description" | "name" | "uid" | "collections" | "environments" | "activeEnvironmentId" | "themeId" | "selectedHttpClient" | "hotKeyConfig" | "proxyUrl" ? {
3477
- uid: string & BRAND<"workspace">;
3478
- name: string;
3479
- description: string;
3480
- collections: (string & BRAND<"collection">)[];
3481
- environments: Record<string, string>;
3482
- activeEnvironmentId: string;
3483
- cookies: (string & BRAND<"cookie">)[];
3484
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3485
- selectedHttpClient: {
3486
- targetKey: string;
3487
- clientKey: string;
3488
- };
3489
- hotKeyConfig?: {
3490
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3491
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3492
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3493
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3494
- }>> | undefined;
3495
- } | undefined;
3496
- proxyUrl?: string | undefined;
3497
- }[P] : P extends `${infer K}.${infer R}` ? K extends "cookies" | "description" | "name" | "uid" | "collections" | "environments" | "activeEnvironmentId" | "themeId" | "selectedHttpClient" | "hotKeyConfig" | "proxyUrl" ? R extends Path< {
3498
- uid: string & BRAND<"workspace">;
3499
- name: string;
3500
- description: string;
3501
- collections: (string & BRAND<"collection">)[];
3502
- environments: Record<string, string>;
3503
- activeEnvironmentId: string;
3504
- cookies: (string & BRAND<"cookie">)[];
3505
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3506
- selectedHttpClient: {
3507
- targetKey: string;
3508
- clientKey: string;
3509
- };
3510
- hotKeyConfig?: {
3511
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3512
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3513
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3514
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3515
- }>> | undefined;
3516
- } | undefined;
3517
- proxyUrl?: string | undefined;
3518
- }[K]> ? PathValue< {
3519
- uid: string & BRAND<"workspace">;
3520
- name: string;
3521
- description: string;
3522
- collections: (string & BRAND<"collection">)[];
3523
- environments: Record<string, string>;
3524
- activeEnvironmentId: string;
3525
- cookies: (string & BRAND<"cookie">)[];
3526
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3527
- selectedHttpClient: {
3528
- targetKey: string;
3529
- clientKey: string;
3530
- };
3531
- hotKeyConfig?: {
3532
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3533
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3534
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3535
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3536
- }>> | undefined;
3537
- } | undefined;
3538
- proxyUrl?: string | undefined;
3539
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3540
- untrackedEdit: <P extends "cookies" | "description" | "name" | "uid" | "collections" | "environments" | "activeEnvironmentId" | "themeId" | "selectedHttpClient" | "hotKeyConfig" | "proxyUrl" | `cookies.${number}` | `collections.${number}` | `environments.${string}` | "selectedHttpClient.targetKey" | "selectedHttpClient.clientKey" | "hotKeyConfig.modifiers" | "hotKeyConfig.hotKeys" | `hotKeyConfig.modifiers.${number}` | "hotKeyConfig.hotKeys." | "hotKeyConfig.hotKeys./" | "hotKeyConfig.hotKeys.Space" | "hotKeyConfig.hotKeys.Backspace" | "hotKeyConfig.hotKeys.Tab" | "hotKeyConfig.hotKeys.Enter" | "hotKeyConfig.hotKeys.Escape" | "hotKeyConfig.hotKeys.ArrowDown" | "hotKeyConfig.hotKeys.ArrowLeft" | "hotKeyConfig.hotKeys.ArrowRight" | "hotKeyConfig.hotKeys.ArrowUp" | "hotKeyConfig.hotKeys.End" | "hotKeyConfig.hotKeys.Home" | "hotKeyConfig.hotKeys.PageDown" | "hotKeyConfig.hotKeys.PageUp" | "hotKeyConfig.hotKeys.Delete" | "hotKeyConfig.hotKeys.0" | "hotKeyConfig.hotKeys.1" | "hotKeyConfig.hotKeys.2" | "hotKeyConfig.hotKeys.3" | "hotKeyConfig.hotKeys.4" | "hotKeyConfig.hotKeys.5" | "hotKeyConfig.hotKeys.6" | "hotKeyConfig.hotKeys.7" | "hotKeyConfig.hotKeys.8" | "hotKeyConfig.hotKeys.9" | "hotKeyConfig.hotKeys.a" | "hotKeyConfig.hotKeys.b" | "hotKeyConfig.hotKeys.c" | "hotKeyConfig.hotKeys.d" | "hotKeyConfig.hotKeys.e" | "hotKeyConfig.hotKeys.f" | "hotKeyConfig.hotKeys.g" | "hotKeyConfig.hotKeys.h" | "hotKeyConfig.hotKeys.i" | "hotKeyConfig.hotKeys.j" | "hotKeyConfig.hotKeys.k" | "hotKeyConfig.hotKeys.l" | "hotKeyConfig.hotKeys.m" | "hotKeyConfig.hotKeys.n" | "hotKeyConfig.hotKeys.o" | "hotKeyConfig.hotKeys.p" | "hotKeyConfig.hotKeys.q" | "hotKeyConfig.hotKeys.r" | "hotKeyConfig.hotKeys.s" | "hotKeyConfig.hotKeys.t" | "hotKeyConfig.hotKeys.u" | "hotKeyConfig.hotKeys.v" | "hotKeyConfig.hotKeys.w" | "hotKeyConfig.hotKeys.x" | "hotKeyConfig.hotKeys.y" | "hotKeyConfig.hotKeys.z" | "hotKeyConfig.hotKeys.*" | "hotKeyConfig.hotKeys.+" | "hotKeyConfig.hotKeys.-" | "hotKeyConfig.hotKeys.." | "hotKeyConfig.hotKeys.F1" | "hotKeyConfig.hotKeys.F2" | "hotKeyConfig.hotKeys.F3" | "hotKeyConfig.hotKeys.F4" | "hotKeyConfig.hotKeys.F5" | "hotKeyConfig.hotKeys.F6" | "hotKeyConfig.hotKeys.F7" | "hotKeyConfig.hotKeys.F8" | "hotKeyConfig.hotKeys.F9" | "hotKeyConfig.hotKeys.F10" | "hotKeyConfig.hotKeys.F11" | "hotKeyConfig.hotKeys.F12" | "hotKeyConfig.hotKeys.;" | "hotKeyConfig.hotKeys.=" | "hotKeyConfig.hotKeys.," | "hotKeyConfig.hotKeys.`" | "hotKeyConfig.hotKeys.[" | "hotKeyConfig.hotKeys.\\" | "hotKeyConfig.hotKeys.]" | "hotKeyConfig.hotKeys..modifiers" | `hotKeyConfig.hotKeys..modifiers.${number}` | "hotKeyConfig.hotKeys..event" | "hotKeyConfig.hotKeys./.modifiers" | `hotKeyConfig.hotKeys./.modifiers.${number}` | "hotKeyConfig.hotKeys./.event" | "hotKeyConfig.hotKeys.Space.modifiers" | `hotKeyConfig.hotKeys.Space.modifiers.${number}` | "hotKeyConfig.hotKeys.Space.event" | "hotKeyConfig.hotKeys.Backspace.modifiers" | `hotKeyConfig.hotKeys.Backspace.modifiers.${number}` | "hotKeyConfig.hotKeys.Backspace.event" | "hotKeyConfig.hotKeys.Tab.modifiers" | `hotKeyConfig.hotKeys.Tab.modifiers.${number}` | "hotKeyConfig.hotKeys.Tab.event" | "hotKeyConfig.hotKeys.Enter.modifiers" | `hotKeyConfig.hotKeys.Enter.modifiers.${number}` | "hotKeyConfig.hotKeys.Enter.event" | "hotKeyConfig.hotKeys.Escape.modifiers" | `hotKeyConfig.hotKeys.Escape.modifiers.${number}` | "hotKeyConfig.hotKeys.Escape.event" | "hotKeyConfig.hotKeys.ArrowDown.modifiers" | `hotKeyConfig.hotKeys.ArrowDown.modifiers.${number}` | "hotKeyConfig.hotKeys.ArrowDown.event" | "hotKeyConfig.hotKeys.ArrowLeft.modifiers" | `hotKeyConfig.hotKeys.ArrowLeft.modifiers.${number}` | "hotKeyConfig.hotKeys.ArrowLeft.event" | "hotKeyConfig.hotKeys.ArrowRight.modifiers" | `hotKeyConfig.hotKeys.ArrowRight.modifiers.${number}` | "hotKeyConfig.hotKeys.ArrowRight.event" | "hotKeyConfig.hotKeys.ArrowUp.modifiers" | `hotKeyConfig.hotKeys.ArrowUp.modifiers.${number}` | "hotKeyConfig.hotKeys.ArrowUp.event" | "hotKeyConfig.hotKeys.End.modifiers" | `hotKeyConfig.hotKeys.End.modifiers.${number}` | "hotKeyConfig.hotKeys.End.event" | "hotKeyConfig.hotKeys.Home.modifiers" | `hotKeyConfig.hotKeys.Home.modifiers.${number}` | "hotKeyConfig.hotKeys.Home.event" | "hotKeyConfig.hotKeys.PageDown.modifiers" | `hotKeyConfig.hotKeys.PageDown.modifiers.${number}` | "hotKeyConfig.hotKeys.PageDown.event" | "hotKeyConfig.hotKeys.PageUp.modifiers" | `hotKeyConfig.hotKeys.PageUp.modifiers.${number}` | "hotKeyConfig.hotKeys.PageUp.event" | "hotKeyConfig.hotKeys.Delete.modifiers" | `hotKeyConfig.hotKeys.Delete.modifiers.${number}` | "hotKeyConfig.hotKeys.Delete.event" | "hotKeyConfig.hotKeys.0.modifiers" | `hotKeyConfig.hotKeys.0.modifiers.${number}` | "hotKeyConfig.hotKeys.0.event" | "hotKeyConfig.hotKeys.1.modifiers" | `hotKeyConfig.hotKeys.1.modifiers.${number}` | "hotKeyConfig.hotKeys.1.event" | "hotKeyConfig.hotKeys.2.modifiers" | `hotKeyConfig.hotKeys.2.modifiers.${number}` | "hotKeyConfig.hotKeys.2.event" | "hotKeyConfig.hotKeys.3.modifiers" | `hotKeyConfig.hotKeys.3.modifiers.${number}` | "hotKeyConfig.hotKeys.3.event" | "hotKeyConfig.hotKeys.4.modifiers" | `hotKeyConfig.hotKeys.4.modifiers.${number}` | "hotKeyConfig.hotKeys.4.event" | "hotKeyConfig.hotKeys.5.modifiers" | `hotKeyConfig.hotKeys.5.modifiers.${number}` | "hotKeyConfig.hotKeys.5.event" | "hotKeyConfig.hotKeys.6.modifiers" | `hotKeyConfig.hotKeys.6.modifiers.${number}` | "hotKeyConfig.hotKeys.6.event" | "hotKeyConfig.hotKeys.7.modifiers" | `hotKeyConfig.hotKeys.7.modifiers.${number}` | "hotKeyConfig.hotKeys.7.event" | "hotKeyConfig.hotKeys.8.modifiers" | `hotKeyConfig.hotKeys.8.modifiers.${number}` | "hotKeyConfig.hotKeys.8.event" | "hotKeyConfig.hotKeys.9.modifiers" | `hotKeyConfig.hotKeys.9.modifiers.${number}` | "hotKeyConfig.hotKeys.9.event" | "hotKeyConfig.hotKeys.a.modifiers" | `hotKeyConfig.hotKeys.a.modifiers.${number}` | "hotKeyConfig.hotKeys.a.event" | "hotKeyConfig.hotKeys.b.modifiers" | `hotKeyConfig.hotKeys.b.modifiers.${number}` | "hotKeyConfig.hotKeys.b.event" | "hotKeyConfig.hotKeys.c.modifiers" | `hotKeyConfig.hotKeys.c.modifiers.${number}` | "hotKeyConfig.hotKeys.c.event" | "hotKeyConfig.hotKeys.d.modifiers" | `hotKeyConfig.hotKeys.d.modifiers.${number}` | "hotKeyConfig.hotKeys.d.event" | "hotKeyConfig.hotKeys.e.modifiers" | `hotKeyConfig.hotKeys.e.modifiers.${number}` | "hotKeyConfig.hotKeys.e.event" | "hotKeyConfig.hotKeys.f.modifiers" | `hotKeyConfig.hotKeys.f.modifiers.${number}` | "hotKeyConfig.hotKeys.f.event" | "hotKeyConfig.hotKeys.g.modifiers" | `hotKeyConfig.hotKeys.g.modifiers.${number}` | "hotKeyConfig.hotKeys.g.event" | "hotKeyConfig.hotKeys.h.modifiers" | `hotKeyConfig.hotKeys.h.modifiers.${number}` | "hotKeyConfig.hotKeys.h.event" | "hotKeyConfig.hotKeys.i.modifiers" | `hotKeyConfig.hotKeys.i.modifiers.${number}` | "hotKeyConfig.hotKeys.i.event" | "hotKeyConfig.hotKeys.j.modifiers" | `hotKeyConfig.hotKeys.j.modifiers.${number}` | "hotKeyConfig.hotKeys.j.event" | "hotKeyConfig.hotKeys.k.modifiers" | `hotKeyConfig.hotKeys.k.modifiers.${number}` | "hotKeyConfig.hotKeys.k.event" | "hotKeyConfig.hotKeys.l.modifiers" | `hotKeyConfig.hotKeys.l.modifiers.${number}` | "hotKeyConfig.hotKeys.l.event" | "hotKeyConfig.hotKeys.m.modifiers" | `hotKeyConfig.hotKeys.m.modifiers.${number}` | "hotKeyConfig.hotKeys.m.event" | "hotKeyConfig.hotKeys.n.modifiers" | `hotKeyConfig.hotKeys.n.modifiers.${number}` | "hotKeyConfig.hotKeys.n.event" | "hotKeyConfig.hotKeys.o.modifiers" | `hotKeyConfig.hotKeys.o.modifiers.${number}` | "hotKeyConfig.hotKeys.o.event" | "hotKeyConfig.hotKeys.p.modifiers" | `hotKeyConfig.hotKeys.p.modifiers.${number}` | "hotKeyConfig.hotKeys.p.event" | "hotKeyConfig.hotKeys.q.modifiers" | `hotKeyConfig.hotKeys.q.modifiers.${number}` | "hotKeyConfig.hotKeys.q.event" | "hotKeyConfig.hotKeys.r.modifiers" | `hotKeyConfig.hotKeys.r.modifiers.${number}` | "hotKeyConfig.hotKeys.r.event" | "hotKeyConfig.hotKeys.s.modifiers" | `hotKeyConfig.hotKeys.s.modifiers.${number}` | "hotKeyConfig.hotKeys.s.event" | "hotKeyConfig.hotKeys.t.modifiers" | `hotKeyConfig.hotKeys.t.modifiers.${number}` | "hotKeyConfig.hotKeys.t.event" | "hotKeyConfig.hotKeys.u.modifiers" | `hotKeyConfig.hotKeys.u.modifiers.${number}` | "hotKeyConfig.hotKeys.u.event" | "hotKeyConfig.hotKeys.v.modifiers" | `hotKeyConfig.hotKeys.v.modifiers.${number}` | "hotKeyConfig.hotKeys.v.event" | "hotKeyConfig.hotKeys.w.modifiers" | `hotKeyConfig.hotKeys.w.modifiers.${number}` | "hotKeyConfig.hotKeys.w.event" | "hotKeyConfig.hotKeys.x.modifiers" | `hotKeyConfig.hotKeys.x.modifiers.${number}` | "hotKeyConfig.hotKeys.x.event" | "hotKeyConfig.hotKeys.y.modifiers" | `hotKeyConfig.hotKeys.y.modifiers.${number}` | "hotKeyConfig.hotKeys.y.event" | "hotKeyConfig.hotKeys.z.modifiers" | `hotKeyConfig.hotKeys.z.modifiers.${number}` | "hotKeyConfig.hotKeys.z.event" | "hotKeyConfig.hotKeys.*.modifiers" | `hotKeyConfig.hotKeys.*.modifiers.${number}` | "hotKeyConfig.hotKeys.*.event" | "hotKeyConfig.hotKeys.+.modifiers" | `hotKeyConfig.hotKeys.+.modifiers.${number}` | "hotKeyConfig.hotKeys.+.event" | "hotKeyConfig.hotKeys.-.modifiers" | `hotKeyConfig.hotKeys.-.modifiers.${number}` | "hotKeyConfig.hotKeys.-.event" | "hotKeyConfig.hotKeys...modifiers" | `hotKeyConfig.hotKeys...modifiers.${number}` | "hotKeyConfig.hotKeys...event" | "hotKeyConfig.hotKeys.F1.modifiers" | `hotKeyConfig.hotKeys.F1.modifiers.${number}` | "hotKeyConfig.hotKeys.F1.event" | "hotKeyConfig.hotKeys.F2.modifiers" | `hotKeyConfig.hotKeys.F2.modifiers.${number}` | "hotKeyConfig.hotKeys.F2.event" | "hotKeyConfig.hotKeys.F3.modifiers" | `hotKeyConfig.hotKeys.F3.modifiers.${number}` | "hotKeyConfig.hotKeys.F3.event" | "hotKeyConfig.hotKeys.F4.modifiers" | `hotKeyConfig.hotKeys.F4.modifiers.${number}` | "hotKeyConfig.hotKeys.F4.event" | "hotKeyConfig.hotKeys.F5.modifiers" | `hotKeyConfig.hotKeys.F5.modifiers.${number}` | "hotKeyConfig.hotKeys.F5.event" | "hotKeyConfig.hotKeys.F6.modifiers" | `hotKeyConfig.hotKeys.F6.modifiers.${number}` | "hotKeyConfig.hotKeys.F6.event" | "hotKeyConfig.hotKeys.F7.modifiers" | `hotKeyConfig.hotKeys.F7.modifiers.${number}` | "hotKeyConfig.hotKeys.F7.event" | "hotKeyConfig.hotKeys.F8.modifiers" | `hotKeyConfig.hotKeys.F8.modifiers.${number}` | "hotKeyConfig.hotKeys.F8.event" | "hotKeyConfig.hotKeys.F9.modifiers" | `hotKeyConfig.hotKeys.F9.modifiers.${number}` | "hotKeyConfig.hotKeys.F9.event" | "hotKeyConfig.hotKeys.F10.modifiers" | `hotKeyConfig.hotKeys.F10.modifiers.${number}` | "hotKeyConfig.hotKeys.F10.event" | "hotKeyConfig.hotKeys.F11.modifiers" | `hotKeyConfig.hotKeys.F11.modifiers.${number}` | "hotKeyConfig.hotKeys.F11.event" | "hotKeyConfig.hotKeys.F12.modifiers" | `hotKeyConfig.hotKeys.F12.modifiers.${number}` | "hotKeyConfig.hotKeys.F12.event" | "hotKeyConfig.hotKeys.;.modifiers" | `hotKeyConfig.hotKeys.;.modifiers.${number}` | "hotKeyConfig.hotKeys.;.event" | "hotKeyConfig.hotKeys.=.modifiers" | `hotKeyConfig.hotKeys.=.modifiers.${number}` | "hotKeyConfig.hotKeys.=.event" | "hotKeyConfig.hotKeys.,.modifiers" | `hotKeyConfig.hotKeys.,.modifiers.${number}` | "hotKeyConfig.hotKeys.,.event" | "hotKeyConfig.hotKeys.`.modifiers" | `hotKeyConfig.hotKeys.\`.modifiers.${number}` | "hotKeyConfig.hotKeys.`.event" | "hotKeyConfig.hotKeys.[.modifiers" | `hotKeyConfig.hotKeys.[.modifiers.${number}` | "hotKeyConfig.hotKeys.[.event" | "hotKeyConfig.hotKeys.\\.modifiers" | `hotKeyConfig.hotKeys.\\.modifiers.${number}` | "hotKeyConfig.hotKeys.\\.event" | "hotKeyConfig.hotKeys.].modifiers" | `hotKeyConfig.hotKeys.].modifiers.${number}` | "hotKeyConfig.hotKeys.].event">(uid: string & BRAND<"workspace">, path: P, value: P extends "cookies" | "description" | "name" | "uid" | "collections" | "environments" | "activeEnvironmentId" | "themeId" | "selectedHttpClient" | "hotKeyConfig" | "proxyUrl" ? {
3541
- uid: string & BRAND<"workspace">;
3542
- name: string;
3543
- description: string;
3544
- collections: (string & BRAND<"collection">)[];
3545
- environments: Record<string, string>;
3546
- activeEnvironmentId: string;
3547
- cookies: (string & BRAND<"cookie">)[];
3548
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3549
- selectedHttpClient: {
3550
- targetKey: string;
3551
- clientKey: string;
3552
- };
3553
- hotKeyConfig?: {
3554
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3555
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3556
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3557
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3558
- }>> | undefined;
3559
- } | undefined;
3560
- proxyUrl?: string | undefined;
3561
- }[P] : P extends `${infer K}.${infer R}` ? K extends "cookies" | "description" | "name" | "uid" | "collections" | "environments" | "activeEnvironmentId" | "themeId" | "selectedHttpClient" | "hotKeyConfig" | "proxyUrl" ? R extends Path< {
3562
- uid: string & BRAND<"workspace">;
3563
- name: string;
3564
- description: string;
3565
- collections: (string & BRAND<"collection">)[];
3566
- environments: Record<string, string>;
3567
- activeEnvironmentId: string;
3568
- cookies: (string & BRAND<"cookie">)[];
3569
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3570
- selectedHttpClient: {
3571
- targetKey: string;
3572
- clientKey: string;
3573
- };
3574
- hotKeyConfig?: {
3575
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3576
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3577
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3578
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3579
- }>> | undefined;
3580
- } | undefined;
3581
- proxyUrl?: string | undefined;
3582
- }[K]> ? PathValue< {
3583
- uid: string & BRAND<"workspace">;
3584
- name: string;
3585
- description: string;
3586
- collections: (string & BRAND<"collection">)[];
3587
- environments: Record<string, string>;
3588
- activeEnvironmentId: string;
3589
- cookies: (string & BRAND<"cookie">)[];
3590
- themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "none";
3591
- selectedHttpClient: {
3592
- targetKey: string;
3593
- clientKey: string;
3594
- };
3595
- hotKeyConfig?: {
3596
- modifiers: ("Meta" | "Control" | "Shift" | "Alt" | "default")[];
3597
- hotKeys?: Partial<Record<"" | "/" | "Space" | "Backspace" | "Tab" | "Enter" | "Escape" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "ArrowUp" | "End" | "Home" | "PageDown" | "PageUp" | "Delete" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "*" | "+" | "-" | "." | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | ";" | "=" | "," | "`" | "[" | "\\" | "]", {
3598
- event: "addTopNav" | "closeModal" | "closeTopNav" | "createNew" | "executeRequest" | "focusAddressBar" | "focusRequestSearch" | "jumpToLastTab" | "jumpToTab" | "navigateSearchResultsDown" | "navigateSearchResultsUp" | "navigateTopNavLeft" | "navigateTopNavRight" | "openCommandPalette" | "selectSearchResult" | "toggleSidebar";
3599
- modifiers?: ("Meta" | "Control" | "Shift" | "Alt" | "default")[] | undefined;
3600
- }>> | undefined;
3601
- } | undefined;
3602
- proxyUrl?: string | undefined;
3603
- }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3604
- undo: (uid: string & BRAND<"workspace">) => void;
3605
- redo: (uid: string & BRAND<"workspace">) => void;
3606
- reset: () => void;
3607
- };
3608
- addCollectionEnvironment: (environmentName: string, environment: XScalarEnvironment, collectionUid: Collection["uid"]) => void;
3609
- removeCollectionEnvironment: (environmentName: string, collectionUid: Collection["uid"]) => void;
3610
- };
3611
- updateExample: (exampleKey: string, operationId: string) => void;
3612
- } | null;
3613
-
3614
- export { }
1
+ export * from './ApiClientModalProvider.js';
2
+ //# sourceMappingURL=index.d.ts.map