@regulaforensics/face-sdk 7.1.211-rc → 7.1.253-beta

package/examples/capacitor/package.json

@@ -1,64 +1,27 @@
 {
   "name": "face-sdk",
-  "private": true,
-  "version": "1.0.0",
-  "type": "module",
   "scripts": {
     "setup": "scripts/setup.sh",
     "ios": "scripts/ios.sh",
-    "android": "scripts/android.sh",
-    "dev": "vite",
-    "build": "tsc && vite build",
-    "preview": "vite preview",
-    "test.e2e": "cypress run",
-    "test.unit": "vitest",
-    "lint": "eslint"
+    "android": "scripts/android.sh"
   },
   "dependencies": {
-    "@regulaforensics/face-sdk": "7.1.211-rc",
-    "@regulaforensics/face-core-basic": "7.1.126-rc",
-    "@awesome-cordova-plugins/camera": "6.6.0",
+    "@regulaforensics/face-sdk": "7.1.253-beta",
+    "@regulaforensics/face-core-basic": "7.1.99-beta",
     "@awesome-cordova-plugins/file": "6.6.0",
-    "@awesome-cordova-plugins/dialogs": "6.6.0",
-    "@capacitor/android": "7.0.0-rc.0",
-    "@capacitor/core": "7.0.0-rc.0",
-    "@capacitor/ios": "7.0.0-rc.0",
-    "@capacitor/app": "7.0.0-rc.0",
-    "@capacitor/haptics": "7.0.0-rc.0",
-    "@capacitor/keyboard": "7.0.0-rc.0",
-    "@capacitor/status-bar": "7.0.0-rc.0",
-    "@ionic/react": "^7.0.0",
-    "@ionic/react-router": "^7.0.0",
-    "@types/react-router": "^5.1.20",
-    "@types/react-router-dom": "^5.3.3",
-    "cordova-plugin-camera": "7.0.0",
-    "cordova-plugin-file": "8.0.1",
-    "cordova-plugin-dialogs": "^2.0.2",
-    "jetifier": "2.0.0",
-    "ionicons": "^7.0.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "react-router": "^5.3.4",
-    "react-router-dom": "^5.3.4"
-  },
-  "devDependencies": {
-    "@capacitor/cli": "7.0.0-rc.0",
-    "@testing-library/dom": ">=7.21.4",
-    "@testing-library/jest-dom": "^5.16.5",
-    "@testing-library/react": "^14.0.0",
-    "@testing-library/user-event": "^14.4.3",
-    "@types/react": "^18.0.27",
-    "@types/react-dom": "^18.0.10",
-    "@vitejs/plugin-legacy": "^5.0.0",
-    "@vitejs/plugin-react": "^4.0.1",
-    "cypress": "^13.5.0",
-    "eslint": "^8.35.0",
-    "eslint-plugin-react": "^7.32.2",
-    "jsdom": "^22.1.0",
-    "terser": "^5.4.0",
-    "typescript": "^5.1.6",
-    "vite": "^5.0.0",
-    "vitest": "^0.34.6"
-  },
-  "description": "An Ionic project"
-}
+    "@awesome-cordova-plugins/camera": "6.6.0",
+    "cordova-plugin-file": "8.1.3",
+    "cordova-plugin-camera": "8.0.0",
+    "@capacitor/dialog": "7.0.1",
+    "@capacitor/cli": "7.0.1",
+    "@capacitor/core": "7.0.1",
+    "@capacitor/app": "7.0.0",
+    "@capacitor/ios": "7.0.1",
+    "@capacitor/android": "7.0.1",
+    "@capacitor/status-bar": "7.0.0",
+    "@ionic/react": "8.4.3",
+    "@vitejs/plugin-react": "4.3.4",
+    "vite-plugin-static-copy": "2.3.1",
+    "@types/react-router-dom": "5.3.3"
+  }
+}

package/examples/capacitor/scripts/setup.sh

@@ -2,3 +2,5 @@
 set -e
 
 npm install
+cd ios/App
+pod install || pod update

package/examples/capacitor/src/main.css

@@ -0,0 +1,77 @@
+html,
+body {
+    width: 99%;
+    height: 99vh;
+    display: flex;
+    flex-direction: column;
+}
+
+.page {
+    height: 100%;
+    display: flex;
+    flex-direction: column;
+}
+
+.column {
+    display: flex;
+    flex-direction: column;
+    align-items: center;
+    justify-content: center;
+    width: 100%;
+}
+
+.row {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: center;
+}
+
+.header {
+    text-align: center;
+    padding-top: 80px;
+    margin-top: -10px;
+    background-color: rgba(0, 0, 0, 0.03);
+}
+
+.title {
+    font-weight: 600;
+    font-size: 18px;
+    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
+}
+
+.divider {
+    height: 1px;
+    background-color: rgba(0, 0, 0, 0.075);
+    margin-top: 13px;
+}
+
+.no-scroll {
+    flex-grow: 1;
+    overflow-y: hidden;
+    overflow-x: hidden;
+}
+
+.button {
+    width: 175px;
+    height: 40px;
+    margin: 5px;
+    margin-top: 10px;
+    background-color: #4285F4;
+    color: white;
+    border: none;
+    padding: 10px 20px;
+    font-size: 16px;
+    border-radius: 100px;
+    cursor: pointer;
+    transition: all 0.3s ease;
+    user-select: none;
+    -webkit-user-select: none;
+    -moz-user-select: none;
+    -ms-user-select: none;
+}
+
+.button:active {
+    position: relative;
+    top: 1px;
+}

package/examples/capacitor/src/main.html

@@ -0,0 +1,22 @@
+<div class="page">
+    <div class="column header">
+        <span id="status" class="title">Loading...</span>
+        <div class="column divider"></div>
+    </div>
+    <div id="main" class="column no-scroll">
+        <div class="column">
+            <img id="first-image" src="images/portrait.png" width="150px" style="padding: 10px">
+            <img id="second-image" src="images/portrait.png" width="150px" style="padding: 10px">
+        </div>
+        <div class="column" style="padding: 10px">
+            <button id="match-faces" class="button">Match</button>
+            <button id="start-liveness" class="button">Liveness</button>
+            <button id="clear-results" class="button">Clear</button>
+        </div>
+        <div>
+            Similarity: <span style="margin-right: 15px" id="similarity-status">null</span> Liveness: <span
+                id="liveness-status">null</span>
+        </div>
+        <div style="padding-top: 100px;"></div>
+    </div>
+</div>

package/examples/capacitor/src/main.tsx

@@ -1,11 +1,152 @@
-import React from 'react';
-import { createRoot } from 'react-dom/client';
-import App from './App';
-
-const container = document.getElementById('root');
-const root = createRoot(container!);
-root.render(
-  <React.StrictMode>
-    <App />
-  </React.StrictMode>
-);
+import '@ionic/react/css/core.css'
+import './main.css'
+import { setupIonicReact } from '@ionic/react'
+import { StatusBar, Style } from '@capacitor/status-bar'
+import { File } from '@awesome-cordova-plugins/file'
+import { Dialog } from '@capacitor/dialog'
+import { Camera, DestinationType, MediaType, PictureSourceType } from '@awesome-cordova-plugins/camera'
+import { FaceSDK, MatchFacesRequest, MatchFacesImage, InitConfig, LivenessSkipStep, ImageType, LivenessStatus, LivenessConfig } from '@regulaforensics/face-sdk'
+
+async function init() {
+  if (!await initializeReader()) return
+  setStatus("Ready")
+}
+
+async function startLiveness() {
+  var response = await faceSdk.startLiveness({
+    config: new LivenessConfig({
+      skipStep: [LivenessSkipStep.ONBOARDING_STEP]
+    }),
+    notificationCompletion: (notification) => {
+      console.log("LivenessStatus: " + notification.status)
+    }
+  })
+  if (response.image == null) return
+  setImage("data:image/png;base64," + response.image, ImageType.LIVE, 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)
+// otherwise init without license.
+async function initializeReader() {
+  setStatus("Initializing...")
+
+  var license = await loadAssetIfExists("regula.license")
+  var config: InitConfig | undefined
+  if (license != null) config = new InitConfig(license)
+  var [success, error] = await faceSdk.initialize({ config: config })
+
+  if (!success && 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(base64)
+    setLivenessStatus("null")
+  }
+  if (position == 2) {
+    image2 = mfImage
+    setUiImage2(base64)
+  }
+}
+
+async function useCamera(position: number) {
+  var response = await faceSdk.startFaceCapture()
+  if (response.image == null) return
+  var image = response.image
+  setImage("data:image/png;base64," + image.image, image.imageType, position)
+}
+
+async function useGallery(position: number) {
+  var image = await Camera.getPicture({
+    destinationType: DestinationType.DATA_URL,
+    mediaType: MediaType.PICTURE,
+    sourceType: PictureSourceType.PHOTOLIBRARY
+  })
+  setImage(image, ImageType.PRINTED, position)
+}
+
+async function pickImage(position: number) {
+  var response = await Dialog.confirm({
+    message: "Select option",
+    okButtonTitle: "Use camera",
+    cancelButtonTitle: "Use gallery"
+  })
+  if (response.value) useCamera(position)
+  else useGallery(position)
+}
+
+async function loadAssetIfExists(path: string): Promise<string | null> {
+  try {
+    var dir = await File.resolveDirectoryUrl(File.applicationDirectory + "public/assets")
+    var fileEntry = await File.getFile(dir, path, null)
+    var result = await new Promise<string | null>((resolve, _) => {
+      fileEntry.file(file => {
+        var reader = new FileReader()
+        reader.onloadend = (_) => resolve(reader.result as string)
+        reader.readAsDataURL(file)
+      }, _ => resolve(null))
+    })
+    return result
+  } catch (_) {
+    return null
+  }
+}
+
+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 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 = () => {
+  setUiImage1("images/portrait.png")
+  setUiImage2("images/portrait.png")
+}
+
+setupIonicReact()
+StatusBar.setStyle({ style: Style.Light })
+document.addEventListener('deviceready', () => {
+  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()
+})

package/examples/capacitor/tsconfig.json

@@ -1,21 +1,5 @@
 {
   "compilerOptions": {
-    "target": "ESNext",
-    "useDefineForClassFields": true,
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "allowJs": false,
-    "skipLibCheck": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "strict": true,
-    "forceConsistentCasingInFileNames": true,
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
     "jsx": "react-jsx"
-  },
-  "include": ["src"],
-  "references": [{ "path": "./tsconfig.node.json" }]
+  }
 }

package/examples/capacitor/vite.config.ts

@@ -1,16 +1,17 @@
-import legacy from '@vitejs/plugin-legacy'
 import react from '@vitejs/plugin-react'
 import { defineConfig } from 'vite'
+import { viteStaticCopy } from 'vite-plugin-static-copy';
 
-// https://vitejs.dev/config/
 export default defineConfig({
   plugins: [
     react(),
-    legacy()
-  ],
-  test: {
-    globals: true,
-    environment: 'jsdom',
-    setupFiles: './src/setupTests.ts',
-  }
+    viteStaticCopy({
+      targets: [
+        {
+          src: 'src/main.html',
+          dest: '.'
+        }
+      ]
+    })],
+  build: { outDir: 'www' }
 })

package/examples/cordova/README.md

@@ -12,16 +12,14 @@
 **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
+## How to use offline match
 1. Place a license that supports offline match at `www/regula.license`.
 
-2. Change `android-packageName` and `ios-CFBundleIdentifier` in `config.xml` if required by your license.
-
-3. Change core with the following commands:
+2. Change core with the following commands:
 ```bash
 cordova plugin remove @regulaforensics/face-core-basic
 cordova plugin add @regulaforensics/face-core-match
-cordova prepare
+npm run setup
 ```
 
-4. Turn off the internet and run the app.
+3. Turn off the internet and run the app.

package/examples/cordova/config.xml

@@ -1,21 +1,11 @@
-<?xml version='1.0' encoding='utf-8'?>
-<widget android-packageName="com.regula.faceapi" ios-CFBundleIdentifier="regula.FaceSDKSample" version="1.0.0" xmlns:android="http://schemas.android.com/apk/res/android" xmlns="http://www.w3.org/ns/widgets" xmlns:cdv="http://cordova.apache.org/ns/1.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>
-    <author email="cordova.support@regulaforensics.com" href="https://mobile.regulaforensics.com">Regula Forensics Inc.</author>
-    <content src="index.html" />
-    <access origin="*" />
-    <allow-intent href="http://*/*" />
-    <allow-intent href="https://*/*" />
-    <allow-intent href="tel:*" />
-    <allow-intent href="sms:*" />
-    <allow-intent href="mailto:*" />
-    <allow-intent href="geo:*" />
     <platform name="android">
         <preference name="orientation" value="portrait" />
         <preference name="GradlePluginKotlinEnabled" value="true" />
-        <preference name="android-minSdkVersion" value="23" />
+        <preference name="android-minSdkVersion" value="24" />
         <preference name="android-targetSdkVersion" value="35" />
-        <allow-intent href="market:*" />
         <config-file parent="/*" target="AndroidManifest.xml">
             <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
         </config-file>
@@ -25,8 +15,7 @@
     </platform>
     <platform name="ios">
         <preference name="orientation" value="portrait" />
-        <allow-intent href="itms:*" />
-        <allow-intent href="itms-apps:*" />
+        <preference name="DisallowOverscroll" value="true" />
         <config-file target="*-Info.plist" parent="NSCameraUsageDescription">
             <string>To use camera</string>
         </config-file>