@opencrvs/toolkit 2.0.0-rc.1b5d54a → 2.0.0-rc.1ddd150
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 +50 -20
- package/create-countryconfig/package.json +12 -2
- package/dist/application-config/index.js +200 -64
- package/dist/cli.js +3 -1
- package/dist/commons/api/router.d.ts +15 -4
- package/dist/commons/events/ActionInput.d.ts +36 -36
- package/dist/commons/events/Draft.d.ts +2 -3
- package/dist/commons/events/WorkqueueConfig.d.ts +5 -5
- package/dist/conditionals/index.js +3 -1
- package/dist/events/index.js +262 -83
- package/dist/migrations/v2.0/index.js +3 -1
- package/dist/notification/index.js +262 -83
- package/dist/scopes/index.js +3 -1
- package/opencrvs-toolkit-2.0.0-rc.1ddd150.tgz +0 -0
- package/package.json +5 -1
- package/opencrvs-toolkit-2.0.0-rc.1b5d54a.tgz +0 -0
package/dist/events/index.js
CHANGED
|
@@ -704,7 +704,9 @@ var decodeScope = (query) => {
|
|
|
704
704
|
};
|
|
705
705
|
var DEFAULT_SCOPE_OPTIONS = {
|
|
706
706
|
placeOfEvent: JurisdictionFilter.enum.all,
|
|
707
|
-
accessLevel: JurisdictionFilter.enum.all
|
|
707
|
+
accessLevel: JurisdictionFilter.enum.all,
|
|
708
|
+
registeredIn: JurisdictionFilter.enum.all,
|
|
709
|
+
declaredIn: JurisdictionFilter.enum.all
|
|
708
710
|
};
|
|
709
711
|
function getAcceptedScopesByType({
|
|
710
712
|
acceptedScopes,
|
|
@@ -1078,8 +1080,8 @@ var ActionConditional = z7.discriminatedUnion("type", [
|
|
|
1078
1080
|
// Action can be shown to the user in the list but as disabled
|
|
1079
1081
|
EnableConditional
|
|
1080
1082
|
]).meta({
|
|
1081
|
-
|
|
1082
|
-
|
|
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."
|
|
1083
1085
|
});
|
|
1084
1086
|
var DisplayOnReviewConditional = z7.object({
|
|
1085
1087
|
type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
|
|
@@ -1095,8 +1097,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
|
|
|
1095
1097
|
// Field output can be shown / hidden on the review page
|
|
1096
1098
|
DisplayOnReviewConditional
|
|
1097
1099
|
]).meta({
|
|
1098
|
-
|
|
1099
|
-
|
|
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."
|
|
1100
1102
|
});
|
|
1101
1103
|
|
|
1102
1104
|
// ../commons/src/events/FieldType.ts
|
|
@@ -1740,8 +1742,8 @@ var FlagConfig = z15.object({
|
|
|
1740
1742
|
),
|
|
1741
1743
|
label: TranslationConfig.describe("Human readable label of the flag.")
|
|
1742
1744
|
}).meta({
|
|
1743
|
-
|
|
1744
|
-
|
|
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,
|
|
@@ -1750,8 +1752,8 @@ var ActionFlagConfig = z15.object({
|
|
|
1750
1752
|
"When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
|
|
1751
1753
|
)
|
|
1752
1754
|
}).meta({
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
+
id: "ActionFlagConfig",
|
|
1756
|
+
description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
|
|
1755
1757
|
});
|
|
1756
1758
|
|
|
1757
1759
|
// ../commons/src/events/EventMetadata.ts
|
|
@@ -2181,8 +2183,15 @@ var FieldReference = import_v43.default.object({
|
|
|
2181
2183
|
)
|
|
2182
2184
|
}).describe("Reference to a field by its ID");
|
|
2183
2185
|
var ValidationConfig = import_v43.default.object({
|
|
2184
|
-
validator: Conditional
|
|
2185
|
-
|
|
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."
|
|
2186
2195
|
});
|
|
2187
2196
|
var requiredSchema = import_v43.default.union([
|
|
2188
2197
|
import_v43.default.boolean(),
|
|
@@ -2221,6 +2230,9 @@ var BaseField = import_v43.default.object({
|
|
|
2221
2230
|
}).describe("Common properties shared across all field types.");
|
|
2222
2231
|
var Divider = BaseField.extend({
|
|
2223
2232
|
type: import_v43.default.literal(FieldType.DIVIDER)
|
|
2233
|
+
}).meta({
|
|
2234
|
+
description: "A horizontal line divider",
|
|
2235
|
+
id: "Divider"
|
|
2224
2236
|
});
|
|
2225
2237
|
var TextField = BaseField.extend({
|
|
2226
2238
|
type: import_v43.default.literal(FieldType.TEXT),
|
|
@@ -2231,7 +2243,10 @@ var TextField = BaseField.extend({
|
|
|
2231
2243
|
prefix: TranslationConfig.optional(),
|
|
2232
2244
|
postfix: TranslationConfig.optional()
|
|
2233
2245
|
}).default({ type: "text" }).optional()
|
|
2234
|
-
}).
|
|
2246
|
+
}).meta({
|
|
2247
|
+
description: "A text input field",
|
|
2248
|
+
id: "TextField"
|
|
2249
|
+
});
|
|
2235
2250
|
var NumberField = BaseField.extend({
|
|
2236
2251
|
type: import_v43.default.literal(FieldType.NUMBER),
|
|
2237
2252
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -2241,7 +2256,10 @@ var NumberField = BaseField.extend({
|
|
|
2241
2256
|
prefix: TranslationConfig.optional(),
|
|
2242
2257
|
postfix: TranslationConfig.optional()
|
|
2243
2258
|
}).optional()
|
|
2244
|
-
}).
|
|
2259
|
+
}).meta({
|
|
2260
|
+
description: "A number input field",
|
|
2261
|
+
id: "NumberField"
|
|
2262
|
+
});
|
|
2245
2263
|
var TextAreaField = BaseField.extend({
|
|
2246
2264
|
type: import_v43.default.literal(FieldType.TEXTAREA),
|
|
2247
2265
|
defaultValue: NonEmptyTextValue.optional(),
|
|
@@ -2252,7 +2270,10 @@ var TextAreaField = BaseField.extend({
|
|
|
2252
2270
|
prefix: TranslationConfig.optional(),
|
|
2253
2271
|
postfix: TranslationConfig.optional()
|
|
2254
2272
|
}).default({ rows: 4 }).optional()
|
|
2255
|
-
}).
|
|
2273
|
+
}).meta({
|
|
2274
|
+
description: "A multiline text input",
|
|
2275
|
+
id: "TextAreaField"
|
|
2276
|
+
});
|
|
2256
2277
|
var ImageMimeType = import_v43.default.enum([
|
|
2257
2278
|
"image/png",
|
|
2258
2279
|
"image/jpg",
|
|
@@ -2282,13 +2303,19 @@ var SignatureField = BaseField.extend({
|
|
|
2282
2303
|
}).default({
|
|
2283
2304
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2284
2305
|
})
|
|
2285
|
-
}).
|
|
2306
|
+
}).meta({
|
|
2307
|
+
description: "A signature input field",
|
|
2308
|
+
id: "SignatureField"
|
|
2309
|
+
});
|
|
2286
2310
|
var EmailField = BaseField.extend({
|
|
2287
2311
|
type: import_v43.default.literal(FieldType.EMAIL),
|
|
2288
2312
|
configuration: import_v43.default.object({
|
|
2289
2313
|
maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
|
|
2290
2314
|
}).default({ maxLength: 255 }).optional(),
|
|
2291
2315
|
defaultValue: NonEmptyTextValue.optional()
|
|
2316
|
+
}).meta({
|
|
2317
|
+
description: "An email input field",
|
|
2318
|
+
id: "EmailField"
|
|
2292
2319
|
});
|
|
2293
2320
|
var DateField = BaseField.extend({
|
|
2294
2321
|
type: import_v43.default.literal(FieldType.DATE),
|
|
@@ -2298,7 +2325,10 @@ var DateField = BaseField.extend({
|
|
|
2298
2325
|
"Text to display above the date input"
|
|
2299
2326
|
).optional()
|
|
2300
2327
|
}).optional()
|
|
2301
|
-
}).
|
|
2328
|
+
}).meta({
|
|
2329
|
+
description: "A date input (yyyy-MM-dd)",
|
|
2330
|
+
id: "DateField"
|
|
2331
|
+
});
|
|
2302
2332
|
var AgeField = BaseField.extend({
|
|
2303
2333
|
type: import_v43.default.literal(FieldType.AGE),
|
|
2304
2334
|
defaultValue: NumberFieldValue.optional(),
|
|
@@ -2307,7 +2337,10 @@ var AgeField = BaseField.extend({
|
|
|
2307
2337
|
prefix: TranslationConfig.optional(),
|
|
2308
2338
|
postfix: TranslationConfig.optional()
|
|
2309
2339
|
})
|
|
2310
|
-
}).
|
|
2340
|
+
}).meta({
|
|
2341
|
+
description: "An age input field which uses the current date as the asOfDate",
|
|
2342
|
+
id: "AgeField"
|
|
2343
|
+
});
|
|
2311
2344
|
var TimeField = BaseField.extend({
|
|
2312
2345
|
type: import_v43.default.literal(FieldType.TIME),
|
|
2313
2346
|
defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
|
|
@@ -2317,7 +2350,10 @@ var TimeField = BaseField.extend({
|
|
|
2317
2350
|
"Text to display above the time input"
|
|
2318
2351
|
).optional()
|
|
2319
2352
|
}).optional()
|
|
2320
|
-
}).
|
|
2353
|
+
}).meta({
|
|
2354
|
+
description: "A single time input (HH-mm)",
|
|
2355
|
+
id: "TimeField"
|
|
2356
|
+
});
|
|
2321
2357
|
var DateRangeField = BaseField.extend({
|
|
2322
2358
|
type: import_v43.default.literal(FieldType.DATE_RANGE),
|
|
2323
2359
|
defaultValue: DateRangeFieldValue.optional(),
|
|
@@ -2326,7 +2362,10 @@ var DateRangeField = BaseField.extend({
|
|
|
2326
2362
|
"Text to display above the date input"
|
|
2327
2363
|
).optional()
|
|
2328
2364
|
}).optional()
|
|
2329
|
-
}).
|
|
2365
|
+
}).meta({
|
|
2366
|
+
description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
|
|
2367
|
+
id: "DateRangeField"
|
|
2368
|
+
});
|
|
2330
2369
|
var HtmlFontVariant = import_v43.default.enum([
|
|
2331
2370
|
"reg12",
|
|
2332
2371
|
"reg14",
|
|
@@ -2370,18 +2409,30 @@ var ImageViewField = BaseField.extend({
|
|
|
2370
2409
|
type: import_v43.default.literal(FieldType.IMAGE_VIEW),
|
|
2371
2410
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2372
2411
|
configuration: ImageConfiguration
|
|
2373
|
-
}).
|
|
2412
|
+
}).meta({
|
|
2413
|
+
description: "A read-only image component for form pages",
|
|
2414
|
+
id: "ImageViewField"
|
|
2415
|
+
});
|
|
2374
2416
|
var Paragraph = BaseField.extend({
|
|
2375
2417
|
type: import_v43.default.literal(FieldType.PARAGRAPH),
|
|
2376
2418
|
configuration: ParagraphConfiguration
|
|
2377
|
-
}).
|
|
2419
|
+
}).meta({
|
|
2420
|
+
description: "A read-only HTML <p> paragraph",
|
|
2421
|
+
id: "Paragraph"
|
|
2422
|
+
});
|
|
2378
2423
|
var Heading = BaseField.extend({
|
|
2379
2424
|
type: import_v43.default.literal(FieldType.HEADING),
|
|
2380
2425
|
configuration: HeadingConfiguration
|
|
2381
|
-
}).
|
|
2426
|
+
}).meta({
|
|
2427
|
+
description: "A read-only heading component for form pages",
|
|
2428
|
+
id: "Heading"
|
|
2429
|
+
});
|
|
2382
2430
|
var PageHeader = BaseField.extend({
|
|
2383
2431
|
type: import_v43.default.literal(FieldType.PAGE_HEADER)
|
|
2384
|
-
}).
|
|
2432
|
+
}).meta({
|
|
2433
|
+
description: "A read-only header component for form pages",
|
|
2434
|
+
id: "PageHeader"
|
|
2435
|
+
});
|
|
2385
2436
|
var File = BaseField.extend({
|
|
2386
2437
|
type: import_v43.default.literal(FieldType.FILE),
|
|
2387
2438
|
defaultValue: FileFieldValue.optional(),
|
|
@@ -2400,7 +2451,10 @@ var File = BaseField.extend({
|
|
|
2400
2451
|
}).default({
|
|
2401
2452
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2402
2453
|
})
|
|
2403
|
-
}).
|
|
2454
|
+
}).meta({
|
|
2455
|
+
description: "A file upload field",
|
|
2456
|
+
id: "File"
|
|
2457
|
+
});
|
|
2404
2458
|
var SelectOption = import_v43.default.object({
|
|
2405
2459
|
value: import_v43.default.string().describe("The value of the option"),
|
|
2406
2460
|
label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
|
|
@@ -2417,7 +2471,10 @@ var NumberWithUnitField = BaseField.extend({
|
|
|
2417
2471
|
"Placeholder for the number field"
|
|
2418
2472
|
)
|
|
2419
2473
|
}).optional()
|
|
2420
|
-
}).
|
|
2474
|
+
}).meta({
|
|
2475
|
+
description: "A number with unit input field",
|
|
2476
|
+
id: "NumberWithUnitField"
|
|
2477
|
+
});
|
|
2421
2478
|
var RadioGroup = BaseField.extend({
|
|
2422
2479
|
type: import_v43.default.literal(FieldType.RADIO_GROUP),
|
|
2423
2480
|
defaultValue: TextValue.optional(),
|
|
@@ -2427,7 +2484,10 @@ var RadioGroup = BaseField.extend({
|
|
|
2427
2484
|
size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
|
|
2428
2485
|
}).optional()
|
|
2429
2486
|
}).optional()
|
|
2430
|
-
}).
|
|
2487
|
+
}).meta({
|
|
2488
|
+
description: "A grouped radio button field",
|
|
2489
|
+
id: "RadioGroup"
|
|
2490
|
+
});
|
|
2431
2491
|
var BulletList = BaseField.extend({
|
|
2432
2492
|
type: import_v43.default.literal(FieldType.BULLET_LIST),
|
|
2433
2493
|
items: import_v43.default.array(TranslationConfig).describe("A list of items"),
|
|
@@ -2436,7 +2496,10 @@ var BulletList = BaseField.extend({
|
|
|
2436
2496
|
fontVariant: HtmlFontVariant.optional()
|
|
2437
2497
|
}).optional()
|
|
2438
2498
|
}).default({})
|
|
2439
|
-
}).
|
|
2499
|
+
}).meta({
|
|
2500
|
+
description: "A list of bullet points",
|
|
2501
|
+
id: "BulletList"
|
|
2502
|
+
});
|
|
2440
2503
|
var Select = BaseField.extend({
|
|
2441
2504
|
type: import_v43.default.literal(FieldType.SELECT),
|
|
2442
2505
|
defaultValue: TextValue.optional(),
|
|
@@ -2451,7 +2514,10 @@ var Select = BaseField.extend({
|
|
|
2451
2514
|
{ ..., defaultMessage: "'{input}' is not listed among the health facilities." }
|
|
2452
2515
|
`
|
|
2453
2516
|
)
|
|
2454
|
-
}).
|
|
2517
|
+
}).meta({
|
|
2518
|
+
description: "A select input field",
|
|
2519
|
+
id: "Select"
|
|
2520
|
+
});
|
|
2455
2521
|
var SelectDateRangeOption = import_v43.default.object({
|
|
2456
2522
|
value: SelectDateRangeValue.describe("The value of the option"),
|
|
2457
2523
|
label: TranslationConfig.describe("The label of the option")
|
|
@@ -2460,7 +2526,10 @@ var SelectDateRangeField = BaseField.extend({
|
|
|
2460
2526
|
type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
|
|
2461
2527
|
defaultValue: SelectDateRangeValue.optional(),
|
|
2462
2528
|
options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
|
|
2463
|
-
}).
|
|
2529
|
+
}).meta({
|
|
2530
|
+
description: "A date range selection field",
|
|
2531
|
+
id: "SelectDateRangeField"
|
|
2532
|
+
});
|
|
2464
2533
|
var NameConfig = import_v43.default.object({
|
|
2465
2534
|
firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
2466
2535
|
middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
|
|
@@ -2491,26 +2560,41 @@ var NameField = BaseField.extend({
|
|
|
2491
2560
|
surname: { required: true }
|
|
2492
2561
|
}
|
|
2493
2562
|
}).optional()
|
|
2494
|
-
}).
|
|
2563
|
+
}).meta({
|
|
2564
|
+
description: "A field for entering a persons name",
|
|
2565
|
+
id: "NameField"
|
|
2566
|
+
});
|
|
2495
2567
|
var PhoneField = BaseField.extend({
|
|
2496
2568
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2497
2569
|
type: import_v43.default.literal(FieldType.PHONE)
|
|
2498
|
-
}).
|
|
2570
|
+
}).meta({
|
|
2571
|
+
description: "A field for entering a phone number",
|
|
2572
|
+
id: "PhoneField"
|
|
2573
|
+
});
|
|
2499
2574
|
var IdField = BaseField.extend({
|
|
2500
2575
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2501
2576
|
type: import_v43.default.literal(FieldType.ID)
|
|
2502
|
-
}).
|
|
2577
|
+
}).meta({
|
|
2578
|
+
description: "A field for entering an ID",
|
|
2579
|
+
id: "IdField"
|
|
2580
|
+
});
|
|
2503
2581
|
var Checkbox = BaseField.extend({
|
|
2504
2582
|
type: import_v43.default.literal(FieldType.CHECKBOX),
|
|
2505
2583
|
defaultValue: CheckboxFieldValue.default(false)
|
|
2506
|
-
}).
|
|
2584
|
+
}).meta({
|
|
2585
|
+
description: "A boolean checkbox field",
|
|
2586
|
+
id: "Checkbox"
|
|
2587
|
+
});
|
|
2507
2588
|
var Country = BaseField.extend({
|
|
2508
2589
|
type: import_v43.default.literal(FieldType.COUNTRY),
|
|
2509
2590
|
defaultValue: NonEmptyTextValue.optional(),
|
|
2510
2591
|
optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
|
|
2511
2592
|
"Conditionals for specific countries. Countries not listed are always shown and enabled."
|
|
2512
2593
|
)
|
|
2513
|
-
}).
|
|
2594
|
+
}).meta({
|
|
2595
|
+
description: "A field for selecting a country",
|
|
2596
|
+
id: "Country"
|
|
2597
|
+
});
|
|
2514
2598
|
var AllowedLocations = JurisdictionReference.optional().describe(
|
|
2515
2599
|
"Limits which location options are selectable depending on user jurisdiction and location."
|
|
2516
2600
|
);
|
|
@@ -2519,16 +2603,18 @@ var AdministrativeAreas = import_v43.default.enum([
|
|
|
2519
2603
|
"HEALTH_FACILITY",
|
|
2520
2604
|
"CRVS_OFFICE"
|
|
2521
2605
|
]);
|
|
2522
|
-
var AdministrativeAreaConfiguration = import_v43.default.object({
|
|
2523
|
-
partOf: FieldReference.optional().describe("Parent location"),
|
|
2524
|
-
type: AdministrativeAreas,
|
|
2525
|
-
allowedLocations: AllowedLocations
|
|
2526
|
-
}).describe("Administrative area options");
|
|
2527
2606
|
var AdministrativeAreaField = BaseField.extend({
|
|
2528
2607
|
type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
|
|
2529
2608
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
2530
|
-
configuration:
|
|
2531
|
-
|
|
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
|
+
});
|
|
2532
2618
|
var LocationInput = BaseField.extend({
|
|
2533
2619
|
type: import_v43.default.literal(FieldType.LOCATION),
|
|
2534
2620
|
defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
|
|
@@ -2536,7 +2622,10 @@ var LocationInput = BaseField.extend({
|
|
|
2536
2622
|
locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
|
|
2537
2623
|
allowedLocations: AllowedLocations
|
|
2538
2624
|
}).optional()
|
|
2539
|
-
}).
|
|
2625
|
+
}).meta({
|
|
2626
|
+
description: "A field for selecting a location",
|
|
2627
|
+
id: "LocationInput"
|
|
2628
|
+
});
|
|
2540
2629
|
var FileUploadWithOptions = BaseField.extend({
|
|
2541
2630
|
type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
|
|
2542
2631
|
options: import_v43.default.array(SelectOption).describe("A list of options"),
|
|
@@ -2550,6 +2639,9 @@ var FileUploadWithOptions = BaseField.extend({
|
|
|
2550
2639
|
}).default({
|
|
2551
2640
|
maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
|
|
2552
2641
|
})
|
|
2642
|
+
}).meta({
|
|
2643
|
+
description: "A field for uploading files with file type options",
|
|
2644
|
+
id: "FileUploadWithOptions"
|
|
2553
2645
|
});
|
|
2554
2646
|
var Facility = BaseField.extend({
|
|
2555
2647
|
type: import_v43.default.literal(FieldType.FACILITY),
|
|
@@ -2595,7 +2687,10 @@ var Address = BaseField.extend({
|
|
|
2595
2687
|
allowedLocations: AllowedLocations
|
|
2596
2688
|
}).optional(),
|
|
2597
2689
|
defaultValue: DefaultAddressFieldValue.optional()
|
|
2598
|
-
}).
|
|
2690
|
+
}).meta({
|
|
2691
|
+
description: "Address input field \u2013 a combination of location and text fields",
|
|
2692
|
+
id: "Address"
|
|
2693
|
+
});
|
|
2599
2694
|
var StaticDataEntry = import_v43.default.object({
|
|
2600
2695
|
id: import_v43.default.string().describe("ID for the data entry."),
|
|
2601
2696
|
label: TranslationConfig,
|
|
@@ -2610,7 +2705,10 @@ var DataField = BaseField.extend({
|
|
|
2610
2705
|
subtitle: TranslationConfig.optional(),
|
|
2611
2706
|
data: import_v43.default.array(DataEntry)
|
|
2612
2707
|
})
|
|
2613
|
-
}).
|
|
2708
|
+
}).meta({
|
|
2709
|
+
description: "A field for displaying a table of read-only data",
|
|
2710
|
+
id: "DataField"
|
|
2711
|
+
});
|
|
2614
2712
|
var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
|
|
2615
2713
|
var ButtonType = import_v43.default.enum([
|
|
2616
2714
|
"primary",
|
|
@@ -2637,11 +2735,17 @@ var ButtonField = BaseField.extend({
|
|
|
2637
2735
|
type: import_v43.default.literal(FieldType.BUTTON),
|
|
2638
2736
|
defaultValue: ButtonFieldValue.optional(),
|
|
2639
2737
|
configuration: ButtonConfiguration
|
|
2640
|
-
}).
|
|
2738
|
+
}).meta({
|
|
2739
|
+
description: "A generic button that can be used to trigger an action",
|
|
2740
|
+
id: "ButtonField"
|
|
2741
|
+
});
|
|
2641
2742
|
var FieldGroup = BaseField.extend({
|
|
2642
2743
|
type: import_v43.default.literal(FieldType.FIELD_GROUP),
|
|
2643
2744
|
// eslint-disable-next-line @typescript-eslint/no-use-before-define
|
|
2644
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"
|
|
2645
2749
|
});
|
|
2646
2750
|
var AlphaPrintButton = BaseField.extend({
|
|
2647
2751
|
type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
|
|
@@ -2651,7 +2755,10 @@ var AlphaPrintButton = BaseField.extend({
|
|
|
2651
2755
|
"Label for the print button"
|
|
2652
2756
|
)
|
|
2653
2757
|
})
|
|
2654
|
-
}).
|
|
2758
|
+
}).meta({
|
|
2759
|
+
description: "An experimental print button field for printing certificates during the declaration process",
|
|
2760
|
+
id: "AlphaPrintButton"
|
|
2761
|
+
});
|
|
2655
2762
|
var HttpField = BaseField.extend({
|
|
2656
2763
|
type: import_v43.default.literal(FieldType.HTTP),
|
|
2657
2764
|
defaultValue: HttpFieldValue.optional(),
|
|
@@ -2667,20 +2774,30 @@ var HttpField = BaseField.extend({
|
|
|
2667
2774
|
params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
|
|
2668
2775
|
timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
|
|
2669
2776
|
})
|
|
2670
|
-
}).
|
|
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
|
+
});
|
|
2671
2781
|
var AutocompleteField = BaseField.extend({
|
|
2672
2782
|
type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
|
|
2673
2783
|
configuration: import_v43.default.object({
|
|
2674
|
-
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(),
|
|
2675
2787
|
method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
|
|
2676
2788
|
defaultOptions: import_v43.default.array(
|
|
2677
2789
|
import_v43.default.object({
|
|
2678
2790
|
label: import_v43.default.string(),
|
|
2679
2791
|
value: import_v43.default.string()
|
|
2680
2792
|
})
|
|
2681
|
-
).optional()
|
|
2793
|
+
).optional().describe(
|
|
2794
|
+
"Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
|
|
2795
|
+
)
|
|
2682
2796
|
})
|
|
2683
|
-
}).
|
|
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
|
+
});
|
|
2684
2801
|
var SearchField = HttpField.extend({
|
|
2685
2802
|
type: import_v43.default.literal(FieldType.SEARCH),
|
|
2686
2803
|
configuration: SearchQuery.pick({
|
|
@@ -2713,6 +2830,9 @@ var SearchField = HttpField.extend({
|
|
|
2713
2830
|
ok: TranslationConfig.optional()
|
|
2714
2831
|
}).optional()
|
|
2715
2832
|
})
|
|
2833
|
+
}).meta({
|
|
2834
|
+
description: "A search input field",
|
|
2835
|
+
id: "SearchField"
|
|
2716
2836
|
});
|
|
2717
2837
|
var LinkButtonField = BaseField.extend({
|
|
2718
2838
|
type: import_v43.default.literal(FieldType.LINK_BUTTON),
|
|
@@ -2721,7 +2841,10 @@ var LinkButtonField = BaseField.extend({
|
|
|
2721
2841
|
text: TranslationConfig.describe("Text to display on the button"),
|
|
2722
2842
|
icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
|
|
2723
2843
|
})
|
|
2724
|
-
}).
|
|
2844
|
+
}).meta({
|
|
2845
|
+
description: "A button that opens a URL link",
|
|
2846
|
+
id: "LinkButtonField"
|
|
2847
|
+
});
|
|
2725
2848
|
var VerificationStatus = BaseField.extend({
|
|
2726
2849
|
type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
|
|
2727
2850
|
defaultValue: VerificationStatusValue.optional(),
|
|
@@ -2731,15 +2854,19 @@ var VerificationStatus = BaseField.extend({
|
|
|
2731
2854
|
"Explaining text on the banner in form."
|
|
2732
2855
|
)
|
|
2733
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"
|
|
2734
2860
|
});
|
|
2735
2861
|
var QueryParamReaderField = BaseField.extend({
|
|
2736
2862
|
type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
|
|
2737
2863
|
configuration: import_v43.default.object({
|
|
2738
2864
|
pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
|
|
2739
2865
|
})
|
|
2740
|
-
}).
|
|
2741
|
-
"A field that maps URL query params into form values and clears them afterward"
|
|
2742
|
-
|
|
2866
|
+
}).meta({
|
|
2867
|
+
description: "A field that maps URL query params into form values and clears them afterward",
|
|
2868
|
+
id: "QueryParamReaderField"
|
|
2869
|
+
});
|
|
2743
2870
|
var QrReaderField = BaseField.extend({
|
|
2744
2871
|
type: import_v43.default.literal(FieldType.QR_READER),
|
|
2745
2872
|
defaultValue: QrReaderFieldValue.optional(),
|
|
@@ -2750,7 +2877,7 @@ var QrReaderField = BaseField.extend({
|
|
|
2750
2877
|
})
|
|
2751
2878
|
}).optional()
|
|
2752
2879
|
}).meta({
|
|
2753
|
-
description: "
|
|
2880
|
+
description: "QR code reader field, including optional JSON Schema validator.",
|
|
2754
2881
|
id: "QrReaderField"
|
|
2755
2882
|
});
|
|
2756
2883
|
var IdReaderField = BaseField.extend({
|
|
@@ -2759,12 +2886,18 @@ var IdReaderField = BaseField.extend({
|
|
|
2759
2886
|
methods: import_v43.default.array(
|
|
2760
2887
|
import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
|
|
2761
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"
|
|
2762
2892
|
});
|
|
2763
2893
|
var CustomField = BaseField.extend({
|
|
2764
2894
|
type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
|
|
2765
2895
|
defaultValue: CustomFieldValue.optional(),
|
|
2766
2896
|
src: import_v43.default.string().describe("Module source path for the custom field component"),
|
|
2767
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"
|
|
2768
2901
|
});
|
|
2769
2902
|
var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
|
|
2770
2903
|
var LoaderField = BaseField.extend({
|
|
@@ -2774,22 +2907,25 @@ var LoaderField = BaseField.extend({
|
|
|
2774
2907
|
configuration: import_v43.default.object({
|
|
2775
2908
|
text: TranslationConfig.describe("Display text above the loading spinner")
|
|
2776
2909
|
})
|
|
2777
|
-
}).
|
|
2778
|
-
"A non-interactive field that indicates an in progress operation in form"
|
|
2779
|
-
|
|
2910
|
+
}).meta({
|
|
2911
|
+
description: "A non-interactive field that indicates an in progress operation in form",
|
|
2912
|
+
id: "LoaderField"
|
|
2913
|
+
});
|
|
2780
2914
|
var HiddenField = BaseField.extend({
|
|
2781
2915
|
type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
|
|
2782
2916
|
required: import_v43.default.boolean().default(false).optional(),
|
|
2783
2917
|
defaultValue: TextValue.optional()
|
|
2784
|
-
}).
|
|
2785
|
-
"A non-interactive, hidden field that only hold a value in the form"
|
|
2786
|
-
|
|
2918
|
+
}).meta({
|
|
2919
|
+
description: "A non-interactive, hidden field that only hold a value in the form",
|
|
2920
|
+
id: "HiddenField"
|
|
2921
|
+
});
|
|
2787
2922
|
var UserRoleField = BaseField.extend({
|
|
2788
2923
|
type: import_v43.default.literal(FieldType.USER_ROLE),
|
|
2789
2924
|
defaultValue: TextValue.optional()
|
|
2790
|
-
}).
|
|
2791
|
-
"A select dropdown that is automatically populated with available user roles"
|
|
2792
|
-
|
|
2925
|
+
}).meta({
|
|
2926
|
+
description: "A select dropdown that is automatically populated with available user roles",
|
|
2927
|
+
id: "UserRoleField"
|
|
2928
|
+
});
|
|
2793
2929
|
var FieldConfig = import_v43.default.discriminatedUnion("type", [
|
|
2794
2930
|
FieldGroup,
|
|
2795
2931
|
Address,
|
|
@@ -2889,15 +3025,18 @@ var VerificationPageConfig = FormPageConfig.extend({
|
|
|
2889
3025
|
actions: VerificationActionConfig
|
|
2890
3026
|
});
|
|
2891
3027
|
var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
|
|
2892
|
-
|
|
2893
|
-
|
|
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."
|
|
2894
3030
|
});
|
|
2895
3031
|
|
|
2896
3032
|
// ../commons/src/events/FormConfig.ts
|
|
2897
3033
|
var DeclarationFormConfig = z22.object({
|
|
2898
3034
|
label: TranslationConfig.describe("Human readable description of the form"),
|
|
2899
3035
|
pages: z22.array(FormPageConfig)
|
|
2900
|
-
}).
|
|
3036
|
+
}).meta({
|
|
3037
|
+
id: "DeclarationFormConfig",
|
|
3038
|
+
description: "Configuration of the declaration form."
|
|
3039
|
+
});
|
|
2901
3040
|
var ActionFormConfig = z22.object({
|
|
2902
3041
|
label: TranslationConfig.describe("Human readable description of the form"),
|
|
2903
3042
|
pages: z22.array(PageConfig)
|
|
@@ -2997,6 +3136,9 @@ var DeduplicationConfig = z23.object({
|
|
|
2997
3136
|
id: z23.string(),
|
|
2998
3137
|
label: TranslationConfig,
|
|
2999
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."
|
|
3000
3142
|
});
|
|
3001
3143
|
|
|
3002
3144
|
// ../commons/src/events/ActionConfig.ts
|
|
@@ -3114,17 +3256,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
|
|
|
3114
3256
|
* OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
|
|
3115
3257
|
* and treat them as "models" instead of duplicating the data structure in each endpoint.
|
|
3116
3258
|
*/
|
|
3117
|
-
ReadActionConfig.meta({
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
|
|
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
|
+
}),
|
|
3121
3275
|
PrintCertificateActionConfig.meta({
|
|
3122
|
-
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."
|
|
3286
|
+
}),
|
|
3287
|
+
ArchiveConfig.meta({
|
|
3288
|
+
id: "ArchiveActionConfig",
|
|
3289
|
+
description: "Configuration for archiving a record."
|
|
3123
3290
|
}),
|
|
3124
|
-
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3291
|
+
CustomActionConfig.meta({
|
|
3292
|
+
id: "CustomActionConfig",
|
|
3293
|
+
description: "Configuration for a country-defined custom action. An event may include any number of these."
|
|
3294
|
+
})
|
|
3128
3295
|
]).describe(
|
|
3129
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."
|
|
3130
3297
|
).meta({ id: "ActionConfig" });
|
|
@@ -3200,7 +3367,10 @@ var Field = BaseField2.extend({
|
|
|
3200
3367
|
}).describe("Custom field defined for the summary view.");
|
|
3201
3368
|
var SummaryConfig = z27.object({
|
|
3202
3369
|
fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
|
|
3203
|
-
}).
|
|
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
|
+
});
|
|
3204
3374
|
|
|
3205
3375
|
// ../commons/src/events/AdvancedSearchConfig.ts
|
|
3206
3376
|
var z28 = __toESM(require("zod/v4"));
|
|
@@ -3324,6 +3494,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
|
|
|
3324
3494
|
var AdvancedSearchConfig = z28.object({
|
|
3325
3495
|
title: TranslationConfig.describe("Advanced search tab title"),
|
|
3326
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()`)."
|
|
3327
3500
|
});
|
|
3328
3501
|
|
|
3329
3502
|
// ../commons/src/events/utils.ts
|
|
@@ -5397,8 +5570,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
|
|
|
5397
5570
|
validateActionFlags(event2, ctx);
|
|
5398
5571
|
validateActionOrder(event2, ctx);
|
|
5399
5572
|
}).meta({
|
|
5400
|
-
id: "EventConfig"
|
|
5401
|
-
|
|
5573
|
+
id: "EventConfig",
|
|
5574
|
+
description: "Configuration defining an event type registered in OpenCRVS (for example birth or death)."
|
|
5575
|
+
});
|
|
5402
5576
|
|
|
5403
5577
|
// ../commons/src/events/EventConfigInput.ts
|
|
5404
5578
|
var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
|
|
@@ -5621,6 +5795,9 @@ var WorkqueueColumnValue = z34.object({
|
|
|
5621
5795
|
var WorkqueueColumn = z34.object({
|
|
5622
5796
|
label: TranslationConfig,
|
|
5623
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`)."
|
|
5624
5801
|
});
|
|
5625
5802
|
function defineWorkqueuesColumns(workqueueColumns) {
|
|
5626
5803
|
return workqueueColumns.map(
|
|
@@ -5826,8 +6003,8 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
|
|
|
5826
6003
|
var WorkqueueConfigInput = WorkqueueConfig.extend({
|
|
5827
6004
|
query: CountryConfigQueryInputType
|
|
5828
6005
|
}).meta({
|
|
5829
|
-
|
|
5830
|
-
|
|
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."
|
|
5831
6008
|
});
|
|
5832
6009
|
function defineWorkqueue(workqueueInput) {
|
|
5833
6010
|
const queryInput = workqueueInput.query;
|
|
@@ -5890,7 +6067,9 @@ var BaseActionInput = z38.object({
|
|
|
5890
6067
|
keepAssignment: z38.boolean().optional(),
|
|
5891
6068
|
keepAssignmentIfAccepted: z38.boolean().optional(),
|
|
5892
6069
|
keepAssignmentIfRejected: z38.boolean().optional(),
|
|
5893
|
-
waitFor: z38.boolean().
|
|
6070
|
+
waitFor: z38.boolean().default(true).describe(
|
|
6071
|
+
"Whether action waits for the indexing before returning. Defaults to true. Setting this to to false completes faster but might lead to stale data in the client if the client tries to read the event immediately after performing the action. Use with care."
|
|
6072
|
+
),
|
|
5894
6073
|
// For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
|
|
5895
6074
|
// @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
|
|
5896
6075
|
createdAtLocation: UUID.nullish().describe(
|
|
@@ -6070,7 +6249,7 @@ var Draft = z39.object({
|
|
|
6070
6249
|
}).describe(
|
|
6071
6250
|
"A temporary storage for an action. Stored with details of the event, creator and creation time."
|
|
6072
6251
|
);
|
|
6073
|
-
var DraftInput = BaseActionInput.extend({
|
|
6252
|
+
var DraftInput = BaseActionInput.omit({ waitFor: true }).extend({
|
|
6074
6253
|
type: ActionTypes.exclude([ActionTypes.enum.DELETE]),
|
|
6075
6254
|
status: z39.enum([
|
|
6076
6255
|
ActionStatus.Requested,
|