@thegrizzlylabs/react-native-genius-scan 5.0.0-beta7 → 5.0.0-beta9

package/README.md

@@ -42,7 +42,16 @@ $ react-native link @thegrizzlylabs/react-native-genius-scan
 
 ### Additional steps on Android
 
-- To your app `android/app/build.gradle`, change minSdkVersion to `21`.
+- Open the `android/build.gradle` file, change `minSdkVersion` to `21` and add the following repository:
+
+```
+allprojects {
+	repositories {
+	    ...
+	    maven { url 'https://s3.amazonaws.com/tgl.maven' }
+	}
+}
+```
 
 ### Additional steps for iOS
 
@@ -52,7 +61,7 @@ NSCameraUsageDescription - "We use the camera for <provide a good reason why you
 ```
 - In your `Podfile`, add the following line:
 ```
-platform :ios, '11.0'
+platform :ios, '13.0'
 ```
 
 Run `pod install` from the ios folder

package/android/build.gradle

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

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

@@ -78,11 +78,4 @@ public class RNGeniusScanModule extends ReactContextBaseJavaModule {
     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,12 +7,5 @@ const { RNGeniusScan } = NativeModules;
 export default {
   scanWithConfiguration: (scanOptions = {}) => RNGeniusScan.scanWithConfiguration(scanOptions),
   generateDocument: RNGeniusScan.generateDocument,
-  /**
-   * @deprecated
-   */
-  setLicenceKey: (key) => {
-    console.warn("setLicenceKey is deprecated. Please use setLicenseKey instead.")
-    RNGeniusScan.setLicenceKey(key)
-  },
   setLicenseKey: RNGeniusScan.setLicenseKey
 };

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

@@ -24,25 +24,6 @@ NS_ASSUME_NONNULL_BEGIN
 */
 @interface GSK : NSObject
 
-/**
- Must be called first with a valid license key to enable the SDK.
-
- This method returns an error if the SDK isn't initialized properly. In addition, all other SDK methods that return errors will report an error if there
- is a problem with the license key, and you must handle them to ensure you provide a good "degraded" experience.
- For instance, you can prompt the user to update the application to use the scanning feature in case they use a version of the application with an expired license key.
-
- This method is deprecated in favor of `setLicenseKey:autoRefresh:`.
-
- @warning *Important* This method must be called before any use of the SDK methods.
-
- @param licenseKey The license key
- @param error On input, a pointer to an error object. If an error occurs, this pointer is set to an actual error object containing the error information.
- You may specify nil for this parameter if you do not want the error information.
-
- @return YES if the SDK was initialized successfully, NO if an error occured.
- */
-+ (BOOL)initWithLicenseKey:(NSString *)licenseKey error:(NSError * _Nullable *)error __deprecated_msg("-setLicenseKey:autoRefresh: instead.");
-
 /// Sets the Genius Scan SDK license key with auto-refresh enabled.
 ///
 /// See `setLicenseKey:autoRefresh:`

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

@@ -0,0 +1,24 @@
+//
+//  GSKLicenseKeyChecker.h
+//  GSSDK
+//
+//  Created by Bruno Virlet on 15/03/2024.
+//  Copyright © 2024 The Grizzly Labs. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface GSKLicenseKeyChecker : NSObject
+
++ (BOOL)checkLicenseWithError:(NSError *__autoreleasing  _Nullable * _Nullable)error;
+
+#if DEBUG
+/// Enables simulating an invalid license in the tests. 
+@property (nonatomic, class, assign) BOOL simulateInvalid;
+#endif
+
+@end
+
+NS_ASSUME_NONNULL_END

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

@@ -419,7 +419,7 @@ SWIFT_CLASS("_TtC5GSSDK12GSKOCRResult")
 @property (nonatomic, readonly, copy) NSString * _Nonnull text;
 /// The recognized text, as a structured text layout.
 @property (nonatomic, readonly, strong) GSKTextLayout * _Nonnull textLayout;
-- (nonnull instancetype)initWithText:(NSString * _Nonnull)text textLayout:(GSKTextLayout * _Nonnull)textLayout OBJC_DESIGNATED_INITIALIZER;
+- (nonnull instancetype)initWithText:(NSString * _Nonnull)text textLayout:(GSKTextLayout * _Nonnull)textLayout;
 - (nonnull instancetype)init SWIFT_UNAVAILABLE;
 + (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
@@ -637,6 +637,10 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
+@interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
+- (BOOL)validate:(NSError * _Nullable * _Nullable)error;
+@end
+
 
 
 @interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
@@ -647,10 +651,6 @@ SWIFT_CLASS("_TtC5GSSDK24GSKScanFlowConfiguration")
 @end
 
 
-@interface GSKScanFlowConfiguration (SWIFT_EXTENSION(GSSDK))
-- (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
@@ -744,7 +744,6 @@ SWIFT_CLASS("_TtC5GSSDK17GSKScanFlowResult")
 
 
 @interface GSKScanFlowResult (SWIFT_EXTENSION(GSSDK))
-@property (nonatomic, readonly, copy) NSURL * _Nullable pdfURL SWIFT_DEPRECATED_MSG("Use multiPageDocumentURL instead");
 /// A dictionary representation of the result.
 /// Convenient for interfacing with React Native, probably no reason to
 /// use it with native code.
@@ -783,29 +782,29 @@ typedef SWIFT_ENUM(NSUInteger, GSKScanFlowSource, open) {
   GSKScanFlowSourceLibrary = 2,
 };
 
-@class GSKScanFlowStructuredDataResultBankDetails;
-@class GSKScanFlowStructuredDataResultContact;
-@class GSKScanFlowStructuredDataResultReceipt;
+@class GSKStructuredDataBankDetails;
+@class GSKStructuredDataContact;
+@class GSKStructuredDataReceipt;
 
 /// The result of a structured data extraction.
 SWIFT_CLASS("_TtC5GSSDK31GSKScanFlowStructuredDataResult")
 @interface GSKScanFlowStructuredDataResult : NSObject
 /// Present if bank details extraction was requested, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultBankDetails * _Nullable bankDetails;
+@property (nonatomic, strong) GSKStructuredDataBankDetails * _Nullable bankDetails;
 /// Present if business card contact extraction was requested and a contact was
 /// succcessfully extracted, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultContact * _Nullable businessCardContact;
+@property (nonatomic, strong) GSKStructuredDataContact * _Nullable businessCardContact;
 /// Present if receipt extraction was requested and a receipt/invoice was
 /// succcessfully extracted, <code>nil</code> otherwise.
-@property (nonatomic, strong) GSKScanFlowStructuredDataResultReceipt * _Nullable receipt;
+@property (nonatomic, strong) GSKStructuredDataReceipt * _Nullable receipt;
 - (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
 @end
 
 
 
 /// Address data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultAddress")
-@interface GSKScanFlowStructuredDataResultAddress : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataAddress")
+@interface GSKStructuredDataAddress : NSObject
 /// The city component of the address.
 @property (nonatomic, readonly, copy) NSString * _Nullable city;
 /// The postal/zip code component of the address.
@@ -823,30 +822,31 @@ SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultAddress")
 
 
 /// The bank details extracted from a document through OCR.
-SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultBankDetails")
-@interface GSKScanFlowStructuredDataResultBankDetails : NSObject
+SWIFT_CLASS("_TtC5GSSDK28GSKStructuredDataBankDetails")
+@interface GSKStructuredDataBankDetails : NSObject
 /// The IBAN if successfully extracted, otherwise is <code>nil</code>.
 @property (nonatomic, copy) NSString * _Nullable iban;
 /// The BIC code if successfully extracted, otherwise is <code>nil</code>.
 @property (nonatomic, copy) NSString * _Nullable bic;
-- (nonnull instancetype)init OBJC_DESIGNATED_INITIALIZER;
+- (nonnull instancetype)init SWIFT_UNAVAILABLE;
++ (nonnull instancetype)new SWIFT_UNAVAILABLE_MSG("-init is unavailable");
 @end
 
 
-@class GSKScanFlowStructuredDataResultPhoneNumber;
+@class GSKStructuredDataPhoneNumber;
 @class CNContact;
 
 /// Contact data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultContact")
-@interface GSKScanFlowStructuredDataResultContact : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataContact")
+@interface GSKStructuredDataContact : NSObject
 /// Any name that appears on the business card. Contains the full name, including all components.
 @property (nonatomic, readonly, copy) NSString * _Nullable name;
 /// Any organization that appears on the business card.
 @property (nonatomic, readonly, copy) NSString * _Nullable organization;
 /// Any address that appears on the business card.
-@property (nonatomic, readonly, strong) GSKScanFlowStructuredDataResultAddress * _Nullable address;
+@property (nonatomic, readonly, strong) GSKStructuredDataAddress * _Nullable address;
 /// The phone numbers that appear on the business card.
-@property (nonatomic, readonly, copy) NSArray<GSKScanFlowStructuredDataResultPhoneNumber *> * _Nonnull phoneNumbers;
+@property (nonatomic, readonly, copy) NSArray<GSKStructuredDataPhoneNumber *> * _Nonnull phoneNumbers;
 /// The links/URLs that appear on the business card.
 @property (nonatomic, readonly, copy) NSArray<NSURL *> * _Nonnull links;
 /// The email addresses that appear on the business card.
@@ -859,9 +859,46 @@ SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultContact")
 
 
 
+/// Class that enables structured data to be extracted from
+/// scanned documents.
+SWIFT_CLASS("_TtC5GSSDK26GSKStructuredDataExtractor")
+@interface GSKStructuredDataExtractor : NSObject
+- (nonnull instancetype)init;
+@end
+
+
+
+@interface GSKStructuredDataExtractor (SWIFT_EXTENSION(GSSDK))
+/// Extract any bank details that were found in a given document by
+/// passing in the result of performing OCR on that document. Use
+/// <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)bankDetailsFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataBankDetails * _Nullable, NSError * _Nullable))completionHandler;
+/// Extract any business card contact that was found in a given document
+/// by passing in the result of performing OCR on that document. Use
+/// <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)businessCardContactFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataContact * _Nullable, NSError * _Nullable))completionHandler;
+/// Extract any receipt/invoice information that was found in a given
+/// document by passing in the result of performing OCR on that document.
+/// Use <code>GSKOCR</code> to obtain a <code>GSKOCRResult</code> instance. Note that if OCR
+/// was performed for languages that don’t support structured data extraction,
+/// then this method will throw an error.
+- (void)receiptFromOCRResult:(GSKOCRResult * _Nonnull)ocrResult completionHandler:(void (^ _Nonnull)(GSKStructuredDataReceipt * _Nullable, NSError * _Nullable))completionHandler;
+@end
+
+/// Enum defining errors that can be thrown by <code>GSKStructuredDataExtractor</code>.
+/// Note that thrown errors will be wrapped in <code>NSError</code> containers.
+typedef SWIFT_ENUM(NSInteger, GSKStructuredDataExtractorError, open) {
+  GSKStructuredDataExtractorErrorMissingRequiredOCRMetadata = -1,
+};
+
+
 /// Phone number data extracted from a business card document through OCR.
-SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultPhoneNumber")
-@interface GSKScanFlowStructuredDataResultPhoneNumber : NSObject
+SWIFT_CLASS("_TtC5GSSDK28GSKStructuredDataPhoneNumber")
+@interface GSKStructuredDataPhoneNumber : NSObject
 /// The label of the phone number. For example “Main”, “Office”, etc.
 @property (nonatomic, readonly, copy) NSString * _Nonnull label;
 /// A string representation of the phone number itself.
@@ -874,8 +911,8 @@ SWIFT_CLASS("_TtC5GSSDK42GSKScanFlowStructuredDataResultPhoneNumber")
 @class NSLocale;
 
 /// Receipt/invoice details extracted from a document through OCR.
-SWIFT_CLASS("_TtC5GSSDK38GSKScanFlowStructuredDataResultReceipt")
-@interface GSKScanFlowStructuredDataResultReceipt : NSObject
+SWIFT_CLASS("_TtC5GSSDK24GSKStructuredDataReceipt")
+@interface GSKStructuredDataReceipt : NSObject
 /// The locale that the receipt is in, if successfully extracted, otherwise <code>nil</code>.
 @property (nonatomic, readonly, copy) NSLocale * _Nullable locale;
 /// The merchant that the receipt is from, if successfully extracted, otherwise <code>nil</code>.
@@ -931,12 +968,12 @@ SWIFT_CLASS_PROPERTY(@property (nonatomic, class, readonly, strong) GSKUIBackgro
 @end
 
 
-
 @interface GSKView (SWIFT_EXTENSION(GSSDK))
 - (void)startSnapAnimationWithDuration:(NSTimeInterval)duration;
 - (void)endSnapAnimation;
 @end
 
+
 @class NSBundle;
 
 SWIFT_CLASS("_TtC5GSSDK14GSSDKResources")

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

@@ -19,6 +19,7 @@ FOUNDATION_EXPORT const unsigned char GSSDKVersionString[];
 #import <GSSDK/GSKLog.h>
 #import <GSSDK/GSKLoggerSeverity.h>
 #import <GSSDK/GSKDefaultLogger.h>
+#import <GSSDK/GSKLicenseKeyChecker.h>
 
 // UI
 #import <GSSDK/GSKCameraSession.h>