@plattar/plattar-ar-adapter 1.122.3 → 1.123.3

package/dist/embed/plattar-embed.js

@@ -1,18 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const plattar_api_1 = require("@plattar/plattar-api");
-const product_ar_1 = require("../ar/product-ar");
+const product_controller_1 = require("./controllers/product-controller");
+const viewer_controller_1 = require("./controllers/viewer-controller");
+const configurator_controller_1 = require("./controllers/configurator-controller");
+const vto_controller_1 = require("./controllers/vto-controller");
 /**
- * This tracks the current state of the Embed
+ * This tracks the current embed type
  */
-var EmbedState;
-(function (EmbedState) {
-    EmbedState[EmbedState["None"] = 0] = "None";
-    EmbedState[EmbedState["SceneViewer"] = 1] = "SceneViewer";
-    EmbedState[EmbedState["ProductViewer"] = 2] = "ProductViewer";
-    EmbedState[EmbedState["ProductAR"] = 3] = "ProductAR";
-    EmbedState[EmbedState["QRCode"] = 4] = "QRCode";
-})(EmbedState || (EmbedState = {}));
+var EmbedType;
+(function (EmbedType) {
+    EmbedType[EmbedType["Viewer"] = 0] = "Viewer";
+    EmbedType[EmbedType["Configurator"] = 1] = "Configurator";
+    EmbedType[EmbedType["VTO"] = 2] = "VTO";
+})(EmbedType || (EmbedType = {}));
 /**
  * This is the primary <plattar-embed /> node that allows easy embedding
  * of Plattar related content
@@ -20,49 +21,34 @@ var EmbedState;
 class PlattarEmbed extends HTMLElement {
     constructor() {
         super();
-        // this is the current state of the embed, none by default
-        this._currentState = EmbedState.None;
-        this._qrCodeOptions = {
-            color: "#101721",
-            qrType: "default",
-            margin: 0
-        };
-        this._sceneID = null;
-        this._productID = null;
-        this._variationID = null;
-        this._isReady = false;
-        this._width = "500px";
-        this._height = "500px";
-        this._server = "production";
-        this._viewer = null;
+        // this is the current embed type, viewer by default
+        this._currentType = EmbedType.Viewer;
+        this._controller = null;
     }
     get viewer() {
-        return this._viewer;
+        return this._controller ? this._controller.element : null;
     }
     connectedCallback() {
+        const embedType = this.hasAttribute("embed-type") ? this.getAttribute("embed-type") : "viewer";
+        if (embedType) {
+            switch (embedType.toLowerCase()) {
+                case "viewer":
+                    this._currentType = EmbedType.Viewer;
+                    break;
+                case "vto":
+                    this._currentType = EmbedType.VTO;
+                    break;
+                case "configurator":
+                    this._currentType = EmbedType.Configurator;
+                    break;
+                default:
+                    this._currentType = EmbedType.Viewer;
+            }
+        }
         const observer = new MutationObserver((mutations) => {
             mutations.forEach((mutation) => {
                 if (mutation.type === "attributes") {
-                    const sceneID = this.hasAttribute("scene-id") ? this.getAttribute("scene-id") : null;
-                    const productID = this.hasAttribute("product-id") ? this.getAttribute("product-id") : null;
-                    const variationID = this.hasAttribute("variation-id") ? this.getAttribute("variation-id") : null;
-                    let updated = false;
-                    if (sceneID !== this._sceneID) {
-                        this._sceneID = sceneID;
-                        updated = true;
-                    }
-                    if (productID !== this._productID) {
-                        this._productID = productID;
-                        updated = true;
-                    }
-                    if (variationID !== this._variationID) {
-                        this._variationID = variationID;
-                        updated = true;
-                    }
-                    if (updated) {
-                        // re-render based on internal state
-                        this._OnAttributesUpdated();
-                    }
+                    this._OnAttributesUpdated();
                 }
             });
         });
@@ -71,21 +57,24 @@ class PlattarEmbed extends HTMLElement {
         });
         const server = this.hasAttribute("server") ? this.getAttribute("server") : "production";
         plattar_api_1.Server.create(plattar_api_1.Server.match(server || "production"));
-        if (server) {
-            this._server = server;
+        const sceneID = this.hasAttribute("scene-id") ? this.getAttribute("scene-id") : null;
+        const productID = this.hasAttribute("product-id") ? this.getAttribute("product-id") : null;
+        // decide which controller to initialise
+        if (this._currentType === EmbedType.Viewer) {
+            // initialise product if scene-id is missing but product-id is defined
+            if (!sceneID && productID) {
+                this._controller = new product_controller_1.ProductController(this);
+            }
+            else if (sceneID) {
+                this._controller = new viewer_controller_1.ViewerController(this);
+            }
         }
-        this._sceneID = this.hasAttribute("scene-id") ? this.getAttribute("scene-id") : null;
-        this._productID = this.hasAttribute("product-id") ? this.getAttribute("product-id") : null;
-        this._variationID = this.hasAttribute("variation-id") ? this.getAttribute("variation-id") : null;
-        const width = this.hasAttribute("width") ? this.getAttribute("width") : "500px";
-        const height = this.hasAttribute("height") ? this.getAttribute("height") : "500px";
-        if (width) {
-            this._width = width;
+        else if (this._currentType === EmbedType.Configurator) {
+            this._controller = new configurator_controller_1.ConfiguratorController(this);
         }
-        if (height) {
-            this._height = height;
+        else if (this._currentType === EmbedType.VTO) {
+            this._controller = new vto_controller_1.VTOController(this);
         }
-        this._isReady = true;
         const init = this.hasAttribute("init") ? this.getAttribute("init") : null;
         if (init === "ar") {
             this.startAR();
@@ -113,194 +102,54 @@ class PlattarEmbed extends HTMLElement {
     }
     initAR() {
         return new Promise((accept, reject) => {
-            if (!this._isReady) {
-                return reject(new Error("PlattarEmbed.initAR() - cannot execute as page has not loaded yet"));
-            }
-            // if scene is not set but product is, then use ProductAR
-            if (!this._sceneID && this._productID) {
-                const product = new product_ar_1.ProductAR(this._productID, this._variationID);
-                return product.init().then(accept).catch(reject);
+            if (!this._controller) {
+                return reject(new Error("PlattarEmbed.initAR() - cannot execute as controller has not loaded yet"));
             }
-            // If Product is set (under any scenario) then use ProductAR
-            // NOTE: At some point this should check for Scenes when SceneAR
-            // is implemented
-            if (this._productID) {
-                const product = new product_ar_1.ProductAR(this._productID, this._variationID);
-                return product.init().then(accept).catch(reject);
-            }
-            // otherwise, scene was set so use SceneAR
-            if (this._sceneID) {
-                return reject(new Error("PlattarEmbed.initAR() - scene-id not yet supported"));
-            }
-            return reject(new Error("PlattarEmbed.initAR() - minimum required attributes not set, use scene-id or product-id as a minimum"));
+            return this._controller.initAR().then(accept).catch(reject);
         });
     }
     startAR() {
         return new Promise((accept, reject) => {
-            if (!this._isReady) {
-                return reject(new Error("PlattarEmbed.startAR() - cannot execute as page has not loaded yet"));
+            if (!this._controller) {
+                return reject(new Error("PlattarEmbed.startAR() - cannot execute as controller has not loaded yet"));
             }
-            this.initAR().then((launcher) => {
-                launcher.start();
-                accept();
-            }).catch(reject);
+            return this._controller.startAR().then(accept).catch(reject);
         });
     }
     startViewer() {
         return new Promise((accept, reject) => {
-            if (!this._isReady) {
-                return reject(new Error("PlattarEmbed.startViewer() - cannot execute as page has not loaded yet"));
+            if (!this._controller) {
+                return reject(new Error("PlattarEmbed.startViewer() - cannot execute as controller has not loaded yet"));
             }
-            if (this._viewer) {
-                this._viewer.remove();
-                this._viewer = null;
-            }
-            // if scene is set, we use <plattar-viewer /> node from plattar-web
-            if (this._sceneID) {
-                const viewer = document.createElement("plattar-viewer");
-                viewer.setAttribute("width", this._width);
-                viewer.setAttribute("height", this._height);
-                viewer.setAttribute("server", this._server);
-                viewer.setAttribute("scene-id", this._sceneID);
-                if (this._productID) {
-                    viewer.setAttribute("product-id", this._productID);
-                }
-                if (this._variationID) {
-                    viewer.setAttribute("variation-id", this._variationID);
-                }
-                viewer.onload = () => {
-                    return accept(viewer);
-                };
-                const shadow = this.shadowRoot || this.attachShadow({ mode: 'open' });
-                shadow.append(viewer);
-                this._viewer = viewer;
-                this._currentState = EmbedState.SceneViewer;
-                return;
-            }
-            // if product is set, we use <plattar-product /> node from plattar-web
-            if (this._productID) {
-                const viewer = document.createElement("plattar-product");
-                viewer.setAttribute("width", this._width);
-                viewer.setAttribute("height", this._height);
-                viewer.setAttribute("server", this._server);
-                viewer.setAttribute("product-id", this._productID);
-                if (this._variationID) {
-                    viewer.setAttribute("variation-id", this._variationID);
-                }
-                viewer.onload = () => {
-                    return accept(viewer);
-                };
-                const shadow = this.shadowRoot || this.attachShadow({ mode: 'open' });
-                shadow.append(viewer);
-                this._viewer = viewer;
-                this._currentState = EmbedState.ProductViewer;
-                return;
-            }
-            return reject(new Error("PlattarEmbed.startViewer() - minimum required attributes not set, use scene-id or product-id as a minimum"));
+            return this._controller.startRenderer().then(accept).catch(reject);
         });
     }
     startQRCode(options = null) {
         return new Promise((accept, reject) => {
-            if (!this._isReady) {
-                return reject(new Error("PlattarEmbed.startQRCode() - cannot execute as page has not loaded yet"));
-            }
-            const opt = options || this._qrCodeOptions;
-            // reset instance for later use
-            this._qrCodeOptions = opt;
-            if (this._viewer) {
-                this._viewer.remove();
-                this._viewer = null;
-            }
-            // if scene is set, we embed a QR code that takes us to viewer.html
-            if (this._sceneID) {
-                const viewer = document.createElement("plattar-qrcode");
-                viewer.setAttribute("width", this._width);
-                viewer.setAttribute("height", this._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);
-                }
-                let dst = plattar_api_1.Server.location().base + "renderer/viewer.html?scene_id=" + this._sceneID;
-                if (this._productID) {
-                    dst += "&productId=" + this._productID;
-                }
-                if (this._variationID) {
-                    dst += "&variationId=" + this._variationID;
-                }
-                viewer.setAttribute("url", dst);
-                viewer.onload = () => {
-                    return accept(viewer);
-                };
-                const shadow = this.shadowRoot || this.attachShadow({ mode: 'open' });
-                shadow.append(viewer);
-                this._viewer = viewer;
-                this._currentState = EmbedState.QRCode;
-                return;
+            if (!this._controller) {
+                return reject(new Error("PlattarEmbed.startQRCode() - cannot execute as controller has not loaded yet"));
             }
-            // if product is set, we embed a QR code that takes us to product.html
-            if (this._productID) {
-                const viewer = document.createElement("plattar-qrcode");
-                viewer.setAttribute("width", this._width);
-                viewer.setAttribute("height", this._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);
-                }
-                let dst = plattar_api_1.Server.location().base + "renderer/product.html?product_id=" + this._productID;
-                if (this._variationID) {
-                    dst += "&variation_id=" + this._variationID;
-                }
-                viewer.setAttribute("url", dst);
-                viewer.onload = () => {
-                    return accept(viewer);
-                };
-                const shadow = this.shadowRoot || this.attachShadow({ mode: 'open' });
-                shadow.append(viewer);
-                this._viewer = viewer;
-                this._currentState = EmbedState.QRCode;
-                return;
-            }
-            return reject(new Error("PlattarEmbed.startQRCode() - minimum required attributes not set, use scene-id or product-id as a minimum"));
+            return this._controller.startQRCode(options).then(accept).catch(reject);
         });
     }
+    /**
+     * This will remove the currently active Renderer
+     *
+     * @returns - true if removed successfully, false otherwise
+     */
+    removeRenderer() {
+        if (!this._controller) {
+            return false;
+        }
+        return this._controller.removeRenderer();
+    }
     /**
      * This is called by the observer if any of the embed attributes have changed
      * based on the state of the embed, we update the internal structure accordingly
      */
     _OnAttributesUpdated() {
-        // nothing to update in these scenarios
-        if (this._currentState === EmbedState.None || this._currentState === EmbedState.ProductAR) {
-            return;
-        }
-        // re-render the QR Code when attributes have changed
-        if (this._currentState === EmbedState.QRCode) {
-            this.startQRCode(this._qrCodeOptions);
-            return;
-        }
-        // use the messenger function to change variation when attributes have changed
-        if (this._currentState === EmbedState.SceneViewer) {
-            const viewer = this.viewer;
-            if (viewer) {
-                viewer.messenger.selectVariation(this._productID, this._variationID);
-            }
-            return;
-        }
-        if (this._currentState === EmbedState.ProductViewer) {
-            const viewer = this.viewer;
-            if (viewer) {
-                viewer.messenger.selectVariation(this._variationID);
-            }
-            return;
+        if (this._controller) {
+            this._controller.onAttributesUpdated();
         }
     }
 }

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 export * as PlattarWeb from "@plattar/plattar-web";
 export * as PlattarQRCode from "@plattar/plattar-qrcode";
 export * as version from "./version";
-export { ConfiguratorAR } from "./ar/configurator-ar";
 export { ProductAR } from "./ar/product-ar";
 export { SceneAR } from "./ar/scene-ar";
 export { ModelAR } from "./ar/model-ar";
 export { RawAR } from "./ar/raw-ar";
 export { Util } from "./util/util";
+export { ConfiguratorState } from "./util/configurator-state";

package/dist/index.js

@@ -22,12 +22,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = exports.ProductAR = exports.ConfiguratorAR = exports.version = exports.PlattarQRCode = exports.PlattarWeb = void 0;
+exports.ConfiguratorState = exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = exports.ProductAR = 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 configurator_ar_1 = require("./ar/configurator-ar");
-Object.defineProperty(exports, "ConfiguratorAR", { enumerable: true, get: function () { return configurator_ar_1.ConfiguratorAR; } });
 var product_ar_1 = require("./ar/product-ar");
 Object.defineProperty(exports, "ProductAR", { enumerable: true, get: function () { return product_ar_1.ProductAR; } });
 var scene_ar_1 = require("./ar/scene-ar");
@@ -38,6 +36,8 @@ var raw_ar_1 = require("./ar/raw-ar");
 Object.defineProperty(exports, "RawAR", { enumerable: true, get: function () { return raw_ar_1.RawAR; } });
 var util_1 = require("./util/util");
 Object.defineProperty(exports, "Util", { enumerable: true, get: function () { return util_1.Util; } });
+var configurator_state_1 = require("./util/configurator-state");
+Object.defineProperty(exports, "ConfiguratorState", { enumerable: true, get: function () { return configurator_state_1.ConfiguratorState; } });
 const plattar_embed_1 = __importDefault(require("./embed/plattar-embed"));
 const version_1 = __importDefault(require("./version"));
 if (customElements) {

package/dist/util/configurator-state.d.ts

@@ -0,0 +1,26 @@
+export interface SceneProductData {
+    scene_product_id: string;
+    product_variation_id: string;
+    meta_data: {
+        augment: boolean;
+    };
+}
+export declare class ConfiguratorState {
+    private readonly _state;
+    constructor(state?: string | null | undefined);
+    /**
+     * 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
+     */
+    addSceneProduct(sceneProductID: string, productVariationID: string, metaData?: any | null | undefined): void;
+    /**
+     * Iterate over the internal state data
+     */
+    forEach(callback: (data: SceneProductData) => void): void;
+    get length(): number;
+    static decode(state: string): ConfiguratorState;
+    encode(): string;
+}

package/dist/util/configurator-state.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfiguratorState = void 0;
+class ConfiguratorState {
+    constructor(state = null) {
+        const defaultState = {
+            meta: {
+                scene_product_index: 0,
+                product_variation_index: 1,
+                meta_index: 2,
+            },
+            states: []
+        };
+        if (state) {
+            try {
+                const decodedb64State = atob(state);
+                const parsedState = JSON.parse(decodedb64State);
+                // set the meta data
+                if (parsedState.meta) {
+                    defaultState.meta.scene_product_index = parsedState.meta.scene_product_index || 0;
+                    defaultState.meta.product_variation_index = parsedState.meta.product_variation_index || 1;
+                    defaultState.meta.meta_index = parsedState.meta.meta_index || 2;
+                }
+                defaultState.states = parsedState.states || [];
+            }
+            catch (err) {
+                console.error("ConfiguratorState.constructor() - there was an error parsing configurator state");
+                console.error(err);
+            }
+        }
+        this._state = defaultState;
+    }
+    /**
+     * 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
+     */
+    addSceneProduct(sceneProductID, productVariationID, metaData = null) {
+        if (sceneProductID && productVariationID) {
+            const states = this._state.states;
+            const meta = this._state.meta;
+            const newData = [];
+            newData.splice(meta.scene_product_index, 0, sceneProductID);
+            newData.splice(meta.product_variation_index, 0, productVariationID);
+            if (metaData) {
+                newData.splice(meta.meta_index, 0, metaData);
+            }
+            states.push(newData);
+        }
+    }
+    /**
+     * Iterate over the internal state data
+     */
+    forEach(callback) {
+        const states = this._state.states;
+        const meta = this._state.meta;
+        if (states.length > 0) {
+            states.forEach((productState) => {
+                if (productState.length === 2) {
+                    callback({
+                        scene_product_id: productState[meta.scene_product_index],
+                        product_variation_id: productState[meta.product_variation_index],
+                        meta_data: {
+                            augment: true
+                        }
+                    });
+                }
+                else if (productState.length === 3) {
+                    callback({
+                        scene_product_id: productState[meta.scene_product_index],
+                        product_variation_id: productState[meta.product_variation_index],
+                        meta_data: {
+                            augment: productState[meta.meta_index].augment || true
+                        }
+                    });
+                }
+            });
+        }
+    }
+    get length() {
+        return this._state.states.length;
+    }
+    static decode(state) {
+        return new ConfiguratorState(state);
+    }
+    encode() {
+        return btoa(JSON.stringify(this._state));
+    }
+}
+exports.ConfiguratorState = ConfiguratorState;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.122.3";
+declare const _default: "1.123.3";
 export default _default;

package/dist/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = "1.122.3";
+exports.default = "1.123.3";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.122.3",
+  "version": "1.123.3",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -39,16 +39,17 @@
   "dependencies": {
     "@plattar/plattar-analytics": "^1.117.2",
     "@plattar/plattar-api": "^1.120.1",
-    "@plattar/plattar-qrcode": "1.120.3",
-    "@plattar/plattar-web": "^1.122.2"
+    "@plattar/plattar-qrcode": "1.122.1",
+    "@plattar/plattar-services": "^1.120.1",
+    "@plattar/plattar-web": "^1.122.3"
   },
   "devDependencies": {
-    "@babel/cli": "^7.16.8",
-    "@babel/core": "^7.16.12",
+    "@babel/cli": "^7.17.0",
+    "@babel/core": "^7.17.2",
     "@babel/preset-env": "^7.16.11",
     "browserify": "^17.0.0",
     "typescript": "^4.5.5",
-    "uglify-es": "^3.3.9"
+    "uglify-js": "^3.15.1"
   },
   "publishConfig": {
     "access": "public"

package/dist/ar/configurator-ar.d.ts

@@ -1,9 +0,0 @@
-import { LauncherAR } from "./launcher-ar";
-/**
- * Performs AR related to Plattar Configurator functionalities
- */
-export declare class ConfiguratorAR extends LauncherAR {
-    init(): Promise<LauncherAR>;
-    launch(): Promise<void>;
-    start(): void;
-}

package/dist/ar/configurator-ar.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfiguratorAR = void 0;
-const launcher_ar_1 = require("./launcher-ar");
-/**
- * Performs AR related to Plattar Configurator functionalities
- */
-class ConfiguratorAR extends launcher_ar_1.LauncherAR {
-    init() {
-        throw new Error("Method not implemented.");
-    }
-    launch() {
-        throw new Error("Method not implemented.");
-    }
-    start() {
-        throw new Error("Method not implemented.");
-    }
-}
-exports.ConfiguratorAR = ConfiguratorAR;