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