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