@scalar/api-client 2.3.34 → 2.4.1
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 +57 -0
- package/dist/components/CodeInput/CodeInput.vue.js +2 -2
- package/dist/components/CodeInput/CodeInput.vue2.js +1 -1
- package/dist/components/CommandPalette/CommandPaletteImport.vue.d.ts.map +1 -1
- package/dist/components/CommandPalette/CommandPaletteImport.vue.js +74 -89
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +4 -0
- package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
- package/dist/components/Server/ServerVariablesForm.vue.d.ts +2 -0
- package/dist/components/Server/ServerVariablesForm.vue.d.ts.map +1 -1
- package/dist/components/Server/ServerVariablesForm.vue.js +19 -18
- package/dist/components/TopNav/TopNavItem.vue.d.ts.map +1 -1
- package/dist/components/TopNav/TopNavItem.vue.js +3 -3
- package/dist/components/TopNav/TopNavItem.vue2.js +46 -54
- package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +1 -1
- package/dist/hooks/useClientConfig.d.ts +72 -6
- package/dist/hooks/useClientConfig.d.ts.map +1 -1
- package/dist/layouts/App/ApiClientApp.vue.d.ts +1 -1
- package/dist/layouts/App/ApiClientApp.vue.d.ts.map +1 -1
- package/dist/layouts/App/ApiClientApp.vue.js +45 -40
- package/dist/layouts/App/create-api-client-app.d.ts +72 -52
- package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
- package/dist/layouts/Modal/create-api-client-modal.d.ts +144 -104
- package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
- package/dist/layouts/Web/ApiClientWeb.vue.d.ts.map +1 -1
- package/dist/layouts/Web/ApiClientWeb.vue.js +49 -44
- package/dist/layouts/Web/create-api-client-web.d.ts +72 -52
- package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
- package/dist/libs/create-client.d.ts +72 -52
- package/dist/libs/create-client.d.ts.map +1 -1
- package/dist/libs/create-client.js +53 -49
- package/dist/libs/electron.d.ts +5 -0
- package/dist/libs/electron.d.ts.map +1 -0
- package/dist/libs/electron.js +4 -0
- package/dist/libs/find-request.d.ts +2 -0
- package/dist/libs/find-request.d.ts.map +1 -1
- package/dist/libs/send-request/create-fetch-query-params.d.ts +10 -3
- package/dist/libs/send-request/create-fetch-query-params.d.ts.map +1 -1
- package/dist/libs/send-request/create-fetch-query-params.js +28 -6
- package/dist/libs/send-request/create-request-operation.d.ts +3 -1
- package/dist/libs/send-request/create-request-operation.d.ts.map +1 -1
- package/dist/libs/send-request/create-request-operation.js +91 -87
- package/dist/libs/send-request/create-request-operation.test.d.ts +2 -0
- package/dist/libs/send-request/create-request-operation.test.d.ts.map +1 -1
- package/dist/plugins/hooks/usePluginManager.d.ts +8 -0
- package/dist/plugins/hooks/usePluginManager.d.ts.map +1 -0
- package/dist/plugins/hooks/usePluginManager.js +10 -0
- package/dist/plugins/index.d.ts +3 -0
- package/dist/plugins/index.d.ts.map +1 -0
- package/dist/plugins/index.js +7 -0
- package/dist/plugins/plugin-manager.d.ts +28 -0
- package/dist/plugins/plugin-manager.d.ts.map +1 -0
- package/dist/plugins/plugin-manager.js +24 -0
- package/dist/store/active-entities.d.ts +2 -0
- package/dist/store/active-entities.d.ts.map +1 -1
- package/dist/store/collections.d.ts +4 -4
- package/dist/store/cookies.d.ts +4 -4
- package/dist/store/environment.d.ts +4 -4
- package/dist/store/request-example.d.ts +4 -4
- package/dist/store/requests.d.ts +26 -4
- package/dist/store/requests.d.ts.map +1 -1
- package/dist/store/security-schemes.d.ts +24 -24
- package/dist/store/store.d.ts +72 -52
- package/dist/store/store.d.ts.map +1 -1
- package/dist/store/tags.d.ts +4 -4
- package/dist/store/workspace.d.ts +4 -4
- package/dist/style.css +1 -1
- package/dist/views/Request/Request.vue.d.ts.map +1 -1
- package/dist/views/Request/Request.vue.js +2 -2
- package/dist/views/Request/RequestRoot.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestRoot.vue.js +1 -1
- package/dist/views/Request/RequestRoot.vue2.js +47 -45
- package/dist/views/Request/RequestSection/RequestParams.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestParams.vue.js +61 -70
- package/dist/views/Request/RequestSection/RequestSection.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestSection.vue.js +2 -2
- package/dist/views/Request/RequestSection/RequestSection.vue2.js +92 -77
- 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 +59 -65
- package/dist/views/Request/RequestSection/RequestTableTooltip.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSection/RequestTableTooltip.vue.js +1 -1
- package/dist/views/Request/RequestSection/RequestTableTooltip.vue2.js +34 -35
- package/dist/views/Request/RequestSection/types/post-response.d.ts +7 -0
- package/dist/views/Request/RequestSection/types/post-response.d.ts.map +1 -0
- package/dist/views/Request/RequestSidebarItem.vue.d.ts.map +1 -1
- package/dist/views/Request/RequestSidebarItem.vue.js +3 -3
- package/dist/views/Request/RequestSidebarItem.vue2.js +132 -134
- package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseSection.vue.d.ts.map +1 -1
- package/dist/views/Request/ResponseSection/ResponseSection.vue.js +1 -1
- package/dist/views/Request/ResponseSection/ResponseSection.vue2.js +82 -70
- package/dist/views/Request/components/WorkspaceDropdown.vue.d.ts.map +1 -1
- package/dist/views/Request/components/WorkspaceDropdown.vue.js +80 -114
- package/package.json +25 -20
|
@@ -1,122 +1,126 @@
|
|
|
1
|
-
import { ERRORS as
|
|
2
|
-
import { normalizeHeaders as
|
|
3
|
-
import { createFetchBody as
|
|
4
|
-
import { createFetchHeaders as
|
|
5
|
-
import { createFetchQueryParams as
|
|
6
|
-
import { decodeBuffer as
|
|
7
|
-
import { setRequestCookies as
|
|
8
|
-
import { replaceTemplateVariables as
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
1
|
+
import { ERRORS as P, normalizeError as U } from "../errors.js";
|
|
2
|
+
import { normalizeHeaders as G } from "../normalize-headers.js";
|
|
3
|
+
import { createFetchBody as J } from "./create-fetch-body.js";
|
|
4
|
+
import { createFetchHeaders as N } from "./create-fetch-headers.js";
|
|
5
|
+
import { createFetchQueryParams as Z } from "./create-fetch-query-params.js";
|
|
6
|
+
import { decodeBuffer as $ } from "./decode-buffer.js";
|
|
7
|
+
import { setRequestCookies as M, getCookieHeader as ee } from "./set-request-cookies.js";
|
|
8
|
+
import { replaceTemplateVariables as d } from "../string-template.js";
|
|
9
|
+
import { isElectron as oe } from "../electron.js";
|
|
10
|
+
import { isDefined as te, mergeUrls as re, shouldUseProxy as q, redirectToProxy as se, httpStatusCodes as ne } from "@scalar/oas-utils/helpers";
|
|
11
|
+
import { buildRequestSecurity as ae } from "./build-request-security.js";
|
|
12
|
+
const Re = ({
|
|
13
|
+
environment: D,
|
|
14
|
+
example: a,
|
|
15
|
+
globalCookies: E,
|
|
16
|
+
proxyUrl: l,
|
|
17
|
+
request: i,
|
|
18
|
+
securitySchemes: L,
|
|
19
|
+
selectedSecuritySchemeUids: z = [],
|
|
20
|
+
server: c,
|
|
21
|
+
status: o,
|
|
22
|
+
pluginManager: u
|
|
21
23
|
}) => {
|
|
22
24
|
try {
|
|
23
|
-
const t =
|
|
24
|
-
let
|
|
25
|
-
if (!
|
|
26
|
-
throw
|
|
27
|
-
Object.entries((
|
|
28
|
-
|
|
29
|
-
[
|
|
25
|
+
const t = D ?? {}, S = new AbortController(), w = a.parameters.path.reduce((e, s) => (s.enabled && (e[s.key] = d(s.value, t)), e), {}), B = d((c == null ? void 0 : c.url) ?? "", t), f = d(d(i.path, t), w);
|
|
26
|
+
let n = B || f;
|
|
27
|
+
if (!n)
|
|
28
|
+
throw P.URL_EMPTY;
|
|
29
|
+
Object.entries((c == null ? void 0 : c.variables) ?? {}).forEach(([e, s]) => {
|
|
30
|
+
n = d(n, {
|
|
31
|
+
[e]: w[e] || s.default
|
|
30
32
|
});
|
|
31
33
|
});
|
|
32
|
-
const
|
|
33
|
-
example:
|
|
34
|
+
const F = Z(a, t, i), _ = N(a, t), { body: O } = J(i.method, a, t), { cookieParams: W } = M({
|
|
35
|
+
example: a,
|
|
34
36
|
env: t,
|
|
35
|
-
globalCookies:
|
|
36
|
-
serverUrl:
|
|
37
|
-
proxyUrl:
|
|
38
|
-
}),
|
|
39
|
-
(
|
|
37
|
+
globalCookies: E,
|
|
38
|
+
serverUrl: n,
|
|
39
|
+
proxyUrl: l
|
|
40
|
+
}), x = z.flat().map((e) => L[e]).filter(te), b = ae(x, t), p = { ...Object.entries(b.headers).reduce(
|
|
41
|
+
(e, [s, y]) => (e[s.toLowerCase()] = y, e),
|
|
40
42
|
{}
|
|
41
|
-
), ...
|
|
42
|
-
|
|
43
|
-
const
|
|
44
|
-
|
|
43
|
+
), ..._ }, j = [...W, ...b.cookies], A = new URLSearchParams([...F, ...b.urlParams]);
|
|
44
|
+
n = re(n, f, A);
|
|
45
|
+
const k = d(ee(j, p.Cookie), t);
|
|
46
|
+
k && (oe() || q(l, n) ? (console.warn(
|
|
45
47
|
"We’re using a `X-Scalar-Cookie` custom header to the request. The proxy will forward this as a `Cookie` header. We do this to avoid the browser omitting the `Cookie` header for cross-origin requests for security reasons."
|
|
46
|
-
),
|
|
48
|
+
), p["X-Scalar-Cookie"] = k) : (console.warn(
|
|
47
49
|
`We’re trying to add a Cookie header, but browsers often omit them for cross-origin requests for various security reasons. If it’s not working, that’s probably why. Here are the requirements for it to work:
|
|
48
50
|
|
|
49
51
|
- The browser URL must be on the same domain as the server URL.
|
|
50
52
|
- The connection must be made over HTTPS.
|
|
51
53
|
`
|
|
52
|
-
),
|
|
53
|
-
const
|
|
54
|
-
method:
|
|
55
|
-
body:
|
|
56
|
-
headers:
|
|
54
|
+
), p.Cookie = k));
|
|
55
|
+
const I = se(l, n), R = new Request(I, {
|
|
56
|
+
method: i.method.toUpperCase(),
|
|
57
|
+
body: O ?? null,
|
|
58
|
+
headers: p
|
|
57
59
|
});
|
|
58
60
|
return [
|
|
59
61
|
null,
|
|
60
62
|
{
|
|
61
|
-
request:
|
|
63
|
+
request: R,
|
|
62
64
|
sendRequest: async () => {
|
|
63
|
-
var
|
|
64
|
-
|
|
65
|
-
const
|
|
65
|
+
var s, y, C;
|
|
66
|
+
o == null || o.emit("start"), u && u.executeHook("onBeforeRequest");
|
|
67
|
+
const e = Date.now();
|
|
66
68
|
try {
|
|
67
|
-
const
|
|
68
|
-
signal:
|
|
69
|
-
}),
|
|
70
|
-
|
|
71
|
-
const
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
69
|
+
const r = await fetch(R, {
|
|
70
|
+
signal: S.signal
|
|
71
|
+
}), Q = (s = r.headers.get("content-type")) == null ? void 0 : s.startsWith("text/event-stream");
|
|
72
|
+
o == null || o.emit("stop");
|
|
73
|
+
const V = Date.now() - e, X = r.clone(), T = G(r.headers, q(l, n)), v = r.headers.get("content-type") ?? "text/plain;charset=UTF-8", g = await X.arrayBuffer(), K = $(g, v), m = r.clone(), Y = m.statusText || ((y = ne[m.status]) == null ? void 0 : y.name) || "", h = new Response(m.body, {
|
|
74
|
+
status: m.status,
|
|
75
|
+
statusText: Y,
|
|
76
|
+
headers: m.headers
|
|
77
|
+
});
|
|
78
|
+
u && u.executeHook("onResponseReceived", { response: h, operation: i });
|
|
79
|
+
const H = "getSetCookie" in h.headers && typeof h.headers.getSetCookie == "function" ? h.headers.getSetCookie() : [];
|
|
80
|
+
return Q && r.body ? [
|
|
81
|
+
null,
|
|
82
|
+
{
|
|
83
|
+
timestamp: Date.now(),
|
|
84
|
+
request: a,
|
|
85
|
+
response: {
|
|
86
|
+
...h,
|
|
87
|
+
headers: T,
|
|
88
|
+
cookieHeaderKeys: H,
|
|
89
|
+
reader: (C = r.body) == null ? void 0 : C.getReader(),
|
|
90
|
+
duration: V,
|
|
91
|
+
method: i.method,
|
|
92
|
+
path: f
|
|
88
93
|
}
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
return [
|
|
94
|
+
}
|
|
95
|
+
] : [
|
|
92
96
|
null,
|
|
93
97
|
{
|
|
94
98
|
timestamp: Date.now(),
|
|
95
|
-
request:
|
|
99
|
+
request: a,
|
|
96
100
|
response: {
|
|
97
|
-
...
|
|
98
|
-
headers:
|
|
99
|
-
cookieHeaderKeys:
|
|
100
|
-
data:
|
|
101
|
-
size:
|
|
102
|
-
duration: Date.now() -
|
|
103
|
-
method:
|
|
104
|
-
status:
|
|
105
|
-
path:
|
|
101
|
+
...r,
|
|
102
|
+
headers: T,
|
|
103
|
+
cookieHeaderKeys: H,
|
|
104
|
+
data: K,
|
|
105
|
+
size: g.byteLength,
|
|
106
|
+
duration: Date.now() - e,
|
|
107
|
+
method: i.method,
|
|
108
|
+
status: r.status,
|
|
109
|
+
path: f
|
|
106
110
|
}
|
|
107
111
|
}
|
|
108
112
|
];
|
|
109
|
-
} catch (
|
|
110
|
-
return
|
|
113
|
+
} catch (r) {
|
|
114
|
+
return o == null || o.emit("abort"), [U(r, P.REQUEST_FAILED), null];
|
|
111
115
|
}
|
|
112
116
|
},
|
|
113
|
-
controller:
|
|
117
|
+
controller: S
|
|
114
118
|
}
|
|
115
119
|
];
|
|
116
120
|
} catch (t) {
|
|
117
|
-
return console.error(t),
|
|
121
|
+
return console.error(t), o == null || o.emit("abort"), [U(t), null];
|
|
118
122
|
}
|
|
119
123
|
};
|
|
120
124
|
export {
|
|
121
|
-
|
|
125
|
+
Re as createRequestOperation
|
|
122
126
|
};
|
|
@@ -47,10 +47,12 @@ export declare const createRequestPayload: (metaRequestPayload?: MetaRequestPayl
|
|
|
47
47
|
schema?: unknown;
|
|
48
48
|
content?: unknown;
|
|
49
49
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
50
|
+
explode?: boolean | undefined;
|
|
50
51
|
}[] | undefined;
|
|
51
52
|
requestBody?: any;
|
|
52
53
|
responses?: Record<string, any> | undefined;
|
|
53
54
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
55
|
+
'x-post-response'?: string | undefined;
|
|
54
56
|
'x-codeSamples'?: {
|
|
55
57
|
source: string;
|
|
56
58
|
label?: string | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"create-request-operation.test.d.ts","sourceRoot":"","sources":["../../../src/libs/send-request/create-request-operation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,aAAa,EAElB,oBAAoB,EAIrB,MAAM,iCAAiC,CAAA;AAExC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAS5B,eAAO,MAAM,QAAQ,0BAAkC,CAAA;AAEvD,KAAK,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE,KAAK,kBAAkB,GAAG;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,qBAAqB,CAAC,EAAE,qBAAqB,CAAA;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,qDAAqD;AACrD,eAAO,MAAM,oBAAoB,wBAAwB,kBAAkB;;;
|
|
1
|
+
{"version":3,"file":"create-request-operation.test.d.ts","sourceRoot":"","sources":["../../../src/libs/send-request/create-request-operation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,aAAa,EAElB,oBAAoB,EAIrB,MAAM,iCAAiC,CAAA;AAExC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAS5B,eAAO,MAAM,QAAQ,0BAAkC,CAAA;AAEvD,KAAK,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAEjE,KAAK,kBAAkB,GAAG;IACxB,aAAa,CAAC,EAAE,aAAa,CAAA;IAC7B,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,qBAAqB,CAAC,EAAE,qBAAqB,CAAA;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,qDAAqD;AACrD,eAAO,MAAM,oBAAoB,wBAAwB,kBAAkB;;;sBAg+B7D,EAAE,KAAK;;;+CAEqD,EAAG,KAC7E,gCAA+B,EAAG,KAAK;qCAIJ,EAAG,KAAK;2BACR,EAAG,KAAK;4BAC3B,EAAG,KAAK;;;;;;uBAQH,CAAC;;;;;;;;;;;;;uBAiBR,CAAC;mBAGP,CADR;oBAA2B,CAAC;qBAClB,CAAC;uBAGH,CAFR;6BAC8C,CAAC;;kBAErC,CAAR;mBAA0B,CAAC;iBACN,CAAC;mBAEK,CAAC;;;;;;;;iBAatB,CAAN;gBAAkC,CAAC;;;;iBAEE,CAAC;gBAIhC,CAAL;;;;iBAIsD,CAAC;gBAE3C,CAAC;;;;;;sBA0B+kT,EAAG,KAAK;;;;;kBAAwI,CAAC;oBAAoC,CAAC;;;;;2BAA8I,CAAC;wBAA0C,CAAC;2BAAwD,CAAC;+BAAiD,CAAC;2BAA6C,CAAC;4BAA+B,CAAC;wBAA2C,CAAC;0BAA8C,CAAC;4BAA8C,CAAC;wBAAyC,CAAC;4BAA+B,CAAC;;;;eAA4H,CAAC;;;wBAA2I,CAAC;;;;;;;;uBAA2L,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA0J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;+BAAqE,EAAG,KAAK;;;;sBAj1Bx0Z,EAAG,KAAK;;;;iBAI/C,CAAC;uBAEE,CAAC;mBAAqC,CAAC;gBAExD,CAAF;;;;;CA/NH,CAAA"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { type PluginManager } from '../../plugins/plugin-manager';
|
|
2
|
+
import { type InjectionKey } from 'vue';
|
|
3
|
+
export declare const PLUGIN_MANAGER_SYMBOL: InjectionKey<PluginManager>;
|
|
4
|
+
/**
|
|
5
|
+
* Hook to access the plugin manager
|
|
6
|
+
*/
|
|
7
|
+
export declare const usePluginManager: () => PluginManager;
|
|
8
|
+
//# sourceMappingURL=usePluginManager.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usePluginManager.d.ts","sourceRoot":"","sources":["../../../src/plugins/hooks/usePluginManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAuB,MAAM,0BAA0B,CAAA;AAClF,OAAO,EAAE,KAAK,YAAY,EAAU,MAAM,KAAK,CAAA;AAE/C,eAAO,MAAM,qBAAqB,EAAe,YAAY,CAAC,aAAa,CAAC,CAAA;AAE5E;;GAEG;AACH,eAAO,MAAM,gBAAgB,QAAO,aASnC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,KAAK,eAAe,EACpB,KAAK,aAAa,GACnB,MAAM,kBAAkB,CAAA;AAEzB,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { ApiClientPlugin } from '@scalar/types/api-client';
|
|
2
|
+
import type { InjectionKey } from 'vue';
|
|
3
|
+
export type { ApiClientPlugin };
|
|
4
|
+
type CreatePluginManagerParams = {
|
|
5
|
+
plugins?: ApiClientPlugin[];
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* Create the plugin manager store
|
|
9
|
+
*
|
|
10
|
+
* This store manages all plugins registered with the API client
|
|
11
|
+
*/
|
|
12
|
+
export declare const createPluginManager: ({ plugins }: CreatePluginManagerParams) => {
|
|
13
|
+
/**
|
|
14
|
+
* Get all components for a specific view
|
|
15
|
+
*/
|
|
16
|
+
getViewComponents: (view: keyof ReturnType<ApiClientPlugin>["views"]) => {
|
|
17
|
+
title?: string | undefined;
|
|
18
|
+
component?: unknown;
|
|
19
|
+
props?: Record<string, any> | undefined;
|
|
20
|
+
}[];
|
|
21
|
+
/**
|
|
22
|
+
* Execute a hook for a specific event
|
|
23
|
+
*/
|
|
24
|
+
executeHook: <E extends keyof ReturnType<ApiClientPlugin>["hooks"]>(event: E, ...args: Parameters<ReturnType<ApiClientPlugin>["hooks"][E]>) => Promise<void[]>;
|
|
25
|
+
};
|
|
26
|
+
export type PluginManager = ReturnType<typeof createPluginManager>;
|
|
27
|
+
export declare const PLUGIN_MANAGER_SYMBOL: InjectionKey<PluginManager>;
|
|
28
|
+
//# sourceMappingURL=plugin-manager.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"plugin-manager.d.ts","sourceRoot":"","sources":["../../src/plugins/plugin-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,KAAK,CAAA;AAEvC,YAAY,EAAE,eAAe,EAAE,CAAA;AAE/B,KAAK,yBAAyB,GAAG;IAC/B,OAAO,CAAC,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,gBAAsB,yBAAyB;IAU3E;;OAEG;8BACuB,MAAM,UAAU,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC;;;;;IAIpE;;OAEG;kBACW,CAAC,SAAS,MAAM,UAAU,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,SACzD,CAAC,WACC,UAAU,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;CAUjE,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAClE,eAAO,MAAM,qBAAqB,EAAe,YAAY,CAAC,aAAa,CAAC,CAAA"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
const s = ({ plugins: o = [] }) => {
|
|
2
|
+
const a = /* @__PURE__ */ new Map();
|
|
3
|
+
return o.forEach((r) => {
|
|
4
|
+
const e = r();
|
|
5
|
+
a.set(e.name, e);
|
|
6
|
+
}), {
|
|
7
|
+
/**
|
|
8
|
+
* Get all components for a specific view
|
|
9
|
+
*/
|
|
10
|
+
getViewComponents: (r) => Array.from(a.values()).flatMap((e) => e.views[r] || []),
|
|
11
|
+
/**
|
|
12
|
+
* Execute a hook for a specific event
|
|
13
|
+
*/
|
|
14
|
+
executeHook: (r, ...e) => {
|
|
15
|
+
const t = Array.from(a.values()).flatMap((n) => n.hooks[r] || []);
|
|
16
|
+
return Promise.all(
|
|
17
|
+
t.map((n) => n(...e))
|
|
18
|
+
);
|
|
19
|
+
}
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
export {
|
|
23
|
+
s as createPluginManager
|
|
24
|
+
};
|
|
@@ -223,10 +223,12 @@ export declare const createActiveEntitiesStore: ({ collections, requestExamples,
|
|
|
223
223
|
schema?: unknown;
|
|
224
224
|
content?: unknown;
|
|
225
225
|
style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
|
|
226
|
+
explode?: boolean | undefined;
|
|
226
227
|
}[] | undefined;
|
|
227
228
|
requestBody?: any;
|
|
228
229
|
responses?: Record<string, any> | undefined;
|
|
229
230
|
'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
|
|
231
|
+
'x-post-response'?: string | undefined;
|
|
230
232
|
'x-codeSamples'?: {
|
|
231
233
|
source: string;
|
|
232
234
|
label?: string | undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"active-entities.d.ts","sourceRoot":"","sources":["../../src/store/active-entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAErE,OAAO,EAAE,KAAK,YAAY,EAAoB,MAAM,KAAK,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAGxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAA;AAE/D,KAAK,+BAA+B,GAAG;IACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,GAAG,CAAA;IACV,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAA;CAChC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,6EAOnC,+BAA+B;;;;;;;;;uBA8Nu+d,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;oBAAoB,CAAC;0BAAmD,CAAC;mBAAqC,CAAC;;uCAAgF,CAAC;;2BAAqD,CAAC;sBAAwC,CAAC;;;;;;;;;;;;;;;uBAAikB,CAAC;;;;;;;;;2BAAuY,CAAC;;iBAA+C,CAAC;uBAAyC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;;;;kBAA2sd,CAAC;oBAAoC,CAAC;;;;;2BAA8I,CAAC;wBAA0C,CAAC;2BAAwD,CAAC;+BAAiD,CAAC;2BAA6C,CAAC;4BAA+B,CAAC;wBAA2C,CAAC;0BAA8C,CAAC;4BAA8C,CAAC;wBAAyC,CAAC;4BAA+B,CAAC;;;;eAA4H,CAAC;;;wBAA2I,CAAC;;;;;;;;uBAA2L,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA0J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;;;;;;;;;;;;;;
|
|
1
|
+
{"version":3,"file":"active-entities.d.ts","sourceRoot":"","sources":["../../src/store/active-entities.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqB,KAAK,WAAW,EAAE,MAAM,wCAAwC,CAAA;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAClG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sCAAsC,CAAA;AAErE,OAAO,EAAE,KAAK,YAAY,EAAoB,MAAM,KAAK,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAGxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAA;AAE/D,KAAK,+BAA+B,GAAG;IACrC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACvC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACzC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,GAAG,CAAA;IACV,MAAM,EAAE,QAAQ,GAAG,YAAY,CAAA;CAChC,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,6EAOnC,+BAA+B;;;;;;;;;uBA8Nu+d,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;oBAAoB,CAAC;0BAAmD,CAAC;mBAAqC,CAAC;;uCAAgF,CAAC;;2BAAqD,CAAC;sBAAwC,CAAC;;;;;;;;;;;;;;;uBAAikB,CAAC;;;;;;;;;2BAAuY,CAAC;;iBAA+C,CAAC;uBAAyC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;;;;kBAA2sd,CAAC;oBAAoC,CAAC;;;;;2BAA8I,CAAC;wBAA0C,CAAC;2BAAwD,CAAC;+BAAiD,CAAC;2BAA6C,CAAC;4BAA+B,CAAC;wBAA2C,CAAC;0BAA8C,CAAC;4BAA8C,CAAC;wBAAyC,CAAC;4BAA+B,CAAC;;;;eAA4H,CAAC;;;wBAA2I,CAAC;;;;;;;;uBAA2L,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA0J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;uBAA4J,CAAC;oBAAsC,CAAC;uBAAoD,CAAC;2BAA6C,CAAC;uBAAyC,CAAC;wBAA2B,CAAC;oBAAuC,CAAC;sBAA0C,CAAC;wBAA0C,CAAC;oBAAqC,CAAC;wBAA2B,CAAC;;;;;;;;;;;;;;;;;;;uBAAn9d,CAAC;;;;;;;;;;;;;uBAA0c,CAAC;mBAAqC,CAAC;oBAA2B,CAAC;qBAAgD,CAAC;uBAA8B,CAAC;6BAA+C,CAAC;;kBAA4D,CAAC;mBAA0B,CAAC;iBAAwB,CAAC;mBAAyH,CAAC;;;;;;;;iBAAsR,CAAC;gBAAkC,CAAC;;;;iBAAyG,CAAC;gBAAkC,CAAC;;;;iBAA4G,CAAC;gBAAkC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;iBA/Ch/pB,CAAC;uBACH,CAAC;mBAGd,CAAA;gBAAkC,CAAC;;;;;;;;;;;;;;;;;;mBA2C4jB,CAAC;;yBAAw5B,CAAC;;;;;;;;;;;;;uBAA4gb,CAAC;mBAAqC,CAAC;0BAA4C,CAAC;mBAAqC,CAAC;oBAAoB,CAAC;mBAAqC,CAAC;qBAAuC,CAAC;;mBAA4D,CAAC;oBAAoB,CAAC;0BAAmD,CAAC;mBAAqC,CAAC;;uCAAgF,CAAC;;2BAAqD,CAAC;sBAAwC,CAAC;;;;;;;;;;;;;;;uBAAikB,CAAC;;;;;;;;;2BAAuY,CAAC;;iBAA+C,CAAC;uBAAyC,CAAC;;;uBAAuG,CAAC;mBAAqC,CAAC;;;;;;;;;;;iBA/CjuhB,CAAC;uBACH,CAAC;mBAGd,CAAA;gBAAkC,CAAC;;;;;CAuBtC,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,UAAU,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAC9E,eAAO,MAAM,sBAAsB,EAAe,YAAY,CAAC,mBAAmB,CAAC,CAAA;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,QAAO,mBAMpC,CAAA"}
|
|
@@ -188,7 +188,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
188
188
|
documentUrl?: string | undefined;
|
|
189
189
|
integration?: string | null | undefined;
|
|
190
190
|
}) => void;
|
|
191
|
-
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "
|
|
191
|
+
edit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.x-scalar-sdk-installation" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `info.x-scalar-sdk-installation.${number}` | `info.x-scalar-sdk-installation.${number}.description` | `info.x-scalar-sdk-installation.${number}.lang` | `info.x-scalar-sdk-installation.${number}.source` | `securitySchemes.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: (string & import("zod").BRAND<"collection">) | null | undefined, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
192
192
|
uid: string & import("zod").BRAND<"collection">;
|
|
193
193
|
type: "collection";
|
|
194
194
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -248,7 +248,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
248
248
|
selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
|
|
249
249
|
documentUrl?: string | undefined;
|
|
250
250
|
integration?: string | null | undefined;
|
|
251
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "
|
|
251
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
252
252
|
uid: string & import("zod").BRAND<"collection">;
|
|
253
253
|
type: "collection";
|
|
254
254
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -369,7 +369,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
369
369
|
documentUrl?: string | undefined;
|
|
370
370
|
integration?: string | null | undefined;
|
|
371
371
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
372
|
-
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "
|
|
372
|
+
untrackedEdit: <P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" | `servers.${number}` | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `requests.${number}` | `x-scalar-environments.${string}` | `children.${number}` | "info.title" | "info.summary" | "info.description" | "info.version" | "info.termsOfService" | "info.contact" | "info.license" | "info.x-scalar-sdk-installation" | "info.contact.url" | "info.contact.name" | "info.contact.email" | "info.license.url" | "info.license.name" | "info.license.identifier" | `info.x-scalar-sdk-installation.${number}` | `info.x-scalar-sdk-installation.${number}.description` | `info.x-scalar-sdk-installation.${number}.lang` | `info.x-scalar-sdk-installation.${number}.source` | `securitySchemes.${number}` | `components.${string}` | `webhooks.${string}` | `x-scalar-secrets.${string}`>(uid: string & import("zod").BRAND<"collection">, path: P, value: P extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? {
|
|
373
373
|
uid: string & import("zod").BRAND<"collection">;
|
|
374
374
|
type: "collection";
|
|
375
375
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
|
@@ -429,7 +429,7 @@ export declare function createStoreCollections(useLocalStorage: boolean): {
|
|
|
429
429
|
selectedServerUid?: (string & import("zod").BRAND<"server">) | undefined;
|
|
430
430
|
documentUrl?: string | undefined;
|
|
431
431
|
integration?: string | null | undefined;
|
|
432
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "
|
|
432
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "servers" | "tags" | "security" | "externalDocs" | "type" | "uid" | "selectedServerUid" | "selectedSecuritySchemeUids" | "requests" | "x-scalar-environments" | "children" | "openapi" | "info" | "x-scalar-icon" | "securitySchemes" | "watchMode" | "useCollectionSecurity" | "watchModeStatus" | "jsonSchemaDialect" | "components" | "webhooks" | "x-scalar-active-environment" | "x-scalar-secrets" | "documentUrl" | "integration" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
433
433
|
uid: string & import("zod").BRAND<"collection">;
|
|
434
434
|
type: "collection";
|
|
435
435
|
children: ((string & import("zod").BRAND<"tag">) | (string & import("zod").BRAND<"operation">))[];
|
package/dist/store/cookies.d.ts
CHANGED
|
@@ -23,13 +23,13 @@ export declare function createStoreCookies(useLocalStorage: boolean): {
|
|
|
23
23
|
domain?: string | undefined;
|
|
24
24
|
path?: string | undefined;
|
|
25
25
|
}) => void;
|
|
26
|
-
edit: <P extends "value" | "
|
|
26
|
+
edit: <P extends "value" | "uid" | "path" | "name" | "domain">(uid: (string & import("zod").BRAND<"cookie">) | null | undefined, path: P, value: P extends "value" | "uid" | "path" | "name" | "domain" ? {
|
|
27
27
|
uid: string & import("zod").BRAND<"cookie">;
|
|
28
28
|
name: string;
|
|
29
29
|
value: string;
|
|
30
30
|
domain?: string | undefined;
|
|
31
31
|
path?: string | undefined;
|
|
32
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "
|
|
32
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "uid" | "path" | "name" | "domain" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
33
33
|
uid: string & import("zod").BRAND<"cookie">;
|
|
34
34
|
name: string;
|
|
35
35
|
value: string;
|
|
@@ -42,13 +42,13 @@ export declare function createStoreCookies(useLocalStorage: boolean): {
|
|
|
42
42
|
domain?: string | undefined;
|
|
43
43
|
path?: string | undefined;
|
|
44
44
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
45
|
-
untrackedEdit: <P extends "value" | "
|
|
45
|
+
untrackedEdit: <P extends "value" | "uid" | "path" | "name" | "domain">(uid: string & import("zod").BRAND<"cookie">, path: P, value: P extends "value" | "uid" | "path" | "name" | "domain" ? {
|
|
46
46
|
uid: string & import("zod").BRAND<"cookie">;
|
|
47
47
|
name: string;
|
|
48
48
|
value: string;
|
|
49
49
|
domain?: string | undefined;
|
|
50
50
|
path?: string | undefined;
|
|
51
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "
|
|
51
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "uid" | "path" | "name" | "domain" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
52
52
|
uid: string & import("zod").BRAND<"cookie">;
|
|
53
53
|
name: string;
|
|
54
54
|
value: string;
|
|
@@ -25,13 +25,13 @@ export declare function createStoreEnvironments(useLocalStorage: boolean): {
|
|
|
25
25
|
color: string;
|
|
26
26
|
isDefault?: boolean | undefined;
|
|
27
27
|
}) => void;
|
|
28
|
-
edit: <P extends "value" | "
|
|
28
|
+
edit: <P extends "value" | "uid" | "name" | "color" | "isDefault">(uid: (string & import("zod").BRAND<"environment">) | null | undefined, path: P, value: P extends "value" | "uid" | "name" | "color" | "isDefault" ? {
|
|
29
29
|
uid: string & import("zod").BRAND<"environment">;
|
|
30
30
|
name: string;
|
|
31
31
|
value: string;
|
|
32
32
|
color: string;
|
|
33
33
|
isDefault?: boolean | undefined;
|
|
34
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "
|
|
34
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "uid" | "name" | "color" | "isDefault" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
35
35
|
uid: string & import("zod").BRAND<"environment">;
|
|
36
36
|
name: string;
|
|
37
37
|
value: string;
|
|
@@ -44,13 +44,13 @@ export declare function createStoreEnvironments(useLocalStorage: boolean): {
|
|
|
44
44
|
color: string;
|
|
45
45
|
isDefault?: boolean | undefined;
|
|
46
46
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
47
|
-
untrackedEdit: <P extends "value" | "
|
|
47
|
+
untrackedEdit: <P extends "value" | "uid" | "name" | "color" | "isDefault">(uid: string & import("zod").BRAND<"environment">, path: P, value: P extends "value" | "uid" | "name" | "color" | "isDefault" ? {
|
|
48
48
|
uid: string & import("zod").BRAND<"environment">;
|
|
49
49
|
name: string;
|
|
50
50
|
value: string;
|
|
51
51
|
color: string;
|
|
52
52
|
isDefault?: boolean | undefined;
|
|
53
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "
|
|
53
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "uid" | "name" | "color" | "isDefault" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
54
54
|
uid: string & import("zod").BRAND<"environment">;
|
|
55
55
|
name: string;
|
|
56
56
|
value: string;
|
|
@@ -307,7 +307,7 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
|
|
|
307
307
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
308
308
|
serverVariables?: Record<string, string[]> | undefined;
|
|
309
309
|
}) => void;
|
|
310
|
-
edit: <P extends "parameters" | "
|
|
310
|
+
edit: <P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: (string & import("zod").BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? {
|
|
311
311
|
uid: string & import("zod").BRAND<"example">;
|
|
312
312
|
name: string;
|
|
313
313
|
type: "requestExample";
|
|
@@ -407,7 +407,7 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
|
|
|
407
407
|
};
|
|
408
408
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
409
409
|
serverVariables?: Record<string, string[]> | undefined;
|
|
410
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "
|
|
410
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
411
411
|
uid: string & import("zod").BRAND<"example">;
|
|
412
412
|
name: string;
|
|
413
413
|
type: "requestExample";
|
|
@@ -608,7 +608,7 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
|
|
|
608
608
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
609
609
|
serverVariables?: Record<string, string[]> | undefined;
|
|
610
610
|
}[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
|
|
611
|
-
untrackedEdit: <P extends "parameters" | "
|
|
611
|
+
untrackedEdit: <P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.examples` | `parameters.path.${number}.required` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.default` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.minimum` | `parameters.path.${number}.maximum` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.examples.${number}.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.examples` | `parameters.query.${number}.required` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.default` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.minimum` | `parameters.query.${number}.maximum` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.examples.${number}.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.examples.${number}.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.default` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.examples.${number}.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.slice" | "body.binary.type" | "body.binary.text" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.default` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.examples.${number}.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | "body.raw.mimeType" | `serverVariables.${string}`>(uid: string & import("zod").BRAND<"example">, path: P, value: P extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? {
|
|
612
612
|
uid: string & import("zod").BRAND<"example">;
|
|
613
613
|
name: string;
|
|
614
614
|
type: "requestExample";
|
|
@@ -708,7 +708,7 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
|
|
|
708
708
|
};
|
|
709
709
|
requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
|
|
710
710
|
serverVariables?: Record<string, string[]> | undefined;
|
|
711
|
-
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "
|
|
711
|
+
}[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "uid" | "requestUid" | "name" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
|
|
712
712
|
uid: string & import("zod").BRAND<"example">;
|
|
713
713
|
name: string;
|
|
714
714
|
type: "requestExample";
|