@adatechnology/conversations-ui 0.1.0-rc.34 → 0.1.0-rc.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,6 @@
1
1
  import * as react from 'react';
2
+ import { ReactNode } from 'react';
3
+ import { InteractiveReplyOption, InboundMediaType } from '@adatechnology/meta-whatsapp-contracts/testing';
2
4
 
3
5
  interface ConversationsUIConfig {
4
6
  apiBaseUrl: string;
@@ -499,4 +501,304 @@ interface ConversationDocument {
499
501
  linkedAt: string;
500
502
  }
501
503
 
502
- export { AudioRecorderButton as A, type ListDocumentsParams as B, CHANNEL_CAPABILITIES as C, DEFAULT_AUDIO_RECORDER_BUTTON_LABELS as D, type MediaRendererProps as E, type FormatContactHandleParams as F, type MessagePayload as G, HANDLE_KIND as H, type InteractiveOption as I, type MessageTranscription as J, type ReopenMechanism as K, type ListConversationsParams as L, MediaRenderer as M, type ResolveMediaUrl as N, type TranscriptionStatus as O, capabilitiesOf as P, channelFiltersFor as Q, REOPEN_MECHANISM as R, type SSEProvider as S, type TranscriptionMode as T, contactFlag as U, formatContactHandle as V, type AudioRecorderButtonLabels as a, type AudioRecorderButtonProps as b, CHANNEL_FILTER_ALL as c, CONVERSATION_CHANNEL as d, type ChannelCapabilities as e, type ChannelFilter as f, type ChannelFilterOption as g, type CompanyDocument as h, type CompanyDocumentPage as i, type ConversationChannel as j, type ConversationDocument as k, type ConversationDocumentPage as l, type ConversationEventSource as m, type ConversationPage as n, type ConversationSummary as o, type ConversationTemplate as p, type ConversationsApi as q, type ConversationsFeatures as r, type ConversationsTheme as s, type ConversationsUIConfig as t, DEFAULT_CONVERSATION_CHANNEL as u, DEFAULT_MAX_RECORDING_MILLISECONDS as v, type HandleKind as w, type InteractivePayload as x, type InteractiveSection as y, type InteractiveSelection as z };
504
+ /**
505
+ * Entrega ao simulador o `uploadMedia` que ele precisa para desenhar o microfone.
506
+ *
507
+ * O `ConversationPreview` esconde o gravador sem esta função, e com razão: microfone que grava sem
508
+ * ter onde guardar o arquivo faz o operador falar para o vazio. O que faltava era montar isto —
509
+ * lê o `File`, manda para a rota do host, devolve o `mediaId` prefixado que o webhook referencia.
510
+ *
511
+ * Fica no pacote porque a parte que erra é sempre a mesma em todo produto: converter o binário sem
512
+ * estourar a pilha e marcar o id com o prefixo que o backend reconhece. O que muda por produto é só
513
+ * a rota e o cliente HTTP — e é exatamente isso que entra por parâmetro.
514
+ */
515
+ /**
516
+ * Do `contracts`, que este pacote já consome — não uma cópia.
517
+ *
518
+ * A convenção tem duas pontas (o front gera o id, o backend resolve) e a versão anterior disso vivia
519
+ * duplicada em dois pacotes de um produto, cada cópia com um comentário pedindo para não divergir.
520
+ * Contrato compartilhado é o que o `contracts` existe para guardar.
521
+ */
522
+
523
+ type PreviewUploadedMedia$1 = {
524
+ readonly mediaId: string;
525
+ readonly mimeType?: string;
526
+ readonly filename?: string;
527
+ };
528
+ type PreviewMediaUploadRequest = {
529
+ readonly base64: string;
530
+ readonly mimeType: string;
531
+ readonly filename: string;
532
+ };
533
+ type CreatePreviewMediaUploaderParams = {
534
+ /**
535
+ * Envia o arquivo à rota do host e devolve o `uploadId` (sem prefixo) que o backend gerou.
536
+ *
537
+ * Recebe a função inteira, e não uma URL, porque autenticação varia: uma instalação assina com
538
+ * HMAC, outra manda token de admin, outra usa cookie de sessão. Pedir a URL obrigaria o pacote a
539
+ * escolher por elas.
540
+ */
541
+ readonly upload: (request: PreviewMediaUploadRequest) => Promise<{
542
+ uploadId: string;
543
+ }>;
544
+ /** Nome usado quando o gravador entrega o áudio sem nome próprio. */
545
+ readonly fallbackFilename?: string;
546
+ readonly fallbackMimeType?: string;
547
+ };
548
+ declare function createPreviewMediaUploader(params: CreatePreviewMediaUploaderParams): (file: File) => Promise<PreviewUploadedMedia$1>;
549
+
550
+ /**
551
+ * Cliente que entrega mensagens do preview no webhook real, assinadas com HMAC — a mesma validação
552
+ * de staging e produção, sem rota alternativa e sem bypass. Do ponto de vista da API, este cliente
553
+ * é indistinguível da Meta; o que muda é apenas quem assina.
554
+ *
555
+ * Assina com WebCrypto porque `node:crypto` não existe no navegador. Os builders vêm dos contratos
556
+ * (isomórficos) justamente para que o mesmo payload seja montado nos dois runtimes.
557
+ *
558
+ * ⚠️ SOMENTE EXECUÇÃO LOCAL. Isto carrega o app secret no bundle, e bundle é público onde quer que
559
+ * seja servido — em qualquer ambiente com URL acessível (homologação inclusive) usar esta fábrica
560
+ * equivale a publicar o segredo, e quem o tiver forja webhooks válidos daquele app da Meta: injeta
561
+ * mensagem de qualquer número e dispara os fluxos. `assertPreviewEnvironment` barra produção, mas
562
+ * homologação passaria, então a barreira não basta.
563
+ *
564
+ * Para qualquer ambiente publicado use `createPreviewBridgeClient`: o navegador manda a intenção e
565
+ * o servidor assina com o segredo que ele já tem.
566
+ */
567
+
568
+ type PreviewWebhookClient = {
569
+ sendText(text: string): Promise<void>;
570
+ sendButtonReply(reply: InteractiveReplyOption): Promise<void>;
571
+ sendListReply(reply: InteractiveReplyOption): Promise<void>;
572
+ sendAudio(mediaId: string): Promise<void>;
573
+ sendMedia(params: SendPreviewMediaParams): Promise<void>;
574
+ /**
575
+ * Guarda um arquivo gravado e devolve o `mediaId` já prefixado, pronto para `sendMedia`.
576
+ *
577
+ * Existe no cliente, e não como prop de quem monta a tela, porque isto é exatamente o que ele já
578
+ * sabe fazer: falar com ESTE host usando ESTE segredo. Enquanto era responsabilidade do produto,
579
+ * o resultado prático foi um produto com microfone no simulador e outro sem — não por decisão,
580
+ * por esquecimento. Cliente montado, microfone na tela.
581
+ *
582
+ * Opcional porque o cliente-ponte só consegue oferecer isto quando sabe a rota de mídia (ou quando
583
+ * o host injeta a função): sem destino, gravar áudio seria falar para o vazio, e aí a tela
584
+ * corretamente não desenha o gravador.
585
+ */
586
+ uploadMedia?(file: File): Promise<PreviewUploadedMedia$1>;
587
+ };
588
+ type SendPreviewMediaParams = {
589
+ readonly mediaType: InboundMediaType;
590
+ /**
591
+ * Id que o host já usa para buscar o arquivo. Não é bytes: o webhook da Meta entrega mídia por
592
+ * referência, e o consumidor baixa depois — mandar base64 aqui simularia um payload que a Meta
593
+ * nunca produz, e o caminho testado deixaria de ser o de produção.
594
+ */
595
+ readonly mediaId: string;
596
+ readonly mimeType?: string;
597
+ readonly filename?: string;
598
+ readonly caption?: string;
599
+ };
600
+ type CreatePreviewWebhookClientParams = {
601
+ readonly webhookUrl: string;
602
+ readonly appSecret: string;
603
+ readonly from: string;
604
+ readonly phoneNumberId?: string;
605
+ /**
606
+ * Rota que guarda o áudio gravado. Por padrão, `/v1/preview/media` na mesma origem do webhook.
607
+ *
608
+ * O padrão cobre o caso normal — as duas rotas são do mesmo servidor — e a prop existe para quem
609
+ * publica a API em outro host ou versiona o caminho.
610
+ */
611
+ readonly mediaUploadUrl?: string;
612
+ readonly fetchImplementation?: typeof fetch;
613
+ };
614
+ /** Falha da rota de upload, separada da do webhook: os dois lados quebram por motivos diferentes. */
615
+ declare class PreviewMediaUploadRejectedError extends Error {
616
+ readonly status: number;
617
+ constructor(status: number);
618
+ }
619
+ declare class PreviewInProductionError extends Error {
620
+ constructor();
621
+ }
622
+ declare class PreviewWebhookRejectedError extends Error {
623
+ readonly status: number;
624
+ constructor(status: number);
625
+ }
626
+ /**
627
+ * Falha alto em vez de degradar em silêncio: um preview que "quase funciona" em produção é pior
628
+ * que um que se recusa a montar.
629
+ */
630
+ declare function assertPreviewEnvironment(isProduction: boolean): void;
631
+ /**
632
+ * Assina um texto qualquer com o app secret, no mesmo formato do header da Meta.
633
+ *
634
+ * Exportada porque o preview precisa provar identidade em MAIS de um lugar: além de entregar a
635
+ * mensagem no webhook, ele lê o transcript de volta — e ler pela API de admin exigia uma sessão que
636
+ * a aba do simulador não tem. Assinar a leitura com o segredo que ele já carrega resolve sem token
637
+ * de admin e sem rota aberta.
638
+ */
639
+ declare function signPreviewPayload(params: {
640
+ rawBody: string;
641
+ appSecret: string;
642
+ }): Promise<string>;
643
+ declare const DEFAULT_MEDIA_UPLOAD_PATH = "/v1/preview/media";
644
+ /**
645
+ * O POST de mídia, sem a parte de assinatura — para os dois clientes usarem o mesmo caminho.
646
+ *
647
+ * O cliente-ponte autentica por sessão e o de webhook por HMAC; o que não muda é a rota, o formato
648
+ * do corpo e a leitura do `uploadId`. Duas cópias disso é como o prefixo de mídia divergiu antes.
649
+ */
650
+ declare function createPreviewMediaPoster(params: {
651
+ readonly url: string;
652
+ readonly headers?: (mimeType: string) => Promise<Readonly<Record<string, string>>>;
653
+ readonly fetchImplementation?: typeof fetch;
654
+ }): (file: File) => Promise<PreviewUploadedMedia$1>;
655
+ declare function createPreviewWebhookClient(params: CreatePreviewWebhookClientParams): PreviewWebhookClient;
656
+
657
+ /**
658
+ * Copyright (c) 2026 Ada Technology. All rights reserved.
659
+ *
660
+ * This source code is proprietary and confidential. Unauthorized copying,
661
+ * modification, distribution, or use of this file, via any medium, is
662
+ * strictly prohibited without prior written permission from Ada Technology.
663
+ *
664
+ * Author: Anderson Filho <andersonfrfilho@gmail.com>
665
+ *
666
+ * Porta do simulador: o que a visão lado-cliente precisa saber fazer, sem canal no nome.
667
+ *
668
+ * O simulador nasceu falando WhatsApp — `PreviewWebhookClient`, payload assinado, mídia por
669
+ * `mediaId`. Só que a mesma casa atende pelo chat do próprio site, e simular ali não é uma segunda
670
+ * tela: é o mesmo painel, no mesmo lugar da conversa, com outro transporte. Sem esta porta cada
671
+ * canal novo viraria uma cópia da tela — e cópia de tela diverge, que é exatamente o que o
672
+ * `ConversationSimulatorPanel` existe para ter parado.
673
+ *
674
+ * O que é específico de canal fica no adaptador, nunca aqui:
675
+ * - **resposta de menu:** a Meta distingue `button_reply` de `list_reply`, e o roteador do fluxo lê
676
+ * campos diferentes; o chat do site manda o rótulo como texto, que é literalmente o que o
677
+ * visitante produz ao tocar no botão do widget. A porta entrega a seleção inteira e deixa cada
678
+ * adaptador escolher a forma de fio.
679
+ * - **mídia:** a Meta entrega por REFERÊNCIA (sobe o arquivo primeiro, o webhook carrega o `id`); o
680
+ * widget manda os BYTES no `FormData`. A porta trafega o `File` que a tela tem em mão — quem
681
+ * tiver passo de upload faz o upload por dentro.
682
+ */
683
+
684
+ /**
685
+ * Tipos de mídia que o cliente pode mandar de dentro do simulador.
686
+ *
687
+ * Subconjunto proposital do que a Meta aceita: `sticker` chega do aparelho, mas não há como
688
+ * escolher um no seletor de arquivo do navegador — oferecer o tipo aqui seria um caminho morto.
689
+ */
690
+ type SimulatorMediaKind = 'image' | 'video' | 'audio' | 'document';
691
+ /** Os tipos que saem do seletor de arquivo. `audio` fica de fora: ele vem do microfone. */
692
+ declare const SIMULATOR_FILE_MEDIA_KINDS: readonly SimulatorMediaKind[];
693
+ /** Deriva o tipo de mídia a partir do MIME do arquivo escolhido. */
694
+ declare function mediaKindOf(mimeType: string): SimulatorMediaKind;
695
+ type SendSimulatorMediaParams = {
696
+ readonly mediaKind: SimulatorMediaKind;
697
+ /** O arquivo do disco ou o áudio recém-gravado. Referência × bytes é decisão do adaptador. */
698
+ readonly file: File;
699
+ readonly mimeType?: string;
700
+ readonly filename?: string;
701
+ readonly caption?: string;
702
+ };
703
+ type ConversationSimulatorClient = {
704
+ sendText(text: string): Promise<void>;
705
+ sendReply(selection: InteractiveSelection): Promise<void>;
706
+ /**
707
+ * Ausente = este canal não recebe mídia do cliente, e o compositor não desenha clipe nem
708
+ * microfone. Melhor um botão que não existe do que um que falha ao ser tocado.
709
+ */
710
+ sendMedia?(params: SendSimulatorMediaParams): Promise<void>;
711
+ /**
712
+ * Restringe o que `sendMedia` aceita. Ausente = todos os tipos.
713
+ *
714
+ * Existe porque canal com meia capacidade é comum: o chat do site sobe áudio (a API transcreve)
715
+ * mas não tem rota para imagem. Sem esta lista o clipe e o microfone apareciam juntos, e um dos
716
+ * dois falhava ao ser tocado.
717
+ */
718
+ readonly acceptedMediaKinds?: readonly SimulatorMediaKind[];
719
+ };
720
+ /** Responde se o compositor deve desenhar o affordance daquele tipo. */
721
+ declare function acceptsMediaKind(client: ConversationSimulatorClient, kind: SimulatorMediaKind): boolean;
722
+ type ToSimulatorClientParams = {
723
+ readonly client: PreviewWebhookClient;
724
+ /** Destino alternativo do upload. Sem isto, usa o do próprio `client`. */
725
+ readonly uploadMedia?: (file: File) => Promise<PreviewUploadedMedia$1>;
726
+ };
727
+ /**
728
+ * Distingue a porta neutra do cliente WhatsApp legado, que continua aceito na prop.
729
+ *
730
+ * Leitura estrutural e não `instanceof`: os dois são objetos literais devolvidos por fábrica, e o
731
+ * host pode ter montado o seu à mão.
732
+ */
733
+ declare function isConversationSimulatorClient(candidate: ConversationSimulatorClient | PreviewWebhookClient): candidate is ConversationSimulatorClient;
734
+ /**
735
+ * Adapta o cliente WhatsApp (webhook assinado ou ponte) para a porta neutra.
736
+ *
737
+ * O upload vive aqui dentro porque ele é uma etapa DO CANAL: no caminho da Meta a mídia precisa
738
+ * existir como `id` antes do webhook citá-la. Sem passo de upload disponível, `sendMedia` sai
739
+ * ausente — é o que mantém o clipe escondido em host que não montou destino para o arquivo, o
740
+ * comportamento que já existia antes desta porta.
741
+ */
742
+ declare function toConversationSimulatorClient({ client, uploadMedia, }: ToSimulatorClientParams): ConversationSimulatorClient;
743
+
744
+ type ConversationPreviewProps = {
745
+ /**
746
+ * Transporte do canal. `PreviewWebhookClient` continua aceito — é o caminho WhatsApp de antes
747
+ * desta porta, adaptado aqui dentro para não obrigar host nenhum a mudar de chamada.
748
+ */
749
+ client: ConversationSimulatorClient | PreviewWebhookClient;
750
+ sse: SSEProvider;
751
+ conversationId: string;
752
+ loadMessages: (conversationId: string) => Promise<MessagePayload[]>;
753
+ placeholder?: string;
754
+ /**
755
+ * Recarrega o transcript a cada N ms. Serve a host SEM stream: a resposta do bot é assíncrona, e
756
+ * sem SSE nem polling ela só apareceria no próximo envio — o sintoma é "às vezes ele não
757
+ * responde". Ausente, não faz polling (host com SSE não precisa).
758
+ */
759
+ pollIntervalMs?: number;
760
+ /**
761
+ * Destino alternativo do upload, no canal que sobe a mídia antes de citá-la (o caminho da Meta
762
+ * entrega mídia por `id`). Sem isto, usa o do próprio `client`. Canal que manda os bytes direto
763
+ * ignora esta prop: quem decide referência × bytes é o adaptador do canal.
764
+ */
765
+ uploadMedia?: (file: File) => Promise<PreviewUploadedMedia>;
766
+ };
767
+ type PreviewUploadedMedia = {
768
+ readonly mediaId: string;
769
+ readonly mimeType?: string;
770
+ readonly filename?: string;
771
+ };
772
+ /** @deprecated Use `mediaKindOf`, que não nomeia canal. Mantido para quem já importa. */
773
+ declare function mediaTypeOf(mimeType: string): SimulatorMediaKind;
774
+ declare function ConversationPreview({ client, sse, conversationId, loadMessages, placeholder, pollIntervalMs, uploadMedia, }: ConversationPreviewProps): react.JSX.Element;
775
+
776
+ type ConversationSimulatorPanelLabels = {
777
+ readonly title: string;
778
+ /** Complementa o identificador no subtítulo, explicando para onde a mensagem realmente vai. */
779
+ readonly destinationHint: string;
780
+ readonly close: string;
781
+ readonly placeholder: string;
782
+ };
783
+ declare const DEFAULT_CONVERSATION_SIMULATOR_PANEL_LABELS: ConversationSimulatorPanelLabels;
784
+ /** Rótulos do painel já resolvidos para o canal — útil para o host que monta o cabeçalho por fora. */
785
+ declare function simulatorPanelLabelsOf(channel: ConversationChannel | undefined): ConversationSimulatorPanelLabels;
786
+ type ConversationSimulatorPanelProps = Omit<ConversationPreviewProps, 'placeholder'> & {
787
+ readonly onClose: () => void;
788
+ /** Ausente = WhatsApp, que era o único canal antes desta prop existir. */
789
+ readonly channel?: ConversationChannel;
790
+ /**
791
+ * Identificador do contato já formatado para leitura — telefone no WhatsApp, apelido no Instagram,
792
+ * "Visitante 3f9c21" no chat do site. É o host que formata: máscara de telefone é convenção
793
+ * regional, e o pacote não tem como saber a do produto.
794
+ */
795
+ readonly displayHandle?: string;
796
+ /** @deprecated Use `displayHandle` — o simulador deixou de ser só telefone. */
797
+ readonly displayNumber?: string;
798
+ readonly labels?: Partial<ConversationSimulatorPanelLabels>;
799
+ /** Ações extras no cabeçalho — roteiro automático, limpar conversa, trocar de contato. */
800
+ readonly headerActions?: ReactNode;
801
+ };
802
+ declare function ConversationSimulatorPanel({ onClose, channel, displayHandle, displayNumber, labels, headerActions, ...previewProps }: ConversationSimulatorPanelProps): react.JSX.Element;
803
+
804
+ export { type PreviewWebhookClient as $, AudioRecorderButton as A, type CreatePreviewMediaUploaderParams as B, CHANNEL_CAPABILITIES as C, type CreatePreviewWebhookClientParams as D, DEFAULT_AUDIO_RECORDER_BUTTON_LABELS as E, DEFAULT_CONVERSATION_CHANNEL as F, DEFAULT_CONVERSATION_SIMULATOR_PANEL_LABELS as G, DEFAULT_MAX_RECORDING_MILLISECONDS as H, DEFAULT_MEDIA_UPLOAD_PATH as I, type FormatContactHandleParams as J, HANDLE_KIND as K, type HandleKind as L, type InteractiveOption as M, type InteractivePayload as N, type InteractiveSection as O, type InteractiveSelection as P, type ListConversationsParams as Q, type ListDocumentsParams as R, MediaRenderer as S, type MediaRendererProps as T, type MessagePayload as U, type MessageTranscription as V, PreviewInProductionError as W, PreviewMediaUploadRejectedError as X, type PreviewMediaUploadRequest as Y, type PreviewUploadedMedia$1 as Z, type PreviewUploadedMedia as _, type AudioRecorderButtonLabels as a, PreviewWebhookRejectedError as a0, REOPEN_MECHANISM as a1, type ReopenMechanism as a2, type ResolveMediaUrl as a3, SIMULATOR_FILE_MEDIA_KINDS as a4, type SSEProvider as a5, type SendPreviewMediaParams as a6, type SendSimulatorMediaParams as a7, type SimulatorMediaKind as a8, type ToSimulatorClientParams as a9, type TranscriptionMode as aa, type TranscriptionStatus as ab, acceptsMediaKind as ac, assertPreviewEnvironment as ad, capabilitiesOf as ae, channelFiltersFor as af, contactFlag as ag, createPreviewMediaPoster as ah, createPreviewMediaUploader as ai, createPreviewWebhookClient as aj, formatContactHandle as ak, isConversationSimulatorClient as al, mediaKindOf as am, mediaTypeOf as an, signPreviewPayload as ao, simulatorPanelLabelsOf as ap, toConversationSimulatorClient as aq, type AudioRecorderButtonProps as b, CHANNEL_FILTER_ALL as c, CONVERSATION_CHANNEL as d, type ChannelCapabilities as e, type ChannelFilter as f, type ChannelFilterOption as g, type CompanyDocument as h, type CompanyDocumentPage as i, type ConversationChannel as j, type ConversationDocument as k, type ConversationDocumentPage as l, type ConversationEventSource as m, type ConversationPage as n, ConversationPreview as o, type ConversationPreviewProps as p, type ConversationSimulatorClient as q, ConversationSimulatorPanel as r, type ConversationSimulatorPanelLabels as s, type ConversationSimulatorPanelProps as t, type ConversationSummary as u, type ConversationTemplate as v, type ConversationsApi as w, type ConversationsFeatures as x, type ConversationsTheme as y, type ConversationsUIConfig as z };