expo-modules-core 0.6.5 → 0.9.0

package/android/src/main/java/expo/modules/kotlin/types/ListTypeConverter.kt

@@ -1,15 +1,17 @@
 package expo.modules.kotlin.types
 
 import com.facebook.react.bridge.Dynamic
+import expo.modules.kotlin.exception.CollectionElementCastException
+import expo.modules.kotlin.exception.exceptionDecorator
 import expo.modules.kotlin.recycle
 import kotlin.reflect.KType
 
 class ListTypeConverter(
   converterProvider: TypeConverterProvider,
-  type: KType,
-) : TypeConverter<List<*>>(type.isMarkedNullable) {
+  private val listType: KType,
+) : TypeConverter<List<*>>(listType.isMarkedNullable) {
   private val elementConverter = converterProvider.obtainTypeConverter(
-    requireNotNull(type.arguments.first().type) {
+    requireNotNull(listType.arguments.first().type) {
       "The list type should contain the type of elements."
     }
   )
@@ -18,7 +20,11 @@ class ListTypeConverter(
     val jsArray = value.asArray()
     return List(jsArray.size()) { index ->
       jsArray.getDynamic(index).recycle {
-        elementConverter.convert(this)
+        exceptionDecorator({ cause ->
+          CollectionElementCastException(listType, listType.arguments.first().type!!, type, cause)
+        }) {
+          elementConverter.convert(this)
+        }
       }
     }
   }

package/android/src/main/java/expo/modules/kotlin/types/MapTypeConverter.kt

@@ -4,22 +4,24 @@ package expo.modules.kotlin.types
 
 import com.facebook.react.bridge.Dynamic
 import com.facebook.react.bridge.DynamicFromObject
+import expo.modules.kotlin.exception.CollectionElementCastException
+import expo.modules.kotlin.exception.exceptionDecorator
 import expo.modules.kotlin.recycle
 import kotlin.reflect.KType
 import kotlin.reflect.typeOf
 
 class MapTypeConverter(
   converterProvider: TypeConverterProvider,
-  type: KType
-) : TypeConverter<Map<*, *>>(type.isMarkedNullable) {
+  private val mapType: KType
+) : TypeConverter<Map<*, *>>(mapType.isMarkedNullable) {
   init {
-    require(type.arguments.first().type == typeOf<String>()) {
-      "The map key type should be String, but received ${type.arguments.first()}."
+    require(mapType.arguments.first().type == typeOf<String>()) {
+      "The map key type should be String, but received ${mapType.arguments.first()}."
     }
   }
 
   private val valueConverter = converterProvider.obtainTypeConverter(
-    requireNotNull(type.arguments.getOrNull(1)?.type) {
+    requireNotNull(mapType.arguments.getOrNull(1)?.type) {
       "The map type should contain the key type."
     }
   )
@@ -30,7 +32,11 @@ class MapTypeConverter(
 
     jsMap.entryIterator.forEach { (key, value) ->
       DynamicFromObject(value).recycle {
-        result[key] = valueConverter.convert(this)
+        exceptionDecorator({ cause ->
+          CollectionElementCastException(mapType, mapType.arguments[1].type!!, type, cause)
+        }) {
+          result[key] = valueConverter.convert(this)
+        }
       }
     }
 

package/android/src/main/java/expo/modules/kotlin/types/PairTypeConverter.kt

@@ -1,28 +1,44 @@
 package expo.modules.kotlin.types
 
 import com.facebook.react.bridge.Dynamic
+import com.facebook.react.bridge.ReadableArray
+import expo.modules.kotlin.exception.CollectionElementCastException
+import expo.modules.kotlin.exception.exceptionDecorator
+import expo.modules.kotlin.recycle
 import kotlin.reflect.KType
 
 class PairTypeConverter(
   converterProvider: TypeConverterProvider,
-  type: KType,
-) : TypeConverter<Pair<*, *>>(type.isMarkedNullable) {
-  private val firstConverter = converterProvider.obtainTypeConverter(
-    requireNotNull(type.arguments.getOrNull(0)?.type) {
-      "The pair type should contain the type of the first parameter."
-    }
-  )
-  private val secondConverter = converterProvider.obtainTypeConverter(
-    requireNotNull(type.arguments.getOrNull(1)?.type) {
-      "The pair type should contain the type of the second parameter."
-    }
+  private val pairType: KType,
+) : TypeConverter<Pair<*, *>>(pairType.isMarkedNullable) {
+  private val converters = listOf(
+    converterProvider.obtainTypeConverter(
+      requireNotNull(pairType.arguments.getOrNull(0)?.type) {
+        "The pair type should contain the type of the first parameter."
+      }
+    ),
+    converterProvider.obtainTypeConverter(
+      requireNotNull(pairType.arguments.getOrNull(1)?.type) {
+        "The pair type should contain the type of the second parameter."
+      }
+    )
   )
 
   override fun convertNonOptional(value: Dynamic): Pair<*, *> {
     val jsArray = value.asArray()
     return Pair(
-      firstConverter.convert(jsArray.getDynamic(0)),
-      secondConverter.convert(jsArray.getDynamic(1)),
+      convertElement(jsArray, 0),
+      convertElement(jsArray, 1)
     )
   }
+
+  private fun convertElement(array: ReadableArray, index: Int): Any? {
+    return array.getDynamic(index).recycle {
+      exceptionDecorator({ cause ->
+        CollectionElementCastException(pairType, pairType.arguments[index].type!!, type, cause)
+      }) {
+        converters[index].convert(this)
+      }
+    }
+  }
 }

package/android/src/main/java/expo/modules/kotlin/types/TypeConverter.kt

@@ -1,6 +1,7 @@
 package expo.modules.kotlin.types
 
 import com.facebook.react.bridge.Dynamic
+import expo.modules.kotlin.exception.NullArgumentException
 
 abstract class TypeConverter<Type : Any>(
   private val isOptional: Boolean
@@ -10,7 +11,7 @@ abstract class TypeConverter<Type : Any>(
       if (isOptional) {
         return null
       }
-      throw IllegalArgumentException()
+      throw NullArgumentException()
     }
     return convertNonOptional(value)
   }

package/android/src/main/java/expo/modules/kotlin/types/TypeConverterProvider.kt

@@ -35,6 +35,7 @@ fun convert(value: Dynamic, type: KType): Any? {
 
 object TypeConverterProviderImpl : TypeConverterProvider {
   private val cachedConverters = createCashedConverters(false) + createCashedConverters(true)
+  private val cachedRecordConverters = mutableMapOf<KClass<*>, TypeConverter<*>>()
 
   override fun obtainTypeConverter(type: KType): TypeConverter<*> {
     cachedConverters[type]?.let {
@@ -68,8 +69,15 @@ object TypeConverterProviderImpl : TypeConverterProvider {
       return EnumTypeConverter(kClass as KClass<Enum<*>>, type.isMarkedNullable)
     }
 
+    val cachedConverter = cachedRecordConverters[kClass]
+    if (cachedConverter != null) {
+      return cachedConverter
+    }
+
     if (kClass.isSubclassOf(Record::class)) {
-      return RecordTypeConverter<Record>(this, type)
+      val converter = RecordTypeConverter<Record>(this, type)
+      cachedRecordConverters[kClass] = converter
+      return converter
     }
 
     throw MissingTypeConverter(type)

package/android/src/main/java/expo/modules/kotlin/views/CallbacksDefinition.kt

@@ -0,0 +1,3 @@
+package expo.modules.kotlin.views
+
+class CallbacksDefinition(val names: Array<out String>)

package/android/src/main/java/expo/modules/kotlin/views/GroupViewManagerWrapper.kt

@@ -3,9 +3,11 @@ package expo.modules.kotlin.views
 import android.view.View
 import android.view.ViewGroup
 import com.facebook.react.bridge.ReadableMap
+import com.facebook.react.common.MapBuilder
 import com.facebook.react.uimanager.ThemedReactContext
 import com.facebook.react.uimanager.ViewGroupManager
 import com.facebook.react.uimanager.annotations.ReactProp
+import expo.modules.core.utilities.ifNull
 
 class GroupViewManagerWrapper(
   override val viewWrapperDelegate: ViewManagerWrapperDelegate
@@ -19,4 +21,73 @@ class GroupViewManagerWrapper(
   fun setProxiedProperties(view: View, proxiedProperties: ReadableMap) {
     viewWrapperDelegate.setProxiedProperties(view, proxiedProperties)
   }
+
+  override fun onDropViewInstance(view: ViewGroup) {
+    super.onDropViewInstance(view)
+    viewWrapperDelegate.onDestroy(view)
+  }
+
+  override fun getExportedCustomDirectEventTypeConstants(): Map<String, Any>? {
+    viewWrapperDelegate.getExportedCustomDirectEventTypeConstants()?.let {
+      val directEvents = super.getExportedCustomDirectEventTypeConstants() ?: emptyMap()
+      val builder = MapBuilder.builder<String, Any>()
+      directEvents.forEach { event ->
+        builder.put(event.key, event.value)
+      }
+      it.forEach { event ->
+        builder.put(event.key, event.value)
+      }
+      return builder.build()
+    }
+
+    return super.getExportedCustomDirectEventTypeConstants()
+  }
+
+  override fun addView(parent: ViewGroup, child: View, index: Int) {
+    viewWrapperDelegate
+      .viewGroupDefinition
+      ?.addViewAction
+      ?.invoke(parent, child, index)
+      .ifNull {
+        super.addView(parent, child, index)
+      }
+  }
+
+  override fun getChildCount(parent: ViewGroup): Int {
+    return viewWrapperDelegate.viewGroupDefinition
+      ?.getChildCountAction
+      ?.invoke(parent)
+      .ifNull {
+        super.getChildCount(parent)
+      }
+  }
+
+  override fun getChildAt(parent: ViewGroup, index: Int): View? {
+    viewWrapperDelegate.viewGroupDefinition
+      ?.getChildAtAction
+      ?.let {
+        return it.invoke(parent, index)
+      }
+      .ifNull {
+        return super.getChildAt(parent, index)
+      }
+  }
+
+  override fun removeViewAt(parent: ViewGroup, index: Int) {
+    viewWrapperDelegate.viewGroupDefinition
+      ?.removeViewAtAction
+      ?.invoke(parent, index)
+      .ifNull {
+        super.removeViewAt(parent, index)
+      }
+  }
+
+  override fun removeView(parent: ViewGroup, view: View) {
+    viewWrapperDelegate.viewGroupDefinition
+      ?.removeViewAction
+      ?.invoke(parent, view)
+      .ifNull {
+        super.removeView(parent, view)
+      }
+  }
 }

package/android/src/main/java/expo/modules/kotlin/views/SimpleViewManagerWrapper.kt

@@ -2,6 +2,7 @@ package expo.modules.kotlin.views
 
 import android.view.View
 import com.facebook.react.bridge.ReadableMap
+import com.facebook.react.common.MapBuilder
 import com.facebook.react.uimanager.SimpleViewManager
 import com.facebook.react.uimanager.ThemedReactContext
 import com.facebook.react.uimanager.annotations.ReactProp
@@ -18,4 +19,25 @@ class SimpleViewManagerWrapper(
   fun setProxiedProperties(view: View, proxiedProperties: ReadableMap) {
     viewWrapperDelegate.setProxiedProperties(view, proxiedProperties)
   }
+
+  override fun onDropViewInstance(view: View) {
+    super.onDropViewInstance(view)
+    viewWrapperDelegate.onDestroy(view)
+  }
+
+  override fun getExportedCustomDirectEventTypeConstants(): Map<String, Any>? {
+    viewWrapperDelegate.getExportedCustomDirectEventTypeConstants()?.let {
+      val directEvents = super.getExportedCustomDirectEventTypeConstants() ?: emptyMap()
+      val builder = MapBuilder.builder<String, Any>()
+      directEvents.forEach { event ->
+        builder.put(event.key, event.value)
+      }
+      it.forEach { event ->
+        builder.put(event.key, event.value)
+      }
+      return builder.build()
+    }
+
+    return super.getExportedCustomDirectEventTypeConstants()
+  }
 }

package/android/src/main/java/expo/modules/kotlin/views/ViewGroupDefinition.kt

@@ -0,0 +1,18 @@
+package expo.modules.kotlin.views
+
+import android.view.View
+import android.view.ViewGroup
+
+class ViewGroupDefinition(
+  val addViewAction: AddViewAction?,
+  val getChildAtAction: GetChildAtAction?,
+  val getChildCountAction: GetChildCountAction?,
+  val removeViewAction: RemoveViewAction?,
+  val removeViewAtAction: RemoveViewAtAction?
+)
+
+internal typealias AddViewAction = (parent: ViewGroup, child: View, index: Int) -> Unit
+internal typealias GetChildAtAction = (parent: ViewGroup, index: Int) -> View?
+internal typealias GetChildCountAction = (parent: ViewGroup) -> Int
+internal typealias RemoveViewAction = (parent: ViewGroup, childToRemove: View) -> Unit
+internal typealias RemoveViewAtAction = (parent: ViewGroup, index: Int) -> Unit

package/android/src/main/java/expo/modules/kotlin/views/ViewGroupDefinitionBuilder.kt

@@ -0,0 +1,114 @@
+@file:OptIn(ExperimentalStdlibApi::class)
+@file:Suppress("FunctionName")
+
+package expo.modules.kotlin.views
+
+import android.view.View
+import android.view.ViewGroup
+import expo.modules.kotlin.modules.DefinitionMarker
+
+@DefinitionMarker
+class ViewGroupDefinitionBuilder {
+  @PublishedApi
+  internal var addViewAction: AddViewAction? = null
+
+  @PublishedApi
+  internal var getChildAtAction: GetChildAtAction? = null
+
+  @PublishedApi
+  internal var getChildCountAction: GetChildCountAction? = null
+
+  @PublishedApi
+  internal var removeViewAction: RemoveViewAction? = null
+
+  @PublishedApi
+  internal var removeViewAtAction: RemoveViewAtAction? = null
+
+  fun build() = ViewGroupDefinition(
+    addViewAction,
+    getChildAtAction,
+    getChildCountAction,
+    removeViewAction,
+    removeViewAtAction
+  )
+
+  @Deprecated(
+    message = "The 'addChildView' component was renamed to 'AddChildView'.",
+    replaceWith = ReplaceWith("AddChildView(body)")
+  )
+  inline fun <reified ParentViewType : ViewGroup, reified ChildViewType : View> addChildView(
+    noinline body: (parent: ParentViewType, child: ChildViewType, index: Int) -> Unit
+  ) = AddChildView(body)
+
+  inline fun <reified ParentViewType : ViewGroup, reified ChildViewType : View> AddChildView(
+    noinline body: (parent: ParentViewType, child: ChildViewType, index: Int) -> Unit
+  ) {
+    addViewAction = { parent, child, index ->
+      body(parent as ParentViewType, child as ChildViewType, index)
+    }
+  }
+
+  @Deprecated(
+    message = "The 'getChildCount' component was renamed to 'GetChildCount'.",
+    replaceWith = ReplaceWith("GetChildCount(body)")
+  )
+  inline fun <reified ParentViewType : ViewGroup> getChildCount(
+    noinline body: (view: ParentViewType) -> Int
+  ) = GetChildCount(body)
+
+  inline fun <reified ParentViewType : ViewGroup> GetChildCount(
+    noinline body: (view: ParentViewType) -> Int
+  ) {
+    getChildCountAction = { view ->
+      body(view as ParentViewType)
+    }
+  }
+
+  @Deprecated(
+    message = "The 'getChildViewAt' component was renamed to 'GetChildViewAt'.",
+    replaceWith = ReplaceWith("GetChildViewAt(body)")
+  )
+  inline fun <reified ParentViewType : ViewGroup, reified ChildViewType : View> getChildViewAt(
+    noinline body: (view: ParentViewType, index: Int) -> ChildViewType?
+  ) = GetChildViewAt(body)
+
+  inline fun <reified ParentViewType : ViewGroup, reified ChildViewType : View> GetChildViewAt(
+    noinline body: (view: ParentViewType, index: Int) -> ChildViewType?
+  ) {
+    getChildAtAction = { view, index ->
+      body(view as ParentViewType, index)
+    }
+  }
+
+  @Deprecated(
+    message = "The 'removeChildViewAt' component was renamed to 'RemoveChildViewAt'.",
+    replaceWith = ReplaceWith("RemoveChildViewAt(body)")
+  )
+  inline fun <reified ParentViewType : ViewGroup> removeChildViewAt(
+    noinline body: (view: ParentViewType, index: Int) -> Unit
+  ) = RemoveChildViewAt(body)
+
+  inline fun <reified ParentViewType : ViewGroup> RemoveChildViewAt(
+    noinline body: (view: ParentViewType, index: Int) -> Unit
+  ) {
+    removeViewAtAction = { view, index ->
+      body(view as ParentViewType, index)
+    }
+  }
+
+  @Deprecated(
+    message = "The 'removeChildView' component was renamed to 'RemoveChildView'.",
+    replaceWith = ReplaceWith("RemoveChildView(body)")
+  )
+  inline fun <reified ParentViewType : ViewGroup, reified ChildViewType : View> removeChildView(
+    noinline body: (parent: ParentViewType, child: ChildViewType) -> Unit
+  ) = RemoveChildView(body)
+
+  inline fun <reified ParentViewType : ViewGroup, reified ChildViewType : View> RemoveChildView(
+    noinline body: (parent: ParentViewType, child: ChildViewType) -> Unit
+  ) {
+    removeViewAction = { view, child ->
+      body(view as ParentViewType, child as ChildViewType)
+    }
+  }
+}

package/android/src/main/java/expo/modules/kotlin/views/ViewManagerDefinition.kt

@@ -4,18 +4,27 @@ import android.content.Context
 import android.util.Log
 import android.view.View
 import android.view.ViewGroup
+import com.facebook.react.bridge.ReactContext
 import com.facebook.react.bridge.ReadableMap
+import expo.modules.adapters.react.NativeModulesProxy
 import expo.modules.core.ViewManager
+import expo.modules.kotlin.exception.CodedException
+import expo.modules.kotlin.exception.UnexpectedException
 import expo.modules.kotlin.recycle
 
 class ViewManagerDefinition(
   private val viewFactory: (Context) -> View,
   private val viewType: Class<out View>,
-  private val props: Map<String, AnyViewProp>
+  private val props: Map<String, AnyViewProp>,
+  val onViewDestroys: ((View) -> Unit)? = null,
+  val callbacksDefinition: CallbacksDefinition? = null,
+  val viewGroupDefinition: ViewGroupDefinition? = null
 ) {
 
   fun createView(context: Context): View = viewFactory(context)
 
+  val propsNames: List<String> = props.keys.toList()
+
   fun getViewManagerType(): ViewManager.ViewManagerType {
     return if (ViewGroup::class.java.isAssignableFrom(viewType)) {
       ViewManager.ViewManagerType.GROUP
@@ -33,9 +42,28 @@ class ViewManagerDefinition(
         try {
           propDelegate.set(this, onView)
         } catch (exception: Throwable) {
-          Log.e("ExpoModulesCore", "Cannot set the $key prop on the ${viewType.simpleName}.", exception)
+          Log.e("ExpoModulesCore", "Cannot set the '$key' prop on the '${viewType.simpleName}'.", exception)
+
+          handleException(
+            onView,
+            when (exception) {
+              is CodedException -> exception
+              else -> UnexpectedException(exception)
+            }
+          )
         }
       }
     }
   }
+
+  fun handleException(view: View, exception: CodedException) {
+    val reactContext = (view.context as? ReactContext) ?: return
+    val nativeModulesProxy = reactContext
+      .catalystInstance
+      ?.getNativeModule("NativeUnimoduleProxy") as? NativeModulesProxy
+      ?: return
+    val appContext = nativeModulesProxy.kotlinInteropModuleRegistry.appContext
+
+    appContext.errorManager?.reportExceptionToLogBox(exception)
+  }
 }

package/android/src/main/java/expo/modules/kotlin/views/ViewManagerDefinitionBuilder.kt

@@ -1,35 +1,84 @@
 @file:OptIn(ExperimentalStdlibApi::class)
+@file:Suppress("FunctionName")
 
 package expo.modules.kotlin.views
 
 import android.content.Context
 import android.view.View
+import expo.modules.kotlin.modules.DefinitionMarker
 import expo.modules.kotlin.types.toAnyType
 import kotlin.reflect.typeOf
 
+@DefinitionMarker
 class ViewManagerDefinitionBuilder {
   @PublishedApi
   internal var viewFactory: ((Context) -> View)? = null
+
   @PublishedApi
   internal var viewType: Class<out View>? = null
+
   @PublishedApi
   internal var props = mutableMapOf<String, AnyViewProp>()
 
+  @PublishedApi
+  internal var onViewDestroys: ((View) -> Unit)? = null
+
+  @PublishedApi
+  internal var viewGroupDefinition: ViewGroupDefinition? = null
+  private var callbacksDefinition: CallbacksDefinition? = null
+
   fun build(): ViewManagerDefinition =
     ViewManagerDefinition(
       requireNotNull(viewFactory),
       requireNotNull(viewType),
-      props
+      props,
+      onViewDestroys,
+      callbacksDefinition,
+      viewGroupDefinition
     )
 
-  inline fun <reified ViewType : View> view(noinline body: (Context) -> ViewType) {
+  @Deprecated(
+    message = "The 'view' component was renamed to 'View'.",
+    replaceWith = ReplaceWith("View(body)")
+  )
+  inline fun <reified ViewType : View> view(noinline body: (Context) -> ViewType) = View(body)
+
+  /**
+   * Defines the factory creating a native view when the module is used as a view.
+   */
+  inline fun <reified ViewType : View> View(noinline body: (Context) -> ViewType) {
     viewType = ViewType::class.java
     viewFactory = body
   }
 
+  @Deprecated(
+    message = "The 'onViewDestroys' component was renamed to 'OnViewDestroys'.",
+    replaceWith = ReplaceWith("OnViewDestroys(body)")
+  )
+  inline fun <reified ViewType : View> onViewDestroys(noinline body: (view: ViewType) -> Unit) = OnViewDestroys(body)
+
+  /**
+   * Creates view's lifecycle listener that is called right after the view isn't longer used by React Native.
+   */
+  inline fun <reified ViewType : View> OnViewDestroys(noinline body: (view: ViewType) -> Unit) {
+    onViewDestroys = { body(it as ViewType) }
+  }
+
+  @Deprecated(
+    message = "The 'prop' component was renamed to 'Prop'.",
+    replaceWith = ReplaceWith("Prop(body)")
+  )
   inline fun <reified ViewType : View, reified PropType> prop(
     name: String,
     noinline body: (view: ViewType, prop: PropType) -> Unit
+  ) = Prop(name, body)
+
+  /**
+   * Creates a view prop that defines its name and setter.
+   */
+  inline fun <reified ViewType : View, reified PropType> Prop(
+    name: String,
+    noinline body: (view: ViewType, prop: PropType) -> Unit
   ) {
     props[name] = ConcreteViewProp(
       name,
@@ -37,4 +86,34 @@ class ViewManagerDefinitionBuilder {
       body
     )
   }
+
+  @Deprecated(
+    message = "The 'events' component was renamed to 'Events'.",
+    replaceWith = ReplaceWith("Events(callbacks)")
+  )
+  fun events(vararg callbacks: String) = Events(*callbacks)
+
+  /**
+   * Defines prop names that should be treated as callbacks.
+   */
+  fun Events(vararg callbacks: String) {
+    callbacksDefinition = CallbacksDefinition(callbacks)
+  }
+
+  @Deprecated(
+    message = "The 'groupView' component was renamed to 'GroupView'.",
+    replaceWith = ReplaceWith("GroupView(callbacks)")
+  )
+  inline fun groupView(body: ViewGroupDefinitionBuilder.() -> Unit) = GroupView(body)
+
+  /**
+   * Creates the group view definition that scopes group view-related definitions.
+   */
+  inline fun GroupView(body: ViewGroupDefinitionBuilder.() -> Unit) {
+    require(viewGroupDefinition == null) { "The viewManager definition may have exported only one groupView definition." }
+
+    val groupViewDefinitionBuilder = ViewGroupDefinitionBuilder()
+    body.invoke(groupViewDefinitionBuilder)
+    viewGroupDefinition = groupViewDefinitionBuilder.build()
+  }
 }