@opencrvs/toolkit 1.8.0-rc.fa72fdf → 1.8.0-rc.faacbde

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 (27) hide show
  1. package/README.md +1 -1
  2. package/dist/commons/api/router.d.ts +6351 -1526
  3. package/dist/commons/conditionals/conditionals.d.ts +8 -0
  4. package/dist/commons/conditionals/validate-address.test.d.ts +2 -0
  5. package/dist/commons/events/ActionConfig.d.ts +1123 -2056
  6. package/dist/commons/events/ActionDocument.d.ts +2317 -241
  7. package/dist/commons/events/ActionInput.d.ts +4251 -343
  8. package/dist/commons/events/ActionType.d.ts +23 -11
  9. package/dist/commons/events/CompositeFieldValue.d.ts +152 -2
  10. package/dist/commons/events/Draft.d.ts +332 -45
  11. package/dist/commons/events/EventConfig.d.ts +551 -1206
  12. package/dist/commons/events/EventConfigInput.d.ts +6 -3
  13. package/dist/commons/events/EventDocument.d.ts +2915 -395
  14. package/dist/commons/events/EventIndex.d.ts +3 -3
  15. package/dist/commons/events/FieldConfig.d.ts +366 -52
  16. package/dist/commons/events/FieldType.d.ts +2 -1
  17. package/dist/commons/events/FieldTypeMapping.d.ts +124 -3
  18. package/dist/commons/events/FieldValue.d.ts +76 -2
  19. package/dist/commons/events/FormConfig.d.ts +633 -48
  20. package/dist/commons/events/PageConfig.d.ts +359 -0
  21. package/dist/commons/events/defineConfig.d.ts +91 -216
  22. package/dist/commons/events/index.d.ts +2 -1
  23. package/dist/commons/events/test.utils.d.ts +158 -140
  24. package/dist/commons/events/utils.d.ts +76 -82
  25. package/dist/conditionals/index.js +55 -0
  26. package/dist/events/index.js +903 -582
  27. package/package.json +1 -1
package/dist/commons/events/test.utils.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ActionDocument } from './ActionDocument';
1
+ import { ActionDocument, ActionUpdate } from './ActionDocument';
2
2
  import { ArchiveActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
3
3
  import { ActionType } from './ActionType';
4
4
  import { Draft } from './Draft';
@@ -7,6 +7,7 @@ import { EventDocument } from './EventDocument';
7
7
  import { EventIndex } from './EventIndex';
8
8
  import { EventInput } from './EventInput';
9
9
  import { FieldValue } from './FieldValue';
10
+ import { TranslationConfig } from './TranslationConfig';
10
11
  export declare function generateActionInput(configuration: EventConfig, action: ActionType): import("lodash").Dictionary<string | number | boolean | {
11
12
  type: string;
12
13
  filename: string;
@@ -14,6 +15,7 @@ export declare function generateActionInput(configuration: EventConfig, action:
14
15
  } | {
15
16
  country: string;
16
17
  district: string;
18
+ addressType: "DOMESTIC";
17
19
  province: string;
18
20
  urbanOrRural: "URBAN";
19
21
  number?: string | undefined;
@@ -24,15 +26,27 @@ export declare function generateActionInput(configuration: EventConfig, action:
24
26
  } | {
25
27
  country: string;
26
28
  district: string;
29
+ addressType: "DOMESTIC";
27
30
  province: string;
28
31
  urbanOrRural: "RURAL";
29
32
  village?: string | undefined;
33
+ } | {
34
+ country: string;
35
+ state: string;
36
+ addressType: "INTERNATIONAL";
37
+ district2: string;
38
+ cityOrTown?: string | undefined;
39
+ addressLine1?: string | undefined;
40
+ addressLine2?: string | undefined;
41
+ addressLine3?: string | undefined;
42
+ postcodeOrZip?: string | undefined;
30
43
  } | {
31
44
  type: string;
32
45
  option: string;
33
46
  filename: string;
34
47
  originalFilename: string;
35
- }[]>;
48
+ }[] | undefined>;
49
+ export declare function generateActionMetadataInput(configuration: EventConfig, action: ActionType): {};
36
50
  export declare const eventPayloadGenerator: {
37
51
  create: (input?: Partial<EventInput>) => {
38
52
  transactionId: string;
@@ -50,13 +64,13 @@ export declare const eventPayloadGenerator: {
50
64
  transactionId: import("../uuid").UUID;
51
65
  action: {
52
66
  type: "REQUEST_CORRECTION";
53
- data: {
67
+ declaration: {
54
68
  'applicant.firstname': string;
55
69
  'applicant.surname': string;
56
70
  'applicant.dob': string;
57
71
  'recommender.none': boolean;
58
72
  };
59
- metadata: {
73
+ annotation: {
60
74
  'correction.requester.relationship': string;
61
75
  'correction.request.reason': string;
62
76
  };
@@ -70,14 +84,17 @@ export declare const eventPayloadGenerator: {
70
84
  eventId: string;
71
85
  transactionId: string;
72
86
  action: {
73
- type: ActionType;
74
- data: Record<string, string | number | boolean | {
87
+ type: "DECLARE" | "REGISTER" | "VALIDATE" | "DELETE" | "CREATE" | "NOTIFY" | "DETECT_DUPLICATE" | "REJECT" | "MARKED_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION" | "READ" | "ASSIGN" | "UNASSIGN";
88
+ createdAt: string;
89
+ createdBy: string;
90
+ declaration: Record<string, string | number | boolean | {
75
91
  type: string;
76
92
  filename: string;
77
93
  originalFilename: string;
78
94
  } | {
79
95
  country: string;
80
96
  district: string;
97
+ addressType: "DOMESTIC";
81
98
  province: string;
82
99
  urbanOrRural: "URBAN";
83
100
  number?: string | null | undefined;
@@ -88,25 +105,35 @@ export declare const eventPayloadGenerator: {
88
105
  } | {
89
106
  country: string;
90
107
  district: string;
108
+ addressType: "DOMESTIC";
91
109
  province: string;
92
110
  urbanOrRural: "RURAL";
93
111
  village?: string | null | undefined;
112
+ } | {
113
+ country: string;
114
+ state: string;
115
+ addressType: "INTERNATIONAL";
116
+ district2: string;
117
+ cityOrTown?: string | null | undefined;
118
+ addressLine1?: string | null | undefined;
119
+ addressLine2?: string | null | undefined;
120
+ addressLine3?: string | null | undefined;
121
+ postcodeOrZip?: string | null | undefined;
94
122
  } | {
95
123
  type: string;
96
124
  option: string;
97
125
  filename: string;
98
126
  originalFilename: string;
99
- }[]>;
100
- createdAt: string;
101
- createdBy: string;
127
+ }[] | undefined>;
102
128
  createdAtLocation: string;
103
- metadata?: Record<string, string | number | boolean | {
129
+ annotation?: Record<string, string | number | boolean | {
104
130
  type: string;
105
131
  filename: string;
106
132
  originalFilename: string;
107
133
  } | {
108
134
  country: string;
109
135
  district: string;
136
+ addressType: "DOMESTIC";
110
137
  province: string;
111
138
  urbanOrRural: "URBAN";
112
139
  number?: string | null | undefined;
@@ -117,28 +144,40 @@ export declare const eventPayloadGenerator: {
117
144
  } | {
118
145
  country: string;
119
146
  district: string;
147
+ addressType: "DOMESTIC";
120
148
  province: string;
121
149
  urbanOrRural: "RURAL";
122
150
  village?: string | null | undefined;
151
+ } | {
152
+ country: string;
153
+ state: string;
154
+ addressType: "INTERNATIONAL";
155
+ district2: string;
156
+ cityOrTown?: string | null | undefined;
157
+ addressLine1?: string | null | undefined;
158
+ addressLine2?: string | null | undefined;
159
+ addressLine3?: string | null | undefined;
160
+ postcodeOrZip?: string | null | undefined;
123
161
  } | {
124
162
  type: string;
125
163
  option: string;
126
164
  filename: string;
127
165
  originalFilename: string;
128
- }[]> | undefined;
166
+ }[] | undefined> | undefined;
129
167
  };
130
168
  }>;
131
169
  actions: {
132
- declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "data">>) => {
170
+ declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "declaration" | "annotation">>) => {
133
171
  type: "DECLARE";
134
172
  transactionId: string;
135
- data: Record<string, string | number | boolean | {
173
+ declaration: Record<string, string | number | boolean | {
136
174
  type: string;
137
175
  filename: string;
138
176
  originalFilename: string;
139
177
  } | {
140
178
  country: string;
141
179
  district: string;
180
+ addressType: "DOMESTIC";
142
181
  province: string;
143
182
  urbanOrRural: "URBAN";
144
183
  number?: string | null | undefined;
@@ -149,27 +188,46 @@ export declare const eventPayloadGenerator: {
149
188
  } | {
150
189
  country: string;
151
190
  district: string;
191
+ addressType: "DOMESTIC";
152
192
  province: string;
153
193
  urbanOrRural: "RURAL";
154
194
  village?: string | null | undefined;
195
+ } | {
196
+ country: string;
197
+ state: string;
198
+ addressType: "INTERNATIONAL";
199
+ district2: string;
200
+ cityOrTown?: string | null | undefined;
201
+ addressLine1?: string | null | undefined;
202
+ addressLine2?: string | null | undefined;
203
+ addressLine3?: string | null | undefined;
204
+ postcodeOrZip?: string | null | undefined;
155
205
  } | {
156
206
  type: string;
157
207
  option: string;
158
208
  filename: string;
159
209
  originalFilename: string;
160
- }[]>;
210
+ }[] | undefined>;
211
+ annotation: {};
161
212
  eventId: string;
162
213
  };
163
- validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "data">>) => {
164
- type: "VALIDATE";
214
+ /**
215
+ * Notify allows sending incomplete data. Think it as 'partial declare' for now.
216
+ */
217
+ notify: (eventId: string, input?: {
218
+ transactionId?: string;
219
+ declaration?: Partial<ActionUpdate>;
220
+ }) => {
221
+ type: "NOTIFY";
165
222
  transactionId: string;
166
- data: Record<string, string | number | boolean | {
223
+ declaration: Partial<Record<string, string | number | boolean | {
167
224
  type: string;
168
225
  filename: string;
169
226
  originalFilename: string;
170
227
  } | {
171
228
  country: string;
172
229
  district: string;
230
+ addressType: "DOMESTIC";
173
231
  province: string;
174
232
  urbanOrRural: "URBAN";
175
233
  number?: string | null | undefined;
@@ -180,28 +238,39 @@ export declare const eventPayloadGenerator: {
180
238
  } | {
181
239
  country: string;
182
240
  district: string;
241
+ addressType: "DOMESTIC";
183
242
  province: string;
184
243
  urbanOrRural: "RURAL";
185
244
  village?: string | null | undefined;
245
+ } | {
246
+ country: string;
247
+ state: string;
248
+ addressType: "INTERNATIONAL";
249
+ district2: string;
250
+ cityOrTown?: string | null | undefined;
251
+ addressLine1?: string | null | undefined;
252
+ addressLine2?: string | null | undefined;
253
+ addressLine3?: string | null | undefined;
254
+ postcodeOrZip?: string | null | undefined;
186
255
  } | {
187
256
  type: string;
188
257
  option: string;
189
258
  filename: string;
190
259
  originalFilename: string;
191
- }[]>;
192
- duplicates: never[];
260
+ }[] | undefined>>;
193
261
  eventId: string;
194
262
  };
195
- archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "data">>, isDuplicate?: boolean) => {
196
- type: "ARCHIVE";
263
+ validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation">>) => {
264
+ type: "VALIDATE";
197
265
  transactionId: string;
198
- data: Record<string, string | number | boolean | {
266
+ declaration: Record<string, string | number | boolean | {
199
267
  type: string;
200
268
  filename: string;
201
269
  originalFilename: string;
202
270
  } | {
203
271
  country: string;
204
272
  district: string;
273
+ addressType: "DOMESTIC";
205
274
  province: string;
206
275
  urbanOrRural: "URBAN";
207
276
  number?: string | null | undefined;
@@ -212,63 +281,59 @@ export declare const eventPayloadGenerator: {
212
281
  } | {
213
282
  country: string;
214
283
  district: string;
284
+ addressType: "DOMESTIC";
215
285
  province: string;
216
286
  urbanOrRural: "RURAL";
217
287
  village?: string | null | undefined;
288
+ } | {
289
+ country: string;
290
+ state: string;
291
+ addressType: "INTERNATIONAL";
292
+ district2: string;
293
+ cityOrTown?: string | null | undefined;
294
+ addressLine1?: string | null | undefined;
295
+ addressLine2?: string | null | undefined;
296
+ addressLine3?: string | null | undefined;
297
+ postcodeOrZip?: string | null | undefined;
218
298
  } | {
219
299
  type: string;
220
300
  option: string;
221
301
  filename: string;
222
302
  originalFilename: string;
223
- }[]>;
224
- metadata: {
303
+ }[] | undefined>;
304
+ annotation: {};
305
+ duplicates: never[];
306
+ eventId: string;
307
+ };
308
+ archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration">>, isDuplicate?: boolean) => {
309
+ type: "ARCHIVE";
310
+ transactionId: string;
311
+ declaration: {};
312
+ annotation: {
225
313
  isDuplicate: boolean;
226
314
  };
227
315
  duplicates: never[];
228
316
  eventId: string;
229
317
  };
230
- reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "data">>) => {
318
+ reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation">>) => {
231
319
  type: "REJECT";
232
320
  transactionId: string;
233
- data: Record<string, string | number | boolean | {
234
- type: string;
235
- filename: string;
236
- originalFilename: string;
237
- } | {
238
- country: string;
239
- district: string;
240
- province: string;
241
- urbanOrRural: "URBAN";
242
- number?: string | null | undefined;
243
- town?: string | null | undefined;
244
- residentialArea?: string | null | undefined;
245
- street?: string | null | undefined;
246
- zipCode?: string | null | undefined;
247
- } | {
248
- country: string;
249
- district: string;
250
- province: string;
251
- urbanOrRural: "RURAL";
252
- village?: string | null | undefined;
253
- } | {
254
- type: string;
255
- option: string;
256
- filename: string;
257
- originalFilename: string;
258
- }[]>;
321
+ declaration: {};
322
+ annotation: {};
259
323
  duplicates: never[];
260
324
  eventId: string;
261
325
  };
262
- register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data">>) => {
326
+ register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation">>) => {
263
327
  type: "REGISTER";
264
328
  transactionId: string;
265
- data: Record<string, string | number | boolean | {
329
+ declaration: Record<string, string | number | boolean | {
266
330
  type: string;
267
331
  filename: string;
268
332
  originalFilename: string;
269
333
  } | {
270
334
  country: string;
271
335
  district: string;
336
+ addressType: "DOMESTIC";
272
337
  province: string;
273
338
  urbanOrRural: "URBAN";
274
339
  number?: string | null | undefined;
@@ -279,59 +344,48 @@ export declare const eventPayloadGenerator: {
279
344
  } | {
280
345
  country: string;
281
346
  district: string;
347
+ addressType: "DOMESTIC";
282
348
  province: string;
283
349
  urbanOrRural: "RURAL";
284
350
  village?: string | null | undefined;
351
+ } | {
352
+ country: string;
353
+ state: string;
354
+ addressType: "INTERNATIONAL";
355
+ district2: string;
356
+ cityOrTown?: string | null | undefined;
357
+ addressLine1?: string | null | undefined;
358
+ addressLine2?: string | null | undefined;
359
+ addressLine3?: string | null | undefined;
360
+ postcodeOrZip?: string | null | undefined;
285
361
  } | {
286
362
  type: string;
287
363
  option: string;
288
364
  filename: string;
289
365
  originalFilename: string;
290
- }[]>;
366
+ }[] | undefined>;
367
+ annotation: {};
291
368
  eventId: string;
292
369
  };
293
- printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data">>) => {
370
+ printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "annotation">>) => {
294
371
  type: "PRINT_CERTIFICATE";
295
372
  transactionId: string;
296
- data: Record<string, string | number | boolean | {
297
- type: string;
298
- filename: string;
299
- originalFilename: string;
300
- } | {
301
- country: string;
302
- district: string;
303
- province: string;
304
- urbanOrRural: "URBAN";
305
- number?: string | null | undefined;
306
- town?: string | null | undefined;
307
- residentialArea?: string | null | undefined;
308
- street?: string | null | undefined;
309
- zipCode?: string | null | undefined;
310
- } | {
311
- country: string;
312
- district: string;
313
- province: string;
314
- urbanOrRural: "RURAL";
315
- village?: string | null | undefined;
316
- } | {
317
- type: string;
318
- option: string;
319
- filename: string;
320
- originalFilename: string;
321
- }[]>;
373
+ declaration: {};
374
+ annotation: {};
322
375
  eventId: string;
323
376
  };
324
377
  correction: {
325
- request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
378
+ request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation">>) => {
326
379
  type: "REQUEST_CORRECTION";
327
380
  transactionId: string;
328
- data: Record<string, string | number | boolean | {
381
+ declaration: Record<string, string | number | boolean | {
329
382
  type: string;
330
383
  filename: string;
331
384
  originalFilename: string;
332
385
  } | {
333
386
  country: string;
334
387
  district: string;
388
+ addressType: "DOMESTIC";
335
389
  province: string;
336
390
  urbanOrRural: "URBAN";
337
391
  number?: string | null | undefined;
@@ -342,79 +396,42 @@ export declare const eventPayloadGenerator: {
342
396
  } | {
343
397
  country: string;
344
398
  district: string;
399
+ addressType: "DOMESTIC";
345
400
  province: string;
346
401
  urbanOrRural: "RURAL";
347
402
  village?: string | null | undefined;
403
+ } | {
404
+ country: string;
405
+ state: string;
406
+ addressType: "INTERNATIONAL";
407
+ district2: string;
408
+ cityOrTown?: string | null | undefined;
409
+ addressLine1?: string | null | undefined;
410
+ addressLine2?: string | null | undefined;
411
+ addressLine3?: string | null | undefined;
412
+ postcodeOrZip?: string | null | undefined;
348
413
  } | {
349
414
  type: string;
350
415
  option: string;
351
416
  filename: string;
352
417
  originalFilename: string;
353
- }[]>;
354
- metadata: {};
418
+ }[] | undefined>;
419
+ annotation: {};
355
420
  eventId: string;
356
421
  };
357
- approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
422
+ approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
358
423
  type: "APPROVE_CORRECTION";
359
424
  transactionId: string;
360
- data: Record<string, string | number | boolean | {
361
- type: string;
362
- filename: string;
363
- originalFilename: string;
364
- } | {
365
- country: string;
366
- district: string;
367
- province: string;
368
- urbanOrRural: "URBAN";
369
- number?: string | null | undefined;
370
- town?: string | null | undefined;
371
- residentialArea?: string | null | undefined;
372
- street?: string | null | undefined;
373
- zipCode?: string | null | undefined;
374
- } | {
375
- country: string;
376
- district: string;
377
- province: string;
378
- urbanOrRural: "RURAL";
379
- village?: string | null | undefined;
380
- } | {
381
- type: string;
382
- option: string;
383
- filename: string;
384
- originalFilename: string;
385
- }[]>;
425
+ declaration: {};
426
+ annotation: {};
386
427
  eventId: string;
387
428
  requestId: string;
388
429
  };
389
- reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
430
+ reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
390
431
  type: "REJECT_CORRECTION";
391
432
  transactionId: string;
392
- data: Record<string, string | number | boolean | {
393
- type: string;
394
- filename: string;
395
- originalFilename: string;
396
- } | {
397
- country: string;
398
- district: string;
399
- province: string;
400
- urbanOrRural: "URBAN";
401
- number?: string | null | undefined;
402
- town?: string | null | undefined;
403
- residentialArea?: string | null | undefined;
404
- street?: string | null | undefined;
405
- zipCode?: string | null | undefined;
406
- } | {
407
- country: string;
408
- district: string;
409
- province: string;
410
- urbanOrRural: "RURAL";
411
- village?: string | null | undefined;
412
- } | {
413
- type: string;
414
- option: string;
415
- filename: string;
416
- originalFilename: string;
417
- }[]>;
433
+ declaration: {};
434
+ annotation: {};
418
435
  eventId: string;
419
436
  requestId: string;
420
437
  };
@@ -430,6 +447,7 @@ export declare function generateEventDocument({ configuration, actions }: {
430
447
  configuration: EventConfig;
431
448
  actions: ActionType[];
432
449
  }): EventDocument;
433
- export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, data?: Record<string, FieldValue>): Draft;
450
+ export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, declaration?: Record<string, FieldValue>): Draft;
434
451
  export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>) => EventIndex;
452
+ export declare const generateTranslationConfig: (message: string) => TranslationConfig;
435
453
  //# sourceMappingURL=test.utils.d.ts.map