@aglyn/plugins-commerce 1.0.0-beta.230 → 1.0.0-beta.231

package/src/lib/server/pos-order.js

@@ -22,9 +22,16 @@ import { merchantAccountIsReady } from "@aglyn/tenant-data-admin/server/payment-
 import { checkoutSessionCardAuthenticationParams } from "@aglyn/tenant-data-admin/server/stripe-card-authentication";
 import { buildRoute, claimAttempt, Route } from "@aglyn/aglyn/server";
 import { alertLowStockCrossing } from "./low-stock.js";
+import { notifyOrderBuyer } from "./order-notifications.js";
+import { ORDER_PAID_EVENT } from "../model/order-events.js";
+import { raiseOrderEvent } from "./order-events.js";
 import { decrementVariantStock } from "./reserve-stock.js";
 import { holdPromotionSlot, promotionHoldKey, settlePromotionSlot } from "./promotion-hold.js";
 import { posMaxDiscountPct } from "../plugin-config.js";
+import { offlineFeeMonthKey } from "./pos-fee-month.js";
+import { notifyPosSaleCompleted } from "./pos-sale.js";
+import { posSaleStamp } from "./pos-sale-stamp.js";
+import { quoteSaleTaxWithEngine } from "./tax-engine-quote.js";
 import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
 /**
  * The settlement claim (AGL-1691) now lives in `@aglyn/aglyn/server`
@@ -43,7 +50,8 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
  * later). Inventory decrements per line from the register's location,
  * and sales can post to an open reservation folio instead (AGL-317).
  */ export const posOrderHandler = async (req, res)=>{
-    var _req_headers_authorization, _req_body, _body_hostId, _body_payment, _body_cashReceivedCents, _body_customerEmail, _body_reservationId, _body_registerId, _body_couponCode, _body_locationId, _body_discountPct, _ref, _req_headers_idempotencykey;
+    var _req_headers_authorization, _req_body, _body_hostId, _body_payment, _body_cashReceivedCents, _ref, _body_customerEmail, _body_reservationId, _body_registerId, _body_couponCode, _body_locationId, _body_discountPct, _ref1, _req_headers_idempotencykey;
+    var _body_customer;
     if (req.method !== 'POST') {
         return res.status(405).json({
             error: 'Method not allowed'
@@ -56,9 +64,14 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
     });
     const body = typeof req.body === 'string' ? JSON.parse(req.body) : (_req_body = req.body) != null ? _req_body : {};
     const hostId = String((_body_hostId = body.hostId) != null ? _body_hostId : '');
+    // `open` (AGL-3607) prices the basket and writes a PENDING sale with an
+    // empty tender ledger; the register then takes one or more payments
+    // against it through `commerce/pos-payment` until the balance is zero.
     const payment = String((_body_payment = body.payment) != null ? _body_payment : 'cash');
     const cashReceivedCents = Math.round(Number((_body_cashReceivedCents = body.cashReceivedCents) != null ? _body_cashReceivedCents : 0));
-    const customerEmail = String((_body_customerEmail = body.customerEmail) != null ? _body_customerEmail : '').trim().toLowerCase();
+    // The customer the register's lookup attached (AGL-3609) gives the email
+    // when the cashier did not type one.
+    const customerEmail = String((_ref = (_body_customerEmail = body.customerEmail) != null ? _body_customerEmail : (_body_customer = body.customer) == null ? void 0 : _body_customer.email) != null ? _ref : '').trim().toLowerCase();
     const reservationId = String((_body_reservationId = body.reservationId) != null ? _body_reservationId : '');
     const registerId = String((_body_registerId = body.registerId) != null ? _body_registerId : '');
     // A code the shopper hands the cashier (AGL-305). The same field name the
@@ -91,7 +104,7 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
     // One settlement attempt, minted by the register (AGL-1691). Node lowercases
     // incoming headers, but read both spellings — the plugin API request type
     // makes no promise about casing.
-    const idempotencyKey = String((_ref = (_req_headers_idempotencykey = req.headers['idempotency-key']) != null ? _req_headers_idempotencykey : req.headers['Idempotency-Key']) != null ? _ref : '').trim().slice(0, 200);
+    const idempotencyKey = String((_ref1 = (_req_headers_idempotencykey = req.headers['idempotency-key']) != null ? _req_headers_idempotencykey : req.headers['Idempotency-Key']) != null ? _ref1 : '').trim().slice(0, 200);
     if (!hostId || rawLines.length === 0) {
         return res.status(400).json({
             error: 'Missing hostId or lines'
@@ -113,8 +126,8 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
         if (slot) await slot.release();
     };
     try {
-        var _hostSnapshot_get, _storeSettings_get, _taxSettings_origin, _ref1, _ref2;
-        var _ownerOrg_org, _ownerOrg_org1;
+        var _hostSnapshot_get, _storeSettings_get, _taxSettings_origin, _ref2, _ref3;
+        var _registerDocs_rank, _ownerOrg_org, _ownerOrg_org1;
         const decoded = await firebaseAdmin.app().auth().verifyIdToken(idToken);
         const firestore = firebaseAdmin.app().firestore();
         const hostRef = firestore.collection('hosts').doc(hostId);
@@ -187,9 +200,10 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
         // site, and
         // reading only the workspace's answer would refuse the sale the console
         // says is allowed.
-        const maxDiscountPct = posMaxDiscountPct(await getPluginConfig(ownerOrg == null ? void 0 : ownerOrg.orgId, 'commerce', {
+        const commerceConfig = await getPluginConfig(ownerOrg == null ? void 0 : ownerOrg.orgId, 'commerce', {
             hostId
-        }));
+        });
+        const maxDiscountPct = posMaxDiscountPct(commerceConfig);
         if (discountPct > maxDiscountPct) {
             return res.status(403).json({
                 error: `This register may discount up to ${maxDiscountPct}%. Ask a ` + 'manager to raise the limit in the commerce settings.',
@@ -222,7 +236,8 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
             var _doc_get_toMillis, _doc_get;
             return {
                 id: doc.id,
-                createdAtMs: (_ref = (_doc_get = doc.get('createdAt')) == null ? void 0 : (_doc_get_toMillis = _doc_get.toMillis) == null ? void 0 : _doc_get_toMillis.call(_doc_get)) != null ? _ref : 0
+                createdAtMs: (_ref = (_doc_get = doc.get('createdAt')) == null ? void 0 : (_doc_get_toMillis = _doc_get.toMillis) == null ? void 0 : _doc_get_toMillis.call(_doc_get)) != null ? _ref : 0,
+                openShiftId: doc.get('openShiftId')
             };
         }).sort((a, b)=>a.createdAtMs - b.createdAtMs || a.id.localeCompare(b.id));
         const rank = registerDocs.findIndex((r)=>r.id === registerId);
@@ -236,6 +251,24 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
                 error: 'This register is over your plan’s limit — remove extra ' + 'registers or upgrade in Billing to use it.'
             });
         }
+        // WHO RANG IT, IN WHICH SHIFT, FOR WHOM (AGL-3609): the PIN-switched
+        // cashier, the register's open shift (refused when the site requires one
+        // and none is open) and the customer the lookup attached.
+        const stamped = await posSaleStamp({
+            hostId,
+            hostRef,
+            registerId,
+            openShiftId: (_registerDocs_rank = registerDocs[rank]) == null ? void 0 : _registerDocs_rank.openShiftId,
+            signedInUid: decoded.uid,
+            body,
+            config: commerceConfig
+        });
+        if ('error' in stamped) {
+            return res.status(stamped.status).json({
+                error: stamped.error
+            });
+        }
+        const saleStamp = stamped.stamp;
         // Server pricing per line.
         const uniqueIds = [
             ...new Set(rawLines.map((line)=>String(line.productId)))
@@ -259,21 +292,30 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
                 });
             }
             const quantity = Math.max(1, Math.min(99, Math.round(Number((_raw_quantity = raw.quantity) != null ? _raw_quantity : 1))));
+            // Modifiers are priced from the product, never from the register
+            // (AGL-3607): the line names option ids and nothing else.
+            const chosen = CommerceModel.resolveLineModifiers(product, raw.modifiers);
+            if (!chosen.ok) return res.status(400).json({
+                error: chosen.error
+            });
+            const variantLabel = CommerceModel.lineLabelWithModifiers(Object.keys((_variant_options = variant.options) != null ? _variant_options : {}).length ? Object.values((_variant_options1 = variant.options) != null ? _variant_options1 : {}).join(' / ') : undefined, chosen.modifiers);
             lineItems.push(_extends({
                 productId: String(raw.productId)
             }, variant.id !== 'default' ? {
                 variantId: variant.id
             } : {}, {
                 name: product.name
-            }, Object.keys((_variant_options = variant.options) != null ? _variant_options : {}).length ? {
-                variantLabel: Object.values((_variant_options1 = variant.options) != null ? _variant_options1 : {}).join(' / ')
+            }, variantLabel ? {
+                variantLabel
             } : {}, variant.sku ? {
                 sku: variant.sku
             } : {}, {
                 productType: product.type,
                 quantity,
-                unitAmountCents: Math.round(Number(variant.priceUsd) * 100)
-            }));
+                unitAmountCents: Math.round(Number(variant.priceUsd) * 100) + chosen.extraCents
+            }, chosen.modifiers.length ? {
+                modifiers: chosen.modifiers
+            } : {}));
         }
         if (lineItems.length === 0) {
             return res.status(400).json({
@@ -465,7 +507,40 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
             });
         }
         const rate = taxDecision.kind === 'manual' ? CommerceModel.resolveTaxRate(taxSettings, (_taxSettings_origin = taxSettings.origin) != null ? _taxSettings_origin : {}) : null;
-        const taxCents = rate && !taxSettings.pricesIncludeTax ? CommerceModel.computeTaxCents(itemsCents - discountCents, rate.pct) : 0;
+        let taxCents = rate && !taxSettings.pricesIncludeTax ? CommerceModel.computeTaxCents(itemsCents - discountCents, rate.pct) : 0;
+        // The merchant's own tax service, where they connected one (AGL-3631):
+        // taxed at the store's ship-from address, as every in-person sale is.
+        // When it does not answer, the store's rate above stands and the order
+        // says so; the cashier is never left waiting on a vendor.
+        const engineTax = taxDecision.kind === 'manual' ? await quoteSaleTaxWithEngine({
+            hostId,
+            settings: taxSettings,
+            channel: 'pos',
+            lines: lineItems.map((line, index)=>_extends({
+                    id: String(index),
+                    productId: line.productId
+                }, line.variantId ? {
+                    variantId: line.variantId
+                } : {}, line.sku ? {
+                    sku: line.sku
+                } : {}, {
+                    description: [
+                        line.name,
+                        line.variantLabel
+                    ].filter(Boolean).join(' — '),
+                    quantity: line.quantity,
+                    amountCents: line.unitAmountCents * line.quantity
+                })),
+            discountCents,
+            customerEmail: customerEmail || null
+        }) : {
+            quote: null,
+            stamp: null
+        };
+        if (engineTax.quote) taxCents = engineTax.quote.taxCents;
+        const taxEngineFields = engineTax.stamp ? {
+            taxEngine: engineTax.stamp
+        } : {};
         /*==========================================
      * THE FEE ATTACHES TO THE SALE, NOT TO THE TENDER (AGL-2111).
      *
@@ -553,7 +628,7 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
         // `orgs//offlineFees/…`; the sale still rings, and the fee is forgone
         // rather than written somewhere no invoice will ever find it.
         const offlineFeeMonth = offlineFeeMonthKey();
-        const offlineFeeOrgId = String((_ref1 = ownerOrg == null ? void 0 : (_ownerOrg_org = ownerOrg.org) == null ? void 0 : _ownerOrg_org.id) != null ? _ref1 : '');
+        const offlineFeeOrgId = String((_ref2 = ownerOrg == null ? void 0 : (_ownerOrg_org = ownerOrg.org) == null ? void 0 : _ownerOrg_org.id) != null ? _ref2 : '');
         const offlineFeeRef = offlineFeeOrgId ? firestore.collection('orgs').doc(offlineFeeOrgId).collection('offlineFees').doc(offlineFeeMonth) : null;
         // Deterministic tender rejections run BEFORE the claim is taken, so they
         // never burn the key (AGL-1691): "cash received is short" is a 400 the
@@ -609,7 +684,7 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
         const claimed = await claimAttempt(firestore, {
             kind: 'pos',
             scopeId: hostId,
-            orgId: String((_ref2 = ownerOrg == null ? void 0 : (_ownerOrg_org1 = ownerOrg.org) == null ? void 0 : _ownerOrg_org1.id) != null ? _ref2 : ''),
+            orgId: String((_ref3 = ownerOrg == null ? void 0 : (_ownerOrg_org1 = ownerOrg.org) == null ? void 0 : _ownerOrg_org1.id) != null ? _ref3 : ''),
             key: idempotencyKey,
             busyMessage: 'This sale is already being processed'
         });
@@ -653,11 +728,83 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
                 discountHoldKey = slot.holdKey;
             }
         }
+        if (payment === 'open') {
+            // AN OPEN SALE (AGL-3607): priced here, exactly like every other
+            // tender, and paid by the ledger. The fee on `totals` is the TAKE alone;
+            // each card payment adds Stripe's processing cost to its own payout
+            // fee, and `pos-sale.ts` restates `feeCents` from what actually paid
+            // when the balance reaches zero. Named like every console resource,
+            // never by an auto-id.
+            const orderRef = hostRef.collection('orders').doc(Aglyn.createResourceUid());
+            const counterRef = hostRef.collection('counters').doc('orders');
+            const openTotals = CommerceModel.computeOrderTotals(lineItems, {
+                discountCents,
+                taxCents,
+                feeCents: takeFeeCents
+            });
+            await firestore.runTransaction(async (transaction)=>{
+                var _counter_get;
+                const counter = await transaction.get(counterRef);
+                const number = Number((_counter_get = counter.get('next')) != null ? _counter_get : 1);
+                transaction.set(counterRef, {
+                    next: number + 1
+                }, {
+                    merge: true
+                });
+                transaction.set(orderRef, CommerceModel.withOrderListFields(orderRef.id, _extends({
+                    number,
+                    status: 'pending',
+                    channel: 'pos',
+                    registerId,
+                    cashierId: saleStamp.cashierId
+                }, saleStamp.fields, discountPct > 0 ? {
+                    discountPct,
+                    discountBy: saleStamp.cashierId
+                } : {}, appliedDiscountId ? {
+                    discountId: appliedDiscountId
+                } : {}, discountHoldKey ? {
+                    discountHoldKey
+                } : {}, locationId ? {
+                    locationId
+                } : {}, {
+                    lineItems,
+                    totals: openTotals,
+                    taxMode: CommerceModel.storefrontTaxModeForDecision(taxDecision, taxCents)
+                }, taxEngineFields, {
+                    posTakeFeeCents: takeFeeCents
+                }, offlineFeeOrgId ? {
+                    posFeeOrgId: offlineFeeOrgId
+                } : {}, {
+                    payments: [],
+                    customerEmail: customerEmail || null,
+                    timeline: [
+                        {
+                            atMs: Date.now(),
+                            event: 'pos-sale-opened'
+                        }
+                    ],
+                    createdAtMs: Date.now(),
+                    createdAt: firebaseAdmin.firestore.FieldValue.serverTimestamp()
+                })));
+            });
+            // The hold now belongs to the sale document, not to this request.
+            discountSlot = null;
+            discountHoldKey = '';
+            const openPayload = _extends({
+                orderId: orderRef.id,
+                totals: openTotals,
+                dueCents: openTotals.totalCents
+            }, stockWarnings.length > 0 ? {
+                stockWarnings
+            } : {});
+            await claim.record(200, openPayload);
+            return res.status(200).json(openPayload);
+        }
         if (payment === 'link') {
-            var _ref3, _session_id;
+            var _ref4, _session_id;
             var _ownerOrg_org2, _ownerOrg_org3;
             // QR payment link on the merchant account, completed by webhook.
-            const ownerProfile = await firestore.collection('profiles').doc(String((_ref3 = ownerOrg == null ? void 0 : (_ownerOrg_org2 = ownerOrg.org) == null ? void 0 : _ownerOrg_org2.ownerUid) != null ? _ref3 : '')).get();
+            const ownerProfile = await firestore.collection('profiles').doc(String((_ref4 = ownerOrg == null ? void 0 : (_ownerOrg_org2 = ownerOrg.org) == null ? void 0 : _ownerOrg_org2.ownerUid) != null ? _ref4 : '')).get();
             const accountId = ownerProfile.get('stripeAccountId');
             if (!merchantAccountIsReady({
                 accountId,
@@ -691,10 +838,11 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
                     number,
                     status: 'pending',
                     channel: 'pos',
-                    registerId
-                }, discountPct > 0 ? {
+                    registerId,
+                    cashierId: saleStamp.cashierId
+                }, saleStamp.fields, discountPct > 0 ? {
                     discountPct,
-                    discountBy: decoded.uid
+                    discountBy: saleStamp.cashierId
                 } : {}, appliedDiscountId ? {
                     discountId: appliedDiscountId
                 } : {}, locationId ? {
@@ -713,7 +861,7 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
                     // carries the same figure over as `metadata[taxCents]` for the
                     // webhook to restate when the card is actually charged.
                     taxMode: CommerceModel.storefrontTaxModeForDecision(taxDecision, taxCents)
-                }, feeCents > 0 ? {
+                }, taxEngineFields, feeCents > 0 ? {
                     feeCollection
                 } : {}, {
                     customerEmail: customerEmail || null,
@@ -877,7 +1025,7 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
                 registerId
             }, discountPct > 0 ? {
                 discountPct,
-                discountBy: decoded.uid
+                discountBy: saleStamp.cashierId
             } : {}, appliedDiscountId ? {
                 discountId: appliedDiscountId
             } : {}, locationId ? {
@@ -891,9 +1039,31 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
                 // witness there will be, and here is the one moment it can be written
                 // down.
                 taxMode: CommerceModel.storefrontTaxModeForDecision(taxDecision, taxCents)
-            }, feeCents > 0 ? {
+            }, taxEngineFields, feeCents > 0 ? {
                 feeCollection
             } : {}, {
+                // THE TENDER, RECORDED (AGL-3607): one settled payment, so this sale
+                // reads the same as a split one rather than by inference.
+                cashierId: saleStamp.cashierId
+            }, saleStamp.fields, {
+                payments: [
+                    _extends({
+                        id: `pay_${payment}`,
+                        method: payment === 'folio' ? 'folio' : 'cash',
+                        amountCents: totals.totalCents,
+                        status: 'succeeded',
+                        atMs: paidEvent.atMs,
+                        settledAtMs: paidEvent.atMs,
+                        takeFeeCents,
+                        feeCents: 0,
+                        cashierId: saleStamp.cashierId
+                    }, payment === 'cash' ? {
+                        cashTenderedCents: cashReceivedCents,
+                        changeCents: cashReceivedCents - totals.totalCents
+                    } : {
+                        reservationId
+                    })
+                ],
                 customerEmail: customerEmail || null,
                 timeline: [
                     paidEvent
@@ -1101,6 +1271,19 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
                 console.error('[pos-order] contact upsert failed', error);
             });
         }
+        // THE ONE "SALE COMPLETED" POINT (AGL-3607), reached here by a
+        // single-tender cash or room sale as by every other register sale.
+        await notifyPosSaleCompleted({
+            hostId,
+            orderId: orderRef.id,
+            order: {
+                status: 'paid',
+                channel: 'pos',
+                registerId,
+                lineItems,
+                totals
+            }
+        });
         const cashPayload = _extends({
             orderId: orderRef.id,
             totals,
@@ -1109,6 +1292,19 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
             stockWarnings
         } : {});
         await claim.record(200, cashPayload);
+        // The receipt, when the customer gave an email (AGL-3610).
+        await notifyOrderBuyer({
+            hostId,
+            orderId: orderRef.id
+        }, 'receipt', {
+            email: contactEmail
+        });
+        // A cash or folio sale is paid on the spot (AGL-3611); a card sale is raised by the webhook.
+        await raiseOrderEvent(ORDER_PAID_EVENT, {
+            hostId,
+            orderId: orderRef.id,
+            key: 'paid'
+        });
         return res.status(200).json(cashPayload);
     } catch (error) {
         console.error(error);
@@ -1126,24 +1322,8 @@ import { resolveOrgPermissions } from "@aglyn/tenant-runtime/org-permissions";
         });
     }
 };
-/**
- * The billing month a non-card POS fee accrues into (AGL-2111): `YYYY-MM` in
- * **UTC**, byte-identical to the key `apps/console/utils/billing-month.ts`
- * mints and to the twelve other month counters on the platform
- * (`orgs/{id}/apiUsage/*`, `orgs/{id}/assistUsage/*`, the per-host counters).
- *
- * It has to be UTC and it has to be this exact expression: `report-usage`
- * sweeps `previousMonth()` in UTC and reads the accrual document by that key,
- * so a local-time month would strand every sale rung in the offset window on a
- * document no sweep ever looks at — which is uncollected revenue that leaves
- * no trace. `offline-pos-fee-month-key.spec.ts` pins the two against each
- * other rather than trusting the comment.
- *
- * Local rather than imported because `apps/console` is an app: a plugin
- * library cannot import from it, and the repo's other eleven copies of this
- * one-liner are the established shape.
- */ export function offlineFeeMonthKey(now = new Date()) {
-    return now.toISOString().slice(0, 7);
-}
+// Moved beside the ledger that also accrues into it (AGL-3607); still
+// exported here, where its readers have always imported it from.
+export { offlineFeeMonthKey } from "./pos-fee-month.js";
 
 //# sourceMappingURL=pos-order.js.map