@scalar/api-reference 1.36.1 → 1.37.0

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
 };

package/dist/v2/blocks/scalar-sidebar-block/helpers/create-sidebar.d.ts

@@ -11,371 +11,9 @@ export declare const createSidebar: (store: WorkspaceStore) => {
     collapsedSidebarItems: Record<string, boolean>;
     isSidebarOpen: import("vue").Ref<boolean, boolean>;
     items: import("vue").ComputedRef<{
-        entries: (({
-            title: string;
-            id: string;
-        } & {
-            description?: string | undefined;
-            children?: (({
-                title: string;
-                id: string;
-            } & /*elided*/ any) | ({
-                title: string;
-                id: string;
-            } & {
-                children?: (({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    path: string;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "operation";
-                    ref: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    type: "model";
-                    ref: string;
-                    name: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "webhook";
-                    ref: string;
-                    name: string;
-                }))[] | undefined;
-                type: "text";
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                path: string;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "operation";
-                ref: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                type: "model";
-                ref: string;
-                name: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "webhook";
-                ref: string;
-                name: string;
-            }))[] | undefined;
-            isWebhooks?: boolean | undefined;
-            xKeys?: {
-                [x: string]: unknown;
-            } | undefined;
-            type: "tag";
-            name: string;
-            isGroup: boolean;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            children?: (({
-                title: string;
-                id: string;
-            } & {
-                description?: string | undefined;
-                children?: (({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    path: string;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "operation";
-                    ref: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    type: "model";
-                    ref: string;
-                    name: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "webhook";
-                    ref: string;
-                    name: string;
-                }))[] | undefined;
-                isWebhooks?: boolean | undefined;
-                xKeys?: {
-                    [x: string]: unknown;
-                } | undefined;
-                type: "tag";
-                name: string;
-                isGroup: boolean;
-            }) | ({
-                title: string;
-                id: string;
-            } & /*elided*/ any) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                path: string;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "operation";
-                ref: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                type: "model";
-                ref: string;
-                name: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "webhook";
-                ref: string;
-                name: string;
-            }))[] | undefined;
-            type: "text";
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            isDeprecated?: boolean | undefined;
-            path: string;
-            method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-            type: "operation";
-            ref: string;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            type: "model";
-            ref: string;
-            name: string;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            isDeprecated?: boolean | undefined;
-            method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-            type: "webhook";
-            ref: string;
-            name: string;
-        }))[];
-        entities: Map<string, (({
-            title: string;
-            id: string;
-        } & {
-            description?: string | undefined;
-            children?: (({
-                title: string;
-                id: string;
-            } & /*elided*/ any) | ({
-                title: string;
-                id: string;
-            } & {
-                children?: (({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    path: string;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "operation";
-                    ref: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    type: "model";
-                    ref: string;
-                    name: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "webhook";
-                    ref: string;
-                    name: string;
-                }))[] | undefined;
-                type: "text";
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                path: string;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "operation";
-                ref: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                type: "model";
-                ref: string;
-                name: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "webhook";
-                ref: string;
-                name: string;
-            }))[] | undefined;
-            isWebhooks?: boolean | undefined;
-            xKeys?: {
-                [x: string]: unknown;
-            } | undefined;
-            type: "tag";
-            name: string;
-            isGroup: boolean;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            children?: (({
-                title: string;
-                id: string;
-            } & {
-                description?: string | undefined;
-                children?: (({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & /*elided*/ any) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    path: string;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "operation";
-                    ref: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    type: "model";
-                    ref: string;
-                    name: string;
-                }) | ({
-                    title: string;
-                    id: string;
-                } & {
-                    isDeprecated?: boolean | undefined;
-                    method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                    type: "webhook";
-                    ref: string;
-                    name: string;
-                }))[] | undefined;
-                isWebhooks?: boolean | undefined;
-                xKeys?: {
-                    [x: string]: unknown;
-                } | undefined;
-                type: "tag";
-                name: string;
-                isGroup: boolean;
-            }) | ({
-                title: string;
-                id: string;
-            } & /*elided*/ any) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                path: string;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "operation";
-                ref: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                type: "model";
-                ref: string;
-                name: string;
-            }) | ({
-                title: string;
-                id: string;
-            } & {
-                isDeprecated?: boolean | undefined;
-                method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-                type: "webhook";
-                ref: string;
-                name: string;
-            }))[] | undefined;
-            type: "text";
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            isDeprecated?: boolean | undefined;
-            path: string;
-            method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-            type: "operation";
-            ref: string;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            type: "model";
-            ref: string;
-            name: string;
-        }) | ({
-            title: string;
-            id: string;
-        } & {
-            isDeprecated?: boolean | undefined;
-            method: "head" | "connect" | "delete" | "get" | "options" | "patch" | "post" | "put" | "trace";
-            type: "webhook";
-            ref: string;
-            name: string;
-        })) & {
-            parent?: import("@scalar/workspace-store/schemas/v3.1/strict/openapi-document").TraversedEntry;
+        entries: import("@scalar/workspace-store/schemas/navigation").TraversedEntry[];
+        entities: Map<string, import("@scalar/workspace-store/schemas/navigation").TraversedEntry & {
+            parent?: import("@scalar/workspace-store/schemas/navigation").TraversedEntry;
         }>;
     }>;
     scrollToOperation: (operationId: string, focus?: boolean) => void;

package/dist/v2/blocks/scalar-sidebar-block/helpers/create-sidebar.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-sidebar.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-sidebar-block/helpers/create-sidebar.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAMpE;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qCA4BT,MAAM,UAAU,OAAO;mCAvBzB,MAAM,SAAS,OAAO;sCADnB,MAAM;CAmDhD,CAAA"}
+{"version":3,"file":"create-sidebar.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-sidebar-block/helpers/create-sidebar.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAMpE;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,cAAc;;;;;;;;;qCA4BT,MAAM,UAAU,OAAO;mCAvBzB,MAAM,SAAS,OAAO;sCADnB,MAAM;CAmDhD,CAAA"}