react-native-nitro-modules 0.22.0 → 0.23.0

package/cpp/utils/ReferenceState.hpp

@@ -0,0 +1,40 @@
+//
+//  ReferenceState.hpp
+//  react-native-nitro
+//
+//  Created by Marc Rousavy on 03.02.24.
+//
+
+#pragma once
+
+#include <atomic>
+#include <mutex>
+
+namespace margelo::nitro {
+
+/**
+ * Holds state for an `BorrowingReference` (or `WeakReference`).
+ *
+ * The state tracks the amount of strong- and weak- references to any kind of value,
+ * including an extra `isDeleted` flag that specifies whether the value has been force-deleted.
+ *
+ * Also, a `mutex` allows for thread-safe access of the `isDeleted` flag.
+ */
+struct ReferenceState {
+  std::atomic_size_t strongRefCount;
+  std::atomic_size_t weakRefCount;
+  bool isDeleted;
+  std::mutex mutex;
+
+  /**
+   * Decrements the strong ref count by one, and returns whether the value should be deleted.
+   */
+  inline bool decrementStrongRefCount() {
+    size_t oldRefCount = strongRefCount.fetch_sub(1);
+    return oldRefCount <= 1;
+  }
+
+  explicit ReferenceState() : strongRefCount(1), weakRefCount(0), isDeleted(false) {}
+};
+
+} // namespace margelo::nitro

package/cpp/utils/WeakReference+Owning.hpp

@@ -0,0 +1,33 @@
+//
+//  WeakReference+Owning.hpp
+//  react-native-nitro
+//
+//  Created by Marc Rousavy on 23.06.24.
+//
+
+#pragma once
+
+#include "BorrowingReference.hpp"
+
+namespace margelo::nitro {
+
+template <typename T>
+WeakReference<T>::WeakReference(const BorrowingReference<T>& ref) {
+  _value = ref._value;
+  _state = ref._state;
+  _state->weakRefCount++;
+}
+
+template <typename T>
+BorrowingReference<T> WeakReference<T>::lock() const {
+  std::unique_lock lock(_state->mutex);
+
+  if (_state->isDeleted) {
+    // return nullptr
+    return BorrowingReference<T>();
+  }
+
+  return BorrowingReference(*this);
+}
+
+} // namespace margelo::nitro

package/cpp/utils/WeakReference.hpp

@@ -0,0 +1,102 @@
+//
+//  WeakReference.hpp
+//  NitroModules
+//
+//  Created by Marc Rousavy on 21.06.24.
+//
+
+#pragma once
+
+#include "ReferenceState.hpp"
+#include <atomic>
+#include <cstddef>
+#include <mutex>
+
+namespace margelo::nitro {
+
+// forward-declaration to avoid duplicate symbols
+template <typename T>
+class BorrowingReference;
+
+/**
+ A `WeakReference<T>` is a weak reference to a pointer created by `BorrowingReference<T>`.
+ It can be locked to gain a strong `BorrowingReference<T>` again if it has not been deleted yet.
+ */
+template <typename T>
+class WeakReference final {
+private:
+  explicit WeakReference(const BorrowingReference<T>& ref);
+
+public:
+  WeakReference() : _value(nullptr), _state(nullptr) {}
+
+  WeakReference(const WeakReference& ref) : _value(ref._value), _state(ref._state) {
+    if (_state != nullptr) {
+      // increment ref count after copy
+      _state->weakRefCount++;
+    }
+  }
+
+  WeakReference(WeakReference&& ref) : _value(ref._value), _state(ref._state) {
+    // Remove state from other WeakReference after moving since it's now stale data
+    ref._value = nullptr;
+    ref._state = nullptr;
+  }
+
+  WeakReference& operator=(const WeakReference& ref) {
+    if (this == &ref)
+      return *this;
+
+    if (_state != nullptr) {
+      // destroy previous pointer
+      _state->weakRefCount--;
+      maybeDestroy();
+    }
+
+    _value = ref._value;
+    _state = ref._state;
+    if (_state != nullptr) {
+      // increment new pointer
+      _state->weakRefCount++;
+    }
+
+    return *this;
+  }
+
+  ~WeakReference() {
+    if (_state == nullptr) {
+      // we are just a dangling nullptr.
+      return;
+    }
+
+    _state->weakRefCount--;
+    maybeDestroy();
+  }
+
+  /**
+   Try to lock the borrowing reference to an owning reference, or `nullptr` if it has already been deleted.
+   */
+  [[nodiscard]]
+  BorrowingReference<T> lock() const;
+
+public:
+  friend class BorrowingReference<T>;
+
+private:
+  void maybeDestroy() {
+    if (_state->strongRefCount == 0 && _state->weakRefCount == 0) {
+      // free the full memory if there are no more references at all
+      if (!_state->isDeleted) [[unlikely]] {
+        throw std::runtime_error("WeakReference<T> encountered a stale _value - BorrowingReference<T> should've already deleted this!");
+      }
+      delete _state;
+      _state = nullptr;
+    }
+  }
+
+private:
+  T* _value;
+  ReferenceState* _state;
+};
+
+} // namespace margelo::nitro

package/cpp/views/CachedProp.hpp

@@ -4,9 +4,9 @@
 
 #pragma once
 
+#include "BorrowingReference.hpp"
 #include "JSIConverter.hpp"
 #include "NitroDefines.hpp"
-#include "OwningReference.hpp"
 #include <jsi/jsi.h>
 
 namespace margelo::nitro {
@@ -17,7 +17,7 @@ template <typename T>
 struct CachedProp {
 public:
   T value;
-  OwningReference<jsi::Value> jsiValue;
+  BorrowingReference<jsi::Value> jsiValue;
   bool isDirty = false;
 
 public:
@@ -35,7 +35,7 @@ public:
     }
     T converted = JSIConverter<T>::fromJSI(runtime, value);
     JSICacheReference cache = JSICache::getOrCreateCache(runtime);
-    OwningReference<jsi::Value> cached = cache.makeShared(jsi::Value(runtime, value));
+    BorrowingReference<jsi::Value> cached = cache.makeShared(jsi::Value(runtime, value));
     return CachedProp<T>(std::move(converted), std::move(cached), /* isDirty */ true);
   }
 };

package/ios/core/AnyMapHolder.swift

@@ -44,7 +44,7 @@ public indirect enum AnyValue {
 /**
  * Represents an `AnyMap` that can be passed to Swift.
  */
-public class AnyMapHolder {
+public final class AnyMapHolder {
   public let cppPart: margelo.nitro.TSharedMap
 
   public init() {
@@ -54,7 +54,7 @@ public class AnyMapHolder {
   public init(withPreallocatedSize size: Int) {
     cppPart = margelo.nitro.AnyMap.make(size)
   }
-  
+
   public init(withCppPart otherCppPart: margelo.nitro.TSharedMap) {
     cppPart = otherCppPart
   }
@@ -120,7 +120,7 @@ public class AnyMapHolder {
     let value = cppPart.pointee.getString(std.string(key))
     return String(value)
   }
-  
+
   /**
    * Gets the array value at the given key.
    * If no value exists at the given key, or if it is not a double,
@@ -130,7 +130,7 @@ public class AnyMapHolder {
     let value = cppPart.pointee.getArray(std.string(key))
     return value.toSwift()
   }
-  
+
   /**
    * Gets the object value at the given key.
    * If no value exists at the given key, or if it is not a double,
@@ -177,14 +177,14 @@ public class AnyMapHolder {
   public func setString(key: String, value: String) {
     cppPart.pointee.setString(std.string(key), std.string(value))
   }
-  
+
   /**
    * Set the given key to the given array value.
    */
   public func setArray(key: String, value: [AnyValue]) {
     cppPart.pointee.setArray(std.string(key), margelo.nitro.AnyArray.create(value))
   }
-  
+
   /**
    * Set the given key to the given object value.
    */
@@ -228,14 +228,14 @@ public class AnyMapHolder {
   public func isString(key: String) -> Bool {
     return cppPart.pointee.isString(std.string(key))
   }
-  
+
   /**
    * Gets whether the given `key` is holding an array value, or not.
    */
   public func isArray(key: String) -> Bool {
     return cppPart.pointee.isArray(std.string(key))
   }
-  
+
   /**
    * Gets whether the given `key` is holding an object value, or not.
    */

package/ios/turbomodule/NativeNitroModules+NewArch.mm

@@ -34,7 +34,7 @@ RCT_EXPORT_MODULE(NitroModules)
 
 - (void)installJSIBindingsWithRuntime:(jsi::Runtime&)runtime {
   // 1. Get CallInvoker we cached statically
-  auto callInvoker = _callInvoker.lock();
+  std::shared_ptr<react::CallInvoker> callInvoker = _callInvoker.lock();
   if (callInvoker == nullptr) {
     throw std::runtime_error("Cannot install global.NitroModulesProxy - CallInvoker was null!");
   }

package/lib/commonjs/index.js

@@ -58,4 +58,15 @@ Object.keys(_HybridView).forEach(function (key) {
     }
   });
 });
+var _getHostComponent = require("./views/getHostComponent");
+Object.keys(_getHostComponent).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _getHostComponent[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _getHostComponent[key];
+    }
+  });
+});
 //# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_HybridObject","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_NitroModules","_AnyMap","_Constructor","_HybridView"],"sourceRoot":"../../src","sources":["index.ts"],"mappings":";;;;;AAAA,IAAAA,aAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,aAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,aAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,aAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,aAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,aAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,aAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,aAAA,CAAAL,GAAA;IAAA;EAAA;AAAA;AACA,IAAAM,OAAA,GAAAV,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAQ,OAAA,EAAAP,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAM,OAAA,CAAAN,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAE,OAAA,CAAAN,GAAA;IAAA;EAAA;AAAA;AACA,IAAAO,YAAA,GAAAX,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAS,YAAA,EAAAR,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAO,YAAA,CAAAP,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAG,YAAA,CAAAP,GAAA;IAAA;EAAA;AAAA;AACA,IAAAQ,WAAA,GAAAZ,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAU,WAAA,EAAAT,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAQ,WAAA,CAAAR,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAI,WAAA,CAAAR,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}
+{"version":3,"names":["_HybridObject","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get","_NitroModules","_AnyMap","_Constructor","_HybridView","_getHostComponent"],"sourceRoot":"../../src","sources":["index.ts"],"mappings":";;;;;AAAA,IAAAA,aAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,aAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,aAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,aAAA,CAAAK,GAAA;IAAA;EAAA;AAAA;AACA,IAAAK,aAAA,GAAAT,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAO,aAAA,EAAAN,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAK,aAAA,CAAAL,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAC,aAAA,CAAAL,GAAA;IAAA;EAAA;AAAA;AACA,IAAAM,OAAA,GAAAV,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAQ,OAAA,EAAAP,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAM,OAAA,CAAAN,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAE,OAAA,CAAAN,GAAA;IAAA;EAAA;AAAA;AACA,IAAAO,YAAA,GAAAX,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAS,YAAA,EAAAR,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAO,YAAA,CAAAP,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAG,YAAA,CAAAP,GAAA;IAAA;EAAA;AAAA;AAEA,IAAAQ,WAAA,GAAAZ,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAU,WAAA,EAAAT,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAQ,WAAA,CAAAR,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAI,WAAA,CAAAR,GAAA;IAAA;EAAA;AAAA;AACA,IAAAS,iBAAA,GAAAb,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAW,iBAAA,EAAAV,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAS,iBAAA,CAAAT,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAK,iBAAA,CAAAT,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/lib/commonjs/views/HybridView.js

@@ -3,15 +3,4 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-var _getHostComponent = require("./getHostComponent");
-Object.keys(_getHostComponent).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _getHostComponent[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _getHostComponent[key];
-    }
-  });
-});
 //# sourceMappingURL=HybridView.js.map

package/lib/commonjs/views/HybridView.js.map

@@ -1 +1 @@
-{"version":3,"names":["_getHostComponent","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sourceRoot":"../../../src","sources":["views/HybridView.ts"],"mappings":";;;;;AAoCA,IAAAA,iBAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,iBAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,iBAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,iBAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}
+{"version":3,"names":[],"sourceRoot":"../../../src","sources":["views/HybridView.ts"],"mappings":"","ignoreList":[]}

package/lib/commonjs/views/getHostComponent.js

@@ -11,7 +11,26 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
 // @ts-expect-error this unfortunately isn't typed or default-exported.
 
 /**
- * Finds and returns a native view (aka {@linkcode HostComponent}) via the given {@linkcode name}.
+ * Represents all default props a Nitro HybridView has.
+ */
+
+// Due to a React limitation, functions cannot be passed to native directly
+// because RN converts them to booleans (`true`). Nitro knows this and just
+// wraps functions as objects - the original function is stored in `f`.
+
+/**
+ * Represents a React Native view, implemented as a Nitro View, with the given props and methods.
+ *
+ * @note Every React Native view has a {@linkcode DefaultHybridViewProps.hybridRef hybridRef} which can be used to gain access
+ *       to the underlying Nitro {@linkcode HybridView}.
+ * @note Every function/callback is wrapped as a `{ f: … }` object.
+ * @note Every method can be called on the Ref. Including setting properties directly.
+ */
+
+/**
+ * Finds and returns a native view (aka "HostComponent") via the given {@linkcode name}.
+ *
+ * The view is bridged to a native Hybrid Object using Nitro Views.
  */
 function getHostComponent(name, getViewConfig) {
   if (NativeComponentRegistry == null) {

package/lib/commonjs/views/getHostComponent.js.map

@@ -1 +1 @@
-{"version":3,"names":["_reactNative","require","NativeComponentRegistry","_interopRequireWildcard","_getRequireWildcardCache","e","WeakMap","r","t","__esModule","default","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","hasOwnProperty","call","i","set","getHostComponent","name","getViewConfig","Error","Platform","OS"],"sourceRoot":"../../../src","sources":["views/getHostComponent.ts"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAEA,IAAAC,uBAAA,GAAAC,uBAAA,CAAAF,OAAA;AAAyG,SAAAG,yBAAAC,CAAA,6BAAAC,OAAA,mBAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAF,wBAAAE,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,WAAAK,OAAA,EAAAL,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAG,GAAA,CAAAN,CAAA,UAAAG,CAAA,CAAAI,GAAA,CAAAP,CAAA,OAAAQ,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,OAAAC,cAAA,CAAAC,IAAA,CAAAhB,CAAA,EAAAc,CAAA,SAAAG,CAAA,GAAAP,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAG,CAAA,KAAAA,CAAA,CAAAV,GAAA,IAAAU,CAAA,CAAAC,GAAA,IAAAP,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAG,CAAA,IAAAT,CAAA,CAAAM,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAN,CAAA,CAAAH,OAAA,GAAAL,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAe,GAAA,CAAAlB,CAAA,EAAAQ,CAAA,GAAAA,CAAA;AADzG;;AAWA;AACA;AACA;AACO,SAASW,gBAAgBA,CAC9BC,IAAY,EACZC,aAAsC,EAChB;EACtB,IAAIxB,uBAAuB,IAAI,IAAI,EAAE;IACnC,MAAM,IAAIyB,KAAK,CACb,+CAA+CC,qBAAQ,CAACC,EAAE,GAC5D,CAAC;EACH;EACA,OAAO3B,uBAAuB,CAACU,GAAG,CAAQa,IAAI,EAAEC,aAAa,CAAC;AAChE","ignoreList":[]}
+{"version":3,"names":["_reactNative","require","NativeComponentRegistry","_interopRequireWildcard","_getRequireWildcardCache","e","WeakMap","r","t","__esModule","default","has","get","n","__proto__","a","Object","defineProperty","getOwnPropertyDescriptor","u","hasOwnProperty","call","i","set","getHostComponent","name","getViewConfig","Error","Platform","OS"],"sourceRoot":"../../../src","sources":["views/getHostComponent.ts"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAEA,IAAAC,uBAAA,GAAAC,uBAAA,CAAAF,OAAA;AAAyG,SAAAG,yBAAAC,CAAA,6BAAAC,OAAA,mBAAAC,CAAA,OAAAD,OAAA,IAAAE,CAAA,OAAAF,OAAA,YAAAF,wBAAA,YAAAA,CAAAC,CAAA,WAAAA,CAAA,GAAAG,CAAA,GAAAD,CAAA,KAAAF,CAAA;AAAA,SAAAF,wBAAAE,CAAA,EAAAE,CAAA,SAAAA,CAAA,IAAAF,CAAA,IAAAA,CAAA,CAAAI,UAAA,SAAAJ,CAAA,eAAAA,CAAA,uBAAAA,CAAA,yBAAAA,CAAA,WAAAK,OAAA,EAAAL,CAAA,QAAAG,CAAA,GAAAJ,wBAAA,CAAAG,CAAA,OAAAC,CAAA,IAAAA,CAAA,CAAAG,GAAA,CAAAN,CAAA,UAAAG,CAAA,CAAAI,GAAA,CAAAP,CAAA,OAAAQ,CAAA,KAAAC,SAAA,UAAAC,CAAA,GAAAC,MAAA,CAAAC,cAAA,IAAAD,MAAA,CAAAE,wBAAA,WAAAC,CAAA,IAAAd,CAAA,oBAAAc,CAAA,OAAAC,cAAA,CAAAC,IAAA,CAAAhB,CAAA,EAAAc,CAAA,SAAAG,CAAA,GAAAP,CAAA,GAAAC,MAAA,CAAAE,wBAAA,CAAAb,CAAA,EAAAc,CAAA,UAAAG,CAAA,KAAAA,CAAA,CAAAV,GAAA,IAAAU,CAAA,CAAAC,GAAA,IAAAP,MAAA,CAAAC,cAAA,CAAAJ,CAAA,EAAAM,CAAA,EAAAG,CAAA,IAAAT,CAAA,CAAAM,CAAA,IAAAd,CAAA,CAAAc,CAAA,YAAAN,CAAA,CAAAH,OAAA,GAAAL,CAAA,EAAAG,CAAA,IAAAA,CAAA,CAAAe,GAAA,CAAAlB,CAAA,EAAAQ,CAAA,GAAAA,CAAA;AADzG;;AAgBA;AACA;AACA;;AAsBA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACO,SAASW,gBAAgBA,CAI9BC,IAAY,EACZC,aAAsC,EACL;EACjC,IAAIxB,uBAAuB,IAAI,IAAI,EAAE;IACnC,MAAM,IAAIyB,KAAK,CACb,+CAA+CC,qBAAQ,CAACC,EAAE,GAC5D,CAAC;EACH;EACA,OAAO3B,uBAAuB,CAACU,GAAG,CAACa,IAAI,EAAEC,aAAa,CAAC;AACzD","ignoreList":[]}

package/lib/module/index.js

@@ -5,4 +5,5 @@ export * from './NitroModules';
 export * from './AnyMap';
 export * from './Constructor';
 export * from './views/HybridView';
+export * from './views/getHostComponent';
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sourceRoot":"../../src","sources":["index.ts"],"mappings":";;AAAA,cAAc,gBAAgB;AAC9B,cAAc,gBAAgB;AAC9B,cAAc,UAAU;AACxB,cAAc,eAAe;AAC7B,cAAc,oBAAoB","ignoreList":[]}
+{"version":3,"names":[],"sourceRoot":"../../src","sources":["index.ts"],"mappings":";;AAAA,cAAc,gBAAgB;AAC9B,cAAc,gBAAgB;AAC9B,cAAc,UAAU;AACxB,cAAc,eAAe;AAE7B,cAAc,oBAAoB;AAClC,cAAc,0BAA0B","ignoreList":[]}

package/lib/module/views/HybridView.js

@@ -1,30 +1,4 @@
 "use strict";
 
-/**
- * Describes the languages this view will be implemented in.
- */
-
-/**
- * Represents a Nitro `HybridView` which is implemented in a native language
- * like Swift or Kotlin.
- *
- * `HybridViews`s use the Nitro Tunnel for efficient, low-overhead JS <-> Native communication.
- *
- * All `HybridViews`s have a C++ Fabric View base with a backing Shadow Node.
- *
- * - TypeScript Properties (`name: Type`) will be React Props
- * - TypeScript Methods (`name(): Type`) will be Ref Methods
- *
- * @example
- * ```tsx
- * export interface Camera extends HybridView {
- *   zoom: number
- *   flash: boolean
- *   takePhoto(): Image
- * }
- * ```
- */
-
-export * from './getHostComponent';
 export {};
 //# sourceMappingURL=HybridView.js.map

package/lib/module/views/HybridView.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sourceRoot":"../../../src","sources":["views/HybridView.ts"],"mappings":";;AAEA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA,cAAc,oBAAoB;AAAA","ignoreList":[]}
+{"version":3,"names":[],"sourceRoot":"../../../src","sources":["views/HybridView.ts"],"mappings":"","ignoreList":[]}

package/lib/module/views/getHostComponent.js

@@ -3,8 +3,28 @@
 import { Platform } from 'react-native';
 // @ts-expect-error this unfortunately isn't typed or default-exported.
 import * as NativeComponentRegistry from 'react-native/Libraries/NativeComponent/NativeComponentRegistry';
+
+/**
+ * Represents all default props a Nitro HybridView has.
+ */
+
+// Due to a React limitation, functions cannot be passed to native directly
+// because RN converts them to booleans (`true`). Nitro knows this and just
+// wraps functions as objects - the original function is stored in `f`.
+
+/**
+ * Represents a React Native view, implemented as a Nitro View, with the given props and methods.
+ *
+ * @note Every React Native view has a {@linkcode DefaultHybridViewProps.hybridRef hybridRef} which can be used to gain access
+ *       to the underlying Nitro {@linkcode HybridView}.
+ * @note Every function/callback is wrapped as a `{ f: … }` object.
+ * @note Every method can be called on the Ref. Including setting properties directly.
+ */
+
 /**
- * Finds and returns a native view (aka {@linkcode HostComponent}) via the given {@linkcode name}.
+ * Finds and returns a native view (aka "HostComponent") via the given {@linkcode name}.
+ *
+ * The view is bridged to a native Hybrid Object using Nitro Views.
  */
 export function getHostComponent(name, getViewConfig) {
   if (NativeComponentRegistry == null) {

package/lib/module/views/getHostComponent.js.map

@@ -1 +1 @@
-{"version":3,"names":["Platform","NativeComponentRegistry","getHostComponent","name","getViewConfig","Error","OS","get"],"sourceRoot":"../../../src","sources":["views/getHostComponent.ts"],"mappings":";;AAAA,SAASA,QAAQ,QAA4B,cAAc;AAC3D;AACA,OAAO,KAAKC,uBAAuB,MAAM,gEAAgE;AAUzG;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAC9BC,IAAY,EACZC,aAAsC,EAChB;EACtB,IAAIH,uBAAuB,IAAI,IAAI,EAAE;IACnC,MAAM,IAAII,KAAK,CACb,+CAA+CL,QAAQ,CAACM,EAAE,GAC5D,CAAC;EACH;EACA,OAAOL,uBAAuB,CAACM,GAAG,CAAQJ,IAAI,EAAEC,aAAa,CAAC;AAChE","ignoreList":[]}
+{"version":3,"names":["Platform","NativeComponentRegistry","getHostComponent","name","getViewConfig","Error","OS","get"],"sourceRoot":"../../../src","sources":["views/getHostComponent.ts"],"mappings":";;AAAA,SAASA,QAAQ,QAA4C,cAAc;AAC3E;AACA,OAAO,KAAKC,uBAAuB,MAAM,gEAAgE;;AAezG;AACA;AACA;;AAsBA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,gBAAgBA,CAI9BC,IAAY,EACZC,aAAsC,EACL;EACjC,IAAIH,uBAAuB,IAAI,IAAI,EAAE;IACnC,MAAM,IAAII,KAAK,CACb,+CAA+CL,QAAQ,CAACM,EAAE,GAC5D,CAAC;EACH;EACA,OAAOL,uBAAuB,CAACM,GAAG,CAACJ,IAAI,EAAEC,aAAa,CAAC;AACzD","ignoreList":[]}