@opencrvs/toolkit 2.1.0-rc.30bcbde → 2.1.0-rc.343362d

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 (126) hide show
  1. package/README.md +1 -0
  2. package/build.sh +9 -1
  3. package/create-countryconfig/index.js +412 -59
  4. package/create-countryconfig/node_modules/.bin/degit +21 -0
  5. package/create-countryconfig/package.json +4 -1
  6. package/dist/application-config/index.js +341 -274
  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 +1782 -113
  11. package/dist/commons/api/router.d.ts +3897 -3263
  12. package/dist/commons/application-config/index.d.ts +6 -6
  13. package/dist/commons/conditionals/conditionals.d.ts +259 -2102
  14. package/dist/commons/conditionals/validate.d.ts +16 -5
  15. package/dist/commons/events/ActionConfig.d.ts +105 -105
  16. package/dist/commons/events/ActionDocument.d.ts +115 -121
  17. package/dist/commons/events/ActionInput.d.ts +4 -4
  18. package/dist/commons/events/ActionStatus.d.ts +14 -0
  19. package/dist/commons/events/ActionType.d.ts +62 -62
  20. package/dist/commons/events/AdvancedSearchConfig.d.ts +531 -507
  21. package/dist/commons/events/AuditLog.d.ts +189 -42
  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 +590 -590
  25. package/dist/commons/events/Draft.d.ts +37 -37
  26. package/dist/commons/events/DynamicFieldValue.d.ts +9 -9
  27. package/dist/commons/events/EventConfig.d.ts +8 -5
  28. package/dist/commons/events/EventDocument.d.ts +516 -48
  29. package/dist/commons/events/EventIndex.d.ts +49 -72
  30. package/dist/commons/events/EventMetadata.d.ts +39 -49
  31. package/dist/commons/events/EventStatus.d.ts +19 -0
  32. package/dist/commons/events/FieldConfig.d.ts +424 -389
  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 +817 -814
  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 +78 -895
  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 +247 -14
  48. package/dist/commons/events/mocks.test.utils.d.ts +48 -4
  49. package/dist/commons/events/scopes.d.ts +4 -4
  50. package/dist/commons/events/state/index.d.ts +17 -17
  51. package/dist/commons/events/state/utils.d.ts +7 -7
  52. package/dist/commons/events/test.utils.d.ts +64 -43
  53. package/dist/commons/events/utils.d.ts +125 -114
  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 +328 -58
  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/derived-variables.d.ts +119 -119
  62. package/dist/environment/derived-variables.d.ts.map +1 -1
  63. package/dist/environment/index.d.ts +1 -0
  64. package/dist/environment/index.d.ts.map +1 -1
  65. package/dist/environment/index.js +10 -0
  66. package/dist/environment/logger.d.ts +15 -3
  67. package/dist/environment/logger.d.ts.map +1 -1
  68. package/dist/environment/paths.d.ts +7 -0
  69. package/dist/environment/paths.d.ts.map +1 -0
  70. package/dist/environment/paths.js +72 -0
  71. package/dist/environment/questions.d.ts +75 -74
  72. package/dist/environment/questions.d.ts.map +1 -1
  73. package/dist/environment/questions.js +20 -14
  74. package/dist/environment/setup-environment.js +36 -21
  75. package/dist/environment/templates.d.ts.map +1 -1
  76. package/dist/environment/templates.js +2 -1
  77. package/dist/environment/update-workflows.d.ts.map +1 -1
  78. package/dist/environment/update-workflows.js +17 -5
  79. package/dist/environment/upgrade.d.ts +2 -0
  80. package/dist/environment/upgrade.d.ts.map +1 -0
  81. package/dist/environment/upgrade.js +82 -0
  82. package/dist/environment/users.js +11 -13
  83. package/dist/environment/utils.d.ts +1 -1
  84. package/dist/events/deduplication.d.ts +1 -1
  85. package/dist/events/index.js +7590 -7099
  86. package/dist/migrations/v2.0/checkout-upstream-files.d.ts +2 -2
  87. package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
  88. package/dist/migrations/v2.0/checkout-upstream-files.js +2 -2
  89. package/dist/migrations/v2.0/migrate-application-config-url.js +4 -3
  90. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +3 -0
  91. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +1 -0
  92. package/dist/migrations/v2.1/add-recovery-link-notifications.js +511 -0
  93. package/dist/migrations/v2.1/add-translations.d.ts +9 -0
  94. package/dist/migrations/v2.1/add-translations.d.ts.map +1 -0
  95. package/dist/migrations/v2.1/add-translations.js +213 -0
  96. package/dist/migrations/v2.1/enable-telemetry.d.ts +3 -0
  97. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +1 -0
  98. package/dist/migrations/v2.1/enable-telemetry.js +438 -0
  99. package/dist/migrations/v2.1/index.d.ts.map +1 -1
  100. package/dist/migrations/v2.1/index.js +1058 -0
  101. package/dist/notification/index.js +1859 -1459
  102. package/dist/scopes/index.d.ts +464 -169
  103. package/dist/scopes/index.js +329 -58
  104. package/dist/telemetry/index.d.ts +45 -0
  105. package/dist/telemetry/index.d.ts.map +1 -0
  106. package/dist/telemetry/index.js +39 -0
  107. package/dist/templates/charts-values/dependencies/values.yaml +2 -0
  108. package/dist/templates/charts-values/opencrvs-services/values.yaml +4 -3
  109. package/dist/templates/charts-values/opentelemetry/values.yaml +95 -0
  110. package/dist/templates/charts-values/traefik/values.yaml +23 -9
  111. package/dist/templates/inventory/inventory.template.yml +1 -3
  112. package/dist/translations/check.d.ts +21 -0
  113. package/dist/translations/check.d.ts.map +1 -0
  114. package/dist/translations/check.js +132 -0
  115. package/dist/verify/endpoints.d.ts +2 -0
  116. package/dist/verify/endpoints.d.ts.map +1 -0
  117. package/dist/verify/endpoints.js +345 -0
  118. package/opencrvs-toolkit-2.1.0-rc.343362d.tgz +0 -0
  119. package/package.json +12 -7
  120. package/tsconfig.build.json +11 -0
  121. package/tsconfig.build.tsbuildinfo +1 -0
  122. package/tsconfig.json +3 -0
  123. package/dist/templates/inventory/production.example.yml +0 -77
  124. package/dist/templates/inventory/qa.example.yml +0 -48
  125. package/opencrvs-toolkit-2.1.0-rc.30bcbde.tgz +0 -0
  126. 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;
@@ -67,8 +68,8 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
67
68
  };
68
69
  requireCompletionToContinue: boolean;
69
70
  fields: FieldConfig[];
70
- type: "FORM";
71
71
  conditional?: any;
72
+ type: "FORM";
72
73
  } | {
73
74
  id: string;
74
75
  title: {
@@ -78,6 +79,7 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
78
79
  };
79
80
  requireCompletionToContinue: boolean;
80
81
  fields: FieldConfig[];
82
+ conditional?: any;
81
83
  type: "VERIFICATION";
82
84
  actions: {
83
85
  verify: {
@@ -107,7 +109,6 @@ export declare function getPrintCertificatePages(configuration: EventConfig): ({
107
109
  };
108
110
  };
109
111
  };
110
- conditional?: any;
111
112
  })[];
112
113
  export declare const getActionAnnotationFields: (actionConfig: ActionConfig) => FieldConfig[];
113
114
  export declare function getAllUniqueFields(eventConfig: EventConfig): FieldConfig[];
@@ -162,313 +163,313 @@ export declare function deepMerge<T extends Record<string, unknown>, K extends R
162
163
  export declare function findLastAssignmentAction(actions: Action[]): {
163
164
  id: string & import("zod").$brand<"UUID">;
164
165
  transactionId: string;
165
- createdByUserType: "user" | "system";
166
+ createdByUserType: "system" | "user";
166
167
  createdAt: string;
167
168
  createdBy: string;
168
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
169
- status: "Requested" | "Accepted" | "Rejected";
170
- type: "REGISTER";
171
169
  createdByRole?: string | undefined;
172
170
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
173
171
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
172
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
174
173
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
174
+ status: "Accepted" | "Rejected" | "Requested";
175
175
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
176
- registrationNumber?: string | undefined;
176
+ type: "CREATE";
177
177
  } | {
178
178
  id: string & import("zod").$brand<"UUID">;
179
179
  transactionId: string;
180
- createdByUserType: "user" | "system";
180
+ createdByUserType: "system" | "user";
181
181
  createdAt: string;
182
182
  createdBy: string;
183
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
184
- status: "Requested" | "Accepted" | "Rejected";
185
- type: "DUPLICATE_DETECTED";
186
- content: {
187
- duplicates: {
188
- id: string & import("zod").$brand<"UUID">;
189
- trackingId: string;
190
- }[];
191
- };
192
183
  createdByRole?: string | undefined;
193
184
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
194
185
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
186
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
195
187
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
188
+ status: "Accepted" | "Rejected" | "Requested";
196
189
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
190
+ type: "REJECT";
191
+ content: {
192
+ reason: string;
193
+ };
197
194
  } | {
198
195
  id: string & import("zod").$brand<"UUID">;
199
196
  transactionId: string;
200
- createdByUserType: "user" | "system";
197
+ createdByUserType: "system" | "user";
201
198
  createdAt: string;
202
199
  createdBy: string;
203
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
204
- status: "Requested" | "Accepted" | "Rejected";
205
- type: "EDIT";
206
200
  createdByRole?: string | undefined;
207
201
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
208
202
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
203
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
209
204
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
205
+ status: "Accepted" | "Rejected" | "Requested";
210
206
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
211
- content?: {
212
- comment?: string | undefined;
213
- } | undefined;
207
+ type: "DUPLICATE_DETECTED";
208
+ content: {
209
+ duplicates: {
210
+ id: string & import("zod").$brand<"UUID">;
211
+ trackingId: string;
212
+ }[];
213
+ };
214
214
  } | {
215
215
  id: string & import("zod").$brand<"UUID">;
216
216
  transactionId: string;
217
- createdByUserType: "user" | "system";
217
+ createdByUserType: "system" | "user";
218
218
  createdAt: string;
219
219
  createdBy: string;
220
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
221
- status: "Requested" | "Accepted" | "Rejected";
222
- type: "PRINT_CERTIFICATE";
223
220
  createdByRole?: string | undefined;
224
221
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
225
222
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
223
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
226
224
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
225
+ status: "Accepted" | "Rejected" | "Requested";
227
226
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
228
- content?: {
229
- templateId?: string | undefined;
230
- } | null | undefined;
227
+ type: "MARK_AS_NOT_DUPLICATE";
231
228
  } | {
232
229
  id: string & import("zod").$brand<"UUID">;
233
230
  transactionId: string;
234
- createdByUserType: "user" | "system";
231
+ createdByUserType: "system" | "user";
235
232
  createdAt: string;
236
233
  createdBy: string;
237
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
238
- status: "Requested" | "Accepted" | "Rejected";
239
- type: "REQUEST_CORRECTION";
240
234
  createdByRole?: string | undefined;
241
235
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
242
236
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
237
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
243
238
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
239
+ status: "Accepted" | "Rejected" | "Requested";
244
240
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
241
+ type: "MARK_AS_DUPLICATE";
242
+ content?: {
243
+ duplicateOf: string & import("zod").$brand<"UUID">;
244
+ } | undefined;
245
245
  } | {
246
246
  id: string & import("zod").$brand<"UUID">;
247
247
  transactionId: string;
248
- createdByUserType: "user" | "system";
248
+ createdByUserType: "system" | "user";
249
249
  createdAt: string;
250
250
  createdBy: string;
251
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
252
- status: "Requested" | "Accepted" | "Rejected";
253
- type: "CUSTOM";
254
- customActionType: string;
255
251
  createdByRole?: string | undefined;
256
252
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
257
253
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
254
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
258
255
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
256
+ status: "Accepted" | "Rejected" | "Requested";
259
257
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
258
+ type: "ARCHIVE";
259
+ content?: {
260
+ reason: string;
261
+ } | undefined;
260
262
  } | {
261
263
  id: string & import("zod").$brand<"UUID">;
262
264
  transactionId: string;
263
- createdByUserType: "user" | "system";
265
+ createdByUserType: "system" | "user";
264
266
  createdAt: string;
265
267
  createdBy: string;
266
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
267
- status: "Requested" | "Accepted" | "Rejected";
268
- type: "CREATE";
269
268
  createdByRole?: string | undefined;
270
269
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
271
270
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
271
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
272
272
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
273
+ status: "Accepted" | "Rejected" | "Requested";
273
274
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
275
+ type: "UNARCHIVE";
274
276
  } | {
275
277
  id: string & import("zod").$brand<"UUID">;
276
278
  transactionId: string;
277
- createdByUserType: "user" | "system";
279
+ createdByUserType: "system" | "user";
278
280
  createdAt: string;
279
281
  createdBy: string;
280
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
281
- status: "Requested" | "Accepted" | "Rejected";
282
- type: "REJECT";
283
- content: {
284
- reason: string;
285
- };
286
282
  createdByRole?: string | undefined;
287
283
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
288
284
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
285
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
289
286
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
287
+ status: "Accepted" | "Rejected" | "Requested";
290
288
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
289
+ type: "NOTIFY";
291
290
  } | {
292
291
  id: string & import("zod").$brand<"UUID">;
293
292
  transactionId: string;
294
- createdByUserType: "user" | "system";
293
+ createdByUserType: "system" | "user";
295
294
  createdAt: string;
296
295
  createdBy: string;
297
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
298
- status: "Requested" | "Accepted" | "Rejected";
299
- type: "MARK_AS_NOT_DUPLICATE";
300
296
  createdByRole?: string | undefined;
301
297
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
302
298
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
299
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
303
300
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
301
+ status: "Accepted" | "Rejected" | "Requested";
304
302
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
303
+ type: "REGISTER";
304
+ registrationNumber?: string | undefined;
305
305
  } | {
306
306
  id: string & import("zod").$brand<"UUID">;
307
307
  transactionId: string;
308
- createdByUserType: "user" | "system";
308
+ createdByUserType: "system" | "user";
309
309
  createdAt: string;
310
310
  createdBy: string;
311
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
312
- status: "Requested" | "Accepted" | "Rejected";
313
- type: "MARK_AS_DUPLICATE";
314
311
  createdByRole?: string | undefined;
315
312
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
316
313
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
314
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
317
315
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
316
+ status: "Accepted" | "Rejected" | "Requested";
318
317
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
319
- content?: {
320
- duplicateOf: string & import("zod").$brand<"UUID">;
321
- } | undefined;
318
+ type: "DECLARE";
322
319
  } | {
323
320
  id: string & import("zod").$brand<"UUID">;
324
321
  transactionId: string;
325
- createdByUserType: "user" | "system";
322
+ createdByUserType: "system" | "user";
326
323
  createdAt: string;
327
324
  createdBy: string;
328
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
329
- status: "Requested" | "Accepted" | "Rejected";
330
- type: "ARCHIVE";
331
- content: {
332
- reason: string;
333
- };
334
325
  createdByRole?: string | undefined;
335
326
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
336
327
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
328
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
337
329
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
330
+ status: "Accepted" | "Rejected" | "Requested";
338
331
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
332
+ type: "ASSIGN";
333
+ assignedTo: string;
339
334
  } | {
340
335
  id: string & import("zod").$brand<"UUID">;
341
336
  transactionId: string;
342
- createdByUserType: "user" | "system";
337
+ createdByUserType: "system" | "user";
343
338
  createdAt: string;
344
339
  createdBy: string;
345
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
346
- status: "Requested" | "Accepted" | "Rejected";
347
- type: "UNARCHIVE";
348
340
  createdByRole?: string | undefined;
349
341
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
350
342
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
343
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
351
344
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
345
+ status: "Accepted" | "Rejected" | "Requested";
352
346
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
347
+ type: "REQUEST_CORRECTION";
353
348
  } | {
354
349
  id: string & import("zod").$brand<"UUID">;
355
350
  transactionId: string;
356
- createdByUserType: "user" | "system";
351
+ createdByUserType: "system" | "user";
357
352
  createdAt: string;
358
353
  createdBy: string;
359
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
360
- status: "Requested" | "Accepted" | "Rejected";
361
- type: "NOTIFY";
362
354
  createdByRole?: string | undefined;
363
355
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
364
356
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
357
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
365
358
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
359
+ status: "Accepted" | "Rejected" | "Requested";
366
360
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
361
+ type: "APPROVE_CORRECTION";
362
+ requestId: string;
363
+ content?: {
364
+ immediateCorrection?: boolean | undefined;
365
+ } | undefined;
367
366
  } | {
368
367
  id: string & import("zod").$brand<"UUID">;
369
368
  transactionId: string;
370
- createdByUserType: "user" | "system";
369
+ createdByUserType: "system" | "user";
371
370
  createdAt: string;
372
371
  createdBy: string;
373
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
374
- status: "Requested" | "Accepted" | "Rejected";
375
- type: "DECLARE";
376
372
  createdByRole?: string | undefined;
377
373
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
378
374
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
375
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
379
376
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
377
+ status: "Accepted" | "Rejected" | "Requested";
380
378
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
379
+ type: "REJECT_CORRECTION";
380
+ requestId: string;
381
+ content: {
382
+ reason: string;
383
+ };
381
384
  } | {
382
385
  id: string & import("zod").$brand<"UUID">;
383
386
  transactionId: string;
384
- createdByUserType: "user" | "system";
387
+ createdByUserType: "system" | "user";
385
388
  createdAt: string;
386
389
  createdBy: string;
387
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
388
- status: "Requested" | "Accepted" | "Rejected";
389
- type: "ASSIGN";
390
- assignedTo: string;
391
390
  createdByRole?: string | undefined;
392
391
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
393
392
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
393
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
394
394
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
395
+ status: "Accepted" | "Rejected" | "Requested";
395
396
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
397
+ type: "UNASSIGN";
396
398
  } | {
397
399
  id: string & import("zod").$brand<"UUID">;
398
400
  transactionId: string;
399
- createdByUserType: "user" | "system";
401
+ createdByUserType: "system" | "user";
400
402
  createdAt: string;
401
403
  createdBy: string;
402
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
403
- status: "Requested" | "Accepted" | "Rejected";
404
- type: "APPROVE_CORRECTION";
405
- requestId: string;
406
404
  createdByRole?: string | undefined;
407
405
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
408
406
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
407
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
409
408
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
409
+ status: "Accepted" | "Rejected" | "Requested";
410
410
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
411
+ type: "PRINT_CERTIFICATE";
411
412
  content?: {
412
- immediateCorrection?: boolean | undefined;
413
- } | undefined;
413
+ templateId?: string | undefined;
414
+ } | null | undefined;
414
415
  } | {
415
416
  id: string & import("zod").$brand<"UUID">;
416
417
  transactionId: string;
417
- createdByUserType: "user" | "system";
418
+ createdByUserType: "system" | "user";
418
419
  createdAt: string;
419
420
  createdBy: string;
420
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
421
- status: "Requested" | "Accepted" | "Rejected";
422
- type: "REJECT_CORRECTION";
423
- requestId: string;
424
- content: {
425
- reason: string;
426
- };
427
421
  createdByRole?: string | undefined;
428
422
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
429
423
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
424
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
430
425
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
426
+ status: "Accepted" | "Rejected" | "Requested";
431
427
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
428
+ type: "READ";
432
429
  } | {
433
430
  id: string & import("zod").$brand<"UUID">;
434
431
  transactionId: string;
435
- createdByUserType: "user" | "system";
432
+ createdByUserType: "system" | "user";
436
433
  createdAt: string;
437
434
  createdBy: string;
438
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
439
- status: "Requested" | "Accepted" | "Rejected";
440
- type: "UNASSIGN";
441
435
  createdByRole?: string | undefined;
442
436
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
443
437
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
438
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
444
439
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
440
+ status: "Accepted" | "Rejected" | "Requested";
445
441
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
442
+ type: "EDIT";
443
+ content?: {
444
+ comment?: string | undefined;
445
+ } | undefined;
446
446
  } | {
447
447
  id: string & import("zod").$brand<"UUID">;
448
448
  transactionId: string;
449
- createdByUserType: "user" | "system";
449
+ createdByUserType: "system" | "user";
450
450
  createdAt: string;
451
451
  createdBy: string;
452
- declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
453
- status: "Requested" | "Accepted" | "Rejected";
454
- type: "READ";
455
452
  createdByRole?: string | undefined;
456
453
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
457
454
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
455
+ declaration: Record<string, import("./FieldValue").FieldUpdateValue>;
458
456
  annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
457
+ status: "Accepted" | "Rejected" | "Requested";
459
458
  originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
459
+ type: "CUSTOM";
460
+ customActionType: string;
460
461
  } | {
461
462
  id: string & import("zod").$brand<"UUID">;
462
463
  transactionId: string;
463
- createdByUserType: "user" | "system";
464
+ createdByUserType: "system" | "user";
464
465
  createdAt: string;
465
466
  createdBy: string;
466
- type: "CUSTOM" | "NOTIFY" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "ARCHIVE" | "UNARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION";
467
- status: "Rejected";
468
467
  createdByRole?: string | undefined;
469
468
  createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
470
469
  createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
471
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";
472
473
  } | undefined;
473
474
  /**
474
475
  * Tell compiler that accessing record with arbitrary key might result to undefined
@@ -597,4 +598,14 @@ export declare function getCompleteActionDeclaration<T extends EventState | Acti
597
598
  export declare function getAcceptedActions(event: EventDocument): ActionDocument[];
598
599
  export declare function aggregateActionDeclarations(event: EventDocument): EventState;
599
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;
600
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