@microsoft/omnichannel-chat-sdk 1.10.16-main.e4f7671 → 1.10.17-main.ea234c0

package/README.md

@@ -372,7 +372,6 @@ import {DeliveryMode, MessageContentType, MessageType, PersonType} from '@micros
 
 ...
 
-const displayName = "Contoso"
 const message = "Sample message from customer";
 const messageToSend = {
     content: message

package/lib/OmnichannelChatSDK.d.ts

@@ -26,6 +26,7 @@ import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread
 import InitializeOptionalParams from "./core/InitializeOptionalParams";
 import LiveWorkItemDetails from "./core/LiveWorkItemDetails";
 import OmnichannelConfig from "./core/OmnichannelConfig";
+import OmnichannelMessage from "./core/messaging/OmnichannelMessage";
 import OnNewMessageOptionalParams from "./core/messaging/OnNewMessageOptionalParams";
 import PostChatContext from "./core/PostChatContext";
 import StartChatOptionalParams from "./core/StartChatOptionalParams";
@@ -109,7 +110,7 @@ declare class OmnichannelChatSDK {
     getMessages(): Promise<GetMessagesResponse>;
     getDataMaskingRules(): Promise<MaskingRules>;
     private transformMessage;
-    sendMessage(message: ChatSDKMessage): Promise<void>;
+    sendMessage(message: ChatSDKMessage): Promise<OmnichannelMessage | void>;
     onNewMessage(onNewMessageCallback: CallableFunction, optionalParams?: OnNewMessageOptionalParams): Promise<void>;
     sendTypingEvent(): Promise<void>;
     onTypingEvent(onTypingEventCallback: CallableFunction): Promise<void>;

package/lib/OmnichannelChatSDK.js

@@ -1497,10 +1497,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.sendMessage = function (message) {
         return __awaiter(this, void 0, void 0, function () {
-            var sendMessageRequest, error_15, messageToSend, _a;
-            var _b;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
+            var sendMessageRequest, chatMessage, error_15, exceptionDetails, messageToSend, error_16, exceptionDetails;
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         this.scenarioMarker.startScenario(TelemetryEvent_1.default.SendMessages, {
                             RequestId: this.requestId,
@@ -1521,24 +1521,29 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (message.metadata) {
                             sendMessageRequest.metadata = __assign(__assign({}, sendMessageRequest.metadata), message.metadata);
                         }
-                        _c.label = 1;
+                        _b.label = 1;
                     case 1:
-                        _c.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, ((_b = this.conversation) === null || _b === void 0 ? void 0 : _b.sendMessage(sendMessageRequest))];
+                        _b.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, ((_a = this.conversation) === null || _a === void 0 ? void 0 : _a.sendMessage(sendMessageRequest))];
                     case 2:
-                        _c.sent();
+                        chatMessage = _b.sent();
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.SendMessages, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
-                        return [3 /*break*/, 4];
+                        return [2 /*return*/, chatMessage];
                     case 3:
-                        error_15 = _c.sent();
+                        error_15 = _b.sent();
+                        exceptionDetails = {
+                            response: ChatSDKError_1.ChatSDKErrorName.ChatSDKSendMessageFailed,
+                            errorObject: "".concat(error_15)
+                        };
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.SendMessages, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId,
+                            ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
-                        throw new Error('ChatSDKSendMessageFailed');
+                        throw new Error(ChatSDKError_1.ChatSDKErrorName.ChatSDKSendMessageFailed);
                     case 4: return [3 /*break*/, 9];
                     case 5:
                         messageToSend = {
@@ -1561,24 +1566,29 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         if (message.timestamp) {
                             messageToSend.timestamp = message.timestamp;
                         }
-                        _c.label = 6;
+                        _b.label = 6;
                     case 6:
-                        _c.trys.push([6, 8, , 9]);
+                        _b.trys.push([6, 8, , 9]);
                         return [4 /*yield*/, this.conversation.sendMessage(messageToSend)];
                     case 7:
-                        _c.sent();
+                        _b.sent();
                         this.scenarioMarker.completeScenario(TelemetryEvent_1.default.SendMessages, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
                         });
                         return [3 /*break*/, 9];
                     case 8:
-                        _a = _c.sent();
+                        error_16 = _b.sent();
+                        exceptionDetails = {
+                            response: ChatSDKError_1.ChatSDKErrorName.ChatSDKSendMessageFailed,
+                            errorObject: "".concat(error_16)
+                        };
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.SendMessages, {
                             RequestId: this.requestId,
-                            ChatId: this.chatToken.chatId
+                            ChatId: this.chatToken.chatId,
+                            ExceptionDetails: JSON.stringify(exceptionDetails)
                         });
-                        throw new Error('ChatSDKSendMessageFailed');
+                        throw new Error(ChatSDKError_1.ChatSDKErrorName.ChatSDKSendMessageFailed);
                     case 9: return [2 /*return*/];
                 }
             });
@@ -1658,7 +1668,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.sendTypingEvent = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var error_16, typingPayload, members, botMembers, error_17;
+            var error_17, typingPayload, members, botMembers, error_18;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -1687,7 +1697,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [3 /*break*/, 5];
                     case 4:
-                        error_16 = _a.sent();
+                        error_17 = _a.sent();
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.SendTypingEvent, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
@@ -1715,7 +1725,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [3 /*break*/, 12];
                     case 11:
-                        error_17 = _a.sent();
+                        error_18 = _a.sent();
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.SendTypingEvent, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
@@ -1852,7 +1862,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.uploadFileAttachment = function (fileInfo) {
         return __awaiter(this, void 0, void 0, function () {
-            var amsClient, createObjectResponse, documentId, uploadDocumentResponse, fileIdsProperty, fileMetaProperty, sendMessageRequest, messageToSend, error_18, fileMetadata, messageToSend, error_19;
+            var amsClient, createObjectResponse, documentId, uploadDocumentResponse, fileIdsProperty, fileMetaProperty, sendMessageRequest, messageToSend, error_19, fileMetadata, messageToSend, error_20;
             var _a, _b;
             return __generator(this, function (_c) {
                 switch (_c.label) {
@@ -1914,7 +1924,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [2 /*return*/, messageToSend];
                     case 6:
-                        error_18 = _c.sent();
+                        error_19 = _c.sent();
                         console.error("OmnichannelChatSDK/uploadFileAttachment/sendMessage/error");
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.UploadFileAttachment, {
                             RequestId: this.requestId,
@@ -1960,8 +1970,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [2 /*return*/, messageToSend];
                     case 15:
-                        error_19 = _c.sent();
-                        console.error("OmnichannelChatSDK/uploadFileAttachment/error: ".concat(error_19));
+                        error_20 = _c.sent();
+                        console.error("OmnichannelChatSDK/uploadFileAttachment/error: ".concat(error_20));
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.UploadFileAttachment, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
@@ -1974,7 +1984,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.downloadFileAttachment = function (fileMetadata) {
         return __awaiter(this, void 0, void 0, function () {
-            var amsClient, response, view_location, viewResponse, _a, downloadedFile, error_20;
+            var amsClient, response, view_location, viewResponse, _a, downloadedFile, error_21;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0: return [4 /*yield*/, this.getAMSClient()];
@@ -2022,8 +2032,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [2 /*return*/, downloadedFile];
                     case 9:
-                        error_20 = _b.sent();
-                        console.error("OmnichannelChatSDK/downloadFileAttachment/error: ".concat(error_20));
+                        error_21 = _b.sent();
+                        console.error("OmnichannelChatSDK/downloadFileAttachment/error: ".concat(error_21));
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.DownloadFileAttachment, {
                             RequestId: this.requestId,
                             ChatId: this.chatToken.chatId
@@ -2036,7 +2046,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.emailLiveChatTranscript = function (body_1) {
         return __awaiter(this, arguments, void 0, function (body, optionalParams) {
-            var emailTranscriptOptionalParams, requestId, chatToken, chatId, sessionId, emailRequestBody, error_21;
+            var emailTranscriptOptionalParams, requestId, chatToken, chatId, sessionId, emailRequestBody, error_22;
             var _a;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_b) {
@@ -2087,8 +2097,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [3 /*break*/, 4];
                     case 3:
-                        error_21 = _b.sent();
-                        console.error("OmnichannelChatSDK/emailLiveChatTranscript/error: ".concat(error_21));
+                        error_22 = _b.sent();
+                        console.error("OmnichannelChatSDK/emailLiveChatTranscript/error: ".concat(error_22));
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.EmailLiveChatTranscript, {
                             RequestId: requestId,
                             ChatId: chatId
@@ -2101,7 +2111,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.getLiveChatTranscript = function () {
         return __awaiter(this, arguments, void 0, function (optionalParams) {
-            var getChatTranscriptOptionalParams, requestId, chatToken, chatId, sessionId, transcriptResponse, error_22, telemetryData;
+            var getChatTranscriptOptionalParams, requestId, chatToken, chatId, sessionId, transcriptResponse, error_23, telemetryData;
             var _a, _b;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_c) {
@@ -2152,12 +2162,12 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [2 /*return*/, transcriptResponse];
                     case 3:
-                        error_22 = _c.sent();
+                        error_23 = _c.sent();
                         telemetryData = {
                             RequestId: requestId,
                             ChatId: chatId
                         };
-                        exceptionThrowers_1.default.throwLiveChatTranscriptRetrievalFailure(error_22, this.scenarioMarker, TelemetryEvent_1.default.GetLiveChatTranscript, telemetryData);
+                        exceptionThrowers_1.default.throwLiveChatTranscriptRetrievalFailure(error_23, this.scenarioMarker, TelemetryEvent_1.default.GetLiveChatTranscript, telemetryData);
                         return [3 /*break*/, 4];
                     case 4: return [2 /*return*/];
                 }
@@ -2673,7 +2683,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.getChatConfig = function () {
         return __awaiter(this, arguments, void 0, function (optionalParams) {
-            var sendCacheHeaders, bypassCache, liveChatConfig, error_23, _a;
+            var sendCacheHeaders, bypassCache, liveChatConfig, error_24, _a;
             var _b, _c;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_d) {
@@ -2693,8 +2703,8 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         this.debug && console.log("[OmnichannelChatSDK][getChatConfig][liveChatVersion] ".concat(this.liveChatVersion));
                         return [2 /*return*/, this.liveChatConfig];
                     case 3:
-                        error_23 = _d.sent();
-                        if (!(0, internalUtils_1.isCoreServicesOrgUrlDNSError)(error_23, this.coreServicesOrgUrl, this.dynamicsLocationCode)) return [3 /*break*/, 6];
+                        error_24 = _d.sent();
+                        if (!(0, internalUtils_1.isCoreServicesOrgUrlDNSError)(error_24, this.coreServicesOrgUrl, this.dynamicsLocationCode)) return [3 /*break*/, 6];
                         this.omnichannelConfig.orgUrl = this.unqServicesOrgUrl;
                         _a = this;
                         return [4 /*yield*/, ocsdk_1.SDKProvider.getSDK(this.omnichannelConfig, (0, createOcSDKConfiguration_1.default)(false), this.ocSdkLogger)];
@@ -2706,10 +2716,10 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         return [3 /*break*/, 7];
                     case 6:
                         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        if (((_c = (_b = error_23.response) === null || _b === void 0 ? void 0 : _b.headers) === null || _c === void 0 ? void 0 : _c.errorcode) && parseInt(error_23.response.headers.errorcode) === OmnichannelErrorCodes_1.default.WidgetNotFound) {
+                        if (((_c = (_b = error_24.response) === null || _b === void 0 ? void 0 : _b.headers) === null || _c === void 0 ? void 0 : _c.errorcode) && parseInt(error_24.response.headers.errorcode) === OmnichannelErrorCodes_1.default.WidgetNotFound) {
                             console.warn("No widget with the given app id is present in the system.");
                         }
-                        throw error_23; // Bubble up error by default to throw ChatConfigRetrievalFailure
+                        throw error_24; // Bubble up error by default to throw ChatConfigRetrievalFailure
                     case 7: return [3 /*break*/, 8];
                     case 8: return [2 /*return*/, this.liveChatConfig];
                 }
@@ -2743,7 +2753,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.updateChatToken = function (newToken, newRegionGTMS) {
         return __awaiter(this, void 0, void 0, function () {
-            var sessionInfo, error_24, exceptionDetails;
+            var sessionInfo, error_25, exceptionDetails;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -2771,7 +2781,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         });
                         return [3 /*break*/, 5];
                     case 4:
-                        error_24 = _a.sent();
+                        error_25 = _a.sent();
                         exceptionDetails = {
                             response: "UpdateChatTokenFailed"
                         };
@@ -2788,7 +2798,7 @@ var OmnichannelChatSDK = /** @class */ (function () {
     };
     OmnichannelChatSDK.prototype.setAuthTokenProvider = function (provider_1) {
         return __awaiter(this, arguments, void 0, function (provider, optionalParams) {
-            var token, exceptionDetails, error_25, exceptionDetails, exceptionDetails;
+            var token, exceptionDetails, error_26, exceptionDetails, exceptionDetails;
             if (optionalParams === void 0) { optionalParams = {}; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
@@ -2820,12 +2830,12 @@ var OmnichannelChatSDK = /** @class */ (function () {
                         }
                         return [3 /*break*/, 4];
                     case 3:
-                        error_25 = _a.sent();
+                        error_26 = _a.sent();
                         exceptionDetails = {
                             response: ChatSDKError_1.ChatSDKErrorName.GetAuthTokenFailed
                         };
-                        if (error_25.message == ChatSDKError_1.ChatSDKErrorName.UndefinedAuthToken) {
-                            exceptionDetails.response = error_25.message;
+                        if (error_26.message == ChatSDKError_1.ChatSDKErrorName.UndefinedAuthToken) {
+                            exceptionDetails.response = error_26.message;
                         }
                         this.scenarioMarker.failScenario(TelemetryEvent_1.default.GetAuthToken, {
                             ExceptionDetails: JSON.stringify(exceptionDetails)