@scalar/api-reference 1.26.1 → 1.28.1

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

@@ -1,4 +1,5 @@
 import { type ApiReferenceConfiguration } from '@scalar/types/api-reference';
+import { type App } from 'vue';
 /**
  * Reading the configuration from the data-attributes.
  */
@@ -7,5 +8,33 @@ export declare function getConfigurationFromDataAttributes(doc: Document): ApiRe
  * Mount the Scalar API Reference on a given document.
  * Read the HTML data-attributes for configuration.
  */
-export declare function mountScalarApiReference(doc: Document, configuration: ApiReferenceConfiguration): void;
+export declare function findDataAttributes(doc: Document, configuration: ApiReferenceConfiguration): void;
+export declare const createContainer: (doc: Document, element?: Element | null) => Element | null;
+type ApiReferenceInstance = {
+    /** The vue app instance */
+    app: App<Element>;
+    /** Destroy the current API Reference instance */
+    destroy: () => void;
+    /** Get the current configuration */
+    getConfiguration: () => Partial<ApiReferenceConfiguration>;
+    /** Update the configuration */
+    updateConfiguration: (newConfig: Partial<ApiReferenceConfiguration>) => void;
+};
+/** Function overload for createApiReference to allow multiple different signatures */
+export type CreateApiReference = {
+    /** Pass in the configuration only */
+    (configuration: Partial<ApiReferenceConfiguration>): ApiReferenceInstance;
+    /** Pass in the element or selector and configuration */
+    (elementOrSelector: Element | string, configuration: Partial<ApiReferenceConfiguration>): ApiReferenceInstance;
+};
+/**
+ * Create and mount a new Scalar API Reference
+ *
+ * @example createApiReference({ spec: { url: '/scalar.json' } })
+ * @example createApiReference('#api-reference', { spec: { url: '/scalar.json' } })
+ * @example createApiReference(document.body, { spec: { url: '/scalar.json' } })
+ *
+ */
+export declare const createApiReference: CreateApiReference;
+export {};
 //# sourceMappingURL=html-api.d.ts.map

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,EAAE,KAAK,yBAAyB,EAAmC,MAAM,6BAA6B,CAAA;AAQ7G;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,yBAAyB,CA8G3F;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,yBAAyB,QAsF9F"}
+{"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,yBAAyB,EAAmC,MAAM,6BAA6B,CAAA;AAE7G,OAAO,EAAE,KAAK,GAAG,EAA0B,MAAM,KAAK,CAAA;AAMtD;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,yBAAyB,CA+G3F;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,yBAAyB,QAiBzF;AAID,eAAO,MAAM,eAAe,QAAS,QAAQ,YAAY,OAAO,GAAG,IAAI,mBAatE,CAAA;AAGD,KAAK,oBAAoB,GAAG;IAC1B,2BAA2B;IAC3B,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;IACjB,iDAAiD;IACjD,OAAO,EAAE,MAAM,IAAI,CAAA;IACnB,oCAAoC;IACpC,gBAAgB,EAAE,MAAM,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAC1D,+BAA+B;IAC/B,mBAAmB,EAAE,CAAC,SAAS,EAAE,OAAO,CAAC,yBAAyB,CAAC,KAAK,IAAI,CAAA;CAC7E,CAAA;AAED,sFAAsF;AACtF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,qCAAqC;IACrC,CAAC,aAAa,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,oBAAoB,CAAA;IACzE,wDAAwD;IACxD,CAAC,iBAAiB,EAAE,OAAO,GAAG,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,oBAAoB,CAAA;CAC/G,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,EAAE,kBA8GhC,CAAA"}

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

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

package/dist/standalone/lib/register-globals.d.ts

@@ -0,0 +1,11 @@
+import { type CreateApiReference } from '../../standalone/lib/html-api.js';
+declare global {
+    interface Window {
+        Scalar: {
+            createApiReference: CreateApiReference;
+        };
+    }
+}
+/** Register any method on the global window.Scalar object, ensure the type is added to the window above */
+export declare const registerGlobals: () => void;
+//# sourceMappingURL=register-globals.d.ts.map

package/dist/standalone/lib/register-globals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"register-globals.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/register-globals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAGvF,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,MAAM,EAAE;YACN,kBAAkB,EAAE,kBAAkB,CAAA;SACvC,CAAA;KACF;CACF;AAED,2GAA2G;AAC3G,eAAO,MAAM,eAAe,YAW3B,CAAA"}