@plattar/plattar-ar-adapter 1.123.3 → 1.123.7

package/dist/ar/scene-product-ar.d.ts

@@ -0,0 +1,14 @@
+import { ProductAR } from "./product-ar";
+import { LauncherAR } from "./launcher-ar";
+/**
+ * Allows launching Product AR by providing a SceneProduct ID instead.
+ * SceneProducts are much more convenient to grab from the Plattar CMS
+ */
+export declare class SceneProductAR extends ProductAR {
+    private readonly _sceneProductID;
+    private _attachedProductID;
+    constructor(sceneProductID?: string | undefined | null, variationID?: string | undefined | null);
+    get sceneProductID(): string;
+    get productID(): string;
+    init(): Promise<LauncherAR>;
+}

package/dist/ar/scene-product-ar.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SceneProductAR = void 0;
+const product_ar_1 = require("./product-ar");
+const plattar_api_1 = require("@plattar/plattar-api");
+const util_1 = require("../util/util");
+/**
+ * Allows launching Product AR by providing a SceneProduct ID instead.
+ * SceneProducts are much more convenient to grab from the Plattar CMS
+ */
+class SceneProductAR extends product_ar_1.ProductAR {
+    constructor(sceneProductID = null, variationID = null) {
+        super(sceneProductID, variationID);
+        // this is evaluated in the init() function
+        this._attachedProductID = null;
+        if (!sceneProductID) {
+            throw new Error("SceneProductAR.constructor(sceneProductID, variationID) - sceneProductID must be defined");
+        }
+        this._sceneProductID = sceneProductID;
+    }
+    get sceneProductID() {
+        return this._sceneProductID;
+    }
+    get productID() {
+        if (!this._attachedProductID) {
+            throw new Error("SceneProductAR.productID() - product id was not defined, did you call init()?");
+        }
+        return this._attachedProductID;
+    }
+    init() {
+        return new Promise((accept, reject) => {
+            if (!util_1.Util.canAugment()) {
+                return reject(new Error("SceneProductAR.init() - cannot proceed as AR not available in context"));
+            }
+            const sceneProduct = new plattar_api_1.SceneProduct(this.sceneProductID);
+            sceneProduct.get().then((sceneProduct) => {
+                const productID = sceneProduct.attributes.product_id;
+                if (!productID) {
+                    return reject("SceneProductAR.init() - Scene Product does not have an attached Product instance");
+                }
+                this._attachedProductID = productID;
+                // execute the standard Product AR functionality
+                return super.init().then(accept).catch(reject);
+            }).catch(reject);
+        });
+    }
+}
+exports.SceneProductAR = SceneProductAR;

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/product-controller.js

@@ -27,7 +27,9 @@ class ProductController extends plattar_controller_1.PlattarController {
             const viewer = this._element;
             if (viewer) {
                 const variationID = this.getAttribute("variation-id");
-                viewer.messenger.selectVariation(variationID);
+                if (variationID && viewer.messenger) {
+                    viewer.messenger.selectVariation(variationID);
+                }
             }
             return;
         }

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

@@ -3,6 +3,7 @@ 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_product_ar_1 = require("../../ar/scene-product-ar");
 const util_1 = require("../../util/util");
 const plattar_controller_1 = require("./plattar-controller");
 /**
@@ -26,9 +27,11 @@ class ViewerController extends plattar_controller_1.PlattarController {
         if (state === plattar_controller_1.ControllerState.Renderer) {
             const viewer = this._element;
             if (viewer) {
-                const productID = this.getAttribute("product-id");
+                const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
-                viewer.messenger.selectVariation(productID, variationID);
+                if (productID && variationID && viewer.messenger) {
+                    viewer.messenger.selectVariation(productID, variationID);
+                }
             }
             return;
         }
@@ -57,7 +60,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 }
                 let dst = plattar_api_1.Server.location().base + "renderer/viewer.html?scene_id=" + sceneID;
                 // optional attributes
-                const productID = this.getAttribute("product-id");
+                const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
                 if (productID) {
                     dst += "&productId=" + productID;
@@ -94,7 +97,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 viewer.setAttribute("server", server);
                 viewer.setAttribute("scene-id", sceneID);
                 // optional attributes
-                const productID = this.getAttribute("product-id");
+                const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
                 if (productID) {
                     viewer.setAttribute("product-id", productID);
@@ -119,17 +122,25 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 return reject(new Error("ViewerController.initAR() - cannot proceed as AR not available in context"));
             }
             const productID = this.getAttribute("product-id");
+            // use product-id if available
             if (productID) {
                 const variationID = this.getAttribute("variation-id");
                 const product = new product_ar_1.ProductAR(productID, variationID);
                 return product.init().then(accept).catch(reject);
             }
+            const sceneProductID = this.getAttribute("scene-product-id");
+            // use scene-product-id if available
+            if (sceneProductID) {
+                const variationID = this.getAttribute("variation-id");
+                const product = new scene_product_ar_1.SceneProductAR(sceneProductID, variationID);
+                return product.init().then(accept).catch(reject);
+            }
             const sceneID = this.getAttribute("scene-id");
             // otherwise, scene was set so use SceneAR
             if (sceneID) {
-                return reject(new Error("ViewerController.initAR() - AR mode for scene-id not yet supported, use product-id"));
+                return reject(new Error("ViewerController.initAR() - AR mode for scene-id not yet supported, use product-id or scene-product-id"));
             }
-            return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use scene-id or product-id as a minimum"));
+            return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use product-id or scene-product-id as a minimum"));
         });
     }
     removeRenderer() {

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/index.d.ts

@@ -2,6 +2,7 @@ export * as PlattarWeb from "@plattar/plattar-web";
 export * as PlattarQRCode from "@plattar/plattar-qrcode";
 export * as version from "./version";
 export { ProductAR } from "./ar/product-ar";
+export { SceneProductAR } from "./ar/scene-product-ar";
 export { SceneAR } from "./ar/scene-ar";
 export { ModelAR } from "./ar/model-ar";
 export { RawAR } from "./ar/raw-ar";

package/dist/index.js

@@ -22,12 +22,14 @@ 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.ProductAR = exports.version = exports.PlattarQRCode = exports.PlattarWeb = void 0;
+exports.ConfiguratorState = exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = exports.SceneProductAR = 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 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");
+Object.defineProperty(exports, "SceneProductAR", { enumerable: true, get: function () { return scene_product_ar_1.SceneProductAR; } });
 var scene_ar_1 = require("./ar/scene-ar");
 Object.defineProperty(exports, "SceneAR", { enumerable: true, get: function () { return scene_ar_1.SceneAR; } });
 var model_ar_1 = require("./ar/model-ar");

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;
 }