@opencrvs/toolkit 2.0.0-rc.3c82a4c → 2.0.0-rc.3d1914b
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/README.md +15 -0
- package/build.sh +3 -2
- package/create-countryconfig/index.js +50 -20
- package/create-countryconfig/package.json +12 -2
- package/dist/application-config/index.js +268 -102
- package/dist/cli.js +3263 -49
- package/dist/commons/api/router.d.ts +117 -21
- 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 +51 -2
- package/dist/commons/events/ActionConfig.d.ts +28 -2
- package/dist/commons/events/ActionDocument.d.ts +6 -0
- package/dist/commons/events/ActionInput.d.ts +42 -36
- package/dist/commons/events/AdvancedSearchConfig.d.ts +354 -0
- package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
- package/dist/commons/events/Draft.d.ts +2 -3
- package/dist/commons/events/EventConfig.d.ts +2 -0
- package/dist/commons/events/EventDocument.d.ts +3 -0
- package/dist/commons/events/EventIndex.d.ts +25 -0
- package/dist/commons/events/EventMetadata.d.ts +26 -0
- package/dist/commons/events/FieldConfig.d.ts +388 -50
- package/dist/commons/events/FieldType.d.ts +1 -0
- package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
- package/dist/commons/events/FieldValue.d.ts +6 -0
- package/dist/commons/events/WorkqueueConfig.d.ts +44 -5
- package/dist/commons/events/field.d.ts +53 -1
- package/dist/commons/events/index.d.ts +2 -0
- package/dist/commons/events/locations.d.ts +1 -0
- package/dist/commons/events/state/flags.d.ts +16 -0
- package/dist/commons/events/state/index.d.ts +8 -0
- package/dist/commons/events/state/utils.d.ts +21 -287
- package/dist/commons/events/utils.d.ts +12 -1
- package/dist/conditionals/index.js +63 -5
- package/dist/environment/custom-types.d.ts +33 -0
- package/dist/environment/custom-types.d.ts.map +1 -0
- package/dist/environment/custom-types.js +12 -0
- package/dist/environment/derived-variables.d.ts +134 -0
- package/dist/environment/derived-variables.d.ts.map +1 -0
- package/dist/environment/derived-variables.js +169 -0
- package/dist/environment/editor-questions.d.ts +4 -0
- package/dist/environment/editor-questions.d.ts.map +1 -0
- package/dist/environment/editor-questions.js +67 -0
- package/dist/environment/git.d.ts +5 -0
- package/dist/environment/git.d.ts.map +1 -0
- package/dist/environment/git.js +38 -0
- package/dist/environment/github.d.ts +26 -0
- package/dist/environment/github.d.ts.map +1 -0
- package/dist/environment/github.js +247 -0
- package/dist/environment/index.d.ts +5 -0
- package/dist/environment/index.d.ts.map +1 -0
- package/dist/environment/index.js +71 -0
- package/dist/environment/logger.d.ts +15 -0
- package/dist/environment/logger.d.ts.map +1 -0
- package/dist/environment/logger.js +25 -0
- package/dist/environment/manage-users.d.ts +11 -0
- package/dist/environment/manage-users.d.ts.map +1 -0
- package/dist/environment/manage-users.js +497 -0
- package/dist/environment/questions-helper.d.ts +15 -0
- package/dist/environment/questions-helper.d.ts.map +1 -0
- package/dist/environment/questions-helper.js +70 -0
- package/dist/environment/questions.d.ts +199 -0
- package/dist/environment/questions.d.ts.map +1 -0
- package/dist/environment/questions.js +412 -0
- package/dist/environment/setup-environment.d.ts +2 -0
- package/dist/environment/setup-environment.d.ts.map +1 -0
- package/dist/environment/setup-environment.js +794 -0
- package/dist/environment/ssh-keygen.d.ts +5 -0
- package/dist/environment/ssh-keygen.d.ts.map +1 -0
- package/dist/environment/ssh-keygen.js +21 -0
- package/dist/environment/swarm-to-k8s.d.ts +2 -0
- package/dist/environment/swarm-to-k8s.d.ts.map +1 -0
- package/dist/environment/swarm-to-k8s.js +173 -0
- package/dist/environment/templates.d.ts +27 -0
- package/dist/environment/templates.d.ts.map +1 -0
- package/dist/environment/templates.js +163 -0
- package/dist/environment/update-workflows.d.ts +2 -0
- package/dist/environment/update-workflows.d.ts.map +1 -0
- package/dist/environment/update-workflows.js +169 -0
- package/dist/environment/users.d.ts +2 -0
- package/dist/environment/users.d.ts.map +1 -0
- package/dist/environment/users.js +112 -0
- package/dist/environment/utils.d.ts +18 -0
- package/dist/environment/utils.d.ts.map +1 -0
- package/dist/environment/utils.js +100 -0
- package/dist/events/index.js +1076 -227
- 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 -1
- package/dist/migrations/v2.0/index.js +21 -8
- package/dist/notification/index.js +887 -125
- package/dist/scopes/index.d.ts +93 -7
- package/dist/scopes/index.js +20 -7
- package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
- package/dist/templates/charts-values/dependencies/values.yaml +83 -0
- package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
- package/dist/templates/charts-values/opencrvs-services/values.yaml +81 -0
- package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
- package/dist/templates/charts-values/traefik/values.yaml +115 -0
- package/dist/templates/inventory/inventory.template.yml +100 -0
- package/dist/templates/inventory/production.example.yml +77 -0
- package/dist/templates/inventory/qa.example.yml +48 -0
- package/opencrvs-toolkit-2.0.0-rc.3d1914b.tgz +0 -0
- package/package.json +20 -2
- package/tsconfig.tsbuildinfo +1 -1
- package/opencrvs-toolkit-2.0.0-rc.3c82a4c.tgz +0 -0
|
@@ -76,8 +76,8 @@ var ActionConditional = z.discriminatedUnion("type", [
|
|
|
76
76
|
// Action can be shown to the user in the list but as disabled
|
|
77
77
|
EnableConditional
|
|
78
78
|
]).meta({
|
|
79
|
-
|
|
80
|
-
|
|
79
|
+
id: "ActionConditional",
|
|
80
|
+
description: "Conditional gating whether an action is shown (SHOW) or enabled (ENABLE). When omitted from an action, the action is shown and enabled for everyone."
|
|
81
81
|
});
|
|
82
82
|
var DisplayOnReviewConditional = z.object({
|
|
83
83
|
type: z.literal(ConditionalType.DISPLAY_ON_REVIEW),
|
|
@@ -93,8 +93,8 @@ var FieldConditional = z.discriminatedUnion("type", [
|
|
|
93
93
|
// Field output can be shown / hidden on the review page
|
|
94
94
|
DisplayOnReviewConditional
|
|
95
95
|
]).meta({
|
|
96
|
-
|
|
97
|
-
|
|
96
|
+
id: "FieldConditional",
|
|
97
|
+
description: "Conditional gating whether a form field is shown (SHOW), enabled (ENABLE), or displayed on the review page (DISPLAY_ON_REVIEW). When omitted, the field is shown and enabled for everyone, and is displayed on review whenever it has a value."
|
|
98
98
|
});
|
|
99
99
|
|
|
100
100
|
// ../commons/src/events/TranslationConfig.ts
|
|
@@ -206,6 +206,11 @@ var FieldTypesToHideInReview = [
|
|
|
206
206
|
FieldType.ALPHA_PRINT_BUTTON,
|
|
207
207
|
FieldType.ALPHA_HIDDEN
|
|
208
208
|
];
|
|
209
|
+
var HiddenFieldTypes = [
|
|
210
|
+
FieldType.HTTP,
|
|
211
|
+
FieldType.QUERY_PARAM_READER,
|
|
212
|
+
FieldType.ALPHA_HIDDEN
|
|
213
|
+
];
|
|
209
214
|
|
|
210
215
|
// ../commons/src/events/FieldValue.ts
|
|
211
216
|
var z7 = __toESM(require("zod/v4"));
|
|
@@ -324,7 +329,7 @@ var PlainDate = import_zod.z.string().date().brand("PlainDate").describe("Date i
|
|
|
324
329
|
// ../commons/src/events/FieldValue.ts
|
|
325
330
|
var TextValue = z7.string();
|
|
326
331
|
var HiddenFieldValue = z7.string();
|
|
327
|
-
var NonEmptyTextValue =
|
|
332
|
+
var NonEmptyTextValue = z7.string().trim().min(1);
|
|
328
333
|
var DateValue = z7.iso.date().describe("Date in the format YYYY-MM-DD");
|
|
329
334
|
var AgeValue = z7.object({
|
|
330
335
|
age: z7.number(),
|
|
@@ -353,6 +358,7 @@ var DateRangeFieldValue = z7.object({
|
|
|
353
358
|
var EmailValue = z7.email();
|
|
354
359
|
var CheckboxFieldValue = z7.boolean();
|
|
355
360
|
var NumberFieldValue = z7.number();
|
|
361
|
+
var SignatureFieldValue = FileFieldValue;
|
|
356
362
|
var ButtonFieldValue = z7.number();
|
|
357
363
|
var VerificationStatusValue = z7.enum([
|
|
358
364
|
"verified",
|
|
@@ -659,11 +665,13 @@ var scopeOptionsPlaceEvent = z11.object({
|
|
|
659
665
|
event: scopeByEvent,
|
|
660
666
|
placeOfEvent: JurisdictionFilter.optional()
|
|
661
667
|
}).describe("Options applicable to all record scopes.");
|
|
662
|
-
var
|
|
668
|
+
var scopeOptionsDeclaredOrNotified = scopeOptionsPlaceEvent.extend({
|
|
669
|
+
notifiedIn: JurisdictionFilter.optional(),
|
|
670
|
+
notifiedBy: UserFilter.optional(),
|
|
663
671
|
declaredIn: JurisdictionFilter.optional(),
|
|
664
672
|
declaredBy: UserFilter.optional()
|
|
665
673
|
}).describe("Options applicable to actions that may take place after DECLARE");
|
|
666
|
-
var AllRecordScopeOptions =
|
|
674
|
+
var AllRecordScopeOptions = scopeOptionsDeclaredOrNotified.extend({
|
|
667
675
|
registeredIn: JurisdictionFilter.optional(),
|
|
668
676
|
registeredBy: UserFilter.optional()
|
|
669
677
|
}).describe(
|
|
@@ -701,6 +709,8 @@ var ResolvedScopeOptionsPlaceEvent = z11.object({
|
|
|
701
709
|
"Resolved options applicable to all record scopes, with location ID instead of jurisdiction filter."
|
|
702
710
|
);
|
|
703
711
|
var ResolvedScopeOptionsDeclared = ResolvedScopeOptionsPlaceEvent.extend({
|
|
712
|
+
notifiedIn: UUID.nullish(),
|
|
713
|
+
notifiedBy: z11.string().optional(),
|
|
704
714
|
declaredIn: UUID.nullish(),
|
|
705
715
|
declaredBy: z11.string().optional()
|
|
706
716
|
}).describe(
|
|
@@ -746,7 +756,7 @@ var RecordScopeV2 = z11.discriminatedUnion("type", [
|
|
|
746
756
|
}),
|
|
747
757
|
z11.object({
|
|
748
758
|
type: ScopesWithDeclaredOptions,
|
|
749
|
-
options:
|
|
759
|
+
options: scopeOptionsDeclaredOrNotified.optional()
|
|
750
760
|
}),
|
|
751
761
|
z11.object({
|
|
752
762
|
type: ScopesWithFullOptions,
|
|
@@ -834,7 +844,10 @@ var ScopeType = z11.enum([
|
|
|
834
844
|
var EncodedScope = z11.string().brand("EncodedScope");
|
|
835
845
|
var DEFAULT_SCOPE_OPTIONS = {
|
|
836
846
|
placeOfEvent: JurisdictionFilter.enum.all,
|
|
837
|
-
accessLevel: JurisdictionFilter.enum.all
|
|
847
|
+
accessLevel: JurisdictionFilter.enum.all,
|
|
848
|
+
notifiedIn: JurisdictionFilter.enum.all,
|
|
849
|
+
declaredIn: JurisdictionFilter.enum.all,
|
|
850
|
+
registeredIn: JurisdictionFilter.enum.all
|
|
838
851
|
};
|
|
839
852
|
|
|
840
853
|
// ../commons/src/authentication.ts
|
|
@@ -987,8 +1000,9 @@ var RequestedCorrectionAction = ActionBase.extend(
|
|
|
987
1000
|
var ApprovedCorrectionAction = ActionBase.extend(
|
|
988
1001
|
z13.object({
|
|
989
1002
|
type: z13.literal(ActionType.APPROVE_CORRECTION),
|
|
990
|
-
requestId: z13.string()
|
|
1003
|
+
requestId: z13.string(),
|
|
991
1004
|
// TODO move into 'content' property
|
|
1005
|
+
content: z13.object({ immediateCorrection: z13.boolean().optional() }).optional()
|
|
992
1006
|
}).shape
|
|
993
1007
|
);
|
|
994
1008
|
var RejectedCorrectionAction = ActionBase.extend(
|
|
@@ -1081,8 +1095,8 @@ var FlagConfig = z14.object({
|
|
|
1081
1095
|
),
|
|
1082
1096
|
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
1083
1097
|
}).meta({
|
|
1084
|
-
|
|
1085
|
-
|
|
1098
|
+
id: "FlagConfig",
|
|
1099
|
+
description: "Configuration for a custom flag that can be added to or removed from records by event actions."
|
|
1086
1100
|
});
|
|
1087
1101
|
var ActionFlagConfig = z14.object({
|
|
1088
1102
|
id: Flag,
|
|
@@ -1091,8 +1105,8 @@ var ActionFlagConfig = z14.object({
|
|
|
1091
1105
|
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1092
1106
|
)
|
|
1093
1107
|
}).meta({
|
|
1094
|
-
|
|
1095
|
-
|
|
1108
|
+
id: "ActionFlagConfig",
|
|
1109
|
+
description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
|
|
1096
1110
|
});
|
|
1097
1111
|
|
|
1098
1112
|
// ../commons/src/events/EventMetadata.ts
|
|
@@ -1122,6 +1136,7 @@ var RegistrationCreationMetadata = ActionCreationMetadata.extend({
|
|
|
1122
1136
|
)
|
|
1123
1137
|
});
|
|
1124
1138
|
var LegalStatuses = z15.object({
|
|
1139
|
+
[EventStatus.enum.NOTIFIED]: ActionCreationMetadata.nullish(),
|
|
1125
1140
|
[EventStatus.enum.DECLARED]: ActionCreationMetadata.nullish(),
|
|
1126
1141
|
[EventStatus.enum.REGISTERED]: RegistrationCreationMetadata.nullish()
|
|
1127
1142
|
});
|
|
@@ -1181,6 +1196,8 @@ var EventMetadataKeys = z15.enum(EventMetadataKeysArray);
|
|
|
1181
1196
|
var EventMetadataDateFieldIdInput = z15.enum([
|
|
1182
1197
|
"createdAt",
|
|
1183
1198
|
"updatedAt",
|
|
1199
|
+
"legalStatuses.NOTIFIED.createdAt",
|
|
1200
|
+
"legalStatuses.NOTIFIED.acceptedAt",
|
|
1184
1201
|
"legalStatuses.DECLARED.createdAt",
|
|
1185
1202
|
"legalStatuses.DECLARED.acceptedAt",
|
|
1186
1203
|
"legalStatuses.REGISTERED.createdAt",
|
|
@@ -1189,6 +1206,8 @@ var EventMetadataDateFieldIdInput = z15.enum([
|
|
|
1189
1206
|
var EventMetadataDateFieldId = z15.enum([
|
|
1190
1207
|
"event.createdAt",
|
|
1191
1208
|
"event.updatedAt",
|
|
1209
|
+
"event.legalStatuses.NOTIFIED.createdAt",
|
|
1210
|
+
"event.legalStatuses.NOTIFIED.acceptedAt",
|
|
1192
1211
|
"event.legalStatuses.DECLARED.createdAt",
|
|
1193
1212
|
"event.legalStatuses.DECLARED.acceptedAt",
|
|
1194
1213
|
"event.legalStatuses.REGISTERED.createdAt",
|
|
@@ -1251,7 +1270,8 @@ var Range = import_v4.z.object({
|
|
|
1251
1270
|
});
|
|
1252
1271
|
var ContainsFlags = import_v4.z.object({
|
|
1253
1272
|
anyOf: import_v4.z.array(Flag).optional(),
|
|
1254
|
-
noneOf: import_v4.z.array(Flag).optional()
|
|
1273
|
+
noneOf: import_v4.z.array(Flag).optional(),
|
|
1274
|
+
allOf: import_v4.z.array(Flag).optional()
|
|
1255
1275
|
}).meta({
|
|
1256
1276
|
id: "ContainsFlags"
|
|
1257
1277
|
});
|
|
@@ -1408,11 +1428,28 @@ var FieldReference = import_v43.default.object({
|
|
|
1408
1428
|
$$field: FieldId.describe("Id of the field to reference"),
|
|
1409
1429
|
$$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
|
|
1410
1430
|
'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
|
|
1431
|
+
),
|
|
1432
|
+
$$code: import_v43.default.string().optional().describe(
|
|
1433
|
+
"Serialised client-side function body. When present the expression is evaluated rather than dereferenced."
|
|
1434
|
+
)
|
|
1435
|
+
}).describe(
|
|
1436
|
+
"Reference to a field value, with an optional client-side computation applied."
|
|
1437
|
+
);
|
|
1438
|
+
var ComputedDefaultValue = import_v43.default.object({
|
|
1439
|
+
$$code: import_v43.default.string().describe(
|
|
1440
|
+
"Serialised client-side function body. Receives (undefined, context) where context includes $now, $online, and system variables."
|
|
1411
1441
|
)
|
|
1412
|
-
}).describe("
|
|
1442
|
+
}).describe("A context-only computation used as a field default value.");
|
|
1413
1443
|
var ValidationConfig = import_v43.default.object({
|
|
1414
|
-
validator: Conditional
|
|
1415
|
-
|
|
1444
|
+
validator: Conditional.describe(
|
|
1445
|
+
"Conditional expression that must hold for the field value to be considered valid."
|
|
1446
|
+
),
|
|
1447
|
+
message: TranslationConfig.describe(
|
|
1448
|
+
"Error message displayed when the validator does not hold."
|
|
1449
|
+
)
|
|
1450
|
+
}).meta({
|
|
1451
|
+
id: "ValidationConfig",
|
|
1452
|
+
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."
|
|
1416
1453
|
});
|
|
1417
1454
|
var requiredSchema = import_v43.default.union([
|
|
1418
1455
|
import_v43.default.boolean(),
|
|
@@ -1443,7 +1480,7 @@ var BaseField = import_v43.default.object({
|
|
|
1443
1480
|
"Indicates whether the field can be modified during record correction."
|
|
1444
1481
|
),
|
|
1445
1482
|
value: FieldReference.or(import_v43.default.array(FieldReference)).optional().describe(
|
|
1446
|
-
"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."
|
|
1483
|
+
"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."
|
|
1447
1484
|
),
|
|
1448
1485
|
analytics: import_v43.default.boolean().default(false).optional().describe(
|
|
1449
1486
|
"Indicates whether the field is included in analytics. When enabled, its value becomes available in the analytics dashboard."
|
|
@@ -1451,30 +1488,40 @@ var BaseField = import_v43.default.object({
|
|
|
1451
1488
|
}).describe("Common properties shared across all field types.");
|
|
1452
1489
|
var Divider = BaseField.extend({
|
|
1453
1490
|
type: import_v43.default.literal(FieldType.DIVIDER)
|
|
1491
|
+
}).meta({
|
|
1492
|
+
description: "A horizontal line divider",
|
|
1493
|
+
id: "Divider"
|
|
1454
1494
|
});
|
|
1455
1495
|
var TextField = BaseField.extend({
|
|
1456
1496
|
type: import_v43.default.literal(FieldType.TEXT),
|
|
1457
|
-
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
1497
|
+
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
|
|
1458
1498
|
configuration: import_v43.default.object({
|
|
1459
1499
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
|
|
1460
1500
|
type: import_v43.default.enum(["text", "password"]).optional(),
|
|
1461
1501
|
prefix: TranslationConfig.optional(),
|
|
1462
1502
|
postfix: TranslationConfig.optional()
|
|
1463
1503
|
}).default({ type: "text" }).optional()
|
|
1464
|
-
}).
|
|
1504
|
+
}).meta({
|
|
1505
|
+
description: "A text input field",
|
|
1506
|
+
id: "TextField"
|
|
1507
|
+
});
|
|
1465
1508
|
var NumberField = BaseField.extend({
|
|
1466
1509
|
type: import_v43.default.literal(FieldType.NUMBER),
|
|
1467
|
-
defaultValue: NumberFieldValue.optional(),
|
|
1510
|
+
defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
|
|
1468
1511
|
configuration: import_v43.default.object({
|
|
1469
1512
|
min: import_v43.default.number().optional().describe("Minimum value"),
|
|
1470
1513
|
max: import_v43.default.number().optional().describe("Maximum value"),
|
|
1514
|
+
integer: import_v43.default.boolean().optional().describe("When true, only whole numbers are allowed"),
|
|
1471
1515
|
prefix: TranslationConfig.optional(),
|
|
1472
1516
|
postfix: TranslationConfig.optional()
|
|
1473
1517
|
}).optional()
|
|
1474
|
-
}).
|
|
1518
|
+
}).meta({
|
|
1519
|
+
description: "A number input field",
|
|
1520
|
+
id: "NumberField"
|
|
1521
|
+
});
|
|
1475
1522
|
var TextAreaField = BaseField.extend({
|
|
1476
1523
|
type: import_v43.default.literal(FieldType.TEXTAREA),
|
|
1477
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1524
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1478
1525
|
configuration: import_v43.default.object({
|
|
1479
1526
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
|
|
1480
1527
|
rows: import_v43.default.number().optional().describe("Number of visible text lines"),
|
|
@@ -1482,7 +1529,10 @@ var TextAreaField = BaseField.extend({
|
|
|
1482
1529
|
prefix: TranslationConfig.optional(),
|
|
1483
1530
|
postfix: TranslationConfig.optional()
|
|
1484
1531
|
}).default({ rows: 4 }).optional()
|
|
1485
|
-
}).
|
|
1532
|
+
}).meta({
|
|
1533
|
+
description: "A multiline text input",
|
|
1534
|
+
id: "TextAreaField"
|
|
1535
|
+
});
|
|
1486
1536
|
var ImageMimeType = import_v43.default.enum([
|
|
1487
1537
|
"image/png",
|
|
1488
1538
|
"image/jpg",
|
|
@@ -1505,58 +1555,76 @@ var SignatureField = BaseField.extend({
|
|
|
1505
1555
|
signaturePromptLabel: TranslationConfig.describe(
|
|
1506
1556
|
"Title of the signature modal"
|
|
1507
1557
|
),
|
|
1508
|
-
defaultValue:
|
|
1558
|
+
defaultValue: SignatureFieldValue.or(ComputedDefaultValue).optional(),
|
|
1509
1559
|
configuration: import_v43.default.object({
|
|
1510
1560
|
maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
|
|
1511
1561
|
acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature")
|
|
1512
1562
|
}).default({
|
|
1513
1563
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1514
1564
|
})
|
|
1515
|
-
}).
|
|
1565
|
+
}).meta({
|
|
1566
|
+
description: "A signature input field",
|
|
1567
|
+
id: "SignatureField"
|
|
1568
|
+
});
|
|
1516
1569
|
var EmailField = BaseField.extend({
|
|
1517
1570
|
type: import_v43.default.literal(FieldType.EMAIL),
|
|
1518
1571
|
configuration: import_v43.default.object({
|
|
1519
1572
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
|
|
1520
1573
|
}).default({ maxLength: 255 }).optional(),
|
|
1521
|
-
defaultValue: NonEmptyTextValue.optional()
|
|
1574
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional()
|
|
1575
|
+
}).meta({
|
|
1576
|
+
description: "An email input field",
|
|
1577
|
+
id: "EmailField"
|
|
1522
1578
|
});
|
|
1523
1579
|
var DateField = BaseField.extend({
|
|
1524
1580
|
type: import_v43.default.literal(FieldType.DATE),
|
|
1525
|
-
defaultValue: SerializedNowDateTime.or(PlainDate).optional().describe("Default date value(yyyy-MM-dd)"),
|
|
1581
|
+
defaultValue: SerializedNowDateTime.or(PlainDate).or(ComputedDefaultValue).optional().describe("Default date value(yyyy-MM-dd)"),
|
|
1526
1582
|
configuration: import_v43.default.object({
|
|
1527
1583
|
notice: TranslationConfig.describe(
|
|
1528
1584
|
"Text to display above the date input"
|
|
1529
1585
|
).optional()
|
|
1530
1586
|
}).optional()
|
|
1531
|
-
}).
|
|
1587
|
+
}).meta({
|
|
1588
|
+
description: "A date input (yyyy-MM-dd)",
|
|
1589
|
+
id: "DateField"
|
|
1590
|
+
});
|
|
1532
1591
|
var AgeField = BaseField.extend({
|
|
1533
1592
|
type: import_v43.default.literal(FieldType.AGE),
|
|
1534
|
-
defaultValue: NumberFieldValue.optional(),
|
|
1593
|
+
defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
|
|
1535
1594
|
configuration: import_v43.default.object({
|
|
1536
1595
|
asOfDate: FieldReference,
|
|
1537
1596
|
prefix: TranslationConfig.optional(),
|
|
1538
1597
|
postfix: TranslationConfig.optional()
|
|
1539
1598
|
})
|
|
1540
|
-
}).
|
|
1599
|
+
}).meta({
|
|
1600
|
+
description: "An age input field which uses the current date as the asOfDate",
|
|
1601
|
+
id: "AgeField"
|
|
1602
|
+
});
|
|
1541
1603
|
var TimeField = BaseField.extend({
|
|
1542
1604
|
type: import_v43.default.literal(FieldType.TIME),
|
|
1543
|
-
defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
|
|
1605
|
+
defaultValue: SerializedNowDateTime.or(TimeValue).or(ComputedDefaultValue).optional().describe("Default time value (HH-mm)"),
|
|
1544
1606
|
configuration: import_v43.default.object({
|
|
1545
1607
|
use12HourFormat: import_v43.default.boolean().optional().describe("Whether to use 12-hour format"),
|
|
1546
1608
|
notice: TranslationConfig.describe(
|
|
1547
1609
|
"Text to display above the time input"
|
|
1548
1610
|
).optional()
|
|
1549
1611
|
}).optional()
|
|
1550
|
-
}).
|
|
1612
|
+
}).meta({
|
|
1613
|
+
description: "A single time input (HH-mm)",
|
|
1614
|
+
id: "TimeField"
|
|
1615
|
+
});
|
|
1551
1616
|
var DateRangeField = BaseField.extend({
|
|
1552
1617
|
type: import_v43.default.literal(FieldType.DATE_RANGE),
|
|
1553
|
-
defaultValue: DateRangeFieldValue.optional(),
|
|
1618
|
+
defaultValue: DateRangeFieldValue.or(ComputedDefaultValue).optional(),
|
|
1554
1619
|
configuration: import_v43.default.object({
|
|
1555
1620
|
notice: TranslationConfig.describe(
|
|
1556
1621
|
"Text to display above the date input"
|
|
1557
1622
|
).optional()
|
|
1558
1623
|
}).optional()
|
|
1559
|
-
}).
|
|
1624
|
+
}).meta({
|
|
1625
|
+
description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
|
|
1626
|
+
id: "DateRangeField"
|
|
1627
|
+
});
|
|
1560
1628
|
var HtmlFontVariant = import_v43.default.enum([
|
|
1561
1629
|
"reg12",
|
|
1562
1630
|
"reg14",
|
|
@@ -1600,21 +1668,33 @@ var ImageViewField = BaseField.extend({
|
|
|
1600
1668
|
type: import_v43.default.literal(FieldType.IMAGE_VIEW),
|
|
1601
1669
|
defaultValue: NonEmptyTextValue.optional(),
|
|
1602
1670
|
configuration: ImageConfiguration
|
|
1603
|
-
}).
|
|
1671
|
+
}).meta({
|
|
1672
|
+
description: "A read-only image component for form pages",
|
|
1673
|
+
id: "ImageViewField"
|
|
1674
|
+
});
|
|
1604
1675
|
var Paragraph = BaseField.extend({
|
|
1605
1676
|
type: import_v43.default.literal(FieldType.PARAGRAPH),
|
|
1606
1677
|
configuration: ParagraphConfiguration
|
|
1607
|
-
}).
|
|
1678
|
+
}).meta({
|
|
1679
|
+
description: "A read-only HTML <p> paragraph",
|
|
1680
|
+
id: "Paragraph"
|
|
1681
|
+
});
|
|
1608
1682
|
var Heading = BaseField.extend({
|
|
1609
1683
|
type: import_v43.default.literal(FieldType.HEADING),
|
|
1610
1684
|
configuration: HeadingConfiguration
|
|
1611
|
-
}).
|
|
1685
|
+
}).meta({
|
|
1686
|
+
description: "A read-only heading component for form pages",
|
|
1687
|
+
id: "Heading"
|
|
1688
|
+
});
|
|
1612
1689
|
var PageHeader = BaseField.extend({
|
|
1613
1690
|
type: import_v43.default.literal(FieldType.PAGE_HEADER)
|
|
1614
|
-
}).
|
|
1691
|
+
}).meta({
|
|
1692
|
+
description: "A read-only header component for form pages",
|
|
1693
|
+
id: "PageHeader"
|
|
1694
|
+
});
|
|
1615
1695
|
var File = BaseField.extend({
|
|
1616
1696
|
type: import_v43.default.literal(FieldType.FILE),
|
|
1617
|
-
defaultValue: FileFieldValue.optional(),
|
|
1697
|
+
defaultValue: FileFieldValue.or(ComputedDefaultValue).optional(),
|
|
1618
1698
|
configuration: import_v43.default.object({
|
|
1619
1699
|
maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
|
|
1620
1700
|
acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature"),
|
|
@@ -1630,7 +1710,10 @@ var File = BaseField.extend({
|
|
|
1630
1710
|
}).default({
|
|
1631
1711
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1632
1712
|
})
|
|
1633
|
-
}).
|
|
1713
|
+
}).meta({
|
|
1714
|
+
description: "A file upload field",
|
|
1715
|
+
id: "File"
|
|
1716
|
+
});
|
|
1634
1717
|
var SelectOption = import_v43.default.object({
|
|
1635
1718
|
value: import_v43.default.string().describe("The value of the option"),
|
|
1636
1719
|
label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
|
|
@@ -1638,7 +1721,7 @@ var SelectOption = import_v43.default.object({
|
|
|
1638
1721
|
});
|
|
1639
1722
|
var NumberWithUnitField = BaseField.extend({
|
|
1640
1723
|
type: import_v43.default.literal(FieldType.NUMBER_WITH_UNIT),
|
|
1641
|
-
defaultValue: NumberWithUnitFieldValue.optional(),
|
|
1724
|
+
defaultValue: NumberWithUnitFieldValue.or(ComputedDefaultValue).optional(),
|
|
1642
1725
|
options: import_v43.default.array(SelectOption).describe("A list of options for the unit select"),
|
|
1643
1726
|
configuration: import_v43.default.object({
|
|
1644
1727
|
min: import_v43.default.number().optional().describe("Minimum value of the number field"),
|
|
@@ -1647,17 +1730,23 @@ var NumberWithUnitField = BaseField.extend({
|
|
|
1647
1730
|
"Placeholder for the number field"
|
|
1648
1731
|
)
|
|
1649
1732
|
}).optional()
|
|
1650
|
-
}).
|
|
1733
|
+
}).meta({
|
|
1734
|
+
description: "A number with unit input field",
|
|
1735
|
+
id: "NumberWithUnitField"
|
|
1736
|
+
});
|
|
1651
1737
|
var RadioGroup = BaseField.extend({
|
|
1652
1738
|
type: import_v43.default.literal(FieldType.RADIO_GROUP),
|
|
1653
|
-
defaultValue: TextValue.optional(),
|
|
1739
|
+
defaultValue: TextValue.or(ComputedDefaultValue).optional(),
|
|
1654
1740
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
1655
1741
|
configuration: import_v43.default.object({
|
|
1656
1742
|
styles: import_v43.default.object({
|
|
1657
1743
|
size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
|
|
1658
1744
|
}).optional()
|
|
1659
1745
|
}).optional()
|
|
1660
|
-
}).
|
|
1746
|
+
}).meta({
|
|
1747
|
+
description: "A grouped radio button field",
|
|
1748
|
+
id: "RadioGroup"
|
|
1749
|
+
});
|
|
1661
1750
|
var BulletList = BaseField.extend({
|
|
1662
1751
|
type: import_v43.default.literal(FieldType.BULLET_LIST),
|
|
1663
1752
|
items: import_v43.default.array(TranslationConfig).describe("A list of items"),
|
|
@@ -1666,10 +1755,13 @@ var BulletList = BaseField.extend({
|
|
|
1666
1755
|
fontVariant: HtmlFontVariant.optional()
|
|
1667
1756
|
}).optional()
|
|
1668
1757
|
}).default({})
|
|
1669
|
-
}).
|
|
1758
|
+
}).meta({
|
|
1759
|
+
description: "A list of bullet points",
|
|
1760
|
+
id: "BulletList"
|
|
1761
|
+
});
|
|
1670
1762
|
var Select = BaseField.extend({
|
|
1671
1763
|
type: import_v43.default.literal(FieldType.SELECT),
|
|
1672
|
-
defaultValue: TextValue.optional(),
|
|
1764
|
+
defaultValue: TextValue.or(ComputedDefaultValue).optional(),
|
|
1673
1765
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
1674
1766
|
noOptionsMessage: TranslationConfig.optional().describe(
|
|
1675
1767
|
`
|
|
@@ -1681,16 +1773,22 @@ var Select = BaseField.extend({
|
|
|
1681
1773
|
{ ..., defaultMessage: "'{input}' is not listed among the health facilities." }
|
|
1682
1774
|
`
|
|
1683
1775
|
)
|
|
1684
|
-
}).
|
|
1776
|
+
}).meta({
|
|
1777
|
+
description: "A select input field",
|
|
1778
|
+
id: "Select"
|
|
1779
|
+
});
|
|
1685
1780
|
var SelectDateRangeOption = import_v43.default.object({
|
|
1686
1781
|
value: SelectDateRangeValue.describe("The value of the option"),
|
|
1687
1782
|
label: TranslationConfig.describe("The label of the option")
|
|
1688
1783
|
});
|
|
1689
1784
|
var SelectDateRangeField = BaseField.extend({
|
|
1690
1785
|
type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
|
|
1691
|
-
defaultValue: SelectDateRangeValue.optional(),
|
|
1786
|
+
defaultValue: SelectDateRangeValue.or(ComputedDefaultValue).optional(),
|
|
1692
1787
|
options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
|
|
1693
|
-
}).
|
|
1788
|
+
}).meta({
|
|
1789
|
+
description: "A date range selection field",
|
|
1790
|
+
id: "SelectDateRangeField"
|
|
1791
|
+
});
|
|
1694
1792
|
var NameConfig = import_v43.default.object({
|
|
1695
1793
|
firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
1696
1794
|
middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
@@ -1702,7 +1800,7 @@ var NameField = BaseField.extend({
|
|
|
1702
1800
|
firstname: SerializedUserField.or(NonEmptyTextValue).optional(),
|
|
1703
1801
|
middlename: SerializedUserField.or(NonEmptyTextValue).optional(),
|
|
1704
1802
|
surname: SerializedUserField.or(NonEmptyTextValue).optional()
|
|
1705
|
-
}).optional(),
|
|
1803
|
+
}).or(ComputedDefaultValue).optional(),
|
|
1706
1804
|
configuration: import_v43.default.object({
|
|
1707
1805
|
name: NameConfig.default({
|
|
1708
1806
|
firstname: { required: true },
|
|
@@ -1721,26 +1819,41 @@ var NameField = BaseField.extend({
|
|
|
1721
1819
|
surname: { required: true }
|
|
1722
1820
|
}
|
|
1723
1821
|
}).optional()
|
|
1724
|
-
}).
|
|
1822
|
+
}).meta({
|
|
1823
|
+
description: "A field for entering a persons name",
|
|
1824
|
+
id: "NameField"
|
|
1825
|
+
});
|
|
1725
1826
|
var PhoneField = BaseField.extend({
|
|
1726
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1827
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1727
1828
|
type: import_v43.default.literal(FieldType.PHONE)
|
|
1728
|
-
}).
|
|
1829
|
+
}).meta({
|
|
1830
|
+
description: "A field for entering a phone number",
|
|
1831
|
+
id: "PhoneField"
|
|
1832
|
+
});
|
|
1729
1833
|
var IdField = BaseField.extend({
|
|
1730
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1834
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1731
1835
|
type: import_v43.default.literal(FieldType.ID)
|
|
1732
|
-
}).
|
|
1836
|
+
}).meta({
|
|
1837
|
+
description: "A field for entering an ID",
|
|
1838
|
+
id: "IdField"
|
|
1839
|
+
});
|
|
1733
1840
|
var Checkbox = BaseField.extend({
|
|
1734
1841
|
type: import_v43.default.literal(FieldType.CHECKBOX),
|
|
1735
|
-
defaultValue: CheckboxFieldValue.default(false)
|
|
1736
|
-
}).
|
|
1842
|
+
defaultValue: CheckboxFieldValue.or(ComputedDefaultValue).default(false)
|
|
1843
|
+
}).meta({
|
|
1844
|
+
description: "A boolean checkbox field",
|
|
1845
|
+
id: "Checkbox"
|
|
1846
|
+
});
|
|
1737
1847
|
var Country = BaseField.extend({
|
|
1738
1848
|
type: import_v43.default.literal(FieldType.COUNTRY),
|
|
1739
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1849
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1740
1850
|
optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
|
|
1741
1851
|
"Conditionals for specific countries. Countries not listed are always shown and enabled."
|
|
1742
1852
|
)
|
|
1743
|
-
}).
|
|
1853
|
+
}).meta({
|
|
1854
|
+
description: "A field for selecting a country",
|
|
1855
|
+
id: "Country"
|
|
1856
|
+
});
|
|
1744
1857
|
var AllowedLocations = JurisdictionReference.optional().describe(
|
|
1745
1858
|
"Limits which location options are selectable depending on user jurisdiction and location."
|
|
1746
1859
|
);
|
|
@@ -1749,28 +1862,33 @@ var AdministrativeAreas = import_v43.default.enum([
|
|
|
1749
1862
|
"HEALTH_FACILITY",
|
|
1750
1863
|
"CRVS_OFFICE"
|
|
1751
1864
|
]);
|
|
1752
|
-
var AdministrativeAreaConfiguration = import_v43.default.object({
|
|
1753
|
-
partOf: FieldReference.optional().describe("Parent location"),
|
|
1754
|
-
type: AdministrativeAreas,
|
|
1755
|
-
allowedLocations: AllowedLocations
|
|
1756
|
-
}).describe("Administrative area options");
|
|
1757
1865
|
var AdministrativeAreaField = BaseField.extend({
|
|
1758
1866
|
type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
|
|
1759
|
-
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
1760
|
-
configuration:
|
|
1761
|
-
|
|
1867
|
+
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
|
|
1868
|
+
configuration: import_v43.default.object({
|
|
1869
|
+
partOf: FieldReference.optional().describe("Parent location"),
|
|
1870
|
+
type: AdministrativeAreas,
|
|
1871
|
+
allowedLocations: AllowedLocations
|
|
1872
|
+
}).describe("Administrative area options")
|
|
1873
|
+
}).meta({
|
|
1874
|
+
description: "Administrative area input field",
|
|
1875
|
+
id: "AdministrativeAreaField"
|
|
1876
|
+
});
|
|
1762
1877
|
var LocationInput = BaseField.extend({
|
|
1763
1878
|
type: import_v43.default.literal(FieldType.LOCATION),
|
|
1764
|
-
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
1879
|
+
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
|
|
1765
1880
|
configuration: import_v43.default.object({
|
|
1766
1881
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
1767
1882
|
allowedLocations: AllowedLocations
|
|
1768
1883
|
}).optional()
|
|
1769
|
-
}).
|
|
1884
|
+
}).meta({
|
|
1885
|
+
description: "A field for selecting a location",
|
|
1886
|
+
id: "LocationInput"
|
|
1887
|
+
});
|
|
1770
1888
|
var FileUploadWithOptions = BaseField.extend({
|
|
1771
1889
|
type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
|
|
1772
1890
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
1773
|
-
defaultValue: FileFieldWithOptionValue.optional(),
|
|
1891
|
+
defaultValue: FileFieldWithOptionValue.or(ComputedDefaultValue).optional(),
|
|
1774
1892
|
configuration: import_v43.default.object({
|
|
1775
1893
|
maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
|
|
1776
1894
|
maxImageSize: import_v43.default.object({
|
|
@@ -1780,15 +1898,18 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
1780
1898
|
}).default({
|
|
1781
1899
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
1782
1900
|
})
|
|
1901
|
+
}).meta({
|
|
1902
|
+
description: "A field for uploading files with file type options",
|
|
1903
|
+
id: "FileUploadWithOptions"
|
|
1783
1904
|
});
|
|
1784
1905
|
var Facility = BaseField.extend({
|
|
1785
1906
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
1786
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1907
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1787
1908
|
configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
|
|
1788
1909
|
}).describe("Input field for a facility");
|
|
1789
1910
|
var Office = BaseField.extend({
|
|
1790
1911
|
type: import_v43.default.literal(FieldType.OFFICE),
|
|
1791
|
-
defaultValue: NonEmptyTextValue.optional(),
|
|
1912
|
+
defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
|
|
1792
1913
|
configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
|
|
1793
1914
|
}).describe("Input field for an office");
|
|
1794
1915
|
var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
|
|
@@ -1824,8 +1945,11 @@ var Address = BaseField.extend({
|
|
|
1824
1945
|
).optional(),
|
|
1825
1946
|
allowedLocations: AllowedLocations
|
|
1826
1947
|
}).optional(),
|
|
1827
|
-
defaultValue: DefaultAddressFieldValue.optional()
|
|
1828
|
-
}).
|
|
1948
|
+
defaultValue: DefaultAddressFieldValue.or(ComputedDefaultValue).optional()
|
|
1949
|
+
}).meta({
|
|
1950
|
+
description: "Address input field \u2013 a combination of location and text fields",
|
|
1951
|
+
id: "Address"
|
|
1952
|
+
});
|
|
1829
1953
|
var StaticDataEntry = import_v43.default.object({
|
|
1830
1954
|
id: import_v43.default.string().describe("ID for the data entry."),
|
|
1831
1955
|
label: TranslationConfig,
|
|
@@ -1840,7 +1964,10 @@ var DataField = BaseField.extend({
|
|
|
1840
1964
|
subtitle: TranslationConfig.optional(),
|
|
1841
1965
|
data: import_v43.default.array(DataEntry)
|
|
1842
1966
|
})
|
|
1843
|
-
}).
|
|
1967
|
+
}).meta({
|
|
1968
|
+
description: "A field for displaying a table of read-only data",
|
|
1969
|
+
id: "DataField"
|
|
1970
|
+
});
|
|
1844
1971
|
var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
|
|
1845
1972
|
var ButtonType = import_v43.default.enum([
|
|
1846
1973
|
"primary",
|
|
@@ -1865,13 +1992,19 @@ var ButtonConfiguration = import_v43.default.object({
|
|
|
1865
1992
|
});
|
|
1866
1993
|
var ButtonField = BaseField.extend({
|
|
1867
1994
|
type: import_v43.default.literal(FieldType.BUTTON),
|
|
1868
|
-
defaultValue: ButtonFieldValue.optional(),
|
|
1995
|
+
defaultValue: ButtonFieldValue.or(ComputedDefaultValue).optional(),
|
|
1869
1996
|
configuration: ButtonConfiguration
|
|
1870
|
-
}).
|
|
1997
|
+
}).meta({
|
|
1998
|
+
description: "A generic button that can be used to trigger an action",
|
|
1999
|
+
id: "ButtonField"
|
|
2000
|
+
});
|
|
1871
2001
|
var FieldGroup = BaseField.extend({
|
|
1872
2002
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
1873
2003
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
1874
2004
|
fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
|
|
2005
|
+
}).meta({
|
|
2006
|
+
description: "A group of fields that are displayed together",
|
|
2007
|
+
id: "FieldGroup"
|
|
1875
2008
|
});
|
|
1876
2009
|
var AlphaPrintButton = BaseField.extend({
|
|
1877
2010
|
type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
|
|
@@ -1881,10 +2014,13 @@ var AlphaPrintButton = BaseField.extend({
|
|
|
1881
2014
|
"Label for the print button"
|
|
1882
2015
|
)
|
|
1883
2016
|
})
|
|
1884
|
-
}).
|
|
2017
|
+
}).meta({
|
|
2018
|
+
description: "An experimental print button field for printing certificates during the declaration process",
|
|
2019
|
+
id: "AlphaPrintButton"
|
|
2020
|
+
});
|
|
1885
2021
|
var HttpField = BaseField.extend({
|
|
1886
2022
|
type: import_v43.default.literal(FieldType.HTTP),
|
|
1887
|
-
defaultValue: HttpFieldValue.optional(),
|
|
2023
|
+
defaultValue: HttpFieldValue.or(ComputedDefaultValue).optional(),
|
|
1888
2024
|
configuration: import_v43.default.object({
|
|
1889
2025
|
trigger: FieldReference.optional().describe(
|
|
1890
2026
|
"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."
|
|
@@ -1897,20 +2033,30 @@ var HttpField = BaseField.extend({
|
|
|
1897
2033
|
params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
|
|
1898
2034
|
timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
|
|
1899
2035
|
})
|
|
1900
|
-
}).
|
|
2036
|
+
}).meta({
|
|
2037
|
+
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.",
|
|
2038
|
+
id: "HttpField"
|
|
2039
|
+
});
|
|
1901
2040
|
var AutocompleteField = BaseField.extend({
|
|
1902
2041
|
type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
|
|
1903
2042
|
configuration: import_v43.default.object({
|
|
1904
|
-
url: import_v43.default.string().describe(
|
|
2043
|
+
url: import_v43.default.string().describe(
|
|
2044
|
+
"URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
|
|
2045
|
+
).optional(),
|
|
1905
2046
|
method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
|
|
1906
2047
|
defaultOptions: import_v43.default.array(
|
|
1907
2048
|
import_v43.default.object({
|
|
1908
2049
|
label: import_v43.default.string(),
|
|
1909
2050
|
value: import_v43.default.string()
|
|
1910
2051
|
})
|
|
1911
|
-
).optional()
|
|
2052
|
+
).optional().describe(
|
|
2053
|
+
"Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
|
|
2054
|
+
)
|
|
1912
2055
|
})
|
|
1913
|
-
}).
|
|
2056
|
+
}).meta({
|
|
2057
|
+
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.",
|
|
2058
|
+
id: "AutocompleteField"
|
|
2059
|
+
});
|
|
1914
2060
|
var SearchField = HttpField.extend({
|
|
1915
2061
|
type: import_v43.default.literal(FieldType.SEARCH),
|
|
1916
2062
|
configuration: SearchQuery.pick({
|
|
@@ -1943,6 +2089,9 @@ var SearchField = HttpField.extend({
|
|
|
1943
2089
|
ok: TranslationConfig.optional()
|
|
1944
2090
|
}).optional()
|
|
1945
2091
|
})
|
|
2092
|
+
}).meta({
|
|
2093
|
+
description: "A search input field",
|
|
2094
|
+
id: "SearchField"
|
|
1946
2095
|
});
|
|
1947
2096
|
var LinkButtonField = BaseField.extend({
|
|
1948
2097
|
type: import_v43.default.literal(FieldType.LINK_BUTTON),
|
|
@@ -1951,28 +2100,35 @@ var LinkButtonField = BaseField.extend({
|
|
|
1951
2100
|
text: TranslationConfig.describe("Text to display on the button"),
|
|
1952
2101
|
icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
|
|
1953
2102
|
})
|
|
1954
|
-
}).
|
|
2103
|
+
}).meta({
|
|
2104
|
+
description: "A button that opens a URL link",
|
|
2105
|
+
id: "LinkButtonField"
|
|
2106
|
+
});
|
|
1955
2107
|
var VerificationStatus = BaseField.extend({
|
|
1956
2108
|
type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
|
|
1957
|
-
defaultValue: VerificationStatusValue.optional(),
|
|
2109
|
+
defaultValue: VerificationStatusValue.or(ComputedDefaultValue).optional(),
|
|
1958
2110
|
configuration: import_v43.default.object({
|
|
1959
2111
|
status: TranslationConfig.describe("Text to display on the status pill."),
|
|
1960
2112
|
description: TranslationConfig.describe(
|
|
1961
2113
|
"Explaining text on the banner in form."
|
|
1962
2114
|
)
|
|
1963
2115
|
})
|
|
2116
|
+
}).meta({
|
|
2117
|
+
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.",
|
|
2118
|
+
id: "VerificationStatus"
|
|
1964
2119
|
});
|
|
1965
2120
|
var QueryParamReaderField = BaseField.extend({
|
|
1966
2121
|
type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
|
|
1967
2122
|
configuration: import_v43.default.object({
|
|
1968
2123
|
pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
|
|
1969
2124
|
})
|
|
1970
|
-
}).
|
|
1971
|
-
"A field that maps URL query params into form values and clears them afterward"
|
|
1972
|
-
|
|
2125
|
+
}).meta({
|
|
2126
|
+
description: "A field that maps URL query params into form values and clears them afterward",
|
|
2127
|
+
id: "QueryParamReaderField"
|
|
2128
|
+
});
|
|
1973
2129
|
var QrReaderField = BaseField.extend({
|
|
1974
2130
|
type: import_v43.default.literal(FieldType.QR_READER),
|
|
1975
|
-
defaultValue: QrReaderFieldValue.optional(),
|
|
2131
|
+
defaultValue: QrReaderFieldValue.or(ComputedDefaultValue).optional(),
|
|
1976
2132
|
configuration: import_v43.default.object({
|
|
1977
2133
|
validator: import_v43.default.any().meta({
|
|
1978
2134
|
description: "JSON Schema to validate the scanned QR code data against before populating the form fields.",
|
|
@@ -1980,21 +2136,27 @@ var QrReaderField = BaseField.extend({
|
|
|
1980
2136
|
})
|
|
1981
2137
|
}).optional()
|
|
1982
2138
|
}).meta({
|
|
1983
|
-
description: "
|
|
2139
|
+
description: "QR code reader field, including optional JSON Schema validator.",
|
|
1984
2140
|
id: "QrReaderField"
|
|
1985
2141
|
});
|
|
1986
2142
|
var IdReaderField = BaseField.extend({
|
|
1987
2143
|
type: import_v43.default.literal(FieldType.ID_READER),
|
|
1988
|
-
defaultValue: IdReaderFieldValue.optional(),
|
|
2144
|
+
defaultValue: IdReaderFieldValue.or(ComputedDefaultValue).optional(),
|
|
1989
2145
|
methods: import_v43.default.array(
|
|
1990
2146
|
import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
|
|
1991
2147
|
)
|
|
2148
|
+
}).meta({
|
|
2149
|
+
description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
|
|
2150
|
+
id: "IdReaderField"
|
|
1992
2151
|
});
|
|
1993
2152
|
var CustomField = BaseField.extend({
|
|
1994
2153
|
type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
|
|
1995
2154
|
defaultValue: CustomFieldValue.optional(),
|
|
1996
2155
|
src: import_v43.default.string().describe("Module source path for the custom field component"),
|
|
1997
2156
|
configuration: import_v43.default.unknown().optional()
|
|
2157
|
+
}).meta({
|
|
2158
|
+
description: "An expiremental custom field that is defined by a module source path",
|
|
2159
|
+
id: "CustomField"
|
|
1998
2160
|
});
|
|
1999
2161
|
var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
|
|
2000
2162
|
var LoaderField = BaseField.extend({
|
|
@@ -2004,22 +2166,25 @@ var LoaderField = BaseField.extend({
|
|
|
2004
2166
|
configuration: import_v43.default.object({
|
|
2005
2167
|
text: TranslationConfig.describe("Display text above the loading spinner")
|
|
2006
2168
|
})
|
|
2007
|
-
}).
|
|
2008
|
-
"A non-interactive field that indicates an in progress operation in form"
|
|
2009
|
-
|
|
2169
|
+
}).meta({
|
|
2170
|
+
description: "A non-interactive field that indicates an in progress operation in form",
|
|
2171
|
+
id: "LoaderField"
|
|
2172
|
+
});
|
|
2010
2173
|
var HiddenField = BaseField.extend({
|
|
2011
2174
|
type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
|
|
2012
2175
|
required: import_v43.default.boolean().default(false).optional(),
|
|
2013
2176
|
defaultValue: TextValue.optional()
|
|
2014
|
-
}).
|
|
2015
|
-
"A non-interactive, hidden field that only hold a value in the form"
|
|
2016
|
-
|
|
2177
|
+
}).meta({
|
|
2178
|
+
description: "A non-interactive, hidden field that only hold a value in the form",
|
|
2179
|
+
id: "HiddenField"
|
|
2180
|
+
});
|
|
2017
2181
|
var UserRoleField = BaseField.extend({
|
|
2018
2182
|
type: import_v43.default.literal(FieldType.USER_ROLE),
|
|
2019
2183
|
defaultValue: TextValue.optional()
|
|
2020
|
-
}).
|
|
2021
|
-
"A select dropdown that is automatically populated with available user roles"
|
|
2022
|
-
|
|
2184
|
+
}).meta({
|
|
2185
|
+
description: "A select dropdown that is automatically populated with available user roles",
|
|
2186
|
+
id: "UserRoleField"
|
|
2187
|
+
});
|
|
2023
2188
|
var FieldConfig = import_v43.default.discriminatedUnion("type", [
|
|
2024
2189
|
FieldGroup,
|
|
2025
2190
|
Address,
|
|
@@ -2137,6 +2302,7 @@ var ClientConfig = z20.object({
|
|
|
2137
2302
|
COUNTRY: z20.string(),
|
|
2138
2303
|
LANGUAGES: z20.array(z20.string()),
|
|
2139
2304
|
SENTRY: z20.string().optional(),
|
|
2305
|
+
LOGIN_URL: z20.string().optional(),
|
|
2140
2306
|
REGISTER_BACKGROUND: BackgroundConfig,
|
|
2141
2307
|
DASHBOARDS: z20.array(
|
|
2142
2308
|
z20.object({
|