@plattar/plattar-ar-adapter 1.120.1 → 1.120.2

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

@@ -0,0 +1,32 @@
+import { LauncherAR } from "./launcher-ar";
+/**
+ * Performs AT Functionality using Plattar FileModel types
+ */
+export declare class ModelAR extends LauncherAR {
+    private _analytics;
+    private readonly _modelID;
+    private _ar;
+    constructor(modelID?: string | undefined | null);
+    get modelID(): string;
+    private _SetupAnalytics;
+    /**
+     * Initialise the ModelAR 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>;
+    /**
+     * 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
+     */
+    start(): void;
+    canQuicklook(): boolean;
+    canRealityViewer(): boolean;
+    canSceneViewer(): boolean;
+}

package/dist/ar/model-ar.js

@@ -0,0 +1,132 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelAR = void 0;
+const plattar_api_1 = require("@plattar/plattar-api");
+const plattar_analytics_1 = require("@plattar/plattar-analytics");
+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 AT Functionality using Plattar FileModel types
+ */
+class ModelAR extends launcher_ar_1.LauncherAR {
+    constructor(modelID = null) {
+        super();
+        // analytics instance
+        this._analytics = null;
+        if (!modelID) {
+            throw new Error("ModelAR.constructor(modelID) - modelID must be defined");
+        }
+        this._modelID = modelID;
+        this._ar = null;
+    }
+    get modelID() {
+        return this._modelID;
+    }
+    _SetupAnalytics(model) {
+        let analytics = null;
+        const project = model.relationships.find(plattar_api_1.Project);
+        // setup scene stuff (if any)
+        if (project) {
+            analytics = new plattar_analytics_1.Analytics(project.id);
+            analytics.origin = plattar_api_1.Server.location().type;
+            analytics.data.push("applicationId", project.id);
+            analytics.data.push("applicationTitle", project.attributes.title);
+            analytics.data.push("modelId", model.id);
+            analytics.data.push("modelTitle", model.attributes.title);
+            this._analytics = analytics;
+        }
+    }
+    /**
+     * Initialise the ModelAR 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("ModelAR.init() - cannot proceed as AR not available in context"));
+            }
+            const model = new plattar_api_1.FileModel(this.modelID);
+            model.include(plattar_api_1.Project);
+            model.get().then((model) => {
+                // setup the analytics data
+                this._SetupAnalytics(model);
+                // we need to define our AR module here
+                // we are in Safari/Quicklook mode here
+                if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
+                    // model needs to have either USDZ or REALITY files defined
+                    // we load REALITY stuff first if available
+                    if (model.attributes.reality_filename && util_1.Util.canRealityViewer()) {
+                        this._ar = new reality_viewer_1.default();
+                        this._ar.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.reality_filename;
+                        return accept(this);
+                    }
+                    // otherwise, load the USDZ stuff second if available
+                    if (model.attributes.usdz_filename && util_1.Util.canQuicklook()) {
+                        this._ar = new quicklook_viewer_1.default();
+                        this._ar.modelUrl = plattar_api_1.Server.location().cdn + model.attributes.path + model.attributes.usdz_filename;
+                        return accept(this);
+                    }
+                    return reject(new Error("ModelAR.init() - cannot proceed as ModelFile does not have a defined .usdz or .reality file"));
+                }
+                // 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;
+                    return accept(this);
+                }
+                // 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("ModelAR.init() - could not initialise AR correctly, check values"));
+            }).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
+     */
+    start() {
+        if (!this._ar) {
+            throw new Error("ModelAR.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 Model 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.ModelAR = ModelAR;

package/dist/index.d.ts

@@ -4,4 +4,5 @@ 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";
 export { Util } from "./util/util";

package/dist/index.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Util = exports.SceneAR = exports.ProductAR = exports.ConfiguratorAR = exports.version = exports.PlattarQRCode = exports.PlattarWeb = void 0;
+exports.Util = exports.ModelAR = exports.SceneAR = exports.ProductAR = exports.ConfiguratorAR = 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"));
@@ -32,6 +32,8 @@ 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");
 Object.defineProperty(exports, "SceneAR", { enumerable: true, get: function () { return scene_ar_1.SceneAR; } });
+var model_ar_1 = require("./ar/model-ar");
+Object.defineProperty(exports, "ModelAR", { enumerable: true, get: function () { return model_ar_1.ModelAR; } });
 var util_1 = require("./util/util");
 Object.defineProperty(exports, "Util", { enumerable: true, get: function () { return util_1.Util; } });
 const plattar_embed_1 = __importDefault(require("./embed/plattar-embed"));

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.120.1";
+declare const _default: "1.120.2";
 export default _default;

package/dist/version.js

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

package/package.json

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