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