@regulaforensics/vp-frontend-face-components 1.4.0 → 2.0.1

package/lib/models/DocReaderWebclient/models/process-params.d.ts

@@ -0,0 +1,254 @@
+/**
+ * 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: 6.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AuthenticityResultType } from './authenticity-result-type';
+import { DocumentFormat } from './document-format';
+import { DocumentType } from './document-type';
+import { ImageQA } from './image-qa';
+import { LogLevel } from './log-level';
+import { MRZFormat } from './mrzformat';
+import { MeasureSystem } from './measure-system';
+import { PerDocumentConfig } from './per-document-config';
+import { Result } from './result';
+import { Scenario } from './scenario';
+import { TextFieldType } from './text-field-type';
+import { TextPostProcessing } from './text-post-processing';
+/**
+ *
+ * @export
+ * @interface ProcessParams
+ */
+export interface ProcessParams {
+    /**
+     *
+     * @type {Scenario}
+     * @memberof ProcessParams
+     */
+    scenario: Scenario;
+    /**
+     * Types of results to return in response. See \'Result\' enum for available options
+     * @type {Array<Result>}
+     * @memberof ProcessParams
+     */
+    resultTypeOutput?: Array<Result>;
+    /**
+     * Enable this option if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or some others. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    doublePageSpread?: boolean;
+    /**
+     * When enabled together with \"doublePageSpread\" and there is a passport with two pages spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured on a flatbed scanner. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    generateDoublePageSpreadImage?: boolean;
+    /**
+     * List of text field types to extract. If empty, all text fields from template will be extracted. Narrowing the list can shorten processing time. Empty by default.
+     * @type {Array<TextFieldType>}
+     * @memberof ProcessParams
+     */
+    fieldTypesFilter?: Array<TextFieldType>;
+    /**
+     * This option allows you to set dates format so that solution will return dates in this format. For example, if you supply \'MM/dd/yyyy\', and document have printed date \'09 JUL 2020\' for the date os issue, you will get \'07/09/2020\' as a result. By default it is set to system locale default (where the service is running).
+     * @type {string}
+     * @memberof ProcessParams
+     */
+    dateFormat?: string;
+    /**
+     *
+     * @type {MeasureSystem}
+     * @memberof ProcessParams
+     */
+    measureSystem?: MeasureSystem;
+    /**
+     * This option controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi.
+     * @type {number}
+     * @memberof ProcessParams
+     */
+    imageDpiOutMax?: number;
+    /**
+     * This option can be enabled if you know for sure that the image you provide contains already cropped document by its edges. This was designed to process on the server side images captured and cropped on mobile. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    alreadyCropped?: boolean;
+    /**
+     * This option allows passing custom processing parameters that can be implemented in future without changing API.
+     * @type {{ [key: string]: object; }}
+     * @memberof ProcessParams
+     */
+    customParams?: {
+        [key: string]: object;
+    };
+    /**
+     * This option allows setting additional custom configuration per document type. If recognized document has ID specified in config, processing adjusts according to designated configuration.
+     * @type {Array<PerDocumentConfig>}
+     * @memberof ProcessParams
+     */
+    config?: Array<PerDocumentConfig>;
+    /**
+     * When enabled, results will contain transaction processing log. Disabled by default
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    log?: boolean;
+    /**
+     *
+     * @type {LogLevel}
+     * @memberof ProcessParams
+     */
+    logLevel?: LogLevel;
+    /**
+     * Force use of specific template ID and skip document type identification step.
+     * @type {number}
+     * @memberof ProcessParams
+     */
+    forceDocID?: number;
+    /**
+     * When disabled, text field OCR will be done as is and then the recognized value will be matched to the field mask for validity. If enabled, we are trying to read a field value with maximum efforts to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask in the template. Enabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    matchTextFieldMask?: boolean;
+    /**
+     * When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds. Enabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    fastDocDetect?: boolean;
+    /**
+     * When enabled, fail OCR field validity, if there is a glare over the text field on the image. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    updateOCRValidityByGlare?: boolean;
+    /**
+     * When enabled, each field in template will be checked for value presence and if the field is marked as required, but has no value, it will have \'error\' in validity status. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    checkRequiredTextFields?: boolean;
+    /**
+     * When enabled, returns cropped barcode images for unknown documents. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    returnCroppedBarcode?: boolean;
+    /**
+     *
+     * @type {ImageQA}
+     * @memberof ProcessParams
+     */
+    imageQa?: ImageQA;
+    /**
+     * When enabled, image quality checks status affects document optical and overall status. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    respectImageQuality?: boolean;
+    /**
+     *
+     * @type {DocumentFormat}
+     * @memberof ProcessParams
+     */
+    forceDocFormat?: DocumentFormat;
+    /**
+     * When enabled, no graphic fields will be cropped from document image. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    noGraphics?: boolean;
+    /**
+     * Specifies minimal area of the image that document should cover to be treated as candidate when locating. Value should be in range from 0 to 1, where 1 is when document should fully cover the image.
+     * @type {number}
+     * @memberof ProcessParams
+     */
+    documentAreaMin?: number;
+    /**
+     * When enabled, all personal data will be forcibly removed from the logs. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    depersonalizeLog?: boolean;
+    /**
+     * This option allows locating and cropping multiple documents from one image if enabled. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    multiDocOnImage?: boolean;
+    /**
+     * This option allows shifting the date of expiry into the future or past for number of months specified. This is useful, for example, in some cases when document might be still valid for some period after original expiration date to prevent negative validity status for such documents. Or by shifting the date to the past will set negative validity for the documents that is about to expire in a specified number of months. 0 by default
+     * @type {number}
+     * @memberof ProcessParams
+     */
+    shiftExpiryDate?: number;
+    /**
+     * This options allows specifying the minimal age in years of the document holder for the document to be considered valid.
+     * @type {number}
+     * @memberof ProcessParams
+     */
+    minimalHolderAge?: number;
+    /**
+     * When enabled, returns input images in output. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    returnUncroppedImage?: boolean;
+    /**
+     * This option allows limiting MRZ formats to be recognized by specifying them in array.
+     * @type {Array<MRZFormat>}
+     * @memberof ProcessParams
+     */
+    mrzFormatsFilter?: Array<MRZFormat>;
+    /**
+     * When enabled, make sure that in series processing MRZ is located fully inside the result document image, if present on the document. Enabling this option may add extra processing time, by disabling optimizations, but allows more stability in output image quality. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    forceReadMrzBeforeLocate?: boolean;
+    /**
+     * This option can be disabled to stop parsing after barcode is read. Enabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    parseBarcodes?: boolean;
+    /**
+     *
+     * @type {TextPostProcessing}
+     * @memberof ProcessParams
+     */
+    convertCase?: TextPostProcessing;
+    /**
+     * When enabled, the Surname and GivenNames field will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    splitNames?: boolean;
+    /**
+     * When enabled, OCR of perforated fields in the document template will not be performed. Disabled by default.
+     * @type {boolean}
+     * @memberof ProcessParams
+     */
+    disablePerforationOCR?: boolean;
+    /**
+     * List of specific eligible document types from DocumentType enum to recognize from. You may, for example, specify only passports to be recognized by setting this property. Empty by default.
+     * @type {Array<DocumentType>}
+     * @memberof ProcessParams
+     */
+    documentGroupFilter?: Array<DocumentType>;
+    /**
+     * Authenticity checks that should be performed regardless of the document type. The available checks are listed in the eRPRM_Authenticity enum. Note that only supported by your license checks can be added.
+     * @type {Array<AuthenticityResultType>}
+     * @memberof ProcessParams
+     */
+    processAuth?: Array<AuthenticityResultType>;
+}

package/lib/models/DocReaderWebclient/models/process-request-image.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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: 6.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ImageData } from './image-data';
+import { Light } from './light';
+/**
+ *
+ * @export
+ * @interface ProcessRequestImage
+ */
+export interface ProcessRequestImage {
+    /**
+     *
+     * @type {ImageData}
+     * @memberof ProcessRequestImage
+     */
+    ImageData: ImageData;
+    /**
+     *
+     * @type {Light}
+     * @memberof ProcessRequestImage
+     */
+    light?: Light;
+    /**
+     * page/image number
+     * @type {number}
+     * @memberof ProcessRequestImage
+     */
+    page_idx?: number;
+}

package/lib/models/DocReaderWebclient/models/process-request.d.ts

@@ -0,0 +1,60 @@
+/**
+ * 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: 6.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ContainerList } from './container-list';
+import { ProcessParams } from './process-params';
+import { ProcessRequestImage } from './process-request-image';
+import { ProcessSystemInfo } from './process-system-info';
+/**
+ *
+ * @export
+ * @interface ProcessRequest
+ */
+export interface ProcessRequest {
+    /**
+     * session id
+     * @type {string}
+     * @memberof ProcessRequest
+     */
+    tag?: string;
+    /**
+     *
+     * @type {ProcessParams}
+     * @memberof ProcessRequest
+     */
+    processParam: ProcessParams;
+    /**
+     *
+     * @type {Array<ProcessRequestImage>}
+     * @memberof ProcessRequest
+     */
+    List?: Array<ProcessRequestImage>;
+    /**
+     *
+     * @type {ContainerList}
+     * @memberof ProcessRequest
+     */
+    ContainerList?: ContainerList;
+    /**
+     *
+     * @type {ProcessSystemInfo}
+     * @memberof ProcessRequest
+     */
+    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
+     */
+    passBackObject?: {
+        [key: string]: object;
+    };
+}

package/lib/models/DocReaderWebclient/models/process-response.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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: 6.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ContainerList } from './container-list';
+import { ProcessingStatus } from './processing-status';
+import { RfidLocation } from './rfid-location';
+import { TransactionInfo } from './transaction-info';
+/**
+ *
+ * @export
+ * @interface ProcessResponse
+ */
+export interface ProcessResponse {
+    /**
+     *
+     * @type {RfidLocation}
+     * @memberof ProcessResponse
+     */
+    ChipPage?: RfidLocation;
+    /**
+     *
+     * @type {ProcessingStatus}
+     * @memberof ProcessResponse
+     */
+    ProcessingFinished: ProcessingStatus;
+    /**
+     *
+     * @type {ContainerList}
+     * @memberof ProcessResponse
+     */
+    ContainerList: ContainerList;
+    /**
+     *
+     * @type {TransactionInfo}
+     * @memberof ProcessResponse
+     */
+    TransactionInfo: TransactionInfo;
+    /**
+     * Base64 encoded transaction processing log
+     * @type {string}
+     * @memberof ProcessResponse
+     */
+    log?: string;
+    /**
+     * Free-form object provided in request. See passBackObject property of ProcessRequest.
+     * @type {{ [key: string]: object; }}
+     * @memberof ProcessResponse
+     */
+    passBackObject?: {
+        [key: string]: object;
+    };
+    /**
+     *
+     * @type {number}
+     * @memberof ProcessResponse
+     */
+    morePagesAvailable?: number;
+}

package/lib/models/DocReaderWebclient/models/process-system-info.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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: 6.5.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 ProcessSystemInfo
+ */
+export interface ProcessSystemInfo {
+    /**
+     * Base64 encoded license file
+     * @type {string}
+     * @memberof ProcessSystemInfo
+     */
+    license?: string;
+    /**
+     * For internal use. Demo-sites recaptcha token.
+     * @type {string}
+     * @memberof ProcessSystemInfo
+     */
+    recaptcha_token?: string;
+}

package/lib/models/DocReaderWebclient/models/processing-status.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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: 6.5.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
+ * @enum {string}
+ */
+export declare enum ProcessingStatus {
+    /**
+    * Processing was not finished
+    */
+    NOT_FINISHED = 0,
+    /**
+    * Processing finished
+    */
+    FINISHED = 1,
+    /**
+    * Processing finished by timeout
+    */
+    TIMEOUT = 2
+}

package/lib/models/DocReaderWebclient/models/raw-image-container-list.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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: 6.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ImageData } from './image-data';
+/**
+ *
+ * @export
+ * @interface RawImageContainerList
+ */
+export interface RawImageContainerList {
+    /**
+     *
+     * @type {number}
+     * @memberof RawImageContainerList
+     */
+    Count?: number;
+    /**
+     *
+     * @type {Array<ImageData>}
+     * @memberof RawImageContainerList
+     */
+    Images?: Array<ImageData>;
+}

package/lib/models/DocReaderWebclient/models/rectangle-coordinates.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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: 6.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Coordinates of the rectangle region on a document image(result type 1). Represented by two points - (left, top) + (right, bottom)
+ * @export
+ * @interface RectangleCoordinates
+ */
+export interface RectangleCoordinates {
+    /**
+     *
+     * @type {number}
+     * @memberof RectangleCoordinates
+     */
+    left: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RectangleCoordinates
+     */
+    top: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RectangleCoordinates
+     */
+    right: number;
+    /**
+     *
+     * @type {number}
+     * @memberof RectangleCoordinates
+     */
+    bottom: number;
+}

package/lib/models/DocReaderWebclient/models/result-item.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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: 6.5.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Common fields for all result objects
+ * @export
+ * @interface ResultItem
+ */
+export interface ResultItem {
+    /**
+     *
+     * @type {number}
+     * @memberof ResultItem
+     */
+    buf_length?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ResultItem
+     */
+    light?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ResultItem
+     */
+    list_idx?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof ResultItem
+     */
+    page_idx?: number;
+    /**
+     * Same as Result type, but used for safe parsing of not-described values. See Result type.
+     * @type {number}
+     * @memberof ResultItem
+     */
+    result_type: number;
+}