api: Send local_(message)_id as a raw String; add it to MessageEvent

The server documents this to be an optional String
(https://zulip.com/api/send-message#parameter-local_id), match that
that in our bindings.  We will determine how this is encoded, but not
at the bindings level.

This will be used for local echoing.  local_message_id on message
event is not yet fully documented; see CZO discussion:
  https://chat.zulip.org/#narrow/channel/412-api-documentation/topic/local_id.2C.20queue_id.2Fsender_queue_id/near/2135340

Author: PIG208

lib/api/model/events.dart

@@ -682,7 +682,16 @@ class MessageEvent extends Event {
   @JsonKey(readValue: _readMessageValue, includeToJson: false)
   final Message message;
 
-  MessageEvent({required super.id, required this.message});
+  // The format of this is documented to be chosen freely by the client.
+  //
+  // When present, this corresponds to the JSON-encoded int, "local_id",
+  // from a previous [sendMessage] call by us.
+  //
+  // This is not yet fully documented.  See CZO discussion for reference:
+  //   https://chat.zulip.org/#narrow/channel/412-api-documentation/topic/local_id.2C.20queue_id.2Fsender_queue_id/near/2135340
+  final String? localMessageId;
+
+  MessageEvent({required super.id, required this.message, required this.localMessageId});
 
   static Map<String, dynamic> _readMessageValue(Map<dynamic, dynamic> json, String key) =>
     {...json['message'] as Map<String, dynamic>, 'flags': json['flags']};

lib/api/model/events.g.dart

@@ -194,7 +194,7 @@ Future<SendMessageResult> sendMessage(
       }}),
     'content': RawParameter(content),
     if (queueId != null) 'queue_id': RawParameter(queueId),
-    if (localId != null) 'local_id': localId, // TODO should this use RawParameter?
+    if (localId != null) 'local_id': RawParameter(localId),
     if (readBySender != null) 'read_by_sender': readBySender,
   },
   overrideUserAgent: switch ((supportsReadBySender, readBySender)) {

lib/api/route/messages.dart

@@ -39,6 +39,7 @@ extension SubscriptionUpdateEventChecks on Subject<SubscriptionUpdateEvent> {
 
 extension MessageEventChecks on Subject<MessageEvent> {
   Subject<Message> get message => has((e) => e.message, 'message');
+  Subject<String?> get localMessageId => has((e) => e.localMessageId, 'localMessageId');
 }
 
 extension UpdateMessageEventChecks on Subject<UpdateMessageEvent> {

test/api/model/events_checks.dart

@@ -363,7 +363,7 @@ void main() {
             'topic': topic,
             'content': content,
             'queue_id': 'abc:123',
-            'local_id': '"456"',
+            'local_id': '456',
             'read_by_sender': 'true',
           });
       });

test/api/route/messages_test.dart

@@ -621,7 +621,7 @@ UserTopicEvent userTopicEvent(
 }
 
 MessageEvent messageEvent(Message message) =>
-  MessageEvent(id: 0, message: message);
+  MessageEvent(id: 0, message: message, localMessageId: null);
 
 DeleteMessageEvent deleteMessageEvent(List<StreamMessage> messages) {
   assert(messages.isNotEmpty);