@plattar/plattar-ar-adapter 2.7.2 → 2.7.3

package/dist/util/configurator-state.js

@@ -12,6 +12,16 @@ class ConfiguratorState {
     _mappedVariationIDValues;
     // This maps Variation SKU against a Variation ID - populated by decodeScene() function
     _mappedVariationSKUValues;
+    // Cache for encodeSceneGraphID() - keyed by serialised scene graph JSON so state
+    // changes automatically bust the cache, and concurrent in-flight calls share one fetch
+    _cachedSceneGraphID = null;
+    _cachedSceneGraphJSON = null;
+    // Memoised result of the sceneGraph getter - cleared whenever state is mutated
+    _cachedSceneGraph = null;
+    // Static page-lifetime cache for Scene API responses, keyed by sceneID.
+    // Shared across all controller instances so that multiple <plattar-embed>
+    // elements with the same scene-id (or a recreated controller) reuse one fetch.
+    static _sceneAPICache = new Map();
     constructor(state = null) {
         this._mappedVariationIDValues = new Map();
         this._mappedVariationSKUValues = new Map();
@@ -108,6 +118,7 @@ class ConfiguratorState {
             newData[meta.scene_product_index] = SceneModelID;
             newData[meta.product_variation_index] = null;
             newData[meta.meta_index] = metaData;
+            this._cachedSceneGraph = null;
         }
     }
     /**
@@ -135,6 +146,7 @@ class ConfiguratorState {
             newData[meta.product_index] = productID;
             newData[meta.product_variation_index] = productVariationID;
             newData[meta.meta_index] = metaData;
+            this._cachedSceneGraph = null;
         }
     }
     /**
@@ -163,6 +175,7 @@ class ConfiguratorState {
             newData[meta.scene_product_index] = sceneProductID;
             newData[meta.product_variation_index] = productVariationID;
             newData[meta.meta_index] = metaData;
+            this._cachedSceneGraph = null;
         }
     }
     /**
@@ -347,24 +360,43 @@ class ConfiguratorState {
     static decode(state) {
         return new ConfiguratorState(state);
     }
+    /**
+     * Returns a cached Promise<Scene> for the given sceneID, firing at most one
+     * API request per sceneID per page lifetime.  Both decodeState() and
+     * decodeScene() share this cache so they never race each other.
+     */
+    static _fetchScene(sceneID) {
+        const cached = ConfiguratorState._sceneAPICache.get(sceneID);
+        if (cached) {
+            return cached;
+        }
+        const fscene = new plattar_api_1.Scene(sceneID);
+        fscene.include(plattar_api_1.Project);
+        fscene.include(plattar_api_1.SceneModel);
+        fscene.include(plattar_api_1.Product);
+        fscene.include(plattar_api_1.SceneProduct.include(plattar_api_1.Product.include(plattar_api_1.ProductVariation)));
+        const promise = fscene.get();
+        ConfiguratorState._sceneAPICache.set(sceneID, promise);
+        // Bust the cache on failure so the next call retries
+        promise.catch(() => {
+            ConfiguratorState._sceneAPICache.delete(sceneID);
+        });
+        return promise;
+    }
     /**
      * Decodes a previously generated state
      * @param sceneID
      * @param state
+     * @param existingState - (optional) reuse this already-decoded instance instead of
+     * parsing a fresh one, so mutations applied to it before this call are preserved
      * @returns
      */
-    static async decodeState(sceneID = null, state = null) {
+    static async decodeState(sceneID = null, state = null, existingState = null) {
         if (!sceneID || !state) {
             throw new Error("ConfiguratorState.decodeState(sceneID, state) - sceneID and state must be defined");
         }
-        const configState = new ConfiguratorState(state);
-        const fscene = new plattar_api_1.Scene(sceneID);
-        fscene.include(plattar_api_1.Project);
-        fscene.include(plattar_api_1.Product);
-        fscene.include(plattar_api_1.SceneProduct);
-        fscene.include(plattar_api_1.SceneModel);
-        fscene.include(plattar_api_1.SceneProduct.include(plattar_api_1.Product.include(plattar_api_1.ProductVariation)));
-        const scene = await fscene.get();
+        const configState = existingState ?? new ConfiguratorState(state);
+        const scene = await ConfiguratorState._fetchScene(sceneID);
         return {
             scene: scene,
             state: configState
@@ -381,13 +413,7 @@ class ConfiguratorState {
             throw new Error("ConfiguratorState.decodeScene(sceneID) - sceneID must be defined");
         }
         const configState = new ConfiguratorState();
-        const fscene = new plattar_api_1.Scene(sceneID);
-        fscene.include(plattar_api_1.Project);
-        fscene.include(plattar_api_1.SceneProduct);
-        fscene.include(plattar_api_1.SceneModel);
-        fscene.include(plattar_api_1.Product);
-        fscene.include(plattar_api_1.SceneProduct.include(plattar_api_1.Product.include(plattar_api_1.ProductVariation)));
-        const scene = await fscene.get();
+        const scene = await ConfiguratorState._fetchScene(sceneID);
         const sceneProducts = scene.relationships.filter(plattar_api_1.SceneProduct);
         const sceneModels = scene.relationships.filter(plattar_api_1.SceneModel);
         const products = scene.relationships.filter(plattar_api_1.Product);
@@ -445,42 +471,54 @@ class ConfiguratorState {
     encode() {
         return btoa(JSON.stringify(this._state));
     }
-    async encodeSceneGraphID() {
+    encodeSceneGraphID() {
         const graph = this.sceneGraph;
+        const graphJSON = JSON.stringify(graph);
+        // Return cached promise if the scene graph state hasn't changed.
+        // Caching the Promise (not the resolved value) means concurrent in-flight
+        // calls also share a single fetch rather than firing multiple requests.
+        if (this._cachedSceneGraphID !== null && this._cachedSceneGraphJSON === graphJSON) {
+            return this._cachedSceneGraphID;
+        }
         // some scene-graphs are very large in size, we store it remotely
         // this storage will expire in 10 minutes so this is a non-permanent version
         // and is designed for quick ar
         const url = plattar_api_1.Server.location().type === 'staging' ? 'https://c.plattar.space/v3/redir/store' : 'https://c.plattar.com/v3/redir/store';
-        // finally send our scene-graph to the backend to generate the AR file and return
-        try {
-            const response = await fetch(url, {
-                method: "POST",
-                headers: {
-                    "Content-Type": "application/json"
-                },
-                body: JSON.stringify({
-                    data: {
-                        attributes: {
-                            data: graph
-                        }
+        this._cachedSceneGraphJSON = graphJSON;
+        this._cachedSceneGraphID = fetch(url, {
+            method: "POST",
+            headers: {
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify({
+                data: {
+                    attributes: {
+                        data: graph
                     }
-                })
-            });
+                }
+            })
+        }).then(async (response) => {
             if (!response.ok) {
                 throw new Error(`ConfiguratorState.encodeSceneGraphID() - network response was not ok ${response.status}`);
             }
             const data = await response.json();
             return data.data.id;
-        }
-        catch (error) {
+        }).catch((error) => {
+            // Bust the cache on failure so the next call retries
+            this._cachedSceneGraphID = null;
+            this._cachedSceneGraphJSON = null;
             throw new Error(`ConfiguratorState.encodeSceneGraphID() - there was a request error to ${url}, error was ${error.message}`);
-        }
+        });
+        return this._cachedSceneGraphID;
     }
     /**
      * Compiles and returns the Dynamic Scene Graph (Updated for 2025 for DynamicAR)
      * NOTE: Eventually this structure should replace ConfiguratorState
      */
     get sceneGraph() {
+        if (this._cachedSceneGraph !== null) {
+            return this._cachedSceneGraph;
+        }
         const objects = this.array();
         // in here we need to generate the schema input to be sent to the backend service
         const schema = {
@@ -507,7 +545,8 @@ class ConfiguratorState {
                 schema.inputs.push(data);
             }
         });
-        return schema;
+        this._cachedSceneGraph = schema;
+        return this._cachedSceneGraph;
     }
 }
 exports.ConfiguratorState = ConfiguratorState;

package/dist/util/util.d.ts

@@ -2,6 +2,7 @@
  * Static Utility Functions
  */
 export declare class Util {
+    private static readonly _cache;
     static isValidServerLocation(server: string | null | undefined): boolean;
     static canAugment(): boolean;
     static canQuicklook(): boolean;

package/dist/util/util.js

@@ -5,6 +5,7 @@ exports.Util = void 0;
  * Static Utility Functions
  */
 class Util {
+    static _cache = new Map();
     static isValidServerLocation(server) {
         if (!server) {
             return false;
@@ -30,67 +31,118 @@ class Util {
         return false;
     }
     static canAugment() {
-        return Util.canQuicklook() || Util.canSceneViewer();
+        if (Util._cache.has('canAugment'))
+            return Util._cache.get('canAugment');
+        const result = Util.canQuicklook() || Util.canSceneViewer();
+        Util._cache.set('canAugment', result);
+        return result;
     }
     static canQuicklook() {
+        if (Util._cache.has('canQuicklook'))
+            return Util._cache.get('canQuicklook');
+        let result = false;
         if (Util.isIOS()) {
             const isWKWebView = Boolean((window && window).webkit && window.webkit.messageHandlers);
             if (isWKWebView) {
-                return Boolean(/CriOS\/|EdgiOS\/|FxiOS\/|GSA\/|DuckDuckGo\//.test(navigator.userAgent));
+                result = Boolean(/CriOS\/|EdgiOS\/|FxiOS\/|GSA\/|DuckDuckGo\//.test(navigator.userAgent));
+            }
+            else {
+                const tempAnchor = document.createElement("a");
+                result = Boolean(tempAnchor.relList && tempAnchor.relList.supports && tempAnchor.relList.supports("ar"));
             }
-            const tempAnchor = document.createElement("a");
-            return tempAnchor.relList && tempAnchor.relList.supports && tempAnchor.relList.supports("ar");
         }
-        return false;
+        Util._cache.set('canQuicklook', result);
+        return result;
     }
     static canSceneViewer() {
-        return Util.isAndroid() && !Util.isFirefox() && !Util.isOculus();
+        if (Util._cache.has('canSceneViewer'))
+            return Util._cache.get('canSceneViewer');
+        const result = Util.isAndroid() && !Util.isFirefox() && !Util.isOculus();
+        Util._cache.set('canSceneViewer', result);
+        return result;
     }
     static canRealityViewer() {
-        return Util.isIOS() && Util.getIOSVersion()[0] >= 13;
+        if (Util._cache.has('canRealityViewer'))
+            return Util._cache.get('canRealityViewer');
+        const result = Util.isIOS() && Util.getIOSVersion()[0] >= 13;
+        Util._cache.set('canRealityViewer', result);
+        return result;
     }
     static isSafariOnIOS() {
-        return Util.isIOS() && Util.isSafari();
+        if (Util._cache.has('isSafariOnIOS'))
+            return Util._cache.get('isSafariOnIOS');
+        const result = Util.isIOS() && Util.isSafari();
+        Util._cache.set('isSafariOnIOS', result);
+        return result;
     }
     static isChromeOnIOS() {
-        return Util.isIOS() && /CriOS\//.test(navigator.userAgent);
+        if (Util._cache.has('isChromeOnIOS'))
+            return Util._cache.get('isChromeOnIOS');
+        const result = Util.isIOS() && /CriOS\//.test(navigator.userAgent);
+        Util._cache.set('isChromeOnIOS', result);
+        return result;
     }
     static isIOS() {
-        return (/iPad|iPhone|iPod/.test(navigator.userAgent) && !self.MSStream) || (navigator.platform === "MacIntel" && navigator.maxTouchPoints > 1);
+        if (Util._cache.has('isIOS'))
+            return Util._cache.get('isIOS');
+        const result = (/iPad|iPhone|iPod/.test(navigator.userAgent) && !self.MSStream) || (navigator.platform === "MacIntel" && navigator.maxTouchPoints > 1);
+        Util._cache.set('isIOS', result);
+        return result;
     }
     static isAndroid() {
-        return /android/i.test(navigator.userAgent);
+        if (Util._cache.has('isAndroid'))
+            return Util._cache.get('isAndroid');
+        const result = /android/i.test(navigator.userAgent);
+        Util._cache.set('isAndroid', result);
+        return result;
     }
     static isFirefox() {
-        return /firefox/i.test(navigator.userAgent);
+        if (Util._cache.has('isFirefox'))
+            return Util._cache.get('isFirefox');
+        const result = /firefox/i.test(navigator.userAgent);
+        Util._cache.set('isFirefox', result);
+        return result;
     }
     static isOculus() {
-        return /OculusBrowser/.test(navigator.userAgent);
+        if (Util._cache.has('isOculus'))
+            return Util._cache.get('isOculus');
+        const result = /OculusBrowser/.test(navigator.userAgent);
+        Util._cache.set('isOculus', result);
+        return result;
     }
     static isSafari() {
-        return Util.isIOS() && /Safari\//.test(navigator.userAgent);
+        if (Util._cache.has('isSafari'))
+            return Util._cache.get('isSafari');
+        const result = Util.isIOS() && /Safari\//.test(navigator.userAgent);
+        Util._cache.set('isSafari', result);
+        return result;
     }
     static getIOSVersion() {
+        if (Util._cache.has('getIOSVersion'))
+            return Util._cache.get('getIOSVersion');
+        let result = [-1, -1, -1];
         if (/iP(hone|od|ad)/.test(navigator.platform)) {
             const v = (navigator.appVersion).match(/OS (\d+)_(\d+)_?(\d+)?/);
             if (v !== null) {
-                return [parseInt(v[1], 10), parseInt(v[2], 10), parseInt(v[3], 10)];
+                result = [parseInt(v[1], 10), parseInt(v[2], 10), parseInt(v[3], 10)];
             }
         }
-        if (/Mac/.test(navigator.platform)) {
+        else if (/Mac/.test(navigator.platform)) {
             const v = (navigator.appVersion).match(/Version\/(\d+)\.(\d+)\.?(\d+)?/);
             if (v !== null) {
-                return [parseInt(v[1], 10), parseInt(v[2], 10), parseInt(v[3], 10)];
+                result = [parseInt(v[1], 10), parseInt(v[2], 10), parseInt(v[3], 10)];
             }
         }
-        return [-1, -1, -1];
+        Util._cache.set('getIOSVersion', result);
+        return result;
     }
     static getChromeVersion() {
+        if (Util._cache.has('getChromeVersion'))
+            return Util._cache.get('getChromeVersion');
         const raw = navigator.userAgent.match(/Chrom(e|ium)\/([0-9]+)\./);
-        if (raw !== null) {
-            return parseInt(raw[2], 10);
-        }
-        return 1;
+        const result = raw !== null ? parseInt(raw[2], 10) : 1;
+        Util._cache.set('getChromeVersion', result);
+        return result;
     }
 }
 exports.Util = Util;

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "2.7.2";
+declare const _default: "2.7.3";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,16 +1,21 @@
 {
 	"name": "@plattar/plattar-ar-adapter",
-	"version": "2.7.2",
+	"version": "2.7.3",
 	"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",
+		"clean": "node -e \"['build','dist','node_modules'].forEach(p=>require('fs').rmSync(p,{recursive:true,force:true}))\"",
 		"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",
+		"build-es2019": "rimraf build/es2019 && mkdirp 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": "rimraf build/es2015 && mkdirp 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",
+		"serve": "http-server build/es2019 -p 3000 --cors -c-1",
+		"watch:rebuild": "npm run build-ts && npm run build-es2019",
+		"watch:files": "chokidar src/**/*.ts -c \"npm run watch:rebuild\"",
+		"prewatch": "npm run watch:rebuild",
+		"watch": "concurrently \"npm run serve\" \"npm run watch:files\"",
 		"clean:build": "npm run clean && npm run build"
 	},
 	"repository": {
@@ -47,6 +52,11 @@
 		"@babel/core": "^7.29.0",
 		"@babel/preset-env": "^7.29.5",
 		"browserify": "^17.0.1",
+		"chokidar-cli": "^3.0.0",
+		"concurrently": "^9.2.1",
+		"http-server": "^14.1.1",
+		"mkdirp": "^3.0.1",
+		"rimraf": "^6.1.3",
 		"typescript": "^6.0.3",
 		"uglify-js": "^3.19.3"
 	},