@adatechnology/conversations-ui 0.1.0-rc.5 → 0.1.0-rc.7

package/dist/preview/index.d.ts

@@ -1,6 +1,6 @@
-import { M as MessagePayload, k as ConversationSummary, i as ConversationEventSource, m as ConversationsApi, L as ListConversationsParams, j as ConversationPage, S as SSEProvider, g as ConversationDocument } from '../types-C2Yexi8A.js';
+import { y as MessagePayload, m as ConversationSummary, k as ConversationEventSource, o as ConversationsApi, L as ListConversationsParams, l as ConversationPage, S as SSEProvider, i as ConversationDocument, A as ResolveMediaUrl } from '../types-B5C1DLu1.js';
 import * as react from 'react';
-import { InteractiveReplyOption } from '@adatechnology/meta-whatsapp-contracts/testing';
+import { InteractiveReplyOption, InboundMediaType } from '@adatechnology/meta-whatsapp-contracts/testing';
 
 /**
  * Estado em memória que alimenta o preview de atendimento humano. Mock de API e mock de SSE
@@ -109,11 +109,6 @@ declare function createMockSSEProvider(params: CreateMockSSEProviderParams): SSE
 
 declare const PREVIEW_CONVERSATIONS: readonly ConversationSummary[];
 declare const PREVIEW_MESSAGES: Readonly<Record<string, readonly MessagePayload[]>>;
-/**
- * A biblioteca de arquivos da conversa, como o backend a devolveria. Deriva das mensagens de
- * documento acima em vez de repetir os dados: fixture duplicada divergiria na primeira edição, e o
- * painel passaria a mostrar arquivo que a thread não tem.
- */
 declare const PREVIEW_DOCUMENTS: Readonly<Record<string, readonly ConversationDocument[]>>;
 
 /**
@@ -134,6 +129,19 @@ type PreviewWebhookClient = {
     sendButtonReply(reply: InteractiveReplyOption): Promise<void>;
     sendListReply(reply: InteractiveReplyOption): Promise<void>;
     sendAudio(mediaId: string): Promise<void>;
+    sendMedia(params: SendPreviewMediaParams): Promise<void>;
+};
+type SendPreviewMediaParams = {
+    readonly mediaType: InboundMediaType;
+    /**
+     * Id que o host já usa para buscar o arquivo. Não é bytes: o webhook da Meta entrega mídia por
+     * referência, e o consumidor baixa depois — mandar base64 aqui simularia um payload que a Meta
+     * nunca produz, e o caminho testado deixaria de ser o de produção.
+     */
+    readonly mediaId: string;
+    readonly mimeType?: string;
+    readonly filename?: string;
+    readonly caption?: string;
 };
 type CreatePreviewWebhookClientParams = {
     readonly webhookUrl: string;
@@ -154,6 +162,18 @@ declare class PreviewWebhookRejectedError extends Error {
  * que um que se recusa a montar.
  */
 declare function assertPreviewEnvironment(isProduction: boolean): void;
+/**
+ * Assina um texto qualquer com o app secret, no mesmo formato do header da Meta.
+ *
+ * Exportada porque o preview precisa provar identidade em MAIS de um lugar: além de entregar a
+ * mensagem no webhook, ele lê o transcript de volta — e ler pela API de admin exigia uma sessão que
+ * a aba do simulador não tem. Assinar a leitura com o segredo que ele já carrega resolve sem token
+ * de admin e sem rota aberta.
+ */
+declare function signPreviewPayload(params: {
+    rawBody: string;
+    appSecret: string;
+}): Promise<string>;
 declare function createPreviewWebhookClient(params: CreatePreviewWebhookClientParams): PreviewWebhookClient;
 
 type ConversationPreviewProps = {
@@ -162,8 +182,52 @@ type ConversationPreviewProps = {
     conversationId: string;
     loadMessages: (conversationId: string) => Promise<MessagePayload[]>;
     placeholder?: string;
+    /**
+     * Recarrega o transcript a cada N ms. Serve a host SEM stream: a resposta do bot é assíncrona, e
+     * sem SSE nem polling ela só apareceria no próximo envio — o sintoma é "às vezes ele não
+     * responde". Ausente, não faz polling (host com SSE não precisa).
+     */
+    pollIntervalMs?: number;
+    /**
+     * Como transformar um arquivo do disco (ou o áudio gravado) na referência que o webhook carrega.
+     * O caminho da Meta entrega mídia por `id`, e quem sabe hospedar o arquivo é o host — a SDK não
+     * inventa um endpoint de upload. Ausente, o compositor não oferece anexo nem gravação: melhor um
+     * botão que não existe do que um que falha ao ser tocado.
+     */
+    uploadMedia?: (file: File) => Promise<PreviewUploadedMedia>;
 };
-declare function ConversationPreview({ client, sse, conversationId, loadMessages, placeholder, }: ConversationPreviewProps): react.JSX.Element;
+type PreviewUploadedMedia = {
+    readonly mediaId: string;
+    readonly mimeType?: string;
+    readonly filename?: string;
+};
+/** Deriva o tipo de mídia do WhatsApp a partir do MIME do arquivo escolhido. */
+declare function mediaTypeOf(mimeType: string): SendPreviewMediaParams['mediaType'];
+declare function ConversationPreview({ client, sse, conversationId, loadMessages, placeholder, pollIntervalMs, uploadMedia, }: ConversationPreviewProps): react.JSX.Element;
+
+/**
+ * Gravação de áudio no simulador, pelo microfone do próprio navegador.
+ *
+ * Existe porque áudio é o formato que mais chega de cliente real e o que mais quebra fluxo: sem
+ * poder gravar aqui, testar o caminho de transcrição exigia mandar mensagem do celular de alguém.
+ *
+ * O arquivo gravado sai daqui como `File` e segue exatamente o mesmo caminho de um anexo — quem
+ * hospeda e devolve o `mediaId` é o host, via `uploadMedia`.
+ */
+interface AudioRecorderButtonLabels {
+    start: string;
+    stop: string;
+    unsupported: string;
+    denied: string;
+}
+declare const DEFAULT_AUDIO_RECORDER_BUTTON_LABELS: AudioRecorderButtonLabels;
+interface AudioRecorderButtonProps {
+    onRecorded: (file: File) => void | Promise<void>;
+    onFailure?: (message: string) => void;
+    labels?: Partial<AudioRecorderButtonLabels>;
+    disabled?: boolean;
+}
+declare function AudioRecorderButton({ onRecorded, onFailure, labels, disabled }: AudioRecorderButtonProps): react.JSX.Element;
 
 /**
  * Roteiro que mantém o preview vivo: sem tráfego chegando, a inbox é uma tela estática e as
@@ -183,4 +247,84 @@ type StartPreviewScriptParams = {
 };
 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_DOCUMENTS, 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 };
+/**
+ * Bytes de verdade para o preview abrir.
+ *
+ * O mock antes devolvia a MESMA imagem PNG para qualquer documento, então clicar em "visualizar" num
+ * PDF entregava um PNG rotulado `application/pdf` e o leitor dizia que o arquivo era inválido. Cada
+ * amostra aqui é um arquivo mínimo porém legítimo do seu tipo: as de mídia foram geradas com ffmpeg
+ * e conferidas com ffprobe, o PDF tem xref/startxref/%%EOF, e os pacotes Office são zips com as
+ * partes obrigatórias (`[Content_Types].xml`, `_rels/.rels`, o documento).
+ *
+ * Não há amostra de `audio/amr`, `video/3gp` nem dos formatos binários legados do Office
+ * (`application/msword`, `application/vnd.ms-excel`, `application/vnd.ms-powerpoint`): não há
+ * encoder para eles nesta máquina e forjar OLE2 à mão daria arquivo corrompido — exatamente o que
+ * este módulo existe para evitar. Esses caem no texto explicativo de `resolvePreviewFileSample`,
+ * que abre sem erro e diz o que é.
+ *
+ * GERADO — não editar à mão.
+ */
+declare const PREVIEW_FILE_SAMPLES: Readonly<Record<string, string>>;
+/**
+ * A data URL que o preview abre para um documento.
+ *
+ * Ordem: tipo exato → família (`audio/amr` toca como mp3, `video/3gp` como mp4) → nota em texto.
+ * A nota fecha o caso dos tipos sem amostra: abre num leitor de texto e explica, em vez de baixar
+ * um binário quebrado com extensão de Word.
+ */
+declare function resolvePreviewFileSample(mimeType: string | undefined, filename?: string): string;
+
+/**
+ * Como o preview entrega mídia para a UI abrir.
+ *
+ * Separado de `previewFileSamples` (que é gerado) porque aqui está a parte que depende do navegador:
+ * **blob URL, não data URL**. O Chrome bloqueia navegação de topo para `data:` desde a v60, então
+ * `window.open(dataUrl)` — que é o que os botões "visualizar" e "baixar" fazem — abre aba em branco
+ * mesmo com bytes perfeitamente válidos. Em `src` de `<img>`/`<video>` a data URL funcionaria; no
+ * `window.open` não, e o mesmo `getDocumentUrl` alimenta os dois.
+ */
+
+/** URL que o preview pode abrir em aba nova. Cai na data URL fora do navegador (teste, SSR). */
+declare function previewFileUrl(mimeType: string | undefined, filename?: string): string;
+/**
+ * A mesma amostra em base64 cru, como o proxy de mídia do backend a devolveria.
+ *
+ * Existe porque `getMediaProxyUrl` é o caminho da mídia AINDA NÃO ingerida (só existe o id na Meta),
+ * e o contrato pede `{ mimeType, data }` — não URL. Sem isto o mock devolvia o PNG 1x1 para
+ * qualquer id, e vídeo e áudio da thread apareciam quebrados apesar de haver amostra válida.
+ */
+declare function previewFileBase64(mimeType: string | undefined, filename?: string): {
+    mimeType: string;
+    data: string;
+};
+/**
+ * O `onResolveMediaUrl` que o `MessageBubble` espera.
+ *
+ * Sem ele, foto, vídeo e áudio da thread ficam parados no placeholder para sempre — o
+ * `MediaRenderer` só resolve `uploadId`/`mediaId` por esta porta, de propósito, para o pacote nunca
+ * chamar endpoint fixo. O preview não tinha resolvedor nenhum, então nenhuma mídia carregava.
+ */
+declare function createPreviewMediaResolver(): ResolveMediaUrl;
+
+/**
+ * Bancada de teste manual de mídia — montável em uma linha por qualquer projeto que adote o SDK.
+ *
+ * Existe porque o defeito que ela pega não é pegável por teste automatizado: "o PDF abre?" depende
+ * do leitor do navegador, "o vídeo toca?" do decodificador, e "a aba abre?" da política do Chrome
+ * sobre `data:` URL. Teste unitário confere bytes; só o olho confere que o arquivo abre. Sem uma
+ * superfície pronta no pacote, cada projeto teria de montar a sua — e, na prática, nenhum montava.
+ *
+ * Traz o próprio store, o próprio mock e o próprio provider: o host não injeta nada. E não passa
+ * `onResolveMediaUrl` em lugar nenhum de propósito — é o `MessageBubble` resolvendo mídia pelo
+ * `ConversationsApi` do contexto, então se essa resolução automática quebrar, esta tela mostra.
+ */
+/** A conversa do fixture que carrega uma mensagem de cada tipo aceito. */
+declare const MEDIA_TYPES_CONVERSATION_ID = "5511944443333";
+type MediaTypesPreviewProps = {
+    /** Outra conversa do fixture, se o projeto tiver acrescentado a sua. */
+    conversationId?: string;
+    className?: string;
+};
+declare function MediaTypesPreview({ conversationId, className, }: MediaTypesPreviewProps): react.JSX.Element;
+
+export { type AppendMessageParams, AudioRecorderButton, type AudioRecorderButtonLabels, type AudioRecorderButtonProps, ConversationPreview, type ConversationPreviewProps, type CreateMockConversationsApiParams, type CreateMockSSEProviderParams, type CreatePreviewStoreParams, type CreatePreviewWebhookClientParams, DEFAULT_AUDIO_RECORDER_BUTTON_LABELS, DEFAULT_PREVIEW_SCRIPT, GLOBAL_CHANNEL, type ListConversationsFilters, MEDIA_TYPES_CONVERSATION_ID, MediaTypesPreview, type MediaTypesPreviewProps, type MockEventSource, PREVIEW_CONVERSATIONS, PREVIEW_DOCUMENTS, PREVIEW_FILE_SAMPLES, PREVIEW_MESSAGES, type PreviewEmission, PreviewInProductionError, type PreviewScriptStep, type PreviewStore, type PreviewStoreListener, type PreviewUploadedMedia, type PreviewWebhookClient, PreviewWebhookRejectedError, type SendPreviewMediaParams, type SetModeParams, type StartPreviewScriptParams, assertPreviewEnvironment, conversationChannel, createMockConversationsApi, createMockEventSource, createMockSSEProvider, createPreviewMediaResolver, createPreviewStore, createPreviewWebhookClient, mediaTypeOf, previewFileBase64, previewFileUrl, resolvePreviewFileSample, signPreviewPayload, startPreviewScript };