@idscan/idvc2 2.0.1

package/dist/js/environment/documentTypes.ts

@@ -0,0 +1,145 @@
+export type DocumentTypeIndex = 1 | 2 | 3 | 6 | 7 | 8 | 9;
+export type DocumentTypeName = 'ID' | 'Passport' | 'PassportCard' | 'GreenCard' | 'InternationalId' | 'VIN' | 'Barcode';
+export type HumanName = 'Driver\'s License or ID card' | 'Passport' | 'Passport Card' | 'Green Card or Employment Authorization' | 'International ID' | 'Vehicle Identification Number' | '1-D and 2-D Barcodes';
+export type ImageSource = 'video' | 'file';
+
+export interface DocumentRecord {
+  name: DocumentTypeName,
+  id: DocumentTypeIndex,
+  nName: string,
+  humanName: HumanName,
+}
+
+interface DocumentType {
+  readonly items: DocumentRecord[],
+  length: number,
+  ids(): DocumentTypeIndex[],
+  names(): DocumentTypeName[],
+  nameById(id: DocumentTypeIndex): DocumentTypeName | '',
+  humanNameById(id: DocumentTypeIndex | 0): HumanName | '',
+  humanNames(): HumanName[],
+  humanNameByName(name: DocumentTypeName): HumanName | '',
+  idByName(name: DocumentTypeName): DocumentTypeIndex | 0,
+  idsByNames(names: DocumentTypeName[]): (DocumentTypeIndex | 0)[],
+  recordById(id: DocumentTypeIndex | 0): DocumentRecord | null,
+  setHumanName(names): void,
+}
+
+const documentType: DocumentType = {
+  items: [
+    {
+      name: 'ID',
+      id: 1,
+      nName: '',
+      humanName: 'Driver\'s License or ID card',
+    },
+    {
+      name: 'Passport',
+      id: 2,
+      nName: 'passp',
+      humanName: 'Passport',
+    },
+    {
+      name: 'PassportCard',
+      id: 3,
+      nName: 'passpcard',
+      humanName: 'Passport Card',
+    },
+    {
+      name: 'GreenCard',
+      id: 6,
+      nName: 'gc',
+      humanName: 'Green Card or Employment Authorization',
+    },
+    {
+      name: 'InternationalId',
+      id: 7,
+      nName: 'iid',
+      humanName: 'International ID',
+    },
+    {
+      name: 'VIN',
+      id: 8,
+      nName: 'vin',
+      humanName: 'Vehicle Identification Number',
+    },
+    {
+      name: 'Barcode',
+      id: 9,
+      nName: 'barcode',
+      humanName: '1-D and 2-D Barcodes',
+    },
+  ],
+  get length() {
+    return this.items.length;
+  },
+  ids() {
+    return this.items.map((item) => item.id);
+  },
+  names() {
+    return this.items.map((item) => item.name);
+  },
+  nameById(id) {
+    const res = this.items.filter((item) => item.id === id);
+    return res.length ? res[0].name : '';
+  },
+  humanNameById(id) {
+    const res = this.items.filter((item) => item.id === id);
+    return res.length ? res[0].humanName : '';
+  },
+  humanNames() {
+    const names: HumanName[] = [];
+    this.items.forEach((item) => {
+      names[item.id] = item.humanName;
+    });
+    return names;
+  },
+  humanNameByName(name) {
+    const lowerName = name.toLowerCase();
+    const record = this.items.find((item) => item.name.toLowerCase() === lowerName);
+    if (record) {
+      return record.humanName;
+    }
+    return '';
+  },
+  setHumanName(names) {
+    Object.keys(names).forEach((key) => {
+      const record = this.items.find((item) => item.name === key);
+      record.humanName = names[key];
+    });
+  },
+  /**
+   * return object's id by its name
+   * @param {string} name
+   * @returns {Number} id of element by its name or 0 if name not found
+   */
+  idByName(name) {
+    const lowerName = name.toLowerCase();
+    if (this.items && this.items.length > 0) {
+      const item = this.items.find((record) => record?.name.toLowerCase() === lowerName);
+      return item?.id || 0;
+    }
+    return 0;
+  },
+  /**
+   * return ids by names
+   * @param {[string]} names
+   * @return {[Number]}
+   */
+  idsByNames(names) {
+    return names.map(this.idByName.bind(this));
+  },
+  /**
+   * return type item { name: String, id: Number, nName: String, humanName: String }
+   * @param {number} id
+   */
+  recordById(id) {
+    if (id === 0) return null;
+    for (let i = 0; i <= this.length; i += 1) {
+      if (this.items[i].id === id) return this.items[i];
+    }
+    return null;
+  },
+};
+
+export default documentType;

package/dist/js/environment/langs.ts

@@ -0,0 +1,270 @@
+type LabelGroup = 'errorCodes' | 'hintTexts' | 'keyErrors' | 'typeError'
+| 'camera' | 'general' | 'uploaderDescription' | 'documentsTypes';
+
+type AllTypes = IErrorCodes | IHintTexts | KeyError | ITypeError
+| ICameraLabels | IGeneral | IDocumentsTypes | IUploaderDescription;
+
+type Label = Record<LabelGroup, AllTypes>;
+type AllLabels = Record<SupportedLanguage, Label>;
+type KeyError = string[];
+type GetTranslation = {
+  (): Label,
+  (groupName: 'errorCodes'): IErrorCodes,
+  (groupName: 'hintTexts'): IHintTexts,
+  (groupName: 'keyErrors'): KeyError,
+  (groupName: 'typeError'): ITypeError,
+  (groupName: 'camera'): ICameraLabels,
+  (groupName: 'general'): IGeneral,
+  (groupName: LabelGroup): AllTypes,
+};
+export type ErrorCodeNames = keyof IErrorCodes;
+export type SupportedLanguage = typeof supportedLanguages[number];
+
+interface IErrorCodes {
+  mrz: string,
+  barcode: string,
+  heic: string,
+  fileType: string,
+  disableStepFileUpload: string,
+  notAllowedDocument: string,
+  frontSide: string,
+}
+
+interface IHintTexts {
+  front: string,
+  frontMRZ: string,
+  mrz: string,
+  capturing: string,
+  pdf: string,
+  back: string,
+  barcode: string,
+  hold: string,
+  dontSee: string,
+  dontMove: string,
+  turnFace: string,
+  turnFaceLR: string,
+  faceCam: string,
+  camAway: string,
+  moveCenter: string,
+  comeCloser: string,
+  holdCamera: string,
+}
+
+export interface ITypeError {
+  typeSelectHeader: string,
+  typeErrorHeader: string,
+  typeErrorBody: string,
+}
+
+interface ICameraLabels {
+  loading: string,
+  awaiting: string,
+}
+
+interface IGeneral {
+  documentType: string,
+  selectDocumentTypeText: string,
+  changeBtn: string,
+  correctBtn: string,
+  cancelBtn: string,
+  doneBtn: string,
+  closeBtn: string,
+  retakeBtn: string,
+  continueBtn: string,
+  submitBtn: string,
+  resetAllStepsBtn: string,
+  btnUploader: string,
+  btnCamera: string,
+  pressToUpdateText: string,
+  pressToUpdateTextSuccess: string
+}
+
+interface IDocumentsTypes {
+  ID: string,
+  Passport: string,
+  PassportCard: string,
+  GreenCard: string,
+  InternationalId: string
+}
+
+interface IUploaderDescription {
+  textFront: string,
+  textBack: string,
+  textFace: string,
+  textPdf: string,
+  textMrz: string,
+  textFrontBack: string,
+  textPass: string,
+  textFacePosition: string,
+}
+
+export type CameraLabels = keyof ICameraLabels;
+
+export const supportedLanguages = ['en', 'es'] as const;
+
+const labels: AllLabels = {
+  es: {
+    errorCodes: {
+      mrz: 'MRZ no fue reconocido',
+      barcode: 'Advertencia: <br/>No se pudieron leer los datos del código de barras.<br/>Intenta tomar una imagen de mayor calidad.',
+      heic: 'El archivo HEIC está dañado',
+      fileType: 'Error de tipo de archivo. Solo se admiten los tipos de archivo JPEG, PNG y HEIC.',
+      disableStepFileUpload: 'Se debe utilizar un dispositivo con una cámara para capturar esta imagen',
+      notAllowedDocument: 'Este tipo de documento no está permitido',
+      frontSide: 'Advertencia: <br/>No se pudo leer la parte frontal del documento. <br/>Intenta tomar una imagen de mayor calidad',
+    },
+    hintTexts: {
+      front: 'Coloque el anverso del documento',
+      frontMRZ: 'Haga zoom para capturar el código en la parte inferior',
+      mrz: 'Haga zoom para capturar el código en la parte posterior',
+      capturing: 'Coloque el anverso del documento',
+      pdf: 'Coloque el código de barras dentro del marco',
+      back: 'Da la vuelta a tu documento',
+      barcode: 'Coloque el código de barras dentro del marco',
+      hold: 'Sostener el **placeholder** lado del documento <br> dentro de la caja',
+      dontSee: 'No te veo',
+      dontMove: 'No te muevas',
+      turnFace: 'Gira la cara <br> a la izquierda o a la derecha (**data**)',
+      turnFaceLR: 'Gira la cara <br> a la izquierda o a la derecha',
+      faceCam: 'Enfréntate a la cámara',
+      camAway: 'Mover la cámara más lejos',
+      moveCenter: 'Mover al centro',
+      comeCloser: 'Acércate',
+      holdCamera: 'Manténgase firme, analizando el documento <br>',
+    },
+    keyErrors: ['La clave de licencia ha caducado', 'Clave de licencia no válida'],
+    typeError: {
+      typeSelectHeader: 'Tipo no definido. <br> Seleccione manualmente',
+      typeErrorHeader: 'Este tipo de documento no está permitido',
+      typeErrorBody: 'Solo se permiten los siguientes tipos de documentos:',
+    },
+    camera: {
+      loading: 'Carga',
+      awaiting: 'A la espera de la respuesta de la cámara',
+    },
+    general: {
+      documentType: 'Su Tipo de Documento es',
+      selectDocumentTypeText: 'Seleccionar Tipo de Documento',
+      changeBtn: 'Cambiar',
+      correctBtn: 'Corregir',
+      cancelBtn: 'Cancelar',
+      doneBtn: 'Hecho',
+      closeBtn: 'Cerrar',
+      retakeBtn: 'VOLVER',
+      continueBtn: 'CONTINUAR',
+      submitBtn: 'ENVIAR',
+      resetAllStepsBtn: 'Restablecer todos los pasos',
+      btnUploader: 'Cambiar a cargador manual',
+      btnCamera: 'Cambiar al modo de cámara',
+      pressToUpdateText: 'Pulse para actualizar',
+      pressToUpdateTextSuccess: 'Pulse para actualizar',
+    },
+    uploaderDescription: {
+      textFront: 'Haga clic aquí para cargar el frente de su identificación',
+      textBack: 'Haga clic aquí para cargar el reverso de una identificación',
+      textFace: 'Haga clic aquí para cargar una foto de su rostro',
+      textPdf: 'Haga clic aquí para cargar el reverso de una identificación',
+      textMrz: 'Haga clic aquí para cargar una foto de su documento\'',
+      textFrontBack: 'Asegúrese de que su identificación llene toda la pantalla de la cámara con poco o ningún fondo.',
+      textPass: 'Asegúrese de que su identificación llene toda la pantalla de la cámara <br> con poco o ningún fondo, y que se incluya el código MRZ completo',
+      textFacePosition: 'Coloque su rostro para ocupar toda la pantalla de la cámara con poco o ningún fondo.',
+    },
+    documentsTypes: {
+      ID: 'Licencia de Conducir',
+      Passport: 'Pasaporte',
+      PassportCard: 'Tarjeta de Pasaporte',
+      GreenCard: 'Tarjeta Verde o Autorización de Empleo',
+      InternationalId: 'Identificación Internacional',
+    },
+  },
+  en: {
+    errorCodes: {
+      mrz: 'MRZ not recognized',
+      barcode: 'Warning: <br/>Barcode data could not be read.<br/>Try taking a higher quality image.',
+      heic: 'HEIC file incorrupted',
+      fileType: 'Error file type. Only jpeg, png and heic supported.',
+      disableStepFileUpload: 'A device with a camera must be used to capture this image',
+      notAllowedDocument: 'This document type is not allowed',
+      frontSide: 'Warning: <br/>Front of the document could not be read. <br/>Try taking a higher quality image',
+    },
+    hintTexts: {
+      front: 'Position the front of the document',
+      frontMRZ: 'Zoom in to capture code at bottom',
+      mrz: 'Zoom in to capture code on back side',
+      capturing: 'Position the front of the document',
+      pdf: 'Position the barcode inside the frame',
+      back: 'Turn around your document',
+      barcode: 'Position the barcode inside the frame',
+      hold: 'Hold the **placeholder** side of the document <br> inside the box',
+      dontSee: 'I don\'t see you',
+      dontMove: 'Don\'t move',
+      turnFace: 'Turn your face <br> left or right (**data**)',
+      turnFaceLR: 'Turn your face <br> left or right',
+      faceCam: 'Face the camera',
+      camAway: 'Move camera further away',
+      moveCenter: 'Move to the center',
+      comeCloser: 'Come closer',
+      holdCamera: 'Hold steady, analyzing document <br>',
+    },
+    keyErrors: ['License Key has expired', 'Invalid license key'],
+    typeError: {
+      typeSelectHeader: 'Type not defined. <br> Please select manually',
+      typeErrorHeader: 'This document type is not allowed',
+      typeErrorBody: 'Only the following document types are allowed:',
+    },
+    camera: {
+      loading: 'Loading',
+      awaiting: 'Awaiting camera response',
+    },
+    general: {
+      documentType: 'Your document type is',
+      selectDocumentTypeText: 'Select Document Type',
+      changeBtn: 'Change',
+      correctBtn: 'Correct',
+      cancelBtn: 'Cancel',
+      doneBtn: 'Done',
+      closeBtn: 'CLOSE',
+      retakeBtn: 'Retake',
+      continueBtn: 'CONTINUE',
+      submitBtn: 'SUBMIT',
+      resetAllStepsBtn: 'Reset all steps',
+      btnUploader: 'Switch to manual uploader',
+      btnCamera: 'Switch to camera mode',
+      pressToUpdateText: 'Press to update',
+      pressToUpdateTextSuccess: 'Press to update',
+    },
+    documentsTypes: {
+      ID: "Driver\'s License",
+      Passport: 'Passport',
+      PassportCard: 'Passport Card',
+      GreenCard: 'Green Card or Employment Authorization',
+      InternationalId: 'International ID',
+    },
+    uploaderDescription: {
+      textFront: 'Click here to upload the front of your ID',
+      textBack: 'Click here to upload the back of your ID',
+      textFace: 'Click here to upload a photo of your face',
+      textPdf: 'Click here to upload the back of a ID',
+      textMrz: 'Click here to upload a photo of your document',
+      textFrontBack: 'Please make sure your ID fills up the entire <br> camera screen with little to no background.',
+      textPass: 'Please make sure your ID fills up the entire camera screen <br> with little to no background, and the full MRZ code is included.',
+      textFacePosition: 'Please position your face to take up <br> the full camera screen with little to no background.',
+    },
+  },
+};
+
+let translation:Label = labels.en;
+
+export const setTranslation = (translationLang?: SupportedLanguage): void => {
+  if (translationLang) {
+    const lang = translationLang.toLowerCase();
+    const trnaslation = Object.keys(labels).includes(lang) ? lang as SupportedLanguage : 'en';
+    translation = labels[trnaslation];
+  } else {
+    translation = labels.en;
+  }
+};
+
+export const getTranslation: GetTranslation = (groupName?) => (groupName
+  ? translation[groupName]
+  : translation);

package/dist/js/environment/loadModes.json

@@ -0,0 +1,11 @@
+{
+  "cdn": {
+    "description": "Take loaders from cdn. No additional webpack config."
+  },
+  "asyncLocal": {
+    "description": "Take local loaders. Required additional webpack config."
+  },
+  "syncLocal": {
+    "description": "Loads all required modules synchronous. No additional webpack config."
+  }
+}

package/dist/js/environment/loopResult.ts

@@ -0,0 +1,14 @@
+export interface ILoopResult {
+  status: boolean,
+  cancel: boolean,
+  touch: boolean,
+  image: ImageData | null,
+}
+
+const defaultLoopResult: ILoopResult = {
+  status: false,
+  cancel: false,
+  touch: false,
+  image: null,
+};
+export default defaultLoopResult;

package/dist/js/environment/networkNames.json

@@ -0,0 +1,27 @@
+{
+  "neurons": {
+    "angles": "angles20210831.json",
+    "blazeface": "blazeface20210831.json",
+    "facemesh": "facemesh20210831.json",
+    "mrz": "mrz20210831.json",
+    "types": "types20220505.json"
+  },
+  "modules": {
+    "IMGPROCModule": "IMGPROCModule20220324.js",
+    "MRZModule": "MRZModule20220324.js",
+    "docDetectorModule": "docDetectorModule20220324.js",
+    "PDF417MODULE": "PDF417MODULE20220324.js",
+    "SimpleFaceModule": "SimpleFaceModule20220324.js",
+    "BlazeFaceModule": "BlazeFaceModule20220324.js",
+    "MeshFaceModule": "MeshFaceModule20220324.js",
+    "BarcodeModule": "BarcodeModule20220324.js",
+    "PICO": "PICO20220324.js",
+    "PDF417": "PDF41720220324.js",
+    "PDF417PARSER": "PDF417PARSER20220324.js",
+    "MRZCore": "MRZCore20220324.js",
+    "IMGPROCCore": "IMGPROCCore20220324.js",
+    "ZXingReader": "ZXingReader20220324.js",
+    "TFBlazeFace": "blazeface.js",
+    "FaceLandmarksDetector": "face-landmarks-detection.js"
+  }
+}

package/dist/js/environment/realFaceModes.ts

@@ -0,0 +1,15 @@
+export type RealFaceMode = keyof typeof realFaceModes;
+
+const realFaceModes = {
+  auto: {
+    description: 'enable "realFaceMode" only for iphone.',
+  },
+  none: {
+    description: 'disable this option.',
+  },
+  all: {
+    description: 'enable "realFaceMode" for all devices.',
+  },
+} as const;
+
+export default realFaceModes;

package/dist/js/environment/stepsDescription.ts

@@ -0,0 +1,85 @@
+export type StepType = 'auto' | 'mrz' | 'front' | 'pdf' | 'back' | 'face' | 'barcode' | 'photo';
+
+export default {
+  auto: {
+    id: 0,
+    camera: 'environment',
+    name: 'Front Scan',
+    time: 5,
+    max: 0.15,
+    core: [
+      'imgProc', 'tf', 'mrz',
+    ],
+    description: 'capture of a document with the following analysis of the document type. In case if a document requires the back side, the step for the back side of a document will be added automatically. Use the step 'front' if you use the component for the document validation.',
+  },
+  mrz: {
+    id: 1,
+    camera: 'environment',
+    name: 'MRZ',
+    time: 5,
+    core: [
+      'mrz',
+    ],
+    description: 'detection, capture and parsing of the mrz-code of a document.',
+  },
+  front: {
+    id: 2,
+    camera: 'environment',
+    name: 'Front Scan',
+    time: 5,
+    max: 0.15,
+    core: [
+      'imgProc', 'mrz', 'tf',
+    ],
+    description: 'capture front of a document without analysis.',
+  },
+  pdf: {
+    id: 3,
+    camera: 'environment',
+    name: 'PDF',
+    time: 5,
+    core: [
+      'pdf',
+    ],
+    description: 'detection and capture of pdf417 of a document.',
+  },
+  back: {
+    id: 4,
+    camera: 'environment',
+    name: 'Back Scan',
+    time: 5,
+    core: [
+      'mrz', 'pdf',
+    ],
+    description: '',
+  },
+  face: {
+    id: 5,
+    camera: 'user',
+    name: 'Face',
+    time: 10,
+    max: 0.33,
+    core: [
+      'imgProc', 'face',
+    ],
+    description: 'detection and capture of a face using the front camera.',
+  },
+  barcode: {
+    id: 6,
+    camera: 'environment',
+    name: 'Barcode',
+    time: 5,
+    core: [
+      'barcode',
+    ],
+    description: 'detection, capture and parsing 1 dimensional (barcodes) or 2 dimensional (qr codes).',
+  },
+  photo: {
+    id: 7,
+    camera: 'environment',
+    name: 'Photo',
+    time: 5,
+    core: [],
+    description: 'Take a photo.',
+  },
+};