@scalar/workspace-store 0.19.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +44 -0
- package/README.md +2 -2
- package/dist/client.d.ts +40 -4
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +58 -23
- package/dist/client.js.map +2 -2
- package/dist/events/bus.d.ts +13 -1
- package/dist/events/bus.d.ts.map +1 -1
- package/dist/events/bus.js +46 -10
- package/dist/events/bus.js.map +3 -3
- package/dist/events/definitions/auth.d.ts +20 -2
- package/dist/events/definitions/auth.d.ts.map +1 -1
- package/dist/events/definitions/cookie.d.ts +20 -0
- package/dist/events/definitions/cookie.d.ts.map +1 -0
- package/dist/events/definitions/cookie.js +1 -0
- package/dist/events/definitions/cookie.js.map +7 -0
- package/dist/events/definitions/document.d.ts +11 -1
- package/dist/events/definitions/document.d.ts.map +1 -1
- package/dist/events/definitions/index.d.ts +4 -2
- package/dist/events/definitions/index.d.ts.map +1 -1
- package/dist/events/definitions/operation.d.ts +0 -13
- package/dist/events/definitions/operation.d.ts.map +1 -1
- package/dist/events/definitions/server.d.ts +20 -28
- package/dist/events/definitions/server.d.ts.map +1 -1
- package/dist/events/definitions/tabs.d.ts +40 -0
- package/dist/events/definitions/tabs.d.ts.map +1 -0
- package/dist/events/definitions/tabs.js +1 -0
- package/dist/events/definitions/tabs.js.map +7 -0
- package/dist/events/definitions/ui.d.ts +39 -4
- package/dist/events/definitions/ui.d.ts.map +1 -1
- package/dist/events/definitions/workspace.d.ts +18 -0
- package/dist/events/definitions/workspace.d.ts.map +1 -0
- package/dist/events/definitions/workspace.js +1 -0
- package/dist/events/definitions/workspace.js.map +7 -0
- package/dist/events/index.d.ts +2 -2
- package/dist/events/index.d.ts.map +1 -1
- package/dist/events/index.js.map +2 -2
- package/dist/helpers/generate-unique-value.d.ts +19 -6
- package/dist/helpers/generate-unique-value.d.ts.map +1 -1
- package/dist/helpers/generate-unique-value.js +12 -7
- package/dist/helpers/generate-unique-value.js.map +2 -2
- package/dist/helpers/unpack-proxy.d.ts +14 -1
- package/dist/helpers/unpack-proxy.d.ts.map +1 -1
- package/dist/helpers/unpack-proxy.js +51 -1
- package/dist/helpers/unpack-proxy.js.map +3 -3
- package/dist/mutators/auth.d.ts +10 -73
- package/dist/mutators/auth.d.ts.map +1 -1
- package/dist/mutators/auth.js +47 -111
- package/dist/mutators/auth.js.map +2 -2
- package/dist/mutators/cookie.d.ts +21 -13
- package/dist/mutators/cookie.d.ts.map +1 -1
- package/dist/mutators/cookie.js +34 -26
- package/dist/mutators/cookie.js.map +3 -3
- package/dist/mutators/document.d.ts +13 -0
- package/dist/mutators/document.d.ts.map +1 -0
- package/dist/mutators/document.js +25 -0
- package/dist/mutators/document.js.map +7 -0
- package/dist/mutators/index.d.ts +13 -20
- package/dist/mutators/index.d.ts.map +1 -1
- package/dist/mutators/index.js +49 -8
- package/dist/mutators/index.js.map +3 -3
- package/dist/mutators/operation.d.ts +23 -101
- package/dist/mutators/operation.d.ts.map +1 -1
- package/dist/mutators/operation.js +132 -96
- package/dist/mutators/operation.js.map +2 -2
- package/dist/mutators/server.d.ts +43 -8
- package/dist/mutators/server.d.ts.map +1 -1
- package/dist/mutators/server.js +113 -20
- package/dist/mutators/server.js.map +2 -2
- package/dist/mutators/workspace.d.ts +6 -0
- package/dist/mutators/workspace.d.ts.map +1 -0
- package/dist/mutators/workspace.js +24 -0
- package/dist/mutators/workspace.js.map +7 -0
- package/dist/navigation/get-navigation-options.d.ts.map +1 -1
- package/dist/navigation/get-navigation-options.js +4 -4
- package/dist/navigation/get-navigation-options.js.map +2 -2
- package/dist/navigation/helpers/traverse-document.d.ts +2 -0
- package/dist/navigation/helpers/traverse-document.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-document.js +18 -3
- package/dist/navigation/helpers/traverse-document.js.map +2 -2
- package/dist/navigation/helpers/traverse-examples.js +2 -2
- package/dist/navigation/helpers/traverse-examples.js.map +2 -2
- package/dist/navigation/helpers/traverse-paths.d.ts +6 -3
- package/dist/navigation/helpers/traverse-paths.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-paths.js +4 -9
- package/dist/navigation/helpers/traverse-paths.js.map +2 -2
- package/dist/navigation/helpers/traverse-tags.d.ts +0 -1
- package/dist/navigation/helpers/traverse-tags.d.ts.map +1 -1
- package/dist/navigation/helpers/traverse-tags.js +57 -49
- package/dist/navigation/helpers/traverse-tags.js.map +3 -3
- package/dist/persistence/index.d.ts +6 -0
- package/dist/persistence/index.d.ts.map +1 -1
- package/dist/persistence/index.js +18 -0
- package/dist/persistence/index.js.map +2 -2
- package/dist/persistence/indexdb.d.ts +1 -0
- package/dist/persistence/indexdb.d.ts.map +1 -1
- package/dist/persistence/indexdb.js +6 -1
- package/dist/persistence/indexdb.js.map +2 -2
- package/dist/plugins/client/persistence.d.ts +2 -1
- package/dist/plugins/client/persistence.d.ts.map +1 -1
- package/dist/plugins/client/persistence.js +17 -9
- package/dist/plugins/client/persistence.js.map +2 -2
- package/dist/schemas/extensions/document/x-scalar-environments.d.ts +1 -0
- package/dist/schemas/extensions/document/x-scalar-environments.d.ts.map +1 -1
- package/dist/schemas/extensions/document/x-scalar-environments.js.map +2 -2
- package/dist/schemas/extensions/document/x-scalar-set-operation-security.d.ts +13 -0
- package/dist/schemas/extensions/document/x-scalar-set-operation-security.d.ts.map +1 -0
- package/dist/schemas/extensions/document/x-scalar-set-operation-security.js +8 -0
- package/dist/schemas/extensions/document/x-scalar-set-operation-security.js.map +7 -0
- package/dist/schemas/extensions/general/x-scalar-cookies.d.ts +36 -0
- package/dist/schemas/extensions/general/x-scalar-cookies.d.ts.map +1 -0
- package/dist/schemas/extensions/general/x-scalar-cookies.js +15 -0
- package/dist/schemas/extensions/general/x-scalar-cookies.js.map +7 -0
- package/dist/schemas/extensions/general/x-scalar-order.d.ts +12 -0
- package/dist/schemas/extensions/general/x-scalar-order.d.ts.map +1 -0
- package/dist/schemas/extensions/general/x-scalar-order.js +8 -0
- package/dist/schemas/extensions/general/x-scalar-order.js.map +7 -0
- package/dist/schemas/extensions/security/x-scalar-selected-security.d.ts +7 -7
- package/dist/schemas/extensions/security/x-scalar-selected-security.d.ts.map +1 -1
- package/dist/schemas/extensions/security/x-scalar-selected-security.js +2 -2
- package/dist/schemas/extensions/security/x-scalar-selected-security.js.map +2 -2
- package/dist/schemas/extensions/server/x-scalar-selected-server.d.ts +8 -0
- package/dist/schemas/extensions/server/x-scalar-selected-server.d.ts.map +1 -0
- package/dist/schemas/extensions/server/x-scalar-selected-server.js +8 -0
- package/dist/schemas/extensions/server/x-scalar-selected-server.js.map +7 -0
- package/dist/schemas/extensions/tag/x-tag-groups.d.ts +10 -5
- package/dist/schemas/extensions/tag/x-tag-groups.d.ts.map +1 -1
- package/dist/schemas/extensions/tag/x-tag-groups.js +15 -10
- package/dist/schemas/extensions/tag/x-tag-groups.js.map +2 -2
- package/dist/schemas/extensions/workspace/x-scalar-active-proxy.d.ts +18 -0
- package/dist/schemas/extensions/workspace/x-scalar-active-proxy.d.ts.map +1 -0
- package/dist/schemas/extensions/workspace/x-scalar-active-proxy.js +8 -0
- package/dist/schemas/extensions/workspace/x-scalar-active-proxy.js.map +7 -0
- package/dist/schemas/extensions.d.ts +1 -1
- package/dist/schemas/extensions.js +1 -1
- package/dist/schemas/extensions.js.map +2 -2
- package/dist/schemas/inmemory-workspace.d.ts +59 -33
- package/dist/schemas/inmemory-workspace.d.ts.map +1 -1
- package/dist/schemas/navigation.d.ts +9 -1
- package/dist/schemas/navigation.d.ts.map +1 -1
- package/dist/schemas/navigation.js +3 -1
- package/dist/schemas/navigation.js.map +2 -2
- package/dist/schemas/reference-config/index.d.ts +29 -16
- package/dist/schemas/reference-config/index.d.ts.map +1 -1
- package/dist/schemas/reference-config/settings.d.ts +29 -16
- package/dist/schemas/reference-config/settings.d.ts.map +1 -1
- package/dist/schemas/reference-config/settings.js +2 -0
- package/dist/schemas/reference-config/settings.js.map +2 -2
- package/dist/schemas/v3.1/strict/openapi-document.d.ts +992 -549
- package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/openapi-document.js +14 -6
- package/dist/schemas/v3.1/strict/openapi-document.js.map +2 -2
- package/dist/schemas/v3.1/strict/operation.d.ts +3 -7
- package/dist/schemas/v3.1/strict/operation.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/operation.js +1 -5
- package/dist/schemas/v3.1/strict/operation.js.map +2 -2
- package/dist/schemas/v3.1/strict/tag.d.ts +4 -1
- package/dist/schemas/v3.1/strict/tag.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/tag.js +3 -1
- package/dist/schemas/v3.1/strict/tag.js.map +2 -2
- package/dist/schemas/v3.1/strict/type-guards.d.ts +6 -0
- package/dist/schemas/v3.1/strict/type-guards.d.ts.map +1 -1
- package/dist/schemas/v3.1/strict/type-guards.js +4 -0
- package/dist/schemas/v3.1/strict/type-guards.js.map +2 -2
- package/dist/schemas/workspace-specification/config.d.ts +29 -16
- package/dist/schemas/workspace-specification/config.d.ts.map +1 -1
- package/dist/schemas/workspace-specification/index.d.ts +30 -17
- package/dist/schemas/workspace-specification/index.d.ts.map +1 -1
- package/dist/schemas/workspace.d.ts +233 -130
- package/dist/schemas/workspace.d.ts.map +1 -1
- package/dist/schemas/workspace.js +8 -6
- package/dist/schemas/workspace.js.map +2 -2
- package/dist/server.d.ts +1 -1
- package/dist/workspace-plugin.d.ts +3 -0
- package/dist/workspace-plugin.d.ts.map +1 -1
- package/package.json +8 -7
- package/dist/helpers/debounce.d.ts +0 -28
- package/dist/helpers/debounce.d.ts.map +0 -1
- package/dist/helpers/debounce.js +0 -31
- package/dist/helpers/debounce.js.map +0 -7
- package/dist/schemas/extensions/operation/x-scalar-operation-identifiers.d.ts +0 -13
- package/dist/schemas/extensions/operation/x-scalar-operation-identifiers.d.ts.map +0 -1
- package/dist/schemas/extensions/operation/x-scalar-operation-identifiers.js +0 -9
- package/dist/schemas/extensions/operation/x-scalar-operation-identifiers.js.map +0 -7
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts +0 -32
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts.map +0 -1
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js +0 -13
- package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js.map +0 -7
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { WorkspaceDocument } from '../schemas.js';
|
|
2
|
+
/**
|
|
3
|
+
* Toggle setting selected security schemes at the operation level
|
|
4
|
+
*/
|
|
5
|
+
export declare const toggleSecurity: (document: WorkspaceDocument | null) => void;
|
|
6
|
+
export declare const updateWatchMode: (document: WorkspaceDocument | null, watchMode: boolean) => void;
|
|
7
|
+
/**
|
|
8
|
+
* Update the document icon and also update the corresponding sidebar entry
|
|
9
|
+
*
|
|
10
|
+
* Does not perform a sidebar rebuild for performance benefit
|
|
11
|
+
*/
|
|
12
|
+
export declare const updateDocumentIcon: (document: WorkspaceDocument | null, icon: string) => void;
|
|
13
|
+
//# sourceMappingURL=document.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/mutators/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAElD;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,UAAU,iBAAiB,GAAG,IAAI,SAMhE,CAAA;AAED,eAAO,MAAM,eAAe,GAAI,UAAU,iBAAiB,GAAG,IAAI,EAAE,WAAW,OAAO,SAMrF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAU,iBAAiB,GAAG,IAAI,EAAE,MAAM,MAAM,SASlF,CAAA"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
const toggleSecurity = (document) => {
|
|
2
|
+
if (!document) {
|
|
3
|
+
return;
|
|
4
|
+
}
|
|
5
|
+
document["x-scalar-set-operation-security"] = !document["x-scalar-set-operation-security"];
|
|
6
|
+
};
|
|
7
|
+
const updateWatchMode = (document, watchMode) => {
|
|
8
|
+
if (!document) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
document["x-scalar-watch-mode"] = watchMode;
|
|
12
|
+
};
|
|
13
|
+
const updateDocumentIcon = (document, icon) => {
|
|
14
|
+
if (!document || !document["x-scalar-navigation"]) {
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
17
|
+
document["x-scalar-icon"] = icon;
|
|
18
|
+
document["x-scalar-navigation"].icon = icon;
|
|
19
|
+
};
|
|
20
|
+
export {
|
|
21
|
+
toggleSecurity,
|
|
22
|
+
updateDocumentIcon,
|
|
23
|
+
updateWatchMode
|
|
24
|
+
};
|
|
25
|
+
//# sourceMappingURL=document.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/mutators/document.ts"],
|
|
4
|
+
"sourcesContent": ["import type { WorkspaceDocument } from '@/schemas'\n\n/**\n * Toggle setting selected security schemes at the operation level\n */\nexport const toggleSecurity = (document: WorkspaceDocument | null) => {\n if (!document) {\n return\n }\n\n document['x-scalar-set-operation-security'] = !document['x-scalar-set-operation-security']\n}\n\nexport const updateWatchMode = (document: WorkspaceDocument | null, watchMode: boolean) => {\n if (!document) {\n return\n }\n\n document['x-scalar-watch-mode'] = watchMode\n}\n\n/**\n * Update the document icon and also update the corresponding sidebar entry\n *\n * Does not perform a sidebar rebuild for performance benefit\n */\nexport const updateDocumentIcon = (document: WorkspaceDocument | null, icon: string) => {\n if (!document || !document['x-scalar-navigation']) {\n return\n }\n\n // Update the document icon\n document['x-scalar-icon'] = icon\n // Update the sidebar document icon\n document['x-scalar-navigation'].icon = icon\n}\n"],
|
|
5
|
+
"mappings": "AAKO,MAAM,iBAAiB,CAAC,aAAuC;AACpE,MAAI,CAAC,UAAU;AACb;AAAA,EACF;AAEA,WAAS,iCAAiC,IAAI,CAAC,SAAS,iCAAiC;AAC3F;AAEO,MAAM,kBAAkB,CAAC,UAAoC,cAAuB;AACzF,MAAI,CAAC,UAAU;AACb;AAAA,EACF;AAEA,WAAS,qBAAqB,IAAI;AACpC;AAOO,MAAM,qBAAqB,CAAC,UAAoC,SAAiB;AACtF,MAAI,CAAC,YAAY,CAAC,SAAS,qBAAqB,GAAG;AACjD;AAAA,EACF;AAGA,WAAS,eAAe,IAAI;AAE5B,WAAS,qBAAqB,EAAE,OAAO;AACzC;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
package/dist/mutators/index.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
/** biome-ignore-all lint/performance/noBarrelFile: Mutators entry point */
|
|
2
2
|
import type { WorkspaceStore } from '../client.js';
|
|
3
|
+
import type { ServerObject } from '../schemas/v3.1/strict/openapi-document.js';
|
|
3
4
|
/**
|
|
4
5
|
* Generates a set of mutators for managing OpenAPI document and workspace state.
|
|
5
6
|
*
|
|
@@ -13,16 +14,12 @@ export declare function generateClientMutators(store: WorkspaceStore): {
|
|
|
13
14
|
* Returns mutators for the workspace-level configuration.
|
|
14
15
|
*/
|
|
15
16
|
workspace: () => {
|
|
16
|
-
cookieMutators: {
|
|
17
|
-
addCookie: (cookie: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js").XScalarClientConfigCookie) => boolean;
|
|
18
|
-
deleteCookie: (cookieName: string) => boolean;
|
|
19
|
-
};
|
|
20
17
|
serverMutators: {
|
|
21
|
-
addServer: (server:
|
|
18
|
+
addServer: (server: ServerObject) => boolean;
|
|
22
19
|
deleteServer: (url: string) => boolean;
|
|
23
20
|
};
|
|
24
21
|
securitySchemeMutators: {
|
|
25
|
-
addSecurityScheme: (name: string, securityScheme: import("../schemas/v3.1/strict/
|
|
22
|
+
addSecurityScheme: (name: string, securityScheme: import("../schemas/v3.1/strict/openapi-document.js").SecuritySchemeObject) => boolean;
|
|
26
23
|
deleteSecurityScheme: (name: string) => boolean;
|
|
27
24
|
};
|
|
28
25
|
};
|
|
@@ -39,15 +36,11 @@ export declare function generateClientMutators(store: WorkspaceStore): {
|
|
|
39
36
|
deleteRequest: ({ path, method }: import("../mutators/request.js").OperationIdentifier) => boolean;
|
|
40
37
|
};
|
|
41
38
|
securitySchemeMutators: {
|
|
42
|
-
addSecurityScheme: (name: string, securityScheme: import("../schemas/v3.1/strict/
|
|
39
|
+
addSecurityScheme: (name: string, securityScheme: import("../schemas/v3.1/strict/openapi-document.js").SecuritySchemeObject) => boolean;
|
|
43
40
|
deleteSecurityScheme: (name: string) => boolean;
|
|
44
41
|
};
|
|
45
|
-
cookieMutators: {
|
|
46
|
-
addCookie: (cookie: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js").XScalarClientConfigCookie) => boolean;
|
|
47
|
-
deleteCookie: (cookieName: string) => boolean;
|
|
48
|
-
};
|
|
49
42
|
serverMutators: {
|
|
50
|
-
addServer: (server:
|
|
43
|
+
addServer: (server: ServerObject) => boolean;
|
|
51
44
|
deleteServer: (url: string) => boolean;
|
|
52
45
|
};
|
|
53
46
|
};
|
|
@@ -65,20 +58,20 @@ export declare function generateClientMutators(store: WorkspaceStore): {
|
|
|
65
58
|
deleteRequest: ({ path, method }: import("../mutators/request.js").OperationIdentifier) => boolean;
|
|
66
59
|
};
|
|
67
60
|
securitySchemeMutators: {
|
|
68
|
-
addSecurityScheme: (name: string, securityScheme: import("../schemas/v3.1/strict/
|
|
61
|
+
addSecurityScheme: (name: string, securityScheme: import("../schemas/v3.1/strict/openapi-document.js").SecuritySchemeObject) => boolean;
|
|
69
62
|
deleteSecurityScheme: (name: string) => boolean;
|
|
70
63
|
};
|
|
71
|
-
cookieMutators: {
|
|
72
|
-
addCookie: (cookie: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js").XScalarClientConfigCookie) => boolean;
|
|
73
|
-
deleteCookie: (cookieName: string) => boolean;
|
|
74
|
-
};
|
|
75
64
|
serverMutators: {
|
|
76
|
-
addServer: (server:
|
|
65
|
+
addServer: (server: ServerObject) => boolean;
|
|
77
66
|
deleteServer: (url: string) => boolean;
|
|
78
67
|
};
|
|
79
68
|
};
|
|
80
69
|
};
|
|
81
|
-
export { type AuthMeta,
|
|
70
|
+
export { type AuthMeta, deleteSecurityScheme, updateSecurityScheme, updateSelectedAuthTab, updateSelectedScopes, updateSelectedSecuritySchemes, } from './auth.js';
|
|
71
|
+
export { deleteCookie, upsertCookie } from './cookie.js';
|
|
72
|
+
export { toggleSecurity, updateDocumentIcon, updateWatchMode } from './document.js';
|
|
82
73
|
export { upsertEnvironment, upsertEnvironmentVariable, } from './environment.js';
|
|
83
|
-
export { type OperationExampleMeta, type OperationMeta, addOperationParameter, addOperationRequestBodyFormRow, deleteAllOperationParameters, deleteOperationParameter, deleteOperationRequestBodyFormRow,
|
|
74
|
+
export { type OperationExampleMeta, type OperationMeta, addOperationParameter, addOperationRequestBodyFormRow, deleteAllOperationParameters, deleteOperationParameter, deleteOperationRequestBodyFormRow, updateOperationMethod, updateOperationParameter, updateOperationPath, updateOperationRequestBodyContentType, updateOperationRequestBodyExample, updateOperationRequestBodyFormRow, updateOperationSummary, } from './operation.js';
|
|
75
|
+
export { addServer, deleteServer, updateSelectedServer, updateServer, updateServerVariables, } from './server.js';
|
|
76
|
+
export { updateActiveProxy, updateColorMode, updateTheme } from './workspace.js';
|
|
84
77
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mutators/index.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mutators/index.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAI9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,cAAc;IAmGxD;;OAEG;;;gCAxFwB,YAAY,KAAG,OAAO;gCAatB,MAAM,KAAG,OAAO;;;;;;;IA6E3C;;;OAGG;;;;;;;;;;;;;;gCA7FwB,YAAY,KAAG,OAAO;gCAatB,MAAM,KAAG,OAAO;;;IAmF3C;;;;OAIG;gBACS,MAAM;;;;;;;;;;;;;gCArGS,YAAY,KAAG,OAAO;gCAatB,MAAM,KAAG,OAAO;;;EA0F9C;AAED,OAAO,EACL,KAAK,QAAQ,EACb,oBAAoB,EACpB,oBAAoB,EACpB,qBAAqB,EACrB,oBAAoB,EACpB,6BAA6B,GAC9B,MAAM,QAAQ,CAAA;AACf,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACrD,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAChF,OAAO,EACL,iBAAiB,EACjB,yBAAyB,GAC1B,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,aAAa,EAClB,qBAAqB,EACrB,8BAA8B,EAC9B,4BAA4B,EAC5B,wBAAwB,EACxB,iCAAiC,EACjC,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,qCAAqC,EACrC,iCAAiC,EACjC,iCAAiC,EACjC,sBAAsB,GACvB,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,SAAS,EACT,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,qBAAqB,GACtB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA"}
|
package/dist/mutators/index.js
CHANGED
|
@@ -1,9 +1,29 @@
|
|
|
1
|
-
import { cookieMutators } from "../mutators/cookie.js";
|
|
2
1
|
import { getDocument } from "../mutators/helpers.js";
|
|
3
2
|
import { requestMutators } from "../mutators/request.js";
|
|
4
3
|
import { securitySchemeMutators } from "../mutators/security-schemes.js";
|
|
5
|
-
import { serverMutators } from "../mutators/server.js";
|
|
6
4
|
function generateClientMutators(store) {
|
|
5
|
+
const serverMutators = (target) => {
|
|
6
|
+
const addServer2 = (server) => {
|
|
7
|
+
if (!target) {
|
|
8
|
+
return false;
|
|
9
|
+
}
|
|
10
|
+
target.push(server);
|
|
11
|
+
return true;
|
|
12
|
+
};
|
|
13
|
+
const deleteServer2 = (url) => {
|
|
14
|
+
if (!target) {
|
|
15
|
+
return false;
|
|
16
|
+
}
|
|
17
|
+
const newTarget = [...target.filter((it) => it.url !== url)];
|
|
18
|
+
target.splice(0, target.length);
|
|
19
|
+
target.push(...newTarget);
|
|
20
|
+
return true;
|
|
21
|
+
};
|
|
22
|
+
return {
|
|
23
|
+
addServer: addServer2,
|
|
24
|
+
deleteServer: deleteServer2
|
|
25
|
+
};
|
|
26
|
+
};
|
|
7
27
|
const documentMutators = (documentName) => {
|
|
8
28
|
const document = getDocument(store, documentName);
|
|
9
29
|
if (document) {
|
|
@@ -20,7 +40,6 @@ function generateClientMutators(store) {
|
|
|
20
40
|
return {
|
|
21
41
|
requestMutators: requestMutators(document),
|
|
22
42
|
securitySchemeMutators: securitySchemeMutators(document?.components?.securitySchemes),
|
|
23
|
-
cookieMutators: cookieMutators(document),
|
|
24
43
|
serverMutators: serverMutators(document?.servers)
|
|
25
44
|
};
|
|
26
45
|
};
|
|
@@ -33,7 +52,6 @@ function generateClientMutators(store) {
|
|
|
33
52
|
store.workspace["x-scalar-client-config-security-schemes"] = {};
|
|
34
53
|
}
|
|
35
54
|
return {
|
|
36
|
-
cookieMutators: cookieMutators(store.workspace),
|
|
37
55
|
serverMutators: serverMutators(store.workspace["x-scalar-client-config-servers"]),
|
|
38
56
|
securitySchemeMutators: securitySchemeMutators(store.workspace["x-scalar-client-config-security-schemes"])
|
|
39
57
|
};
|
|
@@ -63,6 +81,8 @@ import {
|
|
|
63
81
|
updateSelectedScopes,
|
|
64
82
|
updateSelectedSecuritySchemes
|
|
65
83
|
} from "./auth.js";
|
|
84
|
+
import { deleteCookie, upsertCookie } from "./cookie.js";
|
|
85
|
+
import { toggleSecurity, updateDocumentIcon, updateWatchMode } from "./document.js";
|
|
66
86
|
import {
|
|
67
87
|
upsertEnvironment,
|
|
68
88
|
upsertEnvironmentVariable
|
|
@@ -73,25 +93,40 @@ import {
|
|
|
73
93
|
deleteAllOperationParameters,
|
|
74
94
|
deleteOperationParameter,
|
|
75
95
|
deleteOperationRequestBodyFormRow,
|
|
76
|
-
|
|
96
|
+
updateOperationMethod,
|
|
77
97
|
updateOperationParameter,
|
|
78
|
-
|
|
98
|
+
updateOperationPath,
|
|
79
99
|
updateOperationRequestBodyContentType,
|
|
80
100
|
updateOperationRequestBodyExample,
|
|
81
101
|
updateOperationRequestBodyFormRow,
|
|
82
102
|
updateOperationSummary
|
|
83
103
|
} from "./operation.js";
|
|
104
|
+
import {
|
|
105
|
+
addServer,
|
|
106
|
+
deleteServer,
|
|
107
|
+
updateSelectedServer,
|
|
108
|
+
updateServer,
|
|
109
|
+
updateServerVariables
|
|
110
|
+
} from "./server.js";
|
|
111
|
+
import { updateActiveProxy, updateColorMode, updateTheme } from "./workspace.js";
|
|
84
112
|
export {
|
|
85
113
|
addOperationParameter,
|
|
86
114
|
addOperationRequestBodyFormRow,
|
|
115
|
+
addServer,
|
|
87
116
|
deleteAllOperationParameters,
|
|
117
|
+
deleteCookie,
|
|
88
118
|
deleteOperationParameter,
|
|
89
119
|
deleteOperationRequestBodyFormRow,
|
|
90
120
|
deleteSecurityScheme,
|
|
121
|
+
deleteServer,
|
|
91
122
|
generateClientMutators,
|
|
92
|
-
|
|
123
|
+
toggleSecurity,
|
|
124
|
+
updateActiveProxy,
|
|
125
|
+
updateColorMode,
|
|
126
|
+
updateDocumentIcon,
|
|
127
|
+
updateOperationMethod,
|
|
93
128
|
updateOperationParameter,
|
|
94
|
-
|
|
129
|
+
updateOperationPath,
|
|
95
130
|
updateOperationRequestBodyContentType,
|
|
96
131
|
updateOperationRequestBodyExample,
|
|
97
132
|
updateOperationRequestBodyFormRow,
|
|
@@ -100,6 +135,12 @@ export {
|
|
|
100
135
|
updateSelectedAuthTab,
|
|
101
136
|
updateSelectedScopes,
|
|
102
137
|
updateSelectedSecuritySchemes,
|
|
138
|
+
updateSelectedServer,
|
|
139
|
+
updateServer,
|
|
140
|
+
updateServerVariables,
|
|
141
|
+
updateTheme,
|
|
142
|
+
updateWatchMode,
|
|
143
|
+
upsertCookie,
|
|
103
144
|
upsertEnvironment,
|
|
104
145
|
upsertEnvironmentVariable
|
|
105
146
|
};
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../../src/mutators/index.ts"],
|
|
4
|
-
"sourcesContent": ["/** biome-ignore-all lint/performance/noBarrelFile: Mutators entry point */\nimport type { WorkspaceStore } from '@/client'\nimport {
|
|
5
|
-
"mappings": "AAEA,SAAS,
|
|
6
|
-
"names": []
|
|
4
|
+
"sourcesContent": ["/** biome-ignore-all lint/performance/noBarrelFile: Mutators entry point */\nimport type { WorkspaceStore } from '@/client'\nimport { getDocument } from '@/mutators/helpers'\nimport { requestMutators } from '@/mutators/request'\nimport { securitySchemeMutators } from '@/mutators/security-schemes'\nimport type { ServerObject } from '@/schemas/v3.1/strict/openapi-document'\n\n/**\n * Generates a set of mutators for managing OpenAPI document and workspace state.\n *\n * @deprecated use the individual mutators instead, this will be removed after we move fully to the new store\n *\n * @param store - The workspace store containing all documents and workspace-level data\n * @returns An object with mutators for the workspace, the active document, and any named document\n */\nexport function generateClientMutators(store: WorkspaceStore) {\n /**\n * Provides mutator functions for managing an array of OpenAPI ServerObject entries.\n *\n * @param target - The array of ServerObject to mutate. If not provided, mutators will be no-ops.\n * @returns An object with addServer and deleteServer methods.\n */\n const serverMutators = (target?: ServerObject[]) => {\n /**\n * Adds a new ServerObject to the target array.\n * @param server - The ServerObject to add.\n * @returns true if the server was added, false if target is undefined.\n */\n const addServer = (server: ServerObject): boolean => {\n if (!target) {\n return false\n }\n target.push(server)\n return true\n }\n\n /**\n * Deletes a ServerObject at the specified index from the target array.\n * @param index - The index of the server to delete.\n * @returns true if the server was deleted, false if target is undefined.\n */\n const deleteServer = (url: string): boolean => {\n if (!target) {\n return false\n }\n const newTarget = [...target.filter((it) => it.url !== url)]\n target.splice(0, target.length)\n target.push(...newTarget)\n return true\n }\n\n return {\n addServer,\n deleteServer,\n }\n }\n\n /**\n * Returns mutators for a specific document by name.\n *\n * @param documentName - The name of the document to get mutators for\n * @returns An object containing mutators for requests, request examples, security schemes, environments, and cookies\n */\n const documentMutators = (documentName: string) => {\n const document = getDocument(store, documentName)\n\n if (document) {\n // Make sure the document has a servers array\n if (!document.servers) {\n document.servers = []\n }\n\n // Make sure the document has the securitySchema object\n if (!document.components) {\n document.components = {}\n }\n\n if (!document.components.securitySchemes) {\n document.components.securitySchemes = {}\n }\n }\n\n return {\n requestMutators: requestMutators(document),\n securitySchemeMutators: securitySchemeMutators(document?.components?.securitySchemes),\n serverMutators: serverMutators(document?.servers),\n }\n }\n\n /**\n * Returns mutators for the workspace-level configuration.\n *\n * @returns An object containing mutators for environments and cookies at the workspace level\n */\n const workspaceMutators = () => {\n const workspace = store.workspace\n\n // Make sure the workspace has a servers array\n if (!workspace['x-scalar-client-config-servers']) {\n workspace['x-scalar-client-config-servers'] = []\n }\n\n // Make sure the workspace has the securitySchema object\n if (!store.workspace['x-scalar-client-config-security-schemes']) {\n store.workspace['x-scalar-client-config-security-schemes'] = {}\n }\n\n return {\n serverMutators: serverMutators(store.workspace['x-scalar-client-config-servers']),\n securitySchemeMutators: securitySchemeMutators(store.workspace['x-scalar-client-config-security-schemes']),\n }\n }\n\n return {\n /**\n * Returns mutators for the workspace-level configuration.\n */\n workspace: () => workspaceMutators(),\n /**\n * Returns mutators for the currently active document.\n * Falls back to the first document if no active document is set.\n */\n active: () =>\n documentMutators(store.workspace['x-scalar-active-document'] ?? Object.keys(store.workspace.documents)[0] ?? ''),\n /**\n * Returns mutators for a specific document by name.\n *\n * @param name - The name of the document\n */\n doc: (name: string) => documentMutators(name),\n }\n}\n\nexport {\n type AuthMeta,\n deleteSecurityScheme,\n updateSecurityScheme,\n updateSelectedAuthTab,\n updateSelectedScopes,\n updateSelectedSecuritySchemes,\n} from './auth'\nexport { deleteCookie, upsertCookie } from './cookie'\nexport { toggleSecurity, updateDocumentIcon, updateWatchMode } from './document'\nexport {\n upsertEnvironment,\n upsertEnvironmentVariable,\n} from './environment'\nexport {\n type OperationExampleMeta,\n type OperationMeta,\n addOperationParameter,\n addOperationRequestBodyFormRow,\n deleteAllOperationParameters,\n deleteOperationParameter,\n deleteOperationRequestBodyFormRow,\n updateOperationMethod,\n updateOperationParameter,\n updateOperationPath,\n updateOperationRequestBodyContentType,\n updateOperationRequestBodyExample,\n updateOperationRequestBodyFormRow,\n updateOperationSummary,\n} from './operation'\nexport {\n addServer,\n deleteServer,\n updateSelectedServer,\n updateServer,\n updateServerVariables,\n} from './server'\nexport { updateActiveProxy, updateColorMode, updateTheme } from './workspace'\n"],
|
|
5
|
+
"mappings": "AAEA,SAAS,mBAAmB;AAC5B,SAAS,uBAAuB;AAChC,SAAS,8BAA8B;AAWhC,SAAS,uBAAuB,OAAuB;AAO5D,QAAM,iBAAiB,CAAC,WAA4B;AAMlD,UAAMA,aAAY,CAAC,WAAkC;AACnD,UAAI,CAAC,QAAQ;AACX,eAAO;AAAA,MACT;AACA,aAAO,KAAK,MAAM;AAClB,aAAO;AAAA,IACT;AAOA,UAAMC,gBAAe,CAAC,QAAyB;AAC7C,UAAI,CAAC,QAAQ;AACX,eAAO;AAAA,MACT;AACA,YAAM,YAAY,CAAC,GAAG,OAAO,OAAO,CAAC,OAAO,GAAG,QAAQ,GAAG,CAAC;AAC3D,aAAO,OAAO,GAAG,OAAO,MAAM;AAC9B,aAAO,KAAK,GAAG,SAAS;AACxB,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,MACL,WAAAD;AAAA,MACA,cAAAC;AAAA,IACF;AAAA,EACF;AAQA,QAAM,mBAAmB,CAAC,iBAAyB;AACjD,UAAM,WAAW,YAAY,OAAO,YAAY;AAEhD,QAAI,UAAU;AAEZ,UAAI,CAAC,SAAS,SAAS;AACrB,iBAAS,UAAU,CAAC;AAAA,MACtB;AAGA,UAAI,CAAC,SAAS,YAAY;AACxB,iBAAS,aAAa,CAAC;AAAA,MACzB;AAEA,UAAI,CAAC,SAAS,WAAW,iBAAiB;AACxC,iBAAS,WAAW,kBAAkB,CAAC;AAAA,MACzC;AAAA,IACF;AAEA,WAAO;AAAA,MACL,iBAAiB,gBAAgB,QAAQ;AAAA,MACzC,wBAAwB,uBAAuB,UAAU,YAAY,eAAe;AAAA,MACpF,gBAAgB,eAAe,UAAU,OAAO;AAAA,IAClD;AAAA,EACF;AAOA,QAAM,oBAAoB,MAAM;AAC9B,UAAM,YAAY,MAAM;AAGxB,QAAI,CAAC,UAAU,gCAAgC,GAAG;AAChD,gBAAU,gCAAgC,IAAI,CAAC;AAAA,IACjD;AAGA,QAAI,CAAC,MAAM,UAAU,yCAAyC,GAAG;AAC/D,YAAM,UAAU,yCAAyC,IAAI,CAAC;AAAA,IAChE;AAEA,WAAO;AAAA,MACL,gBAAgB,eAAe,MAAM,UAAU,gCAAgC,CAAC;AAAA,MAChF,wBAAwB,uBAAuB,MAAM,UAAU,yCAAyC,CAAC;AAAA,IAC3G;AAAA,EACF;AAEA,SAAO;AAAA;AAAA;AAAA;AAAA,IAIL,WAAW,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA;AAAA,IAKnC,QAAQ,MACN,iBAAiB,MAAM,UAAU,0BAA0B,KAAK,OAAO,KAAK,MAAM,UAAU,SAAS,EAAE,CAAC,KAAK,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAMjH,KAAK,CAAC,SAAiB,iBAAiB,IAAI;AAAA,EAC9C;AACF;AAEA;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,cAAc,oBAAoB;AAC3C,SAAS,gBAAgB,oBAAoB,uBAAuB;AACpE;AAAA,EACE;AAAA,EACA;AAAA,OACK;AACP;AAAA,EAGE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,mBAAmB,iBAAiB,mBAAmB;",
|
|
6
|
+
"names": ["addServer", "deleteServer"]
|
|
7
7
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { HttpMethod } from '@scalar/helpers/http/http-methods';
|
|
2
|
+
import type { OperationEvents } from '../events/definitions/operation.js';
|
|
2
3
|
import type { WorkspaceDocument } from '../schemas.js';
|
|
3
4
|
/**
|
|
4
5
|
* Describes the minimal identity for an operation in the workspace document.
|
|
@@ -38,20 +39,15 @@ export type OperationExampleMeta = OperationMeta & {
|
|
|
38
39
|
*
|
|
39
40
|
* Example:
|
|
40
41
|
* ```ts
|
|
41
|
-
* updateOperationSummary(
|
|
42
|
+
* updateOperationSummary(
|
|
42
43
|
* document,
|
|
44
|
+
* {
|
|
43
45
|
* meta: { method: 'get', path: '/users/{id}' },
|
|
44
46
|
* payload: { summary: 'Get a single user' },
|
|
45
47
|
* })
|
|
46
48
|
* ```
|
|
47
49
|
*/
|
|
48
|
-
export declare const updateOperationSummary: (
|
|
49
|
-
document: WorkspaceDocument | null;
|
|
50
|
-
payload: {
|
|
51
|
-
summary: string;
|
|
52
|
-
};
|
|
53
|
-
meta: OperationMeta;
|
|
54
|
-
}) => void;
|
|
50
|
+
export declare const updateOperationSummary: (document: WorkspaceDocument | null, { meta, payload: { summary } }: OperationEvents["operation:update:summary"]) => void;
|
|
55
51
|
/**
|
|
56
52
|
* Stores the chosen HTTP method under `x-scalar-method` on the operation.
|
|
57
53
|
* This does not move the operation to a different method slot under `paths`;
|
|
@@ -67,36 +63,25 @@ export declare const updateOperationSummary: ({ document, meta, payload: { summa
|
|
|
67
63
|
* })
|
|
68
64
|
* ```
|
|
69
65
|
*/
|
|
70
|
-
export declare const
|
|
71
|
-
document: WorkspaceDocument | null;
|
|
72
|
-
payload: {
|
|
73
|
-
method: HttpMethod;
|
|
74
|
-
};
|
|
75
|
-
meta: OperationMeta;
|
|
76
|
-
}) => void;
|
|
66
|
+
export declare const updateOperationMethod: (document: WorkspaceDocument | null, { meta, payload: { method } }: OperationEvents["operation:update:method"]) => void;
|
|
77
67
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
68
|
+
* Moves the operation to a new path in the document and synchronizes path
|
|
69
|
+
* parameters in `operation.parameters` with the placeholders present in the
|
|
70
|
+
* provided `path` (e.g. `/users/{id}`). When path parameters change,
|
|
71
|
+
* intelligently syncs them by preserving configurations for renamed parameters
|
|
72
|
+
* (detected by position) and existing parameters. Existing non-path parameters
|
|
73
|
+
* are preserved. The operation is removed from the old path location.
|
|
83
74
|
*
|
|
84
75
|
* Example:
|
|
85
76
|
* ```ts
|
|
86
|
-
*
|
|
77
|
+
* updateOperationPath({
|
|
87
78
|
* document,
|
|
88
79
|
* meta: { method: 'get', path: '/users/{id}' },
|
|
89
|
-
* payload: { path: '/users/{
|
|
80
|
+
* payload: { path: '/users/{userId}' },
|
|
90
81
|
* })
|
|
91
82
|
* ```
|
|
92
83
|
*/
|
|
93
|
-
export declare const
|
|
94
|
-
document: WorkspaceDocument | null;
|
|
95
|
-
payload: {
|
|
96
|
-
path: string;
|
|
97
|
-
};
|
|
98
|
-
meta: OperationMeta;
|
|
99
|
-
}) => void;
|
|
84
|
+
export declare const updateOperationPath: (document: WorkspaceDocument | null, { meta, payload: { path } }: OperationEvents["operation:update:path"]) => void;
|
|
100
85
|
/** ------------------------------------------------------------------------------------------------
|
|
101
86
|
* Operation Parameters Mutators
|
|
102
87
|
* ------------------------------------------------------------------------------------------------ */
|
|
@@ -115,16 +100,7 @@ export declare const updateOperationPathDraft: ({ document, meta, payload: { pat
|
|
|
115
100
|
* })
|
|
116
101
|
* ```
|
|
117
102
|
*/
|
|
118
|
-
export declare const addOperationParameter: (
|
|
119
|
-
document: WorkspaceDocument | null;
|
|
120
|
-
type: "header" | "path" | "query" | "cookie";
|
|
121
|
-
payload: {
|
|
122
|
-
key: string;
|
|
123
|
-
value: string;
|
|
124
|
-
isEnabled: boolean;
|
|
125
|
-
};
|
|
126
|
-
meta: OperationExampleMeta;
|
|
127
|
-
}) => void;
|
|
103
|
+
export declare const addOperationParameter: (document: WorkspaceDocument | null, { meta, payload, type }: OperationEvents["operation:add:parameter"]) => void;
|
|
128
104
|
/**
|
|
129
105
|
* Updates an existing parameter of a given `type` by its index within that
|
|
130
106
|
* type subset (e.g. the N-th query parameter). Supports updating name, value,
|
|
@@ -142,17 +118,7 @@ export declare const addOperationParameter: ({ document, meta, payload, type, }:
|
|
|
142
118
|
* })
|
|
143
119
|
* ```
|
|
144
120
|
*/
|
|
145
|
-
export declare const updateOperationParameter: (
|
|
146
|
-
document: WorkspaceDocument | null;
|
|
147
|
-
type: "header" | "path" | "query" | "cookie";
|
|
148
|
-
index: number;
|
|
149
|
-
payload: Partial<{
|
|
150
|
-
key: string;
|
|
151
|
-
value: string;
|
|
152
|
-
isEnabled: boolean;
|
|
153
|
-
}>;
|
|
154
|
-
meta: OperationExampleMeta;
|
|
155
|
-
}) => void;
|
|
121
|
+
export declare const updateOperationParameter: (document: WorkspaceDocument | null, { meta, type, payload, index }: OperationEvents["operation:update:parameter"]) => void;
|
|
156
122
|
/**
|
|
157
123
|
* Removes a parameter from the operation by resolving its position within
|
|
158
124
|
* the filtered list of parameters of the specified `type`.
|
|
@@ -168,12 +134,7 @@ export declare const updateOperationParameter: ({ document, meta, type, payload,
|
|
|
168
134
|
* })
|
|
169
135
|
* ```
|
|
170
136
|
*/
|
|
171
|
-
export declare const deleteOperationParameter: (
|
|
172
|
-
document: WorkspaceDocument | null;
|
|
173
|
-
type: "header" | "path" | "query" | "cookie";
|
|
174
|
-
index: number;
|
|
175
|
-
meta: OperationExampleMeta;
|
|
176
|
-
}) => void;
|
|
137
|
+
export declare const deleteOperationParameter: (document: WorkspaceDocument | null, { meta, index, type }: OperationEvents["operation:delete:parameter"]) => void;
|
|
177
138
|
/**
|
|
178
139
|
* Deletes all parameters of a given `type` from the operation.
|
|
179
140
|
* Safely no-ops if the document or operation does not exist.
|
|
@@ -187,11 +148,7 @@ export declare const deleteOperationParameter: ({ document, meta, index, type, }
|
|
|
187
148
|
* })
|
|
188
149
|
* ```
|
|
189
150
|
*/
|
|
190
|
-
export declare const deleteAllOperationParameters: (
|
|
191
|
-
document: WorkspaceDocument | null;
|
|
192
|
-
type: "header" | "path" | "query" | "cookie";
|
|
193
|
-
meta: OperationMeta;
|
|
194
|
-
}) => void;
|
|
151
|
+
export declare const deleteAllOperationParameters: (document: WorkspaceDocument | null, { meta, type }: OperationEvents["operation:delete-all:parameters"]) => void;
|
|
195
152
|
/** ------------------------------------------------------------------------------------------------
|
|
196
153
|
* Operation Request Body Mutators
|
|
197
154
|
* ------------------------------------------------------------------------------------------------ */
|
|
@@ -209,13 +166,7 @@ export declare const deleteAllOperationParameters: ({ document, meta, type, }: {
|
|
|
209
166
|
* })
|
|
210
167
|
* ```
|
|
211
168
|
*/
|
|
212
|
-
export declare const updateOperationRequestBodyContentType: (
|
|
213
|
-
document: WorkspaceDocument | null;
|
|
214
|
-
payload: {
|
|
215
|
-
contentType: string;
|
|
216
|
-
};
|
|
217
|
-
meta: OperationExampleMeta;
|
|
218
|
-
}) => void;
|
|
169
|
+
export declare const updateOperationRequestBodyContentType: (document: WorkspaceDocument | null, { meta, payload }: OperationEvents["operation:update:requestBody:contentType"]) => void;
|
|
219
170
|
/**
|
|
220
171
|
* Creates or updates a concrete example value for a specific request-body
|
|
221
172
|
* `contentType` and `exampleKey`. Safely no-ops if the document or operation
|
|
@@ -231,14 +182,7 @@ export declare const updateOperationRequestBodyContentType: ({ document, meta, p
|
|
|
231
182
|
* })
|
|
232
183
|
* ```
|
|
233
184
|
*/
|
|
234
|
-
export declare const updateOperationRequestBodyExample: (
|
|
235
|
-
document: WorkspaceDocument | null;
|
|
236
|
-
contentType: string;
|
|
237
|
-
payload: {
|
|
238
|
-
value: string | File | undefined;
|
|
239
|
-
};
|
|
240
|
-
meta: OperationExampleMeta;
|
|
241
|
-
}) => void;
|
|
185
|
+
export declare const updateOperationRequestBodyExample: (document: WorkspaceDocument | null, { meta, payload, contentType }: OperationEvents["operation:update:requestBody:value"]) => void;
|
|
242
186
|
/**
|
|
243
187
|
* Appends a form-data row to the request-body example identified by
|
|
244
188
|
* `contentType` and `exampleKey`. Initializes the example as an array when
|
|
@@ -254,15 +198,7 @@ export declare const updateOperationRequestBodyExample: ({ document, meta, paylo
|
|
|
254
198
|
* })
|
|
255
199
|
* ```
|
|
256
200
|
*/
|
|
257
|
-
export declare const addOperationRequestBodyFormRow: (
|
|
258
|
-
document: WorkspaceDocument | null;
|
|
259
|
-
payload: Partial<{
|
|
260
|
-
key: string;
|
|
261
|
-
value?: string | File;
|
|
262
|
-
}>;
|
|
263
|
-
contentType: string;
|
|
264
|
-
meta: OperationExampleMeta;
|
|
265
|
-
}) => void;
|
|
201
|
+
export declare const addOperationRequestBodyFormRow: (document: WorkspaceDocument | null, { meta, payload, contentType }: OperationEvents["operation:add:requestBody:formRow"]) => void;
|
|
266
202
|
/**
|
|
267
203
|
* Updates a form-data row at a given `index` for the specified example and
|
|
268
204
|
* `contentType`. Setting `payload.value` to `null` clears the value (sets to
|
|
@@ -279,16 +215,7 @@ export declare const addOperationRequestBodyFormRow: ({ document, meta, payload,
|
|
|
279
215
|
* })
|
|
280
216
|
* ```
|
|
281
217
|
*/
|
|
282
|
-
export declare const updateOperationRequestBodyFormRow: (
|
|
283
|
-
document: WorkspaceDocument | null;
|
|
284
|
-
index: number;
|
|
285
|
-
payload: Partial<{
|
|
286
|
-
key: string;
|
|
287
|
-
value: string | File | null;
|
|
288
|
-
}>;
|
|
289
|
-
contentType: string;
|
|
290
|
-
meta: OperationExampleMeta;
|
|
291
|
-
}) => void;
|
|
218
|
+
export declare const updateOperationRequestBodyFormRow: (document: WorkspaceDocument | null, { meta, index, payload, contentType }: OperationEvents["operation:update:requestBody:formRow"]) => void;
|
|
292
219
|
/**
|
|
293
220
|
* Deletes a form-data row at a given `index` from the example for the given
|
|
294
221
|
* `contentType`. If the example becomes empty, the example entry is removed.
|
|
@@ -304,10 +231,5 @@ export declare const updateOperationRequestBodyFormRow: ({ document, meta, index
|
|
|
304
231
|
* })
|
|
305
232
|
* ```
|
|
306
233
|
*/
|
|
307
|
-
export declare const deleteOperationRequestBodyFormRow: (
|
|
308
|
-
document: WorkspaceDocument | null;
|
|
309
|
-
index: number;
|
|
310
|
-
contentType: string;
|
|
311
|
-
meta: OperationExampleMeta;
|
|
312
|
-
}) => void;
|
|
234
|
+
export declare const deleteOperationRequestBodyFormRow: (document: WorkspaceDocument | null, { meta, index, contentType }: OperationEvents["operation:delete:requestBody:formRow"]) => void;
|
|
313
235
|
//# sourceMappingURL=operation.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/mutators/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAGnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;
|
|
1
|
+
{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/mutators/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAGnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAGrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAKlD;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,UAAU,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,GAAG;IACjD,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AA8GD;;sGAEsG;AAEtG;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB,GACjC,UAAU,iBAAiB,GAAG,IAAI,EAClC,gCAAgC,eAAe,CAAC,0BAA0B,CAAC,SAY5E,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,qBAAqB,GAChC,UAAU,iBAAiB,GAAG,IAAI,EAClC,+BAA+B,eAAe,CAAC,yBAAyB,CAAC,SAiB1E,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,GAC9B,UAAU,iBAAiB,GAAG,IAAI,EAClC,6BAA6B,eAAe,CAAC,uBAAuB,CAAC,SAoDtE,CAAA;AAED;;sGAEsG;AAEtG;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,qBAAqB,GAChC,UAAU,iBAAiB,GAAG,IAAI,EAClC,yBAAyB,eAAe,CAAC,yBAAyB,CAAC,SA8BpE,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,gCAAgC,eAAe,CAAC,4BAA4B,CAAC,SA8C9E,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,wBAAwB,GACnC,UAAU,iBAAiB,GAAG,IAAI,EAClC,uBAAuB,eAAe,CAAC,4BAA4B,CAAC,SAwBrE,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,4BAA4B,GACvC,UAAU,iBAAiB,GAAG,IAAI,EAClC,gBAAgB,eAAe,CAAC,iCAAiC,CAAC,SAanE,CAAA;AAED;;sGAEsG;AAEtG;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qCAAqC,GAChD,UAAU,iBAAiB,GAAG,IAAI,EAClC,mBAAmB,eAAe,CAAC,0CAA0C,CAAC,SAwB/E,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iCAAiC,GAC5C,UAAU,iBAAiB,GAAG,IAAI,EAClC,gCAAgC,eAAe,CAAC,oCAAoC,CAAC,SAuCtF,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,8BAA8B,GACzC,UAAU,iBAAiB,GAAG,IAAI,EAClC,gCAAgC,eAAe,CAAC,mCAAmC,CAAC,SAqDrF,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,iCAAiC,GAC5C,UAAU,iBAAiB,GAAG,IAAI,EAClC,uCAAuC,eAAe,CAAC,sCAAsC,CAAC,SAqC/F,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iCAAiC,GAC5C,UAAU,iBAAiB,GAAG,IAAI,EAClC,8BAA8B,eAAe,CAAC,sCAAsC,CAAC,SAmCtF,CAAA"}
|