@teincfood/core 0.9.20 → 0.9.21

package/dist/customer-display/driver.d.ts

@@ -0,0 +1,26 @@
+import type { CustomerDisplayModel } from "./model";
+export interface CustomerDisplayCapabilities {
+    /** True when the platform exposes a usable secondary display mechanism. */
+    supported: boolean;
+    /** Number of monitors/displays the platform reports (1 = single screen). */
+    displays: number;
+    /** Human-readable reason when unsupported (for the settings UI). */
+    reason?: string;
+}
+/**
+ * Platform-specific presentation of the customer display. The shared POS/model
+ * layer never knows whether a driver renders to a Tauri window, an Android
+ * `Presentation`, or a future serial customer pole. Drivers are responsible for
+ * their own lifecycle and hardware quirks.
+ */
+export interface CustomerDisplayDriver {
+    capabilities(): Promise<CustomerDisplayCapabilities>;
+    /** Open/show the secondary presentation. Idempotent. */
+    open(): Promise<void>;
+    /** Close/hide the secondary presentation. Idempotent. */
+    close(): Promise<void>;
+    /** Push the latest model to the presentation (fire-and-forget). */
+    push(model: CustomerDisplayModel): void;
+    /** Subscribe to display topology changes (monitor add/remove). */
+    onCapabilitiesChanged(cb: (caps: CustomerDisplayCapabilities) => void): () => void;
+}

package/dist/customer-display/driver.js

@@ -0,0 +1 @@
+export {};

package/dist/customer-display/model.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Customer display model — a platform-agnostic snapshot of what the
+ * customer-facing screen should show. The merchant POS owns order/payment
+ * state; this module only *describes* that state so any presentation layer
+ * (Tauri second window, Android `Presentation`, future hardware) renders it
+ * identically. No hardware or framework details live here.
+ */
+export type CustomerDisplayPhase = "idle" | "ordering" | "payment" | "confirmation";
+export type CustomerDisplayPaymentMethod = "cash" | "mobile_money" | "card" | "split" | "other";
+export type CustomerDisplayPaymentStatus = "pending" | "processing" | "paid" | "failed";
+export interface CustomerDisplayLineItem {
+    /** Stable key for list rendering. */
+    id: string;
+    name: string;
+    variant?: string;
+    addons: string[];
+    quantity: number;
+    unitPriceMinor: number;
+    lineTotalMinor: number;
+}
+export interface CustomerDisplayTaxLine {
+    id?: string;
+    name: string;
+    amountMinor: number;
+    inclusive?: boolean;
+}
+export interface CustomerDisplayPayment {
+    method: CustomerDisplayPaymentMethod;
+    status: CustomerDisplayPaymentStatus;
+    /** Optional hosted-checkout / QR URL the customer can scan. */
+    qrUrl?: string | null;
+}
+export interface CustomerDisplayConfirmation {
+    orderNumber: string;
+    totalMinor: number;
+    currency: string;
+    /** Epoch ms; used to auto-dismiss back to idle. */
+    at: number;
+}
+export interface CustomerDisplayBranding {
+    name: string;
+    logoUrl?: string | null;
+    /** Optional promo / tagline shown on the idle screen. */
+    tagline?: string | null;
+}
+export interface CustomerDisplayModel {
+    phase: CustomerDisplayPhase;
+    branding: CustomerDisplayBranding | null;
+    currency: string;
+    items: CustomerDisplayLineItem[];
+    itemCount: number;
+    subtotalMinor: number;
+    taxLines: CustomerDisplayTaxLine[];
+    discountMinor: number;
+    totalMinor: number;
+    customerName?: string;
+    orderType?: string;
+    payment?: CustomerDisplayPayment;
+    confirmation?: CustomerDisplayConfirmation;
+    updatedAt: number;
+}
+export interface CustomerDisplayInput {
+    branding: CustomerDisplayBranding | null;
+    currency: string;
+    items: CustomerDisplayLineItem[];
+    subtotalMinor: number;
+    taxLines: CustomerDisplayTaxLine[];
+    discountMinor: number;
+    totalMinor: number;
+    customerName?: string;
+    orderType?: string;
+    /** Runtime overrides from the POS payment flow. */
+    phase?: CustomerDisplayPhase;
+    payment?: CustomerDisplayPayment;
+    confirmation?: CustomerDisplayConfirmation;
+    now?: number;
+}
+export declare const EMPTY_CUSTOMER_DISPLAY_MODEL: CustomerDisplayModel;
+/**
+ * Resolve the display phase from order + runtime state. Explicit runtime phase
+ * (set by the POS flow) wins; otherwise the presence of items implies ordering.
+ */
+export declare function resolvePhase(input: CustomerDisplayInput): CustomerDisplayPhase;
+/** Pure builder — deterministic and safe to unit-test without any hardware. */
+export declare function buildCustomerDisplayModel(input: CustomerDisplayInput): CustomerDisplayModel;

package/dist/customer-display/model.js

@@ -0,0 +1,48 @@
+/**
+ * Customer display model — a platform-agnostic snapshot of what the
+ * customer-facing screen should show. The merchant POS owns order/payment
+ * state; this module only *describes* that state so any presentation layer
+ * (Tauri second window, Android `Presentation`, future hardware) renders it
+ * identically. No hardware or framework details live here.
+ */
+export const EMPTY_CUSTOMER_DISPLAY_MODEL = {
+    phase: "idle",
+    branding: null,
+    currency: "GHS",
+    items: [],
+    itemCount: 0,
+    subtotalMinor: 0,
+    taxLines: [],
+    discountMinor: 0,
+    totalMinor: 0,
+    updatedAt: 0,
+};
+/**
+ * Resolve the display phase from order + runtime state. Explicit runtime phase
+ * (set by the POS flow) wins; otherwise the presence of items implies ordering.
+ */
+export function resolvePhase(input) {
+    if (input.phase)
+        return input.phase;
+    return input.items.length > 0 ? "ordering" : "idle";
+}
+/** Pure builder — deterministic and safe to unit-test without any hardware. */
+export function buildCustomerDisplayModel(input) {
+    const itemCount = input.items.reduce((sum, item) => sum + item.quantity, 0);
+    return {
+        phase: resolvePhase(input),
+        branding: input.branding,
+        currency: input.currency,
+        items: input.items,
+        itemCount,
+        subtotalMinor: input.subtotalMinor,
+        taxLines: input.taxLines,
+        discountMinor: input.discountMinor,
+        totalMinor: input.totalMinor,
+        customerName: input.customerName,
+        orderType: input.orderType,
+        payment: input.payment,
+        confirmation: input.confirmation,
+        updatedAt: input.now ?? Date.now(),
+    };
+}

package/dist/index.d.ts

@@ -9,6 +9,8 @@ export * from "./types/pos.types";
 export * from "./types/rider";
 export * from "./types/places";
 export * from "./adapters/notify";
+export * from "./customer-display/model";
+export type { CustomerDisplayDriver, CustomerDisplayCapabilities } from "./customer-display/driver";
 export { calculatePricing, calculateTaxLines, calculateExclusiveTax, calculateInclusiveTaxShare, } from "./pricing/engine";
 export type { PricingInput, PricingResult } from "./pricing/engine";
 export * from "./utils/constants";

package/dist/index.js

@@ -10,6 +10,8 @@ export * from "./types/pos.types";
 export * from "./types/rider";
 export * from "./types/places";
 export * from "./adapters/notify";
+// ── Customer display (shared model + platform driver contract) ──
+export * from "./customer-display/model";
 // ── Pricing (server-parity) ──
 export { calculatePricing, calculateTaxLines, calculateExclusiveTax, calculateInclusiveTaxShare, } from "./pricing/engine";
 // ── Utils ──

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teincfood/core",
-  "version": "0.9.20",
+  "version": "0.9.21",
   "description": "TeincFood shared offline-first core — types, sync engine, local DB, reference data, and repositories for mobile + desktop",
   "type": "module",
   "main": "dist/index.js",