@hyperscale0/hsx 1.0.342 → 1.0.347

package/examples/savings.hsx

@@ -1,7 +1,6 @@
 // Seattle shopkeepers circle collects 500 SAR from each of six members every month.
 // Each member receives one 3,000 SAR pot in order; missed contributions remain payable and an unfunded pot waits.
 program neighbourhood_savings "Seattle shopkeepers circle"
-use savings
 
 // Fee: 0%. Tax: 0% because this circle only returns members' principal and
 // charges no service. The organiser keeps none of the 18,000 SAR contributed.

package/examples/serviced.hsx

@@ -1,10 +1,6 @@
 // Denver delivery van finance funds a 69,000 SAR van with 10% down and 36 monthly instalments.
 // It records reminders, late charges, hardship extensions, early repayment and financed returns.
 program car_financing "Denver delivery van finance"
-use escrow
-use financing
-use purchase
-use collections
 party dealer: business
 
 // The dealer invoices 60,000 SAR plus 15% VAT. Set price to 69,000 SAR.

package/examples/wallet.hsx

@@ -1,7 +1,6 @@
 // York pottery studio lets members prepay for visits at 172.50 SAR each.
 // A reserved visit can be charged, cancelled or released at expiry; unused credit can be withdrawn.
 program workshop_credits "York pottery studio"
-use wallet
 
 // Top-up fee: 0%. Loading and withdrawing credit have tax 0% here because
 // they do not sell a visit. Each visit is 150 SAR plus 15% VAT, invoiced by

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperscale0/hsx",
-  "version": "1.0.342",
+  "version": "1.0.347",
   "description": "The strictly typed HSX language: compile total financial programs into canonical UDL.",
   "keywords": [
     "hsx",
@@ -90,8 +90,8 @@
     "bases:bundle": "bun scripts/bundle-bases.ts"
   },
   "dependencies": {
-    "@hyperscale0/adl": "1.0.342",
-    "@hyperscale0/udl": "1.0.342",
+    "@hyperscale0/adl": "1.0.347",
+    "@hyperscale0/udl": "1.0.347",
     "fast-sha256": "1.3.0"
   },
   "devDependencies": {
@@ -103,5 +103,5 @@
     "Amir Ayub",
     "Sara AlBakaawi"
   ],
-  "gitHead": "e17fb66eb7dc3ff851b93934665225d065b02cfb"
+  "gitHead": "010c1b8d88b7d61ec9f65a6062fcfc65ea3dd976"
 }

package/src/ast.ts

@@ -80,15 +80,68 @@ export type Decl =
       role?: string;
       span: Span;
     }
-  | { kind: "use"; name: string; span: Span }
-  | { kind: "expose"; target: string; name: string; span: Span }
-  | { kind: "hide"; target: string; span: Span };
+  | { kind: "expose"; target: string; name: string; span: Span };
+/** A name as written, so a check diagnostic points at it. */
+export interface Named {
+  name: string;
+  span: Span;
+}
+/** One statement of a `check` block. Every step may end with `balances { }`. */
+export type CheckStatement = { span: Span; balances?: BlockExpr } & (
+  | {
+      kind: "customer";
+      id: Named;
+      title: string;
+      organization: boolean;
+      fund?: Expr;
+      binds: Named[];
+    }
+  | {
+      kind: "clock";
+      at: Expr;
+      until?: {
+        object: Named;
+        attachment?: Named;
+        recordPath?: string;
+        state: Named;
+      };
+    }
+  | {
+      kind: "object";
+      id: Named;
+      objectKind: Named;
+      owner: Named;
+      fields?: BlockExpr;
+    }
+  | {
+      kind: "action";
+      actor?: Named;
+      object: Named;
+      action: Named;
+      input?: BlockExpr;
+      fields?: BlockExpr;
+      instance?: Named;
+      remember?: Named;
+      state?: Named;
+      status?: Expr;
+      code?: string;
+    }
+  | { kind: "close"; customer: Named }
+  | { kind: "expect"; held?: Expr; pending?: BlockExpr }
+);
+export interface CheckDecl {
+  name: string;
+  statements: CheckStatement[];
+  span: Span;
+}
 export interface Program {
   name: string;
   title: string;
   currency: string;
   header: boolean;
   decls: Decl[];
+  /** Build data beside the document; compile never lowers them into it. */
+  checks: CheckDecl[];
   span: Span;
 }
 export const lineColAt = (source: string, offset: number) => {

package/src/bases-bundle.ts

@@ -1,15 +1,15 @@
 // Generated by open/hsx/scripts/bundle-bases.ts. Do not edit by hand.
 import type { HsxBase } from "./bases.ts";
 export const bases: HsxBase[] = [
-  {"id":"cards","title":"Control card spending","summary":"Reserve a card payment within its spending limit before capture.","headers":["cards"],"source":"// Reserve a card payment within its spending limit before capture.\nprogram cards_base \"Control card spending\"\nuse cards\nparty seller: business\n\nobject card \"Card\" {\n  attach holder = cards.cardholder {\n    holder: owner\n    expose create as create_holder\n    expose activate as activate_holder\n    expose suspend as suspend_holder\n    expose resume as resume_holder\n    expose close as close_holder\n  }\n  attach card = cards.card {\n    holder: holder, person: owner, issuer: operator, spend_limit: runtime\n    expose create as create_card\n    expose activate as activate_card\n    expose freeze as freeze_card\n    expose unfreeze as unfreeze_card\n    expose issuer_freeze as issuer_freeze_card\n    expose issuer_unfreeze as issuer_unfreeze_card\n    expose cancel as cancel_card\n  }\n  attach payment = cards.authorization {\n    card: card, merchant: seller, issuer: operator\n    expose create as create\n    expose approve as approve\n    expose decline as decline\n    expose capture as capture\n    expose reverse as reverse\n  }\n  attach receipt = cards.transaction {\n    authorization: payment\n    expose create as record_payment\n    expose refund as refund\n  }\n}\n"},
-  {"id":"collections","title":"Follow up overdue payments","summary":"Refer overdue instalments for collection and limit contact attempts.","headers":["collections","financing"],"source":"// Refer overdue instalments for collection and limit contact attempts.\nprogram collections_base \"Follow up overdue payments\"\nuse collections\nuse financing\nparty collector: business\n\nobject plan \"Plan\" {\n  fields { price: money }\n  attach allowance = financing.limits {\n    borrower: owner, per_borrower: runtime\n    expose create as request_limit\n    expose approve as approve_limit\n  }\n  attach budget = financing.portfolio_limit {\n    limit: runtime\n    expose create as create_budget\n    expose approve as approve_budget\n  }\n  // Architect sets the placeholder profit rate during tailoring.\n  attach plan = financing.installments {\n    borrower: owner, capital: operator\n    months: 2, pricing: flat_total, profit_rate: 0%\n    disburse_to: borrower, limits: allowance, portfolio: budget\n    expose create as quote\n    expose sign as sign\n    expose disburse as fund\n    expose cancel as cancel_quote\n    expose void as cancel_plan\n    expose payoff as repay_early\n    expose complete as complete\n  }\n  attach recovery = collections.case {\n    on: plan, agency: collector, capital: operator\n    expose create as refer\n    expose assign as assign\n    expose recover as recover\n    expose recall as recall\n    expose return_uncollected as return_uncollected\n  }\n  attach contact = collections.contact {\n    case: recovery, agency: collector\n    expose create as record_contact\n  }\n}\n\nexpose plan.plan.payment.create as record_payment\nexpose plan.plan.payment.pay as pay_instalment\nexpose plan.plan.payment.refund as refund_payment\nexpose plan.plan.payoff_quote.create as quote_payoff\n\nexpose plan.contact.outcome.create as record_contact_outcome\n"},
-  {"id":"escrow","title":"Hold payment until delivery","summary":"Hold a buyer’s payment until delivery is accepted.","headers":["escrow"],"source":"// Hold a buyer’s payment until delivery is accepted.\nprogram escrow_base \"Hold payment until delivery\"\nuse escrow\nparty seller: business\n\nobject order \"Order\" {\n  fields { price: money }\n  attach payment = escrow.hold {\n    payer: owner, payee: seller\n    expose create as create\n    expose fund as fund\n    expose deliver as deliver\n    expose accept as accept\n    expose dispute as dispute\n    expose verify_return as verify_return\n    expose refund as refund\n    expose refund_undelivered as refund_undelivered\n    expose settle_release as settle_release\n    expose settle_return as settle_return\n    expose settle_refund as settle_refund\n    expose cancel as cancel\n  }\n}\n"},
-  {"id":"financing","title":"Split a purchase into instalments","summary":"Fund a purchase and collect its scheduled repayments.","headers":["financing"],"source":"// Fund a purchase and collect its scheduled repayments.\nprogram financing_base \"Split a purchase into instalments\"\nuse financing\nparty seller: business\n\nobject purchase \"Purchase\" {\n  fields { price: money }\n  attach allowance = financing.limits {\n    borrower: owner, per_borrower: runtime\n    expose create as request_limit\n    expose approve as approve_limit\n  }\n  attach budget = financing.portfolio_limit {\n    limit: runtime\n    expose create as create_budget\n    expose approve as approve_budget\n  }\n  // Architect sets the placeholder profit rate during tailoring.\n  attach plan = financing.installments {\n    borrower: owner, capital: operator\n    months: 2, pricing: flat_total, profit_rate: 0%\n    disburse_to: seller, seller: seller, limits: allowance, portfolio: budget\n    expose create as quote\n    expose sign as sign\n    expose disburse as fund\n    expose cancel as cancel_quote\n    expose void as cancel_plan\n    expose payoff as repay_early\n    expose complete as complete\n  }\n}\n\nexpose purchase.plan.payment.create as record_payment\nexpose purchase.plan.payment.pay as pay_instalment\nexpose purchase.plan.payment.refund as refund_payment\nexpose purchase.plan.payoff_quote.create as quote_payoff\n"},
-  {"id":"insurance","title":"Protect a purchase","summary":"Collect cover premiums and reserve approved claims for payment.","headers":["insurance"],"source":"// Collect cover premiums and reserve approved claims for payment.\nprogram insurance_base \"Protect a purchase\"\nuse insurance\n\nobject purchase \"Purchase\" {\n  attach cover = insurance.cover {\n    holder: owner, adapter: \"conformance_boundary\"\n    expose create as create_cover\n    expose activate as activate_cover\n    expose cancel as cancel_cover\n  }\n  attach claim = insurance.claim {\n    cover: cover, inspector: operator\n    expose create as create_claim\n    expose approve as approve_claim\n    expose deny as deny_claim\n    expose pay as pay_claim\n  }\n}\n\nexpose purchase.cover.slice.create as create_period\nexpose purchase.cover.slice.collect as collect_premium\n"},
-  {"id":"lending","title":"Pool funds for lending","summary":"Pool member commitments to fund a loan and distribute repayments or losses.","headers":["lending","financing","wallet"],"source":"// Pool member commitments to fund a loan and distribute repayments or losses.\nprogram lending_base \"Pool funds for lending\"\nuse lending\nuse financing\nuse wallet\n\nobject plan \"Plan\" {\n  fields { price: money }\n  attach allowance = financing.limits {\n    borrower: owner, per_borrower: runtime\n    expose create as request_limit\n    expose approve as approve_limit\n  }\n  attach budget = financing.portfolio_limit {\n    limit: runtime\n    expose create as create_budget\n    expose approve as approve_budget\n  }\n  // Architect sets the placeholder profit rate during tailoring.\n  attach plan = financing.installments {\n    borrower: owner, capital: operator\n    months: 2, pricing: flat_total, profit_rate: 0%\n    disburse_to: borrower, limits: allowance, portfolio: budget\n    expose create as quote\n    expose sign as sign\n    expose disburse as fund\n    expose cancel as cancel_quote\n    expose void as cancel_plan\n    expose payoff as repay_early\n    expose complete as complete\n  }\n  attach balance = wallet.balance {\n    holder: actor\n    expose create as create_balance\n    expose activate as activate_balance\n    expose topup as add_funds\n    expose withdraw as withdraw_funds\n  }\n  attach round = lending.round {\n    borrower: owner, plan: plan\n    expose create as open_round\n    expose close as close_round\n  }\n  attach commitment = lending.commitment {\n    round: round, wallet: balance, investor: actor\n    expose create as commit\n    expose withdraw as withdraw_commitment\n  }\n  attach returns = lending.distribution {\n    round: round, receipt: plan.settlement\n    expose create as record_settlement\n    expose prepare_cash as prepare_returns\n    expose distribute_cash as distribute_returns\n  }\n  attach losses = lending.distribution {\n    round: round, receipt: plan.settlement, mode: loss\n    expose create as record_loss\n    expose prepare_loss as prepare_losses\n    expose distribute_loss as distribute_losses\n  }\n}\n\nexpose plan.plan.payment.create as record_payment\nexpose plan.plan.payment.pay as pay_instalment\nexpose plan.plan.payment.refund as refund_payment\nexpose plan.plan.payoff_quote.create as quote_payoff\n\nexpose plan.returns.share.create as create_return_share\nexpose plan.losses.share.create as create_loss_share\nexpose plan.plan.write_off_request.create as request_write_off\nexpose plan.plan.write_off_request.apply as apply_write_off\nexpose plan.plan.write_off_request.cancel as cancel_write_off\n"},
-  {"id":"marketplace","title":"Connect buyers and sellers","summary":"Turn a seller’s offer into an order with payment held until acceptance.","headers":["marketplace","escrow"],"source":"// Turn a seller’s offer into an order with payment held until acceptance.\nprogram marketplace_base \"Connect buyers and sellers\"\nuse marketplace\nuse escrow\nparty seller: business\n\nobject order \"Order\" {\n  fields { price: money }\n  attach offer = marketplace.listing {\n    seller: seller\n    expose create as create_offer\n    expose publish as publish_offer\n    expose withdraw as withdraw_offer\n    expose sell as sell_offer\n  }\n  attach order = marketplace.order {\n    listing: offer, buyer: owner, fulfiller: seller\n    expose create as create_order\n    expose commit as commit_order\n    expose fulfill as fulfill_order\n    expose cancel as cancel_order\n  }\n  attach payment = escrow.hold {\n    payer: owner, payee: seller\n    expose create as create\n    expose fund as fund\n    expose deliver as deliver\n    expose accept as accept\n    expose dispute as dispute\n    expose verify_return as verify_return\n    expose refund as refund\n    expose refund_undelivered as refund_undelivered\n    expose settle_release as settle_release\n    expose settle_return as settle_return\n    expose settle_refund as settle_refund\n    expose cancel as cancel\n  }\n}\n"},
-  {"id":"money","title":"Collect a payment","summary":"Collect a payment from a customer.","headers":["money"],"source":"// Collect a payment from a customer.\nprogram money_base \"Collect a payment\"\nuse money\n\nobject purchase \"Purchase\" {\n  attach payment = money.transfer {\n    payer: owner, payee: operator\n    expose create as create\n    expose pay as pay\n    expose cancel as cancel\n  }\n}\n"},
-  {"id":"reporting","title":"Track repayments","summary":"Report outstanding balances and overdue repayments on financed purchases.","headers":["reporting","financing"],"source":"// Report outstanding balances and overdue repayments on financed purchases.\nprogram reporting_base \"Track repayments\"\nuse reporting\nuse financing\n\nobject purchase \"Purchase\" {\n  fields { price: money }\n  attach allowance = financing.limits {\n    borrower: owner, per_borrower: runtime\n    expose create as request_limit\n    expose approve as approve_limit\n  }\n  attach budget = financing.portfolio_limit {\n    limit: runtime\n    expose create as create_budget\n    expose approve as approve_budget\n  }\n  // Architect sets the placeholder profit rate during tailoring.\n  attach plan = financing.installments {\n    borrower: owner, capital: operator\n    months: 2, pricing: flat_total, profit_rate: 0%\n    disburse_to: borrower, limits: allowance, portfolio: budget\n    expose create as quote\n    expose sign as sign\n    expose disburse as fund\n    expose cancel as cancel_quote\n    expose void as cancel_plan\n    expose payoff as repay_early\n    expose complete as complete\n  }\n  attach reports = reporting.portfolio {\n    on: plan\n    expose create as create_reports\n  }\n}\n\nexpose purchase.plan.payment.create as record_payment\nexpose purchase.plan.payment.pay as pay_instalment\nexpose purchase.plan.payment.refund as refund_payment\nexpose purchase.plan.payoff_quote.create as quote_payoff\n"},
-  {"id":"savings","title":"Save as a group","summary":"Collect contributions into a shared pot and pay each member in turn.","headers":["savings"],"source":"// Collect contributions into a shared pot and pay each member in turn.\nprogram savings_base \"Save as a group\"\nuse savings\n\nobject pot \"Pot\" {\n  attach circle = savings.circle {\n    contribution: runtime, members: 2, starts: runtime\n    expose create as create_circle\n    expose disband as disband_circle\n    expose close as close_circle\n  }\n  attach membership = savings.membership {\n    circle: circle, member: actor\n    expose create as join\n    expose activate as activate_membership\n    expose withdraw as withdraw\n  }\n}\n\nexpose pot.membership.contribution.create as schedule_contribution\n"},
-  {"id":"wallet","title":"Offer prepaid credit","summary":"Let a customer add funds and reserve each spend before payment.","headers":["wallet"],"source":"// Let a customer add funds and reserve each spend before payment.\nprogram wallet_base \"Offer prepaid credit\"\nuse wallet\n\nobject balance \"Balance\" {\n  attach balance = wallet.balance {\n    holder: owner\n    expose create as create_balance\n    expose activate as activate_balance\n    expose topup as add_funds\n    expose withdraw as withdraw_funds\n    expose freeze as freeze_balance\n    expose unfreeze as unfreeze_balance\n  }\n  attach spend = wallet.spend {\n    wallet: balance, payee: operator, holder: owner\n    expose create as create\n    expose reserve as reserve\n    expose pay as pay\n    expose cancel as cancel\n  }\n}\n"},
+  {"id":"cards","title":"Control card spending","summary":"Reserve a card payment within its spending limit before capture.","headers":["cards"],"source":"// Reserve a card payment within its spending limit before capture.\nprogram cards_base \"Control card spending\"\nparty seller: business\n\nobject card \"Card\" {\n  attach holder = cards.cardholder {\n    holder: owner\n    expose create as create_holder\n    expose activate as activate_holder\n    expose suspend as suspend_holder\n    expose resume as resume_holder\n    expose close as close_holder\n  }\n  attach card = cards.card {\n    holder: holder, person: owner, issuer: operator, spend_limit: runtime\n    expose create as create_card\n    expose activate as activate_card\n    expose freeze as freeze_card\n    expose unfreeze as unfreeze_card\n    expose issuer_freeze as issuer_freeze_card\n    expose issuer_unfreeze as issuer_unfreeze_card\n    expose cancel as cancel_card\n  }\n  attach payment = cards.authorization {\n    card: card, merchant: seller, issuer: operator\n    expose create as create\n    expose approve as approve\n    expose decline as decline\n    expose capture as capture\n    expose reverse as reverse\n  }\n  attach receipt = cards.transaction {\n    authorization: payment\n    expose create as record_payment\n    expose refund as refund\n  }\n}\n"},
+  {"id":"collections","title":"Follow up overdue payments","summary":"Refer overdue instalments for collection and limit contact attempts.","headers":["financing","collections"],"source":"// Refer overdue instalments for collection and limit contact attempts.\nprogram collections_base \"Follow up overdue payments\"\nparty collector: business\n\nobject plan \"Plan\" {\n  fields { price: money }\n  attach allowance = financing.limits {\n    borrower: owner, per_borrower: runtime\n    expose create as request_limit\n    expose approve as approve_limit\n  }\n  attach budget = financing.portfolio_limit {\n    limit: runtime\n    expose create as create_budget\n    expose approve as approve_budget\n  }\n  // Architect sets the placeholder profit rate during tailoring.\n  attach plan = financing.installments {\n    borrower: owner, capital: operator\n    months: 2, pricing: flat_total, profit_rate: 0%\n    disburse_to: borrower, limits: allowance, portfolio: budget\n    expose create as quote\n    expose sign as sign\n    expose disburse as fund\n    expose cancel as cancel_quote\n    expose void as cancel_plan\n    expose payoff as repay_early\n    expose complete as complete\n  }\n  attach recovery = collections.case {\n    on: plan, agency: collector, capital: operator\n    expose create as refer\n    expose assign as assign\n    expose recover as recover\n    expose recall as recall\n    expose return_uncollected as return_uncollected\n  }\n  attach contact = collections.contact {\n    case: recovery, agency: collector\n    expose create as record_contact\n  }\n}\n\nexpose plan.plan.payment.create as record_payment\nexpose plan.plan.payment.pay as pay_instalment\nexpose plan.plan.payment.refund as refund_payment\nexpose plan.plan.payoff_quote.create as quote_payoff\n\nexpose plan.contact.outcome.create as record_contact_outcome\n"},
+  {"id":"escrow","title":"Hold payment until delivery","summary":"Hold a buyer’s payment until delivery is accepted.","headers":["escrow"],"source":"// Hold a buyer’s payment until delivery is accepted.\nprogram escrow_base \"Hold payment until delivery\"\nparty seller: business\n\nobject order \"Order\" {\n  fields { price: money }\n  attach payment = escrow.hold {\n    payer: owner, payee: seller\n    expose create as create\n    expose fund as fund\n    expose deliver as deliver\n    expose accept as accept\n    expose dispute as dispute\n    expose verify_return as verify_return\n    expose refund as refund\n    expose refund_undelivered as refund_undelivered\n    expose settle_release as settle_release\n    expose settle_return as settle_return\n    expose settle_refund as settle_refund\n    expose cancel as cancel\n  }\n}\n"},
+  {"id":"financing","title":"Split a purchase into instalments","summary":"Fund a purchase and collect its scheduled repayments.","headers":["financing","purchase"],"source":"// Fund a purchase and collect its scheduled repayments.\nprogram financing_base \"Split a purchase into instalments\"\nparty seller: business\n\nobject purchase \"Purchase\" {\n  fields { price: money }\n  attach allowance = financing.limits {\n    borrower: owner, per_borrower: runtime\n    expose create as request_limit\n    expose approve as approve_limit\n  }\n  attach budget = financing.portfolio_limit {\n    limit: runtime\n    expose create as create_budget\n    expose approve as approve_budget\n  }\n  // Architect sets the placeholder profit rate during tailoring.\n  attach plan = financing.installments {\n    borrower: owner, capital: operator\n    months: 2, pricing: flat_total, profit_rate: 0%\n    disburse_to: seller, seller: seller, limits: allowance, portfolio: budget\n    expose create as quote\n    expose sign as sign\n    expose disburse as fund\n    expose cancel as cancel_quote\n    expose void as cancel_plan\n    expose payoff as repay_early\n    expose complete as complete\n  }\n}\n\nexpose purchase.plan.payment.create as record_payment\nexpose purchase.plan.payment.pay as pay_instalment\nexpose purchase.plan.payment.refund as refund_payment\nexpose purchase.plan.payoff_quote.create as quote_payoff\n"},
+  {"id":"insurance","title":"Protect a purchase","summary":"Collect cover premiums and reserve approved claims for payment.","headers":["insurance","purchase"],"source":"// Collect cover premiums and reserve approved claims for payment.\nprogram insurance_base \"Protect a purchase\"\n\nobject purchase \"Purchase\" {\n  attach cover = insurance.cover {\n    holder: owner, adapter: \"conformance_boundary\"\n    expose create as create_cover\n    expose activate as activate_cover\n    expose cancel as cancel_cover\n  }\n  attach claim = insurance.claim {\n    cover: cover, inspector: operator\n    expose create as create_claim\n    expose approve as approve_claim\n    expose deny as deny_claim\n    expose pay as pay_claim\n  }\n}\n\nexpose purchase.cover.slice.create as create_period\nexpose purchase.cover.slice.collect as collect_premium\n"},
+  {"id":"lending","title":"Pool funds for lending","summary":"Pool member commitments to fund a loan and distribute repayments or losses.","headers":["financing","wallet","lending"],"source":"// Pool member commitments to fund a loan and distribute repayments or losses.\nprogram lending_base \"Pool funds for lending\"\n\nobject plan \"Plan\" {\n  fields { price: money }\n  attach allowance = financing.limits {\n    borrower: owner, per_borrower: runtime\n    expose create as request_limit\n    expose approve as approve_limit\n  }\n  attach budget = financing.portfolio_limit {\n    limit: runtime\n    expose create as create_budget\n    expose approve as approve_budget\n  }\n  // Architect sets the placeholder profit rate during tailoring.\n  attach plan = financing.installments {\n    borrower: owner, capital: operator\n    months: 2, pricing: flat_total, profit_rate: 0%\n    disburse_to: borrower, limits: allowance, portfolio: budget\n    expose create as quote\n    expose sign as sign\n    expose disburse as fund\n    expose cancel as cancel_quote\n    expose void as cancel_plan\n    expose payoff as repay_early\n    expose complete as complete\n  }\n  attach balance = wallet.balance {\n    holder: actor\n    expose create as create_balance\n    expose activate as activate_balance\n    expose topup as add_funds\n    expose withdraw as withdraw_funds\n  }\n  attach round = lending.round {\n    borrower: owner, plan: plan\n    expose create as open_round\n    expose close as close_round\n  }\n  attach commitment = lending.commitment {\n    round: round, wallet: balance, investor: actor\n    expose create as commit\n    expose withdraw as withdraw_commitment\n  }\n  attach returns = lending.distribution {\n    round: round, receipt: plan.settlement\n    expose create as record_settlement\n    expose prepare_cash as prepare_returns\n    expose distribute_cash as distribute_returns\n  }\n  attach losses = lending.distribution {\n    round: round, receipt: plan.settlement, mode: loss\n    expose create as record_loss\n    expose prepare_loss as prepare_losses\n    expose distribute_loss as distribute_losses\n  }\n}\n\nexpose plan.plan.payment.create as record_payment\nexpose plan.plan.payment.pay as pay_instalment\nexpose plan.plan.payment.refund as refund_payment\nexpose plan.plan.payoff_quote.create as quote_payoff\n\nexpose plan.returns.share.create as create_return_share\nexpose plan.losses.share.create as create_loss_share\nexpose plan.plan.write_off_request.create as request_write_off\nexpose plan.plan.write_off_request.apply as apply_write_off\nexpose plan.plan.write_off_request.cancel as cancel_write_off\n"},
+  {"id":"marketplace","title":"Connect buyers and sellers","summary":"Turn a seller’s offer into an order with payment held until acceptance.","headers":["marketplace","escrow"],"source":"// Turn a seller’s offer into an order with payment held until acceptance.\nprogram marketplace_base \"Connect buyers and sellers\"\nparty seller: business\n\nobject order \"Order\" {\n  fields { price: money }\n  attach offer = marketplace.listing {\n    seller: seller\n    expose create as create_offer\n    expose publish as publish_offer\n    expose withdraw as withdraw_offer\n    expose sell as sell_offer\n  }\n  attach order = marketplace.order {\n    listing: offer, buyer: owner, fulfiller: seller\n    expose create as create_order\n    expose commit as commit_order\n    expose fulfill as fulfill_order\n    expose cancel as cancel_order\n  }\n  attach payment = escrow.hold {\n    payer: owner, payee: seller\n    expose create as create\n    expose fund as fund\n    expose deliver as deliver\n    expose accept as accept\n    expose dispute as dispute\n    expose verify_return as verify_return\n    expose refund as refund\n    expose refund_undelivered as refund_undelivered\n    expose settle_release as settle_release\n    expose settle_return as settle_return\n    expose settle_refund as settle_refund\n    expose cancel as cancel\n  }\n}\n"},
+  {"id":"money","title":"Collect a payment","summary":"Collect a payment from a customer.","headers":["money"],"source":"// Collect a payment from a customer.\nprogram money_base \"Collect a payment\"\n\nobject purchase \"Purchase\" {\n  attach payment = money.transfer {\n    payer: owner, payee: operator\n    expose create as create\n    expose pay as pay\n    expose cancel as cancel\n  }\n}\n"},
+  {"id":"reporting","title":"Track repayments","summary":"Report outstanding balances and overdue repayments on financed purchases.","headers":["financing","reporting","purchase"],"source":"// Report outstanding balances and overdue repayments on financed purchases.\nprogram reporting_base \"Track repayments\"\n\nobject purchase \"Purchase\" {\n  fields { price: money }\n  attach allowance = financing.limits {\n    borrower: owner, per_borrower: runtime\n    expose create as request_limit\n    expose approve as approve_limit\n  }\n  attach budget = financing.portfolio_limit {\n    limit: runtime\n    expose create as create_budget\n    expose approve as approve_budget\n  }\n  // Architect sets the placeholder profit rate during tailoring.\n  attach plan = financing.installments {\n    borrower: owner, capital: operator\n    months: 2, pricing: flat_total, profit_rate: 0%\n    disburse_to: borrower, limits: allowance, portfolio: budget\n    expose create as quote\n    expose sign as sign\n    expose disburse as fund\n    expose cancel as cancel_quote\n    expose void as cancel_plan\n    expose payoff as repay_early\n    expose complete as complete\n  }\n  attach reports = reporting.portfolio {\n    on: plan\n    expose create as create_reports\n  }\n}\n\nexpose purchase.plan.payment.create as record_payment\nexpose purchase.plan.payment.pay as pay_instalment\nexpose purchase.plan.payment.refund as refund_payment\nexpose purchase.plan.payoff_quote.create as quote_payoff\n"},
+  {"id":"savings","title":"Save as a group","summary":"Collect contributions into a shared pot and pay each member in turn.","headers":["savings"],"source":"// Collect contributions into a shared pot and pay each member in turn.\nprogram savings_base \"Save as a group\"\n\nobject pot \"Pot\" {\n  attach circle = savings.circle {\n    contribution: runtime, members: 2, starts: runtime\n    expose create as create_circle\n    expose disband as disband_circle\n    expose close as close_circle\n  }\n  attach membership = savings.membership {\n    circle: circle, member: actor\n    expose create as join\n    expose activate as activate_membership\n    expose withdraw as withdraw\n  }\n}\n\nexpose pot.membership.contribution.create as schedule_contribution\n"},
+  {"id":"wallet","title":"Offer prepaid credit","summary":"Let a customer add funds and reserve each spend before payment.","headers":["wallet"],"source":"// Let a customer add funds and reserve each spend before payment.\nprogram wallet_base \"Offer prepaid credit\"\n\nobject balance \"Balance\" {\n  attach balance = wallet.balance {\n    holder: owner\n    expose create as create_balance\n    expose activate as activate_balance\n    expose topup as add_funds\n    expose withdraw as withdraw_funds\n    expose freeze as freeze_balance\n    expose unfreeze as unfreeze_balance\n  }\n  attach spend = wallet.spend {\n    wallet: balance, payee: operator, holder: owner\n    expose create as create\n    expose reserve as reserve\n    expose pay as pay\n    expose cancel as cancel\n  }\n}\n"},
 ];

package/src/catalog-program.ts

@@ -4,19 +4,6 @@
  * std-headers.spec proves the whole program compiles.
  */
 export const catalogProgramSource = `program catalog "Template catalog"
-use money
-use escrow
-use purchase
-use booking
-use marketplace
-use financing
-use insurance
-use lending
-use wallet
-use cards
-use collections
-use savings
-use reporting
 party supplier: business
 party inspector: staff role claim_inspector
 party investor: business

package/src/checks.ts

@@ -0,0 +1,386 @@
+import type { UdlDocument } from "@hyperscale0/udl";
+import type { BlockExpr, CheckDecl, Expr, Named } from "./ast.ts";
+import { didYouMean, fail } from "./diagnostics.ts";
+
+type Balances = Record<string, string>;
+type Values = Record<string, unknown>;
+type Expected = { expected?: Balances };
+export type CompiledCheckStep = Expected &
+  (
+    | {
+        kind: "clock";
+        at: string;
+        waitFor?: {
+          object: string;
+          state: string;
+          attachment?: string;
+          recordPath?: string;
+        };
+      }
+    | {
+        kind: "object";
+        id: string;
+        objectKind: string;
+        owner: string;
+        fields?: Values;
+      }
+    | {
+        kind: "action";
+        object: string;
+        action: string;
+        actor?: string;
+        input?: Values;
+        fields?: Values;
+        state?: string;
+        status?: number | "absent";
+        code?: string;
+        remember?: string;
+        instance?: string;
+      }
+    | { kind: "close"; customer: string }
+  );
+/** A check as the Build carries it; `buildCheckSchema` in contracts parses it. */
+export interface CompiledCheck {
+  name: string;
+  customers: {
+    id: string;
+    name: string;
+    kind?: "organization";
+    fund?: string;
+  }[];
+  bindings?: Record<string, string>;
+  steps: CompiledCheckStep[];
+  expected: Balances;
+  expectedHeld?: string;
+  pending?: Record<string, Balances>;
+}
+
+// Statement keywords cannot name a customer, since a step opens with its actor.
+const reserved = new Set(["customer", "clock", "object", "close", "expect"]);
+/** The Product pool's balance name. */
+const operator = "operator";
+
+/**
+ * Lowers every check against the compiled document. A name the document does
+ * not declare fails at the step that wrote it.
+ */
+export function lowerChecks(
+  checks: readonly CheckDecl[],
+  document: UdlDocument,
+  literal: (expr: Expr) => string | number | boolean,
+): CompiledCheck[] {
+  const seen = new Set<string>();
+  return checks.map((check) => {
+    if (seen.has(check.name))
+      fail(check, `check "${check.name}" is declared twice`, "rename one");
+    seen.add(check.name);
+    return lowerCheck(check, document, literal);
+  });
+}
+
+function lowerCheck(
+  check: CheckDecl,
+  document: UdlDocument,
+  literal: (expr: Expr) => string | number | boolean,
+): CompiledCheck {
+  const customers: CompiledCheck["customers"] = [];
+  const bindings: Record<string, string> = {};
+  const steps: CompiledCheckStep[] = [];
+  const objects = new Map<string, string>();
+  const remembered = new Set<string>();
+  let final: Pick<CompiledCheck, "expected" | "expectedHeld" | "pending"> =
+    undefined!;
+  const known = (
+    named: Named,
+    names: Iterable<string>,
+    what: string,
+    fix: string,
+  ) => {
+    const list = [...names];
+    if (!list.includes(named.name))
+      fail(
+        named,
+        `${what} ${named.name} is not declared.${didYouMean(named.name, list)}`,
+        fix,
+      );
+    return named.name;
+  };
+  const customer = (named: Named) =>
+    known(
+      named,
+      customers.map((c) => c.id),
+      "customer",
+      `declare customer ${named.name} "Name" before this step`,
+    );
+  const money = (expr: Expr) => {
+    if (expr.kind !== "money")
+      fail(expr, "expected an amount", "write an amount such as 100 SAR");
+    return literal(expr) as string;
+  };
+  const balanceNames = () => [operator, ...customers.map((c) => c.id)];
+  const balanceFix = `name a customer or ${operator}`;
+  const balances = (block: BlockExpr) =>
+    Object.fromEntries(
+      block.entries.map((entry) => [
+        known(
+          { name: entry.key, span: entry.span },
+          balanceNames(),
+          "balance",
+          balanceFix,
+        ),
+        money(entry.value),
+      ]),
+    );
+  const value = (expr: Expr): unknown => {
+    if (expr.kind === "list") return expr.items.map(value);
+    if (expr.kind === "block")
+      return Object.fromEntries(
+        expr.entries.map((entry) => [entry.key, value(entry.value)]),
+      );
+    if (expr.kind === "call" && ["agreement", "object"].includes(expr.name)) {
+      const [arg] = expr.args;
+      if (expr.args.length !== 1 || arg?.kind !== "name")
+        fail(expr, `${expr.name} takes one name`, `write ${expr.name}(name)`);
+      const name = { name: arg.value, span: arg.span };
+      if (expr.name === "agreement")
+        known(name, remembered, "agreement", "remember it on an earlier step");
+      else
+        known(name, objects.keys(), "object", "create it on an earlier step");
+      return `$${expr.name}:${arg.value}`;
+    }
+    return literal(expr);
+  };
+  const values = (block: BlockExpr) => value(block) as Values;
+  const instruments = (object: string) => {
+    const declared = document.objects.find((o) => o.id === object)!;
+    const ids = new Set(declared.attachments.map((a) => a.instrument));
+    return document.instruments.filter((i) => ids.has(i.id));
+  };
+  for (const statement of check.statements) {
+    if (final)
+      fail(statement, "expect closes a check", "move this step before expect");
+    const expected = statement.balances
+      ? { expected: balances(statement.balances) }
+      : {};
+    switch (statement.kind) {
+      case "customer": {
+        const { id } = statement;
+        if (reserved.has(id.name) || id.name === operator)
+          fail(id, `${id.name} cannot name a customer`, "pick another name");
+        if (customers.some((c) => c.id === id.name))
+          fail(id, `customer ${id.name} is declared twice`, "rename one");
+        if (steps.length)
+          fail(statement, "customers come before steps", "move it up");
+        customers.push({
+          id: id.name,
+          name: statement.title,
+          ...(statement.organization ? { kind: "organization" as const } : {}),
+          ...(statement.fund ? { fund: money(statement.fund) } : {}),
+        });
+        for (const party of statement.binds) {
+          const declared = Object.keys(document.parties);
+          known(party, declared, "party", "bind a party the program declares");
+          if (party.name in bindings)
+            fail(party, `party ${party.name} is bound twice`, "bind it once");
+          bindings[party.name] = id.name;
+        }
+        break;
+      }
+      case "clock": {
+        const at = statement.at;
+        if (at.kind !== "date")
+          fail(at, "a clock step needs a date", "write clock 2031-04-01");
+        const until = statement.until;
+        let waitFor: Extract<CompiledCheckStep, { kind: "clock" }>["waitFor"];
+        if (until) {
+          const object = known(
+            until.object,
+            objects.keys(),
+            "object",
+            "create it on an earlier step",
+          );
+          const kind = objects.get(object)!;
+          const declared = document.objects.find((o) => o.id === kind)!;
+          if (until.attachment)
+            known(
+              until.attachment,
+              declared.attachments.map((a) => a.name),
+              `${kind} attachment`,
+              `name an attachment of object ${kind}`,
+            );
+          known(
+            until.state,
+            instruments(kind).flatMap((i) => i.lifecycle.states),
+            "state",
+            `name a lifecycle state on object ${kind}`,
+          );
+          waitFor = {
+            object,
+            ...(until.recordPath ? { recordPath: until.recordPath } : {}),
+            state: until.state.name,
+            ...(until.attachment ? { attachment: until.attachment.name } : {}),
+          };
+        }
+        steps.push({
+          kind: "clock",
+          at: literal(at) as string,
+          ...(waitFor ? { waitFor } : {}),
+          ...expected,
+        });
+        break;
+      }
+      case "object": {
+        const { id } = statement;
+        if (objects.has(id.name))
+          fail(id, `object ${id.name} is created twice`, "rename one");
+        const kind = known(
+          statement.objectKind,
+          document.objects.map((o) => o.id),
+          "object kind",
+          "name an object the program declares",
+        );
+        const owner = customer(statement.owner);
+        const fieldNames = document.objects
+          .find((o) => o.id === kind)!
+          .fields.map((f) => f.name);
+        for (const entry of statement.fields?.entries ?? [])
+          known(
+            { name: entry.key, span: entry.span },
+            fieldNames,
+            `${kind} field`,
+            `name a field of object ${kind}`,
+          );
+        objects.set(id.name, kind);
+        steps.push({
+          kind: "object",
+          id: id.name,
+          objectKind: kind,
+          owner,
+          ...(statement.fields ? { fields: values(statement.fields) } : {}),
+          ...expected,
+        });
+        break;
+      }
+      case "action": {
+        const object = known(
+          statement.object,
+          objects.keys(),
+          "object",
+          "create it on an earlier step",
+        );
+        const kind = objects.get(object)!;
+        const exposing = instruments(kind).filter((i) =>
+          Object.values(i.actions).some(
+            (a) => a.publicAction === statement.action.name,
+          ),
+        );
+        known(
+          statement.action,
+          exposing.length
+            ? [statement.action.name]
+            : instruments(kind).flatMap((i) =>
+                Object.values(i.actions).flatMap((a) =>
+                  a.publicAction ? [a.publicAction] : [],
+                ),
+              ),
+          `${kind} action`,
+          `name an action object ${kind} exposes`,
+        );
+        const actor = statement.actor && customer(statement.actor);
+        if (statement.state)
+          known(
+            statement.state,
+            exposing.flatMap((i) => i.lifecycle.states),
+            "state",
+            `name a state ${statement.action.name} can reach`,
+          );
+        let status: number | "absent" | undefined;
+        if (statement.status) {
+          const raw = statement.status;
+          status =
+            raw.kind === "name" && raw.value === "absent"
+              ? "absent"
+              : raw.kind === "number" && /^[45]\d\d$/.test(raw.value)
+                ? Number(raw.value)
+                : fail(raw, "expected a refusal", "write status 409 or absent");
+        }
+        const instance =
+          statement.instance &&
+          known(
+            statement.instance,
+            remembered,
+            "agreement",
+            "remember it on an earlier step",
+          );
+        const input = statement.input && values(statement.input);
+        const fields = statement.fields && values(statement.fields);
+        if (statement.remember) {
+          if (remembered.has(statement.remember.name))
+            fail(statement.remember, "remembered twice", "rename one");
+          remembered.add(statement.remember.name);
+        }
+        steps.push({
+          kind: "action",
+          object,
+          action: statement.action.name,
+          ...(actor ? { actor } : {}),
+          ...(input ? { input } : {}),
+          ...(fields ? { fields } : {}),
+          ...(statement.state ? { state: statement.state.name } : {}),
+          ...(status !== undefined ? { status } : {}),
+          ...(statement.code ? { code: statement.code } : {}),
+          ...(statement.remember ? { remember: statement.remember.name } : {}),
+          ...(instance ? { instance } : {}),
+          ...expected,
+        });
+        break;
+      }
+      case "close":
+        steps.push({
+          kind: "close",
+          customer: customer(statement.customer),
+          ...expected,
+        });
+        break;
+      case "expect": {
+        if (!steps.length)
+          fail(statement, "a check needs a step", "add a step before expect");
+        if (!statement.balances)
+          fail(statement, "expect needs balances", "write expect balances { }");
+        final = {
+          expected: balances(statement.balances),
+          ...(statement.held ? { expectedHeld: money(statement.held) } : {}),
+          ...(statement.pending
+            ? {
+                pending: Object.fromEntries(
+                  statement.pending.entries.map((entry) => {
+                    const name = { name: entry.key, span: entry.span };
+                    if (entry.value.kind !== "block")
+                      fail(entry, "expected balances", "write name { }");
+                    const fields = entry.value.entries.map((field) => [
+                      field.key,
+                      money(field.value),
+                    ]);
+                    return [
+                      known(name, balanceNames(), "balance", balanceFix),
+                      Object.fromEntries(fields),
+                    ];
+                  }),
+                ),
+              }
+            : {}),
+        };
+        break;
+      }
+    }
+  }
+  if (!final)
+    fail(check, "a check ends with expect", "write expect balances { }");
+  return {
+    name: check.name,
+    customers,
+    ...(Object.keys(bindings).length ? { bindings } : {}),
+    steps,
+    ...final,
+  };
+}