@plattar/plattar-ar-adapter 1.123.1 → 1.123.2

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

@@ -1,6 +1,13 @@
 export declare abstract class LauncherAR {
     constructor();
     abstract init(): Promise<LauncherAR>;
-    abstract launch(): Promise<void>;
     abstract start(): void;
+    abstract canQuicklook(): boolean;
+    abstract canRealityViewer(): boolean;
+    abstract canSceneViewer(): boolean;
+    /**
+     * Initialise and launch with a single function call. this is mostly for convenience.
+     * Use .init() and .start() separately for fine-grained control
+     */
+    launch(): Promise<void>;
 }

package/dist/ar/launcher-ar.js

@@ -3,5 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LauncherAR = void 0;
 class LauncherAR {
     constructor() { }
+    /**
+     * 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);
+        });
+    }
 }
 exports.LauncherAR = LauncherAR;

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

@@ -17,11 +17,6 @@ export declare class ModelAR extends LauncherAR {
      * cannot be performed.
      */
     init(): Promise<LauncherAR>;
-    /**
-     * Initialise and launch with a single function call. this is mostly for convenience.
-     * Use .init() and .start() separately for fine-grained control
-     */
-    launch(): Promise<void>;
     /**
      * Launches the internal AR instance using an appropriate version of AR Viewers
      */

package/dist/ar/model-ar.js

@@ -35,6 +35,7 @@ class ModelAR extends launcher_ar_1.LauncherAR {
         if (project) {
             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("applicationId", project.id);
             analytics.data.push("applicationTitle", project.attributes.title);
             analytics.data.push("modelId", model.id);
@@ -89,18 +90,6 @@ class ModelAR extends launcher_ar_1.LauncherAR {
             }).catch(reject);
         });
     }
-    /**
-     * 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);
-        });
-    }
     /**
      * Launches the internal AR instance using an appropriate version of AR Viewers
      */

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

@@ -10,7 +10,7 @@ export declare class ProductAR extends LauncherAR {
     constructor(productID?: string | undefined | null, variationID?: string | undefined | null);
     get productID(): string;
     get variationID(): string;
-    private _setupAnalytics;
+    private _SetupAnalytics;
     /**
      * Initialise the ProductAR instance. This returns a Promise that resolves
      * successfully if initialisation is successful, otherwise it will fail.
@@ -19,11 +19,6 @@ export declare class ProductAR extends LauncherAR {
      * cannot be performed.
      */
     init(): Promise<LauncherAR>;
-    /**
-     * Initialise and launch with a single function call. this is mostly for convenience.
-     * Use .init() and .start() separately for fine-grained control
-     */
-    launch(): Promise<void>;
     /**
      * Launches the internal AR instance using an appropriate version of AR Viewers
      */

package/dist/ar/product-ar.js

@@ -32,7 +32,7 @@ class ProductAR extends launcher_ar_1.LauncherAR {
     get variationID() {
         return this._variationID;
     }
-    _setupAnalytics(product, variation) {
+    _SetupAnalytics(product, variation) {
         let analytics = null;
         const scene = product.relationships.find(plattar_api_1.Scene);
         // setup scene stuff (if any)
@@ -40,6 +40,7 @@ class ProductAR extends launcher_ar_1.LauncherAR {
             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", "product-ar");
             analytics.data.push("sceneId", scene.id);
             analytics.data.push("sceneTitle", scene.attributes.title);
             const application = scene.relationships.find(plattar_api_1.Project);
@@ -100,7 +101,7 @@ class ProductAR extends launcher_ar_1.LauncherAR {
                 if (!model) {
                     return reject(new Error("ProductAR.init() - cannot proceed as ModelFile for selected variation is corrupt"));
                 }
-                this._setupAnalytics(product, variation);
+                this._SetupAnalytics(product, variation);
                 // we need to define our AR module here
                 // we are in Safari/Quicklook mode here
                 if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
@@ -131,18 +132,6 @@ class ProductAR extends launcher_ar_1.LauncherAR {
             }).catch(reject);
         });
     }
-    /**
-     * 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);
-        });
-    }
     /**
      * Launches the internal AR instance using an appropriate version of AR Viewers
      */

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

@@ -15,11 +15,6 @@ export declare class RawAR extends LauncherAR {
      * cannot be performed.
      */
     init(): Promise<LauncherAR>;
-    /**
-     * Initialise and launch with a single function call. this is mostly for convenience.
-     * Use .init() and .start() separately for fine-grained control
-     */
-    launch(): Promise<void>;
     /**
      * Launches the internal AR instance using an appropriate version of AR Viewers
      */

package/dist/ar/raw-ar.js

@@ -75,18 +75,6 @@ class RawAR extends launcher_ar_1.LauncherAR {
             return reject(new Error("RawAR.init() - could not initialise AR correctly, check values"));
         });
     }
-    /**
-     * 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);
-        });
-    }
     /**
      * Launches the internal AR instance using an appropriate version of AR Viewers
      */

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

@@ -3,7 +3,27 @@ import { LauncherAR } from "./launcher-ar";
  * Performs AR functionality related to Plattar Scenes
  */
 export declare class SceneAR extends LauncherAR {
+    private _analytics;
+    private readonly _sceneID;
+    private _ar;
+    constructor(sceneID?: string | undefined | null);
+    get sceneID(): string;
+    private _SetupAnalytics;
+    /**
+     * Composes a Scene into an AR Model (remote operation) that can be used to launch
+     * an AR File
+     */
+    private _ComposeScene;
+    /**
+     * 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>;
-    launch(): Promise<void>;
     start(): void;
+    canQuicklook(): boolean;
+    canRealityViewer(): boolean;
+    canSceneViewer(): boolean;
 }

package/dist/ar/scene-ar.js

@@ -1,19 +1,162 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SceneAR = 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");
 /**
  * Performs AR functionality related to Plattar Scenes
  */
 class SceneAR extends launcher_ar_1.LauncherAR {
-    init() {
-        throw new Error("Method not implemented.");
+    constructor(sceneID = null) {
+        super();
+        // analytics instance
+        this._analytics = null;
+        if (!sceneID) {
+            throw new Error("SceneAR.constructor(sceneID) - sceneID must be defined");
+        }
+        this._sceneID = sceneID;
+        this._ar = null;
+    }
+    get sceneID() {
+        return this._sceneID;
+    }
+    _SetupAnalytics(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("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
+     */
+    _ComposeScene(scene, output) {
+        return new Promise((accept, reject) => {
+            const sceneProducts = scene.relationships.filter(plattar_api_1.SceneProduct);
+            // nothing to do if no AR components can be found
+            if (sceneProducts.length <= 0) {
+                return reject(new Error("SceneAR.ComposeScene() - 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;
+            // add out scene models
+            sceneProducts.forEach((sceneProduct) => {
+                const product = sceneProduct.relationships.find(plattar_api_1.Product);
+                if (product && product.attributes.product_variation_id) {
+                    configurator.addSceneProduct(sceneProduct.id, product.attributes.product_variation_id);
+                }
+            });
+            return configurator.get().then((result) => {
+                accept(result.filename);
+            }).catch(reject);
+        });
     }
-    launch() {
-        throw new Error("Method not implemented.");
+    /**
+     * 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() {
+        return new Promise((accept, reject) => {
+            if (!util_1.Util.canAugment()) {
+                return reject(new Error("SceneAR.init() - cannot proceed as AR not available in context"));
+            }
+            const scene = new plattar_api_1.Scene(this.sceneID);
+            scene.include(plattar_api_1.Project);
+            scene.include(plattar_api_1.SceneProduct);
+            scene.include(plattar_api_1.SceneProduct.include(plattar_api_1.Product));
+            scene.get().then((scene) => {
+                this._SetupAnalytics(scene);
+                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()) {
+                            return this._ComposeScene(scene, "vto").then((modelUrl) => {
+                                this._ar = new reality_viewer_1.default();
+                                this._ar.modelUrl = modelUrl;
+                                return accept(this);
+                            }).catch(reject);
+                        }
+                        else {
+                            return reject(new Error("SceneAR.init() - cannot proceed as VTO AR requires Reality Viewer support"));
+                        }
+                    }
+                    // otherwise, load the USDZ stuff second if available
+                    if (util_1.Util.canQuicklook()) {
+                        return this._ComposeScene(scene, "usdz").then((modelUrl) => {
+                            this._ar = new quicklook_viewer_1.default();
+                            this._ar.modelUrl = modelUrl;
+                            return accept(this);
+                        }).catch(reject);
+                    }
+                    return reject(new Error("SceneAR.init() - cannot proceed as IOS device does not support AR Mode"));
+                }
+                // 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;
+                        return accept(this);
+                    }).catch(reject);
+                }
+                // otherwise, we didn't have AR available - it should never really reach this stage as this should be caught
+                // earlier in the process
+                return reject(new Error("SceneAR.init() - could not initialise AR correctly, check values"));
+            }).catch(reject);
+        });
     }
     start() {
-        throw new Error("Method not implemented.");
+        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.SceneAR = SceneAR;

package/dist/index.d.ts

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

package/dist/index.js

@@ -22,12 +22,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = exports.ProductAR = exports.ConfiguratorAR = exports.version = exports.PlattarQRCode = exports.PlattarWeb = void 0;
+exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = 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 configurator_ar_1 = require("./ar/configurator-ar");
-Object.defineProperty(exports, "ConfiguratorAR", { enumerable: true, get: function () { return configurator_ar_1.ConfiguratorAR; } });
 var product_ar_1 = require("./ar/product-ar");
 Object.defineProperty(exports, "ProductAR", { enumerable: true, get: function () { return product_ar_1.ProductAR; } });
 var scene_ar_1 = require("./ar/scene-ar");

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.123.1";
+declare const _default: "1.123.2";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.123.1",
+  "version": "1.123.2",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",

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

@@ -1,9 +0,0 @@
-import { LauncherAR } from "./launcher-ar";
-/**
- * Performs AR related to Plattar Configurator functionalities
- */
-export declare class ConfiguratorAR extends LauncherAR {
-    init(): Promise<LauncherAR>;
-    launch(): Promise<void>;
-    start(): void;
-}

package/dist/ar/configurator-ar.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfiguratorAR = void 0;
-const launcher_ar_1 = require("./launcher-ar");
-/**
- * Performs AR related to Plattar Configurator functionalities
- */
-class ConfiguratorAR extends launcher_ar_1.LauncherAR {
-    init() {
-        throw new Error("Method not implemented.");
-    }
-    launch() {
-        throw new Error("Method not implemented.");
-    }
-    start() {
-        throw new Error("Method not implemented.");
-    }
-}
-exports.ConfiguratorAR = ConfiguratorAR;