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