@microsoft/omnichannel-chat-widget 0.1.0-main.1a61ea0

package/lib/esm/controller/componentController.js

@@ -0,0 +1,43 @@
+import { ConversationState } from "../contexts/common/ConversationState";
+export const shouldShowChatButton = state => {
+  return state.appStates.isMinimized || state.appStates.conversationState === ConversationState.Closed;
+};
+export const shouldShowProactiveChatPane = state => {
+  return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.ProactiveChat;
+};
+export const shouldShowHeader = state => {
+  return !state.appStates.isMinimized && state.appStates.conversationState !== ConversationState.Closed && state.appStates.conversationState !== ConversationState.ProactiveChat;
+};
+export const shouldShowFooter = state => {
+  return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.Active;
+};
+export const shouldShowEmailTranscriptPane = state => {
+  return state.uiStates.showEmailTranscriptPane;
+};
+export const shouldShowWebChatContainer = state => {
+  return state.appStates.conversationState === ConversationState.Active;
+};
+export const shouldShowLoadingPane = state => {
+  return !state.appStates.isMinimized && !state.appStates.shouldShowPostChat && state.appStates.conversationState === ConversationState.Loading;
+};
+export const shouldShowReconnectChatPane = state => {
+  return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.ReconnectChat;
+};
+export const shouldShowPostChatLoadingPane = state => {
+  return !state.appStates.isMinimized && state.appStates.shouldShowPostChat && state.appStates.conversationState === ConversationState.Loading;
+};
+export const shouldShowOutOfOfficeHoursPane = state => {
+  return !state.appStates.isMinimized && state.appStates.conversationState === ConversationState.OutOfOffice;
+};
+export const shouldShowPreChatSurveyPane = state => {
+  return state.appStates.conversationState === ConversationState.Prechat;
+};
+export const shouldShowConfirmationPane = state => {
+  return state.uiStates.showConfirmationPane;
+};
+export const shouldShowPostChatSurveyPane = state => {
+  return state.appStates.conversationState === ConversationState.Postchat;
+};
+export const shouldShowCallingContainer = state => {
+  return state.appStates.conversationState === ConversationState.Active && state.appStates.e2vvEnabled;
+};

package/lib/esm/hooks/useChatAdapterStore.js

@@ -0,0 +1,15 @@
+import { ChatAdapterStore } from "../contexts/ChatAdapterStore";
+import { useContext } from "react";
+
+const useChatAdapterStore = () => {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const adapter = useContext(ChatAdapterStore);
+
+  if (!adapter) {
+    throw new Error("This hook can only be used on component that is descendants of <ChatAdapterStore.Provider>");
+  }
+
+  return adapter;
+};
+
+export default useChatAdapterStore;

package/lib/esm/hooks/useChatContextStore.js

@@ -0,0 +1,14 @@
+import { useContext } from "react";
+import { ChatContextStore } from "../contexts/ChatContextStore";
+
+const useChatContextStore = () => {
+  const context = useContext(ChatContextStore);
+
+  if (!context) {
+    throw new Error("This hook can only be used on component that is descendants of <ChatContextStore.Provider>");
+  }
+
+  return context;
+};
+
+export default useChatContextStore;

package/lib/esm/hooks/useChatSDKStore.js

@@ -0,0 +1,14 @@
+import { ChatSDKStore } from "../contexts/ChatSDKStore";
+import { useContext } from "react";
+
+const useChatSDKStore = () => {
+  const sdk = useContext(ChatSDKStore);
+
+  if (!sdk) {
+    throw new Error("This hook is not called on component that is descendants of <ChatSDKStore.Provider>, or ChatSDK is not passed into LiveChatWidget component.");
+  }
+
+  return sdk;
+};
+
+export default useChatSDKStore;

package/lib/esm/index.js

@@ -0,0 +1,5 @@
+import { BroadcastService, decodeComponentString, encodeComponentString } from "@microsoft/omnichannel-chat-components";
+import useChatContextStore from "./hooks/useChatContextStore";
+import useChatSDKStore from "./hooks/useChatSDKStore";
+export { default as LiveChatWidget } from "./components/livechatwidget/LiveChatWidget";
+export { encodeComponentString, decodeComponentString, BroadcastService, useChatSDKStore, useChatContextStore };

package/lib/types/common/Constants.d.ts

@@ -0,0 +1,148 @@
+export declare class Constants {
+    static readonly systemMessageTag = "system";
+    static readonly userMessageTag = "user";
+    static readonly agentEndConversationMessageTag = "agentendconversation";
+    static readonly receivedMessageClassName = "ms_lcw_webchat_received_message";
+    static readonly sentMessageClassName = "ms_lcw_webchat_sent_message";
+    static readonly webchatChannelId = "webchat";
+    static readonly markdown = "markdown";
+    static readonly actionType = "actionType";
+    static readonly String = "string";
+    static readonly ChatMessagesJson = "chatMessagesJson";
+    static readonly truePascal = "True";
+    static readonly true = "true";
+    static readonly false = "false";
+    static readonly maximumUnreadMessageCount = 99;
+    static readonly channelIdKey = "ChannelId-";
+    static readonly ChannelId = "lcw";
+    static readonly CustomerTag = "FromCustomer";
+    static readonly GifContentType = "image/gif";
+    static readonly video = "video";
+    static readonly audio = "audio";
+    static readonly controlsList = "controlsList";
+    static readonly nodownload = "nodownload";
+    static readonly activity = "activity";
+    static readonly payload = "payload";
+    static readonly text = "text";
+    static readonly blank = "_blank";
+    static readonly visitorIdPrefix = "8:";
+    static readonly left = "left";
+    static readonly queuePositionMessageTag = "queueposition";
+    static readonly averageWaitTimeMessageTag = "averagewaittime";
+    static readonly message = "message";
+    static readonly supportedAdaptiveCardContentTypes: Array<string>;
+    static readonly maxUploadFileSize = "500000";
+    static readonly imageRegex: RegExp;
+    static readonly audioMediaRegex: RegExp;
+    static readonly videoMediaRegex: RegExp;
+    static readonly chromeSupportedInlineMediaRegex: RegExp;
+    static readonly firefoxSupportedInlineMediaRegex: RegExp;
+    static readonly CallAdded = "callAdded";
+    static readonly LocalVideoStreamAdded = "localVideoStreamAdded";
+    static readonly LocalVideoStreamRemoved = "localVideoStreamRemoved";
+    static readonly RemoteVideoStreamAdded = "remoteVideoStreamAdded";
+    static readonly RemoteVideoStreamRemoved = "remoteVideoStreamRemoved";
+    static readonly CallDisconnected = "callDisconnected";
+    static readonly IncomingCallEnded = "incomingCallEnded";
+    static readonly VoiceVideoInitialize = "voiceVideoInitialize";
+    static readonly VoiceVideoInitializeException = "voiceVideoInitializeOnException";
+    static readonly VoiceVideoLoading = "voiceVideoLoading";
+    static readonly VoiceVideoNotLoaded = "voiceVideoNotLoaded";
+    static readonly VoiceVideoLoadingException = "voiceVideoLoadingOnException";
+    static readonly VoiceVideoAcceptCallException = "voiceVideoAcceptCallOnException";
+    static readonly VoiceVideoAcceptCallWithVideoException = "voiceVideoAcceptCallWithVideoException";
+    static readonly defaultDownloadTranscriptError = "Download transcript failed.";
+    static readonly ProactiveChatInviteTimeoutInMs = 60000;
+    static readonly InputSubmit = "InputSubmit";
+    static readonly ReconnectIdAttributeName = "oc.reconnectid";
+    static readonly redirectPageRequest = "redirectPageRequest";
+    static readonly LiveChatWidget = "LiveChatWidgetNew";
+    static readonly GuidPattern = "xx-x-4m-ym-xxx";
+    static readonly Default = "default";
+    static readonly Zero = "zero";
+    static readonly Title = "title";
+    static readonly Target = "target";
+    static readonly Blank = "_blank";
+    static readonly TargetRelationship = "rel";
+    static readonly TargetRelationshipAttributes = "noopener noreferrer";
+    static readonly OpenLinkIconCssClass = "webchat__markdown__external-link-icon";
+    static readonly internetConnectionTestUrl = "https://ocsdk-prod.azureedge.net/public/connecttest.txt";
+    static readonly internetConnectionTestUrlText = "Omnichannel Connect Test";
+}
+export declare const Regex: {
+    new (): {};
+    readonly EmailRegex: "(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-zA-Z0-9-]*[a-zA-Z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])";
+};
+export declare class HtmlIdNames {
+    static readonly MSLiveChatWidget = "MSLiveChatWidget";
+}
+export declare class HtmlClassNames {
+    static readonly webChatBannerCloseButton = "webchat__toast__dismissButton";
+    static readonly webChatBannerExpandButton = "webchat__toaster__expandIcon";
+}
+export declare class HtmlElementSelectors {
+    static readonly sendBoxSelector = "textarea[data-id=\"webchat-sendbox-input\"]";
+}
+export declare class HtmlAttributeNames {
+    static readonly role = "role";
+    static readonly navigation = "navigation";
+    static readonly ariaLabel = "aria-label";
+    static readonly ariaLive = "aria-live";
+    static readonly ariaDisabled = "aria-disabled";
+    static readonly form = "form";
+    static readonly ariaLabelledby = "aria-labelledby";
+    static readonly tabindex = "tabindex";
+    static readonly ariaRequired = "aria-required";
+    static readonly ariaDesribedby = "aria-describedby";
+    static readonly ariaHidden = "aria-hidden";
+    static readonly disabled = "disabled";
+    static readonly hidden = "hidden";
+    static readonly download = "download";
+    static readonly href = "href";
+    static readonly region = "region";
+    static readonly button = "button";
+    static readonly input = "Input";
+    static readonly style = "style";
+    static readonly head = "head";
+    static readonly type = "type";
+    static readonly csstext = "text/css";
+    static readonly listItem = "LI";
+    static readonly unorderedList = "UL";
+    static readonly div = "div";
+    static readonly aTagName = "a";
+    static readonly noopenerTag = "noopener";
+    static readonly noreferrerTag = "noreferrer";
+    static readonly adaptiveCardClassName = "ac-adaptiveCard";
+    static readonly adaptiveCardTextBlockClassName = "ac-textBlock";
+    static readonly adaptiveCardToggleInputClassName = "ac-toggleInput";
+}
+export declare class WebChatMiddlewareConstants {
+    static readonly nextVisibleActivity = "nextVisibleActivity";
+    static readonly timeBetweenTimestampGroups = 300000;
+    static readonly maxTextLength = 6000;
+    static readonly adaptiveCard = "AdaptiveCard";
+}
+export declare class MimeTypes {
+    static readonly UnknownFileType = "application/octet-stream";
+}
+export declare class LocaleConstants {
+    static readonly RTL_LOCALES: string[];
+}
+export declare enum ElementType {
+    CallingContainerSDK = "CallingContainerSDK"
+}
+export declare enum ChatSDKError {
+    WidgetUseOutsideOperatingHour = "WidgetUseOutsideOperatingHour"
+}
+export declare class TranscriptConstants {
+    static readonly ChatTranscriptsBodyColor = "#F5F5F5";
+    static readonly TranscriptMessageEmojiMessageType = "http://schema.skype.com/emoji";
+    static readonly ChatTranscriptDownloadFile = "ChatTranscripts.html";
+    static readonly DefaultFileAttachmentName = "Untitled.txt";
+    static readonly CustomerDialogColor = "#E8E8E8";
+    static readonly CustomerFontColor = "black";
+    static readonly AdaptiveCardType = "adaptivecard";
+    static readonly InternalMode = "internal";
+    static readonly AgentDialogColor = "#2266E3";
+    static readonly AgentFontColor = "white";
+}

package/lib/types/common/KeyCodes.d.ts

@@ -0,0 +1,5 @@
+export declare const KeyCodes: {
+    new (): {};
+    readonly ENTER: "Enter";
+    readonly TAB: "Tab";
+};

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

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

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

@@ -0,0 +1,118 @@
+import { TelemetryData } from "./definitions/Payload";
+export declare enum ScenarioType {
+    CONFIG_VALIDATION = "LCW_ConfigValidationEvents",
+    LOAD = "LCW_LoadEvents",
+    ACTIONS = "LCW_ActionEvents",
+    SDK = "LCW_SDKEvents",
+    IC3_CLIENT = "LCW_IC3ClientEvents",
+    OCCHATSDK = "LCW_OCCHATSDKEvents",
+    WEBCHAT = "LCW_WebChatEvents",
+    CALLING = "LCW_Calling",
+    UNDEFINED = "LCW_Undefined",
+    ACS_ADAPTER = "LCW_ACSAdapterEvents"
+}
+export declare enum LogLevel {
+    INFO = "INFO",
+    DEBUG = "DEBUG",
+    WARN = "WARN",
+    ERROR = "ERROR"
+}
+export declare enum TelemetryEvent {
+    CallAdded = "CallAdded",
+    LocalVideoStreamAdded = "LocalVideoStreamAdded",
+    LocalVideoStreamRemoved = "LocalVideoStreamRemoved",
+    RemoteVideoStreamAdded = "RemoteVideoStreamAdded",
+    RemoteVideoStreamRemoved = "RemoteVideoStreamRemoved",
+    CallDisconnected = "CallDisconnected",
+    CallDisconnectedException = "CallDisconnectedException",
+    IncomingCallEnded = "incomingCallEnded",
+    VoiceVideoInitialize = "VoiceVideoInitialize",
+    VoiceVideoInitializeException = "VoiceVideoInitializeException",
+    VoiceVideoLoading = "VoiceVideoLoading",
+    VoiceVideoNotLoaded = "VoiceVideoNotLoaded",
+    VoiceVideoLoadingException = "VoiceVideoLoadingException",
+    VoiceVideoAcceptCallException = "VoiceVideoAcceptCallException",
+    VoiceVideoAcceptCallWithVideoException = "VoiceVideoAcceptCallWithVideoException",
+    VideoCallAcceptButtonClick = "VideoCallAcceptButtonClick",
+    VoiceCallAcceptButtonClick = "VoiceCallAcceptButtonClick",
+    CallRejectClick = "CallRejectClick",
+    CallRejectClickException = "CallRejectClickException",
+    ToggleMuteButtonClick = "ToggleMuteButtonClick",
+    ToggleMuteButtonClickException = "ToggleMuteButtonClickException",
+    ToggleCameraButtonClick = "ToggleCameraButtonClick",
+    ToggleCameraButtonClickException = "ToggleCameraButtonClickException",
+    EndCallButtonClick = "EndCallButtonClick",
+    EndCallButtonClickException = "EndCallButtonClickException",
+    CallingSDKInitSuccess = "CallingSDKInitSuccess",
+    CallingSDKInitFailed = "CallingSDKInitFailed",
+    CallingSDKLoadSuccess = "CallingSDKLoadSuccess",
+    CallingSDKLoadFailed = "CallingSDKLoadFailed",
+    GetConversationDetailsCallFailed = "GetConversationDetailsCallFailed",
+    EndChatSDKCallFailed = "EndChatSDKCallFailed",
+    GetChatReconnectContextSDKCallFailed = "GetChatReconnectContextSDKCallFailed",
+    PostChatContextCallSucceed = "PostChatContextCallSucceed",
+    PostChatContextCallFailed = "PostChatContextCallFailed",
+    ParseAdaptiveCardFailed = "ParseAdaptiveCardFailed",
+    WebChatLoaded = "WebChatLoaded",
+    LCWChatButtonClicked = "LCWChatButtonClicked",
+    LCWChatButtonShow = "LCWChatButtonShow",
+    WidgetLoadComplete = "WidgetLoadComplete",
+    WidgetLoadFailed = "WidgetLoadFailed",
+    StartChatMethodException = "StartChatMethodException",
+    CloseChatMethodException = "CloseChatMethodException",
+    PrechatSurveyLoaded = "PrechatSurveyLoaded",
+    PrechatSubmitted = "PrechatSubmitted",
+    StartChatSDKCall = "StartChatCall",
+    EndChatSDKCall = "EndChatCall",
+    OnNewMessageFailed = "OnNewMessageFailed",
+    OnNewMessageAudioNotificationFailed = "OnNewMessageAudioNotificationFailed",
+    DownloadTranscriptResponseNullOrUndefined = "DownloadTranscriptResponseNullOrUndefined",
+    EmailTranscriptSent = "EmailTranscriptSent",
+    EmailTranscriptFailed = "EmailTranscriptFailed",
+    DownloadTranscriptFailed = "DownloadTranscriptFailed",
+    StartChatFailed = "StartChatFailed",
+    IC3ThreadUpdateEventReceived = "IC3ThreadUpdateEventReceived",
+    ConfirmationCancelButtonClicked = "ConfirmationCancelButtonClicked",
+    ConfirmationConfirmButtonClicked = "ConfirmationConfirmButtonClicked",
+    LoadingPaneLoaded = "LoadingPaneLoaded",
+    EmailTranscriptLoaded = "EmailTranscriptLoaded",
+    OutOfOfficePaneLoaded = "OutOfOfficePaneLoaded",
+    PostChatSurveyLoaded = "PostChatSurveyLoaded",
+    ConfirmationPaneLoaded = "ConfirmationPaneLoaded",
+    ProactiveChatPaneLoaded = "ProactiveChatPaneLoaded",
+    ReconnectChatPaneLoaded = "ReconnectChatPaneLoaded",
+    HeaderCloseButtonClicked = "HeaderCloseButtonClicked",
+    HeaderMinimizeButtonClicked = "HeaderMinimizeButtonClicked",
+    DownloadTranscriptButtonClicked = "DownloadTranscriptButtonClicked",
+    EmailTranscriptButtonClicked = "EmailTranscriptButtonClicked",
+    EmailTranscriptCancelButtonClicked = "EmailTranscriptCancelButtonClicked",
+    AudioToggleButtonClicked = "AudioToggleButtonClicked",
+    ProcessingHTMLTextMiddlewareFailed = "ProcessingHTMLTextMiddlewareFailed",
+    ProcessingSanitizationMiddlewareFailed = "ProcessingSanitizationMiddlewareFailed",
+    FormatTagsMiddlewareJSONStringifyFailed = "FormatTagsMiddlewareJSONStringifyFailed",
+    QueuePositionMessageRecieved = "QueuePositionMessageRecieved",
+    AverageWaitTimeMessageRecieved = "AverageWaitTimeMessageRecieved",
+    DataMaskingRuleApplied = "DataMaskingRuleApplied",
+    IC3ClientEvent = "IC3ClientEvent",
+    ConversationEndedThreadEventReceived = "ConversationEndedThreadEventReceived",
+    InvalidConfiguration = "InvalidConfiguration",
+    SendTypingIndicatorSucceeded = "SendTypingIndicatorSucceeded",
+    SendTypingIndicatorFailed = "SendTypingIndicatorFailed",
+    PreChatSurveyStartChatMethodFailed = "PreChatSurveyStartChatMethodFailed",
+    StartProactiveChatMethodFailed = "StartProactiveChatMethodFailed",
+    ProactiveChatAccepted = "ProactiveChatAccepted",
+    ProactiveChatRejected = "ProactiveChatRejected",
+    IncomingProactiveChatScreenLoaded = "IncomingProactiveChatScreenLoaded",
+    ProactiveChatClosed = "ProactiveChatClosed",
+    ReconnectChatContinueConversation = "ReconnectChatContinueConversation",
+    ReconnectChatStartNewConversation = "ReconnectChatStartNewConversation",
+    ReconnectChatMinimize = "ReconnectChatMinimize"
+}
+export interface TelemetryInput {
+    scenarioType: ScenarioType;
+    payload: TelemetryData;
+}
+export declare class TelemetryConstants {
+    private static map;
+    static mapEventToScenario(eventTypeOrScenarioType: TelemetryEvent): ScenarioType;
+}

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

@@ -0,0 +1,38 @@
+import { LogLevel, TelemetryEvent, TelemetryInput } from "./TelemetryConstants";
+import { BaseContract, TelemetryContract } from "./definitions/Contracts";
+import { TelemetryData } from "./definitions/Payload";
+import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
+import LiveChatContext from "@microsoft/omnichannel-chat-sdk/lib/core/LiveChatContext";
+import LiveWorkItemDetails from "@microsoft/omnichannel-chat-sdk/lib/core/LiveWorkItemDetails";
+import { IInternalTelemetryData } from "./interfaces/IInternalTelemetryData";
+import { ITelemetryConfig } from "./interfaces/ITelemetryConfig";
+export interface TelemetryEventWrapper {
+    Event: TelemetryEvent;
+    Description?: string;
+    ExceptionDetails?: any;
+    ElapsedTimeInMilliseconds?: number;
+}
+export declare class TelemetryHelper {
+    static callId: string;
+    static elapsedTime: string;
+    static buildTelemetryEvent(level: LogLevel, input: TelemetryInput): TelemetryContract;
+    static populateBasicProperties(level: LogLevel, telemetryData: TelemetryData): BaseContract;
+    private static populate;
+    private static conformToActionsContract;
+    private static conformToWebChatContract;
+    private static conformToConfigValidationContract;
+    private static conformToLoadContract;
+    private static conformToIC3ClientContract;
+    private static conformToACSAdapterContract;
+    private static conformToCallingContract;
+    private static conformToOCChatSDKContract;
+    static addChatConfigDataToTelemetry(chatConfig: ChatConfig, telemetryInternalData: IInternalTelemetryData): IInternalTelemetryData;
+    static addWidgetDataToTelemetry(telemetryConfig: ITelemetryConfig, telemetryInternalData: IInternalTelemetryData): IInternalTelemetryData;
+    static addSessionDataToTelemetry(chatSession: LiveChatContext, telemetryInternalData: IInternalTelemetryData): IInternalTelemetryData;
+    static addConversationDataToTelemetry(liveWorkItem: LiveWorkItemDetails, telemetryInternalData: IInternalTelemetryData): IInternalTelemetryData;
+    static logCallingEvent: (logLevel: LogLevel, payload: TelemetryEventWrapper, callId?: string | undefined) => void;
+    static logLoadingEvent: (logLevel: LogLevel, payload: TelemetryEventWrapper) => void;
+    static logActionEvent: (logLevel: LogLevel, payload: TelemetryEventWrapper) => void;
+    static logSDKEvent: (logLevel: LogLevel, payload: TelemetryEventWrapper) => void;
+    static logConfigDataEvent: (logLevel: LogLevel, payload: TelemetryEventWrapper) => void;
+}

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

@@ -0,0 +1,11 @@
+import { IInternalTelemetryData } from "./interfaces/IInternalTelemetryData";
+import { ITimer } from "../interfaces/ITimer";
+export declare class TelemetryTimers {
+    static LcwLoadToChatButtonTimer: ITimer;
+    static ProactiveChatScreenTimer: ITimer;
+    static WidgetLoadTimer: ITimer;
+}
+export declare class TelemetryManager {
+    static InternalTelemetryData: IInternalTelemetryData;
+}
+export declare const RegisterLoggers: () => void;

package/lib/types/common/telemetry/defaultConfigs/defaultAriaConfig.d.ts

@@ -0,0 +1,2 @@
+import { IAriaConfigurations } from "../interfaces/IAriaConfigurations";
+export declare const defaultAriaConfig: IAriaConfigurations;

package/lib/types/common/telemetry/defaultConfigs/defaultTelemetryConfiguration.d.ts

@@ -0,0 +1,2 @@
+import { ITelemetryConfig } from "../interfaces/ITelemetryConfig";
+export declare const defaultTelemetryConfiguration: ITelemetryConfig;

package/lib/types/common/telemetry/defaultConfigs/defaultTelemetryInternalData.d.ts

@@ -0,0 +1,2 @@
+import { IInternalTelemetryData } from "../interfaces/IInternalTelemetryData";
+export declare const defaultInternalTelemetryData: IInternalTelemetryData;

package/lib/types/common/telemetry/definitions/Contracts.d.ts

@@ -0,0 +1,70 @@
+export interface BaseContract {
+    WidgetId: string;
+    ChatId: string;
+    ChannelId: string;
+    ConversationId: string;
+    ElapsedTimeInMilliseconds?: number;
+    OrganizationId: string;
+    LCWRuntimeId: string;
+    CurrentRequestId: string;
+    ExceptionDetails?: string;
+    LogLevel: string;
+}
+export interface ConfigValidationContract extends BaseContract {
+    Event?: string;
+    RequestId?: string;
+    LCWVersion?: string;
+    CloudType?: string;
+    Domain?: string;
+    Language?: string;
+}
+export interface LoadContract extends BaseContract {
+    Event?: string;
+    ResourcePath?: string;
+    WidgetState?: string;
+    ChatState?: string;
+    ChatType?: string;
+}
+export interface ActionsContract extends BaseContract {
+    Event?: string;
+    ActionType?: string;
+}
+export interface IC3ClientContract extends BaseContract {
+    Event?: string;
+    IC3ClientVersion?: string;
+    SubscriptionId?: string;
+    EndpointUrl?: string;
+    EndpointId?: string;
+    ErrorCode?: string;
+    ShouldBubbleToHost?: boolean;
+    Description?: string;
+}
+export interface OCChatSDKContract extends BaseContract {
+    RequestId: string;
+    Event?: string;
+    OCChatSDKVersion: string;
+    TransactionId: string;
+}
+export interface WebChatContract extends BaseContract {
+    Event?: string;
+    EventInfo?: string;
+    Dimensions?: object;
+    Data?: object;
+    Duration?: number;
+}
+export interface CallingContract extends BaseContract {
+    CallId?: string;
+    Event?: string;
+    Description?: string;
+}
+export interface ACSAdapterContract extends BaseContract {
+    Description?: string;
+    ACSUserId?: string;
+    ChatThreadId?: string;
+    ChatMessageId?: string;
+    TimeStamp?: string;
+    Event?: string;
+    ErrorCode?: string;
+    ExceptionDetails?: any;
+}
+export declare type TelemetryContract = OCChatSDKContract | IC3ClientContract | ActionsContract | LoadContract | WebChatContract | ConfigValidationContract | CallingContract | ACSAdapterContract | BaseContract | any;

package/lib/types/common/telemetry/definitions/Payload.d.ts

@@ -0,0 +1,77 @@
+export interface ConfigValidationTelemetryData {
+    Event?: string;
+    RequestId?: string;
+    LCWVersion?: string;
+    Language?: string;
+    ElapsedTimeInMilliseconds?: number;
+    CloudType?: string;
+    ExceptionDetails?: object;
+    Domain?: string;
+}
+export interface LoadTelemetryData {
+    Event?: string;
+    ResourcePath?: string;
+    ElapsedTimeInMilliseconds?: number;
+    WidgetState?: string;
+    ChatState?: string;
+    ChatType?: string;
+    ExceptionDetails?: object;
+}
+export interface MessageProcessingErrorData {
+    Event: string;
+    ExceptionDetails: object;
+}
+export interface OCChatSDKTelemetryData {
+    RequestId: string;
+    Event?: string;
+    ElapsedTimeInMilliseconds?: number;
+    TransactionId: string;
+    ExceptionDetails?: object;
+}
+export interface IC3ClientTelemetryData {
+    SubscriptionId?: string;
+    EndpointUrl?: string;
+    EndpointId?: string;
+    Event?: string;
+    ElapsedTimeInMilliseconds?: number;
+    ErrorCode?: string;
+    ExceptionDetails?: object;
+    ShouldBubbleToHost?: boolean;
+    Description?: string;
+}
+export interface WebChatTelemetryData {
+    data?: any;
+    dimensions?: any;
+    duration?: number;
+    error?: any;
+    fatal?: boolean;
+    level?: string;
+    Event?: string;
+    name?: string;
+    type?: string;
+}
+export interface ACSAdapterTelemetryData {
+    Description?: string;
+    ACSUserId?: string;
+    ChatThreadId?: string;
+    ChatMessageId?: string;
+    TimeStamp?: string;
+    Event?: string;
+    ErrorCode?: string;
+    ExceptionDetails?: any;
+}
+export interface ActionTelemetryData {
+    Event?: string;
+    ElapsedTimeInMilliseconds?: number;
+    ActionType?: string;
+    ExceptionDetails?: object;
+    Description?: string;
+}
+export interface CallingTelemetryData {
+    CallId?: string;
+    Event?: string;
+    ElapsedTimeInMilliseconds?: number;
+    ExceptionDetails?: object;
+    Description?: string;
+}
+export declare type TelemetryData = ConfigValidationTelemetryData | OCChatSDKTelemetryData | IC3ClientTelemetryData | LoadTelemetryData | ActionTelemetryData | WebChatTelemetryData | CallingTelemetryData | MessageProcessingErrorData;

package/lib/types/common/telemetry/interfaces/IAriaConfigurations.d.ts

@@ -0,0 +1,18 @@
+export interface IAriaConfigurations {
+    /**
+    * Collection uri key for telemetry. Indicates which endpoint to use to post telemetry data
+    */
+    collectorUriForTelemetry?: string;
+    /**
+    * Telemetry key to use for logging
+    */
+    ariaTelemetryKey?: string;
+    /**
+    * Telemetry application name
+    */
+    ariaTelemetryApplicationName?: string;
+    /**
+    * Disable cookie usage
+    */
+    disableCookieUsage?: boolean;
+}

package/lib/types/common/telemetry/interfaces/IChatSDKLogger.d.ts

@@ -0,0 +1,4 @@
+import { LogLevel, TelemetryInput } from "../TelemetryConstants";
+export interface IChatSDKLogger {
+    log: (logLevel: LogLevel, telemetryInput: TelemetryInput) => void;
+}

package/lib/types/common/telemetry/interfaces/IInternalTelemetryData.d.ts

@@ -0,0 +1,19 @@
+import { IAriaConfigurations } from "./IAriaConfigurations";
+import { ITelemetryConfig } from "./ITelemetryConfig";
+export interface IInternalTelemetryData {
+    telemetryConfig?: ITelemetryConfig;
+    ariaConfig?: IAriaConfigurations;
+    widgetId?: string;
+    chatId?: string;
+    conversationId?: string;
+    currentRequestId?: string;
+    OCChatSDKVersion?: string;
+    IC3ClientVersion?: string;
+    hostName?: string;
+    environmentVersion?: string;
+    chatWidgetLocaleLCID?: string;
+    orgId?: string;
+    orgUrl?: string;
+    lcwRuntimeId?: string;
+    channelId?: string;
+}