@plattar/plattar-ar-adapter 1.123.7 → 1.129.1

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

@@ -4,12 +4,9 @@ import { PlattarController } from "./plattar-controller";
  * Manages an instance of the <plattar-configurator> HTML Element
  */
 export declare class ConfiguratorController extends PlattarController {
-    private _state;
-    private _element;
-    private _prevQROpt;
     constructor(parent: HTMLElement);
     onAttributesUpdated(): void;
-    startQRCode(options: any): Promise<HTMLElement>;
+    startViewerQRCode(options: any): Promise<HTMLElement>;
     startRenderer(): Promise<HTMLElement>;
     initAR(): Promise<LauncherAR>;
     /**

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

@@ -15,9 +15,6 @@ const plattar_controller_1 = require("./plattar-controller");
 class ConfiguratorController extends plattar_controller_1.PlattarController {
     constructor(parent) {
         super(parent);
-        this._state = plattar_controller_1.ControllerState.None;
-        this._element = null;
-        this._prevQROpt = null;
     }
     onAttributesUpdated() {
         const state = this._state;
@@ -27,7 +24,7 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
             return;
         }
     }
-    startQRCode(options) {
+    startViewerQRCode(options) {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();

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

@@ -13,17 +13,15 @@ export declare abstract class PlattarController {
      */
     static get DEFAULT_QR_OPTIONS(): any;
     private readonly _parent;
+    protected _state: ControllerState;
+    protected _element: HTMLElement | null;
+    protected _prevQROpt: any;
     constructor(parent: HTMLElement);
     /**
      * Called by the parent when a HTML Attribute has changed and the controller
      * requires an update
      */
     abstract onAttributesUpdated(): void;
-    /**
-     * Start Rendering a QR Code with the provided options
-     * @param options (optional) - The QR Code Options
-     */
-    abstract startQRCode(options: any | undefined | null): Promise<HTMLElement>;
     /**
      * Start the underlying Plattar Renderer for this Controller
      */
@@ -32,6 +30,23 @@ export declare abstract class PlattarController {
      * Initialise and start AR mode if available
      */
     startAR(): Promise<void>;
+    /**
+     * Start Rendering a QR Code with the provided options
+     * @param options (optional) - The QR Code Options
+     */
+    abstract startViewerQRCode(options: any | undefined | null): Promise<HTMLElement>;
+    /**
+     * Decide which QR Code to render according to the qr-type attribute
+     * @param options
+     * @returns
+     */
+    startQRCode(options: any): Promise<HTMLElement>;
+    /**
+     * Displays a QR Code that sends the user direct to AR
+     * @param options
+     * @returns
+     */
+    startARQRCode(options: any): Promise<HTMLElement>;
     /**
      * Initialise and return a launcher that can be used to start AR
      */

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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlattarController = exports.ControllerState = void 0;
+const plattar_api_1 = require("@plattar/plattar-api");
 var ControllerState;
 (function (ControllerState) {
     ControllerState[ControllerState["None"] = 0] = "None";
@@ -12,6 +13,9 @@ var ControllerState;
  */
 class PlattarController {
     constructor(parent) {
+        this._state = ControllerState.None;
+        this._element = null;
+        this._prevQROpt = null;
         this._parent = parent;
     }
     /**
@@ -36,6 +40,86 @@ class PlattarController {
             }).catch(reject);
         });
     }
+    /**
+     * Decide which QR Code to render according to the qr-type attribute
+     * @param options
+     * @returns
+     */
+    startQRCode(options) {
+        const qrType = this.getAttribute("qr-type") || "viewer";
+        switch (qrType.toLowerCase()) {
+            case "ar":
+                return this.startARQRCode(options);
+            case "viewer":
+            default:
+                return this.startViewerQRCode(options);
+        }
+    }
+    /**
+     * Displays a QR Code that sends the user direct to AR
+     * @param options
+     * @returns
+     */
+    startARQRCode(options) {
+        return new Promise((accept, reject) => {
+            // remove the old renderer instance if any
+            this.removeRenderer();
+            const opt = options || PlattarController.DEFAULT_QR_OPTIONS;
+            const viewer = document.createElement("plattar-qrcode");
+            // 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);
+            }
+            const qrOptions = btoa(JSON.stringify(opt));
+            let dst = plattar_api_1.Server.location().base + "renderer/launcher.html?qr_options=" + qrOptions;
+            const sceneID = this.getAttribute("scene-id");
+            const configState = this.getAttribute("config-state");
+            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 arMode = this.getAttribute("ar-mode");
+            if (configState) {
+                dst += "&config_state=" + configState;
+            }
+            if (embedType) {
+                dst += "&embed_type=" + embedType;
+            }
+            if (productID) {
+                dst += "&product_id=" + productID;
+            }
+            if (sceneProductID) {
+                dst += "&scene_product_id=" + sceneProductID;
+            }
+            if (variationID) {
+                dst += "&variation_id=" + variationID;
+            }
+            if (arMode) {
+                dst += "&ar_mode=" + arMode;
+            }
+            if (sceneID) {
+                dst += "&scene_id=" + sceneID;
+            }
+            viewer.setAttribute("url", opt.url || dst);
+            viewer.onload = () => {
+                return accept(viewer);
+            };
+            this._element = viewer;
+            this._state = ControllerState.QRCode;
+            this._prevQROpt = opt;
+            this.append(viewer);
+        });
+    }
     /**
      * Returns the Parent Instance
      */

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

@@ -4,12 +4,9 @@ import { PlattarController } from "./plattar-controller";
  * Manages an instance of the <plattar-product> HTML Element
  */
 export declare class ProductController extends PlattarController {
-    private _state;
-    private _element;
-    private _prevQROpt;
     constructor(parent: HTMLElement);
     onAttributesUpdated(): void;
-    startQRCode(options: any): Promise<HTMLElement>;
+    startViewerQRCode(options: any): Promise<HTMLElement>;
     startRenderer(): Promise<HTMLElement>;
     initAR(): Promise<LauncherAR>;
     removeRenderer(): boolean;

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

@@ -11,9 +11,6 @@ const plattar_controller_1 = require("./plattar-controller");
 class ProductController extends plattar_controller_1.PlattarController {
     constructor(parent) {
         super(parent);
-        this._state = plattar_controller_1.ControllerState.None;
-        this._element = null;
-        this._prevQROpt = null;
     }
     onAttributesUpdated() {
         const state = this._state;
@@ -34,7 +31,7 @@ class ProductController extends plattar_controller_1.PlattarController {
             return;
         }
     }
-    startQRCode(options) {
+    startViewerQRCode(options) {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();
@@ -58,10 +55,14 @@ class ProductController extends plattar_controller_1.PlattarController {
                 }
                 // optional attributes
                 const variationID = this.getAttribute("variation-id");
+                const showAR = this.getAttribute("show-ar");
                 let dst = plattar_api_1.Server.location().base + "renderer/product.html?product_id=" + productID;
                 if (variationID) {
                     dst += "&variation_id=" + variationID;
                 }
+                if (showAR) {
+                    dst += "&show_ar=" + showAR;
+                }
                 viewer.setAttribute("url", opt.url || dst);
                 viewer.onload = () => {
                     return accept(viewer);
@@ -92,9 +93,13 @@ class ProductController extends plattar_controller_1.PlattarController {
                 viewer.setAttribute("product-id", productID);
                 // optional attributes
                 const variationID = this.getAttribute("variation-id");
+                const showAR = this.getAttribute("show-ar");
                 if (variationID) {
                     viewer.setAttribute("variation-id", variationID);
                 }
+                if (showAR) {
+                    viewer.setAttribute("show-ar", showAR);
+                }
                 viewer.onload = () => {
                     return accept(viewer);
                 };

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

@@ -4,12 +4,9 @@ import { PlattarController } from "./plattar-controller";
  * Manages an instance of the <plattar-viewer> HTML Element
  */
 export declare class ViewerController extends PlattarController {
-    private _state;
-    private _element;
-    private _prevQROpt;
     constructor(parent: HTMLElement);
     onAttributesUpdated(): void;
-    startQRCode(options: any): Promise<HTMLElement>;
+    startViewerQRCode(options: any): Promise<HTMLElement>;
     startRenderer(): Promise<HTMLElement>;
     initAR(): Promise<LauncherAR>;
     removeRenderer(): boolean;

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

@@ -4,6 +4,7 @@ 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 configurator_state_1 = require("../../util/configurator-state");
 const util_1 = require("../../util/util");
 const plattar_controller_1 = require("./plattar-controller");
 /**
@@ -12,9 +13,6 @@ const plattar_controller_1 = require("./plattar-controller");
 class ViewerController extends plattar_controller_1.PlattarController {
     constructor(parent) {
         super(parent);
-        this._state = plattar_controller_1.ControllerState.None;
-        this._element = null;
-        this._prevQROpt = null;
     }
     onAttributesUpdated() {
         const state = this._state;
@@ -36,7 +34,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
             return;
         }
     }
-    startQRCode(options) {
+    startViewerQRCode(options) {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();
@@ -62,12 +60,16 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 // optional attributes
                 const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
+                const showAR = this.getAttribute("show-ar");
                 if (productID) {
                     dst += "&productId=" + productID;
                 }
                 if (variationID) {
                     dst += "&variationId=" + variationID;
                 }
+                if (showAR) {
+                    dst += "&show_ar=" + showAR;
+                }
                 viewer.setAttribute("url", opt.url || dst);
                 viewer.onload = () => {
                     return accept(viewer);
@@ -99,12 +101,16 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 // optional attributes
                 const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
+                const showAR = this.getAttribute("show-ar");
                 if (productID) {
                     viewer.setAttribute("product-id", productID);
                 }
                 if (variationID) {
                     viewer.setAttribute("variation-id", variationID);
                 }
+                if (showAR) {
+                    viewer.setAttribute("show-ar", showAR);
+                }
                 viewer.onload = () => {
                     return accept(viewer);
                 };
@@ -136,11 +142,18 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 return product.init().then(accept).catch(reject);
             }
             const sceneID = this.getAttribute("scene-id");
-            // otherwise, scene was set so use SceneAR
+            // use the first default product-variation id if available
             if (sceneID) {
-                return reject(new Error("ViewerController.initAR() - AR mode for scene-id not yet supported, use product-id or scene-product-id"));
+                return 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 reject(new Error("ViewerController.initAR() - your scene does not contain any valid products"));
+                }).catch(reject);
             }
-            return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use product-id or scene-product-id as a minimum"));
+            return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
         });
     }
     removeRenderer() {

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

@@ -4,12 +4,9 @@ import { PlattarController } from "./plattar-controller";
  * Manages an instance of the <plattar-configurator> HTML Element
  */
 export declare class VTOController extends PlattarController {
-    private _state;
-    private _element;
-    private _prevQROpt;
     constructor(parent: HTMLElement);
     onAttributesUpdated(): void;
-    startQRCode(options: any): Promise<HTMLElement>;
+    startViewerQRCode(options: any): Promise<HTMLElement>;
     startRenderer(): Promise<HTMLElement>;
     initAR(): Promise<LauncherAR>;
     /**

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

@@ -13,9 +13,6 @@ const plattar_controller_1 = require("./plattar-controller");
 class VTOController extends plattar_controller_1.PlattarController {
     constructor(parent) {
         super(parent);
-        this._state = plattar_controller_1.ControllerState.None;
-        this._element = null;
-        this._prevQROpt = null;
     }
     onAttributesUpdated() {
         const state = this._state;
@@ -25,7 +22,7 @@ class VTOController extends plattar_controller_1.PlattarController {
             return;
         }
     }
-    startQRCode(options) {
+    startViewerQRCode(options) {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/version.d.ts

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

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.123.7",
+  "version": "1.129.1",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -37,19 +37,19 @@
   },
   "homepage": "https://www.plattar.com",
   "dependencies": {
-    "@plattar/plattar-analytics": "^1.117.2",
+    "@plattar/plattar-analytics": "^1.124.1",
     "@plattar/plattar-api": "^1.120.1",
     "@plattar/plattar-qrcode": "1.122.1",
     "@plattar/plattar-services": "^1.120.1",
-    "@plattar/plattar-web": "^1.123.1"
+    "@plattar/plattar-web": "^1.128.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.3",
-    "@babel/core": "^7.17.4",
-    "@babel/preset-env": "^7.16.11",
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.17.10",
+    "@babel/preset-env": "^7.17.10",
     "browserify": "^17.0.0",
-    "typescript": "^4.5.5",
-    "uglify-js": "^3.15.1"
+    "typescript": "^4.6.4",
+    "uglify-js": "^3.15.4"
   },
   "publishConfig": {
     "access": "public"