@opencrvs/toolkit 2.0.0-rc.ddf354d → 2.0.0-rc.de6e7de
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.
- package/create-countryconfig/package.json +12 -2
- package/dist/application-config/index.js +197 -63
- package/dist/commons/api/router.d.ts +1 -1
- package/dist/commons/events/WorkqueueConfig.d.ts +5 -5
- package/dist/events/index.js +240 -77
- package/dist/notification/index.js +240 -77
- package/opencrvs-toolkit-2.0.0-rc.de6e7de.tgz +0 -0
- package/package.json +5 -1
- package/opencrvs-toolkit-2.0.0-rc.ddf354d.tgz +0 -0
|
@@ -5,7 +5,17 @@
|
|
|
5
5
|
"bin": {
|
|
6
6
|
"create-countryconfig": "./index.js"
|
|
7
7
|
},
|
|
8
|
-
"
|
|
9
|
-
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/opencrvs/opencrvs-core.git"
|
|
11
|
+
},
|
|
12
|
+
"files": [
|
|
13
|
+
"index.js"
|
|
14
|
+
],
|
|
15
|
+
"keywords": [
|
|
16
|
+
"opencrvs",
|
|
17
|
+
"countryconfig",
|
|
18
|
+
"create"
|
|
19
|
+
],
|
|
10
20
|
"license": "MPL-2.0"
|
|
11
21
|
}
|
|
@@ -76,8 +76,8 @@ var ActionConditional = z.discriminatedUnion("type", [
|
|
|
76
76
|
// Action can be shown to the user in the list but as disabled
|
|
77
77
|
EnableConditional
|
|
78
78
|
]).meta({
|
|
79
|
-
|
|
80
|
-
|
|
79
|
+
id: "ActionConditional",
|
|
80
|
+
description: "Conditional gating whether an action is shown (SHOW) or enabled (ENABLE). When omitted from an action, the action is shown and enabled for everyone."
|
|
81
81
|
});
|
|
82
82
|
var DisplayOnReviewConditional = z.object({
|
|
83
83
|
type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
|
|
@@ -93,8 +93,8 @@ var FieldConditional = z.discriminatedUnion("type", [
|
|
|
93
93
|
// Field output can be shown / hidden on the review page
|
|
94
94
|
DisplayOnReviewConditional
|
|
95
95
|
]).meta({
|
|
96
|
-
|
|
97
|
-
|
|
96
|
+
id: "FieldConditional",
|
|
97
|
+
description: "Conditional gating whether a form field is shown (SHOW), enabled (ENABLE), or displayed on the review page (DISPLAY_ON_REVIEW). When omitted, the field is shown and enabled for everyone, and is displayed on review whenever it has a value."
|
|
98
98
|
});
|
|
99
99
|
|
|
100
100
|
// ../commons/src/events/TranslationConfig.ts
|
|
@@ -1083,8 +1083,8 @@ var FlagConfig = z14.object({
|
|
|
1083
1083
|
),
|
|
1084
1084
|
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
1085
1085
|
}).meta({
|
|
1086
|
-
|
|
1087
|
-
|
|
1086
|
+
id: "FlagConfig",
|
|
1087
|
+
description: "Configuration for a custom flag that can be added to or removed from records by event actions."
|
|
1088
1088
|
});
|
|
1089
1089
|
var ActionFlagConfig = z14.object({
|
|
1090
1090
|
id: Flag,
|
|
@@ -1093,8 +1093,8 @@ var ActionFlagConfig = z14.object({
|
|
|
1093
1093
|
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1094
1094
|
)
|
|
1095
1095
|
}).meta({
|
|
1096
|
-
|
|
1097
|
-
|
|
1096
|
+
id: "ActionFlagConfig",
|
|
1097
|
+
description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
|
|
1098
1098
|
});
|
|
1099
1099
|
|
|
1100
1100
|
// ../commons/src/events/EventMetadata.ts
|
|
@@ -1413,8 +1413,15 @@ var FieldReference = import_v43.default.object({
|
|
|
1413
1413
|
)
|
|
1414
1414
|
}).describe("Reference to a field by its ID");
|
|
1415
1415
|
var ValidationConfig = import_v43.default.object({
|
|
1416
|
-
validator: Conditional
|
|
1417
|
-
|
|
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."
|
|
1418
1425
|
});
|
|
1419
1426
|
var requiredSchema = import_v43.default.union([
|
|
1420
1427
|
import_v43.default.boolean(),
|
|
@@ -1453,6 +1460,9 @@ var BaseField = import_v43.default.object({
|
|
|
1453
1460
|
}).describe("Common properties shared across all field types.");
|
|
1454
1461
|
var Divider = BaseField.extend({
|
|
1455
1462
|
type: import_v43.default.literal(FieldType.DIVIDER)
|
|
1463
|
+
}).meta({
|
|
1464
|
+
description: "A horizontal line divider",
|
|
1465
|
+
id: "Divider"
|
|
1456
1466
|
});
|
|
1457
1467
|
var TextField = BaseField.extend({
|
|
1458
1468
|
type: import_v43.default.literal(FieldType.TEXT),
|
|
@@ -1463,7 +1473,10 @@ var TextField = BaseField.extend({
|
|
|
1463
1473
|
prefix: TranslationConfig.optional(),
|
|
1464
1474
|
postfix: TranslationConfig.optional()
|
|
1465
1475
|
}).default({ type: "text" }).optional()
|
|
1466
|
-
}).
|
|
1476
|
+
}).meta({
|
|
1477
|
+
description: "A text input field",
|
|
1478
|
+
id: "TextField"
|
|
1479
|
+
});
|
|
1467
1480
|
var NumberField = BaseField.extend({
|
|
1468
1481
|
type: import_v43.default.literal(FieldType.NUMBER),
|
|
1469
1482
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -1473,7 +1486,10 @@ var NumberField = BaseField.extend({
|
|
|
1473
1486
|
prefix: TranslationConfig.optional(),
|
|
1474
1487
|
postfix: TranslationConfig.optional()
|
|
1475
1488
|
}).optional()
|
|
1476
|
-
}).
|
|
1489
|
+
}).meta({
|
|
1490
|
+
description: "A number input field",
|
|
1491
|
+
id: "NumberField"
|
|
1492
|
+
});
|
|
1477
1493
|
var TextAreaField = BaseField.extend({
|
|
1478
1494
|
type: import_v43.default.literal(FieldType.TEXTAREA),
|
|
1479
1495
|
defaultValue: NonEmptyTextValue.optional(),
|
|
@@ -1484,7 +1500,10 @@ var TextAreaField = BaseField.extend({
|
|
|
1484
1500
|
prefix: TranslationConfig.optional(),
|
|
1485
1501
|
postfix: TranslationConfig.optional()
|
|
1486
1502
|
}).default({ rows: 4 }).optional()
|
|
1487
|
-
}).
|
|
1503
|
+
}).meta({
|
|
1504
|
+
description: "A multiline text input",
|
|
1505
|
+
id: "TextAreaField"
|
|
1506
|
+
});
|
|
1488
1507
|
var ImageMimeType = import_v43.default.enum([
|
|
1489
1508
|
"image/png",
|
|
1490
1509
|
"image/jpg",
|
|
@@ -1514,13 +1533,19 @@ var SignatureField = BaseField.extend({
|
|
|
1514
1533
|
}).default({
|
|
1515
1534
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1516
1535
|
})
|
|
1517
|
-
}).
|
|
1536
|
+
}).meta({
|
|
1537
|
+
description: "A signature input field",
|
|
1538
|
+
id: "SignatureField"
|
|
1539
|
+
});
|
|
1518
1540
|
var EmailField = BaseField.extend({
|
|
1519
1541
|
type: import_v43.default.literal(FieldType.EMAIL),
|
|
1520
1542
|
configuration: import_v43.default.object({
|
|
1521
1543
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
|
|
1522
1544
|
}).default({ maxLength: 255 }).optional(),
|
|
1523
1545
|
defaultValue: NonEmptyTextValue.optional()
|
|
1546
|
+
}).meta({
|
|
1547
|
+
description: "An email input field",
|
|
1548
|
+
id: "EmailField"
|
|
1524
1549
|
});
|
|
1525
1550
|
var DateField = BaseField.extend({
|
|
1526
1551
|
type: import_v43.default.literal(FieldType.DATE),
|
|
@@ -1530,7 +1555,10 @@ var DateField = BaseField.extend({
|
|
|
1530
1555
|
"Text to display above the date input"
|
|
1531
1556
|
).optional()
|
|
1532
1557
|
}).optional()
|
|
1533
|
-
}).
|
|
1558
|
+
}).meta({
|
|
1559
|
+
description: "A date input (yyyy-MM-dd)",
|
|
1560
|
+
id: "DateField"
|
|
1561
|
+
});
|
|
1534
1562
|
var AgeField = BaseField.extend({
|
|
1535
1563
|
type: import_v43.default.literal(FieldType.AGE),
|
|
1536
1564
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -1539,7 +1567,10 @@ var AgeField = BaseField.extend({
|
|
|
1539
1567
|
prefix: TranslationConfig.optional(),
|
|
1540
1568
|
postfix: TranslationConfig.optional()
|
|
1541
1569
|
})
|
|
1542
|
-
}).
|
|
1570
|
+
}).meta({
|
|
1571
|
+
description: "An age input field which uses the current date as the asOfDate",
|
|
1572
|
+
id: "AgeField"
|
|
1573
|
+
});
|
|
1543
1574
|
var TimeField = BaseField.extend({
|
|
1544
1575
|
type: import_v43.default.literal(FieldType.TIME),
|
|
1545
1576
|
defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
|
|
@@ -1549,7 +1580,10 @@ var TimeField = BaseField.extend({
|
|
|
1549
1580
|
"Text to display above the time input"
|
|
1550
1581
|
).optional()
|
|
1551
1582
|
}).optional()
|
|
1552
|
-
}).
|
|
1583
|
+
}).meta({
|
|
1584
|
+
description: "A single time input (HH-mm)",
|
|
1585
|
+
id: "TimeField"
|
|
1586
|
+
});
|
|
1553
1587
|
var DateRangeField = BaseField.extend({
|
|
1554
1588
|
type: import_v43.default.literal(FieldType.DATE_RANGE),
|
|
1555
1589
|
defaultValue: DateRangeFieldValue.optional(),
|
|
@@ -1558,7 +1592,10 @@ var DateRangeField = BaseField.extend({
|
|
|
1558
1592
|
"Text to display above the date input"
|
|
1559
1593
|
).optional()
|
|
1560
1594
|
}).optional()
|
|
1561
|
-
}).
|
|
1595
|
+
}).meta({
|
|
1596
|
+
description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
|
|
1597
|
+
id: "DateRangeField"
|
|
1598
|
+
});
|
|
1562
1599
|
var HtmlFontVariant = import_v43.default.enum([
|
|
1563
1600
|
"reg12",
|
|
1564
1601
|
"reg14",
|
|
@@ -1602,18 +1639,30 @@ var ImageViewField = BaseField.extend({
|
|
|
1602
1639
|
type: import_v43.default.literal(FieldType.IMAGE_VIEW),
|
|
1603
1640
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1604
1641
|
configuration: ImageConfiguration
|
|
1605
|
-
}).
|
|
1642
|
+
}).meta({
|
|
1643
|
+
description: "A read-only image component for form pages",
|
|
1644
|
+
id: "ImageViewField"
|
|
1645
|
+
});
|
|
1606
1646
|
var Paragraph = BaseField.extend({
|
|
1607
1647
|
type: import_v43.default.literal(FieldType.PARAGRAPH),
|
|
1608
1648
|
configuration: ParagraphConfiguration
|
|
1609
|
-
}).
|
|
1649
|
+
}).meta({
|
|
1650
|
+
description: "A read-only HTML <p> paragraph",
|
|
1651
|
+
id: "Paragraph"
|
|
1652
|
+
});
|
|
1610
1653
|
var Heading = BaseField.extend({
|
|
1611
1654
|
type: import_v43.default.literal(FieldType.HEADING),
|
|
1612
1655
|
configuration: HeadingConfiguration
|
|
1613
|
-
}).
|
|
1656
|
+
}).meta({
|
|
1657
|
+
description: "A read-only heading component for form pages",
|
|
1658
|
+
id: "Heading"
|
|
1659
|
+
});
|
|
1614
1660
|
var PageHeader = BaseField.extend({
|
|
1615
1661
|
type: import_v43.default.literal(FieldType.PAGE_HEADER)
|
|
1616
|
-
}).
|
|
1662
|
+
}).meta({
|
|
1663
|
+
description: "A read-only header component for form pages",
|
|
1664
|
+
id: "PageHeader"
|
|
1665
|
+
});
|
|
1617
1666
|
var File = BaseField.extend({
|
|
1618
1667
|
type: import_v43.default.literal(FieldType.FILE),
|
|
1619
1668
|
defaultValue: FileFieldValue.optional(),
|
|
@@ -1632,7 +1681,10 @@ var File = BaseField.extend({
|
|
|
1632
1681
|
}).default({
|
|
1633
1682
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1634
1683
|
})
|
|
1635
|
-
}).
|
|
1684
|
+
}).meta({
|
|
1685
|
+
description: "A file upload field",
|
|
1686
|
+
id: "File"
|
|
1687
|
+
});
|
|
1636
1688
|
var SelectOption = import_v43.default.object({
|
|
1637
1689
|
value: import_v43.default.string().describe("The value of the option"),
|
|
1638
1690
|
label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
|
|
@@ -1649,7 +1701,10 @@ var NumberWithUnitField = BaseField.extend({
|
|
|
1649
1701
|
"Placeholder for the number field"
|
|
1650
1702
|
)
|
|
1651
1703
|
}).optional()
|
|
1652
|
-
}).
|
|
1704
|
+
}).meta({
|
|
1705
|
+
description: "A number with unit input field",
|
|
1706
|
+
id: "NumberWithUnitField"
|
|
1707
|
+
});
|
|
1653
1708
|
var RadioGroup = BaseField.extend({
|
|
1654
1709
|
type: import_v43.default.literal(FieldType.RADIO_GROUP),
|
|
1655
1710
|
defaultValue: TextValue.optional(),
|
|
@@ -1659,7 +1714,10 @@ var RadioGroup = BaseField.extend({
|
|
|
1659
1714
|
size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
|
|
1660
1715
|
}).optional()
|
|
1661
1716
|
}).optional()
|
|
1662
|
-
}).
|
|
1717
|
+
}).meta({
|
|
1718
|
+
description: "A grouped radio button field",
|
|
1719
|
+
id: "RadioGroup"
|
|
1720
|
+
});
|
|
1663
1721
|
var BulletList = BaseField.extend({
|
|
1664
1722
|
type: import_v43.default.literal(FieldType.BULLET_LIST),
|
|
1665
1723
|
items: import_v43.default.array(TranslationConfig).describe("A list of items"),
|
|
@@ -1668,7 +1726,10 @@ var BulletList = BaseField.extend({
|
|
|
1668
1726
|
fontVariant: HtmlFontVariant.optional()
|
|
1669
1727
|
}).optional()
|
|
1670
1728
|
}).default({})
|
|
1671
|
-
}).
|
|
1729
|
+
}).meta({
|
|
1730
|
+
description: "A list of bullet points",
|
|
1731
|
+
id: "BulletList"
|
|
1732
|
+
});
|
|
1672
1733
|
var Select = BaseField.extend({
|
|
1673
1734
|
type: import_v43.default.literal(FieldType.SELECT),
|
|
1674
1735
|
defaultValue: TextValue.optional(),
|
|
@@ -1683,7 +1744,10 @@ var Select = BaseField.extend({
|
|
|
1683
1744
|
{ ..., defaultMessage: "'{input}' is not listed among the health facilities." }
|
|
1684
1745
|
`
|
|
1685
1746
|
)
|
|
1686
|
-
}).
|
|
1747
|
+
}).meta({
|
|
1748
|
+
description: "A select input field",
|
|
1749
|
+
id: "Select"
|
|
1750
|
+
});
|
|
1687
1751
|
var SelectDateRangeOption = import_v43.default.object({
|
|
1688
1752
|
value: SelectDateRangeValue.describe("The value of the option"),
|
|
1689
1753
|
label: TranslationConfig.describe("The label of the option")
|
|
@@ -1692,7 +1756,10 @@ var SelectDateRangeField = BaseField.extend({
|
|
|
1692
1756
|
type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
|
|
1693
1757
|
defaultValue: SelectDateRangeValue.optional(),
|
|
1694
1758
|
options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
|
|
1695
|
-
}).
|
|
1759
|
+
}).meta({
|
|
1760
|
+
description: "A date range selection field",
|
|
1761
|
+
id: "SelectDateRangeField"
|
|
1762
|
+
});
|
|
1696
1763
|
var NameConfig = import_v43.default.object({
|
|
1697
1764
|
firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
1698
1765
|
middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
@@ -1723,26 +1790,41 @@ var NameField = BaseField.extend({
|
|
|
1723
1790
|
surname: { required: true }
|
|
1724
1791
|
}
|
|
1725
1792
|
}).optional()
|
|
1726
|
-
}).
|
|
1793
|
+
}).meta({
|
|
1794
|
+
description: "A field for entering a persons name",
|
|
1795
|
+
id: "NameField"
|
|
1796
|
+
});
|
|
1727
1797
|
var PhoneField = BaseField.extend({
|
|
1728
1798
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1729
1799
|
type: import_v43.default.literal(FieldType.PHONE)
|
|
1730
|
-
}).
|
|
1800
|
+
}).meta({
|
|
1801
|
+
description: "A field for entering a phone number",
|
|
1802
|
+
id: "PhoneField"
|
|
1803
|
+
});
|
|
1731
1804
|
var IdField = BaseField.extend({
|
|
1732
1805
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1733
1806
|
type: import_v43.default.literal(FieldType.ID)
|
|
1734
|
-
}).
|
|
1807
|
+
}).meta({
|
|
1808
|
+
description: "A field for entering an ID",
|
|
1809
|
+
id: "IdField"
|
|
1810
|
+
});
|
|
1735
1811
|
var Checkbox = BaseField.extend({
|
|
1736
1812
|
type: import_v43.default.literal(FieldType.CHECKBOX),
|
|
1737
1813
|
defaultValue: CheckboxFieldValue.default(false)
|
|
1738
|
-
}).
|
|
1814
|
+
}).meta({
|
|
1815
|
+
description: "A boolean checkbox field",
|
|
1816
|
+
id: "Checkbox"
|
|
1817
|
+
});
|
|
1739
1818
|
var Country = BaseField.extend({
|
|
1740
1819
|
type: import_v43.default.literal(FieldType.COUNTRY),
|
|
1741
1820
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1742
1821
|
optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
|
|
1743
1822
|
"Conditionals for specific countries. Countries not listed are always shown and enabled."
|
|
1744
1823
|
)
|
|
1745
|
-
}).
|
|
1824
|
+
}).meta({
|
|
1825
|
+
description: "A field for selecting a country",
|
|
1826
|
+
id: "Country"
|
|
1827
|
+
});
|
|
1746
1828
|
var AllowedLocations = JurisdictionReference.optional().describe(
|
|
1747
1829
|
"Limits which location options are selectable depending on user jurisdiction and location."
|
|
1748
1830
|
);
|
|
@@ -1751,16 +1833,18 @@ var AdministrativeAreas = import_v43.default.enum([
|
|
|
1751
1833
|
"HEALTH_FACILITY",
|
|
1752
1834
|
"CRVS_OFFICE"
|
|
1753
1835
|
]);
|
|
1754
|
-
var AdministrativeAreaConfiguration = import_v43.default.object({
|
|
1755
|
-
partOf: FieldReference.optional().describe("Parent location"),
|
|
1756
|
-
type: AdministrativeAreas,
|
|
1757
|
-
allowedLocations: AllowedLocations
|
|
1758
|
-
}).describe("Administrative area options");
|
|
1759
1836
|
var AdministrativeAreaField = BaseField.extend({
|
|
1760
1837
|
type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
|
|
1761
1838
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
1762
|
-
configuration:
|
|
1763
|
-
|
|
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
|
+
});
|
|
1764
1848
|
var LocationInput = BaseField.extend({
|
|
1765
1849
|
type: import_v43.default.literal(FieldType.LOCATION),
|
|
1766
1850
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
@@ -1768,7 +1852,10 @@ var LocationInput = BaseField.extend({
|
|
|
1768
1852
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
1769
1853
|
allowedLocations: AllowedLocations
|
|
1770
1854
|
}).optional()
|
|
1771
|
-
}).
|
|
1855
|
+
}).meta({
|
|
1856
|
+
description: "A field for selecting a location",
|
|
1857
|
+
id: "LocationInput"
|
|
1858
|
+
});
|
|
1772
1859
|
var FileUploadWithOptions = BaseField.extend({
|
|
1773
1860
|
type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
|
|
1774
1861
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
@@ -1782,6 +1869,9 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
1782
1869
|
}).default({
|
|
1783
1870
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1784
1871
|
})
|
|
1872
|
+
}).meta({
|
|
1873
|
+
description: "A field for uploading files with file type options",
|
|
1874
|
+
id: "FileUploadWithOptions"
|
|
1785
1875
|
});
|
|
1786
1876
|
var Facility = BaseField.extend({
|
|
1787
1877
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
@@ -1827,7 +1917,10 @@ var Address = BaseField.extend({
|
|
|
1827
1917
|
allowedLocations: AllowedLocations
|
|
1828
1918
|
}).optional(),
|
|
1829
1919
|
defaultValue: DefaultAddressFieldValue.optional()
|
|
1830
|
-
}).
|
|
1920
|
+
}).meta({
|
|
1921
|
+
description: "Address input field \u2013 a combination of location and text fields",
|
|
1922
|
+
id: "Address"
|
|
1923
|
+
});
|
|
1831
1924
|
var StaticDataEntry = import_v43.default.object({
|
|
1832
1925
|
id: import_v43.default.string().describe("ID for the data entry."),
|
|
1833
1926
|
label: TranslationConfig,
|
|
@@ -1842,7 +1935,10 @@ var DataField = BaseField.extend({
|
|
|
1842
1935
|
subtitle: TranslationConfig.optional(),
|
|
1843
1936
|
data: import_v43.default.array(DataEntry)
|
|
1844
1937
|
})
|
|
1845
|
-
}).
|
|
1938
|
+
}).meta({
|
|
1939
|
+
description: "A field for displaying a table of read-only data",
|
|
1940
|
+
id: "DataField"
|
|
1941
|
+
});
|
|
1846
1942
|
var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
|
|
1847
1943
|
var ButtonType = import_v43.default.enum([
|
|
1848
1944
|
"primary",
|
|
@@ -1869,11 +1965,17 @@ var ButtonField = BaseField.extend({
|
|
|
1869
1965
|
type: import_v43.default.literal(FieldType.BUTTON),
|
|
1870
1966
|
defaultValue: ButtonFieldValue.optional(),
|
|
1871
1967
|
configuration: ButtonConfiguration
|
|
1872
|
-
}).
|
|
1968
|
+
}).meta({
|
|
1969
|
+
description: "A generic button that can be used to trigger an action",
|
|
1970
|
+
id: "ButtonField"
|
|
1971
|
+
});
|
|
1873
1972
|
var FieldGroup = BaseField.extend({
|
|
1874
1973
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
1875
1974
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
1876
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"
|
|
1877
1979
|
});
|
|
1878
1980
|
var AlphaPrintButton = BaseField.extend({
|
|
1879
1981
|
type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
|
|
@@ -1883,7 +1985,10 @@ var AlphaPrintButton = BaseField.extend({
|
|
|
1883
1985
|
"Label for the print button"
|
|
1884
1986
|
)
|
|
1885
1987
|
})
|
|
1886
|
-
}).
|
|
1988
|
+
}).meta({
|
|
1989
|
+
description: "An experimental print button field for printing certificates during the declaration process",
|
|
1990
|
+
id: "AlphaPrintButton"
|
|
1991
|
+
});
|
|
1887
1992
|
var HttpField = BaseField.extend({
|
|
1888
1993
|
type: import_v43.default.literal(FieldType.HTTP),
|
|
1889
1994
|
defaultValue: HttpFieldValue.optional(),
|
|
@@ -1899,20 +2004,30 @@ var HttpField = BaseField.extend({
|
|
|
1899
2004
|
params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
|
|
1900
2005
|
timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
|
|
1901
2006
|
})
|
|
1902
|
-
}).
|
|
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
|
+
});
|
|
1903
2011
|
var AutocompleteField = BaseField.extend({
|
|
1904
2012
|
type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
|
|
1905
2013
|
configuration: import_v43.default.object({
|
|
1906
|
-
url: import_v43.default.string().describe(
|
|
2014
|
+
url: import_v43.default.string().describe(
|
|
2015
|
+
"URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
|
|
2016
|
+
).optional(),
|
|
1907
2017
|
method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
|
|
1908
2018
|
defaultOptions: import_v43.default.array(
|
|
1909
2019
|
import_v43.default.object({
|
|
1910
2020
|
label: import_v43.default.string(),
|
|
1911
2021
|
value: import_v43.default.string()
|
|
1912
2022
|
})
|
|
1913
|
-
).optional()
|
|
2023
|
+
).optional().describe(
|
|
2024
|
+
"Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
|
|
2025
|
+
)
|
|
1914
2026
|
})
|
|
1915
|
-
}).
|
|
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
|
+
});
|
|
1916
2031
|
var SearchField = HttpField.extend({
|
|
1917
2032
|
type: import_v43.default.literal(FieldType.SEARCH),
|
|
1918
2033
|
configuration: SearchQuery.pick({
|
|
@@ -1945,6 +2060,9 @@ var SearchField = HttpField.extend({
|
|
|
1945
2060
|
ok: TranslationConfig.optional()
|
|
1946
2061
|
}).optional()
|
|
1947
2062
|
})
|
|
2063
|
+
}).meta({
|
|
2064
|
+
description: "A search input field",
|
|
2065
|
+
id: "SearchField"
|
|
1948
2066
|
});
|
|
1949
2067
|
var LinkButtonField = BaseField.extend({
|
|
1950
2068
|
type: import_v43.default.literal(FieldType.LINK_BUTTON),
|
|
@@ -1953,7 +2071,10 @@ var LinkButtonField = BaseField.extend({
|
|
|
1953
2071
|
text: TranslationConfig.describe("Text to display on the button"),
|
|
1954
2072
|
icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
|
|
1955
2073
|
})
|
|
1956
|
-
}).
|
|
2074
|
+
}).meta({
|
|
2075
|
+
description: "A button that opens a URL link",
|
|
2076
|
+
id: "LinkButtonField"
|
|
2077
|
+
});
|
|
1957
2078
|
var VerificationStatus = BaseField.extend({
|
|
1958
2079
|
type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
|
|
1959
2080
|
defaultValue: VerificationStatusValue.optional(),
|
|
@@ -1963,15 +2084,19 @@ var VerificationStatus = BaseField.extend({
|
|
|
1963
2084
|
"Explaining text on the banner in form."
|
|
1964
2085
|
)
|
|
1965
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"
|
|
1966
2090
|
});
|
|
1967
2091
|
var QueryParamReaderField = BaseField.extend({
|
|
1968
2092
|
type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
|
|
1969
2093
|
configuration: import_v43.default.object({
|
|
1970
2094
|
pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
|
|
1971
2095
|
})
|
|
1972
|
-
}).
|
|
1973
|
-
"A field that maps URL query params into form values and clears them afterward"
|
|
1974
|
-
|
|
2096
|
+
}).meta({
|
|
2097
|
+
description: "A field that maps URL query params into form values and clears them afterward",
|
|
2098
|
+
id: "QueryParamReaderField"
|
|
2099
|
+
});
|
|
1975
2100
|
var QrReaderField = BaseField.extend({
|
|
1976
2101
|
type: import_v43.default.literal(FieldType.QR_READER),
|
|
1977
2102
|
defaultValue: QrReaderFieldValue.optional(),
|
|
@@ -1982,7 +2107,7 @@ var QrReaderField = BaseField.extend({
|
|
|
1982
2107
|
})
|
|
1983
2108
|
}).optional()
|
|
1984
2109
|
}).meta({
|
|
1985
|
-
description: "
|
|
2110
|
+
description: "QR code reader field, including optional JSON Schema validator.",
|
|
1986
2111
|
id: "QrReaderField"
|
|
1987
2112
|
});
|
|
1988
2113
|
var IdReaderField = BaseField.extend({
|
|
@@ -1991,12 +2116,18 @@ var IdReaderField = BaseField.extend({
|
|
|
1991
2116
|
methods: import_v43.default.array(
|
|
1992
2117
|
import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
|
|
1993
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"
|
|
1994
2122
|
});
|
|
1995
2123
|
var CustomField = BaseField.extend({
|
|
1996
2124
|
type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
|
|
1997
2125
|
defaultValue: CustomFieldValue.optional(),
|
|
1998
2126
|
src: import_v43.default.string().describe("Module source path for the custom field component"),
|
|
1999
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"
|
|
2000
2131
|
});
|
|
2001
2132
|
var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
|
|
2002
2133
|
var LoaderField = BaseField.extend({
|
|
@@ -2006,22 +2137,25 @@ var LoaderField = BaseField.extend({
|
|
|
2006
2137
|
configuration: import_v43.default.object({
|
|
2007
2138
|
text: TranslationConfig.describe("Display text above the loading spinner")
|
|
2008
2139
|
})
|
|
2009
|
-
}).
|
|
2010
|
-
"A non-interactive field that indicates an in progress operation in form"
|
|
2011
|
-
|
|
2140
|
+
}).meta({
|
|
2141
|
+
description: "A non-interactive field that indicates an in progress operation in form",
|
|
2142
|
+
id: "LoaderField"
|
|
2143
|
+
});
|
|
2012
2144
|
var HiddenField = BaseField.extend({
|
|
2013
2145
|
type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
|
|
2014
2146
|
required: import_v43.default.boolean().default(false).optional(),
|
|
2015
2147
|
defaultValue: TextValue.optional()
|
|
2016
|
-
}).
|
|
2017
|
-
"A non-interactive, hidden field that only hold a value in the form"
|
|
2018
|
-
|
|
2148
|
+
}).meta({
|
|
2149
|
+
description: "A non-interactive, hidden field that only hold a value in the form",
|
|
2150
|
+
id: "HiddenField"
|
|
2151
|
+
});
|
|
2019
2152
|
var UserRoleField = BaseField.extend({
|
|
2020
2153
|
type: import_v43.default.literal(FieldType.USER_ROLE),
|
|
2021
2154
|
defaultValue: TextValue.optional()
|
|
2022
|
-
}).
|
|
2023
|
-
"A select dropdown that is automatically populated with available user roles"
|
|
2024
|
-
|
|
2155
|
+
}).meta({
|
|
2156
|
+
description: "A select dropdown that is automatically populated with available user roles",
|
|
2157
|
+
id: "UserRoleField"
|
|
2158
|
+
});
|
|
2025
2159
|
var FieldConfig = import_v43.default.discriminatedUnion("type", [
|
|
2026
2160
|
FieldGroup,
|
|
2027
2161
|
Address,
|
|
@@ -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" | "
|
|
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;
|