@plattar/plattar-ar-adapter 1.130.3 → 1.131.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) {
@@ -972,6 +989,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;
@@ -988,6 +1006,9 @@ class PlattarController {
             if (variationID) {
                 dst += "&variation_id=" + variationID;
             }
+            if (variationSKU) {
+                dst += "&variation_sku=" + variationSKU;
+            }
             if (arMode) {
                 dst += "&ar_mode=" + arMode;
             }
@@ -1087,10 +1108,14 @@ class ProductController extends plattar_controller_1.PlattarController {
                 }
                 // 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;
@@ -1125,10 +1150,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);
                 }
@@ -1151,7 +1180,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"));
@@ -1179,6 +1209,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");
 /**
@@ -1234,6 +1265,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) {
                     dst += "&productId=" + productID;
@@ -1241,6 +1273,9 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 if (variationID) {
                     dst += "&variationId=" + variationID;
                 }
+                if (variationSKU) {
+                    dst += "&variationSku=" + variationSKU;
+                }
                 if (showAR) {
                     dst += "&show_ar=" + showAR;
                 }
@@ -1275,6 +1310,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);
@@ -1282,6 +1318,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);
                 }
@@ -1305,22 +1344,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"));
         });
@@ -1339,7 +1395,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;
@@ -2086,7 +2142,7 @@ exports.Util = Util;
 },{}],16:[function(require,module,exports){
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = "1.130.3";
+exports.default = "1.131.1";
 
 },{}],17:[function(require,module,exports){
 "use strict";
@@ -6716,6 +6772,9 @@ class FaceARElement extends BaseElement {
         return [{
             key: "variation-id",
             map: "variationId"
+        }, {
+            key: "variation-sku",
+            map: "variationSku"
         }, {
             key: "product-id",
             map: "productId"
@@ -6782,6 +6841,9 @@ class ProductElement extends BaseElement {
         return [{
             key: "variation-id",
             map: "variation_id"
+        }, {
+            key: "variation-sku",
+            map: "variationSku"
         }, {
             key: "show-ar",
             map: "show_ar"
@@ -6828,6 +6890,9 @@ class ViewerElement extends BaseElement {
         return [{
             key: "variation-id",
             map: "variationId"
+        }, {
+            key: "variation-sku",
+            map: "variationSku"
         }, {
             key: "product-id",
             map: "productId"
@@ -6969,7 +7034,7 @@ class Util {
 
 module.exports = Util;
 },{}],129:[function(require,module,exports){
-module.exports = "1.130.1";
+module.exports = "1.131.1";
 
 },{}],130:[function(require,module,exports){
 (function (global){(function (){