@scalar/api-reference 1.36.2 → 1.38.0

package/dist/v2/blocks/scalar-sidebar-block/components/SidebarBlock.vue2.js

@@ -1,126 +1,131 @@
-import { defineComponent as O, ref as y, watch as N, onMounted as L, onUnmounted as F, createElementBlock as n, openBlock as i, renderSlot as T, createElementVNode as C, createVNode as G, withCtx as v, Fragment as d, renderList as m, unref as a, createBlock as u, toDisplayString as V, createCommentVNode as A } from "vue";
+import { defineComponent as O, ref as y, watch as N, onMounted as L, onUnmounted as F, createElementBlock as r, openBlock as i, renderSlot as T, createElementVNode as C, createVNode as G, withCtx as f, Fragment as d, renderList as m, unref as l, createBlock as u, toDisplayString as V, createCommentVNode as A } from "vue";
 import { sleep as $ } from "@scalar/helpers/testing/sleep";
 import { useNavState as M } from "../../../../hooks/useNavState.js";
-import { useSidebar as x } from "../hooks/useSidebar.js";
+import { useSidebar as D } from "../hooks/useSidebar.js";
 import h from "./SidebarElement.vue.js";
-import _ from "./SidebarGroup.vue.js";
-const D = { class: "sidebar" }, H = ["aria-label"], R = { class: "sidebar-group-title" }, U = -160, W = /* @__PURE__ */ O({
+import g from "./SidebarGroup.vue.js";
+const H = { class: "sidebar" }, R = ["aria-label"], U = { class: "sidebar-group-title" }, j = -160, X = /* @__PURE__ */ O({
   __name: "SidebarBlock",
   props: {
-    title: {}
+    title: {},
+    options: {}
   },
-  setup(j) {
-    const { hash: o, isIntersectionEnabled: w } = M(), { items: B, toggleCollapsedSidebarItem: g, collapsedSidebarItems: E } = x(), c = y(null), l = y(!0);
-    N(o, (t) => {
-      !w.value || l.value || typeof window > "u" || S(t);
+  setup(q) {
+    const { hash: a, isIntersectionEnabled: w } = M(), { items: B, toggleCollapsedSidebarItem: _, collapsedSidebarItems: E } = D(), c = y(null), n = y(!0);
+    N(a, (e) => {
+      !w.value || n.value || typeof window > "u" || S(e);
     });
-    const S = (t) => {
-      const s = document.getElementById(`sidebar-${t}`);
+    const S = (e) => {
+      const s = document.getElementById(`sidebar-${e}`);
       if (!s || !c.value)
         return;
-      let e = U;
-      s.getAttribute("data-sidebar-type") === "heading" ? e += s.offsetTop + (s.getElementsByClassName("sidebar-heading")?.[0]).offsetHeight : e += s.offsetTop + (s.parentElement?.offsetTop ?? 0) + (s.parentElement?.parentElement?.offsetTop ?? 0), c.value.scrollTo({ top: e, behavior: "smooth" });
-    }, I = (t) => {
+      let t = j;
+      s.getAttribute("data-sidebar-type") === "heading" ? t += s.offsetTop + (s.getElementsByClassName("sidebar-heading")?.[0]).offsetHeight : t += s.offsetTop + (s.parentElement?.offsetTop ?? 0) + (s.parentElement?.parentElement?.offsetTop ?? 0), c.value.scrollTo({ top: t, behavior: "smooth" });
+    }, I = (e) => {
       if (!c.value)
         return;
-      const s = new MutationObserver((e, r) => {
-        document.getElementById(`sidebar-${t}`) && (S(t), l.value = !1, r.disconnect());
+      const s = new MutationObserver((t, o) => {
+        document.getElementById(`sidebar-${e}`) && (S(e), n.value = !1, o.disconnect());
       });
       return s.observe(c.value, {
         childList: !0,
         subtree: !0
       }), s;
-    }, p = (t) => o.value === t ? !0 : o.value.includes("/description/") ? o.value.split("/description/")[0] === t : !1, k = y(void 0);
+    }, v = (e) => a.value === e ? !0 : a.value.includes("/description/") ? a.value.split("/description/")[0] === e : !1, k = y(void 0);
     L(() => {
-      k.value = I(o.value), o.value || setTimeout(() => l.value = !1, 300);
+      k.value = I(a.value), a.value || setTimeout(() => n.value = !1, 300);
     }), F(() => {
       k.value?.disconnect();
     });
-    const b = (t) => (t.type === "tag" || t.type === "text") && (t.children?.length ?? 0) > 0;
-    return (t, s) => (i(), n("div", D, [
-      T(t.$slots, "sidebar-start", {}, void 0, !0),
+    const b = (e) => (e.type === "tag" || e.type === "text") && (e.children?.length ?? 0) > 0;
+    return (e, s) => (i(), r("div", H, [
+      T(e.$slots, "sidebar-start", {}, void 0, !0),
       C("nav", {
         ref_key: "scrollerEl",
         ref: c,
-        "aria-label": `Table of contents for ${t.title}`,
+        "aria-label": `Table of contents for ${e.title}`,
         class: "sidebar-pages custom-scroll custom-scroll-self-contain-overflow"
       }, [
-        G(_, { level: 0 }, {
-          default: v(() => [
-            (i(!0), n(d, null, m(a(B).entries, (e) => (i(), n(d, {
-              key: e.id
+        G(g, { level: 0 }, {
+          default: f(() => [
+            (i(!0), r(d, null, m(l(B).entries, (t) => (i(), r(d, {
+              key: t.id
             }, [
-              "isGroup" in e && e.isGroup ? (i(), n(d, { key: 0 }, [
-                C("li", R, V(e.title), 1),
-                (i(!0), n(d, null, m(e.children, (r) => (i(), u(h, {
-                  key: r.id,
-                  id: `sidebar-${r.id}`,
+              "isGroup" in t && t.isGroup ? (i(), r(d, { key: 0 }, [
+                C("li", U, V(t.title), 1),
+                (i(!0), r(d, null, m(t.children, (o) => (i(), u(h, {
+                  key: o.id,
+                  id: `sidebar-${o.id}`,
                   "data-sidebar-type": "heading",
-                  hasChildren: b(r),
-                  isActive: p(r.id),
-                  item: r,
-                  open: a(E)[r.id] ?? !1,
+                  hasChildren: b(o),
+                  isActive: v(o.id),
+                  item: o,
+                  open: l(E)[o.id] ?? !1,
+                  options: e.options,
                   onToggleOpen: async () => {
-                    l.value = !0, a(g)(r.id), await a($)(100), l.value = !1;
+                    n.value = !0, l(_)(o.id), await l($)(100), n.value = !1;
                   }
                 }, {
-                  default: v(() => [
-                    b(r) ? (i(), u(_, {
+                  default: f(() => [
+                    b(o) ? (i(), u(g, {
                       key: 0,
                       level: 1
                     }, {
-                      default: v(() => [
-                        (i(!0), n(d, null, m(r.children, (f) => (i(), u(h, {
-                          key: f.id,
-                          id: `sidebar-${f.id}`,
-                          isActive: p(f.id),
-                          item: f
-                        }, null, 8, ["id", "isActive", "item"]))), 128))
+                      default: f(() => [
+                        (i(!0), r(d, null, m(o.children, (p) => (i(), u(h, {
+                          key: p.id,
+                          id: `sidebar-${p.id}`,
+                          isActive: v(p.id),
+                          item: p,
+                          options: e.options
+                        }, null, 8, ["id", "isActive", "item", "options"]))), 128))
                       ]),
                       _: 2
                     }, 1024)) : A("", !0)
                   ]),
                   _: 2
-                }, 1032, ["id", "hasChildren", "isActive", "item", "open", "onToggleOpen"]))), 128))
+                }, 1032, ["id", "hasChildren", "isActive", "item", "open", "options", "onToggleOpen"]))), 128))
               ], 64)) : (i(), u(h, {
                 key: 1,
-                id: `sidebar-${e.id}`,
+                id: `sidebar-${t.id}`,
                 "data-sidebar-type": "heading",
-                hasChildren: b(e),
-                isActive: p(e.id),
-                item: e,
-                open: a(E)[e.id] ?? !1,
+                hasChildren: b(t),
+                isActive: v(t.id),
+                item: t,
+                open: l(E)[t.id] ?? !1,
+                options: e.options,
                 onToggleOpen: async () => {
-                  l.value = !0, a(g)(e.id), await a($)(100), l.value = !1;
+                  n.value = !0, l(_)(t.id), await l($)(100), n.value = !1;
                 }
               }, {
-                default: v(() => [
-                  b(e) ? (i(), u(_, {
+                default: f(() => [
+                  b(t) ? (i(), u(g, {
                     key: 0,
                     level: 1
                   }, {
-                    default: v(() => [
-                      (i(!0), n(d, null, m(e.children, (r) => (i(), u(h, {
-                        key: r.id,
-                        id: `sidebar-${r.id}`,
-                        isActive: p(r.id),
-                        item: r
-                      }, null, 8, ["id", "isActive", "item"]))), 128))
+                    default: f(() => [
+                      (i(!0), r(d, null, m(t.children, (o) => (i(), u(h, {
+                        key: o.id,
+                        id: `sidebar-${o.id}`,
+                        isActive: v(o.id),
+                        item: o,
+                        options: e.options
+                      }, null, 8, ["id", "isActive", "item", "options"]))), 128))
                     ]),
                     _: 2
                   }, 1024)) : A("", !0)
                 ]),
                 _: 2
-              }, 1032, ["id", "hasChildren", "isActive", "item", "open", "onToggleOpen"]))
+              }, 1032, ["id", "hasChildren", "isActive", "item", "open", "options", "onToggleOpen"]))
             ], 64))), 128))
           ]),
           _: 1
         })
-      ], 8, H),
-      T(t.$slots, "sidebar-end", {}, void 0, !0)
+      ], 8, R),
+      T(e.$slots, "sidebar-end", {}, void 0, !0)
     ]));
   }
 });
 export {
-  W as default
+  X as default
 };

package/dist/v2/blocks/scalar-sidebar-block/components/SidebarElement.vue.d.ts

@@ -1,10 +1,18 @@
-import type { TraversedEntry } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
+import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
 type __VLS_Props = {
     id: string;
     item: TraversedEntry;
     isActive?: boolean;
     hasChildren?: boolean;
     open?: boolean;
+    options: {
+        pathRouting?: {
+            basePath?: string;
+        };
+        onSidebarClick: ((id: string) => void) | undefined;
+        operationTitleSource: 'path' | 'summary' | undefined;
+        defaultOpenAllTags: boolean | undefined;
+    };
 };
 declare var __VLS_12: {}, __VLS_14: {};
 type __VLS_Slots = {} & {

package/dist/v2/blocks/scalar-sidebar-block/components/SidebarElement.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SidebarElement.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-sidebar-block/components/SidebarElement.vue"],"names":[],"mappings":"AAyXA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,8DAA8D,CAAA;AAOlG,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,IAAI,CAAC,EAAE,OAAO,CAAA;CACf,CAAC;AA4RF,QAAA,IAAI,QAAQ,IAAW,EAAE,QAAQ,IAAY,CAAE;AAC/C,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,GAC7C;IAAE,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,CAAC;AA6BtD,QAAA,MAAM,eAAe;;;;kFAOnB,CAAC;wBACkB,eAAe,CAAC,OAAO,eAAe,EAAE,WAAW,CAAC;AAAzE,wBAA0E;AAQ1E,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}
+{"version":3,"file":"SidebarElement.vue.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-sidebar-block/components/SidebarElement.vue"],"names":[],"mappings":"AAgYA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAMhF,KAAK,WAAW,GAAG;IACjB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,cAAc,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,OAAO,EAAE;QACP,WAAW,CAAC,EAAE;YACZ,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CAAA;QACD,cAAc,EAAE,CAAC,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,GAAG,SAAS,CAAA;QAClD,oBAAoB,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;QACpD,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAA;KACxC,CAAA;CACF,CAAC;AA4RF,QAAA,IAAI,QAAQ,IAAW,EAAE,QAAQ,IAAY,CAAE;AAC/C,KAAK,WAAW,GAAG,EAAE,GACnB;IAAE,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,GAC7C;IAAE,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,QAAQ,KAAK,GAAG,CAAA;CAAE,CAAC;AA4BtD,QAAA,MAAM,eAAe;;;;kFAOnB,CAAC;wBACkB,eAAe,CAAC,OAAO,eAAe,EAAE,WAAW,CAAC;AAAzE,wBAA0E;AAQ1E,KAAK,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAChC,QAAO;QACN,MAAM,EAAE,CAAC,CAAC;KAEV,CAAA;CACD,CAAC"}

package/dist/v2/blocks/scalar-sidebar-block/components/SidebarElement.vue.js

@@ -1,7 +1,7 @@
 import o from "./SidebarElement.vue2.js";
 /* empty css                    */
 import t from "../../../../_virtual/_plugin-vue_export-helper.js";
-const m = /* @__PURE__ */ t(o, [["__scopeId", "data-v-b9da5e03"]]);
+const a = /* @__PURE__ */ t(o, [["__scopeId", "data-v-43553cbe"]]);
 export {
-  m as default
+  a as default
 };

package/dist/v2/blocks/scalar-sidebar-block/components/SidebarElement.vue2.js

@@ -1,99 +1,102 @@
-import { defineComponent as B, createElementBlock as a, openBlock as o, createElementVNode as r, renderSlot as g, createCommentVNode as s, normalizeClass as A, unref as l, createTextVNode as h, withModifiers as O, createVNode as f, withCtx as b, toDisplayString as p, createBlock as $, normalizeStyle as E } from "vue";
-import { ScalarSidebarGroupToggle as N } from "@scalar/components";
-import { scrollToId as V } from "@scalar/helpers/dom/scroll-to-id";
-import { getHttpMethodInfo as H } from "@scalar/helpers/http/http-info";
-import { sleep as k } from "@scalar/helpers/testing/sleep";
-import { ScalarIconWebhooksLogo as I } from "@scalar/icons";
-import { combineUrlAndPath as P } from "@scalar/oas-utils/helpers";
-import { useConfig as R } from "../../../../hooks/useConfig.js";
-import { useNavState as U } from "../../../../hooks/useNavState.js";
-import D from "./SidebarHttpBadge.vue.js";
-const L = ["id"], M = {
+import { defineComponent as T, createElementBlock as n, openBlock as o, createElementVNode as a, renderSlot as c, createCommentVNode as s, normalizeClass as B, createTextVNode as p, withModifiers as A, createVNode as g, unref as h, withCtx as f, toDisplayString as l, createBlock as O, normalizeStyle as $ } from "vue";
+import { ScalarSidebarGroupToggle as E } from "@scalar/components";
+import { scrollToId as N } from "@scalar/helpers/dom/scroll-to-id";
+import { getHttpMethodInfo as V } from "@scalar/helpers/http/http-info";
+import { sleep as b } from "@scalar/helpers/testing/sleep";
+import { ScalarIconWebhooksLogo as H } from "@scalar/icons";
+import { combineUrlAndPath as I } from "@scalar/oas-utils/helpers";
+import { useNavState as P } from "../../../../hooks/useNavState.js";
+import R from "./SidebarHttpBadge.vue.js";
+const U = ["id"], D = {
   key: 0,
   class: "sidebar-heading-chevron"
-}, z = ["aria-expanded"], j = ["href", "tabindex"], F = { class: "sidebar-heading-link-title" }, G = {
+}, L = ["aria-expanded"], M = ["href", "tabindex"], z = { class: "sidebar-heading-link-title" }, j = {
   key: 0,
   class: "hanging-indent"
-}, W = { key: 1 }, q = {
+}, F = { key: 1 }, G = {
   key: 0,
   class: "sidebar-heading-link-method"
-}, J = {
+}, W = {
   key: 1,
   class: "action-menu"
-}, ie = /* @__PURE__ */ B({
+}, ee = /* @__PURE__ */ T({
   __name: "SidebarElement",
   props: {
     id: {},
     item: {},
     isActive: { type: Boolean },
     hasChildren: { type: Boolean },
-    open: { type: Boolean }
+    open: { type: Boolean },
+    options: {}
   },
   emits: ["toggleOpen"],
-  setup(y, { emit: v }) {
-    const t = y, m = v, { getFullHash: u, isIntersectionEnabled: d, replaceUrlState: C } = U(), i = R(), w = (e) => "path" in e ? e.path.replace(/\//g, "/​") : e.title, c = async () => {
-      d.value = !1, t.hasChildren && m("toggleOpen"), await k(100), d.value = !0;
-    }, S = () => {
-      if (i.value.pathRouting)
-        return P(i.value.pathRouting.basePath, t.item.id);
+  setup(k, { emit: y }) {
+    const t = k, d = y, { getFullHash: m, isIntersectionEnabled: r, replaceUrlState: C } = P(), v = (e) => "path" in e ? e.path.replace(/\//g, "/​") : e.title, u = async () => {
+      r.value = !1, t.hasChildren && d("toggleOpen"), await b(100), r.value = !0;
+    }, w = () => {
+      if (t.options.pathRouting)
+        return I(
+          t.options.pathRouting?.basePath ?? "",
+          t.item.id
+        );
       if (typeof window < "u") {
         const e = new URL(window.location.href);
-        return e.hash = u(t.item.id), `${e.search}${e.hash}`;
+        return e.hash = m(t.item.id), `${e.search}${e.hash}`;
       }
-      return `#${u(t.item.id)}`;
-    }, T = async (e) => {
-      i.value.onSidebarClick?.(t.item.id), i.value.pathRouting && (e.preventDefault(), t.hasChildren && m("toggleOpen"), m("toggleOpen"), d.value = !1, C(t.item.id), V(t.item.id), await k(100), d.value = !0);
+      return `#${m(t.item.id)}`;
+    }, S = async (e) => {
+      t.options.onSidebarClick?.(t.item.id), t.options.pathRouting && (e.preventDefault(), t.hasChildren && d("toggleOpen"), d("toggleOpen"), r.value = !1, C(t.item.id), N(t.item.id), await b(100), r.value = !0);
     };
-    return (e, n) => (o(), a("li", {
+    return (e, i) => (o(), n("li", {
       id: e.id,
       class: "sidebar-group-item"
     }, [
-      r("div", {
-        class: A(["sidebar-heading", {
+      a("div", {
+        class: B(["sidebar-heading", {
           "sidebar-group-item__folder": e.hasChildren,
           active_page: e.isActive,
           deprecated: e.item.type === "operation" && e.item.isDeprecated
         }]),
-        onClick: c
+        onClick: u
       }, [
-        e.hasChildren && !l(i).defaultOpenAllTags ? (o(), a("p", M, [
-          r("button", {
+        e.hasChildren && !e.options.defaultOpenAllTags ? (o(), n("p", D, [
+          a("button", {
             "aria-expanded": e.open,
             class: "toggle-nested-icon",
             type: "button",
-            onClick: O(c, ["stop"])
+            onClick: A(u, ["stop"])
           }, [
-            f(l(N), { open: e.open }, {
-              label: b(() => [
-                h(p(e.open ? "Collapse" : "Expand") + " " + p(e.item.title), 1)
+            g(h(E), { open: e.open }, {
+              label: f(() => [
+                p(l(e.open ? "Collapse" : "Expand") + " " + l(e.item.title), 1)
               ]),
               _: 1
             }, 8, ["open"])
-          ], 8, z),
-          n[0] || (n[0] = h("   "))
+          ], 8, L),
+          i[0] || (i[0] = p("   "))
         ])) : s("", !0),
-        r("a", {
+        a("a", {
           class: "sidebar-heading-link",
-          href: S(),
+          href: w(),
           tabindex: e.hasChildren ? -1 : 0,
-          onClick: T
+          onClick: S
         }, [
-          r("p", F, [
-            l(i).operationTitleSource === "path" ? (o(), a("span", G, p(w(e.item)), 1)) : (o(), a("span", W, p(e.item.title), 1))
+          a("p", z, [
+            e.options.operationTitleSource === "path" ? (o(), n("span", j, l(v(e.item)), 1)) : (o(), n("span", F, l(e.item.title), 1))
           ]),
-          "method" in e.item && !e.hasChildren ? (o(), a("p", q, [
-            n[1] || (n[1] = h("   ")),
-            n[2] || (n[2] = r("span", { class: "sr-only" }, "HTTP Method: ", -1)),
-            f(D, {
+          "method" in e.item && !e.hasChildren ? (o(), n("p", G, [
+            i[1] || (i[1] = p("   ")),
+            i[2] || (i[2] = a("span", { class: "sr-only" }, "HTTP Method: ", -1)),
+            g(R, {
               active: e.isActive,
               class: "min-w-9.75 justify-end text-right",
               method: e.item.method
             }, {
-              default: b(() => [
-                e.item.type === "webhook" ? (o(), $(l(I), {
+              default: f(() => [
+                e.item.type === "webhook" ? (o(), O(h(H), {
                   key: 0,
-                  style: E({
-                    color: l(H)(e.item.method).colorVar
+                  style: $({
+                    color: h(V)(e.item.method).colorVar
                   }),
                   weight: "bold"
                 }, null, 8, ["style"])) : s("", !0)
@@ -101,15 +104,15 @@ const L = ["id"], M = {
               _: 1
             }, 8, ["active", "method"])
           ])) : s("", !0)
-        ], 8, j)
+        ], 8, M)
       ], 2),
-      e.open ? g(e.$slots, "default", { key: 0 }, void 0, !0) : s("", !0),
-      e.$slots["action-menu"] ? (o(), a("div", J, [
-        g(e.$slots, "action-menu", {}, void 0, !0)
+      e.open ? c(e.$slots, "default", { key: 0 }, void 0, !0) : s("", !0),
+      e.$slots["action-menu"] ? (o(), n("div", W, [
+        c(e.$slots, "action-menu", {}, void 0, !0)
       ])) : s("", !0)
-    ], 8, L));
+    ], 8, U));
   }
 });
 export {
-  ie as default
+  ee as default
 };