@scalar/api-reference 1.49.0 → 1.49.2

package/dist/helpers/load-from-perssistance.js

@@ -1,17 +0,0 @@
-import { isClient } from "@scalar/api-client/v2/blocks/operation-code-sample";
-import { clientStorage, authStorage } from "./storage.js";
-const loadClientFromStorage = (store) => {
-  const storedClient = clientStorage().get();
-  if (isClient(storedClient) && !store.workspace["x-scalar-default-client"]) {
-    store.update("x-scalar-default-client", storedClient);
-  }
-};
-const loadAuthFromStorage = (store, slug) => {
-  const authPersistence = authStorage();
-  const auth = authPersistence.getAuth(slug);
-  store.auth.load({ [slug]: auth });
-};
-export {
-  loadAuthFromStorage,
-  loadClientFromStorage
-};

package/dist/helpers/map-config-plugins.js

@@ -1,27 +0,0 @@
-import { watch } from "vue";
-const mapConfigPlugins = (config) => {
-  const plugin = { hooks: {} };
-  watch(
-    [() => config.value.onBeforeRequest, () => config.value.onRequestSent],
-    ([onBeforeRequest, onRequestSent]) => {
-      if (!plugin.hooks) {
-        plugin.hooks = {};
-      }
-      plugin.hooks.beforeRequest = onBeforeRequest ? async (payload) => {
-        const result = await onBeforeRequest(payload);
-        if (result === void 0) {
-          return payload;
-        }
-        return result;
-      } : void 0;
-      plugin.hooks.responseReceived = onRequestSent ? (payload) => {
-        onRequestSent(payload.request.url);
-      } : void 0;
-    },
-    { immediate: true }
-  );
-  return [plugin];
-};
-export {
-  mapConfigPlugins
-};

package/dist/helpers/map-config-to-workspace-store.js

@@ -1,45 +0,0 @@
-import { isClient } from "@scalar/api-client/v2/blocks/operation-code-sample";
-import { useSeoMeta } from "@unhead/vue";
-import { useFavicon } from "@vueuse/core";
-import { watch, toValue, computed } from "vue";
-const mapConfigToWorkspaceStore = ({
-  config,
-  store,
-  isDarkMode
-}) => {
-  watch(
-    () => toValue(config).defaultHttpClient,
-    (newValue) => {
-      if (newValue) {
-        const { targetKey, clientKey } = newValue;
-        const clientId = `${targetKey}/${clientKey}`;
-        if (isClient(clientId)) {
-          store.update("x-scalar-default-client", clientId);
-        }
-      }
-    },
-    { immediate: true }
-  );
-  watch(
-    () => toValue(config).darkMode,
-    (isDark) => store.update("x-scalar-color-mode", isDark ? "dark" : "light")
-  );
-  watch(
-    () => isDarkMode.value,
-    (newIsDark) => store.update("x-scalar-color-mode", newIsDark ? "dark" : "light"),
-    { immediate: true }
-  );
-  if (toValue(config).metaData) {
-    useSeoMeta(toValue(config).metaData);
-  }
-  watch(
-    () => toValue(config).proxyUrl,
-    (newProxyUrl) => store.update("x-scalar-active-proxy", newProxyUrl),
-    { immediate: true }
-  );
-  const favicon = computed(() => toValue(config).favicon);
-  useFavicon(favicon);
-};
-export {
-  mapConfigToWorkspaceStore
-};

package/dist/helpers/normalize-configurations.js

@@ -1,69 +0,0 @@
-import { parseJsonOrYaml } from "@scalar/oas-utils/helpers";
-import { isConfigurationWithSources, apiReferenceConfigurationWithSourceSchema } from "@scalar/types/api-reference";
-import GitHubSlugger from "github-slugger";
-const normalizeConfigurations = (configuration) => {
-  const slugger = new GitHubSlugger();
-  const normalized = {};
-  if (!configuration) {
-    return normalized;
-  }
-  const configList = Array.isArray(configuration) ? configuration : [configuration];
-  configList.flatMap((c) => {
-    if (isConfigurationWithSources(c)) {
-      const { sources: configSources, ...rest } = c;
-      return configSources?.map((source) => ({ ...rest, ...source })) ?? [];
-    }
-    return [c];
-  }).map((source) => {
-    const validated = apiReferenceConfigurationWithSourceSchema.safeParse(source);
-    return validated.success ? validated.data : null;
-  }).filter((c) => !!c && (!!c.url || !!c.content)).map((source, index) => addSlugAndTitle(source, index, slugger)).forEach((c) => {
-    const { url, content, ...config } = c;
-    normalized[c.slug] = {
-      config,
-      title: c.title,
-      slug: c.slug,
-      default: !!c?.default,
-      agent: c.agent,
-      source: content ? { content: normalizeContent(content) ?? {} } : { url }
-    };
-  });
-  return normalized;
-};
-const normalizeContent = (content) => {
-  if (!content) {
-    return null;
-  }
-  if (typeof content === "function") {
-    return normalizeContent(content());
-  }
-  if (typeof content === "string") {
-    return parseJsonOrYaml(content);
-  }
-  return content;
-};
-const addSlugAndTitle = (source, index = 0, slugger) => {
-  if (source.title) {
-    return {
-      ...source,
-      slug: source.slug || slugger.slug(source.title),
-      title: source.title
-    };
-  }
-  if (source.slug) {
-    return {
-      ...source,
-      slug: slugger.slug(source.slug),
-      title: source.slug
-    };
-  }
-  return {
-    ...source,
-    slug: `api-${index + 1}`,
-    title: `API #${index + 1}`
-  };
-};
-export {
-  normalizeConfigurations,
-  normalizeContent
-};

package/dist/helpers/openapi.js

@@ -1,135 +0,0 @@
-import { isDereferenced } from "@scalar/openapi-types/helpers";
-import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
-import { isObjectSchema } from "@scalar/workspace-store/schemas/v3.1/strict/type-guards";
-function resolveSchemaRef(ref) {
-  return getResolvedRef(ref);
-}
-function formatProperty(key, obj) {
-  let output = key;
-  const isRequired = obj.required?.includes(key);
-  output += isRequired ? " REQUIRED " : " optional ";
-  const propRef = obj.properties[key];
-  if (!propRef) return output;
-  const property = resolveSchemaRef(propRef);
-  if (property && typeof property === "object" && "type" in property) {
-    output += property.type ?? "";
-    if ("description" in property && typeof property.description === "string") {
-      output += " " + property.description;
-    }
-  }
-  return output;
-}
-function recursiveLogger(obj) {
-  const results = ["Body"];
-  const schema = getResolvedRef(obj?.schema);
-  if (!schema || !isObjectSchema(schema) || !schema.properties) {
-    return results;
-  }
-  const properties = schema.properties;
-  const schemaWithProps = {
-    properties,
-    required: schema.required
-  };
-  Object.keys(properties).forEach((key) => {
-    if (!obj.schema) {
-      return;
-    }
-    results.push(formatProperty(key, schemaWithProps));
-    const propRef = properties[key];
-    if (!propRef) return;
-    const property = resolveSchemaRef(propRef);
-    if (property && isObjectSchema(property) && property.properties) {
-      const nestedProperties = property.properties;
-      Object.keys(nestedProperties).forEach((subKey) => {
-        const ref = nestedProperties[subKey];
-        if (!ref) return;
-        const nested = resolveSchemaRef(ref);
-        const typeStr = nested && typeof nested === "object" && "type" in nested ? nested.type ?? "" : "";
-        results.push(`${subKey} ${typeStr}`);
-      });
-    }
-  });
-  return results;
-}
-function extractRequestBody(operation) {
-  try {
-    const media = getResolvedRef(operation?.requestBody)?.content?.["application/json"];
-    if (!media) {
-      throw new Error("Body not found");
-    }
-    return recursiveLogger(media);
-  } catch (_error) {
-    return false;
-  }
-}
-function deepMerge(source, target) {
-  for (const [key, val] of Object.entries(source)) {
-    if (val !== null && typeof val === "object") {
-      target[key] ??= new val.__proto__.constructor();
-      deepMerge(val, target[key]);
-    } else if (typeof val !== "undefined") {
-      target[key] = val;
-    }
-  }
-  return target;
-}
-function createEmptySpecification(partialSpecification) {
-  return deepMerge(partialSpecification ?? {}, {
-    info: {
-      title: "",
-      description: "",
-      termsOfService: "",
-      version: "",
-      license: {
-        name: "",
-        url: ""
-      },
-      contact: {
-        email: ""
-      }
-    },
-    servers: [],
-    tags: []
-  });
-}
-function createParameterMap(operation) {
-  const map = {
-    path: [],
-    query: [],
-    header: [],
-    cookie: [],
-    body: [],
-    formData: []
-  };
-  const parameters = operation.parameters ?? [];
-  if (parameters) {
-    parameters.forEach((parameter) => {
-      if (!isDereferenced(parameter)) {
-        return;
-      }
-      if (typeof parameter === "object" && parameter !== null && "$ref" in parameter) {
-        return;
-      }
-      if (parameter.in === "path") {
-        map.path.push(parameter);
-      } else if (parameter.in === "query") {
-        map.query.push(parameter);
-      } else if (parameter.in === "header") {
-        map.header.push(parameter);
-      } else if (parameter.in === "cookie") {
-        map.cookie.push(parameter);
-      } else if (parameter.in === "body") {
-        map.body.push(parameter);
-      } else if (parameter.in === "formData") {
-        map.formData.push(parameter);
-      }
-    });
-  }
-  return map;
-}
-export {
-  createEmptySpecification,
-  createParameterMap,
-  deepMerge,
-  extractRequestBody
-};

package/dist/helpers/storage.js

@@ -1,47 +0,0 @@
-import { REFERENCE_LS_KEYS, safeLocalStorage } from "@scalar/helpers/object/local-storage";
-import { AuthSchema } from "@scalar/workspace-store/entities/auth";
-import { coerceValue } from "@scalar/workspace-store/schemas/typebox-coerce";
-const storage = safeLocalStorage();
-const clientStorage = () => {
-  const key = REFERENCE_LS_KEYS.SELECTED_CLIENT;
-  return {
-    /**
-     * Gets the stored selected client from local storage.
-     */
-    get: () => {
-      return storage.getItem(key);
-    },
-    /**
-     * Stores the selected client value in local storage.
-     * @param value The value to store
-     */
-    set: (value) => {
-      storage.setItem(key, value);
-    }
-  };
-};
-const authStorage = () => {
-  const getKey = (slug) => {
-    return `${REFERENCE_LS_KEYS.AUTH}-${slug}`;
-  };
-  return {
-    /**
-     * Retrieves and coerces the authentication schemes stored in local storage.
-     */
-    getAuth: (slug) => {
-      const parsed = JSON.parse(storage.getItem(getKey(slug)) ?? "{}");
-      return coerceValue(AuthSchema, parsed);
-    },
-    /**
-     * Stores the authentication schemes in local storage.
-     * @param value The Auth object to stringify and store.
-     */
-    setAuth: (slug, value) => {
-      storage.setItem(getKey(slug), JSON.stringify(value));
-    }
-  };
-};
-export {
-  authStorage,
-  clientStorage
-};

package/dist/helpers/upload-temp-document.js

@@ -1,24 +0,0 @@
-import { redirectToProxy } from "@scalar/helpers/url/redirect-to-proxy";
-import { PROXY_URL, UPLOAD_TEMP_API_URL } from "../consts/urls.js";
-function isResponseBody(data) {
-  return !!data && typeof data === "object" && "url" in data && typeof data.url === "string";
-}
-async function uploadTempDocument(document) {
-  const body = JSON.stringify({ document });
-  const response = await fetch(redirectToProxy(PROXY_URL, UPLOAD_TEMP_API_URL), {
-    method: "POST",
-    headers: { "Content-Type": "application/json" },
-    body
-  });
-  if (!response.ok) {
-    throw new Error(` Failed to generate temporary link, server responded with ${response.status}`);
-  }
-  const data = await response.json();
-  if (!isResponseBody(data)) {
-    throw new Error("Failed to generate temporary link, invalid response from server");
-  }
-  return data.url;
-}
-export {
-  uploadTempDocument
-};

package/dist/hooks/use-agent.js

@@ -1,42 +0,0 @@
-import { isLocalUrl } from "@scalar/helpers/url/is-local-url";
-import { ref, computed, inject } from "vue";
-const AGENT_CONTEXT_SYMBOL = /* @__PURE__ */ Symbol();
-const agentStateRef = ref(null);
-function useAgent(options) {
-  const showAgent = ref(false);
-  const prefilledMessage = ref("");
-  const agentEnabled = options.agentEnabled ?? computed(() => isLocalUrl(window.location.href));
-  const openAgent = (message) => {
-    prefilledMessage.value = message ?? "";
-    showAgent.value = true;
-  };
-  const closeAgent = () => {
-    showAgent.value = false;
-    prefilledMessage.value = "";
-  };
-  const toggleAgent = () => {
-    showAgent.value = !showAgent.value;
-    if (!showAgent.value) {
-      prefilledMessage.value = "";
-    }
-  };
-  const state = {
-    showAgent,
-    agentEnabled,
-    prefilledMessage,
-    openAgent,
-    closeAgent,
-    toggleAgent
-  };
-  agentStateRef.value = state;
-  return state;
-}
-function useAgentContext() {
-  const injected = inject(AGENT_CONTEXT_SYMBOL, void 0);
-  return computed(() => injected ?? agentStateRef.value ?? void 0);
-}
-export {
-  AGENT_CONTEXT_SYMBOL,
-  useAgent,
-  useAgentContext
-};

package/dist/hooks/use-intersection.js

@@ -1,32 +0,0 @@
-import { useIntersectionObserver } from "@vueuse/core";
-import { onMounted } from "vue";
-const useIntersection = (el, onIntersect) => {
-  const calculateRootMargin = (element) => {
-    const height = element.offsetHeight;
-    return `${height / 2}px 0px ${height / 2}px 0px`;
-  };
-  const calculateThreshold = (element) => {
-    const height = element.offsetHeight;
-    return height < window.innerHeight ? 0.8 : 0.5;
-  };
-  onMounted(() => {
-    if (el.value) {
-      const options = {
-        rootMargin: calculateRootMargin(el.value),
-        threshold: calculateThreshold(el.value)
-      };
-      useIntersectionObserver(
-        el,
-        ([entry]) => {
-          if (entry?.isIntersecting) {
-            onIntersect();
-          }
-        },
-        options
-      );
-    }
-  });
-};
-export {
-  useIntersection
-};

package/dist/plugins/hooks/usePluginManager.js

@@ -1,14 +0,0 @@
-import { createPluginManager } from "../plugin-manager.js";
-import { inject } from "vue";
-const PLUGIN_MANAGER_SYMBOL = /* @__PURE__ */ Symbol();
-const usePluginManager = () => {
-  const manager = inject(PLUGIN_MANAGER_SYMBOL);
-  if (!manager) {
-    return createPluginManager({});
-  }
-  return manager;
-};
-export {
-  PLUGIN_MANAGER_SYMBOL,
-  usePluginManager
-};

package/dist/plugins/persistance-plugin.js

@@ -1,48 +0,0 @@
-import { debounce } from "@scalar/helpers/general/debounce";
-import { clientStorage, authStorage } from "../helpers/storage.js";
-const persistencePlugin = ({
-  debounceDelay = 500,
-  maxWait = 1e4,
-  prefix = "",
-  persistAuth = false
-}) => {
-  const { execute } = debounce({ delay: debounceDelay, maxWait });
-  const authPersistence = authStorage();
-  const clientPersistence = clientStorage();
-  const getPrefix = () => {
-    if (typeof prefix === "string") {
-      return prefix;
-    }
-    return prefix();
-  };
-  const getPersistAuth = () => {
-    if (typeof persistAuth === "function") {
-      return persistAuth();
-    }
-    return persistAuth;
-  };
-  return {
-    hooks: {
-      /**
-       * Handles all workspace state change events.
-       * Each write is debounced by a key to prevent frequent writes for the same entity.
-       */
-      onWorkspaceStateChanges(event) {
-        if (event.type === "meta") {
-          const defaultClient = event.value["x-scalar-default-client"];
-          if (defaultClient !== void 0) {
-            execute("x-scalar-default-client", () => clientPersistence.set(defaultClient));
-          }
-          return;
-        }
-        if (getPersistAuth() && event.type === "auth") {
-          execute("auth", () => authPersistence.setAuth(getPrefix(), event.value));
-        }
-        return;
-      }
-    }
-  };
-};
-export {
-  persistencePlugin
-};

package/dist/plugins/plugin-manager.js

@@ -1,39 +0,0 @@
-const createPluginManager = ({ plugins = [] }) => {
-  const registeredPlugins = /* @__PURE__ */ new Map();
-  plugins.forEach((plugin) => {
-    const pluginInstance = plugin();
-    registeredPlugins.set(pluginInstance.name, pluginInstance);
-  });
-  return {
-    /**
-     * Get all extensions with the given name from registered plugins
-     */
-    getSpecificationExtensions: (name) => {
-      const extensions = [];
-      for (const plugin of registeredPlugins.values()) {
-        for (const extension of plugin.extensions) {
-          if (extension.name === name) {
-            extensions.push(extension);
-          }
-        }
-      }
-      return extensions;
-    },
-    /**
-     * Get all components for a specific view from registered plugins
-     */
-    getViewComponents: (viewName) => {
-      const components = [];
-      for (const plugin of registeredPlugins.values()) {
-        const viewComponents = plugin.views?.[viewName];
-        if (viewComponents) {
-          components.push(...viewComponents);
-        }
-      }
-      return components;
-    }
-  };
-};
-export {
-  createPluginManager
-};

package/dist/standalone/lib/html-api.js

@@ -1,81 +0,0 @@
-import { createHead } from "@unhead/vue/client";
-import { reactive, createApp, h } from "vue";
-import ApiReference from "../../components/ApiReference.vue.js";
-const createApiReference = (elementOrSelectorOrConfig, optionalConfiguration) => {
-  const idPrefix = "scalar-refs";
-  const props = reactive({
-    // Either the configuration will be the second argument or it MUST be the first (configuration only)
-    configuration: optionalConfiguration ?? elementOrSelectorOrConfig ?? {}
-  });
-  let app = createApp(() => h(ApiReference, props));
-  app.use(createHead());
-  app.config.idPrefix = idPrefix;
-  if (optionalConfiguration) {
-    const element = typeof elementOrSelectorOrConfig === "string" ? document.querySelector(elementOrSelectorOrConfig) : elementOrSelectorOrConfig;
-    if (element) {
-      app.mount(element);
-    } else {
-      console.error("Could not find a mount point for API References:", elementOrSelectorOrConfig);
-    }
-  }
-  document.addEventListener(
-    "scalar:reload-references",
-    () => {
-      console.warn(
-        "scalar:reload-references event has been deprecated, please use the scalarInstance.app.mount method instead."
-      );
-      if (!props.configuration) {
-        return;
-      }
-      const currentElement = typeof elementOrSelectorOrConfig === "string" ? document.querySelector(elementOrSelectorOrConfig) : elementOrSelectorOrConfig;
-      if (!currentElement) {
-        return;
-      }
-      if (currentElement && !document.body.contains(currentElement)) {
-        document.body.appendChild(currentElement);
-      }
-      app.unmount();
-      app = createApp(() => h(ApiReference, props));
-      app.use(createHead());
-      app.config.idPrefix = idPrefix;
-      app.mount(currentElement);
-    },
-    false
-  );
-  const destroy = () => {
-    props.configuration = {};
-    app.unmount();
-  };
-  document.addEventListener(
-    "scalar:destroy-references",
-    () => {
-      console.warn("scalar:destroy-references event has been deprecated, please use scalarInstance.destroy instead.");
-      destroy();
-    },
-    false
-  );
-  document.addEventListener(
-    "scalar:update-references-config",
-    (ev) => {
-      console.warn(
-        "scalar:update-references-config event has been deprecated, please use scalarInstance.updateConfiguration instead."
-      );
-      if ("detail" in ev) {
-        Object.assign(props, ev.detail);
-      }
-    },
-    false
-  );
-  const instance = {
-    app,
-    getConfiguration: () => props.configuration ?? {},
-    updateConfiguration: (newConfig) => {
-      props.configuration = newConfig;
-    },
-    destroy
-  };
-  return instance;
-};
-export {
-  createApiReference
-};