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