@hyperscale0/adl 1.0.0-beta.8 → 1.0.123

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 (20) hide show
  1. package/CHANGELOG.md +5 -92
  2. package/README.md +2 -3
  3. package/SECURITY.md +0 -4
  4. package/conformance/cases.json +6 -12
  5. package/conformance/subject-adapter.ts +0 -5
  6. package/dist/boundary-fixture.d.ts +1 -4
  7. package/dist/boundary-fixture.d.ts.map +1 -1
  8. package/dist/boundary-fixture.js +1 -4
  9. package/dist/boundary-fixture.js.map +1 -1
  10. package/dist/index.d.ts +2 -43
  11. package/dist/index.d.ts.map +1 -1
  12. package/dist/index.js +0 -31
  13. package/dist/index.js.map +1 -1
  14. package/dist/vocabulary.d.ts +3 -34
  15. package/dist/vocabulary.d.ts.map +1 -1
  16. package/dist/vocabulary.js +1 -52
  17. package/dist/vocabulary.js.map +1 -1
  18. package/docs/authoring-guide.md +4 -8
  19. package/package.json +5 -9
  20. package/spec/manifest.schema.json +0 -914
package/spec/manifest.schema.json DELETED
@@ -1,914 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://raw.githubusercontent.com/hyperscale0/hyperscale-adl/main/spec/manifest.schema.json",
4
- "title": "Hyperscale provider adapter manifest",
5
- "description": "One provider adapter declaration. Generated from src/vocabulary.ts by scripts/emit-spec.ts; edit that, never this file.",
6
- "type": "object",
7
- "additionalProperties": false,
8
- "required": [
9
- "bindings",
10
- "capability",
11
- "config",
12
- "egress",
13
- "operationMap",
14
- "provider",
15
- "webhookMap"
16
- ],
17
- "properties": {
18
- "provider": {
19
- "type": "string",
20
- "pattern": "^[a-z][a-z0-9_.-]{0,79}$"
21
- },
22
- "capability": {
23
- "type": "string",
24
- "pattern": "\\S"
25
- },
26
- "domain": {
27
- "type": "string",
28
- "pattern": "\\S"
29
- },
30
- "egress": {
31
- "type": "string",
32
- "enum": [
33
- "none",
34
- "rest",
35
- "sync_clearance"
36
- ]
37
- },
38
- "bindings": {
39
- "type": "object",
40
- "additionalProperties": {
41
- "type": "string",
42
- "enum": [
43
- "strict",
44
- "claim",
45
- "confirmation_only",
46
- "evidence_only"
47
- ]
48
- }
49
- },
50
- "config": {
51
- "type": "object",
52
- "additionalProperties": false,
53
- "properties": {
54
- "baseUrl": {
55
- "type": "string",
56
- "pattern": "^https?://"
57
- },
58
- "credentialRef": {
59
- "oneOf": [
60
- {
61
- "type": "object",
62
- "additionalProperties": false,
63
- "required": [
64
- "name",
65
- "source"
66
- ],
67
- "properties": {
68
- "name": {
69
- "type": "string",
70
- "pattern": "\\S"
71
- },
72
- "source": {
73
- "const": "environment"
74
- }
75
- }
76
- },
77
- {
78
- "type": "object",
79
- "additionalProperties": false,
80
- "required": [
81
- "account",
82
- "service",
83
- "source"
84
- ],
85
- "properties": {
86
- "account": {
87
- "type": "string",
88
- "pattern": "\\S"
89
- },
90
- "service": {
91
- "type": "string",
92
- "pattern": "\\S"
93
- },
94
- "source": {
95
- "const": "keychain"
96
- }
97
- }
98
- }
99
- ]
100
- }
101
- }
102
- },
103
- "operationMap": {
104
- "type": "object",
105
- "additionalProperties": {
106
- "$ref": "#/$defs/operationBinding"
107
- }
108
- },
109
- "webhookMap": {
110
- "type": "object",
111
- "additionalProperties": {
112
- "$ref": "#/$defs/webhookTransitionPlan"
113
- }
114
- }
115
- },
116
- "$defs": {
117
- "objectField": {
118
- "oneOf": [
119
- {
120
- "type": "object",
121
- "properties": {
122
- "name": {
123
- "type": "string",
124
- "maxLength": 80,
125
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
126
- },
127
- "optional": {
128
- "type": "boolean",
129
- "const": true
130
- },
131
- "description": {
132
- "type": "string",
133
- "minLength": 1,
134
- "maxLength": 2048
135
- },
136
- "sensitive": {
137
- "type": "boolean",
138
- "const": true
139
- },
140
- "type": {
141
- "type": "string",
142
- "const": "money"
143
- },
144
- "value": {
145
- "type": "string",
146
- "pattern": "^(0|[1-9][0-9]{0,17})$"
147
- },
148
- "minimum": {
149
- "type": "string",
150
- "pattern": "^(0|[1-9][0-9]{0,17})$"
151
- },
152
- "maximum": {
153
- "type": "string",
154
- "pattern": "^(0|[1-9][0-9]{0,17})$"
155
- }
156
- },
157
- "required": [
158
- "name",
159
- "type"
160
- ],
161
- "additionalProperties": false
162
- },
163
- {
164
- "type": "object",
165
- "properties": {
166
- "name": {
167
- "type": "string",
168
- "maxLength": 80,
169
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
170
- },
171
- "optional": {
172
- "type": "boolean",
173
- "const": true
174
- },
175
- "description": {
176
- "type": "string",
177
- "minLength": 1,
178
- "maxLength": 2048
179
- },
180
- "sensitive": {
181
- "type": "boolean",
182
- "const": true
183
- },
184
- "type": {
185
- "type": "string",
186
- "const": "ref"
187
- },
188
- "targetKind": {
189
- "type": "string",
190
- "enum": [
191
- "instrument",
192
- "object"
193
- ]
194
- },
195
- "targetFamily": {
196
- "type": "object",
197
- "properties": {
198
- "module": {
199
- "type": "string",
200
- "maxLength": 80,
201
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
202
- },
203
- "exportPath": {
204
- "type": "string",
205
- "maxLength": 240,
206
- "pattern": "^[a-z][a-zA-Z0-9_]*(?:\\.[a-z][a-zA-Z0-9_]*)*$"
207
- },
208
- "revision": {
209
- "type": "integer",
210
- "exclusiveMinimum": 0,
211
- "maximum": 9007199254740991
212
- }
213
- },
214
- "required": [
215
- "module",
216
- "exportPath",
217
- "revision"
218
- ],
219
- "additionalProperties": false
220
- },
221
- "target": {
222
- "anyOf": [
223
- {
224
- "type": "string",
225
- "maxLength": 80,
226
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
227
- },
228
- {
229
- "minItems": 1,
230
- "maxItems": 16,
231
- "type": "array",
232
- "items": {
233
- "type": "string",
234
- "maxLength": 80,
235
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
236
- }
237
- }
238
- ]
239
- }
240
- },
241
- "required": [
242
- "name",
243
- "type",
244
- "targetKind",
245
- "target"
246
- ],
247
- "additionalProperties": false
248
- },
249
- {
250
- "type": "object",
251
- "properties": {
252
- "name": {
253
- "type": "string",
254
- "maxLength": 80,
255
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
256
- },
257
- "optional": {
258
- "type": "boolean",
259
- "const": true
260
- },
261
- "description": {
262
- "type": "string",
263
- "minLength": 1,
264
- "maxLength": 2048
265
- },
266
- "sensitive": {
267
- "type": "boolean",
268
- "const": true
269
- },
270
- "type": {
271
- "type": "string",
272
- "const": "date"
273
- },
274
- "value": {
275
- "type": "string",
276
- "format": "date-time",
277
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
278
- }
279
- },
280
- "required": [
281
- "name",
282
- "type"
283
- ],
284
- "additionalProperties": false
285
- },
286
- {
287
- "type": "object",
288
- "properties": {
289
- "name": {
290
- "type": "string",
291
- "maxLength": 80,
292
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
293
- },
294
- "optional": {
295
- "type": "boolean",
296
- "const": true
297
- },
298
- "description": {
299
- "type": "string",
300
- "minLength": 1,
301
- "maxLength": 2048
302
- },
303
- "sensitive": {
304
- "type": "boolean",
305
- "const": true
306
- },
307
- "type": {
308
- "type": "string",
309
- "const": "duration"
310
- },
311
- "value": {
312
- "type": "integer",
313
- "exclusiveMinimum": 0,
314
- "maximum": 9007199254740991
315
- }
316
- },
317
- "required": [
318
- "name",
319
- "type"
320
- ],
321
- "additionalProperties": false
322
- },
323
- {
324
- "type": "object",
325
- "properties": {
326
- "name": {
327
- "type": "string",
328
- "maxLength": 80,
329
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
330
- },
331
- "optional": {
332
- "type": "boolean",
333
- "const": true
334
- },
335
- "description": {
336
- "type": "string",
337
- "minLength": 1,
338
- "maxLength": 2048
339
- },
340
- "sensitive": {
341
- "type": "boolean",
342
- "const": true
343
- },
344
- "type": {
345
- "type": "string",
346
- "const": "text"
347
- },
348
- "value": {
349
- "type": "string",
350
- "minLength": 1,
351
- "maxLength": 2048
352
- },
353
- "minLength": {
354
- "type": "integer",
355
- "exclusiveMinimum": 0,
356
- "maximum": 2048
357
- },
358
- "maxLength": {
359
- "type": "integer",
360
- "exclusiveMinimum": 0,
361
- "maximum": 2048
362
- },
363
- "pattern": {
364
- "type": "string",
365
- "pattern": "^\\^\\[[A-Za-z0-9-]+\\]\\{[1-9][0-9]{0,3}\\}\\$$"
366
- }
367
- },
368
- "required": [
369
- "name",
370
- "type"
371
- ],
372
- "additionalProperties": false
373
- },
374
- {
375
- "type": "object",
376
- "properties": {
377
- "name": {
378
- "type": "string",
379
- "maxLength": 80,
380
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
381
- },
382
- "optional": {
383
- "type": "boolean",
384
- "const": true
385
- },
386
- "description": {
387
- "type": "string",
388
- "minLength": 1,
389
- "maxLength": 2048
390
- },
391
- "sensitive": {
392
- "type": "boolean",
393
- "const": true
394
- },
395
- "type": {
396
- "type": "string",
397
- "const": "integer"
398
- },
399
- "value": {
400
- "type": "integer",
401
- "minimum": -9007199254740991,
402
- "maximum": 9007199254740991
403
- },
404
- "minimum": {
405
- "type": "integer",
406
- "minimum": -9007199254740991,
407
- "maximum": 9007199254740991
408
- },
409
- "maximum": {
410
- "type": "integer",
411
- "minimum": -9007199254740991,
412
- "maximum": 9007199254740991
413
- }
414
- },
415
- "required": [
416
- "name",
417
- "type"
418
- ],
419
- "additionalProperties": false
420
- },
421
- {
422
- "type": "object",
423
- "properties": {
424
- "name": {
425
- "type": "string",
426
- "maxLength": 80,
427
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
428
- },
429
- "optional": {
430
- "type": "boolean",
431
- "const": true
432
- },
433
- "description": {
434
- "type": "string",
435
- "minLength": 1,
436
- "maxLength": 2048
437
- },
438
- "sensitive": {
439
- "type": "boolean",
440
- "const": true
441
- },
442
- "type": {
443
- "type": "string",
444
- "const": "percent"
445
- },
446
- "value": {
447
- "type": "integer",
448
- "minimum": 0,
449
- "maximum": 10000
450
- }
451
- },
452
- "required": [
453
- "name",
454
- "type"
455
- ],
456
- "additionalProperties": false
457
- },
458
- {
459
- "type": "object",
460
- "properties": {
461
- "name": {
462
- "type": "string",
463
- "maxLength": 80,
464
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
465
- },
466
- "optional": {
467
- "type": "boolean",
468
- "const": true
469
- },
470
- "description": {
471
- "type": "string",
472
- "minLength": 1,
473
- "maxLength": 2048
474
- },
475
- "sensitive": {
476
- "type": "boolean",
477
- "const": true
478
- },
479
- "type": {
480
- "type": "string",
481
- "const": "boolean"
482
- },
483
- "value": {
484
- "type": "boolean"
485
- }
486
- },
487
- "required": [
488
- "name",
489
- "type"
490
- ],
491
- "additionalProperties": false
492
- },
493
- {
494
- "type": "object",
495
- "properties": {
496
- "name": {
497
- "type": "string",
498
- "maxLength": 80,
499
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
500
- },
501
- "optional": {
502
- "type": "boolean",
503
- "const": true
504
- },
505
- "description": {
506
- "type": "string",
507
- "minLength": 1,
508
- "maxLength": 2048
509
- },
510
- "sensitive": {
511
- "type": "boolean",
512
- "const": true
513
- },
514
- "type": {
515
- "type": "string",
516
- "const": "enum"
517
- },
518
- "values": {
519
- "minItems": 1,
520
- "maxItems": 64,
521
- "type": "array",
522
- "items": {
523
- "type": "string",
524
- "maxLength": 80,
525
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
526
- }
527
- },
528
- "value": {
529
- "type": "string",
530
- "maxLength": 80,
531
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
532
- }
533
- },
534
- "required": [
535
- "name",
536
- "type",
537
- "values"
538
- ],
539
- "additionalProperties": false
540
- },
541
- {
542
- "type": "object",
543
- "properties": {
544
- "name": {
545
- "type": "string",
546
- "maxLength": 80,
547
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
548
- },
549
- "optional": {
550
- "type": "boolean",
551
- "const": true
552
- },
553
- "description": {
554
- "type": "string",
555
- "minLength": 1,
556
- "maxLength": 2048
557
- },
558
- "sensitive": {
559
- "type": "boolean",
560
- "const": true
561
- },
562
- "type": {
563
- "type": "string",
564
- "const": "list"
565
- },
566
- "item": {
567
- "type": "string",
568
- "enum": [
569
- "money",
570
- "date",
571
- "text",
572
- "integer",
573
- "ref"
574
- ]
575
- },
576
- "targetKind": {
577
- "type": "string",
578
- "enum": [
579
- "instrument",
580
- "object"
581
- ]
582
- },
583
- "targetFamily": {
584
- "type": "object",
585
- "properties": {
586
- "module": {
587
- "type": "string",
588
- "maxLength": 80,
589
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
590
- },
591
- "exportPath": {
592
- "type": "string",
593
- "maxLength": 240,
594
- "pattern": "^[a-z][a-zA-Z0-9_]*(?:\\.[a-z][a-zA-Z0-9_]*)*$"
595
- },
596
- "revision": {
597
- "type": "integer",
598
- "exclusiveMinimum": 0,
599
- "maximum": 9007199254740991
600
- }
601
- },
602
- "required": [
603
- "module",
604
- "exportPath",
605
- "revision"
606
- ],
607
- "additionalProperties": false
608
- },
609
- "target": {
610
- "type": "string",
611
- "maxLength": 80,
612
- "pattern": "^[a-z][a-zA-Z0-9_]*$"
613
- },
614
- "maxItems": {
615
- "type": "integer",
616
- "minimum": 1,
617
- "maximum": 366
618
- }
619
- },
620
- "required": [
621
- "name",
622
- "type",
623
- "item",
624
- "maxItems"
625
- ],
626
- "additionalProperties": false
627
- }
628
- ]
629
- },
630
- "BoundaryInstruction": {
631
- "$schema": "https://json-schema.org/draft/2020-12/schema",
632
- "readOnly": true,
633
- "type": "object",
634
- "properties": {
635
- "id": {
636
- "type": "string",
637
- "minLength": 1,
638
- "maxLength": 240
639
- },
640
- "environment": {
641
- "type": "string",
642
- "enum": [
643
- "sandbox",
644
- "live"
645
- ]
646
- },
647
- "tenantId": {
648
- "type": "string",
649
- "minLength": 1,
650
- "maxLength": 240
651
- },
652
- "productId": {
653
- "type": "string",
654
- "minLength": 1,
655
- "maxLength": 240
656
- },
657
- "productBuildId": {
658
- "type": "string",
659
- "minLength": 1,
660
- "maxLength": 240
661
- },
662
- "buildDigest": {
663
- "type": "string",
664
- "minLength": 1,
665
- "maxLength": 240
666
- },
667
- "target": {
668
- "readOnly": true,
669
- "type": "object",
670
- "properties": {
671
- "kind": {
672
- "type": "string",
673
- "minLength": 1,
674
- "maxLength": 240
675
- },
676
- "attachment": {
677
- "type": "string",
678
- "minLength": 1,
679
- "maxLength": 240
680
- },
681
- "instanceId": {
682
- "type": "string",
683
- "minLength": 1,
684
- "maxLength": 240
685
- }
686
- },
687
- "required": [
688
- "kind",
689
- "attachment",
690
- "instanceId"
691
- ],
692
- "additionalProperties": false
693
- },
694
- "sourceAccountId": {
695
- "type": "string",
696
- "minLength": 1,
697
- "maxLength": 240
698
- },
699
- "destinationAccountId": {
700
- "type": "string",
701
- "minLength": 1,
702
- "maxLength": 240
703
- },
704
- "amount": {
705
- "type": "string",
706
- "pattern": "^[1-9][0-9]{0,17}$"
707
- },
708
- "currency": {
709
- "type": "string",
710
- "pattern": "^[A-Z]{3}$"
711
- },
712
- "adapter": {
713
- "type": "string",
714
- "pattern": "^[a-z][a-z0-9_.-]{0,79}$"
715
- }
716
- },
717
- "required": [
718
- "id",
719
- "environment",
720
- "tenantId",
721
- "productId",
722
- "productBuildId",
723
- "buildDigest",
724
- "target",
725
- "sourceAccountId",
726
- "destinationAccountId",
727
- "amount",
728
- "currency",
729
- "adapter"
730
- ],
731
- "additionalProperties": false
732
- },
733
- "BoundaryObservation": {
734
- "$schema": "https://json-schema.org/draft/2020-12/schema",
735
- "readOnly": true,
736
- "type": "object",
737
- "properties": {
738
- "adapter": {
739
- "type": "string",
740
- "pattern": "^[a-z][a-z0-9_.-]{0,79}$"
741
- },
742
- "externalReference": {
743
- "type": "string",
744
- "minLength": 1,
745
- "maxLength": 240
746
- },
747
- "instructionId": {
748
- "type": "string",
749
- "minLength": 1,
750
- "maxLength": 240
751
- },
752
- "outcome": {
753
- "type": "string",
754
- "enum": [
755
- "acknowledged",
756
- "unknown",
757
- "confirmed",
758
- "rejected"
759
- ]
760
- },
761
- "observedAt": {
762
- "type": "string",
763
- "format": "date-time",
764
- "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
765
- }
766
- },
767
- "required": [
768
- "adapter",
769
- "externalReference",
770
- "instructionId",
771
- "outcome",
772
- "observedAt"
773
- ],
774
- "additionalProperties": false
775
- },
776
- "operationBinding": {
777
- "type": "object",
778
- "additionalProperties": false,
779
- "required": [
780
- "direction",
781
- "obligationKind",
782
- "operation",
783
- "resourceIdPath",
784
- "resourceKind"
785
- ],
786
- "properties": {
787
- "operation": {
788
- "type": "string",
789
- "pattern": "\\S"
790
- },
791
- "direction": {
792
- "type": "string",
793
- "enum": [
794
- "tenant_initiated",
795
- "system_settlement"
796
- ]
797
- },
798
- "envelope": {
799
- "type": "string",
800
- "enum": [
801
- "http_200_body_status",
802
- "http_status_error_body",
803
- "unconfirmed_until_live"
804
- ]
805
- },
806
- "meter": {
807
- "type": "string",
808
- "pattern": "\\S"
809
- },
810
- "obligationKind": {
811
- "type": "string",
812
- "pattern": "\\S"
813
- },
814
- "resourceIdPath": {
815
- "type": "string",
816
- "pattern": "\\S"
817
- },
818
- "resourceKind": {
819
- "type": "string",
820
- "pattern": "\\S"
821
- },
822
- "subjectRequirements": {
823
- "type": "array",
824
- "maxItems": 128,
825
- "items": {
826
- "allOf": [
827
- {
828
- "$ref": "#/$defs/objectField"
829
- },
830
- {
831
- "not": {
832
- "required": [
833
- "optional"
834
- ]
835
- }
836
- }
837
- ]
838
- }
839
- }
840
- }
841
- },
842
- "webhookTransitionPlan": {
843
- "type": "object",
844
- "additionalProperties": false,
845
- "required": [
846
- "eventKind",
847
- "operationName",
848
- "optionalPayloadFields",
849
- "requiredFieldGroups",
850
- "requiredPayloadFields",
851
- "resourceIdField",
852
- "resourceKind",
853
- "timestampField"
854
- ],
855
- "properties": {
856
- "eventKind": {
857
- "type": "string",
858
- "pattern": "\\S"
859
- },
860
- "operationName": {
861
- "type": "string",
862
- "pattern": "\\S"
863
- },
864
- "optionalPayloadFields": {
865
- "type": "array",
866
- "items": {
867
- "type": "string",
868
- "pattern": "\\S"
869
- }
870
- },
871
- "requiredFieldGroups": {
872
- "type": "array",
873
- "items": {
874
- "type": "array",
875
- "items": {
876
- "type": "string",
877
- "pattern": "\\S"
878
- }
879
- }
880
- },
881
- "requiredPayloadFields": {
882
- "type": "array",
883
- "items": {
884
- "type": "string",
885
- "pattern": "\\S"
886
- }
887
- },
888
- "resourceIdField": {
889
- "type": "string",
890
- "pattern": "\\S"
891
- },
892
- "resourceKind": {
893
- "type": "string",
894
- "pattern": "\\S"
895
- },
896
- "timestampField": {
897
- "type": "string",
898
- "enum": [
899
- "activeAt",
900
- "completedAt",
901
- "failedAt",
902
- "returnedAt",
903
- "receivedAt",
904
- "clearedAt",
905
- "expiredAt",
906
- "voidedAt",
907
- "postedAt",
908
- "refundedAt"
909
- ]
910
- }
911
- }
912
- }
913
- }
914
- }