@scalar/api-reference 1.2.0 → 1.2.2
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 +14 -0
- package/dist/browser/standalone.js +38 -19
- package/dist/components/SearchButton.vue.d.ts.map +1 -1
- package/dist/helpers/getApiClientRequest.d.ts.map +1 -1
- package/dist/hooks/useActive.d.ts +5 -0
- package/dist/hooks/useActive.d.ts.map +1 -0
- package/dist/hooks/useParser.d.ts +14 -12
- package/dist/hooks/useParser.d.ts.map +1 -1
- package/dist/index.js +3666 -3650
- package/dist/types.d.ts +10 -9
- package/dist/types.d.ts.map +1 -1
- package/package.json +3 -3
package/dist/types.d.ts
CHANGED
|
@@ -44,6 +44,7 @@ export declare const DEFAULT_CONFIG: DeepReadonly<ReferenceConfiguration>;
|
|
|
44
44
|
export type Schema = {
|
|
45
45
|
format: string;
|
|
46
46
|
type: string;
|
|
47
|
+
default?: any;
|
|
47
48
|
};
|
|
48
49
|
export type Parameters = {
|
|
49
50
|
description?: string;
|
|
@@ -57,14 +58,14 @@ export type Response = {
|
|
|
57
58
|
content: any;
|
|
58
59
|
};
|
|
59
60
|
export type Information = {
|
|
60
|
-
description
|
|
61
|
-
operationId
|
|
62
|
-
parameters
|
|
63
|
-
responses
|
|
64
|
-
security
|
|
65
|
-
requestBody
|
|
66
|
-
summary
|
|
67
|
-
tags
|
|
61
|
+
description?: string;
|
|
62
|
+
operationId?: string | number;
|
|
63
|
+
parameters?: Parameters[];
|
|
64
|
+
responses?: Record<string, Response>;
|
|
65
|
+
security?: OpenAPIV3.SecurityRequirementObject[];
|
|
66
|
+
requestBody?: RequestBody;
|
|
67
|
+
summary?: string;
|
|
68
|
+
tags?: string[];
|
|
68
69
|
};
|
|
69
70
|
export type Operation = {
|
|
70
71
|
httpVerb: string;
|
|
@@ -84,7 +85,7 @@ export type ExampleResponseHeaders = Record<string, {
|
|
|
84
85
|
}>;
|
|
85
86
|
export type RequestBodyMimeTypes = 'application/json' | 'application/octet-stream' | 'application/x-www-form-urlencoded' | 'application/xml' | 'multipart/form-data' | 'text/plain';
|
|
86
87
|
export type TransformedOperation = Operation & {
|
|
87
|
-
pathParameters
|
|
88
|
+
pathParameters?: Parameters[];
|
|
88
89
|
information: {
|
|
89
90
|
requestBody?: {
|
|
90
91
|
content?: Record<RequestBodyMimeTypes, {
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,2BAA2B,EACjC,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAChF,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,KAAK,CAAA;AAEvC,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,sBAAsB,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IACpE,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,yCAAyC;IACzC,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,oDAAoD;IACpD,IAAI,CAAC,EAAE;QACL,+BAA+B;QAE/B,8BAA8B;QAC9B,cAAc,CAAC,EAAE,gBAAgB,CAAA;QACjC,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAC/B,CAAA;IACD,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,oCAAoC;IAEpC,uBAAuB,CAAC,EAAE,2BAA2B,CAAA;IACrD,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU;IACV,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED,sCAAsC;AACtC,eAAO,MAAM,cAAc,EAAE,YAAY,CAAC,sBAAsB,CAc/D,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,2BAA2B,EACjC,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAChF,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,KAAK,CAAA;AAEvC,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,sBAAsB,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IACpE,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,yCAAyC;IACzC,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,oDAAoD;IACpD,IAAI,CAAC,EAAE;QACL,+BAA+B;QAE/B,8BAA8B;QAC9B,cAAc,CAAC,EAAE,gBAAgB,CAAA;QACjC,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAC/B,CAAA;IACD,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,oCAAoC;IAEpC,uBAAuB,CAAC,EAAE,2BAA2B,CAAA;IACrD,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU;IACV,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED,sCAAsC;AACtC,eAAO,MAAM,cAAc,EAAE,YAAY,CAAC,sBAAsB,CAc/D,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,GAAG,CAAA;CACd,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,GAAG,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC7B,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACpC,QAAQ,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAAE,CAAA;IAChD,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,WAAW,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,MAAM,EACN;IACE,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;CACF,CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,GAC5B,kBAAkB,GAClB,0BAA0B,GAC1B,mCAAmC,GACnC,iBAAiB,GACjB,qBAAqB,GACrB,YAAY,CAAA;AAEhB,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG;IAC7C,cAAc,CAAC,EAAE,UAAU,EAAE,CAAA;IAC7B,WAAW,EAAE;QACX,WAAW,CAAC,EAAE;YACZ,OAAO,CAAC,EAAE,MAAM,CACd,oBAAoB,EACpB;gBACE,MAAM,CAAC,EAAE,GAAG,CAAA;gBACZ,OAAO,CAAC,EAAE,GAAG,CAAA;gBACb,QAAQ,CAAC,EAAE,GAAG,CAAA;aACf,CACF,CAAA;SACF,CAAA;KACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,oBAAoB,EAAE,CAAA;CACnC,CAAA;AACD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,UAAU,EAAE,iBAAiB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,YAAY,GACZ,WAAW,GACX,mCAAmC,GACnC,qBAAqB,CAAA;AAEzB,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAClC,MAAM,EACN;IACE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CAC3B,CACF,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,eAAe,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,IAAI,CAC3B,SAAS,CAAC,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,EACzD,iBAAiB,CAClB,GAAG;IACF,eAAe,CAAC,EAAE,MAAM,CACtB,MAAM,EACJ,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACrB,SAAS,CAAC,oBAAoB,GAC9B,SAAS,CAAC,oBAAoB,CACjC,CAAA;CACF,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAA;AAErD,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,IAAI,EAAE,IAAI,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,eAAe,CAAC,EACZ,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,oBAAoB,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,oBAAoB,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAA;IACpD,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,QAAQ,EAAE,MAAM,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;SACjB,CAAA;QACD,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;IACD,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,IAAI,GAAG,MAAM,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,eAAe,GACf,aAAa,GACb,eAAe,GACf,aAAa,CAAA;AAEjB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,IAAI,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scalar/api-reference",
|
|
3
3
|
"description": "generate beautiful API references from OpenAPI specs",
|
|
4
|
-
"version": "1.2.
|
|
4
|
+
"version": "1.2.2",
|
|
5
5
|
"author": "Scalar (https://github.com/scalar)",
|
|
6
6
|
"browser": "./dist/browser/standalone.js",
|
|
7
7
|
"bugs": "https://github.com/scalar/scalar/issues/new",
|
|
@@ -31,10 +31,10 @@
|
|
|
31
31
|
"@scalar/api-client": "0.7.31",
|
|
32
32
|
"@scalar/swagger-editor": "0.7.7",
|
|
33
33
|
"@scalar/swagger-parser": "0.5.10",
|
|
34
|
+
"@scalar/use-clipboard": "0.5.6",
|
|
34
35
|
"@scalar/themes": "0.4.0",
|
|
35
36
|
"@scalar/use-codemirror": "0.7.12",
|
|
36
37
|
"@scalar/use-keyboard-event": "0.5.3",
|
|
37
|
-
"@scalar/use-clipboard": "0.5.6",
|
|
38
38
|
"@scalar/use-modal": "0.1.6",
|
|
39
39
|
"@scalar/use-toasts": "0.5.6",
|
|
40
40
|
"@scalar/use-tooltip": "0.5.4"
|
|
@@ -64,7 +64,7 @@
|
|
|
64
64
|
"vue-tsc": "1.8.19"
|
|
65
65
|
},
|
|
66
66
|
"engines": {
|
|
67
|
-
"node": ">=
|
|
67
|
+
"node": ">=20"
|
|
68
68
|
},
|
|
69
69
|
"exports": {
|
|
70
70
|
"import": "./dist/index.js"
|