@scalar/api-client 2.0.24 → 2.0.26
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 +39 -0
- package/dist/components/AddressBar/AddressBar.vue.d.ts.map +1 -1
- package/dist/components/AddressBar/AddressBar.vue.js +2 -2
- package/dist/components/AddressBar/AddressBar.vue2.js +79 -83
- package/dist/components/AddressBar/AddressBarHistory.vue.d.ts.map +1 -1
- package/dist/components/AddressBar/AddressBarHistory.vue.js +38 -38
- package/dist/components/AddressBar/AddressBarServer.vue.d.ts.map +1 -1
- package/dist/components/CodeInput/CodeInput.vue.d.ts +10 -0
- package/dist/components/CodeInput/CodeInput.vue.d.ts.map +1 -1
- package/dist/components/CodeInput/CodeInput.vue.js +2 -1
- package/dist/components/CodeInput/CodeInput.vue2.js +43 -38
- package/dist/components/CodeInput/codeDropdownWidget.d.ts +24 -0
- package/dist/components/CodeInput/codeDropdownWidget.d.ts.map +1 -0
- package/dist/components/CodeInput/codeDropdownWidget.js +110 -0
- package/dist/components/CodeInput/codeVariableWidget.d.ts +8 -0
- package/dist/components/CodeInput/codeVariableWidget.d.ts.map +1 -0
- package/dist/components/CodeInput/codeVariableWidget.js +124 -0
- package/dist/components/CommandPalette/CommandPaletteCollection.vue.d.ts +2 -15
- package/dist/components/CommandPalette/CommandPaletteCollection.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteCollection.vue.js +51 -54
- package/dist/components/CommandPalette/CommandPaletteExample.vue.d.ts +4 -2
- package/dist/components/CommandPalette/CommandPaletteExample.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteExample.vue.js +106 -92
- package/dist/components/CommandPalette/CommandPaletteFolder.vue.d.ts +2 -15
- package/dist/components/CommandPalette/CommandPaletteFolder.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteFolder.vue.js +68 -74
- package/dist/components/CommandPalette/CommandPaletteImport.vue.d.ts +2 -15
- package/dist/components/CommandPalette/CommandPaletteImport.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteImport.vue.js +56 -62
- package/dist/components/CommandPalette/CommandPaletteRequest.vue.d.ts +2 -15
- package/dist/components/CommandPalette/CommandPaletteRequest.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteRequest.vue.js +106 -99
- package/dist/components/CommandPalette/CommandPaletteWorkspace.vue.d.ts +7 -0
- package/dist/components/CommandPalette/CommandPaletteWorkspace.vue.d.ts.map +1 -0
- package/dist/components/CommandPalette/CommandPaletteWorkspace.vue.js +57 -0
- package/dist/components/CommandPalette/CommandPaletteWorkspace.vue2.js +4 -0
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +50 -0
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -0
- package/dist/components/CommandPalette/TheCommandPalette.vue.js +9 -0
- package/dist/components/CommandPalette/TheCommandPalette.vue2.js +198 -0
- package/dist/components/CommandPalette/index.d.ts +2 -0
- package/dist/components/CommandPalette/index.d.ts.map +1 -0
- package/dist/components/CommandPalette/index.js +4 -0
- package/dist/components/ContextBar.vue.js +4 -4
- package/dist/components/DataTable/DataTableInput.vue.d.ts +1 -1
- package/dist/components/DataTable/DataTableInput.vue.d.ts.map +1 -1
- package/dist/components/DataTable/DataTableInput.vue.js +3 -3
- package/dist/components/DataTable/DataTableInput.vue2.js +36 -49
- package/dist/components/SideNav/SideNav.vue.d.ts.map +1 -1
- package/dist/components/SideNav/SideNav.vue.js +26 -23
- package/dist/components/SideNav/SideNavLink.vue.d.ts +3 -2
- package/dist/components/SideNav/SideNavLink.vue.d.ts.map +1 -1
- package/dist/components/SideNav/SideNavLink.vue.js +5 -5
- package/dist/components/Sidebar/Sidebar.vue.d.ts +15 -2
- package/dist/components/Sidebar/Sidebar.vue.d.ts.map +1 -1
- package/dist/components/Sidebar/Sidebar.vue.js +14 -12
- package/dist/components/Sidebar/SidebarButton.vue.d.ts.map +1 -1
- package/dist/components/Sidebar/SidebarButton.vue.js +5 -5
- package/dist/components/TopNav/TopNav.vue.d.ts.map +1 -1
- package/dist/components/TopNav/TopNav.vue.js +2 -2
- package/dist/components/TopNav/TopNav.vue2.js +31 -28
- package/dist/components/TopNav/TopNavItem.vue.d.ts +7 -3
- package/dist/components/TopNav/TopNavItem.vue.d.ts.map +1 -1
- package/dist/components/TopNav/TopNavItem.vue.js +2 -2
- package/dist/components/TopNav/TopNavItem.vue2.js +16 -15
- package/dist/components/ViewLayout/ViewLayout.vue.d.ts.map +1 -1
- package/dist/components/ViewLayout/ViewLayout.vue.js +1 -1
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +2 -1
- package/dist/constants.d.ts +13 -7
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +4 -4
- package/dist/index.d.ts +3 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +14 -16
- package/dist/layouts/App/ApiClientApp.vue.d.ts.map +1 -0
- package/dist/layouts/App/ApiClientApp.vue.js +72 -0
- package/dist/{App → layouts/App}/createApiClientApp.d.ts +1 -1
- package/dist/layouts/App/createApiClientApp.d.ts.map +1 -0
- package/dist/{App → layouts/App}/createApiClientApp.js +2 -2
- package/dist/layouts/App/index.d.ts.map +1 -0
- package/dist/{Modal → layouts/Modal}/ApiClientModal.vue.d.ts +1 -0
- package/dist/layouts/Modal/ApiClientModal.vue.d.ts.map +1 -0
- package/dist/{Modal → layouts/Modal}/ApiClientModal.vue.js +2 -2
- package/dist/{Modal → layouts/Modal}/api-client-modal.d.ts +1 -1
- package/dist/layouts/Modal/api-client-modal.d.ts.map +1 -0
- package/dist/{Modal → layouts/Modal}/api-client-modal.js +42 -42
- package/dist/layouts/Modal/index.d.ts.map +1 -0
- package/dist/libs/eventBusses/command-palette.d.ts +14 -0
- package/dist/libs/eventBusses/command-palette.d.ts.map +1 -0
- package/dist/libs/eventBusses/command-palette.js +5 -0
- package/dist/libs/local-storage.d.ts +1 -1
- package/dist/libs/local-storage.d.ts.map +1 -1
- package/dist/libs/local-storage.js +19 -19
- package/dist/router.d.ts +5 -10
- package/dist/router.d.ts.map +1 -1
- package/dist/router.js +23 -19
- package/dist/store/topNav.d.ts +94 -82
- package/dist/store/topNav.d.ts.map +1 -1
- package/dist/store/topNav.js +21 -20
- package/dist/store/workspace.d.ts +348 -94
- package/dist/store/workspace.d.ts.map +1 -1
- package/dist/store/workspace.js +314 -221
- package/dist/style.css +1 -1
- package/dist/views/Collection/Collection.vue.d.ts.map +1 -1
- package/dist/views/Components/Schemas/Schemas.vue.d.ts.map +1 -1
- package/dist/views/Cookies/Cookies.vue.d.ts.map +1 -1
- package/dist/views/Cookies/Cookies.vue2.js +27 -30
- package/dist/views/Environment/Environment.vue.d.ts.map +1 -1
- package/dist/views/Environment/Environment.vue2.js +22 -25
- package/dist/views/Environment/EnvironmentVariableDropdown.vue.d.ts.map +1 -1
- package/dist/views/Environment/EnvironmentVariableDropdown.vue.js +38 -47
- package/dist/views/Request/Request.vue.d.ts.map +1 -1
- package/dist/views/Request/Request.vue.js +1 -1
- package/dist/views/Request/Request.vue2.js +130 -109
- package/dist/views/Request/RequestSection/RequestAuthDataTableInput.vue.d.ts +1 -1
- package/dist/views/Request/RequestSection/RequestAuthDataTableInput.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestSection.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestSection.vue.js +5 -4
- package/dist/views/Request/RequestSection/RequestTable.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestTable.vue.js +1 -1
- package/dist/views/Request/RequestSection/RequestTable.vue2.js +19 -19
- package/dist/views/Request/RequestSection/RequestTableTooltip.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestTableTooltip.vue.js +6 -5
- package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItem.vue.js +2 -2
- package/dist/views/Request/RequestSidebarItem.vue2.js +78 -81
- package/dist/views/Request/RequestSidebarItemMenu.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItemMenu.vue.js +60 -42
- package/dist/views/Request/ResponseSection/ResponseSection.vue.d.ts.map +1 -1
- package/dist/views/Request/ResponseSection/ResponseSection.vue.js +6 -5
- package/dist/views/Request/components/OAuth2.vue.d.ts.map +1 -1
- package/dist/views/Request/components/OAuth2.vue.js +2 -0
- package/dist/{App.vue.d.ts → views/Request/components/WorkspaceDropdown.vue.d.ts} +1 -2
- package/dist/views/Request/components/WorkspaceDropdown.vue.d.ts.map +1 -0
- package/dist/views/Request/components/WorkspaceDropdown.vue.js +80 -0
- package/dist/views/Request/components/WorkspaceDropdown.vue2.js +4 -0
- package/dist/views/Request/components/index.d.ts +1 -0
- package/dist/views/Request/components/index.d.ts.map +1 -1
- package/dist/views/Request/components/index.js +4 -2
- package/dist/views/Servers/Servers.vue.d.ts.map +1 -1
- package/dist/views/Servers/Servers.vue2.js +12 -15
- package/package.json +22 -18
- package/dist/App/ApiClientApp.vue.d.ts.map +0 -1
- package/dist/App/ApiClientApp.vue.js +0 -56
- package/dist/App/createApiClientApp.d.ts.map +0 -1
- package/dist/App/index.d.ts.map +0 -1
- package/dist/App.vue.d.ts.map +0 -1
- package/dist/App.vue.js +0 -77
- package/dist/App.vue3.js +0 -5
- package/dist/Modal/ApiClientModal.vue.d.ts.map +0 -1
- package/dist/Modal/api-client-modal.d.ts.map +0 -1
- package/dist/Modal/index.d.ts.map +0 -1
- package/dist/components/AddressBar/AddressBarServer.vue.js +0 -113
- package/dist/components/AddressBar/AddressBarServer.vue2.js +0 -4
- package/dist/components/CommandPalette/CommandPalette.vue.d.ts +0 -17
- package/dist/components/CommandPalette/CommandPalette.vue.d.ts.map +0 -1
- package/dist/components/CommandPalette/CommandPalette.vue.js +0 -7
- package/dist/components/CommandPalette/CommandPalette.vue2.js +0 -185
- package/dist/main.d.ts +0 -2
- package/dist/main.d.ts.map +0 -1
- /package/dist/{App → layouts/App}/ApiClientApp.vue.d.ts +0 -0
- /package/dist/{App → layouts/App}/ApiClientApp.vue3.js +0 -0
- /package/dist/{App → layouts/App}/index.d.ts +0 -0
- /package/dist/{App → layouts/App}/index.js +0 -0
- /package/dist/{Modal → layouts/Modal}/ApiClientModal.vue2.js +0 -0
- /package/dist/{Modal → layouts/Modal}/index.d.ts +0 -0
- /package/dist/{Modal → layouts/Modal}/index.js +0 -0
|
@@ -1,8 +1,16 @@
|
|
|
1
|
+
import { type WorkspacePayload } from '@scalar/oas-utils/entities/workspace';
|
|
1
2
|
import { type CollectionPayload } from '@scalar/oas-utils/entities/workspace/collection';
|
|
2
3
|
import { type FolderPayload } from '@scalar/oas-utils/entities/workspace/folder';
|
|
3
|
-
import { type ServerPayload } from '@scalar/oas-utils/entities/workspace/server';
|
|
4
|
+
import { type Server, type ServerPayload } from '@scalar/oas-utils/entities/workspace/server';
|
|
4
5
|
import { type Request, type RequestEvent, type RequestExample, type RequestPayload } from '@scalar/oas-utils/entities/workspace/spec';
|
|
5
6
|
import type { AnyObject } from '@scalar/openapi-parser';
|
|
7
|
+
/**
|
|
8
|
+
* Find nested request inside a collection of folders and return the folderUids up to the collectionUid
|
|
9
|
+
*
|
|
10
|
+
* TODO we definitely need a more performant way of doing this, but because folders can have multiple parents
|
|
11
|
+
* theres no easy short circuit we can store. This can work for now but replace this!
|
|
12
|
+
*/
|
|
13
|
+
export declare const findRequestFolders: (uid: string, foldersToOpen?: string[]) => string[];
|
|
6
14
|
declare const securitySchemeMutators: {
|
|
7
15
|
add: (item: {
|
|
8
16
|
type: "apiKey";
|
|
@@ -131,14 +139,14 @@ declare const securitySchemeMutators: {
|
|
|
131
139
|
openIdConnectUrl: string;
|
|
132
140
|
description?: string | undefined;
|
|
133
141
|
}) => void;
|
|
134
|
-
edit: <P extends "type" | "
|
|
142
|
+
edit: <P extends "type" | "description" | "value" | "name" | "uid" | "in" | "scheme" | "bearerFormat" | "secondValue" | "flows" | "clientId" | "redirectUri" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.value" | "flows.password.secondValue" | "flows.password.selectedScopes" | "flows.password.token" | "flows.password.tokenUrl" | "flows.password.clientSecret" | "flows.password.refreshUrl" | "flows.password.scopes" | `flows.password.selectedScopes.${number}` | `flows.password.scopes.${string}` | "flows.implicit.selectedScopes" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | `flows.implicit.selectedScopes.${number}` | `flows.implicit.scopes.${string}` | "flows.implicit.authorizationUrl" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.token" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | `flows.clientCredentials.selectedScopes.${number}` | `flows.clientCredentials.scopes.${string}` | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.token" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | `flows.authorizationCode.selectedScopes.${number}` | `flows.authorizationCode.scopes.${string}` | "flows.authorizationCode.authorizationUrl" | "openIdConnectUrl">(uid: string, path: P, value: (P extends "type" | "description" | "value" | "name" | "uid" | "in" ? {
|
|
135
143
|
type: "apiKey";
|
|
136
144
|
value: string;
|
|
137
145
|
uid: string;
|
|
138
146
|
name: string;
|
|
139
147
|
in: "query" | "header" | "cookie";
|
|
140
148
|
description?: string | undefined;
|
|
141
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
149
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "name" | "uid" | "in" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
142
150
|
type: "apiKey";
|
|
143
151
|
value: string;
|
|
144
152
|
uid: string;
|
|
@@ -152,7 +160,7 @@ declare const securitySchemeMutators: {
|
|
|
152
160
|
name: string;
|
|
153
161
|
in: "query" | "header" | "cookie";
|
|
154
162
|
description?: string | undefined;
|
|
155
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
163
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? {
|
|
156
164
|
type: "http";
|
|
157
165
|
value: string;
|
|
158
166
|
uid: string;
|
|
@@ -160,7 +168,7 @@ declare const securitySchemeMutators: {
|
|
|
160
168
|
bearerFormat: string;
|
|
161
169
|
secondValue: string;
|
|
162
170
|
description?: string | undefined;
|
|
163
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
171
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
164
172
|
type: "http";
|
|
165
173
|
value: string;
|
|
166
174
|
uid: string;
|
|
@@ -176,7 +184,7 @@ declare const securitySchemeMutators: {
|
|
|
176
184
|
bearerFormat: string;
|
|
177
185
|
secondValue: string;
|
|
178
186
|
description?: string | undefined;
|
|
179
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
187
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? {
|
|
180
188
|
type: "oauth2";
|
|
181
189
|
uid: string;
|
|
182
190
|
flows: {
|
|
@@ -218,7 +226,7 @@ declare const securitySchemeMutators: {
|
|
|
218
226
|
clientId: string;
|
|
219
227
|
redirectUri: string;
|
|
220
228
|
description?: string | undefined;
|
|
221
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
229
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
222
230
|
type: "oauth2";
|
|
223
231
|
uid: string;
|
|
224
232
|
flows: {
|
|
@@ -302,12 +310,12 @@ declare const securitySchemeMutators: {
|
|
|
302
310
|
clientId: string;
|
|
303
311
|
redirectUri: string;
|
|
304
312
|
description?: string | undefined;
|
|
305
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
313
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "openIdConnectUrl" ? {
|
|
306
314
|
type: "openIdConnect";
|
|
307
315
|
uid: string;
|
|
308
316
|
openIdConnectUrl: string;
|
|
309
317
|
description?: string | undefined;
|
|
310
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
318
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "openIdConnectUrl" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
311
319
|
type: "openIdConnect";
|
|
312
320
|
uid: string;
|
|
313
321
|
openIdConnectUrl: string;
|
|
@@ -318,14 +326,14 @@ declare const securitySchemeMutators: {
|
|
|
318
326
|
openIdConnectUrl: string;
|
|
319
327
|
description?: string | undefined;
|
|
320
328
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
|
|
321
|
-
untrackedEdit: <P extends "type" | "
|
|
329
|
+
untrackedEdit: <P extends "type" | "description" | "value" | "name" | "uid" | "in" | "scheme" | "bearerFormat" | "secondValue" | "flows" | "clientId" | "redirectUri" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.value" | "flows.password.secondValue" | "flows.password.selectedScopes" | "flows.password.token" | "flows.password.tokenUrl" | "flows.password.clientSecret" | "flows.password.refreshUrl" | "flows.password.scopes" | `flows.password.selectedScopes.${number}` | `flows.password.scopes.${string}` | "flows.implicit.selectedScopes" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | `flows.implicit.selectedScopes.${number}` | `flows.implicit.scopes.${string}` | "flows.implicit.authorizationUrl" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.token" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | `flows.clientCredentials.selectedScopes.${number}` | `flows.clientCredentials.scopes.${string}` | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.token" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | `flows.authorizationCode.selectedScopes.${number}` | `flows.authorizationCode.scopes.${string}` | "flows.authorizationCode.authorizationUrl" | "openIdConnectUrl">(uid: string, path: P, value: (P extends "type" | "description" | "value" | "name" | "uid" | "in" ? {
|
|
322
330
|
type: "apiKey";
|
|
323
331
|
value: string;
|
|
324
332
|
uid: string;
|
|
325
333
|
name: string;
|
|
326
334
|
in: "query" | "header" | "cookie";
|
|
327
335
|
description?: string | undefined;
|
|
328
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
336
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "name" | "uid" | "in" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
329
337
|
type: "apiKey";
|
|
330
338
|
value: string;
|
|
331
339
|
uid: string;
|
|
@@ -339,7 +347,7 @@ declare const securitySchemeMutators: {
|
|
|
339
347
|
name: string;
|
|
340
348
|
in: "query" | "header" | "cookie";
|
|
341
349
|
description?: string | undefined;
|
|
342
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
350
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? {
|
|
343
351
|
type: "http";
|
|
344
352
|
value: string;
|
|
345
353
|
uid: string;
|
|
@@ -347,7 +355,7 @@ declare const securitySchemeMutators: {
|
|
|
347
355
|
bearerFormat: string;
|
|
348
356
|
secondValue: string;
|
|
349
357
|
description?: string | undefined;
|
|
350
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
358
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
351
359
|
type: "http";
|
|
352
360
|
value: string;
|
|
353
361
|
uid: string;
|
|
@@ -363,7 +371,7 @@ declare const securitySchemeMutators: {
|
|
|
363
371
|
bearerFormat: string;
|
|
364
372
|
secondValue: string;
|
|
365
373
|
description?: string | undefined;
|
|
366
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
374
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? {
|
|
367
375
|
type: "oauth2";
|
|
368
376
|
uid: string;
|
|
369
377
|
flows: {
|
|
@@ -405,7 +413,7 @@ declare const securitySchemeMutators: {
|
|
|
405
413
|
clientId: string;
|
|
406
414
|
redirectUri: string;
|
|
407
415
|
description?: string | undefined;
|
|
408
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
416
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
409
417
|
type: "oauth2";
|
|
410
418
|
uid: string;
|
|
411
419
|
flows: {
|
|
@@ -489,12 +497,12 @@ declare const securitySchemeMutators: {
|
|
|
489
497
|
clientId: string;
|
|
490
498
|
redirectUri: string;
|
|
491
499
|
description?: string | undefined;
|
|
492
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
500
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "openIdConnectUrl" ? {
|
|
493
501
|
type: "openIdConnect";
|
|
494
502
|
uid: string;
|
|
495
503
|
openIdConnectUrl: string;
|
|
496
504
|
description?: string | undefined;
|
|
497
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
505
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "openIdConnectUrl" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
498
506
|
type: "openIdConnect";
|
|
499
507
|
uid: string;
|
|
500
508
|
openIdConnectUrl: string;
|
|
@@ -511,11 +519,14 @@ declare const securitySchemeMutators: {
|
|
|
511
519
|
type SecurityMutatorEditArgs = Parameters<typeof securitySchemeMutators.edit>;
|
|
512
520
|
export type UpdateScheme = (path: SecurityMutatorEditArgs[1], value: SecurityMutatorEditArgs[2]) => void;
|
|
513
521
|
/** Helper function to import a OpenAPI spec file into the local workspace */
|
|
514
|
-
declare function importSpecFile(_spec: string | AnyObject): Promise<void>;
|
|
522
|
+
declare function importSpecFile(_spec: string | AnyObject, workspaceUid?: string, _createWorkspace?: boolean): Promise<void>;
|
|
515
523
|
declare function importSpecFromUrl(url: string, proxy?: string): Promise<void>;
|
|
516
524
|
/**
|
|
517
525
|
* Global hook which contains the store for the whole app
|
|
518
526
|
* We may want to break this up at some point due to the massive file size
|
|
527
|
+
*
|
|
528
|
+
* The rawAdd methods are the mutator.add methods. Some add methods have been replaced when we need some side effects
|
|
529
|
+
* ex: add examples when adding a request
|
|
519
530
|
*/
|
|
520
531
|
export declare const useWorkspace: () => {
|
|
521
532
|
readonly workspaces: Record<string, {
|
|
@@ -529,12 +540,6 @@ export declare const useWorkspace: () => {
|
|
|
529
540
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
530
541
|
proxyUrl?: string | undefined;
|
|
531
542
|
}>;
|
|
532
|
-
readonly workspaceRequests: import("vue").ComputedRef<{
|
|
533
|
-
uid: string;
|
|
534
|
-
path: string;
|
|
535
|
-
method: "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "TRACE" | "CONNECT" | "DELETE" | "OPTIONS";
|
|
536
|
-
summary: string | undefined;
|
|
537
|
-
}[]>;
|
|
538
543
|
readonly collections: Record<string, {
|
|
539
544
|
uid: string;
|
|
540
545
|
spec: {
|
|
@@ -553,7 +558,9 @@ export declare const useWorkspace: () => {
|
|
|
553
558
|
url: string;
|
|
554
559
|
description?: string | undefined;
|
|
555
560
|
} | undefined;
|
|
556
|
-
info
|
|
561
|
+
info
|
|
562
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
563
|
+
?: {
|
|
557
564
|
title: string;
|
|
558
565
|
version: string;
|
|
559
566
|
description?: string | undefined;
|
|
@@ -611,6 +618,7 @@ export declare const useWorkspace: () => {
|
|
|
611
618
|
readonly requestExamples: Record<string, {
|
|
612
619
|
uid: string;
|
|
613
620
|
name: string;
|
|
621
|
+
url: string;
|
|
614
622
|
parameters: {
|
|
615
623
|
path: {
|
|
616
624
|
value: string;
|
|
@@ -801,7 +809,9 @@ export declare const useWorkspace: () => {
|
|
|
801
809
|
url: string;
|
|
802
810
|
description?: string | undefined;
|
|
803
811
|
} | undefined;
|
|
804
|
-
info
|
|
812
|
+
info
|
|
813
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
814
|
+
?: {
|
|
805
815
|
title: string;
|
|
806
816
|
version: string;
|
|
807
817
|
description?: string | undefined;
|
|
@@ -830,6 +840,7 @@ export declare const useWorkspace: () => {
|
|
|
830
840
|
readonly activeExample: import("vue").ComputedRef<{
|
|
831
841
|
uid: string;
|
|
832
842
|
name: string;
|
|
843
|
+
url: string;
|
|
833
844
|
parameters: {
|
|
834
845
|
path: {
|
|
835
846
|
value: string;
|
|
@@ -930,18 +941,18 @@ export declare const useWorkspace: () => {
|
|
|
930
941
|
readonly activeSecurityRequirements: import("vue").ComputedRef<Record<string, string[]>[]>;
|
|
931
942
|
readonly activeSecurityScheme: import("vue").ComputedRef<{
|
|
932
943
|
flow: {
|
|
933
|
-
|
|
944
|
+
value: string;
|
|
945
|
+
secondValue: string;
|
|
934
946
|
selectedScopes: string[];
|
|
935
947
|
token: string;
|
|
948
|
+
tokenUrl: string;
|
|
949
|
+
clientSecret: string;
|
|
936
950
|
refreshUrl?: string | undefined;
|
|
937
951
|
scopes?: Map<string, string | undefined> | Record<string, string | undefined> | {} | undefined;
|
|
938
952
|
} | {
|
|
939
|
-
|
|
940
|
-
secondValue: string;
|
|
953
|
+
authorizationUrl: string;
|
|
941
954
|
selectedScopes: string[];
|
|
942
955
|
token: string;
|
|
943
|
-
tokenUrl: string;
|
|
944
|
-
clientSecret: string;
|
|
945
956
|
refreshUrl?: string | undefined;
|
|
946
957
|
scopes?: Map<string, string | undefined> | Record<string, string | undefined> | {} | undefined;
|
|
947
958
|
} | {
|
|
@@ -1112,6 +1123,72 @@ export declare const useWorkspace: () => {
|
|
|
1112
1123
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
1113
1124
|
proxyUrl?: string | undefined;
|
|
1114
1125
|
}>;
|
|
1126
|
+
readonly activeWorkspaceCollections: import("vue").ComputedRef<{
|
|
1127
|
+
uid: string;
|
|
1128
|
+
spec: {
|
|
1129
|
+
openapi: string;
|
|
1130
|
+
security: Record<string, string[]>[];
|
|
1131
|
+
serverUids: string[];
|
|
1132
|
+
tags: {
|
|
1133
|
+
name: string;
|
|
1134
|
+
description?: string | undefined;
|
|
1135
|
+
externalDocs?: {
|
|
1136
|
+
url: string;
|
|
1137
|
+
description?: string | undefined;
|
|
1138
|
+
} | undefined;
|
|
1139
|
+
}[];
|
|
1140
|
+
externalDocs?: {
|
|
1141
|
+
url: string;
|
|
1142
|
+
description?: string | undefined;
|
|
1143
|
+
} | undefined;
|
|
1144
|
+
info
|
|
1145
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1146
|
+
?: {
|
|
1147
|
+
title: string;
|
|
1148
|
+
version: string;
|
|
1149
|
+
description?: string | undefined;
|
|
1150
|
+
summary?: string | undefined;
|
|
1151
|
+
termsOfService?: string | undefined;
|
|
1152
|
+
contact?: {
|
|
1153
|
+
name?: string | undefined;
|
|
1154
|
+
url?: string | undefined;
|
|
1155
|
+
email?: string | undefined;
|
|
1156
|
+
} | undefined;
|
|
1157
|
+
license?: {
|
|
1158
|
+
name: string;
|
|
1159
|
+
identifier?: string | undefined;
|
|
1160
|
+
url?: string | undefined;
|
|
1161
|
+
} | undefined;
|
|
1162
|
+
} | undefined;
|
|
1163
|
+
};
|
|
1164
|
+
selectedSecuritySchemes: {
|
|
1165
|
+
uid: string;
|
|
1166
|
+
flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
|
|
1167
|
+
}[];
|
|
1168
|
+
selectedServerUid: string;
|
|
1169
|
+
childUids: string[];
|
|
1170
|
+
}[]>;
|
|
1171
|
+
readonly activeWorkspaceServers: import("vue").ComputedRef<{
|
|
1172
|
+
uid: string;
|
|
1173
|
+
url: string;
|
|
1174
|
+
description?: string | undefined;
|
|
1175
|
+
variables?: Record<string, {
|
|
1176
|
+
default: string;
|
|
1177
|
+
uid: string;
|
|
1178
|
+
value?: string | undefined;
|
|
1179
|
+
description?: string | undefined;
|
|
1180
|
+
enum?: string[] | undefined;
|
|
1181
|
+
}> | null | undefined;
|
|
1182
|
+
}[]>;
|
|
1183
|
+
readonly activeParsedEnvironments: import("vue").ComputedRef<({
|
|
1184
|
+
key: string;
|
|
1185
|
+
value: string;
|
|
1186
|
+
} | {
|
|
1187
|
+
_scalarEnvId: any;
|
|
1188
|
+
key: string;
|
|
1189
|
+
value: unknown;
|
|
1190
|
+
})[]>;
|
|
1191
|
+
readonly activeWorkspaceRequests: import("vue").ComputedRef<Request[]>;
|
|
1115
1192
|
readonly modalState: {
|
|
1116
1193
|
open: boolean;
|
|
1117
1194
|
show: () => void;
|
|
@@ -1148,7 +1225,7 @@ export declare const useWorkspace: () => {
|
|
|
1148
1225
|
partitioned?: boolean | undefined;
|
|
1149
1226
|
secure?: boolean | undefined;
|
|
1150
1227
|
}) => void;
|
|
1151
|
-
edit: <P extends "path" | "
|
|
1228
|
+
edit: <P extends "path" | "value" | "name" | "uid" | "sameSite" | "secure" | "domain" | "expires" | "httpOnly" | "maxAge" | "partitioned">(uid: string, path: P, value: P extends "path" | "value" | "name" | "uid" | "sameSite" | "secure" | "domain" | "expires" | "httpOnly" | "maxAge" | "partitioned" ? {
|
|
1152
1229
|
value: string;
|
|
1153
1230
|
uid: string;
|
|
1154
1231
|
name: string;
|
|
@@ -1160,7 +1237,7 @@ export declare const useWorkspace: () => {
|
|
|
1160
1237
|
maxAge?: number | undefined;
|
|
1161
1238
|
partitioned?: boolean | undefined;
|
|
1162
1239
|
secure?: boolean | undefined;
|
|
1163
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "path" | "
|
|
1240
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "path" | "value" | "name" | "uid" | "sameSite" | "secure" | "domain" | "expires" | "httpOnly" | "maxAge" | "partitioned" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1164
1241
|
value: string;
|
|
1165
1242
|
uid: string;
|
|
1166
1243
|
name: string;
|
|
@@ -1185,7 +1262,7 @@ export declare const useWorkspace: () => {
|
|
|
1185
1262
|
partitioned?: boolean | undefined;
|
|
1186
1263
|
secure?: boolean | undefined;
|
|
1187
1264
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1188
|
-
untrackedEdit: <P extends "path" | "
|
|
1265
|
+
untrackedEdit: <P extends "path" | "value" | "name" | "uid" | "sameSite" | "secure" | "domain" | "expires" | "httpOnly" | "maxAge" | "partitioned">(uid: string, path: P, value: P extends "path" | "value" | "name" | "uid" | "sameSite" | "secure" | "domain" | "expires" | "httpOnly" | "maxAge" | "partitioned" ? {
|
|
1189
1266
|
value: string;
|
|
1190
1267
|
uid: string;
|
|
1191
1268
|
name: string;
|
|
@@ -1197,7 +1274,7 @@ export declare const useWorkspace: () => {
|
|
|
1197
1274
|
maxAge?: number | undefined;
|
|
1198
1275
|
partitioned?: boolean | undefined;
|
|
1199
1276
|
secure?: boolean | undefined;
|
|
1200
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "path" | "
|
|
1277
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "path" | "value" | "name" | "uid" | "sameSite" | "secure" | "domain" | "expires" | "httpOnly" | "maxAge" | "partitioned" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1201
1278
|
value: string;
|
|
1202
1279
|
uid: string;
|
|
1203
1280
|
name: string;
|
|
@@ -1225,7 +1302,6 @@ export declare const useWorkspace: () => {
|
|
|
1225
1302
|
undo: (uid: string) => void;
|
|
1226
1303
|
redo: (uid: string) => void;
|
|
1227
1304
|
};
|
|
1228
|
-
readonly createExampleFromRequest: (request: Request) => RequestExample;
|
|
1229
1305
|
readonly collectionMutators: {
|
|
1230
1306
|
readonly rawAdd: (item: {
|
|
1231
1307
|
uid: string;
|
|
@@ -1245,7 +1321,9 @@ export declare const useWorkspace: () => {
|
|
|
1245
1321
|
url: string;
|
|
1246
1322
|
description?: string | undefined;
|
|
1247
1323
|
} | undefined;
|
|
1248
|
-
info
|
|
1324
|
+
info
|
|
1325
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1326
|
+
?: {
|
|
1249
1327
|
title: string;
|
|
1250
1328
|
version: string;
|
|
1251
1329
|
description?: string | undefined;
|
|
@@ -1270,7 +1348,51 @@ export declare const useWorkspace: () => {
|
|
|
1270
1348
|
selectedServerUid: string;
|
|
1271
1349
|
childUids: string[];
|
|
1272
1350
|
}) => void;
|
|
1273
|
-
readonly add: (payload: CollectionPayload) =>
|
|
1351
|
+
readonly add: (payload: CollectionPayload, workspaceUid: string) => {
|
|
1352
|
+
uid: string;
|
|
1353
|
+
spec: {
|
|
1354
|
+
openapi: string;
|
|
1355
|
+
security: Record<string, string[]>[];
|
|
1356
|
+
serverUids: string[];
|
|
1357
|
+
tags: {
|
|
1358
|
+
name: string;
|
|
1359
|
+
description?: string | undefined;
|
|
1360
|
+
externalDocs?: {
|
|
1361
|
+
url: string;
|
|
1362
|
+
description?: string | undefined;
|
|
1363
|
+
} | undefined;
|
|
1364
|
+
}[];
|
|
1365
|
+
externalDocs?: {
|
|
1366
|
+
url: string;
|
|
1367
|
+
description?: string | undefined;
|
|
1368
|
+
} | undefined;
|
|
1369
|
+
info
|
|
1370
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1371
|
+
?: {
|
|
1372
|
+
title: string;
|
|
1373
|
+
version: string;
|
|
1374
|
+
description?: string | undefined;
|
|
1375
|
+
summary?: string | undefined;
|
|
1376
|
+
termsOfService?: string | undefined;
|
|
1377
|
+
contact?: {
|
|
1378
|
+
name?: string | undefined;
|
|
1379
|
+
url?: string | undefined;
|
|
1380
|
+
email?: string | undefined;
|
|
1381
|
+
} | undefined;
|
|
1382
|
+
license?: {
|
|
1383
|
+
name: string;
|
|
1384
|
+
identifier?: string | undefined;
|
|
1385
|
+
url?: string | undefined;
|
|
1386
|
+
} | undefined;
|
|
1387
|
+
} | undefined;
|
|
1388
|
+
};
|
|
1389
|
+
selectedSecuritySchemes: {
|
|
1390
|
+
uid: string;
|
|
1391
|
+
flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
|
|
1392
|
+
}[];
|
|
1393
|
+
selectedServerUid: string;
|
|
1394
|
+
childUids: string[];
|
|
1395
|
+
};
|
|
1274
1396
|
readonly delete: (collectionUid: string) => void;
|
|
1275
1397
|
readonly set: (item: {
|
|
1276
1398
|
uid: string;
|
|
@@ -1290,7 +1412,9 @@ export declare const useWorkspace: () => {
|
|
|
1290
1412
|
url: string;
|
|
1291
1413
|
description?: string | undefined;
|
|
1292
1414
|
} | undefined;
|
|
1293
|
-
info
|
|
1415
|
+
info
|
|
1416
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1417
|
+
?: {
|
|
1294
1418
|
title: string;
|
|
1295
1419
|
version: string;
|
|
1296
1420
|
description?: string | undefined;
|
|
@@ -1315,7 +1439,7 @@ export declare const useWorkspace: () => {
|
|
|
1315
1439
|
selectedServerUid: string;
|
|
1316
1440
|
childUids: string[];
|
|
1317
1441
|
}) => void;
|
|
1318
|
-
readonly edit: <P extends "uid" | "
|
|
1442
|
+
readonly edit: <P extends "uid" | "childUids" | "spec" | "selectedSecuritySchemes" | "selectedServerUid" | `childUids.${number}` | "spec.info" | "spec.tags" | "spec.security" | "spec.openapi" | "spec.serverUids" | "spec.externalDocs" | "spec.info.summary" | "spec.info.title" | "spec.info.version" | "spec.info.description" | "spec.info.termsOfService" | "spec.info.contact" | "spec.info.license" | "spec.info.contact.email" | "spec.info.contact.url" | "spec.info.contact.name" | "spec.info.license.url" | "spec.info.license.name" | "spec.info.license.identifier" | "spec.externalDocs.description" | "spec.externalDocs.url" | `spec.tags.${number}` | `spec.tags.${number}.description` | `spec.tags.${number}.name` | `spec.tags.${number}.externalDocs` | `spec.tags.${number}.externalDocs.description` | `spec.tags.${number}.externalDocs.url` | `spec.security.${number}` | `spec.security.${number}.${string}` | `spec.serverUids.${number}` | `selectedSecuritySchemes.${number}` | `selectedSecuritySchemes.${number}.uid` | `selectedSecuritySchemes.${number}.flowKey`>(uid: string, path: P, value: P extends "uid" | "childUids" | "spec" | "selectedSecuritySchemes" | "selectedServerUid" ? {
|
|
1319
1443
|
uid: string;
|
|
1320
1444
|
spec: {
|
|
1321
1445
|
openapi: string;
|
|
@@ -1333,7 +1457,9 @@ export declare const useWorkspace: () => {
|
|
|
1333
1457
|
url: string;
|
|
1334
1458
|
description?: string | undefined;
|
|
1335
1459
|
} | undefined;
|
|
1336
|
-
info
|
|
1460
|
+
info
|
|
1461
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1462
|
+
?: {
|
|
1337
1463
|
title: string;
|
|
1338
1464
|
version: string;
|
|
1339
1465
|
description?: string | undefined;
|
|
@@ -1357,7 +1483,7 @@ export declare const useWorkspace: () => {
|
|
|
1357
1483
|
}[];
|
|
1358
1484
|
selectedServerUid: string;
|
|
1359
1485
|
childUids: string[];
|
|
1360
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "uid" | "
|
|
1486
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "uid" | "childUids" | "spec" | "selectedSecuritySchemes" | "selectedServerUid" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1361
1487
|
uid: string;
|
|
1362
1488
|
spec: {
|
|
1363
1489
|
openapi: string;
|
|
@@ -1375,7 +1501,9 @@ export declare const useWorkspace: () => {
|
|
|
1375
1501
|
url: string;
|
|
1376
1502
|
description?: string | undefined;
|
|
1377
1503
|
} | undefined;
|
|
1378
|
-
info
|
|
1504
|
+
info
|
|
1505
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1506
|
+
?: {
|
|
1379
1507
|
title: string;
|
|
1380
1508
|
version: string;
|
|
1381
1509
|
description?: string | undefined;
|
|
@@ -1417,7 +1545,9 @@ export declare const useWorkspace: () => {
|
|
|
1417
1545
|
url: string;
|
|
1418
1546
|
description?: string | undefined;
|
|
1419
1547
|
} | undefined;
|
|
1420
|
-
info
|
|
1548
|
+
info
|
|
1549
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1550
|
+
?: {
|
|
1421
1551
|
title: string;
|
|
1422
1552
|
version: string;
|
|
1423
1553
|
description?: string | undefined;
|
|
@@ -1442,7 +1572,7 @@ export declare const useWorkspace: () => {
|
|
|
1442
1572
|
selectedServerUid: string;
|
|
1443
1573
|
childUids: string[];
|
|
1444
1574
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1445
|
-
readonly untrackedEdit: <P extends "uid" | "
|
|
1575
|
+
readonly untrackedEdit: <P extends "uid" | "childUids" | "spec" | "selectedSecuritySchemes" | "selectedServerUid" | `childUids.${number}` | "spec.info" | "spec.tags" | "spec.security" | "spec.openapi" | "spec.serverUids" | "spec.externalDocs" | "spec.info.summary" | "spec.info.title" | "spec.info.version" | "spec.info.description" | "spec.info.termsOfService" | "spec.info.contact" | "spec.info.license" | "spec.info.contact.email" | "spec.info.contact.url" | "spec.info.contact.name" | "spec.info.license.url" | "spec.info.license.name" | "spec.info.license.identifier" | "spec.externalDocs.description" | "spec.externalDocs.url" | `spec.tags.${number}` | `spec.tags.${number}.description` | `spec.tags.${number}.name` | `spec.tags.${number}.externalDocs` | `spec.tags.${number}.externalDocs.description` | `spec.tags.${number}.externalDocs.url` | `spec.security.${number}` | `spec.security.${number}.${string}` | `spec.serverUids.${number}` | `selectedSecuritySchemes.${number}` | `selectedSecuritySchemes.${number}.uid` | `selectedSecuritySchemes.${number}.flowKey`>(uid: string, path: P, value: P extends "uid" | "childUids" | "spec" | "selectedSecuritySchemes" | "selectedServerUid" ? {
|
|
1446
1576
|
uid: string;
|
|
1447
1577
|
spec: {
|
|
1448
1578
|
openapi: string;
|
|
@@ -1460,7 +1590,9 @@ export declare const useWorkspace: () => {
|
|
|
1460
1590
|
url: string;
|
|
1461
1591
|
description?: string | undefined;
|
|
1462
1592
|
} | undefined;
|
|
1463
|
-
info
|
|
1593
|
+
info
|
|
1594
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1595
|
+
?: {
|
|
1464
1596
|
title: string;
|
|
1465
1597
|
version: string;
|
|
1466
1598
|
description?: string | undefined;
|
|
@@ -1484,7 +1616,7 @@ export declare const useWorkspace: () => {
|
|
|
1484
1616
|
}[];
|
|
1485
1617
|
selectedServerUid: string;
|
|
1486
1618
|
childUids: string[];
|
|
1487
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "uid" | "
|
|
1619
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "uid" | "childUids" | "spec" | "selectedSecuritySchemes" | "selectedServerUid" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1488
1620
|
uid: string;
|
|
1489
1621
|
spec: {
|
|
1490
1622
|
openapi: string;
|
|
@@ -1502,7 +1634,9 @@ export declare const useWorkspace: () => {
|
|
|
1502
1634
|
url: string;
|
|
1503
1635
|
description?: string | undefined;
|
|
1504
1636
|
} | undefined;
|
|
1505
|
-
info
|
|
1637
|
+
info
|
|
1638
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1639
|
+
?: {
|
|
1506
1640
|
title: string;
|
|
1507
1641
|
version: string;
|
|
1508
1642
|
description?: string | undefined;
|
|
@@ -1544,7 +1678,9 @@ export declare const useWorkspace: () => {
|
|
|
1544
1678
|
url: string;
|
|
1545
1679
|
description?: string | undefined;
|
|
1546
1680
|
} | undefined;
|
|
1547
|
-
info
|
|
1681
|
+
info
|
|
1682
|
+
/** Active workspace object (will be associated with an entry in the workspace collection) */
|
|
1683
|
+
?: {
|
|
1548
1684
|
title: string;
|
|
1549
1685
|
version: string;
|
|
1550
1686
|
description?: string | undefined;
|
|
@@ -1596,7 +1732,7 @@ export declare const useWorkspace: () => {
|
|
|
1596
1732
|
}[];
|
|
1597
1733
|
isDefault?: boolean | undefined;
|
|
1598
1734
|
}) => void;
|
|
1599
|
-
readonly edit: <P extends "
|
|
1735
|
+
readonly edit: <P extends "color" | "name" | "uid" | "raw" | "parsed" | "isDefault" | `parsed.${number}` | `parsed.${number}.key` | `parsed.${number}.value`>(uid: string, path: P, value: P extends "color" | "name" | "uid" | "raw" | "parsed" | "isDefault" ? {
|
|
1600
1736
|
uid: string;
|
|
1601
1737
|
name: string;
|
|
1602
1738
|
color: string;
|
|
@@ -1606,7 +1742,7 @@ export declare const useWorkspace: () => {
|
|
|
1606
1742
|
key: string;
|
|
1607
1743
|
}[];
|
|
1608
1744
|
isDefault?: boolean | undefined;
|
|
1609
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
1745
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "color" | "name" | "uid" | "raw" | "parsed" | "isDefault" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1610
1746
|
uid: string;
|
|
1611
1747
|
name: string;
|
|
1612
1748
|
color: string;
|
|
@@ -1627,7 +1763,7 @@ export declare const useWorkspace: () => {
|
|
|
1627
1763
|
}[];
|
|
1628
1764
|
isDefault?: boolean | undefined;
|
|
1629
1765
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1630
|
-
readonly untrackedEdit: <P extends "
|
|
1766
|
+
readonly untrackedEdit: <P extends "color" | "name" | "uid" | "raw" | "parsed" | "isDefault" | `parsed.${number}` | `parsed.${number}.key` | `parsed.${number}.value`>(uid: string, path: P, value: P extends "color" | "name" | "uid" | "raw" | "parsed" | "isDefault" ? {
|
|
1631
1767
|
uid: string;
|
|
1632
1768
|
name: string;
|
|
1633
1769
|
color: string;
|
|
@@ -1637,7 +1773,7 @@ export declare const useWorkspace: () => {
|
|
|
1637
1773
|
key: string;
|
|
1638
1774
|
}[];
|
|
1639
1775
|
isDefault?: boolean | undefined;
|
|
1640
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
1776
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "color" | "name" | "uid" | "raw" | "parsed" | "isDefault" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1641
1777
|
uid: string;
|
|
1642
1778
|
name: string;
|
|
1643
1779
|
color: string;
|
|
@@ -1676,12 +1812,12 @@ export declare const useWorkspace: () => {
|
|
|
1676
1812
|
childUids: string[];
|
|
1677
1813
|
description?: string | undefined;
|
|
1678
1814
|
}) => void;
|
|
1679
|
-
readonly edit: <P extends "
|
|
1815
|
+
readonly edit: <P extends "description" | "name" | "uid" | "childUids" | `childUids.${number}`>(uid: string, path: P, value: P extends "description" | "name" | "uid" | "childUids" ? {
|
|
1680
1816
|
uid: string;
|
|
1681
1817
|
name: string;
|
|
1682
1818
|
childUids: string[];
|
|
1683
1819
|
description?: string | undefined;
|
|
1684
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
1820
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "name" | "uid" | "childUids" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1685
1821
|
uid: string;
|
|
1686
1822
|
name: string;
|
|
1687
1823
|
childUids: string[];
|
|
@@ -1692,12 +1828,12 @@ export declare const useWorkspace: () => {
|
|
|
1692
1828
|
childUids: string[];
|
|
1693
1829
|
description?: string | undefined;
|
|
1694
1830
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1695
|
-
readonly untrackedEdit: <P extends "
|
|
1831
|
+
readonly untrackedEdit: <P extends "description" | "name" | "uid" | "childUids" | `childUids.${number}`>(uid: string, path: P, value: P extends "description" | "name" | "uid" | "childUids" ? {
|
|
1696
1832
|
uid: string;
|
|
1697
1833
|
name: string;
|
|
1698
1834
|
childUids: string[];
|
|
1699
1835
|
description?: string | undefined;
|
|
1700
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
1836
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "name" | "uid" | "childUids" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1701
1837
|
uid: string;
|
|
1702
1838
|
name: string;
|
|
1703
1839
|
childUids: string[];
|
|
@@ -1713,7 +1849,7 @@ export declare const useWorkspace: () => {
|
|
|
1713
1849
|
};
|
|
1714
1850
|
readonly requestMutators: {
|
|
1715
1851
|
readonly rawAdd: (item: Request) => void;
|
|
1716
|
-
readonly add: (payload: RequestPayload, parentUid?: string) => {
|
|
1852
|
+
readonly add: (payload: RequestPayload, parentUid?: string, server?: Server) => {
|
|
1717
1853
|
path: string;
|
|
1718
1854
|
uid: string;
|
|
1719
1855
|
tags: string[];
|
|
@@ -1739,8 +1875,8 @@ export declare const useWorkspace: () => {
|
|
|
1739
1875
|
};
|
|
1740
1876
|
readonly delete: (request: Request, parentUid: string) => void;
|
|
1741
1877
|
readonly set: (item: Request) => void;
|
|
1742
|
-
readonly edit: <P extends "ref" | "summary" | "path" | "
|
|
1743
|
-
readonly untrackedEdit: <P extends "ref" | "summary" | "path" | "
|
|
1878
|
+
readonly edit: <P extends "ref" | "summary" | "path" | "description" | "uid" | "tags" | "childUids" | "method" | "parameters" | "history" | "security" | "operationId" | "requestBody" | `childUids.${number}` | "externalDocs" | "externalDocs.description" | "externalDocs.url" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "ref.path" | "ref.isExternal" | "ref.collectionRef" | "parameters.cookies" | "parameters.path" | "parameters.query" | "parameters.headers" | `parameters.cookies.${string}` | `parameters.path.${string}` | `parameters.query.${string}` | `parameters.headers.${string}` | `history.${number}` | `history.${number}.${string}` | `requestBody.${string}`>(uid: string, path: P, value: P extends "ref" | "summary" | "path" | "description" | "uid" | "tags" | "childUids" | "method" | "parameters" | "history" | "security" | "operationId" | "requestBody" | "externalDocs" ? Request[P] : P extends `${infer K}.${infer R}` ? K extends "ref" | "summary" | "path" | "description" | "uid" | "tags" | "childUids" | "method" | "parameters" | "history" | "security" | "operationId" | "requestBody" | "externalDocs" ? R extends import("@scalar/object-utils/nested").Path<Request[K]> ? import("@scalar/object-utils/nested").PathValue<Request[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1879
|
+
readonly untrackedEdit: <P extends "ref" | "summary" | "path" | "description" | "uid" | "tags" | "childUids" | "method" | "parameters" | "history" | "security" | "operationId" | "requestBody" | `childUids.${number}` | "externalDocs" | "externalDocs.description" | "externalDocs.url" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "ref.path" | "ref.isExternal" | "ref.collectionRef" | "parameters.cookies" | "parameters.path" | "parameters.query" | "parameters.headers" | `parameters.cookies.${string}` | `parameters.path.${string}` | `parameters.query.${string}` | `parameters.headers.${string}` | `history.${number}` | `history.${number}.${string}` | `requestBody.${string}`>(uid: string, path: P, value: P extends "ref" | "summary" | "path" | "description" | "uid" | "tags" | "childUids" | "method" | "parameters" | "history" | "security" | "operationId" | "requestBody" | "externalDocs" ? Request[P] : P extends `${infer K}.${infer R}` ? K extends "ref" | "summary" | "path" | "description" | "uid" | "tags" | "childUids" | "method" | "parameters" | "history" | "security" | "operationId" | "requestBody" | "externalDocs" ? R extends import("@scalar/object-utils/nested").Path<Request[K]> ? import("@scalar/object-utils/nested").PathValue<Request[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1744
1880
|
readonly undo: (uid: string) => void;
|
|
1745
1881
|
readonly redo: (uid: string) => void;
|
|
1746
1882
|
};
|
|
@@ -1748,6 +1884,7 @@ export declare const useWorkspace: () => {
|
|
|
1748
1884
|
readonly rawAdd: (item: {
|
|
1749
1885
|
uid: string;
|
|
1750
1886
|
name: string;
|
|
1887
|
+
url: string;
|
|
1751
1888
|
parameters: {
|
|
1752
1889
|
path: {
|
|
1753
1890
|
value: string;
|
|
@@ -1844,11 +1981,111 @@ export declare const useWorkspace: () => {
|
|
|
1844
1981
|
};
|
|
1845
1982
|
auth: Record<string, any>;
|
|
1846
1983
|
}) => void;
|
|
1847
|
-
readonly add: (request: Request) =>
|
|
1984
|
+
readonly add: (request: Request, name?: string) => {
|
|
1985
|
+
uid: string;
|
|
1986
|
+
name: string;
|
|
1987
|
+
url: string;
|
|
1988
|
+
parameters: {
|
|
1989
|
+
path: {
|
|
1990
|
+
value: string;
|
|
1991
|
+
key: string;
|
|
1992
|
+
enabled: boolean;
|
|
1993
|
+
minimum?: number | undefined;
|
|
1994
|
+
type?: string | undefined;
|
|
1995
|
+
maximum?: number | undefined;
|
|
1996
|
+
default?: any;
|
|
1997
|
+
description?: string | undefined;
|
|
1998
|
+
enum?: string[] | undefined;
|
|
1999
|
+
required?: boolean | undefined;
|
|
2000
|
+
file?: File | undefined;
|
|
2001
|
+
refUid?: string | undefined;
|
|
2002
|
+
format?: string | undefined;
|
|
2003
|
+
nullable?: boolean | undefined;
|
|
2004
|
+
}[];
|
|
2005
|
+
query: {
|
|
2006
|
+
value: string;
|
|
2007
|
+
key: string;
|
|
2008
|
+
enabled: boolean;
|
|
2009
|
+
minimum?: number | undefined;
|
|
2010
|
+
type?: string | undefined;
|
|
2011
|
+
maximum?: number | undefined;
|
|
2012
|
+
default?: any;
|
|
2013
|
+
description?: string | undefined;
|
|
2014
|
+
enum?: string[] | undefined;
|
|
2015
|
+
required?: boolean | undefined;
|
|
2016
|
+
file?: File | undefined;
|
|
2017
|
+
refUid?: string | undefined;
|
|
2018
|
+
format?: string | undefined;
|
|
2019
|
+
nullable?: boolean | undefined;
|
|
2020
|
+
}[];
|
|
2021
|
+
cookies: {
|
|
2022
|
+
value: string;
|
|
2023
|
+
key: string;
|
|
2024
|
+
enabled: boolean;
|
|
2025
|
+
minimum?: number | undefined;
|
|
2026
|
+
type?: string | undefined;
|
|
2027
|
+
maximum?: number | undefined;
|
|
2028
|
+
default?: any;
|
|
2029
|
+
description?: string | undefined;
|
|
2030
|
+
enum?: string[] | undefined;
|
|
2031
|
+
required?: boolean | undefined;
|
|
2032
|
+
file?: File | undefined;
|
|
2033
|
+
refUid?: string | undefined;
|
|
2034
|
+
format?: string | undefined;
|
|
2035
|
+
nullable?: boolean | undefined;
|
|
2036
|
+
}[];
|
|
2037
|
+
headers: {
|
|
2038
|
+
value: string;
|
|
2039
|
+
key: string;
|
|
2040
|
+
enabled: boolean;
|
|
2041
|
+
minimum?: number | undefined;
|
|
2042
|
+
type?: string | undefined;
|
|
2043
|
+
maximum?: number | undefined;
|
|
2044
|
+
default?: any;
|
|
2045
|
+
description?: string | undefined;
|
|
2046
|
+
enum?: string[] | undefined;
|
|
2047
|
+
required?: boolean | undefined;
|
|
2048
|
+
file?: File | undefined;
|
|
2049
|
+
refUid?: string | undefined;
|
|
2050
|
+
format?: string | undefined;
|
|
2051
|
+
nullable?: boolean | undefined;
|
|
2052
|
+
}[];
|
|
2053
|
+
};
|
|
2054
|
+
requestUid: string;
|
|
2055
|
+
body: {
|
|
2056
|
+
raw: {
|
|
2057
|
+
value: string;
|
|
2058
|
+
encoding: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn";
|
|
2059
|
+
};
|
|
2060
|
+
formData: {
|
|
2061
|
+
value: {
|
|
2062
|
+
value: string;
|
|
2063
|
+
key: string;
|
|
2064
|
+
enabled: boolean;
|
|
2065
|
+
minimum?: number | undefined;
|
|
2066
|
+
type?: string | undefined;
|
|
2067
|
+
maximum?: number | undefined;
|
|
2068
|
+
default?: any;
|
|
2069
|
+
description?: string | undefined;
|
|
2070
|
+
enum?: string[] | undefined;
|
|
2071
|
+
required?: boolean | undefined;
|
|
2072
|
+
file?: File | undefined;
|
|
2073
|
+
refUid?: string | undefined;
|
|
2074
|
+
format?: string | undefined;
|
|
2075
|
+
nullable?: boolean | undefined;
|
|
2076
|
+
}[];
|
|
2077
|
+
encoding: "form-data" | "urlencoded";
|
|
2078
|
+
};
|
|
2079
|
+
activeBody: "raw" | "formData" | "binary";
|
|
2080
|
+
binary?: File | undefined;
|
|
2081
|
+
};
|
|
2082
|
+
auth: Record<string, any>;
|
|
2083
|
+
};
|
|
1848
2084
|
readonly delete: (requestExample: RequestExample) => void;
|
|
1849
2085
|
readonly set: (item: {
|
|
1850
2086
|
uid: string;
|
|
1851
2087
|
name: string;
|
|
2088
|
+
url: string;
|
|
1852
2089
|
parameters: {
|
|
1853
2090
|
path: {
|
|
1854
2091
|
value: string;
|
|
@@ -1945,9 +2182,10 @@ export declare const useWorkspace: () => {
|
|
|
1945
2182
|
};
|
|
1946
2183
|
auth: Record<string, any>;
|
|
1947
2184
|
}) => void;
|
|
1948
|
-
readonly edit: <P extends "body" | "name" | "uid" | "parameters" | "requestUid" | "auth" | "body.raw" | "body.formData" | "body.
|
|
2185
|
+
readonly edit: <P extends "body" | "url" | "name" | "uid" | "parameters" | "parameters.cookies" | "parameters.path" | "parameters.query" | "parameters.headers" | "requestUid" | "auth" | "body.raw" | "body.formData" | "body.binary" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.type` | `body.formData.value.${number}.required` | `body.formData.value.${number}.value` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.refUid` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.enum.${number}` | `parameters.cookies.${number}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.refUid` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.type` | `parameters.path.${number}.required` | `parameters.path.${number}.value` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.format` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.refUid` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.type` | `parameters.query.${number}.required` | `parameters.query.${number}.value` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.format` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.refUid` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.type` | `parameters.headers.${number}.required` | `parameters.headers.${number}.value` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.refUid` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.enum.${number}` | `auth.${string}`>(uid: string, path: P, value: P extends "body" | "url" | "name" | "uid" | "parameters" | "requestUid" | "auth" ? {
|
|
1949
2186
|
uid: string;
|
|
1950
2187
|
name: string;
|
|
2188
|
+
url: string;
|
|
1951
2189
|
parameters: {
|
|
1952
2190
|
path: {
|
|
1953
2191
|
value: string;
|
|
@@ -2043,9 +2281,10 @@ export declare const useWorkspace: () => {
|
|
|
2043
2281
|
binary?: File | undefined;
|
|
2044
2282
|
};
|
|
2045
2283
|
auth: Record<string, any>;
|
|
2046
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "body" | "name" | "uid" | "parameters" | "requestUid" | "auth" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2284
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "body" | "url" | "name" | "uid" | "parameters" | "requestUid" | "auth" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2047
2285
|
uid: string;
|
|
2048
2286
|
name: string;
|
|
2287
|
+
url: string;
|
|
2049
2288
|
parameters: {
|
|
2050
2289
|
path: {
|
|
2051
2290
|
value: string;
|
|
@@ -2144,6 +2383,7 @@ export declare const useWorkspace: () => {
|
|
|
2144
2383
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2145
2384
|
uid: string;
|
|
2146
2385
|
name: string;
|
|
2386
|
+
url: string;
|
|
2147
2387
|
parameters: {
|
|
2148
2388
|
path: {
|
|
2149
2389
|
value: string;
|
|
@@ -2240,9 +2480,10 @@ export declare const useWorkspace: () => {
|
|
|
2240
2480
|
};
|
|
2241
2481
|
auth: Record<string, any>;
|
|
2242
2482
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2243
|
-
readonly untrackedEdit: <P extends "body" | "name" | "uid" | "parameters" | "requestUid" | "auth" | "body.raw" | "body.formData" | "body.
|
|
2483
|
+
readonly untrackedEdit: <P extends "body" | "url" | "name" | "uid" | "parameters" | "parameters.cookies" | "parameters.path" | "parameters.query" | "parameters.headers" | "requestUid" | "auth" | "body.raw" | "body.formData" | "body.binary" | "body.activeBody" | "body.raw.value" | "body.raw.encoding" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.type` | `body.formData.value.${number}.required` | `body.formData.value.${number}.value` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.format` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.refUid` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.enum.${number}` | `parameters.cookies.${number}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.refUid` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.enum.${number}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.type` | `parameters.path.${number}.required` | `parameters.path.${number}.value` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.format` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.enabled` | `parameters.path.${number}.refUid` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.enum.${number}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.type` | `parameters.query.${number}.required` | `parameters.query.${number}.value` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.format` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.enabled` | `parameters.query.${number}.refUid` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.enum.${number}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.type` | `parameters.headers.${number}.required` | `parameters.headers.${number}.value` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.format` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.refUid` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.enum.${number}` | `auth.${string}`>(uid: string, path: P, value: P extends "body" | "url" | "name" | "uid" | "parameters" | "requestUid" | "auth" ? {
|
|
2244
2484
|
uid: string;
|
|
2245
2485
|
name: string;
|
|
2486
|
+
url: string;
|
|
2246
2487
|
parameters: {
|
|
2247
2488
|
path: {
|
|
2248
2489
|
value: string;
|
|
@@ -2338,9 +2579,10 @@ export declare const useWorkspace: () => {
|
|
|
2338
2579
|
binary?: File | undefined;
|
|
2339
2580
|
};
|
|
2340
2581
|
auth: Record<string, any>;
|
|
2341
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "body" | "name" | "uid" | "parameters" | "requestUid" | "auth" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2582
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "body" | "url" | "name" | "uid" | "parameters" | "requestUid" | "auth" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2342
2583
|
uid: string;
|
|
2343
2584
|
name: string;
|
|
2585
|
+
url: string;
|
|
2344
2586
|
parameters: {
|
|
2345
2587
|
path: {
|
|
2346
2588
|
value: string;
|
|
@@ -2439,6 +2681,7 @@ export declare const useWorkspace: () => {
|
|
|
2439
2681
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2440
2682
|
uid: string;
|
|
2441
2683
|
name: string;
|
|
2684
|
+
url: string;
|
|
2442
2685
|
parameters: {
|
|
2443
2686
|
path: {
|
|
2444
2687
|
value: string;
|
|
@@ -2667,14 +2910,14 @@ export declare const useWorkspace: () => {
|
|
|
2667
2910
|
openIdConnectUrl: string;
|
|
2668
2911
|
description?: string | undefined;
|
|
2669
2912
|
}) => void;
|
|
2670
|
-
edit: <P extends "type" | "
|
|
2913
|
+
edit: <P extends "type" | "description" | "value" | "name" | "uid" | "in" | "scheme" | "bearerFormat" | "secondValue" | "flows" | "clientId" | "redirectUri" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.value" | "flows.password.secondValue" | "flows.password.selectedScopes" | "flows.password.token" | "flows.password.tokenUrl" | "flows.password.clientSecret" | "flows.password.refreshUrl" | "flows.password.scopes" | `flows.password.selectedScopes.${number}` | `flows.password.scopes.${string}` | "flows.implicit.selectedScopes" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | `flows.implicit.selectedScopes.${number}` | `flows.implicit.scopes.${string}` | "flows.implicit.authorizationUrl" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.token" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | `flows.clientCredentials.selectedScopes.${number}` | `flows.clientCredentials.scopes.${string}` | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.token" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | `flows.authorizationCode.selectedScopes.${number}` | `flows.authorizationCode.scopes.${string}` | "flows.authorizationCode.authorizationUrl" | "openIdConnectUrl">(uid: string, path: P, value: (P extends "type" | "description" | "value" | "name" | "uid" | "in" ? {
|
|
2671
2914
|
type: "apiKey";
|
|
2672
2915
|
value: string;
|
|
2673
2916
|
uid: string;
|
|
2674
2917
|
name: string;
|
|
2675
2918
|
in: "query" | "header" | "cookie";
|
|
2676
2919
|
description?: string | undefined;
|
|
2677
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
2920
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "name" | "uid" | "in" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2678
2921
|
type: "apiKey";
|
|
2679
2922
|
value: string;
|
|
2680
2923
|
uid: string;
|
|
@@ -2688,7 +2931,7 @@ export declare const useWorkspace: () => {
|
|
|
2688
2931
|
name: string;
|
|
2689
2932
|
in: "query" | "header" | "cookie";
|
|
2690
2933
|
description?: string | undefined;
|
|
2691
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
2934
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? {
|
|
2692
2935
|
type: "http";
|
|
2693
2936
|
value: string;
|
|
2694
2937
|
uid: string;
|
|
@@ -2696,7 +2939,7 @@ export declare const useWorkspace: () => {
|
|
|
2696
2939
|
bearerFormat: string;
|
|
2697
2940
|
secondValue: string;
|
|
2698
2941
|
description?: string | undefined;
|
|
2699
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
2942
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2700
2943
|
type: "http";
|
|
2701
2944
|
value: string;
|
|
2702
2945
|
uid: string;
|
|
@@ -2712,7 +2955,7 @@ export declare const useWorkspace: () => {
|
|
|
2712
2955
|
bearerFormat: string;
|
|
2713
2956
|
secondValue: string;
|
|
2714
2957
|
description?: string | undefined;
|
|
2715
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
2958
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? {
|
|
2716
2959
|
type: "oauth2";
|
|
2717
2960
|
uid: string;
|
|
2718
2961
|
flows: {
|
|
@@ -2754,7 +2997,7 @@ export declare const useWorkspace: () => {
|
|
|
2754
2997
|
clientId: string;
|
|
2755
2998
|
redirectUri: string;
|
|
2756
2999
|
description?: string | undefined;
|
|
2757
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3000
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2758
3001
|
type: "oauth2";
|
|
2759
3002
|
uid: string;
|
|
2760
3003
|
flows: {
|
|
@@ -2838,12 +3081,12 @@ export declare const useWorkspace: () => {
|
|
|
2838
3081
|
clientId: string;
|
|
2839
3082
|
redirectUri: string;
|
|
2840
3083
|
description?: string | undefined;
|
|
2841
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
3084
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "openIdConnectUrl" ? {
|
|
2842
3085
|
type: "openIdConnect";
|
|
2843
3086
|
uid: string;
|
|
2844
3087
|
openIdConnectUrl: string;
|
|
2845
3088
|
description?: string | undefined;
|
|
2846
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3089
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "openIdConnectUrl" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2847
3090
|
type: "openIdConnect";
|
|
2848
3091
|
uid: string;
|
|
2849
3092
|
openIdConnectUrl: string;
|
|
@@ -2854,14 +3097,14 @@ export declare const useWorkspace: () => {
|
|
|
2854
3097
|
openIdConnectUrl: string;
|
|
2855
3098
|
description?: string | undefined;
|
|
2856
3099
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
|
|
2857
|
-
untrackedEdit: <P extends "type" | "
|
|
3100
|
+
untrackedEdit: <P extends "type" | "description" | "value" | "name" | "uid" | "in" | "scheme" | "bearerFormat" | "secondValue" | "flows" | "clientId" | "redirectUri" | "flows.password" | "flows.implicit" | "flows.clientCredentials" | "flows.authorizationCode" | "flows.password.value" | "flows.password.secondValue" | "flows.password.selectedScopes" | "flows.password.token" | "flows.password.tokenUrl" | "flows.password.clientSecret" | "flows.password.refreshUrl" | "flows.password.scopes" | `flows.password.selectedScopes.${number}` | `flows.password.scopes.${string}` | "flows.implicit.selectedScopes" | "flows.implicit.token" | "flows.implicit.refreshUrl" | "flows.implicit.scopes" | `flows.implicit.selectedScopes.${number}` | `flows.implicit.scopes.${string}` | "flows.implicit.authorizationUrl" | "flows.clientCredentials.selectedScopes" | "flows.clientCredentials.token" | "flows.clientCredentials.tokenUrl" | "flows.clientCredentials.clientSecret" | "flows.clientCredentials.refreshUrl" | "flows.clientCredentials.scopes" | `flows.clientCredentials.selectedScopes.${number}` | `flows.clientCredentials.scopes.${string}` | "flows.authorizationCode.selectedScopes" | "flows.authorizationCode.token" | "flows.authorizationCode.tokenUrl" | "flows.authorizationCode.clientSecret" | "flows.authorizationCode.refreshUrl" | "flows.authorizationCode.scopes" | `flows.authorizationCode.selectedScopes.${number}` | `flows.authorizationCode.scopes.${string}` | "flows.authorizationCode.authorizationUrl" | "openIdConnectUrl">(uid: string, path: P, value: (P extends "type" | "description" | "value" | "name" | "uid" | "in" ? {
|
|
2858
3101
|
type: "apiKey";
|
|
2859
3102
|
value: string;
|
|
2860
3103
|
uid: string;
|
|
2861
3104
|
name: string;
|
|
2862
3105
|
in: "query" | "header" | "cookie";
|
|
2863
3106
|
description?: string | undefined;
|
|
2864
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3107
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "name" | "uid" | "in" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2865
3108
|
type: "apiKey";
|
|
2866
3109
|
value: string;
|
|
2867
3110
|
uid: string;
|
|
@@ -2875,7 +3118,7 @@ export declare const useWorkspace: () => {
|
|
|
2875
3118
|
name: string;
|
|
2876
3119
|
in: "query" | "header" | "cookie";
|
|
2877
3120
|
description?: string | undefined;
|
|
2878
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
3121
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? {
|
|
2879
3122
|
type: "http";
|
|
2880
3123
|
value: string;
|
|
2881
3124
|
uid: string;
|
|
@@ -2883,7 +3126,7 @@ export declare const useWorkspace: () => {
|
|
|
2883
3126
|
bearerFormat: string;
|
|
2884
3127
|
secondValue: string;
|
|
2885
3128
|
description?: string | undefined;
|
|
2886
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3129
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2887
3130
|
type: "http";
|
|
2888
3131
|
value: string;
|
|
2889
3132
|
uid: string;
|
|
@@ -2899,7 +3142,7 @@ export declare const useWorkspace: () => {
|
|
|
2899
3142
|
bearerFormat: string;
|
|
2900
3143
|
secondValue: string;
|
|
2901
3144
|
description?: string | undefined;
|
|
2902
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
3145
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? {
|
|
2903
3146
|
type: "oauth2";
|
|
2904
3147
|
uid: string;
|
|
2905
3148
|
flows: {
|
|
@@ -2941,7 +3184,7 @@ export declare const useWorkspace: () => {
|
|
|
2941
3184
|
clientId: string;
|
|
2942
3185
|
redirectUri: string;
|
|
2943
3186
|
description?: string | undefined;
|
|
2944
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3187
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2945
3188
|
type: "oauth2";
|
|
2946
3189
|
uid: string;
|
|
2947
3190
|
flows: {
|
|
@@ -3025,12 +3268,12 @@ export declare const useWorkspace: () => {
|
|
|
3025
3268
|
clientId: string;
|
|
3026
3269
|
redirectUri: string;
|
|
3027
3270
|
description?: string | undefined;
|
|
3028
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
3271
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "openIdConnectUrl" ? {
|
|
3029
3272
|
type: "openIdConnect";
|
|
3030
3273
|
uid: string;
|
|
3031
3274
|
openIdConnectUrl: string;
|
|
3032
3275
|
description?: string | undefined;
|
|
3033
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3276
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "openIdConnectUrl" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3034
3277
|
type: "openIdConnect";
|
|
3035
3278
|
uid: string;
|
|
3036
3279
|
openIdConnectUrl: string;
|
|
@@ -3071,7 +3314,7 @@ export declare const useWorkspace: () => {
|
|
|
3071
3314
|
enum?: string[] | undefined;
|
|
3072
3315
|
}> | null | undefined;
|
|
3073
3316
|
}) => void;
|
|
3074
|
-
readonly edit: <P extends "
|
|
3317
|
+
readonly edit: <P extends "description" | "url" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "url" | "uid" | "variables" ? {
|
|
3075
3318
|
uid: string;
|
|
3076
3319
|
url: string;
|
|
3077
3320
|
description?: string | undefined;
|
|
@@ -3082,7 +3325,7 @@ export declare const useWorkspace: () => {
|
|
|
3082
3325
|
description?: string | undefined;
|
|
3083
3326
|
enum?: string[] | undefined;
|
|
3084
3327
|
}> | null | undefined;
|
|
3085
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
3328
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "url" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3086
3329
|
uid: string;
|
|
3087
3330
|
url: string;
|
|
3088
3331
|
description?: string | undefined;
|
|
@@ -3105,7 +3348,7 @@ export declare const useWorkspace: () => {
|
|
|
3105
3348
|
enum?: string[] | undefined;
|
|
3106
3349
|
}> | null | undefined;
|
|
3107
3350
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3108
|
-
readonly untrackedEdit: <P extends "
|
|
3351
|
+
readonly untrackedEdit: <P extends "description" | "url" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "url" | "uid" | "variables" ? {
|
|
3109
3352
|
uid: string;
|
|
3110
3353
|
url: string;
|
|
3111
3354
|
description?: string | undefined;
|
|
@@ -3116,7 +3359,7 @@ export declare const useWorkspace: () => {
|
|
|
3116
3359
|
description?: string | undefined;
|
|
3117
3360
|
enum?: string[] | undefined;
|
|
3118
3361
|
}> | null | undefined;
|
|
3119
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
3362
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "url" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3120
3363
|
uid: string;
|
|
3121
3364
|
url: string;
|
|
3122
3365
|
description?: string | undefined;
|
|
@@ -3143,7 +3386,7 @@ export declare const useWorkspace: () => {
|
|
|
3143
3386
|
readonly redo: (uid: string) => void;
|
|
3144
3387
|
};
|
|
3145
3388
|
readonly workspaceMutators: {
|
|
3146
|
-
|
|
3389
|
+
readonly rawAdd: (item: {
|
|
3147
3390
|
uid: string;
|
|
3148
3391
|
description: string;
|
|
3149
3392
|
name: string;
|
|
@@ -3154,8 +3397,19 @@ export declare const useWorkspace: () => {
|
|
|
3154
3397
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3155
3398
|
proxyUrl?: string | undefined;
|
|
3156
3399
|
}) => void;
|
|
3157
|
-
|
|
3158
|
-
|
|
3400
|
+
readonly add: (payload?: WorkspacePayload) => {
|
|
3401
|
+
uid: string;
|
|
3402
|
+
description: string;
|
|
3403
|
+
name: string;
|
|
3404
|
+
isReadOnly: boolean;
|
|
3405
|
+
collectionUids: string[];
|
|
3406
|
+
environmentUids: string[];
|
|
3407
|
+
cookieUids: string[];
|
|
3408
|
+
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3409
|
+
proxyUrl?: string | undefined;
|
|
3410
|
+
};
|
|
3411
|
+
readonly delete: (uid: string) => void;
|
|
3412
|
+
readonly set: (item: {
|
|
3159
3413
|
uid: string;
|
|
3160
3414
|
description: string;
|
|
3161
3415
|
name: string;
|
|
@@ -3166,7 +3420,7 @@ export declare const useWorkspace: () => {
|
|
|
3166
3420
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3167
3421
|
proxyUrl?: string | undefined;
|
|
3168
3422
|
}) => void;
|
|
3169
|
-
edit: <P extends "
|
|
3423
|
+
readonly edit: <P extends "description" | "name" | "uid" | "isReadOnly" | "collectionUids" | "environmentUids" | "cookieUids" | "themeId" | "proxyUrl" | `collectionUids.${number}` | `environmentUids.${number}` | `cookieUids.${number}`>(uid: string, path: P, value: P extends "description" | "name" | "uid" | "isReadOnly" | "collectionUids" | "environmentUids" | "cookieUids" | "themeId" | "proxyUrl" ? {
|
|
3170
3424
|
uid: string;
|
|
3171
3425
|
description: string;
|
|
3172
3426
|
name: string;
|
|
@@ -3176,7 +3430,7 @@ export declare const useWorkspace: () => {
|
|
|
3176
3430
|
cookieUids: string[];
|
|
3177
3431
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3178
3432
|
proxyUrl?: string | undefined;
|
|
3179
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
3433
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "name" | "uid" | "isReadOnly" | "collectionUids" | "environmentUids" | "cookieUids" | "themeId" | "proxyUrl" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3180
3434
|
uid: string;
|
|
3181
3435
|
description: string;
|
|
3182
3436
|
name: string;
|
|
@@ -3197,7 +3451,7 @@ export declare const useWorkspace: () => {
|
|
|
3197
3451
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3198
3452
|
proxyUrl?: string | undefined;
|
|
3199
3453
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3200
|
-
untrackedEdit: <P extends "
|
|
3454
|
+
readonly untrackedEdit: <P extends "description" | "name" | "uid" | "isReadOnly" | "collectionUids" | "environmentUids" | "cookieUids" | "themeId" | "proxyUrl" | `collectionUids.${number}` | `environmentUids.${number}` | `cookieUids.${number}`>(uid: string, path: P, value: P extends "description" | "name" | "uid" | "isReadOnly" | "collectionUids" | "environmentUids" | "cookieUids" | "themeId" | "proxyUrl" ? {
|
|
3201
3455
|
uid: string;
|
|
3202
3456
|
description: string;
|
|
3203
3457
|
name: string;
|
|
@@ -3207,7 +3461,7 @@ export declare const useWorkspace: () => {
|
|
|
3207
3461
|
cookieUids: string[];
|
|
3208
3462
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3209
3463
|
proxyUrl?: string | undefined;
|
|
3210
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
3464
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "name" | "uid" | "isReadOnly" | "collectionUids" | "environmentUids" | "cookieUids" | "themeId" | "proxyUrl" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3211
3465
|
uid: string;
|
|
3212
3466
|
description: string;
|
|
3213
3467
|
name: string;
|
|
@@ -3228,8 +3482,8 @@ export declare const useWorkspace: () => {
|
|
|
3228
3482
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3229
3483
|
proxyUrl?: string | undefined;
|
|
3230
3484
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3231
|
-
undo: (uid: string) => void;
|
|
3232
|
-
redo: (uid: string) => void;
|
|
3485
|
+
readonly undo: (uid: string) => void;
|
|
3486
|
+
readonly redo: (uid: string) => void;
|
|
3233
3487
|
};
|
|
3234
3488
|
};
|
|
3235
3489
|
export {};
|