feat: Add delivered status indicator for messages

This commit introduces a new "delivered" status for messages, which is displayed when a message has been delivered but not yet read.

**Key changes:**

-   Added `isMessageDelivered` property to `MessageItemState` and `MessageListItem`.
-   Introduced a new grey double-check icon (`stream_ui_ic_check_double_grey`) for the delivered state.
-   Updated `ChannelListViewStyle` and `MessageListItemStyle` to include `indicatorDeliveredIcon`.
-   The message status indicator logic in both UI Components and Compose has been updated to show the delivered icon between the "sent" and "read" states.
-   Added a new `stream_ui_message_list_semantics_message_status_delivered` string for accessibility.
-   In Compose, `MessageFooterStatusIndicator` is updated to accept `MessageFooterStatusIndicatorParams` to handle the new delivered state, deprecating the old signature.

Author: andremion

stream-chat-android-compose/api/stream-chat-android-compose.api

@@ -1613,7 +1613,7 @@ public final class io/getstream/chat/android/compose/ui/components/channels/Comp
 
 public final class io/getstream/chat/android/compose/ui/components/channels/MessageReadStatusIconKt {
 	public static final fun MessageReadStatusIcon (Lio/getstream/chat/android/models/Channel;Lio/getstream/chat/android/models/Message;Lio/getstream/chat/android/models/User;Landroidx/compose/ui/Modifier;Landroidx/compose/runtime/Composer;II)V
-	public static final fun MessageReadStatusIcon (Lio/getstream/chat/android/models/Message;ZLandroidx/compose/ui/Modifier;ILkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Landroidx/compose/runtime/Composer;II)V
+	public static final fun MessageReadStatusIcon (Lio/getstream/chat/android/models/Message;ZLandroidx/compose/ui/Modifier;ZILkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function2;Landroidx/compose/runtime/Composer;II)V
 }
 
 public final class io/getstream/chat/android/compose/ui/components/channels/UnreadCountIndicatorKt {
@@ -2908,6 +2908,7 @@ public abstract interface class io/getstream/chat/android/compose/ui/theme/ChatC
 	public abstract fun MessageFooterContent (Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Landroidx/compose/runtime/Composer;I)V
 	public abstract fun MessageFooterOnlyVisibleToYouContent (Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Landroidx/compose/runtime/Composer;I)V
 	public abstract fun MessageFooterStatusIndicator (Landroidx/compose/ui/Modifier;Lio/getstream/chat/android/models/Message;ZILandroidx/compose/runtime/Composer;I)V
+	public abstract fun MessageFooterStatusIndicator (Lio/getstream/chat/android/compose/ui/theme/MessageFooterStatusIndicatorParams;Landroidx/compose/runtime/Composer;I)V
 	public abstract fun MessageFooterUploadingContent (Landroidx/compose/ui/Modifier;Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Landroidx/compose/runtime/Composer;I)V
 	public abstract fun MessageGiphyContent (Lio/getstream/chat/android/models/Message;Lio/getstream/chat/android/models/User;Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;I)V
 	public abstract fun MessageItemCenterContent (Landroidx/compose/foundation/layout/ColumnScope;Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;II)V
@@ -3089,6 +3090,7 @@ public final class io/getstream/chat/android/compose/ui/theme/ChatComponentFacto
 	public static fun MessageFooterContent (Lio/getstream/chat/android/compose/ui/theme/ChatComponentFactory;Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Landroidx/compose/runtime/Composer;I)V
 	public static fun MessageFooterOnlyVisibleToYouContent (Lio/getstream/chat/android/compose/ui/theme/ChatComponentFactory;Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Landroidx/compose/runtime/Composer;I)V
 	public static fun MessageFooterStatusIndicator (Lio/getstream/chat/android/compose/ui/theme/ChatComponentFactory;Landroidx/compose/ui/Modifier;Lio/getstream/chat/android/models/Message;ZILandroidx/compose/runtime/Composer;I)V
+	public static fun MessageFooterStatusIndicator (Lio/getstream/chat/android/compose/ui/theme/ChatComponentFactory;Lio/getstream/chat/android/compose/ui/theme/MessageFooterStatusIndicatorParams;Landroidx/compose/runtime/Composer;I)V
 	public static fun MessageFooterUploadingContent (Lio/getstream/chat/android/compose/ui/theme/ChatComponentFactory;Landroidx/compose/ui/Modifier;Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Landroidx/compose/runtime/Composer;I)V
 	public static fun MessageGiphyContent (Lio/getstream/chat/android/compose/ui/theme/ChatComponentFactory;Lio/getstream/chat/android/models/Message;Lio/getstream/chat/android/models/User;Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;I)V
 	public static fun MessageItemCenterContent (Lio/getstream/chat/android/compose/ui/theme/ChatComponentFactory;Landroidx/compose/foundation/layout/ColumnScope;Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function3;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Landroidx/compose/runtime/Composer;II)V
@@ -3522,6 +3524,18 @@ public final class io/getstream/chat/android/compose/ui/theme/MessageDateSeparat
 	public final fun defaultTheme (Lio/getstream/chat/android/compose/ui/theme/StreamTypography;Lio/getstream/chat/android/compose/ui/theme/StreamColors;Landroidx/compose/runtime/Composer;II)Lio/getstream/chat/android/compose/ui/theme/MessageDateSeparatorTheme;
 }
 
+public final class io/getstream/chat/android/compose/ui/theme/MessageFooterStatusIndicatorParams {
+	public static final field $stable I
+	public fun <init> (Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;)V
+	public final fun component1 ()Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;
+	public final fun copy (Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;)Lio/getstream/chat/android/compose/ui/theme/MessageFooterStatusIndicatorParams;
+	public static synthetic fun copy$default (Lio/getstream/chat/android/compose/ui/theme/MessageFooterStatusIndicatorParams;Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;ILjava/lang/Object;)Lio/getstream/chat/android/compose/ui/theme/MessageFooterStatusIndicatorParams;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getMessageItem ()Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;
+	public fun hashCode ()I
+	public fun toString ()Ljava/lang/String;
+}
+
 public final class io/getstream/chat/android/compose/ui/theme/MessageOptionsTheme {
 	public static final field $stable I
 	public static final field Companion Lio/getstream/chat/android/compose/ui/theme/MessageOptionsTheme$Companion;

stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/ui/components/channels/MessageReadStatusIcon.kt

@@ -31,6 +31,7 @@ import androidx.compose.ui.semantics.contentDescription
 import androidx.compose.ui.semantics.semantics
 import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
+import io.getstream.chat.android.client.extensions.deliveredReadsOf
 import io.getstream.chat.android.client.extensions.getCreatedAtOrThrow
 import io.getstream.chat.android.compose.R
 import io.getstream.chat.android.compose.ui.theme.ChatTheme
@@ -59,11 +60,13 @@ public fun MessageReadStatusIcon(
     val readStatuses = channel.getReadStatuses(userToIgnore = currentUser)
     val readCount = readStatuses.count { it.time >= message.getCreatedAtOrThrow().time }
     val isMessageRead = readCount != 0
+    val isMessageDelivered = channel.deliveredReadsOf(message).isNotEmpty()
 
     MessageReadStatusIcon(
         modifier = modifier,
         message = message,
         isMessageRead = isMessageRead,
+        isMessageDelivered = isMessageDelivered,
         readCount = readCount,
     )
 }
@@ -73,26 +76,36 @@ public fun MessageReadStatusIcon(
  *
  * @param message The message with sync status to check.
  * @param isMessageRead If the message is read by any member.
+ * @param isMessageDelivered If the message is delivered to any member.
  * @param modifier Modifier for styling.
  */
 @Composable
 public fun MessageReadStatusIcon(
     message: Message,
     isMessageRead: Boolean,
     modifier: Modifier = Modifier,
+    isMessageDelivered: Boolean = false,
     readCount: Int = 0,
     isReadIcon: @Composable () -> Unit = { IsReadCount(modifier = modifier, readCount = readCount) },
     isPendingIcon: @Composable () -> Unit = { IsPendingIcon(modifier = modifier) },
     isSentIcon: @Composable () -> Unit = { IsSentIcon(modifier = modifier) },
+    isDeliveredIcon: @Composable () -> Unit = { IsDeliveredIcon(modifier = modifier) },
 ) {
     val syncStatus = message.syncStatus
-    when {
-        isMessageRead -> isReadIcon()
 
-        syncStatus == SyncStatus.SYNC_NEEDED ||
-            syncStatus == SyncStatus.AWAITING_ATTACHMENTS -> isPendingIcon()
+    when (syncStatus) {
+        SyncStatus.IN_PROGRESS,
+        SyncStatus.SYNC_NEEDED,
+        SyncStatus.AWAITING_ATTACHMENTS,
+        -> isPendingIcon()
 
-        syncStatus == SyncStatus.COMPLETED -> isSentIcon()
+        SyncStatus.COMPLETED -> when {
+            isMessageRead -> isReadIcon()
+            isMessageDelivered -> isDeliveredIcon()
+            else -> isSentIcon()
+        }
+
+        SyncStatus.FAILED_PERMANENTLY -> Unit
     }
 }
 
@@ -110,7 +123,7 @@ private fun IsReadCount(
     Row(
         modifier = modifier
             .semantics { contentDescription = description }
-            .padding(horizontal = 2.dp),
+            .padding(start = 2.dp),
         verticalAlignment = Alignment.CenterVertically,
         horizontalArrangement = Arrangement.spacedBy(2.dp),
     ) {
@@ -151,6 +164,18 @@ private fun IsSentIcon(modifier: Modifier) {
     )
 }
 
+@Composable
+private fun IsDeliveredIcon(modifier: Modifier) {
+    Icon(
+        modifier = Modifier.testTag("Stream_MessageReadStatus_isDelivered"),
+        painter = painterResource(id = R.drawable.stream_compose_message_seen),
+        contentDescription = stringResource(
+            R.string.stream_ui_message_list_semantics_message_status_delivered,
+        ),
+        tint = ChatTheme.colors.disabled,
+    )
+}
+
 /**
  * Preview of [MessageReadStatusIcon] for a seen message.
  *

stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/ui/components/messages/MessageFooter.kt

@@ -39,6 +39,7 @@ import io.getstream.chat.android.compose.R
 import io.getstream.chat.android.compose.state.DateFormatType
 import io.getstream.chat.android.compose.ui.components.Timestamp
 import io.getstream.chat.android.compose.ui.theme.ChatTheme
+import io.getstream.chat.android.compose.ui.theme.MessageFooterStatusIndicatorParams
 import io.getstream.chat.android.compose.ui.util.clickable
 import io.getstream.chat.android.core.utils.date.truncateFuture
 import io.getstream.chat.android.models.Message
@@ -103,10 +104,9 @@ public fun MessageFooter(
                     )
                 } else {
                     ChatTheme.componentFactory.MessageFooterStatusIndicator(
-                        modifier = Modifier.padding(end = 4.dp),
-                        message = message,
-                        isMessageRead = messageItem.isMessageRead,
-                        readCount = messageItem.messageReadBy.size,
+                        params = MessageFooterStatusIndicatorParams(
+                            messageItem = messageItem,
+                        ),
                     )
                 }
 

stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/ui/theme/ChatComponentFactory.kt

@@ -1373,6 +1373,18 @@ public interface ChatComponentFactory {
     /**
      * The default read status indicator in the message footer, weather the message is sent, pending or read.
      */
+    @Deprecated(
+        message = "Use the new version of MessageFooterStatusIndicator that takes MessageFooterStatusIndicatorParams.",
+        replaceWith = ReplaceWith(
+            "MessageFooterStatusIndicator(\n" +
+                "    params = MessageFooterStatusIndicatorParams(\n" +
+                "        modifier = modifier,\n" +
+                "        messageItem = messageItem,\n" +
+                "    ),\n" +
+                ")",
+        ),
+        level = DeprecationLevel.WARNING,
+    )
     @Composable
     public fun MessageFooterStatusIndicator(
         modifier: Modifier,
@@ -1388,6 +1400,28 @@ public interface ChatComponentFactory {
         )
     }
 
+    @Composable
+    public fun MessageFooterStatusIndicator(
+        params: MessageFooterStatusIndicatorParams,
+    ) {
+        if (params.messageItem.isMessageDelivered) {
+            MessageReadStatusIcon(
+                modifier = Modifier.padding(end = 4.dp),
+                message = params.messageItem.message,
+                isMessageRead = params.messageItem.isMessageRead,
+                isMessageDelivered = params.messageItem.isMessageDelivered,
+                readCount = params.messageItem.messageReadBy.size,
+            )
+        } else {
+            MessageFooterStatusIndicator(
+                modifier = Modifier.padding(end = 4.dp),
+                message = params.messageItem.message,
+                isMessageRead = params.messageItem.isMessageRead,
+                readCount = params.messageItem.messageReadBy.size,
+            )
+        }
+    }
+
     /**
      * The default message composer that contains
      * the message input, attachments, commands, recording actions, integrations, and the send button.

stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/ui/theme/ChatComponentFactoryParams.kt

@@ -20,6 +20,7 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import io.getstream.chat.android.compose.state.reactionoptions.ReactionOptionItemState
 import io.getstream.chat.android.models.Message
+import io.getstream.chat.android.ui.common.state.messages.list.MessageItemState
 
 /**
  * Parameters for the [ChatComponentFactory.MessageReactionList] component.
@@ -59,3 +60,12 @@ public data class ChannelMediaAttachmentsPreviewBottomBarParams(
     val leadingContent: @Composable () -> Unit = {},
     val trailingContent: @Composable () -> Unit = {},
 )
+
+/**
+ * Parameters for the [ChatComponentFactory.MessageFooterStatusIndicator] component.
+ *
+ * @param messageItem The message item state.
+ */
+public data class MessageFooterStatusIndicatorParams(
+    val messageItem: MessageItemState,
+)

stream-chat-android-ui-common/api/stream-chat-android-ui-common.api

@@ -2433,23 +2433,24 @@ public final class io/getstream/chat/android/ui/common/state/messages/list/Messa
 
 public final class io/getstream/chat/android/ui/common/state/messages/list/MessageItemState : io/getstream/chat/android/ui/common/state/messages/list/HasMessageListItemState {
 	public static final field $stable I
-	public fun <init> (Lio/getstream/chat/android/models/Message;Ljava/lang/String;ZZZLio/getstream/chat/android/models/User;Ljava/util/List;ZLio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;Ljava/util/List;ZLjava/util/Set;)V
-	public synthetic fun <init> (Lio/getstream/chat/android/models/Message;Ljava/lang/String;ZZZLio/getstream/chat/android/models/User;Ljava/util/List;ZLio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;Ljava/util/List;ZLjava/util/Set;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun <init> (Lio/getstream/chat/android/models/Message;Ljava/lang/String;ZZZLio/getstream/chat/android/models/User;Ljava/util/List;ZZLio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;Ljava/util/List;ZLjava/util/Set;)V
+	public synthetic fun <init> (Lio/getstream/chat/android/models/Message;Ljava/lang/String;ZZZLio/getstream/chat/android/models/User;Ljava/util/List;ZZLio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;Ljava/util/List;ZLjava/util/Set;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun component1 ()Lio/getstream/chat/android/models/Message;
-	public final fun component10 ()Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;
-	public final fun component11 ()Ljava/util/List;
-	public final fun component12 ()Z
-	public final fun component13 ()Ljava/util/Set;
+	public final fun component10 ()Lio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;
+	public final fun component11 ()Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;
+	public final fun component12 ()Ljava/util/List;
+	public final fun component13 ()Z
+	public final fun component14 ()Ljava/util/Set;
 	public final fun component2 ()Ljava/lang/String;
 	public final fun component3 ()Z
 	public final fun component4 ()Z
 	public final fun component5 ()Z
 	public final fun component6 ()Lio/getstream/chat/android/models/User;
 	public final fun component7 ()Ljava/util/List;
 	public final fun component8 ()Z
-	public final fun component9 ()Lio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;
-	public final fun copy (Lio/getstream/chat/android/models/Message;Ljava/lang/String;ZZZLio/getstream/chat/android/models/User;Ljava/util/List;ZLio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;Ljava/util/List;ZLjava/util/Set;)Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;
-	public static synthetic fun copy$default (Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Lio/getstream/chat/android/models/Message;Ljava/lang/String;ZZZLio/getstream/chat/android/models/User;Ljava/util/List;ZLio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;Ljava/util/List;ZLjava/util/Set;ILjava/lang/Object;)Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;
+	public final fun component9 ()Z
+	public final fun copy (Lio/getstream/chat/android/models/Message;Ljava/lang/String;ZZZLio/getstream/chat/android/models/User;Ljava/util/List;ZZLio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;Ljava/util/List;ZLjava/util/Set;)Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;
+	public static synthetic fun copy$default (Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;Lio/getstream/chat/android/models/Message;Ljava/lang/String;ZZZLio/getstream/chat/android/models/User;Ljava/util/List;ZZLio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;Lio/getstream/chat/android/ui/common/state/messages/list/MessageFocusState;Ljava/util/List;ZLjava/util/Set;ILjava/lang/Object;)Lio/getstream/chat/android/ui/common/state/messages/list/MessageItemState;
 	public fun equals (Ljava/lang/Object;)Z
 	public final fun getCurrentUser ()Lio/getstream/chat/android/models/User;
 	public final fun getDeletedMessageVisibility ()Lio/getstream/chat/android/ui/common/state/messages/list/DeletedMessageVisibility;
@@ -2463,6 +2464,7 @@ public final class io/getstream/chat/android/ui/common/state/messages/list/Messa
 	public final fun getShowOriginalText ()Z
 	public fun hashCode ()I
 	public final fun isInThread ()Z
+	public final fun isMessageDelivered ()Z
 	public final fun isMessageRead ()Z
 	public final fun isMine ()Z
 	public fun toString ()Ljava/lang/String;