@scalar/api-reference 1.38.0 → 1.39.0

package/dist/helpers/openapi.js

@@ -0,0 +1,119 @@
+import { isDereferenced } from "@scalar/openapi-types/helpers";
+import { getResolvedRef } from "@scalar/workspace-store/helpers/get-resolved-ref";
+function formatProperty(key, obj) {
+  let output = key;
+  const isRequired = obj.required?.includes(key);
+  output += isRequired ? " REQUIRED " : " optional ";
+  const property = getResolvedRef(obj.properties?.[key]);
+  if (property) {
+    output += property.type;
+    if (property.description) {
+      output += " " + property.description;
+    }
+  }
+  return output;
+}
+function recursiveLogger(obj) {
+  const results = ["Body"];
+  const schema = getResolvedRef(obj?.schema);
+  const properties = schema?.properties;
+  if (properties) {
+    Object.keys(properties).forEach((key) => {
+      if (!obj.schema) {
+        return;
+      }
+      results.push(formatProperty(key, schema));
+      const property = getResolvedRef(properties[key]);
+      const isNestedObject = property.type === "object" && Boolean(property.properties);
+      if (isNestedObject && property.properties) {
+        Object.keys(property.properties).forEach((subKey) => {
+          results.push(`${subKey} ${getResolvedRef(property.properties?.[subKey])?.type}`);
+        });
+      }
+    });
+  }
+  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,
+  formatProperty
+};

package/dist/{features/toolbar/uploadTempDocument.d.ts → helpers/upload-temp-document.d.ts}

@@ -1,3 +1,3 @@
 /** Upload a document and return a temporary URL */
 export declare function uploadTempDocument(document: string): Promise<string>;
-//# sourceMappingURL=uploadTempDocument.d.ts.map
+//# sourceMappingURL=upload-temp-document.d.ts.map

package/dist/helpers/upload-temp-document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-temp-document.d.ts","sourceRoot":"","sources":["../../src/helpers/upload-temp-document.ts"],"names":[],"mappings":"AASA,mDAAmD;AACnD,wBAAsB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAoB1E"}

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

@@ -0,0 +1,24 @@
+import { redirectToProxy } from "@scalar/oas-utils/helpers";
+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-intersection.d.ts

@@ -0,0 +1,3 @@
+import { type TemplateRef } from 'vue';
+export declare const useIntersection: (el: TemplateRef<HTMLElement | undefined>, onIntersect: () => void) => void;
+//# sourceMappingURL=use-intersection.d.ts.map

package/dist/hooks/use-intersection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-intersection.d.ts","sourceRoot":"","sources":["../../src/hooks/use-intersection.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,WAAW,EAAa,MAAM,KAAK,CAAA;AAEjD,eAAO,MAAM,eAAe,GAAI,IAAI,WAAW,CAAC,WAAW,GAAG,SAAS,CAAC,EAAE,aAAa,MAAM,IAAI,SAgChG,CAAA"}

package/dist/hooks/use-intersection.js

@@ -0,0 +1,32 @@
+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/hooks/use-legacy-store-events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-legacy-store-events.d.ts","sourceRoot":"","sources":["../../src/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/hooks/use-legacy-store-events.js

@@ -0,0 +1,91 @@
+import { onCustomEvent } from "@scalar/workspace-store/events";
+const useLegacyStoreEvents = (store, legacyStore, activeEntities, root) => {
+  const { servers, serverMutators, requestMutators, collectionMutators, securitySchemeMutators } = legacyStore;
+  const { activeCollection, activeServer } = activeEntities;
+  onCustomEvent(root, "scalar-replace-servers", ({ detail: { servers: inputServers, options } }) => {
+    if (options?.disableOldStoreUpdate === true) {
+      return;
+    }
+    const collection = activeCollection.value;
+    if (!collection) {
+      return console.warn("No active collection found");
+    }
+    collection.servers.forEach((serverUid) => {
+      serverMutators.delete(serverUid, collection.uid);
+    });
+    inputServers.forEach((server) => {
+      const result = Object.values(servers).find((s) => s.url === server.url);
+      if (result) {
+        serverMutators.add(result, collection.uid);
+      }
+    });
+    const lastServer = Object.values(servers).find((s) => s.url === inputServers.at(-1)?.url);
+    collectionMutators.edit(collection.uid, "selectedServerUid", lastServer?.uid);
+  });
+  onCustomEvent(root, "scalar-update-selected-server", ({ detail: { value, options } }) => {
+    if (options?.disableOldStoreUpdate === true) {
+      return;
+    }
+    const collection = activeCollection.value;
+    if (!collection) {
+      return;
+    }
+    const server = Object.values(servers).find((s) => s.url === value);
+    if (!server) {
+      return;
+    }
+    collectionMutators.edit(collection.uid, "selectedServerUid", server.uid);
+  });
+  onCustomEvent(root, "store-update-selected-server-properties", ({ detail: { key, value, options } }) => {
+    if (options?.disableOldStoreUpdate) {
+      return;
+    }
+    const server = activeServer.value;
+    if (!server) {
+      return;
+    }
+    serverMutators.edit(server.uid, key, value);
+  });
+  onCustomEvent(root, "scalar-update-selected-server-variables", ({ detail: { key, value, options } }) => {
+    if (options?.disableOldStoreUpdate === true) {
+      return;
+    }
+    const server = activeServer.value;
+    if (!server || server.url !== store.workspace.activeDocument?.["x-scalar-active-server"]) {
+      return;
+    }
+    const variables = server.variables || {};
+    variables[key] = { ...variables[key], default: value };
+    serverMutators.edit(server.uid, "variables", variables);
+  });
+  onCustomEvent(root, "scalar-select-security-schemes", ({ detail: { uids } }) => {
+    const collection = activeCollection.value;
+    if (!collection) {
+      return console.warn("No active collection found");
+    }
+    collectionMutators.edit(collection.uid, "selectedSecuritySchemeUids", uids);
+  });
+  onCustomEvent(root, "scalar-select-operation-security-schemes", ({ detail: { operationUid, uids } }) => {
+    requestMutators.edit(operationUid, "selectedSecuritySchemeUids", uids);
+  });
+  onCustomEvent(root, "scalar-edit-security-scheme", ({ detail: { uid, path, value } }) => {
+    securitySchemeMutators.edit(uid, path, value);
+  });
+  onCustomEvent(root, "scalar-add-auth-option", ({ detail: { payload } }) => {
+    const collection = activeCollection.value;
+    if (!collection) {
+      return console.warn("No active collection found");
+    }
+    securitySchemeMutators.add(payload, collection.uid);
+  });
+  onCustomEvent(root, "scalar-delete-security-scheme", ({ detail: { uid } }) => {
+    const collection = activeCollection.value;
+    if (!collection) {
+      return console.warn("No active collection found");
+    }
+    securitySchemeMutators.delete(uid);
+  });
+};
+export {
+  useLegacyStoreEvents
+};

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

@@ -0,0 +1 @@
+{"version":3,"file":"use-workspace-store-events.d.ts","sourceRoot":"","sources":["../../src/hooks/use-workspace-store-events.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,cAAc,EAA0B,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,SAgG3F,CAAA"}

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

@@ -0,0 +1,68 @@
+import { safeLocalStorage, REFERENCE_LS_KEYS } from "@scalar/helpers/object/local-storage";
+import { generateClientMutators } from "@scalar/workspace-store/client";
+import { onCustomEvent } from "@scalar/workspace-store/events";
+const useWorkspaceStoreEvents = (store, root) => {
+  const mutators = generateClientMutators(store);
+  onCustomEvent(root, "scalar-update-dark-mode", (event) => {
+    store.update("x-scalar-dark-mode", event.detail.value);
+  });
+  onCustomEvent(root, "scalar-update-active-document", (event) => {
+    store.update("x-scalar-active-document", event.detail.value);
+  });
+  onCustomEvent(root, "scalar-update-selected-client", (event) => {
+    store.update("x-scalar-default-client", event.detail);
+    safeLocalStorage().setItem(REFERENCE_LS_KEYS.SELECTED_CLIENT, event.detail);
+  });
+  onCustomEvent(root, "scalar-replace-servers", (event) => {
+    const activeDocument = store.workspace.activeDocument;
+    if (!activeDocument) {
+      return;
+    }
+    activeDocument.servers = event.detail.servers;
+    activeDocument["x-scalar-active-server"] = event.detail.servers.at(-1)?.url;
+  });
+  onCustomEvent(root, "scalar-update-selected-server", (event) => {
+    const activeDocument = store.workspace.activeDocument;
+    if (activeDocument) {
+      activeDocument["x-scalar-active-server"] = event.detail.value;
+    }
+  });
+  onCustomEvent(root, "store-update-selected-server-properties", (event) => {
+    const activeDocument = store.workspace.activeDocument;
+    if (!activeDocument) {
+      return;
+    }
+    const activeServer = activeDocument["servers"]?.find((it) => it.url === activeDocument["x-scalar-active-server"]);
+    if (!activeServer) {
+      return;
+    }
+    activeServer[event.detail.key] = event.detail.value;
+  });
+  onCustomEvent(root, "scalar-update-selected-server-variables", (event) => {
+    const activeDocument = store.workspace.activeDocument;
+    if (!activeDocument) {
+      return;
+    }
+    const activeServer = activeDocument["servers"]?.find((it) => it.url === activeDocument["x-scalar-active-server"]);
+    if (!activeServer) {
+      return;
+    }
+    const variable = activeServer.variables?.[event.detail.key];
+    if (variable) {
+      variable.default = event.detail.value;
+    }
+  });
+  onCustomEvent(root, "scalar-add-server", (event) => {
+    mutators.active().serverMutators.addServer(event.detail.server);
+    const activeDocument = store.workspace.activeDocument;
+    if (activeDocument) {
+      activeDocument["x-scalar-active-server"] = event.detail.server.url;
+    }
+  });
+  onCustomEvent(root, "scalar-delete-server", (event) => {
+    mutators.active().serverMutators.deleteServer(event.detail.url);
+  });
+};
+export {
+  useWorkspaceStoreEvents
+};

package/dist/index.d.ts

@@ -1,12 +1,12 @@
+import type { AnyApiReferenceConfiguration } from '@scalar/types';
+export type { ApiReferenceConfiguration } from '@scalar/types/api-reference';
 export { default as ApiReference } from './components/ApiReference.vue.js';
-export { default as ApiReferenceContent } from './components/ApiReferenceContent.vue.js';
-export { default as ApiReferenceLayout } from './components/ApiReferenceLayout.vue.js';
 export { default as GettingStarted } from './components/GettingStarted.vue.js';
 export { SearchButton, SearchModal } from './features/Search';
-export { useNavState } from './hooks/useNavState.js';
-export { createEmptySpecification } from './libs/openapi.js';
+export { createEmptySpecification } from './helpers/openapi.js';
+export { useWorkspaceStoreEvents } from './hooks/use-workspace-store-events.js';
 export { createApiReference } from './standalone/lib/html-api.js';
-export type { ApiReferenceConfiguration, ReferenceProps, } from './types';
-export { default as ApiReferenceWorkspace } from './v2/ApiReferenceWorkspace.vue.js';
-export { useWorkspaceStoreEvents } from './v2/hooks/use-workspace-store-events.js';
+export type ReferenceProps = {
+    configuration?: AnyApiReferenceConfiguration;
+};
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,MAAM,sCAAsC,CAAA;AACrF,OAAO,EAAE,OAAO,IAAI,kBAAkB,EAAE,MAAM,qCAAqC,CAAA;AAEnF,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAEjD,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAA;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAC9D,YAAY,EACV,yBAAyB,EACzB,cAAc,GACf,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AAEjF,OAAO,EAAE,uBAAuB,EAAE,MAAM,uCAAuC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,eAAe,CAAA;AAEjE,YAAY,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAG5E,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACvE,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE7D,OAAO,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAA;AAE5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAA;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAE9D,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,4BAA4B,CAAA;CAC7C,CAAA"}