@finos_sdk/sdk-ekyc 1.2.1 → 1.2.8

package/LICENSE

@@ -4,18 +4,21 @@ 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
+in the Software **for both personal and commercial purposes**, 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:
+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.
+1. The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+2. The name “FinOS” or any related trademarks shall not be used to promote or
+   endorse products derived from this Software without prior written permission
+   from FinOS.
 
 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.
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL FinOS
+OR ITS CONTRIBUTORS 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

@@ -5,7 +5,7 @@
 
 React Native SDK for eKYC (electronic Know Your Customer) - Vietnamese CCCD NFC reading, OCR, Liveness detection, Face matching, and C06 residence verification.
 
-**Version**: 1.2.1
+**Version**: 1.2.8
 
 ## 🚀 Features
 
@@ -20,7 +20,7 @@ React Native SDK for eKYC (electronic Know Your Customer) - Vietnamese CCCD NFC
 
 ## 📱 Requirements
 
-- React Native 0.76+
+- React Native 0.77.0+
 - Android 24+ / API Level 24+ (Android platform only)
 - NFC and/or Camera hardware depending on modules used
 - Runtime permissions for Camera and/or NFC
@@ -28,9 +28,9 @@ React Native SDK for eKYC (electronic Know Your Customer) - Vietnamese CCCD NFC
 ## 🛠️ Installation
 
 ```bash
-npm install @finos_sdk/sdk-ekyc@1.2.1
+npm install @finos_sdk/sdk-ekyc
 # or
-yarn add @finos_sdk/sdk-ekyc@1.2.1
+yarn add @finos_sdk/sdk-ekyc
 ```
 
 ## 📖 Quick Start
@@ -145,39 +145,37 @@ Add permissions to `android/app/src/main/AndroidManifest.xml`:
 
 #### 3.2. Configure Gradle
 
-Add the SDK repository to `android/build.gradle`:
+The SDK automatically includes the GitHub Packages Maven repository. If using private Maven packages, configure GitHub credentials:
 
-```gradle
-buildscript {
-    ext {
-        buildToolsVersion = "35.0.0"
-        minSdkVersion = 24
-        compileSdkVersion = 35
-        targetSdkVersion = 34
-        ndkVersion = "26.1.10909125"
-        kotlinVersion = "1.9.25"
-    }
-    repositories {
-        google()
-        mavenCentral()
-        maven { url "https://www.jitpack.io" }
-    }
-    dependencies {
-        classpath("com.android.tools.build:gradle")
-        classpath("com.facebook.react:react-native-gradle-plugin")
-        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin")
-    }
-}
+**Option 1: Using gradle.properties (Recommended)**
 
-// Add this section
-allprojects {
+Add to `~/.gradle/gradle.properties`:
+```properties
+gpr.user=your-github-username
+gpr.key=your-github-token
+```
+
+**Option 2: Using Environment Variables**
+
+```bash
+export GITHUB_USER=your-github-username
+export GITHUB_TOKEN=your-github-token
+```
+
+The SDK's `android/build.gradle` and `android/settings.gradle` are already configured to use GitHub Packages Maven repository:
+
+```gradle
     repositories {
         google()
         mavenCentral()
         mavenLocal()
-        // Add Finos SDK local repository
+    
+    // GitHub Packages for FINOS eKYC SDK
         maven { 
-            url uri("file://${rootProject.projectDir}/../node_modules/@finos_sdk/sdk-ekyc/android/SDKeKYC") 
+        url = uri("https://maven.pkg.github.com/finosvn/finos.ekyc.sdk")
+        credentials {
+            username = project.findProperty("gpr.user") ?: System.getenv("GITHUB_USER")
+            password = project.findProperty("gpr.key") ?: System.getenv("GITHUB_TOKEN")
         }
     }
 }
@@ -475,7 +473,7 @@ const toggleLanguage = () => {
 
 - **UI Integration Guide**: [Complete eKYC Flow Guide](./Document/DOC_eKYC_SDK_UI_ReactNative_Integration.md)
 - **Module Guide**: [Individual Module Integration](./Document/DOC_eKYC_SDK_ReactNative_Integration.md)
-- **Issues**: [GitHub Issues](https://github.com/finos/sdk-ekyc/issues)
+- **Issues**: [GitHub Issues](https://github.com/finosvn/finos.ekyc.sdk/issues)
 - **Contact**: SDK provider for app key registration and support
 
 ## 📄 License
@@ -484,20 +482,21 @@ MIT License - see [LICENSE](LICENSE) file for details.
 
 ## 🔄 Migration Guide
 
-### From Version 0.0.30 to 1.2.1
+### From Version 0.0.30 to 1.2.8
 
 **New Features:**
 - Unified `FinosEKYC.startEkycUI()` method for complete flows
 - Flexible module configuration
 - Enhanced styling options
 - Better error handling
+- GitHub Packages Maven repository integration (no local files required)
 
 **Migration Steps:**
-1. Update installation to version 1.2.1
-2. Add Gradle repository configuration (see Android Setup)
+1. Update installation to version 1.2.8
+2. Configure GitHub credentials for Maven repository (see Android Setup)
 3. Update import statement to use `FinosEKYC` class
 4. Consider using `startEkycUI` instead of individual modules
-5. Update React Native requirement to 0.76+
+5. Update React Native requirement to 0.77.0+
 
 **Before (0.0.30):**
 ```typescript
@@ -508,7 +507,7 @@ SdkEkyc.onNfcScanSuccess((data) => { ... });
 await SdkEkyc.startNfcScan(config);
 ```
 
-**After (1.2.1):**
+**After (1.2.8):**
 ```typescript
 import { FinosEKYC } from '@finos_sdk/sdk-ekyc';
 
@@ -537,19 +536,19 @@ If migrating from the native Android SDK:
 ## 📦 Package Information
 
 - **Package**: `@finos_sdk/sdk-ekyc`
-- **Version**: 1.2.1
+- **Version**: 1.2.8
 - **Platform**: Android (iOS support planned)
-- **React Native**: 0.76+
+- **React Native**: 0.77.0+
 - **License**: MIT
-- **Repository**: [GitHub](https://github.com/finos/sdk-ekyc)
+- **Repository**: [GitHub](https://github.com/finosvn/finos.ekyc.sdk)
 
-## 🆕 What's New in v1.2.1
+## 🆕 What's New in v1.2.8
 
 - ✨ Unified `startEkycUI` method for complete eKYC flows
 - 🎨 Enhanced UI customization with `styleConfig`
 - ⚙️ Flexible module configuration (single or multiple modules)
 - 🔧 Improved error handling and debugging
-- 📦 Better dependency management with local repository support
-- 🏗️ Updated Android build configuration for React Native 0.76+
+- 📦 Better dependency management with GitHub Packages Maven repository
+- 🏗️ Updated Android build configuration for React Native 0.77.0+
 - 🌐 Multi-language support (Vietnamese & English)
 - 🔄 Configurable retry options

package/android/build.gradle

@@ -1,20 +1,43 @@
-// Top-level build file where you can add configuration options common to all sub-projects/modules.
-
-plugins {
-    id 'com.android.library'
-    id 'org.jetbrains.kotlin.android'
+buildscript {
+    ext.kotlinVersion = "2.0.21"
+    repositories {
+        google()
+        mavenCentral()
+        gradlePluginPortal()
+    }
+    dependencies {
+        classpath("com.android.tools.build:gradle:8.7.3")
+        classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion")
+    }
 }
 
+apply plugin: 'com.android.library'
+apply plugin: 'org.jetbrains.kotlin.android'
+
 android {
     namespace 'finos.sdk.ekyc'
     compileSdk 35
 
+    sourceSets {
+        main {
+            java.srcDirs = ['src/main/java']
+        }
+    }
+
     defaultConfig {
         minSdkVersion 24
         targetSdkVersion 34
         consumerProguardFiles 'consumer-rules.pro'
     }
 
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+
+    // Don't set kotlinOptions.languageVersion - let React Native plugin manage it
+    // React Native plugin will automatically configure Kotlin languageVersion
+
     buildTypes {
         release {
             minifyEnabled false
@@ -27,23 +50,33 @@ repositories {
     google()
     mavenCentral()
     mavenLocal()
-    maven { url uri("file://${projectDir}/SDKeKYC") }
+    
+    // GitHub Packages for FINOS eKYC SDK
+    maven {
+        url = uri("https://maven.pkg.github.com/finosvn/finos.ekyc.sdk")
+        credentials {
+            username = project.findProperty("gpr.user") ?: System.getenv("GITHUB_USER")
+            password = project.findProperty("gpr.key") ?: System.getenv("GITHUB_TOKEN")
+        }
+    }
 }
 
 dependencies {
-    // React Native
     implementation 'com.facebook.react:react-android'
 
-    // Finos eKYC SDK dependencies
-    implementation("finos.sdk.ekyc:ekyc:1.2.0")
-    implementation("finos.sdk.ekyc:ekycui:1.2.0")
-    implementation("finos.sdk.ekyc:nfc:1.2.0")
-    implementation("finos.sdk.ekyc:ocr:1.2.0")
-    implementation("finos.sdk.ekyc:liveness:1.2.0")
-    implementation("finos.sdk.ekyc:faceservice:1.2.0")
-    implementation("finos.sdk.ekyc:c06:1.2.0")
-    implementation("finos.sdk.ekyc:sdkcore:1.2.0")
-    implementation("finos.sdk.ekyc:sdkcorecamera:1.2.0")
-    implementation("finos.sdk.ekyc:sdkui:1.2.0")
-    implementation("finos.sdk.ekyc:qrcode:1.2.0")
-}
+    // Finos eKYC SDK dependencies from GitHub Packages Maven repository
+    def sdkVersion = "1.2.8"
+    implementation("finos.sdk.ekyc:ekyc:$sdkVersion")
+    implementation("finos.sdk.ekyc:ekycui:$sdkVersion")
+    implementation("finos.sdk.ekyc:nfc:$sdkVersion")
+    implementation("finos.sdk.ekyc:ocr:$sdkVersion")
+    implementation("finos.sdk.ekyc:liveness:$sdkVersion")
+    implementation("finos.sdk.ekyc:faceservice:$sdkVersion")
+    implementation("finos.sdk.ekyc:c06:$sdkVersion")
+    implementation("finos.sdk.ekyc:sdkcore:$sdkVersion")
+    implementation("finos.sdk.ekyc:sdkcorecamera:$sdkVersion")
+    implementation("finos.sdk.ekyc:sdkui:$sdkVersion")
+    implementation("finos.sdk.ekyc:qrcode:$sdkVersion")
+    implementation("finos.sdk.ekyc:smsotp:$sdkVersion")
+    implementation("finos.sdk.ekyc:esign:$sdkVersion")
+}

package/android/gradle.properties

@@ -44,4 +44,10 @@ compileSdkVersion=35
 targetSdkVersion=34
 minSdkVersion=24
 buildToolsVersion=35.0.0
-ndkVersion=26.1.10909125
+ndkVersion=27.0.12077973
+
+# GitHub Packages credentials for FINOS eKYC SDK
+# Set these values in your ~/.gradle/gradle.properties or as environment variables:
+gpr.user=SDK_eKYC
+gpr.key=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
+# Or use environment variables: GITHUB_USER and GITHUB_TOKEN

package/android/settings.gradle

@@ -0,0 +1,53 @@
+pluginManagement {
+  includeBuild("../node_modules/@react-native/gradle-plugin")
+  repositories {
+    gradlePluginPortal()
+    mavenCentral()
+    mavenLocal()
+    google()
+    
+    // GitHub Packages for FINOS eKYC SDK
+    maven {
+      url = uri("https://maven.pkg.github.com/finosvn/finos.ekyc.sdk")
+      credentials {
+        def props = new Properties()
+        def propsFile = file("gradle.properties")
+        if (propsFile.exists()) {
+          propsFile.withInputStream { props.load(it) }
+        }
+        username = props.getProperty("gpr.user") ?: System.getenv("GITHUB_USER") ?: "SDK_eKYC"
+        password = props.getProperty("gpr.key") ?: System.getenv("GITHUB_TOKEN") ?: "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"
+      }
+    }
+  }
+}
+plugins { id("com.facebook.react.settings") }
+extensions.configure(com.facebook.react.ReactSettingsExtension){ ex -> ex.autolinkLibrariesFromCommand() }
+
+dependencyResolutionManagement {
+  repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
+  repositories {
+    google()
+    mavenCentral()
+    mavenLocal()
+    
+    // GitHub Packages for FINOS eKYC SDK
+    maven {
+      url = uri("https://maven.pkg.github.com/finosvn/finos.ekyc.sdk")
+      credentials {
+        def props = new Properties()
+        def propsFile = file("gradle.properties")
+        if (propsFile.exists()) {
+          propsFile.withInputStream { props.load(it) }
+        }
+        username = props.getProperty("gpr.user") ?: System.getenv("GITHUB_USER") ?: "SDK_eKYC"
+        password = props.getProperty("gpr.key") ?: System.getenv("GITHUB_TOKEN") ?: "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"
+      }
+    }
+  }
+}
+rootProject.name = 'finosSDKeKYC'
+include ':app'
+include ':src:main'
+project(':src:main').projectDir = new File(rootProject.projectDir, 'src/main')
+includeBuild('../node_modules/@react-native/gradle-plugin')