@microsoft/omnichannel-chat-widget 1.2.3-main.000f886 → 1.2.3-main.d27a359

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/lib/cjs/common/Constants.js +5 -1
  2. package/lib/cjs/common/telemetry/TelemetryConstants.js +1 -0
  3. package/lib/cjs/components/livechatwidget/common/ActivitySubscriber/BotAuthActivitySubscriber.js +4 -1
  4. package/lib/cjs/components/livechatwidget/common/initWebChatComposer.js +2 -1
  5. package/lib/cjs/components/livechatwidget/common/reconnectChatHelper.js +12 -7
  6. package/lib/cjs/components/livechatwidget/common/startChat.js +6 -5
  7. package/lib/cjs/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +16 -15
  8. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.js +6 -3
  9. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.spec.js +190 -0
  10. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentMiddleware.js +5 -0
  11. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.js +65 -0
  12. package/lib/cjs/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.spec.js +342 -0
  13. package/lib/cjs/plugins/createChatTranscript.js +28 -4
  14. package/lib/esm/common/Constants.js +5 -1
  15. package/lib/esm/common/telemetry/TelemetryConstants.js +1 -0
  16. package/lib/esm/components/livechatwidget/common/ActivitySubscriber/BotAuthActivitySubscriber.js +4 -1
  17. package/lib/esm/components/livechatwidget/common/initWebChatComposer.js +2 -1
  18. package/lib/esm/components/livechatwidget/common/reconnectChatHelper.js +12 -7
  19. package/lib/esm/components/livechatwidget/common/startChat.js +6 -5
  20. package/lib/esm/components/livechatwidget/livechatwidgetstateful/LiveChatWidgetStateful.js +16 -15
  21. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.js +6 -3
  22. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.spec.js +188 -0
  23. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/attachmentMiddleware.js +5 -0
  24. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.js +58 -0
  25. package/lib/esm/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.spec.js +338 -0
  26. package/lib/esm/plugins/createChatTranscript.js +28 -4
  27. package/lib/types/common/Constants.d.ts +4 -0
  28. package/lib/types/common/telemetry/TelemetryConstants.d.ts +1 -0
  29. package/lib/types/components/livechatwidget/common/reconnectChatHelper.d.ts +1 -1
  30. package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activityMiddleware.spec.d.ts +1 -0
  31. package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.d.ts +5 -0
  32. package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/messageSequenceIdOverrideMiddleware.spec.d.ts +1 -0
  33. package/package.json +2 -2
@@ -0,0 +1,188 @@
1
+ import { Constants } from "../../../../../common/Constants";
2
+ import { DirectLineActivityType } from "../../enums/DirectLineActivityType";
3
+ import { DirectLineSenderRole } from "../../enums/DirectLineSenderRole";
4
+ import { MessageTypes } from "../../enums/MessageType";
5
+ import { TelemetryHelper } from "../../../../../common/telemetry/TelemetryHelper";
6
+ import { createActivityMiddleware } from "./activityMiddleware";
7
+ describe("activityMiddleware test", () => {
8
+ it("createActivityMiddleware() with Channel role sender should returns nothing", () => {
9
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
10
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
11
+ const args = {
12
+ activity: {
13
+ channelData: {
14
+ type: MessageTypes.Thread
15
+ },
16
+ from: {
17
+ role: DirectLineSenderRole.Channel
18
+ }
19
+ }
20
+ };
21
+ const results = createActivityMiddleware()()(next)(args);
22
+ expect(results()).toEqual(false);
23
+ expect(TelemetryHelper.logActionEvent).toHaveBeenCalledTimes(1);
24
+ });
25
+ it("createActivityMiddleware() with Hidden tag should return nothing", () => {
26
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
27
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
28
+ const args = {
29
+ activity: {
30
+ channelData: {
31
+ tags: [Constants.hiddenTag]
32
+ },
33
+ from: {
34
+ role: DirectLineSenderRole.User
35
+ }
36
+ }
37
+ };
38
+ const results = createActivityMiddleware()()(next)(args);
39
+ expect(results()).toEqual(false);
40
+ expect(TelemetryHelper.logActionEvent).toHaveBeenCalledTimes(0);
41
+ });
42
+ it("createActivityMiddleware() with System tag should return system message", () => {
43
+ var _results$props, _results$props$danger;
44
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
45
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
46
+ const systemMessage = "system message";
47
+ const args = {
48
+ activity: {
49
+ text: systemMessage,
50
+ channelData: {
51
+ tags: [Constants.systemMessageTag]
52
+ },
53
+ from: {
54
+ role: DirectLineSenderRole.User
55
+ }
56
+ }
57
+ };
58
+ const results = createActivityMiddleware()()(next)(args);
59
+ expect(TelemetryHelper.logActionEvent).toHaveBeenCalledTimes(0);
60
+ expect((_results$props = results().props) === null || _results$props === void 0 ? void 0 : (_results$props$danger = _results$props.dangerouslySetInnerHTML) === null || _results$props$danger === void 0 ? void 0 : _results$props$danger.__html).toEqual(systemMessage);
61
+ });
62
+ it("createActivityMiddleware() should escape html texts to prevent XSS attacks", () => {
63
+ var _results$props2, _results$props2$dange;
64
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
65
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
66
+ const systemMessage = "<img src='' onerror=\"alert('XSS attack')\"/>";
67
+ const args = {
68
+ activity: {
69
+ text: systemMessage,
70
+ channelData: {
71
+ tags: [Constants.systemMessageTag]
72
+ },
73
+ from: {
74
+ role: DirectLineSenderRole.User
75
+ }
76
+ }
77
+ };
78
+ const results = createActivityMiddleware()()(next)(args);
79
+ expect(TelemetryHelper.logActionEvent).toHaveBeenCalledTimes(0);
80
+ expect((_results$props2 = results().props) === null || _results$props2 === void 0 ? void 0 : (_results$props2$dange = _results$props2.dangerouslySetInnerHTML) === null || _results$props2$dange === void 0 ? void 0 : _results$props2$dange.__html).toEqual("&lt;img src=&#39;&#39; onerror=&quot;alert(&#39;XSS attack&#39;)&quot;&#x2F;&gt;");
81
+ });
82
+ it("createActivityMiddleware() with QueuePosition tag should log QueuePosition message", () => {
83
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
84
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
85
+ const systemMessage = "system message";
86
+ const args = {
87
+ activity: {
88
+ text: systemMessage,
89
+ channelData: {
90
+ tags: [Constants.systemMessageTag, Constants.queuePositionMessageTag]
91
+ },
92
+ from: {
93
+ role: DirectLineSenderRole.User
94
+ }
95
+ }
96
+ };
97
+ createActivityMiddleware()()(next)(args);
98
+ expect(TelemetryHelper.logActionEvent).toHaveBeenCalledTimes(1);
99
+ });
100
+ it("createActivityMiddleware() with same clientmessageid with next activity should return nothing", () => {
101
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
102
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
103
+ const systemMessage = "system message";
104
+ const args = {
105
+ activity: {
106
+ text: systemMessage,
107
+ channelData: {
108
+ tags: [Constants.systemMessageTag],
109
+ clientmessageid: "1234"
110
+ },
111
+ from: {
112
+ role: DirectLineSenderRole.User
113
+ }
114
+ },
115
+ nextVisibleActivity: {
116
+ channelData: {
117
+ clientmessageid: "1234"
118
+ }
119
+ }
120
+ };
121
+ const results = createActivityMiddleware()()(next)(args);
122
+ expect(results()).toEqual(false);
123
+ });
124
+ it("createActivityMiddleware() with same messageid with next activity should return nothing", () => {
125
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
126
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
127
+ const systemMessage = "system message";
128
+ const args = {
129
+ activity: {
130
+ text: systemMessage,
131
+ channelData: {
132
+ tags: [Constants.systemMessageTag]
133
+ },
134
+ from: {
135
+ role: DirectLineSenderRole.User
136
+ },
137
+ messageid: "1234"
138
+ },
139
+ nextVisibleActivity: {
140
+ messageid: "1234"
141
+ }
142
+ };
143
+ const results = createActivityMiddleware()()(next)(args);
144
+ expect(results()).toEqual(false);
145
+ });
146
+ it("createActivityMiddleware() should render normal user messages", () => {
147
+ var _results$props3, _results$props3$child, _results$props3$child2;
148
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
149
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
150
+ const userMessage = "Hello World";
151
+ const args = {
152
+ activity: {
153
+ text: userMessage,
154
+ channelId: "webchat",
155
+ channelData: {
156
+ isHtmlEncoded: false
157
+ },
158
+ from: {
159
+ role: DirectLineSenderRole.User
160
+ },
161
+ type: DirectLineActivityType.Message
162
+ }
163
+ };
164
+ const results = createActivityMiddleware()()(next)(args);
165
+ expect((_results$props3 = results().props) === null || _results$props3 === void 0 ? void 0 : (_results$props3$child = _results$props3.children) === null || _results$props3$child === void 0 ? void 0 : (_results$props3$child2 = _results$props3$child.activity) === null || _results$props3$child2 === void 0 ? void 0 : _results$props3$child2.text).toEqual(userMessage);
166
+ });
167
+ it("createActivityMiddleware() should not render typing messages", () => {
168
+ var _results$activity;
169
+ spyOn(TelemetryHelper, "logActionEvent").and.callFake(() => false);
170
+ const next = args => () => args; // eslint-disable-line @typescript-eslint/no-explicit-any
171
+ const userMessage = "Hello World";
172
+ const args = {
173
+ activity: {
174
+ text: userMessage,
175
+ channelId: "webchat",
176
+ channelData: {
177
+ isHtmlEncoded: false
178
+ },
179
+ from: {
180
+ role: DirectLineSenderRole.User
181
+ },
182
+ type: DirectLineActivityType.Typing
183
+ }
184
+ };
185
+ const results = createActivityMiddleware()()(next)(args);
186
+ expect((_results$activity = results().activity) === null || _results$activity === void 0 ? void 0 : _results$activity.text).toEqual(userMessage);
187
+ });
188
+ });
@@ -202,12 +202,17 @@ const createAttachmentMiddleware = enableInlinePlaying => {
202
202
  id: attachmentId,
203
203
  style: atttachmentAdaptiveCardStyles
204
204
  }, next(...args));
205
+ } else if (contentType.startsWith(Constants.adaptiveCardContentTypePrefix)) {
206
+ console.warn(`${contentType} adaptive card type is currently not supported.`);
205
207
  }
206
208
  if ((_card$activity$channe = card.activity.channelData) !== null && _card$activity$channe !== void 0 && _card$activity$channe.middlewareData) {
207
209
  attachment.contentUrl = card.activity.channelData.middlewareData[attachment.name];
208
210
  } else if (attachment !== null && attachment !== void 0 && attachment.tempContentUrl) {
209
211
  attachment.contentUrl = attachment.tempContentUrl;
210
212
  }
213
+ if (!attachment.name) {
214
+ return next(...args);
215
+ }
211
216
  const fileExtension = attachment.name.substring(attachment.name.lastIndexOf(".") + 1, attachment.name.length) || attachment.name;
212
217
  const imageExtension = Constants.imageRegex.test(attachment.name);
213
218
  const audioExtension = Constants.audioMediaRegex.test(attachment.name);
@@ -0,0 +1,58 @@
1
+ import { WebChatActionType } from "../../enums/WebChatActionType";
2
+ import { Constants } from "../../../../../common/Constants";
3
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
4
+ const createMessageSequenceIdOverrideMiddleware = _ref => {
5
+ let {
6
+ dispatch
7
+ } = _ref;
8
+ return next => action => {
9
+ if (isApplicable(action)) {
10
+ return next(overrideSequenceIdWithOriginalMessageId(action));
11
+ }
12
+ return next(action);
13
+ };
14
+ };
15
+ const isApplicable = action => {
16
+ return action.type === WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY && isValidChannel(action) && isWebSequenceIdPresent(action) && lookupOriginalMessageId(action) !== undefined;
17
+ };
18
+ const isValidChannel = action => {
19
+ var _action$payload, _action$payload$activ;
20
+ return (action === null || action === void 0 ? void 0 : (_action$payload = action.payload) === null || _action$payload === void 0 ? void 0 : (_action$payload$activ = _action$payload.activity) === null || _action$payload$activ === void 0 ? void 0 : _action$payload$activ.channelId) === Constants.acsChannel;
21
+ };
22
+ const isChannelDataPresent = action => {
23
+ var _action$payload2, _action$payload2$acti, _action$payload3, _action$payload3$acti;
24
+ return (action === null || action === void 0 ? void 0 : (_action$payload2 = action.payload) === null || _action$payload2 === void 0 ? void 0 : (_action$payload2$acti = _action$payload2.activity) === null || _action$payload2$acti === void 0 ? void 0 : _action$payload2$acti.channelData) !== undefined && (action === null || action === void 0 ? void 0 : (_action$payload3 = action.payload) === null || _action$payload3 === void 0 ? void 0 : (_action$payload3$acti = _action$payload3.activity) === null || _action$payload3$acti === void 0 ? void 0 : _action$payload3$acti.channelData) !== null;
25
+ };
26
+ const isWebSequenceIdPresent = action => {
27
+ if (!isChannelDataPresent(action)) return false;
28
+ const channelData = action.payload.activity.channelData;
29
+ return Object.keys(channelData).some(key => {
30
+ return key === Constants.WebchatSequenceIdAttribute;
31
+ });
32
+ };
33
+ const overrideSequenceIdWithOriginalMessageId = action => {
34
+ const originalMessageId = extractOriginalMessageId(action);
35
+ const channelData = action.payload.activity.channelData;
36
+ if (originalMessageId === undefined) return action;
37
+ Object.keys(channelData).forEach(function (key) {
38
+ if (key === Constants.WebchatSequenceIdAttribute && action.payload.activity.channelData[key] !== originalMessageId) {
39
+ action.payload.activity.channelData[key] = originalMessageId;
40
+ }
41
+ });
42
+ return action;
43
+ };
44
+
45
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
46
+ const extractOriginalMessageId = action => {
47
+ const originalMessageId = lookupOriginalMessageId(action);
48
+ if (typeof originalMessageId !== "string" || originalMessageId === "") {
49
+ return undefined;
50
+ }
51
+ const originalMessageIdResult = parseInt(originalMessageId);
52
+ return isNaN(originalMessageIdResult) ? undefined : originalMessageIdResult;
53
+ };
54
+ const lookupOriginalMessageId = action => {
55
+ var _action$payload4, _action$payload4$acti, _action$payload4$acti2, _action$payload4$acti3;
56
+ return action === null || action === void 0 ? void 0 : (_action$payload4 = action.payload) === null || _action$payload4 === void 0 ? void 0 : (_action$payload4$acti = _action$payload4.activity) === null || _action$payload4$acti === void 0 ? void 0 : (_action$payload4$acti2 = _action$payload4$acti.channelData) === null || _action$payload4$acti2 === void 0 ? void 0 : (_action$payload4$acti3 = _action$payload4$acti2.metadata) === null || _action$payload4$acti3 === void 0 ? void 0 : _action$payload4$acti3.OriginalMessageId;
57
+ };
58
+ export default createMessageSequenceIdOverrideMiddleware;
@@ -0,0 +1,338 @@
1
+ /* eslint-disable @typescript-eslint/no-explicit-any */
2
+ import { Constants } from "../../../../../common/Constants";
3
+ import { WebChatActionType } from "../../enums/WebChatActionType";
4
+ import createMessageSequenceIdOverrideMiddleware from "./messageSequenceIdOverrideMiddleware";
5
+ describe("messageSequenceIdOverrideMiddleware", () => {
6
+ it("sequenceId is overrided", () => {
7
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
8
+ const next = args => args;
9
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
10
+ const dispatch = () => {
11
+ return 1;
12
+ };
13
+ const action = {
14
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
15
+ payload: {
16
+ text: "test-text",
17
+ activity: {
18
+ channelId: "ACS_CHANNEL",
19
+ from: {
20
+ role: "user"
21
+ },
22
+ channelData: {
23
+ metadata: {
24
+ "OriginalMessageId": "1683742135918"
25
+ },
26
+ "webchat:sequence-id": 12345
27
+ }
28
+ }
29
+ }
30
+ };
31
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
32
+ let resultValue;
33
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
34
+ const channelData = middleware.payload.activity.channelData;
35
+ Object.keys(channelData).forEach(function (key) {
36
+ if (key === Constants.WebchatSequenceIdAttribute) {
37
+ resultValue = channelData[key];
38
+ }
39
+ });
40
+ expect(resultValue).toEqual(1683742135918);
41
+ });
42
+ it("sequenceId is not overrided due to empty string for originalID", () => {
43
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
44
+ const next = args => args;
45
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
46
+ const dispatch = () => {
47
+ return 1;
48
+ };
49
+ const action = {
50
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
51
+ payload: {
52
+ text: "test-text",
53
+ activity: {
54
+ channelId: "ACS_CHANNEL",
55
+ from: {
56
+ role: "user"
57
+ },
58
+ channelData: {
59
+ metadata: {
60
+ "OriginalMessageId": ""
61
+ },
62
+ "webchat:sequence-id": 12345
63
+ }
64
+ }
65
+ }
66
+ };
67
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
68
+ let resultValue;
69
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
70
+ const channelData = middleware.payload.activity.channelData;
71
+ Object.keys(channelData).forEach(function (key) {
72
+ if (key === Constants.WebchatSequenceIdAttribute) {
73
+ resultValue = channelData[key];
74
+ }
75
+ });
76
+ expect(resultValue).toEqual(12345);
77
+ });
78
+ it("sequenceId is not overrided, due to OriginalMessageId being not a string of numbers ", () => {
79
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
80
+ const next = args => args;
81
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
82
+ const dispatch = () => {
83
+ return 1;
84
+ };
85
+ const action = {
86
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
87
+ payload: {
88
+ text: "test-text",
89
+ activity: {
90
+ channelId: "ACS_CHANNEL",
91
+ from: {
92
+ role: "user"
93
+ },
94
+ channelData: {
95
+ metadata: {
96
+ "OriginalMessageId": "abcdf"
97
+ },
98
+ "webchat:sequence-id": 12345
99
+ }
100
+ }
101
+ }
102
+ };
103
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
104
+ let resultValue;
105
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
106
+ const channelData = middleware.payload.activity.channelData;
107
+ Object.keys(channelData).forEach(function (key) {
108
+ if (key === Constants.WebchatSequenceIdAttribute) {
109
+ resultValue = channelData[key];
110
+ }
111
+ });
112
+ expect(resultValue).toEqual(12345);
113
+ });
114
+ it("no changes since webchat id is not present", () => {
115
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
116
+ const next = args => args;
117
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
118
+ const dispatch = () => {
119
+ return 1;
120
+ };
121
+ const payloadExpected = {
122
+ payload: {
123
+ text: "test-text",
124
+ activity: {
125
+ channelId: "ACS_CHANNEL",
126
+ from: {
127
+ role: "user"
128
+ },
129
+ channelData: {
130
+ metadata: {
131
+ "OriginalMessageId": "123456789"
132
+ }
133
+ }
134
+ }
135
+ }
136
+ };
137
+ const action = {
138
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
139
+ payload: {
140
+ text: "test-text",
141
+ activity: {
142
+ channelId: "ACS_CHANNEL",
143
+ from: {
144
+ role: "user"
145
+ },
146
+ channelData: {
147
+ metadata: {
148
+ "OriginalMessageId": "123456789"
149
+ }
150
+ }
151
+ }
152
+ }
153
+ };
154
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
155
+ expect(middleware.payload).toEqual(payloadExpected.payload);
156
+ });
157
+ it("no changes since OriginalMessageId is not present", () => {
158
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
159
+ const next = args => args;
160
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
161
+ const dispatch = () => {
162
+ return 1;
163
+ };
164
+ const payloadExpected = {
165
+ payload: {
166
+ text: "test-text",
167
+ activity: {
168
+ channelId: "ACS_CHANNEL",
169
+ from: {
170
+ role: "user"
171
+ },
172
+ channelData: {
173
+ metadata: {},
174
+ "webchat:sequence-id": 12345
175
+ }
176
+ }
177
+ }
178
+ };
179
+ const action = {
180
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
181
+ payload: {
182
+ text: "test-text",
183
+ activity: {
184
+ channelId: "ACS_CHANNEL",
185
+ from: {
186
+ role: "user"
187
+ },
188
+ channelData: {
189
+ metadata: {},
190
+ "webchat:sequence-id": 12345
191
+ }
192
+ }
193
+ }
194
+ };
195
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
196
+ expect(middleware.payload).toEqual(payloadExpected.payload);
197
+ });
198
+ it("no override, since the type of message is not incoming activity", () => {
199
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
200
+ const next = args => args;
201
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
202
+ const dispatch = () => {
203
+ return 1;
204
+ };
205
+ const action = {
206
+ type: "something else",
207
+ payload: {
208
+ text: "test-text",
209
+ activity: {
210
+ channelId: "ACS_CHANNEL",
211
+ from: {
212
+ role: "user"
213
+ },
214
+ channelData: {
215
+ metadata: {
216
+ "OriginalMessageId": "1683742135918"
217
+ },
218
+ "webchat:sequence-id": 12345
219
+ }
220
+ }
221
+ }
222
+ };
223
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
224
+ let resultValue;
225
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
226
+ const channelData = middleware.payload.activity.channelData;
227
+ Object.keys(channelData).forEach(function (key) {
228
+ if (key === Constants.WebchatSequenceIdAttribute) {
229
+ resultValue = channelData[key];
230
+ }
231
+ });
232
+ expect(resultValue).toEqual(12345);
233
+ });
234
+ it("no override, since the channel is not ACS", () => {
235
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
236
+ const next = args => args;
237
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
238
+ const dispatch = () => {
239
+ return 1;
240
+ };
241
+ const action = {
242
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
243
+ payload: {
244
+ text: "test-text",
245
+ activity: {
246
+ channelId: "something_else",
247
+ from: {
248
+ role: "user"
249
+ },
250
+ channelData: {
251
+ metadata: {
252
+ "OriginalMessageId": "1683742135918"
253
+ },
254
+ "webchat:sequence-id": 12345
255
+ }
256
+ }
257
+ }
258
+ };
259
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
260
+ let resultValue;
261
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
262
+ const channelData = middleware.payload.activity.channelData;
263
+ Object.keys(channelData).forEach(function (key) {
264
+ if (key === Constants.WebchatSequenceIdAttribute) {
265
+ resultValue = channelData[key];
266
+ }
267
+ });
268
+ expect(resultValue).toEqual(12345);
269
+ });
270
+ it("no override, since the channel channelData is not present", () => {
271
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
272
+ const next = args => args;
273
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
274
+ const dispatch = () => {
275
+ return 1;
276
+ };
277
+ const action = {
278
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
279
+ payload: {
280
+ text: "test-text channel data is not present",
281
+ activity: {
282
+ channelId: "ACS_CHANNEL",
283
+ from: {
284
+ role: "user"
285
+ }
286
+ }
287
+ }
288
+ };
289
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
290
+ expect(middleware.payload).toEqual(action.payload);
291
+ });
292
+ it("no override, since channelData is empty object", () => {
293
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
294
+ const next = args => args;
295
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
296
+ const dispatch = () => {
297
+ return 1;
298
+ };
299
+ const action = {
300
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
301
+ payload: {
302
+ text: "test-text channel data empty",
303
+ activity: {
304
+ channelId: "ACS_CHANNEL",
305
+ from: {
306
+ role: "user"
307
+ },
308
+ channelData: {}
309
+ }
310
+ }
311
+ };
312
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
313
+ expect(middleware.payload).toEqual(action.payload);
314
+ });
315
+ it("no override, since channelData null", () => {
316
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
317
+ const next = args => args;
318
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
319
+ const dispatch = () => {
320
+ return 1;
321
+ };
322
+ const action = {
323
+ type: WebChatActionType.DIRECT_LINE_INCOMING_ACTIVITY,
324
+ payload: {
325
+ text: "test-channel Data null",
326
+ activity: {
327
+ channelId: "ACS_CHANNEL",
328
+ from: {
329
+ role: "user"
330
+ },
331
+ channelData: null
332
+ }
333
+ }
334
+ };
335
+ const middleware = createMessageSequenceIdOverrideMiddleware(dispatch)(next)(action);
336
+ expect(middleware.payload).toEqual(action.payload);
337
+ });
338
+ });
@@ -120,7 +120,13 @@ class TranscriptHTMLBuilder {
120
120
  <script>
121
121
  class Translator {
122
122
  static convertTranscriptMessageToActivity(message) {
123
- const {created, isControlMessage, content, tags, from, attachments, amsMetadata, amsReferences} = message;
123
+ const {created, OriginalMessageId, id, isControlMessage, content, tags, from, attachments, amsMetadata, amsReferences} = message;
124
+
125
+ //it's required to convert the id to a number, otherwise the webchat will not render the messages in the correct order
126
+ // if the OrginalMessageId is not present, we can use the id as the sequence id, which is always present.
127
+
128
+ const webchatSequenceId = Translator.convertStringValueToInt(OriginalMessageId) || Translator.convertStringValueToInt(id);
129
+
124
130
  const activity = {
125
131
  from: {
126
132
  role: 'bot'
@@ -175,7 +181,10 @@ class TranscriptHTMLBuilder {
175
181
  return {
176
182
  ...activity,
177
183
  text,
178
- timestamp: created
184
+ timestamp: created,
185
+ channelData: {
186
+ "webchat:sequence-id": webchatSequenceId
187
+ }
179
188
  }
180
189
  }
181
190
 
@@ -188,7 +197,10 @@ class TranscriptHTMLBuilder {
188
197
  return {
189
198
  ...activity,
190
199
  ...partialActivity,
191
- timestamp: created
200
+ timestamp: created,
201
+ channelData: {
202
+ "webchat:sequence-id": webchatSequenceId
203
+ }
192
204
  };
193
205
  } catch {
194
206
 
@@ -199,9 +211,21 @@ class TranscriptHTMLBuilder {
199
211
  return {
200
212
  ...activity,
201
213
  text: content,
202
- timestamp: created
214
+ timestamp: created,
215
+ channelData: {
216
+ "webchat:sequence-id": webchatSequenceId
217
+ }
203
218
  };
204
219
  }
220
+
221
+ static convertStringValueToInt(value) {
222
+ if (typeof value !== "string" || value === "") {
223
+ return undefined;
224
+ }
225
+
226
+ const result = parseInt(value);
227
+ return isNaN(result) ? undefined : result;
228
+ }
205
229
  }
206
230
  <\/script>
207
231
  <script>
@@ -41,6 +41,7 @@ export declare class Constants {
41
41
  static readonly acsChannel = "ACS_CHANNEL";
42
42
  static readonly publicMessageTag = "public";
43
43
  static readonly supportedAdaptiveCardContentTypes: Array<string>;
44
+ static readonly adaptiveCardContentTypePrefix = "application/vnd.microsoft.card";
44
45
  static readonly maxUploadFileSize = "500000";
45
46
  static readonly imageRegex: RegExp;
46
47
  static readonly audioMediaRegex: RegExp;
@@ -86,6 +87,9 @@ export declare class Constants {
86
87
  static readonly LWICheckOnVisibilityTimeout: number;
87
88
  static readonly InitContextParamsRequest = "initContextParamsRequest";
88
89
  static readonly InitContextParamsResponse = "initContextParamsResponse";
90
+ static readonly OCOriginalMessageId = "OriginalMessageId";
91
+ static readonly WebchatSequenceIdAttribute = "webchat:sequence-id";
92
+ static readonly MessageSequenceIdOverride = "MessageSequenceIdOverride";
89
93
  }
90
94
  export declare const Regex: {
91
95
  new (): {};