Files
member-console/docs/models
cgalo5758 fa614d0fb7 Ask for a subscription reconcile from every act that changes who holds a ladder
Fourth section of #269's change. Every act that can change who holds a
ladder now writes one reconcile_subscription outbox entry per live
subscription of the organization (active, trialing, past_due or unpaid,
in id order), in the act's own transaction, so each subscription's
collection pause is decided again after the act commits. The entry is
an insert and takes no lock.

The acts: issuing a grant (entitlements.IssueGrant, which the issue
handler now calls in place of ConferGrant), managing, revoking and
expiring one, the legacy grant a default change confers, and removing a
tier from a ladder. ConferGrantTx itself requests nothing, because the
conferral and provisioning paths that call it run before the
subscription exists or reconcile it themselves. In the reconcile, the
ended branch and the surplus end request the organization's other
subscriptions, excepting the one being reconciled.

The screens utility waits until the application database holds no
pending or failed outbox row before its first capture, because the demo
seed's revocation and expiry now leave two entries the running app's
relay completes on its own schedule.

docs/stripe.md rewrites the grant over a paid plan: the console pauses
the subscription's collection while the grant holds, and the costs that
pause accepts are listed. docs/models/plan-ladders-transitions.md,
docs/plan-management.md, docs/models/payments-billing.md and
docs/database-locks.md say the same.

Tests: TestActsRequestSubscriptionReconciles (six acts, two live
subscriptions and a canceled one, ids and creation order differing),
TestConferGrantTxRequestsNothing,
TestReconcileEndedRequestsTheOtherSubscriptions,
TestSurplusEndRequestsTheOtherSubscriptions,
TestIssueGrantHandlerRequestsAReconcile, and the demo seed's entries.
Seven trace goldens gain the ListLiveSubscriptionsOfPool read.

Review: no blocker or major; six minors and six nits applied (a step
name for the tier removal's request error, the fixture's id order, doc
comments and the docs that still said a grant over a paid plan keeps
billing).

Breaks: 17 of 17 caught. Ignoring the exception is caught only through
the surplus end: in the ended branch the excepted subscription is
already canceled, so the live read never lists it. Full suite on reset
databases: 4768 pass, 14 skip. make screens: no change beyond the three
captures every run since section 2 redraws.
2026-10-28 02:18:02 -05:00
..

title, audience, summary
title audience summary
Domain Model Cards
developer
One card per domain model: purpose, invariants, dimensions, drift traps, and open questions, each claim cited to the migration, file, or decision that enforces it.

Domain Model Cards

Each card in this directory describes one domain model as it is actually built, so a maintainer can modify that model without re-deriving its rules from migrations, specs, and decision documents. The cards are the descriptive home for the as-built models; the normative record — the designed schema, the decision log, the numbered design documents, and the glossary — lives in the synced design/ directory (Decision 141, design/documents/doc-43-schema-topology-and-documentation-division.md). Migrations are the ground truth for as-built claims.

The catalog was motivated by a 2026-07 inventory of the console's domain models, which traced the majority of a 56-finding UX audit to model-attributable causes: rules that lived only in prose, invariants enforced nowhere, and dimensions that were easy to conflate because no single page named them side by side.

The cards

  • Product / catalog — how capabilities are packaged, priced, and sold; the dissolved kind taxonomy and the shape views that replaced it.
  • Payments and Billing — billing accounts, subscriptions, invoices and payments projected from Stripe, scheduled changes as intent, and the reconciler.
  • Plan Ladders and Transitions — ranked tiers, who occupies which rung, the append-only audit, and the conferral functions as sole writers.
  • Entitlements — resource keys, sets and rules, grants as decrees, provisions as delivery, and the materializer.
  • Acts — the act record for actions that write several rows, the plan acts' details, the obligations a default change or reorder owes its organizations, and the functions that are the only writers of its tables.
  • Resource Pools — the per-organization container: workspace assignments, the two resolution directions, and pool-grain usage.
  • Providers and Integrations — the registry and its connections, boot-time manifests, resource-key ownership, desired-state delivery, and the shared substrate.
  • Domains Registry — claims as subtree ownership, placements as the only thing that serves, and the anti-abuse ledger.
  • Identity, Organizations, and Workspaces — users vs persons, the containment ladder, org types as policy, and first-login provisioning.

A new domain model is not considered documented until its card exists and is listed here.

Card anatomy

Every card has four sections in this order:

  • Purpose — what the model owns and why it exists, in plain present tense.
  • Where this lives — a map of the model's pieces: each table, view, function, and code file, with one line saying what it is. Locations live here, not scattered through the body.
  • Invariants — the rules the model guarantees, one per numbered entry so reviews can cite "invariant 3". Each entry carries an enforcement tag matching the actual mechanism: [db] means the database schema rejects violations outright; [db-code] means the database functions are written to uphold the rule, so reviews must protect it when they change; [app] means only application code upholds the rule, so new code paths must uphold it too.
  • Dimensions — the orthogonal axes a maintainer must hold simultaneously, each defined where it is named.

Cards describe the model as it is today, for a reader who knows nothing yet. That means: no history, no decision numbers, no change narrative in the body — a card introduces every table, column, view, and concept before or where it first uses it. Drift between design and code, open questions, and other bookkeeping live on the forge tracker, not in the cards.

Style contract

Card prose follows these rules, and edits are reviewed against them:

  • Write for someone with zero context: never assume the reader knows a term, a table, or an internal codename you haven't introduced.
  • Name the agent: state what acted and what it acted on.
  • Give each verb its own object; do not let one object serve two verbs.
  • Connect clauses with explicit causal or temporal words (because, so, when, after) — never with a bare comma.
  • Replace every metaphor or compressed phrase with the literal claim it stands for.
  • Give every count or statistic its denominator.

A change that alters an invariant, dimension, or map entry recorded on a card must update that card in the same change (see openspec/specs/model-catalog/spec.md once this change archives).