@idscan/idvc2 3.2.0 → 3.3.0

package/dist/types/defaultConfig.d.ts

@@ -29,9 +29,10 @@ export type DocumentType = {
     type: DocumentTypeName;
     steps: StepConfig[];
     mode?: StepMode;
+    tooltipText?: string;
 };
 type ImageURI = 'png' | 'jpeg' | 'webp';
-export type DefaultConfigName = 'el' | 'licenseKey' | 'networkUrl' | 'language' | 'customTranslations' | 'documentTypes' | 'realFaceMode' | 'modalPosition' | 'resizeUploadedImage' | 'showSubmitBtn' | 'isShowDocumentTypeSelect' | 'useCDN' | 'processingImageFormat' | 'allowSubmitWithWarnings' | 'autocaptureConfidence' | 'autoContinue' | 'autoStart' | 'playPreviewAnimations' | 'autocaptureDelay' | 'fixFrontOrientAfterUpload' | 'onChange' | 'onReset' | 'submit' | 'onRetakeHook' | 'onCameraError' | 'onMounted' | 'onReloaded';
+export type DefaultConfigName = 'el' | 'licenseKey' | 'networkUrl' | 'language' | 'customTranslations' | 'documentTypes' | 'realFaceMode' | 'modalPosition' | 'resizeUploadedImage' | 'showSubmitBtn' | 'isShowDocumentTypeSelect' | 'useCDN' | 'processingImageFormat' | 'allowSubmitWithWarnings' | 'autocaptureConfidence' | 'autoContinue' | 'autoStart' | 'playPreviewAnimations' | 'autocaptureDelay' | 'fixFrontOrientAfterUpload' | 'onChange' | 'onReset' | 'submit' | 'onRetakeHook' | 'onCameraError' | 'onMounted' | 'onDocumentTypeSelect' | 'onReloaded';
 /**
  * IDefaultConfig
  * @param {string} name,

package/dist/types/modules/App/UI.d.ts

@@ -29,6 +29,7 @@ export declare class WeblibUI {
     private setFaceOffsets;
     private setCropFace;
     private initMainScreenComponents;
+    private getDocumentsFromAllowedTypes;
     private initStepsList;
     updateInitScreenDocuments(allowedTypesIds: any): void;
     private initDocumentsList;

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

@@ -6,7 +6,7 @@ import { DocumentTypeName } from '../environment/documentTypes';
 import { DeepPartial } from '../types/helpers/DeepPartial';
 import { IDocumentTypeConfig } from './validator';
 import { IStepCallback } from './Step';
-import { IDataForSubmit } from '../util';
+import { IDataForDocumentTypeSelect, IDataForSubmit } from '../util';
 import ValidateDocumentTypes from './validation/ValidateDocumentTypes';
 /**
  * @param {string} el,
@@ -126,8 +126,15 @@ export interface IConfig {
     onReset?: (data: IDataForSubmit) => void;
     /** function which will be called in case the camera is not available */
     onCameraError?: (data: Error) => void;
-    /** function which will be called after clicking the submit button */
+    /** function which will be called after clicking the submit button
+     *
+     * This option switches on/off the HEIC image processing (HEIC is Apple’s proprietary version of the Image File format). It’s possible to upload an image of this type only using a Mac/MacBook
+    */
     submit?: (data: IDataForSubmit) => void;
+    /**
+     * Function that will be called when a document type is selected.
+     */
+    onDocumentTypeSelect?: (data: IDataForDocumentTypeSelect) => void;
 }
 declare class Config implements IConfig {
     el: string;

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

@@ -0,0 +1,3 @@
+import { TemplateResult } from 'lit-html';
+export declare function toggleTooltip(event: Event): void;
+export declare function HelpTooltipTemplate(tooltipText: string): TemplateResult;

package/dist/types/modules/ui/HelpTooltip/index.d.ts

@@ -0,0 +1 @@
+export { HelpTooltipTemplate } from './HelpTooltip';

package/dist/types/modules/ui/InitScreeen/InitScreen.d.ts

@@ -16,5 +16,5 @@ export type InitScreenEvents = {
 export declare class InitScreen extends ComponentLit<InitScreenState> {
     constructor(mountElement: HTMLElement | string, state: InitScreenState, events?: InitScreenEvents);
     protected renderTemplate(): void;
-    private handleDocumentClick;
+    handleDocumentClick: (event: Event) => void;
 }

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

@@ -1,6 +1,7 @@
 import Modal from './Modal';
 import { DocumentRecord, DocumentTypeName } from '../../environment/documentTypes';
 import { ModalPositionKeys } from '../../environment/modalPosition';
+import { IDataForDocumentTypeSelect } from '../../util';
 interface ILoader {
     addState: () => void;
     showLoader: () => void;
@@ -9,17 +10,20 @@ interface ILoader {
     hideLoader: () => void;
 }
 declare class SelectDocumentType extends Modal {
+    #private;
     private elementsList;
     private header;
     private list;
     private loader;
-    constructor(componentWrapper: HTMLElement, loader: ILoader, modalPositionClass: ModalPositionKeys);
+    constructor(componentWrapper: HTMLElement, loader: ILoader, modalPositionClass: ModalPositionKeys, onDocumentTypeSelect: (params: IDataForDocumentTypeSelect) => void);
     show(currentDocument: DocumentTypeName | ''): void;
     hide(): void;
     showCancelButton(): void;
     addCancelHandler(handler: (e?: Event) => void): void;
     clearList(): void;
-    addType({ name: docType, humanName, id }: DocumentRecord): void;
+    addType({ name: docType, humanName, id, tooltipText, }: DocumentRecord & {
+        tooltipText?: string;
+    }): void;
     render(): void;
     private hideCancelButton;
     private createElement;

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

@@ -7,12 +7,14 @@ export interface IValidateDocumentTypes {
     steps: any[];
     commonStepTypes: Set<StepType>;
     documentTypes: IDocumentTypeConfig;
+    tooltipTextMap: Partial<Record<DocumentTypeName, string>>;
 }
 declare class ValidateDocumentTypes implements IValidator<DocumentType[]> {
     types: any[];
     steps: any[];
     commonStepTypes: Set<StepType>;
     documentTypes: IDocumentTypeConfig;
+    tooltipTextMap: Partial<Record<DocumentTypeName, string>>;
     static checkIsDocumentTypes(obj: unknown): obj is IValidateDocumentTypes;
     validate(val: DocumentType[], fallback: DocumentType[], configName: DefaultConfigName): IValidateDocumentTypes;
     validateTypes(types: string[]): DocumentTypeName[];

package/dist/types/util.d.ts

@@ -1,7 +1,11 @@
 import { Base64Image } from './helpers/image';
 import { IStepCallback } from './modules/Step';
-import { DocumentTypeIndex } from './environment/documentTypes';
+import { DocumentTypeIndex, DocumentTypeName } from './environment/documentTypes';
 import { Context } from './types/context';
+export interface IDataForDocumentTypeSelect {
+    docType: DocumentTypeName;
+    id: 0 | DocumentTypeIndex;
+}
 export interface IDataForSubmit {
     metaData?: string;
     payload?: Record<string, any>;

package/package.json

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