@plattar/plattar-ar-adapter 1.180.1 → 1.183.1

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

@@ -0,0 +1,33 @@
+import { LauncherAR } from "./launcher-ar";
+export interface SceneGraphAROptions {
+    readonly id: string;
+    readonly sceneID: string;
+    readonly useARBanner: boolean;
+}
+/**
+ * Performs AR functionality related to Plattar Scenes
+ */
+export declare class SceneGraphAR extends LauncherAR {
+    private _analytics;
+    private _options;
+    private _ar;
+    constructor(options: SceneGraphAROptions);
+    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/scene-graph-ar.js

@@ -0,0 +1,159 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SceneGraphAR = 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 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 SceneGraphAR extends launcher_ar_1.LauncherAR {
+    constructor(options) {
+        super();
+        // analytics instance
+        this._analytics = null;
+        this._options = options;
+        this._ar = null;
+    }
+    async _SetupAnalytics() {
+        const scene = new plattar_api_1.Scene(this._options.sceneID);
+        scene.include(plattar_api_1.Project);
+        const fetchedScene = await scene.get();
+        let analytics = null;
+        analytics = new plattar_analytics_1.Analytics(fetchedScene.attributes.application_id);
+        analytics.origin = plattar_api_1.Server.location().type;
+        this._analytics = analytics;
+        analytics.data.push("type", "scene-graph-ar");
+        analytics.data.push("sdkVersion", version_1.default);
+        analytics.data.push("sceneId", fetchedScene.id);
+        analytics.data.push("sceneTitle", fetchedScene.attributes.title);
+        const application = fetchedScene.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);
+            if (this._options.useARBanner) {
+                this.options.banner = {
+                    title: application.attributes.title,
+                    subtitle: fetchedScene.attributes.title,
+                    button: 'Visit'
+                };
+            }
+        }
+        return fetchedScene;
+    }
+    /**
+     * Composes a Scene into an AR Model (remote operation) that can be used to launch
+     * an AR File
+     */
+    async _Compose(output) {
+        const type = output === 'glb' ? "viewer" : "reality";
+        const url = `https://xrutils.plattar.com/v3/scene/${this._options.sceneID}/${type}/${this._options.id}`;
+        // grab our existing scene-graph from the saved API
+        try {
+            const response = await fetch(url, {
+                method: "GET",
+                headers: {
+                    "Content-Type": "application/json"
+                }
+            });
+            if (!response.ok) {
+                throw new Error(`ARAdapter - Fetching Existing Graph Error - network response was not ok ${response.status}`);
+            }
+            const data = await response.json();
+            return data.data.attributes.url;
+        }
+        catch (error) {
+            throw new Error(`ARAdapter - Fetching Existing Graph Error - there was a request error to ${url}, error was ${error.message}`);
+        }
+    }
+    /**
+     * 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("SceneGraphAR.init() - cannot proceed as AR not available in context");
+        }
+        const scene = await 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 quicklook_viewer_1.default();
+                    this._ar.modelUrl = modelUrl;
+                    this._ar.banner = this.options.banner;
+                    return this;
+                }
+                else {
+                    throw new Error("SceneGraphAR.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;
+                this._ar.banner = this.options.banner;
+                return this;
+            }
+            throw new Error("SceneGraphAR.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;
+            arviewer.banner = this.options.banner;
+            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("SceneGraphAR.init() - could not initialise AR correctly, check values");
+    }
+    start() {
+        if (!this._ar) {
+            throw new Error("SceneGraphAR.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.SceneGraphAR = SceneGraphAR;

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

@@ -6,6 +6,7 @@ const scene_product_ar_1 = require("../../ar/scene-product-ar");
 const util_1 = require("../../util/util");
 const plattar_controller_1 = require("./plattar-controller");
 const configurator_ar_1 = require("../../ar/configurator-ar");
+const scene_graph_ar_1 = require("../../ar/scene-graph-ar");
 /**
  * Manages an instance of the <plattar-configurator> HTML Element
  */
@@ -142,6 +143,7 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
         const showAR = this.getAttribute("show-ar");
         const showUI = this.getAttribute("show-ui");
         const showBanner = this.getAttribute("show-ar-banner");
+        const sceneGraphID = this.getAttribute("scene-graph-id");
         if (showUI && showUI === "true") {
             dst = plattar_api_1.Server.location().base + "configurator/dist/index.html?scene_id=" + sceneID;
         }
@@ -154,6 +156,9 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
         if (showBanner) {
             dst += "&show_ar_banner=" + showBanner;
         }
+        if (sceneGraphID) {
+            dst += "&scene_graph_id=" + sceneGraphID;
+        }
         viewer.setAttribute("url", opt.url || dst);
         this._state = plattar_controller_1.ControllerState.QRCode;
         this._prevQROpt = opt;
@@ -293,6 +298,16 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
         if (!sceneID) {
             throw new Error("VTOController.initAR() - generated AR minimum required attributes not set, use scene-id as a minimum");
         }
+        const graphID = this.getAttribute("scene-graph-id");
+        // use the scene-graph route if available
+        if (graphID) {
+            const configAR = new scene_graph_ar_1.SceneGraphAR({
+                useARBanner: this.getBooleanAttribute("show-ar-banner"),
+                id: graphID,
+                sceneID: sceneID
+            });
+            return configAR.init();
+        }
         const configAR = new configurator_ar_1.ConfiguratorAR({ state: await this.getConfiguratorState(), useARBanner: this.getBooleanAttribute("show-ar-banner") });
         return configAR.init();
     }

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

@@ -5,6 +5,7 @@ const scene_product_ar_1 = require("../../ar/scene-product-ar");
 const util_1 = require("../../util/util");
 const plattar_controller_1 = require("./plattar-controller");
 const configurator_ar_1 = require("../../ar/configurator-ar");
+const scene_graph_ar_1 = require("../../ar/scene-graph-ar");
 /**
  * Manages an instance of the <plattar-configurator> HTML Element
  */
@@ -88,6 +89,7 @@ class LauncherController extends plattar_controller_1.PlattarController {
         const variationSKU = this.getAttribute("variation-sku");
         const arMode = this.getAttribute("ar-mode");
         const showBanner = this.getAttribute("show-ar-banner");
+        const sceneGraphID = this.getAttribute("scene-graph-id");
         // required attributes with defaults for plattar-launcher node
         const width = this.getAttribute("width") || "500px";
         const height = this.getAttribute("height") || "500px";
@@ -126,6 +128,9 @@ class LauncherController extends plattar_controller_1.PlattarController {
                 viewer.setAttribute("config-state", encodedState);
             }
         }
+        if (sceneGraphID) {
+            viewer.setAttribute("scene-graph-id", sceneGraphID);
+        }
         return new Promise((accept, reject) => {
             this.append(viewer);
             if (configState) {
@@ -198,6 +203,16 @@ class LauncherController extends plattar_controller_1.PlattarController {
         if (!sceneID) {
             throw new Error("LauncherController.initAR() - generated AR minimum required attributes not set, use scene-id as a minimum");
         }
+        const graphID = this.getAttribute("scene-graph-id");
+        // use the scene-graph route if available
+        if (graphID) {
+            const configAR = new scene_graph_ar_1.SceneGraphAR({
+                useARBanner: this.getBooleanAttribute("show-ar-banner"),
+                id: graphID,
+                sceneID: sceneID
+            });
+            return configAR.init();
+        }
         const configAR = new configurator_ar_1.ConfiguratorAR({ state: await this.getConfiguratorState(), useARBanner: this.getBooleanAttribute("show-ar-banner") });
         return configAR.init();
     }

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

@@ -171,6 +171,7 @@ class PlattarController {
         const variationSKU = this.getAttribute("variation-sku");
         const arMode = this.getAttribute("ar-mode");
         const showBanner = this.getAttribute("show-ar-banner");
+        const sceneGraphID = this.getAttribute("scene-graph-id");
         try {
             configState = (await this.getConfiguratorState()).state.encode();
         }
@@ -205,6 +206,9 @@ class PlattarController {
         if (showBanner) {
             dst += "&show_ar_banner=" + showBanner;
         }
+        if (sceneGraphID) {
+            dst += "&scene_graph_id" + sceneGraphID;
+        }
         viewer.setAttribute("url", opt.url || dst);
         this._state = ControllerState.QRCode;
         this._prevQROpt = opt;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.180.1";
+declare const _default: "1.183.1";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.180.1",
+  "version": "1.183.1",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -41,14 +41,14 @@
     "@plattar/plattar-api": "^1.178.1",
     "@plattar/plattar-qrcode": "1.178.1",
     "@plattar/plattar-services": "^1.157.1",
-    "@plattar/plattar-web": "^1.178.2"
+    "@plattar/plattar-web": "^1.182.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.25.9",
-    "@babel/core": "^7.26.0",
-    "@babel/preset-env": "^7.26.0",
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.9",
+    "@babel/preset-env": "^7.26.9",
     "browserify": "^17.0.1",
-    "typescript": "^5.7.2",
+    "typescript": "^5.7.3",
     "uglify-js": "^3.19.3"
   },
   "publishConfig": {