@faceio/fiojs 1.0.8 → 1.0.9

package/README.md

@@ -1,7 +1,8 @@
 ## Release Updates & Announcments:
-
+* [fio.js V2.1 Released with Age Verification & Minors Access Prevention](https://blog.pixlab.io/2023/06/age-verification-check-available-for-faceio-face-recognition)
+* Introducing the `fetchAllErrorCodes()` method for the NPM Package for much better error logging experience.
 * [New REST API Endpoints Available for FACEIO](https://blog.pixlab.io/2023/04/new-rest-api-endpoints-available-for-faceio)
-* [**Livneness Detection & Face Anti-Spoofing Security Feature Available for FACEIO**](https://www.biometricupdate.com/202303/pixlab-adds-active-liveness-detection-to-faceio-biometrics-framework)
+* [Liveness Detection & Face Anti-Spoofing Security Feature Available for FACEIO](https://www.biometricupdate.com/202303/pixlab-adds-active-liveness-detection-to-faceio-biometrics-framework)
 * [Webhooks Enhancements & Performance Improvements](https://blog.pixlab.io/2022/11/faceios-webhooks-enhancements-performance-improvements)
 * [fio.js V1.9 Released with Face Duplication Prevention](https://blog.pixlab.io/2022/10/fiojs-190-released-with-face-duplication-prevention)
 
@@ -57,7 +58,43 @@ async function authenticateUser(){
     // call to faceio.authenticate() here will automatically trigger the facial authentication process
 }
 function handleError(errCode){
-     // Handle error here
+    // Handle error here
+    // Log all possible error codes during user interaction..
+    // Refer to: https://faceio.net/integration-guide#error-codes
+    // for a detailed overview when these errors are triggered.
+    const fioErrCode = faceio.fetchAllErrorCodes();
+    switch (errCode) {
+    case fioErrCode.PERMISSION_REFUSED:
+        console.log("Access to the Camera stream was denied by the end user");
+    break;
+    case fioErrCode.NO_FACES_DETECTED:
+        console.log("No faces were detected during the enroll or authentication process");
+    break;
+    case fioErrCode.UNRECOGNIZED_FACE:
+        console.log("Unrecognized face on this application's Facial Index");
+    break;
+    case fioErrCode.MANY_FACES:
+        console.log("Two or more faces were detected during the scan process");
+    break;
+    case fioErrCode.FACE_DUPLICATION:
+        console.log("User enrolled previously (facial features already recorded). Cannot enroll again!");
+    break;
+    case fioErrCode.MINORS_NOT_ALLOWED:
+        console.log("Minors are not allowed to enroll on this application!");
+    break;
+    case fioErrCode.PAD_ATTACK:
+        console.log("Presentation (Spoof) Attack (PAD) detected during the scan process");
+    break;
+    case fioErrCode.FACE_MISMATCH:
+        console.log("Calculated Facial Vectors of the user being enrolled do not matches");
+    break;
+    case fioErrCode.WRONG_PIN_CODE:
+        console.log("Wrong PIN code supplied by the user being authenticated");
+    break;
+    // ...
+    // Refer to the boilerplate at: https://gist.github.com/symisc/34203d2811a39f2a871373abc6dd1ce9
+    // for the list of all possible error codes.
+    }
 }
 
 export default App;

package/index.js

@@ -68,4 +68,35 @@ module.exports = class faceio {
     async restartSession() {
         return await internalCDN.restartSession()
     }
-}
+    
+    /**
+    * Return the list of all possible error codes than can be triggered during failed authentication or enrollment.
+    * @returns fioErrorCode object
+    */
+    fetchAllErrorCodes(){
+     return {
+        PERMISSION_REFUSED: 1, /* Access to the Camera stream was denied by the end user */
+        NO_FACES_DETECTED:  2, /* No faces were detected during the enroll or authentication process */
+        UNRECOGNIZED_FACE:  3, /* Unrecognized face on this application's Facial Index */
+        MANY_FACES:         4, /* Two or more faces were detected during the scan process */
+        PAD_ATTACK:         5, /* Presentation (Spoof) Attack (PAD) detected during the scan process */
+        FACE_MISMATCH:      6, /* Calculated Facial Vectors of the user being enrolled do not matches */
+        NETWORK_IO:         7, /* Error while establishing network connection with the target FACEIO processing node */
+        WRONG_PIN_CODE:     8, /* Wrong PIN code supplied by the user being authenticated */
+        PROCESSING_ERR:     9, /* Server side error */
+        UNAUTHORIZED:       10, /* Your application is not allowed to perform the requested operation (eg. Invalid ID, Blocked, Paused, etc.). Refer to the FACEIO Console for additional information */
+        TERMS_NOT_ACCEPTED: 11, /* Terms & Conditions set out by FACEIO/host application rejected by the end user */
+        UI_NOT_READY:       12, /* The FACEIO Widget code could not be (or is being) injected onto the client DOM */
+        SESSION_EXPIRED:    13, /* Client session expired. The first promise was already fulfilled but the host application failed to act accordingly */
+        TIMEOUT:            14, /* Ongoing operation timed out (eg, Camera access permission, ToS accept delay, Face not yet detected, Server Reply, etc.) */
+        TOO_MANY_REQUESTS:  15, /* Widget instantiation requests exceeded for freemium applications. Does not apply for upgraded applications */
+        EMPTY_ORIGIN:       16, /* Origin or Referer HTTP request header is empty or missing */
+        FORBIDDDEN_ORIGIN:  17, /* Domain origin is forbidden from instantiating fio.js */
+        FORBIDDDEN_COUNTRY: 18, /* Country ISO-3166-1 Code is forbidden from instantiating fio.js */
+        UNIQUE_PIN_REQUIRED: 19, /* Supplied PIN Code must be unique among other PIN's on this application */
+        SESSION_IN_PROGRESS: 20, /* Another authentication or enrollment session is in progress */
+        FACE_DUPLICATION:    21, /* Prevent face duplication during enrollment. Same user trying to enroll twice or more */
+        MINORS_NOT_ALLOWED:  22  /* Minors not allowed to enroll on this application */ 
+    };   
+   }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faceio/fiojs",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "description": "Facial Authentication for the Web",
   "main": "index.js",
   "homepage": "https://faceio.net/",