@primer-io/react-native 2.37.1 → 2.39.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Primer Ltd.
+
+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,149 @@
+<h1 align="center">Primer React Native SDK</h1>
+
+<h3 align="center">
+
+Official React Native SDK plugin for [Primer](https://primer.io)
+
+</h3>
+
+<p align="center">
+<img src="https://img.shields.io/npm/v/@primer-io/react-native" />
+</p>
+
+**Note:** This quick start guide addresses the platform-specific integration points only. As everything prior to that (e.g. creating a client token) is the same for all the guidelines.
+
+# Set up the Universal Checkout
+
+## Step 1. Install the SDK
+
+Add the SDK package.
+
+```sh
+\# With yarn
+yarn add @primer-io/react-native
+
+\# With npm
+npm i @primer-io/react-native --save
+```
+
+Once you are done, navigate to the \/ios folder and run pod install.
+
+## Step 2. Initialize the SDK
+
+Import the Primer SDK, construct your settings and call the SDK’s configure function.
+
+```js
+import * as React from 'react';
+import {
+  Primer,  
+  PrimerSettings,
+  PrimerCheckoutData
+} from '@primer-io/react-native';
+
+const CheckoutScreen = (props: any) => {
+
+  const onCheckoutComplete = (checkoutData: PrimerCheckoutData) => {
+    // Perform an action based on the payment creation response
+    // ex. show success screen, redirect to order confirmation view, etc.
+  };
+
+  React.useEffect(() => {
+    const settings: PrimerSettings = {
+      onCheckoutComplete: onCheckoutComplete
+    };
+
+    Primer.configure(settings)
+      .then(() => {
+        // SDK is initialized sucessfully
+      })
+      .catch (err => {
+        // SDK failed to initialize
+      })
+  }, []);
+}
+```
+
+## Step 3. Generate a client token
+
+**Note:** Check our guide on how to set up the client session [here](https://primer.io/docs/accept-payments/manage-client-sessions).
+
+Make an API call to your backend to fetch a Client Token. Here is a simple example of how it can be done from your component. Once successful store your Client Token for future use.
+
+```js
+const CheckoutScreen = (props: any) => {
+
+  // ...
+
+  const onUniversalCheckoutButtonTapped = async () => {
+    try {
+      // Make an API request to your backend to create a client session
+      // and fetch a client token.
+      const clientToken = await createClientSession(clientSessionRequestParams);
+    } catch (err) {
+      // ...
+    }
+  };
+}
+```
+
+## Step 4. Show Universal Checkout
+
+At this step, you should have a Client Token available. Call the `showUniversalCheckout(clientToken)` function, with the Client Token (as shown below) to present Universal Checkout.
+
+```js
+const CheckoutScreen = (props: any) => {
+
+  // ...
+
+  const onUniversalCheckoutButtonTapped = async () => {
+    try {
+      // ...
+
+      // Present Universal Checkout
+      await Primer.showUniversalCheckout(clientToken);
+    } catch (err) {
+      // ...
+    }
+  };
+}
+```
+
+## Full Code Snippet
+
+```js
+import * as React from 'react';
+import {
+  Primer,  
+  PrimerSettings,
+  PrimerCheckoutData
+} from '@primer-io/react-native';
+
+const CheckoutScreen = async (props: any) => {
+  const onCheckoutComplete = (checkoutData: PrimerCheckoutData) => {
+    // Show a success screen
+  };
+  
+  const onUniversalCheckoutButtonTapped = async () => {
+    const settings: PrimerSettings = {
+      onCheckoutComplete: onCheckoutComplete
+    };
+    
+    // Configure the SDK
+    await Primer.configure(settings);
+    
+    // Ask your backend to create a client session
+    const clientToken = await createClientSession(clientSessionRequestParams);
+    
+    // Present Universal Checkout
+    await Primer.showUniversalCheckout(clientToken);
+  };
+}
+```
+
+You should now be able to see Universal Checkout! The user can now interact with Universal Checkout, and the SDK will create the payment. The payment’s data will be returned in the onCheckoutComplete callback configured in Step 2.
+
+**Note:** For more info & help troubleshooting, check out our [docs](http://primer.io/docs).
+
+## 📚 License
+
+Distributed under the MIT License. See [LICENSE](./LICENSE) for more information.

package/android/build.gradle

@@ -12,7 +12,7 @@ buildscript {
   }
 
   dependencies {
-    classpath 'com.android.tools.build:gradle:8.12.1'
+    classpath 'com.android.tools.build:gradle:8.13.0'
     // noinspection DifferentKotlinGradleVersion
     classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     classpath "org.jetbrains.kotlin:kotlin-serialization:$kotlin_version"
@@ -23,6 +23,7 @@ buildscript {
 
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
+apply plugin: "com.facebook.react"
 apply plugin: 'kotlinx-serialization'
 apply plugin: 'io.gitlab.arturbosch.detekt'
 apply from: "./config/coverage-scripts/kover.gradle"
@@ -35,6 +36,10 @@ def getExtOrIntegerDefault(name) {
   return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties['ReactNative_' + name]).toInteger()
 }
 
+def isNewArchitectureEnabled() {
+  return project.hasProperty("newArchEnabled") && project.newArchEnabled == "true"
+}
+
 java {
   toolchain {
     languageVersion.set(JavaLanguageVersion.of(17))
@@ -48,6 +53,7 @@ android {
   defaultConfig {
     minSdkVersion 21
     targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
+    buildConfigField("boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString())
 
     testInstrumentationRunnerArguments runnerBuilder: 'de.mannodermaus.junit5.AndroidJUnit5Builder'
     testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -79,99 +85,49 @@ android {
       useJUnitPlatform()
     }
   }
+
+  sourceSets {
+    main {
+      java.srcDirs += [
+        "generated/java",
+        "generated/jni"
+      ]
+
+      if (isNewArchitectureEnabled()) {
+        java.srcDirs += ['src/newarch']
+      } else {
+        java.srcDirs += ['src/oldarch']
+      }
+    }
+  }
 }
 
 repositories {
   mavenLocal()
   mavenCentral()
   google()
-
-  def found = false
-  def defaultDir = null
-  def androidSourcesName = 'React Native sources'
-
-  if (rootProject.ext.has('reactNativeAndroidRoot')) {
-    defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
-  } else {
-    defaultDir = new File(
-      projectDir,
-      '/../../../node_modules/react-native/android'
-    )
-  }
-
-  if (defaultDir.exists()) {
-    maven {
-      url defaultDir.toString()
-      name androidSourcesName
-    }
-
-    logger.info(":${project.name}:reactNativeAndroidRoot ${defaultDir.canonicalPath}")
-    found = true
-  } else {
-    def parentDir = rootProject.projectDir
-
-    1.upto(5, {
-      if (found) return true
-      parentDir = parentDir.parentFile
-
-      def androidSourcesDir = new File(
-        parentDir,
-        'node_modules/react-native'
-      )
-
-      def androidPrebuiltBinaryDir = new File(
-        parentDir,
-        'node_modules/react-native/android'
-      )
-
-      if (androidPrebuiltBinaryDir.exists()) {
-        maven {
-          url androidPrebuiltBinaryDir.toString()
-          name androidSourcesName
-        }
-
-        logger.info(":${project.name}:reactNativeAndroidRoot ${androidPrebuiltBinaryDir.canonicalPath}")
-        found = true
-      } else if (androidSourcesDir.exists()) {
-        maven {
-          url androidSourcesDir.toString()
-          name androidSourcesName
-        }
-
-        logger.info(":${project.name}:reactNativeAndroidRoot ${androidSourcesDir.canonicalPath}")
-        found = true
-      }
-    })
-  }
-
-  if (!found) {
-    throw new GradleException(
-      "${project.name}: unable to locate React Native android sources. " +
-        "Ensure you have you installed React Native as a dependency in your project and try again."
-    )
-  }
 }
 
 detekt {
-    buildUponDefaultConfig = true
-    def defaultConfig = file("$rootDir/tooling/code-analysis/detekt.yml")
+  buildUponDefaultConfig = true
+  def defaultConfig = file("$rootDir/tooling/code-analysis/detekt.yml")
 
-    if (defaultConfig.exists()) {
-      config.setFrom(files(defaultConfig))
-    }
+  if (defaultConfig.exists()) {
+    config.setFrom(files(defaultConfig))
+  }
 
-    debug = true
-    parallel = true
-    disableDefaultRuleSets = false
+  debug = true
+  parallel = true
+  disableDefaultRuleSets = false
 
-    ignoredBuildTypes = ["debug"]
+  ignoredBuildTypes = ["debug"]
 
-    reports {
-        html.required.set(true)
-        xml.required.set(false)
-        txt.required.set(true)
-        sarif.required.set(true)
-    }
+  reports {
+    html.required.set(true)
+    xml.required.set(true)
+    txt.required.set(true)
+    sarif.required.set(true)
+  }
 }
 
 def kotlin_version = getExtOrDefault('kotlinVersion')
@@ -179,10 +135,10 @@ def kotlin_version = getExtOrDefault('kotlinVersion')
 dependencies {
   detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.23.8")
   // noinspection GradleDynamicVersion
-  api 'com.facebook.react:react-native:+'
+  implementation 'com.facebook.react:react-native:+'
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
   implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3"
-  implementation 'io.primer:android:2.43.0'
+  implementation 'io.primer:android:2.44.1'
   testImplementation 'io.mockk:mockk:1.14.2'
   testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.2'
   testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.2'

package/android/src/main/java/com/primerioreactnative/{PrimerRN.kt → DefaultNativePrimerModule.kt}

@@ -4,10 +4,7 @@ import android.util.Log
 import com.facebook.react.bridge.Arguments
 import com.facebook.react.bridge.Promise
 import com.facebook.react.bridge.ReactApplicationContext
-import com.facebook.react.bridge.ReactContextBaseJavaModule
-import com.facebook.react.bridge.ReactMethod
 import com.facebook.react.bridge.WritableMap
-import com.facebook.react.modules.core.DeviceEventManagerModule
 import com.primerioreactnative.datamodels.ErrorTypeRN
 import com.primerioreactnative.datamodels.PrimerCheckoutDataRN
 import com.primerioreactnative.datamodels.PrimerErrorRN
@@ -18,100 +15,142 @@ import com.primerioreactnative.utils.PrimerImplementedRNCallbacks
 import com.primerioreactnative.utils.errorTo
 import com.primerioreactnative.utils.toWritableMap
 import io.primer.android.Primer
+import io.primer.android.PrimerSessionIntent
 import io.primer.android.data.settings.PrimerSettings
-import kotlinx.serialization.decodeFromString
 import kotlinx.serialization.encodeToString
 import kotlinx.serialization.json.Json
 import org.json.JSONObject
 
 @Suppress("TooManyFunctions")
-class PrimerRN(private val reactContext: ReactApplicationContext, private val json: Json) :
-    ReactContextBaseJavaModule(reactContext) {
+internal open class DefaultNativePrimerModule(
+    private val reactContext: ReactApplicationContext,
+    private val json: Json,
+    private val eventSender: (String, WritableMap) -> Unit,
+) {
     private val mListener = PrimerRNEventListener()
 
     init {
         mListener.sendEvent = { eventName, paramsJson -> sendEvent(eventName, paramsJson) }
         mListener.sendError = { paramsJson -> onError(paramsJson) }
-        mListener.sendErrorWithCheckoutData =
-            { paramsJson, checkoutData -> onError(paramsJson, checkoutData) }
+        mListener.sendErrorWithCheckoutData = { paramsJson, checkoutData -> onError(paramsJson, checkoutData) }
         mListener.onDismissedEvent = { Primer.instance.dismiss(true) }
     }
 
-    override fun getName(): String = "NativePrimer"
+    open fun sendEvent(
+        name: String,
+        params: WritableMap,
+    ) = eventSender(name, params)
+
+    open fun sendEvent(
+        name: String,
+        data: JSONObject?,
+    ) = eventSender(name, prepareData(data))
+
+    fun getName(): String {
+        return NAME
+    }
 
-    @ReactMethod
     fun configure(
-        settingsStr: String,
+        settingsStr: String?,
         promise: Promise,
     ) {
         try {
-            Log.d("PrimerRN", "settings: $settingsStr")
-            val settings =
-                if (settingsStr.isBlank()) {
-                    PrimerSettingsRN()
-                } else {
-                    json.decodeFromString(
-                        settingsStr,
-                    )
-                }
+            val settings = if (settingsStr.isNullOrBlank()) {
+                PrimerSettingsRN()
+            } else {
+                json.decodeFromString(
+                    settingsStr,
+                )
+            }
             startSdk(settings.toPrimerSettings(reactContext))
             promise.resolve(null)
-        } catch (e: Exception) {
-            Log.e("PrimerRN", "configure settings error: $e")
+        } catch (expected: Exception) {
+            Log.e("PrimerRN", "configure settings error: $expected")
             val exception = ErrorTypeRN.NativeBridgeFailed errorTo "failed to parse settings."
             onError(exception)
-            promise.reject(exception.errorId, exception.description, e)
+            promise.reject(exception.errorId, exception.description, expected)
         }
     }
 
-    @ReactMethod
     fun showUniversalCheckoutWithClientToken(
         clientToken: String,
         promise: Promise,
     ) {
         try {
-            Primer.instance.showUniversalCheckout(reactApplicationContext.applicationContext, clientToken)
+            Primer.instance.showUniversalCheckout(
+                reactContext.applicationContext,
+                clientToken,
+            )
             promise.resolve(null)
-        } catch (e: Exception) {
-            val exception =
-                ErrorTypeRN.NativeBridgeFailed errorTo
-                    "Primer SDK failed: ${e.message}"
+        } catch (expected: Exception) {
+            val exception = ErrorTypeRN.NativeBridgeFailed errorTo "Primer SDK failed: ${expected.message}"
             onError(exception)
-            promise.reject(exception.errorId, exception.description, e)
+            promise.reject(exception.errorId, exception.description, expected)
         }
     }
 
-    @ReactMethod
     fun showVaultManagerWithClientToken(
         clientToken: String,
         promise: Promise,
     ) {
         try {
-            Primer.instance.showVaultManager(reactApplicationContext.applicationContext, clientToken)
+            Primer.instance.showVaultManager(
+                reactContext.applicationContext,
+                clientToken,
+            )
             promise.resolve(null)
-        } catch (e: Exception) {
-            val exception =
-                ErrorTypeRN.NativeBridgeFailed errorTo
-                    "Primer SDK failed: ${e.message}"
+        } catch (expected: Exception) {
+            val exception = ErrorTypeRN.NativeBridgeFailed errorTo "Primer SDK failed: ${expected.message}"
             onError(exception)
-            promise.reject(exception.errorId, exception.description, e)
+            promise.reject(exception.errorId, exception.description, expected)
+        }
+    }
+
+    fun showPaymentMethod(
+        paymentMethod: String,
+        intent: String,
+        clientToken: String,
+        promise: Promise,
+    ) {
+        try {
+            if (PrimerSessionIntent.entries.firstOrNull { intent.equals(it.name, true) } == null) {
+                val exception = PrimerErrorRN(
+                    errorId = ErrorTypeRN.NativeBridgeFailed.errorId,
+                    errorCode = null,
+                    description = "Invalid value for 'intent'.",
+                    diagnosticsId = null,
+                    recoverySuggestion = "'intent' can be 'CHECKOUT' or 'VAULT'.",
+                )
+                promise.reject(exception.errorId, exception.description)
+            } else {
+                Primer.instance.showPaymentMethod(
+                    reactContext.applicationContext,
+                    clientToken,
+                    paymentMethod,
+                    PrimerSessionIntent.entries.first {
+                        intent.equals(it.name, ignoreCase = true)
+                    },
+                )
+                promise.resolve(null)
+            }
+        } catch (expected: Exception) {
+            val exception = ErrorTypeRN.NativeBridgeFailed errorTo "Primer SDK failed: ${expected.message}"
+            onError(exception)
+            promise.reject(exception.errorId, exception.description, expected)
         }
     }
 
-    @ReactMethod
     fun dismiss(promise: Promise) {
         Primer.instance.dismiss(true)
         promise.resolve(null)
     }
 
-    @ReactMethod
     fun cleanUp(promise: Promise) {
         Primer.instance.dismiss(true)
         promise.resolve(null)
     }
 
     // region tokenization handlers
-    @ReactMethod
     fun handleTokenizationNewClientToken(
         newClientToken: String,
         promise: Promise,
@@ -120,13 +159,11 @@ class PrimerRN(private val reactContext: ReactApplicationContext, private val js
         promise.resolve(null)
     }
 
-    @ReactMethod
     fun handleTokenizationSuccess(promise: Promise) {
         mListener.handleTokenizationSuccess()
         promise.resolve(null)
     }
 
-    @ReactMethod
     fun handleTokenizationFailure(
         errorMessage: String?,
         promise: Promise,
@@ -137,8 +174,7 @@ class PrimerRN(private val reactContext: ReactApplicationContext, private val js
     // endregion
 
     // region resume handlers
-    @ReactMethod
-    fun handleResumeNewClientToken(
+    fun handleResumeWithNewClientToken(
         newClientToken: String,
         promise: Promise,
     ) {
@@ -146,13 +182,11 @@ class PrimerRN(private val reactContext: ReactApplicationContext, private val js
         promise.resolve(null)
     }
 
-    @ReactMethod
     fun handleResumeSuccess(promise: Promise) {
         mListener.handleResumeSuccess()
         promise.resolve(null)
     }
 
-    @ReactMethod
     fun handleResumeFailure(
         errorMessage: String?,
         promise: Promise,
@@ -163,13 +197,11 @@ class PrimerRN(private val reactContext: ReactApplicationContext, private val js
     // endregion
 
     // region payment handlers
-    @ReactMethod
     fun handlePaymentCreationContinue(promise: Promise) {
         mListener.handlePaymentCreationContinue()
         promise.resolve(null)
     }
 
-    @ReactMethod
     fun handlePaymentCreationAbort(
         errorMessage: String?,
         promise: Promise,
@@ -180,7 +212,6 @@ class PrimerRN(private val reactContext: ReactApplicationContext, private val js
     // endregion
 
     // region error handlers
-    @ReactMethod
     fun showErrorMessage(
         errorMessage: String?,
         promise: Promise,
@@ -190,31 +221,23 @@ class PrimerRN(private val reactContext: ReactApplicationContext, private val js
     }
     // endregion
 
-    @ReactMethod
     fun setImplementedRNCallbacks(
         implementedRNCallbacksStr: String,
         promise: Promise,
     ) {
         try {
             Log.d("PrimerRN", "implementedRNCallbacks: $implementedRNCallbacksStr")
-            val implementedRNCallbacks =
-                json.decodeFromString<PrimerImplementedRNCallbacks>(implementedRNCallbacksStr)
+            val implementedRNCallbacks = json.decodeFromString<PrimerImplementedRNCallbacks>(implementedRNCallbacksStr)
             this.mListener.setImplementedCallbacks(implementedRNCallbacks)
             promise.resolve(null)
-        } catch (e: Exception) {
+        } catch (expected: Exception) {
             val exception =
                 ErrorTypeRN.NativeBridgeFailed errorTo "Implemented callbacks $implementedRNCallbacksStr is not valid."
             onError(exception)
-            promise.reject(exception.errorId, exception.description, e)
+            promise.reject(exception.errorId, exception.description, expected)
         }
     }
 
-    @ReactMethod
-    fun addListener(eventName: String?) = Unit
-
-    @ReactMethod
-    fun removeListeners(count: Int?) = Unit
-
     private fun startSdk(settings: PrimerSettings) {
         Primer.instance.configure(settings, mListener)
     }
@@ -235,28 +258,13 @@ class PrimerRN(private val reactContext: ReactApplicationContext, private val js
         sendEvent(PrimerEvents.ON_ERROR.eventName, params)
     }
 
-    private fun sendEvent(
-        name: String,
-        params: WritableMap,
-    ) {
-        reactApplicationContext.getJSModule(
-            DeviceEventManagerModule.RCTDeviceEventEmitter::class.java,
-        ).emit(name, params)
-    }
-
-    private fun sendEvent(
-        name: String,
-        data: JSONObject?,
-    ) {
-      val params = prepareData(data)
-      reactContext.getJSModule(
-            DeviceEventManagerModule.RCTDeviceEventEmitter::class.java,
-        ).emit(name, params)
-    }
-
     private fun prepareData(data: JSONObject?): WritableMap {
         return data.toWritableMap()
     }
+
+    companion object Companion {
+        const val NAME = "NativePrimer"
+    }
 }
 
 internal object Keys {