@microsoft/omnichannel-chat-sdk 1.11.6 → 1.11.7-main.3418dc3

package/lib/OmnichannelChatSDK.d.ts

@@ -1,6 +1,6 @@
 import ACSClient from "./core/messaging/ACSClient";
 import { VoiceVideoCallingOptionalParams } from "./types/config";
-import { ChatAdapter, GetAgentAvailabilityResponse, GetCurrentLiveChatContextResponse, GetLiveChatTranscriptResponse, GetMessagesResponse, GetPreChatSurveyResponse, GetVoiceVideoCallingResponse, MaskingRules, UploadFileAttachmentResponse } from "./types/response";
+import { ChatAdapter, GetAgentAvailabilityResponse, GetCurrentLiveChatContextResponse, GetLiveChatTranscriptResponse, GetMessagesResponse, GetPersistentChatHistoryResponse, GetPreChatSurveyResponse, GetVoiceVideoCallingResponse, MaskingRules, UploadFileAttachmentResponse } from "./types/response";
 import { ParticipantsRemovedEvent } from '@azure/communication-signaling';
 import ChatAdapterOptionalParams from "./core/messaging/ChatAdapterOptionalParams";
 import ChatConfig from "./core/ChatConfig";
@@ -21,6 +21,7 @@ import GetChatTokenOptionalParams from "./core/GetChatTokenOptionalParams";
 import GetConversationDetailsOptionalParams from "./core/GetConversationDetailsOptionalParams";
 import GetLiveChatConfigOptionalParams from "./core/GetLiveChatConfigOptionalParams";
 import GetLiveChatTranscriptOptionalParams from "./core/GetLiveChatTranscriptOptionalParams";
+import GetPersistentChatHistoryOptionalParams from "./core/GetPersistentChatHistoryOptionalParams";
 import IChatToken from "./external/IC3Adapter/IChatToken";
 import IFileInfo from "@microsoft/omnichannel-ic3core/lib/interfaces/IFileInfo";
 import IFileMetadata from "@microsoft/omnichannel-ic3core/lib/model/IFileMetadata";
@@ -186,5 +187,10 @@ declare class OmnichannelChatSDK {
      * @private
      */
     private handleConversationJoinFailure;
+    /**
+     * Get persistent chat history for authenticated users.
+     * @param getPersistentChatHistoryOptionalParams Optional parameters for persistent chat history retrieval.
+     */
+    getPersistentChatHistory(getPersistentChatHistoryOptionalParams?: GetPersistentChatHistoryOptionalParams): Promise<GetPersistentChatHistoryResponse | undefined>;
 }
 export default OmnichannelChatSDK;

package/lib/OmnichannelChatSDK.js

@@ -1972,8 +1972,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     OmnichannelChatSDK.prototype.onAgentEndSession = function (onAgentEndSessionCallback) {
         return __awaiter(this, void 0, void 0, function () {
             var _this = this;
-            var _a;
-            return __generator(this, function (_b) {
+            return __generator(this, function (_a) {
                 this.scenarioMarker.startScenario(TelemetryEvent_1.default.OnAgentEndSession, {
                     RequestId: this.requestId,
                     ChatId: this.chatToken.chatId
@@ -1981,59 +1980,32 @@ var OmnichannelChatSDK = /** @class */ (function () {
                 if (!this.isInitialized) {
                     exceptionThrowers_1.default.throwUninitializedChatSDK(this.scenarioMarker, TelemetryEvent_1.default.OnAgentEndSession);
                 }
-                if (this.liveChatVersion === LiveChatVersion_1.default.V2) {
-                    try {
-                        this.conversation.registerOnThreadUpdate(function (event) { return __awaiter(_this, void 0, void 0, function () {
-                            var liveWorkItemDetails;
-                            return __generator(this, function (_a) {
-                                switch (_a.label) {
-                                    case 0: return [4 /*yield*/, this.getConversationDetails()];
-                                    case 1:
-                                        liveWorkItemDetails = _a.sent();
-                                        if (Object.keys(liveWorkItemDetails).length === 0 || liveWorkItemDetails.state == LiveWorkItemState_1.default.WrapUp || liveWorkItemDetails.state == LiveWorkItemState_1.default.Closed) {
-                                            onAgentEndSessionCallback(event);
-                                            this.stopPolling();
-                                        }
-                                        return [2 /*return*/];
-                                }
-                            });
-                        }); });
-                        this.scenarioMarker.completeScenario(TelemetryEvent_1.default.OnAgentEndSession, {
-                            RequestId: this.requestId,
-                            ChatId: this.chatToken.chatId
-                        });
-                    }
-                    catch (error) {
-                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.OnAgentEndSession, {
-                            RequestId: this.requestId,
-                            ChatId: this.chatToken.chatId
-                        });
-                    }
-                }
-                else {
-                    try {
-                        (_a = this.conversation) === null || _a === void 0 ? void 0 : _a.registerOnThreadUpdate(function (message) {
-                            var members = message.members;
-                            // Agent ending conversation would have 1 member left in the chat thread
-                            if (members.length === 1) {
-                                onAgentEndSessionCallback(message);
-                                if (_this.refreshTokenTimer !== null) {
-                                    clearInterval(_this.refreshTokenTimer);
-                                    _this.refreshTokenTimer = null;
-                                }
+                try {
+                    this.conversation.registerOnThreadUpdate(function (event) { return __awaiter(_this, void 0, void 0, function () {
+                        var liveWorkItemDetails;
+                        return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, this.getConversationDetails()];
+                                case 1:
+                                    liveWorkItemDetails = _a.sent();
+                                    if (Object.keys(liveWorkItemDetails).length === 0 || liveWorkItemDetails.state == LiveWorkItemState_1.default.WrapUp || liveWorkItemDetails.state == LiveWorkItemState_1.default.Closed) {
+                                        onAgentEndSessionCallback(event);
+                                        this.stopPolling();
+                                    }
+                                    return [2 /*return*/];
                             }
                         });
-                        this.scenarioMarker.completeScenario(TelemetryEvent_1.default.OnAgentEndSession, {
-                            RequestId: this.requestId,
-                            ChatId: this.chatToken.chatId
-                        });
-                    }
-                    catch (error) {
-                        this.scenarioMarker.failScenario(TelemetryEvent_1.default.OnAgentEndSession, {
-                            RequestId: this.requestId,
-                            ChatId: this.chatToken.chatId
-                        });
-                    }
+                    }); });
+                    this.scenarioMarker.completeScenario(TelemetryEvent_1.default.OnAgentEndSession, {
+                        RequestId: this.requestId,
+                        ChatId: this.chatToken.chatId
+                    });
+                }
+                catch (error) {
+                    this.scenarioMarker.failScenario(TelemetryEvent_1.default.OnAgentEndSession, {
+                        RequestId: this.requestId,
+                        ChatId: this.chatToken.chatId
+                    });
                 }
                 return [2 /*return*/];
             });
@@ -2486,7 +2458,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.getPostChatSurveyContext = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var conversationId, chatConfig, liveWSAndLiveChatEngJoin, msdyn_postconversationsurveyenable, msfp_sourcesurveyidentifier, msfp_botsourcesurveyidentifier, postConversationSurveyOwnerId, postConversationBotSurveyOwnerId, msdyn_surveyprovider, surveyProvider, liveWorkItemDetails, participantJoined, participantType, agentSurveyInviteLinkRequest, botSurveyInviteLinkRequest, optionalParams, agentSurveyInviteLinkResponse, botSurveyInviteLinkResponse, _a, agentSurveyInviteLink, agentFormsProLocale, botSurveyInviteLink, botFormsProLocale, postChatContext, ex_1;
+            var conversationId, chatConfig, liveWSAndLiveChatEngJoin, msdyn_postconversationsurveyenable, msfp_sourcesurveyidentifier, msfp_botsourcesurveyidentifier, postConversationSurveyOwnerId, postConversationBotSurveyOwnerId, msdyn_surveyprovider, surveyProvider, liveWorkItemDetails, participantJoined, participantType, agentSurveyInviteLinkRequest, botSurveyInviteLinkRequest, optionalParams, _a, agentSurveyInviteLinkResponse, botSurveyInviteLinkResponse, agentSurveyInviteLink, agentFormsProLocale, botSurveyInviteLink, botFormsProLocale, postChatContext, ex_1;
             var _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
             return __generator(this, function (_o) {
                 switch (_o.label) {
@@ -2500,7 +2472,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         }
                         _o.label = 1;
                     case 1:
-                        _o.trys.push([1, 8, , 9]);
+                        _o.trys.push([1, 6, , 7]);
                         chatConfig = this.liveChatConfig;
                         liveWSAndLiveChatEngJoin = chatConfig.LiveWSAndLiveChatEngJoin;
                         msdyn_postconversationsurveyenable = liveWSAndLiveChatEngJoin.msdyn_postconversationsurveyenable, msfp_sourcesurveyidentifier = liveWSAndLiveChatEngJoin.msfp_sourcesurveyidentifier, msfp_botsourcesurveyidentifier = liveWSAndLiveChatEngJoin.msfp_botsourcesurveyidentifier, postConversationSurveyOwnerId = liveWSAndLiveChatEngJoin.postConversationSurveyOwnerId, postConversationBotSurveyOwnerId = liveWSAndLiveChatEngJoin.postConversationBotSurveyOwnerId, msdyn_surveyprovider = liveWSAndLiveChatEngJoin.msdyn_surveyprovider;
@@ -2513,7 +2485,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             });
                             return [2 /*return*/, Promise.reject("GetPostChatSurveyContext : msfp_sourcesurveyidentifier is mandatory for survey provider ".concat(SurveyProvider_1.SurveyProvider.CustomerVoice, "."))];
                         }
-                        if (!((0, parsers_1.parseLowerCaseString)(msdyn_postconversationsurveyenable) === "true")) return [3 /*break*/, 6];
+                        if (!((0, parsers_1.parseLowerCaseString)(msdyn_postconversationsurveyenable) === "true")) return [3 /*break*/, 4];
                         return [4 /*yield*/, this.getConversationDetails()];
                     case 2:
                         liveWorkItemDetails = _o.sent();
@@ -2556,17 +2528,14 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (this.authenticatedUserToken) {
                             optionalParams.authenticatedUserToken = this.authenticatedUserToken;
                         }
-                        return [4 /*yield*/, this.OCClient.getSurveyInviteLink(postConversationSurveyOwnerId, agentSurveyInviteLinkRequest, optionalParams)];
+                        return [4 /*yield*/, Promise.all([
+                                this.OCClient.getSurveyInviteLink(postConversationSurveyOwnerId, agentSurveyInviteLinkRequest, optionalParams),
+                                (postConversationBotSurveyOwnerId && msfp_botsourcesurveyidentifier)
+                                    ? this.OCClient.getSurveyInviteLink(postConversationBotSurveyOwnerId, botSurveyInviteLinkRequest, optionalParams)
+                                    : Promise.resolve(null)
+                            ])];
                     case 3:
-                        agentSurveyInviteLinkResponse = _o.sent();
-                        _a = postConversationBotSurveyOwnerId && msfp_botsourcesurveyidentifier;
-                        if (!_a) return [3 /*break*/, 5];
-                        return [4 /*yield*/, this.OCClient.getSurveyInviteLink(postConversationBotSurveyOwnerId, botSurveyInviteLinkRequest, optionalParams)];
-                    case 4:
-                        _a = (_o.sent());
-                        _o.label = 5;
-                    case 5:
-                        botSurveyInviteLinkResponse = _a;
+                        _a = _o.sent(), agentSurveyInviteLinkResponse = _a[0], botSurveyInviteLinkResponse = _a[1];
                         agentSurveyInviteLink = void 0, agentFormsProLocale = void 0, botSurveyInviteLink = void 0, botFormsProLocale = void 0;
                         if (agentSurveyInviteLinkResponse != null) {
                             if (agentSurveyInviteLinkResponse.inviteList != null && agentSurveyInviteLinkResponse.inviteList.length == 1) {
@@ -2615,16 +2584,16 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             });
                             return [2 /*return*/, Promise.reject("surveyInviteLinkResponse is null.")];
                         }
-                        return [3 /*break*/, 7];
-                    case 6:
+                        return [3 /*break*/, 5];
+                    case 4:
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetPostChatSurveyContext, {
                             RequestId: this.requestId,
                             ChatId: (_l = this.chatToken) === null || _l === void 0 ? void 0 : _l.chatId,
                             ExceptionDetails: "Post Chat Survey is disabled. Please check the Omnichannel Administration Portal."
                         });
                         return [2 /*return*/, Promise.reject("Post Chat is disabled from admin side, or chat doesnt have a survey as part of their configuration.")];
-                    case 7: return [3 /*break*/, 9];
-                    case 8:
+                    case 5: return [3 /*break*/, 7];
+                    case 6:
                         ex_1 = _o.sent();
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetPostChatSurveyContext, {
                             ConversationId: conversationId !== null && conversationId !== void 0 ? conversationId : "",
@@ -2633,7 +2602,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                             ExceptionDetails: JSON.stringify(ex_1)
                         });
                         return [2 /*return*/, Promise.reject("Retrieving post chat context failed " + JSON.stringify(ex_1))];
-                    case 9: return [2 /*return*/];
+                    case 7: return [2 /*return*/];
                 }
             });
         });
@@ -3157,6 +3126,67 @@ var OmnichannelChatSDK = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get persistent chat history for authenticated users.
+     * @param getPersistentChatHistoryOptionalParams Optional parameters for persistent chat history retrieval.
+     */
+    OmnichannelChatSDK.prototype.getPersistentChatHistory = function () {
+        return __awaiter(this, arguments, void 0, function (getPersistentChatHistoryOptionalParams) {
+            var params, result, error_28, telemetryData;
+            var _a, _b, _c, _d, _e;
+            if (getPersistentChatHistoryOptionalParams === void 0) { getPersistentChatHistoryOptionalParams = {}; }
+            return __generator(this, function (_f) {
+                switch (_f.label) {
+                    case 0:
+                        if (!this.requestId) {
+                            this.requestId = (0, ocsdk_1.uuidv4)();
+                        }
+                        this.scenarioMarker.startScenario(TelemetryEvent_1.default.GetPersistentChatHistory, {
+                            RequestId: this.requestId
+                        });
+                        if (!this.isInitialized) {
+                            exceptionThrowers_1.default.throwUninitializedChatSDK(this.scenarioMarker, TelemetryEvent_1.default.GetPersistentChatHistory);
+                        }
+                        if (!this.isPersistentChat || ((_a = this.chatSDKConfig.persistentChat) === null || _a === void 0 ? void 0 : _a.disable) === true) {
+                            exceptionThrowers_1.default.throwNotPersistentChatEnabled(this.scenarioMarker, TelemetryEvent_1.default.GetPersistentChatHistory, {
+                                RequestId: this.requestId,
+                                ChatId: (_b = this.chatToken) === null || _b === void 0 ? void 0 : _b.chatId
+                            });
+                        }
+                        if (!this.authenticatedUserToken) {
+                            exceptionThrowers_1.default.throwChatSDKError(ChatSDKError_1.ChatSDKErrorName.AuthenticatedUserTokenNotFound, new Error('Authenticated user token not found'), this.scenarioMarker, TelemetryEvent_1.default.GetPersistentChatHistory, {
+                                RequestId: this.requestId,
+                                ChatId: (_c = this.chatToken) === null || _c === void 0 ? void 0 : _c.chatId
+                            });
+                        }
+                        _f.label = 1;
+                    case 1:
+                        _f.trys.push([1, 3, , 4]);
+                        params = {};
+                        params.pageSize = getPersistentChatHistoryOptionalParams.pageSize || undefined;
+                        params.pageToken = getPersistentChatHistoryOptionalParams.pageToken || undefined;
+                        return [4 /*yield*/, this.OCClient.getPersistentChatHistory(this.requestId, __assign(__assign({}, params), { authenticatedUserToken: this.authenticatedUserToken }))];
+                    case 2:
+                        result = _f.sent();
+                        this.scenarioMarker.completeScenario(TelemetryEvent_1.default.GetPersistentChatHistory, {
+                            RequestId: this.requestId,
+                            ChatId: (_d = this.chatToken) === null || _d === void 0 ? void 0 : _d.chatId
+                        });
+                        return [2 /*return*/, result];
+                    case 3:
+                        error_28 = _f.sent();
+                        telemetryData = {
+                            RequestId: this.requestId,
+                            ChatId: (_e = this.chatToken) === null || _e === void 0 ? void 0 : _e.chatId,
+                            ErrorMessage: (error_28 === null || error_28 === void 0 ? void 0 : error_28.message) || 'Unknown error' // Added error message for better debugging
+                        };
+                        exceptionThrowers_1.default.throwPersistentChatConversationRetrievalFailure(error_28, this.scenarioMarker, TelemetryEvent_1.default.GetPersistentChatHistory, telemetryData);
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
     return OmnichannelChatSDK;
 }());
 exports.default = OmnichannelChatSDK;