added code docs

Author: martinmitrevski

Sources/StreamChatSwiftUI/ChatChannel/Composer/MessageComposerView.swift

@@ -132,19 +132,20 @@ public struct MessageComposerView<Factory: ViewFactory>: View, KeyboardReadable
             }
         }
         .overlay(
-            viewModel.composerCommand != nil ? CommandsContainerView(
-                suggestions: viewModel.suggestions,
-                handleCommand: { commandInfo in
-                    viewModel.handleCommand(
-                        for: $viewModel.text,
-                        selectedRangeLocation: $viewModel.selectedRangeLocation,
-                        command: $viewModel.composerCommand,
-                        extraData: commandInfo
-                    )
-                }
-            )
-            .offset(y: -composerHeight)
-            .animation(nil) : nil,
+            viewModel.composerCommand != nil ?
+                factory.makeCommandsContainerView(
+                    suggestions: viewModel.suggestions,
+                    handleCommand: { commandInfo in
+                        viewModel.handleCommand(
+                            for: $viewModel.text,
+                            selectedRangeLocation: $viewModel.selectedRangeLocation,
+                            command: $viewModel.composerCommand,
+                            extraData: commandInfo
+                        )
+                    }
+                )
+                .offset(y: -composerHeight)
+                .animation(nil) : nil,
             alignment: .bottom
         )
         .alert(isPresented: $viewModel.errorShown) {

Sources/StreamChatSwiftUI/ChatChannel/Composer/MessageComposerViewModel.swift

@@ -10,6 +10,7 @@ import SwiftUI
 /// View model for the `MessageComposerView`.
 public class MessageComposerViewModel: ObservableObject {
     @Injected(\.chatClient) private var chatClient
+    @Injected(\.utils) private var utils
 
     @Published var pickerState: AttachmentPickerState = .photos {
         didSet {
@@ -89,19 +90,19 @@ public class MessageComposerViewModel: ObservableObject {
     private let channelController: ChatChannelController
     private var messageController: ChatMessageController?
 
-    private let mentionsSuggester: MentionsSuggester
     private var cancellables = Set<AnyCancellable>()
-    private lazy var commandsHandler = CommandsHandler(commands: [
-        MentionsSuggester(channelController: channelController)
-    ])
+    private lazy var commandsHandler = utils
+        .commandsConfig
+        .makeCommandsHandler(
+            with: channelController
+        )
 
     public init(
         channelController: ChatChannelController,
         messageController: ChatMessageController?
     ) {
         self.channelController = channelController
         self.messageController = messageController
-        mentionsSuggester = MentionsSuggester(channelController: channelController)
     }
 
     public func sendMessage(

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/CommandsConfig.swift

@@ -0,0 +1,34 @@
+//
+// Copyright © 2021 Stream.io Inc. All rights reserved.
+//
+
+import Foundation
+import StreamChat
+
+/// Configuration for the commands in the composer.
+public protocol CommandsConfig {
+    
+    /// Creates the main commands handler.
+    /// - Parameter channelController: the controller of the channel.
+    /// - Returns: `CommandsHandler`.
+    func makeCommandsHandler(
+        with channelController: ChatChannelController
+    ) -> CommandsHandler
+}
+
+/// Default commands configuration.
+public struct DefaultCommandsConfig: CommandsConfig {
+    
+    public init() {}
+    
+    public func makeCommandsHandler(
+        with channelController: ChatChannelController
+    ) -> CommandsHandler {
+        let mentionsCommand = MentionsCommandHandler(
+            channelController: channelController,
+            commandSymbol: "@",
+            mentionAllAppUsers: false
+        )
+        return CommandsHandler(commands: [mentionsCommand])
+    }
+}

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/CommandsContainerView.swift

@@ -5,6 +5,7 @@
 import StreamChat
 import SwiftUI
 
+/// Default implementation of the commands container.
 struct CommandsContainerView: View {
 
     var suggestions: [String: Any]

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/CommandsHandler.swift

@@ -6,19 +6,35 @@ import Combine
 import StreamChat
 import SwiftUI
 
-protocol CommandHandler {
+/// Defines methods for handling commands.
+public protocol CommandHandler {
 
+    /// Identifier of the command.
     var id: String { get }
 
+    /// Checks whether the command can be handled.
+    /// - Parameters:
+    ///  - text: the user entered text.
+    ///  - caretLocation: the end location of a selected text range.
+    /// - Returns: optional `ComposerCommand` (if the handler can handle the command).
     func canHandleCommand(
         in text: String,
         caretLocation: Int
     ) -> ComposerCommand?
 
+    /// Shows suggestions for the provided command.
+    /// - Parameter command: the command whose suggestions will be shown.
+    /// - Returns: `Future` with the suggestions, or an error.
     func showSuggestions(
         for command: ComposerCommand
     ) -> Future<SuggestionInfo, Error>
 
+    /// Handles the provided command.
+    /// - Parameters:
+    ///  - text: the user entered text.
+    ///  - selectedRangeLocation: the end location of the selected text.
+    ///  - command: binding of the command.
+    ///  - extraData: additional data that can be passed from the command.
     func handleCommand(
         for text: Binding<String>,
         selectedRangeLocation: Binding<Int>,
@@ -27,26 +43,34 @@ protocol CommandHandler {
     )
 }
 
-struct ComposerCommand {
+/// Model for the composer's commands.
+public struct ComposerCommand {
+    /// Identifier of the command.
     let id: String
+    /// Typing suggestion that invokes the command.
     let typingSuggestion: TypingSuggestion
 }
 
-struct SuggestionInfo {
+/// Provides information about the suggestion.
+public struct SuggestionInfo {
+    /// Identifies the suggestion.
     let key: String
+    /// Any value that can be passed to the suggestion.
     let value: Any
 }
 
-class CommandsHandler: CommandHandler {
+/// Main commands handler - decides which commands to invoke.
+/// Command is matched if there's an id matching.
+public class CommandsHandler: CommandHandler {
 
     private let commands: [CommandHandler]
-    let id: String = "main"
+    public let id: String = "main"
 
     init(commands: [CommandHandler]) {
         self.commands = commands
     }
 
-    func canHandleCommand(in text: String, caretLocation: Int) -> ComposerCommand? {
+    public func canHandleCommand(in text: String, caretLocation: Int) -> ComposerCommand? {
         for command in commands {
             if let composerCommand = command.canHandleCommand(
                 in: text,
@@ -59,7 +83,7 @@ class CommandsHandler: CommandHandler {
         return nil
     }
 
-    func showSuggestions(
+    public func showSuggestions(
         for command: ComposerCommand
     ) -> Future<SuggestionInfo, Error> {
         for handler in commands {
@@ -71,7 +95,7 @@ class CommandsHandler: CommandHandler {
         return StreamChatError.wrongConfig.asFailedPromise()
     }
 
-    func handleCommand(
+    public func handleCommand(
         for text: Binding<String>,
         selectedRangeLocation: Binding<Int>,
         command: Binding<ComposerCommand?>,

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/MentionUsersView.swift

@@ -5,7 +5,8 @@
 import StreamChat
 import SwiftUI
 
-struct MentionUsersView: View {
+/// View for the mentioned users.
+public struct MentionUsersView: View {
 
     @Injected(\.colors) private var colors
 
@@ -14,7 +15,7 @@ struct MentionUsersView: View {
     var users: [ChatUser]
     var userSelected: (ChatUser) -> Void
 
-    var body: some View {
+    public var body: some View {
         ScrollView {
             LazyVStack {
                 ForEach(users) { user in
@@ -42,14 +43,15 @@ struct MentionUsersView: View {
     }
 }
 
-struct MentionUserView: View {
+/// View for one user that can be mentioned.
+public struct MentionUserView: View {
     @Injected(\.fonts) private var fonts
     @Injected(\.colors) private var colors
 
     var user: ChatUser
     var userSelected: (ChatUser) -> Void
 
-    var body: some View {
+    public var body: some View {
         HStack {
             MessageAvatarView(
                 author: user,

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/MentionsSuggester.swift renamed to Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/MentionsCommandHandler.swift

@@ -6,23 +6,31 @@ import Combine
 import StreamChat
 import SwiftUI
 
-public struct MentionsSuggester: CommandHandler {
+/// Handles the mention command and provides suggestions.
+public struct MentionsCommandHandler: CommandHandler {
 
-    let id: String = "mentions"
+    public let id: String
 
-    // TODO: read from config
-    private var mentionAllAppUsers = false
-    private let typingSuggester = TypingSuggester(options: .init(symbol: "@"))
+    private let mentionAllAppUsers: Bool
+    private let typingSuggester: TypingSuggester
 
     private let channelController: ChatChannelController
     private let userSearchController: ChatUserSearchController
 
-    init(channelController: ChatChannelController) {
+    init(
+        channelController: ChatChannelController,
+        commandSymbol: String,
+        mentionAllAppUsers: Bool,
+        id: String = "mentions"
+    ) {
+        self.id = id
         self.channelController = channelController
+        self.mentionAllAppUsers = mentionAllAppUsers
+        typingSuggester = TypingSuggester(options: .init(symbol: commandSymbol))
         userSearchController = channelController.client.userSearchController()
     }
 
-    func canHandleCommand(in text: String, caretLocation: Int) -> ComposerCommand? {
+    public func canHandleCommand(in text: String, caretLocation: Int) -> ComposerCommand? {
         if let suggestion = typingSuggester.typingSuggestion(
             in: text,
             caretLocation: caretLocation
@@ -33,7 +41,7 @@ public struct MentionsSuggester: CommandHandler {
         }
     }
 
-    func handleCommand(
+    public func handleCommand(
         for text: Binding<String>,
         selectedRangeLocation: Binding<Int>,
         command: Binding<ComposerCommand?>,
@@ -57,7 +65,7 @@ public struct MentionsSuggester: CommandHandler {
         command.wrappedValue = nil
     }
 
-    func showSuggestions(
+    public func showSuggestions(
         for command: ComposerCommand
     ) -> Future<SuggestionInfo, Error> {
         showMentionSuggestions(

Sources/StreamChatSwiftUI/DefaultViewFactory.swift

@@ -507,6 +507,16 @@ extension ViewFactory {
     ) -> some View {
         EditMessageHeaderView(editedMessage: editedMessage)
     }
+    
+    public func makeCommandsContainerView(
+        suggestions: [String: Any],
+        handleCommand: @escaping ([String: Any]) -> Void
+    ) -> some View {
+        CommandsContainerView(
+            suggestions: suggestions,
+            handleCommand: handleCommand
+        )
+    }
 }
 
 /// Default class conforming to `ViewFactory`, used throughout the SDK.

Sources/StreamChatSwiftUI/Utils.swift

@@ -17,6 +17,7 @@ public class Utils {
     public var channelAvatarsMerger: ChannelAvatarsMerging
     public var messageTypeResolver: MessageTypeResolving
     public var messageActionsResolver: MessageActionsResolving
+    public var commandsConfig: CommandsConfig
 
     public init(
         dateFormatter: DateFormatter = .makeDefault(),
@@ -28,6 +29,7 @@ public class Utils {
         channelAvatarsMerger: ChannelAvatarsMerging = ChannelAvatarsMerger(),
         messageTypeResolver: MessageTypeResolving = MessageTypeResolver(),
         messageActionResolver: MessageActionsResolving = MessageActionsResolver(),
+        commandsConfig: CommandsConfig = DefaultCommandsConfig(),
         channelNamer: @escaping ChatChannelNamer = DefaultChatChannelNamer()
     ) {
         self.dateFormatter = dateFormatter
@@ -40,5 +42,6 @@ public class Utils {
         self.channelAvatarsMerger = channelAvatarsMerger
         self.messageTypeResolver = messageTypeResolver
         messageActionsResolver = messageActionResolver
+        self.commandsConfig = commandsConfig
     }
 }

Sources/StreamChatSwiftUI/ViewFactory.swift

@@ -482,4 +482,15 @@ public protocol ViewFactory: AnyObject {
     func makeEditedMessageHeaderView(
         editedMessage: Binding<ChatMessage?>
     ) -> EditedMessageHeaderViewType
+    
+    associatedtype CommandsContainerViewType: View
+    /// Creates the commands container view, above the composer.
+    /// - Parameters:
+    ///  - suggestions: key-value based suggestions, depending on the command type.
+    ///  - handleCommand: should be invoked by views when a command is executed.
+    /// - Returns: view displayed in the commands container slot.
+    func makeCommandsContainerView(
+        suggestions: [String: Any],
+        handleCommand: @escaping ([String: Any]) -> Void
+    ) -> CommandsContainerViewType
 }