3.2.0

Author: Jenkins

README.md

@@ -22,7 +22,7 @@ $ ionic cordova prepare
   * Run `ionic cordova run ios` inside example folder - this is just one way to run the app. You can also run it directly from within Xcode.
 
 ## Documentation
-You can find documentation on API [here](https://docs.regulaforensics.com/ionic-face).
+You can find documentation on API [here](https://docs.regulaforensics.com/develop/face-sdk/mobile).
 
 ## Additional information
 If you have any technical questions, feel free to [contact](mailto:support@regulaforensics.com) us or create issues [here](https://github.com/regulaforensics/ionic-native-face-api/issues).

example/package.json

@@ -31,8 +31,8 @@
     "cordova-ios": "^6.1.1",
     "cordova-plugin-add-swift-support": "^2.0.2",
     "cordova-plugin-android-permissions": "^1.1.0",
-    "@regulaforensics/cordova-plugin-face-api": "^3.1.0",
-    "@regulaforensics/ionic-native-face-api": "^3.1.0",
+    "@regulaforensics/cordova-plugin-face-api": "^3.2.0",
+    "@regulaforensics/ionic-native-face-api": "^3.2.0",
     "cordova-plugin-file": "^6.0.2",
     "cordova-plugin-telerik-imagepicker": "^2.3.5",
     "cordova-plugin-dialogs": "^2.0.2",

example/src/app/home/home.page.ts

@@ -4,10 +4,10 @@ import { ImagePicker } from '@ionic-native/image-picker/ngx'
 import { Dialogs } from '@ionic-native/dialogs/ngx'
 import { AndroidPermissions } from '@ionic-native/android-permissions/ngx'
 import { Platform } from '@ionic/angular'
-import { Enum, FaceCaptureResponse, LivenessResponse, MatchFacesResponse, MatchFacesRequest, Image, FaceSDK } from '@regulaforensics/ionic-native-face-api/ngx'
+import { Enum, FaceCaptureResponse, LivenessResponse, MatchFacesResponse, MatchFacesRequest, MatchFacesImage, FaceSDK, MatchFacesSimilarityThresholdSplit } from '@regulaforensics/ionic-native-face-api/ngx'
 
-var image1 = new Image()
-var image2 = new Image()
+var image1 = new MatchFacesImage()
+var image2 = new MatchFacesImage()
 
 @Component({
   selector: 'app-home',
@@ -41,7 +41,7 @@ export class HomePage {
       FaceSDK.startLiveness().then(result => {
         result = LivenessResponse.fromJson(JSON.parse(result))
         image1.bitmap = result.bitmap
-        image1.imageType = Enum.ImageType.IMAGE_TYPE_LIVE
+        image1.imageType = Enum.ImageType.LIVE
         app.img1.nativeElement.src = "data:image/png;base64," + result.bitmap
         app.livenessResult.nativeElement.innerHTML = result["liveness"] == 0 ? "passed" : "not passed"
       })
@@ -55,24 +55,26 @@ export class HomePage {
       request.images = [image1, image2]
       FaceSDK.matchFaces(JSON.stringify(request)).then(response => {
         response = MatchFacesResponse.fromJson(JSON.parse(response))
-        var matchedFaces = response.matchedFaces
-        app.similarityResult.nativeElement.innerHTML = matchedFaces.length > 0 ? ((matchedFaces[0].similarity * 100).toFixed(2) + "%") : "error"
+        FaceSDK.matchFacesSimilarityThresholdSplit(JSON.stringify(response.results), 0.75).then(str => {
+          var split = MatchFacesSimilarityThresholdSplit.fromJson(JSON.parse(str))
+          app.similarityResult.nativeElement.innerHTML = split.matchedFaces.length > 0 ? ((split.matchedFaces[0].similarity * 100).toFixed(2) + "%") : "error"
+        })
       })
     }
 
     function clearResults() {
       app.img1.nativeElement.src = "assets/img/portrait.png"
       app.img2.nativeElement.src = "assets/img/portrait.png"
-      image1 = new Image()
-      image2 = new Image()
+      image1 = new MatchFacesImage()
+      image2 = new MatchFacesImage()
       app.similarityResult.nativeElement.innerHTML = "nil"
       app.livenessResult.nativeElement.innerHTML = "nil"
     }
 
     function pickImage(first: boolean) {
       app.dialogs.confirm("Choose the option", "", ["Use camera", "Use gallery"]).then((button) => {
         if (button == 1)
-        FaceSDK.presentFaceCaptureActivity().then(result => setImage(first, FaceCaptureResponse.fromJson(JSON.parse(result)).image.bitmap, Enum.ImageType.IMAGE_TYPE_LIVE))
+        FaceSDK.presentFaceCaptureActivity().then(result => setImage(first, FaceCaptureResponse.fromJson(JSON.parse(result)).image.bitmap, Enum.ImageType.LIVE))
         else if (button == 2)
           if (app.platform.is("android"))
             useGalleryAndroid(first)
@@ -104,7 +106,7 @@ export class HomePage {
         File.readAsDataURL(
           (app.platform.is("ios") ? "file://" : "") + results[0].substring(0, (results[0] as string).lastIndexOf("/")),
           results[0].substring((results[0] as string).lastIndexOf("/") + 1)).then(
-            (file => setImage(first, (file as string).substring(23), Enum.ImageType.IMAGE_TYPE_PRINTED))
+            (file => setImage(first, (file as string).substring(23), Enum.ImageType.PRINTED))
           )
       })
     }

index.d.ts

@@ -14,24 +14,6 @@ export declare class MatchFacesException {
     message?: string;
     static fromJson(jsonObject?: any): MatchFacesException;
 }
-export declare class ComparedFacesPairException {
-    errorCode?: number;
-    message?: string;
-    static fromJson(jsonObject?: any): ComparedFacesPairException;
-}
-export declare class ComparedFace {
-    tag?: string;
-    imageType?: number;
-    position?: number;
-    static fromJson(jsonObject?: any): ComparedFace;
-}
-export declare class ComparedFacesPair {
-    first?: ComparedFace;
-    second?: ComparedFace;
-    similarity?: number;
-    exception?: ComparedFacesPairException;
-    static fromJson(jsonObject?: any): ComparedFacesPair;
-}
 export declare class FaceCaptureResponse {
     exception?: FaceCaptureException;
     image?: Image;
@@ -40,47 +22,98 @@ export declare class FaceCaptureResponse {
 export declare class LivenessResponse {
     bitmap?: string;
     liveness?: number;
+    guid?: string;
     exception?: LivenessErrorException;
     static fromJson(jsonObject?: any): LivenessResponse;
 }
 export declare class MatchFacesResponse {
     exception?: MatchFacesException;
-    matchedFaces?: ComparedFacesPair[];
-    unmatchedFaces?: ComparedFacesPair[];
+    detections?: MatchFacesDetection[];
+    results?: MatchFacesComparedFacesPair[];
     static fromJson(jsonObject?: any): MatchFacesResponse;
 }
 export declare class Image {
     imageType?: number;
-    tag?: string;
     bitmap?: string;
     static fromJson(jsonObject?: any): Image;
 }
 export declare class MatchFacesRequest {
-    similarityThreshold?: number;
-    images?: Image[];
+    images?: MatchFacesImage[];
     customMetadata?: any;
+    thumbnails?: boolean;
     static fromJson(jsonObject?: any): MatchFacesRequest;
 }
-export declare const ComparedFacesPairErrorCodes: {
-    IMAGE_EMPTY: number;
-    FACE_NOT_DETECTED: number;
-    LANDMARKS_NOT_DETECTED: number;
-    FACE_ALIGNER_FAILED: number;
-    DESCRIPTOR_EXTRACTOR_ERROR: number;
-    API_CALL_FAILED: number;
+export declare class MatchFacesImage {
+    imageType?: number;
+    detectAll?: boolean;
+    bitmap?: string;
+    identifier?: string;
+    static fromJson(jsonObject?: any): MatchFacesImage;
+}
+export declare class MatchFacesComparedFacesPair {
+    first?: MatchFacesComparedFace;
+    second?: MatchFacesComparedFace;
+    similarity?: number;
+    score?: number;
+    exception?: MatchFacesException;
+    static fromJson(jsonObject?: any): MatchFacesComparedFacesPair;
+}
+export declare class MatchFacesComparedFace {
+    face?: MatchFacesDetectionFace;
+    image?: MatchFacesImage;
+    faceIndex?: number;
+    imageIndex?: number;
+    static fromJson(jsonObject?: any): MatchFacesComparedFace;
+}
+export declare class MatchFacesDetectionFace {
+    faceIndex?: number;
+    landmarks?: Point[];
+    faceRect?: Rect;
+    rotationAngle?: number;
+    thumbnail?: string;
+    static fromJson(jsonObject?: any): MatchFacesDetectionFace;
+}
+export declare class MatchFacesDetection {
+    image?: MatchFacesImage;
+    imageIndex?: number;
+    faces?: MatchFacesDetectionFace[];
+    exception?: MatchFacesException;
+    static fromJson(jsonObject?: any): MatchFacesDetection;
+}
+export declare class Point {
+    x?: number;
+    y?: number;
+    static fromJson(jsonObject?: any): Point;
+}
+export declare class Rect {
+    bottom?: number;
+    top?: number;
+    left?: number;
+    right?: number;
+    static fromJson(jsonObject?: any): Rect;
+}
+export declare class MatchFacesSimilarityThresholdSplit {
+    matchedFaces?: MatchFacesComparedFacesPair[];
+    unmatchedFaces?: MatchFacesComparedFacesPair[];
+    static fromJson(jsonObject?: any): MatchFacesSimilarityThresholdSplit;
+}
+export declare const CameraPosition: {
+    Back: number;
+    Front: number;
 };
-export declare const FaceCaptureResultCodes: {
+export declare const FaceCaptureErrorCode: {
     CANCEL: number;
     CAMERA_NOT_AVAILABLE: number;
     CAMERA_NO_PERMISSION: number;
     IN_PROGRESS_ALREADY: number;
     CONTEXT_IS_NULL: number;
 };
 export declare const ImageType: {
-    IMAGE_TYPE_PRINTED: number;
-    IMAGE_TYPE_RFID: number;
-    IMAGE_TYPE_LIVE: number;
-    IMAGE_TYPE_LIVE_WITH_DOC: number;
+    PRINTED: number;
+    RFID: number;
+    LIVE: number;
+    DOCUMENT_WITH_LIVE: number;
+    EXTERNAL: number;
 };
 export declare const LivenessErrorCode: {
     CONTEXT_IS_NULL: number;
@@ -91,7 +124,6 @@ export declare const LivenessErrorCode: {
     PROCESSING_TIMEOUT: number;
     API_CALL_FAILED: number;
     PROCESSING_FAILED: number;
-    PROCESSING_ATTEMPTS_ENDED: number;
 };
 export declare const LivenessStatus: {
     PASSED: number;
@@ -104,37 +136,28 @@ export declare const MatchFacesErrorCodes: {
     FACE_ALIGNER_FAILED: number;
     DESCRIPTOR_EXTRACTOR_ERROR: number;
     NO_LICENSE: number;
-    NOT_INITIALIZED: number;
-    COMMAND_IS_NOT_SUPPORTED: number;
-    COMMAND_PARAMS_READ_ERROR: number;
+    IMAGES_COUNT_LIMIT_EXCEEDED: number;
     API_CALL_FAILED: number;
     PROCESSING_FAILED: number;
 };
-export declare const RFSCameraPosition: {
-    RFSCameraPositionBack: number;
-    RFSCameraPositionFront: number;
-};
 export declare const Enum: {
-    ComparedFacesPairErrorCodes: {
-        IMAGE_EMPTY: number;
-        FACE_NOT_DETECTED: number;
-        LANDMARKS_NOT_DETECTED: number;
-        FACE_ALIGNER_FAILED: number;
-        DESCRIPTOR_EXTRACTOR_ERROR: number;
-        API_CALL_FAILED: number;
+    CameraPosition: {
+        Back: number;
+        Front: number;
     };
-    FaceCaptureResultCodes: {
+    FaceCaptureErrorCode: {
         CANCEL: number;
         CAMERA_NOT_AVAILABLE: number;
         CAMERA_NO_PERMISSION: number;
         IN_PROGRESS_ALREADY: number;
         CONTEXT_IS_NULL: number;
     };
     ImageType: {
-        IMAGE_TYPE_PRINTED: number;
-        IMAGE_TYPE_RFID: number;
-        IMAGE_TYPE_LIVE: number;
-        IMAGE_TYPE_LIVE_WITH_DOC: number;
+        PRINTED: number;
+        RFID: number;
+        LIVE: number;
+        DOCUMENT_WITH_LIVE: number;
+        EXTERNAL: number;
     };
     LivenessErrorCode: {
         CONTEXT_IS_NULL: number;
@@ -145,7 +168,6 @@ export declare const Enum: {
         PROCESSING_TIMEOUT: number;
         API_CALL_FAILED: number;
         PROCESSING_FAILED: number;
-        PROCESSING_ATTEMPTS_ENDED: number;
     };
     LivenessStatus: {
         PASSED: number;
@@ -158,16 +180,10 @@ export declare const Enum: {
         FACE_ALIGNER_FAILED: number;
         DESCRIPTOR_EXTRACTOR_ERROR: number;
         NO_LICENSE: number;
-        NOT_INITIALIZED: number;
-        COMMAND_IS_NOT_SUPPORTED: number;
-        COMMAND_PARAMS_READ_ERROR: number;
+        IMAGES_COUNT_LIMIT_EXCEEDED: number;
         API_CALL_FAILED: number;
         PROCESSING_FAILED: number;
     };
-    RFSCameraPosition: {
-        RFSCameraPositionBack: number;
-        RFSCameraPositionFront: number;
-    };
 };
 /**
  * @name FaceSDK
@@ -227,15 +243,20 @@ export declare class FaceSDKOriginal extends IonicNativePlugin {
      *  description
      *
      * @param {object} config int cameraId - set camera on Android
-     *  RFSCameraPosition cameraPositionIOS - set camera on iOS
+     *  CameraPosition cameraPositionIOS - set camera on iOS
+     *  boolean cameraSwitchEnabled
+     *  boolean showHelpTextAnimation
      * @return {Promise<any>} Returns a promise
      */
     presentFaceCaptureActivityWithConfig(config: any): Promise<any>;
     /**
      *  description
      *
      * @param {object} config int cameraId - set camera on Android
-     *  RFSCameraPosition cameraPositionIOS - set camera on iOS
+     *  CameraPosition cameraPositionIOS - set camera on iOS
+     *  boolean cameraSwitchEnabled
+     *  boolean showHelpTextAnimation
+     *  boolean locationTrackingEnabled
      * @return {Promise<any>} Returns a promise
      */
     startLivenessWithConfig(config: any): Promise<any>;
@@ -263,11 +284,12 @@ export declare class FaceSDKOriginal extends IonicNativePlugin {
     /**
      *  description
      *
-     * @param {MatchFacesRequest} request description
-     * @param {object} config description
+     * @param {string} faces facesArray: MatchFacesComparedFacesPair[]
+     *  faces = JSON.stringify(facesArray)
+     * @param {number} similarity description
      * @return {Promise<any>} Returns a promise
      */
-    matchFacesWithConfig(request: any, config: any): Promise<any>;
+    matchFacesSimilarityThresholdSplit(faces: any, similarity: any): Promise<any>;
 }
 
 export declare const FaceSDK: FaceSDKOriginal;