@formfeed/engine 0.3.19 → 0.3.21

package/index.cjs

@@ -47,10 +47,12 @@ __export(index_exports, {
   DefaultHelperRegistry: () => DefaultHelperRegistry,
   EINVOICE_FLAVOURS: () => EINVOICE_FLAVOURS,
   EINVOICE_FLAVOUR_NAMES: () => EINVOICE_FLAVOUR_NAMES,
+  EINVOICE_HEADER_LENGTH: () => EINVOICE_HEADER_LENGTH,
   EINVOICE_MAX_MESSAGES: () => EINVOICE_MAX_MESSAGES,
   EINVOICE_PROFILES: () => EINVOICE_PROFILES,
   EINVOICE_PROFILE_NAMES: () => EINVOICE_PROFILE_NAMES,
   EINVOICE_SPEC_VERSIONS: () => EINVOICE_SPEC_VERSIONS,
+  EINVOICE_TEST_NOTE: () => EINVOICE_TEST_NOTE,
   EINVOICE_XML_NAME: () => EINVOICE_XML_NAME,
   EN16931_TERMS: () => EN16931_TERMS,
   EPC_MAX_BYTES: () => EPC_MAX_BYTES,
@@ -106,6 +108,7 @@ __export(index_exports, {
   editAttribute: () => editAttribute,
   editableRegion: () => editableRegion,
   editableRegionAt: () => editableRegionAt,
+  einvoiceHeaderValue: () => einvoiceHeaderValue,
   einvoiceOptionsSchema: () => einvoiceOptionsSchema,
   einvoiceResult: () => einvoiceResult,
   einvoiceXml: () => einvoiceXml,
@@ -9785,6 +9788,7 @@ var CII_GUIDELINES = {
   en16931: "urn:cen.eu:en16931:2017"
 };
 var EINVOICE_XML_NAME = "factur-x.xml";
+var EINVOICE_TEST_NOTE = "TEST \u2013 keine Rechnung / test render, not an invoice";
 function leaf(name, text4, attributes) {
   if (text4 === void 0 || text4 === "") return void 0;
   const kept = Object.entries(attributes ?? {}).filter(
@@ -10030,6 +10034,7 @@ function invoiceToCii(invoice, options) {
         leaf("ram:ID", invoice.number),
         leaf("ram:TypeCode", invoice.type_code),
         date("ram:IssueDateTime", invoice.issue_date),
+        options.test ? group2("ram:IncludedNote", [leaf("ram:Content", EINVOICE_TEST_NOTE)]) : void 0,
         ...invoice.notes.map(
           (note2) => group2("ram:IncludedNote", [
             leaf("ram:Content", note2.text),
@@ -10943,6 +10948,33 @@ function einvoiceResult(options, specVersion, validation, display) {
     display: display ? { checked: display.checked, missing: display.missing } : null
   };
 }
+var EINVOICE_HEADER_LENGTH = 8e3;
+function einvoiceHeaderValue(result, limit = EINVOICE_HEADER_LENGTH) {
+  const encode = (report) => encodeURIComponent(JSON.stringify(report));
+  const full = encode(result);
+  const validation = result.validation;
+  if (full.length <= limit || !validation) return full;
+  let messages = validation.messages.map((message) => ({
+    ...message,
+    location: null
+  }));
+  const cut = () => ({
+    ...result,
+    validation: { ...validation, messages, truncated: true }
+  });
+  let value = encode(cut());
+  while (value.length > limit && messages.length > 0) {
+    let last = messages.length - 1;
+    for (let i = messages.length - 1; i >= 0; i--)
+      if (messages[i].severity !== "error") {
+        last = i;
+        break;
+      }
+    messages = messages.filter((_, i) => i !== last);
+    value = encode(cut());
+  }
+  return value;
+}
 var EINVOICE_FLAVOUR_NAMES = {
   "factur-x": "Factur-X",
   zugferd: "ZUGFeRD"
@@ -11146,7 +11178,7 @@ function einvoiceXml(data, options) {
         }
       ]
     };
-  const check = checkInvoice(block, options);
+  const check = checkInvoice(block, { profile: options.profile });
   if (!check.ok) return { ok: false, problems: check.problems };
   return {
     ok: true,

package/index.js

@@ -9565,6 +9565,7 @@ var CII_GUIDELINES = {
   en16931: "urn:cen.eu:en16931:2017"
 };
 var EINVOICE_XML_NAME = "factur-x.xml";
+var EINVOICE_TEST_NOTE = "TEST \u2013 keine Rechnung / test render, not an invoice";
 function leaf(name, text4, attributes) {
   if (text4 === void 0 || text4 === "") return void 0;
   const kept = Object.entries(attributes ?? {}).filter(
@@ -9810,6 +9811,7 @@ function invoiceToCii(invoice, options) {
         leaf("ram:ID", invoice.number),
         leaf("ram:TypeCode", invoice.type_code),
         date("ram:IssueDateTime", invoice.issue_date),
+        options.test ? group2("ram:IncludedNote", [leaf("ram:Content", EINVOICE_TEST_NOTE)]) : void 0,
         ...invoice.notes.map(
           (note2) => group2("ram:IncludedNote", [
             leaf("ram:Content", note2.text),
@@ -10723,6 +10725,33 @@ function einvoiceResult(options, specVersion, validation, display) {
     display: display ? { checked: display.checked, missing: display.missing } : null
   };
 }
+var EINVOICE_HEADER_LENGTH = 8e3;
+function einvoiceHeaderValue(result, limit = EINVOICE_HEADER_LENGTH) {
+  const encode = (report) => encodeURIComponent(JSON.stringify(report));
+  const full = encode(result);
+  const validation = result.validation;
+  if (full.length <= limit || !validation) return full;
+  let messages = validation.messages.map((message) => ({
+    ...message,
+    location: null
+  }));
+  const cut = () => ({
+    ...result,
+    validation: { ...validation, messages, truncated: true }
+  });
+  let value = encode(cut());
+  while (value.length > limit && messages.length > 0) {
+    let last = messages.length - 1;
+    for (let i = messages.length - 1; i >= 0; i--)
+      if (messages[i].severity !== "error") {
+        last = i;
+        break;
+      }
+    messages = messages.filter((_, i) => i !== last);
+    value = encode(cut());
+  }
+  return value;
+}
 var EINVOICE_FLAVOUR_NAMES = {
   "factur-x": "Factur-X",
   zugferd: "ZUGFeRD"
@@ -10926,7 +10955,7 @@ function einvoiceXml(data, options) {
         }
       ]
     };
-  const check = checkInvoice(block, options);
+  const check = checkInvoice(block, { profile: options.profile });
   if (!check.ok) return { ok: false, problems: check.problems };
   return {
     ok: true,
@@ -14159,10 +14188,12 @@ export {
   DefaultHelperRegistry,
   EINVOICE_FLAVOURS,
   EINVOICE_FLAVOUR_NAMES,
+  EINVOICE_HEADER_LENGTH,
   EINVOICE_MAX_MESSAGES,
   EINVOICE_PROFILES,
   EINVOICE_PROFILE_NAMES,
   EINVOICE_SPEC_VERSIONS,
+  EINVOICE_TEST_NOTE,
   EINVOICE_XML_NAME,
   EN16931_TERMS,
   EPC_MAX_BYTES,
@@ -14218,6 +14249,7 @@ export {
   editAttribute,
   editableRegion,
   editableRegionAt,
+  einvoiceHeaderValue,
   einvoiceOptionsSchema,
   einvoiceResult,
   einvoiceXml,

package/package.json

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

package/types/index.d.cts

@@ -30,7 +30,7 @@ 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, 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 { CII_GUIDELINES, CODE_LIST_RELEASE, DISPLAY_TERMS, EINVOICE_FLAVOURS, EINVOICE_FLAVOUR_NAMES, EINVOICE_HEADER_LENGTH, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILES, EINVOICE_PROFILE_NAMES, EINVOICE_SPEC_VERSIONS, EINVOICE_TEST_NOTE, EINVOICE_XML_NAME, EN16931_TERMS, INVOICE_DATA_KEY, VAT_CATEGORIES, capMessages, carriesTerm, checkInvoice, defaultEinvoiceOptions, displayCheck, displayMissingText, einvoiceHeaderValue, 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';

package/types/index.d.ts

@@ -30,7 +30,7 @@ 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, 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 { CII_GUIDELINES, CODE_LIST_RELEASE, DISPLAY_TERMS, EINVOICE_FLAVOURS, EINVOICE_FLAVOUR_NAMES, EINVOICE_HEADER_LENGTH, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILES, EINVOICE_PROFILE_NAMES, EINVOICE_SPEC_VERSIONS, EINVOICE_TEST_NOTE, EINVOICE_XML_NAME, EN16931_TERMS, INVOICE_DATA_KEY, VAT_CATEGORIES, capMessages, carriesTerm, checkInvoice, defaultEinvoiceOptions, displayCheck, displayMissingText, einvoiceHeaderValue, 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';

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

@@ -13,6 +13,15 @@ import type { EinvoiceProfile } from './schema.cjs';
 export declare const CII_GUIDELINES: Record<EinvoiceProfile, string>;
 /** The name the XML has inside the PDF, under either of the specification's two names. */
 export declare const EINVOICE_XML_NAME = "factur-x.xml";
+/**
+ * The first note (BT-22) of a test render's invoice, on every plan (plan 25 §5.2): an XML carries
+ * no page mark, so the invoice says it of itself. No subject code: France's rules, which hold the
+ * subject codes of an invoice between French businesses, accept the note without one (measured
+ * with the sidecar on 2026-10-27). The wording waits for the Steuerberater (plan 25 §5.5).
+ */
+export declare const EINVOICE_TEST_NOTE = "TEST \u2013 keine Rechnung / test render, not an invoice";
 export declare function invoiceToCii(invoice: Invoice, options: {
     profile: EinvoiceProfile;
+    /** A test render's invoice: its first note says it is none (`EINVOICE_TEST_NOTE`). */
+    test?: boolean;
 }): string;

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

@@ -13,6 +13,15 @@ import type { EinvoiceProfile } from './schema.js';
 export declare const CII_GUIDELINES: Record<EinvoiceProfile, string>;
 /** The name the XML has inside the PDF, under either of the specification's two names. */
 export declare const EINVOICE_XML_NAME = "factur-x.xml";
+/**
+ * The first note (BT-22) of a test render's invoice, on every plan (plan 25 §5.2): an XML carries
+ * no page mark, so the invoice says it of itself. No subject code: France's rules, which hold the
+ * subject codes of an invoice between French businesses, accept the note without one (measured
+ * with the sidecar on 2026-10-27). The wording waits for the Steuerberater (plan 25 §5.5).
+ */
+export declare const EINVOICE_TEST_NOTE = "TEST \u2013 keine Rechnung / test render, not an invoice";
 export declare function invoiceToCii(invoice: Invoice, options: {
     profile: EinvoiceProfile;
+    /** A test render's invoice: its first note says it is none (`EINVOICE_TEST_NOTE`). */
+    test?: boolean;
 }): string;

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

@@ -7,13 +7,13 @@
 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 { CII_GUIDELINES, EINVOICE_TEST_NOTE, 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';
 export { invoicePathSegments, locateJsonPath, type JsonLocation, } from './locate.cjs';
-export { EINVOICE_FLAVOUR_NAMES, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILE_NAMES, capMessages, einvoiceResult, invoiceLineOf, type EinvoiceDisplay, type EinvoiceMessage, type EinvoiceResult, type EinvoiceValidation, } from './report.cjs';
+export { EINVOICE_FLAVOUR_NAMES, EINVOICE_HEADER_LENGTH, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILE_NAMES, capMessages, einvoiceHeaderValue, einvoiceResult, invoiceLineOf, type EinvoiceDisplay, type EinvoiceMessage, type EinvoiceResult, type EinvoiceValidation, } from './report.cjs';
 export { htmlText } from './html-text.cjs';
 export { invoiceSkeleton } from './skeleton.cjs';
 /** Where the invoice sits in the render data. */
@@ -43,4 +43,6 @@ export type EinvoiceXml = {
  */
 export declare function einvoiceXml(data: unknown, options: {
     profile: EinvoiceProfile;
+    /** A test render's invoice, whose first note says it is none (`EINVOICE_TEST_NOTE`). */
+    test?: boolean;
 }): EinvoiceXml;

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

@@ -7,13 +7,13 @@
 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 { CII_GUIDELINES, EINVOICE_TEST_NOTE, 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';
 export { invoicePathSegments, locateJsonPath, type JsonLocation, } from './locate.js';
-export { EINVOICE_FLAVOUR_NAMES, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILE_NAMES, capMessages, einvoiceResult, invoiceLineOf, type EinvoiceDisplay, type EinvoiceMessage, type EinvoiceResult, type EinvoiceValidation, } from './report.js';
+export { EINVOICE_FLAVOUR_NAMES, EINVOICE_HEADER_LENGTH, EINVOICE_MAX_MESSAGES, EINVOICE_PROFILE_NAMES, capMessages, einvoiceHeaderValue, einvoiceResult, invoiceLineOf, type EinvoiceDisplay, type EinvoiceMessage, type EinvoiceResult, type EinvoiceValidation, } from './report.js';
 export { htmlText } from './html-text.js';
 export { invoiceSkeleton } from './skeleton.js';
 /** Where the invoice sits in the render data. */
@@ -43,4 +43,6 @@ export type EinvoiceXml = {
  */
 export declare function einvoiceXml(data: unknown, options: {
     profile: EinvoiceProfile;
+    /** A test render's invoice, whose first note says it is none (`EINVOICE_TEST_NOTE`). */
+    test?: boolean;
 }): EinvoiceXml;

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

@@ -62,6 +62,21 @@ export declare const EINVOICE_MAX_MESSAGES = 50;
 export declare function capMessages(messages: readonly EinvoiceMessage[], max?: number): Pick<EinvoiceValidation, 'messages' | 'truncated'>;
 /** The result of a render that got as far as `validation` and `display` say. */
 export declare function einvoiceResult(options: Pick<EinvoiceOptions, 'profile' | 'flavour'>, specVersion: string, validation: EinvoiceValidation | null, display: DisplayCheck | null): EinvoiceResult;
+/**
+ * How long the report may be as a header value. A proxy answers a response whose headers grow past a
+ * few kilobytes with 502, and the e-invoice's report shares this room with a PDF/UA verdict
+ * (`ACCESSIBILITY_HEADER_LENGTH`) where a render made both.
+ */
+export declare const EINVOICE_HEADER_LENGTH = 8000;
+/**
+ * The report as a response header carries it: the editor's true render reads the file from the body
+ * and the report from `X-Formfeed-Einvoice`, percent-encoded because a validator's message is not
+ * always ASCII. A report too long for `limit` loses, in this order, every finding's place, then the
+ * findings from the last, warnings before errors, and says so in `truncated` (plan 25 §5.5). What
+ * makes it a verdict always arrives: whether the file is valid, the rule set, the validator's id and
+ * versions, the hashes of the bytes it judged, and the display check.
+ */
+export declare function einvoiceHeaderValue(result: EinvoiceResult, limit?: number): string;
 /** The names a person reads: `Factur-X` and `EN 16931` for `factur-x` and `en16931`. */
 export declare const EINVOICE_FLAVOUR_NAMES: Record<EinvoiceFlavour, string>;
 export declare const EINVOICE_PROFILE_NAMES: Record<EinvoiceProfile, string>;

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

@@ -62,6 +62,21 @@ export declare const EINVOICE_MAX_MESSAGES = 50;
 export declare function capMessages(messages: readonly EinvoiceMessage[], max?: number): Pick<EinvoiceValidation, 'messages' | 'truncated'>;
 /** The result of a render that got as far as `validation` and `display` say. */
 export declare function einvoiceResult(options: Pick<EinvoiceOptions, 'profile' | 'flavour'>, specVersion: string, validation: EinvoiceValidation | null, display: DisplayCheck | null): EinvoiceResult;
+/**
+ * How long the report may be as a header value. A proxy answers a response whose headers grow past a
+ * few kilobytes with 502, and the e-invoice's report shares this room with a PDF/UA verdict
+ * (`ACCESSIBILITY_HEADER_LENGTH`) where a render made both.
+ */
+export declare const EINVOICE_HEADER_LENGTH = 8000;
+/**
+ * The report as a response header carries it: the editor's true render reads the file from the body
+ * and the report from `X-Formfeed-Einvoice`, percent-encoded because a validator's message is not
+ * always ASCII. A report too long for `limit` loses, in this order, every finding's place, then the
+ * findings from the last, warnings before errors, and says so in `truncated` (plan 25 §5.5). What
+ * makes it a verdict always arrives: whether the file is valid, the rule set, the validator's id and
+ * versions, the hashes of the bytes it judged, and the display check.
+ */
+export declare function einvoiceHeaderValue(result: EinvoiceResult, limit?: number): string;
 /** The names a person reads: `Factur-X` and `EN 16931` for `factur-x` and `en16931`. */
 export declare const EINVOICE_FLAVOUR_NAMES: Record<EinvoiceFlavour, string>;
 export declare const EINVOICE_PROFILE_NAMES: Record<EinvoiceProfile, string>;