@thegrizzlylabs/react-native-genius-scan 4.13.0 → 4.15.0

package/README.md

@@ -3,7 +3,7 @@
 
 ## Description
 
-This React Native component allows you to access the [Genius Scan SDK](https://geniusscansdk.com) core features from a React Native application. The component relies on the GSSDKScannerUI library which provides a all-in-one scanner module with simple configurable input.
+This React Native component allows you to access the [Genius Scan SDK](https://geniusscansdk.com) core features from a React Native application. The component relies on the ScanFlow module which provides a all-in-one scanner module with simple configurable input.
 
   - Automatic document detection
   - Document perspective correction
@@ -55,16 +55,8 @@ NSCameraUsageDescription - "We use the camera for <provide a good reason why you
 platform :ios, '11.0'
 ```
 
-#### With ReactNative 0.60 and above
-
 Run `pod install` from the ios folder
 
-#### With ReactNative below 0.60
-
-Open your Xcode project file (ios/*****.xcodeproj), and:
-- Add GSSDK.framework and GSSDKScannerUI.framework, located in `node_modules/@thegrizzlylabs/react-native-genius-scan/ios`, to your project "Embedded Libraries"
-- Add the path `${PROJECT_DIR}/../node_modules/@thegrizzlylabs/react-native-genius-scan/ios/GSSDK` to your project "Framework Search path" (in the Build Settings)
-
 ## Usage
 
 ### Set the licence key
@@ -87,7 +79,7 @@ val result = await RNGeniusScan.scanWithConfiguration(configuration)
 
 The method `scanWithConfiguration` takes a `configuration` parameter which can take the following options:
 
-- `source`: `camera` or `image` (defaults to camera)
+- `source`: `camera`, `image` or `library` (defaults to camera)
 - `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`)
@@ -106,6 +98,7 @@ The method `scanWithConfiguration` takes a `configuration` parameter which can t
 - `ocrConfiguration`: text recognition options. Text recognition will run on a background thread for every captured image. No text recognition will be applied if this parameter is not present.
     - `languages`: list of language codes (eg `["eng"]`) for which to run text recognition. They should match the provided language files. Note that text recognition will take longer if multiple languages are specified.
     - `languagesDirectoryUrl`: folder containing the language files used for text recognition. Language files can be downloaded from https://github.com/tesseract-ocr/tessdata_fast.
+    - `outputFormats`: an array with the formats in which the OCR result is made available in the ScanFlow result (defaults to all formats). Possible formats are `rawText`, `hOCR` and `textLayerInPDF`.
 
 It returns a promise with `result` object containing:
 
@@ -190,7 +183,7 @@ NB: iOS applications must be [localized in XCode by adding each language to the
 Make sure that the license key is correct, that is has not expired, and that it is used with the App ID it was generated for. To learn more about the procurement and replacement of license keys, refer to the [Licensing FAQ](https://geniusscansdk.com/license/licensing).
 
 ## Troubleshooting
-  
+
 Refer to the troubleshooting guides of the native libraries to resolve common configuration and build problems:
 
 - [iOS](https://geniusscansdk.com/docs/v4/ios/troubleshooting/)

package/android/build.gradle

@@ -40,6 +40,6 @@ rootProject.allprojects {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.geniusscansdk:gssdk-scanflow:4.13.0'
-    implementation 'com.geniusscansdk:gssdk-ocr:4.13.0'
+    implementation 'com.geniusscansdk:gssdk-scanflow:4.15.0'
+    implementation 'com.geniusscansdk:gssdk-ocr:4.15.0'
 }

package/ios/GSSDK/GSSDKOCR.xcframework/Info.plist

@@ -6,30 +6,30 @@
 	<array>
 		<dict>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>GSSDKOCR.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
+				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
 		</dict>
 		<dict>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>GSSDKOCR.framework</string>
 			<key>SupportedArchitectures</key>
 			<array>
 				<string>arm64</string>
-				<string>x86_64</string>
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>

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

@@ -6,7 +6,6 @@
 //
 
 #import <Foundation/Foundation.h>
-#import <GSSDKOCR/GSSDKOCR.h>
 #import <UIKit/UIKit.h>
 
 
@@ -21,8 +20,51 @@ typedef NS_ENUM(NSInteger, GSKScanFlowError) {
     GSKScanFlowBadInputError = 1000,
 };
 
+/**
+ The various formats into which the OCR result can be made available.
+
+ This is an option set so you can combine multiple formats.
+ */
+typedef NS_OPTIONS(NSUInteger, GSKScanFlowOCROutputFormats) {
+    /// No output formats
+    GSKScanFlowOCROutputFormatsNone = 0,
+    /// Output OCR result as raw text
+    GSKScanFlowOCROutputFormatsRawText = 1 << 0,
+    /// Output OCR result in HOCR format
+    GSKScanFlowOCROutputFormatsHOCR = 1 << 1,
+    /// Add OCR result as a text layer in the generated PDF file (if any)
+    GSKScanFlowOCROutputFormatsTextLayerInPDF = 1 << 2,
+    /// All the output formats
+    GSKScanFlowOCROutputFormatsAll = NSUIntegerMax,
+};
+
+/**
+ The configuration for text recognition
+ */
+@interface GSKScanFlowOCRConfiguration : NSObject
+
+/**
+ The path to the trained data *folder* (and not file).
+
+ The folder must contain trained data files.
+ */
+@property (nonatomic, strong) NSString *trainedDataPath;
+
+/**
+ The language to process OCR with.
+
+ The corresponding trained data files must be present in the folder specified by trainedDataPath.
+ */
+@property (nonatomic, strong) NSArray<NSString *> *languageCodes;
+
+/**
+ The formats in which the OCR result is made available in the ScanFlow result
 
-@class GSKScanFlowScan;
+ Default is everything.
+ */
+@property (nonatomic, assign) GSKScanFlowOCROutputFormats outputFormats;
+
+@end
 
 /**
  The source for a scan flow
@@ -102,9 +144,9 @@ typedef NS_ENUM(NSUInteger, GSKScanFlowMultiPageFormat) {
 };
 
 /**
- Enables configuration of the GSKUIScanner scan flow.
+ Enables configuration of the GSKScanFlow.
 
- Set the desired configuration on an instance of GSKScanFlowConfiguration and pass it to the initializer of GSKUIScanner to build the desired scan flow.
+ Set the desired configuration on an instance of GSKScanFlowConfiguration and pass it to the initializer of GSKScanFlow to build the desired scan flow.
  */
 @interface GSKScanFlowConfiguration : NSObject
 
@@ -230,7 +272,39 @@ typedef NS_ENUM(NSUInteger, GSKScanFlowMultiPageFormat) {
 
  Default is nil, which means no OCR is performed.
  */
-@property (nonatomic, strong) GSKOCRConfiguration *ocrConfiguration;
+@property (nonatomic, strong) GSKScanFlowOCRConfiguration *ocrConfiguration;
+
+@end
+
+/**
+ The result of the text recognition.
+*/
+@interface GSKScanFlowOCRResult: NSObject
+
+/** The raw text recognized in the document */
+@property (nonatomic, strong, nullable) NSString *text;
+
+/** The text layout of the recognized text */
+@property (nonatomic, strong, nullable) NSString *hocrTextLayout;
+
+@end
+
+/**
+ A page captured by the scan flow.
+*/
+@interface GSKScanFlowScan : NSObject
+
+/// The original JPEG out of the camera.
+///
+/// Note that this image might be rotated, and needs to be read with its EXIF orientation to be properly displayed.
+/// UIImage's methods will properly take care of that.
+@property (nonatomic, strong) NSString *originalFilePath;
+
+/// The enhanced, processed, image.
+@property (nonatomic, strong) NSString *enhancedFilePath;
+
+/// If OCR was performed, the recognized text.
+@property (nonatomic, strong) GSKScanFlowOCRResult *ocrResult;
 
 @end
 
@@ -269,7 +343,7 @@ typedef NS_ENUM(NSUInteger, GSKScanFlowMultiPageFormat) {
 @interface GSKScanFlow : NSObject
 
 /**
- Instantiates a GSKUIScanner with the provided configuration.
+ Instantiates a GSKScanFlow with the provided configuration.
 
  @param configuration The provided configuration
  */

package/ios/GSSDK/GSSDKScanFlow.xcframework/ios-arm64/GSSDKScanFlow.framework/Headers/{GSKScanFlowScan.h → GSKScanFlowScanInternal.h}

@@ -15,7 +15,7 @@
 /**
  The output result from the scan flow.
  */
-@interface GSKScanFlowScan : NSObject
+@interface GSKScanFlowScanInternal : NSObject
 
 - (instancetype)init NS_UNAVAILABLE;
 - (instancetype)initWithOriginalFilePath:(NSString *)originalFilePath;

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

@@ -305,15 +305,15 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) GSKUIBackgro
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
-@class GSKScanFlowScan;
-@class GSKOCRConfiguration;
+@class GSKScanFlowScanInternal;
+@class GSKScanFlowOCRConfiguration;
 
 SWIFT_CLASS("_TtC13GSSDKScanFlow15GSKUIOCRService")
 @interface GSKUIOCRService : NSObject
 SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) GSKUIOCRService * _Nonnull shared;)
 + (GSKUIOCRService * _Nonnull)shared SWIFT_WARN_UNUSED_RESULT;
 @property (nonatomic, readonly) NSInteger pendingCount;
-- (void)process:(GSKScanFlowScan * _Nonnull)scan configuration:(GSKOCRConfiguration * _Nonnull)configuration;
+- (void)process:(GSKScanFlowScanInternal * _Nonnull)scan configuration:(GSKScanFlowOCRConfiguration * _Nonnull)configuration;
 - (void)waitForCompletion:(void (^ _Nonnull)(void))onDone;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end

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

@@ -13,5 +13,5 @@ FOUNDATION_EXPORT double GSSDKScanFlowVersionNumber;
 //! Project version string for GSSDKScanFlow.
 FOUNDATION_EXPORT const unsigned char GSSDKScanFlowVersionString[];
 
-#import <GSSDKScanFlow/GSKScanFlowScan.h>
 #import <GSSDKScanFlow/GSKScanFlow.h>
+#import <GSSDKScanFlow/GSKScanFlowScanInternal.h>