@scalar/api-reference 1.24.56 → 1.24.58

package/dist/features/Search/useSearchIndex.js

@@ -0,0 +1,115 @@
+import V from "fuse.js";
+import { ref as c, computed as A, watch as B } from "vue";
+import { extractRequestBody as P } from "../../helpers/specHelpers.js";
+import { useSidebar as z } from "../../hooks/useSidebar.js";
+import { useOperation as G } from "../../hooks/useOperation.js";
+import { useNavState as J } from "../../hooks/useNavState.js";
+import { getHeadingsFromMarkdown as K } from "../../helpers/getHeadingsFromMarkdown.js";
+import { getModels as Q } from "../../helpers/getModels.js";
+function ae({
+  specification: a
+}) {
+  const { getHeadingId: R, getWebhookId: T, getModelId: j, getOperationId: L, getTagId: W } = J(), { hideModels: q } = z(), o = c([]), u = c([]), h = c(0), s = c(""), d = new V(o.value, {
+    keys: ["title", "description", "body"]
+  }), C = () => {
+    h.value = 0, u.value = d.search(s.value);
+  };
+  function F() {
+    s.value = "", h.value = 0, u.value = [];
+  }
+  const H = A(
+    () => s.value.length === 0 ? o.value.slice(0, 25).map((r) => ({
+      item: r
+    })) : u.value.slice(0, 25)
+  );
+  return B(
+    a.value,
+    async () => {
+      var y, g, I, w, M, k, $, D, x;
+      const f = performance.now();
+      if (o.value = [], !((g = (y = a.value) == null ? void 0 : y.tags) != null && g.length) && !((w = (I = a.value) == null ? void 0 : I.webhooks) != null && w.length)) {
+        d.setCollection([]);
+        return;
+      }
+      const r = [], v = K(
+        ((k = (M = a.value) == null ? void 0 : M.info) == null ? void 0 : k.description) ?? ""
+      );
+      v.length && (v.forEach((e) => {
+        r.push({
+          type: "heading",
+          title: `Info > ${e.value}`,
+          description: "",
+          href: `#${R(e)}`,
+          tag: e.slug,
+          body: ""
+        });
+      }), o.value = o.value.concat(r)), (D = ($ = a.value) == null ? void 0 : $.tags) == null || D.forEach((e) => {
+        const E = {
+          title: e["x-displayName"] ?? e.name,
+          href: `#${W(e)}`,
+          description: e.description,
+          type: "tag",
+          tag: e.name,
+          body: ""
+        };
+        o.value.push(E), e.operations && e.operations.forEach((t) => {
+          const { parameterMap: n } = G({ operation: t }), S = P(t) || n.value;
+          let p = null;
+          typeof S != "boolean" && (p = S);
+          const O = {
+            type: "req",
+            title: t.name ?? t.path,
+            href: `#${L(t, e)}`,
+            operationId: t.operationId,
+            description: t.description ?? "",
+            httpVerb: t.httpVerb,
+            path: t.path,
+            tag: e.name,
+            operation: t
+          };
+          p && (O.body = p), o.value.push(O);
+        });
+      });
+      const l = (x = a.value) == null ? void 0 : x.webhooks, m = [];
+      l && Object.keys(l).forEach((e) => {
+        Object.keys(
+          l[e]
+        ).forEach((t) => {
+          var n;
+          m.push({
+            type: "webhook",
+            title: `Webhook: ${(n = l[e][t]) == null ? void 0 : n.name}`,
+            href: `#${T(e, t)}`,
+            description: e,
+            httpVerb: t,
+            tag: e,
+            body: ""
+          });
+        }), o.value = o.value.concat(m);
+      });
+      const i = q.value ? {} : Q(a.value), b = [];
+      i && (Object.keys(i).forEach((e) => {
+        b.push({
+          type: "model",
+          title: "Model",
+          href: `#${j(e)}`,
+          description: i[e].title ?? e,
+          tag: e,
+          body: ""
+        });
+      }), o.value = o.value.concat(b)), d.setCollection(o.value);
+      const N = performance.now();
+      console.log(`create-search-index: ${Math.round(N - f)} ms`);
+    },
+    { immediate: !0 }
+  ), {
+    resetSearch: F,
+    fuseSearch: C,
+    selectedSearchResult: h,
+    searchResultsWithPlaceholderResults: H,
+    searchText: s
+  };
+}
+export {
+  ae as useSearchIndex
+};

package/dist/helpers/createEmptySpecification.d.ts

@@ -1,7 +1,8 @@
 import type { Spec } from '@scalar/oas-utils';
+import type { OpenAPI } from '@scalar/openapi-parser';
 /**
  * Creates an empty specification object.
  * The returning object has the same structure as a valid OpenAPI specification, but everything is empty.
  */
-export declare function createEmptySpecification(partialSpecification?: Partial<Spec>): Spec;
+export declare function createEmptySpecification(partialSpecification?: Partial<OpenAPI.Document>): Spec;
 //# sourceMappingURL=createEmptySpecification.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"createEmptySpecification.d.ts","sourceRoot":"","sources":["../../src/helpers/createEmptySpecification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAI7C;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,oBAAoB,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,GAqBrE,IAAI,CACX"}
+{"version":3,"file":"createEmptySpecification.d.ts","sourceRoot":"","sources":["../../src/helpers/createEmptySpecification.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAIrD;;;GAGG;AACH,wBAAgB,wBAAwB,CACtC,oBAAoB,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,GAsB1C,IAAI,CACX"}

package/dist/hooks/useDarkModeState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useDarkModeState.d.ts","sourceRoot":"","sources":["../../src/hooks/useDarkModeState.ts"],"names":[],"mappings":"AAKA,wGAAwG;AACxG,wBAAgB,gBAAgB,CAAC,eAAe,CAAC,EAAE,OAAO;;;yBAmC5B,OAAO;EA8BpC"}
+{"version":3,"file":"useDarkModeState.d.ts","sourceRoot":"","sources":["../../src/hooks/useDarkModeState.ts"],"names":[],"mappings":"AAKA,wGAAwG;AACxG,wBAAgB,gBAAgB,CAAC,eAAe,CAAC,EAAE,OAAO;;;yBAoC5B,OAAO;EA8BpC"}

package/dist/hooks/useDarkModeState.js

@@ -1,11 +1,11 @@
-import { ref as s, watch as u } from "vue";
+import { ref as s, watch as f } from "vue";
 const t = s(!1);
-function c(r) {
+function c(a) {
   var n;
-  const a = () => {
+  const r = () => {
     var o, i;
     const e = typeof window < "u" ? (o = window.localStorage) == null ? void 0 : o.getItem("isDark") : null;
-    return typeof e == "string" ? !!JSON.parse(e) : !!(typeof window < "u" && ((i = window == null ? void 0 : window.matchMedia("(prefers-color-scheme: dark)")) != null && i.matches));
+    return typeof e == "string" ? !!JSON.parse(e) : !!(typeof window < "u" && typeof (window == null ? void 0 : window.matchMedia) == "function" && ((i = window == null ? void 0 : window.matchMedia("(prefers-color-scheme: dark)")) != null && i.matches));
   }, d = () => {
     var e;
     t.value = !t.value, typeof window < "u" && ((e = window == null ? void 0 : window.localStorage) == null || e.setItem("isDark", JSON.stringify(t.value)));
@@ -14,7 +14,7 @@ function c(r) {
     var o;
     t.value = e, typeof window < "u" && ((o = window == null ? void 0 : window.localStorage) == null || o.setItem("isDark", JSON.stringify(t.value)));
   }
-  return t.value = (typeof window > "u" ? null : JSON.parse(((n = window.localStorage) == null ? void 0 : n.getItem("isDark")) || "null")) ?? r ?? a(), u(
+  return t.value = (typeof window > "u" ? null : JSON.parse(((n = window.localStorage) == null ? void 0 : n.getItem("isDark")) || "null")) ?? a ?? r(), f(
     t,
     (e) => {
       typeof document > "u" || (document.body.classList.toggle("dark-mode", e), document.body.classList.toggle("light-mode", !e));

package/dist/hooks/useReactiveSpec.d.ts

@@ -149,13 +149,13 @@ export declare function useReactiveSpec({ specConfig, proxy, }: {
         servers?: {
             url?: string;
             description?: string;
-            variables?: {
-                [variable: string]: import("@scalar/openapi-parser").OpenAPIV3.ServerVariableObject;
-            };
+            variables?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ServerVariableObject>;
         }[] | {
             url?: string;
             description?: string;
-            variables?: Record<string, import("@scalar/openapi-parser").OpenAPIV3_1.ServerVariableObject>;
+            variables?: {
+                [variable: string]: import("@scalar/openapi-parser").OpenAPIV3.ServerVariableObject;
+            };
         }[] | undefined;
         components?: {
             schemas?: {

package/dist/hooks/useReactiveSpec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useReactiveSpec.d.ts","sourceRoot":"","sources":["../../src/hooks/useReactiveSpec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAE1D,OAAO,EAAE,KAAK,gBAAgB,EAAiC,MAAM,KAAK,CAAA;AA6C1E;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAC9B,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IAChD,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDA"}
+{"version":3,"file":"useReactiveSpec.d.ts","sourceRoot":"","sources":["../../src/hooks/useReactiveSpec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAE1D,OAAO,EAAE,KAAK,gBAAgB,EAAiC,MAAM,KAAK,CAAA;AAmD1E;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAC9B,UAAU,EACV,KAAK,GACN,EAAE;IACD,UAAU,CAAC,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAA;IAChD,KAAK,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwDA"}

package/dist/hooks/useReactiveSpec.js

@@ -1,50 +1,52 @@
-import { fetchSpecFromUrl as p, prettyPrintJson as l } from "@scalar/oas-utils/helpers";
-import { ref as f, reactive as y, watch as u, toValue as a } from "vue";
-import { parse as S } from "../helpers/parse.js";
-import { isValidUrl as d } from "../helpers/isValidUrl.js";
-import { createEmptySpecification as m } from "../helpers/createEmptySpecification.js";
-const g = async ({ url: r, content: e }, i) => {
-  if (r)
-    return d(r) ? await p(r, i) : await p(r);
-  const t = typeof e == "function" ? e() : e;
+import { fetchSpecFromUrl as f, prettyPrintJson as d } from "@scalar/oas-utils/helpers";
+import { ref as u, reactive as v, watch as m, toValue as a } from "vue";
+import { parse as g } from "../helpers/parse.js";
+import { isValidUrl as h } from "../helpers/isValidUrl.js";
+import { createEmptySpecification as l } from "../helpers/createEmptySpecification.js";
+const y = async ({ url: e, content: r }, n) => {
+  if (e) {
+    const i = performance.now(), s = h(e) ? await f(e, n) : await f(e), o = performance.now();
+    return console.log(`fetch: ${Math.round(o - i)} ms (${e})`), console.log("size:", Math.round(s.length / 1024), "kB"), s;
+  }
+  const t = typeof r == "function" ? r() : r;
   if (typeof t == "string")
     return t;
   if (typeof t == "object")
-    return l(t);
+    return d(t);
 };
 function E({
-  specConfig: r,
-  proxy: e
+  specConfig: e,
+  proxy: r
 }) {
-  const i = f(""), t = y(m()), c = f(null);
-  function v(o) {
-    return o ? S(o, {
-      proxy: e ? a(e) : void 0
-    }).then((n) => {
-      c.value = null, Object.assign(t, {
+  const n = u(""), t = v(l()), i = u(null);
+  function s(o) {
+    return o ? g(o, {
+      proxy: r ? a(r) : void 0
+    }).then((c) => {
+      i.value = null, Object.assign(t, {
         servers: [],
-        ...n
+        ...c
       });
-    }).catch((n) => {
-      c.value = n.toString();
-    }) : Object.assign(t, m());
+    }).catch((c) => {
+      i.value = c.toString();
+    }) : Object.assign(t, l());
   }
-  return u(
-    () => a(r),
+  return m(
+    () => a(e),
     async (o) => {
-      var n;
+      var c;
       if (o) {
-        const s = (n = await g(o, a(e))) == null ? void 0 : n.trim();
-        typeof s == "string" && (i.value = s);
+        const p = (c = await y(o, a(r))) == null ? void 0 : c.trim();
+        typeof p == "string" && (n.value = p);
       }
     },
     { immediate: !0, deep: !0 }
-  ), u(i, () => {
-    v(i.value);
+  ), m(n, () => {
+    s(n.value);
   }), {
-    rawSpec: i,
+    rawSpec: n,
     parsedSpec: t,
-    specErrors: c
+    specErrors: i
   };
 }
 export {

package/dist/index.d.ts

@@ -2,8 +2,7 @@ export { default as ApiReference } from './components/ApiReference.vue.js';
 export { default as ApiReferenceLayout } from './components/ApiReferenceLayout.vue.js';
 export { default as ModernLayout } from './components/Layouts/ModernLayout.vue.js';
 export { default as RenderedReference } from './components/Content/Content.vue.js';
-export { default as SearchModal } from './components/SearchModal.vue.js';
-export { default as SearchButton } from './components/SearchButton.vue.js';
+export * from './features/Search';
 export { default as GettingStarted } from './components/GettingStarted.vue.js';
 export { createScalarReferences } from './esm.js';
 export { useReactiveSpec } from './hooks/useReactiveSpec.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,uCAAuC,CAAA;AAC/E,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AAC/E,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AAEpC,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AACnF,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,uCAAuC,CAAA;AAC/E,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AAC/E,cAAc,mBAAmB,CAAA;AACjC,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,OAAO,CAAA;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA;AACjC,cAAc,sBAAsB,CAAA;AAEpC,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}