@imagowave/vision-ocr 0.0.1

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

@@ -0,0 +1,91 @@
+///
+/// OcrResult.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 `OcrBlock` to properly resolve imports.
+namespace margelo::nitro::visionocr { struct OcrBlock; }
+
+#include <string>
+#include "OcrBlock.hpp"
+#include <vector>
+#include <optional>
+
+namespace margelo::nitro::visionocr {
+
+  /**
+   * A struct which can be represented as a JavaScript object (OcrResult).
+   */
+  struct OcrResult final {
+  public:
+    std::string text     SWIFT_PRIVATE;
+    std::optional<std::vector<OcrBlock>> blocks     SWIFT_PRIVATE;
+
+  public:
+    OcrResult() = default;
+    explicit OcrResult(std::string text, std::optional<std::vector<OcrBlock>> blocks): text(text), blocks(blocks) {}
+
+  public:
+    friend bool operator==(const OcrResult& lhs, const OcrResult& rhs) = default;
+  };
+
+} // namespace margelo::nitro::visionocr
+
+namespace margelo::nitro {
+
+  // C++ OcrResult <> JS OcrResult (object)
+  template <>
+  struct JSIConverter<margelo::nitro::visionocr::OcrResult> final {
+    static inline margelo::nitro::visionocr::OcrResult fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::visionocr::OcrResult(
+        JSIConverter<std::string>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "text"))),
+        JSIConverter<std::optional<std::vector<margelo::nitro::visionocr::OcrBlock>>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "blocks")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::visionocr::OcrResult& 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, "blocks"), JSIConverter<std::optional<std::vector<margelo::nitro::visionocr::OcrBlock>>>::toJSI(runtime, arg.blocks));
+      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<std::vector<margelo::nitro::visionocr::OcrBlock>>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "blocks")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

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

@@ -0,0 +1,94 @@
+///
+/// OcrWord.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 `OcrBox` to properly resolve imports.
+namespace margelo::nitro::visionocr { struct OcrBox; }
+
+#include <string>
+#include "OcrBox.hpp"
+#include <optional>
+
+namespace margelo::nitro::visionocr {
+
+  /**
+   * A struct which can be represented as a JavaScript object (OcrWord).
+   */
+  struct OcrWord final {
+  public:
+    std::string text     SWIFT_PRIVATE;
+    std::optional<OcrBox> box     SWIFT_PRIVATE;
+    std::optional<double> confidence     SWIFT_PRIVATE;
+
+  public:
+    OcrWord() = default;
+    explicit OcrWord(std::string text, std::optional<OcrBox> box, std::optional<double> confidence): text(text), box(box), confidence(confidence) {}
+
+  public:
+    friend bool operator==(const OcrWord& lhs, const OcrWord& rhs) = default;
+  };
+
+} // namespace margelo::nitro::visionocr
+
+namespace margelo::nitro {
+
+  // C++ OcrWord <> JS OcrWord (object)
+  template <>
+  struct JSIConverter<margelo::nitro::visionocr::OcrWord> final {
+    static inline margelo::nitro::visionocr::OcrWord fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::visionocr::OcrWord(
+        JSIConverter<std::string>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "text"))),
+        JSIConverter<std::optional<margelo::nitro::visionocr::OcrBox>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "box"))),
+        JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "confidence")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::visionocr::OcrWord& 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, "box"), JSIConverter<std::optional<margelo::nitro::visionocr::OcrBox>>::toJSI(runtime, arg.box));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "confidence"), JSIConverter<std::optional<double>>::toJSI(runtime, arg.confidence));
+      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<margelo::nitro::visionocr::OcrBox>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "box")))) return false;
+      if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "confidence")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

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

@@ -0,0 +1,76 @@
+///
+/// RLevel.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/NitroHash.hpp>)
+#include <NitroModules/NitroHash.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#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
+
+namespace margelo::nitro::visionocr {
+
+  /**
+   * An enum which can be represented as a JavaScript union (RLevel).
+   */
+  enum class RLevel {
+    FAST      SWIFT_NAME(fast) = 0,
+    ACCURATE      SWIFT_NAME(accurate) = 1,
+  } CLOSED_ENUM;
+
+} // namespace margelo::nitro::visionocr
+
+namespace margelo::nitro {
+
+  // C++ RLevel <> JS RLevel (union)
+  template <>
+  struct JSIConverter<margelo::nitro::visionocr::RLevel> final {
+    static inline margelo::nitro::visionocr::RLevel fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      std::string unionValue = JSIConverter<std::string>::fromJSI(runtime, arg);
+      switch (hashString(unionValue.c_str(), unionValue.size())) {
+        case hashString("fast"): return margelo::nitro::visionocr::RLevel::FAST;
+        case hashString("accurate"): return margelo::nitro::visionocr::RLevel::ACCURATE;
+        default: [[unlikely]]
+          throw std::invalid_argument("Cannot convert \"" + unionValue + "\" to enum RLevel - invalid value!");
+      }
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, margelo::nitro::visionocr::RLevel arg) {
+      switch (arg) {
+        case margelo::nitro::visionocr::RLevel::FAST: return JSIConverter<std::string>::toJSI(runtime, "fast");
+        case margelo::nitro::visionocr::RLevel::ACCURATE: return JSIConverter<std::string>::toJSI(runtime, "accurate");
+        default: [[unlikely]]
+          throw std::invalid_argument("Cannot convert RLevel to JS - invalid value: "
+                                    + std::to_string(static_cast<int>(arg)) + "!");
+      }
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isString()) {
+        return false;
+      }
+      std::string unionValue = JSIConverter<std::string>::fromJSI(runtime, value);
+      switch (hashString(unionValue.c_str(), unionValue.size())) {
+        case hashString("fast"):
+        case hashString("accurate"):
+          return true;
+        default:
+          return false;
+      }
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

@@ -0,0 +1,111 @@
+{
+	"name": "@imagowave/vision-ocr",
+	"version": "0.0.1",
+	"description": "A React Native module for performing OCR using the Vision framework on iOS and ML Kit on Android.",
+	"main": "lib/index",
+	"module": "lib/index",
+	"types": "lib/types.ts",
+	"react-native": "src/index",
+	"source": "src/index",
+	"files": [
+		"src",
+		"react-native.config.js",
+		"lib",
+		"nitrogen",
+		"android/build.gradle",
+		"android/gradle.properties",
+		"android/fix-prefab.gradle",
+		"android/CMakeLists.txt",
+		"android/src",
+		"cpp",
+		"ios/**/*.h",
+		"ios/**/*.m",
+		"ios/**/*.mm",
+		"ios/**/*.cpp",
+		"ios/**/*.swift",
+		"app.plugin.js",
+		"nitro.json",
+		"*.podspec",
+		"README.md"
+	],
+	"scripts": {
+		"typecheck": "tsc --noEmit",
+		"clean": "rm -rf android/build node_modules/**/android/build lib",
+		"lint": "eslint \"**/*.{js,ts,tsx}\" --fix",
+		"lint-ci": "eslint \"**/*.{js,ts,tsx}\" -f @jamesacarr/github-actions",
+		"typescript": "tsc",
+		"specs": "tsc --noEmit false && nitrogen --logLevel=\"debug\""
+	},
+	"keywords": [
+		"react-native",
+		"nitro"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/imagowave/vision-ocr.git"
+	},
+	"author": "Jonathan Grimes <> (https://github.com/jsg2021)",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/imagowave/vision-ocr/issues"
+	},
+	"homepage": "https://github.com/imagowave/vision-ocr#readme",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/",
+		"access": "public"
+	},
+	"devDependencies": {
+		"@react-native/eslint-config": "0.83.0",
+		"@types/react": "^19.1.03",
+		"eslint": "^8.57.0",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-prettier": "^5.2.1",
+		"nitrogen": "*",
+		"prettier": "^3.3.3",
+		"react": "19.2.0",
+		"react-native": "0.83.0",
+		"react-native-nitro-modules": "*",
+		"react-native-vision-camera": "*",
+		"typescript": "^5.8.3"
+	},
+	"peerDependencies": {
+		"react": "*",
+		"react-native": "*",
+		"react-native-nitro-modules": "*",
+		"react-native-vision-camera": "*"
+	},
+	"eslintConfig": {
+		"root": true,
+		"extends": [
+			"@react-native",
+			"prettier"
+		],
+		"plugins": [
+			"prettier"
+		],
+		"rules": {
+			"prettier/prettier": [
+				"warn",
+				{
+					"quoteProps": "consistent",
+					"singleQuote": true,
+					"tabWidth": 2,
+					"trailingComma": "es5",
+					"useTabs": false
+				}
+			]
+		}
+	},
+	"eslintIgnore": [
+		"node_modules/",
+		"lib/"
+	],
+	"prettier": {
+		"quoteProps": "consistent",
+		"singleQuote": true,
+		"tabWidth": 2,
+		"trailingComma": "es5",
+		"useTabs": false,
+		"semi": false
+	}
+}

package/react-native.config.js

@@ -0,0 +1,16 @@
+// https://github.com/react-native-community/cli/blob/main/docs/dependencies.md
+
+module.exports = {
+  dependency: {
+    platforms: {
+      /**
+       * @type {import('@react-native-community/cli-types').IOSDependencyParams}
+       */
+      ios: {},
+      /**
+       * @type {import('@react-native-community/cli-types').AndroidDependencyParams}
+       */
+      android: {},
+    },
+  },
+}

package/src/index.ts

@@ -0,0 +1,21 @@
+import { NitroModules } from "react-native-nitro-modules";
+import type { Frame } from "react-native-vision-camera";
+
+import type { VisionOCR } from "./specs/VisionOCR.nitro";
+import type { OcrOptions, OcrResult } from "./types";
+
+export * from "./types";
+
+const plugin = NitroModules.createHybridObject<VisionOCR>("VisionOCR");
+
+export default plugin;
+
+export function performOcr(
+	frame: Frame,
+	options?: OcrOptions,
+): OcrResult | null {
+	"worklet";
+	if (plugin == null) throw new Error("Failed to load Frame Processor Plugin");
+
+	return plugin.call(frame, options ?? {}) as unknown as OcrResult | null;
+}

package/src/specs/VisionOCR.nitro.ts

@@ -0,0 +1,11 @@
+import type { HybridObject } from "react-native-nitro-modules";
+import type { Frame } from "react-native-vision-camera";
+import type { OcrOptions, OcrResult } from "../types";
+
+export interface VisionOCR
+	extends HybridObject<{
+		ios: "swift";
+		android: "kotlin";
+	}> {
+	call(frame: Frame, options?: OcrOptions): OcrResult | undefined;
+}

package/src/types.ts

@@ -0,0 +1,41 @@
+type RLevel = "fast" | "accurate";
+
+export type OcrOptions = {
+	includeBoxes?: boolean;
+	includeConfidence?: boolean;
+	// iOS only options (ignored on Android)
+	recognitionLevel?: RLevel;
+	recognitionLanguages?: string[];
+	usesLanguageCorrection?: boolean;
+};
+
+export type OcrBox = {
+	x: number;
+	y: number;
+	width: number;
+	height: number;
+};
+
+export type OcrWord = {
+	text: string;
+	box?: OcrBox;
+	confidence?: number;
+};
+
+export type OcrLine = {
+	text: string;
+	box?: OcrBox;
+	words?: OcrWord[];
+	confidence?: number;
+};
+
+export type OcrBlock = {
+	text: string;
+	box?: OcrBox;
+	lines?: OcrLine[];
+};
+
+export type OcrResult = {
+	text: string;
+	blocks?: OcrBlock[];
+};