@adatechnology/conversations-ui 0.1.0-rc.2 → 0.1.0-rc.4

package/dist/preview/index.d.ts

@@ -0,0 +1,172 @@
+import { M as MessagePayload, i as ConversationSummary, h as ConversationEventSource, j as ConversationsApi, S as SSEProvider } from '../types-C0PtaO7S.js';
+import * as react from 'react';
+import { InteractiveReplyOption } from '@adatechnology/meta-whatsapp-contracts/testing';
+
+/**
+ * Estado em memória que alimenta o preview de atendimento humano. Mock de API e mock de SSE
+ * compartilham este store de propósito: se cada um tivesse dados próprios, um evento anunciaria
+ * mensagem nova e o refetch da lista devolveria o estado antigo — a inbox pareceria funcionar e
+ * estaria mentindo, que é exatamente o defeito que o preview deveria expor.
+ *
+ * Os nomes de canal e de evento espelham o servidor (`conv:<whatsappNumber>`, `global`,
+ * `message`/`message-status`/`mode-changed`/`data-changed`). Fidelidade de vocabulário é o que
+ * permite trocar mock por servidor real sem tocar na UI.
+ */
+
+declare const GLOBAL_CHANNEL = "global";
+declare function conversationChannel(conversationId: string): string;
+type PreviewEmission = {
+    readonly channel: string;
+    readonly event: string;
+    readonly payload: Record<string, unknown>;
+};
+type PreviewStoreListener = (emission: PreviewEmission) => void;
+type AppendMessageParams = {
+    readonly conversationId: string;
+    readonly content: string;
+    readonly direction: MessagePayload['direction'];
+    readonly sender: MessagePayload['sender'];
+};
+type SetModeParams = {
+    readonly conversationId: string;
+    readonly mode: ConversationSummary['mode'];
+    readonly assignedUserId?: string | undefined;
+};
+type ListConversationsFilters = {
+    readonly waitingHuman?: boolean;
+    readonly search?: string;
+};
+type PreviewStore = {
+    listConversations(filters?: ListConversationsFilters): ConversationSummary[];
+    listMessages(conversationId: string): MessagePayload[];
+    appendMessage(params: AppendMessageParams): MessagePayload;
+    setMode(params: SetModeParams): void;
+    requestHuman(conversationId: string): void;
+    markRead(conversationId: string): void;
+    subscribe(channel: string, listener: PreviewStoreListener): () => void;
+};
+type CreatePreviewStoreParams = {
+    readonly conversations: readonly ConversationSummary[];
+    readonly messages: Readonly<Record<string, readonly MessagePayload[]>>;
+    readonly now?: () => Date;
+};
+declare function createPreviewStore(params: CreatePreviewStoreParams): PreviewStore;
+
+/**
+ * `EventSource` só existe com um servidor HTTP do outro lado — é justamente o que falta quando se
+ * quer a inbox rodando com dados mockados. Este é o objeto mínimo que satisfaz
+ * `ConversationEventSource`: assina eventos nomeados, desassina e fecha.
+ *
+ * Não imita `EventSource` por completo de propósito: um fake "quase real" convida a depender de
+ * membros que o pacote não usa, e passa a quebrar a cada mudança de runtime.
+ */
+
+type MockEventSource = ConversationEventSource & {
+    emit(event: string, payload: unknown): void;
+    readonly closed: boolean;
+};
+declare function createMockEventSource(): MockEventSource;
+
+/**
+ * `ConversationsApi` servido pelo store em memória. Como o pacote é headless e recebe a API por
+ * injeção, o preview de atendimento humano não precisa de servidor, banco nem Meta: é só outra
+ * implementação deste mesmo contrato.
+ *
+ * Toda resposta é assíncrona e passa por um atraso configurável — API instantânea esconde estados
+ * de carregamento, e é neles que a inbox costuma mostrar defeito.
+ */
+
+type CreateMockConversationsApiParams = {
+    readonly store: PreviewStore;
+    readonly latencyMs?: number;
+    readonly agentName?: string;
+};
+declare function createMockConversationsApi(params: CreateMockConversationsApiParams): ConversationsApi;
+
+/**
+ * `SSEProvider` servido pelo store em memória. Mesmo mapeamento de canal do servidor
+ * (`conv:<conversationId>` e `global`), para que a UI não perceba a troca.
+ */
+
+type CreateMockSSEProviderParams = {
+    readonly store: PreviewStore;
+};
+declare function createMockSSEProvider(params: CreateMockSSEProviderParams): SSEProvider;
+
+/**
+ * Conversas de partida do preview. Cobrem o espaço de estados que a inbox precisa saber desenhar —
+ * bot em atendimento, cliente esperando humano, conversa já assumida por atendente, conversa com
+ * áudio — porque estado que não aparece em fixture é estado que ninguém testa.
+ */
+
+declare const PREVIEW_CONVERSATIONS: readonly ConversationSummary[];
+declare const PREVIEW_MESSAGES: Readonly<Record<string, readonly MessagePayload[]>>;
+
+/**
+ * Cliente que entrega mensagens do preview no webhook real, assinadas com HMAC — a mesma validação
+ * de staging e produção, sem rota alternativa e sem bypass. Do ponto de vista da API, este cliente
+ * é indistinguível da Meta; o que muda é apenas quem assina.
+ *
+ * Assina com WebCrypto porque `node:crypto` não existe no navegador. Os builders vêm dos contratos
+ * (isomórficos) justamente para que o mesmo payload seja montado nos dois runtimes.
+ *
+ * ⚠️ Isto carrega o app secret de DESENVOLVIMENTO no bundle. Só existe para o docker local, e
+ * `assertPreviewEnvironment` recusa rodar em produção — um segredo de dev vazado é irrelevante,
+ * mas o hábito de embarcar segredo em frontend não é.
+ */
+
+type PreviewWebhookClient = {
+    sendText(text: string): Promise<void>;
+    sendButtonReply(reply: InteractiveReplyOption): Promise<void>;
+    sendListReply(reply: InteractiveReplyOption): Promise<void>;
+    sendAudio(mediaId: string): Promise<void>;
+};
+type CreatePreviewWebhookClientParams = {
+    readonly webhookUrl: string;
+    readonly appSecret: string;
+    readonly from: string;
+    readonly phoneNumberId?: string;
+    readonly fetchImplementation?: typeof fetch;
+};
+declare class PreviewInProductionError extends Error {
+    constructor();
+}
+declare class PreviewWebhookRejectedError extends Error {
+    readonly status: number;
+    constructor(status: number);
+}
+/**
+ * Falha alto em vez de degradar em silêncio: um preview que "quase funciona" em produção é pior
+ * que um que se recusa a montar.
+ */
+declare function assertPreviewEnvironment(isProduction: boolean): void;
+declare function createPreviewWebhookClient(params: CreatePreviewWebhookClientParams): PreviewWebhookClient;
+
+type ConversationPreviewProps = {
+    client: PreviewWebhookClient;
+    sse: SSEProvider;
+    conversationId: string;
+    loadMessages: (conversationId: string) => Promise<MessagePayload[]>;
+    placeholder?: string;
+};
+declare function ConversationPreview({ client, sse, conversationId, loadMessages, placeholder, }: ConversationPreviewProps): react.JSX.Element;
+
+/**
+ * Roteiro que mantém o preview vivo: sem tráfego chegando, a inbox é uma tela estática e as
+ * transições que o atendente precisa testar (fila de espera enchendo, handoff, devolução ao bot)
+ * nunca acontecem.
+ *
+ * O roteiro é cíclico e determinístico — mesma ordem a cada execução. Aleatoriedade tornaria um
+ * defeito visto uma vez difícil de reencontrar.
+ */
+
+type PreviewScriptStep = (store: PreviewStore) => void;
+declare const DEFAULT_PREVIEW_SCRIPT: readonly PreviewScriptStep[];
+type StartPreviewScriptParams = {
+    readonly store: PreviewStore;
+    readonly intervalMs?: number;
+    readonly steps?: readonly PreviewScriptStep[];
+};
+declare function startPreviewScript(params: StartPreviewScriptParams): () => void;
+
+export { type AppendMessageParams, ConversationPreview, type ConversationPreviewProps, type CreateMockConversationsApiParams, type CreateMockSSEProviderParams, type CreatePreviewStoreParams, type CreatePreviewWebhookClientParams, DEFAULT_PREVIEW_SCRIPT, GLOBAL_CHANNEL, type ListConversationsFilters, type MockEventSource, PREVIEW_CONVERSATIONS, PREVIEW_MESSAGES, type PreviewEmission, PreviewInProductionError, type PreviewScriptStep, type PreviewStore, type PreviewStoreListener, type PreviewWebhookClient, PreviewWebhookRejectedError, type SetModeParams, type StartPreviewScriptParams, assertPreviewEnvironment, conversationChannel, createMockConversationsApi, createMockEventSource, createMockSSEProvider, createPreviewStore, createPreviewWebhookClient, startPreviewScript };