Skip to content

BridgeJS: Update JSUndefinedOr APIs #615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kateinoigakukun merged 1 commit into from
Feb 10, 2026
+55 −44
Merged

BridgeJS: Update JSUndefinedOr APIs #615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Plugins/BridgeJS/Sources/BridgeJSCore/ExportSwift.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ public class ExportSwift {
let absentExpr =
kind == .null
? "\(optionalSwiftType)<[\(swiftTypeName)]>.none"
: "\(optionalSwiftType)<[\(swiftTypeName)]>.undefinedValue"
: "\(optionalSwiftType)<[\(swiftTypeName)]>.undefined"
liftingExpr = ExprSyntax(
"""
{
Expand Down Expand Up @@ -934,7 +934,7 @@ struct StackCodegen {
let swiftTypeName = elementType.swiftType
let absentExpr =
kind == .null
? "\(typeName)<[\(swiftTypeName)]>.none" : "\(typeName)<[\(swiftTypeName)]>.undefinedValue"
? "\(typeName)<[\(swiftTypeName)]>.none" : "\(typeName)<[\(swiftTypeName)]>.undefined"
return """
{
let __isSome = _swift_js_pop_i32()
Expand All @@ -951,7 +951,7 @@ struct StackCodegen {
let absentExpr =
kind == .null
? "\(typeName)<[String: \(swiftTypeName)]>.none"
: "\(typeName)<[String: \(swiftTypeName)]>.undefinedValue"
: "\(typeName)<[String: \(swiftTypeName)]>.undefined"
return """
{
let __isSome = _swift_js_pop_i32()
Expand Down
70 changes: 35 additions & 35 deletions Sources/JavaScriptKit/BridgeJSIntrinsics.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ public protocol _BridgedSwiftStackType {
/// Used by JSUndefinedOr so all bridge methods delegate to Optional<Wrapped>.
public protocol _BridgedAsOptional {
associatedtype Wrapped
var optionalRepresentation: Wrapped? { get }
var asOptional: Wrapped? { get }
init(optional: Wrapped?)
}

Expand Down Expand Up @@ -2019,7 +2019,7 @@ extension Optional where Wrapped: _BridgedSwiftStruct {

extension _BridgedAsOptional where Wrapped == Bool {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ wrappedValue: Int32) -> Self {
Expand All @@ -2035,13 +2035,13 @@ extension _BridgedAsOptional where Wrapped == Bool {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped == Int {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ wrappedValue: Int32) -> Self {
Expand All @@ -2057,13 +2057,13 @@ extension _BridgedAsOptional where Wrapped == Int {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped == UInt {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ wrappedValue: Int32) -> Self {
Expand All @@ -2079,13 +2079,13 @@ extension _BridgedAsOptional where Wrapped == UInt {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped == String {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(
Expand All @@ -2105,13 +2105,13 @@ extension _BridgedAsOptional where Wrapped == String {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped == JSObject {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ objectId: Int32) -> Self {
Expand All @@ -2123,7 +2123,7 @@ extension _BridgedAsOptional where Wrapped == JSObject {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

Expand All @@ -2133,20 +2133,20 @@ extension _BridgedAsOptional where Wrapped: _BridgedSwiftProtocolWrapper {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped: _BridgedSwiftHeapObject {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, pointer: UnsafeMutableRawPointer)
{
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public consuming func bridgeJSLowerParameterWithRetain() -> (
isSome: Int32, pointer: UnsafeMutableRawPointer
) {
optionalRepresentation.bridgeJSLowerParameterWithRetain()
asOptional.bridgeJSLowerParameterWithRetain()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(
Expand All @@ -2165,13 +2165,13 @@ extension _BridgedAsOptional where Wrapped: _BridgedSwiftHeapObject {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped == Float {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Float32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ wrappedValue: Float32) -> Self {
Expand All @@ -2187,13 +2187,13 @@ extension _BridgedAsOptional where Wrapped == Float {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped == Double {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Float64) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ wrappedValue: Float64) -> Self {
Expand All @@ -2209,13 +2209,13 @@ extension _BridgedAsOptional where Wrapped == Double {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped: _BridgedSwiftCaseEnum {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ caseId: Int32) -> Self {
Expand All @@ -2231,20 +2231,20 @@ extension _BridgedAsOptional where Wrapped: _BridgedSwiftCaseEnum {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped: _BridgedSwiftTypeLoweredIntoVoidType {
@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional
where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.RawValue == String {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(
Expand All @@ -2264,14 +2264,14 @@ where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.Ra
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional
where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.RawValue == Int {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ wrappedValue: Int32) -> Self {
Expand All @@ -2287,7 +2287,7 @@ where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.Ra
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

Expand All @@ -2302,14 +2302,14 @@ where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.Ra
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional
where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.RawValue == Float {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Float32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ wrappedValue: Float32) -> Self {
Expand All @@ -2325,14 +2325,14 @@ where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.Ra
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional
where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.RawValue == Double {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, value: Float64) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ wrappedValue: Float64) -> Self {
Expand All @@ -2348,13 +2348,13 @@ where Wrapped: _BridgedSwiftEnumNoPayload, Wrapped: RawRepresentable, Wrapped.Ra
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

extension _BridgedAsOptional where Wrapped: _BridgedSwiftAssociatedValueEnum {
@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> (isSome: Int32, caseId: Int32) {
optionalRepresentation.bridgeJSLowerParameter()
asOptional.bridgeJSLowerParameter()
}

@_spi(BridgeJS) public static func bridgeJSLiftParameter(_ isSome: Int32, _ caseId: Int32) -> Self {
Expand All @@ -2370,7 +2370,7 @@ extension _BridgedAsOptional where Wrapped: _BridgedSwiftAssociatedValueEnum {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

Expand All @@ -2384,7 +2384,7 @@ extension _BridgedAsOptional where Wrapped: _BridgedSwiftStruct {
}

@_spi(BridgeJS) public consuming func bridgeJSLowerReturn() -> Void {
optionalRepresentation.bridgeJSLowerReturn()
asOptional.bridgeJSLowerReturn()
}
}

Expand Down Expand Up @@ -2526,7 +2526,7 @@ extension _BridgedAsOptional where Wrapped: _BridgedSwiftDictionaryStackType {
typealias DictionaryValue = Wrapped.DictionaryValue

@_spi(BridgeJS) public consuming func bridgeJSLowerParameter() -> Int32 {
let opt = optionalRepresentation
let opt = asOptional
if let dict = opt {
dict.bridgeJSLowerReturn()
return 1
Expand Down
19 changes: 15 additions & 4 deletions Sources/JavaScriptKit/JSUndefinedOr.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
/// A wrapper that represents a JavaScript value of `Wrapped | undefined`.
///
/// In BridgeJS, `Optional<Wrapped>` is bridged as `Wrapped | null`.
/// Use `JSUndefinedOr<Wrapped>` when the JavaScript API expects
/// `Wrapped | undefined` instead.
@frozen public enum JSUndefinedOr<Wrapped> {
/// The JavaScript value is `undefined`.
case undefined
/// The JavaScript value is present and wrapped.
case value(Wrapped)

/// Convenience accessor for the undefined case.
public static var undefinedValue: Self { .undefined }

/// Creates a wrapper from a Swift optional.
///
/// - Parameter optional: The optional value to wrap.
/// `nil` becomes ``undefined`` and a non-`nil` value becomes ``value(_:)``.
@inlinable
public init(optional: Wrapped?) {
self = optional.map(Self.value) ?? .undefined
}

/// Returns the wrapped value as a Swift optional.
///
/// Returns `nil` when this value is ``undefined``.
@inlinable
public var optionalRepresentation: Wrapped? {
public var asOptional: Wrapped? {
switch self {
case .undefined:
return nil
Expand Down
2 changes: 1 addition & 1 deletion Tests/BridgeJSRuntimeTests/DictionaryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ final class DictionaryTests: XCTestCase {

func testRoundTripOptionalDictionaryUndefined() throws {
let some: JSUndefinedOr<[String: Int]> = .value(["n": 42])
let undefined: JSUndefinedOr<[String: Int]> = .undefinedValue
let undefined: JSUndefinedOr<[String: Int]> = .undefined

let returnedSome = try jsRoundTripUndefinedDictionary(some)
switch returnedSome {
Expand Down
2 changes: 1 addition & 1 deletion Tests/BridgeJSRuntimeTests/OptionalSupportTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ final class OptionalSupportTests: XCTestCase {
XCTFail("Expected defined value")
}

let undefined = try jsRoundTripOptionalStringUndefined(.undefinedValue)
let undefined = try jsRoundTripOptionalStringUndefined(.undefined)
if case .value = undefined {
XCTFail("Expected undefined")
}
Expand Down