feat: add rn-mlkit-ocr

Author: ahmeterenodaci

README.md

@@ -2,36 +2,225 @@
 
 A powerful React Native OCR (Optical Character Recognition) module powered by Google ML Kit. Supports multiple languages and scripts with selective model loading for optimized app size.
 
-## Installation
+## Features
+
+- 🌍 **Multi-language support**: Latin, Chinese, Devanagari, Japanese, and Korean scripts
+- 📦 **Selective model loading**: Include only the languages you need to minimize app size
+- ⚡ **High performance**: Powered by Google ML Kit's on-device text recognition
+- 🔄 **Flexible deployment**: Choose between bundled models (offline) or unbundled models (download on demand)
+- 📱 **Cross-platform**: Works on both iOS and Android
 
+## Requirements
 
-```sh
+- iOS 15.5+
+- Android API 21+
+
+## Installation
+
+```bash
 npm install rn-mlkit-ocr
+# or
+yarn add rn-mlkit-ocr
+```
+
+### iOS Setup
+
+Run pod install:
+
+```bash
+cd ios && pod install
+```
+
+### Android Setup
+
+No additional setup required for Android.
+
+## Configuration
+
+### Selecting OCR Models
+
+By default, all language models are included. To optimize your app size, you can specify which models to include.
+
+#### For Expo Projects
+
+Add the plugin to your `app.json` or `app.config.js`:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "rn-mlkit-ocr",
+        {
+          "ocrModels": ["latin", "chinese"],
+          "ocrUseBundled": true
+        }
+      ]
+    ]
+  }
+}
+```
+
+#### For React Native CLI Projects
+
+##### Android
+
+Add the following to your `android/build.gradle` file inside the `buildscript { ext { ... } }` block:
+
+```gradle
+buildscript {
+    ext {
+        // ... other configurations
+        ocrModels = ["latin", "chinese"]
+        ocrUseBundled = true
+    }
+}
 ```
 
+##### iOS
+
+Add the following to your `ios/Podfile` before the `use_react_native!` call:
+
+```ruby
+# --- RN-MLKIT-OCR CONFIG ---
+$ReactNativeOcrSubspecs = ['Latin', 'Chinese']
+# --- END RN-MLKIT-OCR CONFIG ---
+```
+
+### Configuration Options
+
+- **`ocrModels`**: Array of language models to include
+  - Available options: `'latin'`, `'chinese'`, `'devanagari'`, `'japanese'`, `'korean'`, or `'all'`
+  - Default: `['all']`
+- **`ocrUseBundled`** (Android only): Whether to use bundled models
+  - `true`: Models are bundled with the app (larger app size, works offline immediately)
+  - `false`: Models are downloaded on first use (smaller app size, requires internet on first use)
+  - Default: `false`
 
 ## Usage
 
+### Basic Text Recognition
+
+```typescript
+import { recognizeText } from 'rn-mlkit-ocr';
+
+const imageUri = 'file:///path/to/image.jpg'; // or 'https://...'
+
+try {
+  const result = await recognizeText(imageUri);
+  console.log('Recognized text:', result.text);
+
+  // Access detailed information
+  result.blocks.forEach((block) => {
+    console.log('Block:', block.text);
+    block.lines.forEach((line) => {
+      console.log('  Line:', line.text);
+      line.elements.forEach((element) => {
+        console.log('    Element:', element.text);
+      });
+    });
+  });
+} catch (error) {
+  console.error('OCR Error:', error);
+}
+```
+
+### Using Specific Language Models
 
-```js
-import { multiply } from 'rn-mlkit-ocr';
+```typescript
+import { recognizeText } from 'rn-mlkit-ocr';
 
-// ...
+// Recognize Chinese text
+const result = await recognizeText(imageUri, 'chinese');
 
-const result = multiply(3, 7);
+// Recognize Japanese text
+const result = await recognizeText(imageUri, 'japanese');
 ```
 
+### Getting Available Languages
 
-## Contributing
+```typescript
+import { getAvailableLanguages } from 'rn-mlkit-ocr';
+
+const languages = await getAvailableLanguages();
+console.log('Available languages:', languages);
+// Output: ['latin', 'chinese']
+```
+
+## API Reference
+
+### `recognizeText(imageUri: string, detectorType?: DetectorType): Promise<OcrResult>`
+
+Performs OCR on the specified image.
+
+**Parameters:**
+
+- `imageUri`: Path to the image (file path, content URI, or HTTP/HTTPS URL)
+- `detectorType`: Optional language detector type (`'latin'`, `'chinese'`, `'devanagari'`, `'japanese'`, `'korean'`). Defaults to `'latin'`
+
+**Returns:** Promise resolving to `OcrResult`
+
+### `getAvailableLanguages(): Promise<DetectorType[]>`
+
+Returns the list of language models available in the app based on your configuration.
+
+**Returns:** Promise resolving to array of detector types
 
-- [Development workflow](CONTRIBUTING.md#development-workflow)
-- [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
-- [Code of conduct](CODE_OF_CONDUCT.md)
+### Types
 
-## License
+```typescript
+interface OcrResult {
+  text: string; // Full recognized text
+  blocks: OcrBlock[]; // Text blocks
+}
 
-MIT
+interface OcrBlock {
+  text: string;
+  frame: OcrFrame;
+  lines: OcrLine[];
+}
 
----
+interface OcrLine {
+  text: string;
+  frame: OcrFrame;
+  elements: OcrElement[];
+}
+
+interface OcrElement {
+  text: string;
+  frame: OcrFrame;
+}
+
+interface OcrFrame {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+}
+
+type DetectorType = 'latin' | 'chinese' | 'devanagari' | 'japanese' | 'korean';
+```
+
+## Supported Languages & Scripts
+
+For a complete list of supported languages, see [Google ML Kit Text Recognition Languages](https://developers.google.com/ml-kit/vision/text-recognition/v2/languages).
+
+## Example App
+
+Check out the example app in the `example/` directory for a complete working implementation.
+
+```bash
+cd example
+yarn install
+
+# For iOS
+cd ios && pod install && cd ..
+yarn ios
+
+# For Android
+yarn android
+```
+
+## Contributing
 
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+Contributions are welcome! Please feel free to submit a Pull Request.

RnMlkitOcr.podspec

@@ -2,6 +2,9 @@ require "json"
 
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
 
+selected_subspecs = defined?($ReactNativeOcrSubspecs) ? $ReactNativeOcrSubspecs : ['Latin', 'Chinese', 'Devanagari', 'Japanese', 'Korean']
+
+
 Pod::Spec.new do |s|
   s.name         = "RnMlkitOcr"
   s.version      = package["version"]
@@ -10,11 +13,26 @@ Pod::Spec.new do |s|
   s.license      = package["license"]
   s.authors      = package["author"]
 
-  s.platforms    = { :ios => min_ios_version_supported }
+  s.platforms    = { :ios => "15.5" }
   s.source       = { :git => "https://github.com/ahmeterenodaci/rn-mlkit-ocr.git", :tag => "#{s.version}" }
 
   s.source_files = "ios/**/*.{h,m,mm,swift,cpp}"
-  s.private_header_files = "ios/**/*.h"
 
-  install_modules_dependencies(s)
+  s.dependency "React-Core"
+
+  if selected_subspecs.include?('Latin')
+    s.dependency 'GoogleMLKit/TextRecognition', '3.2.0'
+  end
+  if selected_subspecs.include?('Chinese')
+    s.dependency 'GoogleMLKit/TextRecognitionChinese', '3.2.0'
+  end
+  if selected_subspecs.include?('Devanagari')
+    s.dependency 'GoogleMLKit/TextRecognitionDevanagari', '3.2.0'
+  end
+  if selected_subspecs.include?('Japanese')
+    s.dependency 'GoogleMLKit/TextRecognitionJapanese', '3.2.0'
+  end
+  if selected_subspecs.include?('Korean')
+    s.dependency 'GoogleMLKit/TextRecognitionKorean', '3.2.0'
+  end
 end

android/build.gradle

@@ -24,6 +24,9 @@ apply plugin: "com.facebook.react"
 def getExtOrIntegerDefault(name) {
   return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["RnMlkitOcr_" + name]).toInteger()
 }
+def safeGetExt(name, fallback) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : fallback
+}
 
 android {
   namespace "com.rnmlkitocr"
@@ -33,6 +36,14 @@ android {
   defaultConfig {
     minSdkVersion getExtOrIntegerDefault("minSdkVersion")
     targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+
+    def ocrModels = safeGetExt('ocrModels', ['all'])
+    def hasAllModels = ocrModels.contains('all')
+    buildConfigField "boolean", "HAS_LATIN", "${hasAllModels || ocrModels.contains('latin')}"
+    buildConfigField "boolean", "HAS_CHINESE", "${hasAllModels || ocrModels.contains('chinese')}"
+    buildConfigField "boolean", "HAS_DEVANAGARI", "${hasAllModels || ocrModels.contains('devanagari')}"
+    buildConfigField "boolean", "HAS_JAPANESE", "${hasAllModels || ocrModels.contains('japanese')}"
+    buildConfigField "boolean", "HAS_KOREAN", "${hasAllModels || ocrModels.contains('korean')}"
   }
 
   buildFeatures {
@@ -74,4 +85,53 @@ def kotlin_version = getExtOrDefault("kotlinVersion")
 dependencies {
   implementation "com.facebook.react:react-android"
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+
+  def ocrModels = safeGetExt('ocrModels', ['all'])
+  def hasAllModels = ocrModels.contains('all')
+  def isBundled = safeGetExt('ocrUseBundled', false)
+
+  // Latin
+  if (hasAllModels || ocrModels.contains('latin')) {
+    if (isBundled) {
+      implementation 'com.google.mlkit:text-recognition:16.0.1'
+    } else {
+      implementation 'com.google.android.gms:play-services-mlkit-text-recognition:19.0.1'
+    }
+  }
+
+  // Chinese
+  if (hasAllModels || ocrModels.contains('chinese')) {
+    if (isBundled) {
+      implementation 'com.google.mlkit:text-recognition-chinese:16.0.1'
+    } else {
+      implementation 'com.google.android.gms:play-services-mlkit-text-recognition-chinese:16.0.1'
+    }
+  }
+
+  // Devanagari
+  if (hasAllModels || ocrModels.contains('devanagari')) {
+    if (isBundled) {
+      implementation 'com.google.mlkit:text-recognition-devanagari:16.0.1'
+    } else {
+      implementation 'com.google.android.gms:play-services-mlkit-text-recognition-devanagari:16.0.1'
+    }
+  }
+
+  // Japanese
+  if (hasAllModels || ocrModels.contains('japanese')) {
+    if (isBundled) {
+      implementation 'com.google.mlkit:text-recognition-japanese:16.0.1'
+    } else {
+      implementation 'com.google.android.gms:play-services-mlkit-text-recognition-japanese:16.0.1'
+    }
+  }
+
+  // Korean
+  if (hasAllModels || ocrModels.contains('korean')) {
+    if (isBundled) {
+      implementation 'com.google.mlkit:text-recognition-korean:16.0.1'
+    } else {
+      implementation 'com.google.android.gms:play-services-mlkit-text-recognition-korean:16.0.1'
+    }
+  }
 }