@opencrvs/toolkit 2.1.0-rc.a74bce1 → 2.1.0-rc.aae3e77

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