@microsoft/omnichannel-chat-sdk 1.0.1-main.90a4f94 → 1.0.1-main.9e71fa6

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 (38) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +2 -3
  3. package/lib/OmnichannelChatSDK.d.ts +5 -1
  4. package/lib/OmnichannelChatSDK.js +232 -173
  5. package/lib/OmnichannelChatSDK.js.map +1 -1
  6. package/lib/core/ChatConfig.d.ts +1 -0
  7. package/lib/core/ChatSDKExceptionDetails.d.ts +5 -0
  8. package/lib/core/ChatSDKExceptionDetails.js +3 -0
  9. package/lib/core/ChatSDKExceptionDetails.js.map +1 -0
  10. package/lib/core/OmnichannelErrorCodes.d.ts +4 -0
  11. package/lib/core/OmnichannelErrorCodes.js +8 -0
  12. package/lib/core/OmnichannelErrorCodes.js.map +1 -0
  13. package/lib/core/messaging/ChatAdapterOptionalParams.d.ts +14 -0
  14. package/lib/core/messaging/ChatAdapterOptionalParams.js +3 -0
  15. package/lib/core/messaging/ChatAdapterOptionalParams.js.map +1 -0
  16. package/lib/core/messaging/MessageTags.d.ts +2 -0
  17. package/lib/core/messaging/MessageTags.js +4 -2
  18. package/lib/core/messaging/MessageTags.js.map +1 -1
  19. package/lib/external/ACSAdapter/createChannelDataEgressMiddleware.d.ts +5 -0
  20. package/lib/external/ACSAdapter/createChannelDataEgressMiddleware.js +34 -0
  21. package/lib/external/ACSAdapter/createChannelDataEgressMiddleware.js.map +1 -0
  22. package/lib/external/IC3Adapter/IIC3AdapterOptions.d.ts +12 -0
  23. package/lib/telemetry/AriaTelemetry.js +5 -0
  24. package/lib/telemetry/AriaTelemetry.js.map +1 -1
  25. package/lib/telemetry/ScenarioMarker.d.ts +2 -0
  26. package/lib/telemetry/ScenarioMarker.js +7 -3
  27. package/lib/telemetry/ScenarioMarker.js.map +1 -1
  28. package/lib/tsconfig.tsbuildinfo +109 -29
  29. package/lib/utils/WebUtils.d.ts +3 -1
  30. package/lib/utils/WebUtils.js +8 -2
  31. package/lib/utils/WebUtils.js.map +1 -1
  32. package/lib/utils/locale.d.ts +1 -0
  33. package/lib/utils/locale.js +2 -1
  34. package/lib/utils/locale.js.map +1 -1
  35. package/lib/utils/loggers.d.ts +8 -0
  36. package/lib/utils/loggers.js +24 -0
  37. package/lib/utils/loggers.js.map +1 -1
  38. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -8,10 +8,20 @@ All notable changes to this project will be documented in this file.
8
8
  - Add `GetPostChatSurveyContext` telemetry event
9
9
  - Add `widgetId` & `clientMessageId` as metadata on sending message
10
10
  - Update `ChatConfig` interface with `LiveChatVersion`, `allowedFileExtensions` & `maxUploadFileSize` properties
11
+ - Add ability to automatically detect locale from chat config
12
+ - Add `runtimeId` attribute in `OmnichannelChatSDK` & `ChatSDKRuntimeId` field in telemetry
13
+ - Add ability to automatically pass locale from chat config on calling `ChatSDK.emailLiveChatTranscript()`
14
+ - Bubble up `WidgetUseOutsideOperatingHour` exception
15
+ - Add `acs_webchat-chat-adapter` middleware to add default `channelData.tags` & `channelData.metadata`
16
+ - Update `ChatConfig` interface with `msdyn_enablemarkdown` property
11
17
 
12
18
  ### Fix
13
19
  - Add `acs_webchat-chat-adapter` middlewares to format `channelData.tags`
14
20
  - Skip `session init` call on existing conversation
21
+ - Fix `chat reconnect` not ending the conversation on calling `ChatSDK.endChat()`
22
+ - Fix on messaging client not sending heartbeat on new conversations subsequent to the first conversation
23
+ - Fix `ChatSDK.getConversationDetails()` not passing `authenticatedUserToken`
24
+ - Fix `IC3Client.dispose()` called when `IC3Client` is `undefined`
15
25
 
16
26
  ### Changed
17
27
  - README: added examples on usages of the post chat APIs.
package/README.md CHANGED
@@ -131,7 +131,7 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
131
131
  | OmnichannelChatSDK.getLiveChatTranscript() | Get transcript data (JSON) | |
132
132
  | OmnichannelChatSDK.uploadFileAttachment() | Send file attachment | |
133
133
  | OmnichannelChatSDK.downloadFileAttachment() | Download file attachment | |
134
- | OmnichannelChatSDK.createChatAdapter() | Get IC3Adapter | **Web only** |
134
+ | OmnichannelChatSDK.createChatAdapter() | Get Chat Adapter | **Web only** |
135
135
  | OmnichannelChatSDK.getVoiceVideoCalling() | Get VoiceVideoCall SDK for Escalation to Voice & Video | **Web only** |
136
136
  | OmnichannelChatSDK.getPostChatSurveyContext() | Get post chat survey link, survey locale, and whether an agent has joined the survey | |
137
137
 
@@ -335,8 +335,7 @@ The following steps will be required to run Omnichannel Chat SDK on React Native
335
335
  ```ts
336
336
  const body = {
337
337
  emailAddress: 'contoso@microsoft.com',
338
- attachmentMessage: 'Attachment Message',
339
- locale: 'en-us'
338
+ attachmentMessage: 'Attachment Message'
340
339
  };
341
340
  await chatSDK.emailLiveChatTranscript(body);
342
341
  ```
@@ -1,5 +1,6 @@
1
1
  import ACSClient from "./core/messaging/ACSClient";
2
2
  import { ParticipantsRemovedEvent } from '@azure/communication-signaling';
3
+ import ChatAdapterOptionalParams from "./core/messaging/ChatAdapterOptionalParams";
3
4
  import ChatConfig from "./core/ChatConfig";
4
5
  import ChatReconnectContext from "./core/ChatReconnectContext";
5
6
  import ChatReconnectOptionalParams from "./core/ChatReconnectOptionalParams";
@@ -23,6 +24,7 @@ import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalPar
23
24
  import StartChatOptionalParams from "./core/StartChatOptionalParams";
24
25
  declare class OmnichannelChatSDK {
25
26
  private debug;
27
+ runtimeId: string;
26
28
  OCSDKProvider: unknown;
27
29
  IC3SDKProvider: unknown;
28
30
  OCClient: any;
@@ -32,6 +34,7 @@ declare class OmnichannelChatSDK {
32
34
  omnichannelConfig: OmnichannelConfig;
33
35
  chatSDKConfig: ChatSDKConfig;
34
36
  isInitialized: boolean;
37
+ localeId: string;
35
38
  requestId: string;
36
39
  private chatToken;
37
40
  private liveChatConfig;
@@ -79,7 +82,7 @@ declare class OmnichannelChatSDK {
79
82
  downloadFileAttachment(fileMetadata: FileMetadata | IFileMetadata): Promise<Blob>;
80
83
  emailLiveChatTranscript(body: ChatTranscriptBody): Promise<any>;
81
84
  getLiveChatTranscript(): Promise<any>;
82
- createChatAdapter(protocol?: string | null): Promise<unknown>;
85
+ createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<unknown>;
83
86
  getVoiceVideoCalling(params?: any): Promise<any>;
84
87
  getPostChatSurveyContext(): Promise<any>;
85
88
  private getIC3Client;
@@ -87,5 +90,6 @@ declare class OmnichannelChatSDK {
87
90
  private resolveIC3ClientUrl;
88
91
  private resolveChatAdapterUrl;
89
92
  private updateChatToken;
93
+ private setAuthTokenProvider;
90
94
  }
91
95
  export default OmnichannelChatSDK;