@hyperscale0/hsx 2.1.1 → 2.2.0

package/std/money_flows/recurring_collection.hsx

@@ -1,72 +0,0 @@
-module std.money_flows.recurring_collection
-
-// Bounded lifecycle state tracker for recurring collections without direct balance movement.
-//
-// ### Purpose
-// `recurring_collection` tracks the ongoing execution state of a series of recurring collections.
-// It carries no money amount and no account bindings; each `collect` call records that an installment
-// occurred, and `end` closes the series permanently. It is typically paired with an external billing
-// engine or a separate debt obligation instrument.
-//
-// ### Selection guidance
-// - vs `scheduled`: `recurring_collection` moves no money and has no ledger accounts or amount partitioning.
-//   It is a pure lifecycle tracker. Choose `scheduled` when the platform itself must calculate installment amounts,
-//   enforce calendar intervals, or debit customer accounts.
-// - vs `metered`: `metered` bills variable usage against a rate card with real balance movements.
-//   `recurring_collection` only records collection lifecycle steps.
-//
-// ### Parameters
-// - `marker`: Optional descriptive text marker stored on the recurring collection record.
-//
-// ### Decision ports
-// None. State transitions are controlled directly by API actions (`collect`, `end`).
-//
-// ### Example
-// ```hsx
-// program recurring_collection_example "Recurring collection example"
-// import { recurring_collection, scheduled } from "std/money_flows"
-// party debtor: person
-// party repayment_source: business
-// party recipient: business
-// settlement obligation = scheduled {
-//   mode: obligation
-//   payer: repayment_source
-//   payee: recipient
-//   debtor: debtor
-//   amount: principal: money(SAR)
-//   count: 2
-//   every: P30D
-//   first_due: firstDueAt
-//   mandate: port mandate_evidence
-// }
-// settlement collection = recurring_collection {}
-// port mandate_evidence {
-//   allowed: [repayment_source]
-//   shape: { evidenceReference: text }
-// }
-// ```
-export instrument recurring_collection(marker: optional<text>) {
-  agent_description: concat("Reach for ", words(instrument), " to track a bounded run of scheduled collections, one call per recorded installment. It carries no amount and no account, and every action only advances its own state. A settlement that debits an account on a schedule is a different shape.");
-  fields {}
-  lifecycle {
-    states active ended;
-    initial active;
-    on collect: active -> active;
-    on end: active -> ended;
-  }
-  action create {
-    agent_description: "Open the collection so installments can be recorded against it. This is the first call and the collection starts active. It moves no money.";
-    summary: "Create a bounded recurring collection";
-    steps: [];
-  }
-  action collect {
-    agent_description: "Record one due installment as collected. The collection must still be active, and it stays active afterwards so the next installment can follow. It moves no money.";
-    summary: "Collect one due installment";
-    steps: [];
-  }
-  action end {
-    agent_description: "Close the collection so no further installment can be recorded. Only an active collection can end, and ended is final. It moves no money.";
-    summary: "End future collections";
-    steps: [];
-  }
-}