@finos_sdk/sdk-ekyc 1.2.2 → 1.2.8

package/dist/src/modules/FinosESignModule.d.ts

@@ -0,0 +1,270 @@
+import { 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 { LivenessConfig } from '../types/ekycLivenessType';
+import { FaceServiceConfig } from '../types/ekycFaceType';
+import { SDKEkycResultStringWithEvent, SDKEkycResultWithEvent } from '../types/ekycType';
+/**
+ * Finos eSign SDK Module
+ *
+ * A React Native module for eSign (Electronic Signature), SMS OTP, Liveness detection,
+ * and Face matching operations. This module excludes NFC, C06, and OCR features.
+ *
+ * @version Dynamic from package.json
+ * @author FinOS
+ * @license MIT
+ */
+export declare class FinosESignModule {
+    private static instance;
+    private sdk;
+    private isInitialized;
+    private platform;
+    private constructor();
+    /**
+     * Get singleton instance of FinosESignModule
+     */
+    static getInstance(): FinosESignModule;
+    /**
+     * Get SDK information
+     */
+    getSDKInfo(): Promise<{
+        name: string;
+        version: string;
+        buildNumber: string;
+        platform: string;
+        isInitialized: boolean;
+    }>;
+    /**
+     * Initialize the eSign SDK
+     * Must be called before using any other methods
+     */
+    initialize(): Promise<string>;
+    /**
+     * Check if SDK is initialized
+     */
+    isSDKReady(): boolean;
+    /**
+     * Send SMS OTP
+     * @param config SMS OTP configuration
+     */
+    sendOtp(config: SmsOtpConfig): Promise<SmsOtpResult>;
+    /**
+     * Verify SMS OTP
+     * @param config SMS OTP configuration (must include requestId)
+     * @param otpCode OTP code from SMS
+     */
+    verifyOtp(config: SmsOtpConfig, otpCode: string): Promise<SmsOtpResult>;
+    /**
+     * Resend SMS OTP
+     * @param config SMS OTP configuration (must include requestId)
+     */
+    resendOtp(config: SmsOtpConfig): Promise<SmsOtpResult>;
+    onSmsOtpSendSuccess(callback: (data: SmsOtpResult) => void): import("react-native").EmitterSubscription | null;
+    onSmsOtpVerifySuccess(callback: (data: SmsOtpResult) => void): import("react-native").EmitterSubscription | null;
+    onSmsOtpResendSuccess(callback: (data: SmsOtpResult) => void): import("react-native").EmitterSubscription | null;
+    onSmsOtpError(callback: (error: SmsOtpError) => void): import("react-native").EmitterSubscription | null;
+    /**
+     * Initialize eSign SDK
+     */
+    initializeESign(): Promise<ESignInitResult>;
+    /**
+     * 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)
+     */
+    openSessionId(accessToken?: string, username?: string, rememberMe?: boolean, userEsignModel?: UserEsignModel, privateKeyFilePath?: string): Promise<ESignOpenSessionResult>;
+    /**
+     * Register device for eSign
+     * @param recoverCode 8-digit recovery code
+     * @param pinCode 6-digit PIN code
+     * @param fcmToken Optional FCM token
+     */
+    registerDevice(recoverCode: string, pinCode: string, fcmToken?: string): Promise<{
+        code: string;
+        message: string;
+    }>;
+    /**
+     * List eSign certificates
+     * @param pageNumber Page number (default: 1)
+     * @param pageSize Page size (default: 10)
+     */
+    listCerts(pageNumber?: number, pageSize?: number): Promise<{
+        certs: ESignCertificate[];
+    }>;
+    /**
+     * Verify eSign certificate
+     * @param serial Certificate serial number
+     */
+    verifyCert(serial: string): Promise<{
+        code: string;
+        message: string;
+    }>;
+    /**
+     * List eSign sign requests
+     * @param pageNumber Page number (default: 1)
+     * @param pageSize Page size (default: 10)
+     */
+    listSignRequest(pageNumber?: number, pageSize?: number): Promise<{
+        requests: ESignSignRequest[];
+    }>;
+    /**
+     * Confirm eSign signature
+     * @param signRequestId Sign request ID
+     * @param pinCode 6-digit PIN code
+     * @param authId Optional auth ID
+     * @param authData Optional auth data
+     * @param confirm Confirm the signature (default: true)
+     */
+    confirmSign(signRequestId: string, pinCode: string, authId?: string, authData?: string, confirm?: boolean): Promise<{
+        code: string;
+        message: string;
+    }>;
+    /**
+     * Authenticate with eSign
+     * @param username eSign username
+     * @param password eSign password
+     */
+    authenticate(username: string, password: string): Promise<ESignAuthenticateResult>;
+    /**
+     * Register remote signing certificate
+     * @param accessToken JWT access token
+     * @param requestJson JSON request body
+     */
+    registerRemoteSigning(accessToken: string, requestJson: string): Promise<{
+        response: string;
+    }>;
+    /**
+     * Sign PDF document
+     * @param accessToken JWT access token
+     * @param requestJson JSON request body
+     */
+    signPdf(accessToken: string, requestJson: string): Promise<{
+        response: string;
+    }>;
+    /**
+     * Send confirmation document
+     * @param accessToken JWT access token
+     * @param requestJson JSON string containing request data
+     */
+    sendConfirmationDocument(accessToken: string, requestJson: string): Promise<{
+        response: string;
+    }>;
+    /**
+     * Remove all event listeners
+     */
+    removeAllListeners(): void;
+    onESignInitSuccess(callback: (data: ESignInitResult) => void): import("react-native").EmitterSubscription | null;
+    onESignOpenSessionSuccess(callback: (data: ESignOpenSessionResult) => void): import("react-native").EmitterSubscription | null;
+    onESignRegisterDeviceSuccess(callback: (data: {
+        code: string;
+        message: string;
+    }) => void): import("react-native").EmitterSubscription | null;
+    onESignListCertsSuccess(callback: (data: {
+        certs: ESignCertificate[];
+    }) => void): import("react-native").EmitterSubscription | null;
+    onESignVerifyCertSuccess(callback: (data: {
+        code: string;
+        message: string;
+    }) => void): import("react-native").EmitterSubscription | null;
+    onESignListSignRequestSuccess(callback: (data: {
+        requests: ESignSignRequest[];
+    }) => void): import("react-native").EmitterSubscription | null;
+    onESignConfirmSignSuccess(callback: (data: {
+        code: string;
+        message: string;
+    }) => void): import("react-native").EmitterSubscription | null;
+    onESignAuthenticateSuccess(callback: (data: ESignAuthenticateResult) => void): import("react-native").EmitterSubscription | null;
+    onESignRegisterRemoteSigningSuccess(callback: (data: {
+        response: string;
+    }) => void): import("react-native").EmitterSubscription | null;
+    onESignSignPdfSuccess(callback: (data: {
+        response: string;
+    }) => void): import("react-native").EmitterSubscription | null;
+    onESignSendConfirmationDocumentSuccess(callback: (data: {
+        response: string;
+    }) => void): import("react-native").EmitterSubscription | null;
+    onESignError(callback: (error: ESignError) => void): import("react-native").EmitterSubscription | null;
+    /**
+     * Start liveness detection
+     * @param config Liveness configuration (includes switchFrontCamera for camera control)
+     */
+    startLiveness(config: LivenessConfig): Promise<SDKEkycResultStringWithEvent>;
+    onLivenessSuccess(callback: (data: SDKEkycResultStringWithEvent) => void): import("react-native").EmitterSubscription | null;
+    onLivenessError(callback: (error: any) => void): import("react-native").EmitterSubscription | null;
+    /**
+     * Start face comparison
+     * @param config Face service configuration
+     */
+    startFaceCompare(config: FaceServiceConfig): Promise<SDKEkycResultStringWithEvent>;
+    onFaceCompareSuccess(callback: (data: SDKEkycResultWithEvent) => void): import("react-native").EmitterSubscription | null;
+    onFaceCompareError(callback: (error: any) => void): import("react-native").EmitterSubscription | null;
+    /**
+     * Start eKYC UI with flow (excluding NFC, C06, OCR)
+     * Only supports LIVENESS and FACE in flowSDK array
+     * @param appKey Main app key
+     * @param flowSDK Array of SDK types (only 'LIVENESS' and 'FACE' are allowed)
+     * @param language Language code (vi/en)
+     * @param transactionId Transaction ID
+     * @param appKeyConfig App key configuration
+     * @param optionConfig Optional configuration settings (includes switchFrontCamera for camera control)
+     * @param styleConfig Optional style configuration
+     */
+    startEkycUI(appKey: string, flowSDK: string[], language: string, transactionId: string, appKeyConfig: {
+        appKey: string;
+        appKeyLiveness: string;
+        appKeyFaceService: string;
+    }, optionConfig?: {
+        baseUrl?: string;
+        countMaxRetry?: number;
+        language?: string;
+        switchFrontCamera?: boolean;
+    }, 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>;
+    private validateSDKReady;
+}
+export declare const FinosESign: FinosESignModule;
+export type { SmsOtpConfig, SmsOtpResult, SmsOtpError } from '../types/ekycSmsOtpType';
+export type { UserEsignModel, ESignInitResult, ESignOpenSessionResult, ESignCertificate, ESignSignRequest, ESignError, ESignAuthenticateResult } from '../types/ekycESignType';
+export type { LivenessConfig } from '../types/ekycLivenessType';
+export type { FaceServiceConfig } from '../types/ekycFaceType';
+export type { SDKEkycResultStringWithEvent, SDKEkycResultWithEvent } from '../types/ekycType';
+export { SDK_VERSION, SDK_NAME };
+export default FinosESign;