@mat3ra/esse 2026.9.6-0 → 2026.10.8-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 (27) hide show
  1. package/dist/js/esse/server/utils.js +15 -0
  2. package/dist/js/schema/compute/nodes/cluster.json +13 -8
  3. package/dist/js/schema/compute/queue.json +13 -8
  4. package/dist/js/schema/compute/queue_name_enum.json +59 -0
  5. package/dist/js/schema/job/base.json +5104 -39
  6. package/dist/js/schema/job/compute.json +13 -8
  7. package/dist/js/schema/job/compute_property.json +13 -8
  8. package/dist/js/schema/job/dataset.json +37 -0
  9. package/dist/js/schema/job.json +182 -62
  10. package/dist/js/schema/properties_directory/non_scalar/workflow.json +31 -27
  11. package/dist/js/schema/property/holder.json +31 -27
  12. package/dist/js/schema/system/has_project.json +33 -0
  13. package/dist/js/schema/workflow/base.json +17 -18
  14. package/dist/js/schema/workflow/base_flow.json +13 -8
  15. package/dist/js/schema/workflow/subworkflow/mixin.json +17 -18
  16. package/dist/js/schema/workflow/subworkflow/unit.json +4 -10
  17. package/dist/js/schema/workflow/subworkflow.json +17 -18
  18. package/dist/js/schema/workflow/unit/assignment.json +4 -10
  19. package/dist/js/schema/workflow/unit/mixins/assignment.json +4 -10
  20. package/dist/js/schema/workflow.json +31 -27
  21. package/dist/js/schemas.json +1 -1
  22. package/dist/js/scripts/buildDocsPages.d.ts +17 -0
  23. package/dist/js/scripts/buildDocsPages.js +167 -18
  24. package/dist/js/types.d.ts +2902 -378
  25. package/dist/js/types.js +33 -1
  26. package/package.json +1 -1
  27. package/dist/js/schema/system/job_extended.json +0 -70
package/dist/js/schema/job/compute.json CHANGED
@@ -12,29 +12,34 @@
12
12
  ],
13
13
  "properties": {
14
14
  "queue": {
15
- "description": "Name of the submission queues: https://docs.mat3ra.com/infrastructure/resource/queues/. Below enums are for Azure, then AWS circa 2022-08, hence the duplication.",
15
+ "description": "Name of the submission queue: https://docs.mat3ra.com/infrastructure/resource/queues/.",
16
16
  "type": "string",
17
17
  "enum": [
18
18
  "D",
19
19
  "OR",
20
- "OF",
21
- "OFplus",
22
- "SR",
23
- "SF",
24
- "SFplus",
25
20
  "OR4",
26
21
  "OR8",
27
22
  "OR16",
23
+ "SR",
28
24
  "SR4",
29
25
  "SR8",
30
26
  "SR16",
27
+ "OF",
28
+ "OFplus",
29
+ "SF",
30
+ "SFplus",
31
31
  "GOF",
32
32
  "G4OF",
33
33
  "G8OF",
34
+ "GP4OF",
34
35
  "GSF",
35
36
  "G4SF",
36
- "G8SF"
37
- ]
37
+ "G8SF",
38
+ "GPSF",
39
+ "GP2SF",
40
+ "GP4SF"
41
+ ],
42
+ "tsType": "QueueNameEnum"
38
43
  },
39
44
  "nodes": {
40
45
  "description": "number of nodes used for the job inside the RMS.",
package/dist/js/schema/job/compute_property.json CHANGED
@@ -20,29 +20,34 @@
20
20
  ],
21
21
  "properties": {
22
22
  "queue": {
23
- "description": "Name of the submission queues: https://docs.mat3ra.com/infrastructure/resource/queues/. Below enums are for Azure, then AWS circa 2022-08, hence the duplication.",
23
+ "description": "Name of the submission queue: https://docs.mat3ra.com/infrastructure/resource/queues/.",
24
24
  "type": "string",
25
25
  "enum": [
26
26
  "D",
27
27
  "OR",
28
- "OF",
29
- "OFplus",
30
- "SR",
31
- "SF",
32
- "SFplus",
33
28
  "OR4",
34
29
  "OR8",
35
30
  "OR16",
31
+ "SR",
36
32
  "SR4",
37
33
  "SR8",
38
34
  "SR16",
35
+ "OF",
36
+ "OFplus",
37
+ "SF",
38
+ "SFplus",
39
39
  "GOF",
40
40
  "G4OF",
41
41
  "G8OF",
42
+ "GP4OF",
42
43
  "GSF",
43
44
  "G4SF",
44
- "G8SF"
45
- ]
45
+ "G8SF",
46
+ "GPSF",
47
+ "GP2SF",
48
+ "GP4SF"
49
+ ],
50
+ "tsType": "QueueNameEnum"
46
51
  },
47
52
  "nodes": {
48
53
  "description": "number of nodes used for the job inside the RMS.",
package/dist/js/schema/job/dataset.json ADDED
@@ -0,0 +1,37 @@
1
+ {
2
+ "$id": "job/dataset",
3
+ "$schema": "http://json-schema.org/draft-07/schema#",
4
+ "title": "job dataset schema",
5
+ "type": "object",
6
+ "properties": {
7
+ "datasetFilepath": {
8
+ "type": "string"
9
+ },
10
+ "datasetBasename": {
11
+ "type": "string"
12
+ },
13
+ "objectStorageContainerData": {
14
+ "type": "object",
15
+ "properties": {
16
+ "CONTAINER": {
17
+ "type": "string"
18
+ },
19
+ "NAME": {
20
+ "type": "string"
21
+ },
22
+ "PROVIDER": {
23
+ "type": "string"
24
+ },
25
+ "REGION": {
26
+ "type": "string"
27
+ },
28
+ "SIZE": {
29
+ "type": "string"
30
+ },
31
+ "TIMESTAMP": {
32
+ "type": "string"
33
+ }
34
+ }
35
+ }
36
+ }
37
+ }
package/dist/js/schema/job.json CHANGED
@@ -11,6 +11,34 @@
11
11
  "workflow"
12
12
  ],
13
13
  "properties": {
14
+ "_id": {
15
+ "description": "entity identity",
16
+ "type": "string"
17
+ },
18
+ "slug": {
19
+ "description": "entity slug",
20
+ "type": "string"
21
+ },
22
+ "systemName": {
23
+ "type": "string"
24
+ },
25
+ "schemaVersion": {
26
+ "description": "entity's schema version. Used to distinct between different schemas.",
27
+ "type": "string",
28
+ "default": "2022.8.16"
29
+ },
30
+ "name": {
31
+ "description": "entity name",
32
+ "type": "string"
33
+ },
34
+ "isDefault": {
35
+ "description": "Identifies that entity is defaultable",
36
+ "type": "boolean",
37
+ "default": false
38
+ },
39
+ "metadata": {
40
+ "type": "object"
41
+ },
14
42
  "workflow": {
15
43
  "$schema": "http://json-schema.org/draft-07/schema#",
16
44
  "title": "workflow schema",
@@ -24,7 +52,7 @@
24
52
  ],
25
53
  "properties": {
26
54
  "workflows": {
27
- "description": "Array of workflows with the same schema as the current one.",
55
+ "description": "Array of workflows with the same schema as the current one. NOTE: items are not validated against the workflow schema itself (known limitation - see server/utils.ts's parseIncludeReferenceStatements for why, and consider fixing).",
28
56
  "type": "array",
29
57
  "items": {
30
58
  "type": "object"
@@ -43,29 +71,34 @@
43
71
  ],
44
72
  "properties": {
45
73
  "queue": {
46
- "description": "Name of the submission queues: https://docs.mat3ra.com/infrastructure/resource/queues/. Below enums are for Azure, then AWS circa 2022-08, hence the duplication.",
74
+ "description": "Name of the submission queue: https://docs.mat3ra.com/infrastructure/resource/queues/.",
47
75
  "type": "string",
48
76
  "enum": [
49
77
  "D",
50
78
  "OR",
51
- "OF",
52
- "OFplus",
53
- "SR",
54
- "SF",
55
- "SFplus",
56
79
  "OR4",
57
80
  "OR8",
58
81
  "OR16",
82
+ "SR",
59
83
  "SR4",
60
84
  "SR8",
61
85
  "SR16",
86
+ "OF",
87
+ "OFplus",
88
+ "SF",
89
+ "SFplus",
62
90
  "GOF",
63
91
  "G4OF",
64
92
  "G8OF",
93
+ "GP4OF",
65
94
  "GSF",
66
95
  "G4SF",
67
- "G8SF"
68
- ]
96
+ "G8SF",
97
+ "GPSF",
98
+ "GP2SF",
99
+ "GP4SF"
100
+ ],
101
+ "tsType": "QueueNameEnum"
69
102
  },
70
103
  "nodes": {
71
104
  "description": "number of nodes used for the job inside the RMS.",
@@ -296,29 +329,34 @@
296
329
  ],
297
330
  "properties": {
298
331
  "queue": {
299
- "description": "Name of the submission queues: https://docs.mat3ra.com/infrastructure/resource/queues/. Below enums are for Azure, then AWS circa 2022-08, hence the duplication.",
332
+ "description": "Name of the submission queue: https://docs.mat3ra.com/infrastructure/resource/queues/.",
300
333
  "type": "string",
301
334
  "enum": [
302
335
  "D",
303
336
  "OR",
304
- "OF",
305
- "OFplus",
306
- "SR",
307
- "SF",
308
- "SFplus",
309
337
  "OR4",
310
338
  "OR8",
311
339
  "OR16",
340
+ "SR",
312
341
  "SR4",
313
342
  "SR8",
314
343
  "SR16",
344
+ "OF",
345
+ "OFplus",
346
+ "SF",
347
+ "SFplus",
315
348
  "GOF",
316
349
  "G4OF",
317
350
  "G8OF",
351
+ "GP4OF",
318
352
  "GSF",
319
353
  "G4SF",
320
- "G8SF"
321
- ]
354
+ "G8SF",
355
+ "GPSF",
356
+ "GP2SF",
357
+ "GP4SF"
358
+ ],
359
+ "tsType": "QueueNameEnum"
322
360
  },
323
361
  "nodes": {
324
362
  "description": "number of nodes used for the job inside the RMS.",
@@ -3550,16 +3588,10 @@
3550
3588
  },
3551
3589
  "value": {
3552
3590
  "description": "Value of the variable. The value content could be a simple integer, string or a python expression. e.g. '0' (initialization), 'sin(x)+1' (expression)",
3553
- "oneOf": [
3554
- {
3555
- "type": "string"
3556
- },
3557
- {
3558
- "type": "boolean"
3559
- },
3560
- {
3561
- "type": "number"
3562
- }
3591
+ "type": [
3592
+ "string",
3593
+ "boolean",
3594
+ "number"
3563
3595
  ]
3564
3596
  }
3565
3597
  }
@@ -5034,7 +5066,7 @@
5034
5066
  "description": "The path to the working directory of this job, when the job originates from command-line",
5035
5067
  "type": "string"
5036
5068
  },
5037
- "_project": {
5069
+ "_material": {
5038
5070
  "$schema": "http://json-schema.org/draft-07/schema#",
5039
5071
  "title": "entity reference schema",
5040
5072
  "type": "object",
@@ -5056,7 +5088,33 @@
5056
5088
  }
5057
5089
  }
5058
5090
  },
5059
- "_material": {
5091
+ "_materials": {
5092
+ "description": "Subset of the full information about the materials used inside a multi-material job.",
5093
+ "type": "array",
5094
+ "items": {
5095
+ "$schema": "http://json-schema.org/draft-07/schema#",
5096
+ "title": "entity reference schema",
5097
+ "type": "object",
5098
+ "required": [
5099
+ "_id"
5100
+ ],
5101
+ "properties": {
5102
+ "_id": {
5103
+ "description": "entity identity",
5104
+ "type": "string"
5105
+ },
5106
+ "cls": {
5107
+ "description": "entity class",
5108
+ "type": "string"
5109
+ },
5110
+ "slug": {
5111
+ "description": "entity slug",
5112
+ "type": "string"
5113
+ }
5114
+ }
5115
+ }
5116
+ },
5117
+ "_materialsSet": {
5060
5118
  "$schema": "http://json-schema.org/draft-07/schema#",
5061
5119
  "title": "entity reference schema",
5062
5120
  "type": "object",
@@ -5135,33 +5193,47 @@
5135
5193
  }
5136
5194
  }
5137
5195
  },
5138
- "_id": {
5139
- "description": "entity identity",
5140
- "type": "string"
5141
- },
5142
- "slug": {
5143
- "description": "entity slug",
5144
- "type": "string"
5145
- },
5146
- "systemName": {
5147
- "type": "string"
5148
- },
5149
- "schemaVersion": {
5150
- "description": "entity's schema version. Used to distinct between different schemas.",
5151
- "type": "string",
5152
- "default": "2022.8.16"
5153
- },
5154
- "name": {
5155
- "description": "entity name",
5156
- "type": "string"
5196
+ "dataset": {
5197
+ "$schema": "http://json-schema.org/draft-07/schema#",
5198
+ "title": "job dataset schema",
5199
+ "type": "object",
5200
+ "properties": {
5201
+ "datasetFilepath": {
5202
+ "type": "string"
5203
+ },
5204
+ "datasetBasename": {
5205
+ "type": "string"
5206
+ },
5207
+ "objectStorageContainerData": {
5208
+ "type": "object",
5209
+ "properties": {
5210
+ "CONTAINER": {
5211
+ "type": "string"
5212
+ },
5213
+ "NAME": {
5214
+ "type": "string"
5215
+ },
5216
+ "PROVIDER": {
5217
+ "type": "string"
5218
+ },
5219
+ "REGION": {
5220
+ "type": "string"
5221
+ },
5222
+ "SIZE": {
5223
+ "type": "string"
5224
+ },
5225
+ "TIMESTAMP": {
5226
+ "type": "string"
5227
+ }
5228
+ }
5229
+ }
5230
+ }
5157
5231
  },
5158
- "isDefault": {
5159
- "description": "Identifies that entity is defaultable",
5160
- "type": "boolean",
5161
- "default": false
5232
+ "purged": {
5233
+ "type": "boolean"
5162
5234
  },
5163
- "metadata": {
5164
- "type": "object"
5235
+ "purgedAt": {
5236
+ "type": "number"
5165
5237
  },
5166
5238
  "compute": {
5167
5239
  "$schema": "http://json-schema.org/draft-07/schema#",
@@ -5176,29 +5248,34 @@
5176
5248
  ],
5177
5249
  "properties": {
5178
5250
  "queue": {
5179
- "description": "Name of the submission queues: https://docs.mat3ra.com/infrastructure/resource/queues/. Below enums are for Azure, then AWS circa 2022-08, hence the duplication.",
5251
+ "description": "Name of the submission queue: https://docs.mat3ra.com/infrastructure/resource/queues/.",
5180
5252
  "type": "string",
5181
5253
  "enum": [
5182
5254
  "D",
5183
5255
  "OR",
5184
- "OF",
5185
- "OFplus",
5186
- "SR",
5187
- "SF",
5188
- "SFplus",
5189
5256
  "OR4",
5190
5257
  "OR8",
5191
5258
  "OR16",
5259
+ "SR",
5192
5260
  "SR4",
5193
5261
  "SR8",
5194
5262
  "SR16",
5263
+ "OF",
5264
+ "OFplus",
5265
+ "SF",
5266
+ "SFplus",
5195
5267
  "GOF",
5196
5268
  "G4OF",
5197
5269
  "G8OF",
5270
+ "GP4OF",
5198
5271
  "GSF",
5199
5272
  "G4SF",
5200
- "G8SF"
5201
- ]
5273
+ "G8SF",
5274
+ "GPSF",
5275
+ "GP2SF",
5276
+ "GP4SF"
5277
+ ],
5278
+ "tsType": "QueueNameEnum"
5202
5279
  },
5203
5280
  "nodes": {
5204
5281
  "description": "number of nodes used for the job inside the RMS.",
@@ -5333,6 +5410,49 @@
5333
5410
  "type": "string"
5334
5411
  }
5335
5412
  }
5413
+ },
5414
+ "statusTrack": {
5415
+ "type": "array",
5416
+ "items": {
5417
+ "type": "object",
5418
+ "required": [
5419
+ "trackedAt",
5420
+ "status"
5421
+ ],
5422
+ "properties": {
5423
+ "trackedAt": {
5424
+ "type": "number"
5425
+ },
5426
+ "status": {
5427
+ "type": "string"
5428
+ },
5429
+ "repetition": {
5430
+ "type": "number"
5431
+ }
5432
+ }
5433
+ }
5434
+ },
5435
+ "_project": {
5436
+ "$schema": "http://json-schema.org/draft-07/schema#",
5437
+ "title": "entity reference schema",
5438
+ "type": "object",
5439
+ "required": [
5440
+ "_id"
5441
+ ],
5442
+ "properties": {
5443
+ "_id": {
5444
+ "description": "entity identity",
5445
+ "type": "string"
5446
+ },
5447
+ "cls": {
5448
+ "description": "entity class",
5449
+ "type": "string"
5450
+ },
5451
+ "slug": {
5452
+ "description": "entity slug",
5453
+ "type": "string"
5454
+ }
5455
+ }
5336
5456
  }
5337
5457
  }
5338
5458
  }
package/dist/js/schema/properties_directory/non_scalar/workflow.json CHANGED
@@ -19,7 +19,7 @@
19
19
  "type": "string"
20
20
  },
21
21
  "workflows": {
22
- "description": "Array of workflows with the same schema as the current one.",
22
+ "description": "Array of workflows with the same schema as the current one. NOTE: items are not validated against the workflow schema itself (known limitation - see server/utils.ts's parseIncludeReferenceStatements for why, and consider fixing).",
23
23
  "type": "array",
24
24
  "items": {
25
25
  "type": "object"
@@ -38,29 +38,34 @@
38
38
  ],
39
39
  "properties": {
40
40
  "queue": {
41
- "description": "Name of the submission queues: https://docs.mat3ra.com/infrastructure/resource/queues/. Below enums are for Azure, then AWS circa 2022-08, hence the duplication.",
41
+ "description": "Name of the submission queue: https://docs.mat3ra.com/infrastructure/resource/queues/.",
42
42
  "type": "string",
43
43
  "enum": [
44
44
  "D",
45
45
  "OR",
46
- "OF",
47
- "OFplus",
48
- "SR",
49
- "SF",
50
- "SFplus",
51
46
  "OR4",
52
47
  "OR8",
53
48
  "OR16",
49
+ "SR",
54
50
  "SR4",
55
51
  "SR8",
56
52
  "SR16",
53
+ "OF",
54
+ "OFplus",
55
+ "SF",
56
+ "SFplus",
57
57
  "GOF",
58
58
  "G4OF",
59
59
  "G8OF",
60
+ "GP4OF",
60
61
  "GSF",
61
62
  "G4SF",
62
- "G8SF"
63
- ]
63
+ "G8SF",
64
+ "GPSF",
65
+ "GP2SF",
66
+ "GP4SF"
67
+ ],
68
+ "tsType": "QueueNameEnum"
64
69
  },
65
70
  "nodes": {
66
71
  "description": "number of nodes used for the job inside the RMS.",
@@ -287,29 +292,34 @@
287
292
  ],
288
293
  "properties": {
289
294
  "queue": {
290
- "description": "Name of the submission queues: https://docs.mat3ra.com/infrastructure/resource/queues/. Below enums are for Azure, then AWS circa 2022-08, hence the duplication.",
295
+ "description": "Name of the submission queue: https://docs.mat3ra.com/infrastructure/resource/queues/.",
291
296
  "type": "string",
292
297
  "enum": [
293
298
  "D",
294
299
  "OR",
295
- "OF",
296
- "OFplus",
297
- "SR",
298
- "SF",
299
- "SFplus",
300
300
  "OR4",
301
301
  "OR8",
302
302
  "OR16",
303
+ "SR",
303
304
  "SR4",
304
305
  "SR8",
305
306
  "SR16",
307
+ "OF",
308
+ "OFplus",
309
+ "SF",
310
+ "SFplus",
306
311
  "GOF",
307
312
  "G4OF",
308
313
  "G8OF",
314
+ "GP4OF",
309
315
  "GSF",
310
316
  "G4SF",
311
- "G8SF"
312
- ]
317
+ "G8SF",
318
+ "GPSF",
319
+ "GP2SF",
320
+ "GP4SF"
321
+ ],
322
+ "tsType": "QueueNameEnum"
313
323
  },
314
324
  "nodes": {
315
325
  "description": "number of nodes used for the job inside the RMS.",
@@ -3541,16 +3551,10 @@
3541
3551
  },
3542
3552
  "value": {
3543
3553
  "description": "Value of the variable. The value content could be a simple integer, string or a python expression. e.g. '0' (initialization), 'sin(x)+1' (expression)",
3544
- "oneOf": [
3545
- {
3546
- "type": "string"
3547
- },
3548
- {
3549
- "type": "boolean"
3550
- },
3551
- {
3552
- "type": "number"
3553
- }
3554
+ "type": [
3555
+ "string",
3556
+ "boolean",
3557
+ "number"
3554
3558
  ]
3555
3559
  }
3556
3560
  }