@hyperscale0/hsx 5.8.0 → 6.0.0

package/docs/examples.md

@@ -1,22 +0,0 @@
-# Sample programs
-
-Each file is an authored program. Object creation enters no agreement; an attachment may expose its instrument create action by name. Compilation alone does not prove a complete business flow.
-
-| Program | Headers | Business |
-| --- | --- | --- |
-| [Team expense cards](../examples/cards.hsx) | cards | A company issues expense cards to employees and reserves each supplier payment before capture. |
-| [Small business collections](../examples/collections.hsx) | collections, financing | A business lender refers overdue instalments to an agency with limits on collection contacts. |
-| [Used device sales](../examples/escrow.hsx) | escrow | Buyers fund a used device purchase, then accept delivery or raise a dispute before release. |
-| [Tuition instalments](../examples/financing.hsx) | financing | A tuition lender funds a student's fees over three interest-free instalments with borrowing limits. |
-| [Device insurance](../examples/insurance.hsx) | insurance, money | A device retailer collects the purchase price and attaches cover with a claim review process. |
-| [Community business lending](../examples/lending.hsx) | lending, financing, wallet | A lending composition with limit approvals, wallet commitments and cash distribution transitions. |
-| [Financed car sales](../examples/library.hsx) | escrow, financing | A minimal financed car sale connects escrow to a three-instalment plan and lending limits. |
-| [Freelance marketplace](../examples/marketplace.hsx) | marketplace, escrow | Freelancers publish offers and clients place orders with funds held until work is accepted. |
-| [Tutoring studio](../examples/money.hsx) | money | A tutoring studio collects a fixed fee for each lesson and can cancel unpaid bookings. |
-| [Equipment rental](../examples/rental-deposit.hsx) |  | A business rents equipment with a 1000 SAR deposit and a single 50 SAR late fee. On-time return refunds 1000 SAR; late return pays the operator 50 SAR and refunds 950 SAR. |
-| [Repair approvals](../examples/repair-approval.hsx) |  | A repair shop records inspection and approval evidence before it can complete a job. |
-| [Equipment loan reports](../examples/reporting.hsx) | reporting, financing | An equipment lender keeps an ageing report over its financed purchases and recorded repayments. |
-| [Savings circle](../examples/savings.hsx) | savings | Six members contribute to a shared pot and receive it in their agreed calendar order. |
-| [Car financing](../examples/serviced.hsx) | escrow, financing, collections | A car finance company services loans with late charges, payment reminders and early repayment. |
-| [Travel agency](../examples/travel.hsx) | travel, insurance | A travel agency takes deposits for an insured holiday and pays its supplier after confirmation. |
-| [Workshop credits](../examples/wallet.hsx) | wallet | Members prepay for workshop visits and the studio reserves each spend before charging it. |

package/docs/headers.md

@@ -1,46 +0,0 @@
-# Header inventory
-
-Attach library instruments inside authored object kinds. Each program selects policies through typed tunables.
-Bind party parameters to owner, actor, operator or declared parties. Configure declared businesses per Build. The authoringTemplate source is an attach fragment for an object block. An attachment may expose create by name; clock and parent actions remain internal.
-`ref<T>[]` accepts one reference or up to 16 references as one policy.
-
-| Instrument | Tunables |
-| --- | --- |
-| money.transfer | `payer: party`, `payee: party`, `amount: money = runtime` |
-| money.hold | `payer: party`, `payee: party`, `amount: money = runtime` |
-| money.split | `payer: party`, `amount: money = runtime`, `shares: split = { programOperator: 100% }` |
-| money.schedule | `payer: party`, `payee: party`, `amount: money = runtime`, `count: integer(1, 366) = 12` |
-| money.pool | `payer: party`, `payee: party`, `target: money`, `closes: date` |
-| money.swap | `first: party`, `second: party`, `first_amount: money`, `second_amount: money`, `expires: date` |
-| money.payout | `payer: party`, `payee: party`, `adapter: text`, `max_age: duration`, `amount: money = runtime` |
-| money.metered | `payer: party`, `payee: party`, `unit_price: money`, `units: integer = 1`, `fee: fee = { seller: 0% }` |
-| marketplace.listing | `seller: party` |
-| marketplace.order | `listing: ref<marketplace.listing>`, `buyer: party` |
-| marketplace.reservation | `listing: ref<marketplace.listing>`, `funds: ref<escrow.hold>`, `converters: ref[]`, `buyer: party`, `seller: party`, `expires_after: duration = 48h`, `deposit: money = 1000 SAR`, `cancellation_refund: percent = 100%`, `expiry_refund: percent = 100%`, `retained_to: party = programOperator`, `operator: party = programOperator`, `competing_quotes: enum(allowed, blocked) = allowed` |
-| escrow.hold | `payer: party = party(person)`, `payee: party = programOperator`, `accept_within: duration = 48h`, `fee: fee = { seller: 0%, tax: 0% }`, `dispute: policy = { refund_after: return_verified }` |
-| wallet.balance | `holder: party`, `spend_limit: money = 100000 SAR` |
-| wallet.spend | `wallet: ref<wallet.balance>`, `payee: party` |
-| financing.installments | `months: integer(1, 366)`, `charge_limit: integer(1, 3) = 3`, `profit: percent`, `disburse_to: enum(funds, borrower) = funds`, `profit_earned: enum(on_payment, by_schedule, at_disbursement) = on_payment`, `apply: enum(fines_profit_principal, principal_profit, pro_rata) = fines_profit_principal`, `payoff_rebate: percent = 100%`, `write_off_after: duration = 90d`, `max_extension: duration = 90d`, `max_amendments: integer(0, 366) = 2`, `waiver_limit: percent = 100%`, `amendment_expiry: duration = 7d`, `payoff_quote_expiry: duration = 1h`, `allow_overdue: enum(allowed, blocked) = allowed`, `assessed_fines: enum(carry, require_waiver) = carry`, `down_payment: percent = 0%`, `funds: ref<escrow.hold>?`, `borrower: party = party(person)`, `capital: party = programOperator`, `share: percent = 0%`, `limits: ref<financing.limits> = object(financing.limits)`, `portfolio: ref<financing.portfolio_limit> = object(financing.portfolio_limit)` |
-| financing.late_charge | `on: ref<financing.installments>[]`, `grace: duration = 3d`, `fine: money = 50 SAR`, `cap: money = 25 SAR`, `fines_to: party = programOperator`, `costs_to: party = programOperator`, `borrower: party = party(person)` |
-| financing.limits | `per_borrower: money`, `borrower: party = party(person)`, `active_plans: integer = 1` |
-| financing.portfolio_limit | `limit: money` |
-| financing.credit_line | `borrower: party = programOperator`, `adapter: text`, `limit: money`, `expires: date` |
-| financing.advance | `line: ref<financing.credit_line>`, `amount: money = runtime` |
-| lending.round | `borrower: party`, `plan: ref<financing.installments> = object(financing.installments)`, `operator: party = programOperator`, `minimum_ticket: money = 100 SAR`, `investor_cap: percent = 20%`, `commitments: ref<lending.commitment> = object(lending.commitment)` |
-| lending.commitment | `round: ref<lending.round>`, `wallet: ref<wallet.balance>`, `investor: party = party(person)` |
-| lending.distribution | `round: ref<lending.round>`, `receipt: ref`, `commitments: ref<lending.commitment> = object(lending.commitment)`, `mode: enum(cash, loss) = cash`, `residual_to: party = programOperator`, `operator: party = programOperator`, `fee: percent = 1%`, `tax: percent = 15%` |
-| insurance.cover | `holder: party`, `adapter: text`, `commission: percent = 0%`, `broker: party = programOperator`, `covers: ref`, `premium: money = runtime` |
-| insurance.claim | `cover: ref<insurance.cover>`, `inspector: party` |
-| collections.case | `on: ref<financing.installments>[]`, `agency: party`, `capital: party = programOperator`, `overdue: duration = 3d`, `fee: percent = 20%` |
-| collections.contact | `case: ref<collections.case>[]`, `agency: party`, `max_contacts: integer = 10`, `window: duration = 30d`, `contact_from: integer(0, 23) = 8`, `contact_until: integer(1, 23) = 20`, `timezone: text = "Asia/Riyadh"`; contact_from less_than contact_until |
-| collections.reminder | `on: ref<financing.installments>[]`, `operator: party = programOperator`, `before_days: integer(0, 366) = 3`, `overdue_days: integer(1, 366) = 1`, `max_per_day: integer(1, 10) = 1`, `send_from: integer(0, 23) = 8`, `send_until: integer(1, 24) = 20`, `timezone: text = "Asia/Riyadh"`; send_from less_than send_until |
-| travel.package | `price: money`, `supplier_cost: money`, `departure: date`; supplier_cost at_most price |
-| travel.booking | `package: ref<travel.package>`, `buyer: party`, `supplier: party`, `operator: party = programOperator`, `cover: ref<insurance.cover>`, `deposit: percent = 30%`, `balance_before: duration = 14d`, `confirm_within: duration = 24h`, `tax: percent = 15%`, `early_before: duration = 30d`, `middle_before: duration = 15d`, `middle_penalty: percent = 10%`, `late_penalty: percent = 30%`; early_before greater_than middle_before |
-| cards.cardholder | `holder: party` |
-| cards.card | `holder: ref<cards.cardholder>`, `spend_limit: money` |
-| cards.authorization | `card: ref<cards.card>`, `merchant: party`, `issuer: party = programOperator` |
-| cards.transaction | `authorization: ref<cards.authorization>` |
-| cards.dispute | `transaction: ref<cards.transaction>`, `issuer: party = programOperator`, `within: duration = 90d` |
-| savings.circle | `contribution: money`, `members: integer(1, 60)`, `starts: date`, `memberships: ref<savings.membership> = object(savings.membership)` |
-| savings.membership | `circle: ref<savings.circle>`, `member: party` |
-| reporting.portfolio | `on: ref<financing.installments>[]`, `default_days: integer(1, 3650) = 90`, `retention_years: integer(1, 100) = 10`, `aging_first_days: integer(1, 3650) = 30`, `aging_second_days: integer(1, 3650) = 60`, `aging_third_days: integer(1, 3650) = 90`, `ratio_scale: integer(1, 1000000) = 10000`, `ratio_rounding: enum(floor, halfUp) = floor`, `lock_wait_ms: integer(1, 2000) = 2000`, `capture_ms: integer(1, 10000) = 10000`, `max_rows: integer(1, 100000) = 10000`, `max_join_rows: integer(1, 1000000) = 100000`, `max_bytes: integer(1024, 16777216) = 8388608`; aging_first_days less_than aging_second_days, aging_second_days less_than aging_third_days |

package/examples/travel.hsx

@@ -1,29 +0,0 @@
-// A travel agency takes deposits for an insured holiday and pays its supplier after confirmation.
-program travel_agency "Travel agency"
-use travel
-use insurance
-party hotel: business
-
-object holiday "Holiday booking" {
-  fields { destination: text, leadTraveller: text }
-  columns: [destination, leadTraveller]
-  attach trip = travel.package {
-    expose create as create_trip
-    price: 5000 SAR, supplier_cost: 3500 SAR, departure: 2027-07-01
-    expose publish as publish_trip
-  }
-  // Bind travel_insurer to an ADL adapter before creating cover. Premiums net of commission go to its account.
-  attach protection = insurance.cover {
-    expose create as create_protection
-    holder: actor, adapter: "travel_insurer", commission: 10%, covers: reservation
-    expose activate as activate_cover
-  }
-  attach reservation = travel.booking {
-    expose create as create_reservation
-    package: trip, buyer: actor, supplier: hotel, cover: protection
-    expose deposit as pay_deposit
-    expose balance as pay_balance
-    expose confirm as confirm_completion
-    expose cancel_early as cancel_booking
-  }
-}

package/std/travel.hsx

@@ -1,123 +0,0 @@
-header travel
-
-// Economics: Booking funds and refunds are principal. Supplier payments are payouts,
-// tax is pass-through, and the company margin is earning. An outside operator
-// receives a participant payout instead of company earnings.
-
-// Publish a package before booking.create. Expose deposit, balance and confirm
-// separately. Deposit needs pending premium slices whose cover is active, and
-// collects those premiums in addition to booking cash. Balance is due by balanceAt.
-// Expose cancel_early, cancel_middle and cancel_late for the desired booking paths.
-// Early returns all held booking cash, whether deposit-only or fully paid. Middle
-// returns held minus the original deposit; a deposit-only booking gets zero.
-// Supplier penalty is based on supplierCost; tax applies to retained margin,
-// and the bound operator receives the remainder. Late returns no buyer cash.
-// Middle opens at earlyAt and ends at lateAt, which is middleAt plus 1ms; late
-// starts there. Default_balance can already cancel a deposit_paid booking at
-// balanceAt, after which no booking cancellation is reachable. Clock order matters.
-// Booking refunds exclude insurance premiums, broker commission and all balances
-// outside booking.held. Expose cover.cancel independently to refund eligible paid
-// premium periods before startsAt; slice.refund is parent-owned. Active/expired
-// premium periods remain excluded. Confirmation timeout returns the full booking
-// price from paid only. A penalty above held cash or retained deposit refuses;
-// this header does not subsidize a shortfall or reduce the configured penalty.
-
-// Cost: booking.create declares one owned account. Deposit also invokes premium
-// collections; cancellation declares the selected refund, penalty, tax and retained
-// moves. Run hsx cost for bounded counts. Supplier penalties are business terms,
-// not compiler or executor fees.
-
-instrument package(price: money, supplier_cost: money, departure: date) {
-  constraints { supplier_cost: at_most(price) }
-  summary: "Immutable package price, supplier cost and departure."
-  fields { price: money = price, supplierCost: money = supplier_cost, departure: date = departure }
-  lifecycle { states: [draft, published, closed], initial: draft }
-  action create { requires self.supplierCost <= self.price }
-  action publish { from: draft, to: published }
-  action close { from: published, to: closed, actor: clock, due: { at: self.departure } }
-}
-
-instrument booking(package: ref<travel.package>, buyer: party, supplier: party, operator: party = programOperator, cover: ref<insurance.cover>, deposit: percent = 30%, balance_before: duration = 14d, confirm_within: duration = 24h, tax: percent = 15%, early_before: duration = 30d, middle_before: duration = 15d, middle_penalty: percent = 10%, late_penalty: percent = 30%) {
-  constraints { early_before: greater_than(middle_before) }
-  summary: "A deposited booking with three cancellation bands and confirmation."
-  fields {
-    package: ref<package>, buyer: account of buyer, supplier: account of supplier
-    price: money = self.package.price, supplierCost: money = self.package.supplierCost
-    deposit: money = rate(self.price, deposit), balance: money = subtract(self.price, self.deposit)
-    margin: money = subtract(self.price, self.supplierCost)
-    tax: money = rate(self.margin, tax), operatorNet: money = subtract(self.margin, self.tax)
-    middlePenalty: money = rate(self.supplierCost, middle_penalty)
-    latePenalty: money = rate(self.supplierCost, late_penalty)
-    balanceAt: date = before(self.package.departure, balance_before)
-    earlyAt: date = before(self.package.departure, early_before)
-    middleAt: date = before(self.package.departure, middle_before)
-    lateAt: date = after(self.middleAt, 1ms)
-    confirmBy: date = after(self.package.departure, confirm_within)
-    held: account of self
-    refund: money?, retainedMargin: money?, retainedTax: money?, retainedNet: money?
-  }
-  lifecycle { states: [created, deposit_paid, paid, completed, cancelled, refunded], initial: created }
-  action create {
-    requires self.package in [published]
-  }
-  action deposit { allowZero: true, requires self.price > "0";
-    from: created, to: deposit_paid, actor: { party: buyer }, deadline: { at: self.balanceAt }
-    requires count of { instrument: child(cover, slice), reference: "covers", anchor: self.id, states: [pending], limit: 366 } >= 1
-    moves self.deposit from buyer to self.held economics { purpose: principal, sourceParty: buyer }
-    invoke: [{ selection: { instrument: child(cover, slice), reference: "covers", anchor: self.id, states: [pending], limit: 366 }, action: collect, input: {} }]
-  }
-  action balance { allowZero: true, requires self.price > "0";
-    from: deposit_paid, to: paid, actor: { party: buyer }, deadline: { at: self.balanceAt }
-    moves self.balance from buyer to self.held economics { purpose: principal, sourceParty: buyer }
-  }
-  action confirm { allowZero: true, requires self.price > "0";
-    from: paid, to: completed, actor: { party: operator }
-    due: { at: self.package.departure }, deadline: { at: self.confirmBy }
-    moves self.supplierCost from self.held to supplier economics { purpose: participant_payout, sourceParty: programOperator }
-    moves self.tax from self.held to programTax economics { purpose: pass_through, sourceParty: programOperator }
-    moves self.operatorNet from self.held to operator economics { recipient: operator, company: { purpose: earning, sourceParty: buyer }, participant: { purpose: participant_payout, sourceParty: programOperator } }
-  }
-  action timeout {
-    from: paid, to: refunded, actor: clock, due: { at: self.confirmBy }
-    moves self.price from self.held to buyer economics { purpose: principal, sourceParty: programOperator }
-  }
-  action cancel_early { allowZero: true, purpose: option, requires self.price > "0";
-    from: [deposit_paid, paid], to: cancelled, actor: { party: buyer }, deadline: { at: self.earlyAt }
-    moves self.held.balance from self.held to buyer economics { purpose: principal, sourceParty: programOperator }
-  }
-  action cancel_middle { allowZero: true, purpose: option, requires self.price > "0";
-    from: [deposit_paid, paid], to: cancelled, actor: { party: buyer }, due: { at: self.earlyAt }, deadline: { at: self.lateAt }
-    calculate: [
-      { target: refund, op: "subtract", base: { field: self.held.balance }, subtract: [{ field: self.deposit }] }
-      { target: retainedMargin, op: "subtract", base: { field: self.deposit }, subtract: [{ field: self.middlePenalty }] }
-      { target: retainedTax, op: "rate", base: { field: self.retainedMargin }, bps: { literal: tax }, rounding: "floor" }
-      { target: retainedNet, op: "subtract", base: { field: self.retainedMargin }, subtract: [{ field: self.retainedTax }] }
-    ]
-    moves self.refund from self.held to buyer economics { purpose: principal, sourceParty: programOperator }
-    moves self.middlePenalty from self.held to supplier economics { purpose: participant_payout, sourceParty: programOperator }
-    moves self.retainedTax from self.held to programTax economics { purpose: pass_through, sourceParty: programOperator }
-    moves self.retainedNet from self.held to operator economics { recipient: operator, company: { purpose: earning, sourceParty: buyer }, participant: { purpose: participant_payout, sourceParty: programOperator } }
-  }
-  action cancel_late { allowZero: true, purpose: option, requires self.price > "0";
-    from: [deposit_paid, paid], to: cancelled, actor: { party: buyer }, due: { at: self.lateAt }
-    calculate: [
-      { target: retainedMargin, op: "subtract", base: { field: self.held.balance }, subtract: [{ field: self.latePenalty }] }
-      { target: retainedTax, op: "rate", base: { field: self.retainedMargin }, bps: { literal: tax }, rounding: "floor" }
-      { target: retainedNet, op: "subtract", base: { field: self.retainedMargin }, subtract: [{ field: self.retainedTax }] }
-    ]
-    moves self.latePenalty from self.held to supplier economics { purpose: participant_payout, sourceParty: programOperator }
-    moves self.retainedTax from self.held to programTax economics { purpose: pass_through, sourceParty: programOperator }
-    moves self.retainedNet from self.held to operator economics { recipient: operator, company: { purpose: earning, sourceParty: buyer }, participant: { purpose: participant_payout, sourceParty: programOperator } }
-  }
-  action default_balance { allowZero: true, requires self.price > "0";
-    from: deposit_paid, to: cancelled, actor: clock, due: { at: self.balanceAt }
-    calculate: [
-      { target: retainedMargin, op: "subtract", base: { field: self.held.balance }, subtract: [{ field: self.latePenalty }] }
-      { target: retainedTax, op: "rate", base: { field: self.retainedMargin }, bps: { literal: tax }, rounding: "floor" }
-      { target: retainedNet, op: "subtract", base: { field: self.retainedMargin }, subtract: [{ field: self.retainedTax }] }
-    ]
-    moves self.latePenalty from self.held to supplier economics { purpose: participant_payout, sourceParty: programOperator }
-    moves self.retainedTax from self.held to programTax economics { purpose: pass_through, sourceParty: programOperator }
-    moves self.retainedNet from self.held to operator economics { recipient: operator, company: { purpose: earning, sourceParty: buyer }, participant: { purpose: participant_payout, sourceParty: programOperator } }
-  }
-}