@finos_sdk/sdk-ekyc 1.3.1 → 1.3.3

package/src/modules/FinosESignModule.ts

@@ -1,7 +1,7 @@
 import { Platform } from 'react-native';
 import sdkEKYC, { SDKeKYC, SDK_VERSION, SDK_NAME } from '../../EKYCModule';
 import { SmsOtpConfig, SmsOtpResult, SmsOtpError } from '../types/ekycSmsOtpType';
-import { UserEsignModel, ESignInitResult, ESignOpenSessionResult, ESignCertificate, ESignSignRequest, ESignError, ESignAuthenticateResult } from '../types/ekycESignType';
+import { ESignInitResult, ESignOpenSessionResult, ESignCertificate, ESignSignRequest, ESignError, ESignAuthenticateResult } from '../types/ekycESignType';
 import { LivenessConfig } from '../types/ekycLivenessType';
 import { FaceServiceConfig } from '../types/ekycFaceType';
 import { SDKEkycResultStringWithEvent, SDKEkycResultWithEvent } from '../types/ekycType';
@@ -197,32 +197,30 @@ export class FinosESignModule {
         return await this.sdk.getSdkToken(identity, name, deviceId);
     }
 
+
     /**
-     * Open eSign session
-     * @param accessToken JWT access token (optional if using userEsignModel)
-     * @param username Optional username
-     * @param rememberMe Remember session
-     * @param userEsignModel User info for auto token creation (optional if using accessToken)
-     * @param privateKeyFilePath Path to private key file in assets (required if using userEsignModel)
+     * Open eSign Session
+     * @param accessToken Access token (JWT)
+     * @param username Username
+     * @param rememberMe Remember me flag
+     * @param userEsignModel User info model (for auto-token generation)
+     * @param privateKeyFilePath Path to private key file (for auto-token generation)
      */
     public async openSessionId(
-        accessToken?: string,
-        username?: string,
-        rememberMe?: boolean,
-        userEsignModel?: UserEsignModel,
-        privateKeyFilePath?: string
+        accessToken: string | null,
+        username: string | null,
+        rememberMe: boolean | null
     ): Promise<ESignOpenSessionResult> {
         this.validateSDKReady();
         // Pass through to SDK - error handling is done in EKYCModule.ts
         return await this.sdk.openSessionId(
             accessToken,
             username,
-            rememberMe,
-            userEsignModel,
-            privateKeyFilePath
+            rememberMe
         );
     }
 
+
     /**
      * Register device for eSign
      * @param recoverCode 8-digit recovery code
@@ -335,6 +333,20 @@ export class FinosESignModule {
         return await this.sdk.sendConfirmationDocument(requestJson);
     }
 
+    /**
+     * Composite API: Register Remote Signing + Send Confirmation Document
+     * Align với SdkeSignImpl.registerAndConfirm
+     * @param requestJson JSON request body for registerRemoteSigning
+     * @param confirmationDocBase64 PDF base64 for acceptanceDocs
+     */
+    public async registerAndConfirm(
+        requestJson: string,
+        confirmationDocBase64: string
+    ): Promise<{ response: string }> {
+        this.validateSDKReady();
+        return await this.sdk.registerAndConfirm(requestJson, confirmationDocBase64);
+    }
+
     /**
      * Remove all event listeners
      */
@@ -426,6 +438,14 @@ export class FinosESignModule {
         return listener;
     }
 
+    public onESignRegisterAndConfirmSuccess(callback: (data: { response: string }) => void) {
+        const listener = this.sdk.onESignRegisterAndConfirmSuccess(callback);
+        if (!listener) {
+            console.warn('⚠️ onESignRegisterAndConfirmSuccess: Event emitter not ready.');
+        }
+        return listener;
+    }
+
     public onESignError(callback: (error: ESignError) => void) {
         const listener = this.sdk.onESignError(callback);
         if (!listener) {
@@ -623,16 +643,19 @@ const isMethod = (prop: string | symbol): boolean => {
         prop.startsWith('on') ||
         prop === 'initialize' ||
         prop === 'initializeESign' ||
+        prop === 'getSdkToken' ||
+        prop === 'openSessionId' ||
         prop === 'sendOtp' ||
         prop === 'verifyOtp' ||
         prop === 'resendOtp' ||
-        prop === 'openSessionId' ||
+
         prop === 'registerDevice' ||
         prop === 'listCerts' ||
         prop === 'verifyCert' ||
         prop === 'listSignRequest' ||
         prop === 'confirmSign' ||
         prop === 'registerRemoteSigning' ||
+        prop === 'registerAndConfirm' ||
         prop === 'signPdf' ||
         prop === 'sendConfirmationDocument' ||
         prop === 'startLiveness' ||
@@ -689,8 +712,8 @@ const createFinosESignStub = (): FinosESignModule => {
         'onSmsOtpSendSuccess', 'onSmsOtpVerifySuccess', 'onSmsOtpResendSuccess', 'onSmsOtpError',
         'onESignInitSuccess', 'onESignOpenSessionSuccess', 'onESignRegisterDeviceSuccess',
         'onESignListCertsSuccess', 'onESignVerifyCertSuccess', 'onESignListSignRequestSuccess',
-        'onESignConfirmSignSuccess', 'onESignRegisterRemoteSigningSuccess',
-        'onESignSignPdfSuccess', 'onESignSendConfirmationDocumentSuccess', 'onESignError',
+        'onESignConfirmSignSuccess',         'onESignRegisterRemoteSigningSuccess',
+        'onESignSignPdfSuccess', 'onESignSendConfirmationDocumentSuccess', 'onESignRegisterAndConfirmSuccess', 'onESignError',
         'onLivenessSuccess', 'onLivenessError', 'onFaceCompareSuccess', 'onFaceCompareError'
     ];
 
@@ -704,9 +727,9 @@ const createFinosESignStub = (): FinosESignModule => {
     // Add all other methods
     const otherMethods = [
         'initialize', 'startNfcScan', 'checkC06', 'startOcr', 'startLiveness', 'startFaceCompare',
-        'startEkycUI', 'sendOtp', 'verifyOtp', 'resendOtp', 'initializeESign', 'openSessionId',
+        'startEkycUI', 'sendOtp', 'verifyOtp', 'resendOtp', 'initializeESign', 'getSdkToken', 'openSessionId',
         'registerDevice', 'listCerts', 'verifyCert', 'listSignRequest', 'confirmSign',
-        'registerRemoteSigning', 'signPdf', 'sendConfirmationDocument',
+        'registerRemoteSigning', 'registerAndConfirm', 'signPdf', 'sendConfirmationDocument',
         'onResume', 'onPause', 'isSDKReady', 'getSDKInfo'
     ];
 
@@ -757,7 +780,7 @@ export const FinosESign = createFinosESignWrapper();
 
 // Export types
 export type { SmsOtpConfig, SmsOtpResult, SmsOtpError } from '../types/ekycSmsOtpType';
-export type { UserEsignModel, ESignInitResult, ESignOpenSessionResult, ESignCertificate, ESignSignRequest, ESignError, ESignAuthenticateResult } from '../types/ekycESignType';
+export type { ESignInitResult, ESignOpenSessionResult, ESignCertificate, ESignSignRequest, ESignError, ESignAuthenticateResult } from '../types/ekycESignType';
 export type { LivenessConfig } from '../types/ekycLivenessType';
 export { SDKFaceDetectStatus } from '../types/ekycLivenessType';
 export type { FaceServiceConfig } from '../types/ekycFaceType';

package/src/types/ekycESignType.ts

@@ -1,31 +1,15 @@
+
+
 /**
- * User Information Model for eSign
+ * eSign Initialize Result
  */
 export interface UserEsignModel {
-  /**
-   * ID card number (CCCD/CMND)
-   */
   cccd: string;
-
-  /**
-   * User name
-   */
   name: string;
-
-  /**
-   * Device type (e.g., "Android", "iOS")
-   */
-  device: string;
-
-  /**
-   * Device ID
-   */
-  deviceId: string;
+  device?: string;
+  deviceId?: string;
 }
 
-/**
- * eSign Initialize Result
- */
 export interface ESignInitResult {
   code: string;
   message: string;

package/src/types/ekycFlowType.ts

@@ -0,0 +1,25 @@
+/**
+ * Các bước trong flow eKYC – map với Android SDKType (OCR, NFC, LIVENESS).
+ * Bên sử dụng truyền enum vào SDK thay vì string.
+ *
+ * @example
+ * import { FinosEKYC, SDKFlowType } from '@finos_sdk/sdk-ekyc';
+ * await FinosEKYC.startEkycUI(appKey, [SDKFlowType.OCR, SDKFlowType.NFC, SDKFlowType.LIVENESS], ...);
+ */
+export enum SDKFlowType {
+  OCR = 'OCR',
+  NFC = 'NFC',
+  LIVENESS = 'LIVENESS',
+}
+
+/** Mảng đầy đủ các bước (dùng cho picker / default flow). */
+export const SDK_FLOW_OPTIONS: readonly SDKFlowType[] = [
+  SDKFlowType.OCR,
+  SDKFlowType.NFC,
+  SDKFlowType.LIVENESS,
+] as const;
+
+/** Chuyển flow enum[] sang string[] khi gửi xuống native (giá trị enum đã là 'OCR'|'NFC'|'LIVENESS'). */
+export function flowToStrings(flow: SDKFlowType[]): string[] {
+  return flow.map(f => f as string);
+}

package/src/types/ekycLivenessType.ts

@@ -1,9 +1,41 @@
 import { CheckSummaryResponse } from "./ekycOCRType";
 
+/**
+ * Custom actions cho liveness – map Android SDKFaceDetectStatus.
+ * Bên sử dụng truyền enum vào optionConfig.customActions thay vì string.
+ */
 export enum SDKFaceDetectStatus {
     LEFT = "LEFT",
     RIGHT = "RIGHT",
-    STRAIGHT = "STRAIGHT"
+    UP = "UP",
+    DOWN = "DOWN",
+    SMILE = "SMILE",
+    BLINK = "BLINK",
+    TILT_LEFT = "TILT_LEFT",
+    TILT_RIGHT = "TILT_RIGHT",
+    WINK_LEFT = "WINK_LEFT",
+    WINK_RIGHT = "WINK_RIGHT",
+    STRAIGHT = "STRAIGHT",
+}
+
+/** Mảng đầy đủ các action (trừ STRAIGHT thường được SDK tự thêm cuối) – dùng cho picker / default. */
+export const SDK_LIVENESS_ACTIONS: readonly SDKFaceDetectStatus[] = [
+    SDKFaceDetectStatus.LEFT,
+    SDKFaceDetectStatus.RIGHT,
+    SDKFaceDetectStatus.UP,
+    SDKFaceDetectStatus.DOWN,
+    SDKFaceDetectStatus.SMILE,
+    SDKFaceDetectStatus.BLINK,
+    SDKFaceDetectStatus.TILT_LEFT,
+    SDKFaceDetectStatus.TILT_RIGHT,
+    SDKFaceDetectStatus.WINK_LEFT,
+    SDKFaceDetectStatus.WINK_RIGHT,
+    SDKFaceDetectStatus.STRAIGHT,
+] as const;
+
+/** Chuyển customActions enum[] sang string[] khi gửi xuống native. */
+export function customActionsToStrings(actions: SDKFaceDetectStatus[]): string[] {
+    return actions.map(a => a as string);
 }
 
 export interface LivenessConfig {

package/src/types/ekycType.ts

@@ -22,4 +22,35 @@ export interface SDKEkycResultWithEvent {
 export interface SDKEkycResultStringWithEvent {
     data: string;
     event: string;
+}
+
+/**
+ * Result from startEkycUI() – maps Android SDK data.ekycStateModel.eKYCFileModel.
+ * Use the same shape as Android: data?.ekycStateModel?.eKYCFileModel?.imageFace.
+ *
+ * @example
+ * const result = await sdkEKYC.startEkycUI(...);
+ * const selfieBase64 = result?.imageFace;      // base64 selfie (liveness/face)
+ * const frontBase64 = result?.imageOcrFront;   // base64 CCCD/CMND mặt trước
+ * const backBase64 = result?.imageOcrBack;     // base64 CCCD/CMND mặt sau
+ * const selfiePath = result?.imageFacePath;    // file path (e.g. for FormData)
+ * const transactionId = result?.transactionId;
+ */
+export interface StartEkycUIResult {
+    status: 'success';
+    event: string;
+    data?: string;
+    transactionId?: string;
+    /** Base64 selfie (liveness) – same as Android data.ekycStateModel.eKYCFileModel.imageFace */
+    imageFace?: string;
+    /** Base64 OCR front – same as Android eKYCFileModel.imageOcrFront */
+    imageOcrFront?: string;
+    /** Base64 OCR back – same as Android eKYCFileModel.imageOcrBack */
+    imageOcrBack?: string;
+    /** Absolute path to selfie file (e.g. for react-native-fs / FormData) */
+    imageFacePath?: string;
+    /** Absolute path to OCR front image file */
+    imageOcrFrontPath?: string;
+    /** Absolute path to OCR back image file */
+    imageOcrBackPath?: string;
 }