@deliverart/order-receipt
v0.1.2
Published
Compile Deliverart orders and receipt templates into transport-neutral ePOS documents
Readme
@deliverart/order-receipt
Compiles a Deliverart order and a versioned receipt template into an immutable EposDocument.
The package is deliberately independent from React, MUI, routing, authentication, and printer transports. HUB uses the same compiler for the canvas preview and for the final print job, so what an operator sees is the document sent to Epson.
receiptProfileGeometry(profile) exposes the physical 203 dpi paper width, printable width, and line columns for every supported 80 mm and 58 mm profile. Preview consumers pass this geometry to @deliverart/epos; wrapping and physical character cells therefore share one profile definition.
import {
createOrderReceiptSnapshot,
compileOrderReceipt,
} from "@deliverart/order-receipt";
const snapshot = createOrderReceiptSnapshot(order, {
locale: printSettings.printLocale,
currency: pointOfSale.settings.currency,
});
const { document, warnings } = compileOrderReceipt(
template.definition,
snapshot,
{
profile: printer.receiptProfile,
timezone: pointOfSale.timezone,
logo,
}
);The snapshot resolves main items, nested modifier choices, bundle children, removals, notes, discounts, fees, payment details, customer data, and delivery data before compilation. Compilation never performs API calls and returns structured warnings for blocks whose data cannot be rendered.
The items block renders a receipt hierarchy rather than a flat list. Top-level products and bundles start at column zero; modifier names, selected products, and nested choices each advance one indentation level. Variants stay beside the selected product in parentheses, item notes follow that item's complete configuration, and only top-level item totals are printed on a separate right-aligned line. Preview and physical output therefore preserve the same bundle structure.
Time, customer, address, and note blocks preserve the legacy inline rendering by default. With fieldLayout: "stacked", each visible field heading is emitted with labelStyle, followed on a new line by its value using style. Address continuation lines use the value style without fabricated headings. The compiler emits alignment, scale, and text decoration commands before every heading and value so mixed typography behaves identically in previews and on printers.
Order-time blocks render the localized date and time by default. Setting showDate: false removes only the calendar portion and keeps the localized hour and minute in both inline and stacked layouts. Missing and null values retain the legacy date-and-time output.
