@epigraph/epigraph-std-lib 4.1.0 → 4.2.0

package/dist/Epigraph/epigraph.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("../EpigraphLibs/EpigraphLogger/epigraphLogger.cjs"),p=require("../EpigraphLibs/EpigraphUrlProcessor/epigraphUrlProcessor.cjs");var r=(n=>(n.DEVELOPMENT="development",n.STAGING="staging",n.PRODUCTION="production",n))(r||{});class g{constructor(e){if(this._loggerContext="EPIGRAPH",this._isReady=!1,this._logger=new s.EpigraphLogger("EPIGRAPH LOGGER"),this._environment=r.DEVELOPMENT,this._activeComponentsInSession=new Map,this._staleComponentsInSession=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.EpigraphUrlProcessor,this.id=g.safeGenerateUuid();const i=this._urlProcessor.getParameterInUrl(p.QUERY_PARAMETER_NAMES.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}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()}registerActiveComponent(e){this._activeComponentsInSession.set(e.uuid,e),this._logger.info({title:"Registered a new Active Component",details:e,contextOverride:this._loggerContext})}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}))}getLoggerModeNameFromEnvironment(){let e=s.LoggerModeNames.Dev;return this._environment===r.STAGING?e=s.LoggerModeNames.Staging:this._environment===r.PRODUCTION&&(e=s.LoggerModeNames.Release),e}static safeGenerateUuid(){let e="";try{e=crypto.randomUUID()}catch{console.error("crypto not available. Not generating a UUID")}return e}static generateXPath(e){let t="",i=e;for(;i;){let a=1,o=i.previousSibling;for(;o;)o.nodeName===i.nodeName&&a++,o=o.previousSibling;t=`/${i.nodeName.toLowerCase()+(a>1?`[${a}]`:"")}${t}`,i=i.parentNode}return t}}exports.ENVIRONMENT_TYPE=r;exports.Epigraph=g;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const s=require("../EpigraphLibs/EpigraphLogger/epigraphLogger.cjs"),p=require("../EpigraphLibs/EpigraphUrlProcessor/epigraphUrlProcessor.cjs");var n=(r=>(r.DEVELOPMENT="development",r.STAGING="staging",r.PRODUCTION="production",r))(n||{});class a{constructor(e){if(this._loggerContext="EPIGRAPH",this._isReady=!1,this._logger=new s.EpigraphLogger("EPIGRAPH LOGGER"),this._environment=n.DEVELOPMENT,this._activeComponentsInSession=new Map,this._staleComponentsInSession=new Map,this._isSessionWebGL2Compatible=!1,window.epigraph)return window.epigraph.registerActiveComponent(e),window.epigraph;this._isSessionWebGL2Compatible=this._checkIfWebGL2IsAvailable(),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.EpigraphUrlProcessor,this.id=a.safeGenerateUuid();const i=this._urlProcessor.getParameterInUrl(p.QUERY_PARAMETER_NAMES.epigraphSessionId);this._epigraphSessionId=i??a.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}isSessionWebGL2Compatible(){return this._isSessionWebGL2Compatible}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()}_checkIfWebGL2IsAvailable(){try{const e=document.createElement("canvas");return!!(window.WebGL2RenderingContext&&e.getContext("webgl2"))}catch{return!1}}registerActiveComponent(e){this._activeComponentsInSession.set(e.uuid,e),this._logger.info({title:"Registered a new Active Component",details:e,contextOverride:this._loggerContext})}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}))}getLoggerModeNameFromEnvironment(){let e=s.LoggerModeNames.Dev;return this._environment===n.STAGING?e=s.LoggerModeNames.Staging:this._environment===n.PRODUCTION&&(e=s.LoggerModeNames.Release),e}static safeGenerateUuid(){let e="";try{e=crypto.randomUUID()}catch{console.error("crypto not available. Not generating a UUID")}return e}static generateXPath(e){let t="",i=e;for(;i;){let g=1,o=i.previousSibling;for(;o;)o.nodeName===i.nodeName&&g++,o=o.previousSibling;t=`/${i.nodeName.toLowerCase()+(g>1?`[${g}]`:"")}${t}`,i=i.parentNode}return t}}exports.ENVIRONMENT_TYPE=n;exports.Epigraph=a;

package/dist/Epigraph/epigraph.d.ts

@@ -21,6 +21,7 @@ export declare class Epigraph {
     private _environment;
     private _activeComponentsInSession;
     private _staleComponentsInSession;
+    private _isSessionWebGL2Compatible;
     constructor(initializer: EpigraphBaseSolutionTypes);
     get isReady(): boolean;
     get logger(): EpigraphLogger;
@@ -30,10 +31,17 @@ export declare class Epigraph {
     get initializer(): EpigraphBaseSolutionTypes;
     get activeComponentsInSession(): Map<string, EpigraphBaseSolutionTypes>;
     get staleComponentsInSession(): Map<string, EpigraphBaseSolutionTypes>;
+    isSessionWebGL2Compatible(): boolean;
     /**
      * Logs Epigraph Branding in the console to help redirect potential interests in the right direction.
      */
     logBranding(): void;
+    /**
+     * Used to check if the current session can support WebGL2 or not.
+     *
+     * @returns {boolean}
+     */
+    private _checkIfWebGL2IsAvailable;
     /**
      * Registers a new component that was initialized on this page.
      * This is optional from the perspective of the initialization flow but highly recommend

package/dist/Epigraph/epigraph.js

@@ -1,15 +1,15 @@
-import { EpigraphLogger as p, LoggerModeNames as g } from "../EpigraphLibs/EpigraphLogger/epigraphLogger.js";
-import { EpigraphUrlProcessor as h, QUERY_PARAMETER_NAMES as l } from "../EpigraphLibs/EpigraphUrlProcessor/epigraphUrlProcessor.js";
-var r = /* @__PURE__ */ ((i) => (i.DEVELOPMENT = "development", i.STAGING = "staging", i.PRODUCTION = "production", i))(r || {});
-class a {
+import { EpigraphLogger as l, LoggerModeNames as a } from "../EpigraphLibs/EpigraphLogger/epigraphLogger.js";
+import { EpigraphUrlProcessor as h, QUERY_PARAMETER_NAMES as p } from "../EpigraphLibs/EpigraphUrlProcessor/epigraphUrlProcessor.js";
+var s = /* @__PURE__ */ ((i) => (i.DEVELOPMENT = "development", i.STAGING = "staging", i.PRODUCTION = "production", i))(s || {});
+class g {
   constructor(e) {
-    if (this._loggerContext = "EPIGRAPH", this._isReady = !1, this._logger = new p("EPIGRAPH LOGGER"), this._environment = r.DEVELOPMENT, this._activeComponentsInSession = /* @__PURE__ */ new Map(), this._staleComponentsInSession = /* @__PURE__ */ new Map(), window.epigraph)
+    if (this._loggerContext = "EPIGRAPH", this._isReady = !1, this._logger = new l("EPIGRAPH LOGGER"), this._environment = s.DEVELOPMENT, this._activeComponentsInSession = /* @__PURE__ */ new Map(), this._staleComponentsInSession = /* @__PURE__ */ new Map(), this._isSessionWebGL2Compatible = !1, 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;
+    this._isSessionWebGL2Compatible = this._checkIfWebGL2IsAvailable(), 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 h(), this.id = a.safeGenerateUuid();
-    const n = this._urlProcessor.getParameterInUrl(l.epigraphSessionId);
-    this._epigraphSessionId = n ?? a.safeGenerateUuid(), this._logger.info({ title: "Epigraph Object Ready!!", details: this, contextOverride: this._loggerContext }), this._isReady = !0;
+    this._logger.setCurrentMode(t), this._urlProcessor = new h(), this.id = g.safeGenerateUuid();
+    const n = this._urlProcessor.getParameterInUrl(p.epigraphSessionId);
+    this._epigraphSessionId = n ?? g.safeGenerateUuid(), this._logger.info({ title: "Epigraph Object Ready!!", details: this, contextOverride: this._loggerContext }), this._isReady = !0;
   }
   get isReady() {
     return this._isReady;
@@ -35,12 +35,28 @@ class a {
   get staleComponentsInSession() {
     return this._staleComponentsInSession;
   }
+  isSessionWebGL2Compatible() {
+    return this._isSessionWebGL2Compatible;
+  }
   /**
    * 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();
   }
+  /**
+   * Used to check if the current session can support WebGL2 or not.
+   * 
+   * @returns {boolean}
+   */
+  _checkIfWebGL2IsAvailable() {
+    try {
+      const e = document.createElement("canvas");
+      return !!(window.WebGL2RenderingContext && e.getContext("webgl2"));
+    } catch {
+      return !1;
+    }
+  }
   /**
    * Registers a new component that was initialized on this page.
    * This is optional from the perspective of the initialization flow but highly recommend
@@ -70,8 +86,8 @@ class a {
    * @returns {LoggerModeNames} A valid logger mode name.
    */
   getLoggerModeNameFromEnvironment() {
-    let e = g.Dev;
-    return this._environment === r.STAGING ? e = g.Staging : this._environment === r.PRODUCTION && (e = g.Release), e;
+    let e = a.Dev;
+    return this._environment === s.STAGING ? e = a.Staging : this._environment === s.PRODUCTION && (e = a.Release), e;
   }
   /**
    * Generates a random UUID using crypto.randomUUID with a fallback on custom generator,
@@ -97,15 +113,15 @@ class a {
   static generateXPath(e) {
     let t = "", n = e;
     for (; n; ) {
-      let s = 1, o = n.previousSibling;
+      let r = 1, o = n.previousSibling;
       for (; o; )
-        o.nodeName === n.nodeName && s++, o = o.previousSibling;
-      t = `/${n.nodeName.toLowerCase() + (s > 1 ? `[${s}]` : "")}${t}`, n = n.parentNode;
+        o.nodeName === n.nodeName && r++, o = o.previousSibling;
+      t = `/${n.nodeName.toLowerCase() + (r > 1 ? `[${r}]` : "")}${t}`, n = n.parentNode;
     }
     return t;
   }
 }
 export {
-  r as ENVIRONMENT_TYPE,
-  a as Epigraph
+  s as ENVIRONMENT_TYPE,
+  g as Epigraph
 };

package/dist/Epigraph/epigraphBaseSolutions.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("lit"),e=require("./epigraph.cjs");class s extends HTMLElement{constructor(t,i){super(),this._isReady=!1,this._elementName="epigraph-base-solution-html",this._solutionVersion="",this._loggerContextOverride="[EPIGRAPH BASE SOLUTION]",this.attachShadow({mode:"open"}),this._environment=i,this._solutionVersion=t,this._xPath=e.Epigraph.generateXPath(this),this._uuid=e.Epigraph.safeGenerateUuid()??this._xPath,new e.Epigraph(this),window.epigraph.logger.info({title:"Epigraph Base Solution Ready",contextOverride:this._loggerContextOverride})}get isReady(){return this._isReady}get environment(){return this._environment}get elementName(){return this._elementName}get solutionVersion(){return this._solutionVersion}get uuid(){return this._uuid}get xPath(){return this._xPath}disconnectedCallback(){window.epigraph.deregisterActiveComponent(this)}}class o extends r.LitElement{constructor(t,i){super(),this._isReady=!1,this._elementName="epigraph-base-solution-lit",this._solutionVersion="",this._loggerContextOverride="[EPIGRAPH BASE SOLUTION]",this._environment=i,this._solutionVersion=t,this._xPath=e.Epigraph.generateXPath(this),this._uuid=e.Epigraph.safeGenerateUuid()??this._xPath,new e.Epigraph(this),this._isReady=!0,window.epigraph.logger.info({title:"Epigraph Base Solution Ready",contextOverride:this._loggerContextOverride})}get isReady(){return this._isReady}get environment(){return this._environment}get elementName(){return this._elementName}get solutionVersion(){return this._solutionVersion}get uuid(){return this._uuid}get xPath(){return this._xPath}disconnectedCallback(){window.epigraph.deregisterActiveComponent(this)}}exports.EpigraphBaseSolutionHtmlElement=s;exports.EpigraphBaseSolutionLitElement=o;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("../lit-element-CYaaFRfk.cjs"),e=require("./epigraph.cjs");class s extends HTMLElement{constructor(t,i){super(),this._isReady=!1,this._elementName="epigraph-base-solution-html",this._solutionVersion="",this._loggerContextOverride="[EPIGRAPH BASE SOLUTION]",this.attachShadow({mode:"open"}),this._environment=i,this._solutionVersion=t,this._xPath=e.Epigraph.generateXPath(this),this._uuid=e.Epigraph.safeGenerateUuid()??this._xPath,new e.Epigraph(this),window.epigraph.logger.info({title:"Epigraph Base Solution Ready",contextOverride:this._loggerContextOverride})}get isReady(){return this._isReady}get environment(){return this._environment}get elementName(){return this._elementName}get solutionVersion(){return this._solutionVersion}get uuid(){return this._uuid}get xPath(){return this._xPath}disconnectedCallback(){window.epigraph.deregisterActiveComponent(this)}}class o extends r.i{constructor(t,i){super(),this._isReady=!1,this._elementName="epigraph-base-solution-lit",this._solutionVersion="",this._loggerContextOverride="[EPIGRAPH BASE SOLUTION]",this._environment=i,this._solutionVersion=t,this._xPath=e.Epigraph.generateXPath(this),this._uuid=e.Epigraph.safeGenerateUuid()??this._xPath,new e.Epigraph(this),this._isReady=!0,window.epigraph.logger.info({title:"Epigraph Base Solution Ready",contextOverride:this._loggerContextOverride})}get isReady(){return this._isReady}get environment(){return this._environment}get elementName(){return this._elementName}get solutionVersion(){return this._solutionVersion}get uuid(){return this._uuid}get xPath(){return this._xPath}disconnectedCallback(){window.epigraph.deregisterActiveComponent(this)}}exports.EpigraphBaseSolutionHtmlElement=s;exports.EpigraphBaseSolutionLitElement=o;

package/dist/Epigraph/epigraphBaseSolutions.js

@@ -1,4 +1,4 @@
-import { LitElement as s } from "lit";
+import { i as s } from "../lit-element-C3moVMGu.js";
 import { Epigraph as e } from "./epigraph.js";
 class h extends HTMLElement {
   constructor(t, i) {

package/dist/EpigraphLibs/EpigraphNexusApi/epigraphNexusApi.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("../EpigraphResultFactory/epigraphResultFactory.cjs");class P{constructor(e="https://api.myepigraph.com/api/",i,r,s="",a="",n="v1/"){this.epigraphXPath="",this.epigraphComponentVersion=s,this.epigraphSessionId=r,this.epigraphXPath=a,this.baseUrl=e+n,this.epgLocation=i}async getConfiguratorByExperienceId(e,i=""){const r={};i!==""&&(r.version_id=i);const s=`experience/configurator/experience_id/${e}`,a=this.buildNexusUrl(s,r);return await this.callNexusAPI(a,"GET")}async getConfiguratorByClientAccessKey(e,i=""){const r={};i!==""&&(r.version_id=i);const s=`experience/configurator/client_access_key/${e}`,a=this.buildNexusUrl(s,r);return await this.callNexusAPI(a,"GET")}async getConfiguratorLiteByExperienceId(e,i=""){const r={};i!==""&&(r.version_id=i);const s=`experience/configurator-lite/experience_id/${e}`,a=this.buildNexusUrl(s,r);return await this.callNexusAPI(a,"GET")}async getConfiguratorLiteByProjectId(e,i=""){const r={};i!==""&&(r.version_id=i);const s=`experience/configurator-lite/project_id/${e}`,a=this.buildNexusUrl(s,r);return await this.callNexusAPI(a,"GET")}async postExperienceSaveAndShare(e,i){const r="experience/"+e+"/save/",s=this.buildNexusUrl(r),a={save_data:JSON.stringify(i)},n=new Headers;return n.set("Content-Type","application/json"),await this.callNexusAPI(s,"POST",JSON.stringify(a),n)}async getExperienceSaveAndShare(e,i){const r="experience/"+e+"/save/"+i,s=this.buildNexusUrl(r);return await this.callNexusAPI(s,"GET")}async callNexusAPI(e,i="GET",r,s=new Headers){s=this.addRequiredHeaders(s);const a={method:i,body:r,headers:s};try{const n=await fetch(e,a),o=await n.json();if(!n.ok){let u="Unable to retrieve configurator experience";return o.message&&(u=o.message),Promise.resolve(c.failureResult(o,n.status,u))}return Promise.resolve(c.successResult(o,n.status))}catch{return Promise.resolve(c.failureResult({},500,"Unknown error"))}}buildNexusUrl(e,i={}){let r=new URL(this.baseUrl);r.pathname+=e;for(const[s,a]of Object.entries(i))r.searchParams.set(s,a);return r}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 p=(t=>(t.PRODUCTION="https://api.myepigraph.com/api/",t.STAGING="https://nexus.epigraph.dev/api/",t.LOCAL="https://nexus.test/api/",t))(p||{}),l=(t=>(t.CLIENT_ACCESS_KEY="client_access_key",t.EXPERIENCE_ID="experience_id",t.PROJECT_ID="project_id",t))(l||{}),h=(t=>(t.CONFIGURATOR="experience/configurator/",t.CONFIGURATOR_LITE="experience/configurator-lite/",t.EXPERIENCE="experience/",t.SAVE="save/",t))(h||{}),E=(t=>(t.V1="v1/",t))(E||{}),g=(t=>(t.GET="GET",t.POST="POST",t.PUT="PUT",t.DELETE="DELETE",t))(g||{});exports.EpigraphNexusAPI=P;exports.HTTPMethod=g;exports.NexusAPIResourceIdentifier=l;exports.NexusAPIRoutes=h;exports.NexusAPIVersions=E;exports.NexusEndpoints=p;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const o=require("../EpigraphResultFactory/epigraphResultFactory.cjs");class E{constructor(i="https://api.myepigraph.com/api/",t,e,r="",s="",a="v1/"){this.epigraphXPath="",this.epigraphComponentVersion=r,this.epigraphSessionId=e,this.epigraphXPath=s,this.baseUrl=i+a,this.epgLocation=t}async getButtonBySku(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/button/sku/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getButtonByShopifyVariantId(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/button/shopify_variant_id/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getButtonByUpc(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/button/upc/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getButtonByAsin(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/button/asin/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getViewerBySku(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/viewer/sku/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getViewerByShopifyVariantId(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/viewer/shopify_variant_id/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getViewerByUpc(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/viewer/upc/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getViewerByAsin(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/viewer/asin/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getTourBySku(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/tour/sku/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getTourByShopifyVariantId(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/tour/shopify_variant_id/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getTourByUpc(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/tour/upc/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getTourByAsin(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/tour/asin/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getConfiguratorByExperienceId(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/configurator/experience_id/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getConfiguratorByClientAccessKey(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/configurator/client_access_key/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getConfiguratorLiteByExperienceId(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/configurator-lite/experience_id/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async getConfiguratorLiteByProjectId(i,t=""){const e={};t!==""&&(e.version_id=t);const r=`experience/configurator-lite/project_id/${i}`,s=this.buildNexusUrl(r,e);return await this.callNexusAPI(s,"GET")}async postExperienceSaveAndShare(i,t){const e=`experience/${i}/save`,r=this.buildNexusUrl(e),s={save_data:JSON.stringify(t)},a=new Headers;return a.set("Content-Type","application/json"),await this.callNexusAPI(r,"POST",JSON.stringify(s),a)}async getExperienceSaveAndShare(i,t){const e=`experience/${i}/save/${t}`,r=this.buildNexusUrl(e);return await this.callNexusAPI(r,"GET")}async callNexusAPI(i,t="GET",e,r=new Headers){r=this.addRequiredHeaders(r);const s={method:t,body:e,headers:r};try{const a=await fetch(i,s),c=await a.json();if(!a.ok){let u="Unable to retrieve configurator experience";return c.message&&(u=c.message),Promise.resolve(o.failureResult(c,a.status,u))}return Promise.resolve(o.successResult(c,a.status))}catch{return Promise.resolve(o.failureResult({},500,"Unknown error"))}}buildNexusUrl(i,t={}){let e=new URL(this.baseUrl);e.pathname+=i;for(const[r,s]of Object.entries(t))e.searchParams.set(r,s);return e}addRequiredHeaders(i){return i.has("accept")||i.set("accept","application/json"),i.has("EPG-Location")||i.set("EPG-location",this.epgLocation),i.has("EPG-Session-ID")||i.set("EPG-Session-ID",this.epigraphSessionId),i.has("EPG-XPATH")||i.set("EPG-XPATH",this.epigraphXPath),i.has("EPG-Version")||i.set("EPG-Version",this.epigraphComponentVersion),i}}var l=(n=>(n.PRODUCTION="https://api.myepigraph.com/api/",n.STAGING="https://nexus.epigraph.dev/api/",n.LOCAL="https://nexus.test/api/",n))(l||{}),p=(n=>(n.CLIENT_ACCESS_KEY="client_access_key",n.EXPERIENCE_ID="experience_id",n.PROJECT_ID="project_id",n.SKU="sku",n.SHOPIFY_VARIANT_ID="shopify_variant_id",n.UPC="upc",n.ASIN="asin",n))(p||{}),h=(n=>(n.BUTTON="experience/button",n.VIEWER="experience/viewer",n.TOUR="experience/tour",n.CUSTOMIZER="experience/customizer",n.CONFIGURATOR="experience/configurator",n.CONFIGURATOR_LITE="experience/configurator-lite",n.EXPERIENCE="experience",n.SAVE="save",n))(h||{}),y=(n=>(n.V1="v1/",n))(y||{}),x=(n=>(n.GET="GET",n.POST="POST",n.PUT="PUT",n.DELETE="DELETE",n))(x||{});exports.EpigraphNexusAPI=E;exports.HTTPMethod=x;exports.NexusAPIResourceIdentifier=p;exports.NexusAPIRoutes=h;exports.NexusAPIVersions=y;exports.NexusEndpoints=l;

package/dist/EpigraphLibs/EpigraphNexusApi/epigraphNexusApi.d.ts

@@ -17,6 +17,27 @@ export declare class EpigraphNexusAPI {
      * @return {void}
      */
     constructor(baseUrl: NexusEndpoints | undefined, epgLocation: string, epigraphSessionId: string, epigraphComponentVersion?: string, epigraphXPath?: string, apiVersion?: NexusAPIVersions);
+    /*******************************************************************************************************************
+     * Epigraph Button API Calls                                                                                          *
+     ******************************************************************************************************************/
+    getButtonBySku(sku: string, versionId?: string): Promise<Result>;
+    getButtonByShopifyVariantId(shopify_variant_id: string, versionId?: string): Promise<Result>;
+    getButtonByUpc(upc: string, versionId?: string): Promise<Result>;
+    getButtonByAsin(asin: string, versionId?: string): Promise<Result>;
+    /*******************************************************************************************************************
+     * Epigraph Viewer API Calls                                                                                       *
+     ******************************************************************************************************************/
+    getViewerBySku(sku: string, versionId?: string): Promise<Result>;
+    getViewerByShopifyVariantId(shopify_variant_id: string, versionId?: string): Promise<Result>;
+    getViewerByUpc(upc: string, versionId?: string): Promise<Result>;
+    getViewerByAsin(asin: string, versionId?: string): Promise<Result>;
+    /*******************************************************************************************************************
+     * Epigraph Tour API Calls                                                                                       *
+     ******************************************************************************************************************/
+    getTourBySku(sku: string, versionId?: string): Promise<Result>;
+    getTourByShopifyVariantId(shopify_variant_id: string, versionId?: string): Promise<Result>;
+    getTourByUpc(upc: string, versionId?: string): Promise<Result>;
+    getTourByAsin(asin: string, versionId?: string): Promise<Result>;
     /*******************************************************************************************************************
      * Configurator API Calls                                                                                          *
      ******************************************************************************************************************/
@@ -63,13 +84,21 @@ export declare enum NexusEndpoints {
 export declare enum NexusAPIResourceIdentifier {
     CLIENT_ACCESS_KEY = "client_access_key",
     EXPERIENCE_ID = "experience_id",
-    PROJECT_ID = "project_id"
+    PROJECT_ID = "project_id",
+    SKU = "sku",
+    SHOPIFY_VARIANT_ID = "shopify_variant_id",
+    UPC = "upc",
+    ASIN = "asin"
 }
 export declare enum NexusAPIRoutes {
-    CONFIGURATOR = "experience/configurator/",
-    CONFIGURATOR_LITE = "experience/configurator-lite/",
-    EXPERIENCE = "experience/",
-    SAVE = "save/"
+    BUTTON = "experience/button",
+    VIEWER = "experience/viewer",
+    TOUR = "experience/tour",
+    CUSTOMIZER = "experience/customizer",
+    CONFIGURATOR = "experience/configurator",
+    CONFIGURATOR_LITE = "experience/configurator-lite",
+    EXPERIENCE = "experience",
+    SAVE = "save"
 }
 export declare enum NexusAPIVersions {
     V1 = "v1/"

package/dist/EpigraphLibs/EpigraphNexusApi/epigraphNexusApi.js

@@ -1,5 +1,5 @@
-import { failureResult as p, successResult as u } from "../EpigraphResultFactory/epigraphResultFactory.js";
-class x {
+import { failureResult as u, successResult as l } from "../EpigraphResultFactory/epigraphResultFactory.js";
+class P {
   /**
    * Constructs a new instance of the class with the provided parameters.
    *
@@ -11,63 +11,228 @@ class x {
    * @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;
+  constructor(i = "https://api.myepigraph.com/api/", t, e, r = "", s = "", a = "v1/") {
+    this.epigraphXPath = "", this.epigraphComponentVersion = r, this.epigraphSessionId = e, this.epigraphXPath = s, this.baseUrl = i + a, this.epgLocation = t;
   }
   /*******************************************************************************************************************
-   * Configurator API Calls                                                                                          *
+   * Epigraph Button API Calls                                                                                          *
    ******************************************************************************************************************/
-  async getConfiguratorByExperienceId(e, i = "") {
-    const r = {};
-    i !== "" && (r.version_id = i);
-    const s = `experience/configurator/experience_id/${e}`, n = this.buildNexusUrl(
+  async getButtonBySku(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/button/sku/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
       s,
-      r
+      "GET"
+      /* GET */
+    );
+  }
+  async getButtonByShopifyVariantId(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/button/shopify_variant_id/${i}`, s = this.buildNexusUrl(
+      r,
+      e
     );
     return await this.callNexusAPI(
-      n,
+      s,
       "GET"
       /* GET */
     );
   }
-  async getConfiguratorByClientAccessKey(e, i = "") {
-    const r = {};
-    i !== "" && (r.version_id = i);
-    const s = `experience/configurator/client_access_key/${e}`, n = this.buildNexusUrl(
+  async getButtonByUpc(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/button/upc/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
       s,
-      r
+      "GET"
+      /* GET */
+    );
+  }
+  async getButtonByAsin(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/button/asin/${i}`, s = this.buildNexusUrl(
+      r,
+      e
     );
     return await this.callNexusAPI(
-      n,
+      s,
       "GET"
       /* GET */
     );
   }
   /*******************************************************************************************************************
-   * ConfiguratorLite API Calls                                                                                      *
+   * Epigraph Viewer API Calls                                                                                       *
    ******************************************************************************************************************/
-  async getConfiguratorLiteByExperienceId(e, i = "") {
-    const r = {};
-    i !== "" && (r.version_id = i);
-    const s = `experience/configurator-lite/experience_id/${e}`, n = this.buildNexusUrl(
+  async getViewerBySku(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/viewer/sku/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
       s,
-      r
+      "GET"
+      /* GET */
+    );
+  }
+  async getViewerByShopifyVariantId(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/viewer/shopify_variant_id/${i}`, s = this.buildNexusUrl(
+      r,
+      e
     );
     return await this.callNexusAPI(
-      n,
+      s,
       "GET"
       /* GET */
     );
   }
-  async getConfiguratorLiteByProjectId(e, i = "") {
-    const r = {};
-    i !== "" && (r.version_id = i);
-    const s = `experience/configurator-lite/project_id/${e}`, n = this.buildNexusUrl(
+  async getViewerByUpc(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/viewer/upc/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
       s,
-      r
+      "GET"
+      /* GET */
+    );
+  }
+  async getViewerByAsin(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/viewer/asin/${i}`, s = this.buildNexusUrl(
+      r,
+      e
     );
     return await this.callNexusAPI(
-      n,
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  /*******************************************************************************************************************
+   * Epigraph Tour API Calls                                                                                       *
+   ******************************************************************************************************************/
+  async getTourBySku(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/tour/sku/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  async getTourByShopifyVariantId(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/tour/shopify_variant_id/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  async getTourByUpc(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/tour/upc/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  async getTourByAsin(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/tour/asin/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  /*******************************************************************************************************************
+   * Configurator API Calls                                                                                          *
+   ******************************************************************************************************************/
+  async getConfiguratorByExperienceId(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/configurator/experience_id/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  async getConfiguratorByClientAccessKey(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/configurator/client_access_key/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  /*******************************************************************************************************************
+   * ConfiguratorLite API Calls                                                                                      *
+   ******************************************************************************************************************/
+  async getConfiguratorLiteByExperienceId(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/configurator-lite/experience_id/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
+      s,
+      "GET"
+      /* GET */
+    );
+  }
+  async getConfiguratorLiteByProjectId(i, t = "") {
+    const e = {};
+    t !== "" && (e.version_id = t);
+    const r = `experience/configurator-lite/project_id/${i}`, s = this.buildNexusUrl(
+      r,
+      e
+    );
+    return await this.callNexusAPI(
+      s,
       "GET"
       /* GET */
     );
@@ -75,20 +240,20 @@ class x {
   /*******************************************************************************************************************
    * Save & Share Calls                                                                                              *
    ******************************************************************************************************************/
-  async postExperienceSaveAndShare(e, i) {
-    const r = "experience/" + e + "/save/", s = this.buildNexusUrl(
-      r
-    ), n = {
-      save_data: JSON.stringify(i)
+  async postExperienceSaveAndShare(i, t) {
+    const e = `experience/${i}/save`, r = this.buildNexusUrl(
+      e
+    ), s = {
+      save_data: JSON.stringify(t)
     }, a = new Headers();
-    return a.set("Content-Type", "application/json"), await this.callNexusAPI(s, "POST", JSON.stringify(n), a);
+    return a.set("Content-Type", "application/json"), await this.callNexusAPI(r, "POST", JSON.stringify(s), a);
   }
-  async getExperienceSaveAndShare(e, i) {
-    const r = "experience/" + e + "/save/" + i, s = this.buildNexusUrl(
-      r
+  async getExperienceSaveAndShare(i, t) {
+    const e = `experience/${i}/save/${t}`, r = this.buildNexusUrl(
+      e
     );
     return await this.callNexusAPI(
-      s,
+      r,
       "GET"
       /* GET */
     );
@@ -103,32 +268,32 @@ class x {
    * @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
+  async callNexusAPI(i, t = "GET", e, r = new Headers()) {
+    r = this.addRequiredHeaders(r);
+    const s = {
+      method: t,
+      body: e,
+      headers: r
     };
     try {
-      const a = await fetch(e, n), c = await a.json();
+      const a = await fetch(i, s), 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)
+          u(c, a.status, o)
         );
       }
-      return Promise.resolve(u(c, a.status));
+      return Promise.resolve(l(c, a.status));
     } catch {
-      return Promise.resolve(p({}, 500, "Unknown error"));
+      return Promise.resolve(u({}, 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;
+  buildNexusUrl(i, t = {}) {
+    let e = new URL(this.baseUrl);
+    e.pathname += i;
+    for (const [r, s] of Object.entries(t))
+      e.searchParams.set(r, s);
+    return e;
   }
   /**
    * Adds required headers to the provided headers object if they are not already present.
@@ -138,16 +303,16 @@ class x {
    * @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;
+  addRequiredHeaders(i) {
+    return i.has("accept") || i.set("accept", "application/json"), i.has("EPG-Location") || i.set("EPG-location", this.epgLocation), i.has("EPG-Session-ID") || i.set("EPG-Session-ID", this.epigraphSessionId), i.has("EPG-XPATH") || i.set("EPG-XPATH", this.epigraphXPath), i.has("EPG-Version") || i.set("EPG-Version", this.epigraphComponentVersion), i;
   }
 }
-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 || {});
+var p = /* @__PURE__ */ ((n) => (n.PRODUCTION = "https://api.myepigraph.com/api/", n.STAGING = "https://nexus.epigraph.dev/api/", n.LOCAL = "https://nexus.test/api/", n))(p || {}), h = /* @__PURE__ */ ((n) => (n.CLIENT_ACCESS_KEY = "client_access_key", n.EXPERIENCE_ID = "experience_id", n.PROJECT_ID = "project_id", n.SKU = "sku", n.SHOPIFY_VARIANT_ID = "shopify_variant_id", n.UPC = "upc", n.ASIN = "asin", n))(h || {}), y = /* @__PURE__ */ ((n) => (n.BUTTON = "experience/button", n.VIEWER = "experience/viewer", n.TOUR = "experience/tour", n.CUSTOMIZER = "experience/customizer", n.CONFIGURATOR = "experience/configurator", n.CONFIGURATOR_LITE = "experience/configurator-lite", n.EXPERIENCE = "experience", n.SAVE = "save", n))(y || {}), x = /* @__PURE__ */ ((n) => (n.V1 = "v1/", n))(x || {}), $ = /* @__PURE__ */ ((n) => (n.GET = "GET", n.POST = "POST", n.PUT = "PUT", n.DELETE = "DELETE", n))($ || {});
 export {
-  x as EpigraphNexusAPI,
-  P as HTTPMethod,
+  P as EpigraphNexusAPI,
+  $ as HTTPMethod,
   h as NexusAPIResourceIdentifier,
-  E as NexusAPIRoutes,
-  g as NexusAPIVersions,
-  l as NexusEndpoints
+  y as NexusAPIRoutes,
+  x as NexusAPIVersions,
+  p as NexusEndpoints
 };