@opencrvs/toolkit 2.0.1 → 2.1.0-beta

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 (170) hide show
  1. package/README.md +16 -0
  2. package/build.sh +14 -5
  3. package/create-countryconfig/index.js +293 -103
  4. package/create-countryconfig/node_modules/.bin/degit +21 -0
  5. package/create-countryconfig/package.json +5 -2
  6. package/dist/application-config/index.js +369 -282
  7. package/dist/authentication/index.d.ts +67 -0
  8. package/dist/authentication/index.d.ts.map +1 -0
  9. package/dist/authentication/index.js +750 -0
  10. package/dist/cli.js +4343 -4788
  11. package/dist/commons/api/router.d.ts +4120 -2946
  12. package/dist/commons/application-config/index.d.ts +6 -6
  13. package/dist/commons/conditionals/conditionals.d.ts +32 -323
  14. package/dist/commons/conditionals/validate.d.ts +16 -5
  15. package/dist/commons/events/ActionConfig.d.ts +302 -71
  16. package/dist/commons/events/ActionDocument.d.ts +159 -121
  17. package/dist/commons/events/ActionInput.d.ts +30 -10
  18. package/dist/commons/events/ActionStatus.d.ts +14 -0
  19. package/dist/commons/events/ActionType.d.ts +63 -58
  20. package/dist/commons/events/AdvancedSearchConfig.d.ts +531 -501
  21. package/dist/commons/events/AuditLog.d.ts +189 -40
  22. package/dist/commons/events/CompositeFieldValue.d.ts +4 -4
  23. package/dist/commons/events/Conditional.d.ts +3 -3
  24. package/dist/commons/events/CountryConfigQueryInput.d.ts +603 -561
  25. package/dist/commons/events/Draft.d.ts +38 -36
  26. package/dist/commons/events/DynamicFieldValue.d.ts +9 -9
  27. package/dist/commons/events/EventConfig.d.ts +8 -3
  28. package/dist/commons/events/EventDocument.d.ts +537 -47
  29. package/dist/commons/events/EventIndex.d.ts +61 -59
  30. package/dist/commons/events/EventMetadata.d.ts +59 -43
  31. package/dist/commons/events/EventStatus.d.ts +19 -0
  32. package/dist/commons/events/FieldConfig.d.ts +424 -384
  33. package/dist/commons/events/FieldType.d.ts +51 -51
  34. package/dist/commons/events/FieldTypeMapping.d.ts +86 -86
  35. package/dist/commons/events/FieldValue.d.ts +14 -14
  36. package/dist/commons/events/Flag.d.ts +57 -15
  37. package/dist/commons/events/FormConfig.d.ts +0 -6
  38. package/dist/commons/events/PageConfig.d.ts +0 -4
  39. package/dist/commons/events/PlainDate.d.ts +8 -0
  40. package/dist/commons/events/SummaryConfig.d.ts +249 -0
  41. package/dist/commons/events/TemplateConfig.d.ts +1 -1
  42. package/dist/commons/events/WorkqueueColumnConfig.d.ts +40 -40
  43. package/dist/commons/events/WorkqueueConfig.d.ts +835 -790
  44. package/dist/commons/events/deduplication.d.ts +1 -1
  45. package/dist/commons/events/event.d.ts +14 -2
  46. package/dist/commons/events/field.d.ts +69 -198
  47. package/dist/commons/events/index.d.ts +1 -0
  48. package/dist/commons/events/locationPayloads.d.ts +95 -0
  49. package/dist/commons/events/locations.d.ts +248 -14
  50. package/dist/commons/events/mocks.test.utils.d.ts +48 -4
  51. package/dist/commons/events/scopes.d.ts +5 -4
  52. package/dist/commons/events/state/index.d.ts +23 -15
  53. package/dist/commons/events/state/utils.d.ts +15 -6
  54. package/dist/commons/events/test.utils.d.ts +68 -42
  55. package/dist/commons/events/utils.d.ts +139 -110
  56. package/dist/commons/notification/UserNotifications.d.ts +38 -18
  57. package/dist/commons/notification/dispatch.d.ts +10 -0
  58. package/dist/commons/notification/index.d.ts +1 -0
  59. package/dist/conditionals/index.js +341 -68
  60. package/dist/csv.d.ts +25 -0
  61. package/dist/csv.d.ts.map +1 -0
  62. package/dist/csv.js +120 -0
  63. package/dist/environment/custom-types.d.ts +33 -0
  64. package/dist/environment/custom-types.d.ts.map +1 -0
  65. package/dist/environment/custom-types.js +12 -0
  66. package/dist/environment/derived-variables.d.ts +122 -0
  67. package/dist/environment/derived-variables.d.ts.map +1 -0
  68. package/dist/environment/derived-variables.js +155 -0
  69. package/dist/environment/editor-questions.d.ts +4 -0
  70. package/dist/environment/editor-questions.d.ts.map +1 -0
  71. package/dist/environment/editor-questions.js +67 -0
  72. package/dist/environment/git.d.ts +5 -0
  73. package/dist/environment/git.d.ts.map +1 -0
  74. package/dist/environment/git.js +38 -0
  75. package/dist/environment/github.d.ts +26 -0
  76. package/dist/environment/github.d.ts.map +1 -0
  77. package/dist/environment/github.js +247 -0
  78. package/dist/environment/index.d.ts +6 -0
  79. package/dist/environment/index.d.ts.map +1 -0
  80. package/dist/environment/index.js +81 -0
  81. package/dist/environment/logger.d.ts +18 -0
  82. package/dist/environment/logger.d.ts.map +1 -0
  83. package/dist/environment/logger.js +25 -0
  84. package/dist/environment/manage-users.d.ts +11 -0
  85. package/dist/environment/manage-users.d.ts.map +1 -0
  86. package/dist/environment/manage-users.js +507 -0
  87. package/dist/environment/paths.d.ts +7 -0
  88. package/dist/environment/paths.d.ts.map +1 -0
  89. package/dist/environment/paths.js +72 -0
  90. package/dist/environment/questions-helper.d.ts +15 -0
  91. package/dist/environment/questions-helper.d.ts.map +1 -0
  92. package/dist/environment/questions-helper.js +70 -0
  93. package/dist/environment/questions.d.ts +200 -0
  94. package/dist/environment/questions.d.ts.map +1 -0
  95. package/dist/environment/questions.js +418 -0
  96. package/dist/environment/setup-environment.d.ts +2 -0
  97. package/dist/environment/setup-environment.d.ts.map +1 -0
  98. package/dist/environment/setup-environment.js +795 -0
  99. package/dist/environment/ssh-keygen.d.ts +5 -0
  100. package/dist/environment/ssh-keygen.d.ts.map +1 -0
  101. package/dist/environment/ssh-keygen.js +21 -0
  102. package/dist/environment/swarm-to-k8s.d.ts +2 -0
  103. package/dist/environment/swarm-to-k8s.d.ts.map +1 -0
  104. package/dist/environment/swarm-to-k8s.js +183 -0
  105. package/dist/environment/templates.d.ts +27 -0
  106. package/dist/environment/templates.d.ts.map +1 -0
  107. package/dist/environment/templates.js +164 -0
  108. package/dist/environment/update-workflows.d.ts +2 -0
  109. package/dist/environment/update-workflows.d.ts.map +1 -0
  110. package/dist/environment/update-workflows.js +191 -0
  111. package/dist/environment/upgrade.d.ts +2 -0
  112. package/dist/environment/upgrade.d.ts.map +1 -0
  113. package/dist/environment/upgrade.js +82 -0
  114. package/dist/environment/users.d.ts +2 -0
  115. package/dist/environment/users.d.ts.map +1 -0
  116. package/dist/environment/users.js +120 -0
  117. package/dist/environment/utils.d.ts +18 -0
  118. package/dist/environment/utils.d.ts.map +1 -0
  119. package/dist/environment/utils.js +110 -0
  120. package/dist/events/deduplication.d.ts +1 -1
  121. package/dist/events/index.js +8104 -7408
  122. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +2 -2
  123. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  124. package/dist/migrations/v2.0/checkout-upstream-files.js +2 -2
  125. package/dist/migrations/v2.0/convert-config-files-to-ts.js +17 -7
  126. package/dist/migrations/v2.0/index.js +88 -5143
  127. package/dist/migrations/v2.0/merge-infrastructure-directory.js +3 -3
  128. package/dist/migrations/v2.0/migrate-application-config-url.js +4 -3
  129. package/dist/migrations/v2.0/remove-hearth-migrations.js +17 -7
  130. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +3 -0
  131. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +1 -0
  132. package/dist/migrations/v2.1/add-explicit-correction-flags.js +234 -0
  133. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
  134. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
  135. package/dist/migrations/v2.1/add-recovery-link-notifications.js +511 -0
  136. package/dist/migrations/v2.1/add-translations.d.ts +9 -0
  137. package/dist/migrations/v2.1/add-translations.d.ts.map +1 -0
  138. package/dist/migrations/v2.1/add-translations.js +213 -0
  139. package/dist/migrations/v2.1/enable-telemetry.d.ts +3 -0
  140. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
  141. package/dist/migrations/v2.1/enable-telemetry.js +438 -0
  142. package/dist/migrations/v2.1/index.d.ts +6 -0
  143. package/dist/migrations/v2.1/index.d.ts.map +1 -0
  144. package/dist/migrations/v2.1/index.js +1276 -0
  145. package/dist/notification/index.js +2010 -1451
  146. package/dist/scopes/index.d.ts +512 -231
  147. package/dist/scopes/index.js +342 -68
  148. package/dist/telemetry/index.d.ts +45 -0
  149. package/dist/telemetry/index.d.ts.map +1 -0
  150. package/dist/telemetry/index.js +39 -0
  151. package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
  152. package/dist/templates/charts-values/dependencies/values.yaml +82 -0
  153. package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
  154. package/dist/templates/charts-values/opencrvs-services/values.yaml +78 -0
  155. package/dist/templates/charts-values/opentelemetry/values.yaml +95 -0
  156. package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
  157. package/dist/templates/charts-values/traefik/values.yaml +129 -0
  158. package/dist/templates/inventory/inventory.template.yml +98 -0
  159. package/dist/translations/check.d.ts +19 -0
  160. package/dist/translations/check.d.ts.map +1 -0
  161. package/dist/translations/check.js +127 -0
  162. package/dist/verify/endpoints.d.ts.map +1 -1
  163. package/dist/verify/endpoints.js +25 -25
  164. package/opencrvs-toolkit-2.1.0-beta.tgz +0 -0
  165. package/package.json +25 -6
  166. package/tsconfig.build.json +11 -0
  167. package/tsconfig.build.tsbuildinfo +1 -0
  168. package/tsconfig.json +3 -0
  169. package/opencrvs-toolkit-2.0.1.tgz +0 -0
  170. package/tsconfig.tsbuildinfo +0 -1
@@ -10,6 +10,7 @@ import { UUID } from '../uuid';
10
10
  import { ActionConfig, ActionConfigTypes } from './ActionConfig';
11
11
  import { FormConfig } from './FormConfig';
12
12
  import { PlainDate, SelectDateRangeValue } from './FieldValue';
13
+ import { EventIndex } from './EventIndex';
13
14
  export declare function ageToDate(age: number, asOfDate: PlainDate): string & import("zod").$brand<"PlainDate">;
14
15
  export declare function getDeclarationFields(configuration: EventConfig): FieldConfig[];
15
16
  export declare function getDeclarationPages(configuration: EventConfig): {
@@ -21,9 +22,8 @@ export declare function getDeclarationPages(configuration: EventConfig): {
21
22
  };
22
23
  requireCompletionToContinue: boolean;
23
24
  fields: FieldConfig[];
24
- type: "FORM";
25
- showClearButton?: boolean | undefined;
26
25
  conditional?: any;
26
+ type: "FORM";
27
27
  }[];
28
28
  export declare function getDeclaration(configuration: EventConfig): {
29
29
  label: {
@@ -40,9 +40,8 @@ export declare function getDeclaration(configuration: EventConfig): {
40
40
  };
41
41
  requireCompletionToContinue: boolean;
42
42
  fields: FieldConfig[];
43
- type: "FORM";
44
- showClearButton?: boolean | undefined;
45
43
  conditional?: any;
44
+ type: "FORM";
46
45
  }[];
47
46
  };
48
47
  export declare function isActionConfigType(type: ActionType): type is ActionConfigTypes;
@@ -52,6 +51,14 @@ export declare function getActionConfig({ eventConfiguration, actionType, custom
52
51
  customActionType?: string;
53
52
  }): ActionConfig | undefined;
54
53
  export declare function getCustomActionFields(eventConfiguration: EventConfig, customActionType: string): FieldConfig[];
54
+ /**
55
+ * Returns the fields configured for an action's confirmation dialog.
56
+ *
57
+ * Unlike review fields and supporting copy, NOTIFY does NOT fall back to the
58
+ * DECLARE config here: dialog fields always come from the action's own
59
+ * configuration entry.
60
+ */
61
+ export declare function getActionFormFields(eventConfiguration: EventConfig, actionType: ActionType, customActionType?: string): FieldConfig[];
55
62
  export declare function getPrintCertificatePages(configuration: EventConfig): ({
56
63
  id: string;
57
64
  title: {
@@ -61,9 +68,8 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
61
68
  };
62
69
  requireCompletionToContinue: boolean;
63
70
  fields: FieldConfig[];
64
- type: "FORM";
65
- showClearButton?: boolean | undefined;
66
71
  conditional?: any;
72
+ type: "FORM";
67
73
  } | {
68
74
  id: string;
69
75
  title: {
@@ -73,6 +79,7 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
73
79
  };
74
80
  requireCompletionToContinue: boolean;
75
81
  fields: FieldConfig[];
82
+ conditional?: any;
76
83
  type: "VERIFICATION";
77
84
  actions: {
78
85
  verify: {
@@ -102,8 +109,6 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
102
109
  };
103
110
  };
104
111
  };
105
- showClearButton?: boolean | undefined;
106
- conditional?: any;
107
112
  })[];
108
113
  export declare const getActionAnnotationFields: (actionConfig: ActionConfig) => FieldConfig[];
109
114
  export declare function getAllUniqueFields(eventConfig: EventConfig): FieldConfig[];
@@ -158,26 +163,47 @@ export declare function deepMerge<T extends Record<string, unknown>, K extends R
158
163
  export declare function findLastAssignmentAction(actions: Action[]): {
159
164
  id: string & import("zod").$brand<"UUID">;
160
165
  transactionId: string;
161
- createdByUserType: "user" | "system";
166
+ createdByUserType: "system" | "user";
162
167
  createdAt: string;
163
168
  createdBy: string;
169
+ createdByRole?: string | undefined;
170
+ createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
171
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
164
172
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
165
- status: "Requested" | "Accepted" | "Rejected";
166
- type: "REGISTER";
173
+ annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
174
+ status: "Accepted" | "Rejected" | "Requested";
175
+ originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
176
+ type: "CREATE";
177
+ } | {
178
+ id: string & import("zod").$brand<"UUID">;
179
+ transactionId: string;
180
+ createdByUserType: "system" | "user";
181
+ createdAt: string;
182
+ createdBy: string;
167
183
  createdByRole?: string | undefined;
168
184
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
169
185
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
186
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
170
187
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
188
+ status: "Accepted" | "Rejected" | "Requested";
171
189
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
172
- registrationNumber?: string | undefined;
190
+ type: "REJECT";
191
+ content: {
192
+ reason: string;
193
+ };
173
194
  } | {
174
195
  id: string & import("zod").$brand<"UUID">;
175
196
  transactionId: string;
176
- createdByUserType: "user" | "system";
197
+ createdByUserType: "system" | "user";
177
198
  createdAt: string;
178
199
  createdBy: string;
200
+ createdByRole?: string | undefined;
201
+ createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
202
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
179
203
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
180
- status: "Requested" | "Accepted" | "Rejected";
204
+ annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
205
+ status: "Accepted" | "Rejected" | "Requested";
206
+ originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
181
207
  type: "DUPLICATE_DETECTED";
182
208
  content: {
183
209
  duplicates: {
@@ -185,272 +211,265 @@ export declare function findLastAssignmentAction(actions: Action[]): {
185
211
  trackingId: string;
186
212
  }[];
187
213
  };
188
- createdByRole?: string | undefined;
189
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
190
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
191
- annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
192
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
193
214
  } | {
194
215
  id: string & import("zod").$brand<"UUID">;
195
216
  transactionId: string;
196
- createdByUserType: "user" | "system";
217
+ createdByUserType: "system" | "user";
197
218
  createdAt: string;
198
219
  createdBy: string;
199
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
200
- status: "Requested" | "Accepted" | "Rejected";
201
- type: "EDIT";
202
- content: {
203
- comment?: string | undefined;
204
- };
205
220
  createdByRole?: string | undefined;
206
221
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
207
222
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
223
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
208
224
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
225
+ status: "Accepted" | "Rejected" | "Requested";
209
226
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
227
+ type: "MARK_AS_NOT_DUPLICATE";
210
228
  } | {
211
229
  id: string & import("zod").$brand<"UUID">;
212
230
  transactionId: string;
213
- createdByUserType: "user" | "system";
231
+ createdByUserType: "system" | "user";
214
232
  createdAt: string;
215
233
  createdBy: string;
216
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
217
- status: "Requested" | "Accepted" | "Rejected";
218
- type: "PRINT_CERTIFICATE";
219
234
  createdByRole?: string | undefined;
220
235
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
221
236
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
237
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
222
238
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
239
+ status: "Accepted" | "Rejected" | "Requested";
223
240
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
241
+ type: "MARK_AS_DUPLICATE";
224
242
  content?: {
225
- templateId?: string | undefined;
226
- } | null | undefined;
243
+ duplicateOf: string & import("zod").$brand<"UUID">;
244
+ } | undefined;
227
245
  } | {
228
246
  id: string & import("zod").$brand<"UUID">;
229
247
  transactionId: string;
230
- createdByUserType: "user" | "system";
248
+ createdByUserType: "system" | "user";
231
249
  createdAt: string;
232
250
  createdBy: string;
233
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
234
- status: "Requested" | "Accepted" | "Rejected";
235
- type: "REQUEST_CORRECTION";
236
251
  createdByRole?: string | undefined;
237
252
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
238
253
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
254
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
239
255
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
256
+ status: "Accepted" | "Rejected" | "Requested";
240
257
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
258
+ type: "ARCHIVE";
259
+ content?: {
260
+ reason: string;
261
+ } | undefined;
241
262
  } | {
242
263
  id: string & import("zod").$brand<"UUID">;
243
264
  transactionId: string;
244
- createdByUserType: "user" | "system";
265
+ createdByUserType: "system" | "user";
245
266
  createdAt: string;
246
267
  createdBy: string;
247
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
248
- status: "Requested" | "Accepted" | "Rejected";
249
- type: "CUSTOM";
250
- customActionType: string;
251
268
  createdByRole?: string | undefined;
252
269
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
253
270
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
271
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
254
272
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
273
+ status: "Accepted" | "Rejected" | "Requested";
255
274
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
275
+ type: "UNARCHIVE";
256
276
  } | {
257
277
  id: string & import("zod").$brand<"UUID">;
258
278
  transactionId: string;
259
- createdByUserType: "user" | "system";
279
+ createdByUserType: "system" | "user";
260
280
  createdAt: string;
261
281
  createdBy: string;
262
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
263
- status: "Requested" | "Accepted" | "Rejected";
264
- type: "CREATE";
265
282
  createdByRole?: string | undefined;
266
283
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
267
284
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
285
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
268
286
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
287
+ status: "Accepted" | "Rejected" | "Requested";
269
288
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
289
+ type: "NOTIFY";
270
290
  } | {
271
291
  id: string & import("zod").$brand<"UUID">;
272
292
  transactionId: string;
273
- createdByUserType: "user" | "system";
293
+ createdByUserType: "system" | "user";
274
294
  createdAt: string;
275
295
  createdBy: string;
276
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
277
- status: "Requested" | "Accepted" | "Rejected";
278
- type: "REJECT";
279
- content: {
280
- reason: string;
281
- };
282
296
  createdByRole?: string | undefined;
283
297
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
284
298
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
299
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
285
300
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
301
+ status: "Accepted" | "Rejected" | "Requested";
286
302
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
303
+ type: "REGISTER";
304
+ registrationNumber?: string | undefined;
287
305
  } | {
288
306
  id: string & import("zod").$brand<"UUID">;
289
307
  transactionId: string;
290
- createdByUserType: "user" | "system";
308
+ createdByUserType: "system" | "user";
291
309
  createdAt: string;
292
310
  createdBy: string;
293
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
294
- status: "Requested" | "Accepted" | "Rejected";
295
- type: "MARK_AS_NOT_DUPLICATE";
296
311
  createdByRole?: string | undefined;
297
312
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
298
313
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
314
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
299
315
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
316
+ status: "Accepted" | "Rejected" | "Requested";
300
317
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
318
+ type: "DECLARE";
301
319
  } | {
302
320
  id: string & import("zod").$brand<"UUID">;
303
321
  transactionId: string;
304
- createdByUserType: "user" | "system";
322
+ createdByUserType: "system" | "user";
305
323
  createdAt: string;
306
324
  createdBy: string;
307
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
308
- status: "Requested" | "Accepted" | "Rejected";
309
- type: "MARK_AS_DUPLICATE";
310
325
  createdByRole?: string | undefined;
311
326
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
312
327
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
328
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
313
329
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
330
+ status: "Accepted" | "Rejected" | "Requested";
314
331
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
315
- content?: {
316
- duplicateOf: string & import("zod").$brand<"UUID">;
317
- } | undefined;
332
+ type: "ASSIGN";
333
+ assignedTo: string;
318
334
  } | {
319
335
  id: string & import("zod").$brand<"UUID">;
320
336
  transactionId: string;
321
- createdByUserType: "user" | "system";
337
+ createdByUserType: "system" | "user";
322
338
  createdAt: string;
323
339
  createdBy: string;
324
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
325
- status: "Requested" | "Accepted" | "Rejected";
326
- type: "ARCHIVE";
327
- content: {
328
- reason: string;
329
- };
330
340
  createdByRole?: string | undefined;
331
341
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
332
342
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
343
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
333
344
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
345
+ status: "Accepted" | "Rejected" | "Requested";
334
346
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
347
+ type: "REQUEST_CORRECTION";
335
348
  } | {
336
349
  id: string & import("zod").$brand<"UUID">;
337
350
  transactionId: string;
338
- createdByUserType: "user" | "system";
351
+ createdByUserType: "system" | "user";
339
352
  createdAt: string;
340
353
  createdBy: string;
341
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
342
- status: "Requested" | "Accepted" | "Rejected";
343
- type: "NOTIFY";
344
354
  createdByRole?: string | undefined;
345
355
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
346
356
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
357
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
347
358
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
359
+ status: "Accepted" | "Rejected" | "Requested";
348
360
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
361
+ type: "APPROVE_CORRECTION";
362
+ requestId: string;
363
+ content?: {
364
+ immediateCorrection?: boolean | undefined;
365
+ } | undefined;
349
366
  } | {
350
367
  id: string & import("zod").$brand<"UUID">;
351
368
  transactionId: string;
352
- createdByUserType: "user" | "system";
369
+ createdByUserType: "system" | "user";
353
370
  createdAt: string;
354
371
  createdBy: string;
355
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
356
- status: "Requested" | "Accepted" | "Rejected";
357
- type: "DECLARE";
358
372
  createdByRole?: string | undefined;
359
373
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
360
374
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
375
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
361
376
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
377
+ status: "Accepted" | "Rejected" | "Requested";
362
378
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
379
+ type: "REJECT_CORRECTION";
380
+ requestId: string;
381
+ content: {
382
+ reason: string;
383
+ };
363
384
  } | {
364
385
  id: string & import("zod").$brand<"UUID">;
365
386
  transactionId: string;
366
- createdByUserType: "user" | "system";
387
+ createdByUserType: "system" | "user";
367
388
  createdAt: string;
368
389
  createdBy: string;
369
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
370
- status: "Requested" | "Accepted" | "Rejected";
371
- type: "ASSIGN";
372
- assignedTo: string;
373
390
  createdByRole?: string | undefined;
374
391
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
375
392
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
393
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
376
394
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
395
+ status: "Accepted" | "Rejected" | "Requested";
377
396
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
397
+ type: "UNASSIGN";
378
398
  } | {
379
399
  id: string & import("zod").$brand<"UUID">;
380
400
  transactionId: string;
381
- createdByUserType: "user" | "system";
401
+ createdByUserType: "system" | "user";
382
402
  createdAt: string;
383
403
  createdBy: string;
384
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
385
- status: "Requested" | "Accepted" | "Rejected";
386
- type: "APPROVE_CORRECTION";
387
- requestId: string;
388
404
  createdByRole?: string | undefined;
389
405
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
390
406
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
407
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
391
408
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
409
+ status: "Accepted" | "Rejected" | "Requested";
392
410
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
411
+ type: "PRINT_CERTIFICATE";
393
412
  content?: {
394
- immediateCorrection?: boolean | undefined;
395
- } | undefined;
413
+ templateId?: string | undefined;
414
+ } | null | undefined;
396
415
  } | {
397
416
  id: string & import("zod").$brand<"UUID">;
398
417
  transactionId: string;
399
- createdByUserType: "user" | "system";
418
+ createdByUserType: "system" | "user";
400
419
  createdAt: string;
401
420
  createdBy: string;
402
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
403
- status: "Requested" | "Accepted" | "Rejected";
404
- type: "REJECT_CORRECTION";
405
- requestId: string;
406
- content: {
407
- reason: string;
408
- };
409
421
  createdByRole?: string | undefined;
410
422
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
411
423
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
424
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
412
425
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
426
+ status: "Accepted" | "Rejected" | "Requested";
413
427
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
428
+ type: "READ";
414
429
  } | {
415
430
  id: string & import("zod").$brand<"UUID">;
416
431
  transactionId: string;
417
- createdByUserType: "user" | "system";
432
+ createdByUserType: "system" | "user";
418
433
  createdAt: string;
419
434
  createdBy: string;
420
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
421
- status: "Requested" | "Accepted" | "Rejected";
422
- type: "UNASSIGN";
423
435
  createdByRole?: string | undefined;
424
436
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
425
437
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
438
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
426
439
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
440
+ status: "Accepted" | "Rejected" | "Requested";
427
441
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
442
+ type: "EDIT";
443
+ content?: {
444
+ comment?: string | undefined;
445
+ } | undefined;
428
446
  } | {
429
447
  id: string & import("zod").$brand<"UUID">;
430
448
  transactionId: string;
431
- createdByUserType: "user" | "system";
449
+ createdByUserType: "system" | "user";
432
450
  createdAt: string;
433
451
  createdBy: string;
434
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
435
- status: "Requested" | "Accepted" | "Rejected";
436
- type: "READ";
437
452
  createdByRole?: string | undefined;
438
453
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
439
454
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
455
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
440
456
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
457
+ status: "Accepted" | "Rejected" | "Requested";
441
458
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
459
+ type: "CUSTOM";
460
+ customActionType: string;
442
461
  } | {
443
462
  id: string & import("zod").$brand<"UUID">;
444
- createdBy: string;
445
463
  transactionId: string;
446
- createdByUserType: "user" | "system";
464
+ createdByUserType: "system" | "user";
447
465
  createdAt: string;
448
- type: "CUSTOM" | "NOTIFY" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION";
449
- status: "Rejected";
466
+ createdBy: string;
450
467
  createdByRole?: string | undefined;
451
468
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
452
469
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
453
470
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
471
+ type: "APPROVE_CORRECTION" | "ARCHIVE" | "CUSTOM" | "DECLARE" | "EDIT" | "NOTIFY" | "PRINT_CERTIFICATE" | "REGISTER" | "REJECT" | "REJECT_CORRECTION" | "REQUEST_CORRECTION" | "UNARCHIVE";
472
+ status: "Rejected";
454
473
  } | undefined;
455
474
  /**
456
475
  * Tell compiler that accessing record with arbitrary key might result to undefined
@@ -579,4 +598,14 @@ export declare function getCompleteActionDeclaration<T extends EventState | Acti
579
598
  export declare function getAcceptedActions(event: EventDocument): ActionDocument[];
580
599
  export declare function aggregateActionDeclarations(event: EventDocument): EventState;
581
600
  export declare function aggregateActionAnnotations(event: EventDocument): EventState;
601
+ /**
602
+ * 2.1. onwards secured fields have accepted conditionals.
603
+ * Secured fields are not present in EventIndex payload.
604
+ * When we derive @see EventIndex from @see EventDocument, we will have all the fields present.
605
+ *
606
+ * To keep the views consistent, and not to change if event.get gets triggered, we need to clean out the secured fields.
607
+ *
608
+ * @returns EventIndex without values that evaluate to secured: true.
609
+ */
610
+ export declare function dropSecuredDeclarationFields(eventConfig: EventConfig, eventIndex: EventIndex, validatorContext: ValidatorContext): EventIndex;
582
611
  //# sourceMappingURL=utils.d.ts.map
@@ -1,15 +1,17 @@
1
1
  import * as z from 'zod/v4';
2
2
  export declare const TriggerEvent: {
3
- readonly USER_CREATED: "user-created";
4
- readonly USER_UPDATED: "user-updated";
5
- readonly USERNAME_REMINDER: "username-reminder";
6
- readonly RESET_PASSWORD: "reset-password";
7
- readonly RESET_PASSWORD_BY_ADMIN: "reset-password-by-admin";
8
- readonly RESEND_INVITE: "resend-invite";
9
- readonly TWO_FA: "2fa";
10
- readonly ALL_USER_NOTIFICATION: "all-user-notification";
11
- readonly CHANGE_PHONE_NUMBER: "change-phone-number";
12
- readonly CHANGE_EMAIL_ADDRESS: "change-email-address";
3
+ readonly USER_CREATED: 'user-created';
4
+ readonly USER_UPDATED: 'user-updated';
5
+ readonly USERNAME_REMINDER: 'username-reminder';
6
+ readonly RESET_PASSWORD: 'reset-password';
7
+ readonly RESET_PASSWORD_BY_ADMIN: 'reset-password-by-admin';
8
+ readonly PASSWORD_RESET_LINK: 'password-reset-link';
9
+ readonly USERNAME_REMINDER_LINK: 'username-reminder-link';
10
+ readonly RESEND_INVITE: 'resend-invite';
11
+ readonly TWO_FA: '2fa';
12
+ readonly ALL_USER_NOTIFICATION: 'all-user-notification';
13
+ readonly CHANGE_PHONE_NUMBER: 'change-phone-number';
14
+ readonly CHANGE_EMAIL_ADDRESS: 'change-email-address';
13
15
  };
14
16
  export type TriggerEvent = (typeof TriggerEvent)[keyof typeof TriggerEvent];
15
17
  export declare const Recipient: z.ZodObject<{
@@ -113,6 +115,32 @@ export declare const TriggerPayload: {
113
115
  role: z.ZodString;
114
116
  }, z.core.$strip>;
115
117
  }, z.core.$strip>;
118
+ readonly "password-reset-link": z.ZodObject<{
119
+ recipient: z.ZodObject<{
120
+ name: z.ZodOptional<z.ZodObject<{
121
+ firstname: z.ZodString;
122
+ surname: z.ZodString;
123
+ middlename: z.ZodOptional<z.ZodString>;
124
+ }, z.core.$strip>>;
125
+ mobile: z.ZodOptional<z.ZodString>;
126
+ email: z.ZodOptional<z.ZodString>;
127
+ bcc: z.ZodOptional<z.ZodArray<z.ZodString>>;
128
+ }, z.core.$strip>;
129
+ token: z.ZodString;
130
+ }, z.core.$strip>;
131
+ readonly "username-reminder-link": z.ZodObject<{
132
+ recipient: z.ZodObject<{
133
+ name: z.ZodOptional<z.ZodObject<{
134
+ firstname: z.ZodString;
135
+ surname: z.ZodString;
136
+ middlename: z.ZodOptional<z.ZodString>;
137
+ }, z.core.$strip>>;
138
+ mobile: z.ZodOptional<z.ZodString>;
139
+ email: z.ZodOptional<z.ZodString>;
140
+ bcc: z.ZodOptional<z.ZodArray<z.ZodString>>;
141
+ }, z.core.$strip>;
142
+ token: z.ZodString;
143
+ }, z.core.$strip>;
116
144
  readonly "resend-invite": z.ZodObject<{
117
145
  recipient: z.ZodObject<{
118
146
  name: z.ZodOptional<z.ZodObject<{
@@ -184,13 +212,5 @@ export declare const TriggerPayload: {
184
212
  export type TriggerPayload = {
185
213
  [K in TriggerEvent]: z.infer<(typeof TriggerPayload)[K]>;
186
214
  };
187
- export declare function triggerUserEventNotification<T extends TriggerEvent>({ event, payload, countryConfigUrl, authHeader }: {
188
- event: T;
189
- payload: TriggerPayload[T];
190
- countryConfigUrl: string;
191
- authHeader: {
192
- Authorization: string;
193
- };
194
- }): Promise<Response>;
195
215
  export declare function parseUserEventTrigger<T extends TriggerEvent>(event: T, body: unknown): TriggerPayload[T];
196
216
  //# sourceMappingURL=UserNotifications.d.ts.map
@@ -0,0 +1,10 @@
1
+ import { TriggerEvent, TriggerPayload } from './UserNotifications';
2
+ export declare function triggerUserEventNotification<T extends TriggerEvent>({ event, payload, countryConfigUrl, authHeader }: {
3
+ event: T;
4
+ payload: TriggerPayload[T];
5
+ countryConfigUrl: string;
6
+ authHeader: {
7
+ Authorization: string;
8
+ };
9
+ }): Promise<Response>;
10
+ //# sourceMappingURL=dispatch.d.ts.map
@@ -1,2 +1,3 @@
1
1
  export * from './UserNotifications';
2
+ export * from './dispatch';
2
3
  //# sourceMappingURL=index.d.ts.map