@opencrvs/toolkit 2.0.0-rc.c4072b5 → 2.0.0-rc.c4538db

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 (38) hide show
  1. package/create-countryconfig/index.js +50 -20
  2. package/create-countryconfig/package.json +12 -2
  3. package/dist/application-config/index.js +252 -98
  4. package/dist/cli.js +10 -4
  5. package/dist/commons/api/router.d.ts +109 -21
  6. package/dist/commons/application-config/index.d.ts +1 -0
  7. package/dist/commons/conditionals/conditionals.d.ts +354 -4
  8. package/dist/commons/conditionals/validate.d.ts +51 -2
  9. package/dist/commons/events/ActionConfig.d.ts +28 -2
  10. package/dist/commons/events/ActionDocument.d.ts +6 -0
  11. package/dist/commons/events/ActionInput.d.ts +42 -36
  12. package/dist/commons/events/AdvancedSearchConfig.d.ts +342 -0
  13. package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
  14. package/dist/commons/events/Draft.d.ts +2 -3
  15. package/dist/commons/events/EventDocument.d.ts +3 -0
  16. package/dist/commons/events/EventIndex.d.ts +14 -0
  17. package/dist/commons/events/FieldConfig.d.ts +378 -50
  18. package/dist/commons/events/FieldType.d.ts +1 -0
  19. package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
  20. package/dist/commons/events/FieldValue.d.ts +6 -0
  21. package/dist/commons/events/WorkqueueConfig.d.ts +44 -5
  22. package/dist/commons/events/field.d.ts +53 -1
  23. package/dist/commons/events/index.d.ts +2 -0
  24. package/dist/commons/events/state/flags.d.ts +16 -0
  25. package/dist/commons/events/state/utils.d.ts +12 -287
  26. package/dist/commons/events/utils.d.ts +12 -1
  27. package/dist/conditionals/index.js +52 -1
  28. package/dist/events/index.js +1037 -223
  29. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  30. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  31. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
  32. package/dist/migrations/v2.0/index.js +10 -4
  33. package/dist/notification/index.js +871 -121
  34. package/dist/scopes/index.d.ts +4 -6
  35. package/dist/scopes/index.js +9 -3
  36. package/opencrvs-toolkit-2.0.0-rc.c4538db.tgz +0 -0
  37. package/package.json +6 -2
  38. package/opencrvs-toolkit-2.0.0-rc.c4072b5.tgz +0 -0
@@ -76,8 +76,8 @@ var ActionConditional = z.discriminatedUnion("type", [
76
76
  // Action can be shown to the user in the list but as disabled
77
77
  EnableConditional
78
78
  ]).meta({
79
- description: "Action conditional configuration",
80
- id: "ActionConditional"
79
+ id: "ActionConditional",
80
+ description: "Conditional gating whether an action is shown (SHOW) or enabled (ENABLE). When omitted from an action, the action is shown and enabled for everyone."
81
81
  });
82
82
  var DisplayOnReviewConditional = z.object({
83
83
  type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
@@ -93,8 +93,8 @@ var FieldConditional = z.discriminatedUnion("type", [
93
93
  // Field output can be shown / hidden on the review page
94
94
  DisplayOnReviewConditional
95
95
  ]).meta({
96
- description: "Field conditional configuration",
97
- id: "FieldConditional"
96
+ id: "FieldConditional",
97
+ description: "Conditional gating whether a form field is shown (SHOW), enabled (ENABLE), or displayed on the review page (DISPLAY_ON_REVIEW). When omitted, the field is shown and enabled for everyone, and is displayed on review whenever it has a value."
98
98
  });
99
99
 
100
100
  // ../commons/src/events/TranslationConfig.ts
@@ -206,6 +206,11 @@ var FieldTypesToHideInReview = [
206
206
  FieldType.ALPHA_PRINT_BUTTON,
207
207
  FieldType.ALPHA_HIDDEN
208
208
  ];
209
+ var HiddenFieldTypes = [
210
+ FieldType.HTTP,
211
+ FieldType.QUERY_PARAM_READER,
212
+ FieldType.ALPHA_HIDDEN
213
+ ];
209
214
 
210
215
  // ../commons/src/events/FieldValue.ts
211
216
  var z7 = __toESM(require("zod/v4"));
@@ -324,7 +329,7 @@ var PlainDate = import_zod.z.string().date().brand("PlainDate").describe("Date i
324
329
  // ../commons/src/events/FieldValue.ts
325
330
  var TextValue = z7.string();
326
331
  var HiddenFieldValue = z7.string();
327
- var NonEmptyTextValue = TextValue.min(1);
332
+ var NonEmptyTextValue = z7.string().trim().min(1);
328
333
  var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
329
334
  var AgeValue = z7.object({
330
335
  age: z7.number(),
@@ -353,6 +358,7 @@ var DateRangeFieldValue = z7.object({
353
358
  var EmailValue = z7.email();
354
359
  var CheckboxFieldValue = z7.boolean();
355
360
  var NumberFieldValue = z7.number();
361
+ var SignatureFieldValue = FileFieldValue;
356
362
  var ButtonFieldValue = z7.number();
357
363
  var VerificationStatusValue = z7.enum([
358
364
  "verified",
@@ -989,8 +995,9 @@ var RequestedCorrectionAction = ActionBase.extend(
989
995
  var ApprovedCorrectionAction = ActionBase.extend(
990
996
  z13.object({
991
997
  type: z13.literal(ActionType.APPROVE_CORRECTION),
992
- requestId: z13.string()
998
+ requestId: z13.string(),
993
999
  // TODO move into 'content' property
1000
+ content: z13.object({ immediateCorrection: z13.boolean().optional() }).optional()
994
1001
  }).shape
995
1002
  );
996
1003
  var RejectedCorrectionAction = ActionBase.extend(
@@ -1083,8 +1090,8 @@ var FlagConfig = z14.object({
1083
1090
  ),
1084
1091
  label: TranslationConfig.describe("Human readable label of the flag.")
1085
1092
  }).meta({
1086
- description: "Flag configuration",
1087
- id: "FlagConfig"
1093
+ id: "FlagConfig",
1094
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1088
1095
  });
1089
1096
  var ActionFlagConfig = z14.object({
1090
1097
  id: Flag,
@@ -1093,8 +1100,8 @@ var ActionFlagConfig = z14.object({
1093
1100
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1094
1101
  )
1095
1102
  }).meta({
1096
- description: "Action flag configuration",
1097
- id: "ActionFlagConfig"
1103
+ id: "ActionFlagConfig",
1104
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1098
1105
  });
1099
1106
 
1100
1107
  // ../commons/src/events/EventMetadata.ts
@@ -1253,7 +1260,8 @@ var Range = import_v4.z.object({
1253
1260
  });
1254
1261
  var ContainsFlags = import_v4.z.object({
1255
1262
  anyOf: import_v4.z.array(Flag).optional(),
1256
- noneOf: import_v4.z.array(Flag).optional()
1263
+ noneOf: import_v4.z.array(Flag).optional(),
1264
+ allOf: import_v4.z.array(Flag).optional()
1257
1265
  }).meta({
1258
1266
  id: "ContainsFlags"
1259
1267
  });
@@ -1410,11 +1418,28 @@ var FieldReference = import_v43.default.object({
1410
1418
  $$field: FieldId.describe("Id of the field to reference"),
1411
1419
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1412
1420
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1421
+ ),
1422
+ $$code: import_v43.default.string().optional().describe(
1423
+ "Serialised client-side function body. When present the expression is evaluated rather than dereferenced."
1424
+ )
1425
+ }).describe(
1426
+ "Reference to a field value, with an optional client-side computation applied."
1427
+ );
1428
+ var ComputedDefaultValue = import_v43.default.object({
1429
+ $$code: import_v43.default.string().describe(
1430
+ "Serialised client-side function body. Receives (undefined, context) where context includes $now, $online, and system variables."
1413
1431
  )
1414
- }).describe("Reference to a field by its ID");
1432
+ }).describe("A context-only computation used as a field default value.");
1415
1433
  var ValidationConfig = import_v43.default.object({
1416
- validator: Conditional,
1417
- message: TranslationConfig
1434
+ validator: Conditional.describe(
1435
+ "Conditional expression that must hold for the field value to be considered valid."
1436
+ ),
1437
+ message: TranslationConfig.describe(
1438
+ "Error message displayed when the validator does not hold."
1439
+ )
1440
+ }).meta({
1441
+ id: "ValidationConfig",
1442
+ description: "Validation rule applied to a form field. The validator is a conditional expression that must hold for the field value to be considered valid."
1418
1443
  });
1419
1444
  var requiredSchema = import_v43.default.union([
1420
1445
  import_v43.default.boolean(),
@@ -1445,7 +1470,7 @@ var BaseField = import_v43.default.object({
1445
1470
  "Indicates whether the field can be modified during record correction."
1446
1471
  ),
1447
1472
  value: FieldReference.or(import_v43.default.array(FieldReference)).optional().describe(
1448
- "Reference to the source field or fields. When a value is defined, it is copied from the parent field when changed. If multiple references are provided, the first truthy value is used."
1473
+ "Reference to the source field or fields. When a value is defined, it is copied from the parent field when changed. If multiple references are provided, the first truthy value is used. A FieldReference with $$code computes the value via a custom client-side function."
1449
1474
  ),
1450
1475
  analytics: import_v43.default.boolean().default(false).optional().describe(
1451
1476
  "Indicates whether the field is included in analytics. When enabled, its value becomes available in the analytics dashboard."
@@ -1453,30 +1478,40 @@ var BaseField = import_v43.default.object({
1453
1478
  }).describe("Common properties shared across all field types.");
1454
1479
  var Divider = BaseField.extend({
1455
1480
  type: import_v43.default.literal(FieldType.DIVIDER)
1481
+ }).meta({
1482
+ description: "A horizontal line divider",
1483
+ id: "Divider"
1456
1484
  });
1457
1485
  var TextField = BaseField.extend({
1458
1486
  type: import_v43.default.literal(FieldType.TEXT),
1459
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1487
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1460
1488
  configuration: import_v43.default.object({
1461
1489
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1462
1490
  type: import_v43.default.enum(["text", "password"]).optional(),
1463
1491
  prefix: TranslationConfig.optional(),
1464
1492
  postfix: TranslationConfig.optional()
1465
1493
  }).default({ type: "text" }).optional()
1466
- }).describe("Text input");
1494
+ }).meta({
1495
+ description: "A text input field",
1496
+ id: "TextField"
1497
+ });
1467
1498
  var NumberField = BaseField.extend({
1468
1499
  type: import_v43.default.literal(FieldType.NUMBER),
1469
- defaultValue: NumberFieldValue.optional(),
1500
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1470
1501
  configuration: import_v43.default.object({
1471
1502
  min: import_v43.default.number().optional().describe("Minimum value"),
1472
1503
  max: import_v43.default.number().optional().describe("Maximum value"),
1504
+ integer: import_v43.default.boolean().optional().describe("When true, only whole numbers are allowed"),
1473
1505
  prefix: TranslationConfig.optional(),
1474
1506
  postfix: TranslationConfig.optional()
1475
1507
  }).optional()
1476
- }).describe("Number input");
1508
+ }).meta({
1509
+ description: "A number input field",
1510
+ id: "NumberField"
1511
+ });
1477
1512
  var TextAreaField = BaseField.extend({
1478
1513
  type: import_v43.default.literal(FieldType.TEXTAREA),
1479
- defaultValue: NonEmptyTextValue.optional(),
1514
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1480
1515
  configuration: import_v43.default.object({
1481
1516
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1482
1517
  rows: import_v43.default.number().optional().describe("Number of visible text lines"),
@@ -1484,7 +1519,10 @@ var TextAreaField = BaseField.extend({
1484
1519
  prefix: TranslationConfig.optional(),
1485
1520
  postfix: TranslationConfig.optional()
1486
1521
  }).default({ rows: 4 }).optional()
1487
- }).describe("Multiline text input");
1522
+ }).meta({
1523
+ description: "A multiline text input",
1524
+ id: "TextAreaField"
1525
+ });
1488
1526
  var ImageMimeType = import_v43.default.enum([
1489
1527
  "image/png",
1490
1528
  "image/jpg",
@@ -1507,58 +1545,76 @@ var SignatureField = BaseField.extend({
1507
1545
  signaturePromptLabel: TranslationConfig.describe(
1508
1546
  "Title of the signature modal"
1509
1547
  ),
1510
- defaultValue: FieldValue.optional(),
1548
+ defaultValue: SignatureFieldValue.or(ComputedDefaultValue).optional(),
1511
1549
  configuration: import_v43.default.object({
1512
1550
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1513
1551
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature")
1514
1552
  }).default({
1515
1553
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1516
1554
  })
1517
- }).describe("Signature input field");
1555
+ }).meta({
1556
+ description: "A signature input field",
1557
+ id: "SignatureField"
1558
+ });
1518
1559
  var EmailField = BaseField.extend({
1519
1560
  type: import_v43.default.literal(FieldType.EMAIL),
1520
1561
  configuration: import_v43.default.object({
1521
1562
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1522
1563
  }).default({ maxLength: 255 }).optional(),
1523
- defaultValue: NonEmptyTextValue.optional()
1564
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional()
1565
+ }).meta({
1566
+ description: "An email input field",
1567
+ id: "EmailField"
1524
1568
  });
1525
1569
  var DateField = BaseField.extend({
1526
1570
  type: import_v43.default.literal(FieldType.DATE),
1527
- defaultValue: SerializedNowDateTime.or(PlainDate).optional().describe("Default date value(yyyy-MM-dd)"),
1571
+ defaultValue: SerializedNowDateTime.or(PlainDate).or(ComputedDefaultValue).optional().describe("Default date value(yyyy-MM-dd)"),
1528
1572
  configuration: import_v43.default.object({
1529
1573
  notice: TranslationConfig.describe(
1530
1574
  "Text to display above the date input"
1531
1575
  ).optional()
1532
1576
  }).optional()
1533
- }).describe("A single date input (yyyy-MM-dd)");
1577
+ }).meta({
1578
+ description: "A date input (yyyy-MM-dd)",
1579
+ id: "DateField"
1580
+ });
1534
1581
  var AgeField = BaseField.extend({
1535
1582
  type: import_v43.default.literal(FieldType.AGE),
1536
- defaultValue: NumberFieldValue.optional(),
1583
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1537
1584
  configuration: import_v43.default.object({
1538
1585
  asOfDate: FieldReference,
1539
1586
  prefix: TranslationConfig.optional(),
1540
1587
  postfix: TranslationConfig.optional()
1541
1588
  })
1542
- }).describe("An age input field which uses the current date as the asOfDate");
1589
+ }).meta({
1590
+ description: "An age input field which uses the current date as the asOfDate",
1591
+ id: "AgeField"
1592
+ });
1543
1593
  var TimeField = BaseField.extend({
1544
1594
  type: import_v43.default.literal(FieldType.TIME),
1545
- defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
1595
+ defaultValue: SerializedNowDateTime.or(TimeValue).or(ComputedDefaultValue).optional().describe("Default time value (HH-mm)"),
1546
1596
  configuration: import_v43.default.object({
1547
1597
  use12HourFormat: import_v43.default.boolean().optional().describe("Whether to use 12-hour format"),
1548
1598
  notice: TranslationConfig.describe(
1549
1599
  "Text to display above the time input"
1550
1600
  ).optional()
1551
1601
  }).optional()
1552
- }).describe("A single date input (HH-mm)");
1602
+ }).meta({
1603
+ description: "A single time input (HH-mm)",
1604
+ id: "TimeField"
1605
+ });
1553
1606
  var DateRangeField = BaseField.extend({
1554
1607
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1555
- defaultValue: DateRangeFieldValue.optional(),
1608
+ defaultValue: DateRangeFieldValue.or(ComputedDefaultValue).optional(),
1556
1609
  configuration: import_v43.default.object({
1557
1610
  notice: TranslationConfig.describe(
1558
1611
  "Text to display above the date input"
1559
1612
  ).optional()
1560
1613
  }).optional()
1561
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
1614
+ }).meta({
1615
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
1616
+ id: "DateRangeField"
1617
+ });
1562
1618
  var HtmlFontVariant = import_v43.default.enum([
1563
1619
  "reg12",
1564
1620
  "reg14",
@@ -1602,21 +1658,33 @@ var ImageViewField = BaseField.extend({
1602
1658
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1603
1659
  defaultValue: NonEmptyTextValue.optional(),
1604
1660
  configuration: ImageConfiguration
1605
- }).describe("A read-only image component for form pages");
1661
+ }).meta({
1662
+ description: "A read-only image component for form pages",
1663
+ id: "ImageViewField"
1664
+ });
1606
1665
  var Paragraph = BaseField.extend({
1607
1666
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1608
1667
  configuration: ParagraphConfiguration
1609
- }).describe("A read-only HTML <p> paragraph");
1668
+ }).meta({
1669
+ description: "A read-only HTML <p> paragraph",
1670
+ id: "Paragraph"
1671
+ });
1610
1672
  var Heading = BaseField.extend({
1611
1673
  type: import_v43.default.literal(FieldType.HEADING),
1612
1674
  configuration: HeadingConfiguration
1613
- }).describe("A read-only heading component for form pages");
1675
+ }).meta({
1676
+ description: "A read-only heading component for form pages",
1677
+ id: "Heading"
1678
+ });
1614
1679
  var PageHeader = BaseField.extend({
1615
1680
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1616
- }).describe("A read-only header component for form pages");
1681
+ }).meta({
1682
+ description: "A read-only header component for form pages",
1683
+ id: "PageHeader"
1684
+ });
1617
1685
  var File = BaseField.extend({
1618
1686
  type: import_v43.default.literal(FieldType.FILE),
1619
- defaultValue: FileFieldValue.optional(),
1687
+ defaultValue: FileFieldValue.or(ComputedDefaultValue).optional(),
1620
1688
  configuration: import_v43.default.object({
1621
1689
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1622
1690
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature"),
@@ -1632,7 +1700,10 @@ var File = BaseField.extend({
1632
1700
  }).default({
1633
1701
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1634
1702
  })
1635
- }).describe("File upload");
1703
+ }).meta({
1704
+ description: "A file upload field",
1705
+ id: "File"
1706
+ });
1636
1707
  var SelectOption = import_v43.default.object({
1637
1708
  value: import_v43.default.string().describe("The value of the option"),
1638
1709
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1640,7 +1711,7 @@ var SelectOption = import_v43.default.object({
1640
1711
  });
1641
1712
  var NumberWithUnitField = BaseField.extend({
1642
1713
  type: import_v43.default.literal(FieldType.NUMBER_WITH_UNIT),
1643
- defaultValue: NumberWithUnitFieldValue.optional(),
1714
+ defaultValue: NumberWithUnitFieldValue.or(ComputedDefaultValue).optional(),
1644
1715
  options: import_v43.default.array(SelectOption).describe("A list of options for the unit select"),
1645
1716
  configuration: import_v43.default.object({
1646
1717
  min: import_v43.default.number().optional().describe("Minimum value of the number field"),
@@ -1649,17 +1720,23 @@ var NumberWithUnitField = BaseField.extend({
1649
1720
  "Placeholder for the number field"
1650
1721
  )
1651
1722
  }).optional()
1652
- }).describe("Number with unit input");
1723
+ }).meta({
1724
+ description: "A number with unit input field",
1725
+ id: "NumberWithUnitField"
1726
+ });
1653
1727
  var RadioGroup = BaseField.extend({
1654
1728
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1655
- defaultValue: TextValue.optional(),
1729
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1656
1730
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1657
1731
  configuration: import_v43.default.object({
1658
1732
  styles: import_v43.default.object({
1659
1733
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1660
1734
  }).optional()
1661
1735
  }).optional()
1662
- }).describe("Grouped radio options");
1736
+ }).meta({
1737
+ description: "A grouped radio button field",
1738
+ id: "RadioGroup"
1739
+ });
1663
1740
  var BulletList = BaseField.extend({
1664
1741
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1665
1742
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1668,10 +1745,13 @@ var BulletList = BaseField.extend({
1668
1745
  fontVariant: HtmlFontVariant.optional()
1669
1746
  }).optional()
1670
1747
  }).default({})
1671
- }).describe("A list of bullet points");
1748
+ }).meta({
1749
+ description: "A list of bullet points",
1750
+ id: "BulletList"
1751
+ });
1672
1752
  var Select = BaseField.extend({
1673
1753
  type: import_v43.default.literal(FieldType.SELECT),
1674
- defaultValue: TextValue.optional(),
1754
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1675
1755
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1676
1756
  noOptionsMessage: TranslationConfig.optional().describe(
1677
1757
  `
@@ -1683,16 +1763,22 @@ var Select = BaseField.extend({
1683
1763
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1684
1764
  `
1685
1765
  )
1686
- }).describe("Select input");
1766
+ }).meta({
1767
+ description: "A select input field",
1768
+ id: "Select"
1769
+ });
1687
1770
  var SelectDateRangeOption = import_v43.default.object({
1688
1771
  value: SelectDateRangeValue.describe("The value of the option"),
1689
1772
  label: TranslationConfig.describe("The label of the option")
1690
1773
  });
1691
1774
  var SelectDateRangeField = BaseField.extend({
1692
1775
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1693
- defaultValue: SelectDateRangeValue.optional(),
1776
+ defaultValue: SelectDateRangeValue.or(ComputedDefaultValue).optional(),
1694
1777
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1695
- }).describe("Select input with date range options");
1778
+ }).meta({
1779
+ description: "A date range selection field",
1780
+ id: "SelectDateRangeField"
1781
+ });
1696
1782
  var NameConfig = import_v43.default.object({
1697
1783
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1698
1784
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1704,7 +1790,7 @@ var NameField = BaseField.extend({
1704
1790
  firstname: SerializedUserField.or(NonEmptyTextValue).optional(),
1705
1791
  middlename: SerializedUserField.or(NonEmptyTextValue).optional(),
1706
1792
  surname: SerializedUserField.or(NonEmptyTextValue).optional()
1707
- }).optional(),
1793
+ }).or(ComputedDefaultValue).optional(),
1708
1794
  configuration: import_v43.default.object({
1709
1795
  name: NameConfig.default({
1710
1796
  firstname: { required: true },
@@ -1723,26 +1809,41 @@ var NameField = BaseField.extend({
1723
1809
  surname: { required: true }
1724
1810
  }
1725
1811
  }).optional()
1726
- }).describe("Name input field");
1812
+ }).meta({
1813
+ description: "A field for entering a persons name",
1814
+ id: "NameField"
1815
+ });
1727
1816
  var PhoneField = BaseField.extend({
1728
- defaultValue: NonEmptyTextValue.optional(),
1817
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1729
1818
  type: import_v43.default.literal(FieldType.PHONE)
1730
- }).describe("Phone input field");
1819
+ }).meta({
1820
+ description: "A field for entering a phone number",
1821
+ id: "PhoneField"
1822
+ });
1731
1823
  var IdField = BaseField.extend({
1732
- defaultValue: NonEmptyTextValue.optional(),
1824
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1733
1825
  type: import_v43.default.literal(FieldType.ID)
1734
- }).describe("ID input field");
1826
+ }).meta({
1827
+ description: "A field for entering an ID",
1828
+ id: "IdField"
1829
+ });
1735
1830
  var Checkbox = BaseField.extend({
1736
1831
  type: import_v43.default.literal(FieldType.CHECKBOX),
1737
- defaultValue: CheckboxFieldValue.default(false)
1738
- }).describe("Boolean checkbox field");
1832
+ defaultValue: CheckboxFieldValue.or(ComputedDefaultValue).default(false)
1833
+ }).meta({
1834
+ description: "A boolean checkbox field",
1835
+ id: "Checkbox"
1836
+ });
1739
1837
  var Country = BaseField.extend({
1740
1838
  type: import_v43.default.literal(FieldType.COUNTRY),
1741
- defaultValue: NonEmptyTextValue.optional(),
1839
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1742
1840
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1743
1841
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1744
1842
  )
1745
- }).describe("Country select field");
1843
+ }).meta({
1844
+ description: "A field for selecting a country",
1845
+ id: "Country"
1846
+ });
1746
1847
  var AllowedLocations = JurisdictionReference.optional().describe(
1747
1848
  "Limits which location options are selectable depending on user jurisdiction and location."
1748
1849
  );
@@ -1751,28 +1852,33 @@ var AdministrativeAreas = import_v43.default.enum([
1751
1852
  "HEALTH_FACILITY",
1752
1853
  "CRVS_OFFICE"
1753
1854
  ]);
1754
- var AdministrativeAreaConfiguration = import_v43.default.object({
1755
- partOf: FieldReference.optional().describe("Parent location"),
1756
- type: AdministrativeAreas,
1757
- allowedLocations: AllowedLocations
1758
- }).describe("Administrative area options");
1759
1855
  var AdministrativeAreaField = BaseField.extend({
1760
1856
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1761
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1762
- configuration: AdministrativeAreaConfiguration
1763
- }).describe("Administrative area input field e.g. facility, office");
1857
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1858
+ configuration: import_v43.default.object({
1859
+ partOf: FieldReference.optional().describe("Parent location"),
1860
+ type: AdministrativeAreas,
1861
+ allowedLocations: AllowedLocations
1862
+ }).describe("Administrative area options")
1863
+ }).meta({
1864
+ description: "Administrative area input field",
1865
+ id: "AdministrativeAreaField"
1866
+ });
1764
1867
  var LocationInput = BaseField.extend({
1765
1868
  type: import_v43.default.literal(FieldType.LOCATION),
1766
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1869
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1767
1870
  configuration: import_v43.default.object({
1768
1871
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1769
1872
  allowedLocations: AllowedLocations
1770
1873
  }).optional()
1771
- }).describe("Input field for a location");
1874
+ }).meta({
1875
+ description: "A field for selecting a location",
1876
+ id: "LocationInput"
1877
+ });
1772
1878
  var FileUploadWithOptions = BaseField.extend({
1773
1879
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1774
1880
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1775
- defaultValue: FileFieldWithOptionValue.optional(),
1881
+ defaultValue: FileFieldWithOptionValue.or(ComputedDefaultValue).optional(),
1776
1882
  configuration: import_v43.default.object({
1777
1883
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1778
1884
  maxImageSize: import_v43.default.object({
@@ -1782,15 +1888,18 @@ var FileUploadWithOptions = BaseField.extend({
1782
1888
  }).default({
1783
1889
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1784
1890
  })
1891
+ }).meta({
1892
+ description: "A field for uploading files with file type options",
1893
+ id: "FileUploadWithOptions"
1785
1894
  });
1786
1895
  var Facility = BaseField.extend({
1787
1896
  type: import_v43.default.literal(FieldType.FACILITY),
1788
- defaultValue: NonEmptyTextValue.optional(),
1897
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1789
1898
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1790
1899
  }).describe("Input field for a facility");
1791
1900
  var Office = BaseField.extend({
1792
1901
  type: import_v43.default.literal(FieldType.OFFICE),
1793
- defaultValue: NonEmptyTextValue.optional(),
1902
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1794
1903
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1795
1904
  }).describe("Input field for an office");
1796
1905
  var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
@@ -1826,8 +1935,11 @@ var Address = BaseField.extend({
1826
1935
  ).optional(),
1827
1936
  allowedLocations: AllowedLocations
1828
1937
  }).optional(),
1829
- defaultValue: DefaultAddressFieldValue.optional()
1830
- }).describe("Address input field \u2013 a combination of location and text fields");
1938
+ defaultValue: DefaultAddressFieldValue.or(ComputedDefaultValue).optional()
1939
+ }).meta({
1940
+ description: "Address input field \u2013 a combination of location and text fields",
1941
+ id: "Address"
1942
+ });
1831
1943
  var StaticDataEntry = import_v43.default.object({
1832
1944
  id: import_v43.default.string().describe("ID for the data entry."),
1833
1945
  label: TranslationConfig,
@@ -1842,7 +1954,10 @@ var DataField = BaseField.extend({
1842
1954
  subtitle: TranslationConfig.optional(),
1843
1955
  data: import_v43.default.array(DataEntry)
1844
1956
  })
1845
- }).describe("Data field for displaying read-only data");
1957
+ }).meta({
1958
+ description: "A field for displaying a table of read-only data",
1959
+ id: "DataField"
1960
+ });
1846
1961
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1847
1962
  var ButtonType = import_v43.default.enum([
1848
1963
  "primary",
@@ -1867,13 +1982,19 @@ var ButtonConfiguration = import_v43.default.object({
1867
1982
  });
1868
1983
  var ButtonField = BaseField.extend({
1869
1984
  type: import_v43.default.literal(FieldType.BUTTON),
1870
- defaultValue: ButtonFieldValue.optional(),
1985
+ defaultValue: ButtonFieldValue.or(ComputedDefaultValue).optional(),
1871
1986
  configuration: ButtonConfiguration
1872
- }).describe("Generic button without any built-in functionality");
1987
+ }).meta({
1988
+ description: "A generic button that can be used to trigger an action",
1989
+ id: "ButtonField"
1990
+ });
1873
1991
  var FieldGroup = BaseField.extend({
1874
1992
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1875
1993
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1876
1994
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
1995
+ }).meta({
1996
+ description: "A group of fields that are displayed together",
1997
+ id: "FieldGroup"
1877
1998
  });
1878
1999
  var AlphaPrintButton = BaseField.extend({
1879
2000
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1883,10 +2004,13 @@ var AlphaPrintButton = BaseField.extend({
1883
2004
  "Label for the print button"
1884
2005
  )
1885
2006
  })
1886
- }).describe("Print button field for printing certificates");
2007
+ }).meta({
2008
+ description: "An experimental print button field for printing certificates during the declaration process",
2009
+ id: "AlphaPrintButton"
2010
+ });
1887
2011
  var HttpField = BaseField.extend({
1888
2012
  type: import_v43.default.literal(FieldType.HTTP),
1889
- defaultValue: HttpFieldValue.optional(),
2013
+ defaultValue: HttpFieldValue.or(ComputedDefaultValue).optional(),
1890
2014
  configuration: import_v43.default.object({
1891
2015
  trigger: FieldReference.optional().describe(
1892
2016
  "Reference to the field that triggers the HTTP request when its value changes. If not provided, the HTTP request is triggered once on component mount."
@@ -1899,20 +2023,30 @@ var HttpField = BaseField.extend({
1899
2023
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1900
2024
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1901
2025
  })
1902
- }).describe("HTTP request function triggered by a button click or other event");
2026
+ }).meta({
2027
+ description: "Makes a background HTTP request to an external service and stores the response so other fields can use it. Has no visible UI \u2014 pair with LOADER to show request status.",
2028
+ id: "HttpField"
2029
+ });
1903
2030
  var AutocompleteField = BaseField.extend({
1904
2031
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1905
2032
  configuration: import_v43.default.object({
1906
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2033
+ url: import_v43.default.string().describe(
2034
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2035
+ ).optional(),
1907
2036
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1908
2037
  defaultOptions: import_v43.default.array(
1909
2038
  import_v43.default.object({
1910
2039
  label: import_v43.default.string(),
1911
2040
  value: import_v43.default.string()
1912
2041
  })
1913
- ).optional()
2042
+ ).optional().describe(
2043
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2044
+ )
1914
2045
  })
1915
- }).describe("Autocomplete input field");
2046
+ }).meta({
2047
+ description: "Generic autocomplete component designed for use with large dictionary-based datasets. The component supports dynamic retrieval of options from configurable data sources and is intended for datasets that may contain tens or hundreds of thousands of records.",
2048
+ id: "AutocompleteField"
2049
+ });
1916
2050
  var SearchField = HttpField.extend({
1917
2051
  type: import_v43.default.literal(FieldType.SEARCH),
1918
2052
  configuration: SearchQuery.pick({
@@ -1945,6 +2079,9 @@ var SearchField = HttpField.extend({
1945
2079
  ok: TranslationConfig.optional()
1946
2080
  }).optional()
1947
2081
  })
2082
+ }).meta({
2083
+ description: "A search input field",
2084
+ id: "SearchField"
1948
2085
  });
1949
2086
  var LinkButtonField = BaseField.extend({
1950
2087
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1953,28 +2090,35 @@ var LinkButtonField = BaseField.extend({
1953
2090
  text: TranslationConfig.describe("Text to display on the button"),
1954
2091
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1955
2092
  })
1956
- }).describe("Button that opens a link");
2093
+ }).meta({
2094
+ description: "A button that opens a URL link",
2095
+ id: "LinkButtonField"
2096
+ });
1957
2097
  var VerificationStatus = BaseField.extend({
1958
2098
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1959
- defaultValue: VerificationStatusValue.optional(),
2099
+ defaultValue: VerificationStatusValue.or(ComputedDefaultValue).optional(),
1960
2100
  configuration: import_v43.default.object({
1961
2101
  status: TranslationConfig.describe("Text to display on the status pill."),
1962
2102
  description: TranslationConfig.describe(
1963
2103
  "Explaining text on the banner in form."
1964
2104
  )
1965
2105
  })
2106
+ }).meta({
2107
+ description: "Displays a verification state (e.g. ID verified / pending). Often paired with ID_READER \u2014 it can read its value off an ID_READER rather than holding its own.",
2108
+ id: "VerificationStatus"
1966
2109
  });
1967
2110
  var QueryParamReaderField = BaseField.extend({
1968
2111
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1969
2112
  configuration: import_v43.default.object({
1970
2113
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1971
2114
  })
1972
- }).describe(
1973
- "A field that maps URL query params into form values and clears them afterward"
1974
- );
2115
+ }).meta({
2116
+ description: "A field that maps URL query params into form values and clears them afterward",
2117
+ id: "QueryParamReaderField"
2118
+ });
1975
2119
  var QrReaderField = BaseField.extend({
1976
2120
  type: import_v43.default.literal(FieldType.QR_READER),
1977
- defaultValue: QrReaderFieldValue.optional(),
2121
+ defaultValue: QrReaderFieldValue.or(ComputedDefaultValue).optional(),
1978
2122
  configuration: import_v43.default.object({
1979
2123
  validator: import_v43.default.any().meta({
1980
2124
  description: "JSON Schema to validate the scanned QR code data against before populating the form fields.",
@@ -1982,21 +2126,27 @@ var QrReaderField = BaseField.extend({
1982
2126
  })
1983
2127
  }).optional()
1984
2128
  }).meta({
1985
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2129
+ description: "QR code reader field, including optional JSON Schema validator.",
1986
2130
  id: "QrReaderField"
1987
2131
  });
1988
2132
  var IdReaderField = BaseField.extend({
1989
2133
  type: import_v43.default.literal(FieldType.ID_READER),
1990
- defaultValue: IdReaderFieldValue.optional(),
2134
+ defaultValue: IdReaderFieldValue.or(ComputedDefaultValue).optional(),
1991
2135
  methods: import_v43.default.array(
1992
2136
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1993
2137
  )
2138
+ }).meta({
2139
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2140
+ id: "IdReaderField"
1994
2141
  });
1995
2142
  var CustomField = BaseField.extend({
1996
2143
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1997
2144
  defaultValue: CustomFieldValue.optional(),
1998
2145
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1999
2146
  configuration: import_v43.default.unknown().optional()
2147
+ }).meta({
2148
+ description: "An expiremental custom field that is defined by a module source path",
2149
+ id: "CustomField"
2000
2150
  });
2001
2151
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2002
2152
  var LoaderField = BaseField.extend({
@@ -2006,22 +2156,25 @@ var LoaderField = BaseField.extend({
2006
2156
  configuration: import_v43.default.object({
2007
2157
  text: TranslationConfig.describe("Display text above the loading spinner")
2008
2158
  })
2009
- }).describe(
2010
- "A non-interactive field that indicates an in progress operation in form"
2011
- );
2159
+ }).meta({
2160
+ description: "A non-interactive field that indicates an in progress operation in form",
2161
+ id: "LoaderField"
2162
+ });
2012
2163
  var HiddenField = BaseField.extend({
2013
2164
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2014
2165
  required: import_v43.default.boolean().default(false).optional(),
2015
2166
  defaultValue: TextValue.optional()
2016
- }).describe(
2017
- "A non-interactive, hidden field that only hold a value in the form"
2018
- );
2167
+ }).meta({
2168
+ description: "A non-interactive, hidden field that only hold a value in the form",
2169
+ id: "HiddenField"
2170
+ });
2019
2171
  var UserRoleField = BaseField.extend({
2020
2172
  type: import_v43.default.literal(FieldType.USER_ROLE),
2021
2173
  defaultValue: TextValue.optional()
2022
- }).describe(
2023
- "A select dropdown that is automatically populated with available user roles"
2024
- );
2174
+ }).meta({
2175
+ description: "A select dropdown that is automatically populated with available user roles",
2176
+ id: "UserRoleField"
2177
+ });
2025
2178
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2026
2179
  FieldGroup,
2027
2180
  Address,
@@ -2139,6 +2292,7 @@ var ClientConfig = z20.object({
2139
2292
  COUNTRY: z20.string(),
2140
2293
  LANGUAGES: z20.array(z20.string()),
2141
2294
  SENTRY: z20.string().optional(),
2295
+ LOGIN_URL: z20.string().optional(),
2142
2296
  REGISTER_BACKGROUND: BackgroundConfig,
2143
2297
  DASHBOARDS: z20.array(
2144
2298
  z20.object({