@idscan/idvc2 2.2.2 → 2.2.3

package/dist/js/defaultConfig.ts

@@ -1,254 +1,254 @@
-import realFaceModes, { RealFaceMode } from './environment/realFaceModes';
-import { DocumentTypeName } from './environment/documentTypes';
-import { StepType } from './environment/stepsDescription';
-
-export type ValidationFn = 'validateElement' | 'validateString' | 'validateDocumentTypes' | 'validateDistinctStringInArray' | 'validateNumber' | 'validateFunction' | 'validateBool' | 'validateLanguage';
-type DefaultValueFunction = () => boolean;
-
-/**
- * { boolean? } uploader
- * { boolean? } video
- */
-export interface IStepMode {
-  uploader?: boolean,
-  video?: boolean,
-}
-export type IStepModeKeys = keyof IStepMode;
-export interface IStepConfig {
-  type: StepType,
-  name: string,
-  mode: IStepMode,
-}
-
-export interface IDocumentType {
-  type: DocumentTypeName,
-  steps: IStepConfig[],
-  mode?: IStepMode,
-}
-
-/**
- * IDefaultConfig
- * @param {string} name,
- * @param {'String' | 'Array' | 'Number' | 'Boolean' | 'Function' | 'Object'}  type,
- * @param {string} description,
- * @param {string | boolean | DefaultValueFunction | number | IDocumentType[]} defaultValue,
- * @param {ValidationFn}  validationFn,
- * @parma {boolean} hidden?,
- * @param {RealFaceMode[]} values?,
- * @param {any[]} arrayValues,
- * @param {boolean} multiple?,
- */
-export interface IDefaultConfig {
-  name: string,
-  type: 'String' | 'Array' | 'Number' | 'Boolean' | 'Function' | 'Object',
-  description: string,
-  defaultValue: IStepMode | string | boolean | DefaultValueFunction | number | IDocumentType[],
-  validationFn: ValidationFn,
-  hidden?: boolean,
-  values?: RealFaceMode[],
-  arrayValues?: any[],
-  multiple?: boolean,
-}
-
-/**
- * @param {String} name - config param name
- * @param {any} defaultValue - value to fallback
- * @param {String} validationFn - name of validation function from Config module
- */
-const defaultConfig: IDefaultConfig[] = [
-  {
-    name: 'el',
-    type: 'String',
-    description: 'Id of an element on the page where the component will be integrated.',
-    defaultValue: 'videoCapturingEl',
-    validationFn: 'validateElement',
-  },
-  {
-    name: 'licenseKey',
-    type: 'String',
-    description: 'Key for the library',
-    defaultValue: '',
-    validationFn: 'validateString',
-  },
-  {
-    name: 'networkUrl',
-    type: 'String',
-    description: 'Path to the folder with neural networks. Specify the path on the server if you need to remove the folder to another location. The default path is \'networks\'.',
-    defaultValue: 'networks',
-    validationFn: 'validateString',
-  },
-  {
-    name: 'language',
-    type: 'String',
-    description: 'The option sets the language used for the translation of the text in the library',
-    defaultValue: undefined,
-    validationFn: 'validateLanguage',
-  },
-  {
-    name: 'documentTypes',
-    type: 'Array',
-    description: 'The option that describes what steps needs for each document type you are needed',
-    defaultValue: [{
-      type: 'ID',
-      steps: [
-        {
-          type: 'front', name: 'Document Front', mode: { uploader: true, video: true },
-        },
-        {
-          type: 'pdf', name: 'Document PDF417 Barcode', mode: { uploader: true, video: true },
-        },
-        {
-          type: 'face', name: 'Face', mode: { uploader: true, video: true },
-        },
-      ],
-    }],
-    validationFn: 'validateDocumentTypes',
-  },
-  {
-    name: 'realFaceMode',
-    values: ['auto', 'none', 'all'],
-    type: 'Array',
-    description: 'Option that enable advanced capture with volumetric face detection. Available values: \'auto\', \'none\'. Auto - enable "realFaceMode" only for iphone. All - enable "realFaceMode" for all devices. None - disable this option.',
-    defaultValue: 'auto',
-    validationFn: 'validateDistinctStringInArray',
-    arrayValues: Object.keys(realFaceModes),
-    multiple: false,
-  },
-  {
-    name: 'resizeUploadedImage',
-    type: 'Number',
-    description: 'Sets the maximum size for manually loaded pictures.',
-    defaultValue: -1,
-    validationFn: 'validateNumber',
-  },
-  {
-    name: 'h_showSubmitBtn',
-    type: 'Boolean',
-    description: 'This option enables/disables the "submit" button after capturing all the images',
-    defaultValue: true,
-    hidden: true,
-    validationFn: 'validateBool',
-  },
-  {
-    name: 'h_stepMode',
-    type: 'Object',
-    description: 'Default value for step mode (video/uploader)',
-    defaultValue: { uploader: true, video: true },
-    hidden: true,
-    validationFn: null,
-  },
-  {
-    name: 'isShowDocumentTypeSelect',
-    type: 'Boolean',
-    description: 'If only one document type is in the config and this option is disabled, the library starts immediately.',
-    defaultValue: true,
-    validationFn: 'validateBool',
-  },
-  {
-    name: 'useCDN',
-    type: 'Boolean',
-    description: 'Set to true if you prefer to load neural networks from cdn instead of your domain.',
-    defaultValue: false,
-    validationFn: 'validateBool',
-  },
-  {
-    name: 'useHeic',
-    type: 'Boolean',
-    description: 'This option switches on/off the HEIC images processing (HEIC is Apple’s proprietary version of the Image File format). It’s possible to upload only via a Mac/MacBook.',
-    defaultValue: false,
-    validationFn: 'validateBool',
-  },
-  {
-    name: 'autoContinue',
-    type: 'Boolean',
-    description: 'This option switches on/off the automatic transition to the next step.',
-    defaultValue: true,
-    validationFn: 'validateBool',
-  },
-  {
-    name: 'isShowGuidelinesButton',
-    type: 'Boolean',
-    description: 'Switches on the button show guidLines',
-    defaultValue: false,
-    validationFn: 'validateBool',
-  },
-  {
-    name: 'fixFrontOrientAfterUpload',
-    type: 'Boolean',
-    description: 'This option provides the possibility to adjust the correct position of the document in case of manual uploading.',
-    defaultValue: false,
-    validationFn: 'validateBool',
-  },
-  {
-    name: 'isSubmitMetaData',
-    type: 'Boolean',
-    description: '',
-    defaultValue: true,
-    validationFn: 'validateBool',
-  },
-  {
-    name: 'onChange',
-    type: 'Function',
-    description: 'Callback-function which will be called after change one step. The returnable value is the object with the type and the image',
-    defaultValue() {
-      return true;
-    },
-    validationFn: 'validateFunction',
-  },
-  {
-    name: 'clickGuidlines',
-    type: 'Function',
-    description: 'Callback-function which will be called after guidLines button.',
-    defaultValue() {
-      return true;
-    },
-    validationFn: 'validateFunction',
-  },
-  {
-    name: 'onReset',
-    type: 'Function',
-    description: 'Callback-function which will be called after reset all the steps. The returnable value is the object with the steps',
-    defaultValue() {
-      return true;
-    },
-    validationFn: 'validateFunction',
-  },
-  {
-    name: 'submit',
-    type: 'Function',
-    description: 'Callback-function which will be called after completing all the steps.',
-    defaultValue() {
-      return true;
-    },
-    validationFn: 'validateFunction',
-  },
-  {
-    name: 'onRetakeHook',
-    type: 'Function',
-    description: 'The function that will be called before reset the current step. The returnable value is the object with the current step',
-    defaultValue() {
-      return true;
-    },
-    validationFn: 'validateFunction',
-  },
-  {
-    name: 'onCameraError',
-    type: 'Function',
-    description: 'The function that is invoked in case if the camera is not available. The response value is the object with the error code and the message',
-    defaultValue() {
-      return true;
-    },
-    validationFn: 'validateFunction',
-  },
-  {
-    name: 'onMounted',
-    type: 'Function',
-    description: 'the function that will be called on the component mounted. This function doesn\'t return a value.',
-    defaultValue() {
-      return true;
-    },
-    validationFn: 'validateFunction',
-  },
-];
-
-export default defaultConfig;
+import realFaceModes, { RealFaceMode } from './environment/realFaceModes';
+import { DocumentTypeName } from './environment/documentTypes';
+import { StepType } from './environment/stepsDescription';
+
+export type ValidationFn = 'validateElement' | 'validateString' | 'validateDocumentTypes' | 'validateDistinctStringInArray' | 'validateNumber' | 'validateFunction' | 'validateBool' | 'validateLanguage';
+type DefaultValueFunction = () => boolean;
+
+/**
+ * { boolean? } uploader
+ * { boolean? } video
+ */
+export interface IStepMode {
+  uploader?: boolean,
+  video?: boolean,
+}
+export type IStepModeKeys = keyof IStepMode;
+export interface IStepConfig {
+  type: StepType,
+  name: string,
+  mode: IStepMode,
+}
+
+export interface IDocumentType {
+  type: DocumentTypeName,
+  steps: IStepConfig[],
+  mode?: IStepMode,
+}
+
+/**
+ * IDefaultConfig
+ * @param {string} name,
+ * @param {'String' | 'Array' | 'Number' | 'Boolean' | 'Function' | 'Object'}  type,
+ * @param {string} description,
+ * @param {string | boolean | DefaultValueFunction | number | IDocumentType[]} defaultValue,
+ * @param {ValidationFn}  validationFn,
+ * @parma {boolean} hidden?,
+ * @param {RealFaceMode[]} values?,
+ * @param {any[]} arrayValues,
+ * @param {boolean} multiple?,
+ */
+export interface IDefaultConfig {
+  name: string,
+  type: 'String' | 'Array' | 'Number' | 'Boolean' | 'Function' | 'Object',
+  description: string,
+  defaultValue: IStepMode | string | boolean | DefaultValueFunction | number | IDocumentType[],
+  validationFn: ValidationFn,
+  hidden?: boolean,
+  values?: RealFaceMode[],
+  arrayValues?: any[],
+  multiple?: boolean,
+}
+
+/**
+ * @param {String} name - config param name
+ * @param {any} defaultValue - value to fallback
+ * @param {String} validationFn - name of validation function from Config module
+ */
+const defaultConfig: IDefaultConfig[] = [
+  {
+    name: 'el',
+    type: 'String',
+    description: 'Id of an element on the page where the component will be integrated.',
+    defaultValue: 'videoCapturingEl',
+    validationFn: 'validateElement',
+  },
+  {
+    name: 'licenseKey',
+    type: 'String',
+    description: 'Key for the library',
+    defaultValue: '',
+    validationFn: 'validateString',
+  },
+  {
+    name: 'networkUrl',
+    type: 'String',
+    description: 'Path to the folder with neural networks. Specify the path on the server if you need to remove the folder to another location. The default path is \'networks\'.',
+    defaultValue: 'networks',
+    validationFn: 'validateString',
+  },
+  {
+    name: 'language',
+    type: 'String',
+    description: 'The option sets the language used for the translation of the text in the library',
+    defaultValue: undefined,
+    validationFn: 'validateLanguage',
+  },
+  {
+    name: 'documentTypes',
+    type: 'Array',
+    description: 'The option that describes what steps needs for each document type you are needed',
+    defaultValue: [{
+      type: 'ID',
+      steps: [
+        {
+          type: 'front', name: 'Document Front', mode: { uploader: true, video: true },
+        },
+        {
+          type: 'pdf', name: 'Document PDF417 Barcode', mode: { uploader: true, video: true },
+        },
+        {
+          type: 'face', name: 'Face', mode: { uploader: true, video: true },
+        },
+      ],
+    }],
+    validationFn: 'validateDocumentTypes',
+  },
+  {
+    name: 'realFaceMode',
+    values: ['auto', 'none', 'all'],
+    type: 'Array',
+    description: 'Option that enable advanced capture with volumetric face detection. Available values: \'auto\', \'none\'. Auto - enable "realFaceMode" only for iphone. All - enable "realFaceMode" for all devices. None - disable this option.',
+    defaultValue: 'auto',
+    validationFn: 'validateDistinctStringInArray',
+    arrayValues: Object.keys(realFaceModes),
+    multiple: false,
+  },
+  {
+    name: 'resizeUploadedImage',
+    type: 'Number',
+    description: 'Sets the maximum size for manually loaded pictures.',
+    defaultValue: -1,
+    validationFn: 'validateNumber',
+  },
+  {
+    name: 'h_showSubmitBtn',
+    type: 'Boolean',
+    description: 'This option enables/disables the "submit" button after capturing all the images',
+    defaultValue: true,
+    hidden: true,
+    validationFn: 'validateBool',
+  },
+  {
+    name: 'h_stepMode',
+    type: 'Object',
+    description: 'Default value for step mode (video/uploader)',
+    defaultValue: { uploader: true, video: true },
+    hidden: true,
+    validationFn: null,
+  },
+  {
+    name: 'isShowDocumentTypeSelect',
+    type: 'Boolean',
+    description: 'If only one document type is in the config and this option is disabled, the library starts immediately.',
+    defaultValue: true,
+    validationFn: 'validateBool',
+  },
+  {
+    name: 'useCDN',
+    type: 'Boolean',
+    description: 'Set to true if you prefer to load neural networks from cdn instead of your domain.',
+    defaultValue: false,
+    validationFn: 'validateBool',
+  },
+  {
+    name: 'useHeic',
+    type: 'Boolean',
+    description: 'This option switches on/off the HEIC images processing (HEIC is Apple’s proprietary version of the Image File format). It’s possible to upload only via a Mac/MacBook.',
+    defaultValue: false,
+    validationFn: 'validateBool',
+  },
+  {
+    name: 'autoContinue',
+    type: 'Boolean',
+    description: 'This option switches on/off the automatic transition to the next step.',
+    defaultValue: true,
+    validationFn: 'validateBool',
+  },
+  {
+    name: 'isShowGuidelinesButton',
+    type: 'Boolean',
+    description: 'Switches on the button show guidLines',
+    defaultValue: false,
+    validationFn: 'validateBool',
+  },
+  {
+    name: 'fixFrontOrientAfterUpload',
+    type: 'Boolean',
+    description: 'This option provides the possibility to adjust the correct position of the document in case of manual uploading.',
+    defaultValue: false,
+    validationFn: 'validateBool',
+  },
+  {
+    name: 'isSubmitMetaData',
+    type: 'Boolean',
+    description: '',
+    defaultValue: true,
+    validationFn: 'validateBool',
+  },
+  {
+    name: 'onChange',
+    type: 'Function',
+    description: 'Callback-function which will be called after change one step. The returnable value is the object with the type and the image',
+    defaultValue() {
+      return true;
+    },
+    validationFn: 'validateFunction',
+  },
+  {
+    name: 'clickGuidlines',
+    type: 'Function',
+    description: 'Callback-function which will be called after guidLines button.',
+    defaultValue() {
+      return true;
+    },
+    validationFn: 'validateFunction',
+  },
+  {
+    name: 'onReset',
+    type: 'Function',
+    description: 'Callback-function which will be called after reset all the steps. The returnable value is the object with the steps',
+    defaultValue() {
+      return true;
+    },
+    validationFn: 'validateFunction',
+  },
+  {
+    name: 'submit',
+    type: 'Function',
+    description: 'Callback-function which will be called after completing all the steps.',
+    defaultValue() {
+      return true;
+    },
+    validationFn: 'validateFunction',
+  },
+  {
+    name: 'onRetakeHook',
+    type: 'Function',
+    description: 'The function that will be called before reset the current step. The returnable value is the object with the current step',
+    defaultValue() {
+      return true;
+    },
+    validationFn: 'validateFunction',
+  },
+  {
+    name: 'onCameraError',
+    type: 'Function',
+    description: 'The function that is invoked in case if the camera is not available. The response value is the object with the error code and the message',
+    defaultValue() {
+      return true;
+    },
+    validationFn: 'validateFunction',
+  },
+  {
+    name: 'onMounted',
+    type: 'Function',
+    description: 'the function that will be called on the component mounted. This function doesn\'t return a value.',
+    defaultValue() {
+      return true;
+    },
+    validationFn: 'validateFunction',
+  },
+];
+
+export default defaultConfig;

package/dist/js/environment/capturingModes.json

@@ -1,4 +1,4 @@
-{
-  "0": "processImage4",
-  "1": "processImage5"
-}
+{
+  "0": "processImage4",
+  "1": "processImage5"
+}