Update Send Message (#437)

* Update send message from acs client to return message data

* Update test

* Update send message interface to return chat message

* Update CHANGELOG.md

* Update README.md

Author: xTEddie

CHANGELOG.md

@@ -7,6 +7,7 @@ All notable changes to this project will be documented in this file.
 ### Added
 - Added exception details for telemetry for SendMessage
 - Expose `OriginalMessageId` to `ChatSDK.onNewMessage()` to handle message ordering
+- Update `ChatSDK.sendMessage()` to return `OmnichannelMessage`
 
 ### Changed
 - Uptake [@microsoft/ocsdk@0.5.13](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.5.13)

README.md

@@ -372,7 +372,6 @@ import {DeliveryMode, MessageContentType, MessageType, PersonType} from '@micros
 
 ...
 
-const displayName = "Contoso"
 const message = "Sample message from customer";
 const messageToSend = {
     content: message

__tests__/core/messaging/ACSClient.spec.ts

@@ -341,6 +341,7 @@ describe('ACSClient', () => {
         await client.initialize(config);
 
         const chatThreadClient: any = {};
+        const sendMessageResponse = {id: '0'};
         chatThreadClient.listParticipants = jest.fn(() => ({
             next: jest.fn(() => ({
                 value: 'value',
@@ -353,7 +354,7 @@ describe('ACSClient', () => {
                 done: jest.fn()
             })),
         }));
-        chatThreadClient.sendMessage = jest.fn();
+        chatThreadClient.sendMessage = jest.fn(() => sendMessageResponse);
 
         client.chatClient = {};
         client.chatClient.getChatThreadClient = jest.fn(() => chatThreadClient);
@@ -365,11 +366,20 @@ describe('ACSClient', () => {
             pollingInterval: 1000,
         });
 
-        await conversation.sendMessage({
-            content: 'message',
+        const content = 'message';
+        const chatMessage = await conversation.sendMessage({
+            content
         });
 
         expect(chatThreadClient.sendMessage).toHaveBeenCalledTimes(1);
+        expect(chatMessage).toBeDefined();
+        expect(chatMessage.id).toBe(sendMessageResponse.id);
+        expect(chatMessage.content).toBe(content);
+        expect(chatMessage.tags.includes('FromCustomer')).toBe(true);
+        expect(chatMessage.tags.includes('ChannelId-lcw')).toBe(true);
+        expect(chatMessage.properties.tags.includes('FromCustomer')).toBe(true);
+        expect(chatMessage.properties.tags.includes('ChannelId-lcw')).toBe(true);
+        expect(chatMessage.timestamp).toBeDefined();
     });
 
     it('ACSClient.sendMessage() failure should throw an error', async () => {

src/OmnichannelChatSDK.ts

@@ -1260,7 +1260,7 @@ class OmnichannelChatSDK {
         return message;
     }
 
-    public async sendMessage(message: ChatSDKMessage): Promise<void> {
+    public async sendMessage(message: ChatSDKMessage): Promise<OmnichannelMessage | void> {
         this.scenarioMarker.startScenario(TelemetryEvent.SendMessages, {
             RequestId: this.requestId,
             ChatId: this.chatToken.chatId as string
@@ -1288,12 +1288,14 @@ class OmnichannelChatSDK {
             }
 
             try {
-                await (this.conversation as ACSConversation)?.sendMessage(sendMessageRequest);
+                const chatMessage = await (this.conversation as ACSConversation)?.sendMessage(sendMessageRequest);
 
                 this.scenarioMarker.completeScenario(TelemetryEvent.SendMessages, {
                     RequestId: this.requestId,
                     ChatId: this.chatToken.chatId as string
                 });
+
+                return chatMessage;
             } catch (error) {
                 const exceptionDetails: ChatSDKExceptionDetails = {
                     response: ChatSDKErrorName.ChatSDKSendMessageFailed,

src/core/messaging/ACSClient.ts

@@ -312,7 +312,7 @@ export class ACSConversation {
         }
     }
 
-    public async sendMessage(message: ChatSDKMessage): Promise<void> {
+    public async sendMessage(message: ChatSDKMessage): Promise<OmnichannelMessage> {
         this.logger?.startScenario(ACSClientEvent.SendMessage);
 
         if (!message.metadata) {
@@ -333,8 +333,26 @@ export class ACSConversation {
         }
 
         try {
-            await this.chatThreadClient?.sendMessage(sendMessageRequest, sendMessageOptions);
+            const response = await this.chatThreadClient?.sendMessage(sendMessageRequest, sendMessageOptions);
             this.logger?.completeScenario(ACSClientEvent.SendMessage);
+
+            if (response?.id) {
+                console.log(response?.id);
+                const chatMessage = {
+                    id: response?.id,
+                    content: message.content,
+                    sender: { communicationUserId: this.sessionInfo?.id as string },
+                    displayName: sendMessageOptions.senderDisplayName,
+                    metadata: {
+                        tags: defaultMessageTags.join(',')
+                    },
+                    createdOn: new Date(parseInt(response?.id)) || response?.id
+                };
+
+                return createOmnichannelMessage(chatMessage as any, { // eslint-disable-line @typescript-eslint/no-explicit-any
+                    liveChatVersion: LiveChatVersion.V2
+                });
+            }
         } catch (error) {
             const exceptionDetails = {
                 response: 'SendMessageFailed',
@@ -347,6 +365,8 @@ export class ACSConversation {
 
             throw error;
         }
+
+        return {} as OmnichannelMessage;
     }
 
     public async sendTyping(): Promise<void> {