@opencrvs/toolkit 2.0.0-rc.f606fc8 → 2.0.0-rc.f6aaa31
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 +73 -0
- package/create-countryconfig/package.json +11 -0
- package/dist/application-config/index.js +212 -84
- package/dist/cli.js +397 -131
- package/dist/commons/api/router.d.ts +3322 -268
- package/dist/commons/conditionals/conditionals.d.ts +3 -3
- package/dist/commons/conditionals/validate.d.ts +1 -0
- package/dist/commons/events/ActionInput.d.ts +108 -0
- package/dist/commons/events/Draft.d.ts +3 -0
- package/dist/commons/events/EventIndex.d.ts +0 -3
- package/dist/commons/events/EventMetadata.d.ts +0 -7
- package/dist/commons/events/FieldConfig.d.ts +5 -0
- package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
- package/dist/commons/events/locations.d.ts +21 -0
- package/dist/commons/events/mocks.test.utils.d.ts +19 -0
- package/dist/commons/events/scopes.d.ts +24 -1
- package/dist/commons/events/state/index.d.ts +0 -4
- package/dist/commons/events/state/utils.d.ts +0 -2
- package/dist/commons/events/utils.d.ts +1 -1
- package/dist/conditionals/index.js +8 -4
- package/dist/events/index.js +294 -132
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.js +1 -2
- package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +9 -1
- package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -1
- package/dist/migrations/v2.0/delete-infrastructure-directory.js +66 -20
- 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 +5 -3
- package/dist/migrations/v2.0/index.d.ts.map +1 -1
- package/dist/migrations/v2.0/index.js +395 -129
- package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +11 -1
- package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -1
- package/dist/migrations/v2.0/merge-infrastructure-directory.js +17 -16
- package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
- package/dist/migrations/v2.0/migrate-scopes.js +54 -30
- package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
- package/dist/migrations/v2.0/migrate-workqueue-configs.js +140 -59
- package/dist/notification/index.js +226 -102
- package/dist/scopes/index.d.ts +6 -1
- package/dist/scopes/index.js +8 -4
- package/opencrvs-toolkit-2.0.0-rc.f6aaa31.tgz +0 -0
- package/package.json +1 -1
- package/tsconfig.tsbuildinfo +1 -1
- package/opencrvs-toolkit-2.0.0-rc.f606fc8.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
|
+
description: "Action conditional configuration",
|
|
80
|
+
id: "ActionConditional"
|
|
81
|
+
});
|
|
79
82
|
var DisplayOnReviewConditional = z.object({
|
|
80
83
|
type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
|
|
81
84
|
conditional: Conditional
|
|
@@ -418,28 +421,20 @@ function schemaPriority(schema) {
|
|
|
418
421
|
return idx === -1 ? 9999 : idx;
|
|
419
422
|
}
|
|
420
423
|
function safeUnion(schemas) {
|
|
424
|
+
const sortedSchemas = [...schemas].sort(
|
|
425
|
+
(a, b) => schemaPriority(a) - schemaPriority(b)
|
|
426
|
+
);
|
|
421
427
|
return z7.any().superRefine((val, ctx) => {
|
|
422
|
-
const
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
if (successful.length === 0) {
|
|
427
|
-
ctx.addIssue({
|
|
428
|
-
code: "invalid_type",
|
|
429
|
-
expected: "custom",
|
|
430
|
-
message: "Value does not match any schema"
|
|
431
|
-
});
|
|
432
|
-
return;
|
|
433
|
-
}
|
|
434
|
-
successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
|
|
435
|
-
const best = successful[0];
|
|
436
|
-
if (!best.safeParse(val).success) {
|
|
437
|
-
ctx.addIssue({
|
|
438
|
-
expected: "custom",
|
|
439
|
-
code: "invalid_type",
|
|
440
|
-
message: "Value did not match the best schema"
|
|
441
|
-
});
|
|
428
|
+
for (const schema of sortedSchemas) {
|
|
429
|
+
if (schema.safeParse(val).success) {
|
|
430
|
+
return;
|
|
431
|
+
}
|
|
442
432
|
}
|
|
433
|
+
ctx.addIssue({
|
|
434
|
+
code: "invalid_type",
|
|
435
|
+
expected: "custom",
|
|
436
|
+
message: "Value does not match any schema"
|
|
437
|
+
});
|
|
443
438
|
}).meta({
|
|
444
439
|
description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
|
|
445
440
|
});
|
|
@@ -772,12 +767,14 @@ var SystemScopeType = z11.enum([
|
|
|
772
767
|
"organisation.read-locations",
|
|
773
768
|
"user.read",
|
|
774
769
|
"user.create",
|
|
775
|
-
"user.edit"
|
|
770
|
+
"user.edit",
|
|
771
|
+
"user.search"
|
|
776
772
|
]);
|
|
777
773
|
var UserScopeType = SystemScopeType.extract([
|
|
778
774
|
"user.read",
|
|
779
775
|
"user.create",
|
|
780
|
-
"user.edit"
|
|
776
|
+
"user.edit",
|
|
777
|
+
"user.search"
|
|
781
778
|
]);
|
|
782
779
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
783
780
|
var UserScopeV2 = z11.discriminatedUnion("type", [
|
|
@@ -786,7 +783,7 @@ var UserScopeV2 = z11.discriminatedUnion("type", [
|
|
|
786
783
|
options: AllUserScopeOptions.optional()
|
|
787
784
|
}),
|
|
788
785
|
z11.object({
|
|
789
|
-
type: UserScopeType.extract(["user.read"]),
|
|
786
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
790
787
|
options: AccessLevelOptions.optional()
|
|
791
788
|
})
|
|
792
789
|
]);
|
|
@@ -837,7 +834,9 @@ var ScopeType = z11.enum([
|
|
|
837
834
|
var EncodedScope = z11.string().brand("EncodedScope");
|
|
838
835
|
var DEFAULT_SCOPE_OPTIONS = {
|
|
839
836
|
placeOfEvent: JurisdictionFilter.enum.all,
|
|
840
|
-
accessLevel: JurisdictionFilter.enum.all
|
|
837
|
+
accessLevel: JurisdictionFilter.enum.all,
|
|
838
|
+
registeredIn: JurisdictionFilter.enum.all,
|
|
839
|
+
declaredIn: JurisdictionFilter.enum.all
|
|
841
840
|
};
|
|
842
841
|
|
|
843
842
|
// ../commons/src/authentication.ts
|
|
@@ -1083,6 +1082,9 @@ var FlagConfig = z14.object({
|
|
|
1083
1082
|
"Indicates if this flag expects an action to be performed to be cleared."
|
|
1084
1083
|
),
|
|
1085
1084
|
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
1085
|
+
}).meta({
|
|
1086
|
+
description: "Flag configuration",
|
|
1087
|
+
id: "FlagConfig"
|
|
1086
1088
|
});
|
|
1087
1089
|
var ActionFlagConfig = z14.object({
|
|
1088
1090
|
id: Flag,
|
|
@@ -1090,6 +1092,9 @@ var ActionFlagConfig = z14.object({
|
|
|
1090
1092
|
conditional: Conditional.optional().describe(
|
|
1091
1093
|
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1092
1094
|
)
|
|
1095
|
+
}).meta({
|
|
1096
|
+
description: "Action flag configuration",
|
|
1097
|
+
id: "ActionFlagConfig"
|
|
1093
1098
|
});
|
|
1094
1099
|
|
|
1095
1100
|
// ../commons/src/events/EventMetadata.ts
|
|
@@ -1111,8 +1116,7 @@ var ActionCreationMetadata = z15.object({
|
|
|
1111
1116
|
),
|
|
1112
1117
|
createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
|
|
1113
1118
|
acceptedAt: z15.iso.datetime().describe("Timestamp when the action request was accepted."),
|
|
1114
|
-
createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
|
|
1115
|
-
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.")
|
|
1116
1120
|
});
|
|
1117
1121
|
var RegistrationCreationMetadata = ActionCreationMetadata.extend({
|
|
1118
1122
|
registrationNumber: z15.string().describe(
|
|
@@ -1140,9 +1144,6 @@ var EventMetadata = z15.object({
|
|
|
1140
1144
|
createdAtLocation: UUID.nullish().describe(
|
|
1141
1145
|
"Location of the user who created the event."
|
|
1142
1146
|
),
|
|
1143
|
-
createdBySignature: DocumentPath.nullish().describe(
|
|
1144
|
-
"Signature of the user who created the event."
|
|
1145
|
-
),
|
|
1146
1147
|
updatedAtLocation: UUID.nullish().describe(
|
|
1147
1148
|
"Location of the user who last changed the status."
|
|
1148
1149
|
),
|
|
@@ -1406,7 +1407,7 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
|
|
|
1406
1407
|
}
|
|
1407
1408
|
}).describe("Unique identifier for the field");
|
|
1408
1409
|
var FieldReference = import_v43.default.object({
|
|
1409
|
-
$$field: FieldId,
|
|
1410
|
+
$$field: FieldId.describe("Id of the field to reference"),
|
|
1410
1411
|
$$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
|
|
1411
1412
|
'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
|
|
1412
1413
|
)
|
|
@@ -1452,6 +1453,9 @@ var BaseField = import_v43.default.object({
|
|
|
1452
1453
|
}).describe("Common properties shared across all field types.");
|
|
1453
1454
|
var Divider = BaseField.extend({
|
|
1454
1455
|
type: import_v43.default.literal(FieldType.DIVIDER)
|
|
1456
|
+
}).meta({
|
|
1457
|
+
description: "A horizontal line divider",
|
|
1458
|
+
id: "Divider"
|
|
1455
1459
|
});
|
|
1456
1460
|
var TextField = BaseField.extend({
|
|
1457
1461
|
type: import_v43.default.literal(FieldType.TEXT),
|
|
@@ -1462,7 +1466,10 @@ var TextField = BaseField.extend({
|
|
|
1462
1466
|
prefix: TranslationConfig.optional(),
|
|
1463
1467
|
postfix: TranslationConfig.optional()
|
|
1464
1468
|
}).default({ type: "text" }).optional()
|
|
1465
|
-
}).
|
|
1469
|
+
}).meta({
|
|
1470
|
+
description: "A text input field",
|
|
1471
|
+
id: "TextField"
|
|
1472
|
+
});
|
|
1466
1473
|
var NumberField = BaseField.extend({
|
|
1467
1474
|
type: import_v43.default.literal(FieldType.NUMBER),
|
|
1468
1475
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -1472,7 +1479,10 @@ var NumberField = BaseField.extend({
|
|
|
1472
1479
|
prefix: TranslationConfig.optional(),
|
|
1473
1480
|
postfix: TranslationConfig.optional()
|
|
1474
1481
|
}).optional()
|
|
1475
|
-
}).
|
|
1482
|
+
}).meta({
|
|
1483
|
+
description: "A number input field",
|
|
1484
|
+
id: "NumberField"
|
|
1485
|
+
});
|
|
1476
1486
|
var TextAreaField = BaseField.extend({
|
|
1477
1487
|
type: import_v43.default.literal(FieldType.TEXTAREA),
|
|
1478
1488
|
defaultValue: NonEmptyTextValue.optional(),
|
|
@@ -1483,7 +1493,10 @@ var TextAreaField = BaseField.extend({
|
|
|
1483
1493
|
prefix: TranslationConfig.optional(),
|
|
1484
1494
|
postfix: TranslationConfig.optional()
|
|
1485
1495
|
}).default({ rows: 4 }).optional()
|
|
1486
|
-
}).
|
|
1496
|
+
}).meta({
|
|
1497
|
+
description: "A multiline text input",
|
|
1498
|
+
id: "TextAreaField"
|
|
1499
|
+
});
|
|
1487
1500
|
var ImageMimeType = import_v43.default.enum([
|
|
1488
1501
|
"image/png",
|
|
1489
1502
|
"image/jpg",
|
|
@@ -1513,13 +1526,19 @@ var SignatureField = BaseField.extend({
|
|
|
1513
1526
|
}).default({
|
|
1514
1527
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1515
1528
|
})
|
|
1516
|
-
}).
|
|
1529
|
+
}).meta({
|
|
1530
|
+
description: "A signature input field",
|
|
1531
|
+
id: "SignatureField"
|
|
1532
|
+
});
|
|
1517
1533
|
var EmailField = BaseField.extend({
|
|
1518
1534
|
type: import_v43.default.literal(FieldType.EMAIL),
|
|
1519
1535
|
configuration: import_v43.default.object({
|
|
1520
1536
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
|
|
1521
1537
|
}).default({ maxLength: 255 }).optional(),
|
|
1522
1538
|
defaultValue: NonEmptyTextValue.optional()
|
|
1539
|
+
}).meta({
|
|
1540
|
+
description: "An email input field",
|
|
1541
|
+
id: "EmailField"
|
|
1523
1542
|
});
|
|
1524
1543
|
var DateField = BaseField.extend({
|
|
1525
1544
|
type: import_v43.default.literal(FieldType.DATE),
|
|
@@ -1529,7 +1548,10 @@ var DateField = BaseField.extend({
|
|
|
1529
1548
|
"Text to display above the date input"
|
|
1530
1549
|
).optional()
|
|
1531
1550
|
}).optional()
|
|
1532
|
-
}).
|
|
1551
|
+
}).meta({
|
|
1552
|
+
description: "A date input (yyyy-MM-dd)",
|
|
1553
|
+
id: "DateField"
|
|
1554
|
+
});
|
|
1533
1555
|
var AgeField = BaseField.extend({
|
|
1534
1556
|
type: import_v43.default.literal(FieldType.AGE),
|
|
1535
1557
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -1538,7 +1560,10 @@ var AgeField = BaseField.extend({
|
|
|
1538
1560
|
prefix: TranslationConfig.optional(),
|
|
1539
1561
|
postfix: TranslationConfig.optional()
|
|
1540
1562
|
})
|
|
1541
|
-
}).
|
|
1563
|
+
}).meta({
|
|
1564
|
+
description: "An age input field which uses the current date as the asOfDate",
|
|
1565
|
+
id: "AgeField"
|
|
1566
|
+
});
|
|
1542
1567
|
var TimeField = BaseField.extend({
|
|
1543
1568
|
type: import_v43.default.literal(FieldType.TIME),
|
|
1544
1569
|
defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
|
|
@@ -1548,7 +1573,10 @@ var TimeField = BaseField.extend({
|
|
|
1548
1573
|
"Text to display above the time input"
|
|
1549
1574
|
).optional()
|
|
1550
1575
|
}).optional()
|
|
1551
|
-
}).
|
|
1576
|
+
}).meta({
|
|
1577
|
+
description: "A single time input (HH-mm)",
|
|
1578
|
+
id: "TimeField"
|
|
1579
|
+
});
|
|
1552
1580
|
var DateRangeField = BaseField.extend({
|
|
1553
1581
|
type: import_v43.default.literal(FieldType.DATE_RANGE),
|
|
1554
1582
|
defaultValue: DateRangeFieldValue.optional(),
|
|
@@ -1557,7 +1585,10 @@ var DateRangeField = BaseField.extend({
|
|
|
1557
1585
|
"Text to display above the date input"
|
|
1558
1586
|
).optional()
|
|
1559
1587
|
}).optional()
|
|
1560
|
-
}).
|
|
1588
|
+
}).meta({
|
|
1589
|
+
description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
|
|
1590
|
+
id: "DateRangeField"
|
|
1591
|
+
});
|
|
1561
1592
|
var HtmlFontVariant = import_v43.default.enum([
|
|
1562
1593
|
"reg12",
|
|
1563
1594
|
"reg14",
|
|
@@ -1601,18 +1632,30 @@ var ImageViewField = BaseField.extend({
|
|
|
1601
1632
|
type: import_v43.default.literal(FieldType.IMAGE_VIEW),
|
|
1602
1633
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1603
1634
|
configuration: ImageConfiguration
|
|
1604
|
-
}).
|
|
1635
|
+
}).meta({
|
|
1636
|
+
description: "A read-only image component for form pages",
|
|
1637
|
+
id: "ImageViewField"
|
|
1638
|
+
});
|
|
1605
1639
|
var Paragraph = BaseField.extend({
|
|
1606
1640
|
type: import_v43.default.literal(FieldType.PARAGRAPH),
|
|
1607
1641
|
configuration: ParagraphConfiguration
|
|
1608
|
-
}).
|
|
1642
|
+
}).meta({
|
|
1643
|
+
description: "A read-only HTML <p> paragraph",
|
|
1644
|
+
id: "Paragraph"
|
|
1645
|
+
});
|
|
1609
1646
|
var Heading = BaseField.extend({
|
|
1610
1647
|
type: import_v43.default.literal(FieldType.HEADING),
|
|
1611
1648
|
configuration: HeadingConfiguration
|
|
1612
|
-
}).
|
|
1649
|
+
}).meta({
|
|
1650
|
+
description: "A read-only heading component for form pages",
|
|
1651
|
+
id: "Heading"
|
|
1652
|
+
});
|
|
1613
1653
|
var PageHeader = BaseField.extend({
|
|
1614
1654
|
type: import_v43.default.literal(FieldType.PAGE_HEADER)
|
|
1615
|
-
}).
|
|
1655
|
+
}).meta({
|
|
1656
|
+
description: "A read-only header component for form pages",
|
|
1657
|
+
id: "PageHeader"
|
|
1658
|
+
});
|
|
1616
1659
|
var File = BaseField.extend({
|
|
1617
1660
|
type: import_v43.default.literal(FieldType.FILE),
|
|
1618
1661
|
defaultValue: FileFieldValue.optional(),
|
|
@@ -1631,7 +1674,10 @@ var File = BaseField.extend({
|
|
|
1631
1674
|
}).default({
|
|
1632
1675
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1633
1676
|
})
|
|
1634
|
-
}).
|
|
1677
|
+
}).meta({
|
|
1678
|
+
description: "A file upload field",
|
|
1679
|
+
id: "File"
|
|
1680
|
+
});
|
|
1635
1681
|
var SelectOption = import_v43.default.object({
|
|
1636
1682
|
value: import_v43.default.string().describe("The value of the option"),
|
|
1637
1683
|
label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
|
|
@@ -1648,7 +1694,10 @@ var NumberWithUnitField = BaseField.extend({
|
|
|
1648
1694
|
"Placeholder for the number field"
|
|
1649
1695
|
)
|
|
1650
1696
|
}).optional()
|
|
1651
|
-
}).
|
|
1697
|
+
}).meta({
|
|
1698
|
+
description: "A number with unit input field",
|
|
1699
|
+
id: "NumberWithUnitField"
|
|
1700
|
+
});
|
|
1652
1701
|
var RadioGroup = BaseField.extend({
|
|
1653
1702
|
type: import_v43.default.literal(FieldType.RADIO_GROUP),
|
|
1654
1703
|
defaultValue: TextValue.optional(),
|
|
@@ -1658,7 +1707,10 @@ var RadioGroup = BaseField.extend({
|
|
|
1658
1707
|
size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
|
|
1659
1708
|
}).optional()
|
|
1660
1709
|
}).optional()
|
|
1661
|
-
}).
|
|
1710
|
+
}).meta({
|
|
1711
|
+
description: "A grouped radio button field",
|
|
1712
|
+
id: "RadioGroup"
|
|
1713
|
+
});
|
|
1662
1714
|
var BulletList = BaseField.extend({
|
|
1663
1715
|
type: import_v43.default.literal(FieldType.BULLET_LIST),
|
|
1664
1716
|
items: import_v43.default.array(TranslationConfig).describe("A list of items"),
|
|
@@ -1667,7 +1719,10 @@ var BulletList = BaseField.extend({
|
|
|
1667
1719
|
fontVariant: HtmlFontVariant.optional()
|
|
1668
1720
|
}).optional()
|
|
1669
1721
|
}).default({})
|
|
1670
|
-
}).
|
|
1722
|
+
}).meta({
|
|
1723
|
+
description: "A list of bullet points",
|
|
1724
|
+
id: "BulletList"
|
|
1725
|
+
});
|
|
1671
1726
|
var Select = BaseField.extend({
|
|
1672
1727
|
type: import_v43.default.literal(FieldType.SELECT),
|
|
1673
1728
|
defaultValue: TextValue.optional(),
|
|
@@ -1682,7 +1737,10 @@ var Select = BaseField.extend({
|
|
|
1682
1737
|
{ ..., defaultMessage: "'{input}' is not listed among the health facilities." }
|
|
1683
1738
|
`
|
|
1684
1739
|
)
|
|
1685
|
-
}).
|
|
1740
|
+
}).meta({
|
|
1741
|
+
description: "A select input field",
|
|
1742
|
+
id: "Select"
|
|
1743
|
+
});
|
|
1686
1744
|
var SelectDateRangeOption = import_v43.default.object({
|
|
1687
1745
|
value: SelectDateRangeValue.describe("The value of the option"),
|
|
1688
1746
|
label: TranslationConfig.describe("The label of the option")
|
|
@@ -1691,7 +1749,10 @@ var SelectDateRangeField = BaseField.extend({
|
|
|
1691
1749
|
type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
|
|
1692
1750
|
defaultValue: SelectDateRangeValue.optional(),
|
|
1693
1751
|
options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
|
|
1694
|
-
}).
|
|
1752
|
+
}).meta({
|
|
1753
|
+
description: "A date range selection field",
|
|
1754
|
+
id: "SelectDateRangeField"
|
|
1755
|
+
});
|
|
1695
1756
|
var NameConfig = import_v43.default.object({
|
|
1696
1757
|
firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
1697
1758
|
middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
@@ -1722,26 +1783,41 @@ var NameField = BaseField.extend({
|
|
|
1722
1783
|
surname: { required: true }
|
|
1723
1784
|
}
|
|
1724
1785
|
}).optional()
|
|
1725
|
-
}).
|
|
1786
|
+
}).meta({
|
|
1787
|
+
description: "A field for entering a persons name",
|
|
1788
|
+
id: "NameField"
|
|
1789
|
+
});
|
|
1726
1790
|
var PhoneField = BaseField.extend({
|
|
1727
1791
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1728
1792
|
type: import_v43.default.literal(FieldType.PHONE)
|
|
1729
|
-
}).
|
|
1793
|
+
}).meta({
|
|
1794
|
+
description: "A field for entering a phone number",
|
|
1795
|
+
id: "PhoneField"
|
|
1796
|
+
});
|
|
1730
1797
|
var IdField = BaseField.extend({
|
|
1731
1798
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1732
1799
|
type: import_v43.default.literal(FieldType.ID)
|
|
1733
|
-
}).
|
|
1800
|
+
}).meta({
|
|
1801
|
+
description: "A field for entering an ID",
|
|
1802
|
+
id: "IdField"
|
|
1803
|
+
});
|
|
1734
1804
|
var Checkbox = BaseField.extend({
|
|
1735
1805
|
type: import_v43.default.literal(FieldType.CHECKBOX),
|
|
1736
1806
|
defaultValue: CheckboxFieldValue.default(false)
|
|
1737
|
-
}).
|
|
1807
|
+
}).meta({
|
|
1808
|
+
description: "A boolean checkbox field",
|
|
1809
|
+
id: "Checkbox"
|
|
1810
|
+
});
|
|
1738
1811
|
var Country = BaseField.extend({
|
|
1739
1812
|
type: import_v43.default.literal(FieldType.COUNTRY),
|
|
1740
1813
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1741
1814
|
optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
|
|
1742
1815
|
"Conditionals for specific countries. Countries not listed are always shown and enabled."
|
|
1743
1816
|
)
|
|
1744
|
-
}).
|
|
1817
|
+
}).meta({
|
|
1818
|
+
description: "A field for selecting a country",
|
|
1819
|
+
id: "Country"
|
|
1820
|
+
});
|
|
1745
1821
|
var AllowedLocations = JurisdictionReference.optional().describe(
|
|
1746
1822
|
"Limits which location options are selectable depending on user jurisdiction and location."
|
|
1747
1823
|
);
|
|
@@ -1750,16 +1826,18 @@ var AdministrativeAreas = import_v43.default.enum([
|
|
|
1750
1826
|
"HEALTH_FACILITY",
|
|
1751
1827
|
"CRVS_OFFICE"
|
|
1752
1828
|
]);
|
|
1753
|
-
var AdministrativeAreaConfiguration = import_v43.default.object({
|
|
1754
|
-
partOf: FieldReference.optional().describe("Parent location"),
|
|
1755
|
-
type: AdministrativeAreas,
|
|
1756
|
-
allowedLocations: AllowedLocations
|
|
1757
|
-
}).describe("Administrative area options");
|
|
1758
1829
|
var AdministrativeAreaField = BaseField.extend({
|
|
1759
1830
|
type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
|
|
1760
1831
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
1761
|
-
configuration:
|
|
1762
|
-
|
|
1832
|
+
configuration: import_v43.default.object({
|
|
1833
|
+
partOf: FieldReference.optional().describe("Parent location"),
|
|
1834
|
+
type: AdministrativeAreas,
|
|
1835
|
+
allowedLocations: AllowedLocations
|
|
1836
|
+
}).describe("Administrative area options")
|
|
1837
|
+
}).meta({
|
|
1838
|
+
description: "Administrative area input field",
|
|
1839
|
+
id: "AdministrativeAreaField"
|
|
1840
|
+
});
|
|
1763
1841
|
var LocationInput = BaseField.extend({
|
|
1764
1842
|
type: import_v43.default.literal(FieldType.LOCATION),
|
|
1765
1843
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
@@ -1767,7 +1845,10 @@ var LocationInput = BaseField.extend({
|
|
|
1767
1845
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
1768
1846
|
allowedLocations: AllowedLocations
|
|
1769
1847
|
}).optional()
|
|
1770
|
-
}).
|
|
1848
|
+
}).meta({
|
|
1849
|
+
description: "A field for selecting a location",
|
|
1850
|
+
id: "LocationInput"
|
|
1851
|
+
});
|
|
1771
1852
|
var FileUploadWithOptions = BaseField.extend({
|
|
1772
1853
|
type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
|
|
1773
1854
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
@@ -1781,6 +1862,9 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
1781
1862
|
}).default({
|
|
1782
1863
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1783
1864
|
})
|
|
1865
|
+
}).meta({
|
|
1866
|
+
description: "A field for uploading files with file type options",
|
|
1867
|
+
id: "FileUploadWithOptions"
|
|
1784
1868
|
});
|
|
1785
1869
|
var Facility = BaseField.extend({
|
|
1786
1870
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
@@ -1826,7 +1910,10 @@ var Address = BaseField.extend({
|
|
|
1826
1910
|
allowedLocations: AllowedLocations
|
|
1827
1911
|
}).optional(),
|
|
1828
1912
|
defaultValue: DefaultAddressFieldValue.optional()
|
|
1829
|
-
}).
|
|
1913
|
+
}).meta({
|
|
1914
|
+
description: "Address input field \u2013 a combination of location and text fields",
|
|
1915
|
+
id: "Address"
|
|
1916
|
+
});
|
|
1830
1917
|
var StaticDataEntry = import_v43.default.object({
|
|
1831
1918
|
id: import_v43.default.string().describe("ID for the data entry."),
|
|
1832
1919
|
label: TranslationConfig,
|
|
@@ -1841,7 +1928,10 @@ var DataField = BaseField.extend({
|
|
|
1841
1928
|
subtitle: TranslationConfig.optional(),
|
|
1842
1929
|
data: import_v43.default.array(DataEntry)
|
|
1843
1930
|
})
|
|
1844
|
-
}).
|
|
1931
|
+
}).meta({
|
|
1932
|
+
description: "A field for displaying a table of read-only data",
|
|
1933
|
+
id: "DataField"
|
|
1934
|
+
});
|
|
1845
1935
|
var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
|
|
1846
1936
|
var ButtonType = import_v43.default.enum([
|
|
1847
1937
|
"primary",
|
|
@@ -1868,11 +1958,17 @@ var ButtonField = BaseField.extend({
|
|
|
1868
1958
|
type: import_v43.default.literal(FieldType.BUTTON),
|
|
1869
1959
|
defaultValue: ButtonFieldValue.optional(),
|
|
1870
1960
|
configuration: ButtonConfiguration
|
|
1871
|
-
}).
|
|
1961
|
+
}).meta({
|
|
1962
|
+
description: "A generic button that can be used to trigger an action",
|
|
1963
|
+
id: "ButtonField"
|
|
1964
|
+
});
|
|
1872
1965
|
var FieldGroup = BaseField.extend({
|
|
1873
1966
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
1874
1967
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
1875
1968
|
fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
|
|
1969
|
+
}).meta({
|
|
1970
|
+
description: "A group of fields that are displayed together",
|
|
1971
|
+
id: "FieldGroup"
|
|
1876
1972
|
});
|
|
1877
1973
|
var AlphaPrintButton = BaseField.extend({
|
|
1878
1974
|
type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
|
|
@@ -1882,7 +1978,10 @@ var AlphaPrintButton = BaseField.extend({
|
|
|
1882
1978
|
"Label for the print button"
|
|
1883
1979
|
)
|
|
1884
1980
|
})
|
|
1885
|
-
}).
|
|
1981
|
+
}).meta({
|
|
1982
|
+
description: "An experimental print button field for printing certificates during the declaration process",
|
|
1983
|
+
id: "AlphaPrintButton"
|
|
1984
|
+
});
|
|
1886
1985
|
var HttpField = BaseField.extend({
|
|
1887
1986
|
type: import_v43.default.literal(FieldType.HTTP),
|
|
1888
1987
|
defaultValue: HttpFieldValue.optional(),
|
|
@@ -1898,20 +1997,30 @@ var HttpField = BaseField.extend({
|
|
|
1898
1997
|
params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
|
|
1899
1998
|
timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
|
|
1900
1999
|
})
|
|
1901
|
-
}).
|
|
2000
|
+
}).meta({
|
|
2001
|
+
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.",
|
|
2002
|
+
id: "HttpField"
|
|
2003
|
+
});
|
|
1902
2004
|
var AutocompleteField = BaseField.extend({
|
|
1903
2005
|
type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
|
|
1904
2006
|
configuration: import_v43.default.object({
|
|
1905
|
-
url: import_v43.default.string().describe(
|
|
2007
|
+
url: import_v43.default.string().describe(
|
|
2008
|
+
"URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
|
|
2009
|
+
).optional(),
|
|
1906
2010
|
method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
|
|
1907
2011
|
defaultOptions: import_v43.default.array(
|
|
1908
2012
|
import_v43.default.object({
|
|
1909
2013
|
label: import_v43.default.string(),
|
|
1910
2014
|
value: import_v43.default.string()
|
|
1911
2015
|
})
|
|
1912
|
-
).optional()
|
|
2016
|
+
).optional().describe(
|
|
2017
|
+
"Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
|
|
2018
|
+
)
|
|
1913
2019
|
})
|
|
1914
|
-
}).
|
|
2020
|
+
}).meta({
|
|
2021
|
+
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.",
|
|
2022
|
+
id: "AutocompleteField"
|
|
2023
|
+
});
|
|
1915
2024
|
var SearchField = HttpField.extend({
|
|
1916
2025
|
type: import_v43.default.literal(FieldType.SEARCH),
|
|
1917
2026
|
configuration: SearchQuery.pick({
|
|
@@ -1944,6 +2053,9 @@ var SearchField = HttpField.extend({
|
|
|
1944
2053
|
ok: TranslationConfig.optional()
|
|
1945
2054
|
}).optional()
|
|
1946
2055
|
})
|
|
2056
|
+
}).meta({
|
|
2057
|
+
description: "A search input field",
|
|
2058
|
+
id: "SearchField"
|
|
1947
2059
|
});
|
|
1948
2060
|
var LinkButtonField = BaseField.extend({
|
|
1949
2061
|
type: import_v43.default.literal(FieldType.LINK_BUTTON),
|
|
@@ -1952,7 +2064,10 @@ var LinkButtonField = BaseField.extend({
|
|
|
1952
2064
|
text: TranslationConfig.describe("Text to display on the button"),
|
|
1953
2065
|
icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
|
|
1954
2066
|
})
|
|
1955
|
-
}).
|
|
2067
|
+
}).meta({
|
|
2068
|
+
description: "A button that opens a URL link",
|
|
2069
|
+
id: "LinkButtonField"
|
|
2070
|
+
});
|
|
1956
2071
|
var VerificationStatus = BaseField.extend({
|
|
1957
2072
|
type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
|
|
1958
2073
|
defaultValue: VerificationStatusValue.optional(),
|
|
@@ -1962,15 +2077,19 @@ var VerificationStatus = BaseField.extend({
|
|
|
1962
2077
|
"Explaining text on the banner in form."
|
|
1963
2078
|
)
|
|
1964
2079
|
})
|
|
2080
|
+
}).meta({
|
|
2081
|
+
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.",
|
|
2082
|
+
id: "VerificationStatus"
|
|
1965
2083
|
});
|
|
1966
2084
|
var QueryParamReaderField = BaseField.extend({
|
|
1967
2085
|
type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
|
|
1968
2086
|
configuration: import_v43.default.object({
|
|
1969
2087
|
pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
|
|
1970
2088
|
})
|
|
1971
|
-
}).
|
|
1972
|
-
"A field that maps URL query params into form values and clears them afterward"
|
|
1973
|
-
|
|
2089
|
+
}).meta({
|
|
2090
|
+
description: "A field that maps URL query params into form values and clears them afterward",
|
|
2091
|
+
id: "QueryParamReaderField"
|
|
2092
|
+
});
|
|
1974
2093
|
var QrReaderField = BaseField.extend({
|
|
1975
2094
|
type: import_v43.default.literal(FieldType.QR_READER),
|
|
1976
2095
|
defaultValue: QrReaderFieldValue.optional(),
|
|
@@ -1981,7 +2100,7 @@ var QrReaderField = BaseField.extend({
|
|
|
1981
2100
|
})
|
|
1982
2101
|
}).optional()
|
|
1983
2102
|
}).meta({
|
|
1984
|
-
description: "
|
|
2103
|
+
description: "QR code reader field, including optional JSON Schema validator.",
|
|
1985
2104
|
id: "QrReaderField"
|
|
1986
2105
|
});
|
|
1987
2106
|
var IdReaderField = BaseField.extend({
|
|
@@ -1990,12 +2109,18 @@ var IdReaderField = BaseField.extend({
|
|
|
1990
2109
|
methods: import_v43.default.array(
|
|
1991
2110
|
import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
|
|
1992
2111
|
)
|
|
2112
|
+
}).meta({
|
|
2113
|
+
description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
|
|
2114
|
+
id: "IdReaderField"
|
|
1993
2115
|
});
|
|
1994
2116
|
var CustomField = BaseField.extend({
|
|
1995
2117
|
type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
|
|
1996
2118
|
defaultValue: CustomFieldValue.optional(),
|
|
1997
2119
|
src: import_v43.default.string().describe("Module source path for the custom field component"),
|
|
1998
2120
|
configuration: import_v43.default.unknown().optional()
|
|
2121
|
+
}).meta({
|
|
2122
|
+
description: "An expiremental custom field that is defined by a module source path",
|
|
2123
|
+
id: "CustomField"
|
|
1999
2124
|
});
|
|
2000
2125
|
var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
|
|
2001
2126
|
var LoaderField = BaseField.extend({
|
|
@@ -2005,22 +2130,25 @@ var LoaderField = BaseField.extend({
|
|
|
2005
2130
|
configuration: import_v43.default.object({
|
|
2006
2131
|
text: TranslationConfig.describe("Display text above the loading spinner")
|
|
2007
2132
|
})
|
|
2008
|
-
}).
|
|
2009
|
-
"A non-interactive field that indicates an in progress operation in form"
|
|
2010
|
-
|
|
2133
|
+
}).meta({
|
|
2134
|
+
description: "A non-interactive field that indicates an in progress operation in form",
|
|
2135
|
+
id: "LoaderField"
|
|
2136
|
+
});
|
|
2011
2137
|
var HiddenField = BaseField.extend({
|
|
2012
2138
|
type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
|
|
2013
2139
|
required: import_v43.default.boolean().default(false).optional(),
|
|
2014
2140
|
defaultValue: TextValue.optional()
|
|
2015
|
-
}).
|
|
2016
|
-
"A non-interactive, hidden field that only hold a value in the form"
|
|
2017
|
-
|
|
2141
|
+
}).meta({
|
|
2142
|
+
description: "A non-interactive, hidden field that only hold a value in the form",
|
|
2143
|
+
id: "HiddenField"
|
|
2144
|
+
});
|
|
2018
2145
|
var UserRoleField = BaseField.extend({
|
|
2019
2146
|
type: import_v43.default.literal(FieldType.USER_ROLE),
|
|
2020
2147
|
defaultValue: TextValue.optional()
|
|
2021
|
-
}).
|
|
2022
|
-
"A select dropdown that is automatically populated with available user roles"
|
|
2023
|
-
|
|
2148
|
+
}).meta({
|
|
2149
|
+
description: "A select dropdown that is automatically populated with available user roles",
|
|
2150
|
+
id: "UserRoleField"
|
|
2151
|
+
});
|
|
2024
2152
|
var FieldConfig = import_v43.default.discriminatedUnion("type", [
|
|
2025
2153
|
FieldGroup,
|
|
2026
2154
|
Address,
|