@nitro-mlkit/translation 0.1.0-beta.0

package/nitrogen/generated/ios/swift/Func_void_std__string.swift

@@ -0,0 +1,46 @@
+///
+/// Func_void_std__string.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Wraps a Swift `(_ value: String) -> Void` as a class.
+ * This class can be used from C++, e.g. to wrap the Swift closure as a `std::function`.
+ */
+public final class Func_void_std__string {
+  public typealias bridge = margelo.nitro.mlkit.translate.bridge.swift
+
+  private let closure: (_ value: String) -> Void
+
+  public init(_ closure: @escaping (_ value: String) -> Void) {
+    self.closure = closure
+  }
+
+  @inline(__always)
+  public func call(value: std.string) -> Void {
+    self.closure(String(value))
+  }
+
+  /**
+   * Casts this instance to a retained unsafe raw pointer.
+   * This acquires one additional strong reference on the object!
+   */
+  @inline(__always)
+  public func toUnsafe() -> UnsafeMutableRawPointer {
+    return Unmanaged.passRetained(self).toOpaque()
+  }
+
+  /**
+   * Casts an unsafe pointer to a `Func_void_std__string`.
+   * The pointer has to be a retained opaque `Unmanaged<Func_void_std__string>`.
+   * This removes one strong reference from the object!
+   */
+  @inline(__always)
+  public static func fromUnsafe(_ pointer: UnsafeMutableRawPointer) -> Func_void_std__string {
+    return Unmanaged<Func_void_std__string>.fromOpaque(pointer).takeRetainedValue()
+  }
+}

package/nitrogen/generated/ios/swift/Func_void_std__vector_std__string_.swift

@@ -0,0 +1,46 @@
+///
+/// Func_void_std__vector_std__string_.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Wraps a Swift `(_ value: [String]) -> Void` as a class.
+ * This class can be used from C++, e.g. to wrap the Swift closure as a `std::function`.
+ */
+public final class Func_void_std__vector_std__string_ {
+  public typealias bridge = margelo.nitro.mlkit.translate.bridge.swift
+
+  private let closure: (_ value: [String]) -> Void
+
+  public init(_ closure: @escaping (_ value: [String]) -> Void) {
+    self.closure = closure
+  }
+
+  @inline(__always)
+  public func call(value: bridge.std__vector_std__string_) -> Void {
+    self.closure(value.map({ __item in String(__item) }))
+  }
+
+  /**
+   * Casts this instance to a retained unsafe raw pointer.
+   * This acquires one additional strong reference on the object!
+   */
+  @inline(__always)
+  public func toUnsafe() -> UnsafeMutableRawPointer {
+    return Unmanaged.passRetained(self).toOpaque()
+  }
+
+  /**
+   * Casts an unsafe pointer to a `Func_void_std__vector_std__string_`.
+   * The pointer has to be a retained opaque `Unmanaged<Func_void_std__vector_std__string_>`.
+   * This removes one strong reference from the object!
+   */
+  @inline(__always)
+  public static func fromUnsafe(_ pointer: UnsafeMutableRawPointer) -> Func_void_std__vector_std__string_ {
+    return Unmanaged<Func_void_std__vector_std__string_>.fromOpaque(pointer).takeRetainedValue()
+  }
+}

package/nitrogen/generated/ios/swift/HybridTranslatorSpec.swift

@@ -0,0 +1,60 @@
+///
+/// HybridTranslatorSpec.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/// See ``HybridTranslatorSpec``
+public protocol HybridTranslatorSpec_protocol: HybridObject {
+  // Properties
+  
+
+  // Methods
+  func translate(text: String, sourceLanguage: String, targetLanguage: String) throws -> Promise<String>
+  func downloadModel(language: String, requireWifi: Bool) throws -> Promise<Void>
+  func isModelDownloaded(language: String) throws -> Promise<Bool>
+  func deleteModel(language: String) throws -> Promise<Void>
+  func getDownloadedModels() throws -> Promise<[String]>
+  func isAvailable() throws -> Bool
+}
+
+public extension HybridTranslatorSpec_protocol {
+  /// Default implementation of ``HybridObject.toString``
+  func toString() -> String {
+    return "[HybridObject Translator]"
+  }
+}
+
+/// See ``HybridTranslatorSpec``
+open class HybridTranslatorSpec_base {
+  private weak var cxxWrapper: HybridTranslatorSpec_cxx? = nil
+  public init() { }
+  public func getCxxWrapper() -> HybridTranslatorSpec_cxx {
+  #if DEBUG
+    guard self is any HybridTranslatorSpec else {
+      fatalError("`self` is not a `HybridTranslatorSpec`! Did you accidentally inherit from `HybridTranslatorSpec_base` instead of `HybridTranslatorSpec`?")
+    }
+  #endif
+    if let cxxWrapper = self.cxxWrapper {
+      return cxxWrapper
+    } else {
+      let cxxWrapper = HybridTranslatorSpec_cxx(self as! any HybridTranslatorSpec)
+      self.cxxWrapper = cxxWrapper
+      return cxxWrapper
+    }
+  }
+}
+
+/**
+ * A Swift base-protocol representing the Translator HybridObject.
+ * Implement this protocol to create Swift-based instances of Translator.
+ * ```swift
+ * class HybridTranslator : HybridTranslatorSpec {
+ *   // ...
+ * }
+ * ```
+ */
+public typealias HybridTranslatorSpec = HybridTranslatorSpec_protocol & HybridTranslatorSpec_base

package/nitrogen/generated/ios/swift/HybridTranslatorSpec_cxx.swift

@@ -0,0 +1,239 @@
+///
+/// HybridTranslatorSpec_cxx.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * A class implementation that bridges HybridTranslatorSpec over to C++.
+ * In C++, we cannot use Swift protocols - so we need to wrap it in a class to make it strongly defined.
+ *
+ * Also, some Swift types need to be bridged with special handling:
+ * - Enums need to be wrapped in Structs, otherwise they cannot be accessed bi-directionally (Swift bug: https://github.com/swiftlang/swift/issues/75330)
+ * - Other HybridObjects need to be wrapped/unwrapped from the Swift TCxx wrapper
+ * - Throwing methods need to be wrapped with a Result<T, Error> type, as exceptions cannot be propagated to C++
+ */
+open class HybridTranslatorSpec_cxx {
+  /**
+   * The Swift <> C++ bridge's namespace (`margelo::nitro::mlkit::translate::bridge::swift`)
+   * from `NitroMLKitTranslate-Swift-Cxx-Bridge.hpp`.
+   * This contains specialized C++ templates, and C++ helper functions that can be accessed from Swift.
+   */
+  public typealias bridge = margelo.nitro.mlkit.translate.bridge.swift
+
+  /**
+   * Holds an instance of the `HybridTranslatorSpec` Swift protocol.
+   */
+  private var __implementation: any HybridTranslatorSpec
+
+  /**
+   * Holds a weak pointer to the C++ class that wraps the Swift class.
+   */
+  private var __cxxPart: bridge.std__weak_ptr_HybridTranslatorSpec_
+
+  /**
+   * Create a new `HybridTranslatorSpec_cxx` that wraps the given `HybridTranslatorSpec`.
+   * All properties and methods bridge to C++ types.
+   */
+  public init(_ implementation: any HybridTranslatorSpec) {
+    self.__implementation = implementation
+    self.__cxxPart = .init()
+    /* no base class */
+  }
+
+  /**
+   * Get the actual `HybridTranslatorSpec` instance this class wraps.
+   */
+  @inline(__always)
+  public func getHybridTranslatorSpec() -> any HybridTranslatorSpec {
+    return __implementation
+  }
+
+  /**
+   * Casts this instance to a retained unsafe raw pointer.
+   * This acquires one additional strong reference on the object!
+   */
+  public func toUnsafe() -> UnsafeMutableRawPointer {
+    return Unmanaged.passRetained(self).toOpaque()
+  }
+
+  /**
+   * Casts an unsafe pointer to a `HybridTranslatorSpec_cxx`.
+   * The pointer has to be a retained opaque `Unmanaged<HybridTranslatorSpec_cxx>`.
+   * This removes one strong reference from the object!
+   */
+  public class func fromUnsafe(_ pointer: UnsafeMutableRawPointer) -> HybridTranslatorSpec_cxx {
+    return Unmanaged<HybridTranslatorSpec_cxx>.fromOpaque(pointer).takeRetainedValue()
+  }
+
+  /**
+   * Gets (or creates) the C++ part of this Hybrid Object.
+   * The C++ part is a `std::shared_ptr<HybridTranslatorSpec>`.
+   */
+  public func getCxxPart() -> bridge.std__shared_ptr_HybridTranslatorSpec_ {
+    let cachedCxxPart = self.__cxxPart.lock()
+    if Bool(fromCxx: cachedCxxPart) {
+      return cachedCxxPart
+    } else {
+      let newCxxPart = bridge.create_std__shared_ptr_HybridTranslatorSpec_(self.toUnsafe())
+      __cxxPart = bridge.weakify_std__shared_ptr_HybridTranslatorSpec_(newCxxPart)
+      return newCxxPart
+    }
+  }
+
+  
+
+  /**
+   * Get the memory size of the Swift class (plus size of any other allocations)
+   * so the JS VM can properly track it and garbage-collect the JS object if needed.
+   */
+  @inline(__always)
+  public var memorySize: Int {
+    return MemoryHelper.getSizeOf(self.__implementation) + self.__implementation.memorySize
+  }
+
+  /**
+   * Compares this object with the given [other] object for reference equality.
+   */
+  @inline(__always)
+  public func equals(other: HybridTranslatorSpec_cxx) -> Bool {
+    return self.__implementation === other.__implementation
+  }
+
+  /**
+   * Call dispose() on the Swift class.
+   * This _may_ be called manually from JS.
+   */
+  @inline(__always)
+  public func dispose() {
+    self.__implementation.dispose()
+  }
+
+  /**
+   * Call toString() on the Swift class.
+   */
+  @inline(__always)
+  public func toString() -> String {
+    return self.__implementation.toString()
+  }
+
+  // Properties
+  
+
+  // Methods
+  @inline(__always)
+  public final func translate(text: std.string, sourceLanguage: std.string, targetLanguage: std.string) -> bridge.Result_std__shared_ptr_Promise_std__string___ {
+    do {
+      let __result = try self.__implementation.translate(text: String(text), sourceLanguage: String(sourceLanguage), targetLanguage: String(targetLanguage))
+      let __resultCpp = { () -> bridge.std__shared_ptr_Promise_std__string__ in
+        let __promise = bridge.create_std__shared_ptr_Promise_std__string__()
+        let __promiseHolder = bridge.wrap_std__shared_ptr_Promise_std__string__(__promise)
+        __result
+          .then({ __result in __promiseHolder.resolve(std.string(__result)) })
+          .catch({ __error in __promiseHolder.reject(__error.toCpp()) })
+        return __promise
+      }()
+      return bridge.create_Result_std__shared_ptr_Promise_std__string___(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__shared_ptr_Promise_std__string___(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func downloadModel(language: std.string, requireWifi: Bool) -> bridge.Result_std__shared_ptr_Promise_void___ {
+    do {
+      let __result = try self.__implementation.downloadModel(language: String(language), requireWifi: requireWifi)
+      let __resultCpp = { () -> bridge.std__shared_ptr_Promise_void__ in
+        let __promise = bridge.create_std__shared_ptr_Promise_void__()
+        let __promiseHolder = bridge.wrap_std__shared_ptr_Promise_void__(__promise)
+        __result
+          .then({ __result in __promiseHolder.resolve() })
+          .catch({ __error in __promiseHolder.reject(__error.toCpp()) })
+        return __promise
+      }()
+      return bridge.create_Result_std__shared_ptr_Promise_void___(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__shared_ptr_Promise_void___(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func isModelDownloaded(language: std.string) -> bridge.Result_std__shared_ptr_Promise_bool___ {
+    do {
+      let __result = try self.__implementation.isModelDownloaded(language: String(language))
+      let __resultCpp = { () -> bridge.std__shared_ptr_Promise_bool__ in
+        let __promise = bridge.create_std__shared_ptr_Promise_bool__()
+        let __promiseHolder = bridge.wrap_std__shared_ptr_Promise_bool__(__promise)
+        __result
+          .then({ __result in __promiseHolder.resolve(__result) })
+          .catch({ __error in __promiseHolder.reject(__error.toCpp()) })
+        return __promise
+      }()
+      return bridge.create_Result_std__shared_ptr_Promise_bool___(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__shared_ptr_Promise_bool___(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func deleteModel(language: std.string) -> bridge.Result_std__shared_ptr_Promise_void___ {
+    do {
+      let __result = try self.__implementation.deleteModel(language: String(language))
+      let __resultCpp = { () -> bridge.std__shared_ptr_Promise_void__ in
+        let __promise = bridge.create_std__shared_ptr_Promise_void__()
+        let __promiseHolder = bridge.wrap_std__shared_ptr_Promise_void__(__promise)
+        __result
+          .then({ __result in __promiseHolder.resolve() })
+          .catch({ __error in __promiseHolder.reject(__error.toCpp()) })
+        return __promise
+      }()
+      return bridge.create_Result_std__shared_ptr_Promise_void___(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__shared_ptr_Promise_void___(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func getDownloadedModels() -> bridge.Result_std__shared_ptr_Promise_std__vector_std__string____ {
+    do {
+      let __result = try self.__implementation.getDownloadedModels()
+      let __resultCpp = { () -> bridge.std__shared_ptr_Promise_std__vector_std__string___ in
+        let __promise = bridge.create_std__shared_ptr_Promise_std__vector_std__string___()
+        let __promiseHolder = bridge.wrap_std__shared_ptr_Promise_std__vector_std__string___(__promise)
+        __result
+          .then({ __result in __promiseHolder.resolve({ () -> bridge.std__vector_std__string_ in
+              var __vector = bridge.create_std__vector_std__string_(__result.count)
+              for __item in __result {
+                __vector.push_back(std.string(__item))
+              }
+              return __vector
+            }()) })
+          .catch({ __error in __promiseHolder.reject(__error.toCpp()) })
+        return __promise
+      }()
+      return bridge.create_Result_std__shared_ptr_Promise_std__vector_std__string____(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_std__shared_ptr_Promise_std__vector_std__string____(__exceptionPtr)
+    }
+  }
+  
+  @inline(__always)
+  public final func isAvailable() -> bridge.Result_bool_ {
+    do {
+      let __result = try self.__implementation.isAvailable()
+      let __resultCpp = __result
+      return bridge.create_Result_bool_(__resultCpp)
+    } catch (let __error) {
+      let __exceptionPtr = __error.toCpp()
+      return bridge.create_Result_bool_(__exceptionPtr)
+    }
+  }
+}

package/nitrogen/generated/shared/c++/HybridTranslatorSpec.cpp

@@ -0,0 +1,26 @@
+///
+/// HybridTranslatorSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include "HybridTranslatorSpec.hpp"
+
+namespace margelo::nitro::mlkit::translate {
+
+  void HybridTranslatorSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridMethod("translate", &HybridTranslatorSpec::translate);
+      prototype.registerHybridMethod("downloadModel", &HybridTranslatorSpec::downloadModel);
+      prototype.registerHybridMethod("isModelDownloaded", &HybridTranslatorSpec::isModelDownloaded);
+      prototype.registerHybridMethod("deleteModel", &HybridTranslatorSpec::deleteModel);
+      prototype.registerHybridMethod("getDownloadedModels", &HybridTranslatorSpec::getDownloadedModels);
+      prototype.registerHybridMethod("isAvailable", &HybridTranslatorSpec::isAvailable);
+    });
+  }
+
+} // namespace margelo::nitro::mlkit::translate

package/nitrogen/generated/shared/c++/HybridTranslatorSpec.hpp

@@ -0,0 +1,69 @@
+///
+/// HybridTranslatorSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <string>
+#include <NitroModules/Promise.hpp>
+#include <vector>
+
+namespace margelo::nitro::mlkit::translate {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `Translator`
+   * Inherit this class to create instances of `HybridTranslatorSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridTranslator: public HybridTranslatorSpec {
+   * public:
+   *   HybridTranslator(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridTranslatorSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridTranslatorSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridTranslatorSpec() override = default;
+
+    public:
+      // Properties
+      
+
+    public:
+      // Methods
+      virtual std::shared_ptr<Promise<std::string>> translate(const std::string& text, const std::string& sourceLanguage, const std::string& targetLanguage) = 0;
+      virtual std::shared_ptr<Promise<void>> downloadModel(const std::string& language, bool requireWifi) = 0;
+      virtual std::shared_ptr<Promise<bool>> isModelDownloaded(const std::string& language) = 0;
+      virtual std::shared_ptr<Promise<void>> deleteModel(const std::string& language) = 0;
+      virtual std::shared_ptr<Promise<std::vector<std::string>>> getDownloadedModels() = 0;
+      virtual bool isAvailable() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "Translator";
+  };
+
+} // namespace margelo::nitro::mlkit::translate

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@nitro-mlkit/translation",
+  "version": "0.1.0-beta.0",
+  "description": "High-performance on-device translation for React Native — Google ML Kit + Nitro. Translate between 50+ languages, all on-device once the model is downloaded.",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "scripts": {
+    "codegen": "nitrogen",
+    "build": "tsc --noEmit"
+  },
+  "keywords": [
+    "react-native",
+    "nitro",
+    "mlkit",
+    "translation",
+    "translate",
+    "nlp",
+    "machine-learning",
+    "on-device",
+    "expo"
+  ],
+  "author": "pologonzalo",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pologonzalo/react-native-nitro-mlkit",
+    "directory": "packages/translation"
+  },
+  "peerDependencies": {
+    "expo-modules-core": "*",
+    "react": ">=18",
+    "react-native": ">=0.76",
+    "react-native-nitro-modules": ">=0.20"
+  },
+  "devDependencies": {
+    "expo-modules-core": "*",
+    "nitro-codegen": "*",
+    "react-native-nitro-modules": "*",
+    "typescript": "~5.9.0"
+  },
+  "files": [
+    "src",
+    "ios/**/*.swift",
+    "android/src",
+    "android/build.gradle",
+    "android/CMakeLists.txt",
+    "expo-module.config.json",
+    "nitrogen/generated",
+    "*.podspec",
+    "nitro.json",
+    "README.md",
+    "LICENSE"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+export { type Translator } from "./specs/Translator.nitro";
+
+import { Platform } from "react-native";
+import { requireOptionalNativeModule } from "expo-modules-core";
+import { NitroModules } from "react-native-nitro-modules";
+import type { Translator } from "./specs/Translator.nitro";
+
+if (Platform.OS === "android") {
+  requireOptionalNativeModule("NitroMLKitTranslate");
+}
+
+/** Get the shared Translator instance. */
+export const NitroTranslate =
+  NitroModules.createHybridObject<Translator>("Translator");

package/src/specs/Translator.nitro.ts

@@ -0,0 +1,23 @@
+import type { HybridObject } from "react-native-nitro-modules";
+
+/**
+ * On-device translation powered by Google ML Kit. 50+ languages, all on-device
+ * once the language model is downloaded. Language codes are BCP-47 (e.g. "en",
+ * "es", "fr", "de", "ja").
+ */
+export interface Translator extends HybridObject<{ ios: "swift"; android: "kotlin" }> {
+  /**
+   * Translate text from source → target language. Downloads the required model
+   * on first use (may take a few seconds / need network).
+   */
+  translate(text: string, sourceLanguage: string, targetLanguage: string): Promise<string>;
+  /** Download a language model ahead of time. */
+  downloadModel(language: string, requireWifi: boolean): Promise<void>;
+  /** Whether a language model is already downloaded. */
+  isModelDownloaded(language: string): Promise<boolean>;
+  /** Delete a downloaded language model. */
+  deleteModel(language: string): Promise<void>;
+  /** BCP-47 tags of all currently downloaded models. */
+  getDownloadedModels(): Promise<string[]>;
+  isAvailable(): boolean;
+}