@idscan/idvc2 3.8.0 → 3.9.0

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

@@ -0,0 +1,6 @@
+export type Base64 = string;
+export type Base64DataUrl = string;
+export declare const base64ToUint8Array: (base64: string) => Uint8Array;
+export declare const isBase64DataUrl: (value: string) => value is string;
+export declare const extractBase64: (input?: string | null) => Base64;
+export declare const blobToBase64DataUrl: (blob: Blob) => Promise<Base64DataUrl>;

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

@@ -1,6 +1,5 @@
 import { ICrop } from './ts/common';
 import { Bbox } from '../types/geometry';
-export type Base64Image = string;
 export type RGBAColor = string;
 export type RGBColor8 = Uint8ClampedArray;
 export type RGBColor32 = Float32Array;

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

@@ -1,8 +1,3 @@
-import { Base64Image } from './image';
-export declare const encodeMeta: (metadata: any) => string;
-export declare const decodeMeta: (str: string) => any;
-export declare const base64ToArrayBuffer: (base64: string) => Uint8Array;
-export declare const getDataFromBase64Img: (imgString: Base64Image) => string;
 export declare const splitWordByUpperLetters: (word: string) => string[];
 export declare const normalizeCamelCase: (word: string) => string;
 export declare const removeHtmlEntities: (str: string) => string;

package/dist/types/idvc.d.ts

@@ -1,6 +1,8 @@
 import { IConfig } from './modules/Config';
 import type { SupportedLanguage } from './environment/langs';
 import type { IDocumentTypeConfig } from './modules/validator';
+export { prepareRequestDataForDiveApi, } from './integrations/prepareRequestDataForDiveApi';
+export type { IPrepareRequestDataForDiveApiParams } from './integrations/prepareRequestDataForDiveApi';
 export default class VideoCapturing {
     constructor(config: IConfig);
     get version(): string;

package/dist/types/integrations/prepareRequestDataForDiveApi.d.ts

@@ -0,0 +1,59 @@
+import { IDataForSubmit } from '../util';
+import { Base64 } from '../helpers/base64';
+import { DocumentTypeIndex } from '../environment/documentTypes';
+interface IRequestBase {
+    frontImageBase64: Base64;
+    backOrSecondImageBase64: Base64;
+    faceImageBase64: Base64;
+    ssn: string;
+    frontMultiImagesBase64: Base64;
+    faceMultiImagesBase64: Base64;
+    documentType: DocumentTypeIndex | 0;
+}
+interface IRequestV3 extends IRequestBase {
+    trackString: string;
+    verifyFace: boolean;
+    captureMethod: string;
+    userAgent: string;
+    frontEndMetadata: string;
+    metadata?: string;
+}
+interface IRequestV4 extends IRequestBase {
+    trackString: {
+        data: string;
+        barcodeParams: string;
+    };
+    metadata: {
+        captureMethod: string;
+        userAgent: string;
+        frontEndMetadata: string;
+        otherMetadata?: string;
+    };
+}
+export interface IPrepareRequestDataForDiveApiParams<P = Record<string, unknown>> {
+    data?: IDataForSubmit;
+    payload?: P;
+    versionAPI?: '3' | '3.1' | '4';
+}
+type IRequestPayload = Record<string, unknown>;
+/**
+ * Prepares request payload for Dive API (v3 / v3.1 / v4) based on submitted capture data.
+ *
+ * Builds a normalized request object:
+ * - extracts base64 images (front, back/second, face)
+ * - prepares multi-capture images if available
+ * - parses metadata
+ * - adjusts payload structure depending on API version
+ *
+ * @template P - Additional custom payload fields to be merged into the request
+ *
+ * @param params - Parameters object
+ * @param params.data - Raw data collected from the results of the IDVC capture flow
+ * @param params.payload - Optional custom fields to extend the request payload
+ * @param params.versionAPI - Target Dive API version (`'3' | '3.1' | '4'`)
+ *
+ * @returns Promise resolving to a prepared Dive API request object
+ * compatible with the specified API version and extended with custom payload fields
+ */
+export declare const prepareRequestDataForDiveApi: <P extends IRequestPayload>({ data, versionAPI, payload, }: IPrepareRequestDataForDiveApiParams<P>) => Promise<(IRequestV3 | IRequestV4) & P>;
+export {};

package/dist/types/manualUpload.d.ts

@@ -1,6 +1,6 @@
-import { Base64Image } from './helpers/image';
+import { Base64 } from './helpers/base64';
 type Base64Object = {
-    data: ImageData | Base64Image | null;
+    data: ImageData | Base64 | null;
     err: boolean;
 };
 declare const dropFile: (base64Obj: Base64Object) => Promise<void>;

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

@@ -1,8 +1,8 @@
-import { Base64Image } from '../helpers/image';
 import { StepType, StepTypeImageName } from '../environment/stepsDescription';
 import { StepMode } from '../defaultConfig';
 import { ErrorCodes } from '../environment/langs';
 import { DocumentTypeName } from '../environment/documentTypes';
+import { Base64 } from '../helpers/base64';
 export interface IStepConfigMode {
     name: 'mode';
     value: StepMode;
@@ -14,7 +14,7 @@ export interface IStepObj {
     name: string;
     type: StepType;
     camera: VideoFacingModeEnum;
-    img: Base64Image | null;
+    img: Base64 | null;
     err?: string | null;
     text?: string;
     time?: number;
@@ -25,7 +25,7 @@ export interface IStepObj {
 }
 export interface IStepCallback {
     /** base64 encoded step image */
-    img: Base64Image | null;
+    img: Base64 | null;
     /** blob step image */
     blob: Blob | null;
     /** blob step MultiImages */
@@ -43,7 +43,7 @@ export interface IStepCallback {
     /** mrz recognized text */
     mrzText?: string;
     /** cropped base64 encoded mrz image */
-    mrzImg?: Base64Image | null;
+    mrzImg?: Base64 | null;
     /** cropped blob mrz image */
     mrzBlob?: Blob | null;
     /** recognized text */
@@ -54,7 +54,7 @@ export default class Step implements IStepCallback, IStepObj {
     multiImagesBlob: Blob | null;
     errorCode: ErrorCodes | null | undefined;
     mrzText?: string;
-    mrzImg?: Base64Image | null;
+    mrzImg?: Base64 | null;
     mrzBlob?: Blob | null;
     trackString?: string;
     err?: string | null;
@@ -65,7 +65,7 @@ export default class Step implements IStepCallback, IStepObj {
     name: string;
     type: StepType;
     camera: VideoFacingModeEnum;
-    img: Base64Image | null;
+    img: Base64 | null;
     cameraInfo: Record<string, any>;
     stepTypeImageName: StepTypeImageName;
     shouldRecordMultiImages: boolean;

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

@@ -1,5 +1,5 @@
-import type { Base64Image } from '../helpers/image';
 import type { ErrorCodeNames } from '../environment/langs';
+import { Base64 } from '../helpers/base64';
 type ProcessingErrorCode = ErrorCodeNames | '';
 type Coordinate = {
     x: number;
@@ -22,9 +22,9 @@ export declare const pdfProcess: (smallImage: any, { perimeter }: {
 }) => Promise<boolean>;
 /**
  *
- * @param {Base64Image} data - base64 image
+ * @param {Base64} data - base64 image
  */
-export declare const barCodeProcess: (data: Base64Image) => Promise<boolean>;
+export declare const barCodeProcess: (data: Base64) => Promise<boolean>;
 export declare const frontProcess: ({ side, perimeter, isHasFace }: {
     side: any;
     perimeter: any;

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

@@ -7,7 +7,8 @@ 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 { Base64 } from '../helpers/base64';
+import { Offset, Size } from '../helpers/image';
 import { RealFaceTurnSide } from './enums/realFace';
 import { StepConfig, StepMode } from '../defaultConfig';
 import { DeepPartial } from './helpers/DeepPartial';
@@ -45,7 +46,7 @@ export type Context = {
     steps: Step[];
     currentStepType: StepType;
     currentStepCamera: VideoFacingModeEnum;
-    currentStepImg: Base64Image | null;
+    currentStepImg: Base64 | null;
     currentStepBlob: Blob | null;
     curStep: number;
     currentStep: number;

package/dist/types/util.d.ts

@@ -1,4 +1,4 @@
-import { Base64Image } from './helpers/image';
+import { Base64 } from './helpers/base64';
 import { IStepCallback } from './modules/Step';
 import { DocumentTypeIndex, DocumentTypeName } from './environment/documentTypes';
 import { Context } from './types/context';
@@ -22,5 +22,5 @@ export declare const filterWithForbiddenKeysValues: (obj: any, forbiddenKeys: an
 export declare const prepareCameraErr: (err: IError) => IError;
 export declare const formDataForSubmit: (steps: IStepCallback[], c: Context, payload?: {}) => IDataForSubmit;
 export declare const imageToImageData: (img: HTMLImageElement) => ImageData;
-export declare const base64ToImageData: (base64: Base64Image) => Promise<ImageData>;
+export declare const base64ToImageData: (base64: Base64) => Promise<ImageData>;
 export {};

package/package.json

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