@defra/forms-model 3.0.458 → 3.0.459

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 (26) hide show
  1. package/dist/module/conditions/enums.js +2 -0
  2. package/dist/module/conditions/enums.js.map +1 -1
  3. package/dist/module/conditions/types.js.map +1 -1
  4. package/dist/module/form/form-definition/index.js +61 -14
  5. package/dist/module/form/form-definition/index.js.map +1 -1
  6. package/dist/module/form/form-definition/types.js +0 -1
  7. package/dist/module/form/form-definition/types.js.map +1 -1
  8. package/dist/types/conditions/enums.d.ts +3 -1
  9. package/dist/types/conditions/enums.d.ts.map +1 -1
  10. package/dist/types/conditions/types.d.ts +20 -0
  11. package/dist/types/conditions/types.d.ts.map +1 -1
  12. package/dist/types/form/form-definition/index.d.ts +2 -1
  13. package/dist/types/form/form-definition/index.d.ts.map +1 -1
  14. package/dist/types/form/form-definition/types.d.ts +9 -3
  15. package/dist/types/form/form-definition/types.d.ts.map +1 -1
  16. package/package.json +1 -1
  17. package/schemas/component-schema-v2.json +13 -5
  18. package/schemas/form-definition-schema.json +10 -10
  19. package/schemas/form-definition-v2-schema.json +147 -403
  20. package/schemas/list-schema-v2.json +4 -4
  21. package/schemas/list-schema.json +4 -4
  22. package/schemas/page-schema-v2.json +26 -10
  23. package/src/conditions/enums.ts +3 -1
  24. package/src/conditions/types.ts +28 -0
  25. package/src/form/form-definition/index.ts +170 -44
  26. package/src/form/form-definition/types.ts +13 -4
package/schemas/form-definition-v2-schema.json CHANGED
@@ -77,218 +77,6 @@
77
77
  },
78
78
  "title": "Sections"
79
79
  },
80
- "conditions": {
81
- "type": "array",
82
- "description": "Named conditions used for form logic",
83
- "uniqueItems": true,
84
- "items": {
85
- "type": "object",
86
- "description": "Container for a named condition with its definition",
87
- "properties": {
88
- "name": {
89
- "type": "string",
90
- "description": "Unique identifier used to reference this condition",
91
- "title": "Name"
92
- },
93
- "displayName": {
94
- "type": "string",
95
- "description": "Human-readable name for display in the UI",
96
- "title": "Display Name"
97
- },
98
- "value": {
99
- "type": "object",
100
- "description": "The complete condition definition",
101
- "properties": {
102
- "name": {
103
- "type": "string",
104
- "description": "Unique identifier for the condition set",
105
- "title": "Name"
106
- },
107
- "conditions": {
108
- "type": "array",
109
- "description": "Array of conditions, condition references, or condition groups\n\nElements can be direct conditions, references to named conditions, or nested condition groups. This structure allows building complex logical expressions with AND/OR operators.",
110
- "items": {
111
- "anyOf": [
112
- {
113
- "type": "object",
114
- "description": "Condition definition specifying a logical comparison",
115
- "properties": {
116
- "field": {
117
- "type": "object",
118
- "description": "The form field being evaluated in this condition",
119
- "properties": {
120
- "name": {
121
- "type": "string",
122
- "description": "Component name referenced by this condition",
123
- "title": "Name"
124
- },
125
- "type": {
126
- "type": "string",
127
- "description": "Data type of the field (e.g., string, number, date)",
128
- "title": "Type"
129
- },
130
- "display": {
131
- "type": "string",
132
- "description": "Human-readable name of the field for display purposes",
133
- "title": "Display"
134
- }
135
- },
136
- "required": [
137
- "name",
138
- "type",
139
- "display"
140
- ],
141
- "additionalProperties": false,
142
- "title": "Field"
143
- },
144
- "operator": {
145
- "type": "string",
146
- "description": "Comparison operator: equals, notEquals, contains, notContains, greaterThan, lessThan, isEmpty, isNotEmpty",
147
- "title": "Operator"
148
- },
149
- "value": {
150
- "description": "Value to compare the field against, either fixed or relative date",
151
- "anyOf": [
152
- {
153
- "type": "object",
154
- "description": "Value specification for a condition",
155
- "properties": {
156
- "type": {
157
- "type": "string",
158
- "description": "Data type of the value (e.g., string, number, date)",
159
- "title": "Type"
160
- },
161
- "value": {
162
- "type": "string",
163
- "description": "The actual value to compare against",
164
- "title": "Value"
165
- },
166
- "display": {
167
- "type": "string",
168
- "description": "Human-readable version of the value for display purposes",
169
- "title": "Display"
170
- }
171
- },
172
- "required": [
173
- "type",
174
- "value",
175
- "display"
176
- ],
177
- "additionalProperties": false,
178
- "title": "Static Value"
179
- },
180
- {
181
- "type": "object",
182
- "description": "Relative date specification for date-based conditions",
183
- "properties": {
184
- "type": {
185
- "type": "string",
186
- "description": "Data type identifier, should be \"RelativeDate\"",
187
- "title": "Type"
188
- },
189
- "period": {
190
- "type": "string",
191
- "description": "Numeric amount of the time period, as a string",
192
- "title": "Period"
193
- },
194
- "unit": {
195
- "type": "string",
196
- "description": "Time unit (e.g., days, weeks, months, years)",
197
- "title": "Unit"
198
- },
199
- "direction": {
200
- "type": "string",
201
- "description": "Temporal direction, either \"past\" or \"future\"",
202
- "title": "Direction"
203
- }
204
- },
205
- "required": [
206
- "type",
207
- "period",
208
- "unit",
209
- "direction"
210
- ],
211
- "additionalProperties": false,
212
- "title": "Relative Date Value"
213
- }
214
- ],
215
- "title": "Value",
216
- "anyOfTitles": [
217
- "Static Value",
218
- "Relative Date Value"
219
- ]
220
- },
221
- "coordinator": {
222
- "type": "string",
223
- "description": "Logical operator connecting this condition with others (AND, OR)",
224
- "title": "Coordinator"
225
- }
226
- },
227
- "required": [
228
- "operator"
229
- ],
230
- "additionalProperties": false,
231
- "title": "Unknown Value Type"
232
- },
233
- {
234
- "type": "object",
235
- "description": "Reference to a named condition defined elsewhere",
236
- "properties": {
237
- "conditionName": {
238
- "type": "string",
239
- "description": "Name of the referenced condition",
240
- "title": "Condition Name"
241
- },
242
- "conditionDisplayName": {
243
- "type": "string",
244
- "description": "Human-readable name of the condition for display purposes",
245
- "title": "Condition Display Name"
246
- },
247
- "coordinator": {
248
- "type": "string",
249
- "description": "Logical operator connecting this condition with others (AND, OR)",
250
- "title": "Coordinator"
251
- }
252
- },
253
- "required": [
254
- "conditionName",
255
- "conditionDisplayName"
256
- ],
257
- "additionalProperties": false,
258
- "title": "Unknown Value Type"
259
- },
260
- {
261
- "$ref": "#/$defs/conditionGroupSchema",
262
- "title": "Nested Condition Group",
263
- "description": "A nested group of conditions that allows building complex logical expressions with multiple levels."
264
- }
265
- ],
266
- "title": "Conditions Item",
267
- "anyOfTitles": [
268
- "Condition Definition",
269
- "Condition Reference",
270
- "Nested Condition Group"
271
- ]
272
- },
273
- "title": "Conditions"
274
- }
275
- },
276
- "required": [
277
- "name"
278
- ],
279
- "additionalProperties": false,
280
- "title": "Value"
281
- }
282
- },
283
- "required": [
284
- "name",
285
- "value"
286
- ],
287
- "additionalProperties": false,
288
- "title": "Conditions Item"
289
- },
290
- "title": "Conditions"
291
- },
292
80
  "metadata": {
293
81
  "type": "object",
294
82
  "description": "Custom metadata for the form",
@@ -464,11 +252,6 @@
464
252
  ],
465
253
  "additionalProperties": false
466
254
  },
467
- "condition": {
468
- "type": "string",
469
- "description": "Optional condition that determines if this page is shown",
470
- "title": "Condition"
471
- },
472
255
  "next": {
473
256
  "type": "array",
474
257
  "description": "Possible navigation paths after this page",
@@ -749,16 +532,24 @@
749
532
  "additionalProperties": true,
750
533
  "title": "Schema"
751
534
  },
752
- "list": {
753
- "type": "string",
754
- "description": "Reference to a predefined list of options for select components",
755
- "title": "List"
756
- },
757
535
  "id": {
758
536
  "type": "string",
759
537
  "description": "Unique identifier for the component",
760
538
  "format": "uuid",
761
539
  "title": "Id"
540
+ },
541
+ "list": {
542
+ "description": "List id reference to a predefined list of options for select components",
543
+ "const": {
544
+ "ref": {
545
+ "path": [
546
+ "lists"
547
+ ],
548
+ "ancestor": "root",
549
+ "in": true
550
+ }
551
+ },
552
+ "title": "List"
762
553
  }
763
554
  },
764
555
  "required": [
@@ -768,6 +559,19 @@
768
559
  "title": "Components Item"
769
560
  },
770
561
  "title": "Components"
562
+ },
563
+ "condition": {
564
+ "description": "Optional condition that determines if this page is shown",
565
+ "const": {
566
+ "ref": {
567
+ "path": [
568
+ "conditions"
569
+ ],
570
+ "ancestor": "root",
571
+ "in": true
572
+ }
573
+ },
574
+ "title": "Condition"
771
575
  }
772
576
  },
773
577
  "required": [
@@ -826,9 +630,9 @@
826
630
  "properties": {
827
631
  "id": {
828
632
  "type": "string",
633
+ "description": "Unique identifier for the list item",
829
634
  "format": "uuid",
830
- "title": "Id",
831
- "description": "The id value."
635
+ "title": "Id"
832
636
  },
833
637
  "text": {
834
638
  "type": "string",
@@ -1065,9 +869,9 @@
1065
869
  "properties": {
1066
870
  "id": {
1067
871
  "type": "string",
872
+ "description": "Unique identifier for the list item",
1068
873
  "format": "uuid",
1069
- "title": "Id",
1070
- "description": "The id value."
874
+ "title": "Id"
1071
875
  },
1072
876
  "text": {
1073
877
  "type": "string",
@@ -1318,191 +1122,131 @@
1318
1122
  "title": "Lists Item"
1319
1123
  },
1320
1124
  "title": "Lists"
1321
- }
1322
- },
1323
- "required": [
1324
- "sections",
1325
- "pages"
1326
- ],
1327
- "additionalProperties": false,
1328
- "$defs": {
1329
- "conditionGroupSchema": {
1330
- "type": "object",
1331
- "description": "Group of conditions combined with logical operators",
1332
- "properties": {
1333
- "conditions": {
1334
- "type": "array",
1335
- "description": "Array of conditions or condition references in this group",
1336
- "items": {
1337
- "anyOf": [
1338
- {
1339
- "type": "object",
1340
- "description": "Condition definition specifying a logical comparison",
1341
- "properties": {
1342
- "field": {
1343
- "type": "object",
1344
- "description": "The form field being evaluated in this condition",
1345
- "properties": {
1346
- "name": {
1347
- "type": "string",
1348
- "description": "Component name referenced by this condition",
1349
- "title": "Name"
1350
- },
1351
- "type": {
1352
- "type": "string",
1353
- "description": "Data type of the field (e.g., string, number, date)",
1354
- "title": "Type"
1355
- },
1356
- "display": {
1357
- "type": "string",
1358
- "description": "Human-readable name of the field for display purposes",
1359
- "title": "Display"
1360
- }
1125
+ },
1126
+ "conditions": {
1127
+ "type": "array",
1128
+ "description": "Named conditions used for form logic",
1129
+ "uniqueItems": true,
1130
+ "items": {
1131
+ "type": "object",
1132
+ "description": "Condition schema for V2 forms",
1133
+ "properties": {
1134
+ "name": {
1135
+ "type": "string",
1136
+ "description": "Unique identifier for the condition",
1137
+ "title": "Name"
1138
+ },
1139
+ "displayName": {
1140
+ "type": "string",
1141
+ "description": "Human-readable name for display in the UI",
1142
+ "title": "Display Name"
1143
+ },
1144
+ "coordinator": {
1145
+ "type": "string",
1146
+ "description": "Logical operator connecting this condition with others (AND, OR)",
1147
+ "title": "Coordinator"
1148
+ },
1149
+ "conditions": {
1150
+ "type": "array",
1151
+ "description": "Array of conditions or condition references\n\nElements can be direct conditions, references to named conditions, or nested condition groups. This structure allows building complex logical expressions with AND/OR operators.",
1152
+ "items": {
1153
+ "anyOf": [
1154
+ {
1155
+ "type": "object",
1156
+ "description": "Condition definition",
1157
+ "properties": {
1158
+ "id": {
1159
+ "type": "string",
1160
+ "description": "Unique identifier used to reference this condition",
1161
+ "format": "uuid",
1162
+ "title": "Id"
1361
1163
  },
1362
- "required": [
1363
- "name",
1364
- "type",
1365
- "display"
1366
- ],
1367
- "additionalProperties": false,
1368
- "title": "Field"
1369
- },
1370
- "operator": {
1371
- "type": "string",
1372
- "description": "Comparison operator (equals, greaterThan, contains, etc.)",
1373
- "title": "Operator"
1374
- },
1375
- "value": {
1376
- "description": "Value to compare the field against, either fixed or relative date",
1377
- "anyOf": [
1378
- {
1379
- "type": "object",
1380
- "description": "Value specification for a condition",
1381
- "properties": {
1382
- "type": {
1383
- "type": "string",
1384
- "description": "Data type of the value (e.g., string, number, date)",
1385
- "title": "Type"
1386
- },
1387
- "value": {
1388
- "type": "string",
1389
- "description": "The actual value to compare against",
1390
- "title": "Value"
1391
- },
1392
- "display": {
1393
- "type": "string",
1394
- "description": "Human-readable version of the value for display purposes",
1395
- "title": "Display"
1396
- }
1397
- },
1398
- "required": [
1399
- "type",
1400
- "value",
1401
- "display"
1402
- ],
1403
- "additionalProperties": false,
1404
- "title": "Static Value"
1164
+ "componentId": {
1165
+ "description": "Reference to the component id being evaluated in this condition",
1166
+ "const": {
1167
+ "ref": {
1168
+ "path": [
1169
+ "pages"
1170
+ ],
1171
+ "ancestor": "root",
1172
+ "in": true
1173
+ }
1405
1174
  },
1406
- {
1407
- "type": "object",
1408
- "description": "Relative date specification for date-based conditions",
1409
- "properties": {
1410
- "type": {
1411
- "type": "string",
1412
- "description": "Data type identifier, should be \"RelativeDate\"",
1413
- "title": "Type"
1414
- },
1415
- "period": {
1416
- "type": "string",
1417
- "description": "Numeric amount of the time period, as a string",
1418
- "title": "Period"
1419
- },
1420
- "unit": {
1421
- "type": "string",
1422
- "description": "Time unit (e.g., days, weeks, months, years)",
1423
- "title": "Unit"
1424
- },
1425
- "direction": {
1426
- "type": "string",
1427
- "description": "Temporal direction, either \"past\" or \"future\"",
1428
- "title": "Direction"
1429
- }
1430
- },
1431
- "required": [
1432
- "type",
1433
- "period",
1434
- "unit",
1435
- "direction"
1436
- ],
1437
- "additionalProperties": false,
1438
- "title": "Relative Date Value"
1439
- }
1440
- ],
1441
- "title": "Value",
1442
- "anyOfTitles": [
1443
- "Static Value",
1444
- "Relative Date Value"
1445
- ]
1175
+ "title": "Component Id"
1176
+ },
1177
+ "operator": {
1178
+ "type": "string",
1179
+ "description": "Comparison operator: equals, notEquals, contains, notContains, greaterThan, lessThan, isEmpty, isNotEmpty",
1180
+ "title": "Operator"
1181
+ },
1182
+ "value": {
1183
+ "description": "Value to compare the field against, either fixed or relative date\n\nValue can be of various types (object, object, object).",
1184
+ "title": "Value",
1185
+ "anyOfTitles": [
1186
+ "Value (object)",
1187
+ "Value (object)",
1188
+ "Value (object)"
1189
+ ]
1190
+ }
1446
1191
  },
1447
- "coordinator": {
1448
- "type": "string",
1449
- "description": "Logical operator connecting this condition with others (AND, OR)",
1450
- "title": "Coordinator"
1451
- }
1192
+ "required": [
1193
+ "componentId",
1194
+ "operator"
1195
+ ],
1196
+ "additionalProperties": false,
1197
+ "title": "Unknown Condition Item Type"
1452
1198
  },
1453
- "required": [
1454
- "operator"
1455
- ],
1456
- "additionalProperties": false,
1457
- "title": "Condition Definition"
1458
- },
1459
- {
1460
- "type": "object",
1461
- "description": "Reference to a named condition defined elsewhere",
1462
- "properties": {
1463
- "conditionName": {
1464
- "type": "string",
1465
- "description": "Name of the referenced condition",
1466
- "title": "Condition Name"
1467
- },
1468
- "conditionDisplayName": {
1469
- "type": "string",
1470
- "description": "Human-readable name of the condition for display purposes",
1471
- "title": "Condition Display Name"
1199
+ {
1200
+ "type": "object",
1201
+ "description": "Reference to a named condition defined elsewhere",
1202
+ "properties": {
1203
+ "id": {
1204
+ "type": "string",
1205
+ "description": "Unique identifier for the referenced condition",
1206
+ "format": "uuid",
1207
+ "title": "Id"
1208
+ },
1209
+ "conditionId": {
1210
+ "description": "Name of the referenced condition",
1211
+ "const": {
1212
+ "ref": {
1213
+ "path": [
1214
+ "conditions"
1215
+ ],
1216
+ "ancestor": "root",
1217
+ "in": true
1218
+ }
1219
+ },
1220
+ "title": "Condition Id"
1221
+ }
1472
1222
  },
1473
- "coordinator": {
1474
- "type": "string",
1475
- "description": "Logical operator connecting this condition with others (AND, OR)",
1476
- "title": "Coordinator"
1477
- }
1478
- },
1479
- "required": [
1480
- "conditionName",
1481
- "conditionDisplayName"
1482
- ],
1483
- "additionalProperties": false,
1484
- "title": "Condition Reference"
1485
- },
1486
- {
1487
- "$ref": "#/$defs/conditionGroupSchema",
1488
- "title": "Nested Condition Group",
1489
- "description": "A nested group of conditions that allows building complex logical expressions with multiple levels."
1490
- }
1491
- ],
1492
- "title": "Conditions Item",
1493
- "anyOfTitles": [
1494
- "Condition Definition",
1495
- "Condition Reference",
1496
- "Nested Condition Group"
1497
- ]
1498
- },
1499
- "title": "Conditions"
1500
- }
1223
+ "required": [
1224
+ "conditionId"
1225
+ ],
1226
+ "additionalProperties": false,
1227
+ "title": "Unknown Condition Item Type"
1228
+ }
1229
+ ],
1230
+ "title": "Conditions Item",
1231
+ "anyOfTitles": [
1232
+ "Conditions Item (object)",
1233
+ "Conditions Item (object)"
1234
+ ]
1235
+ },
1236
+ "title": "Conditions"
1237
+ }
1238
+ },
1239
+ "additionalProperties": false,
1240
+ "title": "Conditions Item"
1501
1241
  },
1502
- "additionalProperties": false,
1503
- "title": "Condition Group Schema"
1242
+ "title": "Conditions"
1504
1243
  }
1505
1244
  },
1245
+ "required": [
1246
+ "sections",
1247
+ "pages"
1248
+ ],
1249
+ "additionalProperties": false,
1506
1250
  "$schema": "http://json-schema.org/draft-07/schema#",
1507
1251
  "title": "Form Definition V2 Schema",
1508
1252
  "$id": "@defra/forms-model/schemas/form-definition-v2-schema.json"
package/schemas/list-schema-v2.json CHANGED
@@ -41,9 +41,9 @@
41
41
  "properties": {
42
42
  "id": {
43
43
  "type": "string",
44
+ "description": "Unique identifier for the list item",
44
45
  "format": "uuid",
45
- "title": "Id",
46
- "description": "The id value."
46
+ "title": "Id"
47
47
  },
48
48
  "text": {
49
49
  "type": "string",
@@ -280,9 +280,9 @@
280
280
  "properties": {
281
281
  "id": {
282
282
  "type": "string",
283
+ "description": "Unique identifier for the list item",
283
284
  "format": "uuid",
284
- "title": "Id",
285
- "description": "The id value."
285
+ "title": "Id"
286
286
  },
287
287
  "text": {
288
288
  "type": "string",