@scalar/api-reference 1.28.25 → 1.28.26

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 (6) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/browser/standalone.js +13901 -13899
  3. package/dist/browser/webpack-stats.json +1 -1
  4. package/dist/hooks/useMultipleDocuments.d.ts +12 -94
  5. package/dist/hooks/useMultipleDocuments.d.ts.map +1 -1
  6. package/package.json +11 -11
package/dist/hooks/useMultipleDocuments.d.ts CHANGED
@@ -14,100 +14,18 @@ type UseMultipleDocumentsProps = {
14
14
  * Take any configuration and return a flat array of configurations.
15
15
  */
16
16
  export declare const normalizeConfigurations: (configuration: AnyApiReferenceConfiguration | undefined) => SpecConfiguration[];
17
- export declare const useMultipleDocuments: ({ configuration, initialIndex, isIntersectionEnabled, hash, hashPrefix, }: UseMultipleDocumentsProps) => {
18
- selectedConfiguration: import("vue").ComputedRef<{
19
- url?: string | undefined;
20
- content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
21
- title?: string | undefined;
22
- slug?: string | undefined;
23
- default?: boolean;
24
- hideClientButton?: boolean | undefined;
25
- showSidebar?: boolean | undefined;
26
- theme?: "default" | "alternate" | "moon" | "purple" | "solarized" | "bluePlanet" | "deepSpace" | "saturn" | "kepler" | "elysiajs" | "fastify" | "mars" | "laserwave" | "none" | undefined;
27
- layout?: "modern" | "classic" | undefined;
28
- isEditable?: boolean | undefined;
29
- isLoading?: boolean | undefined;
30
- hideModels?: boolean | undefined;
31
- hideDownloadButton?: boolean | undefined;
32
- hideTestRequestButton?: boolean | undefined;
33
- hideSearch?: boolean | undefined;
34
- hideDarkModeToggle?: boolean | undefined;
35
- withDefaultFonts?: boolean | undefined;
36
- authentication?: any;
37
- baseServerURL?: string | undefined;
38
- proxyUrl?: string | undefined;
39
- searchHotKey?: "c" | "r" | "o" | "n" | "a" | "b" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "p" | "q" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | undefined;
40
- servers?: any[] | undefined;
41
- _integration?: "go" | "elysiajs" | "fastify" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "vue" | null | undefined;
42
- onRequestSent?: ((args_0: string, ...args: unknown[]) => void) | undefined;
43
- plugins?: ((...args: unknown[]) => {
44
- name: string;
45
- extensions: {
46
- name: string;
47
- component?: unknown;
48
- }[];
49
- })[] | undefined;
50
- darkMode?: boolean | undefined;
51
- forceDarkModeState?: "dark" | "light" | undefined;
52
- metaData?: any;
53
- favicon?: string | undefined;
54
- hiddenClients?: true | string[] | Record<string, boolean | string[]> | undefined;
55
- defaultHttpClient?: {
56
- targetKey: "c" | "clojure" | "csharp" | "go" | "http" | "java" | "js" | "kotlin" | "node" | "objc" | "ocaml" | "php" | "powershell" | "python" | "r" | "ruby" | "shell" | "swift" | "dart";
57
- clientKey: string;
58
- } | undefined;
59
- customCss?: string | undefined;
60
- onSpecUpdate?: ((args_0: string, ...args: unknown[]) => void) | undefined;
61
- onServerChange?: ((args_0: string, ...args: unknown[]) => void) | undefined;
62
- onDocumentSelect?: ((...args: unknown[]) => void | Promise<void>) | undefined;
63
- onLoaded?: ((...args: unknown[]) => void | Promise<void>) | undefined;
64
- onShowMore?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
65
- onSidebarClick?: ((args_0: string, ...args: unknown[]) => void | Promise<void>) | undefined;
66
- pathRouting?: {
67
- basePath: string;
68
- } | undefined;
69
- generateHeadingSlug?: ((args_0: {
70
- slug?: string | undefined;
71
- }, ...args: unknown[]) => string) | undefined;
72
- generateModelSlug?: ((args_0: {
73
- name?: string | undefined;
74
- }, ...args: unknown[]) => string) | undefined;
75
- generateTagSlug?: ((args_0: {
76
- name?: string | undefined;
77
- }, ...args: unknown[]) => string) | undefined;
78
- generateOperationSlug?: ((args_0: {
79
- path: string;
80
- method: string;
81
- operationId?: string | undefined;
82
- summary?: string | undefined;
83
- }, ...args: unknown[]) => string) | undefined;
84
- generateWebhookSlug?: ((args_0: {
85
- name: string;
86
- method?: string | undefined;
87
- }, ...args: unknown[]) => string) | undefined;
88
- redirect?: ((args_0: string, ...args: unknown[]) => string | null | undefined) | undefined;
89
- defaultOpenAllTags?: boolean | undefined;
90
- tagsSorter?: "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
91
- operationsSorter?: "method" | "alpha" | ((args_0: any, args_1: any, ...args: unknown[]) => number) | undefined;
92
- sources?: ({
93
- url?: string | undefined;
94
- content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
95
- title?: string | undefined;
96
- slug?: string | undefined;
97
- } & {
98
- default?: boolean;
99
- })[] | undefined;
100
- }>;
101
- availableDocuments: import("vue").ComputedRef<{
102
- url?: string | undefined;
103
- content?: string | Record<string, any> | ((...args: unknown[]) => Record<string, any>) | null | undefined;
104
- title?: string | undefined;
105
- slug?: string | undefined;
106
- }[]>;
107
- selectedDocumentIndex: Ref<number, number>;
108
- isIntersectionEnabled: Ref<boolean, boolean>;
109
- hash: Ref<string, string>;
110
- hashPrefix: Ref<string, string>;
17
+ export declare const useMultipleDocuments: ({ configuration, initialIndex, isIntersectionEnabled, hash, hashPrefix, }: UseMultipleDocumentsProps) =>
18
+ /**
19
+ * This was needed for a the bug: The inferred type of 'useMultipleDocuments' cannot be named without a reference to
20
+ * A limitation of typescript
21
+ */
22
+ {
23
+ selectedConfiguration: Ref<SpecConfiguration>;
24
+ availableDocuments: Ref<SpecConfiguration[]>;
25
+ selectedDocumentIndex: Ref<number>;
26
+ isIntersectionEnabled: Ref<boolean>;
27
+ hash: Ref<string>;
28
+ hashPrefix: Ref<string>;
111
29
  };
112
30
  export {};
113
31
  //# sourceMappingURL=useMultipleDocuments.d.ts.map
package/dist/hooks/useMultipleDocuments.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"useMultipleDocuments.d.ts","sourceRoot":"","sources":["../../src/hooks/useMultipleDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EAEvB,MAAM,6BAA6B,CAAA;AAGpC,OAAO,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AAKpD,KAAK,yBAAyB,GAAG;IAC/B;;;OAGG;IACH,aAAa,EAAE,GAAG,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IAC5D,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,QAAQ,CAAA;AAIZ;;GAEG;AACH,eAAO,MAAM,uBAAuB,kBACnB,4BAA4B,GAAG,SAAS,KACtD,iBAAiB,EA6BnB,CAAA;AA0CD,eAAO,MAAM,oBAAoB,8EAM9B,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;0CAmIgooB,GAAI;oBAAuF,GAAG;;;;yBAAiH,CAAC;;;;;;;;;;;;;yCAAymB,GAAI;2CAA6E,GAAI;6BAAgE,GAAG;qBAAwE,GAAG;uCAAyF,GAAI;2CAA6F,GAAI;;;;;gBAA0K,CAAC;WAA4B,GAAI;;gBAAyF,CAAC;WAA4B,GAAI;;gBAAuF,CAAC;WAA4B,GAAI;;;;uBAAkJ,CAAC;mBAAqC,CAAC;WAA4B,GAAI;;;kBAAmH,CAAC;WAA4B,GAAI;qCAAyE,GAAI;;2DAAgK,GAAI;4EAAgH,GAAI;;;uDApLl9sB,GAAG;;;;;;;;;mDAAH,GAAG;;;;;;;;CAmLrD,CAAA"}
1
+ {"version":3,"file":"useMultipleDocuments.d.ts","sourceRoot":"","sources":["../../src/hooks/useMultipleDocuments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAA;AAEnD,OAAO,EACL,KAAK,4BAA4B,EACjC,KAAK,iBAAiB,EAEvB,MAAM,6BAA6B,CAAA;AAGpC,OAAO,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AAKpD,KAAK,yBAAyB,GAAG;IAC/B;;;OAGG;IACH,aAAa,EAAE,GAAG,CAAC,4BAA4B,GAAG,SAAS,CAAC,CAAA;IAC5D,2FAA2F;IAC3F,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,GAAG,QAAQ,CAAA;AAIZ;;GAEG;AACH,eAAO,MAAM,uBAAuB,kBACnB,4BAA4B,GAAG,SAAS,KACtD,iBAAiB,EA6BnB,CAAA;AA0CD,eAAO,MAAM,oBAAoB,8EAM9B,yBAAyB;AAkIxB;;;GAGG;AACH;IACE,qBAAqB,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAA;IAC7C,kBAAkB,EAAE,GAAG,CAAC,iBAAiB,EAAE,CAAC,CAAA;IAC5C,qBAAqB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAClC,qBAAqB,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACnC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACjB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAE5B,CAAA"}
package/package.json CHANGED
@@ -20,7 +20,7 @@
20
20
  "vue",
21
21
  "vue3"
22
22
  ],
23
- "version": "1.28.25",
23
+ "version": "1.28.26",
24
24
  "engines": {
25
25
  "node": ">=18"
26
26
  },
@@ -57,18 +57,18 @@
57
57
  "nanoid": "^5.1.5",
58
58
  "vue": "^3.5.12",
59
59
  "zod": "^3.23.8",
60
- "@scalar/api-client": "2.3.25",
61
- "@scalar/components": "0.13.52",
60
+ "@scalar/api-client": "2.3.26",
62
61
  "@scalar/code-highlight": "0.0.27",
63
- "@scalar/icons": "0.3.1",
62
+ "@scalar/components": "0.13.53",
63
+ "@scalar/icons": "0.3.2",
64
64
  "@scalar/openapi-parser": "0.10.16",
65
- "@scalar/oas-utils": "0.2.135",
65
+ "@scalar/oas-utils": "0.2.136",
66
66
  "@scalar/openapi-types": "0.2.1",
67
67
  "@scalar/snippetz": "0.2.19",
68
- "@scalar/types": "0.1.10",
69
- "@scalar/use-hooks": "0.1.44",
70
- "@scalar/themes": "0.10.2",
71
- "@scalar/use-toasts": "0.7.9"
68
+ "@scalar/types": "0.1.11",
69
+ "@scalar/use-hooks": "0.1.45",
70
+ "@scalar/use-toasts": "0.7.9",
71
+ "@scalar/themes": "0.10.3"
72
72
  },
73
73
  "devDependencies": {
74
74
  "@vitejs/plugin-vue": "^5.0.4",
@@ -82,8 +82,8 @@
82
82
  "vite-plugin-banner": "^0.7.1",
83
83
  "vite-plugin-css-injected-by-js": "^3.4.0",
84
84
  "vitest": "^1.6.0",
85
- "@scalar/build-tooling": "0.1.17",
86
- "@scalar/galaxy": "0.3.1"
85
+ "@scalar/galaxy": "0.3.1",
86
+ "@scalar/build-tooling": "0.1.17"
87
87
  },
88
88
  "scripts": {
89
89
  "analyze:default": "pnpm dlx vite-bundle-visualizer",