react-native-nitro-modules 0.13.0 → 0.14.1

package/lib/typescript/BoxedHybridObject.d.ts

@@ -1,13 +0,0 @@
-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;
-}
-//# sourceMappingURL=BoxedHybridObject.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"BoxedHybridObject.d.ts","sourceRoot":"","sources":["../../src/BoxedHybridObject.ts"],"names":[],"mappings":"AAAA,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"}

package/lib/typescript/HybridObject.d.ts

@@ -1,99 +0,0 @@
-/**
- * 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++';
-    android?: 'kotlin' | 'c++';
-}
-/**
- * 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`.
- * @default { ios: 'c++', android: 'c++' }
- * @example
- * ```ts
- * interface Photo extends HybridObject<{ ios: 'swift', android: 'kotlin' }> {
- *   readonly width: number
- *   readonly height: number
- *   toArrayBuffer(): ArrayBuffer
- *   saveToFile(path: string): Promise<void>
- * }
- * ```
- */
-export interface HybridObject<Platforms extends PlatformSpec = {}> {
-    /**
-     * Holds a type-name describing the native `HybridObject` instance.
-     *
-     * This is the only property actually present on the actual JavaScript object,
-     * because all other properties and methods are inherited from a shared Prototype.
-     *
-     * Nitro prototypes also have a `__type`.
-     *
-     * - For actual HybridObject instances, this is `NativeState<...>`
-     * - For prototypes this is `Prototype<...>`.
-     *
-     * @internal
-     * @private
-     * @note This value is available in debug only.
-     */
-    readonly __type?: string;
-    /**
-     * The `HybridObject`'s name.
-     */
-    readonly name: string;
-    /**
-     * Returns a string representation of the given `HybridObject`.
-     *
-     * Unless overridden by the `HybridObject`, this will return the name of the object.
-     *
-     * @example
-     * ```ts
-     * const hybridA = SomeModule.getExistingHybridInstance()
-     * console.log(hybridA.toString()) // [HybridObject HybridA]
-     * ```
-     */
-    toString(): string;
-    /**
-     * Returns whether this `HybridObject` is the same object as {@linkcode other}.
-     *
-     * While two `HybridObject`s might not be equal when compared with `==`, they might still
-     * hold the same underlying `HybridObject`, in which case {@linkcode equals | equals(other)}
-     * will return `true`.
-     *
-     * @example
-     * ```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`.
-     *
-     * After calling {@linkcode dispose()}, this object can no longer be used.
-     *
-     * Eagerly disposing a {@linkcode HybridObject} could be beneficial for a queue-/handler-architecture
-     * where a bunch of Hybrid Objects are allocated, and later deallocated once a callback (e.g. a render function)
-     * completes.
-     *
-     * @note It is **NOT** required to call {@linkcode dispose()} manually, as the JavaScript
-     * Garbage Collector automatically disposes and releases any resources when needed.
-     * It is purely optional to eagerly-, and manually-, call {@linkcode dispose()} here - **use with caution!**
-     */
-    dispose(): void;
-}
-//# sourceMappingURL=HybridObject.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"HybridObject.d.ts","sourceRoot":"","sources":["../../src/HybridObject.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,CAAC,EAAE,OAAO,GAAG,KAAK,CAAA;IACrB,OAAO,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAA;CAC3B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,YAAY,CAAC,SAAS,SAAS,YAAY,GAAG,EAAE;IAC/D;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB;;;;;;;;;;OAUG;IACH,QAAQ,IAAI,MAAM,CAAA;IAClB;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,KAAK,EAAE,YAAY,CAAC,SAAS,CAAC,GAAG,OAAO,CAAA;IAC/C;;;;;;;;;;;;;OAaG;IACH,OAAO,IAAI,IAAI,CAAA;CAChB"}

package/lib/typescript/ModuleNotFoundError.d.ts

@@ -1,7 +0,0 @@
-declare global {
-    var __turboModuleProxy: unknown | undefined;
-}
-export declare class ModuleNotFoundError extends Error {
-    constructor(cause?: unknown);
-}
-//# sourceMappingURL=ModuleNotFoundError.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"ModuleNotFoundError.d.ts","sourceRoot":"","sources":["../../src/ModuleNotFoundError.ts"],"names":[],"mappings":"AAEA,OAAO,CAAC,MAAM,CAAC;IAEb,IAAI,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAA;CAC5C;AA2BD,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,KAAK,CAAC,EAAE,OAAO;CAwC5B"}

package/lib/typescript/NitroModules.d.ts

@@ -1,2 +0,0 @@
-export * from './turbomodule/NativeNitroModules';
-//# sourceMappingURL=NitroModules.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"NitroModules.d.ts","sourceRoot":"","sources":["../../src/NitroModules.ts"],"names":[],"mappings":"AACA,cAAc,kCAAkC,CAAA"}

package/lib/typescript/NitroModulesProxy.d.ts

@@ -1,59 +0,0 @@
-import type { HybridObject } from './HybridObject';
-import type { BoxedHybridObject } from './BoxedHybridObject';
-/**
- * The Proxy class that acts as a main entry point for Nitro Modules in React Native.
- *
- * 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 {
-    /**
-     * 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>(name: string): T;
-    /**
-     * Returns whether a HybridObject under the given {@linkcode name} is registered, or not.
-     */
-    hasHybridObject(name: string): boolean;
-    /**
-     * Get a list of all registered Hybrid Objects.
-     */
-    getAllHybridObjectNames(): string[];
-    /**
-     * Gets the current build type configuration as defined in the `NITRO_DEBUG`
-     * preprocessor flag.
-     */
-    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>(obj: T): BoxedHybridObject<T>;
-}
-//# sourceMappingURL=NitroModulesProxy.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"NitroModulesProxy.d.ts","sourceRoot":"","sources":["../../src/NitroModulesProxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAE5D;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD;;;;;;;;;OASG;IACH,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,CAAA;IAC3D;;OAEG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;IACtC;;OAEG;IACH,uBAAuB,IAAI,MAAM,EAAE,CAAA;IAEnC;;;OAGG;IACH,SAAS,EAAE,OAAO,GAAG,SAAS,CAAA;IAE9B;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,GAAG,CAAC,CAAC,SAAS,YAAY,EAAE,GAAG,EAAE,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAA;CAC1D"}

package/lib/typescript/__tests__/index.test.d.ts

@@ -1 +0,0 @@
-//# sourceMappingURL=index.test.d.ts.map

package/lib/typescript/__tests__/index.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/index.test.tsx"],"names":[],"mappings":""}

package/lib/typescript/turbomodule/NativeNitroModules.d.ts

@@ -1,8 +0,0 @@
-import type { NitroModulesProxy } from '../NitroModulesProxy';
-export declare const NitroModules: NitroModulesProxy;
-declare global {
-    var __nitroModulesJSICache: {};
-    var __nitroDispatcher: {};
-}
-export declare function isRuntimeAlive(): boolean;
-//# sourceMappingURL=NativeNitroModules.d.ts.map

package/lib/typescript/turbomodule/NativeNitroModules.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NativeNitroModules.d.ts","sourceRoot":"","sources":["../../../src/turbomodule/NativeNitroModules.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AA2B7D,eAAO,MAAM,YAAY,EAA+B,iBAAiB,CAAA;AAQzE,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,sBAAsB,EAAE,EAAE,CAAA;IAC9B,IAAI,iBAAiB,EAAE,EAAE,CAAA;CAC1B;AAED,wBAAgB,cAAc,YAI7B"}

package/lib/typescript/turbomodule/NativeNitroModules.web.d.ts

@@ -1,3 +0,0 @@
-export declare const NitroModules: {};
-export declare function isRuntimeAlive(): boolean;
-//# sourceMappingURL=NativeNitroModules.web.d.ts.map

package/lib/typescript/turbomodule/NativeNitroModules.web.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NativeNitroModules.web.d.ts","sourceRoot":"","sources":["../../../src/turbomodule/NativeNitroModules.web.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,YAAY,IASxB,CAAA;AAED,wBAAgB,cAAc,IAAI,OAAO,CAExC"}