Support collections dsl (#51042)

Summary:
This PR introduces a concise Kotlin DSL for constructing `ReadableMap` and `ReadableArray` in Android native modules:

- Adds `buildReadableMap { … }` and `buildReadableArray { … }` functions, modeled after Kotlin’s `buildMap`/`buildList` APIs.
- Wraps `Arguments.createMap()` / `Arguments.createArray()` in a type-safe, nested DSL to reduce boilerplate and prevent errors.
- Improves readability and maintainability when assembling nested map/array structures for React Native bridges.

Current code like:
```kotlin
val map = Arguments.createMap().apply {
  putString("name", user.name)
  putInt("age", user.age)
  // …
}
```

can now be written as:

```kotlin
val userMap = buildReadableMap {
  put("name", user.name)
  put("age", user.age)
  put("scores") {
    user.scores.forEach { add(it) }
  }
}
```

This feature proposal also written in [[Android] Support Collection DSL](https://github.com/react-native-community/discussions-and-proposals/issues/899)

## Changelog:

[Android] [Added] - Collections DSL functions for Kotlin(`buildReadableMap`, `buildReadableArray`)

Pull Request resolved: https://github.com/facebook/react-native/pull/51042

Test Plan:
### Run Unit Test

```shell
cd packages/react-native/ReactAndroid
./gradlew :ReactAndroid:unitTest
```

Ensure all tests in `src/test/java/.../ReadableMapBuilderTest.kt` and `ReadableArrayBuilderTest.kt` pass.

Reviewed By: javache

Differential Revision: D73986390

Pulled By: cortinico

fbshipit-source-id: b9f94327646bcb6e0190cdd06dfb9bb5eaa6375c
This commit is contained in:
HyunWoo Lee authored and Facebook GitHub Bot committed 2025-05-02 11:02:52 -07:00
1 parent 2590438b67
commit 78dbbaafdd
7 files changed
+317 -7

No files matched your search

@@ -1353,6 +1353,22 @@ public abstract interface class com/facebook/react/bridge/ReadableArray {
public abstract fun toArrayList ()Ljava/util/ArrayList;
}
public final class com/facebook/react/bridge/ReadableArrayBuilder {
public fun <init> (Lcom/facebook/react/bridge/WritableArray;)V
public final fun add (D)V
public final fun add (I)V
public final fun add (J)V
public final fun add (Ljava/lang/String;)V
public final fun add (Z)V
public final fun addArray (Lkotlin/jvm/functions/Function1;)V
public final fun addMap (Lkotlin/jvm/functions/Function1;)V
public final fun addNull ()V
}
public final class com/facebook/react/bridge/ReadableArrayBuilderKt {
public static final fun buildReadableArray (Lkotlin/jvm/functions/Function1;)Lcom/facebook/react/bridge/ReadableArray;
}
public abstract interface class com/facebook/react/bridge/ReadableMap {
public abstract fun getArray (Ljava/lang/String;)Lcom/facebook/react/bridge/ReadableArray;
public abstract fun getBoolean (Ljava/lang/String;)Z
@@ -1370,6 +1386,22 @@ public abstract interface class com/facebook/react/bridge/ReadableMap {
public abstract fun toHashMap ()Ljava/util/HashMap;
}
public final class com/facebook/react/bridge/ReadableMapBuilder {
public fun <init> (Lcom/facebook/react/bridge/WritableMap;)V
public final fun put (Ljava/lang/String;D)V
public final fun put (Ljava/lang/String;I)V
public final fun put (Ljava/lang/String;J)V
public final fun put (Ljava/lang/String;Ljava/lang/String;)V
public final fun put (Ljava/lang/String;Z)V
public final fun putArray (Ljava/lang/String;Lkotlin/jvm/functions/Function1;)V
public final fun putMap (Ljava/lang/String;Lkotlin/jvm/functions/Function1;)V
public final fun putNull (Ljava/lang/String;)V
}
public final class com/facebook/react/bridge/ReadableMapBuilderKt {
public static final fun buildReadableMap (Lkotlin/jvm/functions/Function1;)Lcom/facebook/react/bridge/ReadableMap;
}
public abstract interface class com/facebook/react/bridge/ReadableMapKeySetIterator {
public abstract fun hasNextKey ()Z
public abstract fun nextKey ()Ljava/lang/String;