@regulaforensics/face-sdk 6.5.55-beta → 6.5.63-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.55-beta'
+  s.version      = '6.5.63-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. Run `npm run setup` within this directory.
+2. Execute `npm run setup` within this directory.
 
 3. Run the app: 
-  * Android: use command `ionic cap run android`.
-  * IOS: use command `ionic cap run ios`.
+  * IOS: `npm run ios`.
+  * Android: `npm run android`.
 
-**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.
+**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 offine match

package/examples/capacitor/package.json

@@ -4,9 +4,9 @@
   "version": "1.0.0",
   "type": "module",
   "scripts": {
-    "setup": "npm install",
-    "android": "ionic cap run android --open",
-    "ios": "ionic cap run ios --open",
+    "setup": "scripts/setup.sh",
+    "ios": "scripts/ios.sh",
+    "android": "scripts/android.sh",
     "dev": "vite",
     "build": "tsc && vite build",
     "preview": "vite preview",
@@ -15,7 +15,7 @@
     "lint": "eslint"
   },
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.5.55-beta",
+    "@regulaforensics/face-sdk": "6.5.63-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/capacitor/scripts/android.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -e
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    ionic cap sync android
+    studio android || open -a 'Android Studio' android
+else
+    ionic cap run android
+fi

package/examples/capacitor/scripts/ios.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    ionic cap run ios --open
+else
+    ionic cap run ios
+fi

package/examples/capacitor/scripts/setup.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+npm install

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. Run `npm run setup` within this directory.
+2. Execute `npm run setup` within this directory.
 
 3. Run the app: 
-  * Android: use command `npm run android`.
-  * IOS: use command `npm run ios`.
+  * IOS: `npm run ios`.
+  * Android: `npm run android`.
 
-**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.
+**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 offine match

package/examples/cordova/package.json

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

package/examples/cordova/scripts/android.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    cordova prepare android
+    studio platforms/android || open -a 'Android Studio' platforms/android
+else
+    cordova run android
+fi

package/examples/cordova/scripts/ios.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    cordova prepare ios
+    open platforms/ios/FaceSDK.xcworkspace
+else
+    cordova run ios
+fi

package/examples/cordova/scripts/setup.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+npm install
+cordova prepare

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. Run `npm run setup` within this directory.
+2. Execute `npm run setup` within this directory.
 
 3. Run the app: 
-  * Android: use command `npm run android`.
-  * IOS: use command `npm run ios`.
+  * IOS: `npm run ios`.
+  * Android: `npm run android`.
 
-**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.
+**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 offine match

package/examples/ionic/package.json

@@ -4,9 +4,9 @@
   "author": "Ionic Framework",
   "homepage": "https://ionicframework.com/",
   "scripts": {
-    "setup": "npm install && ionic cordova prepare",
-    "android": "ionic cordova run android",
-    "ios": "ionic cordova run ios",
+    "setup": "scripts/setup.sh",
+    "ios": "scripts/ios.sh",
+    "android": "scripts/android.sh",
     "ng": "ng",
     "start": "ng serve",
     "build": "ng build",
@@ -16,7 +16,7 @@
   },
   "private": true,
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.5.55-beta",
+    "@regulaforensics/face-sdk": "6.5.63-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/scripts/android.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    ionic cordova prepare android
+    studio platforms/android || open -a 'Android Studio' platforms/android
+else
+    ionic cordova run android
+fi

package/examples/ionic/scripts/ios.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    ionic cordova prepare ios
+    open platforms/ios/FaceSDK.xcworkspace
+else
+    ionic cordova run ios
+fi

package/examples/ionic/scripts/setup.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -e
+
+npm install
+ionic cordova prepare

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. Run `npm run setup` within this directory.
+2. Execute `npm run setup` within this directory.
 
 3. Run the app: 
-  * Android: use command `npm run android`.
-  * IOS: use command `npm run ios`.
+  * IOS: `npm run ios`.
+  * Android: `npm run android`.
 
-**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`).
+**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`).
 
 
 ## How to use offine match

package/examples/react-native/package.json

@@ -3,16 +3,15 @@
   "version": "1.0.0",
   "private": true,
   "scripts": {
-    "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",
+    "setup": "scripts/setup.sh",
+    "ios": "scripts/ios.sh",
+    "android": "scripts/android.sh",
     "lint": "eslint .",
     "start": "react-native start",
     "test": "jest"
   },
   "dependencies": {
-    "@regulaforensics/face-sdk": "6.5.55-beta",
+    "@regulaforensics/face-sdk": "6.5.63-beta",
     "@regulaforensics/face-core-basic": "6.3.12-beta",
     "react": "18.3.1",
     "react-native": "0.76.6",

package/examples/react-native/scripts/android.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    studio android || open -a 'Android Studio' android
+else
+    react-native run-android
+fi

package/examples/react-native/scripts/ios.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+if [[ $npm_config_o || $npm_config_open ]]; then
+    open ios/FaceSDK.xcworkspace
+else
+    react-native run-ios
+fi

package/examples/react-native/scripts/setup.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -e
+
+npm install
+cd ios
+bundle install
+RCT_NEW_ARCH_ENABLED=1 bundle exec pod install ||
+    RCT_NEW_ARCH_ENABLED=1 bundle exec pod update

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@regulaforensics/face-sdk",
-  "version": "6.5.55-beta",
+  "version": "6.5.63-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.55-beta" xmlns="http://apache.org/cordova/ns/plugins/1.0">
+<plugin id="@regulaforensics/face-sdk" version="6.5.63-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/image_quality/image_quality_group.js

@@ -306,12 +306,27 @@ export class _Background {
 }
 
 export class ImageQualityGroup {
-    image = new _Image()
-    headSizeAndPosition = new _HeadSizeAndPosition()
-    faceImage = new _FaceImage()
-    eyes = new _Eyes()
-    shadowsAndLightning = new _ShadowsAndLightning()
-    poseAndExpression = new _PoseAndExpression()
-    headOcclusion = new _HeadOcclusion()
-    background = new _Background()
+    static get image() { return ImageQualityGroup._image }
+    static _image = new _Image()
+
+    static get headSizeAndPosition() { return ImageQualityGroup._headSizeAndPosition }
+    static _headSizeAndPosition = new _HeadSizeAndPosition()
+
+    static get faceImage() { return ImageQualityGroup._faceImage }
+    static _faceImage = new _FaceImage()
+
+    static get eyes() { return ImageQualityGroup._eyes }
+    static _eyes = new _Eyes()
+
+    static get shadowsAndLightning() { return ImageQualityGroup._shadowsAndLightning }
+    static _shadowsAndLightning = new _ShadowsAndLightning()
+
+    static get poseAndExpression() { return ImageQualityGroup._poseAndExpression }
+    static _poseAndExpression = new _PoseAndExpression()
+
+    static get headOcclusion() { return ImageQualityGroup._headOcclusion }
+    static _headOcclusion = new _HeadOcclusion()
+
+    static get background() { return ImageQualityGroup._background }
+    static _background = new _Background()
 }

package/www/capacitor/index.js

@@ -92,6 +92,9 @@ export { EditGroupPersonsRequest, ImageUpload, PageableItemList, PersonDatabase,
 
 
 export class FaceSDK {
+    static get instance() { return FaceSDK._instance }
+    static _instance = new FaceSDK()
+
     get version() { return this._version }
     _version
 

package/www/cordova.js

@@ -1771,14 +1771,29 @@ class _Background {
 }
 
 class ImageQualityGroup {
-    image = new _Image()
-    headSizeAndPosition = new _HeadSizeAndPosition()
-    faceImage = new _FaceImage()
-    eyes = new _Eyes()
-    shadowsAndLightning = new _ShadowsAndLightning()
-    poseAndExpression = new _PoseAndExpression()
-    headOcclusion = new _HeadOcclusion()
-    background = new _Background()
+    static get image() { return ImageQualityGroup._image }
+    static _image = new _Image()
+
+    static get headSizeAndPosition() { return ImageQualityGroup._headSizeAndPosition }
+    static _headSizeAndPosition = new _HeadSizeAndPosition()
+
+    static get faceImage() { return ImageQualityGroup._faceImage }
+    static _faceImage = new _FaceImage()
+
+    static get eyes() { return ImageQualityGroup._eyes }
+    static _eyes = new _Eyes()
+
+    static get shadowsAndLightning() { return ImageQualityGroup._shadowsAndLightning }
+    static _shadowsAndLightning = new _ShadowsAndLightning()
+
+    static get poseAndExpression() { return ImageQualityGroup._poseAndExpression }
+    static _poseAndExpression = new _PoseAndExpression()
+
+    static get headOcclusion() { return ImageQualityGroup._headOcclusion }
+    static _headOcclusion = new _HeadOcclusion()
+
+    static get background() { return ImageQualityGroup._background }
+    static _background = new _Background()
 }
 
 /***/ }),
@@ -2123,6 +2138,9 @@ __webpack_require__.r(__webpack_exports__);
 
 
 class FaceSDK {
+    static get instance() { return FaceSDK._instance }
+    static _instance = new FaceSDK()
+
     get version() { return this._version }
     _version
 

package/www/react-native/image_quality/image_quality_group.js

@@ -306,12 +306,27 @@ export class _Background {
 }
 
 export class ImageQualityGroup {
-    image = new _Image()
-    headSizeAndPosition = new _HeadSizeAndPosition()
-    faceImage = new _FaceImage()
-    eyes = new _Eyes()
-    shadowsAndLightning = new _ShadowsAndLightning()
-    poseAndExpression = new _PoseAndExpression()
-    headOcclusion = new _HeadOcclusion()
-    background = new _Background()
+    static get image() { return ImageQualityGroup._image }
+    static _image = new _Image()
+
+    static get headSizeAndPosition() { return ImageQualityGroup._headSizeAndPosition }
+    static _headSizeAndPosition = new _HeadSizeAndPosition()
+
+    static get faceImage() { return ImageQualityGroup._faceImage }
+    static _faceImage = new _FaceImage()
+
+    static get eyes() { return ImageQualityGroup._eyes }
+    static _eyes = new _Eyes()
+
+    static get shadowsAndLightning() { return ImageQualityGroup._shadowsAndLightning }
+    static _shadowsAndLightning = new _ShadowsAndLightning()
+
+    static get poseAndExpression() { return ImageQualityGroup._poseAndExpression }
+    static _poseAndExpression = new _PoseAndExpression()
+
+    static get headOcclusion() { return ImageQualityGroup._headOcclusion }
+    static _headOcclusion = new _HeadOcclusion()
+
+    static get background() { return ImageQualityGroup._background }
+    static _background = new _Background()
 }

package/www/react-native/index.js

@@ -92,6 +92,9 @@ export { EditGroupPersonsRequest, ImageUpload, PageableItemList, PersonDatabase,
 
 
 export class FaceSDK {
+    static get instance() { return FaceSDK._instance }
+    static _instance = new FaceSDK()
+
     get version() { return this._version }
     _version
 

package/www/types/image_quality/image_quality_group.d.ts

@@ -1,15 +1,50 @@
 import { ImageQualityCharacteristic } from './image_quality_characteristic'
 import { ImageQualityRange } from './image_quality_range'
 
+/**
+ * Image Quality characteristic group
+ */
 export class ImageQualityGroup {
-    image: _Image
-    headSizeAndPosition: _HeadSizeAndPosition
-    faceImage: _FaceImage
-    eyes: _Eyes
-    shadowsAndLightning: _ShadowsAndLightning
-    poseAndExpression: _PoseAndExpression
-    headOcclusion: _HeadOcclusion
-    background: _Background
+    /**
+     * The Image characteristics group includes width, height, width to height proportions,
+     * the image RGB channels number, and padding ratio.
+     */
+    static get image(): _Image
+    /**
+     * The Head size and position group includes the position of the "middle point"
+     * relative to the width and height of the image, the head width to the image
+     * width and height ratio, inter-eye distance, yaw, pitch, roll.
+     */
+    static get headSizeAndPosition(): _HeadSizeAndPosition
+    /**
+     * The Face image quality group includes blur and noise levels, unnatural skin tone,
+     * and face dynamic range checks.
+     */
+    static get faceImage(): _FaceImage
+    /**
+     * The Eyes characteristics group checks eyes closure, occlusion, hair coverage,
+     * red eye effect, and whether a person is looking directly at the camera.
+     */
+    static get eyes(): _Eyes
+    /**
+     * The Shadows and lightning characteristics group checks whether a photo
+     * is too dark or overexposed, if there are glares or shadows on the face.
+     */
+    static get shadowsAndLightning(): _ShadowsAndLightning
+    /**
+     * The Pose and expression characteristics group checks the shoulders pose,
+     * face expression, whether there is an open mouth or smile.
+     */
+    static get poseAndExpression(): _PoseAndExpression
+    /**
+     * The Head occlusion group includes checks of glasses, face occlusion, and head coverage.
+     */
+    static get headOcclusion(): _HeadOcclusion
+    /**
+     * The Background characteristics group checks the background uniformity,
+     * shadows on background, and other faces presence on the picture.
+     */
+    static get background(): _Background
 }
 
 export class _Image {

package/www/types/index.d.ts

@@ -83,6 +83,12 @@ export { EditGroupPersonsRequest, ImageUpload, PageableItemList, PersonDatabase,
  * Entry point of the Regula Face SDK.
  */
 export class FaceSDK {
+    /**
+     * The only instance of singleton class {@link FaceSDK}.
+     */
+    static get instance(): FaceSDK
+    private constructor()
+
     /**
      * Information about the SDK.
      */