@formfeed/engine 0.3.15 → 0.3.17

package/package.json

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

package/types/index.d.cts

@@ -30,8 +30,8 @@ export type { ApplyResult, ChipKind, EditableRegion, EditItem, RegionChip, Regio
 export { resolveTranslation, translationTarget } from './lib/translation.cjs';
 export { DESIGN_LIMITS, DESIGN_VERSION, dataPathPattern, defaultLayer, designBytes, designOutputHash, designStarters, emitDesign, emptyDesign, genericFamily, googleFont, googleFonts, googleFontsUrl, imageIsEmpty, layerIdPattern, nearestWeight, nextLayerId, parseDesign, } from './lib/design/index.cjs';
 export type { BarcodeLayer, BarcodeSymbology, Binding, CanvasSize, DesignDocument, DesignLayer, DesignStarter, EmittedDesign, FontChoice, GoogleFont, ImageLayer, ImageSource, LayerBase, LayerType, Paint, ParsedDesign, QrLayer, Shadow, ShapeLayer, Stroke, TextFormat, TextItem, TextLayer, TextStyle, } from './lib/design/index.cjs';
-export { CII_GUIDELINES, CODE_LIST_RELEASE, DISPLAY_TERMS, EINVOICE_FLAVOURS, EINVOICE_FLAVOUR_NAMES, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILES, EINVOICE_PROFILE_NAMES, EINVOICE_SPEC_VERSIONS, EINVOICE_XML_NAME, INVOICE_DATA_KEY, VAT_CATEGORIES, capMessages, checkInvoice, defaultEinvoiceOptions, displayCheck, displayMissingText, einvoiceOptionsSchema, einvoiceResult, einvoiceXml, htmlText, invoiceAmountText, invoiceLineOf, invoicePathSegments, invoiceSchema, invoiceSkeleton, invoiceToCii, locateJsonPath, resolveEinvoiceOptions, shownAmounts, } from './lib/einvoice/index.cjs';
-export type { CheckOptions, DisplayCheck, DisplayValue, EinvoiceDisplay, EinvoiceFlavour, EinvoiceMessage, EinvoiceOptions, EinvoiceOptionsInput, EinvoiceProfile, EinvoiceResult, EinvoiceValidation, EinvoiceXml, Identifier, Invoice, InvoiceAddress, InvoiceAllowance, InvoiceBreakdown, InvoiceCheck, InvoiceInput, InvoiceLine, InvoiceParty, InvoiceProblem, InvoiceProblemCode, InvoiceTax, JsonLocation, ResolvedEinvoice, VatCategory, } from './lib/einvoice/index.cjs';
+export { CII_GUIDELINES, CODE_LIST_RELEASE, DISPLAY_TERMS, EINVOICE_FLAVOURS, EINVOICE_FLAVOUR_NAMES, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILES, EINVOICE_PROFILE_NAMES, EINVOICE_SPEC_VERSIONS, EINVOICE_XML_NAME, EN16931_TERMS, INVOICE_DATA_KEY, VAT_CATEGORIES, capMessages, carriesTerm, checkInvoice, defaultEinvoiceOptions, displayCheck, displayMissingText, einvoiceOptionsSchema, einvoiceResult, einvoiceXml, htmlText, invoiceAmountText, invoiceLineOf, invoicePathSegments, invoiceSchema, invoiceSkeleton, invoiceToCii, locateJsonPath, resolveEinvoiceOptions, shownAmounts, } from './lib/einvoice/index.cjs';
+export type { CheckOptions, DisplayCheck, DisplayValue, EinvoiceDisplay, EinvoiceFlavour, EinvoiceMessage, EinvoiceOptions, EinvoiceOptionsInput, EinvoiceProfile, EinvoiceResult, EinvoiceTerm, EinvoiceValidation, EinvoiceXml, Identifier, Invoice, InvoiceAddress, InvoiceAllowance, InvoiceBreakdown, InvoiceCheck, InvoiceInput, InvoiceLine, InvoiceParty, InvoiceProblem, InvoiceProblemCode, InvoiceTax, JsonLocation, ResolvedEinvoice, VatCategory, } from './lib/einvoice/index.cjs';
 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';

package/types/index.d.ts

@@ -30,8 +30,8 @@ export type { ApplyResult, ChipKind, EditableRegion, EditItem, RegionChip, Regio
 export { resolveTranslation, translationTarget } from './lib/translation.js';
 export { DESIGN_LIMITS, DESIGN_VERSION, dataPathPattern, defaultLayer, designBytes, designOutputHash, designStarters, emitDesign, emptyDesign, genericFamily, googleFont, googleFonts, googleFontsUrl, imageIsEmpty, layerIdPattern, nearestWeight, nextLayerId, parseDesign, } from './lib/design/index.js';
 export type { BarcodeLayer, BarcodeSymbology, Binding, CanvasSize, DesignDocument, DesignLayer, DesignStarter, EmittedDesign, FontChoice, GoogleFont, ImageLayer, ImageSource, LayerBase, LayerType, Paint, ParsedDesign, QrLayer, Shadow, ShapeLayer, Stroke, TextFormat, TextItem, TextLayer, TextStyle, } from './lib/design/index.js';
-export { CII_GUIDELINES, CODE_LIST_RELEASE, DISPLAY_TERMS, EINVOICE_FLAVOURS, EINVOICE_FLAVOUR_NAMES, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILES, EINVOICE_PROFILE_NAMES, EINVOICE_SPEC_VERSIONS, EINVOICE_XML_NAME, INVOICE_DATA_KEY, VAT_CATEGORIES, capMessages, checkInvoice, defaultEinvoiceOptions, displayCheck, displayMissingText, einvoiceOptionsSchema, einvoiceResult, einvoiceXml, htmlText, invoiceAmountText, invoiceLineOf, invoicePathSegments, invoiceSchema, invoiceSkeleton, invoiceToCii, locateJsonPath, resolveEinvoiceOptions, shownAmounts, } from './lib/einvoice/index.js';
-export type { CheckOptions, DisplayCheck, DisplayValue, EinvoiceDisplay, EinvoiceFlavour, EinvoiceMessage, EinvoiceOptions, EinvoiceOptionsInput, EinvoiceProfile, EinvoiceResult, EinvoiceValidation, EinvoiceXml, Identifier, Invoice, InvoiceAddress, InvoiceAllowance, InvoiceBreakdown, InvoiceCheck, InvoiceInput, InvoiceLine, InvoiceParty, InvoiceProblem, InvoiceProblemCode, InvoiceTax, JsonLocation, ResolvedEinvoice, VatCategory, } from './lib/einvoice/index.js';
+export { CII_GUIDELINES, CODE_LIST_RELEASE, DISPLAY_TERMS, EINVOICE_FLAVOURS, EINVOICE_FLAVOUR_NAMES, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILES, EINVOICE_PROFILE_NAMES, EINVOICE_SPEC_VERSIONS, EINVOICE_XML_NAME, EN16931_TERMS, INVOICE_DATA_KEY, VAT_CATEGORIES, capMessages, carriesTerm, checkInvoice, defaultEinvoiceOptions, displayCheck, displayMissingText, einvoiceOptionsSchema, einvoiceResult, einvoiceXml, htmlText, invoiceAmountText, invoiceLineOf, invoicePathSegments, invoiceSchema, invoiceSkeleton, invoiceToCii, locateJsonPath, resolveEinvoiceOptions, shownAmounts, } from './lib/einvoice/index.js';
+export type { CheckOptions, DisplayCheck, DisplayValue, EinvoiceDisplay, EinvoiceFlavour, EinvoiceMessage, EinvoiceOptions, EinvoiceOptionsInput, EinvoiceProfile, EinvoiceResult, EinvoiceTerm, EinvoiceValidation, EinvoiceXml, Identifier, Invoice, InvoiceAddress, InvoiceAllowance, InvoiceBreakdown, InvoiceCheck, InvoiceInput, InvoiceLine, InvoiceParty, InvoiceProblem, InvoiceProblemCode, InvoiceTax, JsonLocation, ResolvedEinvoice, VatCategory, } from './lib/einvoice/index.js';
 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';

package/types/lib/einvoice/check.d.cts

@@ -25,7 +25,7 @@ export interface InvoiceProblem {
     /** The values `message` was built from. */
     args: Record<string, string | number>;
 }
-export type InvoiceProblemCode = 'missing' | 'invalid' | 'not_a_number' | 'decimals' | 'negative' | 'code_list' | 'date' | 'date_order' | 'scheme_required' | 'vat_id_prefix' | 'iban' | 'sum' | 'breakdown_missing' | 'breakdown_duplicate' | 'rate_required' | 'rate_positive' | 'rate_zero' | 'rate_forbidden' | 'amount_zero' | 'exemption_reason_required' | 'exemption_reason_forbidden' | 'seller_tax_id_required' | 'buyer_tax_id_required' | 'vat_id_forbidden' | 'only_category' | 'delivery_required' | 'account_required' | 'means_code_required' | 'due_or_terms_required' | 'seller_identifier_required' | 'siren_mismatch' | 'fr_seller_siren' | 'fr_buyer_siren' | 'fr_operation' | 'fr_vat_on_debits' | 'profile';
+export type InvoiceProblemCode = 'missing' | 'invalid' | 'not_a_number' | 'decimals' | 'negative' | 'code_list' | 'date' | 'date_order' | 'scheme_required' | 'vat_id_prefix' | 'iban' | 'sum' | 'breakdown_missing' | 'breakdown_duplicate' | 'rate_required' | 'rate_positive' | 'rate_zero' | 'rate_forbidden' | 'amount_zero' | 'exemption_reason_required' | 'exemption_reason_forbidden' | 'seller_tax_id_required' | 'buyer_tax_id_required' | 'vat_id_forbidden' | 'only_category' | 'delivery_required' | 'account_required' | 'means_code_required' | 'due_or_terms_required' | 'seller_identifier_required' | 'siren_mismatch' | 'fr_seller_siren' | 'fr_buyer_siren' | 'fr_operation' | 'fr_vat_on_debits' | 'fr_note' | 'fr_electronic_address' | 'fr_profile' | 'profile';
 export interface Identifier {
     value: string;
     scheme?: string;

package/types/lib/einvoice/check.d.ts

@@ -25,7 +25,7 @@ export interface InvoiceProblem {
     /** The values `message` was built from. */
     args: Record<string, string | number>;
 }
-export type InvoiceProblemCode = 'missing' | 'invalid' | 'not_a_number' | 'decimals' | 'negative' | 'code_list' | 'date' | 'date_order' | 'scheme_required' | 'vat_id_prefix' | 'iban' | 'sum' | 'breakdown_missing' | 'breakdown_duplicate' | 'rate_required' | 'rate_positive' | 'rate_zero' | 'rate_forbidden' | 'amount_zero' | 'exemption_reason_required' | 'exemption_reason_forbidden' | 'seller_tax_id_required' | 'buyer_tax_id_required' | 'vat_id_forbidden' | 'only_category' | 'delivery_required' | 'account_required' | 'means_code_required' | 'due_or_terms_required' | 'seller_identifier_required' | 'siren_mismatch' | 'fr_seller_siren' | 'fr_buyer_siren' | 'fr_operation' | 'fr_vat_on_debits' | 'profile';
+export type InvoiceProblemCode = 'missing' | 'invalid' | 'not_a_number' | 'decimals' | 'negative' | 'code_list' | 'date' | 'date_order' | 'scheme_required' | 'vat_id_prefix' | 'iban' | 'sum' | 'breakdown_missing' | 'breakdown_duplicate' | 'rate_required' | 'rate_positive' | 'rate_zero' | 'rate_forbidden' | 'amount_zero' | 'exemption_reason_required' | 'exemption_reason_forbidden' | 'seller_tax_id_required' | 'buyer_tax_id_required' | 'vat_id_forbidden' | 'only_category' | 'delivery_required' | 'account_required' | 'means_code_required' | 'due_or_terms_required' | 'seller_identifier_required' | 'siren_mismatch' | 'fr_seller_siren' | 'fr_buyer_siren' | 'fr_operation' | 'fr_vat_on_debits' | 'fr_note' | 'fr_electronic_address' | 'fr_profile' | 'profile';
 export interface Identifier {
     value: string;
     scheme?: string;

package/types/lib/einvoice/coverage.d.cts

@@ -0,0 +1,28 @@
+/**
+ * Which business terms of EN 16931 the `_invoice` block carries into the e-invoice, term by term
+ * (spec 17 §4.3): the fields of the block each one is written from, or none where the block does
+ * not carry it. The documentation's coverage page is generated from this list
+ * (`apps/docs/scripts/gen-einvoice.ts`), and `coverage.spec.ts` holds it to the schema both ways, so
+ * a field added to the block without its term fails there, and to what the profile `basic` leaves out.
+ *
+ * The 164 terms and their names are those of the English edition of EN 16931-1 (2017): BT-1 to BT-165,
+ * the standard has no BT-4. The names were taken from KoSIT's XRechnung semantic model
+ * (`itplr-kosit/xrechnung-visualization`, `src/xsd/xrechnung-semantic-model.xsd`, Apache-2.0), read on
+ * 9 October 2026, without the terms XRechnung adds of its own.
+ */
+/** A business term of EN 16931 and what the `_invoice` block writes it from. */
+export interface EinvoiceTerm {
+    /** `BT-1` to `BT-165`. */
+    term: string;
+    /** Its name in the English edition of the standard. */
+    name: string;
+    /** Where the block takes it from, dotted, `[]` for every item of a list; empty where it does not. */
+    fields: readonly string[];
+    /** Written from an e-invoice option rather than a field of the block. */
+    option?: 'profile';
+    /** Written in the profile `en16931` only: `basic` leaves it out. */
+    en16931Only?: true;
+}
+export declare const EN16931_TERMS: readonly EinvoiceTerm[];
+/** Whether an e-invoice from the block can carry the term. */
+export declare const carriesTerm: (term: EinvoiceTerm) => boolean;

package/types/lib/einvoice/coverage.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Which business terms of EN 16931 the `_invoice` block carries into the e-invoice, term by term
+ * (spec 17 §4.3): the fields of the block each one is written from, or none where the block does
+ * not carry it. The documentation's coverage page is generated from this list
+ * (`apps/docs/scripts/gen-einvoice.ts`), and `coverage.spec.ts` holds it to the schema both ways, so
+ * a field added to the block without its term fails there, and to what the profile `basic` leaves out.
+ *
+ * The 164 terms and their names are those of the English edition of EN 16931-1 (2017): BT-1 to BT-165,
+ * the standard has no BT-4. The names were taken from KoSIT's XRechnung semantic model
+ * (`itplr-kosit/xrechnung-visualization`, `src/xsd/xrechnung-semantic-model.xsd`, Apache-2.0), read on
+ * 9 October 2026, without the terms XRechnung adds of its own.
+ */
+/** A business term of EN 16931 and what the `_invoice` block writes it from. */
+export interface EinvoiceTerm {
+    /** `BT-1` to `BT-165`. */
+    term: string;
+    /** Its name in the English edition of the standard. */
+    name: string;
+    /** Where the block takes it from, dotted, `[]` for every item of a list; empty where it does not. */
+    fields: readonly string[];
+    /** Written from an e-invoice option rather than a field of the block. */
+    option?: 'profile';
+    /** Written in the profile `en16931` only: `basic` leaves it out. */
+    en16931Only?: true;
+}
+export declare const EN16931_TERMS: readonly EinvoiceTerm[];
+/** Whether an e-invoice from the block can carry the term. */
+export declare const carriesTerm: (term: EinvoiceTerm) => boolean;

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

@@ -8,6 +8,7 @@ import { type Invoice, type InvoiceProblem } from './check.cjs';
 import type { EinvoiceFlavour, EinvoiceProfile } from './schema.cjs';
 export { checkInvoice, type CheckOptions, type Identifier, type Invoice, type InvoiceAddress, type InvoiceAllowance, type InvoiceBreakdown, type InvoiceCheck, type InvoiceLine, type InvoiceParty, type InvoiceProblem, type InvoiceProblemCode, type InvoiceTax, } from './check.cjs';
 export { CII_GUIDELINES, EINVOICE_XML_NAME, invoiceToCii } from './cii.cjs';
+export { EN16931_TERMS, carriesTerm, type EinvoiceTerm } from './coverage.cjs';
 export { CODE_LIST_RELEASE } from './codes.generated.cjs';
 export { DISPLAY_TERMS, displayCheck, displayMissingText, shownAmounts, type DisplayCheck, type DisplayValue, } from './display.cjs';
 export { EINVOICE_FLAVOURS, EINVOICE_PROFILES, VAT_CATEGORIES, defaultEinvoiceOptions, einvoiceOptionsSchema, invoiceSchema, resolveEinvoiceOptions, type EinvoiceFlavour, type EinvoiceOptions, type EinvoiceOptionsInput, type EinvoiceProfile, type InvoiceInput, type ResolvedEinvoice, type VatCategory, } from './schema.cjs';

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

@@ -8,6 +8,7 @@ import { type Invoice, type InvoiceProblem } from './check.js';
 import type { EinvoiceFlavour, EinvoiceProfile } from './schema.js';
 export { checkInvoice, type CheckOptions, type Identifier, type Invoice, type InvoiceAddress, type InvoiceAllowance, type InvoiceBreakdown, type InvoiceCheck, type InvoiceLine, type InvoiceParty, type InvoiceProblem, type InvoiceProblemCode, type InvoiceTax, } from './check.js';
 export { CII_GUIDELINES, EINVOICE_XML_NAME, invoiceToCii } from './cii.js';
+export { EN16931_TERMS, carriesTerm, type EinvoiceTerm } from './coverage.js';
 export { CODE_LIST_RELEASE } from './codes.generated.js';
 export { DISPLAY_TERMS, displayCheck, displayMissingText, shownAmounts, type DisplayCheck, type DisplayValue, } from './display.js';
 export { EINVOICE_FLAVOURS, EINVOICE_PROFILES, VAT_CATEGORIES, defaultEinvoiceOptions, einvoiceOptionsSchema, invoiceSchema, resolveEinvoiceOptions, type EinvoiceFlavour, type EinvoiceOptions, type EinvoiceOptionsInput, type EinvoiceProfile, type InvoiceInput, type ResolvedEinvoice, type VatCategory, } from './schema.js';

package/types/lib/einvoice/report.d.cts

@@ -24,6 +24,20 @@ export interface EinvoiceValidation {
     messages: EinvoiceMessage[];
     /** More findings than the render keeps. */
     truncated?: boolean;
+    /**
+     * The validator's own id for this report, which its log names too. Absent in reports from before
+     * 2026-10-09, like the three fields below.
+     */
+    id?: string;
+    /** The versions of the validator's parts that judged the file: `mustang`, `verapdf`, `pdfbox`. */
+    versions?: Record<string, string>;
+    /** SHA-256 of the XML that was judged, which is the XML inside the PDF. */
+    xml_sha256?: string;
+    /**
+     * SHA-256 of the PDF that was judged: the delivered file when the render succeeded. `null` when the
+     * validator ended before there was a converted file.
+     */
+    pdf_sha256?: string | null;
 }
 export interface EinvoiceDisplay {
     /** The business terms looked for in the text of the PDF (`BT-1`, `BT-112`). */

package/types/lib/einvoice/report.d.ts

@@ -24,6 +24,20 @@ export interface EinvoiceValidation {
     messages: EinvoiceMessage[];
     /** More findings than the render keeps. */
     truncated?: boolean;
+    /**
+     * The validator's own id for this report, which its log names too. Absent in reports from before
+     * 2026-10-09, like the three fields below.
+     */
+    id?: string;
+    /** The versions of the validator's parts that judged the file: `mustang`, `verapdf`, `pdfbox`. */
+    versions?: Record<string, string>;
+    /** SHA-256 of the XML that was judged, which is the XML inside the PDF. */
+    xml_sha256?: string;
+    /**
+     * SHA-256 of the PDF that was judged: the delivered file when the render succeeded. `null` when the
+     * validator ended before there was a converted file.
+     */
+    pdf_sha256?: string | null;
 }
 export interface EinvoiceDisplay {
     /** The business terms looked for in the text of the PDF (`BT-1`, `BT-112`). */