@opencrvs/toolkit 2.1.2 → 2.2.0-rc.19ec10b

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 (177) hide show
  1. package/build.sh +9 -14
  2. package/create-countryconfig/package.json +1 -1
  3. package/dist/application-config/index.js +57 -14
  4. package/dist/authentication/index.d.ts +2 -1
  5. package/dist/authentication/index.js +34 -14
  6. package/dist/cli.js +1491 -2020
  7. package/dist/commons/api/router.d.ts +1564 -248
  8. package/dist/commons/application-config/index.d.ts +3 -3
  9. package/dist/commons/conditionals/conditionals.d.ts +58 -7
  10. package/dist/commons/conditionals/index.d.ts +1 -0
  11. package/dist/commons/conditionals/validate.d.ts +6 -1
  12. package/dist/commons/events/ActionConfig.d.ts +146 -20
  13. package/dist/commons/events/ActionDocument.d.ts +89 -0
  14. package/dist/commons/events/ActionInput.d.ts +56 -4
  15. package/dist/commons/events/ActionStatus.d.ts +2 -2
  16. package/dist/commons/events/ActionType.d.ts +13 -1
  17. package/dist/commons/events/AdvancedSearchConfig.d.ts +15 -0
  18. package/dist/commons/events/AuditLog.d.ts +4 -0
  19. package/dist/commons/events/CompositeFieldValue.d.ts +5 -1
  20. package/dist/commons/events/CountryConfigQueryInput.d.ts +192 -18
  21. package/dist/commons/events/Draft.d.ts +36 -1
  22. package/dist/commons/events/EventConfig.d.ts +473 -6
  23. package/dist/commons/events/EventDocument.d.ts +90 -0
  24. package/dist/commons/events/EventIndex.d.ts +44 -6
  25. package/dist/commons/events/EventInput.d.ts +1 -0
  26. package/dist/commons/events/EventMetadata.d.ts +24 -1
  27. package/dist/commons/events/EventStatus.d.ts +1 -0
  28. package/dist/commons/events/FieldConfig.d.ts +11 -1
  29. package/dist/commons/events/FieldTypeMapping.d.ts +17 -17
  30. package/dist/commons/events/Flag.d.ts +1 -7
  31. package/dist/commons/events/PlainDate.d.ts +6 -0
  32. package/dist/commons/events/WorkqueueConfig.d.ts +224 -33
  33. package/dist/commons/events/defineConfig.d.ts +7 -2
  34. package/dist/commons/events/event.d.ts +20 -1
  35. package/dist/commons/events/eventConfigValidation.d.ts +26 -1
  36. package/dist/commons/events/field.d.ts +37 -0
  37. package/dist/commons/events/index.d.ts +3 -0
  38. package/dist/commons/events/locations.d.ts +1 -1
  39. package/dist/commons/events/scopes.d.ts +4 -1
  40. package/dist/commons/events/state/flags.d.ts +1 -1
  41. package/dist/commons/events/state/index.d.ts +11 -2
  42. package/dist/commons/events/state/utils.d.ts +11 -1
  43. package/dist/commons/events/test.utils.d.ts +89 -7
  44. package/dist/commons/events/toNotificationForm.d.ts +17 -0
  45. package/dist/commons/events/utils.d.ts +90 -10
  46. package/dist/commons/users/Role.d.ts +23 -0
  47. package/dist/commons/users/User.d.ts +263 -0
  48. package/dist/commons/users/authentication.d.ts +67 -0
  49. package/dist/commons/users/index.d.ts +5 -0
  50. package/dist/commons/users/roleValidations.d.ts +15 -0
  51. package/dist/commons/users/scopes.d.ts +1402 -0
  52. package/dist/commons/users/userReferences.d.ts +176 -0
  53. package/dist/conditionals/index.js +29 -9
  54. package/dist/environment/custom-types.d.ts +1 -0
  55. package/dist/environment/custom-types.d.ts.map +1 -1
  56. package/dist/environment/derived-variables.d.ts +24 -4
  57. package/dist/environment/derived-variables.d.ts.map +1 -1
  58. package/dist/environment/derived-variables.js +27 -4
  59. package/dist/environment/questions.d.ts +42 -9
  60. package/dist/environment/questions.d.ts.map +1 -1
  61. package/dist/environment/questions.js +71 -48
  62. package/dist/environment/registry.d.ts +15 -0
  63. package/dist/environment/registry.d.ts.map +1 -0
  64. package/dist/environment/registry.js +112 -0
  65. package/dist/environment/setup-environment.d.ts.map +1 -1
  66. package/dist/environment/setup-environment.js +165 -35
  67. package/dist/environment/templates.d.ts.map +1 -1
  68. package/dist/events/index.js +2050 -1156
  69. package/dist/migrations/add-notify-config.d.ts +40 -0
  70. package/dist/migrations/add-notify-config.d.ts.map +1 -0
  71. package/dist/migrations/add-notify-config.js +249 -0
  72. package/dist/migrations/index.d.ts +9 -0
  73. package/dist/migrations/index.d.ts.map +1 -0
  74. package/dist/migrations/index.js +1306 -0
  75. package/dist/migrations/move-declaration-to-declare-action.d.ts +38 -0
  76. package/dist/migrations/move-declaration-to-declare-action.d.ts.map +1 -0
  77. package/dist/migrations/move-declaration-to-declare-action.js +260 -0
  78. package/dist/migrations/{v2.1 → persistent}/add-translations.d.ts +7 -1
  79. package/dist/migrations/persistent/add-translations.d.ts.map +1 -0
  80. package/dist/migrations/{v2.1 → persistent}/add-translations.js +14 -12
  81. package/dist/migrations/persistent/check-upgrade-path.d.ts +36 -0
  82. package/dist/migrations/persistent/check-upgrade-path.d.ts.map +1 -0
  83. package/dist/migrations/persistent/check-upgrade-path.js +105 -0
  84. package/dist/migrations/persistent/update-toolkit-dependency.d.ts +7 -0
  85. package/dist/migrations/persistent/update-toolkit-dependency.d.ts.map +1 -0
  86. package/dist/migrations/persistent/update-toolkit-dependency.js +77 -0
  87. package/dist/migrations/read-declaration-through-helper.d.ts +39 -0
  88. package/dist/migrations/read-declaration-through-helper.d.ts.map +1 -0
  89. package/dist/migrations/read-declaration-through-helper.js +199 -0
  90. package/dist/migrations/replace-incomplete-flag.d.ts +26 -0
  91. package/dist/migrations/replace-incomplete-flag.d.ts.map +1 -0
  92. package/dist/migrations/replace-incomplete-flag.js +126 -0
  93. package/dist/migrations/resolve-versioned-event-config.d.ts +56 -0
  94. package/dist/migrations/resolve-versioned-event-config.d.ts.map +1 -0
  95. package/dist/migrations/resolve-versioned-event-config.js +353 -0
  96. package/dist/migrations/utils.d.ts +61 -0
  97. package/dist/migrations/utils.d.ts.map +1 -0
  98. package/dist/migrations/utils.js +218 -0
  99. package/dist/notification/index.js +1081 -209
  100. package/dist/roles/index.d.ts +2 -0
  101. package/dist/roles/index.d.ts.map +1 -0
  102. package/dist/roles/index.js +730 -0
  103. package/dist/scopes/index.d.ts +83 -100
  104. package/dist/scopes/index.js +29 -13
  105. package/dist/templates/charts-values/dependencies/values.yaml +6 -3
  106. package/dist/templates/charts-values/opencrvs-services/values.yaml +5 -10
  107. package/dist/templates/charts-values/traefik/values.yaml +4 -3
  108. package/dist/verify/endpoints.d.ts +11 -0
  109. package/dist/verify/endpoints.d.ts.map +1 -1
  110. package/dist/verify/endpoints.js +21 -27
  111. package/opencrvs-toolkit-2.2.0-rc.19ec10b.tgz +0 -0
  112. package/package.json +5 -3
  113. package/tsconfig.build.tsbuildinfo +1 -1
  114. package/tsconfig.json +3 -5
  115. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts +0 -3
  116. package/dist/migrations/v2.1/add-explicit-correction-flags.d.ts.map +0 -1
  117. package/dist/migrations/v2.1/add-explicit-correction-flags.js +0 -234
  118. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts +0 -3
  119. package/dist/migrations/v2.1/add-recovery-link-notifications.d.ts.map +0 -1
  120. package/dist/migrations/v2.1/add-recovery-link-notifications.js +0 -511
  121. package/dist/migrations/v2.1/add-translations.d.ts.map +0 -1
  122. package/dist/migrations/v2.1/enable-telemetry.d.ts +0 -3
  123. package/dist/migrations/v2.1/enable-telemetry.d.ts.map +0 -1
  124. package/dist/migrations/v2.1/enable-telemetry.js +0 -455
  125. package/dist/migrations/v2.1/index.d.ts +0 -6
  126. package/dist/migrations/v2.1/index.d.ts.map +0 -1
  127. package/dist/migrations/v2.1/index.js +0 -2170
  128. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts +0 -14
  129. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.d.ts.map +0 -1
  130. package/dist/migrations/v2.1/migrate-infrastructure-to-assets.js +0 -348
  131. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts +0 -2
  132. package/dist/migrations/v2.1/remove-metabase-package-installs.d.ts.map +0 -1
  133. package/dist/migrations/v2.1/remove-metabase-package-installs.js +0 -161
  134. package/dist/migrations/v2.1/remove-sentry.d.ts +0 -3
  135. package/dist/migrations/v2.1/remove-sentry.d.ts.map +0 -1
  136. package/dist/migrations/v2.1/remove-sentry.js +0 -354
  137. package/dist/migrations/v2.1/rename-trigger-paths.d.ts +0 -3
  138. package/dist/migrations/v2.1/rename-trigger-paths.d.ts.map +0 -1
  139. package/dist/migrations/v2.1/rename-trigger-paths.js +0 -216
  140. package/dist/migrations/v2.1/template-files.d.ts +0 -8
  141. package/dist/migrations/v2.1/template-files.d.ts.map +0 -1
  142. package/dist/migrations/v2.1/template-files.js +0 -49
  143. package/dist/migrations/v2.1/upgrade-tilt.d.ts +0 -8
  144. package/dist/migrations/v2.1/upgrade-tilt.d.ts.map +0 -1
  145. package/dist/migrations/v2.1/upgrade-tilt.js +0 -139
  146. package/dist/templates/countryconfig-template/.tiltignore +0 -1
  147. package/dist/templates/countryconfig-template/Dockerfile.assets +0 -7
  148. package/dist/templates/countryconfig-template/Tiltfile +0 -112
  149. package/dist/templates/countryconfig-template/assets/README.md +0 -1
  150. package/dist/templates/countryconfig-template/assets/clear-all-data-dev.sh +0 -61
  151. package/dist/templates/countryconfig-template/assets/deployment/deploy.sh +0 -455
  152. package/dist/templates/countryconfig-template/assets/deployment/reindex.sh +0 -168
  153. package/dist/templates/countryconfig-template/assets/deployment/validate-required-variables-in-compose-files.ts +0 -67
  154. package/dist/templates/countryconfig-template/assets/elasticsearch/reindex.sh +0 -168
  155. package/dist/templates/countryconfig-template/assets/metabase/README.md +0 -34
  156. package/dist/templates/countryconfig-template/assets/metabase/environment-configuration.sql +0 -36
  157. package/dist/templates/countryconfig-template/assets/metabase/initialize-database.sh +0 -46
  158. package/dist/templates/countryconfig-template/assets/metabase/metabase.init.db.sql +0 -27737
  159. package/dist/templates/countryconfig-template/assets/metabase/open-shell.sh +0 -21
  160. package/dist/templates/countryconfig-template/assets/metabase/package.json +0 -13
  161. package/dist/templates/countryconfig-template/assets/metabase/run-dev.sh +0 -108
  162. package/dist/templates/countryconfig-template/assets/metabase/run.sh +0 -120
  163. package/dist/templates/countryconfig-template/assets/metabase/update-database.sh +0 -40
  164. package/dist/templates/countryconfig-template/assets/postgres/setup-analytics.sh +0 -135
  165. package/dist/templates/countryconfig-template/assets/postgres/setup-reference-data.sh +0 -108
  166. package/dist/templates/countryconfig-template/tilt/clear-all-data.ps1 +0 -50
  167. package/dist/templates/countryconfig-template/tilt/clear-all-data.sh +0 -35
  168. package/dist/templates/countryconfig-template/tilt/common.tilt +0 -145
  169. package/dist/templates/countryconfig-template/tilt/examples/dependencies/values.yaml +0 -15
  170. package/dist/templates/countryconfig-template/tilt/examples/opencrvs-services/values.yaml +0 -56
  171. package/dist/templates/countryconfig-template/tilt/examples/traefik/values-minikube.yaml +0 -21
  172. package/dist/templates/countryconfig-template/tilt/examples/traefik/values.yaml +0 -38
  173. package/dist/templates/countryconfig-template/tilt/helm/dependencies/values.yaml +0 -17
  174. package/dist/templates/countryconfig-template/tilt/helm/opencrvs-services/values.yaml +0 -16
  175. package/dist/templates/countryconfig-template/tilt/lib.tilt +0 -95
  176. package/dist/templates/countryconfig-template/tilt/opencrvs.tilt +0 -136
  177. package/opencrvs-toolkit-2.1.2.tgz +0 -0
@@ -37,6 +37,7 @@ export declare function field(fieldId: string, options?: {
37
37
  validations?: ValidationConfig[];
38
38
  searchCriteriaLabelPrefix?: TranslationConfig;
39
39
  allowedLocations?: JurisdictionReference;
40
+ defaultValue?: boolean | string | number;
40
41
  }): {
41
42
  $$field: string;
42
43
  $$subfield: string[];
@@ -57,6 +58,8 @@ export declare function field(fieldId: string, options?: {
57
58
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
58
59
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
59
60
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
61
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
62
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
60
63
  };
61
64
  date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
62
65
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -67,6 +70,8 @@ export declare function field(fieldId: string, options?: {
67
70
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
68
71
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
69
72
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
73
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
74
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
70
75
  };
71
76
  date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
72
77
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -96,6 +101,8 @@ export declare function field(fieldId: string, options?: {
96
101
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
97
102
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
98
103
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
104
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
105
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
99
106
  };
100
107
  date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
101
108
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -106,6 +113,8 @@ export declare function field(fieldId: string, options?: {
106
113
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
107
114
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
108
115
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
116
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
117
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
109
118
  };
110
119
  date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
111
120
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -140,6 +149,8 @@ export declare function field(fieldId: string, options?: {
140
149
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
141
150
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
142
151
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
152
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
153
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
143
154
  };
144
155
  date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
145
156
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -150,6 +161,8 @@ export declare function field(fieldId: string, options?: {
150
161
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
151
162
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
152
163
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
164
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
165
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
153
166
  };
154
167
  date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
155
168
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -188,6 +201,8 @@ export declare function field(fieldId: string, options?: {
188
201
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
189
202
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
190
203
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
204
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
205
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
191
206
  };
192
207
  date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
193
208
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -198,6 +213,8 @@ export declare function field(fieldId: string, options?: {
198
213
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
199
214
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
200
215
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
216
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
217
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
201
218
  };
202
219
  date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
203
220
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -227,6 +244,8 @@ export declare function field(fieldId: string, options?: {
227
244
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
228
245
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
229
246
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
247
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
248
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
230
249
  };
231
250
  date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
232
251
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -237,6 +256,8 @@ export declare function field(fieldId: string, options?: {
237
256
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
238
257
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
239
258
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
259
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
260
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
240
261
  };
241
262
  date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
242
263
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -275,6 +296,8 @@ export declare function field(fieldId: string, options?: {
275
296
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
276
297
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
277
298
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
299
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
300
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
278
301
  };
279
302
  date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
280
303
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -285,6 +308,8 @@ export declare function field(fieldId: string, options?: {
285
308
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
286
309
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
287
310
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
311
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
312
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
288
313
  };
289
314
  date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
290
315
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -314,6 +339,8 @@ export declare function field(fieldId: string, options?: {
314
339
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
315
340
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
316
341
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
342
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
343
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
317
344
  };
318
345
  date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
319
346
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -324,6 +351,8 @@ export declare function field(fieldId: string, options?: {
324
351
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
325
352
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
326
353
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
354
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
355
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
327
356
  };
328
357
  date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
329
358
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -351,6 +380,8 @@ export declare function field(fieldId: string, options?: {
351
380
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
352
381
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
353
382
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
383
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
384
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
354
385
  };
355
386
  date: (date: string | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
356
387
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -361,6 +392,8 @@ export declare function field(fieldId: string, options?: {
361
392
  inFuture: () => import("../conditionals/conditionals").JSONSchema;
362
393
  fromDate: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
363
394
  fromNow: () => import("../conditionals/conditionals").JSONSchema;
395
+ beforeAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
396
+ afterAction: (action: import("../conditionals/conditionals").ActionDateReference) => import("../conditionals/conditionals").JSONSchema;
364
397
  };
365
398
  date: (date: `${string}-${string}-${string}` | import("./FieldConfig").FieldReference) => import("../conditionals/conditionals").JSONSchema;
366
399
  now: () => import("../conditionals/conditionals").JSONSchema;
@@ -387,6 +420,7 @@ export declare function field(fieldId: string, options?: {
387
420
  validations?: ValidationConfig[];
388
421
  searchCriteriaLabelPrefix?: TranslationConfig;
389
422
  allowedLocations?: JurisdictionReference;
423
+ defaultValue?: boolean | string | number;
390
424
  fieldId: string;
391
425
  fieldType: 'field';
392
426
  } & {
@@ -400,6 +434,7 @@ export declare function field(fieldId: string, options?: {
400
434
  validations?: ValidationConfig[];
401
435
  searchCriteriaLabelPrefix?: TranslationConfig;
402
436
  allowedLocations?: JurisdictionReference;
437
+ defaultValue?: boolean | string | number;
403
438
  fieldId: string;
404
439
  fieldType: 'field';
405
440
  } & {
@@ -413,6 +448,7 @@ export declare function field(fieldId: string, options?: {
413
448
  validations?: ValidationConfig[];
414
449
  searchCriteriaLabelPrefix?: TranslationConfig;
415
450
  allowedLocations?: JurisdictionReference;
451
+ defaultValue?: boolean | string | number;
416
452
  fieldId: string;
417
453
  fieldType: 'field';
418
454
  } & {
@@ -426,6 +462,7 @@ export declare function field(fieldId: string, options?: {
426
462
  validations?: ValidationConfig[];
427
463
  searchCriteriaLabelPrefix?: TranslationConfig;
428
464
  allowedLocations?: JurisdictionReference;
465
+ defaultValue?: boolean | string | number;
429
466
  fieldId: string;
430
467
  fieldType: 'field';
431
468
  } & {
@@ -1,3 +1,4 @@
1
+ import 'zod/compile';
1
2
  export * from './AuditLog';
2
3
  export * from './Constants';
3
4
  export * from './ActionConfig';
@@ -25,6 +26,7 @@ export * from './state';
25
26
  export * from './state/flags';
26
27
  export * from './utils';
27
28
  export * from './defineConfig';
29
+ export * from './toNotificationForm';
28
30
  export * from './DeduplicationConfig';
29
31
  export * from './transactions';
30
32
  export * from './FieldType';
@@ -46,6 +48,7 @@ export * from './Flag';
46
48
  export * from './event';
47
49
  export * from './locations';
48
50
  export * from './locationPayloads';
51
+ export * from './PlainDate';
49
52
  export { UUID } from '../uuid';
50
53
  export { DocumentPath } from '../documents';
51
54
  //# sourceMappingURL=index.d.ts.map
@@ -3,7 +3,7 @@ import * as z from 'zod/v4';
3
3
  import { PlainDate } from './PlainDate';
4
4
  import { EventIndex } from './EventIndex';
5
5
  import { ActionCreationMetadata, RegistrationCreationMetadata } from './EventMetadata';
6
- import { RecordScopeV2, UserScopeV2 } from '../scopes';
6
+ import { RecordScopeV2, UserScopeV2 } from '../users/scopes';
7
7
  import { SystemContext, UserContext } from '../users/User';
8
8
  /** @deprecated Moving on, location types are arbitrary and defined by the country config. */
9
9
  export declare const LocationTypeV1: z.ZodEnum<{
@@ -1,5 +1,5 @@
1
1
  import { DisplayableAction } from './ActionType';
2
- import { EncodedScope, RecordScopeTypeV2, ScopeType, UserScopeV2 } from '../scopes';
2
+ import { EncodedScope, RecordScopeTypeV2, ScopeType, UserScopeV2 } from '../users/scopes';
3
3
  import { EventIndexWithAdministrativeHierarchy } from './locations';
4
4
  import { UserContext } from '../users/User';
5
5
  import { EventIndex } from './EventIndex';
@@ -15,8 +15,11 @@ export declare const ACTION_SCOPE_MAP: {
15
15
  PRINT_CERTIFICATE: "record.print-certified-copies"[];
16
16
  REQUEST_CORRECTION: ("record.correct" | "record.request-correction")[];
17
17
  REVIEW_CORRECTION_REQUEST: "record.correct"[];
18
+ CONTINUE_DRAFT: never[];
18
19
  REJECT_CORRECTION: "record.correct"[];
19
20
  APPROVE_CORRECTION: "record.correct"[];
21
+ REVOKE_REGISTRATION: "record.revoke-registration"[];
22
+ REINSTATE_REGISTRATION: "record.reinstate-registration"[];
20
23
  MARK_AS_DUPLICATE: "record.review-duplicates"[];
21
24
  MARK_AS_NOT_DUPLICATE: "record.review-duplicates"[];
22
25
  ARCHIVE: "record.archive"[];
@@ -27,7 +27,7 @@ export declare function resolveEventCustomFlags(event: EventDocument, eventConfi
27
27
  *
28
28
  * Flags are determined by combining:
29
29
  * - Action status flags (format 'ActionType:ActionStatus')
30
- * - Inherent flags (e.g. incomplete, rejected, correction requested, potential duplicate, edit in progress)
30
+ * - Inherent flags (e.g. rejected, correction requested, potential duplicate, edit in progress)
31
31
  * - Event type-specific custom flags defined in the event configuration
32
32
  *
33
33
  * @param event - The EventDocument containing the action history and payload
@@ -7,7 +7,7 @@ import { Draft } from '../Draft';
7
7
  import { EventConfig } from '../EventConfig';
8
8
  import { UUID } from '../../uuid';
9
9
  import { DocumentPath } from '../../documents';
10
- export declare function getStatusFromActions(actions: Array<Action>): "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED";
10
+ export declare function getStatusFromActions(actions: Array<Action>): "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED" | "REVOKED";
11
11
  export declare function getAssignedUserFromActions(actions: Array<ActionDocument>): string | null;
12
12
  type NonNullableDeep<T> = T extends [unknown, ...unknown[]] ? {
13
13
  [K in keyof T]: NonNullableDeep<NonNullable<T[K]>>;
@@ -63,7 +63,8 @@ export declare function applyDeclarationToEventIndex(eventIndex: EventIndex, dec
63
63
  export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Draft, eventConfiguration: EventConfig): {
64
64
  id: string & import("zod").$brand<"UUID">;
65
65
  type: string;
66
- status: "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED";
66
+ configVersionId: string;
67
+ status: "ARCHIVED" | "CREATED" | "DECLARED" | "NOTIFIED" | "REGISTERED" | "REVOKED";
67
68
  legalStatuses: {
68
69
  NOTIFIED?: {
69
70
  createdAt: string;
@@ -90,6 +91,14 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
90
91
  createdByRole?: string | undefined;
91
92
  registrationNumber: string;
92
93
  } | null | undefined;
94
+ REVOKED?: {
95
+ createdAt: string;
96
+ createdBy: string;
97
+ createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
98
+ createdByUserType?: "system" | "user" | null | undefined;
99
+ acceptedAt: string;
100
+ createdByRole?: string | undefined;
101
+ } | null | undefined;
93
102
  };
94
103
  createdAt: string;
95
104
  dateOfEvent?: string | null | undefined;
@@ -1,4 +1,5 @@
1
1
  import { Action } from '../ActionDocument';
2
+ import { EventStatus } from '../EventMetadata';
2
3
  /**
3
4
  * Returns the creation metadata of the last update action (Requested or Accepted).
4
5
  * Requested actions are included so that async flows (202) correctly reflect the
@@ -29,7 +30,7 @@ export declare function getActionUpdateMetadata(actions: Action[]): Pick<{
29
30
  * @returns the legal statuses of the event. Event is considered legal if it has been accepted.
30
31
  * @see EventIndex for the description of the returned object.
31
32
  */
32
- export declare function getLegalStatuses(actions: Action[]): {
33
+ export declare function getLegalStatuses(actions: Action[], status: EventStatus): {
33
34
  NOTIFIED: {
34
35
  createdAt: string;
35
36
  createdBy: string;
@@ -57,5 +58,14 @@ export declare function getLegalStatuses(actions: Action[]): {
57
58
  createdByRole: string | undefined;
58
59
  registrationNumber: string | null | undefined;
59
60
  } | null;
61
+ REVOKED: {
62
+ createdAt: string;
63
+ createdBy: string;
64
+ createdByUserType: "system" | "user";
65
+ createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
66
+ acceptedAt: string;
67
+ createdByRole: string | undefined;
68
+ registrationNumber: string | null | undefined;
69
+ } | null;
60
70
  };
61
71
  //# sourceMappingURL=utils.d.ts.map
@@ -1,15 +1,16 @@
1
1
  import { UUID } from '../uuid';
2
- import { ActionDocument, ActionUpdate } from './ActionDocument';
2
+ import { Action, ActionBase, ActionDocument, ActionStatus, ActionUpdate } from './ActionDocument';
3
3
  import { ValidatorContext } from '../conditionals/validate';
4
- import { ApproveCorrectionActionInput, ArchiveActionInput, AssignActionInput, DeclareActionInput, EditActionInput, MarkAsDuplicateActionInput, MarkNotDuplicateActionInput, NotifyActionInput, RegisterActionInput, RejectCorrectionActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnarchiveActionInput, UnassignActionInput } from './ActionInput';
4
+ import { ApproveCorrectionActionInput, ArchiveActionInput, AssignActionInput, DeclareActionInput, EditActionInput, MarkAsDuplicateActionInput, MarkNotDuplicateActionInput, NotifyActionInput, RegisterActionInput, RejectCorrectionActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnarchiveActionInput, UnassignActionInput, RevokeRegistrationActionInput, ReinstateRegistrationActionInput } from './ActionInput';
5
5
  import { ActionType } from './ActionType';
6
- import { Draft } from './Draft';
7
- import { EventConfig, EventConfigInput } from './EventConfig';
6
+ import { Draft, DraftInput, RemoteDraft } from './Draft';
7
+ import { EventConfig, EventConfigInput, VersionedEventConfig } from './EventConfig';
8
8
  import { EventDocument } from './EventDocument';
9
9
  import { EventIndex } from './EventIndex';
10
10
  import { EventInput } from './EventInput';
11
11
  import { TranslationConfig } from './TranslationConfig';
12
12
  import { FieldConfig } from './FieldConfig';
13
+ import { DeclarationFormConfig } from './FormConfig';
13
14
  import { LocationVersion, SetLocationPayload, SetAdministrativeAreaPayload, ClientAdministrativeArea } from './locations';
14
15
  import { WorkqueueConfig } from './WorkqueueConfig';
15
16
  import * as z from 'zod/v4';
@@ -97,7 +98,8 @@ export declare function eventPayloadGenerator(rng: () => number, configuration?:
97
98
  eventId: string;
98
99
  };
99
100
  /**
100
- * Notify allows sending incomplete data. Think it as 'partial declare' for now.
101
+ * NOTIFY submits the values of the notification form, and the record can stay incomplete.
102
+ * When `declaration` is not given, string values are left out of the generated declaration to make it incomplete.
101
103
  */
102
104
  notify: (eventId: string, input?: Partial<Pick<NotifyActionInput, 'transactionId' | 'declaration' | 'keepAssignment' | 'keepAssignmentIfRejected' | 'keepAssignmentIfAccepted' | 'waitFor'>>) => {
103
105
  type: "NOTIFY";
@@ -158,6 +160,28 @@ export declare function eventPayloadGenerator(rng: () => number, configuration?:
158
160
  annotation: {};
159
161
  eventId: string;
160
162
  };
163
+ revokeRegistration: (eventId: string, input?: Partial<Pick<RevokeRegistrationActionInput, 'transactionId' | 'annotation' | 'keepAssignment' | 'keepAssignmentIfRejected' | 'keepAssignmentIfAccepted' | 'waitFor'>>) => {
164
+ keepAssignment?: boolean | undefined;
165
+ keepAssignmentIfAccepted?: boolean | undefined;
166
+ keepAssignmentIfRejected?: boolean | undefined;
167
+ waitFor?: boolean | undefined;
168
+ type: "REVOKE_REGISTRATION";
169
+ transactionId: string;
170
+ declaration: {};
171
+ annotation: {};
172
+ eventId: string;
173
+ };
174
+ reinstateRegistration: (eventId: string, input?: Partial<Pick<ReinstateRegistrationActionInput, 'transactionId' | 'annotation' | 'keepAssignment' | 'keepAssignmentIfRejected' | 'keepAssignmentIfAccepted' | 'waitFor'>>) => {
175
+ keepAssignment?: boolean | undefined;
176
+ keepAssignmentIfAccepted?: boolean | undefined;
177
+ keepAssignmentIfRejected?: boolean | undefined;
178
+ waitFor?: boolean | undefined;
179
+ type: "REINSTATE_REGISTRATION";
180
+ transactionId: string;
181
+ declaration: {};
182
+ annotation: {};
183
+ eventId: string;
184
+ };
161
185
  reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, 'transactionId' | 'annotation' | 'keepAssignment' | 'keepAssignmentIfAccepted' | 'keepAssignmentIfRejected' | 'waitFor'>>) => {
162
186
  keepAssignment?: boolean | undefined;
163
187
  keepAssignmentIfAccepted?: boolean | undefined;
@@ -255,6 +279,13 @@ export declare function eventPayloadGenerator(rng: () => number, configuration?:
255
279
  };
256
280
  };
257
281
  };
282
+ /**
283
+ * Generates a single action document with exactly the given status (Accepted by default).
284
+ *
285
+ * For realistic data use `generateActionDocuments`, which also creates the Requested
286
+ * action the events service stores for a confirmable action. Use this one for edge
287
+ * cases, such as pending or rejected requests, or actions without an original request.
288
+ */
258
289
  export declare function generateActionDocument<T extends ActionType>({ configuration, action, rng, defaults, declarationOverrides }: {
259
290
  configuration: EventConfig;
260
291
  action: T;
@@ -264,6 +295,45 @@ export declare function generateActionDocument<T extends ActionType>({ configura
264
295
  }>>;
265
296
  declarationOverrides?: ActionUpdate;
266
297
  }): ActionDocument;
298
+ type GenerateActionDocumentsArgs<T extends ActionType> = Parameters<typeof generateActionDocument<T>>[0];
299
+ type ActionConfirmation<S extends ActionStatus> = {
300
+ status: S;
301
+ defaults?: Partial<ActionBase>;
302
+ };
303
+ /**
304
+ * Generates the action documents the events service stores for a single action.
305
+ *
306
+ * Mirrors the events service: a confirmable action is first stored as Requested,
307
+ * carrying the declaration and annotation, and then confirmed by a separate
308
+ * Accepted (or Rejected) action that points back to it through originalActionId.
309
+ * Other actions are stored once, as Accepted.
310
+ *
311
+ * `confirmation.status` picks the outcome of a confirmable action:
312
+ * - Accepted (default): [Requested, Accepted]
313
+ * - Rejected: [Requested, Rejected]
314
+ * - Requested: [Requested], i.e. still waiting for confirmation
315
+ *
316
+ * By default the request is confirmed synchronously, so both actions share the
317
+ * `transactionId`. `confirmation.defaults` apply to the confirming action only,
318
+ * e.g. a system user and a `transactionId` of its own for an asynchronous confirmation.
319
+ *
320
+ * The confirming action keeps the generated (or given) `id`, since references such
321
+ * as `requestId` of APPROVE_CORRECTION point to the accepted action.
322
+ *
323
+ * Use `generateActionDocument` instead to build a single action with an explicit status.
324
+ *
325
+ * Only a rejection yields an AsyncRejectActionDocument, so the result is typed
326
+ * as `ActionDocument[]` when `confirmation.status` is known not to be Rejected.
327
+ */
328
+ export declare function generateActionDocuments<T extends ActionType>(args: GenerateActionDocumentsArgs<T> & {
329
+ confirmation: ActionConfirmation<typeof ActionStatus.Rejected>;
330
+ }): Action[];
331
+ export declare function generateActionDocuments<T extends ActionType>(args: GenerateActionDocumentsArgs<T> & {
332
+ confirmation?: Partial<ActionConfirmation<typeof ActionStatus.Accepted | typeof ActionStatus.Requested>>;
333
+ }): ActionDocument[];
334
+ export declare function generateActionDocuments<T extends ActionType>(args: GenerateActionDocumentsArgs<T> & {
335
+ confirmation?: Partial<ActionConfirmation<ActionStatus>>;
336
+ }): Action[];
267
337
  export declare function generateRandomDatetime(rng: () => number, start: Date, end: Date): string;
268
338
  export declare function getRandomDate(rng: () => number, start: string, end: string): string;
269
339
  export declare function generateEventDocument({ configuration, actions, rng, defaults }: {
@@ -287,11 +357,11 @@ export declare function generateEventDocument({ configuration, actions, rng, def
287
357
  }): EventDocument;
288
358
  export declare function generateEventDraftDocument({ eventId, actionType, rng, declaration }: {
289
359
  eventId: UUID;
290
- actionType: ActionType;
360
+ actionType: DraftInput['type'];
291
361
  rng?: () => number;
292
362
  declaration?: ActionUpdate;
293
363
  annotation?: ActionUpdate;
294
- }): Draft;
364
+ }): RemoteDraft;
295
365
  /**
296
366
  * Useful for testing when we need deterministic outcome.
297
367
  * @param seed - Seed value for the pseudo-random number generator
@@ -328,6 +398,12 @@ export declare const generateEventConfig: ({ id, fields, placeOfEventId, dateOfE
328
398
  /** Extra actions appended to the default READ + DECLARE pair, e.g. a REQUEST_CORRECTION action with its own correctionForm. */
329
399
  actions?: EventConfigInput['actions'];
330
400
  }) => EventConfig;
401
+ /**
402
+ * The notification form is replaced too, since it may refer to fields of the replaced declaration.
403
+ *
404
+ * @returns a copy of the configuration with the DECLARE action's declaration replaced, and the NOTIFY action's notification form made from it.
405
+ */
406
+ export declare function withDeclaration(configuration: EventConfig, declaration: DeclarationFormConfig): EventConfig;
331
407
  /**
332
408
  * Get the leaf administrative area IDs from a list of administrative areas.
333
409
  *
@@ -344,4 +420,10 @@ export declare function generateTestValidatorContext(userRole?: TestUserRole, ev
344
420
  event: EventDocument;
345
421
  eventConfig: EventConfig;
346
422
  }): ValidatorContext;
423
+ /**
424
+ * Serves `config` as country config does: as the only version of its event.
425
+ * For mocking `/config/events` and `event.config.get` with a configuration built in a test.
426
+ */
427
+ export declare function toVersionedEventConfig({ id, label, advancedSearch, ...version }: EventConfig): VersionedEventConfig;
428
+ export {};
347
429
  //# sourceMappingURL=test.utils.d.ts.map
@@ -0,0 +1,17 @@
1
+ import * as z from 'zod/v4';
2
+ import { DeclarationFormConfig, DeclarationFormConfigInput } from './FormConfig';
3
+ import { DeclarationReviewConfig } from './ActionConfig';
4
+ type DeclarationReviewConfigInput = z.input<typeof DeclarationReviewConfig>;
5
+ type DeclarationReviewConfigOutput = z.infer<typeof DeclarationReviewConfig>;
6
+ /**
7
+ * NOTIFY submits incomplete records, and its notification form is validated like any form.
8
+ *
9
+ * @returns a copy of the declaration form with every field optional and without validations, to use as the NOTIFY `notificationForm`.
10
+ */
11
+ export declare function toNotificationForm<F extends DeclarationFormConfig | DeclarationFormConfigInput>(declaration: F): F;
12
+ /**
13
+ * @returns a copy of the DECLARE review with every field optional and without validations, to use as the NOTIFY `review`.
14
+ */
15
+ export declare function toNotificationReview<R extends DeclarationReviewConfigOutput | DeclarationReviewConfigInput>(review: R): R;
16
+ export {};
17
+ //# sourceMappingURL=toNotificationForm.d.ts.map