@microsoft/omnichannel-chat-sdk 1.3.1-main.2674439 → 1.3.1-main.6c37a66

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+### Added
+- Add ability to use `ChatSDK.getLiveChatTranscript()` to fetch live chat transcript from `liveChatContext`
+- Add ability to use `ChatSDK.getConversationDetails()` to fetch conversation details from `liveChatContext`
+
+### Changed
+- Update `ChatSDKErrors` to include standard ChatSDK errors to be more predictable
 
 ## [1.3.0] - 2023-04-05
 ### Added

package/README.md

@@ -272,7 +272,11 @@ const chatReconnectContext = await chatSDK.getChatReconnectContext(optionalParam
 It gets the details of the current conversation such as its state & when the agent joined the conversation.
 
 ```ts
-const conversationDetails = await chatSDK.getConversationDetails();
+const optionalParams = {
+    liveChatContext: {}, // EXISTING chat context data
+};
+
+const conversationDetails = await chatSDK.getConversationDetails(optionalParams);
 ```
 
 ### Get chat Token
@@ -376,7 +380,11 @@ await chatSDK.emailLiveChatTranscript(body);
 It fetches the current conversation transcript data in JSON.
 
 ```ts
-await chatSDK.getLiveChatTranscript();
+const optionalParams = {
+    liveChatContext: {}, // EXISTING chat context data
+};
+
+await chatSDK.getLiveChatTranscript(optionalParams);
 ```
 
 ### Upload File Attachment

package/lib/OmnichannelChatSDK.d.ts

@@ -25,6 +25,8 @@ import OmnichannelConfig from "./core/OmnichannelConfig";
 import OmnichannelMessage from "./core/messaging/OmnichannelMessage";
 import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalParams";
 import StartChatOptionalParams from "./core/StartChatOptionalParams";
+import GetLiveChatTranscriptOptionalParams from "./core/GetLiveChatTranscriptOptionalParams";
+import GetConversationDetailsOptionalParams from "./core/GetConversationDetailsOptionalParams";
 declare class OmnichannelChatSDK {
     private debug;
     runtimeId: string;
@@ -67,7 +69,7 @@ declare class OmnichannelChatSDK {
     startChat(optionalParams?: StartChatOptionalParams): Promise<void>;
     endChat(): Promise<void>;
     getCurrentLiveChatContext(): Promise<LiveChatContext | {}>;
-    getConversationDetails(): Promise<LiveWorkItemDetails>;
+    getConversationDetails(optionalParams?: GetConversationDetailsOptionalParams): Promise<LiveWorkItemDetails>;
     /**
      * Gets PreChat Survey.
      * @param parse Whether to parse PreChatSurvey to JSON or not.
@@ -86,7 +88,7 @@ declare class OmnichannelChatSDK {
     uploadFileAttachment(fileInfo: IFileInfo | File): Promise<IRawMessage | OmnichannelMessage>;
     downloadFileAttachment(fileMetadata: FileMetadata | IFileMetadata): Promise<Blob>;
     emailLiveChatTranscript(body: ChatTranscriptBody): Promise<any>;
-    getLiveChatTranscript(): Promise<any>;
+    getLiveChatTranscript(optionalParams?: GetLiveChatTranscriptOptionalParams): Promise<any>;
     createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<unknown>;
     getVoiceVideoCalling(params?: any): Promise<any>;
     getPostChatSurveyContext(): Promise<any>;