@regulaforensics/face-sdk 7.2.408-rc → 7.2.414-beta

package/examples/react_native/src/main.tsx

@@ -1,14 +1,21 @@
-import { document } from '../index'
-import * as RNFS from 'react-native-fs'
-import { Alert, Platform } from 'react-native'
-import { launchImageLibrary } from 'react-native-image-picker'
 import { FaceSDK, MatchFacesRequest, MatchFacesImage, InitConfig, LivenessSkipStep, ImageType, LivenessStatus, LivenessConfig } from '@regulaforensics/face-sdk'
+import { loadAssetIfExists, chooseOption, pickImage } from '../index'
+
+var faceSdk = FaceSDK.instance
+var image1: MatchFacesImage | null
+var image2: MatchFacesImage | null
 
 async function init() {
-  if (!await initialize()) return
+  if (!await initializeReader()) return
   setStatus("Ready")
 }
 
+async function startFaceCapture(position: number) {
+  var image = (await faceSdk.startFaceCapture()).image
+  if (image == null) return
+  setImage("data:image/png;base64," + image.image, image.imageType, position)
+}
+
 async function startLiveness() {
   var response = await faceSdk.startLiveness({
     config: new LivenessConfig({
@@ -19,7 +26,7 @@ async function startLiveness() {
     }
   })
   if (response.image == null) return
-  setImage(response.image, ImageType.LIVE, 1)
+  setImage("data:image/png;base64," + response.image, ImageType.LIVE, 1)
   setLivenessStatus(response.liveness == LivenessStatus.PASSED ? "passed" : "unknown")
 }
 
@@ -39,18 +46,34 @@ async function matchFaces() {
   setStatus("Ready")
 }
 
-function clearResults() {
-  setStatus("Ready")
+async function getImage(position: number) {
+  var source = await chooseOption()
+  if (source == null) return
+  if (source) startFaceCapture(position)
+  else {
+    var image = await pickImage()
+    if (image == null) return
+    setImage(image, ImageType.PRINTED, position)
+  }
+}
+
+function setImage(base64: string, type: number, position: number) {
   setSimilarityStatus("null")
-  setLivenessStatus("null")
-  resetImages()
-  image1 = null
-  image2 = null
+  var mfImage = new MatchFacesImage(base64, type)
+  if (position == 1) {
+    image1 = mfImage
+    setUiImage1(base64)
+    setLivenessStatus("null")
+  }
+  if (position == 2) {
+    image2 = mfImage
+    setUiImage2(base64)
+  }
 }
 
 // If 'regula.license' exists, init using license(enables offline match)
 // otherwise init without license.
-async function initialize() {
+async function initializeReader() {
   setStatus("Initializing...")
 
   var license = await loadAssetIfExists("regula.license")
@@ -58,82 +81,36 @@ async function initialize() {
   if (license != null) config = new InitConfig(license)
   var [success, error] = await faceSdk.initialize({ config: config })
 
-  if (!success && error != null) {
+  if (error != null) {
     setStatus(error.message)
     console.log(error.code + ": " + error.message)
   }
   return success
 }
 
-function setImage(base64: string, type: number, position: number) {
-  setSimilarityStatus("null")
-  var mfImage = new MatchFacesImage(base64, type)
-  if (position == 1) {
-    image1 = mfImage
-    setUiImage1("data:image/png;base64," + base64)
-    setLivenessStatus("null")
-  }
-  if (position == 2) {
-    image2 = mfImage
-    setUiImage2("data:image/png;base64," + base64)
-  }
-}
-
-async function useCamera(position: number) {
-  var response = await faceSdk.startFaceCapture()
-  if (response.image == null) return
-  var image = response.image
-  setImage(image.image, image.imageType, position)
-}
+// --------------------------------------------------------------------------------------------------------------------
 
-function useGallery(position: number) {
-  launchImageLibrary({
-    mediaType: 'photo',
-    selectionLimit: 1,
-    includeBase64: true
-  }, (response: any) => {
-    if (response.assets == null) return
-    setImage(response.assets[0].base64!, ImageType.PRINTED, position)
-  })
-}
+export function main() {
+  document.getElementById("first-image")!.onclick = () => getImage(1)
+  document.getElementById("second-image")!.onclick = () => getImage(2)
+  document.getElementById("match-faces")!.onclick = () => matchFaces()
+  document.getElementById("start-liveness")!.onclick = () => startLiveness()
+  document.getElementById("clear-results")!.onclick = () => clearResults()
 
-function pickImage(position: number) {
-  Alert.alert("Select option", "", [
-    { text: "Use gallery", onPress: () => useGallery(position) },
-    { text: "Use camera", onPress: () => useCamera(position) }
-  ], { cancelable: true })
-}
-
-async function loadAssetIfExists(path: string): Promise<string | null> {
-  if (Platform.OS === 'ios') path = RNFS.MainBundlePath + "/" + path
-  var readFile = Platform.OS === 'ios' ? RNFS.readFile : RNFS.readFileRes
-  try {
-    return await readFile(path, 'base64')
-  } catch {
-    return null
-  }
+  init()
 }
 
-var faceSdk = FaceSDK.instance
-var image1: MatchFacesImage | null
-var image2: MatchFacesImage | null
-
-var setStatus = (data: string) => document.getElementById("status").innerHTML = data
-var setLivenessStatus = (data: string) => document.getElementById("liveness-status").innerHTML = data
-var setSimilarityStatus = (data: string) => document.getElementById("similarity-status").innerHTML = data
+var setStatus = (data: string) => document.getElementById("status")!.innerHTML = data
+var setLivenessStatus = (data: string) => document.getElementById("liveness-status")!.innerHTML = data
+var setSimilarityStatus = (data: string) => document.getElementById("similarity-status")!.innerHTML = data
 var setUiImage1 = (data: string) => (document.getElementById("first-image") as HTMLImageElement).src = data
 var setUiImage2 = (data: string) => (document.getElementById("second-image") as HTMLImageElement).src = data
-var resetImages = () => {
+var clearResults = () => {
+  setStatus("Ready")
+  setSimilarityStatus("null")
+  setLivenessStatus("null")
   setUiImage1("images/portrait.png")
   setUiImage2("images/portrait.png")
-}
-
-export function onload() {
-  document.getElementById("first-image").onclick = () => pickImage(1)
-  document.getElementById("second-image").onclick = () => pickImage(2)
-  document.getElementById("match-faces").onclick = () => matchFaces()
-  document.getElementById("start-liveness").onclick = () => startLiveness()
-  document.getElementById("clear-results").onclick = () => clearResults()
-
-  init()
+  image1 = null
+  image2 = null
 }

package/ios/RFSWJSONConstructor.h

@@ -52,7 +52,6 @@
 +(RFSImageQualityCharacteristic* _Nonnull)imageQualityCharacteristicFromJSON:(id _Nonnull)input;
 +(NSDictionary<NSString*, id>* _Nonnull)generateImageQualityCharacteristic:(RFSImageQualityCharacteristic* _Nonnull)input;
 
-+(RFSFaceSDKVersion* _Nonnull)faceSDKVersionFromJSON:(id _Nonnull)input;
 +(NSDictionary<NSString*, id>* _Nonnull)generateFaceSDKVersion:(RFSFaceSDKVersion* _Nonnull)input;
 
 +(RFSInitializationConfiguration* _Nonnull)initConfigFromJSON:(id _Nonnull)input;

package/ios/RFSWJSONConstructor.m

@@ -203,17 +203,7 @@
     return result;
 }
 
-+(id)faceSDKVersionFromJSON:(NSDictionary*)input {
-    if (!input || [input isEqual:[NSNull null]])  return nil;
-    RFSFaceSDKVersion* result = [RFSFaceSDKVersion new];
-    
-    [result setValue:input[@"api"] forKey:@"api"];
-    [result setValue:input[@"core"] forKey:@"core"];
-    [result setValue:input[@"coreMode"] forKey:@"coreMode"];
-    
-    return result;
-}
-
+// No fromJSON and no tests for FaceSDKVersion because of its implementation.
 +(id)generateFaceSDKVersion:(RFSFaceSDKVersion*)input {
     if (!input) return [NSNull null];
     NSMutableDictionary* result = @{}.mutableCopy;
@@ -291,9 +281,9 @@
 
 +(id)livenessResponseFromJSON:(NSDictionary*)input {
     RFSLivenessResponse* result = [RFSLivenessResponse alloc];
-    SEL sel = NSSelectorFromString(@"initWithTag:transactionId:estimatedAge:status:normalImage:scaledImage:error:");
+    SEL sel = NSSelectorFromString(@"initWithTag:transactionId:estimatedAge:status:image:error:");
     IMP imp = [result methodForSelector:sel];
-    void (*func)(id, SEL, id, id, id, NSInteger, id, id, id) = (void *)imp;
+    void (*func)(id, SEL, id, id, id, NSInteger, id, id) = (void *)imp;
     func(result,
          sel,
          input[@"tag"],
@@ -301,7 +291,6 @@
          input[@"estimatedAge"],
          [input[@"liveness"] integerValue],
          [self imageWithBase64:input[@"image"]],
-         [self imageWithBase64:input[@"image"]],
          nil);
     return result;
 }
@@ -893,6 +882,7 @@
                                                                           imageUpload:[self imageUploadFromJSON:input[@"imageUpload"]]];
     result.threshold = input[@"threshold"];
     result.limit = input[@"limit"];
+    result.tag = input[@"tag"];
     if (input[@"detectAll"] && ![input[@"detectAll"] isEqual:[NSNull null]]) result.detectAll = [input[@"detectAll"] boolValue];
     result.outputImageParams = [self outputImageParamsFromJSON:input[@"outputImageParams"]];
     return result;
@@ -906,6 +896,7 @@
     }.mutableCopy;
     if (input.threshold) result[@"threshold"] = input.threshold;
     if (input.limit) result[@"limit"] = input.limit;
+    if (input.tag) result[@"tag"] = input.tag;
     if (input.groupIdsForSearch) result[@"groupIdsForSearch"] = input.groupIdsForSearch;
     if (input.outputImageParams) result[@"outputImageParams"] = [self generateOutputImageParams:input.outputImageParams];
     return result;

package/ios/RFSWMain.m

@@ -9,6 +9,12 @@
         @"getVersion": ^{ [self getVersion :callback]; },
         @"getServiceUrl": ^{ [self getServiceUrl :callback]; },
         @"setServiceUrl": ^{ [self setServiceUrl :args[0] :callback]; },
+        @"getTenant": ^{ [self getTenant :callback]; },
+        @"setTenant": ^{ [self setTenant :args[0]]; },
+        @"getEnv": ^{ [self getEnv :callback]; },
+        @"setEnv": ^{ [self setEnv :args[0]]; },
+        @"getLocale": ^{ [self getLocale :callback]; },
+        @"setLocale": ^{ [self setLocale :args[0]]; },
         @"setLocalizationDictionary": ^{ [self setLocalizationDictionary :args[0]]; },
         @"setRequestHeaders": ^{ [self setRequestHeaders :args[0]]; },
         @"setCustomization": ^{ [self setCustomization :args[0]]; },
@@ -64,6 +70,30 @@ static NSDictionary* headers;
     callback(@"");
 }
 
++(void)getTenant:(RFSWCallback)callback {
+    callback([RFSFaceSDK.service tenant]);
+}
+
++(void)setTenant:(NSString*)tag {
+    [RFSFaceSDK.service setTenant:tag];
+}
+
++(void)getEnv:(RFSWCallback)callback {
+    callback([RFSFaceSDK.service env]);
+}
+
++(void)setEnv:(NSString*)tag {
+    [RFSFaceSDK.service setEnv:tag];
+}
+
++(void)getLocale:(RFSWCallback)callback {
+    callback([RFSFaceSDK.service languageLocaleCode]);
+}
+
++(void)setLocale:(NSString*)locale {
+    [RFSFaceSDK.service setLanguageLocaleCode:locale];
+}
+
 +(void)setLocalizationDictionary:(NSDictionary*)dictionary {
     RFSFaceSDK.service.localizationHandler = ^NSString* (NSString* localizationKey) {
         if (dictionary[localizationKey]) return dictionary[localizationKey];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@regulaforensics/face-sdk",
-  "version": "7.2.408-rc",
+  "version": "7.2.414-beta",
   "description": "This is an npm module for Regula Face SDK. It allows you to easily compaire faces using your phone's camera.",
   "main": "www/react-native/index.js",
   "module": "www/capacitor/index.js",

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="@regulaforensics/face-sdk" version="7.2.408-rc" xmlns="http://apache.org/cordova/ns/plugins/1.0">
+<plugin id="@regulaforensics/face-sdk" version="7.2.414-beta" xmlns="http://apache.org/cordova/ns/plugins/1.0">
   <name>FaceSDK</name>
   <description>Cordova plugin for Regula Face SDK</description>
   <license>commercial</license>
@@ -29,7 +29,7 @@
         <source url="https://github.com/CocoaPods/Specs.git" />
       </config>
       <pods>
-        <pod name="FaceSDKStage" spec="7.2.3010" />
+        <pod name="FaceSDKNightly" spec="7.1.3008" />
       </pods>
     </podspec>
   </platform>

package/test/json.tsx

@@ -0,0 +1,375 @@
+var img1 = 'data1'
+var img2 = 'data2'
+var img3 = 'data3'
+
+export var customJson = {"test1": true, "test2": 1, "test3": "test"}
+
+export var font1 = {"name": "AppleSDGothicNeo-Thin", "size": 10, "style": 2}
+export var font2 = {"name": "Copperplate-Light", "size": 20, "style": 1}
+export var customizationColors = {
+  "100": 0xff000000,
+  "101": 0xff000001,
+  "102": 0xff000002,
+  "103": 0xff000003,
+  "104": 0xff000004,
+  "105": 0xff000005,
+  "200": 0xff000006,
+  "201": 0xff000007,
+  "202": 0xff000008,
+  "203": 0xff000009,
+  "204": 0xff000010,
+  "205": 0xff000011,
+  "206": 0xff000012,
+  "207": 0xff000013,
+  "208": 0xff000014,
+  "209": 0xff000015,
+  "300": 0xff000016,
+  "301": 0xff000017,
+  "302": 0xff000018,
+  "303": 0xff000019,
+  "304": 0xff000020,
+  "305": 0xff000021,
+  "400": 0xff000022,
+  "401": 0xff000023,
+  "402": 0xff000024,
+  "500": 0xff000025,
+}
+export var customizationFonts = {
+  "100": font1,
+  "101": font2,
+  "102": font1,
+  "103": font2,
+  "200": font1,
+  "300": font2,
+  "301": font1,
+  "302": font2,
+  "303": font1,
+  "400": font2,
+}
+export var customizationImages = {
+  "100": img1,
+  "101": img2,
+  "102": img3,
+  "103": img1,
+  "200": img2,
+  "201": img3,
+  "202": img1,
+  "203": img2,
+  "300": img3,
+  "301": img1,
+  "302": img2,
+  "400": img3,
+  "500": img1,
+}
+export var customization = {
+  "colors": customizationColors,
+  "fonts": customizationFonts,
+  "images": customizationImages,
+  "uiCustomizationLayer": customJson
+}
+
+export var point = {
+  "x": 0,
+  "y": 1,
+}
+export var rect = {
+  "left": 0,
+  "top": 1,
+  "right": 2,
+  "bottom": 3,
+}
+export var size = {
+  "width": 68,
+  "height": 91,
+}
+export var outputImageCrop = {
+  "type": 0,
+  "size": size,
+  "padColor": 0xff000000,
+  "returnOriginalRect": true
+}
+export var outputImageParams = {
+  "crop": outputImageCrop,
+  "backgroundColor": 0xff000000,
+}
+
+export var imageQualityRange = {
+  "min": 0.45,
+  "max": 0.55,
+}
+export var imageQualityResult = {
+  "group": 1,
+  "name": "ImageWidth",
+  "status": 0,
+  "value": 0.5,
+  "range": imageQualityRange,
+}
+export var imageQualityCharacteristic = {
+  "characteristicName": "FaceMidPointHorizontalPosition",
+  "recommendedRange": imageQualityRange,
+}
+
+export var detectFacesAttributeResult = {
+  "attribute": "Age",
+  "confidence": 0.5,
+  "value": "test",
+  "range": imageQualityRange,
+}
+export var detectFaceResult = {
+  "quality": [imageQualityResult, imageQualityResult, imageQualityResult],
+  "crop": img1,
+  "attributes": [
+    detectFacesAttributeResult,
+    detectFacesAttributeResult,
+    detectFacesAttributeResult
+  ],
+  "landmarks": [point, point, point],
+  "faceRect": rect,
+  "originalRect": rect,
+  "isQualityCompliant": false,
+}
+export var detectFacesConfig = {
+  "attributes": ["Age", "EyeRight", "EyeLeft"],
+  "customQuality": [
+    imageQualityCharacteristic,
+    imageQualityCharacteristic,
+    imageQualityCharacteristic
+  ],
+  "outputImageParams": outputImageParams,
+  "onlyCentralFace": true,
+}
+export var detectFacesRequest = {
+  "tag": "test",
+  // "scenario": "CropCentralFace",
+  "image": img1,
+  "configuration": detectFacesConfig,
+}
+export var detectFacesBackendException = {
+  "code": 2,
+  "message": "test",
+}
+export var detectFacesException = {
+  "code": 0,
+  "message": "In process already.",
+  "underlyingError": detectFacesBackendException
+}
+export var detectFacesResponse = {
+  "detection": detectFaceResult,
+  "allDetections": [detectFaceResult, detectFaceResult, detectFaceResult],
+  "scenario": "CropCentralFace",
+  "error": detectFacesException,
+}
+
+export var faceCaptureConfig = {
+  "copyright": true,
+  "cameraSwitchEnabled": false,
+  "closeButtonEnabled": true,
+  "torchButtonEnabled": false,
+  "vibrateOnSteps": true,
+  "detectOcclusion": false,
+  "showFaceAnimation": true,
+  "cameraPositionAndroid": 0,
+  "cameraPositionIOS": 1,
+  "screenOrientation": [0, 1],
+  "timeout": 0.5,
+  "holdStillDuration": 1.5,
+}
+export var faceCaptureImage = {
+  "image": img1,
+  "imageType": 1,
+  "tag": "test",
+}
+export var faceCaptureException = {
+  "code": 0,
+  "message": "Cancelled by user.",
+}
+export var faceCaptureResponse = {
+  "image": faceCaptureImage,
+  "error": faceCaptureException,
+}
+
+export var faceSDKVersion = {
+  "api": "test1",
+  "core": "test2",
+  "coreMode": "test3",
+}
+export var initConfig = {
+  "license": img1,
+  "licenseUpdate": true,
+  "useBleDevice": false,
+}
+export var licenseException = {
+  "code": 0,
+  "message": "",
+}
+export var initException = {
+  "code": 0,
+  "message": "In process already.",
+  "underlyingError": licenseException
+}
+
+export var livenessConfig = {
+  "copyright": true,
+  "cameraSwitchEnabled": false,
+  "closeButtonEnabled": true,
+  "torchButtonEnabled": false,
+  "vibrateOnSteps": true,
+  "cameraPositionAndroid": -1,
+  "cameraPositionIOS": 1,
+  "screenOrientation": [0, 1],
+  "locationTrackingEnabled": true,
+  "attemptsCount": 2,
+  "recordingProcess": 0,
+  "livenessType": 1,
+  "tag": "test",
+  "skipStep": [0, 1],
+  "metadata": customJson,
+}
+export var livenessBackendException = {
+  "code": 200,
+  "message": "No license",
+}
+export var livenessException = {
+  "code": 0,
+  "message": "FaceSDK Core is not initialized",
+  "underlyingError": livenessBackendException
+}
+export var livenessResponse = {
+  "image": img1,
+  "liveness": 0,
+  "tag": "test",
+  "transactionId": "test1",
+  "estimatedAge": 1,
+  "error": livenessException,
+}
+export var livenessNotification = {
+  "status": 0,
+  "response": livenessResponse,
+}
+
+export var matchFacesConfig = {
+  "processingMode": 0,
+  "locationTrackingEnabled": false,
+}
+export var matchFacesImage = {
+  "image": img1,
+  "imageType": 1,
+  "detectAll": true,
+  "identifier": "test"
+}
+export var matchFacesRequest = {
+  "images": [matchFacesImage, matchFacesImage, matchFacesImage],
+  "outputImageParams": outputImageParams,
+  "tag": "test",
+  "metadata": customJson,
+}
+export var matchFacesDetectionFace = {
+  "faceIndex": 0,
+  "landmarks": [point, point, point],
+  "faceRect": rect,
+  "rotationAngle": 0.5,
+  "originalRect": rect,
+  "crop": img1,
+}
+export var matchFacesBackendException = {"code": 0, "message": "Image is empty."}
+export var matchFacesException = {
+  "code": 0,
+  "message": "Image is empty.",
+  "underlyingError": matchFacesBackendException,
+}
+export var matchFacesDetection = {
+  "imageIndex": 0,
+  "image": matchFacesImage,
+  "faces": [
+    matchFacesDetectionFace,
+    matchFacesDetectionFace,
+    matchFacesDetectionFace
+  ],
+  "error": matchFacesException,
+}
+export var comparedFace = {
+  "imageIndex": 0,
+  "image": matchFacesImage,
+  "faceIndex": 1,
+  "face": matchFacesDetectionFace,
+}
+export var comparedFacesPair = {
+  "first": comparedFace,
+  "second": comparedFace,
+  "similarity": 0.5,
+  "score": 1.5,
+  "error": matchFacesException,
+}
+export var matchFacesResponse = {
+  "results": [comparedFacesPair, comparedFacesPair, comparedFacesPair],
+  "detections": [matchFacesDetection, matchFacesDetection, matchFacesDetection],
+  "tag": "test",
+  "error": matchFacesException,
+}
+export var comparedFacesSplit = {
+  "matchedFaces": [comparedFacesPair, comparedFacesPair, comparedFacesPair],
+  "unmatchedFaces": [comparedFacesPair, comparedFacesPair, comparedFacesPair],
+}
+
+export var editGroupPersonsRequest = {
+  "personIdsToAdd": ["test1", "test2", "test3"],
+  "personIdsToRemove": ["test4", "test5", "test6"],
+}
+export var imageUpload = {"imageData": img1}
+export var person = {
+  "name": "test1",
+  "updatedAt": "1969-07-20 20:18:04.000",
+  "groups": ["test1", "test2", "test3"],
+  "id": "test3",
+  "metadata": customJson,
+  "createdAt": "1969-07-20 20:18:05.000",
+}
+export var personGroup = {
+  "name": "test1",
+  "id": "test3",
+  "metadata": customJson,
+  "createdAt": "1969-07-20 20:18:04.000",
+}
+export var personImage = {
+  "path": "test",
+  "url": "test1",
+  "contentType": "test2",
+  "id": "test3",
+  "metadata": customJson,
+  "createdAt": "1969-07-20 20:18:04.000",
+}
+export var searchPersonDetection = {
+  "landmarks": [point, point, point],
+  "rect": rect,
+  "crop": img1,
+  "rotationAngle": 0.5,
+}
+export var searchPersonImage = {
+  "similarity": 0.5,
+  "distance": 1.5,
+  "path": "test",
+  "url": "test1",
+  "contentType": "test2",
+  "id": "test3",
+  "metadata": customJson,
+  "createdAt": "1969-07-20 20:18:04.000",
+}
+export var searchPerson = {
+  "images": [searchPersonImage, searchPersonImage, searchPersonImage],
+  "detection": searchPersonDetection,
+  "name": "test1",
+  "updatedAt": "1969-07-20 20:18:04.000",
+  "groups": ["test1", "test2", "test3"],
+  "id": "test3",
+  "metadata": customJson,
+  "createdAt": "1969-07-20 20:18:05.000",
+}
+export var searchPersonRequest = {
+  "imageUpload": imageUpload,
+  "groupIdsForSearch": ["test1", "test2", "test3"],
+  "threshold": 0.5,
+  "limit": 1,
+  "tag": "test",
+  "detectAll": true,
+  "outputImageParams": outputImageParams,
+}