Bug 2010700 - Created public compose root and store primitives for s2s

Author: fmasalha

mobile/android/android-components/.buildconfig.yml

@@ -1391,6 +1391,8 @@ projects:
     publish: true
     upstream_dependencies:
     - components:tooling-lint
+    - components:lib-state
+    - components:compose-base
   components:feature-syncedtabs:
     description: Feature that provides access to other devices' tabs in the same account.
     path: components/feature/syncedtabs

mobile/android/android-components/components/feature/summarize/build.gradle

@@ -4,6 +4,7 @@
 
 plugins {
     alias(libs.plugins.dependency.analysis)
+    alias(libs.plugins.kotlin.compose)
 }
 
 apply plugin: 'com.android.library'
@@ -16,13 +17,23 @@ android {
 
     buildFeatures {
         buildConfig = true
+        compose = true
     }
 
     namespace = 'mozilla.components.feature.summarize'
 }
 
 dependencies {
+    implementation project(':components:lib-state')
+
     testImplementation libs.androidx.test.junit
+
+    implementation libs.androidx.compose.foundation
+    implementation libs.androidx.compose.ui.tooling.preview
+    implementation libs.androidx.compose.ui
+    implementation libs.androidx.compose.material3
+    debugImplementation libs.androidx.compose.ui.tooling
+
 }
 
 apply from: '../../../common-config.gradle'

mobile/android/android-components/components/feature/summarize/src/main/java/mozilla/components/feature/summarize/SummarizationMiddleware.kt

@@ -0,0 +1,18 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.feature.summarize
+
+import mozilla.components.lib.state.Middleware
+import mozilla.components.lib.state.Store
+
+internal class SummarizationMiddleware : Middleware<SummarizationState, SummarizationAction> {
+    override fun invoke(
+        store: Store<SummarizationState, SummarizationAction>,
+        next: (SummarizationAction) -> Unit,
+        action: SummarizationAction,
+    ) {
+        TODO("Not yet implemented")
+    }
+}

mobile/android/android-components/components/feature/summarize/src/main/java/mozilla/components/feature/summarize/SummarizationReducer.kt

@@ -0,0 +1,9 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.feature.summarize
+
+internal fun summarizationReducer(state: SummarizationState, action: SummarizationAction) = when (action) {
+    else -> { state }
+}

mobile/android/android-components/components/feature/summarize/src/main/java/mozilla/components/feature/summarize/SummarizationScreen.kt

@@ -0,0 +1,61 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.feature.summarize
+
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.tooling.preview.PreviewParameter
+import androidx.compose.ui.tooling.preview.PreviewParameterProvider
+
+/**
+ * Composable function that renders the summarized text of a webpage.
+ **/
+@Composable
+fun SummarizationUi() {
+    SummarizationScreen(
+        SummarizationStore(
+            initialState = SummarizationState(
+                pageSummarizationState = PageSummarizationState.Inert,
+            ),
+            reducer = ::summarizationReducer,
+            middleware = listOf(SummarizationMiddleware()),
+        ),
+    )
+}
+
+@Composable
+private fun SummarizationScreen(store: SummarizationStore) {
+    Text(store.state.summarizedText)
+}
+
+private class SummarizationStatePreviewProvider : PreviewParameterProvider<SummarizationState> {
+    override val values: Sequence<SummarizationState> = sequenceOf(
+        SummarizationState(
+            PageSummarizationState.Summarizing,
+            summarizedText = "Lorem Ipsum",
+        ),
+        SummarizationState(
+            PageSummarizationState.Error(SummarizationError.ContentTooLong),
+        ),
+        SummarizationState(
+            PageSummarizationState.WaitingForPermission,
+        ),
+    )
+}
+
+@Preview
+@Composable
+private fun SummarizationScreenPreview(
+    @PreviewParameter(SummarizationStatePreviewProvider::class) state: SummarizationState,
+) {
+    SummarizationScreen(
+        SummarizationStore(
+            initialState = state,
+            reducer = ::summarizationReducer,
+            middleware = listOf(SummarizationMiddleware()),
+        ),
+    )
+}

mobile/android/android-components/components/feature/summarize/src/main/java/mozilla/components/feature/summarize/SummarizationStore.kt

@@ -0,0 +1,36 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+package mozilla.components.feature.summarize
+
+import mozilla.components.lib.state.Action
+import mozilla.components.lib.state.State
+import mozilla.components.lib.state.Store
+
+internal typealias SummarizationStore = Store<SummarizationState, SummarizationAction>
+
+internal interface SummarizationAction : Action
+
+internal data class SummarizationState(
+    val pageSummarizationState: PageSummarizationState,
+    val summarizedText: String = "",
+) : State
+
+internal sealed class PageSummarizationState {
+    data object Inert : PageSummarizationState()
+    data object WaitingForPermission : PageSummarizationState()
+    data object Summarizing : PageSummarizationState()
+    data class Summarized(val text: String) : PageSummarizationState()
+    data class Error(val error: SummarizationError) : PageSummarizationState()
+}
+
+internal sealed class SummarizationError {
+    object PermissionDenied : SummarizationError()
+    object ContentUnavailable : SummarizationError()
+    object ContentTooShort : SummarizationError()
+    object ContentTooLong : SummarizationError()
+    object SummarizationFailed : SummarizationError()
+    object InvalidSummary : SummarizationError()
+    object NetworkError : SummarizationError()
+}