@microsoft/omnichannel-chat-widget 1.8.3-main.ec1328d → 1.8.4-main.1bfa518

package/lib/types/components/citationpanestateful/interfaces/ICitationPaneStatefulProps.d.ts

@@ -0,0 +1,19 @@
+import { ICitationPaneProps } from "@microsoft/omnichannel-chat-components/lib/types/components/citationpane/interfaces/ICitationPaneProps";
+export interface ICitationPaneStatefulProps extends ICitationPaneProps {
+    /**
+     * id: Optional custom ID for the citation pane container
+     */
+    id?: string;
+    /**
+     * title: Optional title for the citation pane
+     */
+    title?: string;
+    /**
+     * onClose: Optional callback function called when the citation pane is closed
+     */
+    onClose?: () => void;
+    /**
+     * contentHtml: Optional HTML content to display in the citation pane
+     */
+    contentHtml?: string;
+}

package/lib/types/components/confirmationpanestateful/common/defaultProps/defaultConfirmationPaneLocalizedTexts.d.ts

@@ -1,2 +1,2 @@
-import { IConfirmationPaneLocalizedTexts } from "../../interfaces/IConfirmationPaneLocalizedText";
+import { IConfirmationPaneLocalizedTexts } from "../../interfaces/IConfirmationPaneLocalizedTexts";
 export declare const defaultConfirmationPaneLocalizedTexts: IConfirmationPaneLocalizedTexts;

package/lib/types/components/confirmationpanestateful/interfaces/IConfirmationPaneStatefulProps.d.ts

@@ -1,4 +1,4 @@
-import { IConfirmationPaneLocalizedTexts } from "./IConfirmationPaneLocalizedText";
+import { IConfirmationPaneLocalizedTexts } from "./IConfirmationPaneLocalizedTexts";
 import { IConfirmationPaneProps } from "@microsoft/omnichannel-chat-components/lib/types/components/confirmationpane/interfaces/IConfirmationPaneProps";
 export interface IConfirmationPaneStatefulProps extends IConfirmationPaneProps {
     /**

package/lib/types/components/livechatwidget/common/ActivitySubscriber/AddActivitySubscriber.d.ts

@@ -0,0 +1,45 @@
+import { IActivitySubscriber } from "./IActivitySubscriber";
+/**
+ * The `AddActivitySubscriber` class is responsible for subscribing to the `ADD_ACTIVITY` event
+ * from the `ChatWidgetEvents` and notifying an observer when a new activity is added.
+ *
+ * This class implements the `IActivitySubscriber` interface and acts as a bridge between
+ * the event system and the observer pattern.
+ */
+export declare class AddActivitySubscriber implements IActivitySubscriber {
+    /**
+     * The observer that will be notified when a new activity is added.
+     * This is expected to be an object with a `next` method, such as an RxJS `Observer`.
+     */
+    observer: any;
+    /**
+     * Set to track processed activity IDs to prevent duplicate processing.
+     */
+    private processedActivityIds;
+    /**
+     * Unsubscribe function for the secure event listener
+     */
+    private unsubscribeFromSecureEvent;
+    /**
+     * Subscription for PersistentConversationReset event
+     */
+    private resetEventListener;
+    /**
+     * Constructor initializes the `AddActivitySubscriber` and sets up a secure event listener
+     * for the `ChatWidgetEvents.ADD_ACTIVITY` event. When the event is triggered, it checks
+     * if the event payload contains an `activity` and notifies the observer.
+     */
+    constructor();
+    /**
+     * The `next` method is a placeholder for processing the activity.
+     * This method can be overridden or extended as needed.
+     *
+     * @param activity - The activity object to process.
+     * @returns The activity object (asynchronously).
+     */
+    next(activity: any): Promise<any>;
+    /**
+     * Reset the processed activity IDs when a conversation resets
+     */
+    reset(): void;
+}

package/lib/types/components/livechatwidget/common/ChatWidgetEvents.d.ts

@@ -0,0 +1,7 @@
+declare enum ChatWidgetEvents {
+    ADD_ACTIVITY = "CHAT_WIDGET/ADD_ACTIVITY",
+    FETCH_PERSISTENT_CHAT_HISTORY = "CHAT_WIDGET/FETCH_PERSISTENT_CHAT_HISTORY",
+    NO_MORE_HISTORY_AVAILABLE = "CHAT_WIDGET/NO_MORE_HISTORY_AVAILABLE",
+    HISTORY_LOAD_ERROR = "CHAT_WIDGET/HISTORY_LOAD_ERROR"
+}
+export default ChatWidgetEvents;

package/lib/types/components/livechatwidget/common/PersistentConversationHandler.d.ts

@@ -0,0 +1,28 @@
+import { FacadeChatSDK } from "../../../common/facades/FacadeChatSDK";
+import { IPersistentChatHistoryProps } from "../interfaces/IPersistentChatHistoryProps";
+/**
+ * Class responsible for handling persistent conversation history
+ */
+declare class PersistentConversationHandler {
+    private appliedProps;
+    private isLastPull;
+    private pageToken;
+    private facadeChatSDK;
+    private lastMessage;
+    private count;
+    private pageSize;
+    private isCurrentlyPulling;
+    private pageTokenInTransitSet;
+    constructor(facadeChatSDK: FacadeChatSDK, props: IPersistentChatHistoryProps);
+    private appliedPropsHandler;
+    private resetEventListener;
+    reset(): void;
+    destroy(): void;
+    pullHistory(): Promise<void>;
+    private processHistoryMessages;
+    private fetchHistoryMessages;
+    private shouldPull;
+    private processMessageToActivity;
+    private createDividerActivity;
+}
+export default PersistentConversationHandler;

package/lib/types/components/livechatwidget/common/defaultProps/defaultPersistentChatHistoryProps.d.ts

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

package/lib/types/components/livechatwidget/common/getMockChatSDKIfApplicable.d.ts

@@ -1 +1,2 @@
-export declare const getMockChatSDKIfApplicable: (chatSDK: any, type?: string) => any;
+import { IMockProps } from "../interfaces/IMockProps";
+export declare const getMockChatSDKIfApplicable: (chatSDK: any, mockProps?: IMockProps) => any;

package/lib/types/components/livechatwidget/common/liveChatConfigUtils.d.ts

@@ -1,4 +1,15 @@
+import { ExtendedChatConfig } from "../../webchatcontainerstateful/interfaces/IExtendedChatConffig";
 import { FacadeChatSDK } from "../../../common/facades/FacadeChatSDK";
 export declare const isPostChatSurveyEnabled: (facadeChatSDK: FacadeChatSDK) => Promise<boolean>;
 export declare const getPostChatSurveyConfig: (facadeChatSDK: FacadeChatSDK) => Promise<any>;
 export declare const isPersistentChatEnabled: (conversationMode: string | undefined) => boolean;
+/**
+ * Determines if persistent chat history should be loaded based on all required conditions.
+ *
+ * @param extendedChatConfig - The extended chat configuration object
+ * @returns true if ALL conditions are met:
+ *   1. Conversation mode must be Persistent ("192350001")
+ *   2. History is enabled in admin config (msdyn_enablepersistentchatpreviousconversations)
+ *   3. History is enabled via feature flag (lcwPersistentChatHistoryEnabled)
+ */
+export declare const shouldLoadPersistentChatHistory: (extendedChatConfig: ExtendedChatConfig | undefined) => boolean;

package/lib/types/components/livechatwidget/common/startChatErrorHandler.d.ts

@@ -4,4 +4,5 @@ import { ILiveChatWidgetAction } from "../../../contexts/common/ILiveChatWidgetA
 import { ILiveChatWidgetProps } from "../interfaces/ILiveChatWidgetProps";
 export declare const handleStartChatError: (dispatch: Dispatch<ILiveChatWidgetAction>, facadeChatSDK: FacadeChatSDK, props: ILiveChatWidgetProps | undefined, ex: any, isStartChatSuccessful: boolean) => void;
 export declare const logWidgetLoadComplete: (additionalMessage?: string) => void;
+export declare const logStartChatComplete: (additionalMessage?: string) => void;
 export declare const logWidgetLoadWithUnexpectedError: (ex: any) => void;

package/lib/types/components/livechatwidget/interfaces/ILiveChatWidgetProps.d.ts

@@ -1,7 +1,9 @@
 import ChatConfig from "@microsoft/omnichannel-chat-sdk/lib/core/ChatConfig";
+import { IAppInsightsConfig } from "../../../common/telemetry/interfaces/IAppInsightsConfig";
 import { IAudioNotificationProps } from "../../footerstateful/audionotificationstateful/interfaces/IAudioNotificationProps";
 import { ICallingContainerProps } from "@microsoft/omnichannel-chat-components/lib/types/components/callingcontainer/interfaces/ICallingContainerProps";
 import { IChatButtonProps } from "@microsoft/omnichannel-chat-components/lib/types/components/chatbutton/interfaces/IChatButtonProps";
+import { ICitationPaneStatefulProps } from "../../citationpanestateful/interfaces/ICitationPaneStatefulProps";
 import { IConfirmationPaneStatefulProps } from "../../confirmationpanestateful/interfaces/IConfirmationPaneStatefulProps";
 import { IContextDataStore } from "../../../common/interfaces/IContextDataStore";
 import { IDownloadTranscriptProps } from "../../footerstateful/downloadtranscriptstateful/interfaces/IDownloadTranscriptProps";
@@ -18,6 +20,7 @@ import { ILoadingPaneProps } from "@microsoft/omnichannel-chat-components/lib/ty
 import { IMockProps } from "./IMockProps";
 import { INotificationPaneProps } from "@microsoft/omnichannel-chat-components/lib/types/components/notificationpane/interfaces/INotificationPaneProps";
 import { IOOOHPaneProps } from "@microsoft/omnichannel-chat-components/lib/types/components/outofofficehourspane/interfaces/IOOOHPaneProps";
+import { IPersistentChatHistoryProps } from "./IPersistentChatHistoryProps";
 import { IPostChatSurveyPaneStatefulProps } from "../../postchatsurveypanestateful/interfaces/IPostChatSurveyPaneStatefulProps";
 import { IPreChatSurveyPaneProps } from "@microsoft/omnichannel-chat-components/lib/types/components/prechatsurveypane/interfaces/IPreChatSurveyPaneProps";
 import { IProactiveChatPaneStatefulProps } from "../../proactivechatpanestateful/interfaces/IProactiveChatPaneStatefulProps";
@@ -27,7 +30,6 @@ import { IStartChatErrorPaneProps } from "../../startchaterrorpanestateful/inter
 import { ITelemetryConfig } from "../../../common/telemetry/interfaces/ITelemetryConfig";
 import { IWebChatContainerStatefulProps } from "../../webchatcontainerstateful/interfaces/IWebChatContainerStatefulProps";
 import { OmnichannelChatSDK } from "@microsoft/omnichannel-chat-sdk";
-import { IAppInsightsConfig } from "../../../common/telemetry/interfaces/IAppInsightsConfig";
 export interface ILiveChatWidgetProps {
     audioNotificationProps?: IAudioNotificationProps;
     callingContainerProps?: ICallingContainerProps;
@@ -51,6 +53,7 @@ export interface ILiveChatWidgetProps {
     preChatSurveyPaneProps?: IPreChatSurveyPaneProps;
     proactiveChatPaneProps?: IProactiveChatPaneStatefulProps;
     reconnectChatPaneProps?: IReconnectChatPaneStatefulProps;
+    citationPaneProps?: ICitationPaneStatefulProps;
     startChatErrorPaneProps?: IStartChatErrorPaneProps;
     styleProps?: ILiveChatWidgetStyleProps;
     telemetryConfig: ITelemetryConfig;
@@ -67,4 +70,5 @@ export interface ILiveChatWidgetProps {
     mock?: IMockProps;
     featureConfigProps?: IFeatureConfigProps;
     appInsightsConfig?: IAppInsightsConfig;
+    persistentChatHistoryProps?: IPersistentChatHistoryProps;
 }

package/lib/types/components/livechatwidget/interfaces/IMockProps.d.ts

@@ -1,8 +1,10 @@
-declare enum LiveChatWidgetMockType {
+import { Message } from "botframework-directlinejs";
+export declare enum LiveChatWidgetMockType {
     Test = "Test",
-    Demo = "Demo"
+    Demo = "Demo",
+    Designer = "Designer"
 }
 export interface IMockProps {
     type: LiveChatWidgetMockType;
+    mockMessages?: Message[];
 }
-export {};

package/lib/types/components/livechatwidget/interfaces/IPersistentChatHistoryProps.d.ts

@@ -0,0 +1,11 @@
+import { IStyle } from "@fluentui/react";
+export interface IPersistentChatHistoryProps {
+    pageSize?: number;
+    dividerActivityStyle?: IStyle;
+    /**
+     * Accessible label announced by screen readers for the conversation divider element.
+     * If not supplied, a default provided in defaultPersistentChatHistoryProps will be used.
+     */
+    dividerActivityAriaLabel?: string;
+    bannerStyle?: IStyle;
+}

package/lib/types/components/webchatcontainerstateful/common/DesignerChatAdapter.d.ts

@@ -1,8 +1,10 @@
 import { Message } from "botframework-directlinejs";
-import { Observable } from "rxjs/Observable";
 import MockAdapter from "./mockadapter";
+import { Observable } from "rxjs/Observable";
 export declare class DesignerChatAdapter extends MockAdapter {
-    constructor();
+    messages?: Message[];
+    constructor(messages?: Message[]);
+    private processMessage;
     private postUserActivity;
     postActivity(activity: Message): Observable<string>;
 }

package/lib/types/components/webchatcontainerstateful/common/DesignerChatSDK.d.ts

@@ -1,7 +1,12 @@
 import { DesignerChatAdapter } from "./DesignerChatAdapter";
+import { Message } from "botframework-directlinejs";
 import { MockChatSDK } from "./mockchatsdk";
 export declare class DesignerChatSDK extends MockChatSDK {
     constructor();
+    /**
+     * Create a chat adapter for the designer. Uses this.mockMessages if set.
+     */
+    mockMessages?: Message[];
     createChatAdapter(): DesignerChatAdapter;
     localeId: string;
     /**

package/lib/types/components/webchatcontainerstateful/common/activities/botActivity.d.ts

@@ -0,0 +1,7 @@
+declare const botActivity: {
+    from: {
+        role: string;
+    };
+    type: string;
+};
+export default botActivity;

package/lib/types/components/webchatcontainerstateful/common/activities/conversationDividerActivity.d.ts

@@ -0,0 +1,10 @@
+declare const conversationDividerActivity: {
+    channelData: {
+        tags: string[];
+    };
+    from: {
+        role: string;
+    };
+    type: string;
+};
+export default conversationDividerActivity;

package/lib/types/components/webchatcontainerstateful/common/activityConverters/convertPersistentChatHistoryMessageToActivity.d.ts

@@ -0,0 +1,2 @@
+declare const convertPersistentChatHistoryMessageToActivity: (message: any) => any;
+export default convertPersistentChatHistoryMessageToActivity;

package/lib/types/components/webchatcontainerstateful/common/utils/chatAdapterUtils.d.ts

@@ -1,4 +1,4 @@
-import { Activity, Attachment, Message, User } from "botframework-directlinejs";
+import { Activity, Attachment, AttachmentLayout, CardAction, Message, User } from "botframework-directlinejs";
 import { Subscriber } from "rxjs/Subscriber";
 export declare const customerUser: User;
 export declare const botUser: User;
@@ -9,3 +9,8 @@ export declare const postAgentMessageActivity: (activityObserver: Subscriber<Act
 export declare const postSystemMessageActivity: (activityObserver: Subscriber<Activity> | undefined, text: string, delay?: number) => void;
 export declare const postBotTypingActivity: (activityObserver: Subscriber<Activity> | undefined, delay?: number) => void;
 export declare const postBotAttachmentActivity: (activityObserver: Subscriber<Activity> | undefined, attachments?: Attachment[], delay?: number) => void;
+export declare const postAgentAttachmentActivity: (activityObserver: Subscriber<Activity> | undefined, attachments?: Attachment[], delay?: number, attachmentLayout?: AttachmentLayout) => void;
+export declare const postAgentSuggestedActionsActivity: (activityObserver: Subscriber<Activity> | undefined, text: string, suggestedActions: {
+    actions: CardAction[];
+    to?: string[];
+}, delay?: number) => void;

package/lib/types/components/webchatcontainerstateful/common/utils/fontUtils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Utility functions for font handling and emoji support
+ */
+/**
+ * Creates a font family optimized for iOS emoji support
+ * Uses system-ui as the primary font for better emoji rendering on iOS
+ * @param primaryFont - The base font family string (optional, used as fallback)
+ * @returns Font family string optimized for iOS emoji support
+ */
+export declare const createIOSOptimizedEmojiFont: (primaryFont?: string) => string;

package/lib/types/components/webchatcontainerstateful/hooks/usePersistentChatHistory.d.ts

@@ -0,0 +1,4 @@
+import { FacadeChatSDK } from "../../../common/facades/FacadeChatSDK";
+import { IPersistentChatHistoryProps } from "../../livechatwidget/interfaces/IPersistentChatHistoryProps";
+declare const usePersistentChatHistory: (facadeChatSDK: FacadeChatSDK | undefined, props: IPersistentChatHistoryProps) => void;
+export default usePersistentChatHistory;

package/lib/types/components/webchatcontainerstateful/interfaces/ICitation.d.ts

@@ -0,0 +1,12 @@
+export interface ICitation {
+    id: string;
+    text?: string;
+    title?: string;
+    type?: string;
+    position?: number;
+    entityType?: string;
+    entityContext?: string;
+    url?: string;
+    searchSourceId?: string;
+    chunkId?: string;
+}

package/lib/types/components/webchatcontainerstateful/interfaces/IExtendedChatConffig.d.ts

@@ -0,0 +1,15 @@
+export interface ExtendedChatConfig {
+    LcwFcbConfiguration?: LcwFcbConfiguration;
+    LiveChatConfigAuthSettings?: LiveChatConfigAuthSettings;
+    LiveWSAndLiveChatEngJoin?: {
+        msdyn_conversationmode?: string;
+        msdyn_enablepersistentchatpreviousconversations?: string;
+    };
+}
+interface LcwFcbConfiguration {
+    lcwPersistentChatHistoryEnabled?: boolean;
+}
+interface LiveChatConfigAuthSettings {
+    msdyn_javascriptclientfunction?: string;
+}
+export {};

package/lib/types/components/webchatcontainerstateful/webchatcontroller/WebChatEventSubscribers.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Component to handle persistent chat history events.
+ * Uses WebChatStoreLoader instead of hooks to avoid context issues.
+ */
+declare const WebChatEventSubscribers: () => null;
+export default WebChatEventSubscribers;

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activities/Constants.d.ts

@@ -0,0 +1,3 @@
+export declare const LazyLoadActivityConstants: {
+    SCROLL_ID: string;
+};

package/lib/types/components/webchatcontainerstateful/webchatcontroller/middlewares/renderingmiddlewares/activities/ConversationDividerActivity.d.ts

@@ -0,0 +1,4 @@
+import { IPersistentChatHistoryProps } from "../../../../../livechatwidget/interfaces/IPersistentChatHistoryProps";
+import React from "react";
+declare const ConversationDividerActivity: (props: IPersistentChatHistoryProps) => React.JSX.Element;
+export default ConversationDividerActivity;