@scalar/api-reference 1.25.35 → 1.25.37

package/dist/features/Search/SearchModal.vue2.js

@@ -1,27 +1,24 @@
-import { defineComponent as $, toRef as M, ref as U, watch as k, openBlock as h, createBlock as b, unref as a, withKeys as S, withModifiers as v, withCtx as l, createElementVNode as d, createVNode as g, isRef as q, createTextVNode as I, toDisplayString as f, createElementBlock as L, Fragment as z, renderList as D, createSlots as H, normalizeClass as K, pushScopeId as P, popScopeId as O } from "vue";
-import { ScalarModal as W, ScalarSearchInput as Y, ScalarSearchResultList as j, ScalarSearchResultItem as A } from "@scalar/components";
-import { lazyBus as G } from "../../components/Content/Lazy/lazyBus.js";
-import J from "../../components/Sidebar/SidebarHttpBadge.vue.js";
-import { useSearchIndex as Q } from "./useSearchIndex.js";
-import { useSidebar as X } from "../../hooks/useSidebar.js";
-import { scrollToId as C } from "../../helpers/scrollToId.js";
-const Z = (i) => (P("data-v-fc89d20d"), i = i(), O(), i), y = /* @__PURE__ */ Z(() => /* @__PURE__ */ d("div", { class: "ref-search-meta" }, [
-  /* @__PURE__ */ d("span", null, "↑↓ Navigate"),
-  /* @__PURE__ */ d("span", null, "⏎ Select")
-], -1)), re = /* @__PURE__ */ $({
+import { defineComponent as M, toRef as U, ref as q, watch as I, openBlock as f, createBlock as k, unref as a, withKeys as h, withModifiers as S, withCtx as n, createElementVNode as c, createVNode as v, isRef as L, createTextVNode as g, toDisplayString as p, createElementBlock as z, Fragment as D, renderList as H, createSlots as K, normalizeClass as P } from "vue";
+import { ScalarModal as O, ScalarSearchInput as W, ScalarSearchResultList as Y, ScalarSearchResultItem as j } from "@scalar/components";
+import { lazyBus as A } from "../../components/Content/Lazy/lazyBus.js";
+import G from "../../components/Sidebar/SidebarHttpBadge.vue.js";
+import { useSearchIndex as J } from "./useSearchIndex.js";
+import { useSidebar as Q } from "../../hooks/useSidebar.js";
+import { scrollToId as b } from "../../helpers/scrollToId.js";
+const ae = /* @__PURE__ */ M({
   __name: "SearchModal",
   props: {
     parsedSpec: {},
     modalState: {}
   },
-  setup(i) {
-    const m = i, V = M(m, "parsedSpec"), {
+  setup(C) {
+    const d = C, V = U(d, "parsedSpec"), {
       resetSearch: B,
       fuseSearch: x,
-      selectedSearchResult: n,
-      searchResultsWithPlaceholderResults: c,
-      searchText: p
-    } = Q({
+      selectedSearchResult: r,
+      searchResultsWithPlaceholderResults: i,
+      searchText: m
+    } = J({
       specification: V
     }), F = {
       heading: "DocsPage",
@@ -29,112 +26,112 @@ const Z = (i) => (P("data-v-fc89d20d"), i = i(), O(), i), y = /* @__PURE__ */ Z(
       req: "Terminal",
       tag: "CodeFolder",
       webhook: "Terminal"
-    }, N = U(null);
-    k(
-      () => m.modalState.open,
+    }, N = q(null);
+    I(
+      () => d.modalState.open,
       (o) => {
         o && B();
       }
     );
-    const { setCollapsedSidebarItem: T } = X(), E = /#(tag\/[^/]*)/;
+    const { setCollapsedSidebarItem: T } = Q(), E = /#(tag\/[^/]*)/;
     function R(o) {
       let t = "models";
       const e = o.item.href.match(E);
       e != null && e.length && e.length > 1 && (t = e[1]), T(t, !0);
-      const s = o.item.href.replace("#", "");
-      if (document.getElementById(s))
-        C(s), m.modalState.hide();
+      const l = o.item.href.replace("#", "");
+      if (document.getElementById(l))
+        b(l), d.modalState.hide();
       else {
-        const r = G.on((u) => {
-          u.id === s && (C(s), r(), m.modalState.hide());
+        const s = A.on((u) => {
+          u.id === l && (b(l), s(), d.modalState.hide());
         });
       }
     }
-    k(n, (o) => {
+    I(r, (o) => {
       var e;
-      const t = c.value[o];
+      const t = i.value[o];
       (e = document.getElementById(t.item.href)) == null || e.scrollIntoView({
         behavior: "smooth",
         block: "nearest"
       });
     });
     const w = (o) => {
-      const t = o === "up" ? -1 : 1, e = c.value.length, s = (n.value + t + e) % e;
-      n.value = s;
+      const t = o === "up" ? -1 : 1, e = i.value.length, l = (r.value + t + e) % e;
+      r.value = l;
     };
-    function _(o) {
+    function $(o) {
       const t = new URL(window.location.href);
       return t.hash = o, t.toString();
     }
-    return (o, t) => (h(), b(a(W), {
+    return (o, t) => (f(), k(a(O), {
       state: o.modalState,
       variant: "search",
       onKeydown: [
-        t[1] || (t[1] = S(v((e) => w("down"), ["stop", "prevent"]), ["down"])),
-        t[2] || (t[2] = S(v((e) => R(
-          a(c)[a(n)]
+        t[1] || (t[1] = h(S((e) => w("down"), ["stop", "prevent"]), ["down"])),
+        t[2] || (t[2] = h(S((e) => R(
+          a(i)[a(r)]
         ), ["stop", "prevent"]), ["enter"])),
-        t[3] || (t[3] = S(v((e) => w("up"), ["stop", "prevent"]), ["up"]))
+        t[3] || (t[3] = h(S((e) => w("up"), ["stop", "prevent"]), ["up"]))
       ]
     }, {
-      default: l(() => [
-        d("div", {
+      default: n(() => [
+        c("div", {
           ref_key: "searchModalRef",
           ref: N,
           class: "ref-search-container"
         }, [
-          g(a(Y), {
-            modelValue: a(p),
-            "onUpdate:modelValue": t[0] || (t[0] = (e) => q(p) ? p.value = e : null),
+          v(a(W), {
+            modelValue: a(m),
+            "onUpdate:modelValue": t[0] || (t[0] = (e) => L(m) ? m.value = e : null),
             onInput: a(x)
           }, null, 8, ["modelValue", "onInput"])
         ], 512),
-        g(a(j), {
+        v(a(Y), {
           class: "ref-search-results custom-scroll",
-          noResults: !a(c).length
+          noResults: !a(i).length
         }, {
-          query: l(() => [
-            I(f(a(p)), 1)
+          query: n(() => [
+            g(p(a(m)), 1)
           ]),
-          default: l(() => [
-            (h(!0), L(z, null, D(a(c), (e, s) => (h(), b(a(A), {
+          default: n(() => [
+            (f(!0), z(D, null, H(a(i), (e, l) => (f(), k(a(j), {
               id: e.item.href,
               key: e.refIndex,
-              active: a(n) === s,
-              href: _(e.item.href),
+              active: a(r) === l,
+              href: $(e.item.href),
               icon: F[e.item.type],
-              onClick: (r) => R(e),
-              onFocus: (r) => n.value = s
-            }, H({
-              default: l(() => {
-                var r, u;
+              onClick: (s) => R(e),
+              onFocus: (s) => r.value = l
+            }, K({
+              default: n(() => {
+                var s, u;
                 return [
-                  d("span", {
-                    class: K({
-                      deprecated: (u = (r = e.item.operation) == null ? void 0 : r.information) == null ? void 0 : u.deprecated
+                  c("span", {
+                    class: P({
+                      deprecated: (u = (s = e.item.operation) == null ? void 0 : s.information) == null ? void 0 : u.deprecated
                     })
-                  }, f(e.item.title), 3)
+                  }, p(e.item.title), 3)
                 ];
               }),
               _: 2
             }, [
               (e.item.httpVerb || e.item.path) && e.item.path !== e.item.title ? {
                 name: "description",
-                fn: l(() => [
-                  I(f(e.item.path), 1)
+                fn: n(() => [
+                  g(p(e.item.path), 1)
                 ]),
                 key: "0"
               } : e.item.description ? {
                 name: "description",
-                fn: l(() => [
-                  I(f(e.item.description), 1)
+                fn: n(() => [
+                  g(p(e.item.description), 1)
                 ]),
                 key: "1"
               } : void 0,
               e.item.type === "req" ? {
                 name: "addon",
-                fn: l(() => [
-                  g(J, {
+                fn: n(() => [
+                  v(G, {
                     method: e.item.httpVerb ?? "get"
                   }, null, 8, ["method"])
                 ]),
@@ -144,12 +141,15 @@ const Z = (i) => (P("data-v-fc89d20d"), i = i(), O(), i), y = /* @__PURE__ */ Z(
           ]),
           _: 1
         }, 8, ["noResults"]),
-        y
+        t[4] || (t[4] = c("div", { class: "ref-search-meta" }, [
+          c("span", null, "↑↓ Navigate"),
+          c("span", null, "⏎ Select")
+        ], -1))
       ]),
       _: 1
     }, 8, ["state"]));
   }
 });
 export {
-  re as default
+  ae as default
 };

package/dist/features/Search/useSearchIndex.d.ts

@@ -23,8 +23,8 @@ export declare function useSearchIndex({ specification, }: {
 }): {
     resetSearch: () => void;
     fuseSearch: () => void;
-    selectedSearchResult: Ref<number>;
+    selectedSearchResult: Ref<number, number>;
     searchResultsWithPlaceholderResults: import("vue").ComputedRef<FuseResult<FuseData>[]>;
-    searchText: Ref<string>;
+    searchText: Ref<string, string>;
 };
 //# sourceMappingURL=useSearchIndex.d.ts.map

package/dist/hooks/useDarkModeState.d.ts

@@ -1,6 +1,6 @@
 /** This hook helps with retrieving the dark mode setting from local storage or from system settings. */
 export declare function useDarkModeState(isDarkInitially?: boolean, forceDarkModeState?: 'dark' | 'light'): {
-    isDark: import("vue").Ref<boolean>;
+    isDark: import("vue").Ref<boolean, boolean>;
     toggleDarkMode: () => void;
     setDarkMode: (value: boolean) => void;
 };

package/dist/hooks/useNavState.d.ts

@@ -8,7 +8,7 @@ import type { PathRouting } from '../types';
  * when clicking on sidebar links or going backwards
  */
 export declare const useNavState: () => {
-    hash: import("vue").Ref<string>;
+    hash: import("vue").Ref<string, string>;
     getWebhookId: (name?: string, httpVerb?: string) => string;
     getModelId: (name?: string) => string;
     getHeadingId: (heading: Heading) => string;
@@ -16,8 +16,8 @@ export declare const useNavState: () => {
     getPathRoutingId: (pathName: string) => string;
     getSectionId: (hashStr?: string) => string;
     getTagId: ({ name }: Tag) => string;
-    isIntersectionEnabled: import("vue").Ref<boolean>;
-    pathRouting: import("vue").Ref<PathRouting | undefined>;
+    isIntersectionEnabled: import("vue").Ref<boolean, boolean>;
+    pathRouting: import("vue").Ref<PathRouting | undefined, PathRouting | undefined>;
     updateHash: () => void;
 };
 //# sourceMappingURL=useNavState.d.ts.map

package/dist/hooks/useReactiveSpec.d.ts

@@ -7,7 +7,7 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
     specConfig?: MaybeRefOrGetter<SpecConfiguration>;
     proxy?: MaybeRefOrGetter<string>;
 }): {
-    rawSpec: import("vue").Ref<string>;
+    rawSpec: import("vue").Ref<string, string>;
     parsedSpec: {
         tags?: {
             name: string;
@@ -215,6 +215,6 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
         }[] | undefined;
         security?: import("@scalar/openapi-types").OpenAPIV3.SecurityRequirementObject[] | undefined;
     };
-    specErrors: import("vue").Ref<string | null>;
+    specErrors: import("vue").Ref<string | null, string | null>;
 };
 //# sourceMappingURL=useReactiveSpec.d.ts.map

package/dist/hooks/useRefOnMount.d.ts

@@ -2,5 +2,5 @@ import { type Ref } from 'vue';
 /**
  * Set a ref value on mount when needed to access properties that are not SSR-friendly.
  */
-export declare function useRefOnMount<T>(setter: () => T): Ref<T | null>;
+export declare function useRefOnMount<T>(setter: () => T): Ref<T | null, T | null>;
 //# sourceMappingURL=useRefOnMount.d.ts.map

package/dist/hooks/useRefOnMount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useRefOnMount.d.ts","sourceRoot":"","sources":["../../src/hooks/useRefOnMount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAkB,MAAM,KAAK,CAAA;AAE9C;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,iBAQ/C"}
+{"version":3,"file":"useRefOnMount.d.ts","sourceRoot":"","sources":["../../src/hooks/useRefOnMount.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAkB,MAAM,KAAK,CAAA;AAE9C;;GAEG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,2BAQ/C"}

package/dist/hooks/useSidebar.d.ts

@@ -39,13 +39,13 @@ export declare function useSidebar(options?: ParsedSpecOption & SorterOption): {
         entries: SidebarEntry[];
         titles: Record<string, string>;
     }>;
-    isSidebarOpen: import("vue").Ref<boolean>;
+    isSidebarOpen: import("vue").Ref<boolean, boolean>;
     collapsedSidebarItems: CollapsedSidebarItems;
     toggleCollapsedSidebarItem: typeof toggleCollapsedSidebarItem;
     setCollapsedSidebarItem: typeof setCollapsedSidebarItem;
-    hideModels: import("vue").Ref<boolean>;
+    hideModels: import("vue").Ref<boolean, boolean>;
     setParsedSpec: typeof setParsedSpec;
-    defaultOpenAllTags: import("vue").Ref<boolean>;
+    defaultOpenAllTags: import("vue").Ref<boolean, boolean>;
     scrollToOperation: (operationId: string) => void;
 };
 export {};