@regulaforensics/document-reader-webclient 6.9.4 → 6.9.6

package/lib/index.d.ts

@@ -117,7 +117,7 @@ export interface Point {
  * @export
  * @interface PointArray
  */
-interface PointArray {
+export interface PointArray {
     /**
      *
      * @type {Array<Point>}
@@ -172,7 +172,7 @@ export interface RectangleCoordinates {
  * @export
  * @interface AreaArray
  */
-interface AreaArray {
+export interface AreaArray {
     /**
      *
      * @type {Array<RectangleCoordinates>}
@@ -2414,7 +2414,7 @@ export interface ChosenDocumentTypeResultAllOf {
  * @export
  * @interface BcPDF417INFO
  */
-interface BcPDF417INFO {
+export interface BcPDF417INFO {
     /**
      *
      * @type {number}
@@ -2468,7 +2468,7 @@ interface BcPDF417INFO {
  * @export
  * @interface BcROIDETECT
  */
-interface BcROIDETECT {
+export interface BcROIDETECT {
     /**
      *
      * @type {number}
@@ -2510,7 +2510,7 @@ interface BcROIDETECT {
  * @export
  * @interface DataModule
  */
-interface DataModule {
+export interface DataModule {
     /**
      *
      * @type {string}
@@ -2547,7 +2547,7 @@ interface DataModule {
  * @export
  * @interface PArrayField
  */
-interface PArrayField {
+export interface PArrayField {
     /**
      *
      * @type {number}
@@ -2614,7 +2614,7 @@ interface PArrayField {
  * @export
  * @interface DocBarCodeInfoFieldsList
  */
-interface DocBarCodeInfoFieldsList {
+export interface DocBarCodeInfoFieldsList {
     /**
      * Count of array fields
      * @type {number}
@@ -2633,7 +2633,7 @@ interface DocBarCodeInfoFieldsList {
  * @export
  * @interface DocBarCodeInfoAllOf
  */
-interface DocBarCodeInfoAllOf {
+export interface DocBarCodeInfoAllOf {
     /**
      *
      * @type {DocBarCodeInfoFieldsList}
@@ -2659,7 +2659,7 @@ export interface DocumentImageResultAllOf {
  * @export
  * @interface DocumentPosition
  */
-interface DocumentPosition {
+export interface DocumentPosition {
     /**
      *
      * @type {DocumentFormat}
@@ -2726,7 +2726,7 @@ interface DocumentPosition {
  * @export
  * @interface DocumentPositionResultAllOf
  */
-interface DocumentPositionResultAllOf {
+export interface DocumentPositionResultAllOf {
     /**
      *
      * @type {DocumentPosition}
@@ -2812,7 +2812,7 @@ export interface DocumentTypesCandidatesResultAllOf {
  * @export
  * @interface EncryptedRCLResultAllOf
  */
-interface EncryptedRCLResultAllOf {
+export interface EncryptedRCLResultAllOf {
     /**
      * Base64 encoded data
      * @type {string}
@@ -3061,14 +3061,15 @@ export enum ImageQualityCheckType {
     /**
     * Signals if the portrait is present
     */
-    Portrait = 7
+    Portrait = 7,
+    Brightness = 8
 }
 /**
  *
  * @export
  * @interface ImageQualityCheck
  */
-interface ImageQualityCheck {
+export interface ImageQualityCheck {
     /**
      *
      * @type {ImageQualityCheckType}
@@ -3117,7 +3118,7 @@ interface ImageQualityCheck {
  * @export
  * @interface ImageQualityCheckList
  */
-interface ImageQualityCheckList {
+export interface ImageQualityCheckList {
     /**
      *
      * @type {CheckResult}
@@ -3136,7 +3137,7 @@ interface ImageQualityCheckList {
  * @export
  * @interface ImageQualityResultAllOf
  */
-interface ImageQualityResultAllOf {
+export interface ImageQualityResultAllOf {
     /**
      *
      * @type {ImageQualityCheckList}
@@ -3309,7 +3310,7 @@ export interface ImagesFieldValue {
  * @export
  * @interface ImagesField
  */
-interface _ImagesField1 {
+export interface ImagesField {
     /**
      * Human readable field name. Do not bind to this name - use GraphicFieldType instead.
      * @type {string}
@@ -3334,7 +3335,7 @@ interface _ImagesField1 {
  * @export
  * @interface Images
  */
-interface _Images1 {
+export interface Images {
     /**
      *
      * @type {Array<ImagesAvailableSource>}
@@ -3346,7 +3347,7 @@ interface _Images1 {
      * @type {Array<ImagesField>}
      * @memberof Images
      */
-    fieldList: Array<_ImagesField1>;
+    fieldList: Array<ImagesField>;
 }
 /**
  *
@@ -3359,7 +3360,7 @@ export interface ImagesResultAllOf {
      * @type {Images}
      * @memberof ImagesResultAllOf
      */
-    _Images1: _Images1;
+    Images: Images;
 }
 /**
  * Regula Document Reader Web API
@@ -3479,6 +3480,10 @@ export enum LCID {
     */
     BULGARIAN = 1026,
     /**
+    * Burmese
+    */
+    BURMESE = 1109,
+    /**
     * Catalan
     */
     CATALAN = 1027,
@@ -3699,6 +3704,10 @@ export enum LCID {
     */
     KAZAKH = 1087,
     /**
+    * Khmer
+    */
+    KHMER = 1107,
+    /**
     * Konkani
     */
     KONKANI = 1111,
@@ -3727,6 +3736,10 @@ export enum LCID {
     */
     MALAY_BRUNEI_DARUSSALAM = 2110,
     /**
+    * Maltese
+    */
+    MALTESE = 1082,
+    /**
     * Marathi
     */
     MARATHI = 1102,
@@ -3941,7 +3954,19 @@ export enum LCID {
     /**
     * CTC Traditional
     */
-    CTC_TRADITIONAL = 50002
+    CTC_TRADITIONAL = 50002,
+    /**
+    * Bengali (Bangladesh)
+    */
+    BengaliBangladesh = 2117,
+    /**
+    * BengaliIndia
+    */
+    BengaliIndia = 1093,
+    /**
+    * Assamese
+    */
+    Assamese = 1101
 }
 /**
  * Regula Document Reader Web API
@@ -6598,7 +6623,7 @@ export interface LexicalAnalysisResultAllOf {
  * @export
  * @interface LicenseResultAllOf
  */
-interface LicenseResultAllOf {
+export interface LicenseResultAllOf {
     /**
      * Base64 encoded data
      * @type {string}
@@ -7069,7 +7094,7 @@ export interface TextFieldValue {
  * @export
  * @interface TextField
  */
-interface _TextField1 {
+export interface TextField {
     /**
      *
      * @type {TextFieldType}
@@ -7136,7 +7161,7 @@ interface _TextField1 {
  * @export
  * @interface Text
  */
-interface _Text1 {
+export interface Text {
     /**
      *
      * @type {CheckResult}
@@ -7160,7 +7185,7 @@ interface _Text1 {
      * @type {Array<TextField>}
      * @memberof Text
      */
-    fieldList: Array<_TextField1>;
+    fieldList: Array<TextField>;
     /**
      *
      * @type {Array<TextAvailableSource>}
@@ -7179,7 +7204,7 @@ export interface TextResultAllOf {
      * @type {Text}
      * @memberof TextResultAllOf
      */
-    _Text1: _Text1;
+    Text: Text;
 }
 /**
  * @type TextResult
@@ -7238,7 +7263,7 @@ export interface ResultItem {
  * @type LicenseResult
  * @export
  */
-type LicenseResult = LicenseResultAllOf & ResultItem;
+export type LicenseResult = LicenseResultAllOf & ResultItem;
 /**
  * @type LexicalAnalysisResult
  * Lexical data analysis allows you to compare the results of reading the text data of the MRZ, the document filling area, barcodes and data from the memory of the RFID chip for an additional assessment of the authenticity of the document. Single result for all pages. Consider using Result.TEXT type for more simplicity.
@@ -7254,7 +7279,7 @@ export type ImagesResult = ImagesResultAllOf & ResultItem;
  * @type ImageQualityResult
  * @export
  */
-type ImageQualityResult = ImageQualityResultAllOf & ResultItem;
+export type ImageQualityResult = ImageQualityResultAllOf & ResultItem;
 /**
  * @type GraphicsResult
  * Graphic fields extracted from one of the document sources. Returns separate results for each provided page.
@@ -7265,7 +7290,7 @@ export type GraphicsResult = GraphicsResultAllOf & ResultItem;
  * @type EncryptedRCLResult
  * @export
  */
-type EncryptedRCLResult = EncryptedRCLResultAllOf & ResultItem;
+export type EncryptedRCLResult = EncryptedRCLResultAllOf & ResultItem;
 /**
  * @type DocumentTypesCandidatesResult
  * @export
@@ -7276,7 +7301,7 @@ export type DocumentTypesCandidatesResult = DocumentTypesCandidatesResultAllOf &
  * Contains information about document position on the input image, its center, angle, etc
  * @export
  */
-type DocumentPositionResult = DocumentPositionResultAllOf & ResultItem;
+export type DocumentPositionResult = DocumentPositionResultAllOf & ResultItem;
 /**
  * @type DocumentImageResult
  * @export
@@ -7287,7 +7312,7 @@ export type DocumentImageResult = DocumentImageResultAllOf & ResultItem;
  * Raw data from BarCodes
  * @export
  */
-type DocBarCodeInfo = DocBarCodeInfoAllOf & ResultItem;
+export type DocBarCodeInfo = DocBarCodeInfoAllOf & ResultItem;
 /**
  * @type ChosenDocumentTypeResult
  * Contains information about the type of document that was determined based on the analysis of the provided image
@@ -7492,7 +7517,7 @@ export interface DocumentTypesCandidates {
  * @export
  * @interface FaceApiSearch
  */
-interface FaceApiSearch {
+export interface FaceApiSearch {
     /**
      * The maximum number of results to be returned.
      * @type {number}
@@ -7517,7 +7542,7 @@ interface FaceApiSearch {
  * @export
  * @interface FaceApi
  */
-interface FaceApi {
+export interface FaceApi {
     /**
      * The URL of the Regula Face Web service to be used.
      * @type {string}
@@ -7584,6 +7609,12 @@ interface FaceApi {
  * @interface ImageQA
  */
 export interface ImageQA {
+    /**
+     * Set the threshold for an actual document brightness below which the check fails
+     * @type {number}
+     * @memberof ImageQA
+     */
+    brightnessThreshold?: number;
     /**
      * This parameter sets threshold for Image QA check of the presented document physical dpi. If actual document dpi is below this threshold, check will fail.
      * @type {number}
@@ -8639,7 +8670,7 @@ export enum ParsingNotificationCodes {
  * @export
  * @interface PerDocumentConfig
  */
-interface PerDocumentConfig {
+export interface PerDocumentConfig {
     /**
      * Specific template IDs, for which apply current custom configuration
      * @type {Array<number>}
@@ -8658,7 +8689,7 @@ interface PerDocumentConfig {
  * @export
  * @interface ProcessParamsRfid
  */
-interface ProcessParamsRfid {
+export interface ProcessParamsRfid {
     /**
      * A list of notification codes that should be ignored during passive authentication (PA)
      * @type {Array<ParsingNotificationCodes>}
@@ -8914,6 +8945,24 @@ export enum TextPostProcessing {
  * @interface ProcessParams
  */
 export interface ProcessParams {
+    /**
+     * The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default.
+     * @type {Array<number>}
+     * @memberof ProcessParams
+     */
+    lcidFilter?: Array<number>;
+    /**
+     * This parameter is used to enable document liveness check.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    checkLiveness?: boolean;
+    /**
+     * The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default.
+     * @type {Array<number>}
+     * @memberof ProcessParams
+     */
+    lcidIgnoreFilter?: Array<number>;
     /**
      * This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person\'s face
      * @type {boolean}
@@ -9216,7 +9265,7 @@ export interface ProcessParams {
  * @export
  * @interface ProcessRequestImage
  */
-interface _ProcessRequestImage1 {
+export interface ProcessRequestImage {
     /**
      *
      * @type {ImageData}
@@ -9271,7 +9320,7 @@ export interface ProcessSystemInfo {
  * @export
  * @interface ProcessRequest
  */
-interface _ProcessRequest1 {
+export interface ProcessRequest {
     /**
      * session id
      * @type {string}
@@ -9289,7 +9338,7 @@ interface _ProcessRequest1 {
      * @type {Array<ProcessRequestImage>}
      * @memberof ProcessRequest
      */
-    List?: Array<_ProcessRequestImage1>;
+    List?: Array<ProcessRequestImage>;
     /**
      * Live portrait photo
      * @type {string}
@@ -9452,7 +9501,7 @@ export interface ProcessResponse {
      */
     elapsedTime?: number;
 }
-export class TextField implements _TextField1 {
+export class TextFieldExt implements TextField {
     fieldType: TextFieldType;
     fieldName: string;
     lcid?: number;
@@ -9463,7 +9512,7 @@ export class TextField implements _TextField1 {
     valueList: Array<TextFieldValue>;
     validityList: Array<SourceValidity>;
     comparisonList: Array<CrossSourceValueComparison>;
-    constructor(origin: _TextField1);
+    constructor(origin: TextField);
     /**
      * This method returns value of the text field. Value encoded in UTF8.
      * Fields value obtained in the following order:
@@ -9490,30 +9539,30 @@ export class TextField implements _TextField1 {
     crossSourceComparison(one: Source, other: Source): CheckResult;
     getLCIDName(): string | undefined;
 }
-export class Text implements _Text1 {
+export class TextExt implements Text {
     status: CheckResult;
     validityStatus: CheckResult;
     comparisonStatus: CheckResult;
     availableSourceList: Array<TextAvailableSource>;
-    fieldList: Array<TextField>;
-    constructor(origin: _Text1);
-    getField(type: TextFieldType, lcid?: number): TextField | undefined;
-    getFieldByName(name: string, lcid?: number): TextField | undefined;
+    fieldList: Array<TextFieldExt>;
+    constructor(origin: Text);
+    getField(type: TextFieldType, lcid?: number): TextFieldExt | undefined;
+    getFieldByName(name: string, lcid?: number): TextFieldExt | undefined;
     getFieldValue(type: TextFieldType, lcid?: number): string | undefined;
     getFieldValueByName(name: string, lcid?: number): string | undefined;
 }
-export class Images implements _Images1 {
+export class ImagesExt implements Images {
     availableSourceList: Array<ImagesAvailableSource>;
-    fieldList: Array<ImagesField>;
-    constructor(origin: _Images1);
-    getField(type: GraphicFieldType): ImagesField | undefined;
-    getFields(type: GraphicFieldType): Array<ImagesField> | undefined;
+    fieldList: Array<ImagesFieldWrapper>;
+    constructor(origin: Images);
+    getField(type: GraphicFieldType): ImagesFieldWrapper | undefined;
+    getFields(type: GraphicFieldType): Array<ImagesFieldWrapper> | undefined;
 }
-export class ImagesField implements _ImagesField1 {
+export class ImagesFieldWrapper implements ImagesField {
     fieldName: string;
     fieldType: GraphicFieldType;
     valueList: Array<ImagesFieldValue>;
-    constructor(origin: _ImagesField1);
+    constructor(origin: ImagesField);
     getValue(source?: Source, original?: boolean): ArrayBuffer | undefined;
 }
 declare class FiberChecks implements AuthenticityCheckResult {
@@ -9573,8 +9622,8 @@ declare class Authenticity implements AuthenticityCheckList {
 }
 export class Response {
     status?: Status;
-    text?: Text;
-    images?: Images;
+    text?: TextExt;
+    images?: ImagesExt;
     lowLvlResponse: LowLvlResponse;
     rawResponse: ProcessResponse;
     constructor(original: ProcessResponse);
@@ -9606,64 +9655,56 @@ export class LowLvlResponse implements ProcessResponse {
     resultByTypeAndPage(type: Result, page_idx?: number): ResultItem | undefined;
     resultsByType(type: Result): Array<ResultItem | AuthenticityResult | ImageQualityCheckList>;
 }
-export interface ProcessRequestImage extends Omit<_ProcessRequestImage1, 'ImageData'> {
+export interface ProcessRequestImageWrapper extends Omit<ProcessRequestImage, 'ImageData'> {
     ImageData: ArrayBuffer | Base64String;
 }
 export type Base64String = string;
-export interface ProcessRequest {
+export interface ProcessRequestExt {
     /**
      *
      * @type {ProcessParams}
-     * @memberof ProcessRequest
+     * @memberof ProcessRequestExt
      */
     processParam: ProcessParams;
     /**
      *
      * @type {Array<ProcessRequestImage>}
-     * @memberof ProcessRequest
+     * @memberof ProcessRequestExt
      */
-    images: Array<ProcessRequestImage | ArrayBuffer | Base64String>;
+    images: Array<ProcessRequestImageWrapper | ArrayBuffer | Base64String>;
     /**
      * @type {ContainerList}
-     * @memberOf ProcessRequest
+     * @memberOf ProcessRequestExt
      */
     ContainerList: ContainerList;
     /**
      *
      * @type {ProcessParams}
-     * @memberof ProcessRequest
+     * @memberof ProcessRequestExt
      */
     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 ProcessRequest
+     * @memberof ProcessRequestExt
      */
     passBackObject?: {
         [key: string]: any;
     };
 }
-export const instanceOfProcessRequest: (data: any) => data is ProcessRequest;
+export const instanceOfProcessRequest: (data: any) => data is ProcessRequestExt;
 export class DocumentReaderApi {
     constructor(configuration?: ConfigurationParameters, basePath?: string, axios?: AxiosInstance);
     ping(xRequestID?: string): Promise<DeviceInfo>;
     /**
      *
      * @summary Process list of documents images and return extracted data
-     * @param {ProcessRequest} [request] Request options such as image, results types and etc.
+     * @param {ProcessRequestExt} [request] Request options such as image, results types and etc.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError} If some request params are missed
      * */
-    process(request: ProcessRequest | _ProcessRequest1, xRequestID?: string, options?: any): Promise<Response>;
+    process(request: ProcessRequestExt | ProcessRequest, xRequestID?: string, options?: any): Promise<Response>;
     setLicense(license: ArrayBuffer | Base64String): void;
 }
-export function requestToBaseRequest(request: ProcessRequest): _ProcessRequest1;
-export class BaseResultItem implements ResultItem {
-    buf_length?: number;
-    light?: number;
-    list_idx?: number;
-    page_idx?: number;
-    result_type: number;
-    constructor(item: ResultItem);
-}
+export function requestToBaseRequest(request: ProcessRequestExt): ProcessRequest;

package/package.json

@@ -5,7 +5,7 @@
     "> 0.2%",
     "not dead"
   ],
-  "version": "6.9.4",
+  "version": "6.9.6",
   "description": "Regula Document Reader js client for the browser and node.js based on axios",
   "author": "Regula Forensics, Inc.",
   "keywords": [
@@ -34,21 +34,16 @@
   ],
   "targets": {
     "main": {
-      "optimize": true,
-      "sourceMap": false
+      "optimize": true
     },
     "module": {
-      "optimize": true,
-      "sourceMap": false
-    },
-    "types": {
-      "sourceMap": false
+      "optimize": true
     }
   },
   "scripts": {
     "check-types": "tsc --noEmit",
     "format": "eslint --fix",
-    "build": "parcel build",
+    "build": "parcel build --no-source-maps --no-cache",
     "prepare": "husky install"
   },
   "lint-staged": {
@@ -61,8 +56,8 @@
     "pako": "^2.1.0"
   },
   "devDependencies": {
-    "@parcel/packager-ts": "^2.10.0",
-    "@parcel/transformer-typescript-types": "^2.10.0",
+    "@parcel/packager-ts": "^2.10.3",
+    "@parcel/transformer-typescript-types": "^2.10.3",
     "@types/pako": "^2.0.1",
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
@@ -71,8 +66,8 @@
     "eslint-plugin-prettier": "^5.0.1",
     "husky": "^8.0.3",
     "lint-staged": "^15.0.1",
-    "parcel": "^2.10.0",
+    "parcel": "^2.10.3",
     "prettier": "^3.0.3",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.2"
   }
 }