@scalar/oas-utils 0.19.9 → 0.19.10
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
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# @scalar/oas-utils
|
|
2
2
|
|
|
3
|
+
## 0.19.10
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#9793](https://github.com/scalar/scalar/pull/9793): Expose `server` and `customFetch` in the ClientPlugin `beforeRequest` hook
|
|
8
|
+
payload (both optional, additive) so plugins can resolve relative URLs and run
|
|
9
|
+
network calls — e.g. a token refresh — through the host fetch without closing
|
|
10
|
+
over external state.
|
|
11
|
+
|
|
3
12
|
## 0.19.9
|
|
4
13
|
|
|
5
14
|
## 0.19.8
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { AnyEventListener, ApiReferenceEvents, WorkspaceEventBus } from '@scalar/workspace-store/events';
|
|
2
2
|
import type { RequestFactory, VariablesStore } from '@scalar/workspace-store/request-example';
|
|
3
|
-
import type { OpenApiDocument } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
|
|
3
|
+
import type { OpenApiDocument, ServerObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
|
|
4
4
|
import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
|
|
5
5
|
import type { Component, DefineComponent } from 'vue';
|
|
6
6
|
/** Shared fields present on every response body handler variant */
|
|
@@ -45,9 +45,9 @@ type ClientPluginHooks = {
|
|
|
45
45
|
* Runs before a request is sent. Receives the current document and operation so plugins can
|
|
46
46
|
* modify the request before it is sent (for example, adding headers or modifying the body).
|
|
47
47
|
*
|
|
48
|
-
* Mutations here happen on the request builder, before the fetch `Request` exists.
|
|
49
|
-
* `requestBuilt` hook
|
|
50
|
-
* multipart body for request signing).
|
|
48
|
+
* Mutations here happen on the request builder, before the fetch `Request` exists. Outside
|
|
49
|
+
* Electron, use the `requestBuilt` hook when you need the exact outgoing request (for example,
|
|
50
|
+
* to hash a multipart body for request signing). Electron sends the request payload instead.
|
|
51
51
|
*/
|
|
52
52
|
beforeRequest: (payload: {
|
|
53
53
|
/** Workspace-store request spec; mutable by pre-request scripts (headers, method). */
|
|
@@ -55,16 +55,19 @@ type ClientPluginHooks = {
|
|
|
55
55
|
document: OpenApiDocument;
|
|
56
56
|
operation: OperationObject;
|
|
57
57
|
variablesStore?: VariablesStore;
|
|
58
|
+
/** Active server, so plugins can resolve relative URLs (e.g. a token endpoint). */
|
|
59
|
+
server?: ServerObject | null;
|
|
60
|
+
/** Host fetch, so plugins can run network calls (e.g. a token refresh) through the same channel as the request. */
|
|
61
|
+
customFetch?: typeof fetch;
|
|
58
62
|
}) => void | Promise<void>;
|
|
59
63
|
/**
|
|
60
|
-
* Runs after the fetch `Request` has been built, right before it is sent.
|
|
61
|
-
* here is
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
* have no effect at this stage; use the `beforeRequest` hook for those.
|
|
64
|
+
* Runs after the fetch `Request` has been built, right before it is sent. Outside Electron, the
|
|
65
|
+
* request passed here is handed to fetch, so header mutations apply to the outgoing request and
|
|
66
|
+
* the body bytes match what goes over the wire. Electron sends the request payload instead.
|
|
67
|
+
* Mutations to the request builder have no effect at this stage; use `beforeRequest` for those.
|
|
65
68
|
*/
|
|
66
69
|
requestBuilt: (payload: {
|
|
67
|
-
/** The
|
|
70
|
+
/** The fetch Request built before sending. Electron sends the request payload instead. */
|
|
68
71
|
request: Request;
|
|
69
72
|
/** Request builder the request was built from. Mutating it has no effect at this stage. */
|
|
70
73
|
requestBuilder: RequestFactory;
|
|
@@ -80,7 +83,7 @@ type ClientPluginHooks = {
|
|
|
80
83
|
response: Response;
|
|
81
84
|
/** Request builder object that was used to build the request. Mutating this object will not affect the request object. */
|
|
82
85
|
requestBuilder: RequestFactory;
|
|
83
|
-
/** Request
|
|
86
|
+
/** Request rebuilt from the sent request payload, not the same instance sent to the server. */
|
|
84
87
|
request: Request;
|
|
85
88
|
document: OpenApiDocument;
|
|
86
89
|
operation: OperationObject;
|
|
@@ -147,14 +150,18 @@ type ClientPluginComponents = {
|
|
|
147
150
|
*
|
|
148
151
|
* const myPlugin: ClientPlugin = {
|
|
149
152
|
* hooks: {
|
|
150
|
-
* beforeRequest: ({
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
+
* beforeRequest: async ({ requestBuilder, server, customFetch }) => {
|
|
154
|
+
* console.log('Active server configuration:', server?.url);
|
|
155
|
+
*
|
|
156
|
+
* if (customFetch) {
|
|
157
|
+
* await customFetch('https://auth.example.com/session/refresh', { method: 'POST' });
|
|
158
|
+
* }
|
|
159
|
+
*
|
|
160
|
+
* requestBuilder.headers.set('X-Custom-Header', 'foo');
|
|
153
161
|
* },
|
|
154
|
-
* responseReceived:
|
|
162
|
+
* responseReceived: ({ response, operation }) => {
|
|
155
163
|
* // Handle post-response logic
|
|
156
|
-
*
|
|
157
|
-
* console.log('Received:', data, 'for operation:', operation.operationId);
|
|
164
|
+
* console.log('Received status:', response.status, 'for operation:', operation.operationId);
|
|
158
165
|
* }
|
|
159
166
|
* },
|
|
160
167
|
* components: {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client-plugins.d.ts","sourceRoot":"","sources":["../../src/helpers/client-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAC7G,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAA;AAC7F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;
|
|
1
|
+
{"version":3,"file":"client-plugins.d.ts","sourceRoot":"","sources":["../../src/helpers/client-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAC7G,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAA;AAC7F,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,8DAA8D,CAAA;AACjH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,KAAK,CAAA;AAErD,mEAAmE;AACnE,KAAK,uBAAuB,GAAG;IAC7B,4FAA4F;IAC5F,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,gEAAgE;IAChE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAC7F,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,GAAG,uBAAuB,GACvD,CAAC;IAAE,YAAY,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,YAAY,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAE/F,oEAAoE;AACpE,KAAK,iBAAiB,GAAG;IACvB;;;;;OAKG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE;QAAE,QAAQ,EAAE,eAAe,CAAC;QAAC,SAAS,EAAE,eAAe,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC5G;;;;;;;OAOG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE;QACvB,sFAAsF;QACtF,cAAc,EAAE,cAAc,CAAA;QAC9B,QAAQ,EAAE,eAAe,CAAA;QACzB,SAAS,EAAE,eAAe,CAAA;QAC1B,cAAc,CAAC,EAAE,cAAc,CAAA;QAC/B,mFAAmF;QACnF,MAAM,CAAC,EAAE,YAAY,GAAG,IAAI,CAAA;QAC5B,mHAAmH;QACnH,WAAW,CAAC,EAAE,OAAO,KAAK,CAAA;KAC3B,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B;;;;;OAKG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE;QACtB,0FAA0F;QAC1F,OAAO,EAAE,OAAO,CAAA;QAChB,2FAA2F;QAC3F,cAAc,EAAE,cAAc,CAAA;QAC9B,QAAQ,EAAE,eAAe,CAAA;QACzB,SAAS,EAAE,eAAe,CAAA;QAC1B,cAAc,CAAC,EAAE,cAAc,CAAA;KAChC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B;;;OAGG;IACH,gBAAgB,EAAE,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,QAAQ,CAAA;QAClB,0HAA0H;QAC1H,cAAc,EAAE,cAAc,CAAA;QAC9B,+FAA+F;QAC/F,OAAO,EAAE,OAAO,CAAA;QAChB,QAAQ,EAAE,eAAe,CAAA;QACzB,SAAS,EAAE,eAAe,CAAA;QAC1B,cAAc,CAAC,EAAE,cAAc,CAAA;KAChC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B,CAAA;AAED,6CAA6C;AAC7C,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,UAAU,CAAA;AAE7D,kDAAkD;AAClD,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAA;AAE5D,0DAA0D;AAC1D,MAAM,MAAM,oBAAoB,GAAG;IACjC,SAAS,EAAE,uBAAuB,CAAA;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,GAAG,WAAW,CAAA;IAC1B,MAAM,EAAE,kBAAkB,CAAA;CAC3B,CAAA;AAED,sDAAsD;AACtD,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,8EAA8E;IAC9E,aAAa,EAAE,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IACnF,uEAAuE;IACvE,kBAAkB,EAAE,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,oBAAoB,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACtF,iEAAiE;IACjE,gBAAgB,EAAE,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,wBAAwB,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACxF,CAAA;AAED,wDAAwD;AACxD,KAAK,qBAAqB,CACxB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC,GAAG,EAAE,IACzD;IACF,SAAS,EAAE,eAAe,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;IAChE,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,KAAK,sBAAsB,GAAG;IAC5B,OAAO,EAAE,qBAAqB,CAC5B;QACE,SAAS,CAAC,EAAE,eAAe,CAAA;KAG5B,EACD;QACE,4BAA4B,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,4BAA4B,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,CAAA;KAC7G,CACF,CAAA;IACD,QAAQ,EAAE,qBAAqB,CAAC;QAG9B,SAAS,CAAC,EAAE,eAAe,CAAA;KAC5B,CAAC,CAAA;CACH,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,+EAA+E;AAC/E,KAAK,qBAAqB,GAAG;IAC3B,gDAAgD;IAChD,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IAChE,uDAAuD;IACvD,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IACvE,8CAA8C;IAC9C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAClC,+DAA+D;IAC/D,cAAc,CAAC,EAAE,OAAO,CAAC,0BAA0B,CAAC,CAAA;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAC5C,6CAA6C;IAC7C,SAAS,CAAC,EAAE,qBAAqB,CAAA;IACjC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,CAAC,EAAE,gBAAgB,CAAA;IACrB,+DAA+D;IAC/D,YAAY,CAAC,EAAE,mBAAmB,EAAE,CAAA;CACrC,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,qBAAqB,GAAI,UAAU,iBAAiB,EAAE,QAAQ,YAAY,KAAG,CAAC,MAAM,IAAI,CAQpG,CAAA;AAED;;;;GAIG;AACH,KAAK,cAAc,GAAG;KACnB,CAAC,IAAI,MAAM,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAU,CAAC,SAAS,MAAM,cAAc,EAC9D,SAAS,cAAc,CAAC,CAAC,CAAC,EAC1B,UAAU,CAAC,EACX,SAAS,YAAY,EAAE,KACtB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAY3B,CAAA;AAED,KAAK,uBAAuB,GAAG;KAC5B,CAAC,IAAI,MAAM,0BAA0B,GAAG,UAAU,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACtF,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,GAAU,CAAC,SAAS,MAAM,uBAAuB,EAChF,SAAS,uBAAuB,CAAC,CAAC,CAAC,EACnC,UAAU,CAAC,EACX,SAAS,YAAY,EAAE,KACtB,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAcpC,CAAA"}
|
package/package.json
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"specification",
|
|
17
17
|
"yaml"
|
|
18
18
|
],
|
|
19
|
-
"version": "0.19.
|
|
19
|
+
"version": "0.19.10",
|
|
20
20
|
"engines": {
|
|
21
21
|
"node": ">=22"
|
|
22
22
|
},
|
|
@@ -41,18 +41,18 @@
|
|
|
41
41
|
],
|
|
42
42
|
"dependencies": {
|
|
43
43
|
"flatted": "^3.4.0",
|
|
44
|
-
"vue": "^3.5.
|
|
45
|
-
"yaml": "^2.
|
|
46
|
-
"@scalar/
|
|
44
|
+
"vue": "^3.5.40",
|
|
45
|
+
"yaml": "^2.9.0",
|
|
46
|
+
"@scalar/types": "0.17.1",
|
|
47
47
|
"@scalar/themes": "0.17.2",
|
|
48
|
-
"@scalar/
|
|
49
|
-
"@scalar/workspace-store": "0.56.
|
|
48
|
+
"@scalar/helpers": "0.10.0",
|
|
49
|
+
"@scalar/workspace-store": "0.56.1"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@types/node": "^24.1.0",
|
|
53
53
|
"fake-indexeddb": "6.2.3",
|
|
54
|
-
"vite": "8.
|
|
55
|
-
"vitest": "4.1.
|
|
54
|
+
"vite": "8.1.5",
|
|
55
|
+
"vitest": "4.1.10"
|
|
56
56
|
},
|
|
57
57
|
"scripts": {
|
|
58
58
|
"build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
|