@scalar/api-client 2.6.0 → 2.7.0
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.
- package/CHANGELOG.md +55 -0
- package/dist/analytics.d.ts +2 -18
- package/dist/analytics.d.ts.map +1 -1
- package/dist/components/CodeInput/CodeInput.vue.d.ts +1 -1
- package/dist/components/CodeInput/CodeInput.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +66 -42
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
- package/dist/components/HttpMethod/HttpMethod.vue.d.ts +2 -2
- package/dist/hooks/useAnalytics.d.ts +2 -18
- package/dist/hooks/useAnalytics.d.ts.map +1 -1
- package/dist/hooks/useClientConfig.d.ts +115 -112
- package/dist/hooks/useClientConfig.d.ts.map +1 -1
- package/dist/layouts/App/create-api-client-app.d.ts +1378 -1306
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +2752 -2608
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/create-api-client-web.d.ts +1378 -1306
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +1378 -1306
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/find-request.d.ts +17 -17
- package/dist/libs/find-request.d.ts.map +1 -1
- package/dist/libs/hot-keys.d.ts +1 -1
- package/dist/libs/local-storage.d.ts.map +1 -1
- package/dist/libs/send-request/build-request-security.d.ts +1 -1
- package/dist/libs/send-request/create-fetch-body.d.ts +1 -1
- package/dist/libs/send-request/create-request-operation.test.d.ts +82 -82
- package/dist/libs/send-request/create-request-operation.test.d.ts.map +1 -1
- package/dist/plugins/plugin-manager.d.ts +1 -1
- package/dist/store/active-entities.d.ts +118 -118
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/collections.d.ts +127 -127
- package/dist/store/collections.d.ts.map +1 -1
- package/dist/store/cookies.d.ts +14 -14
- package/dist/store/environment.d.ts +23 -23
- package/dist/store/request-example.d.ts +546 -546
- package/dist/store/request-example.d.ts.map +1 -1
- package/dist/store/requests.d.ts +194 -194
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/security-schemes.d.ts +281 -281
- package/dist/store/security-schemes.d.ts.map +1 -1
- package/dist/store/servers.d.ts +45 -45
- package/dist/store/servers.d.ts.map +1 -1
- package/dist/store/store.d.ts +1378 -1306
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/store.js +18 -18
- package/dist/store/tags.d.ts +35 -35
- package/dist/store/tags.d.ts.map +1 -1
- package/dist/store/workspace.d.ts +47 -47
- package/dist/store/workspace.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.test.d.ts +2 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.test.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.d.ts +25 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue.js +30 -0
- package/dist/v2/blocks/operation-code-sample/components/HttpMethod.vue2.js +4 -0
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue.js +3 -3
- package/dist/v2/blocks/operation-code-sample/components/OperationCodeSample.vue2.js +102 -95
- package/dist/v2/blocks/operation-code-sample/helpers/find-client.js +16 -14
- package/dist/v2/blocks/operation-code-sample/helpers/generate-client-options.js +31 -2
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.d.ts +6 -1
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/helpers/get-example-from-schema.js +198 -131
- package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.bench.d.ts +2 -0
- package/dist/v2/blocks/operation-code-sample/helpers/operation-to-har/operation-to-har.bench.d.ts.map +1 -0
- package/dist/v2/blocks/operation-code-sample/index.d.ts +4 -1
- package/dist/v2/blocks/operation-code-sample/index.d.ts.map +1 -1
- package/dist/v2/blocks/operation-code-sample/index.js +10 -4
- package/dist/v2/blocks/scalar-auth-selector-block/helpers/security-scheme.d.ts +2 -6
- package/dist/v2/blocks/scalar-auth-selector-block/helpers/security-scheme.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts +54 -54
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuth.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.d.ts +54 -54
- package/dist/views/Request/RequestSection/RequestAuth/RequestAuthDataTable.vue.d.ts.map +1 -1
- package/dist/views/Request/ResponseSection/RequestHeaders.vue.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseHeaders.vue.js +1 -1
- package/dist/views/Request/libs/auth.d.ts +2 -2
- package/dist/views/Request/libs/watch-mode.d.ts +4 -4
- package/dist/views/Request/libs/watch-mode.d.ts.map +1 -1
- package/dist/views/Request/libs/watch-mode.js +241 -186
- package/package.json +25 -20
|
@@ -4,15 +4,13 @@ import type { Workspace } from '@scalar/oas-utils/entities/workspace';
|
|
|
4
4
|
/** Initiate the workspace collections */
|
|
5
5
|
export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
6
6
|
collections: Record<string, {
|
|
7
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
8
7
|
type: "collection";
|
|
9
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
10
8
|
openapi: string;
|
|
11
9
|
info: {
|
|
12
10
|
title: string;
|
|
13
11
|
version: string;
|
|
14
|
-
description?: string | undefined;
|
|
15
12
|
summary?: string | undefined;
|
|
13
|
+
description?: string | undefined;
|
|
16
14
|
termsOfService?: string | undefined;
|
|
17
15
|
contact?: {
|
|
18
16
|
name?: string | undefined;
|
|
@@ -24,27 +22,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
24
22
|
identifier?: string | undefined;
|
|
25
23
|
url?: string | undefined;
|
|
26
24
|
} | undefined;
|
|
27
|
-
|
|
25
|
+
'x-scalar-sdk-installation'?: {
|
|
28
26
|
lang: string;
|
|
29
|
-
description?: string | undefined;
|
|
30
27
|
source?: string | undefined;
|
|
28
|
+
description?: string | undefined;
|
|
31
29
|
}[] | undefined;
|
|
32
30
|
};
|
|
33
31
|
security: Record<string, string[]>[];
|
|
34
32
|
'x-scalar-icon': string;
|
|
33
|
+
uid: string & import("zod").$brand<"collection">;
|
|
35
34
|
securitySchemes: string[];
|
|
36
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
37
|
-
servers: (string & import("zod")
|
|
38
|
-
requests: (string & import("zod")
|
|
39
|
-
tags: (string & import("zod")
|
|
35
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
36
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
37
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
38
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
39
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
40
40
|
watchMode: boolean;
|
|
41
41
|
useCollectionSecurity: boolean;
|
|
42
42
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
43
|
+
jsonSchemaDialect?: string | undefined;
|
|
43
44
|
externalDocs?: {
|
|
44
45
|
url: string;
|
|
45
46
|
description?: string | undefined;
|
|
46
47
|
} | undefined;
|
|
47
|
-
jsonSchemaDialect?: string | undefined;
|
|
48
48
|
components?: Record<string, unknown> | undefined;
|
|
49
49
|
webhooks?: Record<string, unknown> | undefined;
|
|
50
50
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -53,28 +53,26 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
53
53
|
default: string;
|
|
54
54
|
description?: string | undefined;
|
|
55
55
|
}>;
|
|
56
|
-
color?: string | undefined;
|
|
57
56
|
description?: string | undefined;
|
|
57
|
+
color?: string | undefined;
|
|
58
58
|
}> | undefined;
|
|
59
59
|
'x-scalar-secrets'?: Record<string, {
|
|
60
60
|
description?: string | undefined;
|
|
61
61
|
example?: string | undefined;
|
|
62
62
|
}> | undefined;
|
|
63
|
-
selectedServerUid?: (string & import("zod")
|
|
63
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
64
64
|
documentUrl?: string | undefined;
|
|
65
65
|
integration?: string | null | undefined;
|
|
66
66
|
}>;
|
|
67
67
|
collectionMutators: {
|
|
68
68
|
add: (item: {
|
|
69
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
70
69
|
type: "collection";
|
|
71
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
72
70
|
openapi: string;
|
|
73
71
|
info: {
|
|
74
72
|
title: string;
|
|
75
73
|
version: string;
|
|
76
|
-
description?: string | undefined;
|
|
77
74
|
summary?: string | undefined;
|
|
75
|
+
description?: string | undefined;
|
|
78
76
|
termsOfService?: string | undefined;
|
|
79
77
|
contact?: {
|
|
80
78
|
name?: string | undefined;
|
|
@@ -86,27 +84,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
86
84
|
identifier?: string | undefined;
|
|
87
85
|
url?: string | undefined;
|
|
88
86
|
} | undefined;
|
|
89
|
-
|
|
87
|
+
'x-scalar-sdk-installation'?: {
|
|
90
88
|
lang: string;
|
|
91
|
-
description?: string | undefined;
|
|
92
89
|
source?: string | undefined;
|
|
90
|
+
description?: string | undefined;
|
|
93
91
|
}[] | undefined;
|
|
94
92
|
};
|
|
95
93
|
security: Record<string, string[]>[];
|
|
96
94
|
'x-scalar-icon': string;
|
|
95
|
+
uid: string & import("zod").$brand<"collection">;
|
|
97
96
|
securitySchemes: string[];
|
|
98
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
99
|
-
servers: (string & import("zod")
|
|
100
|
-
requests: (string & import("zod")
|
|
101
|
-
tags: (string & import("zod")
|
|
97
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
98
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
99
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
100
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
101
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
102
102
|
watchMode: boolean;
|
|
103
103
|
useCollectionSecurity: boolean;
|
|
104
104
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
105
|
+
jsonSchemaDialect?: string | undefined;
|
|
105
106
|
externalDocs?: {
|
|
106
107
|
url: string;
|
|
107
108
|
description?: string | undefined;
|
|
108
109
|
} | undefined;
|
|
109
|
-
jsonSchemaDialect?: string | undefined;
|
|
110
110
|
components?: Record<string, unknown> | undefined;
|
|
111
111
|
webhooks?: Record<string, unknown> | undefined;
|
|
112
112
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -115,28 +115,26 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
115
115
|
default: string;
|
|
116
116
|
description?: string | undefined;
|
|
117
117
|
}>;
|
|
118
|
-
color?: string | undefined;
|
|
119
118
|
description?: string | undefined;
|
|
119
|
+
color?: string | undefined;
|
|
120
120
|
}> | undefined;
|
|
121
121
|
'x-scalar-secrets'?: Record<string, {
|
|
122
122
|
description?: string | undefined;
|
|
123
123
|
example?: string | undefined;
|
|
124
124
|
}> | undefined;
|
|
125
|
-
selectedServerUid?: (string & import("zod")
|
|
125
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
126
126
|
documentUrl?: string | undefined;
|
|
127
127
|
integration?: string | null | undefined;
|
|
128
128
|
}) => void;
|
|
129
|
-
delete: (uid: (string & import("zod")
|
|
129
|
+
delete: (uid: (string & import("zod").$brand<"collection">) | null | undefined) => void;
|
|
130
130
|
set: (item: {
|
|
131
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
132
131
|
type: "collection";
|
|
133
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
134
132
|
openapi: string;
|
|
135
133
|
info: {
|
|
136
134
|
title: string;
|
|
137
135
|
version: string;
|
|
138
|
-
description?: string | undefined;
|
|
139
136
|
summary?: string | undefined;
|
|
137
|
+
description?: string | undefined;
|
|
140
138
|
termsOfService?: string | undefined;
|
|
141
139
|
contact?: {
|
|
142
140
|
name?: string | undefined;
|
|
@@ -148,27 +146,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
148
146
|
identifier?: string | undefined;
|
|
149
147
|
url?: string | undefined;
|
|
150
148
|
} | undefined;
|
|
151
|
-
|
|
149
|
+
'x-scalar-sdk-installation'?: {
|
|
152
150
|
lang: string;
|
|
153
|
-
description?: string | undefined;
|
|
154
151
|
source?: string | undefined;
|
|
152
|
+
description?: string | undefined;
|
|
155
153
|
}[] | undefined;
|
|
156
154
|
};
|
|
157
155
|
security: Record<string, string[]>[];
|
|
158
156
|
'x-scalar-icon': string;
|
|
157
|
+
uid: string & import("zod").$brand<"collection">;
|
|
159
158
|
securitySchemes: string[];
|
|
160
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
161
|
-
servers: (string & import("zod")
|
|
162
|
-
requests: (string & import("zod")
|
|
163
|
-
tags: (string & import("zod")
|
|
159
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
160
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
161
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
162
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
163
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
164
164
|
watchMode: boolean;
|
|
165
165
|
useCollectionSecurity: boolean;
|
|
166
166
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
167
|
+
jsonSchemaDialect?: string | undefined;
|
|
167
168
|
externalDocs?: {
|
|
168
169
|
url: string;
|
|
169
170
|
description?: string | undefined;
|
|
170
171
|
} | undefined;
|
|
171
|
-
jsonSchemaDialect?: string | undefined;
|
|
172
172
|
components?: Record<string, unknown> | undefined;
|
|
173
173
|
webhooks?: Record<string, unknown> | undefined;
|
|
174
174
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -177,27 +177,25 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
177
177
|
default: string;
|
|
178
178
|
description?: string | undefined;
|
|
179
179
|
}>;
|
|
180
|
-
color?: string | undefined;
|
|
181
180
|
description?: string | undefined;
|
|
181
|
+
color?: string | undefined;
|
|
182
182
|
}> | undefined;
|
|
183
183
|
'x-scalar-secrets'?: Record<string, {
|
|
184
184
|
description?: string | undefined;
|
|
185
185
|
example?: string | undefined;
|
|
186
186
|
}> | undefined;
|
|
187
|
-
selectedServerUid?: (string & import("zod")
|
|
187
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
188
188
|
documentUrl?: string | undefined;
|
|
189
189
|
integration?: string | null | undefined;
|
|
190
190
|
}) => void;
|
|
191
|
-
edit: <P extends "servers" | "
|
|
192
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
191
|
+
edit: <P extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "securitySchemes" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" | `servers.${number}` | "externalDocs.url" | "externalDocs.description" | `security.${number}` | `security.${number}.${string}` | `tags.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "info.title" | "info.summary" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.x-scalar-sdk-installation" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `info.x-scalar-sdk-installation.${number}` | `info.x-scalar-sdk-installation.${number}.description` | `info.x-scalar-sdk-installation.${number}.lang` | `info.x-scalar-sdk-installation.${number}.source` | `components.${string}` | `webhooks.${string}` | `x-scalar-environments.${string}` | `x-scalar-secrets.${string}` | `securitySchemes.${number}` | `requests.${number}` | `children.${number}`>(uid: (string & import("zod").$brand<"collection">) | null | undefined, path: P, value: P extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "securitySchemes" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" ? {
|
|
193
192
|
type: "collection";
|
|
194
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
195
193
|
openapi: string;
|
|
196
194
|
info: {
|
|
197
195
|
title: string;
|
|
198
196
|
version: string;
|
|
199
|
-
description?: string | undefined;
|
|
200
197
|
summary?: string | undefined;
|
|
198
|
+
description?: string | undefined;
|
|
201
199
|
termsOfService?: string | undefined;
|
|
202
200
|
contact?: {
|
|
203
201
|
name?: string | undefined;
|
|
@@ -209,27 +207,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
209
207
|
identifier?: string | undefined;
|
|
210
208
|
url?: string | undefined;
|
|
211
209
|
} | undefined;
|
|
212
|
-
|
|
210
|
+
'x-scalar-sdk-installation'?: {
|
|
213
211
|
lang: string;
|
|
214
|
-
description?: string | undefined;
|
|
215
212
|
source?: string | undefined;
|
|
213
|
+
description?: string | undefined;
|
|
216
214
|
}[] | undefined;
|
|
217
215
|
};
|
|
218
216
|
security: Record<string, string[]>[];
|
|
219
217
|
'x-scalar-icon': string;
|
|
218
|
+
uid: string & import("zod").$brand<"collection">;
|
|
220
219
|
securitySchemes: string[];
|
|
221
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
222
|
-
servers: (string & import("zod")
|
|
223
|
-
requests: (string & import("zod")
|
|
224
|
-
tags: (string & import("zod")
|
|
220
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
221
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
222
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
223
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
224
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
225
225
|
watchMode: boolean;
|
|
226
226
|
useCollectionSecurity: boolean;
|
|
227
227
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
228
|
+
jsonSchemaDialect?: string | undefined;
|
|
228
229
|
externalDocs?: {
|
|
229
230
|
url: string;
|
|
230
231
|
description?: string | undefined;
|
|
231
232
|
} | undefined;
|
|
232
|
-
jsonSchemaDialect?: string | undefined;
|
|
233
233
|
components?: Record<string, unknown> | undefined;
|
|
234
234
|
webhooks?: Record<string, unknown> | undefined;
|
|
235
235
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -238,26 +238,24 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
238
238
|
default: string;
|
|
239
239
|
description?: string | undefined;
|
|
240
240
|
}>;
|
|
241
|
-
color?: string | undefined;
|
|
242
241
|
description?: string | undefined;
|
|
242
|
+
color?: string | undefined;
|
|
243
243
|
}> | undefined;
|
|
244
244
|
'x-scalar-secrets'?: Record<string, {
|
|
245
245
|
description?: string | undefined;
|
|
246
246
|
example?: string | undefined;
|
|
247
247
|
}> | undefined;
|
|
248
|
-
selectedServerUid?: (string & import("zod")
|
|
248
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
249
249
|
documentUrl?: string | undefined;
|
|
250
250
|
integration?: string | null | undefined;
|
|
251
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "
|
|
252
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
251
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "securitySchemes" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
253
252
|
type: "collection";
|
|
254
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
255
253
|
openapi: string;
|
|
256
254
|
info: {
|
|
257
255
|
title: string;
|
|
258
256
|
version: string;
|
|
259
|
-
description?: string | undefined;
|
|
260
257
|
summary?: string | undefined;
|
|
258
|
+
description?: string | undefined;
|
|
261
259
|
termsOfService?: string | undefined;
|
|
262
260
|
contact?: {
|
|
263
261
|
name?: string | undefined;
|
|
@@ -269,27 +267,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
269
267
|
identifier?: string | undefined;
|
|
270
268
|
url?: string | undefined;
|
|
271
269
|
} | undefined;
|
|
272
|
-
|
|
270
|
+
'x-scalar-sdk-installation'?: {
|
|
273
271
|
lang: string;
|
|
274
|
-
description?: string | undefined;
|
|
275
272
|
source?: string | undefined;
|
|
273
|
+
description?: string | undefined;
|
|
276
274
|
}[] | undefined;
|
|
277
275
|
};
|
|
278
276
|
security: Record<string, string[]>[];
|
|
279
277
|
'x-scalar-icon': string;
|
|
278
|
+
uid: string & import("zod").$brand<"collection">;
|
|
280
279
|
securitySchemes: string[];
|
|
281
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
282
|
-
servers: (string & import("zod")
|
|
283
|
-
requests: (string & import("zod")
|
|
284
|
-
tags: (string & import("zod")
|
|
280
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
281
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
282
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
283
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
284
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
285
285
|
watchMode: boolean;
|
|
286
286
|
useCollectionSecurity: boolean;
|
|
287
287
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
288
|
+
jsonSchemaDialect?: string | undefined;
|
|
288
289
|
externalDocs?: {
|
|
289
290
|
url: string;
|
|
290
291
|
description?: string | undefined;
|
|
291
292
|
} | undefined;
|
|
292
|
-
jsonSchemaDialect?: string | undefined;
|
|
293
293
|
components?: Record<string, unknown> | undefined;
|
|
294
294
|
webhooks?: Record<string, unknown> | undefined;
|
|
295
295
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -298,26 +298,24 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
298
298
|
default: string;
|
|
299
299
|
description?: string | undefined;
|
|
300
300
|
}>;
|
|
301
|
-
color?: string | undefined;
|
|
302
301
|
description?: string | undefined;
|
|
302
|
+
color?: string | undefined;
|
|
303
303
|
}> | undefined;
|
|
304
304
|
'x-scalar-secrets'?: Record<string, {
|
|
305
305
|
description?: string | undefined;
|
|
306
306
|
example?: string | undefined;
|
|
307
307
|
}> | undefined;
|
|
308
|
-
selectedServerUid?: (string & import("zod")
|
|
308
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
309
309
|
documentUrl?: string | undefined;
|
|
310
310
|
integration?: string | null | undefined;
|
|
311
311
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
312
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
313
312
|
type: "collection";
|
|
314
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
315
313
|
openapi: string;
|
|
316
314
|
info: {
|
|
317
315
|
title: string;
|
|
318
316
|
version: string;
|
|
319
|
-
description?: string | undefined;
|
|
320
317
|
summary?: string | undefined;
|
|
318
|
+
description?: string | undefined;
|
|
321
319
|
termsOfService?: string | undefined;
|
|
322
320
|
contact?: {
|
|
323
321
|
name?: string | undefined;
|
|
@@ -329,27 +327,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
329
327
|
identifier?: string | undefined;
|
|
330
328
|
url?: string | undefined;
|
|
331
329
|
} | undefined;
|
|
332
|
-
|
|
330
|
+
'x-scalar-sdk-installation'?: {
|
|
333
331
|
lang: string;
|
|
334
|
-
description?: string | undefined;
|
|
335
332
|
source?: string | undefined;
|
|
333
|
+
description?: string | undefined;
|
|
336
334
|
}[] | undefined;
|
|
337
335
|
};
|
|
338
336
|
security: Record<string, string[]>[];
|
|
339
337
|
'x-scalar-icon': string;
|
|
338
|
+
uid: string & import("zod").$brand<"collection">;
|
|
340
339
|
securitySchemes: string[];
|
|
341
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
342
|
-
servers: (string & import("zod")
|
|
343
|
-
requests: (string & import("zod")
|
|
344
|
-
tags: (string & import("zod")
|
|
340
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
341
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
342
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
343
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
344
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
345
345
|
watchMode: boolean;
|
|
346
346
|
useCollectionSecurity: boolean;
|
|
347
347
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
348
|
+
jsonSchemaDialect?: string | undefined;
|
|
348
349
|
externalDocs?: {
|
|
349
350
|
url: string;
|
|
350
351
|
description?: string | undefined;
|
|
351
352
|
} | undefined;
|
|
352
|
-
jsonSchemaDialect?: string | undefined;
|
|
353
353
|
components?: Record<string, unknown> | undefined;
|
|
354
354
|
webhooks?: Record<string, unknown> | undefined;
|
|
355
355
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -358,27 +358,25 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
358
358
|
default: string;
|
|
359
359
|
description?: string | undefined;
|
|
360
360
|
}>;
|
|
361
|
-
color?: string | undefined;
|
|
362
361
|
description?: string | undefined;
|
|
362
|
+
color?: string | undefined;
|
|
363
363
|
}> | undefined;
|
|
364
364
|
'x-scalar-secrets'?: Record<string, {
|
|
365
365
|
description?: string | undefined;
|
|
366
366
|
example?: string | undefined;
|
|
367
367
|
}> | undefined;
|
|
368
|
-
selectedServerUid?: (string & import("zod")
|
|
368
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
369
369
|
documentUrl?: string | undefined;
|
|
370
370
|
integration?: string | null | undefined;
|
|
371
371
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
372
|
-
untrackedEdit: <P extends "servers" | "
|
|
373
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
372
|
+
untrackedEdit: <P extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "securitySchemes" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" | `servers.${number}` | "externalDocs.url" | "externalDocs.description" | `security.${number}` | `security.${number}.${string}` | `tags.${number}` | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | "info.title" | "info.summary" | "info.description" | "info.termsOfService" | "info.contact" | "info.license" | "info.version" | "info.x-scalar-sdk-installation" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `info.x-scalar-sdk-installation.${number}` | `info.x-scalar-sdk-installation.${number}.description` | `info.x-scalar-sdk-installation.${number}.lang` | `info.x-scalar-sdk-installation.${number}.source` | `components.${string}` | `webhooks.${string}` | `x-scalar-environments.${string}` | `x-scalar-secrets.${string}` | `securitySchemes.${number}` | `requests.${number}` | `children.${number}`>(uid: string & import("zod").$brand<"collection">, path: P, value: P extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "securitySchemes" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" ? {
|
|
374
373
|
type: "collection";
|
|
375
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
376
374
|
openapi: string;
|
|
377
375
|
info: {
|
|
378
376
|
title: string;
|
|
379
377
|
version: string;
|
|
380
|
-
description?: string | undefined;
|
|
381
378
|
summary?: string | undefined;
|
|
379
|
+
description?: string | undefined;
|
|
382
380
|
termsOfService?: string | undefined;
|
|
383
381
|
contact?: {
|
|
384
382
|
name?: string | undefined;
|
|
@@ -390,27 +388,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
390
388
|
identifier?: string | undefined;
|
|
391
389
|
url?: string | undefined;
|
|
392
390
|
} | undefined;
|
|
393
|
-
|
|
391
|
+
'x-scalar-sdk-installation'?: {
|
|
394
392
|
lang: string;
|
|
395
|
-
description?: string | undefined;
|
|
396
393
|
source?: string | undefined;
|
|
394
|
+
description?: string | undefined;
|
|
397
395
|
}[] | undefined;
|
|
398
396
|
};
|
|
399
397
|
security: Record<string, string[]>[];
|
|
400
398
|
'x-scalar-icon': string;
|
|
399
|
+
uid: string & import("zod").$brand<"collection">;
|
|
401
400
|
securitySchemes: string[];
|
|
402
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
403
|
-
servers: (string & import("zod")
|
|
404
|
-
requests: (string & import("zod")
|
|
405
|
-
tags: (string & import("zod")
|
|
401
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
402
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
403
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
404
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
405
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
406
406
|
watchMode: boolean;
|
|
407
407
|
useCollectionSecurity: boolean;
|
|
408
408
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
409
|
+
jsonSchemaDialect?: string | undefined;
|
|
409
410
|
externalDocs?: {
|
|
410
411
|
url: string;
|
|
411
412
|
description?: string | undefined;
|
|
412
413
|
} | undefined;
|
|
413
|
-
jsonSchemaDialect?: string | undefined;
|
|
414
414
|
components?: Record<string, unknown> | undefined;
|
|
415
415
|
webhooks?: Record<string, unknown> | undefined;
|
|
416
416
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -419,26 +419,24 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
419
419
|
default: string;
|
|
420
420
|
description?: string | undefined;
|
|
421
421
|
}>;
|
|
422
|
-
color?: string | undefined;
|
|
423
422
|
description?: string | undefined;
|
|
423
|
+
color?: string | undefined;
|
|
424
424
|
}> | undefined;
|
|
425
425
|
'x-scalar-secrets'?: Record<string, {
|
|
426
426
|
description?: string | undefined;
|
|
427
427
|
example?: string | undefined;
|
|
428
428
|
}> | undefined;
|
|
429
|
-
selectedServerUid?: (string & import("zod")
|
|
429
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
430
430
|
documentUrl?: string | undefined;
|
|
431
431
|
integration?: string | null | undefined;
|
|
432
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "
|
|
433
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
432
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "externalDocs" | "security" | "tags" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "openapi" | "jsonSchemaDialect" | "info" | "components" | "webhooks" | "x-scalar-icon" | "x-scalar-active-environment" | "x-scalar-environments" | "x-scalar-secrets" | "securitySchemes" | "requests" | "children" | "documentUrl" | "watchMode" | "integration" | "useCollectionSecurity" | "watchModeStatus" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
434
433
|
type: "collection";
|
|
435
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
436
434
|
openapi: string;
|
|
437
435
|
info: {
|
|
438
436
|
title: string;
|
|
439
437
|
version: string;
|
|
440
|
-
description?: string | undefined;
|
|
441
438
|
summary?: string | undefined;
|
|
439
|
+
description?: string | undefined;
|
|
442
440
|
termsOfService?: string | undefined;
|
|
443
441
|
contact?: {
|
|
444
442
|
name?: string | undefined;
|
|
@@ -450,27 +448,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
450
448
|
identifier?: string | undefined;
|
|
451
449
|
url?: string | undefined;
|
|
452
450
|
} | undefined;
|
|
453
|
-
|
|
451
|
+
'x-scalar-sdk-installation'?: {
|
|
454
452
|
lang: string;
|
|
455
|
-
description?: string | undefined;
|
|
456
453
|
source?: string | undefined;
|
|
454
|
+
description?: string | undefined;
|
|
457
455
|
}[] | undefined;
|
|
458
456
|
};
|
|
459
457
|
security: Record<string, string[]>[];
|
|
460
458
|
'x-scalar-icon': string;
|
|
459
|
+
uid: string & import("zod").$brand<"collection">;
|
|
461
460
|
securitySchemes: string[];
|
|
462
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
463
|
-
servers: (string & import("zod")
|
|
464
|
-
requests: (string & import("zod")
|
|
465
|
-
tags: (string & import("zod")
|
|
461
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
462
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
463
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
464
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
465
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
466
466
|
watchMode: boolean;
|
|
467
467
|
useCollectionSecurity: boolean;
|
|
468
468
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
469
|
+
jsonSchemaDialect?: string | undefined;
|
|
469
470
|
externalDocs?: {
|
|
470
471
|
url: string;
|
|
471
472
|
description?: string | undefined;
|
|
472
473
|
} | undefined;
|
|
473
|
-
jsonSchemaDialect?: string | undefined;
|
|
474
474
|
components?: Record<string, unknown> | undefined;
|
|
475
475
|
webhooks?: Record<string, unknown> | undefined;
|
|
476
476
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -479,26 +479,24 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
479
479
|
default: string;
|
|
480
480
|
description?: string | undefined;
|
|
481
481
|
}>;
|
|
482
|
-
color?: string | undefined;
|
|
483
482
|
description?: string | undefined;
|
|
483
|
+
color?: string | undefined;
|
|
484
484
|
}> | undefined;
|
|
485
485
|
'x-scalar-secrets'?: Record<string, {
|
|
486
486
|
description?: string | undefined;
|
|
487
487
|
example?: string | undefined;
|
|
488
488
|
}> | undefined;
|
|
489
|
-
selectedServerUid?: (string & import("zod")
|
|
489
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
490
490
|
documentUrl?: string | undefined;
|
|
491
491
|
integration?: string | null | undefined;
|
|
492
492
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
493
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
494
493
|
type: "collection";
|
|
495
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
496
494
|
openapi: string;
|
|
497
495
|
info: {
|
|
498
496
|
title: string;
|
|
499
497
|
version: string;
|
|
500
|
-
description?: string | undefined;
|
|
501
498
|
summary?: string | undefined;
|
|
499
|
+
description?: string | undefined;
|
|
502
500
|
termsOfService?: string | undefined;
|
|
503
501
|
contact?: {
|
|
504
502
|
name?: string | undefined;
|
|
@@ -510,27 +508,29 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
510
508
|
identifier?: string | undefined;
|
|
511
509
|
url?: string | undefined;
|
|
512
510
|
} | undefined;
|
|
513
|
-
|
|
511
|
+
'x-scalar-sdk-installation'?: {
|
|
514
512
|
lang: string;
|
|
515
|
-
description?: string | undefined;
|
|
516
513
|
source?: string | undefined;
|
|
514
|
+
description?: string | undefined;
|
|
517
515
|
}[] | undefined;
|
|
518
516
|
};
|
|
519
517
|
security: Record<string, string[]>[];
|
|
520
518
|
'x-scalar-icon': string;
|
|
519
|
+
uid: string & import("zod").$brand<"collection">;
|
|
521
520
|
securitySchemes: string[];
|
|
522
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
523
|
-
servers: (string & import("zod")
|
|
524
|
-
requests: (string & import("zod")
|
|
525
|
-
tags: (string & import("zod")
|
|
521
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
522
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
523
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
524
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
525
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
526
526
|
watchMode: boolean;
|
|
527
527
|
useCollectionSecurity: boolean;
|
|
528
528
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
529
|
+
jsonSchemaDialect?: string | undefined;
|
|
529
530
|
externalDocs?: {
|
|
530
531
|
url: string;
|
|
531
532
|
description?: string | undefined;
|
|
532
533
|
} | undefined;
|
|
533
|
-
jsonSchemaDialect?: string | undefined;
|
|
534
534
|
components?: Record<string, unknown> | undefined;
|
|
535
535
|
webhooks?: Record<string, unknown> | undefined;
|
|
536
536
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -539,34 +539,32 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
539
539
|
default: string;
|
|
540
540
|
description?: string | undefined;
|
|
541
541
|
}>;
|
|
542
|
-
color?: string | undefined;
|
|
543
542
|
description?: string | undefined;
|
|
543
|
+
color?: string | undefined;
|
|
544
544
|
}> | undefined;
|
|
545
545
|
'x-scalar-secrets'?: Record<string, {
|
|
546
546
|
description?: string | undefined;
|
|
547
547
|
example?: string | undefined;
|
|
548
548
|
}> | undefined;
|
|
549
|
-
selectedServerUid?: (string & import("zod")
|
|
549
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
550
550
|
documentUrl?: string | undefined;
|
|
551
551
|
integration?: string | null | undefined;
|
|
552
552
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
553
|
-
undo: (uid: string & import("zod")
|
|
554
|
-
redo: (uid: string & import("zod")
|
|
553
|
+
undo: (uid: string & import("zod").$brand<"collection">) => void;
|
|
554
|
+
redo: (uid: string & import("zod").$brand<"collection">) => void;
|
|
555
555
|
reset: () => void;
|
|
556
556
|
};
|
|
557
557
|
};
|
|
558
558
|
/** Extended mutators and data for collections that required workspace access */
|
|
559
559
|
export declare function extendedCollectionDataFactory({ requests, requestMutators, requestExamples, requestExampleMutators, workspaces, workspaceMutators, collections, collectionMutators, tagMutators, serverMutators, }: StoreContext): {
|
|
560
560
|
addCollection: (payload: CollectionPayload, workspaceUid: Workspace["uid"]) => {
|
|
561
|
-
uid: string & import("zod").BRAND<"collection">;
|
|
562
561
|
type: "collection";
|
|
563
|
-
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
564
562
|
openapi: string;
|
|
565
563
|
info: {
|
|
566
564
|
title: string;
|
|
567
565
|
version: string;
|
|
568
|
-
description?: string | undefined;
|
|
569
566
|
summary?: string | undefined;
|
|
567
|
+
description?: string | undefined;
|
|
570
568
|
termsOfService?: string | undefined;
|
|
571
569
|
contact?: {
|
|
572
570
|
name?: string | undefined;
|
|
@@ -578,27 +576,29 @@ export declare function extendedCollectionDataFactory({ requests, requestMutator
|
|
|
578
576
|
identifier?: string | undefined;
|
|
579
577
|
url?: string | undefined;
|
|
580
578
|
} | undefined;
|
|
581
|
-
|
|
579
|
+
'x-scalar-sdk-installation'?: {
|
|
582
580
|
lang: string;
|
|
583
|
-
description?: string | undefined;
|
|
584
581
|
source?: string | undefined;
|
|
582
|
+
description?: string | undefined;
|
|
585
583
|
}[] | undefined;
|
|
586
584
|
};
|
|
587
585
|
security: Record<string, string[]>[];
|
|
588
586
|
'x-scalar-icon': string;
|
|
587
|
+
uid: string & import("zod").$brand<"collection">;
|
|
589
588
|
securitySchemes: string[];
|
|
590
|
-
selectedSecuritySchemeUids: ((string & import("zod")
|
|
591
|
-
servers: (string & import("zod")
|
|
592
|
-
requests: (string & import("zod")
|
|
593
|
-
tags: (string & import("zod")
|
|
589
|
+
selectedSecuritySchemeUids: ((string & import("zod").$brand<"securityScheme">) | (string & import("zod").$brand<"securityScheme">)[])[];
|
|
590
|
+
servers: (string & import("zod").$brand<"server">)[];
|
|
591
|
+
requests: (string & import("zod").$brand<"operation">)[];
|
|
592
|
+
tags: (string & import("zod").$brand<"tag">)[];
|
|
593
|
+
children: ((string & import("zod").$brand<"operation">) | (string & import("zod").$brand<"tag">))[];
|
|
594
594
|
watchMode: boolean;
|
|
595
595
|
useCollectionSecurity: boolean;
|
|
596
596
|
watchModeStatus: "IDLE" | "WATCHING" | "ERROR";
|
|
597
|
+
jsonSchemaDialect?: string | undefined;
|
|
597
598
|
externalDocs?: {
|
|
598
599
|
url: string;
|
|
599
600
|
description?: string | undefined;
|
|
600
601
|
} | undefined;
|
|
601
|
-
jsonSchemaDialect?: string | undefined;
|
|
602
602
|
components?: Record<string, unknown> | undefined;
|
|
603
603
|
webhooks?: Record<string, unknown> | undefined;
|
|
604
604
|
'x-scalar-active-environment'?: string | undefined;
|
|
@@ -607,14 +607,14 @@ export declare function extendedCollectionDataFactory({ requests, requestMutator
|
|
|
607
607
|
default: string;
|
|
608
608
|
description?: string | undefined;
|
|
609
609
|
}>;
|
|
610
|
-
color?: string | undefined;
|
|
611
610
|
description?: string | undefined;
|
|
611
|
+
color?: string | undefined;
|
|
612
612
|
}> | undefined;
|
|
613
613
|
'x-scalar-secrets'?: Record<string, {
|
|
614
614
|
description?: string | undefined;
|
|
615
615
|
example?: string | undefined;
|
|
616
616
|
}> | undefined;
|
|
617
|
-
selectedServerUid?: (string & import("zod")
|
|
617
|
+
selectedServerUid?: (string & import("zod").$brand<"server">) | undefined;
|
|
618
618
|
documentUrl?: string | undefined;
|
|
619
619
|
integration?: string | null | undefined;
|
|
620
620
|
};
|