Referência
Visão geral
Seção intitulada “Visão geral”O material de referência responde a perguntas pontuais: qual é o símbolo, qual é o valor, qual é o nível de suporte ou qual é a cláusula. Esta aba reúne a superfície verificada do NextPDF: referência de módulos, matrizes de suporte, superfície da API, referência de erros, conformidade com normas e políticas publicadas pelo projeto. A Referência não é o caminho para executar tarefas — quando você quiser alcançar um objetivo em vez de consultar um fato específico, use os Guias ou o Cookbook.
Mapa de referência
Seção intitulada “Mapa de referência”Mecanismo core
Seção intitulada “Mecanismo core”O mecanismo nextpdf/core, documentado módulo a módulo.
| Página | Use para |
|---|---|
| Referência do motor core | Consultar o mapa dos namespaces, com cada página de módulo e as quatro subfamílias. |
| Contracts: 41 interfaces públicas (SPI) | Consultar as interfaces públicas e enums com rastreamento de estabilidade. |
| Core: fachada Document + traits de responsabilidade | Consultar a fachada Document e a família de traits Has*. |
| HTML: subsistema de renderização de HTML+CSS em PDF | Entender o renderizador de HTML em streaming de passe único. |
| Segurança: criptografia, política de criptografia e superfície de assinatura | Consultar criptografia, permissões e pontos de integração para assinatura. |
Suporte à renderização
Seção intitulada “Suporte à renderização”O que o renderizador verifica, declara, oferece parcialmente ou não oferece.
| Página | Use para |
|---|---|
| Matriz de suporte a CSS | Níveis de suporte dos recursos de Cascading Style Sheets (CSS), recurso por recurso, no pipeline de HTML. |
| Recursos CSS não suportados e soluções alternativas | O que fica fora do escopo e o que fazer em vez disso. |
| Matriz de suporte a fontes e escritas | Tecnologias de fontes e suporte aos sistemas de escrita. |
| Suporte a escrita vertical CJK | Suporte a writing-mode vertical para texto em chinês, japonês e coreano. |
| Suporte a composição de scripts complexos | Suporte à composição de scripts que exigem esse tipo de processamento. |
Superfície da API
Seção intitulada “Superfície da API”Símbolos exatos, valores permitidos e contratos de serviço.
| Página | Use para |
|---|---|
| Referência de enums | Todos os enums públicos e seus valores permitidos. |
| Configuração da TSA | A autoridade de timestamp (TSA) padrão e como alterá-la. |
| Referência da API REST do Connect | Os endpoints REST do NextPDF Connect, baseados no documento OpenAPI 3.1. |
| Explorador da API do Connect | O explorador interativo do mesmo contrato. |
As referências de API (Interface de Programação de Aplicações) no nível dos pacotes ficam junto aos próprios pacotes: Referência da API do Connect, Índice das APIs de integração e Referência da API do SDK para Python, todas na aba Guias.
Referência de erros
Seção intitulada “Referência de erros”Todas as exceções geradas pelo mecanismo, organizadas por domínio, com seu contexto estruturado e orientações de recuperação.
| Página | Use para |
|---|---|
| Referência de erros | O modelo de exceções: a base NextPdfException e o contrato de contexto. |
| Erros do core e gerais | Falhas do ciclo de vida do documento e falhas gerais do mecanismo. |
| Erros de renderização e I/O | Falhas de HTML, fontes, writer e reader. |
| Erros de segurança e assinatura | Falhas de criptografia, assinatura e PKI. |
| Erros de runtime e suporte | Falhas de HTTP, resiliência e observabilidade. |
| Erros do Accelerator | Falhas do sidecar de aceleração opcional. |
| Erros de conformidade | Falhas de validação e de ferramentas de conformidade. |
Conformidade com normas
Seção intitulada “Conformidade com normas”Os perfis normativos que o NextPDF Core tem como alvo, cada um com seu limite declarado: o mecanismo produz uma saída destinada à conformidade; um validador externo decide se ela está em conformidade.
| Página | Use para |
|---|---|
| Conformidade com normas | A postura de conformidade e o índice dos perfis. |
| Conformidade PDF 2.0 | O baseline da ISO 32000-2 que o mecanismo tem como alvo. |
| Conformidade PDF/A-4 | Conformidade de arquivamento, com o respectivo Mapeamento de cláusulas PDF/A-4. |
| Conformidade PDF/UA-2 | Conformidade de acessibilidade, com o respectivo Mapeamento de cláusulas PDF/UA-2. |
| Conformidade PDF/X | Conformidade de produção gráfica. |
| Mapeamento de cláusulas PAdES | O mapeamento do perfil baseline da ETSI EN 319 142 para assinaturas de PDF. |
| Conformidade ZUGFeRD / Factur-X | Conformidade de fatura eletrônica híbrida. |
Central de confiança
Seção intitulada “Central de confiança”A postura de engenharia do mecanismo core, com os limites de cada afirmação.
| Página | Use para |
|---|---|
| Central de confiança | O índice das posturas. |
| Licenciamento do produto | Os termos de licença do open core e das edições comerciais. |
| Marca registrada e uso da marca | Como o nome e as marcas NextPDF podem ser usados. |
| Tratamento de dados, PII e telemetria | O que o mecanismo lê, armazena e transmite. |
| Modelo de segurança para assinaturas e criptografia | O design criptográfico e seus limites. |
| Modelo de ameaças do mecanismo | Contra quais ameaças o mecanismo se defende e contra quais não se defende. |
| Política de divulgação de vulnerabilidades | Como relatar uma vulnerabilidade. |
Projeto e versões
Seção intitulada “Projeto e versões”| Página | Use para |
|---|---|
| Registro de alterações | O que mudou em cada versão. |
| Convenções de changelog | Como as entradas do changelog são escritas e classificadas. |
| Política de versionamento, estabilidade, depreciação e suporte | As promessas de compatibilidade entre versões. |
| Como a documentação do NextPDF é estruturada | A estrutura e a governança deste conjunto de documentação. |
Glossário
Seção intitulada “Glossário”Glossário — termos usados nesta documentação, definidos uma vez e reutilizados em toda a documentação.
Contrato de entrada de referência
Seção intitulada “Contrato de entrada de referência”Cada entrada de API deve responder às mesmas perguntas:
| Pergunta | Resposta obrigatória |
|---|---|
| O que devo chamar? | Símbolo totalmente qualificado, endpoint, comando da interface de linha de comando (CLI) ou chave de configuração. |
| Quais entradas são aceitas? | Tabela de parâmetros com tipo, obrigatoriedade, valor padrão e valores aceitos. |
| O que acontece por padrão? | O comportamento quando você omite uma entrada opcional. |
| O que é retornado? | Tipo de retorno, corpo da resposta, arquivo de saída, stream (fluxo) ou efeito colateral. |
| O que pode falhar? | Exceção, erro de validação, status HTTP ou modo de falha operacional. |
| Como uso isso com segurança? | Notas sobre segurança, uso seguro em workers, limite de tamanho, caminho, timeout e tratamento de segredos. |
Política de cobertura
Seção intitulada “Política de cobertura”As páginas de referência de API e comportamento se baseiam no código-fonte. As APIs públicas são documentadas a partir do código-fonte do pacote, dos arquivos de configuração, dos testes e dos exemplos. As classes auxiliares internas são documentadas apenas quando quem desenvolve a aplicação precisa entender seu comportamento para configurar ou operar o pacote.
Prontidão para tradução
Seção intitulada “Prontidão para tradução”As páginas de referência priorizam tabelas em vez de parágrafos densos. Cada linha precisa ser autossuficiente, pois a segmentação posterior do Extensible Localization Interchange File Format (XLIFF) dividirá o conteúdo por bloco.