react-native-neuroscan 0.1.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 Dmytro
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Neuroscan.podspec

@@ -0,0 +1,29 @@
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+
+Pod::Spec.new do |s|
+  s.name         = "Neuroscan"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => "16.0" }
+  s.source       = { :git => "https://github.com/dmytro/react-native-neuroscan.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/**/*.{h,m,mm,swift}"
+  s.private_header_files = "ios/**/*.h"
+  s.swift_version = "5.9"
+
+  s.frameworks   = "VisionKit", "UIKit"
+
+  s.pod_target_xcconfig = {
+    "CLANG_CXX_LANGUAGE_STANDARD" => "c++20",
+    "GCC_PREPROCESSOR_DEFINITIONS" => "$(inherited)",
+    "CLANG_ALLOW_NON_MODULAR_INCLUDES_IN_FRAMEWORK_MODULES" => "YES"
+  }
+
+  install_modules_dependencies(s)
+end

package/README.md

@@ -0,0 +1,233 @@
+# react-native-neuroscan
+
+High-performance native document scanner for React Native with automatic edge detection, perspective correction, and advanced image processing. Built as a TurboModule for the New Architecture.
+
+- **iOS** — Apple VisionKit (`VNDocumentCameraViewController`)
+- **Android** — Google ML Kit Document Scanner
+
+## Features
+
+- Native document camera UI with real-time edge detection
+- Automatic perspective correction
+- Multi-page scanning with configurable page limits
+- Gallery import support (Android)
+- Post-processing filters: brightness, contrast, sharpness, rotation, crop
+- Grayscale and black & white document modes with threshold control
+- JPEG / PNG output with adjustable quality
+- Temporary file management with cleanup API
+- Full TypeScript support
+
+## Requirements
+
+| Platform | Minimum Version |
+|----------|----------------|
+| iOS      | 16.0           |
+| Android  | SDK 24 (Android 7.0) |
+| React Native | 0.76+ (New Architecture) |
+
+**Android note:** requires Google Play Services (ML Kit). Devices without GMS (e.g. Huawei) are not currently supported.
+
+## Installation
+
+```sh
+npm install react-native-neuroscan
+# or
+yarn add react-native-neuroscan
+```
+
+### iOS
+
+```sh
+cd ios && pod install
+```
+
+Add camera permission to `Info.plist`:
+
+```xml
+<key>NSCameraUsageDescription</key>
+<string>We need camera access to scan documents</string>
+```
+
+### Android
+
+Camera permission is declared in the library's `AndroidManifest.xml` and will be merged automatically. No additional setup required.
+
+## Usage
+
+### Scan documents
+
+```tsx
+import { NeuroScan } from 'react-native-neuroscan';
+
+async function scan() {
+  try {
+    const result = await NeuroScan.scanDocument({
+      maxPages: 5,
+    });
+
+    console.log(`Scanned ${result.pageCount} pages`);
+    console.log(result.imageUrls); // ['file:///...page1.jpg', ...]
+  } catch (error) {
+    if (error.code === 'SCANNER_CANCELLED') {
+      // User dismissed the scanner
+      return;
+    }
+    console.error(error);
+  }
+}
+```
+
+### Process images
+
+Apply filters to scanned images. Filters are applied in order: **crop > rotate > brightness/contrast > sharpen > grayscale/threshold**.
+
+```tsx
+const processed = await NeuroScan.processImage({
+  imageUrl: result.imageUrls[0],
+  brightness: 10,
+  contrast: 20,
+  sharpness: 50,
+  rotation: 90,
+});
+
+console.log(processed.imageUrl); // 'file:///...processed.jpg'
+```
+
+#### Black & white document mode
+
+```tsx
+const bw = await NeuroScan.processImage({
+  imageUrl: result.imageUrls[0],
+  threshold: 128, // 0-255, converts to pure black & white
+});
+```
+
+#### Crop with normalized coordinates
+
+```tsx
+const cropped = await NeuroScan.processImage({
+  imageUrl: result.imageUrls[0],
+  cropX: 0.1,      // 10% from left
+  cropY: 0.1,      // 10% from top
+  cropWidth: 0.8,   // 80% of width
+  cropHeight: 0.8,  // 80% of height
+});
+```
+
+### Cleanup temporary files
+
+```tsx
+await NeuroScan.cleanupTempFiles();
+```
+
+## API Reference
+
+### `scanDocument(options?)`
+
+Opens the native document scanner UI.
+
+#### Options
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `maxPages` | `number` | `0` | Maximum pages to scan. `0` = unlimited |
+| `enableAutoCapture` | `boolean` | `true` | Enable automatic capture mode |
+
+#### Returns
+
+```typescript
+Promise<{
+  imageUrls: string[];  // Array of file:// URIs (JPEG)
+  pageCount: number;    // Number of scanned pages
+}>
+```
+
+---
+
+### `processImage(options)`
+
+Applies post-processing filters to an image. Returns a new file URI — the original is not modified.
+
+#### Options
+
+| Parameter | Type | Range | Default | Description |
+|-----------|------|-------|---------|-------------|
+| `imageUrl` | `string` | — | **required** | `file://` URI of the source image |
+| `brightness` | `number` | -100 to 100 | `0` | Brightness adjustment |
+| `contrast` | `number` | -100 to 100 | `0` | Contrast adjustment |
+| `sharpness` | `number` | 0 to 100 | `0` | Sharpening intensity |
+| `rotation` | `number` | 0, 90, 180, 270 | `0` | Rotation in degrees |
+| `grayscale` | `boolean` | — | `false` | Convert to grayscale |
+| `threshold` | `number` | 0 to 255 | `0` | B&W threshold (`0` = disabled) |
+| `cropX` | `number` | 0 to 1 | — | Normalized crop X offset |
+| `cropY` | `number` | 0 to 1 | — | Normalized crop Y offset |
+| `cropWidth` | `number` | 0 to 1 | — | Normalized crop width |
+| `cropHeight` | `number` | 0 to 1 | — | Normalized crop height |
+| `outputFormat` | `string` | `"jpeg"`, `"png"` | `"jpeg"` | Output image format |
+| `quality` | `number` | 1 to 100 | `90` | Compression quality |
+
+#### Returns
+
+```typescript
+Promise<{
+  imageUrl: string;  // file:// URI of the processed image
+}>
+```
+
+---
+
+### `cleanupTempFiles()`
+
+Removes all temporary files created by the scanner and image processor.
+
+#### Returns
+
+```typescript
+Promise<boolean>  // true on success
+```
+
+## Error Codes
+
+| Code | Description |
+|------|-------------|
+| `CAMERA_UNAVAILABLE` | Camera or scanner UI is not available on this device |
+| `SCANNER_CANCELLED` | User dismissed the scanner |
+| `SCANNER_FAILED` | Scanner initialization or execution error |
+| `PROCESS_FAILED` | Image processing error |
+| `CLEANUP_FAILED` | Failed to remove temporary files |
+
+## Example
+
+A full working example app is included in the [`example/`](./example) directory. It demonstrates scanning, page gallery, and an image editor with all available filters.
+
+```sh
+# Clone the repo
+git clone https://github.com/nicklvsa/react-native-neuroscan.git
+cd react-native-neuroscan
+
+# Install dependencies
+yarn install
+
+# Run the example
+yarn example ios
+# or
+yarn example android
+```
+
+## How It Works
+
+### iOS
+
+Uses Apple's `VNDocumentCameraViewController` from the VisionKit framework. Edge detection and perspective correction are handled natively by the system. Image processing uses Core Image filters (`CIColorControls`, `CISharpenLuminance`, `CIPhotoEffectMono`, `CIColorThreshold`).
+
+### Android
+
+Uses Google ML Kit Document Scanner API in full scanner mode with gallery import support. Image processing uses Android's `ColorMatrix` for color adjustments and convolution kernels for sharpening. All processing runs on coroutines with the IO dispatcher.
+
+## Contributing
+
+Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for development workflow details.
+
+## License
+
+MIT

package/android/app/build/generated/source/codegen/RCTAppDependencyProvider.h

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+
+#import <Foundation/Foundation.h>
+
+#if __has_include(<React-RCTAppDelegate/RCTDependencyProvider.h>)
+#import <React-RCTAppDelegate/RCTDependencyProvider.h>
+#elif __has_include(<React_RCTAppDelegate/RCTDependencyProvider.h>)
+#import <React_RCTAppDelegate/RCTDependencyProvider.h>
+#else
+#import "RCTDependencyProvider.h"
+#endif
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface RCTAppDependencyProvider : NSObject <RCTDependencyProvider>
+
+@end
+
+NS_ASSUME_NONNULL_END

package/android/app/build/generated/source/codegen/RCTAppDependencyProvider.mm

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import "RCTAppDependencyProvider.h"
+#import <ReactCodegen/RCTModulesConformingToProtocolsProvider.h>
+#import <ReactCodegen/RCTThirdPartyComponentsProvider.h>
+#import <ReactCodegen/RCTModuleProviders.h>
+
+@implementation RCTAppDependencyProvider
+
+- (nonnull NSArray<NSString *> *)URLRequestHandlerClassNames {
+  return RCTModulesConformingToProtocolsProvider.URLRequestHandlerClassNames;
+}
+
+- (nonnull NSArray<NSString *> *)imageDataDecoderClassNames {
+  return RCTModulesConformingToProtocolsProvider.imageDataDecoderClassNames;
+}
+
+- (nonnull NSArray<NSString *> *)imageURLLoaderClassNames {
+  return RCTModulesConformingToProtocolsProvider.imageURLLoaderClassNames;
+}
+
+- (nonnull NSDictionary<NSString *,Class<RCTComponentViewProtocol>> *)thirdPartyFabricComponents {
+  return RCTThirdPartyComponentsProvider.thirdPartyFabricComponents;
+}
+
+- (nonnull NSDictionary<NSString *, id<RCTModuleProvider>> *)moduleProviders {
+  return RCTModuleProviders.moduleProviders;
+}
+
+@end

package/android/app/build/generated/source/codegen/RCTModuleProviders.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+@protocol RCTModuleProvider;
+
+@interface RCTModuleProviders: NSObject
+
++ (NSDictionary<NSString *, id<RCTModuleProvider>> *)moduleProviders;
+
+@end

package/android/app/build/generated/source/codegen/RCTModuleProviders.mm

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import "RCTModuleProviders.h"
+#import <ReactCommon/RCTTurboModule.h>
+#import <React/RCTLog.h>
+
+@implementation RCTModuleProviders
+
++ (NSDictionary<NSString *, id<RCTModuleProvider>> *)moduleProviders
+{
+  static NSDictionary<NSString *, id<RCTModuleProvider>> *providers = nil;
+  static dispatch_once_t onceToken;
+
+  dispatch_once(&onceToken, ^{
+    NSDictionary<NSString *, NSString *> * moduleMapping = @{
+      
+    };
+
+    NSMutableDictionary *dict = [[NSMutableDictionary alloc] initWithCapacity:moduleMapping.count];
+
+    for (NSString *key in moduleMapping) {
+      NSString * moduleProviderName = moduleMapping[key];
+      Class klass = NSClassFromString(moduleProviderName);
+      if (!klass) {
+        RCTLogError(@"Module provider %@ cannot be found in the runtime", moduleProviderName);
+        continue;
+      }
+
+      id instance = [klass new];
+      if (![instance respondsToSelector:@selector(getTurboModule:)]) {
+        RCTLogError(@"Module provider %@ does not conform to RCTModuleProvider", moduleProviderName);
+        continue;
+      }
+
+      [dict setObject:instance forKey:key];
+    }
+
+    providers = dict;
+  });
+
+  return providers;
+}
+
+@end

package/android/app/build/generated/source/codegen/RCTModulesConformingToProtocolsProvider.h

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+@interface RCTModulesConformingToProtocolsProvider: NSObject
+
++(NSArray<NSString *> *)imageURLLoaderClassNames;
+
++(NSArray<NSString *> *)imageDataDecoderClassNames;
+
++(NSArray<NSString *> *)URLRequestHandlerClassNames;
+
+@end

package/android/app/build/generated/source/codegen/RCTModulesConformingToProtocolsProvider.mm

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import "RCTModulesConformingToProtocolsProvider.h"
+
+@implementation RCTModulesConformingToProtocolsProvider
+
++(NSArray<NSString *> *)imageURLLoaderClassNames
+{
+  static NSArray<NSString *> *classNames = nil;
+  static dispatch_once_t onceToken;
+  
+  dispatch_once(&onceToken, ^{
+    classNames = @[
+      
+    ];
+  });
+  
+  return classNames;
+}
+
++(NSArray<NSString *> *)imageDataDecoderClassNames
+{
+  static NSArray<NSString *> *classNames = nil;
+  static dispatch_once_t onceToken;
+  
+  dispatch_once(&onceToken, ^{
+    classNames = @[
+      
+    ];
+  });
+  
+  return classNames;
+}
+
++(NSArray<NSString *> *)URLRequestHandlerClassNames
+{
+  static NSArray<NSString *> *classNames = nil;
+  static dispatch_once_t onceToken;
+  
+  dispatch_once(&onceToken, ^{
+    classNames = @[
+      
+    ];
+  });
+  
+  return classNames;
+}
+
+@end

package/android/app/build/generated/source/codegen/RCTThirdPartyComponentsProvider.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+@protocol RCTComponentViewProtocol;
+
+@interface RCTThirdPartyComponentsProvider: NSObject
+
++ (NSDictionary<NSString *, Class<RCTComponentViewProtocol>> *)thirdPartyFabricComponents;
+
+@end

package/android/app/build/generated/source/codegen/RCTThirdPartyComponentsProvider.mm

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+
+#import <Foundation/Foundation.h>
+
+#import "RCTThirdPartyComponentsProvider.h"
+#import <React/RCTComponentViewProtocol.h>
+
+@implementation RCTThirdPartyComponentsProvider
+
++ (NSDictionary<NSString *, Class<RCTComponentViewProtocol>> *)thirdPartyFabricComponents
+{
+  static NSDictionary<NSString *, Class<RCTComponentViewProtocol>> *thirdPartyComponents = nil;
+  static dispatch_once_t nativeComponentsToken;
+
+  dispatch_once(&nativeComponentsToken, ^{
+    thirdPartyComponents = @{
+			@"NeuroScanCameraView": NSClassFromString(@"NeuroScanCameraViewComponentView"), // react-native-neuroscan
+    };
+  });
+
+  return thirdPartyComponents;
+}
+
+@end

package/android/app/build/generated/source/codegen/ReactAppDependencyProvider.podspec

@@ -0,0 +1,34 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+version = "0.79.0"
+source = { :git => 'https://github.com/facebook/react-native.git' }
+if version == '1000.0.0'
+  # This is an unpublished version, use the latest commit hash of the react-native repo, which we’re presumably in.
+  source[:commit] = `git rev-parse HEAD`.strip if system("git rev-parse --git-dir > /dev/null 2>&1")
+else
+  source[:tag] = "v#{version}"
+end
+
+Pod::Spec.new do |s|
+  s.name                   = "ReactAppDependencyProvider"
+  s.version                = version
+  s.summary                = "The third party dependency provider for the app"
+  s.homepage               = "https://reactnative.dev/"
+  s.documentation_url      = "https://reactnative.dev/"
+  s.license                = "MIT"
+  s.author                 = "Meta Platforms, Inc. and its affiliates"
+  s.platforms              = min_supported_versions
+  s.source                 = source
+  s.source_files           = "**/RCTAppDependencyProvider.{h,mm}"
+
+  # This guard prevent to install the dependencies when we run `pod install` in the old architecture.
+  s.pod_target_xcconfig    = {
+    "CLANG_CXX_LANGUAGE_STANDARD" => rct_cxx_language_standard(),
+    "DEFINES_MODULE" => "YES"
+  }
+
+  s.dependency "ReactCodegen"
+end

package/android/app/build/generated/source/codegen/java/com/facebook/fbreact/specs/NativeNeuroscanSpec.java

@@ -0,0 +1,67 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateModuleJavaSpec.js
+ *
+ * @nolint
+ */
+
+package com.facebook.fbreact.specs;
+
+import com.facebook.proguard.annotations.DoNotStrip;
+import com.facebook.react.bridge.Promise;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.turbomodule.core.interfaces.TurboModule;
+import javax.annotation.Nonnull;
+
+public abstract class NativeNeuroscanSpec extends ReactContextBaseJavaModule implements TurboModule {
+  public static final String NAME = "Neuroscan";
+
+  public NativeNeuroscanSpec(ReactApplicationContext reactContext) {
+    super(reactContext);
+  }
+
+  @Override
+  public @Nonnull String getName() {
+    return NAME;
+  }
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void scanDocument(ReadableMap options, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void detectEdges(String imageUri, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void cropDocument(String imageUri, ReadableMap corners, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void processImage(String imageUri, ReadableMap options, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void scanAndProcess(String imageUri, ReadableMap processOptions, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void cleanupTempFiles(Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void addListener(String eventType);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void removeListeners(double count);
+}