@webspatial/core-sdk 1.4.0 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webspatial/core-sdk",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "this is the core js API for webspatial",
   "main": "dist/index.js",
   "module": "dist/index.js",

package/src/JSBCommand.ts

@@ -2,6 +2,7 @@ import { createPlatform } from './platform-adapter'
 import { WebSpatialProtocolResult } from './platform-adapter/interface'
 import { SpatialComponent } from './reality/component/SpatialComponent'
 import { SpatialEntity } from './reality/entity/SpatialEntity'
+import { SpatialMaterial } from './reality/material/SpatialMaterial'
 import { SpatializedDynamic3DElement } from './SpatializedDynamic3DElement'
 import { SpatializedElement } from './SpatializedElement'
 import { SpatialObject } from './SpatialObject'
@@ -386,6 +387,38 @@ export class AddComponentToEntityCommand extends JSBCommand {
   commandType = 'AddComponentToEntity'
 }
 
+export class RemoveComponentFromEntityCommand extends JSBCommand {
+  constructor(
+    public entity: SpatialEntity,
+    public comp: SpatialComponent,
+  ) {
+    super()
+  }
+  protected getParams(): Record<string, any> | undefined {
+    return {
+      entityId: this.entity.id,
+      componentId: this.comp.id,
+    }
+  }
+  commandType = 'RemoveComponentFromEntity'
+}
+
+export class SetMaterialsOnEntityCommand extends JSBCommand {
+  constructor(
+    public entityId: string,
+    public materials: SpatialMaterial[],
+  ) {
+    super()
+  }
+  protected getParams(): Record<string, any> | undefined {
+    return {
+      entityId: this.entityId,
+      materialIds: this.materials.map(m => m.id),
+    }
+  }
+  commandType = 'SetMaterialsOnEntity'
+}
+
 export class AddEntityToDynamic3DCommand extends JSBCommand {
   constructor(
     public d3dEle: SpatializedDynamic3DElement,

package/src/platform-adapter/index.ts

@@ -40,8 +40,8 @@ export function createPlatform(): PlatformAbility {
     userAgent.includes('PicoWebApp') &&
     isVersionGreater(webSpatialVersion, [0, 0, 1])
   ) {
-    const XRPlatform = require('./xr/XRPlatform').XRPlatform
-    return new XRPlatform()
+    const PicoOSPlatform = require('./pico-os/PicoOSPlatform').PicoOSPlatform
+    return new PicoOSPlatform()
   } else if (userAgent.includes('Android') || userAgent.includes('Linux')) {
     const AndroidPlatform = require('./android/AndroidPlatform').AndroidPlatform
     return new AndroidPlatform()

package/src/platform-adapter/{xr/XRPlatform.ts → pico-os/PicoOSPlatform.ts}

@@ -23,9 +23,10 @@ function nextRequestId() {
   return `rId_${requestId}`
 }
 
-export class XRPlatform implements PlatformAbility {
+// Only supports Pico OS 6
+export class PicoOSPlatform implements PlatformAbility {
   async callJSB(cmd: string, msg: string): Promise<CommandResult> {
-    // android JS Bridge interface only support sync invoking
+    // swan JS Bridge interface only support sync invoking
     // in order to implement promise API, register every request by requestId and remove when resolve/reject.
     return new Promise((resolve, reject) => {
       try {
@@ -54,7 +55,7 @@ export class XRPlatform implements PlatformAbility {
           }
         }
       } catch (error: unknown) {
-        console.error(`XRPlatform cmd: ${cmd}, msg: ${msg} error: ${error}`)
+        console.error(`SwanPlatform cmd: ${cmd}, msg: ${msg} error: ${error}`)
         const { code, message } = error as JSBError
         resolve(CommandResultFailure(code, message))
       }
@@ -75,7 +76,6 @@ export class XRPlatform implements PlatformAbility {
         SpatialWebEvent.addEventReceiver(
           createdId,
           (result: { spatialId: string }) => {
-            console.log('createdId', createdId, result.spatialId)
             resolve(
               CommandResultSuccess({
                 windowProxy: windowProxy,
@@ -87,13 +87,11 @@ export class XRPlatform implements PlatformAbility {
         )
         windowProxy = this.openWindow(
           command,
-          query,
+          'rid=' + createdId,
           target,
           features,
         ).windowProxy
-        windowProxy?.open(`about:blank?rid=${createdId}`, '_self')
       } catch (error: unknown) {
-        console.error(`open window error: ${error}`)
         const { code, message } = error as JSBError
         SpatialWebEvent.removeEventReceiver(createdId)
         resolve(CommandResultFailure(code, message))

package/src/reality/entity/SpatialEntity.ts

@@ -13,6 +13,7 @@ import {
 import {
   AddComponentToEntityCommand,
   AddEntityToEntityCommand,
+  RemoveComponentFromEntityCommand,
   RemoveEntityFromParentCommand,
   UpdateEntityEventCommand,
   UpdateEntityPropertiesCommand,
@@ -79,6 +80,9 @@ export class SpatialEntity extends SpatialObject {
   async addComponent(component: SpatialComponent) {
     return new AddComponentToEntityCommand(this, component).execute()
   }
+  async removeComponent(component: SpatialComponent) {
+    return new RemoveComponentFromEntityCommand(this, component).execute()
+  }
   async setPosition(position: Vec3) {
     return this.updateTransform({ position })
   }

package/src/reality/entity/SpatialModelEntity.ts

@@ -2,6 +2,8 @@ import {
   SpatialEntityUserData,
   SpatialModelEntityCreationOptions,
 } from '../../types/types'
+import { SetMaterialsOnEntityCommand } from '../../JSBCommand'
+import { SpatialMaterial } from '../material/SpatialMaterial'
 import { SpatialEntity } from './SpatialEntity'
 
 export class SpatialModelEntity extends SpatialEntity {
@@ -12,4 +14,8 @@ export class SpatialModelEntity extends SpatialEntity {
   ) {
     super(id, userData)
   }
+
+  async setMaterials(materials: SpatialMaterial[]) {
+    return new SetMaterialsOnEntityCommand(this.id, materials).execute()
+  }
 }

package/src/scene-polyfill.ts

@@ -76,6 +76,18 @@ class SceneManager {
   private open = (url?: string, target?: string, features?: string) => {
     // bypass internal
     if (url?.startsWith(INTERNAL_SCHEMA_PREFIX)) {
+      if (url.includes('createSpatialized2DElement')) {
+        const token = window.webSpatial?.genToken?.()
+        if (token) {
+          const host = window.location.host
+          const protocol = window.location.protocol
+          const finalURL = `${protocol}//${host}/${token}/?command=createSpatialized2DElement`
+          const rid = new URL(url).searchParams.get('rid')
+          const final = new URL(finalURL)
+          if (rid) final.searchParams.set('rid', rid)
+          return this.originalOpen(final.toString(), target, features)
+        }
+      }
       return this.originalOpen(url, target, features)
     }
 

package/src/types/global.d.ts

@@ -22,6 +22,11 @@ declare global {
     webkit: any
     webspatialBridge: any
 
+    // Project Pico OS browser injects this global object to provide internal capabilities.
+    webSpatial?: {
+      genToken?: () => string
+    }
+
     // Will be removed in favor of __WebSpatialData
     WebSpatailNativeVersion: string