@scalar/api-reference 0.7.4 → 0.7.6
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 +29 -0
- package/README.md +5 -1
- package/dist/browser/standalone.js +20945 -20014
- package/dist/components/ApiReference.vue.d.ts.map +1 -1
- package/dist/components/Content/Content.vue.d.ts.map +1 -1
- package/dist/components/Content/EndpointsOverview.vue.d.ts +0 -8
- package/dist/components/Content/EndpointsOverview.vue.d.ts.map +1 -1
- package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
- package/dist/components/Content/Models.vue.d.ts +12 -0
- package/dist/components/Content/Models.vue.d.ts.map +1 -0
- package/dist/components/Content/ReferenceEndpoint/Copy.vue.d.ts +0 -9
- package/dist/components/Content/ReferenceEndpoint/Copy.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/Parameters.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ReferenceEndpoint.vue.d.ts +1 -9
- package/dist/components/Content/ReferenceEndpoint/ReferenceEndpoint.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/RequestBody.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema.vue.d.ts +21 -0
- package/dist/components/Content/Schema.vue.d.ts.map +1 -0
- package/dist/components/IntersectionObserver.vue.d.ts +24 -0
- package/dist/components/IntersectionObserver.vue.d.ts.map +1 -0
- package/dist/components/LoadingSkeleton.vue.d.ts +15 -0
- package/dist/components/LoadingSkeleton.vue.d.ts.map +1 -0
- package/dist/components/Section/Section.vue.d.ts +18 -0
- package/dist/components/Section/Section.vue.d.ts.map +1 -0
- package/dist/components/Section/SectionColumn.vue.d.ts +10 -0
- package/dist/components/Section/SectionColumn.vue.d.ts.map +1 -0
- package/dist/components/Section/SectionColumns.vue.d.ts +10 -0
- package/dist/components/Section/SectionColumns.vue.d.ts.map +1 -0
- package/dist/components/Section/SectionContainer.vue.d.ts +10 -0
- package/dist/components/Section/SectionContainer.vue.d.ts.map +1 -0
- package/dist/components/Section/SectionContent.vue.d.ts +22 -0
- package/dist/components/Section/SectionContent.vue.d.ts.map +1 -0
- package/dist/components/Section/SectionHeader.vue.d.ts +31 -0
- package/dist/components/Section/SectionHeader.vue.d.ts.map +1 -0
- package/dist/components/Section/index.d.ts +7 -0
- package/dist/components/Section/index.d.ts.map +1 -0
- package/dist/components/Sidebar.vue.d.ts.map +1 -1
- package/dist/helpers/generateResponseContent.d.ts +1 -1
- package/dist/helpers/generateResponseContent.d.ts.map +1 -1
- package/dist/helpers/getHeadingId.d.ts +3 -0
- package/dist/helpers/getHeadingId.d.ts.map +1 -0
- package/dist/helpers/getHeadingsFromMarkdown.d.ts +3 -2
- package/dist/helpers/getHeadingsFromMarkdown.d.ts.map +1 -1
- package/dist/helpers/getModelSectionId.d.ts +2 -0
- package/dist/helpers/getModelSectionId.d.ts.map +1 -0
- package/dist/helpers/getOperationSectionId.d.ts +3 -0
- package/dist/helpers/getOperationSectionId.d.ts.map +1 -0
- package/dist/helpers/getTagSectionId.d.ts +3 -0
- package/dist/helpers/getTagSectionId.d.ts.map +1 -0
- package/dist/helpers/hasModels.d.ts +3 -0
- package/dist/helpers/hasModels.d.ts.map +1 -0
- package/dist/helpers/index.d.ts +11 -5
- package/dist/helpers/index.d.ts.map +1 -1
- package/dist/helpers/scrollToId.d.ts +5 -0
- package/dist/helpers/scrollToId.d.ts.map +1 -0
- package/dist/index.js +9681 -10431
- package/dist/types.d.ts +5 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +7 -7
package/dist/types.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { type EditorHeaderTabs, type HocuspocusConfigurationProp } from '@scalar/swagger-editor';
|
|
2
2
|
import { type ThemeId } from '@scalar/themes';
|
|
3
|
+
import { type OpenAPIV2, type OpenAPIV3, type OpenAPIV3_1 } from 'openapi-types';
|
|
3
4
|
export type ReferenceProps = {
|
|
4
5
|
isEditable?: boolean;
|
|
5
6
|
showSidebar?: boolean;
|
|
@@ -122,10 +123,14 @@ export type Server = {
|
|
|
122
123
|
url: string;
|
|
123
124
|
description?: string;
|
|
124
125
|
};
|
|
126
|
+
export type Components = OpenAPIV3.ComponentsObject | OpenAPIV3_1.ComponentsObject;
|
|
127
|
+
export type Definitions = OpenAPIV2.DefinitionsObject;
|
|
125
128
|
export type Spec = {
|
|
126
129
|
tags: Tag[];
|
|
127
130
|
info: Info;
|
|
128
131
|
externalDocs: ExternalDocs;
|
|
129
132
|
servers: Server[];
|
|
133
|
+
components?: Components;
|
|
134
|
+
definitions?: Definitions;
|
|
130
135
|
};
|
|
131
136
|
//# sourceMappingURL=types.d.ts.map
|
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;
|
|
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,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAEhF,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,uBAAuB,CAAC,EAAE,2BAA2B,CAAA;IACrD,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,eAAe,CAAC,EAAE,gBAAgB,CAAA;CACnC,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,CAAC,EAAE,GAAG,EAAE,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AACD,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,QAAQ,EAAE,CAAA;IACpB,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;CACrB,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"}
|
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.7.
|
|
4
|
+
"version": "0.7.6",
|
|
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",
|
|
@@ -9,12 +9,14 @@
|
|
|
9
9
|
"@headlessui/vue": "1.7.16",
|
|
10
10
|
"@vcarl/remark-headings": "0.1.0",
|
|
11
11
|
"@vueuse/core": "10.4.1",
|
|
12
|
+
"@xmldom/xmldom": "0.8.4",
|
|
12
13
|
"fuse.js": "6.6.2",
|
|
13
14
|
"github-slugger": "2.0.0",
|
|
14
15
|
"httpsnippet-lite": "3.0.5",
|
|
15
16
|
"js-yaml": "4.1.0",
|
|
16
17
|
"modern-normalize": "2.0.0",
|
|
17
18
|
"nanoid": "5.0.1",
|
|
19
|
+
"openapi-types": "12.1.3",
|
|
18
20
|
"postcss-nested": "6.0.1",
|
|
19
21
|
"rehype-document": "7.0.1",
|
|
20
22
|
"rehype-format": "5.0.0",
|
|
@@ -29,10 +31,9 @@
|
|
|
29
31
|
"remark-textr": "6.0.0",
|
|
30
32
|
"typographic-base": "1.0.4",
|
|
31
33
|
"unified": "11.0.3",
|
|
32
|
-
"
|
|
33
|
-
"@scalar/
|
|
34
|
-
"@scalar/swagger-
|
|
35
|
-
"@scalar/swagger-parser": "0.5.4",
|
|
34
|
+
"@scalar/api-client": "0.7.20",
|
|
35
|
+
"@scalar/swagger-editor": "0.6.23",
|
|
36
|
+
"@scalar/swagger-parser": "0.5.5",
|
|
36
37
|
"@scalar/themes": "0.4.0",
|
|
37
38
|
"@scalar/use-clipboard": "0.5.5",
|
|
38
39
|
"@scalar/use-codemirror": "0.7.8",
|
|
@@ -52,7 +53,7 @@
|
|
|
52
53
|
"@vitejs/plugin-vue": "4.3.4",
|
|
53
54
|
"@vitest/coverage-v8": "0.34.4",
|
|
54
55
|
"http-server": "14.1.1",
|
|
55
|
-
"postcss": "8.4.
|
|
56
|
+
"postcss": "8.4.31",
|
|
56
57
|
"react": "18.2.0",
|
|
57
58
|
"react-dom": "18.2.0",
|
|
58
59
|
"storybook": "7.4.3",
|
|
@@ -89,7 +90,6 @@
|
|
|
89
90
|
"module": "./dist/index.js",
|
|
90
91
|
"peerDependencies": {
|
|
91
92
|
"@types/js-yaml": "4.0.6",
|
|
92
|
-
"@types/xmldom": "0.1.31",
|
|
93
93
|
"vue": "3.3.4"
|
|
94
94
|
},
|
|
95
95
|
"repository": {
|