@epigraph/epigraph-std-lib 3.3.1 → 4.0.0-alpha

package/dist/EpigraphLibs/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: n = "", contextOverride: e = void 0 }) {
+    if (!this._isLogTypeAllowedInCurrentMode(
+      "info"
+      /* Info */
+    ))
+      return;
+    const r = e || this.context;
+    console.groupCollapsed(`[${r}]: ${o}`), console.log(n), 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: n = "", contextOverride: e = void 0 }) {
+    if (!this._isLogTypeAllowedInCurrentMode(
+      "warn"
+      /* Warn */
+    ))
+      return;
+    const r = e || this.context;
+    console.groupCollapsed(`%c[${r}]: ${o}`, "color: orange;"), console.warn(n), 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: n = "", contextOverride: e = void 0 }) {
+    if (!this._isLogTypeAllowedInCurrentMode(
+      "error"
+      /* Error */
+    ))
+      return;
+    const r = e || this.context;
+    console.groupCollapsed(`%c[${r}]: ${o}`, "color: red;"), console.error(n), 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: n = {},
+    contextOverride: e = void 0,
+    logType: r = "info"
+    /* Info */
+  }) {
+    if (!this._isLogTypeAllowedInCurrentMode(r))
+      return;
+    const s = e || this.context;
+    console.groupCollapsed(`[${s}]: ${o}`), console.table(n), 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: n = void 0,
+    logType: e = "info"
+    /* Info */
+  }) {
+    if (!this._isLogTypeAllowedInCurrentMode(e))
+      return;
+    const r = n || this.context;
+    console.group(`%c ${r} 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: n = void 0,
+    logType: e = "info"
+    /* Info */
+  }) {
+    if (!this._isLogTypeAllowedInCurrentMode(e))
+      return;
+    const r = n || this.context;
+    console.groupCollapsed(`%c ${r} 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.js

@@ -0,0 +1,153 @@
+import { failureResult as p, successResult as u } from "./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
+};