Merge pull request #216 from regulaforensics/develop

Develop -> Stable

Author: ArtsiomTsybulko

examples/auth/client/encrypted-rcl-example.js

@@ -22,7 +22,7 @@ const { DOCUMENT_NUMBER } = TextFieldType;
 
     api.setLicense(license);
 
-    const serverInfo = await api.ping();
+    const serverInfo = await api.health();
 
     const license_file = fs.readFileSync('license.txt', 'utf8');
     const encrypted_rcl = fs.readFileSync('encrypted-rcl.txt', 'utf8');

examples/auth/client/index.js

@@ -55,7 +55,7 @@ const api = new DocumentReaderApi({
 // Uncomment the line below if you want to transfer the license with each request
 // api.setLicense(license);
 
-const serverInfo = await api.ping();
+const serverInfo = await api.health();
 
 const white_page_0 = fs.readFileSync('WHITE.jpg').buffer;
 

examples/basic/encrypted-rcl-example.js

@@ -22,7 +22,7 @@ const { DOCUMENT_NUMBER } = TextFieldType;
 
     api.setLicense(license);
 
-    const serverInfo = await api.ping();
+    const serverInfo = await api.health();
 
     const license_file = fs.readFileSync('license.txt', 'utf8');
     const encrypted_rcl = fs.readFileSync('encrypted-rcl.txt', 'utf8');

examples/basic/index.js

@@ -19,7 +19,7 @@ const api = new DocumentReaderApi({ basePath: apiBasePath });
 // Uncomment the line below if you want to transfer the license with each request
 // api.setLicense(license);
 
-const serverInfo = await api.ping();
+const serverInfo = await api.health();
 
 const white_page_0 = fs.readFileSync('WHITE.jpg').buffer;
 

src/ext/document-reader.ts

@@ -1,5 +1,6 @@
 import { DefaultApi } from '../api/default-api';
 import { ProcessApi } from '../api/process-api';
+import { HealthcheckApi } from '../api/healthcheck-api';
 import { TransactionApi } from '../api/transaction-api';
 import { Response } from './process-response';
 import { Configuration, ConfigurationParameters } from '../configuration';
@@ -16,13 +17,15 @@ import {
     InlineResponse200,
     ListTransactionsByTagResponse,
     TransactionProcessGetResponse,
+    Healthcheck,
 } from '../models';
 import { Base64String, instanceOfProcessRequest, ProcessRequestExt } from './process-request-ext';
 import { ProcessRequestImageWrapper } from './process-request-image-wrapper';
 import * as converter from 'base64-arraybuffer';
 
 export class DocumentReaderApi {
     private readonly defaultApi: DefaultApi;
+    private readonly healthcheckApi: HealthcheckApi;
     private readonly processApi: ProcessApi;
     private readonly transactionApi: TransactionApi;
 
@@ -34,6 +37,7 @@ export class DocumentReaderApi {
         axios: AxiosInstance = globalAxios,
     ) {
         this.defaultApi = new DefaultApi(new Configuration(configuration), basePath, axios);
+        this.healthcheckApi = new HealthcheckApi(new Configuration(configuration), basePath, axios);
         this.processApi = new ProcessApi(new Configuration(configuration), basePath, axios);
         this.transactionApi = new TransactionApi(new Configuration(configuration), basePath, axios);
     }
@@ -43,6 +47,11 @@ export class DocumentReaderApi {
         return axiosResult.data;
     }
 
+    async health(xRequestID?: string): Promise<Healthcheck> {
+        const axiosResult = await this.healthcheckApi.healthz(xRequestID);
+        return axiosResult.data;
+    }
+
     /**
      *
      * @summary Process list of documents images and return extracted data

src/models/auth-params.ts

@@ -111,6 +111,12 @@ export interface AuthParams {
      * @memberof AuthParams
      */
     checkLetterScreen?: boolean;
+    /**
+     * This parameter is used to enable Security text check
+     * @type {boolean}
+     * @memberof AuthParams
+     */
+    checkSecurityText?: boolean;
 }
 
 

src/models/check-diagnose.ts

@@ -134,6 +134,7 @@ export enum CheckDiagnose {
     OCR_QUALITY_INVALID_FONT = 221,
     OCR_QUALITY_INVALID_BACKGROUND = 222,
     LASINK_INVALID_LINES_FREQUENCY = 230,
+    DOC_LIVENESS_DOCUMENT_NOT_LIVE = 238,
     DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED = 239,
     DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED = 240,
     DOC_LIVENESS_INVALID_BARCODE_BACKGROUND = 241,

src/models/face-api.ts

@@ -70,7 +70,7 @@ export interface FaceApi {
      */
     proxy_type?: number;
     /**
-     * Minimum age of a child, at which portrait comparison result will be effective. Default: 13.
+     * The age threshold for the portrait comparison. Default: 13.
      * @type {number}
      * @memberof FaceApi
      */

src/models/image-quality-check-type.ts

@@ -51,7 +51,11 @@ export enum ImageQualityCheckType {
     /**
     * Signals if the document image is bright enough
     */
-    Brightness = 9
+    Brightness = 9,
+    /**
+    * Signals if the document image has occlusion
+    */
+    Occlusion = 10
 }
 
 

src/models/input-image-quality-checks.ts

@@ -51,7 +51,11 @@ export enum InputImageQualityChecks {
     /**
     * Signals if the document image is bright enough
     */
-    Brightness = 'brightnessCheck'
+    Brightness = 'brightnessCheck',
+    /**
+    * Signals if the document image has occlusion
+    */
+    Occlusion = 'occlusionCheck'
 }