@scalar/api-reference 1.38.1 → 1.39.1

package/dist/plugins/hooks/usePluginManager.js

@@ -1,10 +1,14 @@
-import { createPluginManager as n } from "../plugin-manager.js";
-import { inject as e } from "vue";
-const t = Symbol(), i = () => {
-  const r = e(t);
-  return r || n({});
+import { createPluginManager } from "../plugin-manager.js";
+import { inject } from "vue";
+const PLUGIN_MANAGER_SYMBOL = Symbol();
+const usePluginManager = () => {
+  const manager = inject(PLUGIN_MANAGER_SYMBOL);
+  if (!manager) {
+    return createPluginManager({});
+  }
+  return manager;
 };
 export {
-  t as PLUGIN_MANAGER_SYMBOL,
-  i as usePluginManager
+  PLUGIN_MANAGER_SYMBOL,
+  usePluginManager
 };

package/dist/plugins/plugin-manager.d.ts

@@ -1,4 +1,4 @@
-import type { ApiReferencePlugin as OriginalApiReferencePlugin, SpecificationExtension } from '@scalar/types/api-reference';
+import type { ApiReferencePlugin as OriginalApiReferencePlugin, SpecificationExtension, ViewComponent } from '@scalar/types/api-reference';
 export type ApiReferencePlugin = OriginalApiReferencePlugin;
 type CreatePluginManagerParams = {
     plugins?: ApiReferencePlugin[];
@@ -13,6 +13,10 @@ export declare const createPluginManager: ({ plugins }: CreatePluginManagerParam
      * Get all extensions with the given name from registered plugins
      */
     getSpecificationExtensions: (name: `x-${string}`) => SpecificationExtension[];
+    /**
+     * Get all components for a specific view from registered plugins
+     */
+    getViewComponents: (viewName: "content.end") => ViewComponent[];
 };
 export type PluginManager = ReturnType<typeof createPluginManager>;
 export {};

package/dist/plugins/plugin-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-manager.d.ts","sourceRoot":"","sources":["../../src/plugins/plugin-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,IAAI,0BAA0B,EAChD,sBAAsB,EACvB,MAAM,6BAA6B,CAAA;AAEpC,MAAM,MAAM,kBAAkB,GAAG,0BAA0B,CAAA;AAE3D,KAAK,yBAAyB,GAAG;IAC/B,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAC/B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAkB,yBAAyB;IAU3E;;OAEG;uCACgC,KAAK,MAAM,EAAE,KAAG,sBAAsB,EAAE;CAc9E,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAA"}
+{"version":3,"file":"plugin-manager.d.ts","sourceRoot":"","sources":["../../src/plugins/plugin-manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,IAAI,0BAA0B,EAChD,sBAAsB,EACtB,aAAa,EACd,MAAM,6BAA6B,CAAA;AAEpC,MAAM,MAAM,kBAAkB,GAAG,0BAA0B,CAAA;AAE3D,KAAK,yBAAyB,GAAG;IAC/B,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAA;CAC/B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,GAAI,aAAkB,yBAAyB;IAU3E;;OAEG;uCACgC,KAAK,MAAM,EAAE,KAAG,sBAAsB,EAAE;IAc3E;;OAEG;kCAC2B,aAAa,KAAG,aAAa,EAAE;CAahE,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAA"}

package/dist/plugins/plugin-manager.js

@@ -1,21 +1,39 @@
-const r = ({ plugins: o = [] }) => {
-  const s = /* @__PURE__ */ new Map();
-  return o.forEach((e) => {
-    const n = e();
-    s.set(n.name, n);
-  }), {
+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: (e) => {
-      const n = [];
-      for (const i of s.values())
-        for (const t of i.extensions)
-          t.name === e && n.push(t);
-      return n;
+    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 {
-  r as createPluginManager
+  createPluginManager
 };

package/dist/standalone/lib/html-api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,mCAAmC,EACnC,kBAAkB,EACnB,MAAM,6BAA6B,CAAA;AASpC;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,mCAAmC,CA+GrG;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,mCAAmC,QAiBnG;AAID,eAAO,MAAM,eAAe,GAAI,KAAK,QAAQ,EAAE,UAAU,OAAO,GAAG,IAAI,mBAatE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAwHhC,CAAA"}
+{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,mCAAmC,EACnC,kBAAkB,EACnB,MAAM,6BAA6B,CAAA;AAQpC;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,mCAAmC,CA+GrG;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,mCAAmC,QAiBnG;AAID,eAAO,MAAM,eAAe,GAAI,KAAK,QAAQ,EAAE,UAAU,OAAO,GAAG,IAAI,mBAatE,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBAwHhC,CAAA"}

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

@@ -1,54 +1,81 @@
-import { createHead as c } from "@unhead/vue";
-import { reactive as f, createApp as d, h as i } from "vue";
-import u from "../../components/ApiReference.vue.js";
-const g = (a, s) => {
-  const r = "scalar-refs", t = f({
-    // Either the configuration will be the second arugment or it MUST be the first (configuration only)
-    configuration: s ?? a ?? {}
+import { createHead } from "@unhead/vue";
+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 n = d(() => i(u, t));
-  if (n.use(c()), n.config.idPrefix = r, s) {
-    const e = typeof a == "string" ? document.querySelector(a) : a;
-    e ? n.mount(e) : console.error("Could not find a mount point for API References:", a);
+  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",
     () => {
-      if (console.warn(
+      console.warn(
         "scalar:reload-references event has been deprecated, please use the scalarInstance.app.mount method instead."
-      ), !t.configuration)
+      );
+      if (!props.configuration) {
+        return;
+      }
+      const currentElement = typeof elementOrSelectorOrConfig === "string" ? document.querySelector(elementOrSelectorOrConfig) : elementOrSelectorOrConfig;
+      if (!currentElement) {
         return;
-      const e = typeof a == "string" ? document.querySelector(a) : a;
-      e && (e && !document.body.contains(e) && document.body.appendChild(e), n.unmount(), n = d(() => i(u, t)), n.use(c()), n.config.idPrefix = r, n.mount(e));
+      }
+      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);
     },
-    !1
+    false
   );
-  const o = () => {
-    delete t.configuration, n.unmount();
+  const destroy = () => {
+    props.configuration = {};
+    app.unmount();
   };
-  return document.addEventListener(
+  document.addEventListener(
     "scalar:destroy-references",
     () => {
-      console.warn("scalar:destroy-references event has been deprecated, please use scalarInstance.destroy instead."), o();
+      console.warn("scalar:destroy-references event has been deprecated, please use scalarInstance.destroy instead.");
+      destroy();
     },
-    !1
-  ), document.addEventListener(
+    false
+  );
+  document.addEventListener(
     "scalar:update-references-config",
-    (e) => {
+    (ev) => {
       console.warn(
         "scalar:update-references-config event has been deprecated, please use scalarInstance.updateConfiguration instead."
-      ), "detail" in e && Object.assign(t, e.detail);
+      );
+      if ("detail" in ev) {
+        Object.assign(props, ev.detail);
+      }
     },
-    !1
-  ), {
-    app: n,
-    getConfiguration: () => t.configuration ?? {},
-    updateConfiguration: (e) => {
-      t.configuration = e;
+    false
+  );
+  const instance = {
+    app,
+    getConfiguration: () => props.configuration ?? {},
+    updateConfiguration: (newConfig) => {
+      props.configuration = newConfig;
     },
-    destroy: o
+    destroy
   };
+  return instance;
 };
 export {
-  g as createApiReference
+  createApiReference
 };