PX-2962 4.1.1 Release (#25)

Author: tl-lukasz-franieczek

MigrateTo3.8.0.md

@@ -714,3 +714,82 @@ Other libraries have been updated:
 - `org.jetbrains.kotlinx.kotlinx-coroutines-android` : `1.10.2`
 - `org.jetbrains.kotlinx.kotlinx-coroutines-core` : `1.10.2`
 - `org.jetbrains.kotlinx.kotlinx-coroutines-test` : `1.10.2`
+
+# Version 4.1.0
+
+Version 4.1.0 includes all the features of 4.x.x, including 
+a refreshed user experience with a new, seamless UI and support for payment retries.
+
+The following new features are available automatically for all GBP single payments and EUR payments in Ireland:
+
+- A single-screen, modern, declarative UI system under the hood, allowing for smooth transitions and improved user experience.
+- Retries: allow your users to change bank on the fly, or retry failed payments without restarting the SDK.
+- Cancellation screen streamlining: more insight on why users are abandoning their payments.
+- Preselected providers for returning users: automatically select the last used provider, allowing for faster one-click payments and more engaged, better converting users.
+
+- This update contains minor bug fixes, improvements and underlying library updates.
+
+The most important version changes:
+- `Kotlin` : `2.2.20`
+- `androidx.compose.compose-bom` : `2025.10.01`
+- `gradle` : `gradle-8.13`
+
+Other library updates:
+- `androidx.activity.activity-compose` : `1.11.0`
+- `androidx.compose.runtime.runtime-tracing` : `1.9.4`
+- `androidx.core.core-ktx` : `1.17.0`
+- `androidx.fragment.fragment-ktx` : `1.8.9`
+- `androidx.fragment.fragment-testing` : `1.8.9`
+- `androidx.lifecycle.lifecycle-livedata-ktx` : `2.9.4`
+- `androidx.lifecycle.lifecycle-runtime-compose-android` : `2.9.4`
+- `androidx.lifecycle.lifecycle-runtime-ktx` : `2.9.4`
+- `androidx.lifecycle.lifecycle-viewmodel-compose` : `2.9.4`
+- `androidx.lifecycle.lifecycle-viewmodel-ktx` : `2.9.4`
+- `androidx.navigation.navigation-compose` : `2.9.5`
+- `androidx.work.work-multiprocess` : `2.11.0`
+- `androidx.work.work-runtime-ktx` : `2.11.0`
+- `com.google.android.material.material` : `1.13.0`
+
+## The new way to theme the SDK
+
+When integrating via Compose you no longer need to wrapp the `Processor` composable with `Theme`.
+The `Theme` will be applied automatically. If you want to customise the theme the `Processor` composable
+now accepts a `theme` parameter.
+It also worth mentioning that the SDK will only allow theming for approved merchants. If you are trying
+to apply a custom theme and you are not an approved merchant the SDK will fallback to the default theme.
+If you have questions about this please contact TrueLayer support.
+
+```kotlin
+// Your payments custom theme or use the provided defaults as below
+// theme is optional, if not provided default theme will be applied
+val theme = TrueLayerTheme(
+    lightPalette = LightColorDefaults,
+    darkPalette = DarkColorDefaults,
+    typography = TypographyDefaults
+)
+
+// Obtain your payment context from your backend
+val paymentContext = PaymentContext(
+    id =  "your-payment-identifier",
+    resourceToken = "payment-resource-token",
+    redirectUri = "redirect-uri-that-will-be-invoked-when-coming-back-from-bank"
+)
+
+setContent {
+    Processor(
+        context = paymentContext,
+        // theme is optional, if not provided default theme will be applied
+        theme = theme,
+        onSuccess = { successStep ->
+            // action on success
+        },
+        onFailure = { failureReason ->
+            // action on failure
+        }
+    )
+}
+```
+
+Because the SDK is using `Scaffold` and `BottomSheetScaffold` under the hood to present its UI components
+you need to make sure that you don't have nested `Scaffold` or `BottomSheetScaffold` in your app when integrating the SDK via Compose.
+Although the SDK will work the UI may and will not behave as expected.

README.md

@@ -101,6 +101,95 @@ Other libraries have been updated:
 - `org.jetbrains.kotlinx.kotlinx-coroutines-core` : `1.10.2`
 - `org.jetbrains.kotlinx.kotlinx-coroutines-test` : `1.10.2`
 
+## Version 4.1.0
+
+Version 4.1.0 includes all the features of 4.x.x, including
+a refreshed user experience with a new, seamless UI and support for payment retries.
+
+The following new features are available automatically for all GBP single payments and EUR payments in Ireland:
+
+- A single-screen, modern, declarative UI system under the hood, allowing for smooth transitions and improved user experience.
+- Retries: allow your users to change bank on the fly, or retry failed payments without restarting the SDK.
+- Cancellation screen streamlining: more insight on why users are abandoning their payments.
+- Preselected providers for returning users: automatically select the last used provider, allowing for faster one-click payments and more engaged, better converting users.
+
+- This update contains minor bug fixes, improvements and underlying library updates.
+
+The most important version changes:
+- `Kotlin` : `2.2.20`
+- `androidx.compose.compose-bom` : `2025.10.01`
+- `gradle` : `gradle-8.13`
+
+Other library updates:
+- `androidx.activity.activity-compose` : `1.11.0`
+- `androidx.compose.runtime.runtime-tracing` : `1.9.4`
+- `androidx.core.core-ktx` : `1.17.0`
+- `androidx.fragment.fragment-ktx` : `1.8.9`
+- `androidx.fragment.fragment-testing` : `1.8.9`
+- `androidx.lifecycle.lifecycle-livedata-ktx` : `2.9.4`
+- `androidx.lifecycle.lifecycle-runtime-compose-android` : `2.9.4`
+- `androidx.lifecycle.lifecycle-runtime-ktx` : `2.9.4`
+- `androidx.lifecycle.lifecycle-viewmodel-compose` : `2.9.4`
+- `androidx.lifecycle.lifecycle-viewmodel-ktx` : `2.9.4`
+- `androidx.navigation.navigation-compose` : `2.9.5`
+- `androidx.work.work-multiprocess` : `2.11.0`
+- `androidx.work.work-runtime-ktx` : `2.11.0`
+- `com.google.android.material.material` : `1.13.0`
+
+### The new way to theme the SDK
+
+When integrating via Compose you no longer need to wrapp the `Processor` composable with `Theme`.
+The `Theme` will be applied automatically. If you want to customise the theme the `Processor` composable
+now accepts a `theme` parameter.
+It also worth mentioning that the SDK will only allow theming for approved merchants. If you are trying
+to apply a custom theme and you are not an approved merchant the SDK will fallback to the default theme.
+If you have questions about this please contact TrueLayer support.
+
+```kotlin
+// Your payments custom theme or use the provided defaults as below
+// theme is optional, if not provided default theme will be applied
+val theme = TrueLayerTheme(
+    lightPalette = LightColorDefaults,
+    darkPalette = DarkColorDefaults,
+    typography = TypographyDefaults
+)
+
+// Obtain your payment context from your backend
+val paymentContext = PaymentContext(
+    id =  "your-payment-identifier",
+    resourceToken = "payment-resource-token",
+    redirectUri = "redirect-uri-that-will-be-invoked-when-coming-back-from-bank"
+)
+
+setContent {
+    Processor(
+        context = paymentContext,
+        // theme is optional, if not provided default theme will be applied
+        theme = theme,
+        onSuccess = { successStep ->
+            // action on success
+        },
+        onFailure = { failureReason ->
+            // action on failure
+        }
+    )
+}
+```
+
+Because the SDK is using `Scaffold` and `BottomSheetScaffold` under the hood to present its UI components
+you need to make sure that you don't have nested `Scaffold` or `BottomSheetScaffold` in your app when integrating the SDK via Compose.
+Although the SDK will work the UI may and will not behave as expected.
+
+## 4.1.1
+
+This patch version contains bugfixes and improvements, all the libraries and version 
+and the integration method remain as with the 4.1.0.
+
+### General improvements and bug fixes
+- Improved the bottom sheet behaviour.
+- Handling edge cases of certain SDK integrations.
+- Improving user journey in some GBP payments.
+
 ## How does the payment flow with the SDK works?
 
 ```mermaid

app/build.gradle

@@ -9,12 +9,11 @@ def localProperties = new Properties()
 localProperties.load(new FileInputStream(rootProject.file("local.properties")))
 
 android {
-    compileSdk 35
-
+    compileSdk = 36
     defaultConfig {
         applicationId "com.truelayer.demo"
         minSdk 24
-        targetSdk 35
+        targetSdk 36
         versionCode 1
         versionName "1.0"
 
@@ -67,11 +66,15 @@ dependencies {
     implementation "androidx.compose.material3:material3"
     implementation "com.google.android.material:material:$material_version"
 
+    // Android Studio Preview support
+    implementation 'androidx.compose.ui:ui-tooling-preview'
+    debugImplementation 'androidx.compose.ui:ui-tooling'
+
     implementation 'com.squareup.retrofit2:retrofit:2.9.0'
     implementation 'com.squareup.okhttp3:logging-interceptor:4.12.0'
 
     implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:$json_serialization_version"
     implementation "com.jakewharton.retrofit:retrofit2-kotlinx-serialization-converter:$retrofit2_kotlinx_serialization"
 
-    implementation "com.truelayer.payments:ui:4.0.1"
+    implementation "com.truelayer.payments:ui:4.1.1"
 }

app/src/main/AndroidManifest.xml

@@ -14,14 +14,13 @@
         android:supportsRtl="true"
         android:theme="@style/Theme.SDKDemo"
         android:usesCleartextTraffic="true"
-        tools:targetApi="34">
+        tools:targetApi="36">
         <activity
             android:name=".MainActivity"
             android:exported="true"
             android:theme="@style/Theme.SDKDemo">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
-
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
@@ -45,10 +44,11 @@
         <activity
             android:name=".integrations.ActivityIntegrationActivity"
             android:parentActivityName=".MainActivity"
+            android:launchMode="singleTask"
             android:label="@string/integration_activity"/>
         <activity
             android:name=".integrations.ActivityXIntegrationActivity"
-            android:exported="true"
+            android:launchMode="singleTask"
             android:label="@string/integration_activityx">
         </activity>
         <activity
@@ -59,6 +59,7 @@
         <activity
             android:name=".integrations.JavaIntegrationActivity"
             android:parentActivityName=".MainActivity"
+            android:launchMode="singleTask"
             android:label="@string/integration_java"/>
     </application>
 

app/src/main/java/com/truelayer/demo/integrations/ActivityIntegrationActivity.kt

@@ -3,6 +3,7 @@ package com.truelayer.demo.integrations
 import android.app.Activity
 import android.content.Intent
 import android.os.Bundle
+import android.util.Log
 import android.widget.Toast
 import com.truelayer.demo.R
 import com.truelayer.demo.databinding.ActivityIntegrationBinding
@@ -21,6 +22,7 @@ import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
+import kotlinx.serialization.json.Json
 
 /**
  * Example integration of the SDK with the Activity component
@@ -29,6 +31,12 @@ class ActivityIntegrationActivity : Activity() {
 
     private val scope = CoroutineScope(Dispatchers.IO)
 
+    private var currentProcessorContext: ProcessorContext? = null
+
+    companion object {
+        const val TAG = "Activity"
+    }
+
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
 
@@ -56,6 +64,31 @@ class ActivityIntegrationActivity : Activity() {
         super.onNewIntent(intent)
         intent?.let {
             tryHandleIntentWithRedirectFromBankData(it)
+            this.intent = it
+        }
+    }
+
+    override fun onSaveInstanceState(outState: Bundle) {
+        super.onSaveInstanceState(outState)
+        currentProcessorContext?.let {
+            try {
+                val ctx = Json.encodeToString(it)
+                outState.putString("processorContext", ctx)
+            } catch (e: Throwable) {
+                Log.e(TAG, e.toString())
+            }
+        }
+    }
+
+    override fun onRestoreInstanceState(savedInstanceState: Bundle) {
+        super.onRestoreInstanceState(savedInstanceState)
+        savedInstanceState.getString("processorContext")?.let {
+            try {
+                currentProcessorContext = Json.Default.decodeFromString(it)
+            } catch (e: Throwable) {
+                // failed to decode
+                Log.e(TAG, e.toString())
+            }
         }
     }
 
@@ -68,10 +101,15 @@ class ActivityIntegrationActivity : Activity() {
             // and the payment/mandate ID matches the one we have stored
             // so we can fetch the payment status
             startPaymentActivity(storedProcessorContext)
+        } else {
+            currentProcessorContext?.let {
+                startPaymentActivity(it)
+            }
         }
     }
 
     private fun startPaymentActivity(processorContext: ProcessorContext) {
+        currentProcessorContext = processorContext
         // Create an intent with the payment context to start the payment flow
         val intent = ProcessorActivityContract().createIntent(this, processorContext)
         // Start activity for result to receive the results of the payment flow
@@ -103,6 +141,11 @@ class ActivityIntegrationActivity : Activity() {
         super.onActivityResult(requestCode, resultCode, data)
         // Extract the result of the payment flow from the intent
         val result = ProcessorResult.unwrapResult(data)
+            ?: // in this case the Processor was terminated without setting a result
+            // this is a common case when a redirect from bank is coming
+            // and the same activity that is holding the SDK is not brought forward
+            // but a new one is created. In such case it is safe to ignore it.
+            return
         Toast.makeText(this, result.toString(), Toast.LENGTH_LONG).show()
     }
 }