@opencrvs/toolkit 2.0.0-rc.3edb4f4 → 2.0.0-rc.403d34f

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 (100) hide show
  1. package/create-countryconfig/index.js +103 -0
  2. package/create-countryconfig/package.json +21 -0
  3. package/dist/application-config/index.js +259 -96
  4. package/dist/cli.js +1952 -347
  5. package/dist/commons/api/router.d.ts +3400 -324
  6. package/dist/commons/application-config/index.d.ts +16 -4
  7. package/dist/commons/conditionals/conditionals.d.ts +12 -6
  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/AuditLog.d.ts +2 -0
  11. package/dist/commons/events/Draft.d.ts +4 -2
  12. package/dist/commons/events/EventIndex.d.ts +0 -3
  13. package/dist/commons/events/EventMetadata.d.ts +0 -7
  14. package/dist/commons/events/FieldConfig.d.ts +10 -0
  15. package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
  16. package/dist/commons/events/index.d.ts +1 -0
  17. package/dist/commons/events/locations.d.ts +38 -1
  18. package/dist/commons/events/mocks.test.utils.d.ts +19 -0
  19. package/dist/commons/events/scopes.d.ts +24 -1
  20. package/dist/commons/events/state/flags.d.ts +15 -0
  21. package/dist/commons/events/state/index.d.ts +0 -4
  22. package/dist/commons/events/state/utils.d.ts +0 -2
  23. package/dist/commons/events/utils.d.ts +1 -1
  24. package/dist/commons/notification/UserNotifications.d.ts +15 -0
  25. package/dist/conditionals/index.js +44 -8
  26. package/dist/events/index.js +859 -179
  27. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
  28. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +63 -39
  29. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts +3 -0
  30. package/dist/migrations/v2.0/add-resend-invite-notification.d.ts.map +1 -0
  31. package/dist/migrations/v2.0/add-resend-invite-notification.js +373 -0
  32. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +19 -0
  33. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  34. package/dist/migrations/v2.0/checkout-upstream-files.js +17 -14
  35. package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +1 -1
  36. package/dist/migrations/v2.0/convert-config-files-to-ts.js +4 -5
  37. package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts.map +1 -1
  38. package/dist/migrations/v2.0/convert-paragraph-to-heading.js +4 -5
  39. package/dist/migrations/v2.0/create-events-index.d.ts.map +1 -1
  40. package/dist/migrations/v2.0/create-events-index.js +1 -2
  41. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +11 -0
  42. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -0
  43. package/dist/migrations/v2.0/delete-infrastructure-directory.js +123 -0
  44. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  45. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  46. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  47. package/dist/migrations/v2.0/index.d.ts +10 -4
  48. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  49. package/dist/migrations/v2.0/index.js +1920 -344
  50. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  51. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +95 -7
  52. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +13 -0
  53. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -0
  54. package/dist/migrations/v2.0/merge-infrastructure-directory.js +222 -0
  55. package/dist/migrations/v2.0/migrate-application-config-url.d.ts +3 -0
  56. package/dist/migrations/v2.0/migrate-application-config-url.d.ts.map +1 -0
  57. package/dist/migrations/v2.0/migrate-application-config-url.js +342 -0
  58. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  59. package/dist/migrations/v2.0/migrate-scopes.js +55 -32
  60. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts.map +1 -1
  61. package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.js +3 -4
  62. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  63. package/dist/migrations/v2.0/migrate-workqueue-configs.js +143 -63
  64. package/dist/migrations/v2.0/remove-delete-actions.d.ts.map +1 -1
  65. package/dist/migrations/v2.0/remove-delete-actions.js +3 -4
  66. package/dist/migrations/v2.0/remove-demo-scope.d.ts.map +1 -1
  67. package/dist/migrations/v2.0/remove-demo-scope.js +2 -3
  68. package/dist/migrations/v2.0/remove-deprecated-imports.d.ts.map +1 -1
  69. package/dist/migrations/v2.0/remove-deprecated-imports.js +3 -4
  70. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts +3 -0
  71. package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts.map +1 -0
  72. package/dist/migrations/v2.0/remove-fhir-url-helpers.js +163 -0
  73. package/dist/migrations/v2.0/remove-hearth-migrations.d.ts.map +1 -1
  74. package/dist/migrations/v2.0/remove-hearth-migrations.js +1 -2
  75. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts +3 -0
  76. package/dist/migrations/v2.0/remove-old-statistics-service.d.ts.map +1 -0
  77. package/dist/migrations/v2.0/remove-old-statistics-service.js +356 -0
  78. package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts.map +1 -1
  79. package/dist/migrations/v2.0/remove-pending-certification-flag.js +3 -4
  80. package/dist/migrations/v2.0/remove-review-from-register-action.d.ts.map +1 -1
  81. package/dist/migrations/v2.0/remove-review-from-register-action.js +3 -4
  82. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts +3 -0
  83. package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts.map +1 -0
  84. package/dist/migrations/v2.0/remove-unused-environment-variables.js +186 -0
  85. package/dist/migrations/v2.0/rename-api-paths.d.ts.map +1 -1
  86. package/dist/migrations/v2.0/rename-api-paths.js +3 -4
  87. package/dist/migrations/v2.0/rename-location-parent-id.d.ts.map +1 -1
  88. package/dist/migrations/v2.0/rename-location-parent-id.js +3 -4
  89. package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts.map +1 -1
  90. package/dist/migrations/v2.0/simplify-analytics-precalculations.js +1 -2
  91. package/dist/migrations/v2.0/update-package-json.d.ts +3 -0
  92. package/dist/migrations/v2.0/update-package-json.d.ts.map +1 -0
  93. package/dist/migrations/v2.0/update-package-json.js +105 -0
  94. package/dist/notification/index.js +695 -124
  95. package/dist/scopes/index.d.ts +87 -10
  96. package/dist/scopes/index.js +46 -9
  97. package/opencrvs-toolkit-2.0.0-rc.403d34f.tgz +0 -0
  98. package/package.json +6 -2
  99. package/tsconfig.tsbuildinfo +1 -1
  100. package/opencrvs-toolkit-2.0.0-rc.3edb4f4.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,
@@ -234,6 +238,7 @@ __export(events_exports, {
234
238
  ageToDate: () => ageToDate,
235
239
  aggregateActionAnnotations: () => aggregateActionAnnotations,
236
240
  aggregateActionDeclarations: () => aggregateActionDeclarations,
241
+ always: () => always,
237
242
  alwaysTrue: () => alwaysTrue,
238
243
  and: () => and,
239
244
  annotationActions: () => annotationActions,
@@ -243,6 +248,8 @@ __export(events_exports, {
243
248
  areConditionsMet: () => areConditionsMet,
244
249
  buildFormState: () => buildFormState,
245
250
  canAccessEventWithScope: () => canAccessEventWithScope,
251
+ canAccessOtherUserWithScopes: () => canAccessOtherUserWithScopes,
252
+ canAccessUserWithScope: () => canAccessUserWithScope,
246
253
  compositeFieldTypes: () => compositeFieldTypes,
247
254
  createEmptyDraft: () => createEmptyDraft,
248
255
  createFieldConditionals: () => createFieldConditionals,
@@ -300,12 +307,13 @@ __export(events_exports, {
300
307
  getActionConfig: () => getActionConfig,
301
308
  getActionReview: () => getActionReview,
302
309
  getActionReviewFields: () => getActionReviewFields,
310
+ getAdministrativeAreaHierarchy: () => getAdministrativeAreaHierarchy,
303
311
  getAllUniqueFields: () => getAllUniqueFields,
304
312
  getAnnotationFromDrafts: () => getAnnotationFromDrafts,
305
313
  getAssignedUserFromActions: () => getAssignedUserFromActions,
306
- getAssignedUserSignatureFromActions: () => getAssignedUserSignatureFromActions,
307
314
  getAssignmentStatus: () => getAssignmentStatus,
308
315
  getAvailableActionsForEvent: () => getAvailableActionsForEvent,
316
+ getAvailableRolesForUserUpdatePayload: () => getAvailableRolesForUserUpdatePayload,
309
317
  getCompleteActionAnnotation: () => getCompleteActionAnnotation,
310
318
  getCompleteActionDeclaration: () => getCompleteActionDeclaration,
311
319
  getCurrentEventState: () => getCurrentEventState,
@@ -316,6 +324,7 @@ __export(events_exports, {
316
324
  getDeclarationPages: () => getDeclarationPages,
317
325
  getEventConfigById: () => getEventConfigById,
318
326
  getFilePathsFromEvent: () => getFilePathsFromEvent,
327
+ getLocationHierarchy: () => getLocationHierarchy,
319
328
  getMixedPath: () => getMixedPath,
320
329
  getPendingAction: () => getPendingAction,
321
330
  getPrintCertificatePages: () => getPrintCertificatePages,
@@ -489,6 +498,10 @@ var scopeByEvent = z2.preprocess(
489
498
  (val) => val === void 0 ? void 0 : [val].flat(),
490
499
  z2.array(z2.string()).optional()
491
500
  ).describe("Event type, e.g. birth, death");
501
+ var userRole = z2.preprocess(
502
+ (val) => val === void 0 ? void 0 : [val].flat(),
503
+ z2.array(z2.string()).optional()
504
+ ).describe("User role, e.g. admin, field agent");
492
505
  var scopeOptionsPlaceEvent = z2.object({
493
506
  event: scopeByEvent,
494
507
  placeOfEvent: JurisdictionFilter.optional()
@@ -512,6 +525,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
512
525
  var AccessLevelOptions = z2.object({
513
526
  accessLevel: JurisdictionFilter.optional()
514
527
  });
528
+ var AllUserScopeOptions = AccessLevelOptions.extend({
529
+ role: userRole.optional()
530
+ });
515
531
  var WorkqueueOrDashboardOptions = z2.object({
516
532
  ids: z2.preprocess(
517
533
  (val) => val === void 0 ? void 0 : [val].flat(),
@@ -521,6 +537,7 @@ var WorkqueueOrDashboardOptions = z2.object({
521
537
  var AllScopeOptions = z2.object({
522
538
  ...AllRecordScopeOptions.shape,
523
539
  ...AccessLevelOptions.shape,
540
+ ...AllUserScopeOptions.shape,
524
541
  ...WorkqueueOrDashboardOptions.shape
525
542
  });
526
543
  var ScopeOptionKey = AllScopeOptions.keyof();
@@ -593,6 +610,33 @@ var RecordScopeV2 = z2.discriminatedUnion("type", [
593
610
  ]).describe(
594
611
  "Scopes used to check user's permission to perform actions on a record."
595
612
  );
613
+ var SystemScopeType = z2.enum([
614
+ "organisation.read-locations",
615
+ "user.read",
616
+ "user.create",
617
+ "user.edit",
618
+ "user.search"
619
+ ]);
620
+ var UserScopeType = SystemScopeType.extract([
621
+ "user.read",
622
+ "user.create",
623
+ "user.edit",
624
+ "user.search"
625
+ ]);
626
+ var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
627
+ var UserScopeV2 = z2.discriminatedUnion("type", [
628
+ z2.object({
629
+ type: ScopesWithRoleOption,
630
+ options: AllUserScopeOptions.optional()
631
+ }),
632
+ z2.object({
633
+ type: UserScopeType.extract(["user.read", "user.search"]),
634
+ options: AccessLevelOptions.optional()
635
+ })
636
+ ]);
637
+ function scopeUsesRoleOptions(scope) {
638
+ return ScopesWithRoleOption?.options.some((opt) => opt === scope.type);
639
+ }
596
640
  function scopeUsesDeclaredOptions(scope) {
597
641
  return !ScopesWithPlaceEventOptions.options.some((opt) => opt === scope.type);
598
642
  }
@@ -625,16 +669,14 @@ var ResolvedRecordScopeV2 = z2.discriminatedUnion("type", [
625
669
  }).optional()
626
670
  })
627
671
  ]).describe("Resolved scope with location/user IDs instead of filters.");
628
- var SystemScopeType = z2.enum([
629
- "organisation.read-locations",
630
- "user.read",
631
- "user.create",
632
- "user.edit"
633
- ]);
634
672
  var Scope = z2.discriminatedUnion("type", [
635
673
  z2.object({ type: PlainScopeType }),
636
674
  ...RecordScopeV2.options,
637
- z2.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
675
+ ...UserScopeV2.options,
676
+ z2.object({
677
+ type: z2.literal("organisation.read-locations"),
678
+ options: AccessLevelOptions.optional()
679
+ }),
638
680
  z2.object({
639
681
  type: z2.literal("workqueue"),
640
682
  options: WorkqueueOrDashboardOptions
@@ -667,7 +709,9 @@ var decodeScope = (query) => {
667
709
  };
668
710
  var DEFAULT_SCOPE_OPTIONS = {
669
711
  placeOfEvent: JurisdictionFilter.enum.all,
670
- accessLevel: JurisdictionFilter.enum.all
712
+ accessLevel: JurisdictionFilter.enum.all,
713
+ registeredIn: JurisdictionFilter.enum.all,
714
+ declaredIn: JurisdictionFilter.enum.all
671
715
  };
672
716
  function getAcceptedScopesByType({
673
717
  acceptedScopes,
@@ -938,6 +982,7 @@ var UserSubjectOnlyEntrySchema = AuditLogEntryBase.extend({
938
982
  "user.password_changed",
939
983
  "user.password_reset",
940
984
  "user.password_reset_by_admin",
985
+ "user.resend_invite",
941
986
  "user.username_reminder",
942
987
  "user.username_reminder_by_admin"
943
988
  ]),
@@ -1039,7 +1084,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
1039
1084
  ShowConditional,
1040
1085
  // Action can be shown to the user in the list but as disabled
1041
1086
  EnableConditional
1042
- ]);
1087
+ ]).meta({
1088
+ id: "ActionConditional",
1089
+ 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."
1090
+ });
1043
1091
  var DisplayOnReviewConditional = z7.object({
1044
1092
  type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
1045
1093
  conditional: Conditional
@@ -1054,8 +1102,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
1054
1102
  // Field output can be shown / hidden on the review page
1055
1103
  DisplayOnReviewConditional
1056
1104
  ]).meta({
1057
- description: "Field conditional configuration",
1058
- id: "FieldConditional"
1105
+ id: "FieldConditional",
1106
+ 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."
1059
1107
  });
1060
1108
 
1061
1109
  // ../commons/src/events/FieldType.ts
@@ -1375,28 +1423,20 @@ function schemaPriority(schema) {
1375
1423
  return idx === -1 ? 9999 : idx;
1376
1424
  }
1377
1425
  function safeUnion(schemas) {
1426
+ const sortedSchemas = [...schemas].sort(
1427
+ (a, b) => schemaPriority(a) - schemaPriority(b)
1428
+ );
1378
1429
  return z12.any().superRefine((val, ctx) => {
1379
- const successful = schemas.filter((s) => s.safeParse(val).success);
1380
- if (successful.length === 1) {
1381
- return;
1382
- }
1383
- if (successful.length === 0) {
1384
- ctx.addIssue({
1385
- code: "invalid_type",
1386
- expected: "custom",
1387
- message: "Value does not match any schema"
1388
- });
1389
- return;
1390
- }
1391
- successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
1392
- const best = successful[0];
1393
- if (!best.safeParse(val).success) {
1394
- ctx.addIssue({
1395
- expected: "custom",
1396
- code: "invalid_type",
1397
- message: "Value did not match the best schema"
1398
- });
1430
+ for (const schema of sortedSchemas) {
1431
+ if (schema.safeParse(val).success) {
1432
+ return;
1433
+ }
1399
1434
  }
1435
+ ctx.addIssue({
1436
+ code: "invalid_type",
1437
+ expected: "custom",
1438
+ message: "Value does not match any schema"
1439
+ });
1400
1440
  }).meta({
1401
1441
  description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
1402
1442
  });
@@ -1706,6 +1746,9 @@ var FlagConfig = z15.object({
1706
1746
  "Indicates if this flag expects an action to be performed to be cleared."
1707
1747
  ),
1708
1748
  label: TranslationConfig.describe("Human readable label of the flag.")
1749
+ }).meta({
1750
+ id: "FlagConfig",
1751
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1709
1752
  });
1710
1753
  var ActionFlagConfig = z15.object({
1711
1754
  id: Flag,
@@ -1713,6 +1756,9 @@ var ActionFlagConfig = z15.object({
1713
1756
  conditional: Conditional.optional().describe(
1714
1757
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1715
1758
  )
1759
+ }).meta({
1760
+ id: "ActionFlagConfig",
1761
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1716
1762
  });
1717
1763
 
1718
1764
  // ../commons/src/events/EventMetadata.ts
@@ -1734,8 +1780,7 @@ var ActionCreationMetadata = z16.object({
1734
1780
  ),
1735
1781
  createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1736
1782
  acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
1737
- createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation."),
1738
- createdBySignature: z16.string().nullish().describe("Signature of the user who created the action request.")
1783
+ createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
1739
1784
  });
1740
1785
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1741
1786
  registrationNumber: z16.string().describe(
@@ -1763,9 +1808,6 @@ var EventMetadata = z16.object({
1763
1808
  createdAtLocation: UUID.nullish().describe(
1764
1809
  "Location of the user who created the event."
1765
1810
  ),
1766
- createdBySignature: DocumentPath.nullish().describe(
1767
- "Signature of the user who created the event."
1768
- ),
1769
1811
  updatedAtLocation: UUID.nullish().describe(
1770
1812
  "Location of the user who last changed the status."
1771
1813
  ),
@@ -2140,14 +2182,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
2140
2182
  }
2141
2183
  }).describe("Unique identifier for the field");
2142
2184
  var FieldReference = import_v43.default.object({
2143
- $$field: FieldId,
2185
+ $$field: FieldId.describe("Id of the field to reference"),
2144
2186
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
2145
2187
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
2146
2188
  )
2147
2189
  }).describe("Reference to a field by its ID");
2148
2190
  var ValidationConfig = import_v43.default.object({
2149
- validator: Conditional,
2150
- message: TranslationConfig
2191
+ validator: Conditional.describe(
2192
+ "Conditional expression that must hold for the field value to be considered valid."
2193
+ ),
2194
+ message: TranslationConfig.describe(
2195
+ "Error message displayed when the validator does not hold."
2196
+ )
2197
+ }).meta({
2198
+ id: "ValidationConfig",
2199
+ 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."
2151
2200
  });
2152
2201
  var requiredSchema = import_v43.default.union([
2153
2202
  import_v43.default.boolean(),
@@ -2186,6 +2235,9 @@ var BaseField = import_v43.default.object({
2186
2235
  }).describe("Common properties shared across all field types.");
2187
2236
  var Divider = BaseField.extend({
2188
2237
  type: import_v43.default.literal(FieldType.DIVIDER)
2238
+ }).meta({
2239
+ description: "A horizontal line divider",
2240
+ id: "Divider"
2189
2241
  });
2190
2242
  var TextField = BaseField.extend({
2191
2243
  type: import_v43.default.literal(FieldType.TEXT),
@@ -2196,7 +2248,10 @@ var TextField = BaseField.extend({
2196
2248
  prefix: TranslationConfig.optional(),
2197
2249
  postfix: TranslationConfig.optional()
2198
2250
  }).default({ type: "text" }).optional()
2199
- }).describe("Text input");
2251
+ }).meta({
2252
+ description: "A text input field",
2253
+ id: "TextField"
2254
+ });
2200
2255
  var NumberField = BaseField.extend({
2201
2256
  type: import_v43.default.literal(FieldType.NUMBER),
2202
2257
  defaultValue: NumberFieldValue.optional(),
@@ -2206,7 +2261,10 @@ var NumberField = BaseField.extend({
2206
2261
  prefix: TranslationConfig.optional(),
2207
2262
  postfix: TranslationConfig.optional()
2208
2263
  }).optional()
2209
- }).describe("Number input");
2264
+ }).meta({
2265
+ description: "A number input field",
2266
+ id: "NumberField"
2267
+ });
2210
2268
  var TextAreaField = BaseField.extend({
2211
2269
  type: import_v43.default.literal(FieldType.TEXTAREA),
2212
2270
  defaultValue: NonEmptyTextValue.optional(),
@@ -2217,7 +2275,10 @@ var TextAreaField = BaseField.extend({
2217
2275
  prefix: TranslationConfig.optional(),
2218
2276
  postfix: TranslationConfig.optional()
2219
2277
  }).default({ rows: 4 }).optional()
2220
- }).describe("Multiline text input");
2278
+ }).meta({
2279
+ description: "A multiline text input",
2280
+ id: "TextAreaField"
2281
+ });
2221
2282
  var ImageMimeType = import_v43.default.enum([
2222
2283
  "image/png",
2223
2284
  "image/jpg",
@@ -2247,13 +2308,19 @@ var SignatureField = BaseField.extend({
2247
2308
  }).default({
2248
2309
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2249
2310
  })
2250
- }).describe("Signature input field");
2311
+ }).meta({
2312
+ description: "A signature input field",
2313
+ id: "SignatureField"
2314
+ });
2251
2315
  var EmailField = BaseField.extend({
2252
2316
  type: import_v43.default.literal(FieldType.EMAIL),
2253
2317
  configuration: import_v43.default.object({
2254
2318
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
2255
2319
  }).default({ maxLength: 255 }).optional(),
2256
2320
  defaultValue: NonEmptyTextValue.optional()
2321
+ }).meta({
2322
+ description: "An email input field",
2323
+ id: "EmailField"
2257
2324
  });
2258
2325
  var DateField = BaseField.extend({
2259
2326
  type: import_v43.default.literal(FieldType.DATE),
@@ -2263,7 +2330,10 @@ var DateField = BaseField.extend({
2263
2330
  "Text to display above the date input"
2264
2331
  ).optional()
2265
2332
  }).optional()
2266
- }).describe("A single date input (yyyy-MM-dd)");
2333
+ }).meta({
2334
+ description: "A date input (yyyy-MM-dd)",
2335
+ id: "DateField"
2336
+ });
2267
2337
  var AgeField = BaseField.extend({
2268
2338
  type: import_v43.default.literal(FieldType.AGE),
2269
2339
  defaultValue: NumberFieldValue.optional(),
@@ -2272,7 +2342,10 @@ var AgeField = BaseField.extend({
2272
2342
  prefix: TranslationConfig.optional(),
2273
2343
  postfix: TranslationConfig.optional()
2274
2344
  })
2275
- }).describe("An age input field which uses the current date as the asOfDate");
2345
+ }).meta({
2346
+ description: "An age input field which uses the current date as the asOfDate",
2347
+ id: "AgeField"
2348
+ });
2276
2349
  var TimeField = BaseField.extend({
2277
2350
  type: import_v43.default.literal(FieldType.TIME),
2278
2351
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -2282,7 +2355,10 @@ var TimeField = BaseField.extend({
2282
2355
  "Text to display above the time input"
2283
2356
  ).optional()
2284
2357
  }).optional()
2285
- }).describe("A single date input (HH-mm)");
2358
+ }).meta({
2359
+ description: "A single time input (HH-mm)",
2360
+ id: "TimeField"
2361
+ });
2286
2362
  var DateRangeField = BaseField.extend({
2287
2363
  type: import_v43.default.literal(FieldType.DATE_RANGE),
2288
2364
  defaultValue: DateRangeFieldValue.optional(),
@@ -2291,7 +2367,10 @@ var DateRangeField = BaseField.extend({
2291
2367
  "Text to display above the date input"
2292
2368
  ).optional()
2293
2369
  }).optional()
2294
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
2370
+ }).meta({
2371
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
2372
+ id: "DateRangeField"
2373
+ });
2295
2374
  var HtmlFontVariant = import_v43.default.enum([
2296
2375
  "reg12",
2297
2376
  "reg14",
@@ -2335,18 +2414,30 @@ var ImageViewField = BaseField.extend({
2335
2414
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
2336
2415
  defaultValue: NonEmptyTextValue.optional(),
2337
2416
  configuration: ImageConfiguration
2338
- }).describe("A read-only image component for form pages");
2417
+ }).meta({
2418
+ description: "A read-only image component for form pages",
2419
+ id: "ImageViewField"
2420
+ });
2339
2421
  var Paragraph = BaseField.extend({
2340
2422
  type: import_v43.default.literal(FieldType.PARAGRAPH),
2341
2423
  configuration: ParagraphConfiguration
2342
- }).describe("A read-only HTML <p> paragraph");
2424
+ }).meta({
2425
+ description: "A read-only HTML <p> paragraph",
2426
+ id: "Paragraph"
2427
+ });
2343
2428
  var Heading = BaseField.extend({
2344
2429
  type: import_v43.default.literal(FieldType.HEADING),
2345
2430
  configuration: HeadingConfiguration
2346
- }).describe("A read-only heading component for form pages");
2431
+ }).meta({
2432
+ description: "A read-only heading component for form pages",
2433
+ id: "Heading"
2434
+ });
2347
2435
  var PageHeader = BaseField.extend({
2348
2436
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
2349
- }).describe("A read-only header component for form pages");
2437
+ }).meta({
2438
+ description: "A read-only header component for form pages",
2439
+ id: "PageHeader"
2440
+ });
2350
2441
  var File = BaseField.extend({
2351
2442
  type: import_v43.default.literal(FieldType.FILE),
2352
2443
  defaultValue: FileFieldValue.optional(),
@@ -2365,7 +2456,10 @@ var File = BaseField.extend({
2365
2456
  }).default({
2366
2457
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2367
2458
  })
2368
- }).describe("File upload");
2459
+ }).meta({
2460
+ description: "A file upload field",
2461
+ id: "File"
2462
+ });
2369
2463
  var SelectOption = import_v43.default.object({
2370
2464
  value: import_v43.default.string().describe("The value of the option"),
2371
2465
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -2382,7 +2476,10 @@ var NumberWithUnitField = BaseField.extend({
2382
2476
  "Placeholder for the number field"
2383
2477
  )
2384
2478
  }).optional()
2385
- }).describe("Number with unit input");
2479
+ }).meta({
2480
+ description: "A number with unit input field",
2481
+ id: "NumberWithUnitField"
2482
+ });
2386
2483
  var RadioGroup = BaseField.extend({
2387
2484
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
2388
2485
  defaultValue: TextValue.optional(),
@@ -2392,7 +2489,10 @@ var RadioGroup = BaseField.extend({
2392
2489
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
2393
2490
  }).optional()
2394
2491
  }).optional()
2395
- }).describe("Grouped radio options");
2492
+ }).meta({
2493
+ description: "A grouped radio button field",
2494
+ id: "RadioGroup"
2495
+ });
2396
2496
  var BulletList = BaseField.extend({
2397
2497
  type: import_v43.default.literal(FieldType.BULLET_LIST),
2398
2498
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -2401,7 +2501,10 @@ var BulletList = BaseField.extend({
2401
2501
  fontVariant: HtmlFontVariant.optional()
2402
2502
  }).optional()
2403
2503
  }).default({})
2404
- }).describe("A list of bullet points");
2504
+ }).meta({
2505
+ description: "A list of bullet points",
2506
+ id: "BulletList"
2507
+ });
2405
2508
  var Select = BaseField.extend({
2406
2509
  type: import_v43.default.literal(FieldType.SELECT),
2407
2510
  defaultValue: TextValue.optional(),
@@ -2416,7 +2519,10 @@ var Select = BaseField.extend({
2416
2519
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
2417
2520
  `
2418
2521
  )
2419
- }).describe("Select input");
2522
+ }).meta({
2523
+ description: "A select input field",
2524
+ id: "Select"
2525
+ });
2420
2526
  var SelectDateRangeOption = import_v43.default.object({
2421
2527
  value: SelectDateRangeValue.describe("The value of the option"),
2422
2528
  label: TranslationConfig.describe("The label of the option")
@@ -2425,7 +2531,10 @@ var SelectDateRangeField = BaseField.extend({
2425
2531
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
2426
2532
  defaultValue: SelectDateRangeValue.optional(),
2427
2533
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
2428
- }).describe("Select input with date range options");
2534
+ }).meta({
2535
+ description: "A date range selection field",
2536
+ id: "SelectDateRangeField"
2537
+ });
2429
2538
  var NameConfig = import_v43.default.object({
2430
2539
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
2431
2540
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -2456,26 +2565,41 @@ var NameField = BaseField.extend({
2456
2565
  surname: { required: true }
2457
2566
  }
2458
2567
  }).optional()
2459
- }).describe("Name input field");
2568
+ }).meta({
2569
+ description: "A field for entering a persons name",
2570
+ id: "NameField"
2571
+ });
2460
2572
  var PhoneField = BaseField.extend({
2461
2573
  defaultValue: NonEmptyTextValue.optional(),
2462
2574
  type: import_v43.default.literal(FieldType.PHONE)
2463
- }).describe("Phone input field");
2575
+ }).meta({
2576
+ description: "A field for entering a phone number",
2577
+ id: "PhoneField"
2578
+ });
2464
2579
  var IdField = BaseField.extend({
2465
2580
  defaultValue: NonEmptyTextValue.optional(),
2466
2581
  type: import_v43.default.literal(FieldType.ID)
2467
- }).describe("ID input field");
2582
+ }).meta({
2583
+ description: "A field for entering an ID",
2584
+ id: "IdField"
2585
+ });
2468
2586
  var Checkbox = BaseField.extend({
2469
2587
  type: import_v43.default.literal(FieldType.CHECKBOX),
2470
2588
  defaultValue: CheckboxFieldValue.default(false)
2471
- }).describe("Boolean checkbox field");
2589
+ }).meta({
2590
+ description: "A boolean checkbox field",
2591
+ id: "Checkbox"
2592
+ });
2472
2593
  var Country = BaseField.extend({
2473
2594
  type: import_v43.default.literal(FieldType.COUNTRY),
2474
2595
  defaultValue: NonEmptyTextValue.optional(),
2475
2596
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
2476
2597
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
2477
2598
  )
2478
- }).describe("Country select field");
2599
+ }).meta({
2600
+ description: "A field for selecting a country",
2601
+ id: "Country"
2602
+ });
2479
2603
  var AllowedLocations = JurisdictionReference.optional().describe(
2480
2604
  "Limits which location options are selectable depending on user jurisdiction and location."
2481
2605
  );
@@ -2484,16 +2608,18 @@ var AdministrativeAreas = import_v43.default.enum([
2484
2608
  "HEALTH_FACILITY",
2485
2609
  "CRVS_OFFICE"
2486
2610
  ]);
2487
- var AdministrativeAreaConfiguration = import_v43.default.object({
2488
- partOf: FieldReference.optional().describe("Parent location"),
2489
- type: AdministrativeAreas,
2490
- allowedLocations: AllowedLocations
2491
- }).describe("Administrative area options");
2492
2611
  var AdministrativeAreaField = BaseField.extend({
2493
2612
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
2494
2613
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
2495
- configuration: AdministrativeAreaConfiguration
2496
- }).describe("Administrative area input field e.g. facility, office");
2614
+ configuration: import_v43.default.object({
2615
+ partOf: FieldReference.optional().describe("Parent location"),
2616
+ type: AdministrativeAreas,
2617
+ allowedLocations: AllowedLocations
2618
+ }).describe("Administrative area options")
2619
+ }).meta({
2620
+ description: "Administrative area input field",
2621
+ id: "AdministrativeAreaField"
2622
+ });
2497
2623
  var LocationInput = BaseField.extend({
2498
2624
  type: import_v43.default.literal(FieldType.LOCATION),
2499
2625
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -2501,7 +2627,10 @@ var LocationInput = BaseField.extend({
2501
2627
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
2502
2628
  allowedLocations: AllowedLocations
2503
2629
  }).optional()
2504
- }).describe("Input field for a location");
2630
+ }).meta({
2631
+ description: "A field for selecting a location",
2632
+ id: "LocationInput"
2633
+ });
2505
2634
  var FileUploadWithOptions = BaseField.extend({
2506
2635
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
2507
2636
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -2515,6 +2644,9 @@ var FileUploadWithOptions = BaseField.extend({
2515
2644
  }).default({
2516
2645
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2517
2646
  })
2647
+ }).meta({
2648
+ description: "A field for uploading files with file type options",
2649
+ id: "FileUploadWithOptions"
2518
2650
  });
2519
2651
  var Facility = BaseField.extend({
2520
2652
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -2560,7 +2692,10 @@ var Address = BaseField.extend({
2560
2692
  allowedLocations: AllowedLocations
2561
2693
  }).optional(),
2562
2694
  defaultValue: DefaultAddressFieldValue.optional()
2563
- }).describe("Address input field \u2013 a combination of location and text fields");
2695
+ }).meta({
2696
+ description: "Address input field \u2013 a combination of location and text fields",
2697
+ id: "Address"
2698
+ });
2564
2699
  var StaticDataEntry = import_v43.default.object({
2565
2700
  id: import_v43.default.string().describe("ID for the data entry."),
2566
2701
  label: TranslationConfig,
@@ -2575,7 +2710,10 @@ var DataField = BaseField.extend({
2575
2710
  subtitle: TranslationConfig.optional(),
2576
2711
  data: import_v43.default.array(DataEntry)
2577
2712
  })
2578
- }).describe("Data field for displaying read-only data");
2713
+ }).meta({
2714
+ description: "A field for displaying a table of read-only data",
2715
+ id: "DataField"
2716
+ });
2579
2717
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
2580
2718
  var ButtonType = import_v43.default.enum([
2581
2719
  "primary",
@@ -2602,11 +2740,17 @@ var ButtonField = BaseField.extend({
2602
2740
  type: import_v43.default.literal(FieldType.BUTTON),
2603
2741
  defaultValue: ButtonFieldValue.optional(),
2604
2742
  configuration: ButtonConfiguration
2605
- }).describe("Generic button without any built-in functionality");
2743
+ }).meta({
2744
+ description: "A generic button that can be used to trigger an action",
2745
+ id: "ButtonField"
2746
+ });
2606
2747
  var FieldGroup = BaseField.extend({
2607
2748
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
2608
2749
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
2609
2750
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
2751
+ }).meta({
2752
+ description: "A group of fields that are displayed together",
2753
+ id: "FieldGroup"
2610
2754
  });
2611
2755
  var AlphaPrintButton = BaseField.extend({
2612
2756
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -2616,7 +2760,10 @@ var AlphaPrintButton = BaseField.extend({
2616
2760
  "Label for the print button"
2617
2761
  )
2618
2762
  })
2619
- }).describe("Print button field for printing certificates");
2763
+ }).meta({
2764
+ description: "An experimental print button field for printing certificates during the declaration process",
2765
+ id: "AlphaPrintButton"
2766
+ });
2620
2767
  var HttpField = BaseField.extend({
2621
2768
  type: import_v43.default.literal(FieldType.HTTP),
2622
2769
  defaultValue: HttpFieldValue.optional(),
@@ -2632,20 +2779,30 @@ var HttpField = BaseField.extend({
2632
2779
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
2633
2780
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
2634
2781
  })
2635
- }).describe("HTTP request function triggered by a button click or other event");
2782
+ }).meta({
2783
+ 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.",
2784
+ id: "HttpField"
2785
+ });
2636
2786
  var AutocompleteField = BaseField.extend({
2637
2787
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
2638
2788
  configuration: import_v43.default.object({
2639
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2789
+ url: import_v43.default.string().describe(
2790
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2791
+ ).optional(),
2640
2792
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
2641
2793
  defaultOptions: import_v43.default.array(
2642
2794
  import_v43.default.object({
2643
2795
  label: import_v43.default.string(),
2644
2796
  value: import_v43.default.string()
2645
2797
  })
2646
- ).optional()
2798
+ ).optional().describe(
2799
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2800
+ )
2647
2801
  })
2648
- }).describe("Autocomplete input field");
2802
+ }).meta({
2803
+ 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.",
2804
+ id: "AutocompleteField"
2805
+ });
2649
2806
  var SearchField = HttpField.extend({
2650
2807
  type: import_v43.default.literal(FieldType.SEARCH),
2651
2808
  configuration: SearchQuery.pick({
@@ -2678,6 +2835,9 @@ var SearchField = HttpField.extend({
2678
2835
  ok: TranslationConfig.optional()
2679
2836
  }).optional()
2680
2837
  })
2838
+ }).meta({
2839
+ description: "A search input field",
2840
+ id: "SearchField"
2681
2841
  });
2682
2842
  var LinkButtonField = BaseField.extend({
2683
2843
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -2686,7 +2846,10 @@ var LinkButtonField = BaseField.extend({
2686
2846
  text: TranslationConfig.describe("Text to display on the button"),
2687
2847
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
2688
2848
  })
2689
- }).describe("Button that opens a link");
2849
+ }).meta({
2850
+ description: "A button that opens a URL link",
2851
+ id: "LinkButtonField"
2852
+ });
2690
2853
  var VerificationStatus = BaseField.extend({
2691
2854
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
2692
2855
  defaultValue: VerificationStatusValue.optional(),
@@ -2696,15 +2859,19 @@ var VerificationStatus = BaseField.extend({
2696
2859
  "Explaining text on the banner in form."
2697
2860
  )
2698
2861
  })
2862
+ }).meta({
2863
+ 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.",
2864
+ id: "VerificationStatus"
2699
2865
  });
2700
2866
  var QueryParamReaderField = BaseField.extend({
2701
2867
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
2702
2868
  configuration: import_v43.default.object({
2703
2869
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
2704
2870
  })
2705
- }).describe(
2706
- "A field that maps URL query params into form values and clears them afterward"
2707
- );
2871
+ }).meta({
2872
+ description: "A field that maps URL query params into form values and clears them afterward",
2873
+ id: "QueryParamReaderField"
2874
+ });
2708
2875
  var QrReaderField = BaseField.extend({
2709
2876
  type: import_v43.default.literal(FieldType.QR_READER),
2710
2877
  defaultValue: QrReaderFieldValue.optional(),
@@ -2715,7 +2882,7 @@ var QrReaderField = BaseField.extend({
2715
2882
  })
2716
2883
  }).optional()
2717
2884
  }).meta({
2718
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2885
+ description: "QR code reader field, including optional JSON Schema validator.",
2719
2886
  id: "QrReaderField"
2720
2887
  });
2721
2888
  var IdReaderField = BaseField.extend({
@@ -2724,12 +2891,18 @@ var IdReaderField = BaseField.extend({
2724
2891
  methods: import_v43.default.array(
2725
2892
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
2726
2893
  )
2894
+ }).meta({
2895
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2896
+ id: "IdReaderField"
2727
2897
  });
2728
2898
  var CustomField = BaseField.extend({
2729
2899
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
2730
2900
  defaultValue: CustomFieldValue.optional(),
2731
2901
  src: import_v43.default.string().describe("Module source path for the custom field component"),
2732
2902
  configuration: import_v43.default.unknown().optional()
2903
+ }).meta({
2904
+ description: "An expiremental custom field that is defined by a module source path",
2905
+ id: "CustomField"
2733
2906
  });
2734
2907
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2735
2908
  var LoaderField = BaseField.extend({
@@ -2739,22 +2912,25 @@ var LoaderField = BaseField.extend({
2739
2912
  configuration: import_v43.default.object({
2740
2913
  text: TranslationConfig.describe("Display text above the loading spinner")
2741
2914
  })
2742
- }).describe(
2743
- "A non-interactive field that indicates an in progress operation in form"
2744
- );
2915
+ }).meta({
2916
+ description: "A non-interactive field that indicates an in progress operation in form",
2917
+ id: "LoaderField"
2918
+ });
2745
2919
  var HiddenField = BaseField.extend({
2746
2920
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2747
2921
  required: import_v43.default.boolean().default(false).optional(),
2748
2922
  defaultValue: TextValue.optional()
2749
- }).describe(
2750
- "A non-interactive, hidden field that only hold a value in the form"
2751
- );
2923
+ }).meta({
2924
+ description: "A non-interactive, hidden field that only hold a value in the form",
2925
+ id: "HiddenField"
2926
+ });
2752
2927
  var UserRoleField = BaseField.extend({
2753
2928
  type: import_v43.default.literal(FieldType.USER_ROLE),
2754
2929
  defaultValue: TextValue.optional()
2755
- }).describe(
2756
- "A select dropdown that is automatically populated with available user roles"
2757
- );
2930
+ }).meta({
2931
+ description: "A select dropdown that is automatically populated with available user roles",
2932
+ id: "UserRoleField"
2933
+ });
2758
2934
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2759
2935
  FieldGroup,
2760
2936
  Address,
@@ -2853,16 +3029,19 @@ var VerificationPageConfig = FormPageConfig.extend({
2853
3029
  type: z21.literal(PageTypes.enum.VERIFICATION),
2854
3030
  actions: VerificationActionConfig
2855
3031
  });
2856
- var PageConfig = z21.discriminatedUnion("type", [
2857
- FormPageConfig,
2858
- VerificationPageConfig
2859
- ]);
3032
+ var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
3033
+ id: "PageConfig",
3034
+ 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."
3035
+ });
2860
3036
 
2861
3037
  // ../commons/src/events/FormConfig.ts
2862
3038
  var DeclarationFormConfig = z22.object({
2863
3039
  label: TranslationConfig.describe("Human readable description of the form"),
2864
3040
  pages: z22.array(FormPageConfig)
2865
- }).describe("Configuration of the declaration form.");
3041
+ }).meta({
3042
+ id: "DeclarationFormConfig",
3043
+ description: "Configuration of the declaration form."
3044
+ });
2866
3045
  var ActionFormConfig = z22.object({
2867
3046
  label: TranslationConfig.describe("Human readable description of the form"),
2868
3047
  pages: z22.array(PageConfig)
@@ -2962,6 +3141,9 @@ var DeduplicationConfig = z23.object({
2962
3141
  id: z23.string(),
2963
3142
  label: TranslationConfig,
2964
3143
  query: Clause
3144
+ }).meta({
3145
+ id: "DeduplicationConfig",
3146
+ 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."
2965
3147
  });
2966
3148
 
2967
3149
  // ../commons/src/events/ActionConfig.ts
@@ -3079,17 +3261,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
3079
3261
  * OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
3080
3262
  * and treat them as "models" instead of duplicating the data structure in each endpoint.
3081
3263
  */
3082
- ReadActionConfig.meta({ id: "ReadActionConfig" }),
3083
- DeclareConfig.meta({ id: "DeclareActionConfig" }),
3084
- RejectConfig.meta({ id: "RejectActionConfig" }),
3085
- RegisterConfig.meta({ id: "RegisterActionConfig" }),
3264
+ ReadActionConfig.meta({
3265
+ id: "ReadActionConfig",
3266
+ description: "Configuration for the read action \u2014 defines the record-tab content displayed on the event overview page."
3267
+ }),
3268
+ DeclareConfig.meta({
3269
+ id: "DeclareActionConfig",
3270
+ description: "Configuration for the declare action. Includes review-page fields. Shared with the notify action (ActionType.NOTIFY)."
3271
+ }),
3272
+ RejectConfig.meta({
3273
+ id: "RejectActionConfig",
3274
+ description: "Configuration for rejecting a record before registration."
3275
+ }),
3276
+ RegisterConfig.meta({
3277
+ id: "RegisterActionConfig",
3278
+ description: "Configuration for registering a record."
3279
+ }),
3086
3280
  PrintCertificateActionConfig.meta({
3087
- id: "PrintCertificateActionConfig"
3281
+ id: "PrintCertificateActionConfig",
3282
+ description: "Configuration for printing a certificate of a registered record."
3088
3283
  }),
3089
- RequestCorrectionConfig.meta({ id: "RequestCorrectionActionConfig" }),
3090
- EditActionConfig.meta({ id: "EditActionConfig" }),
3091
- ArchiveConfig.meta({ id: "ArchiveActionConfig" }),
3092
- CustomActionConfig.meta({ id: "CustomActionConfig" })
3284
+ RequestCorrectionConfig.meta({
3285
+ id: "RequestCorrectionActionConfig",
3286
+ description: "Configuration for requesting a correction on a registered record."
3287
+ }),
3288
+ EditActionConfig.meta({
3289
+ id: "EditActionConfig",
3290
+ description: "Configuration for editing a record before registration."
3291
+ }),
3292
+ ArchiveConfig.meta({
3293
+ id: "ArchiveActionConfig",
3294
+ description: "Configuration for archiving a record."
3295
+ }),
3296
+ CustomActionConfig.meta({
3297
+ id: "CustomActionConfig",
3298
+ description: "Configuration for a country-defined custom action. An event may include any number of these."
3299
+ })
3093
3300
  ]).describe(
3094
3301
  "Configuration of an action available for an event. Data collected depends on the action type and is accessible through the annotation property in ActionDocument."
3095
3302
  ).meta({ id: "ActionConfig" });
@@ -3165,7 +3372,10 @@ var Field = BaseField2.extend({
3165
3372
  }).describe("Custom field defined for the summary view.");
3166
3373
  var SummaryConfig = z27.object({
3167
3374
  fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
3168
- }).describe("Configuration of the event summary section.");
3375
+ }).meta({
3376
+ id: "SummaryConfig",
3377
+ 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."
3378
+ });
3169
3379
 
3170
3380
  // ../commons/src/events/AdvancedSearchConfig.ts
3171
3381
  var z28 = __toESM(require("zod/v4"));
@@ -3289,6 +3499,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
3289
3499
  var AdvancedSearchConfig = z28.object({
3290
3500
  title: TranslationConfig.describe("Advanced search tab title"),
3291
3501
  fields: z28.array(AdvancedSearchField).describe("Advanced search fields within the tab.")
3502
+ }).meta({
3503
+ id: "AdvancedSearchConfig",
3504
+ 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()`)."
3292
3505
  });
3293
3506
 
3294
3507
  // ../commons/src/events/utils.ts
@@ -3765,6 +3978,9 @@ function precompileActionSchemas(eventConfigurations) {
3765
3978
  function isAgeValue(value) {
3766
3979
  return typeof value === "object" && value !== null && "age" in value && typeof value.age === "number";
3767
3980
  }
3981
+ function mergeWithBaseFormState(values, context) {
3982
+ return { ...context.baseFormState, ...values };
3983
+ }
3768
3984
  function validate(schema, data) {
3769
3985
  const validator = ajv.getSchema(schema.$id) || ajv.compile(schema);
3770
3986
  if ("$form" in data) {
@@ -3803,7 +4019,7 @@ function isOnline() {
3803
4019
  }
3804
4020
  function isConditionMet(conditional, values, context, eventIndex) {
3805
4021
  return validate(conditional, {
3806
- $form: values,
4022
+ $form: mergeWithBaseFormState(values, context),
3807
4023
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
3808
4024
  $online: isOnline(),
3809
4025
  $user: context.user,
@@ -3832,7 +4048,7 @@ function isFieldConditionMet(field3, form, conditionalType, context) {
3832
4048
  return true;
3833
4049
  }
3834
4050
  const validConditionals = getConditionalActionsForField(field3, {
3835
- $form: form,
4051
+ $form: mergeWithBaseFormState(form, context),
3836
4052
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
3837
4053
  $online: isOnline(),
3838
4054
  $user: context.user,
@@ -4024,7 +4240,7 @@ function runFieldValidations({
4024
4240
  return [];
4025
4241
  }
4026
4242
  const conditionalParameters = {
4027
- $form: form,
4243
+ $form: mergeWithBaseFormState(form, context),
4028
4244
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
4029
4245
  /**
4030
4246
  * In real use cases, there can be hundreds of thousands of locations.
@@ -4268,17 +4484,16 @@ function isPageVisible(page, formValues, context) {
4268
4484
  }
4269
4485
  return isConditionMet(page.conditional, formValues, context);
4270
4486
  }
4271
- function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false, declarationContext) {
4487
+ function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false) {
4272
4488
  const base = (0, import_lodash.cloneDeep)(formValues);
4273
4489
  function fn(prevVisibilityContext) {
4274
- const visibilityForm = declarationContext ? { ...declarationContext, ...prevVisibilityContext } : prevVisibilityContext;
4275
4490
  const cleaned = (0, import_lodash.omitBy)(base, (value, fieldId) => {
4276
4491
  const fieldConfig = fields.filter((f) => f.id === fieldId);
4277
4492
  if (!fieldConfig.length) {
4278
4493
  return false;
4279
4494
  }
4280
4495
  const isHidden = fieldConfig.every(
4281
- (f) => !isFieldVisible(f, visibilityForm, validatorContext)
4496
+ (f) => !isFieldVisible(f, prevVisibilityContext, validatorContext)
4282
4497
  );
4283
4498
  if (!isHidden) {
4284
4499
  return false;
@@ -4296,7 +4511,7 @@ function omitHiddenPaginatedFields(formConfig, values, validatorContext, include
4296
4511
  const visibleFields = formConfig.pages.filter((p) => isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
4297
4512
  const hiddenFields = formConfig.pages.filter((p) => !isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
4298
4513
  const valuesExceptHiddenPage = (0, import_lodash.omitBy)(values, (_2, fieldId) => {
4299
- return hiddenFields.some((f) => f.id === fieldId);
4514
+ return hiddenFields.some((f) => f.id === fieldId) && !visibleFields.some((f) => f.id === fieldId);
4300
4515
  });
4301
4516
  return omitHiddenFields(
4302
4517
  visibleFields,
@@ -4343,13 +4558,10 @@ function getVisibleVerificationPageIds(pages, annotation, context) {
4343
4558
  }
4344
4559
  function omitHiddenAnnotationFields(actionConfig, declaration, annotation, context) {
4345
4560
  const annotationFields = getActionAnnotationFields(actionConfig);
4346
- return omitHiddenFields(
4347
- annotationFields,
4348
- annotation,
4349
- context,
4350
- false,
4351
- declaration
4352
- );
4561
+ return omitHiddenFields(annotationFields, annotation, {
4562
+ ...context,
4563
+ baseFormState: declaration
4564
+ });
4353
4565
  }
4354
4566
  function deepMerge(currentDocument, actionDocument) {
4355
4567
  const currentDocumentClone = (0, import_lodash.cloneDeep)(currentDocument);
@@ -4643,6 +4855,9 @@ function not(condition) {
4643
4855
  function never2() {
4644
4856
  return not(alwaysTrue());
4645
4857
  }
4858
+ function always() {
4859
+ return defineConditional(alwaysTrue());
4860
+ }
4646
4861
  function jsonFieldPath(field3) {
4647
4862
  return [field3.$$field, ...field3.$$subfield].join("/");
4648
4863
  }
@@ -5338,7 +5553,7 @@ var _EventConfigBase = z33.object({
5338
5553
  ),
5339
5554
  label: TranslationConfig.describe("Human-readable label for the event type."),
5340
5555
  actions: z33.array(ActionConfig).describe(
5341
- "Configuration of system-defined actions associated with the event."
5556
+ "Configuration of core and custom actions associated with the event."
5342
5557
  ),
5343
5558
  actionOrder: z33.array(z33.string()).optional().describe(
5344
5559
  "Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
@@ -5350,7 +5565,7 @@ var _EventConfigBase = z33.object({
5350
5565
  "Configuration of fields available in the advanced search feature."
5351
5566
  ),
5352
5567
  flags: z33.array(FlagConfig).optional().default([]).describe(
5353
- "Configuration of flags associated with the actions of this event type."
5568
+ "Configuration of custom flags associated with the actions of this event type."
5354
5569
  ),
5355
5570
  analytics: z33.boolean().optional().default(true).describe(
5356
5571
  "Indicates whether the records of this event type are included in analytics"
@@ -5363,8 +5578,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
5363
5578
  validateActionFlags(event2, ctx);
5364
5579
  validateActionOrder(event2, ctx);
5365
5580
  }).meta({
5366
- id: "EventConfig"
5367
- }).describe("Configuration defining an event type.");
5581
+ id: "EventConfig",
5582
+ description: "Configuration defining an event type registered in OpenCRVS (for example birth or death)."
5583
+ });
5368
5584
 
5369
5585
  // ../commons/src/events/EventConfigInput.ts
5370
5586
  var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
@@ -5587,6 +5803,9 @@ var WorkqueueColumnValue = z34.object({
5587
5803
  var WorkqueueColumn = z34.object({
5588
5804
  label: TranslationConfig,
5589
5805
  value: WorkqueueColumnValue
5806
+ }).meta({
5807
+ id: "WorkqueueColumn",
5808
+ description: "Configuration for a single workqueue column. The value references an event metadata key (e.g. `dateOfEvent`, `status`, `trackingId`)."
5590
5809
  });
5591
5810
  function defineWorkqueuesColumns(workqueueColumns) {
5592
5811
  return workqueueColumns.map(
@@ -5789,18 +6008,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
5789
6008
  query: true,
5790
6009
  columns: true
5791
6010
  });
5792
- var WorkqueueConfigInput = z37.object({
5793
- slug: z37.string().describe("Determines the url of the workqueue."),
5794
- name: TranslationConfig.describe(
5795
- "Title of the workflow (both in navigation and on the page)"
5796
- ),
5797
- query: CountryConfigQueryInputType,
5798
- action: z37.object({ type: WorkqueueActionType }).optional().describe(
5799
- "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."
5800
- ),
5801
- columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
5802
- icon: AvailableIcons,
5803
- emptyMessage: TranslationConfig.optional()
6011
+ var WorkqueueConfigInput = WorkqueueConfig.extend({
6012
+ query: CountryConfigQueryInputType
6013
+ }).meta({
6014
+ id: "WorkqueueConfig",
6015
+ 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."
5804
6016
  });
5805
6017
  function defineWorkqueue(workqueueInput) {
5806
6018
  const queryInput = workqueueInput.query;
@@ -5861,6 +6073,11 @@ var BaseActionInput = z38.object({
5861
6073
  originalActionId: UUID.optional(),
5862
6074
  // should not be part of base action.
5863
6075
  keepAssignment: z38.boolean().optional(),
6076
+ keepAssignmentIfAccepted: z38.boolean().optional(),
6077
+ keepAssignmentIfRejected: z38.boolean().optional(),
6078
+ waitFor: z38.boolean().default(true).describe(
6079
+ "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."
6080
+ ),
5864
6081
  // For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
5865
6082
  // @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
5866
6083
  createdAtLocation: UUID.nullish().describe(
@@ -6040,7 +6257,7 @@ var Draft = z39.object({
6040
6257
  }).describe(
6041
6258
  "A temporary storage for an action. Stored with details of the event, creator and creation time."
6042
6259
  );
6043
- var DraftInput = BaseActionInput.extend({
6260
+ var DraftInput = BaseActionInput.omit({ waitFor: true }).extend({
6044
6261
  type: ActionTypes.exclude([ActionTypes.enum.DELETE]),
6045
6262
  status: z39.enum([
6046
6263
  ActionStatus.Requested,
@@ -6114,7 +6331,6 @@ function getDeclarationActionCreationMetadata(actionType, actions) {
6114
6331
  createdAtLocation: requestAction?.createdAtLocation ?? acceptAction.createdAtLocation,
6115
6332
  acceptedAt: acceptAction.createdAt,
6116
6333
  createdByRole: requestAction?.createdByRole ?? acceptAction.createdByRole,
6117
- createdBySignature: requestAction?.createdBySignature ?? acceptAction.createdBySignature,
6118
6334
  registrationNumber
6119
6335
  };
6120
6336
  }
@@ -6172,26 +6388,43 @@ var import_date_fns3 = require("date-fns");
6172
6388
  function isEditInProgress(actions) {
6173
6389
  return actions.at(-1)?.type === ActionType.EDIT;
6174
6390
  }
6391
+ function findPendingCorrectionAction(writeActions2) {
6392
+ let correctionRequestAction;
6393
+ for (let i = writeActions2.length - 1; i >= 0; i--) {
6394
+ const action = writeActions2[i];
6395
+ if (action.type === ActionType.APPROVE_CORRECTION || action.type === ActionType.REJECT_CORRECTION) {
6396
+ break;
6397
+ }
6398
+ if (action.type === ActionType.REQUEST_CORRECTION) {
6399
+ correctionRequestAction = action;
6400
+ break;
6401
+ }
6402
+ }
6403
+ return correctionRequestAction;
6404
+ }
6175
6405
  function isCorrectionRequested(actions) {
6406
+ return findPendingCorrectionAction(actions) !== void 0;
6407
+ }
6408
+ function isDeclarationIncomplete(actions) {
6409
+ return getStatusFromActions(actions) === EventStatus.enum.NOTIFIED;
6410
+ }
6411
+ function isRejected(actions) {
6412
+ const resettingActionTypes = [
6413
+ ActionType.NOTIFY,
6414
+ ActionType.DECLARE,
6415
+ ActionType.EDIT,
6416
+ ActionType.REGISTER
6417
+ ];
6176
6418
  return actions.reduce((prev, { type }) => {
6177
- if (type === ActionType.REQUEST_CORRECTION) {
6419
+ if (type === ActionType.REJECT) {
6178
6420
  return true;
6179
6421
  }
6180
- if (type === ActionType.APPROVE_CORRECTION) {
6181
- return false;
6182
- }
6183
- if (type === ActionType.REJECT_CORRECTION) {
6422
+ if (resettingActionTypes.includes(type)) {
6184
6423
  return false;
6185
6424
  }
6186
6425
  return prev;
6187
6426
  }, false);
6188
6427
  }
6189
- function isDeclarationIncomplete(actions) {
6190
- return getStatusFromActions(actions) === EventStatus.enum.NOTIFIED;
6191
- }
6192
- function isRejected(actions) {
6193
- return actions.at(-1)?.type === ActionType.REJECT;
6194
- }
6195
6428
  function isPotentialDuplicate(actions) {
6196
6429
  return actions.reduce((prev, { type }) => {
6197
6430
  if (type === ActionType.DUPLICATE_DETECTED) {
@@ -6254,8 +6487,7 @@ function resolveEventCustomFlags(event2, eventConfiguration) {
6254
6487
  return (0, import_lodash3.uniq)(flags);
6255
6488
  }, []);
6256
6489
  }
6257
- function getEventFlags(event2, config) {
6258
- const sortedActions = event2.actions.filter(({ type }) => !isMetaAction(type)).sort((a, b) => a.createdAt.localeCompare(b.createdAt));
6490
+ function getActionStatusFlags(sortedActions) {
6259
6491
  const actionStatus = sortedActions.reduce(
6260
6492
  (actionStatuses, { type, status: status2 }) => ({
6261
6493
  ...actionStatuses,
@@ -6263,26 +6495,40 @@ function getEventFlags(event2, config) {
6263
6495
  }),
6264
6496
  {}
6265
6497
  );
6266
- const flags = Object.entries(actionStatus).filter(([, status2]) => status2 !== ActionStatus.Accepted).map(([type, status2]) => {
6498
+ return Object.entries(actionStatus).filter(([, status2]) => status2 !== ActionStatus.Accepted).map(([type, status2]) => {
6267
6499
  const flag2 = joinValues([type, status2], ":").toLowerCase();
6268
6500
  return flag2;
6269
6501
  });
6270
- if (isCorrectionRequested(sortedActions)) {
6271
- flags.push(InherentFlags.CORRECTION_REQUESTED);
6502
+ }
6503
+ function getInherentFlags(sortedActions) {
6504
+ const acceptedActions = sortedActions.filter(
6505
+ ({ status: status2 }) => status2 === ActionStatus.Accepted
6506
+ );
6507
+ const inherentFlags = [];
6508
+ if (isCorrectionRequested(acceptedActions)) {
6509
+ inherentFlags.push(InherentFlags.CORRECTION_REQUESTED);
6272
6510
  }
6273
- if (isDeclarationIncomplete(sortedActions)) {
6274
- flags.push(InherentFlags.INCOMPLETE);
6511
+ if (isDeclarationIncomplete(acceptedActions)) {
6512
+ inherentFlags.push(InherentFlags.INCOMPLETE);
6275
6513
  }
6276
- if (isRejected(sortedActions)) {
6277
- flags.push(InherentFlags.REJECTED);
6514
+ if (isRejected(acceptedActions)) {
6515
+ inherentFlags.push(InherentFlags.REJECTED);
6278
6516
  }
6279
- if (isPotentialDuplicate(sortedActions)) {
6280
- flags.push(InherentFlags.POTENTIAL_DUPLICATE);
6517
+ if (isPotentialDuplicate(acceptedActions)) {
6518
+ inherentFlags.push(InherentFlags.POTENTIAL_DUPLICATE);
6281
6519
  }
6282
- if (isEditInProgress(sortedActions)) {
6283
- flags.push(InherentFlags.EDIT_IN_PROGRESS);
6520
+ if (isEditInProgress(acceptedActions)) {
6521
+ inherentFlags.push(InherentFlags.EDIT_IN_PROGRESS);
6284
6522
  }
6285
- return [...flags, ...resolveEventCustomFlags(event2, config)];
6523
+ return inherentFlags;
6524
+ }
6525
+ function getEventFlags(event2, config) {
6526
+ const sortedActions = event2.actions.filter(({ type }) => !isMetaAction(type)).sort((a, b) => a.createdAt.localeCompare(b.createdAt));
6527
+ return [
6528
+ ...getActionStatusFlags(sortedActions),
6529
+ ...getInherentFlags(sortedActions),
6530
+ ...resolveEventCustomFlags(event2, config)
6531
+ ];
6286
6532
  }
6287
6533
 
6288
6534
  // ../commons/src/events/state/index.ts
@@ -6328,17 +6574,6 @@ function getAssignedUserFromActions(actions) {
6328
6574
  return user2;
6329
6575
  }, null);
6330
6576
  }
6331
- function getAssignedUserSignatureFromActions(actions) {
6332
- return actions.reduce((signature, action) => {
6333
- if (action.type === ActionType.ASSIGN) {
6334
- return action.createdBySignature || null;
6335
- }
6336
- if (action.type === ActionType.UNASSIGN) {
6337
- return null;
6338
- }
6339
- return signature;
6340
- }, null);
6341
- }
6342
6577
  function deepDropNulls(obj) {
6343
6578
  if (Array.isArray(obj)) {
6344
6579
  return obj.map(deepDropNulls);
@@ -6434,10 +6669,8 @@ function getCurrentEventState(event2, config) {
6434
6669
  createdBy: creationAction.createdBy,
6435
6670
  createdByUserType: creationAction.createdByUserType,
6436
6671
  createdAtLocation: creationAction.createdAtLocation,
6437
- createdBySignature: creationAction.createdBySignature,
6438
6672
  updatedAt: acceptedActionMetadata.createdAt,
6439
6673
  assignedTo: getAssignedUserFromActions(acceptedActions),
6440
- assignedToSignature: getAssignedUserSignatureFromActions(acceptedActions),
6441
6674
  updatedBy: requestActionMetadata.createdBy,
6442
6675
  updatedAtLocation: requestActionMetadata.createdAtLocation,
6443
6676
  declaration,
@@ -9696,7 +9929,6 @@ var eventQueryDataGenerator = (overrides = {}, seed = 1) => {
9696
9929
  createdBy: overrides.createdBy ?? generateUuid(rng),
9697
9930
  createdAtLocation: overrides.createdAtLocation ?? generateUuid(rng),
9698
9931
  updatedAtLocation: overrides.updatedAtLocation ?? generateUuid(rng),
9699
- createdBySignature: overrides.createdBySignature ?? generateRandomSignature(rng),
9700
9932
  updatedAt: overrides.updatedAt ?? (0, import_date_fns4.addDays)(new Date(createdAt), 1).toISOString(),
9701
9933
  assignedTo: overrides.assignedTo ?? null,
9702
9934
  updatedBy: overrides.updatedBy ?? generateUuid(rng),
@@ -9929,11 +10161,77 @@ function canAccessEventWithScope(event2, scope, user2, customActionType) {
9929
10161
  }
9930
10162
  return true;
9931
10163
  }
10164
+ function canAccessUserWithScope({
10165
+ userToAccess,
10166
+ scope,
10167
+ user: user2
10168
+ }) {
10169
+ const opts = scope.options;
10170
+ const hasSameOffice = user2.primaryOfficeId === userToAccess.primaryOfficeId;
10171
+ if (opts?.accessLevel === JurisdictionFilter.enum.location && !hasSameOffice) {
10172
+ return false;
10173
+ }
10174
+ const hasAdministrativeAreaInHierarchy = userToAccess.administrativeHierarchy.some(
10175
+ (id) => user2.administrativeAreaId === id
10176
+ ) || user2.administrativeAreaId === null;
10177
+ if (opts?.accessLevel === JurisdictionFilter.enum.administrativeArea && !hasAdministrativeAreaInHierarchy) {
10178
+ return false;
10179
+ }
10180
+ if (scopeUsesRoleOptions(scope)) {
10181
+ const { options } = scope;
10182
+ if (options?.role && !options.role.includes(userToAccess.role)) {
10183
+ return false;
10184
+ }
10185
+ }
10186
+ return true;
10187
+ }
10188
+ function canAccessOtherUserWithScopes({
10189
+ scopes,
10190
+ userToAccess,
10191
+ user: user2
10192
+ }) {
10193
+ return scopes.some(
10194
+ (scope) => canAccessUserWithScope({ userToAccess, scope, user: user2 })
10195
+ );
10196
+ }
9932
10197
  function userCanAccessEventWithScopes(event2, scopes, user2, customActionType) {
9933
10198
  return scopes.some(
9934
10199
  (scope) => canAccessEventWithScope(event2, scope, user2, customActionType)
9935
10200
  );
9936
10201
  }
10202
+ function getAdministrativeAreaHierarchy(administrativeAreaId, administrativeAreas) {
10203
+ const collectedLocations = [];
10204
+ const parsedAdministrativeAreaId = administrativeAreaId && UUID.safeParse(administrativeAreaId).data;
10205
+ let current = parsedAdministrativeAreaId ? administrativeAreas.get(parsedAdministrativeAreaId) : null;
10206
+ while (current) {
10207
+ collectedLocations.push(current);
10208
+ if (!current.parentId) {
10209
+ break;
10210
+ }
10211
+ const parentId = current.parentId;
10212
+ current = administrativeAreas.get(parentId);
10213
+ }
10214
+ return collectedLocations;
10215
+ }
10216
+ function getLocationHierarchy(selectedId, context) {
10217
+ const { administrativeAreas, locations } = context;
10218
+ const loc = locations.get(selectedId);
10219
+ if (loc) {
10220
+ if (loc.administrativeAreaId) {
10221
+ const hierarchy2 = getAdministrativeAreaHierarchy(
10222
+ loc.administrativeAreaId,
10223
+ administrativeAreas
10224
+ );
10225
+ return [...hierarchy2.reverse().map((area) => area.id), loc.id];
10226
+ }
10227
+ return [loc.id];
10228
+ }
10229
+ const hierarchy = getAdministrativeAreaHierarchy(
10230
+ selectedId,
10231
+ administrativeAreas
10232
+ );
10233
+ return hierarchy.reverse().map((area) => area.id);
10234
+ }
9937
10235
 
9938
10236
  // ../commons/src/events/scopes.ts
9939
10237
  var ACTION_SCOPE_MAP = {
@@ -10008,6 +10306,25 @@ function isActionInScope({
10008
10306
  );
10009
10307
  return canAccess;
10010
10308
  }
10309
+ function getAvailableRolesForUserUpdatePayload({
10310
+ allRoles,
10311
+ userLocation,
10312
+ acceptedScopes,
10313
+ userRequesting
10314
+ }) {
10315
+ const availableRoles = allRoles.filter((role) => {
10316
+ const canAccess = canAccessOtherUserWithScopes({
10317
+ userToAccess: {
10318
+ ...userLocation,
10319
+ role
10320
+ },
10321
+ user: userRequesting,
10322
+ scopes: acceptedScopes
10323
+ });
10324
+ return canAccess;
10325
+ });
10326
+ return availableRoles;
10327
+ }
10011
10328
 
10012
10329
  // ../commons/src/events/serializers/user/deserializer.ts
10013
10330
  function userDeserializer(serializedUserField, user2) {
@@ -10210,3 +10527,366 @@ function getFilePathsFromEvent(event2) {
10210
10527
  });
10211
10528
  return (0, import_lodash7.uniq)(filepaths);
10212
10529
  }
10530
+
10531
+ // ../commons/src/events/mocks.test.utils.ts
10532
+ var V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS = [
10533
+ {
10534
+ id: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10535
+ name: "Central",
10536
+ parentId: null,
10537
+ validUntil: null,
10538
+ externalId: "ydyJb1RAy4U1"
10539
+ },
10540
+ {
10541
+ id: "c599b691-fd2d-45e1-abf4-d185de727fb5",
10542
+ name: "Sulaka",
10543
+ parentId: null,
10544
+ validUntil: null,
10545
+ externalId: "pQ8nGxWmZ2Q3"
10546
+ },
10547
+ {
10548
+ id: "7ef2b9c7-5e6d-49f6-ae05-656207d0fc64",
10549
+ name: "Pualula",
10550
+ parentId: null,
10551
+ validUntil: null,
10552
+ externalId: "Aq91DweLmT8k"
10553
+ },
10554
+ {
10555
+ id: "6d1a59df-988c-4021-a846-ccbc021931a7",
10556
+ name: "Chuminga",
10557
+ parentId: null,
10558
+ validUntil: null,
10559
+ externalId: "Rw0fYNh2Xk9a"
10560
+ },
10561
+ {
10562
+ id: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10563
+ name: "Ibombo",
10564
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10565
+ validUntil: null,
10566
+ externalId: "k7DsP4vbN1Qe"
10567
+ },
10568
+ {
10569
+ id: "27160bbd-32d1-4625-812f-860226bfb92a",
10570
+ name: "Isango",
10571
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10572
+ validUntil: null,
10573
+ externalId: "Gm3Z9eQpHw4L"
10574
+ },
10575
+ {
10576
+ id: "967032fd-3f81-478a-826c-30cb8fe121bd",
10577
+ name: "Isamba",
10578
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10579
+ validUntil: null,
10580
+ externalId: "sT0xVu1KqJ7r"
10581
+ },
10582
+ {
10583
+ id: "89a33893-b17d-481d-a26d-6461e7ac1651",
10584
+ name: "Itambo",
10585
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10586
+ validUntil: null,
10587
+ externalId: "Nq6Bv2HpL9Te"
10588
+ },
10589
+ {
10590
+ id: "d42ab2fe-e7ed-470e-8b31-4fb27f9b8250",
10591
+ name: "Ezhi",
10592
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10593
+ validUntil: null,
10594
+ externalId: "xK8cQ0ZRy5Wd"
10595
+ },
10596
+ {
10597
+ id: "8fbd09d2-212b-47f4-beb3-5e1694931d9f",
10598
+ name: "Ilanga",
10599
+ parentId: "c599b691-fd2d-45e1-abf4-d185de727fb5",
10600
+ validUntil: null,
10601
+ externalId: "Cq4Jm1XvN8Ls"
10602
+ },
10603
+ // Villages under Ibombo (62a0ccb4-880d-4f30-8882-f256007dfff9)
10604
+ {
10605
+ id: "1d4e5f6a-7b8c-4912-8efa-345678901234",
10606
+ name: "Klow",
10607
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10608
+ validUntil: null,
10609
+ externalId: "IkYcYBUcyY2"
10610
+ },
10611
+ {
10612
+ id: "2e5f6a7b-8c9d-4a23-8fab-456789012345",
10613
+ name: "Mbondo",
10614
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10615
+ validUntil: null,
10616
+ externalId: "Qhvv5hvo3mY"
10617
+ },
10618
+ {
10619
+ id: "3f6a7b8c-9d0e-4b34-8abc-567890123456",
10620
+ name: "Ndara",
10621
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10622
+ validUntil: null,
10623
+ externalId: "crXh068O9TR"
10624
+ },
10625
+ {
10626
+ id: "4a7b8c9d-0e1f-4c45-abcd-678901234567",
10627
+ name: "Olani",
10628
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10629
+ validUntil: null,
10630
+ externalId: "r00It8Tvvp7"
10631
+ },
10632
+ {
10633
+ id: "5b8c9d0e-1f2a-4d56-bcde-789012345678",
10634
+ name: "Pemba",
10635
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10636
+ validUntil: null,
10637
+ externalId: "ZnUWsbONIaH"
10638
+ },
10639
+ {
10640
+ id: "6c9d0e1f-2a3b-4e67-8def-890123456789",
10641
+ name: "Quanza",
10642
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10643
+ validUntil: null,
10644
+ externalId: "fDZycvQTa7l"
10645
+ },
10646
+ {
10647
+ id: "7d0e1f2a-3b4c-4f78-8efa-901234567890",
10648
+ name: "Rivka",
10649
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10650
+ validUntil: null,
10651
+ externalId: "KqswxCGTELa"
10652
+ },
10653
+ // Villages under Isamba (967032fd-3f81-478a-826c-30cb8fe121bd)
10654
+ {
10655
+ id: "8e1f2a3b-4c5d-4089-8fab-012345678901",
10656
+ name: "Mbula",
10657
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10658
+ validUntil: null,
10659
+ externalId: "osEbKjRc9Kg"
10660
+ },
10661
+ {
10662
+ id: "9f2a3b4c-5d6e-4190-8abf-123456789012",
10663
+ name: "Ndoki",
10664
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10665
+ validUntil: null,
10666
+ externalId: "aq4daBUAGr3"
10667
+ },
10668
+ {
10669
+ id: "0a3b4c5d-6e7f-4201-abcd-234567890123",
10670
+ name: "Tsanga",
10671
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10672
+ validUntil: null,
10673
+ externalId: "cqis6Y8trbJ"
10674
+ },
10675
+ {
10676
+ id: "1b4c5d6e-7f8a-4312-bcde-345678901234",
10677
+ name: "Waziri",
10678
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10679
+ validUntil: null,
10680
+ externalId: "LMijHPyyx6d"
10681
+ },
10682
+ {
10683
+ id: "2c5d6e7f-8a9b-4423-8def-456789012345",
10684
+ name: "Zimbi",
10685
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10686
+ validUntil: null,
10687
+ externalId: "pcQYbPuKGZ7"
10688
+ },
10689
+ // Villages under Itambo (89a33893-b17d-481d-a26d-6461e7ac1651)
10690
+ {
10691
+ id: "3d6e7f8a-9b0c-4534-8efa-567890123456",
10692
+ name: "Felani",
10693
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10694
+ validUntil: null,
10695
+ externalId: "gSqpoCGdMXp"
10696
+ },
10697
+ {
10698
+ id: "4e7f8a9b-0c1d-4645-8fab-678901234567",
10699
+ name: "Goroma",
10700
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10701
+ validUntil: null,
10702
+ externalId: "KvAAIaNqVrp"
10703
+ },
10704
+ {
10705
+ id: "5f8a9b0c-1d2e-4756-8abc-789012345678",
10706
+ name: "Halifu",
10707
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10708
+ validUntil: null,
10709
+ externalId: "qe4UnEVt1hv"
10710
+ },
10711
+ {
10712
+ id: "6a9b0c1d-2e3f-4867-abcd-890123456789",
10713
+ name: "Jabari",
10714
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10715
+ validUntil: null,
10716
+ externalId: "yHH9Nz4rLOt"
10717
+ },
10718
+ {
10719
+ id: "7b0c1d2e-3f4a-4978-bcde-901234567890",
10720
+ name: "Kifani",
10721
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10722
+ validUntil: null,
10723
+ externalId: "eSWmXIGeu1I"
10724
+ },
10725
+ {
10726
+ id: "8c1d2e3f-4a5b-4089-8def-012345678901",
10727
+ name: "Lumela",
10728
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
10729
+ validUntil: null,
10730
+ externalId: "bh0b3aI1uP3"
10731
+ }
10732
+ ];
10733
+ var V2_DEFAULT_MOCK_LOCATIONS = [
10734
+ {
10735
+ id: "6f6186ce-cd5f-4a5f-810a-2d99e7c4ba12",
10736
+ name: "Central Provincial Office",
10737
+ locationType: "CRVS_OFFICE",
10738
+ administrativeAreaId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10739
+ validUntil: null,
10740
+ externalId: "Xr3Df8WpK6Ys"
10741
+ },
10742
+ {
10743
+ id: "b1c2d3e4-f5a6-7890-bcde-f12345678901",
10744
+ name: "Central Health Post",
10745
+ locationType: "HEALTH_FACILITY",
10746
+ administrativeAreaId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
10747
+ validUntil: null
10748
+ },
10749
+ {
10750
+ id: "028d2c85-ca31-426d-b5d1-2cef545a4902",
10751
+ name: "Ibombo District Office",
10752
+ locationType: "CRVS_OFFICE",
10753
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10754
+ validUntil: null,
10755
+ externalId: "Sm4Nw7GrD2Vy"
10756
+ },
10757
+ {
10758
+ id: "62a0ccb4-4f30-4f30-8882-f256007dff9f",
10759
+ name: "Isamba District Office",
10760
+ locationType: "CRVS_OFFICE",
10761
+ administrativeAreaId: "967032fd-3f81-478a-826c-30cb8fe121bd",
10762
+ validUntil: null,
10763
+ externalId: "Vg1Bq5XeH9Lt"
10764
+ },
10765
+ {
10766
+ id: "954c93e1-13f7-4435-bb82-35e0e215e07d",
10767
+ name: "Isango District Office",
10768
+ locationType: "CRVS_OFFICE",
10769
+ administrativeAreaId: "27160bbd-32d1-4625-812f-860226bfb92a",
10770
+ validUntil: null,
10771
+ externalId: "Je7Lm2XqN9Vz"
10772
+ },
10773
+ {
10774
+ id: "2884f5b9-17b4-49ce-bf4d-f538228935df",
10775
+ name: "Sulaka Provincial Office",
10776
+ locationType: "CRVS_OFFICE",
10777
+ administrativeAreaId: "c599b691-fd2d-45e1-abf4-d185de727fb5",
10778
+ validUntil: null,
10779
+ externalId: "Ht2Wp9KcX5Qv"
10780
+ },
10781
+ {
10782
+ id: "030358c6-54af-44be-821b-8e4af963a49c",
10783
+ name: "Ilanga District Office",
10784
+ locationType: "CRVS_OFFICE",
10785
+ administrativeAreaId: "8fbd09d2-212b-47f4-beb3-5e1694931d9f",
10786
+ validUntil: null,
10787
+ externalId: "Yp6Ds1WqN3Xz"
10788
+ },
10789
+ {
10790
+ id: "423d000f-101b-47c0-8b86-21a908067cee",
10791
+ name: "Chamakubi Health Post",
10792
+ locationType: "HEALTH_FACILITY",
10793
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10794
+ validUntil: null,
10795
+ externalId: "M1nFr8LbC2Qy"
10796
+ },
10797
+ {
10798
+ id: "4d3279be-d026-420c-88f7-f0a4ae986973",
10799
+ name: "Ibombo Rural Health Centre",
10800
+ locationType: "HEALTH_FACILITY",
10801
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10802
+ validUntil: null,
10803
+ externalId: "bT7pV6YrW0Xc"
10804
+ },
10805
+ {
10806
+ id: "190902f4-1d77-476a-8947-41145af1db7d",
10807
+ name: "Chikobo Rural Health Centre",
10808
+ locationType: "HEALTH_FACILITY",
10809
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10810
+ validUntil: null,
10811
+ externalId: "zE4qPn2SgJ5d"
10812
+ },
10813
+ {
10814
+ id: "f5ecbd9b-a01e-4a65-910e-70e86ab41b71",
10815
+ name: "Chilochabalenje Health Post",
10816
+ locationType: "HEALTH_FACILITY",
10817
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10818
+ validUntil: null,
10819
+ externalId: "H8vDs1MqR4Uf"
10820
+ },
10821
+ {
10822
+ id: "dbfc178f-7295-4b90-b28d-111c95b03127",
10823
+ name: "Chipeso Rural Health Centre",
10824
+ locationType: "HEALTH_FACILITY",
10825
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10826
+ validUntil: null,
10827
+ externalId: "Qw3uZ9KfX6Lm"
10828
+ },
10829
+ {
10830
+ id: "09862bfe-c7ac-46cd-987b-668681533c80",
10831
+ name: "Chisamba Rural Health Centre",
10832
+ locationType: "HEALTH_FACILITY",
10833
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10834
+ validUntil: null,
10835
+ externalId: "Yr0pCg8LdM2s"
10836
+ },
10837
+ {
10838
+ id: "834ce389-e95b-4fb0-96a0-33e9ab323059",
10839
+ name: "Chitanda Rural Health Centre",
10840
+ locationType: "HEALTH_FACILITY",
10841
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10842
+ validUntil: null,
10843
+ externalId: "tS9gJ4PwB1Qx"
10844
+ },
10845
+ {
10846
+ id: "0431c433-6062-4a4c-aee9-25271aec61ee",
10847
+ name: "Golden Valley Rural Health Centre",
10848
+ locationType: "HEALTH_FACILITY",
10849
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10850
+ validUntil: null,
10851
+ externalId: "Ld7Qm3XsA8Vr"
10852
+ },
10853
+ {
10854
+ id: "bc84d0b6-7ba7-480d-a339-5d9920d90eb2",
10855
+ name: "Ipongo Rural Health Centre",
10856
+ locationType: "HEALTH_FACILITY",
10857
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10858
+ validUntil: null,
10859
+ externalId: "kF2sW9DmH0Bt"
10860
+ },
10861
+ {
10862
+ id: "4cf1f53b-b730-41d2-8649-dff7eeed970d",
10863
+ name: "Itumbwe Health Post",
10864
+ locationType: "HEALTH_FACILITY",
10865
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10866
+ validUntil: null,
10867
+ externalId: "Ue5Xb3VaC7Pq"
10868
+ },
10869
+ {
10870
+ id: "4b3676cb-9355-4942-9eb9-2ce46acaf0e0",
10871
+ name: "Kabangalala Rural Health Centre",
10872
+ locationType: "HEALTH_FACILITY",
10873
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
10874
+ validUntil: null,
10875
+ externalId: "Pz8Kc1TqH6Jn"
10876
+ },
10877
+ // Village offices
10878
+ {
10879
+ id: "1f4a5b6c-7d8e-4312-8abc-345678901234",
10880
+ name: "Klow Village Office",
10881
+ locationType: "CRVS_OFFICE",
10882
+ administrativeAreaId: "1d4e5f6a-7b8c-4912-8efa-345678901234",
10883
+ validUntil: null,
10884
+ externalId: "PmAyxAJkxiJ"
10885
+ }
10886
+ ];
10887
+ var V2_DEFAULT_MOCK_LOCATIONS_MAP = new Map(
10888
+ V2_DEFAULT_MOCK_LOCATIONS.map((l) => [l.id, l])
10889
+ );
10890
+ var V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP = new Map(
10891
+ V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS.map((a) => [a.id, a])
10892
+ );