@opencrvs/toolkit 2.0.0-rc.ec6b668 → 2.0.0-rc.ed6382e

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.
@@ -75,7 +75,10 @@ var ActionConditional = z.discriminatedUnion("type", [
75
75
  ShowConditional,
76
76
  // Action can be shown to the user in the list but as disabled
77
77
  EnableConditional
78
- ]);
78
+ ]).meta({
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
+ });
79
82
  var DisplayOnReviewConditional = z.object({
80
83
  type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
81
84
  conditional: Conditional
@@ -90,8 +93,8 @@ var FieldConditional = z.discriminatedUnion("type", [
90
93
  // Field output can be shown / hidden on the review page
91
94
  DisplayOnReviewConditional
92
95
  ]).meta({
93
- description: "Field conditional configuration",
94
- 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."
95
98
  });
96
99
 
97
100
  // ../commons/src/events/TranslationConfig.ts
@@ -831,7 +834,9 @@ var ScopeType = z11.enum([
831
834
  var EncodedScope = z11.string().brand("EncodedScope");
832
835
  var DEFAULT_SCOPE_OPTIONS = {
833
836
  placeOfEvent: JurisdictionFilter.enum.all,
834
- accessLevel: JurisdictionFilter.enum.all
837
+ accessLevel: JurisdictionFilter.enum.all,
838
+ registeredIn: JurisdictionFilter.enum.all,
839
+ declaredIn: JurisdictionFilter.enum.all
835
840
  };
836
841
 
837
842
  // ../commons/src/authentication.ts
@@ -1077,6 +1082,9 @@ var FlagConfig = z14.object({
1077
1082
  "Indicates if this flag expects an action to be performed to be cleared."
1078
1083
  ),
1079
1084
  label: TranslationConfig.describe("Human readable label of the flag.")
1085
+ }).meta({
1086
+ id: "FlagConfig",
1087
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1080
1088
  });
1081
1089
  var ActionFlagConfig = z14.object({
1082
1090
  id: Flag,
@@ -1084,6 +1092,9 @@ var ActionFlagConfig = z14.object({
1084
1092
  conditional: Conditional.optional().describe(
1085
1093
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1086
1094
  )
1095
+ }).meta({
1096
+ id: "ActionFlagConfig",
1097
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1087
1098
  });
1088
1099
 
1089
1100
  // ../commons/src/events/EventMetadata.ts
@@ -1105,8 +1116,7 @@ var ActionCreationMetadata = z15.object({
1105
1116
  ),
1106
1117
  createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1107
1118
  acceptedAt: z15.iso.datetime().describe("Timestamp when the action request was accepted."),
1108
- createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation."),
1109
- createdBySignature: z15.string().nullish().describe("Signature of the user who created the action request.")
1119
+ createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
1110
1120
  });
1111
1121
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1112
1122
  registrationNumber: z15.string().describe(
@@ -1134,9 +1144,6 @@ var EventMetadata = z15.object({
1134
1144
  createdAtLocation: UUID.nullish().describe(
1135
1145
  "Location of the user who created the event."
1136
1146
  ),
1137
- createdBySignature: DocumentPath.nullish().describe(
1138
- "Signature of the user who created the event."
1139
- ),
1140
1147
  updatedAtLocation: UUID.nullish().describe(
1141
1148
  "Location of the user who last changed the status."
1142
1149
  ),
@@ -1144,9 +1151,6 @@ var EventMetadata = z15.object({
1144
1151
  "Timestamp of the most recent *accepted* status change. Possibly 3rd party update, if action is validation asynchronously."
1145
1152
  ),
1146
1153
  assignedTo: z15.string().nullish().describe("ID of the user currently assigned to the event."),
1147
- assignedToSignature: DocumentPath.nullish().describe(
1148
- "Signature of the user who is currently assigned to the event."
1149
- ),
1150
1154
  updatedBy: z15.string().nullish().describe("ID of the user who last changed the status."),
1151
1155
  trackingId: z15.string().describe(
1152
1156
  "System-generated tracking ID used by informants or registrars to look up the event."
@@ -1403,14 +1407,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1403
1407
  }
1404
1408
  }).describe("Unique identifier for the field");
1405
1409
  var FieldReference = import_v43.default.object({
1406
- $$field: FieldId,
1410
+ $$field: FieldId.describe("Id of the field to reference"),
1407
1411
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1408
1412
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1409
1413
  )
1410
1414
  }).describe("Reference to a field by its ID");
1411
1415
  var ValidationConfig = import_v43.default.object({
1412
- validator: Conditional,
1413
- message: TranslationConfig
1416
+ validator: Conditional.describe(
1417
+ "Conditional expression that must hold for the field value to be considered valid."
1418
+ ),
1419
+ message: TranslationConfig.describe(
1420
+ "Error message displayed when the validator does not hold."
1421
+ )
1422
+ }).meta({
1423
+ id: "ValidationConfig",
1424
+ 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."
1414
1425
  });
1415
1426
  var requiredSchema = import_v43.default.union([
1416
1427
  import_v43.default.boolean(),
@@ -1449,6 +1460,9 @@ var BaseField = import_v43.default.object({
1449
1460
  }).describe("Common properties shared across all field types.");
1450
1461
  var Divider = BaseField.extend({
1451
1462
  type: import_v43.default.literal(FieldType.DIVIDER)
1463
+ }).meta({
1464
+ description: "A horizontal line divider",
1465
+ id: "Divider"
1452
1466
  });
1453
1467
  var TextField = BaseField.extend({
1454
1468
  type: import_v43.default.literal(FieldType.TEXT),
@@ -1459,7 +1473,10 @@ var TextField = BaseField.extend({
1459
1473
  prefix: TranslationConfig.optional(),
1460
1474
  postfix: TranslationConfig.optional()
1461
1475
  }).default({ type: "text" }).optional()
1462
- }).describe("Text input");
1476
+ }).meta({
1477
+ description: "A text input field",
1478
+ id: "TextField"
1479
+ });
1463
1480
  var NumberField = BaseField.extend({
1464
1481
  type: import_v43.default.literal(FieldType.NUMBER),
1465
1482
  defaultValue: NumberFieldValue.optional(),
@@ -1469,7 +1486,10 @@ var NumberField = BaseField.extend({
1469
1486
  prefix: TranslationConfig.optional(),
1470
1487
  postfix: TranslationConfig.optional()
1471
1488
  }).optional()
1472
- }).describe("Number input");
1489
+ }).meta({
1490
+ description: "A number input field",
1491
+ id: "NumberField"
1492
+ });
1473
1493
  var TextAreaField = BaseField.extend({
1474
1494
  type: import_v43.default.literal(FieldType.TEXTAREA),
1475
1495
  defaultValue: NonEmptyTextValue.optional(),
@@ -1480,7 +1500,10 @@ var TextAreaField = BaseField.extend({
1480
1500
  prefix: TranslationConfig.optional(),
1481
1501
  postfix: TranslationConfig.optional()
1482
1502
  }).default({ rows: 4 }).optional()
1483
- }).describe("Multiline text input");
1503
+ }).meta({
1504
+ description: "A multiline text input",
1505
+ id: "TextAreaField"
1506
+ });
1484
1507
  var ImageMimeType = import_v43.default.enum([
1485
1508
  "image/png",
1486
1509
  "image/jpg",
@@ -1510,13 +1533,19 @@ var SignatureField = BaseField.extend({
1510
1533
  }).default({
1511
1534
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1512
1535
  })
1513
- }).describe("Signature input field");
1536
+ }).meta({
1537
+ description: "A signature input field",
1538
+ id: "SignatureField"
1539
+ });
1514
1540
  var EmailField = BaseField.extend({
1515
1541
  type: import_v43.default.literal(FieldType.EMAIL),
1516
1542
  configuration: import_v43.default.object({
1517
1543
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1518
1544
  }).default({ maxLength: 255 }).optional(),
1519
1545
  defaultValue: NonEmptyTextValue.optional()
1546
+ }).meta({
1547
+ description: "An email input field",
1548
+ id: "EmailField"
1520
1549
  });
1521
1550
  var DateField = BaseField.extend({
1522
1551
  type: import_v43.default.literal(FieldType.DATE),
@@ -1526,7 +1555,10 @@ var DateField = BaseField.extend({
1526
1555
  "Text to display above the date input"
1527
1556
  ).optional()
1528
1557
  }).optional()
1529
- }).describe("A single date input (yyyy-MM-dd)");
1558
+ }).meta({
1559
+ description: "A date input (yyyy-MM-dd)",
1560
+ id: "DateField"
1561
+ });
1530
1562
  var AgeField = BaseField.extend({
1531
1563
  type: import_v43.default.literal(FieldType.AGE),
1532
1564
  defaultValue: NumberFieldValue.optional(),
@@ -1535,7 +1567,10 @@ var AgeField = BaseField.extend({
1535
1567
  prefix: TranslationConfig.optional(),
1536
1568
  postfix: TranslationConfig.optional()
1537
1569
  })
1538
- }).describe("An age input field which uses the current date as the asOfDate");
1570
+ }).meta({
1571
+ description: "An age input field which uses the current date as the asOfDate",
1572
+ id: "AgeField"
1573
+ });
1539
1574
  var TimeField = BaseField.extend({
1540
1575
  type: import_v43.default.literal(FieldType.TIME),
1541
1576
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -1545,7 +1580,10 @@ var TimeField = BaseField.extend({
1545
1580
  "Text to display above the time input"
1546
1581
  ).optional()
1547
1582
  }).optional()
1548
- }).describe("A single date input (HH-mm)");
1583
+ }).meta({
1584
+ description: "A single time input (HH-mm)",
1585
+ id: "TimeField"
1586
+ });
1549
1587
  var DateRangeField = BaseField.extend({
1550
1588
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1551
1589
  defaultValue: DateRangeFieldValue.optional(),
@@ -1554,7 +1592,10 @@ var DateRangeField = BaseField.extend({
1554
1592
  "Text to display above the date input"
1555
1593
  ).optional()
1556
1594
  }).optional()
1557
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
1595
+ }).meta({
1596
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
1597
+ id: "DateRangeField"
1598
+ });
1558
1599
  var HtmlFontVariant = import_v43.default.enum([
1559
1600
  "reg12",
1560
1601
  "reg14",
@@ -1598,18 +1639,30 @@ var ImageViewField = BaseField.extend({
1598
1639
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1599
1640
  defaultValue: NonEmptyTextValue.optional(),
1600
1641
  configuration: ImageConfiguration
1601
- }).describe("A read-only image component for form pages");
1642
+ }).meta({
1643
+ description: "A read-only image component for form pages",
1644
+ id: "ImageViewField"
1645
+ });
1602
1646
  var Paragraph = BaseField.extend({
1603
1647
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1604
1648
  configuration: ParagraphConfiguration
1605
- }).describe("A read-only HTML <p> paragraph");
1649
+ }).meta({
1650
+ description: "A read-only HTML <p> paragraph",
1651
+ id: "Paragraph"
1652
+ });
1606
1653
  var Heading = BaseField.extend({
1607
1654
  type: import_v43.default.literal(FieldType.HEADING),
1608
1655
  configuration: HeadingConfiguration
1609
- }).describe("A read-only heading component for form pages");
1656
+ }).meta({
1657
+ description: "A read-only heading component for form pages",
1658
+ id: "Heading"
1659
+ });
1610
1660
  var PageHeader = BaseField.extend({
1611
1661
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1612
- }).describe("A read-only header component for form pages");
1662
+ }).meta({
1663
+ description: "A read-only header component for form pages",
1664
+ id: "PageHeader"
1665
+ });
1613
1666
  var File = BaseField.extend({
1614
1667
  type: import_v43.default.literal(FieldType.FILE),
1615
1668
  defaultValue: FileFieldValue.optional(),
@@ -1628,7 +1681,10 @@ var File = BaseField.extend({
1628
1681
  }).default({
1629
1682
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1630
1683
  })
1631
- }).describe("File upload");
1684
+ }).meta({
1685
+ description: "A file upload field",
1686
+ id: "File"
1687
+ });
1632
1688
  var SelectOption = import_v43.default.object({
1633
1689
  value: import_v43.default.string().describe("The value of the option"),
1634
1690
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1645,7 +1701,10 @@ var NumberWithUnitField = BaseField.extend({
1645
1701
  "Placeholder for the number field"
1646
1702
  )
1647
1703
  }).optional()
1648
- }).describe("Number with unit input");
1704
+ }).meta({
1705
+ description: "A number with unit input field",
1706
+ id: "NumberWithUnitField"
1707
+ });
1649
1708
  var RadioGroup = BaseField.extend({
1650
1709
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1651
1710
  defaultValue: TextValue.optional(),
@@ -1655,7 +1714,10 @@ var RadioGroup = BaseField.extend({
1655
1714
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1656
1715
  }).optional()
1657
1716
  }).optional()
1658
- }).describe("Grouped radio options");
1717
+ }).meta({
1718
+ description: "A grouped radio button field",
1719
+ id: "RadioGroup"
1720
+ });
1659
1721
  var BulletList = BaseField.extend({
1660
1722
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1661
1723
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1664,7 +1726,10 @@ var BulletList = BaseField.extend({
1664
1726
  fontVariant: HtmlFontVariant.optional()
1665
1727
  }).optional()
1666
1728
  }).default({})
1667
- }).describe("A list of bullet points");
1729
+ }).meta({
1730
+ description: "A list of bullet points",
1731
+ id: "BulletList"
1732
+ });
1668
1733
  var Select = BaseField.extend({
1669
1734
  type: import_v43.default.literal(FieldType.SELECT),
1670
1735
  defaultValue: TextValue.optional(),
@@ -1679,7 +1744,10 @@ var Select = BaseField.extend({
1679
1744
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1680
1745
  `
1681
1746
  )
1682
- }).describe("Select input");
1747
+ }).meta({
1748
+ description: "A select input field",
1749
+ id: "Select"
1750
+ });
1683
1751
  var SelectDateRangeOption = import_v43.default.object({
1684
1752
  value: SelectDateRangeValue.describe("The value of the option"),
1685
1753
  label: TranslationConfig.describe("The label of the option")
@@ -1688,7 +1756,10 @@ var SelectDateRangeField = BaseField.extend({
1688
1756
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1689
1757
  defaultValue: SelectDateRangeValue.optional(),
1690
1758
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1691
- }).describe("Select input with date range options");
1759
+ }).meta({
1760
+ description: "A date range selection field",
1761
+ id: "SelectDateRangeField"
1762
+ });
1692
1763
  var NameConfig = import_v43.default.object({
1693
1764
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1694
1765
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1719,26 +1790,41 @@ var NameField = BaseField.extend({
1719
1790
  surname: { required: true }
1720
1791
  }
1721
1792
  }).optional()
1722
- }).describe("Name input field");
1793
+ }).meta({
1794
+ description: "A field for entering a persons name",
1795
+ id: "NameField"
1796
+ });
1723
1797
  var PhoneField = BaseField.extend({
1724
1798
  defaultValue: NonEmptyTextValue.optional(),
1725
1799
  type: import_v43.default.literal(FieldType.PHONE)
1726
- }).describe("Phone input field");
1800
+ }).meta({
1801
+ description: "A field for entering a phone number",
1802
+ id: "PhoneField"
1803
+ });
1727
1804
  var IdField = BaseField.extend({
1728
1805
  defaultValue: NonEmptyTextValue.optional(),
1729
1806
  type: import_v43.default.literal(FieldType.ID)
1730
- }).describe("ID input field");
1807
+ }).meta({
1808
+ description: "A field for entering an ID",
1809
+ id: "IdField"
1810
+ });
1731
1811
  var Checkbox = BaseField.extend({
1732
1812
  type: import_v43.default.literal(FieldType.CHECKBOX),
1733
1813
  defaultValue: CheckboxFieldValue.default(false)
1734
- }).describe("Boolean checkbox field");
1814
+ }).meta({
1815
+ description: "A boolean checkbox field",
1816
+ id: "Checkbox"
1817
+ });
1735
1818
  var Country = BaseField.extend({
1736
1819
  type: import_v43.default.literal(FieldType.COUNTRY),
1737
1820
  defaultValue: NonEmptyTextValue.optional(),
1738
1821
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1739
1822
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1740
1823
  )
1741
- }).describe("Country select field");
1824
+ }).meta({
1825
+ description: "A field for selecting a country",
1826
+ id: "Country"
1827
+ });
1742
1828
  var AllowedLocations = JurisdictionReference.optional().describe(
1743
1829
  "Limits which location options are selectable depending on user jurisdiction and location."
1744
1830
  );
@@ -1747,16 +1833,18 @@ var AdministrativeAreas = import_v43.default.enum([
1747
1833
  "HEALTH_FACILITY",
1748
1834
  "CRVS_OFFICE"
1749
1835
  ]);
1750
- var AdministrativeAreaConfiguration = import_v43.default.object({
1751
- partOf: FieldReference.optional().describe("Parent location"),
1752
- type: AdministrativeAreas,
1753
- allowedLocations: AllowedLocations
1754
- }).describe("Administrative area options");
1755
1836
  var AdministrativeAreaField = BaseField.extend({
1756
1837
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1757
1838
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1758
- configuration: AdministrativeAreaConfiguration
1759
- }).describe("Administrative area input field e.g. facility, office");
1839
+ configuration: import_v43.default.object({
1840
+ partOf: FieldReference.optional().describe("Parent location"),
1841
+ type: AdministrativeAreas,
1842
+ allowedLocations: AllowedLocations
1843
+ }).describe("Administrative area options")
1844
+ }).meta({
1845
+ description: "Administrative area input field",
1846
+ id: "AdministrativeAreaField"
1847
+ });
1760
1848
  var LocationInput = BaseField.extend({
1761
1849
  type: import_v43.default.literal(FieldType.LOCATION),
1762
1850
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -1764,7 +1852,10 @@ var LocationInput = BaseField.extend({
1764
1852
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1765
1853
  allowedLocations: AllowedLocations
1766
1854
  }).optional()
1767
- }).describe("Input field for a location");
1855
+ }).meta({
1856
+ description: "A field for selecting a location",
1857
+ id: "LocationInput"
1858
+ });
1768
1859
  var FileUploadWithOptions = BaseField.extend({
1769
1860
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1770
1861
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -1778,6 +1869,9 @@ var FileUploadWithOptions = BaseField.extend({
1778
1869
  }).default({
1779
1870
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1780
1871
  })
1872
+ }).meta({
1873
+ description: "A field for uploading files with file type options",
1874
+ id: "FileUploadWithOptions"
1781
1875
  });
1782
1876
  var Facility = BaseField.extend({
1783
1877
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -1823,7 +1917,10 @@ var Address = BaseField.extend({
1823
1917
  allowedLocations: AllowedLocations
1824
1918
  }).optional(),
1825
1919
  defaultValue: DefaultAddressFieldValue.optional()
1826
- }).describe("Address input field \u2013 a combination of location and text fields");
1920
+ }).meta({
1921
+ description: "Address input field \u2013 a combination of location and text fields",
1922
+ id: "Address"
1923
+ });
1827
1924
  var StaticDataEntry = import_v43.default.object({
1828
1925
  id: import_v43.default.string().describe("ID for the data entry."),
1829
1926
  label: TranslationConfig,
@@ -1838,7 +1935,10 @@ var DataField = BaseField.extend({
1838
1935
  subtitle: TranslationConfig.optional(),
1839
1936
  data: import_v43.default.array(DataEntry)
1840
1937
  })
1841
- }).describe("Data field for displaying read-only data");
1938
+ }).meta({
1939
+ description: "A field for displaying a table of read-only data",
1940
+ id: "DataField"
1941
+ });
1842
1942
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1843
1943
  var ButtonType = import_v43.default.enum([
1844
1944
  "primary",
@@ -1865,11 +1965,17 @@ var ButtonField = BaseField.extend({
1865
1965
  type: import_v43.default.literal(FieldType.BUTTON),
1866
1966
  defaultValue: ButtonFieldValue.optional(),
1867
1967
  configuration: ButtonConfiguration
1868
- }).describe("Generic button without any built-in functionality");
1968
+ }).meta({
1969
+ description: "A generic button that can be used to trigger an action",
1970
+ id: "ButtonField"
1971
+ });
1869
1972
  var FieldGroup = BaseField.extend({
1870
1973
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1871
1974
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1872
1975
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
1976
+ }).meta({
1977
+ description: "A group of fields that are displayed together",
1978
+ id: "FieldGroup"
1873
1979
  });
1874
1980
  var AlphaPrintButton = BaseField.extend({
1875
1981
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1879,7 +1985,10 @@ var AlphaPrintButton = BaseField.extend({
1879
1985
  "Label for the print button"
1880
1986
  )
1881
1987
  })
1882
- }).describe("Print button field for printing certificates");
1988
+ }).meta({
1989
+ description: "An experimental print button field for printing certificates during the declaration process",
1990
+ id: "AlphaPrintButton"
1991
+ });
1883
1992
  var HttpField = BaseField.extend({
1884
1993
  type: import_v43.default.literal(FieldType.HTTP),
1885
1994
  defaultValue: HttpFieldValue.optional(),
@@ -1895,20 +2004,30 @@ var HttpField = BaseField.extend({
1895
2004
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1896
2005
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1897
2006
  })
1898
- }).describe("HTTP request function triggered by a button click or other event");
2007
+ }).meta({
2008
+ 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.",
2009
+ id: "HttpField"
2010
+ });
1899
2011
  var AutocompleteField = BaseField.extend({
1900
2012
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1901
2013
  configuration: import_v43.default.object({
1902
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2014
+ url: import_v43.default.string().describe(
2015
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2016
+ ).optional(),
1903
2017
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1904
2018
  defaultOptions: import_v43.default.array(
1905
2019
  import_v43.default.object({
1906
2020
  label: import_v43.default.string(),
1907
2021
  value: import_v43.default.string()
1908
2022
  })
1909
- ).optional()
2023
+ ).optional().describe(
2024
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2025
+ )
1910
2026
  })
1911
- }).describe("Autocomplete input field");
2027
+ }).meta({
2028
+ 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.",
2029
+ id: "AutocompleteField"
2030
+ });
1912
2031
  var SearchField = HttpField.extend({
1913
2032
  type: import_v43.default.literal(FieldType.SEARCH),
1914
2033
  configuration: SearchQuery.pick({
@@ -1941,6 +2060,9 @@ var SearchField = HttpField.extend({
1941
2060
  ok: TranslationConfig.optional()
1942
2061
  }).optional()
1943
2062
  })
2063
+ }).meta({
2064
+ description: "A search input field",
2065
+ id: "SearchField"
1944
2066
  });
1945
2067
  var LinkButtonField = BaseField.extend({
1946
2068
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1949,7 +2071,10 @@ var LinkButtonField = BaseField.extend({
1949
2071
  text: TranslationConfig.describe("Text to display on the button"),
1950
2072
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1951
2073
  })
1952
- }).describe("Button that opens a link");
2074
+ }).meta({
2075
+ description: "A button that opens a URL link",
2076
+ id: "LinkButtonField"
2077
+ });
1953
2078
  var VerificationStatus = BaseField.extend({
1954
2079
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1955
2080
  defaultValue: VerificationStatusValue.optional(),
@@ -1959,15 +2084,19 @@ var VerificationStatus = BaseField.extend({
1959
2084
  "Explaining text on the banner in form."
1960
2085
  )
1961
2086
  })
2087
+ }).meta({
2088
+ 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.",
2089
+ id: "VerificationStatus"
1962
2090
  });
1963
2091
  var QueryParamReaderField = BaseField.extend({
1964
2092
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1965
2093
  configuration: import_v43.default.object({
1966
2094
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1967
2095
  })
1968
- }).describe(
1969
- "A field that maps URL query params into form values and clears them afterward"
1970
- );
2096
+ }).meta({
2097
+ description: "A field that maps URL query params into form values and clears them afterward",
2098
+ id: "QueryParamReaderField"
2099
+ });
1971
2100
  var QrReaderField = BaseField.extend({
1972
2101
  type: import_v43.default.literal(FieldType.QR_READER),
1973
2102
  defaultValue: QrReaderFieldValue.optional(),
@@ -1978,7 +2107,7 @@ var QrReaderField = BaseField.extend({
1978
2107
  })
1979
2108
  }).optional()
1980
2109
  }).meta({
1981
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2110
+ description: "QR code reader field, including optional JSON Schema validator.",
1982
2111
  id: "QrReaderField"
1983
2112
  });
1984
2113
  var IdReaderField = BaseField.extend({
@@ -1987,12 +2116,18 @@ var IdReaderField = BaseField.extend({
1987
2116
  methods: import_v43.default.array(
1988
2117
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1989
2118
  )
2119
+ }).meta({
2120
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2121
+ id: "IdReaderField"
1990
2122
  });
1991
2123
  var CustomField = BaseField.extend({
1992
2124
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1993
2125
  defaultValue: CustomFieldValue.optional(),
1994
2126
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1995
2127
  configuration: import_v43.default.unknown().optional()
2128
+ }).meta({
2129
+ description: "An expiremental custom field that is defined by a module source path",
2130
+ id: "CustomField"
1996
2131
  });
1997
2132
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
1998
2133
  var LoaderField = BaseField.extend({
@@ -2002,22 +2137,25 @@ var LoaderField = BaseField.extend({
2002
2137
  configuration: import_v43.default.object({
2003
2138
  text: TranslationConfig.describe("Display text above the loading spinner")
2004
2139
  })
2005
- }).describe(
2006
- "A non-interactive field that indicates an in progress operation in form"
2007
- );
2140
+ }).meta({
2141
+ description: "A non-interactive field that indicates an in progress operation in form",
2142
+ id: "LoaderField"
2143
+ });
2008
2144
  var HiddenField = BaseField.extend({
2009
2145
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2010
2146
  required: import_v43.default.boolean().default(false).optional(),
2011
2147
  defaultValue: TextValue.optional()
2012
- }).describe(
2013
- "A non-interactive, hidden field that only hold a value in the form"
2014
- );
2148
+ }).meta({
2149
+ description: "A non-interactive, hidden field that only hold a value in the form",
2150
+ id: "HiddenField"
2151
+ });
2015
2152
  var UserRoleField = BaseField.extend({
2016
2153
  type: import_v43.default.literal(FieldType.USER_ROLE),
2017
2154
  defaultValue: TextValue.optional()
2018
- }).describe(
2019
- "A select dropdown that is automatically populated with available user roles"
2020
- );
2155
+ }).meta({
2156
+ description: "A select dropdown that is automatically populated with available user roles",
2157
+ id: "UserRoleField"
2158
+ });
2021
2159
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2022
2160
  FieldGroup,
2023
2161
  Address,