@scalar/api-reference 1.25.130 → 1.26.1
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 +34 -0
- package/dist/browser/standalone.js +19687 -19597
- package/dist/browser/webpack-stats.json +1 -1
- package/dist/components/ApiReference.vue.d.ts +8 -21
- package/dist/components/ApiReference.vue.d.ts.map +1 -1
- package/dist/components/ApiReference.vue.js +20 -52
- package/dist/components/ApiReference.vue2.js +4 -0
- package/dist/components/ApiReferenceLayout.vue.d.ts +2 -2
- package/dist/components/ApiReferenceLayout.vue.js +2 -2
- package/dist/components/ApiReferenceLayout.vue2.js +1 -1
- package/dist/components/Content/Introduction/Introduction.vue.js +1 -1
- package/dist/components/Content/Introduction/Introduction.vue2.js +45 -42
- package/dist/components/DocumentSelector/DocumentSelector.vue.d.ts +12 -0
- package/dist/components/DocumentSelector/DocumentSelector.vue.d.ts.map +1 -0
- package/dist/components/DocumentSelector/DocumentSelector.vue.js +67 -0
- package/dist/components/DocumentSelector/DocumentSelector.vue2.js +4 -0
- package/dist/components/DocumentSelector/index.d.ts +2 -0
- package/dist/components/DocumentSelector/index.d.ts.map +1 -0
- package/dist/components/Layouts/ClassicLayout.vue.d.ts +4 -4
- package/dist/components/Layouts/ClassicLayout.vue.d.ts.map +1 -1
- package/dist/components/Layouts/ClassicLayout.vue.js +28 -22
- package/dist/components/Layouts/Layouts.vue.d.ts +4 -7
- package/dist/components/Layouts/Layouts.vue.d.ts.map +1 -1
- package/dist/components/Layouts/Layouts.vue.js +23 -14
- package/dist/components/Layouts/ModernLayout.vue.d.ts +4 -4
- package/dist/components/Layouts/ModernLayout.vue.d.ts.map +1 -1
- package/dist/components/Layouts/ModernLayout.vue.js +2 -2
- package/dist/components/Layouts/ModernLayout.vue2.js +33 -30
- package/dist/components/Sidebar/SidebarElement.vue.js +2 -2
- package/dist/components/SingleApiReference.vue.d.ts +28 -0
- package/dist/components/SingleApiReference.vue.d.ts.map +1 -0
- package/dist/components/SingleApiReference.vue.js +60 -0
- package/dist/components/SingleApiReference.vue3.js +5 -0
- package/dist/esm.d.ts +3 -5
- package/dist/esm.d.ts.map +1 -1
- package/dist/esm.js +12 -13
- package/dist/features/ApiClientModal/useApiClient.d.ts +2 -2
- package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
- package/dist/features/BaseUrl/BaseUrl.vue.js +31 -30
- package/dist/features/ExampleRequest/ExampleRequest.vue.d.ts.map +1 -1
- package/dist/features/ExampleRequest/ExampleRequest.vue.js +2 -2
- package/dist/features/TestRequestButton/TestRequestButton.vue.js +2 -2
- package/dist/features/TestRequestButton/TestRequestButton.vue2.js +16 -14
- package/dist/hooks/useConfig.d.ts +3 -3
- package/dist/hooks/useConfig.d.ts.map +1 -1
- package/dist/hooks/useConfig.js +7 -4
- package/dist/hooks/useMultipleDocuments.d.ts +87 -0
- package/dist/hooks/useMultipleDocuments.d.ts.map +1 -0
- package/dist/hooks/useMultipleDocuments.js +49 -0
- package/dist/hooks/useNavState.js +38 -38
- package/dist/hooks/useReactiveSpec.d.ts +1 -1
- package/dist/hooks/useReactiveSpec.d.ts.map +1 -1
- package/dist/index.js +80 -81
- package/dist/standalone/lib/html-api.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/dist/types.d.ts +6 -6
- package/dist/types.d.ts.map +1 -1
- package/package.json +13 -14
- package/dist/components/ApiReference.vue3.js +0 -5
package/dist/types.d.ts
CHANGED
|
@@ -1,21 +1,18 @@
|
|
|
1
1
|
import type { ThemeId } from '@scalar/themes';
|
|
2
2
|
import type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
|
|
3
|
-
import type { ContentType, ReferenceConfiguration, Spec } from '@scalar/types/legacy';
|
|
4
3
|
import type { HarRequest } from '@scalar/types/snippetz';
|
|
4
|
+
import type { ContentType, ReferenceConfiguration, Spec } from '@scalar/types/legacy';
|
|
5
5
|
import type { Slot } from 'vue';
|
|
6
6
|
export type { ApiReferenceConfiguration };
|
|
7
7
|
export type { ReferenceConfiguration };
|
|
8
|
-
/**
|
|
9
|
-
* Props for the ApiReference components, coming from user input
|
|
10
|
-
*/
|
|
11
8
|
export type ReferenceProps = {
|
|
12
|
-
configuration?: Partial<ApiReferenceConfiguration
|
|
9
|
+
configuration?: Partial<ApiReferenceConfiguration>;
|
|
13
10
|
};
|
|
14
11
|
/**
|
|
15
12
|
* Before the configuration is parsed, we can use the broader types.
|
|
16
13
|
*/
|
|
17
14
|
export type ReferenceLayoutProps = {
|
|
18
|
-
configuration: Partial<ApiReferenceConfiguration
|
|
15
|
+
configuration: Partial<ApiReferenceConfiguration>;
|
|
19
16
|
parsedSpec: Spec;
|
|
20
17
|
rawSpec: string;
|
|
21
18
|
isDark: boolean;
|
|
@@ -86,6 +83,9 @@ export type ReferenceLayoutSlot = 'header' | 'footer' | 'editor' | 'content-star
|
|
|
86
83
|
export type ReferenceLayoutSlots = {
|
|
87
84
|
[x in ReferenceLayoutSlot]: (props: ReferenceSlotProps) => any;
|
|
88
85
|
};
|
|
86
|
+
export type DocumentSelectorSlot = {
|
|
87
|
+
'document-selector': any;
|
|
88
|
+
};
|
|
89
89
|
export type ReferenceSlotProps = {
|
|
90
90
|
spec: Spec;
|
|
91
91
|
breadcrumb: 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,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAC5E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AACrF,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,KAAK,CAAA;AAE/B,YAAY,EAAE,yBAAyB,EAAE,CAAA;AAEzC,YAAY,EAAE,sBAAsB,EAAE,CAAA;AAEtC,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAA;CACnD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,aAAa,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAA;IACjD,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,aAAa,EAAE,yBAAyB,CAAA;IACxC,UAAU,EAAE,IAAI,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,eAAe,CAAA;AAEjE,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,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,GAAG,CAAA;QACb,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,UAAU,EAAE,iBAAiB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,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,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEtD,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAA;AAEpC,MAAM,MAAM,cAAc,GAAG;KAE1B,CAAC,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAClD,CAAA;AAED,2DAA2D;AAC3D,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,eAAe,GACf,aAAa,GACb,eAAe,GACf,aAAa,CAAA;AAEjB,MAAM,MAAM,oBAAoB,GAAG;KAChC,CAAC,IAAI,mBAAmB,GAAG,CAAC,KAAK,EAAE,kBAAkB,KAAK,GAAG;CAC/D,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,mBAAmB,EAAE,GAAG,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,IAAI,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,CAAC,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAA;IACxC,CAAC,CAAC,EAAE,eAAe,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACzC,CAAC,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC5B,CAAC,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC5B,CAAC,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;CAC5B,CAAA"}
|
package/package.json
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"vue",
|
|
21
21
|
"vue3"
|
|
22
22
|
],
|
|
23
|
-
"version": "1.
|
|
23
|
+
"version": "1.26.1",
|
|
24
24
|
"engines": {
|
|
25
25
|
"node": ">=18"
|
|
26
26
|
},
|
|
@@ -55,17 +55,17 @@
|
|
|
55
55
|
"nanoid": "^5.0.9",
|
|
56
56
|
"vue": "^3.5.12",
|
|
57
57
|
"zod": "^3.23.8",
|
|
58
|
-
"@scalar/api-client": "2.2.
|
|
59
|
-
"@scalar/code-highlight": "0.0.
|
|
60
|
-
"@scalar/components": "0.13.
|
|
61
|
-
"@scalar/
|
|
62
|
-
"@scalar/oas-utils": "0.2.113",
|
|
63
|
-
"@scalar/snippetz": "0.2.16",
|
|
58
|
+
"@scalar/api-client": "2.2.61",
|
|
59
|
+
"@scalar/code-highlight": "0.0.24",
|
|
60
|
+
"@scalar/components": "0.13.33",
|
|
61
|
+
"@scalar/oas-utils": "0.2.115",
|
|
64
62
|
"@scalar/openapi-types": "0.1.9",
|
|
65
|
-
"@scalar/
|
|
66
|
-
"@scalar/
|
|
67
|
-
"@scalar/
|
|
68
|
-
"@scalar/
|
|
63
|
+
"@scalar/openapi-parser": "0.10.10",
|
|
64
|
+
"@scalar/snippetz": "0.2.16",
|
|
65
|
+
"@scalar/types": "0.0.40",
|
|
66
|
+
"@scalar/themes": "0.9.75",
|
|
67
|
+
"@scalar/use-hooks": "0.1.29",
|
|
68
|
+
"@scalar/use-toasts": "0.7.9"
|
|
69
69
|
},
|
|
70
70
|
"devDependencies": {
|
|
71
71
|
"@vitejs/plugin-vue": "^5.0.4",
|
|
@@ -79,8 +79,8 @@
|
|
|
79
79
|
"vite-plugin-banner": "^0.7.1",
|
|
80
80
|
"vite-plugin-css-injected-by-js": "^3.4.0",
|
|
81
81
|
"vitest": "^1.6.0",
|
|
82
|
-
"@scalar/
|
|
83
|
-
"@scalar/
|
|
82
|
+
"@scalar/build-tooling": "0.1.17",
|
|
83
|
+
"@scalar/galaxy": "0.2.24"
|
|
84
84
|
},
|
|
85
85
|
"scripts": {
|
|
86
86
|
"analyze:default": "pnpm dlx vite-bundle-visualizer",
|
|
@@ -93,7 +93,6 @@
|
|
|
93
93
|
"lint:check": "eslint .",
|
|
94
94
|
"lint:fix": "eslint . --fix",
|
|
95
95
|
"playground:esm": "vite ./playground/esm -c ./playground/esm/vite.config.ts",
|
|
96
|
-
"playground:examples": "vite ./playground/examples -c ./vite.config.ts",
|
|
97
96
|
"preview": "vite preview",
|
|
98
97
|
"test": "vitest",
|
|
99
98
|
"types:build": "vue-tsc -p tsconfig.build.json",
|