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