Initial implementation of the JoinRoomScreen. (#2684)

* Update Compound and use super button for room directory.

ElementX/Sources/Screens/JoinRoomScreen/JoinRoomScreenCoordinator.swift

@@ -0,0 +1,72 @@
+//
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Combine
+import SwiftUI
+
+struct JoinRoomScreenCoordinatorParameters {
+    let roomID: String
+    let roomName: String
+    let avatarURL: URL?
+    let interaction: JoinRoomScreenInteraction
+    let clientProxy: ClientProxyProtocol
+}
+
+enum JoinRoomScreenCoordinatorAction {
+    case joined
+    case cancelled
+}
+
+final class JoinRoomScreenCoordinator: CoordinatorProtocol {
+    private let parameters: JoinRoomScreenCoordinatorParameters
+    private let viewModel: JoinRoomScreenViewModelProtocol
+    
+    private var cancellables = Set<AnyCancellable>()
+ 
+    private let actionsSubject: PassthroughSubject<JoinRoomScreenCoordinatorAction, Never> = .init()
+    var actionsPublisher: AnyPublisher<JoinRoomScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: JoinRoomScreenCoordinatorParameters) {
+        self.parameters = parameters
+        
+        viewModel = JoinRoomScreenViewModel(roomID: parameters.roomID,
+                                            roomName: parameters.roomName,
+                                            avatarURL: parameters.avatarURL,
+                                            interaction: parameters.interaction,
+                                            clientProxy: parameters.clientProxy)
+    }
+    
+    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 .joined:
+                actionsSubject.send(.joined)
+            case .cancelled:
+                actionsSubject.send(.cancelled)
+            }
+        }
+        .store(in: &cancellables)
+    }
+        
+    func toPresentable() -> AnyView {
+        AnyView(JoinRoomScreen(context: viewModel.context))
+    }
+}

ElementX/Sources/Screens/JoinRoomScreen/JoinRoomScreenModels.swift

@@ -0,0 +1,74 @@
+//
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Foundation
+
+enum JoinRoomScreenViewModelAction {
+    case joined
+    case cancelled
+}
+
+struct JoinRoomScreenViewState: BindableState {
+    // Maybe use room summary details or similar here??
+    let roomID: String
+    let roomName: String
+    let avatarURL: URL?
+    
+    let interaction: JoinRoomScreenInteraction
+    
+    var isJoining = false
+    
+    var bindings = JoinRoomScreenViewStateBindings()
+    
+    var title: String {
+        switch interaction {
+        case .knock:
+            L10n.screenJoinRoomTitleKnock
+        case .join, .invited:
+            L10n.screenJoinRoomTitleNoPreview
+        }
+    }
+    
+    var subtitle: String {
+        switch interaction {
+        case .knock:
+            L10n.screenJoinRoomSubtitleKnock
+        case .join, .invited:
+            L10n.screenJoinRoomSubtitleNoPreview
+        }
+    }
+}
+
+struct JoinRoomScreenViewStateBindings {
+    var alertInfo: AlertInfo<JoinRoomScreenAlertType>?
+}
+
+enum JoinRoomScreenAlertType {
+    case joinFailed
+}
+
+enum JoinRoomScreenInteraction {
+    case knock
+    case join
+    case invited
+}
+
+enum JoinRoomScreenViewAction {
+    case knock
+    case join
+    case acceptInvite
+    case declineInvite
+}

ElementX/Sources/Screens/JoinRoomScreen/JoinRoomScreenViewModel.swift

@@ -0,0 +1,67 @@
+//
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Combine
+import SwiftUI
+
+typealias JoinRoomScreenViewModelType = StateStoreViewModel<JoinRoomScreenViewState, JoinRoomScreenViewAction>
+
+class JoinRoomScreenViewModel: JoinRoomScreenViewModelType, JoinRoomScreenViewModelProtocol {
+    private let clientProxy: ClientProxyProtocol
+    
+    private let actionsSubject: PassthroughSubject<JoinRoomScreenViewModelAction, Never> = .init()
+    var actionsPublisher: AnyPublisher<JoinRoomScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+
+    init(roomID: String, roomName: String, avatarURL: URL?, interaction: JoinRoomScreenInteraction, clientProxy: ClientProxyProtocol) {
+        self.clientProxy = clientProxy
+        
+        super.init(initialViewState: JoinRoomScreenViewState(roomID: roomID,
+                                                             roomName: roomName,
+                                                             avatarURL: avatarURL,
+                                                             interaction: interaction))
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: JoinRoomScreenViewAction) {
+        MXLog.info("View model: received view action: \(viewAction)")
+        
+        switch viewAction {
+        case .knock:
+            break
+        case .join:
+            Task { await joinRoom() }
+        case .acceptInvite:
+            break
+        case .declineInvite:
+            break
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func joinRoom() async {
+        state.isJoining = true
+        switch await clientProxy.joinRoom(state.roomID) {
+        case .success:
+            actionsSubject.send(.joined)
+        case .failure(let error):
+            state.bindings.alertInfo = .init(id: .joinFailed)
+        }
+    }
+}

ElementX/Sources/Screens/JoinRoomScreen/JoinRoomScreenViewModelProtocol.swift

@@ -0,0 +1,23 @@
+//
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Combine
+
+@MainActor
+protocol JoinRoomScreenViewModelProtocol {
+    var actionsPublisher: AnyPublisher<JoinRoomScreenViewModelAction, Never> { get }
+    var context: JoinRoomScreenViewModelType.Context { get }
+}

ElementX/Sources/Screens/JoinRoomScreen/View/JoinRoomScreen.swift

@@ -0,0 +1,130 @@
+//
+// Copyright 2022 New Vector Ltd
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import Compound
+import SwiftUI
+
+struct JoinRoomScreen: View {
+    @Environment(\.dynamicTypeSize) private var dynamicTypeSize
+    
+    @ObservedObject var context: JoinRoomScreenViewModel.Context
+    
+    var body: some View {
+        FullscreenDialog(topPadding: 80, background: .bloom) {
+            mainContent
+        } bottomContent: {
+            buttons
+        }
+        .background()
+        .backgroundStyle(.compound.bgCanvasDefault)
+        .navigationBarTitleDisplayMode(.inline)
+        .toolbar { toolbar }
+    }
+    
+    var mainContent: some View {
+        VStack(spacing: 16) {
+            LoadableAvatarImage(url: context.viewState.avatarURL,
+                                name: context.viewState.roomName,
+                                contentID: context.viewState.roomID,
+                                avatarSize: .room(on: .joinRoom),
+                                imageProvider: context.imageProvider)
+                .dynamicTypeSize(dynamicTypeSize < .accessibility1 ? dynamicTypeSize : .accessibility1)
+            
+            VStack(spacing: 8) {
+                Text(context.viewState.title)
+                    .font(.compound.headingMDBold)
+                    .foregroundStyle(.compound.textPrimary)
+                    .multilineTextAlignment(.center)
+                
+                Text(context.viewState.subtitle)
+                    .font(.compound.bodyMD)
+                    .foregroundStyle(.compound.textSecondary)
+                    .multilineTextAlignment(.center)
+            }
+            
+            Image(asset: Asset.Images.joinRoomGraphic)
+                .padding(.top, 40)
+        }
+    }
+    
+    @ViewBuilder
+    var buttons: some View {
+        switch context.viewState.interaction {
+        case .knock:
+            Button(L10n.screenJoinRoomKnockAction) { context.send(viewAction: .knock) }
+                .buttonStyle(.compound(.primary))
+        case .join:
+            Button(L10n.screenJoinRoomJoinAction) { context.send(viewAction: .join) }
+                .buttonStyle(.compound(.super))
+        case .invited:
+            ViewThatFits {
+                HStack(spacing: 8) { inviteButtons }
+                VStack(spacing: 16) { inviteButtons }
+            }
+        }
+    }
+    
+    @ViewBuilder
+    var inviteButtons: some View {
+        Button(L10n.actionDecline) { context.send(viewAction: .acceptInvite) }
+            .buttonStyle(.compound(.secondary))
+        Button(L10n.actionAccept) { context.send(viewAction: .declineInvite) }
+            .buttonStyle(.compound(.primary))
+    }
+    
+    @ToolbarContentBuilder
+    var toolbar: some ToolbarContent {
+        ToolbarItem(placement: .principal) {
+            RoomHeaderView(roomID: context.viewState.roomID,
+                           roomName: context.viewState.roomName,
+                           avatarURL: context.viewState.avatarURL,
+                           imageProvider: context.imageProvider)
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct JoinRoomScreen_Previews: PreviewProvider, TestablePreview {
+    static let knockViewModel = makeViewModel(interaction: .knock)
+    static let joinViewModel = makeViewModel(interaction: .join)
+    static let inviteViewModel = makeViewModel(interaction: .invited)
+    
+    static var previews: some View {
+        NavigationStack {
+            JoinRoomScreen(context: knockViewModel.context)
+        }
+        .previewDisplayName("Knock")
+        
+        NavigationStack {
+            JoinRoomScreen(context: joinViewModel.context)
+        }
+        .previewDisplayName("Join")
+        
+        NavigationStack {
+            JoinRoomScreen(context: inviteViewModel.context)
+        }
+        .previewDisplayName("Invite")
+    }
+    
+    static func makeViewModel(interaction: JoinRoomScreenInteraction) -> JoinRoomScreenViewModel {
+        JoinRoomScreenViewModel(roomID: "6",
+                                roomName: "Room Name",
+                                avatarURL: nil,
+                                interaction: interaction,
+                                clientProxy: ClientProxyMock(.init()))
+    }
+}