@hyperscale0/adl 1.0.0-alpha.2 → 1.0.0-beta.10

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 (43) hide show
  1. package/CHANGELOG.md +46 -2
  2. package/LICENSE.md +356 -0
  3. package/NOTICE.md +8 -0
  4. package/README.md +29 -140
  5. package/conformance/cases.json +50 -764
  6. package/conformance/subject-adapter.ts +31 -0
  7. package/dist/boundary-fixture.d.ts +24 -0
  8. package/dist/boundary-fixture.d.ts.map +1 -0
  9. package/dist/boundary-fixture.js +34 -0
  10. package/dist/boundary-fixture.js.map +1 -0
  11. package/dist/index.d.ts +68 -156
  12. package/dist/index.d.ts.map +1 -1
  13. package/dist/index.js +100 -77
  14. package/dist/index.js.map +1 -1
  15. package/dist/vocabulary.d.ts +3 -57
  16. package/dist/vocabulary.d.ts.map +1 -1
  17. package/dist/vocabulary.js +12 -84
  18. package/dist/vocabulary.js.map +1 -1
  19. package/docs/assets/adl.svg +11 -0
  20. package/docs/assets/brand/adl-horizontal-white.svg +1 -0
  21. package/docs/assets/brand/adl-horizontal.svg +1 -0
  22. package/docs/assets/brand/adl-stacked-white.svg +1 -0
  23. package/docs/assets/brand/adl-stacked.svg +1 -0
  24. package/docs/assets/brand/manifest.json +30 -0
  25. package/docs/authoring-guide.md +37 -416
  26. package/package.json +17 -12
  27. package/spec/manifest.schema.json +646 -439
  28. package/LICENSE +0 -661
  29. package/LICENSING.md +0 -51
  30. package/TRADEMARKS.md +0 -30
  31. package/dist/conformance.d.ts +0 -41
  32. package/dist/conformance.d.ts.map +0 -1
  33. package/dist/conformance.js +0 -486
  34. package/dist/conformance.js.map +0 -1
  35. package/examples/meridian-bank/README.md +0 -65
  36. package/examples/meridian-bank/example.spec.ts +0 -162
  37. package/examples/meridian-bank/fixtures/payout-status-replay.json +0 -19
  38. package/examples/meridian-bank/fixtures/payout-status-settled.json +0 -19
  39. package/examples/meridian-bank/fixtures/payout-submit-accepted.json +0 -26
  40. package/examples/meridian-bank/fixtures/payout-submit-declined.json +0 -25
  41. package/examples/meridian-bank/fixtures/statement-camt053.json +0 -45
  42. package/examples/meridian-bank/fixtures/webhook-payout-settled.json +0 -11
  43. package/examples/meridian-bank/index.ts +0 -262
package/CHANGELOG.md CHANGED
@@ -4,7 +4,50 @@ All notable changes to this package are documented here. The format follows
4
4
  [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project
5
5
  follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) from 1.0.0.
6
6
 
7
- ## [Unreleased]
7
+ ## [1.0.0-beta.10] - 2026-09-23
8
+
9
+ - Pin the public UDL dependency to 4.7.0 so ADL and HSX resolve the same contract version.
10
+
11
+ ## [1.0.0-beta.9] - 2026-09-22
12
+
13
+ - Regenerated `spec/manifest.schema.json`: optional `label` on the shapes that UDL 4.6.0 labels, which beta.8 shipped without.
14
+
15
+ ## [1.0.0-beta.8] - 2026-09-21
16
+
17
+ - Regenerated `spec/manifest.schema.json`: `sensitive` on field shapes and `targetFamily` on references, which beta.7 shipped without.
18
+
19
+ ## [1.0.0-beta.7] - 2026-09-21
20
+
21
+ - Added optional `subjectRequirements` on operation bindings: subject fields an action collects before dispatch.
22
+ - Added `BoundaryInstruction`, `BoundaryObservation`, `BoundaryOutcome` and `BoundaryAdapter`.
23
+ - Replaced bank profiles and certification with generic binding conformance.
24
+ - Removed the fictional bank example and its status, rail and calendar vocabulary.
25
+
26
+ ## [1.0.0-beta.6] - 2026-09-20
27
+
28
+ - Republished so the package cites a platform commit that survives the 2026-09-19 history rewrite. No vocabulary or conformance change.
29
+
30
+ ## [1.0.0-beta.5] - 2026-09-18
31
+
32
+ - Licensed under the Hyperscale Intellectual Property and Copyright License 1.0 (`LicenseRef-Hyperscale-IPCL-1.0`), Tier 2 (Source Available). The AGPL-3.0-only grant ends with this release; earlier versions keep it. `LICENSE.md` and `NOTICE.md` replace the previous license, licensing and trademark files; trademark and conformance rules now live in the license. No vocabulary or conformance change.
33
+
34
+ ## [1.0.0-beta.4] - 2026-09-14
35
+
36
+ - Republished with the design-language brand assets in the README. No package behavior changes from 1.0.0-beta.3.
37
+
38
+ ## [1.0.0-beta.3] - 2026-09-10
39
+
40
+ - Republished without the GitHub Actions publish workflow. No package behavior changes from 1.0.0-beta.2.
41
+
42
+ ## [1.0.0-beta.2] - 2026-09-10
43
+
44
+ - Republished against UDL 2.0.0. No package behavior changes from
45
+ 1.0.0-beta.1.
46
+
47
+ ## [1.0.0-beta.1] - 2026-08-29
48
+
49
+ - This is the first beta and has no package behavior changes from
50
+ 1.0.0-alpha.2.
8
51
 
9
52
  ## [1.0.0-alpha.2] - 2026-08-26
10
53
 
@@ -54,6 +97,7 @@ write an adapter in; an adapter is still what you write.
54
97
  the exported types derived from them, so the published schema cannot drift
55
98
  from the type checker. No exported type changed shape.
56
99
 
57
- [Unreleased]: https://github.com/hyperscale0/hyperscale-adl/compare/v1.0.0-alpha.2...HEAD
100
+ [Unreleased]: https://github.com/hyperscale0/hyperscale-adl/compare/v1.0.0-beta.1...HEAD
101
+ [1.0.0-beta.1]: https://github.com/hyperscale0/hyperscale-adl/compare/v1.0.0-alpha.2...v1.0.0-beta.1
58
102
  [1.0.0-alpha.2]: https://github.com/hyperscale0/hyperscale-adl/compare/v1.0.0-alpha.1...v1.0.0-alpha.2
59
103
  [1.0.0-alpha.1]: https://github.com/hyperscale0/hyperscale-adl/releases/tag/v1.0.0-alpha.1
package/LICENSE.md ADDED
@@ -0,0 +1,356 @@
1
+ # Hyperscale Intellectual Property and Copyright License
2
+
3
+ Version 1.0, effective 18 September 2026. This text is under review by
4
+ Hyperscale LLC's counsel. Until a revised version replaces it, it states the
5
+ terms on which Hyperscale makes the Software available.
6
+
7
+ SPDX identifier: `LicenseRef-Hyperscale-IPCL-1.0`
8
+
9
+ Copyright (c) 2026 Hyperscale LLC. All rights reserved.
10
+
11
+ This is not an open source license. The Software is proprietary. Hyperscale
12
+ publishes some of it so that you can read it, learn it, build on the Hyperscale
13
+ platform with it, and verify what Hyperscale runs. Publishing is not a gift of
14
+ rights. Every right not written in this License stays with Hyperscale.
15
+
16
+ ---
17
+
18
+ ## 1. Acceptance
19
+
20
+ By accessing, viewing, downloading, cloning, installing, copying, compiling,
21
+ running, or otherwise using any part of the Software, you accept this License.
22
+ If you do not accept it, do none of those things. If you act for an
23
+ organisation, you confirm you have authority to bind it, and "you" means that
24
+ organisation and every person acting for it.
25
+
26
+ ## 2. Definitions
27
+
28
+ "Hyperscale" means Hyperscale LLC, a limited liability company organised under
29
+ the laws of the Kingdom of Saudi Arabia, and its successors and assigns.
30
+
31
+ "Software" means every work Hyperscale distributes under this License, in any
32
+ form: source code, compiled or bundled code, schemas, grammars, standard
33
+ libraries, headers, example programs, fixtures, conformance cases, generated
34
+ artifacts, documentation, designs, images, and data files, and every update,
35
+ version, or part of any of them.
36
+
37
+ "Specification" means the parts of the Software that Hyperscale designates as a
38
+ Specification in the applicable Notice: a schema, grammar, wire format,
39
+ manifest format, vocabulary, or interface description, together with its
40
+ documentation and published example inputs and outputs.
41
+
42
+ "Hyperscale Platform" means the products and services Hyperscale offers or
43
+ operates, in any form and under any name, including Hyperscale Arc, Architect,
44
+ Composer, the Hyperscale engine, portals, registries, hosted compilers, hosted
45
+ MCP servers, generated SDKs, and every successor product.
46
+
47
+ "Notice" means the file named `NOTICE` or `NOTICE.md`, or the license
48
+ statement in a package manifest, that accompanies a copy of the Software and
49
+ states which Tier under section 4 applies to it.
50
+
51
+ "Tier" means one of the three permission levels in section 4.
52
+
53
+ "Derivative Work" means any work that is based on, incorporates, translates,
54
+ adapts, ports, reimplements, transforms, or is derived from the Software or any
55
+ part of it, in any language or form, including a work produced by studying the
56
+ Software and then writing new code that performs the same function.
57
+
58
+ "Competing Product" means any product, service, library, platform, or tool,
59
+ whether or not sold, that performs or is offered as performing substantially the
60
+ same function as the Hyperscale Platform or any part of it, including: a
61
+ language, compiler, or checker for financial programs; an engine, runtime, or
62
+ ledger that executes financial product definitions; a framework for declaring,
63
+ conforming, or operating bank or payment provider adapters; a service that
64
+ generates APIs, SDKs, or agent tools from a financial product definition; or a
65
+ hosted or embedded version of any of those. A product you build on the
66
+ Hyperscale Platform for your own customers is not a Competing Product.
67
+
68
+ "Hosted Use" means making the functionality of the Software available to any
69
+ third party over a network, whether as a service, an API, an agent tool, an
70
+ embedded feature, or otherwise.
71
+
72
+ "Contribution" means any work of authorship you intentionally submit to
73
+ Hyperscale for inclusion in the Software, by any means, unless you clearly mark
74
+ it "not a contribution".
75
+
76
+ "Marks" means the names, logos, and trade dress of Hyperscale and its products,
77
+ including "Hyperscale", "Hyperscale Arc", "HSX", "UDL", "ADL", "Architect",
78
+ "Composer", the `hyperscale0` GitHub organisation, the `@hyperscale0` npm
79
+ scope, and every confusingly similar name or sign.
80
+
81
+ "Confidential Material" means Software distributed under Tier 3, and any part
82
+ of the Software that Hyperscale has not made publicly available.
83
+
84
+ ## 3. Ownership
85
+
86
+ Hyperscale owns all right, title, and interest in the Software, the
87
+ Specifications, the Marks, and every Derivative Work Hyperscale creates,
88
+ including all copyright, patent, trade secret, design, database, and moral
89
+ rights, worldwide. The Software is licensed, not sold. This License transfers
90
+ no ownership of anything to you. Your possession of a copy, in any form, gives
91
+ you no right in it beyond what this License states.
92
+
93
+ The Specifications describe how the Hyperscale Platform works. The design
94
+ choices they record, the vocabulary they fix, the structure of the financial
95
+ programs, products, ledgers, and adapters they define, and the standard library
96
+ of financial instruments Hyperscale publishes are Hyperscale's intellectual
97
+ property. Publication does not place any of it in the public domain.
98
+
99
+ ## 4. Tiers of permission
100
+
101
+ Every copy of the Software carries a Notice naming its Tier. If a copy carries
102
+ no Notice, Tier 3 applies. A permission granted at a higher-numbered Tier is
103
+ never implied at a lower-numbered one.
104
+
105
+ ### Tier 1: Open Specification
106
+
107
+ For Software designated as a Specification, Hyperscale grants you a worldwide,
108
+ non-exclusive, non-transferable, royalty-free, revocable license to:
109
+
110
+ 1. read, copy, and redistribute the Specification, unmodified and with all
111
+ notices intact;
112
+ 2. write programs, documents, and data that conform to the Specification, and
113
+ use them in any way, including commercially;
114
+ 3. write and distribute software that reads, writes, validates, or displays
115
+ data conforming to the Specification, solely for the purpose of using or
116
+ interoperating with the Hyperscale Platform or with products built on it;
117
+ 4. quote reasonable portions of the Specification in documentation, teaching,
118
+ and commentary, with attribution to Hyperscale.
119
+
120
+ Tier 1 does not permit you to build a Competing Product, to publish a modified
121
+ Specification under any name that includes or resembles a Mark, or to claim
122
+ conformance or compatibility except as section 8 allows.
123
+
124
+ ### Tier 2: Source Available
125
+
126
+ For Software designated as Source Available, Hyperscale grants you a worldwide,
127
+ non-exclusive, non-transferable, non-sublicensable, royalty-free, revocable
128
+ license to:
129
+
130
+ 1. view, download, and study the source;
131
+ 2. install, compile, and run the Software, unmodified or modified, on systems
132
+ you control, for the purpose of building, testing, operating, and
133
+ maintaining your own products on the Hyperscale Platform;
134
+ 3. modify the Software for that purpose and keep the modification for your own
135
+ internal use;
136
+ 4. submit modifications to Hyperscale as Contributions;
137
+ 5. redistribute unmodified copies of the Software, in the form Hyperscale
138
+ published them, with all notices and this License intact, for example by
139
+ mirroring a package or vendoring a dependency.
140
+
141
+ Tier 2 does not permit Hosted Use, distribution of modified copies,
142
+ distribution of compiled or bundled forms other than those Hyperscale
143
+ published, or any use in or toward a Competing Product.
144
+
145
+ ### Tier 3: Confidential
146
+
147
+ For Software designated as Confidential, or carrying no Notice, Hyperscale
148
+ grants you only the license written in the agreement under which you received
149
+ it. If there is no such agreement, you have no license, and you must not use,
150
+ copy, disclose, or retain the Software. Confidential Material includes generated
151
+ SDKs, downloadable product artifacts, private repositories, and anything you
152
+ obtain through a portal, a registry, or a signed-in session. You may use
153
+ Confidential Material only for your own organisation's Hyperscale integration,
154
+ must not publish it to any public repository or package registry, must not
155
+ disclose it beyond personnel and contractors who need it and are bound by
156
+ confidentiality at least as protective as this License, and must destroy it on
157
+ request or when your access ends.
158
+
159
+ ## 5. Restrictions
160
+
161
+ Whatever the Tier, you must not, and must not help or allow anyone else to:
162
+
163
+ 1. build, contribute to, market, sell, or operate a Competing Product using
164
+ the Software, a Derivative Work, or knowledge gained from the Software;
165
+ 2. create a Derivative Work except as Tier 2 permits for internal use;
166
+ 3. reimplement, port, translate, or clone the Software or any part of it, in
167
+ any programming language, whether by copying or by studying it and
168
+ rewriting it;
169
+ 4. offer the Software or a Derivative Work for Hosted Use;
170
+ 5. sublicense, sell, rent, lease, lend, or assign the Software or any right in
171
+ it;
172
+ 6. remove, hide, or alter any copyright, trademark, license, or attribution
173
+ notice, or misstate the origin of the Software;
174
+ 7. reverse engineer, decompile, disassemble, or unminify any compiled, bundled,
175
+ or generated form of the Software, except where a law forbids this
176
+ restriction and only to the extent it does;
177
+ 8. circumvent, disable, or evade any license check, access control, rate limit,
178
+ key, or technical protection in the Software or the Hyperscale Platform;
179
+ 9. use the Software, the Specifications, or any output of the Hyperscale
180
+ Platform as training, fine-tuning, evaluation, or retrieval data for any
181
+ machine-learning model, or to generate a Competing Product with such a
182
+ model, without Hyperscale's prior written consent;
183
+ 10. use the Software to benchmark or compare the Hyperscale Platform in any
184
+ publication without Hyperscale's prior written consent;
185
+ 11. register, apply for, or claim any patent, trademark, design, or domain
186
+ name that covers or resembles the Software, the Specifications, or the
187
+ Marks;
188
+ 12. use the Software in violation of any law, sanction, or export control;
189
+ 13. use the Software for any purpose this License does not expressly permit.
190
+
191
+ ## 6. Contributions
192
+
193
+ You are not required to contribute. If you do, then on submission you grant
194
+ Hyperscale, and everyone who receives the Software from Hyperscale, a
195
+ perpetual, worldwide, non-exclusive, irrevocable, royalty-free license to use,
196
+ reproduce, modify, distribute, sublicense, and relicense your Contribution
197
+ under any terms, including this License and any commercial license, and you
198
+ grant Hyperscale a patent license of the same scope covering the claims your
199
+ Contribution alone or in combination with the Software would infringe. You
200
+ confirm you have the right to make these grants and that the Contribution is
201
+ your own work or that you have permission to submit it. Hyperscale may require
202
+ a signed contributor agreement before merging any Contribution and may decline
203
+ any Contribution for any reason. Feedback, suggestions, and ideas you send
204
+ about the Software are not confidential and Hyperscale may use them freely.
205
+
206
+ ## 7. Marks
207
+
208
+ This License grants no right to any Mark. You may refer to the Software and to
209
+ the Hyperscale Platform by name to describe truthfully that your product uses
210
+ or integrates with them. You must not use any Mark as or in the name of your
211
+ product, company, package, domain, or repository, in a logo, or in any way that
212
+ suggests Hyperscale made, sponsors, certifies, or endorses your work.
213
+
214
+ ## 8. Conformance and compatibility claims
215
+
216
+ You may state that your product "conforms to" or "is compatible with" a named
217
+ Specification version only if, at the time of the claim, your product
218
+ validates against the Specification exactly as Hyperscale published it, using
219
+ Hyperscale's published example inputs unmodified, and you built the product
220
+ under Tier 1 for the purpose of interoperating with the Hyperscale Platform.
221
+ The claim is a statement about your product and never an endorsement by
222
+ Hyperscale. Hyperscale may require you to withdraw a claim it considers false.
223
+ No claim of conformance permits a Competing Product.
224
+
225
+ ## 9. Commercial license
226
+
227
+ Hyperscale offers a commercial license to organisations whose use falls
228
+ outside this License, including Hosted Use, distribution of modified copies,
229
+ embedding in a proprietary product, or any use a procurement policy cannot
230
+ accept under these terms. Ask through <https://hyperscale0.ai>. Nothing in this
231
+ section grants any right until a commercial agreement is signed.
232
+
233
+ ## 10. Prior releases
234
+
235
+ Any version of the Software that Hyperscale released under a different license
236
+ remains available under that license for that version only. This License
237
+ applies to every version that carries it and to every later version unless
238
+ that version states otherwise. Nothing in this License narrows a right you
239
+ already hold in a prior version under its own license.
240
+
241
+ ## 11. Term and termination
242
+
243
+ This License takes effect when you accept it and lasts until terminated. It
244
+ terminates automatically, with no notice, the moment you breach section 5 or
245
+ section 7. For any other breach, it terminates thirty days after Hyperscale
246
+ notifies you, unless you cure the breach within that period and it is the
247
+ first notice you have received. Hyperscale may also terminate this License for
248
+ convenience for any Tier 3 material, on notice. On termination you must stop
249
+ all use, destroy every copy in your possession or control, including
250
+ Derivative Works, and confirm destruction in writing if asked. Sections 3, 5,
251
+ 6, 7, 11, 12, 13, 14, 15, and 16 survive termination.
252
+
253
+ ## 12. Disclaimer of warranty
254
+
255
+ The Software is provided "as is" and "as available". Hyperscale makes no
256
+ warranty of any kind, express, implied, or statutory, including any warranty
257
+ of merchantability, fitness for a particular purpose, title, non-infringement,
258
+ accuracy, or that the Software will be error-free or uninterrupted. Hyperscale
259
+ is not a bank, does not hold money, and gives no assurance that any financial
260
+ program, product, or adapter written with the Software is lawful, licensed,
261
+ or fit for any real-world financial use in any jurisdiction.
262
+
263
+ ## 13. Limitation of liability
264
+
265
+ To the fullest extent the law allows, Hyperscale is not liable to you or any
266
+ third party for any indirect, incidental, special, consequential, exemplary, or
267
+ punitive damages, or for any loss of profit, revenue, data, goodwill, or
268
+ business opportunity, arising from or related to the Software or this
269
+ License, however caused and under any theory of liability, even if advised of
270
+ the possibility. Hyperscale's total liability under this License is limited to
271
+ one thousand Saudi riyals (SAR 1,000) or the amount you paid Hyperscale for the
272
+ Software in the twelve months before the claim, whichever is greater.
273
+
274
+ ## 14. Indemnity
275
+
276
+ You will defend, indemnify, and hold harmless Hyperscale, its owners,
277
+ officers, employees, and agents from every claim, loss, damage, liability,
278
+ cost, and expense, including reasonable legal fees, arising from your use of
279
+ the Software, your Derivative Works, your products, or your breach of this
280
+ License.
281
+
282
+ ## 15. Remedies and enforcement
283
+
284
+ You acknowledge that the Software embodies valuable trade secrets and
285
+ intellectual property of Hyperscale, that a breach of section 3, 4, 5, or 7
286
+ would cause Hyperscale irreparable harm that money alone cannot repair, and
287
+ that Hyperscale is entitled to injunctive and other equitable relief in any
288
+ court of competent jurisdiction to stop or prevent a breach, without posting a
289
+ bond and in addition to every other remedy. You will pay Hyperscale's
290
+ reasonable legal fees and costs in any action in which Hyperscale enforces
291
+ this License and prevails on any claim. Hyperscale may bring an action in the
292
+ courts named in section 16 or in any jurisdiction where the Software is used,
293
+ a Derivative Work is made, or a Competing Product is offered, and you consent
294
+ to the jurisdiction of those courts.
295
+
296
+ ## 16. Governing law and venue
297
+
298
+ This License is governed by the laws of the Kingdom of Saudi Arabia, including
299
+ the Copyright Law issued by Royal Decree M/41 and its implementing
300
+ regulations, without regard to conflict-of-law rules. The competent courts of
301
+ Riyadh have exclusive jurisdiction over any dispute arising from this License,
302
+ subject to Hyperscale's right under section 15 to enforce elsewhere. The
303
+ Berne Convention and the TRIPS Agreement apply to the protection of the
304
+ Software in every member state. Where a law of another jurisdiction gives you
305
+ a right this License cannot exclude, that right is preserved to the minimum
306
+ extent that law requires and no further.
307
+
308
+ ## 17. General
309
+
310
+ 1. This License is the entire agreement between you and Hyperscale about the
311
+ Software under its Tier, and replaces every earlier or contemporaneous
312
+ understanding, except a signed commercial agreement, which prevails where
313
+ the two conflict.
314
+ 2. If any provision is held unenforceable, it is limited to the minimum
315
+ extent necessary and the rest stays in force.
316
+ 3. Hyperscale's failure or delay in enforcing any provision is not a waiver.
317
+ A waiver is effective only in writing signed by Hyperscale.
318
+ 4. You may not assign or transfer this License or any right under it, by
319
+ operation of law or otherwise, and any attempt is void. Hyperscale may
320
+ assign it freely.
321
+ 5. Hyperscale may publish new versions of this License. Each version of the
322
+ Software carries the License version it was released under, and a new
323
+ License version applies only to Software that carries it.
324
+ 6. This License is written in English. Hyperscale may publish an Arabic
325
+ translation. Where a court requires an Arabic text, the certified Arabic
326
+ translation Hyperscale provides is the text of record; in every other case
327
+ the English text governs.
328
+ 7. Nothing in this License creates a partnership, joint venture, agency, or
329
+ employment relationship between you and Hyperscale.
330
+ 8. Notices to Hyperscale go to the address published at
331
+ <https://hyperscale0.ai/legal>.
332
+
333
+ ---
334
+
335
+ ## Applying this License
336
+
337
+ A copy of the Software must carry this file as `LICENSE.md` and a `NOTICE.md`
338
+ that states the Tier. The form is:
339
+
340
+ ```
341
+ This work is licensed under the Hyperscale Intellectual Property and
342
+ Copyright License, version 1.0 (LicenseRef-Hyperscale-IPCL-1.0).
343
+ Copyright (c) 2026 Hyperscale LLC. All rights reserved.
344
+
345
+ Tier: 2 (Source Available)
346
+ Specifications under Tier 1 in this repository: spec/, docs/grammar.md
347
+
348
+ Not open source. See LICENSE.md.
349
+ ```
350
+
351
+ A package manifest states `"license": "SEE LICENSE IN LICENSE.md"`. A source
352
+ file may carry the one-line header:
353
+
354
+ ```
355
+ // Copyright (c) 2026 Hyperscale LLC. Licensed under LicenseRef-Hyperscale-IPCL-1.0. Not open source.
356
+ ```
package/NOTICE.md ADDED
@@ -0,0 +1,8 @@
1
+ This work is licensed under the Hyperscale Intellectual Property and
2
+ Copyright License, version 1.0 (`LicenseRef-Hyperscale-IPCL-1.0`).
3
+ Copyright (c) 2026 Hyperscale LLC. All rights reserved.
4
+
5
+ Tier: 2 (Source Available)
6
+ Specifications under Tier 1 (Open Specification) in this repository: spec/, conformance/cases.json, docs/, examples/
7
+
8
+ Not open source. See [LICENSE.md](LICENSE.md).
package/README.md CHANGED
@@ -1,37 +1,16 @@
1
- # ADL
2
-
3
- ADL, the Adapter Declaration Language: the format for describing a bank or
4
- provider to Hyperscale, the validator that refuses a declaration the runtime
5
- could not operate, and the conformance suite that says when one is ready to
6
- serve live money.
7
-
8
- It is the third of three. UDL describes the product, HSX scripts the money
9
- movement, ADL declares the provider the money moves through.
10
-
11
- **Status: alpha.** `1.0.0-alpha.1`. The surface can still change on a minor
12
- version until 1.0.0.
13
-
14
- ## Adapter symmetry
1
+ <p align="left">
2
+ <picture>
3
+ <source media="(max-width: 600px) and (prefers-color-scheme: dark)" srcset="docs/assets/brand/adl-stacked-white.svg">
4
+ <source media="(max-width: 600px)" srcset="docs/assets/brand/adl-stacked.svg">
5
+ <source media="(prefers-color-scheme: dark)" srcset="docs/assets/brand/adl-horizontal-white.svg">
6
+ <source media="(prefers-color-scheme: light)" srcset="docs/assets/brand/adl-horizontal.svg">
7
+ <img src="docs/assets/brand/adl-horizontal.svg" alt="Hyperscale™ ADL" width="335">
8
+ </picture>
9
+ </p>
15
10
 
16
- Hyperscale's own bank adapters are written against this package and nothing
17
- more. There is no private adapter API and no second interface for first-party
18
- code. When one of our adapters needs a seam ADL lacks, the seam is added here,
19
- in public, or it is not added.
20
-
21
- So the guide below is not a simplified account of how we do it. It is how we
22
- do it.
23
-
24
- ## What an adapter is
25
-
26
- A declaration, not a client. A plain object saying what the provider does:
27
- which commands exist, how each response classifies, what the bank's status
28
- tokens mean, when statements can be fetched, which reference comes back on a
29
- debit. The runtime that executes it is generic and ships with the platform.
11
+ # ADL
30
12
 
31
- Your adapter opens no sockets, holds no credentials, and decides nothing about
32
- what a payment means. It states facts, and the checks in this package prove
33
- those facts are complete enough for a generic runtime to poll, classify,
34
- reconcile, and dedupe without guessing.
13
+ ADL declares provider bindings and the instruction and observation contract for external work. HSX authors money behavior; UDL carries that contract into execution. The runtime owns money accounts, reservations and evidence consumption.
35
14
 
36
15
  ## Install
37
16
 
@@ -39,126 +18,36 @@ reconcile, and dedupe without guessing.
39
18
  npm install @hyperscale0/adl
40
19
  ```
41
20
 
42
- Every release before 1.0.0 is an alpha, and `latest` follows the newest one, so
43
- a bare install gets it. Pin an exact version if you need one: until 1.0.0 a
44
- change to the surface ships as a minor bump, not a major.
45
-
46
- No runtime dependencies, and no proprietary code imported.
47
-
48
- ## The thirty-second shape
49
-
50
- ```ts
51
- import {
52
- certifyPartnerBankAdapter,
53
- createProviderAdapterRegistry,
54
- type ProviderAdapterVocabulary,
55
- } from "@hyperscale0/adl";
56
-
57
- interface MyVocabulary extends ProviderAdapterVocabulary {
58
- capability: "payout_execution";
59
- operation: "payout.submit";
60
- resource: "payout";
61
- // ...the rest of your closed unions
62
- }
63
-
64
- const defineAdapters = createProviderAdapterRegistry<MyVocabulary>();
65
-
66
- export const adapters = defineAdapters([
67
- {
68
- provider: "meridian_bank",
69
- capability: "payout_execution",
70
- egress: "rest",
71
- operationMap: {
72
- "payout.submit": {
73
- operation: "payout.submit",
74
- direction: "tenant_initiated",
75
- envelope: "http_status_error_body",
76
- statusEnquiry: {
77
- keys: "provider_reference",
78
- pathTemplate: "/v2/payments/{providerReference}",
79
- },
80
- obligationKind: "payout_submission",
81
- resourceKind: "payout",
82
- resourceIdPath: "payoutId",
83
- },
84
- },
85
- webhookMap: {},
86
- bindings: { payout: "claim" },
87
- config: {
88
- credentialRef: { source: "environment", name: "MERIDIAN_CREDENTIALS" },
89
- },
90
- profile: myBankProfile,
91
- },
92
- ]);
93
-
94
- for (const adapter of adapters) certifyPartnerBankAdapter(adapter);
95
- ```
21
+ Pre-1.0 releases are prerelease versions (alpha and beta). Pin an exact version if needed: until 1.0.0, a change to the surface ships as a minor bump, not a major. ADL depends on `@hyperscale0/udl` for object field schema validation.
96
22
 
97
- `createProviderAdapterRegistry` validates at import and preserves your literal
98
- types. `certifyPartnerBankAdapter` throws with every gap listed at once; an
99
- empty finding list is the certification.
23
+ ## Adapter declaration
100
24
 
101
- ## Where to go next
25
+ Use `createProviderAdapterRegistry` to validate `ProviderAdapter` declarations and `adapterConformanceFindings` to report incomplete bindings. `BoundaryAdapter` dispatches immutable `BoundaryInstruction` values and returns explicit `BoundaryObservation` values. HTTP success never confirms settlement.
102
26
 
103
- - **[docs/authoring-guide.md](docs/authoring-guide.md)** -- the whole job, field
104
- by field, with the rule that enforces each one.
105
- - **[examples/meridian-bank](examples/meridian-bank)** -- a complete certified
106
- adapter for a bank that does not exist, with fixtures and its own tests.
107
- Copy it.
108
- - **[conformance/cases.json](conformance/cases.json)** -- every rule as data:
109
- one broken fact per case, and what each gate says about it.
110
- - **[spec/manifest.schema.json](spec/manifest.schema.json)** -- JSON Schema
111
- 2020-12 for one declaration, for authors who are not writing TypeScript.
27
+ The [generic fixture](src/boundary-fixture.ts) has no network, clock or account policy. Check it from this package:
112
28
 
113
- ## Running conformance
114
-
115
- ```bash
116
- bun run conformance -- ./examples/meridian-bank
117
- ```
118
-
119
- ```
120
- ok meridian_bank:payout_execution
121
- ok meridian_bank:bank_credit
122
- 2 adapter(s) checked, 0 finding(s) reported
29
+ ```sh
30
+ bun run conformance -- ./src/boundary-fixture.ts
123
31
  ```
124
32
 
125
- Exit 1 when anything reports, so it drops straight into CI.
33
+ ## Documentation
126
34
 
127
- ## Development
128
-
129
- ```bash
130
- bun install
131
- bun run check # spec drift, tests, types
132
- bun run build
133
- ```
35
+ - [Authoring guide](docs/authoring-guide.md)
36
+ - [Conformance test cases](conformance/cases.json)
37
+ - [Subject adapter fixture](conformance/subject-adapter.ts)
38
+ - [Manifest JSON schema](spec/manifest.schema.json)
39
+ - [Contributing](CONTRIBUTING.md)
134
40
 
135
41
  ## Versioning
136
42
 
137
- Semantic versioning from 1.0.0. Until then, alpha releases may change the
138
- surface on a minor version. Two promises hold now:
139
-
140
- - conformance codes are append-only: a released code is never renamed or
141
- removed, so `switch` statements stay exhaustive;
142
- - removing a value from a vocabulary in `src/vocabulary.ts` is a breaking
143
- change and appears in [CHANGELOG.md](CHANGELOG.md).
43
+ Semantic versioning from 1.0.0. Until then, prereleases may change the surface on a minor version. Removing a value from a vocabulary in `src/vocabulary.ts` is a breaking change documented in [CHANGELOG.md](CHANGELOG.md).
144
44
 
145
- ## Contributing
45
+ ## License and security
146
46
 
147
- Issues only. Hyperscale makes the changes to the format and the package; you
148
- propose them in an issue carrying the provider that needs the seam and the
149
- conformance case it would add. [CONTRIBUTING.md](CONTRIBUTING.md) has that
150
- model in full, plus the loop: what earns a new field, how to regenerate the
151
- schema, and the CLA behind a rare accepted pull request. Participation is under
152
- the [Code of Conduct](CODE_OF_CONDUCT.md).
47
+ ADL is licensed under the Hyperscale Intellectual Property and Copyright License, Tier 2 (Source Available), with a commercial license available from Hyperscale LLC. It is not open source. See [LICENSE.md](LICENSE.md) and [NOTICE.md](NOTICE.md).
153
48
 
154
- Vulnerabilities go through GitHub private reporting, never a public issue. See
155
- [SECURITY.md](SECURITY.md).
49
+ Vulnerability reports go through private disclosure as described in [SECURITY.md](SECURITY.md).
156
50
 
157
- ## License
51
+ ---
158
52
 
159
- AGPL-3.0-only, with a commercial license available from Hyperscale LLC for
160
- organisations that cannot accept the AGPL. See [LICENSE](LICENSE) for the text
161
- and [LICENSING.md](LICENSING.md) for which one you want and how to ask for the
162
- commercial one. Neither covers the Hyperscale marks;
163
- [TRADEMARKS.md](TRADEMARKS.md) says what that means and carries the rule for
164
- claiming conformance.
53
+ Hyperscale™ is a trademark of Hyperscale LLC. Code licenses do not grant rights to the name or marks.