First Commit

appconfig/build.gradle.kts

@@ -0,0 +1,53 @@
+import config.BuildTimeConfig
+import extension.buildConfigFieldStr
+
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2022-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.appconfig"
+
+    buildFeatures {
+        buildConfig = true
+    }
+
+    defaultConfig {
+        buildConfigFieldStr(
+            name = "URL_POLICY",
+            value = if (isEnterpriseBuild) {
+                BuildTimeConfig.URL_POLICY ?: ""
+            } else {
+                "https://element.io/cookie-policy"
+            },
+        )
+        buildConfigFieldStr(
+            name = "BUG_REPORT_URL",
+            value = if (isEnterpriseBuild) {
+                BuildTimeConfig.BUG_REPORT_URL ?: ""
+            } else {
+                "https://rageshakes.element.io/api/submit"
+            },
+        )
+        buildConfigFieldStr(
+            name = "BUG_REPORT_APP_NAME",
+            value = if (isEnterpriseBuild) {
+                BuildTimeConfig.BUG_REPORT_APP_NAME ?: ""
+            } else {
+                "element-x-android"
+            },
+        )
+    }
+}
+
+dependencies {
+    implementation(libs.androidx.annotationjvm)
+    implementation(projects.libraries.matrix.api)
+}

appconfig/src/main/kotlin/io/element/android/appconfig/AnalyticsConfig.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.appconfig
+
+object AnalyticsConfig {
+    const val POLICY_LINK = BuildConfig.URL_POLICY
+}

appconfig/src/main/kotlin/io/element/android/appconfig/ApplicationConfig.kt

@@ -0,0 +1,35 @@
+/*
+ * 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.appconfig
+
+object ApplicationConfig {
+    /**
+     * Application name used in the UI for string. If empty, the value is taken from the resources `R.string.app_name`.
+     * Note that this value is not used for the launcher icon.
+     * For Element, the value is empty, and so read from `R.string.app_name`, which depends on the build variant:
+     * - "Element X" for release builds;
+     * - "Element X dbg" for debug builds;
+     * - "Element X nightly" for nightly builds.
+     */
+    const val APPLICATION_NAME: String = ""
+
+    /**
+     * Used in the strings to reference the Element client.
+     * Cannot be empty.
+     * For Element, the value is "Element".
+     */
+    const val PRODUCTION_APPLICATION_NAME: String = "Element"
+
+    /**
+     * Used in the strings to reference the Element Desktop client, for instance Element Web.
+     * Cannot be empty.
+     * For Element, the value is "Element". We use the same name for desktop and mobile for now.
+     */
+    const val DESKTOP_APPLICATION_NAME: String = "Element"
+}

appconfig/src/main/kotlin/io/element/android/appconfig/AuthenticationConfig.kt

@@ -0,0 +1,23 @@
+/*
+ * 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.appconfig
+
+object AuthenticationConfig {
+    const val MATRIX_ORG_URL = "https://matrix.org"
+
+    /**
+     * URL with some docs that explain what's sliding sync and how to add it to your home server.
+     */
+    const val SLIDING_SYNC_READ_MORE_URL = "https://github.com/matrix-org/sliding-sync/blob/main/docs/Landing.md"
+
+    /**
+     * Force a sliding sync proxy url, if not null, the proxy url in the .well-known file will be ignored.
+     */
+    val SLIDING_SYNC_PROXY_URL: String? = null
+}

appconfig/src/main/kotlin/io/element/android/appconfig/ElementCallConfig.kt

@@ -0,0 +1,16 @@
+/*
+ * 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.appconfig
+
+object ElementCallConfig {
+    /**
+     * The default duration of a ringing call in seconds before it's automatically dismissed.
+     */
+    const val RINGING_CALL_DURATION_SECONDS = 90
+}

appconfig/src/main/kotlin/io/element/android/appconfig/LearnMoreConfig.kt

@@ -0,0 +1,16 @@
+/*
+ * 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.appconfig
+
+object LearnMoreConfig {
+    const val ENCRYPTION_URL: String = "https://element.io/help#encryption"
+    const val DEVICE_VERIFICATION_URL: String = "https://element.io/help#encryption-device-verification"
+    const val SECURE_BACKUP_URL: String = "https://element.io/help#encryption5"
+    const val IDENTITY_CHANGE_URL: String = "https://element.io/help#encryption18"
+}

appconfig/src/main/kotlin/io/element/android/appconfig/LockScreenConfig.kt

@@ -0,0 +1,35 @@
+/*
+ * 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.appconfig
+
+import kotlin.time.Duration
+import kotlin.time.Duration.Companion.minutes
+
+object LockScreenConfig {
+    /** Whether the PIN is mandatory or not. */
+    const val IS_PIN_MANDATORY: Boolean = false
+
+    /** Set of forbidden PIN codes. */
+    val FORBIDDEN_PIN_CODES: Set<String> = setOf("0000", "1234")
+
+    /** The size of the PIN. */
+    const val PIN_SIZE: Int = 4
+
+    /** Number of attempts before the user is logged out. */
+    const val MAX_PIN_CODE_ATTEMPTS_BEFORE_LOGOUT: Int = 3
+
+    /** Time period before locking the app once backgrounded. */
+    val GRACE_PERIOD: Duration = 2.minutes
+
+    /** Authentication with strong methods (fingerprint, some face/iris unlock implementations) is supported. */
+    const val IS_STRONG_BIOMETRICS_ENABLED: Boolean = true
+
+    /** Authentication with weak methods (most face/iris unlock implementations) is supported. */
+    const val IS_WEAK_BIOMETRICS_ENABLED: Boolean = true
+}

appconfig/src/main/kotlin/io/element/android/appconfig/MatrixConfiguration.kt

@@ -0,0 +1,14 @@
+/*
+ * 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.appconfig
+
+object MatrixConfiguration {
+    const val MATRIX_TO_PERMALINK_BASE_URL: String = "https://matrix.to/#/"
+    val clientPermalinkBaseUrl: String? = null
+}

appconfig/src/main/kotlin/io/element/android/appconfig/MessageComposerConfig.kt

@@ -0,0 +1,16 @@
+/*
+ * 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.appconfig
+
+object MessageComposerConfig {
+    /**
+     * Enable the rich text editing in the composer.
+     */
+    const val ENABLE_RICH_TEXT_EDITING = true
+}

appconfig/src/main/kotlin/io/element/android/appconfig/NotificationConfig.kt

@@ -0,0 +1,32 @@
+/*
+ * 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.appconfig
+
+import androidx.annotation.ColorInt
+import androidx.core.graphics.toColorInt
+
+object NotificationConfig {
+    /**
+     * If set to true, the notification will have a "Mark as read" action.
+     */
+    const val SHOW_MARK_AS_READ_ACTION = true
+
+    /**
+     * If set to true, the notification for invitation will have two actions to accept or decline the invite.
+     */
+    const val SHOW_ACCEPT_AND_DECLINE_INVITE_ACTIONS = true
+
+    /**
+     * If set to true, the notification will have a "Quick reply" action, allow to compose and send a message to the room.
+     */
+    const val SHOW_QUICK_REPLY_ACTION = true
+
+    @ColorInt
+    val NOTIFICATION_ACCENT_COLOR: Int = "#FF0DBD8B".toColorInt()
+}

appconfig/src/main/kotlin/io/element/android/appconfig/OnBoardingConfig.kt

@@ -0,0 +1,14 @@
+/*
+ * 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.appconfig
+
+object OnBoardingConfig {
+    /** Whether the user can create an account using the app. */
+    const val CAN_CREATE_ACCOUNT = true
+}

appconfig/src/main/kotlin/io/element/android/appconfig/PushConfig.kt

@@ -0,0 +1,16 @@
+/*
+ * 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.appconfig
+
+object PushConfig {
+    /**
+     * Note: pusher_app_id cannot exceed 64 chars.
+     */
+    const val PUSHER_APP_ID: String = "im.vector.app.android"
+}

appconfig/src/main/kotlin/io/element/android/appconfig/RageshakeConfig.kt

@@ -0,0 +1,28 @@
+/*
+ * 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.appconfig
+
+object RageshakeConfig {
+    /**
+     * The URL to submit bug reports to.
+     */
+    const val BUG_REPORT_URL = BuildConfig.BUG_REPORT_URL
+
+    /**
+     * As per https://github.com/matrix-org/rageshake:
+     * Identifier for the application (eg 'riot-web').
+     * Should correspond to a mapping configured in the configuration file for github issue reporting to work.
+     */
+    const val BUG_REPORT_APP_NAME = BuildConfig.BUG_REPORT_APP_NAME
+
+    /**
+     * The maximum size of the upload request. Default value is just below CloudFlare's max request size.
+     */
+    const val MAX_LOG_UPLOAD_SIZE = 50 * 1024 * 1024L
+}

appconfig/src/main/kotlin/io/element/android/appconfig/RoomListConfig.kt

@@ -0,0 +1,16 @@
+/*
+ * 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.appconfig
+
+object RoomListConfig {
+    const val SHOW_INVITE_MENU_ITEM = false
+    const val SHOW_REPORT_PROBLEM_MENU_ITEM = false
+
+    const val HAS_DROP_DOWN_MENU = SHOW_INVITE_MENU_ITEM || SHOW_REPORT_PROBLEM_MENU_ITEM
+}

appconfig/src/main/kotlin/io/element/android/appconfig/TimelineConfig.kt

@@ -0,0 +1,35 @@
+/*
+ * 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.appconfig
+
+import io.element.android.libraries.matrix.api.room.StateEventType
+
+object TimelineConfig {
+    const val MAX_READ_RECEIPT_TO_DISPLAY = 3
+
+    /**
+     * Event types that will be filtered out from the timeline (i.e. not displayed).
+     */
+    val excludedEvents = listOf(
+        StateEventType.CALL_MEMBER,
+        StateEventType.ROOM_ALIASES,
+        StateEventType.ROOM_CANONICAL_ALIAS,
+        StateEventType.ROOM_GUEST_ACCESS,
+        StateEventType.ROOM_HISTORY_VISIBILITY,
+        StateEventType.ROOM_JOIN_RULES,
+        StateEventType.ROOM_POWER_LEVELS,
+        StateEventType.ROOM_SERVER_ACL,
+        StateEventType.ROOM_TOMBSTONE,
+        StateEventType.SPACE_CHILD,
+        StateEventType.SPACE_PARENT,
+        StateEventType.POLICY_RULE_ROOM,
+        StateEventType.POLICY_RULE_SERVER,
+        StateEventType.POLICY_RULE_USER,
+    )
+}

appconfig/src/main/kotlin/io/element/android/appconfig/VoiceMessageConfig.kt

@@ -0,0 +1,15 @@
+/*
+ * 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.appconfig
+
+import kotlin.time.Duration.Companion.minutes
+
+object VoiceMessageConfig {
+    val maxVoiceMessageDuration = 30.minutes
+}