Add a SpaceScreen for listing rooms and subspaces within a space. (#4412)

ElementX/Sources/Screens/Spaces/SpaceScreen/SpaceScreenCoordinator.swift

@@ -0,0 +1,55 @@
+//
+// 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.
+//
+
+// periphery:ignore:all - this is just a space remove this comment once generating the final file
+
+import Combine
+import SwiftUI
+
+struct SpaceScreenCoordinatorParameters {
+    let spaceRoomListProxy: SpaceRoomListProxyProtocol
+    let mediaProvider: MediaProviderProtocol
+}
+
+enum SpaceScreenCoordinatorAction {
+    case selectSpace(SpaceRoomProxyProtocol)
+}
+
+final class SpaceScreenCoordinator: CoordinatorProtocol {
+    private let parameters: SpaceScreenCoordinatorParameters
+    private let viewModel: SpaceScreenViewModelProtocol
+    
+    private var cancellables = Set<AnyCancellable>()
+ 
+    private let actionsSubject: PassthroughSubject<SpaceScreenCoordinatorAction, Never> = .init()
+    var actionsPublisher: AnyPublisher<SpaceScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: SpaceScreenCoordinatorParameters) {
+        self.parameters = parameters
+        
+        viewModel = SpaceScreenViewModel(spaceRoomList: parameters.spaceRoomListProxy, mediaProvider: parameters.mediaProvider)
+    }
+    
+    func start() {
+        viewModel.actionsPublisher.sink { [weak self] action in
+            MXLog.info("Coordinator: received view model action: \(action)")
+            
+            guard let self else { return }
+            switch action {
+            case .selectSpace(let spaceRoom):
+                actionsSubject.send(.selectSpace(spaceRoom))
+            }
+        }
+        .store(in: &cancellables)
+    }
+        
+    func toPresentable() -> AnyView {
+        AnyView(SpaceScreen(context: viewModel.context))
+    }
+}

ElementX/Sources/Screens/Spaces/SpaceScreen/SpaceScreenModels.swift

@@ -0,0 +1,27 @@
+//
+// 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.
+//
+
+import Foundation
+
+enum SpaceScreenViewModelAction {
+    case selectSpace(SpaceRoomProxyProtocol)
+}
+
+struct SpaceScreenViewState: BindableState {
+    let space: SpaceRoomProxyProtocol
+    
+    var isPaginating = false
+    var rooms: [SpaceRoomProxyProtocol]
+    
+    var bindings = SpaceScreenViewStateBindings()
+}
+
+struct SpaceScreenViewStateBindings { }
+
+enum SpaceScreenViewAction {
+    case spaceAction(SpaceRoomCell.Action)
+}

ElementX/Sources/Screens/Spaces/SpaceScreen/SpaceScreenViewModel.swift

@@ -0,0 +1,60 @@
+//
+// 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.
+//
+
+import Combine
+import SwiftUI
+
+typealias SpaceScreenViewModelType = StateStoreViewModelV2<SpaceScreenViewState, SpaceScreenViewAction>
+
+class SpaceScreenViewModel: SpaceScreenViewModelType, SpaceScreenViewModelProtocol {
+    private let actionsSubject: PassthroughSubject<SpaceScreenViewModelAction, Never> = .init()
+    var actionsPublisher: AnyPublisher<SpaceScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+
+    init(spaceRoomList: SpaceRoomListProxyProtocol, mediaProvider: MediaProviderProtocol) {
+        super.init(initialViewState: SpaceScreenViewState(space: spaceRoomList.spaceRoom,
+                                                          rooms: spaceRoomList.spaceRoomsPublisher.value),
+                   mediaProvider: mediaProvider)
+        
+        spaceRoomList.spaceRoomsPublisher
+            .receive(on: DispatchQueue.main)
+            .weakAssign(to: \.state.rooms, on: self)
+            .store(in: &cancellables)
+        
+        spaceRoomList.paginationStatePublisher
+            .receive(on: DispatchQueue.main)
+            .sink { [weak self] paginationState in
+                switch paginationState {
+                case .idle(let endReached):
+                    self?.state.isPaginating = false
+                    guard !endReached else { return }
+                    Task { await spaceRoomList.paginate() }
+                case .loading:
+                    self?.state.isPaginating = true
+                }
+            }
+            .store(in: &cancellables)
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: SpaceScreenViewAction) {
+        MXLog.info("View model: received view action: \(viewAction)")
+        
+        switch viewAction {
+        case .spaceAction(.select(let spaceRoom)):
+            if spaceRoom.isSpace {
+                actionsSubject.send(.selectSpace(spaceRoom))
+            } else {
+                #warning("Implement joining")
+            }
+        case .spaceAction(.join(let spaceID)):
+            #warning("Implement joining.")
+        }
+    }
+}

ElementX/Sources/Screens/Spaces/SpaceScreen/SpaceScreenViewModelProtocol.swift

@@ -0,0 +1,14 @@
+//
+// 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.
+//
+
+import Combine
+
+@MainActor
+protocol SpaceScreenViewModelProtocol {
+    var actionsPublisher: AnyPublisher<SpaceScreenViewModelAction, Never> { get }
+    var context: SpaceScreenViewModelType.Context { get }
+}

ElementX/Sources/Screens/Spaces/SpaceScreen/View/SpaceScreen.swift

@@ -0,0 +1,71 @@
+//
+// 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.
+//
+
+import Compound
+import SwiftUI
+
+struct SpaceScreen: View {
+    @Bindable var context: SpaceScreenViewModel.Context
+    
+    var body: some View {
+        ScrollView {
+            LazyVStack(spacing: 0) {
+                SpaceHeaderView(spaceRoomProxy: context.viewState.space,
+                                mediaProvider: context.mediaProvider)
+                rooms
+            }
+        }
+        .navigationTitle(context.viewState.space.name ?? L10n.commonSpace)
+        .navigationBarTitleDisplayMode(.inline)
+        .background(Color.compound.bgCanvasDefault.ignoresSafeArea())
+    }
+    
+    @ViewBuilder
+    var rooms: some View {
+        ForEach(context.viewState.rooms, id: \.id) { spaceRoom in
+            SpaceRoomCell(spaceRoom: spaceRoom,
+                          isSelected: false,
+                          mediaProvider: context.mediaProvider) { action in
+                context.send(viewAction: .spaceAction(action))
+            }
+        }
+        
+        if context.viewState.isPaginating {
+            ProgressView()
+                .padding()
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct SpaceScreen_Previews: PreviewProvider, TestablePreview {
+    static let viewModel = makeViewModel()
+    
+    static var previews: some View {
+        NavigationStack {
+            SpaceScreen(context: viewModel.context)
+        }
+    }
+    
+    static func makeViewModel() -> SpaceScreenViewModel {
+        let spaceRoomProxy = SpaceRoomProxyMock(.init(id: "!eng-space:matrix.org",
+                                                      name: "Engineering Team",
+                                                      isSpace: true,
+                                                      childrenCount: 30,
+                                                      joinedMembersCount: 76,
+                                                      heroes: [.mockDan, .mockBob, .mockCharlie, .mockVerbose],
+                                                      topic: "Description of the space goes right here. Lorem ipsum dolor sit amet consectetur. Leo viverra morbi habitant in.",
+                                                      joinRule: .knockRestricted(rules: [.roomMembership(roomId: "")])))
+        let spaceRoomListProxy = SpaceRoomListProxyMock(.init(spaceRoomProxy: spaceRoomProxy,
+                                                              initialSpaceRooms: .mockSpaceList))
+        
+        let viewModel = SpaceScreenViewModel(spaceRoomList: spaceRoomListProxy,
+                                             mediaProvider: MediaProviderMock(configuration: .init()))
+        return viewModel
+    }
+}