@opencrvs/toolkit 2.0.0-rc.c0c9888 → 2.0.0-rc.c16385a
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 +269 -121
- package/dist/cli.js +397 -131
- package/dist/commons/api/router.d.ts +3403 -272
- package/dist/commons/application-config/index.d.ts +1 -0
- package/dist/commons/conditionals/conditionals.d.ts +357 -7
- package/dist/commons/conditionals/validate.d.ts +52 -2
- package/dist/commons/events/ActionDocument.d.ts +6 -0
- package/dist/commons/events/ActionInput.d.ts +114 -0
- package/dist/commons/events/AdvancedSearchConfig.d.ts +342 -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 +382 -50
- package/dist/commons/events/FieldValue.d.ts +6 -0
- package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
- package/dist/commons/events/field.d.ts +53 -1
- package/dist/commons/events/index.d.ts +2 -0
- 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 +13 -2
- package/dist/conditionals/index.js +60 -5
- package/dist/events/index.js +949 -253
- 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 +809 -156
- package/dist/scopes/index.d.ts +6 -1
- package/dist/scopes/index.js +8 -4
- package/opencrvs-toolkit-2.0.0-rc.c16385a.tgz +0 -0
- package/package.json +6 -2
- package/tsconfig.tsbuildinfo +1 -1
- package/opencrvs-toolkit-2.0.0-rc.c0c9888.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
|
|
@@ -350,6 +353,7 @@ var DateRangeFieldValue = z7.object({
|
|
|
350
353
|
var EmailValue = z7.email();
|
|
351
354
|
var CheckboxFieldValue = z7.boolean();
|
|
352
355
|
var NumberFieldValue = z7.number();
|
|
356
|
+
var SignatureFieldValue = FileFieldValue;
|
|
353
357
|
var ButtonFieldValue = z7.number();
|
|
354
358
|
var VerificationStatusValue = z7.enum([
|
|
355
359
|
"verified",
|
|
@@ -418,28 +422,20 @@ function schemaPriority(schema) {
|
|
|
418
422
|
return idx === -1 ? 9999 : idx;
|
|
419
423
|
}
|
|
420
424
|
function safeUnion(schemas) {
|
|
425
|
+
const sortedSchemas = [...schemas].sort(
|
|
426
|
+
(a, b) => schemaPriority(a) - schemaPriority(b)
|
|
427
|
+
);
|
|
421
428
|
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
|
-
});
|
|
429
|
+
for (const schema of sortedSchemas) {
|
|
430
|
+
if (schema.safeParse(val).success) {
|
|
431
|
+
return;
|
|
432
|
+
}
|
|
442
433
|
}
|
|
434
|
+
ctx.addIssue({
|
|
435
|
+
code: "invalid_type",
|
|
436
|
+
expected: "custom",
|
|
437
|
+
message: "Value does not match any schema"
|
|
438
|
+
});
|
|
443
439
|
}).meta({
|
|
444
440
|
description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
|
|
445
441
|
});
|
|
@@ -772,12 +768,14 @@ var SystemScopeType = z11.enum([
|
|
|
772
768
|
"organisation.read-locations",
|
|
773
769
|
"user.read",
|
|
774
770
|
"user.create",
|
|
775
|
-
"user.edit"
|
|
771
|
+
"user.edit",
|
|
772
|
+
"user.search"
|
|
776
773
|
]);
|
|
777
774
|
var UserScopeType = SystemScopeType.extract([
|
|
778
775
|
"user.read",
|
|
779
776
|
"user.create",
|
|
780
|
-
"user.edit"
|
|
777
|
+
"user.edit",
|
|
778
|
+
"user.search"
|
|
781
779
|
]);
|
|
782
780
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
783
781
|
var UserScopeV2 = z11.discriminatedUnion("type", [
|
|
@@ -786,7 +784,7 @@ var UserScopeV2 = z11.discriminatedUnion("type", [
|
|
|
786
784
|
options: AllUserScopeOptions.optional()
|
|
787
785
|
}),
|
|
788
786
|
z11.object({
|
|
789
|
-
type: UserScopeType.extract(["user.read"]),
|
|
787
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
790
788
|
options: AccessLevelOptions.optional()
|
|
791
789
|
})
|
|
792
790
|
]);
|
|
@@ -837,7 +835,9 @@ var ScopeType = z11.enum([
|
|
|
837
835
|
var EncodedScope = z11.string().brand("EncodedScope");
|
|
838
836
|
var DEFAULT_SCOPE_OPTIONS = {
|
|
839
837
|
placeOfEvent: JurisdictionFilter.enum.all,
|
|
840
|
-
accessLevel: JurisdictionFilter.enum.all
|
|
838
|
+
accessLevel: JurisdictionFilter.enum.all,
|
|
839
|
+
registeredIn: JurisdictionFilter.enum.all,
|
|
840
|
+
declaredIn: JurisdictionFilter.enum.all
|
|
841
841
|
};
|
|
842
842
|
|
|
843
843
|
// ../commons/src/authentication.ts
|
|
@@ -990,8 +990,9 @@ var RequestedCorrectionAction = ActionBase.extend(
|
|
|
990
990
|
var ApprovedCorrectionAction = ActionBase.extend(
|
|
991
991
|
z13.object({
|
|
992
992
|
type: z13.literal(ActionType.APPROVE_CORRECTION),
|
|
993
|
-
requestId: z13.string()
|
|
993
|
+
requestId: z13.string(),
|
|
994
994
|
// TODO move into 'content' property
|
|
995
|
+
content: z13.object({ immediateCorrection: z13.boolean().optional() }).optional()
|
|
995
996
|
}).shape
|
|
996
997
|
);
|
|
997
998
|
var RejectedCorrectionAction = ActionBase.extend(
|
|
@@ -1083,6 +1084,9 @@ var FlagConfig = z14.object({
|
|
|
1083
1084
|
"Indicates if this flag expects an action to be performed to be cleared."
|
|
1084
1085
|
),
|
|
1085
1086
|
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
1087
|
+
}).meta({
|
|
1088
|
+
id: "FlagConfig",
|
|
1089
|
+
description: "Configuration for a custom flag that can be added to or removed from records by event actions."
|
|
1086
1090
|
});
|
|
1087
1091
|
var ActionFlagConfig = z14.object({
|
|
1088
1092
|
id: Flag,
|
|
@@ -1090,6 +1094,9 @@ var ActionFlagConfig = z14.object({
|
|
|
1090
1094
|
conditional: Conditional.optional().describe(
|
|
1091
1095
|
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1092
1096
|
)
|
|
1097
|
+
}).meta({
|
|
1098
|
+
id: "ActionFlagConfig",
|
|
1099
|
+
description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
|
|
1093
1100
|
});
|
|
1094
1101
|
|
|
1095
1102
|
// ../commons/src/events/EventMetadata.ts
|
|
@@ -1111,8 +1118,7 @@ var ActionCreationMetadata = z15.object({
|
|
|
1111
1118
|
),
|
|
1112
1119
|
createdByUserType: z15.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
|
|
1113
1120
|
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.")
|
|
1121
|
+
createdByRole: z15.string().optional().describe("Role of the user at the time of action request creation.")
|
|
1116
1122
|
});
|
|
1117
1123
|
var RegistrationCreationMetadata = ActionCreationMetadata.extend({
|
|
1118
1124
|
registrationNumber: z15.string().describe(
|
|
@@ -1140,9 +1146,6 @@ var EventMetadata = z15.object({
|
|
|
1140
1146
|
createdAtLocation: UUID.nullish().describe(
|
|
1141
1147
|
"Location of the user who created the event."
|
|
1142
1148
|
),
|
|
1143
|
-
createdBySignature: DocumentPath.nullish().describe(
|
|
1144
|
-
"Signature of the user who created the event."
|
|
1145
|
-
),
|
|
1146
1149
|
updatedAtLocation: UUID.nullish().describe(
|
|
1147
1150
|
"Location of the user who last changed the status."
|
|
1148
1151
|
),
|
|
@@ -1406,14 +1409,31 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
|
|
|
1406
1409
|
}
|
|
1407
1410
|
}).describe("Unique identifier for the field");
|
|
1408
1411
|
var FieldReference = import_v43.default.object({
|
|
1409
|
-
$$field: FieldId,
|
|
1412
|
+
$$field: FieldId.describe("Id of the field to reference"),
|
|
1410
1413
|
$$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
|
|
1411
1414
|
'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
|
|
1415
|
+
),
|
|
1416
|
+
$$code: import_v43.default.string().optional().describe(
|
|
1417
|
+
"Serialised client-side function body. When present the expression is evaluated rather than dereferenced."
|
|
1418
|
+
)
|
|
1419
|
+
}).describe(
|
|
1420
|
+
"Reference to a field value, with an optional client-side computation applied."
|
|
1421
|
+
);
|
|
1422
|
+
var ComputedDefaultValue = import_v43.default.object({
|
|
1423
|
+
$$code: import_v43.default.string().describe(
|
|
1424
|
+
"Serialised client-side function body. Receives (undefined, context) where context includes $now, $online, and system variables."
|
|
1412
1425
|
)
|
|
1413
|
-
}).describe("
|
|
1426
|
+
}).describe("A context-only computation used as a field default value.");
|
|
1414
1427
|
var ValidationConfig = import_v43.default.object({
|
|
1415
|
-
validator: Conditional
|
|
1416
|
-
|
|
1428
|
+
validator: Conditional.describe(
|
|
1429
|
+
"Conditional expression that must hold for the field value to be considered valid."
|
|
1430
|
+
),
|
|
1431
|
+
message: TranslationConfig.describe(
|
|
1432
|
+
"Error message displayed when the validator does not hold."
|
|
1433
|
+
)
|
|
1434
|
+
}).meta({
|
|
1435
|
+
id: "ValidationConfig",
|
|
1436
|
+
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
1437
|
});
|
|
1418
1438
|
var requiredSchema = import_v43.default.union([
|
|
1419
1439
|
import_v43.default.boolean(),
|
|
@@ -1444,7 +1464,7 @@ var BaseField = import_v43.default.object({
|
|
|
1444
1464
|
"Indicates whether the field can be modified during record correction."
|
|
1445
1465
|
),
|
|
1446
1466
|
value: FieldReference.or(import_v43.default.array(FieldReference)).optional().describe(
|
|
1447
|
-
"Reference to the source field or fields. When a value is defined, it is copied from the parent field when changed. If multiple references are provided, the first truthy value is used."
|
|
1467
|
+
"Reference to the source field or fields. When a value is defined, it is copied from the parent field when changed. If multiple references are provided, the first truthy value is used. A FieldReference with $$code computes the value via a custom client-side function."
|
|
1448
1468
|
),
|
|
1449
1469
|
analytics: import_v43.default.boolean().default(false).optional().describe(
|
|
1450
1470
|
"Indicates whether the field is included in analytics. When enabled, its value becomes available in the analytics dashboard."
|
|
@@ -1452,30 +1472,39 @@ var BaseField = import_v43.default.object({
|
|
|
1452
1472
|
}).describe("Common properties shared across all field types.");
|
|
1453
1473
|
var Divider = BaseField.extend({
|
|
1454
1474
|
type: import_v43.default.literal(FieldType.DIVIDER)
|
|
1475
|
+
}).meta({
|
|
1476
|
+
description: "A horizontal line divider",
|
|
1477
|
+
id: "Divider"
|
|
1455
1478
|
});
|
|
1456
1479
|
var TextField = BaseField.extend({
|
|
1457
1480
|
type: import_v43.default.literal(FieldType.TEXT),
|
|
1458
|
-
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
1481
|
+
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
|
|
1459
1482
|
configuration: import_v43.default.object({
|
|
1460
1483
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
|
|
1461
1484
|
type: import_v43.default.enum(["text", "password"]).optional(),
|
|
1462
1485
|
prefix: TranslationConfig.optional(),
|
|
1463
1486
|
postfix: TranslationConfig.optional()
|
|
1464
1487
|
}).default({ type: "text" }).optional()
|
|
1465
|
-
}).
|
|
1488
|
+
}).meta({
|
|
1489
|
+
description: "A text input field",
|
|
1490
|
+
id: "TextField"
|
|
1491
|
+
});
|
|
1466
1492
|
var NumberField = BaseField.extend({
|
|
1467
1493
|
type: import_v43.default.literal(FieldType.NUMBER),
|
|
1468
|
-
defaultValue: NumberFieldValue.optional(),
|
|
1494
|
+
defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
|
|
1469
1495
|
configuration: import_v43.default.object({
|
|
1470
1496
|
min: import_v43.default.number().optional().describe("Minimum value"),
|
|
1471
1497
|
max: import_v43.default.number().optional().describe("Maximum value"),
|
|
1472
1498
|
prefix: TranslationConfig.optional(),
|
|
1473
1499
|
postfix: TranslationConfig.optional()
|
|
1474
1500
|
}).optional()
|
|
1475
|
-
}).
|
|
1501
|
+
}).meta({
|
|
1502
|
+
description: "A number input field",
|
|
1503
|
+
id: "NumberField"
|
|
1504
|
+
});
|
|
1476
1505
|
var TextAreaField = BaseField.extend({
|
|
1477
1506
|
type: import_v43.default.literal(FieldType.TEXTAREA),
|
|
1478
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1507
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1479
1508
|
configuration: import_v43.default.object({
|
|
1480
1509
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
|
|
1481
1510
|
rows: import_v43.default.number().optional().describe("Number of visible text lines"),
|
|
@@ -1483,7 +1512,10 @@ var TextAreaField = BaseField.extend({
|
|
|
1483
1512
|
prefix: TranslationConfig.optional(),
|
|
1484
1513
|
postfix: TranslationConfig.optional()
|
|
1485
1514
|
}).default({ rows: 4 }).optional()
|
|
1486
|
-
}).
|
|
1515
|
+
}).meta({
|
|
1516
|
+
description: "A multiline text input",
|
|
1517
|
+
id: "TextAreaField"
|
|
1518
|
+
});
|
|
1487
1519
|
var ImageMimeType = import_v43.default.enum([
|
|
1488
1520
|
"image/png",
|
|
1489
1521
|
"image/jpg",
|
|
@@ -1506,58 +1538,76 @@ var SignatureField = BaseField.extend({
|
|
|
1506
1538
|
signaturePromptLabel: TranslationConfig.describe(
|
|
1507
1539
|
"Title of the signature modal"
|
|
1508
1540
|
),
|
|
1509
|
-
defaultValue:
|
|
1541
|
+
defaultValue: SignatureFieldValue.or(ComputedDefaultValue).optional(),
|
|
1510
1542
|
configuration: import_v43.default.object({
|
|
1511
1543
|
maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
|
|
1512
1544
|
acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature")
|
|
1513
1545
|
}).default({
|
|
1514
1546
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1515
1547
|
})
|
|
1516
|
-
}).
|
|
1548
|
+
}).meta({
|
|
1549
|
+
description: "A signature input field",
|
|
1550
|
+
id: "SignatureField"
|
|
1551
|
+
});
|
|
1517
1552
|
var EmailField = BaseField.extend({
|
|
1518
1553
|
type: import_v43.default.literal(FieldType.EMAIL),
|
|
1519
1554
|
configuration: import_v43.default.object({
|
|
1520
1555
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
|
|
1521
1556
|
}).default({ maxLength: 255 }).optional(),
|
|
1522
|
-
defaultValue: NonEmptyTextValue.optional()
|
|
1557
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional()
|
|
1558
|
+
}).meta({
|
|
1559
|
+
description: "An email input field",
|
|
1560
|
+
id: "EmailField"
|
|
1523
1561
|
});
|
|
1524
1562
|
var DateField = BaseField.extend({
|
|
1525
1563
|
type: import_v43.default.literal(FieldType.DATE),
|
|
1526
|
-
defaultValue: SerializedNowDateTime.or(PlainDate).optional().describe("Default date value(yyyy-MM-dd)"),
|
|
1564
|
+
defaultValue: SerializedNowDateTime.or(PlainDate).or(ComputedDefaultValue).optional().describe("Default date value(yyyy-MM-dd)"),
|
|
1527
1565
|
configuration: import_v43.default.object({
|
|
1528
1566
|
notice: TranslationConfig.describe(
|
|
1529
1567
|
"Text to display above the date input"
|
|
1530
1568
|
).optional()
|
|
1531
1569
|
}).optional()
|
|
1532
|
-
}).
|
|
1570
|
+
}).meta({
|
|
1571
|
+
description: "A date input (yyyy-MM-dd)",
|
|
1572
|
+
id: "DateField"
|
|
1573
|
+
});
|
|
1533
1574
|
var AgeField = BaseField.extend({
|
|
1534
1575
|
type: import_v43.default.literal(FieldType.AGE),
|
|
1535
|
-
defaultValue: NumberFieldValue.optional(),
|
|
1576
|
+
defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
|
|
1536
1577
|
configuration: import_v43.default.object({
|
|
1537
1578
|
asOfDate: FieldReference,
|
|
1538
1579
|
prefix: TranslationConfig.optional(),
|
|
1539
1580
|
postfix: TranslationConfig.optional()
|
|
1540
1581
|
})
|
|
1541
|
-
}).
|
|
1582
|
+
}).meta({
|
|
1583
|
+
description: "An age input field which uses the current date as the asOfDate",
|
|
1584
|
+
id: "AgeField"
|
|
1585
|
+
});
|
|
1542
1586
|
var TimeField = BaseField.extend({
|
|
1543
1587
|
type: import_v43.default.literal(FieldType.TIME),
|
|
1544
|
-
defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
|
|
1588
|
+
defaultValue: SerializedNowDateTime.or(TimeValue).or(ComputedDefaultValue).optional().describe("Default time value (HH-mm)"),
|
|
1545
1589
|
configuration: import_v43.default.object({
|
|
1546
1590
|
use12HourFormat: import_v43.default.boolean().optional().describe("Whether to use 12-hour format"),
|
|
1547
1591
|
notice: TranslationConfig.describe(
|
|
1548
1592
|
"Text to display above the time input"
|
|
1549
1593
|
).optional()
|
|
1550
1594
|
}).optional()
|
|
1551
|
-
}).
|
|
1595
|
+
}).meta({
|
|
1596
|
+
description: "A single time input (HH-mm)",
|
|
1597
|
+
id: "TimeField"
|
|
1598
|
+
});
|
|
1552
1599
|
var DateRangeField = BaseField.extend({
|
|
1553
1600
|
type: import_v43.default.literal(FieldType.DATE_RANGE),
|
|
1554
|
-
defaultValue: DateRangeFieldValue.optional(),
|
|
1601
|
+
defaultValue: DateRangeFieldValue.or(ComputedDefaultValue).optional(),
|
|
1555
1602
|
configuration: import_v43.default.object({
|
|
1556
1603
|
notice: TranslationConfig.describe(
|
|
1557
1604
|
"Text to display above the date input"
|
|
1558
1605
|
).optional()
|
|
1559
1606
|
}).optional()
|
|
1560
|
-
}).
|
|
1607
|
+
}).meta({
|
|
1608
|
+
description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
|
|
1609
|
+
id: "DateRangeField"
|
|
1610
|
+
});
|
|
1561
1611
|
var HtmlFontVariant = import_v43.default.enum([
|
|
1562
1612
|
"reg12",
|
|
1563
1613
|
"reg14",
|
|
@@ -1601,21 +1651,33 @@ var ImageViewField = BaseField.extend({
|
|
|
1601
1651
|
type: import_v43.default.literal(FieldType.IMAGE_VIEW),
|
|
1602
1652
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1603
1653
|
configuration: ImageConfiguration
|
|
1604
|
-
}).
|
|
1654
|
+
}).meta({
|
|
1655
|
+
description: "A read-only image component for form pages",
|
|
1656
|
+
id: "ImageViewField"
|
|
1657
|
+
});
|
|
1605
1658
|
var Paragraph = BaseField.extend({
|
|
1606
1659
|
type: import_v43.default.literal(FieldType.PARAGRAPH),
|
|
1607
1660
|
configuration: ParagraphConfiguration
|
|
1608
|
-
}).
|
|
1661
|
+
}).meta({
|
|
1662
|
+
description: "A read-only HTML <p> paragraph",
|
|
1663
|
+
id: "Paragraph"
|
|
1664
|
+
});
|
|
1609
1665
|
var Heading = BaseField.extend({
|
|
1610
1666
|
type: import_v43.default.literal(FieldType.HEADING),
|
|
1611
1667
|
configuration: HeadingConfiguration
|
|
1612
|
-
}).
|
|
1668
|
+
}).meta({
|
|
1669
|
+
description: "A read-only heading component for form pages",
|
|
1670
|
+
id: "Heading"
|
|
1671
|
+
});
|
|
1613
1672
|
var PageHeader = BaseField.extend({
|
|
1614
1673
|
type: import_v43.default.literal(FieldType.PAGE_HEADER)
|
|
1615
|
-
}).
|
|
1674
|
+
}).meta({
|
|
1675
|
+
description: "A read-only header component for form pages",
|
|
1676
|
+
id: "PageHeader"
|
|
1677
|
+
});
|
|
1616
1678
|
var File = BaseField.extend({
|
|
1617
1679
|
type: import_v43.default.literal(FieldType.FILE),
|
|
1618
|
-
defaultValue: FileFieldValue.optional(),
|
|
1680
|
+
defaultValue: FileFieldValue.or(ComputedDefaultValue).optional(),
|
|
1619
1681
|
configuration: import_v43.default.object({
|
|
1620
1682
|
maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
|
|
1621
1683
|
acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature"),
|
|
@@ -1631,7 +1693,10 @@ var File = BaseField.extend({
|
|
|
1631
1693
|
}).default({
|
|
1632
1694
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1633
1695
|
})
|
|
1634
|
-
}).
|
|
1696
|
+
}).meta({
|
|
1697
|
+
description: "A file upload field",
|
|
1698
|
+
id: "File"
|
|
1699
|
+
});
|
|
1635
1700
|
var SelectOption = import_v43.default.object({
|
|
1636
1701
|
value: import_v43.default.string().describe("The value of the option"),
|
|
1637
1702
|
label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
|
|
@@ -1639,7 +1704,7 @@ var SelectOption = import_v43.default.object({
|
|
|
1639
1704
|
});
|
|
1640
1705
|
var NumberWithUnitField = BaseField.extend({
|
|
1641
1706
|
type: import_v43.default.literal(FieldType.NUMBER_WITH_UNIT),
|
|
1642
|
-
defaultValue: NumberWithUnitFieldValue.optional(),
|
|
1707
|
+
defaultValue: NumberWithUnitFieldValue.or(ComputedDefaultValue).optional(),
|
|
1643
1708
|
options: import_v43.default.array(SelectOption).describe("A list of options for the unit select"),
|
|
1644
1709
|
configuration: import_v43.default.object({
|
|
1645
1710
|
min: import_v43.default.number().optional().describe("Minimum value of the number field"),
|
|
@@ -1648,17 +1713,23 @@ var NumberWithUnitField = BaseField.extend({
|
|
|
1648
1713
|
"Placeholder for the number field"
|
|
1649
1714
|
)
|
|
1650
1715
|
}).optional()
|
|
1651
|
-
}).
|
|
1716
|
+
}).meta({
|
|
1717
|
+
description: "A number with unit input field",
|
|
1718
|
+
id: "NumberWithUnitField"
|
|
1719
|
+
});
|
|
1652
1720
|
var RadioGroup = BaseField.extend({
|
|
1653
1721
|
type: import_v43.default.literal(FieldType.RADIO_GROUP),
|
|
1654
|
-
defaultValue: TextValue.optional(),
|
|
1722
|
+
defaultValue: TextValue.or(ComputedDefaultValue).optional(),
|
|
1655
1723
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
1656
1724
|
configuration: import_v43.default.object({
|
|
1657
1725
|
styles: import_v43.default.object({
|
|
1658
1726
|
size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
|
|
1659
1727
|
}).optional()
|
|
1660
1728
|
}).optional()
|
|
1661
|
-
}).
|
|
1729
|
+
}).meta({
|
|
1730
|
+
description: "A grouped radio button field",
|
|
1731
|
+
id: "RadioGroup"
|
|
1732
|
+
});
|
|
1662
1733
|
var BulletList = BaseField.extend({
|
|
1663
1734
|
type: import_v43.default.literal(FieldType.BULLET_LIST),
|
|
1664
1735
|
items: import_v43.default.array(TranslationConfig).describe("A list of items"),
|
|
@@ -1667,10 +1738,13 @@ var BulletList = BaseField.extend({
|
|
|
1667
1738
|
fontVariant: HtmlFontVariant.optional()
|
|
1668
1739
|
}).optional()
|
|
1669
1740
|
}).default({})
|
|
1670
|
-
}).
|
|
1741
|
+
}).meta({
|
|
1742
|
+
description: "A list of bullet points",
|
|
1743
|
+
id: "BulletList"
|
|
1744
|
+
});
|
|
1671
1745
|
var Select = BaseField.extend({
|
|
1672
1746
|
type: import_v43.default.literal(FieldType.SELECT),
|
|
1673
|
-
defaultValue: TextValue.optional(),
|
|
1747
|
+
defaultValue: TextValue.or(ComputedDefaultValue).optional(),
|
|
1674
1748
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
1675
1749
|
noOptionsMessage: TranslationConfig.optional().describe(
|
|
1676
1750
|
`
|
|
@@ -1682,16 +1756,22 @@ var Select = BaseField.extend({
|
|
|
1682
1756
|
{ ..., defaultMessage: "'{input}' is not listed among the health facilities." }
|
|
1683
1757
|
`
|
|
1684
1758
|
)
|
|
1685
|
-
}).
|
|
1759
|
+
}).meta({
|
|
1760
|
+
description: "A select input field",
|
|
1761
|
+
id: "Select"
|
|
1762
|
+
});
|
|
1686
1763
|
var SelectDateRangeOption = import_v43.default.object({
|
|
1687
1764
|
value: SelectDateRangeValue.describe("The value of the option"),
|
|
1688
1765
|
label: TranslationConfig.describe("The label of the option")
|
|
1689
1766
|
});
|
|
1690
1767
|
var SelectDateRangeField = BaseField.extend({
|
|
1691
1768
|
type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
|
|
1692
|
-
defaultValue: SelectDateRangeValue.optional(),
|
|
1769
|
+
defaultValue: SelectDateRangeValue.or(ComputedDefaultValue).optional(),
|
|
1693
1770
|
options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
|
|
1694
|
-
}).
|
|
1771
|
+
}).meta({
|
|
1772
|
+
description: "A date range selection field",
|
|
1773
|
+
id: "SelectDateRangeField"
|
|
1774
|
+
});
|
|
1695
1775
|
var NameConfig = import_v43.default.object({
|
|
1696
1776
|
firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
1697
1777
|
middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
@@ -1703,7 +1783,7 @@ var NameField = BaseField.extend({
|
|
|
1703
1783
|
firstname: SerializedUserField.or(NonEmptyTextValue).optional(),
|
|
1704
1784
|
middlename: SerializedUserField.or(NonEmptyTextValue).optional(),
|
|
1705
1785
|
surname: SerializedUserField.or(NonEmptyTextValue).optional()
|
|
1706
|
-
}).optional(),
|
|
1786
|
+
}).or(ComputedDefaultValue).optional(),
|
|
1707
1787
|
configuration: import_v43.default.object({
|
|
1708
1788
|
name: NameConfig.default({
|
|
1709
1789
|
firstname: { required: true },
|
|
@@ -1722,26 +1802,41 @@ var NameField = BaseField.extend({
|
|
|
1722
1802
|
surname: { required: true }
|
|
1723
1803
|
}
|
|
1724
1804
|
}).optional()
|
|
1725
|
-
}).
|
|
1805
|
+
}).meta({
|
|
1806
|
+
description: "A field for entering a persons name",
|
|
1807
|
+
id: "NameField"
|
|
1808
|
+
});
|
|
1726
1809
|
var PhoneField = BaseField.extend({
|
|
1727
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1810
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1728
1811
|
type: import_v43.default.literal(FieldType.PHONE)
|
|
1729
|
-
}).
|
|
1812
|
+
}).meta({
|
|
1813
|
+
description: "A field for entering a phone number",
|
|
1814
|
+
id: "PhoneField"
|
|
1815
|
+
});
|
|
1730
1816
|
var IdField = BaseField.extend({
|
|
1731
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1817
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1732
1818
|
type: import_v43.default.literal(FieldType.ID)
|
|
1733
|
-
}).
|
|
1819
|
+
}).meta({
|
|
1820
|
+
description: "A field for entering an ID",
|
|
1821
|
+
id: "IdField"
|
|
1822
|
+
});
|
|
1734
1823
|
var Checkbox = BaseField.extend({
|
|
1735
1824
|
type: import_v43.default.literal(FieldType.CHECKBOX),
|
|
1736
|
-
defaultValue: CheckboxFieldValue.default(false)
|
|
1737
|
-
}).
|
|
1825
|
+
defaultValue: CheckboxFieldValue.or(ComputedDefaultValue).default(false)
|
|
1826
|
+
}).meta({
|
|
1827
|
+
description: "A boolean checkbox field",
|
|
1828
|
+
id: "Checkbox"
|
|
1829
|
+
});
|
|
1738
1830
|
var Country = BaseField.extend({
|
|
1739
1831
|
type: import_v43.default.literal(FieldType.COUNTRY),
|
|
1740
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1832
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1741
1833
|
optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
|
|
1742
1834
|
"Conditionals for specific countries. Countries not listed are always shown and enabled."
|
|
1743
1835
|
)
|
|
1744
|
-
}).
|
|
1836
|
+
}).meta({
|
|
1837
|
+
description: "A field for selecting a country",
|
|
1838
|
+
id: "Country"
|
|
1839
|
+
});
|
|
1745
1840
|
var AllowedLocations = JurisdictionReference.optional().describe(
|
|
1746
1841
|
"Limits which location options are selectable depending on user jurisdiction and location."
|
|
1747
1842
|
);
|
|
@@ -1750,28 +1845,33 @@ var AdministrativeAreas = import_v43.default.enum([
|
|
|
1750
1845
|
"HEALTH_FACILITY",
|
|
1751
1846
|
"CRVS_OFFICE"
|
|
1752
1847
|
]);
|
|
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
1848
|
var AdministrativeAreaField = BaseField.extend({
|
|
1759
1849
|
type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
|
|
1760
|
-
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
1761
|
-
configuration:
|
|
1762
|
-
|
|
1850
|
+
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
|
|
1851
|
+
configuration: import_v43.default.object({
|
|
1852
|
+
partOf: FieldReference.optional().describe("Parent location"),
|
|
1853
|
+
type: AdministrativeAreas,
|
|
1854
|
+
allowedLocations: AllowedLocations
|
|
1855
|
+
}).describe("Administrative area options")
|
|
1856
|
+
}).meta({
|
|
1857
|
+
description: "Administrative area input field",
|
|
1858
|
+
id: "AdministrativeAreaField"
|
|
1859
|
+
});
|
|
1763
1860
|
var LocationInput = BaseField.extend({
|
|
1764
1861
|
type: import_v43.default.literal(FieldType.LOCATION),
|
|
1765
|
-
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
1862
|
+
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
|
|
1766
1863
|
configuration: import_v43.default.object({
|
|
1767
1864
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
1768
1865
|
allowedLocations: AllowedLocations
|
|
1769
1866
|
}).optional()
|
|
1770
|
-
}).
|
|
1867
|
+
}).meta({
|
|
1868
|
+
description: "A field for selecting a location",
|
|
1869
|
+
id: "LocationInput"
|
|
1870
|
+
});
|
|
1771
1871
|
var FileUploadWithOptions = BaseField.extend({
|
|
1772
1872
|
type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
|
|
1773
1873
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
1774
|
-
defaultValue: FileFieldWithOptionValue.optional(),
|
|
1874
|
+
defaultValue: FileFieldWithOptionValue.or(ComputedDefaultValue).optional(),
|
|
1775
1875
|
configuration: import_v43.default.object({
|
|
1776
1876
|
maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
|
|
1777
1877
|
maxImageSize: import_v43.default.object({
|
|
@@ -1781,15 +1881,18 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
1781
1881
|
}).default({
|
|
1782
1882
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1783
1883
|
})
|
|
1884
|
+
}).meta({
|
|
1885
|
+
description: "A field for uploading files with file type options",
|
|
1886
|
+
id: "FileUploadWithOptions"
|
|
1784
1887
|
});
|
|
1785
1888
|
var Facility = BaseField.extend({
|
|
1786
1889
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
1787
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1890
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1788
1891
|
configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
|
|
1789
1892
|
}).describe("Input field for a facility");
|
|
1790
1893
|
var Office = BaseField.extend({
|
|
1791
1894
|
type: import_v43.default.literal(FieldType.OFFICE),
|
|
1792
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1895
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1793
1896
|
configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
|
|
1794
1897
|
}).describe("Input field for an office");
|
|
1795
1898
|
var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
|
|
@@ -1825,8 +1928,11 @@ var Address = BaseField.extend({
|
|
|
1825
1928
|
).optional(),
|
|
1826
1929
|
allowedLocations: AllowedLocations
|
|
1827
1930
|
}).optional(),
|
|
1828
|
-
defaultValue: DefaultAddressFieldValue.optional()
|
|
1829
|
-
}).
|
|
1931
|
+
defaultValue: DefaultAddressFieldValue.or(ComputedDefaultValue).optional()
|
|
1932
|
+
}).meta({
|
|
1933
|
+
description: "Address input field \u2013 a combination of location and text fields",
|
|
1934
|
+
id: "Address"
|
|
1935
|
+
});
|
|
1830
1936
|
var StaticDataEntry = import_v43.default.object({
|
|
1831
1937
|
id: import_v43.default.string().describe("ID for the data entry."),
|
|
1832
1938
|
label: TranslationConfig,
|
|
@@ -1841,7 +1947,10 @@ var DataField = BaseField.extend({
|
|
|
1841
1947
|
subtitle: TranslationConfig.optional(),
|
|
1842
1948
|
data: import_v43.default.array(DataEntry)
|
|
1843
1949
|
})
|
|
1844
|
-
}).
|
|
1950
|
+
}).meta({
|
|
1951
|
+
description: "A field for displaying a table of read-only data",
|
|
1952
|
+
id: "DataField"
|
|
1953
|
+
});
|
|
1845
1954
|
var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
|
|
1846
1955
|
var ButtonType = import_v43.default.enum([
|
|
1847
1956
|
"primary",
|
|
@@ -1866,13 +1975,19 @@ var ButtonConfiguration = import_v43.default.object({
|
|
|
1866
1975
|
});
|
|
1867
1976
|
var ButtonField = BaseField.extend({
|
|
1868
1977
|
type: import_v43.default.literal(FieldType.BUTTON),
|
|
1869
|
-
defaultValue: ButtonFieldValue.optional(),
|
|
1978
|
+
defaultValue: ButtonFieldValue.or(ComputedDefaultValue).optional(),
|
|
1870
1979
|
configuration: ButtonConfiguration
|
|
1871
|
-
}).
|
|
1980
|
+
}).meta({
|
|
1981
|
+
description: "A generic button that can be used to trigger an action",
|
|
1982
|
+
id: "ButtonField"
|
|
1983
|
+
});
|
|
1872
1984
|
var FieldGroup = BaseField.extend({
|
|
1873
1985
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
1874
1986
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
1875
1987
|
fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
|
|
1988
|
+
}).meta({
|
|
1989
|
+
description: "A group of fields that are displayed together",
|
|
1990
|
+
id: "FieldGroup"
|
|
1876
1991
|
});
|
|
1877
1992
|
var AlphaPrintButton = BaseField.extend({
|
|
1878
1993
|
type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
|
|
@@ -1882,10 +1997,13 @@ var AlphaPrintButton = BaseField.extend({
|
|
|
1882
1997
|
"Label for the print button"
|
|
1883
1998
|
)
|
|
1884
1999
|
})
|
|
1885
|
-
}).
|
|
2000
|
+
}).meta({
|
|
2001
|
+
description: "An experimental print button field for printing certificates during the declaration process",
|
|
2002
|
+
id: "AlphaPrintButton"
|
|
2003
|
+
});
|
|
1886
2004
|
var HttpField = BaseField.extend({
|
|
1887
2005
|
type: import_v43.default.literal(FieldType.HTTP),
|
|
1888
|
-
defaultValue: HttpFieldValue.optional(),
|
|
2006
|
+
defaultValue: HttpFieldValue.or(ComputedDefaultValue).optional(),
|
|
1889
2007
|
configuration: import_v43.default.object({
|
|
1890
2008
|
trigger: FieldReference.optional().describe(
|
|
1891
2009
|
"Reference to the field that triggers the HTTP request when its value changes. If not provided, the HTTP request is triggered once on component mount."
|
|
@@ -1898,20 +2016,30 @@ var HttpField = BaseField.extend({
|
|
|
1898
2016
|
params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
|
|
1899
2017
|
timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
|
|
1900
2018
|
})
|
|
1901
|
-
}).
|
|
2019
|
+
}).meta({
|
|
2020
|
+
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.",
|
|
2021
|
+
id: "HttpField"
|
|
2022
|
+
});
|
|
1902
2023
|
var AutocompleteField = BaseField.extend({
|
|
1903
2024
|
type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
|
|
1904
2025
|
configuration: import_v43.default.object({
|
|
1905
|
-
url: import_v43.default.string().describe(
|
|
2026
|
+
url: import_v43.default.string().describe(
|
|
2027
|
+
"URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
|
|
2028
|
+
).optional(),
|
|
1906
2029
|
method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
|
|
1907
2030
|
defaultOptions: import_v43.default.array(
|
|
1908
2031
|
import_v43.default.object({
|
|
1909
2032
|
label: import_v43.default.string(),
|
|
1910
2033
|
value: import_v43.default.string()
|
|
1911
2034
|
})
|
|
1912
|
-
).optional()
|
|
2035
|
+
).optional().describe(
|
|
2036
|
+
"Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
|
|
2037
|
+
)
|
|
1913
2038
|
})
|
|
1914
|
-
}).
|
|
2039
|
+
}).meta({
|
|
2040
|
+
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.",
|
|
2041
|
+
id: "AutocompleteField"
|
|
2042
|
+
});
|
|
1915
2043
|
var SearchField = HttpField.extend({
|
|
1916
2044
|
type: import_v43.default.literal(FieldType.SEARCH),
|
|
1917
2045
|
configuration: SearchQuery.pick({
|
|
@@ -1944,6 +2072,9 @@ var SearchField = HttpField.extend({
|
|
|
1944
2072
|
ok: TranslationConfig.optional()
|
|
1945
2073
|
}).optional()
|
|
1946
2074
|
})
|
|
2075
|
+
}).meta({
|
|
2076
|
+
description: "A search input field",
|
|
2077
|
+
id: "SearchField"
|
|
1947
2078
|
});
|
|
1948
2079
|
var LinkButtonField = BaseField.extend({
|
|
1949
2080
|
type: import_v43.default.literal(FieldType.LINK_BUTTON),
|
|
@@ -1952,28 +2083,35 @@ var LinkButtonField = BaseField.extend({
|
|
|
1952
2083
|
text: TranslationConfig.describe("Text to display on the button"),
|
|
1953
2084
|
icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
|
|
1954
2085
|
})
|
|
1955
|
-
}).
|
|
2086
|
+
}).meta({
|
|
2087
|
+
description: "A button that opens a URL link",
|
|
2088
|
+
id: "LinkButtonField"
|
|
2089
|
+
});
|
|
1956
2090
|
var VerificationStatus = BaseField.extend({
|
|
1957
2091
|
type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
|
|
1958
|
-
defaultValue: VerificationStatusValue.optional(),
|
|
2092
|
+
defaultValue: VerificationStatusValue.or(ComputedDefaultValue).optional(),
|
|
1959
2093
|
configuration: import_v43.default.object({
|
|
1960
2094
|
status: TranslationConfig.describe("Text to display on the status pill."),
|
|
1961
2095
|
description: TranslationConfig.describe(
|
|
1962
2096
|
"Explaining text on the banner in form."
|
|
1963
2097
|
)
|
|
1964
2098
|
})
|
|
2099
|
+
}).meta({
|
|
2100
|
+
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.",
|
|
2101
|
+
id: "VerificationStatus"
|
|
1965
2102
|
});
|
|
1966
2103
|
var QueryParamReaderField = BaseField.extend({
|
|
1967
2104
|
type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
|
|
1968
2105
|
configuration: import_v43.default.object({
|
|
1969
2106
|
pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
|
|
1970
2107
|
})
|
|
1971
|
-
}).
|
|
1972
|
-
"A field that maps URL query params into form values and clears them afterward"
|
|
1973
|
-
|
|
2108
|
+
}).meta({
|
|
2109
|
+
description: "A field that maps URL query params into form values and clears them afterward",
|
|
2110
|
+
id: "QueryParamReaderField"
|
|
2111
|
+
});
|
|
1974
2112
|
var QrReaderField = BaseField.extend({
|
|
1975
2113
|
type: import_v43.default.literal(FieldType.QR_READER),
|
|
1976
|
-
defaultValue: QrReaderFieldValue.optional(),
|
|
2114
|
+
defaultValue: QrReaderFieldValue.or(ComputedDefaultValue).optional(),
|
|
1977
2115
|
configuration: import_v43.default.object({
|
|
1978
2116
|
validator: import_v43.default.any().meta({
|
|
1979
2117
|
description: "JSON Schema to validate the scanned QR code data against before populating the form fields.",
|
|
@@ -1981,21 +2119,27 @@ var QrReaderField = BaseField.extend({
|
|
|
1981
2119
|
})
|
|
1982
2120
|
}).optional()
|
|
1983
2121
|
}).meta({
|
|
1984
|
-
description: "
|
|
2122
|
+
description: "QR code reader field, including optional JSON Schema validator.",
|
|
1985
2123
|
id: "QrReaderField"
|
|
1986
2124
|
});
|
|
1987
2125
|
var IdReaderField = BaseField.extend({
|
|
1988
2126
|
type: import_v43.default.literal(FieldType.ID_READER),
|
|
1989
|
-
defaultValue: IdReaderFieldValue.optional(),
|
|
2127
|
+
defaultValue: IdReaderFieldValue.or(ComputedDefaultValue).optional(),
|
|
1990
2128
|
methods: import_v43.default.array(
|
|
1991
2129
|
import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
|
|
1992
2130
|
)
|
|
2131
|
+
}).meta({
|
|
2132
|
+
description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
|
|
2133
|
+
id: "IdReaderField"
|
|
1993
2134
|
});
|
|
1994
2135
|
var CustomField = BaseField.extend({
|
|
1995
2136
|
type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
|
|
1996
2137
|
defaultValue: CustomFieldValue.optional(),
|
|
1997
2138
|
src: import_v43.default.string().describe("Module source path for the custom field component"),
|
|
1998
2139
|
configuration: import_v43.default.unknown().optional()
|
|
2140
|
+
}).meta({
|
|
2141
|
+
description: "An expiremental custom field that is defined by a module source path",
|
|
2142
|
+
id: "CustomField"
|
|
1999
2143
|
});
|
|
2000
2144
|
var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
|
|
2001
2145
|
var LoaderField = BaseField.extend({
|
|
@@ -2005,22 +2149,25 @@ var LoaderField = BaseField.extend({
|
|
|
2005
2149
|
configuration: import_v43.default.object({
|
|
2006
2150
|
text: TranslationConfig.describe("Display text above the loading spinner")
|
|
2007
2151
|
})
|
|
2008
|
-
}).
|
|
2009
|
-
"A non-interactive field that indicates an in progress operation in form"
|
|
2010
|
-
|
|
2152
|
+
}).meta({
|
|
2153
|
+
description: "A non-interactive field that indicates an in progress operation in form",
|
|
2154
|
+
id: "LoaderField"
|
|
2155
|
+
});
|
|
2011
2156
|
var HiddenField = BaseField.extend({
|
|
2012
2157
|
type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
|
|
2013
2158
|
required: import_v43.default.boolean().default(false).optional(),
|
|
2014
2159
|
defaultValue: TextValue.optional()
|
|
2015
|
-
}).
|
|
2016
|
-
"A non-interactive, hidden field that only hold a value in the form"
|
|
2017
|
-
|
|
2160
|
+
}).meta({
|
|
2161
|
+
description: "A non-interactive, hidden field that only hold a value in the form",
|
|
2162
|
+
id: "HiddenField"
|
|
2163
|
+
});
|
|
2018
2164
|
var UserRoleField = BaseField.extend({
|
|
2019
2165
|
type: import_v43.default.literal(FieldType.USER_ROLE),
|
|
2020
2166
|
defaultValue: TextValue.optional()
|
|
2021
|
-
}).
|
|
2022
|
-
"A select dropdown that is automatically populated with available user roles"
|
|
2023
|
-
|
|
2167
|
+
}).meta({
|
|
2168
|
+
description: "A select dropdown that is automatically populated with available user roles",
|
|
2169
|
+
id: "UserRoleField"
|
|
2170
|
+
});
|
|
2024
2171
|
var FieldConfig = import_v43.default.discriminatedUnion("type", [
|
|
2025
2172
|
FieldGroup,
|
|
2026
2173
|
Address,
|
|
@@ -2138,6 +2285,7 @@ var ClientConfig = z20.object({
|
|
|
2138
2285
|
COUNTRY: z20.string(),
|
|
2139
2286
|
LANGUAGES: z20.array(z20.string()),
|
|
2140
2287
|
SENTRY: z20.string().optional(),
|
|
2288
|
+
LOGIN_URL: z20.string().optional(),
|
|
2141
2289
|
REGISTER_BACKGROUND: BackgroundConfig,
|
|
2142
2290
|
DASHBOARDS: z20.array(
|
|
2143
2291
|
z20.object({
|