@rive-app/react-native 0.1.1 → 0.1.2

package/nitrogen/generated/ios/swift/HybridViewModelListPropertySpec_cxx.swift

@@ -0,0 +1,248 @@
+///
+/// HybridViewModelListPropertySpec_cxx.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+import Foundation
+import NitroModules
+
+/**
+ * A class implementation that bridges HybridViewModelListPropertySpec over to C++.
+ * In C++, we cannot use Swift protocols - so we need to wrap it in a class to make it strongly defined.
+ *
+ * Also, some Swift types need to be bridged with special handling:
+ * - Enums need to be wrapped in Structs, otherwise they cannot be accessed bi-directionally (Swift bug: https://github.com/swiftlang/swift/issues/75330)
+ * - Other HybridObjects need to be wrapped/unwrapped from the Swift TCxx wrapper
+ * - Throwing methods need to be wrapped with a Result<T, Error> type, as exceptions cannot be propagated to C++
+ */
+open class HybridViewModelListPropertySpec_cxx : HybridViewModelPropertySpec_cxx {
+  /**
+   * The Swift <> C++ bridge's namespace (`margelo::nitro::rive::bridge::swift`)
+   * from `RNRive-Swift-Cxx-Bridge.hpp`.
+   * This contains specialized C++ templates, and C++ helper functions that can be accessed from Swift.
+   */
+  public typealias bridge = margelo.nitro.rive.bridge.swift
+
+  /**
+   * Holds an instance of the `HybridViewModelListPropertySpec` Swift protocol.
+   */
+  private var __implementation: any HybridViewModelListPropertySpec
+
+  /**
+   * Holds a weak pointer to the C++ class that wraps the Swift class.
+   */
+  private var __cxxPart: bridge.std__weak_ptr_HybridViewModelListPropertySpec_
+
+  /**
+   * Create a new `HybridViewModelListPropertySpec_cxx` that wraps the given `HybridViewModelListPropertySpec`.
+   * All properties and methods bridge to C++ types.
+   */
+  public init(_ implementation: any HybridViewModelListPropertySpec) {
+    self.__implementation = implementation
+    self.__cxxPart = .init()
+    super.init(implementation)
+  }
+
+  /**
+   * Get the actual `HybridViewModelListPropertySpec` instance this class wraps.
+   */
+  @inline(__always)
+  public func getHybridViewModelListPropertySpec() -> any HybridViewModelListPropertySpec {
+    return __implementation
+  }
+
+  /**
+   * Casts this instance to a retained unsafe raw pointer.
+   * This acquires one additional strong reference on the object!
+   */
+  public override func toUnsafe() -> UnsafeMutableRawPointer {
+    return Unmanaged.passRetained(self).toOpaque()
+  }
+
+  /**
+   * Casts an unsafe pointer to a `HybridViewModelListPropertySpec_cxx`.
+   * The pointer has to be a retained opaque `Unmanaged<HybridViewModelListPropertySpec_cxx>`.
+   * This removes one strong reference from the object!
+   */
+  public override class func fromUnsafe(_ pointer: UnsafeMutableRawPointer) -> HybridViewModelListPropertySpec_cxx {
+    return Unmanaged<HybridViewModelListPropertySpec_cxx>.fromOpaque(pointer).takeRetainedValue()
+  }
+
+  /**
+   * Gets (or creates) the C++ part of this Hybrid Object.
+   * The C++ part is a `std::shared_ptr<HybridViewModelListPropertySpec>`.
+   */
+  public func getCxxPart() -> bridge.std__shared_ptr_HybridViewModelListPropertySpec_ {
+    let cachedCxxPart = self.__cxxPart.lock()
+    if Bool(fromCxx: cachedCxxPart) {
+      return cachedCxxPart
+    } else {
+      let newCxxPart = bridge.create_std__shared_ptr_HybridViewModelListPropertySpec_(self.toUnsafe())
+      __cxxPart = bridge.weakify_std__shared_ptr_HybridViewModelListPropertySpec_(newCxxPart)
+      return newCxxPart
+    }
+  }
+
+  public override func getCxxPart() -> bridge.std__shared_ptr_HybridViewModelPropertySpec_ {
+    let ownCxxPart: bridge.std__shared_ptr_HybridViewModelListPropertySpec_ = getCxxPart()
+    return bridge.upcast_ViewModelListProperty_to_ViewModelProperty(ownCxxPart)
+  }
+
+  /**
+   * Get the memory size of the Swift class (plus size of any other allocations)
+   * so the JS VM can properly track it and garbage-collect the JS object if needed.
+   */
+  @inline(__always)
+  public override var memorySize: Int {
+    return MemoryHelper.getSizeOf(self.__implementation) + self.__implementation.memorySize
+  }
+
+  /**
+   * Call dispose() on the Swift class.
+   * This _may_ be called manually from JS.
+   */
+  @inline(__always)
+  public override func dispose() {
+    self.__implementation.dispose()
+  }
+
+  /**
+   * Call toString() on the Swift class.
+   */
+  @inline(__always)
+  public override func toString() -> String {
+    return self.__implementation.toString()
+  }
+
+  // Properties
+  public final var length: Double {
+    @inline(__always)
+    get {
+      return self.__implementation.length
+    }
+  }
+
+  // Methods
+  @inline(__always)
+  public final func getInstanceAt(index: Double) -> bridge.Result_std__optional_std__shared_ptr_HybridViewModelInstanceSpec___ {
+    do {
+      let __result = try self.__implementation.getInstanceAt(index: index)
+      let __resultCpp = { () -> bridge.std__optional_std__shared_ptr_HybridViewModelInstanceSpec__ in
+        if let __unwrappedValue = __result {
+          return bridge.create_std__optional_std__shared_ptr_HybridViewModelInstanceSpec__({ () -> bridge.std__shared_ptr_HybridViewModelInstanceSpec_ in
+            let __cxxWrapped = __unwrappedValue.getCxxWrapper()
+            return __cxxWrapped.getCxxPart()
+          }())
+        } else {
+          return .init()
+        }
+      }()
+      return bridge.create_Result_std__optional_std__shared_ptr_HybridViewModelInstanceSpec___(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__optional_std__shared_ptr_HybridViewModelInstanceSpec___(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func addInstance(instance: bridge.std__shared_ptr_HybridViewModelInstanceSpec_) -> bridge.Result_void_ {
+    do {
+      try self.__implementation.addInstance(instance: { () -> HybridViewModelInstanceSpec in
+        let __unsafePointer = bridge.get_std__shared_ptr_HybridViewModelInstanceSpec_(instance)
+        let __instance = HybridViewModelInstanceSpec_cxx.fromUnsafe(__unsafePointer)
+        return __instance.getHybridViewModelInstanceSpec()
+      }())
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func addInstanceAt(instance: bridge.std__shared_ptr_HybridViewModelInstanceSpec_, index: Double) -> bridge.Result_bool_ {
+    do {
+      let __result = try self.__implementation.addInstanceAt(instance: { () -> HybridViewModelInstanceSpec in
+        let __unsafePointer = bridge.get_std__shared_ptr_HybridViewModelInstanceSpec_(instance)
+        let __instance = HybridViewModelInstanceSpec_cxx.fromUnsafe(__unsafePointer)
+        return __instance.getHybridViewModelInstanceSpec()
+      }(), index: index)
+      let __resultCpp = __result
+      return bridge.create_Result_bool_(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_bool_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func removeInstance(instance: bridge.std__shared_ptr_HybridViewModelInstanceSpec_) -> bridge.Result_void_ {
+    do {
+      try self.__implementation.removeInstance(instance: { () -> HybridViewModelInstanceSpec in
+        let __unsafePointer = bridge.get_std__shared_ptr_HybridViewModelInstanceSpec_(instance)
+        let __instance = HybridViewModelInstanceSpec_cxx.fromUnsafe(__unsafePointer)
+        return __instance.getHybridViewModelInstanceSpec()
+      }())
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func removeInstanceAt(index: Double) -> bridge.Result_void_ {
+    do {
+      try self.__implementation.removeInstanceAt(index: index)
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func swap(index1: Double, index2: Double) -> bridge.Result_bool_ {
+    do {
+      let __result = try self.__implementation.swap(index1: index1, index2: index2)
+      let __resultCpp = __result
+      return bridge.create_Result_bool_(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_bool_(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func addListener(onChanged: bridge.Func_void) -> bridge.Result_std__function_void____ {
+    do {
+      let __result = try self.__implementation.addListener(onChanged: { () -> () -> Void in
+        let __wrappedFunction = bridge.wrap_Func_void(onChanged)
+        return { () -> Void in
+          __wrappedFunction.call()
+        }
+      }())
+      let __resultCpp = { () -> bridge.Func_void in
+        let __closureWrapper = Func_void(__result)
+        return bridge.create_Func_void(__closureWrapper.toUnsafe())
+      }()
+      return bridge.create_Result_std__function_void____(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__function_void____(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func removeListeners() -> bridge.Result_void_ {
+    do {
+      try self.__implementation.removeListeners()
+      return bridge.create_Result_void_()
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_void_(__exceptionPtr)
+    }
+  }
+}

package/nitrogen/generated/shared/c++/HybridViewModelInstanceSpec.cpp

@@ -22,6 +22,7 @@ namespace margelo::nitro::rive {
       prototype.registerHybridMethod("enumProperty", &HybridViewModelInstanceSpec::enumProperty);
       prototype.registerHybridMethod("triggerProperty", &HybridViewModelInstanceSpec::triggerProperty);
       prototype.registerHybridMethod("imageProperty", &HybridViewModelInstanceSpec::imageProperty);
+      prototype.registerHybridMethod("listProperty", &HybridViewModelInstanceSpec::listProperty);
     });
   }
 

package/nitrogen/generated/shared/c++/HybridViewModelInstanceSpec.hpp

@@ -27,6 +27,8 @@ namespace margelo::nitro::rive { class HybridViewModelEnumPropertySpec; }
 namespace margelo::nitro::rive { class HybridViewModelTriggerPropertySpec; }
 // Forward declaration of `HybridViewModelImagePropertySpec` to properly resolve imports.
 namespace margelo::nitro::rive { class HybridViewModelImagePropertySpec; }
+// Forward declaration of `HybridViewModelListPropertySpec` to properly resolve imports.
+namespace margelo::nitro::rive { class HybridViewModelListPropertySpec; }
 
 #include <string>
 #include <memory>
@@ -38,6 +40,7 @@ namespace margelo::nitro::rive { class HybridViewModelImagePropertySpec; }
 #include "HybridViewModelEnumPropertySpec.hpp"
 #include "HybridViewModelTriggerPropertySpec.hpp"
 #include "HybridViewModelImagePropertySpec.hpp"
+#include "HybridViewModelListPropertySpec.hpp"
 
 namespace margelo::nitro::rive {
 
@@ -77,6 +80,7 @@ namespace margelo::nitro::rive {
       virtual std::optional<std::shared_ptr<HybridViewModelEnumPropertySpec>> enumProperty(const std::string& path) = 0;
       virtual std::optional<std::shared_ptr<HybridViewModelTriggerPropertySpec>> triggerProperty(const std::string& path) = 0;
       virtual std::optional<std::shared_ptr<HybridViewModelImagePropertySpec>> imageProperty(const std::string& path) = 0;
+      virtual std::optional<std::shared_ptr<HybridViewModelListPropertySpec>> listProperty(const std::string& path) = 0;
 
     protected:
       // Hybrid Setup

package/nitrogen/generated/shared/c++/HybridViewModelListPropertySpec.cpp

@@ -0,0 +1,30 @@
+///
+/// HybridViewModelListPropertySpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#include "HybridViewModelListPropertySpec.hpp"
+
+namespace margelo::nitro::rive {
+
+  void HybridViewModelListPropertySpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    HybridViewModelPropertySpec::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridGetter("length", &HybridViewModelListPropertySpec::getLength);
+      prototype.registerHybridMethod("getInstanceAt", &HybridViewModelListPropertySpec::getInstanceAt);
+      prototype.registerHybridMethod("addInstance", &HybridViewModelListPropertySpec::addInstance);
+      prototype.registerHybridMethod("addInstanceAt", &HybridViewModelListPropertySpec::addInstanceAt);
+      prototype.registerHybridMethod("removeInstance", &HybridViewModelListPropertySpec::removeInstance);
+      prototype.registerHybridMethod("removeInstanceAt", &HybridViewModelListPropertySpec::removeInstanceAt);
+      prototype.registerHybridMethod("swap", &HybridViewModelListPropertySpec::swap);
+      prototype.registerHybridMethod("addListener", &HybridViewModelListPropertySpec::addListener);
+      prototype.registerHybridMethod("removeListeners", &HybridViewModelListPropertySpec::removeListeners);
+    });
+  }
+
+} // namespace margelo::nitro::rive

package/nitrogen/generated/shared/c++/HybridViewModelListPropertySpec.hpp

@@ -0,0 +1,76 @@
+///
+/// HybridViewModelListPropertySpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 2025 Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `HybridViewModelInstanceSpec` to properly resolve imports.
+namespace margelo::nitro::rive { class HybridViewModelInstanceSpec; }
+// Forward declaration of `HybridViewModelPropertySpec` to properly resolve imports.
+namespace margelo::nitro::rive { class HybridViewModelPropertySpec; }
+
+#include <memory>
+#include "HybridViewModelInstanceSpec.hpp"
+#include <optional>
+#include <functional>
+#include "HybridViewModelPropertySpec.hpp"
+
+namespace margelo::nitro::rive {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `ViewModelListProperty`
+   * Inherit this class to create instances of `HybridViewModelListPropertySpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridViewModelListProperty: public HybridViewModelListPropertySpec {
+   * public:
+   *   HybridViewModelListProperty(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridViewModelListPropertySpec: public virtual HybridObject, public virtual HybridViewModelPropertySpec {
+    public:
+      // Constructor
+      explicit HybridViewModelListPropertySpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridViewModelListPropertySpec() override = default;
+
+    public:
+      // Properties
+      virtual double getLength() = 0;
+
+    public:
+      // Methods
+      virtual std::optional<std::shared_ptr<HybridViewModelInstanceSpec>> getInstanceAt(double index) = 0;
+      virtual void addInstance(const std::shared_ptr<HybridViewModelInstanceSpec>& instance) = 0;
+      virtual bool addInstanceAt(const std::shared_ptr<HybridViewModelInstanceSpec>& instance, double index) = 0;
+      virtual void removeInstance(const std::shared_ptr<HybridViewModelInstanceSpec>& instance) = 0;
+      virtual void removeInstanceAt(double index) = 0;
+      virtual bool swap(double index1, double index2) = 0;
+      virtual std::function<void()> addListener(const std::function<void()>& onChanged) = 0;
+      virtual void removeListeners() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "ViewModelListProperty";
+  };
+
+} // namespace margelo::nitro::rive

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/react-native",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Rive React Native",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -64,8 +64,8 @@
   },
   "homepage": "https://github.com/rive-app/rive-nitro-react-native#readme",
   "runtimeVersions": {
-    "ios": "6.12.0",
-    "android": "10.5.0"
+    "ios": "6.12.3",
+    "android": "10.5.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/src/hooks/useRiveColor.ts

@@ -3,7 +3,6 @@ import type {
   ViewModelColorProperty,
   ViewModelInstance,
 } from '../specs/ViewModel.nitro';
-import { type UseRivePropertyResult } from '../types';
 import { useRiveProperty } from './useRiveProperty';
 import { RiveColor } from '../core/RiveColor';
 
@@ -11,6 +10,12 @@ const COLOR_PROPERTY_OPTIONS = {
   getProperty: (vmi: ViewModelInstance, p: string) => vmi.colorProperty(p),
 };
 
+export interface UseRiveColorResult {
+  value: RiveColor | undefined;
+  setValue: (value: RiveColor | string) => void;
+  error: Error | null;
+}
+
 /**
  * Hook for interacting with color ViewModel instance properties.
  *
@@ -21,9 +26,7 @@ const COLOR_PROPERTY_OPTIONS = {
 export function useRiveColor(
   path: string,
   viewModelInstance?: ViewModelInstance | null
-): UseRivePropertyResult<RiveColor> & {
-  setValue: (value: RiveColor | string) => void;
-} {
+): UseRiveColorResult {
   const [rawValue, setRawValue, error] = useRiveProperty<
     ViewModelColorProperty,
     number

package/src/hooks/useRiveList.ts

@@ -0,0 +1,108 @@
+import { useCallback, useEffect, useState, useMemo } from 'react';
+import type { ViewModelInstance } from '../specs/ViewModel.nitro';
+import type { UseRiveListResult } from '../types';
+
+/**
+ * Hook for interacting with list ViewModel instance properties.
+ *
+ * @param path - The path to the list property
+ * @param viewModelInstance - The ViewModelInstance containing the list property
+ * @returns An object with list length, manipulation methods, and error state
+ */
+export function useRiveList(
+  path: string,
+  viewModelInstance?: ViewModelInstance | null
+): UseRiveListResult {
+  const [error, setError] = useState<Error | null>(null);
+  const [revision, setRevision] = useState(0);
+
+  useEffect(() => {
+    setError(null);
+  }, [path, viewModelInstance]);
+
+  const property = useMemo(() => {
+    if (!viewModelInstance) return undefined;
+    return viewModelInstance.listProperty(path);
+  }, [viewModelInstance, path]);
+
+  useEffect(() => {
+    if (viewModelInstance && !property) {
+      setError(
+        new Error(`List property "${path}" not found in the ViewModel instance`)
+      );
+    }
+  }, [viewModelInstance, property, path]);
+
+  useEffect(() => {
+    if (!property) return;
+
+    const removeListener = property.addListener(() => {
+      setRevision((r) => r + 1);
+    });
+
+    return () => {
+      removeListener();
+      property.removeListeners();
+      property.dispose();
+    };
+  }, [property]);
+
+  const length = useMemo(() => {
+    // revision is used to trigger re-computation when list changes
+    revision;
+    return property?.length ?? 0;
+  }, [property, revision]);
+
+  const getInstanceAt = useCallback(
+    (index: number) => {
+      return property?.getInstanceAt(index);
+    },
+    [property]
+  );
+
+  const addInstance = useCallback(
+    (instance: ViewModelInstance) => {
+      property?.addInstance(instance);
+    },
+    [property]
+  );
+
+  const addInstanceAt = useCallback(
+    (instance: ViewModelInstance, index: number) => {
+      return property?.addInstanceAt(instance, index) ?? false;
+    },
+    [property]
+  );
+
+  const removeInstance = useCallback(
+    (instance: ViewModelInstance) => {
+      property?.removeInstance(instance);
+    },
+    [property]
+  );
+
+  const removeInstanceAt = useCallback(
+    (index: number) => {
+      property?.removeInstanceAt(index);
+    },
+    [property]
+  );
+
+  const swap = useCallback(
+    (index1: number, index2: number) => {
+      return property?.swap(index1, index2) ?? false;
+    },
+    [property]
+  );
+
+  return {
+    length,
+    getInstanceAt,
+    addInstance,
+    addInstanceAt,
+    removeInstance,
+    removeInstanceAt,
+    swap,
+    error,
+  };
+}

package/src/hooks/useRiveProperty.ts

@@ -28,7 +28,12 @@ export function useRiveProperty<P extends ViewModelProperty, T>(
     /** Optional override callback for property events (mainly used by triggers) */
     onPropertyEventOverride?: (...args: any[]) => void;
   }
-): [T | undefined, (value: T) => void, Error | null, P | undefined] {
+): [
+  T | undefined,
+  (value: T | ((prevValue: T | undefined) => T)) => void,
+  Error | null,
+  P | undefined,
+] {
   const [value, setValue] = useState<T | undefined>(undefined);
   const [error, setError] = useState<Error | null>(null);
 
@@ -61,25 +66,21 @@ export function useRiveProperty<P extends ViewModelProperty, T>(
 
     // If an override callback is provided, use it.
     // Otherwise, use the default callback.
-    if (options.onPropertyEventOverride) {
-      property.addListener(options.onPropertyEventOverride);
-    } else {
-      property.addListener((newValue) => {
-        setValue(newValue);
-      });
-    }
+    const removeListener = options.onPropertyEventOverride
+      ? property.addListener(options.onPropertyEventOverride)
+      : property.addListener((newValue) => {
+          setValue(newValue);
+        });
 
-    // Cleanup: Remove listeners and dispose of the property
-    // This ensures proper cleanup of event listeners and resources
     return () => {
-      property.removeListeners();
+      removeListener();
       property.dispose();
     };
   }, [options, property]);
 
   // Set the value of the property
   const setPropertyValue = useCallback(
-    (newValue: T) => {
+    (valueOrUpdater: T | ((prevValue: T | undefined) => T)) => {
       if (!property) {
         setError(
           new Error(
@@ -87,6 +88,12 @@ export function useRiveProperty<P extends ViewModelProperty, T>(
           )
         );
       } else {
+        const newValue =
+          typeof valueOrUpdater === 'function'
+            ? (valueOrUpdater as (prevValue: T | undefined) => T)(
+                property.value
+              )
+            : valueOrUpdater;
         property.value = newValue;
       }
     },