@thegrizzlylabs/react-native-genius-scan 4.18.0 → 4.20.0

package/README.md

@@ -11,16 +11,16 @@ This React Native component allows you to access the [Genius Scan SDK](https://g
   - Batch scanning of several pages in row
   - OCR to extract raw text from images and generate PDF with invisible text layer
 
-## Licence
+## License
 
-This component is based on the Genius Scan SDK for which you need to [setup a licence](#api).
-You can already try the "demo" version for free by not setting a licence key, the only limitation being that the app will exit after 60 seconds.
+This plugin is based on the Genius Scan SDK for which you need to [setup a license](#set-the-license-key).
+You can aleady try the "demo" version for free by not setting a license key, the only limitation being that the app will exit after 60 seconds.
 
 To buy a license:
 1. [Sign up](https://sdk.geniusscan.com/apps) to our developer console
 2. Submit a quote request for each application
 
-You can learn more about [licensing](https://geniusscansdk.com/license/licensing) on our website and contact us at sdk@geniusscan.com for further questions.
+You can learn more about [licensing](https://geniusscansdk.com/license/licensing) in our website and contact us at sdk@geniusscan.com for further questions.
 
 ## Demo application
 
@@ -59,15 +59,15 @@ Run `pod install` from the ios folder
 
 ## Usage
 
-### Set the licence key
+### Set the license key
 
-Initialize the SDK with a valid licence key:
+Initialize the SDK with a valid license key:
 
 ```javascript
-RNGeniusScan.setLicenceKey('REPLACE_WITH_YOUR_LICENCE_KEY')
+RNGeniusScan.setLicenseKey(licenseKey, /* autoRefresh = */ true)
 ```
 
-`setLicenseKey` returns a promise that is resolved if the licence key is valid and rejected if it is not. Note that, for testing purpose, you can also use the plugin without a licence key, but it will only work for 60 seconds.
+`setLicenseKey` doesn't return anything. However, other methods of the plugin will fail if the license key is invalid or expired. Note that, for testing purpose, you can also use the plugin without setting a license key, but it will only work for 60 seconds.
 
 **It is recommended to show a message to users asking them to update the application in case the license has expired.**
 
@@ -137,10 +137,7 @@ The `configuration` parameter provides the following options:
 ```javascript
 import RNGeniusScan from '@thegrizzlylabs/react-native-genius-scan';
 
-RNGeniusScan.setLicenceKey('REPLACE_WITH_YOUR_LICENCE_KEY')
-.then(() => {
-	return RNGeniusScan.scanWithConfiguration({ source: 'camera'})
-})
+RNGeniusScan.scanWithConfiguration({ source: 'camera'})
 .then((result) => {
 	// Do something with the result
 })
@@ -156,10 +153,7 @@ import RNGeniusScan from '@thegrizzlylabs/react-native-genius-scan';
 
 const imageUri = 'file://xxxxx' // imageUri from an existing file
 
-RNGeniusScan.setLicenceKey('REPLACE_WITH_YOUR_LICENCE_KEY')
-.then(() => {
-	return RNGeniusScan.scanWithConfiguration({ source: 'image', sourceImageUrl: imageUri })
-})
+RNGeniusScan.scanWithConfiguration({ source: 'image', sourceImageUrl: imageUri })
 .then((result) => {
 	// Do something with the enhanced image
 })

package/RNGeniusScan.podspec

@@ -13,7 +13,7 @@ Pod::Spec.new do |s|
   s.source_files  = ["ios/RNGeniusScan.{h,m}"]
   s.requires_arc = true
   s.source = { git: 'git@github.com:thegrizzlylabs/geniusscan-sdk-demo.git' }
-  s.platform     = :ios, "11.0"
+  s.platform     = :ios, "12.0"
 
   s.dependency "React"
 

package/android/build.gradle

@@ -41,6 +41,6 @@ rootProject.allprojects {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.geniusscansdk:gssdk-scanflow:4.18.0'
-    implementation 'com.geniusscansdk:gssdk-ocr:4.18.0'
+    implementation 'com.geniusscansdk:gssdk-scanflow:4.20.0'
+    implementation 'com.geniusscansdk:gssdk-ocr:4.20.0'
 }

package/android/src/main/java/com/geniusscansdk/reactnative/RNGeniusScanModule.java

@@ -72,10 +72,17 @@ public class RNGeniusScanModule extends ReactContextBaseJavaModule {
     resolvePromiseWithPromiseResult(promise, promiseResult);
   }
 
+  @SuppressWarnings("unused")
+  @ReactMethod
+  public void setLicenseKey(String licenseKey, boolean autoRefresh, Promise promise) {
+    PluginBridge.setLicenseKey(this.reactContext, licenseKey, autoRefresh);
+    promise.resolve(null);
+  }
+
   @SuppressWarnings("unused")
   @ReactMethod
   public void setLicenceKey(String licenseKey, Promise promise) {
     PromiseResult promiseResult = PluginBridge.setLicenseKey(this.reactContext, licenseKey);
     resolvePromiseWithPromiseResult(promise, promiseResult);
   }
-}
+}

package/index.js

@@ -7,5 +7,12 @@ const { RNGeniusScan } = NativeModules;
 export default {
   scanWithConfiguration: (scanOptions = {}) => RNGeniusScan.scanWithConfiguration(scanOptions),
   generateDocument: RNGeniusScan.generateDocument,
-  setLicenceKey: RNGeniusScan.setLicenceKey
+  /**
+   * @deprecated
+   */
+  setLicenceKey: (key) => {
+    console.warn("setLicenceKey is deprecated. Please use setLicenseKey instead.")
+    RNGeniusScan.setLicenceKey(key)
+  },
+  setLicenseKey: RNGeniusScan.setLicenseKey
 };

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

@@ -8,32 +8,32 @@
 			<key>DebugSymbolsPath</key>
 			<string>dSYMs</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64_x86_64-simulator</string>
 			<key>LibraryPath</key>
 			<string>GSSDKCore.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>DebugSymbolsPath</key>
 			<string>dSYMs</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64_x86_64-simulator</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>GSSDKCore.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/GSSDKOCR.xcframework/Info.plist

@@ -8,32 +8,32 @@
 			<key>DebugSymbolsPath</key>
 			<string>dSYMs</string>
 			<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>DebugSymbolsPath</key>
 			<string>dSYMs</string>
 			<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

@@ -17,7 +17,7 @@ typedef NS_ENUM(NSInteger, GSKScanFlowError) {
     /// User has canceled the scan flow
     GSKScanFlowUserCancelationError = 999,
     /// A general error due to a bad input parameter. Verify that your input match the API requirements.
-    GSKScanFlowBadInputError = 1000,
+    GSKScanFlowBadInputError = 1000
 };
 
 /**
@@ -38,6 +38,15 @@ typedef NS_OPTIONS(NSUInteger, GSKScanFlowOCROutputFormats) {
     GSKScanFlowOCROutputFormatsAll = NSUIntegerMax,
 };
 
+/**
+ The types of structured data to extract.
+ */
+typedef NS_OPTIONS(NSUInteger, GSKScanFlowStructuredData) {
+    GSKScanFlowStructuredDataNone = 0,
+    /// To scan IBAN and BIC/SWIFT codes
+    GSKScanFlowStructuredDataBankDetails = 1 << 0
+};
+
 /**
  The configuration for text recognition
  */
@@ -180,6 +189,14 @@ typedef NS_ENUM(NSUInteger, GSKScanFlowMultiPageFormat) {
  */
 @property (nonatomic, assign) GSKScanFlowFilterType defaultFilter;
 
+/**
+ Skips showing the post-processing screen.
+
+ We only recommend this option when scanning structured data. Generally, you want the user to visually confirm
+ the quality of the scan.
+ */
+@property (nonatomic, assign) BOOL skipPostProcessingScreen;
+
 /**
  Select which actions are displayed in the post processing screen
 
@@ -274,6 +291,13 @@ typedef NS_ENUM(NSUInteger, GSKScanFlowMultiPageFormat) {
  */
 @property (nonatomic, strong, nullable) GSKScanFlowOCRConfiguration *ocrConfiguration;
 
+/**
+ The types of structured data you want to extract from the document.
+
+ This is an option set so you can combine multiple values.
+ */
+@property (nonatomic, assign) GSKScanFlowStructuredData structuredData;
+
 @end
 
 /**
@@ -289,6 +313,26 @@ typedef NS_ENUM(NSUInteger, GSKScanFlowMultiPageFormat) {
 
 @end
 
+@interface GSKScanFlowStructuredDataResultBankDetails: NSObject
+
+/// The IBAN if successfully extracted, otherwise is nil.
+@property (nonatomic, strong, nullable) NSString *iban;
+
+/// The BIC code if successfully extracted, otherwise is nil.
+@property (nonatomic, strong, nullable) NSString *bic;
+
+@end
+
+/**
+ The result of a structured data extraction.
+ */
+@interface GSKScanFlowStructuredDataResult: NSObject
+
+/// Present if bank details extraction was requested, nil otherwise.
+@property (nonatomic, strong, nullable) GSKScanFlowStructuredDataResultBankDetails *bankDetails;
+
+@end
+
 /**
  A page captured by the scan flow.
 */
@@ -304,7 +348,10 @@ typedef NS_ENUM(NSUInteger, GSKScanFlowMultiPageFormat) {
 @property (nonatomic, strong) NSString *enhancedFilePath;
 
 /// If OCR was performed, the recognized text.
-@property (nonatomic, strong) GSKScanFlowOCRResult *ocrResult;
+@property (nonatomic, strong, nullable) GSKScanFlowOCRResult *ocrResult;
+
+/// If structured data extraction was performed, the structured data.
+@property (nonatomic, strong, nullable) GSKScanFlowStructuredDataResult *structuredDataResult;
 
 @end
 

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

@@ -10,6 +10,8 @@
 
 #import <GSSDKCore/GSSDKCore.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 @class GSKOCRResult;
 
 /**
@@ -45,7 +47,12 @@
 @property (nonatomic, assign) GSKRotation appliedRotation;
 
 /// If OCR was performed, the recognized text.
-@property (nonatomic, strong) GSKOCRResult *ocrResult;
+@property (nonatomic, strong, nullable) GSKOCRResult *ocrResult;
+
+/// If bank details extraction was performed and successful, the extracted IBAN, otherwise nil.
+@property (nonatomic, strong, nullable) NSString *structuredDataIBAN;
+/// If bank details extraction was performed and successful, the extracted BIC, otherwise nil.
+@property (nonatomic, strong, nullable) NSString *structuredDataBIC;
 
 /// Deletes all the files related to this scan. Convenient to clean up after you copied
 /// what you needed.
@@ -53,4 +60,4 @@
 
 @end
 
-
+NS_ASSUME_NONNULL_END

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

@@ -296,6 +296,18 @@ SWIFT_CLASS("_TtC13GSSDKScanFlow33BVImageContentViewObjCWrapperView")
 @end
 
 
+@class GSKScanFlowScanInternal;
+@class GSKScanFlowConfiguration;
+
+SWIFT_CLASS("_TtC13GSSDKScanFlow32GSKScanFlowStructuredDataService")
+@interface GSKScanFlowStructuredDataService : NSObject
+SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) GSKScanFlowStructuredDataService * _Nonnull shared;)
++ (GSKScanFlowStructuredDataService * _Nonnull)shared SWIFT_WARN_UNUSED_RESULT;
+- (void)process:(GSKScanFlowScanInternal * _Nonnull)scan configuration:(GSKScanFlowConfiguration * _Nonnull)configuration;
+- (void)waitForCompletion:(void (^ _Nonnull)(void))onDone;
+- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
+@end
+
 
 SWIFT_CLASS("_TtC13GSSDKScanFlow25GSKUIBackgroundProcessing")
 @interface GSKUIBackgroundProcessing : NSObject
@@ -305,7 +317,6 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) GSKUIBackgro
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
-@class GSKScanFlowScanInternal;
 @class GSKScanFlowOCRConfiguration;
 
 SWIFT_CLASS("_TtC13GSSDKScanFlow15GSKUIOCRService")

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

@@ -18,3 +18,4 @@ FOUNDATION_EXPORT const unsigned char GSSDKScanFlowVersionString[];
 // Private
 #import <GSSDKScanFlow/GSKScanFlowScanInternal.h>
 #import <GSSDKScanFlow/GSKScanFlowConfiguration+Dictionary.h>
+#import <GSSDKScanFlow/GSKScanFlowResult+Dictionary.h>