@microsoft/omnichannel-chat-widget 1.2.2 → 1.2.3-main.2ce131d

package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.spec.js

@@ -0,0 +1,338 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Constants } from "../../../../../common/Constants";
+import { WebChatActionType } from "../../enums/WebChatActionType";
+import createMessageSequenceIdOverrideMiddleware from "./messageSequenceIdOverrideMiddleware";
+describe("messageSequenceIdOverrideMiddleware", () => {
+  it("sequenceId is overrided", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {
+              "OriginalMessageId": "1683742135918"
+            },
+            "webchat:sequence-id": 12345
+          }
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    let resultValue;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
+    const channelData = middleware.payload.activity.channelData;
+    Object.keys(channelData).forEach(function (key) {
+      if (key === Constants.WebchatSequenceIdAttribute) {
+        resultValue = channelData[key];
+      }
+    });
+    expect(resultValue).toEqual(1683742135918);
+  });
+  it("sequenceId is not overrided due to empty string for originalID", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {
+              "OriginalMessageId": ""
+            },
+            "webchat:sequence-id": 12345
+          }
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    let resultValue;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
+    const channelData = middleware.payload.activity.channelData;
+    Object.keys(channelData).forEach(function (key) {
+      if (key === Constants.WebchatSequenceIdAttribute) {
+        resultValue = channelData[key];
+      }
+    });
+    expect(resultValue).toEqual(12345);
+  });
+  it("sequenceId is not overrided, due to OriginalMessageId being not a string of numbers ", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {
+              "OriginalMessageId": "abcdf"
+            },
+            "webchat:sequence-id": 12345
+          }
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    let resultValue;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
+    const channelData = middleware.payload.activity.channelData;
+    Object.keys(channelData).forEach(function (key) {
+      if (key === Constants.WebchatSequenceIdAttribute) {
+        resultValue = channelData[key];
+      }
+    });
+    expect(resultValue).toEqual(12345);
+  });
+  it("no changes since webchat id is not present", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const payloadExpected = {
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {
+              "OriginalMessageId": "123456789"
+            }
+          }
+        }
+      }
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {
+              "OriginalMessageId": "123456789"
+            }
+          }
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    expect(middleware.payload).toEqual(payloadExpected.payload);
+  });
+  it("no changes since OriginalMessageId is not present", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const payloadExpected = {
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {},
+            "webchat:sequence-id": 12345
+          }
+        }
+      }
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {},
+            "webchat:sequence-id": 12345
+          }
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    expect(middleware.payload).toEqual(payloadExpected.payload);
+  });
+  it("no override, since the type of message is not incoming activity", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const action = {
+      type: "something else",
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {
+              "OriginalMessageId": "1683742135918"
+            },
+            "webchat:sequence-id": 12345
+          }
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    let resultValue;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
+    const channelData = middleware.payload.activity.channelData;
+    Object.keys(channelData).forEach(function (key) {
+      if (key === Constants.WebchatSequenceIdAttribute) {
+        resultValue = channelData[key];
+      }
+    });
+    expect(resultValue).toEqual(12345);
+  });
+  it("no override, since the channel is not ACS", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-text",
+        activity: {
+          channelId: "something_else",
+          from: {
+            role: "user"
+          },
+          channelData: {
+            metadata: {
+              "OriginalMessageId": "1683742135918"
+            },
+            "webchat:sequence-id": 12345
+          }
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    let resultValue;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
+    const channelData = middleware.payload.activity.channelData;
+    Object.keys(channelData).forEach(function (key) {
+      if (key === Constants.WebchatSequenceIdAttribute) {
+        resultValue = channelData[key];
+      }
+    });
+    expect(resultValue).toEqual(12345);
+  });
+  it("no override, since the channel channelData is not present", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-text channel data is not present",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          }
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    expect(middleware.payload).toEqual(action.payload);
+  });
+  it("no override, since channelData is empty object", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-text channel data empty",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: {}
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    expect(middleware.payload).toEqual(action.payload);
+  });
+  it("no override, since channelData null", () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const next = args => args;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const dispatch = () => {
+      return 1;
+    };
+    const action = {
+      type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
+      payload: {
+        text: "test-channel Data null",
+        activity: {
+          channelId: "ACS_CHANNEL",
+          from: {
+            role: "user"
+          },
+          channelData: null
+        }
+      }
+    };
+    const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
+    expect(middleware.payload).toEqual(action.payload);
+  });
+});

package/lib/esm/plugins/createChatTranscript.js

@@ -120,7 +120,13 @@ class TranscriptHTMLBuilder {
                 <script>
                     class Translator {
                         static convertTranscriptMessageToActivity(message) {
-                            const {created, isControlMessage, content, tags, from, attachments, amsMetadata, amsReferences} = message;
+                            const {created, OriginalMessageId, id, isControlMessage, content, tags, from, attachments, amsMetadata, amsReferences} = message;
+                            
+                            //it's required to convert the id to a number, otherwise the webchat will not render the messages in the correct order
+                            // if the OrginalMessageId is not present, we can use the id as the sequence id, which is always present.
+                            
+                            const webchatSequenceId = Translator.convertStringValueToInt(OriginalMessageId) || Translator.convertStringValueToInt(id);
+                            
                             const activity = {
                                 from: {
                                     role: 'bot'
@@ -175,7 +181,10 @@ class TranscriptHTMLBuilder {
                                 return {
                                     ...activity,
                                     text,
-                                    timestamp: created
+                                    timestamp: created,
+                                    channelData: { 
+                                        "webchat:sequence-id": webchatSequenceId
+                                    }
                                 }
                             }
 
@@ -188,7 +197,10 @@ class TranscriptHTMLBuilder {
                                         return {
                                             ...activity,
                                             ...partialActivity,
-                                            timestamp: created
+                                            timestamp: created,
+                                            channelData: { 
+                                                "webchat:sequence-id": webchatSequenceId
+                                            }
                                         };
                                     } catch {
 
@@ -199,9 +211,21 @@ class TranscriptHTMLBuilder {
                             return {
                                 ...activity,
                                 text: content,
-                                timestamp: created
+                                timestamp: created,
+                                channelData: { 
+                                    "webchat:sequence-id": webchatSequenceId
+                                }
                             };
                         }
+                        
+                        static convertStringValueToInt(value) {
+                            if (typeof value !== "string" || value === "") {
+                                return undefined;
+                            }
+
+                            const result = parseInt(value);
+                            return isNaN(result) ? undefined : result;
+                        }
                     }
                 <\/script>
                 <script>

package/lib/types/common/Constants.d.ts

@@ -41,6 +41,7 @@ export declare class Constants {
     static readonly acsChannel = "ACS_CHANNEL";
     static readonly publicMessageTag = "public";
     static readonly supportedAdaptiveCardContentTypes: Array<string>;
+    static readonly adaptiveCardContentTypePrefix = "application/vnd.microsoft.card";
     static readonly maxUploadFileSize = "500000";
     static readonly imageRegex: RegExp;
     static readonly audioMediaRegex: RegExp;
@@ -86,6 +87,9 @@ export declare class Constants {
     static readonly LWICheckOnVisibilityTimeout: number;
     static readonly InitContextParamsRequest = "initContextParamsRequest";
     static readonly InitContextParamsResponse = "initContextParamsResponse";
+    static readonly OCOriginalMessageId = "OriginalMessageId";
+    static readonly WebchatSequenceIdAttribute = "webchat:sequence-id";
+    static readonly MessageSequenceIdOverride = "MessageSequenceIdOverride";
 }
 export declare const Regex: {
     new (): {};

package/lib/types/components/livechatwidget/common/reconnectChatHelper.d.ts

@@ -3,7 +3,7 @@ import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
 import { Dispatch } from "react";
 import { ILiveChatWidgetAction } from "../../../contexts/common/ILiveChatWidgetAction";
 import { ILiveChatWidgetContext } from "../../../contexts/common/ILiveChatWidgetContext";
-declare const handleChatReconnect: (chatSDK: any, props: any, dispatch: Dispatch<ILiveChatWidgetAction>, setAdapter: any, initStartChat: any, state: ILiveChatWidgetContext) => Promise<void>;
+declare const handleChatReconnect: (chatSDK: any, props: any, dispatch: Dispatch<ILiveChatWidgetAction>, setAdapter: any, initStartChat: any, state: ILiveChatWidgetContext) => Promise<boolean>;
 declare const getChatReconnectContext: (chatSDK: any, chatConfig: ChatConfig, props: any, isAuthenticatedChat: boolean) => Promise<any>;
 declare const isReconnectEnabled: (chatConfig?: ChatConfig | undefined) => boolean;
 declare const isPersistentEnabled: (chatConfig?: ChatConfig | undefined) => boolean;

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.d.ts

@@ -0,0 +1,5 @@
+import { IWebChatAction } from "../../../interfaces/IWebChatAction";
+declare const createMessageSequenceIdOverrideMiddleware: ({ dispatch }: {
+    dispatch: any;
+}) => (next: any) => (action: IWebChatAction) => any;
+export default createMessageSequenceIdOverrideMiddleware;

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/omnichannel-chat-widget",
-  "version": "1.2.2",
+  "version": "1.2.3-main.2ce131d",
   "description": "Microsoft Omnichannel Chat Widget",
   "main": "lib/cjs/index.js",
   "types": "lib/types/index.d.ts",
@@ -74,7 +74,7 @@
     "webpack-cli": "^4.9.2"
   },
   "dependencies": {
-    "@microsoft/omnichannel-chat-components": "^1.0.5",
+    "@microsoft/omnichannel-chat-components": "^1.0.6",
     "@microsoft/omnichannel-chat-sdk": "1.4.6",
     "abort-controller-es5": "^2.0.1",
     "dompurify": "^2.3.4",