@opencrvs/toolkit 2.0.0-rc.ac461be → 2.0.0-rc.adea241

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.
Files changed (29) hide show
  1. package/create-countryconfig/package.json +12 -2
  2. package/dist/application-config/index.js +206 -65
  3. package/dist/cli.js +206 -36
  4. package/dist/commons/api/router.d.ts +3287 -229
  5. package/dist/commons/conditionals/validate.d.ts +1 -0
  6. package/dist/commons/events/ActionInput.d.ts +108 -36
  7. package/dist/commons/events/Draft.d.ts +4 -3
  8. package/dist/commons/events/EventIndex.d.ts +0 -3
  9. package/dist/commons/events/EventMetadata.d.ts +0 -7
  10. package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
  11. package/dist/commons/events/index.d.ts +1 -0
  12. package/dist/commons/events/state/index.d.ts +0 -4
  13. package/dist/commons/events/state/utils.d.ts +0 -2
  14. package/dist/commons/events/utils.d.ts +1 -1
  15. package/dist/conditionals/index.js +3 -1
  16. package/dist/events/index.js +657 -128
  17. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  18. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  19. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  20. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  21. package/dist/migrations/v2.0/index.js +204 -34
  22. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  23. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  24. package/dist/notification/index.js +640 -98
  25. package/dist/scopes/index.js +3 -1
  26. package/opencrvs-toolkit-2.0.0-rc.adea241.tgz +0 -0
  27. package/package.json +5 -1
  28. package/tsconfig.tsbuildinfo +1 -1
  29. package/opencrvs-toolkit-2.0.0-rc.ac461be.tgz +0 -0
@@ -213,6 +213,10 @@ __export(events_exports, {
213
213
  UUID: () => UUID,
214
214
  UnassignActionInput: () => UnassignActionInput,
215
215
  UserAuditRecordInput: () => UserAuditRecordInput,
216
+ V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS: () => V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS,
217
+ V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP: () => V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP,
218
+ V2_DEFAULT_MOCK_LOCATIONS: () => V2_DEFAULT_MOCK_LOCATIONS,
219
+ V2_DEFAULT_MOCK_LOCATIONS_MAP: () => V2_DEFAULT_MOCK_LOCATIONS_MAP,
216
220
  ValidationConfig: () => ValidationConfig,
217
221
  VerificationActionConfig: () => VerificationActionConfig,
218
222
  VerificationPageConfig: () => VerificationPageConfig,
@@ -306,7 +310,6 @@ __export(events_exports, {
306
310
  getAllUniqueFields: () => getAllUniqueFields,
307
311
  getAnnotationFromDrafts: () => getAnnotationFromDrafts,
308
312
  getAssignedUserFromActions: () => getAssignedUserFromActions,
309
- getAssignedUserSignatureFromActions: () => getAssignedUserSignatureFromActions,
310
313
  getAssignmentStatus: () => getAssignmentStatus,
311
314
  getAvailableActionsForEvent: () => getAvailableActionsForEvent,
312
315
  getAvailableRolesForUserUpdatePayload: () => getAvailableRolesForUserUpdatePayload,
@@ -705,7 +708,9 @@ var decodeScope = (query) => {
705
708
  };
706
709
  var DEFAULT_SCOPE_OPTIONS = {
707
710
  placeOfEvent: JurisdictionFilter.enum.all,
708
- accessLevel: JurisdictionFilter.enum.all
711
+ accessLevel: JurisdictionFilter.enum.all,
712
+ registeredIn: JurisdictionFilter.enum.all,
713
+ declaredIn: JurisdictionFilter.enum.all
709
714
  };
710
715
  function getAcceptedScopesByType({
711
716
  acceptedScopes,
@@ -1078,7 +1083,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
1078
1083
  ShowConditional,
1079
1084
  // Action can be shown to the user in the list but as disabled
1080
1085
  EnableConditional
1081
- ]);
1086
+ ]).meta({
1087
+ id: "ActionConditional",
1088
+ 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."
1089
+ });
1082
1090
  var DisplayOnReviewConditional = z7.object({
1083
1091
  type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
1084
1092
  conditional: Conditional
@@ -1093,8 +1101,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
1093
1101
  // Field output can be shown / hidden on the review page
1094
1102
  DisplayOnReviewConditional
1095
1103
  ]).meta({
1096
- description: "Field conditional configuration",
1097
- id: "FieldConditional"
1104
+ id: "FieldConditional",
1105
+ 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."
1098
1106
  });
1099
1107
 
1100
1108
  // ../commons/src/events/FieldType.ts
@@ -1737,6 +1745,9 @@ var FlagConfig = z15.object({
1737
1745
  "Indicates if this flag expects an action to be performed to be cleared."
1738
1746
  ),
1739
1747
  label: TranslationConfig.describe("Human readable label of the flag.")
1748
+ }).meta({
1749
+ id: "FlagConfig",
1750
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1740
1751
  });
1741
1752
  var ActionFlagConfig = z15.object({
1742
1753
  id: Flag,
@@ -1744,6 +1755,9 @@ var ActionFlagConfig = z15.object({
1744
1755
  conditional: Conditional.optional().describe(
1745
1756
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1746
1757
  )
1758
+ }).meta({
1759
+ id: "ActionFlagConfig",
1760
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1747
1761
  });
1748
1762
 
1749
1763
  // ../commons/src/events/EventMetadata.ts
@@ -1765,8 +1779,7 @@ var ActionCreationMetadata = z16.object({
1765
1779
  ),
1766
1780
  createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1767
1781
  acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
1768
- createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation."),
1769
- createdBySignature: z16.string().nullish().describe("Signature of the user who created the action request.")
1782
+ createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
1770
1783
  });
1771
1784
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1772
1785
  registrationNumber: z16.string().describe(
@@ -1794,9 +1807,6 @@ var EventMetadata = z16.object({
1794
1807
  createdAtLocation: UUID.nullish().describe(
1795
1808
  "Location of the user who created the event."
1796
1809
  ),
1797
- createdBySignature: DocumentPath.nullish().describe(
1798
- "Signature of the user who created the event."
1799
- ),
1800
1810
  updatedAtLocation: UUID.nullish().describe(
1801
1811
  "Location of the user who last changed the status."
1802
1812
  ),
@@ -2171,14 +2181,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
2171
2181
  }
2172
2182
  }).describe("Unique identifier for the field");
2173
2183
  var FieldReference = import_v43.default.object({
2174
- $$field: FieldId,
2184
+ $$field: FieldId.describe("Id of the field to reference"),
2175
2185
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
2176
2186
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
2177
2187
  )
2178
2188
  }).describe("Reference to a field by its ID");
2179
2189
  var ValidationConfig = import_v43.default.object({
2180
- validator: Conditional,
2181
- message: TranslationConfig
2190
+ validator: Conditional.describe(
2191
+ "Conditional expression that must hold for the field value to be considered valid."
2192
+ ),
2193
+ message: TranslationConfig.describe(
2194
+ "Error message displayed when the validator does not hold."
2195
+ )
2196
+ }).meta({
2197
+ id: "ValidationConfig",
2198
+ 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."
2182
2199
  });
2183
2200
  var requiredSchema = import_v43.default.union([
2184
2201
  import_v43.default.boolean(),
@@ -2217,6 +2234,9 @@ var BaseField = import_v43.default.object({
2217
2234
  }).describe("Common properties shared across all field types.");
2218
2235
  var Divider = BaseField.extend({
2219
2236
  type: import_v43.default.literal(FieldType.DIVIDER)
2237
+ }).meta({
2238
+ description: "A horizontal line divider",
2239
+ id: "Divider"
2220
2240
  });
2221
2241
  var TextField = BaseField.extend({
2222
2242
  type: import_v43.default.literal(FieldType.TEXT),
@@ -2227,7 +2247,10 @@ var TextField = BaseField.extend({
2227
2247
  prefix: TranslationConfig.optional(),
2228
2248
  postfix: TranslationConfig.optional()
2229
2249
  }).default({ type: "text" }).optional()
2230
- }).describe("Text input");
2250
+ }).meta({
2251
+ description: "A text input field",
2252
+ id: "TextField"
2253
+ });
2231
2254
  var NumberField = BaseField.extend({
2232
2255
  type: import_v43.default.literal(FieldType.NUMBER),
2233
2256
  defaultValue: NumberFieldValue.optional(),
@@ -2237,7 +2260,10 @@ var NumberField = BaseField.extend({
2237
2260
  prefix: TranslationConfig.optional(),
2238
2261
  postfix: TranslationConfig.optional()
2239
2262
  }).optional()
2240
- }).describe("Number input");
2263
+ }).meta({
2264
+ description: "A number input field",
2265
+ id: "NumberField"
2266
+ });
2241
2267
  var TextAreaField = BaseField.extend({
2242
2268
  type: import_v43.default.literal(FieldType.TEXTAREA),
2243
2269
  defaultValue: NonEmptyTextValue.optional(),
@@ -2248,7 +2274,10 @@ var TextAreaField = BaseField.extend({
2248
2274
  prefix: TranslationConfig.optional(),
2249
2275
  postfix: TranslationConfig.optional()
2250
2276
  }).default({ rows: 4 }).optional()
2251
- }).describe("Multiline text input");
2277
+ }).meta({
2278
+ description: "A multiline text input",
2279
+ id: "TextAreaField"
2280
+ });
2252
2281
  var ImageMimeType = import_v43.default.enum([
2253
2282
  "image/png",
2254
2283
  "image/jpg",
@@ -2278,13 +2307,19 @@ var SignatureField = BaseField.extend({
2278
2307
  }).default({
2279
2308
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2280
2309
  })
2281
- }).describe("Signature input field");
2310
+ }).meta({
2311
+ description: "A signature input field",
2312
+ id: "SignatureField"
2313
+ });
2282
2314
  var EmailField = BaseField.extend({
2283
2315
  type: import_v43.default.literal(FieldType.EMAIL),
2284
2316
  configuration: import_v43.default.object({
2285
2317
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
2286
2318
  }).default({ maxLength: 255 }).optional(),
2287
2319
  defaultValue: NonEmptyTextValue.optional()
2320
+ }).meta({
2321
+ description: "An email input field",
2322
+ id: "EmailField"
2288
2323
  });
2289
2324
  var DateField = BaseField.extend({
2290
2325
  type: import_v43.default.literal(FieldType.DATE),
@@ -2294,7 +2329,10 @@ var DateField = BaseField.extend({
2294
2329
  "Text to display above the date input"
2295
2330
  ).optional()
2296
2331
  }).optional()
2297
- }).describe("A single date input (yyyy-MM-dd)");
2332
+ }).meta({
2333
+ description: "A date input (yyyy-MM-dd)",
2334
+ id: "DateField"
2335
+ });
2298
2336
  var AgeField = BaseField.extend({
2299
2337
  type: import_v43.default.literal(FieldType.AGE),
2300
2338
  defaultValue: NumberFieldValue.optional(),
@@ -2303,7 +2341,10 @@ var AgeField = BaseField.extend({
2303
2341
  prefix: TranslationConfig.optional(),
2304
2342
  postfix: TranslationConfig.optional()
2305
2343
  })
2306
- }).describe("An age input field which uses the current date as the asOfDate");
2344
+ }).meta({
2345
+ description: "An age input field which uses the current date as the asOfDate",
2346
+ id: "AgeField"
2347
+ });
2307
2348
  var TimeField = BaseField.extend({
2308
2349
  type: import_v43.default.literal(FieldType.TIME),
2309
2350
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -2313,7 +2354,10 @@ var TimeField = BaseField.extend({
2313
2354
  "Text to display above the time input"
2314
2355
  ).optional()
2315
2356
  }).optional()
2316
- }).describe("A single date input (HH-mm)");
2357
+ }).meta({
2358
+ description: "A single time input (HH-mm)",
2359
+ id: "TimeField"
2360
+ });
2317
2361
  var DateRangeField = BaseField.extend({
2318
2362
  type: import_v43.default.literal(FieldType.DATE_RANGE),
2319
2363
  defaultValue: DateRangeFieldValue.optional(),
@@ -2322,7 +2366,10 @@ var DateRangeField = BaseField.extend({
2322
2366
  "Text to display above the date input"
2323
2367
  ).optional()
2324
2368
  }).optional()
2325
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
2369
+ }).meta({
2370
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
2371
+ id: "DateRangeField"
2372
+ });
2326
2373
  var HtmlFontVariant = import_v43.default.enum([
2327
2374
  "reg12",
2328
2375
  "reg14",
@@ -2366,18 +2413,30 @@ var ImageViewField = BaseField.extend({
2366
2413
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
2367
2414
  defaultValue: NonEmptyTextValue.optional(),
2368
2415
  configuration: ImageConfiguration
2369
- }).describe("A read-only image component for form pages");
2416
+ }).meta({
2417
+ description: "A read-only image component for form pages",
2418
+ id: "ImageViewField"
2419
+ });
2370
2420
  var Paragraph = BaseField.extend({
2371
2421
  type: import_v43.default.literal(FieldType.PARAGRAPH),
2372
2422
  configuration: ParagraphConfiguration
2373
- }).describe("A read-only HTML <p> paragraph");
2423
+ }).meta({
2424
+ description: "A read-only HTML <p> paragraph",
2425
+ id: "Paragraph"
2426
+ });
2374
2427
  var Heading = BaseField.extend({
2375
2428
  type: import_v43.default.literal(FieldType.HEADING),
2376
2429
  configuration: HeadingConfiguration
2377
- }).describe("A read-only heading component for form pages");
2430
+ }).meta({
2431
+ description: "A read-only heading component for form pages",
2432
+ id: "Heading"
2433
+ });
2378
2434
  var PageHeader = BaseField.extend({
2379
2435
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
2380
- }).describe("A read-only header component for form pages");
2436
+ }).meta({
2437
+ description: "A read-only header component for form pages",
2438
+ id: "PageHeader"
2439
+ });
2381
2440
  var File = BaseField.extend({
2382
2441
  type: import_v43.default.literal(FieldType.FILE),
2383
2442
  defaultValue: FileFieldValue.optional(),
@@ -2396,7 +2455,10 @@ var File = BaseField.extend({
2396
2455
  }).default({
2397
2456
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2398
2457
  })
2399
- }).describe("File upload");
2458
+ }).meta({
2459
+ description: "A file upload field",
2460
+ id: "File"
2461
+ });
2400
2462
  var SelectOption = import_v43.default.object({
2401
2463
  value: import_v43.default.string().describe("The value of the option"),
2402
2464
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -2413,7 +2475,10 @@ var NumberWithUnitField = BaseField.extend({
2413
2475
  "Placeholder for the number field"
2414
2476
  )
2415
2477
  }).optional()
2416
- }).describe("Number with unit input");
2478
+ }).meta({
2479
+ description: "A number with unit input field",
2480
+ id: "NumberWithUnitField"
2481
+ });
2417
2482
  var RadioGroup = BaseField.extend({
2418
2483
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
2419
2484
  defaultValue: TextValue.optional(),
@@ -2423,7 +2488,10 @@ var RadioGroup = BaseField.extend({
2423
2488
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
2424
2489
  }).optional()
2425
2490
  }).optional()
2426
- }).describe("Grouped radio options");
2491
+ }).meta({
2492
+ description: "A grouped radio button field",
2493
+ id: "RadioGroup"
2494
+ });
2427
2495
  var BulletList = BaseField.extend({
2428
2496
  type: import_v43.default.literal(FieldType.BULLET_LIST),
2429
2497
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -2432,7 +2500,10 @@ var BulletList = BaseField.extend({
2432
2500
  fontVariant: HtmlFontVariant.optional()
2433
2501
  }).optional()
2434
2502
  }).default({})
2435
- }).describe("A list of bullet points");
2503
+ }).meta({
2504
+ description: "A list of bullet points",
2505
+ id: "BulletList"
2506
+ });
2436
2507
  var Select = BaseField.extend({
2437
2508
  type: import_v43.default.literal(FieldType.SELECT),
2438
2509
  defaultValue: TextValue.optional(),
@@ -2447,7 +2518,10 @@ var Select = BaseField.extend({
2447
2518
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
2448
2519
  `
2449
2520
  )
2450
- }).describe("Select input");
2521
+ }).meta({
2522
+ description: "A select input field",
2523
+ id: "Select"
2524
+ });
2451
2525
  var SelectDateRangeOption = import_v43.default.object({
2452
2526
  value: SelectDateRangeValue.describe("The value of the option"),
2453
2527
  label: TranslationConfig.describe("The label of the option")
@@ -2456,7 +2530,10 @@ var SelectDateRangeField = BaseField.extend({
2456
2530
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
2457
2531
  defaultValue: SelectDateRangeValue.optional(),
2458
2532
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
2459
- }).describe("Select input with date range options");
2533
+ }).meta({
2534
+ description: "A date range selection field",
2535
+ id: "SelectDateRangeField"
2536
+ });
2460
2537
  var NameConfig = import_v43.default.object({
2461
2538
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
2462
2539
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -2487,26 +2564,41 @@ var NameField = BaseField.extend({
2487
2564
  surname: { required: true }
2488
2565
  }
2489
2566
  }).optional()
2490
- }).describe("Name input field");
2567
+ }).meta({
2568
+ description: "A field for entering a persons name",
2569
+ id: "NameField"
2570
+ });
2491
2571
  var PhoneField = BaseField.extend({
2492
2572
  defaultValue: NonEmptyTextValue.optional(),
2493
2573
  type: import_v43.default.literal(FieldType.PHONE)
2494
- }).describe("Phone input field");
2574
+ }).meta({
2575
+ description: "A field for entering a phone number",
2576
+ id: "PhoneField"
2577
+ });
2495
2578
  var IdField = BaseField.extend({
2496
2579
  defaultValue: NonEmptyTextValue.optional(),
2497
2580
  type: import_v43.default.literal(FieldType.ID)
2498
- }).describe("ID input field");
2581
+ }).meta({
2582
+ description: "A field for entering an ID",
2583
+ id: "IdField"
2584
+ });
2499
2585
  var Checkbox = BaseField.extend({
2500
2586
  type: import_v43.default.literal(FieldType.CHECKBOX),
2501
2587
  defaultValue: CheckboxFieldValue.default(false)
2502
- }).describe("Boolean checkbox field");
2588
+ }).meta({
2589
+ description: "A boolean checkbox field",
2590
+ id: "Checkbox"
2591
+ });
2503
2592
  var Country = BaseField.extend({
2504
2593
  type: import_v43.default.literal(FieldType.COUNTRY),
2505
2594
  defaultValue: NonEmptyTextValue.optional(),
2506
2595
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
2507
2596
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
2508
2597
  )
2509
- }).describe("Country select field");
2598
+ }).meta({
2599
+ description: "A field for selecting a country",
2600
+ id: "Country"
2601
+ });
2510
2602
  var AllowedLocations = JurisdictionReference.optional().describe(
2511
2603
  "Limits which location options are selectable depending on user jurisdiction and location."
2512
2604
  );
@@ -2515,16 +2607,18 @@ var AdministrativeAreas = import_v43.default.enum([
2515
2607
  "HEALTH_FACILITY",
2516
2608
  "CRVS_OFFICE"
2517
2609
  ]);
2518
- var AdministrativeAreaConfiguration = import_v43.default.object({
2519
- partOf: FieldReference.optional().describe("Parent location"),
2520
- type: AdministrativeAreas,
2521
- allowedLocations: AllowedLocations
2522
- }).describe("Administrative area options");
2523
2610
  var AdministrativeAreaField = BaseField.extend({
2524
2611
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
2525
2612
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
2526
- configuration: AdministrativeAreaConfiguration
2527
- }).describe("Administrative area input field e.g. facility, office");
2613
+ configuration: import_v43.default.object({
2614
+ partOf: FieldReference.optional().describe("Parent location"),
2615
+ type: AdministrativeAreas,
2616
+ allowedLocations: AllowedLocations
2617
+ }).describe("Administrative area options")
2618
+ }).meta({
2619
+ description: "Administrative area input field",
2620
+ id: "AdministrativeAreaField"
2621
+ });
2528
2622
  var LocationInput = BaseField.extend({
2529
2623
  type: import_v43.default.literal(FieldType.LOCATION),
2530
2624
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -2532,7 +2626,10 @@ var LocationInput = BaseField.extend({
2532
2626
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
2533
2627
  allowedLocations: AllowedLocations
2534
2628
  }).optional()
2535
- }).describe("Input field for a location");
2629
+ }).meta({
2630
+ description: "A field for selecting a location",
2631
+ id: "LocationInput"
2632
+ });
2536
2633
  var FileUploadWithOptions = BaseField.extend({
2537
2634
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
2538
2635
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -2546,6 +2643,9 @@ var FileUploadWithOptions = BaseField.extend({
2546
2643
  }).default({
2547
2644
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2548
2645
  })
2646
+ }).meta({
2647
+ description: "A field for uploading files with file type options",
2648
+ id: "FileUploadWithOptions"
2549
2649
  });
2550
2650
  var Facility = BaseField.extend({
2551
2651
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -2591,7 +2691,10 @@ var Address = BaseField.extend({
2591
2691
  allowedLocations: AllowedLocations
2592
2692
  }).optional(),
2593
2693
  defaultValue: DefaultAddressFieldValue.optional()
2594
- }).describe("Address input field \u2013 a combination of location and text fields");
2694
+ }).meta({
2695
+ description: "Address input field \u2013 a combination of location and text fields",
2696
+ id: "Address"
2697
+ });
2595
2698
  var StaticDataEntry = import_v43.default.object({
2596
2699
  id: import_v43.default.string().describe("ID for the data entry."),
2597
2700
  label: TranslationConfig,
@@ -2606,7 +2709,10 @@ var DataField = BaseField.extend({
2606
2709
  subtitle: TranslationConfig.optional(),
2607
2710
  data: import_v43.default.array(DataEntry)
2608
2711
  })
2609
- }).describe("Data field for displaying read-only data");
2712
+ }).meta({
2713
+ description: "A field for displaying a table of read-only data",
2714
+ id: "DataField"
2715
+ });
2610
2716
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
2611
2717
  var ButtonType = import_v43.default.enum([
2612
2718
  "primary",
@@ -2633,11 +2739,17 @@ var ButtonField = BaseField.extend({
2633
2739
  type: import_v43.default.literal(FieldType.BUTTON),
2634
2740
  defaultValue: ButtonFieldValue.optional(),
2635
2741
  configuration: ButtonConfiguration
2636
- }).describe("Generic button without any built-in functionality");
2742
+ }).meta({
2743
+ description: "A generic button that can be used to trigger an action",
2744
+ id: "ButtonField"
2745
+ });
2637
2746
  var FieldGroup = BaseField.extend({
2638
2747
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
2639
2748
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
2640
2749
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
2750
+ }).meta({
2751
+ description: "A group of fields that are displayed together",
2752
+ id: "FieldGroup"
2641
2753
  });
2642
2754
  var AlphaPrintButton = BaseField.extend({
2643
2755
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -2647,7 +2759,10 @@ var AlphaPrintButton = BaseField.extend({
2647
2759
  "Label for the print button"
2648
2760
  )
2649
2761
  })
2650
- }).describe("Print button field for printing certificates");
2762
+ }).meta({
2763
+ description: "An experimental print button field for printing certificates during the declaration process",
2764
+ id: "AlphaPrintButton"
2765
+ });
2651
2766
  var HttpField = BaseField.extend({
2652
2767
  type: import_v43.default.literal(FieldType.HTTP),
2653
2768
  defaultValue: HttpFieldValue.optional(),
@@ -2663,20 +2778,30 @@ var HttpField = BaseField.extend({
2663
2778
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
2664
2779
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
2665
2780
  })
2666
- }).describe("HTTP request function triggered by a button click or other event");
2781
+ }).meta({
2782
+ 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.",
2783
+ id: "HttpField"
2784
+ });
2667
2785
  var AutocompleteField = BaseField.extend({
2668
2786
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
2669
2787
  configuration: import_v43.default.object({
2670
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2788
+ url: import_v43.default.string().describe(
2789
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2790
+ ).optional(),
2671
2791
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
2672
2792
  defaultOptions: import_v43.default.array(
2673
2793
  import_v43.default.object({
2674
2794
  label: import_v43.default.string(),
2675
2795
  value: import_v43.default.string()
2676
2796
  })
2677
- ).optional()
2797
+ ).optional().describe(
2798
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2799
+ )
2678
2800
  })
2679
- }).describe("Autocomplete input field");
2801
+ }).meta({
2802
+ 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.",
2803
+ id: "AutocompleteField"
2804
+ });
2680
2805
  var SearchField = HttpField.extend({
2681
2806
  type: import_v43.default.literal(FieldType.SEARCH),
2682
2807
  configuration: SearchQuery.pick({
@@ -2709,6 +2834,9 @@ var SearchField = HttpField.extend({
2709
2834
  ok: TranslationConfig.optional()
2710
2835
  }).optional()
2711
2836
  })
2837
+ }).meta({
2838
+ description: "A search input field",
2839
+ id: "SearchField"
2712
2840
  });
2713
2841
  var LinkButtonField = BaseField.extend({
2714
2842
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -2717,7 +2845,10 @@ var LinkButtonField = BaseField.extend({
2717
2845
  text: TranslationConfig.describe("Text to display on the button"),
2718
2846
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
2719
2847
  })
2720
- }).describe("Button that opens a link");
2848
+ }).meta({
2849
+ description: "A button that opens a URL link",
2850
+ id: "LinkButtonField"
2851
+ });
2721
2852
  var VerificationStatus = BaseField.extend({
2722
2853
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
2723
2854
  defaultValue: VerificationStatusValue.optional(),
@@ -2727,15 +2858,19 @@ var VerificationStatus = BaseField.extend({
2727
2858
  "Explaining text on the banner in form."
2728
2859
  )
2729
2860
  })
2861
+ }).meta({
2862
+ 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.",
2863
+ id: "VerificationStatus"
2730
2864
  });
2731
2865
  var QueryParamReaderField = BaseField.extend({
2732
2866
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
2733
2867
  configuration: import_v43.default.object({
2734
2868
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
2735
2869
  })
2736
- }).describe(
2737
- "A field that maps URL query params into form values and clears them afterward"
2738
- );
2870
+ }).meta({
2871
+ description: "A field that maps URL query params into form values and clears them afterward",
2872
+ id: "QueryParamReaderField"
2873
+ });
2739
2874
  var QrReaderField = BaseField.extend({
2740
2875
  type: import_v43.default.literal(FieldType.QR_READER),
2741
2876
  defaultValue: QrReaderFieldValue.optional(),
@@ -2746,7 +2881,7 @@ var QrReaderField = BaseField.extend({
2746
2881
  })
2747
2882
  }).optional()
2748
2883
  }).meta({
2749
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2884
+ description: "QR code reader field, including optional JSON Schema validator.",
2750
2885
  id: "QrReaderField"
2751
2886
  });
2752
2887
  var IdReaderField = BaseField.extend({
@@ -2755,12 +2890,18 @@ var IdReaderField = BaseField.extend({
2755
2890
  methods: import_v43.default.array(
2756
2891
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
2757
2892
  )
2893
+ }).meta({
2894
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2895
+ id: "IdReaderField"
2758
2896
  });
2759
2897
  var CustomField = BaseField.extend({
2760
2898
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
2761
2899
  defaultValue: CustomFieldValue.optional(),
2762
2900
  src: import_v43.default.string().describe("Module source path for the custom field component"),
2763
2901
  configuration: import_v43.default.unknown().optional()
2902
+ }).meta({
2903
+ description: "An expiremental custom field that is defined by a module source path",
2904
+ id: "CustomField"
2764
2905
  });
2765
2906
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2766
2907
  var LoaderField = BaseField.extend({
@@ -2770,22 +2911,25 @@ var LoaderField = BaseField.extend({
2770
2911
  configuration: import_v43.default.object({
2771
2912
  text: TranslationConfig.describe("Display text above the loading spinner")
2772
2913
  })
2773
- }).describe(
2774
- "A non-interactive field that indicates an in progress operation in form"
2775
- );
2914
+ }).meta({
2915
+ description: "A non-interactive field that indicates an in progress operation in form",
2916
+ id: "LoaderField"
2917
+ });
2776
2918
  var HiddenField = BaseField.extend({
2777
2919
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2778
2920
  required: import_v43.default.boolean().default(false).optional(),
2779
2921
  defaultValue: TextValue.optional()
2780
- }).describe(
2781
- "A non-interactive, hidden field that only hold a value in the form"
2782
- );
2922
+ }).meta({
2923
+ description: "A non-interactive, hidden field that only hold a value in the form",
2924
+ id: "HiddenField"
2925
+ });
2783
2926
  var UserRoleField = BaseField.extend({
2784
2927
  type: import_v43.default.literal(FieldType.USER_ROLE),
2785
2928
  defaultValue: TextValue.optional()
2786
- }).describe(
2787
- "A select dropdown that is automatically populated with available user roles"
2788
- );
2929
+ }).meta({
2930
+ description: "A select dropdown that is automatically populated with available user roles",
2931
+ id: "UserRoleField"
2932
+ });
2789
2933
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2790
2934
  FieldGroup,
2791
2935
  Address,
@@ -2884,16 +3028,19 @@ var VerificationPageConfig = FormPageConfig.extend({
2884
3028
  type: z21.literal(PageTypes.enum.VERIFICATION),
2885
3029
  actions: VerificationActionConfig
2886
3030
  });
2887
- var PageConfig = z21.discriminatedUnion("type", [
2888
- FormPageConfig,
2889
- VerificationPageConfig
2890
- ]);
3031
+ var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
3032
+ id: "PageConfig",
3033
+ 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."
3034
+ });
2891
3035
 
2892
3036
  // ../commons/src/events/FormConfig.ts
2893
3037
  var DeclarationFormConfig = z22.object({
2894
3038
  label: TranslationConfig.describe("Human readable description of the form"),
2895
3039
  pages: z22.array(FormPageConfig)
2896
- }).describe("Configuration of the declaration form.");
3040
+ }).meta({
3041
+ id: "DeclarationFormConfig",
3042
+ description: "Configuration of the declaration form."
3043
+ });
2897
3044
  var ActionFormConfig = z22.object({
2898
3045
  label: TranslationConfig.describe("Human readable description of the form"),
2899
3046
  pages: z22.array(PageConfig)
@@ -2993,6 +3140,9 @@ var DeduplicationConfig = z23.object({
2993
3140
  id: z23.string(),
2994
3141
  label: TranslationConfig,
2995
3142
  query: Clause
3143
+ }).meta({
3144
+ id: "DeduplicationConfig",
3145
+ 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."
2996
3146
  });
2997
3147
 
2998
3148
  // ../commons/src/events/ActionConfig.ts
@@ -3110,17 +3260,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
3110
3260
  * OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
3111
3261
  * and treat them as "models" instead of duplicating the data structure in each endpoint.
3112
3262
  */
3113
- ReadActionConfig.meta({ id: "ReadActionConfig" }),
3114
- DeclareConfig.meta({ id: "DeclareActionConfig" }),
3115
- RejectConfig.meta({ id: "RejectActionConfig" }),
3116
- RegisterConfig.meta({ id: "RegisterActionConfig" }),
3263
+ ReadActionConfig.meta({
3264
+ id: "ReadActionConfig",
3265
+ description: "Configuration for the read action \u2014 defines the record-tab content displayed on the event overview page."
3266
+ }),
3267
+ DeclareConfig.meta({
3268
+ id: "DeclareActionConfig",
3269
+ description: "Configuration for the declare action. Includes review-page fields. Shared with the notify action (ActionType.NOTIFY)."
3270
+ }),
3271
+ RejectConfig.meta({
3272
+ id: "RejectActionConfig",
3273
+ description: "Configuration for rejecting a record before registration."
3274
+ }),
3275
+ RegisterConfig.meta({
3276
+ id: "RegisterActionConfig",
3277
+ description: "Configuration for registering a record."
3278
+ }),
3117
3279
  PrintCertificateActionConfig.meta({
3118
- id: "PrintCertificateActionConfig"
3280
+ id: "PrintCertificateActionConfig",
3281
+ description: "Configuration for printing a certificate of a registered record."
3282
+ }),
3283
+ RequestCorrectionConfig.meta({
3284
+ id: "RequestCorrectionActionConfig",
3285
+ description: "Configuration for requesting a correction on a registered record."
3119
3286
  }),
3120
- RequestCorrectionConfig.meta({ id: "RequestCorrectionActionConfig" }),
3121
- EditActionConfig.meta({ id: "EditActionConfig" }),
3122
- ArchiveConfig.meta({ id: "ArchiveActionConfig" }),
3123
- CustomActionConfig.meta({ id: "CustomActionConfig" })
3287
+ EditActionConfig.meta({
3288
+ id: "EditActionConfig",
3289
+ description: "Configuration for editing a record before registration."
3290
+ }),
3291
+ ArchiveConfig.meta({
3292
+ id: "ArchiveActionConfig",
3293
+ description: "Configuration for archiving a record."
3294
+ }),
3295
+ CustomActionConfig.meta({
3296
+ id: "CustomActionConfig",
3297
+ description: "Configuration for a country-defined custom action. An event may include any number of these."
3298
+ })
3124
3299
  ]).describe(
3125
3300
  "Configuration of an action available for an event. Data collected depends on the action type and is accessible through the annotation property in ActionDocument."
3126
3301
  ).meta({ id: "ActionConfig" });
@@ -3196,7 +3371,10 @@ var Field = BaseField2.extend({
3196
3371
  }).describe("Custom field defined for the summary view.");
3197
3372
  var SummaryConfig = z27.object({
3198
3373
  fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
3199
- }).describe("Configuration of the event summary section.");
3374
+ }).meta({
3375
+ id: "SummaryConfig",
3376
+ 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."
3377
+ });
3200
3378
 
3201
3379
  // ../commons/src/events/AdvancedSearchConfig.ts
3202
3380
  var z28 = __toESM(require("zod/v4"));
@@ -3320,6 +3498,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
3320
3498
  var AdvancedSearchConfig = z28.object({
3321
3499
  title: TranslationConfig.describe("Advanced search tab title"),
3322
3500
  fields: z28.array(AdvancedSearchField).describe("Advanced search fields within the tab.")
3501
+ }).meta({
3502
+ id: "AdvancedSearchConfig",
3503
+ 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()`)."
3323
3504
  });
3324
3505
 
3325
3506
  // ../commons/src/events/utils.ts
@@ -3796,6 +3977,9 @@ function precompileActionSchemas(eventConfigurations) {
3796
3977
  function isAgeValue(value) {
3797
3978
  return typeof value === "object" && value !== null && "age" in value && typeof value.age === "number";
3798
3979
  }
3980
+ function mergeWithBaseFormState(values, context) {
3981
+ return { ...context.baseFormState, ...values };
3982
+ }
3799
3983
  function validate(schema, data) {
3800
3984
  const validator = ajv.getSchema(schema.$id) || ajv.compile(schema);
3801
3985
  if ("$form" in data) {
@@ -3834,7 +4018,7 @@ function isOnline() {
3834
4018
  }
3835
4019
  function isConditionMet(conditional, values, context, eventIndex) {
3836
4020
  return validate(conditional, {
3837
- $form: values,
4021
+ $form: mergeWithBaseFormState(values, context),
3838
4022
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
3839
4023
  $online: isOnline(),
3840
4024
  $user: context.user,
@@ -3863,7 +4047,7 @@ function isFieldConditionMet(field3, form, conditionalType, context) {
3863
4047
  return true;
3864
4048
  }
3865
4049
  const validConditionals = getConditionalActionsForField(field3, {
3866
- $form: form,
4050
+ $form: mergeWithBaseFormState(form, context),
3867
4051
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
3868
4052
  $online: isOnline(),
3869
4053
  $user: context.user,
@@ -4055,7 +4239,7 @@ function runFieldValidations({
4055
4239
  return [];
4056
4240
  }
4057
4241
  const conditionalParameters = {
4058
- $form: form,
4242
+ $form: mergeWithBaseFormState(form, context),
4059
4243
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
4060
4244
  /**
4061
4245
  * In real use cases, there can be hundreds of thousands of locations.
@@ -4299,17 +4483,16 @@ function isPageVisible(page, formValues, context) {
4299
4483
  }
4300
4484
  return isConditionMet(page.conditional, formValues, context);
4301
4485
  }
4302
- function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false, declarationContext) {
4486
+ function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false) {
4303
4487
  const base = (0, import_lodash.cloneDeep)(formValues);
4304
4488
  function fn(prevVisibilityContext) {
4305
- const visibilityForm = declarationContext ? { ...declarationContext, ...prevVisibilityContext } : prevVisibilityContext;
4306
4489
  const cleaned = (0, import_lodash.omitBy)(base, (value, fieldId) => {
4307
4490
  const fieldConfig = fields.filter((f) => f.id === fieldId);
4308
4491
  if (!fieldConfig.length) {
4309
4492
  return false;
4310
4493
  }
4311
4494
  const isHidden = fieldConfig.every(
4312
- (f) => !isFieldVisible(f, visibilityForm, validatorContext)
4495
+ (f) => !isFieldVisible(f, prevVisibilityContext, validatorContext)
4313
4496
  );
4314
4497
  if (!isHidden) {
4315
4498
  return false;
@@ -4327,7 +4510,7 @@ function omitHiddenPaginatedFields(formConfig, values, validatorContext, include
4327
4510
  const visibleFields = formConfig.pages.filter((p) => isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
4328
4511
  const hiddenFields = formConfig.pages.filter((p) => !isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
4329
4512
  const valuesExceptHiddenPage = (0, import_lodash.omitBy)(values, (_2, fieldId) => {
4330
- return hiddenFields.some((f) => f.id === fieldId);
4513
+ return hiddenFields.some((f) => f.id === fieldId) && !visibleFields.some((f) => f.id === fieldId);
4331
4514
  });
4332
4515
  return omitHiddenFields(
4333
4516
  visibleFields,
@@ -4374,13 +4557,10 @@ function getVisibleVerificationPageIds(pages, annotation, context) {
4374
4557
  }
4375
4558
  function omitHiddenAnnotationFields(actionConfig, declaration, annotation, context) {
4376
4559
  const annotationFields = getActionAnnotationFields(actionConfig);
4377
- return omitHiddenFields(
4378
- annotationFields,
4379
- annotation,
4380
- context,
4381
- false,
4382
- declaration
4383
- );
4560
+ return omitHiddenFields(annotationFields, annotation, {
4561
+ ...context,
4562
+ baseFormState: declaration
4563
+ });
4384
4564
  }
4385
4565
  function deepMerge(currentDocument, actionDocument) {
4386
4566
  const currentDocumentClone = (0, import_lodash.cloneDeep)(currentDocument);
@@ -5369,7 +5549,7 @@ var _EventConfigBase = z33.object({
5369
5549
  ),
5370
5550
  label: TranslationConfig.describe("Human-readable label for the event type."),
5371
5551
  actions: z33.array(ActionConfig).describe(
5372
- "Configuration of system-defined actions associated with the event."
5552
+ "Configuration of core and custom actions associated with the event."
5373
5553
  ),
5374
5554
  actionOrder: z33.array(z33.string()).optional().describe(
5375
5555
  "Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
@@ -5381,7 +5561,7 @@ var _EventConfigBase = z33.object({
5381
5561
  "Configuration of fields available in the advanced search feature."
5382
5562
  ),
5383
5563
  flags: z33.array(FlagConfig).optional().default([]).describe(
5384
- "Configuration of flags associated with the actions of this event type."
5564
+ "Configuration of custom flags associated with the actions of this event type."
5385
5565
  ),
5386
5566
  analytics: z33.boolean().optional().default(true).describe(
5387
5567
  "Indicates whether the records of this event type are included in analytics"
@@ -5394,8 +5574,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
5394
5574
  validateActionFlags(event2, ctx);
5395
5575
  validateActionOrder(event2, ctx);
5396
5576
  }).meta({
5397
- id: "EventConfig"
5398
- }).describe("Configuration defining an event type.");
5577
+ id: "EventConfig",
5578
+ description: "Configuration defining an event type registered in OpenCRVS (for example birth or death)."
5579
+ });
5399
5580
 
5400
5581
  // ../commons/src/events/EventConfigInput.ts
5401
5582
  var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
@@ -5618,6 +5799,9 @@ var WorkqueueColumnValue = z34.object({
5618
5799
  var WorkqueueColumn = z34.object({
5619
5800
  label: TranslationConfig,
5620
5801
  value: WorkqueueColumnValue
5802
+ }).meta({
5803
+ id: "WorkqueueColumn",
5804
+ description: "Configuration for a single workqueue column. The value references an event metadata key (e.g. `dateOfEvent`, `status`, `trackingId`)."
5621
5805
  });
5622
5806
  function defineWorkqueuesColumns(workqueueColumns) {
5623
5807
  return workqueueColumns.map(
@@ -5820,18 +6004,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
5820
6004
  query: true,
5821
6005
  columns: true
5822
6006
  });
5823
- var WorkqueueConfigInput = z37.object({
5824
- slug: z37.string().describe("Determines the url of the workqueue."),
5825
- name: TranslationConfig.describe(
5826
- "Title of the workflow (both in navigation and on the page)"
5827
- ),
5828
- query: CountryConfigQueryInputType,
5829
- action: z37.object({ type: WorkqueueActionType }).optional().describe(
5830
- "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."
5831
- ),
5832
- columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
5833
- icon: AvailableIcons,
5834
- emptyMessage: TranslationConfig.optional()
6007
+ var WorkqueueConfigInput = WorkqueueConfig.extend({
6008
+ query: CountryConfigQueryInputType
6009
+ }).meta({
6010
+ id: "WorkqueueConfig",
6011
+ 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."
5835
6012
  });
5836
6013
  function defineWorkqueue(workqueueInput) {
5837
6014
  const queryInput = workqueueInput.query;
@@ -5892,7 +6069,11 @@ var BaseActionInput = z38.object({
5892
6069
  originalActionId: UUID.optional(),
5893
6070
  // should not be part of base action.
5894
6071
  keepAssignment: z38.boolean().optional(),
5895
- waitFor: z38.boolean().optional(),
6072
+ keepAssignmentIfAccepted: z38.boolean().optional(),
6073
+ keepAssignmentIfRejected: z38.boolean().optional(),
6074
+ waitFor: z38.boolean().default(true).describe(
6075
+ "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."
6076
+ ),
5896
6077
  // For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
5897
6078
  // @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
5898
6079
  createdAtLocation: UUID.nullish().describe(
@@ -6072,7 +6253,7 @@ var Draft = z39.object({
6072
6253
  }).describe(
6073
6254
  "A temporary storage for an action. Stored with details of the event, creator and creation time."
6074
6255
  );
6075
- var DraftInput = BaseActionInput.extend({
6256
+ var DraftInput = BaseActionInput.omit({ waitFor: true }).extend({
6076
6257
  type: ActionTypes.exclude([ActionTypes.enum.DELETE]),
6077
6258
  status: z39.enum([
6078
6259
  ActionStatus.Requested,
@@ -6146,7 +6327,6 @@ function getDeclarationActionCreationMetadata(actionType, actions) {
6146
6327
  createdAtLocation: requestAction?.createdAtLocation ?? acceptAction.createdAtLocation,
6147
6328
  acceptedAt: acceptAction.createdAt,
6148
6329
  createdByRole: requestAction?.createdByRole ?? acceptAction.createdByRole,
6149
- createdBySignature: requestAction?.createdBySignature ?? acceptAction.createdBySignature,
6150
6330
  registrationNumber
6151
6331
  };
6152
6332
  }
@@ -6360,17 +6540,6 @@ function getAssignedUserFromActions(actions) {
6360
6540
  return user2;
6361
6541
  }, null);
6362
6542
  }
6363
- function getAssignedUserSignatureFromActions(actions) {
6364
- return actions.reduce((signature, action) => {
6365
- if (action.type === ActionType.ASSIGN) {
6366
- return action.createdBySignature || null;
6367
- }
6368
- if (action.type === ActionType.UNASSIGN) {
6369
- return null;
6370
- }
6371
- return signature;
6372
- }, null);
6373
- }
6374
6543
  function deepDropNulls(obj) {
6375
6544
  if (Array.isArray(obj)) {
6376
6545
  return obj.map(deepDropNulls);
@@ -6466,10 +6635,8 @@ function getCurrentEventState(event2, config) {
6466
6635
  createdBy: creationAction.createdBy,
6467
6636
  createdByUserType: creationAction.createdByUserType,
6468
6637
  createdAtLocation: creationAction.createdAtLocation,
6469
- createdBySignature: creationAction.createdBySignature,
6470
6638
  updatedAt: acceptedActionMetadata.createdAt,
6471
6639
  assignedTo: getAssignedUserFromActions(acceptedActions),
6472
- assignedToSignature: getAssignedUserSignatureFromActions(acceptedActions),
6473
6640
  updatedBy: requestActionMetadata.createdBy,
6474
6641
  updatedAtLocation: requestActionMetadata.createdAtLocation,
6475
6642
  declaration,
@@ -9728,7 +9895,6 @@ var eventQueryDataGenerator = (overrides = {}, seed = 1) => {
9728
9895
  createdBy: overrides.createdBy ?? generateUuid(rng),
9729
9896
  createdAtLocation: overrides.createdAtLocation ?? generateUuid(rng),
9730
9897
  updatedAtLocation: overrides.updatedAtLocation ?? generateUuid(rng),
9731
- createdBySignature: overrides.createdBySignature ?? generateRandomSignature(rng),
9732
9898
  updatedAt: overrides.updatedAt ?? (0, import_date_fns4.addDays)(new Date(createdAt), 1).toISOString(),
9733
9899
  assignedTo: overrides.assignedTo ?? null,
9734
9900
  updatedBy: overrides.updatedBy ?? generateUuid(rng),
@@ -10327,3 +10493,366 @@ function getFilePathsFromEvent(event2) {
10327
10493
  });
10328
10494
  return (0, import_lodash7.uniq)(filepaths);
10329
10495
  }
10496
+
10497
+ // ../commons/src/events/mocks.test.utils.ts
10498
+ var V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS = [
10499
+ {
10500
+ id: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10501
+ name: "Central",
10502
+ parentId: null,
10503
+ validUntil: null,
10504
+ externalId: "ydyJb1RAy4U1"
10505
+ },
10506
+ {
10507
+ id: "c599b691-fd2d-45e1-abf4-d185de727fb5",
10508
+ name: "Sulaka",
10509
+ parentId: null,
10510
+ validUntil: null,
10511
+ externalId: "pQ8nGxWmZ2Q3"
10512
+ },
10513
+ {
10514
+ id: "7ef2b9c7-5e6d-49f6-ae05-656207d0fc64",
10515
+ name: "Pualula",
10516
+ parentId: null,
10517
+ validUntil: null,
10518
+ externalId: "Aq91DweLmT8k"
10519
+ },
10520
+ {
10521
+ id: "6d1a59df-988c-4021-a846-ccbc021931a7",
10522
+ name: "Chuminga",
10523
+ parentId: null,
10524
+ validUntil: null,
10525
+ externalId: "Rw0fYNh2Xk9a"
10526
+ },
10527
+ {
10528
+ id: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10529
+ name: "Ibombo",
10530
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10531
+ validUntil: null,
10532
+ externalId: "k7DsP4vbN1Qe"
10533
+ },
10534
+ {
10535
+ id: "27160bbd-32d1-4625-812f-860226bfb92a",
10536
+ name: "Isango",
10537
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10538
+ validUntil: null,
10539
+ externalId: "Gm3Z9eQpHw4L"
10540
+ },
10541
+ {
10542
+ id: "967032fd-3f81-478a-826c-30cb8fe121bd",
10543
+ name: "Isamba",
10544
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10545
+ validUntil: null,
10546
+ externalId: "sT0xVu1KqJ7r"
10547
+ },
10548
+ {
10549
+ id: "89a33893-b17d-481d-a26d-6461e7ac1651",
10550
+ name: "Itambo",
10551
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10552
+ validUntil: null,
10553
+ externalId: "Nq6Bv2HpL9Te"
10554
+ },
10555
+ {
10556
+ id: "d42ab2fe-e7ed-470e-8b31-4fb27f9b8250",
10557
+ name: "Ezhi",
10558
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10559
+ validUntil: null,
10560
+ externalId: "xK8cQ0ZRy5Wd"
10561
+ },
10562
+ {
10563
+ id: "8fbd09d2-212b-47f4-beb3-5e1694931d9f",
10564
+ name: "Ilanga",
10565
+ parentId: "c599b691-fd2d-45e1-abf4-d185de727fb5",
10566
+ validUntil: null,
10567
+ externalId: "Cq4Jm1XvN8Ls"
10568
+ },
10569
+ // Villages under Ibombo (62a0ccb4-880d-4f30-8882-f256007dfff9)
10570
+ {
10571
+ id: "1d4e5f6a-7b8c-4912-8efa-345678901234",
10572
+ name: "Klow",
10573
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10574
+ validUntil: null,
10575
+ externalId: "IkYcYBUcyY2"
10576
+ },
10577
+ {
10578
+ id: "2e5f6a7b-8c9d-4a23-8fab-456789012345",
10579
+ name: "Mbondo",
10580
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10581
+ validUntil: null,
10582
+ externalId: "Qhvv5hvo3mY"
10583
+ },
10584
+ {
10585
+ id: "3f6a7b8c-9d0e-4b34-8abc-567890123456",
10586
+ name: "Ndara",
10587
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10588
+ validUntil: null,
10589
+ externalId: "crXh068O9TR"
10590
+ },
10591
+ {
10592
+ id: "4a7b8c9d-0e1f-4c45-abcd-678901234567",
10593
+ name: "Olani",
10594
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10595
+ validUntil: null,
10596
+ externalId: "r00It8Tvvp7"
10597
+ },
10598
+ {
10599
+ id: "5b8c9d0e-1f2a-4d56-bcde-789012345678",
10600
+ name: "Pemba",
10601
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10602
+ validUntil: null,
10603
+ externalId: "ZnUWsbONIaH"
10604
+ },
10605
+ {
10606
+ id: "6c9d0e1f-2a3b-4e67-8def-890123456789",
10607
+ name: "Quanza",
10608
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10609
+ validUntil: null,
10610
+ externalId: "fDZycvQTa7l"
10611
+ },
10612
+ {
10613
+ id: "7d0e1f2a-3b4c-4f78-8efa-901234567890",
10614
+ name: "Rivka",
10615
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10616
+ validUntil: null,
10617
+ externalId: "KqswxCGTELa"
10618
+ },
10619
+ // Villages under Isamba (967032fd-3f81-478a-826c-30cb8fe121bd)
10620
+ {
10621
+ id: "8e1f2a3b-4c5d-4089-8fab-012345678901",
10622
+ name: "Mbula",
10623
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10624
+ validUntil: null,
10625
+ externalId: "osEbKjRc9Kg"
10626
+ },
10627
+ {
10628
+ id: "9f2a3b4c-5d6e-4190-8abf-123456789012",
10629
+ name: "Ndoki",
10630
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10631
+ validUntil: null,
10632
+ externalId: "aq4daBUAGr3"
10633
+ },
10634
+ {
10635
+ id: "0a3b4c5d-6e7f-4201-abcd-234567890123",
10636
+ name: "Tsanga",
10637
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10638
+ validUntil: null,
10639
+ externalId: "cqis6Y8trbJ"
10640
+ },
10641
+ {
10642
+ id: "1b4c5d6e-7f8a-4312-bcde-345678901234",
10643
+ name: "Waziri",
10644
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10645
+ validUntil: null,
10646
+ externalId: "LMijHPyyx6d"
10647
+ },
10648
+ {
10649
+ id: "2c5d6e7f-8a9b-4423-8def-456789012345",
10650
+ name: "Zimbi",
10651
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10652
+ validUntil: null,
10653
+ externalId: "pcQYbPuKGZ7"
10654
+ },
10655
+ // Villages under Itambo (89a33893-b17d-481d-a26d-6461e7ac1651)
10656
+ {
10657
+ id: "3d6e7f8a-9b0c-4534-8efa-567890123456",
10658
+ name: "Felani",
10659
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10660
+ validUntil: null,
10661
+ externalId: "gSqpoCGdMXp"
10662
+ },
10663
+ {
10664
+ id: "4e7f8a9b-0c1d-4645-8fab-678901234567",
10665
+ name: "Goroma",
10666
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10667
+ validUntil: null,
10668
+ externalId: "KvAAIaNqVrp"
10669
+ },
10670
+ {
10671
+ id: "5f8a9b0c-1d2e-4756-8abc-789012345678",
10672
+ name: "Halifu",
10673
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10674
+ validUntil: null,
10675
+ externalId: "qe4UnEVt1hv"
10676
+ },
10677
+ {
10678
+ id: "6a9b0c1d-2e3f-4867-abcd-890123456789",
10679
+ name: "Jabari",
10680
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10681
+ validUntil: null,
10682
+ externalId: "yHH9Nz4rLOt"
10683
+ },
10684
+ {
10685
+ id: "7b0c1d2e-3f4a-4978-bcde-901234567890",
10686
+ name: "Kifani",
10687
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10688
+ validUntil: null,
10689
+ externalId: "eSWmXIGeu1I"
10690
+ },
10691
+ {
10692
+ id: "8c1d2e3f-4a5b-4089-8def-012345678901",
10693
+ name: "Lumela",
10694
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10695
+ validUntil: null,
10696
+ externalId: "bh0b3aI1uP3"
10697
+ }
10698
+ ];
10699
+ var V2_DEFAULT_MOCK_LOCATIONS = [
10700
+ {
10701
+ id: "6f6186ce-cd5f-4a5f-810a-2d99e7c4ba12",
10702
+ name: "Central Provincial Office",
10703
+ locationType: "CRVS_OFFICE",
10704
+ administrativeAreaId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10705
+ validUntil: null,
10706
+ externalId: "Xr3Df8WpK6Ys"
10707
+ },
10708
+ {
10709
+ id: "b1c2d3e4-f5a6-7890-bcde-f12345678901",
10710
+ name: "Central Health Post",
10711
+ locationType: "HEALTH_FACILITY",
10712
+ administrativeAreaId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10713
+ validUntil: null
10714
+ },
10715
+ {
10716
+ id: "028d2c85-ca31-426d-b5d1-2cef545a4902",
10717
+ name: "Ibombo District Office",
10718
+ locationType: "CRVS_OFFICE",
10719
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10720
+ validUntil: null,
10721
+ externalId: "Sm4Nw7GrD2Vy"
10722
+ },
10723
+ {
10724
+ id: "62a0ccb4-4f30-4f30-8882-f256007dff9f",
10725
+ name: "Isamba District Office",
10726
+ locationType: "CRVS_OFFICE",
10727
+ administrativeAreaId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10728
+ validUntil: null,
10729
+ externalId: "Vg1Bq5XeH9Lt"
10730
+ },
10731
+ {
10732
+ id: "954c93e1-13f7-4435-bb82-35e0e215e07d",
10733
+ name: "Isango District Office",
10734
+ locationType: "CRVS_OFFICE",
10735
+ administrativeAreaId: "27160bbd-32d1-4625-812f-860226bfb92a",
10736
+ validUntil: null,
10737
+ externalId: "Je7Lm2XqN9Vz"
10738
+ },
10739
+ {
10740
+ id: "2884f5b9-17b4-49ce-bf4d-f538228935df",
10741
+ name: "Sulaka Provincial Office",
10742
+ locationType: "CRVS_OFFICE",
10743
+ administrativeAreaId: "c599b691-fd2d-45e1-abf4-d185de727fb5",
10744
+ validUntil: null,
10745
+ externalId: "Ht2Wp9KcX5Qv"
10746
+ },
10747
+ {
10748
+ id: "030358c6-54af-44be-821b-8e4af963a49c",
10749
+ name: "Ilanga District Office",
10750
+ locationType: "CRVS_OFFICE",
10751
+ administrativeAreaId: "8fbd09d2-212b-47f4-beb3-5e1694931d9f",
10752
+ validUntil: null,
10753
+ externalId: "Yp6Ds1WqN3Xz"
10754
+ },
10755
+ {
10756
+ id: "423d000f-101b-47c0-8b86-21a908067cee",
10757
+ name: "Chamakubi Health Post",
10758
+ locationType: "HEALTH_FACILITY",
10759
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10760
+ validUntil: null,
10761
+ externalId: "M1nFr8LbC2Qy"
10762
+ },
10763
+ {
10764
+ id: "4d3279be-d026-420c-88f7-f0a4ae986973",
10765
+ name: "Ibombo Rural Health Centre",
10766
+ locationType: "HEALTH_FACILITY",
10767
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10768
+ validUntil: null,
10769
+ externalId: "bT7pV6YrW0Xc"
10770
+ },
10771
+ {
10772
+ id: "190902f4-1d77-476a-8947-41145af1db7d",
10773
+ name: "Chikobo Rural Health Centre",
10774
+ locationType: "HEALTH_FACILITY",
10775
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10776
+ validUntil: null,
10777
+ externalId: "zE4qPn2SgJ5d"
10778
+ },
10779
+ {
10780
+ id: "f5ecbd9b-a01e-4a65-910e-70e86ab41b71",
10781
+ name: "Chilochabalenje Health Post",
10782
+ locationType: "HEALTH_FACILITY",
10783
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10784
+ validUntil: null,
10785
+ externalId: "H8vDs1MqR4Uf"
10786
+ },
10787
+ {
10788
+ id: "dbfc178f-7295-4b90-b28d-111c95b03127",
10789
+ name: "Chipeso Rural Health Centre",
10790
+ locationType: "HEALTH_FACILITY",
10791
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10792
+ validUntil: null,
10793
+ externalId: "Qw3uZ9KfX6Lm"
10794
+ },
10795
+ {
10796
+ id: "09862bfe-c7ac-46cd-987b-668681533c80",
10797
+ name: "Chisamba Rural Health Centre",
10798
+ locationType: "HEALTH_FACILITY",
10799
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10800
+ validUntil: null,
10801
+ externalId: "Yr0pCg8LdM2s"
10802
+ },
10803
+ {
10804
+ id: "834ce389-e95b-4fb0-96a0-33e9ab323059",
10805
+ name: "Chitanda Rural Health Centre",
10806
+ locationType: "HEALTH_FACILITY",
10807
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10808
+ validUntil: null,
10809
+ externalId: "tS9gJ4PwB1Qx"
10810
+ },
10811
+ {
10812
+ id: "0431c433-6062-4a4c-aee9-25271aec61ee",
10813
+ name: "Golden Valley Rural Health Centre",
10814
+ locationType: "HEALTH_FACILITY",
10815
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10816
+ validUntil: null,
10817
+ externalId: "Ld7Qm3XsA8Vr"
10818
+ },
10819
+ {
10820
+ id: "bc84d0b6-7ba7-480d-a339-5d9920d90eb2",
10821
+ name: "Ipongo Rural Health Centre",
10822
+ locationType: "HEALTH_FACILITY",
10823
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10824
+ validUntil: null,
10825
+ externalId: "kF2sW9DmH0Bt"
10826
+ },
10827
+ {
10828
+ id: "4cf1f53b-b730-41d2-8649-dff7eeed970d",
10829
+ name: "Itumbwe Health Post",
10830
+ locationType: "HEALTH_FACILITY",
10831
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10832
+ validUntil: null,
10833
+ externalId: "Ue5Xb3VaC7Pq"
10834
+ },
10835
+ {
10836
+ id: "4b3676cb-9355-4942-9eb9-2ce46acaf0e0",
10837
+ name: "Kabangalala Rural Health Centre",
10838
+ locationType: "HEALTH_FACILITY",
10839
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10840
+ validUntil: null,
10841
+ externalId: "Pz8Kc1TqH6Jn"
10842
+ },
10843
+ // Village offices
10844
+ {
10845
+ id: "1f4a5b6c-7d8e-4312-8abc-345678901234",
10846
+ name: "Klow Village Office",
10847
+ locationType: "CRVS_OFFICE",
10848
+ administrativeAreaId: "1d4e5f6a-7b8c-4912-8efa-345678901234",
10849
+ validUntil: null,
10850
+ externalId: "PmAyxAJkxiJ"
10851
+ }
10852
+ ];
10853
+ var V2_DEFAULT_MOCK_LOCATIONS_MAP = new Map(
10854
+ V2_DEFAULT_MOCK_LOCATIONS.map((l) => [l.id, l])
10855
+ );
10856
+ var V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP = new Map(
10857
+ V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS.map((a) => [a.id, a])
10858
+ );