@plattar/plattar-ar-adapter 1.136.1 → 1.138.1

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

@@ -4,9 +4,12 @@ import { LauncherAR } from "./launcher-ar";
  */
 export declare class RawAR extends LauncherAR {
     private readonly _modelLocation;
+    private readonly _sceneID;
     private _ar;
-    constructor(modelLocation?: string | undefined | null);
+    private _analytics;
+    constructor(modelLocation?: string | undefined | null, sceneID?: string | undefined | null);
     get modelLocation(): string;
+    private _SetupAnalytics;
     /**
      * Initialise the RawAR instance. This returns a Promise that resolves
      * successfully if initialisation is successful, otherwise it will fail.

package/dist/ar/raw-ar.js

@@ -4,6 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RawAR = void 0;
+const plattar_analytics_1 = require("@plattar/plattar-analytics");
+const plattar_api_1 = require("@plattar/plattar-api");
 const util_1 = require("../util/util");
 const quicklook_viewer_1 = __importDefault(require("../viewers/quicklook-viewer"));
 const reality_viewer_1 = __importDefault(require("../viewers/reality-viewer"));
@@ -13,14 +15,17 @@ const launcher_ar_1 = require("./launcher-ar");
  * Allows launching AR Experiences provided a single remote 3D Model file
  */
 class RawAR extends launcher_ar_1.LauncherAR {
-    constructor(modelLocation = null) {
+    constructor(modelLocation = null, sceneID = null) {
         super();
+        // analytics instance
+        this._analytics = null;
         if (!modelLocation) {
             throw new Error("RawAR.constructor(modelLocation) - modelLocation must be defined");
         }
         const lowerLoc = modelLocation.toLowerCase();
         if (lowerLoc.endsWith("usdz") || lowerLoc.endsWith("glb") || lowerLoc.endsWith("gltf") || lowerLoc.endsWith("reality")) {
             this._modelLocation = modelLocation;
+            this._sceneID = sceneID;
             this._ar = null;
         }
         else {
@@ -30,6 +35,33 @@ class RawAR extends launcher_ar_1.LauncherAR {
     get modelLocation() {
         return this._modelLocation;
     }
+    _SetupAnalytics() {
+        return new Promise((accept, _reject) => {
+            const sceneID = this._sceneID;
+            if (!sceneID) {
+                return accept();
+            }
+            const scene = new plattar_api_1.Scene(sceneID);
+            scene.include(plattar_api_1.Project);
+            scene.get().then((scene) => {
+                const 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);
+                }
+                accept();
+            }).catch((_err) => {
+                accept();
+            });
+        });
+    }
     /**
      * Initialise the RawAR instance. This returns a Promise that resolves
      * successfully if initialisation is successful, otherwise it will fail.
@@ -42,39 +74,42 @@ class RawAR extends launcher_ar_1.LauncherAR {
             if (!util_1.Util.canAugment()) {
                 return reject(new Error("RawAR.init() - cannot proceed as AR not available in context"));
             }
-            const modelLocation = this._modelLocation;
-            const lowerLoc = modelLocation.toLowerCase();
-            // we need to define our AR module here
-            // we are in Safari/Quicklook mode here
-            if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
-                // load the reality experience if dealing with reality file
-                if (lowerLoc.endsWith("reality") && util_1.Util.canRealityViewer()) {
-                    this._ar = new reality_viewer_1.default();
-                    this._ar.modelUrl = modelLocation;
-                    return accept(this);
+            // send the analytics (if any)
+            this._SetupAnalytics().then(() => {
+                const modelLocation = this._modelLocation;
+                const lowerLoc = modelLocation.toLowerCase();
+                // we need to define our AR module here
+                // we are in Safari/Quicklook mode here
+                if (util_1.Util.isSafari() || util_1.Util.isChromeOnIOS()) {
+                    // load the reality experience if dealing with reality file
+                    if (lowerLoc.endsWith("reality") && util_1.Util.canRealityViewer()) {
+                        this._ar = new reality_viewer_1.default();
+                        this._ar.modelUrl = modelLocation;
+                        return accept(this);
+                    }
+                    // load the usdz experience if dealing with usdz file
+                    if (lowerLoc.endsWith("usdz") && util_1.Util.canQuicklook()) {
+                        this._ar = new quicklook_viewer_1.default();
+                        this._ar.modelUrl = modelLocation;
+                        return accept(this);
+                    }
+                    return reject(new Error("RawAR.init() - cannot proceed as model is not a .usdz or .reality file"));
                 }
-                // load the usdz experience if dealing with usdz file
-                if (lowerLoc.endsWith("usdz") && util_1.Util.canQuicklook()) {
-                    this._ar = new quicklook_viewer_1.default();
-                    this._ar.modelUrl = modelLocation;
-                    return accept(this);
+                // check android
+                if (util_1.Util.canSceneViewer()) {
+                    if (lowerLoc.endsWith("glb") || lowerLoc.endsWith("gltf")) {
+                        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"));
                 }
-                return reject(new Error("RawAR.init() - cannot proceed as model is not a .usdz or .reality file"));
-            }
-            // check android
-            if (util_1.Util.canSceneViewer()) {
-                if (lowerLoc.endsWith("glb") || lowerLoc.endsWith("gltf")) {
-                    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"));
-            }
-            // 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("RawAR.init() - could not initialise AR correctly, check values"));
+                // 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("RawAR.init() - could not initialise AR correctly, check values"));
+            });
         });
     }
     /**
@@ -84,6 +119,14 @@ class RawAR extends launcher_ar_1.LauncherAR {
         if (!this._ar) {
             throw new Error("RawAR.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();
     }

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

@@ -174,7 +174,7 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
                 output = "usdz";
             }
             viewer.messenger.getARFile(output).then((result) => {
-                const rawAR = new raw_ar_1.RawAR(result.filename);
+                const rawAR = new raw_ar_1.RawAR(result.filename, sceneID);
                 return rawAR.init().then(accept).catch(reject);
             }).catch(reject);
             return;
@@ -200,7 +200,7 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
                     }
                 });
                 configurator.get().then((result) => {
-                    const rawAR = new raw_ar_1.RawAR(result.filename);
+                    const rawAR = new raw_ar_1.RawAR(result.filename, sceneID);
                     rawAR.init().then(accept).catch(reject);
                 }).catch(reject);
                 return;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.136.1";
+declare const _default: "1.138.1";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.136.1",
+  "version": "1.138.1",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -44,12 +44,12 @@
     "@plattar/plattar-web": "^1.135.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.18.10",
-    "@babel/core": "^7.18.13",
-    "@babel/preset-env": "^7.18.10",
+    "@babel/cli": "^7.19.3",
+    "@babel/core": "^7.19.6",
+    "@babel/preset-env": "^7.19.4",
     "browserify": "^17.0.0",
-    "typescript": "^4.8.2",
-    "uglify-js": "^3.17.0"
+    "typescript": "^4.8.4",
+    "uglify-js": "^3.17.3"
   },
   "publishConfig": {
     "access": "public"