Gerador de relatórios para Next.js

PDF

O mesmo objeto ReportDefinition vira PDF de duas formas: no navegador, com preview ao vivo, ou no servidor, com bytes prontos para uma Response. Esta página mostra as duas — e como customizar uma célula.

Preview ao vivo

CmReportPdfPreview gera o PDF no navegador (debounced) e o exibe num iframe, a partir da mesma definição e das mesmas 36 linhas de vendas — aqui limitadas às 15 primeiras.

Célula custom (pdfRender)

Quando format não é suficiente, uma coluna pode definir pdfRender: uma função que recebe a linha e o contexto da célula e devolve o elemento react-pdf a desenhar, no lugar do texto padrão.

Situação com cor condicional

A coluna 'pago' troca o texto padrão por um <Text> do react-pdf (reexportado por @cosmemilton/report/pdf) verde quando pago e vermelho quando pendente.

Motor e paginação (v0.6)

Nas APIs de servidor, engine auto usa PDFKit em Node 20+ para tabelas e seções compatíveis, com fallback React. engine react-pdf força o renderer React; createReportDocument sempre retorna a árvore React usada no navegador.

Em A4/Letter, maxRowsPerBlock limita os blocos a 100 linhas por padrão: cada bloco inicia uma página e pode ocupar várias. false mantém o fluxo contínuo. breakBeforeRow recebe a linha original e o índice global e permite uma quebra explícita, preservando a numeração do documento. Essas opções não alteram a configuração salva.

tsx
import { renderReportToBuffer, type ReportPdfOptions } from "@cosmemilton/report/pdf";
import { relatorioVendas, vendas, type Venda } from "@/lib/demo-data";

const options: ReportPdfOptions<Venda> = {
  engine: "auto", // PDFKit em Node 20+ quando compatível; fallback React
  maxRowsPerBlock: 100, // padrão; false mantém paginação contínua
  breakBeforeRow: (row, index) => index > 0 && row.vendedor !== vendas[index - 1].vendedor,
};

const pdf = await renderReportToBuffer(
  { definition: relatorioVendas, rows: vendas, globalConfig: { paperSize: "A4" } },
  options,
);

Bobinas de 58mm/80mm usam altura contínua e margens padrão de 3 mm; não são divididas em blocos e rejeitam breakBeforeRow. Conteúdo React dependente do documento inteiro também preserva o fluxo contínuo.

PDF com mais de uma tabela (v0.6)

O compositor reúne definições e dados diferentes em um único PDF. Cada relatório começa em uma página nova, com cabeçalho e rodapé próprios e numeração global. Aceita A4/Letter, incluindo tamanhos e orientações diferentes entre as partes; entradas vazias e bobinas são rejeitadas.

tsx
import { renderCompositeReportToBuffer } from "@cosmemilton/report/pdf";
import { relatorioVendas, relatorioPorVendedor, vendas } from "@/lib/demo-data";

const pdf = await renderCompositeReportToBuffer(
  [
    { definition: relatorioVendas, rows: vendas, globalConfig: { paperSize: "A4" } },
    { definition: relatorioPorVendedor, rows: vendas, globalConfig: { paperSize: "A4" } },
  ],
  { engine: "auto", maxRowsPerBlock: 100 },
);
// Cada relatório começa em uma página nova, com numeração global.
// Também existem createCompositeReportDocument e renderCompositeReportToStream.

ReportCompositePdfOptions oferece engine e maxRowsPerBlock. A quebra breakBeforeRow pertence às APIs de relatório individual.

Fontes

registerReportFonts registra uma família de fontes para usar em globalConfig.fontFamily e desativa a hifenização automática do react-pdf.

tsx
import { registerReportFonts } from "@cosmemilton/report/pdf";

// Use URLs absolutas acessíveis pelo navegador e pelo servidor.
// Chame uma vez, antes de renderizar (ex.: no módulo de setup do app,
// ou no topo do route handler que gera o PDF).
registerReportFonts({
  family: "Inter",
  fonts: [
    { src: "https://seu-app.example/fonts/Inter-Regular.ttf", fontWeight: "normal" },
    { src: "https://seu-app.example/fonts/Inter-Bold.ttf", fontWeight: "bold" },
    { src: "https://seu-app.example/fonts/Inter-Italic.ttf", fontWeight: "normal", fontStyle: "italic" },
  ],
});

// Depois, use a família registrada em qualquer render:
await renderReportToBuffer({
  definition: relatorioVendas,
  rows,
  globalConfig: { fontFamily: "Inter" },
});

Server-side

renderReportToBuffer usa PDFKit automaticamente em Node 20+ quando o relatório é compatível, com fallback para React.

Sem iframe, sem preview: só a definição, as linhas e um buffer pronto para a resposta HTTP.

tsx
// app/api/relatorios/vendas.pdf/route.ts
import { renderReportToBuffer } from "@cosmemilton/report/pdf";
import { relatorioVendas } from "@/lib/reports/vendas";

export async function GET() {
  const rows = await buscarVendas();

  const buffer = await renderReportToBuffer({
    definition: relatorioVendas,
    rows,
  });

  return new Response(buffer, {
    headers: {
      "Content-Type": "application/pdf",
      "Content-Disposition": 'attachment; filename="vendas.pdf"',
    },
  });
}
Ver guia completo de Next.js