@toolproof-npm/schema 0.1.67 → 0.1.69

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 (12) hide show
  1. package/README.md +59 -59
  2. package/dist/genesis/generated/dependencies_ordered.json +5 -1
  3. package/dist/genesis/generated/resourceTypes/Genesis.json +89 -5
  4. package/dist/genesis/generated/resources/Genesis.json +109 -5
  5. package/dist/genesis/generated/schemas/Genesis.json +73 -2
  6. package/dist/genesis/generated/schemas/Job.json +38 -1
  7. package/dist/genesis/generated/schemas/StatefulStrategy.json +2 -0
  8. package/dist/genesis/generated/schemas/StrategyRun.json +202 -187
  9. package/dist/genesis/generated/terminals.json +1 -0
  10. package/dist/genesis/generated/types/ResourceTypeGenesis.d.ts +2 -0
  11. package/dist/genesis/generated/types/types.d.ts +39 -7
  12. package/package.json +59 -59
package/dist/genesis/generated/schemas/StrategyRun.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "allOf": [
5
5
  {
6
6
  "$comment": "The Engine will convert the statelessStrategy.steps array of the referenced StatefulStrategy into this map before the run. This is to allow jobs that do not depend on previous-step inputs to run in parallel.The Engine will also inject internal steps to prompt for runtime-provided inputs and handle other orchestration tasks such as repeted steps when encountering a loop.",
7
- "$ref": "#/$defs/StrategyThreadMap"
7
+ "$ref": "#/$defs/StrategyThreadMapWrapper"
8
8
  },
9
9
  {
10
10
  "$comment": "Reusing StrategyStateWrapper to include the strategy state in the StrategyRun. The Engine will update it with materialized Resources (i.e. runtime-provided inputs and job-created outputs) during the run.",
@@ -30,20 +30,19 @@
30
30
  "unevaluatedProperties": false,
31
31
  "$anchor": "StrategyRun",
32
32
  "$defs": {
33
- "StrategyThreadMap": {
33
+ "StrategyThreadMapWrapper": {
34
34
  "$schema": "https://json-schema.org/draft/2020-12/schema",
35
35
  "type": "object",
36
- "additionalProperties": {
37
- "type": "array",
38
- "items": {
39
- "$ref": "#/$defs/Step"
36
+ "properties": {
37
+ "strategyThreadMap": {
38
+ "$ref": "#/$defs/StrategyThreadMap"
40
39
  }
41
40
  },
42
- "$anchor": "StrategyThreadMap",
43
- "$comment": "Each thread contains an array of steps, allowing for sequential execution within a thread while supporting parallel execution across multiple threads.",
44
- "propertyNames": {
45
- "$ref": "#/$defs/StrategyThreadIdentity"
46
- }
41
+ "required": [
42
+ "strategyThreadMap"
43
+ ],
44
+ "unevaluatedProperties": false,
45
+ "$anchor": "StrategyThreadMapWrapper"
47
46
  },
48
47
  "StrategyStateWrapper": {
49
48
  "$schema": "https://json-schema.org/draft/2020-12/schema",
@@ -56,6 +55,7 @@
56
55
  "required": [
57
56
  "strategyState"
58
57
  ],
58
+ "unevaluatedProperties": false,
59
59
  "$anchor": "StrategyStateWrapper"
60
60
  },
61
61
  "StrategyRunIdentity": {
@@ -90,31 +90,20 @@
90
90
  "unevaluatedProperties": false,
91
91
  "$anchor": "StrategyRunContext"
92
92
  },
93
- "Step": {
93
+ "StrategyThreadMap": {
94
94
  "$schema": "https://json-schema.org/draft/2020-12/schema",
95
95
  "type": "object",
96
- "oneOf": [
97
- {
98
- "$ref": "#/$defs/WorkStep"
99
- },
100
- {
101
- "$ref": "#/$defs/BranchStep"
102
- },
103
- {
104
- "$ref": "#/$defs/WhileStep"
105
- },
106
- {
107
- "$ref": "#/$defs/ForStep"
96
+ "additionalProperties": {
97
+ "type": "array",
98
+ "items": {
99
+ "$ref": "#/$defs/Step"
108
100
  }
109
- ],
110
- "unevaluatedProperties": false,
111
- "$anchor": "Step"
112
- },
113
- "StrategyThreadIdentity": {
114
- "$schema": "https://json-schema.org/draft/2020-12/schema",
115
- "type": "string",
116
- "$anchor": "StrategyThreadIdentity",
117
- "pattern": "^STRATEGY_THREAD-.+$"
101
+ },
102
+ "$anchor": "StrategyThreadMap",
103
+ "$comment": "Each thread contains an array of steps, allowing for sequential execution within a thread while supporting parallel execution across multiple threads.",
104
+ "propertyNames": {
105
+ "$ref": "#/$defs/StrategyThreadIdentity"
106
+ }
118
107
  },
119
108
  "StrategyState": {
120
109
  "$schema": "https://json-schema.org/draft/2020-12/schema",
@@ -172,114 +161,31 @@
172
161
  "cancelled"
173
162
  ]
174
163
  },
175
- "WorkStep": {
164
+ "Step": {
176
165
  "$schema": "https://json-schema.org/draft/2020-12/schema",
177
166
  "type": "object",
178
- "allOf": [
167
+ "oneOf": [
179
168
  {
180
- "$ref": "#/$defs/StepKind"
181
- }
182
- ],
183
- "properties": {
184
- "execution": {
185
- "$ref": "#/$defs/Execution"
186
- },
187
- "identity": {
188
- "$ref": "#/$defs/WorkStepIdentity"
169
+ "$ref": "#/$defs/WorkStep"
189
170
  },
190
- "kind": {
191
- "const": "work"
192
- }
193
- },
194
- "required": [
195
- "identity",
196
- "kind",
197
- "execution"
198
- ],
199
- "$anchor": "WorkStep"
200
- },
201
- "BranchStep": {
202
- "$schema": "https://json-schema.org/draft/2020-12/schema",
203
- "type": "object",
204
- "allOf": [
205
171
  {
206
- "$ref": "#/$defs/StepKind"
207
- }
208
- ],
209
- "properties": {
210
- "cases": {
211
- "type": "array",
212
- "items": {
213
- "$ref": "#/$defs/Conditional"
214
- },
215
- "minItems": 1,
216
- "uniqueItems": true
217
- },
218
- "identity": {
219
- "$ref": "#/$defs/BranchStepIdentity"
172
+ "$ref": "#/$defs/BranchStep"
220
173
  },
221
- "kind": {
222
- "const": "branch"
223
- }
224
- },
225
- "required": [
226
- "identity",
227
- "kind",
228
- "cases"
229
- ],
230
- "$anchor": "BranchStep"
231
- },
232
- "WhileStep": {
233
- "$schema": "https://json-schema.org/draft/2020-12/schema",
234
- "type": "object",
235
- "allOf": [
236
174
  {
237
- "$ref": "#/$defs/StepKind"
238
- }
239
- ],
240
- "properties": {
241
- "case": {
242
- "$ref": "#/$defs/Conditional"
243
- },
244
- "identity": {
245
- "$ref": "#/$defs/WhileStepIdentity"
175
+ "$ref": "#/$defs/WhileStep"
246
176
  },
247
- "kind": {
248
- "const": "while"
177
+ {
178
+ "$ref": "#/$defs/ForStep"
249
179
  }
250
- },
251
- "required": [
252
- "identity",
253
- "kind",
254
- "case"
255
180
  ],
256
- "$anchor": "WhileStep"
181
+ "unevaluatedProperties": false,
182
+ "$anchor": "Step"
257
183
  },
258
- "ForStep": {
184
+ "StrategyThreadIdentity": {
259
185
  "$schema": "https://json-schema.org/draft/2020-12/schema",
260
- "type": "object",
261
- "allOf": [
262
- {
263
- "$ref": "#/$defs/StepKind"
264
- }
265
- ],
266
- "properties": {
267
- "case": {
268
- "$ref": "#/$defs/Conditional"
269
- },
270
- "identity": {
271
- "$ref": "#/$defs/ForStepIdentity"
272
- },
273
- "kind": {
274
- "const": "for"
275
- }
276
- },
277
- "required": [
278
- "identity",
279
- "kind",
280
- "case"
281
- ],
282
- "$anchor": "ForStep"
186
+ "type": "string",
187
+ "$anchor": "StrategyThreadIdentity",
188
+ "pattern": "^STRATEGY_THREAD-.+$"
283
189
  },
284
190
  "ResourceMissing": {
285
191
  "$schema": "https://json-schema.org/draft/2020-12/schema",
@@ -396,89 +302,114 @@
396
302
  "$anchor": "ExecutionIdentity",
397
303
  "pattern": "^EXECUTION-.+$"
398
304
  },
399
- "StepKind": {
305
+ "WorkStep": {
400
306
  "$schema": "https://json-schema.org/draft/2020-12/schema",
401
307
  "type": "object",
308
+ "allOf": [
309
+ {
310
+ "$ref": "#/$defs/StepKind"
311
+ }
312
+ ],
402
313
  "properties": {
314
+ "execution": {
315
+ "$ref": "#/$defs/Execution"
316
+ },
317
+ "identity": {
318
+ "$ref": "#/$defs/WorkStepIdentity"
319
+ },
403
320
  "kind": {
404
- "type": "string",
405
- "enum": [
406
- "work",
407
- "branch",
408
- "while",
409
- "for"
410
- ]
321
+ "const": "work"
411
322
  }
412
323
  },
413
324
  "required": [
414
- "kind"
325
+ "identity",
326
+ "kind",
327
+ "execution"
415
328
  ],
416
- "$anchor": "StepKind"
329
+ "$anchor": "WorkStep"
417
330
  },
418
- "Execution": {
331
+ "BranchStep": {
419
332
  "$schema": "https://json-schema.org/draft/2020-12/schema",
420
333
  "type": "object",
421
334
  "allOf": [
422
335
  {
423
- "$comment": "This will be overlayed at runtime to specify roleBindings corresponding to the roles of the underlying job.",
424
- "$ref": "#/$defs/RoleBindingsWrapper"
336
+ "$ref": "#/$defs/StepKind"
425
337
  }
426
338
  ],
427
339
  "properties": {
340
+ "cases": {
341
+ "type": "array",
342
+ "items": {
343
+ "$ref": "#/$defs/Conditional"
344
+ },
345
+ "minItems": 1,
346
+ "uniqueItems": true
347
+ },
428
348
  "identity": {
429
- "$ref": "#/$defs/ExecutionIdentity"
349
+ "$ref": "#/$defs/BranchStepIdentity"
430
350
  },
431
- "jobRef": {
432
- "$ref": "#/$defs/JobIdentity"
351
+ "kind": {
352
+ "const": "branch"
433
353
  }
434
354
  },
435
355
  "required": [
436
356
  "identity",
437
- "jobRef"
357
+ "kind",
358
+ "cases"
438
359
  ],
439
- "$anchor": "Execution"
440
- },
441
- "WorkStepIdentity": {
442
- "$schema": "https://json-schema.org/draft/2020-12/schema",
443
- "type": "string",
444
- "$anchor": "WorkStepIdentity",
445
- "pattern": "^WORKSTEP-.+$"
360
+ "$anchor": "BranchStep"
446
361
  },
447
- "Conditional": {
362
+ "WhileStep": {
448
363
  "$schema": "https://json-schema.org/draft/2020-12/schema",
449
364
  "type": "object",
365
+ "allOf": [
366
+ {
367
+ "$ref": "#/$defs/StepKind"
368
+ }
369
+ ],
450
370
  "properties": {
451
- "what": {
452
- "$ref": "#/$defs/WorkStep"
371
+ "case": {
372
+ "$ref": "#/$defs/Conditional"
453
373
  },
454
- "when": {
455
- "$ref": "#/$defs/WorkStep"
374
+ "identity": {
375
+ "$ref": "#/$defs/WhileStepIdentity"
376
+ },
377
+ "kind": {
378
+ "const": "while"
456
379
  }
457
380
  },
458
381
  "required": [
459
- "when",
460
- "what"
382
+ "identity",
383
+ "kind",
384
+ "case"
461
385
  ],
462
- "unevaluatedProperties": false,
463
- "$anchor": "Conditional"
464
- },
465
- "BranchStepIdentity": {
466
- "$schema": "https://json-schema.org/draft/2020-12/schema",
467
- "type": "string",
468
- "$anchor": "BranchStepIdentity",
469
- "pattern": "^BRANCHSTEP-.+$"
470
- },
471
- "WhileStepIdentity": {
472
- "$schema": "https://json-schema.org/draft/2020-12/schema",
473
- "type": "string",
474
- "$anchor": "WhileStepIdentity",
475
- "pattern": "^WHILESTEP-.+$"
386
+ "$anchor": "WhileStep"
476
387
  },
477
- "ForStepIdentity": {
388
+ "ForStep": {
478
389
  "$schema": "https://json-schema.org/draft/2020-12/schema",
479
- "type": "string",
480
- "$anchor": "ForStepIdentity",
481
- "pattern": "^FORSTEP-.+$"
390
+ "type": "object",
391
+ "allOf": [
392
+ {
393
+ "$ref": "#/$defs/StepKind"
394
+ }
395
+ ],
396
+ "properties": {
397
+ "case": {
398
+ "$ref": "#/$defs/Conditional"
399
+ },
400
+ "identity": {
401
+ "$ref": "#/$defs/ForStepIdentity"
402
+ },
403
+ "kind": {
404
+ "const": "for"
405
+ }
406
+ },
407
+ "required": [
408
+ "identity",
409
+ "kind",
410
+ "case"
411
+ ],
412
+ "$anchor": "ForStep"
482
413
  },
483
414
  "ResourceBase": {
484
415
  "$schema": "https://json-schema.org/draft/2020-12/schema",
@@ -590,25 +521,89 @@
590
521
  ],
591
522
  "$anchor": "JsonData"
592
523
  },
593
- "RoleBindingsWrapper": {
524
+ "StepKind": {
594
525
  "$schema": "https://json-schema.org/draft/2020-12/schema",
595
526
  "type": "object",
596
527
  "properties": {
597
- "roleBindings": {
598
- "$ref": "#/$defs/RoleBindings"
528
+ "kind": {
529
+ "type": "string",
530
+ "enum": [
531
+ "work",
532
+ "branch",
533
+ "while",
534
+ "for"
535
+ ]
599
536
  }
600
537
  },
601
538
  "required": [
602
- "roleBindings"
539
+ "kind"
603
540
  ],
604
- "$anchor": "RoleBindingsWrapper"
541
+ "$anchor": "StepKind"
605
542
  },
606
- "JobIdentity": {
543
+ "Execution": {
544
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
545
+ "type": "object",
546
+ "allOf": [
547
+ {
548
+ "$comment": "This will be overlayed at runtime to specify roleBindings corresponding to the roles of the underlying job.",
549
+ "$ref": "#/$defs/RoleBindingsWrapper"
550
+ }
551
+ ],
552
+ "properties": {
553
+ "identity": {
554
+ "$ref": "#/$defs/ExecutionIdentity"
555
+ },
556
+ "jobRef": {
557
+ "$ref": "#/$defs/JobIdentity"
558
+ }
559
+ },
560
+ "required": [
561
+ "identity",
562
+ "jobRef"
563
+ ],
564
+ "$anchor": "Execution"
565
+ },
566
+ "WorkStepIdentity": {
607
567
  "$schema": "https://json-schema.org/draft/2020-12/schema",
608
568
  "type": "string",
609
- "$anchor": "JobIdentity",
610
- "$comment": "",
611
- "pattern": "^JOB-.+$"
569
+ "$anchor": "WorkStepIdentity",
570
+ "pattern": "^WORKSTEP-.+$"
571
+ },
572
+ "Conditional": {
573
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
574
+ "type": "object",
575
+ "properties": {
576
+ "what": {
577
+ "$ref": "#/$defs/WorkStep"
578
+ },
579
+ "when": {
580
+ "$ref": "#/$defs/WorkStep"
581
+ }
582
+ },
583
+ "required": [
584
+ "when",
585
+ "what"
586
+ ],
587
+ "unevaluatedProperties": false,
588
+ "$anchor": "Conditional"
589
+ },
590
+ "BranchStepIdentity": {
591
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
592
+ "type": "string",
593
+ "$anchor": "BranchStepIdentity",
594
+ "pattern": "^BRANCHSTEP-.+$"
595
+ },
596
+ "WhileStepIdentity": {
597
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
598
+ "type": "string",
599
+ "$anchor": "WhileStepIdentity",
600
+ "pattern": "^WHILESTEP-.+$"
601
+ },
602
+ "ForStepIdentity": {
603
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
604
+ "type": "string",
605
+ "$anchor": "ForStepIdentity",
606
+ "pattern": "^FORSTEP-.+$"
612
607
  },
613
608
  "ResourceIdentity": {
614
609
  "$schema": "https://json-schema.org/draft/2020-12/schema",
@@ -653,6 +648,26 @@
653
648
  ],
654
649
  "$anchor": "Path"
655
650
  },
651
+ "RoleBindingsWrapper": {
652
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
653
+ "type": "object",
654
+ "properties": {
655
+ "roleBindings": {
656
+ "$ref": "#/$defs/RoleBindings"
657
+ }
658
+ },
659
+ "required": [
660
+ "roleBindings"
661
+ ],
662
+ "$anchor": "RoleBindingsWrapper"
663
+ },
664
+ "JobIdentity": {
665
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
666
+ "type": "string",
667
+ "$anchor": "JobIdentity",
668
+ "$comment": "",
669
+ "pattern": "^JOB-.+$"
670
+ },
656
671
  "RoleBindings": {
657
672
  "$schema": "https://json-schema.org/draft/2020-12/schema",
658
673
  "type": "object",
package/dist/genesis/generated/terminals.json CHANGED
@@ -1,5 +1,6 @@
1
1
  [
2
2
  "ResourceType",
3
+ "Error",
3
4
  "ResourceFormat",
4
5
  "ResourceMeta",
5
6
  "Job",
package/dist/genesis/generated/types/ResourceTypeGenesis.d.ts CHANGED
@@ -9,6 +9,7 @@ export type ResourceTypeGenesis = {
9
9
  "CreationContextWrapper": ResourceType;
10
10
  "Described": ResourceType;
11
11
  "Documented": ResourceType;
12
+ "Error": ResourceType;
12
13
  "Execution": ResourceType;
13
14
  "ExecutionIdentity": ResourceType;
14
15
  "ExtractionSchema": ResourceType;
@@ -62,6 +63,7 @@ export type ResourceTypeGenesis = {
62
63
  "StrategyStateWrapper": ResourceType;
63
64
  "StrategyThreadIdentity": ResourceType;
64
65
  "StrategyThreadMap": ResourceType;
66
+ "StrategyThreadMapWrapper": ResourceType;
65
67
  "Timestamp": ResourceType;
66
68
  "WhileStep": ResourceType;
67
69
  "WhileStepIdentity": ResourceType;
package/dist/genesis/generated/types/types.d.ts CHANGED
@@ -74,6 +74,16 @@ export type ResourceRoleIdentity =
74
74
  */
75
75
  export type Documented =
76
76
  Named & Described;
77
+ /**
78
+ * This interface was referenced by `GenesisJson`'s JSON-Schema
79
+ * via the `definition` "Error".
80
+ */
81
+ export type Error =
82
+ {
83
+ } & Documented & {
84
+ details?: {
85
+ };
86
+ };
77
87
  /**
78
88
  * This interface was referenced by `GenesisJson`'s JSON-Schema
79
89
  * via the `definition` "ExtractionSchema".
@@ -344,7 +354,7 @@ export type StrategyRun =
344
354
  identity: StrategyRunIdentity;
345
355
  statefulStrategyRef: StatefulStrategyIdentity;
346
356
  strategyRunContext: StrategyRunContext;
347
- } & StrategyThreadMap &
357
+ } & StrategyThreadMapWrapper &
348
358
  StrategyStateWrapper1;
349
359
  /**
350
360
  * This interface was referenced by `GenesisJson`'s JSON-Schema
@@ -466,7 +476,13 @@ export interface RolesWrapper {
466
476
  */
467
477
  export interface Roles {
468
478
  inputMap: RoleMap;
469
- outputMap: RoleMap;
479
+ outputMap: RoleMap & {
480
+ "ROLE-ErrorOutput": ResourceRoleValue & {
481
+ description: "Represents error outputs from job executions.";
482
+ name: "ErrorOutput";
483
+ resourceTypeRef: "TYPE-Error";
484
+ };
485
+ };
470
486
  }
471
487
  /**
472
488
  * This interface was referenced by `GenesisJson`'s JSON-Schema
@@ -564,6 +580,13 @@ export interface StrategyRunContext {
564
580
  startedAt?: Timestamp;
565
581
  status: StrategyRunStatus;
566
582
  }
583
+ export interface StrategyThreadMapWrapper {
584
+ strategyThreadMap: StrategyThreadMap;
585
+ }
586
+ /**
587
+ * This interface was referenced by `GenesisJson`'s JSON-Schema
588
+ * via the `definition` "StrategyThreadMap".
589
+ */
567
590
  export interface StrategyThreadMap {
568
591
  [k: string]: Step[];
569
592
  }
@@ -572,10 +595,10 @@ export interface StrategyStateWrapper1 {
572
595
  }
573
596
  /**
574
597
  * This interface was referenced by `GenesisJson`'s JSON-Schema
575
- * via the `definition` "StrategyThreadMap".
598
+ * via the `definition` "StrategyThreadMapWrapper".
576
599
  */
577
- export interface StrategyThreadMap1 {
578
- [k: string]: Step[];
600
+ export interface StrategyThreadMapWrapper1 {
601
+ strategyThreadMap: StrategyThreadMap;
579
602
  }
580
603
 
581
604
  export type Normalized =
@@ -606,7 +629,13 @@ export interface RolesWrapper {
606
629
  }
607
630
  export interface Roles {
608
631
  inputMap: RoleMap;
609
- outputMap: RoleMap;
632
+ outputMap: RoleMap & {
633
+ "ROLE-ErrorOutput": ResourceRoleValue & {
634
+ description: "Represents error outputs from job executions.";
635
+ name: "ErrorOutput";
636
+ resourceTypeRef: "TYPE-Error";
637
+ };
638
+ };
610
639
  }
611
640
  export type RoleMap = Record<ResourceRoleIdentity, ResourceRoleValue>;
612
641
 
@@ -977,7 +1006,7 @@ export type Normalized =
977
1006
  identity: StrategyRunIdentity;
978
1007
  statefulStrategyRef: StatefulStrategyIdentity;
979
1008
  strategyRunContext: StrategyRunContext;
980
- } & StrategyThreadMap &
1009
+ } & StrategyThreadMapWrapper &
981
1010
  StrategyStateWrapper;
982
1011
  export type StrategyRunIdentity =
983
1012
  `STRATEGY_RUN-${string}`;
@@ -1089,6 +1118,9 @@ export interface StrategyRunContext {
1089
1118
  export interface Timestamp {
1090
1119
  timestamp: string;
1091
1120
  }
1121
+ export interface StrategyThreadMapWrapper {
1122
+ strategyThreadMap: StrategyThreadMap;
1123
+ }
1092
1124
  export interface StrategyThreadMap {
1093
1125
  [k: string]: Step[];
1094
1126
  }