@hyperscale0/hsx 1.0.0-rc.1 → 1.0.123

package/examples/escrow.hsx

@@ -0,0 +1,24 @@
+// Buyers fund a used device purchase, then accept delivery or raise a dispute before release.
+program used_device_sales "Used device sales"
+use escrow
+
+object device "Device" {
+  fields {
+    model: text
+    condition: text
+    serialNumber: text
+    price: money
+  }
+  columns: [model, condition, price]
+  attach sale = escrow.hold {
+    expose create as create_sale
+    payer: actor, payee: owner
+    expose fund as pay_for_device
+    expose deliver as confirm_delivery
+    expose accept as accept_device
+    expose dispute as report_problem
+    expose verify_return as verify_return
+    expose refund as refund_buyer
+    expose cancel as cancel_sale
+  }
+}

package/examples/financing.hsx

@@ -0,0 +1,32 @@
+// A tuition lender funds a student's fees over three interest-free instalments with borrowing limits.
+program tuition_instalments "Tuition instalments"
+use financing
+
+object enrolment "Enrolment" {
+  fields { student: text, course: text, price: money }
+  columns: [student, course, price]
+  attach allowance = financing.limits {
+    expose create as create_allowance
+    borrower: owner, per_borrower: 12000 SAR
+    expose approve as approve_student
+  }
+  attach budget = financing.portfolio_limit {
+    expose create as create_budget
+    limit: 500000 SAR
+    expose approve as approve_budget
+  }
+  attach tuition = financing.installments {
+    expose create as create_tuition
+    borrower: owner, capital: operator
+    months: 3, profit: 0%, disburse_to: borrower
+    limits: allowance, portfolio: budget
+    expose sign as sign_tuition_plan
+    expose disburse as fund_tuition
+    expose payoff as repay_early
+  }
+}
+
+expose enrolment.tuition.payment.create as create_payment
+expose enrolment.tuition.payment.pay as pay_instalment
+expose enrolment.tuition.payment.refund as refund_payment
+expose enrolment.tuition.payoff_quote.create as request_payoff_quote

package/examples/insurance.hsx

@@ -0,0 +1,30 @@
+// A device retailer collects the purchase price and attaches cover with a claim review process.
+program device_insurance "Device insurance"
+use insurance
+use money
+party inspector: staff role claims
+
+object device "Insured device" {
+  fields { model: text, serialNumber: text, purchaseDate: date }
+  columns: [model, serialNumber, purchaseDate]
+  attach purchase = money.transfer {
+    expose create as create_purchase
+    payer: owner, payee: operator
+    economics pay { purpose: earning, sourceParty: owner }
+    expose pay as pay_for_device
+  }
+  // Bind device_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: owner, adapter: "device_insurer", commission: 10%, covers: purchase
+    expose activate as activate_cover
+    expose cancel as cancel_cover
+  }
+  attach claim = insurance.claim {
+    expose create as create_claim
+    cover: protection, inspector: inspector
+    expose approve as approve_claim
+    expose deny as deny_claim
+    expose pay as pay_claim
+  }
+}

package/examples/lending.hsx

@@ -0,0 +1,57 @@
+// A lending composition with limit approvals, wallet commitments and cash distribution transitions.
+program community_business_lending "Community business lending"
+use lending
+use financing
+use wallet
+
+object business "Business funding" {
+  fields { businessName: text, purpose: text, price: money }
+  columns: [businessName, purpose, price]
+  attach allowance = financing.limits {
+    expose create as create_allowance
+    borrower: owner, per_borrower: 100000 SAR
+    expose approve as approve_borrower
+  }
+  attach budget = financing.portfolio_limit {
+    expose create as create_budget
+    limit: 2000000 SAR
+    expose approve as approve_budget
+  }
+  attach loan = financing.installments {
+    expose create as create_loan
+    borrower: owner, capital: operator
+    months: 12, profit: 6%, disburse_to: borrower
+    limits: allowance, portfolio: budget
+    expose sign as sign_loan
+    expose disburse as release_loan
+    expose payoff as repay_early
+  }
+  attach investor_balance = wallet.balance {
+    expose create as create_investor_balance
+    holder: actor
+    expose activate as open_wallet
+    expose topup as add_funds
+  }
+  attach funding = lending.round {
+    borrower: owner, plan: loan
+    expose create as open_funding
+    expose close as close_funding
+  }
+  attach investment = lending.commitment {
+    round: funding, wallet: investor_balance, investor: actor
+    expose create as invest
+    expose withdraw as withdraw_investment
+  }
+  attach returns = lending.distribution {
+    expose create as create_returns
+    round: funding, receipt: loan.settlement
+    expose prepare_cash as prepare_returns
+    expose distribute_cash as distribute_returns
+  }
+}
+
+expose business.loan.payment.create as create_payment
+expose business.loan.payment.pay as pay_instalment
+expose business.loan.payment.refund as refund_payment
+expose business.loan.payoff_quote.create as request_payoff_quote
+expose business.returns.share.create as create_return_share

package/examples/library.hsx

@@ -0,0 +1,15 @@
+// A minimal financed car sale connects escrow to a three-instalment plan and lending limits.
+program cars "Financed car sales"
+use escrow
+use financing
+object car "Cars" {
+ fields { make: text, model: text, year: integer }
+ attach sale = escrow.hold { expose create as create_sale, payer: actor, payee: owner, expose fund as sell }
+ attach limits = financing.limits { expose create as create_limits, borrower: actor, per_borrower: 60000 SAR }
+ attach ceiling = financing.portfolio_limit { expose create as create_ceiling, limit: 1500000 SAR }
+ attach plan = financing.installments {
+  borrower: actor, capital: operator, share: 25%
+  months: 3, profit: 2.5%, funds: sale, limits: limits, portfolio: ceiling
+  expose create as finance
+ }
+}

package/examples/marketplace.hsx

@@ -0,0 +1,32 @@
+// Freelancers publish offers and clients place orders with funds held until work is accepted.
+program freelance_marketplace "Freelance marketplace"
+use marketplace
+use escrow
+
+object project "Project" {
+  fields { brief: text, deliverable: text, price: money }
+  columns: [brief, deliverable, price]
+  attach offer = marketplace.listing {
+    expose create as create_offer
+    seller: owner
+    expose publish as publish_offer
+    expose withdraw as withdraw_offer
+  }
+  attach order = marketplace.order {
+    expose create as create_order
+    listing: offer, buyer: actor
+    expose commit as place_order
+    expose fulfill as finish_order
+  }
+  attach payment = escrow.hold {
+    expose create as create_payment
+    payer: actor, payee: owner
+    expose fund as fund_project
+    expose deliver as submit_work
+    expose accept as accept_work
+    expose dispute as dispute_work
+    expose verify_return as verify_return
+    expose refund as refund_client
+    expose cancel as cancel_payment
+  }
+}

package/examples/money.hsx

@@ -0,0 +1,19 @@
+// A tutoring studio collects a fixed fee for each lesson and can cancel unpaid bookings.
+program tutoring_studio "Tutoring studio"
+use money
+
+object lesson "Lesson" {
+  fields {
+    student: text
+    tutor: text
+    startsAt: date
+  }
+  columns: [student, tutor, startsAt]
+  attach payment = money.transfer {
+    expose create as create_payment
+    payer: actor, payee: operator, amount: 150 SAR
+    economics pay { purpose: earning, sourceParty: actor }
+    expose pay as pay_for_lesson
+    expose cancel as cancel_payment
+  }
+}

package/examples/rental-deposit.hsx

@@ -0,0 +1,60 @@
+// 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.
+program equipment_rental "Equipment rental"
+party renter: business
+
+// Program-local instruments have fixed terms and parties, not tunable parameters.
+instrument deposit {
+  summary: "Hold a rental deposit, then return it less any fixed late fee."
+  fields {
+    renter: account of renter
+    held: account of self
+    amount: money = 1000 SAR
+    lateFee: money = 50 SAR
+    dueAt: date
+    refund: money?
+  }
+  lifecycle { states: [pending, funded, returned, cancelled], initial: pending }
+  action create {
+    actor: { party: renter }
+    requires self.dueAt > self.now
+  }
+  action fund {
+    from: pending, to: funded, actor: { party: renter }
+    deadline: { at: self.dueAt }
+    moves self.amount from self.renter to self.held
+  }
+  action return_on_time {
+    from: funded, to: returned, actor: { party: programOperator }
+    deadline: { at: self.dueAt }
+    subject { returnReference: text }
+    moves self.held.balance from self.held to self.renter
+  }
+  action return_late {
+    from: funded, to: returned, actor: { party: programOperator }
+    due: { at: self.dueAt }
+    subject { returnReference: text }
+    calculate: [{ target: refund, op: subtract, base: { field: self.held.balance }, subtract: [{ field: self.lateFee }] }]
+    moves self.lateFee from self.held to programOperator
+    moves self.refund from self.held to self.renter
+  }
+  action cancel { from: pending, to: cancelled, actor: { party: renter } }
+}
+
+object rental "Equipment rental" {
+  fields { equipment: text }
+  columns: [equipment, dueAt]
+  attach security = deposit {
+    expose create as agree_rental
+    expose fund as pay_deposit
+    expose return_on_time as return_equipment
+    expose return_late as return_equipment_late
+    expose cancel as cancel_rental
+  }
+}
+
+hide deposit.create
+hide deposit.fund
+hide deposit.return_on_time
+hide deposit.return_late
+hide deposit.cancel

package/examples/repair-approval.hsx

@@ -0,0 +1,44 @@
+// A repair shop records inspection and approval evidence before it can complete a job.
+program repair_shop "Repair approvals"
+
+instrument assessment {
+  summary: "Inspect the repair, collect approval, then record completion."
+  fields { inspectedAt: date?, approvedAt: date? }
+  lifecycle { states: [submitted, inspected, approved, completed, rejected], initial: submitted }
+  action create {}
+  action inspect {
+    from: submitted, to: inspected, actor: { party: programOperator }
+    subject { inspectionNotes: text }
+    set: { inspectedAt: { field: self.now } }
+  }
+  action approve {
+    from: inspected, to: approved, actor: { party: programOperator }
+    subject { approvalReference: text }
+    set: { approvedAt: { field: self.now } }
+  }
+  action reject {
+    from: inspected, to: rejected, actor: { party: programOperator }
+  }
+  action complete {
+    from: approved, to: completed, actor: { party: programOperator }
+    subject { completionNotes: text }
+  }
+}
+
+object repair "Repair" {
+  fields { item: text, problem: text }
+  columns: [item, problem]
+  attach review = assessment {
+    expose create as create_review
+    expose inspect as inspect_repair
+    expose approve as approve_repair
+    expose reject as reject_repair
+    expose complete as complete_repair
+  }
+}
+
+hide assessment.create
+hide assessment.inspect
+hide assessment.approve
+hide assessment.reject
+hide assessment.complete

package/examples/reporting.hsx

@@ -0,0 +1,28 @@
+// An equipment lender keeps an ageing report over its financed purchases and recorded repayments.
+program equipment_loan_reports "Equipment loan reports"
+use reporting
+use financing
+
+object purchase "Equipment loan" {
+  fields { businessName: text, equipment: text, price: money }
+  columns: [businessName, equipment, price]
+  attach allowance = financing.limits {
+    expose create as create_allowance
+    borrower: owner, per_borrower: 200000 SAR
+    expose approve as approve_business
+  }
+  attach budget = financing.portfolio_limit {
+    expose create as create_budget
+    limit: 5000000 SAR
+    expose approve as approve_budget
+  }
+  attach loan = financing.installments {
+    expose create as create_loan
+    borrower: owner, capital: operator
+    months: 12, profit: 6%, disburse_to: borrower
+    limits: allowance, portfolio: budget
+    expose sign as sign_purchase_loan
+    expose disburse as fund_purchase
+  }
+  attach reports = reporting.portfolio { expose create as create_reports, on: loan }
+}

package/examples/savings.hsx

@@ -0,0 +1,21 @@
+// Six members contribute to a shared pot and receive it in their agreed calendar order.
+program neighbourhood_savings "Savings circle"
+use savings
+
+object group "Savings group" {
+  fields { groupName: text, purpose: text }
+  columns: [groupName, purpose]
+  attach circle = savings.circle {
+    expose create as create_circle
+    contribution: 500 SAR, members: 6, starts: 2027-01-01
+    expose disband as disband_circle
+    expose close as close_circle
+  }
+  attach membership = savings.membership {
+    expose create as create_membership
+    circle: circle, member: actor
+    expose activate as confirm_membership
+    expose withdraw as leave_circle
+  }
+  // Contributions and each member's payout follow the declared calendar.
+}

package/examples/serviced.hsx

@@ -0,0 +1,25 @@
+// A car finance company services loans with late charges, payment reminders and early repayment.
+program car_financing "Car financing"
+use escrow
+use financing
+use collections
+object car "Car" {
+ fields { make: text, model: text, year: integer, vin: text, price: money }
+ columns: [make, model, year, vin, price]
+ attach sale = escrow.hold { expose create as create_sale, payer: actor, payee: operator, expose fund as purchase }
+ attach limits = financing.limits { expose create as create_limits, borrower: actor, per_borrower: 250000 SAR }
+ attach ceiling = financing.portfolio_limit { expose create as create_ceiling, limit: 10000000 SAR }
+ attach plan = financing.installments {
+  borrower: actor, capital: operator
+  months: 36, profit: 8.5%, down_payment: 10%
+  apply: fines_profit_principal, payoff_rebate: 100%, write_off_after: 90d
+  funds: sale, limits: limits, portfolio: ceiling
+  expose create as finance, expose sign as sign_contract, expose payoff as payoff
+ }
+ attach late = financing.late_charge {
+   expose create as create_late
+  on: plan, grace: 3d, fine: 50 SAR, cap: 25 SAR
+  fines_to: operator, costs_to: operator, borrower: actor
+ }
+ attach reminders = collections.reminder { expose create as create_reminders, on: plan, operator: operator, before_days: 3, overdue_days: 1 }
+}

package/examples/wallet.hsx

@@ -0,0 +1,24 @@
+// Members prepay for workshop visits and the studio reserves each spend before charging it.
+program workshop_credits "Workshop credits"
+use wallet
+
+object membership "Membership" {
+  fields { memberName: text, membershipNumber: text }
+  columns: [memberName, membershipNumber]
+  attach balance = wallet.balance {
+    expose create as create_balance
+    holder: owner
+    expose activate as open_balance
+    expose topup as add_credit
+    expose withdraw as withdraw_credit
+    expose close as close_balance
+  }
+  attach visit = wallet.spend {
+    expose create as create_visit
+    wallet: balance, payee: operator
+    economics pay { purpose: earning, sourceParty: owner }
+    expose reserve as reserve_visit
+    expose pay as charge_visit
+    expose cancel as cancel_visit
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperscale0/hsx",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.123",
   "description": "The strictly typed HSX language: compile total financial programs into canonical UDL.",
   "keywords": [
     "hsx",
@@ -21,7 +21,7 @@
     "type": "git",
     "url": "git+https://github.com/hyperscale0/hyperscale-hsx.git"
   },
-  "license": "AGPL-3.0-only",
+  "license": "SEE LICENSE IN LICENSE.md",
   "author": "Hyperscale LLC",
   "type": "module",
   "sideEffects": false,
@@ -40,22 +40,28 @@
       "types": "./dist/src/cost.d.ts",
       "default": "./dist/src/cost.js"
     },
+    "./examples": {
+      "types": "./dist/src/examples.d.ts",
+      "default": "./dist/src/examples.js"
+    },
+    "./language": {
+      "types": "./dist/src/language.d.ts",
+      "default": "./dist/src/language.js"
+    },
     "./package.json": "./package.json",
     "./std/*": "./std/*"
   },
   "files": [
+    "LICENSE.md",
+    "NOTICE.md",
     "AUTHORS",
     "CHANGELOG.md",
-    "LICENSE",
-    "LICENSING.md",
     "README.md",
     "SECURITY.md",
-    "TRADEMARKS.md",
     "bin",
     "dist",
     "docs",
     "examples",
-    "skills",
     "std",
     "src"
   ],
@@ -66,26 +72,30 @@
     "access": "public"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.build.json",
-    "check": "bun test && bun run docs:check && tsc -p tsconfig.json && bun run build && bun scripts/check-bin.ts",
-    "docs:build": "bun scripts/docs/build.ts",
-    "docs:check": "bun scripts/docs/check.ts",
-    "examples:build": "bun scripts/examples/build.ts",
+    "build": "bun run generate && tsc -p tsconfig.build.json && tsc -p playground/tsconfig.json && bun scripts/build-playground.ts",
+    "typecheck": "tsc -p tsconfig.json",
+    "test": "bun test test",
     "postpack": "bun scripts/pack-exports.ts restore",
     "prepack": "bun run build && bun scripts/pack-exports.ts apply",
-    "test": "bun test",
-    "typecheck": "tsc -p tsconfig.json"
+    "std:bundle": "bun scripts/bundle-std.ts",
+    "generate": "bun run std:bundle && bun run examples:bundle",
+    "prepare": "bun run std:bundle && bun run examples:bundle",
+    "check": "bun run typecheck && tsc -p playground/tsconfig.json && bun test test",
+    "examples:bundle": "bun scripts/bundle-examples.ts"
   },
   "dependencies": {
-    "@hyperscale0/udl": "1.0.0-rc.1"
+    "@hyperscale0/adl": "1.0.123",
+    "@hyperscale0/udl": "1.0.123",
+    "fast-sha256": "1.3.0"
   },
   "devDependencies": {
-    "@types/bun": "1.4.0",
-    "typescript": "6.0.3"
+    "bun-types": "1.4.2",
+    "typescript": "7.0.2"
   },
   "contributors": [
     "Meshael AlBakaawi",
     "Amir Ayub",
     "Sara AlBakaawi"
-  ]
+  ],
+  "gitHead": "3af04bb95dfbacee4caae46f0eaf2b88296a18a7"
 }