@finos_sdk/sdk-ekyc 0.0.31 → 0.0.33

package/src/modules/FinosEKYCModule.ts

@@ -0,0 +1,450 @@
+import { Platform } from 'react-native';
+import sdkEKYC, { SDKeKYC, SDK_VERSION, SDK_NAME } from '../../EKYCModule';
+import { NfcConfig, NfcError } from '../types/ekycNFCType';
+import { SDKEkycResultWithEvent, SDKEkycResultStringWithEvent } from '../types/ekycType';
+import { C06Config } from '../types/ekycC06Type';
+import { OcrConfig } from '../types/ekycOCRType';
+import { LivenessConfig } from '../types/ekycLivenessType';
+import { FaceServiceConfig } from '../types/ekycFaceType';
+
+/**
+ * Finos eKYC SDK Module v0.0.31
+ * 
+ * A comprehensive React Native module for electronic Know Your Customer (eKYC) operations
+ * including Vietnamese CCCD NFC reading, OCR, Liveness detection, Face matching, and C06 residence verification.
+ * 
+ * @version 0.0.31
+ * @author FinOS
+ * @license MIT
+ */
+export class FinosEKYCModule {
+    private static instance: FinosEKYCModule;
+    private sdk: SDKeKYC;
+    private isInitialized: boolean = false;
+    private platform: string;
+
+    private constructor() {
+        this.sdk = sdkEKYC;
+        this.platform = Platform.OS;
+    }
+
+    /**
+     * Get singleton instance of FinosEKYCModule
+     */
+    public static getInstance(): FinosEKYCModule {
+        if (!FinosEKYCModule.instance) {
+            FinosEKYCModule.instance = new FinosEKYCModule();
+        }
+        return FinosEKYCModule.instance;
+    }
+
+    /**
+     * Get SDK information
+     */
+    public async getSDKInfo(): Promise<{
+        name: string;
+        version: string;
+        buildNumber: string;
+        platform: string;
+        isInitialized: boolean;
+    }> {
+        try {
+            const nativeInfo = await this.sdk.getSDKInfo();
+            return {
+                ...nativeInfo,
+                platform: this.platform,
+                isInitialized: this.isInitialized
+            };
+        } catch (error) {
+            return {
+                name: SDK_NAME,
+                version: SDK_VERSION,
+                buildNumber: '1',
+                platform: this.platform,
+                isInitialized: this.isInitialized
+            };
+        }
+    }
+
+    /**
+     * Initialize the eKYC SDK
+     * Must be called before using any other methods
+     */
+    public async initialize(): Promise<string> {
+        try {
+            if (this.isInitialized) {
+                console.log('✅ SDK already initialized');
+                return 'SDK already initialized';
+            }
+
+            // Check if SDK is already initialized on native side
+            if (this.sdk.isSDKInitialized()) {
+                this.isInitialized = true;
+                console.log('✅ SDK already initialized on native side');
+                return 'SDK already initialized on native side';
+            }
+
+            const result = await this.sdk.initSdkEkyc();
+            this.isInitialized = true;
+            console.log('✅ Finos eKYC SDK v0.0.31 initialized successfully');
+            return result;
+        } catch (error) {
+            // Handle Koin Application already started error
+            if (error && error.toString().includes('Koin Application has already been started')) {
+                console.log('✅ SDK already initialized (Koin Application started)');
+                this.isInitialized = true;
+                return 'SDK already initialized (Koin Application started)';
+            }
+            
+            console.error('❌ Failed to initialize Finos eKYC SDK:', error);
+            throw new Error(`SDK initialization failed: ${error}`);
+        }
+    }
+
+    /**
+     * Check if SDK is initialized
+     */
+    public isSDKReady(): boolean {
+        return this.isInitialized && this.sdk.isSDKInitialized();
+    }
+
+    /**
+     * Start NFC scanning for Vietnamese CCCD
+     * @param config NFC configuration
+     */
+    public async startNfcScan(config: NfcConfig): Promise<SDKEkycResultStringWithEvent> {
+        this.validateSDKReady();
+        this.validatePlatform('android', 'NFC scanning is only available on Android');
+        
+        try {
+            console.log('📡 Starting NFC scan...');
+            const result = await this.sdk.startNfcScan(config);
+            console.log('✅ NFC scan completed:', result.event);
+            return result;
+        } catch (error) {
+            console.error('❌ NFC scan failed:', error);
+            throw error;
+        }
+    }
+
+    /**
+     * Check C06 residence verification
+     * @param config C06 configuration
+     */
+    public async checkC06(config: C06Config): Promise<SDKEkycResultStringWithEvent> {
+        this.validateSDKReady();
+        
+        try {
+            console.log('🏠 Starting C06 residence check...');
+            const result = await this.sdk.checkC06(config);
+            console.log('✅ C06 check completed:', result.event);
+            return result;
+        } catch (error) {
+            console.error('❌ C06 check failed:', error);
+            throw error;
+        }
+    }
+
+    /**
+     * Start OCR document scanning
+     * @param config OCR configuration
+     */
+    public async startOCR(config: OcrConfig): Promise<SDKEkycResultStringWithEvent> {
+        this.validateSDKReady();
+        
+        try {
+            console.log('📄 Starting OCR scan...');
+            const result = await this.sdk.startOcr(config);
+            console.log('✅ OCR scan completed:', result.event);
+            return result;
+        } catch (error) {
+            console.error('❌ OCR scan failed:', error);
+            throw error;
+        }
+    }
+
+    /**
+     * Start liveness detection
+     * @param config Liveness configuration
+     */
+    public async startLiveness(config: LivenessConfig): Promise<SDKEkycResultStringWithEvent> {
+        this.validateSDKReady();
+        
+        try {
+            console.log('👁️ Starting liveness detection...');
+            const result = await this.sdk.startLiveness(config);
+            console.log('✅ Liveness detection completed:', result.event);
+            return result;
+        } catch (error) {
+            console.error('❌ Liveness detection failed:', error);
+            throw error;
+        }
+    }
+
+    /**
+     * Start face comparison
+     * @param config Face service configuration
+     */
+    public async startFaceCompare(config: FaceServiceConfig): Promise<SDKEkycResultStringWithEvent> {
+        this.validateSDKReady();
+        
+        try {
+            console.log('👤 Starting face comparison...');
+            const result = await this.sdk.startFaceCompare(config);
+            console.log('✅ Face comparison completed:', result.event);
+            return result;
+        } catch (error) {
+            console.error('❌ Face comparison failed:', error);
+            throw error;
+        }
+    }
+
+    /**
+     * Extract NFC data for C06 verification
+     * @param nfcResultJson NFC result JSON string
+     */
+    public async extractNfcDataForC06(nfcResultJson: string): Promise<any> {
+        this.validateSDKReady();
+        
+        try {
+            console.log('🔍 Extracting NFC data for C06...');
+            // Note: This method needs to be implemented in the native module
+            console.log('✅ NFC data extraction completed');
+            return { success: true, data: nfcResultJson };
+        } catch (error) {
+            console.error('❌ NFC data extraction failed:', error);
+            throw error;
+        }
+    }
+
+    /**
+     * Handle app lifecycle - Resume
+     */
+    public onResume(): void {
+        this.sdk.onResume();
+        console.log('📱 App resumed');
+    }
+
+    /**
+     * Handle app lifecycle - Pause
+     */
+    public onPause(): void {
+        this.sdk.onPause();
+        console.log('📱 App paused');
+    }
+
+    /**
+     * Handle new intent (Android)
+     */
+    public handleNewIntent(): void {
+        // Note: This method needs to be implemented in the native module
+        console.log('📱 New intent handled');
+    }
+
+    // Event Listeners
+    /**
+     * Listen for NFC scan start events
+     */
+    public onNfcScanStart(callback: (data: SDKEkycResultWithEvent) => void) {
+        return this.sdk.onNfcScanStart(callback);
+    }
+
+    /**
+     * Listen for NFC scan success events
+     */
+    public onNfcScanSuccess(callback: (data: SDKEkycResultStringWithEvent) => void) {
+        return this.sdk.onNfcScanSuccess(callback);
+    }
+
+    /**
+     * Listen for NFC error events
+     */
+    public onNfcError(callback: (error: NfcError) => void) {
+        return this.sdk.onNfcError(callback);
+    }
+
+    /**
+     * Listen for C06 success events
+     */
+    public onC06Success(callback: (data: SDKEkycResultWithEvent) => void) {
+        return this.sdk.onC06Success(callback);
+    }
+
+    /**
+     * Listen for C06 error events
+     */
+    public onC06Error(callback: (error: NfcError) => void) {
+        return this.sdk.onC06Error(callback);
+    }
+
+    /**
+     * Listen for OCR success events
+     */
+    public onOCRSuccess(callback: (data: SDKEkycResultStringWithEvent) => void) {
+        return this.sdk.onOcrSuccess(callback);
+    }
+
+    /**
+     * Listen for OCR error events
+     */
+    public onOCRError(callback: (error: any) => void) {
+        return this.sdk.onOcrError(callback);
+    }
+
+    /**
+     * Listen for liveness success events
+     */
+    public onLivenessSuccess(callback: (data: SDKEkycResultStringWithEvent) => void) {
+        return this.sdk.onLivenessSuccess(callback);
+    }
+
+    /**
+     * Listen for liveness error events
+     */
+    public onLivenessError(callback: (error: any) => void) {
+        return this.sdk.onLivenessError(callback);
+    }
+
+    /**
+     * Listen for face compare success events
+     */
+    public onFaceCompareSuccess(callback: (data: SDKEkycResultWithEvent) => void) {
+        return this.sdk.onFaceCompareSuccess(callback);
+    }
+
+    /**
+     * Listen for face compare error events
+     */
+    public onFaceCompareError(callback: (error: any) => void) {
+        return this.sdk.onFaceCompareError(callback);
+    }
+
+    /**
+     * Remove all event listeners
+     */
+    public removeAllListeners(): void {
+        this.sdk.removeAllListeners();
+        console.log('🧹 All event listeners removed');
+    }
+
+    /**
+     * Start eKYC UI with flow (like MainActivity.kt)
+     * @param appKey Main app key
+     * @param flowSDK Array of SDK types
+     * @param language Language code (vi/en)
+     * @param transactionId Transaction ID
+     * @param optionConfig Optional configuration settings
+     * @param appKeyConfig Optional app key configuration
+     * @param styleConfig Optional style configuration
+     */
+    public async startEkycUI(
+        appKey: string,
+        flowSDK: string[],
+        language: string,
+        transactionId: string,
+        appKeyConfig: {
+            appKey: string;
+            appKeyNfc: string;
+            appKeyOcr: string;
+            appKeyLiveness: string;
+            appKeyC06: string;
+            appKeyFaceService: string;
+        },
+        optionConfig?: {
+            baseUrl?: string;
+            countMaxRetry?: number;
+            language?: string;
+        },
+        styleConfig?: {
+            textSize?: number;
+            textFont?: string;
+            textColor?: number;
+            statusBarBackground?: number;
+            backIcon?: number;
+            titleStyle?: {
+                textSize?: number;
+                textFont?: string;
+                textColor?: number;
+            };
+            toolbarStyle?: {
+                textSize?: number;
+                textFont?: string;
+                textColor?: number;
+            };
+            instructionStyle?: {
+                textSize?: number;
+                textFont?: string;
+                textColor?: number;
+            };
+            errorStyle?: {
+                textSize?: number;
+                textFont?: string;
+                textColor?: number;
+            };
+            successStyle?: {
+                textSize?: number;
+                textFont?: string;
+                textColor?: number;
+            };
+            warningStyle?: {
+                textSize?: number;
+                textFont?: string;
+                textColor?: number;
+            };
+        }
+    ): Promise<any> {
+        this.validateSDKReady();
+        
+        try {
+            console.log('🚀 Starting eKYC UI with flow:', flowSDK);
+            console.log('🔧 OptionConfig:', optionConfig);
+            console.log('🔑 AppKeyConfig:', appKeyConfig);
+            console.log('🎨 StyleConfig:', styleConfig);
+            
+            const result = await this.sdk.startEkycUI(
+                appKey,
+                flowSDK,
+                language,
+                transactionId,
+                appKeyConfig,
+                optionConfig,
+                styleConfig
+            );
+            console.log('✅ eKYC UI started successfully');
+            return result;
+        } catch (error) {
+            console.error('❌ eKYC UI failed:', error);
+            throw error;
+        }
+    }
+
+    // Private validation methods
+    private validateSDKReady(): void {
+        if (!this.isSDKReady()) {
+            throw new Error('SDK is not initialized. Please call initialize() first.');
+        }
+    }
+
+    private validatePlatform(requiredPlatform: string, message: string): void {
+        if (this.platform !== requiredPlatform) {
+            throw new Error(message);
+        }
+    }
+}
+
+// Export singleton instance
+export const FinosEKYC = FinosEKYCModule.getInstance();
+
+// Export types
+export type { NfcConfig, NfcError } from '../types/ekycNFCType';
+export type { C06Config } from '../types/ekycC06Type';
+export type { OcrConfig } from '../types/ekycOCRType';
+export type { LivenessConfig } from '../types/ekycLivenessType';
+export type { FaceServiceConfig } from '../types/ekycFaceType';
+export type { SDKEkycResultWithEvent, SDKEkycResultStringWithEvent } from '../types/ekycType';
+
+// Export constants
+export { SDK_VERSION, SDK_NAME };
+
+// Default export
+export default FinosEKYC;