@opencrvs/toolkit 2.0.0-rc.9954a7c → 2.0.0-rc.99921a2

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 (113) hide show
  1. package/README.md +15 -0
  2. package/build.sh +5 -4
  3. package/dist/application-config/index.js +82 -40
  4. package/dist/cli.js +3186 -4915
  5. package/dist/commons/api/router.d.ts +700 -22
  6. package/dist/commons/application-config/index.d.ts +1 -0
  7. package/dist/commons/conditionals/conditionals.d.ts +354 -10
  8. package/dist/commons/conditionals/validate.d.ts +51 -2
  9. package/dist/commons/events/ActionConfig.d.ts +230 -2
  10. package/dist/commons/events/ActionDocument.d.ts +50 -0
  11. package/dist/commons/events/ActionInput.d.ts +32 -0
  12. package/dist/commons/events/ActionType.d.ts +6 -1
  13. package/dist/commons/events/AdvancedSearchConfig.d.ts +360 -0
  14. package/dist/commons/events/AuditLog.d.ts +2 -0
  15. package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
  16. package/dist/commons/events/Draft.d.ts +2 -0
  17. package/dist/commons/events/EventConfig.d.ts +2 -0
  18. package/dist/commons/events/EventDocument.d.ts +25 -0
  19. package/dist/commons/events/EventIndex.d.ts +25 -0
  20. package/dist/commons/events/EventMetadata.d.ts +26 -0
  21. package/dist/commons/events/FieldConfig.d.ts +393 -50
  22. package/dist/commons/events/FieldType.d.ts +1 -0
  23. package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
  24. package/dist/commons/events/FieldValue.d.ts +6 -0
  25. package/dist/commons/events/WorkqueueConfig.d.ts +44 -2
  26. package/dist/commons/events/field.d.ts +53 -1
  27. package/dist/commons/events/index.d.ts +1 -0
  28. package/dist/commons/events/locations.d.ts +1 -0
  29. package/dist/commons/events/scopes.d.ts +1 -0
  30. package/dist/commons/events/state/flags.d.ts +14 -0
  31. package/dist/commons/events/state/index.d.ts +8 -0
  32. package/dist/commons/events/state/utils.d.ts +21 -287
  33. package/dist/commons/events/test.utils.d.ts +9 -1
  34. package/dist/commons/events/utils.d.ts +27 -2
  35. package/dist/conditionals/index.js +60 -6
  36. package/dist/environment/custom-types.d.ts +33 -0
  37. package/dist/environment/custom-types.d.ts.map +1 -0
  38. package/dist/environment/custom-types.js +12 -0
  39. package/dist/environment/derived-variables.d.ts +134 -0
  40. package/dist/environment/derived-variables.d.ts.map +1 -0
  41. package/dist/environment/derived-variables.js +169 -0
  42. package/dist/environment/editor-questions.d.ts +4 -0
  43. package/dist/environment/editor-questions.d.ts.map +1 -0
  44. package/dist/environment/editor-questions.js +67 -0
  45. package/dist/environment/git.d.ts +5 -0
  46. package/dist/environment/git.d.ts.map +1 -0
  47. package/dist/environment/git.js +38 -0
  48. package/dist/environment/github.d.ts +26 -0
  49. package/dist/environment/github.d.ts.map +1 -0
  50. package/dist/environment/github.js +247 -0
  51. package/dist/environment/index.d.ts +5 -0
  52. package/dist/environment/index.d.ts.map +1 -0
  53. package/dist/environment/index.js +71 -0
  54. package/dist/environment/logger.d.ts +15 -0
  55. package/dist/environment/logger.d.ts.map +1 -0
  56. package/dist/environment/logger.js +25 -0
  57. package/dist/environment/manage-users.d.ts +11 -0
  58. package/dist/environment/manage-users.d.ts.map +1 -0
  59. package/dist/environment/manage-users.js +497 -0
  60. package/dist/environment/questions-helper.d.ts +15 -0
  61. package/dist/environment/questions-helper.d.ts.map +1 -0
  62. package/dist/environment/questions-helper.js +70 -0
  63. package/dist/environment/questions.d.ts +199 -0
  64. package/dist/environment/questions.d.ts.map +1 -0
  65. package/dist/environment/questions.js +412 -0
  66. package/dist/environment/setup-environment.d.ts +2 -0
  67. package/dist/environment/setup-environment.d.ts.map +1 -0
  68. package/dist/environment/setup-environment.js +794 -0
  69. package/dist/environment/ssh-keygen.d.ts +5 -0
  70. package/dist/environment/ssh-keygen.d.ts.map +1 -0
  71. package/dist/environment/ssh-keygen.js +21 -0
  72. package/dist/environment/swarm-to-k8s.d.ts +2 -0
  73. package/dist/environment/swarm-to-k8s.d.ts.map +1 -0
  74. package/dist/environment/swarm-to-k8s.js +173 -0
  75. package/dist/environment/templates.d.ts +27 -0
  76. package/dist/environment/templates.d.ts.map +1 -0
  77. package/dist/environment/templates.js +163 -0
  78. package/dist/environment/update-workflows.d.ts +2 -0
  79. package/dist/environment/update-workflows.d.ts.map +1 -0
  80. package/dist/environment/update-workflows.js +169 -0
  81. package/dist/environment/users.d.ts +2 -0
  82. package/dist/environment/users.d.ts.map +1 -0
  83. package/dist/environment/users.js +112 -0
  84. package/dist/environment/utils.d.ts +18 -0
  85. package/dist/environment/utils.d.ts.map +1 -0
  86. package/dist/environment/utils.js +100 -0
  87. package/dist/events/index.js +600 -158
  88. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
  89. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  90. package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
  91. package/dist/migrations/v2.0/index.js +88 -5133
  92. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +3 -0
  93. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +1 -0
  94. package/dist/migrations/v2.1/add-explicit-correction-flags.js +234 -0
  95. package/dist/migrations/v2.1/index.d.ts +6 -0
  96. package/dist/migrations/v2.1/index.d.ts.map +1 -0
  97. package/dist/migrations/v2.1/index.js +218 -0
  98. package/dist/notification/index.js +389 -49
  99. package/dist/scopes/index.d.ts +100 -8
  100. package/dist/scopes/index.js +21 -8
  101. package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
  102. package/dist/templates/charts-values/dependencies/values.yaml +83 -0
  103. package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
  104. package/dist/templates/charts-values/opencrvs-services/values.yaml +81 -0
  105. package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
  106. package/dist/templates/charts-values/traefik/values.yaml +115 -0
  107. package/dist/templates/inventory/inventory.template.yml +100 -0
  108. package/dist/templates/inventory/production.example.yml +77 -0
  109. package/dist/templates/inventory/qa.example.yml +48 -0
  110. package/opencrvs-toolkit-2.0.0-rc.99921a2.tgz +0 -0
  111. package/package.json +15 -1
  112. package/tsconfig.tsbuildinfo +1 -1
  113. package/opencrvs-toolkit-2.0.0-rc.9954a7c.tgz +0 -0
@@ -75,4 +75,5 @@ export type FieldType = (typeof fieldTypes)[number];
75
75
  */
76
76
  export declare const compositeFieldTypes: ("NAME" | "ADDRESS" | "DATE_RANGE" | "FILE" | "FILE_WITH_OPTIONS" | "DATA" | "ID_READER")[];
77
77
  export declare const FieldTypesToHideInReview: ("IMAGE_VIEW" | "PARAGRAPH" | "PAGE_HEADER" | "BULLET_LIST" | "DIVIDER" | "DATA" | "ALPHA_PRINT_BUTTON" | "HTTP" | "QUERY_PARAM_READER" | "ID_READER" | "LOADER" | "ALPHA_HIDDEN")[];
78
+ export declare const HiddenFieldTypes: ("HTTP" | "QUERY_PARAM_READER" | "ALPHA_HIDDEN")[];
78
79
  //# sourceMappingURL=FieldType.d.ts.map
@@ -690,7 +690,7 @@ export declare const isHiddenFieldType: (field: {
690
690
  value: undefined;
691
691
  config: HiddenField;
692
692
  };
693
- export type NonInteractiveFieldType = Divider | PageHeader | ImageViewField | Paragraph | Heading | BulletList | DataField | AlphaPrintButton | HttpField | LinkButtonField | QueryParamReaderField | LoaderField | AutocompleteField;
693
+ export type NonInteractiveFieldType = Divider | PageHeader | ImageViewField | Paragraph | Heading | BulletList | DataField | AlphaPrintButton | LinkButtonField | LoaderField | AutocompleteField;
694
694
  export type InteractiveFieldType = Exclude<FieldConfig, NonInteractiveFieldType>;
695
695
  export declare const isNonInteractiveFieldType: (field: FieldConfig) => field is NonInteractiveFieldType;
696
696
  export {};
@@ -58,6 +58,12 @@ export declare const CheckboxFieldValue: z.ZodBoolean;
58
58
  export type CheckboxFieldValue = z.infer<typeof CheckboxFieldValue>;
59
59
  export declare const NumberFieldValue: z.ZodNumber;
60
60
  export type NumberFieldValue = z.infer<typeof NumberFieldValue>;
61
+ export declare const SignatureFieldValue: z.ZodObject<{
62
+ path: z.core.$ZodBranded<z.ZodString, "DocumentPath", "out">;
63
+ originalFilename: z.ZodString;
64
+ type: z.ZodString;
65
+ }, z.core.$strip>;
66
+ export type SignatureFieldValue = z.infer<typeof SignatureFieldValue>;
61
67
  export declare const ButtonFieldValue: z.ZodNumber;
62
68
  export type ButtonFieldValue = z.infer<typeof ButtonFieldValue>;
63
69
  export declare const VerificationStatusValue: z.ZodEnum<{
@@ -322,6 +322,13 @@ export declare const WorkqueueConfig: z.ZodObject<{
322
322
  readonly POTENTIAL_DUPLICATE: "potential-duplicate";
323
323
  readonly EDIT_IN_PROGRESS: "edit-in-progress";
324
324
  }>]>, z.ZodString]>>>;
325
+ allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
326
+ readonly INCOMPLETE: "incomplete";
327
+ readonly REJECTED: "rejected";
328
+ readonly CORRECTION_REQUESTED: "correction-requested";
329
+ readonly POTENTIAL_DUPLICATE: "potential-duplicate";
330
+ readonly EDIT_IN_PROGRESS: "edit-in-progress";
331
+ }>]>, z.ZodString]>>>;
325
332
  }, z.core.$strip>>>;
326
333
  data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
327
334
  }, z.core.$strip>>;
@@ -632,6 +639,13 @@ export declare const WorkqueueConfig: z.ZodObject<{
632
639
  readonly POTENTIAL_DUPLICATE: "potential-duplicate";
633
640
  readonly EDIT_IN_PROGRESS: "edit-in-progress";
634
641
  }>]>, z.ZodString]>>>;
642
+ allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
643
+ readonly INCOMPLETE: "incomplete";
644
+ readonly REJECTED: "rejected";
645
+ readonly CORRECTION_REQUESTED: "correction-requested";
646
+ readonly POTENTIAL_DUPLICATE: "potential-duplicate";
647
+ readonly EDIT_IN_PROGRESS: "edit-in-progress";
648
+ }>]>, z.ZodString]>>>;
635
649
  }, z.core.$strip>>>;
636
650
  data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
637
651
  }, z.core.$strip>>;
@@ -645,6 +659,7 @@ export declare const WorkqueueConfig: z.ZodObject<{
645
659
  REJECT: "REJECT";
646
660
  MARK_AS_DUPLICATE: "MARK_AS_DUPLICATE";
647
661
  ARCHIVE: "ARCHIVE";
662
+ UNARCHIVE: "UNARCHIVE";
648
663
  PRINT_CERTIFICATE: "PRINT_CERTIFICATE";
649
664
  REQUEST_CORRECTION: "REQUEST_CORRECTION";
650
665
  READ: "READ";
@@ -899,6 +914,7 @@ export declare const WorkqueueConfigWithoutQuery: z.ZodObject<{
899
914
  REJECT: "REJECT";
900
915
  MARK_AS_DUPLICATE: "MARK_AS_DUPLICATE";
901
916
  ARCHIVE: "ARCHIVE";
917
+ UNARCHIVE: "UNARCHIVE";
902
918
  PRINT_CERTIFICATE: "PRINT_CERTIFICATE";
903
919
  REQUEST_CORRECTION: "REQUEST_CORRECTION";
904
920
  READ: "READ";
@@ -919,6 +935,7 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
919
935
  REJECT: "REJECT";
920
936
  MARK_AS_DUPLICATE: "MARK_AS_DUPLICATE";
921
937
  ARCHIVE: "ARCHIVE";
938
+ UNARCHIVE: "UNARCHIVE";
922
939
  PRINT_CERTIFICATE: "PRINT_CERTIFICATE";
923
940
  REQUEST_CORRECTION: "REQUEST_CORRECTION";
924
941
  READ: "READ";
@@ -1361,6 +1378,13 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
1361
1378
  readonly POTENTIAL_DUPLICATE: "potential-duplicate";
1362
1379
  readonly EDIT_IN_PROGRESS: "edit-in-progress";
1363
1380
  }>]>, z.ZodString]>>>;
1381
+ allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
1382
+ readonly INCOMPLETE: "incomplete";
1383
+ readonly REJECTED: "rejected";
1384
+ readonly CORRECTION_REQUESTED: "correction-requested";
1385
+ readonly POTENTIAL_DUPLICATE: "potential-duplicate";
1386
+ readonly EDIT_IN_PROGRESS: "edit-in-progress";
1387
+ }>]>, z.ZodString]>>>;
1364
1388
  }, z.core.$strip>>>;
1365
1389
  data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
1366
1390
  }, z.core.$strip>, z.ZodObject<{
@@ -1670,6 +1694,13 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
1670
1694
  readonly POTENTIAL_DUPLICATE: "potential-duplicate";
1671
1695
  readonly EDIT_IN_PROGRESS: "edit-in-progress";
1672
1696
  }>]>, z.ZodString]>>>;
1697
+ allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
1698
+ readonly INCOMPLETE: "incomplete";
1699
+ readonly REJECTED: "rejected";
1700
+ readonly CORRECTION_REQUESTED: "correction-requested";
1701
+ readonly POTENTIAL_DUPLICATE: "potential-duplicate";
1702
+ readonly EDIT_IN_PROGRESS: "edit-in-progress";
1703
+ }>]>, z.ZodString]>>>;
1673
1704
  }, z.core.$strip>>>;
1674
1705
  data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
1675
1706
  }, z.core.$strip>>;
@@ -1980,6 +2011,13 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
1980
2011
  readonly POTENTIAL_DUPLICATE: "potential-duplicate";
1981
2012
  readonly EDIT_IN_PROGRESS: "edit-in-progress";
1982
2013
  }>]>, z.ZodString]>>>;
2014
+ allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
2015
+ readonly INCOMPLETE: "incomplete";
2016
+ readonly REJECTED: "rejected";
2017
+ readonly CORRECTION_REQUESTED: "correction-requested";
2018
+ readonly POTENTIAL_DUPLICATE: "potential-duplicate";
2019
+ readonly EDIT_IN_PROGRESS: "edit-in-progress";
2020
+ }>]>, z.ZodString]>>>;
1983
2021
  }, z.core.$strip>>>;
1984
2022
  data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
1985
2023
  }, z.core.$strip>>;
@@ -2130,6 +2168,7 @@ export declare function defineWorkqueue(workqueueInput: WorkqueueConfigInput): {
2130
2168
  flags?: {
2131
2169
  anyOf?: string[] | undefined;
2132
2170
  noneOf?: string[] | undefined;
2171
+ allOf?: string[] | undefined;
2133
2172
  } | undefined;
2134
2173
  data?: unknown;
2135
2174
  }[];
@@ -2268,6 +2307,7 @@ export declare function defineWorkqueue(workqueueInput: WorkqueueConfigInput): {
2268
2307
  flags?: {
2269
2308
  anyOf?: string[] | undefined;
2270
2309
  noneOf?: string[] | undefined;
2310
+ allOf?: string[] | undefined;
2271
2311
  } | undefined;
2272
2312
  data?: unknown;
2273
2313
  }[];
@@ -2284,7 +2324,7 @@ export declare function defineWorkqueue(workqueueInput: WorkqueueConfigInput): {
2284
2324
  }[];
2285
2325
  icon: "File" | "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
2286
2326
  action?: {
2287
- type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
2327
+ type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "UNARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
2288
2328
  } | undefined;
2289
2329
  emptyMessage?: {
2290
2330
  id: string;
@@ -2439,6 +2479,7 @@ export declare function defineWorkqueues(workqueues: WorkqueueConfigInputWithV19
2439
2479
  flags?: {
2440
2480
  anyOf?: string[] | undefined;
2441
2481
  noneOf?: string[] | undefined;
2482
+ allOf?: string[] | undefined;
2442
2483
  } | undefined;
2443
2484
  data?: unknown;
2444
2485
  }[];
@@ -2577,6 +2618,7 @@ export declare function defineWorkqueues(workqueues: WorkqueueConfigInputWithV19
2577
2618
  flags?: {
2578
2619
  anyOf?: string[] | undefined;
2579
2620
  noneOf?: string[] | undefined;
2621
+ allOf?: string[] | undefined;
2580
2622
  } | undefined;
2581
2623
  data?: unknown;
2582
2624
  }[];
@@ -2593,7 +2635,7 @@ export declare function defineWorkqueues(workqueues: WorkqueueConfigInputWithV19
2593
2635
  }[];
2594
2636
  icon: "File" | "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
2595
2637
  action?: {
2596
- type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
2638
+ type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "UNARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
2597
2639
  } | undefined;
2598
2640
  emptyMessage?: {
2599
2641
  id: string;
@@ -1,6 +1,31 @@
1
+ import { FormConditionalParameters } from '../conditionals/conditionals';
1
2
  import { FieldConditional } from './Conditional';
2
3
  import { TranslationConfig } from './TranslationConfig';
3
- import { SelectOption, ValidationConfig } from './FieldConfig';
4
+ import { JurisdictionReference } from '../users/userReferences';
5
+ import { ComputedDefaultValue, SelectOption, ValidationConfig } from './FieldConfig';
6
+ /**
7
+ * Creates a {@link ComputedDefaultValue} descriptor for use in a field's `defaultValue`.
8
+ *
9
+ * Unlike `field(id).customClientEvaluation(fn)`, this builder is **not tied to any
10
+ * specific field**. Use it when the initial value should be derived purely from
11
+ * context variables (`$now`, `$online`, system variables such as `$user`) rather
12
+ * than from another field's current value.
13
+ *
14
+ * The serialised function receives `(undefined, context)` at runtime, where
15
+ * `context` is a {@link FormConditionalParameters} object.
16
+ *
17
+ * External references (e.g. lodash) are **not** available inside the function body —
18
+ * all logic must be self-contained so the code survives serialisation.
19
+ *
20
+ * @example
21
+ * // Default a date field to today
22
+ * defaultValue: evaluate((_, ctx) => ctx.$now)
23
+ *
24
+ * @example
25
+ * // Default to the current user's role
26
+ * defaultValue: evaluate((_, ctx) => ctx.user.role)
27
+ */
28
+ export declare function evaluate(computationFn: (fieldValue: undefined, context: FormConditionalParameters) => unknown): ComputedDefaultValue;
4
29
  /**
5
30
  * Entry point for defining conditional logic or configuration for a form field.
6
31
  * @param fieldId - The ID of the field to define rules or config for.
@@ -11,12 +36,14 @@ export declare function field(fieldId: string, options?: {
11
36
  conditionals?: FieldConditional[];
12
37
  validations?: ValidationConfig[];
13
38
  searchCriteriaLabelPrefix?: TranslationConfig;
39
+ allowedLocations?: JurisdictionReference;
14
40
  }): {
15
41
  range: () => {
16
42
  options?: SelectOption[];
17
43
  conditionals?: FieldConditional[];
18
44
  validations?: ValidationConfig[];
19
45
  searchCriteriaLabelPrefix?: TranslationConfig;
46
+ allowedLocations?: JurisdictionReference;
20
47
  fieldId: string;
21
48
  fieldType: "field";
22
49
  } & {
@@ -29,6 +56,7 @@ export declare function field(fieldId: string, options?: {
29
56
  conditionals?: FieldConditional[];
30
57
  validations?: ValidationConfig[];
31
58
  searchCriteriaLabelPrefix?: TranslationConfig;
59
+ allowedLocations?: JurisdictionReference;
32
60
  fieldId: string;
33
61
  fieldType: "field";
34
62
  } & {
@@ -41,6 +69,7 @@ export declare function field(fieldId: string, options?: {
41
69
  conditionals?: FieldConditional[];
42
70
  validations?: ValidationConfig[];
43
71
  searchCriteriaLabelPrefix?: TranslationConfig;
72
+ allowedLocations?: JurisdictionReference;
44
73
  fieldId: string;
45
74
  fieldType: "field";
46
75
  } & {
@@ -53,6 +82,7 @@ export declare function field(fieldId: string, options?: {
53
82
  conditionals?: FieldConditional[];
54
83
  validations?: ValidationConfig[];
55
84
  searchCriteriaLabelPrefix?: TranslationConfig;
85
+ allowedLocations?: JurisdictionReference;
56
86
  fieldId: string;
57
87
  fieldType: "field";
58
88
  } & {
@@ -107,6 +137,8 @@ export declare function field(fieldId: string, options?: {
107
137
  fieldId: string;
108
138
  };
109
139
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
140
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
141
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
110
142
  };
111
143
  asDob(): any;
112
144
  asAge(): any;
@@ -144,6 +176,8 @@ export declare function field(fieldId: string, options?: {
144
176
  fieldId: string;
145
177
  };
146
178
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
179
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
180
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
147
181
  };
148
182
  getByPath(fieldPath: string[]): {
149
183
  $$subfield: string[];
@@ -189,6 +223,8 @@ export declare function field(fieldId: string, options?: {
189
223
  fieldId: string;
190
224
  };
191
225
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
226
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
227
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
192
228
  };
193
229
  getByPath(fieldPath: string[]): any;
194
230
  asDob(): {
@@ -232,6 +268,8 @@ export declare function field(fieldId: string, options?: {
232
268
  fieldId: string;
233
269
  };
234
270
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
271
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
272
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
235
273
  };
236
274
  asAge(): {
237
275
  $$subfield: string[];
@@ -274,6 +312,8 @@ export declare function field(fieldId: string, options?: {
274
312
  fieldId: string;
275
313
  };
276
314
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
315
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
316
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
277
317
  };
278
318
  isAfter(): {
279
319
  days: (days: number) => {
@@ -309,6 +349,8 @@ export declare function field(fieldId: string, options?: {
309
349
  fieldId: string;
310
350
  };
311
351
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
352
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
353
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
312
354
  };
313
355
  asDob(): {
314
356
  $$subfield: string[];
@@ -355,6 +397,8 @@ export declare function field(fieldId: string, options?: {
355
397
  fieldId: string;
356
398
  };
357
399
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
400
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
401
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
358
402
  };
359
403
  asDob(): any;
360
404
  asAge(): any;
@@ -392,6 +436,8 @@ export declare function field(fieldId: string, options?: {
392
436
  fieldId: string;
393
437
  };
394
438
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
439
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
440
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
395
441
  };
396
442
  asAge(): {
397
443
  $$subfield: string[];
@@ -438,6 +484,8 @@ export declare function field(fieldId: string, options?: {
438
484
  fieldId: string;
439
485
  };
440
486
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
487
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
488
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
441
489
  };
442
490
  asDob(): any;
443
491
  asAge(): any;
@@ -475,6 +523,8 @@ export declare function field(fieldId: string, options?: {
475
523
  fieldId: string;
476
524
  };
477
525
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
526
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
527
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
478
528
  };
479
529
  isAfter(): {
480
530
  days: (days: number) => {
@@ -510,5 +560,7 @@ export declare function field(fieldId: string, options?: {
510
560
  fieldId: string;
511
561
  };
512
562
  object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
563
+ customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
564
+ customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
513
565
  };
514
566
  //# sourceMappingURL=field.d.ts.map
@@ -22,6 +22,7 @@ export * from './FieldValue';
22
22
  export * from './FormConfig';
23
23
  export * from './CompositeFieldValue';
24
24
  export * from './state';
25
+ export * from './state/flags';
25
26
  export * from './utils';
26
27
  export * from './defineConfig';
27
28
  export * from './DeduplicationConfig';
@@ -40,6 +40,7 @@ type ToArrayFields<T, K extends PropertyKey> = T extends unknown ? T extends obj
40
40
  */
41
41
  export type EventIndexWithAdministrativeHierarchy = Omit<ToArrayFields<EventIndex, 'createdAtLocation' | 'updatedAtLocation' | 'placeOfEvent'>, 'legalStatuses'> & {
42
42
  legalStatuses: {
43
+ NOTIFIED: ToArrayFields<ActionCreationMetadata, 'createdAtLocation'> | undefined;
43
44
  DECLARED: ToArrayFields<ActionCreationMetadata, 'createdAtLocation'> | undefined;
44
45
  REGISTERED: ToArrayFields<RegistrationCreationMetadata, 'createdAtLocation'> | undefined;
45
46
  };
@@ -20,6 +20,7 @@ export declare const ACTION_SCOPE_MAP: {
20
20
  MARK_AS_DUPLICATE: "record.review-duplicates"[];
21
21
  MARK_AS_NOT_DUPLICATE: "record.review-duplicates"[];
22
22
  ARCHIVE: "record.archive"[];
23
+ UNARCHIVE: "record.unarchive"[];
23
24
  REJECT: "record.reject"[];
24
25
  ASSIGN: null;
25
26
  UNASSIGN: null;
@@ -3,6 +3,7 @@ import { Flag, CustomFlag } from '../Flag';
3
3
  import { EventConfig } from '../EventConfig';
4
4
  import { EventDocument } from '../EventDocument';
5
5
  export declare function findPendingCorrectionAction(writeActions: Action[]): RequestedCorrectionAction | undefined;
6
+ export declare function isPotentialDuplicate(actions: Action[]): boolean;
6
7
  /**
7
8
  * This function resolves custom flags for an event based on its actions.
8
9
  * Flags are not stored to the event state or any database directly, instead they are always computed/evaluated from the event actions.
@@ -20,5 +21,18 @@ export declare function findPendingCorrectionAction(writeActions: Action[]): Req
20
21
  * // Returns: ['flag-1', 'flag-3']
21
22
  */
22
23
  export declare function resolveEventCustomFlags(event: EventDocument, eventConfiguration: EventConfig): CustomFlag[];
24
+ /**
25
+ * Computes all flags (inherent, action status, and custom) that should be attached to the given event,
26
+ * based on its actions and event-specific configuration.
27
+ *
28
+ * Flags are determined by combining:
29
+ * - Action status flags (format 'ActionType:ActionStatus')
30
+ * - Inherent flags (e.g. incomplete, rejected, correction requested, potential duplicate, edit in progress)
31
+ * - Event type-specific custom flags defined in the event configuration
32
+ *
33
+ * @param event - The EventDocument containing the action history and payload
34
+ * @param config - The EventConfig providing rules for custom flag evaluation
35
+ * @returns An array of flags currently relevant/applicable to the event
36
+ */
23
37
  export declare function getEventFlags(event: EventDocument, config: EventConfig): Flag[];
24
38
  //# sourceMappingURL=flags.d.ts.map
@@ -65,6 +65,14 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
65
65
  type: string;
66
66
  status: "CREATED" | "NOTIFIED" | "DECLARED" | "REGISTERED" | "ARCHIVED";
67
67
  legalStatuses: {
68
+ NOTIFIED?: {
69
+ createdAt: string;
70
+ createdBy: string;
71
+ acceptedAt: string;
72
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
73
+ createdByUserType?: "user" | "system" | null | undefined;
74
+ createdByRole?: string | undefined;
75
+ } | null | undefined;
68
76
  DECLARED?: {
69
77
  createdAt: string;
70
78
  createdBy: string;