@scalar/api-reference 1.32.0 → 1.32.4

package/dist/features/Search/useSearchIndex.js

@@ -1,133 +1,170 @@
-import A from "fuse.js";
-import { ref as m, watch as T, computed as k } from "vue";
-import { useConfig as B } from "../../hooks/useConfig.js";
-import { useNavState as P } from "../../hooks/useNavState.js";
-import { useOperation as O } from "../../hooks/useOperation.js";
-import { getHeadingsFromMarkdown as z } from "../../libs/markdown.js";
-import { extractRequestBody as j, getModels as G } from "../../libs/openapi.js";
-import { isHttpMethod as J } from "@scalar/helpers/http/is-http-method";
-function w({
-  specification: q
+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: H, getModelId: L, getTagId: C } = P(), F = B(), a = m([]), d = m([]), i = m(), l = m(""), y = new A(a.value, {
-    keys: ["title", "description", "body"]
-  }), b = () => {
-    i.value = 0, d.value = y.search(l.value);
+  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);
   };
-  T(l, (e) => {
-    e.length ? b() : d.value = [];
+  H(n, (e) => {
+    e.length ? y() : u.value = [];
   });
   function N() {
-    l.value = "", i.value = void 0, d.value = [];
+    n.value = "", s.value = void 0, u.value = [];
   }
-  const g = k(() => l.value.length === 0 ? a.value.slice(0, 25).map((f) => ({
-    item: f
-  })) : d.value.slice(0, 25)), W = k(
-    () => typeof i.value == "number" ? g.value[i.value] : void 0
+  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 T(
-    q,
+  return H(
+    C,
     (e) => {
-      var E, x, V;
+      var $, x, R;
       a.value = [];
-      const f = [], I = z(((E = e == null ? void 0 : e.info) == null ? void 0 : E.description) ?? "");
-      if (I.length && (I.forEach((t) => {
-        f.push({
+      const g = [], M = _((($ = e == null ? void 0 : e.info) == null ? void 0 : $.description) ?? "");
+      if (M.length && (M.forEach((t) => {
+        g.push({
           type: "heading",
-          title: `Info > ${t.value}`,
-          description: "",
-          href: `#${H(t)}`,
+          title: t.value,
+          description: "Introduction",
+          href: `#${O(t)}`,
           tag: t.slug,
           body: ""
         });
-      }), a.value = a.value.concat(f)), (x = e == null ? void 0 : e.tags) != null && x.length)
-        (V = e == null ? void 0 : e.tags) == null || V.forEach((t) => {
-          const h = {
+      }), 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: `#${C(t)}`,
+            href: `#${F(t)}`,
             description: t.description,
             type: "tag",
             tag: t.name,
             body: ""
           };
-          a.value.push(h), t.operations && t.operations.forEach((s) => {
-            var u;
-            const { parameterMap: o } = O(s), n = j(s.information) || o.value;
-            let r = null;
-            typeof n != "boolean" && (r = n);
+          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: s.name ?? s.path,
-              href: `#${s.id}`,
-              operationId: (u = s.information) == null ? void 0 : u.operationId,
-              description: s.description ?? "",
-              httpVerb: s.httpVerb,
-              path: s.path,
+              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: s
+              operation: o
             };
-            r && (c.body = r), a.value.push(c);
+            i && (c.body = i), a.value.push(c);
           });
         });
       else if (e != null && e.paths) {
         const t = e.paths;
-        Object.keys(t ?? {}).forEach((h) => {
-          Object.keys((t == null ? void 0 : t[h]) ?? {}).forEach((s) => {
-            var n, r;
-            const o = (n = t == null ? void 0 : t[h]) == null ? void 0 : n[s];
-            if (J(s) && o) {
-              const { parameterMap: c } = O({ ...o, information: o }), u = j(o) || c.value;
+        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 u != "boolean" && (p = u);
-              const R = {
+              typeof h != "boolean" && (p = h);
+              const V = {
                 type: "req",
-                title: o.name ?? o.path,
-                href: `#${o.id}`,
-                operationId: (r = o.information) == null ? void 0 : r.operationId,
-                description: o.description ?? "",
-                httpVerb: o.httpVerb,
-                path: o.path,
-                operation: o
+                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 && (R.body = p), a.value.push(R);
+              p && (V.body = p), a.value.push(V);
             }
           });
         });
       }
-      const M = e == null ? void 0 : e.webhooks, D = [];
-      M && M.forEach((t) => {
-        D.push({
+      const I = e == null ? void 0 : e.webhooks, E = [];
+      I && I.forEach((t) => {
+        E.push({
           type: "webhook",
-          title: "Webhook",
+          title: `${t.name}`,
           href: `#${t.id}`,
-          description: `${t.name}`,
+          description: "Webhook",
           httpVerb: t.httpVerb,
           tag: t.name,
           body: ""
-        }), a.value = a.value.concat(D);
+        }), a.value = a.value.concat(E);
       });
-      const v = F.value.hideModels ? {} : G(e), $ = [];
-      v && (Object.keys(v).forEach((t) => {
-        $.push({
+      const m = L ? {} : B(e), D = [];
+      m && (Object.keys(m).forEach((t) => {
+        D.push({
           type: "model",
-          title: "Model",
-          href: `#${L({ name: t })}`,
-          description: v[t].title ?? t,
+          title: `${m[t].title ?? t}`,
+          href: `#${T({ name: t })}`,
+          description: "Model",
           tag: t,
           body: ""
         });
-      }), a.value = a.value.concat($)), y.setCollection(a.value);
+      }), a.value = a.value.concat(D)), v.setCollection(a.value);
     },
     { immediate: !0 }
   ), {
     resetSearch: N,
-    fuseSearch: b,
-    selectedSearchIndex: i,
-    selectedSearchResult: W,
-    searchResultsWithPlaceholderResults: g,
-    searchText: l
+    fuseSearch: y,
+    selectedSearchIndex: s,
+    selectedSearchResult: P,
+    searchResultsWithPlaceholderResults: b,
+    searchText: n
   };
 }
 export {
-  w as useSearchIndex
+  Z as useSearchIndex
 };

package/dist/features/api-client-modal/ApiClientModal.vue.d.ts

@@ -1,7 +1,7 @@
 import type { OpenAPIV3_1 } from '@scalar/openapi-types';
-import type { ApiClientConfiguration } from '@scalar/types/api-reference';
+import type { ApiClientConfiguration, ApiReferenceConfiguration } from '@scalar/types/api-reference';
 type __VLS_Props = {
-    configuration: Partial<Omit<ApiClientConfiguration, 'plugins'>>;
+    configuration: Partial<Omit<ApiClientConfiguration, 'plugins'>> & Pick<ApiReferenceConfiguration, 'onBeforeRequest'>;
     dereferencedDocument: OpenAPIV3_1.Document;
 };
 declare const _default: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, HTMLDivElement>;

package/dist/features/api-client-modal/ApiClientModal.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiClientModal.vue.d.ts","sourceRoot":"","sources":["../../../src/features/api-client-modal/ApiClientModal.vue"],"names":[],"mappings":"AAiKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAA;AAYzE,KAAK,WAAW,GAAG;IAEjB,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC,CAAA;IAC/D,oBAAoB,EAAE,WAAW,CAAC,QAAQ,CAAA;CAC3C,CAAC;;AAuLF,wBAOG"}
+{"version":3,"file":"ApiClientModal.vue.d.ts","sourceRoot":"","sources":["../../../src/features/api-client-modal/ApiClientModal.vue"],"names":[],"mappings":"AAiLA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,KAAK,EACV,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,6BAA6B,CAAA;AAYpC,KAAK,WAAW,GAAG;IAEjB,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,sBAAsB,EAAE,SAAS,CAAC,CAAC,GAC7D,IAAI,CAAC,yBAAyB,EAAE,iBAAiB,CAAC,CAAA;IACpD,oBAAoB,EAAE,WAAW,CAAC,QAAQ,CAAA;CAC3C,CAAC;;AAkMF,wBAOG"}

package/dist/features/api-client-modal/ApiClientModal.vue.js

@@ -1,79 +1,88 @@
-import { defineComponent as h, ref as S, onMounted as E, watch as g, onBeforeUnmount as D, createElementBlock as b, openBlock as x } from "vue";
-import { useActiveEntities as M, useWorkspace as U } from "@scalar/api-client/store";
-import { mutateSecuritySchemeDiff as k } from "@scalar/api-client/views/Request/libs";
-import { getServersFromOpenApiDocument as A } from "@scalar/oas-utils/transforms";
+import { defineComponent as S, ref as g, onMounted as E, watch as B, onBeforeUnmount as b, createElementBlock as D, openBlock as R } from "vue";
+import { useActiveEntities as k, useWorkspace as q } from "@scalar/api-client/store";
+import { mutateSecuritySchemeDiff as x } from "@scalar/api-client/views/Request/libs";
+import { getServersFromOpenApiDocument as M } from "@scalar/oas-utils/transforms";
 import { watchDebounced as d } from "@vueuse/core";
-import C from "microdiff";
-import { useNavState as y } from "../../hooks/useNavState.js";
-import { useApiClient as B } from "./useApiClient.js";
-import { useExampleStore as L } from "../../legacy/stores/useExampleStore.js";
-const z = /* @__PURE__ */ h({
+import U from "microdiff";
+import { useNavState as A } from "../../hooks/useNavState.js";
+import { useApiClient as C } from "./useApiClient.js";
+import { useExampleStore as y } from "../../legacy/stores/useExampleStore.js";
+const z = /* @__PURE__ */ S({
   __name: "ApiClientModal",
   props: {
     configuration: {},
     dereferencedDocument: {}
   },
-  setup(n) {
-    const a = S(null), { client: c, init: v } = B(), { selectedExampleKey: p, operationId: s } = L(), u = M(), i = U(), { isIntersectionEnabled: m } = y();
+  setup(o) {
+    const a = g(null), { client: i, init: v } = C(), { selectedExampleKey: p, operationId: s } = y(), c = k(), u = q(), { isIntersectionEnabled: f } = A(), h = () => ({
+      name: "on-before-request",
+      hooks: {
+        onBeforeRequest: o.configuration.onBeforeRequest
+      }
+    });
     return E(() => {
       a.value && v({
         el: a.value,
-        configuration: n.configuration,
-        store: i
+        configuration: {
+          ...o.configuration,
+          // If the onBeforeRequest hook is configured, we add the plugin to the API client.
+          plugins: o.configuration.onBeforeRequest ? [h] : []
+        },
+        store: u
       });
     }), d(
-      () => n.dereferencedDocument,
+      () => o.dereferencedDocument,
       (e) => {
-        var r, o;
-        e && (u.activeCollection.value && ((r = c.value) == null || r.resetStore()), i.importSpecFile(void 0, "default", {
+        var r, n;
+        e && (c.activeCollection.value && ((r = i.value) == null || r.resetStore()), u.importSpecFile(void 0, "default", {
           dereferencedDocument: e,
           shouldLoad: !1,
-          documentUrl: (o = n.configuration) == null ? void 0 : o.url,
+          documentUrl: (n = o.configuration) == null ? void 0 : n.url,
           useCollectionSecurity: !0,
-          ...n.configuration
+          ...o.configuration
         }));
       }
     ), d(
-      () => n.configuration,
+      () => o.configuration,
       (e, r) => {
-        if (!r || !u.activeCollection.value)
+        if (!r || !c.activeCollection.value)
           return;
-        const o = u.activeCollection.value, f = C(r, e);
-        if (!f.some(
+        const n = c.activeCollection.value, m = U(r, e);
+        if (!m.some(
           (t) => t.path[0] === "url" || t.path[0] === "content" || t.path[1] === "url" || t.path[1] === "content"
         )) {
-          if (f.forEach((t) => {
-            t.path[0] === "authentication" && k(t, u, i);
+          if (m.forEach((t) => {
+            t.path[0] === "authentication" && x(t, c, u);
           }), e.servers || r.servers) {
-            o.servers.forEach((l) => {
-              i.serverMutators.delete(l, o.uid);
+            n.servers.forEach((l) => {
+              u.serverMutators.delete(l, n.uid);
             });
-            const t = A(
-              e.servers ?? n.dereferencedDocument.servers,
+            const t = M(
+              e.servers ?? o.dereferencedDocument.servers,
               {
                 baseServerURL: e.baseServerURL
               }
             );
             t.forEach((l) => {
-              i.serverMutators.add(l, o.uid);
-            }), t.length && i.collectionMutators.edit(
-              o.uid,
+              u.serverMutators.add(l, n.uid);
+            }), t.length && u.collectionMutators.edit(
+              n.uid,
               "selectedServerUid",
               t[t.length - 1].uid
             );
           }
         }
-        m.value = !1, setTimeout(() => {
-          m.value = !0;
+        f.value = !1, setTimeout(() => {
+          f.value = !0;
         }, 1e3);
       },
       { deep: !0, debounce: 300 }
-    ), g(p, (e) => {
-      c.value && e && s.value && c.value.updateExample(e, s.value);
-    }), D(() => {
+    ), B(p, (e) => {
+      i.value && e && s.value && i.value.updateExample(e, s.value);
+    }), b(() => {
       var e;
-      return (e = c.value) == null ? void 0 : e.app.unmount();
-    }), (e, r) => (x(), b("div", {
+      return (e = i.value) == null ? void 0 : e.app.unmount();
+    }), (e, r) => (R(), D("div", {
       ref_key: "el",
       ref: a
     }, null, 512));