@adatechnology/conversations-ui 0.6.1 → 0.8.0

package/dist/participant/index.d.ts

@@ -1,8 +1,12 @@
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { ParticipantConversationSummary, ParticipantSubjectRef, ParticipantConversationPage, ParticipantMessage, ParticipantAttachment } from '@adatechnology/conversation-contracts';
+import { ParticipantConversationSummary, ParticipantConversationPage, ParticipantSubjectRef, ParticipantMessage, ParticipantAttachment } from '@adatechnology/conversation-contracts';
 export { ParticipantAttachment, ParticipantConversationPage, ParticipantConversationSummary, ParticipantMessage, ParticipantSubjectRef } from '@adatechnology/conversation-contracts';
-import { C as ConversationChannel, a as ConversationsTheme, Q as QuickReply } from '../quickReply.types-B4gmZsSr.js';
+import { C as ConversationChannel, d as ConversationsTheme, Q as QuickReply } from '../quickReply.types-DzWH3NYV.js';
+
+type ParticipantAuthorAvatarRenderer = (author: {
+    name: string | null;
+}) => ReactNode;
 
 type ParticipantSubjectGroup = {
     readonly subjectType: string;
@@ -116,6 +120,8 @@ type ParticipantConversationsLabels = {
     readonly me: string;
     readonly newMessages: string;
     readonly loadOlder: string;
+    /** Accessible name of the floating button that returns to the end of the conversation. */
+    readonly scrollToLatest: string;
     readonly closedNotice: string;
     readonly messageInputLabel: string;
     readonly messageInputPlaceholder: string;
@@ -156,6 +162,11 @@ type ParticipantConversationsLabels = {
     readonly channelEmail: string;
     readonly channelPortal: string;
     readonly channelWebchat: string;
+    /** Spoken after a link that opens in a new tab. */
+    readonly externalLinkHint: string;
+    /** Prefix of the accessible name of the copy buttons: "Copy 529.982.247-25". */
+    readonly copyValue: string;
+    readonly valueCopied: string;
 };
 declare const DEFAULT_PARTICIPANT_CONVERSATIONS_LABELS: ParticipantConversationsLabels;
 
@@ -178,9 +189,57 @@ type ParticipantConversationsProps = {
     renderSubjectIcon?: ParticipantSubjectIconRenderer;
     renderSubjectCard?: (conversation: ParticipantConversationSummary) => ReactNode;
     onOpenSubject?: (subject: ParticipantSubjectRef) => void;
+    /** Absent draws no avatar. The SDK has no photo: the host supplies it through renderAuthorAvatar. */
+    avatars?: 'initials';
+    /** Host slot for the author's photo; wins over 'initials' and enables avatars on its own. */
+    renderAuthorAvatar?: ParticipantAuthorAvatarRenderer;
+    /** Speech-bubble tail on the bottom corner; false removes it. Default true. */
+    tail?: boolean;
 };
 declare function ParticipantConversations(props: ParticipantConversationsProps): react.JSX.Element;
 
+/** What one conversation needs from the host: no list, no open-by-subject. `markRead` and `subscribe` are optional. */
+type ConversationThreadApi = Pick<ParticipantConversationsApi, 'fetchMessages' | 'sendMessage' | 'resolveAttachmentUrl'> & Partial<Pick<ParticipantConversationsApi, 'markRead' | 'subscribe'>>;
+
+/** Who is looking at the conversation. `participant` is the outside party; `operator` is the company. */
+type ParticipantPerspective = 'participant' | 'operator';
+
+type ConversationThreadProps = {
+    readonly api: ConversationThreadApi;
+    readonly subject: ParticipantSubjectRef;
+    /** `participant` (default) is the outside party; `operator` is the company, which owns the outbound messages. */
+    readonly perspective?: ParticipantPerspective;
+    readonly title: string;
+    readonly protocol?: string;
+    readonly channels?: ParticipantConversationSummary['channels'];
+    /** `closed` removes the composer and shows `labels.closedNotice`. */
+    readonly status?: 'open' | 'closed';
+    /** Short line under the title, written by the host (for example "Participant: Ana"). */
+    readonly counterpartLabel?: string;
+    /** Slot at the end of the header bar for the host's own actions (close, reopen...). The package knows none of them. */
+    readonly headerActions?: ReactNode;
+    /** Absent draws no back arrow. */
+    readonly onBack?: () => void;
+    readonly renderSubjectIcon?: ParticipantSubjectIconRenderer;
+    readonly subjectGroups?: readonly ParticipantSubjectGroup[];
+    /** Chips above the field: tapping one fills the text, it never sends. */
+    readonly quickReplies?: readonly QuickReply[];
+    readonly labels?: Partial<ParticipantConversationsLabels>;
+    readonly theme?: ConversationsTheme;
+    readonly className?: string;
+    readonly locale?: string;
+    readonly channel?: ConversationChannel;
+    readonly pendingMessages?: readonly ParticipantPendingMessage[];
+    readonly onRetryPending?: (clientMessageId: string) => void;
+    /** Tells the host the other side's messages were marked read, to refresh its own badges. */
+    readonly onMarkedRead?: (subject: ParticipantSubjectRef) => void;
+    readonly tail?: boolean;
+    readonly avatars?: 'initials';
+    readonly renderAuthorAvatar?: ParticipantAuthorAvatarRenderer;
+};
+/** One conversation about one subject, drawn like the participant app and seen from either side. */
+declare function ConversationThread(props: ConversationThreadProps): react.JSX.Element;
+
 declare function groupParticipantConversations(params: GroupParticipantConversationsParams): ParticipantInboxView;
 
-export { DEFAULT_PARTICIPANT_CONVERSATIONS_LABELS, type GroupParticipantConversationsParams, type ParticipantConversationEvent, ParticipantConversations, type ParticipantConversationsApi, type ParticipantConversationsClassNames, type ParticipantConversationsLabels, type ParticipantConversationsProps, type ParticipantInboxSection, type ParticipantInboxView, type ParticipantLocalPendingMessage, type ParticipantPendingMessage, type ParticipantSendInput, type ParticipantSendResult, type ParticipantSubjectGroup, type ParticipantSubjectIconRenderer, groupParticipantConversations };
+export { ConversationThread, type ConversationThreadApi, type ConversationThreadProps, DEFAULT_PARTICIPANT_CONVERSATIONS_LABELS, type GroupParticipantConversationsParams, type ParticipantAuthorAvatarRenderer, type ParticipantConversationEvent, ParticipantConversations, type ParticipantConversationsApi, type ParticipantConversationsClassNames, type ParticipantConversationsLabels, type ParticipantConversationsProps, type ParticipantInboxSection, type ParticipantInboxView, type ParticipantLocalPendingMessage, type ParticipantPendingMessage, type ParticipantPerspective, type ParticipantSendInput, type ParticipantSendResult, type ParticipantSubjectGroup, type ParticipantSubjectIconRenderer, groupParticipantConversations };