@hyperscale0/udl 2.3.0 → 2.4.0

package/docs/llms.txt

@@ -1,4 +1,4 @@
-<!-- Generated by scripts/docs/build.ts from @hyperscale0/udl 2.3.0. Edit the source, not llms.txt. -->
+<!-- Generated by scripts/docs/build.ts from @hyperscale0/udl 2.4.0. Edit the source, not llms.txt. -->
 
 # UDL documentation
 

package/docs/reference/clauses.md

@@ -1,9 +1,259 @@
-<!-- Generated by scripts/docs/build.ts from @hyperscale0/udl 2.3.0. Edit the source, not clauses.md. -->
+<!-- Generated by scripts/docs/build.ts from @hyperscale0/udl 2.4.0. Edit the source, not clauses.md. -->
 
 # Clause reference
 
 This page lists every entry in `udlClauseVocabulary`. The examples are copied from admitted documents under `conformance/valid`.
 
+## funding
+
+- Scope: action
+- UDL target: `funding`
+- Cardinality: one
+- Linear outputs: none
+- Effects: moves.transfer.internal per clause
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "capture": "snapshot",
+  "collectAction": "collect",
+  "destinationAccountField": "fundingAccount",
+  "obligationField": "obligationId",
+  "principalField": "principal",
+  "sourceAccountPath": "refs.escrow",
+  "terms": {
+    "currency": "currency",
+    "principal": "principal"
+  },
+  "ticketAccountField": "wallet",
+  "ticketAmountField": "amount",
+  "ticketInstrumentId": "ticket",
+  "ticketInvestorField": "investor",
+  "ticketRefField": "roundId",
+  "ticketStatus": "open"
+}
+```
+
+## receipt distribution
+
+- Scope: action
+- UDL target: `receiptDistribution`
+- Cardinality: one
+- Linear outputs: none
+- Effects: decides.allocation per clause; moves.allocation per clause
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "capture": "receipt",
+  "feeAccountField": "fee",
+  "feeBps": 100,
+  "mode": "cash",
+  "receiptField": "receiptId",
+  "receiptPath": "refs.allocationReceipt",
+  "residualAccountField": "residual",
+  "roundField": "roundId",
+  "snapshotRef": "snapshot",
+  "taxAccountField": "tax",
+  "vatBps": 1500
+}
+```
+
+## requires allocation
+
+- Scope: action
+- UDL target: `requiresAllocation`
+- Cardinality: one
+- Linear outputs: none
+- Effects: decides.allocation per clause
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "buckets": [
+    "principal",
+    "profit"
+  ],
+  "check": "settled",
+  "refField": "coverId",
+  "slice": "self"
+}
+```
+
+## allocation
+
+- Scope: instrument
+- UDL target: `allocation`
+- Cardinality: one
+- Linear outputs: none
+- Effects: none
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "buckets": [
+    {
+      "key": "principal",
+      "source": {
+        "amountField": "principal",
+        "destinationField": "receiver",
+        "from": "slice"
+      }
+    },
+    {
+      "key": "profit",
+      "source": {
+        "amountField": "profit",
+        "destinationField": "receiver",
+        "from": "slice"
+      }
+    },
+    {
+      "key": "cost",
+      "source": {
+        "amountField": "amount",
+        "destinationField": "receiver",
+        "from": "children",
+        "parameters": {
+          "cost": true
+        },
+        "refField": "sliceId",
+        "statuses": [
+          "open"
+        ],
+        "template": "assessment"
+      }
+    }
+  ],
+  "dueField": "dueAt",
+  "earningRuleField": "earningRule",
+  "positionField": "position",
+  "sliceInstrumentId": "slice",
+  "sliceRefField": "coverId",
+  "sliceStatuses": [
+    "open"
+  ]
+}
+```
+
+## contributions
+
+- Scope: instrument
+- UDL target: `contributions`
+- Cardinality: one
+- Linear outputs: none
+- Effects: none
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "accountKey": "origin",
+  "amountKey": "amount",
+  "field": "contributions",
+  "totalField": "price"
+}
+```
+
+## allocate
+
+- Scope: action
+- UDL target: `allocate`
+- Cardinality: one
+- Linear outputs: none
+- Effects: decides.allocation per clause; moves.allocation per clause
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "capture": "payoffReceipt",
+  "mode": "payoff",
+  "paymentIdentityField": "paymentIdentity",
+  "sourceAccountField": "payerAccount"
+}
+```
+
+## contribution stage
+
+- Scope: action
+- UDL target: `contributionStage`
+- Cardinality: one
+- Linear outputs: none
+- Effects: moves.transfer.internal per clause
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "accountPath": "refs.hold",
+  "stage": "fund"
+}
+```
+
+## date order
+
+- Scope: instrument
+- UDL target: `dateOrder`
+- Cardinality: many
+- Linear outputs: none
+- Effects: none
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+[
+  {
+    "afterField": "end",
+    "beforeField": "start",
+    "operator": "<"
+  }
+]
+```
+
+## unique
+
+- Scope: action
+- UDL target: `unique`
+- Cardinality: one
+- Linear outputs: none
+- Effects: decides.subject_unique per clause
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "byFields": [
+    "borrower",
+    "currency"
+  ],
+  "namespace": "borrower_limit"
+}
+```
+
+## transitions refs
+
+- Scope: action
+- UDL target: `transitionsRefs`
+- Cardinality: many
+- Linear outputs: none
+- Effects: decides.referenced_transition per element
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+[
+  {
+    "action": "close",
+    "field": "coverId"
+  }
+]
+```
+
 ## action library
 
 - Scope: instrument
@@ -17,7 +267,10 @@ This page lists every entry in `udlClauseVocabulary`. The examples are copied fr
 ```json
 {
   "transfers": {
-    "actionOrder": ["execute_fund", "execute_release"],
+    "actionOrder": [
+      "execute_fund",
+      "execute_release"
+    ],
     "actions": {
       "execute_fund": {
         "approval": "inherit",
@@ -40,7 +293,9 @@ This page lists every entry in `udlClauseVocabulary`. The examples are copied fr
             "operation": "internal_transfer.create"
           }
         ],
-        "order": ["leaf_fund"],
+        "order": [
+          "leaf_fund"
+        ],
         "parameters": {
           "inst": {
             "kind": "instance"
@@ -73,7 +328,9 @@ This page lists every entry in `udlClauseVocabulary`. The examples are copied fr
             "operation": "internal_transfer.create"
           }
         ],
-        "order": ["leaf_rel"],
+        "order": [
+          "leaf_rel"
+        ],
         "parameters": {
           "inst": {
             "kind": "instance"
@@ -127,6 +384,52 @@ This page lists every entry in `udlClauseVocabulary`. The examples are copied fr
 ]
 ```
 
+## requires input
+
+- Scope: action
+- UDL target: `requiresInput`
+- Cardinality: one
+- Linear outputs: none
+- Effects: none
+- Law: Requirements-as-data law and closure law
+- Conformance source: `attested.udl`
+
+```json
+{
+  "amount": "fields.amount"
+}
+```
+
+## engine owned
+
+- Scope: action
+- UDL target: `engineOwned`
+- Cardinality: one
+- Linear outputs: none
+- Effects: none
+- Law: Requirements-as-data law and closure law
+- Conformance source: `attested.udl`
+
+```json
+true
+```
+
+## capture engine
+
+- Scope: action
+- UDL target: `captureEngine`
+- Cardinality: one
+- Linear outputs: none
+- Effects: none
+- Law: Requirements-as-data law and closure law
+- Conformance source: `attested.udl`
+
+```json
+{
+  "consumedByOperationId": "operationId"
+}
+```
+
 ## capture input
 
 - Scope: action
@@ -181,7 +484,10 @@ A commit has no separate effect row. The committing action consumes the quote th
   "expires": {
     "offset": "PT15M"
   },
-  "fixes": ["amount", "buyerAccountId"],
+  "fixes": [
+    "amount",
+    "buyerAccountId"
+  ],
   "netDestinationField": "buyerAccountId",
   "netRef": "unwindRefund"
 }
@@ -258,7 +564,10 @@ A commit has no separate effect row. The committing action consumes the quote th
     "path": "fields.distributableAmount"
   },
   "refField": "repaymentDistributionId",
-  "statuses": ["recorded", "paid"],
+  "statuses": [
+    "recorded",
+    "paid"
+  ],
   "weightField": "committedWeight"
 }
 ```
@@ -351,19 +660,21 @@ true
 - Linear outputs: none
 - Effects: none
 - Law: Requirements-as-data law and closure law
-- Conformance source: `cards.udl`
+- Conformance source: `attested.udl`
 
 ```json
 {
   "additionalProperties": false,
   "properties": {
-    "reason": {
-      "maxLength": 180,
-      "minLength": 1,
-      "type": "string"
+    "amount": {
+      "pattern": "^[1-9][0-9]{0,17}$",
+      "type": "string",
+      "x-hyperscale-currency": "SAR"
     }
   },
-  "required": ["reason"],
+  "required": [
+    "amount"
+  ],
   "type": "object"
 }
 ```
@@ -416,7 +727,10 @@ true
 
 ```json
 {
-  "fund_order": ["p1", "p2"],
+  "fund_order": [
+    "p1",
+    "p2"
+  ],
   "id": "split_plan",
   "pieces": [
     {
@@ -432,10 +746,18 @@ true
       "release_to": "p2Release"
     }
   ],
-  "refund_order": ["p1"],
-  "release_order": ["p1", "p2"],
+  "refund_order": [
+    "p1"
+  ],
+  "release_order": [
+    "p1",
+    "p2"
+  ],
   "total": "totalAmount",
-  "unfund_order": ["p2", "p1"]
+  "unfund_order": [
+    "p2",
+    "p1"
+  ]
 }
 ```
 
@@ -464,11 +786,14 @@ true
 - Linear outputs: none
 - Effects: decides.tenant_port per clause
 - Law: Requirements-as-data law and closure law
-- Conformance source: `compiled-crowdfunding.udl`
+- Conformance source: `attested.udl`
 
 ```json
 {
-  "allowedParties": ["beneficiary"]
+  "allowedParties": [
+    "decider"
+  ],
+  "capture": "decidedBy"
 }
 ```
 
@@ -577,7 +902,9 @@ true
     "instrumentId": "borrower_loan_installment_1_payment",
     "over": "children",
     "refField": "borrowerLoanId",
-    "statuses": ["paid"]
+    "statuses": [
+      "paid"
+    ]
   }
 ]
 ```
@@ -598,7 +925,9 @@ true
     "checkKind": "identity_verification",
     "family": "national_identity",
     "maxAge": "P30D",
-    "statuses": ["completed"],
+    "statuses": [
+      "completed"
+    ],
     "subjectField": "subjectId"
   }
 ]
@@ -638,7 +967,9 @@ true
     "capField": "installment1Amount",
     "capOnAnchor": true,
     "childInstrumentId": "borrower_loan_installment_1_payment",
-    "statuses": ["paid"]
+    "statuses": [
+      "paid"
+    ]
   }
 ]
 ```
@@ -651,13 +982,27 @@ true
 - Linear outputs: none
 - Effects: reads.requires_refs per clause
 - Law: Requirements-as-data law and closure law
-- Conformance source: `cards.udl`
+- Conformance source: `attested.udl`
 
 ```json
 [
   {
-    "field": "cardholderId",
-    "statuses": ["active"]
+    "attests": {
+      "action": "fields.actionName",
+      "consume": "consume",
+      "digest": "fields.digest",
+      "expiresAt": "fields.expiry",
+      "instrument": "fields.requestInstrument",
+      "party": "decider",
+      "role": "fields.role"
+    },
+    "field": "approvalId",
+    "match": {
+      "instrumentInstanceId": "fields.requestId"
+    },
+    "statuses": [
+      "approved"
+    ]
   }
 ]
 ```
@@ -715,7 +1060,9 @@ true
       "instrumentId": "seller_payout_capture_entry",
       "refField": "sellerPayoutId",
       "sign": "add",
-      "statuses": ["accrued"],
+      "statuses": [
+        "accrued"
+      ],
       "subtotalRef": "grossCaptureAmount"
     },
     {
@@ -723,7 +1070,9 @@ true
       "instrumentId": "seller_payout_credit_adjustment",
       "refField": "sellerPayoutId",
       "sign": "add",
-      "statuses": ["applied"],
+      "statuses": [
+        "applied"
+      ],
       "subtotalRef": "creditAdjustmentAmount"
     },
     {
@@ -731,7 +1080,9 @@ true
       "instrumentId": "seller_payout_debit_adjustment",
       "refField": "sellerPayoutId",
       "sign": "subtract",
-      "statuses": ["applied"],
+      "statuses": [
+        "applied"
+      ],
       "subtotalRef": "debitAdjustmentAmount"
     }
   ]
@@ -777,7 +1128,9 @@ true
 - Conformance source: `commerce-escrow.udl`
 
 ```json
-["escrowOrderId"]
+[
+  "escrowOrderId"
+]
 ```
 
 ## notify
@@ -831,14 +1184,18 @@ true
     "childField": "amount",
     "childInstrumentId": "borrower_loan_installment_1_payment",
     "childRefField": "borrowerLoanId",
-    "childStatuses": ["paid"],
+    "childStatuses": [
+      "paid"
+    ],
     "parentField": "installment1Amount"
   },
   {
     "childField": "amount",
     "childInstrumentId": "borrower_loan_installment_2_payment",
     "childRefField": "borrowerLoanId",
-    "childStatuses": ["paid"],
+    "childStatuses": [
+      "paid"
+    ],
     "parentField": "installment2Amount"
   }
 ]
@@ -1013,34 +1370,6 @@ true
 "note"
 ```
 
-## journeys
-
-- Scope: instrument
-- UDL target: `journeys`
-- Cardinality: many
-- Linear outputs: none
-- Effects: none
-- Law: Requirements-as-data law and closure law
-- Conformance source: `hand-edited.udl`
-
-```json
-[
-  {
-    "id": "file_note",
-    "label": "File a note",
-    "steps": [
-      {
-        "bind": {},
-        "example": "default",
-        "id": "note",
-        "operation": "note.create"
-      }
-    ],
-    "summary": "File a note."
-  }
-]
-```
-
 ## nav
 
 - Scope: instrument
@@ -1052,7 +1381,10 @@ true
 - Conformance source: `cards.udl`
 
 ```json
-["Blueprints", "Cardholders"]
+[
+  "Blueprints",
+  "Cardholders"
+]
 ```
 
 ## partitions
@@ -1068,7 +1400,10 @@ true
 ```json
 [
   {
-    "pieceFields": ["installment1Amount", "installment2Amount"],
+    "pieceFields": [
+      "installment1Amount",
+      "installment2Amount"
+    ],
     "totalField": "principalAmount"
   }
 ]
@@ -1086,7 +1421,10 @@ true
 
 ```json
 {
-  "kinds": ["vehicle", "merchandise"]
+  "kinds": [
+    "vehicle",
+    "merchandise"
+  ]
 }
 ```
 
@@ -1118,6 +1456,25 @@ true
 "public"
 ```
 
+## template binding
+
+- Scope: instrument
+- UDL target: `templateBinding`
+- Cardinality: one
+- Linear outputs: none
+- Effects: none
+- Law: Requirements-as-data law and closure law
+- Conformance source: `vocabulary.udl`
+
+```json
+{
+  "id": "assessment",
+  "parameters": {
+    "cost": true
+  }
+}
+```
+
 ## template id
 
 - Scope: instrument
@@ -1169,7 +1526,38 @@ true
       "name": "update_cardholder_contact"
     }
   ],
-  "fields": ["displayName", "email", "phoneNumber"],
-  "states": ["pending", "active", "suspended"]
+  "fields": [
+    "displayName",
+    "email",
+    "phoneNumber"
+  ],
+  "states": [
+    "pending",
+    "active",
+    "suspended"
+  ]
+}
+```
+
+## request authority
+
+- Scope: action
+- UDL target: `requestAuthority`
+- Cardinality: one
+- Linear outputs: none
+- Effects: none
+- Law: Requirements-as-data law and closure law
+- Conformance source: `attested.udl`
+
+```json
+{
+  "actionField": "actionName",
+  "digestField": "digest",
+  "expiresField": "expiry",
+  "inputField": "requestInput",
+  "instanceField": "requestId",
+  "instrumentField": "requestInstrument",
+  "party": "decider",
+  "roleField": "role"
 }
 ```