@scalar/api-reference 1.49.0 → 1.49.1

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

@@ -1,120 +0,0 @@
-import { defineComponent, ref, watch, computed, createBlock, openBlock, unref, withCtx, createElementVNode, createVNode, withKeys, withModifiers, isRef, createElementBlock, Fragment, renderList, createTextVNode, toDisplayString } from "vue";
-import { ScalarModal, ScalarSearchInput, ScalarSearchResultList } from "@scalar/components";
-import { nanoid } from "nanoid";
-import { useSearchIndex } from "../hooks/useSearchIndex.js";
-import _sfc_main$1 from "./SearchResult.vue.js";
-const _hoisted_1 = {
-  class: "mb-0 flex flex-col",
-  role: "search"
-};
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "SearchModal",
-  props: {
-    modalState: {},
-    document: {},
-    eventBus: {}
-  },
-  setup(__props) {
-    const props = __props;
-    const id = nanoid();
-    const listboxId = `${id}-search-result`;
-    const instructionsId = `${id}-search-instructions`;
-    const { query, results } = useSearchIndex(() => props.document);
-    const selectedIndex = ref(void 0);
-    watch(
-      () => props.modalState.open,
-      (open) => {
-        if (open) {
-          query.value = "";
-        }
-      }
-    );
-    const navigateSearchResults = (direction) => {
-      const offset = direction === "up" ? -1 : 1;
-      const length = results.value.length;
-      if (typeof selectedIndex.value === "number") {
-        selectedIndex.value = (selectedIndex.value + offset + length) % length;
-      } else {
-        selectedIndex.value = offset === -1 ? length - 1 : 0;
-      }
-    };
-    function handleSelect(idx) {
-      if (typeof idx !== "number" || !results.value[idx]) {
-        return;
-      }
-      const result = results.value[idx];
-      props.modalState.hide();
-      props.eventBus.emit("scroll-to:nav-item", { id: result.item.id });
-    }
-    const activeDescendantId = computed(() => {
-      const selectedResult = results.value[selectedIndex.value ?? -1];
-      return selectedResult ? `search-result-${selectedResult.item.id}` : void 0;
-    });
-    return (_ctx, _cache) => {
-      return openBlock(), createBlock(unref(ScalarModal), {
-        "aria-label": "Reference Search",
-        state: __props.modalState,
-        variant: "search"
-      }, {
-        default: withCtx(() => [
-          createElementVNode("div", _hoisted_1, [
-            createVNode(unref(ScalarSearchInput), {
-              modelValue: unref(query),
-              "onUpdate:modelValue": _cache[0] || (_cache[0] = ($event) => isRef(query) ? query.value = $event : null),
-              "aria-activedescendant": activeDescendantId.value,
-              "aria-autocomplete": "list",
-              "aria-controls": listboxId,
-              "aria-describedby": instructionsId,
-              role: "combobox",
-              onBlur: _cache[1] || (_cache[1] = ($event) => selectedIndex.value = void 0),
-              onKeydown: [
-                _cache[2] || (_cache[2] = withKeys(withModifiers(($event) => navigateSearchResults("down"), ["stop", "prevent"]), ["down"])),
-                _cache[3] || (_cache[3] = withKeys(withModifiers(() => handleSelect(selectedIndex.value), ["stop", "prevent"]), ["enter"])),
-                _cache[4] || (_cache[4] = withKeys(withModifiers(($event) => navigateSearchResults("up"), ["stop", "prevent"]), ["up"]))
-              ]
-            }, null, 8, ["modelValue", "aria-activedescendant"])
-          ]),
-          createVNode(unref(ScalarSearchResultList), {
-            id: listboxId,
-            "aria-label": "Reference Search Results",
-            class: "custom-scroll p-1 pt-0",
-            noResults: !unref(results).length
-          }, {
-            query: withCtx(() => [
-              createTextVNode(toDisplayString(unref(query)), 1)
-            ]),
-            default: withCtx(() => [
-              (openBlock(true), createElementBlock(Fragment, null, renderList(unref(results), (result, idx) => {
-                return openBlock(), createBlock(_sfc_main$1, {
-                  id: `search-result-${result.item.id}`,
-                  key: result.refIndex,
-                  isSelected: selectedIndex.value === idx,
-                  result,
-                  onClick: withModifiers(() => handleSelect(idx), ["prevent"])
-                }, null, 8, ["id", "isSelected", "result", "onClick"]);
-              }), 128))
-            ]),
-            _: 1
-          }, 8, ["noResults"]),
-          createElementVNode("div", {
-            id: instructionsId,
-            class: "ref-search-meta"
-          }, [..._cache[5] || (_cache[5] = [
-            createElementVNode("span", {
-              "aria-hidden": "true",
-              class: "contents"
-            }, [
-              createElementVNode("span", null, "↑↓ Navigate"),
-              createElementVNode("span", null, "⏎ Select")
-            ], -1),
-            createElementVNode("span", { class: "sr-only" }, " Press up arrow / down arrow to navigate, enter to select, type to filter results ", -1)
-          ])])
-        ]),
-        _: 1
-      }, 8, ["state"]);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/features/Search/components/SearchResult.vue.js

@@ -1,84 +0,0 @@
-import { defineComponent, createBlock, openBlock, unref, createSlots, withCtx, createElementVNode, normalizeClass, createTextVNode, createElementBlock, createCommentVNode, toDisplayString, Fragment, createVNode } from "vue";
-import { ScalarSearchResultItem } from "@scalar/components";
-import { ScalarIconTerminalWindow, ScalarIconTag, ScalarIconBracketsCurly, ScalarIconTextAlignLeft } from "@scalar/icons";
-import { HttpMethod } from "@scalar/sidebar";
-const _hoisted_1 = { class: "sr-only" };
-const _hoisted_2 = { class: "inline-flex items-center gap-1" };
-const _hoisted_3 = { class: "sr-only" };
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "SearchResult",
-  props: {
-    id: {},
-    isSelected: { type: Boolean },
-    result: {}
-  },
-  setup(__props) {
-    const ENTRY_ICONS = {
-      heading: ScalarIconTextAlignLeft,
-      model: ScalarIconBracketsCurly,
-      operation: ScalarIconTerminalWindow,
-      tag: ScalarIconTag,
-      webhook: ScalarIconTerminalWindow
-    };
-    const ENTRY_LABELS = {
-      heading: "Heading",
-      operation: "Operation",
-      tag: "Tag",
-      model: "Model",
-      webhook: "Webhook"
-    };
-    return (_ctx, _cache) => {
-      return openBlock(), createBlock(unref(ScalarSearchResultItem), {
-        id: __props.id,
-        icon: ENTRY_ICONS[__props.result.item.type],
-        selected: __props.isSelected
-      }, createSlots({
-        default: withCtx(() => [
-          createElementVNode("span", {
-            class: normalizeClass({
-              "text-decoration-line": __props.result.item.entry.type === "operation" && __props.result.item.entry.isDeprecated
-            })
-          }, [
-            createElementVNode("span", _hoisted_1, [
-              createTextVNode(toDisplayString(ENTRY_LABELS[__props.result.item.type]) + ":  ", 1),
-              __props.result.item.entry.type === "operation" && __props.result.item.entry.isDeprecated ? (openBlock(), createElementBlock(Fragment, { key: 0 }, [
-                createTextVNode(" (Deprecated)  ")
-              ], 64)) : createCommentVNode("", true)
-            ]),
-            createTextVNode(" " + toDisplayString(__props.result.item.title) + " ", 1),
-            _cache[0] || (_cache[0] = createElementVNode("span", { class: "sr-only" }, ",", -1))
-          ], 2)
-        ]),
-        _: 2
-      }, [
-        __props.result.item.type !== "webhook" && (__props.result.item.method || __props.result.item.path) && __props.result.item.path !== __props.result.item.title ? {
-          name: "description",
-          fn: withCtx(() => [
-            createElementVNode("span", _hoisted_2, [
-              __props.result.item.type === "operation" ? (openBlock(), createElementBlock(Fragment, { key: 0 }, [
-                createVNode(unref(HttpMethod), {
-                  "aria-hidden": "true",
-                  method: __props.result.item.method ?? "get"
-                }, null, 8, ["method"]),
-                createElementVNode("span", _hoisted_3, " HTTP Method: " + toDisplayString(__props.result.item.method ?? "get"), 1)
-              ], 64)) : createCommentVNode("", true),
-              _cache[1] || (_cache[1] = createElementVNode("span", { class: "sr-only" }, "Path: ", -1)),
-              createTextVNode(" " + toDisplayString(__props.result.item.path), 1)
-            ])
-          ]),
-          key: "0"
-        } : __props.result.item.description ? {
-          name: "description",
-          fn: withCtx(() => [
-            _cache[2] || (_cache[2] = createElementVNode("span", { class: "sr-only" }, "Description: ", -1)),
-            createTextVNode(" " + toDisplayString(__props.result.item.description), 1)
-          ]),
-          key: "1"
-        } : void 0
-      ]), 1032, ["id", "icon", "selected"]);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

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

@@ -1,4 +0,0 @@
-import _sfc_main from "./SearchResult.vue.js";
-export {
-  _sfc_main as default
-};

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

@@ -1,43 +0,0 @@
-import Fuse from "fuse.js";
-function createFuseInstance() {
-  return new Fuse([], {
-    // 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: "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: true,
-    // Include detailed match information showing which parts of the text matched
-    includeMatches: true,
-    // Don't require matches to be at the beginning of strings
-    // Makes search more flexible and user-friendly
-    ignoreLocation: true,
-    // Enable advanced search syntax like 'exact' for exact matches or !exclude for exclusions
-    useExtendedSearch: true,
-    // Find all possible matches in each item, not just the first one
-    // Ensures comprehensive search results
-    findAllMatches: true
-  });
-}
-export {
-  createFuseInstance
-};

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

@@ -1,119 +0,0 @@
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { extractRequestBody, createParameterMap } from "../../../helpers/openapi.js";
-function createSearchIndex(document) {
-  const index = [];
-  function processEntries(entriesToProcess) {
-    entriesToProcess.forEach((entry) => {
-      addEntryToIndex(entry, index, document);
-      if ("children" in entry && entry.children) {
-        processEntries(entry.children);
-      }
-    });
-  }
-  processEntries(document?.["x-scalar-navigation"]?.children ?? []);
-  return index;
-}
-function addEntryToIndex(entry, index, document) {
-  if (entry.type === "operation") {
-    const operation = getResolvedRef(document?.paths?.[entry.path]?.[entry.method]) ?? {};
-    const requestBodyOrParameterMap = extractRequestBody(operation) || createParameterMap(operation);
-    const body = typeof requestBodyOrParameterMap !== "boolean" ? requestBodyOrParameterMap : null;
-    index.push({
-      type: "operation",
-      title: entry.title,
-      id: entry.id,
-      description: operation.description || "",
-      method: entry.method,
-      path: entry.path,
-      body: body || "",
-      operationId: operation.operationId,
-      entry
-    });
-    return;
-  }
-  if (entry.type === "webhook") {
-    const webhook = getResolvedRef(document?.webhooks?.[entry.name]?.[entry.method]) ?? {};
-    index.push({
-      id: entry.id,
-      type: "webhook",
-      title: entry.title,
-      description: "Webhook",
-      method: entry.method,
-      body: webhook.description || "",
-      operationId: webhook.operationId,
-      entry
-    });
-    return;
-  }
-  if (entry.type === "model") {
-    const schema = getResolvedRef(document?.components?.schemas?.[entry.name]);
-    const description = schema?.description ?? "";
-    index.push({
-      type: "model",
-      title: entry.title,
-      description: "Model",
-      id: entry.id,
-      body: description,
-      entry
-    });
-    return;
-  }
-  if (entry.type === "models") {
-    index.push({
-      id: entry.id,
-      type: "heading",
-      title: "Models",
-      description: "Heading",
-      body: "",
-      entry
-    });
-    return;
-  }
-  if (entry.type === "tag" && entry.isWebhooks === true) {
-    index.push({
-      id: entry.id,
-      type: "heading",
-      title: "Webhooks",
-      description: "Heading",
-      body: "",
-      entry
-    });
-    return;
-  }
-  if (entry.type === "tag" && entry.isGroup === false) {
-    index.push({
-      id: entry.id,
-      title: entry.title,
-      description: entry.description || "",
-      type: "tag",
-      body: "",
-      entry
-    });
-    return;
-  }
-  if (entry.type === "tag" && entry.isGroup === true) {
-    index.push({
-      id: entry.id,
-      title: entry.title,
-      description: "Tag Group",
-      type: "tag",
-      body: "",
-      entry
-    });
-    return;
-  }
-  if (entry.type === "text") {
-    index.push({
-      id: entry.id,
-      type: "heading",
-      title: entry.title ?? "",
-      description: "Heading",
-      body: "",
-      entry
-    });
-    return;
-  }
-}
-export {
-  createSearchIndex
-};

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

@@ -1,33 +0,0 @@
-import { computed, toValue, ref } from "vue";
-import { createFuseInstance } from "../helpers/create-fuse-instance.js";
-import { createSearchIndex } from "../helpers/create-search-index.js";
-const MAX_SEARCH_RESULTS = 25;
-function useSearchIndex(document) {
-  const fuse = computed(() => {
-    const instance = createFuseInstance();
-    instance.setCollection(createSearchIndex(toValue(document)));
-    return instance;
-  });
-  const query = ref("");
-  const results = computed(() => {
-    if (query.value.length !== 0) {
-      return fuse.value.search(query.value, {
-        limit: MAX_SEARCH_RESULTS
-      });
-    }
-    const allEntries = fuse.value._docs;
-    return allEntries.slice(0, MAX_SEARCH_RESULTS).map(
-      (item, index) => ({
-        item,
-        refIndex: index
-      })
-    );
-  });
-  return {
-    results,
-    query
-  };
-}
-export {
-  useSearchIndex
-};

package/dist/features/ask-agent-button/AskAgentButton.vue.js

@@ -1,7 +0,0 @@
-import _sfc_main from "./AskAgentButton.vue2.js";
-/* empty css                    */
-import _export_sfc from "../../_virtual/_plugin-vue_export-helper.js";
-const AskAgentButton = /* @__PURE__ */ _export_sfc(_sfc_main, [["__scopeId", "data-v-78f5377c"]]);
-export {
-  AskAgentButton as default
-};

package/dist/features/ask-agent-button/AskAgentButton.vue2.js

@@ -1,51 +0,0 @@
-import { defineComponent, ref, createElementBlock, createCommentVNode, unref, openBlock, withModifiers, createVNode, createElementVNode, withDirectives, normalizeClass, vModelText } from "vue";
-import { ScalarIconSparkle, ScalarIconArrowUp } from "@scalar/icons";
-import { useAgentContext } from "../../hooks/use-agent.js";
-const _hoisted_1 = {
-  class: "ask-agent-scalar-send",
-  type: "submit"
-};
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "AskAgentButton",
-  setup(__props) {
-    const agentContext = useAgentContext();
-    const message = ref("");
-    const inputRef = ref();
-    function handleSubmit() {
-      agentContext.value?.openAgent(message.value);
-      message.value = "";
-    }
-    return (_ctx, _cache) => {
-      return unref(agentContext)?.agentEnabled.value ? (openBlock(), createElementBlock("form", {
-        key: 0,
-        class: "agent-button-container",
-        onClick: _cache[1] || (_cache[1] = ($event) => inputRef.value?.focus()),
-        onSubmit: _cache[2] || (_cache[2] = withModifiers(($event) => handleSubmit(), ["prevent"]))
-      }, [
-        createVNode(unref(ScalarIconSparkle), {
-          class: "size-3 shrink-0",
-          weight: "fill"
-        }),
-        _cache[3] || (_cache[3] = createElementVNode("div", { class: "ask-agent-scalar-input-label" }, "Ask AI Agent", -1)),
-        withDirectives(createElementVNode("input", {
-          ref_key: "inputRef",
-          ref: inputRef,
-          "onUpdate:modelValue": _cache[0] || (_cache[0] = ($event) => message.value = $event),
-          class: normalizeClass(["ask-agent-scalar-input", { "ask-agent-scalar-input-not-empty": message.value.length > 0 }]),
-          placeholder: "Ask AI Agent"
-        }, null, 2), [
-          [vModelText, message.value]
-        ]),
-        createElementVNode("button", _hoisted_1, [
-          createVNode(unref(ScalarIconArrowUp), {
-            class: "size-3",
-            weight: "bold"
-          })
-        ])
-      ], 32)) : createCommentVNode("", true);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/features/developer-tools/DeveloperTools.vue.js

@@ -1,60 +0,0 @@
-import { defineComponent, mergeModels, useModel, computed, createElementBlock, createCommentVNode, openBlock, createElementVNode, createVNode, Fragment } from "vue";
-import { isLocalUrl } from "@scalar/helpers/url/is-local-url";
-import _sfc_main$1 from "./components/ApiReferenceToolbarTitle.vue.js";
-import _sfc_main$4 from "./components/DeployApiReference.vue.js";
-import _sfc_main$2 from "./components/ModifyConfiguration.vue.js";
-import _sfc_main$3 from "./components/ShareApiReference.vue.js";
-const _hoisted_1 = {
-  key: 0,
-  "aria-label": "Developer Tools",
-  class: "api-reference-toolbar bg-b-1 relative z-1 flex h-10 justify-center border-b px-15"
-};
-const _hoisted_2 = { class: "-mx-2 flex max-w-(--refs-content-max-width) flex-1 items-center" };
-const _hoisted_3 = { class: "flex flex-1 items-center" };
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "DeveloperTools",
-  props: /* @__PURE__ */ mergeModels({
-    workspace: {},
-    configuration: {}
-  }, {
-    "overrides": {},
-    "overridesModifiers": {}
-  }),
-  emits: ["update:overrides"],
-  setup(__props) {
-    const overrides = useModel(__props, "overrides");
-    const showDeveloperTools = computed(() => {
-      if (__props.configuration?.showDeveloperTools === "always") {
-        return true;
-      }
-      if (__props.configuration?.showDeveloperTools === "never") {
-        return false;
-      }
-      if (typeof window === "undefined") {
-        return false;
-      }
-      return isLocalUrl(window.location.href);
-    });
-    return (_ctx, _cache) => {
-      return showDeveloperTools.value ? (openBlock(), createElementBlock("header", _hoisted_1, [
-        createElementVNode("div", _hoisted_2, [
-          createElementVNode("div", _hoisted_3, [
-            createVNode(_sfc_main$1)
-          ]),
-          createVNode(_sfc_main$2, {
-            overrides: overrides.value,
-            "onUpdate:overrides": _cache[0] || (_cache[0] = ($event) => overrides.value = $event),
-            configuration: __props.configuration
-          }, null, 8, ["overrides", "configuration"]),
-          __props.workspace ? (openBlock(), createElementBlock(Fragment, { key: 0 }, [
-            createVNode(_sfc_main$3, { workspace: __props.workspace }, null, 8, ["workspace"]),
-            createVNode(_sfc_main$4, { workspace: __props.workspace }, null, 8, ["workspace"])
-          ], 64)) : createCommentVNode("", true)
-        ])
-      ])) : createCommentVNode("", true);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/features/developer-tools/DeveloperTools.vue2.js

@@ -1,4 +0,0 @@
-import _sfc_main from "./DeveloperTools.vue.js";
-export {
-  _sfc_main as default
-};

package/dist/features/developer-tools/components/ApiReferenceToolbarBlurb.vue.js

@@ -1,13 +0,0 @@
-import { createElementBlock, openBlock, renderSlot } from "vue";
-import _export_sfc from "../../../_virtual/_plugin-vue_export-helper.js";
-const _sfc_main = {};
-const _hoisted_1 = { class: "text-c-3 [&_code]:font-code [&_a:hover]:text-c-1 text-center leading-normal [&_a]:underline" };
-function _sfc_render(_ctx, _cache) {
-  return openBlock(), createElementBlock("p", _hoisted_1, [
-    renderSlot(_ctx.$slots, "default")
-  ]);
-}
-const ApiReferenceToolbarBlurb = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
-export {
-  ApiReferenceToolbarBlurb as default
-};

package/dist/features/developer-tools/components/ApiReferenceToolbarConfigLayout.vue.js

@@ -1,33 +0,0 @@
-import { defineComponent, useModel, computed, createBlock, openBlock, unref } from "vue";
-import { ScalarCheckboxRadioGroup } from "@scalar/components";
-const _sfc_main = /* @__PURE__ */ defineComponent({
-  __name: "ApiReferenceToolbarConfigLayout",
-  props: {
-    "modelValue": {},
-    "modelModifiers": {}
-  },
-  emits: ["update:modelValue"],
-  setup(__props) {
-    const ModernOption = { label: "Modern", value: "modern" };
-    const ClassicOption = { label: "Classic", value: "classic" };
-    const options = [
-      ModernOption,
-      ClassicOption
-    ];
-    const model = useModel(__props, "modelValue");
-    const selected = computed({
-      get: () => model.value === "modern" ? ModernOption : ClassicOption,
-      set: (option) => model.value = option.value
-    });
-    return (_ctx, _cache) => {
-      return openBlock(), createBlock(unref(ScalarCheckboxRadioGroup), {
-        modelValue: selected.value,
-        "onUpdate:modelValue": _cache[0] || (_cache[0] = ($event) => selected.value = $event),
-        options
-      }, null, 8, ["modelValue"]);
-    };
-  }
-});
-export {
-  _sfc_main as default
-};

package/dist/features/developer-tools/components/ApiReferenceToolbarConfigLayout.vue2.js

@@ -1,4 +0,0 @@
-import _sfc_main from "./ApiReferenceToolbarConfigLayout.vue.js";
-export {
-  _sfc_main as default
-};