@nitro-mlkit/digital-ink 0.1.0-beta.0

package/nitrogen/generated/ios/swift/RecognitionCandidate.swift

@@ -0,0 +1,47 @@
+///
+/// RecognitionCandidate.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+/**
+ * Represents an instance of `RecognitionCandidate`, backed by a C++ struct.
+ */
+public typealias RecognitionCandidate = margelo.nitro.mlkit.digitalink.RecognitionCandidate
+
+public extension RecognitionCandidate {
+  private typealias bridge = margelo.nitro.mlkit.digitalink.bridge.swift
+
+  /**
+   * Create a new instance of `RecognitionCandidate`.
+   */
+  init(text: String, score: Double?) {
+    self.init(std.string(text), { () -> bridge.std__optional_double_ in
+      if let __unwrappedValue = score {
+        return bridge.create_std__optional_double_(__unwrappedValue)
+      } else {
+        return .init()
+      }
+    }())
+  }
+
+  @inline(__always)
+  var text: String {
+    return String(self.__text)
+  }
+  
+  @inline(__always)
+  var score: Double? {
+    return { () -> Double? in
+      if bridge.has_value_std__optional_double_(self.__score) {
+        let __unwrapped = bridge.get_std__optional_double_(self.__score)
+        return __unwrapped
+      } else {
+        return nil
+      }
+    }()
+  }
+}

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

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

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

@@ -0,0 +1,73 @@
+///
+/// HybridDigitalInkRecognizerSpec.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
+
+// Forward declaration of `RecognitionCandidate` to properly resolve imports.
+namespace margelo::nitro::mlkit::digitalink { struct RecognitionCandidate; }
+// Forward declaration of `InkStroke` to properly resolve imports.
+namespace margelo::nitro::mlkit::digitalink { struct InkStroke; }
+
+#include "RecognitionCandidate.hpp"
+#include <vector>
+#include <NitroModules/Promise.hpp>
+#include "InkStroke.hpp"
+#include <string>
+
+namespace margelo::nitro::mlkit::digitalink {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `DigitalInkRecognizer`
+   * Inherit this class to create instances of `HybridDigitalInkRecognizerSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridDigitalInkRecognizer: public HybridDigitalInkRecognizerSpec {
+   * public:
+   *   HybridDigitalInkRecognizer(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridDigitalInkRecognizerSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridDigitalInkRecognizerSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridDigitalInkRecognizerSpec() override = default;
+
+    public:
+      // Properties
+      
+
+    public:
+      // Methods
+      virtual std::shared_ptr<Promise<std::vector<RecognitionCandidate>>> recognize(const std::vector<InkStroke>& strokes, const std::string& languageTag) = 0;
+      virtual std::shared_ptr<Promise<void>> downloadModel(const std::string& languageTag) = 0;
+      virtual std::shared_ptr<Promise<bool>> isModelDownloaded(const std::string& languageTag) = 0;
+      virtual std::shared_ptr<Promise<void>> deleteModel(const std::string& languageTag) = 0;
+      virtual bool isAvailable() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "DigitalInkRecognizer";
+  };
+
+} // namespace margelo::nitro::mlkit::digitalink

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

@@ -0,0 +1,91 @@
+///
+/// InkPoint.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/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/PropNameIDCache.hpp>)
+#include <NitroModules/PropNameIDCache.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <optional>
+
+namespace margelo::nitro::mlkit::digitalink {
+
+  /**
+   * A struct which can be represented as a JavaScript object (InkPoint).
+   */
+  struct InkPoint final {
+  public:
+    double x     SWIFT_PRIVATE;
+    double y     SWIFT_PRIVATE;
+    std::optional<double> t     SWIFT_PRIVATE;
+
+  public:
+    InkPoint() = default;
+    explicit InkPoint(double x, double y, std::optional<double> t): x(x), y(y), t(t) {}
+
+  public:
+    friend bool operator==(const InkPoint& lhs, const InkPoint& rhs) = default;
+  };
+
+} // namespace margelo::nitro::mlkit::digitalink
+
+namespace margelo::nitro {
+
+  // C++ InkPoint <> JS InkPoint (object)
+  template <>
+  struct JSIConverter<margelo::nitro::mlkit::digitalink::InkPoint> final {
+    static inline margelo::nitro::mlkit::digitalink::InkPoint fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::mlkit::digitalink::InkPoint(
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "x"))),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "y"))),
+        JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "t")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::mlkit::digitalink::InkPoint& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "x"), JSIConverter<double>::toJSI(runtime, arg.x));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "y"), JSIConverter<double>::toJSI(runtime, arg.y));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "t"), JSIConverter<std::optional<double>>::toJSI(runtime, arg.t));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "x")))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "y")))) return false;
+      if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "t")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

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

@@ -0,0 +1,85 @@
+///
+/// InkStroke.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/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/PropNameIDCache.hpp>)
+#include <NitroModules/PropNameIDCache.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `InkPoint` to properly resolve imports.
+namespace margelo::nitro::mlkit::digitalink { struct InkPoint; }
+
+#include "InkPoint.hpp"
+#include <vector>
+
+namespace margelo::nitro::mlkit::digitalink {
+
+  /**
+   * A struct which can be represented as a JavaScript object (InkStroke).
+   */
+  struct InkStroke final {
+  public:
+    std::vector<InkPoint> points     SWIFT_PRIVATE;
+
+  public:
+    InkStroke() = default;
+    explicit InkStroke(std::vector<InkPoint> points): points(points) {}
+
+  public:
+    friend bool operator==(const InkStroke& lhs, const InkStroke& rhs) = default;
+  };
+
+} // namespace margelo::nitro::mlkit::digitalink
+
+namespace margelo::nitro {
+
+  // C++ InkStroke <> JS InkStroke (object)
+  template <>
+  struct JSIConverter<margelo::nitro::mlkit::digitalink::InkStroke> final {
+    static inline margelo::nitro::mlkit::digitalink::InkStroke fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::mlkit::digitalink::InkStroke(
+        JSIConverter<std::vector<margelo::nitro::mlkit::digitalink::InkPoint>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "points")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::mlkit::digitalink::InkStroke& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "points"), JSIConverter<std::vector<margelo::nitro::mlkit::digitalink::InkPoint>>::toJSI(runtime, arg.points));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<std::vector<margelo::nitro::mlkit::digitalink::InkPoint>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "points")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

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

@@ -0,0 +1,88 @@
+///
+/// RecognitionCandidate.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/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/PropNameIDCache.hpp>)
+#include <NitroModules/PropNameIDCache.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+#include <string>
+#include <optional>
+
+namespace margelo::nitro::mlkit::digitalink {
+
+  /**
+   * A struct which can be represented as a JavaScript object (RecognitionCandidate).
+   */
+  struct RecognitionCandidate final {
+  public:
+    std::string text     SWIFT_PRIVATE;
+    std::optional<double> score     SWIFT_PRIVATE;
+
+  public:
+    RecognitionCandidate() = default;
+    explicit RecognitionCandidate(std::string text, std::optional<double> score): text(text), score(score) {}
+
+  public:
+    friend bool operator==(const RecognitionCandidate& lhs, const RecognitionCandidate& rhs) = default;
+  };
+
+} // namespace margelo::nitro::mlkit::digitalink
+
+namespace margelo::nitro {
+
+  // C++ RecognitionCandidate <> JS RecognitionCandidate (object)
+  template <>
+  struct JSIConverter<margelo::nitro::mlkit::digitalink::RecognitionCandidate> final {
+    static inline margelo::nitro::mlkit::digitalink::RecognitionCandidate fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::mlkit::digitalink::RecognitionCandidate(
+        JSIConverter<std::string>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "text"))),
+        JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "score")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::mlkit::digitalink::RecognitionCandidate& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "text"), JSIConverter<std::string>::toJSI(runtime, arg.text));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "score"), JSIConverter<std::optional<double>>::toJSI(runtime, arg.score));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<std::string>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "text")))) return false;
+      if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "score")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@nitro-mlkit/digital-ink",
+  "version": "0.1.0-beta.0",
+  "description": "High-performance on-device handwriting recognition for React Native — Google ML Kit + Nitro. Recognize ink strokes in 300+ languages, zero bridge overhead.",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "scripts": {
+    "codegen": "nitrogen",
+    "build": "tsc --noEmit"
+  },
+  "keywords": [
+    "react-native",
+    "nitro",
+    "mlkit",
+    "digital-ink",
+    "handwriting-recognition",
+    "ink",
+    "machine-learning",
+    "on-device",
+    "expo"
+  ],
+  "author": "pologonzalo",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pologonzalo/react-native-nitro-mlkit",
+    "directory": "packages/digital-ink"
+  },
+  "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,19 @@
+export { type DigitalInkRecognizer } from "./specs/DigitalInkRecognizer.nitro";
+export type {
+  InkPoint,
+  InkStroke,
+  RecognitionCandidate,
+} from "./specs/DigitalInkRecognizer.nitro";
+
+import { Platform } from "react-native";
+import { requireOptionalNativeModule } from "expo-modules-core";
+import { NitroModules } from "react-native-nitro-modules";
+import type { DigitalInkRecognizer } from "./specs/DigitalInkRecognizer.nitro";
+
+if (Platform.OS === "android") {
+  requireOptionalNativeModule("NitroMLKitDigitalInk");
+}
+
+/** The shared DigitalInkRecognizer instance. */
+export const NitroDigitalInk =
+  NitroModules.createHybridObject<DigitalInkRecognizer>("DigitalInkRecognizer");

package/src/specs/DigitalInkRecognizer.nitro.ts

@@ -0,0 +1,51 @@
+import type { HybridObject } from "react-native-nitro-modules";
+
+/** A single sampled point of a stroke, in your canvas' coordinate space. */
+export interface InkPoint {
+  x: number;
+  y: number;
+  /**
+   * Optional timestamp in milliseconds (e.g. `Date.now()`), relative or
+   * absolute. Providing it improves recognition accuracy.
+   */
+  t?: number;
+}
+
+/** One continuous stroke (pen-down → pen-up), as its sampled points. */
+export interface InkStroke {
+  points: InkPoint[];
+}
+
+/** A candidate transcription of the ink, best first. */
+export interface RecognitionCandidate {
+  text: string;
+  /** Model score if the model provides one (may be undefined). */
+  score?: number;
+}
+
+/**
+ * On-device handwriting / drawing recognition powered by Google ML Kit.
+ * Feed it the strokes the user drew (points with optional timestamps) and a
+ * BCP-47 language tag; get back candidate transcriptions. The per-language
+ * model downloads at runtime on first use. All recognition is on-device.
+ */
+export interface DigitalInkRecognizer extends HybridObject<{
+  ios: "swift";
+  android: "kotlin";
+}> {
+  /**
+   * Recognize handwriting from ink strokes. `languageTag` is a tag ML Kit
+   * supports (e.g. "en-US", "es-ES", "fr-FR", "zh-Hani", "emoji"). Downloads the
+   * model on first use.
+   */
+  recognize(strokes: InkStroke[], languageTag: string): Promise<RecognitionCandidate[]>;
+
+  /** Download a language model ahead of time. */
+  downloadModel(languageTag: string): Promise<void>;
+  /** Whether a language model is already downloaded. */
+  isModelDownloaded(languageTag: string): Promise<boolean>;
+  /** Delete a downloaded language model. */
+  deleteModel(languageTag: string): Promise<void>;
+
+  isAvailable(): boolean;
+}