@idscan/idvc2 2.15.0 → 3.1.0

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

@@ -2,17 +2,19 @@ import { DefaultConfigName, DocumentType } from '../../defaultConfig';
 import { DocumentTypeName } from '../../environment/documentTypes';
 import { StepType } from '../../environment/stepsDescription';
 import { IDocumentTypeConfig, IValidator } from '../validator';
+export interface IValidateDocumentTypes {
+    types: any[];
+    steps: any[];
+    commonStepTypes: Set<StepType>;
+    documentTypes: IDocumentTypeConfig;
+}
 declare class ValidateDocumentTypes implements IValidator<DocumentType[]> {
     types: any[];
     steps: any[];
     commonStepTypes: Set<StepType>;
     documentTypes: IDocumentTypeConfig;
-    validate(val: DocumentType[], fallback: DocumentType[], configName: DefaultConfigName): {
-        types: any[];
-        steps: any[];
-        commonStepTypes: Set<StepType>;
-        documentTypes: IDocumentTypeConfig;
-    };
+    static checkIsDocumentTypes(obj: unknown): obj is IValidateDocumentTypes;
+    validate(val: DocumentType[], fallback: DocumentType[], configName: DefaultConfigName): IValidateDocumentTypes;
     validateTypes(types: string[]): DocumentTypeName[];
     transformDocType({ type, steps }: DocumentType): void;
     setCommonStepTypes(): void;

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

@@ -1,2 +1,7 @@
-declare const showError: (configName: string, fallback: any) => void;
+interface IShowErrorProps {
+    configName: string;
+    fallback: any;
+    invalidPathsWithReason?: Record<string, string>;
+}
+declare const showError: ({ configName, fallback, invalidPathsWithReason }: IShowErrorProps) => void;
 export default showError;

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

@@ -1,10 +1,11 @@
 import { ValidationFn } from '../../defaultConfig';
 import ValidateElement from './ValidateElement';
 import ValidateBool from './ValidateBool';
+import ValidateDictionaryLangMatch from './ValidateDictionaryLangMatch';
 import ValidateDistinctStringInArray from './ValidateStringInArray';
 import ValidateDocumentTypes from './ValidateDocumentTypes';
 import ValidateFunction from './ValidateFunction';
 import ValidateNumber from './ValidateNumber';
 import ValidateString from './ValidateString';
-declare const validatorFactory: (name: ValidationFn) => false | ValidateElement | ValidateBool | ValidateDistinctStringInArray | ValidateDocumentTypes | ValidateFunction | ValidateNumber | ValidateString;
+declare const validatorFactory: (name: ValidationFn) => false | ValidateElement | ValidateBool | ValidateDistinctStringInArray | ValidateDocumentTypes | ValidateFunction | ValidateNumber | ValidateString | ValidateDictionaryLangMatch<Record<string, unknown>>;
 export default validatorFactory;

package/dist/types/neural models/generalTypeDetectionYoloModel.d.ts

@@ -16,6 +16,7 @@ declare const modelConfig: {
     outputTensorName: string;
     predictLength: number;
     padding: number;
+    documentFramePadding: number;
 };
 export type InterpretYoloDetectionResult = {
     side: GeneralTypeExitYolo;

package/dist/types/types/context.d.ts

@@ -5,10 +5,12 @@ import MetaData from '../modules/MetaData';
 import { WebLibManualUploader } from '../modules/App/WebLibManualUploader';
 import LoggerController from '../controllers/LoggerController';
 import Step from '../modules/Step';
+import { AllLabels } from '../environment/langs';
 import { StepType } from '../environment/stepsDescription';
 import { Base64Image, Offset, Size } from '../helpers/image';
 import { RealFaceTurnSide } from './enums/realFace';
 import { StepConfig, StepMode } from '../defaultConfig';
+import { DeepPartial } from './helpers/DeepPartial';
 import { IMRZResults } from './mrz';
 type LoopFunction = () => Promise<false>;
 export type Context = {
@@ -29,6 +31,7 @@ export type Context = {
     config: Record<string, any>;
     networkUrl: string;
     imageFormat: 'webp' | 'jpeg';
+    customTranslations?: DeepPartial<AllLabels>;
     supabase: ReturnType<typeof InitClient> | null;
     cameraInfo: Record<string, any>;
     idvcLinkParam: string;

package/dist/types/types/helpers/DeepPartial.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Makes all properties of T optional, recursively.
+ */
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idscan/idvc2",
-  "version": "2.15.0",
+  "version": "3.1.0",
   "description": "component for the capturing documents",
   "main": "dist/idvc.js",
   "types": "dist/types/idvc.d.ts",
@@ -29,7 +29,6 @@
   "devDependencies": {
     "@swc/core": "1.3.59",
     "@types/animejs": "^3.1.12",
-    "@types/dot": "^1.1.5",
     "@types/pako": "^2.0.3",
     "@typescript-eslint/eslint-plugin": "5.59.6",
     "@typescript-eslint/parser": "5.59.6",
@@ -45,7 +44,6 @@
     "eslint-plugin-jest": "27.2.1",
     "eslint-plugin-node": "11.1.0",
     "eslint-webpack-plugin": "4.0.0",
-    "handlebars": "4.7.7",
     "html-loader": "4.1.0",
     "html-webpack-plugin": "5.5.1",
     "jest": "29.5.0",
@@ -72,7 +70,7 @@
     "core-js": "3.30.2",
     "crypto-browserify": "3.12.0",
     "detect-browser": "5.3.0",
-    "dot": "^1.1.3",
+    "lit-html": "^3.2.1",
     "mobile-detect": "1.4.5",
     "onnxruntime-web": "1.17.0",
     "pako": "^2.1.0",

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

@@ -1,21 +0,0 @@
-import { Component } from '../Component';
-import { DocumentTypeIndex, DocumentTypeName, HumanName } from '../../../environment/documentTypes';
-import { DocumentSelectEvent } from '../selectDocumentType/documentSelectedEvent';
-type DocumentState = {
-    name: DocumentTypeName;
-    humanName: HumanName;
-    id: 0 | DocumentTypeIndex;
-};
-export type InitScreenState = {
-    documents: DocumentState[];
-    isHidden: boolean;
-};
-export type InitScreenEvents = {
-    onDocumentClick?: (res: DocumentSelectEvent) => void;
-};
-export declare class InitScreen extends Component<InitScreenState> {
-    constructor(mountElement: any, state: InitScreenState, events?: InitScreenEvents);
-    protected addEventListeners(): void;
-    private addDocumentClickListener;
-}
-export {};

package/dist/types/modules/ui/Spinner/LoaderUI.d.ts

@@ -1,11 +0,0 @@
-import { Component } from '../Component';
-export type LoaderState = {
-    loading: boolean;
-    spinnerVisibility: boolean;
-    bottomText?: string;
-    topText?: string;
-};
-export declare class LoaderUI extends Component<LoaderState> {
-    constructor(mountElement: any, state: LoaderState, events?: any);
-    protected addEventListeners(): void;
-}