@rive-app/react-native 0.2.2 → 0.2.4

package/nitrogen/generated/ios/swift/HybridRiveRuntimeSpec_cxx.swift

@@ -0,0 +1,164 @@
+///
+/// HybridRiveRuntimeSpec_cxx.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import Foundation
+import NitroModules
+
+/**
+ * A class implementation that bridges HybridRiveRuntimeSpec 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 HybridRiveRuntimeSpec_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 `HybridRiveRuntimeSpec` Swift protocol.
+   */
+  private var __implementation: any HybridRiveRuntimeSpec
+
+  /**
+   * Holds a weak pointer to the C++ class that wraps the Swift class.
+   */
+  private var __cxxPart: bridge.std__weak_ptr_HybridRiveRuntimeSpec_
+
+  /**
+   * Create a new `HybridRiveRuntimeSpec_cxx` that wraps the given `HybridRiveRuntimeSpec`.
+   * All properties and methods bridge to C++ types.
+   */
+  public init(_ implementation: any HybridRiveRuntimeSpec) {
+    self.__implementation = implementation
+    self.__cxxPart = .init()
+    /* no base class */
+  }
+
+  /**
+   * Get the actual `HybridRiveRuntimeSpec` instance this class wraps.
+   */
+  @inline(__always)
+  public func getHybridRiveRuntimeSpec() -> any HybridRiveRuntimeSpec {
+    return __implementation
+  }
+
+  /**
+   * Casts this instance to a retained unsafe raw pointer.
+   * This acquires one additional strong reference on the object!
+   */
+  public func toUnsafe() -> UnsafeMutableRawPointer {
+    return Unmanaged.passRetained(self).toOpaque()
+  }
+
+  /**
+   * Casts an unsafe pointer to a `HybridRiveRuntimeSpec_cxx`.
+   * The pointer has to be a retained opaque `Unmanaged<HybridRiveRuntimeSpec_cxx>`.
+   * This removes one strong reference from the object!
+   */
+  public class func fromUnsafe(_ pointer: UnsafeMutableRawPointer) -> HybridRiveRuntimeSpec_cxx {
+    return Unmanaged<HybridRiveRuntimeSpec_cxx>.fromOpaque(pointer).takeRetainedValue()
+  }
+
+  /**
+   * Gets (or creates) the C++ part of this Hybrid Object.
+   * The C++ part is a `std::shared_ptr<HybridRiveRuntimeSpec>`.
+   */
+  public func getCxxPart() -> bridge.std__shared_ptr_HybridRiveRuntimeSpec_ {
+    let cachedCxxPart = self.__cxxPart.lock()
+    if Bool(fromCxx: cachedCxxPart) {
+      return cachedCxxPart
+    } else {
+      let newCxxPart = bridge.create_std__shared_ptr_HybridRiveRuntimeSpec_(self.toUnsafe())
+      __cxxPart = bridge.weakify_std__shared_ptr_HybridRiveRuntimeSpec_(newCxxPart)
+      return newCxxPart
+    }
+  }
+
+  
+
+  /**
+   * 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 var memorySize: Int {
+    return MemoryHelper.getSizeOf(self.__implementation) + self.__implementation.memorySize
+  }
+
+  /**
+   * Compares this object with the given [other] object for reference equality.
+   */
+  @inline(__always)
+  public func equals(other: HybridRiveRuntimeSpec_cxx) -> Bool {
+    return self.__implementation === other.__implementation
+  }
+
+  /**
+   * Call dispose() on the Swift class.
+   * This _may_ be called manually from JS.
+   */
+  @inline(__always)
+  public func dispose() {
+    self.__implementation.dispose()
+  }
+
+  /**
+   * Call toString() on the Swift class.
+   */
+  @inline(__always)
+  public func toString() -> String {
+    return self.__implementation.toString()
+  }
+
+  // Properties
+  public final var isInitialized: Bool {
+    @inline(__always)
+    get {
+      return self.__implementation.isInitialized
+    }
+  }
+  
+  public final var initError: bridge.std__optional_std__string_ {
+    @inline(__always)
+    get {
+      return { () -> bridge.std__optional_std__string_ in
+        if let __unwrappedValue = self.__implementation.initError {
+          return bridge.create_std__optional_std__string_(std.string(__unwrappedValue))
+        } else {
+          return .init()
+        }
+      }()
+    }
+  }
+
+  // Methods
+  @inline(__always)
+  public final func initialize() -> bridge.Result_std__shared_ptr_Promise_void___ {
+    do {
+      let __result = try self.__implementation.initialize()
+      let __resultCpp = { () -> bridge.std__shared_ptr_Promise_void__ in
+        let __promise = bridge.create_std__shared_ptr_Promise_void__()
+        let __promiseHolder = bridge.wrap_std__shared_ptr_Promise_void__(__promise)
+        __result
+          .then({ __result in __promiseHolder.resolve() })
+          .catch({ __error in __promiseHolder.reject(__error.toCpp()) })
+        return __promise
+      }()
+      return bridge.create_Result_std__shared_ptr_Promise_void___(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__shared_ptr_Promise_void___(__exceptionPtr)
+    }
+  }
+}

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

@@ -0,0 +1,23 @@
+///
+/// HybridRiveRuntimeSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include "HybridRiveRuntimeSpec.hpp"
+
+namespace margelo::nitro::rive {
+
+  void HybridRiveRuntimeSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridGetter("isInitialized", &HybridRiveRuntimeSpec::getIsInitialized);
+      prototype.registerHybridGetter("initError", &HybridRiveRuntimeSpec::getInitError);
+      prototype.registerHybridMethod("initialize", &HybridRiveRuntimeSpec::initialize);
+    });
+  }
+
+} // namespace margelo::nitro::rive

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

@@ -0,0 +1,65 @@
+///
+/// HybridRiveRuntimeSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © 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
+
+
+
+#include <string>
+#include <optional>
+#include <NitroModules/Promise.hpp>
+
+namespace margelo::nitro::rive {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `RiveRuntime`
+   * Inherit this class to create instances of `HybridRiveRuntimeSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridRiveRuntime: public HybridRiveRuntimeSpec {
+   * public:
+   *   HybridRiveRuntime(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridRiveRuntimeSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridRiveRuntimeSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridRiveRuntimeSpec() override = default;
+
+    public:
+      // Properties
+      virtual bool getIsInitialized() = 0;
+      virtual std::optional<std::string> getInitError() = 0;
+
+    public:
+      // Methods
+      virtual std::shared_ptr<Promise<void>> initialize() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "RiveRuntime";
+  };
+
+} // namespace margelo::nitro::rive

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rive-app/react-native",
-  "version": "0.2.2",
+  "version": "0.2.4",
   "description": "Rive React Native",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",

package/src/core/RiveRuntime.ts

@@ -0,0 +1,23 @@
+import { NitroModules } from 'react-native-nitro-modules';
+import type { RiveRuntime as RiveRuntimeSpec } from '../specs/RiveRuntime.nitro';
+
+const RiveRuntimeInternal =
+  NitroModules.createHybridObject<RiveRuntimeSpec>('RiveRuntime');
+
+export namespace RiveRuntime {
+  export async function initialize(): Promise<void> {
+    await RiveRuntimeInternal.initialize();
+    if (!RiveRuntimeInternal.isInitialized) {
+      throw new Error(
+        `Rive initialization failed: ${RiveRuntimeInternal.initError ?? 'Unknown error'}`
+      );
+    }
+  }
+
+  export function getStatus(): { isInitialized: boolean; error?: string } {
+    return {
+      isInitialized: RiveRuntimeInternal.isInitialized,
+      error: RiveRuntimeInternal.initError ?? undefined,
+    };
+  }
+}

package/src/hooks/useRiveProperty.ts

@@ -86,15 +86,11 @@ export function useRiveProperty<P extends ViewModelProperty, T>(
     };
   }, [options, property]);
 
-  // Set the value of the property
+  // Set the value of the property (no-op if property isn't available yet)
   const setPropertyValue = useCallback(
     (valueOrUpdater: T | ((prevValue: T | undefined) => T)) => {
       if (!property) {
-        setError(
-          new Error(
-            `Cannot set value for property "${path}" because it was not found. Your view model instance may be undefined, or the path may be incorrect.`
-          )
-        );
+        return;
       } else {
         const newValue =
           typeof valueOrUpdater === 'function'
@@ -105,7 +101,7 @@ export function useRiveProperty<P extends ViewModelProperty, T>(
         property.value = newValue;
       }
     },
-    [property, path]
+    [property]
   );
 
   return [value, setPropertyValue, error, property as unknown as P];

package/src/index.tsx

@@ -55,4 +55,5 @@ export { useViewModelInstance } from './hooks/useViewModelInstance';
 export { useRiveFile } from './hooks/useRiveFile';
 export { type RiveFileInput } from './hooks/useRiveFile';
 export { type SetValueAction } from './types';
+export { RiveRuntime } from './core/RiveRuntime';
 export { DataBindMode };

package/src/specs/RiveRuntime.nitro.ts

@@ -0,0 +1,8 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface RiveRuntime
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  initialize(): Promise<void>;
+  readonly isInitialized: boolean;
+  readonly initError: string | undefined;
+}