Merge branch 'main' into fallback-api-host

Author: ajpallares

.circleci/config.yml

@@ -301,7 +301,7 @@ jobs:
           command: sudo pip install awscli
       - run:
           name: Deploy to S3
-          command: aws s3 sync ~/project/docs/8.17.0 s3://purchases-docs/android/8.17.0 --delete
+          command: aws s3 sync ~/project/docs/8.18.0-SNAPSHOT s3://purchases-docs/android/8.18.0-SNAPSHOT --delete
       - run:
           name: Update index.html
           command: aws s3 cp ~/project/docs/index.html s3://purchases-docs/android/index.html

.version

@@ -1 +1 @@
-8.17.0
+8.18.0-SNAPSHOT

examples/CustomEntitlementComputationSample/gradle/libs.versions.toml

@@ -2,7 +2,7 @@
 agp = "8.1.3"
 androidxNavigation = "2.5.3"
 kotlin = "1.7.20"
-purchases = "8.17.0"
+purchases = "8.18.0-SNAPSHOT"
 lifecycle = "2.5.0"
 androidxCore = "1.10.1"
 

examples/MagicWeather/gradle/libs.versions.toml

@@ -2,7 +2,7 @@
 agp = "8.1.3"
 androidxNavigation = "2.6.0"
 kotlin = "1.9.0"
-purchases = "8.17.0"
+purchases = "8.18.0-SNAPSHOT"
 lifecycle = "2.6.1"
 androidxCore = "1.10.1"
 

examples/MagicWeatherCompose/gradle/libs.versions.toml

@@ -2,7 +2,7 @@
 agp = "8.1.3"
 androidxNavigation = "2.5.3"
 kotlin = "1.8.22"
-purchases = "8.17.0"
+purchases = "8.18.0-SNAPSHOT"
 lifecycle = "2.5.0"
 androidxCore = "1.10.1"
 

gradle.properties

@@ -13,7 +13,7 @@
 #Fri Mar 31 10:31:20 PDT 2023
 GROUP=com.revenuecat.purchases
 
-VERSION_NAME=8.17.0
+VERSION_NAME=8.18.0-SNAPSHOT
 
 POM_DESCRIPTION=Mobile subscriptions in hours, not months.
 POM_URL=https://github.com/RevenueCat/purchases-android

library.gradle

@@ -5,7 +5,7 @@ android {
         minSdkVersion obtainMinSdkVersion()
         targetSdkVersion compileVersion
         versionCode 1
-        versionName "8.17.0"
+        versionName "8.18.0-SNAPSHOT"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         consumerProguardFiles "consumer-rules.pro"
     }

purchases/src/main/kotlin/com/revenuecat/purchases/common/Config.kt

@@ -6,5 +6,5 @@ import com.revenuecat.purchases.api.BuildConfig
 internal object Config {
     var logLevel = LogLevel.debugLogsEnabled(BuildConfig.DEBUG)
 
-    const val frameworkVersion = "8.17.0"
+    const val frameworkVersion = "8.18.0-SNAPSHOT"
 }

ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/components/image/ImageComponentView.kt

@@ -275,6 +275,7 @@ private fun ImageComponentView_Bigger_Container_Fit_Fill_FitModeFill_Preview() {
     }
 }
 
+@EmergeSnapshotConfig(precision = 0.99f)
 @Preview
 @Composable
 private fun ImageComponentView_Preview_SmallerContainer() {
@@ -391,6 +392,7 @@ private fun ImageComponentView_Preview_LinearGradient() {
 }
 
 @Suppress("MagicNumber")
+@EmergeSnapshotConfig(precision = 0.99f)
 @Preview
 @Composable
 private fun ImageComponentView_Preview_RadialGradient() {

ui/revenuecatui/src/main/kotlin/com/revenuecat/purchases/ui/revenuecatui/components/style/StyleFactory.kt

@@ -25,7 +25,9 @@ import com.revenuecat.purchases.paywalls.components.common.LocaleId
 import com.revenuecat.purchases.paywalls.components.common.LocalizationKey
 import com.revenuecat.purchases.paywalls.components.common.VariableLocalizationKey
 import com.revenuecat.purchases.paywalls.components.properties.ColorScheme
+import com.revenuecat.purchases.paywalls.components.properties.Dimension
 import com.revenuecat.purchases.paywalls.components.properties.Shape
+import com.revenuecat.purchases.paywalls.components.properties.SizeConstraint
 import com.revenuecat.purchases.paywalls.components.properties.ThemeImageUrls
 import com.revenuecat.purchases.ui.revenuecatui.components.LocalizedTextPartial
 import com.revenuecat.purchases.ui.revenuecatui.components.PresentedCarouselPartial
@@ -102,6 +104,91 @@ internal class StyleFactory(
          */
         var tabIndex: Int? = null,
     ) {
+        private class WindowInsetsState {
+            /**
+             * Whether the current component should apply the top window insets. This field is reset when it is read,
+             * as it should only be set on a single component.
+             */
+            var applyTopWindowInsets = false
+                get() {
+                    val value = field
+                    field = false
+                    return value
+                }
+
+            /**
+             * Whether the current component should ignore the top window insets. This field is reset when it is read,
+             * as it should only be set on a single component.
+             */
+            var ignoreTopWindowInsets = false
+                get() {
+                    val value = field
+                    field = false
+                    return value
+                }
+
+            /**
+             * Whether we have applied the top window insets to any component.
+             */
+            var topWindowInsetsApplied = false
+
+            /**
+             * We're only interested in the first non-container component. After that, we can stop looking.
+             */
+            private var stillLookingForHeaderImage = true
+
+            /**
+             * This will be called for every component in the tree, and will determine whether we have a header image
+             * that needs special top-window-insets treatment. A header image is found if the first non-container
+             * component is an image component with a Fill width and a ZLayer parent stack.
+             */
+            fun handleHeaderImageWindowInsets(component: PaywallComponent) {
+                when (component) {
+                    is StackComponent -> if (stillLookingForHeaderImage) {
+                        applyTopWindowInsets = when (component.dimension) {
+                            is Dimension.ZLayer -> {
+                                topWindowInsetsApplied = component.components.firstOrNull()?.isHeaderImage == true
+                                topWindowInsetsApplied
+                            }
+                            is Dimension.Horizontal,
+                            is Dimension.Vertical,
+                            -> false
+                        }
+                    }
+
+                    is ImageComponent -> {
+                        if (stillLookingForHeaderImage) {
+                            ignoreTopWindowInsets = component.isHeaderImage
+                        }
+                        stillLookingForHeaderImage = false
+                    }
+
+                    else -> stillLookingForHeaderImage = false
+                }
+            }
+
+            private val PaywallComponent.isHeaderImage: Boolean
+                get() = this is ImageComponent &&
+                    when (size.width) {
+                        is SizeConstraint.Fill -> true
+                        is SizeConstraint.Fit,
+                        is SizeConstraint.Fixed,
+                        -> false
+                    }
+        }
+
+        val windowInsetsState = WindowInsetsState()
+
+        /**
+         * Whether the current component should apply the top window insets.
+         */
+        val applyTopWindowInsets by windowInsetsState::applyTopWindowInsets
+
+        /**
+         * Whether the current component should ignore the top window insets.
+         */
+        val ignoreTopWindowInsets by windowInsetsState::ignoreTopWindowInsets
+
         var defaultTabIndex: Int? = null
         val rcPackage: Package?
             get() = packageInfo?.pkg
@@ -170,6 +257,41 @@ internal class StyleFactory(
             return result
         }
 
+        /**
+         * Tells the StyleFactoryScope about a component. This should be called for every component in the tree.
+         */
+        fun recordComponent(component: PaywallComponent) {
+            windowInsetsState.handleHeaderImageWindowInsets(component)
+        }
+
+        /**
+         * Applies the top window insets to the provided ComponentStyle if they haven't been applied to any other
+         * component yet.
+         */
+        fun applyTopWindowInsetsIfNotYetApplied(to: ComponentStyle): ComponentStyle =
+            when (to) {
+                is StackComponentStyle -> to.copy(applyTopWindowInsets = !windowInsetsState.topWindowInsetsApplied)
+                else -> to
+            }
+
+        /**
+         * Applies the bottom window insets to this ComponentStyle if [shouldApply] is true and this is a stack or
+         * sticky footer.
+         */
+        @Suppress("UNCHECKED_CAST")
+        fun <T : ComponentStyle> T.applyBottomWindowInsetsIfNecessary(shouldApply: Boolean): T =
+            if (shouldApply) {
+                when (this) {
+                    is StackComponentStyle -> copy(applyBottomWindowInsets = true)
+                    is StickyFooterComponentStyle -> copy(
+                        stackComponentStyle = stackComponentStyle.copy(applyBottomWindowInsets = true),
+                    )
+                    else -> this
+                } as T
+            } else {
+                this
+            }
+
         private fun recordPackage(pkg: AvailablePackages.Info) {
             val currentTabIndex = tabIndex
             if (currentTabIndex == null) {
@@ -186,29 +308,39 @@ internal class StyleFactory(
         val defaultTabIndex: Int?,
     )
 
-    fun create(component: PaywallComponent): Result<StyleResult, NonEmptyList<PaywallValidationError>> {
-        val scope = StyleFactoryScope()
-        return scope.createInternal(component)
-            .flatMap { componentStyle ->
-                componentStyle?.let { Result.Success(it) }
-                    ?: Result.Error(
-                        nonEmptyListOf(PaywallValidationError.RootComponentUnsupportedProperties(component)),
+    /**
+     * @param applyBottomWindowInsets Whether to apply bottom window insets to the root of this tree (i.e. the
+     * passed-in [component]).
+     */
+    fun create(
+        component: PaywallComponent,
+        applyBottomWindowInsets: Boolean = false,
+    ): Result<StyleResult, NonEmptyList<PaywallValidationError>> =
+        with(StyleFactoryScope()) {
+            createInternal(component)
+                .flatMap { componentStyle ->
+                    componentStyle?.let { Result.Success(it) }
+                        ?: Result.Error(
+                            nonEmptyListOf(PaywallValidationError.RootComponentUnsupportedProperties(component)),
+                        )
+                }
+                .map { componentStyle -> applyTopWindowInsetsIfNotYetApplied(to = componentStyle) }
+                .map { componentStyle -> componentStyle.applyBottomWindowInsetsIfNecessary(applyBottomWindowInsets) }
+                .map { componentStyle ->
+                    StyleResult(
+                        componentStyle = componentStyle,
+                        availablePackages = packages,
+                        defaultTabIndex = defaultTabIndex,
                     )
-            }
-            .map { componentStyle ->
-                StyleResult(
-                    componentStyle = componentStyle,
-                    availablePackages = scope.packages,
-                    defaultTabIndex = scope.defaultTabIndex,
-                )
-            }
-    }
+                }
+        }
 
     @Suppress("CyclomaticComplexMethod")
     private fun StyleFactoryScope.createInternal(
         component: PaywallComponent,
-    ): Result<ComponentStyle?, NonEmptyList<PaywallValidationError>> =
-        when (component) {
+    ): Result<ComponentStyle?, NonEmptyList<PaywallValidationError>> {
+        recordComponent(component)
+        return when (component) {
             is ButtonComponent -> createButtonComponentStyleOrNull(component)
             is ImageComponent -> createImageComponentStyle(component)
             is PackageComponent -> createPackageComponentStyle(component)
@@ -224,6 +356,7 @@ internal class StyleFactory(
             is TabControlComponent -> tabControl.errorIfNull(nonEmptyListOf(PaywallValidationError.TabControlNotInTab))
             is TabsComponent -> createTabsComponentStyle(component)
         }
+    }
 
     private fun StyleFactoryScope.createStickyFooterComponentStyle(
         component: StickyFooterComponent,
@@ -382,6 +515,7 @@ internal class StyleFactory(
             rcPackage = rcPackage,
             tabIndex = tabControlIndex,
             overrides = presentedOverrides,
+            applyTopWindowInsets = applyTopWindowInsets,
         )
     }
 
@@ -462,6 +596,7 @@ internal class StyleFactory(
             rcPackage = rcPackage,
             tabIndex = tabControlIndex,
             overrides = presentedOverrides,
+            ignoreTopWindowInsets = ignoreTopWindowInsets,
         )
     }