@opencrvs/toolkit 2.0.0-rc.fa96c0e → 2.0.0-rc.fb896bc

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
  ),
@@ -1400,14 +1407,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1400
1407
  }
1401
1408
  }).describe("Unique identifier for the field");
1402
1409
  var FieldReference = import_v43.default.object({
1403
- $$field: FieldId,
1410
+ $$field: FieldId.describe("Id of the field to reference"),
1404
1411
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1405
1412
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1406
1413
  )
1407
1414
  }).describe("Reference to a field by its ID");
1408
1415
  var ValidationConfig = import_v43.default.object({
1409
- validator: Conditional,
1410
- 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."
1411
1425
  });
1412
1426
  var requiredSchema = import_v43.default.union([
1413
1427
  import_v43.default.boolean(),
@@ -1446,6 +1460,9 @@ var BaseField = import_v43.default.object({
1446
1460
  }).describe("Common properties shared across all field types.");
1447
1461
  var Divider = BaseField.extend({
1448
1462
  type: import_v43.default.literal(FieldType.DIVIDER)
1463
+ }).meta({
1464
+ description: "A horizontal line divider",
1465
+ id: "Divider"
1449
1466
  });
1450
1467
  var TextField = BaseField.extend({
1451
1468
  type: import_v43.default.literal(FieldType.TEXT),
@@ -1456,7 +1473,10 @@ var TextField = BaseField.extend({
1456
1473
  prefix: TranslationConfig.optional(),
1457
1474
  postfix: TranslationConfig.optional()
1458
1475
  }).default({ type: "text" }).optional()
1459
- }).describe("Text input");
1476
+ }).meta({
1477
+ description: "A text input field",
1478
+ id: "TextField"
1479
+ });
1460
1480
  var NumberField = BaseField.extend({
1461
1481
  type: import_v43.default.literal(FieldType.NUMBER),
1462
1482
  defaultValue: NumberFieldValue.optional(),
@@ -1466,7 +1486,10 @@ var NumberField = BaseField.extend({
1466
1486
  prefix: TranslationConfig.optional(),
1467
1487
  postfix: TranslationConfig.optional()
1468
1488
  }).optional()
1469
- }).describe("Number input");
1489
+ }).meta({
1490
+ description: "A number input field",
1491
+ id: "NumberField"
1492
+ });
1470
1493
  var TextAreaField = BaseField.extend({
1471
1494
  type: import_v43.default.literal(FieldType.TEXTAREA),
1472
1495
  defaultValue: NonEmptyTextValue.optional(),
@@ -1477,7 +1500,10 @@ var TextAreaField = BaseField.extend({
1477
1500
  prefix: TranslationConfig.optional(),
1478
1501
  postfix: TranslationConfig.optional()
1479
1502
  }).default({ rows: 4 }).optional()
1480
- }).describe("Multiline text input");
1503
+ }).meta({
1504
+ description: "A multiline text input",
1505
+ id: "TextAreaField"
1506
+ });
1481
1507
  var ImageMimeType = import_v43.default.enum([
1482
1508
  "image/png",
1483
1509
  "image/jpg",
@@ -1507,13 +1533,19 @@ var SignatureField = BaseField.extend({
1507
1533
  }).default({
1508
1534
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1509
1535
  })
1510
- }).describe("Signature input field");
1536
+ }).meta({
1537
+ description: "A signature input field",
1538
+ id: "SignatureField"
1539
+ });
1511
1540
  var EmailField = BaseField.extend({
1512
1541
  type: import_v43.default.literal(FieldType.EMAIL),
1513
1542
  configuration: import_v43.default.object({
1514
1543
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1515
1544
  }).default({ maxLength: 255 }).optional(),
1516
1545
  defaultValue: NonEmptyTextValue.optional()
1546
+ }).meta({
1547
+ description: "An email input field",
1548
+ id: "EmailField"
1517
1549
  });
1518
1550
  var DateField = BaseField.extend({
1519
1551
  type: import_v43.default.literal(FieldType.DATE),
@@ -1523,7 +1555,10 @@ var DateField = BaseField.extend({
1523
1555
  "Text to display above the date input"
1524
1556
  ).optional()
1525
1557
  }).optional()
1526
- }).describe("A single date input (yyyy-MM-dd)");
1558
+ }).meta({
1559
+ description: "A date input (yyyy-MM-dd)",
1560
+ id: "DateField"
1561
+ });
1527
1562
  var AgeField = BaseField.extend({
1528
1563
  type: import_v43.default.literal(FieldType.AGE),
1529
1564
  defaultValue: NumberFieldValue.optional(),
@@ -1532,7 +1567,10 @@ var AgeField = BaseField.extend({
1532
1567
  prefix: TranslationConfig.optional(),
1533
1568
  postfix: TranslationConfig.optional()
1534
1569
  })
1535
- }).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
+ });
1536
1574
  var TimeField = BaseField.extend({
1537
1575
  type: import_v43.default.literal(FieldType.TIME),
1538
1576
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -1542,7 +1580,10 @@ var TimeField = BaseField.extend({
1542
1580
  "Text to display above the time input"
1543
1581
  ).optional()
1544
1582
  }).optional()
1545
- }).describe("A single date input (HH-mm)");
1583
+ }).meta({
1584
+ description: "A single time input (HH-mm)",
1585
+ id: "TimeField"
1586
+ });
1546
1587
  var DateRangeField = BaseField.extend({
1547
1588
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1548
1589
  defaultValue: DateRangeFieldValue.optional(),
@@ -1551,7 +1592,10 @@ var DateRangeField = BaseField.extend({
1551
1592
  "Text to display above the date input"
1552
1593
  ).optional()
1553
1594
  }).optional()
1554
- }).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
+ });
1555
1599
  var HtmlFontVariant = import_v43.default.enum([
1556
1600
  "reg12",
1557
1601
  "reg14",
@@ -1595,18 +1639,30 @@ var ImageViewField = BaseField.extend({
1595
1639
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1596
1640
  defaultValue: NonEmptyTextValue.optional(),
1597
1641
  configuration: ImageConfiguration
1598
- }).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
+ });
1599
1646
  var Paragraph = BaseField.extend({
1600
1647
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1601
1648
  configuration: ParagraphConfiguration
1602
- }).describe("A read-only HTML <p> paragraph");
1649
+ }).meta({
1650
+ description: "A read-only HTML <p> paragraph",
1651
+ id: "Paragraph"
1652
+ });
1603
1653
  var Heading = BaseField.extend({
1604
1654
  type: import_v43.default.literal(FieldType.HEADING),
1605
1655
  configuration: HeadingConfiguration
1606
- }).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
+ });
1607
1660
  var PageHeader = BaseField.extend({
1608
1661
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1609
- }).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
+ });
1610
1666
  var File = BaseField.extend({
1611
1667
  type: import_v43.default.literal(FieldType.FILE),
1612
1668
  defaultValue: FileFieldValue.optional(),
@@ -1625,7 +1681,10 @@ var File = BaseField.extend({
1625
1681
  }).default({
1626
1682
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1627
1683
  })
1628
- }).describe("File upload");
1684
+ }).meta({
1685
+ description: "A file upload field",
1686
+ id: "File"
1687
+ });
1629
1688
  var SelectOption = import_v43.default.object({
1630
1689
  value: import_v43.default.string().describe("The value of the option"),
1631
1690
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1642,7 +1701,10 @@ var NumberWithUnitField = BaseField.extend({
1642
1701
  "Placeholder for the number field"
1643
1702
  )
1644
1703
  }).optional()
1645
- }).describe("Number with unit input");
1704
+ }).meta({
1705
+ description: "A number with unit input field",
1706
+ id: "NumberWithUnitField"
1707
+ });
1646
1708
  var RadioGroup = BaseField.extend({
1647
1709
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1648
1710
  defaultValue: TextValue.optional(),
@@ -1652,7 +1714,10 @@ var RadioGroup = BaseField.extend({
1652
1714
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1653
1715
  }).optional()
1654
1716
  }).optional()
1655
- }).describe("Grouped radio options");
1717
+ }).meta({
1718
+ description: "A grouped radio button field",
1719
+ id: "RadioGroup"
1720
+ });
1656
1721
  var BulletList = BaseField.extend({
1657
1722
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1658
1723
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1661,7 +1726,10 @@ var BulletList = BaseField.extend({
1661
1726
  fontVariant: HtmlFontVariant.optional()
1662
1727
  }).optional()
1663
1728
  }).default({})
1664
- }).describe("A list of bullet points");
1729
+ }).meta({
1730
+ description: "A list of bullet points",
1731
+ id: "BulletList"
1732
+ });
1665
1733
  var Select = BaseField.extend({
1666
1734
  type: import_v43.default.literal(FieldType.SELECT),
1667
1735
  defaultValue: TextValue.optional(),
@@ -1676,7 +1744,10 @@ var Select = BaseField.extend({
1676
1744
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1677
1745
  `
1678
1746
  )
1679
- }).describe("Select input");
1747
+ }).meta({
1748
+ description: "A select input field",
1749
+ id: "Select"
1750
+ });
1680
1751
  var SelectDateRangeOption = import_v43.default.object({
1681
1752
  value: SelectDateRangeValue.describe("The value of the option"),
1682
1753
  label: TranslationConfig.describe("The label of the option")
@@ -1685,7 +1756,10 @@ var SelectDateRangeField = BaseField.extend({
1685
1756
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1686
1757
  defaultValue: SelectDateRangeValue.optional(),
1687
1758
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1688
- }).describe("Select input with date range options");
1759
+ }).meta({
1760
+ description: "A date range selection field",
1761
+ id: "SelectDateRangeField"
1762
+ });
1689
1763
  var NameConfig = import_v43.default.object({
1690
1764
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1691
1765
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1716,26 +1790,41 @@ var NameField = BaseField.extend({
1716
1790
  surname: { required: true }
1717
1791
  }
1718
1792
  }).optional()
1719
- }).describe("Name input field");
1793
+ }).meta({
1794
+ description: "A field for entering a persons name",
1795
+ id: "NameField"
1796
+ });
1720
1797
  var PhoneField = BaseField.extend({
1721
1798
  defaultValue: NonEmptyTextValue.optional(),
1722
1799
  type: import_v43.default.literal(FieldType.PHONE)
1723
- }).describe("Phone input field");
1800
+ }).meta({
1801
+ description: "A field for entering a phone number",
1802
+ id: "PhoneField"
1803
+ });
1724
1804
  var IdField = BaseField.extend({
1725
1805
  defaultValue: NonEmptyTextValue.optional(),
1726
1806
  type: import_v43.default.literal(FieldType.ID)
1727
- }).describe("ID input field");
1807
+ }).meta({
1808
+ description: "A field for entering an ID",
1809
+ id: "IdField"
1810
+ });
1728
1811
  var Checkbox = BaseField.extend({
1729
1812
  type: import_v43.default.literal(FieldType.CHECKBOX),
1730
1813
  defaultValue: CheckboxFieldValue.default(false)
1731
- }).describe("Boolean checkbox field");
1814
+ }).meta({
1815
+ description: "A boolean checkbox field",
1816
+ id: "Checkbox"
1817
+ });
1732
1818
  var Country = BaseField.extend({
1733
1819
  type: import_v43.default.literal(FieldType.COUNTRY),
1734
1820
  defaultValue: NonEmptyTextValue.optional(),
1735
1821
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1736
1822
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1737
1823
  )
1738
- }).describe("Country select field");
1824
+ }).meta({
1825
+ description: "A field for selecting a country",
1826
+ id: "Country"
1827
+ });
1739
1828
  var AllowedLocations = JurisdictionReference.optional().describe(
1740
1829
  "Limits which location options are selectable depending on user jurisdiction and location."
1741
1830
  );
@@ -1744,16 +1833,18 @@ var AdministrativeAreas = import_v43.default.enum([
1744
1833
  "HEALTH_FACILITY",
1745
1834
  "CRVS_OFFICE"
1746
1835
  ]);
1747
- var AdministrativeAreaConfiguration = import_v43.default.object({
1748
- partOf: FieldReference.optional().describe("Parent location"),
1749
- type: AdministrativeAreas,
1750
- allowedLocations: AllowedLocations
1751
- }).describe("Administrative area options");
1752
1836
  var AdministrativeAreaField = BaseField.extend({
1753
1837
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1754
1838
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1755
- configuration: AdministrativeAreaConfiguration
1756
- }).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
+ });
1757
1848
  var LocationInput = BaseField.extend({
1758
1849
  type: import_v43.default.literal(FieldType.LOCATION),
1759
1850
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -1761,7 +1852,10 @@ var LocationInput = BaseField.extend({
1761
1852
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1762
1853
  allowedLocations: AllowedLocations
1763
1854
  }).optional()
1764
- }).describe("Input field for a location");
1855
+ }).meta({
1856
+ description: "A field for selecting a location",
1857
+ id: "LocationInput"
1858
+ });
1765
1859
  var FileUploadWithOptions = BaseField.extend({
1766
1860
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1767
1861
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -1775,6 +1869,9 @@ var FileUploadWithOptions = BaseField.extend({
1775
1869
  }).default({
1776
1870
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1777
1871
  })
1872
+ }).meta({
1873
+ description: "A field for uploading files with file type options",
1874
+ id: "FileUploadWithOptions"
1778
1875
  });
1779
1876
  var Facility = BaseField.extend({
1780
1877
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -1820,7 +1917,10 @@ var Address = BaseField.extend({
1820
1917
  allowedLocations: AllowedLocations
1821
1918
  }).optional(),
1822
1919
  defaultValue: DefaultAddressFieldValue.optional()
1823
- }).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
+ });
1824
1924
  var StaticDataEntry = import_v43.default.object({
1825
1925
  id: import_v43.default.string().describe("ID for the data entry."),
1826
1926
  label: TranslationConfig,
@@ -1835,7 +1935,10 @@ var DataField = BaseField.extend({
1835
1935
  subtitle: TranslationConfig.optional(),
1836
1936
  data: import_v43.default.array(DataEntry)
1837
1937
  })
1838
- }).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
+ });
1839
1942
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1840
1943
  var ButtonType = import_v43.default.enum([
1841
1944
  "primary",
@@ -1862,11 +1965,17 @@ var ButtonField = BaseField.extend({
1862
1965
  type: import_v43.default.literal(FieldType.BUTTON),
1863
1966
  defaultValue: ButtonFieldValue.optional(),
1864
1967
  configuration: ButtonConfiguration
1865
- }).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
+ });
1866
1972
  var FieldGroup = BaseField.extend({
1867
1973
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1868
1974
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1869
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"
1870
1979
  });
1871
1980
  var AlphaPrintButton = BaseField.extend({
1872
1981
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1876,7 +1985,10 @@ var AlphaPrintButton = BaseField.extend({
1876
1985
  "Label for the print button"
1877
1986
  )
1878
1987
  })
1879
- }).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
+ });
1880
1992
  var HttpField = BaseField.extend({
1881
1993
  type: import_v43.default.literal(FieldType.HTTP),
1882
1994
  defaultValue: HttpFieldValue.optional(),
@@ -1892,20 +2004,30 @@ var HttpField = BaseField.extend({
1892
2004
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1893
2005
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1894
2006
  })
1895
- }).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
+ });
1896
2011
  var AutocompleteField = BaseField.extend({
1897
2012
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1898
2013
  configuration: import_v43.default.object({
1899
- 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(),
1900
2017
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1901
2018
  defaultOptions: import_v43.default.array(
1902
2019
  import_v43.default.object({
1903
2020
  label: import_v43.default.string(),
1904
2021
  value: import_v43.default.string()
1905
2022
  })
1906
- ).optional()
2023
+ ).optional().describe(
2024
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2025
+ )
1907
2026
  })
1908
- }).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
+ });
1909
2031
  var SearchField = HttpField.extend({
1910
2032
  type: import_v43.default.literal(FieldType.SEARCH),
1911
2033
  configuration: SearchQuery.pick({
@@ -1938,6 +2060,9 @@ var SearchField = HttpField.extend({
1938
2060
  ok: TranslationConfig.optional()
1939
2061
  }).optional()
1940
2062
  })
2063
+ }).meta({
2064
+ description: "A search input field",
2065
+ id: "SearchField"
1941
2066
  });
1942
2067
  var LinkButtonField = BaseField.extend({
1943
2068
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1946,7 +2071,10 @@ var LinkButtonField = BaseField.extend({
1946
2071
  text: TranslationConfig.describe("Text to display on the button"),
1947
2072
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1948
2073
  })
1949
- }).describe("Button that opens a link");
2074
+ }).meta({
2075
+ description: "A button that opens a URL link",
2076
+ id: "LinkButtonField"
2077
+ });
1950
2078
  var VerificationStatus = BaseField.extend({
1951
2079
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1952
2080
  defaultValue: VerificationStatusValue.optional(),
@@ -1956,15 +2084,19 @@ var VerificationStatus = BaseField.extend({
1956
2084
  "Explaining text on the banner in form."
1957
2085
  )
1958
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"
1959
2090
  });
1960
2091
  var QueryParamReaderField = BaseField.extend({
1961
2092
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1962
2093
  configuration: import_v43.default.object({
1963
2094
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1964
2095
  })
1965
- }).describe(
1966
- "A field that maps URL query params into form values and clears them afterward"
1967
- );
2096
+ }).meta({
2097
+ description: "A field that maps URL query params into form values and clears them afterward",
2098
+ id: "QueryParamReaderField"
2099
+ });
1968
2100
  var QrReaderField = BaseField.extend({
1969
2101
  type: import_v43.default.literal(FieldType.QR_READER),
1970
2102
  defaultValue: QrReaderFieldValue.optional(),
@@ -1975,7 +2107,7 @@ var QrReaderField = BaseField.extend({
1975
2107
  })
1976
2108
  }).optional()
1977
2109
  }).meta({
1978
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2110
+ description: "QR code reader field, including optional JSON Schema validator.",
1979
2111
  id: "QrReaderField"
1980
2112
  });
1981
2113
  var IdReaderField = BaseField.extend({
@@ -1984,12 +2116,18 @@ var IdReaderField = BaseField.extend({
1984
2116
  methods: import_v43.default.array(
1985
2117
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1986
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"
1987
2122
  });
1988
2123
  var CustomField = BaseField.extend({
1989
2124
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1990
2125
  defaultValue: CustomFieldValue.optional(),
1991
2126
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1992
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"
1993
2131
  });
1994
2132
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
1995
2133
  var LoaderField = BaseField.extend({
@@ -1999,22 +2137,25 @@ var LoaderField = BaseField.extend({
1999
2137
  configuration: import_v43.default.object({
2000
2138
  text: TranslationConfig.describe("Display text above the loading spinner")
2001
2139
  })
2002
- }).describe(
2003
- "A non-interactive field that indicates an in progress operation in form"
2004
- );
2140
+ }).meta({
2141
+ description: "A non-interactive field that indicates an in progress operation in form",
2142
+ id: "LoaderField"
2143
+ });
2005
2144
  var HiddenField = BaseField.extend({
2006
2145
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2007
2146
  required: import_v43.default.boolean().default(false).optional(),
2008
2147
  defaultValue: TextValue.optional()
2009
- }).describe(
2010
- "A non-interactive, hidden field that only hold a value in the form"
2011
- );
2148
+ }).meta({
2149
+ description: "A non-interactive, hidden field that only hold a value in the form",
2150
+ id: "HiddenField"
2151
+ });
2012
2152
  var UserRoleField = BaseField.extend({
2013
2153
  type: import_v43.default.literal(FieldType.USER_ROLE),
2014
2154
  defaultValue: TextValue.optional()
2015
- }).describe(
2016
- "A select dropdown that is automatically populated with available user roles"
2017
- );
2155
+ }).meta({
2156
+ description: "A select dropdown that is automatically populated with available user roles",
2157
+ id: "UserRoleField"
2158
+ });
2018
2159
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2019
2160
  FieldGroup,
2020
2161
  Address,