@qore-id/react-native-qoreid-sdk 0.1.0-snapshot

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2023 Emmanuel Ugwuoke
+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

@@ -0,0 +1,127 @@
+# @qore-id/react-native-qoreid-sdk
+
+QoreID React Native SDK
+
+## Installation
+
+```sh
+npm install @qore-id/react-native-qoreid-sdk
+```
+
+```sh
+yarn add @qore-id/react-native-qoreid-sdk
+```
+
+### Android
+
+Add the following to your `app/build.gradle`
+```groovy
+    repositories {
+        ...
+        maven {
+            url "https://repo.qoreid.com/repository/maven-releases/"
+        }
+    }
+```
+
+### iOS
+
+You will be required to install WebView package if you don't already have it installed in your project.
+
+```sh
+npm i react-native-webview
+```
+
+
+
+
+## Usage 
+
+```tsx
+//verify.android.tsx
+import React from 'react'
+import { QoreIdButton } from '@qore-id/react-native-qoreid-sdk';
+
+
+function App() {
+ 
+    let clientId = /* CLIENT ID */
+    const customButton  = ({ onPress }) =>  <Button onPress={onPress} title="QoreId Button" />
+
+    const onError = (data) => {
+        console.error(data);
+        Alert.alert('Error', data);
+    };
+
+    const onSumitted = (data) => {
+        console.debug(data);
+        Alert.alert('Sumitted', data);
+    };
+
+    const onClosed = (data) => {
+        console.debug(data);
+        Alert.alert('Closed', data);
+    };
+
+    return (
+        <View>
+            {/* Other components */}
+            <QoreIdButton
+                title="Verify"
+                flowId=""
+                clientId={clientId} {/* Required */}
+                productCode="" {/* Required */}
+                customerReference={customerRef} {/* Required */}
+                applicantData={{
+                    firstName:"",
+                    middleName:"",
+                    lastName:"",
+                    gender:"",
+                    phoneNumber:"",
+                    email:"",
+                }}
+                identityData={{ idType: "", idNumber:"" }}
+                addressData={{
+                    address: "",
+                    city:"",
+                    lga:"",
+                }}
+                ocrAcceptedDocuments="DRIVERS_LICENSE_NGA,VOTERS_CARD_NGA,NIN_SLIP_NGA,PASSPORT_NGA"
+                onQoreIDSdkSubmitted={onSumitted}
+                onQoreIDSdkError={onError}
+                onQoreIDSdkClosed={onClosed}
+                render={customButton} {/* Only supported for iOS */}
+            />
+        </View>
+    )
+}
+
+```
+
+
+
+### Utilities
+
+QoreId SDK exposes utilities that you can easily use
+
+```tsx
+
+import React from 'react'
+import { QoreIdButton, utils } from '@qore-id/react-native-qoreid-sdk';
+
+function App() {
+
+   // Array of string
+   //For more information check -> https://docs.qoreid.com/docs/product-codes
+   const productIds = utils.productCodes; 
+
+
+   //An array of accepted documents in a specific country
+   //For more information check -> https://docs.qoreid.com/docs/ocr-accepted-documents#accepted-documents-for-ocr-verifications
+   const ocrLists = utils.acceptedDocuments["Nigeria"]
+    ...
+}
+
+```
+- Link to [doc/product-code]('https://docs.qoreid.com/docs/product-codes')
+- Link to [doc/accepted-documents]('https://docs.qoreid.com/docs/ocr-accepted-documents#accepted-documents-for-ocr-verifications')

package/android/build.gradle

@@ -0,0 +1,109 @@
+buildscript {
+    // Buildscript is evaluated before everything else so we can't use getExtOrDefault
+    def kotlin_version = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : project.properties["QoreidSdk_kotlinVersion"]
+    repositories {
+        google()
+        mavenCentral()
+    }
+
+
+    dependencies {
+        classpath "com.android.tools.build:gradle:7.2.1"
+        // noinspection DifferentKotlinGradleVersion
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+    }
+}
+
+def isNewArchitectureEnabled() {
+    return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+apply plugin: "maven-publish"
+
+
+def appProject = rootProject.allprojects.find { it.plugins.hasPlugin('com.android.application') }
+
+if (isNewArchitectureEnabled()) {
+    apply plugin: "com.facebook.react"
+}
+
+def getExtOrDefault(name) {
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties["QoreidSdk_" + name]
+}
+
+def getExtOrIntegerDefault(name) {
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["QoreidSdk_" + name]).toInteger()
+}
+
+android {
+    compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+    sourceSets {
+        main {
+            // ...
+            res.srcDirs = ['src/main/res']
+        }
+    }
+    defaultConfig {
+        minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+        targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+        buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+        multiDexEnabled true
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+        }
+        debug {
+            gradle.properties['isReleaseBuild'] = false
+        }
+    }
+
+    lintOptions {
+        disable "GradleCompatible"
+    }
+
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_1_8
+        targetCompatibility JavaVersion.VERSION_1_8
+    }
+
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+
+
+}
+
+repositories {
+    mavenCentral()
+    google()
+    mavenLocal()
+    maven { url "https://repo.qoreid.com/repository/maven-releases/" }
+    maven { url 'https://jitpack.io' }
+}
+
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
+
+dependencies {
+    // For < 0.71, this will be from the local maven repo
+    // For > 0.71, this will be replaced by `com.facebook.react:react-android:$version` by react gradle plugin
+    //noinspection GradleDynamicVersion
+    implementation 'com.qoreid:qoreid-sdk:1.0.1'
+    implementation 'com.google.android.material:material:1.7.0'
+    implementation "com.google.code.gson:gson:2.8.5"
+    implementation "com.facebook.react:react-native:+"
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+
+}
+
+
+if (isNewArchitectureEnabled()) {
+    react {
+        jsRootDir = file("../src/")
+        libraryName = "QoreidSdk"
+        codegenJavaPackageName = "com.qoreidsdk"
+    }
+}

package/android/gradle.properties

@@ -0,0 +1,9 @@
+QoreidSdk_kotlinVersion=1.7.0
+QoreidSdk_minSdkVersion=21
+QoreidSdk_targetSdkVersion=31
+QoreidSdk_compileSdkVersion=31
+QoreidSdk_ndkversion=21.4.7075529
+android.useAndroidX=true
+android.enableJetifier=true
+isReleaseBuild=true
+

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.qoreidsdk">
+
+</manifest>

package/android/src/main/java/com/qoreidsdk/QoreIdJSData.kt

@@ -0,0 +1,49 @@
+package com.qoreidsdk
+
+data class Config (
+  val flowId: Long? = 0,
+  val customerRef: String,
+  val productCode: String,
+  val clientId: String,
+)
+
+data class ApplicantData(
+  val firstName: String,
+  val lastName: String,
+  val phoneNumber: String,
+  val email: String,
+  val dob: String,
+  val gender: String,
+  val middleName:String
+)
+
+data class IdentityData(
+    val idType: String,
+    val idNumber: String,
+)
+
+data class AddressData(
+  val address: String,
+  val town: String,
+  val lga: String,
+  val city: String,
+  val state: String,
+  val region: String,
+  val district: String,
+  val virAddress: String
+)
+
+data class QoreIdJSData(
+  val config: Config,
+  val applicantData: ApplicantData,
+  val addressData: AddressData,
+  val acceptedDocuments: List<String>,
+  val identityData: IdentityData
+)
+
+
+data class StyleOptionsData (
+    val color:String,
+    val backgroundColor:String,
+    val title: String
+)

package/android/src/main/java/com/qoreidsdk/QoreIdReactButtonFragment.kt

@@ -0,0 +1,116 @@
+package com.qoreidsdk
+
+
+import android.graphics.Color
+import android.os.Bundle
+import android.util.Log
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import androidx.fragment.app.Fragment
+import com.google.gson.Gson
+import com.qoreid.sdk.core.QoreIDButton
+import com.qoreid.sdk.core.QoreIDParams
+import com.qoreid.sdk.core.models.AddressData
+import com.qoreid.sdk.core.models.ApplicantData
+
+
+class QoreIdReactButtonFragment : Fragment() {
+    private lateinit var qoredIdButton: QoreIDButton
+    var clientId: String = ""
+    var buttonPropsString: String = "";
+    private val gson = Gson()
+
+    override fun onCreateView(
+        inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?
+    ): View {
+        super.onCreateView(inflater, container, savedInstanceState)
+         qoredIdButton = QoreIDButton(requireContext())
+         qoredIdButton.setText("Launch QoreID")
+        if (buttonPropsString != "") {
+            val buttonProps = gson.fromJson(buttonPropsString, StyleOptionsData::class.java)
+            qoredIdButton.setText(buttonProps.title)
+
+        }
+
+
+        return qoredIdButton // this qoreIdButton could be any view that you want to render
+    }
+
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+        super.onViewCreated(view, savedInstanceState)
+
+        qoredIdButton
+            .params(
+                QoreIDParams()
+                    .clientId(clientId)
+            )
+
+    }
+
+
+    fun dataEventListener(jsonData: String) {
+        Log.i("QoredID Event", "listening")
+        Log.d("INITIALIze",::qoredIdButton.isInitialized.toString())
+        if (!::qoredIdButton.isInitialized) {
+            return
+        }
+
+        val qoreIdJSData = gson.fromJson(jsonData, QoreIdJSData::class.java)
+
+        Log.i("QOREIDPARAMS", qoreIdJSData.toString())
+
+        val config = qoreIdJSData.config
+        val apD = qoreIdJSData.applicantData
+        val applicantData = ApplicantData(
+            apD.firstName,
+            apD.lastName,
+            apD.phoneNumber,
+            apD.middleName,
+            apD.dob,
+            apD.dob,
+            apD.gender
+        )
+
+        val adD = qoreIdJSData.addressData
+        val addressData = AddressData(
+            adD.address,
+            adD.city,
+            adD.lga,
+            adD.state,
+        )
+
+
+        val qoreIDParams = if (config.flowId != 0L) {
+            QoreIDParams()
+                .clientId(config.clientId)
+                .customerReference(qoreIdJSData.config.customerRef)
+                .inputData(applicantData, addressData)
+                .ocrAcceptedDocuments(qoreIdJSData.acceptedDocuments)
+                .workflow(config.flowId!!)
+        } else {
+            QoreIDParams()
+                .clientId(config.clientId)
+                .customerReference(qoreIdJSData.config.customerRef)
+                .inputData(applicantData, addressData)
+                .ocrAcceptedDocuments(qoreIdJSData.acceptedDocuments)
+                .collection(config.productCode)
+        }
+
+        qoredIdButton
+            .params(qoreIDParams)
+
+    }
+
+    companion object {
+        private var instance: QoreIdReactButtonFragment? = null
+
+        fun getInstance(): QoreIdReactButtonFragment {
+            if (instance == null) {
+                instance = QoreIdReactButtonFragment()
+            }
+            return instance as QoreIdReactButtonFragment
+        }
+    }
+}
+

package/android/src/main/java/com/qoreidsdk/QoreIdReactButtonManager.kt

@@ -0,0 +1,168 @@
+package com.qoreidsdk
+
+
+import android.util.Log
+import android.view.Choreographer
+import android.view.View
+import android.view.ViewGroup
+import android.view.ViewTreeObserver
+import android.widget.FrameLayout
+import androidx.fragment.app.FragmentActivity
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.ReadableArray
+import com.facebook.react.uimanager.ThemedReactContext
+import com.facebook.react.uimanager.ViewGroupManager
+import com.facebook.react.uimanager.annotations.ReactPropGroup
+
+class QoreIdReactButtonManager(
+    private val reactContext: ReactApplicationContext
+) : ViewGroupManager<FrameLayout>() {
+    private var propWidth: Int? = null
+    private var propHeight: Int? = null
+
+    override fun getName() = REACT_CLASS
+
+    /**
+     * Return a FrameLayout which will later hold the Fragment
+     */
+    override fun createViewInstance(reactContext: ThemedReactContext): FrameLayout {
+        return FrameLayout(reactContext)
+    }
+
+
+    /**
+     * Map the "create, update" command to an integer
+     */
+    override fun getCommandsMap() = mapOf(
+        "create" to COMMAND_CREATE,
+        "update" to COMMAND_DATA_CHANGE,
+    )
+
+    /**
+     * Handle "create, update" command (called from JS) and call createFragment method
+     */
+    override fun receiveCommand(
+        root: FrameLayout, commandId: String, args: ReadableArray?
+    ) {
+        super.receiveCommand(root, commandId, args)
+
+
+        when (commandId.toInt()) {
+            COMMAND_CREATE -> {
+                val reactNativeViewId = requireNotNull(args).getInt(0)
+                var clientId = requireNotNull(args).getString(1)
+                var btnString = args?.getString(2) ?: ""
+
+                createFragment(root, reactNativeViewId, clientId, btnString)
+            }
+            COMMAND_DATA_CHANGE -> {
+                val data = requireNotNull(args).getString(0)
+                onDataChange(data);
+            }
+        }
+    }
+
+    @ReactPropGroup(names = ["width", "height"], customType = "Style")
+    fun setStyle(view: FrameLayout, index: Int, value: Int) {
+        if (index == 0) propWidth = value
+        if (index == 1) propHeight = value
+    }
+
+
+    /**
+     * Replace your React Native view with a custom fragment
+     */
+    fun createFragment(root: FrameLayout, reactNativeViewId: Int, clientId: String, btn: String?) {
+        val parentView = root.findViewById<ViewGroup>(reactNativeViewId)
+        setupLayout(parentView)
+
+        val mFragment = QoreIdReactButtonFragment.getInstance()
+        mFragment.clientId = clientId
+
+        if(btn != null) {
+            mFragment.buttonPropsString = btn
+        }
+        val activity = reactContext.currentActivity as FragmentActivity
+        activity.supportFragmentManager.beginTransaction()
+            .replace(reactNativeViewId, mFragment, reactNativeViewId.toString()).commit()
+
+        // Add an `OnGlobalLayoutListener` to the parent view to detect when the view is unmounted
+        parentView.viewTreeObserver.addOnGlobalLayoutListener(object :
+            ViewTreeObserver.OnGlobalLayoutListener {
+            override fun onGlobalLayout() {
+                // Remove the fragment if the parent view is no longer attached to the window or its parent
+                if (!parentView.isAttachedToWindow || parentView.parent == null) {
+                    val fragment =
+                        activity.supportFragmentManager.findFragmentById(reactNativeViewId)
+                    if (fragment != null) {
+                        activity.supportFragmentManager.beginTransaction().remove(fragment).commit()
+                    }
+                    parentView.viewTreeObserver.removeOnGlobalLayoutListener(this)
+
+                }
+            }
+        })
+
+        // Add an `OnAttachStateChangeListener` to the parent view to detect when the view is unmounted
+        parentView.addOnAttachStateChangeListener(object : View.OnAttachStateChangeListener {
+            override fun onViewAttachedToWindow(view: View) {
+                // Do nothing
+            }
+
+            override fun onViewDetachedFromWindow(view: View) {
+
+            }
+        })
+    }
+
+    // function for listening on that changes from RN app
+    fun onDataChange(str: String) {
+        val mFragment = QoreIdReactButtonFragment.getInstance()
+        mFragment.dataEventListener(str)
+    }
+
+    fun setupLayout(view: View) {
+        Choreographer.getInstance().postFrameCallback(object : Choreographer.FrameCallback {
+            override fun doFrame(frameTimeNanos: Long) {
+                manuallyLayoutChildren(view)
+                view.viewTreeObserver.dispatchOnGlobalLayout()
+                Choreographer.getInstance().postFrameCallback(this)
+            }
+        })
+    }
+
+    /**
+     * Layout all children properly
+     */
+    private fun manuallyLayoutChildren(view: View) {
+
+        // Get the parent view's dimensions
+        val parentWidth =
+            view.parent as? View ?: return // return if the parent is null or not a view
+        val width = parentWidth.width
+
+        val parentHeight =
+            view.parent as? View ?: return // return if the parent is null or not a view
+        val height = parentHeight.height
+
+        view.measure(
+            View.MeasureSpec.makeMeasureSpec(width, View.MeasureSpec.EXACTLY),
+            View.MeasureSpec.makeMeasureSpec(height, View.MeasureSpec.EXACTLY)
+        )
+
+        // Set the view's layout params to match parent width and height
+        val layoutParams = view.layoutParams
+        layoutParams.width = ViewGroup.LayoutParams.MATCH_PARENT
+        layoutParams.height = ViewGroup.LayoutParams.MATCH_PARENT
+        view.layoutParams = layoutParams
+
+        view.layout(0, 0, width, height)
+    }
+
+
+    companion object {
+        private const val REACT_CLASS = "QoreIdReactButtonManager"
+        private const val COMMAND_CREATE = 1
+        private const val COMMAND_DATA_CHANGE = 2
+    }
+}

package/android/src/main/java/com/qoreidsdk/QoreidSdkModule.kt

@@ -0,0 +1,88 @@
+package com.qoreidsdk
+
+
+
+import android.app.Activity
+import android.content.Intent
+import android.os.Build
+import com.facebook.react.bridge.*
+import com.facebook.react.modules.core.DeviceEventManagerModule
+import com.qoreid.sdk.core.QoreIdSdkKt.QORE_ID_RESULT_CODE
+import com.qoreid.sdk.core.QoreIdSdkKt.QORE_ID_RESULT_EXTRA_KEY
+import com.qoreid.sdk.core.models.ErrorResult
+import com.qoreid.sdk.core.models.QoreIDResult
+import com.qoreid.sdk.core.models.SuccessResult
+
+
+class QoreidSdkModule(val reactContext: ReactApplicationContext) :
+  ReactContextBaseJavaModule(reactContext) {
+
+  private var qoreIdResult: QoreIDResult? = null;
+
+  private val activityEventListener =
+    object : BaseActivityEventListener() {
+      override fun onActivityResult(
+        activity: Activity?,
+        requestCode: Int,
+        resultCode: Int,
+        intent: Intent?
+      ) {
+
+        if (resultCode == QORE_ID_RESULT_CODE && intent != null) {
+          qoreIdResult = if (Build.VERSION.SDK_INT < 33) {
+            intent.extras?.getSerializable(QORE_ID_RESULT_EXTRA_KEY) as QoreIDResult
+          } else {
+            intent.extras?.getSerializable(QORE_ID_RESULT_EXTRA_KEY, QoreIDResult::class.java)
+          }
+
+          processQoreIDResult(reactContext, qoreIdResult!!)
+        }
+      }
+    }
+
+  init {
+    reactContext.addActivityEventListener(activityEventListener)
+  }
+
+  override fun getName(): String {
+    return NAME
+  }
+
+
+fun processQoreIDResult(context: ReactContext, qoreIdResult: QoreIDResult) {
+    when (qoreIdResult) {
+      is ErrorResult -> {
+        // Handle error.
+        val event = Arguments.createMap().apply {
+          putString("code",  qoreIdResult.code.toString())
+          putString("data",  qoreIdResult.data.toString())
+          putString("message",  qoreIdResult.message)
+        }
+
+        sendEvent(context, "onResult", event)
+
+      }
+      is SuccessResult -> {
+        // Handle success.
+        val event = Arguments.createMap().apply {
+          putString("data",  qoreIdResult.data.toString())
+          putString("message",  qoreIdResult.message)
+        }
+
+        sendEvent(context, "onResult", event)
+      }
+    }
+  }
+
+
+  private fun sendEvent(reactContext: ReactContext, eventName: String, params: WritableMap?) {
+    reactContext
+      .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter::class.java)
+      .emit(eventName, params)
+  }
+
+  companion object {
+    const val NAME = "QoreidSdk"
+  }
+
+}