@plattar/plattar-ar-adapter 1.155.3 → 1.155.4-b2

package/dist/embed/controllers/configurator-controller.d.ts

@@ -8,6 +8,7 @@ export declare class ConfiguratorController extends PlattarController {
     private _cachedConfigState;
     getConfiguratorState(): Promise<DecodedConfiguratorState>;
     onAttributesUpdated(attributeName: string): Promise<void>;
+    startARQRCode(options: any): Promise<HTMLElement>;
     startViewerQRCode(options: any): Promise<HTMLElement>;
     startRenderer(): Promise<HTMLElement>;
     initAR(): Promise<LauncherAR>;

package/dist/embed/controllers/configurator-controller.js

@@ -65,12 +65,58 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
             return;
         }
     }
+    async startARQRCode(options) {
+        try {
+            const dState = await this.getConfiguratorState();
+            // if this is declared, we have a furniture scene that we need to re-create the embed
+            // with new attributes
+            const product = dState.state.firstOfType("product");
+            if (product) {
+                this.parent.lockObserver();
+                this.parent.destroy();
+                this.setAttribute("product-id", product.scene_product_id);
+                this.parent.unlockObserver();
+                const controller = this.parent.create();
+                if (controller) {
+                    return controller.startARQRCode(options);
+                }
+                return Promise.reject(new Error("ConfiguratorController.startARQRCode() - legacy product transition failed"));
+            }
+        }
+        catch (_err) {
+        }
+        return super.startARQRCode(options);
+    }
     async startViewerQRCode(options) {
         // remove the old renderer instance if any
         this.removeRenderer();
         const sceneID = this.getAttribute("scene-id");
         if (!sceneID) {
-            throw new Error("ConfiguratorController.startQRCode() - minimum required attributes not set, use scene-id as a minimum");
+            throw new Error("ConfiguratorController.startViewerQRCode() - minimum required attributes not set, use scene-id as a minimum");
+        }
+        // optional attributes
+        let configState = null;
+        try {
+            const dState = await this.getConfiguratorState();
+            // if this is declared, we have a furniture scene that we need to re-create the embed
+            // with new attributes
+            const product = dState.state.firstOfType("product");
+            if (product) {
+                this.parent.lockObserver();
+                this.parent.destroy();
+                this.setAttribute("product-id", product.scene_product_id);
+                this.parent.unlockObserver();
+                const controller = this.parent.create();
+                if (controller) {
+                    return controller.startViewerQRCode(options);
+                }
+                return Promise.reject(new Error("ConfiguratorController.startViewerQRCode() - legacy product transition failed"));
+            }
+            configState = dState.state.encode();
+        }
+        catch (_err) {
+            // config state is not available
+            configState = null;
         }
         const opt = options || this._GetDefaultQROptions();
         const viewer = document.createElement("plattar-qrcode");
@@ -91,17 +137,8 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
         }
         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
-        let configState = null;
         const showAR = this.getAttribute("show-ar");
         const showUI = this.getAttribute("show-ui");
-        try {
-            configState = (await this.getConfiguratorState()).state.encode();
-        }
-        catch (_err) {
-            // config state is not available
-            configState = null;
-        }
         if (showUI && showUI === "true") {
             dst = plattar_api_1.Server.location().base + "configurator/dist/index.html?scene_id=" + sceneID;
         }
@@ -128,6 +165,30 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
         if (!sceneID) {
             throw new Error("ConfiguratorController.startRenderer() - minimum required attributes not set, use scene-id as a minimum");
         }
+        // optional attributes
+        let configState = null;
+        try {
+            const dState = await this.getConfiguratorState();
+            // if this is declared, we have a furniture scene that we need to re-create the embed
+            // with new attributes
+            const product = dState.state.firstOfType("product");
+            if (product) {
+                this.parent.lockObserver();
+                this.parent.destroy();
+                this.setAttribute("product-id", product.scene_product_id);
+                this.parent.unlockObserver();
+                const controller = this.parent.create();
+                if (controller) {
+                    return controller.startRenderer();
+                }
+                return Promise.reject(new Error("ConfiguratorController.startRenderer() - legacy product transition failed"));
+            }
+            configState = dState;
+        }
+        catch (_err) {
+            // config state is not available
+            configState = null;
+        }
         // required attributes with defaults for plattar-configurator node
         const width = this.getAttribute("width") || "500px";
         const height = this.getAttribute("height") || "500px";
@@ -138,15 +199,6 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
         viewer.setAttribute("height", height);
         viewer.setAttribute("server", server);
         viewer.setAttribute("scene-id", sceneID);
-        // optional attributes
-        let configState = null;
-        try {
-            configState = await this.getConfiguratorState();
-        }
-        catch (_err) {
-            // config state is not available
-            configState = null;
-        }
         const showAR = this.getAttribute("show-ar");
         const showUI = this.getAttribute("show-ui");
         if (configState) {
@@ -171,6 +223,26 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
         if (!util_1.Util.canAugment()) {
             throw new Error("ConfiguratorController.initAR() - cannot proceed as AR not available in context");
         }
+        try {
+            const dState = await this.getConfiguratorState();
+            // if this is declared, we have a furniture scene that we need to re-create the embed
+            // with new attributes
+            const product = dState.state.firstOfType("product");
+            if (product) {
+                this.parent.lockObserver();
+                this.parent.destroy();
+                this.setAttribute("product-id", product.scene_product_id);
+                this.parent.unlockObserver();
+                const controller = this.parent.create();
+                if (controller) {
+                    return controller.initAR();
+                }
+                return Promise.reject(new Error("ConfiguratorController.initAR() - legacy product transition failed"));
+            }
+        }
+        catch (_err) {
+            // config state is not available
+        }
         const arMode = this.getAttribute("ar-mode") || "generated";
         switch (arMode.toLowerCase()) {
             case "inherited":

package/dist/embed/controllers/plattar-controller.d.ts

@@ -1,5 +1,6 @@
 import { LauncherAR } from "../../ar/launcher-ar";
 import { DecodedConfiguratorState } from "../../util/configurator-state";
+import type PlattarEmbed from "../plattar-embed";
 export declare enum ControllerState {
     None = 0,
     Renderer = 1,
@@ -19,7 +20,7 @@ export declare abstract class PlattarController {
     protected _prevQROpt: any;
     private _selectVariationObserver;
     private _selectVariationSKUObserver;
-    constructor(parent: HTMLElement);
+    constructor(parent: PlattarEmbed);
     /**
      * Generates a brand new Configurator State from the provided SceneID or inputted Configurator State
      */
@@ -82,13 +83,20 @@ export declare abstract class PlattarController {
     /**
      * Returns the Parent Instance
      */
-    get parent(): HTMLElement;
+    get parent(): PlattarEmbed;
     /**
      * Returns the specified attribute from the parent
-     * @param attribute - The name of thhe attribute
+     * @param attribute - The name of the attribute
      * @returns - The attribute value or null
      */
     getAttribute(attribute: string): string | null;
+    /**
+     * Sets a particular attribute into the HTML DOM
+     *
+     * @param attribute - The name of the attribute
+     * @param value - The value of the attribute
+     */
+    setAttribute(attribute: string, value: string): void;
     /**
      * Appends the provided element into the shadow-root of the parent element
      * @param element - The element to append

package/dist/embed/controllers/plattar-controller.js

@@ -205,12 +205,23 @@ class PlattarController {
     }
     /**
      * Returns the specified attribute from the parent
-     * @param attribute - The name of thhe attribute
+     * @param attribute - The name of the attribute
      * @returns - The attribute value or null
      */
     getAttribute(attribute) {
         return this.parent ? (this.parent.hasAttribute(attribute) ? this.parent.getAttribute(attribute) : null) : null;
     }
+    /**
+     * Sets a particular attribute into the HTML DOM
+     *
+     * @param attribute - The name of the attribute
+     * @param value - The value of the attribute
+     */
+    setAttribute(attribute, value) {
+        if (this.parent) {
+            this.parent.setAttribute(attribute, value);
+        }
+    }
     /**
      * Appends the provided element into the shadow-root of the parent element
      * @param element - The element to append

package/dist/embed/controllers/product-controller.d.ts

@@ -9,7 +9,6 @@ import { DecodedConfiguratorState } from "../../util/configurator-state";
  */
 export declare class ProductController extends PlattarController {
     getConfiguratorState(): Promise<DecodedConfiguratorState>;
-    constructor(parent: HTMLElement);
     onAttributesUpdated(attributeName: string): Promise<void>;
     startViewerQRCode(options: any): Promise<HTMLElement>;
     /**

package/dist/embed/controllers/product-controller.js

@@ -15,11 +15,6 @@ class ProductController extends plattar_controller_1.PlattarController {
     async getConfiguratorState() {
         throw new Error("ProductController.getConfiguratorState() - legacy embeds do not support configurator states");
     }
-    constructor(parent) {
-        // this is a hack against DecodedConfiguratorState that's now stored in PlattarController
-        // this is not used in legacy mode
-        super(parent);
-    }
     async onAttributesUpdated(attributeName) {
         const state = this._state;
         // re-render the QR Code when attributes have changed

package/dist/embed/plattar-embed.d.ts

@@ -1,10 +1,12 @@
 import { LauncherAR } from "../ar/launcher-ar";
+import { PlattarController } from "./controllers/plattar-controller";
 /**
  * This is the primary <plattar-embed /> node that allows easy embedding
  * of Plattar related content
  */
 export default class PlattarEmbed extends HTMLElement {
     private _currentType;
+    private _observerState;
     private _controller;
     private _currentSceneID;
     private _observer;
@@ -17,7 +19,15 @@ export default class PlattarEmbed extends HTMLElement {
     /**
      * creates a brand new instance of this embed
      */
-    create(): void;
+    create(): PlattarController | null;
+    /**
+     * Locks the observer so attribute changes do not trigger anything
+     */
+    lockObserver(): void;
+    /**
+     * Unlocks the observer so attribute changes will start to re-trigger properly
+     */
+    unlockObserver(): void;
     /**
      * Destroys the active instance of this embed and resets internal state to default
      */

package/dist/embed/plattar-embed.js

@@ -14,6 +14,14 @@ var EmbedType;
     EmbedType[EmbedType["VTO"] = 2] = "VTO";
     EmbedType[EmbedType["None"] = 3] = "None";
 })(EmbedType || (EmbedType = {}));
+/**
+ * Controls the state of the observer
+ */
+var ObserverState;
+(function (ObserverState) {
+    ObserverState[ObserverState["Locked"] = 0] = "Locked";
+    ObserverState[ObserverState["Unlocked"] = 1] = "Unlocked";
+})(ObserverState || (ObserverState = {}));
 /**
  * This is the primary <plattar-embed /> node that allows easy embedding
  * of Plattar related content
@@ -23,6 +31,7 @@ class PlattarEmbed extends HTMLElement {
         super();
         // this is the current embed type, viewer by default
         this._currentType = EmbedType.None;
+        this._observerState = ObserverState.Unlocked;
         this._controller = null;
         this._currentSceneID = null;
         this._observer = null;
@@ -45,17 +54,19 @@ class PlattarEmbed extends HTMLElement {
         plattar_api_1.Server.create(plattar_api_1.Server.match(server || "production"));
         if (!this._observer) {
             this._observer = new MutationObserver((mutations) => {
-                mutations.forEach((mutation) => {
-                    if (mutation.type === "attributes") {
-                        const attributeName = mutation.attributeName ? mutation.attributeName : "none";
-                        if (this._currentType !== EmbedType.Legacy) {
-                            this._CreateEmbed(attributeName);
-                        }
-                        else {
-                            this._OnAttributesUpdated(attributeName);
+                if (this._observerState === ObserverState.Unlocked) {
+                    mutations.forEach((mutation) => {
+                        if (mutation.type === "attributes") {
+                            const attributeName = mutation.attributeName ? mutation.attributeName : "none";
+                            if (this._currentType !== EmbedType.Legacy) {
+                                this._CreateEmbed(attributeName);
+                            }
+                            else {
+                                this._OnAttributesUpdated(attributeName);
+                            }
                         }
-                    }
-                });
+                    });
+                }
             });
             this._observer.observe(this, {
                 attributes: true
@@ -65,9 +76,22 @@ class PlattarEmbed extends HTMLElement {
         if (productID) {
             this._currentType = EmbedType.Legacy;
             this._CreateLegacyEmbed();
-            return;
+            return this._controller;
         }
         this._CreateEmbed("none");
+        return this._controller;
+    }
+    /**
+     * Locks the observer so attribute changes do not trigger anything
+     */
+    lockObserver() {
+        this._observerState = ObserverState.Locked;
+    }
+    /**
+     * Unlocks the observer so attribute changes will start to re-trigger properly
+     */
+    unlockObserver() {
+        this._observerState = ObserverState.Unlocked;
     }
     /**
      * Destroys the active instance of this embed and resets internal state to default

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

@@ -1,4 +1,5 @@
 import { Scene } from "@plattar/plattar-api";
+export type SceneProductDataMetaType = "sceneproduct" | "scenemodel" | "product";
 export interface SceneProductData {
     scene_product_id: string;
     product_variation_id: string;
@@ -6,7 +7,7 @@ export interface SceneProductData {
 }
 export interface SceneProductDataMeta {
     augment: boolean;
-    type: "sceneproduct" | "scenemodel";
+    type: SceneProductDataMetaType;
 }
 export interface DecodedConfiguratorState {
     readonly scene: Scene;
@@ -47,6 +48,13 @@ export declare class ConfiguratorState {
      * @param metaData - Arbitrary meta-data that can be used against certain operaions
      */
     setSceneModel(SceneModelID: string, metaData?: SceneProductDataMeta | null | undefined): void;
+    /**
+     * Adds a new Product with meta-data into the Configurator State
+     *
+     * @param productID - The Product ID to add
+     * @param metaData - Arbitrary meta-data that can be used against certain operaions
+     */
+    setProduct(productID: string, productVariationID: string, metaData?: SceneProductDataMeta | null | undefined): void;
     /**
      * Adds a new Scene Product/Variation combo with meta-data into the Configurator State
      *
@@ -79,6 +87,10 @@ export declare class ConfiguratorState {
      * @returns Returns the first reference of data in the stack, otherwise returns null
      */
     first(): SceneProductData | null;
+    /**
+     * @returns Returns the first reference of data in the stack that matches a type, otherwise returns null
+     */
+    firstOfType(type: SceneProductDataMetaType): SceneProductData | null;
     get length(): number;
     /**
      * Decodes and returns an instance of ConfiguratorState from a previously

package/dist/util/configurator-state.js

@@ -14,6 +14,7 @@ class ConfiguratorState {
             meta: {
                 scene_product_index: 0,
                 scene_model_index: 0,
+                product_index: 0,
                 product_variation_index: 1,
                 meta_index: 2,
             },
@@ -27,6 +28,7 @@ class ConfiguratorState {
                 if (parsedState.meta) {
                     defaultState.meta.scene_product_index = parsedState.meta.scene_product_index || 0;
                     defaultState.meta.scene_model_index = parsedState.meta.scene_model_index || 0;
+                    defaultState.meta.product_index = parsedState.meta.product_index || 0;
                     defaultState.meta.product_variation_index = parsedState.meta.product_variation_index || 1;
                     defaultState.meta.meta_index = parsedState.meta.meta_index || 2;
                 }
@@ -103,6 +105,33 @@ class ConfiguratorState {
             newData[meta.meta_index] = metaData;
         }
     }
+    /**
+     * Adds a new Product with meta-data into the Configurator State
+     *
+     * @param productID - The Product ID to add
+     * @param metaData - Arbitrary meta-data that can be used against certain operaions
+     */
+    setProduct(productID, productVariationID, metaData = null) {
+        if (productID && productVariationID) {
+            metaData = metaData || { augment: true, type: "product" };
+            metaData.type = "product";
+            const states = this._state.states;
+            const meta = this._state.meta;
+            let newData = null;
+            const existingData = this.findSceneProductIndex(productID);
+            if (existingData) {
+                newData = existingData;
+            }
+            else {
+                newData = [];
+                // push the new data into the stack
+                states.push(newData);
+            }
+            newData[meta.product_index] = productID;
+            newData[meta.product_variation_index] = productVariationID;
+            newData[meta.meta_index] = metaData;
+        }
+    }
     /**
      * Adds a new Scene Product/Variation combo with meta-data into the Configurator State
      *
@@ -246,6 +275,35 @@ class ConfiguratorState {
         }
         return null;
     }
+    /**
+     * @returns Returns the first reference of data in the stack that matches a type, otherwise returns null
+     */
+    firstOfType(type) {
+        const states = this._state.states;
+        if (states.length > 0) {
+            const meta = this._state.meta;
+            const found = states.find((productState) => {
+                const check = productState[meta.scene_product_index];
+                if (check !== null && check !== undefined) {
+                    return productState.length === 3 && productState[meta.meta_index].type === type;
+                }
+                return false;
+            });
+            if (!found) {
+                return null;
+            }
+            const data = {
+                scene_product_id: found[meta.scene_product_index],
+                product_variation_id: found[meta.product_variation_index],
+                meta_data: {
+                    augment: found[meta.meta_index].augment || true,
+                    type: found[meta.meta_index].type || type
+                }
+            };
+            return data;
+        }
+        return null;
+    }
     get length() {
         return this._state.states.length;
     }
@@ -271,6 +329,7 @@ class ConfiguratorState {
         const configState = new ConfiguratorState(state);
         const fscene = new plattar_api_1.Scene(sceneID);
         fscene.include(plattar_api_1.Project);
+        fscene.include(plattar_api_1.Product);
         fscene.include(plattar_api_1.SceneProduct);
         fscene.include(plattar_api_1.SceneModel);
         fscene.include(plattar_api_1.SceneProduct.include(plattar_api_1.Product.include(plattar_api_1.ProductVariation)));
@@ -295,18 +354,29 @@ class ConfiguratorState {
         fscene.include(plattar_api_1.Project);
         fscene.include(plattar_api_1.SceneProduct);
         fscene.include(plattar_api_1.SceneModel);
+        fscene.include(plattar_api_1.Product);
         fscene.include(plattar_api_1.SceneProduct.include(plattar_api_1.Product.include(plattar_api_1.ProductVariation)));
         const scene = await fscene.get();
         const sceneProducts = scene.relationships.filter(plattar_api_1.SceneProduct);
         const sceneModels = scene.relationships.filter(plattar_api_1.SceneModel);
-        // add out scene models
+        const products = scene.relationships.filter(plattar_api_1.Product);
+        // add our scene models
         sceneModels.forEach((sceneModel) => {
             configState.setSceneModel(sceneModel.id, {
                 augment: sceneModel.attributes.include_in_augment,
                 type: "scenemodel"
             });
         });
-        // add out scene products
+        // add our products - this is used when scene == furniture
+        products.forEach((product) => {
+            if (product.attributes.product_variation_id) {
+                configState.setProduct(product.id, product.attributes.product_variation_id, {
+                    augment: true,
+                    type: "product"
+                });
+            }
+        });
+        // add our scene products
         sceneProducts.forEach((sceneProduct) => {
             const product = sceneProduct.relationships.find(plattar_api_1.Product);
             if (product) {

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.155.3";
+declare const _default: "1.155.4-b2";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.155.3",
+  "version": "1.155.4-b2",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",