@cogenta/commerce 0.2.0

package/dist/order/store.js

@@ -0,0 +1,301 @@
+import { CogentaError, identifier, limit, newId, sql, } from '@cogenta/core';
+import { couponRefusal } from '../cart/store.js';
+import { toInt, toNullableText, toText } from '../rows.js';
+import { TABLES } from '../tables.js';
+import { assertTransition, holdsStock } from './types.js';
+/**
+ * A short, unambiguous order reference.
+ *
+ * Not the UUID: a person reads this aloud on the phone and types it into a
+ * bank transfer. Crockford's alphabet without I, L, O and U — the four that
+ * get misread as 1, 1, 0 and V, and the one that makes accidental words.
+ */
+const REFERENCE_ALPHABET = '0123456789ABCDEFGHJKMNPQRSTVWXYZ';
+export function referenceFrom(id) {
+    let hash = 0x811c9dc5;
+    for (const character of id) {
+        hash ^= character.codePointAt(0) ?? 0;
+        hash = Math.imul(hash, 0x01000193) >>> 0;
+    }
+    let out = '';
+    let value = hash;
+    for (let index = 0; index < 8; index += 1) {
+        out += REFERENCE_ALPHABET[value % REFERENCE_ALPHABET.length];
+        value = Math.floor(value / REFERENCE_ALPHABET.length);
+        if (value === 0)
+            value = hash + index + 1;
+    }
+    return out;
+}
+export function createOrderStore(db, dependencies, now = Date.now) {
+    const d = db.dialect;
+    const orders = identifier(TABLES.orders, d);
+    const orderLines = identifier(TABLES.orderLines, d);
+    const orderEvents = identifier(TABLES.orderEvents, d);
+    const carts = identifier(TABLES.carts, d);
+    const stamp = () => new Date(now()).toISOString();
+    async function linesOf(orderId, executor = db) {
+        const result = await executor.query(sql `select * from ${orderLines} where order_id = ${orderId} order by position asc, id asc`);
+        return result.rows.map((row) => ({
+            id: toText(row.id, 'order_line.id'),
+            variantId: toText(row.variant_id, 'order_line.variant_id'),
+            sku: toText(row.sku, 'order_line.sku'),
+            title: toText(row.title, 'order_line.title'),
+            quantity: toInt(row.quantity, 'order_line.quantity'),
+            unitPriceMinor: toInt(row.unit_price_minor, 'order_line.unit_price_minor'),
+            subtotalMinor: toInt(row.subtotal_minor, 'order_line.subtotal_minor'),
+            discountMinor: toInt(row.discount_minor, 'order_line.discount_minor'),
+            taxMinor: toInt(row.tax_minor, 'order_line.tax_minor'),
+            taxRateBp: toInt(row.tax_rate_bp, 'order_line.tax_rate_bp'),
+            totalMinor: toInt(row.total_minor, 'order_line.total_minor'),
+            position: toInt(row.position, 'order_line.position'),
+        }));
+    }
+    async function decode(row, executor = db) {
+        const id = toText(row.id, 'order.id');
+        return {
+            id,
+            reference: toText(row.reference, 'order.reference'),
+            customerId: toNullableText(row.customer_id),
+            email: toText(row.email, 'order.email'),
+            status: toText(row.status, 'order.status'),
+            currency: toText(row.currency, 'order.currency'),
+            subtotalMinor: toInt(row.subtotal_minor, 'order.subtotal_minor'),
+            discountMinor: toInt(row.discount_minor, 'order.discount_minor'),
+            shippingMinor: toInt(row.shipping_minor, 'order.shipping_minor'),
+            taxMinor: toInt(row.tax_minor, 'order.tax_minor'),
+            totalMinor: toInt(row.total_minor, 'order.total_minor'),
+            couponCode: toNullableText(row.coupon_code),
+            shippingCountry: toNullableText(row.shipping_country),
+            shippingRegion: toNullableText(row.shipping_region),
+            shippingMethodId: toNullableText(row.shipping_method_id),
+            shippingMethodLabel: toNullableText(row.shipping_method_label),
+            subscriptionId: toNullableText(row.subscription_id),
+            lines: await linesOf(id, executor),
+            placedAt: toText(row.placed_at, 'order.placed_at'),
+            updatedAt: toText(row.updated_at, 'order.updated_at'),
+        };
+    }
+    async function read(id, executor = db) {
+        const result = await executor.query(sql `select * from ${orders} where id = ${id}`);
+        const row = result.rows[0];
+        return row === undefined ? null : decode(row, executor);
+    }
+    async function load(id) {
+        const order = await read(id);
+        if (order === null) {
+            throw new CogentaError({
+                code: 'COMMERCE_ORDER_NOT_FOUND',
+                message: 'This order does not exist.',
+                hint: 'Check the order reference, or refresh the order list.',
+            });
+        }
+        return order;
+    }
+    async function appendEvent(executor, orderId, kind, fields = {}) {
+        await executor.query(sql `
+      insert into ${orderEvents} (id, order_id, at, kind, from_status, to_status, actor_id, note)
+      values (${newId(now)}, ${orderId}, ${stamp()}, ${kind},
+              ${fields.fromStatus ?? null}, ${fields.toStatus ?? null},
+              ${fields.actorId ?? null}, ${fields.note ?? null})`);
+    }
+    return {
+        place: async (input) => {
+            const priced = await dependencies.carts.price(input.cartId);
+            const { cart, totals } = priced;
+            if (cart.status !== 'open') {
+                throw new CogentaError({
+                    code: 'COMMERCE_CART_CLOSED',
+                    message: 'This basket has already been ordered.',
+                    hint: 'Look at the order it produced rather than the basket.',
+                });
+            }
+            if (totals.lines.length === 0)
+                return { kind: 'empty' };
+            const customer = await dependencies.customers.ensure(input.email, input.customerName);
+            // Re-checked here, at the last possible moment, against the *final*
+            // subtotal. The check the cart did was for the shopper's benefit; this
+            // one is the one that decides, because a coupon can expire or be
+            // exhausted between adding it and paying.
+            if (cart.couponCode !== null) {
+                const check = await dependencies.coupons.check(cart.couponCode, totals.subtotalMinor, cart.currency);
+                if (check.kind !== 'ok') {
+                    return { kind: 'coupon_refused', reason: couponRefusal(check).message };
+                }
+            }
+            const id = newId(now);
+            const reference = referenceFrom(id);
+            const at = stamp();
+            try {
+                // ONE transaction, taken immediate. Everything below is either all
+                // true or none of it happened.
+                return await db.transaction(async (tx) => {
+                    const taken = await dependencies.catalog.takeStock(totals.lines.map((line) => ({
+                        variantId: line.variantId,
+                        quantity: line.quantity,
+                    })), tx);
+                    if (taken.kind === 'short') {
+                        throw new PlacementRefused({
+                            kind: 'out_of_stock',
+                            shortfalls: taken.shortfalls,
+                        });
+                    }
+                    if (cart.couponCode !== null) {
+                        const claimed = await dependencies.coupons.redeem(cart.couponCode, id, customer.id, tx);
+                        if (!claimed) {
+                            // Lost the last redemption to somebody else between the check
+                            // above and here. The whole transaction unwinds, so the stock
+                            // that was just taken goes back too.
+                            throw new PlacementRefused({
+                                kind: 'coupon_refused',
+                                reason: 'This discount code was fully used a moment ago.',
+                            });
+                        }
+                    }
+                    await tx.query(sql `
+              insert into ${orders} (id, reference, customer_id, email, status, currency,
+                                     subtotal_minor, discount_minor, shipping_minor, tax_minor, total_minor,
+                                     coupon_code, shipping_country, shipping_region,
+                                     shipping_method_id, shipping_method_label,
+                                     placed_at, updated_at, subscription_id)
+              values (${id}, ${reference}, ${customer.id}, ${customer.email}, ${'pending'}, ${cart.currency},
+                      ${totals.subtotalMinor}, ${totals.discountMinor}, ${totals.shippingMinor},
+                      ${totals.taxMinor}, ${totals.totalMinor},
+                      ${cart.couponCode}, ${cart.shippingCountry}, ${cart.shippingRegion},
+                      ${cart.shippingMethodId}, ${null}, ${at}, ${at}, ${null})`);
+                    for (const [position, line] of totals.lines.entries()) {
+                        await tx.query(sql `
+                insert into ${orderLines} (id, order_id, variant_id, sku, title, quantity,
+                                           unit_price_minor, subtotal_minor, discount_minor,
+                                           tax_minor, tax_rate_bp, total_minor, position)
+                values (${newId(now)}, ${id}, ${line.variantId}, ${line.sku}, ${line.title},
+                        ${line.quantity}, ${line.unitPriceMinor}, ${line.subtotalMinor},
+                        ${line.discountMinor}, ${line.taxMinor}, ${line.taxRateBp},
+                        ${line.totalMinor}, ${position})`);
+                    }
+                    await tx.query(sql `
+              update ${carts} set status = ${'ordered'}, order_id = ${id}, updated_at = ${at}
+              where id = ${cart.id} and status = ${'open'}`);
+                    await appendEvent(tx, id, 'placed', {
+                        toStatus: 'pending',
+                        actorId: input.actorId ?? null,
+                        note: `Order ${reference} placed.`,
+                    });
+                    const order = await read(id, tx);
+                    if (order === null) {
+                        throw new CogentaError({
+                            code: 'INTERNAL',
+                            message: 'The order was not stored.',
+                            hint: 'Check that the commerce tables exist (ensureCommerceTables).',
+                        });
+                    }
+                    return { kind: 'placed', order };
+                }, { immediate: true });
+            }
+            catch (error) {
+                if (error instanceof PlacementRefused)
+                    return error.outcome;
+                throw error;
+            }
+        },
+        read: async (id) => read(id),
+        readByReference: async (reference) => {
+            const result = await db.query(sql `select * from ${orders} where reference = ${reference.trim().toUpperCase()}`);
+            const row = result.rows[0];
+            return row === undefined ? null : decode(row);
+        },
+        list: async (options) => {
+            let statement = sql `select * from ${orders}`;
+            if (options?.status !== undefined && options.customerId !== undefined) {
+                statement = sql `${statement} where status = ${options.status} and customer_id = ${options.customerId}`;
+            }
+            else if (options?.status !== undefined) {
+                statement = sql `${statement} where status = ${options.status}`;
+            }
+            else if (options?.customerId !== undefined) {
+                statement = sql `${statement} where customer_id = ${options.customerId}`;
+            }
+            statement = sql `${statement} order by placed_at desc, id desc limit ${limit(options?.limit ?? 100)} offset ${limit(options?.offset ?? 0)}`;
+            const result = await db.query(statement);
+            const decoded = [];
+            for (const row of result.rows)
+                decoded.push(await decode(row));
+            return decoded;
+        },
+        transition: async (id, to, options) => {
+            return db.transaction(async (tx) => {
+                const current = await read(id, tx);
+                if (current === null) {
+                    throw new CogentaError({
+                        code: 'COMMERCE_ORDER_NOT_FOUND',
+                        message: 'This order does not exist.',
+                        hint: 'Check the order reference, or refresh the order list.',
+                    });
+                }
+                assertTransition(current.status, to);
+                // Goods that are no longer promised go back on the shelf, in the
+                // same transaction as the status change. Doing it afterwards is how
+                // a crash between the two leaves stock permanently lost.
+                if (holdsStock(current.status) && !holdsStock(to)) {
+                    await dependencies.catalog.restock(current.lines.map((line) => ({
+                        variantId: line.variantId,
+                        quantity: line.quantity,
+                    })), tx);
+                }
+                // A cancellation before payment hands the coupon back. A refund does
+                // not: the code was genuinely used, and a shop that returns a
+                // one-shot code on every refund has given away two discounts.
+                if (to === 'cancelled' && current.couponCode !== null) {
+                    await dependencies.coupons.release(id, tx);
+                }
+                await tx.query(sql `update ${orders} set status = ${to}, updated_at = ${stamp()} where id = ${id}`);
+                await appendEvent(tx, id, 'status_changed', {
+                    fromStatus: current.status,
+                    toStatus: to,
+                    actorId: options?.actorId ?? null,
+                    note: options?.note ?? null,
+                });
+                const updated = await read(id, tx);
+                if (updated === null) {
+                    throw new CogentaError({
+                        code: 'COMMERCE_ORDER_NOT_FOUND',
+                        message: 'This order disappeared while it was being updated.',
+                        hint: 'Refresh the order list.',
+                    });
+                }
+                return updated;
+            }, { immediate: true });
+        },
+        history: async (id) => {
+            const result = await db.query(sql `select * from ${orderEvents} where order_id = ${id} order by at asc, id asc`);
+            return result.rows.map((row) => ({
+                id: toText(row.id, 'order_event.id'),
+                orderId: toText(row.order_id, 'order_event.order_id'),
+                at: toText(row.at, 'order_event.at'),
+                kind: toText(row.kind, 'order_event.kind'),
+                fromStatus: toNullableText(row.from_status),
+                toStatus: toNullableText(row.to_status),
+                actorId: toNullableText(row.actor_id),
+                note: toNullableText(row.note),
+            }));
+        },
+        record: async (id, kind, options, tx) => {
+            if (tx === undefined)
+                await load(id);
+            await appendEvent(tx ?? db, id, kind, {
+                actorId: options?.actorId ?? null,
+                note: options?.note ?? null,
+            });
+        },
+    };
+}
+/** Internal. Unwinds the placement transaction with a caller-facing outcome. */
+class PlacementRefused extends Error {
+    outcome;
+    constructor(outcome) {
+        super(`order placement refused: ${outcome.kind}`);
+        this.name = 'PlacementRefused';
+        this.outcome = outcome;
+    }
+}
+//# sourceMappingURL=store.js.map

package/dist/order/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../src/order/store.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EAEZ,UAAU,EACV,KAAK,EACL,KAAK,EAEL,GAAG,GACJ,MAAM,eAAe,CAAA;AAEtB,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAKhD,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAoHzD;;;;;;GAMG;AACH,MAAM,kBAAkB,GAAG,kCAAkC,CAAA;AAE7D,MAAM,UAAU,aAAa,CAAC,EAAU;IACtC,IAAI,IAAI,GAAG,UAAU,CAAA;IACrB,KAAK,MAAM,SAAS,IAAI,EAAE,EAAE,CAAC;QAC3B,IAAI,IAAI,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QACrC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,CAAA;IAC1C,CAAC;IACD,IAAI,GAAG,GAAG,EAAE,CAAA;IACZ,IAAI,KAAK,GAAG,IAAI,CAAA;IAChB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC1C,GAAG,IAAI,kBAAkB,CAAC,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAC5D,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;QACrD,IAAI,KAAK,KAAK,CAAC;YAAE,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,CAAC,CAAA;IAC3C,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,EAAkB,EAClB,YAAoC,EACpC,GAAG,GAAiB,IAAI,CAAC,GAAG;IAE5B,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAA;IACpB,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAC3C,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAA;IACnD,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;IACrD,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IACzC,MAAM,KAAK,GAAG,GAAW,EAAE,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE,CAAA;IAEzD,KAAK,UAAU,OAAO,CAAC,OAAe,EAAE,QAAQ,GAAgB,EAAE;QAChE,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,KAAK,CACjC,GAAG,CAAA,iBAAiB,UAAU,qBAAqB,OAAO,gCAAgC,CAC3F,CAAA;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YAC/B,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,eAAe,CAAC;YACnC,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,uBAAuB,CAAC;YAC1D,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC;YACtC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,kBAAkB,CAAC;YAC5C,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,qBAAqB,CAAC;YACpD,cAAc,EAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,EAAE,6BAA6B,CAAC;YAC1E,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,2BAA2B,CAAC;YACrE,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,2BAA2B,CAAC;YACrE,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,sBAAsB,CAAC;YACtD,SAAS,EAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,wBAAwB,CAAC;YAC3D,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,wBAAwB,CAAC;YAC5D,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,qBAAqB,CAAC;SACrD,CAAC,CAAC,CAAA;IACL,CAAC;IAED,KAAK,UAAU,MAAM,CAAC,GAAa,EAAE,QAAQ,GAAgB,EAAE;QAC7D,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,UAAU,CAAC,CAAA;QACrC,OAAO;YACL,EAAE;YACF,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC;YACnD,UAAU,EAAE,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC;YAC3C,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC;YACvC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAgB;YACzD,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,gBAAgB,CAAC;YAChD,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,sBAAsB,CAAC;YAChE,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,sBAAsB,CAAC;YAChE,aAAa,EAAE,KAAK,CAAC,GAAG,CAAC,cAAc,EAAE,sBAAsB,CAAC;YAChE,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC;YACjD,UAAU,EAAE,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,mBAAmB,CAAC;YACvD,UAAU,EAAE,cAAc,CAAC,GAAG,CAAC,WAAW,CAAC;YAC3C,eAAe,EAAE,cAAc,CAAC,GAAG,CAAC,gBAAgB,CAAC;YACrD,cAAc,EAAE,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC;YACnD,gBAAgB,EAAE,cAAc,CAAC,GAAG,CAAC,kBAAkB,CAAC;YACxD,mBAAmB,EAAE,cAAc,CAAC,GAAG,CAAC,qBAAqB,CAAC;YAC9D,cAAc,EAAE,cAAc,CAAC,GAAG,CAAC,eAAe,CAAC;YACnD,KAAK,EAAE,MAAM,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC;YAClC,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC;YAClD,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,kBAAkB,CAAC;SACtD,CAAA;IACH,CAAC;IAED,KAAK,UAAU,IAAI,CAAC,EAAU,EAAE,QAAQ,GAAgB,EAAE;QACxD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAW,GAAG,CAAA,iBAAiB,MAAM,eAAe,EAAE,EAAE,CAAC,CAAA;QAC5F,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QAC1B,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IACzD,CAAC;IAED,KAAK,UAAU,IAAI,CAAC,EAAU;QAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,CAAC,CAAA;QAC5B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,YAAY,CAAC;gBACrB,IAAI,EAAE,0BAA0B;gBAChC,OAAO,EAAE,4BAA4B;gBACrC,IAAI,EAAE,uDAAuD;aAC9D,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,UAAU,WAAW,CACxB,QAAqB,EACrB,OAAe,EACf,IAAoB,EACpB,MAAM,GAKF,EAAE;QAEN,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAA;oBACR,WAAW;gBACf,KAAK,CAAC,GAAG,CAAC,KAAK,OAAO,KAAK,KAAK,EAAE,KAAK,IAAI;gBAC3C,MAAM,CAAC,UAAU,IAAI,IAAI,KAAK,MAAM,CAAC,QAAQ,IAAI,IAAI;gBACrD,MAAM,CAAC,OAAO,IAAI,IAAI,KAAK,MAAM,CAAC,IAAI,IAAI,IAAI,GAAG,CAAC,CAAA;IAChE,CAAC;IAED,OAAO;QACL,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;YACrB,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YAC3D,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;YAE/B,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;gBAC3B,MAAM,IAAI,YAAY,CAAC;oBACrB,IAAI,EAAE,sBAAsB;oBAC5B,OAAO,EAAE,uCAAuC;oBAChD,IAAI,EAAE,uDAAuD;iBAC9D,CAAC,CAAA;YACJ,CAAC;YACD,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAA;YAEvD,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAA;YAErF,oEAAoE;YACpE,uEAAuE;YACvE,iEAAiE;YACjE,0CAA0C;YAC1C,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;gBAC7B,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,KAAK,CAC5C,IAAI,CAAC,UAAU,EACf,MAAM,CAAC,aAAa,EACpB,IAAI,CAAC,QAAQ,CACd,CAAA;gBACD,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBACxB,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAA;gBACzE,CAAC;YACH,CAAC;YAED,MAAM,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;YACrB,MAAM,SAAS,GAAG,aAAa,CAAC,EAAE,CAAC,CAAA;YACnC,MAAM,EAAE,GAAG,KAAK,EAAE,CAAA;YAElB,IAAI,CAAC;gBACH,mEAAmE;gBACnE,+BAA+B;gBAC/B,OAAO,MAAM,EAAE,CAAC,WAAW,CACzB,KAAK,EAAE,EAAE,EAAE,EAAE;oBACX,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,SAAS,CAChD,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;wBAC1B,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;qBACxB,CAAC,CAAC,EACH,EAAE,CACH,CAAA;oBACD,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;wBAC3B,MAAM,IAAI,gBAAgB,CAAC;4BACzB,IAAI,EAAE,cAAc;4BACpB,UAAU,EAAE,KAAK,CAAC,UAAU;yBAC7B,CAAC,CAAA;oBACJ,CAAC;oBAED,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;wBAC7B,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,MAAM,CAC/C,IAAI,CAAC,UAAU,EACf,EAAE,EACF,QAAQ,CAAC,EAAE,EACX,EAAE,CACH,CAAA;wBACD,IAAI,CAAC,OAAO,EAAE,CAAC;4BACb,8DAA8D;4BAC9D,8DAA8D;4BAC9D,qCAAqC;4BACrC,MAAM,IAAI,gBAAgB,CAAC;gCACzB,IAAI,EAAE,gBAAgB;gCACtB,MAAM,EAAE,iDAAiD;6BAC1D,CAAC,CAAA;wBACJ,CAAC;oBACH,CAAC;oBAED,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA;4BACF,MAAM;;;;;wBAKV,EAAE,KAAK,SAAS,KAAK,QAAQ,CAAC,EAAE,KAAK,QAAQ,CAAC,KAAK,KAAK,SAAS,KAAK,IAAI,CAAC,QAAQ;wBACnF,MAAM,CAAC,aAAa,KAAK,MAAM,CAAC,aAAa,KAAK,MAAM,CAAC,aAAa;wBACtE,MAAM,CAAC,QAAQ,KAAK,MAAM,CAAC,UAAU;wBACrC,IAAI,CAAC,UAAU,KAAK,IAAI,CAAC,eAAe,KAAK,IAAI,CAAC,cAAc;wBAChE,IAAI,CAAC,gBAAgB,KAAK,IAAI,KAAK,EAAE,KAAK,EAAE,KAAK,IAAI,GAAG,CAAC,CAAA;oBAErE,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;wBACtD,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA;8BACF,UAAU;;;0BAGd,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,KAAK;0BAChE,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,aAAa;0BAC5D,IAAI,CAAC,aAAa,KAAK,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC,SAAS;0BACvD,IAAI,CAAC,UAAU,KAAK,QAAQ,GAAG,CAAC,CAAA;oBAC9C,CAAC;oBAED,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,CAAA;uBACP,KAAK,iBAAiB,SAAS,gBAAgB,EAAE,kBAAkB,EAAE;2BACjE,IAAI,CAAC,EAAE,iBAAiB,MAAM,EAAE,CAAC,CAAA;oBAEhD,MAAM,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE;wBAClC,QAAQ,EAAE,SAAS;wBACnB,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;wBAC9B,IAAI,EAAE,SAAS,SAAS,UAAU;qBACnC,CAAC,CAAA;oBAEF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;oBAChC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;wBACnB,MAAM,IAAI,YAAY,CAAC;4BACrB,IAAI,EAAE,UAAU;4BAChB,OAAO,EAAE,2BAA2B;4BACpC,IAAI,EAAE,8DAA8D;yBACrE,CAAC,CAAA;oBACJ,CAAC;oBACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAA;gBAClC,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB,CAAA;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,gBAAgB;oBAAE,OAAO,KAAK,CAAC,OAAO,CAAA;gBAC3D,MAAM,KAAK,CAAA;YACb,CAAC;QACH,CAAC;QAED,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAE5B,eAAe,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE;YACnC,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,KAAK,CAC3B,GAAG,CAAA,iBAAiB,MAAM,sBAAsB,SAAS,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CACjF,CAAA;YACD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC1B,OAAO,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC/C,CAAC;QAED,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACtB,IAAI,SAAS,GAAG,GAAG,CAAA,iBAAiB,MAAM,EAAE,CAAA;YAC5C,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS,IAAI,OAAO,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBACtE,SAAS,GAAG,GAAG,CAAA,GAAG,SAAS,mBAAmB,OAAO,CAAC,MAAM,sBAAsB,OAAO,CAAC,UAAU,EAAE,CAAA;YACxG,CAAC;iBAAM,IAAI,OAAO,EAAE,MAAM,KAAK,SAAS,EAAE,CAAC;gBACzC,SAAS,GAAG,GAAG,CAAA,GAAG,SAAS,mBAAmB,OAAO,CAAC,MAAM,EAAE,CAAA;YAChE,CAAC;iBAAM,IAAI,OAAO,EAAE,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7C,SAAS,GAAG,GAAG,CAAA,GAAG,SAAS,wBAAwB,OAAO,CAAC,UAAU,EAAE,CAAA;YACzE,CAAC;YACD,SAAS,GAAG,GAAG,CAAA,GAAG,SAAS,2CAA2C,KAAK,CAAC,OAAO,EAAE,KAAK,IAAI,GAAG,CAAC,WAAW,KAAK,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC,CAAC,EAAE,CAAA;YAE1I,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,KAAK,CAAW,SAAS,CAAC,CAAA;YAClD,MAAM,OAAO,GAAY,EAAE,CAAA;YAC3B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI;gBAAE,OAAO,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;YAC9D,OAAO,OAAO,CAAA;QAChB,CAAC;QAED,UAAU,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE;YACpC,OAAO,EAAE,CAAC,WAAW,CACnB,KAAK,EAAE,EAAE,EAAE,EAAE;gBACX,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;gBAClC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;oBACrB,MAAM,IAAI,YAAY,CAAC;wBACrB,IAAI,EAAE,0BAA0B;wBAChC,OAAO,EAAE,4BAA4B;wBACrC,IAAI,EAAE,uDAAuD;qBAC9D,CAAC,CAAA;gBACJ,CAAC;gBAED,gBAAgB,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;gBAEpC,iEAAiE;gBACjE,oEAAoE;gBACpE,yDAAyD;gBACzD,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;oBAClD,MAAM,YAAY,CAAC,OAAO,CAAC,OAAO,CAChC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;wBAC3B,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;qBACxB,CAAC,CAAC,EACH,EAAE,CACH,CAAA;gBACH,CAAC;gBAED,qEAAqE;gBACrE,8DAA8D;gBAC9D,8DAA8D;gBAC9D,IAAI,EAAE,KAAK,WAAW,IAAI,OAAO,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;oBACtD,MAAM,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;gBAC5C,CAAC;gBAED,MAAM,EAAE,CAAC,KAAK,CACZ,GAAG,CAAA,UAAU,MAAM,iBAAiB,EAAE,kBAAkB,KAAK,EAAE,eAAe,EAAE,EAAE,CACnF,CAAA;gBAED,MAAM,WAAW,CAAC,EAAE,EAAE,EAAE,EAAE,gBAAgB,EAAE;oBAC1C,UAAU,EAAE,OAAO,CAAC,MAAM;oBAC1B,QAAQ,EAAE,EAAE;oBACZ,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI;oBACjC,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,IAAI;iBAC5B,CAAC,CAAA;gBAEF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;gBAClC,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;oBACrB,MAAM,IAAI,YAAY,CAAC;wBACrB,IAAI,EAAE,0BAA0B;wBAChC,OAAO,EAAE,oDAAoD;wBAC7D,IAAI,EAAE,yBAAyB;qBAChC,CAAC,CAAA;gBACJ,CAAC;gBACD,OAAO,OAAO,CAAA;YAChB,CAAC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,CACpB,CAAA;QACH,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;YACpB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,KAAK,CAC3B,GAAG,CAAA,iBAAiB,WAAW,qBAAqB,EAAE,0BAA0B,CACjF,CAAA;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBAC/B,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,gBAAgB,CAAC;gBACpC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,sBAAsB,CAAC;gBACrD,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,gBAAgB,CAAC;gBACpC,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,kBAAkB,CAAmB;gBAC5D,UAAU,EAAE,cAAc,CAAC,GAAG,CAAC,WAAW,CAAuB;gBACjE,QAAQ,EAAE,cAAc,CAAC,GAAG,CAAC,SAAS,CAAuB;gBAC7D,OAAO,EAAE,cAAc,CAAC,GAAG,CAAC,QAAQ,CAAC;gBACrC,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC;aAC/B,CAAC,CAAC,CAAA;QACL,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE;YACtC,IAAI,EAAE,KAAK,SAAS;gBAAE,MAAM,IAAI,CAAC,EAAE,CAAC,CAAA;YACpC,MAAM,WAAW,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE;gBACpC,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,IAAI;gBACjC,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,IAAI;aAC5B,CAAC,CAAA;QACJ,CAAC;KACF,CAAA;AACH,CAAC;AAED,gFAAgF;AAChF,MAAM,gBAAiB,SAAQ,KAAK;IACzB,OAAO,CAAgD;IAEhE,YAAY,OAAuD;QACjE,KAAK,CAAC,4BAA4B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;QACjD,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAA;QAC9B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF"}

package/dist/order/types.d.ts

@@ -0,0 +1,67 @@
+/**
+ * What can happen to an order, and in what order.
+ *
+ * A closed union with an explicit transition table, rather than a free string
+ * and a hope. Two things follow from that and both matter: an impossible
+ * transition ("delivered" back to "pending") is refused rather than recorded,
+ * and every screen that switches on a status is forced by the compiler to
+ * handle a new one the day it is added.
+ */
+export declare const ORDER_STATUSES: readonly ['pending', 'paid', 'shipped', 'delivered', 'cancelled', 'refunded'];
+export type OrderStatus = (typeof ORDER_STATUSES)[number];
+export declare function canTransition(from: OrderStatus, to: OrderStatus): boolean;
+export declare function assertTransition(from: OrderStatus, to: OrderStatus): void;
+/** Statuses in which the goods are still promised, so stock stays taken. */
+export declare function holdsStock(status: OrderStatus): boolean;
+export interface OrderLine {
+    readonly id: string;
+    readonly variantId: string;
+    /** Copied at placement. A product renamed next year must not rewrite history. */
+    readonly sku: string;
+    readonly title: string;
+    readonly quantity: number;
+    readonly unitPriceMinor: number;
+    readonly subtotalMinor: number;
+    readonly discountMinor: number;
+    readonly taxMinor: number;
+    readonly taxRateBp: number;
+    readonly totalMinor: number;
+    readonly position: number;
+}
+export interface Order {
+    readonly id: string;
+    /** Human-facing, unique, unrelated to any invoice number. */
+    readonly reference: string;
+    readonly customerId: string | null;
+    readonly email: string;
+    readonly status: OrderStatus;
+    readonly currency: string;
+    readonly subtotalMinor: number;
+    readonly discountMinor: number;
+    readonly shippingMinor: number;
+    readonly taxMinor: number;
+    readonly totalMinor: number;
+    readonly couponCode: string | null;
+    readonly shippingCountry: string | null;
+    readonly shippingRegion: string | null;
+    readonly shippingMethodId: string | null;
+    readonly shippingMethodLabel: string | null;
+    readonly subscriptionId: string | null;
+    readonly lines: readonly OrderLine[];
+    readonly placedAt: string;
+    readonly updatedAt: string;
+}
+export declare const ORDER_EVENT_KINDS: readonly ['placed', 'status_changed', 'payment_started', 'payment_settled', 'payment_failed', 'refunded', 'invoiced', 'note'];
+export type OrderEventKind = (typeof ORDER_EVENT_KINDS)[number];
+/** One line of an order's history. Append-only: nothing here is ever edited. */
+export interface OrderEvent {
+    readonly id: string;
+    readonly orderId: string;
+    readonly at: string;
+    readonly kind: OrderEventKind;
+    readonly fromStatus: OrderStatus | null;
+    readonly toStatus: OrderStatus | null;
+    readonly actorId: string | null;
+    readonly note: string | null;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/order/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/order/types.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,YACzB,SAAS,EACT,MAAM,EACN,SAAS,EACT,WAAW,EACX,WAAW,EACX,UAAU,CACF,CAAA;AACV,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAA;AAyBzD,wBAAgB,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,GAAG,OAAO,CAEzE;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,GAAG,IAAI,CAazE;AAED,4EAA4E;AAC5E,wBAAgB,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAEvD;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,iFAAiF;IACjF,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;IAC/B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,6DAA6D;IAC7D,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;IAC5B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3C,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,SAAS,EAAE,CAAA;IACpC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;CAC3B;AAED,eAAO,MAAM,iBAAiB,YAC5B,QAAQ,EACR,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,MAAM,CACE,CAAA;AACV,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/D,gFAAgF;AAChF,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B,QAAQ,CAAC,UAAU,EAAE,WAAW,GAAG,IAAI,CAAA;IACvC,QAAQ,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAA;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAC7B"}

package/dist/order/types.js

@@ -0,0 +1,71 @@
+import { CogentaError } from '@cogenta/core';
+/**
+ * What can happen to an order, and in what order.
+ *
+ * A closed union with an explicit transition table, rather than a free string
+ * and a hope. Two things follow from that and both matter: an impossible
+ * transition ("delivered" back to "pending") is refused rather than recorded,
+ * and every screen that switches on a status is forced by the compiler to
+ * handle a new one the day it is added.
+ */
+export const ORDER_STATUSES = [
+    'pending',
+    'paid',
+    'shipped',
+    'delivered',
+    'cancelled',
+    'refunded',
+];
+/**
+ * The transitions a shop actually performs.
+ *
+ * Deliberately not a full graph. Notably absent:
+ *
+ * - nothing leaves `delivered` except `refunded`. Goods that arrived did
+ *   arrive; the remedy is a refund, not a rewind.
+ * - nothing leaves `cancelled` or `refunded` at all. Both are ends. Reviving a
+ *   cancelled order would mean re-taking stock that was already put back,
+ *   which is a second sale wearing the first one's number.
+ * - `pending → shipped` is not allowed. Sending goods before payment is a
+ *   decision a person makes deliberately, by marking the order paid first, so
+ *   that the reason is recorded rather than implied.
+ */
+const TRANSITIONS = {
+    pending: ['paid', 'cancelled'],
+    paid: ['shipped', 'cancelled', 'refunded'],
+    shipped: ['delivered', 'refunded'],
+    delivered: ['refunded'],
+    cancelled: [],
+    refunded: [],
+};
+export function canTransition(from, to) {
+    return (TRANSITIONS[from] ?? []).includes(to);
+}
+export function assertTransition(from, to) {
+    if (canTransition(from, to))
+        return;
+    const allowed = TRANSITIONS[from] ?? [];
+    throw new CogentaError({
+        code: 'COMMERCE_ORDER_TRANSITION_INVALID',
+        message: `An order that is ${from} cannot become ${to}.`,
+        hint: allowed.length === 0
+            ? `${from} is a final state. Nothing follows it.`
+            : `From ${from}, an order can become: ${allowed.join(', ')}.`,
+        details: { from, to },
+    });
+}
+/** Statuses in which the goods are still promised, so stock stays taken. */
+export function holdsStock(status) {
+    return status === 'pending' || status === 'paid' || status === 'shipped' || status === 'delivered';
+}
+export const ORDER_EVENT_KINDS = [
+    'placed',
+    'status_changed',
+    'payment_started',
+    'payment_settled',
+    'payment_failed',
+    'refunded',
+    'invoiced',
+    'note',
+];
+//# sourceMappingURL=types.js.map

package/dist/order/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/order/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS;IACT,MAAM;IACN,SAAS;IACT,WAAW;IACX,WAAW;IACX,UAAU;CACF,CAAA;AAGV;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,GAA0D;IACzE,OAAO,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;IAC9B,IAAI,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC;IAC1C,OAAO,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC;IAClC,SAAS,EAAE,CAAC,UAAU,CAAC;IACvB,SAAS,EAAE,EAAE;IACb,QAAQ,EAAE,EAAE;CACb,CAAA;AAED,MAAM,UAAU,aAAa,CAAC,IAAiB,EAAE,EAAe;IAC9D,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;AAC/C,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,IAAiB,EAAE,EAAe;IACjE,IAAI,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC;QAAE,OAAM;IAEnC,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE,CAAA;IACvC,MAAM,IAAI,YAAY,CAAC;QACrB,IAAI,EAAE,mCAAmC;QACzC,OAAO,EAAE,oBAAoB,IAAI,kBAAkB,EAAE,GAAG;QACxD,IAAI,EACF,OAAO,CAAC,MAAM,KAAK,CAAC;YAClB,CAAC,CAAC,GAAG,IAAI,wCAAwC;YACjD,CAAC,CAAC,QAAQ,IAAI,0BAA0B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;QACjE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;KACtB,CAAC,CAAA;AACJ,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,UAAU,CAAC,MAAmB;IAC5C,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,MAAM,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,WAAW,CAAA;AACpG,CAAC;AA0CD,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ;IACR,gBAAgB;IAChB,iBAAiB;IACjB,iBAAiB;IACjB,gBAAgB;IAChB,UAAU;IACV,UAAU;IACV,MAAM;CACE,CAAA"}

package/dist/payment/manual.d.ts

@@ -0,0 +1,27 @@
+import type { PaymentConfig, PaymentDriver, PaymentGateway } from './types.js';
+/**
+ * Payment by bank transfer. The degraded driver, and a real way to be paid.
+ *
+ * R1 and R2 are not negotiable: a shop must work end to end with no Stripe
+ * account, no API key and no outbound network. This is what makes that true.
+ * It is emphatically **not** a stub — a great many businesses invoice and are
+ * paid by transfer, and nothing else. The difference from Stripe is not
+ * "pretend" versus "real", it is *who confirms the money arrived*: a gateway
+ * says so over an API, and here a human says so, by marking the payment
+ * received once they have seen it on the statement.
+ *
+ * That is why it holds no state of its own. There is nothing to poll: the
+ * truth lives in the payment row that `PaymentStore` owns, and a driver that
+ * kept a second copy would only be able to disagree with it.
+ */
+/** The reference a shopper is asked to put on the transfer. */
+export declare function transferReference(orderReference: string): string;
+export declare function createManualPaymentGateway(config?: PaymentConfig): PaymentGateway;
+/**
+ * The degraded tier, and therefore the last one the registry tries — and the
+ * one it always finds. `available()` is unconditionally true because there is
+ * nothing that could be unavailable, which is precisely the property R1 asks a
+ * degraded driver to have.
+ */
+export declare function manualPaymentDriver(): PaymentDriver;
+//# sourceMappingURL=manual.d.ts.map

package/dist/payment/manual.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manual.d.ts","sourceRoot":"","sources":["../../src/payment/manual.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAGV,aAAa,EACb,aAAa,EACb,cAAc,EAEf,MAAM,YAAY,CAAA;AAEnB;;;;;;;;;;;;;;GAcG;AAEH,+DAA+D;AAC/D,wBAAgB,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM,CAEhE;AAkBD,wBAAgB,0BAA0B,CAAC,MAAM,GAAE,aAAkB,GAAG,cAAc,CA6CrF;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,aAAa,CAwBnD"}

package/dist/payment/manual.js

@@ -0,0 +1,105 @@
+import { CogentaError } from '@cogenta/core';
+import { assertCurrency, assertMinor, formatMoney } from '../money.js';
+/**
+ * Payment by bank transfer. The degraded driver, and a real way to be paid.
+ *
+ * R1 and R2 are not negotiable: a shop must work end to end with no Stripe
+ * account, no API key and no outbound network. This is what makes that true.
+ * It is emphatically **not** a stub — a great many businesses invoice and are
+ * paid by transfer, and nothing else. The difference from Stripe is not
+ * "pretend" versus "real", it is *who confirms the money arrived*: a gateway
+ * says so over an API, and here a human says so, by marking the payment
+ * received once they have seen it on the statement.
+ *
+ * That is why it holds no state of its own. There is nothing to poll: the
+ * truth lives in the payment row that `PaymentStore` owns, and a driver that
+ * kept a second copy would only be able to disagree with it.
+ */
+/** The reference a shopper is asked to put on the transfer. */
+export function transferReference(orderReference) {
+    return orderReference.toUpperCase();
+}
+const DEFAULT_INSTRUCTIONS = 'Pay by bank transfer. Your order is reserved and will be prepared once the transfer arrives.';
+function instructionsFor(config, request) {
+    const amount = formatMoney({
+        amountMinor: request.amountMinor,
+        currency: request.currency,
+    });
+    const preamble = config.transferInstructions ?? DEFAULT_INSTRUCTIONS;
+    return [
+        preamble,
+        `Amount: ${amount}`,
+        `Reference to quote: ${transferReference(request.orderReference)}`,
+    ].join('\n');
+}
+export function createManualPaymentGateway(config = {}) {
+    return {
+        name: 'manual',
+        settlesOffline: true,
+        start: async (request) => {
+            assertMinor(request.amountMinor, 'A payment amount');
+            assertCurrency(request.currency);
+            return {
+                // The order's own reference *is* the external id here: it is what the
+                // shopper types into their bank, and what the operator matches against
+                // the statement. Inventing a second identifier would only give a human
+                // two numbers to reconcile instead of one.
+                externalId: transferReference(request.orderReference),
+                status: 'pending',
+                instructions: instructionsFor(config, request),
+            };
+        },
+        fetch: async (externalId) => ({
+            externalId,
+            // Deliberately unchanged. There is nothing to ask: no API knows whether
+            // this transfer landed, and returning anything else would be a guess
+            // dressed up as a fact.
+            status: 'pending',
+            instructions: null,
+        }),
+        refund: async (request) => {
+            assertMinor(request.amountMinor, 'A refund amount');
+            assertCurrency(request.currency);
+            // A transfer back is made by a human too. `pending` is honest: the money
+            // has not moved yet, and only the operator can say when it has.
+            return { externalId: request.externalId, status: 'pending' };
+        },
+        verifyEvent: async () => {
+            throw new CogentaError({
+                code: 'COMMERCE_PAYMENT_UNSUPPORTED',
+                message: 'Bank transfer has no inbound notification to verify.',
+                hint: 'A transfer is confirmed by a person marking the payment received, not by a webhook.',
+            });
+        },
+    };
+}
+/**
+ * The degraded tier, and therefore the last one the registry tries — and the
+ * one it always finds. `available()` is unconditionally true because there is
+ * nothing that could be unavailable, which is precisely the property R1 asks a
+ * degraded driver to have.
+ */
+export function manualPaymentDriver() {
+    let gateway;
+    return {
+        name: 'manual',
+        tier: 'degraded',
+        available: async () => true,
+        init: async (config) => {
+            gateway = createManualPaymentGateway(config);
+            return gateway;
+        },
+        dispose: async () => {
+            gateway = undefined;
+        },
+        health: async () => ({
+            status: 'ok',
+            driver: 'manual',
+            tier: 'degraded',
+            message: gateway === undefined
+                ? 'Not started yet. Bank transfer needs no external service.'
+                : 'Bank transfer needs no external service, so it is never down.',
+        }),
+    };
+}
+//# sourceMappingURL=manual.js.map

package/dist/payment/manual.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manual.js","sourceRoot":"","sources":["../../src/payment/manual.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAqB,MAAM,eAAe,CAAA;AAC/D,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAUtE;;;;;;;;;;;;;;GAcG;AAEH,+DAA+D;AAC/D,MAAM,UAAU,iBAAiB,CAAC,cAAsB;IACtD,OAAO,cAAc,CAAC,WAAW,EAAE,CAAA;AACrC,CAAC;AAED,MAAM,oBAAoB,GACxB,8FAA8F,CAAA;AAEhG,SAAS,eAAe,CAAC,MAAqB,EAAE,OAA4B;IAC1E,MAAM,MAAM,GAAG,WAAW,CAAC;QACzB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B,CAAC,CAAA;IACF,MAAM,QAAQ,GAAG,MAAM,CAAC,oBAAoB,IAAI,oBAAoB,CAAA;IACpE,OAAO;QACL,QAAQ;QACR,WAAW,MAAM,EAAE;QACnB,uBAAuB,iBAAiB,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;KACnE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACd,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,MAAM,GAAkB,EAAE;IACnE,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,cAAc,EAAE,IAAI;QAEpB,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;YACvB,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;YACpD,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAEhC,OAAO;gBACL,sEAAsE;gBACtE,uEAAuE;gBACvE,uEAAuE;gBACvE,2CAA2C;gBAC3C,UAAU,EAAE,iBAAiB,CAAC,OAAO,CAAC,cAAc,CAAC;gBACrD,MAAM,EAAE,SAAS;gBACjB,YAAY,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC;aAC/C,CAAA;QACH,CAAC;QAED,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;YAC5B,UAAU;YACV,wEAAwE;YACxE,qEAAqE;YACrE,wBAAwB;YACxB,MAAM,EAAE,SAAS;YACjB,YAAY,EAAE,IAAI;SACnB,CAAC;QAEF,MAAM,EAAE,KAAK,EAAE,OAA4B,EAA+B,EAAE;YAC1E,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAA;YACnD,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;YAChC,yEAAyE;YACzE,gEAAgE;YAChE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAA;QAC9D,CAAC;QAED,WAAW,EAAE,KAAK,IAAI,EAAE;YACtB,MAAM,IAAI,YAAY,CAAC;gBACrB,IAAI,EAAE,8BAA8B;gBACpC,OAAO,EAAE,sDAAsD;gBAC/D,IAAI,EAAE,qFAAqF;aAC5F,CAAC,CAAA;QACJ,CAAC;KACF,CAAA;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB;IACjC,IAAI,OAAmC,CAAA;IAEvC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,UAAU;QAChB,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI;QAC3B,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;YACrB,OAAO,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAA;YAC5C,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,OAAO,EAAE,KAAK,IAAI,EAAE;YAClB,OAAO,GAAG,SAAS,CAAA;QACrB,CAAC;QACD,MAAM,EAAE,KAAK,IAA2B,EAAE,CAAC,CAAC;YAC1C,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,UAAU;YAChB,OAAO,EACL,OAAO,KAAK,SAAS;gBACnB,CAAC,CAAC,2DAA2D;gBAC7D,CAAC,CAAC,+DAA+D;SACtE,CAAC;KACH,CAAA;AACH,CAAC"}

package/dist/payment/registry.d.ts

@@ -0,0 +1,23 @@
+import { type DriverRegistry, type Logger } from '@cogenta/core';
+import type { PaymentConfig, PaymentGateway } from './types.js';
+export interface PaymentRegistryOptions {
+    readonly logger?: Logger;
+}
+/**
+ * The payment gateways Cogenta ships.
+ *
+ * Registered in tier order, exactly like cache, queue, storage and database:
+ * Stripe is `optimal` and answers only when a key is configured and the API
+ * responds; bank transfer is `degraded` and always answers. So a site with no
+ * Stripe account does not fail to start and does not fall over at checkout —
+ * it takes bank transfers, which is a real way to be paid, not a placeholder.
+ *
+ * The registry's two rules apply here with more force than anywhere else in
+ * the project. If the configuration **names** Stripe, a Stripe outage is fatal
+ * rather than a silent downgrade: quietly switching a shop that expects card
+ * payments over to "please make a transfer" would change what customers are
+ * asked to do without anybody deciding to. If the configuration names nothing,
+ * the fall-through is the point.
+ */
+export declare function createPaymentRegistry(options?: PaymentRegistryOptions): DriverRegistry<PaymentGateway, PaymentConfig>;
+//# sourceMappingURL=registry.d.ts.map

package/dist/payment/registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/payment/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,KAAK,cAAc,EAAE,KAAK,MAAM,EAAE,MAAM,eAAe,CAAA;AAGtF,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE/D,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,GAAE,sBAA2B,GACnC,cAAc,CAAC,cAAc,EAAE,aAAa,CAAC,CAW/C"}