@regulaforensics/react-native-document-reader-api 6.3.0 → 6.5.0

package/ios/RGLWJSONConstructor.h

@@ -12,6 +12,8 @@
 +(NSMutableDictionary* _Nonnull)generateNSDictionary:(NSDictionary<NSNumber*, NSNumber*>* _Nullable)input;
 +(RGLPKDCertificate* _Nullable)RGLPKDCertificateFromJson:(NSDictionary* _Nullable) dict;
 +(RGLTCCParams* _Nonnull)RGLTCCParamsFromJson:(NSDictionary* _Nonnull)input;
++(RGLConfig* _Nullable)RGLConfigFromJson:(NSDictionary* _Nonnull)input;
++(RGLImageInput* _Nonnull)RGLImageInputFromJson:(NSDictionary* _Nonnull)input;
 +(NSInteger)generateDocReaderAction:(RGLDocReaderAction)action;
 +(NSInteger)generateRFIDCompleteAction:(RGLRFIDCompleteAction)action;
 +(NSInteger)generateRFIDNotificationAction:(RGLRFIDNotificationAction)action;

package/ios/RGLWJSONConstructor.m

@@ -35,6 +35,42 @@
     return [[RGLTCCParams alloc] initWithServiceTAURLString:serviceTAURLString servicePAURLString:servicePAURLString pfxCertURLString:pfxCertURLString pfxCertData: pfxCertData pfxPassPhrase:pfxPassPhrase];
 }
 
++(RGLConfig*)RGLConfigFromJson:(NSDictionary*)input {
+    NSData* license;
+    if([input valueForKey:@"license"] != nil)
+        license = [[NSData alloc] initWithBase64EncodedString:[input valueForKey:@"license"] options:0];
+    else return nil;
+
+    RGLConfig *config = [[RGLConfig alloc] initWithLicenseData:license];
+
+    if([input valueForKey:@"databasePath"] != nil){
+        config.databasePath = [[input valueForKey:@"databasePath"] stringValue];
+    }
+    if([input valueForKey:@"licenseUpdate"] != nil){
+        config.licenseUpdateCheck = [[input valueForKey:@"licenseUpdate"] boolValue];
+    }
+    if([input valueForKey:@"delayedNNLoad"] != nil){
+        config.delayedNNLoadEnabled = [[input valueForKey:@"delayedNNLoad"] boolValue];
+    }
+
+    return config;
+}
+
+
++(RGLImageInput*)RGLImageInputFromJson:(NSDictionary*)input {
+    NSInteger pageIndex = 0;
+    if([input valueForKey:@"pageIndex"] != nil)
+        pageIndex = [[input valueForKey:@"pageIndex"] integerValue];
+    NSInteger light = 6;
+    if([input valueForKey:@"light"] != nil)
+        pageIndex = [[input valueForKey:@"light"] integerValue];
+    if([input valueForKey:@"bitmap"] != nil){
+        UIImage* image = [UIImage imageWithData:[[NSData alloc]initWithBase64EncodedString:[input valueForKey:@"bitmap"] options:NSDataBase64DecodingIgnoreUnknownCharacters]];
+        return [[RGLImageInput alloc] initWithImage:image light:light pageIndex:pageIndex];
+    }
+    return nil;
+}
+
 +(NSMutableDictionary*)generateCGPoint:(CGPoint)input {
     NSMutableDictionary *result = [NSMutableDictionary new];
 
@@ -107,6 +143,9 @@
         case RGLDocReaderActionError:
             result = 3;
             break;
+        case RGLDocReaderActionProcessTimeout:
+            result = 10;
+            break;
         default:
             break;
     }
@@ -118,7 +157,7 @@
     NSInteger result = 0;
     switch (input) {
         case RGLRFIDCompleteActionComplete:
-            result = 10;
+            result = 999;
             break;
         case RGLRFIDCompleteActionError:
             result = 3;
@@ -136,6 +175,29 @@
     return result;
 }
 
++(NSNumber*)generateRGLImageQualityCheckType:(RGLImageQualityCheckType)value {
+    if(value == RGLImageQualityCheckTypeImageGlares)
+        return @0;
+    else if(value == RGLImageQualityCheckTypeImageFocus)
+        return @1;
+    else if(value == RGLImageQualityCheckTypeImageResolution)
+        return @2;
+    else if(value == RGLImageQualityCheckTypeImageColorness)
+        return @3;
+    else if(value == RGLImageQualityCheckTypeImagePerspective)
+        return @4;
+    else if(value == RGLImageQualityCheckTypeImageBounds)
+        return @5;
+    else if(value == RGLImageQualityCheckTypeScreenCapture)
+        return @6;
+    else if(value == RGLImageQualityCheckTypePortrait)
+        return @7;
+    else if(value == RGLImageQualityCheckTypeHandwritten)
+        return @8;
+    else
+        return @0;
+}
+
 +(NSInteger)generateRFIDNotificationAction:(RGLRFIDNotificationAction)input {
     return 5;
 }
@@ -155,6 +217,9 @@
         case 3:
             result[@"results"] = [self generateRGLDocumentReaderResults:results];
             break;
+        case 10:
+            result[@"results"] = [self generateRGLDocumentReaderResults:results];
+            break;
         case 5:
             result[@"results"] = [self generateResultsWithNotification:[self generateRGLRFIDNotify:notify]];
             break;
@@ -164,7 +229,7 @@
         case 8:
             result[@"results"] = [self generateRGLDocumentReaderResults:results];
             break;
-        case 10:
+        case 999:
             result[@"results"] = [self generateResultsWithRFID :results :1];
             action = 1;
             break;
@@ -251,11 +316,9 @@
                 [array addObject:[self generateRGLImageQualityGroup:item]];
         result[@"imageQuality"] = array;
     }
-    result[@"overallResult"] = @(input.overallResult);
     result[@"authenticityResult"] = [self generateRGLDocumentReaderAuthenticityResult:input.authenticityResults];
     result[@"rfidSessionData"] = [self generateRGLRFIDSessionData:input.rfidSessionData];
     result[@"chipPage"] = @(input.chipPage);
-    result[@"resolutionType"] = @(input.resolutionType);
     result[@"barcodeResult"] = [self generateRGLDocumentReaderBarcodeResult:input.barcodeResult];
     result[@"processingFinishedStatus"] = @(input.processingFinishedStatus);
     result[@"morePagesAvailable"] = @(input.morePagesAvailable);
@@ -400,7 +463,7 @@
     NSMutableDictionary *result = [NSMutableDictionary new];
     if(input == nil) return result;
 
-    result[@"type"] = input.type;
+    result[@"type"] = [self generateRGLImageQualityCheckType:input.type];
     result[@"result"] = @(input.result);
     result[@"featureType"] = @(input.featureType);
     result[@"boundRects"] = [self generateNSArrayCGRect:input.boundRects];
@@ -571,7 +634,6 @@
     result[@"status"] = @(input.status);
     result[@"extLeSupport"] = @(input.extLeSupport);
     result[@"processTime"] = @(input.processTime);
-    result[@"sessionDataStatus"] = [self generateRGLRFIDSessionDataStatus:input.sessionDataStatus];
 
     return result;
 }

package/ios/RNRegulaDocumentReader.m

@@ -170,6 +170,8 @@ RCT_EXPORT_METHOD(exec:(NSString*)moduleName:(NSString*)action:(NSArray*)args:(R
         [self startRFIDReader :successCallback :errorCallback];
     else if([action isEqualToString:@"stopRFIDReader"])
         [self stopRFIDReader :successCallback :errorCallback];
+    else if([action isEqualToString:@"stopRFIDReaderWithErrorMessage"])
+        [self stopRFIDReaderWithErrorMessage :[args objectAtIndex:0] :successCallback :errorCallback];
     else if([action isEqualToString:@"stopScanner"])
         [self stopScanner :successCallback :errorCallback];
     else if([action isEqualToString:@"deinitializeReader"])
@@ -226,6 +228,8 @@ RCT_EXPORT_METHOD(exec:(NSString*)moduleName:(NSString*)action:(NSArray*)args:(R
         [self prepareDatabase :[args objectAtIndex:0] :successCallback :errorCallback];
     else if([action isEqualToString:@"recognizeImage"])
         [self recognizeImage :[args objectAtIndex:0] :successCallback :errorCallback];
+    else if([action isEqualToString:@"recognizeData"])
+        [self recognizeData :[args objectAtIndex:0] :successCallback :errorCallback];
     else if([action isEqualToString:@"setRfidSessionStatus"])
         [self setRfidSessionStatus :[args objectAtIndex:0] :successCallback :errorCallback];
     else if([action isEqualToString:@"providePACertificates"])
@@ -238,20 +242,16 @@ RCT_EXPORT_METHOD(exec:(NSString*)moduleName:(NSString*)action:(NSArray*)args:(R
         [self parseCoreResults :[args objectAtIndex:0] :successCallback :errorCallback];
     else if([action isEqualToString:@"setTCCParams"])
         [self setTCCParams :[args objectAtIndex:0] :successCallback :errorCallback];
-    else if([action isEqualToString:@"initializeReaderWithDatabase"])
-        [self initializeReaderWithDatabase :[args objectAtIndex:0] :[args objectAtIndex:1] :successCallback :errorCallback];
-    else if([action isEqualToString:@"recognizeImageFrame"])
-        [self recognizeImageFrame :[args objectAtIndex:0] :[args objectAtIndex:1] :successCallback :errorCallback];
     else if([action isEqualToString:@"recognizeImageWithOpts"])
         [self recognizeImageWithOpts :[args objectAtIndex:0] :[args objectAtIndex:1] :successCallback :errorCallback];
     else if([action isEqualToString:@"recognizeVideoFrame"])
         [self recognizeVideoFrame :[args objectAtIndex:0] :[args objectAtIndex:1] :successCallback :errorCallback];
     else if([action isEqualToString:@"showScannerWithCameraIDAndOpts"])
         [self showScannerWithCameraIDAndOpts :[args objectAtIndex:0] :[args objectAtIndex:1] :successCallback :errorCallback];
-    else if([action isEqualToString:@"recognizeImageWithImageInputParams"])
-        [self recognizeImageWithImageInputParams :[args objectAtIndex:0] :[args objectAtIndex:1] :successCallback :errorCallback];
     else if([action isEqualToString:@"recognizeImageWithCameraMode"])
         [self recognizeImageWithCameraMode :[args objectAtIndex:0] :[args objectAtIndex:1] :successCallback :errorCallback];
+    else if([action isEqualToString:@"recognizeImagesWithImageInputs"])
+        [self recognizeImagesWithImageInputs :[args objectAtIndex:0] :successCallback :errorCallback];
     else
         [self result:[NSString stringWithFormat:@"%@/%@", @"method not implemented: ", action] :errorCallback];
 }
@@ -274,8 +274,10 @@ RCT_EXPORT_METHOD(exec:(NSString*)moduleName:(NSString*)action:(NSArray*)args:(R
     [self result:@"showScannerWithCameraID() is an android-only method" :errorCallback];
 }
 
-- (void) recognizeImageFrame:(NSString*)base64 :(NSDictionary*)opts :(Callback)successCallback :(Callback)errorCallback{
-    [self result:@"recognizeImageFrame() is an android-only method" :errorCallback];
+- (void) stopRFIDReaderWithErrorMessage:(NSMutableString*)message :(Callback)successCallback :(Callback)errorCallback{
+    [RGLDocReader.shared stopRFIDReaderWithErrorMessage:message completion:^() {
+        [self result:@"" :successCallback];
+    }];
 }
 
 - (void) recognizeImageWithOpts:(NSString*)base64 :(NSDictionary*)opts :(Callback)successCallback :(Callback)errorCallback{
@@ -290,20 +292,12 @@ RCT_EXPORT_METHOD(exec:(NSString*)moduleName:(NSString*)action:(NSArray*)args:(R
     [self result:@"showScannerWithCameraIDAndOpts() is an android-only method" :errorCallback];
 }
 
-- (void) recognizeImageWithImageInputParams:(NSString*)base64 :(NSDictionary*)params :(Callback)successCallback :(Callback)errorCallback{
-    [self result:@"recognizeImageWithImageInputParams() is an android-only method" :errorCallback];
-}
-
 - (void) getLicenseMessage:(Callback)successCallback :(Callback)errorCallback{
     [self result:@"getLicenseMessage() is an android-only method" :successCallback];
 }
 
-- (void) initializeReaderWithDatabase:(NSString*)licenseString :(NSString*)databaseString :(Callback)successCallback :(Callback)errorCallback{
-    [self result:@"initializeReaderWithDatabase() is an android-only method" :successCallback];
-}
-
-- (void) initializeReader:(NSString*)licenseString :(Callback)successCallback :(Callback)errorCallback{
-    [RGLDocReader.shared initializeReaderWithConfig:[RGLConfig configWithLicenseData:[[NSData alloc] initWithBase64EncodedString:licenseString options:0]] completion:[self getInitCompletion :successCallback :errorCallback]];
+- (void) initializeReader:(NSDictionary*)config :(Callback)successCallback :(Callback)errorCallback{
+    [RGLDocReader.shared initializeReaderWithConfig:[RGLWJSONConstructor RGLConfigFromJson:config] completion:[self getInitCompletion :successCallback :errorCallback]];
 }
 
 - (void) parseCoreResults:(NSString*)json :(Callback)successCallback :(Callback)errorCallback{
@@ -350,6 +344,10 @@ RCT_EXPORT_METHOD(exec:(NSString*)moduleName:(NSString*)action:(NSArray*)args:(R
     [self recognizeImageWith :base64 :false :successCallback :errorCallback];
 }
 
+- (void) recognizeData:(NSString*)data :(Callback)successCallback :(Callback)errorCallback{
+    [RGLDocReader.shared recognizeData :[[NSData alloc] initWithBase64EncodedString:data options:0] completion:[self getCompletion]];
+}
+
 - (void) recognizeImages:(NSArray*)input :(Callback)successCallback :(Callback)errorCallback{
         NSMutableArray<UIImage*>* images = [[NSMutableArray alloc] init];
         for(__strong NSMutableString* base64 in input)
@@ -359,6 +357,15 @@ RCT_EXPORT_METHOD(exec:(NSString*)moduleName:(NSString*)action:(NSArray*)args:(R
         });
 }
 
+- (void) recognizeImagesWithImageInputs:(NSArray*)input :(Callback)successCallback :(Callback)errorCallback{
+        NSMutableArray<RGLImageInput*>* images = [[NSMutableArray alloc] init];
+        for(__strong NSDictionary* image in input)
+            [images addObject:[RGLWJSONConstructor RGLImageInputFromJson: image]];
+        dispatch_async(dispatch_get_main_queue(), ^{
+            [RGLDocReader.shared recognizeImagesWithImageInputs:images completion:[self getCompletion]];
+        });
+}
+
 - (void) recognizeImageWithCameraMode:(NSMutableString*)base64 :(BOOL)cameraMode :(Callback)successCallback :(Callback)errorCallback{
     [self recognizeImageWith :base64 :cameraMode :successCallback :errorCallback];
 }

package/ios/RegulaConfig.m

@@ -447,6 +447,37 @@
     return group;
 }
 
++(RGLOnlineProcessingConfig*)RGLOnlineProcessingConfigFromJSON:(NSDictionary*)dict {
+    if([dict valueForKey:@"mode"] == nil) return nil;
+
+    RGLOnlineProcessingConfig *result = [[RGLOnlineProcessingConfig alloc] initWithMode:[[dict valueForKey:@"mode"] integerValue]];
+
+    if([dict valueForKey:@"imageFormat"] != nil)
+        result.imageFormat = [[dict valueForKey:@"imageFormat"] integerValue];
+    if([dict valueForKey:@"url"] != nil)
+        result.serviceURL = [dict valueForKey:@"url"];
+    if([dict valueForKey:@"imageCompressionQuality"] != nil)
+        result.imageCompressionQuality = [[dict valueForKey:@"imageCompressionQuality"] floatValue];
+    if([dict valueForKey:@"processParams"] != nil) {
+        RGLProcessParams *params = [RGLProcessParams new];
+        [self setProcessParams:[dict valueForKey:@"processParams"] :params];
+        result.processParams = params;
+    }
+
+    return result;
+}
+
++(RGLReprocParams*)RGLReprocParamsFromJSON:(NSDictionary*)dict {
+    RGLReprocParams *result = [RGLReprocParams new];
+
+    if([dict valueForKey:@"serviceUrl"] != nil)
+        result.serviceURL = [dict valueForKey:@"serviceUrl"];
+    if([dict valueForKey:@"failIfNoService"] != nil)
+        result.failIfNoService = [dict valueForKey:@"failIfNoService"];
+
+    return result;
+}
+
 +(void)setCustomization:(NSDictionary*)options :(RGLCustomization*)customization {
     if([options valueForKey:@"cameraFrameBorderWidth"] != nil)
         customization.cameraFrameBorderWidth = [[options valueForKey:@"cameraFrameBorderWidth"] floatValue];
@@ -550,6 +581,8 @@
         customization.hologramAnimationPositionMultiplier = [[options valueForKey:@"hologramAnimationPositionMultiplier"] floatValue];
     if([options valueForKey:@"hologramAnimationImage"] != nil)
         customization.hologramAnimationImage = [self imageFromBase64:[options valueForKey:@"hologramAnimationImage"]];
+    if([options valueForKey:@"uiCustomizationLayer"] != nil)
+        customization.customUILayerJSON = [options valueForKey:@"uiCustomizationLayer"];
 }
 
 +(void)setFunctionality:(NSDictionary*)options :(RGLFunctionality*)functionality {
@@ -588,10 +621,6 @@
         functionality.singleResult = [[options valueForKey:@"singleResult"] boolValue];
     if([options valueForKey:@"cameraPosition"] != nil)
         functionality.cameraPosition = [self AVCaptureDevicePositionWithNSInteger:[[options valueForKey:@"cameraPosition"] integerValue]];
-    if([options valueForKey:@"onlineMode"] != nil)
-        functionality.onlineMode = [[options valueForKey:@"onlineMode"] boolValue];
-    if([options valueForKey:@"serviceURL"] != nil)
-        functionality.serviceURL = [[options valueForKey:@"serviceURL"] stringValue];
     if([options valueForKey:@"btDeviceName"] != nil)
         functionality.btDeviceName = [[options valueForKey:@"btDeviceName"] stringValue];
     if([options valueForKey:@"useAuthenticator"] != nil)
@@ -612,6 +641,8 @@
         functionality.recordScanningProcess = [[options valueForKey:@"recordScanningProcess"] boolValue];
     if([options valueForKey:@"manualMultipageMode"] != nil)
         functionality.manualMultipageMode = [[options valueForKey:@"manualMultipageMode"] boolValue];
+    if([options valueForKey:@"onlineProcessingConfiguration"] != nil)
+        functionality.onlineProcessingConfig = [self RGLOnlineProcessingConfigFromJSON:[options valueForKey:@"onlineProcessingConfiguration"]];;
 }
 
 +(void)setProcessParams:(NSDictionary*)options :(RGLProcessParams*)processParams {
@@ -755,6 +786,7 @@
     result[@"toolbarSize"] = [NSNumber numberWithFloat:customization.toolbarSize];
     result[@"hologramAnimationImageContentMode"] = [NSNumber numberWithInteger:[self NSIntegerWithUIViewContentMode:customization.hologramAnimationImageContentMode]];
     result[@"hologramAnimationPositionMultiplier"] = [NSNumber numberWithFloat:customization.hologramAnimationPositionMultiplier];
+    result[@"uiCustomizationLayer"] = customization.customUILayerJSON;
     result[@"hologramAnimationImage"] = [UIImageJPEGRepresentation(customization.hologramAnimationImage, 1.0) base64EncodedStringWithOptions:0];
     if(customization.customLabelStatus != nil)
         result[@"customLabelStatus"] = customization.customLabelStatus.string;
@@ -794,8 +826,6 @@
     result[@"videoSessionPreset"] = [NSNumber numberWithInteger:[self NSIntegerWithAVCaptureSessionPreset:functionality.videoSessionPreset]];
     result[@"videoCaptureMotionControl"] = [NSNumber numberWithBool:functionality.videoCaptureMotionControl];
     result[@"orientation"] = [NSNumber numberWithInteger:[self NSIntegerWithUIInterfaceOrientationMask:functionality.orientation]];
-    result[@"onlineMode"] = [NSNumber numberWithBool:functionality.onlineMode];
-    result[@"serviceURL"] = functionality.serviceURL;
     result[@"cameraPosition"] = [NSNumber numberWithInteger:[self NSIntegerWithAVCaptureDevicePosition:functionality.cameraPosition]];
     result[@"btDeviceName"] = functionality.btDeviceName;
     result[@"useAuthenticator"] = [NSNumber numberWithBool:functionality.isUseAuthenticator];
@@ -966,6 +996,10 @@
         rfidScenario.authorizedInstallCert = [[options valueForKey:@"authorizedInstallCert"] boolValue];
     if([options valueForKey:@"authorizedInstallQCert"] != nil)
         rfidScenario.authorizedInstallQCert = [[options valueForKey:@"authorizedInstallQCert"] boolValue];
+    if([options valueForKey:@"reprocessParams"] != nil)
+        rfidScenario.reprocParams = [self RGLReprocParamsFromJSON: [options valueForKey:@"reprocessParams"]];
+    if([options valueForKey:@"defaultReadingBufferSize"] != nil)
+        rfidScenario.defaultReadingBufferSize = [[options valueForKey:@"defaultReadingBufferSize"] intValue];
 }
 
 @end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/react-native-document-reader-api",
-  "version": "6.3.0",
+  "version": "6.5.0",
   "description": "React Native module for reading and validation of identification documents (API framework)",
   "main": "index.js",
   "scripts": {