@opencrvs/toolkit 1.8.0-rc.fd754eb → 1.8.0-rc.fd8a78f

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 (42) hide show
  1. package/dist/commons/api/router.d.ts +15318 -5028
  2. package/dist/commons/conditionals/conditionals.d.ts +8 -3
  3. package/dist/commons/conditionals/validate.d.ts +6 -0
  4. package/dist/commons/events/ActionConfig.d.ts +56387 -29043
  5. package/dist/commons/events/ActionDocument.d.ts +1900 -309
  6. package/dist/commons/events/ActionInput.d.ts +1455 -183
  7. package/dist/commons/events/ActionType.d.ts +4 -0
  8. package/dist/commons/events/AdvancedSearchConfig.d.ts +675 -12
  9. package/dist/commons/events/CompositeFieldValue.d.ts +28 -0
  10. package/dist/commons/events/Constants.d.ts +3 -0
  11. package/dist/commons/events/CountryConfigQueryInput.d.ts +2982 -0
  12. package/dist/commons/events/CreatedAtLocation.d.ts +3 -0
  13. package/dist/commons/events/Draft.d.ts +122 -21
  14. package/dist/commons/events/EventConfig.d.ts +27593 -14046
  15. package/dist/commons/events/EventDocument.d.ts +1228 -245
  16. package/dist/commons/events/EventIndex.d.ts +585 -353
  17. package/dist/commons/events/EventInput.d.ts +0 -13
  18. package/dist/commons/events/EventMetadata.d.ts +70 -76
  19. package/dist/commons/events/FieldConfig.d.ts +2500 -1111
  20. package/dist/commons/events/FieldType.d.ts +4 -1
  21. package/dist/commons/events/FieldTypeMapping.d.ts +94 -52
  22. package/dist/commons/events/FieldValue.d.ts +43 -5
  23. package/dist/commons/events/FormConfig.d.ts +18485 -9821
  24. package/dist/commons/events/PageConfig.d.ts +3600 -1472
  25. package/dist/commons/events/SummaryConfig.d.ts +0 -5
  26. package/dist/commons/events/User.d.ts +31 -7
  27. package/dist/commons/events/WorkqueueColumnConfig.d.ts +53 -0
  28. package/dist/commons/events/WorkqueueConfig.d.ts +4205 -538
  29. package/dist/commons/events/defineConfig.d.ts +2639 -635
  30. package/dist/commons/events/event.d.ts +37 -10
  31. package/dist/commons/events/field.d.ts +26 -17
  32. package/dist/commons/events/index.d.ts +5 -0
  33. package/dist/commons/events/scopes.d.ts +20 -1
  34. package/dist/commons/events/serializer.d.ts +2 -0
  35. package/dist/commons/events/test.utils.d.ts +147 -41
  36. package/dist/commons/events/utils.d.ts +10110 -309
  37. package/dist/commons/events/workqueueDefaultColumns.d.ts +3 -0
  38. package/dist/conditionals/index.js +45 -8
  39. package/dist/events/index.js +2708 -1100
  40. package/dist/scopes/index.d.ts +94 -6
  41. package/dist/scopes/index.js +42 -21
  42. package/package.json +1 -1
@@ -2,25 +2,12 @@ import { z } from 'zod';
2
2
  export declare const EventInput: z.ZodObject<{
3
3
  transactionId: z.ZodString;
4
4
  type: z.ZodString;
5
- dateOfEvent: z.ZodOptional<z.ZodObject<{
6
- fieldId: z.ZodString;
7
- }, "strip", z.ZodTypeAny, {
8
- fieldId: string;
9
- }, {
10
- fieldId: string;
11
- }>>;
12
5
  }, "strip", z.ZodTypeAny, {
13
6
  type: string;
14
7
  transactionId: string;
15
- dateOfEvent?: {
16
- fieldId: string;
17
- } | undefined;
18
8
  }, {
19
9
  type: string;
20
10
  transactionId: string;
21
- dateOfEvent?: {
22
- fieldId: string;
23
- } | undefined;
24
11
  }>;
25
12
  export type EventInput = z.infer<typeof EventInput>;
26
13
  //# sourceMappingURL=EventInput.d.ts.map
@@ -3,17 +3,8 @@ import { TranslationConfig } from './TranslationConfig';
3
3
  /**
4
4
  * Event statuses recognized by the system
5
5
  */
6
- export declare const EventStatus: {
7
- readonly CREATED: "CREATED";
8
- readonly NOTIFIED: "NOTIFIED";
9
- readonly DECLARED: "DECLARED";
10
- readonly VALIDATED: "VALIDATED";
11
- readonly REGISTERED: "REGISTERED";
12
- readonly CERTIFIED: "CERTIFIED";
13
- readonly REJECTED: "REJECTED";
14
- readonly ARCHIVED: "ARCHIVED";
15
- };
16
- export type EventStatus = (typeof EventStatus)[keyof typeof EventStatus];
6
+ export declare const EventStatus: z.ZodEnum<["CREATED", "NOTIFIED", "DECLARED", "VALIDATED", "REGISTERED", "CERTIFIED", "REJECTED", "ARCHIVED"]>;
7
+ export type EventStatus = z.infer<typeof EventStatus>;
17
8
  export declare const CustomFlags: {
18
9
  readonly CERTIFICATE_PRINTED: "certificate-printed";
19
10
  };
@@ -22,136 +13,141 @@ export declare const Flag: z.ZodUnion<[z.ZodString, z.ZodNativeEnum<{
22
13
  readonly CERTIFICATE_PRINTED: "certificate-printed";
23
14
  }>]>;
24
15
  export type Flag = z.infer<typeof Flag>;
25
- export declare const eventStatuses: ("ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED")[];
26
- export declare const EventStatuses: z.ZodNativeEnum<{
27
- readonly CREATED: "CREATED";
28
- readonly NOTIFIED: "NOTIFIED";
29
- readonly DECLARED: "DECLARED";
30
- readonly VALIDATED: "VALIDATED";
31
- readonly REGISTERED: "REGISTERED";
32
- readonly CERTIFIED: "CERTIFIED";
33
- readonly REJECTED: "REJECTED";
34
- readonly ARCHIVED: "ARCHIVED";
35
- }>;
36
16
  export declare const ZodDate: z.ZodString;
37
17
  export declare const ActionCreationMetadata: z.ZodObject<{
38
18
  createdAt: z.ZodString;
39
19
  createdBy: z.ZodString;
40
- createdAtLocation: z.ZodString;
20
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
41
21
  acceptedAt: z.ZodString;
42
22
  createdByRole: z.ZodString;
23
+ createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
43
24
  }, "strip", z.ZodTypeAny, {
44
25
  createdAt: string;
45
26
  createdBy: string;
46
27
  createdByRole: string;
47
- createdAtLocation: string;
48
28
  acceptedAt: string;
29
+ createdBySignature?: string | null | undefined;
30
+ createdAtLocation?: string | null | undefined;
49
31
  }, {
50
32
  createdAt: string;
51
33
  createdBy: string;
52
34
  createdByRole: string;
53
- createdAtLocation: string;
54
35
  acceptedAt: string;
36
+ createdBySignature?: string | null | undefined;
37
+ createdAtLocation?: string | null | undefined;
55
38
  }>;
56
39
  export type ActionCreationMetadata = z.infer<typeof ActionCreationMetadata>;
57
40
  export declare const RegistrationCreationMetadata: z.ZodObject<z.objectUtil.extendShape<{
58
41
  createdAt: z.ZodString;
59
42
  createdBy: z.ZodString;
60
- createdAtLocation: z.ZodString;
43
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
61
44
  acceptedAt: z.ZodString;
62
45
  createdByRole: z.ZodString;
46
+ createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
63
47
  }, {
64
48
  registrationNumber: z.ZodString;
65
49
  }>, "strip", z.ZodTypeAny, {
66
50
  createdAt: string;
67
51
  createdBy: string;
68
52
  createdByRole: string;
69
- createdAtLocation: string;
70
53
  registrationNumber: string;
71
54
  acceptedAt: string;
55
+ createdBySignature?: string | null | undefined;
56
+ createdAtLocation?: string | null | undefined;
72
57
  }, {
73
58
  createdAt: string;
74
59
  createdBy: string;
75
60
  createdByRole: string;
76
- createdAtLocation: string;
77
61
  registrationNumber: string;
78
62
  acceptedAt: string;
63
+ createdBySignature?: string | null | undefined;
64
+ createdAtLocation?: string | null | undefined;
79
65
  }>;
80
66
  export type RegistrationCreationMetadata = z.infer<typeof RegistrationCreationMetadata>;
81
67
  export declare const LegalStatuses: z.ZodObject<{
82
68
  DECLARED: z.ZodOptional<z.ZodNullable<z.ZodObject<{
83
69
  createdAt: z.ZodString;
84
70
  createdBy: z.ZodString;
85
- createdAtLocation: z.ZodString;
71
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
86
72
  acceptedAt: z.ZodString;
87
73
  createdByRole: z.ZodString;
74
+ createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
88
75
  }, "strip", z.ZodTypeAny, {
89
76
  createdAt: string;
90
77
  createdBy: string;
91
78
  createdByRole: string;
92
- createdAtLocation: string;
93
79
  acceptedAt: string;
80
+ createdBySignature?: string | null | undefined;
81
+ createdAtLocation?: string | null | undefined;
94
82
  }, {
95
83
  createdAt: string;
96
84
  createdBy: string;
97
85
  createdByRole: string;
98
- createdAtLocation: string;
99
86
  acceptedAt: string;
87
+ createdBySignature?: string | null | undefined;
88
+ createdAtLocation?: string | null | undefined;
100
89
  }>>>;
101
90
  REGISTERED: z.ZodOptional<z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
102
91
  createdAt: z.ZodString;
103
92
  createdBy: z.ZodString;
104
- createdAtLocation: z.ZodString;
93
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
105
94
  acceptedAt: z.ZodString;
106
95
  createdByRole: z.ZodString;
96
+ createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
107
97
  }, {
108
98
  registrationNumber: z.ZodString;
109
99
  }>, "strip", z.ZodTypeAny, {
110
100
  createdAt: string;
111
101
  createdBy: string;
112
102
  createdByRole: string;
113
- createdAtLocation: string;
114
103
  registrationNumber: string;
115
104
  acceptedAt: string;
105
+ createdBySignature?: string | null | undefined;
106
+ createdAtLocation?: string | null | undefined;
116
107
  }, {
117
108
  createdAt: string;
118
109
  createdBy: string;
119
110
  createdByRole: string;
120
- createdAtLocation: string;
121
111
  registrationNumber: string;
122
112
  acceptedAt: string;
113
+ createdBySignature?: string | null | undefined;
114
+ createdAtLocation?: string | null | undefined;
123
115
  }>>>;
124
116
  }, "strip", z.ZodTypeAny, {
125
117
  DECLARED?: {
126
118
  createdAt: string;
127
119
  createdBy: string;
128
120
  createdByRole: string;
129
- createdAtLocation: string;
130
121
  acceptedAt: string;
122
+ createdBySignature?: string | null | undefined;
123
+ createdAtLocation?: string | null | undefined;
131
124
  } | null | undefined;
132
125
  REGISTERED?: {
133
126
  createdAt: string;
134
127
  createdBy: string;
135
128
  createdByRole: string;
136
- createdAtLocation: string;
137
129
  registrationNumber: string;
138
130
  acceptedAt: string;
131
+ createdBySignature?: string | null | undefined;
132
+ createdAtLocation?: string | null | undefined;
139
133
  } | null | undefined;
140
134
  }, {
141
135
  DECLARED?: {
142
136
  createdAt: string;
143
137
  createdBy: string;
144
138
  createdByRole: string;
145
- createdAtLocation: string;
146
139
  acceptedAt: string;
140
+ createdBySignature?: string | null | undefined;
141
+ createdAtLocation?: string | null | undefined;
147
142
  } | null | undefined;
148
143
  REGISTERED?: {
149
144
  createdAt: string;
150
145
  createdBy: string;
151
146
  createdByRole: string;
152
- createdAtLocation: string;
153
147
  registrationNumber: string;
154
148
  acceptedAt: string;
149
+ createdBySignature?: string | null | undefined;
150
+ createdAtLocation?: string | null | undefined;
155
151
  } | null | undefined;
156
152
  }>;
157
153
  /**
@@ -162,97 +158,99 @@ export declare const LegalStatuses: z.ZodObject<{
162
158
  export declare const EventMetadata: z.ZodObject<{
163
159
  id: z.ZodString;
164
160
  type: z.ZodString;
165
- status: z.ZodNativeEnum<{
166
- readonly CREATED: "CREATED";
167
- readonly NOTIFIED: "NOTIFIED";
168
- readonly DECLARED: "DECLARED";
169
- readonly VALIDATED: "VALIDATED";
170
- readonly REGISTERED: "REGISTERED";
171
- readonly CERTIFIED: "CERTIFIED";
172
- readonly REJECTED: "REJECTED";
173
- readonly ARCHIVED: "ARCHIVED";
174
- }>;
161
+ status: z.ZodEnum<["CREATED", "NOTIFIED", "DECLARED", "VALIDATED", "REGISTERED", "CERTIFIED", "REJECTED", "ARCHIVED"]>;
175
162
  legalStatuses: z.ZodObject<{
176
163
  DECLARED: z.ZodOptional<z.ZodNullable<z.ZodObject<{
177
164
  createdAt: z.ZodString;
178
165
  createdBy: z.ZodString;
179
- createdAtLocation: z.ZodString;
166
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
180
167
  acceptedAt: z.ZodString;
181
168
  createdByRole: z.ZodString;
169
+ createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
182
170
  }, "strip", z.ZodTypeAny, {
183
171
  createdAt: string;
184
172
  createdBy: string;
185
173
  createdByRole: string;
186
- createdAtLocation: string;
187
174
  acceptedAt: string;
175
+ createdBySignature?: string | null | undefined;
176
+ createdAtLocation?: string | null | undefined;
188
177
  }, {
189
178
  createdAt: string;
190
179
  createdBy: string;
191
180
  createdByRole: string;
192
- createdAtLocation: string;
193
181
  acceptedAt: string;
182
+ createdBySignature?: string | null | undefined;
183
+ createdAtLocation?: string | null | undefined;
194
184
  }>>>;
195
185
  REGISTERED: z.ZodOptional<z.ZodNullable<z.ZodObject<z.objectUtil.extendShape<{
196
186
  createdAt: z.ZodString;
197
187
  createdBy: z.ZodString;
198
- createdAtLocation: z.ZodString;
188
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
199
189
  acceptedAt: z.ZodString;
200
190
  createdByRole: z.ZodString;
191
+ createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
201
192
  }, {
202
193
  registrationNumber: z.ZodString;
203
194
  }>, "strip", z.ZodTypeAny, {
204
195
  createdAt: string;
205
196
  createdBy: string;
206
197
  createdByRole: string;
207
- createdAtLocation: string;
208
198
  registrationNumber: string;
209
199
  acceptedAt: string;
200
+ createdBySignature?: string | null | undefined;
201
+ createdAtLocation?: string | null | undefined;
210
202
  }, {
211
203
  createdAt: string;
212
204
  createdBy: string;
213
205
  createdByRole: string;
214
- createdAtLocation: string;
215
206
  registrationNumber: string;
216
207
  acceptedAt: string;
208
+ createdBySignature?: string | null | undefined;
209
+ createdAtLocation?: string | null | undefined;
217
210
  }>>>;
218
211
  }, "strip", z.ZodTypeAny, {
219
212
  DECLARED?: {
220
213
  createdAt: string;
221
214
  createdBy: string;
222
215
  createdByRole: string;
223
- createdAtLocation: string;
224
216
  acceptedAt: string;
217
+ createdBySignature?: string | null | undefined;
218
+ createdAtLocation?: string | null | undefined;
225
219
  } | null | undefined;
226
220
  REGISTERED?: {
227
221
  createdAt: string;
228
222
  createdBy: string;
229
223
  createdByRole: string;
230
- createdAtLocation: string;
231
224
  registrationNumber: string;
232
225
  acceptedAt: string;
226
+ createdBySignature?: string | null | undefined;
227
+ createdAtLocation?: string | null | undefined;
233
228
  } | null | undefined;
234
229
  }, {
235
230
  DECLARED?: {
236
231
  createdAt: string;
237
232
  createdBy: string;
238
233
  createdByRole: string;
239
- createdAtLocation: string;
240
234
  acceptedAt: string;
235
+ createdBySignature?: string | null | undefined;
236
+ createdAtLocation?: string | null | undefined;
241
237
  } | null | undefined;
242
238
  REGISTERED?: {
243
239
  createdAt: string;
244
240
  createdBy: string;
245
241
  createdByRole: string;
246
- createdAtLocation: string;
247
242
  registrationNumber: string;
248
243
  acceptedAt: string;
244
+ createdBySignature?: string | null | undefined;
245
+ createdAtLocation?: string | null | undefined;
249
246
  } | null | undefined;
250
247
  }>;
251
248
  createdAt: z.ZodString;
252
249
  dateOfEvent: z.ZodOptional<z.ZodNullable<z.ZodString>>;
253
250
  createdBy: z.ZodString;
254
251
  updatedByUserRole: z.ZodString;
255
- createdAtLocation: z.ZodString;
252
+ createdAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
253
+ createdBySignature: z.ZodOptional<z.ZodNullable<z.ZodString>>;
256
254
  updatedAtLocation: z.ZodOptional<z.ZodNullable<z.ZodString>>;
257
255
  updatedAt: z.ZodString;
258
256
  assignedTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -267,7 +265,6 @@ export declare const EventMetadata: z.ZodObject<{
267
265
  status: "ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED";
268
266
  createdAt: string;
269
267
  createdBy: string;
270
- createdAtLocation: string;
271
268
  updatedAt: string;
272
269
  trackingId: string;
273
270
  legalStatuses: {
@@ -275,20 +272,24 @@ export declare const EventMetadata: z.ZodObject<{
275
272
  createdAt: string;
276
273
  createdBy: string;
277
274
  createdByRole: string;
278
- createdAtLocation: string;
279
275
  acceptedAt: string;
276
+ createdBySignature?: string | null | undefined;
277
+ createdAtLocation?: string | null | undefined;
280
278
  } | null | undefined;
281
279
  REGISTERED?: {
282
280
  createdAt: string;
283
281
  createdBy: string;
284
282
  createdByRole: string;
285
- createdAtLocation: string;
286
283
  registrationNumber: string;
287
284
  acceptedAt: string;
285
+ createdBySignature?: string | null | undefined;
286
+ createdAtLocation?: string | null | undefined;
288
287
  } | null | undefined;
289
288
  };
290
289
  updatedByUserRole: string;
291
290
  flags: string[];
291
+ createdBySignature?: string | null | undefined;
292
+ createdAtLocation?: string | null | undefined;
292
293
  assignedTo?: string | null | undefined;
293
294
  dateOfEvent?: string | null | undefined;
294
295
  updatedAtLocation?: string | null | undefined;
@@ -299,7 +300,6 @@ export declare const EventMetadata: z.ZodObject<{
299
300
  status: "ARCHIVED" | "CERTIFIED" | "DECLARED" | "REGISTERED" | "REJECTED" | "VALIDATED" | "CREATED" | "NOTIFIED";
300
301
  createdAt: string;
301
302
  createdBy: string;
302
- createdAtLocation: string;
303
303
  updatedAt: string;
304
304
  trackingId: string;
305
305
  legalStatuses: {
@@ -307,39 +307,33 @@ export declare const EventMetadata: z.ZodObject<{
307
307
  createdAt: string;
308
308
  createdBy: string;
309
309
  createdByRole: string;
310
- createdAtLocation: string;
311
310
  acceptedAt: string;
311
+ createdBySignature?: string | null | undefined;
312
+ createdAtLocation?: string | null | undefined;
312
313
  } | null | undefined;
313
314
  REGISTERED?: {
314
315
  createdAt: string;
315
316
  createdBy: string;
316
317
  createdByRole: string;
317
- createdAtLocation: string;
318
318
  registrationNumber: string;
319
319
  acceptedAt: string;
320
+ createdBySignature?: string | null | undefined;
321
+ createdAtLocation?: string | null | undefined;
320
322
  } | null | undefined;
321
323
  };
322
324
  updatedByUserRole: string;
323
325
  flags: string[];
326
+ createdBySignature?: string | null | undefined;
327
+ createdAtLocation?: string | null | undefined;
324
328
  assignedTo?: string | null | undefined;
325
329
  dateOfEvent?: string | null | undefined;
326
330
  updatedAtLocation?: string | null | undefined;
327
331
  updatedBy?: string | null | undefined;
328
332
  }>;
329
333
  export type EventMetadata = z.infer<typeof EventMetadata>;
334
+ export declare const EventMetadataKeysArray: readonly ["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"];
330
335
  export declare const EventMetadataKeys: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"]>;
331
336
  export type EventMetadataKeys = z.infer<typeof EventMetadataKeys>;
332
- /**
333
- * This ensures `event.field()` takes a key from `EventMetadata`
334
- */
335
- export declare const EventMetadataParameter: z.ZodObject<{
336
- $event: z.ZodEnum<["id", "type", "status", "createdAt", "dateOfEvent", "createdBy", "updatedByUserRole", "createdAtLocation", "updatedAtLocation", "updatedAt", "assignedTo", "updatedBy", "trackingId", "legalStatuses", "flags"]>;
337
- }, "strip", z.ZodTypeAny, {
338
- $event: "type" | "id" | "status" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "dateOfEvent" | "updatedAt" | "trackingId" | "legalStatuses" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags";
339
- }, {
340
- $event: "type" | "id" | "status" | "createdAt" | "createdBy" | "createdAtLocation" | "assignedTo" | "dateOfEvent" | "updatedAt" | "trackingId" | "legalStatuses" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags";
341
- }>;
342
- export type EventMetadataParameter = z.infer<typeof EventMetadataParameter>;
343
337
  /**
344
338
  * Mapping of event metadata keys to translation configuration.
345
339
  * Consider introducing type in same manner as we have in FieldConfig.