Merge pull request #425 from markhermano/feat/terminal-app-on-device-connection

feat(terminal): Implemented handoff connection type

Author: rdlabo

packages/terminal/README.md

@@ -83,6 +83,10 @@ And add next block to `android/app/build.gradle`.
 + apply plugin: 'kotlin-android'
 ```
 
+If you are developing apps for Stripe Android devices (e.g. Stripe Reader S700), follow the Stripe's documentation for the client-side setup.
+- [Stripe - Android configure your app](https://docs.stripe.com/terminal/features/apps-on-devices/build?terminal-sdk-platform=android&lang-android=java#setup-app)
+
+
 ## Usage
 
 ### Simple collect payment
@@ -1048,6 +1052,7 @@ addListener(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: (
 | **`Bluetooth`** | <code>'bluetooth'</code>  |
 | **`Usb`**       | <code>'usb'</code>        |
 | **`TapToPay`**  | <code>'tap-to-pay'</code> |
+| **`HandOff`**   | <code>'hand-off'</code>   |
 
 
 #### SimulateReaderUpdate

packages/terminal/android/build.gradle

@@ -8,6 +8,7 @@ ext {
     volleyVersion = project.hasProperty('volleyVersion') ? rootProject.ext.volleyVersion : '1.2.1'
     stripeterminalTapToPayVersion = project.hasProperty('stripeterminalTapToPayVersion') ? rootProject.ext.stripeterminalTapToPayVersion : '4.1.0'
     stripeterminalCoreVersion = project.hasProperty('stripeterminalCoreVersion') ? rootProject.ext.stripeterminalCoreVersion : '4.1.0'
+    stripeterminalHandoffClientVersion = project.hasProperty('stripeterminalHandoffClientVersion') ? rootProject.ext.stripeterminalHandoffClientVersion : '4.1.0'
 }
 
 buildscript {
@@ -71,6 +72,7 @@ dependencies {
 
     implementation "com.stripe:stripeterminal-core:$stripeterminalCoreVersion"
     implementation "com.stripe:stripeterminal-taptopay:$stripeterminalTapToPayVersion"
+    implementation "com.stripe:stripeterminal-handoffclient:$stripeterminalHandoffClientVersion"
     implementation "com.android.volley:volley:$volleyVersion"
     implementation "com.google.android.gms:play-services-wallet:$playServicesWalletVersion"
 }

packages/terminal/android/src/main/java/com/getcapacitor/community/stripe/terminal/StripeTerminal.kt

@@ -29,6 +29,7 @@ import com.stripe.stripeterminal.external.callable.PaymentIntentCallback
 import com.stripe.stripeterminal.external.callable.ReaderCallback
 import com.stripe.stripeterminal.external.callable.TapToPayReaderListener
 import com.stripe.stripeterminal.external.callable.TerminalListener
+import com.stripe.stripeterminal.external.callable.HandoffReaderListener
 import com.stripe.stripeterminal.external.models.BatteryStatus
 import com.stripe.stripeterminal.external.models.CardPresentDetails
 import com.stripe.stripeterminal.external.models.Cart
@@ -194,6 +195,9 @@ class StripeTerminal(
         ) {
             config = DiscoveryConfiguration.BluetoothDiscoveryConfiguration(0, this.isTest!!)
             this.terminalConnectType = TerminalConnectTypes.Bluetooth
+        } else if (call.getString("type") == TerminalConnectTypes.HandOff.webEventName) {
+            config = DiscoveryConfiguration.HandoffDiscoveryConfiguration()
+            this.terminalConnectType = TerminalConnectTypes.HandOff
         } else {
             call.unimplemented(call.getString("type") + " is not support now")
             return
@@ -240,6 +244,8 @@ class StripeTerminal(
             this.connectUsbReader(call)
         } else if (this.terminalConnectType == TerminalConnectTypes.Bluetooth) {
             this.connectBluetoothReader(call)
+        } else if (this.terminalConnectType == TerminalConnectTypes.HandOff) {
+            this.connectHandOffReader(call)
         } else {
             call.reject("type is not defined.")
         }
@@ -440,6 +446,39 @@ class StripeTerminal(
         Terminal.getInstance().connectReader(foundReader, config, this.readerCallback(call))
     }
 
+    private fun connectHandOffReader(call: PluginCall) {
+        val reader = call.getObject("reader")
+        val serialNumber = reader.getString("serialNumber")
+        val foundReader = this.discoveredReadersList.firstOrNull()
+
+        if (serialNumber == null || foundReader == null) {
+            call.reject("The reader value is not set correctly.")
+            return
+        }
+
+        val config: ConnectionConfiguration.HandoffConnectionConfiguration = ConnectionConfiguration.HandoffConnectionConfiguration(
+            this.handoffReaderListener
+        )
+
+        Terminal.getInstance().connectReader(foundReader, config, this.readerCallback(call))
+    }
+
+    var handoffReaderListener: HandoffReaderListener = object : HandoffReaderListener {
+        override fun onDisconnect(reason: DisconnectReason) {
+            notifyListeners(
+                TerminalEnumEvent.DisconnectedReader.webEventName,
+                JSObject().put("reason", reason.toString())
+            )
+        }
+
+        override fun onReportReaderEvent(event: ReaderEvent) {
+            notifyListeners(
+                TerminalEnumEvent.ReaderEvent.webEventName,
+                JSObject().put("event", event.toString())
+            )
+        }
+    }
+
     fun cancelDiscoverReaders(call: PluginCall) {
         if (discoveryCancelable == null || discoveryCancelable!!.isCompleted) {
             call.resolve()

packages/terminal/android/src/main/java/com/getcapacitor/community/stripe/terminal/TerminalConnectTypes.kt

@@ -6,4 +6,5 @@ enum class TerminalConnectTypes(val webEventName: String) {
     Bluetooth("bluetooth"),
     Usb("usb"),
     TapToPay("tap-to-pay"),
+    HandOff("hand-off"),
 }

packages/terminal/src/stripe.enum.ts

@@ -4,6 +4,7 @@ export enum TerminalConnectTypes {
   Bluetooth = 'bluetooth',
   Usb = 'usb',
   TapToPay = 'tap-to-pay',
+  HandOff = 'hand-off',
 }
 
 /**