@thegrizzlylabs/react-native-genius-scan 5.0.8 → 5.1.0

package/README.md

@@ -92,12 +92,14 @@ The method `scanWithConfiguration` takes a `configuration` parameter which can t
 - `sourceImageUrl`: an absolute image url, required if `source` is `image`. Example: `file:///var/…/image.png`
 - `multiPage`: boolean (defaults to true). If true, after a page is scanned, a prompt to scan another page will be displayed. If false, a single page will be scanned.
 - `multiPageFormat`: `pdf`, `tiff`, `none` (defaults to `pdf`)
-- `defaultFilter`: `none`, `blackAndWhite`, `monochrome`, `color`, `photo` (by default, the filter is chosen automatically)
+- `defaultFilter`: the filter that will be applied by default to enhance scans, or `none` if no enhancement should be performed by default. Possible values are listed in the [Available filters section](#available-filters). Default value is `automatic`.
+- `availableFilters`: an array of filters that the user can select when they tap on the edit filter button. Defaults to [`none`, `automatic`, `automaticMonochrome`, `automaticBlackAndWhite`, `automaticColor`, `photo`].
 - `pdfPageSize`: `fit`, `a4`, `letter`, defaults to fit.
 - `pdfMaxScanDimension`: max dimension in pixels when images are scaled before PDF generation, for example 2000 to fit both height and width within 2000px. Defaults to 0, which means no scaling is performed.
 - `pdfFontFileUrl`: Custom font file used during the PDF generation to embed an invisible text layer. If null, a default font is used, which only supports Latin languages.
 - `jpegQuality`: JPEG quality used to compress captured images. Between 0 and 100, 100 being the best quality. Default is 60.
 - `postProcessingActions`: an array with the desired actions to display during the post processing screen (defaults to all actions). Possible actions are `rotate`, `editFilter` and `correctDistortion`.
+- `defaultCurvatureCorrection`: `enabled` or `disabled` whether a curvature correction should be applied by default (Android only). Disabled by default.
 - `flashButtonHidden`: boolean (default to false)
 - `defaultFlashMode`: `auto`, `on`, `off` (default to `off`)
 - `foregroundColor`: string representing a color, must start with a `#`. The color of the icons, text (defaults to '#ffffff').
@@ -120,6 +122,15 @@ It returns a promise with `result` object containing:
         - `hocrTextLayout`: the recognized text in [hOCR](https://en.wikipedia.org/wiki/HOCR) format (with position, style…)
     - `structuredData`: the result of the structured data extraction. A subdictionary will be present for each type of structured data detected by the scan flow.
 
+### Available filters
+
+The ScanFlow offers a variety of filters to enhance the appearance of different kinds of documents.
+Some filters are dynamic (or automatic), meaning they will apply the best enhancement possible, possibly with some constraints. For example, the `automaticBlackAndWhite` filter will apply the best enhancement, assuming that the scan is a text document and making sure the output will have a grayscale color palette.
+Here is a list of all possible dynamic filters: `automatic`, `automaticColor`, `automaticBlackAndWhite`, `automaticMonochrome`.
+
+Other filters are static filters, which means they always perform the same enhancement operation, without any logic on the document characteristics.
+The different static filters are: `photo`, `softBlackAndWhite`, `softColor`, `strongMonochrome`, `strongBlackAndWhite`, `strongColor`, `darkBackground`.
+
 ### (Optional) Generate a PDF document from multiple pages
 
 If you'd like to rearrange the pages returned by the ScanFlow or add some more pages, you can do so and generate a PDF document from these pages:

package/android/build.gradle

@@ -41,5 +41,5 @@ rootProject.allprojects {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.geniusscansdk:gssdk:5.0.8'
+    implementation 'com.geniusscansdk:gssdk:5.1.0'
 }

package/ios/GSSDK/GSSDK.xcframework/ios-arm64/GSSDK.framework/Headers/GSKView.h

@@ -11,10 +11,12 @@
 
 #import <AVFoundation/AVFoundation.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 @class GSKView;
 @class GSKQuadrangle;
 
-@protocol GSCViewDelegate <NSObject>
+@protocol GSKViewDelegate <NSObject>
 
 - (void)cameraView:(GSKView *)cameraView requestedFocusAtPoint:(CGPoint)focusPoint;
 
@@ -22,15 +24,15 @@
 
 @interface GSKView : UIView
 
-// Handle interface orientation change
+/// Handle interface orientation change
 - (void)initializeRotationWithInterfaceOrientation:(UIInterfaceOrientation)orientation;
 - (void)rotateWithCoordinator:(id<UIViewControllerTransitionCoordinator>)coordinator;
 
-// Displays the focus indicator at the requested location
+/// Displays the focus indicator at the requested location
 - (void)animateFocusAtLocation:(CGPoint)location;
 
 /// Updates the quadrangle overlay. Removes the quadrangle if @param quadrangle is nil.
-- (void)updateQuadrangle:(GSKQuadrangle *)quadrangle;
+- (void)updateQuadrangle:(GSKQuadrangle * _Nullable)quadrangle;
 
 - (void)setCaptureSession:(AVCaptureSession *)session;
 
@@ -54,7 +56,8 @@
 
 @property (nonatomic, copy) UIColor *overlayColor;
 
-@property (nonatomic, weak) id <GSCViewDelegate> delegate;
+@property (nonatomic, weak) id<GSKViewDelegate> delegate;
 
 @end
 
+NS_ASSUME_NONNULL_END

package/ios/GSSDK/GSSDK.xcframework/ios-arm64/GSSDK.framework/Headers/GSSDK-Swift.h

@@ -1,6 +1,6 @@
 #if 0
 #elif defined(__arm64__) && __arm64__
-// Generated by Apple Swift version 5.9.2 (swiftlang-5.9.2.2.56 clang-1500.1.0.2.5)
+// Generated by Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4)
 #ifndef GSSDK_SWIFT_H
 #define GSSDK_SWIFT_H
 #pragma clang diagnostic push
@@ -277,7 +277,9 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 #if __has_warning("-Watimport-in-framework-header")
 #pragma clang diagnostic ignored "-Watimport-in-framework-header"
 #endif
+@import AVFoundation;
 @import CoreFoundation;
+@import CoreGraphics;
 @import Dispatch;
 @import Foundation;
 @import ObjectiveC;
@@ -305,8 +307,144 @@ typedef unsigned int swift_uint4  __attribute__((__ext_vector_type__(4)));
 
 #if defined(__OBJC__)
 
+SWIFT_PROTOCOL("_TtP5GSSDK20CGImageRepresentable_")
+@protocol CGImageRepresentable
+- (CGImageRef _Nullable)CGImageRepresentation SWIFT_WARN_UNUSED_RESULT;
+@end
+
+
+@interface AVCapturePhoto (SWIFT_EXTENSION(GSSDK)) <CGImageRepresentable>
+@end
+
+
+
 
 
+
+
+@class GSKCameraSessionConfiguration;
+
+SWIFT_CLASS("_TtC5GSSDK16GSKCameraSession")
+@interface GSKCameraSession : NSObject
+- (nonnull instancetype)initWithConfiguration:(GSKCameraSessionConfiguration * _Nonnull)configuration;
+- (nonnull instancetype)init SWIFT_UNAVAILABLE;
++ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
+@end
+
+
+
+
+
+
+@class AVCapturePhotoOutput;
+@class AVCaptureResolvedPhotoSettings;
+
+@interface GSKCameraSession (SWIFT_EXTENSION(GSSDK)) <AVCapturePhotoCaptureDelegate>
+- (void)captureOutput:(AVCapturePhotoOutput * _Nonnull)output willBeginCaptureForResolvedSettings:(AVCaptureResolvedPhotoSettings * _Nonnull)resolvedSettings;
+- (void)captureOutput:(AVCapturePhotoOutput * _Nonnull)output willCapturePhotoForResolvedSettings:(AVCaptureResolvedPhotoSettings * _Nonnull)resolvedSettings;
+- (void)captureOutput:(AVCapturePhotoOutput * _Nonnull)output didCapturePhotoForResolvedSettings:(AVCaptureResolvedPhotoSettings * _Nonnull)resolvedSettings;
+- (void)captureOutput:(AVCapturePhotoOutput * _Nonnull)output didFinishProcessingPhoto:(AVCapturePhoto * _Nonnull)photo error:(NSError * _Nullable)error;
+- (void)captureOutput:(AVCapturePhotoOutput * _Nonnull)output didFinishCaptureForResolvedSettings:(AVCaptureResolvedPhotoSettings * _Nonnull)resolvedSettings error:(NSError * _Nullable)error;
+@end
+
+
+
+enum GSKCameraSessionDocumentDetection : NSInteger;
+
+/// The configuration for a camera session.
+SWIFT_CLASS("_TtC5GSSDK29GSKCameraSessionConfiguration")
+@interface GSKCameraSessionConfiguration : NSObject
+/// \param documentDetection The type of real-time document detection to apply.
+///
+- (nonnull instancetype)initWithDocumentDetection:(enum GSKCameraSessionDocumentDetection)documentDetection OBJC_DESIGNATED_INITIALIZER;
+/// A session configuration where the document detection is <code>.highlightAndTrigger</code>
+- (nonnull instancetype)init;
+@end
+
+/// The style of document detection to be used during a camera session.
+typedef SWIFT_ENUM(NSInteger, GSKCameraSessionDocumentDetection, open) {
+/// The session doesn’t attempt to detect documents.
+  GSKCameraSessionDocumentDetectionNone = 0,
+/// The session detects documents and produces quadrangles
+/// to be used for highlighting the document in the video frames.
+  GSKCameraSessionDocumentDetectionHighlight = 1,
+/// The session detects documents and snaps the photo when
+/// the detection is stable.
+  GSKCameraSessionDocumentDetectionHighlightAndTrigger = 2,
+};
+
+/// Represents an error raised by the camera session
+typedef SWIFT_ENUM(NSInteger, GSKCameraSessionError, open) {
+  GSKCameraSessionErrorOther = -1,
+  GSKCameraSessionErrorNotAuthorized = -2,
+  GSKCameraSessionErrorLockDevice = -3,
+  GSKCameraSessionErrorNoDevice = -4,
+  GSKCameraSessionErrorInvalidSetupDependency = -5,
+  GSKCameraSessionErrorNoVideoCaptureConnection = -6,
+  GSKCameraSessionErrorInvalidData = -7,
+  GSKCameraSessionErrorBadInput = -8,
+  GSKCameraSessionErrorWarnLockDevice = -1003,
+};
+
+typedef SWIFT_ENUM(NSInteger, GSKCameraSessionFlashStatus, open) {
+  GSKCameraSessionFlashStatusAuto = 0,
+  GSKCameraSessionFlashStatusOn = 1,
+  GSKCameraSessionFlashStatusOff = 2,
+};
+
+@class NSCoder;
+@protocol UIViewControllerTransitionCoordinator;
+@class NSString;
+@class NSBundle;
+
+/// A ready-to-use camera interface for scanning documents.
+SWIFT_CLASS("_TtC5GSSDK23GSKCameraViewController")
+@interface GSKCameraViewController : UIViewController
+- (nullable instancetype)initWithCoder:(NSCoder * _Nonnull)coder OBJC_DESIGNATED_INITIALIZER SWIFT_UNAVAILABLE;
+@property (nonatomic, readonly) BOOL prefersStatusBarHidden;
+- (void)viewDidLoad;
+- (void)viewWillAppear:(BOOL)animated;
+- (void)viewWillDisappear:(BOOL)animated;
+- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id <UIViewControllerTransitionCoordinator> _Nonnull)coordinator;
+- (nonnull instancetype)initWithNibName:(NSString * _Nullable)nibNameOrNil bundle:(NSBundle * _Nullable)nibBundleOrNil SWIFT_UNAVAILABLE;
+@end
+
+@class GSKView;
+
+@interface GSKCameraViewController (SWIFT_EXTENSION(GSSDK)) <GSKViewDelegate>
+- (void)cameraView:(GSKView * _Nonnull)cameraView requestedFocusAtPoint:(CGPoint)focusPoint;
+@end
+
+
+@interface GSKCameraViewController (SWIFT_EXTENSION(GSSDK))
+/// Snap the photo
+- (void)takePhoto;
+@end
+
+
+@class GSKScan;
+@class GSKQuadrangle;
+
+@interface GSKCameraViewController (SWIFT_EXTENSION(GSSDK))
+- (void)cameraSessionDidSetup:(GSKCameraSession * _Nonnull)cameraSession;
+- (void)cameraSession:(GSKCameraSession * _Nonnull)cameraSession setupFailedWithError:(NSError * _Nonnull)error;
+- (void)cameraSessionWillSnapPhoto:(GSKCameraSession * _Nonnull)cameraSession;
+- (void)cameraSessionDidSnapPhoto:(GSKCameraSession * _Nonnull)cameraSession;
+- (void)cameraSession:(GSKCameraSession * _Nonnull)cameraSession didFailToSnapPhotoWithError:(NSError * _Nonnull)error;
+- (void)cameraSession:(GSKCameraSession * _Nonnull)cameraSession didGenerateScan:(GSKScan * _Nonnull)scan;
+- (void)cameraSession:(GSKCameraSession * _Nonnull)cameraSession didEncounterFailureWithError:(NSError * _Nonnull)error;
+- (void)cameraSession:(GSKCameraSession * _Nonnull)cameraSession didFailWithError:(NSError * _Nonnull)error;
+- (void)cameraSessionIsSearchingQuadrangle:(GSKCameraSession * _Nonnull)cameraSession;
+- (void)cameraSessionIsAboutToChooseQuadrangle:(GSKCameraSession * _Nonnull)cameraSession;
+- (void)cameraSession:(GSKCameraSession * _Nonnull)cameraSession willAutoTriggerWithQuadrangle:(GSKQuadrangle * _Nonnull)quadrangle;
+- (void)cameraSession:(GSKCameraSession * _Nonnull)cameraSession didFindQuadrangle:(GSKQuadrangle * _Nonnull)quadrangle;
+- (void)cameraSessionFailedToFindQuadrangle:(GSKCameraSession * _Nonnull)cameraSession;
+- (void)cameraSessionDidStart:(GSKCameraSession * _Nonnull)cameraSession;
+- (void)cameraSessionDidStop:(GSKCameraSession * _Nonnull)cameraSession;
+- (void)cameraSession:(GSKCameraSession * _Nonnull)cameraSession wasInterruptedWithReason:(enum AVCaptureSessionInterruptionReason)reason;
+- (void)cameraSessionInterruptionEnded:(GSKCameraSession * _Nonnull)cameraSession;
+@end
+
 /// The type of document detected by the document finder.
 typedef SWIFT_ENUM(NSInteger, GSKDocumentFinderImageType, closed) {
 /// No document present in the image
@@ -346,7 +484,6 @@ SWIFT_CLASS("_TtC5GSSDK20GSKDocumentGenerator")
 @end
 
 enum GSKDocumentGeneratorFileFormat : NSInteger;
-@class NSString;
 @class GSKDocumentGeneratorDebugConfiguration;
 
 /// A configuration for the document generator.
@@ -764,7 +901,6 @@ SWIFT_CLASS("_TtC5GSSDK11GSKScanFlow")
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
-@class UIViewController;
 @class GSKScanFlowResult;
 
 @interface GSKScanFlow (SWIFT_EXTENSION(GSSDK))
@@ -856,6 +992,7 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
+
 @interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
 /// Create a configuration from a dictionary.
 /// This is particularly useful for interfacing with React Native but shouldn’t
@@ -869,7 +1006,6 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 - (BOOL)validate:(NSError * _Nullable * _Nullable)error;
 @end
 
-
 /// Enum that defines various errors that can occur during a scan flow.
 typedef SWIFT_ENUM(NSInteger, GSKScanFlowError, open) {
 /// User has canceled the scan flow
@@ -1212,7 +1348,6 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) GSKUIBackgro
 - (void)endSnapAnimation;
 @end
 
-@class NSBundle;
 
 SWIFT_CLASS("_TtC5GSSDK14GSSDKResources")
 @interface GSSDKResources : NSObject

package/ios/GSSDK/GSSDK.xcframework/ios-arm64/GSSDK.framework/Headers/GSSDK.h

@@ -12,8 +12,6 @@ FOUNDATION_EXPORT double GSSDKVersionNumber;
 FOUNDATION_EXPORT const unsigned char GSSDKVersionString[];
 
 #import <GSSDK/GSKBackgroundKind.h>
-#import <GSSDK/GSKCameraSession.h>
-#import <GSSDK/GSKCameraViewController.h>
 #import <GSSDK/GSKCore.h>
 #import <GSSDK/GSKCurvatureCorrectionConfiguration.h>
 #import <GSSDK/GSKDefaultLogger.h>
@@ -46,7 +44,6 @@ FOUNDATION_EXPORT const unsigned char GSSDKVersionString[];
 #import <GSSDK/GSKScanFlowStructuredData.h>
 #import <GSSDK/GSKScanProcessor.h>
 #import <GSSDK/GSKShutterView.h>
-#import <GSSDK/GSKTriggerDecider.h>
 #import <GSSDK/GSKView.h>
 #import <GSSDK/MBProgressHUD.h>
 #import <GSSDK/UIImage+GSKUtils.h>