@scalar/api-reference 1.33.0 → 1.34.0

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

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

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

@@ -1,32 +0,0 @@
-import { type ParameterMap } from '../../libs/openapi.js';
-import type { Spec, TransformedOperation } from '@scalar/types/legacy';
-import { type FuseResult } from 'fuse.js';
-import { type Ref } from 'vue';
-export type EntryType = 'req' | 'webhook' | 'model' | 'heading' | 'tag';
-export type FuseData = {
-    title: string;
-    href: string;
-    type: EntryType;
-    operationId?: string;
-    description: string;
-    body?: string | string[] | ParameterMap;
-    httpVerb?: string;
-    path?: string;
-    tag?: string;
-    operation?: TransformedOperation;
-};
-/**
- * Creates the search index from an OpenAPI document.
- */
-export declare function useSearchIndex({ specification, hideModels, }: {
-    specification: Ref<Spec>;
-    hideModels?: boolean;
-}): {
-    resetSearch: () => void;
-    fuseSearch: () => void;
-    selectedSearchIndex: Ref<number | undefined, number | undefined>;
-    selectedSearchResult: import("vue").ComputedRef<FuseResult<FuseData> | undefined>;
-    searchResultsWithPlaceholderResults: import("vue").ComputedRef<FuseResult<FuseData>[]>;
-    searchText: Ref<string, string>;
-};
-//# sourceMappingURL=useSearchIndex.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"useSearchIndex.d.ts","sourceRoot":"","sources":["../../../src/features/Search/useSearchIndex.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,YAAY,EAAqD,MAAM,gBAAgB,CAAA;AAErG,OAAO,KAAK,EAAe,IAAI,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAA;AACnF,OAAa,EAAE,KAAK,UAAU,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,KAAK,GAAG,EAAwB,MAAM,KAAK,CAAA;AAIpD,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,KAAK,CAAA;AAEvE,MAAM,MAAM,QAAQ,GAAG;IACrB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY,CAAA;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,oBAAoB,CAAA;CACjC,CAAA;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,EAC7B,aAAa,EACb,UAAkB,GACnB,EAAE;IACD,aAAa,EAAE,GAAG,CAAC,IAAI,CAAC,CAAA;IACxB,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;uBAsEyB,IAAI;sBAbL,IAAI;;;;;EAoM5B"}

package/dist/features/Search/useSearchIndex.js

@@ -1,170 +0,0 @@
-import { useNavState as W } from "../../hooks/useNavState.js";
-import { getHeadingsFromMarkdown as _ } from "../../libs/markdown.js";
-import { createParameterMap as k, extractRequestBody as A, getModels as B } from "../../libs/openapi.js";
-import { isHttpMethod as U } from "@scalar/helpers/http/is-http-method";
-import X from "fuse.js";
-import { ref as f, watch as H, computed as j } from "vue";
-const q = 25;
-function Z({
-  specification: C,
-  hideModels: L = !1
-}) {
-  const { getHeadingId: O, getModelId: T, getTagId: F } = W(), a = f([]), u = f([]), s = f(), n = f(""), v = new X(a.value, {
-    // Define searchable fields with weights to prioritize more important matches
-    keys: [
-      // Highest weight - titles are most descriptive
-      { name: "title", weight: 0.7 },
-      // Medium weight - helpful but often verbose
-      { name: "description", weight: 0.3 },
-      // Lowest weight - can be very long and noisy
-      { name: "body", weight: 0.2 },
-      // High weight - unique identifiers for operations
-      { name: "operationId", weight: 0.6 },
-      // Good weight - endpoint paths are searchable
-      { name: "path", weight: 0.5 },
-      // Medium-high weight - helps with categorization
-      { name: "tag", weight: 0.4 },
-      // Medium weight - useful for filtering by method
-      { name: "httpVerb", weight: 0.3 }
-    ],
-    // Threshold controls how strict the matching is (0.0 = perfect match, 1.0 = very loose)
-    // 0.3 allows for some typos and partial matches while maintaining relevance
-    threshold: 0.3,
-    // Maximum distance between characters that can be matched
-    // Higher values allow matches even when characters are far apart in long text
-    distance: 100,
-    // Include the match score in results for debugging and potential UI enhancements
-    includeScore: !0,
-    // Include detailed match information showing which parts of the text matched
-    includeMatches: !0,
-    // Minimum number of characters that must match to be considered a result
-    // Prevents single-character matches that are usually noise
-    minMatchCharLength: 2,
-    // Don't require matches to be at the beginning of strings
-    // Makes search more flexible and user-friendly
-    ignoreLocation: !0,
-    // Enable advanced search syntax like 'exact' for exact matches or !exclude for exclusions
-    useExtendedSearch: !0,
-    // Find all possible matches in each item, not just the first one
-    // Ensures comprehensive search results
-    findAllMatches: !0
-  }), y = () => {
-    s.value = 0, u.value = v.search(n.value);
-  };
-  H(n, (e) => {
-    e.length ? y() : u.value = [];
-  });
-  function N() {
-    n.value = "", s.value = void 0, u.value = [];
-  }
-  const b = j(() => n.value.length === 0 ? a.value.slice(0, q).map((e) => ({
-    item: e
-  })) : u.value.slice(0, q)), P = j(
-    () => typeof s.value == "number" ? b.value[s.value] : void 0
-  );
-  return H(
-    C,
-    (e) => {
-      var $, x, R;
-      a.value = [];
-      const g = [], M = _((($ = e == null ? void 0 : e.info) == null ? void 0 : $.description) ?? "");
-      if (M.length && (M.forEach((t) => {
-        g.push({
-          type: "heading",
-          title: t.value,
-          description: "Introduction",
-          href: `#${O(t)}`,
-          tag: t.slug,
-          body: ""
-        });
-      }), a.value = a.value.concat(g)), (x = e == null ? void 0 : e.tags) != null && x.length)
-        (R = e == null ? void 0 : e.tags) == null || R.forEach((t) => {
-          const d = {
-            title: t["x-displayName"] ?? t.name,
-            href: `#${F(t)}`,
-            description: t.description,
-            type: "tag",
-            tag: t.name,
-            body: ""
-          };
-          a.value.push(d), t.operations && t.operations.forEach((o) => {
-            var h;
-            const r = k(o.information), l = A(o.information) || r;
-            let i = null;
-            typeof l != "boolean" && (i = l);
-            const c = {
-              type: "req",
-              title: o.name ?? o.path,
-              href: `#${o.id}`,
-              operationId: (h = o.information) == null ? void 0 : h.operationId,
-              description: o.description ?? "",
-              httpVerb: o.httpVerb,
-              path: o.path,
-              tag: t.name,
-              operation: o
-            };
-            i && (c.body = i), a.value.push(c);
-          });
-        });
-      else if (e != null && e.paths) {
-        const t = e.paths;
-        Object.keys(t ?? {}).forEach((d) => {
-          Object.keys((t == null ? void 0 : t[d]) ?? {}).forEach((o) => {
-            var l, i;
-            const r = (l = t == null ? void 0 : t[d]) == null ? void 0 : l[o];
-            if (U(o) && r) {
-              const c = k(r), h = A(r) || c;
-              let p = null;
-              typeof h != "boolean" && (p = h);
-              const V = {
-                type: "req",
-                title: r.name ?? r.path,
-                href: `#${r.id}`,
-                operationId: (i = r.information) == null ? void 0 : i.operationId,
-                description: r.description ?? "",
-                httpVerb: r.httpVerb,
-                path: r.path,
-                operation: r
-              };
-              p && (V.body = p), a.value.push(V);
-            }
-          });
-        });
-      }
-      const I = e == null ? void 0 : e.webhooks, E = [];
-      I && I.forEach((t) => {
-        E.push({
-          type: "webhook",
-          title: `${t.name}`,
-          href: `#${t.id}`,
-          description: "Webhook",
-          httpVerb: t.httpVerb,
-          tag: t.name,
-          body: ""
-        }), a.value = a.value.concat(E);
-      });
-      const m = L ? {} : B(e), D = [];
-      m && (Object.keys(m).forEach((t) => {
-        D.push({
-          type: "model",
-          title: `${m[t].title ?? t}`,
-          href: `#${T({ name: t })}`,
-          description: "Model",
-          tag: t,
-          body: ""
-        });
-      }), a.value = a.value.concat(D)), v.setCollection(a.value);
-    },
-    { immediate: !0 }
-  ), {
-    resetSearch: N,
-    fuseSearch: y,
-    selectedSearchIndex: s,
-    selectedSearchResult: P,
-    searchResultsWithPlaceholderResults: b,
-    searchText: n
-  };
-}
-export {
-  Z as useSearchIndex
-};

package/dist/helpers/parse.d.ts

@@ -1,10 +0,0 @@
-import type { OpenAPIV3_1 } from '@scalar/openapi-types';
-import type { Spec } from '@scalar/types/legacy';
-import type { TraversedEntry } from '../features/traverse-schema';
-/**
- * Parse the given dereferencedDocument and return a super custom transformed dereferencedDocument.
- *
- * @deprecated Try to use a store instead.
- */
-export declare const parse: (dereferencedDocument: OpenAPIV3_1.Document, items?: TraversedEntry[]) => Promise<Spec>;
-//# sourceMappingURL=parse.d.ts.map

package/dist/helpers/parse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"parse.d.ts","sourceRoot":"","sources":["../../src/helpers/parse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,IAAI,EAAwB,MAAM,sBAAsB,CAAA;AAGtE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAKhE;;;;GAIG;AACH,eAAO,MAAM,KAAK,yBAA0B,WAAW,CAAC,QAAQ,UAAU,cAAc,EAAE,KAAG,OAAO,CAAC,IAAI,CAiBrG,CAAA"}

package/dist/helpers/parse.js

@@ -1,81 +0,0 @@
-import { createEmptySpecification as w } from "../libs/openapi.js";
-import { normalizeHttpMethod as m } from "@scalar/helpers/http/normalize-http-method";
-const P = (s, i) => new Promise((e, b) => {
-  try {
-    return e(s ? k(s, i) : k(w()));
-  } catch (p) {
-    console.error("[@scalar/api-reference]", "Failed to parse the OpenAPI document. It might be invalid?"), console.error(p), b(p);
-  }
-  return e(k(w()));
-}), k = (s, i) => {
-  let e = {};
-  s && typeof s == "object" ? e = s : e = w(), e.tags || (e.tags = []), e.paths || (e.paths = {}), e.components || (e.components = {}), e.webhooks || (e.webhooks = {}), e.servers || (e.servers = []), e.security || (e.security = []);
-  const b = [], p = (o) => {
-    var h;
-    !("children" in o) || !((h = o.children) != null && h.length) || o.children.forEach((a) => {
-      var f, u, t, n, g, d;
-      let r = (f = e.tags) == null ? void 0 : f.findIndex((y) => "tag" in o && y.name === o.tag.name);
-      r === -1 && "tag" in o && (e.tags.push({
-        name: o.tag.name,
-        operations: []
-      }), r = e.tags.length - 1), (u = e.tags[r]).operations || (u.operations = []), "tag" in a ? p(a) : "operation" in a ? e.tags[r].operations.push({
-        id: a.id,
-        httpVerb: m(a.method),
-        path: a.path,
-        name: a.operation.summary || a.path || "",
-        description: a.operation.description || "",
-        isWebhook: !1,
-        information: a.operation,
-        pathParameters: (n = (t = e.paths) == null ? void 0 : t[a.path ?? ""]) == null ? void 0 : n.parameters
-      }) : "webhook" in a && e.tags[r].operations.push({
-        id: a.id,
-        httpVerb: m(a.method),
-        path: a.name,
-        name: a.webhook.summary || a.name || "",
-        description: a.webhook.description || "",
-        isWebhook: !0,
-        information: a.webhook,
-        pathParameters: (d = (g = e.webhooks) == null ? void 0 : g[a.name ?? ""]) == null ? void 0 : d.parameters
-      });
-    });
-  };
-  return i == null || i.forEach((o) => {
-    var h, a, r, f, u;
-    if (o.id.startsWith("tag/default") && "operation" in o) {
-      let t = (h = e.tags) == null ? void 0 : h.findIndex((n) => n.name === "default");
-      t === -1 && (e.tags.push({
-        name: "default",
-        description: "",
-        operations: []
-      }), t = e.tags.length - 1), e.tags[t].operations.push({
-        id: o.id,
-        httpVerb: m(o.method),
-        path: o.path,
-        name: o.operation.summary || o.path || "",
-        description: o.operation.description || "",
-        isWebhook: !1,
-        information: o.operation,
-        pathParameters: (r = (a = e.paths) == null ? void 0 : a[o.path ?? ""]) == null ? void 0 : r.parameters
-      });
-    }
-    "tag" in o && o.isGroup && ((f = o.children) != null && f.length) ? o.children.forEach(p) : "tag" in o && p(o), "isWebhooks" in o && o.isWebhooks && ((u = o.children) != null && u.length) && o.children.forEach((t) => {
-      var n, g;
-      "webhook" in t && t.name && t.method && b.push({
-        id: t.id,
-        httpVerb: m(t.method),
-        path: t.name,
-        name: t.webhook.summary || t.name || "",
-        description: t.webhook.description || "",
-        isWebhook: !0,
-        information: t.webhook,
-        pathParameters: (g = (n = e.webhooks) == null ? void 0 : n[t.name ?? ""]) == null ? void 0 : g.parameters
-      });
-    });
-  }), {
-    ...e,
-    webhooks: b
-  };
-};
-export {
-  P as parse
-};