@adatechnology/conversations-ui 0.4.2 → 0.6.0

package/dist/participant/index.d.ts

@@ -0,0 +1,186 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+import { ParticipantConversationSummary, ParticipantSubjectRef, ParticipantConversationPage, 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';
+
+type ParticipantSubjectGroup = {
+    readonly subjectType: string;
+    readonly label: string;
+    readonly icon?: ReactNode;
+};
+/** Host-drawn icon for a list row; null/undefined falls back to the subject group icon. */
+type ParticipantSubjectIconRenderer = (conversation: ParticipantConversationSummary) => ReactNode;
+type ParticipantInboxSection = {
+    /** 'awaiting' | 'closed' | 'other' or the subjectType of a group. */
+    readonly key: string;
+    /** Absent for groups: the host resolves it from subjectGroups. */
+    readonly label?: string;
+    readonly conversations: readonly ParticipantConversationSummary[];
+    readonly unreadCount: number;
+};
+type ParticipantInboxFilter = {
+    readonly subjectType: string;
+    readonly label: string;
+    readonly unreadCount: number;
+};
+type ParticipantInboxView = {
+    readonly sections: readonly ParticipantInboxSection[];
+    readonly filters: readonly ParticipantInboxFilter[];
+    readonly showFilters: boolean;
+    /** The filter actually applied: 'all' when the requested one has no conversations left. */
+    readonly activeFilter: string;
+    /** The search finds conversations, but none under the active subject filter. */
+    readonly hasMatchesOutsideFilter: boolean;
+};
+type GroupParticipantConversationsParams = {
+    readonly conversations: readonly ParticipantConversationSummary[];
+    readonly subjectGroups: readonly ParticipantSubjectGroup[];
+    /** subjectType, or 'all'/undefined for everything. */
+    readonly filter?: string;
+    /** Narrows the rows only: chips and their counts always describe the whole list. */
+    readonly searchQuery?: string;
+};
+type ParticipantConversationsClassNames = {
+    readonly root: string;
+    readonly inbox: string;
+    readonly thread: string;
+};
+
+type ParticipantSendInput = {
+    readonly subject: ParticipantSubjectRef;
+    /** Generated by the package (crypto.randomUUID). The host uses it as Idempotency-Key; a resend repeats it. */
+    readonly clientMessageId: string;
+    readonly text?: string;
+    readonly files?: readonly File[];
+};
+type ParticipantSendResult = {
+    readonly outcome: 'sent';
+    readonly message: ParticipantMessage;
+} | {
+    readonly outcome: 'queued';
+};
+type ParticipantConversationEvent = {
+    readonly type: 'inbox-changed';
+} | {
+    readonly type: 'conversation-changed';
+    readonly subject: ParticipantSubjectRef;
+};
+interface ParticipantConversationsApi {
+    listConversations(params?: {
+        readonly cursor?: string;
+    }): Promise<ParticipantConversationPage>;
+    fetchMessages(subject: ParticipantSubjectRef, params?: {
+        readonly before?: string;
+        readonly limit?: number;
+    }): Promise<readonly ParticipantMessage[]>;
+    /** Throwing means failed; the package shows a retry affordance and repeats the SAME clientMessageId. */
+    sendMessage(input: ParticipantSendInput): Promise<ParticipantSendResult>;
+    /** Marks the other side's messages of THAT subject as read, never "all". */
+    markRead(subject: ParticipantSubjectRef): Promise<void>;
+    resolveAttachmentUrl(attachment: ParticipantAttachment, disposition?: 'inline' | 'attachment'): Promise<string>;
+    openConversation?(subject: ParticipantSubjectRef): Promise<ParticipantConversationSummary>;
+    subscribe?(listener: (event: ParticipantConversationEvent) => void): () => void;
+}
+type ParticipantPendingAttachment = {
+    readonly filename: string;
+    readonly mimeType: string;
+    readonly sizeBytes: number;
+};
+/** Message the host keeps in its durable queue and hands back to the package. */
+type ParticipantPendingMessage = {
+    readonly clientMessageId: string;
+    readonly subject: ParticipantSubjectRef;
+    readonly text?: string;
+    readonly attachments?: readonly ParticipantPendingAttachment[];
+    readonly createdAt: string;
+    readonly state: 'queued' | 'failed';
+};
+/** Message still living only in the memory of the screen: being sent, queued by the host and not yet reflected, sent but not yet echoed, or failed. */
+type ParticipantLocalPendingMessage = Omit<ParticipantPendingMessage, 'state'> & {
+    readonly state: 'sending' | 'queued' | 'failed' | 'sent';
+};
+
+type ParticipantConversationsLabels = {
+    readonly inboxTitle: string;
+    readonly sectionAwaiting: string;
+    readonly sectionClosed: string;
+    readonly sectionOther: string;
+    readonly filterAll: string;
+    readonly filtersGroup: string;
+    readonly emptyInbox: string;
+    /** Uses the `{count}` placeholder. */
+    readonly unreadCount: string;
+    readonly back: string;
+    readonly openSubject: string;
+    readonly me: string;
+    readonly newMessages: string;
+    readonly loadOlder: string;
+    readonly closedNotice: string;
+    readonly messageInputLabel: string;
+    readonly messageInputPlaceholder: string;
+    readonly send: string;
+    readonly attach: string;
+    readonly attachmentsList: string;
+    readonly removeAttachment: string;
+    readonly attachmentTooLarge: string;
+    readonly attachmentTypeNotAccepted: string;
+    readonly quickRepliesGroup: string;
+    readonly downloadAttachment: string;
+    readonly statusSending: string;
+    readonly statusQueued: string;
+    readonly statusSent: string;
+    readonly statusDelivered: string;
+    readonly statusRead: string;
+    readonly statusFailed: string;
+    readonly statusFailedShort: string;
+    readonly retry: string;
+    readonly discard: string;
+    readonly edit: string;
+    readonly notFound: string;
+    readonly loading: string;
+    readonly loadError: string;
+    readonly loadMore: string;
+    readonly searchLabel: string;
+    readonly searchPlaceholder: string;
+    readonly noResults: string;
+    readonly noResultsInFilter: string;
+    readonly noResultsLoadedOnly: string;
+    /** Spoken before the protocol code, e.g. "Protocol 261009-K7M2". */
+    readonly protocolPrefix: string;
+    readonly copyProtocol: string;
+    readonly protocolCopied: string;
+    readonly channelsGroup: string;
+    readonly channelApp: string;
+    readonly channelWhatsapp: string;
+    readonly channelEmail: string;
+    readonly channelPortal: string;
+    readonly channelWebchat: string;
+};
+declare const DEFAULT_PARTICIPANT_CONVERSATIONS_LABELS: ParticipantConversationsLabels;
+
+type ParticipantConversationsProps = {
+    api: ParticipantConversationsApi;
+    subjectGroups: readonly ParticipantSubjectGroup[];
+    /** undefined renders the list; defined renders that conversation. */
+    selected: ParticipantSubjectRef | undefined;
+    onSelect: (subject: ParticipantSubjectRef) => void;
+    onBack?: () => void;
+    channel?: ConversationChannel;
+    labels?: Partial<ParticipantConversationsLabels>;
+    locale?: string;
+    theme?: ConversationsTheme;
+    className?: string;
+    classNames?: Partial<ParticipantConversationsClassNames>;
+    pendingMessages?: readonly ParticipantPendingMessage[];
+    onRetryPending?: (clientMessageId: string) => void;
+    quickReplies?: readonly QuickReply[];
+    renderSubjectIcon?: ParticipantSubjectIconRenderer;
+    renderSubjectCard?: (conversation: ParticipantConversationSummary) => ReactNode;
+    onOpenSubject?: (subject: ParticipantSubjectRef) => void;
+};
+declare function ParticipantConversations(props: ParticipantConversationsProps): 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 };