Merge pull request #5432 from element-hq/feature/bma/leaveSpace

Leave space: use SDK API.

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/MatrixPatterns.kt

@@ -69,14 +69,6 @@ object MatrixPatterns {
             str matches PATTERN_CONTAIN_MATRIX_USER_IDENTIFIER
     }
 
-    /**
-     * Tells if a string is a valid space id. This is an alias for [isRoomId]
-     *
-     * @param str the string to test
-     * @return true if the string is a valid space Id
-     */
-    fun isSpaceId(str: String?) = isRoomId(str)
-
     /**
      * Tells if a string is a valid room id.
      *

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/core/SpaceId.kt

@@ -7,23 +7,7 @@
 
 package io.element.android.libraries.matrix.api.core
 
-import io.element.android.libraries.androidutils.metadata.isInDebug
-import java.io.Serializable
-
-@JvmInline
-value class SpaceId(val value: String) : Serializable {
-    init {
-        if (isInDebug && !MatrixPatterns.isSpaceId(value)) {
-            error(
-                "`$value` is not a valid space id.\n" +
-                    "Space ids are the same as room ids.\n" +
-                    "Example space id: `!space_id:domain`."
-            )
-        }
-    }
-
-    override fun toString(): String = value
-}
+typealias SpaceId = RoomId
 
 /**
  * Value to use when no space is selected by the user.

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/encryption/RecoveryException.kt

@@ -11,6 +11,7 @@ import io.element.android.libraries.matrix.api.exception.ClientException
 
 sealed class RecoveryException(message: String) : Exception(message) {
     class SecretStorage(message: String) : RecoveryException(message)
+    class Import(message: String) : RecoveryException(message)
     data object BackupExistsOnServer : RecoveryException("BackupExistsOnServer")
     data class Client(val exception: ClientException) : RecoveryException(exception.message ?: "Unknown error")
 }

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/spaces/LeaveSpaceHandle.kt

@@ -0,0 +1,34 @@
+/*
+ * 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.matrix.api.spaces
+
+import io.element.android.libraries.matrix.api.core.RoomId
+
+interface LeaveSpaceHandle {
+    /**
+     * The id of the space to leave.
+     */
+    val id: RoomId
+
+    /**
+     * Get a list of rooms that can be left when leaving the space.
+     * It will include the current space and all the subspaces and rooms that the user has joined.
+     */
+    suspend fun rooms(): Result<List<LeaveSpaceRoom>>
+
+    /**
+     * Leave the space and the given rooms.
+     * If [roomIds] is empty, only the space will be left.
+     */
+    suspend fun leave(roomIds: List<RoomId>): Result<Unit>
+
+    /**
+     * Close the handle and free resources.
+     */
+    fun close()
+}

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/spaces/LeaveSpaceRoom.kt

@@ -0,0 +1,13 @@
+/*
+ * 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.matrix.api.spaces
+
+data class LeaveSpaceRoom(
+    val spaceRoom: SpaceRoom,
+    val isLastAdmin: Boolean,
+)

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/spaces/SpaceService.kt

@@ -15,4 +15,6 @@ interface SpaceService {
     suspend fun joinedSpaces(): Result<List<SpaceRoom>>
 
     fun spaceRoomList(id: RoomId): SpaceRoomList
+
+    fun getLeaveSpaceHandle(spaceId: RoomId): LeaveSpaceHandle
 }