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