@plattar/plattar-ar-adapter 1.123.6 → 1.123.7

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

@@ -1086,6 +1086,12 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 
       var raw_ar_1 = require("../../ar/raw-ar");
 
+      var scene_ar_1 = require("../../ar/scene-ar");
+
+      var scene_product_ar_1 = require("../../ar/scene-product-ar");
+
+      var configurator_state_1 = require("../../util/configurator-state");
+
       var util_1 = require("../../util/util");
 
       var plattar_controller_1 = require("./plattar-controller");
@@ -1240,74 +1246,133 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
             return new Promise(function (accept, reject) {
               if (!util_1.Util.canAugment()) {
                 return reject(new Error("ConfiguratorController.initAR() - cannot proceed as AR not available in context"));
-              } // if scene ID is available and the state is a configurator viewer
-              // we can use the real-time configurator state to launch the AR view
+              }
 
+              var arMode = _this15.getAttribute("ar-mode") || "generated";
 
-              var viewer = _this15.element;
+              switch (arMode.toLowerCase()) {
+                case "inherited":
+                  _this15._InitARInherited(accept, reject);
 
-              var sceneID = _this15.getAttribute("scene-id");
+                  return;
 
-              if (viewer && sceneID) {
-                var output = "glb";
+                case "generated":
+                default:
+                  _this15._InitARGenerated(accept, reject);
 
-                if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
-                  output = "usdz";
-                }
+              }
+            });
+          }
+          /**
+           * Private Function - This launches the Static/Inherited AR Mode
+           */
 
-                return viewer.messenger.getARFile(output).then(function (result) {
-                  var rawAR = new raw_ar_1.RawAR(result.filename);
-                  return rawAR.init().then(accept)["catch"](reject);
-                })["catch"](reject);
+        }, {
+          key: "_InitARInherited",
+          value: function _InitARInherited(accept, reject) {
+            var sceneID = this.getAttribute("scene-id");
+            var configState = this.getAttribute("config-state"); // use config-state if its available
+
+            if (sceneID && configState) {
+              var state = configurator_state_1.ConfiguratorState.decode(configState);
+              var first = state.first();
+
+              if (first) {
+                var sceneProductAR = new scene_product_ar_1.SceneProductAR(first.scene_product_id, first.product_variation_id);
+                sceneProductAR.init().then(accept)["catch"](reject);
+                return;
               }
 
-              var configState = _this15.getAttribute("config-state"); // otherwise scene ID is available to the viewer is not launched
-              // we can use the static configuration state to launch the AR view
+              return reject(new Error("ConfiguratorController.initAR() - invalid config-state does not have any product states"));
+            } // otherwise fallback to using scene
 
 
-              if (sceneID && configState) {
-                try {
-                  var decodedb64State = atob(configState);
-                  var state = JSON.parse(decodedb64State);
-
-                  if (state.meta) {
-                    var sceneProductIndex = state.meta.scene_product_index || 0;
-                    var variationIndex = state.meta.product_variation_index || 1;
-                    var states = state.states || [];
-
-                    if (states.length > 0) {
-                      var configurator = new plattar_services_1.Configurator();
-                      states.forEach(function (productState) {
-                        configurator.addSceneProduct(productState[sceneProductIndex], productState[variationIndex]);
-                      });
+            if (sceneID) {
+              configurator_state_1.ConfiguratorState.decodeScene(sceneID).then(function (state) {
+                var first = state.first();
 
-                      if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
-                        configurator.output = "usdz";
-                      }
+                if (first) {
+                  var _sceneProductAR = new scene_product_ar_1.SceneProductAR(first.scene_product_id, first.product_variation_id);
 
-                      if (util_1.Util.canSceneViewer()) {
-                        configurator.output = "glb";
-                      }
+                  return _sceneProductAR.init().then(accept)["catch"](reject);
+                }
 
-                      var server = _this15.getAttribute("server") || "production";
-                      configurator.server = server;
-                      return configurator.get().then(function (result) {
-                        var rawAR = new raw_ar_1.RawAR(result.filename);
-                        rawAR.init().then(accept)["catch"](reject);
-                      })["catch"](reject);
-                    }
+                return reject(new Error("ConfiguratorController.initAR() - invalid Scene does not have any product states"));
+              })["catch"](reject);
+              return;
+            }
 
-                    return reject(new Error("ConfiguratorController.initAR() - invalid config-state does not have any product states"));
-                  }
+            return reject(new Error("ConfiguratorController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
+          }
+          /**
+           * Private Function - This launches the Dynamic/Generated AR Mode
+           */
 
-                  return reject(new Error("ConfiguratorController.initAR() - invalid config-state for configurator"));
-                } catch (err) {
-                  return reject(err);
+        }, {
+          key: "_InitARGenerated",
+          value: function _InitARGenerated(accept, reject) {
+            // if scene ID is available and the state is a configurator viewer
+            // we can use the real-time configurator state to launch the AR view
+            var viewer = this.element;
+            var sceneID = this.getAttribute("scene-id");
+
+            if (viewer && sceneID && viewer.messenger) {
+              var output = "glb";
+
+              if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
+                output = "usdz";
+              }
+
+              viewer.messenger.getARFile(output).then(function (result) {
+                var rawAR = new raw_ar_1.RawAR(result.filename);
+                return rawAR.init().then(accept)["catch"](reject);
+              })["catch"](reject);
+              return;
+            }
+
+            var configState = this.getAttribute("config-state"); // otherwise scene ID is available to the viewer is not launched
+            // we can use the static configuration state to launch the AR view
+
+            if (sceneID && configState) {
+              var state = configurator_state_1.ConfiguratorState.decode(configState);
+
+              if (state.length > 0) {
+                var server = this.getAttribute("server") || "production";
+                var configurator = new plattar_services_1.Configurator();
+                configurator.server = server;
+
+                if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
+                  configurator.output = "usdz";
+                }
+
+                if (util_1.Util.canSceneViewer()) {
+                  configurator.output = "glb";
                 }
+
+                state.forEach(function (productState) {
+                  if (productState.meta_data.augment === true) {
+                    configurator.addSceneProduct(productState.scene_product_id, productState.product_variation_id);
+                  }
+                });
+                configurator.get().then(function (result) {
+                  var rawAR = new raw_ar_1.RawAR(result.filename);
+                  rawAR.init().then(accept)["catch"](reject);
+                })["catch"](reject);
+                return;
               }
 
-              return reject(new Error("ConfiguratorController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
-            });
+              return reject(new Error("ConfiguratorController.initAR() - invalid config-state does not have any product states"));
+            } // otherwise no config-state or viewer is active
+            // fallback to using default SceneAR implementation
+
+
+            if (sceneID) {
+              var sceneAR = new scene_ar_1.SceneAR(sceneID);
+              sceneAR.init().then(accept)["catch"](reject);
+              return;
+            }
+
+            return reject(new Error("ConfiguratorController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
           }
         }, {
           key: "removeRenderer",
@@ -1334,6 +1399,9 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
       exports.ConfiguratorController = ConfiguratorController;
     }, {
       "../../ar/raw-ar": 4,
+      "../../ar/scene-ar": 5,
+      "../../ar/scene-product-ar": 6,
+      "../../util/configurator-state": 14,
       "../../util/util": 15,
       "./plattar-controller": 8,
       "@plattar/plattar-api": 42,
@@ -2068,56 +2136,121 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 
               if (!(util_1.Util.isSafari() || util_1.Util.isChromeOnIOS())) {
                 return reject(new Error("VTOController.initAR() - cannot proceed as VTO AR only available on IOS Mobile devices"));
-              } // if scene ID is available and the state is a configurator viewer
-              // we can use the real-time configurator state to launch the AR view
+              }
 
+              var arMode = _this28.getAttribute("ar-mode") || "generated";
 
-              var viewer = _this28.element;
+              switch (arMode.toLowerCase()) {
+                case "inherited":
+                  _this28._InitARInherited(accept, reject);
 
-              var sceneID = _this28.getAttribute("scene-id");
+                  return;
+
+                case "generated":
+                default:
+                  _this28._InitARGenerated(accept, reject);
 
-              if (viewer && sceneID) {
-                return viewer.messenger.getARFile("vto").then(function (result) {
-                  var rawAR = new raw_ar_1.RawAR(result.filename);
-                  return rawAR.init().then(accept)["catch"](reject);
-                })["catch"](reject);
               }
+            });
+          }
+          /**
+           * Private Function - This launches the Static/Inherited AR Mode
+           */
 
-              var configState = _this28.getAttribute("config-state"); // otherwise scene ID is available to the viewer is not launched
-              // we can use the static configuration state to launch the AR view
+        }, {
+          key: "_InitARInherited",
+          value: function _InitARInherited(accept, reject) {
+            var sceneID = this.getAttribute("scene-id");
+            var configState = this.getAttribute("config-state"); // use config-state if its available
 
+            if (sceneID && configState) {
+              var state = __1.ConfiguratorState.decode(configState);
 
-              if (sceneID && configState) {
-                var state = __1.ConfiguratorState.decode(configState);
+              var first = state.first();
 
-                if (state.length > 0) {
-                  var server = _this28.getAttribute("server") || "production";
-                  var configurator = new plattar_services_1.Configurator();
-                  configurator.server = server;
-                  configurator.output = "vto";
-                  state.forEach(function (productState) {
-                    if (productState.meta_data.augment === true) {
-                      configurator.addSceneProduct(productState.scene_product_id, productState.product_variation_id);
-                    }
-                  });
-                  return configurator.get().then(function (result) {
-                    var rawAR = new raw_ar_1.RawAR(result.filename);
-                    rawAR.init().then(accept)["catch"](reject);
-                  })["catch"](reject);
+              if (first) {
+                var sceneProductAR = new __1.SceneProductAR(first.scene_product_id, first.product_variation_id);
+                sceneProductAR.init().then(accept)["catch"](reject);
+                return;
+              }
+
+              return reject(new Error("VTOController.initAR() - invalid config-state does not have any product states"));
+            } // otherwise fallback to using scene
+
+
+            if (sceneID) {
+              __1.ConfiguratorState.decodeScene(sceneID).then(function (state) {
+                var first = state.first();
+
+                if (first) {
+                  var _sceneProductAR2 = new __1.SceneProductAR(first.scene_product_id, first.product_variation_id);
+
+                  return _sceneProductAR2.init().then(accept)["catch"](reject);
                 }
 
-                return reject(new Error("VTOController.initAR() - invalid config-state does not have any product states"));
-              } // otherwise no config-state or viewer is active
-              // fallback to using default SceneAR implementation
+                return reject(new Error("VTOController.initAR() - invalid Scene does not have any product states"));
+              })["catch"](reject);
 
+              return;
+            }
 
-              if (sceneID) {
-                var sceneAR = new __1.SceneAR(sceneID);
-                return sceneAR.init().then(accept)["catch"](reject);
+            return reject(new Error("VTOController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
+          }
+          /**
+           * Private Function - This launches the Dynamic/Generated AR Mode
+           */
+
+        }, {
+          key: "_InitARGenerated",
+          value: function _InitARGenerated(accept, reject) {
+            // if scene ID is available and the state is a configurator viewer
+            // we can use the real-time configurator state to launch the AR view
+            var viewer = this.element;
+            var sceneID = this.getAttribute("scene-id");
+
+            if (viewer && sceneID && viewer.messenger) {
+              viewer.messenger.getARFile("vto").then(function (result) {
+                var rawAR = new raw_ar_1.RawAR(result.filename);
+                return rawAR.init().then(accept)["catch"](reject);
+              })["catch"](reject);
+              return;
+            }
+
+            var configState = this.getAttribute("config-state"); // otherwise scene ID is available to the viewer is not launched
+            // we can use the static configuration state to launch the AR view
+
+            if (sceneID && configState) {
+              var state = __1.ConfiguratorState.decode(configState);
+
+              if (state.length > 0) {
+                var server = this.getAttribute("server") || "production";
+                var configurator = new plattar_services_1.Configurator();
+                configurator.server = server;
+                configurator.output = "vto";
+                state.forEach(function (productState) {
+                  if (productState.meta_data.augment === true) {
+                    configurator.addSceneProduct(productState.scene_product_id, productState.product_variation_id);
+                  }
+                });
+                configurator.get().then(function (result) {
+                  var rawAR = new raw_ar_1.RawAR(result.filename);
+                  rawAR.init().then(accept)["catch"](reject);
+                })["catch"](reject);
+                return;
               }
 
-              return reject(new Error("VTOController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
-            });
+              return reject(new Error("VTOController.initAR() - invalid config-state does not have any product states"));
+            } // otherwise no config-state or viewer is active
+            // fallback to using default SceneAR implementation
+
+
+            if (sceneID) {
+              var sceneAR = new __1.SceneAR(sceneID);
+              sceneAR.init().then(accept)["catch"](reject);
+              return;
+            }
+
+            return reject(new Error("VTOController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
           }
         }, {
           key: "removeRenderer",
@@ -2519,6 +2652,8 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
       });
       exports.ConfiguratorState = void 0;
 
+      var plattar_api_1 = require("@plattar/plattar-api");
+
       var ConfiguratorState = /*#__PURE__*/function () {
         function ConfiguratorState() {
           var state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
@@ -2564,6 +2699,20 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 
 
         _createClass(ConfiguratorState, [{
+          key: "setSceneProduct",
+          value: function setSceneProduct(sceneProductID, productVariationID) {
+            var metaData = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+            this.addSceneProduct(sceneProductID, productVariationID, metaData);
+          }
+          /**
+           * Adds a new Scene Product/Variation combo with meta-data into the Configurator State
+           *
+           * @param sceneProductID - The Scene Product ID to be used (as defined in Plattar CMS)
+           * @param productVariationID - The Product Variation ID to be used (as defined in Plattar CMS)
+           * @param metaData - Arbitrary meta-data that can be used against certain operaions
+           */
+
+        }, {
           key: "addSceneProduct",
           value: function addSceneProduct(sceneProductID, productVariationID) {
             var metaData = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
@@ -2571,16 +2720,75 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
             if (sceneProductID && productVariationID) {
               var states = this._state.states;
               var meta = this._state.meta;
-              var newData = [];
-              newData.splice(meta.scene_product_index, 0, sceneProductID);
-              newData.splice(meta.product_variation_index, 0, productVariationID);
+              var newData = null;
+              var existingData = this.findSceneProductIndex(sceneProductID);
+
+              if (existingData) {
+                newData = existingData;
+              } else {
+                newData = []; // push the new data into the stack
+
+                states.push(newData);
+              }
+
+              newData[meta.scene_product_index] = sceneProductID;
+              newData[meta.product_variation_index] = productVariationID;
 
               if (metaData) {
-                newData.splice(meta.meta_index, 0, metaData);
+                newData[meta.meta_index] = metaData;
               }
+            }
+          }
+          /**
+           * Search and return the data index reference for the provided Scene Product ID
+           * if not found, will return null
+           * @param sceneProductID
+           */
 
-              states.push(newData);
+        }, {
+          key: "findSceneProductIndex",
+          value: function findSceneProductIndex(sceneProductID) {
+            var states = this._state.states;
+
+            if (states.length > 0) {
+              var meta = this._state.meta;
+              var found = states.find(function (productState) {
+                return productState[meta.scene_product_index] === sceneProductID;
+              });
+              return found ? found : null;
             }
+
+            return null;
+          }
+          /**
+           * Search and return the data for the provided Scene Product ID
+           * if not found, will return null
+           * @param sceneProductID
+           */
+
+        }, {
+          key: "findSceneProduct",
+          value: function findSceneProduct(sceneProductID) {
+            var found = this.findSceneProductIndex(sceneProductID);
+
+            if (found) {
+              var meta = this._state.meta;
+              var data = {
+                scene_product_id: found[meta.scene_product_index],
+                product_variation_id: found[meta.product_variation_index],
+                meta_data: {
+                  augment: true
+                }
+              }; // include the meta-data
+
+              if (found.length === 3) {
+                data.meta_data.augment = found[meta.meta_index].augment || true;
+              }
+
+              return data;
+            }
+
+            return null;
           }
           /**
            * Iterate over the internal state data
@@ -2614,14 +2822,64 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
               });
             }
           }
+          /**
+           * @returns Returns the first reference of data in the stack, otherwise returns null
+           */
+
+        }, {
+          key: "first",
+          value: function first() {
+            var states = this._state.states;
+
+            if (states.length > 0) {
+              var meta = this._state.meta;
+              var found = states.find(function (productState) {
+                var check = productState[meta.scene_product_index]; // ensure the data contains valid elements
+
+                return check !== null && check !== undefined;
+              });
+
+              if (!found) {
+                return null;
+              }
+
+              var data = {
+                scene_product_id: found[meta.scene_product_index],
+                product_variation_id: found[meta.product_variation_index],
+                meta_data: {
+                  augment: true
+                }
+              }; // include the meta-data
+
+              if (found.length === 3) {
+                data.meta_data.augment = found[meta.meta_index].augment || true;
+              }
+
+              return data;
+            }
+
+            return null;
+          }
         }, {
           key: "length",
           get: function get() {
             return this._state.states.length;
           }
+          /**
+           * Decodes and returns an instance of ConfiguratorState from a previously
+           * encoded state
+           * @param state - The previously encoded state as a Base64 String
+           * @returns - ConfiguratorState instance
+           */
+
         }, {
           key: "encode",
-          value: function encode() {
+          value:
+          /**
+           * Encode and return the internal ConfiguratorState as a Base64 String
+           * @returns - Base64 String
+           */
+          function encode() {
             return btoa(JSON.stringify(this._state));
           }
         }], [{
@@ -2629,13 +2887,55 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
           value: function decode(state) {
             return new ConfiguratorState(state);
           }
+          /**
+           * Generates a new ConfiguratorState instance from all SceneProducts and default
+           * variations from the provided Scene ID
+           * @param sceneID - the Scene ID to generate
+           * @returns - Promise that resolves into a ConfiguratorState instance
+           */
+
+        }, {
+          key: "decodeScene",
+          value: function decodeScene() {
+            var sceneID = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+            return new Promise(function (accept, reject) {
+              var configState = new ConfiguratorState();
+
+              if (!sceneID) {
+                return reject(new Error("ConfiguratorState.decodeScene(sceneID) - sceneID must be defined"));
+              }
+
+              var scene = new plattar_api_1.Scene(sceneID);
+              scene.include(plattar_api_1.SceneProduct);
+              scene.include(plattar_api_1.SceneProduct.include(plattar_api_1.Product));
+              scene.get().then(function (scene) {
+                var sceneProducts = scene.relationships.filter(plattar_api_1.SceneProduct); // nothing to do if no AR components can be found
+
+                if (sceneProducts.length <= 0) {
+                  return accept(configState);
+                } // add out scene models
+
+
+                sceneProducts.forEach(function (sceneProduct) {
+                  var product = sceneProduct.relationships.find(plattar_api_1.Product);
+
+                  if (product && product.attributes.product_variation_id) {
+                    configState.setSceneProduct(sceneProduct.id, product.attributes.product_variation_id);
+                  }
+                });
+                accept(configState);
+              })["catch"](reject);
+            });
+          }
         }]);
 
         return ConfiguratorState;
       }();
 
       exports.ConfiguratorState = ConfiguratorState;
-    }, {}],
+    }, {
+      "@plattar/plattar-api": 42
+    }],
     15: [function (require, module, exports) {
       "use strict";
 
@@ -2766,7 +3066,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
       Object.defineProperty(exports, "__esModule", {
         value: true
       });
-      exports["default"] = "1.123.6";
+      exports["default"] = "1.123.7";
     }, {}],
     17: [function (require, module, exports) {
       "use strict";