@opencrvs/toolkit 2.0.0-rc.85c0047 → 2.0.0-rc.86e800a

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.
@@ -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
@@ -324,7 +324,7 @@ var PlainDate = import_zod.z.string().date().brand("PlainDate").describe("Date i
324
324
  // ../commons/src/events/FieldValue.ts
325
325
  var TextValue = z7.string();
326
326
  var HiddenFieldValue = z7.string();
327
- var NonEmptyTextValue = TextValue.min(1);
327
+ var NonEmptyTextValue = z7.string().trim().min(1);
328
328
  var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
329
329
  var AgeValue = z7.object({
330
330
  age: z7.number(),
@@ -353,6 +353,7 @@ var DateRangeFieldValue = z7.object({
353
353
  var EmailValue = z7.email();
354
354
  var CheckboxFieldValue = z7.boolean();
355
355
  var NumberFieldValue = z7.number();
356
+ var SignatureFieldValue = FileFieldValue;
356
357
  var ButtonFieldValue = z7.number();
357
358
  var VerificationStatusValue = z7.enum([
358
359
  "verified",
@@ -834,7 +835,9 @@ var ScopeType = z11.enum([
834
835
  var EncodedScope = z11.string().brand("EncodedScope");
835
836
  var DEFAULT_SCOPE_OPTIONS = {
836
837
  placeOfEvent: JurisdictionFilter.enum.all,
837
- accessLevel: JurisdictionFilter.enum.all
838
+ accessLevel: JurisdictionFilter.enum.all,
839
+ registeredIn: JurisdictionFilter.enum.all,
840
+ declaredIn: JurisdictionFilter.enum.all
838
841
  };
839
842
 
840
843
  // ../commons/src/authentication.ts
@@ -987,8 +990,9 @@ var RequestedCorrectionAction = ActionBase.extend(
987
990
  var ApprovedCorrectionAction = ActionBase.extend(
988
991
  z13.object({
989
992
  type: z13.literal(ActionType.APPROVE_CORRECTION),
990
- requestId: z13.string()
993
+ requestId: z13.string(),
991
994
  // TODO move into 'content' property
995
+ content: z13.object({ immediateCorrection: z13.boolean().optional() }).optional()
992
996
  }).shape
993
997
  );
994
998
  var RejectedCorrectionAction = ActionBase.extend(
@@ -1081,8 +1085,8 @@ var FlagConfig = z14.object({
1081
1085
  ),
1082
1086
  label: TranslationConfig.describe("Human readable label of the flag.")
1083
1087
  }).meta({
1084
- description: "Flag configuration",
1085
- id: "FlagConfig"
1088
+ id: "FlagConfig",
1089
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1086
1090
  });
1087
1091
  var ActionFlagConfig = z14.object({
1088
1092
  id: Flag,
@@ -1091,8 +1095,8 @@ var ActionFlagConfig = z14.object({
1091
1095
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1092
1096
  )
1093
1097
  }).meta({
1094
- description: "Action flag configuration",
1095
- id: "ActionFlagConfig"
1098
+ id: "ActionFlagConfig",
1099
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1096
1100
  });
1097
1101
 
1098
1102
  // ../commons/src/events/EventMetadata.ts
@@ -1405,14 +1409,31 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1405
1409
  }
1406
1410
  }).describe("Unique identifier for the field");
1407
1411
  var FieldReference = import_v43.default.object({
1408
- $$field: FieldId,
1412
+ $$field: FieldId.describe("Id of the field to reference"),
1409
1413
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1410
1414
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1415
+ ),
1416
+ $$code: import_v43.default.string().optional().describe(
1417
+ "Serialised client-side function body. When present the expression is evaluated rather than dereferenced."
1411
1418
  )
1412
- }).describe("Reference to a field by its ID");
1419
+ }).describe(
1420
+ "Reference to a field value, with an optional client-side computation applied."
1421
+ );
1422
+ var ComputedDefaultValue = import_v43.default.object({
1423
+ $$code: import_v43.default.string().describe(
1424
+ "Serialised client-side function body. Receives (undefined, context) where context includes $now, $online, and system variables."
1425
+ )
1426
+ }).describe("A context-only computation used as a field default value.");
1413
1427
  var ValidationConfig = import_v43.default.object({
1414
- validator: Conditional,
1415
- message: TranslationConfig
1428
+ validator: Conditional.describe(
1429
+ "Conditional expression that must hold for the field value to be considered valid."
1430
+ ),
1431
+ message: TranslationConfig.describe(
1432
+ "Error message displayed when the validator does not hold."
1433
+ )
1434
+ }).meta({
1435
+ id: "ValidationConfig",
1436
+ 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."
1416
1437
  });
1417
1438
  var requiredSchema = import_v43.default.union([
1418
1439
  import_v43.default.boolean(),
@@ -1443,7 +1464,7 @@ var BaseField = import_v43.default.object({
1443
1464
  "Indicates whether the field can be modified during record correction."
1444
1465
  ),
1445
1466
  value: FieldReference.or(import_v43.default.array(FieldReference)).optional().describe(
1446
- "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."
1467
+ "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."
1447
1468
  ),
1448
1469
  analytics: import_v43.default.boolean().default(false).optional().describe(
1449
1470
  "Indicates whether the field is included in analytics. When enabled, its value becomes available in the analytics dashboard."
@@ -1451,30 +1472,39 @@ var BaseField = import_v43.default.object({
1451
1472
  }).describe("Common properties shared across all field types.");
1452
1473
  var Divider = BaseField.extend({
1453
1474
  type: import_v43.default.literal(FieldType.DIVIDER)
1475
+ }).meta({
1476
+ description: "A horizontal line divider",
1477
+ id: "Divider"
1454
1478
  });
1455
1479
  var TextField = BaseField.extend({
1456
1480
  type: import_v43.default.literal(FieldType.TEXT),
1457
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1481
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1458
1482
  configuration: import_v43.default.object({
1459
1483
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1460
1484
  type: import_v43.default.enum(["text", "password"]).optional(),
1461
1485
  prefix: TranslationConfig.optional(),
1462
1486
  postfix: TranslationConfig.optional()
1463
1487
  }).default({ type: "text" }).optional()
1464
- }).describe("Text input");
1488
+ }).meta({
1489
+ description: "A text input field",
1490
+ id: "TextField"
1491
+ });
1465
1492
  var NumberField = BaseField.extend({
1466
1493
  type: import_v43.default.literal(FieldType.NUMBER),
1467
- defaultValue: NumberFieldValue.optional(),
1494
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1468
1495
  configuration: import_v43.default.object({
1469
1496
  min: import_v43.default.number().optional().describe("Minimum value"),
1470
1497
  max: import_v43.default.number().optional().describe("Maximum value"),
1471
1498
  prefix: TranslationConfig.optional(),
1472
1499
  postfix: TranslationConfig.optional()
1473
1500
  }).optional()
1474
- }).describe("Number input");
1501
+ }).meta({
1502
+ description: "A number input field",
1503
+ id: "NumberField"
1504
+ });
1475
1505
  var TextAreaField = BaseField.extend({
1476
1506
  type: import_v43.default.literal(FieldType.TEXTAREA),
1477
- defaultValue: NonEmptyTextValue.optional(),
1507
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1478
1508
  configuration: import_v43.default.object({
1479
1509
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
1480
1510
  rows: import_v43.default.number().optional().describe("Number of visible text lines"),
@@ -1482,7 +1512,10 @@ var TextAreaField = BaseField.extend({
1482
1512
  prefix: TranslationConfig.optional(),
1483
1513
  postfix: TranslationConfig.optional()
1484
1514
  }).default({ rows: 4 }).optional()
1485
- }).describe("Multiline text input");
1515
+ }).meta({
1516
+ description: "A multiline text input",
1517
+ id: "TextAreaField"
1518
+ });
1486
1519
  var ImageMimeType = import_v43.default.enum([
1487
1520
  "image/png",
1488
1521
  "image/jpg",
@@ -1505,58 +1538,76 @@ var SignatureField = BaseField.extend({
1505
1538
  signaturePromptLabel: TranslationConfig.describe(
1506
1539
  "Title of the signature modal"
1507
1540
  ),
1508
- defaultValue: FieldValue.optional(),
1541
+ defaultValue: SignatureFieldValue.or(ComputedDefaultValue).optional(),
1509
1542
  configuration: import_v43.default.object({
1510
1543
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1511
1544
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature")
1512
1545
  }).default({
1513
1546
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1514
1547
  })
1515
- }).describe("Signature input field");
1548
+ }).meta({
1549
+ description: "A signature input field",
1550
+ id: "SignatureField"
1551
+ });
1516
1552
  var EmailField = BaseField.extend({
1517
1553
  type: import_v43.default.literal(FieldType.EMAIL),
1518
1554
  configuration: import_v43.default.object({
1519
1555
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1520
1556
  }).default({ maxLength: 255 }).optional(),
1521
- defaultValue: NonEmptyTextValue.optional()
1557
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional()
1558
+ }).meta({
1559
+ description: "An email input field",
1560
+ id: "EmailField"
1522
1561
  });
1523
1562
  var DateField = BaseField.extend({
1524
1563
  type: import_v43.default.literal(FieldType.DATE),
1525
- defaultValue: SerializedNowDateTime.or(PlainDate).optional().describe("Default date value(yyyy-MM-dd)"),
1564
+ defaultValue: SerializedNowDateTime.or(PlainDate).or(ComputedDefaultValue).optional().describe("Default date value(yyyy-MM-dd)"),
1526
1565
  configuration: import_v43.default.object({
1527
1566
  notice: TranslationConfig.describe(
1528
1567
  "Text to display above the date input"
1529
1568
  ).optional()
1530
1569
  }).optional()
1531
- }).describe("A single date input (yyyy-MM-dd)");
1570
+ }).meta({
1571
+ description: "A date input (yyyy-MM-dd)",
1572
+ id: "DateField"
1573
+ });
1532
1574
  var AgeField = BaseField.extend({
1533
1575
  type: import_v43.default.literal(FieldType.AGE),
1534
- defaultValue: NumberFieldValue.optional(),
1576
+ defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
1535
1577
  configuration: import_v43.default.object({
1536
1578
  asOfDate: FieldReference,
1537
1579
  prefix: TranslationConfig.optional(),
1538
1580
  postfix: TranslationConfig.optional()
1539
1581
  })
1540
- }).describe("An age input field which uses the current date as the asOfDate");
1582
+ }).meta({
1583
+ description: "An age input field which uses the current date as the asOfDate",
1584
+ id: "AgeField"
1585
+ });
1541
1586
  var TimeField = BaseField.extend({
1542
1587
  type: import_v43.default.literal(FieldType.TIME),
1543
- defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
1588
+ defaultValue: SerializedNowDateTime.or(TimeValue).or(ComputedDefaultValue).optional().describe("Default time value (HH-mm)"),
1544
1589
  configuration: import_v43.default.object({
1545
1590
  use12HourFormat: import_v43.default.boolean().optional().describe("Whether to use 12-hour format"),
1546
1591
  notice: TranslationConfig.describe(
1547
1592
  "Text to display above the time input"
1548
1593
  ).optional()
1549
1594
  }).optional()
1550
- }).describe("A single date input (HH-mm)");
1595
+ }).meta({
1596
+ description: "A single time input (HH-mm)",
1597
+ id: "TimeField"
1598
+ });
1551
1599
  var DateRangeField = BaseField.extend({
1552
1600
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1553
- defaultValue: DateRangeFieldValue.optional(),
1601
+ defaultValue: DateRangeFieldValue.or(ComputedDefaultValue).optional(),
1554
1602
  configuration: import_v43.default.object({
1555
1603
  notice: TranslationConfig.describe(
1556
1604
  "Text to display above the date input"
1557
1605
  ).optional()
1558
1606
  }).optional()
1559
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
1607
+ }).meta({
1608
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
1609
+ id: "DateRangeField"
1610
+ });
1560
1611
  var HtmlFontVariant = import_v43.default.enum([
1561
1612
  "reg12",
1562
1613
  "reg14",
@@ -1600,21 +1651,33 @@ var ImageViewField = BaseField.extend({
1600
1651
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1601
1652
  defaultValue: NonEmptyTextValue.optional(),
1602
1653
  configuration: ImageConfiguration
1603
- }).describe("A read-only image component for form pages");
1654
+ }).meta({
1655
+ description: "A read-only image component for form pages",
1656
+ id: "ImageViewField"
1657
+ });
1604
1658
  var Paragraph = BaseField.extend({
1605
1659
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1606
1660
  configuration: ParagraphConfiguration
1607
- }).describe("A read-only HTML <p> paragraph");
1661
+ }).meta({
1662
+ description: "A read-only HTML <p> paragraph",
1663
+ id: "Paragraph"
1664
+ });
1608
1665
  var Heading = BaseField.extend({
1609
1666
  type: import_v43.default.literal(FieldType.HEADING),
1610
1667
  configuration: HeadingConfiguration
1611
- }).describe("A read-only heading component for form pages");
1668
+ }).meta({
1669
+ description: "A read-only heading component for form pages",
1670
+ id: "Heading"
1671
+ });
1612
1672
  var PageHeader = BaseField.extend({
1613
1673
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1614
- }).describe("A read-only header component for form pages");
1674
+ }).meta({
1675
+ description: "A read-only header component for form pages",
1676
+ id: "PageHeader"
1677
+ });
1615
1678
  var File = BaseField.extend({
1616
1679
  type: import_v43.default.literal(FieldType.FILE),
1617
- defaultValue: FileFieldValue.optional(),
1680
+ defaultValue: FileFieldValue.or(ComputedDefaultValue).optional(),
1618
1681
  configuration: import_v43.default.object({
1619
1682
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1620
1683
  acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature"),
@@ -1630,7 +1693,10 @@ var File = BaseField.extend({
1630
1693
  }).default({
1631
1694
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1632
1695
  })
1633
- }).describe("File upload");
1696
+ }).meta({
1697
+ description: "A file upload field",
1698
+ id: "File"
1699
+ });
1634
1700
  var SelectOption = import_v43.default.object({
1635
1701
  value: import_v43.default.string().describe("The value of the option"),
1636
1702
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1638,7 +1704,7 @@ var SelectOption = import_v43.default.object({
1638
1704
  });
1639
1705
  var NumberWithUnitField = BaseField.extend({
1640
1706
  type: import_v43.default.literal(FieldType.NUMBER_WITH_UNIT),
1641
- defaultValue: NumberWithUnitFieldValue.optional(),
1707
+ defaultValue: NumberWithUnitFieldValue.or(ComputedDefaultValue).optional(),
1642
1708
  options: import_v43.default.array(SelectOption).describe("A list of options for the unit select"),
1643
1709
  configuration: import_v43.default.object({
1644
1710
  min: import_v43.default.number().optional().describe("Minimum value of the number field"),
@@ -1647,17 +1713,23 @@ var NumberWithUnitField = BaseField.extend({
1647
1713
  "Placeholder for the number field"
1648
1714
  )
1649
1715
  }).optional()
1650
- }).describe("Number with unit input");
1716
+ }).meta({
1717
+ description: "A number with unit input field",
1718
+ id: "NumberWithUnitField"
1719
+ });
1651
1720
  var RadioGroup = BaseField.extend({
1652
1721
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1653
- defaultValue: TextValue.optional(),
1722
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1654
1723
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1655
1724
  configuration: import_v43.default.object({
1656
1725
  styles: import_v43.default.object({
1657
1726
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1658
1727
  }).optional()
1659
1728
  }).optional()
1660
- }).describe("Grouped radio options");
1729
+ }).meta({
1730
+ description: "A grouped radio button field",
1731
+ id: "RadioGroup"
1732
+ });
1661
1733
  var BulletList = BaseField.extend({
1662
1734
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1663
1735
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1666,10 +1738,13 @@ var BulletList = BaseField.extend({
1666
1738
  fontVariant: HtmlFontVariant.optional()
1667
1739
  }).optional()
1668
1740
  }).default({})
1669
- }).describe("A list of bullet points");
1741
+ }).meta({
1742
+ description: "A list of bullet points",
1743
+ id: "BulletList"
1744
+ });
1670
1745
  var Select = BaseField.extend({
1671
1746
  type: import_v43.default.literal(FieldType.SELECT),
1672
- defaultValue: TextValue.optional(),
1747
+ defaultValue: TextValue.or(ComputedDefaultValue).optional(),
1673
1748
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1674
1749
  noOptionsMessage: TranslationConfig.optional().describe(
1675
1750
  `
@@ -1681,16 +1756,22 @@ var Select = BaseField.extend({
1681
1756
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1682
1757
  `
1683
1758
  )
1684
- }).describe("Select input");
1759
+ }).meta({
1760
+ description: "A select input field",
1761
+ id: "Select"
1762
+ });
1685
1763
  var SelectDateRangeOption = import_v43.default.object({
1686
1764
  value: SelectDateRangeValue.describe("The value of the option"),
1687
1765
  label: TranslationConfig.describe("The label of the option")
1688
1766
  });
1689
1767
  var SelectDateRangeField = BaseField.extend({
1690
1768
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1691
- defaultValue: SelectDateRangeValue.optional(),
1769
+ defaultValue: SelectDateRangeValue.or(ComputedDefaultValue).optional(),
1692
1770
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1693
- }).describe("Select input with date range options");
1771
+ }).meta({
1772
+ description: "A date range selection field",
1773
+ id: "SelectDateRangeField"
1774
+ });
1694
1775
  var NameConfig = import_v43.default.object({
1695
1776
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1696
1777
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1702,7 +1783,7 @@ var NameField = BaseField.extend({
1702
1783
  firstname: SerializedUserField.or(NonEmptyTextValue).optional(),
1703
1784
  middlename: SerializedUserField.or(NonEmptyTextValue).optional(),
1704
1785
  surname: SerializedUserField.or(NonEmptyTextValue).optional()
1705
- }).optional(),
1786
+ }).or(ComputedDefaultValue).optional(),
1706
1787
  configuration: import_v43.default.object({
1707
1788
  name: NameConfig.default({
1708
1789
  firstname: { required: true },
@@ -1721,26 +1802,41 @@ var NameField = BaseField.extend({
1721
1802
  surname: { required: true }
1722
1803
  }
1723
1804
  }).optional()
1724
- }).describe("Name input field");
1805
+ }).meta({
1806
+ description: "A field for entering a persons name",
1807
+ id: "NameField"
1808
+ });
1725
1809
  var PhoneField = BaseField.extend({
1726
- defaultValue: NonEmptyTextValue.optional(),
1810
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1727
1811
  type: import_v43.default.literal(FieldType.PHONE)
1728
- }).describe("Phone input field");
1812
+ }).meta({
1813
+ description: "A field for entering a phone number",
1814
+ id: "PhoneField"
1815
+ });
1729
1816
  var IdField = BaseField.extend({
1730
- defaultValue: NonEmptyTextValue.optional(),
1817
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1731
1818
  type: import_v43.default.literal(FieldType.ID)
1732
- }).describe("ID input field");
1819
+ }).meta({
1820
+ description: "A field for entering an ID",
1821
+ id: "IdField"
1822
+ });
1733
1823
  var Checkbox = BaseField.extend({
1734
1824
  type: import_v43.default.literal(FieldType.CHECKBOX),
1735
- defaultValue: CheckboxFieldValue.default(false)
1736
- }).describe("Boolean checkbox field");
1825
+ defaultValue: CheckboxFieldValue.or(ComputedDefaultValue).default(false)
1826
+ }).meta({
1827
+ description: "A boolean checkbox field",
1828
+ id: "Checkbox"
1829
+ });
1737
1830
  var Country = BaseField.extend({
1738
1831
  type: import_v43.default.literal(FieldType.COUNTRY),
1739
- defaultValue: NonEmptyTextValue.optional(),
1832
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1740
1833
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1741
1834
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1742
1835
  )
1743
- }).describe("Country select field");
1836
+ }).meta({
1837
+ description: "A field for selecting a country",
1838
+ id: "Country"
1839
+ });
1744
1840
  var AllowedLocations = JurisdictionReference.optional().describe(
1745
1841
  "Limits which location options are selectable depending on user jurisdiction and location."
1746
1842
  );
@@ -1749,28 +1845,33 @@ var AdministrativeAreas = import_v43.default.enum([
1749
1845
  "HEALTH_FACILITY",
1750
1846
  "CRVS_OFFICE"
1751
1847
  ]);
1752
- var AdministrativeAreaConfiguration = import_v43.default.object({
1753
- partOf: FieldReference.optional().describe("Parent location"),
1754
- type: AdministrativeAreas,
1755
- allowedLocations: AllowedLocations
1756
- }).describe("Administrative area options");
1757
1848
  var AdministrativeAreaField = BaseField.extend({
1758
1849
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1759
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1760
- configuration: AdministrativeAreaConfiguration
1761
- }).describe("Administrative area input field e.g. facility, office");
1850
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1851
+ configuration: import_v43.default.object({
1852
+ partOf: FieldReference.optional().describe("Parent location"),
1853
+ type: AdministrativeAreas,
1854
+ allowedLocations: AllowedLocations
1855
+ }).describe("Administrative area options")
1856
+ }).meta({
1857
+ description: "Administrative area input field",
1858
+ id: "AdministrativeAreaField"
1859
+ });
1762
1860
  var LocationInput = BaseField.extend({
1763
1861
  type: import_v43.default.literal(FieldType.LOCATION),
1764
- defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1862
+ defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
1765
1863
  configuration: import_v43.default.object({
1766
1864
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1767
1865
  allowedLocations: AllowedLocations
1768
1866
  }).optional()
1769
- }).describe("Input field for a location");
1867
+ }).meta({
1868
+ description: "A field for selecting a location",
1869
+ id: "LocationInput"
1870
+ });
1770
1871
  var FileUploadWithOptions = BaseField.extend({
1771
1872
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1772
1873
  options: import_v43.default.array(SelectOption).describe("A list of options"),
1773
- defaultValue: FileFieldWithOptionValue.optional(),
1874
+ defaultValue: FileFieldWithOptionValue.or(ComputedDefaultValue).optional(),
1774
1875
  configuration: import_v43.default.object({
1775
1876
  maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
1776
1877
  maxImageSize: import_v43.default.object({
@@ -1780,15 +1881,18 @@ var FileUploadWithOptions = BaseField.extend({
1780
1881
  }).default({
1781
1882
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1782
1883
  })
1884
+ }).meta({
1885
+ description: "A field for uploading files with file type options",
1886
+ id: "FileUploadWithOptions"
1783
1887
  });
1784
1888
  var Facility = BaseField.extend({
1785
1889
  type: import_v43.default.literal(FieldType.FACILITY),
1786
- defaultValue: NonEmptyTextValue.optional(),
1890
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1787
1891
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1788
1892
  }).describe("Input field for a facility");
1789
1893
  var Office = BaseField.extend({
1790
1894
  type: import_v43.default.literal(FieldType.OFFICE),
1791
- defaultValue: NonEmptyTextValue.optional(),
1895
+ defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
1792
1896
  configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
1793
1897
  }).describe("Input field for an office");
1794
1898
  var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
@@ -1824,8 +1928,11 @@ var Address = BaseField.extend({
1824
1928
  ).optional(),
1825
1929
  allowedLocations: AllowedLocations
1826
1930
  }).optional(),
1827
- defaultValue: DefaultAddressFieldValue.optional()
1828
- }).describe("Address input field \u2013 a combination of location and text fields");
1931
+ defaultValue: DefaultAddressFieldValue.or(ComputedDefaultValue).optional()
1932
+ }).meta({
1933
+ description: "Address input field \u2013 a combination of location and text fields",
1934
+ id: "Address"
1935
+ });
1829
1936
  var StaticDataEntry = import_v43.default.object({
1830
1937
  id: import_v43.default.string().describe("ID for the data entry."),
1831
1938
  label: TranslationConfig,
@@ -1840,7 +1947,10 @@ var DataField = BaseField.extend({
1840
1947
  subtitle: TranslationConfig.optional(),
1841
1948
  data: import_v43.default.array(DataEntry)
1842
1949
  })
1843
- }).describe("Data field for displaying read-only data");
1950
+ }).meta({
1951
+ description: "A field for displaying a table of read-only data",
1952
+ id: "DataField"
1953
+ });
1844
1954
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1845
1955
  var ButtonType = import_v43.default.enum([
1846
1956
  "primary",
@@ -1865,13 +1975,19 @@ var ButtonConfiguration = import_v43.default.object({
1865
1975
  });
1866
1976
  var ButtonField = BaseField.extend({
1867
1977
  type: import_v43.default.literal(FieldType.BUTTON),
1868
- defaultValue: ButtonFieldValue.optional(),
1978
+ defaultValue: ButtonFieldValue.or(ComputedDefaultValue).optional(),
1869
1979
  configuration: ButtonConfiguration
1870
- }).describe("Generic button without any built-in functionality");
1980
+ }).meta({
1981
+ description: "A generic button that can be used to trigger an action",
1982
+ id: "ButtonField"
1983
+ });
1871
1984
  var FieldGroup = BaseField.extend({
1872
1985
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1873
1986
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1874
1987
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
1988
+ }).meta({
1989
+ description: "A group of fields that are displayed together",
1990
+ id: "FieldGroup"
1875
1991
  });
1876
1992
  var AlphaPrintButton = BaseField.extend({
1877
1993
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1881,10 +1997,13 @@ var AlphaPrintButton = BaseField.extend({
1881
1997
  "Label for the print button"
1882
1998
  )
1883
1999
  })
1884
- }).describe("Print button field for printing certificates");
2000
+ }).meta({
2001
+ description: "An experimental print button field for printing certificates during the declaration process",
2002
+ id: "AlphaPrintButton"
2003
+ });
1885
2004
  var HttpField = BaseField.extend({
1886
2005
  type: import_v43.default.literal(FieldType.HTTP),
1887
- defaultValue: HttpFieldValue.optional(),
2006
+ defaultValue: HttpFieldValue.or(ComputedDefaultValue).optional(),
1888
2007
  configuration: import_v43.default.object({
1889
2008
  trigger: FieldReference.optional().describe(
1890
2009
  "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."
@@ -1897,20 +2016,30 @@ var HttpField = BaseField.extend({
1897
2016
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1898
2017
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1899
2018
  })
1900
- }).describe("HTTP request function triggered by a button click or other event");
2019
+ }).meta({
2020
+ 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.",
2021
+ id: "HttpField"
2022
+ });
1901
2023
  var AutocompleteField = BaseField.extend({
1902
2024
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1903
2025
  configuration: import_v43.default.object({
1904
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2026
+ url: import_v43.default.string().describe(
2027
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2028
+ ).optional(),
1905
2029
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1906
2030
  defaultOptions: import_v43.default.array(
1907
2031
  import_v43.default.object({
1908
2032
  label: import_v43.default.string(),
1909
2033
  value: import_v43.default.string()
1910
2034
  })
1911
- ).optional()
2035
+ ).optional().describe(
2036
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2037
+ )
1912
2038
  })
1913
- }).describe("Autocomplete input field");
2039
+ }).meta({
2040
+ 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.",
2041
+ id: "AutocompleteField"
2042
+ });
1914
2043
  var SearchField = HttpField.extend({
1915
2044
  type: import_v43.default.literal(FieldType.SEARCH),
1916
2045
  configuration: SearchQuery.pick({
@@ -1943,6 +2072,9 @@ var SearchField = HttpField.extend({
1943
2072
  ok: TranslationConfig.optional()
1944
2073
  }).optional()
1945
2074
  })
2075
+ }).meta({
2076
+ description: "A search input field",
2077
+ id: "SearchField"
1946
2078
  });
1947
2079
  var LinkButtonField = BaseField.extend({
1948
2080
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1951,28 +2083,35 @@ var LinkButtonField = BaseField.extend({
1951
2083
  text: TranslationConfig.describe("Text to display on the button"),
1952
2084
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1953
2085
  })
1954
- }).describe("Button that opens a link");
2086
+ }).meta({
2087
+ description: "A button that opens a URL link",
2088
+ id: "LinkButtonField"
2089
+ });
1955
2090
  var VerificationStatus = BaseField.extend({
1956
2091
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1957
- defaultValue: VerificationStatusValue.optional(),
2092
+ defaultValue: VerificationStatusValue.or(ComputedDefaultValue).optional(),
1958
2093
  configuration: import_v43.default.object({
1959
2094
  status: TranslationConfig.describe("Text to display on the status pill."),
1960
2095
  description: TranslationConfig.describe(
1961
2096
  "Explaining text on the banner in form."
1962
2097
  )
1963
2098
  })
2099
+ }).meta({
2100
+ 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.",
2101
+ id: "VerificationStatus"
1964
2102
  });
1965
2103
  var QueryParamReaderField = BaseField.extend({
1966
2104
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1967
2105
  configuration: import_v43.default.object({
1968
2106
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1969
2107
  })
1970
- }).describe(
1971
- "A field that maps URL query params into form values and clears them afterward"
1972
- );
2108
+ }).meta({
2109
+ description: "A field that maps URL query params into form values and clears them afterward",
2110
+ id: "QueryParamReaderField"
2111
+ });
1973
2112
  var QrReaderField = BaseField.extend({
1974
2113
  type: import_v43.default.literal(FieldType.QR_READER),
1975
- defaultValue: QrReaderFieldValue.optional(),
2114
+ defaultValue: QrReaderFieldValue.or(ComputedDefaultValue).optional(),
1976
2115
  configuration: import_v43.default.object({
1977
2116
  validator: import_v43.default.any().meta({
1978
2117
  description: "JSON Schema to validate the scanned QR code data against before populating the form fields.",
@@ -1980,21 +2119,27 @@ var QrReaderField = BaseField.extend({
1980
2119
  })
1981
2120
  }).optional()
1982
2121
  }).meta({
1983
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2122
+ description: "QR code reader field, including optional JSON Schema validator.",
1984
2123
  id: "QrReaderField"
1985
2124
  });
1986
2125
  var IdReaderField = BaseField.extend({
1987
2126
  type: import_v43.default.literal(FieldType.ID_READER),
1988
- defaultValue: IdReaderFieldValue.optional(),
2127
+ defaultValue: IdReaderFieldValue.or(ComputedDefaultValue).optional(),
1989
2128
  methods: import_v43.default.array(
1990
2129
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1991
2130
  )
2131
+ }).meta({
2132
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2133
+ id: "IdReaderField"
1992
2134
  });
1993
2135
  var CustomField = BaseField.extend({
1994
2136
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1995
2137
  defaultValue: CustomFieldValue.optional(),
1996
2138
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1997
2139
  configuration: import_v43.default.unknown().optional()
2140
+ }).meta({
2141
+ description: "An expiremental custom field that is defined by a module source path",
2142
+ id: "CustomField"
1998
2143
  });
1999
2144
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2000
2145
  var LoaderField = BaseField.extend({
@@ -2004,22 +2149,25 @@ var LoaderField = BaseField.extend({
2004
2149
  configuration: import_v43.default.object({
2005
2150
  text: TranslationConfig.describe("Display text above the loading spinner")
2006
2151
  })
2007
- }).describe(
2008
- "A non-interactive field that indicates an in progress operation in form"
2009
- );
2152
+ }).meta({
2153
+ description: "A non-interactive field that indicates an in progress operation in form",
2154
+ id: "LoaderField"
2155
+ });
2010
2156
  var HiddenField = BaseField.extend({
2011
2157
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2012
2158
  required: import_v43.default.boolean().default(false).optional(),
2013
2159
  defaultValue: TextValue.optional()
2014
- }).describe(
2015
- "A non-interactive, hidden field that only hold a value in the form"
2016
- );
2160
+ }).meta({
2161
+ description: "A non-interactive, hidden field that only hold a value in the form",
2162
+ id: "HiddenField"
2163
+ });
2017
2164
  var UserRoleField = BaseField.extend({
2018
2165
  type: import_v43.default.literal(FieldType.USER_ROLE),
2019
2166
  defaultValue: TextValue.optional()
2020
- }).describe(
2021
- "A select dropdown that is automatically populated with available user roles"
2022
- );
2167
+ }).meta({
2168
+ description: "A select dropdown that is automatically populated with available user roles",
2169
+ id: "UserRoleField"
2170
+ });
2023
2171
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2024
2172
  FieldGroup,
2025
2173
  Address,
@@ -2137,6 +2285,7 @@ var ClientConfig = z20.object({
2137
2285
  COUNTRY: z20.string(),
2138
2286
  LANGUAGES: z20.array(z20.string()),
2139
2287
  SENTRY: z20.string().optional(),
2288
+ LOGIN_URL: z20.string().optional(),
2140
2289
  REGISTER_BACKGROUND: BackgroundConfig,
2141
2290
  DASHBOARDS: z20.array(
2142
2291
  z20.object({