@opencrvs/toolkit 1.8.0-rc.fb8e005 → 1.8.0-rc.fbababd

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 (32) hide show
  1. package/dist/commons/api/router.d.ts +8621 -5643
  2. package/dist/commons/events/ActionConfig.d.ts +18584 -33488
  3. package/dist/commons/events/ActionDocument.d.ts +1083 -1182
  4. package/dist/commons/events/ActionInput.d.ts +726 -726
  5. package/dist/commons/events/AdvancedSearchConfig.d.ts +18 -222
  6. package/dist/commons/events/CompositeFieldValue.d.ts +6 -6
  7. package/dist/commons/events/CountryConfigQueryInput.d.ts +412 -1160
  8. package/dist/commons/events/CreatedAtLocation.d.ts +2 -1
  9. package/dist/commons/events/Draft.d.ts +71 -76
  10. package/dist/commons/events/EventConfig.d.ts +17504 -27573
  11. package/dist/commons/events/EventDocument.d.ts +707 -782
  12. package/dist/commons/events/EventIndex.d.ts +224 -639
  13. package/dist/commons/events/EventMetadata.d.ts +31 -73
  14. package/dist/commons/events/FieldConfig.d.ts +37 -198
  15. package/dist/commons/events/FieldTypeMapping.d.ts +16 -16
  16. package/dist/commons/events/FieldValue.d.ts +12 -12
  17. package/dist/commons/events/FormConfig.d.ts +66 -1200
  18. package/dist/commons/events/PageConfig.d.ts +18 -288
  19. package/dist/commons/events/WorkqueueColumnConfig.d.ts +11 -11
  20. package/dist/commons/events/WorkqueueConfig.d.ts +740 -3237
  21. package/dist/commons/events/defineConfig.d.ts +1589 -3532
  22. package/dist/commons/events/field.d.ts +0 -5
  23. package/dist/commons/events/index.d.ts +0 -1
  24. package/dist/commons/events/scopes.d.ts +3 -2
  25. package/dist/commons/events/test.utils.d.ts +17 -40
  26. package/dist/commons/events/transactions.d.ts +1 -1
  27. package/dist/commons/events/utils.d.ts +1604 -3684
  28. package/dist/conditionals/index.js +17 -20
  29. package/dist/events/index.js +1323 -1695
  30. package/dist/scopes/index.d.ts +1 -4
  31. package/dist/scopes/index.js +17 -67
  32. package/package.json +3 -3
package/dist/commons/events/EventMetadata.d.ts CHANGED
@@ -5,26 +5,19 @@ import { TranslationConfig } from './TranslationConfig';
5
5
  */
6
6
  export declare const EventStatus: z.ZodEnum<["CREATED", "NOTIFIED", "DECLARED", "VALIDATED", "REGISTERED", "CERTIFIED", "REJECTED", "ARCHIVED"]>;
7
7
  export type EventStatus = z.infer<typeof EventStatus>;
8
- export declare const InherentFlags: {
9
- readonly PRINTED: "printed";
10
- readonly INCOMPLETE: "incomplete";
11
- readonly REJECTED: "rejected";
12
- readonly CORRECTION_REQUESTED: "correction-requested";
8
+ export declare const CustomFlags: {
9
+ readonly CERTIFICATE_PRINTED: "certificate-printed";
13
10
  };
14
- export type InherentFlags = (typeof InherentFlags)[keyof typeof InherentFlags];
11
+ export type CustomFlags = (typeof CustomFlags)[keyof typeof CustomFlags];
15
12
  export declare const Flag: z.ZodUnion<[z.ZodString, z.ZodNativeEnum<{
16
- readonly PRINTED: "printed";
17
- readonly INCOMPLETE: "incomplete";
18
- readonly REJECTED: "rejected";
19
- readonly CORRECTION_REQUESTED: "correction-requested";
13
+ readonly CERTIFICATE_PRINTED: "certificate-printed";
20
14
  }>]>;
21
15
  export type Flag = z.infer<typeof Flag>;
22
16
  export declare const ZodDate: z.ZodString;
23
17
  export declare const ActionCreationMetadata: z.ZodObject<{
24
18
  createdAt: z.ZodString;
25
19
  createdBy: z.ZodString;
26
- createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
27
- createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
20
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
28
21
  acceptedAt: z.ZodString;
29
22
  createdByRole: z.ZodString;
30
23
  createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -33,15 +26,13 @@ export declare const ActionCreationMetadata: z.ZodObject<{
33
26
  createdBy: string;
34
27
  createdByRole: string;
35
28
  acceptedAt: string;
36
- createdByUserType?: "system" | "user" | null | undefined;
37
29
  createdBySignature?: string | null | undefined;
38
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
30
+ createdAtLocation?: string | null | undefined;
39
31
  }, {
40
32
  createdAt: string;
41
33
  createdBy: string;
42
34
  createdByRole: string;
43
35
  acceptedAt: string;
44
- createdByUserType?: "system" | "user" | null | undefined;
45
36
  createdBySignature?: string | null | undefined;
46
37
  createdAtLocation?: string | null | undefined;
47
38
  }>;
@@ -49,8 +40,7 @@ export type ActionCreationMetadata = z.infer<typeof ActionCreationMetadata>;
49
40
  export declare const RegistrationCreationMetadata: z.ZodObject<z.objectUtil.extendShape<{
50
41
  createdAt: z.ZodString;
51
42
  createdBy: z.ZodString;
52
- createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
53
- createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
43
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
54
44
  acceptedAt: z.ZodString;
55
45
  createdByRole: z.ZodString;
56
46
  createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -62,16 +52,14 @@ export declare const RegistrationCreationMetadata: z.ZodObject<z.objectUtil.exte
62
52
  createdByRole: string;
63
53
  registrationNumber: string;
64
54
  acceptedAt: string;
65
- createdByUserType?: "system" | "user" | null | undefined;
66
55
  createdBySignature?: string | null | undefined;
67
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
56
+ createdAtLocation?: string | null | undefined;
68
57
  }, {
69
58
  createdAt: string;
70
59
  createdBy: string;
71
60
  createdByRole: string;
72
61
  registrationNumber: string;
73
62
  acceptedAt: string;
74
- createdByUserType?: "system" | "user" | null | undefined;
75
63
  createdBySignature?: string | null | undefined;
76
64
  createdAtLocation?: string | null | undefined;
77
65
  }>;
@@ -80,8 +68,7 @@ export declare const LegalStatuses: z.ZodObject<{
80
68
  DECLARED: z.ZodOptional<z.ZodNullable<z.ZodObject<{
81
69
  createdAt: z.ZodString;
82
70
  createdBy: z.ZodString;
83
- createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
84
- createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
71
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
85
72
  acceptedAt: z.ZodString;
86
73
  createdByRole: z.ZodString;
87
74
  createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -90,23 +77,20 @@ export declare const LegalStatuses: z.ZodObject<{
90
77
  createdBy: string;
91
78
  createdByRole: string;
92
79
  acceptedAt: string;
93
- createdByUserType?: "system" | "user" | null | undefined;
94
80
  createdBySignature?: string | null | undefined;
95
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
81
+ createdAtLocation?: string | null | undefined;
96
82
  }, {
97
83
  createdAt: string;
98
84
  createdBy: string;
99
85
  createdByRole: string;
100
86
  acceptedAt: string;
101
- createdByUserType?: "system" | "user" | null | undefined;
102
87
  createdBySignature?: string | null | undefined;
103
88
  createdAtLocation?: string | null | undefined;
104
89
  }>>>;
105
90
  REGISTERED: z.ZodOptional<z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
106
91
  createdAt: z.ZodString;
107
92
  createdBy: z.ZodString;
108
- createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
109
- createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
93
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
110
94
  acceptedAt: z.ZodString;
111
95
  createdByRole: z.ZodString;
112
96
  createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -118,16 +102,14 @@ export declare const LegalStatuses: z.ZodObject<{
118
102
  createdByRole: string;
119
103
  registrationNumber: string;
120
104
  acceptedAt: string;
121
- createdByUserType?: "system" | "user" | null | undefined;
122
105
  createdBySignature?: string | null | undefined;
123
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
106
+ createdAtLocation?: string | null | undefined;
124
107
  }, {
125
108
  createdAt: string;
126
109
  createdBy: string;
127
110
  createdByRole: string;
128
111
  registrationNumber: string;
129
112
  acceptedAt: string;
130
- createdByUserType?: "system" | "user" | null | undefined;
131
113
  createdBySignature?: string | null | undefined;
132
114
  createdAtLocation?: string | null | undefined;
133
115
  }>>>;
@@ -137,9 +119,8 @@ export declare const LegalStatuses: z.ZodObject<{
137
119
  createdBy: string;
138
120
  createdByRole: string;
139
121
  acceptedAt: string;
140
- createdByUserType?: "system" | "user" | null | undefined;
141
122
  createdBySignature?: string | null | undefined;
142
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
123
+ createdAtLocation?: string | null | undefined;
143
124
  } | null | undefined;
144
125
  REGISTERED?: {
145
126
  createdAt: string;
@@ -147,9 +128,8 @@ export declare const LegalStatuses: z.ZodObject<{
147
128
  createdByRole: string;
148
129
  registrationNumber: string;
149
130
  acceptedAt: string;
150
- createdByUserType?: "system" | "user" | null | undefined;
151
131
  createdBySignature?: string | null | undefined;
152
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
132
+ createdAtLocation?: string | null | undefined;
153
133
  } | null | undefined;
154
134
  }, {
155
135
  DECLARED?: {
@@ -157,7 +137,6 @@ export declare const LegalStatuses: z.ZodObject<{
157
137
  createdBy: string;
158
138
  createdByRole: string;
159
139
  acceptedAt: string;
160
- createdByUserType?: "system" | "user" | null | undefined;
161
140
  createdBySignature?: string | null | undefined;
162
141
  createdAtLocation?: string | null | undefined;
163
142
  } | null | undefined;
@@ -167,7 +146,6 @@ export declare const LegalStatuses: z.ZodObject<{
167
146
  createdByRole: string;
168
147
  registrationNumber: string;
169
148
  acceptedAt: string;
170
- createdByUserType?: "system" | "user" | null | undefined;
171
149
  createdBySignature?: string | null | undefined;
172
150
  createdAtLocation?: string | null | undefined;
173
151
  } | null | undefined;
@@ -178,15 +156,14 @@ export declare const LegalStatuses: z.ZodObject<{
178
156
  * Accessed through `event.` in configuration.
179
157
  */
180
158
  export declare const EventMetadata: z.ZodObject<{
181
- id: z.ZodBranded<z.ZodString, "UUID">;
159
+ id: z.ZodString;
182
160
  type: z.ZodString;
183
161
  status: z.ZodEnum<["CREATED", "NOTIFIED", "DECLARED", "VALIDATED", "REGISTERED", "CERTIFIED", "REJECTED", "ARCHIVED"]>;
184
162
  legalStatuses: z.ZodObject<{
185
163
  DECLARED: z.ZodOptional<z.ZodNullable<z.ZodObject<{
186
164
  createdAt: z.ZodString;
187
165
  createdBy: z.ZodString;
188
- createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
189
- createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
166
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
190
167
  acceptedAt: z.ZodString;
191
168
  createdByRole: z.ZodString;
192
169
  createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -195,23 +172,20 @@ export declare const EventMetadata: z.ZodObject<{
195
172
  createdBy: string;
196
173
  createdByRole: string;
197
174
  acceptedAt: string;
198
- createdByUserType?: "system" | "user" | null | undefined;
199
175
  createdBySignature?: string | null | undefined;
200
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
176
+ createdAtLocation?: string | null | undefined;
201
177
  }, {
202
178
  createdAt: string;
203
179
  createdBy: string;
204
180
  createdByRole: string;
205
181
  acceptedAt: string;
206
- createdByUserType?: "system" | "user" | null | undefined;
207
182
  createdBySignature?: string | null | undefined;
208
183
  createdAtLocation?: string | null | undefined;
209
184
  }>>>;
210
185
  REGISTERED: z.ZodOptional<z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
211
186
  createdAt: z.ZodString;
212
187
  createdBy: z.ZodString;
213
- createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
214
- createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
188
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
215
189
  acceptedAt: z.ZodString;
216
190
  createdByRole: z.ZodString;
217
191
  createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -223,16 +197,14 @@ export declare const EventMetadata: z.ZodObject<{
223
197
  createdByRole: string;
224
198
  registrationNumber: string;
225
199
  acceptedAt: string;
226
- createdByUserType?: "system" | "user" | null | undefined;
227
200
  createdBySignature?: string | null | undefined;
228
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
201
+ createdAtLocation?: string | null | undefined;
229
202
  }, {
230
203
  createdAt: string;
231
204
  createdBy: string;
232
205
  createdByRole: string;
233
206
  registrationNumber: string;
234
207
  acceptedAt: string;
235
- createdByUserType?: "system" | "user" | null | undefined;
236
208
  createdBySignature?: string | null | undefined;
237
209
  createdAtLocation?: string | null | undefined;
238
210
  }>>>;
@@ -242,9 +214,8 @@ export declare const EventMetadata: z.ZodObject<{
242
214
  createdBy: string;
243
215
  createdByRole: string;
244
216
  acceptedAt: string;
245
- createdByUserType?: "system" | "user" | null | undefined;
246
217
  createdBySignature?: string | null | undefined;
247
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
218
+ createdAtLocation?: string | null | undefined;
248
219
  } | null | undefined;
249
220
  REGISTERED?: {
250
221
  createdAt: string;
@@ -252,9 +223,8 @@ export declare const EventMetadata: z.ZodObject<{
252
223
  createdByRole: string;
253
224
  registrationNumber: string;
254
225
  acceptedAt: string;
255
- createdByUserType?: "system" | "user" | null | undefined;
256
226
  createdBySignature?: string | null | undefined;
257
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
227
+ createdAtLocation?: string | null | undefined;
258
228
  } | null | undefined;
259
229
  }, {
260
230
  DECLARED?: {
@@ -262,7 +232,6 @@ export declare const EventMetadata: z.ZodObject<{
262
232
  createdBy: string;
263
233
  createdByRole: string;
264
234
  acceptedAt: string;
265
- createdByUserType?: "system" | "user" | null | undefined;
266
235
  createdBySignature?: string | null | undefined;
267
236
  createdAtLocation?: string | null | undefined;
268
237
  } | null | undefined;
@@ -272,7 +241,6 @@ export declare const EventMetadata: z.ZodObject<{
272
241
  createdByRole: string;
273
242
  registrationNumber: string;
274
243
  acceptedAt: string;
275
- createdByUserType?: "system" | "user" | null | undefined;
276
244
  createdBySignature?: string | null | undefined;
277
245
  createdAtLocation?: string | null | undefined;
278
246
  } | null | undefined;
@@ -280,24 +248,20 @@ export declare const EventMetadata: z.ZodObject<{
280
248
  createdAt: z.ZodString;
281
249
  dateOfEvent: z.ZodOptional<z.ZodNullable<z.ZodString>>;
282
250
  createdBy: z.ZodString;
283
- createdByUserType: z.ZodOptional<z.ZodNullable<z.ZodEnum<["user", "system"]>>>;
284
251
  updatedByUserRole: z.ZodString;
285
- createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
252
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
286
253
  createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
287
- updatedAtLocation: z.ZodOptional<z.ZodNullable<z.ZodBranded<z.ZodString, "UUID">>>;
254
+ updatedAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
288
255
  updatedAt: z.ZodString;
289
256
  assignedTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
290
257
  updatedBy: z.ZodOptional<z.ZodNullable<z.ZodString>>;
291
258
  trackingId: z.ZodString;
292
259
  flags: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNativeEnum<{
293
- readonly PRINTED: "printed";
294
- readonly INCOMPLETE: "incomplete";
295
- readonly REJECTED: "rejected";
296
- readonly CORRECTION_REQUESTED: "correction-requested";
260
+ readonly CERTIFICATE_PRINTED: "certificate-printed";
297
261
  }>]>, "many">;
298
262
  }, "strip", z.ZodTypeAny, {
299
263
  type: string;
300
- id: string & z.BRAND<"UUID">;
264
+ id: string;
301
265
  status: "ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED";
302
266
  createdAt: string;
303
267
  createdBy: string;
@@ -309,9 +273,8 @@ export declare const EventMetadata: z.ZodObject<{
309
273
  createdBy: string;
310
274
  createdByRole: string;
311
275
  acceptedAt: string;
312
- createdByUserType?: "system" | "user" | null | undefined;
313
276
  createdBySignature?: string | null | undefined;
314
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
277
+ createdAtLocation?: string | null | undefined;
315
278
  } | null | undefined;
316
279
  REGISTERED?: {
317
280
  createdAt: string;
@@ -319,19 +282,17 @@ export declare const EventMetadata: z.ZodObject<{
319
282
  createdByRole: string;
320
283
  registrationNumber: string;
321
284
  acceptedAt: string;
322
- createdByUserType?: "system" | "user" | null | undefined;
323
285
  createdBySignature?: string | null | undefined;
324
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
286
+ createdAtLocation?: string | null | undefined;
325
287
  } | null | undefined;
326
288
  };
327
289
  updatedByUserRole: string;
328
290
  flags: string[];
329
- createdByUserType?: "system" | "user" | null | undefined;
330
291
  createdBySignature?: string | null | undefined;
331
- createdAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
292
+ createdAtLocation?: string | null | undefined;
332
293
  assignedTo?: string | null | undefined;
333
294
  dateOfEvent?: string | null | undefined;
334
- updatedAtLocation?: (string & z.BRAND<"UUID">) | null | undefined;
295
+ updatedAtLocation?: string | null | undefined;
335
296
  updatedBy?: string | null | undefined;
336
297
  }, {
337
298
  type: string;
@@ -347,7 +308,6 @@ export declare const EventMetadata: z.ZodObject<{
347
308
  createdBy: string;
348
309
  createdByRole: string;
349
310
  acceptedAt: string;
350
- createdByUserType?: "system" | "user" | null | undefined;
351
311
  createdBySignature?: string | null | undefined;
352
312
  createdAtLocation?: string | null | undefined;
353
313
  } | null | undefined;
@@ -357,14 +317,12 @@ export declare const EventMetadata: z.ZodObject<{
357
317
  createdByRole: string;
358
318
  registrationNumber: string;
359
319
  acceptedAt: string;
360
- createdByUserType?: "system" | "user" | null | undefined;
361
320
  createdBySignature?: string | null | undefined;
362
321
  createdAtLocation?: string | null | undefined;
363
322
  } | null | undefined;
364
323
  };
365
324
  updatedByUserRole: string;
366
325
  flags: string[];
367
- createdByUserType?: "system" | "user" | null | undefined;
368
326
  createdBySignature?: string | null | undefined;
369
327
  createdAtLocation?: string | null | undefined;
370
328
  assignedTo?: string | null | undefined;
@@ -373,8 +331,8 @@ export declare const EventMetadata: z.ZodObject<{
373
331
  updatedBy?: string | null | undefined;
374
332
  }>;
375
333
  export type EventMetadata = z.infer<typeof EventMetadata>;
376
- export declare const EventMetadataKeysArray: readonly ["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "createdByUserType", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"];
377
- export declare const EventMetadataKeys: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "createdByUserType", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"]>;
334
+ export declare const EventMetadataKeysArray: readonly ["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"];
335
+ export declare const EventMetadataKeys: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"]>;
378
336
  export type EventMetadataKeys = z.infer<typeof EventMetadataKeys>;
379
337
  /**
380
338
  * Mapping of event metadata keys to translation configuration.