@formfeed/engine 0.3.21 → 0.3.22

package/index.cjs

@@ -60,6 +60,12 @@ __export(index_exports, {
   INVOICE_DATA_KEY: () => INVOICE_DATA_KEY,
   OFFICE_FILLED_MAX_BYTES: () => OFFICE_FILLED_MAX_BYTES,
   OfficeTemplateError: () => OfficeTemplateError,
+  PDFA_DEFAULT_LEVEL: () => PDFA_DEFAULT_LEVEL,
+  PDFA_HEADER_LENGTH: () => PDFA_HEADER_LENGTH,
+  PDFA_LEVELS: () => PDFA_LEVELS,
+  PDFA_MAX_MESSAGES: () => PDFA_MAX_MESSAGES,
+  PDFA_REFUSALS: () => PDFA_REFUSALS,
+  PDFA_STANDARDS: () => PDFA_STANDARDS,
   PDFUA_STANDARD: () => PDFUA_STANDARD,
   RenderError: () => RenderError,
   RenderLimitError: () => RenderLimitError,
@@ -152,6 +158,8 @@ __export(index_exports, {
   isApitemplateRegion: () => isApitemplateRegion,
   isOfficeKind: () => isOfficeKind,
   isOutputFormat: () => isOutputFormat,
+  isPdfaResult: () => isPdfaResult,
+  isPdfaSetting: () => isPdfaSetting,
   isScss: () => isScss,
   isUaSetting: () => isUaSetting,
   jinja2Engine: () => jinja2Engine,
@@ -184,6 +192,10 @@ __export(index_exports, {
   parseDesign: () => parseDesign,
   parseSourceAttribute: () => parseSourceAttribute,
   partialInclude: () => partialInclude,
+  pdfaFromEinvoice: () => pdfaFromEinvoice,
+  pdfaHeaderValue: () => pdfaHeaderValue,
+  pdfaResult: () => pdfaResult,
+  pdfaStandard: () => pdfaStandard,
   printReset: () => printReset,
   qrSvg: () => qrSvg,
   readJsreportExport: () => readJsreportExport,
@@ -194,6 +206,7 @@ __export(index_exports, {
   renderVersion: () => renderVersion,
   resolveEinvoiceOptions: () => resolveEinvoiceOptions,
   resolvePath: () => resolvePath,
+  resolvePdfa: () => resolvePdfa,
   resolveTranslation: () => resolveTranslation,
   resolveUa: () => resolveUa,
   scanBlocks: () => scanBlocks,
@@ -324,7 +337,7 @@ function toNumber(value) {
 // packages/engine/src/lib/codes/epc.ts
 function epcPayload(input) {
   const amount2 = input.amount === void 0 || input.amount === "" ? "" : `EUR${toNumber(input.amount).toFixed(2)}`;
-  return [
+  const elements = [
     "BCD",
     "002",
     "1",
@@ -336,8 +349,12 @@ function epcPayload(input) {
     (input.purpose ?? "").slice(0, 4),
     (input.reference ?? "").slice(0, 35),
     input.reference ? "" : (input.text ?? "").slice(0, 140),
+    // the beneficiary to originator information, which a payment here has no field for
     ""
-  ].join("\n");
+  ];
+  while (elements.length > 0 && elements[elements.length - 1] === "")
+    elements.pop();
+  return elements.join("\n");
 }
 var IBAN_LENGTHS = {
   AD: 24,
@@ -394,34 +411,73 @@ function validateEpc(input) {
   const problems = [];
   const name = String(input.name ?? "").trim();
   if (!name) problems.push({ field: "name", code: "required" });
-  else if (name.length > 70) problems.push({ field: "name", code: "too_long", max: 70, actual: name.length });
+  else if (name.length > 70)
+    problems.push({
+      field: "name",
+      code: "too_long",
+      max: 70,
+      actual: name.length
+    });
   const iban2 = normaliseIban(String(input.iban ?? ""));
   if (!iban2) problems.push({ field: "iban", code: "required" });
-  else if (!/^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$/.test(iban2)) problems.push({ field: "iban", code: "iban_characters" });
+  else if (!/^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$/.test(iban2))
+    problems.push({ field: "iban", code: "iban_characters" });
   else {
     const expected = IBAN_LENGTHS[iban2.slice(0, 2)];
     if (expected !== void 0 && iban2.length !== expected)
-      problems.push({ field: "iban", code: "iban_country_length", max: expected, actual: iban2.length });
-    else if (!ibanChecksum(iban2)) problems.push({ field: "iban", code: "iban_checksum" });
+      problems.push({
+        field: "iban",
+        code: "iban_country_length",
+        max: expected,
+        actual: iban2.length
+      });
+    else if (!ibanChecksum(iban2))
+      problems.push({ field: "iban", code: "iban_checksum" });
   }
   const bic = String(input.bic ?? "").replace(/\s/g, "").toUpperCase();
-  if (bic && !/^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$/.test(bic)) problems.push({ field: "bic", code: "bic_format" });
+  if (bic && !/^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$/.test(bic))
+    problems.push({ field: "bic", code: "bic_format" });
   if (input.amount !== void 0 && input.amount !== "") {
     const amount2 = toNumber(input.amount);
-    if (Number.isNaN(amount2)) problems.push({ field: "amount", code: "not_a_number" });
-    else if (amount2 < 0.01 || amount2 > 99999999999e-2) problems.push({ field: "amount", code: "out_of_range" });
+    if (Number.isNaN(amount2))
+      problems.push({ field: "amount", code: "not_a_number" });
+    else if (amount2 < 0.01 || amount2 > 99999999999e-2)
+      problems.push({ field: "amount", code: "out_of_range" });
   }
   const purpose = String(input.purpose ?? "");
-  if (purpose.length > 4) problems.push({ field: "purpose", code: "too_long", max: 4, actual: purpose.length });
+  if (purpose.length > 4)
+    problems.push({
+      field: "purpose",
+      code: "too_long",
+      max: 4,
+      actual: purpose.length
+    });
   const reference = String(input.reference ?? "").trim();
   const text4 = String(input.text ?? "").trim();
-  if (reference && text4) problems.push({ field: "reference", code: "reference_or_text" });
+  if (reference && text4)
+    problems.push({ field: "reference", code: "reference_or_text" });
   if (reference.length > 35)
-    problems.push({ field: "reference", code: "too_long", max: 35, actual: reference.length });
-  if (text4.length > 140) problems.push({ field: "text", code: "too_long", max: 140, actual: text4.length });
+    problems.push({
+      field: "reference",
+      code: "too_long",
+      max: 35,
+      actual: reference.length
+    });
+  if (text4.length > 140)
+    problems.push({
+      field: "text",
+      code: "too_long",
+      max: 140,
+      actual: text4.length
+    });
   const bytes = byteLength(epcPayload(input));
   if (bytes > EPC_MAX_BYTES)
-    problems.push({ field: "payload", code: "too_long", max: EPC_MAX_BYTES, actual: bytes });
+    problems.push({
+      field: "payload",
+      code: "too_long",
+      max: EPC_MAX_BYTES,
+      actual: bytes
+    });
   return problems;
 }
 
@@ -11501,6 +11557,89 @@ function staticAudit(input) {
   return findings;
 }
 
+// packages/engine/src/lib/pdfa/index.ts
+var PDFA_LEVELS = ["2b", "3b"];
+var PDFA_DEFAULT_LEVEL = "3b";
+var PDFA_STANDARDS = {
+  "2b": "PDF/A-2b",
+  "3b": "PDF/A-3b"
+};
+function resolvePdfa(setting) {
+  if (setting === true) return PDFA_DEFAULT_LEVEL;
+  return typeof setting === "string" && PDFA_LEVELS.includes(setting) ? setting : null;
+}
+function isPdfaSetting(value) {
+  return value === null || typeof value === "boolean" || typeof value === "string" && PDFA_LEVELS.includes(value);
+}
+function pdfaStandard(level) {
+  return PDFA_STANDARDS[level];
+}
+var PDFA_REFUSALS = {
+  password: "pdf.pdfa cannot be combined with post.password: PDF/A does not allow encryption",
+  einvoice: 'pdf.pdfa "2b" cannot be combined with an e-invoice: the invoice XML is an attachment, which PDF/A-2 does not allow. An e-invoice is a PDF/A-3b already; ask for "3b" or leave pdf.pdfa out',
+  invalid: 'settings.pdf.pdfa is "2b", "3b", true, false or null'
+};
+var PDFA_MAX_MESSAGES = 50;
+var asMessage = (message) => ({
+  severity: message.severity === "warning" ? "warning" : "error",
+  rule: typeof message.rule === "string" ? message.rule : null,
+  message: typeof message.message === "string" ? message.message : "",
+  location: typeof message.location === "string" ? message.location : null
+});
+var capped = (messages, truncated) => {
+  const sorted = [
+    ...messages.filter((message) => message.severity === "error"),
+    ...messages.filter((message) => message.severity !== "error")
+  ];
+  return sorted.length > PDFA_MAX_MESSAGES || truncated ? { messages: sorted.slice(0, PDFA_MAX_MESSAGES), truncated: true } : { messages: sorted };
+};
+function pdfaResult(level, report, pdfSha256) {
+  return {
+    standard: PDFA_STANDARDS[level],
+    conformant: report.valid === true,
+    validator: report.validator,
+    id: report.id,
+    versions: { ...report.versions ?? {} },
+    pdf_sha256: pdfSha256,
+    ...capped(
+      (Array.isArray(report.messages) ? report.messages : []).map(asMessage),
+      report.truncated === true
+    )
+  };
+}
+function pdfaFromEinvoice(validation) {
+  if (!validation || validation.pdfa == null) return null;
+  const messages = validation.messages.filter((message) => message.part === "pdf").map((message) => ({
+    severity: message.severity,
+    rule: message.rule,
+    message: message.message,
+    location: message.location
+  }));
+  const versions = { ...validation.versions ?? {} };
+  return {
+    standard: PDFA_STANDARDS["3b"],
+    conformant: !messages.some((message) => message.severity === "error"),
+    validator: `veraPDF ${versions["verapdf"] ?? "unknown"}`,
+    id: validation.id ?? "",
+    versions,
+    pdf_sha256: validation.pdf_sha256 ?? null,
+    ...capped(messages, false)
+  };
+}
+function isPdfaResult(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return false;
+  const report = value;
+  return typeof report.standard === "string" && Object.values(PDFA_STANDARDS).includes(report.standard) && typeof report.conformant === "boolean";
+}
+var PDFA_HEADER_LENGTH = 2e3;
+function pdfaHeaderValue(result, limit = PDFA_HEADER_LENGTH) {
+  const value = encodeURIComponent(JSON.stringify(result));
+  if (value.length <= limit) return value;
+  return encodeURIComponent(
+    JSON.stringify({ ...result, messages: [], truncated: true })
+  );
+}
+
 // packages/engine/src/lib/office/errors.ts
 var OfficeError = class extends Error {
   constructor(code, message, details = {}) {

package/index.js

@@ -101,7 +101,7 @@ function toNumber(value) {
 // packages/engine/src/lib/codes/epc.ts
 function epcPayload(input) {
   const amount2 = input.amount === void 0 || input.amount === "" ? "" : `EUR${toNumber(input.amount).toFixed(2)}`;
-  return [
+  const elements = [
     "BCD",
     "002",
     "1",
@@ -113,8 +113,12 @@ function epcPayload(input) {
     (input.purpose ?? "").slice(0, 4),
     (input.reference ?? "").slice(0, 35),
     input.reference ? "" : (input.text ?? "").slice(0, 140),
+    // the beneficiary to originator information, which a payment here has no field for
     ""
-  ].join("\n");
+  ];
+  while (elements.length > 0 && elements[elements.length - 1] === "")
+    elements.pop();
+  return elements.join("\n");
 }
 var IBAN_LENGTHS = {
   AD: 24,
@@ -171,34 +175,73 @@ function validateEpc(input) {
   const problems = [];
   const name = String(input.name ?? "").trim();
   if (!name) problems.push({ field: "name", code: "required" });
-  else if (name.length > 70) problems.push({ field: "name", code: "too_long", max: 70, actual: name.length });
+  else if (name.length > 70)
+    problems.push({
+      field: "name",
+      code: "too_long",
+      max: 70,
+      actual: name.length
+    });
   const iban2 = normaliseIban(String(input.iban ?? ""));
   if (!iban2) problems.push({ field: "iban", code: "required" });
-  else if (!/^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$/.test(iban2)) problems.push({ field: "iban", code: "iban_characters" });
+  else if (!/^[A-Z]{2}[0-9]{2}[A-Z0-9]{11,30}$/.test(iban2))
+    problems.push({ field: "iban", code: "iban_characters" });
   else {
     const expected = IBAN_LENGTHS[iban2.slice(0, 2)];
     if (expected !== void 0 && iban2.length !== expected)
-      problems.push({ field: "iban", code: "iban_country_length", max: expected, actual: iban2.length });
-    else if (!ibanChecksum(iban2)) problems.push({ field: "iban", code: "iban_checksum" });
+      problems.push({
+        field: "iban",
+        code: "iban_country_length",
+        max: expected,
+        actual: iban2.length
+      });
+    else if (!ibanChecksum(iban2))
+      problems.push({ field: "iban", code: "iban_checksum" });
   }
   const bic = String(input.bic ?? "").replace(/\s/g, "").toUpperCase();
-  if (bic && !/^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$/.test(bic)) problems.push({ field: "bic", code: "bic_format" });
+  if (bic && !/^[A-Z]{6}[A-Z0-9]{2}([A-Z0-9]{3})?$/.test(bic))
+    problems.push({ field: "bic", code: "bic_format" });
   if (input.amount !== void 0 && input.amount !== "") {
     const amount2 = toNumber(input.amount);
-    if (Number.isNaN(amount2)) problems.push({ field: "amount", code: "not_a_number" });
-    else if (amount2 < 0.01 || amount2 > 99999999999e-2) problems.push({ field: "amount", code: "out_of_range" });
+    if (Number.isNaN(amount2))
+      problems.push({ field: "amount", code: "not_a_number" });
+    else if (amount2 < 0.01 || amount2 > 99999999999e-2)
+      problems.push({ field: "amount", code: "out_of_range" });
   }
   const purpose = String(input.purpose ?? "");
-  if (purpose.length > 4) problems.push({ field: "purpose", code: "too_long", max: 4, actual: purpose.length });
+  if (purpose.length > 4)
+    problems.push({
+      field: "purpose",
+      code: "too_long",
+      max: 4,
+      actual: purpose.length
+    });
   const reference = String(input.reference ?? "").trim();
   const text4 = String(input.text ?? "").trim();
-  if (reference && text4) problems.push({ field: "reference", code: "reference_or_text" });
+  if (reference && text4)
+    problems.push({ field: "reference", code: "reference_or_text" });
   if (reference.length > 35)
-    problems.push({ field: "reference", code: "too_long", max: 35, actual: reference.length });
-  if (text4.length > 140) problems.push({ field: "text", code: "too_long", max: 140, actual: text4.length });
+    problems.push({
+      field: "reference",
+      code: "too_long",
+      max: 35,
+      actual: reference.length
+    });
+  if (text4.length > 140)
+    problems.push({
+      field: "text",
+      code: "too_long",
+      max: 140,
+      actual: text4.length
+    });
   const bytes = byteLength(epcPayload(input));
   if (bytes > EPC_MAX_BYTES)
-    problems.push({ field: "payload", code: "too_long", max: EPC_MAX_BYTES, actual: bytes });
+    problems.push({
+      field: "payload",
+      code: "too_long",
+      max: EPC_MAX_BYTES,
+      actual: bytes
+    });
   return problems;
 }
 
@@ -11278,6 +11321,89 @@ function staticAudit(input) {
   return findings;
 }
 
+// packages/engine/src/lib/pdfa/index.ts
+var PDFA_LEVELS = ["2b", "3b"];
+var PDFA_DEFAULT_LEVEL = "3b";
+var PDFA_STANDARDS = {
+  "2b": "PDF/A-2b",
+  "3b": "PDF/A-3b"
+};
+function resolvePdfa(setting) {
+  if (setting === true) return PDFA_DEFAULT_LEVEL;
+  return typeof setting === "string" && PDFA_LEVELS.includes(setting) ? setting : null;
+}
+function isPdfaSetting(value) {
+  return value === null || typeof value === "boolean" || typeof value === "string" && PDFA_LEVELS.includes(value);
+}
+function pdfaStandard(level) {
+  return PDFA_STANDARDS[level];
+}
+var PDFA_REFUSALS = {
+  password: "pdf.pdfa cannot be combined with post.password: PDF/A does not allow encryption",
+  einvoice: 'pdf.pdfa "2b" cannot be combined with an e-invoice: the invoice XML is an attachment, which PDF/A-2 does not allow. An e-invoice is a PDF/A-3b already; ask for "3b" or leave pdf.pdfa out',
+  invalid: 'settings.pdf.pdfa is "2b", "3b", true, false or null'
+};
+var PDFA_MAX_MESSAGES = 50;
+var asMessage = (message) => ({
+  severity: message.severity === "warning" ? "warning" : "error",
+  rule: typeof message.rule === "string" ? message.rule : null,
+  message: typeof message.message === "string" ? message.message : "",
+  location: typeof message.location === "string" ? message.location : null
+});
+var capped = (messages, truncated) => {
+  const sorted = [
+    ...messages.filter((message) => message.severity === "error"),
+    ...messages.filter((message) => message.severity !== "error")
+  ];
+  return sorted.length > PDFA_MAX_MESSAGES || truncated ? { messages: sorted.slice(0, PDFA_MAX_MESSAGES), truncated: true } : { messages: sorted };
+};
+function pdfaResult(level, report, pdfSha256) {
+  return {
+    standard: PDFA_STANDARDS[level],
+    conformant: report.valid === true,
+    validator: report.validator,
+    id: report.id,
+    versions: { ...report.versions ?? {} },
+    pdf_sha256: pdfSha256,
+    ...capped(
+      (Array.isArray(report.messages) ? report.messages : []).map(asMessage),
+      report.truncated === true
+    )
+  };
+}
+function pdfaFromEinvoice(validation) {
+  if (!validation || validation.pdfa == null) return null;
+  const messages = validation.messages.filter((message) => message.part === "pdf").map((message) => ({
+    severity: message.severity,
+    rule: message.rule,
+    message: message.message,
+    location: message.location
+  }));
+  const versions = { ...validation.versions ?? {} };
+  return {
+    standard: PDFA_STANDARDS["3b"],
+    conformant: !messages.some((message) => message.severity === "error"),
+    validator: `veraPDF ${versions["verapdf"] ?? "unknown"}`,
+    id: validation.id ?? "",
+    versions,
+    pdf_sha256: validation.pdf_sha256 ?? null,
+    ...capped(messages, false)
+  };
+}
+function isPdfaResult(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return false;
+  const report = value;
+  return typeof report.standard === "string" && Object.values(PDFA_STANDARDS).includes(report.standard) && typeof report.conformant === "boolean";
+}
+var PDFA_HEADER_LENGTH = 2e3;
+function pdfaHeaderValue(result, limit = PDFA_HEADER_LENGTH) {
+  const value = encodeURIComponent(JSON.stringify(result));
+  if (value.length <= limit) return value;
+  return encodeURIComponent(
+    JSON.stringify({ ...result, messages: [], truncated: true })
+  );
+}
+
 // packages/engine/src/lib/office/errors.ts
 var OfficeError = class extends Error {
   constructor(code, message, details = {}) {
@@ -14201,6 +14327,12 @@ export {
   INVOICE_DATA_KEY,
   OFFICE_FILLED_MAX_BYTES,
   OfficeTemplateError,
+  PDFA_DEFAULT_LEVEL,
+  PDFA_HEADER_LENGTH,
+  PDFA_LEVELS,
+  PDFA_MAX_MESSAGES,
+  PDFA_REFUSALS,
+  PDFA_STANDARDS,
   PDFUA_STANDARD,
   RenderError,
   RenderLimitError,
@@ -14293,6 +14425,8 @@ export {
   isApitemplateRegion,
   isOfficeKind,
   isOutputFormat,
+  isPdfaResult,
+  isPdfaSetting,
   isScss,
   isUaSetting,
   jinja2Engine,
@@ -14325,6 +14459,10 @@ export {
   parseDesign,
   parseSourceAttribute,
   partialInclude,
+  pdfaFromEinvoice,
+  pdfaHeaderValue,
+  pdfaResult,
+  pdfaStandard,
   printReset,
   qrSvg,
   readJsreportExport,
@@ -14335,6 +14473,7 @@ export {
   renderVersion,
   resolveEinvoiceOptions,
   resolvePath,
+  resolvePdfa,
   resolveTranslation,
   resolveUa,
   scanBlocks,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formfeed/engine",
-  "version": "0.3.21",
+  "version": "0.3.22",
   "description": "The Formfeed template engine (Jinja2, Liquid, Handlebars) for the browser and Node.",
   "license": "MIT",
   "type": "module",

package/types/index.d.cts

@@ -35,6 +35,8 @@ export type { CheckOptions, DisplayCheck, DisplayValue, EinvoiceDisplay, Einvoic
 export { ACCESSIBILITY_HEADER_LENGTH, ACCESSIBILITY_MAX_ELEMENTS, ACCESSIBILITY_MAX_FAILURES, AUDIT_CODES, AUDIT_RULES, AUDIT_SEVERITY, AUDIT_SNIPPET_LENGTH, AUDIT_TITLES, PDFUA_STANDARD, UA_CHECKS, UA_REFUSALS, accessibilityHeader, accessibilityHeaderValue, accessibilityResult, auditMessage, isUaSetting, resolveUa, } from './lib/accessibility/index.cjs';
 export type { AccessibilityFailure, AccessibilityResult, AccessibilityWarning, AuditArgs, AuditCode, AuditFinding, AuditLink, AuditOptions, AuditReport, AuditSeverity, UaCheck, UaOptions, UaSetting, ValidatorFailure, ValidatorVerdict, } from './lib/accessibility/index.cjs';
 export { staticAudit, staticAuditDiagnostics, } from './lib/accessibility/static.cjs';
+export { PDFA_DEFAULT_LEVEL, PDFA_HEADER_LENGTH, PDFA_LEVELS, PDFA_MAX_MESSAGES, PDFA_REFUSALS, PDFA_STANDARDS, isPdfaResult, isPdfaSetting, pdfaFromEinvoice, pdfaHeaderValue, pdfaResult, pdfaStandard, resolvePdfa, } from './lib/pdfa/index.cjs';
+export type { PdfaLevel, PdfaMessage, PdfaResult, PdfaSetting, PdfaStandard, PdfaValidatorReport, } from './lib/pdfa/index.cjs';
 export type { StaticAuditDiagnostic, StaticAuditInput, } from './lib/accessibility/static.cjs';
 export { auditRuntime } from './lib/generated/frames.cjs';
 export { encodeTemplateText } from './lib/source-edit.cjs';

package/types/index.d.ts

@@ -35,6 +35,8 @@ export type { CheckOptions, DisplayCheck, DisplayValue, EinvoiceDisplay, Einvoic
 export { ACCESSIBILITY_HEADER_LENGTH, ACCESSIBILITY_MAX_ELEMENTS, ACCESSIBILITY_MAX_FAILURES, AUDIT_CODES, AUDIT_RULES, AUDIT_SEVERITY, AUDIT_SNIPPET_LENGTH, AUDIT_TITLES, PDFUA_STANDARD, UA_CHECKS, UA_REFUSALS, accessibilityHeader, accessibilityHeaderValue, accessibilityResult, auditMessage, isUaSetting, resolveUa, } from './lib/accessibility/index.js';
 export type { AccessibilityFailure, AccessibilityResult, AccessibilityWarning, AuditArgs, AuditCode, AuditFinding, AuditLink, AuditOptions, AuditReport, AuditSeverity, UaCheck, UaOptions, UaSetting, ValidatorFailure, ValidatorVerdict, } from './lib/accessibility/index.js';
 export { staticAudit, staticAuditDiagnostics, } from './lib/accessibility/static.js';
+export { PDFA_DEFAULT_LEVEL, PDFA_HEADER_LENGTH, PDFA_LEVELS, PDFA_MAX_MESSAGES, PDFA_REFUSALS, PDFA_STANDARDS, isPdfaResult, isPdfaSetting, pdfaFromEinvoice, pdfaHeaderValue, pdfaResult, pdfaStandard, resolvePdfa, } from './lib/pdfa/index.js';
+export type { PdfaLevel, PdfaMessage, PdfaResult, PdfaSetting, PdfaStandard, PdfaValidatorReport, } from './lib/pdfa/index.js';
 export type { StaticAuditDiagnostic, StaticAuditInput, } from './lib/accessibility/static.js';
 export { auditRuntime } from './lib/generated/frames.js';
 export { encodeTemplateText } from './lib/source-edit.js';

package/types/lib/assemble.d.cts

@@ -1,4 +1,5 @@
 import type { UaSetting } from './accessibility/index.cjs';
+import type { PdfaSetting } from './pdfa/index.cjs';
 import type { BrandContext } from './brand.cjs';
 import type { EinvoiceOptionsInput } from './einvoice/schema.cjs';
 import type { EngineId, RenderContext } from './types.cjs';
@@ -56,6 +57,13 @@ export interface TemplateSettings {
          * implies `tagged`. Read it through `resolveUa`.
          */
         ua?: UaSetting;
+        /**
+         * PDF/A (plan 26): the finished PDF is converted to PDF/A-2b or PDF/A-3b and held to it by the
+         * validator; a file that fails fails the render, there is no mode that delivers it. `true` is
+         * `'3b'`. An e-invoice is a PDF/A-3b already, so `'2b'` beside one is refused. Read it through
+         * `resolvePdfa`.
+         */
+        pdfa?: PdfaSetting;
         metadata?: {
             title?: string;
             author?: string;

package/types/lib/assemble.d.ts

@@ -1,4 +1,5 @@
 import type { UaSetting } from './accessibility/index.js';
+import type { PdfaSetting } from './pdfa/index.js';
 import type { BrandContext } from './brand.js';
 import type { EinvoiceOptionsInput } from './einvoice/schema.js';
 import type { EngineId, RenderContext } from './types.js';
@@ -56,6 +57,13 @@ export interface TemplateSettings {
          * implies `tagged`. Read it through `resolveUa`.
          */
         ua?: UaSetting;
+        /**
+         * PDF/A (plan 26): the finished PDF is converted to PDF/A-2b or PDF/A-3b and held to it by the
+         * validator; a file that fails fails the render, there is no mode that delivers it. `true` is
+         * `'3b'`. An e-invoice is a PDF/A-3b already, so `'2b'` beside one is refused. Read it through
+         * `resolvePdfa`.
+         */
+        pdfa?: PdfaSetting;
         metadata?: {
             title?: string;
             author?: string;

package/types/lib/codes/epc.d.cts

@@ -29,7 +29,11 @@ export interface EpcPayment {
 }
 /** What a caller actually hands over: the same fields, none of them guaranteed to be there. */
 export type EpcInput = Partial<EpcPayment>;
-/** EPC QR (GiroCode) payload, version 002, UTF-8, SCT. */
+/**
+ * EPC QR (GiroCode) payload, version 002, UTF-8, SCT. It ends with the last populated element:
+ * "The last populated element is not followed by any character or element separator" (EPC069-12
+ * v3.1 §2.2), so the empty elements after it are left out, line breaks and all.
+ */
 export declare function epcPayload(input: EpcInput): string;
 /**
  * What is wrong with a payment, as a code rather than a sentence: the engine has no locale, and the

package/types/lib/codes/epc.d.ts

@@ -29,7 +29,11 @@ export interface EpcPayment {
 }
 /** What a caller actually hands over: the same fields, none of them guaranteed to be there. */
 export type EpcInput = Partial<EpcPayment>;
-/** EPC QR (GiroCode) payload, version 002, UTF-8, SCT. */
+/**
+ * EPC QR (GiroCode) payload, version 002, UTF-8, SCT. It ends with the last populated element:
+ * "The last populated element is not followed by any character or element separator" (EPC069-12
+ * v3.1 §2.2), so the empty elements after it are left out, line breaks and all.
+ */
 export declare function epcPayload(input: EpcInput): string;
 /**
  * What is wrong with a payment, as a code rather than a sentence: the engine has no locale, and the

package/types/lib/pdfa/index.d.cts

@@ -0,0 +1,112 @@
+import type { EinvoiceValidation } from '../einvoice/report.cjs';
+/**
+ * `@formfeed/engine/pdfa` (plan 26): what `pdf.pdfa` asks for, what it cannot go with, and the
+ * report a render keeps of what the validator said. No template engine is imported here and nothing
+ * of Node, so the gateway Worker, the render-worker, the editor and the CLI all read the same names.
+ *
+ * PDF/A is ISO 19005, a file format for keeping documents: the fonts embedded, the colours defined,
+ * nothing that needs the network or a password. Whether an archive keeps them as a law asks (the
+ * GoBD, for one) is a matter of how the archive is run, not of the file, so nothing here or on any
+ * page says "revisionssicher", "GoBD-konform", "certified" or "archive-compliant": the report says
+ * which part and level a file was held to, and by which validator.
+ */
+/**
+ * The levels a render can ask for. 3b is the default and what an e-invoice is; 2b is for archives
+ * that take PDF/A-2 and not PDF/A-3, which may carry any file as an attachment. PDF/A-1 forbids the
+ * transparency Chromium writes, so it is not offered.
+ */
+export declare const PDFA_LEVELS: readonly ["2b", "3b"];
+export type PdfaLevel = (typeof PDFA_LEVELS)[number];
+/** What `true` stands for. */
+export declare const PDFA_DEFAULT_LEVEL: PdfaLevel;
+/** The standard a level names, as the report and the `X-Formfeed-PDF-A` header write it. */
+export declare const PDFA_STANDARDS: {
+    readonly '2b': "PDF/A-2b";
+    readonly '3b': "PDF/A-3b";
+};
+export type PdfaStandard = (typeof PDFA_STANDARDS)[PdfaLevel];
+/** `pdf.pdfa` as a template's settings or a request write it. */
+export type PdfaSetting = PdfaLevel | boolean | null;
+/**
+ * `pdf.pdfa` as a render takes it: a level, `true` for the default level, and anything else off.
+ * There is no check to choose (plan 26, decision 2): a file that fails PDF/A fails the render.
+ */
+export declare function resolvePdfa(setting: unknown): PdfaLevel | null;
+/** Whether a `pdf.pdfa` value is one the API takes: a level, a boolean, or null. */
+export declare function isPdfaSetting(value: unknown): value is PdfaSetting;
+export declare function pdfaStandard(level: PdfaLevel): PdfaStandard;
+/**
+ * What `pdf.pdfa` cannot go with, in the words every place that refuses it uses (the gateway before
+ * a render costs anything, the worker for whoever calls it directly, `formfeed validate`, the API's
+ * template validation). A merge, a watermark and Word and PowerPoint templates go with it, since all
+ * of them come before the conversion.
+ */
+export declare const PDFA_REFUSALS: {
+    readonly password: "pdf.pdfa cannot be combined with post.password: PDF/A does not allow encryption";
+    readonly einvoice: "pdf.pdfa \"2b\" cannot be combined with an e-invoice: the invoice XML is an attachment, which PDF/A-2 does not allow. An e-invoice is a PDF/A-3b already; ask for \"3b\" or leave pdf.pdfa out";
+    readonly invalid: "settings.pdf.pdfa is \"2b\", \"3b\", true, false or null";
+};
+/** How many findings a render keeps; a render row travels in every list and webhook. */
+export declare const PDFA_MAX_MESSAGES = 50;
+/** One rule of PDF/A the file failed, as the validator reports it. */
+export interface PdfaMessage {
+    severity: 'error' | 'warning';
+    /** A clause of ISO 19005 and veraPDF's test number, `6.2.11.4.1-1`. */
+    rule: string | null;
+    message: string;
+    /** veraPDF's path to the object of the PDF. */
+    location: string | null;
+}
+/**
+ * `pdfa` on a render (plan 26): `null` unless the render asked for PDF/A or is an e-invoice with
+ * `pdf.pdfa` beside it. `conformant` is the validator's word on the file it judged; a render that
+ * succeeded delivered exactly that file, and one that failed delivered nothing.
+ */
+export interface PdfaResult {
+    standard: PdfaStandard;
+    conformant: boolean;
+    /** The validator and its version: its rule set moves between releases. */
+    validator: string;
+    /** The validator's own id for this report, which its log names too. */
+    id: string;
+    /** The versions of what converted and judged the file: `verapdf`, `pdfbox` (and `mustang` for an e-invoice). */
+    versions: Record<string, string>;
+    /** SHA-256 of the PDF that was judged: the delivered file when the render succeeded. */
+    pdf_sha256: string | null;
+    messages: PdfaMessage[];
+    /** More findings than the render keeps. */
+    truncated?: boolean;
+}
+/** The sidecar's report of `POST /pdf/pdfa` (`ArchiveReport` in `apps/conformance`). */
+export interface PdfaValidatorReport {
+    id: string;
+    valid: boolean;
+    pdfa: string;
+    validator: string;
+    messages: Array<{
+        severity?: string;
+        rule?: string | null;
+        message?: string;
+        location?: string | null;
+    }>;
+    truncated?: boolean;
+    versions?: Record<string, string>;
+}
+/** The report a render keeps, from the sidecar's, with the hash of the file it judged. */
+export declare function pdfaResult(level: PdfaLevel, report: PdfaValidatorReport, pdfSha256: string | null): PdfaResult;
+/**
+ * The `pdfa` block of an e-invoice that asked for PDF/A too (plan 26, decision 8): an e-invoice is
+ * a PDF/A-3b, converted and judged once, so the block is made from the e-invoice's own validation
+ * and its PDF findings. Null while that validation ended at the XML, before there was a file.
+ */
+export declare function pdfaFromEinvoice(validation: EinvoiceValidation | null | undefined): PdfaResult | null;
+/** Whether a stored value is a report: the API shows it, and null otherwise. */
+export declare function isPdfaResult(value: unknown): value is PdfaResult;
+/** How long the report may be as a header value: proxies refuse a response whose headers grow past a few kilobytes. */
+export declare const PDFA_HEADER_LENGTH = 2000;
+/**
+ * The report as the worker's binary answer carries it in `x-formfeed-pdfa`, percent-encoded: the
+ * gateway records it with the render and `preview-render` shows it. A file that was delivered
+ * passed, so its report is short; one that is too long anyway loses its findings and says so.
+ */
+export declare function pdfaHeaderValue(result: PdfaResult, limit?: number): string;

package/types/lib/pdfa/index.d.ts

@@ -0,0 +1,112 @@
+import type { EinvoiceValidation } from '../einvoice/report.js';
+/**
+ * `@formfeed/engine/pdfa` (plan 26): what `pdf.pdfa` asks for, what it cannot go with, and the
+ * report a render keeps of what the validator said. No template engine is imported here and nothing
+ * of Node, so the gateway Worker, the render-worker, the editor and the CLI all read the same names.
+ *
+ * PDF/A is ISO 19005, a file format for keeping documents: the fonts embedded, the colours defined,
+ * nothing that needs the network or a password. Whether an archive keeps them as a law asks (the
+ * GoBD, for one) is a matter of how the archive is run, not of the file, so nothing here or on any
+ * page says "revisionssicher", "GoBD-konform", "certified" or "archive-compliant": the report says
+ * which part and level a file was held to, and by which validator.
+ */
+/**
+ * The levels a render can ask for. 3b is the default and what an e-invoice is; 2b is for archives
+ * that take PDF/A-2 and not PDF/A-3, which may carry any file as an attachment. PDF/A-1 forbids the
+ * transparency Chromium writes, so it is not offered.
+ */
+export declare const PDFA_LEVELS: readonly ["2b", "3b"];
+export type PdfaLevel = (typeof PDFA_LEVELS)[number];
+/** What `true` stands for. */
+export declare const PDFA_DEFAULT_LEVEL: PdfaLevel;
+/** The standard a level names, as the report and the `X-Formfeed-PDF-A` header write it. */
+export declare const PDFA_STANDARDS: {
+    readonly '2b': "PDF/A-2b";
+    readonly '3b': "PDF/A-3b";
+};
+export type PdfaStandard = (typeof PDFA_STANDARDS)[PdfaLevel];
+/** `pdf.pdfa` as a template's settings or a request write it. */
+export type PdfaSetting = PdfaLevel | boolean | null;
+/**
+ * `pdf.pdfa` as a render takes it: a level, `true` for the default level, and anything else off.
+ * There is no check to choose (plan 26, decision 2): a file that fails PDF/A fails the render.
+ */
+export declare function resolvePdfa(setting: unknown): PdfaLevel | null;
+/** Whether a `pdf.pdfa` value is one the API takes: a level, a boolean, or null. */
+export declare function isPdfaSetting(value: unknown): value is PdfaSetting;
+export declare function pdfaStandard(level: PdfaLevel): PdfaStandard;
+/**
+ * What `pdf.pdfa` cannot go with, in the words every place that refuses it uses (the gateway before
+ * a render costs anything, the worker for whoever calls it directly, `formfeed validate`, the API's
+ * template validation). A merge, a watermark and Word and PowerPoint templates go with it, since all
+ * of them come before the conversion.
+ */
+export declare const PDFA_REFUSALS: {
+    readonly password: "pdf.pdfa cannot be combined with post.password: PDF/A does not allow encryption";
+    readonly einvoice: "pdf.pdfa \"2b\" cannot be combined with an e-invoice: the invoice XML is an attachment, which PDF/A-2 does not allow. An e-invoice is a PDF/A-3b already; ask for \"3b\" or leave pdf.pdfa out";
+    readonly invalid: "settings.pdf.pdfa is \"2b\", \"3b\", true, false or null";
+};
+/** How many findings a render keeps; a render row travels in every list and webhook. */
+export declare const PDFA_MAX_MESSAGES = 50;
+/** One rule of PDF/A the file failed, as the validator reports it. */
+export interface PdfaMessage {
+    severity: 'error' | 'warning';
+    /** A clause of ISO 19005 and veraPDF's test number, `6.2.11.4.1-1`. */
+    rule: string | null;
+    message: string;
+    /** veraPDF's path to the object of the PDF. */
+    location: string | null;
+}
+/**
+ * `pdfa` on a render (plan 26): `null` unless the render asked for PDF/A or is an e-invoice with
+ * `pdf.pdfa` beside it. `conformant` is the validator's word on the file it judged; a render that
+ * succeeded delivered exactly that file, and one that failed delivered nothing.
+ */
+export interface PdfaResult {
+    standard: PdfaStandard;
+    conformant: boolean;
+    /** The validator and its version: its rule set moves between releases. */
+    validator: string;
+    /** The validator's own id for this report, which its log names too. */
+    id: string;
+    /** The versions of what converted and judged the file: `verapdf`, `pdfbox` (and `mustang` for an e-invoice). */
+    versions: Record<string, string>;
+    /** SHA-256 of the PDF that was judged: the delivered file when the render succeeded. */
+    pdf_sha256: string | null;
+    messages: PdfaMessage[];
+    /** More findings than the render keeps. */
+    truncated?: boolean;
+}
+/** The sidecar's report of `POST /pdf/pdfa` (`ArchiveReport` in `apps/conformance`). */
+export interface PdfaValidatorReport {
+    id: string;
+    valid: boolean;
+    pdfa: string;
+    validator: string;
+    messages: Array<{
+        severity?: string;
+        rule?: string | null;
+        message?: string;
+        location?: string | null;
+    }>;
+    truncated?: boolean;
+    versions?: Record<string, string>;
+}
+/** The report a render keeps, from the sidecar's, with the hash of the file it judged. */
+export declare function pdfaResult(level: PdfaLevel, report: PdfaValidatorReport, pdfSha256: string | null): PdfaResult;
+/**
+ * The `pdfa` block of an e-invoice that asked for PDF/A too (plan 26, decision 8): an e-invoice is
+ * a PDF/A-3b, converted and judged once, so the block is made from the e-invoice's own validation
+ * and its PDF findings. Null while that validation ended at the XML, before there was a file.
+ */
+export declare function pdfaFromEinvoice(validation: EinvoiceValidation | null | undefined): PdfaResult | null;
+/** Whether a stored value is a report: the API shows it, and null otherwise. */
+export declare function isPdfaResult(value: unknown): value is PdfaResult;
+/** How long the report may be as a header value: proxies refuse a response whose headers grow past a few kilobytes. */
+export declare const PDFA_HEADER_LENGTH = 2000;
+/**
+ * The report as the worker's binary answer carries it in `x-formfeed-pdfa`, percent-encoded: the
+ * gateway records it with the render and `preview-render` shows it. A file that was delivered
+ * passed, so its report is short; one that is too long anyway loses its findings and says so.
+ */
+export declare function pdfaHeaderValue(result: PdfaResult, limit?: number): string;