@regulaforensics/face-sdk 7.2.422-beta → 7.2.425-beta

package/www/react-native/liveness/liveness_exception.js

@@ -15,6 +15,14 @@ export class LivenessException {
 
         return result
     }
+
+    toJson() {
+        return {
+            "code": this.code,
+            "message": this.message,
+            "underlyingError": this.underlyingError?.toJson(),
+        }
+    }
 }
 
 export const LivenessErrorCode = {

package/www/react-native/liveness/liveness_notification.js

@@ -13,6 +13,13 @@ export class LivenessNotification {
 
         return result
     }
+
+    toJson() {
+        return {
+            "status": this.status,
+            "response": this.response?.toJson(),
+        }
+    }
 }
 
 export const LivenessProcessStatus = {

package/www/react-native/liveness/liveness_response.js

@@ -22,6 +22,17 @@ export class LivenessResponse {
 
         return result
     }
+
+    toJson() {
+        return {
+            "image": this.image,
+            "liveness": this.liveness,
+            "tag": this.tag,
+            "transactionId": this.transactionId,
+            "estimatedAge": this.estimatedAge,
+            "error": this.error?.toJson(),
+        }
+    }
 }
 
 export const LivenessStatus = {

package/www/react-native/match_faces/compared_face.js

@@ -18,4 +18,13 @@ export class ComparedFace {
 
         return result
     }
+
+    toJson() {
+        return {
+            "imageIndex": this.imageIndex,
+            "image": this.image?.toJson(),
+            "faceIndex": this.faceIndex,
+            "face": this.face?.toJson(),
+        }
+    }
 }

package/www/react-native/match_faces/compared_faces_pair.js

@@ -20,4 +20,14 @@ export class ComparedFacesPair {
 
         return result
     }
+
+    toJson() {
+        return {
+            "first": this.first?.toJson(),
+            "second": this.second?.toJson(),
+            "similarity": this.similarity,
+            "score": this.score,
+            "error": this.error?.toJson(),
+        }
+    }
 }

package/www/react-native/match_faces/compared_faces_split.js

@@ -19,4 +19,11 @@ export class ComparedFacesSplit {
 
         return result
     }
+
+    toJson() {
+        return {
+            "matchedFaces": this.matchedFaces?.map(e => e.toJson()),
+            "unmatchedFaces": this.unmatchedFaces?.map(e => e.toJson()),
+        }
+    }
 }

package/www/react-native/match_faces/match_faces_backend_exception.js

@@ -11,4 +11,11 @@ export class MatchFacesBackendException {
 
         return result
     }
+
+    toJson() {
+        return {
+            "code": this.code,
+            "message": this.message,
+        }
+    }
 }

package/www/react-native/match_faces/match_faces_config.js

@@ -1,8 +1,27 @@
 export class MatchFacesConfig {
     processingMode
+    locationTrackingEnabled
 
     constructor(params) {
         this.processingMode = params?.processingMode ?? ProcessingMode.ONLINE
+        this.locationTrackingEnabled = params?.locationTrackingEnabled ?? true
+    }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        const result = new MatchFacesConfig()
+
+        result.processingMode = jsonObject["processingMode"]
+        result.locationTrackingEnabled = jsonObject["locationTrackingEnabled"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "processingMode": this.processingMode,
+            "locationTrackingEnabled": this.locationTrackingEnabled,
+        }
     }
 }
 

package/www/react-native/match_faces/match_faces_detection.js

@@ -22,4 +22,13 @@ export class MatchFacesDetection {
 
         return result
     }
+
+    toJson() {
+        return {
+            "imageIndex": this.imageIndex,
+            "image": this.image?.toJson(),
+            "faces": this.faces?.map(e => e.toJson()),
+            "error": this.error?.toJson(),
+        }
+    }
 }

package/www/react-native/match_faces/match_faces_detection_face.js

@@ -25,4 +25,15 @@ export class MatchFacesDetectionFace {
 
         return result
     }
+
+    toJson() {
+        return {
+            "faceIndex": this.faceIndex,
+            "landmarks": this.landmarks?.map(e => e.toJson()),
+            "faceRect": this.faceRect?.toJson(),
+            "rotationAngle": this.rotationAngle,
+            "originalRect": this.originalRect?.toJson(),
+            "crop": this.crop,
+        }
+    }
 }

package/www/react-native/match_faces/match_faces_exception.js

@@ -15,6 +15,14 @@ export class MatchFacesException {
 
         return result
     }
+
+    toJson() {
+        return {
+            "code": this.code,
+            "message": this.message,
+            "underlyingError": this.underlyingError?.toJson(),
+        }
+    }
 }
 
 export const MatchFacesErrorCode = {

package/www/react-native/match_faces/match_faces_image.js

@@ -22,4 +22,13 @@ export class MatchFacesImage {
 
         return result
     }
+
+    toJson() {
+        return {
+            "image": this.image,
+            "imageType": this.imageType,
+            "detectAll": this.detectAll,
+            "identifier": this.identifier,
+        }
+    }
 }

package/www/react-native/match_faces/match_faces_request.js

@@ -1,3 +1,6 @@
+import { OutputImageParams } from '../image_params/output_image_params'
+import { MatchFacesImage } from './match_faces_image'
+
 export class MatchFacesRequest {
     images
     outputImageParams
@@ -10,4 +13,28 @@ export class MatchFacesRequest {
         this.tag = params?.tag
         this.metadata = params?.metadata
     }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+
+        const images = []
+        for (const item of jsonObject["images"]) {
+            images.push(MatchFacesImage.fromJson(item))
+        }
+
+        return new MatchFacesRequest(images, {
+            outputImageParams: OutputImageParams.fromJson(jsonObject["outputImageParams"]),
+            tag: jsonObject["tag"],
+            metadata: jsonObject["metadata"],
+        })
+    }
+
+    toJson() {
+        return {
+            "images": this.images?.map(e => e.toJson()),
+            "outputImageParams": this.outputImageParams?.toJson(),
+            "tag": this.tag,
+            "metadata": this.metadata,
+        }
+    }
 }

package/www/react-native/match_faces/match_faces_response.js

@@ -25,4 +25,13 @@ export class MatchFacesResponse {
 
         return result
     }
+
+    toJson() {
+        return {
+            "results": this.results?.map(e => e.toJson()),
+            "detections": this.detections?.map(e => e.toJson()),
+            "tag": this.tag,
+            "error": this.error?.toJson(),
+        }
+    }
 }

package/www/react-native/person_database/edit_group_persons_request.js

@@ -6,4 +6,19 @@ export class EditGroupPersonsRequest {
         this.personIdsToAdd = params?.personIdsToAdd
         this.personIdsToRemove = params?.personIdsToRemove
     }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        return new EditGroupPersonsRequest({
+            personIdsToAdd: jsonObject["personIdsToAdd"],
+            personIdsToRemove: jsonObject["personIdsToRemove"],
+        })
+    }
+
+    toJson() {
+        return {
+            "personIdsToAdd": this.personIdsToAdd,
+            "personIdsToRemove": this.personIdsToRemove,
+        }
+    }
 }

package/www/react-native/person_database/image_upload.js

@@ -13,4 +13,21 @@ export class ImageUpload {
         result.imageUrl = imageUrl
         return result
     }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        var result = new ImageUpload()
+
+        result.imageData = jsonObject["imageData"]
+        result.imageUrl = jsonObject["imageUrl"]
+
+        return result
+    }
+
+    toJson() {
+        return {
+            "imageData": this.imageData,
+            "imageUrl": this.imageUrl,
+        }
+    }
 }

package/www/react-native/person_database/pageable_item_list.js

@@ -19,4 +19,12 @@ export class PageableItemList {
 
         return result
     }
+
+    toJson() {
+        return {
+            "items": this.items?.map(e => e.toJson()),
+            "page": this.page,
+            "totalPages": this.totalPages,
+        }
+    }
 }

package/www/react-native/person_database/person.js

@@ -1,3 +1,5 @@
+import { dateToString } from '../internal/bridge'
+
 export class Person {
     name
     updatedAt
@@ -19,4 +21,15 @@ export class Person {
 
         return result
     }
+
+    toJson() {
+        return {
+            "name": this.name,
+            "updatedAt": dateToString(this.updatedAt),
+            "groups": this.groups,
+            "id": this.id,
+            "metadata": this.metadata,
+            "createdAt": dateToString(this.createdAt),
+        }
+    }
 }

package/www/react-native/person_database/person_group.js

@@ -1,3 +1,5 @@
+import { dateToString } from '../internal/bridge'
+
 export class PersonGroup {
     name
     id
@@ -15,4 +17,13 @@ export class PersonGroup {
 
         return result
     }
+
+    toJson() {
+        return {
+            "name": this.name,
+            "id": this.id,
+            "metadata": this.metadata,
+            "createdAt": dateToString(this.createdAt),
+        }
+    }
 }

package/www/react-native/person_database/person_image.js

@@ -1,3 +1,5 @@
+import { dateToString } from '../internal/bridge'
+
 export class PersonImage {
     path
     url
@@ -19,4 +21,15 @@ export class PersonImage {
 
         return result
     }
+
+    toJson() {
+        return {
+            "path": this.path,
+            "url": this.url,
+            "contentType": this.contentType,
+            "id": this.id,
+            "metadata": this.metadata,
+            "createdAt": dateToString(this.createdAt),
+        }
+    }
 }

package/www/react-native/person_database/search_person.js

@@ -1,3 +1,4 @@
+import { dateToString } from '../internal/bridge'
 import { SearchPersonImage } from './search_person_image'
 import { SearchPersonDetection } from './search_person_detection'
 
@@ -28,4 +29,17 @@ export class SearchPerson {
 
         return result
     }
+
+    toJson() {
+        return {
+            "images": this.images?.map(e => e.toJson()),
+            "detection": this.detection?.toJson(),
+            "name": this.name,
+            "updatedAt": dateToString(this.updatedAt),
+            "groups": this.groups,
+            "id": this.id,
+            "metadata": this.metadata,
+            "createdAt": dateToString(this.createdAt),
+        }
+    }
 }

package/www/react-native/person_database/search_person_detection.js

@@ -19,4 +19,13 @@ export class SearchPersonDetection {
 
         return result
     }
+
+    toJson() {
+        return {
+            "landmarks": this.landmarks?.map(e => e.toJson()),
+            "rect": this.rect?.toJson(),
+            "crop": this.crop,
+            "rotationAngle": this.rotationAngle,
+        }
+    }
 }

package/www/react-native/person_database/search_person_image.js

@@ -1,3 +1,5 @@
+import { dateToString } from '../internal/bridge'
+
 export class SearchPersonImage {
     similarity
     distance
@@ -23,4 +25,17 @@ export class SearchPersonImage {
 
         return result
     }
+
+    toJson() {
+        return {
+            "similarity": this.similarity,
+            "distance": this.distance,
+            "path": this.path,
+            "url": this.url,
+            "contentType": this.contentType,
+            "id": this.id,
+            "metadata": this.metadata,
+            "createdAt": dateToString(this.createdAt),
+        }
+    }
 }

package/www/react-native/person_database/search_person_request.js

@@ -1,8 +1,12 @@
+import { OutputImageParams } from '../image_params/output_image_params'
+import { ImageUpload } from './image_upload'
+
 export class SearchPersonRequest {
     imageUpload
     groupIdsForSearch
     threshold
     limit
+    tag
     detectAll
     outputImageParams
 
@@ -11,7 +15,32 @@ export class SearchPersonRequest {
         this.groupIdsForSearch = params?.groupIdsForSearch
         this.threshold = params?.threshold
         this.limit = params?.limit
+        this.tag = params?.tag
         this.detectAll = params?.detectAll ?? false
         this.outputImageParams = params?.outputImageParams
     }
+
+    static fromJson(jsonObject) {
+        if (jsonObject == null) return null
+        return new SearchPersonRequest(ImageUpload.fromJson(jsonObject["imageUpload"]), {
+            groupIdsForSearch: jsonObject["groupIdsForSearch"],
+            threshold: jsonObject["threshold"],
+            limit: jsonObject["limit"],
+            tag: jsonObject["tag"],
+            detectAll: jsonObject["detectAll"],
+            outputImageParams: OutputImageParams.fromJson(jsonObject["outputImageParams"]),
+        })
+    }
+
+    toJson() {
+        return {
+            "imageUpload": this.imageUpload?.toJson(),
+            "groupIdsForSearch": this.groupIdsForSearch,
+            "threshold": this.threshold,
+            "limit": this.limit,
+            "tag": this.tag,
+            "detectAll": this.detectAll,
+            "outputImageParams": this.outputImageParams?.toJson(),
+        }
+    }
 }

package/www/types/index.d.ts

@@ -97,6 +97,18 @@ export class FaceSDK {
     get serviceUrl(): string | null
     set serviceUrl(val: string | null)
 
+    /** Customer name. */
+    tenant: string | null;
+
+    /** Environment type. */
+    env: string | null;
+
+    /** 
+     * Custom language locale code of DocumentReaderSDK.
+     * If empty or doesn't exist - app language is used. Format "en-US" or "en".
+     */
+    locale: string | null;
+
     /**
      * A localization dictionary to override default localization logic.
      * Allows to replace any string of FaceSDK with an arbitrary string.

package/www/types/match_faces/match_faces_config.d.ts

@@ -1,9 +1,11 @@
 export class MatchFacesConfig {
     processingMode: ProcessingMode
+    locationTrackingEnabled: boolean
 
     constructor(
         params?: {
             processingMode?: ProcessingMode
+            locationTrackingEnabled?: boolean
         }
     )
 }

package/www/types/person_database/search_person_request.d.ts

@@ -20,6 +20,9 @@ export class SearchPersonRequest {
      * @param params.limit - The number of returned Persons limit. 
      * Default: 100.
      * 
+     * @param tag - Defines tag that can be used in search request.
+     * Default: null.
+     * 
      * @param params.detectAll - Whether to process only the one face on the image or all the faces. 
      * Default: `false`.
      * 
@@ -32,6 +35,7 @@ export class SearchPersonRequest {
             groupIdsForSearch?: string[],
             threshold?: number,
             limit?: number,
+            tag?: string,
             detectAll?: boolean,
             outputImageParams?: OutputImageParams
         }

package/examples/cordova/.vscode/launch.json

@@ -1,28 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Debug Android on emulator",
-            "type": "cordova",
-            "request": "launch",
-            "platform": "android",
-            "target": "emulator",
-            "port": 9222,
-            "sourceMaps": true,
-            "cwd": "${workspaceFolder}"
-        },
-        {
-            "name": "Debug Android on device",
-            "type": "cordova",
-            "request": "launch",
-            "platform": "android",
-            "target": "device",
-            "port": 9222,
-            "sourceMaps": true,
-            "cwd": "${workspaceFolder}"
-        }
-    ]
-}

package/examples/cordova/README.md

@@ -1,25 +0,0 @@
-# Regula Face SDK Cordova demo application
-
-## How to build demo application
-1. Download or the clone current repository using the command `git clone https://github.com/regulaforensics/npm-face-sdk.git`.
-
-2. Execute `npm run setup` within this directory.
-
-3. Run the app: 
-  * IOS: `npm run ios`.
-  * Android: `npm run android`.
-
-**Note**: this is just one way of running the app. You can also pass `-o` or `--open` argument to the command, and this will open Xcode/Android Studio, then run the app directly from the IDE. Overall, this is a more consistent way, so if you're having troubles running the app from terminal, try running it from the IDE.
-
-
-## How to use offline match
-1. Place a license that supports offline match at `www/regula.license`.
-
-2. Change core with the following commands:
-```bash
-cordova plugin remove @regulaforensics/face-core-basic
-cordova plugin add @regulaforensics/face-core-match
-npm run setup
-```
-
-3. Turn off the internet and run the app.

package/examples/cordova/config.xml

@@ -1,26 +0,0 @@
-<widget android-packageName="com.regula.documentreader.api.androidtest" ios-CFBundleIdentifier="com.regula.documentreader.qa" version="1.0.0"
-    xmlns:android="http://schemas.android.com/apk/res/android">
-    <name>FaceSDK</name>
-    <platform name="android">
-        <preference name="orientation" value="portrait" />
-        <preference name="GradlePluginKotlinEnabled" value="true" />
-        <preference name="android-minSdkVersion" value="24" />
-        <preference name="android-targetSdkVersion" value="35" />
-        <config-file parent="/*" target="AndroidManifest.xml">
-            <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
-        </config-file>
-        <edit-config file="app/src/main/AndroidManifest.xml" mode="merge" target="/manifest/application">
-            <application android:usesCleartextTraffic="true" />
-        </edit-config>
-    </platform>
-    <platform name="ios">
-        <preference name="orientation" value="portrait" />
-        <preference name="DisallowOverscroll" value="true" />
-        <config-file target="*-Info.plist" parent="NSCameraUsageDescription">
-            <string>To use camera</string>
-        </config-file>
-        <config-file target="*-Info.plist" parent="NSPhotoLibraryUsageDescription">
-            <string>To pick images</string>
-        </config-file>
-    </platform>
-</widget>