@opencrvs/toolkit 2.0.0-rc.61bee9f → 2.0.0-rc.62a7fbc
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 +21 -0
- package/dist/application-config/index.js +218 -85
- package/dist/cli.js +392 -128
- package/dist/commons/api/router.d.ts +3304 -235
- 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/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 +3 -1
- package/dist/events/index.js +354 -146
- 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 +390 -126
- 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 +286 -116
- package/dist/scopes/index.js +3 -1
- package/opencrvs-toolkit-2.0.0-rc.62a7fbc.tgz +0 -0
- package/package.json +5 -1
- package/tsconfig.tsbuildinfo +1 -1
- package/opencrvs-toolkit-2.0.0-rc.61bee9f.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,
|
|
@@ -702,7 +704,9 @@ var decodeScope = (query) => {
|
|
|
702
704
|
};
|
|
703
705
|
var DEFAULT_SCOPE_OPTIONS = {
|
|
704
706
|
placeOfEvent: JurisdictionFilter.enum.all,
|
|
705
|
-
accessLevel: JurisdictionFilter.enum.all
|
|
707
|
+
accessLevel: JurisdictionFilter.enum.all,
|
|
708
|
+
registeredIn: JurisdictionFilter.enum.all,
|
|
709
|
+
declaredIn: JurisdictionFilter.enum.all
|
|
706
710
|
};
|
|
707
711
|
function getAcceptedScopesByType({
|
|
708
712
|
acceptedScopes,
|
|
@@ -1075,7 +1079,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
|
|
|
1075
1079
|
ShowConditional,
|
|
1076
1080
|
// Action can be shown to the user in the list but as disabled
|
|
1077
1081
|
EnableConditional
|
|
1078
|
-
])
|
|
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
|
+
});
|
|
1079
1086
|
var DisplayOnReviewConditional = z7.object({
|
|
1080
1087
|
type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
|
|
1081
1088
|
conditional: Conditional
|
|
@@ -1090,8 +1097,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
|
|
|
1090
1097
|
// Field output can be shown / hidden on the review page
|
|
1091
1098
|
DisplayOnReviewConditional
|
|
1092
1099
|
]).meta({
|
|
1093
|
-
|
|
1094
|
-
|
|
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."
|
|
1095
1102
|
});
|
|
1096
1103
|
|
|
1097
1104
|
// ../commons/src/events/FieldType.ts
|
|
@@ -1411,28 +1418,20 @@ function schemaPriority(schema) {
|
|
|
1411
1418
|
return idx === -1 ? 9999 : idx;
|
|
1412
1419
|
}
|
|
1413
1420
|
function safeUnion(schemas) {
|
|
1421
|
+
const sortedSchemas = [...schemas].sort(
|
|
1422
|
+
(a, b) => schemaPriority(a) - schemaPriority(b)
|
|
1423
|
+
);
|
|
1414
1424
|
return z12.any().superRefine((val, ctx) => {
|
|
1415
|
-
const
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
if (successful.length === 0) {
|
|
1420
|
-
ctx.addIssue({
|
|
1421
|
-
code: "invalid_type",
|
|
1422
|
-
expected: "custom",
|
|
1423
|
-
message: "Value does not match any schema"
|
|
1424
|
-
});
|
|
1425
|
-
return;
|
|
1426
|
-
}
|
|
1427
|
-
successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
|
|
1428
|
-
const best = successful[0];
|
|
1429
|
-
if (!best.safeParse(val).success) {
|
|
1430
|
-
ctx.addIssue({
|
|
1431
|
-
expected: "custom",
|
|
1432
|
-
code: "invalid_type",
|
|
1433
|
-
message: "Value did not match the best schema"
|
|
1434
|
-
});
|
|
1425
|
+
for (const schema of sortedSchemas) {
|
|
1426
|
+
if (schema.safeParse(val).success) {
|
|
1427
|
+
return;
|
|
1428
|
+
}
|
|
1435
1429
|
}
|
|
1430
|
+
ctx.addIssue({
|
|
1431
|
+
code: "invalid_type",
|
|
1432
|
+
expected: "custom",
|
|
1433
|
+
message: "Value does not match any schema"
|
|
1434
|
+
});
|
|
1436
1435
|
}).meta({
|
|
1437
1436
|
description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
|
|
1438
1437
|
});
|
|
@@ -1742,6 +1741,9 @@ var FlagConfig = z15.object({
|
|
|
1742
1741
|
"Indicates if this flag expects an action to be performed to be cleared."
|
|
1743
1742
|
),
|
|
1744
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."
|
|
1745
1747
|
});
|
|
1746
1748
|
var ActionFlagConfig = z15.object({
|
|
1747
1749
|
id: Flag,
|
|
@@ -1749,6 +1751,9 @@ var ActionFlagConfig = z15.object({
|
|
|
1749
1751
|
conditional: Conditional.optional().describe(
|
|
1750
1752
|
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1751
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."
|
|
1752
1757
|
});
|
|
1753
1758
|
|
|
1754
1759
|
// ../commons/src/events/EventMetadata.ts
|
|
@@ -1770,8 +1775,7 @@ var ActionCreationMetadata = z16.object({
|
|
|
1770
1775
|
),
|
|
1771
1776
|
createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
|
|
1772
1777
|
acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
|
|
1773
|
-
createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
|
|
1774
|
-
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.")
|
|
1775
1779
|
});
|
|
1776
1780
|
var RegistrationCreationMetadata = ActionCreationMetadata.extend({
|
|
1777
1781
|
registrationNumber: z16.string().describe(
|
|
@@ -1799,9 +1803,6 @@ var EventMetadata = z16.object({
|
|
|
1799
1803
|
createdAtLocation: UUID.nullish().describe(
|
|
1800
1804
|
"Location of the user who created the event."
|
|
1801
1805
|
),
|
|
1802
|
-
createdBySignature: DocumentPath.nullish().describe(
|
|
1803
|
-
"Signature of the user who created the event."
|
|
1804
|
-
),
|
|
1805
1806
|
updatedAtLocation: UUID.nullish().describe(
|
|
1806
1807
|
"Location of the user who last changed the status."
|
|
1807
1808
|
),
|
|
@@ -2176,14 +2177,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
|
|
|
2176
2177
|
}
|
|
2177
2178
|
}).describe("Unique identifier for the field");
|
|
2178
2179
|
var FieldReference = import_v43.default.object({
|
|
2179
|
-
$$field: FieldId,
|
|
2180
|
+
$$field: FieldId.describe("Id of the field to reference"),
|
|
2180
2181
|
$$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
|
|
2181
2182
|
'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
|
|
2182
2183
|
)
|
|
2183
2184
|
}).describe("Reference to a field by its ID");
|
|
2184
2185
|
var ValidationConfig = import_v43.default.object({
|
|
2185
|
-
validator: Conditional
|
|
2186
|
-
|
|
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."
|
|
2187
2195
|
});
|
|
2188
2196
|
var requiredSchema = import_v43.default.union([
|
|
2189
2197
|
import_v43.default.boolean(),
|
|
@@ -2222,6 +2230,9 @@ var BaseField = import_v43.default.object({
|
|
|
2222
2230
|
}).describe("Common properties shared across all field types.");
|
|
2223
2231
|
var Divider = BaseField.extend({
|
|
2224
2232
|
type: import_v43.default.literal(FieldType.DIVIDER)
|
|
2233
|
+
}).meta({
|
|
2234
|
+
description: "A horizontal line divider",
|
|
2235
|
+
id: "Divider"
|
|
2225
2236
|
});
|
|
2226
2237
|
var TextField = BaseField.extend({
|
|
2227
2238
|
type: import_v43.default.literal(FieldType.TEXT),
|
|
@@ -2232,7 +2243,10 @@ var TextField = BaseField.extend({
|
|
|
2232
2243
|
prefix: TranslationConfig.optional(),
|
|
2233
2244
|
postfix: TranslationConfig.optional()
|
|
2234
2245
|
}).default({ type: "text" }).optional()
|
|
2235
|
-
}).
|
|
2246
|
+
}).meta({
|
|
2247
|
+
description: "A text input field",
|
|
2248
|
+
id: "TextField"
|
|
2249
|
+
});
|
|
2236
2250
|
var NumberField = BaseField.extend({
|
|
2237
2251
|
type: import_v43.default.literal(FieldType.NUMBER),
|
|
2238
2252
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -2242,7 +2256,10 @@ var NumberField = BaseField.extend({
|
|
|
2242
2256
|
prefix: TranslationConfig.optional(),
|
|
2243
2257
|
postfix: TranslationConfig.optional()
|
|
2244
2258
|
}).optional()
|
|
2245
|
-
}).
|
|
2259
|
+
}).meta({
|
|
2260
|
+
description: "A number input field",
|
|
2261
|
+
id: "NumberField"
|
|
2262
|
+
});
|
|
2246
2263
|
var TextAreaField = BaseField.extend({
|
|
2247
2264
|
type: import_v43.default.literal(FieldType.TEXTAREA),
|
|
2248
2265
|
defaultValue: NonEmptyTextValue.optional(),
|
|
@@ -2253,7 +2270,10 @@ var TextAreaField = BaseField.extend({
|
|
|
2253
2270
|
prefix: TranslationConfig.optional(),
|
|
2254
2271
|
postfix: TranslationConfig.optional()
|
|
2255
2272
|
}).default({ rows: 4 }).optional()
|
|
2256
|
-
}).
|
|
2273
|
+
}).meta({
|
|
2274
|
+
description: "A multiline text input",
|
|
2275
|
+
id: "TextAreaField"
|
|
2276
|
+
});
|
|
2257
2277
|
var ImageMimeType = import_v43.default.enum([
|
|
2258
2278
|
"image/png",
|
|
2259
2279
|
"image/jpg",
|
|
@@ -2283,13 +2303,19 @@ var SignatureField = BaseField.extend({
|
|
|
2283
2303
|
}).default({
|
|
2284
2304
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2285
2305
|
})
|
|
2286
|
-
}).
|
|
2306
|
+
}).meta({
|
|
2307
|
+
description: "A signature input field",
|
|
2308
|
+
id: "SignatureField"
|
|
2309
|
+
});
|
|
2287
2310
|
var EmailField = BaseField.extend({
|
|
2288
2311
|
type: import_v43.default.literal(FieldType.EMAIL),
|
|
2289
2312
|
configuration: import_v43.default.object({
|
|
2290
2313
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
|
|
2291
2314
|
}).default({ maxLength: 255 }).optional(),
|
|
2292
2315
|
defaultValue: NonEmptyTextValue.optional()
|
|
2316
|
+
}).meta({
|
|
2317
|
+
description: "An email input field",
|
|
2318
|
+
id: "EmailField"
|
|
2293
2319
|
});
|
|
2294
2320
|
var DateField = BaseField.extend({
|
|
2295
2321
|
type: import_v43.default.literal(FieldType.DATE),
|
|
@@ -2299,7 +2325,10 @@ var DateField = BaseField.extend({
|
|
|
2299
2325
|
"Text to display above the date input"
|
|
2300
2326
|
).optional()
|
|
2301
2327
|
}).optional()
|
|
2302
|
-
}).
|
|
2328
|
+
}).meta({
|
|
2329
|
+
description: "A date input (yyyy-MM-dd)",
|
|
2330
|
+
id: "DateField"
|
|
2331
|
+
});
|
|
2303
2332
|
var AgeField = BaseField.extend({
|
|
2304
2333
|
type: import_v43.default.literal(FieldType.AGE),
|
|
2305
2334
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -2308,7 +2337,10 @@ var AgeField = BaseField.extend({
|
|
|
2308
2337
|
prefix: TranslationConfig.optional(),
|
|
2309
2338
|
postfix: TranslationConfig.optional()
|
|
2310
2339
|
})
|
|
2311
|
-
}).
|
|
2340
|
+
}).meta({
|
|
2341
|
+
description: "An age input field which uses the current date as the asOfDate",
|
|
2342
|
+
id: "AgeField"
|
|
2343
|
+
});
|
|
2312
2344
|
var TimeField = BaseField.extend({
|
|
2313
2345
|
type: import_v43.default.literal(FieldType.TIME),
|
|
2314
2346
|
defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
|
|
@@ -2318,7 +2350,10 @@ var TimeField = BaseField.extend({
|
|
|
2318
2350
|
"Text to display above the time input"
|
|
2319
2351
|
).optional()
|
|
2320
2352
|
}).optional()
|
|
2321
|
-
}).
|
|
2353
|
+
}).meta({
|
|
2354
|
+
description: "A single time input (HH-mm)",
|
|
2355
|
+
id: "TimeField"
|
|
2356
|
+
});
|
|
2322
2357
|
var DateRangeField = BaseField.extend({
|
|
2323
2358
|
type: import_v43.default.literal(FieldType.DATE_RANGE),
|
|
2324
2359
|
defaultValue: DateRangeFieldValue.optional(),
|
|
@@ -2327,7 +2362,10 @@ var DateRangeField = BaseField.extend({
|
|
|
2327
2362
|
"Text to display above the date input"
|
|
2328
2363
|
).optional()
|
|
2329
2364
|
}).optional()
|
|
2330
|
-
}).
|
|
2365
|
+
}).meta({
|
|
2366
|
+
description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
|
|
2367
|
+
id: "DateRangeField"
|
|
2368
|
+
});
|
|
2331
2369
|
var HtmlFontVariant = import_v43.default.enum([
|
|
2332
2370
|
"reg12",
|
|
2333
2371
|
"reg14",
|
|
@@ -2371,18 +2409,30 @@ var ImageViewField = BaseField.extend({
|
|
|
2371
2409
|
type: import_v43.default.literal(FieldType.IMAGE_VIEW),
|
|
2372
2410
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2373
2411
|
configuration: ImageConfiguration
|
|
2374
|
-
}).
|
|
2412
|
+
}).meta({
|
|
2413
|
+
description: "A read-only image component for form pages",
|
|
2414
|
+
id: "ImageViewField"
|
|
2415
|
+
});
|
|
2375
2416
|
var Paragraph = BaseField.extend({
|
|
2376
2417
|
type: import_v43.default.literal(FieldType.PARAGRAPH),
|
|
2377
2418
|
configuration: ParagraphConfiguration
|
|
2378
|
-
}).
|
|
2419
|
+
}).meta({
|
|
2420
|
+
description: "A read-only HTML <p> paragraph",
|
|
2421
|
+
id: "Paragraph"
|
|
2422
|
+
});
|
|
2379
2423
|
var Heading = BaseField.extend({
|
|
2380
2424
|
type: import_v43.default.literal(FieldType.HEADING),
|
|
2381
2425
|
configuration: HeadingConfiguration
|
|
2382
|
-
}).
|
|
2426
|
+
}).meta({
|
|
2427
|
+
description: "A read-only heading component for form pages",
|
|
2428
|
+
id: "Heading"
|
|
2429
|
+
});
|
|
2383
2430
|
var PageHeader = BaseField.extend({
|
|
2384
2431
|
type: import_v43.default.literal(FieldType.PAGE_HEADER)
|
|
2385
|
-
}).
|
|
2432
|
+
}).meta({
|
|
2433
|
+
description: "A read-only header component for form pages",
|
|
2434
|
+
id: "PageHeader"
|
|
2435
|
+
});
|
|
2386
2436
|
var File = BaseField.extend({
|
|
2387
2437
|
type: import_v43.default.literal(FieldType.FILE),
|
|
2388
2438
|
defaultValue: FileFieldValue.optional(),
|
|
@@ -2401,7 +2451,10 @@ var File = BaseField.extend({
|
|
|
2401
2451
|
}).default({
|
|
2402
2452
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2403
2453
|
})
|
|
2404
|
-
}).
|
|
2454
|
+
}).meta({
|
|
2455
|
+
description: "A file upload field",
|
|
2456
|
+
id: "File"
|
|
2457
|
+
});
|
|
2405
2458
|
var SelectOption = import_v43.default.object({
|
|
2406
2459
|
value: import_v43.default.string().describe("The value of the option"),
|
|
2407
2460
|
label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
|
|
@@ -2418,7 +2471,10 @@ var NumberWithUnitField = BaseField.extend({
|
|
|
2418
2471
|
"Placeholder for the number field"
|
|
2419
2472
|
)
|
|
2420
2473
|
}).optional()
|
|
2421
|
-
}).
|
|
2474
|
+
}).meta({
|
|
2475
|
+
description: "A number with unit input field",
|
|
2476
|
+
id: "NumberWithUnitField"
|
|
2477
|
+
});
|
|
2422
2478
|
var RadioGroup = BaseField.extend({
|
|
2423
2479
|
type: import_v43.default.literal(FieldType.RADIO_GROUP),
|
|
2424
2480
|
defaultValue: TextValue.optional(),
|
|
@@ -2428,7 +2484,10 @@ var RadioGroup = BaseField.extend({
|
|
|
2428
2484
|
size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
|
|
2429
2485
|
}).optional()
|
|
2430
2486
|
}).optional()
|
|
2431
|
-
}).
|
|
2487
|
+
}).meta({
|
|
2488
|
+
description: "A grouped radio button field",
|
|
2489
|
+
id: "RadioGroup"
|
|
2490
|
+
});
|
|
2432
2491
|
var BulletList = BaseField.extend({
|
|
2433
2492
|
type: import_v43.default.literal(FieldType.BULLET_LIST),
|
|
2434
2493
|
items: import_v43.default.array(TranslationConfig).describe("A list of items"),
|
|
@@ -2437,7 +2496,10 @@ var BulletList = BaseField.extend({
|
|
|
2437
2496
|
fontVariant: HtmlFontVariant.optional()
|
|
2438
2497
|
}).optional()
|
|
2439
2498
|
}).default({})
|
|
2440
|
-
}).
|
|
2499
|
+
}).meta({
|
|
2500
|
+
description: "A list of bullet points",
|
|
2501
|
+
id: "BulletList"
|
|
2502
|
+
});
|
|
2441
2503
|
var Select = BaseField.extend({
|
|
2442
2504
|
type: import_v43.default.literal(FieldType.SELECT),
|
|
2443
2505
|
defaultValue: TextValue.optional(),
|
|
@@ -2452,7 +2514,10 @@ var Select = BaseField.extend({
|
|
|
2452
2514
|
{ ..., defaultMessage: "'{input}' is not listed among the health facilities." }
|
|
2453
2515
|
`
|
|
2454
2516
|
)
|
|
2455
|
-
}).
|
|
2517
|
+
}).meta({
|
|
2518
|
+
description: "A select input field",
|
|
2519
|
+
id: "Select"
|
|
2520
|
+
});
|
|
2456
2521
|
var SelectDateRangeOption = import_v43.default.object({
|
|
2457
2522
|
value: SelectDateRangeValue.describe("The value of the option"),
|
|
2458
2523
|
label: TranslationConfig.describe("The label of the option")
|
|
@@ -2461,7 +2526,10 @@ var SelectDateRangeField = BaseField.extend({
|
|
|
2461
2526
|
type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
|
|
2462
2527
|
defaultValue: SelectDateRangeValue.optional(),
|
|
2463
2528
|
options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
|
|
2464
|
-
}).
|
|
2529
|
+
}).meta({
|
|
2530
|
+
description: "A date range selection field",
|
|
2531
|
+
id: "SelectDateRangeField"
|
|
2532
|
+
});
|
|
2465
2533
|
var NameConfig = import_v43.default.object({
|
|
2466
2534
|
firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
2467
2535
|
middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
@@ -2492,26 +2560,41 @@ var NameField = BaseField.extend({
|
|
|
2492
2560
|
surname: { required: true }
|
|
2493
2561
|
}
|
|
2494
2562
|
}).optional()
|
|
2495
|
-
}).
|
|
2563
|
+
}).meta({
|
|
2564
|
+
description: "A field for entering a persons name",
|
|
2565
|
+
id: "NameField"
|
|
2566
|
+
});
|
|
2496
2567
|
var PhoneField = BaseField.extend({
|
|
2497
2568
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2498
2569
|
type: import_v43.default.literal(FieldType.PHONE)
|
|
2499
|
-
}).
|
|
2570
|
+
}).meta({
|
|
2571
|
+
description: "A field for entering a phone number",
|
|
2572
|
+
id: "PhoneField"
|
|
2573
|
+
});
|
|
2500
2574
|
var IdField = BaseField.extend({
|
|
2501
2575
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2502
2576
|
type: import_v43.default.literal(FieldType.ID)
|
|
2503
|
-
}).
|
|
2577
|
+
}).meta({
|
|
2578
|
+
description: "A field for entering an ID",
|
|
2579
|
+
id: "IdField"
|
|
2580
|
+
});
|
|
2504
2581
|
var Checkbox = BaseField.extend({
|
|
2505
2582
|
type: import_v43.default.literal(FieldType.CHECKBOX),
|
|
2506
2583
|
defaultValue: CheckboxFieldValue.default(false)
|
|
2507
|
-
}).
|
|
2584
|
+
}).meta({
|
|
2585
|
+
description: "A boolean checkbox field",
|
|
2586
|
+
id: "Checkbox"
|
|
2587
|
+
});
|
|
2508
2588
|
var Country = BaseField.extend({
|
|
2509
2589
|
type: import_v43.default.literal(FieldType.COUNTRY),
|
|
2510
2590
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2511
2591
|
optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
|
|
2512
2592
|
"Conditionals for specific countries. Countries not listed are always shown and enabled."
|
|
2513
2593
|
)
|
|
2514
|
-
}).
|
|
2594
|
+
}).meta({
|
|
2595
|
+
description: "A field for selecting a country",
|
|
2596
|
+
id: "Country"
|
|
2597
|
+
});
|
|
2515
2598
|
var AllowedLocations = JurisdictionReference.optional().describe(
|
|
2516
2599
|
"Limits which location options are selectable depending on user jurisdiction and location."
|
|
2517
2600
|
);
|
|
@@ -2520,16 +2603,18 @@ var AdministrativeAreas = import_v43.default.enum([
|
|
|
2520
2603
|
"HEALTH_FACILITY",
|
|
2521
2604
|
"CRVS_OFFICE"
|
|
2522
2605
|
]);
|
|
2523
|
-
var AdministrativeAreaConfiguration = import_v43.default.object({
|
|
2524
|
-
partOf: FieldReference.optional().describe("Parent location"),
|
|
2525
|
-
type: AdministrativeAreas,
|
|
2526
|
-
allowedLocations: AllowedLocations
|
|
2527
|
-
}).describe("Administrative area options");
|
|
2528
2606
|
var AdministrativeAreaField = BaseField.extend({
|
|
2529
2607
|
type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
|
|
2530
2608
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
2531
|
-
configuration:
|
|
2532
|
-
|
|
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
|
+
});
|
|
2533
2618
|
var LocationInput = BaseField.extend({
|
|
2534
2619
|
type: import_v43.default.literal(FieldType.LOCATION),
|
|
2535
2620
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
@@ -2537,7 +2622,10 @@ var LocationInput = BaseField.extend({
|
|
|
2537
2622
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
2538
2623
|
allowedLocations: AllowedLocations
|
|
2539
2624
|
}).optional()
|
|
2540
|
-
}).
|
|
2625
|
+
}).meta({
|
|
2626
|
+
description: "A field for selecting a location",
|
|
2627
|
+
id: "LocationInput"
|
|
2628
|
+
});
|
|
2541
2629
|
var FileUploadWithOptions = BaseField.extend({
|
|
2542
2630
|
type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
|
|
2543
2631
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
@@ -2551,6 +2639,9 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
2551
2639
|
}).default({
|
|
2552
2640
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2553
2641
|
})
|
|
2642
|
+
}).meta({
|
|
2643
|
+
description: "A field for uploading files with file type options",
|
|
2644
|
+
id: "FileUploadWithOptions"
|
|
2554
2645
|
});
|
|
2555
2646
|
var Facility = BaseField.extend({
|
|
2556
2647
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
@@ -2596,7 +2687,10 @@ var Address = BaseField.extend({
|
|
|
2596
2687
|
allowedLocations: AllowedLocations
|
|
2597
2688
|
}).optional(),
|
|
2598
2689
|
defaultValue: DefaultAddressFieldValue.optional()
|
|
2599
|
-
}).
|
|
2690
|
+
}).meta({
|
|
2691
|
+
description: "Address input field \u2013 a combination of location and text fields",
|
|
2692
|
+
id: "Address"
|
|
2693
|
+
});
|
|
2600
2694
|
var StaticDataEntry = import_v43.default.object({
|
|
2601
2695
|
id: import_v43.default.string().describe("ID for the data entry."),
|
|
2602
2696
|
label: TranslationConfig,
|
|
@@ -2611,7 +2705,10 @@ var DataField = BaseField.extend({
|
|
|
2611
2705
|
subtitle: TranslationConfig.optional(),
|
|
2612
2706
|
data: import_v43.default.array(DataEntry)
|
|
2613
2707
|
})
|
|
2614
|
-
}).
|
|
2708
|
+
}).meta({
|
|
2709
|
+
description: "A field for displaying a table of read-only data",
|
|
2710
|
+
id: "DataField"
|
|
2711
|
+
});
|
|
2615
2712
|
var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
|
|
2616
2713
|
var ButtonType = import_v43.default.enum([
|
|
2617
2714
|
"primary",
|
|
@@ -2638,11 +2735,17 @@ var ButtonField = BaseField.extend({
|
|
|
2638
2735
|
type: import_v43.default.literal(FieldType.BUTTON),
|
|
2639
2736
|
defaultValue: ButtonFieldValue.optional(),
|
|
2640
2737
|
configuration: ButtonConfiguration
|
|
2641
|
-
}).
|
|
2738
|
+
}).meta({
|
|
2739
|
+
description: "A generic button that can be used to trigger an action",
|
|
2740
|
+
id: "ButtonField"
|
|
2741
|
+
});
|
|
2642
2742
|
var FieldGroup = BaseField.extend({
|
|
2643
2743
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
2644
2744
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
2645
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"
|
|
2646
2749
|
});
|
|
2647
2750
|
var AlphaPrintButton = BaseField.extend({
|
|
2648
2751
|
type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
|
|
@@ -2652,7 +2755,10 @@ var AlphaPrintButton = BaseField.extend({
|
|
|
2652
2755
|
"Label for the print button"
|
|
2653
2756
|
)
|
|
2654
2757
|
})
|
|
2655
|
-
}).
|
|
2758
|
+
}).meta({
|
|
2759
|
+
description: "An experimental print button field for printing certificates during the declaration process",
|
|
2760
|
+
id: "AlphaPrintButton"
|
|
2761
|
+
});
|
|
2656
2762
|
var HttpField = BaseField.extend({
|
|
2657
2763
|
type: import_v43.default.literal(FieldType.HTTP),
|
|
2658
2764
|
defaultValue: HttpFieldValue.optional(),
|
|
@@ -2668,20 +2774,30 @@ var HttpField = BaseField.extend({
|
|
|
2668
2774
|
params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
|
|
2669
2775
|
timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
|
|
2670
2776
|
})
|
|
2671
|
-
}).
|
|
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
|
+
});
|
|
2672
2781
|
var AutocompleteField = BaseField.extend({
|
|
2673
2782
|
type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
|
|
2674
2783
|
configuration: import_v43.default.object({
|
|
2675
|
-
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(),
|
|
2676
2787
|
method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
|
|
2677
2788
|
defaultOptions: import_v43.default.array(
|
|
2678
2789
|
import_v43.default.object({
|
|
2679
2790
|
label: import_v43.default.string(),
|
|
2680
2791
|
value: import_v43.default.string()
|
|
2681
2792
|
})
|
|
2682
|
-
).optional()
|
|
2793
|
+
).optional().describe(
|
|
2794
|
+
"Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
|
|
2795
|
+
)
|
|
2683
2796
|
})
|
|
2684
|
-
}).
|
|
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
|
+
});
|
|
2685
2801
|
var SearchField = HttpField.extend({
|
|
2686
2802
|
type: import_v43.default.literal(FieldType.SEARCH),
|
|
2687
2803
|
configuration: SearchQuery.pick({
|
|
@@ -2714,6 +2830,9 @@ var SearchField = HttpField.extend({
|
|
|
2714
2830
|
ok: TranslationConfig.optional()
|
|
2715
2831
|
}).optional()
|
|
2716
2832
|
})
|
|
2833
|
+
}).meta({
|
|
2834
|
+
description: "A search input field",
|
|
2835
|
+
id: "SearchField"
|
|
2717
2836
|
});
|
|
2718
2837
|
var LinkButtonField = BaseField.extend({
|
|
2719
2838
|
type: import_v43.default.literal(FieldType.LINK_BUTTON),
|
|
@@ -2722,7 +2841,10 @@ var LinkButtonField = BaseField.extend({
|
|
|
2722
2841
|
text: TranslationConfig.describe("Text to display on the button"),
|
|
2723
2842
|
icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
|
|
2724
2843
|
})
|
|
2725
|
-
}).
|
|
2844
|
+
}).meta({
|
|
2845
|
+
description: "A button that opens a URL link",
|
|
2846
|
+
id: "LinkButtonField"
|
|
2847
|
+
});
|
|
2726
2848
|
var VerificationStatus = BaseField.extend({
|
|
2727
2849
|
type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
|
|
2728
2850
|
defaultValue: VerificationStatusValue.optional(),
|
|
@@ -2732,15 +2854,19 @@ var VerificationStatus = BaseField.extend({
|
|
|
2732
2854
|
"Explaining text on the banner in form."
|
|
2733
2855
|
)
|
|
2734
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"
|
|
2735
2860
|
});
|
|
2736
2861
|
var QueryParamReaderField = BaseField.extend({
|
|
2737
2862
|
type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
|
|
2738
2863
|
configuration: import_v43.default.object({
|
|
2739
2864
|
pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
|
|
2740
2865
|
})
|
|
2741
|
-
}).
|
|
2742
|
-
"A field that maps URL query params into form values and clears them afterward"
|
|
2743
|
-
|
|
2866
|
+
}).meta({
|
|
2867
|
+
description: "A field that maps URL query params into form values and clears them afterward",
|
|
2868
|
+
id: "QueryParamReaderField"
|
|
2869
|
+
});
|
|
2744
2870
|
var QrReaderField = BaseField.extend({
|
|
2745
2871
|
type: import_v43.default.literal(FieldType.QR_READER),
|
|
2746
2872
|
defaultValue: QrReaderFieldValue.optional(),
|
|
@@ -2751,7 +2877,7 @@ var QrReaderField = BaseField.extend({
|
|
|
2751
2877
|
})
|
|
2752
2878
|
}).optional()
|
|
2753
2879
|
}).meta({
|
|
2754
|
-
description: "
|
|
2880
|
+
description: "QR code reader field, including optional JSON Schema validator.",
|
|
2755
2881
|
id: "QrReaderField"
|
|
2756
2882
|
});
|
|
2757
2883
|
var IdReaderField = BaseField.extend({
|
|
@@ -2760,12 +2886,18 @@ var IdReaderField = BaseField.extend({
|
|
|
2760
2886
|
methods: import_v43.default.array(
|
|
2761
2887
|
import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
|
|
2762
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"
|
|
2763
2892
|
});
|
|
2764
2893
|
var CustomField = BaseField.extend({
|
|
2765
2894
|
type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
|
|
2766
2895
|
defaultValue: CustomFieldValue.optional(),
|
|
2767
2896
|
src: import_v43.default.string().describe("Module source path for the custom field component"),
|
|
2768
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"
|
|
2769
2901
|
});
|
|
2770
2902
|
var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
|
|
2771
2903
|
var LoaderField = BaseField.extend({
|
|
@@ -2775,22 +2907,25 @@ var LoaderField = BaseField.extend({
|
|
|
2775
2907
|
configuration: import_v43.default.object({
|
|
2776
2908
|
text: TranslationConfig.describe("Display text above the loading spinner")
|
|
2777
2909
|
})
|
|
2778
|
-
}).
|
|
2779
|
-
"A non-interactive field that indicates an in progress operation in form"
|
|
2780
|
-
|
|
2910
|
+
}).meta({
|
|
2911
|
+
description: "A non-interactive field that indicates an in progress operation in form",
|
|
2912
|
+
id: "LoaderField"
|
|
2913
|
+
});
|
|
2781
2914
|
var HiddenField = BaseField.extend({
|
|
2782
2915
|
type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
|
|
2783
2916
|
required: import_v43.default.boolean().default(false).optional(),
|
|
2784
2917
|
defaultValue: TextValue.optional()
|
|
2785
|
-
}).
|
|
2786
|
-
"A non-interactive, hidden field that only hold a value in the form"
|
|
2787
|
-
|
|
2918
|
+
}).meta({
|
|
2919
|
+
description: "A non-interactive, hidden field that only hold a value in the form",
|
|
2920
|
+
id: "HiddenField"
|
|
2921
|
+
});
|
|
2788
2922
|
var UserRoleField = BaseField.extend({
|
|
2789
2923
|
type: import_v43.default.literal(FieldType.USER_ROLE),
|
|
2790
2924
|
defaultValue: TextValue.optional()
|
|
2791
|
-
}).
|
|
2792
|
-
"A select dropdown that is automatically populated with available user roles"
|
|
2793
|
-
|
|
2925
|
+
}).meta({
|
|
2926
|
+
description: "A select dropdown that is automatically populated with available user roles",
|
|
2927
|
+
id: "UserRoleField"
|
|
2928
|
+
});
|
|
2794
2929
|
var FieldConfig = import_v43.default.discriminatedUnion("type", [
|
|
2795
2930
|
FieldGroup,
|
|
2796
2931
|
Address,
|
|
@@ -2889,16 +3024,19 @@ var VerificationPageConfig = FormPageConfig.extend({
|
|
|
2889
3024
|
type: z21.literal(PageTypes.enum.VERIFICATION),
|
|
2890
3025
|
actions: VerificationActionConfig
|
|
2891
3026
|
});
|
|
2892
|
-
var PageConfig = z21.discriminatedUnion("type", [
|
|
2893
|
-
|
|
2894
|
-
|
|
2895
|
-
|
|
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
|
+
});
|
|
2896
3031
|
|
|
2897
3032
|
// ../commons/src/events/FormConfig.ts
|
|
2898
3033
|
var DeclarationFormConfig = z22.object({
|
|
2899
3034
|
label: TranslationConfig.describe("Human readable description of the form"),
|
|
2900
3035
|
pages: z22.array(FormPageConfig)
|
|
2901
|
-
}).
|
|
3036
|
+
}).meta({
|
|
3037
|
+
id: "DeclarationFormConfig",
|
|
3038
|
+
description: "Configuration of the declaration form."
|
|
3039
|
+
});
|
|
2902
3040
|
var ActionFormConfig = z22.object({
|
|
2903
3041
|
label: TranslationConfig.describe("Human readable description of the form"),
|
|
2904
3042
|
pages: z22.array(PageConfig)
|
|
@@ -2998,6 +3136,9 @@ var DeduplicationConfig = z23.object({
|
|
|
2998
3136
|
id: z23.string(),
|
|
2999
3137
|
label: TranslationConfig,
|
|
3000
3138
|
query: Clause
|
|
3139
|
+
}).meta({
|
|
3140
|
+
id: "DeduplicationConfig",
|
|
3141
|
+
description: "Configuration for duplicate detection on a declare or register action. The query is built from fuzzy / strict / date-range matchers combined with and/or/not."
|
|
3001
3142
|
});
|
|
3002
3143
|
|
|
3003
3144
|
// ../commons/src/events/ActionConfig.ts
|
|
@@ -3115,17 +3256,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
|
|
|
3115
3256
|
* OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
|
|
3116
3257
|
* and treat them as "models" instead of duplicating the data structure in each endpoint.
|
|
3117
3258
|
*/
|
|
3118
|
-
ReadActionConfig.meta({
|
|
3119
|
-
|
|
3120
|
-
|
|
3121
|
-
|
|
3259
|
+
ReadActionConfig.meta({
|
|
3260
|
+
id: "ReadActionConfig",
|
|
3261
|
+
description: "Configuration for the read action \u2014 defines the record-tab content displayed on the event overview page."
|
|
3262
|
+
}),
|
|
3263
|
+
DeclareConfig.meta({
|
|
3264
|
+
id: "DeclareActionConfig",
|
|
3265
|
+
description: "Configuration for the declare action. Includes review-page fields. Shared with the notify action (ActionType.NOTIFY)."
|
|
3266
|
+
}),
|
|
3267
|
+
RejectConfig.meta({
|
|
3268
|
+
id: "RejectActionConfig",
|
|
3269
|
+
description: "Configuration for rejecting a record before registration."
|
|
3270
|
+
}),
|
|
3271
|
+
RegisterConfig.meta({
|
|
3272
|
+
id: "RegisterActionConfig",
|
|
3273
|
+
description: "Configuration for registering a record."
|
|
3274
|
+
}),
|
|
3122
3275
|
PrintCertificateActionConfig.meta({
|
|
3123
|
-
id: "PrintCertificateActionConfig"
|
|
3276
|
+
id: "PrintCertificateActionConfig",
|
|
3277
|
+
description: "Configuration for printing a certificate of a registered record."
|
|
3278
|
+
}),
|
|
3279
|
+
RequestCorrectionConfig.meta({
|
|
3280
|
+
id: "RequestCorrectionActionConfig",
|
|
3281
|
+
description: "Configuration for requesting a correction on a registered record."
|
|
3282
|
+
}),
|
|
3283
|
+
EditActionConfig.meta({
|
|
3284
|
+
id: "EditActionConfig",
|
|
3285
|
+
description: "Configuration for editing a record before registration."
|
|
3124
3286
|
}),
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3128
|
-
|
|
3287
|
+
ArchiveConfig.meta({
|
|
3288
|
+
id: "ArchiveActionConfig",
|
|
3289
|
+
description: "Configuration for archiving a record."
|
|
3290
|
+
}),
|
|
3291
|
+
CustomActionConfig.meta({
|
|
3292
|
+
id: "CustomActionConfig",
|
|
3293
|
+
description: "Configuration for a country-defined custom action. An event may include any number of these."
|
|
3294
|
+
})
|
|
3129
3295
|
]).describe(
|
|
3130
3296
|
"Configuration of an action available for an event. Data collected depends on the action type and is accessible through the annotation property in ActionDocument."
|
|
3131
3297
|
).meta({ id: "ActionConfig" });
|
|
@@ -3201,7 +3367,10 @@ var Field = BaseField2.extend({
|
|
|
3201
3367
|
}).describe("Custom field defined for the summary view.");
|
|
3202
3368
|
var SummaryConfig = z27.object({
|
|
3203
3369
|
fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
|
|
3204
|
-
}).
|
|
3370
|
+
}).meta({
|
|
3371
|
+
id: "SummaryConfig",
|
|
3372
|
+
description: "Configuration of the event overview page. Defines which declaration fields appear in the record summary, optionally with custom labels, empty-value messages, and templated values."
|
|
3373
|
+
});
|
|
3205
3374
|
|
|
3206
3375
|
// ../commons/src/events/AdvancedSearchConfig.ts
|
|
3207
3376
|
var z28 = __toESM(require("zod/v4"));
|
|
@@ -3325,6 +3494,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
|
|
|
3325
3494
|
var AdvancedSearchConfig = z28.object({
|
|
3326
3495
|
title: TranslationConfig.describe("Advanced search tab title"),
|
|
3327
3496
|
fields: z28.array(AdvancedSearchField).describe("Advanced search fields within the tab.")
|
|
3497
|
+
}).meta({
|
|
3498
|
+
id: "AdvancedSearchConfig",
|
|
3499
|
+
description: "Configuration of one advanced search tab. Each tab has a title and a list of searchable fields \u2014 either declaration fields (via `field()`) or event metadata (via `event()`)."
|
|
3328
3500
|
});
|
|
3329
3501
|
|
|
3330
3502
|
// ../commons/src/events/utils.ts
|
|
@@ -3801,6 +3973,9 @@ function precompileActionSchemas(eventConfigurations) {
|
|
|
3801
3973
|
function isAgeValue(value) {
|
|
3802
3974
|
return typeof value === "object" && value !== null && "age" in value && typeof value.age === "number";
|
|
3803
3975
|
}
|
|
3976
|
+
function mergeWithBaseFormState(values, context) {
|
|
3977
|
+
return { ...context.baseFormState, ...values };
|
|
3978
|
+
}
|
|
3804
3979
|
function validate(schema, data) {
|
|
3805
3980
|
const validator = ajv.getSchema(schema.$id) || ajv.compile(schema);
|
|
3806
3981
|
if ("$form" in data) {
|
|
@@ -3839,7 +4014,7 @@ function isOnline() {
|
|
|
3839
4014
|
}
|
|
3840
4015
|
function isConditionMet(conditional, values, context, eventIndex) {
|
|
3841
4016
|
return validate(conditional, {
|
|
3842
|
-
$form: values,
|
|
4017
|
+
$form: mergeWithBaseFormState(values, context),
|
|
3843
4018
|
$now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
|
|
3844
4019
|
$online: isOnline(),
|
|
3845
4020
|
$user: context.user,
|
|
@@ -3868,7 +4043,7 @@ function isFieldConditionMet(field3, form, conditionalType, context) {
|
|
|
3868
4043
|
return true;
|
|
3869
4044
|
}
|
|
3870
4045
|
const validConditionals = getConditionalActionsForField(field3, {
|
|
3871
|
-
$form: form,
|
|
4046
|
+
$form: mergeWithBaseFormState(form, context),
|
|
3872
4047
|
$now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
|
|
3873
4048
|
$online: isOnline(),
|
|
3874
4049
|
$user: context.user,
|
|
@@ -4060,7 +4235,7 @@ function runFieldValidations({
|
|
|
4060
4235
|
return [];
|
|
4061
4236
|
}
|
|
4062
4237
|
const conditionalParameters = {
|
|
4063
|
-
$form: form,
|
|
4238
|
+
$form: mergeWithBaseFormState(form, context),
|
|
4064
4239
|
$now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
|
|
4065
4240
|
/**
|
|
4066
4241
|
* In real use cases, there can be hundreds of thousands of locations.
|
|
@@ -4304,17 +4479,16 @@ function isPageVisible(page, formValues, context) {
|
|
|
4304
4479
|
}
|
|
4305
4480
|
return isConditionMet(page.conditional, formValues, context);
|
|
4306
4481
|
}
|
|
4307
|
-
function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false
|
|
4482
|
+
function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false) {
|
|
4308
4483
|
const base = (0, import_lodash.cloneDeep)(formValues);
|
|
4309
4484
|
function fn(prevVisibilityContext) {
|
|
4310
|
-
const visibilityForm = declarationContext ? { ...declarationContext, ...prevVisibilityContext } : prevVisibilityContext;
|
|
4311
4485
|
const cleaned = (0, import_lodash.omitBy)(base, (value, fieldId) => {
|
|
4312
4486
|
const fieldConfig = fields.filter((f) => f.id === fieldId);
|
|
4313
4487
|
if (!fieldConfig.length) {
|
|
4314
4488
|
return false;
|
|
4315
4489
|
}
|
|
4316
4490
|
const isHidden = fieldConfig.every(
|
|
4317
|
-
(f) => !isFieldVisible(f,
|
|
4491
|
+
(f) => !isFieldVisible(f, prevVisibilityContext, validatorContext)
|
|
4318
4492
|
);
|
|
4319
4493
|
if (!isHidden) {
|
|
4320
4494
|
return false;
|
|
@@ -4332,7 +4506,7 @@ function omitHiddenPaginatedFields(formConfig, values, validatorContext, include
|
|
|
4332
4506
|
const visibleFields = formConfig.pages.filter((p) => isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
|
|
4333
4507
|
const hiddenFields = formConfig.pages.filter((p) => !isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
|
|
4334
4508
|
const valuesExceptHiddenPage = (0, import_lodash.omitBy)(values, (_2, fieldId) => {
|
|
4335
|
-
return hiddenFields.some((f) => f.id === fieldId);
|
|
4509
|
+
return hiddenFields.some((f) => f.id === fieldId) && !visibleFields.some((f) => f.id === fieldId);
|
|
4336
4510
|
});
|
|
4337
4511
|
return omitHiddenFields(
|
|
4338
4512
|
visibleFields,
|
|
@@ -4379,13 +4553,10 @@ function getVisibleVerificationPageIds(pages, annotation, context) {
|
|
|
4379
4553
|
}
|
|
4380
4554
|
function omitHiddenAnnotationFields(actionConfig, declaration, annotation, context) {
|
|
4381
4555
|
const annotationFields = getActionAnnotationFields(actionConfig);
|
|
4382
|
-
return omitHiddenFields(
|
|
4383
|
-
|
|
4384
|
-
|
|
4385
|
-
|
|
4386
|
-
false,
|
|
4387
|
-
declaration
|
|
4388
|
-
);
|
|
4556
|
+
return omitHiddenFields(annotationFields, annotation, {
|
|
4557
|
+
...context,
|
|
4558
|
+
baseFormState: declaration
|
|
4559
|
+
});
|
|
4389
4560
|
}
|
|
4390
4561
|
function deepMerge(currentDocument, actionDocument) {
|
|
4391
4562
|
const currentDocumentClone = (0, import_lodash.cloneDeep)(currentDocument);
|
|
@@ -5374,7 +5545,7 @@ var _EventConfigBase = z33.object({
|
|
|
5374
5545
|
),
|
|
5375
5546
|
label: TranslationConfig.describe("Human-readable label for the event type."),
|
|
5376
5547
|
actions: z33.array(ActionConfig).describe(
|
|
5377
|
-
"Configuration of
|
|
5548
|
+
"Configuration of core and custom actions associated with the event."
|
|
5378
5549
|
),
|
|
5379
5550
|
actionOrder: z33.array(z33.string()).optional().describe(
|
|
5380
5551
|
"Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
|
|
@@ -5386,7 +5557,7 @@ var _EventConfigBase = z33.object({
|
|
|
5386
5557
|
"Configuration of fields available in the advanced search feature."
|
|
5387
5558
|
),
|
|
5388
5559
|
flags: z33.array(FlagConfig).optional().default([]).describe(
|
|
5389
|
-
"Configuration of flags associated with the actions of this event type."
|
|
5560
|
+
"Configuration of custom flags associated with the actions of this event type."
|
|
5390
5561
|
),
|
|
5391
5562
|
analytics: z33.boolean().optional().default(true).describe(
|
|
5392
5563
|
"Indicates whether the records of this event type are included in analytics"
|
|
@@ -5399,8 +5570,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
|
|
|
5399
5570
|
validateActionFlags(event2, ctx);
|
|
5400
5571
|
validateActionOrder(event2, ctx);
|
|
5401
5572
|
}).meta({
|
|
5402
|
-
id: "EventConfig"
|
|
5403
|
-
|
|
5573
|
+
id: "EventConfig",
|
|
5574
|
+
description: "Configuration defining an event type registered in OpenCRVS (for example birth or death)."
|
|
5575
|
+
});
|
|
5404
5576
|
|
|
5405
5577
|
// ../commons/src/events/EventConfigInput.ts
|
|
5406
5578
|
var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
|
|
@@ -5623,6 +5795,9 @@ var WorkqueueColumnValue = z34.object({
|
|
|
5623
5795
|
var WorkqueueColumn = z34.object({
|
|
5624
5796
|
label: TranslationConfig,
|
|
5625
5797
|
value: WorkqueueColumnValue
|
|
5798
|
+
}).meta({
|
|
5799
|
+
id: "WorkqueueColumn",
|
|
5800
|
+
description: "Configuration for a single workqueue column. The value references an event metadata key (e.g. `dateOfEvent`, `status`, `trackingId`)."
|
|
5626
5801
|
});
|
|
5627
5802
|
function defineWorkqueuesColumns(workqueueColumns) {
|
|
5628
5803
|
return workqueueColumns.map(
|
|
@@ -5825,18 +6000,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
|
|
|
5825
6000
|
query: true,
|
|
5826
6001
|
columns: true
|
|
5827
6002
|
});
|
|
5828
|
-
var WorkqueueConfigInput =
|
|
5829
|
-
|
|
5830
|
-
|
|
5831
|
-
|
|
5832
|
-
|
|
5833
|
-
query: CountryConfigQueryInputType,
|
|
5834
|
-
action: z37.object({ type: WorkqueueActionType }).optional().describe(
|
|
5835
|
-
"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."
|
|
5836
|
-
),
|
|
5837
|
-
columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
|
|
5838
|
-
icon: AvailableIcons,
|
|
5839
|
-
emptyMessage: TranslationConfig.optional()
|
|
6003
|
+
var WorkqueueConfigInput = WorkqueueConfig.extend({
|
|
6004
|
+
query: CountryConfigQueryInputType
|
|
6005
|
+
}).meta({
|
|
6006
|
+
id: "WorkqueueConfig",
|
|
6007
|
+
description: "Configuration for a single workqueue. Defines the filter applied to the event index, the quick-action button, the columns shown on each row, and the message rendered when the queue is empty."
|
|
5840
6008
|
});
|
|
5841
6009
|
function defineWorkqueue(workqueueInput) {
|
|
5842
6010
|
const queryInput = workqueueInput.query;
|
|
@@ -5897,6 +6065,9 @@ var BaseActionInput = z38.object({
|
|
|
5897
6065
|
originalActionId: UUID.optional(),
|
|
5898
6066
|
// should not be part of base action.
|
|
5899
6067
|
keepAssignment: z38.boolean().optional(),
|
|
6068
|
+
keepAssignmentIfAccepted: z38.boolean().optional(),
|
|
6069
|
+
keepAssignmentIfRejected: z38.boolean().optional(),
|
|
6070
|
+
waitFor: z38.boolean().optional(),
|
|
5900
6071
|
// For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
|
|
5901
6072
|
// @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
|
|
5902
6073
|
createdAtLocation: UUID.nullish().describe(
|
|
@@ -6150,7 +6321,6 @@ function getDeclarationActionCreationMetadata(actionType, actions) {
|
|
|
6150
6321
|
createdAtLocation: requestAction?.createdAtLocation ?? acceptAction.createdAtLocation,
|
|
6151
6322
|
acceptedAt: acceptAction.createdAt,
|
|
6152
6323
|
createdByRole: requestAction?.createdByRole ?? acceptAction.createdByRole,
|
|
6153
|
-
createdBySignature: requestAction?.createdBySignature ?? acceptAction.createdBySignature,
|
|
6154
6324
|
registrationNumber
|
|
6155
6325
|
};
|
|
6156
6326
|
}
|
|
@@ -6364,17 +6534,6 @@ function getAssignedUserFromActions(actions) {
|
|
|
6364
6534
|
return user2;
|
|
6365
6535
|
}, null);
|
|
6366
6536
|
}
|
|
6367
|
-
function getAssignedUserSignatureFromActions(actions) {
|
|
6368
|
-
return actions.reduce((signature, action) => {
|
|
6369
|
-
if (action.type === ActionType.ASSIGN) {
|
|
6370
|
-
return action.createdBySignature || null;
|
|
6371
|
-
}
|
|
6372
|
-
if (action.type === ActionType.UNASSIGN) {
|
|
6373
|
-
return null;
|
|
6374
|
-
}
|
|
6375
|
-
return signature;
|
|
6376
|
-
}, null);
|
|
6377
|
-
}
|
|
6378
6537
|
function deepDropNulls(obj) {
|
|
6379
6538
|
if (Array.isArray(obj)) {
|
|
6380
6539
|
return obj.map(deepDropNulls);
|
|
@@ -6470,10 +6629,8 @@ function getCurrentEventState(event2, config) {
|
|
|
6470
6629
|
createdBy: creationAction.createdBy,
|
|
6471
6630
|
createdByUserType: creationAction.createdByUserType,
|
|
6472
6631
|
createdAtLocation: creationAction.createdAtLocation,
|
|
6473
|
-
createdBySignature: creationAction.createdBySignature,
|
|
6474
6632
|
updatedAt: acceptedActionMetadata.createdAt,
|
|
6475
6633
|
assignedTo: getAssignedUserFromActions(acceptedActions),
|
|
6476
|
-
assignedToSignature: getAssignedUserSignatureFromActions(acceptedActions),
|
|
6477
6634
|
updatedBy: requestActionMetadata.createdBy,
|
|
6478
6635
|
updatedAtLocation: requestActionMetadata.createdAtLocation,
|
|
6479
6636
|
declaration,
|
|
@@ -9732,7 +9889,6 @@ var eventQueryDataGenerator = (overrides = {}, seed = 1) => {
|
|
|
9732
9889
|
createdBy: overrides.createdBy ?? generateUuid(rng),
|
|
9733
9890
|
createdAtLocation: overrides.createdAtLocation ?? generateUuid(rng),
|
|
9734
9891
|
updatedAtLocation: overrides.updatedAtLocation ?? generateUuid(rng),
|
|
9735
|
-
createdBySignature: overrides.createdBySignature ?? generateRandomSignature(rng),
|
|
9736
9892
|
updatedAt: overrides.updatedAt ?? (0, import_date_fns4.addDays)(new Date(createdAt), 1).toISOString(),
|
|
9737
9893
|
assignedTo: overrides.assignedTo ?? null,
|
|
9738
9894
|
updatedBy: overrides.updatedBy ?? generateUuid(rng),
|
|
@@ -10003,6 +10159,39 @@ function userCanAccessEventWithScopes(event2, scopes, user2, customActionType) {
|
|
|
10003
10159
|
(scope) => canAccessEventWithScope(event2, scope, user2, customActionType)
|
|
10004
10160
|
);
|
|
10005
10161
|
}
|
|
10162
|
+
function getAdministrativeAreaHierarchy(administrativeAreaId, administrativeAreas) {
|
|
10163
|
+
const collectedLocations = [];
|
|
10164
|
+
const parsedAdministrativeAreaId = administrativeAreaId && UUID.safeParse(administrativeAreaId).data;
|
|
10165
|
+
let current = parsedAdministrativeAreaId ? administrativeAreas.get(parsedAdministrativeAreaId) : null;
|
|
10166
|
+
while (current) {
|
|
10167
|
+
collectedLocations.push(current);
|
|
10168
|
+
if (!current.parentId) {
|
|
10169
|
+
break;
|
|
10170
|
+
}
|
|
10171
|
+
const parentId = current.parentId;
|
|
10172
|
+
current = administrativeAreas.get(parentId);
|
|
10173
|
+
}
|
|
10174
|
+
return collectedLocations;
|
|
10175
|
+
}
|
|
10176
|
+
function getLocationHierarchy(selectedId, context) {
|
|
10177
|
+
const { administrativeAreas, locations } = context;
|
|
10178
|
+
const loc = locations.get(selectedId);
|
|
10179
|
+
if (loc) {
|
|
10180
|
+
if (loc.administrativeAreaId) {
|
|
10181
|
+
const hierarchy2 = getAdministrativeAreaHierarchy(
|
|
10182
|
+
loc.administrativeAreaId,
|
|
10183
|
+
administrativeAreas
|
|
10184
|
+
);
|
|
10185
|
+
return [...hierarchy2.reverse().map((area) => area.id), loc.id];
|
|
10186
|
+
}
|
|
10187
|
+
return [loc.id];
|
|
10188
|
+
}
|
|
10189
|
+
const hierarchy = getAdministrativeAreaHierarchy(
|
|
10190
|
+
selectedId,
|
|
10191
|
+
administrativeAreas
|
|
10192
|
+
);
|
|
10193
|
+
return hierarchy.reverse().map((area) => area.id);
|
|
10194
|
+
}
|
|
10006
10195
|
|
|
10007
10196
|
// ../commons/src/events/scopes.ts
|
|
10008
10197
|
var ACTION_SCOPE_MAP = {
|
|
@@ -10077,6 +10266,25 @@ function isActionInScope({
|
|
|
10077
10266
|
);
|
|
10078
10267
|
return canAccess;
|
|
10079
10268
|
}
|
|
10269
|
+
function getAvailableRolesForUserUpdatePayload({
|
|
10270
|
+
allRoles,
|
|
10271
|
+
userLocation,
|
|
10272
|
+
acceptedScopes,
|
|
10273
|
+
userRequesting
|
|
10274
|
+
}) {
|
|
10275
|
+
const availableRoles = allRoles.filter((role) => {
|
|
10276
|
+
const canAccess = canAccessOtherUserWithScopes({
|
|
10277
|
+
userToAccess: {
|
|
10278
|
+
...userLocation,
|
|
10279
|
+
role
|
|
10280
|
+
},
|
|
10281
|
+
user: userRequesting,
|
|
10282
|
+
scopes: acceptedScopes
|
|
10283
|
+
});
|
|
10284
|
+
return canAccess;
|
|
10285
|
+
});
|
|
10286
|
+
return availableRoles;
|
|
10287
|
+
}
|
|
10080
10288
|
|
|
10081
10289
|
// ../commons/src/events/serializers/user/deserializer.ts
|
|
10082
10290
|
function userDeserializer(serializedUserField, user2) {
|