@scalar/oas-utils 0.18.4 → 0.19.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
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# @scalar/oas-utils
|
|
2
2
|
|
|
3
|
+
## 0.19.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#9515](https://github.com/scalar/scalar/pull/9515): feat: add `requestBuilt` client plugin hook and `onRequestBuilt` configuration callback that receive the exact fetch `Request` that is sent over the wire
|
|
8
|
+
|
|
9
|
+
The hook runs after the request has been built, right before it is sent. Header mutations apply to the outgoing request and the body bytes match what the server receives, which makes request signing possible: hashing the body of a rebuilt `multipart/form-data` request would produce a different multipart boundary than the request that is actually sent.
|
|
10
|
+
|
|
11
|
+
## 0.18.5
|
|
12
|
+
|
|
3
13
|
## 0.18.4
|
|
4
14
|
|
|
5
15
|
### Patch Changes
|
|
@@ -44,6 +44,10 @@ type ClientPluginHooks = {
|
|
|
44
44
|
/**
|
|
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
|
+
*
|
|
48
|
+
* Mutations here happen on the request builder, before the fetch `Request` exists. Use the
|
|
49
|
+
* `requestBuilt` hook instead when you need the exact outgoing request (for example, to hash a
|
|
50
|
+
* multipart body for request signing).
|
|
47
51
|
*/
|
|
48
52
|
beforeRequest: (payload: {
|
|
49
53
|
/** Workspace-store request spec; mutable by pre-request scripts (headers, method). */
|
|
@@ -52,6 +56,22 @@ type ClientPluginHooks = {
|
|
|
52
56
|
operation: OperationObject;
|
|
53
57
|
variablesStore?: VariablesStore;
|
|
54
58
|
}) => void | Promise<void>;
|
|
59
|
+
/**
|
|
60
|
+
* Runs after the fetch `Request` has been built, right before it is sent. The request passed
|
|
61
|
+
* here is the exact object handed to fetch, so header mutations apply to the outgoing request
|
|
62
|
+
* and the body bytes match what goes over the wire (important for request signing, where a
|
|
63
|
+
* rebuilt multipart body would get a different boundary). Mutations to the request builder
|
|
64
|
+
* have no effect at this stage; use the `beforeRequest` hook for those.
|
|
65
|
+
*/
|
|
66
|
+
requestBuilt: (payload: {
|
|
67
|
+
/** The exact fetch Request that will be sent. Mutate its headers to modify the outgoing request. */
|
|
68
|
+
request: Request;
|
|
69
|
+
/** Request builder the request was built from. Mutating it has no effect at this stage. */
|
|
70
|
+
requestBuilder: RequestFactory;
|
|
71
|
+
document: OpenApiDocument;
|
|
72
|
+
operation: OperationObject;
|
|
73
|
+
variablesStore?: VariablesStore;
|
|
74
|
+
}) => void | Promise<void>;
|
|
55
75
|
/**
|
|
56
76
|
* Runs after a response is received. Receives the current document and operation so plugins can
|
|
57
77
|
* modify the response after it is received (for example, adding headers or modifying the body).
|
|
@@ -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;AACnG,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
|
|
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;AACnG,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;KAChC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B;;;;;;OAMG;IACH,YAAY,EAAE,CAAC,OAAO,EAAE;QACtB,oGAAoG;QACpG,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,kDAAkD;QAClD,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;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
|
+
"version": "0.19.0",
|
|
20
20
|
"engines": {
|
|
21
21
|
"node": ">=22"
|
|
22
22
|
},
|
|
@@ -44,9 +44,9 @@
|
|
|
44
44
|
"vue": "^3.5.30",
|
|
45
45
|
"yaml": "^2.8.3",
|
|
46
46
|
"@scalar/helpers": "0.8.2",
|
|
47
|
-
"@scalar/types": "0.
|
|
48
|
-
"@scalar/workspace-store": "0.54.
|
|
49
|
-
"@scalar/themes": "0.16.
|
|
47
|
+
"@scalar/types": "0.15.0",
|
|
48
|
+
"@scalar/workspace-store": "0.54.5",
|
|
49
|
+
"@scalar/themes": "0.16.1"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
52
|
"@types/node": "^24.1.0",
|