botframework-webchat-core 4.17.1 → 4.18.1-hotfix.20260127.b53acdf

package/dist/botframework-webchat-core.d.mts

@@ -1,33 +1,26 @@
+export { PromiseWithResolvers, withResolvers } from 'botframework-webchat-base/utils';
 import { Store } from 'redux';
 
-const CLEAR_SUGGESTED_ACTIONS = 'WEB_CHAT/CLEAR_SUGGESTED_ACTIONS';
-
-function clearSuggestedActions() {
-  return {
-    type: CLEAR_SUGGESTED_ACTIONS
-  };
-}
-
-const CONNECT = 'DIRECT_LINE/CONNECT';
+declare function clearSuggestedActions(): {
+    type: "WEB_CHAT/CLEAR_SUGGESTED_ACTIONS";
+};
 
-function connect({ directLine, userID, username }) {
-  return {
-    type: CONNECT,
+declare function connect({ directLine, userID, username }: {
+    directLine: any;
+    userID: any;
+    username: any;
+}): {
+    type: string;
     payload: {
-      directLine,
-      userID,
-      username
-    }
-  };
-}
-
-const DISCONNECT = 'DIRECT_LINE/DISCONNECT';
+        directLine: any;
+        userID: any;
+        username: any;
+    };
+};
 
-function disconnect() {
-  return {
-    type: DISCONNECT
-  };
-}
+declare function disconnect(): {
+    type: string;
+};
 
 declare const DISMISS_NOTIFICATION = "WEB_CHAT/DISMISS_NOTIFICATION";
 type DismissNotificationAction = {
@@ -38,13 +31,9 @@ type DismissNotificationAction = {
 };
 declare function dismissNotification(id: string): DismissNotificationAction;
 
-const EMIT_TYPING_INDICATOR = 'WEB_CHAT/EMIT_TYPING_INDICATOR';
-
-function emitTypingIndicator() {
-  return {
-    type: EMIT_TYPING_INDICATOR
-  };
-}
+declare function emitTypingIndicator(): {
+    type: string;
+};
 
 type MarkActivityActionType = 'WEB_CHAT/MARK_ACTIVITY';
 type MarkActivityAction = {
@@ -189,6 +178,20 @@ type ChannelData<SendStatus extends SupportedSendStatus | undefined, Type extend
     attachmentSizes?: number[];
     clientActivityID?: string;
     'webchat:sequence-id': number;
+    webChat?: {
+        /**
+         * Time when the activity appear in chat history.
+         *
+         * Note: if the activity is updated, this value will also be updated.
+         */
+        receivedAt?: number;
+        /**
+         * Per-activity style options.
+         *
+         * New in 4.18.0.
+         */
+        styleOptions?: Record<string, boolean | number | null | string>;
+    };
 } & (SendStatus extends SupportedSendStatus ? {
     /**
      * @deprecated Since 4.15.3: Please use `channelData['webchat:send-status']` or `useSendStatusByActivityKey()` hook instead.
@@ -208,7 +211,7 @@ type ChannelData<SendStatus extends SupportedSendStatus | undefined, Type extend
      * For further details, please see [#4362](https://github.com/microsoft/BotFramework-WebChat/pull/4362).
      */
     'webchat:send-status': SendStatus;
-} : {}) & (Type extends 'message' ? {
+} : Record<any, any>) & (Type extends 'message' ? {
     messageBack?: {
         displayText: string;
     };
@@ -216,7 +219,11 @@ type ChannelData<SendStatus extends SupportedSendStatus | undefined, Type extend
     speak?: boolean;
     speechSynthesisUtterance?: SpeechSynthesisUtterance;
     'webchat:fallback-text'?: string;
-} : {})>;
+    feedbackLoop?: {
+        type: 'default';
+        disclaimer?: string;
+    };
+} : Record<any, any>)>;
 type ClientCapabilitiesEntity = {
     requiresBotState?: boolean;
     supportsListening?: boolean;
@@ -239,6 +246,11 @@ type EventActivityEssence = {
 type MessageActivityEssence = {
     attachmentLayout?: 'carousel' | 'stacked';
     attachments?: DirectLineAttachment[];
+    channelData: {
+        streamId?: string;
+        streamSequence?: number;
+        streamType?: 'final';
+    };
     inputHint?: 'accepting' | 'expecting' | 'ignoring';
     locale?: string;
     speak?: string;
@@ -249,6 +261,19 @@ type MessageActivityEssence = {
     value?: any;
 };
 type TypingActivityEssence = {
+    attachmentLayout?: 'carousel' | 'stacked';
+    attachments?: DirectLineAttachment[];
+    text?: undefined;
+    type: 'typing';
+} | {
+    attachmentLayout?: 'carousel' | 'stacked';
+    attachments?: DirectLineAttachment[];
+    channelData: {
+        streamId?: string | undefined;
+        streamSequence: number;
+        streamType: 'informative' | 'streaming' | 'final';
+    };
+    text?: string | undefined;
     type: 'typing';
 };
 type TimestampFromServerEssence = {
@@ -292,14 +317,13 @@ type PostActivityAction = {
 };
 declare function postActivity(activity: WebChatActivity, method?: string): PostActivityAction;
 
-const SEND_EVENT = 'WEB_CHAT/SEND_EVENT';
-
-function sendEvent(name, value) {
-  return {
-    type: SEND_EVENT,
-    payload: { name, value }
-  };
-}
+declare function sendEvent(name: any, value: any): {
+    type: string;
+    payload: {
+        name: any;
+        value: any;
+    };
+};
 
 declare function sendFiles(files: readonly Readonly<{
     name: string;
@@ -339,50 +363,42 @@ declare function sendMessage(text: string | undefined, method: string | undefine
     };
 };
 
-const SEND_MESSAGE_BACK = 'WEB_CHAT/SEND_MESSAGE_BACK';
-
-function sendMessageback(value, text, displayText) {
-  return {
-    type: SEND_MESSAGE_BACK,
-    payload: { displayText, text, value }
-  };
-}
-
-const SEND_POST_BACK = 'WEB_CHAT/SEND_POST_BACK';
-
-function sendPostback(value) {
-  return {
-    type: SEND_POST_BACK,
-    payload: { value }
-  };
-}
-
-const SET_DICTATE_INTERIMS = 'WEB_CHAT/SET_DICTATE_INTERIMS';
-
-function setDictateInterims(dictateInterims) {
-  return {
-    type: SET_DICTATE_INTERIMS,
-    payload: { dictateInterims }
-  };
-}
+declare function sendMessageback(value: any, text: any, displayText: any): {
+    type: string;
+    payload: {
+        displayText: any;
+        text: any;
+        value: any;
+    };
+};
 
-const SET_DICTATE_STATE = 'WEB_CHAT/SET_DICTATE_STATE';
+declare function sendPostback(value: any): {
+    type: string;
+    payload: {
+        value: any;
+    };
+};
 
-function setDictateState(dictateState) {
-  return {
-    type: SET_DICTATE_STATE,
-    payload: { dictateState }
-  };
-}
+declare function setDictateInterims(dictateInterims: any): {
+    type: string;
+    payload: {
+        dictateInterims: any;
+    };
+};
 
-const SET_LANGUAGE = 'WEB_CHAT/SET_LANGUAGE';
+declare function setDictateState(dictateState: any): {
+    type: string;
+    payload: {
+        dictateState: any;
+    };
+};
 
-function setLanguage(language) {
-  return {
-    type: SET_LANGUAGE,
-    payload: { language }
-  };
-}
+declare function setLanguage(language: any): {
+    type: string;
+    payload: {
+        language: any;
+    };
+};
 
 type Notification = {
     alt: string;
@@ -400,14 +416,12 @@ type SetNotificationAction = {
 };
 declare function setNotification({ alt, data, id, level, message }: Omit<Notification, 'timestamp'>): SetNotificationAction;
 
-const SET_SEND_BOX = 'WEB_CHAT/SET_SEND_BOX';
-
-function setSendBox(text) {
-  return {
-    type: SET_SEND_BOX,
-    payload: { text }
-  };
-}
+declare function setSendBox(text: any): {
+    type: string;
+    payload: {
+        text: any;
+    };
+};
 
 declare function setSendBoxAttachments(attachments: readonly SendBoxAttachment[]): {
     type: string;
@@ -419,14 +433,12 @@ declare function setSendBoxAttachments(attachments: readonly SendBoxAttachment[]
     };
 };
 
-const SET_SEND_TIMEOUT = 'WEB_CHAT/SET_SEND_TIMEOUT';
-
-function setSendTimeout(sendTimeout) {
-  return {
-    type: SET_SEND_TIMEOUT,
-    payload: { sendTimeout }
-  };
-}
+declare function setSendTimeout(sendTimeout: any): {
+    type: string;
+    payload: {
+        sendTimeout: any;
+    };
+};
 
 declare const SET_SEND_TYPING_INDICATOR = "WEB_CHAT/SET_SEND_TYPING_INDICATOR";
 type SetSendTypingIndicatorAction = {
@@ -437,42 +449,31 @@ type SetSendTypingIndicatorAction = {
 };
 declare function setSendTypingIndicator(value: any): SetSendTypingIndicatorAction;
 
-const START_DICTATE = 'WEB_CHAT/START_DICTATE';
-
-function startDictate() {
-  return { type: START_DICTATE };
-}
-
-const START_SPEAKING_ACTIVITY = 'WEB_CHAT/START_SPEAKING';
-
-function startSpeakingActivity() {
-  return {
-    type: START_SPEAKING_ACTIVITY
-  };
-}
-
-const STOP_DICTATE = 'WEB_CHAT/STOP_DICTATE';
-
-function stopDictate() {
-  return { type: STOP_DICTATE };
-}
+declare function startDictate(): {
+    type: string;
+};
 
-const STOP_SPEAKING_ACTIVITY = 'WEB_CHAT/STOP_SPEAKING';
+declare function startSpeakingActivity(): {
+    type: string;
+};
 
-function stopSpeakingActivity() {
-  return {
-    type: STOP_SPEAKING_ACTIVITY
-  };
-}
+declare function stopDictate(): {
+    type: string;
+};
 
-const SUBMIT_SEND_BOX = 'WEB_CHAT/SUBMIT_SEND_BOX';
+declare function stopSpeakingActivity(): {
+    type: string;
+};
 
-function submitSendBox(method = 'keyboard', { channelData } = {}) {
-  return {
-    type: SUBMIT_SEND_BOX,
-    payload: { channelData, method }
-  };
-}
+declare function submitSendBox(method?: string, { channelData }?: {
+    channelData: any;
+}): {
+    type: string;
+    payload: {
+        channelData: any;
+        method: string;
+    };
+};
 
 type GlobalScopeClock = {
     cancelAnimationFrame?: typeof cancelAnimationFrame;
@@ -619,7 +620,7 @@ type Action = Thing & {
      *
      * @see https://schema.org/actionStatus
      */
-    actionStatus?: 'ActiveActionStatus' | 'CompletedActionStatu' | 'FailedActionStatus' | 'PotentialActionStatus' | undefined;
+    actionStatus?: 'ActiveActionStatus' | 'CompletedActionStatus' | 'FailedActionStatus' | 'PotentialActionStatus' | undefined;
     /**
      * The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller. Supersedes [carrier](https://schema.org/carrier).
      *
@@ -671,13 +672,17 @@ type CreativeWork = Thing & {
      *
      * @see https://schema.org/author
      */
-    author?: string | undefined;
+    author?: Person | string | undefined;
     /**
      * A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
      *
      * @see https://schema.org/citation
      */
     citation?: readonly CreativeWork[] | undefined;
+    /**
+     * The schema.org [isBasedOn](https://schema.org/isBasedOn) property provides a resource from which this work is derived or from which it is a modification or adaptation.
+     */
+    isBasedOn?: CreativeWork | undefined;
     /**
      * Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property.
      *
@@ -703,6 +708,12 @@ type CreativeWork = Thing & {
      */
     usageInfo?: CreativeWork | undefined;
 };
+type Person = {
+    '@type': 'Person';
+    description?: string | undefined;
+    image?: string | undefined;
+    name?: string | undefined;
+};
 declare const parseCreativeWork: (data: unknown) => CreativeWork;
 
 /**
@@ -755,7 +766,31 @@ type VoteAction = Action & {
 };
 declare const parseVoteAction: (data: unknown) => VoteAction;
 
-declare function getOrgSchemaMessage(graph: readonly WebChatActivity['entities'][0][]): CreativeWork | undefined;
+/**
+ * Gets the livestreaming metadata of the activity, or `undefined` if the activity is not participating in a livestreaming session.
+ *
+ * - `sessionId` - ID of the livestreaming session
+ * - `sequenceNumber` - sequence number of the activity
+ * - `type`
+ *   - `"contentless"` - ongoing but no content, should show indicator
+ *   - `"interim activity"` - current response, could be partial-from-start, or complete response.
+ *     More activities are expected. Future interim activities always replace past interim activities, enable erasing or backtracking response.
+ *   - `"informative message"` - optional side-channel informative message describing the current response, e.g. "Searching your document library".
+ *     Always replace past informative messages. May interleave with interim activities.
+ *   - `"final activity"` - complete-and-final response, always replace past interim activities and remove all informative messages.
+ *     This activity indicates end of the session, all future activities must be ignored.
+ *   - `undefined` - not part of a livestream session or the activity is not valid
+ *
+ * @returns {object} Livestreaming metadata of the activity, or `undefined` if the activity is not participating in a livestreaming session.
+ */
+declare function getActivityLivestreamingMetadata(activity: WebChatActivity): Readonly<{
+    sessionId: string;
+    sequenceNumber: number;
+    type: 'contentless' | 'final activity' | 'informative message' | 'interim activity';
+}> | undefined;
+
+type EntityType = NonNullable<WebChatActivity['entities']>[number];
+declare function getOrgSchemaMessage(graph: readonly EntityType[]): CreativeWork | undefined;
 
 declare function isForbiddenPropertyName(propertyName: string): boolean;
 
@@ -766,7 +801,7 @@ declare function singleToArray<T>(singleOrArray: T | T[]): T[];
 
 declare function warnOnce(message: string): () => void;
 
-type DirectLineActivity = Exclude<any, [] | boolean | Function | number | string>;
+type DirectLineActivity = Exclude<any, [] | boolean | ((...args: unknown[]) => unknown) | number | string>;
 
 type DirectLineMediaCardEssence = {
     aspect?: '4:3' | '16:9';
@@ -921,4 +956,4 @@ declare const buildInfo: {
     version: string;
 };
 
-export { Constants, type DirectLineActivity, type DirectLineAnimationCard, type DirectLineAttachment, type DirectLineAudioCard, type DirectLineCardAction, type DirectLineHeroCard, type DirectLineJSBotConnection, type DirectLineOAuthCard, type DirectLineReceiptCard, type DirectLineSignInCard, type DirectLineSuggestedAction, type DirectLineThumbnailCard, type DirectLineVideoCard, type GlobalScopePonyfill, Observable, type OneOrMany, type Action as OrgSchemaAction, type Claim as OrgSchemaClaim, type CreativeWork as OrgSchemaCreativeWork, type DefinedTerm as OrgSchemaDefinedTerm, type Project as OrgSchemaProject, type Thing as OrgSchemaThing, type SendBoxAttachment, type WebChatActivity, buildInfo, clearSuggestedActions, connect, createStore, withDevTools as createStoreWithDevTools, withOptions as createStoreWithOptions, disconnect, dismissNotification, emitTypingIndicator, getOrgSchemaMessage, isForbiddenPropertyName, markActivity, moduleFormat, onErrorResumeNext, parseAction, parseClaim, parseCreativeWork, parseDefinedTerm, parseProject, parseThing, parseVoteAction, postActivity, sendEvent, sendFiles, sendMessage, sendMessageback as sendMessageBack, sendPostback as sendPostBack, setDictateInterims, setDictateState, setLanguage, setNotification, setSendBox, setSendBoxAttachments, setSendTimeout, setSendTypingIndicator, singleToArray, startDictate, startSpeakingActivity, stopDictate, stopSpeakingActivity, submitSendBox, version, warnOnce };
+export { Constants, type DirectLineActivity, type DirectLineAnimationCard, type DirectLineAttachment, type DirectLineAudioCard, type DirectLineCardAction, type DirectLineHeroCard, type DirectLineJSBotConnection, type DirectLineOAuthCard, type DirectLineReceiptCard, type DirectLineSignInCard, type DirectLineSuggestedAction, type DirectLineThumbnailCard, type DirectLineVideoCard, type GlobalScopePonyfill, Observable, type OneOrMany, type Action as OrgSchemaAction, type Claim as OrgSchemaClaim, type CreativeWork as OrgSchemaCreativeWork, type DefinedTerm as OrgSchemaDefinedTerm, type Project as OrgSchemaProject, type Thing as OrgSchemaThing, type SendBoxAttachment, type WebChatActivity, buildInfo, clearSuggestedActions, connect, createStore, withDevTools as createStoreWithDevTools, withOptions as createStoreWithOptions, disconnect, dismissNotification, emitTypingIndicator, getActivityLivestreamingMetadata, getOrgSchemaMessage, isForbiddenPropertyName, markActivity, moduleFormat, onErrorResumeNext, parseAction, parseClaim, parseCreativeWork, parseDefinedTerm, parseProject, parseThing, parseVoteAction, postActivity, sendEvent, sendFiles, sendMessage, sendMessageback as sendMessageBack, sendPostback as sendPostBack, setDictateInterims, setDictateState, setLanguage, setNotification, setSendBox, setSendBoxAttachments, setSendTimeout, setSendTypingIndicator, singleToArray, startDictate, startSpeakingActivity, stopDictate, stopSpeakingActivity, submitSendBox, version, warnOnce };