Merge pull request #1685 from GetStream/feat/system-message

packages/stream_chat/CHANGELOG.md

@@ -1,3 +1,15 @@
+## Upcoming
+
+✅ Added
+
+- Added support for setting `Message.type`. [#1682](https://github.com/GetStream/stream-chat-flutter/issues/1682)
+  ```
+  It is now possible to send system messages. System messages differ from normal messages in the way they are
+  presented to the user. Like the name says, system messages are normally send from the system itself, but a user is
+  able to send it as well by specifying type: 'system' with the message. The user who sends a system message client-side
+  should have the Create System Message permission. Server-side system messages don't need that permission.
+  ```
+
 ## 6.6.0
 
 🔄 Changed

packages/stream_chat/lib/src/core/models/message.dart

@@ -168,7 +168,6 @@ class Message extends Equatable {
   late final MessageState state;
 
   /// The message type.
-  @JsonKey(includeToJson: false)
   final String type;
 
   /// The list of attachments, either provided by the user or generated from a

packages/stream_chat/lib/src/core/models/message.g.dart

@@ -74,6 +74,7 @@ Message _$MessageFromJson(Map<String, dynamic> json) => Message(
 Map<String, dynamic> _$MessageToJson(Message instance) => <String, dynamic>{
       'id': instance.id,
       'text': instance.text,
+      'type': instance.type,
       'attachments': instance.attachments.map((e) => e.toJson()).toList(),
       'mentioned_users': User.toIds(instance.mentionedUsers),
       'parent_id': instance.parentId,

packages/stream_chat/test/fixtures/channel_state_to_json.json

@@ -14,6 +14,7 @@
   "messages": [
     {
       "id": "dry-meadow-0-2b73cc8b-cd86-4a01-8d40-bd82ad07a030",
+      "type": "regular",
       "text": "fasdfa",
       "attachments": [],
       "parent_id": null,
@@ -27,6 +28,7 @@
     },
     {
       "id": "dry-meadow-0-e8e74482-b4cd-48db-9d1e-30e6c191786f",
+      "type": "regular",
       "text": "test message",
       "attachments": [],
       "parent_id": null,
@@ -40,6 +42,7 @@
     },
     {
       "id": "dry-meadow-0-53e6299f-9b97-4a9c-a27e-7e2dde49b7e0",
+      "type": "regular",
       "text": "test message",
       "attachments": [],
       "parent_id": null,
@@ -53,6 +56,7 @@
     },
     {
       "id": "dry-meadow-0-80925be0-786e-40a5-b225-486518dafd35",
+      "type": "regular",
       "text": "asdfadf",
       "attachments": [],
       "parent_id": null,
@@ -66,6 +70,7 @@
     },
     {
       "id": "dry-meadow-0-64d7970f-ede8-4b31-9738-1bc1756d2bfe",
+      "type": "regular",
       "text": "test",
       "attachments": [],
       "parent_id": null,
@@ -79,6 +84,7 @@
     },
     {
       "id": "withered-cell-0-84cbd760-cf55-4f7e-9207-c5f66cccc6dc",
+      "type": "regular",
       "text": "hi",
       "attachments": [],
       "parent_id": null,
@@ -92,6 +98,7 @@
     },
     {
       "id": "dry-meadow-0-e9203588-43c3-40b1-91f7-f217fc42aa53",
+      "type": "regular",
       "text": "fantastic",
       "attachments": [],
       "parent_id": null,
@@ -105,6 +112,7 @@
     },
     {
       "id": "withered-cell-0-7e3552d7-7a0d-45f2-a856-e91b23a7e240",
+      "type": "regular",
       "text": "nice to meet you",
       "attachments": [],
       "parent_id": null,
@@ -118,6 +126,7 @@
     },
     {
       "id": "dry-meadow-0-1ffeafd4-e4fc-4c84-9394-9d7cb10fff42",
+      "type": "regular",
       "text": "hey",
       "attachments": [],
       "parent_id": null,
@@ -131,6 +140,7 @@
     },
     {
       "id": "dry-meadow-0-3f147324-12c8-4b41-9fb5-2db88d065efa",
+      "type": "regular",
       "text": "hello, everyone",
       "attachments": [],
       "parent_id": null,
@@ -144,6 +154,7 @@
     },
     {
       "id": "dry-meadow-0-51a348ae-0c0a-44de-a556-eac7891c0cf0",
+      "type": "regular",
       "text": "who is there?",
       "attachments": [],
       "parent_id": null,
@@ -157,6 +168,7 @@
     },
     {
       "id": "icy-recipe-7-a29e237b-8d81-4a97-9bc8-d42bca3f1356",
+      "type": "regular",
       "text": "하이",
       "attachments": [],
       "parent_id": null,
@@ -170,6 +182,7 @@
     },
     {
       "id": "icy-recipe-7-935c396e-ddf8-4a9a-951c-0a12fa5bf055",
+      "type": "regular",
       "text": "what are you doing?",
       "attachments": [],
       "parent_id": null,
@@ -183,6 +196,7 @@
     },
     {
       "id": "throbbing-boat-5-1e4d5730-5ff0-4d25-9948-9f34ffda43e4",
+      "type": "regular",
       "text": "👍",
       "attachments": [],
       "parent_id": null,
@@ -196,6 +210,7 @@
     },
     {
       "id": "snowy-credit-3-3e0c1a0d-d22f-42ee-b2a1-f9f49477bf21",
+      "type": "regular",
       "text": "sdasas",
       "attachments": [],
       "parent_id": null,
@@ -209,6 +224,7 @@
     },
     {
       "id": "snowy-credit-3-3319537e-2d0e-4876-8170-a54f046e4b7d",
+      "type": "regular",
       "text": "cjshsa",
       "attachments": [],
       "parent_id": null,
@@ -222,6 +238,7 @@
     },
     {
       "id": "snowy-credit-3-cfaf0b46-1daa-49c5-947c-b16d6697487d",
+      "type": "regular",
       "text": "nhisagdhsadz",
       "attachments": [],
       "parent_id": null,
@@ -235,6 +252,7 @@
     },
     {
       "id": "snowy-credit-3-cebe25a7-a3a3-49fc-9919-91c6725e81f3",
+      "type": "regular",
       "text": "hvadhsahzd",
       "attachments": [],
       "parent_id": null,
@@ -248,6 +266,7 @@
     },
     {
       "id": "divine-glade-9-0cea9262-5766-48e9-8b22-311870aed3bf",
+      "type": "regular",
       "text": "hello",
       "attachments": [],
       "parent_id": null,
@@ -261,6 +280,7 @@
     },
     {
       "id": "red-firefly-9-c4e9007b-bb7d-4238-ae08-5f8e3cd03d73",
+      "type": "regular",
       "text": "hello",
       "attachments": [],
       "parent_id": null,
@@ -274,6 +294,7 @@
     },
     {
       "id": "bitter-glade-2-02aee4eb-4093-4736-808b-2de75820e854",
+      "type": "regular",
       "text": "hello",
       "attachments": [],
       "parent_id": null,
@@ -287,6 +308,7 @@
     },
     {
       "id": "morning-sea-1-0c700bcb-46dd-4224-b590-e77bdbccc480",
+      "type": "regular",
       "text": "http://jaeger.ui.gtstrm.com/",
       "attachments": [],
       "parent_id": null,
@@ -300,6 +322,7 @@
     },
     {
       "id": "ancient-salad-0-53e8b4e6-5b7b-43ad-aeee-8bfb6a9ed0be",
+      "type": "regular",
       "text": "hi",
       "attachments": [],
       "parent_id": null,
@@ -313,6 +336,7 @@
     },
     {
       "id": "ancient-salad-0-8c225075-bd4c-42e2-8024-530aae13cd40",
+      "type": "regular",
       "text": "hi",
       "attachments": [],
       "parent_id": null,
@@ -326,6 +350,7 @@
     },
     {
       "id": "proud-sea-7-17802096-cbf8-4e3c-addd-4ee31f4c8b5c",
+      "type": "regular",
       "text": "😃",
       "attachments": [],
       "parent_id": null,

packages/stream_chat/test/fixtures/message_to_json.json

@@ -1,5 +1,6 @@
 {
   "id": "4637f7e4-a06b-42db-ba5a-8d8270dd926f",
+  "type": "regular",
   "text": "https://giphy.com/gifs/the-lion-king-live-action-5zvN79uTGfLMOVfQaA",
   "silent": false,
   "attachments": [