react-native-nitro-modules 0.31.2 → 0.31.4

package/src/HybridObject.ts

@@ -5,8 +5,8 @@
  * to platform-specific languages like Swift or Kotlin
  */
 export interface PlatformSpec {
-  ios?: 'swift' | 'c++'
-  android?: 'kotlin' | 'c++'
+  ios?: 'c++' | 'swift'
+  android?: 'c++' | 'kotlin'
 }
 
 /**
@@ -19,9 +19,7 @@ export interface PlatformSpec {
  * All `HybridObject`s are implemented using `NativeState`, and inherit their properties
  * and methods from their prototype, so the actual JS object is empty.
  *
- * @type Platforms: The type of platforms this HybridObject will be implemented in. By default, it is
- * a C++ `HybridObject`.
- * @default { ios: 'c++', android: 'c++' }
+ * @type Platforms: The type of platforms this HybridObject will be implemented in.
  * @example
  * ```ts
  * interface Photo extends HybridObject<{ ios: 'swift', android: 'kotlin' }> {
@@ -32,7 +30,7 @@ export interface PlatformSpec {
  * }
  * ```
  */
-export interface HybridObject<Platforms extends PlatformSpec = {}> {
+export interface HybridObject<Platforms extends PlatformSpec> {
   /**
    * Holds a type-name describing the native `HybridObject` instance.
    *
@@ -41,7 +39,7 @@ export interface HybridObject<Platforms extends PlatformSpec = {}> {
    *
    * Nitro prototypes also have a `__type`.
    *
-   * - For actual HybridObject instances, this is `NativeState<...>`
+   * - For actual HybridObject instances, this is `HybridObject<...>`
    * - For prototypes this is `Prototype<...>`.
    *
    * @internal
@@ -76,14 +74,13 @@ export interface HybridObject<Platforms extends PlatformSpec = {}> {
    * ```ts
    * const hybridA = SomeModule.getExistingHybridInstance()
    * const hybridB = SomeModule.getExistingHybridInstance()
-   * console.log(hybridA === hybridB) // false
    * console.log(hybridA.equals(hybridB)) // true
    * ```
    */
   equals(other: HybridObject<Platforms>): boolean
   /**
    * Disposes any resources this {@linkcode HybridObject} might hold natively,
-   * and finally releases this {@linkcode HybridObject}'s `NativeState`.
+   * and releases this {@linkcode HybridObject}'s `NativeState`.
    *
    * After calling {@linkcode dispose()}, this object can no longer be used.
    *

package/src/NitroModulesProxy.ts

@@ -7,7 +7,8 @@ import type { BoxedHybridObject } from './BoxedHybridObject'
  * This is a `HybridObject` on the native side as well, and is expected to be
  * installed into the runtime's `global` via the NativeModule/TurboModule's `install()` function.
  */
-export interface NitroModulesProxy extends HybridObject {
+export interface NitroModulesProxy
+  extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
   /**
    * Create a new instance of the `HybridObject` {@linkcode T}.
    *
@@ -18,7 +19,7 @@ export interface NitroModulesProxy extends HybridObject {
    * @returns An instance of {@linkcode T}
    * @throws an Error if {@linkcode T} has not been registered under the name {@linkcode name}.
    */
-  createHybridObject<T extends HybridObject>(name: string): T
+  createHybridObject<T extends HybridObject<{}>>(name: string): T
   /**
    * Returns whether a HybridObject under the given {@linkcode name} is registered, or not.
    */
@@ -26,7 +27,7 @@ export interface NitroModulesProxy extends HybridObject {
   /**
    * Returns whether the given {@linkcode object} is a {@linkcode HybridObject}, or not.
    */
-  isHybridObject(object: object): object is HybridObject
+  isHybridObject(object: object): object is HybridObject<{}>
   /**
    * Get a list of all registered Hybrid Objects.
    */
@@ -67,7 +68,7 @@ export interface NitroModulesProxy extends HybridObject {
    * })
    * ```
    */
-  box<T extends HybridObject>(obj: T): BoxedHybridObject<T>
+  box<T extends HybridObject<{}>>(obj: T): BoxedHybridObject<T>
 
   /**
    * Returns whether the given {@linkcode object} has NativeState or not.
@@ -80,5 +81,5 @@ export interface NitroModulesProxy extends HybridObject {
    *
    * This is achieved by just doing a round-trip from JS -> native -> JS.
    */
-  updateMemorySize(obj: HybridObject): HybridObject
+  updateMemorySize<T extends HybridObject<{}>>(obj: T): T
 }

package/src/getHybridObjectConstructor.ts

@@ -16,7 +16,7 @@ const cache = new Map<string, Function>()
  * image1 instanceof HybridImage // --> true
  * ```
  */
-export function getHybridObjectConstructor<T extends HybridObject>(
+export function getHybridObjectConstructor<T extends HybridObject<{}>>(
   name: string
 ): { new (): T } {
   // Cache functions for performance.

package/src/index.ts

@@ -1,6 +1,7 @@
 export * from './HybridObject'
 export * from './NitroModules'
 export * from './AnyMap'
+export * from './AnyHybridObject'
 export * from './CustomType'
 export * from './getHybridObjectConstructor'
 export * from './Sync'

package/src/views/HybridView.ts

@@ -81,12 +81,14 @@ export interface HybridViewMethods {}
 export type HybridRef<
   Props extends HybridViewProps,
   Methods extends HybridViewMethods = {},
-> = HybridObject & Props & Methods
+  Platforms extends ViewPlatformSpec = { ios: 'swift'; android: 'kotlin' },
+> = HybridObject<Platforms> & Props & Methods
 
 /**
  * This interface acts as a tag for Hybrid Views so nitrogen detects them.
  */
-interface HybridViewTag extends HybridObject {}
+interface HybridViewTag<Platforms extends ViewPlatformSpec>
+  extends HybridObject<Platforms> {}
 
 /**
  * Represents a Nitro Hybrid View.
@@ -112,4 +114,4 @@ export type HybridView<
   Props extends HybridViewProps,
   Methods extends HybridViewMethods = {},
   Platforms extends ViewPlatformSpec = { ios: 'swift'; android: 'kotlin' },
-> = HybridViewTag & HybridObject<Platforms> & Props & Methods
+> = HybridViewTag<Platforms> & HybridObject<Platforms> & Props & Methods

package/src/views/getHostComponent.ts

@@ -38,13 +38,15 @@ interface DefaultHybridViewProps<RefType> {
    * function App() {
    *   return (
    *     <HybridScrollView
-   *       hybridRef={{ f: (ref) => {
+   *       hybridRef={callback((ref) => {
    *         ref.current.scrollTo(400)
-   *       }
+   *       })}
    *     />
    *   )
    * }
    * ```
+   * @note If you're wondering about the `callback(...)` syntax, see
+   * ["Callbacks have to be wrapped"](https://nitro.margelo.com/docs/view-components#callbacks-have-to-be-wrapped).
    */
   hybridRef?: (ref: RefType) => void
 }