@finos_sdk/sdk-ekyc 0.0.29 → 0.0.31

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 FinOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,79 +1,276 @@
-This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
+# @finos_sdk/sdk-ekyc
 
-# Getting Started
+[![npm version](https://badge.fury.io/js/%40finos_sdk%2Fsdk-ekyc.svg)](https://badge.fury.io/js/%40finos_sdk%2Fsdk-ekyc)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
->**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.
+React Native SDK for eKYC (electronic Know Your Customer) - Vietnamese CCCD NFC reading, OCR, Liveness detection, Face matching, and C06 residence verification.
 
-## Step 1: Start the Metro Server
+## 🚀 Features
 
-First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
+- **NFC Reading** - Read Vietnamese CCCD cards with NFC chips
+- **OCR Processing** - Extract data from ID card images
+- **Liveness Detection** - Verify user presence with selfie
+- **Face Matching** - Compare selfie with ID card photo
+- **C06 Verification** - Residence information verification
+- **TypeScript Support** - Full type definitions included
 
-To start Metro, run the following command from the _root_ of your React Native project:
+## 📱 Requirements
+
+- React Native 0.70+
+- Android 21+ (Android platform only)
+- NFC and/or Camera hardware depending on modules used
+- Runtime permissions for Camera and/or NFC
+
+## 🛠️ Installation
 
 ```bash
-# using npm
-npm start
+npm install @finos_sdk/sdk-ekyc
+# or
+yarn add @finos_sdk/sdk-ekyc
+```
 
-# OR using Yarn
-yarn start
+## 📖 Quick Start
+
+### 1. Import the SDK
+
+```typescript
+import SdkEkyc from '@finos_sdk/sdk-ekyc';
+import type { NfcConfig } from '@finos_sdk/sdk-ekyc';
 ```
 
-## Step 2: Start your Application
+### 2. Basic NFC Scanning
 
-Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app:
+```typescript
+import React, { useEffect } from 'react';
+import { View, Button, Alert } from 'react-native';
+import SdkEkyc from '@finos_sdk/sdk-ekyc';
 
-### For Android
+const NFCExample = () => {
+  useEffect(() => {
+    // Set up event listeners
+    const nfcSuccessListener = SdkEkyc.onNfcScanSuccess((data) => {
+      console.log('NFC scan successful:', data);
+    });
 
-```bash
-# using npm
-npm run android
+    const nfcErrorListener = SdkEkyc.onNfcError((error) => {
+      Alert.alert('NFC Error', error.message);
+    });
 
-# OR using Yarn
-yarn android
+    return () => {
+      nfcSuccessListener?.remove();
+      nfcErrorListener?.remove();
+    };
+  }, []);
+
+  const startNfcScan = async () => {
+    try {
+      const config: NfcConfig = {
+        appKey: 'your_app_key_here',
+        documentNumber: '123456789',
+        birthDate: '01011990',
+        expireDate: '01012030',
+      };
+
+      await SdkEkyc.startNfcScan(config);
+    } catch (error) {
+      Alert.alert('Error', 'Failed to start NFC scan');
+    }
+  };
+
+  return (
+    <View style={{ padding: 20 }}>
+      <Button title="Start NFC Scan" onPress={startNfcScan} />
+    </View>
+  );
+};
 ```
 
-### For iOS
+### 3. Android Setup
+
+Add permissions to `android/app/src/main/AndroidManifest.xml`:
+
+```xml
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.NFC" />
+<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+
+<uses-feature
+    android:name="android.hardware.nfc"
+    android:required="false" />
+```
+
+Clean and rebuild:
 
 ```bash
-# using npm
-npm run ios
+cd android
+./gradlew clean
+cd ..
+npx react-native run-android
+```
+
+## 📚 Documentation
+
+For complete documentation, examples, and API reference, see:
+
+- [📖 Full Integration Guide](./Document/DOC_eKYC_SDK_ReactNative_Integration.md)
+- [🔧 API Reference](./Document/DOC_eKYC_SDK_ReactNative_Integration.md#api-reference)
+- [📋 Event Types](./Document/DOC_eKYC_SDK_ReactNative_Integration.md#event-types-and-callbacks)
 
-# OR using Yarn
-yarn ios
+## 🎯 Available Modules
+
+### NFC Scanning
+```typescript
+const config: NfcConfig = {
+  appKey: 'your_app_key',
+  documentNumber: '123456789',
+  birthDate: '01011990',
+  expireDate: '01012030',
+};
+
+await SdkEkyc.startNfcScan(config);
 ```
 
-If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly.
+### OCR Processing
+```typescript
+const config: OcrConfig = {
+  appKey: 'your_app_key',
+  idImagePath: 'base64_image_data',
+  expectedDocumentSide: 'front',
+};
 
-This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
+await SdkEkyc.startOcr(config);
+```
 
-## Step 3: Modifying your App
+### Liveness Detection
+```typescript
+const config: LivenessConfig = {
+  appKey: 'your_app_key',
+  selfieImage: 'base64_selfie_image',
+  usingRandomAction: false,
+  isStraight: true,
+};
 
-Now that you have successfully run the app, let's modify it.
+await SdkEkyc.startLiveness(config);
+```
 
-1. Open `App.tsx` in your text editor of choice and edit some lines.
-2. For **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Developer Menu** (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes!
+### Face Matching
+```typescript
+const config: FaceServiceConfig = {
+  appKey: 'your_app_key',
+  selfieImage: 'selfie_base64',
+  idImage: 'id_image_base64',
+};
 
-   For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes!
+await SdkEkyc.startFaceCompare(config);
+```
+
+### C06 Verification
+```typescript
+const config: C06Config = {
+  appKey: 'your_app_key',
+  sod: 'sod_from_nfc',
+  idCardNumber: '123456789',
+  recentLocation: 'address_from_nfc',
+};
+
+await SdkEkyc.checkC06(config);
+```
+
+## 🔧 Event Handling
+
+The SDK uses event listeners for real-time updates:
+
+```typescript
+// Success events
+SdkEkyc.onNfcScanSuccess((data) => { /* handle success */ });
+SdkEkyc.onOcrSuccess((data) => { /* handle success */ });
+SdkEkyc.onLivenessSuccess((data) => { /* handle success */ });
+
+// Error events
+SdkEkyc.onNfcError((error) => { /* handle error */ });
+SdkEkyc.onOcrError((error) => { /* handle error */ });
+SdkEkyc.onLivenessError((error) => { /* handle error */ });
+```
+
+## 🧪 TypeScript Support
+
+Full TypeScript support with comprehensive type definitions:
+
+```typescript
+import type {
+  NfcConfig,
+  C06Config,
+  OcrConfig,
+  LivenessConfig,
+  FaceServiceConfig,
+  SDKEkycResultWithEvent,
+  SDKEkycResultStringWithEvent,
+} from '@finos_sdk/sdk-ekyc';
+```
+
+## 🔄 Lifecycle Management
+
+For proper NFC functionality, integrate with your app's lifecycle:
+
+```typescript
+import { AppState } from 'react-native';
+
+useEffect(() => {
+  const handleAppStateChange = (nextAppState: string) => {
+    if (nextAppState === 'active') {
+      SdkEkyc.onResume();
+    } else if (nextAppState === 'background') {
+      SdkEkyc.onPause();
+    }
+  };
+
+  const subscription = AppState.addEventListener('change', handleAppStateChange);
+  return () => {
+    subscription?.remove();
+    SdkEkyc.removeAllListeners();
+  };
+}, []);
+```
+
+## 🚨 Error Handling
+
+All SDK operations return promises and emit error events:
+
+```typescript
+try {
+  const result = await SdkEkyc.startNfcScan(config);
+  // Handle success
+} catch (error) {
+  console.error('SDK operation failed:', error);
+  // Show user-friendly error message
+}
+```
 
-## Congratulations! :tada:
+## 📞 Support
 
-You've successfully run and modified your React Native App. :partying_face:
+- **Documentation**: [Full Integration Guide](./Document/DOC_eKYC_SDK_ReactNative_Integration.md)
+- **Issues**: [GitHub Issues](https://github.com/finos/sdk-ekyc/issues)
+- **Contact**: SDK provider for app key registration and support
 
-### Now what?
+## 📄 License
 
-- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps).
-- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started).
+MIT License - see [LICENSE](LICENSE) file for details.
 
-# Troubleshooting
+## 🔄 Migration from Android SDK
 
-If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
+If migrating from the native Android SDK:
 
-# Learn More
+1. Replace native method calls with React Native SDK methods
+2. Convert callback-based APIs to Promise-based APIs
+3. Use event listeners instead of direct callbacks
+4. Handle permissions through React Native's permission system
+5. Update app lifecycle management to use React Native's AppState
 
-To learn more about React Native, take a look at the following resources:
+## 📦 Package Information
 
-- [React Native Website](https://reactnative.dev) - learn more about React Native.
-- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
-- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
-- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
-- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.
+- **Package**: `@finos_sdk/sdk-ekyc`
+- **Version**: 0.0.30+
+- **Platform**: Android (iOS support planned)
+- **React Native**: 0.70+
+- **License**: MIT

package/android/SDKeKYC/finos/sdk/ekyc/c06/{1.1.9/c06-1.1.9.module → 1.2.0/c06-1.2.0.module}

@@ -3,14 +3,14 @@
   "component": {
     "group": "finos.sdk.ekyc",
     "module": "c06",
-    "version": "1.1.9",
+    "version": "1.2.0",
     "attributes": {
       "org.gradle.status": "release"
     }
   },
   "createdBy": {
     "gradle": {
-      "version": "8.14.3"
+      "version": "9.0.0"
     }
   },
   "variants": [
@@ -33,13 +33,13 @@
       ],
       "files": [
         {
-          "name": "c06-1.1.9.aar",
-          "url": "c06-1.1.9.aar",
-          "size": 12864,
-          "sha512": "b82ef7802687929040b2830fd6262c056fabce9641afda252b6777122c2f7b158bebda08a3a105b4004aea632dd1f71cd2f2325d0c7ae2cd7c0d9e107cdca9d0",
-          "sha256": "5da1ba9612ccb5cf10350d6cc517cb620dd0f58b98a160a772c2b23c6fcf197a",
-          "sha1": "428284bffac01ee6accaca35967edf768b86e07c",
-          "md5": "743a418d33f678a051f1ce677c45eea5"
+          "name": "c06-1.2.0.aar",
+          "url": "c06-1.2.0.aar",
+          "size": 13592,
+          "sha512": "c55f8a3b30a68e8346a96a2e21b88f8b4d2620fd53c2782ee593135b2d45fb0582ab0411dad5e1f5e90d35a625e60786705cc4a2bca99afca50140c6386cde3e",
+          "sha256": "bf3d0865238651be831e08e334d8777c074d803f5b431521afc2edabd58b0d4e",
+          "sha1": "8d402b27282bd069b5addc0c7461b85801d74b8a",
+          "md5": "650b52ab71d78a8390238feab377daa6"
         }
       ]
     },
@@ -63,7 +63,7 @@
           "group": "finos.sdk.ekyc",
           "module": "sdkcore",
           "version": {
-            "requires": "1.1.9"
+            "requires": "1.2.0"
           }
         },
         {
@@ -76,13 +76,13 @@
       ],
       "files": [
         {
-          "name": "c06-1.1.9.aar",
-          "url": "c06-1.1.9.aar",
-          "size": 12864,
-          "sha512": "b82ef7802687929040b2830fd6262c056fabce9641afda252b6777122c2f7b158bebda08a3a105b4004aea632dd1f71cd2f2325d0c7ae2cd7c0d9e107cdca9d0",
-          "sha256": "5da1ba9612ccb5cf10350d6cc517cb620dd0f58b98a160a772c2b23c6fcf197a",
-          "sha1": "428284bffac01ee6accaca35967edf768b86e07c",
-          "md5": "743a418d33f678a051f1ce677c45eea5"
+          "name": "c06-1.2.0.aar",
+          "url": "c06-1.2.0.aar",
+          "size": 13592,
+          "sha512": "c55f8a3b30a68e8346a96a2e21b88f8b4d2620fd53c2782ee593135b2d45fb0582ab0411dad5e1f5e90d35a625e60786705cc4a2bca99afca50140c6386cde3e",
+          "sha256": "bf3d0865238651be831e08e334d8777c074d803f5b431521afc2edabd58b0d4e",
+          "sha1": "8d402b27282bd069b5addc0c7461b85801d74b8a",
+          "md5": "650b52ab71d78a8390238feab377daa6"
         }
       ]
     },
@@ -96,13 +96,13 @@
       },
       "files": [
         {
-          "name": "c06-1.1.9-sources.jar",
-          "url": "c06-1.1.9-sources.jar",
-          "size": 2422,
-          "sha512": "c2eb1f6667cd91cc19c76d1cf25934cbc116f5b0c7aad5b6f91f127a9c77c358bb11c71cca4175cb145752ab06d04b77af8db0a504104efb3b2d75c7b0a6222f",
-          "sha256": "a567040ef9e2ecf7925ac28a8d32cf647a26a9916e90c12357e8b14fb75e58fc",
-          "sha1": "2d51eff6ef67232f5c1611ba8045f38bd61e67c5",
-          "md5": "5457a62ac2611bf9e64c899a3a800f23"
+          "name": "c06-1.2.0-sources.jar",
+          "url": "c06-1.2.0-sources.jar",
+          "size": 2529,
+          "sha512": "ec7bd58447a91703b10d092171b5b6fe4c7d2d69426a8fb108303537d84dc61aa3ac07ecd0324450d34ee10367f4a611fa64f07127c48b7d10e494a316bad054",
+          "sha256": "4d2e875d46b677c8b7a0167e802790785388585731315f22c1a64b1982531dd3",
+          "sha1": "498122de6d59700f7522cc095b9fa0958baa277a",
+          "md5": "a29aad68f0ad4c0ab2232771c9427711"
         }
       ]
     },
@@ -116,13 +116,13 @@
       },
       "files": [
         {
-          "name": "c06-1.1.9-javadoc.jar",
-          "url": "c06-1.1.9-javadoc.jar",
-          "size": 278596,
-          "sha512": "b80c0c6368e6e1f1d6841d06c82284713f368b6694d2fd6d19c7192df37ec876d4455282a01ae0b87d11664839c7b64fb6b22a8018d673c58e2f8958314c5f1e",
-          "sha256": "c18382876476efdc5c111470c41a4c550ac577033fd8d3ca8afbf0d6031c04a7",
-          "sha1": "d84ad5b8e325decbdbe42afb036c54f1cf3f1154",
-          "md5": "e9a6f61cf9819bd3e7a45500ec1722c2"
+          "name": "c06-1.2.0-javadoc.jar",
+          "url": "c06-1.2.0-javadoc.jar",
+          "size": 278559,
+          "sha512": "f76907ff9d16be331dad19abb505f479ae075cf9915924359239a0d8a7eadae2df80a91efd18976cddcb971285db8113281eba9d4110499cc6e1dba616419214",
+          "sha256": "13b1fc8b8006f97deb7459a1ed9ccde2ebecb5f8dfac0b69407cf905eadaff7c",
+          "sha1": "05ed4aad207cca3ad70520871bce6047f66fbcaa",
+          "md5": "ba3093ec80ef12c5c5e36d0b0ef7f54c"
         }
       ]
     }

package/android/SDKeKYC/finos/sdk/ekyc/c06/{1.1.9/c06-1.1.9.pom → 1.2.0/c06-1.2.0.pom}

@@ -9,11 +9,11 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>finos.sdk.ekyc</groupId>
   <artifactId>c06</artifactId>
-  <version>1.1.9</version>
+  <version>1.2.0</version>
   <packaging>aar</packaging>
   <name>C06</name>
   <description>Android SDK module: C06</description>
-  <url>https://github.com/vnfinosdevops/finos.ekyc.sdk.android</url>
+  <url>https://github.com/ToanMobile/SDK_Ekyc_KMP</url>
   <dependencies>
     <dependency>
       <groupId>org.jetbrains.kotlin</groupId>
@@ -30,7 +30,7 @@
     <dependency>
       <groupId>finos.sdk.ekyc</groupId>
       <artifactId>sdkcore</artifactId>
-      <version>1.1.9</version>
+      <version>1.2.0</version>
       <scope>runtime</scope>
     </dependency>
   </dependencies>

package/android/SDKeKYC/finos/sdk/ekyc/c06/maven-metadata-local.xml

@@ -3,11 +3,11 @@
   <groupId>finos.sdk.ekyc</groupId>
   <artifactId>c06</artifactId>
   <versioning>
-    <latest>1.1.9</latest>
-    <release>1.1.9</release>
+    <latest>1.2.0</latest>
+    <release>1.2.0</release>
     <versions>
-      <version>1.1.9</version>
+      <version>1.2.0</version>
     </versions>
-    <lastUpdated>20250911071811</lastUpdated>
+    <lastUpdated>20250929062922</lastUpdated>
   </versioning>
 </metadata>