@plattar/plattar-ar-adapter 1.154.1 → 1.155.1

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

@@ -0,0 +1,29 @@
+import { LauncherAR } from "./launcher-ar";
+import { DecodedConfiguratorState } from "../util/configurator-state";
+/**
+ * Performs AR functionality related to Plattar Scenes
+ */
+export declare class ConfiguratorAR extends LauncherAR {
+    private _analytics;
+    private _state;
+    private _ar;
+    constructor(state: DecodedConfiguratorState);
+    private _SetupAnalytics;
+    /**
+     * Composes a Scene into an AR Model (remote operation) that can be used to launch
+     * an AR File
+     */
+    private _Compose;
+    /**
+     * Initialise the SceneAR instance. This returns a Promise that resolves
+     * successfully if initialisation is successful, otherwise it will fail.
+     *
+     * filure can occur for a number of reasons but it generally means that AR
+     * cannot be performed.
+     */
+    init(): Promise<LauncherAR>;
+    start(): void;
+    canQuicklook(): boolean;
+    canRealityViewer(): boolean;
+    canSceneViewer(): boolean;
+}

package/dist/ar/configurator-ar.js

@@ -0,0 +1,161 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfiguratorAR = void 0;
+const plattar_analytics_1 = require("@plattar/plattar-analytics");
+const plattar_api_1 = require("@plattar/plattar-api");
+const plattar_services_1 = require("@plattar/plattar-services");
+const util_1 = require("../util/util");
+const quicklook_viewer_1 = __importDefault(require("../viewers/quicklook-viewer"));
+const reality_viewer_1 = __importDefault(require("../viewers/reality-viewer"));
+const scene_viewer_1 = __importDefault(require("../viewers/scene-viewer"));
+const launcher_ar_1 = require("./launcher-ar");
+const version_1 = __importDefault(require("../version"));
+/**
+ * Performs AR functionality related to Plattar Scenes
+ */
+class ConfiguratorAR extends launcher_ar_1.LauncherAR {
+    constructor(state) {
+        super();
+        // analytics instance
+        this._analytics = null;
+        if (!state) {
+            throw new Error("ConfiguratorAR.constructor(state) - state must be defined");
+        }
+        this._state = state;
+        this._ar = null;
+    }
+    _SetupAnalytics() {
+        const scene = this._state.scene;
+        let analytics = null;
+        // setup scene stuff (if any)
+        if (scene) {
+            analytics = new plattar_analytics_1.Analytics(scene.attributes.application_id);
+            analytics.origin = plattar_api_1.Server.location().type;
+            this._analytics = analytics;
+            analytics.data.push("type", "scene-ar");
+            analytics.data.push("sdkVersion", version_1.default);
+            analytics.data.push("sceneId", scene.id);
+            analytics.data.push("sceneTitle", scene.attributes.title);
+            const application = scene.relationships.find(plattar_api_1.Project);
+            // setup application stuff (if any)
+            if (application) {
+                analytics.data.push("applicationId", application.id);
+                analytics.data.push("applicationTitle", application.attributes.title);
+            }
+        }
+    }
+    /**
+     * Composes a Scene into an AR Model (remote operation) that can be used to launch
+     * an AR File
+     */
+    async _Compose(output) {
+        const objects = this._state.state.array();
+        if (objects.length <= 0) {
+            throw new Error("ConfiguratorAR.Compose() - cannot proceed as scene does not contain AR components");
+        }
+        // define our configurator
+        const configurator = new plattar_services_1.Configurator();
+        configurator.server = plattar_api_1.Server.location().type;
+        configurator.output = output;
+        let totalARObjectCount = 0;
+        objects.forEach((object) => {
+            if (object.meta_data.augment) {
+                if (object.meta_data.type === "scenemodel") {
+                    configurator.addModel(object.scene_product_id);
+                }
+                else {
+                    configurator.addSceneProduct(object.scene_product_id, object.product_variation_id);
+                }
+                totalARObjectCount++;
+            }
+        });
+        if (totalARObjectCount <= 0) {
+            throw new Error("ConfiguratorAR.Compose() - cannot proceed as scene does not contain any enabled AR components");
+        }
+        const results = await configurator.get();
+        return results.filename;
+    }
+    /**
+     * Initialise the SceneAR instance. This returns a Promise that resolves
+     * successfully if initialisation is successful, otherwise it will fail.
+     *
+     * filure can occur for a number of reasons but it generally means that AR
+     * cannot be performed.
+     */
+    async init() {
+        if (!util_1.Util.canAugment()) {
+            throw new Error("ConfiguratorAR.init() - cannot proceed as AR not available in context");
+        }
+        const scene = this._state.scene;
+        this._SetupAnalytics();
+        const sceneOpt = scene.attributes.custom_json || {};
+        // we need to define our AR module here
+        // we are in Safari/Quicklook mode here
+        if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
+            // we need to launch a VTO experience here
+            // VTO requires Reality Support
+            if (sceneOpt.anchor === "face") {
+                if (util_1.Util.canRealityViewer()) {
+                    const modelUrl = await this._Compose("vto");
+                    this._ar = new reality_viewer_1.default();
+                    this._ar.modelUrl = modelUrl;
+                    return this;
+                }
+                else {
+                    throw new Error("ConfiguratorAR.init() - cannot proceed as VTO AR requires Reality Viewer support");
+                }
+            }
+            // otherwise, load the USDZ stuff second if available
+            if (util_1.Util.canQuicklook()) {
+                const modelUrl = await this._Compose("usdz");
+                this._ar = new quicklook_viewer_1.default();
+                this._ar.modelUrl = modelUrl;
+                return this;
+            }
+            throw new Error("ConfiguratorAR.init() - cannot proceed as IOS device does not support AR Mode");
+        }
+        // check android
+        if (util_1.Util.canSceneViewer()) {
+            const modelUrl = await this._Compose("glb");
+            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 this;
+        }
+        // otherwise, we didn't have AR available - it should never really reach this stage as this should be caught
+        // earlier in the process
+        throw new Error("ConfiguratorAR.init() - could not initialise AR correctly, check values");
+    }
+    start() {
+        if (!this._ar) {
+            throw new Error("SceneAR.start() - cannot proceed as AR instance is null");
+        }
+        const analytics = this._analytics;
+        if (analytics) {
+            analytics.data.push("device", this._ar.device);
+            analytics.data.push("eventCategory", this._ar.nodeType);
+            analytics.data.push("eventAction", "Start Scene Augment");
+            analytics.write();
+            analytics.startRecordEngagement();
+        }
+        // this was initialised via the init() function
+        this._ar.start();
+    }
+    canQuicklook() {
+        return this._ar && this._ar.nodeType === "Quick Look" ? true : false;
+    }
+    canRealityViewer() {
+        return this._ar && this._ar.nodeType === "Reality Viewer" ? true : false;
+    }
+    canSceneViewer() {
+        return this._ar && this._ar.nodeType === "Scene Viewer" ? true : false;
+    }
+}
+exports.ConfiguratorAR = ConfiguratorAR;

package/dist/ar/launcher-ar.js

@@ -11,13 +11,9 @@ class LauncherAR {
      * Initialise and launch with a single function call. this is mostly for convenience.
      * Use .init() and .start() separately for fine-grained control
      */
-    launch() {
-        return new Promise((accept, reject) => {
-            this.init().then((value) => {
-                value.start();
-                return accept();
-            }).catch(reject);
-        });
+    async launch() {
+        const value = await this.init();
+        return value.start();
     }
     /**
      * AR Options used for launching AR

package/dist/ar/model-ar.js

@@ -11,6 +11,7 @@ const quicklook_viewer_1 = __importDefault(require("../viewers/quicklook-viewer"
 const reality_viewer_1 = __importDefault(require("../viewers/reality-viewer"));
 const scene_viewer_1 = __importDefault(require("../viewers/scene-viewer"));
 const launcher_ar_1 = require("./launcher-ar");
+const version_1 = __importDefault(require("../version"));
 /**
  * Performs AT Functionality using Plattar FileModel types
  */
@@ -36,6 +37,7 @@ class ModelAR extends launcher_ar_1.LauncherAR {
             analytics = new plattar_analytics_1.Analytics(project.id);
             analytics.origin = plattar_api_1.Server.location().type;
             analytics.data.push("type", "model-ar");
+            analytics.data.push("sdkVersion", version_1.default);
             analytics.data.push("applicationId", project.id);
             analytics.data.push("applicationTitle", project.attributes.title);
             analytics.data.push("modelId", model.id);

package/dist/ar/product-ar.js

@@ -11,6 +11,7 @@ const quicklook_viewer_1 = __importDefault(require("../viewers/quicklook-viewer"
 const reality_viewer_1 = __importDefault(require("../viewers/reality-viewer"));
 const scene_viewer_1 = __importDefault(require("../viewers/scene-viewer"));
 const launcher_ar_1 = require("./launcher-ar");
+const version_1 = __importDefault(require("../version"));
 /**
  * Performs AR functionality related to Plattar Products and Variation types
  */
@@ -45,6 +46,7 @@ class ProductAR extends launcher_ar_1.LauncherAR {
             analytics.origin = plattar_api_1.Server.location().type;
             this._analytics = analytics;
             analytics.data.push("type", "product-ar");
+            analytics.data.push("sdkVersion", version_1.default);
             analytics.data.push("sceneId", scene.id);
             analytics.data.push("sceneTitle", scene.attributes.title);
             const application = scene.relationships.find(plattar_api_1.Project);

package/dist/ar/raw-ar.js

@@ -11,6 +11,7 @@ const quicklook_viewer_1 = __importDefault(require("../viewers/quicklook-viewer"
 const reality_viewer_1 = __importDefault(require("../viewers/reality-viewer"));
 const scene_viewer_1 = __importDefault(require("../viewers/scene-viewer"));
 const launcher_ar_1 = require("./launcher-ar");
+const version_1 = __importDefault(require("../version"));
 /**
  * Allows launching AR Experiences provided a single remote 3D Model file
  */
@@ -48,6 +49,7 @@ class RawAR extends launcher_ar_1.LauncherAR {
                 analytics.origin = plattar_api_1.Server.location().type;
                 this._analytics = analytics;
                 analytics.data.push("type", "scene-ar");
+                analytics.data.push("sdkVersion", version_1.default);
                 analytics.data.push("sceneId", scene.id);
                 analytics.data.push("sceneTitle", scene.attributes.title);
                 const application = scene.relationships.find(plattar_api_1.Project);

package/dist/ar/scene-ar.js

@@ -12,6 +12,7 @@ const quicklook_viewer_1 = __importDefault(require("../viewers/quicklook-viewer"
 const reality_viewer_1 = __importDefault(require("../viewers/reality-viewer"));
 const scene_viewer_1 = __importDefault(require("../viewers/scene-viewer"));
 const launcher_ar_1 = require("./launcher-ar");
+const version_1 = __importDefault(require("../version"));
 /**
  * Performs AR functionality related to Plattar Scenes
  */
@@ -38,6 +39,7 @@ class SceneAR extends launcher_ar_1.LauncherAR {
             analytics.origin = plattar_api_1.Server.location().type;
             this._analytics = analytics;
             analytics.data.push("type", "scene-ar");
+            analytics.data.push("sdkVersion", version_1.default);
             analytics.data.push("sceneId", scene.id);
             analytics.data.push("sceneTitle", scene.attributes.title);
             const application = scene.relationships.find(plattar_api_1.Project);

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

@@ -1,11 +1,13 @@
 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 ConfiguratorController extends PlattarController {
-    constructor(parent: HTMLElement);
-    onAttributesUpdated(): void;
+    private _cachedConfigState;
+    getConfiguratorState(): Promise<DecodedConfiguratorState>;
+    onAttributesUpdated(attributeName: string): Promise<void>;
     startViewerQRCode(options: any): Promise<HTMLElement>;
     startRenderer(): Promise<HTMLElement>;
     initAR(): Promise<LauncherAR>;