react-native-text-reader 0.5.0 → 1.2.0

package/README.md

@@ -1,33 +1,117 @@
-# react-native-text-reader
+# `react-native-text-reader`
 
-A React Native library for OCR (Optical Character Recognition) using Vision Framework on iOS and Firebase ML Kit on Android.
+A simple React Native library for extracting text from images using native iOS (Vision Framework) and Android (ML Kit) capabilities.
+
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Platform Setup](#platform-setup)
+  - [iOS](#ios)
+  - [Android](#android)
+- [Usage](#usage)
+  - [Basic Example](#basic-example)
+- [Options](#options)
+- [ScriptOptions Enum](#scriptoptions-enum)
+- [Contributing](#contributing)
+- [License](#license)
+
+### NOTE:
+ I currently do not work extensively with React Native, so this project may not receive frequent updates. However, if anyone is interested in contributing, please feel free to reach out!
 
 ## Installation
 
-```sh
+Install the package using npm or yarn:
+
+```bash
 npm install react-native-text-reader
 ```
 
+or
+
+```bash
+yarn add react-native-text-reader
+```
+
+After installing the package, make sure to link the native dependencies:
+
+### iOS
+
+If you're using iOS, run the following command to install the necessary native modules:
+
+```bash
+cd ios/ && pod install
+```
+
+### Android
+
+No additional steps are required for Android.
+
+---
+
 ## Usage
 
+To use the text reader, import it and call the `read` method with the image path and options.
+
+### Basic Example
 
-```js
-import { read } from 'react-native-text-reader';
+```javascript
+import TextReader, { ScriptOptions } from 'react-native-text-reader';
 
-// ...
+const imagePath = 'path/to/your/image.jpg';
+const options = {
+  visionIgnoreThreshold: 0.5, // iOS only
+  script: ScriptOptions.LATIN, // Android only
+};
+
+const readTextFromImage = async () => {
+  try {
+    const text = await TextReader.read(imagePath, options);
+    console.log('Extracted text:', text);
+  } catch (error) {
+    console.error('Error reading text:', error);
+  }
+};
+
+readTextFromImage();
 
-const result = await read('imageUri');
 ```
 
+---
 
-## Contributing
+## Options
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+### `Options`
 
-## License
+| Property                  | Type              | Description                                          |
+|--------------------------|-------------------|------------------------------------------------------|
+| `visionIgnoreThreshold`  | `number`          | The confidence threshold for iOS (default: 0.0)     |
+| `script`                 | `ScriptOptions`   | The language script for Android (default: `LATIN`)  |
 
-MIT
+---
+
+## ScriptOptions
+
+The `ScriptOptions` enum allows you to specify different language scripts for Android:
+
+```javascript
+export enum ScriptOptions {
+  LATIN = 'Latin',
+  CHINESE = 'Chinese',
+  DEVANAGARI = 'Devanagari',
+  JAPANESE = 'Japanese',
+  KOREAN = 'Korean',
+}
+```
+
+---
+
+## Contributing
+
+Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bugs.
 
 ---
 
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/ios/TextReader.swift

@@ -10,47 +10,63 @@ extension String {
 @objc(TextReader)
 class TextReader: NSObject {
   @objc static func requiresMainQueueSetup() -> Bool { return true }
+
   @objc(read:withOptions:withResolver:withRejecter:)
-  func read(imgPath: String, options: [String: Float], resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
-    guard !imgPath.isEmpty else { reject("ERR", "Image path cannot be empty.", nil); return }
+  func read(imgPath: String, options: [String: Any], resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    guard !imgPath.isEmpty else {
+      reject("ERR_EMPTY_PATH", "Image path cannot be empty.", nil)
+      return
+    }
 
     let formattedImgPath = imgPath.stripPrefix("file://")
-    var threshold: Float = 0.0
-
-    if !(options["visionIgnoreThreshold"]?.isZero ?? true) {
-      threshold = options["visionIgnoreThreshold"] ?? 0.0
-    }
+    let threshold = (options["visionIgnoreThreshold"] as? NSNumber)?.floatValue ?? 0.0
 
     do {
       let imgData = try Data(contentsOf: URL(fileURLWithPath: formattedImgPath))
-      let image = UIImage(data: imgData)
-
-      guard let cgImage = image?.cgImage else { return }
+      guard let image = UIImage(data: imgData), let cgImage = image.cgImage else {
+        reject("ERR_IMAGE_PROCESSING", "Failed to load image from the provided path.", nil)
+        return
+      }
 
       let requestHandler = VNImageRequestHandler(cgImage: cgImage)
+      let ocrRequest = VNRecognizeTextRequest { request, error in
+        self.handleTextRecognitionResult(request: request, threshold: threshold, error: error, resolve: resolve, reject: reject)
+      }
 
-      let ocrRequest = VNRecognizeTextRequest { (request: VNRequest, error: Error?) in
-        self.textReaderHandler(request: request, threshold: threshold, error: error, resolve: resolve, reject: reject)
+      if #available(iOS 16.0, *) {
+        ocrRequest.automaticallyDetectsLanguage = true
       }
 
       try requestHandler.perform([ocrRequest])
     } catch {
-      print(error)
-      reject("ERR", error.localizedDescription, nil)
+      reject("ERR_IMAGE_LOADING", "Failed to load or process the image: \(error.localizedDescription)", nil)
     }
   }
 
-  func textReaderHandler(request: VNRequest, threshold: Float, error _: Error?, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
-    guard let observations = request.results as? [VNRecognizedTextObservation] else { reject("ERR", "Failed to read the text.", nil); return }
+  private func handleTextRecognitionResult(request: VNRequest, threshold: Float, error: Error?, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    if let error = error {
+      reject("ERR_OCR", "Error in text recognition: \(error.localizedDescription)", nil)
+      return
+    }
+
+    guard let observations = request.results as? [VNRecognizedTextObservation] else {
+      reject("ERR_OCR_RESULTS", "Failed to read text from the image.", nil)
+      return
+    }
 
-    let strings = observations.compactMap { observation -> String? in
-      if observation.topCandidates(1).first?.confidence ?? 0 >= threshold {
-        return observation.topCandidates(1).first?.string
-      } else {
-        return nil
+    if observations.isEmpty {
+      resolve([])
+      return
+    }
+
+    let extractedStrings = observations.compactMap { observation -> String? in
+      guard let topCandidate = observation.topCandidates(1).first else { return nil }
+      if topCandidate.confidence >= threshold {
+        return topCandidate.string
       }
+      return nil
     }
-    
-    resolve(strings)
+
+    resolve(extractedStrings.isEmpty ? [] : extractedStrings)
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-text-reader",
-  "version": "0.5.0",
+  "version": "1.2.0",
   "description": "A React Native library for OCR (Optical Character Recognition) using Vision Framework on iOS and Firebase ML Kit on Android.",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",