[Paywalls V2] LocalizationKey is an inline value class now.

purchases/src/main/kotlin/com/revenuecat/purchases/paywalls/components/Background.kt

@@ -0,0 +1,17 @@
+package com.revenuecat.purchases.paywalls.components
+
+import com.revenuecat.purchases.paywalls.components.properties.ColorScheme
+import com.revenuecat.purchases.paywalls.components.properties.ThemeImageUrls
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+internal sealed interface Background {
+    @Serializable
+    @SerialName("color")
+    data class Color(val value: ColorScheme) : Background
+
+    @Serializable
+    @SerialName("image")
+    data class Image(val value: ThemeImageUrls) : Background
+}

purchases/src/main/kotlin/com/revenuecat/purchases/paywalls/components/ComponentsConfig.kt

@@ -0,0 +1,17 @@
+package com.revenuecat.purchases.paywalls.components
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+internal data class ComponentsConfig(
+    val base: PaywallComponentsConfig,
+)
+
+@Serializable
+internal data class PaywallComponentsConfig(
+    val stack: StackComponent,
+    val background: Background,
+    @SerialName("sticky_footer")
+    val stickyFooter: StickyFooterComponent? = null,
+)

purchases/src/main/kotlin/com/revenuecat/purchases/paywalls/components/Localization.kt

@@ -0,0 +1,60 @@
+package com.revenuecat.purchases.paywalls.components
+
+import com.revenuecat.purchases.paywalls.components.properties.ThemeImageUrls
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.InternalSerializationApi
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.SerializationException
+import kotlinx.serialization.descriptors.PolymorphicKind
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.descriptors.buildSerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+@Serializable
+@JvmInline
+internal value class LocaleId(val value: String)
+
+@Serializable
+@JvmInline
+internal value class LocalizationKey(val value: String)
+
+internal typealias LocalizationDictionary = Map<LocalizationKey, LocalizationData>
+
+/**
+ * A make-shift union type. LocalizationData is either a plain String or a ThemeImageUrls object.
+ */
+@Serializable(with = LocalizationDataSerializer::class)
+internal sealed interface LocalizationData {
+    @Serializable
+    @JvmInline
+    value class Text(val value: String) : LocalizationData
+
+    @Serializable
+    @JvmInline
+    value class Image(val value: ThemeImageUrls) : LocalizationData
+}
+
+private object LocalizationDataSerializer : KSerializer<LocalizationData> {
+    // Documentation says to use either PrimitiveSerialDescriptor or buildClassSerialDescriptor. However, we need a
+    // polymorphic descriptor that's either a primitive (string) or a class. So neither of those options fit the bill.
+    @OptIn(InternalSerializationApi::class, ExperimentalSerializationApi::class)
+    override val descriptor: SerialDescriptor = buildSerialDescriptor(
+        serialName = "LocalizationData",
+        kind = PolymorphicKind.SEALED,
+    )
+
+    override fun serialize(encoder: Encoder, value: LocalizationData) {
+        error("Serialization is not implemented as it is not (yet) needed.")
+    }
+
+    @Suppress("SwallowedException")
+    override fun deserialize(decoder: Decoder): LocalizationData =
+        // We have no `type` descriptor field, so we resort to trial and error.
+        try {
+            decoder.decodeSerializableValue(LocalizationData.Text.serializer())
+        } catch (e: SerializationException) {
+            decoder.decodeSerializableValue(LocalizationData.Image.serializer())
+        }
+}

purchases/src/main/kotlin/com/revenuecat/purchases/paywalls/components/PaywallComponentsData.kt

@@ -0,0 +1,22 @@
+package com.revenuecat.purchases.paywalls.components
+
+import com.revenuecat.purchases.utils.serializers.URLSerializer
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+import java.net.URL
+
+@Serializable
+internal data class PaywallComponentsData(
+    @SerialName("template_name")
+    val templateName: String,
+    @Serializable(with = URLSerializer::class)
+    @SerialName("asset_base_url")
+    val assetBaseURL: URL,
+    @SerialName("components_config")
+    val componentsConfig: ComponentsConfig,
+    @SerialName("components_localizations")
+    val componentsLocalizations: Map<LocaleId, LocalizationDictionary>,
+    @SerialName("default_locale")
+    val defaultLocaleIdentifier: LocaleId,
+    val revision: Int = 0,
+)

purchases/src/test/java/com/revenuecat/purchases/paywalls/components/BackgroundTests.kt

@@ -0,0 +1,93 @@
+package com.revenuecat.purchases.paywalls.components
+
+import com.revenuecat.purchases.common.OfferingParser
+import com.revenuecat.purchases.paywalls.components.properties.ColorInfo
+import com.revenuecat.purchases.paywalls.components.properties.ColorScheme
+import com.revenuecat.purchases.paywalls.components.properties.ImageUrls
+import com.revenuecat.purchases.paywalls.components.properties.ThemeImageUrls
+import org.intellij.lang.annotations.Language
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.junit.runners.Parameterized
+import java.net.URL
+
+@RunWith(Parameterized::class)
+internal class BackgroundTests(@Suppress("UNUSED_PARAMETER") name: String, private val args: Args) {
+
+    class Args(
+        @Language("json")
+        val json: String,
+        val expected: Background,
+    )
+
+    companion object {
+
+        @Suppress("LongMethod")
+        @JvmStatic
+        @Parameterized.Parameters(name = "{0}")
+        fun parameters(): Collection<*> = listOf(
+            arrayOf(
+                "String",
+                Args(
+                    json = """
+                        {
+                          "type": "color",
+                          "value": {
+                            "light": {
+                              "type": "alias",
+                              "value": "primary"
+                            }
+                          }
+                        }
+                        """.trimIndent(),
+                    expected = Background.Color(
+                        value = ColorScheme(
+                            light = ColorInfo.Alias("primary")
+                        )
+                    ),
+                ),
+            ),
+            arrayOf(
+                "ThemeImageUrls",
+                Args(
+                    json = """
+                         {
+                           "type": "image",
+                           "value": {
+                             "light": {
+                               "heic": "https://assets.pawwalls.com/1151049_1732039548.heic",
+                               "heic_low_res": "https://assets.pawwalls.com/1151049_low_res_1732039548.heic",
+                               "original": "https://assets.pawwalls.com/1151049_1732039548.png",
+                               "webp": "https://assets.pawwalls.com/1151049_1732039548.webp",
+                               "webp_low_res": "https://assets.pawwalls.com/1151049_low_res_1732039548.webp",
+                               "width": 2345,
+                               "height": 1234
+                             }
+                           }
+                         }
+                        """.trimIndent(),
+                    expected = Background.Image(
+                        value = ThemeImageUrls(
+                            light = ImageUrls(
+                                original = URL("https://assets.pawwalls.com/1151049_1732039548.png"),
+                                webp = URL("https://assets.pawwalls.com/1151049_1732039548.webp"),
+                                webpLowRes = URL("https://assets.pawwalls.com/1151049_low_res_1732039548.webp"),
+                                width = 2345.toUInt(),
+                                height = 1234.toUInt(),
+                            )
+                        )
+                    ),
+                ),
+            ),
+        )
+    }
+
+    @Test
+    fun `Should properly deserialize Background`() {
+        // Arrange, Act
+        val actual = OfferingParser.json.decodeFromString<Background>(args.json)
+
+        // Assert
+        assert(actual == args.expected)
+    }
+}

purchases/src/test/java/com/revenuecat/purchases/paywalls/components/ButtonComponentTests.kt

@@ -62,7 +62,7 @@ internal class ButtonComponentTests {
                             stack = StackComponent(
                                 components = listOf(
                                     TextComponent(
-                                        text = "7bkohQjzIE",
+                                        text = LocalizationKey("7bkohQjzIE"),
                                         color = ColorScheme(light = ColorInfo.Alias("primary"))
                                     )
                                 ),
@@ -104,7 +104,7 @@ internal class ButtonComponentTests {
                             stack = StackComponent(
                                 components = listOf(
                                     TextComponent(
-                                        text = "7bkohQjzIE",
+                                        text = LocalizationKey("7bkohQjzIE"),
                                         color = ColorScheme(light = ColorInfo.Alias("primary"))
                                     )
                                 ),
@@ -149,7 +149,7 @@ internal class ButtonComponentTests {
                             stack = StackComponent(
                                 components = listOf(
                                     TextComponent(
-                                        text = "7bkohQjzIE",
+                                        text = LocalizationKey("7bkohQjzIE"),
                                         color = ColorScheme(light = ColorInfo.Alias("primary"))
                                     )
                                 ),
@@ -201,7 +201,7 @@ internal class ButtonComponentTests {
                             stack = StackComponent(
                                 components = listOf(
                                     TextComponent(
-                                        text = "7bkohQjzIE",
+                                        text = LocalizationKey("7bkohQjzIE"),
                                         color = ColorScheme(light = ColorInfo.Alias("primary"))
                                     )
                                 ),
@@ -253,7 +253,7 @@ internal class ButtonComponentTests {
                             stack = StackComponent(
                                 components = listOf(
                                     TextComponent(
-                                        text = "7bkohQjzIE",
+                                        text = LocalizationKey("7bkohQjzIE"),
                                         color = ColorScheme(light = ColorInfo.Alias("primary"))
                                     )
                                 ),
@@ -305,7 +305,7 @@ internal class ButtonComponentTests {
                             stack = StackComponent(
                                 components = listOf(
                                     TextComponent(
-                                        text = "7bkohQjzIE",
+                                        text = LocalizationKey("7bkohQjzIE"),
                                         color = ColorScheme(light = ColorInfo.Alias("primary"))
                                     )
                                 ),

purchases/src/test/java/com/revenuecat/purchases/paywalls/components/ComponentOverridesTests.kt

@@ -137,14 +137,14 @@ internal class ComponentOverridesTests {
                         }
                         """.trimIndent(),
                         expected = ComponentOverrides(
-                            introOffer = PartialImageComponent(overrideSourceLid = "intro"),
+                            introOffer = PartialImageComponent(overrideSourceLid = LocalizationKey("intro")),
                             states = ComponentStates(
-                                selected = PartialImageComponent(overrideSourceLid = "selected")
+                                selected = PartialImageComponent(overrideSourceLid = LocalizationKey("selected"))
                             ),
                             conditions = ComponentConditions(
-                                compact = PartialImageComponent(overrideSourceLid = "compact"),
-                                medium = PartialImageComponent(overrideSourceLid = "medium"),
-                                expanded = PartialImageComponent(overrideSourceLid = "expanded"),
+                                compact = PartialImageComponent(overrideSourceLid = LocalizationKey("compact")),
+                                medium = PartialImageComponent(overrideSourceLid = LocalizationKey("medium")),
+                                expanded = PartialImageComponent(overrideSourceLid = LocalizationKey("expanded")),
                             )
                         )
                     )