@plattar/plattar-ar-adapter 1.172.1 → 1.178.1

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

@@ -0,0 +1,15 @@
+import { LauncherAR } from "../../ar/launcher-ar";
+import { DecodedConfiguratorState } from "../../util/configurator-state";
+import { PlattarController } from "./plattar-controller";
+/**
+ * Manages an instance of the <plattar-configurator> HTML Element
+ */
+export declare class GalleryController extends PlattarController {
+    private _cachedConfigState;
+    getConfiguratorState(): Promise<DecodedConfiguratorState>;
+    onAttributesUpdated(attributeName: string): Promise<void>;
+    startViewerQRCode(options: any): Promise<HTMLElement>;
+    startRenderer(): Promise<HTMLElement>;
+    initAR(): Promise<LauncherAR>;
+    get element(): HTMLElement | null;
+}

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

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GalleryController = void 0;
+const plattar_api_1 = require("@plattar/plattar-api");
+const plattar_controller_1 = require("./plattar-controller");
+/**
+ * Manages an instance of the <plattar-configurator> HTML Element
+ */
+class GalleryController extends plattar_controller_1.PlattarController {
+    constructor() {
+        super(...arguments);
+        this._cachedConfigState = null;
+    }
+    async getConfiguratorState() {
+        if (this._cachedConfigState) {
+            return this._cachedConfigState;
+        }
+        this._cachedConfigState = this.createConfiguratorState();
+        return this._cachedConfigState;
+    }
+    async onAttributesUpdated(attributeName) {
+        const state = this._state;
+        // re-render the QR Code when attributes have changed
+        if (state === plattar_controller_1.ControllerState.QRCode) {
+            if (attributeName === "variation-id") {
+                const configState = await this.getConfiguratorState();
+                const variationIDs = this.getAttribute("variation-id");
+                const variationIDsList = variationIDs ? variationIDs.split(",") : [];
+                variationIDsList.forEach((variationID) => {
+                    configState.state.setVariationID(variationID);
+                });
+            }
+            if (attributeName === "variation-sku") {
+                const configState = await this.getConfiguratorState();
+                const variationSKUs = this.getAttribute("variation-sku");
+                const variationSKUList = variationSKUs ? variationSKUs.split(",") : [];
+                variationSKUList.forEach((variationSKU) => {
+                    configState.state.setVariationSKU(variationSKU);
+                });
+            }
+            this.startQRCode(this._prevQROpt);
+            return;
+        }
+    }
+    async startViewerQRCode(options) {
+        // remove the old renderer instance if any
+        this.removeRenderer();
+        const sceneID = this.getAttribute("scene-id");
+        if (!sceneID) {
+            throw new Error("GalleryController.startViewerQRCode() - minimum required attributes not set, use scene-id as a minimum");
+        }
+        const opt = options || this._GetDefaultQROptions();
+        const viewer = document.createElement("plattar-qrcode");
+        this._element = viewer;
+        // required attributes with defaults for plattar-viewer node
+        const width = this.getAttribute("width") || "500px";
+        const height = this.getAttribute("height") || "500px";
+        viewer.setAttribute("width", width);
+        viewer.setAttribute("height", height);
+        if (opt.color) {
+            viewer.setAttribute("color", opt.color);
+        }
+        if (opt.margin) {
+            viewer.setAttribute("margin", "" + opt.margin);
+        }
+        if (opt.qrType) {
+            viewer.setAttribute("qr-type", opt.qrType);
+        }
+        viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
+        const dst = plattar_api_1.Server.location().base + "renderer/gallery.html?scene_id=" + sceneID;
+        viewer.setAttribute("url", opt.url || dst);
+        this._state = plattar_controller_1.ControllerState.QRCode;
+        this._prevQROpt = opt;
+        return new Promise((accept, reject) => {
+            viewer.onload = () => {
+                return accept(viewer);
+            };
+            this.append(viewer);
+        });
+    }
+    async startRenderer() {
+        // remove the old renderer instance if any
+        this.removeRenderer();
+        const sceneID = this.getAttribute("scene-id");
+        if (!sceneID) {
+            throw new Error("GalleryController.startRenderer() - minimum required attributes not set, use scene-id as a minimum");
+        }
+        this._state = plattar_controller_1.ControllerState.Renderer;
+        // required attributes with defaults for plattar-configurator node
+        const width = this.getAttribute("width") || "500px";
+        const height = this.getAttribute("height") || "500px";
+        const server = this.getAttribute("server") || "production";
+        const viewer = document.createElement("plattar-gallery");
+        this._element = viewer;
+        viewer.setAttribute("width", width);
+        viewer.setAttribute("height", height);
+        viewer.setAttribute("server", server);
+        viewer.setAttribute("scene-id", sceneID);
+        return new Promise((accept, reject) => {
+            this.append(viewer);
+            return accept(viewer);
+        });
+    }
+    async initAR() {
+        throw new Error("GalleryController.initAR() - cannot proceed as AR not available in gallery context");
+    }
+    get element() {
+        return this._element;
+    }
+}
+exports.GalleryController = GalleryController;

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

@@ -0,0 +1,24 @@
+import { LauncherAR } from "../../ar/launcher-ar";
+import { DecodedConfiguratorState } from "../../util/configurator-state";
+import { PlattarController } from "./plattar-controller";
+/**
+ * Manages an instance of the <plattar-configurator> HTML Element
+ */
+export declare class LauncherController 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>;
+    /**
+     * Private Function - This launches the Static/Inherited AR Mode
+     */
+    private _InitARInherited;
+    /**
+     * Private Function - This launches the Dynamic/Generated AR Mode
+     */
+    private _InitARGenerated;
+    get element(): HTMLElement | null;
+}

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

@@ -0,0 +1,208 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LauncherController = void 0;
+const scene_product_ar_1 = require("../../ar/scene-product-ar");
+const util_1 = require("../../util/util");
+const plattar_controller_1 = require("./plattar-controller");
+const configurator_ar_1 = require("../../ar/configurator-ar");
+/**
+ * Manages an instance of the <plattar-configurator> HTML Element
+ */
+class LauncherController extends plattar_controller_1.PlattarController {
+    constructor() {
+        super(...arguments);
+        this._cachedConfigState = null;
+    }
+    async getConfiguratorState() {
+        if (this._cachedConfigState) {
+            return this._cachedConfigState;
+        }
+        this._cachedConfigState = this.createConfiguratorState();
+        return this._cachedConfigState;
+    }
+    async onAttributesUpdated(attributeName) {
+        const state = this._state;
+        // re-render the QR Code when attributes have changed
+        if (state === plattar_controller_1.ControllerState.QRCode) {
+            if (attributeName === "variation-id") {
+                const configState = await this.getConfiguratorState();
+                const variationIDs = this.getAttribute("variation-id");
+                const variationIDsList = variationIDs ? variationIDs.split(",") : [];
+                variationIDsList.forEach((variationID) => {
+                    configState.state.setVariationID(variationID);
+                });
+            }
+            if (attributeName === "variation-sku") {
+                const configState = await this.getConfiguratorState();
+                const variationSKUs = this.getAttribute("variation-sku");
+                const variationSKUList = variationSKUs ? variationSKUs.split(",") : [];
+                variationSKUList.forEach((variationSKU) => {
+                    configState.state.setVariationSKU(variationSKU);
+                });
+            }
+            this.startQRCode(this._prevQROpt);
+            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.removeAttribute("scene-id");
+                this.parent.unlockObserver();
+                const controller = this.parent.create();
+                if (controller) {
+                    return controller.startARQRCode(options);
+                }
+                return Promise.reject(new Error("LauncherController.startARQRCode() - legacy product transition failed"));
+            }
+        }
+        catch (_err) {
+        }
+        return super.startARQRCode(options);
+    }
+    async startViewerQRCode(options) {
+        return this.startARQRCode(options);
+    }
+    async startRenderer() {
+        // remove the old renderer instance if any
+        this.removeRenderer();
+        const sceneID = this.getAttribute("scene-id");
+        if (!sceneID) {
+            throw new Error("LauncherController.startRenderer() - minimum required attributes not set, use scene-id as a minimum");
+        }
+        // optional attributes
+        const configState = await this.getConfiguratorState();
+        this._state = plattar_controller_1.ControllerState.Renderer;
+        const qrOptions = btoa(JSON.stringify(this._GetDefaultQROptions()));
+        const embedType = this.getAttribute("embed-type");
+        const productID = this.getAttribute("product-id");
+        const sceneProductID = this.getAttribute("scene-product-id");
+        const variationID = this.getAttribute("variation-id");
+        const variationSKU = this.getAttribute("variation-sku");
+        const arMode = this.getAttribute("ar-mode");
+        const showBanner = this.getAttribute("show-ar-banner");
+        // required attributes with defaults for plattar-launcher node
+        const width = this.getAttribute("width") || "500px";
+        const height = this.getAttribute("height") || "500px";
+        const server = this.getAttribute("server") || "production";
+        const viewer = document.createElement("plattar-launcher");
+        this._element = viewer;
+        viewer.setAttribute("width", width);
+        viewer.setAttribute("height", height);
+        viewer.setAttribute("server", server);
+        viewer.setAttribute("scene-id", sceneID);
+        viewer.setAttribute("qr-options", qrOptions);
+        if (embedType) {
+            viewer.setAttribute("embed-type", embedType);
+        }
+        if (productID) {
+            viewer.setAttribute("product-id", productID);
+        }
+        if (sceneProductID) {
+            viewer.setAttribute("scene-product-id", sceneProductID);
+        }
+        if (variationID) {
+            viewer.setAttribute("variation-id", variationID);
+        }
+        if (variationSKU) {
+            viewer.setAttribute("variation-sku", variationSKU);
+        }
+        if (arMode) {
+            viewer.setAttribute("ar-mode", arMode);
+        }
+        if (showBanner) {
+            viewer.setAttribute("show-ar-banner", showBanner);
+        }
+        if (configState) {
+            const encodedState = configState.state.encode();
+            if (encodedState.length < 6000) {
+                viewer.setAttribute("config-state", encodedState);
+            }
+        }
+        return new Promise((accept, reject) => {
+            this.append(viewer);
+            if (configState) {
+                this.setupMessengerObservers(viewer, configState);
+            }
+            return accept(viewer);
+        });
+    }
+    async initAR() {
+        if (!util_1.Util.canAugment()) {
+            throw new Error("LauncherController.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.removeAttribute("scene-id");
+                this.parent.unlockObserver();
+                const controller = this.parent.create();
+                if (controller) {
+                    return controller.initAR();
+                }
+                return Promise.reject(new Error("LauncherController.initAR() - legacy product transition failed"));
+            }
+        }
+        catch (_err) {
+            // config state is not available
+        }
+        const arMode = this.getAttribute("ar-mode") || "generated";
+        switch (arMode.toLowerCase()) {
+            case "inherited":
+                return this._InitARInherited();
+            case "generated":
+            default:
+                return this._InitARGenerated();
+        }
+    }
+    /**
+     * Private Function - This launches the Static/Inherited AR Mode
+     */
+    async _InitARInherited() {
+        const sceneID = this.getAttribute("scene-id");
+        if (!sceneID) {
+            throw new Error("LauncherController.initAR() - inherited AR minimum required attributes not set, use scene-id as a minimum");
+        }
+        const state = (await this.getConfiguratorState()).state;
+        const first = state.first();
+        if (first) {
+            //const sceneProductAR: SceneProductAR = new SceneProductAR(first.scene_product_id, first.product_variation_id);
+            const sceneProductAR = new scene_product_ar_1.SceneProductAR({
+                productID: first.scene_product_id,
+                variationID: first.product_variation_id,
+                variationSKU: null,
+                useARBanner: this.getBooleanAttribute("show-ar-banner")
+            });
+            return sceneProductAR.init();
+        }
+        throw new Error("LauncherController.initAR() - invalid decoded config-state does not have any product states");
+    }
+    /**
+     * Private Function - This launches the Dynamic/Generated AR Mode
+     */
+    async _InitARGenerated() {
+        const sceneID = this.getAttribute("scene-id");
+        if (!sceneID) {
+            throw new Error("LauncherController.initAR() - generated AR minimum required attributes not set, use scene-id as a minimum");
+        }
+        const configAR = new configurator_ar_1.ConfiguratorAR({ state: await this.getConfiguratorState(), useARBanner: this.getBooleanAttribute("show-ar-banner") });
+        return configAR.init();
+    }
+    get element() {
+        return this._element;
+    }
+}
+exports.LauncherController = LauncherController;

package/dist/embed/plattar-embed.js

@@ -6,6 +6,8 @@ const vto_controller_1 = require("./controllers/vto-controller");
 const product_controller_1 = require("./controllers/product-controller");
 const util_1 = require("../util/util");
 const webxr_controller_1 = require("./controllers/webxr-controller");
+const gallery_controller_1 = require("./controllers/gallery-controller");
+const launcher_controller_1 = require("./controllers/launcher-controller");
 /**
  * This tracks the current embed type
  */
@@ -15,7 +17,9 @@ var EmbedType;
     EmbedType[EmbedType["Legacy"] = 1] = "Legacy";
     EmbedType[EmbedType["VTO"] = 2] = "VTO";
     EmbedType[EmbedType["WebXR"] = 3] = "WebXR";
-    EmbedType[EmbedType["None"] = 4] = "None";
+    EmbedType[EmbedType["Gallery"] = 4] = "Gallery";
+    EmbedType[EmbedType["Launcher"] = 5] = "Launcher";
+    EmbedType[EmbedType["None"] = 6] = "None";
 })(EmbedType || (EmbedType = {}));
 /**
  * Controls the state of the observer
@@ -158,6 +162,12 @@ class PlattarEmbed extends HTMLElement {
                 case "webxr":
                     this._currentType = EmbedType.WebXR;
                     break;
+                case "gallery":
+                    this._currentType = EmbedType.Gallery;
+                    break;
+                case "launcher":
+                    this._currentType = EmbedType.Launcher;
+                    break;
                 case "viewer":
                 case "configurator":
                 default:
@@ -189,6 +199,12 @@ class PlattarEmbed extends HTMLElement {
                 case EmbedType.WebXR:
                     this._controller = new webxr_controller_1.WebXRController(this);
                     break;
+                case EmbedType.Gallery:
+                    this._controller = new gallery_controller_1.GalleryController(this);
+                    break;
+                case EmbedType.Launcher:
+                    this._controller = new launcher_controller_1.LauncherController(this);
+                    break;
                 case EmbedType.VTO:
                     this._controller = new vto_controller_1.VTOController(this);
                     break;

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="@plattar/plattar-web" />
-/// <reference types="@plattar/plattar-qrcode" />
 export * as PlattarWeb from "@plattar/plattar-web";
 export * as PlattarQRCode from "@plattar/plattar-qrcode";
 export * as version from "./version";

package/dist/index.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.172.1";
+declare const _default: "1.178.1";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.172.1",
+  "version": "1.178.1",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -38,18 +38,18 @@
   "homepage": "https://www.plattar.com",
   "dependencies": {
     "@plattar/plattar-analytics": "^1.152.2",
-    "@plattar/plattar-api": "^1.159.1",
+    "@plattar/plattar-api": "^1.178.1",
     "@plattar/plattar-qrcode": "1.165.1",
     "@plattar/plattar-services": "^1.157.1",
-    "@plattar/plattar-web": "^1.169.1"
+    "@plattar/plattar-web": "^1.178.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.24.6",
-    "@babel/core": "^7.24.6",
-    "@babel/preset-env": "^7.24.6",
-    "browserify": "^17.0.0",
-    "typescript": "^5.4.5",
-    "uglify-js": "^3.17.4"
+    "@babel/cli": "^7.25.9",
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "browserify": "^17.0.1",
+    "typescript": "^5.7.2",
+    "uglify-js": "^3.19.3"
   },
   "publishConfig": {
     "access": "public"