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