@scalar/api-reference 1.25.41 → 1.25.43

package/dist/features/Search/SearchButton.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SearchButton.vue.d.ts","sourceRoot":"","sources":["../../../src/features/Search/SearchButton.vue"],"names":[],"mappings":"AAkIA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;;UAWtC,IAAI;mBACK,MAAM;;UADf,IAAI;mBACK,MAAM;;kBAAN,MAAM;;AA6HzB,wBAOG"}
+{"version":3,"file":"SearchButton.vue.d.ts","sourceRoot":"","sources":["../../../src/features/Search/SearchButton.vue"],"names":[],"mappings":"AAiIA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;;UAWtC,IAAI;mBACK,MAAM;;UADf,IAAI;mBACK,MAAM;;kBAAN,MAAM;;AAgIzB,wBAOG"}

package/dist/features/Search/SearchButton.vue.js

@@ -1,7 +1,7 @@
 import o from "./SearchButton.vue2.js";
 /* empty css                  */
 import t from "../../_virtual/_plugin-vue_export-helper.js";
-const e = /* @__PURE__ */ t(o, [["__scopeId", "data-v-bc475de3"]]);
+const m = /* @__PURE__ */ t(o, [["__scopeId", "data-v-831b7e18"]]);
 export {
-  e as default
+  m as default
 };

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

@@ -1,54 +1,56 @@
-import { defineComponent as h, ref as u, onMounted as f, openBlock as S, createElementBlock as y, Fragment as k, createElementVNode as o, normalizeClass as b, unref as a, createVNode as l, toDisplayString as i } from "vue";
+import { defineComponent as u, ref as h, onMounted as f, openBlock as S, createElementBlock as y, Fragment as b, createElementVNode as o, normalizeClass as k, unref as a, createVNode as c, toDisplayString as i } from "vue";
 import { useModal as v, ScalarIcon as K } from "@scalar/components";
 import { isMacOS as r } from "@scalar/use-tooltip";
-import { useMagicKeys as M, whenever as _ } from "@vueuse/core";
-import { modalStateBus as g } from "../../components/api-client-bus.js";
-import w from "./SearchModal.vue.js";
-const B = { class: "sidebar-search-input" }, C = { class: "sidebar-search-shortcut" }, H = { class: "sidebar-search-key" }, V = /* @__PURE__ */ h({
+import { useMagicKeys as M, whenever as g } from "@vueuse/core";
+import { modalStateBus as w } from "../../components/api-client-bus.js";
+import B from "./SearchModal.vue.js";
+const C = { class: "sidebar-search-input" }, H = { class: "sidebar-search-shortcut" }, E = { class: "sidebar-search-key" }, V = /* @__PURE__ */ u({
   __name: "SearchButton",
   props: {
     spec: {},
     searchHotKey: { default: "k" }
   },
   setup(p) {
-    const n = p, s = v(), c = u(null), d = M({
+    const n = p, t = v(), l = h(null), d = M({
       passive: !1,
       onEventFired(e) {
         !r() && e.ctrlKey && e.key === n.searchHotKey && (e.preventDefault(), e.stopPropagation());
       }
     });
     return f(() => {
-      g.on((e) => {
-        c.value = e;
+      w.on((e) => {
+        l.value = e;
       });
-    }), _(
+    }), g(
       d[`${r() ? "meta" : "control"}_${n.searchHotKey}`],
       () => {
         var e;
-        (e = c.value) != null && e.open || (s.open ? s.hide() : s.show());
+        (e = l.value) != null && e.open || (t.open ? t.hide() : t.show());
       }
-    ), (e, t) => (S(), y(k, null, [
+    ), (e, s) => (S(), y(b, null, [
       o("button", {
-        class: b(["sidebar-search", e.$attrs.class]),
+        class: k(["sidebar-search", e.$attrs.class]),
         type: "button",
-        onClick: t[0] || (t[0] = //@ts-ignore
-        (...m) => a(s).show && a(s).show(...m))
+        onClick: s[0] || (s[0] = //@ts-ignore
+        (...m) => a(t).show && a(t).show(...m))
       }, [
-        l(a(K), {
+        c(a(K), {
           class: "search-icon",
           icon: "Search",
           size: "sm",
           thickness: "2.5"
         }),
-        o("div", B, [
-          t[1] || (t[1] = o("span", { class: "sidebar-search-placeholder" }, "Search", -1)),
-          o("span", C, [
-            o("span", H, i(a(r)() ? "⌘" : "⌃") + i(e.searchHotKey), 1)
+        o("div", C, [
+          s[2] || (s[2] = o("span", { class: "sr-only" }, "Open ", -1)),
+          s[3] || (s[3] = o("span", { class: "sidebar-search-placeholder" }, "Search", -1)),
+          o("span", H, [
+            s[1] || (s[1] = o("span", { class: "sr-only" }, "(Keyboard Shortcut)", -1)),
+            o("kbd", E, i(a(r)() ? "⌘" : "⌃") + i(e.searchHotKey), 1)
           ])
         ])
       ], 2),
-      l(w, {
-        modalState: a(s),
+      c(B, {
+        modalState: a(t),
         parsedSpec: e.spec
       }, null, 8, ["modalState", "parsedSpec"])
     ], 64));

package/dist/features/Search/SearchModal.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SearchModal.vue.d.ts","sourceRoot":"","sources":["../../../src/features/Search/SearchModal.vue"],"names":[],"mappings":"AAiNA,OAAO,EAEL,KAAK,UAAU,EAKhB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;;gBAalC,IAAI;gBACJ,UAAU;;gBADV,IAAI;gBACJ,UAAU;;AAyWxB,wBAMG"}
+{"version":3,"file":"SearchModal.vue.d.ts","sourceRoot":"","sources":["../../../src/features/Search/SearchModal.vue"],"names":[],"mappings":"AAyQA,OAAO,EAEL,KAAK,UAAU,EAKhB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;;gBAclC,IAAI;gBACJ,UAAU;;gBADV,IAAI;gBACJ,UAAU;;AA6ZxB,wBAMG"}

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

@@ -1,7 +1,7 @@
 import o from "./SearchModal.vue2.js";
 /* empty css                 */
 import r from "../../_virtual/_plugin-vue_export-helper.js";
-const d = /* @__PURE__ */ r(o, [["__scopeId", "data-v-fc89d20d"]]);
+const p = /* @__PURE__ */ r(o, [["__scopeId", "data-v-829b4762"]]);
 export {
-  d as default
+  p as default
 };

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

@@ -1,139 +1,171 @@
-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({
+import { defineComponent as O, toRef as W, ref as Y, watch as x, computed as A, openBlock as h, createBlock as B, unref as s, withKeys as R, withModifiers as b, withCtx as i, createElementVNode as r, createVNode as I, isRef as j, createTextVNode as c, toDisplayString as m, createElementBlock as $, Fragment as N, renderList as G, createSlots as J, normalizeClass as Q, createCommentVNode as X } from "vue";
+import { ScalarModal as Z, ScalarSearchInput as _, ScalarSearchResultList as ee, ScalarSearchResultItem as te } from "@scalar/components";
+import { nanoid as oe } from "nanoid";
+import { lazyBus as ae } from "../../components/Content/Lazy/lazyBus.js";
+import se from "../../components/Sidebar/SidebarHttpBadge.vue.js";
+import { useSearchIndex as re } from "./useSearchIndex.js";
+import { useSidebar as ne } from "../../hooks/useSidebar.js";
+import { scrollToId as E } from "../../helpers/scrollToId.js";
+const ie = { class: "sr-only" }, le = { class: "sr-only" }, ve = /* @__PURE__ */ O({
   __name: "SearchModal",
   props: {
     parsedSpec: {},
     modalState: {}
   },
-  setup(C) {
-    const d = C, V = U(d, "parsedSpec"), {
-      resetSearch: B,
-      fuseSearch: x,
-      selectedSearchResult: r,
-      searchResultsWithPlaceholderResults: i,
-      searchText: m
-    } = J({
-      specification: V
-    }), F = {
+  setup(y) {
+    const p = y, F = W(p, "parsedSpec"), S = oe(), k = `${S}-search-result`, v = `${S}-search-instructions`, g = (o) => `${S}${o}`, {
+      resetSearch: q,
+      fuseSearch: D,
+      selectedSearchResult: n,
+      searchResultsWithPlaceholderResults: l,
+      searchText: u
+    } = re({
+      specification: F
+    }), L = {
       heading: "DocsPage",
       model: "Brackets",
       req: "Terminal",
       tag: "CodeFolder",
       webhook: "Terminal"
-    }, N = q(null);
-    I(
-      () => d.modalState.open,
+    }, M = {
+      heading: "Document Heading",
+      model: "",
+      // The title of the entry is already :"Model"
+      req: "Request",
+      tag: "Tag",
+      webhook: "Webhook"
+    }, P = Y(null);
+    x(
+      () => p.modalState.open,
       (o) => {
-        o && B();
+        o && q();
       }
     );
-    const { setCollapsedSidebarItem: T } = Q(), E = /#(tag\/[^/]*)/;
-    function R(o) {
+    const { setCollapsedSidebarItem: H } = ne(), U = /#(tag\/[^/]*)/;
+    function w(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 l = o.item.href.replace("#", "");
-      if (document.getElementById(l))
-        b(l), d.modalState.hide();
+      const e = o.item.href.match(U);
+      e != null && e.length && e.length > 1 && (t = e[1]), H(t, !0);
+      const a = o.item.href.replace("#", "");
+      if (document.getElementById(a))
+        E(a), p.modalState.hide();
       else {
-        const s = A.on((u) => {
-          u.id === l && (b(l), s(), d.modalState.hide());
+        const d = ae.on((f) => {
+          f.id === a && (E(a), d(), p.modalState.hide());
         });
       }
     }
-    I(r, (o) => {
-      var e;
-      const t = i.value[o];
-      (e = document.getElementById(t.item.href)) == null || e.scrollIntoView({
+    x(n, (o) => {
+      var a;
+      const t = l.value[o], e = g(t == null ? void 0 : t.item.href);
+      (a = document.getElementById(e)) == null || a.scrollIntoView({
         behavior: "smooth",
         block: "nearest"
       });
     });
-    const w = (o) => {
-      const t = o === "up" ? -1 : 1, e = i.value.length, l = (r.value + t + e) % e;
-      r.value = l;
+    const z = A(() => {
+      const o = n.value, t = l.value[o];
+      return g(t == null ? void 0 : t.item.href);
+    }), V = (o) => {
+      const t = o === "up" ? -1 : 1, e = l.value.length, a = (n.value + t + e) % e;
+      n.value = a;
     };
-    function $(o) {
+    function K(o) {
       const t = new URL(window.location.href);
       return t.hash = o, t.toString();
     }
-    return (o, t) => (f(), k(a(O), {
+    return (o, t) => (h(), B(s(Z), {
       state: o.modalState,
       variant: "search",
       onKeydown: [
-        t[1] || (t[1] = h(S((e) => w("down"), ["stop", "prevent"]), ["down"])),
-        t[2] || (t[2] = h(S((e) => R(
-          a(i)[a(r)]
+        t[1] || (t[1] = R(b((e) => V("down"), ["stop", "prevent"]), ["down"])),
+        t[2] || (t[2] = R(b((e) => w(
+          s(l)[s(n)]
         ), ["stop", "prevent"]), ["enter"])),
-        t[3] || (t[3] = h(S((e) => w("up"), ["stop", "prevent"]), ["up"]))
+        t[3] || (t[3] = R(b((e) => V("up"), ["stop", "prevent"]), ["up"]))
       ]
     }, {
-      default: n(() => [
-        c("div", {
+      default: i(() => [
+        r("div", {
           ref_key: "searchModalRef",
-          ref: N,
-          class: "ref-search-container"
+          ref: P,
+          "aria-label": "Reference Search",
+          class: "ref-search-container",
+          role: "search"
         }, [
-          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"])
+          I(s(_), {
+            modelValue: s(u),
+            "onUpdate:modelValue": t[0] || (t[0] = (e) => j(u) ? u.value = e : null),
+            "aria-activedescendant": z.value,
+            "aria-controls": k,
+            "aria-describedby": v,
+            onInput: s(D)
+          }, null, 8, ["modelValue", "aria-activedescendant", "onInput"])
         ], 512),
-        v(a(Y), {
+        I(s(ee), {
+          id: k,
+          "aria-describedby": v,
+          "aria-label": "Reference Search Results",
           class: "ref-search-results custom-scroll",
-          noResults: !a(i).length
+          noResults: !s(l).length
         }, {
-          query: n(() => [
-            g(p(a(m)), 1)
+          query: i(() => [
+            c(m(s(u)), 1)
           ]),
-          default: n(() => [
-            (f(!0), z(D, null, H(a(i), (e, l) => (f(), k(a(j), {
-              id: e.item.href,
+          default: i(() => [
+            (h(!0), $(N, null, G(s(l), (e, a) => (h(), B(s(te), {
+              id: g(e.item.href),
               key: e.refIndex,
-              active: a(r) === l,
-              href: $(e.item.href),
-              icon: F[e.item.type],
-              onClick: (s) => R(e),
-              onFocus: (s) => r.value = l
-            }, K({
-              default: n(() => {
-                var s, u;
+              active: s(n) === a,
+              href: K(e.item.href),
+              icon: L[e.item.type],
+              onClick: (d) => w(e),
+              onFocus: (d) => n.value = a
+            }, J({
+              default: i(() => {
+                var d, f, C, T;
                 return [
-                  c("span", {
-                    class: P({
-                      deprecated: (u = (s = e.item.operation) == null ? void 0 : s.information) == null ? void 0 : u.deprecated
+                  r("span", {
+                    class: Q({
+                      deprecated: (f = (d = e.item.operation) == null ? void 0 : d.information) == null ? void 0 : f.deprecated
                     })
-                  }, p(e.item.title), 3)
+                  }, [
+                    r("span", ie, [
+                      c(m(M[e.item.type]) + ":  ", 1),
+                      (T = (C = e.item.operation) == null ? void 0 : C.information) != null && T.deprecated ? (h(), $(N, { key: 0 }, [
+                        c(" (Deprecated)  ")
+                      ], 64)) : X("", !0)
+                    ]),
+                    c(" " + m(e.item.title) + " ", 1),
+                    t[4] || (t[4] = r("span", { class: "sr-only" }, ",", -1))
+                  ], 2)
                 ];
               }),
               _: 2
             }, [
               (e.item.httpVerb || e.item.path) && e.item.path !== e.item.title ? {
                 name: "description",
-                fn: n(() => [
-                  g(p(e.item.path), 1)
+                fn: i(() => [
+                  t[5] || (t[5] = r("span", { class: "sr-only" }, "Path: ", -1)),
+                  c(" " + m(e.item.path), 1)
                 ]),
                 key: "0"
               } : e.item.description ? {
                 name: "description",
-                fn: n(() => [
-                  g(p(e.item.description), 1)
+                fn: i(() => [
+                  t[6] || (t[6] = r("span", { class: "sr-only" }, "Description: ", -1)),
+                  c(" " + m(e.item.description), 1)
                 ]),
                 key: "1"
               } : void 0,
               e.item.type === "req" ? {
                 name: "addon",
-                fn: n(() => [
-                  v(G, {
+                fn: i(() => [
+                  I(se, {
+                    "aria-hidden": "true",
                     method: e.item.httpVerb ?? "get"
-                  }, null, 8, ["method"])
+                  }, null, 8, ["method"]),
+                  r("span", le, " HTTP Method: " + m(e.item.httpVerb ?? "get") + ", ", 1)
                 ]),
                 key: "2"
               } : void 0
@@ -141,15 +173,19 @@ const ae = /* @__PURE__ */ M({
           ]),
           _: 1
         }, 8, ["noResults"]),
-        t[4] || (t[4] = c("div", { class: "ref-search-meta" }, [
-          c("span", null, "↑↓ Navigate"),
-          c("span", null, "⏎ Select")
-        ], -1))
+        t[7] || (t[7] = r("div", { class: "ref-search-meta" }, [
+          r("span", null, "↑↓ Navigate"),
+          r("span", null, "⏎ Select")
+        ], -1)),
+        r("div", {
+          id: v,
+          class: "sr-only"
+        }, " Press up arrow / down arrow to navigate, enter to select, type to filter results ")
       ]),
       _: 1
     }, 8, ["state"]));
   }
 });
 export {
-  ae as default
+  ve as default
 };