{ "$schema": "https://ui.shadcn.com/schema/registry-item.json", "name": "pdf-templates", "title": "Pdf Templates", "description": "Three renderer-native A4 document templates powered by Takumi, the PDF engine behind PDFCN: a commercial invoice, monthly operations report, and evidence-led compliance certificate. Exports serialisable data contracts, document components, deterministic samples, and renderPdfTemplate() for server-side PDF generation.", "dependencies": [ "takumi-pdf@^0.6.4" ], "files": [ { "path": "components/blocks/domain/pdf-templates/documents.tsx", "content": "import * as React from \"react\"\n\nimport type {\n ComplianceCertificateTemplateData,\n InvoiceTemplateData,\n OperationsReportTemplateData,\n PdfCurrency,\n PdfParty,\n PdfTemplateData,\n PdfTemplateName,\n} from \"./types\"\n\nconst INK = \"#18181b\"\nconst MUTED_INK = \"#52525b\"\nconst FAINT_INK = \"#52525b\"\nconst RULE = \"#d4d4d8\"\nconst WASH = \"#f4f4f5\"\nconst PAPER = \"#ffffff\"\n\nconst pageStyle: React.CSSProperties = {\n backgroundColor: PAPER,\n color: INK,\n display: \"flex\",\n flexDirection: \"column\",\n fontFamily: \"Helvetica, Arial, sans-serif\",\n fontSize: 11,\n lineHeight: 1.5,\n width: \"100%\",\n}\n\nconst labelStyle: React.CSSProperties = {\n color: MUTED_INK,\n fontSize: 8,\n fontWeight: 700,\n letterSpacing: 1,\n margin: 0,\n textTransform: \"uppercase\",\n}\n\nconst sectionHeadingStyle: React.CSSProperties = {\n borderBottom: `1px solid ${RULE}`,\n fontSize: 13,\n fontWeight: 700,\n margin: \"28px 0 12px\",\n paddingBottom: 6,\n}\n\nfunction formatMoneyMinor(amountMinor: number, currency: PdfCurrency): string {\n return new Intl.NumberFormat(\"en-GB\", {\n currency,\n currencyDisplay: \"symbol\",\n maximumFractionDigits: 2,\n minimumFractionDigits: 2,\n style: \"currency\",\n }).format(amountMinor / 100)\n}\n\nfunction assertSafeInteger(value: number, name: string): number {\n if (!Number.isSafeInteger(value)) {\n throw new Error(`${name} must be a safe integer.`)\n }\n return value\n}\n\nfunction assertNonNegativeSafeInteger(value: number, name: string): number {\n const integer = assertSafeInteger(value, name)\n if (integer < 0) {\n throw new Error(`${name} must not be negative.`)\n }\n return integer\n}\n\nfunction quantityToMillionths(quantity: number): number {\n if (!Number.isFinite(quantity) || quantity < 0) {\n throw new Error(\"Invoice item quantity must be a finite, non-negative number.\")\n }\n\n const quantityMillionths = Math.round(quantity * 1_000_000)\n if (!Number.isSafeInteger(quantityMillionths) || Math.abs(quantity - quantityMillionths / 1_000_000) > 1e-10) {\n throw new Error(\"Invoice item quantity supports at most six decimal places.\")\n }\n return quantityMillionths\n}\n\nfunction multiplySafe(left: number, right: number, name: string): number {\n const product = assertNonNegativeSafeInteger(left, name) * assertNonNegativeSafeInteger(right, name)\n if (!Number.isSafeInteger(product)) {\n throw new Error(`${name} exceeds JavaScript's safe integer range.`)\n }\n return product\n}\n\nfunction addSafe(left: number, right: number, name: string): number {\n const sum = assertSafeInteger(left, name) + assertSafeInteger(right, name)\n if (!Number.isSafeInteger(sum)) {\n throw new Error(`${name} exceeds JavaScript's safe integer range.`)\n }\n return sum\n}\n\nfunction divideAndRound(numerator: number, denominator: number, name: string): number {\n const result = Math.round(numerator / denominator)\n if (!Number.isSafeInteger(result)) {\n throw new Error(`${name} exceeds JavaScript's safe integer range.`)\n }\n return result\n}\n\nexport function calculateInvoiceTotals(data: InvoiceTemplateData): {\n lineTotalsMinor: number[]\n subtotalMinor: number\n taxMinor: number\n totalMinor: number\n} {\n const lineTotalsMinor = data.items.map((item) =>\n divideAndRound(\n multiplySafe(quantityToMillionths(item.quantity), item.unitPriceMinor, \"Invoice line total\"),\n 1_000_000,\n \"Invoice line total\"\n )\n )\n const subtotalMinor = lineTotalsMinor.reduce(\n (total, itemTotal) => addSafe(total, itemTotal, \"Invoice subtotal\"),\n 0\n )\n const taxMinor = divideAndRound(\n multiplySafe(subtotalMinor, data.taxRateBasisPoints, \"Invoice tax\"),\n 10_000,\n \"Invoice tax\"\n )\n\n return {\n lineTotalsMinor,\n subtotalMinor,\n taxMinor,\n totalMinor: addSafe(subtotalMinor, taxMinor, \"Invoice total\"),\n }\n}\n\nexport function PdfPageFooter({ documentId }: { documentId: string }) {\n return (\n \n {documentId}\n \n Page of \n \n \n )\n}\n\nfunction Party({ party }: { party: PdfParty }) {\n return (\n
\n {party.name}\n {party.address.map((line) => (\n \n {line}\n \n ))}\n {party.registrationNumber ? (\n {party.registrationNumber}\n ) : null}\n {party.email ? {party.email} : null}\n
\n )\n}\n\nexport function InvoicePdfDocument({ data }: { data: InvoiceTemplateData }) {\n const { lineTotalsMinor, subtotalMinor, taxMinor, totalMinor } = calculateInvoiceTotals(data)\n const taxRate = data.taxRateBasisPoints / 100\n\n return (\n
\n
\n
\n

Invoice

\n

\n {data.invoiceNumber}\n

\n
\n
\n

Issued {data.issueDate}

\n

Due {data.dueDate}

\n
\n
\n\n
\n
\n

From

\n \n
\n
\n

Bill to

\n \n
\n
\n\n
\n

Items

\n
\n Description\n Qty\n Rate\n Amount\n
\n {data.items.map((item, index) => (\n
\n {item.description}\n {item.quantity}\n \n {formatMoneyMinor(item.unitPriceMinor, data.currency)}\n \n \n {formatMoneyMinor(lineTotalsMinor[index], data.currency)}\n \n
\n ))}\n
\n\n
\n {[\n [\"Subtotal\", formatMoneyMinor(subtotalMinor, data.currency)],\n [`VAT (${taxRate}%)`, formatMoneyMinor(taxMinor, data.currency)],\n ].map(([label, value]) => (\n
\n {label}\n {value}\n
\n ))}\n
\n Total due\n {formatMoneyMinor(totalMinor, data.currency)}\n
\n
\n\n {data.notes ? (\n
\n

Notes

\n

{data.notes}

\n
\n ) : null}\n
\n )\n}\n\nfunction StatusMark({ status }: { status: string }) {\n return {status}\n}\n\nexport function OperationsReportPdfDocument({\n data,\n}: {\n data: OperationsReportTemplateData\n}) {\n return (\n
\n
\n

Operations report · {data.period}

\n

{data.title}

\n

\n Prepared by {data.preparedBy} for {data.preparedFor}\n

\n
\n\n
\n

Executive summary

\n

{data.summary}

\n
\n\n
\n

Key metrics

\n
\n {data.metrics.map((metric) => (\n
\n

{metric.label}

\n

{metric.value}

\n {metric.context ?

{metric.context}

: null}\n
\n ))}\n
\n
\n\n
\n

Workstreams

\n
\n Workstream\n Owner\n Progress\n Status\n
\n {data.workstreams.map((workstream) => (\n
\n {workstream.name}\n {workstream.owner}\n {workstream.progress}%\n \n
\n ))}\n
\n\n
\n
\n

Decisions needed

\n
    \n {data.decisions.map((decision) =>
  1. {decision}
    2. )}\n
\n
\n
\n

Next steps

\n
    \n {data.nextSteps.map((step) =>
  1. {step}
    2. )}\n
\n
\n
\n
\n )\n}\n\nexport function ComplianceCertificatePdfDocument({\n data,\n}: {\n data: ComplianceCertificateTemplateData\n}) {\n return (\n
\n
\n
\n

Evidence certificate

\n

Compliance record

\n
\n
\n

Certificate

\n {data.certificateNumber}\n
\n
\n\n
\n

Subject

\n \n
\n\n
\n
\n

Material and project

\n

Material: {data.material}

\n

Project: {data.project}

\n

Location: {data.location}

\n
\n
\n

Validity

\n

Issued: {data.issuedDate}

\n

Valid until: {data.validUntil}

\n
\n
\n\n
\n

Statement

\n

{data.statement}

\n
\n\n
\n

Evidence checks

\n
\n Requirement\n Evidence\n Result\n
\n {data.checks.map((check) => (\n
\n {check.requirement}\n {check.evidence}\n {check.result}\n
\n ))}\n
\n\n
\n

Issued by

\n

{data.issuedBy}

\n
\n
\n )\n}\n\nexport function PdfTemplateDocument({\n name,\n data,\n}: {\n name: Name\n data: PdfTemplateData\n}) {\n if (name === \"invoice\") {\n return \n }\n if (name === \"operations-report\") {\n return \n }\n return \n}\n", "type": "registry:component", "target": "components/blocks/domain/pdf-templates/documents.tsx" }, { "path": "components/blocks/domain/pdf-templates/index.ts", "content": "export {\n ComplianceCertificatePdfDocument,\n calculateInvoiceTotals,\n InvoicePdfDocument,\n OperationsReportPdfDocument,\n PdfTemplateDocument,\n} from \"./documents\"\nexport { renderPdfTemplate } from \"./render\"\nexport { PDF_TEMPLATE_SAMPLES } from \"./sample-data\"\nexport {\n PDF_TEMPLATE_NAMES,\n type ComplianceCertificateTemplateData,\n type ComplianceCheck,\n type InvoiceLineItem,\n type InvoiceTemplateData,\n type OperationsMetric,\n type OperationsReportTemplateData,\n type OperationsWorkstream,\n type PdfCurrency,\n type PdfParty,\n type PdfRenderOptions,\n type PdfTemplateData,\n type PdfTemplateDataMap,\n type PdfTemplateName,\n} from \"./types\"\n", "type": "registry:component", "target": "components/blocks/domain/pdf-templates/index.ts" }, { "path": "components/blocks/domain/pdf-templates/render.tsx", "content": "import { measure, render } from \"takumi-pdf\"\n\nimport { PdfPageFooter, PdfTemplateDocument } from \"./documents\"\nimport { PDF_TEMPLATE_SAMPLES } from \"./sample-data\"\nimport type {\n ComplianceCertificateTemplateData,\n InvoiceTemplateData,\n OperationsReportTemplateData,\n PdfRenderOptions,\n PdfTemplateData,\n PdfTemplateName,\n} from \"./types\"\n\nfunction documentIdForTemplate(\n name: Name,\n data: PdfTemplateData\n): string {\n if (name === \"invoice\") {\n return (data as InvoiceTemplateData).invoiceNumber\n }\n if (name === \"operations-report\") {\n const report = data as OperationsReportTemplateData\n return `${report.title} · ${report.period}`\n }\n return (data as ComplianceCertificateTemplateData).certificateNumber\n}\n\n/**\n * Renders one of the bundled PDF template documents with Takumi — the renderer\n * underpinning pdfcn's Takumi registry. Call this from a server action, route\n * handler, worker, or any other trusted server-side integration.\n */\nexport async function renderPdfTemplate(\n name: Name,\n data: PdfTemplateData = PDF_TEMPLATE_SAMPLES[name] as PdfTemplateData,\n options: PdfRenderOptions = {}\n): Promise {\n const footer = \n const { height: footerHeight } = await measure(footer, {\n fontFamilies: options.fontFamilies,\n fonts: options.fonts,\n images: options.images,\n lang: \"en-GB\",\n size: \"a4\",\n stylesheets: options.stylesheets,\n })\n\n return render(, {\n ...options,\n footer,\n lang: \"en-GB\",\n margin: { bottom: Math.ceil(footerHeight) + 16, left: 48, right: 48, top: 48 },\n outline: true,\n size: \"a4\",\n })\n}\n", "type": "registry:component", "target": "components/blocks/domain/pdf-templates/render.tsx" }, { "path": "components/blocks/domain/pdf-templates/sample-data.ts", "content": "import type { PdfTemplateDataMap } from \"./types\"\n\n/**\n * Deterministic reference data used by the showcase endpoint and render check.\n * Replace it with application data before rendering in a consumer application.\n */\nexport const PDF_TEMPLATE_SAMPLES: PdfTemplateDataMap = {\n invoice: {\n invoiceNumber: \"NX-INV-2026-041\",\n issueDate: \"13 August 2026\",\n dueDate: \"12 September 2026\",\n supplier: {\n name: \"Nexus ReGen Ltd\",\n address: [\"15 Greville Street\", \"London\", \"EC1N 8SQ\"],\n email: \"finance@nexusregen.com\",\n registrationNumber: \"Company No. 15432108\",\n },\n customer: {\n name: \"Acme Civil Engineering Ltd\",\n address: [\"Station Yard\", \"Hungerford\", \"RG17 0EY\"],\n email: \"accounts@acmecivil.example\",\n registrationNumber: \"Company No. 09182044\",\n },\n items: [\n { description: \"Materials assurance workspace — August\", quantity: 1, unitPriceMinor: 240_000 },\n { description: \"Verified movement records\", quantity: 84, unitPriceMinor: 1_200 },\n { description: \"Implementation support\", quantity: 6, unitPriceMinor: 17_500 },\n ],\n currency: \"GBP\",\n taxRateBasisPoints: 2_000,\n notes: \"Please quote the invoice number with your payment. Payment terms: 30 days.\",\n },\n \"operations-report\": {\n title: \"Monthly delivery report\",\n period: \"August 2026\",\n preparedFor: \"Nexus ReGen leadership team\",\n preparedBy: \"Delivery Office\",\n summary:\n \"Delivery remained on plan overall. The two decisions below would remove the only material risk to the September release window.\",\n metrics: [\n { label: \"Movements verified\", value: \"1,284\", context: \"+18% month on month\" },\n { label: \"Evidence complete\", value: \"94.6%\", context: \"+3.2 percentage points\" },\n { label: \"Avoided disposal\", value: \"486 t\", context: \"Estimate across live projects\" },\n { label: \"Open decisions\", value: \"2\", context: \"Both owner-assigned\" },\n ],\n workstreams: [\n { name: \"Assurance workflows\", owner: \"M. Patel\", progress: 88, status: \"On track\" },\n { name: \"Evidence ingestion\", owner: \"A. Roberts\", progress: 71, status: \"Requires decision\" },\n { name: \"Partner onboarding\", owner: \"C. Green\", progress: 64, status: \"At risk\" },\n { name: \"Reporting release\", owner: \"D. Khan\", progress: 93, status: \"On track\" },\n ],\n decisions: [\n \"Approve an additional evidence-review capacity allocation for September.\",\n \"Confirm the partner onboarding pilot cohort before 21 August.\",\n ],\n nextSteps: [\n \"Close the remaining ingestion edge cases and run the acceptance pack.\",\n \"Publish the reporting release note and customer enablement guide.\",\n \"Reforecast the September delivery plan after the pilot cohort decision.\",\n ],\n },\n \"compliance-certificate\": {\n certificateNumber: \"NXR-CERT-2026-0187\",\n issuedDate: \"13 August 2026\",\n validUntil: \"13 February 2027\",\n subject: {\n name: \"Acme Civil Engineering Ltd\",\n address: [\"Station Yard\", \"Hungerford\", \"RG17 0EY\"],\n registrationNumber: \"Company No. 09182044\",\n },\n material: \"6F2 recycled aggregate\",\n project: \"Riverside logistics hub\",\n location: \"Bristol, United Kingdom\",\n statement:\n \"This certificate records the evidence reviewed for the stated material and project. It is a traceable record of the checks below, not a substitute for statutory approvals or site-specific professional advice.\",\n checks: [\n { requirement: \"Source and movement record\", evidence: \"Verified chain of custody\", result: \"Pass\" },\n { requirement: \"Material classification\", evidence: \"EWC 17 01 07 recorded\", result: \"Pass\" },\n { requirement: \"Quality evidence\", evidence: \"Test certificate linked\", result: \"Pass\" },\n { requirement: \"Receiving-site acceptance\", evidence: \"Acceptance evidence due at next movement\", result: \"Review\" },\n ],\n issuedBy: \"Nexus ReGen Assurance\",\n },\n}\n", "type": "registry:component", "target": "components/blocks/domain/pdf-templates/sample-data.ts" }, { "path": "components/blocks/domain/pdf-templates/types.ts", "content": "import type { RenderOptions } from \"takumi-pdf\"\n\n/** The supported document templates. */\nexport const PDF_TEMPLATE_NAMES = [\n \"invoice\",\n \"operations-report\",\n \"compliance-certificate\",\n] as const\n\nexport type PdfTemplateName = (typeof PDF_TEMPLATE_NAMES)[number]\n\nexport type PdfCurrency = \"EUR\" | \"GBP\" | \"USD\"\n\nexport interface PdfParty {\n name: string\n address: string[]\n email?: string\n registrationNumber?: string\n}\n\nexport interface InvoiceLineItem {\n description: string\n /** A non-negative quantity, up to six decimal places. */\n quantity: number\n /** Unit price in the currency's minor unit, e.g. 2,400.00 GBP is 240000. */\n unitPriceMinor: number\n}\n\nexport interface InvoiceTemplateData {\n invoiceNumber: string\n issueDate: string\n dueDate: string\n supplier: PdfParty\n customer: PdfParty\n items: InvoiceLineItem[]\n currency: PdfCurrency\n /** Tax rate in basis points, e.g. 20% is 2000. */\n taxRateBasisPoints: number\n notes?: string\n}\n\nexport interface OperationsMetric {\n label: string\n value: string\n context?: string\n}\n\nexport interface OperationsWorkstream {\n name: string\n owner: string\n progress: number\n status: \"At risk\" | \"On track\" | \"Requires decision\"\n}\n\nexport interface OperationsReportTemplateData {\n title: string\n period: string\n preparedFor: string\n preparedBy: string\n summary: string\n metrics: OperationsMetric[]\n workstreams: OperationsWorkstream[]\n decisions: string[]\n nextSteps: string[]\n}\n\nexport interface ComplianceCheck {\n requirement: string\n evidence: string\n result: \"Pass\" | \"Review\" | \"Not assessed\"\n}\n\nexport interface ComplianceCertificateTemplateData {\n certificateNumber: string\n issuedDate: string\n validUntil: string\n subject: PdfParty\n material: string\n project: string\n location: string\n statement: string\n checks: ComplianceCheck[]\n issuedBy: string\n}\n\nexport interface PdfTemplateDataMap {\n invoice: InvoiceTemplateData\n \"operations-report\": OperationsReportTemplateData\n \"compliance-certificate\": ComplianceCertificateTemplateData\n}\n\nexport type PdfTemplateData =\n PdfTemplateDataMap[Name]\n\n/**\n * Safe renderer options consumers may customise without changing the A4 page\n * contract used by these templates. The template owns page geometry and locale.\n */\nexport type PdfRenderOptions = Pick<\n RenderOptions,\n \"fontFamilies\" | \"fonts\" | \"images\" | \"metadata\" | \"stylesheets\" | \"tagged\"\n>\n", "type": "registry:component", "target": "components/blocks/domain/pdf-templates/types.ts" } ], "type": "registry:block" }