| @@ -21,18 +21,8 @@ | ||
| 21 | 21 | **Plugin State**: |
| 22 | 22 | Machine bookkeeping stored in options but not user intent: site UUID, JWT secret keys, install timestamp, DB version. Owned by the module that uses it (e.g. Auth owns its secret keys), never by the Settings module. |
| 23 | 23 | _Avoid_: settings (for these), internal options |
| 24 | 24 | |
| 25 | -### Receipts | |
| 26 | - | |
| 27 | -**Receipt Data**: | |
| 28 | -The JSON payload a receipt template renders from: `order`, `store`, `cashier`, `customer`, `lines`, `fees`, `shipping`, `discounts`, `totals`, `tax`, `tax_summary`, `payments`, `refunds`, `fiscal`, `presentation_hints`. Built by a source (a live WooCommerce order, or the sample the template editor and gallery use), filtered through `woocommerce_pos_receipt_data`, then rendered identically on the server and offline in the app. Logic-less by ADR 0039: templates branch on data the payload carries. | |
| 29 | -_Avoid_: receipt JSON, receipt context, template data | |
| 30 | - | |
| 31 | -**Receipt Section**: | |
| 32 | -One named block of Receipt Data and the shape of its rows. Money keys come in triples (`total`, `total_incl`, `total_excl`) with the bare key filled from the store's tax display basis. Row shapes and the aggregate rules of `totals` (subtotals, item counts, net total after refunds, savings completeness) are declared once in the Receipt Sections module; a source supplies priced values, it never declares keys. | |
| 33 | -_Avoid_: receipt block, payload part, builder output | |
| 34 | - | |
| 35 | 25 | ### Sync |
| 36 | 26 | |
| 37 | 27 | **Collection Rule**: |
| 38 | 28 | One POS query behaviour for one collection — the params it claims, the clauses it contributes, the storage it targets — declared once in the Collection Rules module and applied identically on every read lane, so it cannot be wired into only one. |
| @@ -40,20 +30,8 @@ | ||
| 40 | 30 | |
| 41 | 31 | **Read Lane**: |
| 42 | 32 | One of the two paths a collection read reaches the client by — the direct lane (`wcpos/v1` controllers, plus the flat `wcpos/v2` routes with no `wc/v3` proxy backing, e.g. `/variations`) and the proxy lane (`wcpos/v2` → `wc/v3`). Behaviour that exists on one lane only is a parity bug, not a design. (Code comments also say "lane" for the request shapes *within* one route — include lane, discovery lane; that narrower sense is not this term.) |
| 43 | 33 | _Avoid_: v1/v2 API, endpoint version |
| 44 | - | |
| 45 | -**Write Payload shape**: | |
| 46 | -The one pass an order document takes through the Order Write Payload module before WooCommerce sees it, named by what an absent line means. The _full-document_ shape (`for_update`, the `wcpos/v2` push lane) treats the document as the whole order: an omitted stored line is deleted and coupon lines are reconciled. The _partial-document_ shape (`for_partial_update`, the `wcpos/v1` lane) keeps WooCommerce's own semantics: an absent line is untouched and coupon lines pass through to the controller. Both shapes share every other rule; a rule that exists in one shape only is a ruling (recorded on the module), not a drift. | |
| 47 | -_Avoid_: v1 sanitizer, v2 forward rules, payload filter | |
| 48 | - | |
| 49 | -**Create Identity**: | |
| 50 | -The proof that a record born on the `wcpos/v2` push lane owns its client UUID before the mutation is finalized: poison checkpoint, UUID persisted, resolved back to the same id, checkpoint finalized. Written once in the Create Identity module; a retry against a `poison` checkpoint re-enters the same proof rather than running a second copy. ADR 0038 decides when identity is re-proved; this module decides where the proof lives. | |
| 51 | -_Avoid_: poison retry, identity stamp, recovery path | |
| 52 | - | |
| 53 | -**Promoted Service**: | |
| 54 | -A shared POS service (auth, settings, cashier, receipts, print jobs, stores, extensions, logs, gateways, checkout, templates, shipping methods, tax classes, order statuses) that answers identically under `wcpos/v1` and `wcpos/v2`. The Controller Registry derives the v2 map from the v1 map, so promotion is the default and only the nine frozen data controllers (the sync surface replaced them, #544) are excluded. | |
| 55 | -_Avoid_: v2 twin, pass-through subclass, v2 controllers map | |
| 56 | 34 | |
| 57 | 35 | **Replica policy**: |
| 58 | 36 | What a collection's client-side copy aims to hold: `complete` (a full replica, e.g. products, |
| 59 | 37 | variations) or `windowed` (a bounded recent window of an unbounded set, e.g. orders). |
