@regulaforensics/face-sdk 6.5.63-beta → 6.5.67-beta

package/RNFaceSDK.podspec

@@ -5,7 +5,7 @@ source = File.join(__dir__, 'ios')
 
 Pod::Spec.new do |s|
   s.name         = 'RNFaceSDK'
-  s.version      = '6.5.63-beta'
+  s.version      = '6.5.67-beta'
   s.summary      = package['description']
   s.license      = package['license']
 

package/examples/capacitor/README.md

@@ -3,13 +3,13 @@
 ## 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.
+2. Run `npm run setup` within this directory.
 
 3. Run the app: 
-  * IOS: `npm run ios`.
-  * Android: `npm run android`.
+  * Android: use command `ionic cap run android`.
+  * IOS: use command `ionic cap run ios`.
 
-**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.
+**Note**: this is just one way of running the app. You can also run it directly from Xcode and Android Studio, but in this case make sure to run `ionic cap sync` before building if any changes were make to the project.
 
 
 ## How to use offine match

package/examples/capacitor/package.json

@@ -4,9 +4,9 @@
   "version": "1.0.0",
   "type": "module",
   "scripts": {
-    "setup": "scripts/setup.sh",
-    "ios": "scripts/ios.sh",
-    "android": "scripts/android.sh",
+    "setup": "npm install",
+    "android": "ionic cap run android --open",
+    "ios": "ionic cap run ios --open",
     "dev": "vite",
     "build": "tsc && vite build",
     "preview": "vite preview",
@@ -15,7 +15,7 @@
     "lint": "eslint"
   },
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.5.63-beta",
+    "@regulaforensics/face-sdk": "6.5.67-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "@awesome-cordova-plugins/camera": "6.6.0",
     "@awesome-cordova-plugins/file": "6.6.0",

package/examples/cordova/README.md

@@ -3,13 +3,13 @@
 ## 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.
+2. Run `npm run setup` within this directory.
 
 3. Run the app: 
-  * IOS: `npm run ios`.
-  * Android: `npm run android`.
+  * Android: use command `npm run android`.
+  * IOS: use command `npm run ios`.
 
-**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.
+**Note**: this is just one way of running the app. You can also run it directly from Xcode and Android Studio, but in this case make sure to run `cordova prepare ios` and `cordova prepare android` before building if any changes were make to the project.
 
 
 ## How to use offine match

package/examples/cordova/package.json

@@ -4,12 +4,17 @@
   "version": "1.0.0",
   "main": "index.js",
   "scripts": {
-    "setup": "scripts/setup.sh",
-    "ios": "scripts/ios.sh",
-    "android": "scripts/android.sh"
+    "setup": "npm install && cordova prepare",
+    "android": "cordova run android",
+    "ios": "cordova run ios"
   },
+  "keywords": [
+    "ecosystem:cordova"
+  ],
+  "author": "Regula Forensics Inc.",
+  "license": "commercial",
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.5.63-beta",
+    "@regulaforensics/face-sdk": "6.5.67-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "cordova-android": "13.0.0",
     "cordova-ios": "7.1.1",
@@ -31,4 +36,4 @@
       "ios"
     ]
   }
-}
+}

package/examples/ionic/README.md

@@ -3,13 +3,13 @@
 ## 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.
+2. Run `npm run setup` within this directory.
 
 3. Run the app: 
-  * IOS: `npm run ios`.
-  * Android: `npm run android`.
+  * Android: use command `npm run android`.
+  * IOS: use command `npm run ios`.
 
-**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.
+**Note**: this is just one way of running the app. You can also run it directly from Xcode and Android Studio, but in this case make sure to run `ionic cordova prepare ios` and `ionic cordova prepare android` before building if any changes were make to the project.
 
 
 ## How to use offine match

package/examples/ionic/package.json

@@ -4,9 +4,9 @@
   "author": "Ionic Framework",
   "homepage": "https://ionicframework.com/",
   "scripts": {
-    "setup": "scripts/setup.sh",
-    "ios": "scripts/ios.sh",
-    "android": "scripts/android.sh",
+    "setup": "npm install && ionic cordova prepare",
+    "android": "ionic cordova run android",
+    "ios": "ionic cordova run ios",
     "ng": "ng",
     "start": "ng serve",
     "build": "ng build",
@@ -16,7 +16,7 @@
   },
   "private": true,
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.5.63-beta",
+    "@regulaforensics/face-sdk": "6.5.67-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "cordova-plugin-camera": "8.0.0",
     "@awesome-cordova-plugins/camera": "6.14.0",

package/examples/ionic/src/app/home/home.page.ts

@@ -3,7 +3,7 @@ import { Dialogs } from '@awesome-cordova-plugins/dialogs/ngx'
 import { File } from '@awesome-cordova-plugins/file'
 import { Camera, DestinationType, MediaType, PictureSourceType } from '@awesome-cordova-plugins/camera/ngx'
 import { Platform } from '@ionic/angular'
-import { FaceSDK, MatchFacesRequest, MatchFacesImage, InitConfig, LivenessSkipStep, ImageType, LivenessStatus, LivenessConfig } from '@regulaforensics/face-sdk'
+import { FaceSDK, InitConfig, LivenessSkipStep, LivenessStatus, LivenessConfig } from '@regulaforensics/face-sdk'
 
 async function init() {
   if (!await initialize()) return
@@ -20,33 +20,14 @@ async function startLiveness() {
     }
   })
   if (response.image == null) return
-  setImage(response.image, ImageType.LIVE, 1)
+  setImage(response.image, 1)
   setLivenessStatus(response.liveness == LivenessStatus.PASSED ? "passed" : "unknown")
 }
 
-async function matchFaces() {
-  if (image1 == null || image2 == null) {
-    setStatus("Both images required!")
-    return
-  }
-  setStatus("Processing...")
-  var request = new MatchFacesRequest([image1, image2])
-  var response = await faceSdk.matchFaces(request)
-  var split = await faceSdk.splitComparedFaces(response.results, 0.75)
-  var match = split.matchedFaces
-  setSimilarityStatus("failed")
-  if (match.length > 0)
-    setSimilarityStatus((match[0].similarity * 100).toFixed(2) + "%")
-  setStatus("Ready")
-}
-
 function clearResults() {
   setStatus("Ready")
-  setSimilarityStatus("null")
   setLivenessStatus("null")
   resetImages()
-  image1 = null
-  image2 = null
 }
 
 // If 'regula.license' exists, init using license(enables offline match)
@@ -64,40 +45,14 @@ async function initialize() {
   return success
 }
 
-function setImage(base64: string, type: number, position: number) {
+function setImage(base64: string, 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
+  if (position == 2)
     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) {
-  app.camera.getPicture({
-    destinationType: DestinationType.DATA_URL,
-    mediaType: MediaType.PICTURE,
-    sourceType: PictureSourceType.PHOTOLIBRARY
-  }).then((result: string) => setImage(result, ImageType.PRINTED, position))
-}
-
-function pickImage(position: number) {
-  app.dialogs.confirm("", "Select option", ["Use gallery", "Use camera"]).then(button => {
-    if (button == 1) useGallery(position)
-    else useCamera(position)
-  })
 }
 
 async function loadAssetIfExists(path: string): Promise<string | null> {
@@ -118,10 +73,7 @@ async function loadAssetIfExists(path: string): Promise<string | null> {
 }
 
 var app: HomePage
-var faceSdk = FaceSDK.instance
-
-var image1: MatchFacesImage | null
-var image2: MatchFacesImage | null
+var faceSdk = new FaceSDK()
 
 var setStatus = (data: string) => app.status.nativeElement.innerHTML = data
 var setSimilarityStatus = (data: string) => app.similarityResult.nativeElement.innerHTML = data
@@ -154,9 +106,6 @@ export class HomePage {
   async ionViewDidEnter() {
     app = this
 
-    app.img1.nativeElement.onclick = () => pickImage(1)
-    app.img2.nativeElement.onclick = () => pickImage(2)
-    app.matchFacesButton.nativeElement.addEventListener("click", matchFaces)
     app.livenessButton.nativeElement.addEventListener("click", startLiveness)
     app.clearResultsButton.nativeElement.addEventListener("click", clearResults)
 

package/examples/react-native/README.md

@@ -3,13 +3,13 @@
 ## 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.
+2. Run `npm run setup` within this directory.
 
 3. Run the app: 
-  * IOS: `npm run ios`.
-  * Android: `npm run android`.
+  * Android: use command `npm run android`.
+  * IOS: use command `npm run ios`.
 
-**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. Just don't forget to make sure that Metro Bundler is running(`npm start`).
+**Note**: this is just one way of running the app. You can also run it directly from Xcode and Android Studio, but in this case make sure that Metro Bundler is running(`npm start`).
 
 
 ## How to use offine match

package/examples/react-native/package.json

@@ -3,15 +3,16 @@
   "version": "1.0.0",
   "private": true,
   "scripts": {
-    "setup": "scripts/setup.sh",
-    "ios": "scripts/ios.sh",
-    "android": "scripts/android.sh",
+    "setup": "npm install && (cd ios && bundle install) && npm run pod-install",
+    "pod-install": "cd ios && RCT_NEW_ARCH_ENABLED=1 bundle exec pod update",
+    "android": "react-native run-android",
+    "ios": "react-native run-ios",
     "lint": "eslint .",
     "start": "react-native start",
     "test": "jest"
   },
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.5.63-beta",
+    "@regulaforensics/face-sdk": "6.5.67-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "react": "18.3.1",
     "react-native": "0.76.6",

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@regulaforensics/face-sdk",
-  "version": "6.5.63-beta",
+  "version": "6.5.67-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",
   "types": "www/types/index.d.ts",
   "cordova": {

package/plugin.xml

@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='utf-8'?>
-<plugin id="@regulaforensics/face-sdk" version="6.5.63-beta" xmlns="http://apache.org/cordova/ns/plugins/1.0">
+<plugin id="@regulaforensics/face-sdk" version="6.5.67-beta" xmlns="http://apache.org/cordova/ns/plugins/1.0">
   <name>FaceSDK</name>
   <description>Cordova plugin for Regula Face SDK</description>
   <license>commercial</license>

package/www/capacitor/index.js

@@ -1,146 +1,24 @@
 import { exec, _setVideoEncoderCompletion, _setLivenessNotificationCompletion, _setCameraSwitchCallback } from './internal/bridge'
 
-import { CameraPosition } from './customization/camera_position'
-import { CustomizationColors } from './customization/customization_colors'
-import { CustomizationFonts } from './customization/customization_fonts'
-import { CustomizationImages } from './customization/customization_images'
-import { Customization } from './customization/customization'
-import { Font } from './customization/font'
-import { ScreenOrientation } from './customization/screen_orientation'
-
-export { CameraPosition, CustomizationColors, CustomizationFonts, CustomizationImages, Customization, Font, ScreenOrientation }
-
-import { FaceSDKVersion } from './init/face_sdk_version'
 import { InitConfig } from './init/init_config'
 import { InitException } from './init/init_exception'
 import { InitErrorCode } from './init/init_exception'
 import { LicenseException } from './init/license_exception'
 import { LicensingResultCode } from './init/license_exception'
 
-export { FaceSDKVersion, InitConfig, InitException, InitErrorCode, LicenseException, LicensingResultCode }
-
-import { DetectFaceResult } from './detect_faces/detect_face_result'
-import { DetectFacesAttributeResult } from './detect_faces/detect_faces_attribute_result'
-import { DetectFacesAttribute } from './detect_faces/detect_faces_attribute'
-import { DetectFacesBackendException, DetectFacesBackendErrorCode } from './detect_faces/detect_faces_backend_exception'
-import { DetectFacesConfig } from './detect_faces/detect_faces_config'
-import { DetectFacesException, DetectFacesErrorCode } from './detect_faces/detect_faces_exception'
-import { DetectFacesRequest } from './detect_faces/detect_faces_request'
-import { DetectFacesResponse } from './detect_faces/detect_faces_response'
-import { DetectFacesScenario } from './detect_faces/detect_faces_scenario'
-
-export { DetectFaceResult, DetectFacesAttributeResult, DetectFacesAttribute, DetectFacesBackendException, DetectFacesBackendErrorCode, DetectFacesConfig, DetectFacesException, DetectFacesErrorCode, DetectFacesRequest, DetectFacesResponse, DetectFacesScenario }
-
-import { FaceCaptureConfig } from './face_capture/face_capture_config'
-import { FaceCaptureException, FaceCaptureErrorCode } from './face_capture/face_capture_exception'
-import { FaceCaptureImage, ImageType } from './face_capture/face_capture_image'
-import { FaceCaptureResponse } from './face_capture/face_capture_response'
-
-export { FaceCaptureConfig, FaceCaptureException, FaceCaptureErrorCode, FaceCaptureImage, ImageType, FaceCaptureResponse }
-
-import { OutputImageCrop, OutputImageCropAspectRatio } from './image_params/output_image_crop'
-import { OutputImageParams } from './image_params/output_image_params'
-import { Point } from './image_params/point'
-import { Rect } from './image_params/rect'
-import { Size } from './image_params/size'
-
-export { OutputImageCrop, OutputImageCropAspectRatio, OutputImageParams, Point, Rect, Size }
-
-import { ImageQualityCharacteristicName } from './image_quality/image_quality_characteristic_name'
-import { ImageQualityCharacteristic } from './image_quality/image_quality_characteristic'
-import { ImageQualityGroup } from './image_quality/image_quality_group'
-import { ImageQualityRange } from './image_quality/image_quality_range'
-import { ImageQualityResult, ImageQualityGroupName, ImageQualityResultStatus } from './image_quality/image_quality_result'
-
-export { ImageQualityCharacteristicName, ImageQualityCharacteristic, ImageQualityGroup, ImageQualityRange, ImageQualityResult, ImageQualityGroupName, ImageQualityResultStatus }
+export { InitConfig, InitException, InitErrorCode, LicenseException, LicensingResultCode }
 
+import { CameraPosition } from './customization/camera_position'
+import { ScreenOrientation } from './customization/screen_orientation'
 import { LivenessBackendException, LivenessBackendErrorCode } from './liveness/liveness_backend_exception'
 import { LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep } from './liveness/liveness_config'
 import { LivenessException, LivenessErrorCode } from './liveness/liveness_exception'
 import { LivenessNotification, LivenessProcessStatus } from './liveness/liveness_notification'
 import { LivenessResponse, LivenessStatus } from './liveness/liveness_response'
 
-export { LivenessBackendException, LivenessBackendErrorCode, LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep, LivenessException, LivenessErrorCode, LivenessNotification, LivenessProcessStatus, LivenessResponse, LivenessStatus }
-
-import { ComparedFace } from './match_faces/compared_face'
-import { ComparedFacesPair } from './match_faces/compared_faces_pair'
-import { ComparedFacesSplit } from './match_faces/compared_faces_split'
-import { MatchFacesBackendException } from './match_faces/match_faces_backend_exception'
-import { MatchFacesConfig, ProcessingMode } from './match_faces/match_faces_config'
-import { MatchFacesDetectionFace } from './match_faces/match_faces_detection_face'
-import { MatchFacesDetection } from './match_faces/match_faces_detection'
-import { MatchFacesException, MatchFacesErrorCode } from './match_faces/match_faces_exception'
-import { MatchFacesImage } from './match_faces/match_faces_image'
-import { MatchFacesRequest } from './match_faces/match_faces_request'
-import { MatchFacesResponse } from './match_faces/match_faces_response'
-
-export { ComparedFace, ComparedFacesPair, ComparedFacesSplit, MatchFacesBackendException, MatchFacesConfig, ProcessingMode, MatchFacesDetectionFace, MatchFacesDetection, MatchFacesException, MatchFacesErrorCode, MatchFacesImage, MatchFacesRequest, MatchFacesResponse }
-
-import { EditGroupPersonsRequest } from './person_database/edit_group_persons_request'
-import { ImageUpload } from './person_database/image_upload'
-import { PageableItemList } from './person_database/pageable_item_list'
-import { PersonDatabase } from './person_database/person_database'
-import { PersonGroup } from './person_database/person_group'
-import { PersonImage } from './person_database/person_image'
-import { Person } from './person_database/person'
-import { SearchPersonDetection } from './person_database/search_person_detection'
-import { SearchPersonImage } from './person_database/search_person_image'
-import { SearchPersonRequest } from './person_database/search_person_request'
-import { SearchPerson } from './person_database/search_person'
-
-export { EditGroupPersonsRequest, ImageUpload, PageableItemList, PersonDatabase, PersonGroup, PersonImage, Person, SearchPersonDetection, SearchPersonImage, SearchPersonRequest, SearchPerson }
-
+export { LivenessBackendException, LivenessBackendErrorCode, LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep, LivenessException, LivenessErrorCode, LivenessNotification, LivenessProcessStatus, LivenessResponse, LivenessStatus, CameraPosition, ScreenOrientation }
 
 export class FaceSDK {
-    static get instance() { return FaceSDK._instance }
-    static _instance = new FaceSDK()
-
-    get version() { return this._version }
-    _version
-
-    get serviceUrl() { return this._serviceUrl }
-    _serviceUrl
-    set serviceUrl(val) {
-        this._serviceUrl = val
-        this._setServiceUrl(val)
-    }
-
-    get localizationDictionary() { return this._localizationDictionary }
-    _localizationDictionary
-    set localizationDictionary(val) {
-        var temp = Object.assign({}, val);
-        Object.freeze(temp);
-        this._localizationDictionary = temp
-        this._setLocalizationDictionary(val)
-    }
-
-    get requestHeaders() { return this._requestHeaders }
-    _requestHeaders
-    set requestHeaders(val) {
-        var temp = Object.assign({}, val);
-        Object.freeze(temp);
-        this._requestHeaders = temp
-        this._setRequestHeaders(val)
-    }
-
-    get customization() { return this._customization }
-    _customization = new Customization()
-    set customization(val) {
-        this._customization = val
-        this._customization._apply()
-    }
-
-    set videoEncoderCompletion(completion) {
-        _setVideoEncoderCompletion(completion)
-    }
-
-    get personDatabase() { return this._personDatabase }
-    _personDatabase = new PersonDatabase()
-
-    async isInitialized() {
-        return await exec("isInitialized", [])
-    }
-
     async initialize(params) {
         var response = await exec("initialize", [params?.config])
 
@@ -148,8 +26,6 @@ export class FaceSDK {
         var success = jsonObject["success"]
         var error = jsonObject["error"]
 
-        if (success) await this._onInit()
-
         return [success, InitException.fromJson(error)]
     }
 
@@ -157,16 +33,6 @@ export class FaceSDK {
         exec("deinitialize", [])
     }
 
-    async startFaceCapture(params) {
-        _setCameraSwitchCallback(params?.cameraSwitchCallback)
-        var response = await exec("startFaceCapture", [params?.config])
-        return FaceCaptureResponse.fromJson(JSON.parse(response))
-    }
-
-    stopFaceCapture() {
-        exec("stopFaceCapture", [])
-    }
-
     async startLiveness(params) {
         _setCameraSwitchCallback(params?.cameraSwitchCallback)
         _setLivenessNotificationCompletion(params?.notificationCompletion)
@@ -177,45 +43,4 @@ export class FaceSDK {
     stopLiveness() {
         exec("stopLiveness", [])
     }
-
-    async matchFaces(request, params) {
-        var response = await exec("matchFaces", [request, params?.config])
-        return MatchFacesResponse.fromJson(JSON.parse(response))
-    }
-
-    async splitComparedFaces(facesPairs, similarityThreshold) {
-        var response = await exec("splitComparedFaces", [facesPairs, similarityThreshold])
-        return ComparedFacesSplit.fromJson(JSON.parse(response))
-    }
-
-    async detectFaces(request) {
-        var response = await exec("detectFaces", [request])
-        return DetectFacesResponse.fromJson(JSON.parse(response))
-    }
-
-    async _onInit() {
-        this._version = await this._getVersion()
-        this._serviceUrl = await this._getServiceUrl()
-    }
-
-    async _getVersion() {
-        var response = await exec("getVersion", [])
-        return FaceSDKVersion.fromJson(JSON.parse(response))
-    }
-
-    async _getServiceUrl() {
-        return await exec("getServiceUrl", [])
-    }
-
-    _setServiceUrl(url) {
-        exec("setServiceUrl", [url])
-    }
-
-    _setLocalizationDictionary(dictionary) {
-        exec("setLocalizationDictionary", [dictionary])
-    }
-
-    _setRequestHeaders(dictionary) {
-        exec("setRequestHeaders", [dictionary])
-    }
 }