react-native-nitro-modules 0.9.2 → 0.10.0

package/lib/typescript/NitroModules.d.ts

@@ -0,0 +1,84 @@
+import type { HybridObject } from './HybridObject';
+/**
+ * Represents a boxed {@linkcode HybridObject} that can later be unboxed again.
+ * This is implemented as a `jsi::HostObject`.
+ */
+export interface BoxedHybridObject<T extends HybridObject> {
+    /**
+     * Unboxes the {@linkcode HybridObject}.
+     * This can be called from a different Runtime than the one it was boxed in.
+     */
+    unbox(): T;
+}
+/**
+ * A lazy proxy for initializing Nitro Modules HybridObjects.
+ */
+export declare const NitroModules: {
+    /**
+     * Create a new instance of the `HybridObject` {@linkcode T}.
+     *
+     * {@linkcode T} has to be registered beforehand under the name {@linkcode name}
+     * in the native Nitro Modules `HybridObjectRegistry`.
+     *
+     * @param name The name of the `HybridObject` under which it was registered at.
+     * @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<any>>(name: string): T;
+    /**
+     * Get a list of all registered Hybrid Objects.
+     */
+    getAllHybridObjectNames(): string[];
+    /**
+     * Returns whether a HybridObject under the given {@linkcode name} is registered, or not.
+     */
+    hasHybridObject(name: string): boolean;
+    /**
+     * Returns whether the given {@linkcode object} has a `NativeState` or not.
+     *
+     * This can be a quick way to check if an object is a valid {@linkcode HybridObject},
+     * and has not yet been disposed.
+     * @example
+     * ```ts
+     * const someObject = NitroModules.createHybridObject<Some>('Some')
+     * console.log(NitroModules.hasNativeState(someObject)) // -> true
+     * someObject.dispose()
+     * console.log(NitroModules.hasNativeState(someObject)) // -> false
+     * ```
+     */
+    hasNativeState(object: object): boolean;
+    /**
+     * Forcefully removes the `NativeState` of the given {@linkcode object}.
+     */
+    removeNativeState(object: object): void;
+    /**
+     * Gets the current build type configuration as defined in the `NITRO_DEBUG`
+     * preprocessor flag.
+     */
+    readonly buildType: "debug" | "release";
+    /**
+     * Boxes the given {@linkcode hybridObject} into a {@linkcode BoxedHybridObject<T>}, which can
+     * later be unboxed in a separate Runtime.
+     *
+     * While Nitro is runtime-agnostic and all `HybridObject`s can be used from a any Runtime,
+     * some threading/worklet libraries (like [react-native-worklets-core](https://github.com/margelo/react-native-worklets-core))
+     * do not yet support copying over `HybridObject`s as they use newer JSI APIs like `jsi::NativeState`.
+     *
+     * While those APIs are not yet available, you can still use every Nitro Hybrid Object in a separate
+     * Runtime/Worklet context by just boxing it yourself:
+     *
+     * @example
+     * ```ts
+     * const something = NitroModules.createHybridObject<Something>('Something')
+     * const boxed = NitroModules.box(something)
+     * const context = Worklets.createContext('DummyContext')
+     * context.runAsync(() => {
+     *   'worklet'
+     *   const unboxed = boxed.unbox()
+     *   console.log(unboxed.name) // --> "Something"
+     * })
+     * ```
+     */
+    box<T extends HybridObject>(hybridObject: T): BoxedHybridObject<T>;
+};
+//# sourceMappingURL=NitroModules.d.ts.map

package/lib/typescript/NitroModules.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NitroModules.d.ts","sourceRoot":"","sources":["../../src/NitroModules.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AASlD;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;;;;;OASG;uBACgB,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,QAAQ,MAAM,GAAG,CAAC;IAKhE;;OAEG;+BACwB,MAAM,EAAE;IAInC;;OAEG;0BACmB,MAAM,GAAG,OAAO;IAItC;;;;;;;;;;;;OAYG;2BACoB,MAAM,GAAG,OAAO;IAIvC;;OAEG;8BACuB,MAAM,GAAG,IAAI;IAIvC;;;OAGG;;CAKJ,CAAA"}
+{"version":3,"file":"NitroModules.d.ts","sourceRoot":"","sources":["../../src/NitroModules.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAElD;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC,SAAS,YAAY;IACvD;;;OAGG;IACH,KAAK,IAAI,CAAC,CAAA;CACX;AAED;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;;;;;OASG;uBACgB,CAAC,SAAS,YAAY,CAAC,GAAG,CAAC,QAAQ,MAAM,GAAG,CAAC;IAKhE;;OAEG;+BACwB,MAAM,EAAE;IAInC;;OAEG;0BACmB,MAAM,GAAG,OAAO;IAItC;;;;;;;;;;;;OAYG;2BACoB,MAAM,GAAG,OAAO;IAIvC;;OAEG;8BACuB,MAAM,GAAG,IAAI;IAIvC;;;OAGG;;IAKH;;;;;;;;;;;;;;;;;;;;;;OAsBG;QACC,CAAC,SAAS,YAAY,gBAAgB,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC;CAInE,CAAA"}

package/lib/typescript/NitroModulesTurboModule.d.ts

@@ -2,12 +2,13 @@ import type { TurboModule } from 'react-native';
 import type { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes';
 export interface NativeNitroSpec extends TurboModule {
     install(): void;
-    createHybridObject(name: string, args?: UnsafeObject): UnsafeObject;
+    createHybridObject(name: string): UnsafeObject;
     hasHybridObject(name: string): boolean;
     getAllHybridObjectNames(): string[];
     hasNativeState(obj: UnsafeObject): boolean;
     removeNativeState(obj: UnsafeObject): void;
     buildType: 'debug' | 'release';
+    box(obj: UnsafeObject): UnsafeObject;
 }
 export declare function getNativeNitroModules(): NativeNitroSpec;
 declare global {

package/lib/typescript/NitroModulesTurboModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NitroModulesTurboModule.d.ts","sourceRoot":"","sources":["../../src/NitroModulesTurboModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAA;AAM7E,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAElD,OAAO,IAAI,IAAI,CAAA;IAEf,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,YAAY,CAAA;IACnE,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IACtC,uBAAuB,IAAI,MAAM,EAAE,CAAA;IAEnC,cAAc,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAA;IAC1C,iBAAiB,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,CAAA;IAC1C,SAAS,EAAE,OAAO,GAAG,SAAS,CAAA;CAC/B;AAGD,wBAAgB,qBAAqB,IAAI,eAAe,CAevD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,sBAAsB,EAAE,EAAE,CAAA;IAC9B,IAAI,iBAAiB,EAAE,EAAE,CAAA;CAC1B;AAED,wBAAgB,cAAc,YAI7B"}
+{"version":3,"file":"NitroModulesTurboModule.d.ts","sourceRoot":"","sources":["../../src/NitroModulesTurboModule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAE/C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAA;AAM7E,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAElD,OAAO,IAAI,IAAI,CAAA;IAEf,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAAA;IAC9C,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IACtC,uBAAuB,IAAI,MAAM,EAAE,CAAA;IAEnC,cAAc,CAAC,GAAG,EAAE,YAAY,GAAG,OAAO,CAAA;IAC1C,iBAAiB,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI,CAAA;IAC1C,SAAS,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,GAAG,CAAC,GAAG,EAAE,YAAY,GAAG,YAAY,CAAA;CACrC;AAGD,wBAAgB,qBAAqB,IAAI,eAAe,CAevD;AAED,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,sBAAsB,EAAE,EAAE,CAAA;IAC9B,IAAI,iBAAiB,EAAE,EAAE,CAAA;CAC1B;AAED,wBAAgB,cAAc,YAI7B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-modules",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "description": "Insanely fast native C++, Swift or Kotlin modules with a statically compiled binding layer to JSI.",
   "main": "lib/index",
   "module": "lib/index",

package/src/NitroModules.ts

@@ -1,11 +1,16 @@
 import { getNativeNitroModules } from './NitroModulesTurboModule'
 import type { HybridObject } from './HybridObject'
 
-// TODO: Do we wanna support such constructors?
-// @ts-expect-error
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-type ExtractConstructors<T> = {
-  [K in keyof T as K extends `constructor` ? `create` : never]: T[K]
+/**
+ * Represents a boxed {@linkcode HybridObject} that can later be unboxed again.
+ * This is implemented as a `jsi::HostObject`.
+ */
+export interface BoxedHybridObject<T extends HybridObject> {
+  /**
+   * Unboxes the {@linkcode HybridObject}.
+   * This can be called from a different Runtime than the one it was boxed in.
+   */
+  unbox(): T
 }
 
 /**
@@ -73,4 +78,31 @@ export const NitroModules = {
     const nitro = getNativeNitroModules()
     return nitro.buildType
   },
+  /**
+   * Boxes the given {@linkcode hybridObject} into a {@linkcode BoxedHybridObject<T>}, which can
+   * later be unboxed in a separate Runtime.
+   *
+   * While Nitro is runtime-agnostic and all `HybridObject`s can be used from a any Runtime,
+   * some threading/worklet libraries (like [react-native-worklets-core](https://github.com/margelo/react-native-worklets-core))
+   * do not yet support copying over `HybridObject`s as they use newer JSI APIs like `jsi::NativeState`.
+   *
+   * While those APIs are not yet available, you can still use every Nitro Hybrid Object in a separate
+   * Runtime/Worklet context by just boxing it yourself:
+   *
+   * @example
+   * ```ts
+   * const something = NitroModules.createHybridObject<Something>('Something')
+   * const boxed = NitroModules.box(something)
+   * const context = Worklets.createContext('DummyContext')
+   * context.runAsync(() => {
+   *   'worklet'
+   *   const unboxed = boxed.unbox()
+   *   console.log(unboxed.name) // --> "Something"
+   * })
+   * ```
+   */
+  box<T extends HybridObject>(hybridObject: T): BoxedHybridObject<T> {
+    const nitro = getNativeNitroModules()
+    return nitro.box(hybridObject) as BoxedHybridObject<T>
+  },
 }

package/src/NitroModulesTurboModule.ts

@@ -10,13 +10,14 @@ export interface NativeNitroSpec extends TurboModule {
   // Set up
   install(): void
   // Hybrid Objects stuff
-  createHybridObject(name: string, args?: UnsafeObject): UnsafeObject
+  createHybridObject(name: string): UnsafeObject
   hasHybridObject(name: string): boolean
   getAllHybridObjectNames(): string[]
   // JSI Helpers
   hasNativeState(obj: UnsafeObject): boolean
   removeNativeState(obj: UnsafeObject): void
   buildType: 'debug' | 'release'
+  box(obj: UnsafeObject): UnsafeObject
 }
 
 let turboModule: NativeNitroSpec | undefined