First Commit

features/ftue/api/build.gradle.kts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+plugins {
+    id("io.element.android-library")
+}
+
+android {
+    namespace = "io.element.android.features.ftue.api"
+}
+
+dependencies {
+    implementation(projects.libraries.architecture)
+}

features/ftue/api/src/main/kotlin/io/element/android/features/ftue/api/FtueEntryPoint.kt

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.ftue.api
+
+import io.element.android.libraries.architecture.SimpleFeatureEntryPoint
+
+interface FtueEntryPoint : SimpleFeatureEntryPoint

features/ftue/api/src/main/kotlin/io/element/android/features/ftue/api/state/FtueService.kt

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.features.ftue.api.state
+
+import kotlinx.coroutines.flow.StateFlow
+
+/**
+ * Service to manage the First Time User Experience state (aka Onboarding).
+ */
+interface FtueService {
+    /** The current state of the FTUE. */
+    val state: StateFlow<FtueState>
+}
+
+/** The state of the FTUE. */
+sealed interface FtueState {
+    /** The FTUE state is unknown, nothing to do for now. */
+    data object Unknown : FtueState
+
+    /** The FTUE state is incomplete. The FTUE flow should be displayed. */
+    data object Incomplete : FtueState
+
+    /** The FTUE state is complete. The FTUE flow should not be displayed anymore. */
+    data object Complete : FtueState
+}