omnichannel-chat-sdk

[1.5.2] - 2023-10-14

Changed

• Disable tokenRefresher temporarily

Fixed: Modify getChatReconnectContext to return redirection URL when reconnection ID is no longer Valid for Auth Chats.

[1.5.0] - 2023-09-29

Added

• Add Attachment File Scan to ChatSDK.createChatAdapter()

[1.4.7] - 2023-09-13

Changed

• Supporting getAgentAvailable SDK method for unauthenticated chat widget

[1.4.6] - 2023-08-15

Fixed

• Fix tokenRefresher to update chatToken properly on expiry through reinitialization of AMSClient

[1.4.5] - 2023-08-02

Changed

• Upgraded ACSAdapter to version beta.20

[1.4.4] - 2023-07-19

Added

• Add tokenRefresher mechanism to retrieve chat token on expiry

Changed

• Add ocSDKConfiguration to reduce chatToken retries to 2
• Uptake @microsoft/[email protected]
• Remove redundant call to create of participantsMapping

Fixed

• Set enableSenderDisplayNameInTypingNotification to true to include display name on sending typing notification
• Add async to ChatSDK.getLiveChatTranscript() internal call

[1.4.3] - 2023-06-15

Fixed

• [Perf] Make sessionInit, AcsClientInit/Ic3ClientInit and AmsClientInit calls in parallel

[1.4.2] - 2023-05-19

Fixed

• Fixed null check on startChat failure

[1.4.1] - 2023-05-05

Fixed

• Skipped empty string or null context variables (parity with v1)

[1.4.0] - 2023-05-02

Added

• Added ability to use ChatSDK.getLiveChatTranscript() to fetch live chat transcript from liveChatContext
• Added ability to use ChatSDK.getConversationDetails() to fetch conversation details from liveChatContext
• Added AuthContactIdNotFoundFailure to ExceptionThrower

Changed

• Updated ChatSDKErrors to include standard ChatSDK errors to be more predictable

[1.3.0] - 2023-04-05

Added

• Add ability to use ChatSDK.createChatAdapter() for DirectLine protocol
• Add CreateACSAdapter telemetry event
• Improve ChatSDK.createChatAdapter() with retries using exponential backoff & additional details on failures
• Add GetAgentAvailability SDK method for auth chat
• Pass logger to AMSClient
• Add portalContactId in StartChatOptionalParams and GetAgentAvailabilityOptionalParams
• Added exception on initialization failure
• Upgraded ACSAdapter to version beta.17
• Added botSurveyInviteLink and botFormsProLocale the getPostChatSurveyContext() response

Fixed

• Fix ChatAdapterOptionalParams.ACSAdapter.options.egressMiddleware being used as ingressMiddleware
• Fix ChatSDK.onTypingEvent() being triggered on current user typing
• Update ChatSDK.liveChatVersion to be V2 by default

Changed

• Uptake @microsoft/[email protected]
• Uptake [email protected]
• Uptake @microsoft/[email protected]

[1.2.0] - 2022-11-11

Added

• Add sendDefaultInitContext optional parameter to ChatSDK.startChat() to automatically populate browser, device, originurl & os as default init context on web
• Add sendCacheHeaders as optional paramater to ChatSDK.initialize() and ChatSDK.getLiveChatConfig()
• Add validateAuthChatRecord call on ChatSDK.startChat() with liveChatContext for all authenticated chat scenarios
• Pass ChatClient during ACSAdapter initialization
• Pass multiClient to AMSClient on initialization to support ChatSDK multi-client

Fixed

• Prevent AMSFileManager.getFileIds() & AMSFileManager.getFileMetadata() to be triggered on all activities with null checks
• Add LiveChatVersion check on ChatSDK.updateChatToken()
• Use amsreferences property instead of amsReferences by default
• Fix attachment download to use MIME types instead of file extensions
• Remove fileMetadata property on messages not containing any attachment

Changed

• Uptake @microsoft/[email protected]
• Uptake [email protected]
• Uptake [email protected]
• Uptake [email protected]
• Uptake @microsoft/[email protected]
• Uptake @microsoft/[email protected]

[1.1.0] - 2022-04-15

Added

• Add getPostChatSurveyContext API method
• Add GetPostChatSurveyContext telemetry event
• Add widgetId & clientMessageId as metadata on sending message
• Update ChatConfig interface with LiveChatVersion, allowedFileExtensions & maxUploadFileSize properties
• Add ability to automatically detect locale from chat config
• Add runtimeId attribute in OmnichannelChatSDK & ChatSDKRuntimeId field in telemetry
• Add ability to automatically pass locale from chat config on calling ChatSDK.emailLiveChatTranscript()
• Bubble up WidgetUseOutsideOperatingHour exception
• Add acs_webchat-chat-adapter middleware to add default channelData.tags & channelData.metadata
• Update ChatConfig interface with msdyn_enablemarkdown property
• Throw exception on ChatSDK.getVoiceVideoCalling() if feature is disabled or platform is not supported
• Add participantType & canRenderPostChat as response of getConversationDetails() API
• Add support for separate bot post chat survey feature
• Pass logger to acs_webchat-chat-adapter

Fixed

• Add acs_webchat-chat-adapter middlewares to format channelData.tags
• Skip session init call on existing conversation
• Fix chat reconnect not ending the conversation on calling ChatSDK.endChat()
• Fix on messaging client not sending heartbeat on new conversations subsequent to the first conversation
• Fix ChatSDK.getConversationDetails() not passing authenticatedUserToken
• Fix IC3Client.dispose() called when IC3Client is undefined

Changed

• README: added examples on usages of the post chat APIs.
• Uptake @azure/[email protected]
• Uptake [email protected]
• Update locale property in ChatTranscriptBody interface to be optional
• Uptake [email protected]

[1.0.0] - 2021-10-08

Added

• Add GetAuthToken & GetPreChatSurvey telemetry events
• Add Domain telemetry base property
• Add GetCurrentLiveChatContext, GetMessages, SendMessages, OnNewMessage & OnTypingEvent telemetry events
• Live Chat V2 Support
• Add PlatformDetails telemetry event

Changed

• Uptake @microsoft/[email protected]
• Uptake @microsoft/[email protected]

Fixed

• onNewMessage with rehydrate flag set to true crashing when getMessages returns undefined
• Fix AriaTelemetry unable to read property logEvent of undefined on React Native
• Fix Escalation to Voice & Video library not being imported properly

[0.3.0] - 2021-09-03

Added

• Persistent Chat Support
• Chat Reconnect Support
• Operating Hours Documentation

Changed

• Uptake @microsoft/[email protected]
• Add getCallingToken
• Send ChannelId-lcw message tag
• Uptake [email protected]
• Uptake [email protected]
• Uptake [email protected]
• Update @types/[email protected]
• Uptake [email protected]

Fixed

• msdyn_enablechatreconnect not being parsed properly
• Fix unable to start multiple conversations with same instance due to chat client being disposed
• Pass logger to adapter

[0.2.0] - 2021-04-30

Added

• React Native sample app using Omnichannel Chat SDK with react-native-gifted-chat
• Escalation to Voice & View support (Web Only)
• React sample app using Omnichannel Chat SDK with BotFramework-WebChat
• Expose sessiontInit's initContext on startChat's optional paramaters
• Add ability to use custom ic3Config & chatAdapterConfig
• Add telemetry
• Add rehydrate flag for onNewMessage to rehydrate all messages of existing conversation
• Add getConversationDetails
• Add ability to pass custom ariaTelemetryKey

Changed

• Uptake @microsoft/[email protected]
• Uptake @microsoft/[email protected]
• Uptake [email protected]
• Uptake [email protected]
• Uptake [email protected]
• Uptake [email protected]

Fixed

• onAgentEndSession triggered on accept voice & video call
• Fix multiple instances of IC3Client initialized
• uploadFileAttachment failing on Web

Security

• Fix eslint errors

[0.1.0] - 2020-10-26

Added

Initial release of Omnichannel Chat SDK v0.1.0