@plattar/plattar-ar-adapter 1.123.6 → 1.123.7

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

@@ -12,6 +12,14 @@ export declare class ConfiguratorController extends PlattarController {
     startQRCode(options: any): Promise<HTMLElement>;
     startRenderer(): Promise<HTMLElement>;
     initAR(): Promise<LauncherAR>;
+    /**
+     * Private Function - This launches the Static/Inherited AR Mode
+     */
+    private _InitARInherited;
+    /**
+     * Private Function - This launches the Dynamic/Generated AR Mode
+     */
+    private _InitARGenerated;
     removeRenderer(): boolean;
     get element(): HTMLElement | null;
 }

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

@@ -4,6 +4,9 @@ exports.ConfiguratorController = void 0;
 const plattar_api_1 = require("@plattar/plattar-api");
 const plattar_services_1 = require("@plattar/plattar-services");
 const raw_ar_1 = require("../../ar/raw-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");
 /**
@@ -109,59 +112,103 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
             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
-            const viewer = this.element;
-            const sceneID = this.getAttribute("scene-id");
-            if (viewer && sceneID) {
-                let output = "glb";
-                if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
-                    output = "usdz";
+            const arMode = this.getAttribute("ar-mode") || "generated";
+            switch (arMode.toLowerCase()) {
+                case "inherited":
+                    this._InitARInherited(accept, reject);
+                    return;
+                case "generated":
+                default:
+                    this._InitARGenerated(accept, reject);
+            }
+        });
+    }
+    /**
+     * Private Function - This launches the Static/Inherited AR Mode
+     */
+    _InitARInherited(accept, reject) {
+        const sceneID = this.getAttribute("scene-id");
+        const configState = this.getAttribute("config-state");
+        // use config-state if its available
+        if (sceneID && configState) {
+            const state = configurator_state_1.ConfiguratorState.decode(configState);
+            const first = state.first();
+            if (first) {
+                const sceneProductAR = new scene_product_ar_1.SceneProductAR(first.scene_product_id, first.product_variation_id);
+                sceneProductAR.init().then(accept).catch(reject);
+                return;
+            }
+            return reject(new Error("ConfiguratorController.initAR() - invalid config-state does not have any product states"));
+        }
+        // otherwise fallback to using scene
+        if (sceneID) {
+            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 viewer.messenger.getARFile(output).then((result) => {
-                    const rawAR = new raw_ar_1.RawAR(result.filename);
-                    return 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() - minimum required attributes not set, use scene-id as a minimum"));
+    }
+    /**
+     * Private Function - This launches the Dynamic/Generated AR Mode
+     */
+    _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
+        const viewer = this.element;
+        const sceneID = this.getAttribute("scene-id");
+        if (viewer && sceneID && viewer.messenger) {
+            let output = "glb";
+            if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
+                output = "usdz";
             }
-            const 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) {
-                try {
-                    const decodedb64State = atob(configState);
-                    const state = JSON.parse(decodedb64State);
-                    if (state.meta) {
-                        const sceneProductIndex = state.meta.scene_product_index || 0;
-                        const variationIndex = state.meta.product_variation_index || 1;
-                        const states = state.states || [];
-                        if (states.length > 0) {
-                            const configurator = new plattar_services_1.Configurator();
-                            states.forEach((productState) => {
-                                configurator.addSceneProduct(productState[sceneProductIndex], productState[variationIndex]);
-                            });
-                            if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
-                                configurator.output = "usdz";
-                            }
-                            if (util_1.Util.canSceneViewer()) {
-                                configurator.output = "glb";
-                            }
-                            const server = this.getAttribute("server") || "production";
-                            configurator.server = server;
-                            return configurator.get().then((result) => {
-                                const rawAR = new raw_ar_1.RawAR(result.filename);
-                                rawAR.init().then(accept).catch(reject);
-                            }).catch(reject);
-                        }
-                        return reject(new Error("ConfiguratorController.initAR() - invalid config-state does not have any product states"));
-                    }
-                    return reject(new Error("ConfiguratorController.initAR() - invalid config-state for configurator"));
+            viewer.messenger.getARFile(output).then((result) => {
+                const rawAR = new raw_ar_1.RawAR(result.filename);
+                return rawAR.init().then(accept).catch(reject);
+            }).catch(reject);
+            return;
+        }
+        const 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) {
+            const state = configurator_state_1.ConfiguratorState.decode(configState);
+            if (state.length > 0) {
+                const server = this.getAttribute("server") || "production";
+                const configurator = new plattar_services_1.Configurator();
+                configurator.server = server;
+                if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
+                    configurator.output = "usdz";
                 }
-                catch (err) {
-                    return reject(err);
+                if (util_1.Util.canSceneViewer()) {
+                    configurator.output = "glb";
                 }
+                state.forEach((productState) => {
+                    if (productState.meta_data.augment === true) {
+                        configurator.addSceneProduct(productState.scene_product_id, productState.product_variation_id);
+                    }
+                });
+                configurator.get().then((result) => {
+                    const 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) {
+            const 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"));
     }
     removeRenderer() {
         if (this._element) {

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

@@ -12,6 +12,14 @@ export declare class VTOController extends PlattarController {
     startQRCode(options: any): Promise<HTMLElement>;
     startRenderer(): Promise<HTMLElement>;
     initAR(): Promise<LauncherAR>;
+    /**
+     * Private Function - This launches the Static/Inherited AR Mode
+     */
+    private _InitARInherited;
+    /**
+     * Private Function - This launches the Dynamic/Generated AR Mode
+     */
+    private _InitARGenerated;
     removeRenderer(): boolean;
     get element(): HTMLElement | null;
 }

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

@@ -113,46 +113,94 @@ class VTOController extends plattar_controller_1.PlattarController {
             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
-            const viewer = this.element;
-            const sceneID = this.getAttribute("scene-id");
-            if (viewer && sceneID) {
-                return viewer.messenger.getARFile("vto").then((result) => {
-                    const rawAR = new raw_ar_1.RawAR(result.filename);
-                    return rawAR.init().then(accept).catch(reject);
-                }).catch(reject);
+            const arMode = this.getAttribute("ar-mode") || "generated";
+            switch (arMode.toLowerCase()) {
+                case "inherited":
+                    this._InitARInherited(accept, reject);
+                    return;
+                case "generated":
+                default:
+                    this._InitARGenerated(accept, reject);
             }
-            const 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) {
-                const state = __1.ConfiguratorState.decode(configState);
-                if (state.length > 0) {
-                    const server = this.getAttribute("server") || "production";
-                    const configurator = new plattar_services_1.Configurator();
-                    configurator.server = server;
-                    configurator.output = "vto";
-                    state.forEach((productState) => {
-                        if (productState.meta_data.augment === true) {
-                            configurator.addSceneProduct(productState.scene_product_id, productState.product_variation_id);
-                        }
-                    });
-                    return configurator.get().then((result) => {
-                        const rawAR = new raw_ar_1.RawAR(result.filename);
-                        rawAR.init().then(accept).catch(reject);
-                    }).catch(reject);
-                }
-                return reject(new Error("VTOController.initAR() - invalid config-state does not have any product states"));
+        });
+    }
+    /**
+     * Private Function - This launches the Static/Inherited AR Mode
+     */
+    _InitARInherited(accept, reject) {
+        const sceneID = this.getAttribute("scene-id");
+        const configState = this.getAttribute("config-state");
+        // use config-state if its available
+        if (sceneID && configState) {
+            const state = __1.ConfiguratorState.decode(configState);
+            const first = state.first();
+            if (first) {
+                const sceneProductAR = new __1.SceneProductAR(first.scene_product_id, first.product_variation_id);
+                sceneProductAR.init().then(accept).catch(reject);
+                return;
             }
-            // otherwise no config-state or viewer is active
-            // fallback to using default SceneAR implementation
-            if (sceneID) {
-                const sceneAR = new __1.SceneAR(sceneID);
-                return sceneAR.init().then(accept).catch(reject);
+            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((state) => {
+                const first = state.first();
+                if (first) {
+                    const sceneProductAR = new __1.SceneProductAR(first.scene_product_id, first.product_variation_id);
+                    return sceneProductAR.init().then(accept).catch(reject);
+                }
+                return reject(new Error("VTOController.initAR() - invalid Scene does not have any product states"));
+            }).catch(reject);
+            return;
+        }
+        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
+     */
+    _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
+        const viewer = this.element;
+        const sceneID = this.getAttribute("scene-id");
+        if (viewer && sceneID && viewer.messenger) {
+            viewer.messenger.getARFile("vto").then((result) => {
+                const rawAR = new raw_ar_1.RawAR(result.filename);
+                return rawAR.init().then(accept).catch(reject);
+            }).catch(reject);
+            return;
+        }
+        const 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) {
+            const state = __1.ConfiguratorState.decode(configState);
+            if (state.length > 0) {
+                const server = this.getAttribute("server") || "production";
+                const configurator = new plattar_services_1.Configurator();
+                configurator.server = server;
+                configurator.output = "vto";
+                state.forEach((productState) => {
+                    if (productState.meta_data.augment === true) {
+                        configurator.addSceneProduct(productState.scene_product_id, productState.product_variation_id);
+                    }
+                });
+                configurator.get().then((result) => {
+                    const 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) {
+            const 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"));
     }
     removeRenderer() {
         if (this._element) {

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

@@ -8,6 +8,14 @@ export interface SceneProductData {
 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
+     */
+    setSceneProduct(sceneProductID: string, productVariationID: string, metaData?: any | null | undefined): void;
     /**
      * Adds a new Scene Product/Variation combo with meta-data into the Configurator State
      *
@@ -16,11 +24,44 @@ export declare class ConfiguratorState {
      * @param metaData - Arbitrary meta-data that can be used against certain operaions
      */
     addSceneProduct(sceneProductID: string, productVariationID: string, metaData?: any | null | undefined): void;
+    /**
+     * Search and return the data index reference for the provided Scene Product ID
+     * if not found, will return null
+     * @param sceneProductID
+     */
+    findSceneProductIndex(sceneProductID: string): any[] | null;
+    /**
+     * Search and return the data for the provided Scene Product ID
+     * if not found, will return null
+     * @param sceneProductID
+     */
+    findSceneProduct(sceneProductID: string): SceneProductData | null;
     /**
      * Iterate over the internal state data
      */
     forEach(callback: (data: SceneProductData) => void): void;
+    /**
+     * @returns Returns the first reference of data in the stack, otherwise returns null
+     */
+    first(): SceneProductData | null;
     get length(): number;
+    /**
+     * 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
+     */
     static decode(state: string): ConfiguratorState;
+    /**
+     * 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
+     */
+    static decodeScene(sceneID?: string | null | undefined): Promise<ConfiguratorState>;
+    /**
+     * Encode and return the internal ConfiguratorState as a Base64 String
+     * @returns - Base64 String
+     */
     encode(): string;
 }

package/dist/util/configurator-state.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfiguratorState = void 0;
+const plattar_api_1 = require("@plattar/plattar-api");
 class ConfiguratorState {
     constructor(state = null) {
         const defaultState = {
@@ -30,6 +31,16 @@ class ConfiguratorState {
         }
         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
+     */
+    setSceneProduct(sceneProductID, productVariationID, metaData = null) {
+        this.addSceneProduct(sceneProductID, productVariationID, metaData);
+    }
     /**
      * Adds a new Scene Product/Variation combo with meta-data into the Configurator State
      *
@@ -41,15 +52,63 @@ class ConfiguratorState {
         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);
+            let newData = null;
+            const 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;
             }
-            states.push(newData);
         }
     }
+    /**
+     * Search and return the data index reference for the provided Scene Product ID
+     * if not found, will return null
+     * @param sceneProductID
+     */
+    findSceneProductIndex(sceneProductID) {
+        const states = this._state.states;
+        if (states.length > 0) {
+            const meta = this._state.meta;
+            const found = states.find((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
+     */
+    findSceneProduct(sceneProductID) {
+        const found = this.findSceneProductIndex(sceneProductID);
+        if (found) {
+            const meta = this._state.meta;
+            const 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
      */
@@ -79,12 +138,84 @@ class ConfiguratorState {
             });
         }
     }
+    /**
+     * @returns Returns the first reference of data in the stack, otherwise returns null
+     */
+    first() {
+        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];
+                // ensure the data contains valid elements
+                return check !== null && check !== undefined;
+            });
+            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: true
+                }
+            };
+            // include the meta-data
+            if (found.length === 3) {
+                data.meta_data.augment = found[meta.meta_index].augment || true;
+            }
+            return data;
+        }
+        return null;
+    }
     get length() {
         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
+     */
     static 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
+     */
+    static decodeScene(sceneID = null) {
+        return new Promise((accept, reject) => {
+            const configState = new ConfiguratorState();
+            if (!sceneID) {
+                return reject(new Error("ConfiguratorState.decodeScene(sceneID) - sceneID must be defined"));
+            }
+            const 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((scene) => {
+                const 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((sceneProduct) => {
+                    const 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);
+        });
+    }
+    /**
+     * Encode and return the internal ConfiguratorState as a Base64 String
+     * @returns - Base64 String
+     */
     encode() {
         return btoa(JSON.stringify(this._state));
     }

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.123.6";
+declare const _default: "1.123.7";
 export default _default;

package/dist/version.js

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

package/package.json

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