@plattar/plattar-ar-adapter 1.188.1 → 1.188.2

package/dist/ar/configurator-ar.js

@@ -6,6 +6,7 @@ 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 scene_viewer_1 = __importDefault(require("../viewers/scene-viewer"));
@@ -57,30 +58,31 @@ class ConfiguratorAR extends launcher_ar_1.LauncherAR {
      * an AR File
      */
     async _Compose(output) {
-        const type = output === 'glb' ? "viewer" : "reality";
-        const url = `https://xrutils.plattar.com/v3/scene/${this._options.state.scene.id}/${type}`;
-        // grab our existing scene-graph from the saved API
-        try {
-            const response = await fetch(url, {
-                method: "POST",
-                headers: {
-                    "Content-Type": "application/json"
-                },
-                body: JSON.stringify({
-                    data: {
-                        attributes: this._options.state.state.sceneGraph
-                    }
-                })
-            });
-            if (!response.ok) {
-                throw new Error(`ConfiguratorAR - Fetching Existing Graph Error - network response was not ok ${response.status}`);
-            }
-            const data = await response.json();
-            return data.data.attributes.url;
+        const objects = this._options.state.state.array();
+        if (objects.length <= 0) {
+            throw new Error("ConfiguratorAR.Compose() - cannot proceed as scene does not contain AR components");
         }
-        catch (error) {
-            throw new Error(`ConfiguratorAR - Fetching Existing Graph Error - there was a request error to ${url}, error was ${error.message}`);
+        // 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

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

@@ -6,7 +6,6 @@ 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
  */
@@ -143,7 +142,6 @@ 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;
         }
@@ -156,9 +154,6 @@ 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;
@@ -298,16 +293,6 @@ 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,7 +5,6 @@ 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
  */
@@ -89,7 +88,6 @@ 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";
@@ -128,9 +126,6 @@ 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) {
@@ -203,16 +198,6 @@ 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,7 +171,6 @@ 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();
         }
@@ -206,9 +205,6 @@ 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/util/configurator-state.d.ts

@@ -119,9 +119,4 @@ export declare class ConfiguratorState {
      * @returns - Base64 String
      */
     encode(): string;
-    /**
-     * Compiles and returns the Dynamic Scene Graph (Updated for 2025 for DynamicAR)
-     * NOTE: Eventually this structure should replace ConfiguratorState
-     */
-    get sceneGraph(): any;
 }

package/dist/util/configurator-state.js

@@ -440,38 +440,5 @@ class ConfiguratorState {
     encode() {
         return btoa(JSON.stringify(this._state));
     }
-    /**
-     * Compiles and returns the Dynamic Scene Graph (Updated for 2025 for DynamicAR)
-     * NOTE: Eventually this structure should replace ConfiguratorState
-     */
-    get sceneGraph() {
-        const objects = this.array();
-        // in here we need to generate the schema input to be sent to the backend service
-        const schema = {
-            // ensure to only generate AR using files we pass into the backend
-            strict: false,
-            inputs: []
-        };
-        objects.forEach((object) => {
-            if (object.meta_data.type === "scenemodel") {
-                const data = {
-                    id: object.scene_product_id,
-                    type: 'scenemodel',
-                    visibility: object.meta_data.augment
-                };
-                schema.inputs.push(data);
-            }
-            else {
-                const data = {
-                    id: object.scene_product_id,
-                    type: 'sceneproduct',
-                    variation_id: object.product_variation_id,
-                    visibility: object.meta_data.augment
-                };
-                schema.inputs.push(data);
-            }
-        });
-        return schema;
-    }
 }
 exports.ConfiguratorState = ConfiguratorState;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.188.1";
+declare const _default: "1.188.2";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,57 +1,57 @@
 {
-	"name": "@plattar/plattar-ar-adapter",
-	"version": "1.188.1",
-	"description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
-	"main": "dist/index.js",
-	"module": "dist/index.js",
-	"types": "dist/index.d.ts",
-	"scripts": {
-		"clean": "rm -rf build dist node_modules",
-		"build": "npm run clean && npm install && npm run build-ts && npm run build-es2019 && npm run build-es2015",
-		"build-ts": "tsc --noEmitOnError",
-		"build-es2019": "rm -rf build/es2019 && mkdir -p build/es2019 && browserify --standalone PlattarARAdapter dist/index.js -o build/es2019/plattar-ar-adapter.js && uglifyjs build/es2019/plattar-ar-adapter.js --output build/es2019/plattar-ar-adapter.min.js",
-		"build-es2015": "rm -rf build/es2015 && mkdir -p build/es2015 && babel build/es2019/plattar-ar-adapter.js --presets=@babel/env > build/es2015/plattar-ar-adapter.js && uglifyjs build/es2015/plattar-ar-adapter.js --output build/es2015/plattar-ar-adapter.min.js",
-		"clean:build": "npm run clean && npm run build"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/Plattar/plattar-ar-adapter.git"
-	},
-	"engines": {
-		"node": "^10.17 || >=12.3"
-	},
-	"keywords": [
-		"plattar",
-		"npm",
-		"ar",
-		"augmented",
-		"reality",
-		"augmentedreality",
-		"augmented-reality",
-		"web"
-	],
-	"author": "plattar",
-	"license": "Apache-2.0",
-	"bugs": {
-		"url": "https://github.com/Plattar/plattar-ar-adapter/issues"
-	},
-	"homepage": "https://www.plattar.com",
-	"dependencies": {
-		"@plattar/plattar-analytics": "^1.152.2",
-		"@plattar/plattar-api": "^1.186.3",
-		"@plattar/plattar-qrcode": "1.178.1",
-		"@plattar/plattar-services": "^1.186.1",
-		"@plattar/plattar-web": "^1.182.2"
-	},
-	"devDependencies": {
-		"@babel/cli": "^7.27.0",
-		"@babel/core": "^7.26.10",
-		"@babel/preset-env": "^7.26.9",
-		"browserify": "^17.0.1",
-		"typescript": "^5.8.3",
-		"uglify-js": "^3.19.3"
-	},
-	"publishConfig": {
-		"access": "public"
-	}
+  "name": "@plattar/plattar-ar-adapter",
+  "version": "1.188.2",
+  "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "rm -rf build dist node_modules",
+    "build": "npm run clean && npm install && npm run build-ts && npm run build-es2019 && npm run build-es2015",
+    "build-ts": "tsc --noEmitOnError",
+    "build-es2019": "rm -rf build/es2019 && mkdir -p build/es2019 && browserify --standalone PlattarARAdapter dist/index.js -o build/es2019/plattar-ar-adapter.js && uglifyjs build/es2019/plattar-ar-adapter.js --output build/es2019/plattar-ar-adapter.min.js",
+    "build-es2015": "rm -rf build/es2015 && mkdir -p build/es2015 && babel build/es2019/plattar-ar-adapter.js --presets=@babel/env > build/es2015/plattar-ar-adapter.js && uglifyjs build/es2015/plattar-ar-adapter.js --output build/es2015/plattar-ar-adapter.min.js",
+    "clean:build": "npm run clean && npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Plattar/plattar-ar-adapter.git"
+  },
+  "engines": {
+    "node": "^10.17 || >=12.3"
+  },
+  "keywords": [
+    "plattar",
+    "npm",
+    "ar",
+    "augmented",
+    "reality",
+    "augmentedreality",
+    "augmented-reality",
+    "web"
+  ],
+  "author": "plattar",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/Plattar/plattar-ar-adapter/issues"
+  },
+  "homepage": "https://www.plattar.com",
+  "dependencies": {
+    "@plattar/plattar-analytics": "^1.152.2",
+    "@plattar/plattar-api": "^1.186.3",
+    "@plattar/plattar-qrcode": "1.178.1",
+    "@plattar/plattar-services": "^1.157.1",
+    "@plattar/plattar-web": "^1.182.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.10",
+    "@babel/preset-env": "^7.26.9",
+    "browserify": "^17.0.1",
+    "typescript": "^5.8.2",
+    "uglify-js": "^3.19.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }

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

@@ -1,33 +0,0 @@
-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

@@ -1,159 +0,0 @@
-"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;