@scalar/api-reference 1.38.0 → 1.39.0

package/dist/v2/blocks/scalar-sidebar-block/helpers/create-sidebar.js

@@ -1,35 +0,0 @@
-import { scrollToId as n } from "@scalar/helpers/dom/scroll-to-id";
-import { reactive as d, ref as p, computed as u } from "vue";
-import { generateReverseIndex as g } from "./generate-reverse-index.js";
-import { lazyBus as b } from "../../../../components/Lazy/lazyBus.js";
-const C = (i) => {
-  const r = d({}), a = p(!1), l = (e) => r[e] = !r[e], o = (e, t) => r[e] = t, c = u(() => {
-    const e = i.workspace.activeDocument?.["x-scalar-navigation"];
-    return i.config["x-scalar-reference-config"].features.expandAllTagSections && e?.forEach((t) => o(t.id, !0)), {
-      entries: e ?? [],
-      entities: g(e)
-    };
-  });
-  return {
-    collapsedSidebarItems: r,
-    isSidebarOpen: a,
-    items: c,
-    scrollToOperation: (e, t) => {
-      const s = c.value.entities.get(e)?.parent?.id;
-      if (s && s !== e)
-        if (r[s])
-          n(e, t);
-        else {
-          const f = b.on((m) => {
-            m.loaded === e && (n(e, t), f());
-          });
-          o(s, !0);
-        }
-    },
-    setCollapsedSidebarItem: o,
-    toggleCollapsedSidebarItem: l
-  };
-};
-export {
-  C as createSidebar
-};

package/dist/v2/blocks/scalar-sidebar-block/helpers/generate-reverse-index.d.ts

@@ -1,9 +0,0 @@
-import type { TraversedEntry } from '@scalar/workspace-store/schemas/navigation';
-import type { OpenApiDocument } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
-/**
- * Generate a reverse index for fast lookups of entities by their IDs.
- */
-export declare const generateReverseIndex: (navigation?: OpenApiDocument["x-scalar-navigation"]) => Map<string, TraversedEntry & {
-    parent?: TraversedEntry;
-}>;
-//# sourceMappingURL=generate-reverse-index.d.ts.map

package/dist/v2/blocks/scalar-sidebar-block/helpers/generate-reverse-index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"generate-reverse-index.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-sidebar-block/helpers/generate-reverse-index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4CAA4C,CAAA;AAChF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AAEnG;;GAEG;AACH,eAAO,MAAM,oBAAoB,GAAI,aAAY,eAAe,CAAC,qBAAqB,CAAM;aAE9B,cAAc;EAe3E,CAAA"}

package/dist/v2/blocks/scalar-sidebar-block/helpers/generate-reverse-index.js

@@ -1,9 +0,0 @@
-const a = (t = []) => {
-  const r = /* @__PURE__ */ new Map(), n = (e) => {
-    r.set(e.id, e), "children" in e && e.children?.forEach((c) => n({ ...c, parent: e }));
-  };
-  return t.forEach(n), r;
-};
-export {
-  a as generateReverseIndex
-};

package/dist/v2/blocks/scalar-sidebar-block/hooks/useSidebar.d.ts

@@ -1,18 +0,0 @@
-import type { WorkspaceStore } from '@scalar/workspace-store/client';
-import { type InjectionKey } from 'vue';
-import { createSidebar } from '../../../../v2/blocks/scalar-sidebar-block/helpers/create-sidebar.js';
-type Sidebar = ReturnType<typeof createSidebar>;
-/**
- * Injection key for the sidebar instance.
- * This ensures type safety when injecting the sidebar.
- */
-export declare const SIDEBAR_SYMBOL: InjectionKey<Sidebar>;
-/**
- * Composable for managing the sidebar state.
- *
- * When called with a collection and options, it creates and provides a new sidebar instance.
- * When called without parameters, it returns the injected sidebar state.
- */
-export declare const useSidebar: (store?: WorkspaceStore) => ReturnType<typeof createSidebar>;
-export {};
-//# sourceMappingURL=useSidebar.d.ts.map

package/dist/v2/blocks/scalar-sidebar-block/hooks/useSidebar.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useSidebar.d.ts","sourceRoot":"","sources":["../../../../../src/v2/blocks/scalar-sidebar-block/hooks/useSidebar.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AACpE,OAAO,EAAE,KAAK,YAAY,EAAmB,MAAM,KAAK,CAAA;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,yDAAyD,CAAA;AAEvF,KAAK,OAAO,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAA;AAE/C;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,YAAY,CAAC,OAAO,CAAqB,CAAA;AAEtE;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,cAAc,KAAG,UAAU,CAAC,OAAO,aAAa,CAoBlF,CAAA"}

package/dist/v2/blocks/scalar-sidebar-block/hooks/useSidebar.js

@@ -1,18 +0,0 @@
-import { provide as t, inject as a } from "vue";
-import { createSidebar as n } from "../helpers/create-sidebar.js";
-const i = Symbol("sidebar"), d = (e) => {
-  if (e) {
-    const o = n(e);
-    return t(i, o), o;
-  }
-  const r = a(i);
-  if (!r)
-    throw new Error(
-      "useSidebar() was called without a collection and no sidebar instance was found. Make sure to call useSidebar(collection) in a parent component first."
-    );
-  return r;
-};
-export {
-  i as SIDEBAR_SYMBOL,
-  d as useSidebar
-};

package/dist/v2/blocks/scalar-sidebar-block/index.d.ts

@@ -1,4 +0,0 @@
-export { default as SidebarBlock } from './components/SidebarBlock.vue.js';
-export { default as SidebarHttpBadge } from './components/SidebarHttpBadge.vue.js';
-export { SIDEBAR_SYMBOL, useSidebar } from './hooks/useSidebar.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/v2/blocks/scalar-sidebar-block/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/v2/blocks/scalar-sidebar-block/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AAC/E,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA"}

package/dist/v2/helpers/get-document-name.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-document-name.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/get-document-name.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAc,MAAM,8DAA8D,CAAA;AAE/G;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,GAC1B,0BAAyB,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,SAAS,CAAM,EAClE,YAAY,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,KAC1C,MA2BF,CAAA"}

package/dist/v2/helpers/get-document-name.js

@@ -1,15 +0,0 @@
-const r = ({ name: t, url: e, document: i } = {}, f) => {
-  if (t)
-    return t;
-  if (e)
-    return e;
-  if (i?.info) {
-    const n = i.info;
-    if (n.title)
-      return n.title;
-  }
-  return "default";
-};
-export {
-  r as getDocumentName
-};

package/dist/v2/helpers/map-configuration.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"map-configuration.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/map-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAA;AAG9D;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAAI,QAAQ,OAAO,CAAC,yBAAyB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgD1E,CAAA"}

package/dist/v2/helpers/map-configuration.js

@@ -1,50 +0,0 @@
-const t = (e) => ({
-  "x-scalar-reference-config": {
-    title: e.title,
-    slug: e.slug,
-    features: {
-      // Feature toggles for UI elements and behaviors
-      showModels: !e.hideModels,
-      expandAllTagSections: e.defaultOpenAllTags,
-      persistAuthenticationState: e.persistAuth,
-      showDarkModeToggle: !e.hideDarkModeToggle,
-      showDownload: !e.hideDownloadButton,
-      showSearch: !e.hideSearch,
-      showSidebar: e.showSidebar,
-      showTestRequestButton: !e.hideTestRequestButton
-    },
-    appearance: {
-      // Appearance-related configuration
-      css: e.customCss,
-      favicon: e.favicon,
-      forceColorMode: e.forceDarkModeState,
-      initialColorMode: e.darkMode ? "dark" : void 0,
-      layout: e.layout,
-      loadDefaultFonts: e.withDefaultFonts,
-      theme: e.theme
-    },
-    routing: {
-      // Routing configuration
-      basePath: e.pathRouting?.basePath
-    },
-    settings: {
-      // Miscellaneous settings
-      proxyUrl: e.proxyUrl,
-      searchKey: e.searchHotKey,
-      baseServerUrl: e.baseServerURL,
-      servers: e.servers
-    },
-    meta: e.metaData,
-    // In memory configuration
-    tagSort: e.tagsSorter,
-    operationsSorter: e.operationsSorter,
-    generateHeadingSlug: e.generateHeadingSlug,
-    generateModelSlug: e.generateModelSlug,
-    generateOperationSlug: e.generateOperationSlug,
-    generateTagSlug: e.generateTagSlug,
-    generateWebhookSlug: e.generateWebhookSlug
-  }
-});
-export {
-  t as mapConfiguration
-};

package/dist/v2/helpers/normalize-content.d.ts

@@ -1,3 +0,0 @@
-/** Normalize content into a JS object or return null if it is falsey */
-export declare const normalizeContent: (content: string | Record<string, unknown> | (() => string | Record<string, unknown>) | undefined | null) => Record<string, unknown> | undefined;
-//# sourceMappingURL=normalize-content.d.ts.map

package/dist/v2/helpers/normalize-content.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"normalize-content.d.ts","sourceRoot":"","sources":["../../../src/v2/helpers/normalize-content.ts"],"names":[],"mappings":"AAEA,wEAAwE;AACxE,eAAO,MAAM,gBAAgB,GAC3B,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,KACtG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAc5B,CAAA"}

package/dist/v2/helpers/normalize-content.js

@@ -1,8 +0,0 @@
-import { parseJsonOrYaml as i } from "@scalar/oas-utils/helpers";
-const f = (r) => {
-  if (r)
-    return typeof r == "function" ? f(r()) : typeof r == "string" ? i(r) : r || void 0;
-};
-export {
-  f as normalizeContent
-};

package/dist/v2/hooks/use-legacy-store-events.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-legacy-store-events.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-legacy-store-events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,IAAI,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAEpE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAC9B,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAA;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAC/B,OAAO,cAAc,EACrB,aAAa,MAAM,EACnB,gBAAgB,UAAU,CAAC,OAAO,yBAAyB,CAAC,EAC5D,MAAM,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,SA6H9B,CAAA"}

package/dist/v2/hooks/use-legacy-store-events.js

@@ -1,61 +0,0 @@
-import { onCustomEvent as a } from "@scalar/workspace-store/events";
-const y = (p, S, b, s) => {
-  const { servers: u, serverMutators: d, requestMutators: m, collectionMutators: o, securitySchemeMutators: n } = S, { activeCollection: i, activeServer: v } = b;
-  a(s, "scalar-replace-servers", ({ detail: { servers: e, options: t } }) => {
-    if (t?.disableOldStoreUpdate === !0)
-      return;
-    const r = i.value;
-    if (!r)
-      return console.warn("No active collection found");
-    r.servers.forEach((l) => {
-      d.delete(l, r.uid);
-    }), e.forEach((l) => {
-      const f = Object.values(u).find((h) => h.url === l.url);
-      f && d.add(f, r.uid);
-    });
-    const c = Object.values(u).find((l) => l.url === e.at(-1)?.url);
-    o.edit(r.uid, "selectedServerUid", c?.uid);
-  }), a(s, "scalar-update-selected-server", ({ detail: { value: e, options: t } }) => {
-    if (t?.disableOldStoreUpdate === !0)
-      return;
-    const r = i.value;
-    if (!r)
-      return;
-    const c = Object.values(u).find((l) => l.url === e);
-    c && o.edit(r.uid, "selectedServerUid", c.uid);
-  }), a(s, "store-update-selected-server-properties", ({ detail: { key: e, value: t, options: r } }) => {
-    if (r?.disableOldStoreUpdate)
-      return;
-    const c = v.value;
-    c && d.edit(c.uid, e, t);
-  }), a(s, "scalar-update-selected-server-variables", ({ detail: { key: e, value: t, options: r } }) => {
-    if (r?.disableOldStoreUpdate === !0)
-      return;
-    const c = v.value;
-    if (!c || c.url !== p.workspace.activeDocument?.["x-scalar-active-server"])
-      return;
-    const l = c.variables || {};
-    l[e] = { ...l[e], default: t }, d.edit(c.uid, "variables", l);
-  }), a(s, "scalar-select-security-schemes", ({ detail: { uids: e } }) => {
-    const t = i.value;
-    if (!t)
-      return console.warn("No active collection found");
-    o.edit(t.uid, "selectedSecuritySchemeUids", e);
-  }), a(s, "scalar-select-operation-security-schemes", ({ detail: { operationUid: e, uids: t } }) => {
-    m.edit(e, "selectedSecuritySchemeUids", t);
-  }), a(s, "scalar-edit-security-scheme", ({ detail: { uid: e, path: t, value: r } }) => {
-    n.edit(e, t, r);
-  }), a(s, "scalar-add-auth-option", ({ detail: { payload: e } }) => {
-    const t = i.value;
-    if (!t)
-      return console.warn("No active collection found");
-    n.add(e, t.uid);
-  }), a(s, "scalar-delete-security-scheme", ({ detail: { uid: e } }) => {
-    if (!i.value)
-      return console.warn("No active collection found");
-    n.delete(e);
-  });
-};
-export {
-  y as useLegacyStoreEvents
-};

package/dist/v2/hooks/use-workspace-store-events.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"use-workspace-store-events.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-workspace-store-events.ts"],"names":[],"mappings":"AACA,OAAO,EAA0B,KAAK,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAE5F,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAE9B,eAAO,MAAM,uBAAuB,GAAI,OAAO,cAAc,EAAE,MAAM,GAAG,CAAC,WAAW,GAAG,IAAI,CAAC,SAsG3F,CAAA"}

package/dist/v2/hooks/use-workspace-store-events.js

@@ -1,40 +0,0 @@
-import { safeLocalStorage as v, REFERENCE_LS_KEYS as d } from "@scalar/helpers/object/local-storage";
-import { generateClientMutators as u } from "@scalar/workspace-store/client";
-import { onCustomEvent as c } from "@scalar/workspace-store/events";
-const p = (r, t) => {
-  const i = u(r);
-  c(t, "scalar-update-dark-mode", (e) => {
-    r.update("x-scalar-dark-mode", e.detail.value);
-  }), c(t, "scalar-update-active-document", (e) => {
-    r.update("x-scalar-active-document", e.detail.value);
-  }), c(t, "scalar-update-selected-client", (e) => {
-    r.update("x-scalar-default-client", e.detail), v().setItem(d.SELECTED_CLIENT, e.detail);
-  }), c(t, "scalar-replace-servers", (e) => {
-    const a = r.workspace.activeDocument;
-    a && (a.servers = e.detail.servers, a["x-scalar-active-server"] = e.detail.servers.at(-1)?.url);
-  }), c(t, "scalar-update-selected-server", (e) => {
-    const a = r.workspace.activeDocument;
-    a && (a["x-scalar-active-server"] = e.detail.value);
-  }), c(t, "store-update-selected-server-properties", (e) => {
-    const a = r.workspace.activeDocument;
-    if (!a)
-      return;
-    const s = a.servers?.find((l) => l.url === a["x-scalar-active-server"]);
-    s && (s[e.detail.key] = e.detail.value);
-  }), c(t, "scalar-update-selected-server-variables", (e) => {
-    const a = r.workspace.activeDocument;
-    if (!a)
-      return;
-    const s = a.servers?.find((l) => l.url === a["x-scalar-active-server"]);
-    s && s.variables?.[e.detail.key] && (s.variables[e.detail.key].default = e.detail.value);
-  }), c(t, "scalar-add-server", (e) => {
-    i.active().serverMutators.addServer(e.detail.server);
-    const a = r.workspace.activeDocument;
-    a && (a["x-scalar-active-server"] = e.detail.server.url);
-  }), c(t, "scalar-delete-server", (e) => {
-    i.active().serverMutators.deleteServer(e.detail.url);
-  });
-};
-export {
-  p as useWorkspaceStoreEvents
-};

package/dist/v2/styles.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=styles.d.ts.map

package/dist/v2/styles.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"styles.d.ts","sourceRoot":"","sources":["../../src/v2/styles.ts"],"names":[],"mappings":""}