@opencrvs/toolkit 2.0.1-rc.fed4de8 → 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 (169) hide show
  1. package/README.md +16 -0
  2. package/build.sh +14 -5
  3. package/create-countryconfig/index.js +412 -59
  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 -280
  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 +4619 -4737
  11. package/dist/commons/api/router.d.ts +4122 -2944
  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 +531 -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 +424 -379
  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 +139 -106
  54. package/dist/commons/notification/UserNotifications.d.ts +38 -23
  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 +341 -66
  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 +795 -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 +27 -0
  104. package/dist/environment/templates.d.ts.map +1 -0
  105. package/dist/environment/templates.js +164 -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 +191 -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 +18 -0
  116. package/dist/environment/utils.d.ts.map +1 -0
  117. package/dist/environment/utils.js +110 -0
  118. package/dist/events/deduplication.d.ts +1 -1
  119. package/dist/events/index.js +8106 -7390
  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 -5141
  125. package/dist/migrations/v2.0/merge-infrastructure-directory.js +3 -3
  126. package/dist/migrations/v2.0/migrate-application-config-url.js +4 -3
  127. package/dist/migrations/v2.0/remove-hearth-migrations.js +17 -7
  128. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +3 -0
  129. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +1 -0
  130. package/dist/migrations/v2.1/add-explicit-correction-flags.js +234 -0
  131. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
  132. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
  133. package/dist/migrations/v2.1/add-recovery-link-notifications.js +511 -0
  134. package/dist/migrations/v2.1/add-translations.d.ts +9 -0
  135. package/dist/migrations/v2.1/add-translations.d.ts.map +1 -0
  136. package/dist/migrations/v2.1/add-translations.js +213 -0
  137. package/dist/migrations/v2.1/enable-telemetry.d.ts +3 -0
  138. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
  139. package/dist/migrations/v2.1/enable-telemetry.js +438 -0
  140. package/dist/migrations/v2.1/index.d.ts +6 -0
  141. package/dist/migrations/v2.1/index.d.ts.map +1 -0
  142. package/dist/migrations/v2.1/index.js +1276 -0
  143. package/dist/notification/index.js +2011 -1446
  144. package/dist/scopes/index.d.ts +514 -168
  145. package/dist/scopes/index.js +342 -66
  146. package/dist/telemetry/index.d.ts +45 -0
  147. package/dist/telemetry/index.d.ts.map +1 -0
  148. package/dist/telemetry/index.js +39 -0
  149. package/dist/templates/charts-values/dependencies/values.override.yaml +4 -0
  150. package/dist/templates/charts-values/dependencies/values.yaml +82 -0
  151. package/dist/templates/charts-values/opencrvs-services/values.override.yaml +4 -0
  152. package/dist/templates/charts-values/opencrvs-services/values.yaml +78 -0
  153. package/dist/templates/charts-values/opentelemetry/values.yaml +95 -0
  154. package/dist/templates/charts-values/traefik/values.override.yaml +4 -0
  155. package/dist/templates/charts-values/traefik/values.yaml +129 -0
  156. package/dist/templates/inventory/inventory.template.yml +98 -0
  157. package/dist/translations/check.d.ts +19 -0
  158. package/dist/translations/check.d.ts.map +1 -0
  159. package/dist/translations/check.js +127 -0
  160. package/dist/verify/endpoints.d.ts +2 -0
  161. package/dist/verify/endpoints.d.ts.map +1 -0
  162. package/dist/verify/endpoints.js +345 -0
  163. package/opencrvs-toolkit-2.1.0-beta.tgz +0 -0
  164. package/package.json +25 -6
  165. package/tsconfig.build.json +11 -0
  166. package/tsconfig.build.tsbuildinfo +1 -0
  167. package/tsconfig.json +3 -0
  168. package/opencrvs-toolkit-2.0.1-rc.fed4de8.tgz +0 -0
  169. 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,8 +22,8 @@ export declare function getDeclarationPages(configuration: EventConfig): {
21
22
  };
22
23
  requireCompletionToContinue: boolean;
23
24
  fields: FieldConfig[];
24
- type: "FORM";
25
25
  conditional?: any;
26
+ type: "FORM";
26
27
  }[];
27
28
  export declare function getDeclaration(configuration: EventConfig): {
28
29
  label: {
@@ -39,8 +40,8 @@ export declare function getDeclaration(configuration: EventConfig): {
39
40
  };
40
41
  requireCompletionToContinue: boolean;
41
42
  fields: FieldConfig[];
42
- type: "FORM";
43
43
  conditional?: any;
44
+ type: "FORM";
44
45
  }[];
45
46
  };
46
47
  export declare function isActionConfigType(type: ActionType): type is ActionConfigTypes;
@@ -50,6 +51,14 @@ export declare function getActionConfig({ eventConfiguration, actionType, custom
50
51
  customActionType?: string;
51
52
  }): ActionConfig | undefined;
52
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[];
53
62
  export declare function getPrintCertificatePages(configuration: EventConfig): ({
54
63
  id: string;
55
64
  title: {
@@ -59,8 +68,8 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
59
68
  };
60
69
  requireCompletionToContinue: boolean;
61
70
  fields: FieldConfig[];
62
- type: "FORM";
63
71
  conditional?: any;
72
+ type: "FORM";
64
73
  } | {
65
74
  id: string;
66
75
  title: {
@@ -70,6 +79,7 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
70
79
  };
71
80
  requireCompletionToContinue: boolean;
72
81
  fields: FieldConfig[];
82
+ conditional?: any;
73
83
  type: "VERIFICATION";
74
84
  actions: {
75
85
  verify: {
@@ -99,7 +109,6 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
99
109
  };
100
110
  };
101
111
  };
102
- conditional?: any;
103
112
  })[];
104
113
  export declare const getActionAnnotationFields: (actionConfig: ActionConfig) => FieldConfig[];
105
114
  export declare function getAllUniqueFields(eventConfig: EventConfig): FieldConfig[];
@@ -154,26 +163,47 @@ export declare function deepMerge<T extends Record<string, unknown>, K extends R
154
163
  export declare function findLastAssignmentAction(actions: Action[]): {
155
164
  id: string & import("zod").$brand<"UUID">;
156
165
  transactionId: string;
157
- createdByUserType: "user" | "system";
166
+ createdByUserType: "system" | "user";
158
167
  createdAt: string;
159
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;
160
172
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
161
- status: "Requested" | "Accepted" | "Rejected";
162
- 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;
163
183
  createdByRole?: string | undefined;
164
184
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
165
185
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
186
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
166
187
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
188
+ status: "Accepted" | "Rejected" | "Requested";
167
189
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
168
- registrationNumber?: string | undefined;
190
+ type: "REJECT";
191
+ content: {
192
+ reason: string;
193
+ };
169
194
  } | {
170
195
  id: string & import("zod").$brand<"UUID">;
171
196
  transactionId: string;
172
- createdByUserType: "user" | "system";
197
+ createdByUserType: "system" | "user";
173
198
  createdAt: string;
174
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;
175
203
  declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
176
- 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;
177
207
  type: "DUPLICATE_DETECTED";
178
208
  content: {
179
209
  duplicates: {
@@ -181,272 +211,265 @@ export declare function findLastAssignmentAction(actions: Action[]): {
181
211
  trackingId: string;
182
212
  }[];
183
213
  };
184
- createdByRole?: string | undefined;
185
- createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
186
- createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
187
- annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
188
- originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
189
214
  } | {
190
215
  id: string & import("zod").$brand<"UUID">;
191
216
  transactionId: string;
192
- createdByUserType: "user" | "system";
217
+ createdByUserType: "system" | "user";
193
218
  createdAt: string;
194
219
  createdBy: string;
195
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
196
- status: "Requested" | "Accepted" | "Rejected";
197
- type: "EDIT";
198
- content: {
199
- comment?: string | undefined;
200
- };
201
220
  createdByRole?: string | undefined;
202
221
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
203
222
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
223
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
204
224
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
225
+ status: "Accepted" | "Rejected" | "Requested";
205
226
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
227
+ type: "MARK_AS_NOT_DUPLICATE";
206
228
  } | {
207
229
  id: string & import("zod").$brand<"UUID">;
208
230
  transactionId: string;
209
- createdByUserType: "user" | "system";
231
+ createdByUserType: "system" | "user";
210
232
  createdAt: string;
211
233
  createdBy: string;
212
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
213
- status: "Requested" | "Accepted" | "Rejected";
214
- type: "PRINT_CERTIFICATE";
215
234
  createdByRole?: string | undefined;
216
235
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
217
236
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
237
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
218
238
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
239
+ status: "Accepted" | "Rejected" | "Requested";
219
240
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
241
+ type: "MARK_AS_DUPLICATE";
220
242
  content?: {
221
- templateId?: string | undefined;
222
- } | null | undefined;
243
+ duplicateOf: string & import("zod").$brand<"UUID">;
244
+ } | undefined;
223
245
  } | {
224
246
  id: string & import("zod").$brand<"UUID">;
225
247
  transactionId: string;
226
- createdByUserType: "user" | "system";
248
+ createdByUserType: "system" | "user";
227
249
  createdAt: string;
228
250
  createdBy: string;
229
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
230
- status: "Requested" | "Accepted" | "Rejected";
231
- type: "REQUEST_CORRECTION";
232
251
  createdByRole?: string | undefined;
233
252
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
234
253
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
254
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
235
255
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
256
+ status: "Accepted" | "Rejected" | "Requested";
236
257
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
258
+ type: "ARCHIVE";
259
+ content?: {
260
+ reason: string;
261
+ } | undefined;
237
262
  } | {
238
263
  id: string & import("zod").$brand<"UUID">;
239
264
  transactionId: string;
240
- createdByUserType: "user" | "system";
265
+ createdByUserType: "system" | "user";
241
266
  createdAt: string;
242
267
  createdBy: string;
243
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
244
- status: "Requested" | "Accepted" | "Rejected";
245
- type: "CUSTOM";
246
- customActionType: string;
247
268
  createdByRole?: string | undefined;
248
269
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
249
270
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
271
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
250
272
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
273
+ status: "Accepted" | "Rejected" | "Requested";
251
274
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
275
+ type: "UNARCHIVE";
252
276
  } | {
253
277
  id: string & import("zod").$brand<"UUID">;
254
278
  transactionId: string;
255
- createdByUserType: "user" | "system";
279
+ createdByUserType: "system" | "user";
256
280
  createdAt: string;
257
281
  createdBy: string;
258
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
259
- status: "Requested" | "Accepted" | "Rejected";
260
- type: "CREATE";
261
282
  createdByRole?: string | undefined;
262
283
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
263
284
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
285
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
264
286
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
287
+ status: "Accepted" | "Rejected" | "Requested";
265
288
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
289
+ type: "NOTIFY";
266
290
  } | {
267
291
  id: string & import("zod").$brand<"UUID">;
268
292
  transactionId: string;
269
- createdByUserType: "user" | "system";
293
+ createdByUserType: "system" | "user";
270
294
  createdAt: string;
271
295
  createdBy: string;
272
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
273
- status: "Requested" | "Accepted" | "Rejected";
274
- type: "REJECT";
275
- content: {
276
- reason: string;
277
- };
278
296
  createdByRole?: string | undefined;
279
297
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
280
298
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
299
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
281
300
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
301
+ status: "Accepted" | "Rejected" | "Requested";
282
302
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
303
+ type: "REGISTER";
304
+ registrationNumber?: string | undefined;
283
305
  } | {
284
306
  id: string & import("zod").$brand<"UUID">;
285
307
  transactionId: string;
286
- createdByUserType: "user" | "system";
308
+ createdByUserType: "system" | "user";
287
309
  createdAt: string;
288
310
  createdBy: string;
289
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
290
- status: "Requested" | "Accepted" | "Rejected";
291
- type: "MARK_AS_NOT_DUPLICATE";
292
311
  createdByRole?: string | undefined;
293
312
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
294
313
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
314
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
295
315
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
316
+ status: "Accepted" | "Rejected" | "Requested";
296
317
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
318
+ type: "DECLARE";
297
319
  } | {
298
320
  id: string & import("zod").$brand<"UUID">;
299
321
  transactionId: string;
300
- createdByUserType: "user" | "system";
322
+ createdByUserType: "system" | "user";
301
323
  createdAt: string;
302
324
  createdBy: string;
303
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
304
- status: "Requested" | "Accepted" | "Rejected";
305
- type: "MARK_AS_DUPLICATE";
306
325
  createdByRole?: string | undefined;
307
326
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
308
327
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
328
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
309
329
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
330
+ status: "Accepted" | "Rejected" | "Requested";
310
331
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
311
- content?: {
312
- duplicateOf: string & import("zod").$brand<"UUID">;
313
- } | undefined;
332
+ type: "ASSIGN";
333
+ assignedTo: string;
314
334
  } | {
315
335
  id: string & import("zod").$brand<"UUID">;
316
336
  transactionId: string;
317
- createdByUserType: "user" | "system";
337
+ createdByUserType: "system" | "user";
318
338
  createdAt: string;
319
339
  createdBy: string;
320
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
321
- status: "Requested" | "Accepted" | "Rejected";
322
- type: "ARCHIVE";
323
- content: {
324
- reason: string;
325
- };
326
340
  createdByRole?: string | undefined;
327
341
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
328
342
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
343
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
329
344
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
345
+ status: "Accepted" | "Rejected" | "Requested";
330
346
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
347
+ type: "REQUEST_CORRECTION";
331
348
  } | {
332
349
  id: string & import("zod").$brand<"UUID">;
333
350
  transactionId: string;
334
- createdByUserType: "user" | "system";
351
+ createdByUserType: "system" | "user";
335
352
  createdAt: string;
336
353
  createdBy: string;
337
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
338
- status: "Requested" | "Accepted" | "Rejected";
339
- type: "NOTIFY";
340
354
  createdByRole?: string | undefined;
341
355
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
342
356
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
357
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
343
358
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
359
+ status: "Accepted" | "Rejected" | "Requested";
344
360
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
361
+ type: "APPROVE_CORRECTION";
362
+ requestId: string;
363
+ content?: {
364
+ immediateCorrection?: boolean | undefined;
365
+ } | undefined;
345
366
  } | {
346
367
  id: string & import("zod").$brand<"UUID">;
347
368
  transactionId: string;
348
- createdByUserType: "user" | "system";
369
+ createdByUserType: "system" | "user";
349
370
  createdAt: string;
350
371
  createdBy: string;
351
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
352
- status: "Requested" | "Accepted" | "Rejected";
353
- type: "DECLARE";
354
372
  createdByRole?: string | undefined;
355
373
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
356
374
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
375
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
357
376
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
377
+ status: "Accepted" | "Rejected" | "Requested";
358
378
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
379
+ type: "REJECT_CORRECTION";
380
+ requestId: string;
381
+ content: {
382
+ reason: string;
383
+ };
359
384
  } | {
360
385
  id: string & import("zod").$brand<"UUID">;
361
386
  transactionId: string;
362
- createdByUserType: "user" | "system";
387
+ createdByUserType: "system" | "user";
363
388
  createdAt: string;
364
389
  createdBy: string;
365
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
366
- status: "Requested" | "Accepted" | "Rejected";
367
- type: "ASSIGN";
368
- assignedTo: string;
369
390
  createdByRole?: string | undefined;
370
391
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
371
392
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
393
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
372
394
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
395
+ status: "Accepted" | "Rejected" | "Requested";
373
396
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
397
+ type: "UNASSIGN";
374
398
  } | {
375
399
  id: string & import("zod").$brand<"UUID">;
376
400
  transactionId: string;
377
- createdByUserType: "user" | "system";
401
+ createdByUserType: "system" | "user";
378
402
  createdAt: string;
379
403
  createdBy: string;
380
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
381
- status: "Requested" | "Accepted" | "Rejected";
382
- type: "APPROVE_CORRECTION";
383
- requestId: string;
384
404
  createdByRole?: string | undefined;
385
405
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
386
406
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
407
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
387
408
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
409
+ status: "Accepted" | "Rejected" | "Requested";
388
410
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
411
+ type: "PRINT_CERTIFICATE";
389
412
  content?: {
390
- immediateCorrection?: boolean | undefined;
391
- } | undefined;
413
+ templateId?: string | undefined;
414
+ } | null | undefined;
392
415
  } | {
393
416
  id: string & import("zod").$brand<"UUID">;
394
417
  transactionId: string;
395
- createdByUserType: "user" | "system";
418
+ createdByUserType: "system" | "user";
396
419
  createdAt: string;
397
420
  createdBy: string;
398
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
399
- status: "Requested" | "Accepted" | "Rejected";
400
- type: "REJECT_CORRECTION";
401
- requestId: string;
402
- content: {
403
- reason: string;
404
- };
405
421
  createdByRole?: string | undefined;
406
422
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
407
423
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
424
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
408
425
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
426
+ status: "Accepted" | "Rejected" | "Requested";
409
427
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
428
+ type: "READ";
410
429
  } | {
411
430
  id: string & import("zod").$brand<"UUID">;
412
431
  transactionId: string;
413
- createdByUserType: "user" | "system";
432
+ createdByUserType: "system" | "user";
414
433
  createdAt: string;
415
434
  createdBy: string;
416
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
417
- status: "Requested" | "Accepted" | "Rejected";
418
- type: "UNASSIGN";
419
435
  createdByRole?: string | undefined;
420
436
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
421
437
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
438
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
422
439
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
440
+ status: "Accepted" | "Rejected" | "Requested";
423
441
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
442
+ type: "EDIT";
443
+ content?: {
444
+ comment?: string | undefined;
445
+ } | undefined;
424
446
  } | {
425
447
  id: string & import("zod").$brand<"UUID">;
426
448
  transactionId: string;
427
- createdByUserType: "user" | "system";
449
+ createdByUserType: "system" | "user";
428
450
  createdAt: string;
429
451
  createdBy: string;
430
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
431
- status: "Requested" | "Accepted" | "Rejected";
432
- type: "READ";
433
452
  createdByRole?: string | undefined;
434
453
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
435
454
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
455
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
436
456
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
457
+ status: "Accepted" | "Rejected" | "Requested";
437
458
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
459
+ type: "CUSTOM";
460
+ customActionType: string;
438
461
  } | {
439
462
  id: string & import("zod").$brand<"UUID">;
440
- createdBy: string;
441
463
  transactionId: string;
442
- createdByUserType: "user" | "system";
464
+ createdByUserType: "system" | "user";
443
465
  createdAt: string;
444
- type: "CUSTOM" | "NOTIFY" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION";
445
- status: "Rejected";
466
+ createdBy: string;
446
467
  createdByRole?: string | undefined;
447
468
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
448
469
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
449
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";
450
473
  } | undefined;
451
474
  /**
452
475
  * Tell compiler that accessing record with arbitrary key might result to undefined
@@ -575,4 +598,14 @@ export declare function getCompleteActionDeclaration<T extends EventState | Acti
575
598
  export declare function getAcceptedActions(event: EventDocument): ActionDocument[];
576
599
  export declare function aggregateActionDeclarations(event: EventDocument): EventState;
577
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;
578
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,18 +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(args: {
188
- event: typeof TriggerEvent.ALL_USER_NOTIFICATION;
189
- payload: TriggerPayload[typeof TriggerEvent.ALL_USER_NOTIFICATION];
190
- countryConfigUrl: string;
191
- }): Promise<Response>;
192
- export declare function triggerUserEventNotification<T extends Exclude<TriggerEvent, typeof TriggerEvent.ALL_USER_NOTIFICATION>>(args: {
193
- event: T;
194
- payload: TriggerPayload[T];
195
- countryConfigUrl: string;
196
- authHeader: {
197
- Authorization: string;
198
- };
199
- }): Promise<Response>;
200
215
  export declare function parseUserEventTrigger<T extends TriggerEvent>(event: T, body: unknown): TriggerPayload[T];
201
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