@tmf/mailbox-front (4.0.3)

Published 2026-07-10 11:55:31 -03:00 by tarcisio

Setup this registry in your project .npmrc file:

@tmf:registry=

To install the package using npm, run the following command:

npm install @tmf/mailbox-front@4.0.3

or add it to the package.json file:

"@tmf/mailbox-front": "4.0.3"

For more information on the npm registry, see the documentation.

@tmf/mailbox-front

Módulo Mailbox plug-and-play da plataforma TMF — caixa de entrada unificada de mensagens inbound (WhatsApp / E-mail / SMS).

Extraído do antigo SDInboxTable do @tmf/service-desk-front. Inbound multicanal é domínio de mensageria, não de tickets — por isso virou módulo próprio, com contrato (MailboxApiClient) e backend próprios.

Versão: 0.1.0
Distribuição: registry npm privado (org TMF, Forgejo)
Peer deps: react, react-dom (>= 18)
Deps: @tanstack/react-query, lucide-react

Instalação

npm install @tmf/mailbox-front

Uso (plug-and-play)

import { MailboxApp } from '@tmf/mailbox-front'

<MailboxApp baseUrl="/api/service/mailbox" getToken={() => auth.token} />

⚠️ baseUrl deve ser /api/service/mailbox — é o prefixo que o tmf-mailbox-service expõe (S2S, espelha /api/service/service-desk). O Provider monta sozinho o MailboxApiClient (fetch sobre ${baseUrl}/messages) e um QueryClient interno — o host não precisa prover <QueryClientProvider>.

Uso (modo avançado — client próprio)

import { MailboxApp, type MailboxApiClient } from '@tmf/mailbox-front'

const client: MailboxApiClient = {
  listMessages: (params) => http.get('/api/service/mailbox/messages', params),
}

<MailboxApp client={client} onReply={(msg) => openComposer(msg)} />

Contrato de backend

O front é agnóstico de transporte. O backend próprio do módulo (packages/mailbox/back — SDK Python — e packages/mailbox/service — serviço FastAPI) implementa:

Método	Endpoint	Retorno
`listMessages(params)`	`GET /api/service/mailbox/messages`	`MailboxListResponse` (cursor-based)

Exports

MailboxApp — componente top-level (Provider + header + caixa de entrada)
MailboxInbox — só a tabela da caixa de entrada (uso avulso)
MailboxProvider, useMailboxContext, useMailboxUI
defaultMailboxUIPrimitives, mergeMailboxUI (slot pattern de UI)
mailboxQueryKeys, tipos (MailboxMessage, MailboxApiClient, MailboxLabels, …)
PACKAGE_VERSION

Documentação

Arquivo	Conteúdo
`FUNCIONALIDADES.md`	Catálogo de componentes, hooks, slots e tipos
`CONFORMANCE.md`	Checklist de conformidade ao padrão-ouro TMF
`CHANGELOG.md`	Histórico de versões

Dependencies

ID	Version
@tanstack/react-query	^5.0.0
lucide-react	^0.400.0

Development dependencies

ID	Version
@tmf/platform-core	file:../../platform-core
@types/react	^18.2.47
@types/react-dom	^18.2.18
tsup	^8.5.1
typescript	^5.3.3

Peer dependencies

ID	Version
react	>=18.0.0
react-dom	>=18.0.0

tmf mailbox inbox messaging react components plug-and-play

Details

npm

2026-07-10 11:55:31 -03:00

Trade Marketing Force LTDA

UNLICENSED

29 KiB

Assets (1)

mailbox-front-4.0.3.tgz 29 KiB

Versions (7) View all

6.1.0

2026-07-30

6.0.0

2026-07-27

5.0.0

2026-07-16

4.0.3

2026-07-10

4.0.0

2026-07-07

@tmf/mailbox-front (4.0.3)

Installation

About this package