First Commit

libraries/preferences/api/build.gradle.kts

@@ -0,0 +1,26 @@
+import extension.testCommonDependencies
+
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023, 2024 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.libraries.preferences.api"
+}
+
+dependencies {
+    implementation(libs.coroutines.core)
+    implementation(projects.libraries.matrix.api)
+    implementation(libs.androidx.datastore.preferences)
+
+    testCommonDependencies(libs)
+    testImplementation(projects.libraries.preferences.test)
+}

libraries/preferences/api/src/main/kotlin/io/element/android/libraries/preferences/api/store/AppPreferencesStore.kt

@@ -0,0 +1,42 @@
+/*
+ * 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.libraries.preferences.api.store
+
+import io.element.android.libraries.matrix.api.media.MediaPreviewValue
+import io.element.android.libraries.matrix.api.tracing.LogLevel
+import io.element.android.libraries.matrix.api.tracing.TraceLogPack
+import kotlinx.coroutines.flow.Flow
+
+interface AppPreferencesStore {
+    suspend fun setDeveloperModeEnabled(enabled: Boolean)
+    fun isDeveloperModeEnabledFlow(): Flow<Boolean>
+
+    suspend fun setCustomElementCallBaseUrl(string: String?)
+    fun getCustomElementCallBaseUrlFlow(): Flow<String?>
+
+    suspend fun setTheme(theme: String)
+    fun getThemeFlow(): Flow<String?>
+
+    @Deprecated("Use MediaPreviewService instead. Kept only for migration.")
+    suspend fun setHideInviteAvatars(hide: Boolean?)
+    @Deprecated("Use MediaPreviewService instead. Kept only for migration.")
+    fun getHideInviteAvatarsFlow(): Flow<Boolean?>
+    @Deprecated("Use MediaPreviewService instead. Kept only for migration.")
+    suspend fun setTimelineMediaPreviewValue(mediaPreviewValue: MediaPreviewValue?)
+    @Deprecated("Use MediaPreviewService instead. Kept only for migration.")
+    fun getTimelineMediaPreviewValueFlow(): Flow<MediaPreviewValue?>
+
+    suspend fun setTracingLogLevel(logLevel: LogLevel)
+    fun getTracingLogLevelFlow(): Flow<LogLevel>
+
+    suspend fun setTracingLogPacks(targets: Set<TraceLogPack>)
+    fun getTracingLogPacksFlow(): Flow<Set<TraceLogPack>>
+
+    suspend fun reset()
+}

libraries/preferences/api/src/main/kotlin/io/element/android/libraries/preferences/api/store/PreferenceDataStoreFactory.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2024, 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.libraries.preferences.api.store
+
+import androidx.datastore.core.DataStore
+import androidx.datastore.preferences.core.Preferences
+
+/**
+ * Factory used to create a [DataStore] for preferences.
+ *
+ * It's a wrapper around AndroidX's `PreferenceDataStoreFactory` to make testing easier.
+ */
+interface PreferenceDataStoreFactory {
+    fun create(name: String): DataStore<Preferences>
+}

libraries/preferences/api/src/main/kotlin/io/element/android/libraries/preferences/api/store/SessionPreferencesStore.kt

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2024, 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.libraries.preferences.api.store
+
+import kotlinx.coroutines.flow.Flow
+
+interface SessionPreferencesStore {
+    suspend fun setSharePresence(enabled: Boolean)
+    fun isSharePresenceEnabled(): Flow<Boolean>
+
+    suspend fun setSendPublicReadReceipts(enabled: Boolean)
+    fun isSendPublicReadReceiptsEnabled(): Flow<Boolean>
+
+    suspend fun setRenderReadReceipts(enabled: Boolean)
+    fun isRenderReadReceiptsEnabled(): Flow<Boolean>
+
+    suspend fun setSendTypingNotifications(enabled: Boolean)
+    fun isSendTypingNotificationsEnabled(): Flow<Boolean>
+
+    suspend fun setRenderTypingNotifications(enabled: Boolean)
+    fun isRenderTypingNotificationsEnabled(): Flow<Boolean>
+
+    suspend fun setSkipSessionVerification(skip: Boolean)
+    fun isSessionVerificationSkipped(): Flow<Boolean>
+
+    suspend fun setOptimizeImages(compress: Boolean)
+    fun doesOptimizeImages(): Flow<Boolean>
+
+    suspend fun setVideoCompressionPreset(preset: VideoCompressionPreset)
+    fun getVideoCompressionPreset(): Flow<VideoCompressionPreset>
+
+    suspend fun clear()
+}

libraries/preferences/api/src/main/kotlin/io/element/android/libraries/preferences/api/store/SessionPreferencesStoreFactory.kt

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2024, 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.libraries.preferences.api.store
+
+import io.element.android.libraries.matrix.api.core.SessionId
+import kotlinx.coroutines.CoroutineScope
+
+interface SessionPreferencesStoreFactory {
+    fun get(sessionId: SessionId, sessionCoroutineScope: CoroutineScope): SessionPreferencesStore
+    fun remove(sessionId: SessionId)
+}

libraries/preferences/api/src/main/kotlin/io/element/android/libraries/preferences/api/store/VideoCompressionPreset.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 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.libraries.preferences.api.store
+
+/**
+ * Video compression presets to use when processing videos before uploading them.
+ */
+enum class VideoCompressionPreset {
+    /** High quality compression, suitable for high-resolution videos. */
+    HIGH,
+
+    /** Standard quality compression, suitable for most videos. */
+    STANDARD,
+
+    /** Low quality compression, suitable for low-resolution videos or when bandwidth is a concern. */
+    LOW
+}