@scalar/api-reference 1.32.10 → 1.34.0

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

package/dist/stores/useHttpClientStore.d.ts

@@ -1,43 +0,0 @@
-import type { HiddenClients } from '@scalar/types/legacy';
-import type { Target, TargetId } from '@scalar/types/snippetz';
-import { type Ref } from 'vue';
-/**
- * Gets the client title from the availableTargets
- * { targetKey: 'shell', clientKey: 'curl' } -> 'Shell'
- */
-declare function getTargetTitle(client: HttpClientState): string;
-/**
- * Gets the client title from the availableTargets
- * { targetKey: 'shell', clientKey: 'curl' } -> 'cURL'
- */
-declare function getClientTitle(client: HttpClientState): string;
-/**
- * Filters out hidden clients from the available targets (based on the given configuration).
- */
-export declare function filterHiddenClients(targets: Target[], exclude: Ref<HiddenClients>): Target[];
-/** The selected HTTP client */
-export type HttpClientState = {
-    targetKey: TargetId;
-    clientKey: string;
-};
-declare function setDefaultHttpClient(httpClient?: HttpClientState): void;
-declare function resetState(): void;
-/** Keep track of the available and the selected HTTP client(s) */
-export declare const useHttpClientStore: () => {
-    httpClient: {
-        readonly targetKey: TargetId;
-        readonly clientKey: string;
-    };
-    resetState: typeof resetState;
-    setHttpClient: (newState: Partial<HttpClientState>) => void;
-    setDefaultHttpClient: typeof setDefaultHttpClient;
-    excludedClients: Ref<HiddenClients>;
-    setExcludedClients: (v: HiddenClients) => void;
-    availableTargets: import("vue").ComputedRef<Target[]>;
-    getClientTitle: typeof getClientTitle;
-    getTargetTitle: typeof getTargetTitle;
-    httpTargetTitle: import("vue").ComputedRef<string>;
-    httpClientTitle: import("vue").ComputedRef<string>;
-};
-export {};
-//# sourceMappingURL=useHttpClientStore.d.ts.map

package/dist/stores/useHttpClientStore.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useHttpClientStore.d.ts","sourceRoot":"","sources":["../../src/stores/useHttpClientStore.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,EAAE,KAAK,GAAG,EAAqC,MAAM,KAAK,CAAA;AASjE;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAE9C;AAED;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAM9C;AAYD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,EAAE,CAoD5F;AASD,+BAA+B;AAC/B,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAMxE,iBAAS,oBAAoB,CAAC,UAAU,CAAC,EAAE,eAAe,QAOzD;AAiCD,iBAAS,UAAU,SAElB;AAeD,kEAAkE;AAClE,eAAO,MAAM,kBAAkB;;4BAhEY,QAAQ;4BAAa,MAAM;;;8BAqDrC,OAAO,CAAC,eAAe,CAAC;;qBAiBP,GAAG,CAAC,aAAa,CAAC;4BACxC,aAAa;;;;;;CAaxC,CAAA"}

package/dist/stores/useHttpClientStore.js

@@ -1,70 +0,0 @@
-import { safeLocalStorage as T, REFERENCE_LS_KEYS as m } from "@scalar/helpers/object/local-storage";
-import { objectReplace as p } from "@scalar/helpers/object/object-replace";
-import { snippetz as A } from "@scalar/snippetz";
-import { computed as o, readonly as a, ref as C, reactive as k } from "vue";
-const y = {
-  targetKey: "shell",
-  clientKey: "curl"
-}, { clients: H } = A();
-function d(t) {
-  var n;
-  return ((n = r.value.find((e) => e.key === t.targetKey)) == null ? void 0 : n.title) ?? t.targetKey;
-}
-function E(t) {
-  var n, e;
-  return ((e = (n = r.value.find((i) => i.key === t.targetKey)) == null ? void 0 : n.clients.find((i) => i.client === t.clientKey)) == null ? void 0 : e.title) ?? t.clientKey;
-}
-const L = o(() => d(l)), S = o(() => E(l));
-function _(t, n) {
-  return n.value === !0 ? [] : t.flatMap((e) => {
-    var i;
-    return typeof n.value != "object" ? [] : Array.isArray(n.value) ? (e.clients = e.clients.filter(
-      // @ts-expect-error Typescript, chill. It's all good. It has to be an array.
-      (s) => !n.value.includes(s.client)
-    ), e.clients.length ? [e] : []) : n.value[e.key] === !0 ? [] : (Array.isArray(n.value[e.key]) && (e.clients = e.clients.filter((s) => !// @ts-expect-error We checked whether it's an Array already.
-    n.value[e.key].includes(s.client))), (i = e == null ? void 0 : e.clients) != null && i.length ? [e] : []);
-  });
-}
-const r = o(() => _(H(), c)), c = C({}), f = C();
-function b(t) {
-  t !== void 0 && (f.value = t, K(u()));
-}
-const u = () => {
-  var t, n, e, i;
-  return v(f.value) ? f.value : v(y) ? y : {
-    targetKey: (t = r.value[0]) == null ? void 0 : t.key,
-    clientKey: (i = (e = (n = r.value[0]) == null ? void 0 : n.clients) == null ? void 0 : e[0]) == null ? void 0 : i.client
-  };
-};
-function v(t) {
-  return t === void 0 ? !1 : !!r.value.find(
-    (n) => n.key === t.targetKey && n.clients.find((e) => e.client === t.clientKey)
-  );
-}
-function D() {
-  p(l, u());
-}
-const l = k(u()), K = (t) => {
-  Object.assign(l, {
-    ...l,
-    ...t
-  }), T().setItem(m.SELECTED_CLIENT_DEPRECATED, JSON.stringify(l));
-}, I = () => ({
-  httpClient: a(l),
-  resetState: D,
-  setHttpClient: K,
-  setDefaultHttpClient: b,
-  excludedClients: a(c),
-  setExcludedClients: (t) => {
-    c.value = t, p(l, u());
-  },
-  availableTargets: r,
-  getClientTitle: E,
-  getTargetTitle: d,
-  httpTargetTitle: L,
-  httpClientTitle: S
-});
-export {
-  _ as filterHiddenClients,
-  I as useHttpClientStore
-};

package/dist/v2/hooks/useStore.d.ts

@@ -1,9 +0,0 @@
-import type { WorkspaceStore } from '@scalar/workspace-store/client';
-/**
- * Composable for accessing the new workspace store
- *
- * When called with a store it provides that store
- * When called without parameters, it returns the injected store
- */
-export declare const useStore: (store?: WorkspaceStore) => WorkspaceStore;
-//# sourceMappingURL=useStore.d.ts.map

package/dist/v2/hooks/useStore.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useStore.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/useStore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAKpE;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,WAAY,cAAc,mBAe9C,CAAA"}

package/dist/v2/hooks/useStore.js

@@ -1,14 +0,0 @@
-import { provide as r, inject as n } from "vue";
-const o = Symbol(), a = (e) => {
-  if (e)
-    return r(o, e), e;
-  const t = n(o);
-  if (!t)
-    throw new Error(
-      "useStore() was called without a store and no store instance was found. Make sure to call useStore(store) in a parent component first."
-    );
-  return t;
-};
-export {
-  a as useStore
-};