@regulaforensics/vp-frontend-document-components 7.6.2184-rc → 7.6.2241-nightly

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { ContainerList } from '@regulaforensics/document-reader-webclient';
 import { GetTransactionsByTagResponse } from '@regulaforensics/document-reader-webclient';
+import { Light } from '@regulaforensics/document-reader-webclient';
 import { ProcessParams } from '@regulaforensics/document-reader-webclient';
 import { ProcessResponse } from '@regulaforensics/document-reader-webclient';
 import { Response as Response_2 } from '@regulaforensics/document-reader-webclient';
@@ -37,7 +38,7 @@ export declare type CameraSnapshotResponseType = Array<{
 
 export declare interface CameraSnapshotSettings {
     startScreen?: boolean;
-    locale?: Locales | string;
+    locale?: Locales;
     multipleFileInput?: boolean;
     regulaLogo?: boolean;
     copyright?: boolean;
@@ -53,6 +54,10 @@ export declare interface CameraSnapshotSettings {
     uploadFileButton?: boolean;
     mirrorButton?: boolean;
     mirrorType?: MirrorType;
+    statusPositionMultiplier?: number;
+    statusIcon?: boolean;
+    activityIndicatorPortraitPositionMultiplier?: number;
+    activityIndicatorLandscapePositionMultiplier?: number;
 }
 
 export declare type CaptureFrameType = {
@@ -70,7 +75,7 @@ export declare enum CaptureMode {
 export declare type CaptureType = Array<Omit<CaptureFrameType, 'imageData'>>;
 
 export declare interface CurrentPage {
-    data: Response_2 | null;
+    data: DocumentReaderResponseType | null;
     startNextPage: () => Promise<void>;
     finishRecognition: () => void;
 }
@@ -92,6 +97,22 @@ export declare interface DetailEvent<A, R> {
 
 export declare type DocumentDictionaries = Partial<Record<Locales, DocumentTranslations>>;
 
+declare enum DocumentImageType {
+    Unknown = 0,
+    PassportSinglePage = 1,
+    PassportTwoPages = 2,
+    IDFront = 3,
+    IDFrontMRZ = 4,
+    IDBack = 5,
+    IDBackMrz = 6,
+    IDBackBarcode = 7,
+    IDBackBarcodeMRZ = 8,
+    BankCardFront = 9,
+    BankCardBack = 10,
+    DocumentFront = 11,
+    DocumentBack = 12
+}
+
 declare enum DocumentReaderAttributes {
     locale = "locale",
     multiple = "multiple",
@@ -112,12 +133,12 @@ export declare class DocumentReaderCaptureWebComponent extends HTMLElement {
     private _translations;
     private _settings;
     constructor();
-    static get observedAttributes(): CameraSnapshotAttributes[];
+    static get observedAttributes(): Array<CameraSnapshotAttributes>;
     private onEvent;
     attributeChangedCallback(name: CameraSnapshotAttributes): void;
     connectedCallback(): void;
-    set translations(dictionary: Partial<Record<string, DocumentTranslations>> | null);
-    get translations(): Partial<Record<string, DocumentTranslations>> | null;
+    set translations(dictionary: DocumentDictionaries | null);
+    get translations(): DocumentDictionaries | null;
     set settings(params: CameraSnapshotSettings);
     get settings(): CameraSnapshotSettings;
     private render;
@@ -147,8 +168,8 @@ export declare class DocumentReaderProcessor {
     isInitialized: boolean;
     videoElement: HTMLVideoElement | null;
     constructor(videoElement?: HTMLVideoElement);
-    get recognizeListener(): ((data: Response_2 | ProcessRejectResponse) => void) | null;
-    set recognizeListener(listener: ((data: Response_2 | ProcessRejectResponse) => void) | null);
+    get recognizeListener(): RecognizeListener | null;
+    set recognizeListener(listener: RecognizeListener | null);
     get streamParam(): Partial<StreamParams>;
     set streamParam(params: Partial<StreamParams>);
     get recognizerProcessParam(): ProcessingRequest;
@@ -164,8 +185,8 @@ export declare class DocumentReaderProcessor {
     private startNewPage;
     private startNewDocument;
     switchCamera(): Promise<void>;
-    startRecognition(responseListener?: ResponseListener): Promise<Response_2 | null>;
-    processImage(images: FileList | Array<Blob>): Promise<Response_2>;
+    startRecognition(responseListener?: ResponseListener): Promise<DocumentReaderResponseType | null>;
+    processImage(images: FileList | Array<Blob>): Promise<DocumentReaderResponseType>;
     stopRecognition(): void;
     initialize(license?: {
         license: string | undefined;
@@ -174,6 +195,7 @@ export declare class DocumentReaderProcessor {
 }
 
 export declare type DocumentReaderProcessParam = Pick<ProcessParams, 'generateNumericCodes' | 'returnUncroppedImage' | 'log' | 'resultTypeOutput' | 'customParams' | 'imageOutputMaxHeight' | 'imageOutputMaxWidth' | 'fieldTypesFilter' | 'dateFormat' | 'measureSystem' | 'imageDpiOutMax' | 'alreadyCropped' | 'fastDocDetect' | 'updateOCRValidityByGlare' | 'returnCroppedBarcode' | 'respectImageQuality' | 'forceDocFormat' | 'noGraphics' | 'depersonalizeLog' | 'multiDocOnImage' | 'shiftExpiryDate' | 'minimalHolderAge' | 'mrzFormatsFilter' | 'forceReadMrzBeforeLocate' | 'parseBarcodes' | 'splitNames' | 'doublePageSpread' | 'strictImageQuality' | 'doDetectCan' | 'generateDoublePageSpreadImage' | 'mrzDetectMode' | 'strictBarcodeDigitalSignatureCheck' | 'selectLongestNames'> & {
+    generateAlpha2Codes?: boolean;
     returnPackageForReprocess?: boolean;
     scenario?: InternalScenarios;
     multipageProcessing?: boolean;
@@ -182,6 +204,10 @@ export declare type DocumentReaderProcessParam = Pick<ProcessParams, 'generateNu
     timeoutFromFirstDocType?: number;
     documentAreaMin?: number;
     imageQa?: {
+        angleThreshold?: number;
+        focusCheck?: boolean;
+        documentPositionIndent?: number;
+        brightnessThreshold?: number;
         expectedPass?: Array<ImageQualityChecks>;
         dpiThreshold?: number;
         glaresCheck?: boolean;
@@ -235,9 +261,9 @@ export declare class DocumentReaderService {
         license: string | undefined;
     }): Promise<License>;
     private doProcess;
-    processImageBase64(base64ImagesArray: Array<string>, params: ProcessingRequest): Promise<Response_2>;
-    process(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<Response_2>;
-    processImage(imageDataArray: Array<ImageData> | Array<ArrayBuffer>, params?: ProcessingRequest): Promise<Response_2>;
+    processImageBase64(base64ImagesArray: Array<string>, params: ProcessingRequest): Promise<DocumentReaderResponseType>;
+    process(imageDataArray: Array<ImageData>, params?: ProcessingRequest): Promise<DocumentReaderResponseType>;
+    processImage(imageDataArray: Array<ImageData> | Array<ArrayBuffer>, params?: ProcessingRequest): Promise<DocumentReaderResponseType>;
     startNewPage(): Promise<void>;
     startNewDocument(metadata?: Record<string, any>): Promise<NewTransaction>;
     createBackendTransaction(metadata?: Record<string, any>): Promise<NewTransaction>;
@@ -259,8 +285,6 @@ export declare interface DocumentReaderSettings extends CameraSnapshotSettings {
     backgroundMaskAlpha?: number;
     cameraFramePortraitAspectRatio?: number;
     cameraFrameLandscapeAspectRatio?: number;
-    statusPositionMultiplier?: number;
-    statusIcon?: boolean;
     cameraFrameOffsetWidth?: number;
     cameraFrameVerticalPositionMultiplier?: number;
     cameraFrameHorizontalPositionMultiplier?: number;
@@ -288,67 +312,19 @@ export declare class DocumentReaderWebComponent extends HTMLElement {
     private _translations;
     private _settings;
     constructor();
-    static get observedAttributes(): DocumentReaderAttributes[];
+    static get observedAttributes(): Array<DocumentReaderAttributes>;
     private onEvent;
     attributeChangedCallback(name: DocumentReaderAttributes): void;
     connectedCallback(): void;
-    set translations(dictionary: Partial<Record<string, DocumentTranslations>> | null);
-    get translations(): Partial<Record<string, DocumentTranslations>> | null;
+    set translations(dictionary: DocumentDictionaries | null);
+    get translations(): DocumentDictionaries | null;
     set settings(params: DocumentReaderSettings);
     get settings(): DocumentReaderSettings;
     private render;
     disconnectedCallback(): void;
 }
 
-export declare interface DocumentTranslations {
-    scanIDInBrowser?: string;
-    useYourDeviceCamera?: string;
-    success?: string;
-    processingFinished?: string;
-    largeFile?: string;
-    selectSmallerFile?: string;
-    versionNotSupported?: string;
-    httpNotSupported?: string;
-    insecurePageContext?: string;
-    updateBrowser?: string;
-    licenseError?: string;
-    licenseExpired?: string;
-    fileCorrupt?: string;
-    selectAnotherFile?: string;
-    timeout?: string;
-    error?: string;
-    somethingWentWrong?: string;
-    tryAgain?: string;
-    fromCamera?: string;
-    fromGallery?: string;
-    processing?: string;
-    preparingService?: string;
-    placeDocumentIntoFrame?: string;
-    positionDocumentCenter?: string;
-    noFocus?: string;
-    moveCloser?: string;
-    glaresOnDocument?: string;
-    holdDocumentStraight?: string;
-    documentProcessing?: string;
-    flipDocument?: string;
-    cameraUnavailable?: string;
-    preparingCamera?: string;
-    noCameraAvailable?: string;
-    incorrectCameraId?: string;
-    allowAccessToCamera?: string;
-    cameraConnection?: string;
-    checkCameraId?: string;
-    photoCapturedSuccessfully?: string;
-    uploadPhoto?: string;
-    useCameraOrGallery?: string;
-    connect?: string;
-    disconnect?: string;
-    process?: string;
-    device?: string;
-    service?: string;
-    autoScan?: string;
-    keepDeviceStill?: string;
-}
+export declare type DocumentTranslations = Partial<Record<Labels, string>>;
 
 export declare enum ErrorTypes {
     WASM_ERROR = "WASM_ERROR",
@@ -399,6 +375,13 @@ export declare enum FrameLineCap {
     square = "square"
 }
 
+export declare interface FramePosition {
+    frameBottom: number;
+    frameLeft: number;
+    frameRight: number;
+    frameTop: number;
+}
+
 export declare enum FrameShapeType {
     line = "line",
     corners = "corners"
@@ -409,6 +392,19 @@ export declare class FullScreenContainer extends HTMLElement {
     constructor();
 }
 
+declare enum HoloAnimationType {
+    Unknown = 0,
+    Horizontal = 1,
+    Vertical = 2,
+    LeftBottomRightTop = 4,
+    RightBottomLeftTop = 8
+}
+
+export declare interface HoloData {
+    hologramTiltType: HoloAnimationType;
+    livenessAnimationImage: DocumentImageType;
+}
+
 export declare interface ICameraSnapshot {
     locale?: Locales;
     copyright?: boolean;
@@ -426,14 +422,10 @@ export declare interface IDocumentReader extends ICameraSnapshot {
     'capture-button'?: boolean;
 }
 
-export declare interface ImageInputParamType {
-    frameBottom: number;
-    frameLeft: number;
-    frameRight: number;
-    frameTop: number;
-    light: number;
-    resolutionType: number;
-}
+export declare type ImageInputParamType = Partial<FramePosition> & {
+    light?: Light;
+    resolutionType?: number;
+};
 
 export declare type ImageProcessingRequest = BaseRequest;
 
@@ -461,6 +453,10 @@ declare interface IOptions {
     color?: string;
 }
 
+declare type Labels = 'preparingCamera' | 'timeout' | 'noFocus' | 'somethingWentWrong' | 'incorrectCameraId' | 'done' | 'cameraUnavailable' | 'versionNotSupported' | 'httpNotSupported' | 'insecurePageContext' | 'badLicense' | 'fileCorrupt' | 'largeFile' | 'placeDocumentIntoFrame' | 'holdDocumentStraight' | 'glaresOnDocument' | 'tryAgain' | 'noCameraAvailable' | 'positionDocumentCenter' | 'uploadPhoto' | 'moveCloser' | 'keepDeviceStill' | 'camera' | 'switchToMobile' | 'openPhoneCamera' | 'pleaseWait' | 'mobileDevice' | 'verifyYourIdentity' | 'fromCameraFilesMobileDesktop' | 'fromCameraFilesDesktop' | 'fromCameraMobileDesktop' | 'fromFilesMobileDesktop' | 'fromCameraDesktop' | 'fromFilesDesktop' | 'fromMobileDesktop' | 'fromCameraGalleryMobile' | 'fromGalleryMobile' | 'gallery' | 'files' | 'returnToComputer' | 'documentCaptured';
+
+declare type Languages = 'ru' | 'en' | 'de' | 'pl' | 'it' | 'hu' | 'zh' | 'sk' | 'uk' | 'fr' | 'es' | 'pt' | 'ar' | 'nl' | 'id' | 'vi' | 'ko' | 'ms' | 'ro' | 'el' | 'tr' | 'ja' | 'cs' | 'th' | 'hi' | 'bn' | 'he' | 'fi' | 'sv' | 'da' | 'hr' | 'no' | 'uz' | 'hy' | 'ky';
+
 export declare type License = {
     license: {
         errorCode: number;
@@ -470,7 +466,7 @@ export declare type License = {
     scenario: Array<TScenarioParams>;
 };
 
-export declare type Locales = 'ru' | 'en' | 'de' | 'pl' | 'it' | 'hu' | 'zh' | 'sk' | 'uk' | 'fr' | 'es' | 'pt' | 'ar' | 'nl' | 'id' | 'vi' | 'ko' | 'ms' | 'ro' | 'el' | 'tr' | 'ja' | 'cs' | 'th' | 'hi' | 'bn' | 'he' | 'fi' | 'sv' | 'da' | 'hr' | 'no' | 'uz' | 'hy' | 'ky' | string;
+export declare type Locales = Languages | string;
 
 export declare const Logger: Logger_2;
 
@@ -502,6 +498,8 @@ export declare interface PackageParams {
     metadata?: Record<string, any>;
 }
 
+export declare type ProcessHoloResponse = HoloData & ProcessResponseWithLight;
+
 export declare interface ProcessingRequest extends BaseRequest {
     metadata?: Record<string, any>;
     delegateProcessing?: {
@@ -512,13 +510,21 @@ export declare interface ProcessingRequest extends BaseRequest {
     imagesList?: Array<DocumentReaderImage>;
 }
 
+export declare interface ProcessMultiPageResponse extends ProcessResponse {
+    multipageAnimationImage: Array<DocumentImageType>;
+}
+
 export declare interface ProcessRejectResponse extends ProcessResponse {
     licensing_code: number;
     reject_message: string;
     reject_reason: number;
 }
 
-declare type RecognizeListener = (data: Response_2 | ProcessRejectResponse) => void;
+export declare interface ProcessResponseWithLight extends ProcessResponse {
+    lightType: Array<Light>;
+}
+
+declare type RecognizeListener = (data: DocumentReaderResponseType) => void;
 
 export declare type Resolution = Partial<WidthAndHeight>;
 
@@ -607,24 +613,51 @@ export * from "@regulaforensics/document-reader-webclient";
 export { }
 
 
+
 declare global {
+    const UI_COMPONENTS_VERSION: string;
+    const DOC_WASM_S3_PATH: string;
+    const DOCUMENT_API: string;
+    const LICENSE: string | undefined;
+
+    namespace React.JSX {
+        interface IntrinsicElements {
+            'document-reader': React.DetailedHTMLProps<
+                IDocumentReader & React.HTMLAttributes<DocumentReaderWebComponent>,
+                DocumentReaderWebComponent
+            >;
+            'camera-snapshot': React.DetailedHTMLProps<
+                ICameraSnapshot & React.HTMLAttributes<DocumentReaderCaptureWebComponent>,
+                DocumentReaderCaptureWebComponent
+            >;
+            'fullscreen-container': React.DetailedHTMLProps<
+                React.HTMLAttributes<FullScreenContainer>,
+                FullScreenContainer
+            >;
+        }
+    }
+
     interface HTMLElementEventMap {
         'document-reader': CustomEvent<DocumentReaderDetailType | TransactionEvent>;
         'camera-snapshot': CustomEvent<CameraSnapshotDetailType>;
     }
+
     interface Window {
         RegulaDocumentSDK: DocumentReaderService;
     }
 }
 
-
-declare namespace v3 {
-    var DNS: string;
-    var URL: string;
+declare global {
+    const VERSION: string;
+    const ENV: string;
 }
 
+declare module 'react' {
+    interface HTMLAttributes<T> extends AriaAttributes, DOMAttributes<T> {
+        part?: string;
+    }
 
-declare namespace v5 {
-    var DNS: string;
-    var URL: string;
+    interface SVGAttributes<T> extends AriaAttributes, DOMAttributes<T> {
+        part?: string;
+    }
 }