@scalar/api-reference 1.25.102 → 1.25.104

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.
Files changed (99) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/dist/blocks/constants.d.ts +9 -0
  3. package/dist/blocks/constants.d.ts.map +1 -0
  4. package/dist/blocks/constants.js +8 -0
  5. package/dist/blocks/helpers/getPointer.d.ts +22 -0
  6. package/dist/blocks/helpers/getPointer.d.ts.map +1 -0
  7. package/dist/blocks/helpers/getPointer.js +12 -0
  8. package/dist/blocks/hooks/useBlockProps.d.ts +32 -0
  9. package/dist/blocks/hooks/useBlockProps.d.ts.map +1 -0
  10. package/dist/blocks/hooks/useBlockProps.js +28 -0
  11. package/dist/browser/standalone.js +12846 -12739
  12. package/dist/browser/webpack-stats.json +1 -1
  13. package/dist/components/ApiReference.vue.js +31 -31
  14. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  15. package/dist/components/ApiReferenceLayout.vue.js +2 -2
  16. package/dist/components/ApiReferenceLayout.vue2.js +2 -1
  17. package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
  18. package/dist/components/Content/Introduction/Introduction.vue.js +1 -1
  19. package/dist/components/Content/Introduction/Introduction.vue2.js +84 -70
  20. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts +2 -0
  21. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
  22. package/dist/components/Content/Schema/SchemaProperty.vue.js +2 -2
  23. package/dist/components/Content/Schema/SchemaProperty.vue2.js +118 -111
  24. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
  25. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +3 -3
  26. package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +91 -77
  27. package/dist/components/Content/Schema/helpers/formatExample.d.ts +5 -0
  28. package/dist/components/Content/Schema/helpers/formatExample.d.ts.map +1 -0
  29. package/dist/components/Content/Schema/helpers/formatExample.js +6 -0
  30. package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.d.ts +9 -0
  31. package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.d.ts.map +1 -0
  32. package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.js +20 -0
  33. package/dist/components/HttpMethod/HttpMethod.vue.d.ts +2 -1
  34. package/dist/components/HttpMethod/HttpMethod.vue.d.ts.map +1 -1
  35. package/dist/components/Layouts/ClassicLayout.vue.d.ts.map +1 -1
  36. package/dist/components/Layouts/ClassicLayout.vue.js +30 -27
  37. package/dist/components/Layouts/ModernLayout.vue.d.ts.map +1 -1
  38. package/dist/components/Layouts/ModernLayout.vue.js +2 -2
  39. package/dist/components/Layouts/ModernLayout.vue2.js +55 -50
  40. package/dist/features/ApiClientModal/useApiClient.d.ts +336 -254
  41. package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
  42. package/dist/features/DownloadLink/DownloadLink.vue.d.ts.map +1 -1
  43. package/dist/features/DownloadLink/DownloadLink.vue.js +2 -2
  44. package/dist/features/DownloadLink/DownloadLink.vue2.js +10 -3
  45. package/dist/features/Operation/Operation.vue.d.ts.map +1 -1
  46. package/dist/features/Operation/Operation.vue.js +37 -26
  47. package/dist/features/Operation/components/OperationResponses.vue.d.ts.map +1 -1
  48. package/dist/features/Operation/components/OperationResponses.vue.js +8 -7
  49. package/dist/features/Operation/components/ParameterList.vue.d.ts +2 -0
  50. package/dist/features/Operation/components/ParameterList.vue.d.ts.map +1 -1
  51. package/dist/features/Operation/components/ParameterList.vue.js +2 -2
  52. package/dist/features/Operation/components/ParameterList.vue2.js +18 -16
  53. package/dist/features/Operation/components/ParameterListItem.vue.d.ts +2 -0
  54. package/dist/features/Operation/components/ParameterListItem.vue.d.ts.map +1 -1
  55. package/dist/features/Operation/components/ParameterListItem.vue.js +1 -1
  56. package/dist/features/Operation/components/ParameterListItem.vue2.js +27 -25
  57. package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts +3 -0
  58. package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
  59. package/dist/features/Operation/layouts/ClassicLayout.vue.js +1 -1
  60. package/dist/features/Operation/layouts/ClassicLayout.vue2.js +108 -101
  61. package/dist/features/Operation/layouts/ModernLayout.vue.d.ts +3 -0
  62. package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map +1 -1
  63. package/dist/features/Operation/layouts/ModernLayout.vue.js +2 -2
  64. package/dist/features/Operation/layouts/ModernLayout.vue2.js +54 -50
  65. package/dist/helpers/get-request.d.ts +2 -0
  66. package/dist/helpers/get-request.d.ts.map +1 -1
  67. package/dist/helpers/parse.d.ts.map +1 -1
  68. package/dist/helpers/parse.js +88 -68
  69. package/dist/index.d.ts +0 -1
  70. package/dist/index.d.ts.map +1 -1
  71. package/dist/index.js +79 -83
  72. package/dist/style.css +1 -1
  73. package/package.json +11 -12
  74. package/dist/components/DarkModeToggle/DarkModeIconToggle.vue.d.ts +0 -10
  75. package/dist/components/DarkModeToggle/DarkModeIconToggle.vue.d.ts.map +0 -1
  76. package/dist/components/DarkModeToggle/DarkModeIconToggle.vue.js +0 -7
  77. package/dist/components/DarkModeToggle/DarkModeIconToggle.vue2.js +0 -30
  78. package/dist/components/DarkModeToggle/DarkModeToggle.vue.d.ts +0 -11
  79. package/dist/components/DarkModeToggle/DarkModeToggle.vue.d.ts.map +0 -1
  80. package/dist/components/DarkModeToggle/DarkModeToggle.vue.js +0 -7
  81. package/dist/components/DarkModeToggle/DarkModeToggle.vue2.js +0 -31
  82. package/dist/components/DarkModeToggle/index.d.ts +0 -3
  83. package/dist/components/DarkModeToggle/index.d.ts.map +0 -1
  84. package/dist/embeds/ExampleRequest/ExampleRequest.vue.d.ts +0 -10
  85. package/dist/embeds/ExampleRequest/ExampleRequest.vue.d.ts.map +0 -1
  86. package/dist/embeds/ExampleRequest/index.d.ts +0 -2
  87. package/dist/embeds/ExampleRequest/index.d.ts.map +0 -1
  88. package/dist/embeds/ExampleResponses/ExampleResponses.vue.d.ts +0 -7
  89. package/dist/embeds/ExampleResponses/ExampleResponses.vue.d.ts.map +0 -1
  90. package/dist/embeds/ExampleResponses/index.d.ts +0 -2
  91. package/dist/embeds/ExampleResponses/index.d.ts.map +0 -1
  92. package/dist/embeds/OpenApiDocument/OpenApiDocument.vue.d.ts +0 -782
  93. package/dist/embeds/OpenApiDocument/OpenApiDocument.vue.d.ts.map +0 -1
  94. package/dist/embeds/OpenApiDocument/index.d.ts +0 -3
  95. package/dist/embeds/OpenApiDocument/index.d.ts.map +0 -1
  96. package/dist/embeds/OpenApiDocument/types.d.ts +0 -3
  97. package/dist/embeds/OpenApiDocument/types.d.ts.map +0 -1
  98. package/dist/embeds/index.d.ts +0 -4
  99. package/dist/embeds/index.d.ts.map +0 -1
package/package.json CHANGED
@@ -20,7 +20,7 @@
20
20
  "vue",
21
21
  "vue3"
22
22
  ],
23
- "version": "1.25.102",
23
+ "version": "1.25.104",
24
24
  "engines": {
25
25
  "node": ">=18"
26
26
  },
@@ -54,17 +54,17 @@
54
54
  "github-slugger": "^2.0.0",
55
55
  "nanoid": "^5.0.7",
56
56
  "vue": "^3.5.12",
57
- "@scalar/api-client": "2.2.31",
58
- "@scalar/components": "0.13.13",
59
57
  "@scalar/code-highlight": "0.0.19",
60
- "@scalar/openapi-parser": "0.10.3",
61
- "@scalar/oas-utils": "0.2.96",
62
- "@scalar/openapi-types": "0.1.5",
63
- "@scalar/snippetz": "0.2.10",
64
- "@scalar/themes": "0.9.59",
65
- "@scalar/types": "0.0.25",
66
- "@scalar/use-hooks": "0.1.13",
67
- "@scalar/use-toasts": "0.7.8"
58
+ "@scalar/oas-utils": "0.2.97",
59
+ "@scalar/openapi-parser": "0.10.4",
60
+ "@scalar/components": "0.13.14",
61
+ "@scalar/openapi-types": "0.1.6",
62
+ "@scalar/themes": "0.9.60",
63
+ "@scalar/types": "0.0.26",
64
+ "@scalar/use-toasts": "0.7.8",
65
+ "@scalar/use-hooks": "0.1.14",
66
+ "@scalar/api-client": "2.2.33",
67
+ "@scalar/snippetz": "0.2.10"
68
68
  },
69
69
  "devDependencies": {
70
70
  "@vitejs/plugin-vue": "^5.0.4",
@@ -91,7 +91,6 @@
91
91
  "dev:standalone": "vite -c vite.standalone.config.ts",
92
92
  "lint:check": "eslint .",
93
93
  "lint:fix": "eslint . --fix",
94
- "playground:embed": "vite ./playground/embed -c ./vite.config.ts",
95
94
  "playground:esm": "vite ./playground/esm -c ./playground/esm/vite.config.ts",
96
95
  "playground:examples": "vite ./playground/examples -c ./vite.config.ts",
97
96
  "preview": "vite preview",
@@ -1,10 +0,0 @@
1
- type __VLS_Props = {
2
- isDarkMode: boolean;
3
- };
4
- declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
5
- toggleDarkMode: () => any;
6
- }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
7
- onToggleDarkMode?: (() => any) | undefined;
8
- }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLButtonElement>;
9
- export default _default;
10
- //# sourceMappingURL=DarkModeIconToggle.vue.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"DarkModeIconToggle.vue.d.ts","sourceRoot":"","sources":["../../../src/components/DarkModeToggle/DarkModeIconToggle.vue"],"names":[],"mappings":"AAiDA,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE,OAAO,CAAA;CACpB,CAAC;;;;;;AAoFF,wBAQG"}
@@ -1,7 +0,0 @@
1
- import o from "./DarkModeIconToggle.vue2.js";
2
- /* empty css */
3
- import e from "../../_virtual/_plugin-vue_export-helper.js";
4
- const m = /* @__PURE__ */ e(o, [["__scopeId", "data-v-3d47eee0"]]);
5
- export {
6
- m as default
7
- };
@@ -1,30 +0,0 @@
1
- import { defineComponent as r, openBlock as n, createElementBlock as a, createVNode as t, unref as i, withCtx as l, createTextVNode as d, toDisplayString as p } from "vue";
2
- import { ScalarIcon as s } from "@scalar/components";
3
- import c from "../ScreenReader.vue.js";
4
- const M = /* @__PURE__ */ r({
5
- __name: "DarkModeIconToggle",
6
- props: {
7
- isDarkMode: { type: Boolean }
8
- },
9
- emits: ["toggleDarkMode"],
10
- setup(k) {
11
- return (e, o) => (n(), a("button", {
12
- class: "darklight",
13
- type: "button",
14
- onClick: o[0] || (o[0] = (m) => e.$emit("toggleDarkMode"))
15
- }, [
16
- t(i(s), {
17
- icon: e.isDarkMode ? "DarkMode" : "LightMode"
18
- }, null, 8, ["icon"]),
19
- t(c, null, {
20
- default: l(() => [
21
- d(" Switch to " + p(e.isDarkMode ? "Light" : "Dark") + " Mode ", 1)
22
- ]),
23
- _: 1
24
- })
25
- ]));
26
- }
27
- });
28
- export {
29
- M as default
30
- };
@@ -1,11 +0,0 @@
1
- type __VLS_Props = {
2
- isDarkMode: boolean;
3
- hideDarkModeToggle?: boolean;
4
- };
5
- declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
6
- toggleDarkMode: () => any;
7
- }, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
8
- onToggleDarkMode?: (() => any) | undefined;
9
- }>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLDivElement>;
10
- export default _default;
11
- //# sourceMappingURL=DarkModeToggle.vue.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"DarkModeToggle.vue.d.ts","sourceRoot":"","sources":["../../../src/components/DarkModeToggle/DarkModeToggle.vue"],"names":[],"mappings":"AAiKA,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE,OAAO,CAAA;IACnB,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,CAAC;;;;;;AA8GF,wBAQG"}
@@ -1,7 +0,0 @@
1
- import o from "./DarkModeToggle.vue2.js";
2
- /* empty css */
3
- import r from "../../_virtual/_plugin-vue_export-helper.js";
4
- const d = /* @__PURE__ */ r(o, [["__scopeId", "data-v-4eddf114"]]);
5
- export {
6
- d as default
7
- };
@@ -1,31 +0,0 @@
1
- import { defineComponent as t, openBlock as o, createElementBlock as d, createElementVNode as r, normalizeClass as s, createStaticVNode as i, createCommentVNode as l } from "vue";
2
- const n = { class: "darklight-reference-switch" }, g = ["aria-pressed"], m = /* @__PURE__ */ t({
3
- __name: "DarkModeToggle",
4
- props: {
5
- isDarkMode: { type: Boolean },
6
- hideDarkModeToggle: { type: Boolean }
7
- },
8
- emits: ["toggleDarkMode"],
9
- setup(c) {
10
- return (a, e) => (o(), d("div", n, [
11
- e[2] || (e[2] = r("a", {
12
- class: "darklight-reference-promo",
13
- href: "https://www.scalar.com",
14
- target: "_blank"
15
- }, " Powered by Scalar ", -1)),
16
- a.hideDarkModeToggle ? l("", !0) : (o(), d("button", {
17
- key: 0,
18
- "aria-label": "Toggle dark mode",
19
- "aria-pressed": a.isDarkMode,
20
- class: s(["darklight", { darklight_dark: a.isDarkMode }]),
21
- type: "button",
22
- onClick: e[0] || (e[0] = (k) => a.$emit("toggleDarkMode"))
23
- }, e[1] || (e[1] = [
24
- i('<div class="darklight-slider" data-v-4eddf114><div class="toggleicon" data-v-4eddf114><i class="toggleicon-sunray" data-v-4eddf114></i><i class="toggleicon-sunray" data-v-4eddf114></i><i class="toggleicon-sunray" data-v-4eddf114></i><i class="toggleicon-sunray" data-v-4eddf114></i><i class="toggleicon-sun" data-v-4eddf114></i></div></div>', 1)
25
- ]), 10, g))
26
- ]));
27
- }
28
- });
29
- export {
30
- m as default
31
- };
@@ -1,3 +0,0 @@
1
- export { default as DarkModeToggle } from './DarkModeToggle.vue.js';
2
- export { default as DarkModeIconToggle } from './DarkModeIconToggle.vue.js';
3
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/DarkModeToggle/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAChE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,0BAA0B,CAAA"}
@@ -1,10 +0,0 @@
1
- import type { Spec, TransformedOperation } from '@scalar/types/legacy';
2
- import type { OpenApiDocumentConfiguration } from '../OpenApiDocument/types';
3
- type __VLS_Props = {
4
- parsedSpec: Spec;
5
- operation: TransformedOperation;
6
- configuration?: OpenApiDocumentConfiguration;
7
- };
8
- declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLDivElement>;
9
- export default _default;
10
- //# sourceMappingURL=ExampleRequest.vue.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ExampleRequest.vue.d.ts","sourceRoot":"","sources":["../../../src/embeds/ExampleRequest/ExampleRequest.vue"],"names":[],"mappings":"AAiEA,OAAO,KAAK,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAGtE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAA;AAI5E,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE,IAAI,CAAA;IAChB,SAAS,EAAE,oBAAoB,CAAA;IAC/B,aAAa,CAAC,EAAE,4BAA4B,CAAA;CAC7C,CAAC;;AA4GF,wBAOG"}
@@ -1,2 +0,0 @@
1
- export { default as ExampleRequest } from './ExampleRequest.vue';
2
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/embeds/ExampleRequest/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,sBAAsB,CAAA"}
@@ -1,7 +0,0 @@
1
- import type { TransformedOperation } from '@scalar/types/legacy';
2
- type __VLS_Props = {
3
- operation?: TransformedOperation;
4
- };
5
- declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLDivElement>;
6
- export default _default;
7
- //# sourceMappingURL=ExampleResponses.vue.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ExampleResponses.vue.d.ts","sourceRoot":"","sources":["../../../src/embeds/ExampleResponses/ExampleResponses.vue"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AAMhE,KAAK,WAAW,GAAG;IACjB,SAAS,CAAC,EAAE,oBAAoB,CAAA;CACjC,CAAC;;AA+DF,wBAOG"}
@@ -1,2 +0,0 @@
1
- export { default as ExampleResponses } from './ExampleResponses.vue';
2
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/embeds/ExampleResponses/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAA"}