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