@opencrvs/toolkit 2.0.0-rc.e12df15 → 2.0.0-rc.e260b0b

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 (52) hide show
  1. package/create-countryconfig/index.js +73 -0
  2. package/create-countryconfig/package.json +21 -0
  3. package/dist/application-config/index.js +227 -92
  4. package/dist/cli.js +507 -171
  5. package/dist/commons/api/router.d.ts +3343 -266
  6. package/dist/commons/application-config/index.d.ts +16 -4
  7. package/dist/commons/conditionals/conditionals.d.ts +3 -3
  8. package/dist/commons/conditionals/validate.d.ts +1 -0
  9. package/dist/commons/events/ActionInput.d.ts +108 -0
  10. package/dist/commons/events/Draft.d.ts +4 -2
  11. package/dist/commons/events/EventIndex.d.ts +0 -3
  12. package/dist/commons/events/EventMetadata.d.ts +0 -7
  13. package/dist/commons/events/FieldConfig.d.ts +5 -0
  14. package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
  15. package/dist/commons/events/locations.d.ts +21 -0
  16. package/dist/commons/events/mocks.test.utils.d.ts +19 -0
  17. package/dist/commons/events/scopes.d.ts +24 -1
  18. package/dist/commons/events/state/index.d.ts +0 -4
  19. package/dist/commons/events/state/utils.d.ts +0 -2
  20. package/dist/commons/events/utils.d.ts +1 -1
  21. package/dist/conditionals/index.js +8 -4
  22. package/dist/events/index.js +362 -150
  23. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
  24. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +60 -35
  25. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  26. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  27. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -2
  28. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +9 -1
  29. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -1
  30. package/dist/migrations/v2.0/delete-infrastructure-directory.js +66 -20
  31. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  32. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  33. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  34. package/dist/migrations/v2.0/index.d.ts +5 -3
  35. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  36. package/dist/migrations/v2.0/index.js +505 -169
  37. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  38. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +90 -1
  39. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +11 -1
  40. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -1
  41. package/dist/migrations/v2.0/merge-infrastructure-directory.js +17 -16
  42. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  43. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  44. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  45. package/dist/migrations/v2.0/migrate-workqueue-configs.js +140 -59
  46. package/dist/notification/index.js +294 -120
  47. package/dist/scopes/index.d.ts +6 -1
  48. package/dist/scopes/index.js +8 -4
  49. package/opencrvs-toolkit-2.0.0-rc.e260b0b.tgz +0 -0
  50. package/package.json +5 -1
  51. package/tsconfig.tsbuildinfo +1 -1
  52. package/opencrvs-toolkit-2.0.0-rc.e12df15.tgz +0 -0
@@ -302,12 +302,13 @@ __export(events_exports, {
302
302
  getActionConfig: () => getActionConfig,
303
303
  getActionReview: () => getActionReview,
304
304
  getActionReviewFields: () => getActionReviewFields,
305
+ getAdministrativeAreaHierarchy: () => getAdministrativeAreaHierarchy,
305
306
  getAllUniqueFields: () => getAllUniqueFields,
306
307
  getAnnotationFromDrafts: () => getAnnotationFromDrafts,
307
308
  getAssignedUserFromActions: () => getAssignedUserFromActions,
308
- getAssignedUserSignatureFromActions: () => getAssignedUserSignatureFromActions,
309
309
  getAssignmentStatus: () => getAssignmentStatus,
310
310
  getAvailableActionsForEvent: () => getAvailableActionsForEvent,
311
+ getAvailableRolesForUserUpdatePayload: () => getAvailableRolesForUserUpdatePayload,
311
312
  getCompleteActionAnnotation: () => getCompleteActionAnnotation,
312
313
  getCompleteActionDeclaration: () => getCompleteActionDeclaration,
313
314
  getCurrentEventState: () => getCurrentEventState,
@@ -318,6 +319,7 @@ __export(events_exports, {
318
319
  getDeclarationPages: () => getDeclarationPages,
319
320
  getEventConfigById: () => getEventConfigById,
320
321
  getFilePathsFromEvent: () => getFilePathsFromEvent,
322
+ getLocationHierarchy: () => getLocationHierarchy,
321
323
  getMixedPath: () => getMixedPath,
322
324
  getPendingAction: () => getPendingAction,
323
325
  getPrintCertificatePages: () => getPrintCertificatePages,
@@ -607,12 +609,14 @@ var SystemScopeType = z2.enum([
607
609
  "organisation.read-locations",
608
610
  "user.read",
609
611
  "user.create",
610
- "user.edit"
612
+ "user.edit",
613
+ "user.search"
611
614
  ]);
612
615
  var UserScopeType = SystemScopeType.extract([
613
616
  "user.read",
614
617
  "user.create",
615
- "user.edit"
618
+ "user.edit",
619
+ "user.search"
616
620
  ]);
617
621
  var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
618
622
  var UserScopeV2 = z2.discriminatedUnion("type", [
@@ -621,7 +625,7 @@ var UserScopeV2 = z2.discriminatedUnion("type", [
621
625
  options: AllUserScopeOptions.optional()
622
626
  }),
623
627
  z2.object({
624
- type: UserScopeType.extract(["user.read"]),
628
+ type: UserScopeType.extract(["user.read", "user.search"]),
625
629
  options: AccessLevelOptions.optional()
626
630
  })
627
631
  ]);
@@ -700,7 +704,9 @@ var decodeScope = (query) => {
700
704
  };
701
705
  var DEFAULT_SCOPE_OPTIONS = {
702
706
  placeOfEvent: JurisdictionFilter.enum.all,
703
- accessLevel: JurisdictionFilter.enum.all
707
+ accessLevel: JurisdictionFilter.enum.all,
708
+ registeredIn: JurisdictionFilter.enum.all,
709
+ declaredIn: JurisdictionFilter.enum.all
704
710
  };
705
711
  function getAcceptedScopesByType({
706
712
  acceptedScopes,
@@ -1073,7 +1079,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
1073
1079
  ShowConditional,
1074
1080
  // Action can be shown to the user in the list but as disabled
1075
1081
  EnableConditional
1076
- ]);
1082
+ ]).meta({
1083
+ id: "ActionConditional",
1084
+ description: "Conditional gating whether an action is shown (SHOW) or enabled (ENABLE). When omitted from an action, the action is shown and enabled for everyone."
1085
+ });
1077
1086
  var DisplayOnReviewConditional = z7.object({
1078
1087
  type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
1079
1088
  conditional: Conditional
@@ -1088,8 +1097,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
1088
1097
  // Field output can be shown / hidden on the review page
1089
1098
  DisplayOnReviewConditional
1090
1099
  ]).meta({
1091
- description: "Field conditional configuration",
1092
- id: "FieldConditional"
1100
+ id: "FieldConditional",
1101
+ description: "Conditional gating whether a form field is shown (SHOW), enabled (ENABLE), or displayed on the review page (DISPLAY_ON_REVIEW). When omitted, the field is shown and enabled for everyone, and is displayed on review whenever it has a value."
1093
1102
  });
1094
1103
 
1095
1104
  // ../commons/src/events/FieldType.ts
@@ -1409,28 +1418,20 @@ function schemaPriority(schema) {
1409
1418
  return idx === -1 ? 9999 : idx;
1410
1419
  }
1411
1420
  function safeUnion(schemas) {
1421
+ const sortedSchemas = [...schemas].sort(
1422
+ (a, b) => schemaPriority(a) - schemaPriority(b)
1423
+ );
1412
1424
  return z12.any().superRefine((val, ctx) => {
1413
- const successful = schemas.filter((s) => s.safeParse(val).success);
1414
- if (successful.length === 1) {
1415
- return;
1416
- }
1417
- if (successful.length === 0) {
1418
- ctx.addIssue({
1419
- code: "invalid_type",
1420
- expected: "custom",
1421
- message: "Value does not match any schema"
1422
- });
1423
- return;
1424
- }
1425
- successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
1426
- const best = successful[0];
1427
- if (!best.safeParse(val).success) {
1428
- ctx.addIssue({
1429
- expected: "custom",
1430
- code: "invalid_type",
1431
- message: "Value did not match the best schema"
1432
- });
1425
+ for (const schema of sortedSchemas) {
1426
+ if (schema.safeParse(val).success) {
1427
+ return;
1428
+ }
1433
1429
  }
1430
+ ctx.addIssue({
1431
+ code: "invalid_type",
1432
+ expected: "custom",
1433
+ message: "Value does not match any schema"
1434
+ });
1434
1435
  }).meta({
1435
1436
  description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
1436
1437
  });
@@ -1740,6 +1741,9 @@ var FlagConfig = z15.object({
1740
1741
  "Indicates if this flag expects an action to be performed to be cleared."
1741
1742
  ),
1742
1743
  label: TranslationConfig.describe("Human readable label of the flag.")
1744
+ }).meta({
1745
+ id: "FlagConfig",
1746
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1743
1747
  });
1744
1748
  var ActionFlagConfig = z15.object({
1745
1749
  id: Flag,
@@ -1747,6 +1751,9 @@ var ActionFlagConfig = z15.object({
1747
1751
  conditional: Conditional.optional().describe(
1748
1752
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1749
1753
  )
1754
+ }).meta({
1755
+ id: "ActionFlagConfig",
1756
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1750
1757
  });
1751
1758
 
1752
1759
  // ../commons/src/events/EventMetadata.ts
@@ -1768,8 +1775,7 @@ var ActionCreationMetadata = z16.object({
1768
1775
  ),
1769
1776
  createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1770
1777
  acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
1771
- createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation."),
1772
- createdBySignature: z16.string().nullish().describe("Signature of the user who created the action request.")
1778
+ createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
1773
1779
  });
1774
1780
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1775
1781
  registrationNumber: z16.string().describe(
@@ -1797,9 +1803,6 @@ var EventMetadata = z16.object({
1797
1803
  createdAtLocation: UUID.nullish().describe(
1798
1804
  "Location of the user who created the event."
1799
1805
  ),
1800
- createdBySignature: DocumentPath.nullish().describe(
1801
- "Signature of the user who created the event."
1802
- ),
1803
1806
  updatedAtLocation: UUID.nullish().describe(
1804
1807
  "Location of the user who last changed the status."
1805
1808
  ),
@@ -2174,14 +2177,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
2174
2177
  }
2175
2178
  }).describe("Unique identifier for the field");
2176
2179
  var FieldReference = import_v43.default.object({
2177
- $$field: FieldId,
2180
+ $$field: FieldId.describe("Id of the field to reference"),
2178
2181
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
2179
2182
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
2180
2183
  )
2181
2184
  }).describe("Reference to a field by its ID");
2182
2185
  var ValidationConfig = import_v43.default.object({
2183
- validator: Conditional,
2184
- message: TranslationConfig
2186
+ validator: Conditional.describe(
2187
+ "Conditional expression that must hold for the field value to be considered valid."
2188
+ ),
2189
+ message: TranslationConfig.describe(
2190
+ "Error message displayed when the validator does not hold."
2191
+ )
2192
+ }).meta({
2193
+ id: "ValidationConfig",
2194
+ description: "Validation rule applied to a form field. The validator is a conditional expression that must hold for the field value to be considered valid."
2185
2195
  });
2186
2196
  var requiredSchema = import_v43.default.union([
2187
2197
  import_v43.default.boolean(),
@@ -2220,6 +2230,9 @@ var BaseField = import_v43.default.object({
2220
2230
  }).describe("Common properties shared across all field types.");
2221
2231
  var Divider = BaseField.extend({
2222
2232
  type: import_v43.default.literal(FieldType.DIVIDER)
2233
+ }).meta({
2234
+ description: "A horizontal line divider",
2235
+ id: "Divider"
2223
2236
  });
2224
2237
  var TextField = BaseField.extend({
2225
2238
  type: import_v43.default.literal(FieldType.TEXT),
@@ -2230,7 +2243,10 @@ var TextField = BaseField.extend({
2230
2243
  prefix: TranslationConfig.optional(),
2231
2244
  postfix: TranslationConfig.optional()
2232
2245
  }).default({ type: "text" }).optional()
2233
- }).describe("Text input");
2246
+ }).meta({
2247
+ description: "A text input field",
2248
+ id: "TextField"
2249
+ });
2234
2250
  var NumberField = BaseField.extend({
2235
2251
  type: import_v43.default.literal(FieldType.NUMBER),
2236
2252
  defaultValue: NumberFieldValue.optional(),
@@ -2240,7 +2256,10 @@ var NumberField = BaseField.extend({
2240
2256
  prefix: TranslationConfig.optional(),
2241
2257
  postfix: TranslationConfig.optional()
2242
2258
  }).optional()
2243
- }).describe("Number input");
2259
+ }).meta({
2260
+ description: "A number input field",
2261
+ id: "NumberField"
2262
+ });
2244
2263
  var TextAreaField = BaseField.extend({
2245
2264
  type: import_v43.default.literal(FieldType.TEXTAREA),
2246
2265
  defaultValue: NonEmptyTextValue.optional(),
@@ -2251,7 +2270,10 @@ var TextAreaField = BaseField.extend({
2251
2270
  prefix: TranslationConfig.optional(),
2252
2271
  postfix: TranslationConfig.optional()
2253
2272
  }).default({ rows: 4 }).optional()
2254
- }).describe("Multiline text input");
2273
+ }).meta({
2274
+ description: "A multiline text input",
2275
+ id: "TextAreaField"
2276
+ });
2255
2277
  var ImageMimeType = import_v43.default.enum([
2256
2278
  "image/png",
2257
2279
  "image/jpg",
@@ -2281,13 +2303,19 @@ var SignatureField = BaseField.extend({
2281
2303
  }).default({
2282
2304
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2283
2305
  })
2284
- }).describe("Signature input field");
2306
+ }).meta({
2307
+ description: "A signature input field",
2308
+ id: "SignatureField"
2309
+ });
2285
2310
  var EmailField = BaseField.extend({
2286
2311
  type: import_v43.default.literal(FieldType.EMAIL),
2287
2312
  configuration: import_v43.default.object({
2288
2313
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
2289
2314
  }).default({ maxLength: 255 }).optional(),
2290
2315
  defaultValue: NonEmptyTextValue.optional()
2316
+ }).meta({
2317
+ description: "An email input field",
2318
+ id: "EmailField"
2291
2319
  });
2292
2320
  var DateField = BaseField.extend({
2293
2321
  type: import_v43.default.literal(FieldType.DATE),
@@ -2297,7 +2325,10 @@ var DateField = BaseField.extend({
2297
2325
  "Text to display above the date input"
2298
2326
  ).optional()
2299
2327
  }).optional()
2300
- }).describe("A single date input (yyyy-MM-dd)");
2328
+ }).meta({
2329
+ description: "A date input (yyyy-MM-dd)",
2330
+ id: "DateField"
2331
+ });
2301
2332
  var AgeField = BaseField.extend({
2302
2333
  type: import_v43.default.literal(FieldType.AGE),
2303
2334
  defaultValue: NumberFieldValue.optional(),
@@ -2306,7 +2337,10 @@ var AgeField = BaseField.extend({
2306
2337
  prefix: TranslationConfig.optional(),
2307
2338
  postfix: TranslationConfig.optional()
2308
2339
  })
2309
- }).describe("An age input field which uses the current date as the asOfDate");
2340
+ }).meta({
2341
+ description: "An age input field which uses the current date as the asOfDate",
2342
+ id: "AgeField"
2343
+ });
2310
2344
  var TimeField = BaseField.extend({
2311
2345
  type: import_v43.default.literal(FieldType.TIME),
2312
2346
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -2316,7 +2350,10 @@ var TimeField = BaseField.extend({
2316
2350
  "Text to display above the time input"
2317
2351
  ).optional()
2318
2352
  }).optional()
2319
- }).describe("A single date input (HH-mm)");
2353
+ }).meta({
2354
+ description: "A single time input (HH-mm)",
2355
+ id: "TimeField"
2356
+ });
2320
2357
  var DateRangeField = BaseField.extend({
2321
2358
  type: import_v43.default.literal(FieldType.DATE_RANGE),
2322
2359
  defaultValue: DateRangeFieldValue.optional(),
@@ -2325,7 +2362,10 @@ var DateRangeField = BaseField.extend({
2325
2362
  "Text to display above the date input"
2326
2363
  ).optional()
2327
2364
  }).optional()
2328
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
2365
+ }).meta({
2366
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
2367
+ id: "DateRangeField"
2368
+ });
2329
2369
  var HtmlFontVariant = import_v43.default.enum([
2330
2370
  "reg12",
2331
2371
  "reg14",
@@ -2369,18 +2409,30 @@ var ImageViewField = BaseField.extend({
2369
2409
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
2370
2410
  defaultValue: NonEmptyTextValue.optional(),
2371
2411
  configuration: ImageConfiguration
2372
- }).describe("A read-only image component for form pages");
2412
+ }).meta({
2413
+ description: "A read-only image component for form pages",
2414
+ id: "ImageViewField"
2415
+ });
2373
2416
  var Paragraph = BaseField.extend({
2374
2417
  type: import_v43.default.literal(FieldType.PARAGRAPH),
2375
2418
  configuration: ParagraphConfiguration
2376
- }).describe("A read-only HTML <p> paragraph");
2419
+ }).meta({
2420
+ description: "A read-only HTML <p> paragraph",
2421
+ id: "Paragraph"
2422
+ });
2377
2423
  var Heading = BaseField.extend({
2378
2424
  type: import_v43.default.literal(FieldType.HEADING),
2379
2425
  configuration: HeadingConfiguration
2380
- }).describe("A read-only heading component for form pages");
2426
+ }).meta({
2427
+ description: "A read-only heading component for form pages",
2428
+ id: "Heading"
2429
+ });
2381
2430
  var PageHeader = BaseField.extend({
2382
2431
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
2383
- }).describe("A read-only header component for form pages");
2432
+ }).meta({
2433
+ description: "A read-only header component for form pages",
2434
+ id: "PageHeader"
2435
+ });
2384
2436
  var File = BaseField.extend({
2385
2437
  type: import_v43.default.literal(FieldType.FILE),
2386
2438
  defaultValue: FileFieldValue.optional(),
@@ -2399,7 +2451,10 @@ var File = BaseField.extend({
2399
2451
  }).default({
2400
2452
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2401
2453
  })
2402
- }).describe("File upload");
2454
+ }).meta({
2455
+ description: "A file upload field",
2456
+ id: "File"
2457
+ });
2403
2458
  var SelectOption = import_v43.default.object({
2404
2459
  value: import_v43.default.string().describe("The value of the option"),
2405
2460
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -2416,7 +2471,10 @@ var NumberWithUnitField = BaseField.extend({
2416
2471
  "Placeholder for the number field"
2417
2472
  )
2418
2473
  }).optional()
2419
- }).describe("Number with unit input");
2474
+ }).meta({
2475
+ description: "A number with unit input field",
2476
+ id: "NumberWithUnitField"
2477
+ });
2420
2478
  var RadioGroup = BaseField.extend({
2421
2479
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
2422
2480
  defaultValue: TextValue.optional(),
@@ -2426,7 +2484,10 @@ var RadioGroup = BaseField.extend({
2426
2484
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
2427
2485
  }).optional()
2428
2486
  }).optional()
2429
- }).describe("Grouped radio options");
2487
+ }).meta({
2488
+ description: "A grouped radio button field",
2489
+ id: "RadioGroup"
2490
+ });
2430
2491
  var BulletList = BaseField.extend({
2431
2492
  type: import_v43.default.literal(FieldType.BULLET_LIST),
2432
2493
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -2435,7 +2496,10 @@ var BulletList = BaseField.extend({
2435
2496
  fontVariant: HtmlFontVariant.optional()
2436
2497
  }).optional()
2437
2498
  }).default({})
2438
- }).describe("A list of bullet points");
2499
+ }).meta({
2500
+ description: "A list of bullet points",
2501
+ id: "BulletList"
2502
+ });
2439
2503
  var Select = BaseField.extend({
2440
2504
  type: import_v43.default.literal(FieldType.SELECT),
2441
2505
  defaultValue: TextValue.optional(),
@@ -2450,7 +2514,10 @@ var Select = BaseField.extend({
2450
2514
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
2451
2515
  `
2452
2516
  )
2453
- }).describe("Select input");
2517
+ }).meta({
2518
+ description: "A select input field",
2519
+ id: "Select"
2520
+ });
2454
2521
  var SelectDateRangeOption = import_v43.default.object({
2455
2522
  value: SelectDateRangeValue.describe("The value of the option"),
2456
2523
  label: TranslationConfig.describe("The label of the option")
@@ -2459,7 +2526,10 @@ var SelectDateRangeField = BaseField.extend({
2459
2526
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
2460
2527
  defaultValue: SelectDateRangeValue.optional(),
2461
2528
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
2462
- }).describe("Select input with date range options");
2529
+ }).meta({
2530
+ description: "A date range selection field",
2531
+ id: "SelectDateRangeField"
2532
+ });
2463
2533
  var NameConfig = import_v43.default.object({
2464
2534
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
2465
2535
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -2490,26 +2560,41 @@ var NameField = BaseField.extend({
2490
2560
  surname: { required: true }
2491
2561
  }
2492
2562
  }).optional()
2493
- }).describe("Name input field");
2563
+ }).meta({
2564
+ description: "A field for entering a persons name",
2565
+ id: "NameField"
2566
+ });
2494
2567
  var PhoneField = BaseField.extend({
2495
2568
  defaultValue: NonEmptyTextValue.optional(),
2496
2569
  type: import_v43.default.literal(FieldType.PHONE)
2497
- }).describe("Phone input field");
2570
+ }).meta({
2571
+ description: "A field for entering a phone number",
2572
+ id: "PhoneField"
2573
+ });
2498
2574
  var IdField = BaseField.extend({
2499
2575
  defaultValue: NonEmptyTextValue.optional(),
2500
2576
  type: import_v43.default.literal(FieldType.ID)
2501
- }).describe("ID input field");
2577
+ }).meta({
2578
+ description: "A field for entering an ID",
2579
+ id: "IdField"
2580
+ });
2502
2581
  var Checkbox = BaseField.extend({
2503
2582
  type: import_v43.default.literal(FieldType.CHECKBOX),
2504
2583
  defaultValue: CheckboxFieldValue.default(false)
2505
- }).describe("Boolean checkbox field");
2584
+ }).meta({
2585
+ description: "A boolean checkbox field",
2586
+ id: "Checkbox"
2587
+ });
2506
2588
  var Country = BaseField.extend({
2507
2589
  type: import_v43.default.literal(FieldType.COUNTRY),
2508
2590
  defaultValue: NonEmptyTextValue.optional(),
2509
2591
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
2510
2592
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
2511
2593
  )
2512
- }).describe("Country select field");
2594
+ }).meta({
2595
+ description: "A field for selecting a country",
2596
+ id: "Country"
2597
+ });
2513
2598
  var AllowedLocations = JurisdictionReference.optional().describe(
2514
2599
  "Limits which location options are selectable depending on user jurisdiction and location."
2515
2600
  );
@@ -2518,16 +2603,18 @@ var AdministrativeAreas = import_v43.default.enum([
2518
2603
  "HEALTH_FACILITY",
2519
2604
  "CRVS_OFFICE"
2520
2605
  ]);
2521
- var AdministrativeAreaConfiguration = import_v43.default.object({
2522
- partOf: FieldReference.optional().describe("Parent location"),
2523
- type: AdministrativeAreas,
2524
- allowedLocations: AllowedLocations
2525
- }).describe("Administrative area options");
2526
2606
  var AdministrativeAreaField = BaseField.extend({
2527
2607
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
2528
2608
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
2529
- configuration: AdministrativeAreaConfiguration
2530
- }).describe("Administrative area input field e.g. facility, office");
2609
+ configuration: import_v43.default.object({
2610
+ partOf: FieldReference.optional().describe("Parent location"),
2611
+ type: AdministrativeAreas,
2612
+ allowedLocations: AllowedLocations
2613
+ }).describe("Administrative area options")
2614
+ }).meta({
2615
+ description: "Administrative area input field",
2616
+ id: "AdministrativeAreaField"
2617
+ });
2531
2618
  var LocationInput = BaseField.extend({
2532
2619
  type: import_v43.default.literal(FieldType.LOCATION),
2533
2620
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -2535,7 +2622,10 @@ var LocationInput = BaseField.extend({
2535
2622
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
2536
2623
  allowedLocations: AllowedLocations
2537
2624
  }).optional()
2538
- }).describe("Input field for a location");
2625
+ }).meta({
2626
+ description: "A field for selecting a location",
2627
+ id: "LocationInput"
2628
+ });
2539
2629
  var FileUploadWithOptions = BaseField.extend({
2540
2630
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
2541
2631
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -2549,6 +2639,9 @@ var FileUploadWithOptions = BaseField.extend({
2549
2639
  }).default({
2550
2640
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2551
2641
  })
2642
+ }).meta({
2643
+ description: "A field for uploading files with file type options",
2644
+ id: "FileUploadWithOptions"
2552
2645
  });
2553
2646
  var Facility = BaseField.extend({
2554
2647
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -2594,7 +2687,10 @@ var Address = BaseField.extend({
2594
2687
  allowedLocations: AllowedLocations
2595
2688
  }).optional(),
2596
2689
  defaultValue: DefaultAddressFieldValue.optional()
2597
- }).describe("Address input field \u2013 a combination of location and text fields");
2690
+ }).meta({
2691
+ description: "Address input field \u2013 a combination of location and text fields",
2692
+ id: "Address"
2693
+ });
2598
2694
  var StaticDataEntry = import_v43.default.object({
2599
2695
  id: import_v43.default.string().describe("ID for the data entry."),
2600
2696
  label: TranslationConfig,
@@ -2609,7 +2705,10 @@ var DataField = BaseField.extend({
2609
2705
  subtitle: TranslationConfig.optional(),
2610
2706
  data: import_v43.default.array(DataEntry)
2611
2707
  })
2612
- }).describe("Data field for displaying read-only data");
2708
+ }).meta({
2709
+ description: "A field for displaying a table of read-only data",
2710
+ id: "DataField"
2711
+ });
2613
2712
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
2614
2713
  var ButtonType = import_v43.default.enum([
2615
2714
  "primary",
@@ -2636,11 +2735,17 @@ var ButtonField = BaseField.extend({
2636
2735
  type: import_v43.default.literal(FieldType.BUTTON),
2637
2736
  defaultValue: ButtonFieldValue.optional(),
2638
2737
  configuration: ButtonConfiguration
2639
- }).describe("Generic button without any built-in functionality");
2738
+ }).meta({
2739
+ description: "A generic button that can be used to trigger an action",
2740
+ id: "ButtonField"
2741
+ });
2640
2742
  var FieldGroup = BaseField.extend({
2641
2743
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
2642
2744
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
2643
2745
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
2746
+ }).meta({
2747
+ description: "A group of fields that are displayed together",
2748
+ id: "FieldGroup"
2644
2749
  });
2645
2750
  var AlphaPrintButton = BaseField.extend({
2646
2751
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -2650,7 +2755,10 @@ var AlphaPrintButton = BaseField.extend({
2650
2755
  "Label for the print button"
2651
2756
  )
2652
2757
  })
2653
- }).describe("Print button field for printing certificates");
2758
+ }).meta({
2759
+ description: "An experimental print button field for printing certificates during the declaration process",
2760
+ id: "AlphaPrintButton"
2761
+ });
2654
2762
  var HttpField = BaseField.extend({
2655
2763
  type: import_v43.default.literal(FieldType.HTTP),
2656
2764
  defaultValue: HttpFieldValue.optional(),
@@ -2666,20 +2774,30 @@ var HttpField = BaseField.extend({
2666
2774
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
2667
2775
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
2668
2776
  })
2669
- }).describe("HTTP request function triggered by a button click or other event");
2777
+ }).meta({
2778
+ description: "Makes a background HTTP request to an external service and stores the response so other fields can use it. Has no visible UI \u2014 pair with LOADER to show request status.",
2779
+ id: "HttpField"
2780
+ });
2670
2781
  var AutocompleteField = BaseField.extend({
2671
2782
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
2672
2783
  configuration: import_v43.default.object({
2673
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2784
+ url: import_v43.default.string().describe(
2785
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2786
+ ).optional(),
2674
2787
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
2675
2788
  defaultOptions: import_v43.default.array(
2676
2789
  import_v43.default.object({
2677
2790
  label: import_v43.default.string(),
2678
2791
  value: import_v43.default.string()
2679
2792
  })
2680
- ).optional()
2793
+ ).optional().describe(
2794
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2795
+ )
2681
2796
  })
2682
- }).describe("Autocomplete input field");
2797
+ }).meta({
2798
+ description: "Generic autocomplete component designed for use with large dictionary-based datasets. The component supports dynamic retrieval of options from configurable data sources and is intended for datasets that may contain tens or hundreds of thousands of records.",
2799
+ id: "AutocompleteField"
2800
+ });
2683
2801
  var SearchField = HttpField.extend({
2684
2802
  type: import_v43.default.literal(FieldType.SEARCH),
2685
2803
  configuration: SearchQuery.pick({
@@ -2712,6 +2830,9 @@ var SearchField = HttpField.extend({
2712
2830
  ok: TranslationConfig.optional()
2713
2831
  }).optional()
2714
2832
  })
2833
+ }).meta({
2834
+ description: "A search input field",
2835
+ id: "SearchField"
2715
2836
  });
2716
2837
  var LinkButtonField = BaseField.extend({
2717
2838
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -2720,7 +2841,10 @@ var LinkButtonField = BaseField.extend({
2720
2841
  text: TranslationConfig.describe("Text to display on the button"),
2721
2842
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
2722
2843
  })
2723
- }).describe("Button that opens a link");
2844
+ }).meta({
2845
+ description: "A button that opens a URL link",
2846
+ id: "LinkButtonField"
2847
+ });
2724
2848
  var VerificationStatus = BaseField.extend({
2725
2849
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
2726
2850
  defaultValue: VerificationStatusValue.optional(),
@@ -2730,15 +2854,19 @@ var VerificationStatus = BaseField.extend({
2730
2854
  "Explaining text on the banner in form."
2731
2855
  )
2732
2856
  })
2857
+ }).meta({
2858
+ description: "Displays a verification state (e.g. ID verified / pending). Often paired with ID_READER \u2014 it can read its value off an ID_READER rather than holding its own.",
2859
+ id: "VerificationStatus"
2733
2860
  });
2734
2861
  var QueryParamReaderField = BaseField.extend({
2735
2862
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
2736
2863
  configuration: import_v43.default.object({
2737
2864
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
2738
2865
  })
2739
- }).describe(
2740
- "A field that maps URL query params into form values and clears them afterward"
2741
- );
2866
+ }).meta({
2867
+ description: "A field that maps URL query params into form values and clears them afterward",
2868
+ id: "QueryParamReaderField"
2869
+ });
2742
2870
  var QrReaderField = BaseField.extend({
2743
2871
  type: import_v43.default.literal(FieldType.QR_READER),
2744
2872
  defaultValue: QrReaderFieldValue.optional(),
@@ -2749,7 +2877,7 @@ var QrReaderField = BaseField.extend({
2749
2877
  })
2750
2878
  }).optional()
2751
2879
  }).meta({
2752
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2880
+ description: "QR code reader field, including optional JSON Schema validator.",
2753
2881
  id: "QrReaderField"
2754
2882
  });
2755
2883
  var IdReaderField = BaseField.extend({
@@ -2758,12 +2886,18 @@ var IdReaderField = BaseField.extend({
2758
2886
  methods: import_v43.default.array(
2759
2887
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
2760
2888
  )
2889
+ }).meta({
2890
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2891
+ id: "IdReaderField"
2761
2892
  });
2762
2893
  var CustomField = BaseField.extend({
2763
2894
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
2764
2895
  defaultValue: CustomFieldValue.optional(),
2765
2896
  src: import_v43.default.string().describe("Module source path for the custom field component"),
2766
2897
  configuration: import_v43.default.unknown().optional()
2898
+ }).meta({
2899
+ description: "An expiremental custom field that is defined by a module source path",
2900
+ id: "CustomField"
2767
2901
  });
2768
2902
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2769
2903
  var LoaderField = BaseField.extend({
@@ -2773,22 +2907,25 @@ var LoaderField = BaseField.extend({
2773
2907
  configuration: import_v43.default.object({
2774
2908
  text: TranslationConfig.describe("Display text above the loading spinner")
2775
2909
  })
2776
- }).describe(
2777
- "A non-interactive field that indicates an in progress operation in form"
2778
- );
2910
+ }).meta({
2911
+ description: "A non-interactive field that indicates an in progress operation in form",
2912
+ id: "LoaderField"
2913
+ });
2779
2914
  var HiddenField = BaseField.extend({
2780
2915
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2781
2916
  required: import_v43.default.boolean().default(false).optional(),
2782
2917
  defaultValue: TextValue.optional()
2783
- }).describe(
2784
- "A non-interactive, hidden field that only hold a value in the form"
2785
- );
2918
+ }).meta({
2919
+ description: "A non-interactive, hidden field that only hold a value in the form",
2920
+ id: "HiddenField"
2921
+ });
2786
2922
  var UserRoleField = BaseField.extend({
2787
2923
  type: import_v43.default.literal(FieldType.USER_ROLE),
2788
2924
  defaultValue: TextValue.optional()
2789
- }).describe(
2790
- "A select dropdown that is automatically populated with available user roles"
2791
- );
2925
+ }).meta({
2926
+ description: "A select dropdown that is automatically populated with available user roles",
2927
+ id: "UserRoleField"
2928
+ });
2792
2929
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2793
2930
  FieldGroup,
2794
2931
  Address,
@@ -2887,16 +3024,19 @@ var VerificationPageConfig = FormPageConfig.extend({
2887
3024
  type: z21.literal(PageTypes.enum.VERIFICATION),
2888
3025
  actions: VerificationActionConfig
2889
3026
  });
2890
- var PageConfig = z21.discriminatedUnion("type", [
2891
- FormPageConfig,
2892
- VerificationPageConfig
2893
- ]);
3027
+ var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
3028
+ id: "PageConfig",
3029
+ description: "Configuration for a single page in a form. Either a form page with fields and a continue button, or a verification page with verify/cancel options."
3030
+ });
2894
3031
 
2895
3032
  // ../commons/src/events/FormConfig.ts
2896
3033
  var DeclarationFormConfig = z22.object({
2897
3034
  label: TranslationConfig.describe("Human readable description of the form"),
2898
3035
  pages: z22.array(FormPageConfig)
2899
- }).describe("Configuration of the declaration form.");
3036
+ }).meta({
3037
+ id: "DeclarationFormConfig",
3038
+ description: "Configuration of the declaration form."
3039
+ });
2900
3040
  var ActionFormConfig = z22.object({
2901
3041
  label: TranslationConfig.describe("Human readable description of the form"),
2902
3042
  pages: z22.array(PageConfig)
@@ -2996,6 +3136,9 @@ var DeduplicationConfig = z23.object({
2996
3136
  id: z23.string(),
2997
3137
  label: TranslationConfig,
2998
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."
2999
3142
  });
3000
3143
 
3001
3144
  // ../commons/src/events/ActionConfig.ts
@@ -3113,17 +3256,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
3113
3256
  * OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
3114
3257
  * and treat them as "models" instead of duplicating the data structure in each endpoint.
3115
3258
  */
3116
- ReadActionConfig.meta({ id: "ReadActionConfig" }),
3117
- DeclareConfig.meta({ id: "DeclareActionConfig" }),
3118
- RejectConfig.meta({ id: "RejectActionConfig" }),
3119
- RegisterConfig.meta({ id: "RegisterActionConfig" }),
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
+ }),
3120
3275
  PrintCertificateActionConfig.meta({
3121
- 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."
3122
3290
  }),
3123
- RequestCorrectionConfig.meta({ id: "RequestCorrectionActionConfig" }),
3124
- EditActionConfig.meta({ id: "EditActionConfig" }),
3125
- ArchiveConfig.meta({ id: "ArchiveActionConfig" }),
3126
- CustomActionConfig.meta({ id: "CustomActionConfig" })
3291
+ CustomActionConfig.meta({
3292
+ id: "CustomActionConfig",
3293
+ description: "Configuration for a country-defined custom action. An event may include any number of these."
3294
+ })
3127
3295
  ]).describe(
3128
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."
3129
3297
  ).meta({ id: "ActionConfig" });
@@ -3199,7 +3367,10 @@ var Field = BaseField2.extend({
3199
3367
  }).describe("Custom field defined for the summary view.");
3200
3368
  var SummaryConfig = z27.object({
3201
3369
  fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
3202
- }).describe("Configuration of the event summary section.");
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
+ });
3203
3374
 
3204
3375
  // ../commons/src/events/AdvancedSearchConfig.ts
3205
3376
  var z28 = __toESM(require("zod/v4"));
@@ -3323,6 +3494,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
3323
3494
  var AdvancedSearchConfig = z28.object({
3324
3495
  title: TranslationConfig.describe("Advanced search tab title"),
3325
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()`)."
3326
3500
  });
3327
3501
 
3328
3502
  // ../commons/src/events/utils.ts
@@ -3799,6 +3973,9 @@ function precompileActionSchemas(eventConfigurations) {
3799
3973
  function isAgeValue(value) {
3800
3974
  return typeof value === "object" && value !== null && "age" in value && typeof value.age === "number";
3801
3975
  }
3976
+ function mergeWithBaseFormState(values, context) {
3977
+ return { ...context.baseFormState, ...values };
3978
+ }
3802
3979
  function validate(schema, data) {
3803
3980
  const validator = ajv.getSchema(schema.$id) || ajv.compile(schema);
3804
3981
  if ("$form" in data) {
@@ -3837,7 +4014,7 @@ function isOnline() {
3837
4014
  }
3838
4015
  function isConditionMet(conditional, values, context, eventIndex) {
3839
4016
  return validate(conditional, {
3840
- $form: values,
4017
+ $form: mergeWithBaseFormState(values, context),
3841
4018
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
3842
4019
  $online: isOnline(),
3843
4020
  $user: context.user,
@@ -3866,7 +4043,7 @@ function isFieldConditionMet(field3, form, conditionalType, context) {
3866
4043
  return true;
3867
4044
  }
3868
4045
  const validConditionals = getConditionalActionsForField(field3, {
3869
- $form: form,
4046
+ $form: mergeWithBaseFormState(form, context),
3870
4047
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
3871
4048
  $online: isOnline(),
3872
4049
  $user: context.user,
@@ -4058,7 +4235,7 @@ function runFieldValidations({
4058
4235
  return [];
4059
4236
  }
4060
4237
  const conditionalParameters = {
4061
- $form: form,
4238
+ $form: mergeWithBaseFormState(form, context),
4062
4239
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
4063
4240
  /**
4064
4241
  * In real use cases, there can be hundreds of thousands of locations.
@@ -4302,17 +4479,16 @@ function isPageVisible(page, formValues, context) {
4302
4479
  }
4303
4480
  return isConditionMet(page.conditional, formValues, context);
4304
4481
  }
4305
- function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false, declarationContext) {
4482
+ function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false) {
4306
4483
  const base = (0, import_lodash.cloneDeep)(formValues);
4307
4484
  function fn(prevVisibilityContext) {
4308
- const visibilityForm = declarationContext ? { ...declarationContext, ...prevVisibilityContext } : prevVisibilityContext;
4309
4485
  const cleaned = (0, import_lodash.omitBy)(base, (value, fieldId) => {
4310
4486
  const fieldConfig = fields.filter((f) => f.id === fieldId);
4311
4487
  if (!fieldConfig.length) {
4312
4488
  return false;
4313
4489
  }
4314
4490
  const isHidden = fieldConfig.every(
4315
- (f) => !isFieldVisible(f, visibilityForm, validatorContext)
4491
+ (f) => !isFieldVisible(f, prevVisibilityContext, validatorContext)
4316
4492
  );
4317
4493
  if (!isHidden) {
4318
4494
  return false;
@@ -4330,7 +4506,7 @@ function omitHiddenPaginatedFields(formConfig, values, validatorContext, include
4330
4506
  const visibleFields = formConfig.pages.filter((p) => isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
4331
4507
  const hiddenFields = formConfig.pages.filter((p) => !isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
4332
4508
  const valuesExceptHiddenPage = (0, import_lodash.omitBy)(values, (_2, fieldId) => {
4333
- return hiddenFields.some((f) => f.id === fieldId);
4509
+ return hiddenFields.some((f) => f.id === fieldId) && !visibleFields.some((f) => f.id === fieldId);
4334
4510
  });
4335
4511
  return omitHiddenFields(
4336
4512
  visibleFields,
@@ -4377,13 +4553,10 @@ function getVisibleVerificationPageIds(pages, annotation, context) {
4377
4553
  }
4378
4554
  function omitHiddenAnnotationFields(actionConfig, declaration, annotation, context) {
4379
4555
  const annotationFields = getActionAnnotationFields(actionConfig);
4380
- return omitHiddenFields(
4381
- annotationFields,
4382
- annotation,
4383
- context,
4384
- false,
4385
- declaration
4386
- );
4556
+ return omitHiddenFields(annotationFields, annotation, {
4557
+ ...context,
4558
+ baseFormState: declaration
4559
+ });
4387
4560
  }
4388
4561
  function deepMerge(currentDocument, actionDocument) {
4389
4562
  const currentDocumentClone = (0, import_lodash.cloneDeep)(currentDocument);
@@ -5372,7 +5545,7 @@ var _EventConfigBase = z33.object({
5372
5545
  ),
5373
5546
  label: TranslationConfig.describe("Human-readable label for the event type."),
5374
5547
  actions: z33.array(ActionConfig).describe(
5375
- "Configuration of system-defined actions associated with the event."
5548
+ "Configuration of core and custom actions associated with the event."
5376
5549
  ),
5377
5550
  actionOrder: z33.array(z33.string()).optional().describe(
5378
5551
  "Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
@@ -5384,7 +5557,7 @@ var _EventConfigBase = z33.object({
5384
5557
  "Configuration of fields available in the advanced search feature."
5385
5558
  ),
5386
5559
  flags: z33.array(FlagConfig).optional().default([]).describe(
5387
- "Configuration of flags associated with the actions of this event type."
5560
+ "Configuration of custom flags associated with the actions of this event type."
5388
5561
  ),
5389
5562
  analytics: z33.boolean().optional().default(true).describe(
5390
5563
  "Indicates whether the records of this event type are included in analytics"
@@ -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
- }).describe("Configuration defining an event type.");
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(
@@ -5823,18 +6000,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
5823
6000
  query: true,
5824
6001
  columns: true
5825
6002
  });
5826
- var WorkqueueConfigInput = z37.object({
5827
- slug: z37.string().describe("Determines the url of the workqueue."),
5828
- name: TranslationConfig.describe(
5829
- "Title of the workflow (both in navigation and on the page)"
5830
- ),
5831
- query: CountryConfigQueryInputType,
5832
- action: z37.object({ type: WorkqueueActionType }).optional().describe(
5833
- "Workqueue call-to-action button configuration. This determines the quick action button shown on each event card and the action taken when the button is clicked."
5834
- ),
5835
- columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
5836
- icon: AvailableIcons,
5837
- emptyMessage: TranslationConfig.optional()
6003
+ var WorkqueueConfigInput = WorkqueueConfig.extend({
6004
+ query: CountryConfigQueryInputType
6005
+ }).meta({
6006
+ id: "WorkqueueConfig",
6007
+ description: "Configuration for a single workqueue. Defines the filter applied to the event index, the quick-action button, the columns shown on each row, and the message rendered when the queue is empty."
5838
6008
  });
5839
6009
  function defineWorkqueue(workqueueInput) {
5840
6010
  const queryInput = workqueueInput.query;
@@ -5895,6 +6065,11 @@ var BaseActionInput = z38.object({
5895
6065
  originalActionId: UUID.optional(),
5896
6066
  // should not be part of base action.
5897
6067
  keepAssignment: z38.boolean().optional(),
6068
+ keepAssignmentIfAccepted: z38.boolean().optional(),
6069
+ keepAssignmentIfRejected: z38.boolean().optional(),
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
+ ),
5898
6073
  // For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
5899
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.
5900
6075
  createdAtLocation: UUID.nullish().describe(
@@ -6074,7 +6249,7 @@ var Draft = z39.object({
6074
6249
  }).describe(
6075
6250
  "A temporary storage for an action. Stored with details of the event, creator and creation time."
6076
6251
  );
6077
- var DraftInput = BaseActionInput.extend({
6252
+ var DraftInput = BaseActionInput.omit({ waitFor: true }).extend({
6078
6253
  type: ActionTypes.exclude([ActionTypes.enum.DELETE]),
6079
6254
  status: z39.enum([
6080
6255
  ActionStatus.Requested,
@@ -6148,7 +6323,6 @@ function getDeclarationActionCreationMetadata(actionType, actions) {
6148
6323
  createdAtLocation: requestAction?.createdAtLocation ?? acceptAction.createdAtLocation,
6149
6324
  acceptedAt: acceptAction.createdAt,
6150
6325
  createdByRole: requestAction?.createdByRole ?? acceptAction.createdByRole,
6151
- createdBySignature: requestAction?.createdBySignature ?? acceptAction.createdBySignature,
6152
6326
  registrationNumber
6153
6327
  };
6154
6328
  }
@@ -6362,17 +6536,6 @@ function getAssignedUserFromActions(actions) {
6362
6536
  return user2;
6363
6537
  }, null);
6364
6538
  }
6365
- function getAssignedUserSignatureFromActions(actions) {
6366
- return actions.reduce((signature, action) => {
6367
- if (action.type === ActionType.ASSIGN) {
6368
- return action.createdBySignature || null;
6369
- }
6370
- if (action.type === ActionType.UNASSIGN) {
6371
- return null;
6372
- }
6373
- return signature;
6374
- }, null);
6375
- }
6376
6539
  function deepDropNulls(obj) {
6377
6540
  if (Array.isArray(obj)) {
6378
6541
  return obj.map(deepDropNulls);
@@ -6468,10 +6631,8 @@ function getCurrentEventState(event2, config) {
6468
6631
  createdBy: creationAction.createdBy,
6469
6632
  createdByUserType: creationAction.createdByUserType,
6470
6633
  createdAtLocation: creationAction.createdAtLocation,
6471
- createdBySignature: creationAction.createdBySignature,
6472
6634
  updatedAt: acceptedActionMetadata.createdAt,
6473
6635
  assignedTo: getAssignedUserFromActions(acceptedActions),
6474
- assignedToSignature: getAssignedUserSignatureFromActions(acceptedActions),
6475
6636
  updatedBy: requestActionMetadata.createdBy,
6476
6637
  updatedAtLocation: requestActionMetadata.createdAtLocation,
6477
6638
  declaration,
@@ -9730,7 +9891,6 @@ var eventQueryDataGenerator = (overrides = {}, seed = 1) => {
9730
9891
  createdBy: overrides.createdBy ?? generateUuid(rng),
9731
9892
  createdAtLocation: overrides.createdAtLocation ?? generateUuid(rng),
9732
9893
  updatedAtLocation: overrides.updatedAtLocation ?? generateUuid(rng),
9733
- createdBySignature: overrides.createdBySignature ?? generateRandomSignature(rng),
9734
9894
  updatedAt: overrides.updatedAt ?? (0, import_date_fns4.addDays)(new Date(createdAt), 1).toISOString(),
9735
9895
  assignedTo: overrides.assignedTo ?? null,
9736
9896
  updatedBy: overrides.updatedBy ?? generateUuid(rng),
@@ -10001,6 +10161,39 @@ function userCanAccessEventWithScopes(event2, scopes, user2, customActionType) {
10001
10161
  (scope) => canAccessEventWithScope(event2, scope, user2, customActionType)
10002
10162
  );
10003
10163
  }
10164
+ function getAdministrativeAreaHierarchy(administrativeAreaId, administrativeAreas) {
10165
+ const collectedLocations = [];
10166
+ const parsedAdministrativeAreaId = administrativeAreaId && UUID.safeParse(administrativeAreaId).data;
10167
+ let current = parsedAdministrativeAreaId ? administrativeAreas.get(parsedAdministrativeAreaId) : null;
10168
+ while (current) {
10169
+ collectedLocations.push(current);
10170
+ if (!current.parentId) {
10171
+ break;
10172
+ }
10173
+ const parentId = current.parentId;
10174
+ current = administrativeAreas.get(parentId);
10175
+ }
10176
+ return collectedLocations;
10177
+ }
10178
+ function getLocationHierarchy(selectedId, context) {
10179
+ const { administrativeAreas, locations } = context;
10180
+ const loc = locations.get(selectedId);
10181
+ if (loc) {
10182
+ if (loc.administrativeAreaId) {
10183
+ const hierarchy2 = getAdministrativeAreaHierarchy(
10184
+ loc.administrativeAreaId,
10185
+ administrativeAreas
10186
+ );
10187
+ return [...hierarchy2.reverse().map((area) => area.id), loc.id];
10188
+ }
10189
+ return [loc.id];
10190
+ }
10191
+ const hierarchy = getAdministrativeAreaHierarchy(
10192
+ selectedId,
10193
+ administrativeAreas
10194
+ );
10195
+ return hierarchy.reverse().map((area) => area.id);
10196
+ }
10004
10197
 
10005
10198
  // ../commons/src/events/scopes.ts
10006
10199
  var ACTION_SCOPE_MAP = {
@@ -10075,6 +10268,25 @@ function isActionInScope({
10075
10268
  );
10076
10269
  return canAccess;
10077
10270
  }
10271
+ function getAvailableRolesForUserUpdatePayload({
10272
+ allRoles,
10273
+ userLocation,
10274
+ acceptedScopes,
10275
+ userRequesting
10276
+ }) {
10277
+ const availableRoles = allRoles.filter((role) => {
10278
+ const canAccess = canAccessOtherUserWithScopes({
10279
+ userToAccess: {
10280
+ ...userLocation,
10281
+ role
10282
+ },
10283
+ user: userRequesting,
10284
+ scopes: acceptedScopes
10285
+ });
10286
+ return canAccess;
10287
+ });
10288
+ return availableRoles;
10289
+ }
10078
10290
 
10079
10291
  // ../commons/src/events/serializers/user/deserializer.ts
10080
10292
  function userDeserializer(serializedUserField, user2) {