@plattar/plattar-ar-adapter 1.130.2 → 1.132.1

package/build/es2019/plattar-ar-adapter.js

@@ -172,7 +172,7 @@ const launcher_ar_1 = require("./launcher-ar");
  * Performs AR functionality related to Plattar Products and Variation types
  */
 class ProductAR extends launcher_ar_1.LauncherAR {
-    constructor(productID = null, variationID = null) {
+    constructor(productID = null, variationID = null, variationSKU = null) {
         super();
         // analytics instance
         this._analytics = null;
@@ -180,7 +180,8 @@ class ProductAR extends launcher_ar_1.LauncherAR {
             throw new Error("ProductAR.constructor(productID, variationID) - productID must be defined");
         }
         this._productID = productID;
-        this._variationID = variationID ? variationID : "default";
+        this._variationSKU = variationSKU;
+        this._variationID = variationID ? variationID : (variationSKU ? null : "default");
         this._ar = null;
     }
     get productID() {
@@ -189,6 +190,9 @@ class ProductAR extends launcher_ar_1.LauncherAR {
     get variationID() {
         return this._variationID;
     }
+    get variationSKU() {
+        return this._variationSKU;
+    }
     _SetupAnalytics(product, variation) {
         let analytics = null;
         const scene = product.relationships.find(plattar_api_1.Scene);
@@ -237,14 +241,27 @@ class ProductAR extends launcher_ar_1.LauncherAR {
             product.include(plattar_api_1.Scene.include(plattar_api_1.Project));
             product.get().then((product) => {
                 // find the required variation from our product
-                const variationID = this.variationID ? (this.variationID === "default" ? product.attributes.product_variation_id : this.variationID) : product.attributes.product_variation_id;
-                if (!variationID) {
-                    return reject(new Error("ProductAR.init() - cannot proceed as variation was not defined correctly"));
+                const variationID = this.variationID ? (this.variationID === "default" ? product.attributes.product_variation_id : this.variationID) : null;
+                const variationSKU = this.variationSKU;
+                if (!variationID && !variationSKU) {
+                    return reject(new Error("ProductAR.init() - cannot proceed as variation-id or variation-sku was not set correctly"));
+                }
+                let variation = undefined;
+                if (variationID) {
+                    variation = product.relationships.find(plattar_api_1.ProductVariation, variationID);
+                }
+                // if no variation was found with variationID - try searching variation sku
+                if (!variation && variationSKU) {
+                    const variations = product.relationships.filter(plattar_api_1.ProductVariation);
+                    if (variations) {
+                        variation = variations.find((element) => {
+                            return element.attributes.sku === variationSKU;
+                        });
+                    }
                 }
-                const variation = product.relationships.find(plattar_api_1.ProductVariation, variationID);
                 // make sure our variation is actually available before moving forward
                 if (!variation) {
-                    return reject(new Error("ProductAR.init() - cannot proceed as variation with id " + variationID + " cannot be found"));
+                    return reject(new Error("ProductAR.init() - cannot proceed as variation with id " + variationID + " or sku " + variationSKU + " cannot be found"));
                 }
                 // otherwise both the product and variation are available
                 // we need to figure out if we can actually do AR though
@@ -611,8 +628,8 @@ const util_1 = require("../util/util");
  * SceneProducts are much more convenient to grab from the Plattar CMS
  */
 class SceneProductAR extends product_ar_1.ProductAR {
-    constructor(sceneProductID = null, variationID = null) {
-        super(sceneProductID, variationID);
+    constructor(sceneProductID = null, variationID = null, variationSKU = null) {
+        super(sceneProductID, variationID, variationSKU);
         // this is evaluated in the init() function
         this._attachedProductID = null;
         if (!sceneProductID) {
@@ -682,7 +699,7 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
             this.removeRenderer();
             const sceneID = this.getAttribute("scene-id");
             if (sceneID) {
-                const opt = options || plattar_controller_1.PlattarController.DEFAULT_QR_OPTIONS;
+                const opt = options || this._GetDefaultQROptions();
                 const viewer = document.createElement("plattar-qrcode");
                 // required attributes with defaults for plattar-viewer node
                 const width = this.getAttribute("width") || "500px";
@@ -698,10 +715,15 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
                 if (opt.qrType) {
                     viewer.setAttribute("qr-type", opt.qrType);
                 }
+                viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
                 let dst = plattar_api_1.Server.location().base + "renderer/configurator.html?scene_id=" + sceneID;
                 // optional attributes
                 const configState = this.getAttribute("config-state");
                 const showAR = this.getAttribute("show-ar");
+                const showUI = this.getAttribute("show-ui");
+                if (showUI && showUI === "true") {
+                    dst = plattar_api_1.Server.location().base + "configurator/dist/index.html?scene_id=" + sceneID;
+                }
                 if (configState) {
                     dst += "&config_state=" + configState;
                 }
@@ -739,12 +761,16 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
                 // optional attributes
                 const configState = this.getAttribute("config-state");
                 const showAR = this.getAttribute("show-ar");
+                const showUI = this.getAttribute("show-ui");
                 if (configState) {
                     viewer.setAttribute("config-state", configState);
                 }
                 if (showAR) {
                     viewer.setAttribute("show-ar", showAR);
                 }
+                if (showUI) {
+                    viewer.setAttribute("show-ui", showUI);
+                }
                 viewer.onload = () => {
                     return accept(viewer);
                 };
@@ -897,10 +923,11 @@ class PlattarController {
     /**
      * Default QR Code rendering options
      */
-    static get DEFAULT_QR_OPTIONS() {
+    _GetDefaultQROptions() {
         return {
-            color: "#101721",
-            qrType: "default",
+            color: this.getAttribute("qr-color") || "#101721",
+            qrType: this.getAttribute("qr-style") || "default",
+            shorten: this.getAttribute("qr-shorten") || false,
             margin: 0
         };
     }
@@ -940,7 +967,7 @@ class PlattarController {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();
-            const opt = options || PlattarController.DEFAULT_QR_OPTIONS;
+            const opt = options || this._GetDefaultQROptions();
             const viewer = document.createElement("plattar-qrcode");
             // required attributes with defaults for plattar-viewer node
             const width = this.getAttribute("width") || "500px";
@@ -956,6 +983,7 @@ class PlattarController {
             if (opt.qrType) {
                 viewer.setAttribute("qr-type", opt.qrType);
             }
+            viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
             const qrOptions = btoa(JSON.stringify(opt));
             let dst = plattar_api_1.Server.location().base + "renderer/launcher.html?qr_options=" + qrOptions;
             const sceneID = this.getAttribute("scene-id");
@@ -964,6 +992,7 @@ class PlattarController {
             const productID = this.getAttribute("product-id");
             const sceneProductID = this.getAttribute("scene-product-id");
             const variationID = this.getAttribute("variation-id");
+            const variationSKU = this.getAttribute("variation-sku");
             const arMode = this.getAttribute("ar-mode");
             if (configState) {
                 dst += "&config_state=" + configState;
@@ -980,6 +1009,9 @@ class PlattarController {
             if (variationID) {
                 dst += "&variation_id=" + variationID;
             }
+            if (variationSKU) {
+                dst += "&variation_sku=" + variationSKU;
+            }
             if (arMode) {
                 dst += "&ar_mode=" + arMode;
             }
@@ -1061,7 +1093,7 @@ class ProductController extends plattar_controller_1.PlattarController {
             this.removeRenderer();
             const productID = this.getAttribute("product-id");
             if (productID) {
-                const opt = options || plattar_controller_1.PlattarController.DEFAULT_QR_OPTIONS;
+                const opt = options || this._GetDefaultQROptions();
                 const viewer = document.createElement("plattar-qrcode");
                 // required attributes with defaults for plattar-viewer node
                 const width = this.getAttribute("width") || "500px";
@@ -1077,12 +1109,17 @@ class ProductController extends plattar_controller_1.PlattarController {
                 if (opt.qrType) {
                     viewer.setAttribute("qr-type", opt.qrType);
                 }
+                viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
                 // optional attributes
                 const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
                 const showAR = this.getAttribute("show-ar");
                 let dst = plattar_api_1.Server.location().base + "renderer/product.html?product_id=" + productID;
                 if (variationID) {
-                    dst += "&variation_id=" + variationID;
+                    dst += "&variationId=" + variationID;
+                }
+                if (variationSKU) {
+                    dst += "&variationSku=" + variationSKU;
                 }
                 if (showAR) {
                     dst += "&show_ar=" + showAR;
@@ -1117,10 +1154,14 @@ class ProductController extends plattar_controller_1.PlattarController {
                 viewer.setAttribute("product-id", productID);
                 // optional attributes
                 const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
                 const showAR = this.getAttribute("show-ar");
                 if (variationID) {
                     viewer.setAttribute("variation-id", variationID);
                 }
+                if (variationSKU) {
+                    viewer.setAttribute("variation-sku", variationSKU);
+                }
                 if (showAR) {
                     viewer.setAttribute("show-ar", showAR);
                 }
@@ -1143,7 +1184,8 @@ class ProductController extends plattar_controller_1.PlattarController {
             const productID = this.getAttribute("product-id");
             if (productID) {
                 const variationID = this.getAttribute("variation-id");
-                const product = new product_ar_1.ProductAR(productID, variationID);
+                const variationSKU = this.getAttribute("variation-sku");
+                const product = new product_ar_1.ProductAR(productID, variationID, variationSKU);
                 return product.init().then(accept).catch(reject);
             }
             return reject(new Error("ProductController.initAR() - minimum required attributes not set, use product-id as a minimum"));
@@ -1171,6 +1213,7 @@ const plattar_api_1 = require("@plattar/plattar-api");
 const product_ar_1 = require("../../ar/product-ar");
 const scene_ar_1 = require("../../ar/scene-ar");
 const scene_product_ar_1 = require("../../ar/scene-product-ar");
+const configurator_state_1 = require("../../util/configurator-state");
 const util_1 = require("../../util/util");
 const plattar_controller_1 = require("./plattar-controller");
 /**
@@ -1206,7 +1249,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
             this.removeRenderer();
             const sceneID = this.getAttribute("scene-id");
             if (sceneID) {
-                const opt = options || plattar_controller_1.PlattarController.DEFAULT_QR_OPTIONS;
+                const opt = options || this._GetDefaultQROptions();
                 const viewer = document.createElement("plattar-qrcode");
                 // required attributes with defaults for plattar-viewer node
                 const width = this.getAttribute("width") || "500px";
@@ -1222,10 +1265,12 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 if (opt.qrType) {
                     viewer.setAttribute("qr-type", opt.qrType);
                 }
+                viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
                 let dst = plattar_api_1.Server.location().base + "renderer/viewer.html?scene_id=" + sceneID;
                 // optional attributes
                 const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
                 const showAR = this.getAttribute("show-ar");
                 if (productID) {
                     dst += "&productId=" + productID;
@@ -1233,6 +1278,9 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 if (variationID) {
                     dst += "&variationId=" + variationID;
                 }
+                if (variationSKU) {
+                    dst += "&variationSku=" + variationSKU;
+                }
                 if (showAR) {
                     dst += "&show_ar=" + showAR;
                 }
@@ -1267,6 +1315,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 // optional attributes
                 const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
                 const showAR = this.getAttribute("show-ar");
                 if (productID) {
                     viewer.setAttribute("product-id", productID);
@@ -1274,6 +1323,9 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 if (variationID) {
                     viewer.setAttribute("variation-id", variationID);
                 }
+                if (variationSKU) {
+                    viewer.setAttribute("variation-sku", variationSKU);
+                }
                 if (showAR) {
                     viewer.setAttribute("show-ar", showAR);
                 }
@@ -1297,22 +1349,39 @@ class ViewerController extends plattar_controller_1.PlattarController {
             // use product-id if available
             if (productID) {
                 const variationID = this.getAttribute("variation-id");
-                const product = new product_ar_1.ProductAR(productID, variationID);
+                const variationSKU = this.getAttribute("variation-sku");
+                const product = new product_ar_1.ProductAR(productID, variationID, variationSKU);
                 return product.init().then(accept).catch(reject);
             }
             const sceneProductID = this.getAttribute("scene-product-id");
             // use scene-product-id if available
             if (sceneProductID) {
                 const variationID = this.getAttribute("variation-id");
-                const product = new scene_product_ar_1.SceneProductAR(sceneProductID, variationID);
+                const variationSKU = this.getAttribute("variation-sku");
+                const product = new scene_product_ar_1.SceneProductAR(sceneProductID, variationID, variationSKU);
                 return product.init().then(accept).catch(reject);
             }
             const sceneID = this.getAttribute("scene-id");
             // fallback to using default SceneAR implementation
             if (sceneID) {
-                const sceneAR = new scene_ar_1.SceneAR(sceneID);
-                sceneAR.init().then(accept).catch(reject);
-                return;
+                // special case - check if scene only has a single product, if so
+                // we need to use provided variation-id or variation-sku to override
+                const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
+                // just do scene-ar if variation ID and variation SKU is not set
+                if (!variationID && !variationSKU) {
+                    const sceneAR = new scene_ar_1.SceneAR(sceneID);
+                    return sceneAR.init().then(accept).catch(reject);
+                }
+                // otherwise decode scene
+                return configurator_state_1.ConfiguratorState.decodeScene(sceneID).then((state) => {
+                    const firstProduct = state.first();
+                    if (state.length > 1 || !firstProduct) {
+                        return reject(new Error("ViewerController.initAR() - single product required to override variation-id or variation-sku"));
+                    }
+                    const product = new scene_product_ar_1.SceneProductAR(firstProduct.scene_product_id, variationID, variationSKU);
+                    return product.init().then(accept).catch(reject);
+                }).catch(reject);
             }
             return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
         });
@@ -1331,7 +1400,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
 }
 exports.ViewerController = ViewerController;
 
-},{"../../ar/product-ar":3,"../../ar/scene-ar":5,"../../ar/scene-product-ar":6,"../../util/util":15,"./plattar-controller":8,"@plattar/plattar-api":42}],11:[function(require,module,exports){
+},{"../../ar/product-ar":3,"../../ar/scene-ar":5,"../../ar/scene-product-ar":6,"../../util/configurator-state":14,"../../util/util":15,"./plattar-controller":8,"@plattar/plattar-api":42}],11:[function(require,module,exports){
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VTOController = void 0;
@@ -1362,7 +1431,7 @@ class VTOController extends plattar_controller_1.PlattarController {
             this.removeRenderer();
             const sceneID = this.getAttribute("scene-id");
             if (sceneID) {
-                const opt = options || plattar_controller_1.PlattarController.DEFAULT_QR_OPTIONS;
+                const opt = options || this._GetDefaultQROptions();
                 const viewer = document.createElement("plattar-qrcode");
                 // required attributes with defaults for plattar-viewer node
                 const width = this.getAttribute("width") || "500px";
@@ -1378,6 +1447,7 @@ class VTOController extends plattar_controller_1.PlattarController {
                 if (opt.qrType) {
                     viewer.setAttribute("qr-type", opt.qrType);
                 }
+                viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
                 let dst = plattar_api_1.Server.location().base + "renderer/facear.html?scene_id=" + sceneID;
                 // optional attributes
                 const configState = this.getAttribute("config-state");
@@ -2078,7 +2148,7 @@ exports.Util = Util;
 },{}],16:[function(require,module,exports){
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = "1.130.2";
+exports.default = "1.132.1";
 
 },{}],17:[function(require,module,exports){
 "use strict";
@@ -6251,6 +6321,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = "1.120.1";
 
 },{}],115:[function(require,module,exports){
+const Util = require("../../util/util");
 const ElementController = require("../controllers/element-controller");
 
 class BaseElement extends HTMLElement {
@@ -6388,10 +6459,14 @@ class BaseElement extends HTMLElement {
     get elementType() {
         return "none";
     }
+
+    get elementLocation() {
+        return Util.getElementLocation(this.elementType);
+    }
 }
 
 module.exports = BaseElement;
-},{"../controllers/element-controller":117}],116:[function(require,module,exports){
+},{"../../util/util":128,"../controllers/element-controller":117}],116:[function(require,module,exports){
 const BaseElement = require("./base/base-element.js");
 
 class ConfiguratorElement extends BaseElement {
@@ -6407,6 +6482,16 @@ class ConfiguratorElement extends BaseElement {
         return "configurator";
     }
 
+    get elementLocation() {
+        if (this.hasAttribute("show-ui")) {
+            const state = this.getAttribute("show-ui");
+
+            return state === "true" ? "configurator/dist/index.html" : super.elementLocation;
+        }
+
+        return super.elementLocation;
+    }
+
     get optionalAttributes() {
         return [{
             key: "config-state",
@@ -6464,7 +6549,7 @@ class ElementController {
             throw new Error("ElementController - attribute \"server\" must be one of \"production\", \"staging\" or \"dev\"");
         }
 
-        const embedLocation = Util.getElementLocation(element.elementType);
+        const embedLocation = element.elementLocation;
 
         if (embedLocation === undefined) {
             throw new Error("ElementController - element named \"" + elementType + "\" is invalid");
@@ -6554,15 +6639,7 @@ class IFrameController {
         if (element.hasAttribute("fullscreen")) {
             const style = document.createElement('style');
 
-            style.textContent = `
-                ._PlattarFullScreen {
-                    width: 100%;
-                    height: 100%;
-                    position: absolute;
-                    top: 0;
-                    left: 0;
-                }
-            `;
+            style.textContent = `._PlattarFullScreen { width: 100%; height: 100%; position: absolute; top: 0; left: 0; }`;
 
             this._iframe.className = "_PlattarFullScreen";
 
@@ -6701,6 +6778,9 @@ class FaceARElement extends BaseElement {
         return [{
             key: "variation-id",
             map: "variationId"
+        }, {
+            key: "variation-sku",
+            map: "variationSku"
         }, {
             key: "product-id",
             map: "productId"
@@ -6767,6 +6847,9 @@ class ProductElement extends BaseElement {
         return [{
             key: "variation-id",
             map: "variation_id"
+        }, {
+            key: "variation-sku",
+            map: "variationSku"
         }, {
             key: "show-ar",
             map: "show_ar"
@@ -6813,6 +6896,9 @@ class ViewerElement extends BaseElement {
         return [{
             key: "variation-id",
             map: "variationId"
+        }, {
+            key: "variation-sku",
+            map: "variationSku"
         }, {
             key: "product-id",
             map: "productId"
@@ -6900,9 +6986,9 @@ module.exports = {
 class Util {
     static getServerLocation(server) {
         switch (server) {
-            case "production": return "https://app.plattar.com/renderer/";
-            case "staging": return "https://staging.plattar.space/renderer/";
-            case "dev": return "https://localhost/renderer/";
+            case "production": return "https://app.plattar.com/";
+            case "staging": return "https://staging.plattar.space/";
+            case "dev": return "https://localhost/";
             default: return undefined;
         }
     }
@@ -6911,25 +6997,7 @@ class Util {
         const isValid = Util.isValidType(etype);
 
         if (isValid) {
-            return etype + ".html";
-        }
-
-        return undefined;
-    }
-
-    static getElementBundleLocation(etype, server) {
-        const location = Util.getServerLocation(server);
-
-        if (!location) {
-            return undefined;
-        }
-
-        const isValid = Util.isValidType(etype);
-
-        if (isValid) {
-            const isMinified = location === "dev" ? false : true;
-
-            return isMinified ? (etype + "-bundle.min.js") : (etype + "-bundle.js");
+            return "renderer/" + etype + ".html";
         }
 
         return undefined;
@@ -6972,7 +7040,7 @@ class Util {
 
 module.exports = Util;
 },{}],129:[function(require,module,exports){
-module.exports = "1.129.1";
+module.exports = "1.131.1";
 
 },{}],130:[function(require,module,exports){
 (function (global){(function (){