@webspatial/core-sdk 1.3.0 → 1.4.0

package/dist/index.js

@@ -2,7 +2,7 @@
     (function(){
       if(typeof window === 'undefined') return;
       if(!window.__webspatialsdk__) window.__webspatialsdk__ = {}
-      window.__webspatialsdk__['core-sdk-version'] = "1.3.0"
+      window.__webspatialsdk__['core-sdk-version'] = "1.4.0"
   })()
     
 var __defProp = Object.defineProperty;
@@ -105,7 +105,7 @@ var init_PuppeteerPlatform = __esm({
     init_CommandResultUtils();
     console.log("PuppeteerPlatform");
     PuppeteerPlatform = class {
-      // 存储iframe实例
+      // store iframe instance
       iframeRegistry = /* @__PURE__ */ new Map();
       constructor() {
       }
@@ -135,7 +135,7 @@ var init_PuppeteerPlatform = __esm({
         });
       }
       /**
-       * 同步创建Spatialized2DElement到Puppeteer Runner
+       * Synchronously create Spatialized2DElement to Puppeteer Runner
        */
       createSpatializedElementSync(spatialId, webspatialUrl) {
         try {
@@ -207,7 +207,7 @@ var init_PuppeteerPlatform = __esm({
         }
       }
       /**
-       * 创建基于iframe的窗口
+       * Synchronously create iframe-based window
        */
       createIframeWindow(url, target, features) {
         const iframe = document.createElement("iframe");
@@ -243,11 +243,11 @@ var init_PuppeteerPlatform = __esm({
         return { spatialId, iframe, windowProxy };
       }
       /**
-       * 创建增强的windowProxy对象
+       * create enhanced windowProxy object
        */
       createEnhancedWindowProxy(iframe, url, spatialId) {
         return {
-          // 基本属性
+          // basic properties
           location: {
             href: url,
             toString: () => url,
@@ -260,22 +260,22 @@ var init_PuppeteerPlatform = __esm({
           navigator: {
             userAgent: `Mozilla/5.0 (WebKit) SpatialId/${spatialId}`
           },
-          // 方法
+          // methods
           close: () => {
             console.log(`Closing iframe with spatialId: ${spatialId}`);
             iframe.remove();
             this.iframeRegistry.delete(spatialId);
           },
-          // 文档访问
+          // document access
           document: iframe.contentDocument || {},
           contentWindow: iframe.contentWindow || {},
-          // 添加消息通信方法
+          // add message communication method
           postMessage: (message, targetOrigin) => {
             if (iframe.contentWindow) {
               iframe.contentWindow.postMessage(message, targetOrigin || "*");
             }
           },
-          // 添加事件监听方法
+          // add event listener method
           addEventListener: (type, listener) => {
             if (iframe.contentWindow) {
               iframe.contentWindow.addEventListener(type, listener);
@@ -286,7 +286,7 @@ var init_PuppeteerPlatform = __esm({
               iframe.contentWindow.removeEventListener(type, listener);
             }
           },
-          // 执行JavaScript
+          // execute JavaScript
           executeScript: (code) => {
             if (iframe.contentWindow) {
               try {
@@ -302,29 +302,29 @@ var init_PuppeteerPlatform = __esm({
             }
             return null;
           },
-          // 获取iframe引用
+          // get iframe reference
           getIframe: () => iframe,
-          // 获取spatialId
+          // get spatialId
           getSpatialId: () => spatialId
         };
       }
       /**
-       * 初始化iframe内容
+       * initialize iframe content
        */
       initializeIframeContent(iframe, url, spatialId) {
         try {
           iframe.onload = () => {
             try {
               const iframeContent = `
-            // \u6CE8\u5165\u901A\u4FE1\u811A\u672C
+            // inject communication script
             window.webSpatialId = '${spatialId}';
             window.SpatialId = '${spatialId}';
             
-            // \u91CD\u5199window.open\u4EE5\u652F\u6301webspatial\u534F\u8BAE
+            // override window.open to support webspatial protocol
             const originalOpen = window.open;
             window.open = function(url, target, features) {
               if (url && url.startsWith('webspatial://')) {
-                // \u901A\u8FC7windowProxy\u5904\u7406webspatial\u534F\u8BAE
+                // handle webspatial protocol through windowProxy
                 const windowProxy = new Proxy({}, {
                   get: function(target, prop) {
                     if (prop === 'toString') {
@@ -338,28 +338,28 @@ var init_PuppeteerPlatform = __esm({
               return originalOpen.call(window, url, target, features);
             };
             
-            // \u8BBE\u7F6Enavigator.userAgent\u4EE5\u8BC6\u522Bwebspatial\u73AF\u5883
+            // set navigator.userAgent to identify webspatial environment
             Object.defineProperty(navigator, 'userAgent', {
               value: 'WebSpatial/1.0 ' + navigator.userAgent,
               configurable: true
             });
             
-            // \u53D1\u9001\u52A0\u8F7D\u5B8C\u6210\u6D88\u606F
+            // send loaded message
             window.parent.postMessage({
               type: 'iframe_loaded',
               spatialId: '${spatialId}',
               url: '${url}'
             }, '${window.location.origin}');
             
-            // \u8BBE\u7F6E\u6D88\u606F\u5904\u7406\u5668
+            // set message handler
             window.addEventListener('message', (event) => {
               if (event.origin !== window.parent.location.origin) return;
               
               const data = event.data;
               if (data && data.type === 'webspatial_command') {
-                // \u5904\u7406\u6765\u81EA\u7236\u7A97\u53E3\u7684\u547D\u4EE4
+                // handle command from parent window
                 console.log('Received command in iframe from parent:', data.command);
-                // \u8FD9\u91CC\u53EF\u4EE5\u6DFB\u52A0\u547D\u4EE4\u5904\u7406\u903B\u8F91
+                // add command handling logic here
               }
             });
           `;
@@ -396,7 +396,7 @@ var init_PuppeteerPlatform = __esm({
         }
       }
       /**
-       * 解析features字符串为对象
+       * parse features string to object
        */
       parseFeatures(features) {
         const result = {};
@@ -410,7 +410,7 @@ var init_PuppeteerPlatform = __esm({
         return result;
       }
       /**
-       * 发送消息到指定spatialId的iframe
+       * send message to iframe with specified spatialId
        */
       sendMessageToIframe(spatialId, message) {
         const iframe = this.iframeRegistry.get(spatialId);
@@ -421,7 +421,7 @@ var init_PuppeteerPlatform = __esm({
         return false;
       }
       /**
-       * 获取所有活跃的iframe
+       * get all active iframes
        */
       getAllActiveIframes() {
         const result = [];
@@ -431,7 +431,7 @@ var init_PuppeteerPlatform = __esm({
         return result;
       }
       /**
-       * 清理资源
+       * dispose all active iframes
        */
       dispose() {
         this.iframeRegistry.forEach((iframe, spatialId) => {
@@ -440,7 +440,7 @@ var init_PuppeteerPlatform = __esm({
         });
         this.iframeRegistry.clear();
       }
-      // 生成UUID函数
+      // generate UUID function
       generateUUID() {
         return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(
           /[xy]/g,
@@ -834,7 +834,7 @@ var init_utils = __esm({
 });
 
 // src/JSBCommand.ts
-var platform, JSBCommand, UpdateEntityPropertiesCommand, UpdateEntityEventCommand, UpdateSpatialSceneProperties, UpdateSceneConfig, FocusScene, GetSpatialSceneState, SpatializedElementCommand, UpdateSpatialized2DElementProperties, UpdateSpatializedDynamic3DElementProperties, UpdateUnlitMaterialProperties, UpdateSpatializedElementTransform, UpdateSpatializedStatic3DElementProperties, AddSpatializedElementToSpatialized2DElement, AddSpatializedElementToSpatialScene, CreateSpatializedStatic3DElementCommand, CreateSpatializedDynamic3DElementCommand, CreateSpatialEntityCommand, CreateModelComponentCommand, CreateSpatialModelEntityCommand, CreateModelAssetCommand, CreateSpatialGeometryCommand, CreateSpatialUnlitMaterialCommand, AddComponentToEntityCommand, SetParentForEntityCommand, ConvertFromEntityToEntityCommand, ConvertFromEntityToSceneCommand, ConvertFromSceneToEntityCommand, InspectCommand, DestroyCommand, CheckWebViewCanCreateCommand, WebSpatialProtocolCommand, createSpatialized2DElementCommand, createSpatialSceneCommand, CreateAttachmentEntityCommand, UpdateAttachmentEntityCommand;
+var platform, JSBCommand, UpdateEntityPropertiesCommand, UpdateEntityEventCommand, UpdateSpatialSceneProperties, UpdateSceneConfig, FocusScene, GetSpatialSceneState, SpatializedElementCommand, UpdateSpatialized2DElementProperties, UpdateSpatializedDynamic3DElementProperties, UpdateUnlitMaterialProperties, UpdateSpatializedElementTransform, UpdateSpatializedStatic3DElementProperties, AddSpatializedElementToSpatialized2DElement, AddSpatializedElementToSpatialScene, CreateSpatializedStatic3DElementCommand, CreateSpatializedDynamic3DElementCommand, CreateSpatialEntityCommand, CreateModelComponentCommand, CreateSpatialModelEntityCommand, CreateModelAssetCommand, CreateSpatialGeometryCommand, CreateSpatialUnlitMaterialCommand, AddComponentToEntityCommand, SetParentForEntityCommand, ConvertFromEntityToEntityCommand, ConvertFromEntityToSceneCommand, ConvertFromSceneToEntityCommand, ConvertCoordinateCommand, InspectCommand, DestroyCommand, CheckWebViewCanCreateCommand, WebSpatialProtocolCommand, createSpatialized2DElementCommand, createSpatialSceneCommand, CreateAttachmentEntityCommand, InitializeAttachmentCommand, UpdateAttachmentEntityCommand;
 var init_JSBCommand = __esm({
   "src/JSBCommand.ts"() {
     "use strict";
@@ -1172,6 +1172,22 @@ var init_JSBCommand = __esm({
       }
       commandType = "ConvertFromSceneToEntity";
     };
+    ConvertCoordinateCommand = class extends JSBCommand {
+      constructor(position, fromId, toId) {
+        super();
+        this.position = position;
+        this.fromId = fromId;
+        this.toId = toId;
+      }
+      getParams() {
+        return {
+          position: this.position,
+          fromId: this.fromId,
+          toId: this.toId
+        };
+      }
+      commandType = "ConvertCoordinate";
+    };
     InspectCommand = class extends JSBCommand {
       constructor(id = "") {
         super();
@@ -1267,11 +1283,24 @@ var init_JSBCommand = __esm({
         this.options = options;
       }
       commandType = "createAttachment";
+      getParams() {
+        return {};
+      }
+    };
+    InitializeAttachmentCommand = class extends JSBCommand {
+      constructor(attachmentId, options) {
+        super();
+        this.attachmentId = attachmentId;
+        this.options = options;
+      }
+      commandType = "InitializeAttachment";
       getParams() {
         return {
+          id: this.attachmentId,
           parentEntityId: this.options.parentEntityId,
           position: this.options.position ?? [0, 0, 0],
-          size: this.options.size
+          size: this.options.size,
+          ownerViewId: this.options.ownerViewId
         };
       }
     };
@@ -1332,6 +1361,7 @@ init_JSBCommand();
 
 // src/SpatialScene.ts
 init_JSBCommand();
+init_JSBCommand();
 var instance;
 var SpatialScene = class _SpatialScene extends SpatialObject {
   /**
@@ -1345,6 +1375,19 @@ var SpatialScene = class _SpatialScene extends SpatialObject {
     }
     return instance;
   }
+  async convertCoordinate(position, fromId, toId) {
+    try {
+      const ret = await new ConvertCoordinateCommand(
+        position,
+        fromId,
+        toId
+      ).execute();
+      return ret?.data ?? position;
+    } catch (error) {
+      console.warn("SpatialScene.convertCoordinate error:", error);
+      throw error;
+    }
+  }
   /**
    * Updates the properties of the spatial scene.
    * This can include background settings, lighting, and other scene-wide properties.
@@ -1844,29 +1887,6 @@ var SpatializedElement = class extends SpatialObject {
     const { type } = data;
     if (type === "objectdestroy" /* objectdestroy */) {
       this.isDestroyed = true;
-    } else if (type === "cubeInfo" /* cubeInfo */) {
-      const cubeInfoMsg = data;
-      this._cubeInfo = new CubeInfo(cubeInfoMsg.size, cubeInfoMsg.origin);
-    } else if (type === "transform" /* transform */) {
-      this._transform = new DOMMatrix([
-        data.detail.column0[0],
-        data.detail.column0[1],
-        data.detail.column0[2],
-        0,
-        data.detail.column1[0],
-        data.detail.column1[1],
-        data.detail.column1[2],
-        0,
-        data.detail.column2[0],
-        data.detail.column2[1],
-        data.detail.column2[2],
-        0,
-        data.detail.column3[0],
-        data.detail.column3[1],
-        data.detail.column3[2],
-        1
-      ]);
-      this._transformInv = this._transform.inverse();
     } else if (type === "spatialtap" /* spatialtap */) {
       const event = createSpatialEvent(
         "spatialtap" /* spatialtap */,
@@ -2045,6 +2065,7 @@ var SpatializedStatic3DElement = class extends SpatializedElement {
    * @returns Promise that resolves when the model is loaded (true) or fails to load (false)
    */
   createReadyPromise() {
+    this._readyResolve?.(false);
     return new Promise((resolve) => {
       this._readyResolve = resolve;
     });
@@ -2120,6 +2141,7 @@ var SpatializedStatic3DElement = class extends SpatializedElement {
 init_JSBCommand();
 var SpatializedDynamic3DElement = class extends SpatializedElement {
   children = [];
+  events = {};
   constructor(id) {
     super(id);
   }
@@ -2129,6 +2151,17 @@ var SpatializedDynamic3DElement = class extends SpatializedElement {
     entity.parent = this;
     return ans;
   }
+  addEvent(type, callback) {
+    this.events[type] = callback;
+  }
+  removeEvent(eventName) {
+    if (this.events[eventName]) {
+      delete this.events[eventName];
+    }
+  }
+  dispatchEvent(evt) {
+    this.events[evt.type]?.(evt);
+  }
   async updateProperties(properties) {
     return new UpdateSpatializedDynamic3DElementProperties(
       this,
@@ -2197,6 +2230,7 @@ async function createAttachmentEntity(options) {
     throw new Error("createAttachmentEntity failed: " + result?.errorMessage);
   }
   const { id, windowProxy } = result.data;
+  await new InitializeAttachmentCommand(id, options).execute();
   return new Attachment(id, windowProxy, options);
 }
 
@@ -2207,7 +2241,7 @@ init_JSBCommand();
 init_JSBCommand();
 init_JSBCommand();
 init_SpatialWebEvent();
-var SpatialEntity = class _SpatialEntity extends SpatialObject {
+var SpatialEntity = class extends SpatialObject {
   constructor(id, userData) {
     super(id);
     this.userData = userData;
@@ -2219,6 +2253,20 @@ var SpatialEntity = class _SpatialEntity extends SpatialObject {
   events = {};
   children = [];
   parent = null;
+  _enableInput = false;
+  get enableInput() {
+    return this._enableInput;
+  }
+  set enableInput(value) {
+    if (this._enableInput === value) return;
+    this._enableInput = value;
+    void this.updateEntityEvent("spatialtap", value).catch((err) => {
+      console.error("enableInput updateEntityEvent failed", "spatialtap", err);
+      if (this._enableInput === value) {
+        this._enableInput = !value;
+      }
+    });
+  }
   async addComponent(component) {
     return new AddComponentToEntityCommand(this, component).execute();
   }
@@ -2286,10 +2334,7 @@ var SpatialEntity = class _SpatialEntity extends SpatialObject {
     if (type === "objectdestroy" /* objectdestroy */) {
       this.isDestroyed = true;
     } else if (type === "spatialtap" /* spatialtap */) {
-      const evt = createSpatialEvent(
-        "spatialtap" /* spatialtap */,
-        data.detail
-      );
+      const evt = createSpatialEvent("spatialtap" /* spatialtap */, data.detail);
       this.dispatchEvent(evt);
     } else if (type === "spatialdragstart" /* spatialdragstart */) {
       const evt = createSpatialEvent(
@@ -2298,10 +2343,7 @@ var SpatialEntity = class _SpatialEntity extends SpatialObject {
       );
       this.dispatchEvent(evt);
     } else if (type === "spatialdrag" /* spatialdrag */) {
-      const evt = createSpatialEvent(
-        "spatialdrag" /* spatialdrag */,
-        data.detail
-      );
+      const evt = createSpatialEvent("spatialdrag" /* spatialdrag */, data.detail);
       this.dispatchEvent(evt);
     } else if (type === "spatialdragend" /* spatialdragend */) {
       const evt = createSpatialEvent(
@@ -2341,7 +2383,7 @@ var SpatialEntity = class _SpatialEntity extends SpatialObject {
     }
     this.events[evt.type]?.(evt);
     if (evt.bubbles && !evt.cancelBubble) {
-      if (this.parent && this.parent instanceof _SpatialEntity) {
+      if (this.parent) {
         this.parent.dispatchEvent(evt);
       }
     }
@@ -2704,6 +2746,7 @@ var SpatialSession = class {
 // src/Spatial.ts
 init_SpatialWebEvent();
 var Spatial = class {
+  wsAppShellVersionFromUA;
   /**
    * Requests a spatial session object from the browser.
    * This is the primary method to initialize spatial functionality.
@@ -2729,6 +2772,20 @@ var Spatial = class {
     }
     return false;
   }
+  getShellVersionFromUA() {
+    if (this.wsAppShellVersionFromUA !== void 0) {
+      return this.wsAppShellVersionFromUA;
+    }
+    if (typeof navigator === "undefined" || typeof navigator.userAgent !== "string") {
+      this.wsAppShellVersionFromUA = null;
+      return null;
+    }
+    const match = navigator.userAgent.match(
+      /WSAppShell\/(\d+(?:\.\d+){2}(?:[-+][0-9A-Za-z.-]+)*)/
+    );
+    this.wsAppShellVersionFromUA = match ? match[1] : "1.3.0";
+    return this.wsAppShellVersionFromUA;
+  }
   /** @deprecated
    * Checks if WebSpatial is supported in the current environment.
    * Verifies compatibility between native and client versions.
@@ -2746,7 +2803,7 @@ var Spatial = class {
     if (window.__WebSpatialData && window.__WebSpatialData.getNativeVersion) {
       return window.__WebSpatialData.getNativeVersion();
     }
-    return window.WebSpatailNativeVersion === "PACKAGE_VERSION" ? this.getClientVersion() : window.WebSpatailNativeVersion;
+    return window.WebSpatailNativeVersion === "WS_SHELL_VERSION" ? this.getClientVersion() : window.WebSpatailNativeVersion;
   }
   /** @deprecated
    * Gets the client SDK version.
@@ -2754,10 +2811,70 @@ var Spatial = class {
    * @returns Client SDK version string in format "x.x.x"
    */
   getClientVersion() {
-    return "1.3.0";
+    return "1.4.0";
   }
 };
 
+// src/physicalMetrics.ts
+var physicalMetrics_exports = {};
+__export(physicalMetrics_exports, {
+  getValue: () => getValue,
+  physicalToPoint: () => physicalToPoint,
+  pointToPhysical: () => pointToPhysical,
+  subscribe: () => subscribe
+});
+init_SpatialWebEvent();
+var snapshot = {
+  meterToPtUnscaled: 1360,
+  meterToPtScaled: 1360
+};
+function getWorldScalingCompensation(options) {
+  return options?.worldScalingCompensation ?? "scaled";
+}
+function pointToPhysical(point, options) {
+  updateValue();
+  const compensation = getWorldScalingCompensation(options);
+  if (compensation === "unscaled") {
+    return point / snapshot.meterToPtUnscaled;
+  }
+  return point / snapshot.meterToPtScaled;
+}
+function physicalToPoint(physical, options) {
+  updateValue();
+  const compensation = getWorldScalingCompensation(options);
+  if (compensation === "unscaled") {
+    return physical * snapshot.meterToPtUnscaled;
+  }
+  return physical * snapshot.meterToPtScaled;
+}
+function updateValue() {
+  if (typeof window === "undefined") return;
+  const src = window.__webspatialsdk__?.physicalMetrics;
+  if (!src) return;
+  const next = {
+    meterToPtScaled: src.meterToPtScaled ?? snapshot.meterToPtScaled,
+    meterToPtUnscaled: src.meterToPtUnscaled ?? snapshot.meterToPtUnscaled
+  };
+  if (next.meterToPtScaled !== snapshot.meterToPtScaled || next.meterToPtUnscaled !== snapshot.meterToPtUnscaled) {
+    snapshot = next;
+  }
+}
+function getValue() {
+  updateValue();
+  return snapshot;
+}
+function subscribe(cb) {
+  if (typeof window === "undefined") return () => {
+  };
+  const handler = () => {
+    cb();
+  };
+  SpatialWebEvent.addEventReceiver("window", handler);
+  return () => {
+    SpatialWebEvent.removeEventReceiver("window");
+  };
+}
+
 // src/index.ts
 init_ssr_polyfill();
 
@@ -2909,6 +3026,7 @@ export {
   BaseplateVisibilityValues,
   CubeInfo,
   ModelComponent,
+  physicalMetrics_exports as PhysicalMetrics,
   Spatial,
   SpatialBoxGeometry,
   SpatialComponent,