react-native-nitro-modules 0.0.2 → 0.0.4

package/src/ModuleNotFoundError.ts

@@ -0,0 +1,90 @@
+import { NativeModules, Platform } from 'react-native'
+
+declare global {
+  // A react-native internal from TurboModuleRegistry.js
+  var __turboModuleProxy: unknown | undefined
+}
+
+const BULLET_POINT = '\n* '
+
+function messageWithSuggestions(
+  message: string,
+  suggestions: string[]
+): string {
+  return message + BULLET_POINT + suggestions.join(BULLET_POINT)
+}
+
+function getFrameworkType(): 'react-native' | 'expo' | 'expo-go' {
+  // check if Expo
+  const ExpoConstants =
+    NativeModules.NativeUnimoduleProxy?.modulesConstants?.ExponentConstants
+  if (ExpoConstants != null) {
+    if (ExpoConstants.appOwnership === 'expo') {
+      // We're running Expo Go
+      return 'expo-go'
+    } else {
+      // We're running Expo bare / standalone
+      return 'expo'
+    }
+  }
+  return 'react-native'
+}
+
+export class ModuleNotFoundError extends Error {
+  constructor(cause?: unknown) {
+    // TurboModule not found, something went wrong!
+    if (global.__turboModuleProxy == null) {
+      // TurboModules are not available/new arch is not enabled.
+      const message =
+        'Failed to get NitroModules: NitroModules require the new architecture to be enabled!'
+      const suggestions: string[] = []
+      suggestions.push(
+        'Enable the new architecture in your app to use NitroModules. (See https://github.com/reactwg/react-native-new-architecture/blob/main/docs/enable-apps.md)'
+      )
+      const error = messageWithSuggestions(message, suggestions)
+      super(error, { cause: cause })
+      return
+    }
+
+    const framework = getFrameworkType()
+    if (framework === 'expo-go') {
+      super(
+        'NitroModules are not supported in Expo Go! Use EAS (`expo prebuild`) or eject to a bare workflow instead.'
+      )
+      return
+    }
+
+    const message =
+      'Failed to get NitroModules: The native "NitroModules" TurboModule could not be found.'
+    const suggestions: string[] = []
+    suggestions.push(
+      'Make sure react-native-nitro-modules/NitroModules is correctly autolinked (run `npx react-native config` to verify)'
+    )
+    suggestions.push(
+      'Make sure you enabled the new architecture (TurboModules) and CodeGen properly generated the "NativeNitroModules"/NitroModulesCxx specs. See https://github.com/reactwg/react-native-new-architecture/blob/main/docs/enable-apps.md'
+    )
+    suggestions.push(
+      'Make sure you are using react-native 0.74.0 or higher, because NitroModules are built with C++ TurboModules.'
+    )
+    suggestions.push('Make sure you rebuilt the app.')
+    if (framework === 'expo') {
+      suggestions.push('Make sure you ran `expo prebuild`.')
+    }
+    switch (Platform.OS) {
+      case 'ios':
+      case 'macos':
+        suggestions.push(
+          'Make sure you ran `pod install` in the ios/ directory.'
+        )
+        break
+      case 'android':
+        suggestions.push('Make sure gradle is synced.')
+        break
+      default:
+        throw new Error(`NitroModules are not yet supported on ${Platform.OS}!`)
+    }
+
+    const error = messageWithSuggestions(message, suggestions)
+    super(error, { cause: cause })
+  }
+}

package/src/NativeNitroModules.ts

@@ -0,0 +1,26 @@
+import type { TurboModule } from 'react-native'
+import { TurboModuleRegistry } from 'react-native'
+import type { UnsafeObject } from 'react-native/Libraries/Types/CodegenTypes'
+import { ModuleNotFoundError } from './ModuleNotFoundError'
+
+export interface Spec extends TurboModule {
+  install(): void
+  createHybridObject(name: string, args?: UnsafeObject): UnsafeObject
+}
+
+let turboModule: Spec | undefined
+export function getNativeNitroModules(): Spec {
+  if (turboModule == null) {
+    try {
+      // 1. Get (and initialize) the C++ TurboModule
+      turboModule = TurboModuleRegistry.getEnforcing<Spec>('NitroModulesCxx')
+
+      // 2. Install Dispatcher and required bindings into the Runtime
+      turboModule.install()
+    } catch (e) {
+      throw new ModuleNotFoundError(e)
+    }
+  }
+
+  return turboModule
+}

package/src/NitroModules.ts

@@ -0,0 +1,30 @@
+import { getNativeNitroModules } from './NativeNitroModules'
+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]
+}
+
+/**
+ * A lazy proxy for initializing Nitro Modules HybridObjects.
+ */
+export 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}.
+   */
+  get<T extends HybridObject<any>>(name: string): T {
+    const nitro = getNativeNitroModules()
+    const instance = nitro.createHybridObject(name)
+    return instance as T
+  },
+}

package/src/__tests__/index.test.tsx

@@ -0,0 +1 @@
+it.todo('write a test')

package/src/createTestObject.ts

@@ -0,0 +1,40 @@
+import { NitroModules, type HybridObject } from '.'
+
+export interface TestHybridObject extends HybridObject<{}> {
+  // C++ getter & setter
+  int: number
+  string: string
+  nullableString: string | undefined
+  // C++ methods
+  multipleArguments(
+    first: number,
+    second: boolean,
+    third: string
+  ): Record<string, number>
+  getIntGetter(): () => number
+  sayHelloCallback(callback: (name: string) => void): void
+  createNewHybridObject(): TestHybridObject
+  // C++ Threading
+  calculateFibonacci(count: number): bigint
+  calculateFibonacciAsync(count: number): Promise<bigint>
+  asyncVoidFunc(): Promise<void>
+  syncVoidFunc(): void
+  // Errors
+  throwError(): void
+}
+
+export function createCppTestHybridObject(): TestHybridObject {
+  return NitroModules.get<TestHybridObject>('TestHybridObject')
+}
+
+export interface SwiftTestHybridObject extends HybridObject<{}> {
+  // Swift getter & setter
+  int: number
+  // Swift methods
+  throwError(): number
+  asyncMethod(): Promise<number>
+}
+
+export function createSwiftTestHybridObject(): SwiftTestHybridObject {
+  return NitroModules.get<SwiftTestHybridObject>('SwiftTestObject')
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './createTestObject'
+export * from './HybridObject'
+export * from './NitroModules'
+export * from './AnyMap'

package/LICENSE

@@ -1,20 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Marc Rousavy
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,32 +0,0 @@
-# react-native-nitro
-
-Nitro Modules
-
-## Installation
-
-```sh
-npm install react-native-nitro
-```
-
-## Usage
-
-
-```js
-import { multiply } from 'react-native-nitro';
-
-// ...
-
-const result = multiply(3, 7);
-```
-
-## Contributing
-
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
-
-## License
-
-MIT
-
----
-
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)

package/android/cpp-adapter.cpp

@@ -1,8 +0,0 @@
-#include <jni.h>
-#include "react-native-nitro.h"
-
-extern "C"
-JNIEXPORT jdouble JNICALL
-Java_com_nitro_NitroModule_nativeMultiply(JNIEnv *env, jclass type, jdouble a, jdouble b) {
-    return nitro::multiply(a, b);
-}

package/android/src/main/AndroidManifest.xml

@@ -1,3 +0,0 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          package="com.nitro">
-</manifest>

package/android/src/main/AndroidManifestNew.xml

@@ -1,2 +0,0 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android">
-</manifest>

package/android/src/main/java/com/nitro/NitroModule.java

@@ -1,34 +0,0 @@
-package com.nitro;
-
-import androidx.annotation.NonNull;
-
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.module.annotations.ReactModule;
-
-@ReactModule(name = NitroModule.NAME)
-public class NitroModule extends NativeNitroSpec {
-  public static final String NAME = "Nitro";
-
-  public NitroModule(ReactApplicationContext reactContext) {
-    super(reactContext);
-  }
-
-  @Override
-  @NonNull
-  public String getName() {
-    return NAME;
-  }
-
-  static {
-    System.loadLibrary("react-native-nitro");
-  }
-
-  private static native double nativeMultiply(double a, double b);
-
-  // Example method
-  // See https://reactnative.dev/docs/native-modules-android
-  @Override
-  public double multiply(double a, double b) {
-    return nativeMultiply(a, b);
-  }
-}

package/android/src/main/java/com/nitro/NitroPackage.java

@@ -1,44 +0,0 @@
-package com.nitro;
-
-import androidx.annotation.Nullable;
-
-import com.facebook.react.bridge.NativeModule;
-import com.facebook.react.bridge.ReactApplicationContext;
-import com.facebook.react.module.model.ReactModuleInfo;
-import com.facebook.react.module.model.ReactModuleInfoProvider;
-import com.facebook.react.TurboReactPackage;
-
-import java.util.HashMap;
-import java.util.Map;
-
-public class NitroPackage extends TurboReactPackage {
-
-  @Nullable
-  @Override
-  public NativeModule getModule(String name, ReactApplicationContext reactContext) {
-    if (name.equals(NitroModule.NAME)) {
-      return new NitroModule(reactContext);
-    } else {
-      return null;
-    }
-  }
-
-  @Override
-  public ReactModuleInfoProvider getReactModuleInfoProvider() {
-    return () -> {
-      final Map<String, ReactModuleInfo> moduleInfos = new HashMap<>();
-      moduleInfos.put(
-              NitroModule.NAME,
-              new ReactModuleInfo(
-                      NitroModule.NAME,
-                      NitroModule.NAME,
-                      false, // canOverrideExistingModule
-                      false, // needsEagerInit
-                      true, // hasConstants
-                      false, // isCxxModule
-                      true // isTurboModule
-      ));
-      return moduleInfos;
-    };
-  }
-}

package/cpp/react-native-nitro.cpp

@@ -1,7 +0,0 @@
-#include "react-native-nitro.h"
-
-namespace nitro {
-	double multiply(double a, double b) {
-		return a * b;
-	}
-}

package/cpp/react-native-nitro.h

@@ -1,8 +0,0 @@
-#ifndef NITRO_H
-#define NITRO_H
-
-namespace nitro {
-  double multiply(double a, double b);
-}
-
-#endif /* NITRO_H */

package/ios/Nitro.h

@@ -1,15 +0,0 @@
-#ifdef __cplusplus
-#import "react-native-nitro.h"
-#endif
-
-#ifdef RCT_NEW_ARCH_ENABLED
-#import "RNNitroSpec.h"
-
-@interface Nitro : NSObject <NativeNitroSpec>
-#else
-#import <React/RCTBridgeModule.h>
-
-@interface Nitro : NSObject <RCTBridgeModule>
-#endif
-
-@end

package/ios/Nitro.mm

@@ -1,21 +0,0 @@
-#import "Nitro.h"
-
-@implementation Nitro
-RCT_EXPORT_MODULE()
-
-// Don't compile this code when we build for the old architecture.
-#ifdef RCT_NEW_ARCH_ENABLED
-- (NSNumber *)multiply:(double)a b:(double)b {
-    NSNumber *result = @(nitro::multiply(a, b));
-
-    return result;
-}
-
-- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
-    (const facebook::react::ObjCTurboModule::InitParams &)params
-{
-    return std::make_shared<facebook::react::NativeNitroSpecJSI>(params);
-}
-#endif
-
-@end

package/lib/commonjs/NativeNitro.js

@@ -1,9 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _reactNative = require("react-native");
-var _default = exports.default = _reactNative.TurboModuleRegistry.getEnforcing('Nitro');
-//# sourceMappingURL=NativeNitro.js.map

package/lib/commonjs/NativeNitro.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["_reactNative","require","_default","exports","default","TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativeNitro.ts"],"mappings":";;;;;;AACA,IAAAA,YAAA,GAAAC,OAAA;AAAmD,IAAAC,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAMpCC,gCAAmB,CAACC,YAAY,CAAO,OAAO,CAAC","ignoreList":[]}

package/lib/module/NativeNitro.js

@@ -1,3 +0,0 @@
-import { TurboModuleRegistry } from 'react-native';
-export default TurboModuleRegistry.getEnforcing('Nitro');
-//# sourceMappingURL=NativeNitro.js.map

package/lib/module/NativeNitro.js.map

@@ -1 +0,0 @@
-{"version":3,"names":["TurboModuleRegistry","getEnforcing"],"sourceRoot":"../../src","sources":["NativeNitro.ts"],"mappings":"AACA,SAASA,mBAAmB,QAAQ,cAAc;AAMlD,eAAeA,mBAAmB,CAACC,YAAY,CAAO,OAAO,CAAC","ignoreList":[]}

package/lib/typescript/src/NativeNitro.d.ts

@@ -1,7 +0,0 @@
-import type { TurboModule } from 'react-native';
-export interface Spec extends TurboModule {
-    multiply(a: number, b: number): number;
-}
-declare const _default: Spec;
-export default _default;
-//# sourceMappingURL=NativeNitro.d.ts.map

package/lib/typescript/src/NativeNitro.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NativeNitro.d.ts","sourceRoot":"","sources":["../../../src/NativeNitro.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACxC;;AAED,wBAA+D"}

package/lib/typescript/src/index.d.ts

@@ -1,2 +0,0 @@
-export declare function multiply(a: number, b: number): number;
-//# sourceMappingURL=index.d.ts.map

package/lib/typescript/src/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAEA,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAErD"}

package/react-native-nitro.podspec

@@ -1,41 +0,0 @@
-require "json"
-
-package = JSON.parse(File.read(File.join(__dir__, "package.json")))
-folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
-
-Pod::Spec.new do |s|
-  s.name         = "react-native-nitro"
-  s.version      = package["version"]
-  s.summary      = package["description"]
-  s.homepage     = package["homepage"]
-  s.license      = package["license"]
-  s.authors      = package["author"]
-
-  s.platforms    = { :ios => min_ios_version_supported }
-  s.source       = { :git => "https://github.com/mrousavy/react-native-nitro.git", :tag => "#{s.version}" }
-
-  s.source_files = "ios/**/*.{h,m,mm}", "cpp/**/*.{hpp,cpp,c,h}"
-
-  # Use install_modules_dependencies helper to install the dependencies if React Native version >=0.71.0.
-  # See https://github.com/facebook/react-native/blob/febf6b7f33fdb4904669f99d795eba4c0f95d7bf/scripts/cocoapods/new_architecture.rb#L79.
-  if respond_to?(:install_modules_dependencies, true)
-    install_modules_dependencies(s)
-  else
-    s.dependency "React-Core"
-
-    # Don't install the dependencies when we run `pod install` in the old architecture.
-    if ENV['RCT_NEW_ARCH_ENABLED'] == '1' then
-      s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
-      s.pod_target_xcconfig    = {
-          "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
-          "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
-          "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
-      }
-      s.dependency "React-Codegen"
-      s.dependency "RCT-Folly"
-      s.dependency "RCTRequired"
-      s.dependency "RCTTypeSafety"
-      s.dependency "ReactCommon/turbomodule/core"
-    end
-  end
-end

package/src/NativeNitro.ts

@@ -1,8 +0,0 @@
-import type { TurboModule } from 'react-native';
-import { TurboModuleRegistry } from 'react-native';
-
-export interface Spec extends TurboModule {
-  multiply(a: number, b: number): number;
-}
-
-export default TurboModuleRegistry.getEnforcing<Spec>('Nitro');

package/src/index.tsx

@@ -1,5 +0,0 @@
-const Nitro = require('./NativeNitro').default;
-
-export function multiply(a: number, b: number): number {
-  return Nitro.multiply(a, b);
-}