@plattar/plattar-ar-adapter 1.128.1 → 1.130.2

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

@@ -3,7 +3,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LauncherAR = void 0;
 class LauncherAR {
-    constructor() { }
+    constructor() {
+        this._opt = {
+            anchor: "horizontal_vertical"
+        };
+    }
     /**
      * Initialise and launch with a single function call. this is mostly for convenience.
      * Use .init() and .start() separately for fine-grained control
@@ -16,6 +20,12 @@ class LauncherAR {
             }).catch(reject);
         });
     }
+    /**
+     * AR Options used for launching AR
+     */
+    get options() {
+        return this._opt;
+    }
 }
 exports.LauncherAR = LauncherAR;
 
@@ -102,8 +112,10 @@ class ModelAR extends launcher_ar_1.LauncherAR {
                 }
                 // check android
                 if (util_1.Util.canSceneViewer()) {
-                    this._ar = new scene_viewer_1.default();
-                    this._ar.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.original_filename;
+                    const arviewer = new scene_viewer_1.default();
+                    arviewer.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.original_filename;
+                    arviewer.isVertical = this.options.anchor === "vertical" ? true : false;
+                    this._ar = arviewer;
                     return accept(this);
                 }
                 // otherwise, we didn't have AR available - it should never really reach this stage as this should be caught
@@ -267,8 +279,17 @@ class ProductAR extends launcher_ar_1.LauncherAR {
                 }
                 // check android
                 if (util_1.Util.canSceneViewer()) {
-                    this._ar = new scene_viewer_1.default();
-                    this._ar.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.original_filename;
+                    const arviewer = new scene_viewer_1.default();
+                    arviewer.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.original_filename;
+                    arviewer.isVertical = this.options.anchor === "vertical" ? true : false;
+                    const scene = product.relationships.find(plattar_api_1.Scene);
+                    if (scene) {
+                        const sceneOpt = scene.attributes.custom_json || {};
+                        if (sceneOpt.anchor === "vertical") {
+                            arviewer.isVertical = true;
+                        }
+                    }
+                    this._ar = arviewer;
                     return accept(this);
                 }
                 // otherwise, we didn't have AR available - it should never really reach this stage as this should be caught
@@ -374,8 +395,10 @@ class RawAR extends launcher_ar_1.LauncherAR {
             // check android
             if (util_1.Util.canSceneViewer()) {
                 if (lowerLoc.endsWith("glb") || lowerLoc.endsWith("gltf")) {
-                    this._ar = new scene_viewer_1.default();
-                    this._ar.modelUrl = modelLocation;
+                    const arviewer = new scene_viewer_1.default();
+                    arviewer.modelUrl = modelLocation;
+                    arviewer.isVertical = this.options.anchor === "vertical" ? true : false;
+                    this._ar = arviewer;
                     return accept(this);
                 }
                 return reject(new Error("RawAR.init() - cannot proceed as model is not a .glb or .gltf file"));
@@ -533,8 +556,13 @@ class SceneAR extends launcher_ar_1.LauncherAR {
                 // check android
                 if (util_1.Util.canSceneViewer()) {
                     return this._ComposeScene(scene, "glb").then((modelUrl) => {
-                        this._ar = new scene_viewer_1.default();
-                        this._ar.modelUrl = modelUrl;
+                        const arviewer = new scene_viewer_1.default();
+                        arviewer.modelUrl = modelUrl;
+                        arviewer.isVertical = this.options.anchor === "vertical" ? true : false;
+                        if (sceneOpt.anchor === "vertical") {
+                            arviewer.isVertical = true;
+                        }
+                        this._ar = arviewer;
                         return accept(this);
                     }).catch(reject);
                 }
@@ -639,9 +667,6 @@ const plattar_controller_1 = require("./plattar-controller");
 class ConfiguratorController extends plattar_controller_1.PlattarController {
     constructor(parent) {
         super(parent);
-        this._state = plattar_controller_1.ControllerState.None;
-        this._element = null;
-        this._prevQROpt = null;
     }
     onAttributesUpdated() {
         const state = this._state;
@@ -651,7 +676,7 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
             return;
         }
     }
-    startQRCode(options) {
+    startViewerQRCode(options) {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();
@@ -852,6 +877,7 @@ exports.ConfiguratorController = ConfiguratorController;
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlattarController = exports.ControllerState = void 0;
+const plattar_api_1 = require("@plattar/plattar-api");
 var ControllerState;
 (function (ControllerState) {
     ControllerState[ControllerState["None"] = 0] = "None";
@@ -863,6 +889,9 @@ var ControllerState;
  */
 class PlattarController {
     constructor(parent) {
+        this._state = ControllerState.None;
+        this._element = null;
+        this._prevQROpt = null;
         this._parent = parent;
     }
     /**
@@ -887,6 +916,86 @@ class PlattarController {
             }).catch(reject);
         });
     }
+    /**
+     * Decide which QR Code to render according to the qr-type attribute
+     * @param options
+     * @returns
+     */
+    startQRCode(options) {
+        const qrType = this.getAttribute("qr-type") || "viewer";
+        switch (qrType.toLowerCase()) {
+            case "ar":
+                return this.startARQRCode(options);
+            case "viewer":
+            default:
+                return this.startViewerQRCode(options);
+        }
+    }
+    /**
+     * Displays a QR Code that sends the user direct to AR
+     * @param options
+     * @returns
+     */
+    startARQRCode(options) {
+        return new Promise((accept, reject) => {
+            // remove the old renderer instance if any
+            this.removeRenderer();
+            const opt = options || PlattarController.DEFAULT_QR_OPTIONS;
+            const viewer = document.createElement("plattar-qrcode");
+            // required attributes with defaults for plattar-viewer node
+            const width = this.getAttribute("width") || "500px";
+            const height = this.getAttribute("height") || "500px";
+            viewer.setAttribute("width", width);
+            viewer.setAttribute("height", height);
+            if (opt.color) {
+                viewer.setAttribute("color", opt.color);
+            }
+            if (opt.margin) {
+                viewer.setAttribute("margin", "" + opt.margin);
+            }
+            if (opt.qrType) {
+                viewer.setAttribute("qr-type", opt.qrType);
+            }
+            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");
+            const configState = this.getAttribute("config-state");
+            const embedType = this.getAttribute("embed-type");
+            const productID = this.getAttribute("product-id");
+            const sceneProductID = this.getAttribute("scene-product-id");
+            const variationID = this.getAttribute("variation-id");
+            const arMode = this.getAttribute("ar-mode");
+            if (configState) {
+                dst += "&config_state=" + configState;
+            }
+            if (embedType) {
+                dst += "&embed_type=" + embedType;
+            }
+            if (productID) {
+                dst += "&product_id=" + productID;
+            }
+            if (sceneProductID) {
+                dst += "&scene_product_id=" + sceneProductID;
+            }
+            if (variationID) {
+                dst += "&variation_id=" + variationID;
+            }
+            if (arMode) {
+                dst += "&ar_mode=" + arMode;
+            }
+            if (sceneID) {
+                dst += "&scene_id=" + sceneID;
+            }
+            viewer.setAttribute("url", opt.url || dst);
+            viewer.onload = () => {
+                return accept(viewer);
+            };
+            this._element = viewer;
+            this._state = ControllerState.QRCode;
+            this._prevQROpt = opt;
+            this.append(viewer);
+        });
+    }
     /**
      * Returns the Parent Instance
      */
@@ -912,7 +1021,7 @@ class PlattarController {
 }
 exports.PlattarController = PlattarController;
 
-},{}],9:[function(require,module,exports){
+},{"@plattar/plattar-api":42}],9:[function(require,module,exports){
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProductController = void 0;
@@ -926,9 +1035,6 @@ const plattar_controller_1 = require("./plattar-controller");
 class ProductController extends plattar_controller_1.PlattarController {
     constructor(parent) {
         super(parent);
-        this._state = plattar_controller_1.ControllerState.None;
-        this._element = null;
-        this._prevQROpt = null;
     }
     onAttributesUpdated() {
         const state = this._state;
@@ -949,7 +1055,7 @@ class ProductController extends plattar_controller_1.PlattarController {
             return;
         }
     }
-    startQRCode(options) {
+    startViewerQRCode(options) {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();
@@ -1063,8 +1169,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ViewerController = void 0;
 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");
 /**
@@ -1073,9 +1179,6 @@ const plattar_controller_1 = require("./plattar-controller");
 class ViewerController extends plattar_controller_1.PlattarController {
     constructor(parent) {
         super(parent);
-        this._state = plattar_controller_1.ControllerState.None;
-        this._element = null;
-        this._prevQROpt = null;
     }
     onAttributesUpdated() {
         const state = this._state;
@@ -1097,7 +1200,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
             return;
         }
     }
-    startQRCode(options) {
+    startViewerQRCode(options) {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();
@@ -1205,16 +1308,11 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 return product.init().then(accept).catch(reject);
             }
             const sceneID = this.getAttribute("scene-id");
-            // use the first default product-variation id if available
+            // fallback to using default SceneAR implementation
             if (sceneID) {
-                return configurator_state_1.ConfiguratorState.decodeScene(sceneID).then((state) => {
-                    const first = state.first();
-                    if (first) {
-                        const sceneProductAR = new scene_product_ar_1.SceneProductAR(first.scene_product_id, first.product_variation_id);
-                        return sceneProductAR.init().then(accept).catch(reject);
-                    }
-                    return reject(new Error("ViewerController.initAR() - your scene does not contain any valid products"));
-                }).catch(reject);
+                const sceneAR = new scene_ar_1.SceneAR(sceneID);
+                sceneAR.init().then(accept).catch(reject);
+                return;
             }
             return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
         });
@@ -1233,7 +1331,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
 }
 exports.ViewerController = ViewerController;
 
-},{"../../ar/product-ar":3,"../../ar/scene-product-ar":6,"../../util/configurator-state":14,"../../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/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;
@@ -1249,9 +1347,6 @@ const plattar_controller_1 = require("./plattar-controller");
 class VTOController extends plattar_controller_1.PlattarController {
     constructor(parent) {
         super(parent);
-        this._state = plattar_controller_1.ControllerState.None;
-        this._element = null;
-        this._prevQROpt = null;
     }
     onAttributesUpdated() {
         const state = this._state;
@@ -1261,7 +1356,7 @@ class VTOController extends plattar_controller_1.PlattarController {
             return;
         }
     }
-    startQRCode(options) {
+    startViewerQRCode(options) {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();
@@ -1639,10 +1734,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfiguratorState = exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = exports.SceneProductAR = exports.ProductAR = exports.version = exports.PlattarQRCode = exports.PlattarWeb = void 0;
+exports.ConfiguratorState = exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = exports.SceneProductAR = exports.ProductAR = exports.LauncherAR = exports.version = exports.PlattarQRCode = exports.PlattarWeb = void 0;
 exports.PlattarWeb = __importStar(require("@plattar/plattar-web"));
 exports.PlattarQRCode = __importStar(require("@plattar/plattar-qrcode"));
 exports.version = __importStar(require("./version"));
+var launcher_ar_1 = require("./ar/launcher-ar");
+Object.defineProperty(exports, "LauncherAR", { enumerable: true, get: function () { return launcher_ar_1.LauncherAR; } });
 var product_ar_1 = require("./ar/product-ar");
 Object.defineProperty(exports, "ProductAR", { enumerable: true, get: function () { return product_ar_1.ProductAR; } });
 var scene_product_ar_1 = require("./ar/scene-product-ar");
@@ -1666,7 +1763,7 @@ if (customElements) {
 }
 console.log("using @plattar/plattar-ar-adapter v" + version_1.default);
 
-},{"./ar/model-ar":2,"./ar/product-ar":3,"./ar/raw-ar":4,"./ar/scene-ar":5,"./ar/scene-product-ar":6,"./embed/plattar-embed":12,"./util/configurator-state":14,"./util/util":15,"./version":16,"@plattar/plattar-qrcode":108,"@plattar/plattar-web":127}],14:[function(require,module,exports){
+},{"./ar/launcher-ar":1,"./ar/model-ar":2,"./ar/product-ar":3,"./ar/raw-ar":4,"./ar/scene-ar":5,"./ar/scene-product-ar":6,"./embed/plattar-embed":12,"./util/configurator-state":14,"./util/util":15,"./version":16,"@plattar/plattar-qrcode":108,"@plattar/plattar-web":127}],14:[function(require,module,exports){
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfiguratorState = void 0;
@@ -1981,7 +2078,7 @@ exports.Util = Util;
 },{}],16:[function(require,module,exports){
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = "1.128.1";
+exports.default = "1.130.2";
 
 },{}],17:[function(require,module,exports){
 "use strict";
@@ -6183,6 +6280,10 @@ class BaseElement extends HTMLElement {
         return this._controller ? this._controller.context : undefined;
     }
 
+    get parent() {
+        return this._controller ? this._controller.parent : undefined;
+    }
+
     get element() {
         return this._controller;
     }
@@ -6405,6 +6506,10 @@ class ElementController {
         return messenger.self;
     }
 
+    get parent() {
+        return messenger.parent;
+    }
+
     get controller() {
         return this._controller;
     }
@@ -6867,7 +6972,7 @@ class Util {
 
 module.exports = Util;
 },{}],129:[function(require,module,exports){
-module.exports = "1.128.1";
+module.exports = "1.129.1";
 
 },{}],130:[function(require,module,exports){
 (function (global){(function (){