@scalar/api-reference 1.33.0 → 1.34.0

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

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

package/dist/features/Search/helpers/create-fuse-instance.d.ts

@@ -0,0 +1,9 @@
+import type { FuseData } from '../../../features/Search/types';
+import Fuse from 'fuse.js';
+/**
+ * Create a Fuse instance for searching the API reference.
+ *
+ * Doesn't have any data yet, so it's empty.
+ */
+export declare function createFuseInstance(): Fuse<FuseData>;
+//# sourceMappingURL=create-fuse-instance.d.ts.map

package/dist/features/Search/helpers/create-fuse-instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-fuse-instance.d.ts","sourceRoot":"","sources":["../../../../src/features/Search/helpers/create-fuse-instance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,IAAI,MAAM,SAAS,CAAA;AAE1B;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,IAAI,CAAC,QAAQ,CAAC,CAiDnD"}

package/dist/features/Search/helpers/create-fuse-instance.js

@@ -0,0 +1,46 @@
+import e from "fuse.js";
+function n() {
+  return new e([], {
+    // 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: "id", 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: "method", 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
+  });
+}
+export {
+  n as createFuseInstance
+};

package/dist/features/Search/helpers/create-search-index.d.ts

@@ -0,0 +1,7 @@
+import type { FuseData } from '../../../features/Search/types';
+import type { TraversedEntry } from '../../../features/traverse-schema';
+/**
+ * Create a search index from a list of entries.
+ */
+export declare function createSearchIndex(entries: TraversedEntry[]): FuseData[];
+//# sourceMappingURL=create-search-index.d.ts.map

package/dist/features/Search/helpers/create-search-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-search-index.d.ts","sourceRoot":"","sources":["../../../../src/features/Search/helpers/create-search-index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAGhE;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,QAAQ,EAAE,CAoBvE"}

package/dist/features/Search/helpers/create-search-index.js

@@ -0,0 +1,109 @@
+import { extractRequestBody as p, createParameterMap as s } from "../../../libs/openapi.js";
+function c(i) {
+  const o = [];
+  function e(d) {
+    d.forEach((t) => {
+      h(t, o), "children" in t && t.children && e(t.children);
+    });
+  }
+  return e(i), o;
+}
+function h(i, o) {
+  if ("operation" in i) {
+    const e = p(i.operation) || s(i.operation), d = typeof e != "boolean" ? e : null;
+    o.push({
+      type: "operation",
+      title: i.title,
+      href: `#${i.id}`,
+      id: i.operation.operationId,
+      description: i.operation.description || "",
+      method: i.method,
+      path: i.path,
+      body: d || "",
+      entry: i
+    });
+    return;
+  }
+  if ("webhook" in i) {
+    o.push({
+      type: "webhook",
+      title: i.title,
+      href: `#${i.id}`,
+      description: "Webhook",
+      method: i.method,
+      body: i.webhook.description || "",
+      entry: i
+    });
+    return;
+  }
+  if ("schema" in i) {
+    const e = "description" in i.schema && typeof i.schema.description == "string" ? i.schema.description : "";
+    o.push({
+      type: "model",
+      title: i.title,
+      href: `#${i.id}`,
+      description: "Model",
+      body: e,
+      entry: i
+    });
+    return;
+  }
+  if ("tag" in i) {
+    o.push({
+      title: i.title,
+      href: `#${i.id}`,
+      description: i.tag.description || "",
+      type: "tag",
+      body: "",
+      entry: i
+    });
+    return;
+  }
+  if ("isGroup" in i) {
+    o.push({
+      title: i.title,
+      href: `#${i.id}`,
+      description: "Tag Group",
+      type: "tag",
+      body: "",
+      entry: i
+    });
+    return;
+  }
+  if ("isWebhooks" in i) {
+    o.push({
+      type: "heading",
+      title: "Webhooks",
+      href: `#${i.id}`,
+      description: "Heading",
+      body: "",
+      entry: i
+    });
+    return;
+  }
+  if (i.title === "Models") {
+    o.push({
+      type: "heading",
+      title: "Models",
+      href: `#${i.id}`,
+      description: "Heading",
+      body: "",
+      entry: i
+    });
+    return;
+  }
+  if (i.title) {
+    o.push({
+      type: "heading",
+      title: i.title ?? "",
+      description: "Description",
+      href: `#${i.id}`,
+      body: "",
+      entry: i
+    });
+    return;
+  }
+}
+export {
+  c as createSearchIndex
+};

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

@@ -0,0 +1,14 @@
+import type { createSidebar } from '../../../features/sidebar';
+import type { FuseResult } from 'fuse.js';
+import type { FuseData } from '../types';
+/**
+ * Creates the search index from an OpenAPI document.
+ */
+export declare function useSearchIndex(items: ReturnType<typeof createSidebar>['items']): {
+    resetSearch: () => void;
+    selectedIndex: import("vue").Ref<number | undefined, number | undefined>;
+    selectedSearchResult: import("vue").ComputedRef<FuseResult<FuseData> | undefined>;
+    searchResultsWithPlaceholderResults: import("vue").ComputedRef<FuseResult<FuseData>[]>;
+    query: import("vue").Ref<string, string>;
+};
+//# sourceMappingURL=useSearchIndex.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useSearchIndex.d.ts","sourceRoot":"","sources":["../../../../src/features/Search/hooks/useSearchIndex.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAIzC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAIxC;;GAEG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,OAAO,CAAC;uBAgCrD,IAAI;;;;;EA0D7B"}

package/dist/features/Search/hooks/useSearchIndex.js

@@ -0,0 +1,46 @@
+import { ref as a, watch as i, toValue as S, computed as h } from "vue";
+import { createFuseInstance as p } from "../helpers/create-fuse-instance.js";
+import { createSearchIndex as x } from "../helpers/create-search-index.js";
+const d = 25;
+function _(l) {
+  const n = p(), e = a();
+  i(
+    l,
+    () => {
+      const { entries: r } = S(l), c = x(r);
+      n.setCollection(c);
+    },
+    { immediate: !0 }
+  );
+  const t = a("");
+  i(t, (r) => {
+    if (r.length) {
+      v();
+      return;
+    }
+    o();
+  });
+  function o() {
+    t.value = "", e.value = void 0, s.value = [];
+  }
+  const s = a([]), v = () => {
+    e.value = 0, s.value = n.search(t.value, {
+      limit: d
+    });
+  }, u = h(() => t.value.length !== 0 ? s.value : n._docs.slice(0, d).map((c, m) => ({
+    item: c,
+    refIndex: m
+  }))), f = h(
+    () => typeof e.value == "number" ? u.value[e.value] : void 0
+  );
+  return {
+    resetSearch: o,
+    selectedIndex: e,
+    selectedSearchResult: f,
+    searchResultsWithPlaceholderResults: u,
+    query: t
+  };
+}
+export {
+  _ as useSearchIndex
+};

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

@@ -1,3 +1,3 @@
-export { default as SearchButton } from './SearchButton.vue.js';
-export { default as SearchModal } from './SearchModal.vue.js';
+export { default as SearchButton } from './components/SearchButton.vue.js';
+export { default as SearchModal } from './components/SearchModal.vue.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/Search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAC5D,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/features/Search/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA"}

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

@@ -0,0 +1,15 @@
+import type { TraversedEntry } from '../../features/traverse-schema';
+import type { ParameterMap } from '../../libs/openapi.js';
+export type EntryType = 'operation' | 'webhook' | 'model' | 'heading' | 'tag';
+export type FuseData = {
+    type: EntryType;
+    id?: string;
+    title: string;
+    description: string;
+    href: string;
+    body?: string | string[] | ParameterMap;
+    method?: string;
+    path?: string;
+    entry: TraversedEntry;
+};
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/features/Search/types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,KAAK,CAAA;AAE7E,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,SAAS,CAAA;IACf,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,YAAY,CAAA;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,cAAc,CAAA;CACtB,CAAA"}

package/dist/features/api-client-modal/useApiClient.d.ts

@@ -367,6 +367,13 @@ declare const client: import("vue").Ref<{
             documentUrl?: string | undefined;
             integration?: string | null | undefined;
         }>;
+        cookies: Record<string, {
+            uid: string & import("zod").BRAND<"cookie">;
+            name: string;
+            value: string;
+            domain?: string | undefined;
+            path?: string | undefined;
+        }>;
         modalState: {
             open: boolean;
             show: () => void;
@@ -394,13 +401,6 @@ declare const client: import("vue").Ref<{
             } | undefined;
             proxyUrl?: string | undefined;
         }>;
-        cookies: Record<string, {
-            uid: string & import("zod").BRAND<"cookie">;
-            name: string;
-            value: string;
-            domain?: string | undefined;
-            path?: string | undefined;
-        }>;
         environments: Record<string, {
             uid: string & import("zod").BRAND<"environment">;
             name: string;
@@ -4325,6 +4325,13 @@ declare const client: import("vue").Ref<{
             documentUrl?: string | undefined;
             integration?: string | null | undefined;
         }>;
+        cookies: Record<string, {
+            uid: string & import("zod").BRAND<"cookie">;
+            name: string;
+            value: string;
+            domain?: string | undefined;
+            path?: string | undefined;
+        }>;
         modalState: {
             open: boolean;
             show: () => void;
@@ -4352,13 +4359,6 @@ declare const client: import("vue").Ref<{
             } | undefined;
             proxyUrl?: string | undefined;
         }>;
-        cookies: Record<string, {
-            uid: string & import("zod").BRAND<"cookie">;
-            name: string;
-            value: string;
-            domain?: string | undefined;
-            path?: string | undefined;
-        }>;
         environments: Record<string, {
             uid: string & import("zod").BRAND<"environment">;
             name: string;