@finos_sdk/sdk-ekyc 1.3.2 → 1.3.4

package/src/types/ekycFaceType.ts

@@ -15,7 +15,14 @@ export interface FaceVerifyResult {
 }
 
 export interface FaceServiceConfig {
+    /**
+     * Backward/forward compatible:
+     * - SDK code uses `appKey`
+     * - Some integration docs use `appKeyFaceService`
+     * Provide either; `startFaceCompare()` will normalize.
+     */
     appKey: string,
+    appKeyFaceService?: string,
     transactionId?: string,
     selfieImage: string,
     idImage: 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;
 }