@opencrvs/toolkit 2.0.0-rc.c6361e3 → 2.0.0-rc.c71173e

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 (55) 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 +225 -89
  4. package/dist/cli.js +507 -171
  5. package/dist/commons/api/router.d.ts +3389 -258
  6. package/dist/commons/conditionals/conditionals.d.ts +9 -3
  7. package/dist/commons/conditionals/validate.d.ts +1 -0
  8. package/dist/commons/events/ActionDocument.d.ts +6 -0
  9. package/dist/commons/events/ActionInput.d.ts +114 -0
  10. package/dist/commons/events/Draft.d.ts +4 -2
  11. package/dist/commons/events/EventDocument.d.ts +3 -0
  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 +5 -0
  15. package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
  16. package/dist/commons/events/index.d.ts +2 -0
  17. package/dist/commons/events/locations.d.ts +21 -0
  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 +16 -0
  21. package/dist/commons/events/state/index.d.ts +0 -4
  22. package/dist/commons/events/state/utils.d.ts +3 -2
  23. package/dist/commons/events/utils.d.ts +12 -1
  24. package/dist/conditionals/index.js +12 -4
  25. package/dist/events/index.js +813 -177
  26. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
  27. package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +60 -35
  28. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  29. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  30. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -2
  31. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +9 -1
  32. package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -1
  33. package/dist/migrations/v2.0/delete-infrastructure-directory.js +66 -20
  34. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
  35. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
  36. package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
  37. package/dist/migrations/v2.0/index.d.ts +5 -3
  38. package/dist/migrations/v2.0/index.d.ts.map +1 -1
  39. package/dist/migrations/v2.0/index.js +505 -169
  40. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
  41. package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +90 -1
  42. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +11 -1
  43. package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -1
  44. package/dist/migrations/v2.0/merge-infrastructure-directory.js +17 -16
  45. package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
  46. package/dist/migrations/v2.0/migrate-scopes.js +54 -30
  47. package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
  48. package/dist/migrations/v2.0/migrate-workqueue-configs.js +140 -59
  49. package/dist/notification/index.js +661 -122
  50. package/dist/scopes/index.d.ts +6 -1
  51. package/dist/scopes/index.js +8 -4
  52. package/opencrvs-toolkit-2.0.0-rc.c71173e.tgz +0 -0
  53. package/package.json +6 -2
  54. package/tsconfig.tsbuildinfo +1 -1
  55. package/opencrvs-toolkit-2.0.0-rc.c6361e3.tgz +0 -0
@@ -226,12 +226,14 @@ var SystemScopeType = z2.enum([
226
226
  "organisation.read-locations",
227
227
  "user.read",
228
228
  "user.create",
229
- "user.edit"
229
+ "user.edit",
230
+ "user.search"
230
231
  ]);
231
232
  var UserScopeType = SystemScopeType.extract([
232
233
  "user.read",
233
234
  "user.create",
234
- "user.edit"
235
+ "user.edit",
236
+ "user.search"
235
237
  ]);
236
238
  var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
237
239
  var UserScopeV2 = z2.discriminatedUnion("type", [
@@ -240,7 +242,7 @@ var UserScopeV2 = z2.discriminatedUnion("type", [
240
242
  options: AllUserScopeOptions.optional()
241
243
  }),
242
244
  z2.object({
243
- type: UserScopeType.extract(["user.read"]),
245
+ type: UserScopeType.extract(["user.read", "user.search"]),
244
246
  options: AccessLevelOptions.optional()
245
247
  })
246
248
  ]);
@@ -291,7 +293,9 @@ var ScopeType = z2.enum([
291
293
  var EncodedScope = z2.string().brand("EncodedScope");
292
294
  var DEFAULT_SCOPE_OPTIONS = {
293
295
  placeOfEvent: JurisdictionFilter.enum.all,
294
- accessLevel: JurisdictionFilter.enum.all
296
+ accessLevel: JurisdictionFilter.enum.all,
297
+ registeredIn: JurisdictionFilter.enum.all,
298
+ declaredIn: JurisdictionFilter.enum.all
295
299
  };
296
300
 
297
301
  // ../commons/src/authentication.ts
@@ -650,7 +654,10 @@ var ActionConditional = z7.discriminatedUnion("type", [
650
654
  ShowConditional,
651
655
  // Action can be shown to the user in the list but as disabled
652
656
  EnableConditional
653
- ]);
657
+ ]).meta({
658
+ id: "ActionConditional",
659
+ 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."
660
+ });
654
661
  var DisplayOnReviewConditional = z7.object({
655
662
  type: z7.literal(ConditionalType.DISPLAY_ON_REVIEW),
656
663
  conditional: Conditional
@@ -665,8 +672,8 @@ var FieldConditional = z7.discriminatedUnion("type", [
665
672
  // Field output can be shown / hidden on the review page
666
673
  DisplayOnReviewConditional
667
674
  ]).meta({
668
- description: "Field conditional configuration",
669
- id: "FieldConditional"
675
+ id: "FieldConditional",
676
+ 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."
670
677
  });
671
678
 
672
679
  // ../commons/src/events/FieldType.ts
@@ -978,28 +985,20 @@ function schemaPriority(schema) {
978
985
  return idx === -1 ? 9999 : idx;
979
986
  }
980
987
  function safeUnion(schemas) {
988
+ const sortedSchemas = [...schemas].sort(
989
+ (a, b) => schemaPriority(a) - schemaPriority(b)
990
+ );
981
991
  return z12.any().superRefine((val, ctx) => {
982
- const successful = schemas.filter((s) => s.safeParse(val).success);
983
- if (successful.length === 1) {
984
- return;
985
- }
986
- if (successful.length === 0) {
987
- ctx.addIssue({
988
- code: "invalid_type",
989
- expected: "custom",
990
- message: "Value does not match any schema"
991
- });
992
- return;
993
- }
994
- successful.sort((a, b) => schemaPriority(a) - schemaPriority(b));
995
- const best = successful[0];
996
- if (!best.safeParse(val).success) {
997
- ctx.addIssue({
998
- expected: "custom",
999
- code: "invalid_type",
1000
- message: "Value did not match the best schema"
1001
- });
992
+ for (const schema of sortedSchemas) {
993
+ if (schema.safeParse(val).success) {
994
+ return;
995
+ }
1002
996
  }
997
+ ctx.addIssue({
998
+ code: "invalid_type",
999
+ expected: "custom",
1000
+ message: "Value does not match any schema"
1001
+ });
1003
1002
  }).meta({
1004
1003
  description: "Value that matches exactly one of the possible schema types (TextValue, DateValue, DateRangeFieldValue). The best matching schema is chosen by priority."
1005
1004
  });
@@ -1216,8 +1215,9 @@ var RequestedCorrectionAction = ActionBase.extend(
1216
1215
  var ApprovedCorrectionAction = ActionBase.extend(
1217
1216
  z14.object({
1218
1217
  type: z14.literal(ActionType.APPROVE_CORRECTION),
1219
- requestId: z14.string()
1218
+ requestId: z14.string(),
1220
1219
  // TODO move into 'content' property
1220
+ content: z14.object({ immediateCorrection: z14.boolean().optional() }).optional()
1221
1221
  }).shape
1222
1222
  );
1223
1223
  var RejectedCorrectionAction = ActionBase.extend(
@@ -1309,6 +1309,9 @@ var FlagConfig = z15.object({
1309
1309
  "Indicates if this flag expects an action to be performed to be cleared."
1310
1310
  ),
1311
1311
  label: TranslationConfig.describe("Human readable label of the flag.")
1312
+ }).meta({
1313
+ id: "FlagConfig",
1314
+ description: "Configuration for a custom flag that can be added to or removed from records by event actions."
1312
1315
  });
1313
1316
  var ActionFlagConfig = z15.object({
1314
1317
  id: Flag,
@@ -1316,6 +1319,9 @@ var ActionFlagConfig = z15.object({
1316
1319
  conditional: Conditional.optional().describe(
1317
1320
  "When conditional is met, the operation is performed on the flag. If not provided, the operation is performed unconditionally."
1318
1321
  )
1322
+ }).meta({
1323
+ id: "ActionFlagConfig",
1324
+ description: "Add or remove operation applied to a flag when the parent action is accepted. Optionally gated by a conditional."
1319
1325
  });
1320
1326
 
1321
1327
  // ../commons/src/events/EventMetadata.ts
@@ -1337,8 +1343,7 @@ var ActionCreationMetadata = z16.object({
1337
1343
  ),
1338
1344
  createdByUserType: z16.enum(["user", "system"]).nullish().describe("Whether the user is a normal user or a system."),
1339
1345
  acceptedAt: z16.iso.datetime().describe("Timestamp when the action request was accepted."),
1340
- createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation."),
1341
- createdBySignature: z16.string().nullish().describe("Signature of the user who created the action request.")
1346
+ createdByRole: z16.string().optional().describe("Role of the user at the time of action request creation.")
1342
1347
  });
1343
1348
  var RegistrationCreationMetadata = ActionCreationMetadata.extend({
1344
1349
  registrationNumber: z16.string().describe(
@@ -1366,9 +1371,6 @@ var EventMetadata = z16.object({
1366
1371
  createdAtLocation: UUID.nullish().describe(
1367
1372
  "Location of the user who created the event."
1368
1373
  ),
1369
- createdBySignature: DocumentPath.nullish().describe(
1370
- "Signature of the user who created the event."
1371
- ),
1372
1374
  updatedAtLocation: UUID.nullish().describe(
1373
1375
  "Location of the user who last changed the status."
1374
1376
  ),
@@ -1661,14 +1663,21 @@ var FieldId = import_v43.default.string().superRefine((val, ctx) => {
1661
1663
  }
1662
1664
  }).describe("Unique identifier for the field");
1663
1665
  var FieldReference = import_v43.default.object({
1664
- $$field: FieldId,
1666
+ $$field: FieldId.describe("Id of the field to reference"),
1665
1667
  $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
1666
1668
  'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
1667
1669
  )
1668
1670
  }).describe("Reference to a field by its ID");
1669
1671
  var ValidationConfig = import_v43.default.object({
1670
- validator: Conditional,
1671
- message: TranslationConfig
1672
+ validator: Conditional.describe(
1673
+ "Conditional expression that must hold for the field value to be considered valid."
1674
+ ),
1675
+ message: TranslationConfig.describe(
1676
+ "Error message displayed when the validator does not hold."
1677
+ )
1678
+ }).meta({
1679
+ id: "ValidationConfig",
1680
+ 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."
1672
1681
  });
1673
1682
  var requiredSchema = import_v43.default.union([
1674
1683
  import_v43.default.boolean(),
@@ -1707,6 +1716,9 @@ var BaseField = import_v43.default.object({
1707
1716
  }).describe("Common properties shared across all field types.");
1708
1717
  var Divider = BaseField.extend({
1709
1718
  type: import_v43.default.literal(FieldType.DIVIDER)
1719
+ }).meta({
1720
+ description: "A horizontal line divider",
1721
+ id: "Divider"
1710
1722
  });
1711
1723
  var TextField = BaseField.extend({
1712
1724
  type: import_v43.default.literal(FieldType.TEXT),
@@ -1717,7 +1729,10 @@ var TextField = BaseField.extend({
1717
1729
  prefix: TranslationConfig.optional(),
1718
1730
  postfix: TranslationConfig.optional()
1719
1731
  }).default({ type: "text" }).optional()
1720
- }).describe("Text input");
1732
+ }).meta({
1733
+ description: "A text input field",
1734
+ id: "TextField"
1735
+ });
1721
1736
  var NumberField = BaseField.extend({
1722
1737
  type: import_v43.default.literal(FieldType.NUMBER),
1723
1738
  defaultValue: NumberFieldValue.optional(),
@@ -1727,7 +1742,10 @@ var NumberField = BaseField.extend({
1727
1742
  prefix: TranslationConfig.optional(),
1728
1743
  postfix: TranslationConfig.optional()
1729
1744
  }).optional()
1730
- }).describe("Number input");
1745
+ }).meta({
1746
+ description: "A number input field",
1747
+ id: "NumberField"
1748
+ });
1731
1749
  var TextAreaField = BaseField.extend({
1732
1750
  type: import_v43.default.literal(FieldType.TEXTAREA),
1733
1751
  defaultValue: NonEmptyTextValue.optional(),
@@ -1738,7 +1756,10 @@ var TextAreaField = BaseField.extend({
1738
1756
  prefix: TranslationConfig.optional(),
1739
1757
  postfix: TranslationConfig.optional()
1740
1758
  }).default({ rows: 4 }).optional()
1741
- }).describe("Multiline text input");
1759
+ }).meta({
1760
+ description: "A multiline text input",
1761
+ id: "TextAreaField"
1762
+ });
1742
1763
  var ImageMimeType = import_v43.default.enum([
1743
1764
  "image/png",
1744
1765
  "image/jpg",
@@ -1768,13 +1789,19 @@ var SignatureField = BaseField.extend({
1768
1789
  }).default({
1769
1790
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1770
1791
  })
1771
- }).describe("Signature input field");
1792
+ }).meta({
1793
+ description: "A signature input field",
1794
+ id: "SignatureField"
1795
+ });
1772
1796
  var EmailField = BaseField.extend({
1773
1797
  type: import_v43.default.literal(FieldType.EMAIL),
1774
1798
  configuration: import_v43.default.object({
1775
1799
  maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
1776
1800
  }).default({ maxLength: 255 }).optional(),
1777
1801
  defaultValue: NonEmptyTextValue.optional()
1802
+ }).meta({
1803
+ description: "An email input field",
1804
+ id: "EmailField"
1778
1805
  });
1779
1806
  var DateField = BaseField.extend({
1780
1807
  type: import_v43.default.literal(FieldType.DATE),
@@ -1784,7 +1811,10 @@ var DateField = BaseField.extend({
1784
1811
  "Text to display above the date input"
1785
1812
  ).optional()
1786
1813
  }).optional()
1787
- }).describe("A single date input (yyyy-MM-dd)");
1814
+ }).meta({
1815
+ description: "A date input (yyyy-MM-dd)",
1816
+ id: "DateField"
1817
+ });
1788
1818
  var AgeField = BaseField.extend({
1789
1819
  type: import_v43.default.literal(FieldType.AGE),
1790
1820
  defaultValue: NumberFieldValue.optional(),
@@ -1793,7 +1823,10 @@ var AgeField = BaseField.extend({
1793
1823
  prefix: TranslationConfig.optional(),
1794
1824
  postfix: TranslationConfig.optional()
1795
1825
  })
1796
- }).describe("An age input field which uses the current date as the asOfDate");
1826
+ }).meta({
1827
+ description: "An age input field which uses the current date as the asOfDate",
1828
+ id: "AgeField"
1829
+ });
1797
1830
  var TimeField = BaseField.extend({
1798
1831
  type: import_v43.default.literal(FieldType.TIME),
1799
1832
  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
@@ -1803,7 +1836,10 @@ var TimeField = BaseField.extend({
1803
1836
  "Text to display above the time input"
1804
1837
  ).optional()
1805
1838
  }).optional()
1806
- }).describe("A single date input (HH-mm)");
1839
+ }).meta({
1840
+ description: "A single time input (HH-mm)",
1841
+ id: "TimeField"
1842
+ });
1807
1843
  var DateRangeField = BaseField.extend({
1808
1844
  type: import_v43.default.literal(FieldType.DATE_RANGE),
1809
1845
  defaultValue: DateRangeFieldValue.optional(),
@@ -1812,7 +1848,10 @@ var DateRangeField = BaseField.extend({
1812
1848
  "Text to display above the date input"
1813
1849
  ).optional()
1814
1850
  }).optional()
1815
- }).describe("A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })");
1851
+ }).meta({
1852
+ description: "A date range input ({ start: yyyy-MM-dd, end: yyyy-MM-dd })",
1853
+ id: "DateRangeField"
1854
+ });
1816
1855
  var HtmlFontVariant = import_v43.default.enum([
1817
1856
  "reg12",
1818
1857
  "reg14",
@@ -1856,18 +1895,30 @@ var ImageViewField = BaseField.extend({
1856
1895
  type: import_v43.default.literal(FieldType.IMAGE_VIEW),
1857
1896
  defaultValue: NonEmptyTextValue.optional(),
1858
1897
  configuration: ImageConfiguration
1859
- }).describe("A read-only image component for form pages");
1898
+ }).meta({
1899
+ description: "A read-only image component for form pages",
1900
+ id: "ImageViewField"
1901
+ });
1860
1902
  var Paragraph = BaseField.extend({
1861
1903
  type: import_v43.default.literal(FieldType.PARAGRAPH),
1862
1904
  configuration: ParagraphConfiguration
1863
- }).describe("A read-only HTML <p> paragraph");
1905
+ }).meta({
1906
+ description: "A read-only HTML <p> paragraph",
1907
+ id: "Paragraph"
1908
+ });
1864
1909
  var Heading = BaseField.extend({
1865
1910
  type: import_v43.default.literal(FieldType.HEADING),
1866
1911
  configuration: HeadingConfiguration
1867
- }).describe("A read-only heading component for form pages");
1912
+ }).meta({
1913
+ description: "A read-only heading component for form pages",
1914
+ id: "Heading"
1915
+ });
1868
1916
  var PageHeader = BaseField.extend({
1869
1917
  type: import_v43.default.literal(FieldType.PAGE_HEADER)
1870
- }).describe("A read-only header component for form pages");
1918
+ }).meta({
1919
+ description: "A read-only header component for form pages",
1920
+ id: "PageHeader"
1921
+ });
1871
1922
  var File = BaseField.extend({
1872
1923
  type: import_v43.default.literal(FieldType.FILE),
1873
1924
  defaultValue: FileFieldValue.optional(),
@@ -1886,7 +1937,10 @@ var File = BaseField.extend({
1886
1937
  }).default({
1887
1938
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
1888
1939
  })
1889
- }).describe("File upload");
1940
+ }).meta({
1941
+ description: "A file upload field",
1942
+ id: "File"
1943
+ });
1890
1944
  var SelectOption = import_v43.default.object({
1891
1945
  value: import_v43.default.string().describe("The value of the option"),
1892
1946
  label: import_v43.default.union([import_v43.default.string(), TranslationConfig]).describe("The label of the option"),
@@ -1903,7 +1957,10 @@ var NumberWithUnitField = BaseField.extend({
1903
1957
  "Placeholder for the number field"
1904
1958
  )
1905
1959
  }).optional()
1906
- }).describe("Number with unit input");
1960
+ }).meta({
1961
+ description: "A number with unit input field",
1962
+ id: "NumberWithUnitField"
1963
+ });
1907
1964
  var RadioGroup = BaseField.extend({
1908
1965
  type: import_v43.default.literal(FieldType.RADIO_GROUP),
1909
1966
  defaultValue: TextValue.optional(),
@@ -1913,7 +1970,10 @@ var RadioGroup = BaseField.extend({
1913
1970
  size: import_v43.default.enum(["NORMAL", "LARGE"]).optional()
1914
1971
  }).optional()
1915
1972
  }).optional()
1916
- }).describe("Grouped radio options");
1973
+ }).meta({
1974
+ description: "A grouped radio button field",
1975
+ id: "RadioGroup"
1976
+ });
1917
1977
  var BulletList = BaseField.extend({
1918
1978
  type: import_v43.default.literal(FieldType.BULLET_LIST),
1919
1979
  items: import_v43.default.array(TranslationConfig).describe("A list of items"),
@@ -1922,7 +1982,10 @@ var BulletList = BaseField.extend({
1922
1982
  fontVariant: HtmlFontVariant.optional()
1923
1983
  }).optional()
1924
1984
  }).default({})
1925
- }).describe("A list of bullet points");
1985
+ }).meta({
1986
+ description: "A list of bullet points",
1987
+ id: "BulletList"
1988
+ });
1926
1989
  var Select = BaseField.extend({
1927
1990
  type: import_v43.default.literal(FieldType.SELECT),
1928
1991
  defaultValue: TextValue.optional(),
@@ -1937,7 +2000,10 @@ var Select = BaseField.extend({
1937
2000
  { ..., defaultMessage: "'{input}' is not listed among the health facilities." }
1938
2001
  `
1939
2002
  )
1940
- }).describe("Select input");
2003
+ }).meta({
2004
+ description: "A select input field",
2005
+ id: "Select"
2006
+ });
1941
2007
  var SelectDateRangeOption = import_v43.default.object({
1942
2008
  value: SelectDateRangeValue.describe("The value of the option"),
1943
2009
  label: TranslationConfig.describe("The label of the option")
@@ -1946,7 +2012,10 @@ var SelectDateRangeField = BaseField.extend({
1946
2012
  type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
1947
2013
  defaultValue: SelectDateRangeValue.optional(),
1948
2014
  options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
1949
- }).describe("Select input with date range options");
2015
+ }).meta({
2016
+ description: "A date range selection field",
2017
+ id: "SelectDateRangeField"
2018
+ });
1950
2019
  var NameConfig = import_v43.default.object({
1951
2020
  firstname: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
1952
2021
  middlename: import_v43.default.object({ required: requiredSchema, label: TranslationConfig.optional() }).optional(),
@@ -1977,26 +2046,41 @@ var NameField = BaseField.extend({
1977
2046
  surname: { required: true }
1978
2047
  }
1979
2048
  }).optional()
1980
- }).describe("Name input field");
2049
+ }).meta({
2050
+ description: "A field for entering a persons name",
2051
+ id: "NameField"
2052
+ });
1981
2053
  var PhoneField = BaseField.extend({
1982
2054
  defaultValue: NonEmptyTextValue.optional(),
1983
2055
  type: import_v43.default.literal(FieldType.PHONE)
1984
- }).describe("Phone input field");
2056
+ }).meta({
2057
+ description: "A field for entering a phone number",
2058
+ id: "PhoneField"
2059
+ });
1985
2060
  var IdField = BaseField.extend({
1986
2061
  defaultValue: NonEmptyTextValue.optional(),
1987
2062
  type: import_v43.default.literal(FieldType.ID)
1988
- }).describe("ID input field");
2063
+ }).meta({
2064
+ description: "A field for entering an ID",
2065
+ id: "IdField"
2066
+ });
1989
2067
  var Checkbox = BaseField.extend({
1990
2068
  type: import_v43.default.literal(FieldType.CHECKBOX),
1991
2069
  defaultValue: CheckboxFieldValue.default(false)
1992
- }).describe("Boolean checkbox field");
2070
+ }).meta({
2071
+ description: "A boolean checkbox field",
2072
+ id: "Checkbox"
2073
+ });
1993
2074
  var Country = BaseField.extend({
1994
2075
  type: import_v43.default.literal(FieldType.COUNTRY),
1995
2076
  defaultValue: NonEmptyTextValue.optional(),
1996
2077
  optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
1997
2078
  "Conditionals for specific countries. Countries not listed are always shown and enabled."
1998
2079
  )
1999
- }).describe("Country select field");
2080
+ }).meta({
2081
+ description: "A field for selecting a country",
2082
+ id: "Country"
2083
+ });
2000
2084
  var AllowedLocations = JurisdictionReference.optional().describe(
2001
2085
  "Limits which location options are selectable depending on user jurisdiction and location."
2002
2086
  );
@@ -2005,16 +2089,18 @@ var AdministrativeAreas = import_v43.default.enum([
2005
2089
  "HEALTH_FACILITY",
2006
2090
  "CRVS_OFFICE"
2007
2091
  ]);
2008
- var AdministrativeAreaConfiguration = import_v43.default.object({
2009
- partOf: FieldReference.optional().describe("Parent location"),
2010
- type: AdministrativeAreas,
2011
- allowedLocations: AllowedLocations
2012
- }).describe("Administrative area options");
2013
2092
  var AdministrativeAreaField = BaseField.extend({
2014
2093
  type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
2015
2094
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
2016
- configuration: AdministrativeAreaConfiguration
2017
- }).describe("Administrative area input field e.g. facility, office");
2095
+ configuration: import_v43.default.object({
2096
+ partOf: FieldReference.optional().describe("Parent location"),
2097
+ type: AdministrativeAreas,
2098
+ allowedLocations: AllowedLocations
2099
+ }).describe("Administrative area options")
2100
+ }).meta({
2101
+ description: "Administrative area input field",
2102
+ id: "AdministrativeAreaField"
2103
+ });
2018
2104
  var LocationInput = BaseField.extend({
2019
2105
  type: import_v43.default.literal(FieldType.LOCATION),
2020
2106
  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
@@ -2022,7 +2108,10 @@ var LocationInput = BaseField.extend({
2022
2108
  locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
2023
2109
  allowedLocations: AllowedLocations
2024
2110
  }).optional()
2025
- }).describe("Input field for a location");
2111
+ }).meta({
2112
+ description: "A field for selecting a location",
2113
+ id: "LocationInput"
2114
+ });
2026
2115
  var FileUploadWithOptions = BaseField.extend({
2027
2116
  type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
2028
2117
  options: import_v43.default.array(SelectOption).describe("A list of options"),
@@ -2036,6 +2125,9 @@ var FileUploadWithOptions = BaseField.extend({
2036
2125
  }).default({
2037
2126
  maxFileSize: DEFAULT_MAX_FILE_SIZE_BYTES
2038
2127
  })
2128
+ }).meta({
2129
+ description: "A field for uploading files with file type options",
2130
+ id: "FileUploadWithOptions"
2039
2131
  });
2040
2132
  var Facility = BaseField.extend({
2041
2133
  type: import_v43.default.literal(FieldType.FACILITY),
@@ -2081,7 +2173,10 @@ var Address = BaseField.extend({
2081
2173
  allowedLocations: AllowedLocations
2082
2174
  }).optional(),
2083
2175
  defaultValue: DefaultAddressFieldValue.optional()
2084
- }).describe("Address input field \u2013 a combination of location and text fields");
2176
+ }).meta({
2177
+ description: "Address input field \u2013 a combination of location and text fields",
2178
+ id: "Address"
2179
+ });
2085
2180
  var StaticDataEntry = import_v43.default.object({
2086
2181
  id: import_v43.default.string().describe("ID for the data entry."),
2087
2182
  label: TranslationConfig,
@@ -2096,7 +2191,10 @@ var DataField = BaseField.extend({
2096
2191
  subtitle: TranslationConfig.optional(),
2097
2192
  data: import_v43.default.array(DataEntry)
2098
2193
  })
2099
- }).describe("Data field for displaying read-only data");
2194
+ }).meta({
2195
+ description: "A field for displaying a table of read-only data",
2196
+ id: "DataField"
2197
+ });
2100
2198
  var ButtonSize = import_v43.default.enum(["small", "medium", "large"]);
2101
2199
  var ButtonType = import_v43.default.enum([
2102
2200
  "primary",
@@ -2123,11 +2221,17 @@ var ButtonField = BaseField.extend({
2123
2221
  type: import_v43.default.literal(FieldType.BUTTON),
2124
2222
  defaultValue: ButtonFieldValue.optional(),
2125
2223
  configuration: ButtonConfiguration
2126
- }).describe("Generic button without any built-in functionality");
2224
+ }).meta({
2225
+ description: "A generic button that can be used to trigger an action",
2226
+ id: "ButtonField"
2227
+ });
2127
2228
  var FieldGroup = BaseField.extend({
2128
2229
  type: import_v43.default.literal(FieldType.FIELD_GROUP),
2129
2230
  // eslint-disable-next-line @typescript-eslint/no-use-before-define
2130
2231
  fields: import_v43.default.lazy(() => import_v43.default.array(FieldConfig))
2232
+ }).meta({
2233
+ description: "A group of fields that are displayed together",
2234
+ id: "FieldGroup"
2131
2235
  });
2132
2236
  var AlphaPrintButton = BaseField.extend({
2133
2237
  type: import_v43.default.literal(FieldType.ALPHA_PRINT_BUTTON),
@@ -2137,7 +2241,10 @@ var AlphaPrintButton = BaseField.extend({
2137
2241
  "Label for the print button"
2138
2242
  )
2139
2243
  })
2140
- }).describe("Print button field for printing certificates");
2244
+ }).meta({
2245
+ description: "An experimental print button field for printing certificates during the declaration process",
2246
+ id: "AlphaPrintButton"
2247
+ });
2141
2248
  var HttpField = BaseField.extend({
2142
2249
  type: import_v43.default.literal(FieldType.HTTP),
2143
2250
  defaultValue: HttpFieldValue.optional(),
@@ -2153,20 +2260,30 @@ var HttpField = BaseField.extend({
2153
2260
  params: import_v43.default.record(import_v43.default.string(), import_v43.default.union([import_v43.default.string(), FieldReference])).optional(),
2154
2261
  timeout: import_v43.default.number().default(15e3).describe("Request timeout in milliseconds")
2155
2262
  })
2156
- }).describe("HTTP request function triggered by a button click or other event");
2263
+ }).meta({
2264
+ 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.",
2265
+ id: "HttpField"
2266
+ });
2157
2267
  var AutocompleteField = BaseField.extend({
2158
2268
  type: import_v43.default.literal(FieldType.AUTOCOMPLETE),
2159
2269
  configuration: import_v43.default.object({
2160
- url: import_v43.default.string().describe("URL to fetch autocomplete suggestions from").optional(),
2270
+ url: import_v43.default.string().describe(
2271
+ "URL to fetch autocomplete suggestions from. This should be a country config server endpoint."
2272
+ ).optional(),
2161
2273
  method: import_v43.default.enum(["GET", "POST"]).default("GET").optional(),
2162
2274
  defaultOptions: import_v43.default.array(
2163
2275
  import_v43.default.object({
2164
2276
  label: import_v43.default.string(),
2165
2277
  value: import_v43.default.string()
2166
2278
  })
2167
- ).optional()
2279
+ ).optional().describe(
2280
+ "Manual entry is supported through configuration, allowing users to provide values not currently represented in the dataset."
2281
+ )
2168
2282
  })
2169
- }).describe("Autocomplete input field");
2283
+ }).meta({
2284
+ 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.",
2285
+ id: "AutocompleteField"
2286
+ });
2170
2287
  var SearchField = HttpField.extend({
2171
2288
  type: import_v43.default.literal(FieldType.SEARCH),
2172
2289
  configuration: SearchQuery.pick({
@@ -2199,6 +2316,9 @@ var SearchField = HttpField.extend({
2199
2316
  ok: TranslationConfig.optional()
2200
2317
  }).optional()
2201
2318
  })
2319
+ }).meta({
2320
+ description: "A search input field",
2321
+ id: "SearchField"
2202
2322
  });
2203
2323
  var LinkButtonField = BaseField.extend({
2204
2324
  type: import_v43.default.literal(FieldType.LINK_BUTTON),
@@ -2207,7 +2327,10 @@ var LinkButtonField = BaseField.extend({
2207
2327
  text: TranslationConfig.describe("Text to display on the button"),
2208
2328
  icon: import_v43.default.string().optional().describe("Icon for the button. You can find icons from OpenCRVS UI-Kit.")
2209
2329
  })
2210
- }).describe("Button that opens a link");
2330
+ }).meta({
2331
+ description: "A button that opens a URL link",
2332
+ id: "LinkButtonField"
2333
+ });
2211
2334
  var VerificationStatus = BaseField.extend({
2212
2335
  type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
2213
2336
  defaultValue: VerificationStatusValue.optional(),
@@ -2217,15 +2340,19 @@ var VerificationStatus = BaseField.extend({
2217
2340
  "Explaining text on the banner in form."
2218
2341
  )
2219
2342
  })
2343
+ }).meta({
2344
+ 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.",
2345
+ id: "VerificationStatus"
2220
2346
  });
2221
2347
  var QueryParamReaderField = BaseField.extend({
2222
2348
  type: import_v43.default.literal(FieldType.QUERY_PARAM_READER),
2223
2349
  configuration: import_v43.default.object({
2224
2350
  pickParams: import_v43.default.array(import_v43.default.string()).describe("List of query parameters to read from the URL")
2225
2351
  })
2226
- }).describe(
2227
- "A field that maps URL query params into form values and clears them afterward"
2228
- );
2352
+ }).meta({
2353
+ description: "A field that maps URL query params into form values and clears them afterward",
2354
+ id: "QueryParamReaderField"
2355
+ });
2229
2356
  var QrReaderField = BaseField.extend({
2230
2357
  type: import_v43.default.literal(FieldType.QR_READER),
2231
2358
  defaultValue: QrReaderFieldValue.optional(),
@@ -2236,7 +2363,7 @@ var QrReaderField = BaseField.extend({
2236
2363
  })
2237
2364
  }).optional()
2238
2365
  }).meta({
2239
- description: "Configuration for QR code reader field, including optional JSON Schema validator.",
2366
+ description: "QR code reader field, including optional JSON Schema validator.",
2240
2367
  id: "QrReaderField"
2241
2368
  });
2242
2369
  var IdReaderField = BaseField.extend({
@@ -2245,12 +2372,18 @@ var IdReaderField = BaseField.extend({
2245
2372
  methods: import_v43.default.array(
2246
2373
  import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
2247
2374
  )
2375
+ }).meta({
2376
+ description: "A wrapper around nested form fields, specifically QR_READER and LINK_BUTTON. It can hold the QR_READERs value.",
2377
+ id: "IdReaderField"
2248
2378
  });
2249
2379
  var CustomField = BaseField.extend({
2250
2380
  type: import_v43.default.literal(FieldType._EXPERIMENTAL_CUSTOM),
2251
2381
  defaultValue: CustomFieldValue.optional(),
2252
2382
  src: import_v43.default.string().describe("Module source path for the custom field component"),
2253
2383
  configuration: import_v43.default.unknown().optional()
2384
+ }).meta({
2385
+ description: "An expiremental custom field that is defined by a module source path",
2386
+ id: "CustomField"
2254
2387
  });
2255
2388
  var FieldStyleVariant = import_v43.default.enum(["default", "highlighted"]);
2256
2389
  var LoaderField = BaseField.extend({
@@ -2260,22 +2393,25 @@ var LoaderField = BaseField.extend({
2260
2393
  configuration: import_v43.default.object({
2261
2394
  text: TranslationConfig.describe("Display text above the loading spinner")
2262
2395
  })
2263
- }).describe(
2264
- "A non-interactive field that indicates an in progress operation in form"
2265
- );
2396
+ }).meta({
2397
+ description: "A non-interactive field that indicates an in progress operation in form",
2398
+ id: "LoaderField"
2399
+ });
2266
2400
  var HiddenField = BaseField.extend({
2267
2401
  type: import_v43.default.literal(FieldType.ALPHA_HIDDEN),
2268
2402
  required: import_v43.default.boolean().default(false).optional(),
2269
2403
  defaultValue: TextValue.optional()
2270
- }).describe(
2271
- "A non-interactive, hidden field that only hold a value in the form"
2272
- );
2404
+ }).meta({
2405
+ description: "A non-interactive, hidden field that only hold a value in the form",
2406
+ id: "HiddenField"
2407
+ });
2273
2408
  var UserRoleField = BaseField.extend({
2274
2409
  type: import_v43.default.literal(FieldType.USER_ROLE),
2275
2410
  defaultValue: TextValue.optional()
2276
- }).describe(
2277
- "A select dropdown that is automatically populated with available user roles"
2278
- );
2411
+ }).meta({
2412
+ description: "A select dropdown that is automatically populated with available user roles",
2413
+ id: "UserRoleField"
2414
+ });
2279
2415
  var FieldConfig = import_v43.default.discriminatedUnion("type", [
2280
2416
  FieldGroup,
2281
2417
  Address,
@@ -2374,16 +2510,19 @@ var VerificationPageConfig = FormPageConfig.extend({
2374
2510
  type: z21.literal(PageTypes.enum.VERIFICATION),
2375
2511
  actions: VerificationActionConfig
2376
2512
  });
2377
- var PageConfig = z21.discriminatedUnion("type", [
2378
- FormPageConfig,
2379
- VerificationPageConfig
2380
- ]);
2513
+ var PageConfig = z21.discriminatedUnion("type", [FormPageConfig, VerificationPageConfig]).meta({
2514
+ id: "PageConfig",
2515
+ 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."
2516
+ });
2381
2517
 
2382
2518
  // ../commons/src/events/FormConfig.ts
2383
2519
  var DeclarationFormConfig = z22.object({
2384
2520
  label: TranslationConfig.describe("Human readable description of the form"),
2385
2521
  pages: z22.array(FormPageConfig)
2386
- }).describe("Configuration of the declaration form.");
2522
+ }).meta({
2523
+ id: "DeclarationFormConfig",
2524
+ description: "Configuration of the declaration form."
2525
+ });
2387
2526
  var ActionFormConfig = z22.object({
2388
2527
  label: TranslationConfig.describe("Human readable description of the form"),
2389
2528
  pages: z22.array(PageConfig)
@@ -2483,6 +2622,9 @@ var DeduplicationConfig = z23.object({
2483
2622
  id: z23.string(),
2484
2623
  label: TranslationConfig,
2485
2624
  query: Clause
2625
+ }).meta({
2626
+ id: "DeduplicationConfig",
2627
+ 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."
2486
2628
  });
2487
2629
 
2488
2630
  // ../commons/src/events/ActionConfig.ts
@@ -2600,17 +2742,42 @@ var ActionConfig = z24.discriminatedUnion("type", [
2600
2742
  * OpenAPI references are defined here so our generated OpenAPI spec knows to reuse the models
2601
2743
  * and treat them as "models" instead of duplicating the data structure in each endpoint.
2602
2744
  */
2603
- ReadActionConfig.meta({ id: "ReadActionConfig" }),
2604
- DeclareConfig.meta({ id: "DeclareActionConfig" }),
2605
- RejectConfig.meta({ id: "RejectActionConfig" }),
2606
- RegisterConfig.meta({ id: "RegisterActionConfig" }),
2745
+ ReadActionConfig.meta({
2746
+ id: "ReadActionConfig",
2747
+ description: "Configuration for the read action \u2014 defines the record-tab content displayed on the event overview page."
2748
+ }),
2749
+ DeclareConfig.meta({
2750
+ id: "DeclareActionConfig",
2751
+ description: "Configuration for the declare action. Includes review-page fields. Shared with the notify action (ActionType.NOTIFY)."
2752
+ }),
2753
+ RejectConfig.meta({
2754
+ id: "RejectActionConfig",
2755
+ description: "Configuration for rejecting a record before registration."
2756
+ }),
2757
+ RegisterConfig.meta({
2758
+ id: "RegisterActionConfig",
2759
+ description: "Configuration for registering a record."
2760
+ }),
2607
2761
  PrintCertificateActionConfig.meta({
2608
- id: "PrintCertificateActionConfig"
2762
+ id: "PrintCertificateActionConfig",
2763
+ description: "Configuration for printing a certificate of a registered record."
2764
+ }),
2765
+ RequestCorrectionConfig.meta({
2766
+ id: "RequestCorrectionActionConfig",
2767
+ description: "Configuration for requesting a correction on a registered record."
2768
+ }),
2769
+ EditActionConfig.meta({
2770
+ id: "EditActionConfig",
2771
+ description: "Configuration for editing a record before registration."
2772
+ }),
2773
+ ArchiveConfig.meta({
2774
+ id: "ArchiveActionConfig",
2775
+ description: "Configuration for archiving a record."
2609
2776
  }),
2610
- RequestCorrectionConfig.meta({ id: "RequestCorrectionActionConfig" }),
2611
- EditActionConfig.meta({ id: "EditActionConfig" }),
2612
- ArchiveConfig.meta({ id: "ArchiveActionConfig" }),
2613
- CustomActionConfig.meta({ id: "CustomActionConfig" })
2777
+ CustomActionConfig.meta({
2778
+ id: "CustomActionConfig",
2779
+ description: "Configuration for a country-defined custom action. An event may include any number of these."
2780
+ })
2614
2781
  ]).describe(
2615
2782
  "Configuration of an action available for an event. Data collected depends on the action type and is accessible through the annotation property in ActionDocument."
2616
2783
  ).meta({ id: "ActionConfig" });
@@ -2686,7 +2853,10 @@ var Field = BaseField2.extend({
2686
2853
  }).describe("Custom field defined for the summary view.");
2687
2854
  var SummaryConfig = z27.object({
2688
2855
  fields: z27.array(z27.union([Field, ReferenceField])).describe("Fields displayed in the event summary view.")
2689
- }).describe("Configuration of the event summary section.");
2856
+ }).meta({
2857
+ id: "SummaryConfig",
2858
+ 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."
2859
+ });
2690
2860
 
2691
2861
  // ../commons/src/events/AdvancedSearchConfig.ts
2692
2862
  var z28 = __toESM(require("zod/v4"));
@@ -2810,6 +2980,9 @@ var AdvancedSearchField = z28.discriminatedUnion("fieldType", [FieldConfigSchema
2810
2980
  var AdvancedSearchConfig = z28.object({
2811
2981
  title: TranslationConfig.describe("Advanced search tab title"),
2812
2982
  fields: z28.array(AdvancedSearchField).describe("Advanced search fields within the tab.")
2983
+ }).meta({
2984
+ id: "AdvancedSearchConfig",
2985
+ 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()`)."
2813
2986
  });
2814
2987
 
2815
2988
  // ../commons/src/events/utils.ts
@@ -3677,7 +3850,7 @@ var _EventConfigBase = z33.object({
3677
3850
  ),
3678
3851
  label: TranslationConfig.describe("Human-readable label for the event type."),
3679
3852
  actions: z33.array(ActionConfig).describe(
3680
- "Configuration of system-defined actions associated with the event."
3853
+ "Configuration of core and custom actions associated with the event."
3681
3854
  ),
3682
3855
  actionOrder: z33.array(z33.string()).optional().describe(
3683
3856
  "Order of actions in the action menu. Use either the action type for core actions or the customActionType for custom actions."
@@ -3689,7 +3862,7 @@ var _EventConfigBase = z33.object({
3689
3862
  "Configuration of fields available in the advanced search feature."
3690
3863
  ),
3691
3864
  flags: z33.array(FlagConfig).optional().default([]).describe(
3692
- "Configuration of flags associated with the actions of this event type."
3865
+ "Configuration of custom flags associated with the actions of this event type."
3693
3866
  ),
3694
3867
  analytics: z33.boolean().optional().default(true).describe(
3695
3868
  "Indicates whether the records of this event type are included in analytics"
@@ -3702,8 +3875,9 @@ var EventConfig = _EventConfigBase.superRefine((event2, ctx) => {
3702
3875
  validateActionFlags(event2, ctx);
3703
3876
  validateActionOrder(event2, ctx);
3704
3877
  }).meta({
3705
- id: "EventConfig"
3706
- }).describe("Configuration defining an event type.");
3878
+ id: "EventConfig",
3879
+ description: "Configuration defining an event type registered in OpenCRVS (for example birth or death)."
3880
+ });
3707
3881
 
3708
3882
  // ../commons/src/events/EventConfigInput.ts
3709
3883
  var defineDeclarationForm = (form) => DeclarationFormConfig.parse(form);
@@ -3925,6 +4099,9 @@ var WorkqueueColumnValue = z34.object({
3925
4099
  var WorkqueueColumn = z34.object({
3926
4100
  label: TranslationConfig,
3927
4101
  value: WorkqueueColumnValue
4102
+ }).meta({
4103
+ id: "WorkqueueColumn",
4104
+ description: "Configuration for a single workqueue column. The value references an event metadata key (e.g. `dateOfEvent`, `status`, `trackingId`)."
3928
4105
  });
3929
4106
  function defineWorkqueuesColumns(workqueueColumns) {
3930
4107
  return workqueueColumns.map(
@@ -4127,18 +4304,11 @@ var WorkqueueConfigWithoutQuery = WorkqueueConfig.omit({
4127
4304
  query: true,
4128
4305
  columns: true
4129
4306
  });
4130
- var WorkqueueConfigInput = z37.object({
4131
- slug: z37.string().describe("Determines the url of the workqueue."),
4132
- name: TranslationConfig.describe(
4133
- "Title of the workflow (both in navigation and on the page)"
4134
- ),
4135
- query: CountryConfigQueryInputType,
4136
- action: z37.object({ type: WorkqueueActionType }).optional().describe(
4137
- "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."
4138
- ),
4139
- columns: z37.array(WorkqueueColumn).default(mandatoryColumns),
4140
- icon: AvailableIcons,
4141
- emptyMessage: TranslationConfig.optional()
4307
+ var WorkqueueConfigInput = WorkqueueConfig.extend({
4308
+ query: CountryConfigQueryInputType
4309
+ }).meta({
4310
+ id: "WorkqueueConfig",
4311
+ 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."
4142
4312
  });
4143
4313
  var WorkqueueCountInput = z37.array(
4144
4314
  z37.object({ slug: z37.string(), query: QueryType })
@@ -4178,6 +4348,11 @@ var BaseActionInput = z38.object({
4178
4348
  originalActionId: UUID.optional(),
4179
4349
  // should not be part of base action.
4180
4350
  keepAssignment: z38.boolean().optional(),
4351
+ keepAssignmentIfAccepted: z38.boolean().optional(),
4352
+ keepAssignmentIfRejected: z38.boolean().optional(),
4353
+ waitFor: z38.boolean().default(true).describe(
4354
+ "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."
4355
+ ),
4181
4356
  // For normal users, the createdAtLocation is resolved on the backend from the user's primaryOfficeId.
4182
4357
  // @TODO: createdAtLocation should be limited to actions that system users can perform. For normal users, it should not be part of the base action.
4183
4358
  createdAtLocation: UUID.nullish().describe(
@@ -4295,7 +4470,8 @@ var RejectCorrectionActionInput = BaseActionInput.extend(
4295
4470
  var ApproveCorrectionActionInput = BaseActionInput.extend(
4296
4471
  z38.object({
4297
4472
  requestId: z38.string(),
4298
- type: z38.literal(ActionType.APPROVE_CORRECTION).default(ActionType.APPROVE_CORRECTION)
4473
+ type: z38.literal(ActionType.APPROVE_CORRECTION).default(ActionType.APPROVE_CORRECTION),
4474
+ content: z38.object({ immediateCorrection: z38.boolean().optional() }).optional()
4299
4475
  }).shape
4300
4476
  );
4301
4477
  var ReadActionInput = BaseActionInput.extend(
@@ -4357,7 +4533,7 @@ var Draft = z39.object({
4357
4533
  }).describe(
4358
4534
  "A temporary storage for an action. Stored with details of the event, creator and creation time."
4359
4535
  );
4360
- var DraftInput = BaseActionInput.extend({
4536
+ var DraftInput = BaseActionInput.omit({ waitFor: true }).extend({
4361
4537
  type: ActionTypes.exclude([ActionTypes.enum.DELETE]),
4362
4538
  status: z39.enum([
4363
4539
  ActionStatus.Requested,
@@ -6955,6 +7131,369 @@ var ACTION_FILTERS = {
6955
7131
  // ../commons/src/events/FileUtils.ts
6956
7132
  var import_lodash7 = require("lodash");
6957
7133
 
7134
+ // ../commons/src/events/mocks.test.utils.ts
7135
+ var V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS = [
7136
+ {
7137
+ id: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
7138
+ name: "Central",
7139
+ parentId: null,
7140
+ validUntil: null,
7141
+ externalId: "ydyJb1RAy4U1"
7142
+ },
7143
+ {
7144
+ id: "c599b691-fd2d-45e1-abf4-d185de727fb5",
7145
+ name: "Sulaka",
7146
+ parentId: null,
7147
+ validUntil: null,
7148
+ externalId: "pQ8nGxWmZ2Q3"
7149
+ },
7150
+ {
7151
+ id: "7ef2b9c7-5e6d-49f6-ae05-656207d0fc64",
7152
+ name: "Pualula",
7153
+ parentId: null,
7154
+ validUntil: null,
7155
+ externalId: "Aq91DweLmT8k"
7156
+ },
7157
+ {
7158
+ id: "6d1a59df-988c-4021-a846-ccbc021931a7",
7159
+ name: "Chuminga",
7160
+ parentId: null,
7161
+ validUntil: null,
7162
+ externalId: "Rw0fYNh2Xk9a"
7163
+ },
7164
+ {
7165
+ id: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7166
+ name: "Ibombo",
7167
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
7168
+ validUntil: null,
7169
+ externalId: "k7DsP4vbN1Qe"
7170
+ },
7171
+ {
7172
+ id: "27160bbd-32d1-4625-812f-860226bfb92a",
7173
+ name: "Isango",
7174
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
7175
+ validUntil: null,
7176
+ externalId: "Gm3Z9eQpHw4L"
7177
+ },
7178
+ {
7179
+ id: "967032fd-3f81-478a-826c-30cb8fe121bd",
7180
+ name: "Isamba",
7181
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
7182
+ validUntil: null,
7183
+ externalId: "sT0xVu1KqJ7r"
7184
+ },
7185
+ {
7186
+ id: "89a33893-b17d-481d-a26d-6461e7ac1651",
7187
+ name: "Itambo",
7188
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
7189
+ validUntil: null,
7190
+ externalId: "Nq6Bv2HpL9Te"
7191
+ },
7192
+ {
7193
+ id: "d42ab2fe-e7ed-470e-8b31-4fb27f9b8250",
7194
+ name: "Ezhi",
7195
+ parentId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
7196
+ validUntil: null,
7197
+ externalId: "xK8cQ0ZRy5Wd"
7198
+ },
7199
+ {
7200
+ id: "8fbd09d2-212b-47f4-beb3-5e1694931d9f",
7201
+ name: "Ilanga",
7202
+ parentId: "c599b691-fd2d-45e1-abf4-d185de727fb5",
7203
+ validUntil: null,
7204
+ externalId: "Cq4Jm1XvN8Ls"
7205
+ },
7206
+ // Villages under Ibombo (62a0ccb4-880d-4f30-8882-f256007dfff9)
7207
+ {
7208
+ id: "1d4e5f6a-7b8c-4912-8efa-345678901234",
7209
+ name: "Klow",
7210
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7211
+ validUntil: null,
7212
+ externalId: "IkYcYBUcyY2"
7213
+ },
7214
+ {
7215
+ id: "2e5f6a7b-8c9d-4a23-8fab-456789012345",
7216
+ name: "Mbondo",
7217
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7218
+ validUntil: null,
7219
+ externalId: "Qhvv5hvo3mY"
7220
+ },
7221
+ {
7222
+ id: "3f6a7b8c-9d0e-4b34-8abc-567890123456",
7223
+ name: "Ndara",
7224
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7225
+ validUntil: null,
7226
+ externalId: "crXh068O9TR"
7227
+ },
7228
+ {
7229
+ id: "4a7b8c9d-0e1f-4c45-abcd-678901234567",
7230
+ name: "Olani",
7231
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7232
+ validUntil: null,
7233
+ externalId: "r00It8Tvvp7"
7234
+ },
7235
+ {
7236
+ id: "5b8c9d0e-1f2a-4d56-bcde-789012345678",
7237
+ name: "Pemba",
7238
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7239
+ validUntil: null,
7240
+ externalId: "ZnUWsbONIaH"
7241
+ },
7242
+ {
7243
+ id: "6c9d0e1f-2a3b-4e67-8def-890123456789",
7244
+ name: "Quanza",
7245
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7246
+ validUntil: null,
7247
+ externalId: "fDZycvQTa7l"
7248
+ },
7249
+ {
7250
+ id: "7d0e1f2a-3b4c-4f78-8efa-901234567890",
7251
+ name: "Rivka",
7252
+ parentId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7253
+ validUntil: null,
7254
+ externalId: "KqswxCGTELa"
7255
+ },
7256
+ // Villages under Isamba (967032fd-3f81-478a-826c-30cb8fe121bd)
7257
+ {
7258
+ id: "8e1f2a3b-4c5d-4089-8fab-012345678901",
7259
+ name: "Mbula",
7260
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
7261
+ validUntil: null,
7262
+ externalId: "osEbKjRc9Kg"
7263
+ },
7264
+ {
7265
+ id: "9f2a3b4c-5d6e-4190-8abf-123456789012",
7266
+ name: "Ndoki",
7267
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
7268
+ validUntil: null,
7269
+ externalId: "aq4daBUAGr3"
7270
+ },
7271
+ {
7272
+ id: "0a3b4c5d-6e7f-4201-abcd-234567890123",
7273
+ name: "Tsanga",
7274
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
7275
+ validUntil: null,
7276
+ externalId: "cqis6Y8trbJ"
7277
+ },
7278
+ {
7279
+ id: "1b4c5d6e-7f8a-4312-bcde-345678901234",
7280
+ name: "Waziri",
7281
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
7282
+ validUntil: null,
7283
+ externalId: "LMijHPyyx6d"
7284
+ },
7285
+ {
7286
+ id: "2c5d6e7f-8a9b-4423-8def-456789012345",
7287
+ name: "Zimbi",
7288
+ parentId: "967032fd-3f81-478a-826c-30cb8fe121bd",
7289
+ validUntil: null,
7290
+ externalId: "pcQYbPuKGZ7"
7291
+ },
7292
+ // Villages under Itambo (89a33893-b17d-481d-a26d-6461e7ac1651)
7293
+ {
7294
+ id: "3d6e7f8a-9b0c-4534-8efa-567890123456",
7295
+ name: "Felani",
7296
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
7297
+ validUntil: null,
7298
+ externalId: "gSqpoCGdMXp"
7299
+ },
7300
+ {
7301
+ id: "4e7f8a9b-0c1d-4645-8fab-678901234567",
7302
+ name: "Goroma",
7303
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
7304
+ validUntil: null,
7305
+ externalId: "KvAAIaNqVrp"
7306
+ },
7307
+ {
7308
+ id: "5f8a9b0c-1d2e-4756-8abc-789012345678",
7309
+ name: "Halifu",
7310
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
7311
+ validUntil: null,
7312
+ externalId: "qe4UnEVt1hv"
7313
+ },
7314
+ {
7315
+ id: "6a9b0c1d-2e3f-4867-abcd-890123456789",
7316
+ name: "Jabari",
7317
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
7318
+ validUntil: null,
7319
+ externalId: "yHH9Nz4rLOt"
7320
+ },
7321
+ {
7322
+ id: "7b0c1d2e-3f4a-4978-bcde-901234567890",
7323
+ name: "Kifani",
7324
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
7325
+ validUntil: null,
7326
+ externalId: "eSWmXIGeu1I"
7327
+ },
7328
+ {
7329
+ id: "8c1d2e3f-4a5b-4089-8def-012345678901",
7330
+ name: "Lumela",
7331
+ parentId: "89a33893-b17d-481d-a26d-6461e7ac1651",
7332
+ validUntil: null,
7333
+ externalId: "bh0b3aI1uP3"
7334
+ }
7335
+ ];
7336
+ var V2_DEFAULT_MOCK_LOCATIONS = [
7337
+ {
7338
+ id: "6f6186ce-cd5f-4a5f-810a-2d99e7c4ba12",
7339
+ name: "Central Provincial Office",
7340
+ locationType: "CRVS_OFFICE",
7341
+ administrativeAreaId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
7342
+ validUntil: null,
7343
+ externalId: "Xr3Df8WpK6Ys"
7344
+ },
7345
+ {
7346
+ id: "b1c2d3e4-f5a6-7890-bcde-f12345678901",
7347
+ name: "Central Health Post",
7348
+ locationType: "HEALTH_FACILITY",
7349
+ administrativeAreaId: "a45b982a-5c7b-4bd9-8fd8-a42d0994054c",
7350
+ validUntil: null
7351
+ },
7352
+ {
7353
+ id: "028d2c85-ca31-426d-b5d1-2cef545a4902",
7354
+ name: "Ibombo District Office",
7355
+ locationType: "CRVS_OFFICE",
7356
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7357
+ validUntil: null,
7358
+ externalId: "Sm4Nw7GrD2Vy"
7359
+ },
7360
+ {
7361
+ id: "62a0ccb4-4f30-4f30-8882-f256007dff9f",
7362
+ name: "Isamba District Office",
7363
+ locationType: "CRVS_OFFICE",
7364
+ administrativeAreaId: "967032fd-3f81-478a-826c-30cb8fe121bd",
7365
+ validUntil: null,
7366
+ externalId: "Vg1Bq5XeH9Lt"
7367
+ },
7368
+ {
7369
+ id: "954c93e1-13f7-4435-bb82-35e0e215e07d",
7370
+ name: "Isango District Office",
7371
+ locationType: "CRVS_OFFICE",
7372
+ administrativeAreaId: "27160bbd-32d1-4625-812f-860226bfb92a",
7373
+ validUntil: null,
7374
+ externalId: "Je7Lm2XqN9Vz"
7375
+ },
7376
+ {
7377
+ id: "2884f5b9-17b4-49ce-bf4d-f538228935df",
7378
+ name: "Sulaka Provincial Office",
7379
+ locationType: "CRVS_OFFICE",
7380
+ administrativeAreaId: "c599b691-fd2d-45e1-abf4-d185de727fb5",
7381
+ validUntil: null,
7382
+ externalId: "Ht2Wp9KcX5Qv"
7383
+ },
7384
+ {
7385
+ id: "030358c6-54af-44be-821b-8e4af963a49c",
7386
+ name: "Ilanga District Office",
7387
+ locationType: "CRVS_OFFICE",
7388
+ administrativeAreaId: "8fbd09d2-212b-47f4-beb3-5e1694931d9f",
7389
+ validUntil: null,
7390
+ externalId: "Yp6Ds1WqN3Xz"
7391
+ },
7392
+ {
7393
+ id: "423d000f-101b-47c0-8b86-21a908067cee",
7394
+ name: "Chamakubi Health Post",
7395
+ locationType: "HEALTH_FACILITY",
7396
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7397
+ validUntil: null,
7398
+ externalId: "M1nFr8LbC2Qy"
7399
+ },
7400
+ {
7401
+ id: "4d3279be-d026-420c-88f7-f0a4ae986973",
7402
+ name: "Ibombo Rural Health Centre",
7403
+ locationType: "HEALTH_FACILITY",
7404
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7405
+ validUntil: null,
7406
+ externalId: "bT7pV6YrW0Xc"
7407
+ },
7408
+ {
7409
+ id: "190902f4-1d77-476a-8947-41145af1db7d",
7410
+ name: "Chikobo Rural Health Centre",
7411
+ locationType: "HEALTH_FACILITY",
7412
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7413
+ validUntil: null,
7414
+ externalId: "zE4qPn2SgJ5d"
7415
+ },
7416
+ {
7417
+ id: "f5ecbd9b-a01e-4a65-910e-70e86ab41b71",
7418
+ name: "Chilochabalenje Health Post",
7419
+ locationType: "HEALTH_FACILITY",
7420
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7421
+ validUntil: null,
7422
+ externalId: "H8vDs1MqR4Uf"
7423
+ },
7424
+ {
7425
+ id: "dbfc178f-7295-4b90-b28d-111c95b03127",
7426
+ name: "Chipeso Rural Health Centre",
7427
+ locationType: "HEALTH_FACILITY",
7428
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7429
+ validUntil: null,
7430
+ externalId: "Qw3uZ9KfX6Lm"
7431
+ },
7432
+ {
7433
+ id: "09862bfe-c7ac-46cd-987b-668681533c80",
7434
+ name: "Chisamba Rural Health Centre",
7435
+ locationType: "HEALTH_FACILITY",
7436
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7437
+ validUntil: null,
7438
+ externalId: "Yr0pCg8LdM2s"
7439
+ },
7440
+ {
7441
+ id: "834ce389-e95b-4fb0-96a0-33e9ab323059",
7442
+ name: "Chitanda Rural Health Centre",
7443
+ locationType: "HEALTH_FACILITY",
7444
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7445
+ validUntil: null,
7446
+ externalId: "tS9gJ4PwB1Qx"
7447
+ },
7448
+ {
7449
+ id: "0431c433-6062-4a4c-aee9-25271aec61ee",
7450
+ name: "Golden Valley Rural Health Centre",
7451
+ locationType: "HEALTH_FACILITY",
7452
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7453
+ validUntil: null,
7454
+ externalId: "Ld7Qm3XsA8Vr"
7455
+ },
7456
+ {
7457
+ id: "bc84d0b6-7ba7-480d-a339-5d9920d90eb2",
7458
+ name: "Ipongo Rural Health Centre",
7459
+ locationType: "HEALTH_FACILITY",
7460
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7461
+ validUntil: null,
7462
+ externalId: "kF2sW9DmH0Bt"
7463
+ },
7464
+ {
7465
+ id: "4cf1f53b-b730-41d2-8649-dff7eeed970d",
7466
+ name: "Itumbwe Health Post",
7467
+ locationType: "HEALTH_FACILITY",
7468
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7469
+ validUntil: null,
7470
+ externalId: "Ue5Xb3VaC7Pq"
7471
+ },
7472
+ {
7473
+ id: "4b3676cb-9355-4942-9eb9-2ce46acaf0e0",
7474
+ name: "Kabangalala Rural Health Centre",
7475
+ locationType: "HEALTH_FACILITY",
7476
+ administrativeAreaId: "62a0ccb4-880d-4f30-8882-f256007dfff9",
7477
+ validUntil: null,
7478
+ externalId: "Pz8Kc1TqH6Jn"
7479
+ },
7480
+ // Village offices
7481
+ {
7482
+ id: "1f4a5b6c-7d8e-4312-8abc-345678901234",
7483
+ name: "Klow Village Office",
7484
+ locationType: "CRVS_OFFICE",
7485
+ administrativeAreaId: "1d4e5f6a-7b8c-4912-8efa-345678901234",
7486
+ validUntil: null,
7487
+ externalId: "PmAyxAJkxiJ"
7488
+ }
7489
+ ];
7490
+ var V2_DEFAULT_MOCK_LOCATIONS_MAP = new Map(
7491
+ V2_DEFAULT_MOCK_LOCATIONS.map((l) => [l.id, l])
7492
+ );
7493
+ var V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS_MAP = new Map(
7494
+ V2_DEFAULT_MOCK_ADMINISTRATIVE_AREAS.map((a) => [a.id, a])
7495
+ );
7496
+
6958
7497
  // ../commons/src/notification/UserNotifications.ts
6959
7498
  var z44 = __toESM(require("zod/v4"));
6960
7499
  var TriggerEvent = {