@scalar/oas-utils 0.10.15 → 0.11.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,5 @@
|
|
|
1
1
|
import { XScalarStability } from '@scalar/types/legacy';
|
|
2
|
-
import type { XPostResponse } from '@scalar/workspace-store/schemas/extensions/
|
|
2
|
+
import type { XPostResponse } from '@scalar/workspace-store/schemas/extensions/general/x-post-response';
|
|
3
3
|
import { z } from 'zod';
|
|
4
4
|
import { type RequestExample } from './request-examples.js';
|
|
5
5
|
/** The code to execute */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;
|
|
1
|
+
{"version":3,"file":"requests.d.ts","sourceRoot":"","sources":["../../../src/entities/spec/requests.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oEAAoE,CAAA;AAGvG,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAKvB,OAAO,EAAE,KAAK,cAAc,EAAwB,MAAM,oBAAoB,CAAA;AAe9E,0BAA0B;AAC1B,QAAA,MAAM,kBAAkB,aAAa,CAAA;AAMrC,QAAA,MAAM,cAAc,gFAAiF,CAAA;AAErG,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAE3D,0DAA0D;AAC1D,MAAM,MAAM,gBAAgB,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACzD,iEAAiE;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,wCAAwC;IACxC,gBAAgB,EAAE,MAAM,EAAE,CAAA;IAC1B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,0BAA0B;IAC1B,MAAM,EAAE,aAAa,CAAA;IACrB,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAA;CACb,GAAG,CACE;IACE,wBAAwB;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAA;CACb,GACD;IACE,qDAAqD;IACrD,MAAM,EAAE,2BAA2B,CAAC,UAAU,CAAC,CAAA;CAChD,CACJ,CAAA;AAEH,iEAAiE;AACjE,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA;AAoGD,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACnE,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAA;AAElE,8CAA8C;AAC9C,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAKG,CAAA;AAE7B,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AACnD,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA"}
|
|
@@ -1,19 +1,26 @@
|
|
|
1
1
|
import type { ApiReferenceEvents } from '@scalar/workspace-store/events';
|
|
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';
|
|
2
4
|
import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
|
|
3
5
|
import type { DefineComponent } from 'vue';
|
|
4
6
|
/** A type representing the hooks that a client plugin can define */
|
|
5
7
|
type ClientPluginHooks = {
|
|
6
8
|
beforeRequest: (payload: {
|
|
7
|
-
request
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
} | void>;
|
|
9
|
+
/** Workspace-store request spec; mutable by pre-request scripts (headers, method). */
|
|
10
|
+
requestBuilder: RequestFactory;
|
|
11
|
+
document: OpenApiDocument;
|
|
12
|
+
operation: OperationObject;
|
|
13
|
+
variablesStore?: VariablesStore;
|
|
14
|
+
}) => void | Promise<void>;
|
|
13
15
|
responseReceived: (payload: {
|
|
14
16
|
response: Response;
|
|
17
|
+
/** Request builder object that was used to build the request. Mutating this object will not affect the request object. */
|
|
18
|
+
requestBuilder: RequestFactory;
|
|
19
|
+
/** Request object that was sent to the server. */
|
|
15
20
|
request: Request;
|
|
21
|
+
document: OpenApiDocument;
|
|
16
22
|
operation: OperationObject;
|
|
23
|
+
variablesStore?: VariablesStore;
|
|
17
24
|
}) => void | Promise<void>;
|
|
18
25
|
};
|
|
19
26
|
/** A vue component which accepts the specified props */
|
|
@@ -23,11 +30,13 @@ type ClientPluginComponent<Props extends Record<string, unknown>, Emits extends
|
|
|
23
30
|
};
|
|
24
31
|
type ClientPluginComponents = {
|
|
25
32
|
request: ClientPluginComponent<{
|
|
26
|
-
operation
|
|
33
|
+
operation?: OperationObject;
|
|
27
34
|
}, {
|
|
28
35
|
'operation:update:extension': (payload: ApiReferenceEvents['operation:update:extension']['payload']) => void;
|
|
29
36
|
}>;
|
|
30
|
-
response: ClientPluginComponent<{
|
|
37
|
+
response: ClientPluginComponent<{
|
|
38
|
+
operation?: OperationObject;
|
|
39
|
+
}>;
|
|
31
40
|
};
|
|
32
41
|
/**
|
|
33
42
|
* ClientPlugin is used to extend the API Client with custom hooks and UI components.
|
|
@@ -36,10 +45,9 @@ type ClientPluginComponents = {
|
|
|
36
45
|
*
|
|
37
46
|
* const myPlugin: ClientPlugin = {
|
|
38
47
|
* hooks: {
|
|
39
|
-
* beforeRequest: (request) => {
|
|
40
|
-
* // Modify the request before it is sent
|
|
48
|
+
* beforeRequest: ({ request }) => {
|
|
41
49
|
* request.headers.set('X-Custom-Header', 'foo');
|
|
42
|
-
* return request;
|
|
50
|
+
* return { request };
|
|
43
51
|
* },
|
|
44
52
|
* responseReceived: async (response, operation) => {
|
|
45
53
|
* // Handle post-response logic
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client-plugins.d.ts","sourceRoot":"","sources":["../../src/helpers/client-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,KAAK,CAAA;AAE1C,oEAAoE;AACpE,KAAK,iBAAiB,GAAG;IACvB,aAAa,EAAE,CAAC,OAAO,EAAE;
|
|
1
|
+
{"version":3,"file":"client-plugins.d.ts","sourceRoot":"","sources":["../../src/helpers/client-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACxE,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,eAAe,EAAE,MAAM,KAAK,CAAA;AAE1C,oEAAoE;AACpE,KAAK,iBAAiB,GAAG;IACvB,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,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,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;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAA;CAC7C,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"}
|
package/package.json
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"specification",
|
|
17
17
|
"yaml"
|
|
18
18
|
],
|
|
19
|
-
"version": "0.
|
|
19
|
+
"version": "0.11.0",
|
|
20
20
|
"engines": {
|
|
21
21
|
"node": ">=22"
|
|
22
22
|
},
|
|
@@ -93,12 +93,12 @@
|
|
|
93
93
|
"zod": "^4.3.5",
|
|
94
94
|
"@scalar/helpers": "0.4.3",
|
|
95
95
|
"@scalar/json-magic": "0.12.5",
|
|
96
|
-
"@scalar/object-utils": "1.3.4",
|
|
97
96
|
"@scalar/openapi-parser": "0.25.8",
|
|
98
|
-
"@scalar/themes": "0.15.2",
|
|
99
|
-
"@scalar/types": "0.7.6",
|
|
100
97
|
"@scalar/openapi-types": "0.7.0",
|
|
101
|
-
"@scalar/
|
|
98
|
+
"@scalar/themes": "0.15.2",
|
|
99
|
+
"@scalar/types": "0.8.0",
|
|
100
|
+
"@scalar/workspace-store": "0.44.0",
|
|
101
|
+
"@scalar/object-utils": "1.3.4"
|
|
102
102
|
},
|
|
103
103
|
"devDependencies": {
|
|
104
104
|
"@types/node": "^24.1.0",
|