@microsoft/omnichannel-chat-sdk - npm Package Compare versions

Comparing version 1.10.3-main.3e21b51 to 1.10.3-main.fdb5a09

lib/OmnichannelChatSDK.d.ts

 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 { ParticipantsRemovedEvent } from '@azure/communication-signaling';
@@ -23,11 +25,8 @@ import ChatAdapterOptionalParams from "./core/messaging/ChatAdapterOptionalParams";
 import IFileMetadata from "@microsoft/omnichannel-ic3core/lib/model/IFileMetadata";
-import IMessage from "@microsoft/omnichannel-ic3core/lib/model/IMessage";
-import IRawMessage from "@microsoft/omnichannel-ic3core/lib/model/IRawMessage";
 import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread";
 import InitializeOptionalParams from "./core/InitializeOptionalParams";
-import LiveChatContext from "./core/LiveChatContext";
 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";
@@ -74,2 +73,4 @@ declare class OmnichannelChatSDK {
     private AMSClientLoadCurrentState;
+    private isMaskingDisabled;
+    private maskingCharacter;
     constructor(omnichannelConfig: OmnichannelConfig, chatSDKConfig?: ChatSDKConfig);
@@ -97,3 +98,3 @@ setDebug(flag: boolean): void;
     endChat(endChatOptionalParams?: EndChatOptionalParams): Promise<void>;
-    getCurrentLiveChatContext(): Promise<LiveChatContext | {}>;
+    getCurrentLiveChatContext(): Promise<GetCurrentLiveChatContextResponse>;
     getConversationDetails(optionalParams?: GetConversationDetailsOptionalParams): Promise<LiveWorkItemDetails>;
@@ -104,8 +105,9 @@ /**
      */
-    getPreChatSurvey(parse?: boolean): Promise<any>;
+    getPreChatSurvey(parse?: boolean): Promise<GetPreChatSurveyResponse>;
     getLiveChatConfig(optionalParams?: GetLiveChatConfigOptionalParams): Promise<ChatConfig>;
     getChatToken(cached?: boolean, optionalParams?: GetChatTokenOptionalParams): Promise<IChatToken>;
     getCallingToken(): Promise<string>;
-    getMessages(): Promise<IMessage[] | OmnichannelMessage[] | undefined>;
-    getDataMaskingRules(): Promise<any>;
+    getMessages(): Promise<GetMessagesResponse>;
+    getDataMaskingRules(): Promise<MaskingRules>;
+    private transformMessage;
     sendMessage(message: ChatSDKMessage): Promise<void>;
@@ -116,14 +118,22 @@ onNewMessage(onNewMessageCallback: CallableFunction, optionalParams?: OnNewMessageOptionalParams | unknown): Promise<void>;
     onAgentEndSession(onAgentEndSessionCallback: (message: IRawThread | ParticipantsRemovedEvent) => void): Promise<void>;
-    uploadFileAttachment(fileInfo: IFileInfo | File): Promise<IRawMessage | OmnichannelMessage>;
+    uploadFileAttachment(fileInfo: IFileInfo | File): Promise<UploadFileAttachmentResponse>;
     downloadFileAttachment(fileMetadata: FileMetadata | IFileMetadata): Promise<Blob>;
-    emailLiveChatTranscript(body: ChatTranscriptBody, optionalParams?: EmailLiveChatTranscriptOptionaParams): Promise<any>;
-    getLiveChatTranscript(optionalParams?: GetLiveChatTranscriptOptionalParams): Promise<any>;
-    createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<unknown>;
+    emailLiveChatTranscript(body: ChatTranscriptBody, optionalParams?: EmailLiveChatTranscriptOptionaParams): Promise<void>;
+    getLiveChatTranscript(optionalParams?: GetLiveChatTranscriptOptionalParams): Promise<GetLiveChatTranscriptResponse>;
+    createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<ChatAdapter>;
     isVoiceVideoCallingEnabled(): boolean;
-    getVoiceVideoCalling(params?: any): Promise<any>;
-    getPostChatSurveyContext(): Promise<any>;
-    getAgentAvailability(optionalParams?: GetAgentAvailabilityOptionalParams): Promise<any>;
+    getVoiceVideoCalling(voiceVideoCallingOptionalParams?: VoiceVideoCallingOptionalParams): Promise<GetVoiceVideoCallingResponse>;
+    getPostChatSurveyContext(): Promise<PostChatContext>;
+    getAgentAvailability(optionalParams?: GetAgentAvailabilityOptionalParams): Promise<GetAgentAvailabilityResponse>;
     private populateInitChatOptionalParam;
     private getIC3Client;
+    private setPrechatConfigurations;
+    private setDataMaskingConfiguration;
+    private setAuthSettingConfig;
+    private setPersistentChatConfiguration;
+    private setLocaleIdConfiguration;
+    private setCallingOptionConfiguration;
+    private setLiveChatVersionConfiguration;
     private getChatConfig;
+    private buildConfigurations;
     private resolveIC3ClientUrl;
@@ -130,0 +140,0 @@ private resolveChatAdapterUrl;

package.json

 {
   "name": "@microsoft/omnichannel-chat-sdk",
-  "version": "1.10.3-main.3e21b51",
+  "version": "1.10.3-main.fdb5a09",
   "description": "Microsoft Omnichannel Chat SDK",
@@ -5,0 +5,0 @@ "files": [

README.md

@@ -266,6 +266,9 @@ # Omnichannel Chat SDK 💬
 `Option 1`
+
 ```ts
 const preChatSurvey = await getPreChatSurvey(); // Adaptive Cards JSON payload data
 ```
+
 `Option 2`
+
 ```ts
@@ -295,7 +298,20 @@ const parseToJSON = false;
 It gets the active data masking rules from Live Chat Config.
+Returned type is defined as :
 
 ```ts
-const dataMaskingRules = await chatSDK.getDataMaskingRules();
+
+type MaskingRule = {
+ id: string;
+ regex: string;
+}
+
+type MaskingRules = {
+ rules: MaskingRule[];
+}
 ```
 
+```ts
+const dataMaskingRules : MaskingRules = await chatSDK.getDataMaskingRules();
+```
+
 ### Get Chat Reconnect Context
@@ -302,0 +318,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1069905

increased by0.54%

Lines of code

15015

increased by0.65%

Number of lines in readme file

996

increased by1.63%

No dependency changes