@capacitor-community/stripe-terminal 5.1.0 → 5.3.0

package/CapacitorCommunityStripeTerminal.podspec

@@ -13,6 +13,6 @@ Pod::Spec.new do |s|
   s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target  = '13.0'
   s.dependency 'Capacitor'
-  s.dependency 'StripeTerminal'
+  s.dependency 'StripeTerminal', '~> 2.17.1'
   s.swift_version = '5.1'
 end

package/README.md

@@ -24,11 +24,11 @@ npx cap sync
 Add permissions to your `android/app/src/main/AndroidManifest.xml` file:
 
 ```diff
-+ <uses-permission android:name="android.permission.BLUETOOTH" />
-+ <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
-+ <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
-+ <uses-permission android:name="android.permission.BLUETOOTH_ADVERTISE" />
++ <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
++ <uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
++ <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30" />
 + <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
++ <uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
 ```
 
 If used in conjunction with the `@capacitor-community/stripe` plugin, the following settings may be necessary
@@ -44,6 +44,35 @@ android {
 }
 ```
 
+And update minSdkVersion to 26 And compileSdkVersion to 34 in your `android/app/build.gradle` file:
+
+```diff
+  ext {
+-    minSdkVersion = 22
+-    compileSdkVersion = 33
++    minSdkVersion = 26
++    compileSdkVersion = 34
+```
+
+## Usage
+
+```typescript
+(async ()=> {
+  /**
+   * tokenProviderEndpoint: The URL of your backend to provide a token. Use Post request to get a token.
+   */
+  await StripeTerminal.initialize({ tokenProviderEndpoint: 'https://example.com/token', isTest: true })
+  const { readers } = await StripeTerminal.discoverReaders({
+    type: TerminalConnectTypes.TapToPay,
+    locationId: "**************",
+  });
+  await StripeTerminal.connectReader({
+    reader: readers[0],
+  });
+  await StripeTerminal.collect({ paymentIntent: "**************" });
+});
+```
+
 ## API
 
 <docgen-index>
@@ -51,7 +80,11 @@ android {
 * [`initialize(...)`](#initialize)
 * [`discoverReaders(...)`](#discoverreaders)
 * [`connectReader(...)`](#connectreader)
+* [`getConnectedReader()`](#getconnectedreader)
+* [`disconnectReader()`](#disconnectreader)
+* [`cancelDiscoverReaders()`](#canceldiscoverreaders)
 * [`collect(...)`](#collect)
+* [`cancelCollect()`](#cancelcollect)
 * [`addListener(TerminalEventsEnum.Loaded, ...)`](#addlistenerterminaleventsenumloaded)
 * [`addListener(TerminalEventsEnum.DiscoveredReaders, ...)`](#addlistenerterminaleventsenumdiscoveredreaders)
 * [`addListener(TerminalEventsEnum.ConnectedReader, ...)`](#addlistenerterminaleventsenumconnectedreader)
@@ -108,6 +141,35 @@ connectReader(options: { reader: ReaderInterface; }) => Promise<void>
 --------------------
 
 
+### getConnectedReader()
+
+```typescript
+getConnectedReader() => Promise<{ reader: ReaderInterface | null; }>
+```
+
+**Returns:** <code>Promise&lt;{ reader: <a href="#readerinterface">ReaderInterface</a> | null; }&gt;</code>
+
+--------------------
+
+
+### disconnectReader()
+
+```typescript
+disconnectReader() => Promise<void>
+```
+
+--------------------
+
+
+### cancelDiscoverReaders()
+
+```typescript
+cancelDiscoverReaders() => Promise<void>
+```
+
+--------------------
+
+
 ### collect(...)
 
 ```typescript
@@ -121,6 +183,15 @@ collect(options: { paymentIntent: string; }) => Promise<void>
 --------------------
 
 
+### cancelCollect()
+
+```typescript
+cancelCollect() => Promise<void>
+```
+
+--------------------
+
+
 ### addListener(TerminalEventsEnum.Loaded, ...)
 
 ```typescript
@@ -251,13 +322,15 @@ addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: () => void) => P
 
 #### TerminalEventsEnum
 
-| Members                 | Value                                    |
-| ----------------------- | ---------------------------------------- |
-| **`Loaded`**            | <code>'terminalLoaded'</code>            |
-| **`DiscoveredReaders`** | <code>'terminalDiscoveredReaders'</code> |
-| **`ConnectedReader`**   | <code>'terminalConnectedReader'</code>   |
-| **`Completed`**         | <code>'terminalCompleted'</code>         |
-| **`Canceled`**          | <code>'terminalCanceled'</code>          |
-| **`Failed`**            | <code>'terminalFailed'</code>            |
+| Members                       | Value                                          |
+| ----------------------------- | ---------------------------------------------- |
+| **`Loaded`**                  | <code>'terminalLoaded'</code>                  |
+| **`DiscoveredReaders`**       | <code>'terminalDiscoveredReaders'</code>       |
+| **`CancelDiscoveredReaders`** | <code>'terminalCancelDiscoveredReaders'</code> |
+| **`ConnectedReader`**         | <code>'terminalConnectedReader'</code>         |
+| **`DisconnectedReader`**      | <code>'terminalDisconnectedReader'</code>      |
+| **`Completed`**               | <code>'terminalCompleted'</code>               |
+| **`Canceled`**                | <code>'terminalCanceled'</code>                |
+| **`Failed`**                  | <code>'terminalFailed'</code>                  |
 
 </docgen-api>

package/android/build.gradle

@@ -3,17 +3,22 @@ ext {
     androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
     androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
     androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+
+    playServicesWalletVersion = project.hasProperty('playServicesWalletVersion') ? rootProject.ext.playServicesWalletVersion : '19.2.+'
+    volleyVersion = project.hasProperty('volleyVersion') ? rootProject.ext.volleyVersion : '1.2.1'
+    stripeterminalLocalmobileVersion = project.hasProperty('stripeterminalLocalmobileVersion') ? rootProject.ext.stripeterminalLocalmobileVersion : '3.0.+'
+    stripeterminalCoreVersion = project.hasProperty('stripeterminalCoreVersion') ? rootProject.ext.stripeterminalCoreVersion : '3.1.+'
 }
 
 buildscript {
-    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.8.20'
+    ext.kotlinVersion = project.hasProperty("kotlinVersion") ? rootProject.ext.kotlinVersion : '1.8.20'
     repositories {
         google()
         mavenCentral()
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:8.0.0'
-        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
     }
 }
 
@@ -62,9 +67,10 @@ dependencies {
     androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
     androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
 
-    implementation "com.stripe:stripeterminal-localmobile:2.23.0"
-    implementation "com.stripe:stripeterminal-core:2.23.0"
-    implementation 'com.android.volley:volley:1.2.1'
-    implementation 'com.google.android.gms:play-services-wallet:19.1.0'
-    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
-}
+    implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlinVersion"
+
+    implementation "com.stripe:stripeterminal-core:$stripeterminalCoreVersion"
+    implementation "com.stripe:stripeterminal-localmobile:$stripeterminalLocalmobileVersion"
+    implementation "com.android.volley:volley:$volleyVersion"
+    implementation "com.google.android.gms:play-services-wallet:$playServicesWalletVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -1,2 +1,5 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
 </manifest>