@scalar/api-client 2.0.22 → 2.0.25
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 +48 -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 +80 -84
- package/dist/components/AddressBar/AddressBarHistory.vue.d.ts.map +1 -1
- package/dist/components/AddressBar/AddressBarHistory.vue.js +11 -10
- 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 +3 -2
- package/dist/components/CodeInput/CodeInput.vue2.js +42 -37
- 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/DarkModeToggle/DarkModeIconToggle.vue.js +7 -6
- package/dist/components/DataTable/DataTableCheckbox.vue.d.ts.map +1 -1
- package/dist/components/DataTable/DataTableCheckbox.vue.js +3 -2
- 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/DataTable/DataTableInputSelect.vue.d.ts.map +1 -1
- package/dist/components/DataTable/DataTableInputSelect.vue.js +15 -14
- package/dist/components/Search/SearchButton.vue.d.ts.map +1 -1
- package/dist/components/Search/SearchButton.vue.js +7 -6
- 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 +18 -16
- 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/Sidebar/SidebarListElementActions.vue.d.ts.map +1 -1
- package/dist/components/Sidebar/SidebarListElementActions.vue.js +2 -2
- package/dist/components/TopNav/TopNav.vue.d.ts.map +1 -1
- package/dist/components/TopNav/TopNav.vue.js +1 -1
- package/dist/components/TopNav/TopNav.vue2.js +31 -29
- 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 +18 -18
- 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 +2 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +11 -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/layouts/Modal/api-client-modal.d.ts.map +1 -0
- package/dist/{Modal → layouts/Modal}/api-client-modal.js +7 -7
- 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 +18 -6
- package/dist/router.d.ts.map +1 -1
- package/dist/router.js +107 -71
- 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 +312 -82
- package/dist/store/workspace.d.ts.map +1 -1
- package/dist/store/workspace.js +299 -224
- 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 +9 -12
- 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 +125 -108
- 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/RequestBody.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestBody.vue.js +5 -4
- package/dist/views/Request/RequestSection/RequestSection.vue.js +3 -2
- package/dist/views/Request/RequestSection/RequestTable.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestTable.vue.js +4 -4
- package/dist/views/Request/RequestSection/RequestTable.vue2.js +22 -21
- 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 +84 -79
- package/dist/views/Request/RequestSidebarItemMenu.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItemMenu.vue.js +58 -38
- package/dist/views/Request/ResponseSection/ResponseSection.vue.d.ts.map +1 -1
- package/dist/views/Request/ResponseSection/ResponseSection.vue.js +3 -2
- 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 +19 -15
- 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 -106
- 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 -184
- package/dist/main.d.ts +0 -2
- package/dist/main.d.ts.map +0 -1
- package/dist/views/Collection/Collection.vue.js +0 -4
- package/dist/views/Collection/Collection.vue2.js +0 -136
- package/dist/views/Components/Schemas/Schemas.vue.js +0 -4
- package/dist/views/Components/Schemas/Schemas.vue2.js +0 -20
- /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}/api-client-modal.d.ts +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: {
|
|
@@ -611,6 +616,7 @@ export declare const useWorkspace: () => {
|
|
|
611
616
|
readonly requestExamples: Record<string, {
|
|
612
617
|
uid: string;
|
|
613
618
|
name: string;
|
|
619
|
+
url: string;
|
|
614
620
|
parameters: {
|
|
615
621
|
path: {
|
|
616
622
|
value: string;
|
|
@@ -830,6 +836,7 @@ export declare const useWorkspace: () => {
|
|
|
830
836
|
readonly activeExample: import("vue").ComputedRef<{
|
|
831
837
|
uid: string;
|
|
832
838
|
name: string;
|
|
839
|
+
url: string;
|
|
833
840
|
parameters: {
|
|
834
841
|
path: {
|
|
835
842
|
value: string;
|
|
@@ -930,18 +937,18 @@ export declare const useWorkspace: () => {
|
|
|
930
937
|
readonly activeSecurityRequirements: import("vue").ComputedRef<Record<string, string[]>[]>;
|
|
931
938
|
readonly activeSecurityScheme: import("vue").ComputedRef<{
|
|
932
939
|
flow: {
|
|
933
|
-
|
|
940
|
+
value: string;
|
|
941
|
+
secondValue: string;
|
|
934
942
|
selectedScopes: string[];
|
|
935
943
|
token: string;
|
|
944
|
+
tokenUrl: string;
|
|
945
|
+
clientSecret: string;
|
|
936
946
|
refreshUrl?: string | undefined;
|
|
937
947
|
scopes?: Map<string, string | undefined> | Record<string, string | undefined> | {} | undefined;
|
|
938
948
|
} | {
|
|
939
|
-
|
|
940
|
-
secondValue: string;
|
|
949
|
+
authorizationUrl: string;
|
|
941
950
|
selectedScopes: string[];
|
|
942
951
|
token: string;
|
|
943
|
-
tokenUrl: string;
|
|
944
|
-
clientSecret: string;
|
|
945
952
|
refreshUrl?: string | undefined;
|
|
946
953
|
scopes?: Map<string, string | undefined> | Record<string, string | undefined> | {} | undefined;
|
|
947
954
|
} | {
|
|
@@ -1112,6 +1119,70 @@ export declare const useWorkspace: () => {
|
|
|
1112
1119
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
1113
1120
|
proxyUrl?: string | undefined;
|
|
1114
1121
|
}>;
|
|
1122
|
+
readonly activeWorkspaceCollections: import("vue").ComputedRef<{
|
|
1123
|
+
uid: string;
|
|
1124
|
+
spec: {
|
|
1125
|
+
openapi: string;
|
|
1126
|
+
security: Record<string, string[]>[];
|
|
1127
|
+
serverUids: string[];
|
|
1128
|
+
tags: {
|
|
1129
|
+
name: string;
|
|
1130
|
+
description?: string | undefined;
|
|
1131
|
+
externalDocs?: {
|
|
1132
|
+
url: string;
|
|
1133
|
+
description?: string | undefined;
|
|
1134
|
+
} | undefined;
|
|
1135
|
+
}[];
|
|
1136
|
+
externalDocs?: {
|
|
1137
|
+
url: string;
|
|
1138
|
+
description?: string | undefined;
|
|
1139
|
+
} | undefined;
|
|
1140
|
+
info?: {
|
|
1141
|
+
title: string;
|
|
1142
|
+
version: string;
|
|
1143
|
+
description?: string | undefined;
|
|
1144
|
+
summary?: string | undefined;
|
|
1145
|
+
termsOfService?: string | undefined;
|
|
1146
|
+
contact?: {
|
|
1147
|
+
name?: string | undefined;
|
|
1148
|
+
url?: string | undefined;
|
|
1149
|
+
email?: string | undefined;
|
|
1150
|
+
} | undefined;
|
|
1151
|
+
license?: {
|
|
1152
|
+
name: string;
|
|
1153
|
+
identifier?: string | undefined;
|
|
1154
|
+
url?: string | undefined;
|
|
1155
|
+
} | undefined;
|
|
1156
|
+
} | undefined;
|
|
1157
|
+
};
|
|
1158
|
+
selectedSecuritySchemes: {
|
|
1159
|
+
uid: string;
|
|
1160
|
+
flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
|
|
1161
|
+
}[];
|
|
1162
|
+
selectedServerUid: string;
|
|
1163
|
+
childUids: string[];
|
|
1164
|
+
}[]>;
|
|
1165
|
+
readonly activeWorkspaceServers: import("vue").ComputedRef<{
|
|
1166
|
+
uid: string;
|
|
1167
|
+
url: string;
|
|
1168
|
+
description?: string | undefined;
|
|
1169
|
+
variables?: Record<string, {
|
|
1170
|
+
default: string;
|
|
1171
|
+
uid: string;
|
|
1172
|
+
value?: string | undefined;
|
|
1173
|
+
description?: string | undefined;
|
|
1174
|
+
enum?: string[] | undefined;
|
|
1175
|
+
}> | null | undefined;
|
|
1176
|
+
}[]>;
|
|
1177
|
+
readonly activeParsedEnvironments: import("vue").ComputedRef<({
|
|
1178
|
+
key: string;
|
|
1179
|
+
value: string;
|
|
1180
|
+
} | {
|
|
1181
|
+
_scalarEnvId: any;
|
|
1182
|
+
key: string;
|
|
1183
|
+
value: unknown;
|
|
1184
|
+
})[]>;
|
|
1185
|
+
readonly activeWorkspaceRequests: import("vue").ComputedRef<Request[]>;
|
|
1115
1186
|
readonly modalState: {
|
|
1116
1187
|
open: boolean;
|
|
1117
1188
|
show: () => void;
|
|
@@ -1148,7 +1219,7 @@ export declare const useWorkspace: () => {
|
|
|
1148
1219
|
partitioned?: boolean | undefined;
|
|
1149
1220
|
secure?: boolean | undefined;
|
|
1150
1221
|
}) => void;
|
|
1151
|
-
edit: <P extends "path" | "
|
|
1222
|
+
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
1223
|
value: string;
|
|
1153
1224
|
uid: string;
|
|
1154
1225
|
name: string;
|
|
@@ -1160,7 +1231,7 @@ export declare const useWorkspace: () => {
|
|
|
1160
1231
|
maxAge?: number | undefined;
|
|
1161
1232
|
partitioned?: boolean | undefined;
|
|
1162
1233
|
secure?: boolean | undefined;
|
|
1163
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "path" | "
|
|
1234
|
+
}[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
1235
|
value: string;
|
|
1165
1236
|
uid: string;
|
|
1166
1237
|
name: string;
|
|
@@ -1185,7 +1256,7 @@ export declare const useWorkspace: () => {
|
|
|
1185
1256
|
partitioned?: boolean | undefined;
|
|
1186
1257
|
secure?: boolean | undefined;
|
|
1187
1258
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1188
|
-
untrackedEdit: <P extends "path" | "
|
|
1259
|
+
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
1260
|
value: string;
|
|
1190
1261
|
uid: string;
|
|
1191
1262
|
name: string;
|
|
@@ -1197,7 +1268,7 @@ export declare const useWorkspace: () => {
|
|
|
1197
1268
|
maxAge?: number | undefined;
|
|
1198
1269
|
partitioned?: boolean | undefined;
|
|
1199
1270
|
secure?: boolean | undefined;
|
|
1200
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "path" | "
|
|
1271
|
+
}[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
1272
|
value: string;
|
|
1202
1273
|
uid: string;
|
|
1203
1274
|
name: string;
|
|
@@ -1225,7 +1296,6 @@ export declare const useWorkspace: () => {
|
|
|
1225
1296
|
undo: (uid: string) => void;
|
|
1226
1297
|
redo: (uid: string) => void;
|
|
1227
1298
|
};
|
|
1228
|
-
readonly createExampleFromRequest: (request: Request) => RequestExample;
|
|
1229
1299
|
readonly collectionMutators: {
|
|
1230
1300
|
readonly rawAdd: (item: {
|
|
1231
1301
|
uid: string;
|
|
@@ -1270,7 +1340,49 @@ export declare const useWorkspace: () => {
|
|
|
1270
1340
|
selectedServerUid: string;
|
|
1271
1341
|
childUids: string[];
|
|
1272
1342
|
}) => void;
|
|
1273
|
-
readonly add: (payload: CollectionPayload) =>
|
|
1343
|
+
readonly add: (payload: CollectionPayload, workspaceUid: string) => {
|
|
1344
|
+
uid: string;
|
|
1345
|
+
spec: {
|
|
1346
|
+
openapi: string;
|
|
1347
|
+
security: Record<string, string[]>[];
|
|
1348
|
+
serverUids: string[];
|
|
1349
|
+
tags: {
|
|
1350
|
+
name: string;
|
|
1351
|
+
description?: string | undefined;
|
|
1352
|
+
externalDocs?: {
|
|
1353
|
+
url: string;
|
|
1354
|
+
description?: string | undefined;
|
|
1355
|
+
} | undefined;
|
|
1356
|
+
}[];
|
|
1357
|
+
externalDocs?: {
|
|
1358
|
+
url: string;
|
|
1359
|
+
description?: string | undefined;
|
|
1360
|
+
} | undefined;
|
|
1361
|
+
info?: {
|
|
1362
|
+
title: string;
|
|
1363
|
+
version: string;
|
|
1364
|
+
description?: string | undefined;
|
|
1365
|
+
summary?: string | undefined;
|
|
1366
|
+
termsOfService?: string | undefined;
|
|
1367
|
+
contact?: {
|
|
1368
|
+
name?: string | undefined;
|
|
1369
|
+
url?: string | undefined;
|
|
1370
|
+
email?: string | undefined;
|
|
1371
|
+
} | undefined;
|
|
1372
|
+
license?: {
|
|
1373
|
+
name: string;
|
|
1374
|
+
identifier?: string | undefined;
|
|
1375
|
+
url?: string | undefined;
|
|
1376
|
+
} | undefined;
|
|
1377
|
+
} | undefined;
|
|
1378
|
+
};
|
|
1379
|
+
selectedSecuritySchemes: {
|
|
1380
|
+
uid: string;
|
|
1381
|
+
flowKey?: "implicit" | "password" | "clientCredentials" | "authorizationCode" | undefined;
|
|
1382
|
+
}[];
|
|
1383
|
+
selectedServerUid: string;
|
|
1384
|
+
childUids: string[];
|
|
1385
|
+
};
|
|
1274
1386
|
readonly delete: (collectionUid: string) => void;
|
|
1275
1387
|
readonly set: (item: {
|
|
1276
1388
|
uid: string;
|
|
@@ -1315,7 +1427,7 @@ export declare const useWorkspace: () => {
|
|
|
1315
1427
|
selectedServerUid: string;
|
|
1316
1428
|
childUids: string[];
|
|
1317
1429
|
}) => void;
|
|
1318
|
-
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.
|
|
1430
|
+
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
1431
|
uid: string;
|
|
1320
1432
|
spec: {
|
|
1321
1433
|
openapi: string;
|
|
@@ -1442,7 +1554,7 @@ export declare const useWorkspace: () => {
|
|
|
1442
1554
|
selectedServerUid: string;
|
|
1443
1555
|
childUids: string[];
|
|
1444
1556
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1445
|
-
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.
|
|
1557
|
+
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
1558
|
uid: string;
|
|
1447
1559
|
spec: {
|
|
1448
1560
|
openapi: string;
|
|
@@ -1596,7 +1708,7 @@ export declare const useWorkspace: () => {
|
|
|
1596
1708
|
}[];
|
|
1597
1709
|
isDefault?: boolean | undefined;
|
|
1598
1710
|
}) => void;
|
|
1599
|
-
readonly edit: <P extends "
|
|
1711
|
+
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
1712
|
uid: string;
|
|
1601
1713
|
name: string;
|
|
1602
1714
|
color: string;
|
|
@@ -1606,7 +1718,7 @@ export declare const useWorkspace: () => {
|
|
|
1606
1718
|
key: string;
|
|
1607
1719
|
}[];
|
|
1608
1720
|
isDefault?: boolean | undefined;
|
|
1609
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
1721
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "color" | "name" | "uid" | "raw" | "parsed" | "isDefault" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1610
1722
|
uid: string;
|
|
1611
1723
|
name: string;
|
|
1612
1724
|
color: string;
|
|
@@ -1627,7 +1739,7 @@ export declare const useWorkspace: () => {
|
|
|
1627
1739
|
}[];
|
|
1628
1740
|
isDefault?: boolean | undefined;
|
|
1629
1741
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1630
|
-
readonly untrackedEdit: <P extends "
|
|
1742
|
+
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
1743
|
uid: string;
|
|
1632
1744
|
name: string;
|
|
1633
1745
|
color: string;
|
|
@@ -1637,7 +1749,7 @@ export declare const useWorkspace: () => {
|
|
|
1637
1749
|
key: string;
|
|
1638
1750
|
}[];
|
|
1639
1751
|
isDefault?: boolean | undefined;
|
|
1640
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
1752
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "color" | "name" | "uid" | "raw" | "parsed" | "isDefault" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1641
1753
|
uid: string;
|
|
1642
1754
|
name: string;
|
|
1643
1755
|
color: string;
|
|
@@ -1676,12 +1788,12 @@ export declare const useWorkspace: () => {
|
|
|
1676
1788
|
childUids: string[];
|
|
1677
1789
|
description?: string | undefined;
|
|
1678
1790
|
}) => void;
|
|
1679
|
-
readonly edit: <P extends "
|
|
1791
|
+
readonly edit: <P extends "description" | "name" | "uid" | "childUids" | `childUids.${number}`>(uid: string, path: P, value: P extends "description" | "name" | "uid" | "childUids" ? {
|
|
1680
1792
|
uid: string;
|
|
1681
1793
|
name: string;
|
|
1682
1794
|
childUids: string[];
|
|
1683
1795
|
description?: string | undefined;
|
|
1684
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
1796
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "name" | "uid" | "childUids" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1685
1797
|
uid: string;
|
|
1686
1798
|
name: string;
|
|
1687
1799
|
childUids: string[];
|
|
@@ -1692,12 +1804,12 @@ export declare const useWorkspace: () => {
|
|
|
1692
1804
|
childUids: string[];
|
|
1693
1805
|
description?: string | undefined;
|
|
1694
1806
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
1695
|
-
readonly untrackedEdit: <P extends "
|
|
1807
|
+
readonly untrackedEdit: <P extends "description" | "name" | "uid" | "childUids" | `childUids.${number}`>(uid: string, path: P, value: P extends "description" | "name" | "uid" | "childUids" ? {
|
|
1696
1808
|
uid: string;
|
|
1697
1809
|
name: string;
|
|
1698
1810
|
childUids: string[];
|
|
1699
1811
|
description?: string | undefined;
|
|
1700
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
1812
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "name" | "uid" | "childUids" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
1701
1813
|
uid: string;
|
|
1702
1814
|
name: string;
|
|
1703
1815
|
childUids: string[];
|
|
@@ -1713,7 +1825,7 @@ export declare const useWorkspace: () => {
|
|
|
1713
1825
|
};
|
|
1714
1826
|
readonly requestMutators: {
|
|
1715
1827
|
readonly rawAdd: (item: Request) => void;
|
|
1716
|
-
readonly add: (payload: RequestPayload, parentUid?: string) => {
|
|
1828
|
+
readonly add: (payload: RequestPayload, parentUid?: string, server?: Server) => {
|
|
1717
1829
|
path: string;
|
|
1718
1830
|
uid: string;
|
|
1719
1831
|
tags: string[];
|
|
@@ -1739,8 +1851,8 @@ export declare const useWorkspace: () => {
|
|
|
1739
1851
|
};
|
|
1740
1852
|
readonly delete: (request: Request, parentUid: string) => void;
|
|
1741
1853
|
readonly set: (item: Request) => void;
|
|
1742
|
-
readonly edit: <P extends "ref" | "summary" | "path" | "
|
|
1743
|
-
readonly untrackedEdit: <P extends "ref" | "summary" | "path" | "
|
|
1854
|
+
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;
|
|
1855
|
+
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
1856
|
readonly undo: (uid: string) => void;
|
|
1745
1857
|
readonly redo: (uid: string) => void;
|
|
1746
1858
|
};
|
|
@@ -1748,6 +1860,7 @@ export declare const useWorkspace: () => {
|
|
|
1748
1860
|
readonly rawAdd: (item: {
|
|
1749
1861
|
uid: string;
|
|
1750
1862
|
name: string;
|
|
1863
|
+
url: string;
|
|
1751
1864
|
parameters: {
|
|
1752
1865
|
path: {
|
|
1753
1866
|
value: string;
|
|
@@ -1844,11 +1957,111 @@ export declare const useWorkspace: () => {
|
|
|
1844
1957
|
};
|
|
1845
1958
|
auth: Record<string, any>;
|
|
1846
1959
|
}) => void;
|
|
1847
|
-
readonly add: (request: Request) =>
|
|
1960
|
+
readonly add: (request: Request, name?: string) => {
|
|
1961
|
+
uid: string;
|
|
1962
|
+
name: string;
|
|
1963
|
+
url: string;
|
|
1964
|
+
parameters: {
|
|
1965
|
+
path: {
|
|
1966
|
+
value: string;
|
|
1967
|
+
key: string;
|
|
1968
|
+
enabled: boolean;
|
|
1969
|
+
minimum?: number | undefined;
|
|
1970
|
+
type?: string | undefined;
|
|
1971
|
+
maximum?: number | undefined;
|
|
1972
|
+
default?: any;
|
|
1973
|
+
description?: string | undefined;
|
|
1974
|
+
enum?: string[] | undefined;
|
|
1975
|
+
required?: boolean | undefined;
|
|
1976
|
+
file?: File | undefined;
|
|
1977
|
+
refUid?: string | undefined;
|
|
1978
|
+
format?: string | undefined;
|
|
1979
|
+
nullable?: boolean | undefined;
|
|
1980
|
+
}[];
|
|
1981
|
+
query: {
|
|
1982
|
+
value: string;
|
|
1983
|
+
key: string;
|
|
1984
|
+
enabled: boolean;
|
|
1985
|
+
minimum?: number | undefined;
|
|
1986
|
+
type?: string | undefined;
|
|
1987
|
+
maximum?: number | undefined;
|
|
1988
|
+
default?: any;
|
|
1989
|
+
description?: string | undefined;
|
|
1990
|
+
enum?: string[] | undefined;
|
|
1991
|
+
required?: boolean | undefined;
|
|
1992
|
+
file?: File | undefined;
|
|
1993
|
+
refUid?: string | undefined;
|
|
1994
|
+
format?: string | undefined;
|
|
1995
|
+
nullable?: boolean | undefined;
|
|
1996
|
+
}[];
|
|
1997
|
+
cookies: {
|
|
1998
|
+
value: string;
|
|
1999
|
+
key: string;
|
|
2000
|
+
enabled: boolean;
|
|
2001
|
+
minimum?: number | undefined;
|
|
2002
|
+
type?: string | undefined;
|
|
2003
|
+
maximum?: number | undefined;
|
|
2004
|
+
default?: any;
|
|
2005
|
+
description?: string | undefined;
|
|
2006
|
+
enum?: string[] | undefined;
|
|
2007
|
+
required?: boolean | undefined;
|
|
2008
|
+
file?: File | undefined;
|
|
2009
|
+
refUid?: string | undefined;
|
|
2010
|
+
format?: string | undefined;
|
|
2011
|
+
nullable?: boolean | undefined;
|
|
2012
|
+
}[];
|
|
2013
|
+
headers: {
|
|
2014
|
+
value: string;
|
|
2015
|
+
key: string;
|
|
2016
|
+
enabled: boolean;
|
|
2017
|
+
minimum?: number | undefined;
|
|
2018
|
+
type?: string | undefined;
|
|
2019
|
+
maximum?: number | undefined;
|
|
2020
|
+
default?: any;
|
|
2021
|
+
description?: string | undefined;
|
|
2022
|
+
enum?: string[] | undefined;
|
|
2023
|
+
required?: boolean | undefined;
|
|
2024
|
+
file?: File | undefined;
|
|
2025
|
+
refUid?: string | undefined;
|
|
2026
|
+
format?: string | undefined;
|
|
2027
|
+
nullable?: boolean | undefined;
|
|
2028
|
+
}[];
|
|
2029
|
+
};
|
|
2030
|
+
requestUid: string;
|
|
2031
|
+
body: {
|
|
2032
|
+
raw: {
|
|
2033
|
+
value: string;
|
|
2034
|
+
encoding: "json" | "text" | "html" | "javascript" | "xml" | "yaml" | "edn";
|
|
2035
|
+
};
|
|
2036
|
+
formData: {
|
|
2037
|
+
value: {
|
|
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
|
+
encoding: "form-data" | "urlencoded";
|
|
2054
|
+
};
|
|
2055
|
+
activeBody: "raw" | "formData" | "binary";
|
|
2056
|
+
binary?: File | undefined;
|
|
2057
|
+
};
|
|
2058
|
+
auth: Record<string, any>;
|
|
2059
|
+
};
|
|
1848
2060
|
readonly delete: (requestExample: RequestExample) => void;
|
|
1849
2061
|
readonly set: (item: {
|
|
1850
2062
|
uid: string;
|
|
1851
2063
|
name: string;
|
|
2064
|
+
url: string;
|
|
1852
2065
|
parameters: {
|
|
1853
2066
|
path: {
|
|
1854
2067
|
value: string;
|
|
@@ -1945,9 +2158,10 @@ export declare const useWorkspace: () => {
|
|
|
1945
2158
|
};
|
|
1946
2159
|
auth: Record<string, any>;
|
|
1947
2160
|
}) => void;
|
|
1948
|
-
readonly edit: <P extends "body" | "name" | "uid" | "parameters" | "parameters.
|
|
2161
|
+
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
2162
|
uid: string;
|
|
1950
2163
|
name: string;
|
|
2164
|
+
url: string;
|
|
1951
2165
|
parameters: {
|
|
1952
2166
|
path: {
|
|
1953
2167
|
value: string;
|
|
@@ -2043,9 +2257,10 @@ export declare const useWorkspace: () => {
|
|
|
2043
2257
|
binary?: File | undefined;
|
|
2044
2258
|
};
|
|
2045
2259
|
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<{
|
|
2260
|
+
}[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
2261
|
uid: string;
|
|
2048
2262
|
name: string;
|
|
2263
|
+
url: string;
|
|
2049
2264
|
parameters: {
|
|
2050
2265
|
path: {
|
|
2051
2266
|
value: string;
|
|
@@ -2144,6 +2359,7 @@ export declare const useWorkspace: () => {
|
|
|
2144
2359
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2145
2360
|
uid: string;
|
|
2146
2361
|
name: string;
|
|
2362
|
+
url: string;
|
|
2147
2363
|
parameters: {
|
|
2148
2364
|
path: {
|
|
2149
2365
|
value: string;
|
|
@@ -2240,9 +2456,10 @@ export declare const useWorkspace: () => {
|
|
|
2240
2456
|
};
|
|
2241
2457
|
auth: Record<string, any>;
|
|
2242
2458
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
2243
|
-
readonly untrackedEdit: <P extends "body" | "name" | "uid" | "parameters" | "parameters.
|
|
2459
|
+
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
2460
|
uid: string;
|
|
2245
2461
|
name: string;
|
|
2462
|
+
url: string;
|
|
2246
2463
|
parameters: {
|
|
2247
2464
|
path: {
|
|
2248
2465
|
value: string;
|
|
@@ -2338,9 +2555,10 @@ export declare const useWorkspace: () => {
|
|
|
2338
2555
|
binary?: File | undefined;
|
|
2339
2556
|
};
|
|
2340
2557
|
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<{
|
|
2558
|
+
}[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
2559
|
uid: string;
|
|
2343
2560
|
name: string;
|
|
2561
|
+
url: string;
|
|
2344
2562
|
parameters: {
|
|
2345
2563
|
path: {
|
|
2346
2564
|
value: string;
|
|
@@ -2439,6 +2657,7 @@ export declare const useWorkspace: () => {
|
|
|
2439
2657
|
}[K]> ? import("@scalar/object-utils/nested").PathValue<{
|
|
2440
2658
|
uid: string;
|
|
2441
2659
|
name: string;
|
|
2660
|
+
url: string;
|
|
2442
2661
|
parameters: {
|
|
2443
2662
|
path: {
|
|
2444
2663
|
value: string;
|
|
@@ -2667,14 +2886,14 @@ export declare const useWorkspace: () => {
|
|
|
2667
2886
|
openIdConnectUrl: string;
|
|
2668
2887
|
description?: string | undefined;
|
|
2669
2888
|
}) => void;
|
|
2670
|
-
edit: <P extends "type" | "
|
|
2889
|
+
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
2890
|
type: "apiKey";
|
|
2672
2891
|
value: string;
|
|
2673
2892
|
uid: string;
|
|
2674
2893
|
name: string;
|
|
2675
2894
|
in: "query" | "header" | "cookie";
|
|
2676
2895
|
description?: string | undefined;
|
|
2677
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
2896
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "name" | "uid" | "in" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2678
2897
|
type: "apiKey";
|
|
2679
2898
|
value: string;
|
|
2680
2899
|
uid: string;
|
|
@@ -2688,7 +2907,7 @@ export declare const useWorkspace: () => {
|
|
|
2688
2907
|
name: string;
|
|
2689
2908
|
in: "query" | "header" | "cookie";
|
|
2690
2909
|
description?: string | undefined;
|
|
2691
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
2910
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? {
|
|
2692
2911
|
type: "http";
|
|
2693
2912
|
value: string;
|
|
2694
2913
|
uid: string;
|
|
@@ -2696,7 +2915,7 @@ export declare const useWorkspace: () => {
|
|
|
2696
2915
|
bearerFormat: string;
|
|
2697
2916
|
secondValue: string;
|
|
2698
2917
|
description?: string | undefined;
|
|
2699
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
2918
|
+
}[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
2919
|
type: "http";
|
|
2701
2920
|
value: string;
|
|
2702
2921
|
uid: string;
|
|
@@ -2712,7 +2931,7 @@ export declare const useWorkspace: () => {
|
|
|
2712
2931
|
bearerFormat: string;
|
|
2713
2932
|
secondValue: string;
|
|
2714
2933
|
description?: string | undefined;
|
|
2715
|
-
}[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" | "uid" | "flows" | "clientId" | "redirectUri" ? {
|
|
2716
2935
|
type: "oauth2";
|
|
2717
2936
|
uid: string;
|
|
2718
2937
|
flows: {
|
|
@@ -2754,7 +2973,7 @@ export declare const useWorkspace: () => {
|
|
|
2754
2973
|
clientId: string;
|
|
2755
2974
|
redirectUri: string;
|
|
2756
2975
|
description?: string | undefined;
|
|
2757
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
2976
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2758
2977
|
type: "oauth2";
|
|
2759
2978
|
uid: string;
|
|
2760
2979
|
flows: {
|
|
@@ -2838,12 +3057,12 @@ export declare const useWorkspace: () => {
|
|
|
2838
3057
|
clientId: string;
|
|
2839
3058
|
redirectUri: string;
|
|
2840
3059
|
description?: string | undefined;
|
|
2841
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
3060
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "openIdConnectUrl" ? {
|
|
2842
3061
|
type: "openIdConnect";
|
|
2843
3062
|
uid: string;
|
|
2844
3063
|
openIdConnectUrl: string;
|
|
2845
3064
|
description?: string | undefined;
|
|
2846
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3065
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "openIdConnectUrl" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2847
3066
|
type: "openIdConnect";
|
|
2848
3067
|
uid: string;
|
|
2849
3068
|
openIdConnectUrl: string;
|
|
@@ -2854,14 +3073,14 @@ export declare const useWorkspace: () => {
|
|
|
2854
3073
|
openIdConnectUrl: string;
|
|
2855
3074
|
description?: string | undefined;
|
|
2856
3075
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
|
|
2857
|
-
untrackedEdit: <P extends "type" | "
|
|
3076
|
+
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
3077
|
type: "apiKey";
|
|
2859
3078
|
value: string;
|
|
2860
3079
|
uid: string;
|
|
2861
3080
|
name: string;
|
|
2862
3081
|
in: "query" | "header" | "cookie";
|
|
2863
3082
|
description?: string | undefined;
|
|
2864
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3083
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "value" | "name" | "uid" | "in" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2865
3084
|
type: "apiKey";
|
|
2866
3085
|
value: string;
|
|
2867
3086
|
uid: string;
|
|
@@ -2875,7 +3094,7 @@ export declare const useWorkspace: () => {
|
|
|
2875
3094
|
name: string;
|
|
2876
3095
|
in: "query" | "header" | "cookie";
|
|
2877
3096
|
description?: string | undefined;
|
|
2878
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
3097
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "value" | "uid" | "scheme" | "bearerFormat" | "secondValue" ? {
|
|
2879
3098
|
type: "http";
|
|
2880
3099
|
value: string;
|
|
2881
3100
|
uid: string;
|
|
@@ -2883,7 +3102,7 @@ export declare const useWorkspace: () => {
|
|
|
2883
3102
|
bearerFormat: string;
|
|
2884
3103
|
secondValue: string;
|
|
2885
3104
|
description?: string | undefined;
|
|
2886
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3105
|
+
}[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
3106
|
type: "http";
|
|
2888
3107
|
value: string;
|
|
2889
3108
|
uid: string;
|
|
@@ -2899,7 +3118,7 @@ export declare const useWorkspace: () => {
|
|
|
2899
3118
|
bearerFormat: string;
|
|
2900
3119
|
secondValue: string;
|
|
2901
3120
|
description?: string | undefined;
|
|
2902
|
-
}[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" | "uid" | "flows" | "clientId" | "redirectUri" ? {
|
|
2903
3122
|
type: "oauth2";
|
|
2904
3123
|
uid: string;
|
|
2905
3124
|
flows: {
|
|
@@ -2941,7 +3160,7 @@ export declare const useWorkspace: () => {
|
|
|
2941
3160
|
clientId: string;
|
|
2942
3161
|
redirectUri: string;
|
|
2943
3162
|
description?: string | undefined;
|
|
2944
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3163
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "flows" | "clientId" | "redirectUri" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
2945
3164
|
type: "oauth2";
|
|
2946
3165
|
uid: string;
|
|
2947
3166
|
flows: {
|
|
@@ -3025,12 +3244,12 @@ export declare const useWorkspace: () => {
|
|
|
3025
3244
|
clientId: string;
|
|
3026
3245
|
redirectUri: string;
|
|
3027
3246
|
description?: string | undefined;
|
|
3028
|
-
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "
|
|
3247
|
+
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) | (P extends "type" | "description" | "uid" | "openIdConnectUrl" ? {
|
|
3029
3248
|
type: "openIdConnect";
|
|
3030
3249
|
uid: string;
|
|
3031
3250
|
openIdConnectUrl: string;
|
|
3032
3251
|
description?: string | undefined;
|
|
3033
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "
|
|
3252
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "type" | "description" | "uid" | "openIdConnectUrl" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3034
3253
|
type: "openIdConnect";
|
|
3035
3254
|
uid: string;
|
|
3036
3255
|
openIdConnectUrl: string;
|
|
@@ -3071,7 +3290,7 @@ export declare const useWorkspace: () => {
|
|
|
3071
3290
|
enum?: string[] | undefined;
|
|
3072
3291
|
}> | null | undefined;
|
|
3073
3292
|
}) => void;
|
|
3074
|
-
readonly edit: <P extends "
|
|
3293
|
+
readonly edit: <P extends "description" | "url" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "url" | "uid" | "variables" ? {
|
|
3075
3294
|
uid: string;
|
|
3076
3295
|
url: string;
|
|
3077
3296
|
description?: string | undefined;
|
|
@@ -3082,7 +3301,7 @@ export declare const useWorkspace: () => {
|
|
|
3082
3301
|
description?: string | undefined;
|
|
3083
3302
|
enum?: string[] | undefined;
|
|
3084
3303
|
}> | null | undefined;
|
|
3085
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
3304
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "url" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3086
3305
|
uid: string;
|
|
3087
3306
|
url: string;
|
|
3088
3307
|
description?: string | undefined;
|
|
@@ -3105,7 +3324,7 @@ export declare const useWorkspace: () => {
|
|
|
3105
3324
|
enum?: string[] | undefined;
|
|
3106
3325
|
}> | null | undefined;
|
|
3107
3326
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3108
|
-
readonly untrackedEdit: <P extends "
|
|
3327
|
+
readonly untrackedEdit: <P extends "description" | "url" | "uid" | "variables" | `variables.${string}`>(uid: string, path: P, value: P extends "description" | "url" | "uid" | "variables" ? {
|
|
3109
3328
|
uid: string;
|
|
3110
3329
|
url: string;
|
|
3111
3330
|
description?: string | undefined;
|
|
@@ -3116,7 +3335,7 @@ export declare const useWorkspace: () => {
|
|
|
3116
3335
|
description?: string | undefined;
|
|
3117
3336
|
enum?: string[] | undefined;
|
|
3118
3337
|
}> | null | undefined;
|
|
3119
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
3338
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "description" | "url" | "uid" | "variables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
3120
3339
|
uid: string;
|
|
3121
3340
|
url: string;
|
|
3122
3341
|
description?: string | undefined;
|
|
@@ -3143,7 +3362,7 @@ export declare const useWorkspace: () => {
|
|
|
3143
3362
|
readonly redo: (uid: string) => void;
|
|
3144
3363
|
};
|
|
3145
3364
|
readonly workspaceMutators: {
|
|
3146
|
-
|
|
3365
|
+
readonly rawAdd: (item: {
|
|
3147
3366
|
uid: string;
|
|
3148
3367
|
description: string;
|
|
3149
3368
|
name: string;
|
|
@@ -3154,8 +3373,19 @@ export declare const useWorkspace: () => {
|
|
|
3154
3373
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3155
3374
|
proxyUrl?: string | undefined;
|
|
3156
3375
|
}) => void;
|
|
3157
|
-
|
|
3158
|
-
|
|
3376
|
+
readonly add: (payload?: WorkspacePayload) => {
|
|
3377
|
+
uid: string;
|
|
3378
|
+
description: string;
|
|
3379
|
+
name: string;
|
|
3380
|
+
isReadOnly: boolean;
|
|
3381
|
+
collectionUids: string[];
|
|
3382
|
+
environmentUids: string[];
|
|
3383
|
+
cookieUids: string[];
|
|
3384
|
+
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3385
|
+
proxyUrl?: string | undefined;
|
|
3386
|
+
};
|
|
3387
|
+
readonly delete: (uid: string) => void;
|
|
3388
|
+
readonly set: (item: {
|
|
3159
3389
|
uid: string;
|
|
3160
3390
|
description: string;
|
|
3161
3391
|
name: string;
|
|
@@ -3166,7 +3396,7 @@ export declare const useWorkspace: () => {
|
|
|
3166
3396
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3167
3397
|
proxyUrl?: string | undefined;
|
|
3168
3398
|
}) => void;
|
|
3169
|
-
edit: <P extends "
|
|
3399
|
+
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
3400
|
uid: string;
|
|
3171
3401
|
description: string;
|
|
3172
3402
|
name: string;
|
|
@@ -3176,7 +3406,7 @@ export declare const useWorkspace: () => {
|
|
|
3176
3406
|
cookieUids: string[];
|
|
3177
3407
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3178
3408
|
proxyUrl?: string | undefined;
|
|
3179
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
3409
|
+
}[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
3410
|
uid: string;
|
|
3181
3411
|
description: string;
|
|
3182
3412
|
name: string;
|
|
@@ -3197,7 +3427,7 @@ export declare const useWorkspace: () => {
|
|
|
3197
3427
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3198
3428
|
proxyUrl?: string | undefined;
|
|
3199
3429
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3200
|
-
untrackedEdit: <P extends "
|
|
3430
|
+
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
3431
|
uid: string;
|
|
3202
3432
|
description: string;
|
|
3203
3433
|
name: string;
|
|
@@ -3207,7 +3437,7 @@ export declare const useWorkspace: () => {
|
|
|
3207
3437
|
cookieUids: string[];
|
|
3208
3438
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3209
3439
|
proxyUrl?: string | undefined;
|
|
3210
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "
|
|
3440
|
+
}[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
3441
|
uid: string;
|
|
3212
3442
|
description: string;
|
|
3213
3443
|
name: string;
|
|
@@ -3228,8 +3458,8 @@ export declare const useWorkspace: () => {
|
|
|
3228
3458
|
themeId: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "mars" | "none";
|
|
3229
3459
|
proxyUrl?: string | undefined;
|
|
3230
3460
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
3231
|
-
undo: (uid: string) => void;
|
|
3232
|
-
redo: (uid: string) => void;
|
|
3461
|
+
readonly undo: (uid: string) => void;
|
|
3462
|
+
readonly redo: (uid: string) => void;
|
|
3233
3463
|
};
|
|
3234
3464
|
};
|
|
3235
3465
|
export {};
|