@webspatial/platform-visionos 1.0.4 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webspatial/platform-visionos",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "Used to publish WebSpatial projects to Apple Vision Pro",
   "type": "commonjs",
   "engines": {
@@ -19,7 +19,7 @@
     "package.json"
   ],
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "dependencies": {},
   "devDependencies": {},
   "publishConfig": {

package/web-spatial/EventEmitter.swift

@@ -0,0 +1,56 @@
+class EventEmitter {
+    private var listeners: [String: [(_ object: Any, _ data: Any) -> Void]] = [:]
+
+    public func on(event: String, listener: @escaping (_ object: Any, _ data: Any) -> Void) {
+        if listeners[event] == nil {
+            listeners[event] = []
+        }
+        listeners[event]?.append(listener)
+    }
+
+    public func emit(event: String, data: Any) {
+        listeners[event]?.forEach { listener in
+            listener(self, data)
+        }
+    }
+
+    public func off(event: String, listener: @escaping (_ object: Any, _ data: Any) -> Void) {
+        listeners[event]?.removeAll(where: { $0 as AnyObject === listener as AnyObject })
+    }
+    
+    public func reset(){
+        listeners = [:]
+    }
+}
+
+protocol EventEmitterProtocol{
+    var listeners: [String: [(_ object: Any, _ data: Any) -> Void]] {get set}
+    
+    mutating func on(event: String, listener: @escaping (_ object: Any, _ data: Any) -> Void)
+    func emit(event: String, data: Any)
+    mutating func off(event: String, listener: @escaping (_ object: Any, _ data: Any) -> Void)
+    mutating func reset()
+}
+
+extension EventEmitterProtocol{
+    mutating func on(event: String, listener: @escaping (_ object: Any, _ data: Any) -> Void) {
+        if listeners[event] == nil {
+            listeners[event] = []
+        }
+        listeners[event]?.append(listener)
+    }
+
+    func emit(event: String, data: Any) {
+        listeners[event]?.forEach { listener in
+            listener(self, data)
+        }
+    }
+
+    mutating func off(event: String, listener: @escaping (_ object: Any, _ data: Any) -> Void) {
+        listeners[event]?.removeAll(where: { $0 as AnyObject === listener as AnyObject })
+    }
+    
+    mutating func reset(){
+        listeners = [:]
+    }
+}

package/web-spatial/JSBCommand.swift

@@ -0,0 +1,348 @@
+import SwiftUI
+
+struct UpdateSpatialSceneProperties: CommandDataProtocol {
+    static let commandType: String = "UpdateSpatialSceneProperties"
+    let cornerRadius: CornerRadius?
+    let material: BackgroundMaterial?
+    let opacity: Double?
+}
+
+struct AddSpatializedElementToSpatialScene: CommandDataProtocol {
+    static let commandType: String = "AddSpatializedElementToSpatialScene"
+    let spatializedElementId: String
+}
+
+struct CreateSpatializedStatic3DElement: CommandDataProtocol {
+    static let commandType: String = "CreateSpatializedStatic3DElement"
+    let modelURL: String
+}
+
+struct CreateSpatializedDynamic3DElement: CommandDataProtocol{
+    static let commandType: String = "CreateSpatializedDynamic3DElement"
+    let test: Bool
+}
+
+struct CreateSpatialEntity: CommandDataProtocol{
+    static let commandType: String = "CreateSpatialEntity"
+    let name: String?
+}
+
+struct CreateGeometryProperties: CommandDataProtocol{
+    static let commandType: String = "CreateGeometry"
+    let type: String
+    let width: Float?
+    let height: Float?
+    let depth: Float?
+    let cornerRadius: Float?
+    let splitFaces: Bool?
+    let radius: Float?
+}
+
+struct CreateUnlitMaterial: CommandDataProtocol{
+    static let commandType: String = "CreateUnlitMaterial"
+    let color: String?
+    let textureId: String?
+    let transparent: Bool?
+    let opacity: Float?
+}
+
+struct CreateTexture: CommandDataProtocol{
+    static let commandType: String = "CreateTexture"
+    let url: String
+}
+
+struct CreateModelAsset: CommandDataProtocol{
+    static let commandType: String = "CreateModelAsset"
+    let url: String
+}
+
+struct CreateSpatialModelEntity: CommandDataProtocol{
+    static let commandType: String = "CreateSpatialModelEntity"
+    let modelAssetId:String
+    let name:String?
+}
+
+struct CreateModelComponent: CommandDataProtocol{
+    static let commandType: String = "CreateModelComponent"
+    let geometryId: String
+    let materialIds: [String]
+}
+
+struct AddComponentToEntity: CommandDataProtocol{
+    static let commandType: String = "AddComponentToEntity"
+    let entityId: String
+    let componentId: String
+}
+
+struct AddEntityToDynamic3D: CommandDataProtocol{
+    static let commandType: String = "AddEntityToDynamic3D"
+    let dynamic3dId: String
+    let entityId: String
+}
+
+struct AddEntityToEntity: CommandDataProtocol{
+    static let commandType: String = "AddEntityToEntity"
+    let childId: String
+    let parentId: String
+}
+
+struct SetParentForEntity: CommandDataProtocol{
+    static let commandType: String = "SetParentToEntity"
+    let childId: String
+    let parentId: String?
+}
+
+struct RemoveEntityFromParent: CommandDataProtocol{
+    static let commandType: String = "RemoveEntityFromParent"
+    let entityId: String
+}
+
+struct UpdateEntityProperties: CommandDataProtocol{
+    static let commandType: String = "UpdateEntityProperties"
+    let entityId: String
+    let transform: [String:Float]
+}
+
+struct UpdateEntityEvent: CommandDataProtocol{
+    static let commandType: String = "UpdateEntityEvent"
+    let type: String
+    let entityId: String
+    let isEnable:Bool
+}
+
+struct ConvertFromEntityToEntity: CommandDataProtocol{
+    static let commandType: String = "ConvertFromEntityToEntity"
+    let fromEntityId: String
+    let toEntityId: String
+    let position:Vec3
+}
+
+struct ConvertFromEntityToScene: CommandDataProtocol{
+    static let commandType: String = "ConvertFromEntityToScene"
+    let fromEntityId: String
+    let position:Vec3
+}
+
+struct ConvertFromSceneToEntity: CommandDataProtocol{
+    static let commandType: String = "ConvertFromSceneToEntity"
+    let entityId: String
+    let position:Vec3
+}
+
+struct InspectCommand: CommandDataProtocol {
+    static let commandType: String = "Inspect"
+    var id: String?
+}
+
+protocol SpatialObjectCommand: CommandDataProtocol {
+    var id: String { get }
+}
+
+struct DestroyCommand: CommandDataProtocol {
+    static let commandType: String = "Destroy"
+    var id: String
+}
+
+protocol SpatializedElementProperties: SpatialObjectCommand {
+    var name: String? { get }
+    var clientX: Double? { get }
+    var clientY: Double? { get }
+    var width: Double? { get }
+    var height: Double? { get }
+    var depth: Double? { get }
+    var backOffset: Double? { get }
+    var rotationAnchor: Vec3? { get }
+    var opacity: Double? { get }
+    var visible: Bool? { get }
+    var scrollWithParent: Bool? { get }
+    var zIndex: Double? { get }
+    
+    var enableDragStartGesture: Bool? { get }
+    var enableDragGesture: Bool? { get }
+    var enableDragEndGesture: Bool? { get }
+    
+    var enableRotateStartGesture: Bool? { get }
+    var enableRotateGesture: Bool? { get }
+    var enableRotateEndGesture: Bool? { get }
+    var enableMagnifyStartGesture: Bool? { get }
+    var enableMagnifyGesture: Bool? { get }
+    var enableMagnifyEndGesture: Bool? { get }
+    var enableTapGesture: Bool? { get }
+}
+
+struct UpdateSpatialized2DElementProperties: SpatializedElementProperties {
+    static let commandType: String = "UpdateSpatialized2DElementProperties"
+    let id: String
+    let name: String?
+    var clientX: Double?
+    var clientY: Double?
+    let width: Double?
+    let height: Double?
+    let depth: Double?
+    let backOffset: Double?
+    let rotationAnchor: Vec3?
+    let opacity: Double?
+    let visible: Bool?
+    let scrollWithParent: Bool?
+    let zIndex: Double?
+    
+    var enableDragStartGesture: Bool?
+    var enableDragGesture: Bool?
+    var enableDragEndGesture: Bool?
+    var enableRotateStartGesture: Bool?
+    var enableRotateGesture: Bool?
+    var enableRotateEndGesture: Bool?
+    var enableMagnifyStartGesture: Bool?
+    var enableMagnifyGesture: Bool?
+    var enableMagnifyEndGesture: Bool?
+    var enableTapGesture: Bool?  
+    
+    let scrollPageEnabled: Bool?
+    let material: BackgroundMaterial?
+    let cornerRadius: CornerRadius?
+    
+    // this value is used by previous WebSpatial code, keep it here only for Compatibility consideration
+    // may delete it when we think it's not needed
+    let scrollEdgeInsetsMarginRight: Double?
+}
+
+struct UpdateSpatializedStatic3DElementProperties: SpatializedElementProperties {
+    static let commandType: String = "UpdateSpatializedStatic3DElementProperties"
+    let id: String
+    let name: String?
+    var clientX: Double?
+    var clientY: Double?  
+    let width: Double?
+    let height: Double?
+    let depth: Double?
+    let backOffset: Double?
+    let rotationAnchor: Vec3?
+    let opacity: Double?
+    let visible: Bool?
+    let scrollWithParent: Bool?
+    let zIndex: Double?
+    
+    var enableDragStartGesture: Bool?
+    let enableDragGesture: Bool?
+    let enableDragEndGesture: Bool?
+    var enableRotateStartGesture: Bool?
+    let enableRotateGesture: Bool?
+    let enableRotateEndGesture: Bool?
+    var enableMagnifyStartGesture: Bool?
+    let enableMagnifyGesture: Bool?
+    let enableMagnifyEndGesture: Bool?
+    let enableTapGesture: Bool?
+
+    let modelURL: String?
+    let modelTransform: [Double]?
+}
+
+struct UpdateSpatializedDynamic3DElementProperties: SpatializedElementProperties {
+    static let commandType: String = "UpdateSpatializedDynamic3DElementProperties"
+    let id: String
+    let name: String?
+    var clientX: Double?
+    var clientY: Double?
+    let width: Double?
+    let height: Double?
+    let depth: Double?
+    let backOffset: Double?
+    let rotationAnchor: Vec3?
+    let opacity: Double?
+    let visible: Bool?
+    let scrollWithParent: Bool?
+    let zIndex: Double?
+    
+    var enableDragStartGesture: Bool?
+    let enableDragGesture: Bool?
+    let enableDragEndGesture: Bool?
+    var enableRotateStartGesture: Bool?
+    let enableRotateGesture: Bool?
+    let enableRotateEndGesture: Bool?
+    var enableMagnifyStartGesture: Bool?
+    let enableMagnifyGesture: Bool?
+    let enableMagnifyEndGesture: Bool?
+    let enableTapGesture: Bool?
+}
+
+struct UpdateSpatializedElementTransform: SpatialObjectCommand {
+    static let commandType: String = "UpdateSpatializedElementTransform"
+    let id: String
+    let matrix: [Double]
+}
+
+struct AddSpatializedElementToSpatialized2DElement: SpatialObjectCommand {
+    static let commandType: String = "AddSpatializedElementToSpatialized2DElement"
+    let id: String
+    let spatializedElementId: String
+}
+
+// incomming JSB data
+struct XSceneOptionsJSB: Codable {
+    let defaultSize: Size?
+    let type: SpatialScene.WindowStyle?
+    let resizability: ResizeRange?
+    let worldScaling: WorldScalingJSB?
+    let worldAlignment: WorldAlignmentJSB?
+    let baseplateVisibility: BaseplateVisibilityJSB?
+}
+
+enum BaseplateVisibilityJSB: String, Codable {
+    case automatic
+    case visible
+    case hidden
+    
+    var toSDK: Visibility {
+        switch self {
+            case .automatic: return .automatic
+            case .visible: return .visible
+            case .hidden: return .hidden
+        }
+    }
+}
+
+enum WorldScalingJSB: String, Codable {
+    case automatic
+    case dynamic
+    
+    var toSDK: WorldScalingBehavior {
+        switch self {
+            case .automatic: return .automatic
+            case .dynamic: return .dynamic
+        }
+    }
+}
+
+enum WorldAlignmentJSB: String, Codable {
+    case adaptive
+    case automatic
+    case gravityAligned
+    
+    var toSDK: WorldAlignmentBehavior {
+        switch self {
+            case .adaptive: return .adaptive
+            case .automatic: return .automatic
+            case .gravityAligned: return .gravityAligned
+        }
+    }
+}
+
+struct UpdateSceneConfigCommand: CommandDataProtocol {
+    static let commandType = "UpdateSceneConfig"
+    let config: XSceneOptionsJSB
+    init(_ data: XSceneOptionsJSB) {
+        config = data
+    }
+}
+
+struct FocusSceneCommand: CommandDataProtocol {
+    static let commandType = "FocusScene"
+    let id: String
+    init(_ id: String) {
+        self.id = id
+    }
+}
+
+struct GetSpatialSceneStateCommand: CommandDataProtocol {
+    static let commandType = "GetSpatialSceneState"
+}

package/web-spatial/SpatialObject.swift

@@ -0,0 +1,108 @@
+import Foundation
+
+protocol SpatialObjectProtocol: Encodable, Equatable, EventEmitterProtocol {
+    var spatialId: String { get }
+    func destroy()
+}
+
+class WeakReference<T: AnyObject> {
+    weak var value: T?
+
+    init(_ value: T) {
+        self.value = value
+    }
+}
+
+class SpatialObjectWeakRefManager {
+    static var weakRefObjects = [String: WeakReference<AnyObject>]()
+    
+    static func setWeakRef<T: AnyObject>(_ id: String, _ object: T) {
+        weakRefObjects[id] = WeakReference(object as AnyObject)
+    }
+    
+    static func getWeakRef(_ id: String) -> AnyObject? {
+        return weakRefObjects[id]?.value
+    }
+    
+    static func removeWeakRef(_ id: String) {
+        weakRefObjects.removeValue(forKey: id)
+    }
+}
+
+class SpatialObject: SpatialObjectProtocol {
+    internal var listeners: [String : [(Any, Any) -> Void]] = [:]
+    static var objects = [String: (any SpatialObjectProtocol)]()
+    
+    static func get(_ id: String) -> (any SpatialObjectProtocol)? {
+        return objects[id]
+    }
+
+    static func getRefObject(_ id: String) -> SpatialObject? {
+        return SpatialObjectWeakRefManager.getWeakRef(id) as? SpatialObject
+    }
+
+    let spatialId: String
+    var name: String = ""
+    let id: String
+
+    private var _isDestroyed = false
+
+    var isDestroyed: Bool {
+        _isDestroyed
+    }
+
+    enum CodingKeys: String, CodingKey {
+        case id, name, isDestroyed
+    }
+
+    func encode(to encoder: any Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(spatialId, forKey: .id)
+        try container.encode(name, forKey: .name)
+        try container.encode(isDestroyed, forKey: .isDestroyed)
+    }
+
+    static func == (lhs: SpatialObject, rhs: SpatialObject) -> Bool {
+        return lhs.spatialId == rhs.spatialId
+    }
+
+    init() {
+        spatialId = UUID().uuidString
+        id = spatialId
+        SpatialObject.objects[spatialId] = self
+        SpatialObjectWeakRefManager.setWeakRef(spatialId, self)
+    }
+
+    init(_ _id: String) {
+        spatialId = _id
+        id = spatialId
+        SpatialObject.objects[spatialId] = self
+        SpatialObjectWeakRefManager.setWeakRef(spatialId, self)
+    }
+
+    deinit {
+        SpatialObjectWeakRefManager.removeWeakRef(spatialId)
+    }
+
+    enum Events: String {
+        case BeforeDestroyed = "SpatialObject::BeforeDestroyed"
+        case Destroyed = "SpatialObject::Destroyed"
+    }
+
+    func destroy() {
+        if _isDestroyed {
+            logger.warning("SpatialObject already destroyed \(self)")
+            return
+        }
+        emit(event: Events.BeforeDestroyed.rawValue, data: ["object": self])
+        onDestroy()
+        _isDestroyed = true
+
+        emit(event: Events.Destroyed.rawValue, data: ["object": self])
+        SpatialObject.objects.removeValue(forKey: spatialId)
+
+        listeners = [:]
+    }
+
+    internal func onDestroy() {}
+}

package/web-spatial/WebMsgCommand.swift

@@ -0,0 +1,137 @@
+// All WebMsg have been listed here
+
+import SwiftUI
+
+enum WebSpatialGestureType: String, Encodable {
+    case spatialtap = "spatialtap"
+    case spatialdragstart = "spatialdragstart"
+    case spatialdrag = "spatialdrag"
+    case spatialdragend = "spatialdragend"
+    case spatialrotatestart = "spatialrotatestart"
+    case spatialrotate = "spatialrotate"
+    case spatialrotateend = "spatialrotateend"
+    case spatialmagnifystart = "spatialmagnifystart"
+    case spatialmagnify = "spatialmagnify"
+    case spatialmagnifyend = "spatialmagnifyend"
+}
+
+enum SpatialWebMsgType: String, Encodable {
+    case cubeInfo = "cubeInfo"
+    case transform = "transform"
+    case modelloaded = "modelloaded"
+    case modelloadfailed = "modelloadfailed"
+    case spatialtap = "spatialtap"
+    case spatialdragstart = "spatialdragstart"
+    case spatialdrag = "spatialdrag"
+    case spatialdragend = "spatialdragend"
+    case spatialrotatestart = "spatialrotatestart"
+    case spatialrotate = "spatialrotate"
+    case spatialrotateend = "spatialrotateend"
+    case spatialmagnifystart = "spatialmagnifystart"
+    case spatialmagnify = "spatialmagnify"
+    case spatialmagnifyend = "spatialmagnifyend"
+
+    case objectdestroy = "objectdestroy"
+}
+
+// notify Spatialized3DElement Container Cube, used for ref.current.getBoundingClientCube()
+struct SpatiaizedContainerClientCube: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.cubeInfo
+    let origin: Point3D
+    let size: Size3D
+}
+
+// notify Spatialized3DElement Container Transform to SpatialScene, used for ref.current.convertToSpatialScene()
+struct SpatiaizedContainerTransform: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.transform
+    let detail: AffineTransform3D
+}
+
+struct WebSpatialTapGuestureEventDetail: Encodable {
+    let location3D: Point3D
+}
+
+// notify SpatializedElement/SpatialEntity tapped
+struct WebSpatialTapGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialtap
+    let detail: WebSpatialTapGuestureEventDetail
+}
+
+struct WebSpatialDragGuestureEventDetail: Encodable {
+    let location3D: Point3D
+    let startLocation3D: Point3D
+    let translation3D: Vector3D
+    let predictedEndTranslation3D: Vector3D
+    let predictedEndLocation3D: Point3D
+    let velocity: CGSize
+}
+
+struct WebSpatialDragGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialdrag
+    let detail: WebSpatialDragGuestureEventDetail
+}
+
+struct WebSpatialDragStartGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialdragstart
+    let detail: WebSpatialDragGuestureEventDetail
+}
+
+struct WebSpatialDragEndGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialdragend
+    let detail: WebSpatialDragGuestureEventDetail
+}
+
+struct WebSpatialRotateGuestureEventDetail: Encodable {
+    let rotation: Rotation3D
+    let startAnchor3D: UnitPoint3D
+    let startLocation3D: Point3D
+}
+
+struct WebSpatialRotateGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialrotate
+    let detail: WebSpatialRotateGuestureEventDetail
+}
+
+struct WebSpatialRotateStartGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialrotatestart
+    let detail: WebSpatialRotateGuestureEventDetail
+}
+
+struct WebSpatialRotateEndGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialrotateend
+    let detail: WebSpatialRotateGuestureEventDetail
+}
+
+struct WebSpatialMagnifyGuestureEventDetail: Encodable {
+    let magnification: CGFloat
+    let velocity: CGFloat
+    let startLocation3D: Point3D
+    let startAnchor3D: UnitPoint3D
+}
+
+struct WebSpatialMagnifyGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialmagnify
+    let detail: WebSpatialMagnifyGuestureEventDetail
+}
+
+struct WebSpatialMagnifyStartGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialmagnifystart
+    let detail: WebSpatialMagnifyGuestureEventDetail
+}
+
+struct WebSpatialMagnifyEndGuestureEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.spatialmagnifyend
+    let detail: WebSpatialMagnifyGuestureEventDetail
+}
+
+struct ModelLoadSuccess: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.modelloaded
+}
+
+struct ModelLoadFailure: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.modelloadfailed
+}
+
+struct SpatialObjectDestroiedEvent: Encodable {
+    let type: SpatialWebMsgType = SpatialWebMsgType.objectdestroy
+}