expo-ocr-kit 0.1.0

package/README.md

@@ -0,0 +1,143 @@
+# Expo OCR Kit
+
+On-device text recognition for Expo and React Native.
+
+`expo-ocr-kit` is a native OCR module built with the Expo Modules API. It uses ML Kit on Android and Vision on iOS, and exposes a single typed API for both platforms.
+
+## Demo
+
+<p align="center">
+  <img src="./assets/demo.gif" alt="Expo OCR Kit demo" width="320" />
+</p>
+
+## Why this package
+
+- Built with the Expo Modules API
+- Works in Expo development builds, prebuild workflows, EAS Build, and bare React Native
+- Uses platform OCR engines directly instead of a generic wrapper
+- Returns normalized cross-platform bounding boxes
+- Includes a minimal Expo config plugin for camera permission setup
+- Downsamples large images before OCR to reduce memory pressure
+
+## Installation
+
+```bash
+npm install expo-ocr-kit
+```
+
+## Usage
+
+```ts
+import { recognizeText, type OcrResult } from 'expo-ocr-kit';
+
+const result: OcrResult = await recognizeText(uri);
+```
+
+`uri` should be a local image URI.
+
+## API
+
+```ts
+type OcrBoundingBox = {
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+};
+
+type OcrBlock = {
+  text: string;
+  boundingBox: OcrBoundingBox;
+};
+
+type OcrResult = {
+  text: string;
+  blocks: OcrBlock[];
+};
+```
+
+Bounding boxes are returned in image-space coordinates with a top-left origin on both platforms.
+
+## Expo support
+
+This package contains native code.
+
+- Supported: Expo development builds
+- Supported: `expo prebuild`
+- Supported: EAS Build
+- Supported: bare React Native
+- Not supported: Expo Go
+
+Typical Expo workflow:
+
+```bash
+npx expo prebuild
+npx expo run:android
+npx expo run:ios
+```
+
+## Camera support
+
+The OCR API is image-based. Camera capture should stay in your app layer or use a helper package such as `expo-image-picker`.
+
+If your Expo app captures images with the camera, add the bundled config plugin:
+
+```json
+{
+  "expo": {
+    "plugins": [
+      [
+        "expo-ocr-kit",
+        {
+          "cameraPermission": "Allow this app to capture images for OCR."
+        }
+      ]
+    ]
+  }
+}
+```
+
+The plugin adds:
+
+- iOS: `NSCameraUsageDescription`
+- Android: `android.permission.CAMERA`
+
+Runtime permission requests are still your responsibility.
+
+## What makes it different
+
+Most OCR packages in this space fall into one of three buckets:
+
+- older React Native wrappers with dated native integrations
+- platform-specific text recognition packages
+- Vision Camera frame-processor plugins focused on real-time OCR
+
+`expo-ocr-kit` is aimed at a different use case:
+
+- Expo-first native module architecture
+- batch OCR on local images
+- clean JS API for both Expo and bare React Native apps
+- native implementation details kept behind a small, typed surface
+
+If you need real-time OCR from camera frames, a Vision Camera plugin is the right tool. If you need a production-friendly OCR module for captured images, scanned documents, screenshots, and imported files, this package is the better fit.
+
+## Implementation notes
+
+- Android uses ML Kit with URI loading, EXIF-aware rotation handling, and image downsampling.
+- iOS uses Vision with `CGImageSource` thumbnail decoding and coordinate normalization.
+- Large images are processed on reduced-size native buffers, but bounding boxes are scaled back to the original image space before they are returned.
+
+## Design direction
+
+The core API stays intentionally generic:
+
+```ts
+recognizeText(uri: string): Promise<OcrResult>
+```
+
+Receipt parsing, invoice extraction, field detection, and domain-specific post-processing belong above OCR rather than inside the low-level recognition API.
+
+## Notes for contributors
+
+- Native iOS builds can be sensitive to filesystem paths with spaces. A path without spaces is recommended when working on the example app locally.
+- If you change native Kotlin or Swift code, rebuild the app. Metro reload is only enough for JavaScript changes.

package/android/build/.transforms/0ccd80621f9d41140b150fb1d1a89374/results.bin

@@ -0,0 +1 @@
+o/classes

package/android/build/.transforms/e1d05a683f9f90125c897565d1f6e5cb/results.bin

@@ -0,0 +1 @@
+o/bundleLibRuntimeToDirDebug

package/android/build/generated/source/buildConfig/debug/expo/modules/ocrkit/BuildConfig.java

@@ -0,0 +1,10 @@
+/**
+ * Automatically generated file. DO NOT MODIFY
+ */
+package expo.modules.ocrkit;
+
+public final class BuildConfig {
+  public static final boolean DEBUG = Boolean.parseBoolean("true");
+  public static final String LIBRARY_PACKAGE_NAME = "expo.modules.ocrkit";
+  public static final String BUILD_TYPE = "debug";
+}

package/android/build/intermediates/aapt_friendly_merged_manifests/debug/processDebugManifest/aapt/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="expo.modules.ocrkit" >
+
+    <uses-sdk android:minSdkVersion="24" />
+
+</manifest>

package/android/build/intermediates/aapt_friendly_merged_manifests/debug/processDebugManifest/aapt/output-metadata.json

@@ -0,0 +1,18 @@
+{
+  "version": 3,
+  "artifactType": {
+    "type": "AAPT_FRIENDLY_MERGED_MANIFESTS",
+    "kind": "Directory"
+  },
+  "applicationId": "expo.modules.ocrkit",
+  "variantName": "debug",
+  "elements": [
+    {
+      "type": "SINGLE",
+      "filters": [],
+      "attributes": [],
+      "outputFile": "AndroidManifest.xml"
+    }
+  ],
+  "elementType": "File"
+}

package/android/build/intermediates/aar_metadata/debug/writeDebugAarMetadata/aar-metadata.properties

@@ -0,0 +1,6 @@
+aarFormatVersion=1.0
+aarMetadataVersion=1.0
+minCompileSdk=1
+minCompileSdkExtension=0
+minAndroidGradlePluginVersion=1.0.0
+coreLibraryDesugaringEnabled=false

package/android/build/intermediates/annotation_processor_list/debug/javaPreCompileDebug/annotationProcessors.json

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

package/android/build/intermediates/incremental/debug/packageDebugResources/compile-file-map.properties

@@ -0,0 +1 @@
+#Thu Apr 02 00:21:02 EDT 2026

package/android/build/intermediates/incremental/debug/packageDebugResources/merger.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<merger version="3"><dataSet aapt-namespace="http://schemas.android.com/apk/res-auto" config="main$Generated" generated="true" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/main/res"/></dataSet><dataSet aapt-namespace="http://schemas.android.com/apk/res-auto" config="main" generated-set="main$Generated" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/main/res"/></dataSet><dataSet aapt-namespace="http://schemas.android.com/apk/res-auto" config="debug$Generated" generated="true" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/debug/res"/></dataSet><dataSet aapt-namespace="http://schemas.android.com/apk/res-auto" config="debug" generated-set="debug$Generated" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/debug/res"/></dataSet><dataSet aapt-namespace="http://schemas.android.com/apk/res-auto" config="generated$Generated" generated="true" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/build/generated/res/resValues/debug"/></dataSet><dataSet aapt-namespace="http://schemas.android.com/apk/res-auto" config="generated" generated-set="generated$Generated" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/build/generated/res/resValues/debug"/></dataSet><mergedItems/></merger>

package/android/build/intermediates/incremental/mergeDebugAssets/merger.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<merger version="3"><dataSet config="main" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/main/assets"/></dataSet><dataSet config="debug" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/debug/assets"/></dataSet><dataSet config="generated" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/build/intermediates/shader_assets/debug/compileDebugShaders/out"/></dataSet></merger>

package/android/build/intermediates/incremental/mergeDebugJniLibFolders/merger.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<merger version="3"><dataSet config="main" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/main/jniLibs"/></dataSet><dataSet config="debug" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/debug/jniLibs"/></dataSet></merger>

package/android/build/intermediates/incremental/mergeDebugShaders/merger.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?>
+<merger version="3"><dataSet config="main" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/main/shaders"/></dataSet><dataSet config="debug" ignore_pattern="!.svn:!.git:!.ds_store:!*.scc:.*:&lt;dir>_*:!CVS:!thumbs.db:!picasa.ini:!*~"><source path="/Users/manojkanth/Desktop/Projects/mine/npm packages/Expo-ocr-kit/expo-ocr-kit/android/src/debug/shaders"/></dataSet></merger>

package/android/build/intermediates/local_only_symbol_list/debug/parseDebugLocalResources/R-def.txt

@@ -0,0 +1,2 @@
+R_DEF: Internal format may change without notice
+local

package/android/build/intermediates/manifest_merge_blame_file/debug/processDebugManifest/manifest-merger-blame-debug-report.txt

@@ -0,0 +1,7 @@
+1<?xml version="1.0" encoding="utf-8"?>
+2<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+3    package="expo.modules.ocrkit" >
+4
+5    <uses-sdk android:minSdkVersion="24" />
+6
+7</manifest>

package/android/build/intermediates/merged_manifest/debug/processDebugManifest/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="expo.modules.ocrkit" >
+
+    <uses-sdk android:minSdkVersion="24" />
+
+</manifest>

package/android/build/intermediates/navigation_json/debug/extractDeepLinksDebug/navigation.json

@@ -0,0 +1 @@
+[]

package/android/build/intermediates/nested_resources_validation_report/debug/generateDebugResources/nestedResourcesValidationReport.txt

@@ -0,0 +1 @@
+0 Warning/Error

package/android/build/intermediates/symbol_list_with_package_name/debug/generateDebugRFile/package-aware-r.txt

@@ -0,0 +1 @@
+expo.modules.ocrkit

package/android/build/kotlin/compileDebugKotlin/cacheable/caches-jvm/lookups/counters.tab

@@ -0,0 +1,2 @@
+2
+0