Migração de consumidores

Este guia ajuda a extrair integrações SIP implementadas dentro de aplicações consumidoras para o pacote @anpdgovbr/sip-client.

Modelo recomendado

A aplicação consumidora deve manter apenas uma fachada local para:

• ler variáveis de ambiente;
• montar SipConfig;
• aplicar cache, auditoria e autorização próprios;
• preservar imports internos durante a migração;
• compor fluxos de negócio específicos.

O pacote @anpdgovbr/sip-client deve receber somente configuração explícita:

import { createSipClient, type SipConfig } from "@anpdgovbr/sip-client"

export const loadSipConfig = (): SipConfig => ({
  endpointUrl: process.env.SIP_SOAP_ENDPOINT!,
  accessKey: process.env.SIP_ACCESS_KEY!,
  systemId: process.env.SIP_SYSTEM_ID!,
  requestTimeoutMs: Number(process.env.SIP_REQUEST_TIMEOUT_MS ?? 30_000),
})

export const getSipClient = () => createSipClient(loadSipConfig())
Copy

O que mover para a lib

Mova para @anpdgovbr/sip-client:

• montagem de envelopes SOAP RPC/encoded;
• parsing de SOAP Fault;
• normalização de arrays SOAP e mapas PHP;
• tipos públicos do SIP;
• mappers de usuários, unidades, perfis, recursos e permissões;
• cliente de consultas e replicação;
• testes de contrato com fixtures SOAP.

O que manter no consumidor

Mantenha na aplicação consumidora:

• .env e nomes reais das variáveis;
• autorização de usuário final;
• auditoria de quem consultou ou replicou dados;
• cache;
• persistência;
• regras de negócio;
• API routes, controllers, jobs e filas;
• decisões de UI;
• composição com RBAC, banco ou outros serviços.

Cuidados durante a migração

• Não exponha a chave do SIP em frontend.
• Prefira client.consultas.* para código novo.
• Trate client.replicacao.* como operação sensível.
• Não libere serviços de replicação no SIP para consumidores somente leitura.
• Não confunda SIP com SEI direto: permissões e cadastros vêm do SIP; operações próprias do SEI (processos, documentos, envios) usam o @anpdgovbr/sei-client. Veja sei-client.md.
• Preserve a compatibilidade do consumidor com uma fachada local até trocar os imports internos.

Validação sugerida

No repositório da lib:

pnpm format:check
pnpm lint
pnpm typecheck
pnpm test
pnpm test:coverage
pnpm build
Copy

No consumidor, instale as dependências de forma reprodutível com o gerenciador de pacotes do projeto:

npm ci
# ou
yarn install --frozen-lockfile
# ou
pnpm install --frozen-lockfile
Copy

E rode os scripts de qualidade já configurados no projeto consumidor (nomes podem variar, mas normalmente incluem):

<seu-gerenciador> run typecheck
<seu-gerenciador> run lint
<seu-gerenciador> run test
Copy

Quando houver acesso ao ambiente SIP, faça um smoke test server-side usando um usuário de teste anonimizado ou controlado e valide apenas contagens/IDs necessários, sem registrar dados sensíveis em logs permanentes.