1 | # Changelog
|
2 |
|
3 | All notable changes to this project will be documented in this file.
|
4 |
|
5 | ## [Unreleased]
|
6 |
|
7 | ### Added
|
8 | - Adding new externalRuntimeId, allows to pass external runtimeId to ChatSDK and keep in sync sessions for telemetry.
|
9 |
|
10 | ## [1.8.0] - 2024-03-29
|
11 |
|
12 | ### Changed
|
13 |
|
14 | - Updated `OCClient.getSurveyInviteLink` request payload to support Copilot Survey
|
15 |
|
16 | ## [1.7.2] - 2024-03-20
|
17 |
|
18 | ### Fixed
|
19 |
|
20 | - Remove override block for follow-redirect, which was causing conflicts with ACS libs in LCW
|
21 |
|
22 | ## [1.7.1] - 2024-03-18
|
23 |
|
24 | ### Changed
|
25 |
|
26 | - Fix ChatSDK.getPostConversationContext() to reject promise when conversation is not found
|
27 |
|
28 | ## [1.7.0] - 2024-03-07
|
29 |
|
30 | ### Added
|
31 |
|
32 | - Add ability to use `ChatSDK.emailLiveChatTranscript()` to email live chat transcript from `liveChatContext`
|
33 | - Handling the lifecycle of `sessionId` if it exists
|
34 |
|
35 | ### Changed
|
36 |
|
37 | - Throw exception when `ChatSDK.startChat()` fails with `ChatSDKConfig.getAuthToken()` failures
|
38 | - Uptake [@microsoft/ocsdk@0.4.3](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.4.3)
|
39 |
|
40 | ## [1.6.3] - 2024-01-30
|
41 |
|
42 | ### Changed
|
43 |
|
44 | - Reduce number of `config` calls on loading `Escalation to Voice & Video` library by retrieving the config from runtime cache
|
45 |
|
46 | ## [1.6.2] - 2023-12-12
|
47 |
|
48 | ### Fixed
|
49 |
|
50 | - Add `supportedImagesMimeTypes` to support `MIME` types `image/heic` & `image/webp` as images
|
51 |
|
52 | ## [1.6.1] - 2023-12-07
|
53 |
|
54 | ### Added
|
55 |
|
56 | - Exported `ChatSDKErrorName` and `ChatSDKError` for downstream component to use
|
57 |
|
58 | ### Fixed
|
59 |
|
60 | - Subscribe to `chatMessageEdited` events within `onNewMessage()` for queue position message updates
|
61 |
|
62 | ### Changed
|
63 |
|
64 | - Uptake [@microsoft/ocsdk@0.4.2](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.4.2)
|
65 |
|
66 | ## [1.6.0] - 2023-12-04
|
67 |
|
68 | ### Changed
|
69 |
|
70 | - Added "httpResponseStatusCode" attribute in the error object thrown
|
71 |
|
72 | ## [1.5.7] - 2023-11-20
|
73 |
|
74 | ### Changed
|
75 |
|
76 | - Uptake [@microsoft/omnichannel-amsclient@0.1.6](https://www.npmjs.com/package/@microsoft/omnichannel-amsclient/v/0.1.6)
|
77 |
|
78 | ## [1.5.6] - 2023-11-13
|
79 |
|
80 | ### Added
|
81 |
|
82 | - Add `RequestPayload`, `RequestPath`, `RequestMethod`, `ResponseStatusCode` telemetry base property to `OCSDKContract`
|
83 | - Update Jest configuration and tests to support new libraries
|
84 |
|
85 | ### Security
|
86 |
|
87 | - Uptake [@microsoft/omnichannel-ic3core@0.1.3](https://www.npmjs.com/package/@microsoft/omnichannel-ic3core/v/0.1.3)
|
88 | - Uptake [@microsoft/ocsdk@0.4.1](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.4.1)
|
89 |
|
90 | ### Changed
|
91 |
|
92 | - Use `parseLowerCaseString()` on chat config properties to protect text case change
|
93 |
|
94 | ## [1.5.5] - 2023-10-31
|
95 |
|
96 | ### Added
|
97 |
|
98 | - Add ability to pass custom `ariaCollectorUri`
|
99 |
|
100 | ### Fixed
|
101 |
|
102 | - Add missing `PACS` URL for `EUDomainNames`
|
103 | - Fixed an issue where startChat failed due to optionalParam being null
|
104 |
|
105 | ## [1.5.4] - 2023-10-20
|
106 |
|
107 | ### Fixed
|
108 |
|
109 | - Fix `AriaTelemetry._configuration` not being passed to `AriaTelemetry._logger`
|
110 |
|
111 | ## [1.5.3] - 2023-10-18
|
112 |
|
113 | ### Fixed
|
114 |
|
115 | - Fix `ChatSDK.emailLiveChatTranscript()` calling `OCClient.emailTranscript()` without waiting until its completion
|
116 | - Fix `EU` orgs telemetry to flow to the proper `EU` location
|
117 |
|
118 | ## [1.5.2] - 2023-10-14
|
119 |
|
120 | ### Changed
|
121 |
|
122 | - Disable `tokenRefresher` temporarily
|
123 |
|
124 | ## [1.5.1] - 2023-10-11
|
125 |
|
126 | ### Fixed
|
127 |
|
128 | - Modify `getChatReconnectContext` to return redirection URL when reconnection ID is not longer Valid for Auth Chats.
|
129 |
|
130 | ## [1.5.0] - 2023-09-29
|
131 |
|
132 | ### Added
|
133 |
|
134 | - Add `Attachment File Scan` to `ChatSDK.createChatAdapter()`
|
135 |
|
136 | ## [1.4.7] - 2023-09-13
|
137 |
|
138 | ### Changed
|
139 |
|
140 | - Supporting getAgentAvailable SDK method for unauthenticated chat widget
|
141 |
|
142 | ## [1.4.6] - 2023-08-15
|
143 |
|
144 | ### Fixed
|
145 |
|
146 | - Fix `tokenRefresher` to update `chatToken` properly on expiry through reinitialization of AMSClient
|
147 |
|
148 | ## [1.4.5] - 2023-08-02
|
149 |
|
150 | ### Changed
|
151 |
|
152 | - Upgraded ACSAdapter to version beta.20
|
153 |
|
154 | ## [1.4.4] - 2023-07-19
|
155 |
|
156 | ### Added
|
157 |
|
158 | - Add `tokenRefresher` mechanism to retrieve chat token on expiry
|
159 |
|
160 | ### Changed
|
161 |
|
162 | - Add `ocSDKConfiguration` to reduce `chatToken` retries to 2
|
163 | - Uptake [@microsoft/ocsdk@0.4.0](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.4.0)
|
164 | - Remove redundant call to create of `participantsMapping`
|
165 |
|
166 | ### Fixed
|
167 |
|
168 | - Set `enableSenderDisplayNameInTypingNotification` to true to include display name on sending typing notification
|
169 | - Add `async` to `ChatSDK.getLiveChatTranscript()` internal call
|
170 |
|
171 | ## [1.4.3] - 2023-06-15
|
172 |
|
173 | ### Fixed
|
174 |
|
175 | - [Perf] Make sessionInit, AcsClientInit/Ic3ClientInit and AmsClientInit calls in parallel
|
176 |
|
177 | ## [1.4.2] - 2023-05-19
|
178 |
|
179 | ### Fixed
|
180 |
|
181 | - Fixed null check on startChat failure
|
182 |
|
183 | ## [1.4.1] - 2023-05-05
|
184 |
|
185 | ### Fixed
|
186 |
|
187 | - Skipped empty string or null context variables (parity with v1)
|
188 |
|
189 | ## [1.4.0] - 2023-05-02
|
190 |
|
191 | ### Added
|
192 |
|
193 | - Add ability to use `ChatSDK.getLiveChatTranscript()` to fetch live chat transcript from `liveChatContext`
|
194 | - Add ability to use `ChatSDK.getConversationDetails()` to fetch conversation details from `liveChatContext`
|
195 | - Add `AuthContactIdNotFoundFailure` to `ExceptionThrower`
|
196 |
|
197 | ### Changed
|
198 |
|
199 | - Update `ChatSDKErrors` to include standard ChatSDK errors to be more predictable
|
200 |
|
201 | ## [1.3.0] - 2023-04-05
|
202 |
|
203 | ### Added
|
204 |
|
205 | - Add ability to use `ChatSDK.createChatAdapter()` for `DirectLine` protocol
|
206 | - Add `CreateACSAdapter` telemetry event
|
207 | - Improve `ChatSDK.createChatAdapter()` with retries using exponential backoff & additional details on failures
|
208 | - Add `GetAgentAvailability` SDK method for auth chat
|
209 | - Pass `logger` to AMSClient
|
210 | - Add `portalContactId` in `StartChatOptionalParams` and `GetAgentAvailabilityOptionalParams`
|
211 | - Added exception on initialization failure
|
212 | - Upgraded ACSAdapter to version beta.17
|
213 | - Added `botSurveyInviteLink` and `botFormsProLocale` the `getPostChatSurveyContext()` response
|
214 |
|
215 | ### Fixed
|
216 |
|
217 | - Fix `ChatAdapterOptionalParams.ACSAdapter.options.egressMiddleware` being used as `ingressMiddleware`
|
218 | - Fix `ChatSDK.onTypingEvent()` being triggered on current user typing
|
219 | - Update `ChatSDK.liveChatVersion` to be `V2` by default
|
220 |
|
221 | ### Changed
|
222 |
|
223 | - Uptake [@microsoft/omnichannel-amsclient@0.1.4](https://www.npmjs.com/package/@microsoft/omnichannel-amsclient/v/0.1.4)
|
224 | - Uptake [acs_webchat-chat-adapter@0.0.35-beta.17](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.17/dist/chat-adapter.js)
|
225 | - Uptake [@microsoft/ocsdk@0.3.4](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.3.4)
|
226 |
|
227 | ## [1.2.0] - 2022-11-11
|
228 |
|
229 | ### Added
|
230 |
|
231 | - Add `sendDefaultInitContext` optional parameter to `ChatSDK.startChat()` to automatically populate `browser`, `device`, `originurl` & `os` as default init context on web
|
232 | - Add `sendCacheHeaders` as optional paramater to `ChatSDK.initialize()` and `ChatSDK.getLiveChatConfig()`
|
233 | - Add `validateAuthChatRecord` call on `ChatSDK.startChat()` with `liveChatContext` for all authenticated chat scenarios
|
234 | - Pass `ChatClient` during `ACSAdapter` initialization
|
235 | - Pass `multiClient` to `AMSClient` on initialization to support `ChatSDK` multi-client
|
236 |
|
237 | ### Fixed
|
238 |
|
239 | - Prevent `AMSFileManager.getFileIds()` & `AMSFileManager.getFileMetadata()` to be triggered on all activities with null checks
|
240 | - Add `LiveChatVersion` check on `ChatSDK.updateChatToken()`
|
241 | - Use `amsreferences` property instead of `amsReferences` by default
|
242 | - Fix attachment download to use MIME types instead of file extensions
|
243 | - Remove `fileMetadata` property on messages not containing any attachment
|
244 |
|
245 | ### Changed
|
246 |
|
247 | - Uptake [@microsoft/ocsdk@0.3.1](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.3.1)
|
248 | - Uptake [acs_webchat-chat-adapter@0.0.35-beta.8](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.8/dist/chat-adapter.js)
|
249 | - Uptake [acs_webchat-chat-adapter@0.0.35-beta.9](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.9/dist/chat-adapter.js)
|
250 | - Uptake [acs_webchat-chat-adapter@0.0.35-beta.12](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.12/dist/chat-adapter.js)
|
251 | - Uptake [@microsoft/omnichannel-amsclient@0.1.2](https://www.npmjs.com/package/@microsoft/omnichannel-amsclient/v/0.1.2)
|
252 | - Uptake [@microsoft/ocsdk@0.3.2](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.3.2)
|
253 |
|
254 | ## [1.1.0] - 2022-04-15
|
255 |
|
256 | ### Added
|
257 |
|
258 | - Add `getPostChatSurveyContext` API method
|
259 | - Add `GetPostChatSurveyContext` telemetry event
|
260 | - Add `widgetId` & `clientMessageId` as metadata on sending message
|
261 | - Update `ChatConfig` interface with `LiveChatVersion`, `allowedFileExtensions` & `maxUploadFileSize` properties
|
262 | - Add ability to automatically detect locale from chat config
|
263 | - Add `runtimeId` attribute in `OmnichannelChatSDK` & `ChatSDKRuntimeId` field in telemetry
|
264 | - Add ability to automatically pass locale from chat config on calling `ChatSDK.emailLiveChatTranscript()`
|
265 | - Bubble up `WidgetUseOutsideOperatingHour` exception
|
266 | - Add `acs_webchat-chat-adapter` middleware to add default `channelData.tags` & `channelData.metadata`
|
267 | - Update `ChatConfig` interface with `msdyn_enablemarkdown` property
|
268 | - Throw exception on `ChatSDK.getVoiceVideoCalling()` if feature is disabled or platform is not supported
|
269 | - Add `participantType` & `canRenderPostChat` as response of getConversationDetails() API
|
270 | - Add support for separate bot post chat survey feature
|
271 | - Pass `logger` to `acs_webchat-chat-adapter`
|
272 |
|
273 | ### Fixed
|
274 |
|
275 | - Add `acs_webchat-chat-adapter` middlewares to format `channelData.tags`
|
276 | - Skip `session init` call on existing conversation
|
277 | - Fix `chat reconnect` not ending the conversation on calling `ChatSDK.endChat()`
|
278 | - Fix on messaging client not sending heartbeat on new conversations subsequent to the first conversation
|
279 | - Fix `ChatSDK.getConversationDetails()` not passing `authenticatedUserToken`
|
280 | - Fix `IC3Client.dispose()` called when `IC3Client` is `undefined`
|
281 |
|
282 | ### Changed
|
283 |
|
284 | - README: added examples on usages of the post chat APIs.
|
285 | - Uptake [@azure/communication-chat@1.1.1](https://www.npmjs.com/package/@azure/communication-chat/v/1.1.1)
|
286 | - Uptake [acs_webchat-chat-adapter@0.0.35-beta.2](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.2/dist/chat-adapter.js)
|
287 | - Update `locale` property in `ChatTranscriptBody` interface to be optional
|
288 | - Uptake [acs_webchat-chat-adapter@0.0.35-beta.4](https://unpkg.com/acs_webchat-chat-adapter@0.0.35-beta.4/dist/chat-adapter.js)
|
289 |
|
290 | ## [1.0.0] - 2021-10-08
|
291 |
|
292 | ### Added
|
293 |
|
294 | - Add `GetAuthToken` & `GetPreChatSurvey` telemetry events
|
295 | - Add `Domain` telemetry base property
|
296 | - Add `GetCurrentLiveChatContext`, `GetMessages`, `SendMessages`, `OnNewMessage` & `OnTypingEvent` telemetry events
|
297 | - Live Chat V2 Support
|
298 | - Add `PlatformDetails` telemetry event
|
299 |
|
300 | ### Changed
|
301 |
|
302 | - Uptake [@microsoft/ocsdk@0.3.0](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.3.0)
|
303 | - Uptake [@microsoft/omnichannel-ic3core@0.1.2](https://www.npmjs.com/package/@microsoft/omnichannel-ic3core/v/0.1.2)
|
304 |
|
305 | ### Fixed
|
306 |
|
307 | - `onNewMessage` with `rehydrate` flag set to `true` crashing when `getMessages` returns `undefined`
|
308 | - Fix `AriaTelemetry` unable to read property `logEvent` of undefined on `React Native`
|
309 | - Fix `Escalation to Voice & Video` library not being imported properly
|
310 |
|
311 | ## [0.3.0] - 2021-09-03
|
312 |
|
313 | ### Added
|
314 |
|
315 | - Persistent Chat Support
|
316 | - Chat Reconnect Support
|
317 | - Operating Hours Documentation
|
318 |
|
319 | ### Changed
|
320 |
|
321 | - Uptake [@microsoft/ocsdk@0.2.0](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.2.0)
|
322 | - Add `getCallingToken`
|
323 | - Send `ChannelId-lcw` message tag
|
324 | - Uptake [IC3Client@2021.08.14.1](https://comms.omnichannelengagementhub.com/release/2021.08.14.1/Scripts/SDK/SDK.min.js)
|
325 | - Uptake [botframework-webchat-adapter-ic3@0.1.0-master.2dba07b](https://www.npmjs.com/package/botframework-webchat-adapter-ic3/v/0.1.0-master.2dba07b)
|
326 | - Uptake [jest@27.1.0](https://www.npmjs.com/package/jest/v/27.1.0)
|
327 | - Update [@types/jest@27.0.1](https://www.npmjs.com/package/@types/jest/v/27.0.1)
|
328 | - Uptake [ts-jest@27.0.5](https://www.npmjs.com/package/ts-jest/v/27.0.5)
|
329 |
|
330 | ### Fixed
|
331 |
|
332 | - `msdyn_enablechatreconnect` not being parsed properly
|
333 | - Fix unable to start multiple conversations with same instance due to chat client being disposed
|
334 | - Pass logger to adapter
|
335 |
|
336 | ## [0.2.0] - 2021-04-30
|
337 |
|
338 | ### Added
|
339 |
|
340 | - React Native sample app using Omnichannel Chat SDK with [react-native-gifted-chat](https://github.com/FaridSafi/react-native-gifted-chat)
|
341 | - Escalation to Voice & Video support (Web Only)
|
342 | - React sample app using Omnichannel Chat SDK with [BotFramework-WebChat](https://github.com/microsoft/BotFramework-WebChat)
|
343 | - Expose `sessiontInit`'s `initContext` on `startChat`'s optional paramaters
|
344 | - Add ability to use custom `ic3Config` & `chatAdapterConfig`
|
345 | - Add telemetry
|
346 | - Add `rehydrate` flag for `onNewMessage` to rehydrate all messages of existing conversation
|
347 | - Add `getConversationDetails`
|
348 | - Add ability to pass custom `ariaTelemetryKey`
|
349 |
|
350 | ### Changed
|
351 |
|
352 | - Uptake [@microsoft/ocsdk@0.1.1](https://www.npmjs.com/package/@microsoft/ocsdk/v/0.1.1)
|
353 | - Uptake [@microsoft/omnichannel-ic3core@0.1.1](https://www.npmjs.com/package/@microsoft/omnichannel-ic3core/v/0.1.1)
|
354 | - Uptake [jest@26.6.3](https://www.npmjs.com/package/jest/v/26.6.3)
|
355 | - Uptake [ts-jest@26.5.1](https://www.npmjs.com/package/ts-jest/v/26.5.1)
|
356 | - Uptake [IC3Client@2021.03.02.1](https://comms.omnichannelengagementhub.com/release/2021.03.02.1/Scripts/SDK/SDK.min.js)
|
357 | - Uptake [botframework-webchat-adapter-ic3@0.1.0-master.f4dfd7d](https://www.npmjs.com/package/botframework-webchat-adapter-ic3/v/0.1.0-master.f4dfd7d)
|
358 |
|
359 | ### Fixed
|
360 |
|
361 | - onAgentEndSession triggered on accept voice & video call
|
362 | - Fix multiple instances of IC3Client initialized
|
363 | - `uploadFileAttachment` failing on Web
|
364 |
|
365 | ### Security
|
366 |
|
367 | - Fix eslint errors
|
368 |
|
369 | ## [0.1.0] - 2020-10-26
|
370 |
|
371 | ### Added
|
372 |
|
373 | - Initial release of Omnichannel Chat SDK v0.1.0
|