[Paywalls V2] Adds PaywallState.Loaded.Components (#1969)

RevenueCat · Dec 10, 2024 · 9bf19f5 · 9bf19f5
1 parent b793940
commit 9bf19f5
Show file tree

Hide file tree

Showing 18 changed files with 113 additions and 99 deletions.
diff --git a/ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/InternalPaywall.kt b/ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/InternalPaywall.kt
@@ -80,11 +80,11 @@ internal fun InternalPaywall(
         }
 
         AnimatedVisibility(
-            visible = state is PaywallState.Loaded,
+            visible = state is PaywallState.Loaded.Legacy,
             enter = fadeIn(animationSpec = defaultAnimation()),
             exit = fadeOut(animationSpec = defaultAnimation()),
         ) {
-            if (state is PaywallState.Loaded) {
+            if (state is PaywallState.Loaded.Legacy) {
                 LoadedPaywall(state = state, viewModel = viewModel)
             } else {
                 Logger.e(
@@ -117,7 +117,7 @@ internal fun InternalPaywall(
 }
 
 @Composable
-private fun LoadedPaywall(state: PaywallState.Loaded, viewModel: PaywallViewModel) {
+private fun LoadedPaywall(state: PaywallState.Loaded.Legacy, viewModel: PaywallViewModel) {
     viewModel.trackPaywallImpressionIfNeeded()
     val backgroundColor = state.templateConfiguration.getCurrentColors().background
     Box(
@@ -157,7 +157,7 @@ private fun LoadedPaywall(state: PaywallState.Loaded, viewModel: PaywallViewMode
 }
 
 @Composable
-private fun TemplatePaywall(state: PaywallState.Loaded, viewModel: PaywallViewModel) {
+private fun TemplatePaywall(state: PaywallState.Loaded.Legacy, viewModel: PaywallViewModel) {
     when (state.templateConfiguration.template) {
         PaywallTemplate.TEMPLATE_1 -> Template1(state = state, viewModel = viewModel)
         PaywallTemplate.TEMPLATE_2 -> Template2(state = state, viewModel = viewModel)
@@ -191,7 +191,7 @@ internal fun getPaywallViewModel(
 
 @ReadOnlyComposable
 @Composable
-private fun PaywallState.Loaded.contextWithConfiguration(configuration: Configuration): Context {
+private fun PaywallState.Loaded.Legacy.contextWithConfiguration(configuration: Configuration): Context {
     val context = LocalContext.current
 
     // Context.createConfigurationContext returns `null` with Paparazzi
@@ -200,7 +200,7 @@ private fun PaywallState.Loaded.contextWithConfiguration(configuration: Configur
 
 @ReadOnlyComposable
 @Composable
-private fun PaywallState.Loaded.configurationWithOverriddenLocale(): Configuration {
+private fun PaywallState.Loaded.Legacy.configurationWithOverriddenLocale(): Configuration {
     val configuration = Configuration(LocalConfiguration.current)
     configuration.setLocale(templateConfiguration.locale)
 

diff --git a/ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/LoadingPaywall.kt b/ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/LoadingPaywall.kt
@@ -81,15 +81,16 @@ internal fun LoadingPaywall(
         // and snapshots ensure that these 2 states are impossible.
         is PaywallState.Error,
         is PaywallState.Loading,
+        is PaywallState.Loaded.Components,
         -> Box {}
 
-        is PaywallState.Loaded -> LoadingPaywall(state, LoadingViewModel(state, resourceProvider), onDismiss)
+        is PaywallState.Loaded.Legacy -> LoadingPaywall(state, LoadingViewModel(state, resourceProvider), onDismiss)
     }
 }
 
 @Composable
 private fun LoadingPaywall(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     viewModel: PaywallViewModel,
     onDismiss: () -> Unit,
 ) {

diff --git a/...tlin/com/revenuecat/purchases/ui/revenuecatui/composables/ConsistentPackageContentView.kt b/...tlin/com/revenuecat/purchases/ui/revenuecatui/composables/ConsistentPackageContentView.kt
@@ -10,7 +10,7 @@ import com.revenuecat.purchases.ui.revenuecatui.data.processed.TemplateConfigura
 
 @Composable
 internal fun ConsistentPackageContentView(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     creator: @Composable (TemplateConfiguration.PackageInfo) -> Unit,
 ) {
     ConsistentPackageContentView(

diff --git a/...atui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/composables/OfferDetails.kt b/...atui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/composables/OfferDetails.kt
@@ -21,7 +21,7 @@ import com.revenuecat.purchases.ui.revenuecatui.extensions.introEligibility
  */
 @Composable
 internal fun OfferDetails(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     colors: TemplateConfiguration.Colors = state.templateConfiguration.getCurrentColors(),
 ) {
     OfferDetails(state = state, color = colors.text1)
@@ -33,7 +33,7 @@ internal fun OfferDetails(
  */
 @Composable
 internal fun OfferDetails(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     color: Color,
 ) {
     Box(

diff --git a/...ui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/composables/PurchaseButton.kt b/...ui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/composables/PurchaseButton.kt
@@ -47,7 +47,7 @@ import com.revenuecat.purchases.ui.revenuecatui.helpers.TestTag
 
 @Composable
 internal fun PurchaseButton(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     viewModel: PaywallViewModel,
     childModifier: Modifier = Modifier,
     horizontalPadding: Dp = UIConstant.defaultHorizontalPadding,
@@ -199,7 +199,7 @@ private fun BoxScope.LoadingSpinner(shouldShow: Boolean, colors: TemplateConfigu
 @Composable
 private fun PurchaseButtonPreview() {
     val viewModel = MockViewModel(offering = TestData.template2Offering, allowsPurchases = true)
-    val state = viewModel.loadedState()
+    val state = viewModel.loadedLegacyState()
 
     if (state != null) {
         PurchaseButton(

diff --git a/...evenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/PaywallState.kt b/...evenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/PaywallState.kt
@@ -10,54 +10,67 @@ import com.revenuecat.purchases.ui.revenuecatui.data.processed.TemplateConfigura
 import com.revenuecat.purchases.ui.revenuecatui.helpers.Logger
 import com.revenuecat.purchases.ui.revenuecatui.isFullScreen
 
-internal sealed class PaywallState {
-    object Loading : PaywallState()
+internal sealed interface PaywallState {
+    object Loading : PaywallState
 
-    data class Error(val errorMessage: String) : PaywallState() {
+    data class Error(val errorMessage: String) : PaywallState {
         init {
             Logger.e("Paywall transitioned to error state: $errorMessage")
         }
     }
 
-    data class Loaded(
-        val offering: Offering,
-        val templateConfiguration: TemplateConfiguration,
-        val selectedPackage: MutableState<TemplateConfiguration.PackageInfo>,
-        val shouldDisplayDismissButton: Boolean,
-    ) : PaywallState() {
-        constructor(
-            offering: Offering,
-            templateConfiguration: TemplateConfiguration,
-            selectedPackage: TemplateConfiguration.PackageInfo,
-            shouldDisplayDismissButton: Boolean,
-        ) :
-            this(
-                offering,
-                templateConfiguration,
-                mutableStateOf(selectedPackage),
-                shouldDisplayDismissButton,
-            )
-
-        fun selectPackage(packageInfo: TemplateConfiguration.PackageInfo) {
-            selectedPackage.value = packageInfo
+    sealed interface Loaded : PaywallState {
+        val offering: Offering
+
+        data class Legacy(
+            override val offering: Offering,
+            val templateConfiguration: TemplateConfiguration,
+            val selectedPackage: MutableState<TemplateConfiguration.PackageInfo>,
+            val shouldDisplayDismissButton: Boolean,
+        ) : Loaded {
+
+            constructor(
+                offering: Offering,
+                templateConfiguration: TemplateConfiguration,
+                selectedPackage: TemplateConfiguration.PackageInfo,
+                shouldDisplayDismissButton: Boolean,
+            ) :
+                this(
+                    offering,
+                    templateConfiguration,
+                    mutableStateOf(selectedPackage),
+                    shouldDisplayDismissButton,
+                )
+
+            fun selectPackage(packageInfo: TemplateConfiguration.PackageInfo) {
+                selectedPackage.value = packageInfo
+            }
         }
+
+        data class Components(
+            override val offering: Offering,
+            // TODO val data: PaywallComponentsData,
+        ) : Loaded
     }
 }
 
-internal fun PaywallState.loaded(): PaywallState.Loaded? {
+internal fun PaywallState.loadedLegacy(): PaywallState.Loaded.Legacy? {
     return when (val state = this) {
         is PaywallState.Error -> null
-        is PaywallState.Loaded -> state
+        is PaywallState.Loaded -> when (state) {
+            is PaywallState.Loaded.Legacy -> state
+            is PaywallState.Loaded.Components -> null
+        }
         is PaywallState.Loading -> null
     }
 }
 
-internal val PaywallState.Loaded.selectedLocalization: ProcessedLocalizedConfiguration
+internal val PaywallState.Loaded.Legacy.selectedLocalization: ProcessedLocalizedConfiguration
     get() = selectedPackage.value.localization
 
-internal val PaywallState.Loaded.currentColors: TemplateConfiguration.Colors
+internal val PaywallState.Loaded.Legacy.currentColors: TemplateConfiguration.Colors
     @Composable @ReadOnlyComposable
     get() = templateConfiguration.getCurrentColors()
 
-internal val PaywallState.Loaded.isInFullScreenMode: Boolean
+internal val PaywallState.Loaded.Legacy.isInFullScreenMode: Boolean
     get() = templateConfiguration.mode.isFullScreen
diff --git a/...uecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/PaywallViewModel.kt b/...uecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/PaywallViewModel.kt
@@ -131,7 +131,7 @@ internal class PaywallViewModelImpl(
 
     override fun selectPackage(packageToSelect: TemplateConfiguration.PackageInfo) {
         when (val currentState = _state.value) {
-            is PaywallState.Loaded -> {
+            is PaywallState.Loaded.Legacy -> {
                 currentState.selectPackage(packageToSelect)
             }
 
@@ -248,7 +248,7 @@ internal class PaywallViewModelImpl(
 
     private suspend fun handlePackagePurchase(activity: Activity) {
         when (val currentState = _state.value) {
-            is PaywallState.Loaded -> {
+            is PaywallState.Loaded.Legacy -> {
                 val selectedPackage = currentState.selectedPackage.value
                 if (!selectedPackage.currentlySubscribed) {
                     performPurchase(activity, selectedPackage.rcPackage)
@@ -441,7 +441,7 @@ internal class PaywallViewModelImpl(
     @Suppress("ReturnCount")
     private fun createEventData(): PaywallEvent.Data? {
         val currentState = state.value
-        if (currentState !is PaywallState.Loaded) {
+        if (currentState !is PaywallState.Loaded.Legacy) {
             Logger.e("Unexpected state trying to create event data: $currentState")
             return null
         }

diff --git a/...ecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/testdata/TestData.kt b/...ecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/data/testdata/TestData.kt
@@ -19,7 +19,7 @@ import com.revenuecat.purchases.ui.revenuecatui.PaywallMode
 import com.revenuecat.purchases.ui.revenuecatui.R
 import com.revenuecat.purchases.ui.revenuecatui.data.PaywallState
 import com.revenuecat.purchases.ui.revenuecatui.data.PaywallViewModel
-import com.revenuecat.purchases.ui.revenuecatui.data.loaded
+import com.revenuecat.purchases.ui.revenuecatui.data.loadedLegacy
 import com.revenuecat.purchases.ui.revenuecatui.data.processed.PaywallTemplate
 import com.revenuecat.purchases.ui.revenuecatui.data.processed.TemplateConfiguration
 import com.revenuecat.purchases.ui.revenuecatui.data.processed.VariableDataProvider
@@ -436,8 +436,8 @@ internal class MockViewModel(
     override val actionError: State<PurchasesError?>
         get() = _actionError
 
-    fun loadedState(): PaywallState.Loaded? {
-        return state.value.loaded()
+    fun loadedLegacyState(): PaywallState.Loaded.Legacy? {
+        return state.value.loadedLegacy()
     }
 
     private val _state = MutableStateFlow(

diff --git a/...uecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/extensions/Animations.kt b/...uecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/extensions/Animations.kt
@@ -22,7 +22,7 @@ internal fun PaywallViewModel.packageButtonActionInProgressOpacityAnimation(): F
 }
 
 @Composable
-internal fun PaywallState.Loaded.packageButtonColorAnimation(
+internal fun PaywallState.Loaded.Legacy.packageButtonColorAnimation(
     packageInfo: TemplateConfiguration.PackageInfo,
     selectedColor: Color,
     unselectedColor: Color,

diff --git a/...src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/helpers/OfferingToStateMapper.kt b/...src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/helpers/OfferingToStateMapper.kt
@@ -153,7 +153,7 @@ internal fun Offering.toPaywallState(
         return PaywallState.Error(it.message ?: "Unknown error")
     }
 
-    return PaywallState.Loaded(
+    return PaywallState.Loaded.Legacy(
         offering = this,
         templateConfiguration = templateConfiguration,
         selectedPackage = templateConfiguration.packages.default,

diff --git a/...nuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/helpers/WindowHelper.kt b/...nuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/helpers/WindowHelper.kt
@@ -33,7 +33,7 @@ internal fun hasCompactDimension(): Boolean {
 
 @Composable
 @ReadOnlyComposable
-internal fun PaywallState.Loaded.shouldUseLandscapeLayout(): Boolean {
+internal fun PaywallState.Loaded.Legacy.shouldUseLandscapeLayout(): Boolean {
     return shouldUseLandscapeLayout(mode = templateConfiguration.mode)
 }
 

diff --git a/...enuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/templates/Template1.kt b/...enuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/templates/Template1.kt
@@ -58,7 +58,7 @@ import com.revenuecat.purchases.ui.revenuecatui.extensions.conditional
 import com.revenuecat.purchases.ui.revenuecatui.helpers.shouldUseLandscapeLayout
 
 @Composable
-internal fun Template1(state: PaywallState.Loaded, viewModel: PaywallViewModel) {
+internal fun Template1(state: PaywallState.Loaded.Legacy, viewModel: PaywallViewModel) {
     Column(
         modifier = Modifier
             .fillMaxWidth(),
@@ -72,7 +72,7 @@ internal fun Template1(state: PaywallState.Loaded, viewModel: PaywallViewModel)
 
 @SuppressWarnings("LongMethod")
 @Composable
-private fun ColumnScope.Template1MainContent(state: PaywallState.Loaded) {
+private fun ColumnScope.Template1MainContent(state: PaywallState.Loaded.Legacy) {
     val localizedConfig = state.selectedLocalization
     val colors = state.currentColors
 

diff --git a/...enuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/templates/Template2.kt b/...enuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/templates/Template2.kt
@@ -87,7 +87,7 @@ private object Template2UIConstants {
  */
 @Composable
 internal fun Template2(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     viewModel: PaywallViewModel,
     childModifier: Modifier = Modifier,
 ) {
@@ -132,7 +132,7 @@ internal fun Template2(
 @Suppress("LongMethod")
 @Composable
 private fun ColumnScope.Template2PortraitContent(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     viewModel: PaywallViewModel,
     packageSelectionVisible: Boolean,
     childModifier: Modifier,
@@ -182,7 +182,7 @@ private fun ColumnScope.Template2PortraitContent(
 @Suppress("LongMethod")
 @Composable
 private fun ColumnScope.Template2LandscapeContent(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     viewModel: PaywallViewModel,
     packageSelectionVisible: Boolean,
     childModifier: Modifier,
@@ -245,7 +245,7 @@ private fun ColumnScope.Template2LandscapeContent(
 
 @Composable
 private fun IconImage(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     childModifier: Modifier,
 ) {
     IconImage(
@@ -258,7 +258,7 @@ private fun IconImage(
 
 @Composable
 private fun Title(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     childModifier: Modifier,
     textAlign: TextAlign = TextAlign.Center,
 ) {
@@ -275,7 +275,7 @@ private fun Title(
 
 @Composable
 private fun Subtitle(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     childModifier: Modifier,
     textAlign: TextAlign = TextAlign.Center,
 ) {
@@ -292,7 +292,7 @@ private fun Subtitle(
 
 @Composable
 private fun AnimatedPackages(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     packageSelectionVisible: Boolean,
     landscapeLayout: Boolean,
     viewModel: PaywallViewModel,
@@ -340,7 +340,7 @@ private fun AnimatedPackages(
 @SuppressWarnings("LongMethod")
 @Composable
 private fun ColumnScope.SelectPackageButton(
-    state: PaywallState.Loaded,
+    state: PaywallState.Loaded.Legacy,
     packageInfo: TemplateConfiguration.PackageInfo,
     viewModel: PaywallViewModel,
     childModifier: Modifier,