@hyperscale0/udl 2.6.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (213) hide show
  1. package/CHANGELOG.md +2 -322
  2. package/LICENSING.md +1 -2
  3. package/README.md +3 -114
  4. package/TRADEMARKS.md +2 -2
  5. package/dist/diagnostics.d.ts +21 -201
  6. package/dist/diagnostics.d.ts.map +1 -1
  7. package/dist/diagnostics.js +29 -193
  8. package/dist/diagnostics.js.map +1 -1
  9. package/dist/evolution.d.ts +3 -132
  10. package/dist/evolution.d.ts.map +1 -1
  11. package/dist/evolution.js +29 -633
  12. package/dist/evolution.js.map +1 -1
  13. package/dist/finance.d.ts +5 -72
  14. package/dist/finance.d.ts.map +1 -1
  15. package/dist/finance.js +233 -737
  16. package/dist/finance.js.map +1 -1
  17. package/dist/index.d.ts +7 -18
  18. package/dist/index.d.ts.map +1 -1
  19. package/dist/index.js +7 -12
  20. package/dist/index.js.map +1 -1
  21. package/dist/instrument-references.d.ts.map +1 -1
  22. package/dist/instrument-references.js +3 -2
  23. package/dist/instrument-references.js.map +1 -1
  24. package/dist/schema.d.ts +2079 -4564
  25. package/dist/schema.d.ts.map +1 -1
  26. package/dist/schema.js +270 -1609
  27. package/dist/schema.js.map +1 -1
  28. package/dist/validation.d.ts +8 -104
  29. package/dist/validation.d.ts.map +1 -1
  30. package/dist/validation.js +653 -3271
  31. package/dist/validation.js.map +1 -1
  32. package/docs/README.md +147 -14
  33. package/package.json +7 -11
  34. package/spec/README.md +151 -164
  35. package/spec/darb.udl.json +249 -0
  36. package/spec/udl.schema.json +4104 -3202
  37. package/src/diagnostics.ts +51 -246
  38. package/src/evolution.ts +39 -1045
  39. package/src/finance.ts +287 -1127
  40. package/src/index.ts +18 -142
  41. package/src/instrument-references.ts +3 -2
  42. package/src/schema.ts +285 -1843
  43. package/src/validation.ts +870 -5611
  44. package/conformance/README.md +0 -82
  45. package/conformance/evolution/action-contract.expected.json +0 -10
  46. package/conformance/evolution/action-contract.live.udl +0 -44
  47. package/conformance/evolution/action-contract.next.udl +0 -45
  48. package/conformance/evolution/product-identity.expected.json +0 -10
  49. package/conformance/evolution/product-identity.live.udl +0 -55
  50. package/conformance/evolution/product-identity.next.udl +0 -55
  51. package/conformance/evolution/version-required.expected.json +0 -10
  52. package/conformance/evolution/version-required.live.udl +0 -55
  53. package/conformance/evolution/version-required.next.udl +0 -58
  54. package/conformance/invalid/action-without-transition.expected.json +0 -10
  55. package/conformance/invalid/action-without-transition.udl +0 -60
  56. package/conformance/invalid/agent-description-too-long.expected.json +0 -10
  57. package/conformance/invalid/agent-description-too-long.udl +0 -57
  58. package/conformance/invalid/blank-title.expected.json +0 -10
  59. package/conformance/invalid/blank-title.udl +0 -54
  60. package/conformance/invalid/call-binds-results.expected.json +0 -10
  61. package/conformance/invalid/call-binds-results.udl +0 -314
  62. package/conformance/invalid/call-unknown-action.expected.json +0 -10
  63. package/conformance/invalid/call-unknown-action.udl +0 -314
  64. package/conformance/invalid/composition-dial-duplicate-key.expected.json +0 -10
  65. package/conformance/invalid/composition-dial-duplicate-key.udl +0 -73
  66. package/conformance/invalid/depth-budget.expected.json +0 -10
  67. package/conformance/invalid/depth-budget.udl +0 -49
  68. package/conformance/invalid/duplicate-subject.expected.json +0 -10
  69. package/conformance/invalid/duplicate-subject.udl +0 -230
  70. package/conformance/invalid/forged-effects.expected.json +0 -10
  71. package/conformance/invalid/forged-effects.udl +0 -76
  72. package/conformance/invalid/format-version.expected.json +0 -10
  73. package/conformance/invalid/format-version.udl +0 -54
  74. package/conformance/invalid/instrument-id-not-snake-case.expected.json +0 -10
  75. package/conformance/invalid/instrument-id-not-snake-case.udl +0 -54
  76. package/conformance/invalid/invalid-aggregate-gate-shape.expected.json +0 -10
  77. package/conformance/invalid/invalid-aggregate-gate-shape.udl +0 -1819
  78. package/conformance/invalid/invalid-check-duration.expected.json +0 -10
  79. package/conformance/invalid/invalid-check-duration.udl +0 -219
  80. package/conformance/invalid/invalid-dial-anchor.expected.json +0 -10
  81. package/conformance/invalid/invalid-dial-anchor.udl +0 -219
  82. package/conformance/invalid/invalid-exception-parent-ref.expected.json +0 -10
  83. package/conformance/invalid/invalid-exception-parent-ref.udl +0 -2487
  84. package/conformance/invalid/invalid-exposure-shape.expected.json +0 -10
  85. package/conformance/invalid/invalid-exposure-shape.udl +0 -1819
  86. package/conformance/invalid/invalid-journeys.expected.json +0 -10
  87. package/conformance/invalid/invalid-journeys.udl +0 -77
  88. package/conformance/invalid/invalid-remainder.expected.json +0 -10
  89. package/conformance/invalid/invalid-remainder.udl +0 -220
  90. package/conformance/invalid/invalid-schema-keyword.expected.json +0 -10
  91. package/conformance/invalid/invalid-schema-keyword.udl +0 -220
  92. package/conformance/invalid/invalid-utf8.expected.json +0 -10
  93. package/conformance/invalid/invalid-utf8.udl +0 -1
  94. package/conformance/invalid/leaf-effect-mismatch.expected.json +0 -10
  95. package/conformance/invalid/leaf-effect-mismatch.udl +0 -314
  96. package/conformance/invalid/malformed-json.expected.json +0 -10
  97. package/conformance/invalid/malformed-json.udl +0 -1
  98. package/conformance/invalid/missing-create-action.expected.json +0 -10
  99. package/conformance/invalid/missing-create-action.udl +0 -48
  100. package/conformance/invalid/missing-exception-amount-field.expected.json +0 -10
  101. package/conformance/invalid/missing-exception-amount-field.udl +0 -2487
  102. package/conformance/invalid/missing-exception-contract.expected.json +0 -14
  103. package/conformance/invalid/missing-exception-contract.udl +0 -2523
  104. package/conformance/invalid/missing-exception-reason-field.expected.json +0 -10
  105. package/conformance/invalid/missing-exception-reason-field.udl +0 -2487
  106. package/conformance/invalid/not-an-object.expected.json +0 -10
  107. package/conformance/invalid/not-an-object.udl +0 -1
  108. package/conformance/invalid/payout-reconcile-not-a-bank-debit.expected.json +0 -10
  109. package/conformance/invalid/payout-reconcile-not-a-bank-debit.udl +0 -259
  110. package/conformance/invalid/piece-plan-without-partition.expected.json +0 -10
  111. package/conformance/invalid/piece-plan-without-partition.udl +0 -305
  112. package/conformance/invalid/private-action-independent-approval.expected.json +0 -10
  113. package/conformance/invalid/private-action-independent-approval.udl +0 -314
  114. package/conformance/invalid/quote-freeze-set-incomplete.expected.json +0 -10
  115. package/conformance/invalid/quote-freeze-set-incomplete.udl +0 -261
  116. package/conformance/invalid/quote-named-reference-gate.expected.json +0 -10
  117. package/conformance/invalid/quote-named-reference-gate.udl +0 -50
  118. package/conformance/invalid/reconcile-named-reference-gate.expected.json +0 -10
  119. package/conformance/invalid/reconcile-named-reference-gate.udl +0 -50
  120. package/conformance/invalid/unfund-order-not-reversed.expected.json +0 -10
  121. package/conformance/invalid/unfund-order-not-reversed.udl +0 -314
  122. package/conformance/invalid/unknown-key.expected.json +0 -10
  123. package/conformance/invalid/unknown-key.udl +0 -55
  124. package/conformance/invalid/unknown-reference-gate-field.expected.json +0 -10
  125. package/conformance/invalid/unknown-reference-gate-field.udl +0 -1819
  126. package/conformance/invalid/unknown-required-field.expected.json +0 -10
  127. package/conformance/invalid/unknown-required-field.udl +0 -220
  128. package/conformance/invalid/unreachable-state.expected.json +0 -10
  129. package/conformance/invalid/unreachable-state.udl +0 -55
  130. package/conformance/invalid/wrong-exception-amount-field.expected.json +0 -10
  131. package/conformance/invalid/wrong-exception-amount-field.udl +0 -2487
  132. package/conformance/invalid/wrong-exception-reason-field.expected.json +0 -10
  133. package/conformance/invalid/wrong-exception-reason-field.udl +0 -2487
  134. package/conformance/valid/agent-description.expected.json +0 -6
  135. package/conformance/valid/agent-description.udl +0 -66
  136. package/conformance/valid/attested.expected.json +0 -6
  137. package/conformance/valid/attested.udl +0 -251
  138. package/conformance/valid/cards.expected.json +0 -6
  139. package/conformance/valid/cards.udl +0 -1579
  140. package/conformance/valid/commerce-escrow.expected.json +0 -6
  141. package/conformance/valid/commerce-escrow.udl +0 -1512
  142. package/conformance/valid/compiled-crowdfunding.expected.json +0 -6
  143. package/conformance/valid/compiled-crowdfunding.udl +0 -1843
  144. package/conformance/valid/compiled-watch-club.expected.json +0 -6
  145. package/conformance/valid/compiled-watch-club.udl +0 -2486
  146. package/conformance/valid/complete-contract.expected.json +0 -6
  147. package/conformance/valid/complete-contract.udl +0 -218
  148. package/conformance/valid/effect-signatures.expected.json +0 -6
  149. package/conformance/valid/effect-signatures.udl +0 -75
  150. package/conformance/valid/hand-edited.expected.json +0 -6
  151. package/conformance/valid/hand-edited.udl +0 -1
  152. package/conformance/valid/insured-car-marketplace.expected.json +0 -6
  153. package/conformance/valid/insured-car-marketplace.udl +0 -1050
  154. package/conformance/valid/insured-travel.expected.json +0 -6
  155. package/conformance/valid/insured-travel.udl +0 -3469
  156. package/conformance/valid/minimal.expected.json +0 -6
  157. package/conformance/valid/minimal.udl +0 -62
  158. package/conformance/valid/piece-plan-calls.expected.json +0 -6
  159. package/conformance/valid/piece-plan-calls.udl +0 -314
  160. package/conformance/valid/protection.expected.json +0 -6
  161. package/conformance/valid/protection.udl +0 -1551
  162. package/conformance/valid/string-escaping.expected.json +0 -6
  163. package/conformance/valid/string-escaping.udl +0 -54
  164. package/conformance/valid/vocabulary.expected.json +0 -6
  165. package/conformance/valid/vocabulary.udl +0 -2012
  166. package/dist/allocation.d.ts +0 -60
  167. package/dist/allocation.d.ts.map +0 -1
  168. package/dist/allocation.js +0 -177
  169. package/dist/allocation.js.map +0 -1
  170. package/dist/check-profiles.d.ts +0 -57
  171. package/dist/check-profiles.d.ts.map +0 -1
  172. package/dist/check-profiles.js +0 -62
  173. package/dist/check-profiles.js.map +0 -1
  174. package/dist/distribution.d.ts +0 -15
  175. package/dist/distribution.d.ts.map +0 -1
  176. package/dist/distribution.js +0 -49
  177. package/dist/distribution.js.map +0 -1
  178. package/dist/effects.d.ts +0 -58
  179. package/dist/effects.d.ts.map +0 -1
  180. package/dist/effects.js +0 -1126
  181. package/dist/effects.js.map +0 -1
  182. package/dist/reference.d.ts +0 -3
  183. package/dist/reference.d.ts.map +0 -1
  184. package/dist/reference.js +0 -28
  185. package/dist/reference.js.map +0 -1
  186. package/dist/vocabulary.d.ts +0 -23
  187. package/dist/vocabulary.d.ts.map +0 -1
  188. package/dist/vocabulary.js +0 -1052
  189. package/dist/vocabulary.js.map +0 -1
  190. package/docs/funding-custody.md +0 -165
  191. package/docs/guide/01-a-document.md +0 -37
  192. package/docs/guide/02-money-steps.md +0 -23
  193. package/docs/guide/03-laws.md +0 -18
  194. package/docs/guide/04-fees-and-remainder.md +0 -36
  195. package/docs/guide/05-checks-updates-dials.md +0 -7
  196. package/docs/guide/06-effects.md +0 -11
  197. package/docs/guide/07-evolution.md +0 -11
  198. package/docs/guide/08-implementing.md +0 -13
  199. package/docs/guide/09-schedules-and-allocation.md +0 -132
  200. package/docs/llms-full.txt +0 -2008
  201. package/docs/llms.txt +0 -14
  202. package/docs/piece-plans.md +0 -148
  203. package/docs/reference/canonical.md +0 -16
  204. package/docs/reference/clauses.md +0 -1585
  205. package/docs/reference/cli.md +0 -24
  206. package/docs/reference/diagnostics.md +0 -38
  207. package/skills/udl/SKILL.md +0 -28
  208. package/src/allocation.ts +0 -259
  209. package/src/check-profiles.ts +0 -80
  210. package/src/distribution.ts +0 -61
  211. package/src/effects.ts +0 -1920
  212. package/src/reference.ts +0 -31
  213. package/src/vocabulary.ts +0 -1635
package/src/index.ts CHANGED
@@ -1,148 +1,24 @@
1
+ export * from "./schema.js";
2
+ export { parseUdl, canonicalizeUdl } from "./parser.js";
3
+ export { serializeUdl, canonicalDigest } from "./canonical.js";
1
4
  export {
2
- mapUdlInstrumentReferences,
3
- referencedUdlInstrumentIds,
4
- } from "./instrument-references.js";
5
- export { canonicalizeUdl, parseUdl } from "./parser.js";
6
- export { canonicalDigest, serializeUdl } from "./canonical.js";
7
- export { issue, udlDiagnostic, udlDiagnostics } from "./diagnostics.js";
8
- export type {
9
- UdlDiagnostic,
10
- UdlDiagnosticFamily,
11
- UdlIssue,
12
- UdlIssueCategory,
13
- UdlIssueCode,
14
- } from "./diagnostics.js";
15
- export {
16
- udlCheckEvidenceProfile,
17
- udlCheckEvidenceProfiles,
18
- type UdlCheckEvidenceProfile,
19
- } from "./check-profiles.js";
20
- export { fixedIsoDurationMs } from "./duration.js";
21
- export {
22
- deriveUdlActionEffects,
23
- resolveUdlActionPlans,
24
- movementClass,
25
- udlEffectKinds,
26
- type DerivedUdlEffects,
27
- type ResolvedActionPlan,
28
- type ResolvedActionPlanLeaf,
29
- type ResolvedActionPlansResult,
30
- type UdlEffectKind,
31
- type UdlMovementClass,
32
- } from "./effects.js";
33
- export {
34
- analyzeInstrumentFinance,
35
- type FinanceIssue,
36
- type FinanceOptions,
37
- } from "./finance.js";
38
- export {
39
- diffInstrumentEvolution,
40
- diffValidatedUdlEvolution,
41
- snapshotUdlInstrument,
42
- } from "./evolution.js";
43
- export type {
44
- EvolutionFieldSnapshot,
45
- EvolutionMoveSnapshot,
46
- EvolutionStepSnapshot,
47
- EvolutionTransitionSnapshot,
48
- EvolutionActionSnapshot,
49
- InstrumentEvolutionSnapshot,
50
- } from "./evolution.js";
51
- export {
52
- quoteExpiresAtRefKey,
53
- quoteFrozenRefKey,
54
- quoteSeededRefKeys,
55
- UDL_FORMAT_VERSION,
56
- udlClauseVocabulary,
57
- udlDocumentSchema,
58
- udlInstrumentActionIdSchema,
59
- udlKernelOperationSchema,
60
- udlProviderFamilyIdSchema,
61
- udlPublicActionSchema,
62
- } from "./schema.js";
63
- export type {
64
- UdlPiece,
65
- UdlPiecePlan,
66
- UdlPieceStage,
67
- UdlPieceStageStage,
68
- UdlCall,
69
- UdlPrivateParameterKind,
70
- UdlPrivateParameter,
71
- UdlPrivateLeaf,
72
- UdlPrivateAction,
73
- UdlActionLibraryModule,
74
- UdlActionLibrary,
75
- UdlAggregate,
76
- UdlAggregateCondition,
77
- UdlBinding,
78
- UdlCompositionDial,
79
- UdlDeclaredValuePolicy,
80
- UdlDecision,
81
- UdlDial,
82
- UdlDocument,
83
- UdlDue,
84
- UdlEffects,
85
- UdlExample,
86
- UdlDateComparison,
87
- UdlDateComparisonOperator,
88
- UdlGate,
89
- UdlKernelOperation,
90
- UdlLifecycle,
91
- UdlLifecycleTransition,
92
- UdlInstrument,
93
- UdlInstrumentSubject,
94
- UdlPayout,
95
- UdlQuote,
96
- UdlProviderFamilyId,
97
- UdlCheckRequirement,
98
- UdlClauseCardinality,
99
- UdlClauseEffect,
100
- UdlReconcile,
101
- UdlRemainder,
102
- UdlStep,
103
- UdlSubject,
104
- UdlAction,
105
- UdlClauseVocabularyEntry,
106
- } from "./schema.js";
107
- export {
5
+ validateUdl,
108
6
  assertValidUdl,
109
- isReconcileExceptionChild,
110
- reconcileExceptionChildProblems,
111
- openReferenceShapeBudget,
7
+ resolveField,
112
8
  UdlError,
113
- instrumentFinanceIssues,
114
- validateUdl,
115
- validateUdlJsonSchema,
116
- validateUdlSchemaValue,
9
+ type UdlValidationResult,
117
10
  } from "./validation.js";
118
- export type {
119
- ReferenceShapeBudget,
120
- UdlValidationOptions,
121
- UdlValidationResult,
122
- } from "./validation.js";
123
-
124
11
  export {
125
- deriveUdlAmount,
126
- deriveRemainder,
127
- matchesOrdered,
128
- matchesDateOrder,
129
- matchesSchedule,
130
- isDueBefore,
131
- planContributions,
132
- } from "./vocabulary.js";
12
+ issue,
13
+ udlDiagnostic,
14
+ udlDiagnostics,
15
+ type UdlIssue,
16
+ type UdlIssueCode,
17
+ } from "./diagnostics.js";
18
+ export { analyzeInstrumentFinance, type FinanceIssue } from "./finance.js";
133
19
  export {
134
- planAllocation,
135
- planAllocationRefund,
136
- matchesAllocationConsumption,
137
- } from "./allocation.js";
138
- export type { UdlAllocation, UdlAllocate, UdlContributions } from "./schema.js";
139
-
140
- export type {
141
- AllocationInput,
142
- AllocationSlice,
143
- AllocationBalance,
144
- AllocationPosting,
145
- AllocationCancellation,
146
- } from "./allocation.js";
147
-
148
- export { distributeReceiptAmounts } from "./distribution.js";
20
+ mapUdlInstrumentReferences,
21
+ referencedUdlInstrumentIds,
22
+ } from "./instrument-references.js";
23
+ export { diffValidatedUdlEvolution } from "./evolution.js";
24
+ export { fixedIsoDurationMs } from "./duration.js";
@@ -81,11 +81,12 @@ export function referencedUdlInstrumentIds(
81
81
  const found = new Set<string>();
82
82
  mapUdlInstrumentReferences(
83
83
  {
84
- udl: 1,
84
+ udl: 3,
85
85
  version: 1,
86
86
  product: "references",
87
87
  title: "References",
88
- subjects: [],
88
+ currency: "SAR",
89
+ parties: {},
89
90
  instruments: [instrument],
90
91
  },
91
92
  (id) => {