@dariyd/react-native-document-scanner 2.0.13

package/CHANGELOG.md

@@ -0,0 +1,170 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2025-10-19
+
+### 🎉 Major Release - Android Support & New Architecture
+
+This is a major release that adds Android support and React Native new architecture (Fabric/TurboModules) compatibility while maintaining full backward compatibility with version 1.x.
+
+### Added
+
+#### Platform Support
+- ✅ **Android support** using Google ML Kit Document Scanner API
+  - Minimum Android API level 21 (Android 5.0)
+  - Automatic document detection and edge detection
+  - Multi-page scanning support
+  - Automatic perspective correction
+  - Same API as iOS for cross-platform consistency
+
+#### Architecture Support
+- ✅ **React Native new architecture support** (Fabric/TurboModules)
+  - Works with React Native 0.71+ new architecture
+  - Backward compatible with old architecture
+  - Automatic detection and adaptation
+  - iOS: TurboModule with codegen
+  - Android: TurboReactPackage with new architecture flag
+
+#### Developer Experience
+- ✅ **TypeScript definitions** (`index.d.ts`)
+  - Full type safety for all APIs
+  - IntelliSense support in VS Code and other IDEs
+  - Comprehensive JSDoc comments
+
+#### Documentation
+- ✅ **Comprehensive README updates**
+  - Cross-platform installation instructions
+  - Platform differences documentation
+  - New architecture setup guide
+  - Troubleshooting section
+  - Usage examples for both platforms
+
+- ✅ **Migration guide** (`MIGRATION.md`)
+  - Detailed upgrade instructions from 1.x to 2.0
+  - Platform-specific setup steps
+  - Common issues and solutions
+  - Testing checklist
+
+- ✅ **Android implementation docs**
+  - ML Kit integration details
+  - Requirements and dependencies
+  - Publishing instructions
+
+### Changed
+
+#### iOS
+- Updated podspec to support both old and new architecture
+- Added conditional compilation for new architecture (`RCT_NEW_ARCH_ENABLED`)
+- Improved module implementation with better architecture detection
+
+#### Android
+- Implemented full document scanning functionality using ML Kit
+- Added activity result handling for scan results
+- Implemented image processing with quality and base64 options
+- Added BuildConfig flag for architecture detection
+
+#### JavaScript
+- Enhanced module loading with fallback mechanism
+- Better error handling for missing modules
+- Improved Promise/callback dual support
+
+#### Build Configuration
+- Updated Android SDK versions (compileSdkVersion 33, minSdkVersion 21)
+- Added ML Kit dependency (`play-services-mlkit-document-scanner:16.0.0-beta1`)
+- Added codegen configuration for new architecture
+- Updated package.json with new metadata and keywords
+
+#### Example Project
+- Updated Android manifest with camera permission
+- Verified iOS Info.plist has camera permission
+- Example app works on both platforms
+
+### Technical Details
+
+#### New Files
+- `src/NativeDocumentScanner.ts` - Codegen spec for new architecture
+- `index.d.ts` - TypeScript definitions
+- `MIGRATION.md` - Migration guide
+- `CHANGELOG.md` - This file
+
+#### Modified Files
+- `index.js` - Enhanced module loading for both architectures
+- `package.json` - Updated version, description, and configuration
+- `ios/DocumentScanner.h` - Added new architecture support
+- `ios/DocumentScanner.m` - Added TurboModule implementation
+- `react-native-document-scanner.podspec` - New architecture dependencies
+- `android/build.gradle` - Updated dependencies and SDK versions
+- `android/src/main/java/com/reactlibrary/DocumentScannerModule.java` - Complete ML Kit implementation
+- `android/src/main/java/com/reactlibrary/DocumentScannerPackage.java` - TurboReactPackage support
+- `README.md` - Comprehensive documentation updates
+- `android/README.md` - Android-specific documentation
+
+### Dependencies
+
+#### React Native
+- **Minimum version: 0.78.0** (required for stable new architecture support)
+- React 18.2.0+
+
+#### iOS
+- VisionKit (iOS 13.0+)
+- React Native new architecture dependencies (optional, for new arch):
+  - React-Codegen
+  - RCT-Folly
+  - ReactCommon/turbomodule/core
+
+#### Android
+- Google ML Kit Document Scanner: `16.0.0-beta1`
+- AndroidX libraries (included with React Native)
+- Google Play Services (required on device)
+- Target SDK: API level 35 (Android 15) - Google Play Store requirement
+- Minimum SDK: API level 21 (Android 5.0)
+
+### Platform Parity
+
+The following features are now available on both platforms with identical APIs:
+
+| Feature | iOS | Android |
+|---------|-----|---------|
+| Document scanning | ✅ | ✅ |
+| Multi-page scanning | ✅ | ✅ |
+| Image quality control | ✅ | ✅ |
+| Base64 encoding | ✅ | ✅ |
+| Cancel handling | ✅ | ✅ |
+| Error handling | ✅ | ✅ |
+| Old architecture | ✅ | ✅ |
+| New architecture | ✅ | ✅ |
+
+### Backward Compatibility
+
+✅ **Fully backward compatible** - No breaking changes from 1.x. All existing code will continue to work without modifications.
+
+### Known Limitations
+
+- Android requires Google Play Services (not available on some devices/emulators)
+- ML Kit Document Scanner is in beta on Android
+- Android always outputs JPEG format (iOS can output PNG when quality=1.0)
+
+### Upgrade Instructions
+
+See [MIGRATION.md](./MIGRATION.md) for detailed upgrade instructions.
+
+---
+
+## [1.0.1] - Previous Version
+
+### Features
+- iOS-only implementation
+- VisionKit document scanning
+- Multi-page scanning
+- Image quality control
+- Base64 encoding option
+
+---
+
+[2.0.0]: https://github.com/dariyd/react-native-document-scanner/compare/v1.0.1...v2.0.0
+[1.0.1]: https://github.com/dariyd/react-native-document-scanner/releases/tag/v1.0.1
+

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,224 @@
+# react-native-document-scanner
+
+A React Native document scanner module for iOS and Android. Supports the new React Native architecture (Fabric/TurboModules) on iOS.
+
+- **iOS**: Uses VisionKit framework and VNDocumentCameraViewController
+- **Android**: Uses ML Kit Document Scanner API
+
+## Preview
+### iOS
+![iOS Scanner](./assets/ios_demo.gif)
+
+### Android
+![Android Scanner](./assets/android_demo.gif)
+
+
+## Features
+
+- 📱 Cross-platform support (iOS 13+ and Android API 21+)
+- 🚀 iOS: Full support for new React Native architecture (Fabric/TurboModules)
+- 📸 Automatic document detection and scanning
+- 🖼️ Multi-page document scanning
+- ⚙️ Configurable image quality
+- 📦 Optional base64 encoding
+- 🎯 Platform parity - same API for both platforms
+
+## Installation
+
+### From npm (Recommended)
+
+```bash
+npm install @dariyd/react-native-document-scanner
+```
+
+or with yarn:
+
+```bash
+yarn add @dariyd/react-native-document-scanner
+```
+
+### From GitHub (Latest Development)
+
+```bash
+npm install https://github.com/dariyd/react-native-document-scanner.git
+```
+
+or
+
+```bash
+yarn add https://github.com/dariyd/react-native-document-scanner.git
+```
+
+### iOS Installation
+
+```bash
+cd ios && pod install
+```
+
+### Android Installation
+
+No additional steps required. The ML Kit dependency will be automatically included.
+
+## Post-install Steps
+
+### iOS
+
+Add the `NSCameraUsageDescription` key to your `Info.plist`:
+
+```xml
+<key>NSCameraUsageDescription</key>
+<string>We need access to your camera to scan documents</string>
+```
+
+### Android
+
+Add camera permission to your `AndroidManifest.xml`:
+
+```xml
+<uses-permission android:name="android.permission.CAMERA" />
+```
+
+The module automatically requests camera permission when launching the scanner.
+
+## React Native New Architecture
+
+This module requires **React Native 0.77.3 or higher** and supports the new architecture on iOS, while using the stable old architecture on Android.
+
+**iOS**: Full support for Fabric and TurboModules - automatically detected and enabled when you enable new architecture in your project.
+
+**Android**: Uses the stable bridge implementation for maximum compatibility. New architecture support is planned for a future release.
+
+### Requirements
+
+- **React Native 0.77.3 or higher**
+- **React 18.2.0 or higher**
+- iOS 13.0 or higher
+- **Android**:
+  - Minimum SDK: API 21 (Android 5.0)
+  - Target SDK: API 35 (Android 15) - required by Google Play Store
+  - Compile SDK: API 35
+
+### Enabling New Architecture
+
+**✅ iOS**: Fully supported - Set `RCT_NEW_ARCH_ENABLED=1` in your Podfile or build settings
+
+**⚠️ Android**: Currently uses old architecture only. New architecture support for Android is coming in a future release.
+  - The module is implemented as a Java-only TurboModule on Android, which requires additional C++ bridging setup
+  - Keep `newArchEnabled=false` in your `gradle.properties` for now
+  - The module works perfectly with the old architecture on Android
+
+The iOS implementation will automatically use Fabric/TurboModules when enabled, while Android will continue to use the stable bridge implementation.
+
+
+## Usage
+
+```javascript
+import { launchScanner } from 'react-native-document-scanner';
+
+// Basic usage
+const result = await launchScanner();
+
+// With options
+const result = await launchScanner({
+  quality: 0.8,
+  includeBase64: false,
+});
+
+// With callback (optional)
+launchScanner({ quality: 0.9 }, (result) => {
+  if (result.didCancel) {
+    console.log('User cancelled');
+  } else if (result.error) {
+    console.log('Error:', result.errorMessage);
+  } else {
+    console.log('Scanned images:', result.images);
+  }
+});
+```
+# API Reference
+
+## Methods
+
+```js
+import {launchScanner} from 'react-native-document-scanner';
+```
+
+### `launchScanner()`
+
+Launch scanner to scan documents.
+
+See [Options](#options) for further information on `options`.
+
+The `callback` will be called with a response object, refer to [The Response Object](#the-response-object).
+
+
+## Options
+
+| Option         | iOS | Android | Description                                                                                                                               |
+| -------------- | --- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| quality        | ✅  | ✅      | Number between 0 and 1 for image quality (default: 1). Lower values reduce file size                                                      |
+| includeBase64  | ✅  | ✅      | If true, creates base64 string of the image (Avoid using on large image files due to performance)                                         |                                                   |
+
+## The Response Object
+
+| key          | iOS | Android | Description                                                         |
+| ------------ | --- | ------- | ------------------------------------------------------------------- |
+| didCancel    | ✅  | ✅      | `true` if the user cancelled the process                            |
+| error        | ✅  | ✅      | `true` if error happens                                             |
+| errorMessage | ✅  | ✅      | Description of the error, use it for debug purpose only             |
+| images       | ✅  | ✅      | Array of the selected media, [refer to Image Object](#image-object) |
+
+## Image Object
+
+| key       | iOS | Android | Description                                        |
+| --------- | --- | ------- | -------------------------------------------------- |
+| base64    | ✅  | ✅      | The base64 string of the image (if includeBase64 is true) |
+| uri       | ✅  | ✅      | The file uri in app specific cache storage         |
+| width     | ✅  | ✅      | Image width in pixels                              |
+| height    | ✅  | ✅      | Image height in pixels                             |
+| fileSize  | ✅  | ✅      | The file size in bytes                             |
+| type      | ✅  | ✅      | The file MIME type (e.g., "image/jpeg")            |
+| fileName  | ✅  | ✅      | The file name                                      |
+
+## Platform Differences
+
+While both platforms provide similar functionality, there are some minor differences:
+
+### iOS
+- Uses native VisionKit framework
+- Requires iOS 13.0 or higher
+- Supports PNG format for quality = 1.0, JPEG for quality < 1.0
+
+### Android
+- Uses Google ML Kit Document Scanner
+- Minimum SDK: API level 21 (Android 5.0)
+- Target SDK: API level 35 (Android 15) - Google Play Store requirement
+- Always outputs JPEG format
+- Requires Google Play Services
+
+## Troubleshooting
+
+### Android: ML Kit not available
+
+If you encounter issues with ML Kit on Android, ensure that:
+1. Google Play Services is installed on the device/emulator
+2. Your `compileSdkVersion` is 35 or higher
+3. Your `targetSdkVersion` is 35 (required by Google Play Store)
+4. Your `minSdkVersion` is 21 or higher
+
+### iOS: Camera permission denied
+
+Ensure you've added the `NSCameraUsageDescription` key to your `Info.plist`.
+
+## Example
+
+Check the `example/` directory for a complete example app demonstrating the scanner.
+
+## Inspired By
+
+- iOS implementation: [react-native-image-picker](https://github.com/react-native-image-picker/react-native-image-picker)
+- Android ML Kit: [Google ML Kit Document Scanner](https://developers.google.com/ml-kit/vision/doc-scanner)
+
+## License
+
+MIT

package/android/README.md

@@ -0,0 +1,43 @@
+# Android Implementation
+
+This is the Android implementation of react-native-document-scanner using Google ML Kit Document Scanner API.
+
+## Features
+
+- Uses Google ML Kit Document Scanner API
+- Automatic document detection and edge detection
+- Multi-page scanning support
+- Automatic perspective correction
+- Image quality and compression options
+- Support for both old and new React Native architecture
+
+## Requirements
+
+- **Minimum SDK**: Android API level 21 (Android 5.0)
+- **Target SDK**: Android API level 35 (Android 15) - required by Google Play Store
+- **Compile SDK**: Android API level 35
+- Google Play Services
+- Camera permission
+
+## Implementation Details
+
+The module uses:
+- `com.google.android.gms:play-services-mlkit-document-scanner` for document scanning
+- React Native bridge for old architecture
+- TurboModule support for new architecture
+
+## Publishing
+
+If you want to publish the lib as a maven dependency, follow these steps before publishing a new version to npm:
+
+1. Be sure to have the Android [SDK](https://developer.android.com/studio/index.html) and [NDK](https://developer.android.com/ndk/guides/index.html) installed
+2. Be sure to have a `local.properties` file in this folder that points to the Android SDK and NDK
+```
+ndk.dir=/Users/{username}/Library/Android/sdk/ndk-bundle
+sdk.dir=/Users/{username}/Library/Android/sdk
+```
+3. Delete the `maven` folder
+4. Run `./gradlew publishToMavenLocal` or `./gradlew publish`
+5. Verify that latest set of generated files is in the maven folder with the correct version number
+
+**Note**: The library now uses the modern `maven-publish` plugin (compatible with Gradle 8+) instead of the deprecated `maven` plugin.