@microsoft/omnichannel-chat-widget 1.7.8-main.f60b0b7 → 1.8.0

package/lib/types/common/facades/FacadeChatSDK.d.ts

@@ -1,74 +1,75 @@
-import { ChatAdapter, ChatSDKMessage, GetAgentAvailabilityResponse, GetLiveChatTranscriptResponse, GetVoiceVideoCallingResponse, IFileInfo, IRawMessage, MaskingRules, OmnichannelChatSDK, VoiceVideoCallingOptionalParams } from "@microsoft/omnichannel-chat-sdk";
-import { IFacadeChatSDKInput } from "./types/IFacadeChatSDKInput";
-import ChatAdapterOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/messaging/ChatAdapterOptionalParams";
-import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
-import ChatReconnectContext from "@microsoft/omnichannel-chat-sdk/lib/core/ChatReconnectContext";
-import ChatReconnectOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/ChatReconnectOptionalParams";
-import ChatTranscriptBody from "@microsoft/omnichannel-chat-sdk/lib/core/ChatTranscriptBody";
-import EmailLiveChatTranscriptOptionaParams from "@microsoft/omnichannel-chat-sdk/lib/core/EmailLiveChatTranscriptOptionalParams";
-import EndChatOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/EndChatOptionalParams";
-import FileMetadata from "@microsoft/omnichannel-amsclient/lib/FileMetadata";
-import GetAgentAvailabilityOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetAgentAvailabilityOptionalParams";
-import GetChatTokenOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetChatTokenOptionalParams";
-import GetConversationDetailsOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetConversationDetailsOptionalParams";
-import GetLiveChatConfigOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetLiveChatConfigOptionalParams";
-import GetLiveChatTranscriptOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetLiveChatTranscriptOptionalParams";
-import IChatToken from "@microsoft/omnichannel-chat-sdk/lib/external/IC3Adapter/IChatToken";
-import IFileMetadata from "@microsoft/omnichannel-ic3core/lib/model/IFileMetadata";
-import IMessage from "@microsoft/omnichannel-ic3core/lib/model/IMessage";
-import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread";
-import InitializeOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/InitializeOptionalParams";
-import LiveWorkItemDetails from "@microsoft/omnichannel-chat-sdk/lib/core/LiveWorkItemDetails";
-import OmnichannelMessage from "@microsoft/omnichannel-chat-sdk/lib/core/messaging/OmnichannelMessage";
-import OnNewMessageOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/messaging/OnNewMessageOptionalParams";
-import { ParticipantsRemovedEvent } from "@azure/communication-signaling";
-import PostChatContext from "@microsoft/omnichannel-chat-sdk/lib/core/PostChatContext";
-import StartChatOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/StartChatOptionalParams";
-export declare class FacadeChatSDK {
-    private chatSDK;
-    private chatConfig;
-    private token;
-    private expiration;
-    private isAuthenticated;
-    private getAuthToken?;
-    private sdkMocked;
-    private disableReauthentication;
-    isSDKMocked(): boolean;
-    getChatSDK(): OmnichannelChatSDK;
-    destroy(): void;
-    isTokenSet(): boolean;
-    constructor(input: IFacadeChatSDKInput, disableReauthentication: boolean);
-    private convertExpiration;
-    private isTokenExpired;
-    private enforceBase64Encoding;
-    private extractExpFromToken;
-    private setToken;
-    private tokenRing;
-    private validateAndExecuteCall;
-    initialize(optionalParams?: InitializeOptionalParams): Promise<ChatConfig>;
-    getChatReconnectContext(optionalParams?: ChatReconnectOptionalParams): Promise<ChatReconnectContext>;
-    startChat(optionalParams?: StartChatOptionalParams): Promise<void>;
-    endChat(optionalParams?: EndChatOptionalParams): Promise<void>;
-    getCurrentLiveChatContext(): Promise<object>;
-    getConversationDetails(optionalParams?: GetConversationDetailsOptionalParams): Promise<LiveWorkItemDetails>;
-    getPreChatSurvey(parse?: boolean): Promise<any>;
-    getLiveChatConfig(optionalParams?: GetLiveChatConfigOptionalParams): Promise<ChatConfig>;
-    getChatToken(cached?: boolean, optionalParams?: GetChatTokenOptionalParams): Promise<IChatToken>;
-    getCallingToken(): Promise<string>;
-    getMessages(): Promise<IMessage[] | OmnichannelMessage[] | undefined>;
-    getDataMaskingRules(): Promise<MaskingRules>;
-    sendMessage(message: ChatSDKMessage): Promise<void | OmnichannelMessage>;
-    onNewMessage(onNewMessageCallback: CallableFunction, optionalParams?: OnNewMessageOptionalParams): Promise<void>;
-    sendTypingEvent(): Promise<void>;
-    onTypingEvent(onTypingEventCallback: CallableFunction): Promise<void>;
-    onAgentEndSession(onAgentEndSessionCallback: (message: IRawThread | ParticipantsRemovedEvent) => void): Promise<void>;
-    uploadFileAttachment(fileInfo: IFileInfo | File): Promise<IRawMessage | OmnichannelMessage>;
-    downloadFileAttachment(fileMetadata: FileMetadata | IFileMetadata): Promise<Blob>;
-    emailLiveChatTranscript(body: ChatTranscriptBody, optionalParams?: EmailLiveChatTranscriptOptionaParams): Promise<void>;
-    getLiveChatTranscript(optionalParams?: GetLiveChatTranscriptOptionalParams): Promise<GetLiveChatTranscriptResponse>;
-    createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<ChatAdapter>;
-    isVoiceVideoCallingEnabled(): Promise<boolean>;
-    getVoiceVideoCalling(params?: VoiceVideoCallingOptionalParams): Promise<GetVoiceVideoCallingResponse>;
-    getPostChatSurveyContext(): Promise<PostChatContext>;
-    getAgentAvailability(optionalParams?: GetAgentAvailabilityOptionalParams): Promise<GetAgentAvailabilityResponse>;
-}
+import { ChatAdapter, ChatSDKMessage, GetAgentAvailabilityResponse, GetLiveChatTranscriptResponse, GetVoiceVideoCallingResponse, IFileInfo, IRawMessage, MaskingRules, OmnichannelChatSDK, VoiceVideoCallingOptionalParams } from "@microsoft/omnichannel-chat-sdk";
+import { IFacadeChatSDKInput } from "./types/IFacadeChatSDKInput";
+import ChatAdapterOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/messaging/ChatAdapterOptionalParams";
+import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
+import ChatReconnectContext from "@microsoft/omnichannel-chat-sdk/lib/core/ChatReconnectContext";
+import ChatReconnectOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/ChatReconnectOptionalParams";
+import ChatTranscriptBody from "@microsoft/omnichannel-chat-sdk/lib/core/ChatTranscriptBody";
+import EmailLiveChatTranscriptOptionaParams from "@microsoft/omnichannel-chat-sdk/lib/core/EmailLiveChatTranscriptOptionalParams";
+import EndChatOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/EndChatOptionalParams";
+import FileMetadata from "@microsoft/omnichannel-amsclient/lib/FileMetadata";
+import GetAgentAvailabilityOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetAgentAvailabilityOptionalParams";
+import GetChatTokenOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetChatTokenOptionalParams";
+import GetConversationDetailsOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetConversationDetailsOptionalParams";
+import GetLiveChatConfigOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetLiveChatConfigOptionalParams";
+import GetLiveChatTranscriptOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/GetLiveChatTranscriptOptionalParams";
+import IChatToken from "@microsoft/omnichannel-chat-sdk/lib/external/IC3Adapter/IChatToken";
+import IFileMetadata from "@microsoft/omnichannel-ic3core/lib/model/IFileMetadata";
+import IMessage from "@microsoft/omnichannel-ic3core/lib/model/IMessage";
+import IRawThread from "@microsoft/omnichannel-ic3core/lib/interfaces/IRawThread";
+import InitializeOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/InitializeOptionalParams";
+import LiveWorkItemDetails from "@microsoft/omnichannel-chat-sdk/lib/core/LiveWorkItemDetails";
+import OmnichannelMessage from "@microsoft/omnichannel-chat-sdk/lib/core/messaging/OmnichannelMessage";
+import OnNewMessageOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/messaging/OnNewMessageOptionalParams";
+import { ParticipantsRemovedEvent } from "@azure/communication-signaling";
+import PostChatContext from "@microsoft/omnichannel-chat-sdk/lib/core/PostChatContext";
+import StartChatOptionalParams from "@microsoft/omnichannel-chat-sdk/lib/core/StartChatOptionalParams";
+export declare class FacadeChatSDK {
+    private chatSDK;
+    private chatConfig;
+    private token;
+    private expiration;
+    private isAuthenticated;
+    private getAuthToken?;
+    private sdkMocked;
+    private disableReauthentication;
+    isSDKMocked(): boolean;
+    getChatSDK(): OmnichannelChatSDK;
+    destroy(): void;
+    isTokenSet(): boolean;
+    constructor(input: IFacadeChatSDKInput, disableReauthentication: boolean);
+    private convertExpiration;
+    private isTokenExpired;
+    private enforceBase64Encoding;
+    private extractExpFromToken;
+    private setToken;
+    private corroborateTokenIsSet;
+    private tokenRing;
+    private validateAndExecuteCall;
+    initialize(optionalParams?: InitializeOptionalParams): Promise<ChatConfig>;
+    getChatReconnectContext(optionalParams?: ChatReconnectOptionalParams): Promise<ChatReconnectContext>;
+    startChat(optionalParams?: StartChatOptionalParams): Promise<void>;
+    endChat(optionalParams?: EndChatOptionalParams): Promise<void>;
+    getCurrentLiveChatContext(): Promise<object>;
+    getConversationDetails(optionalParams?: GetConversationDetailsOptionalParams): Promise<LiveWorkItemDetails>;
+    getPreChatSurvey(parse?: boolean): Promise<any>;
+    getLiveChatConfig(optionalParams?: GetLiveChatConfigOptionalParams): Promise<ChatConfig>;
+    getChatToken(cached?: boolean, optionalParams?: GetChatTokenOptionalParams): Promise<IChatToken>;
+    getCallingToken(): Promise<string>;
+    getMessages(): Promise<IMessage[] | OmnichannelMessage[] | undefined>;
+    getDataMaskingRules(): Promise<MaskingRules>;
+    sendMessage(message: ChatSDKMessage): Promise<void | OmnichannelMessage>;
+    onNewMessage(onNewMessageCallback: CallableFunction, optionalParams?: OnNewMessageOptionalParams): Promise<void>;
+    sendTypingEvent(): Promise<void>;
+    onTypingEvent(onTypingEventCallback: CallableFunction): Promise<void>;
+    onAgentEndSession(onAgentEndSessionCallback: (message: IRawThread | ParticipantsRemovedEvent) => void): Promise<void>;
+    uploadFileAttachment(fileInfo: IFileInfo | File): Promise<IRawMessage | OmnichannelMessage>;
+    downloadFileAttachment(fileMetadata: FileMetadata | IFileMetadata): Promise<Blob>;
+    emailLiveChatTranscript(body: ChatTranscriptBody, optionalParams?: EmailLiveChatTranscriptOptionaParams): Promise<void>;
+    getLiveChatTranscript(optionalParams?: GetLiveChatTranscriptOptionalParams): Promise<GetLiveChatTranscriptResponse>;
+    createChatAdapter(optionalParams?: ChatAdapterOptionalParams): Promise<ChatAdapter>;
+    isVoiceVideoCallingEnabled(): Promise<boolean>;
+    getVoiceVideoCalling(params?: VoiceVideoCallingOptionalParams): Promise<GetVoiceVideoCallingResponse>;
+    getPostChatSurveyContext(): Promise<PostChatContext>;
+    getAgentAvailability(optionalParams?: GetAgentAvailabilityOptionalParams): Promise<GetAgentAvailabilityResponse>;
+}

package/lib/types/common/facades/types/IFacadeChatSDKInput.d.ts

@@ -1,13 +1,13 @@
-import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
-import { OmnichannelChatSDK } from "@microsoft/omnichannel-chat-sdk";
-export interface IFacadeChatSDKInput {
-    chatSDK: OmnichannelChatSDK;
-    chatConfig: ChatConfig;
-    isAuthenticated: boolean;
-    isSDKMocked: boolean;
-    getAuthToken?: (authClientFunction?: string) => Promise<string | null>;
-}
-export interface PingResponse {
-    result: boolean;
-    message: string;
-}
+import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
+import { OmnichannelChatSDK } from "@microsoft/omnichannel-chat-sdk";
+export interface IFacadeChatSDKInput {
+    chatSDK: OmnichannelChatSDK;
+    chatConfig: ChatConfig;
+    isAuthenticated: boolean;
+    isSDKMocked: boolean;
+    getAuthToken?: (authClientFunction?: string) => Promise<string | null>;
+}
+export interface PingResponse {
+    result: boolean;
+    message: string;
+}

package/lib/types/common/interfaces/IContextDataStore.d.ts

@@ -1,14 +1,14 @@
-export interface IContextDataStore {
-    /**
-     * getData: Get data from data store
-     */
-    getData: (key: string) => any;
-    /**
-     * setData: Set data to data store
-     */
-    setData: (key: string, value: any) => void;
-    /**
-     * removeData: Remove data from data store by key
-     */
-    removeData: (key: string) => void;
-}
+export interface IContextDataStore {
+    /**
+     * getData: Get data from data store
+     */
+    getData: (key: string) => any;
+    /**
+     * setData: Set data to data store
+     */
+    setData: (key: string, value: any) => void;
+    /**
+     * removeData: Remove data from data store by key
+     */
+    removeData: (key: string) => void;
+}

package/lib/types/common/interfaces/ITimer.d.ts

@@ -1,3 +1,3 @@
-export interface ITimer {
-    readonly milliSecondsElapsed: number;
-}
+export interface ITimer {
+    readonly milliSecondsElapsed: number;
+}

package/lib/types/common/storage/default/defaultCacheManager.d.ts

@@ -1,5 +1,5 @@
-import { StorageType } from "../../Constants";
-export declare class defaultCacheManager {
-    static InternalCache: any;
-}
-export declare const registerBroadcastServiceForStorage: (widgetCacheId: string, ttlInMins: number, storageType: StorageType) => void;
+import { StorageType } from "../../Constants";
+export declare class defaultCacheManager {
+    static InternalCache: any;
+}
+export declare const registerBroadcastServiceForStorage: (widgetCacheId: string, ttlInMins: number, storageType: StorageType) => void;

package/lib/types/common/storage/default/defaultClientDataStoreProvider.d.ts

@@ -1,4 +1,4 @@
-import { IContextDataStore } from "../../interfaces/IContextDataStore";
-import { StorageType } from "../../Constants";
-export declare const isCookieAllowed: () => boolean;
-export declare const defaultClientDataStoreProvider: (cacheTtlinMins?: number, storageType?: StorageType) => IContextDataStore;
+import { IContextDataStore } from "../../interfaces/IContextDataStore";
+import { StorageType } from "../../Constants";
+export declare const isCookieAllowed: () => boolean;
+export declare const defaultClientDataStoreProvider: (cacheTtlinMins?: number, storageType?: StorageType) => IContextDataStore;

package/lib/types/common/storage/default/defaultInMemoryDataStore.d.ts

@@ -1,6 +1,6 @@
-export declare const defaultInitializeInMemoryDataStore: (widgetId: string) => void;
-export declare const inMemoryDataStore: () => {
-    getData: (key: string) => any;
-    setData: (key: any, data: any) => void;
-    removeData: (key: string) => void;
-};
+export declare const defaultInitializeInMemoryDataStore: (widgetId: string) => void;
+export declare const inMemoryDataStore: () => {
+    getData: (key: string) => any;
+    setData: (key: any, data: any) => void;
+    removeData: (key: string) => void;
+};

package/lib/types/common/telemetry/AppInsightsEvents.d.ts

@@ -0,0 +1 @@
+export declare const AppInsightsEventMapping: Record<string, string>;

package/lib/types/common/telemetry/ScenarioMarker.d.ts

@@ -0,0 +1,19 @@
+declare class ScenarioMarker {
+    /**
+   * Formats the event name for the "Started" state of a scenario.
+   */
+    static startScenario(event: string): string;
+    /**
+   * Formats the event name for the "Failed" state of a scenario.
+   */
+    static failScenario(event: string): string;
+    /**
+   * Formats the event name for the "Completed" state of a scenario.
+   */
+    static completeScenario(event: string): string;
+    /**
+   * Formats the event name for the "Warn" state of a scenario.
+   */
+    static warnScenario(event: string): string;
+}
+export default ScenarioMarker;