update-clients

.github/workflows/run-smoke-test.yml

@@ -21,10 +21,10 @@ jobs:
       - run: node --unhandled-rejections=strict index.js
         working-directory: ./examples/basic/esm
         env:
-          API_BASE_PATH: "https://test-faceapi.regulaforensics.com"
+          API_BASE_PATH: "https://nightly-faceapi.regulaforensics.com"
       - run: npm install
         working-directory: ./examples/basic/cjs
       - run: node --unhandled-rejections=strict index.js
         working-directory: ./examples/basic/cjs
         env:
-          API_BASE_PATH: "https://test-faceapi.regulaforensics.com"
+          API_BASE_PATH: "https://nightly-faceapi.regulaforensics.com"

examples/auth/client/index.js

@@ -1,7 +1,7 @@
 import { FaceSdk, ImageSource } from '@regulaforensics/facesdk-webclient';
 import fs from 'fs';
-import qs from "qs";
-import axios from "axios";
+import qs from 'qs';
+import axios from 'axios';
 
 const GATEWAY_BASE_URL = 'http://localhost:8080';
 
@@ -39,13 +39,7 @@ async function get_authorization_token() {
     const face1 = fs.readFileSync('face1.jpg').buffer;
     const face2 = fs.readFileSync('face2.jpg').buffer;
     const token = await get_authorization_token();
-    const sdk = new FaceSdk({ basePath: apiBasePath, baseOptions: { headers: { Authorization: `Bearer ${token}` }},});
-
-    const diagnostic = await sdk.diagnosticsApi.readiness();
-    console.log('-----------------------------------------------------------------');
-    console.log('                         Diagnostic                              ');
-    console.log('-----------------------------------------------------------------');
-    console.log(diagnostic);
+    const sdk = new FaceSdk({ basePath: apiBasePath, baseOptions: { headers: { Authorization: `Bearer ${token}` } } });
 
     const matchingResponse = await sdk.matchingApi.match({
         tag: '1',

examples/basic/README.md

@@ -47,15 +47,6 @@ API_BASE_PATH="http://192.168.0.101:41101" node .
 
 This sample generates next text output:
 ```text
------------------------------------------------------------------
-                         Diagnostic                              
------------------------------------------------------------------
-{
-  metadata: {
-    serverTime: '2023-10-20T11:57:46.509152',
-    ctx: { userIp: 'xxx.xx.xx.xx' }
-  }
-}
 -----------------------------------------------------------------
                          Compare Results                         
 -----------------------------------------------------------------

examples/basic/angular/package.json

@@ -19,6 +19,7 @@
     "@angular/platform-browser-dynamic": "^15.1.0",
     "@angular/router": "^15.1.0",
     "@regulaforensics/facesdk-webclient": "file:../../..",
+    "ngx-json-viewer": "^3.2.1",
     "rxjs": "~7.8.0",
     "tslib": "^2.3.0",
     "zone.js": "~0.12.0"

examples/basic/angular/src/app/app.component.css

@@ -2,15 +2,18 @@
     display: flex;
     flex-direction: column;
     gap: 15px;
-    position: absolute;
     height: 100%;
     width: 100%;
-    top: 0;
-    left: 0;
     justify-content: center;
     align-items: center;
 }
 
+.result {
+    width: 500px;
+    border: 1px solid #e9e9e9;
+    padding: 10px;
+}
+
 button {
     padding: 10px 30px;
     color: white;

examples/basic/angular/src/app/app.component.html

@@ -1,8 +1,9 @@
 <div class="container">
     Face Sdk
     <button (click)="diagnostic()">
-        Diagnostic
+        Diagnostic Detection
     </button>
-
-    <pre>{{ resultObject | json }}</pre>
+    <div class="result">
+        <ngx-json-viewer [json]="resultObject"></ngx-json-viewer>
+    </div>
 </div>

examples/basic/angular/src/app/app.component.ts

@@ -1,5 +1,6 @@
 import { Component } from '@angular/core';
 import { FaceSdk } from '@regulaforensics/facesdk-webclient';
+import { imageBase64 } from './resources';
 
 @Component({
     selector: 'app-root',
@@ -15,7 +16,16 @@ export class AppComponent {
     title = 'Face Sdk Web Client Example';
 
     async diagnostic() {
-        const result = await this.faceSdk.diagnosticsApi.readiness();
-        this.resultObject = result;
+        const detectResponse = await this.faceSdk.matchingApi.detect({
+            tag: '1',
+            image: imageBase64,
+            thumbnails: true,
+        });
+        const detectResults = detectResponse.results;
+        if (detectResults) {
+            detectResults.detections[0].crop = 'base64Image';
+            detectResults.detections[0].thumbnail = 'base64Thumbnail';
+            this.resultObject = detectResults;
+        }
     }
 }

examples/basic/angular/src/app/app.module.ts

@@ -1,13 +1,15 @@
 import { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';
 import { BrowserModule } from '@angular/platform-browser';
 import { AppComponent } from './app.component';
+import { NgxJsonViewerModule } from 'ngx-json-viewer';
 
 @NgModule({
     declarations: [
         AppComponent
     ],
     imports: [
-        BrowserModule
+        BrowserModule,
+        NgxJsonViewerModule
     ],
     providers: [],
     bootstrap: [AppComponent],

examples/basic/cjs/index.js

@@ -9,12 +9,6 @@ const fs = require('fs');
 
     const sdk = new FaceSdk({ basePath: apiBasePath });
 
-    const diagnostic = await sdk.diagnosticsApi.readiness();
-    console.log('-----------------------------------------------------------------');
-    console.log('                         Diagnostic                              ');
-    console.log('-----------------------------------------------------------------');
-    console.log(diagnostic);
-
     const matchingResponse = await sdk.matchingApi.match({
         images: [
             { type: ImageSource.LIVE, data: face1 },

examples/basic/esm/index.js

@@ -8,12 +8,6 @@ import fs from 'fs';
     const face2 = fs.readFileSync('../face2.jpg').buffer;
     const sdk = new FaceSdk({ basePath: apiBasePath });
 
-    const diagnostic = await sdk.diagnosticsApi.readiness();
-    console.log('-----------------------------------------------------------------');
-    console.log('                         Diagnostic                              ');
-    console.log('-----------------------------------------------------------------');
-    console.log(diagnostic);
-
     const matchingResponse = await sdk.matchingApi.match({
         tag: '1',
         images: [

src/.openapi-generator/FILES

@@ -32,6 +32,8 @@ models/face-sdkresult-code.ts
 models/face-sdkresult.ts
 models/faces-response-all-of.ts
 models/faces-response.ts
+models/filter-op.ts
+models/filter-search-request.ts
 models/group-all-of.ts
 models/group-page-all-of.ts
 models/group-page.ts
@@ -44,6 +46,7 @@ models/image-page.ts
 models/image-source.ts
 models/image.ts
 models/index.ts
+models/liveness-type.ts
 models/match-and-search-request-all-of-images.ts
 models/match-and-search-request-all-of.ts
 models/match-and-search-request.ts

src/api.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Regula Face SDK Web API
- * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.  The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face Detection</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face Match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face Search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness Assessment</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core 
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core 
  *
  * The version of the OpenAPI document: 6.1.0
  * 

src/api/diagnostics-api.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /**
  * Regula Face SDK Web API
- * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.  The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face Detection</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face Match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face Search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness Assessment</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core 
+ * <a href=\"https://regulaforensics.com/products/face-recognition-sdk/  \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side.   The Face SDK includes the following features:  * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a>  Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi  \" target=\"_blank\">OpenAPI specification on GitHub</a>.   ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core 
  *
  * The version of the OpenAPI document: 6.1.0
  *