feat: add properties enumeration to ViewModel and ViewModelInstance

Adds getPropertiesAsync() to ViewModel and ViewModelInstance for runtime
introspection. Returns ViewModelPropertyInfo[] with name and type for each
property.

Author: mfazekas

android/src/new/java/com/margelo/nitro/rive/HybridViewModel.kt

@@ -5,6 +5,7 @@ import app.rive.RiveFile
 import app.rive.ViewModelInstance
 import app.rive.ViewModelSource
 import app.rive.core.CommandQueue
+import app.rive.runtime.kotlin.core.ViewModel
 import com.facebook.proguard.annotations.DoNotStrip
 import com.margelo.nitro.core.Promise
 import kotlinx.coroutines.runBlocking
@@ -22,6 +23,17 @@ class HybridViewModel(
     private const val TAG = "HybridViewModel"
   }
 
+  override fun getPropertiesAsync(): Promise<Array<ViewModelPropertyInfo>> {
+    val name = viewModelName ?: return Promise.resolved(emptyArray())
+    return Promise.async {
+      riveFile
+        .getViewModelProperties(name)
+        .map { prop ->
+        ViewModelPropertyInfo(name = prop.name, type = mapPropertyType(prop.type))
+      }.toTypedArray()
+    }
+  }
+
   override val propertyCount: Double
     get() {
       DeprecationWarning.warn("propertyCount", "getPropertyCountAsync")
@@ -147,3 +159,19 @@ class HybridViewModel(
     }
   }
 }
+
+internal fun mapPropertyType(type: ViewModel.PropertyDataType): ViewModelPropertyType = when (type) {
+  ViewModel.PropertyDataType.NONE -> ViewModelPropertyType.NONE
+  ViewModel.PropertyDataType.STRING -> ViewModelPropertyType.STRING
+  ViewModel.PropertyDataType.NUMBER -> ViewModelPropertyType.NUMBER
+  ViewModel.PropertyDataType.BOOLEAN -> ViewModelPropertyType.BOOLEAN
+  ViewModel.PropertyDataType.COLOR -> ViewModelPropertyType.COLOR
+  ViewModel.PropertyDataType.LIST -> ViewModelPropertyType.LIST
+  ViewModel.PropertyDataType.ENUM -> ViewModelPropertyType.ENUM
+  ViewModel.PropertyDataType.TRIGGER -> ViewModelPropertyType.TRIGGER
+  ViewModel.PropertyDataType.VIEW_MODEL -> ViewModelPropertyType.VIEWMODEL
+  ViewModel.PropertyDataType.INTEGER -> ViewModelPropertyType.INTEGER
+  ViewModel.PropertyDataType.SYMBOL_LIST_INDEX -> ViewModelPropertyType.SYMBOLLISTINDEX
+  ViewModel.PropertyDataType.ASSET_IMAGE -> ViewModelPropertyType.ASSETIMAGE
+  ViewModel.PropertyDataType.ARTBOARD -> ViewModelPropertyType.ARTBOARD
+}

android/src/new/java/com/margelo/nitro/rive/HybridViewModelInstance.kt

@@ -44,6 +44,18 @@ class HybridViewModelInstance(
   override val instanceName: String
     get() = _instanceName ?: ""
 
+  override fun getPropertiesAsync(): Promise<Array<ViewModelPropertyInfo>> {
+    val name = viewModelName ?: return Promise.resolved(emptyArray())
+    val file = parentFile.riveFile ?: return Promise.resolved(emptyArray())
+    return Promise.async {
+      file
+        .getViewModelProperties(name)
+        .map { prop ->
+        ViewModelPropertyInfo(name = prop.name, type = mapPropertyType(prop.type))
+      }.toTypedArray()
+    }
+  }
+
   override fun numberProperty(path: String): HybridViewModelNumberPropertySpec? {
     return try {
       runBlocking { viewModelInstance.getNumberFlow(path).first() }

example/package.json

@@ -34,7 +34,6 @@
     "@react-native-community/cli": "18.0.0",
     "@react-native-community/cli-platform-android": "18.0.0",
     "@react-native-community/cli-platform-ios": "18.0.0",
-    "@react-native-harness/coverage-ios": "file:/Users/boga/Work/Margelo/react-native-harness/packages/coverage-ios",
     "@react-native-harness/platform-android": "1.0.0",
     "@react-native-harness/platform-apple": "1.0.0",
     "@react-native/babel-preset": "0.79.2",

example/rn-harness.config.mjs

@@ -24,12 +24,4 @@ export default {
     }),
   ],
   defaultRunner: 'ios',
-
-  coverage: {
-    native: {
-      ios: {
-        pods: ['RNRive', 'RiveRuntime'],
-      },
-    },
-  },
 };

ios/new/HybridViewModel.swift

@@ -34,6 +34,13 @@ class HybridViewModel: HybridViewModelSpec {
     }
   }
 
+  func getPropertiesAsync() throws -> Promise<[ViewModelPropertyInfo]> {
+    return Promise.async {
+      let props = try await self.file.getProperties(of: self.vmName)
+      return props.map { ViewModelPropertyInfo(name: $0.name, type: mapPropertyType($0.type)) }
+    }
+  }
+
   func getPropertyCountAsync() throws -> Promise<Double> {
     return Promise.async {
       Double(try await self.file.getProperties(of: self.vmName).count)
@@ -48,7 +55,7 @@ class HybridViewModel: HybridViewModelSpec {
 
   private func createDefaultInstanceImpl() async throws -> (any HybridViewModelInstanceSpec)? {
     let vmi = try await self.file.createViewModelInstance(.viewModelDefault(from: .name(self.vmName)))
-    return HybridViewModelInstance(viewModelInstance: vmi, worker: self.worker)
+    return HybridViewModelInstance(viewModelInstance: vmi, worker: self.worker, file: self.file, vmName: self.vmName)
   }
 
   private func createInstanceByIndexImpl(index: Double) async throws -> (any HybridViewModelInstanceSpec)? {
@@ -57,7 +64,7 @@ class HybridViewModel: HybridViewModelSpec {
     guard idx >= 0 && idx < names.count else { return nil }
     let name = names[idx]
     let vmi = try await self.file.createViewModelInstance(.name(name, from: .name(self.vmName)))
-    return HybridViewModelInstance(viewModelInstance: vmi, worker: self.worker, instanceName: name)
+    return HybridViewModelInstance(viewModelInstance: vmi, worker: self.worker, instanceName: name, file: self.file, vmName: self.vmName)
   }
 
   // Deprecated: Use createInstanceByNameAsync instead
@@ -68,7 +75,7 @@ class HybridViewModel: HybridViewModelSpec {
 
   private func createInstanceByNameImpl(name: String) async throws -> (any HybridViewModelInstanceSpec)? {
     let vmi = try await self.file.createViewModelInstance(.name(name, from: .name(self.vmName)))
-    return HybridViewModelInstance(viewModelInstance: vmi, worker: self.worker, instanceName: name)
+    return HybridViewModelInstance(viewModelInstance: vmi, worker: self.worker, instanceName: name, file: self.file, vmName: self.vmName)
   }
 
   // Deprecated: Use createInstanceByNameAsync instead
@@ -93,7 +100,7 @@ class HybridViewModel: HybridViewModelSpec {
 
   private func createInstanceImpl() async throws -> (any HybridViewModelInstanceSpec)? {
     let vmi = try await self.file.createViewModelInstance(.blank(from: .name(self.vmName)))
-    return HybridViewModelInstance(viewModelInstance: vmi, worker: self.worker)
+    return HybridViewModelInstance(viewModelInstance: vmi, worker: self.worker, file: self.file, vmName: self.vmName)
   }
 
   // Deprecated: Use createBlankInstanceAsync instead
@@ -106,3 +113,24 @@ class HybridViewModel: HybridViewModelSpec {
     return Promise.async { try await self.createInstanceImpl() }
   }
 }
+
+func mapPropertyType(_ type: RiveRuntime.ViewModelProperty.DataType) -> ViewModelPropertyType {
+  switch type {
+  case .none: return .none
+  case .string: return .string
+  case .number: return .number
+  case .boolean: return .boolean
+  case .color: return .color
+  case .list: return .list
+  case .enum: return .enum
+  case .trigger: return .trigger
+  case .viewModel: return .viewmodel
+  case .integer: return .integer
+  case .symbolListIndex: return .symbollistindex
+  case .assetImage: return .assetimage
+  case .artboard: return .artboard
+  case .input: return .input
+  case .any: return .any
+  @unknown default: return .none
+  }
+}

ios/new/HybridViewModelInstance.swift

@@ -5,17 +5,27 @@ class HybridViewModelInstance: HybridViewModelInstanceSpec {
   let viewModelInstance: ViewModelInstance
   let worker: Worker
   private let _instanceName: String
+  private let file: File?
+  private let vmName: String?
 
-  init(viewModelInstance: ViewModelInstance, worker: Worker, instanceName: String = "") {
+  init(viewModelInstance: ViewModelInstance, worker: Worker, instanceName: String = "", file: File? = nil, vmName: String? = nil) {
     self.viewModelInstance = viewModelInstance
     self.worker = worker
     self._instanceName = instanceName
+    self.file = file
+    self.vmName = vmName
   }
 
-  // TODO: Workaround — rive-ios experimental SDK doesn't expose ViewModelInstance.name.
-  // Only works when caller knows the name (createInstanceByName). Falls back to "" otherwise.
   var instanceName: String { _instanceName }
 
+  func getPropertiesAsync() throws -> Promise<[ViewModelPropertyInfo]> {
+    guard let file = file, let vmName = vmName else { return Promise.resolved(withResult: []) }
+    return Promise.async {
+      let props = try await file.getProperties(of: vmName)
+      return props.map { ViewModelPropertyInfo(name: $0.name, type: mapPropertyType($0.type)) }
+    }
+  }
+
   // Note: Unlike legacy API, experimental API can't sync-validate if property exists
   // Non-existent properties return wrapper objects that fail on getValue()
   // This is a known limitation documented in EXPERIMENTAL_IOS_API.md