react-native-nitro-modules 0.2.0 → 0.4.0

package/src/HybridObject.ts

@@ -1,5 +1,8 @@
 /**
  * Describes the languages this component will be implemented in.
+ *
+ * By default, everything has a C++ base, and can optionally be bridged down
+ * to platform-specific languages like Swift or Kotlin
  */
 export interface PlatformSpec {
   ios?: 'swift' | 'c++'
@@ -7,14 +10,17 @@ export interface PlatformSpec {
 }
 
 /**
- * Represents a Nitro `HybridObject` which is implemented natively in either C++,
- * or Swift/Kotlin.
+ * Represents a Nitro `HybridObject` which is implemented in a native language like
+ * C++, Swift or Kotlin.
+ * Every Nitro `HybridObject` has a C++ base, and can optionally be bridged down to Swift or Kotlin.
  *
  * `HybridObject`s use the Nitro Tunnel for efficient, low-overhead JS <-> Native communication.
  *
  * 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`.
  * @example
  * ```ts
  * interface Photo extends HybridObject<{ ios: 'swift', android: 'kotlin' }> {
@@ -25,7 +31,7 @@ export interface PlatformSpec {
  * }
  * ```
  */
-export interface HybridObject<Spec extends PlatformSpec> {
+export interface HybridObject<Platforms extends PlatformSpec = {}> {
   /**
    * Holds a type-name describing the native `HybridObject` instance.
    *
@@ -34,8 +40,8 @@ export interface HybridObject<Spec extends PlatformSpec> {
    *
    * Nitro prototypes also have a `__type`.
    *
-   * For actual HybridObject instances, this is `NativeState<...>`, for
-   * prototypes this is `Prototype<...>`.
+   * - For actual HybridObject instances, this is `NativeState<...>`
+   * - For prototypes this is `Prototype<...>`.
    *
    * @internal
    * @private
@@ -49,7 +55,7 @@ export interface HybridObject<Spec extends PlatformSpec> {
   /**
    * Returns a string representation of the given `HybridObject`.
    *
-   * Unless overridden by the `HybridObject`, this will return a list of all properties.
+   * Unless overridden by the `HybridObject`, this will return the name of the object.
    *
    * @example
    * ```ts
@@ -73,5 +79,5 @@ export interface HybridObject<Spec extends PlatformSpec> {
    * console.log(hybridA.equals(hybridB)) // true
    * ```
    */
-  equals(other: HybridObject<Spec>): boolean
+  equals(other: HybridObject<Platforms>): boolean
 }

package/src/NativeNitroModules.ts

@@ -6,6 +6,8 @@ import { ModuleNotFoundError } from './ModuleNotFoundError'
 export interface Spec extends TurboModule {
   install(): void
   createHybridObject(name: string, args?: UnsafeObject): UnsafeObject
+  hasHybridObject(name: string): boolean
+  getAllHybridObjectNames(): string[]
 }
 
 let turboModule: Spec | undefined

package/src/NitroModules.ts

@@ -22,9 +22,23 @@ export const NitroModules = {
    * @returns An instance of {@linkcode T}
    * @throws an Error if {@linkcode T} has not been registered under the name {@linkcode name}.
    */
-  get<T extends HybridObject<any>>(name: string): T {
+  createHybridObject<T extends HybridObject<any>>(name: string): T {
     const nitro = getNativeNitroModules()
     const instance = nitro.createHybridObject(name)
     return instance as T
   },
+  /**
+   * Get a list of all registered Hybrid Objects.
+   */
+  getAllHybridObjectNames(): string[] {
+    const nitro = getNativeNitroModules()
+    return nitro.getAllHybridObjectNames()
+  },
+  /**
+   * Returns whether a HybridObject under the given {@linkcode name} is registered, or not.
+   */
+  hasHybridObject(name: string): boolean {
+    const nitro = getNativeNitroModules()
+    return nitro.hasHybridObject(name)
+  },
 }

package/lib/NativeNitro.d.ts

@@ -1,8 +0,0 @@
-import type { TurboModule } from 'react-native';
-import type { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
-export interface Spec extends TurboModule {
-    install(): void;
-    createTestHybridObject(): UnsafeObject;
-    createSwiftTestHybridObject(): UnsafeObject;
-}
-export declare const NitroModules: Spec;

package/lib/NativeNitro.js

@@ -1,3 +0,0 @@
-import { TurboModuleRegistry } from 'react-native';
-export const NitroModules = TurboModuleRegistry.getEnforcing('NitroModulesCxx');
-NitroModules.install();

package/lib/createTestObject.d.ts

@@ -1,22 +0,0 @@
-import { type HybridObject } from '.';
-export interface TestHybridObject extends HybridObject<{}> {
-    int: number;
-    string: string;
-    nullableString: string | undefined;
-    multipleArguments(first: number, second: boolean, third: string): Record<string, number>;
-    getIntGetter(): () => number;
-    sayHelloCallback(callback: (name: string) => void): void;
-    createNewHybridObject(): TestHybridObject;
-    calculateFibonacci(count: number): bigint;
-    calculateFibonacciAsync(count: number): Promise<bigint>;
-    asyncVoidFunc(): Promise<void>;
-    syncVoidFunc(): void;
-    throwError(): void;
-}
-export declare function createCppTestHybridObject(): TestHybridObject;
-export interface SwiftTestHybridObject extends HybridObject<{}> {
-    int: number;
-    throwError(): number;
-    asyncMethod(): Promise<number>;
-}
-export declare function createSwiftTestHybridObject(): SwiftTestHybridObject;

package/lib/createTestObject.js

@@ -1,7 +0,0 @@
-import { NitroModules } from '.';
-export function createCppTestHybridObject() {
-    return NitroModules.get('TestHybridObject');
-}
-export function createSwiftTestHybridObject() {
-    return NitroModules.get('SwiftTestObject');
-}