@opencrvs/toolkit 2.0.0-rc.29c83ca → 2.0.0-rc.2acb3d5

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 (44) 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 +223 -88
  4. package/dist/cli.js +397 -131
  5. package/dist/commons/api/router.d.ts +3331 -266
  6. package/dist/commons/conditionals/conditionals.d.ts +3 -3
  7. package/dist/commons/conditionals/validate.d.ts +1 -0
  8. package/dist/commons/events/ActionInput.d.ts +108 -0
  9. package/dist/commons/events/Draft.d.ts +4 -2
  10. package/dist/commons/events/EventIndex.d.ts +0 -3
  11. package/dist/commons/events/EventMetadata.d.ts +0 -7
  12. package/dist/commons/events/FieldConfig.d.ts +5 -0
  13. package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
  14. package/dist/commons/events/state/index.d.ts +0 -4
  15. package/dist/commons/events/state/utils.d.ts +0 -2
  16. package/dist/commons/events/utils.d.ts +1 -1
  17. package/dist/conditionals/index.js +8 -4
  18. package/dist/events/index.js +307 -150
  19. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  20. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  21. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -2
  22. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +9 -1
  23. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -1
  24. package/dist/migrations/v2.0/delete-infrastructure-directory.js +66 -20
  25. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  26. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  27. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  28. package/dist/migrations/v2.0/index.d.ts +5 -3
  29. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  30. package/dist/migrations/v2.0/index.js +395 -129
  31. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +11 -1
  32. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -1
  33. package/dist/migrations/v2.0/merge-infrastructure-directory.js +17 -16
  34. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  35. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  36. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  37. package/dist/migrations/v2.0/migrate-workqueue-configs.js +140 -59
  38. package/dist/notification/index.js +294 -120
  39. package/dist/scopes/index.d.ts +6 -1
  40. package/dist/scopes/index.js +8 -4
  41. package/opencrvs-toolkit-2.0.0-rc.2acb3d5.tgz +0 -0
  42. package/package.json +5 -1
  43. package/tsconfig.tsbuildinfo +1 -1
  44. package/opencrvs-toolkit-2.0.0-rc.29c83ca.tgz +0 -0
@@ -306,7 +306,6 @@ __export(events_exports, {
306
306
  getAllUniqueFields: () => getAllUniqueFields,
307
307
  getAnnotationFromDrafts: () => getAnnotationFromDrafts,
308
308
  getAssignedUserFromActions: () => getAssignedUserFromActions,
309
- getAssignedUserSignatureFromActions: () => getAssignedUserSignatureFromActions,
310
309
  getAssignmentStatus: () => getAssignmentStatus,
311
310
  getAvailableActionsForEvent: () => getAvailableActionsForEvent,
312
311
  getAvailableRolesForUserUpdatePayload: () => getAvailableRolesForUserUpdatePayload,
@@ -610,12 +609,14 @@ var SystemScopeType = z2.enum([
610
609
  "organisation.read-locations",
611
610
  "user.read",
612
611
  "user.create",
613
- "user.edit"
612
+ "user.edit",
613
+ "user.search"
614
614
  ]);
615
615
  var UserScopeType = SystemScopeType.extract([
616
616
  "user.read",
617
617
  "user.create",
618
- "user.edit"
618
+ "user.edit",
619
+ "user.search"
619
620
  ]);
620
621
  var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
621
622
  var UserScopeV2 = z2.discriminatedUnion("type", [
@@ -624,7 +625,7 @@ var UserScopeV2 = z2.discriminatedUnion("type", [
624
625
  options: AllUserScopeOptions.optional()
625
626
  }),
626
627
  z2.object({
627
- type: UserScopeType.extract(["user.read"]),
628
+ type: UserScopeType.extract(["user.read", "user.search"]),
628
629
  options: AccessLevelOptions.optional()
629
630
  })
630
631
  ]);
@@ -703,7 +704,9 @@ var decodeScope = (query) => {
703
704
  };
704
705
  var DEFAULT_SCOPE_OPTIONS = {
705
706
  placeOfEvent: JurisdictionFilter.enum.all,
706
- accessLevel: JurisdictionFilter.enum.all
707
+ accessLevel: JurisdictionFilter.enum.all,
708
+ registeredIn: JurisdictionFilter.enum.all,
709
+ declaredIn: JurisdictionFilter.enum.all
707
710
  };
708
711
  function getAcceptedScopesByType({
709
712
  acceptedScopes,
@@ -1076,7 +1079,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
1076
1079
  ShowConditional,
1077
1080
  // Action can be shown to the user in the list but as disabled
1078
1081
  EnableConditional
1079
- ]);
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
+ });
1080
1086
  var DisplayOnReviewConditional = z7.object({
1081
1087
  type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
1082
1088
  conditional: Conditional
@@ -1091,8 +1097,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
1091
1097
  // Field output can be shown / hidden on the review page
1092
1098
  DisplayOnReviewConditional
1093
1099
  ]).meta({
1094
- description: "Field conditional configuration",
1095
- 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."
1096
1102
  });
1097
1103
 
1098
1104
  // ../commons/src/events/FieldType.ts
@@ -1412,28 +1418,20 @@ function schemaPriority(schema) {
1412
1418
  return idx === -1 ? 9999 : idx;
1413
1419
  }
1414
1420
  function safeUnion(schemas) {
1421
+ const sortedSchemas = [...schemas].sort(
1422
+ (a, b) => schemaPriority(a) - schemaPriority(b)
1423
+ );
1415
1424
  return z12.any().superRefine((val, ctx) => {
1416
- const successful = schemas.filter((s) => s.safeParse(val).success);
1417
- if (successful.length === 1) {
1418
- return;
1419
- }
1420
- if (successful.length === 0) {
1421
- ctx.addIssue({
1422
- code: "invalid_type",
1423
- expected: "custom",
1424
- message: "Value does not match any schema"
1425
- });
1426
- return;
1427
- }
1428
- successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
1429
- const best = successful[0];
1430
- if (!best.safeParse(val).success) {
1431
- ctx.addIssue({
1432
- expected: "custom",
1433
- code: "invalid_type",
1434
- message: "Value did not match the best schema"
1435
- });
1425
+ for (const schema of sortedSchemas) {
1426
+ if (schema.safeParse(val).success) {
1427
+ return;
1428
+ }
1436
1429
  }
1430
+ ctx.addIssue({
1431
+ code: "invalid_type",
1432
+ expected: "custom",
1433
+ message: "Value does not match any schema"
1434
+ });
1437
1435
  }).meta({
1438
1436
  description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
1439
1437
  });
@@ -1743,6 +1741,9 @@ var FlagConfig = z15.object({
1743
1741
  "Indicates if this flag expects an action to be performed to be cleared."
1744
1742
  ),
1745
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."
1746
1747
  });
1747
1748
  var ActionFlagConfig = z15.object({
1748
1749
  id: Flag,
@@ -1750,6 +1751,9 @@ var ActionFlagConfig = z15.object({
1750
1751
  conditional: Conditional.optional().describe(
1751
1752
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1752
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."
1753
1757
  });
1754
1758
 
1755
1759
  // ../commons/src/events/EventMetadata.ts
@@ -1771,8 +1775,7 @@ var ActionCreationMetadata = z16.object({
1771
1775
  ),
1772
1776
  createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1773
1777
  acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
1774
- createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation."),
1775
- 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.")
1776
1779
  });
1777
1780
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1778
1781
  registrationNumber: z16.string().describe(
@@ -1800,9 +1803,6 @@ var EventMetadata = z16.object({
1800
1803
  createdAtLocation: UUID.nullish().describe(
1801
1804
  "Location of the user who created the event."
1802
1805
  ),
1803
- createdBySignature: DocumentPath.nullish().describe(
1804
- "Signature of the user who created the event."
1805
- ),
1806
1806
  updatedAtLocation: UUID.nullish().describe(
1807
1807
  "Location of the user who last changed the status."
1808
1808
  ),
@@ -2177,14 +2177,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
2177
2177
  }
2178
2178
  }).describe("Unique identifier for the field");
2179
2179
  var FieldReference = import_v43.default.object({
2180
- $$field: FieldId,
2180
+ $$field: FieldId.describe("Id of the field to reference"),
2181
2181
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
2182
2182
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
2183
2183
  )
2184
2184
  }).describe("Reference to a field by its ID");
2185
2185
  var ValidationConfig = import_v43.default.object({
2186
- validator: Conditional,
2187
- 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."
2188
2195
  });
2189
2196
  var requiredSchema = import_v43.default.union([
2190
2197
  import_v43.default.boolean(),
@@ -2223,6 +2230,9 @@ var BaseField = import_v43.default.object({
2223
2230
  }).describe("Common properties shared across all field types.");
2224
2231
  var Divider = BaseField.extend({
2225
2232
  type: import_v43.default.literal(FieldType.DIVIDER)
2233
+ }).meta({
2234
+ description: "A horizontal line divider",
2235
+ id: "Divider"
2226
2236
  });
2227
2237
  var TextField = BaseField.extend({
2228
2238
  type: import_v43.default.literal(FieldType.TEXT),
@@ -2233,7 +2243,10 @@ var TextField = BaseField.extend({
2233
2243
  prefix: TranslationConfig.optional(),
2234
2244
  postfix: TranslationConfig.optional()
2235
2245
  }).default({ type: "text" }).optional()
2236
- }).describe("Text input");
2246
+ }).meta({
2247
+ description: "A text input field",
2248
+ id: "TextField"
2249
+ });
2237
2250
  var NumberField = BaseField.extend({
2238
2251
  type: import_v43.default.literal(FieldType.NUMBER),
2239
2252
  defaultValue: NumberFieldValue.optional(),
@@ -2243,7 +2256,10 @@ var NumberField = BaseField.extend({
2243
2256
  prefix: TranslationConfig.optional(),
2244
2257
  postfix: TranslationConfig.optional()
2245
2258
  }).optional()
2246
- }).describe("Number input");
2259
+ }).meta({
2260
+ description: "A number input field",
2261
+ id: "NumberField"
2262
+ });
2247
2263
  var TextAreaField = BaseField.extend({
2248
2264
  type: import_v43.default.literal(FieldType.TEXTAREA),
2249
2265
  defaultValue: NonEmptyTextValue.optional(),
@@ -2254,7 +2270,10 @@ var TextAreaField = BaseField.extend({
2254
2270
  prefix: TranslationConfig.optional(),
2255
2271
  postfix: TranslationConfig.optional()
2256
2272
  }).default({ rows: 4 }).optional()
2257
- }).describe("Multiline text input");
2273
+ }).meta({
2274
+ description: "A multiline text input",
2275
+ id: "TextAreaField"
2276
+ });
2258
2277
  var ImageMimeType = import_v43.default.enum([
2259
2278
  "image/png",
2260
2279
  "image/jpg",
@@ -2284,13 +2303,19 @@ var SignatureField = BaseField.extend({
2284
2303
  }).default({
2285
2304
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2286
2305
  })
2287
- }).describe("Signature input field");
2306
+ }).meta({
2307
+ description: "A signature input field",
2308
+ id: "SignatureField"
2309
+ });
2288
2310
  var EmailField = BaseField.extend({
2289
2311
  type: import_v43.default.literal(FieldType.EMAIL),
2290
2312
  configuration: import_v43.default.object({
2291
2313
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
2292
2314
  }).default({ maxLength: 255 }).optional(),
2293
2315
  defaultValue: NonEmptyTextValue.optional()
2316
+ }).meta({
2317
+ description: "An email input field",
2318
+ id: "EmailField"
2294
2319
  });
2295
2320
  var DateField = BaseField.extend({
2296
2321
  type: import_v43.default.literal(FieldType.DATE),
@@ -2300,7 +2325,10 @@ var DateField = BaseField.extend({
2300
2325
  "Text to display above the date input"
2301
2326
  ).optional()
2302
2327
  }).optional()
2303
- }).describe("A single date input (yyyy-MM-dd)");
2328
+ }).meta({
2329
+ description: "A date input (yyyy-MM-dd)",
2330
+ id: "DateField"
2331
+ });
2304
2332
  var AgeField = BaseField.extend({
2305
2333
  type: import_v43.default.literal(FieldType.AGE),
2306
2334
  defaultValue: NumberFieldValue.optional(),
@@ -2309,7 +2337,10 @@ var AgeField = BaseField.extend({
2309
2337
  prefix: TranslationConfig.optional(),
2310
2338
  postfix: TranslationConfig.optional()
2311
2339
  })
2312
- }).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
+ });
2313
2344
  var TimeField = BaseField.extend({
2314
2345
  type: import_v43.default.literal(FieldType.TIME),
2315
2346
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -2319,7 +2350,10 @@ var TimeField = BaseField.extend({
2319
2350
  "Text to display above the time input"
2320
2351
  ).optional()
2321
2352
  }).optional()
2322
- }).describe("A single date input (HH-mm)");
2353
+ }).meta({
2354
+ description: "A single time input (HH-mm)",
2355
+ id: "TimeField"
2356
+ });
2323
2357
  var DateRangeField = BaseField.extend({
2324
2358
  type: import_v43.default.literal(FieldType.DATE_RANGE),
2325
2359
  defaultValue: DateRangeFieldValue.optional(),
@@ -2328,7 +2362,10 @@ var DateRangeField = BaseField.extend({
2328
2362
  "Text to display above the date input"
2329
2363
  ).optional()
2330
2364
  }).optional()
2331
- }).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
+ });
2332
2369
  var HtmlFontVariant = import_v43.default.enum([
2333
2370
  "reg12",
2334
2371
  "reg14",
@@ -2372,18 +2409,30 @@ var ImageViewField = BaseField.extend({
2372
2409
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
2373
2410
  defaultValue: NonEmptyTextValue.optional(),
2374
2411
  configuration: ImageConfiguration
2375
- }).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
+ });
2376
2416
  var Paragraph = BaseField.extend({
2377
2417
  type: import_v43.default.literal(FieldType.PARAGRAPH),
2378
2418
  configuration: ParagraphConfiguration
2379
- }).describe("A read-only HTML <p> paragraph");
2419
+ }).meta({
2420
+ description: "A read-only HTML <p> paragraph",
2421
+ id: "Paragraph"
2422
+ });
2380
2423
  var Heading = BaseField.extend({
2381
2424
  type: import_v43.default.literal(FieldType.HEADING),
2382
2425
  configuration: HeadingConfiguration
2383
- }).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
+ });
2384
2430
  var PageHeader = BaseField.extend({
2385
2431
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
2386
- }).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
+ });
2387
2436
  var File = BaseField.extend({
2388
2437
  type: import_v43.default.literal(FieldType.FILE),
2389
2438
  defaultValue: FileFieldValue.optional(),
@@ -2402,7 +2451,10 @@ var File = BaseField.extend({
2402
2451
  }).default({
2403
2452
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2404
2453
  })
2405
- }).describe("File upload");
2454
+ }).meta({
2455
+ description: "A file upload field",
2456
+ id: "File"
2457
+ });
2406
2458
  var SelectOption = import_v43.default.object({
2407
2459
  value: import_v43.default.string().describe("The value of the option"),
2408
2460
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -2419,7 +2471,10 @@ var NumberWithUnitField = BaseField.extend({
2419
2471
  "Placeholder for the number field"
2420
2472
  )
2421
2473
  }).optional()
2422
- }).describe("Number with unit input");
2474
+ }).meta({
2475
+ description: "A number with unit input field",
2476
+ id: "NumberWithUnitField"
2477
+ });
2423
2478
  var RadioGroup = BaseField.extend({
2424
2479
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
2425
2480
  defaultValue: TextValue.optional(),
@@ -2429,7 +2484,10 @@ var RadioGroup = BaseField.extend({
2429
2484
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
2430
2485
  }).optional()
2431
2486
  }).optional()
2432
- }).describe("Grouped radio options");
2487
+ }).meta({
2488
+ description: "A grouped radio button field",
2489
+ id: "RadioGroup"
2490
+ });
2433
2491
  var BulletList = BaseField.extend({
2434
2492
  type: import_v43.default.literal(FieldType.BULLET_LIST),
2435
2493
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -2438,7 +2496,10 @@ var BulletList = BaseField.extend({
2438
2496
  fontVariant: HtmlFontVariant.optional()
2439
2497
  }).optional()
2440
2498
  }).default({})
2441
- }).describe("A list of bullet points");
2499
+ }).meta({
2500
+ description: "A list of bullet points",
2501
+ id: "BulletList"
2502
+ });
2442
2503
  var Select = BaseField.extend({
2443
2504
  type: import_v43.default.literal(FieldType.SELECT),
2444
2505
  defaultValue: TextValue.optional(),
@@ -2453,7 +2514,10 @@ var Select = BaseField.extend({
2453
2514
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
2454
2515
  `
2455
2516
  )
2456
- }).describe("Select input");
2517
+ }).meta({
2518
+ description: "A select input field",
2519
+ id: "Select"
2520
+ });
2457
2521
  var SelectDateRangeOption = import_v43.default.object({
2458
2522
  value: SelectDateRangeValue.describe("The value of the option"),
2459
2523
  label: TranslationConfig.describe("The label of the option")
@@ -2462,7 +2526,10 @@ var SelectDateRangeField = BaseField.extend({
2462
2526
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
2463
2527
  defaultValue: SelectDateRangeValue.optional(),
2464
2528
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
2465
- }).describe("Select input with date range options");
2529
+ }).meta({
2530
+ description: "A date range selection field",
2531
+ id: "SelectDateRangeField"
2532
+ });
2466
2533
  var NameConfig = import_v43.default.object({
2467
2534
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
2468
2535
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -2493,26 +2560,41 @@ var NameField = BaseField.extend({
2493
2560
  surname: { required: true }
2494
2561
  }
2495
2562
  }).optional()
2496
- }).describe("Name input field");
2563
+ }).meta({
2564
+ description: "A field for entering a persons name",
2565
+ id: "NameField"
2566
+ });
2497
2567
  var PhoneField = BaseField.extend({
2498
2568
  defaultValue: NonEmptyTextValue.optional(),
2499
2569
  type: import_v43.default.literal(FieldType.PHONE)
2500
- }).describe("Phone input field");
2570
+ }).meta({
2571
+ description: "A field for entering a phone number",
2572
+ id: "PhoneField"
2573
+ });
2501
2574
  var IdField = BaseField.extend({
2502
2575
  defaultValue: NonEmptyTextValue.optional(),
2503
2576
  type: import_v43.default.literal(FieldType.ID)
2504
- }).describe("ID input field");
2577
+ }).meta({
2578
+ description: "A field for entering an ID",
2579
+ id: "IdField"
2580
+ });
2505
2581
  var Checkbox = BaseField.extend({
2506
2582
  type: import_v43.default.literal(FieldType.CHECKBOX),
2507
2583
  defaultValue: CheckboxFieldValue.default(false)
2508
- }).describe("Boolean checkbox field");
2584
+ }).meta({
2585
+ description: "A boolean checkbox field",
2586
+ id: "Checkbox"
2587
+ });
2509
2588
  var Country = BaseField.extend({
2510
2589
  type: import_v43.default.literal(FieldType.COUNTRY),
2511
2590
  defaultValue: NonEmptyTextValue.optional(),
2512
2591
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
2513
2592
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
2514
2593
  )
2515
- }).describe("Country select field");
2594
+ }).meta({
2595
+ description: "A field for selecting a country",
2596
+ id: "Country"
2597
+ });
2516
2598
  var AllowedLocations = JurisdictionReference.optional().describe(
2517
2599
  "Limits which location options are selectable depending on user jurisdiction and location."
2518
2600
  );
@@ -2521,16 +2603,18 @@ var AdministrativeAreas = import_v43.default.enum([
2521
2603
  "HEALTH_FACILITY",
2522
2604
  "CRVS_OFFICE"
2523
2605
  ]);
2524
- var AdministrativeAreaConfiguration = import_v43.default.object({
2525
- partOf: FieldReference.optional().describe("Parent location"),
2526
- type: AdministrativeAreas,
2527
- allowedLocations: AllowedLocations
2528
- }).describe("Administrative area options");
2529
2606
  var AdministrativeAreaField = BaseField.extend({
2530
2607
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
2531
2608
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
2532
- configuration: AdministrativeAreaConfiguration
2533
- }).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
+ });
2534
2618
  var LocationInput = BaseField.extend({
2535
2619
  type: import_v43.default.literal(FieldType.LOCATION),
2536
2620
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -2538,7 +2622,10 @@ var LocationInput = BaseField.extend({
2538
2622
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
2539
2623
  allowedLocations: AllowedLocations
2540
2624
  }).optional()
2541
- }).describe("Input field for a location");
2625
+ }).meta({
2626
+ description: "A field for selecting a location",
2627
+ id: "LocationInput"
2628
+ });
2542
2629
  var FileUploadWithOptions = BaseField.extend({
2543
2630
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
2544
2631
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -2552,6 +2639,9 @@ var FileUploadWithOptions = BaseField.extend({
2552
2639
  }).default({
2553
2640
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2554
2641
  })
2642
+ }).meta({
2643
+ description: "A field for uploading files with file type options",
2644
+ id: "FileUploadWithOptions"
2555
2645
  });
2556
2646
  var Facility = BaseField.extend({
2557
2647
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -2597,7 +2687,10 @@ var Address = BaseField.extend({
2597
2687
  allowedLocations: AllowedLocations
2598
2688
  }).optional(),
2599
2689
  defaultValue: DefaultAddressFieldValue.optional()
2600
- }).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
+ });
2601
2694
  var StaticDataEntry = import_v43.default.object({
2602
2695
  id: import_v43.default.string().describe("ID for the data entry."),
2603
2696
  label: TranslationConfig,
@@ -2612,7 +2705,10 @@ var DataField = BaseField.extend({
2612
2705
  subtitle: TranslationConfig.optional(),
2613
2706
  data: import_v43.default.array(DataEntry)
2614
2707
  })
2615
- }).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
+ });
2616
2712
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
2617
2713
  var ButtonType = import_v43.default.enum([
2618
2714
  "primary",
@@ -2639,11 +2735,17 @@ var ButtonField = BaseField.extend({
2639
2735
  type: import_v43.default.literal(FieldType.BUTTON),
2640
2736
  defaultValue: ButtonFieldValue.optional(),
2641
2737
  configuration: ButtonConfiguration
2642
- }).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
+ });
2643
2742
  var FieldGroup = BaseField.extend({
2644
2743
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
2645
2744
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
2646
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"
2647
2749
  });
2648
2750
  var AlphaPrintButton = BaseField.extend({
2649
2751
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -2653,7 +2755,10 @@ var AlphaPrintButton = BaseField.extend({
2653
2755
  "Label for the print button"
2654
2756
  )
2655
2757
  })
2656
- }).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
+ });
2657
2762
  var HttpField = BaseField.extend({
2658
2763
  type: import_v43.default.literal(FieldType.HTTP),
2659
2764
  defaultValue: HttpFieldValue.optional(),
@@ -2669,20 +2774,30 @@ var HttpField = BaseField.extend({
2669
2774
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
2670
2775
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
2671
2776
  })
2672
- }).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
+ });
2673
2781
  var AutocompleteField = BaseField.extend({
2674
2782
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
2675
2783
  configuration: import_v43.default.object({
2676
- 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(),
2677
2787
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
2678
2788
  defaultOptions: import_v43.default.array(
2679
2789
  import_v43.default.object({
2680
2790
  label: import_v43.default.string(),
2681
2791
  value: import_v43.default.string()
2682
2792
  })
2683
- ).optional()
2793
+ ).optional().describe(
2794
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2795
+ )
2684
2796
  })
2685
- }).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
+ });
2686
2801
  var SearchField = HttpField.extend({
2687
2802
  type: import_v43.default.literal(FieldType.SEARCH),
2688
2803
  configuration: SearchQuery.pick({
@@ -2715,6 +2830,9 @@ var SearchField = HttpField.extend({
2715
2830
  ok: TranslationConfig.optional()
2716
2831
  }).optional()
2717
2832
  })
2833
+ }).meta({
2834
+ description: "A search input field",
2835
+ id: "SearchField"
2718
2836
  });
2719
2837
  var LinkButtonField = BaseField.extend({
2720
2838
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -2723,7 +2841,10 @@ var LinkButtonField = BaseField.extend({
2723
2841
  text: TranslationConfig.describe("Text to display on the button"),
2724
2842
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
2725
2843
  })
2726
- }).describe("Button that opens a link");
2844
+ }).meta({
2845
+ description: "A button that opens a URL link",
2846
+ id: "LinkButtonField"
2847
+ });
2727
2848
  var VerificationStatus = BaseField.extend({
2728
2849
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
2729
2850
  defaultValue: VerificationStatusValue.optional(),
@@ -2733,15 +2854,19 @@ var VerificationStatus = BaseField.extend({
2733
2854
  "Explaining text on the banner in form."
2734
2855
  )
2735
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"
2736
2860
  });
2737
2861
  var QueryParamReaderField = BaseField.extend({
2738
2862
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
2739
2863
  configuration: import_v43.default.object({
2740
2864
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
2741
2865
  })
2742
- }).describe(
2743
- "A field that maps URL query params into form values and clears them afterward"
2744
- );
2866
+ }).meta({
2867
+ description: "A field that maps URL query params into form values and clears them afterward",
2868
+ id: "QueryParamReaderField"
2869
+ });
2745
2870
  var QrReaderField = BaseField.extend({
2746
2871
  type: import_v43.default.literal(FieldType.QR_READER),
2747
2872
  defaultValue: QrReaderFieldValue.optional(),
@@ -2752,7 +2877,7 @@ var QrReaderField = BaseField.extend({
2752
2877
  })
2753
2878
  }).optional()
2754
2879
  }).meta({
2755
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2880
+ description: "QR code reader field, including optional JSON Schema validator.",
2756
2881
  id: "QrReaderField"
2757
2882
  });
2758
2883
  var IdReaderField = BaseField.extend({
@@ -2761,12 +2886,18 @@ var IdReaderField = BaseField.extend({
2761
2886
  methods: import_v43.default.array(
2762
2887
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
2763
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"
2764
2892
  });
2765
2893
  var CustomField = BaseField.extend({
2766
2894
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
2767
2895
  defaultValue: CustomFieldValue.optional(),
2768
2896
  src: import_v43.default.string().describe("Module source path for the custom field component"),
2769
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"
2770
2901
  });
2771
2902
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2772
2903
  var LoaderField = BaseField.extend({
@@ -2776,22 +2907,25 @@ var LoaderField = BaseField.extend({
2776
2907
  configuration: import_v43.default.object({
2777
2908
  text: TranslationConfig.describe("Display text above the loading spinner")
2778
2909
  })
2779
- }).describe(
2780
- "A non-interactive field that indicates an in progress operation in form"
2781
- );
2910
+ }).meta({
2911
+ description: "A non-interactive field that indicates an in progress operation in form",
2912
+ id: "LoaderField"
2913
+ });
2782
2914
  var HiddenField = BaseField.extend({
2783
2915
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2784
2916
  required: import_v43.default.boolean().default(false).optional(),
2785
2917
  defaultValue: TextValue.optional()
2786
- }).describe(
2787
- "A non-interactive, hidden field that only hold a value in the form"
2788
- );
2918
+ }).meta({
2919
+ description: "A non-interactive, hidden field that only hold a value in the form",
2920
+ id: "HiddenField"
2921
+ });
2789
2922
  var UserRoleField = BaseField.extend({
2790
2923
  type: import_v43.default.literal(FieldType.USER_ROLE),
2791
2924
  defaultValue: TextValue.optional()
2792
- }).describe(
2793
- "A select dropdown that is automatically populated with available user roles"
2794
- );
2925
+ }).meta({
2926
+ description: "A select dropdown that is automatically populated with available user roles",
2927
+ id: "UserRoleField"
2928
+ });
2795
2929
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2796
2930
  FieldGroup,
2797
2931
  Address,
@@ -2890,16 +3024,19 @@ var VerificationPageConfig = FormPageConfig.extend({
2890
3024
  type: z21.literal(PageTypes.enum.VERIFICATION),
2891
3025
  actions: VerificationActionConfig
2892
3026
  });
2893
- var PageConfig = z21.discriminatedUnion("type", [
2894
- FormPageConfig,
2895
- VerificationPageConfig
2896
- ]);
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
+ });
2897
3031
 
2898
3032
  // ../commons/src/events/FormConfig.ts
2899
3033
  var DeclarationFormConfig = z22.object({
2900
3034
  label: TranslationConfig.describe("Human readable description of the form"),
2901
3035
  pages: z22.array(FormPageConfig)
2902
- }).describe("Configuration of the declaration form.");
3036
+ }).meta({
3037
+ id: "DeclarationFormConfig",
3038
+ description: "Configuration of the declaration form."
3039
+ });
2903
3040
  var ActionFormConfig = z22.object({
2904
3041
  label: TranslationConfig.describe("Human readable description of the form"),
2905
3042
  pages: z22.array(PageConfig)
@@ -2999,6 +3136,9 @@ var DeduplicationConfig = z23.object({
2999
3136
  id: z23.string(),
3000
3137
  label: TranslationConfig,
3001
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."
3002
3142
  });
3003
3143
 
3004
3144
  // ../commons/src/events/ActionConfig.ts
@@ -3116,17 +3256,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
3116
3256
  * OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
3117
3257
  * and treat them as "models" instead of duplicating the data structure in each endpoint.
3118
3258
  */
3119
- ReadActionConfig.meta({ id: "ReadActionConfig" }),
3120
- DeclareConfig.meta({ id: "DeclareActionConfig" }),
3121
- RejectConfig.meta({ id: "RejectActionConfig" }),
3122
- 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
+ }),
3123
3275
  PrintCertificateActionConfig.meta({
3124
- 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."
3125
3290
  }),
3126
- RequestCorrectionConfig.meta({ id: "RequestCorrectionActionConfig" }),
3127
- EditActionConfig.meta({ id: "EditActionConfig" }),
3128
- ArchiveConfig.meta({ id: "ArchiveActionConfig" }),
3129
- 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
+ })
3130
3295
  ]).describe(
3131
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."
3132
3297
  ).meta({ id: "ActionConfig" });
@@ -3202,7 +3367,10 @@ var Field = BaseField2.extend({
3202
3367
  }).describe("Custom field defined for the summary view.");
3203
3368
  var SummaryConfig = z27.object({
3204
3369
  fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
3205
- }).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
+ });
3206
3374
 
3207
3375
  // ../commons/src/events/AdvancedSearchConfig.ts
3208
3376
  var z28 = __toESM(require("zod/v4"));
@@ -3326,6 +3494,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
3326
3494
  var AdvancedSearchConfig = z28.object({
3327
3495
  title: TranslationConfig.describe("Advanced search tab title"),
3328
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()`)."
3329
3500
  });
3330
3501
 
3331
3502
  // ../commons/src/events/utils.ts
@@ -3802,6 +3973,9 @@ function precompileActionSchemas(eventConfigurations) {
3802
3973
  function isAgeValue(value) {
3803
3974
  return typeof value === "object" && value !== null && "age" in value && typeof value.age === "number";
3804
3975
  }
3976
+ function mergeWithBaseFormState(values, context) {
3977
+ return { ...context.baseFormState, ...values };
3978
+ }
3805
3979
  function validate(schema, data) {
3806
3980
  const validator = ajv.getSchema(schema.$id) || ajv.compile(schema);
3807
3981
  if ("$form" in data) {
@@ -3840,7 +4014,7 @@ function isOnline() {
3840
4014
  }
3841
4015
  function isConditionMet(conditional, values, context, eventIndex) {
3842
4016
  return validate(conditional, {
3843
- $form: values,
4017
+ $form: mergeWithBaseFormState(values, context),
3844
4018
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
3845
4019
  $online: isOnline(),
3846
4020
  $user: context.user,
@@ -3869,7 +4043,7 @@ function isFieldConditionMet(field3, form, conditionalType, context) {
3869
4043
  return true;
3870
4044
  }
3871
4045
  const validConditionals = getConditionalActionsForField(field3, {
3872
- $form: form,
4046
+ $form: mergeWithBaseFormState(form, context),
3873
4047
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
3874
4048
  $online: isOnline(),
3875
4049
  $user: context.user,
@@ -4061,7 +4235,7 @@ function runFieldValidations({
4061
4235
  return [];
4062
4236
  }
4063
4237
  const conditionalParameters = {
4064
- $form: form,
4238
+ $form: mergeWithBaseFormState(form, context),
4065
4239
  $now: (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" }),
4066
4240
  /**
4067
4241
  * In real use cases, there can be hundreds of thousands of locations.
@@ -4305,17 +4479,16 @@ function isPageVisible(page, formValues, context) {
4305
4479
  }
4306
4480
  return isConditionMet(page.conditional, formValues, context);
4307
4481
  }
4308
- function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false, declarationContext) {
4482
+ function omitHiddenFields(fields, formValues, validatorContext, includeHiddenFieldsWithNullValues = false) {
4309
4483
  const base = (0, import_lodash.cloneDeep)(formValues);
4310
4484
  function fn(prevVisibilityContext) {
4311
- const visibilityForm = declarationContext ? { ...declarationContext, ...prevVisibilityContext } : prevVisibilityContext;
4312
4485
  const cleaned = (0, import_lodash.omitBy)(base, (value, fieldId) => {
4313
4486
  const fieldConfig = fields.filter((f) => f.id === fieldId);
4314
4487
  if (!fieldConfig.length) {
4315
4488
  return false;
4316
4489
  }
4317
4490
  const isHidden = fieldConfig.every(
4318
- (f) => !isFieldVisible(f, visibilityForm, validatorContext)
4491
+ (f) => !isFieldVisible(f, prevVisibilityContext, validatorContext)
4319
4492
  );
4320
4493
  if (!isHidden) {
4321
4494
  return false;
@@ -4333,7 +4506,7 @@ function omitHiddenPaginatedFields(formConfig, values, validatorContext, include
4333
4506
  const visibleFields = formConfig.pages.filter((p) => isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
4334
4507
  const hiddenFields = formConfig.pages.filter((p) => !isPageVisible(p, values, validatorContext)).flatMap((p) => p.fields);
4335
4508
  const valuesExceptHiddenPage = (0, import_lodash.omitBy)(values, (_2, fieldId) => {
4336
- return hiddenFields.some((f) => f.id === fieldId);
4509
+ return hiddenFields.some((f) => f.id === fieldId) && !visibleFields.some((f) => f.id === fieldId);
4337
4510
  });
4338
4511
  return omitHiddenFields(
4339
4512
  visibleFields,
@@ -4380,13 +4553,10 @@ function getVisibleVerificationPageIds(pages, annotation, context) {
4380
4553
  }
4381
4554
  function omitHiddenAnnotationFields(actionConfig, declaration, annotation, context) {
4382
4555
  const annotationFields = getActionAnnotationFields(actionConfig);
4383
- return omitHiddenFields(
4384
- annotationFields,
4385
- annotation,
4386
- context,
4387
- false,
4388
- declaration
4389
- );
4556
+ return omitHiddenFields(annotationFields, annotation, {
4557
+ ...context,
4558
+ baseFormState: declaration
4559
+ });
4390
4560
  }
4391
4561
  function deepMerge(currentDocument, actionDocument) {
4392
4562
  const currentDocumentClone = (0, import_lodash.cloneDeep)(currentDocument);
@@ -5375,7 +5545,7 @@ var _EventConfigBase = z33.object({
5375
5545
  ),
5376
5546
  label: TranslationConfig.describe("Human-readable label for the event type."),
5377
5547
  actions: z33.array(ActionConfig).describe(
5378
- "Configuration of system-defined actions associated with the event."
5548
+ "Configuration of core and custom actions associated with the event."
5379
5549
  ),
5380
5550
  actionOrder: z33.array(z33.string()).optional().describe(
5381
5551
  "Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
@@ -5387,7 +5557,7 @@ var _EventConfigBase = z33.object({
5387
5557
  "Configuration of fields available in the advanced search feature."
5388
5558
  ),
5389
5559
  flags: z33.array(FlagConfig).optional().default([]).describe(
5390
- "Configuration of flags associated with the actions of this event type."
5560
+ "Configuration of custom flags associated with the actions of this event type."
5391
5561
  ),
5392
5562
  analytics: z33.boolean().optional().default(true).describe(
5393
5563
  "Indicates whether the records of this event type are included in analytics"
@@ -5400,8 +5570,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
5400
5570
  validateActionFlags(event2, ctx);
5401
5571
  validateActionOrder(event2, ctx);
5402
5572
  }).meta({
5403
- id: "EventConfig"
5404
- }).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
+ });
5405
5576
 
5406
5577
  // ../commons/src/events/EventConfigInput.ts
5407
5578
  var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
@@ -5624,6 +5795,9 @@ var WorkqueueColumnValue = z34.object({
5624
5795
  var WorkqueueColumn = z34.object({
5625
5796
  label: TranslationConfig,
5626
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`)."
5627
5801
  });
5628
5802
  function defineWorkqueuesColumns(workqueueColumns) {
5629
5803
  return workqueueColumns.map(
@@ -5826,18 +6000,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
5826
6000
  query: true,
5827
6001
  columns: true
5828
6002
  });
5829
- var WorkqueueConfigInput = z37.object({
5830
- slug: z37.string().describe("Determines the url of the workqueue."),
5831
- name: TranslationConfig.describe(
5832
- "Title of the workflow (both in navigation and on the page)"
5833
- ),
5834
- query: CountryConfigQueryInputType,
5835
- action: z37.object({ type: WorkqueueActionType }).optional().describe(
5836
- "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."
5837
- ),
5838
- columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
5839
- icon: AvailableIcons,
5840
- 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."
5841
6008
  });
5842
6009
  function defineWorkqueue(workqueueInput) {
5843
6010
  const queryInput = workqueueInput.query;
@@ -5898,6 +6065,11 @@ var BaseActionInput = z38.object({
5898
6065
  originalActionId: UUID.optional(),
5899
6066
  // should not be part of base action.
5900
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
+ ),
5901
6073
  // For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
5902
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.
5903
6075
  createdAtLocation: UUID.nullish().describe(
@@ -6077,7 +6249,7 @@ var Draft = z39.object({
6077
6249
  }).describe(
6078
6250
  "A temporary storage for an action. Stored with details of the event, creator and creation time."
6079
6251
  );
6080
- var DraftInput = BaseActionInput.extend({
6252
+ var DraftInput = BaseActionInput.omit({ waitFor: true }).extend({
6081
6253
  type: ActionTypes.exclude([ActionTypes.enum.DELETE]),
6082
6254
  status: z39.enum([
6083
6255
  ActionStatus.Requested,
@@ -6151,7 +6323,6 @@ function getDeclarationActionCreationMetadata(actionType, actions) {
6151
6323
  createdAtLocation: requestAction?.createdAtLocation ?? acceptAction.createdAtLocation,
6152
6324
  acceptedAt: acceptAction.createdAt,
6153
6325
  createdByRole: requestAction?.createdByRole ?? acceptAction.createdByRole,
6154
- createdBySignature: requestAction?.createdBySignature ?? acceptAction.createdBySignature,
6155
6326
  registrationNumber
6156
6327
  };
6157
6328
  }
@@ -6365,17 +6536,6 @@ function getAssignedUserFromActions(actions) {
6365
6536
  return user2;
6366
6537
  }, null);
6367
6538
  }
6368
- function getAssignedUserSignatureFromActions(actions) {
6369
- return actions.reduce((signature, action) => {
6370
- if (action.type === ActionType.ASSIGN) {
6371
- return action.createdBySignature || null;
6372
- }
6373
- if (action.type === ActionType.UNASSIGN) {
6374
- return null;
6375
- }
6376
- return signature;
6377
- }, null);
6378
- }
6379
6539
  function deepDropNulls(obj) {
6380
6540
  if (Array.isArray(obj)) {
6381
6541
  return obj.map(deepDropNulls);
@@ -6471,10 +6631,8 @@ function getCurrentEventState(event2, config) {
6471
6631
  createdBy: creationAction.createdBy,
6472
6632
  createdByUserType: creationAction.createdByUserType,
6473
6633
  createdAtLocation: creationAction.createdAtLocation,
6474
- createdBySignature: creationAction.createdBySignature,
6475
6634
  updatedAt: acceptedActionMetadata.createdAt,
6476
6635
  assignedTo: getAssignedUserFromActions(acceptedActions),
6477
- assignedToSignature: getAssignedUserSignatureFromActions(acceptedActions),
6478
6636
  updatedBy: requestActionMetadata.createdBy,
6479
6637
  updatedAtLocation: requestActionMetadata.createdAtLocation,
6480
6638
  declaration,
@@ -9733,7 +9891,6 @@ var eventQueryDataGenerator = (overrides = {}, seed = 1) => {
9733
9891
  createdBy: overrides.createdBy ?? generateUuid(rng),
9734
9892
  createdAtLocation: overrides.createdAtLocation ?? generateUuid(rng),
9735
9893
  updatedAtLocation: overrides.updatedAtLocation ?? generateUuid(rng),
9736
- createdBySignature: overrides.createdBySignature ?? generateRandomSignature(rng),
9737
9894
  updatedAt: overrides.updatedAt ?? (0, import_date_fns4.addDays)(new Date(createdAt), 1).toISOString(),
9738
9895
  assignedTo: overrides.assignedTo ?? null,
9739
9896
  updatedBy: overrides.updatedBy ?? generateUuid(rng),