@scalar/api-reference 0.8.9 → 1.0.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 +31 -0
- package/README.md +8 -0
- package/dist/browser/standalone.js +88857 -88804
- package/dist/components/ApiClientModal.vue.d.ts +2 -2
- package/dist/components/ApiClientModal.vue.d.ts.map +1 -1
- package/dist/components/ApiReference.vue.d.ts +7 -7
- package/dist/components/ApiReference.vue.d.ts.map +1 -1
- package/dist/components/Content/Authentication/Authentication.vue.d.ts +2 -2
- package/dist/components/Content/Authentication/Authentication.vue.d.ts.map +1 -1
- package/dist/components/Content/Authentication/SecuritySchemeSelector.vue.d.ts.map +1 -1
- package/dist/components/Content/Content.vue.d.ts +9 -2
- package/dist/components/Content/Content.vue.d.ts.map +1 -1
- package/dist/components/Content/Introduction/ServerList.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ReferenceEndpoint.vue.d.ts +1 -17
- package/dist/components/Content/ReferenceEndpoint/ReferenceEndpoint.vue.d.ts.map +1 -1
- package/dist/components/FindAnythingButton.vue.d.ts +13 -1
- package/dist/components/FindAnythingButton.vue.d.ts.map +1 -1
- package/dist/components/SearchModal.vue.d.ts +2 -2
- package/dist/components/Sidebar.vue.d.ts +13 -3
- package/dist/components/Sidebar.vue.d.ts.map +1 -1
- package/dist/helpers/getUrlFromServerState.d.ts +1 -1
- package/dist/helpers/getUrlFromServerState.d.ts.map +1 -1
- package/dist/hooks/index.d.ts +2 -0
- package/dist/hooks/index.d.ts.map +1 -1
- package/dist/hooks/useParser.d.ts +161 -0
- package/dist/hooks/useParser.d.ts.map +1 -0
- package/dist/hooks/useSpec.d.ts +13 -0
- package/dist/hooks/useSpec.d.ts.map +1 -0
- package/dist/index.js +36545 -19144
- package/dist/types.d.ts +11 -8
- package/dist/types.d.ts.map +1 -1
- package/package.json +23 -8
package/dist/types.d.ts
CHANGED
|
@@ -27,18 +27,19 @@ export type ReferenceProps = {
|
|
|
27
27
|
/** @deprecated Use the `configuration` prop instead. */
|
|
28
28
|
hocuspocusConfiguration?: HocuspocusConfigurationProp;
|
|
29
29
|
};
|
|
30
|
+
export type SpecConfiguration = {
|
|
31
|
+
/** URL to a Swagger/OpenAPI file */
|
|
32
|
+
url?: string;
|
|
33
|
+
/** Swagger/Open API spec */
|
|
34
|
+
content?: string | Record<string, any> | (() => Record<string, any>);
|
|
35
|
+
/** The result of @scalar/swagger-parser */
|
|
36
|
+
preparsedContent?: Record<any, any>;
|
|
37
|
+
};
|
|
30
38
|
export type ReferenceConfiguration = {
|
|
31
39
|
/** A string to use one of the color presets */
|
|
32
40
|
theme?: ThemeId;
|
|
33
41
|
/** The Swagger/OpenAPI spec to render */
|
|
34
|
-
spec?:
|
|
35
|
-
/** URL to a Swagger/OpenAPI file */
|
|
36
|
-
url?: string;
|
|
37
|
-
/** Swagger/Open API spec */
|
|
38
|
-
content?: string | Record<string, any> | (() => Record<string, any>);
|
|
39
|
-
/** The result of @scalar/swagger-parser */
|
|
40
|
-
preparsedContent?: Record<any, any>;
|
|
41
|
-
};
|
|
42
|
+
spec?: SpecConfiguration;
|
|
42
43
|
/** URL to a request proxy for the API client */
|
|
43
44
|
proxy?: string;
|
|
44
45
|
/** Whether the spec input should show */
|
|
@@ -55,6 +56,8 @@ export type ReferenceConfiguration = {
|
|
|
55
56
|
footerBelowSidebar?: boolean;
|
|
56
57
|
/** Remove the Scalar branding :( */
|
|
57
58
|
hocuspocusConfiguration?: HocuspocusConfigurationProp;
|
|
59
|
+
/** Key used with CNTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
|
|
60
|
+
searchHotKey?: string;
|
|
58
61
|
};
|
|
59
62
|
export type Schema = {
|
|
60
63
|
format: string;
|
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;AAEhF,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,sBAAsB,CAAA;IACtC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,GAAG;IACF,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IAC7B,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,wDAAwD;IACxD,eAAe,CAAC,EAAE,gBAAgB,CAAA;IAClC,wDAAwD;IACxD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,wDAAwD;IACxD,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,wDAAwD;IACxD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,wDAAwD;IACxD,uBAAuB,CAAC,EAAE,2BAA2B,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,
|
|
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;AAEhF,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,sBAAsB,CAAA;IACtC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,GAAG;IACF,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wDAAwD;IACxD,UAAU,CAAC,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IAC7B,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wDAAwD;IACxD,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,wDAAwD;IACxD,eAAe,CAAC,EAAE,gBAAgB,CAAA;IAClC,wDAAwD;IACxD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,wDAAwD;IACxD,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,wDAAwD;IACxD,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,wDAAwD;IACxD,uBAAuB,CAAC,EAAE,2BAA2B,CAAA;CACtD,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;KAClC,CAAA;IACD,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,wEAAwE;IACxE,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,oCAAoC;IAEpC,uBAAuB,CAAC,EAAE,2BAA2B,CAAA;IACrD,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,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,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,UAAU,EAAE,CAAA;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACnC,QAAQ,EAAE,SAAS,CAAC,yBAAyB,EAAE,CAAA;IAC/C,WAAW,EAAE,WAAW,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,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,GAAG,SAAS,GAAG;IAC7C,SAAS,EAAE,MAAM,CACf,MAAM,EACN,QAAQ,GAAG;QACT,OAAO,EAAE,sBAAsB,CAAA;KAChC,CACF,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,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAChB,MAAM,EACN;QACE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;QACzB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;KAC3B,CACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,UAAU,GAClB,SAAS,CAAC,gBAAgB,GAC1B,WAAW,CAAC,gBAAgB,CAAA;AAEhC,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAA;AAErD,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,IAAI,EAAE,IAAI,CAAA;IACV,YAAY,EAAE,YAAY,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B,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,GAAG,MAAM,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,IAAI,GAAG,MAAM,CAAA;IAC7B,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"}
|
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": "0.
|
|
4
|
+
"version": "1.0.0",
|
|
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",
|
|
@@ -32,16 +32,16 @@
|
|
|
32
32
|
"remark-rehype": "11.0.0",
|
|
33
33
|
"remark-stringify": "11.0.0",
|
|
34
34
|
"unified": "11.0.3",
|
|
35
|
-
"@scalar/api-client": "0.7.
|
|
36
|
-
"@scalar/swagger-editor": "0.6.30",
|
|
37
|
-
"@scalar/swagger-parser": "0.5.5",
|
|
35
|
+
"@scalar/api-client": "0.7.27",
|
|
38
36
|
"@scalar/themes": "0.4.0",
|
|
37
|
+
"@scalar/swagger-parser": "0.5.5",
|
|
38
|
+
"@scalar/use-codemirror": "0.7.11",
|
|
39
39
|
"@scalar/use-clipboard": "0.5.6",
|
|
40
|
-
"@scalar/use-codemirror": "0.7.10",
|
|
41
40
|
"@scalar/use-keyboard-event": "0.5.3",
|
|
42
|
-
"@scalar/use-modal": "0.1.
|
|
41
|
+
"@scalar/use-modal": "0.1.5",
|
|
43
42
|
"@scalar/use-toasts": "0.5.6",
|
|
44
|
-
"@scalar/use-tooltip": "0.5.4"
|
|
43
|
+
"@scalar/use-tooltip": "0.5.4",
|
|
44
|
+
"@scalar/swagger-editor": "0.7.0"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"@storybook/addon-essentials": "7.4.3",
|
|
@@ -91,7 +91,22 @@
|
|
|
91
91
|
"module": "./dist/index.js",
|
|
92
92
|
"peerDependencies": {
|
|
93
93
|
"@types/js-yaml": "4.0.6",
|
|
94
|
-
"
|
|
94
|
+
"@xmldom/xmldom": "0.8.4",
|
|
95
|
+
"rehype-document": "7.0.1",
|
|
96
|
+
"rehype-external-links": "3.0.0",
|
|
97
|
+
"rehype-format": "5.0.0",
|
|
98
|
+
"rehype-highlight": "7.0.0",
|
|
99
|
+
"rehype-sanitize": "6.0.0",
|
|
100
|
+
"rehype-slug-custom-id": "1.1.0",
|
|
101
|
+
"rehype-stringify": "10.0.0",
|
|
102
|
+
"remark-breaks": "3.0.3",
|
|
103
|
+
"remark-gfm": "4.0.0",
|
|
104
|
+
"remark-parse": "11.0.0",
|
|
105
|
+
"remark-rehype": "11.0.0",
|
|
106
|
+
"remark-stringify": "11.0.0",
|
|
107
|
+
"unified": "11.0.3",
|
|
108
|
+
"vue": "3.3.4",
|
|
109
|
+
"@scalar/swagger-editor": "0.7.0"
|
|
95
110
|
},
|
|
96
111
|
"repository": {
|
|
97
112
|
"type": "git",
|