@epigraph/epigraph-std-lib 3.3.1 → 4.0.0

package/README.md

@@ -13,18 +13,8 @@ A global object that must only be initialized once per session and provides some
 | EpigraphBaseSolutionLitElement | A base class intended to enforce some common functionalities across our solutions, built by extending the LitElement |
 | EpigraphLogger | A logger class that provides a convenient way for logging info, warning or errors in any given session |
 | EpigraphQrCoreGenerator | A Utility class that allows the generation of a QR code from a give string input |
-| EpigraphUnitsConverter | A Utility class that allows conversion between different standard unit, including but not limited to Distance, Color, etc. |
-| EpigraphUrlProcessor | A Utility class that provides various methods to generate, process, manipulate URLs |
-
-
-### 3rd PARTY LIBRARY EXPORTS
-
-| Name  | Version  |
-|---|---|
-| [three](https://threejs.org/) | ![three version](https://img.shields.io/badge/three-0.169.0-green) |
-| [model-viewer](https://modelviewer.dev/) | ![@google/model-viewer version](https://img.shields.io/badge/model--viewer-4.0.0-green) |
-| [@epigraph/epigraph-analytics](https://www.npmjs.com/package/@epigraph/epigraph-analytics)  |![@epigraph/epigraph-analytics version](https://img.shields.io/badge/epigraph--analytics-1.0.0-green)|
-| [qr-creator](https://www.npmjs.com/package/qr-creator)  |![qr-creator version](https://img.shields.io/badge/qr--creator-1.0.0-green)|
+| EpigraphUnitsConverter |  |
+| EpigraphUrlProcessor |  |
 
 
 # HOW TO:
@@ -32,8 +22,36 @@ A global object that must only be initialized once per session and provides some
 ### Add a new EpigraphLibrary:
 1. Create a new directory under lib/EpigraphLibs/`<MyEpigraphLibrary>`
 2. Create the module file/s. Ensure that the names of these files are in camelCase.
-3. Export this module in lib/EpigraphLibs/epigraph-std-lib.ts as `export * from "./ThirdPartyLibs/main";`
-4. Write a test for this Library under tests/<MyEpigraphLibrary.test.ts>
+3. Write a test for this Library under tests/<MyEpigraphLibrary.test.ts>
+4. Add the module that you wish to export as an entry in vite.config.ts > defineConfig > build > entry, similar to other entries in there. This will bundle the new module on build.
+5. Go to package.json:
+    - Add the new module entry under exports similar to other entries in that field.
+    - Add the new module entry under typesVersions similar to other entries in that field.
+
+### Use the library
+This library exports the module into submodules to allow for better tree shaking when bundling the final product. Here is how you can import the submodules individually.
+
+```javascript
+// Epigraph Object
+import { Epigraph } from "@epigraph/epigraph-std-lib/dist/Epigraph/epigraph";
+
+// Epigraph libs
+import { EpigraphAnalytics } from "@epigraph/epigraph-std-lib/dist/EpigraphLibs/epigraphAnalytics";
+
+```
+
+Exported Submodules:
+| Name  | Description  |
+|---|---|
+| @epigraph/epigraph-std-lib/dist/Epigraph/epigraph | A base class intended to enforce some common functionalities across our solutions, built by extending the HTMLElement |
+| @epigraph/epigraph-std-lib/dist/EpigraphLibs/epigraphAnalytics | An Analytics modules that exports handy ways to log analytics across our solutions |
+| @epigraph/epigraph-std-lib/dist/EpigraphLibs/epigraphLogger | A Logger modules that exports handy ways to log across our solutions |
+| @epigraph/epigraph-std-lib/dist/EpigraphLibs/epigraphNexusApi | A Nexus API modules that exports handy ways to interact with the Nexus API across our solutions |
+| @epigraph/epigraph-std-lib/dist/EpigraphLibs/epigraphQrCodeGenerator | A QR Code generator modules that exports handy ways to generate QR Codes across our solutions |
+| @epigraph/epigraph-std-lib/dist/EpigraphLibs/epigraphResultFactory | A Result Factory modules that exports handy ways to generate Result objects across our solutions |
+| @epigraph/epigraph-std-lib/dist/EpigraphLibs/epigraphUnitsConverter | A Utility class that allows conversion between different standard unit, including but not limited to Distance, Color, etc. |
+| @epigraph/epigraph-std-lib/dist/EpigraphLibs/epigraphUrlProcessor | A Utility class that provides various methods to generate, process, manipulate URLs |
+
 
 ### Write a test: 
 We use [vitest](https://vitest.dev/guide/) to write tests in this repository using [happy-dom](https://www.npmjs.com/package/happy-dom) to support some but not all browser functionalities. In order to write a new test:

package/dist/Epigraph/epigraph.d.ts

@@ -1,6 +1,6 @@
 import { EpigraphLogger, LoggerModeNames } from '../EpigraphLibs/EpigraphLogger/epigraphLogger';
 import { ENVIRONMENT_TYPE } from './constants/enums';
-import { UrlProcessor } from '../EpigraphLibs/EpigraphUrlProcessor/epigraphUrlProcessor';
+import { EpigraphUrlProcessor } from '../EpigraphLibs/EpigraphUrlProcessor/epigraphUrlProcessor';
 import { EpigraphBaseSolutionTypes, EpigraphBaseSolutionHtmlElement, EpigraphBaseSolutionLitElement } from './epigraphBaseSolution';
 /**
  * Epigraph component is intended to be a global source of truth/tracker in a given session for all of our components.
@@ -24,7 +24,7 @@ export declare class Epigraph {
     constructor(initializer: EpigraphBaseSolutionTypes);
     get isReady(): boolean;
     get logger(): EpigraphLogger;
-    get urlProcessor(): UrlProcessor;
+    get urlProcessor(): EpigraphUrlProcessor;
     get epigraphSessionId(): string;
     get environment(): ENVIRONMENT_TYPE;
     get initializer(): EpigraphBaseSolutionTypes;

package/dist/Epigraph/epigraph.js

@@ -0,0 +1,114 @@
+import { EpigraphLogger as a, LoggerModeNames as r } from "../EpigraphLibs/EpigraphLogger/epigraphLogger.js";
+import { ENVIRONMENT_TYPE as s } from "../lib/Epigraph/constants/enums.js";
+import { EpigraphUrlProcessor as p, QUERY_PARAMETER_NAMES as l } from "../EpigraphLibs/EpigraphUrlProcessor/epigraphUrlProcessor.js";
+import { EpigraphBaseSolutionHtmlElement as w, EpigraphBaseSolutionLitElement as I } from "../lib/Epigraph/epigraphBaseSolution.js";
+class g {
+  constructor(e) {
+    if (this._loggerContext = "EPIGRAPH", this._isReady = !1, this._logger = new a("EPIGRAPH LOGGER"), this._environment = s.DEVELOPMENT, this._activeComponentsInSession = /* @__PURE__ */ new Map(), this._staleComponentsInSession = /* @__PURE__ */ new Map(), window.epigraph)
+      return window.epigraph.registerActiveComponent(e), window.epigraph;
+    window.epigraph = this, window.epigraph.registerActiveComponent(e), this.logBranding(), this._initializer = e, this._environment = this._initializer.environment;
+    const t = this.getLoggerModeNameFromEnvironment();
+    this._logger.setCurrentMode(t), this._urlProcessor = new p(), this.id = g.safeGenerateUuid();
+    const i = this._urlProcessor.getParameterInUrl(l.epigraphSessionId);
+    this._epigraphSessionId = i ?? g.safeGenerateUuid(), this._logger.info({ title: "Epigraph Object Ready!!", details: this, contextOverride: this._loggerContext }), this._isReady = !0;
+  }
+  get isReady() {
+    return this._isReady;
+  }
+  get logger() {
+    return this._logger;
+  }
+  get urlProcessor() {
+    return this._urlProcessor;
+  }
+  get epigraphSessionId() {
+    return this._epigraphSessionId;
+  }
+  get environment() {
+    return this._environment;
+  }
+  get initializer() {
+    return this._initializer;
+  }
+  get activeComponentsInSession() {
+    return this._activeComponentsInSession;
+  }
+  get staleComponentsInSession() {
+    return this._staleComponentsInSession;
+  }
+  /**
+   * Logs Epigraph Branding in the console to help redirect potential interests in the right direction.
+   */
+  logBranding() {
+    console.group("Powered by: "), console.log("%cEPIGRAPH", "font-weight: bold; font-size: 50px; text-shadow: 3px 3px 0 rgb(100,100,100)"), console.log("Visit for more details: www.epigraph.us"), console.groupEnd();
+  }
+  /**
+   * Registers a new component that was initialized on this page.
+   * This is optional from the perspective of the initialization flow but highly recommend
+   * registering any component that gets initialized in this session.
+   * Any component that inherits from EpigraphBaseSolution should automatically register itself on initialization.
+   *
+   * @param {EpigraphBaseSolutionTypes} solutionRef A type of Epigraph base component that is initialized in the session.
+   */
+  registerActiveComponent(e) {
+    this._activeComponentsInSession.set(e.uuid, e), this._logger.info({ title: "Registered a new Active Component", details: e, contextOverride: this._loggerContext });
+  }
+  /**
+   * De-Registers a component that was initialized on this page.
+   * This is optional from the perspective of the unmount flow but highly recommend
+   * de-registering any component that gets removed in this session.
+   * Any component that inherits from EpigraphBaseSolution should automatically de-register itself on unmount.
+   *
+   * @param {EpigraphBaseSolutionTypes} solutionRef A type of Epigraph base component that is initialized in the session.
+   */
+  deregisterActiveComponent(e) {
+    const t = this._activeComponentsInSession.get(e.uuid);
+    t && (this._staleComponentsInSession.set(t.uuid, t), this._activeComponentsInSession.delete(t.uuid), this._logger.info({ title: "Deregistered a new Active Component", details: e, contextOverride: this._loggerContext }));
+  }
+  /**
+   * Gets the mode that the logger should be executed in, based on the runtime environment.
+   *
+   * @returns {LoggerModeNames} A valid logger mode name.
+   */
+  getLoggerModeNameFromEnvironment() {
+    let e = r.Dev;
+    return this._environment === s.STAGING ? e = r.Staging : this._environment === s.PRODUCTION && (e = r.Release), e;
+  }
+  /**
+   * Generates a random UUID using crypto.randomUUID with a fallback on custom generator,
+   * if the first option fails for any reason in an environment.1
+   *
+   * @returns {string} A random generated ID.
+   */
+  static safeGenerateUuid() {
+    let e = "";
+    try {
+      e = crypto.randomUUID();
+    } catch {
+      console.error("crypto not available. Not generating a UUID");
+    }
+    return e;
+  }
+  /**
+   * Generates an XPath based on a DOM nodes location on the page.
+   *
+   * @param {HTMLElement} element The element that we need the XPath for.
+   * @returns {string} The generated XPath.
+   */
+  static generateXPath(e) {
+    let t = "", i = e;
+    for (; i; ) {
+      let o = 1, n = i.previousSibling;
+      for (; n; )
+        n.nodeName === i.nodeName && o++, n = n.previousSibling;
+      t = `/${i.nodeName.toLowerCase() + (o > 1 ? `[${o}]` : "")}${t}`, i = i.parentNode;
+    }
+    return t;
+  }
+}
+export {
+  s as ENVIRONMENT_TYPE,
+  g as Epigraph,
+  w as EpigraphBaseSolutionHtmlElement,
+  I as EpigraphBaseSolutionLitElement
+};

package/dist/EpigraphLibs/EpigraphAnalytics/epigraphAnalytics.js

@@ -0,0 +1,69 @@
+import { GA3AnalyticsPlugin as c } from "../../lib/EpigraphLibs/EpigraphAnalytics/plugins/ga3-analytics-plugin.js";
+import { GA4AnalyticsPlugin as f } from "../../lib/EpigraphLibs/EpigraphAnalytics/plugins/ga4-analytics-plugin.js";
+import { NexusAnalyticsPlugin as m } from "../../lib/EpigraphLibs/EpigraphAnalytics/plugins/nexus-analytics-plugin.js";
+import { OneTrustConsentPlugin as e } from "../../lib/EpigraphLibs/EpigraphAnalytics/consent-plugins/one-trust-consent-plugin.js";
+import { ConsentPluginNames as l } from "../../lib/EpigraphLibs/EpigraphAnalytics/consent-plugins/consent-plugin-names.js";
+/**
+ * @license
+ * Copyright (c) 2023 Epigraph LLC. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var s;
+const i = Symbol("analyticsPluginsMap");
+s = i;
+class a {
+  constructor(n, t) {
+    this[s] = /* @__PURE__ */ new Map(), this._consentPlugin = null, n && t && (this._consentPlugin = this.buildConsentPlugin(n, t));
+  }
+  /**
+   * Epigraph Analytics uses plugins to send events to multiple trackers at a time. You can create a customer tracker
+   * by implementing the IAnalyticsPlugin and then adding it via this function. This will also hold only a single
+   * instance of a plugin with a given Tracking Identifier.
+   *
+   * @param plugin
+   */
+  addEventPlugin(n) {
+    this[i].has(n.getUniquePluginIdentifier()) || (this[i].set(
+      n.getUniquePluginIdentifier(),
+      n
+    ), n.setupPlugin());
+  }
+  /**
+   * Send an Event to all plugins
+   *
+   * @param eventData
+   */
+  sendEvent(n) {
+    this[i].forEach((t) => {
+      t.sendEvent(n, this._consentPlugin);
+    });
+  }
+  /**
+   * Returns an IConsentPlugin if something is passed to it. Returns null if we can't find the plugin named.
+   * @param consentPluginName
+   * @param consentIdentifier
+   * @private
+   */
+  buildConsentPlugin(n, t) {
+    return n.toLowerCase() === l.OneTrust.toLowerCase() ? new e(t) : null;
+  }
+}
+export {
+  l as ConsentPluginNames,
+  a as EpigraphAnalytics,
+  c as GA3AnalyticsPlugin,
+  f as GA4AnalyticsPlugin,
+  m as NexusAnalyticsPlugin,
+  e as OneTrustConsentPlugin
+};

package/dist/EpigraphLibs/EpigraphAnalytics/generics/queue.d.ts

@@ -1,4 +1,5 @@
 import { default as SLL } from './single-linked-list.js';
+import { AnalyticsEvent } from '../analytics-event-interface.ts';
 declare const $queue: unique symbol;
 declare const $size: unique symbol;
 export default class Queue {
@@ -7,7 +8,7 @@ export default class Queue {
     constructor();
     get queue(): SLL;
     get size(): number;
-    enqueue(data: any): void;
-    dequeue(): any;
+    enqueue(data: AnalyticsEvent): void;
+    dequeue(): AnalyticsEvent;
 }
 export {};

package/dist/EpigraphLibs/EpigraphAnalytics/types/index.d.ts

@@ -0,0 +1,7 @@
+export {};
+
+declare global {
+  interface Window {
+    gtag?: any;
+  }
+}

package/dist/EpigraphLibs/EpigraphLogger/epigraphLogger.d.ts

@@ -1,8 +1,8 @@
-interface LoggerMode {
+export interface LoggerMode {
     name: string;
     allows: Array<string>;
 }
-interface LoggerModes {
+export interface LoggerModes {
     release: LoggerMode;
     staging: LoggerMode;
     dev: LoggerMode;
@@ -51,7 +51,7 @@ export interface ILoggerGroup {
  * Mode: A logger's mode defines what log types would be automatically executed and
  *       what would be ignored.
  */
-declare class EpigraphLogger {
+export declare class EpigraphLogger {
     context: string;
     private _allModes;
     private _currentMode;
@@ -153,4 +153,3 @@ declare class EpigraphLogger {
      */
     groupEnd(): void;
 }
-export { EpigraphLogger };

package/dist/EpigraphLibs/EpigraphLogger/epigraphLogger.js

@@ -0,0 +1,199 @@
+var t = /* @__PURE__ */ ((l) => (l.Release = "release", l.Staging = "staging", l.Dev = "dev", l))(t || {}), c = /* @__PURE__ */ ((l) => (l.Info = "info", l.Warn = "warn", l.Error = "error", l))(c || {});
+class a {
+  /**
+   * @param {string} [context="EPIGRAPH-LOGGER"] Used to categorise each message within
+   *                the console.
+   * @example,CORE, UI
+   */
+  constructor(o) {
+    this.context = "EPIGRAPH-LOGGER", this._allModes = {
+      release: { name: "release", allows: [
+        "error"
+        /* Error */
+      ] },
+      staging: {
+        name: "staging",
+        allows: [
+          "warn",
+          "error"
+          /* Error */
+        ]
+      },
+      dev: {
+        name: "dev",
+        allows: [
+          "info",
+          "warn",
+          "error"
+          /* Error */
+        ]
+      }
+    }, this._currentMode = "release", o && (this.context = o.toLocaleUpperCase());
+  }
+  get modes() {
+    return this._allModes;
+  }
+  /**
+   *
+   * @param {LoggerModeNames} newValue Sets the logger mode of the current instance.
+   */
+  setCurrentMode(o) {
+    if (!Object.keys(this._allModes).includes(o)) {
+      console.warn(`"${o}": is not a valid logger mode`);
+      return;
+    }
+    this._currentMode = o;
+  }
+  _isLogTypeAllowedInCurrentMode(o) {
+    return this._allModes[this._currentMode].allows.includes(o);
+  }
+  /**
+   * A log type that doesn't necessarily need to be looked at by the end user.
+   * This can be any generic log that would be ignored in most logger modes except verbose.
+   *
+   * @param {string} title A short title for this log.
+   * @param {any} details Any optional detail that would be shown if this log was expanded in the console.
+   * @param {string | undefined} contextOverride Allows the user to specify where this log
+   * was recorded from. For eg. Core and Ui can pass in different values for this
+   * paramater to make it easy to debug. If not provided, the default context would be used
+   * that was provided at the time of initialisation of this class.
+   */
+  info({ title: o, details: r = "", contextOverride: e = void 0 }) {
+    if (!this._isLogTypeAllowedInCurrentMode(
+      "info"
+      /* Info */
+    ))
+      return;
+    const n = e || this.context;
+    console.groupCollapsed(`[${n}]: ${o}`), console.log(r), console.groupCollapsed("Traceback..."), console.trace(), console.groupEnd(), console.groupEnd();
+  }
+  /**
+   * A warning log type that let's the user know that some action that could be dangerous was just
+   * performed and might need attention.
+   *
+   * @param {string} title A short title for this log.
+   * @param {any} details Any optional detail that would be shown if this log was expanded in the console.
+   * @param {string | undefined} contextOverride Allows the user to specify where this log
+   * was recorded from. For eg. Core and Ui can pass in different values for this
+   * paramater to make it easy to debug. If not provided, the default context would be used
+   * that was provided at the time of initialisation of this class.
+   */
+  warn({ title: o, details: r = "", contextOverride: e = void 0 }) {
+    if (!this._isLogTypeAllowedInCurrentMode(
+      "warn"
+      /* Warn */
+    ))
+      return;
+    const n = e || this.context;
+    console.groupCollapsed(`%c[${n}]: ${o}`, "color: orange;"), console.warn(r), console.groupCollapsed("Traceback..."), console.trace(), console.groupEnd(), console.groupEnd();
+  }
+  /**
+   * A critical error log type that let's the user know that some action that was unexpected and required immediate attention.
+   *
+   * @param {string} title A short title for this log.
+   * @param {any} details Any optional detail that would be shown if this log was expanded in the console.
+   * @param {string | undefined} contextOverride Allows the user to specify where this log
+   * was recorded from. For eg. Core and Ui can pass in different values for this
+   * paramater to make it easy to debug. If not provided, the default context would be used
+   * that was provided at the time of initialisation of this class.
+   */
+  error({ title: o, details: r = "", contextOverride: e = void 0 }) {
+    if (!this._isLogTypeAllowedInCurrentMode(
+      "error"
+      /* Error */
+    ))
+      return;
+    const n = e || this.context;
+    console.groupCollapsed(`%c[${n}]: ${o}`, "color: red;"), console.error(r), console.groupCollapsed("Traceback..."), console.trace(), console.groupEnd(), console.groupEnd();
+  }
+  /**
+   * A table log type that can show an object in an organised manner within the console.
+   * This is primarily for the visual purposes and doesn't provide any additional functionality
+   * that other log types cannot provide.
+   *
+   * @param {string} title A short title for this log.
+   * @param {any} details Any optional detail that would be shown if this log was expanded in the console.
+   * @param {string | undefined} contextOverride Allows the user to specify where this log
+   * was recorded from. For eg. Core and Ui can pass in different values for this
+   * paramater to make it easy to debug. If not provided, the default context would be used
+   * that was provided at the time of initialisation of this class.
+   * @param {LogTypes} logType A
+   */
+  table({
+    title: o,
+    details: r = {},
+    contextOverride: e = void 0,
+    logType: n = "info"
+    /* Info */
+  }) {
+    if (!this._isLogTypeAllowedInCurrentMode(n))
+      return;
+    const s = e || this.context;
+    console.groupCollapsed(`[${s}]: ${o}`), console.table(r), console.groupCollapsed("Traceback..."), console.trace(), console.groupEnd(), console.groupEnd();
+  }
+  /**
+   * Begins an expanded group with the browser's console window.
+   * NOTE: Please remember to close this group once done using EpigraphLogger.groupEnd();
+   *
+   * @param {string} title A short title for this group.
+   * @param {string | undefined} contextOverride Allows the user to specify where this log
+   * was recorded from. For eg. Core and Ui can pass in different values for this
+   * paramater to make it easy to debug. If not provided, the default context would be used
+   * that was provided at the time of initialisation of this class.
+   * @param {LogTypes} logType A group can implictly of any log type, by default it is of type
+   * info but this parameter allows the user to override this.
+   * @returns {void}
+   */
+  group({
+    title: o,
+    contextOverride: r = void 0,
+    logType: e = "info"
+    /* Info */
+  }) {
+    if (!this._isLogTypeAllowedInCurrentMode(e))
+      return;
+    const n = r || this.context;
+    console.group(`%c ${n} GROUP`, o);
+  }
+  /**
+   * Begins a collapsed group with the browser's console window.
+   * NOTE: Please remember to close this group once done using EpigraphLogger.groupEnd();
+   *
+   * @param {string} title A short title for this group.
+   * @param {string | undefined} contextOverride Allows the user to specify where this log
+   * was recorded from. For eg. Core and Ui can pass in different values for this
+   * paramater to make it easy to debug. If not provided, the default context would be used
+   * that was provided at the time of initialisation of this class.
+   * @param {LogTypes} logType A group can implictly of any log type, by default it is of type
+   * info but this parameter allows the user to override this.
+   * @returns {void}
+   */
+  groupCollapsed({
+    title: o,
+    contextOverride: r = void 0,
+    logType: e = "info"
+    /* Info */
+  }) {
+    if (!this._isLogTypeAllowedInCurrentMode(e))
+      return;
+    const n = r || this.context;
+    console.groupCollapsed(`%c ${n} GROUP`, o);
+  }
+  /**
+   * Similar to the console.groupEnd(). Useful for ending either a group or
+   * groupCollapse that was initialised by this logger.
+   *
+   * @returns {void}
+   */
+  groupEnd() {
+    this._isLogTypeAllowedInCurrentMode(
+      "info"
+      /* Info */
+    ) && (console.log("----------------------------------"), console.groupEnd());
+  }
+}
+export {
+  a as EpigraphLogger,
+  c as LogTypes,
+  t as LoggerModeNames
+};

package/dist/EpigraphLibs/EpigraphNexusApi/epigraphNexusApi.js

@@ -0,0 +1,153 @@
+import { failureResult as p, successResult as u } from "../EpigraphResultFactory/epigraphResultFactory.js";
+class x {
+  /**
+   * Constructs a new instance of the class with the provided parameters.
+   *
+   * @param {NexusEndpoints} [baseUrl=NexusEndpoints.PRODUCTION] - The base URL endpoint for the API, defaulting to the production environment.
+   * @param {string} epgLocation - The window.location.href associated with the epigraph data.
+   * @param {string} epigraphSessionId - The session identifier for the epigraph session.
+   * @param {string} epigraphComponentVersion - The version of the Epigraph Component(1.x.x or 1.2.1, etc.).
+   * @param {string} [epigraphXPath=""] - The XPath expression for epigraph data processing, defaults to an empty string.
+   * @param {NexusAPIVersions} [apiVersion=NexusAPIVersions.V1] - The API version to use, defaulting to version 1.
+   * @return {void}
+   */
+  constructor(e = "https://api.myepigraph.com/api/", i, r, s = "", n = "", a = "v1/") {
+    this.epigraphXPath = "", this.epigraphComponentVersion = s, this.epigraphSessionId = r, this.epigraphXPath = n, this.baseUrl = e + a, this.epgLocation = i;
+  }
+  /*******************************************************************************************************************
+   * Configurator API Calls                                                                                          *
+   ******************************************************************************************************************/
+  async getConfiguratorByExperienceId(e, i = "") {
+    const r = {};
+    i !== "" && (r.version_id = i);
+    const s = `experience/configurator/experience_id/${e}`, n = this.buildNexusUrl(
+      s,
+      r
+    );
+    return await this.callNexusAPI(
+      n,
+      "GET"
+      /* GET */
+    );
+  }
+  async getConfiguratorByClientAccessKey(e, i = "") {
+    const r = {};
+    i !== "" && (r.version_id = i);
+    const s = `experience/configurator/client_access_key/${e}`, n = this.buildNexusUrl(
+      s,
+      r
+    );
+    return await this.callNexusAPI(
+      n,
+      "GET"
+      /* GET */
+    );
+  }
+  /*******************************************************************************************************************
+   * ConfiguratorLite API Calls                                                                                      *
+   ******************************************************************************************************************/
+  async getConfiguratorLiteByExperienceId(e, i = "") {
+    const r = {};
+    i !== "" && (r.version_id = i);
+    const s = `experience/configurator-lite/experience_id/${e}`, n = this.buildNexusUrl(
+      s,
+      r
+    );
+    return await this.callNexusAPI(
+      n,
+      "GET"
+      /* GET */
+    );
+  }
+  async getConfiguratorLiteByProjectId(e, i = "") {
+    const r = {};
+    i !== "" && (r.version_id = i);
+    const s = `experience/configurator-lite/project_id/${e}`, n = this.buildNexusUrl(
+      s,
+      r
+    );
+    return await this.callNexusAPI(
+      n,
+      "GET"
+      /* GET */
+    );
+  }
+  /*******************************************************************************************************************
+   * Save & Share Calls                                                                                              *
+   ******************************************************************************************************************/
+  async postExperienceSaveAndShare(e, i) {
+    const r = "experience/" + e + "/save/", s = this.buildNexusUrl(
+      r
+    ), n = {
+      save_data: JSON.stringify(i)
+    }, a = new Headers();
+    return a.set("Content-Type", "application/json"), await this.callNexusAPI(s, "POST", JSON.stringify(n), a);
+  }
+  async getExperienceSaveAndShare(e, i) {
+    const r = "experience/" + e + "/save/" + i, s = this.buildNexusUrl(
+      r
+    );
+    return await this.callNexusAPI(
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  /**
+   * Makes a call to the Nexus API and ensures the response is returned in JSON format.
+   * Automatically appends the `application/json` accept header if not already provided.
+   *
+   * @param {URL} url - The URL of the Nexus API endpoint to call.
+   * @param method
+   * @param body
+   * @param headers
+   * @return {Promise<Result>} A promise that resolves with the API response, encapsulated in a success or failure result format.
+   */
+  async callNexusAPI(e, i = "GET", r, s = new Headers()) {
+    s = this.addRequiredHeaders(s);
+    const n = {
+      method: i,
+      body: r,
+      headers: s
+    };
+    try {
+      const a = await fetch(e, n), c = await a.json();
+      if (!a.ok) {
+        let o = "Unable to retrieve configurator experience";
+        return c.message && (o = c.message), Promise.resolve(
+          p(c, a.status, o)
+        );
+      }
+      return Promise.resolve(u(c, a.status));
+    } catch {
+      return Promise.resolve(p({}, 500, "Unknown error"));
+    }
+  }
+  buildNexusUrl(e, i = {}) {
+    let r = new URL(this.baseUrl);
+    r.pathname += e;
+    for (const [s, n] of Object.entries(i))
+      r.searchParams.set(s, n);
+    return r;
+  }
+  /**
+   * Adds required headers to the provided headers object if they are not already present.
+   * Ensures that the headers include "accept", "EPG-Location", "EPG-Session-ID",
+   * and "EPG-XPATH" with their respective values.
+   *
+   * @param {Headers} headers - The headers object to which the required headers will be added.
+   * @return {Headers} The updated headers object containing all required headers.
+   */
+  addRequiredHeaders(e) {
+    return e.has("accept") || e.set("accept", "application/json"), e.has("EPG-Location") || e.set("EPG-location", this.epgLocation), e.has("EPG-Session-ID") || e.set("EPG-Session-ID", this.epigraphSessionId), e.has("EPG-XPATH") || e.set("EPG-XPATH", this.epigraphXPath), e.has("EPG-Version") || e.set("EPG-Version", this.epigraphComponentVersion), e;
+  }
+}
+var l = /* @__PURE__ */ ((t) => (t.PRODUCTION = "https://api.myepigraph.com/api/", t.STAGING = "https://nexus.epigraph.dev/api/", t.LOCAL = "https://nexus.test/api/", t))(l || {}), h = /* @__PURE__ */ ((t) => (t.CLIENT_ACCESS_KEY = "client_access_key", t.EXPERIENCE_ID = "experience_id", t.PROJECT_ID = "project_id", t))(h || {}), E = /* @__PURE__ */ ((t) => (t.CONFIGURATOR = "experience/configurator/", t.CONFIGURATOR_LITE = "experience/configurator-lite/", t.EXPERIENCE = "experience/", t.SAVE = "save/", t))(E || {}), g = /* @__PURE__ */ ((t) => (t.V1 = "v1/", t))(g || {}), P = /* @__PURE__ */ ((t) => (t.GET = "GET", t.POST = "POST", t.PUT = "PUT", t.DELETE = "DELETE", t))(P || {});
+export {
+  x as EpigraphNexusAPI,
+  P as HTTPMethod,
+  h as NexusAPIResourceIdentifier,
+  E as NexusAPIRoutes,
+  g as NexusAPIVersions,
+  l as NexusEndpoints
+};