@regulaforensics/document-reader-webclient 7.4.82-rc → 7.4.97

package/lib/index.d.ts

@@ -469,7 +469,11 @@ export enum AuthenticityResultType {
     /**
     * Extended MRZ check
     */
-    EXTENDED_MRZ_CHECK = 8388608
+    EXTENDED_MRZ_CHECK = 8388608,
+    /**
+    * Encrypted IPI
+    */
+    ENCRYPTED_IPI = 16777216
 }
 /**
  * Regula Document Reader Web API
@@ -558,7 +562,9 @@ export enum CheckDiagnose {
     UV_DULL_PAPER_ERROR = 54,
     FALSE_LUMINESCENCE_IN_BLANK = 55,
     BAD_AREA_IN_AXIAL = 60,
-    FALSE_IP_PARAMETERS = 65,
+    FALSE_IPI_PARAMETERS = 65,
+    ENCRYPTED_IPI_NOT_FOUND = 66,
+    ENCRYPTED_IPI_DATA_DONT_MATCH = 67,
     FIELD_POS_CORRECTOR_HIGHLIGHT_IR = 80,
     FIELD_POS_CORRECTOR_GLARES_IN_PHOTO_AREA = 81,
     FIELD_POS_CORRECTOR_PHOTO_REPLACED = 82,
@@ -636,7 +642,7 @@ export enum CheckDiagnose {
     CHD_ICAO_IDB_SIGNATURE_MUST_BE_PRESENT = 246,
     CHD_ICAO_IDB_SIGNATURE_MUST_NOT_BE_PRESENT = 247,
     CHD_ICAO_IDB_CERTIFICATE_MUST_NOT_BE_PRESENT = 248,
-    LAST_DIAGNOSE_VALUE = 250
+    CHD_INCORRECT_OBJECT_COLOR = 250
 }
 /**
  * Regula Document Reader Web API
@@ -1265,6 +1271,12 @@ export interface AuthenticityCheckResultItem {
      * @memberof AuthenticityCheckResultItem
      */
     ElementDiagnose?: CheckDiagnose;
+    /**
+     *
+     * @type {number}
+     * @memberof AuthenticityCheckResultItem
+     */
+    PercentValue?: number;
 }
 /**
  *
@@ -3241,10 +3253,6 @@ export enum ImageQualityCheckType {
     */
     Bounds = 5,
     /**
-    * Signals if an image is captured from screen
-    */
-    ScreenCapture = 6,
-    /**
     * Signals if the portrait is present
     */
     Portrait = 7,
@@ -6745,7 +6753,39 @@ export enum TextFieldType {
     /**
     * Signature
     */
-    SIGNATURE = 683
+    SIGNATURE = 683,
+    /**
+    * Unique Certificate Identifier
+    */
+    FT_UNIQUE_CERTIFICATE_IDENTIFIER = 684,
+    /**
+    * Email
+    */
+    FT_EMAIL = 685,
+    /**
+    * Date of Specimen Collection
+    */
+    FT_DATE_OF_SPECIMEN_COLLECTION = 686,
+    /**
+    * Type Of Testing
+    */
+    FT_TYPE_OF_TESTING = 687,
+    /**
+    * Result Of Testing
+    */
+    FT_RESULT_OF_TESTING = 688,
+    /**
+    * Method Of Testing
+    */
+    FT_METHOD_OF_TESTING = 689,
+    /**
+    * Digital Travel Authorization Number
+    */
+    FT_DIGITAL_TRAVEL_AUTHORIZATION_NUMBER = 690,
+    /**
+    * Date of First Positive Test Result
+    */
+    FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT = 691
 }
 /**
  * Regula Document Reader Web API
@@ -7845,6 +7885,42 @@ export interface FaceApi {
      */
     proxy_type?: number;
 }
+/**
+ * Regula Document Reader Web API
+ * Documents recognition as easy as reading two bytes.  # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
+ *
+ * The version of the OpenAPI document: 7.2.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetTransactionsByTagResponse
+ */
+export interface GetTransactionsByTagResponse {
+    /**
+     * Transaction id
+     * @type {number}
+     * @memberof GetTransactionsByTagResponse
+     */
+    id?: number;
+    /**
+     * Transaction status
+     * @type {number}
+     * @memberof GetTransactionsByTagResponse
+     */
+    state?: number;
+    /**
+     * Last time updated
+     * @type {string}
+     * @memberof GetTransactionsByTagResponse
+     */
+    updatedAt?: string;
+}
 /**
  * Regula Document Reader Web API
  * Documents recognition as easy as reading two bytes.  # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
@@ -7898,12 +7974,6 @@ export interface ImageQA {
      * @memberof ImageQA
      */
     colornessCheck?: boolean;
-    /**
-     * This option enables screen capture (moire patterns) check while performing image quality validation.
-     * @type {boolean}
-     * @memberof ImageQA
-     */
-    moireCheck?: boolean;
     /**
      * This parameter specifies the necessary margin. Default 0.
      * @type {number}
@@ -8228,6 +8298,27 @@ export interface InlineResponse2001 {
      */
     CoreLibResultCode?: number;
 }
+/**
+ *
+ * @export
+ * @interface ListTransactionsByTagResponse
+ */
+export interface ListTransactionsByTagResponse {
+    /**
+     *
+     * @type {Array<GetTransactionsByTagResponse>}
+     * @memberof ListTransactionsByTagResponse
+     */
+    items?: Array<GetTransactionsByTagResponse>;
+    /**
+     *
+     * @type {{ [key: string]: object; }}
+     * @memberof ListTransactionsByTagResponse
+     */
+    metadata?: {
+        [key: string]: object;
+    };
+}
 /**
  * Regula Document Reader Web API
  * Documents recognition as easy as reading two bytes.  # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
@@ -9350,6 +9441,10 @@ export enum Result {
     */
     LEXICAL_ANALYSIS = 15,
     /**
+    * Contains raw uncropped images
+    */
+    RAW_UNCROPPED_IMAGE = 16,
+    /**
     * Contains Visual zone OCR results
     */
     VISUAL_TEXT = 17,
@@ -9874,6 +9969,12 @@ export interface ProcessParams {
      * @memberof ProcessParams
      */
     mrzDetectMode?: MrzDetectModeEnum;
+    /**
+     * This parameter is used to generate numeric representation for issuing state and nationality codes
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    generateNumericCodes?: boolean;
 }
 /**
  *
@@ -9936,12 +10037,6 @@ export interface ProcessSystemInfo {
  * @interface ProcessRequest
  */
 export interface ProcessRequest {
-    /**
-     * session id
-     * @type {string}
-     * @memberof ProcessRequest
-     */
-    tag?: string;
     /**
      *
      * @type {ProcessParams}
@@ -9954,6 +10049,24 @@ export interface ProcessRequest {
      * @memberof ProcessRequest
      */
     List?: Array<ProcessRequestImage>;
+    /**
+     * Session ID
+     * @type {string}
+     * @memberof ProcessRequest
+     */
+    tag?: string;
+    /**
+     * Customer name
+     * @type {string}
+     * @memberof ProcessRequest
+     */
+    tenant?: string;
+    /**
+     * Environment type
+     * @type {string}
+     * @memberof ProcessRequest
+     */
+    env?: string;
     /**
      * Live portrait photo
      * @type {string}
@@ -10091,28 +10204,53 @@ export interface TransactionProcessGetResponse {
 /**
  *
  * @export
- * @interface TransactionScenarioRequest
+ * @interface TransactionProcessRequest
  */
-export interface TransactionScenarioRequest {
+export interface TransactionProcessRequest {
     /**
      *
-     * @type {Scenario}
-     * @memberof TransactionScenarioRequest
+     * @type {ProcessParams}
+     * @memberof TransactionProcessRequest
      */
-    scenario?: Scenario;
-}
-/**
- *
- * @export
- * @interface TransactionProcessRequest
- */
-export interface TransactionProcessRequest {
+    processParam: ProcessParams;
     /**
      *
-     * @type {TransactionScenarioRequest}
+     * @type {Array<ProcessRequestImage>}
+     * @memberof TransactionProcessRequest
+     */
+    List?: Array<ProcessRequestImage>;
+    /**
+     * Live portrait photo
+     * @type {string}
+     * @memberof TransactionProcessRequest
+     */
+    livePortrait?: string;
+    /**
+     * Portrait photo from an external source
+     * @type {string}
      * @memberof TransactionProcessRequest
      */
-    processParam: TransactionScenarioRequest;
+    extPortrait?: string;
+    /**
+     *
+     * @type {ContainerList}
+     * @memberof TransactionProcessRequest
+     */
+    ContainerList?: ContainerList;
+    /**
+     *
+     * @type {ProcessSystemInfo}
+     * @memberof TransactionProcessRequest
+     */
+    systemInfo?: ProcessSystemInfo;
+    /**
+     * Free-form object to be included in response. Must be object, not list or simple value. Do not affect document processing. Use it freely to pass your app params. Stored in process logs.
+     * @type {{ [key: string]: object; }}
+     * @memberof TransactionProcessRequest
+     */
+    passBackObject?: {
+        [key: string]: object;
+    };
 }
 export class TextFieldExt implements TextField {
     fieldType: TextFieldType;
@@ -10337,5 +10475,38 @@ export class DocumentReaderApi {
      * @throws {RequiredError}
      */
     getReprocessTransactionResult(transactionId: number, withImages?: boolean, options?: any): Promise<Response>;
+    /**
+     *
+     * @summary Get transactions by tag
+     * @param {number} tagId Tag id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<ListTransactionsByTagResponse>>;
+    /**
+     *
+     * @summary Delete Reprocess transactions by tag
+     * @param {number} tagId Tag id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteReprocessTransactionsByTag(tagId: number, options?: any): Promise<AxiosResponse<object, any>>;
+    /**
+     *
+     * @summary Get Reprocess transaction file
+     * @param {number} transactionId Transaction id
+     * @param {string} name File name
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReprocessTransactionFile(transactionId: number, name: string, options?: any): Promise<AxiosResponse<any, any>>;
+    /**
+     *
+     * @summary Get Reprocess transaction data
+     * @param {number} transactionId Transaction id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReprocessTransactionData(transactionId: number, options?: any): Promise<AxiosResponse<TransactionProcessGetResponse, any>>;
 }
 export function requestToBaseRequest(request: ProcessRequestExt): ProcessRequest;

package/package.json

@@ -5,7 +5,7 @@
     "> 0.2%",
     "not dead"
   ],
-  "version": "7.4.82-rc",
+  "version": "7.4.97",
   "description": "Regula Document Reader js client for the browser and node.js based on axios",
   "author": "Regula Forensics, Inc.",
   "keywords": [
@@ -45,30 +45,30 @@
     "check-types": "tsc --noEmit",
     "format": "eslint --fix",
     "build": "parcel build --no-source-maps --no-cache",
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "lint-staged": {
     "*.{js,ts}": "eslint --fix"
   },
   "dependencies": {
-    "@swc/helpers": "^0.5.3",
-    "axios": "^1.6.8",
+    "@swc/helpers": "^0.5.12",
+    "axios": "^1.7.4",
     "base64-arraybuffer": "^1.0.2",
     "pako": "^2.1.0"
   },
   "devDependencies": {
-    "@parcel/packager-ts": "^2.10.3",
-    "@parcel/transformer-typescript-types": "^2.10.3",
-    "@types/pako": "^2.0.1",
+    "@parcel/packager-ts": "^2.12.0",
+    "@parcel/transformer-typescript-types": "^2.12.0",
+    "@types/pako": "^2.0.3",
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
     "eslint": "^8.51.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "husky": "^8.0.3",
-    "lint-staged": "^15.0.1",
-    "parcel": "^2.10.3",
-    "prettier": "^3.0.3",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "husky": "^9.1.5",
+    "lint-staged": "^15.2.9",
+    "parcel": "^2.12.0",
+    "prettier": "^3.3.3",
     "typescript": "^5.3.2"
   }
 }