@opencrvs/toolkit 2.0.1 → 2.1.0-beta.2

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