@opencrvs/toolkit 2.0.0-rc.086745c → 2.0.0-rc.0a2e52b
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 +73 -0
- package/create-countryconfig/package.json +11 -0
- package/dist/application-config/index.js +223 -88
- package/dist/cli.js +507 -171
- package/dist/commons/api/router.d.ts +3322 -268
- package/dist/commons/conditionals/conditionals.d.ts +3 -3
- package/dist/commons/conditionals/validate.d.ts +1 -0
- package/dist/commons/events/ActionInput.d.ts +108 -0
- package/dist/commons/events/Draft.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 +5 -0
- package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
- 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/index.d.ts +0 -4
- package/dist/commons/events/state/utils.d.ts +0 -2
- package/dist/commons/events/utils.d.ts +1 -1
- package/dist/conditionals/index.js +8 -4
- package/dist/events/index.js +346 -148
- package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
- package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +60 -35
- 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 +505 -169
- package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
- package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +90 -1
- 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 +278 -118
- package/dist/scopes/index.d.ts +6 -1
- package/dist/scopes/index.js +8 -4
- package/opencrvs-toolkit-2.0.0-rc.0a2e52b.tgz +0 -0
- package/package.json +1 -1
- package/tsconfig.tsbuildinfo +1 -1
- package/opencrvs-toolkit-2.0.0-rc.086745c.tgz +0 -0
package/dist/events/index.js
CHANGED
|
@@ -302,12 +302,13 @@ __export(events_exports, {
|
|
|
302
302
|
getActionConfig: () => getActionConfig,
|
|
303
303
|
getActionReview: () => getActionReview,
|
|
304
304
|
getActionReviewFields: () => getActionReviewFields,
|
|
305
|
+
getAdministrativeAreaHierarchy: () => getAdministrativeAreaHierarchy,
|
|
305
306
|
getAllUniqueFields: () => getAllUniqueFields,
|
|
306
307
|
getAnnotationFromDrafts: () => getAnnotationFromDrafts,
|
|
307
308
|
getAssignedUserFromActions: () => getAssignedUserFromActions,
|
|
308
|
-
getAssignedUserSignatureFromActions: () => getAssignedUserSignatureFromActions,
|
|
309
309
|
getAssignmentStatus: () => getAssignmentStatus,
|
|
310
310
|
getAvailableActionsForEvent: () => getAvailableActionsForEvent,
|
|
311
|
+
getAvailableRolesForUserUpdatePayload: () => getAvailableRolesForUserUpdatePayload,
|
|
311
312
|
getCompleteActionAnnotation: () => getCompleteActionAnnotation,
|
|
312
313
|
getCompleteActionDeclaration: () => getCompleteActionDeclaration,
|
|
313
314
|
getCurrentEventState: () => getCurrentEventState,
|
|
@@ -318,6 +319,7 @@ __export(events_exports, {
|
|
|
318
319
|
getDeclarationPages: () => getDeclarationPages,
|
|
319
320
|
getEventConfigById: () => getEventConfigById,
|
|
320
321
|
getFilePathsFromEvent: () => getFilePathsFromEvent,
|
|
322
|
+
getLocationHierarchy: () => getLocationHierarchy,
|
|
321
323
|
getMixedPath: () => getMixedPath,
|
|
322
324
|
getPendingAction: () => getPendingAction,
|
|
323
325
|
getPrintCertificatePages: () => getPrintCertificatePages,
|
|
@@ -607,12 +609,14 @@ var SystemScopeType = z2.enum([
|
|
|
607
609
|
"organisation.read-locations",
|
|
608
610
|
"user.read",
|
|
609
611
|
"user.create",
|
|
610
|
-
"user.edit"
|
|
612
|
+
"user.edit",
|
|
613
|
+
"user.search"
|
|
611
614
|
]);
|
|
612
615
|
var UserScopeType = SystemScopeType.extract([
|
|
613
616
|
"user.read",
|
|
614
617
|
"user.create",
|
|
615
|
-
"user.edit"
|
|
618
|
+
"user.edit",
|
|
619
|
+
"user.search"
|
|
616
620
|
]);
|
|
617
621
|
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
618
622
|
var UserScopeV2 = z2.discriminatedUnion("type", [
|
|
@@ -621,7 +625,7 @@ var UserScopeV2 = z2.discriminatedUnion("type", [
|
|
|
621
625
|
options: AllUserScopeOptions.optional()
|
|
622
626
|
}),
|
|
623
627
|
z2.object({
|
|
624
|
-
type: UserScopeType.extract(["user.read"]),
|
|
628
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
625
629
|
options: AccessLevelOptions.optional()
|
|
626
630
|
})
|
|
627
631
|
]);
|
|
@@ -700,7 +704,9 @@ var decodeScope = (query) => {
|
|
|
700
704
|
};
|
|
701
705
|
var DEFAULT_SCOPE_OPTIONS = {
|
|
702
706
|
placeOfEvent: JurisdictionFilter.enum.all,
|
|
703
|
-
accessLevel: JurisdictionFilter.enum.all
|
|
707
|
+
accessLevel: JurisdictionFilter.enum.all,
|
|
708
|
+
registeredIn: JurisdictionFilter.enum.all,
|
|
709
|
+
declaredIn: JurisdictionFilter.enum.all
|
|
704
710
|
};
|
|
705
711
|
function getAcceptedScopesByType({
|
|
706
712
|
acceptedScopes,
|
|
@@ -1073,7 +1079,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
|
|
|
1073
1079
|
ShowConditional,
|
|
1074
1080
|
// Action can be shown to the user in the list but as disabled
|
|
1075
1081
|
EnableConditional
|
|
1076
|
-
])
|
|
1082
|
+
]).meta({
|
|
1083
|
+
id: "ActionConditional",
|
|
1084
|
+
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."
|
|
1085
|
+
});
|
|
1077
1086
|
var DisplayOnReviewConditional = z7.object({
|
|
1078
1087
|
type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
|
|
1079
1088
|
conditional: Conditional
|
|
@@ -1088,8 +1097,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
|
|
|
1088
1097
|
// Field output can be shown / hidden on the review page
|
|
1089
1098
|
DisplayOnReviewConditional
|
|
1090
1099
|
]).meta({
|
|
1091
|
-
|
|
1092
|
-
|
|
1100
|
+
id: "FieldConditional",
|
|
1101
|
+
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."
|
|
1093
1102
|
});
|
|
1094
1103
|
|
|
1095
1104
|
// ../commons/src/events/FieldType.ts
|
|
@@ -1409,28 +1418,20 @@ function schemaPriority(schema) {
|
|
|
1409
1418
|
return idx === -1 ? 9999 : idx;
|
|
1410
1419
|
}
|
|
1411
1420
|
function safeUnion(schemas) {
|
|
1421
|
+
const sortedSchemas = [...schemas].sort(
|
|
1422
|
+
(a, b) => schemaPriority(a) - schemaPriority(b)
|
|
1423
|
+
);
|
|
1412
1424
|
return z12.any().superRefine((val, ctx) => {
|
|
1413
|
-
const
|
|
1414
|
-
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
if (successful.length === 0) {
|
|
1418
|
-
ctx.addIssue({
|
|
1419
|
-
code: "invalid_type",
|
|
1420
|
-
expected: "custom",
|
|
1421
|
-
message: "Value does not match any schema"
|
|
1422
|
-
});
|
|
1423
|
-
return;
|
|
1424
|
-
}
|
|
1425
|
-
successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
|
|
1426
|
-
const best = successful[0];
|
|
1427
|
-
if (!best.safeParse(val).success) {
|
|
1428
|
-
ctx.addIssue({
|
|
1429
|
-
expected: "custom",
|
|
1430
|
-
code: "invalid_type",
|
|
1431
|
-
message: "Value did not match the best schema"
|
|
1432
|
-
});
|
|
1425
|
+
for (const schema of sortedSchemas) {
|
|
1426
|
+
if (schema.safeParse(val).success) {
|
|
1427
|
+
return;
|
|
1428
|
+
}
|
|
1433
1429
|
}
|
|
1430
|
+
ctx.addIssue({
|
|
1431
|
+
code: "invalid_type",
|
|
1432
|
+
expected: "custom",
|
|
1433
|
+
message: "Value does not match any schema"
|
|
1434
|
+
});
|
|
1434
1435
|
}).meta({
|
|
1435
1436
|
description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
|
|
1436
1437
|
});
|
|
@@ -1740,6 +1741,9 @@ var FlagConfig = z15.object({
|
|
|
1740
1741
|
"Indicates if this flag expects an action to be performed to be cleared."
|
|
1741
1742
|
),
|
|
1742
1743
|
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
1744
|
+
}).meta({
|
|
1745
|
+
id: "FlagConfig",
|
|
1746
|
+
description: "Configuration for a custom flag that can be added to or removed from records by event actions."
|
|
1743
1747
|
});
|
|
1744
1748
|
var ActionFlagConfig = z15.object({
|
|
1745
1749
|
id: Flag,
|
|
@@ -1747,6 +1751,9 @@ var ActionFlagConfig = z15.object({
|
|
|
1747
1751
|
conditional: Conditional.optional().describe(
|
|
1748
1752
|
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1749
1753
|
)
|
|
1754
|
+
}).meta({
|
|
1755
|
+
id: "ActionFlagConfig",
|
|
1756
|
+
description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
|
|
1750
1757
|
});
|
|
1751
1758
|
|
|
1752
1759
|
// ../commons/src/events/EventMetadata.ts
|
|
@@ -1768,8 +1775,7 @@ var ActionCreationMetadata = z16.object({
|
|
|
1768
1775
|
),
|
|
1769
1776
|
createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
|
|
1770
1777
|
acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
|
|
1771
|
-
createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
|
|
1772
|
-
createdBySignature: z16.string().nullish().describe("Signature of the user who created the action request.")
|
|
1778
|
+
createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
|
|
1773
1779
|
});
|
|
1774
1780
|
var RegistrationCreationMetadata = ActionCreationMetadata.extend({
|
|
1775
1781
|
registrationNumber: z16.string().describe(
|
|
@@ -1797,9 +1803,6 @@ var EventMetadata = z16.object({
|
|
|
1797
1803
|
createdAtLocation: UUID.nullish().describe(
|
|
1798
1804
|
"Location of the user who created the event."
|
|
1799
1805
|
),
|
|
1800
|
-
createdBySignature: DocumentPath.nullish().describe(
|
|
1801
|
-
"Signature of the user who created the event."
|
|
1802
|
-
),
|
|
1803
1806
|
updatedAtLocation: UUID.nullish().describe(
|
|
1804
1807
|
"Location of the user who last changed the status."
|
|
1805
1808
|
),
|
|
@@ -2174,14 +2177,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
|
|
|
2174
2177
|
}
|
|
2175
2178
|
}).describe("Unique identifier for the field");
|
|
2176
2179
|
var FieldReference = import_v43.default.object({
|
|
2177
|
-
$$field: FieldId,
|
|
2180
|
+
$$field: FieldId.describe("Id of the field to reference"),
|
|
2178
2181
|
$$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
|
|
2179
2182
|
'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
|
|
2180
2183
|
)
|
|
2181
2184
|
}).describe("Reference to a field by its ID");
|
|
2182
2185
|
var ValidationConfig = import_v43.default.object({
|
|
2183
|
-
validator: Conditional
|
|
2184
|
-
|
|
2186
|
+
validator: Conditional.describe(
|
|
2187
|
+
"Conditional expression that must hold for the field value to be considered valid."
|
|
2188
|
+
),
|
|
2189
|
+
message: TranslationConfig.describe(
|
|
2190
|
+
"Error message displayed when the validator does not hold."
|
|
2191
|
+
)
|
|
2192
|
+
}).meta({
|
|
2193
|
+
id: "ValidationConfig",
|
|
2194
|
+
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."
|
|
2185
2195
|
});
|
|
2186
2196
|
var requiredSchema = import_v43.default.union([
|
|
2187
2197
|
import_v43.default.boolean(),
|
|
@@ -2220,6 +2230,9 @@ var BaseField = import_v43.default.object({
|
|
|
2220
2230
|
}).describe("Common properties shared across all field types.");
|
|
2221
2231
|
var Divider = BaseField.extend({
|
|
2222
2232
|
type: import_v43.default.literal(FieldType.DIVIDER)
|
|
2233
|
+
}).meta({
|
|
2234
|
+
description: "A horizontal line divider",
|
|
2235
|
+
id: "Divider"
|
|
2223
2236
|
});
|
|
2224
2237
|
var TextField = BaseField.extend({
|
|
2225
2238
|
type: import_v43.default.literal(FieldType.TEXT),
|
|
@@ -2230,7 +2243,10 @@ var TextField = BaseField.extend({
|
|
|
2230
2243
|
prefix: TranslationConfig.optional(),
|
|
2231
2244
|
postfix: TranslationConfig.optional()
|
|
2232
2245
|
}).default({ type: "text" }).optional()
|
|
2233
|
-
}).
|
|
2246
|
+
}).meta({
|
|
2247
|
+
description: "A text input field",
|
|
2248
|
+
id: "TextField"
|
|
2249
|
+
});
|
|
2234
2250
|
var NumberField = BaseField.extend({
|
|
2235
2251
|
type: import_v43.default.literal(FieldType.NUMBER),
|
|
2236
2252
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -2240,7 +2256,10 @@ var NumberField = BaseField.extend({
|
|
|
2240
2256
|
prefix: TranslationConfig.optional(),
|
|
2241
2257
|
postfix: TranslationConfig.optional()
|
|
2242
2258
|
}).optional()
|
|
2243
|
-
}).
|
|
2259
|
+
}).meta({
|
|
2260
|
+
description: "A number input field",
|
|
2261
|
+
id: "NumberField"
|
|
2262
|
+
});
|
|
2244
2263
|
var TextAreaField = BaseField.extend({
|
|
2245
2264
|
type: import_v43.default.literal(FieldType.TEXTAREA),
|
|
2246
2265
|
defaultValue: NonEmptyTextValue.optional(),
|
|
@@ -2251,7 +2270,10 @@ var TextAreaField = BaseField.extend({
|
|
|
2251
2270
|
prefix: TranslationConfig.optional(),
|
|
2252
2271
|
postfix: TranslationConfig.optional()
|
|
2253
2272
|
}).default({ rows: 4 }).optional()
|
|
2254
|
-
}).
|
|
2273
|
+
}).meta({
|
|
2274
|
+
description: "A multiline text input",
|
|
2275
|
+
id: "TextAreaField"
|
|
2276
|
+
});
|
|
2255
2277
|
var ImageMimeType = import_v43.default.enum([
|
|
2256
2278
|
"image/png",
|
|
2257
2279
|
"image/jpg",
|
|
@@ -2281,13 +2303,19 @@ var SignatureField = BaseField.extend({
|
|
|
2281
2303
|
}).default({
|
|
2282
2304
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2283
2305
|
})
|
|
2284
|
-
}).
|
|
2306
|
+
}).meta({
|
|
2307
|
+
description: "A signature input field",
|
|
2308
|
+
id: "SignatureField"
|
|
2309
|
+
});
|
|
2285
2310
|
var EmailField = BaseField.extend({
|
|
2286
2311
|
type: import_v43.default.literal(FieldType.EMAIL),
|
|
2287
2312
|
configuration: import_v43.default.object({
|
|
2288
2313
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
|
|
2289
2314
|
}).default({ maxLength: 255 }).optional(),
|
|
2290
2315
|
defaultValue: NonEmptyTextValue.optional()
|
|
2316
|
+
}).meta({
|
|
2317
|
+
description: "An email input field",
|
|
2318
|
+
id: "EmailField"
|
|
2291
2319
|
});
|
|
2292
2320
|
var DateField = BaseField.extend({
|
|
2293
2321
|
type: import_v43.default.literal(FieldType.DATE),
|
|
@@ -2297,7 +2325,10 @@ var DateField = BaseField.extend({
|
|
|
2297
2325
|
"Text to display above the date input"
|
|
2298
2326
|
).optional()
|
|
2299
2327
|
}).optional()
|
|
2300
|
-
}).
|
|
2328
|
+
}).meta({
|
|
2329
|
+
description: "A date input (yyyy-MM-dd)",
|
|
2330
|
+
id: "DateField"
|
|
2331
|
+
});
|
|
2301
2332
|
var AgeField = BaseField.extend({
|
|
2302
2333
|
type: import_v43.default.literal(FieldType.AGE),
|
|
2303
2334
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -2306,7 +2337,10 @@ var AgeField = BaseField.extend({
|
|
|
2306
2337
|
prefix: TranslationConfig.optional(),
|
|
2307
2338
|
postfix: TranslationConfig.optional()
|
|
2308
2339
|
})
|
|
2309
|
-
}).
|
|
2340
|
+
}).meta({
|
|
2341
|
+
description: "An age input field which uses the current date as the asOfDate",
|
|
2342
|
+
id: "AgeField"
|
|
2343
|
+
});
|
|
2310
2344
|
var TimeField = BaseField.extend({
|
|
2311
2345
|
type: import_v43.default.literal(FieldType.TIME),
|
|
2312
2346
|
defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
|
|
@@ -2316,7 +2350,10 @@ var TimeField = BaseField.extend({
|
|
|
2316
2350
|
"Text to display above the time input"
|
|
2317
2351
|
).optional()
|
|
2318
2352
|
}).optional()
|
|
2319
|
-
}).
|
|
2353
|
+
}).meta({
|
|
2354
|
+
description: "A single time input (HH-mm)",
|
|
2355
|
+
id: "TimeField"
|
|
2356
|
+
});
|
|
2320
2357
|
var DateRangeField = BaseField.extend({
|
|
2321
2358
|
type: import_v43.default.literal(FieldType.DATE_RANGE),
|
|
2322
2359
|
defaultValue: DateRangeFieldValue.optional(),
|
|
@@ -2325,7 +2362,10 @@ var DateRangeField = BaseField.extend({
|
|
|
2325
2362
|
"Text to display above the date input"
|
|
2326
2363
|
).optional()
|
|
2327
2364
|
}).optional()
|
|
2328
|
-
}).
|
|
2365
|
+
}).meta({
|
|
2366
|
+
description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
|
|
2367
|
+
id: "DateRangeField"
|
|
2368
|
+
});
|
|
2329
2369
|
var HtmlFontVariant = import_v43.default.enum([
|
|
2330
2370
|
"reg12",
|
|
2331
2371
|
"reg14",
|
|
@@ -2369,18 +2409,30 @@ var ImageViewField = BaseField.extend({
|
|
|
2369
2409
|
type: import_v43.default.literal(FieldType.IMAGE_VIEW),
|
|
2370
2410
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2371
2411
|
configuration: ImageConfiguration
|
|
2372
|
-
}).
|
|
2412
|
+
}).meta({
|
|
2413
|
+
description: "A read-only image component for form pages",
|
|
2414
|
+
id: "ImageViewField"
|
|
2415
|
+
});
|
|
2373
2416
|
var Paragraph = BaseField.extend({
|
|
2374
2417
|
type: import_v43.default.literal(FieldType.PARAGRAPH),
|
|
2375
2418
|
configuration: ParagraphConfiguration
|
|
2376
|
-
}).
|
|
2419
|
+
}).meta({
|
|
2420
|
+
description: "A read-only HTML <p> paragraph",
|
|
2421
|
+
id: "Paragraph"
|
|
2422
|
+
});
|
|
2377
2423
|
var Heading = BaseField.extend({
|
|
2378
2424
|
type: import_v43.default.literal(FieldType.HEADING),
|
|
2379
2425
|
configuration: HeadingConfiguration
|
|
2380
|
-
}).
|
|
2426
|
+
}).meta({
|
|
2427
|
+
description: "A read-only heading component for form pages",
|
|
2428
|
+
id: "Heading"
|
|
2429
|
+
});
|
|
2381
2430
|
var PageHeader = BaseField.extend({
|
|
2382
2431
|
type: import_v43.default.literal(FieldType.PAGE_HEADER)
|
|
2383
|
-
}).
|
|
2432
|
+
}).meta({
|
|
2433
|
+
description: "A read-only header component for form pages",
|
|
2434
|
+
id: "PageHeader"
|
|
2435
|
+
});
|
|
2384
2436
|
var File = BaseField.extend({
|
|
2385
2437
|
type: import_v43.default.literal(FieldType.FILE),
|
|
2386
2438
|
defaultValue: FileFieldValue.optional(),
|
|
@@ -2399,7 +2451,10 @@ var File = BaseField.extend({
|
|
|
2399
2451
|
}).default({
|
|
2400
2452
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2401
2453
|
})
|
|
2402
|
-
}).
|
|
2454
|
+
}).meta({
|
|
2455
|
+
description: "A file upload field",
|
|
2456
|
+
id: "File"
|
|
2457
|
+
});
|
|
2403
2458
|
var SelectOption = import_v43.default.object({
|
|
2404
2459
|
value: import_v43.default.string().describe("The value of the option"),
|
|
2405
2460
|
label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
|
|
@@ -2416,7 +2471,10 @@ var NumberWithUnitField = BaseField.extend({
|
|
|
2416
2471
|
"Placeholder for the number field"
|
|
2417
2472
|
)
|
|
2418
2473
|
}).optional()
|
|
2419
|
-
}).
|
|
2474
|
+
}).meta({
|
|
2475
|
+
description: "A number with unit input field",
|
|
2476
|
+
id: "NumberWithUnitField"
|
|
2477
|
+
});
|
|
2420
2478
|
var RadioGroup = BaseField.extend({
|
|
2421
2479
|
type: import_v43.default.literal(FieldType.RADIO_GROUP),
|
|
2422
2480
|
defaultValue: TextValue.optional(),
|
|
@@ -2426,7 +2484,10 @@ var RadioGroup = BaseField.extend({
|
|
|
2426
2484
|
size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
|
|
2427
2485
|
}).optional()
|
|
2428
2486
|
}).optional()
|
|
2429
|
-
}).
|
|
2487
|
+
}).meta({
|
|
2488
|
+
description: "A grouped radio button field",
|
|
2489
|
+
id: "RadioGroup"
|
|
2490
|
+
});
|
|
2430
2491
|
var BulletList = BaseField.extend({
|
|
2431
2492
|
type: import_v43.default.literal(FieldType.BULLET_LIST),
|
|
2432
2493
|
items: import_v43.default.array(TranslationConfig).describe("A list of items"),
|
|
@@ -2435,7 +2496,10 @@ var BulletList = BaseField.extend({
|
|
|
2435
2496
|
fontVariant: HtmlFontVariant.optional()
|
|
2436
2497
|
}).optional()
|
|
2437
2498
|
}).default({})
|
|
2438
|
-
}).
|
|
2499
|
+
}).meta({
|
|
2500
|
+
description: "A list of bullet points",
|
|
2501
|
+
id: "BulletList"
|
|
2502
|
+
});
|
|
2439
2503
|
var Select = BaseField.extend({
|
|
2440
2504
|
type: import_v43.default.literal(FieldType.SELECT),
|
|
2441
2505
|
defaultValue: TextValue.optional(),
|
|
@@ -2450,7 +2514,10 @@ var Select = BaseField.extend({
|
|
|
2450
2514
|
{ ..., defaultMessage: "'{input}' is not listed among the health facilities." }
|
|
2451
2515
|
`
|
|
2452
2516
|
)
|
|
2453
|
-
}).
|
|
2517
|
+
}).meta({
|
|
2518
|
+
description: "A select input field",
|
|
2519
|
+
id: "Select"
|
|
2520
|
+
});
|
|
2454
2521
|
var SelectDateRangeOption = import_v43.default.object({
|
|
2455
2522
|
value: SelectDateRangeValue.describe("The value of the option"),
|
|
2456
2523
|
label: TranslationConfig.describe("The label of the option")
|
|
@@ -2459,7 +2526,10 @@ var SelectDateRangeField = BaseField.extend({
|
|
|
2459
2526
|
type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
|
|
2460
2527
|
defaultValue: SelectDateRangeValue.optional(),
|
|
2461
2528
|
options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
|
|
2462
|
-
}).
|
|
2529
|
+
}).meta({
|
|
2530
|
+
description: "A date range selection field",
|
|
2531
|
+
id: "SelectDateRangeField"
|
|
2532
|
+
});
|
|
2463
2533
|
var NameConfig = import_v43.default.object({
|
|
2464
2534
|
firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
2465
2535
|
middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
@@ -2490,26 +2560,41 @@ var NameField = BaseField.extend({
|
|
|
2490
2560
|
surname: { required: true }
|
|
2491
2561
|
}
|
|
2492
2562
|
}).optional()
|
|
2493
|
-
}).
|
|
2563
|
+
}).meta({
|
|
2564
|
+
description: "A field for entering a persons name",
|
|
2565
|
+
id: "NameField"
|
|
2566
|
+
});
|
|
2494
2567
|
var PhoneField = BaseField.extend({
|
|
2495
2568
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2496
2569
|
type: import_v43.default.literal(FieldType.PHONE)
|
|
2497
|
-
}).
|
|
2570
|
+
}).meta({
|
|
2571
|
+
description: "A field for entering a phone number",
|
|
2572
|
+
id: "PhoneField"
|
|
2573
|
+
});
|
|
2498
2574
|
var IdField = BaseField.extend({
|
|
2499
2575
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2500
2576
|
type: import_v43.default.literal(FieldType.ID)
|
|
2501
|
-
}).
|
|
2577
|
+
}).meta({
|
|
2578
|
+
description: "A field for entering an ID",
|
|
2579
|
+
id: "IdField"
|
|
2580
|
+
});
|
|
2502
2581
|
var Checkbox = BaseField.extend({
|
|
2503
2582
|
type: import_v43.default.literal(FieldType.CHECKBOX),
|
|
2504
2583
|
defaultValue: CheckboxFieldValue.default(false)
|
|
2505
|
-
}).
|
|
2584
|
+
}).meta({
|
|
2585
|
+
description: "A boolean checkbox field",
|
|
2586
|
+
id: "Checkbox"
|
|
2587
|
+
});
|
|
2506
2588
|
var Country = BaseField.extend({
|
|
2507
2589
|
type: import_v43.default.literal(FieldType.COUNTRY),
|
|
2508
2590
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2509
2591
|
optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
|
|
2510
2592
|
"Conditionals for specific countries. Countries not listed are always shown and enabled."
|
|
2511
2593
|
)
|
|
2512
|
-
}).
|
|
2594
|
+
}).meta({
|
|
2595
|
+
description: "A field for selecting a country",
|
|
2596
|
+
id: "Country"
|
|
2597
|
+
});
|
|
2513
2598
|
var AllowedLocations = JurisdictionReference.optional().describe(
|
|
2514
2599
|
"Limits which location options are selectable depending on user jurisdiction and location."
|
|
2515
2600
|
);
|
|
@@ -2518,16 +2603,18 @@ var AdministrativeAreas = import_v43.default.enum([
|
|
|
2518
2603
|
"HEALTH_FACILITY",
|
|
2519
2604
|
"CRVS_OFFICE"
|
|
2520
2605
|
]);
|
|
2521
|
-
var AdministrativeAreaConfiguration = import_v43.default.object({
|
|
2522
|
-
partOf: FieldReference.optional().describe("Parent location"),
|
|
2523
|
-
type: AdministrativeAreas,
|
|
2524
|
-
allowedLocations: AllowedLocations
|
|
2525
|
-
}).describe("Administrative area options");
|
|
2526
2606
|
var AdministrativeAreaField = BaseField.extend({
|
|
2527
2607
|
type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
|
|
2528
2608
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
2529
|
-
configuration:
|
|
2530
|
-
|
|
2609
|
+
configuration: import_v43.default.object({
|
|
2610
|
+
partOf: FieldReference.optional().describe("Parent location"),
|
|
2611
|
+
type: AdministrativeAreas,
|
|
2612
|
+
allowedLocations: AllowedLocations
|
|
2613
|
+
}).describe("Administrative area options")
|
|
2614
|
+
}).meta({
|
|
2615
|
+
description: "Administrative area input field",
|
|
2616
|
+
id: "AdministrativeAreaField"
|
|
2617
|
+
});
|
|
2531
2618
|
var LocationInput = BaseField.extend({
|
|
2532
2619
|
type: import_v43.default.literal(FieldType.LOCATION),
|
|
2533
2620
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
@@ -2535,7 +2622,10 @@ var LocationInput = BaseField.extend({
|
|
|
2535
2622
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
2536
2623
|
allowedLocations: AllowedLocations
|
|
2537
2624
|
}).optional()
|
|
2538
|
-
}).
|
|
2625
|
+
}).meta({
|
|
2626
|
+
description: "A field for selecting a location",
|
|
2627
|
+
id: "LocationInput"
|
|
2628
|
+
});
|
|
2539
2629
|
var FileUploadWithOptions = BaseField.extend({
|
|
2540
2630
|
type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
|
|
2541
2631
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
@@ -2549,6 +2639,9 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
2549
2639
|
}).default({
|
|
2550
2640
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2551
2641
|
})
|
|
2642
|
+
}).meta({
|
|
2643
|
+
description: "A field for uploading files with file type options",
|
|
2644
|
+
id: "FileUploadWithOptions"
|
|
2552
2645
|
});
|
|
2553
2646
|
var Facility = BaseField.extend({
|
|
2554
2647
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
@@ -2594,7 +2687,10 @@ var Address = BaseField.extend({
|
|
|
2594
2687
|
allowedLocations: AllowedLocations
|
|
2595
2688
|
}).optional(),
|
|
2596
2689
|
defaultValue: DefaultAddressFieldValue.optional()
|
|
2597
|
-
}).
|
|
2690
|
+
}).meta({
|
|
2691
|
+
description: "Address input field \u2013 a combination of location and text fields",
|
|
2692
|
+
id: "Address"
|
|
2693
|
+
});
|
|
2598
2694
|
var StaticDataEntry = import_v43.default.object({
|
|
2599
2695
|
id: import_v43.default.string().describe("ID for the data entry."),
|
|
2600
2696
|
label: TranslationConfig,
|
|
@@ -2609,7 +2705,10 @@ var DataField = BaseField.extend({
|
|
|
2609
2705
|
subtitle: TranslationConfig.optional(),
|
|
2610
2706
|
data: import_v43.default.array(DataEntry)
|
|
2611
2707
|
})
|
|
2612
|
-
}).
|
|
2708
|
+
}).meta({
|
|
2709
|
+
description: "A field for displaying a table of read-only data",
|
|
2710
|
+
id: "DataField"
|
|
2711
|
+
});
|
|
2613
2712
|
var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
|
|
2614
2713
|
var ButtonType = import_v43.default.enum([
|
|
2615
2714
|
"primary",
|
|
@@ -2636,11 +2735,17 @@ var ButtonField = BaseField.extend({
|
|
|
2636
2735
|
type: import_v43.default.literal(FieldType.BUTTON),
|
|
2637
2736
|
defaultValue: ButtonFieldValue.optional(),
|
|
2638
2737
|
configuration: ButtonConfiguration
|
|
2639
|
-
}).
|
|
2738
|
+
}).meta({
|
|
2739
|
+
description: "A generic button that can be used to trigger an action",
|
|
2740
|
+
id: "ButtonField"
|
|
2741
|
+
});
|
|
2640
2742
|
var FieldGroup = BaseField.extend({
|
|
2641
2743
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
2642
2744
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
2643
2745
|
fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
|
|
2746
|
+
}).meta({
|
|
2747
|
+
description: "A group of fields that are displayed together",
|
|
2748
|
+
id: "FieldGroup"
|
|
2644
2749
|
});
|
|
2645
2750
|
var AlphaPrintButton = BaseField.extend({
|
|
2646
2751
|
type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
|
|
@@ -2650,7 +2755,10 @@ var AlphaPrintButton = BaseField.extend({
|
|
|
2650
2755
|
"Label for the print button"
|
|
2651
2756
|
)
|
|
2652
2757
|
})
|
|
2653
|
-
}).
|
|
2758
|
+
}).meta({
|
|
2759
|
+
description: "An experimental print button field for printing certificates during the declaration process",
|
|
2760
|
+
id: "AlphaPrintButton"
|
|
2761
|
+
});
|
|
2654
2762
|
var HttpField = BaseField.extend({
|
|
2655
2763
|
type: import_v43.default.literal(FieldType.HTTP),
|
|
2656
2764
|
defaultValue: HttpFieldValue.optional(),
|
|
@@ -2666,20 +2774,30 @@ var HttpField = BaseField.extend({
|
|
|
2666
2774
|
params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
|
|
2667
2775
|
timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
|
|
2668
2776
|
})
|
|
2669
|
-
}).
|
|
2777
|
+
}).meta({
|
|
2778
|
+
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.",
|
|
2779
|
+
id: "HttpField"
|
|
2780
|
+
});
|
|
2670
2781
|
var AutocompleteField = BaseField.extend({
|
|
2671
2782
|
type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
|
|
2672
2783
|
configuration: import_v43.default.object({
|
|
2673
|
-
url: import_v43.default.string().describe(
|
|
2784
|
+
url: import_v43.default.string().describe(
|
|
2785
|
+
"URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
|
|
2786
|
+
).optional(),
|
|
2674
2787
|
method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
|
|
2675
2788
|
defaultOptions: import_v43.default.array(
|
|
2676
2789
|
import_v43.default.object({
|
|
2677
2790
|
label: import_v43.default.string(),
|
|
2678
2791
|
value: import_v43.default.string()
|
|
2679
2792
|
})
|
|
2680
|
-
).optional()
|
|
2793
|
+
).optional().describe(
|
|
2794
|
+
"Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
|
|
2795
|
+
)
|
|
2681
2796
|
})
|
|
2682
|
-
}).
|
|
2797
|
+
}).meta({
|
|
2798
|
+
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.",
|
|
2799
|
+
id: "AutocompleteField"
|
|
2800
|
+
});
|
|
2683
2801
|
var SearchField = HttpField.extend({
|
|
2684
2802
|
type: import_v43.default.literal(FieldType.SEARCH),
|
|
2685
2803
|
configuration: SearchQuery.pick({
|
|
@@ -2712,6 +2830,9 @@ var SearchField = HttpField.extend({
|
|
|
2712
2830
|
ok: TranslationConfig.optional()
|
|
2713
2831
|
}).optional()
|
|
2714
2832
|
})
|
|
2833
|
+
}).meta({
|
|
2834
|
+
description: "A search input field",
|
|
2835
|
+
id: "SearchField"
|
|
2715
2836
|
});
|
|
2716
2837
|
var LinkButtonField = BaseField.extend({
|
|
2717
2838
|
type: import_v43.default.literal(FieldType.LINK_BUTTON),
|
|
@@ -2720,7 +2841,10 @@ var LinkButtonField = BaseField.extend({
|
|
|
2720
2841
|
text: TranslationConfig.describe("Text to display on the button"),
|
|
2721
2842
|
icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
|
|
2722
2843
|
})
|
|
2723
|
-
}).
|
|
2844
|
+
}).meta({
|
|
2845
|
+
description: "A button that opens a URL link",
|
|
2846
|
+
id: "LinkButtonField"
|
|
2847
|
+
});
|
|
2724
2848
|
var VerificationStatus = BaseField.extend({
|
|
2725
2849
|
type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
|
|
2726
2850
|
defaultValue: VerificationStatusValue.optional(),
|
|
@@ -2730,15 +2854,19 @@ var VerificationStatus = BaseField.extend({
|
|
|
2730
2854
|
"Explaining text on the banner in form."
|
|
2731
2855
|
)
|
|
2732
2856
|
})
|
|
2857
|
+
}).meta({
|
|
2858
|
+
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.",
|
|
2859
|
+
id: "VerificationStatus"
|
|
2733
2860
|
});
|
|
2734
2861
|
var QueryParamReaderField = BaseField.extend({
|
|
2735
2862
|
type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
|
|
2736
2863
|
configuration: import_v43.default.object({
|
|
2737
2864
|
pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
|
|
2738
2865
|
})
|
|
2739
|
-
}).
|
|
2740
|
-
"A field that maps URL query params into form values and clears them afterward"
|
|
2741
|
-
|
|
2866
|
+
}).meta({
|
|
2867
|
+
description: "A field that maps URL query params into form values and clears them afterward",
|
|
2868
|
+
id: "QueryParamReaderField"
|
|
2869
|
+
});
|
|
2742
2870
|
var QrReaderField = BaseField.extend({
|
|
2743
2871
|
type: import_v43.default.literal(FieldType.QR_READER),
|
|
2744
2872
|
defaultValue: QrReaderFieldValue.optional(),
|
|
@@ -2749,7 +2877,7 @@ var QrReaderField = BaseField.extend({
|
|
|
2749
2877
|
})
|
|
2750
2878
|
}).optional()
|
|
2751
2879
|
}).meta({
|
|
2752
|
-
description: "
|
|
2880
|
+
description: "QR code reader field, including optional JSON Schema validator.",
|
|
2753
2881
|
id: "QrReaderField"
|
|
2754
2882
|
});
|
|
2755
2883
|
var IdReaderField = BaseField.extend({
|
|
@@ -2758,12 +2886,18 @@ var IdReaderField = BaseField.extend({
|
|
|
2758
2886
|
methods: import_v43.default.array(
|
|
2759
2887
|
import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
|
|
2760
2888
|
)
|
|
2889
|
+
}).meta({
|
|
2890
|
+
description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
|
|
2891
|
+
id: "IdReaderField"
|
|
2761
2892
|
});
|
|
2762
2893
|
var CustomField = BaseField.extend({
|
|
2763
2894
|
type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
|
|
2764
2895
|
defaultValue: CustomFieldValue.optional(),
|
|
2765
2896
|
src: import_v43.default.string().describe("Module source path for the custom field component"),
|
|
2766
2897
|
configuration: import_v43.default.unknown().optional()
|
|
2898
|
+
}).meta({
|
|
2899
|
+
description: "An expiremental custom field that is defined by a module source path",
|
|
2900
|
+
id: "CustomField"
|
|
2767
2901
|
});
|
|
2768
2902
|
var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
|
|
2769
2903
|
var LoaderField = BaseField.extend({
|
|
@@ -2773,22 +2907,25 @@ var LoaderField = BaseField.extend({
|
|
|
2773
2907
|
configuration: import_v43.default.object({
|
|
2774
2908
|
text: TranslationConfig.describe("Display text above the loading spinner")
|
|
2775
2909
|
})
|
|
2776
|
-
}).
|
|
2777
|
-
"A non-interactive field that indicates an in progress operation in form"
|
|
2778
|
-
|
|
2910
|
+
}).meta({
|
|
2911
|
+
description: "A non-interactive field that indicates an in progress operation in form",
|
|
2912
|
+
id: "LoaderField"
|
|
2913
|
+
});
|
|
2779
2914
|
var HiddenField = BaseField.extend({
|
|
2780
2915
|
type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
|
|
2781
2916
|
required: import_v43.default.boolean().default(false).optional(),
|
|
2782
2917
|
defaultValue: TextValue.optional()
|
|
2783
|
-
}).
|
|
2784
|
-
"A non-interactive, hidden field that only hold a value in the form"
|
|
2785
|
-
|
|
2918
|
+
}).meta({
|
|
2919
|
+
description: "A non-interactive, hidden field that only hold a value in the form",
|
|
2920
|
+
id: "HiddenField"
|
|
2921
|
+
});
|
|
2786
2922
|
var UserRoleField = BaseField.extend({
|
|
2787
2923
|
type: import_v43.default.literal(FieldType.USER_ROLE),
|
|
2788
2924
|
defaultValue: TextValue.optional()
|
|
2789
|
-
}).
|
|
2790
|
-
"A select dropdown that is automatically populated with available user roles"
|
|
2791
|
-
|
|
2925
|
+
}).meta({
|
|
2926
|
+
description: "A select dropdown that is automatically populated with available user roles",
|
|
2927
|
+
id: "UserRoleField"
|
|
2928
|
+
});
|
|
2792
2929
|
var FieldConfig = import_v43.default.discriminatedUnion("type", [
|
|
2793
2930
|
FieldGroup,
|
|
2794
2931
|
Address,
|
|
@@ -2887,16 +3024,19 @@ var VerificationPageConfig = FormPageConfig.extend({
|
|
|
2887
3024
|
type: z21.literal(PageTypes.enum.VERIFICATION),
|
|
2888
3025
|
actions: VerificationActionConfig
|
|
2889
3026
|
});
|
|
2890
|
-
var PageConfig = z21.discriminatedUnion("type", [
|
|
2891
|
-
|
|
2892
|
-
|
|
2893
|
-
|
|
3027
|
+
var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
|
|
3028
|
+
id: "PageConfig",
|
|
3029
|
+
description: "Configuration for a single page in a form. Either a form page with fields and a continue button, or a verification page with verify/cancel options."
|
|
3030
|
+
});
|
|
2894
3031
|
|
|
2895
3032
|
// ../commons/src/events/FormConfig.ts
|
|
2896
3033
|
var DeclarationFormConfig = z22.object({
|
|
2897
3034
|
label: TranslationConfig.describe("Human readable description of the form"),
|
|
2898
3035
|
pages: z22.array(FormPageConfig)
|
|
2899
|
-
}).
|
|
3036
|
+
}).meta({
|
|
3037
|
+
id: "DeclarationFormConfig",
|
|
3038
|
+
description: "Configuration of the declaration form."
|
|
3039
|
+
});
|
|
2900
3040
|
var ActionFormConfig = z22.object({
|
|
2901
3041
|
label: TranslationConfig.describe("Human readable description of the form"),
|
|
2902
3042
|
pages: z22.array(PageConfig)
|
|
@@ -3113,17 +3253,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
|
|
|
3113
3253
|
* OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
|
|
3114
3254
|
* and treat them as "models" instead of duplicating the data structure in each endpoint.
|
|
3115
3255
|
*/
|
|
3116
|
-
ReadActionConfig.meta({
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3256
|
+
ReadActionConfig.meta({
|
|
3257
|
+
id: "ReadActionConfig",
|
|
3258
|
+
description: "Configuration for the read action \u2014 defines the record-tab content displayed on the event overview page."
|
|
3259
|
+
}),
|
|
3260
|
+
DeclareConfig.meta({
|
|
3261
|
+
id: "DeclareActionConfig",
|
|
3262
|
+
description: "Configuration for the declare action. Includes review-page fields. Shared with the notify action (ActionType.NOTIFY)."
|
|
3263
|
+
}),
|
|
3264
|
+
RejectConfig.meta({
|
|
3265
|
+
id: "RejectActionConfig",
|
|
3266
|
+
description: "Configuration for rejecting a record before registration."
|
|
3267
|
+
}),
|
|
3268
|
+
RegisterConfig.meta({
|
|
3269
|
+
id: "RegisterActionConfig",
|
|
3270
|
+
description: "Configuration for registering a record."
|
|
3271
|
+
}),
|
|
3120
3272
|
PrintCertificateActionConfig.meta({
|
|
3121
|
-
id: "PrintCertificateActionConfig"
|
|
3273
|
+
id: "PrintCertificateActionConfig",
|
|
3274
|
+
description: "Configuration for printing a certificate of a registered record."
|
|
3122
3275
|
}),
|
|
3123
|
-
RequestCorrectionConfig.meta({
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3276
|
+
RequestCorrectionConfig.meta({
|
|
3277
|
+
id: "RequestCorrectionActionConfig",
|
|
3278
|
+
description: "Configuration for requesting a correction on a registered record."
|
|
3279
|
+
}),
|
|
3280
|
+
EditActionConfig.meta({
|
|
3281
|
+
id: "EditActionConfig",
|
|
3282
|
+
description: "Configuration for editing a record before registration."
|
|
3283
|
+
}),
|
|
3284
|
+
ArchiveConfig.meta({
|
|
3285
|
+
id: "ArchiveActionConfig",
|
|
3286
|
+
description: "Configuration for archiving a record."
|
|
3287
|
+
}),
|
|
3288
|
+
CustomActionConfig.meta({
|
|
3289
|
+
id: "CustomActionConfig",
|
|
3290
|
+
description: "Configuration for a country-defined custom action. An event may include any number of these."
|
|
3291
|
+
})
|
|
3127
3292
|
]).describe(
|
|
3128
3293
|
"Configuration of an action available for an event. Data collected depends on the action type and is accessible through the annotation property in ActionDocument."
|
|
3129
3294
|
).meta({ id: "ActionConfig" });
|
|
@@ -3799,6 +3964,9 @@ function precompileActionSchemas(eventConfigurations) {
|
|
|
3799
3964
|
function isAgeValue(value) {
|
|
3800
3965
|
return typeof value === "object" && value !== null && "age" in value && typeof value.age === "number";
|
|
3801
3966
|
}
|
|
3967
|
+
function mergeWithBaseFormState(values, context) {
|
|
3968
|
+
return { ...context.baseFormState, ...values };
|
|
3969
|
+
}
|
|
3802
3970
|
function validate(schema, data) {
|
|
3803
3971
|
const validator = ajv.getSchema(schema.$id) || ajv.compile(schema);
|
|
3804
3972
|
if ("$form" in data) {
|
|
@@ -3837,7 +4005,7 @@ function isOnline() {
|
|
|
3837
4005
|
}
|
|
3838
4006
|
function isConditionMet(conditional, values, context, eventIndex) {
|
|
3839
4007
|
return validate(conditional, {
|
|
3840
|
-
$form: values,
|
|
4008
|
+
$form: mergeWithBaseFormState(values, context),
|
|
3841
4009
|
$now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
|
|
3842
4010
|
$online: isOnline(),
|
|
3843
4011
|
$user: context.user,
|
|
@@ -3866,7 +4034,7 @@ function isFieldConditionMet(field3, form, conditionalType, context) {
|
|
|
3866
4034
|
return true;
|
|
3867
4035
|
}
|
|
3868
4036
|
const validConditionals = getConditionalActionsForField(field3, {
|
|
3869
|
-
$form: form,
|
|
4037
|
+
$form: mergeWithBaseFormState(form, context),
|
|
3870
4038
|
$now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
|
|
3871
4039
|
$online: isOnline(),
|
|
3872
4040
|
$user: context.user,
|
|
@@ -4058,7 +4226,7 @@ function runFieldValidations({
|
|
|
4058
4226
|
return [];
|
|
4059
4227
|
}
|
|
4060
4228
|
const conditionalParameters = {
|
|
4061
|
-
$form: form,
|
|
4229
|
+
$form: mergeWithBaseFormState(form, context),
|
|
4062
4230
|
$now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
|
|
4063
4231
|
/**
|
|
4064
4232
|
* In real use cases, there can be hundreds of thousands of locations.
|
|
@@ -4302,17 +4470,16 @@ function isPageVisible(page, formValues, context) {
|
|
|
4302
4470
|
}
|
|
4303
4471
|
return isConditionMet(page.conditional, formValues, context);
|
|
4304
4472
|
}
|
|
4305
|
-
function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false
|
|
4473
|
+
function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false) {
|
|
4306
4474
|
const base = (0, import_lodash.cloneDeep)(formValues);
|
|
4307
4475
|
function fn(prevVisibilityContext) {
|
|
4308
|
-
const visibilityForm = declarationContext ? { ...declarationContext, ...prevVisibilityContext } : prevVisibilityContext;
|
|
4309
4476
|
const cleaned = (0, import_lodash.omitBy)(base, (value, fieldId) => {
|
|
4310
4477
|
const fieldConfig = fields.filter((f) => f.id === fieldId);
|
|
4311
4478
|
if (!fieldConfig.length) {
|
|
4312
4479
|
return false;
|
|
4313
4480
|
}
|
|
4314
4481
|
const isHidden = fieldConfig.every(
|
|
4315
|
-
(f) => !isFieldVisible(f,
|
|
4482
|
+
(f) => !isFieldVisible(f, prevVisibilityContext, validatorContext)
|
|
4316
4483
|
);
|
|
4317
4484
|
if (!isHidden) {
|
|
4318
4485
|
return false;
|
|
@@ -4330,7 +4497,7 @@ function omitHiddenPaginatedFields(formConfig, values, validatorContext, include
|
|
|
4330
4497
|
const visibleFields = formConfig.pages.filter((p) => isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
|
|
4331
4498
|
const hiddenFields = formConfig.pages.filter((p) => !isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
|
|
4332
4499
|
const valuesExceptHiddenPage = (0, import_lodash.omitBy)(values, (_2, fieldId) => {
|
|
4333
|
-
return hiddenFields.some((f) => f.id === fieldId);
|
|
4500
|
+
return hiddenFields.some((f) => f.id === fieldId) && !visibleFields.some((f) => f.id === fieldId);
|
|
4334
4501
|
});
|
|
4335
4502
|
return omitHiddenFields(
|
|
4336
4503
|
visibleFields,
|
|
@@ -4377,13 +4544,10 @@ function getVisibleVerificationPageIds(pages, annotation, context) {
|
|
|
4377
4544
|
}
|
|
4378
4545
|
function omitHiddenAnnotationFields(actionConfig, declaration, annotation, context) {
|
|
4379
4546
|
const annotationFields = getActionAnnotationFields(actionConfig);
|
|
4380
|
-
return omitHiddenFields(
|
|
4381
|
-
|
|
4382
|
-
|
|
4383
|
-
|
|
4384
|
-
false,
|
|
4385
|
-
declaration
|
|
4386
|
-
);
|
|
4547
|
+
return omitHiddenFields(annotationFields, annotation, {
|
|
4548
|
+
...context,
|
|
4549
|
+
baseFormState: declaration
|
|
4550
|
+
});
|
|
4387
4551
|
}
|
|
4388
4552
|
function deepMerge(currentDocument, actionDocument) {
|
|
4389
4553
|
const currentDocumentClone = (0, import_lodash.cloneDeep)(currentDocument);
|
|
@@ -5372,7 +5536,7 @@ var _EventConfigBase = z33.object({
|
|
|
5372
5536
|
),
|
|
5373
5537
|
label: TranslationConfig.describe("Human-readable label for the event type."),
|
|
5374
5538
|
actions: z33.array(ActionConfig).describe(
|
|
5375
|
-
"Configuration of
|
|
5539
|
+
"Configuration of core and custom actions associated with the event."
|
|
5376
5540
|
),
|
|
5377
5541
|
actionOrder: z33.array(z33.string()).optional().describe(
|
|
5378
5542
|
"Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
|
|
@@ -5384,7 +5548,7 @@ var _EventConfigBase = z33.object({
|
|
|
5384
5548
|
"Configuration of fields available in the advanced search feature."
|
|
5385
5549
|
),
|
|
5386
5550
|
flags: z33.array(FlagConfig).optional().default([]).describe(
|
|
5387
|
-
"Configuration of flags associated with the actions of this event type."
|
|
5551
|
+
"Configuration of custom flags associated with the actions of this event type."
|
|
5388
5552
|
),
|
|
5389
5553
|
analytics: z33.boolean().optional().default(true).describe(
|
|
5390
5554
|
"Indicates whether the records of this event type are included in analytics"
|
|
@@ -5397,8 +5561,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
|
|
|
5397
5561
|
validateActionFlags(event2, ctx);
|
|
5398
5562
|
validateActionOrder(event2, ctx);
|
|
5399
5563
|
}).meta({
|
|
5400
|
-
id: "EventConfig"
|
|
5401
|
-
|
|
5564
|
+
id: "EventConfig",
|
|
5565
|
+
description: "Configuration defining an event type registered in OpenCRVS (for example birth or death)."
|
|
5566
|
+
});
|
|
5402
5567
|
|
|
5403
5568
|
// ../commons/src/events/EventConfigInput.ts
|
|
5404
5569
|
var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
|
|
@@ -5823,18 +5988,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
|
|
|
5823
5988
|
query: true,
|
|
5824
5989
|
columns: true
|
|
5825
5990
|
});
|
|
5826
|
-
var WorkqueueConfigInput =
|
|
5827
|
-
|
|
5828
|
-
|
|
5829
|
-
|
|
5830
|
-
|
|
5831
|
-
query: CountryConfigQueryInputType,
|
|
5832
|
-
action: z37.object({ type: WorkqueueActionType }).optional().describe(
|
|
5833
|
-
"Workqueue call-to-action button configuration. This determines the quick action button shown on each event card and the action taken when the button is clicked."
|
|
5834
|
-
),
|
|
5835
|
-
columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
|
|
5836
|
-
icon: AvailableIcons,
|
|
5837
|
-
emptyMessage: TranslationConfig.optional()
|
|
5991
|
+
var WorkqueueConfigInput = WorkqueueConfig.extend({
|
|
5992
|
+
query: CountryConfigQueryInputType
|
|
5993
|
+
}).meta({
|
|
5994
|
+
description: "Workqueue configuration",
|
|
5995
|
+
id: "WorkqueueConfig"
|
|
5838
5996
|
});
|
|
5839
5997
|
function defineWorkqueue(workqueueInput) {
|
|
5840
5998
|
const queryInput = workqueueInput.query;
|
|
@@ -5895,6 +6053,9 @@ var BaseActionInput = z38.object({
|
|
|
5895
6053
|
originalActionId: UUID.optional(),
|
|
5896
6054
|
// should not be part of base action.
|
|
5897
6055
|
keepAssignment: z38.boolean().optional(),
|
|
6056
|
+
keepAssignmentIfAccepted: z38.boolean().optional(),
|
|
6057
|
+
keepAssignmentIfRejected: z38.boolean().optional(),
|
|
6058
|
+
waitFor: z38.boolean().optional(),
|
|
5898
6059
|
// For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
|
|
5899
6060
|
// @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
|
|
5900
6061
|
createdAtLocation: UUID.nullish().describe(
|
|
@@ -6148,7 +6309,6 @@ function getDeclarationActionCreationMetadata(actionType, actions) {
|
|
|
6148
6309
|
createdAtLocation: requestAction?.createdAtLocation ?? acceptAction.createdAtLocation,
|
|
6149
6310
|
acceptedAt: acceptAction.createdAt,
|
|
6150
6311
|
createdByRole: requestAction?.createdByRole ?? acceptAction.createdByRole,
|
|
6151
|
-
createdBySignature: requestAction?.createdBySignature ?? acceptAction.createdBySignature,
|
|
6152
6312
|
registrationNumber
|
|
6153
6313
|
};
|
|
6154
6314
|
}
|
|
@@ -6362,17 +6522,6 @@ function getAssignedUserFromActions(actions) {
|
|
|
6362
6522
|
return user2;
|
|
6363
6523
|
}, null);
|
|
6364
6524
|
}
|
|
6365
|
-
function getAssignedUserSignatureFromActions(actions) {
|
|
6366
|
-
return actions.reduce((signature, action) => {
|
|
6367
|
-
if (action.type === ActionType.ASSIGN) {
|
|
6368
|
-
return action.createdBySignature || null;
|
|
6369
|
-
}
|
|
6370
|
-
if (action.type === ActionType.UNASSIGN) {
|
|
6371
|
-
return null;
|
|
6372
|
-
}
|
|
6373
|
-
return signature;
|
|
6374
|
-
}, null);
|
|
6375
|
-
}
|
|
6376
6525
|
function deepDropNulls(obj) {
|
|
6377
6526
|
if (Array.isArray(obj)) {
|
|
6378
6527
|
return obj.map(deepDropNulls);
|
|
@@ -6468,10 +6617,8 @@ function getCurrentEventState(event2, config) {
|
|
|
6468
6617
|
createdBy: creationAction.createdBy,
|
|
6469
6618
|
createdByUserType: creationAction.createdByUserType,
|
|
6470
6619
|
createdAtLocation: creationAction.createdAtLocation,
|
|
6471
|
-
createdBySignature: creationAction.createdBySignature,
|
|
6472
6620
|
updatedAt: acceptedActionMetadata.createdAt,
|
|
6473
6621
|
assignedTo: getAssignedUserFromActions(acceptedActions),
|
|
6474
|
-
assignedToSignature: getAssignedUserSignatureFromActions(acceptedActions),
|
|
6475
6622
|
updatedBy: requestActionMetadata.createdBy,
|
|
6476
6623
|
updatedAtLocation: requestActionMetadata.createdAtLocation,
|
|
6477
6624
|
declaration,
|
|
@@ -9730,7 +9877,6 @@ var eventQueryDataGenerator = (overrides = {}, seed = 1) => {
|
|
|
9730
9877
|
createdBy: overrides.createdBy ?? generateUuid(rng),
|
|
9731
9878
|
createdAtLocation: overrides.createdAtLocation ?? generateUuid(rng),
|
|
9732
9879
|
updatedAtLocation: overrides.updatedAtLocation ?? generateUuid(rng),
|
|
9733
|
-
createdBySignature: overrides.createdBySignature ?? generateRandomSignature(rng),
|
|
9734
9880
|
updatedAt: overrides.updatedAt ?? (0, import_date_fns4.addDays)(new Date(createdAt), 1).toISOString(),
|
|
9735
9881
|
assignedTo: overrides.assignedTo ?? null,
|
|
9736
9882
|
updatedBy: overrides.updatedBy ?? generateUuid(rng),
|
|
@@ -10001,6 +10147,39 @@ function userCanAccessEventWithScopes(event2, scopes, user2, customActionType) {
|
|
|
10001
10147
|
(scope) => canAccessEventWithScope(event2, scope, user2, customActionType)
|
|
10002
10148
|
);
|
|
10003
10149
|
}
|
|
10150
|
+
function getAdministrativeAreaHierarchy(administrativeAreaId, administrativeAreas) {
|
|
10151
|
+
const collectedLocations = [];
|
|
10152
|
+
const parsedAdministrativeAreaId = administrativeAreaId && UUID.safeParse(administrativeAreaId).data;
|
|
10153
|
+
let current = parsedAdministrativeAreaId ? administrativeAreas.get(parsedAdministrativeAreaId) : null;
|
|
10154
|
+
while (current) {
|
|
10155
|
+
collectedLocations.push(current);
|
|
10156
|
+
if (!current.parentId) {
|
|
10157
|
+
break;
|
|
10158
|
+
}
|
|
10159
|
+
const parentId = current.parentId;
|
|
10160
|
+
current = administrativeAreas.get(parentId);
|
|
10161
|
+
}
|
|
10162
|
+
return collectedLocations;
|
|
10163
|
+
}
|
|
10164
|
+
function getLocationHierarchy(selectedId, context) {
|
|
10165
|
+
const { administrativeAreas, locations } = context;
|
|
10166
|
+
const loc = locations.get(selectedId);
|
|
10167
|
+
if (loc) {
|
|
10168
|
+
if (loc.administrativeAreaId) {
|
|
10169
|
+
const hierarchy2 = getAdministrativeAreaHierarchy(
|
|
10170
|
+
loc.administrativeAreaId,
|
|
10171
|
+
administrativeAreas
|
|
10172
|
+
);
|
|
10173
|
+
return [...hierarchy2.reverse().map((area) => area.id), loc.id];
|
|
10174
|
+
}
|
|
10175
|
+
return [loc.id];
|
|
10176
|
+
}
|
|
10177
|
+
const hierarchy = getAdministrativeAreaHierarchy(
|
|
10178
|
+
selectedId,
|
|
10179
|
+
administrativeAreas
|
|
10180
|
+
);
|
|
10181
|
+
return hierarchy.reverse().map((area) => area.id);
|
|
10182
|
+
}
|
|
10004
10183
|
|
|
10005
10184
|
// ../commons/src/events/scopes.ts
|
|
10006
10185
|
var ACTION_SCOPE_MAP = {
|
|
@@ -10075,6 +10254,25 @@ function isActionInScope({
|
|
|
10075
10254
|
);
|
|
10076
10255
|
return canAccess;
|
|
10077
10256
|
}
|
|
10257
|
+
function getAvailableRolesForUserUpdatePayload({
|
|
10258
|
+
allRoles,
|
|
10259
|
+
userLocation,
|
|
10260
|
+
acceptedScopes,
|
|
10261
|
+
userRequesting
|
|
10262
|
+
}) {
|
|
10263
|
+
const availableRoles = allRoles.filter((role) => {
|
|
10264
|
+
const canAccess = canAccessOtherUserWithScopes({
|
|
10265
|
+
userToAccess: {
|
|
10266
|
+
...userLocation,
|
|
10267
|
+
role
|
|
10268
|
+
},
|
|
10269
|
+
user: userRequesting,
|
|
10270
|
+
scopes: acceptedScopes
|
|
10271
|
+
});
|
|
10272
|
+
return canAccess;
|
|
10273
|
+
});
|
|
10274
|
+
return availableRoles;
|
|
10275
|
+
}
|
|
10078
10276
|
|
|
10079
10277
|
// ../commons/src/events/serializers/user/deserializer.ts
|
|
10080
10278
|
function userDeserializer(serializedUserField, user2) {
|