@idscan/idvc2 2.8.0 → 2.8.2

package/dist/types/context.d.ts

@@ -6,7 +6,7 @@ import Step from './modules/Step';
 import { Base64Image, ISize, IOffset } from './helpers/image';
 import MetaData from './modules/MetaData';
 import { StepType } from './environment/stepsDescription';
-import { IStepMode } from './defaultConfig';
+import { StepConfig, StepMode } from './defaultConfig';
 import { IMRZResults } from './types/mrz';
 import { RealFaceTurnSide } from './types/enums/realFace';
 import { InitClient } from './modules/supaBaseClient';
@@ -72,6 +72,7 @@ export interface Context {
     isShowStayText: boolean;
     isShowHoldText: boolean;
     isShowHelpText: boolean;
+    isShowSwitchToUploaderText: boolean;
     isShowCloserText: boolean;
     isShowCenterText: boolean;
     isShowAwayText: boolean;
@@ -104,7 +105,9 @@ export interface Context {
     offsetsFace: IOffset;
     offsetsResized: IOffset;
     offsets: IOffset;
-    get currentStepMode(): IStepMode;
+    loop: null | LoopFunction;
+    get currentStepMode(): StepMode;
+    get currentStepDelay(): number;
     get hasFrontStep(): boolean;
     calculateIsMirroring(): void;
     dropKeys(): void;
@@ -122,7 +125,7 @@ export interface Context {
     init(): void;
     dropCounters(): void;
     updateRealFaceTurnSide(): void;
-    loop: null | LoopFunction;
+    getStepConfigValue<K extends keyof StepConfig>(key: K): StepConfig[K];
 }
 declare const context: Context;
 export default context;

package/dist/types/defaultConfig.d.ts

@@ -10,29 +10,31 @@ export type NormalizedType = 'Path';
  * { boolean? } uploader
  * { boolean? } video
  */
-export interface IStepMode {
+export type StepMode = {
     uploader?: boolean;
     video?: boolean;
-}
-export type IStepModeKeys = keyof IStepMode;
-export interface IStepConfig {
+};
+export type IStepModeKeys = keyof StepMode;
+export type StepConfig = {
     type: StepType;
     name: string;
-    mode: IStepMode;
-}
-export interface IDocumentType {
+    mode: StepMode;
+    autocaptureDelay?: number;
+    enableDesktopNotification?: boolean;
+};
+export type DocumentType = {
     type: DocumentTypeName;
-    steps: IStepConfig[];
-    mode?: IStepMode;
-}
+    steps: StepConfig[];
+    mode?: StepMode;
+};
 type ImageURI = 'png' | 'jpeg' | 'webp';
-export type DefaultConfigName = 'el' | 'licenseKey' | 'networkUrl' | 'chunkPublicPath' | 'language' | 'documentTypes' | 'realFaceMode' | 'modalPosition' | 'resizeUploadedImage' | 'showSubmitBtn' | 'h_stepMode' | 'isShowDocumentTypeSelect' | 'useCDN' | 'useHeic' | 'processingImageFormat' | 'hideDocumentTitle' | 'autoContinue' | 'isShowGuidelinesButton' | 'fixFrontOrientAfterUpload' | 'onChange' | 'clickGuidlines' | 'onReset' | 'submit' | 'onRetakeHook' | 'onCameraError' | 'onMounted' | 'onReloaded';
+export type DefaultConfigName = 'el' | 'licenseKey' | 'networkUrl' | 'chunkPublicPath' | 'language' | 'documentTypes' | 'realFaceMode' | 'modalPosition' | 'resizeUploadedImage' | 'showSubmitBtn' | 'h_stepMode' | 'isShowDocumentTypeSelect' | 'useCDN' | 'useHeic' | 'processingImageFormat' | 'hideDocumentTitle' | 'autoContinue' | 'autocaptureDelay' | 'isShowGuidelinesButton' | 'fixFrontOrientAfterUpload' | 'onChange' | 'clickGuidlines' | 'onReset' | 'submit' | 'onRetakeHook' | 'onCameraError' | 'onMounted' | 'onReloaded';
 /**
  * IDefaultConfig
  * @param {string} name,
  * @param {'String' | 'Array' | 'Number' | 'Boolean' | 'Function' | 'Object'}  type,
  * @param {string} description,
- * @param {string | boolean | DefaultValueFunction | number | IDocumentType[]} defaultValue,
+ * @param {string | boolean | DefaultValueFunction | number | DocumentType[]} defaultValue,
  * @param {ValidationFn}  validationFn,
  * @parma {boolean} hidden?,
  * @param {RealFaceMode[]} values?,
@@ -43,7 +45,7 @@ export interface IDefaultConfig {
     name: DefaultConfigName;
     type: 'String' | 'Array' | 'Number' | 'Boolean' | 'Function' | 'Object';
     description: string;
-    defaultValue: IStepMode | string | boolean | DefaultValueFunction | number | IDocumentType[];
+    defaultValue: StepMode | string | boolean | DefaultValueFunction | number | DocumentType[];
     validationFn: ValidationFn;
     hidden?: boolean;
     values?: ModalPositionKeys[] | RealFaceMode[] | typeof supportedLanguages[number][] | ImageURI[];

package/dist/types/environment/langs.d.ts

@@ -22,6 +22,7 @@ interface IHintTexts {
     mrz: string;
     capturing: string;
     pdf: string;
+    switchToUploader: string;
     back: string;
     barcode: string;
     hold: string;
@@ -54,6 +55,10 @@ interface IGeneral {
     continueBtn: string;
     submitBtn: string;
     resetAllStepsBtn: string;
+    desktopNotification: {
+        barcode: string;
+        other: string;
+    };
     btnUploader: string;
     btnCamera: string;
     pressToUpdateText: string;

package/dist/types/idvc.d.ts

@@ -4,15 +4,15 @@ import { SupportedLanguage } from './environment/langs';
 import { IDocumentTypeConfig } from './modules/validator';
 export default class VideoCapturing {
     constructor(config: IConfig);
-    private init;
+    get version(): string;
     /**
      *
      * @param language
      */
     changeLanguage(language: SupportedLanguage): void;
-    get version(): string;
     resetAllSteps(): void;
     reloadComponent(newConfig: Partial<IConfig>): void;
     updateDocumentTypes(documentTypes: IDocumentTypeConfig): void;
     showSpinner(val: any): void;
+    private init;
 }

package/dist/types/modules/Config.d.ts

@@ -1,4 +1,4 @@
-import { IStepConfig, ValidationFn } from '../defaultConfig';
+import { StepConfig, ValidationFn } from '../defaultConfig';
 import { RealFaceMode } from '../environment/realFaceModes';
 import { SupportedLanguage } from '../environment/langs';
 import { StepType } from '../environment/stepsDescription';
@@ -57,8 +57,10 @@ export interface IConfig {
      *   - video - capturing an image using the auto capture feature
      */
     documentTypes: IDocumentTypeConfig | null;
-    /** the setting that enables the automatic transition from one step to the next step. Default */
+    /** the setting that enables the automatic transition from one step to the next step. Default is false */
     autoContinue?: boolean;
+    /** the setting the delay (in ms) when automatically switching steps. Default is 1000ms */
+    autocaptureDelay?: number;
     /** sets the maximum size in pixels (of the largest of the height or width) for a manually uploaded picture */
     resizeUploadedImage?: number;
     /** this setting will change the orientation of a front step's image if it is not horizontal when it is uploaded */
@@ -122,10 +124,11 @@ declare class Config implements IConfig {
     el: string;
     commonStepTypes: Set<StepType>;
     types: DocumentTypeName[];
-    steps: IStepConfig[];
+    steps: StepConfig[];
     documentTypes: IDocumentTypeConfig | null;
     licenseKey: string;
     autoContinue: boolean;
+    autocaptureDelay: number;
     resizeUploadedImage: number;
     fixFrontOrientAfterUpload: boolean;
     useCDN: boolean;

package/dist/types/modules/PdfModule.d.ts

@@ -1,4 +1,5 @@
-import { ISize } from '../helpers/image';
+import type { ISize } from '../helpers/image';
+import type { PDFPreProcessResult, PDFResult } from '../types/pdf';
 interface Coord {
     x: number;
     y: number;
@@ -13,6 +14,7 @@ export declare class PdfModule {
     out: any;
     isAllocate: boolean;
     successCount: number;
+    pdfCapturedCount: number;
     edgMem: any;
     src2: any;
     outLen: any;
@@ -24,7 +26,15 @@ export declare class PdfModule {
     minPDFframes: number;
     cropSizes: ISize;
     canvasSizes: ISize;
-    constructor(core: any, processor: any);
+    private preProcessCore;
+    private readonly preProcessReader;
+    constructor(pdf: {
+        core: any;
+        processor: any;
+    }, pdfWithPreProcess?: {
+        core: any;
+        processor: any;
+    });
     _errorId: number;
     get errorId(): number;
     set errorId(id: number);
@@ -37,10 +47,6 @@ export declare class PdfModule {
      * @param {{width: number, height: number}} canvasSizes - ui.borderCanvas
      */
     init(geometry: any, minPDFframes: any, cropSize: any, canvasSizes: any): void;
-    /**
-     * returns error Object
-     * @return {{errorType: string, error: boolean, errorVal: string}}
-     */
     licenseError(): {
         error: boolean;
         errorType: string;
@@ -51,7 +57,7 @@ export declare class PdfModule {
     initReader(key: any): void;
     destroyReader(): void;
     setPdfData(data: any): void;
-    readPdf(): any;
+    readPdf(): PDFResult;
     releasePdf(): void;
     create(): void;
     free(): void;
@@ -61,20 +67,10 @@ export declare class PdfModule {
         bh: number;
     };
     allocate(): void;
-    readPDF(data: any): any;
     drawCords(locations: Record<string, number>): Coord[];
-    proccessPDF(data: ImageData): {
-        status: boolean;
-        predict: boolean;
-        touch: boolean;
-        image: any;
-        type: string;
-        error: any;
-        coords: any[];
-        trackString: string;
-        pdfSuccessCount: number;
-        pdfCount: number;
-        isSuccessProcess: boolean;
-    };
+    processPDF(data: ImageData): Record<string, any>;
+    processPDFWithPreProcess(data: ImageData): PDFPreProcessResult;
+    private readPDF;
+    private readPDFWithPreProcess;
 }
 export default PdfModule;

package/dist/types/modules/Step.d.ts

@@ -1,9 +1,9 @@
 import { Base64Image } from '../helpers/image';
 import { StepType } from '../environment/stepsDescription';
-import { IStepMode } from '../defaultConfig';
+import { StepMode } from '../defaultConfig';
 export interface IStepConfigMode {
     name: 'mode';
-    value: IStepMode;
+    value: StepMode;
 }
 export type StepConfig = IStepConfigMode;
 export type StepConfigNames = StepConfig['name'];
@@ -60,11 +60,11 @@ export default class Step implements IStepCallback, IStepObj {
     img: Base64Image | null;
     cameraInfo: Record<string, any>;
     constructor(nameOrObj: string | IStepObj, type?: StepType, camera?: VideoFacingModeEnum, time?: number, img?: Base64Image | null);
+    get isShowManualSwitchButton(): boolean;
+    get capturingMode(): StepMode;
+    static createStep(stepObj: IStepObj): Step;
     setConfig(configName: StepConfigNames, configValue: StepConfigValues): void;
     hasConfig(configName: StepConfigNames): StepConfig | undefined;
     getConfig(configName: StepConfigNames): StepConfigValues | null;
-    get isShowManualSwitchButton(): boolean;
-    get capturingMode(): IStepMode;
     prepareStepForCallback(index: number): IStepCallback;
-    static createStep(stepObj: IStepObj): Step;
 }

package/dist/types/modules/ui/MaskCapture.d.ts

@@ -1,33 +1,30 @@
-import { StepType } from '../../environment/stepsDescription';
+import type { StepType } from '../../environment/stepsDescription';
+import { DocumentTypeIndex } from '../../environment/documentTypes';
 declare class MaskCapture {
     private readonly svg;
     private readonly strokeMask;
     private successMask;
     private readonly pdfHint;
-    private readonly mrzHint;
+    private readonly mrz2Hint;
+    private readonly mrz3Hint;
     private type;
     private cssVarContainer;
     private borders;
     private cssVars;
+    private hintElements;
+    constructor(cssVarContainer: any);
     _mainContainerSizes: {
         width: string;
         height: string;
     };
-    private mappedState;
-    constructor(cssVarContainer: any);
     /**
-     * get computed width and height of element
-     * @param {HTMLElement} el
-     * @return {{width: string, height: string}}
+     * resizes frame based on width and height of main container
+     * @param {{width: number, height: number}} param - width and height of main container
      */
-    getSizes: (el: any) => {
-        width: string;
-        height: string;
-    };
-    applyMaskCaptureSizes(mainContainer: Element, currentStepType: StepType): void;
-    applyCaptureHintMask(mainContainer: Element): void;
-    applyMainContainerSize(mainContainer: Element): void;
-    changeHintState(currentStepType: StepType): void;
+    set mainContainerSizes({ width, height }: {
+        width: any;
+        height: any;
+    });
     get svgSizes(): {
         width: string;
         height: string;
@@ -37,36 +34,43 @@ declare class MaskCapture {
         height: number;
     };
     get strokeLength(): number;
-    private calculateUserSizes;
-    private set borderSizes(value);
-    private calculateEnvironmentSizes;
-    private calculateFieldMaskSizes;
-    private applySizes;
     set sizes({ width, height }: {
         width: any;
         height: any;
     });
-    private addAnimation;
-    private removeAnimation;
     set fillPercentage(percentage: any);
     /**
      * sets the type of capturing mask and it position on screen
      * @param {VideoFacingModeEnum} type - 'environment', 'user'
      */
     set maskType(type: any);
+    private set borderSizes(value);
+    /**
+     * get computed width and height of element
+     * @param {HTMLElement} el
+     * @return {{width: string, height: string}}
+     */
+    getSizes: (el: any) => {
+        width: string;
+        height: string;
+    };
+    applyMaskCaptureSizes(mainContainer: Element, currentStepType: StepType, currentDocument: DocumentTypeIndex | 0): void;
+    applyCaptureHintMask(mainContainer: Element): void;
+    applyMainContainerSize(mainContainer: Element): void;
+    changeHintState(currentStepType: any, currentDocument: any): void;
+    hideAllHints(): void;
+    showHintForCurrentStep(currentStepType: any, currentDocument: any): void;
+    private calculateUserSizes;
+    private calculateEnvironmentSizes;
+    private calculateFieldMaskSizes;
+    private applySizes;
+    private addAnimation;
+    private removeAnimation;
     /**
      *
      * @param {Number} size1
      * @param {Number} size2
      */
     private calculateSize;
-    /**
-     * resizes frame based on width and height of main container
-     * @param {{width: number, height: number}} param - width and height of main container
-     */
-    set mainContainerSizes({ width, height }: {
-        width: any;
-        height: any;
-    });
 }
 export default MaskCapture;

package/dist/types/modules/validation/ValidateDocumentTypes.d.ts

@@ -1,20 +1,20 @@
-import { DefaultConfigName, IDocumentType } from '../../defaultConfig';
+import { DefaultConfigName, DocumentType } from '../../defaultConfig';
 import { DocumentTypeName } from '../../environment/documentTypes';
 import { StepType } from '../../environment/stepsDescription';
 import { IDocumentTypeConfig, IValidator } from '../validator';
-declare class ValidateDocumentTypes implements IValidator<IDocumentType[]> {
+declare class ValidateDocumentTypes implements IValidator<DocumentType[]> {
     types: any[];
     steps: any[];
     commonStepTypes: Set<StepType>;
     documentTypes: IDocumentTypeConfig;
-    validate(val: IDocumentType[], fallback: IDocumentType[], configName: DefaultConfigName): {
+    validate(val: DocumentType[], fallback: DocumentType[], configName: DefaultConfigName): {
         types: any[];
         steps: any[];
         commonStepTypes: Set<StepType>;
         documentTypes: IDocumentTypeConfig;
     };
     validateTypes(types: string[]): DocumentTypeName[];
-    transformDocType({ type, steps }: IDocumentType): void;
+    transformDocType({ type, steps }: DocumentType): void;
     setCommonStepTypes(): void;
 }
 export default ValidateDocumentTypes;

package/dist/types/modules/validator.d.ts

@@ -1,8 +1,8 @@
 import { DocumentTypeName } from '../environment/documentTypes';
-import { DefaultConfigName, IStepConfig } from '../defaultConfig';
+import { DefaultConfigName, StepConfig } from '../defaultConfig';
 export type IDocumentTypeConfig = {
     type: DocumentTypeName;
-    steps: IStepConfig[];
+    steps: StepConfig[];
 }[];
 type SimpleValidate<T> = (val: T, fallback: T, configName: DefaultConfigName) => any;
 type OneOfArray<T> = (valueToSet: T, defaultValue: T, configName: DefaultConfigName, availableValues: T[]) => any;

package/dist/types/types/enums/pdf.d.ts

@@ -0,0 +1,8 @@
+export declare enum EResultStatus {
+    Empty = 0,
+    Detected = 1,
+    Decoded = 2,
+    Error = 3,
+    InvalidLicenseKey = 4,
+    LicenseKeyHasExpired = 5
+}

package/dist/types/types/pdf.d.ts

@@ -0,0 +1,43 @@
+import { EResultStatus } from './enums/pdf';
+export type PDFParameters = {
+    rows: number;
+    columns: number;
+    ecl: number;
+};
+export type PDFLocation = {
+    x1: number;
+    y1: number;
+    x2: number;
+    y2: number;
+    x3: number;
+    y3: number;
+    x4: number;
+    y4: number;
+};
+export type PDFStatus = {
+    value: EResultStatus;
+};
+export type PDFResult = {
+    error?: any;
+    data: string;
+    errorDesc: string;
+    location: PDFLocation;
+    parameters: PDFParameters;
+    status: PDFStatus;
+    trackString?: string;
+};
+export type PDFError = {
+    errorType: string;
+    error: boolean;
+    errorVal: any;
+};
+export type PDFPreProcessResult = {
+    direction: {
+        value: number;
+    };
+    error: string;
+    location: PDFLocation;
+    resultParams: PDFParameters;
+    status: PDFStatus;
+    trackString: string;
+} | PDFError;

package/dist/types/ui.d.ts

@@ -32,6 +32,7 @@ declare class Ui {
     pressToUpdateText: HTMLElement;
     pressToUpdateTextSuccess: HTMLElement;
     documentType: HTMLParagraphElement;
+    desktopNotification: HTMLDivElement;
     videoErrorText: HTMLElement;
     mainContainer: HTMLElement;
     Mask: MaskCapture;
@@ -83,6 +84,7 @@ declare class Ui {
     getFakeContourWidth(width: number): number;
     setFakeContourStyles(width: number): void;
     setMirroring(): void;
+    setDesktopNotificationVisibility(): void;
 }
 declare const ui: {
     ui: Ui | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idscan/idvc2",
-  "version": "2.8.0",
+  "version": "2.8.2",
   "description": "component for the capturing documents",
   "main": "dist/idvc.js",
   "types": "dist/types/idvc.d.ts",