@plattar/plattar-ar-adapter 1.128.1 → 1.130.2

package/dist/ar/launcher-ar.d.ts

@@ -1,4 +1,8 @@
+export interface LauncherAROptions {
+    anchor: "horizontal" | "vertical" | "vto" | "horizontal_vertical";
+}
 export declare abstract class LauncherAR {
+    private readonly _opt;
     constructor();
     abstract init(): Promise<LauncherAR>;
     abstract start(): void;
@@ -10,4 +14,8 @@ export declare abstract class LauncherAR {
      * Use .init() and .start() separately for fine-grained control
      */
     launch(): Promise<void>;
+    /**
+     * AR Options used for launching AR
+     */
+    get options(): LauncherAROptions;
 }

package/dist/ar/launcher-ar.js

@@ -2,7 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LauncherAR = void 0;
 class LauncherAR {
-    constructor() { }
+    constructor() {
+        this._opt = {
+            anchor: "horizontal_vertical"
+        };
+    }
     /**
      * Initialise and launch with a single function call. this is mostly for convenience.
      * Use .init() and .start() separately for fine-grained control
@@ -15,5 +19,11 @@ class LauncherAR {
             }).catch(reject);
         });
     }
+    /**
+     * AR Options used for launching AR
+     */
+    get options() {
+        return this._opt;
+    }
 }
 exports.LauncherAR = LauncherAR;

package/dist/ar/model-ar.js

@@ -80,8 +80,10 @@ class ModelAR extends launcher_ar_1.LauncherAR {
                 }
                 // check android
                 if (util_1.Util.canSceneViewer()) {
-                    this._ar = new scene_viewer_1.default();
-                    this._ar.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.original_filename;
+                    const arviewer = new scene_viewer_1.default();
+                    arviewer.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.original_filename;
+                    arviewer.isVertical = this.options.anchor === "vertical" ? true : false;
+                    this._ar = arviewer;
                     return accept(this);
                 }
                 // otherwise, we didn't have AR available - it should never really reach this stage as this should be caught

package/dist/ar/product-ar.js

@@ -122,8 +122,17 @@ class ProductAR extends launcher_ar_1.LauncherAR {
                 }
                 // check android
                 if (util_1.Util.canSceneViewer()) {
-                    this._ar = new scene_viewer_1.default();
-                    this._ar.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.original_filename;
+                    const arviewer = new scene_viewer_1.default();
+                    arviewer.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.original_filename;
+                    arviewer.isVertical = this.options.anchor === "vertical" ? true : false;
+                    const scene = product.relationships.find(plattar_api_1.Scene);
+                    if (scene) {
+                        const sceneOpt = scene.attributes.custom_json || {};
+                        if (sceneOpt.anchor === "vertical") {
+                            arviewer.isVertical = true;
+                        }
+                    }
+                    this._ar = arviewer;
                     return accept(this);
                 }
                 // otherwise, we didn't have AR available - it should never really reach this stage as this should be caught

package/dist/ar/raw-ar.js

@@ -64,8 +64,10 @@ class RawAR extends launcher_ar_1.LauncherAR {
             // check android
             if (util_1.Util.canSceneViewer()) {
                 if (lowerLoc.endsWith("glb") || lowerLoc.endsWith("gltf")) {
-                    this._ar = new scene_viewer_1.default();
-                    this._ar.modelUrl = modelLocation;
+                    const arviewer = new scene_viewer_1.default();
+                    arviewer.modelUrl = modelLocation;
+                    arviewer.isVertical = this.options.anchor === "vertical" ? true : false;
+                    this._ar = arviewer;
                     return accept(this);
                 }
                 return reject(new Error("RawAR.init() - cannot proceed as model is not a .glb or .gltf file"));

package/dist/ar/scene-ar.js

@@ -123,8 +123,13 @@ class SceneAR extends launcher_ar_1.LauncherAR {
                 // check android
                 if (util_1.Util.canSceneViewer()) {
                     return this._ComposeScene(scene, "glb").then((modelUrl) => {
-                        this._ar = new scene_viewer_1.default();
-                        this._ar.modelUrl = modelUrl;
+                        const arviewer = new scene_viewer_1.default();
+                        arviewer.modelUrl = modelUrl;
+                        arviewer.isVertical = this.options.anchor === "vertical" ? true : false;
+                        if (sceneOpt.anchor === "vertical") {
+                            arviewer.isVertical = true;
+                        }
+                        this._ar = arviewer;
                         return accept(this);
                     }).catch(reject);
                 }

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();

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

@@ -3,8 +3,8 @@ 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_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");
 /**
@@ -13,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;
@@ -37,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();
@@ -145,16 +142,11 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 return product.init().then(accept).catch(reject);
             }
             const sceneID = this.getAttribute("scene-id");
-            // use the first default product-variation id if available
+            // fallback to using default SceneAR implementation
             if (sceneID) {
-                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);
+                const sceneAR = new scene_ar_1.SceneAR(sceneID);
+                sceneAR.init().then(accept).catch(reject);
+                return;
             }
             return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
         });

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

@@ -1,6 +1,8 @@
 export * as PlattarWeb from "@plattar/plattar-web";
 export * as PlattarQRCode from "@plattar/plattar-qrcode";
 export * as version from "./version";
+export { LauncherAR } from "./ar/launcher-ar";
+export { LauncherAROptions } from "./ar/launcher-ar";
 export { ProductAR } from "./ar/product-ar";
 export { SceneProductAR } from "./ar/scene-product-ar";
 export { SceneAR } from "./ar/scene-ar";

package/dist/index.js

@@ -26,10 +26,12 @@ 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.SceneProductAR = 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.LauncherAR = 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 launcher_ar_1 = require("./ar/launcher-ar");
+Object.defineProperty(exports, "LauncherAR", { enumerable: true, get: function () { return launcher_ar_1.LauncherAR; } });
 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");

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.128.1";
+declare const _default: "1.130.2";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.128.1",
+  "version": "1.130.2",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -41,15 +41,15 @@
     "@plattar/plattar-api": "^1.120.1",
     "@plattar/plattar-qrcode": "1.122.1",
     "@plattar/plattar-services": "^1.120.1",
-    "@plattar/plattar-web": "^1.128.1"
+    "@plattar/plattar-web": "^1.129.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.6",
-    "@babel/core": "^7.17.9",
-    "@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.6.3",
-    "uglify-js": "^3.15.4"
+    "typescript": "^4.6.4",
+    "uglify-js": "^3.15.5"
   },
   "publishConfig": {
     "access": "public"