@webspatial/core-sdk 0.0.1 → 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @webspatial/core-sdk
+
+## 0.0.3
+
+### Patch Changes
+
+- ee36e07: add SpatialObject name to provide more infomation when debug
+
+## 0.0.2
+
+### Patch Changes
+
+- d15b125: update version
+
+## 0.0.1
+
+### Patch Changes
+
+- 456d15f: change ModelDragEvent to SpatialModelDragEvent in coresdk

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Spatial Web
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,112 @@
+# **Full API documentation**
+
+* [API Docs](https://github.com/webspatial/webspatial.github.io/blob/main/docs/globals.md)
+
+# **Introduction**
+
+The core-sdk library is responsible for interacting with the target platforms native APIs to expose behavior not commonly found on the web.
+
+# **Hello world example**
+
+```
+import { Spatial, SpatialHelper } from '@webspatial/core-sdk'
+
+var main = async () => {
+    var spatial = new Spatial()
+    var versionInfo = "clientVersion:" + spatial.getClientVersion() + "\nnativeVersion:" + spatial.getNativeVersion() + "\nisSupported:" + spatial.isSupported()
+    
+    let sh = SpatialHelper.instance!
+    if (sh) {
+        // Create a new window container
+        var container = await sh.session.createWindowContainer({ style: 'Volumetric' })
+        
+        // Setup volume for the entity
+        var rootEntity = await sh.session.createEntity()
+        await rootEntity.setCoordinateSpace("Root")
+        rootEntity.setComponent(await sh.session.createViewComponent())
+        
+        // Create a mesh. and add it tot the root volume
+        var box = await sh.shape.createShapeEntity("box")
+        await box.setParent(rootEntity)
+        
+        // add the volume to the window
+        await container.setRootEntity(rootEntity)
+    }
+}
+main()
+```
+
+# **Initialization**
+
+Create a new spatial object which is the root entry point to the API. This object should be available in standard browsers as well as webspatial environments. This object can check client and native versions of the library and detect if webspatial is available in this setup.
+
+```
+var spatial = new Spatial()
+if(spatial.isSupported()){
+  var session = spatial.requestSession()
+  if(session){
+    console.log("session supported and created")
+  }
+}
+```
+
+# **Async/Await/Promises**
+
+Due to the architecture of webspatial, the client library communicates to native code over a JS Bridge provided by the platform. Because of this, function calls may not be completed immediately. To accomidate this, the majority of webspatial api use [promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) to keep track of completion. It is recommended you create an async main function to allow you to use the await syntax for app setup.
+
+```
+var main = async ()=>{
+    // Your code goes here
+};
+main()'
+```
+
+# **WindowContainer**
+
+To create a new WindowContainer (aka WindowGroup on apple vision pro)
+
+```
+var windowContainer = await session.createWindowContainer({ style: 'Volumetric' })
+```
+
+Depending on if you want to display content as a panel or within a volume, you can choose to use "Plain" or "Volumetric" style.
+
+# **Entity/Component api**
+
+To start displaying content within a WindowContainer, you must create an entity.
+
+```
+// Create entity
+var entity = await session.createEntity()
+
+// Create component
+await entity.setComponent(
+    await session.createViewComponent({ windowContainer: windowContainer }),
+)
+await entity.setCoordinateSpace('Root')
+
+// Set root entity on the window container. 
+// Note the entity much have:
+// - Root coordinate space
+// - have a ViewComponent for Volumetric windowContainer
+// - have a WindowComponent for Plain windowContainer
+await windowContainer.setRootEntity(entity)
+```
+
+Entity maps to an object that will be displayed. Components tell how that object should be displayed.  
+You can find more examples here when you run the server locally:
+
+* http://localhost:5173/src/docsWebsite/index.html?examplePath=webElement
+
+# **Helper**
+
+This library, similar to (webGL or webXR) may be a bit too verbose to use directly. You can use the helper we provide to do some common tasks such as opening a new webpage panel or use our higher level react API.
+
+```
+import { SpatialHelper } from '@webspatial/core-sdk'
+SpatialHelper.instance.navigation.openPanel(
+    'https://www.npmjs.com/package/@webspatial/core-sdk',
+    { resolution: { width: 600, height: 100 } },
+)
+```
+

package/dist/core/SpatialEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpatialEntity.d.ts","sourceRoot":"","sources":["../../src/core/SpatialEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAEjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAE9C;;GAEG;AACH,qBAAa,aAAc,SAAQ,aAAa;IAC9C;;;OAGG;IACH,SAAS,mBAAyB;IAElC,cAAc;IACd,OAAO,CAAC,UAAU,CAAQ;IAC1B,cAAc;IACd,OAAO,KAAK,OAAO,GAElB;IAED;;OAEG;IACG,eAAe;IAIrB;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM;IAIjC,OAAO,CAAC,UAAU,CAA6C;IAE/D;;;OAGG;IACG,YAAY,CAAC,SAAS,EAAE,gBAAgB;IAK9C;;OAEG;IACG,eAAe,CAAC,CAAC,SAAS,gBAAgB,EAC9C,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC;IASjC;;OAEG;IACH,YAAY,CAAC,CAAC,SAAS,gBAAgB,EACrC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAC9B,CAAC,GAAG,SAAS;IAIhB;;;;OAIG;IACG,yBAAyB,CAAC,EAAE,EAAE,sBAAsB;IAM1D;;;OAGG;IACG,SAAS,CAAC,CAAC,EAAE,aAAa,GAAG,IAAI;IAMvC;;;;;;;OAOG;IACG,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM;IAItD;;;OAGG;IACG,cAAc;gBAKR;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE;iBAClC;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE;;IAIhD;;;OAGG;IACG,UAAU,CAAC,OAAO,EAAE,OAAO;IAIjC;;OAEG;IACG,OAAO;IAKb;;OAEG;IACH,WAAW;IAKX,cAAc;IACR,QAAQ,CAAC,IAAI,EAAE,MAAM;CAG5B"}
+{"version":3,"file":"SpatialEntity.d.ts","sourceRoot":"","sources":["../../src/core/SpatialEntity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAEjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAE9C;;GAEG;AACH,qBAAa,aAAc,SAAQ,aAAa;IAC9C;;;OAGG;IACH,SAAS,mBAAyB;IAElC,cAAc;IACd,OAAO,CAAC,UAAU,CAAQ;IAC1B,cAAc;IACd,OAAO,KAAK,OAAO,GAElB;IAED;;OAEG;IACG,eAAe;IAIrB;;OAEG;IACG,YAAY,CAAC,MAAM,EAAE,MAAM;IAIjC,OAAO,CAAC,UAAU,CAA6C;IAE/D;;;OAGG;IACG,YAAY,CAAC,SAAS,EAAE,gBAAgB;IAK9C;;OAEG;IACG,eAAe,CAAC,CAAC,SAAS,gBAAgB,EAC9C,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC;IASjC;;OAEG;IACH,YAAY,CAAC,CAAC,SAAS,gBAAgB,EACrC,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,GAC9B,CAAC,GAAG,SAAS;IAIhB;;;;OAIG;IACG,yBAAyB,CAAC,EAAE,EAAE,sBAAsB;IAM1D;;;OAGG;IACG,SAAS,CAAC,CAAC,EAAE,aAAa,GAAG,IAAI;IAMvC;;;;;;;OAOG;IACG,kBAAkB,CAAC,KAAK,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM;IAItD;;;OAGG;IACG,cAAc;gBAKR;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE;iBAClC;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE;;IAIhD;;;OAGG;IACG,UAAU,CAAC,OAAO,EAAE,OAAO;IAIjC;;OAEG;IACG,OAAO;IAKb;;OAEG;IACH,WAAW;IAKX,cAAc;IACR,QAAQ,CAAC,IAAI,EAAE,MAAM;CAI5B"}

package/dist/core/SpatialEntity.js

@@ -116,6 +116,7 @@ export class SpatialEntity extends SpatialObject {
     // Set Entity name. Currently for debugging only.
     /** @hidden */
     async _setName(name) {
+        this.name = name;
         return WebSpatial.updateResource(this._entity, { name });
     }
 }

package/dist/core/SpatialObject.d.ts

@@ -14,6 +14,7 @@ export declare class SpatialObject {
      * Marks resource to be released (it should no longer be used)
      */
     destroy(): Promise<void>;
+    name: string;
     protected onDestroy(): Promise<void>;
 }
 //# sourceMappingURL=SpatialObject.d.ts.map

package/dist/core/SpatialObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpatialObject.d.ts","sourceRoot":"","sources":["../../src/core/SpatialObject.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAEzD;;;GAGG;AACH,qBAAa,aAAa;IAGtB,cAAc;IACP,SAAS,EAAE,kBAAkB;IAHtC,cAAc;;IAEZ,cAAc;IACP,SAAS,EAAE,kBAAkB;IAGtC;;OAEG;IACG,OAAO;cAKG,SAAS;CAC1B"}
+{"version":3,"file":"SpatialObject.d.ts","sourceRoot":"","sources":["../../src/core/SpatialObject.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAEzD;;;GAGG;AACH,qBAAa,aAAa;IAGtB,cAAc;IACP,SAAS,EAAE,kBAAkB;IAHtC,cAAc;;IAEZ,cAAc;IACP,SAAS,EAAE,kBAAkB;IAGtC;;OAEG;IACG,OAAO;IAKN,IAAI,EAAE,MAAM,CAAK;cAER,SAAS;CAC1B"}

package/dist/core/SpatialObject.js

@@ -18,5 +18,6 @@ export class SpatialObject {
         await WebSpatial.destroyResource(this._resource);
         await this.onDestroy();
     }
+    name = '';
     async onDestroy() { }
 }

package/dist/core/SpatialSession.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpatialSession.d.ts","sourceRoot":"","sources":["../../src/core/SpatialSession.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAMjE,OAAO,EACL,iBAAiB,EACjB,cAAc,EAEd,WAAW,EACZ,MAAM,SAAS,CAAA;AAEhB,OAAO,EACL,mBAAmB,EACnB,sCAAsC,EACvC,MAAM,YAAY,CAAA;AACnB,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,aAAa,CAAA;AAGpB;;GAEG;AACH,KAAK,YAAY,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;AA4B/D;;GAEG;AACH,qBAAa,cAAc;IACzB,cAAc;IACd,sBAAsB,iBAAwB;IAC9C,cAAc;IACd,iBAAiB,UAAQ;IAEzB;;;OAGG;IACH,8BAA8B,CAAC,QAAQ,EAAE,YAAY;IAerD;;;OAGG;IACG,YAAY;IASlB;;;;OAIG;IACG,qBAAqB,CAAC,OAAO,CAAC,EAAE;QACpC,eAAe,CAAC,EAAE,sBAAsB,CAAA;KACzC;IAWD;;;OAGG;IACG,mBAAmB,CAAC,OAAO,CAAC,EAAE;QAClC,eAAe,CAAC,EAAE,sBAAsB,CAAA;KACzC;IAWD;;;OAGG;IACG,oBAAoB,CAAC,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE;IAcpD;;;OAGG;IACG,sBAAsB,CAAC,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE;IActD;;;;OAIG;IACG,oBAAoB;IAS1B;;;OAGG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;IAUrD;;;OAGG;IACG,qCAAqC,CAAC,OAAO,CAAC,EAAE,EAAE;IASxD;;;SAGK;IACC,qBAAqB,CAAC,OAAO,CAAC,EAAE;QACpC,KAAK,EAAE,WAAW,CAAA;QAClB,eAAe,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;QAC/C,eAAe,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KAChD;IAYD;;;;;;OAMG;IACG,YAAY,CAChB,KAAK,EAAE,WAAW,YAAU,EAC5B,GAAG,EAAE;QACH,SAAS,EAAE,cAAc,CAAA;KAC1B;IAKH;;;;OAIG;IACH,yBAAyB;IAIzB;;;OAGG;IACG,wBAAwB;IAgB9B;;;OAGG;IACG,GAAG,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE;IAIvB;;;OAGG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM;IAIvB;;;;OAIG;IACG,SAAS;iBACsC,GAAG;oBAAc,GAAG;;IAGzE;;OAEG;IACG,QAAQ,CAAC,eAAe,GAAE,MAA2C;IAI3E;;OAEG;IACG,2BAA2B;IAIjC,gCAAgC;IAC1B,kBAAkB;IAIxB,iCAAiC;IAC3B,qBAAqB;IAI3B,OAAO,CAAC,MAAM,CAAC,yBAAyB,CACD;IACvC;;;OAGG;IACG,2BAA2B;IAYjC,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAwC;IAE9E;;;;OAIG;IACH,yBAAyB;IAWzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,QAAQ;IAMxB;;;OAGG;IACG,mBAAmB;IAgCzB,cAAc;IACR,UAAU,CAAC,EAAE,EAAE,MAAM;IAoB3B,cAAc;IACR,UAAU,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,CAAC,EAAE,MAAM;CAG3D"}
+{"version":3,"file":"SpatialSession.d.ts","sourceRoot":"","sources":["../../src/core/SpatialSession.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAA;AAMjE,OAAO,EACL,iBAAiB,EACjB,cAAc,EAEd,WAAW,EACZ,MAAM,SAAS,CAAA;AAEhB,OAAO,EACL,mBAAmB,EACnB,sCAAsC,EACvC,MAAM,YAAY,CAAA;AACnB,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,uBAAuB,EACxB,MAAM,aAAa,CAAA;AAGpB;;GAEG;AACH,KAAK,YAAY,GAAG,CAAC,IAAI,EAAE,mBAAmB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;AA4B/D;;GAEG;AACH,qBAAa,cAAc;IACzB,cAAc;IACd,sBAAsB,iBAAwB;IAC9C,cAAc;IACd,iBAAiB,UAAQ;IAEzB;;;OAGG;IACH,8BAA8B,CAAC,QAAQ,EAAE,YAAY;IAerD;;;OAGG;IACG,YAAY;IASlB;;;;OAIG;IACG,qBAAqB,CAAC,OAAO,CAAC,EAAE;QACpC,eAAe,CAAC,EAAE,sBAAsB,CAAA;KACzC;IAWD;;;OAGG;IACG,mBAAmB,CAAC,OAAO,CAAC,EAAE;QAClC,eAAe,CAAC,EAAE,sBAAsB,CAAA;KACzC;IAWD;;;OAGG;IACG,oBAAoB,CAAC,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE;IAcpD;;;OAGG;IACG,sBAAsB,CAAC,OAAO,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE;IActD;;;;OAIG;IACG,oBAAoB;IAS1B;;;OAGG;IACG,kBAAkB,CAAC,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE;IAUrD;;;OAGG;IACG,qCAAqC,CAAC,OAAO,CAAC,EAAE,EAAE;IASxD;;;SAGK;IACC,qBAAqB,CAAC,OAAO,CAAC,EAAE;QACpC,KAAK,EAAE,WAAW,CAAA;QAClB,eAAe,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;QAC/C,eAAe,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAA;KAChD;IAYD;;;;;;OAMG;IACG,YAAY,CAChB,KAAK,EAAE,WAAW,YAAU,EAC5B,GAAG,EAAE;QACH,SAAS,EAAE,cAAc,CAAA;KAC1B;IAKH;;;;OAIG;IACH,yBAAyB;IAIzB;;;OAGG;IACG,wBAAwB;IAgB9B;;;OAGG;IACG,GAAG,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE;IAUvB;;;OAGG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM;IAIvB;;;;OAIG;IACG,SAAS;iBACsC,GAAG;oBAAc,GAAG;;IAGzE;;OAEG;IACG,QAAQ,CAAC,eAAe,GAAE,MAA2C;IAI3E;;OAEG;IACG,2BAA2B;IAIjC,gCAAgC;IAC1B,kBAAkB;IAIxB,iCAAiC;IAC3B,qBAAqB;IAI3B,OAAO,CAAC,MAAM,CAAC,yBAAyB,CACD;IACvC;;;OAGG;IACG,2BAA2B;IAYjC,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAwC;IAE9E;;;;OAIG;IACH,yBAAyB;IAWzB;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,QAAQ;IAMxB;;;OAGG;IACG,mBAAmB;IAgCzB,cAAc;IACR,UAAU,CAAC,EAAE,EAAE,MAAM;IAoB3B,cAAc;IACR,UAAU,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,CAAC,EAAE,MAAM;CAG3D"}

package/dist/core/SpatialSession.js

@@ -174,7 +174,11 @@ export class SpatialSession {
      * @param msg mesage to log
      */
     async log(...msg) {
-        await WebSpatial.sendCommand(new RemoteCommand('log', { logString: msg }));
+        await WebSpatial.sendCommand(new RemoteCommand('log', {
+            logString: msg.map(x => {
+                return JSON.stringify(x);
+            }),
+        }));
     }
     /**
      * @hidden

package/dist/core/component/SpatialModel3DComponent.d.ts

@@ -3,7 +3,7 @@ import { Vec3 } from '../SpatialTransform';
 /**
  * Translate event, matching similar behavior to https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/drag_event
  */
-export type ModelDragEvent = {
+export type SpatialModelDragEvent = {
     eventType: 'dragstart' | 'dragend' | 'drag';
     translation3D: Vec3;
     startLocation3D: Vec3;
@@ -57,19 +57,19 @@ export declare class SpatialModel3DComponent extends EventSpatialComponent {
      * @param dragEvent
      */
     private _onDragStart?;
-    set onDragStart(callback: ((dragEvent: ModelDragEvent) => void) | undefined);
+    set onDragStart(callback: ((dragEvent: SpatialModelDragEvent) => void) | undefined);
     /**
      * Callback fired when model was dragged
      * @param dragEvent
      */
     private _onDrag?;
-    set onDrag(callback: ((dragEvent: ModelDragEvent) => void) | undefined);
+    set onDrag(callback: ((dragEvent: SpatialModelDragEvent) => void) | undefined);
     /**
      * Callback fired when model was dragged at the ending
      * @param dragEvent
      */
     private _onDragEnd?;
-    set onDragEnd(callback: ((dragEvent: ModelDragEvent) => void) | undefined);
+    set onDragEnd(callback: ((dragEvent: SpatialModelDragEvent) => void) | undefined);
     private get enableDragEvent();
     /**
      * Callback fired when model was tapped

package/dist/core/component/SpatialModel3DComponent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SpatialModel3DComponent.d.ts","sourceRoot":"","sources":["../../../src/core/component/SpatialModel3DComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,CAAA;IAC3C,aAAa,EAAE,IAAI,CAAA;IACnB,eAAe,EAAE,IAAI,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,SAAS,EAAE,KAAK,CAAA;CACjB,CAAA;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;cAC7C,WAAW,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAiC/C;;OAEG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAM3C,iBAAiB,CAAC,cAAc,EAAE,IAAI;IAM5C;;;OAGG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM;IAMhC;;;OAGG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK;IAMhD;;;;;OAKG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM;IAMxC;;;OAGG;IACG,YAAY,CAAC,SAAS,EAAE,OAAO;IAMrC;;OAEG;IACI,SAAS,CAAC,EAAE,MAAM,IAAI,CAAA;IAE7B;;;OAGG;IACI,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAA;IAEhD;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAC,CAAqC;IAC1D,IAAW,WAAW,CACpB,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,cAAc,KAAK,IAAI,CAAC,GAAG,SAAS,EAQ5D;IAED;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAC,CAAqC;IACrD,IAAW,MAAM,CACf,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,cAAc,KAAK,IAAI,CAAC,GAAG,SAAS,EAQ5D;IAED;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAC,CAAqC;IACxD,IAAW,SAAS,CAClB,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,cAAc,KAAK,IAAI,CAAC,GAAG,SAAS,EAQ5D;IAED,OAAO,KAAK,eAAe,GAM1B;IAED;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,CAAY;IAC3B,IAAW,KAAK,CAAC,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAOlD;IAED,kDAAkD;IAClD,OAAO,CAAC,YAAY,CAAC,CAAY;IACjC,IAAW,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAOxD;IAED,iDAAiD;IACjD,OAAO,CAAC,YAAY,CAAC,CAAY;IACjC,IAAW,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAOxD;CACF"}
+{"version":3,"file":"SpatialModel3DComponent.d.ts","sourceRoot":"","sources":["../../../src/core/component/SpatialModel3DComponent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,EAAE,WAAW,GAAG,SAAS,GAAG,MAAM,CAAA;IAC3C,aAAa,EAAE,IAAI,CAAA;IACnB,eAAe,EAAE,IAAI,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,SAAS,EAAE,KAAK,CAAA;CACjB,CAAA;AAED;;GAEG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;cAC7C,WAAW,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAiC/C;;OAEG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAM3C,iBAAiB,CAAC,cAAc,EAAE,IAAI;IAM5C;;;OAGG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM;IAMhC;;;OAGG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK;IAMhD;;;;;OAKG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM;IAMxC;;;OAGG;IACG,YAAY,CAAC,SAAS,EAAE,OAAO;IAMrC;;OAEG;IACI,SAAS,CAAC,EAAE,MAAM,IAAI,CAAA;IAE7B;;;OAGG;IACI,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,IAAI,CAAA;IAEhD;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAC,CAA4C;IACjE,IAAW,WAAW,CACpB,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,qBAAqB,KAAK,IAAI,CAAC,GAAG,SAAS,EAQnE;IAED;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAC,CAA4C;IAC5D,IAAW,MAAM,CACf,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,qBAAqB,KAAK,IAAI,CAAC,GAAG,SAAS,EAQnE;IAED;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAC,CAA4C;IAC/D,IAAW,SAAS,CAClB,QAAQ,EAAE,CAAC,CAAC,SAAS,EAAE,qBAAqB,KAAK,IAAI,CAAC,GAAG,SAAS,EAQnE;IAED,OAAO,KAAK,eAAe,GAM1B;IAED;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,CAAY;IAC3B,IAAW,KAAK,CAAC,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAOlD;IAED,kDAAkD;IAClD,OAAO,CAAC,YAAY,CAAC,CAAY;IACjC,IAAW,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAOxD;IAED,iDAAiD;IACjD,OAAO,CAAC,YAAY,CAAC,CAAY;IACjC,IAAW,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,EAOxD;CACF"}

package/dist/core/component/index.d.ts

@@ -3,5 +3,5 @@ export { SpatialWindowComponent, type BackgroundMaterialType, type StyleParam, t
 export { SpatialInputComponent } from './SpatialInputComponent';
 export { SpatialModelComponent } from './SpatialModelComponent';
 export { SpatialViewComponent } from './SpatialViewComponent';
-export { SpatialModel3DComponent, type ModelDragEvent, } from './SpatialModel3DComponent';
+export { SpatialModel3DComponent, type SpatialModelDragEvent, } from './SpatialModel3DComponent';
 //# sourceMappingURL=index.d.ts.map

package/dist/core/component/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/component/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EACL,sBAAsB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,YAAY,GAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EACL,uBAAuB,EACvB,KAAK,cAAc,GACpB,MAAM,2BAA2B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/component/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EACL,sBAAsB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EACf,KAAK,YAAY,GAClB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EACL,uBAAuB,EACvB,KAAK,qBAAqB,GAC3B,MAAM,2BAA2B,CAAA"}

package/package.json

@@ -1,19 +1,11 @@
 {
   "name": "@webspatial/core-sdk",
-  "version": "0.0.1",
-  "description": "",
+  "version": "0.0.3",
+  "description": "this is runtime for webspatial",
   "main": "dist/index.js",
   "types": "dist/index.d.js",
   "type": "module",
   "sideEffects": false,
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc",
-    "start": "tsc --watch",
-    "buildIife": "esbuild dist/index.js --outdir=dist/iife --minify --bundle --format=iife --global-name=webspatialRuntime",
-    "format": "npx prettier --write 'src/**/*.ts' 'src/**/*.tsx' || true",
-    "genDocs": "typedoc --plugin typedoc-plugin-markdown src/core/index.ts"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/webspatial/webspatial-sdk.git"
@@ -31,5 +23,13 @@
   },
   "dependencies": {
     "loglevel": "^1.9.2"
+  },
+  "scripts": {
+    "test": "tsc -p ./tsconfig.json",
+    "build": "tsc",
+    "start": "tsc --watch",
+    "buildIife": "esbuild dist/index.js --outdir=dist/iife --minify --bundle --format=iife --global-name=webspatialRuntime",
+    "format": "npx prettier --write 'src/**/*.ts' 'src/**/*.tsx' || true",
+    "genDocs": "typedoc --plugin typedoc-plugin-markdown src/core/index.ts"
   }
-}
+}

package/src/core/SpatialEntity.ts

@@ -141,6 +141,7 @@ export class SpatialEntity extends SpatialObject {
   // Set Entity name. Currently for debugging only.
   /** @hidden */
   async _setName(name: string) {
+    this.name = name
     return WebSpatial.updateResource(this._entity, { name })
   }
 }

package/src/core/SpatialObject.ts

@@ -20,5 +20,7 @@ export class SpatialObject {
     await this.onDestroy()
   }
 
+  public name: string = ''
+
   protected async onDestroy() {}
 }

package/src/core/SpatialSession.ts

@@ -279,7 +279,13 @@ export class SpatialSession {
    * @param msg mesage to log
    */
   async log(...msg: any[]) {
-    await WebSpatial.sendCommand(new RemoteCommand('log', { logString: msg }))
+    await WebSpatial.sendCommand(
+      new RemoteCommand('log', {
+        logString: msg.map(x => {
+          return JSON.stringify(x)
+        }),
+      }),
+    )
   }
 
   /**

package/src/core/component/SpatialModel3DComponent.ts

@@ -5,7 +5,7 @@ import { Vec3 } from '../SpatialTransform'
 /**
  * Translate event, matching similar behavior to https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/drag_event
  */
-export type ModelDragEvent = {
+export type SpatialModelDragEvent = {
   eventType: 'dragstart' | 'dragend' | 'drag'
   translation3D: Vec3
   startLocation3D: Vec3
@@ -124,9 +124,9 @@ export class SpatialModel3DComponent extends EventSpatialComponent {
    * Callback fired when model was dragged at the beginning
    * @param dragEvent
    */
-  private _onDragStart?: (dragEvent: ModelDragEvent) => void
+  private _onDragStart?: (dragEvent: SpatialModelDragEvent) => void
   public set onDragStart(
-    callback: ((dragEvent: ModelDragEvent) => void) | undefined,
+    callback: ((dragEvent: SpatialModelDragEvent) => void) | undefined,
   ) {
     if (this._onDragStart !== callback) {
       this._onDragStart = callback
@@ -140,9 +140,9 @@ export class SpatialModel3DComponent extends EventSpatialComponent {
    * Callback fired when model was dragged
    * @param dragEvent
    */
-  private _onDrag?: (dragEvent: ModelDragEvent) => void
+  private _onDrag?: (dragEvent: SpatialModelDragEvent) => void
   public set onDrag(
-    callback: ((dragEvent: ModelDragEvent) => void) | undefined,
+    callback: ((dragEvent: SpatialModelDragEvent) => void) | undefined,
   ) {
     if (this._onDrag !== callback) {
       this._onDrag = callback
@@ -156,9 +156,9 @@ export class SpatialModel3DComponent extends EventSpatialComponent {
    * Callback fired when model was dragged at the ending
    * @param dragEvent
    */
-  private _onDragEnd?: (dragEvent: ModelDragEvent) => void
+  private _onDragEnd?: (dragEvent: SpatialModelDragEvent) => void
   public set onDragEnd(
-    callback: ((dragEvent: ModelDragEvent) => void) | undefined,
+    callback: ((dragEvent: SpatialModelDragEvent) => void) | undefined,
   ) {
     if (this._onDragEnd !== callback) {
       this._onDragEnd = callback

package/src/core/component/index.ts

@@ -10,5 +10,5 @@ export { SpatialModelComponent } from './SpatialModelComponent'
 export { SpatialViewComponent } from './SpatialViewComponent'
 export {
   SpatialModel3DComponent,
-  type ModelDragEvent,
+  type SpatialModelDragEvent,
 } from './SpatialModel3DComponent'