BridgeJS: Fix Array<@jsclass struct> support on imported interfaces

Author: kateinoigakukun

Sources/JavaScriptKit/BridgeJSIntrinsics.swift

@@ -510,12 +510,13 @@ extension _JSBridgedClass {
     @_spi(BridgeJS) public static func bridgeJSLiftParameter(_ id: Int32) -> Self {
         Self(unsafelyWrapping: JSObject.bridgeJSLiftParameter(id))
     }
-    @_spi(BridgeJS) public static func bridgeJSStackPop() -> Self {
-        bridgeJSLiftParameter(_swift_js_pop_i32())
-    }
     @_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Int32 { jsObject.bridgeJSLowerReturn() }
-    @_spi(BridgeJS) public consuming func bridgeJSStackPush() {
-        _swift_js_push_i32(bridgeJSLowerReturn())
+
+    public static func bridgeJSStackPop() -> Self {
+        Self(unsafelyWrapping: JSObject.bridgeJSStackPop())
+    }
+    public consuming func bridgeJSStackPush() {
+        jsObject.bridgeJSStackPush()
     }
 }
 

Sources/JavaScriptKit/JSBridgedType.swift

@@ -16,7 +16,7 @@ extension JSBridgedType {
 /// A protocol that Swift classes that are exposed to JavaScript via `@JS class` conform to.
 ///
 /// The conformance is automatically synthesized by `@JSClass` for BridgeJS-generated declarations.
-public protocol _JSBridgedClass {
+public protocol _JSBridgedClass: Equatable, _BridgedSwiftStackType {
     /// The JavaScript object wrapped by this instance.
     /// You may assume that `jsObject instanceof Self.constructor == true`
     var jsObject: JSObject { get }
@@ -26,6 +26,12 @@ public protocol _JSBridgedClass {
     init(unsafelyWrapping jsObject: JSObject)
 }
 
+extension _JSBridgedClass {
+    public static func == (lhs: Self, rhs: Self) -> Bool {
+        lhs.jsObject == rhs.jsObject
+    }
+}
+
 /// Conform to this protocol when your Swift class wraps a JavaScript class.
 public protocol JSBridgedClass: JSBridgedType, _JSBridgedClass {
     /// The constructor function for the JavaScript class

Tests/BridgeJSRuntimeTests/ArraySupportTests.swift

@@ -1,6 +1,12 @@
 import XCTest
 import JavaScriptKit
 
+@JSClass struct ArrayElementObject {
+    @JSGetter var id: String
+
+    @JSFunction init(id: String) throws(JSException)
+}
+
 @JSClass struct ArraySupportImports {
     @JSFunction static func jsIntArrayLength(_ items: [Int]) throws(JSException) -> Int
 
@@ -10,7 +16,13 @@ import JavaScriptKit
     @JSFunction static func jsRoundTripBoolArray(_ values: [Bool]) throws(JSException) -> [Bool]
 
     @JSFunction static func jsRoundTripJSValueArray(_ v: [JSValue]) throws(JSException) -> [JSValue]
-    @JSFunction static func jsRoundTripOptionalJSValueArray(_ v: Optional<[JSValue]>) throws(JSException) -> Optional<[JSValue]>
+    @JSFunction static func jsRoundTripOptionalJSValueArray(
+        _ v: Optional<[JSValue]>
+    ) throws(JSException) -> Optional<[JSValue]>
+
+    @JSFunction static func jsRoundTripJSClassArray(
+        _ values: [ArrayElementObject]
+    ) throws(JSException) -> [ArrayElementObject]
 
     @JSFunction static func jsSumNumberArray(_ values: [Double]) throws(JSException) -> Double
     @JSFunction static func jsCreateNumberArray() throws(JSException) -> [Double]
@@ -85,4 +97,15 @@ final class ArraySupportTests: XCTestCase {
         let result = try ArraySupportImports.jsRoundTripOptionalJSValueArray(values)
         XCTAssertEqual(result, values)
     }
+
+    func testRoundTripJSClassArray() throws {
+        let values = try [ArrayElementObject(id: "1"), ArrayElementObject(id: "2"), ArrayElementObject(id: "3")]
+        let result = try ArraySupportImports.jsRoundTripJSClassArray(values)
+        XCTAssertEqual(result, values)
+        XCTAssertEqual(try result[0].id, "1")
+        XCTAssertEqual(try result[1].id, "2")
+        XCTAssertEqual(try result[2].id, "3")
+
+        XCTAssertEqual(try ArraySupportImports.jsRoundTripJSClassArray([]), [])
+    }
 }

Tests/BridgeJSRuntimeTests/Generated/BridgeJS.swift

@@ -9229,6 +9229,48 @@ fileprivate func _bjs_LeakCheck_wrap_extern(_ pointer: UnsafeMutableRawPointer)
     return _bjs_LeakCheck_wrap_extern(pointer)
 }
 
+#if arch(wasm32)
+@_extern(wasm, module: "BridgeJSRuntimeTests", name: "bjs_ArrayElementObject_init")
+fileprivate func bjs_ArrayElementObject_init_extern(_ id: Int32) -> Int32
+#else
+fileprivate func bjs_ArrayElementObject_init_extern(_ id: Int32) -> Int32 {
+    fatalError("Only available on WebAssembly")
+}
+#endif
+@inline(never) fileprivate func bjs_ArrayElementObject_init(_ id: Int32) -> Int32 {
+    return bjs_ArrayElementObject_init_extern(id)
+}
+
+#if arch(wasm32)
+@_extern(wasm, module: "BridgeJSRuntimeTests", name: "bjs_ArrayElementObject_id_get")
+fileprivate func bjs_ArrayElementObject_id_get_extern(_ self: Int32) -> Int32
+#else
+fileprivate func bjs_ArrayElementObject_id_get_extern(_ self: Int32) -> Int32 {
+    fatalError("Only available on WebAssembly")
+}
+#endif
+@inline(never) fileprivate func bjs_ArrayElementObject_id_get(_ self: Int32) -> Int32 {
+    return bjs_ArrayElementObject_id_get_extern(self)
+}
+
+func _$ArrayElementObject_init(_ id: String) throws(JSException) -> JSObject {
+    let idValue = id.bridgeJSLowerParameter()
+    let ret = bjs_ArrayElementObject_init(idValue)
+    if let error = _swift_js_take_exception() {
+        throw error
+    }
+    return JSObject.bridgeJSLiftReturn(ret)
+}
+
+func _$ArrayElementObject_id_get(_ self: JSObject) throws(JSException) -> String {
+    let selfValue = self.bridgeJSLowerParameter()
+    let ret = bjs_ArrayElementObject_id_get(selfValue)
+    if let error = _swift_js_take_exception() {
+        throw error
+    }
+    return String.bridgeJSLiftReturn(ret)
+}
+
 #if arch(wasm32)
 @_extern(wasm, module: "BridgeJSRuntimeTests", name: "bjs_ArraySupportImports_jsIntArrayLength_static")
 fileprivate func bjs_ArraySupportImports_jsIntArrayLength_static_extern() -> Int32
@@ -9313,6 +9355,18 @@ fileprivate func bjs_ArraySupportImports_jsRoundTripOptionalJSValueArray_static_
     return bjs_ArraySupportImports_jsRoundTripOptionalJSValueArray_static_extern(v)
 }
 
+#if arch(wasm32)
+@_extern(wasm, module: "BridgeJSRuntimeTests", name: "bjs_ArraySupportImports_jsRoundTripJSClassArray_static")
+fileprivate func bjs_ArraySupportImports_jsRoundTripJSClassArray_static_extern() -> Void
+#else
+fileprivate func bjs_ArraySupportImports_jsRoundTripJSClassArray_static_extern() -> Void {
+    fatalError("Only available on WebAssembly")
+}
+#endif
+@inline(never) fileprivate func bjs_ArraySupportImports_jsRoundTripJSClassArray_static() -> Void {
+    return bjs_ArraySupportImports_jsRoundTripJSClassArray_static_extern()
+}
+
 #if arch(wasm32)
 @_extern(wasm, module: "BridgeJSRuntimeTests", name: "bjs_ArraySupportImports_jsSumNumberArray_static")
 fileprivate func bjs_ArraySupportImports_jsSumNumberArray_static_extern() -> Float64
@@ -9400,6 +9454,15 @@ func _$ArraySupportImports_jsRoundTripOptionalJSValueArray(_ v: Optional<[JSValu
     return Optional<[JSValue]>.bridgeJSLiftReturn()
 }
 
+func _$ArraySupportImports_jsRoundTripJSClassArray(_ values: [ArrayElementObject]) throws(JSException) -> [ArrayElementObject] {
+    let _ = values.bridgeJSLowerParameter()
+    bjs_ArraySupportImports_jsRoundTripJSClassArray_static()
+    if let error = _swift_js_take_exception() {
+        throw error
+    }
+    return [ArrayElementObject].bridgeJSLiftReturn()
+}
+
 func _$ArraySupportImports_jsSumNumberArray(_ values: [Double]) throws(JSException) -> Double {
     let _ = values.bridgeJSLowerParameter()
     let ret = bjs_ArraySupportImports_jsSumNumberArray_static()

Tests/BridgeJSRuntimeTests/Generated/JavaScript/BridgeJS.json

@@ -13379,6 +13379,40 @@
 
         ],
         "types" : [
+          {
+            "constructor" : {
+              "parameters" : [
+                {
+                  "name" : "id",
+                  "type" : {
+                    "string" : {
+
+                    }
+                  }
+                }
+              ]
+            },
+            "getters" : [
+              {
+                "name" : "id",
+                "type" : {
+                  "string" : {
+
+                  }
+                }
+              }
+            ],
+            "methods" : [
+
+            ],
+            "name" : "ArrayElementObject",
+            "setters" : [
+
+            ],
+            "staticMethods" : [
+
+            ]
+          },
           {
             "getters" : [
 
@@ -13579,6 +13613,32 @@
                   }
                 }
               },
+              {
+                "name" : "jsRoundTripJSClassArray",
+                "parameters" : [
+                  {
+                    "name" : "values",
+                    "type" : {
+                      "array" : {
+                        "_0" : {
+                          "jsObject" : {
+                            "_0" : "ArrayElementObject"
+                          }
+                        }
+                      }
+                    }
+                  }
+                ],
+                "returnType" : {
+                  "array" : {
+                    "_0" : {
+                      "jsObject" : {
+                        "_0" : "ArrayElementObject"
+                      }
+                    }
+                  }
+                }
+              },
               {
                 "name" : "jsSumNumberArray",
                 "parameters" : [

Tests/BridgeJSRuntimeTests/JSClassSupportTests.swift

@@ -13,7 +13,10 @@ import JavaScriptKit
 }
 
 @JSClass struct JSClassSupportImports {
-    @JSFunction static func makeJSClassWithArrayMembers(_ numbers: [Int], _ labels: [String]) throws(JSException) -> JSClassWithArrayMembers
+    @JSFunction static func makeJSClassWithArrayMembers(
+        _ numbers: [Int],
+        _ labels: [String]
+    ) throws(JSException) -> JSClassWithArrayMembers
 }
 
 final class JSClassSupportTests: XCTestCase {
@@ -35,4 +38,4 @@ final class JSClassSupportTests: XCTestCase {
         XCTAssertEqual(try host.firstLabel([]), "gamma")
         XCTAssertEqual(try host.firstLabel(["zeta"]), "zeta")
     }
-}
+}

Tests/BridgeJSRuntimeTests/JavaScript/ArraySupportTests.mjs

@@ -1,5 +1,11 @@
 // @ts-check
 
+export class ArrayElementObject {
+    constructor(id) {
+        this.id = id;
+    }
+}
+
 /**
  * @returns {import('../../../.build/plugins/PackageToJS/outputs/PackageTests/bridge-js.d.ts').Imports["ArraySupportImports"]}
  */
@@ -31,6 +37,9 @@ export function getImports(importsContext) {
         },
         jsCreateNumberArray: function () {
             return [1, 2, 3, 4, 5];
-        }
+        },
+        jsRoundTripJSClassArray: (values) => {
+            return values;
+        },
     };
 }

Tests/prelude.mjs

@@ -8,7 +8,7 @@ import { runJsOptionalSupportTests } from './BridgeJSRuntimeTests/JavaScript/Opt
 import { getImports as getClosureSupportImports } from './BridgeJSRuntimeTests/JavaScript/ClosureSupportTests.mjs';
 import { getImports as getSwiftClassSupportImports } from './BridgeJSRuntimeTests/JavaScript/SwiftClassSupportTests.mjs';
 import { getImports as getOptionalSupportImports } from './BridgeJSRuntimeTests/JavaScript/OptionalSupportTests.mjs';
-import { getImports as getArraySupportImports } from './BridgeJSRuntimeTests/JavaScript/ArraySupportTests.mjs';
+import { getImports as getArraySupportImports, ArrayElementObject } from './BridgeJSRuntimeTests/JavaScript/ArraySupportTests.mjs';
 import { getImports as getJSClassSupportImports, JSClassWithArrayMembers } from './BridgeJSRuntimeTests/JavaScript/JSClassSupportTests.mjs';
 
 /** @type {import('../.build/plugins/PackageToJS/outputs/PackageTests/test.d.ts').SetupOptionsFn} */
@@ -112,6 +112,7 @@ export async function setupOptions(options, context) {
                 "$jsWeirdFunction": () => {
                     return 42;
                 },
+                ArrayElementObject,
                 JSClassWithArrayMembers,
                 JsGreeter: class {
                     /**