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

package/lib/models/DocReaderWebclient/models/text-field-value.d.ts

@@ -1,70 +0,0 @@
-/**
- * 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 { OriginalSymbol } from './original-symbol';
-import { RectangleCoordinates } from './rectangle-coordinates';
-import { RfidOrigin } from './rfid-origin';
-import { Source } from './source';
-/**
- *
- * @export
- * @interface TextFieldValue
- */
-export interface TextFieldValue {
-    /**
-     *
-     * @type {Source}
-     * @memberof TextFieldValue
-     */
-    source: Source;
-    /**
-     * Parsed/processed value. Date format converted for output, delimiters removed
-     * @type {string}
-     * @memberof TextFieldValue
-     */
-    value: string;
-    /**
-     * Original value as seen in the document
-     * @type {string}
-     * @memberof TextFieldValue
-     */
-    originalValue?: string;
-    /**
-     *
-     * @type {Array<OriginalSymbol>}
-     * @memberof TextFieldValue
-     */
-    originalSymbols?: Array<OriginalSymbol>;
-    /**
-     * Page index of the image from input list
-     * @type {number}
-     * @memberof TextFieldValue
-     */
-    pageIndex: number;
-    /**
-     * Min recognition probability. Combined minimum probability from single characters probabilities
-     * @type {number}
-     * @memberof TextFieldValue
-     */
-    probability?: number;
-    /**
-     *
-     * @type {RectangleCoordinates}
-     * @memberof TextFieldValue
-     */
-    fieldRect?: RectangleCoordinates;
-    /**
-     *
-     * @type {RfidOrigin}
-     * @memberof TextFieldValue
-     */
-    rfidOrigin?: RfidOrigin;
-}

package/lib/models/DocReaderWebclient/models/text-field.d.ts

@@ -1,84 +0,0 @@
-/**
- * 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 { CheckResult } from './check-result';
-import { CrossSourceValueComparison } from './cross-source-value-comparison';
-import { LCID } from './lcid';
-import { SourceValidity } from './source-validity';
-import { TextFieldType } from './text-field-type';
-import { TextFieldValue } from './text-field-value';
-/**
- *
- * @export
- * @interface TextField
- */
-export interface TextField {
-    /**
-     *
-     * @type {TextFieldType}
-     * @memberof TextField
-     */
-    fieldType: TextFieldType;
-    /**
-     * Field name. Only use to search values for fields with fieldType=50(other). In general, use fieldType for lookup.
-     * @type {string}
-     * @memberof TextField
-     */
-    fieldName: string;
-    /**
-     *
-     * @type {LCID}
-     * @memberof TextField
-     */
-    lcid?: LCID;
-    /**
-     *
-     * @type {CheckResult}
-     * @memberof TextField
-     */
-    status: CheckResult;
-    /**
-     *
-     * @type {CheckResult}
-     * @memberof TextField
-     */
-    validityStatus: CheckResult;
-    /**
-     *
-     * @type {CheckResult}
-     * @memberof TextField
-     */
-    comparisonStatus: CheckResult;
-    /**
-     * The most confidence value, selected from valueList
-     * @type {string}
-     * @memberof TextField
-     */
-    value: string;
-    /**
-     *
-     * @type {Array<TextFieldValue>}
-     * @memberof TextField
-     */
-    valueList: Array<TextFieldValue>;
-    /**
-     * Validity of all field values for given source. If there are two values on different pages for one field-source pair, then validity also will include logical match checking. If such values do not match, validity will return error.
-     * @type {Array<SourceValidity>}
-     * @memberof TextField
-     */
-    validityList: Array<SourceValidity>;
-    /**
-     *
-     * @type {Array<CrossSourceValueComparison>}
-     * @memberof TextField
-     */
-    comparisonList: Array<CrossSourceValueComparison>;
-}

package/lib/models/DocReaderWebclient/models/text-post-processing.d.ts

@@ -1,22 +0,0 @@
-/**
- * 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 TextPostProcessing {
-    NO_CHANGE = 0,
-    UPPERCASE = 1,
-    LOWERCASE = 2,
-    CAPITAL = 3
-}

package/lib/models/DocReaderWebclient/models/text-result-all-of.d.ts

@@ -1,25 +0,0 @@
-/**
- * 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 { Text } from './text';
-/**
- *
- * @export
- * @interface TextResultAllOf
- */
-export interface TextResultAllOf {
-    /**
-     *
-     * @type {Text}
-     * @memberof TextResultAllOf
-     */
-    Text: Text;
-}

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

@@ -1,18 +0,0 @@
-/**
- * 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 { ResultItem } from './result-item';
-import { TextResultAllOf } from './text-result-all-of';
-/**
- * @type TextResult
- * @export
- */
-export declare type TextResult = ResultItem & TextResultAllOf;

package/lib/models/DocReaderWebclient/models/text.d.ts

@@ -1,51 +0,0 @@
-/**
- * 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 { CheckResult } from './check-result';
-import { TextAvailableSource } from './text-available-source';
-import { TextField } from './text-field';
-/**
- * Contains all document text fields data with validity and cross-source compare checks
- * @export
- * @interface Text
- */
-export interface Text {
-    /**
-     *
-     * @type {CheckResult}
-     * @memberof Text
-     */
-    status: CheckResult;
-    /**
-     *
-     * @type {CheckResult}
-     * @memberof Text
-     */
-    validityStatus: CheckResult;
-    /**
-     *
-     * @type {CheckResult}
-     * @memberof Text
-     */
-    comparisonStatus: CheckResult;
-    /**
-     *
-     * @type {Array<TextField>}
-     * @memberof Text
-     */
-    fieldList: Array<TextField>;
-    /**
-     *
-     * @type {Array<TextAvailableSource>}
-     * @memberof Text
-     */
-    availableSourceList: Array<TextAvailableSource>;
-}

package/lib/models/DocReaderWebclient/models/transaction-info.d.ts

@@ -1,42 +0,0 @@
-/**
- * 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 TransactionInfo
- */
-export interface TransactionInfo {
-    /**
-     *
-     * @type {string}
-     * @memberof TransactionInfo
-     */
-    ComputerName?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof TransactionInfo
-     */
-    DateTime?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof TransactionInfo
-     */
-    TransactionID?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof TransactionInfo
-     */
-    UserName?: string;
-}

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

@@ -1,38 +0,0 @@
-/**
- * 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 VerificationResult {
-    /**
-    * Comparison result unknown
-    */
-    DISABLED = 0,
-    /**
-    * Verification passed
-    */
-    VERIFIED = 1,
-    /**
-    * Verification failed
-    */
-    NOT_VERIFIED = 2,
-    /**
-    * Positive comparison result
-    */
-    COMPARE_MATCH = 3,
-    /**
-    * Negative comparison result
-    */
-    COMPARE_NOT_MATCH = 4
-}

package/lib/models/DocReaderWebclient/models/verified-field-map.d.ts

@@ -1,63 +0,0 @@
-/**
- * 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 { LCID } from './lcid';
-import { TextFieldType } from './text-field-type';
-import { VerificationResult } from './verification-result';
-/**
- *
- * @export
- * @interface VerifiedFieldMap
- */
-export interface VerifiedFieldMap {
-    /**
-     *
-     * @type {TextFieldType}
-     * @memberof VerifiedFieldMap
-     */
-    wFieldType?: TextFieldType;
-    /**
-     *
-     * @type {LCID}
-     * @memberof VerifiedFieldMap
-     */
-    wLCID?: LCID;
-    /**
-     * Field data extracted from mrz(machine readable zone)
-     * @type {string}
-     * @memberof VerifiedFieldMap
-     */
-    Field_MRZ?: string;
-    /**
-     * Field data extracted from visual zone
-     * @type {string}
-     * @memberof VerifiedFieldMap
-     */
-    Field_Visual?: string;
-    /**
-     * Field data extracted from barcode
-     * @type {string}
-     * @memberof VerifiedFieldMap
-     */
-    Field_Barcode?: string;
-    /**
-     * Field data extracted from rfid chip
-     * @type {string}
-     * @memberof VerifiedFieldMap
-     */
-    Field_RFID?: string;
-    /**
-     * results comparison matrix. Elements of the matrix with indices 0, 1, 2, 3 take one of the values Disabled(0), Verified(1) or Not_Verified(2), elements with indices 4, 5, 6, 7, 8 are one of the values Disabled(0), Compare_Match(3) or Compare_Not_Match(4). Elements of the Matrix matrix have the following semantic meaning: - element with index 0 –– the result of verification of data from the MRZ; - 1 –– the result of verification of data from the RFID microcircuit; - 2 –– the result of verification of data from text areas of the document; - 3 –– the result of verification data from barcodes; - 4 - the result of comparing MRZ data and RFID microcircuits; - 5 - the result of comparing MRZ data and text areas of document filling; - 6 - the result of comparing MRZ data and bar codes; - 7 - the result of comparing the data of text areas of the document and the RFID chip; - 8 - the result of comparing the data of the text areas of the document and barcodes; - 9 - the result of comparing the data of the RFID chip and barcodes.
-     * @type {Array<VerificationResult>}
-     * @memberof VerifiedFieldMap
-     */
-    Matrix?: Array<VerificationResult>;
-}

package/lib/models/DocReaderWebclient/models/visibility.d.ts

@@ -1,23 +0,0 @@
-/**
- * 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.
- */
-/**
- * Enumeration contains visibility status of the security element
- * @export
- * @enum {string}
- */
-export declare enum Visibility {
-    INVISIBLE = 0,
-    VISIBLE = 1,
-    COLORED = 2,
-    GRAYSCALE = 4,
-    WHITE_IR_MATCHING = 8
-}

package/lib/models/ImageModel.d.ts

@@ -1,7 +0,0 @@
-declare class ImageModel {
-    readonly mimeType: string;
-    readonly raw: string;
-    readonly extension: string;
-    constructor(dataURL: string);
-}
-export default ImageModel;

package/lib/services/DebugService.d.ts

@@ -1,17 +0,0 @@
-import { logLevels } from '../constants';
-declare class DebugService {
-    private readonly logLvl;
-    private prevTime;
-    private frameResults;
-    constructor(logLvl: logLevels);
-    private log;
-    private frameInfoLog;
-    private shutDownInfoLog;
-    private time;
-    debug(message: string, ...optionalParams: Array<any>): void;
-    info(message: string, ...optionalParams: Array<any>): void;
-    warn(message: string, ...optionalParams: Array<any>): void;
-    error(message: string, ...optionalParams: Array<any>): void;
-}
-declare const _default: DebugService;
-export default _default;

package/lib/services/DeviceOrientationService.d.ts

@@ -1,18 +0,0 @@
-declare class DeviceOrientationService {
-    private angles;
-    initialized: boolean;
-    private debugPlate;
-    constructor();
-    private setAngle;
-    private setAngleLink;
-    private setListeners;
-    init(debug: boolean | undefined): void;
-    getAngle(): {
-        alpha: number | null;
-        beta: number | null;
-        gamma: number | null;
-    } | null;
-    shutdown(): void;
-}
-declare const _default: DeviceOrientationService;
-export default _default;

package/lib/services/DocumentReaderProcessor.d.ts

@@ -1,43 +0,0 @@
-import { CurrentPage, ImageProcessingRequest, ProcessingRequest, StreamParams } from '../types';
-import { Response } from '../models/DocReaderWebclient/ext';
-declare type RecognizeListener = (data: Response) => void;
-declare type ResponseListener = (currentPage: CurrentPage) => void;
-declare class DocumentReaderProcessor {
-    private _streamData;
-    private _documentReaderService;
-    private _canvas;
-    private _camerasInfo;
-    private _devices;
-    private _videoEventListener;
-    private _frameListener;
-    private _pageIdx;
-    private _streamParam;
-    isPrepared: boolean;
-    isProcessing: boolean;
-    isInitialized: boolean;
-    videoElement: HTMLVideoElement | null;
-    recognizeListener: RecognizeListener | null;
-    constructor(videoElement?: HTMLVideoElement);
-    get streamParam(): Partial<StreamParams>;
-    set streamParam(params: Partial<StreamParams>);
-    get recognizerProcessParam(): ProcessingRequest;
-    set recognizerProcessParam(params: ProcessingRequest);
-    get imageProcessParam(): ImageProcessingRequest;
-    set imageProcessParam(params: ImageProcessingRequest);
-    private startStream;
-    private stopStream;
-    private startRecognizeProcess;
-    private stopRecognizeProcess;
-    private startNewPage;
-    private startNewDocument;
-    switchCamera(): Promise<void>;
-    startRecognition(responseListener?: ResponseListener): Promise<Response | null>;
-    processImage(images: FileList | Array<Blob>): Promise<Response>;
-    stopRecognition(): void;
-    prepare(): Promise<void>;
-    initialize(license?: {
-        license: string | undefined;
-    }): Promise<void>;
-    shutdown(): void;
-}
-export default DocumentReaderProcessor;

package/lib/services/DocumentReaderService.d.ts

@@ -1,37 +0,0 @@
-import { ImageProcessingRequest, ProcessingRequest } from '../types';
-import { Response } from '../models/DocReaderWebclient/ext';
-declare type TLicense = {
-    license: {
-        errorCode: number;
-        message: string;
-        status: boolean;
-    };
-};
-declare class DocumentReaderService {
-    private _worker;
-    private _tasks;
-    isPrepared: boolean;
-    isInitialized: boolean;
-    isProcessing: boolean;
-    recognizerProcessParam: ProcessingRequest;
-    imageProcessParam: ImageProcessingRequest;
-    version: {
-        component: string;
-    };
-    private print;
-    private printErr;
-    private createPromise;
-    private createProcessImageRequest;
-    private onWorkerMessage;
-    prepare(): Promise<void>;
-    initialize(initData?: {
-        license: string | undefined;
-    }): Promise<TLicense>;
-    processImageBase64(base64ImagesArray: Array<string>, params: ProcessingRequest): Promise<Response>;
-    process(imageDataArray: Array<ImageData>): Promise<Response>;
-    processImage(imageDataArray: Array<ImageData>): Promise<Response>;
-    startNewPage(): Promise<void>;
-    startNewDocument(): Promise<void>;
-    shutdown(): void;
-}
-export default DocumentReaderService;

package/lib/services/EventEmitter.d.ts

@@ -1,9 +0,0 @@
-declare class EventEmitter {
-    callbacks: Record<string, any>;
-    constructor();
-    on(event: string, cb: (data: any) => any): void;
-    emit(event: string, data: any): void;
-    unsubscribe(event: string, listener: any): void;
-    unsubscribeAll(): void;
-}
-export default EventEmitter;

package/lib/services/FaceLivenessService.d.ts

@@ -1,70 +0,0 @@
-import EventEmitter from './EventEmitter';
-import CameraModel from '../models/CameraModel';
-import { ConfigLivenessParams } from '../types';
-declare type InitializedFaceLivenessData = {
-    config: ConfigLivenessParams;
-    publicKey: string;
-    schema: string;
-    sessionId: string;
-    transactionId: string;
-    metadata: {
-        platform: string;
-        osVersion: string;
-        sdkVersion: string;
-        hostAppId: string;
-        deviceModel: string;
-        currentCameraId: string;
-        cameraState: CameraModel[];
-        ctx: {
-            userIp: string;
-        };
-    };
-};
-export declare type InitializedFaceCaptureData = {
-    config: {
-        scenario: number;
-        frameWidth: number;
-        frameHeight: number;
-        debugOutput: boolean | undefined;
-        numChannels: number;
-    };
-    metadata: {
-        hostAppId: string;
-        sdkVersion: string;
-        deviceModel: string;
-        camera: CameraModel;
-    };
-};
-declare type InitializeData = InitializedFaceLivenessData | InitializedFaceCaptureData;
-declare type ParamsData = {
-    initializedData: InitializeData;
-};
-declare type ProcessData = {
-    deviceOrientation?: {
-        yaw: number;
-        pitch: number;
-        roll: number;
-    };
-    abortSession?: boolean;
-};
-declare class FaceLivenessService {
-    initialized: boolean;
-    processing: boolean;
-    prepared: boolean;
-    worker: Worker | null;
-    params: ParamsData | null;
-    eventEmitter: EventEmitter;
-    constructor();
-    prepare(listener: (data: any) => void): Promise<void>;
-    initialize(params: {
-        initializedData: InitializeData;
-    }): void;
-    private postCustomMessage;
-    private emit;
-    private print;
-    private printErr;
-    private onWorkerMessage;
-    shutdown(): void;
-    processImage(videoFrame: Uint8ClampedArray, processData: ProcessData): void;
-}
-export default FaceLivenessService;