react-native-text-reader 1.5.0 → 2.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "react-native-text-reader",
-  "version": "1.5.0",
-  "description": "A React Native library for OCR (Optical Character Recognition) using Vision Framework on iOS and Firebase ML Kit on Android. Optimized for Android 16KB page size compatibility.",
+  "version": "2.0.0",
+  "description": "A React Native library for OCR using Vision Framework on iOS and ML Kit on Android. Supports Expo development builds, detailed OCR metadata, and Android 16KB page size compatibility.",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",
@@ -25,6 +25,7 @@
     "cpp",
     "*.podspec",
     "react-native.config.json",
+    "app.plugin.js",
     "!ios/build",
     "!android/build",
     "!android/gradle",
@@ -37,13 +38,17 @@
     "!**/.*"
   ],
   "scripts": {
-    "example": "yarn workspace react-native-text-reader-example",
+    "example": "pnpm --filter react-native-text-reader-example",
+    "example:prebuild": "pnpm --filter react-native-text-reader-example prebuild",
+    "example:ios": "pnpm --filter react-native-text-reader-example ios",
+    "example:android": "pnpm --filter react-native-text-reader-example android",
     "test": "jest",
     "typecheck": "tsc",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
     "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
     "prepare": "bob build",
-    "release": "release-it"
+    "release": "release-it",
+    "audit": "pnpm audit --audit-level high"
   },
   "keywords": [
     "react-native",
@@ -64,49 +69,59 @@
     "registry": "https://registry.npmjs.org/"
   },
   "devDependencies": {
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-transform-class-properties": "^7.27.1",
     "@babel/preset-env": "^7.28.3",
-    "@commitlint/config-conventional": "^17.0.2",
-    "@evilmartians/lefthook": "^1.5.0",
-    "@react-native/eslint-config": "^0.73.1",
-    "@release-it/conventional-changelog": "^5.0.0",
-    "@types/jest": "^29.5.5",
-    "@types/react": "^19.0.0",
-    "commitlint": "^17.0.2",
-    "del-cli": "^5.1.0",
-    "eslint": "^8.51.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "jest": "^29.7.0",
-    "prettier": "^3.0.3",
-    "react": "19.1.1",
-    "react-native": "0.81.4",
-    "react-native-builder-bob": "^0.30.2",
-    "release-it": "^15.0.0",
-    "turbo": "^1.10.7",
-    "typescript": "^5.2.2"
-  },
-  "resolutions": {
-    "@types/react": "^19.0.0"
+    "@commitlint/config-conventional": "^21.0.2",
+    "@evilmartians/lefthook": "^2.1.9",
+    "@react-native/eslint-config": "^0.86.0",
+    "@release-it/conventional-changelog": "^11.0.1",
+    "@types/jest": "^30.0.0",
+    "@types/react": "^19.2.17",
+    "commitlint": "^21.0.2",
+    "del-cli": "^7.0.0",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "jest": "^30.4.2",
+    "ts-jest": "^29.4.11",
+    "prettier": "^3.8.4",
+    "react": "19.2.7",
+    "react-native": "0.86.0",
+    "react-native-builder-bob": "^0.43.0",
+    "release-it": "^20.2.0",
+    "turbo": "^2.9.18",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "react": "*",
     "react-native": "*"
   },
-  "workspaces": [
-    "example"
-  ],
-  "packageManager": "yarn@3.6.1",
+  "engines": {
+    "node": ">=22",
+    "pnpm": ">=11"
+  },
+  "packageManager": "pnpm@11.8.0",
   "jest": {
-    "preset": "react-native",
+    "preset": "ts-jest",
+    "testEnvironment": "node",
     "modulePathIgnorePatterns": [
-      "<rootDir>/example/node_modules",
-      "<rootDir>/lib/"
+      "<rootDir>/lib/",
+      "<rootDir>/example/"
     ],
-    "transformIgnorePatterns": [
-      "node_modules/(?!(react-native|@react-native|react-native-.*)/)"
-    ]
+    "setupFilesAfterEnv": [
+      "<rootDir>/jest.setup.js"
+    ],
+    "moduleNameMapper": {
+      "^react-native$": "<rootDir>/jest.react-native-mock.js"
+    },
+    "transform": {
+      "^.+\\.tsx?$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.test.json"
+        }
+      ]
+    }
   },
   "commitlint": {
     "extends": [
@@ -126,7 +141,7 @@
     },
     "plugins": {
       "@release-it/conventional-changelog": {
-        "preset": "angular"
+        "preset": "conventionalcommits"
       }
     }
   },
@@ -136,6 +151,9 @@
       "@react-native",
       "prettier"
     ],
+    "plugins": [
+      "prettier"
+    ],
     "rules": {
       "react/react-in-jsx-scope": "off",
       "prettier/prettier": [
@@ -152,7 +170,8 @@
   },
   "eslintIgnore": [
     "node_modules/",
-    "lib/"
+    "lib/",
+    "example/"
   ],
   "prettier": {
     "quoteProps": "consistent",
@@ -180,8 +199,7 @@
       [
         "typescript",
         {
-          "project": "tsconfig.build.json",
-          "esm": true
+          "project": "tsconfig.build.json"
         }
       ]
     ]
@@ -190,5 +208,13 @@
     "type": "module-legacy",
     "languages": "kotlin-swift",
     "version": "0.42.0"
+  },
+  "codegenConfig": {
+    "name": "NativeTextReaderSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "android": {
+      "javaPackageName": "com.textreader"
+    }
   }
-}
+}

package/react-native.config.json

@@ -0,0 +1 @@
+{}

package/src/NativeTextReader.ts

@@ -0,0 +1,41 @@
+import type { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+
+export type NativeOptions = {
+  visionIgnoreThreshold?: number;
+  confidenceThreshold?: number;
+  script?: string;
+  recognitionLevel?: 'fast' | 'accurate';
+  recognitionLanguages?: string[];
+  customWords?: string[];
+  useLanguageCorrection?: boolean;
+  minimumTextHeight?: number;
+};
+
+export type NativeTextLine = {
+  text: string;
+  confidence?: number;
+  frame?: {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+  };
+  recognizedLanguages?: string[];
+};
+
+export type NativeDetailedResult = {
+  fullText: string;
+  lines: string[];
+  details: NativeTextLine[];
+};
+
+export interface Spec extends TurboModule {
+  read(imagePath: string, options?: NativeOptions): Promise<string[]>;
+  readDetailed(
+    imagePath: string,
+    options?: NativeOptions
+  ): Promise<NativeDetailedResult>;
+}
+
+export default TurboModuleRegistry.get<Spec>('TextReader');

package/src/index.tsx

@@ -1,13 +1,16 @@
 import { NativeModules, Platform } from 'react-native';
+import NativeTextReaderModule from './NativeTextReader';
 
 const LINKING_ERROR =
   `The package 'react-native-text-reader' doesn't seem to be linked. Make sure: \n\n` +
   Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
   '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
+  '- You are not using Expo Go (use a development build instead)\n';
 
-const TextReader = NativeModules.TextReader
-  ? NativeModules.TextReader
+const TextReaderModule = NativeTextReaderModule ?? NativeModules.TextReader;
+
+const TextReader = TextReaderModule
+  ? TextReaderModule
   : new Proxy(
       {},
       {
@@ -25,30 +28,81 @@ export enum ScriptOptions {
   KOREAN = 'Korean',
 }
 
-// Options
+export type RecognitionLevel = 'fast' | 'accurate';
+
+export type TextFrame = {
+  top: number;
+  left: number;
+  width: number;
+  height: number;
+};
+
+export type TextLine = {
+  text: string;
+  confidence?: number;
+  frame?: TextFrame;
+  recognizedLanguages?: string[];
+};
+
+export type DetailedResult = {
+  fullText: string;
+  lines: string[];
+  details: TextLine[];
+};
+
 export type Options = {
-  visionIgnoreThreshold?: number; // only iOS
-  script?: ScriptOptions; // only Android
+  visionIgnoreThreshold?: number;
+  confidenceThreshold?: number;
+  script?: ScriptOptions;
+  recognitionLevel?: RecognitionLevel;
+  recognitionLanguages?: string[];
+  customWords?: string[];
+  useLanguageCorrection?: boolean;
+  minimumTextHeight?: number;
 };
 
-type TextReaderType = {
+type TextReaderNative = {
   read(imagePath: string, options?: Options): Promise<string[]>;
+  readDetailed(imagePath: string, options?: Options): Promise<DetailedResult>;
 };
 
+const DEFAULT_OPTIONS: Options = {
+  script: ScriptOptions.LATIN,
+};
+
+function normalizeDetailedResult(result: DetailedResult): DetailedResult {
+  return {
+    fullText: result.fullText ?? '',
+    lines: result.lines ?? [],
+    details: (result.details ?? []).map((detail) => ({
+      text: detail.text,
+      confidence: detail.confidence,
+      frame: detail.frame,
+      recognizedLanguages: detail.recognizedLanguages,
+    })),
+  };
+}
+
+/**
+ * Extracts text lines from an image.
+ */
+async function read(imagePath: string, options?: Options): Promise<string[]> {
+  const detailed = await readDetailed(imagePath, options);
+  return detailed.lines;
+}
+
 /**
- * Extracts text from an image.
- * @param imagePath - Image path
- * @param options - Additional options
- * @param options.visionIgnoreThreshold - Vision ignore threshold(iOS)
- * @param options.script - Language script (Android)
+ * Extracts text with confidence, bounding boxes, and language metadata.
  */
-async function read(imagePath: string, options: Options): Promise<string[]> {
-  return await TextReader.read(
+async function readDetailed(
+  imagePath: string,
+  options?: Options
+): Promise<DetailedResult> {
+  const result = await TextReader.readDetailed(
     imagePath,
-    options || {
-      script: ScriptOptions.LATIN,
-    }
+    options ?? DEFAULT_OPTIONS
   );
+  return normalizeDetailedResult(result);
 }
 
-export default { read } as TextReaderType;
+export default { read, readDetailed } as TextReaderNative;