@opencrvs/toolkit 2.0.0-rc.d603f53 → 2.0.0-rc.d6d6f02

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
@@ -1396,14 +1407,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1396
1407
  }
1397
1408
  }).describe("Unique identifier for the field");
1398
1409
  var FieldReference = import_v43.default.object({
1399
- $$field: FieldId,
1410
+ $$field: FieldId.describe("Id of the field to reference"),
1400
1411
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1401
1412
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1402
1413
  )
1403
1414
  }).describe("Reference to a field by its ID");
1404
1415
  var ValidationConfig = import_v43.default.object({
1405
- validator: Conditional,
1406
- 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."
1407
1425
  });
1408
1426
  var requiredSchema = import_v43.default.union([
1409
1427
  import_v43.default.boolean(),
@@ -1442,6 +1460,9 @@ var BaseField = import_v43.default.object({
1442
1460
  }).describe("Common properties shared across all field types.");
1443
1461
  var Divider = BaseField.extend({
1444
1462
  type: import_v43.default.literal(FieldType.DIVIDER)
1463
+ }).meta({
1464
+ description: "A horizontal line divider",
1465
+ id: "Divider"
1445
1466
  });
1446
1467
  var TextField = BaseField.extend({
1447
1468
  type: import_v43.default.literal(FieldType.TEXT),
@@ -1452,7 +1473,10 @@ var TextField = BaseField.extend({
1452
1473
  prefix: TranslationConfig.optional(),
1453
1474
  postfix: TranslationConfig.optional()
1454
1475
  }).default({ type: "text" }).optional()
1455
- }).describe("Text input");
1476
+ }).meta({
1477
+ description: "A text input field",
1478
+ id: "TextField"
1479
+ });
1456
1480
  var NumberField = BaseField.extend({
1457
1481
  type: import_v43.default.literal(FieldType.NUMBER),
1458
1482
  defaultValue: NumberFieldValue.optional(),
@@ -1462,7 +1486,10 @@ var NumberField = BaseField.extend({
1462
1486
  prefix: TranslationConfig.optional(),
1463
1487
  postfix: TranslationConfig.optional()
1464
1488
  }).optional()
1465
- }).describe("Number input");
1489
+ }).meta({
1490
+ description: "A number input field",
1491
+ id: "NumberField"
1492
+ });
1466
1493
  var TextAreaField = BaseField.extend({
1467
1494
  type: import_v43.default.literal(FieldType.TEXTAREA),
1468
1495
  defaultValue: NonEmptyTextValue.optional(),
@@ -1473,7 +1500,10 @@ var TextAreaField = BaseField.extend({
1473
1500
  prefix: TranslationConfig.optional(),
1474
1501
  postfix: TranslationConfig.optional()
1475
1502
  }).default({ rows: 4 }).optional()
1476
- }).describe("Multiline text input");
1503
+ }).meta({
1504
+ description: "A multiline text input",
1505
+ id: "TextAreaField"
1506
+ });
1477
1507
  var ImageMimeType = import_v43.default.enum([
1478
1508
  "image/png",
1479
1509
  "image/jpg",
@@ -1503,13 +1533,19 @@ var SignatureField = BaseField.extend({
1503
1533
  }).default({
1504
1534
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1505
1535
  })
1506
- }).describe("Signature input field");
1536
+ }).meta({
1537
+ description: "A signature input field",
1538
+ id: "SignatureField"
1539
+ });
1507
1540
  var EmailField = BaseField.extend({
1508
1541
  type: import_v43.default.literal(FieldType.EMAIL),
1509
1542
  configuration: import_v43.default.object({
1510
1543
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1511
1544
  }).default({ maxLength: 255 }).optional(),
1512
1545
  defaultValue: NonEmptyTextValue.optional()
1546
+ }).meta({
1547
+ description: "An email input field",
1548
+ id: "EmailField"
1513
1549
  });
1514
1550
  var DateField = BaseField.extend({
1515
1551
  type: import_v43.default.literal(FieldType.DATE),
@@ -1519,7 +1555,10 @@ var DateField = BaseField.extend({
1519
1555
  "Text to display above the date input"
1520
1556
  ).optional()
1521
1557
  }).optional()
1522
- }).describe("A single date input (yyyy-MM-dd)");
1558
+ }).meta({
1559
+ description: "A date input (yyyy-MM-dd)",
1560
+ id: "DateField"
1561
+ });
1523
1562
  var AgeField = BaseField.extend({
1524
1563
  type: import_v43.default.literal(FieldType.AGE),
1525
1564
  defaultValue: NumberFieldValue.optional(),
@@ -1528,7 +1567,10 @@ var AgeField = BaseField.extend({
1528
1567
  prefix: TranslationConfig.optional(),
1529
1568
  postfix: TranslationConfig.optional()
1530
1569
  })
1531
- }).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
+ });
1532
1574
  var TimeField = BaseField.extend({
1533
1575
  type: import_v43.default.literal(FieldType.TIME),
1534
1576
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -1538,7 +1580,10 @@ var TimeField = BaseField.extend({
1538
1580
  "Text to display above the time input"
1539
1581
  ).optional()
1540
1582
  }).optional()
1541
- }).describe("A single date input (HH-mm)");
1583
+ }).meta({
1584
+ description: "A single time input (HH-mm)",
1585
+ id: "TimeField"
1586
+ });
1542
1587
  var DateRangeField = BaseField.extend({
1543
1588
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1544
1589
  defaultValue: DateRangeFieldValue.optional(),
@@ -1547,7 +1592,10 @@ var DateRangeField = BaseField.extend({
1547
1592
  "Text to display above the date input"
1548
1593
  ).optional()
1549
1594
  }).optional()
1550
- }).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
+ });
1551
1599
  var HtmlFontVariant = import_v43.default.enum([
1552
1600
  "reg12",
1553
1601
  "reg14",
@@ -1591,18 +1639,30 @@ var ImageViewField = BaseField.extend({
1591
1639
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1592
1640
  defaultValue: NonEmptyTextValue.optional(),
1593
1641
  configuration: ImageConfiguration
1594
- }).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
+ });
1595
1646
  var Paragraph = BaseField.extend({
1596
1647
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1597
1648
  configuration: ParagraphConfiguration
1598
- }).describe("A read-only HTML <p> paragraph");
1649
+ }).meta({
1650
+ description: "A read-only HTML <p> paragraph",
1651
+ id: "Paragraph"
1652
+ });
1599
1653
  var Heading = BaseField.extend({
1600
1654
  type: import_v43.default.literal(FieldType.HEADING),
1601
1655
  configuration: HeadingConfiguration
1602
- }).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
+ });
1603
1660
  var PageHeader = BaseField.extend({
1604
1661
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1605
- }).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
+ });
1606
1666
  var File = BaseField.extend({
1607
1667
  type: import_v43.default.literal(FieldType.FILE),
1608
1668
  defaultValue: FileFieldValue.optional(),
@@ -1621,7 +1681,10 @@ var File = BaseField.extend({
1621
1681
  }).default({
1622
1682
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1623
1683
  })
1624
- }).describe("File upload");
1684
+ }).meta({
1685
+ description: "A file upload field",
1686
+ id: "File"
1687
+ });
1625
1688
  var SelectOption = import_v43.default.object({
1626
1689
  value: import_v43.default.string().describe("The value of the option"),
1627
1690
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1638,7 +1701,10 @@ var NumberWithUnitField = BaseField.extend({
1638
1701
  "Placeholder for the number field"
1639
1702
  )
1640
1703
  }).optional()
1641
- }).describe("Number with unit input");
1704
+ }).meta({
1705
+ description: "A number with unit input field",
1706
+ id: "NumberWithUnitField"
1707
+ });
1642
1708
  var RadioGroup = BaseField.extend({
1643
1709
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1644
1710
  defaultValue: TextValue.optional(),
@@ -1648,7 +1714,10 @@ var RadioGroup = BaseField.extend({
1648
1714
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1649
1715
  }).optional()
1650
1716
  }).optional()
1651
- }).describe("Grouped radio options");
1717
+ }).meta({
1718
+ description: "A grouped radio button field",
1719
+ id: "RadioGroup"
1720
+ });
1652
1721
  var BulletList = BaseField.extend({
1653
1722
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1654
1723
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1657,7 +1726,10 @@ var BulletList = BaseField.extend({
1657
1726
  fontVariant: HtmlFontVariant.optional()
1658
1727
  }).optional()
1659
1728
  }).default({})
1660
- }).describe("A list of bullet points");
1729
+ }).meta({
1730
+ description: "A list of bullet points",
1731
+ id: "BulletList"
1732
+ });
1661
1733
  var Select = BaseField.extend({
1662
1734
  type: import_v43.default.literal(FieldType.SELECT),
1663
1735
  defaultValue: TextValue.optional(),
@@ -1672,7 +1744,10 @@ var Select = BaseField.extend({
1672
1744
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1673
1745
  `
1674
1746
  )
1675
- }).describe("Select input");
1747
+ }).meta({
1748
+ description: "A select input field",
1749
+ id: "Select"
1750
+ });
1676
1751
  var SelectDateRangeOption = import_v43.default.object({
1677
1752
  value: SelectDateRangeValue.describe("The value of the option"),
1678
1753
  label: TranslationConfig.describe("The label of the option")
@@ -1681,7 +1756,10 @@ var SelectDateRangeField = BaseField.extend({
1681
1756
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1682
1757
  defaultValue: SelectDateRangeValue.optional(),
1683
1758
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1684
- }).describe("Select input with date range options");
1759
+ }).meta({
1760
+ description: "A date range selection field",
1761
+ id: "SelectDateRangeField"
1762
+ });
1685
1763
  var NameConfig = import_v43.default.object({
1686
1764
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1687
1765
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1712,26 +1790,41 @@ var NameField = BaseField.extend({
1712
1790
  surname: { required: true }
1713
1791
  }
1714
1792
  }).optional()
1715
- }).describe("Name input field");
1793
+ }).meta({
1794
+ description: "A field for entering a persons name",
1795
+ id: "NameField"
1796
+ });
1716
1797
  var PhoneField = BaseField.extend({
1717
1798
  defaultValue: NonEmptyTextValue.optional(),
1718
1799
  type: import_v43.default.literal(FieldType.PHONE)
1719
- }).describe("Phone input field");
1800
+ }).meta({
1801
+ description: "A field for entering a phone number",
1802
+ id: "PhoneField"
1803
+ });
1720
1804
  var IdField = BaseField.extend({
1721
1805
  defaultValue: NonEmptyTextValue.optional(),
1722
1806
  type: import_v43.default.literal(FieldType.ID)
1723
- }).describe("ID input field");
1807
+ }).meta({
1808
+ description: "A field for entering an ID",
1809
+ id: "IdField"
1810
+ });
1724
1811
  var Checkbox = BaseField.extend({
1725
1812
  type: import_v43.default.literal(FieldType.CHECKBOX),
1726
1813
  defaultValue: CheckboxFieldValue.default(false)
1727
- }).describe("Boolean checkbox field");
1814
+ }).meta({
1815
+ description: "A boolean checkbox field",
1816
+ id: "Checkbox"
1817
+ });
1728
1818
  var Country = BaseField.extend({
1729
1819
  type: import_v43.default.literal(FieldType.COUNTRY),
1730
1820
  defaultValue: NonEmptyTextValue.optional(),
1731
1821
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1732
1822
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1733
1823
  )
1734
- }).describe("Country select field");
1824
+ }).meta({
1825
+ description: "A field for selecting a country",
1826
+ id: "Country"
1827
+ });
1735
1828
  var AllowedLocations = JurisdictionReference.optional().describe(
1736
1829
  "Limits which location options are selectable depending on user jurisdiction and location."
1737
1830
  );
@@ -1740,16 +1833,18 @@ var AdministrativeAreas = import_v43.default.enum([
1740
1833
  "HEALTH_FACILITY",
1741
1834
  "CRVS_OFFICE"
1742
1835
  ]);
1743
- var AdministrativeAreaConfiguration = import_v43.default.object({
1744
- partOf: FieldReference.optional().describe("Parent location"),
1745
- type: AdministrativeAreas,
1746
- allowedLocations: AllowedLocations
1747
- }).describe("Administrative area options");
1748
1836
  var AdministrativeAreaField = BaseField.extend({
1749
1837
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
1750
1838
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
1751
- configuration: AdministrativeAreaConfiguration
1752
- }).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
+ });
1753
1848
  var LocationInput = BaseField.extend({
1754
1849
  type: import_v43.default.literal(FieldType.LOCATION),
1755
1850
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -1757,7 +1852,10 @@ var LocationInput = BaseField.extend({
1757
1852
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
1758
1853
  allowedLocations: AllowedLocations
1759
1854
  }).optional()
1760
- }).describe("Input field for a location");
1855
+ }).meta({
1856
+ description: "A field for selecting a location",
1857
+ id: "LocationInput"
1858
+ });
1761
1859
  var FileUploadWithOptions = BaseField.extend({
1762
1860
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
1763
1861
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -1771,6 +1869,9 @@ var FileUploadWithOptions = BaseField.extend({
1771
1869
  }).default({
1772
1870
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1773
1871
  })
1872
+ }).meta({
1873
+ description: "A field for uploading files with file type options",
1874
+ id: "FileUploadWithOptions"
1774
1875
  });
1775
1876
  var Facility = BaseField.extend({
1776
1877
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -1816,7 +1917,10 @@ var Address = BaseField.extend({
1816
1917
  allowedLocations: AllowedLocations
1817
1918
  }).optional(),
1818
1919
  defaultValue: DefaultAddressFieldValue.optional()
1819
- }).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
+ });
1820
1924
  var StaticDataEntry = import_v43.default.object({
1821
1925
  id: import_v43.default.string().describe("ID for the data entry."),
1822
1926
  label: TranslationConfig,
@@ -1831,7 +1935,10 @@ var DataField = BaseField.extend({
1831
1935
  subtitle: TranslationConfig.optional(),
1832
1936
  data: import_v43.default.array(DataEntry)
1833
1937
  })
1834
- }).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
+ });
1835
1942
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
1836
1943
  var ButtonType = import_v43.default.enum([
1837
1944
  "primary",
@@ -1858,11 +1965,17 @@ var ButtonField = BaseField.extend({
1858
1965
  type: import_v43.default.literal(FieldType.BUTTON),
1859
1966
  defaultValue: ButtonFieldValue.optional(),
1860
1967
  configuration: ButtonConfiguration
1861
- }).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
+ });
1862
1972
  var FieldGroup = BaseField.extend({
1863
1973
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
1864
1974
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
1865
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"
1866
1979
  });
1867
1980
  var AlphaPrintButton = BaseField.extend({
1868
1981
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -1872,7 +1985,10 @@ var AlphaPrintButton = BaseField.extend({
1872
1985
  "Label for the print button"
1873
1986
  )
1874
1987
  })
1875
- }).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
+ });
1876
1992
  var HttpField = BaseField.extend({
1877
1993
  type: import_v43.default.literal(FieldType.HTTP),
1878
1994
  defaultValue: HttpFieldValue.optional(),
@@ -1888,20 +2004,30 @@ var HttpField = BaseField.extend({
1888
2004
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
1889
2005
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
1890
2006
  })
1891
- }).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
+ });
1892
2011
  var AutocompleteField = BaseField.extend({
1893
2012
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
1894
2013
  configuration: import_v43.default.object({
1895
- 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(),
1896
2017
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
1897
2018
  defaultOptions: import_v43.default.array(
1898
2019
  import_v43.default.object({
1899
2020
  label: import_v43.default.string(),
1900
2021
  value: import_v43.default.string()
1901
2022
  })
1902
- ).optional()
2023
+ ).optional().describe(
2024
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2025
+ )
1903
2026
  })
1904
- }).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
+ });
1905
2031
  var SearchField = HttpField.extend({
1906
2032
  type: import_v43.default.literal(FieldType.SEARCH),
1907
2033
  configuration: SearchQuery.pick({
@@ -1934,6 +2060,9 @@ var SearchField = HttpField.extend({
1934
2060
  ok: TranslationConfig.optional()
1935
2061
  }).optional()
1936
2062
  })
2063
+ }).meta({
2064
+ description: "A search input field",
2065
+ id: "SearchField"
1937
2066
  });
1938
2067
  var LinkButtonField = BaseField.extend({
1939
2068
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -1942,7 +2071,10 @@ var LinkButtonField = BaseField.extend({
1942
2071
  text: TranslationConfig.describe("Text to display on the button"),
1943
2072
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
1944
2073
  })
1945
- }).describe("Button that opens a link");
2074
+ }).meta({
2075
+ description: "A button that opens a URL link",
2076
+ id: "LinkButtonField"
2077
+ });
1946
2078
  var VerificationStatus = BaseField.extend({
1947
2079
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
1948
2080
  defaultValue: VerificationStatusValue.optional(),
@@ -1952,15 +2084,19 @@ var VerificationStatus = BaseField.extend({
1952
2084
  "Explaining text on the banner in form."
1953
2085
  )
1954
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"
1955
2090
  });
1956
2091
  var QueryParamReaderField = BaseField.extend({
1957
2092
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
1958
2093
  configuration: import_v43.default.object({
1959
2094
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
1960
2095
  })
1961
- }).describe(
1962
- "A field that maps URL query params into form values and clears them afterward"
1963
- );
2096
+ }).meta({
2097
+ description: "A field that maps URL query params into form values and clears them afterward",
2098
+ id: "QueryParamReaderField"
2099
+ });
1964
2100
  var QrReaderField = BaseField.extend({
1965
2101
  type: import_v43.default.literal(FieldType.QR_READER),
1966
2102
  defaultValue: QrReaderFieldValue.optional(),
@@ -1971,7 +2107,7 @@ var QrReaderField = BaseField.extend({
1971
2107
  })
1972
2108
  }).optional()
1973
2109
  }).meta({
1974
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2110
+ description: "QR code reader field, including optional JSON Schema validator.",
1975
2111
  id: "QrReaderField"
1976
2112
  });
1977
2113
  var IdReaderField = BaseField.extend({
@@ -1980,12 +2116,18 @@ var IdReaderField = BaseField.extend({
1980
2116
  methods: import_v43.default.array(
1981
2117
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
1982
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"
1983
2122
  });
1984
2123
  var CustomField = BaseField.extend({
1985
2124
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
1986
2125
  defaultValue: CustomFieldValue.optional(),
1987
2126
  src: import_v43.default.string().describe("Module source path for the custom field component"),
1988
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"
1989
2131
  });
1990
2132
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
1991
2133
  var LoaderField = BaseField.extend({
@@ -1995,22 +2137,25 @@ var LoaderField = BaseField.extend({
1995
2137
  configuration: import_v43.default.object({
1996
2138
  text: TranslationConfig.describe("Display text above the loading spinner")
1997
2139
  })
1998
- }).describe(
1999
- "A non-interactive field that indicates an in progress operation in form"
2000
- );
2140
+ }).meta({
2141
+ description: "A non-interactive field that indicates an in progress operation in form",
2142
+ id: "LoaderField"
2143
+ });
2001
2144
  var HiddenField = BaseField.extend({
2002
2145
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2003
2146
  required: import_v43.default.boolean().default(false).optional(),
2004
2147
  defaultValue: TextValue.optional()
2005
- }).describe(
2006
- "A non-interactive, hidden field that only hold a value in the form"
2007
- );
2148
+ }).meta({
2149
+ description: "A non-interactive, hidden field that only hold a value in the form",
2150
+ id: "HiddenField"
2151
+ });
2008
2152
  var UserRoleField = BaseField.extend({
2009
2153
  type: import_v43.default.literal(FieldType.USER_ROLE),
2010
2154
  defaultValue: TextValue.optional()
2011
- }).describe(
2012
- "A select dropdown that is automatically populated with available user roles"
2013
- );
2155
+ }).meta({
2156
+ description: "A select dropdown that is automatically populated with available user roles",
2157
+ id: "UserRoleField"
2158
+ });
2014
2159
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2015
2160
  FieldGroup,
2016
2161
  Address,
package/dist/cli.js CHANGED
@@ -2393,7 +2393,9 @@ var decodeScope = (query) => {
2393
2393
  };
2394
2394
  var DEFAULT_SCOPE_OPTIONS = {
2395
2395
  placeOfEvent: JurisdictionFilter.enum.all,
2396
- accessLevel: JurisdictionFilter.enum.all
2396
+ accessLevel: JurisdictionFilter.enum.all,
2397
+ registeredIn: JurisdictionFilter.enum.all,
2398
+ declaredIn: JurisdictionFilter.enum.all
2397
2399
  };
2398
2400
 
2399
2401
  // ../commons/src/scopes.deprecated.do-not-use.ts
@@ -8079,7 +8079,7 @@ export declare const appRouter: import("@trpc/server").TRPCBuiltRouter<{
8079
8079
  $event: "id" | "createdBy" | "createdAt" | "status" | "createdByUserType" | "createdAtLocation" | "updatedAt" | "assignedTo" | "trackingId" | "type" | "flags" | "dateOfEvent" | "placeOfEvent" | "title" | "legalStatuses" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "outbox";
8080
8080
  };
8081
8081
  }[];
8082
- icon: "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "File" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
8082
+ icon: "File" | "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
8083
8083
  action?: {
8084
8084
  type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
8085
8085
  } | undefined;