@tallyui/pos 0.1.0 → 3.0.0-next.0

package/src/receipt/build-receipt-data.ts

@@ -1,18 +1,27 @@
-import type { Order } from '../order/types';
+import type { Discount, SentOrder } from '../order/types';
+import { roundMicrosToMinor, taxLinesByRate } from '../tax/exact';
 import type { ReceiptConfig, ReceiptData } from './types';
 
-export function buildReceiptData(order: Order, config: ReceiptConfig): ReceiptData {
-  const taxByRate = new Map<number, number>();
-  for (const line of order.lineItems) {
-    const existing = taxByRate.get(line.taxRate) ?? 0;
-    taxByRate.set(line.taxRate, existing + line.taxAmount);
-  }
+export function buildReceiptData(order: SentOrder, config: ReceiptConfig): ReceiptData {
+  // Drops the shared helper's `netMinor` (the Z report's own use): the receipt's tax summary
+  // never showed it, and an exact-shape test elsewhere in this package pins that.
+  const taxLines = taxLinesByRate(order.lineItems, order.taxMinor, config.taxLabels, order.taxRounding).map(
+    ({ label, code, ratePpm, amountMinor }) => ({ label, code, ratePpm, amountMinor }),
+  );
 
-  const taxLines = Array.from(taxByRate.entries()).map(([rate, amount]) => ({
-    label: config.taxLabels?.[rate] ?? `Tax ${Math.round(rate * 100)}%`,
-    rate,
-    amount: Math.round(amount * 100) / 100,
-  }));
+  // Every receipt line is shown in the order's mode. A line whose price had the other mode is
+  // converted by its tax share as the order total rounds it: the rounded running tax sum,
+  // started from the exclusive lines the order already rounds, so the shares add up exactly.
+  let taxSoFar = order.lineItems.reduce(
+    (sum, li) => li.taxInclusive || li.priceTaxModeConverted ? sum : sum + BigInt(li.taxMicros), 0n);
+  const lineTotals = order.lineItems.map((li) => {
+    if (!li.priceTaxModeConverted) return li.netMinor;
+    const share = roundMicrosToMinor(taxSoFar + BigInt(li.taxMicros)) - roundMicrosToMinor(taxSoFar);
+    taxSoFar += BigInt(li.taxMicros);
+    return li.taxInclusive ? li.netMinor - share : li.netMinor + share;
+  });
+  const label = (d: Discount) => d.label ?? d.couponCode ?? `${d.type} discount`;
+  const customer = order.customer?.name || order.customer?.email;
 
   return {
     header: {
@@ -21,32 +30,39 @@ export function buildReceiptData(order: Order, config: ReceiptConfig): ReceiptDa
       orderNumber: order.id,
       date: order.createdAt,
       cashier: config.cashier,
+      ...(customer ? { customer } : {}),
       register: config.register,
     },
-    lineItems: order.lineItems.map((li) => ({
+    lineItems: order.lineItems.map((li, index) => ({
       name: li.name,
       sku: li.sku,
       quantity: li.quantity,
-      unitPrice: li.price,
-      lineTotal: li.lineTotal,
+      unitPriceMinor: li.unitPriceMinor,
+      lineTotalMinor: lineTotals[index],
+      // Line plus allocated order discounts, in the line's own mode; lineTotalMinor is already after it (ADR-062).
+      ...(li.discountMinor > 0 ? { discountMinor: li.discountMinor } : {}),
+      displayAmountMinor: order.display.lines[index].amountMinor,
+      displayDiscounts: order.display.lines[index].discounts.map((row, i) => ({ label: label(li.discounts[i]), amountMinor: row.amountMinor })),
     })),
     discounts: order.discounts.map((d) => ({
-      label: d.label ?? d.couponCode ?? `${d.type} discount`,
-      amount: d.amount,
+      label: label(d),
+      amountMinor: d.amountMinor,
     })),
+    orderDiscountMinor: order.display.orderDiscountMinor,
     totals: {
-      subtotal: order.subtotal,
-      discountTotal: order.discountTotal,
+      taxInclusive: order.display.taxInclusive,
+      subtotalMinor: order.display.subtotalMinor,
+      discountMinor: order.display.discountMinor,
       taxLines,
-      taxTotal: order.taxTotal,
-      total: order.total,
+      taxMinor: order.display.taxMinor,
+      totalMinor: order.display.totalMinor,
     },
     payments: order.payments.map((p) => ({
       method: p.method,
-      amount: p.amount,
+      amountMinor: p.amountMinor,
       reference: p.reference,
     })),
-    changeDue: order.changeDue,
+    changeDueMinor: order.changeDueMinor,
     footer: {
       note: order.note || undefined,
       barcode: order.id,

package/src/receipt/types.ts

@@ -2,8 +2,12 @@ export interface ReceiptLineItem {
   name: string;
   sku: string;
   quantity: number;
-  unitPrice: number;
-  lineTotal: number;
+  unitPriceMinor: number;
+  /** After every discount, including the line's order share, in the order's mode. Not the figure to print above the subtotal: use displayAmountMinor. */
+  lineTotalMinor: number;
+  discountMinor?: number;     // this line's discounts, already taken off lineTotalMinor; absent when 0
+  displayAmountMinor: number; // before any discount, in the display mode; Σ = totals.subtotalMinor (ADR-063)
+  displayDiscounts: { label: string; amountMinor: number }[]; // this line's own discounts, in the display mode
 }
 
 export interface ReceiptData {
@@ -13,19 +17,22 @@ export interface ReceiptData {
     orderNumber: string;
     date: string;
     cashier?: string;
+    customer?: string;
     register?: string;
   };
   lineItems: ReceiptLineItem[];
-  discounts: { label: string; amount: number }[];
+  discounts: { label: string; amountMinor: number }[];
+  orderDiscountMinor: number;   // the order discounts as one row, in the display mode; + Σ displayDiscounts = totals.discountMinor
   totals: {
-    subtotal: number;
-    discountTotal: number;
-    taxLines: { label: string; rate: number; amount: number }[];
-    taxTotal: number;
-    total: number;
+    taxInclusive: boolean;      // from order.display: tax is added (false) or included (true)
+    subtotalMinor: number;      // order.display.subtotalMinor: before discounts, in the display mode
+    discountMinor: number;      // order.display.discountMinor: every discount, in the display mode (>= 0)
+    taxLines: { label: string; code?: string; ratePpm: number; amountMinor: number }[];
+    taxMinor: number;           // order.display.taxMinor
+    totalMinor: number;         // order.display.totalMinor
   };
-  payments: { method: string; amount: number; reference?: string }[];
-  changeDue: number;
+  payments: { method: string; amountMinor: number; reference?: string }[];
+  changeDueMinor: number;
   footer: {
     note?: string;
     barcode?: string;

package/src/register/__fixtures__/closure-local-row.json

@@ -0,0 +1,61 @@
+{
+  "id": "closure-fixture",
+  "session_id": "session-fixture",
+  "register_id": "register-fixture",
+  "store_key": "1",
+  "business_day": "2026-09-11",
+  "closed_by": "1",
+  "corrections_count": 0,
+  "number": 42,
+  "opened_at": "2026-09-11T08:00:00Z",
+  "closed_at": "2026-09-11T17:00:00Z",
+  "till_expected": { "cash": 18000, "card": 12000 },
+  "expected": { "cash": 18000, "card": 12000 },
+  "counted": { "cash": 17800, "card": 12000 },
+  "variance": { "cash": -200, "card": 0 },
+  "period_sales_total_minor": 25000,
+  "period_refunds_total_minor": 5000,
+  "perpetual_sales_total_minor": 525000,
+  "perpetual_refunds_total_minor": 25000,
+  "unsynced_count": 2,
+  "unsynced_total_minor": 1200,
+  "software_version": "preview",
+  "breakdowns": {
+    "currency": "USD",
+    "transaction_count": 12,
+    "refund_count": 2,
+    "cashiers": [{ "id": "1", "name": "Alex" }],
+    "register_name": "Main register",
+    "opened_by": "1",
+    "approved_by": "1",
+    "opened_by_name": "Alex",
+    "closed_by_name": "Alex",
+    "approved_by_name": "Alex",
+    "payment_methods": {
+      "cash": { "sales_minor": 13000, "refunds_minor": 5000 },
+      "card": { "sales_minor": 12000, "refunds_minor": 0 }
+    },
+    "tax_rates": {
+      "vat": { "name": "VAT 20%", "net_minor": 16667, "tax_minor": 3333, "gross_minor": 20000 }
+    },
+    "opening_float": { "expected_minor": 10000, "counted_minor": 10000, "variance_minor": 0 },
+    "movements": [
+      {
+        "id": "movement-fixture",
+        "type": "paid_out",
+        "amountMinor": 500,
+        "reason": "Petty cash",
+        "created_at_gmt": "2026-09-11T10:00:00Z",
+        "created_by": "1",
+        "voids": null,
+        "voided_by": "sample-void"
+      }
+    ]
+  },
+  "order_ids": [],
+  "movement_ids": [],
+  "server_closure_id": null,
+  "printed_at": null,
+  "print_count": 0,
+  "number_retried": false
+}

package/src/register/__fixtures__/closure.json

@@ -0,0 +1,197 @@
+{
+  "closure": {
+    "number": 42,
+    "has_sales": true,
+    "has_payment_methods": true,
+    "has_tax_rates": true,
+    "has_perpetual": true,
+    "has_movements": true,
+
+    "store_id": 1,
+    "opened_at_gmt": "2026-09-11 08:00:00",
+    "closed_at_gmt": "2026-09-11 17:00:00",
+    "opened_by": 1,
+    "closed_by": 1,
+    "approved_by": 1,
+    "expected": {
+      "cash": "180.0000",
+      "card": "120.0000"
+    },
+    "counted": {
+      "cash": "178.0000",
+      "card": "120.0000"
+    },
+    "variance": {
+      "cash": "-2.0000",
+      "card": "0.0000"
+    },
+    "period_sales_total": "250.0000",
+    "period_refunds_total": "50.0000",
+    "perpetual_sales_total": "5250.0000",
+    "perpetual_refunds_total": "250.0000",
+    "unsynced_count": 2,
+    "unsynced_total": "12.0000",
+    "breakdowns": {
+      "currency": "USD",
+      "payment_methods": [
+        {
+          "method": "cash",
+          "name": "Cash",
+          "sales": "130.0000",
+          "refunds": "50.0000",
+          "sales_display": "$130.00",
+          "refunds_display": "$50.00"
+        },
+        {
+          "method": "card",
+          "name": "Card",
+          "sales": "120.0000",
+          "refunds": "0.0000",
+          "sales_display": "$120.00",
+          "refunds_display": "$0.00"
+        }
+      ],
+      "tax_rates": [
+        {
+          "name": "VAT 20%",
+          "net": "166.6667",
+          "tax": "33.3333",
+          "gross": "200.0000",
+          "net_display": "$166.67",
+          "tax_display": "$33.33",
+          "gross_display": "$200.00"
+        }
+      ],
+      "opening_float": {
+        "expected": "100.0000",
+        "counted": "100.0000",
+        "variance": "0.0000",
+        "expected_display": "$100.00",
+        "counted_display": "$100.00",
+        "variance_display": "$0.00"
+      },
+      "movements": [
+        {
+          "created_at_gmt": "2026-09-11 10:00:00",
+          "type": "paid_out",
+          "amount": "5.0000",
+          "reason": "Petty cash",
+          "voided_by": "sample-void",
+          "amount_display": "$5.00",
+          "created_at": {"datetime": "Sep 11, 2026, 12:00", "date": "Sep 11, 2026", "time": "12:00", "datetime_short": "9/11/26, 12:00", "datetime_long": "September 11, 2026 at 12:00 GMT+2", "datetime_full": "Friday, September 11, 2026 at 12:00 Central European Summer Time", "date_short": "9/11/26", "date_long": "September 11, 2026", "date_full": "Friday, September 11, 2026", "date_ymd": "2026-09-11", "date_dmy": "11/09/2026", "date_mdy": "09/11/2026", "weekday_short": "Fri", "weekday_long": "Friday", "day": "11", "month": "09", "month_short": "Sep", "month_long": "September", "year": "2026"},
+          "type_label": "Paid out",
+          "voided": true
+        }
+      ],
+      "transaction_count": 12,
+      "refund_count": 2,
+      "cashiers": [
+        {
+          "id": 1,
+          "name": "Alex"
+        }
+      ],
+      "labels": {
+        "opened_by_name": "Alex",
+        "closed_by_name": "Alex",
+        "approved_by_name": "Alex"
+      }
+    },
+    "tenders": [
+      {
+        "name": "cash",
+        "label": "Cash",
+        "has_variance": true,
+        "variance_absolute_display": "$2.00",
+        "expected": "180.0000",
+        "counted": "178.0000",
+        "variance": "-2.0000",
+        "variance_label": "Short",
+        "expected_display": "$180.00",
+        "counted_display": "$178.00",
+        "variance_display": "-$2.00"
+      },
+      {
+        "name": "card",
+        "label": "Card",
+        "has_variance": false,
+        "variance_absolute_display": "$0.00",
+        "expected": "120.0000",
+        "counted": "120.0000",
+        "variance": "0.0000",
+        "variance_label": "Exact",
+        "expected_display": "$120.00",
+        "counted_display": "$120.00",
+        "variance_display": "$0.00"
+      }
+    ],
+    "period_sales_total_display": "$250.00",
+    "period_refunds_total_display": "$50.00",
+    "perpetual_sales_total_display": "$5,250.00",
+    "perpetual_refunds_total_display": "$250.00",
+    "unsynced_total_display": "$12.00",
+    "opened_at": {"datetime": "Sep 11, 2026, 10:00", "date": "Sep 11, 2026", "time": "10:00", "datetime_short": "9/11/26, 10:00", "datetime_long": "September 11, 2026 at 10:00 GMT+2", "datetime_full": "Friday, September 11, 2026 at 10:00 Central European Summer Time", "date_short": "9/11/26", "date_long": "September 11, 2026", "date_full": "Friday, September 11, 2026", "date_ymd": "2026-09-11", "date_dmy": "11/09/2026", "date_mdy": "09/11/2026", "weekday_short": "Fri", "weekday_long": "Friday", "day": "11", "month": "09", "month_short": "Sep", "month_long": "September", "year": "2026"},
+    "closed_at": {"datetime": "Sep 11, 2026, 19:00", "date": "Sep 11, 2026", "time": "19:00", "datetime_short": "9/11/26, 19:00", "datetime_long": "September 11, 2026 at 19:00 GMT+2", "datetime_full": "Friday, September 11, 2026 at 19:00 Central European Summer Time", "date_short": "9/11/26", "date_long": "September 11, 2026", "date_full": "Friday, September 11, 2026", "date_ymd": "2026-09-11", "date_dmy": "11/09/2026", "date_mdy": "09/11/2026", "weekday_short": "Fri", "weekday_long": "Friday", "day": "11", "month": "09", "month_short": "Sep", "month_long": "September", "year": "2026"}
+  },
+  "order": { "currency": "USD" },
+  "i18n": {
+    "x_report": "X-report",
+    "closure": "Closure",
+    "opened": "Opened",
+    "closed": "Closed",
+    "approver": "Approver",
+    "opening_float": "Opening float",
+    "expected": "Expected",
+    "counted": "Counted",
+    "variance": "Variance",
+    "tenders": "Tenders",
+    "tender": "Tender",
+    "cash_movements": "Cash movements",
+    "time": "Time",
+    "type": "Type",
+    "amount": "Amount",
+    "reason": "Reason",
+    "sales": "Sales",
+    "period_sales": "Period sales",
+    "period_refunds": "Period refunds",
+    "transactions": "Transactions",
+    "refunds": "Refunds",
+    "payment_method": "Payment method",
+    "cashiers": "Cashiers",
+    "tax_rates": "Tax rates",
+    "tax_rate": "Tax rate",
+    "net": "Net",
+    "tax": "Tax",
+    "gross": "Gross",
+    "perpetual_totals": "Perpetual totals",
+    "perpetual_sales": "Perpetual sales",
+    "perpetual_refunds": "Perpetual refunds",
+    "unsynced_sales": "sales not yet on the server",
+    "short": "Short",
+    "over": "Over",
+    "exact": "Exact",
+    "voided": "Voided",
+    "paid_in": "Paid in",
+    "paid_out": "Paid out",
+    "no_sale": "No sale",
+    "void": "Void",
+    "copy": "COPY"
+},
+  "register": {
+    "name": "Main register"
+  },
+  "software": {
+    "name": "WCPOS",
+    "plugin_version": "preview"
+  },
+  "fiscal": {
+    "document_type": "closure",
+    "receipt_number": "42",
+    "is_sale_document": false,
+    "is_refund_document": false,
+    "is_closure_document": true,
+    "is_x_report": false,
+    "is_reprint": false,
+    "reprint_count": 0
+  }
+}

package/src/register/__fixtures__/corrections-dst.json

@@ -0,0 +1,63 @@
+{
+  "timezone": "America/Los_Angeles",
+  "now": "2026-11-01T20:00:00Z",
+  "closures": [
+    {
+      "id": "before-fallback",
+      "number": 42,
+      "business_day": "2026-10-31",
+      "opened_at": "2026-10-31T23:00:00Z",
+      "closed_at": "2026-11-01T08:30:00Z"
+    },
+    {
+      "id": "after-fallback",
+      "number": 43,
+      "business_day": "2026-11-01",
+      "opened_at": "2026-11-01T07:00:00Z",
+      "closed_at": "2026-11-01T09:30:00Z"
+    }
+  ],
+  "corrections": [
+    {
+      "id": 1,
+      "type": "late_sale",
+      "created_at": "2026-11-01 08:45:00",
+      "actor": { "id": "1", "name": "Alex" },
+      "approver": null,
+      "reason": "Overnight sale synced",
+      "figures": {
+        "expected_delta": { "cash": 1 },
+        "sales_delta": 1,
+        "refunds_delta": 0
+      }
+    },
+    {
+      "id": 2,
+      "type": "recount",
+      "created_at": "2026-11-01 09:45:00",
+      "actor": { "id": "1", "name": "Alex" },
+      "approver": { "id": "2", "name": "Manager" },
+      "reason": "Drawer recounted after the clock change",
+      "figures": {
+        "counted": { "cash": 18000 },
+        "variance": { "cash": 0 }
+      }
+    }
+  ],
+  "settled": {
+    "expected": { "cash": 18001, "card": 12000 },
+    "counted": { "cash": 18000, "card": 12000 },
+    "variance": { "cash": -1, "card": 0 },
+    "period_sales_total_minor": 25001,
+    "period_refunds_total_minor": 5000,
+    "perpetual_sales_total_minor": 525001,
+    "perpetual_refunds_total_minor": 25000
+  },
+  "touched": [
+    "counted.cash",
+    "expected.cash",
+    "period_sales_total_minor",
+    "perpetual_sales_total_minor",
+    "variance.cash"
+  ]
+}