release: [v3.4.5] (Apr 07 2023) (#482)

Features:

* Add a message list filter of UI level in the `Channel` module
  * Add `Channel.filterMessageList?: (messages: BaseMessage): boolean;`, a UI level filter prop
    to Channel. This function will be used to filter messages in `<MessageList />`

    example:
    ```javascript
    // set your channel URL
    const channel = "";
    export const ChannelWithFilter = () => {
      const channelFilter = useCallback((message) => {
        const now = Date.now();
        const twoWeeksAgo = now - 1000 * 60 * 60 * 24 * 14;
        return message.createdAt > twoWeeksAgo;
      }, []);
      return (
        <Channel
            channelUrl={channel}
            filterMessageList={channelFilter}
        />
      );
    };
    ```

* Improve structure of message UI for copying
    Before:
    * The words inside messages were kept in separate spans
    * This would lead to unfavourable formatting when pasted in other applications

    After:
    * Remove span for wrapping simple strings in message body
    * Urls and Mentions will still be wrapped in spans(for formatting)
    * Apply new logic & components(TextFragment) to tokenize strings
    * Improve keys used in rendering inside message,
      * UUIDs are not the optimal way to improve rendering
      * Create a composite key with message.updatedAt
    * Refactor usePaste hook to make mentions work ~
    * Fix overflow of long strings
    * Deprecate `Word` and `convertWordToStringObj`

* Export MessageProvider, a simple provider to avoid prop drilling into Messages
    Note - this is still in works, but these props will remain
    * In the future, we will add methods - to this module - to:
      * Edit & delete callbacks
      * Menu render options(ACLs)
      * Reaction configs
      * This will improve the customizability and remove a lot of prop drilling in Messages

    ```javascript
    export type MessageProviderProps = {
      children: React.ReactNode;
      message: BaseMessage;
      isByMe?: boolean;
    }

    import { MessageProvider, useMessageContext } from '@sendbird/uikit-react/Message/context'
    ```
    Incase if you were using MessageComponents and see error message
    `useMessageContext must be used within a MessageProvider `
    use: `<MessageProvider message={message}><CustomMessage /></MessageProvider>`

* Add a scheduler for calling markAsRead intervally
  * The `markAsRead` is called on individual channels is un-optimal(causes command ack. error)
because we have a list of channels that do this
ideally this should be fixed in server/SDK
this is a work around for the meantime to un-throttle the customer

Fixes:
* Set current channel on `ChannelList` when opening channel from the parent message of `Thread`
  * Issue: The ChannelPreview item is not selected when opening the channel from
  the ParentMessage of the Thread
  * Fix: Set activeChannelUrl of ChannelList
* Detect new lines in safari on the `MessageInput` component
  * Safari puts `<div>text</div>` for new lines inside content editable div(input)
  * Other browsers put newline or `br`

[SDKRLSD-761](https://sendbird.atlassian.net/browse/SDKRLSD-761)

Co-authored-by: HoonBaek <[email protected]>

Author: Sravan S

CHANGELOG.md

@@ -1,6 +1,86 @@
 # Changelog - v3
 
+## [v3.4.5] (Apr 7 2023)
+
+Features:
+
+* Add a message list filter of UI level in the `Channel` module
+  * Add `Channel.filterMessageList?: (messages: BaseMessage): boolean;`, a UI level filter prop
+    to Channel. This function will be used to filter messages in `<MessageList />`
+
+    example:
+    ```javascript
+    // set your channel URL
+    const channel = "";
+    export const ChannelWithFilter = () => {
+      const channelFilter = useCallback((message) => {
+        const now = Date.now();
+        const twoWeeksAgo = now - 1000 * 60 * 60 * 24 * 14;
+        return message.createdAt > twoWeeksAgo;
+      }, []);
+      return (
+        <Channel
+              channelUrl={channel}
+              filterMessageList={channelFilter}
+            />
+      );
+    };
+    ```
+
+* Improve structure of message UI for copying
+    Before:
+    * The words inside messages were kept in separate spans
+    * This would lead to unfavourable formatting when pasted in other applications
+
+    After:
+    * Remove span for wrapping simple strings in message body
+    * Urls and Mentions will still be wrapped in spans(for formatting)
+    * Apply new logic & components(TextFragment) to tokenize strings
+    * Improve keys used in rendering inside message,
+      * UUIDs are not the optimal way to improve rendering
+      * Create a composite key with message.updatedAt
+    * Refactor usePaste hook to make mentions work ~
+    * Fix overflow of long strings
+    * Deprecate `Word` and `convertWordToStringObj`
+
+* Export MessageProvider, a simple provider to avoid prop drilling into Messages
+    Note - this is still in works, but these props will remain
+    * In the future, we will add methods - to this module - to:
+      * Edit & delete callbacks
+      * Menu render options(ACLs)
+      * Reaction configs
+      * This will improve the customizability and remove a lot of prop drilling in Messages
+
+    ```
+    export type MessageProviderProps = {
+      children: React.ReactNode;
+      message: BaseMessage;
+      isByMe?: boolean;
+    }
+
+    import { MessageProvider, useMessageContext } from '@sendbird/uikit-react/Message/context'
+    ```
+    Incase if you were using MessageComponents and see error message
+    `useMessageContext must be used within a MessageProvider `
+    use: `<MessageProvider message={message}><CustomMessage /></MessageProvider>`
+
+* Add a scheduler for calling markAsRead intervally
+  * The `markAsRead` is called on individual channels is un-optimal(causes command ack. error)
+because we have a list of channels that do this
+ideally this should be fixed in server/SDK
+this is a work around for the meantime to un-throttle the customer
+
+Fixes:
+* Set current channel on `ChannelList` when opening channel from the parent message of `Thread`
+  * Issue: The ChannelPreview item is not selected when opening the channel from
+  the ParentMessage of the Thread
+  * Fix: Set activeChannelUrl of ChannelList
+* Detect new lines in safari on the `MessageInput` component
+  * Safari puts `<div>text</div>` for new lines inside content editable div(input)
+  * Other browsers put newline or `br`
+
 ## [v3.4.4] (Mar 31 2023)
+
 Features:
 * Increase default maximum recording time of Voice Message to 10 minutes
 * Add logger to VoicePlayer, VoiceRecorder, and useSendVoiceMessage hook