@opencrvs/toolkit 1.8.0-rc.faeb298 → 1.8.0-rc.fb261c5

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 (24) hide show
  1. package/dist/commons/api/router.d.ts +5489 -457
  2. package/dist/commons/conditionals/conditionals.d.ts +1 -0
  3. package/dist/commons/conditionals/validate-address.test.d.ts +2 -0
  4. package/dist/commons/conditionals/validate.d.ts +27 -0
  5. package/dist/commons/conditionals/validate.test.d.ts +2 -0
  6. package/dist/commons/events/ActionConfig.d.ts +4174 -1134
  7. package/dist/commons/events/ActionDocument.d.ts +2147 -71
  8. package/dist/commons/events/ActionInput.d.ts +3236 -116
  9. package/dist/commons/events/ActionType.d.ts +6 -1
  10. package/dist/commons/events/CompositeFieldValue.d.ts +152 -2
  11. package/dist/commons/events/Draft.d.ts +300 -12
  12. package/dist/commons/events/EventConfig.d.ts +340 -148
  13. package/dist/commons/events/EventConfigInput.d.ts +2 -2
  14. package/dist/commons/events/EventDocument.d.ts +2645 -125
  15. package/dist/commons/events/FieldConfig.d.ts +139 -59
  16. package/dist/commons/events/FieldTypeMapping.d.ts +136 -5
  17. package/dist/commons/events/FieldValue.d.ts +76 -2
  18. package/dist/commons/events/FormConfig.d.ts +133 -47
  19. package/dist/commons/events/defineConfig.d.ts +53 -25
  20. package/dist/commons/events/test.utils.d.ts +164 -16
  21. package/dist/commons/events/utils.d.ts +144 -4
  22. package/dist/conditionals/index.js +17 -0
  23. package/dist/events/index.js +418 -139
  24. package/package.json +1 -1
package/dist/commons/events/FormConfig.d.ts CHANGED
@@ -1,20 +1,20 @@
1
1
  import { z } from 'zod';
2
2
  import { TranslationConfig } from './TranslationConfig';
3
- export declare enum PageType {
4
- FORM = "FORM",
5
- VERIFICATION = "VERIFICATION"
6
- }
7
- export declare const PageBase: z.ZodObject<{
3
+ export declare const FormPageType: {
4
+ readonly FORM: "FORM";
5
+ readonly VERIFICATION: "VERIFICATION";
6
+ };
7
+ export declare const FormPage: z.ZodObject<{
8
8
  id: z.ZodString;
9
9
  title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
10
10
  id: string;
11
11
  description: string;
12
12
  defaultMessage: string;
13
13
  }>;
14
- fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").Inferred>, "many">;
15
- type: z.ZodDefault<z.ZodEnum<["FORM", "VERIFICATION"]>>;
14
+ fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").InferredInput>, "many">;
15
+ type: z.ZodDefault<z.ZodLiteral<"FORM">>;
16
16
  }, "strip", z.ZodTypeAny, {
17
- type: "FORM" | "VERIFICATION";
17
+ type: "FORM";
18
18
  id: string;
19
19
  title: TranslationConfig;
20
20
  fields: import("./FieldConfig").Inferred[];
@@ -25,34 +25,120 @@ export declare const PageBase: z.ZodObject<{
25
25
  description: string;
26
26
  defaultMessage: string;
27
27
  };
28
- fields: import("./FieldConfig").Inferred[];
29
- type?: "FORM" | "VERIFICATION" | undefined;
28
+ fields: import("./FieldConfig").InferredInput[];
29
+ type?: "FORM" | undefined;
30
30
  }>;
31
- export declare const FormPage: z.ZodObject<z.objectUtil.extendShape<{
32
- id: z.ZodString;
33
- title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
34
- id: string;
35
- description: string;
36
- defaultMessage: string;
31
+ export declare const VerificationPageConfig: z.ZodObject<{
32
+ verify: z.ZodObject<{
33
+ label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
34
+ id: string;
35
+ description: string;
36
+ defaultMessage: string;
37
+ }>;
38
+ }, "strip", z.ZodTypeAny, {
39
+ label: TranslationConfig;
40
+ }, {
41
+ label: {
42
+ id: string;
43
+ description: string;
44
+ defaultMessage: string;
45
+ };
37
46
  }>;
38
- fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").Inferred>, "many">;
39
- type: z.ZodDefault<z.ZodEnum<["FORM", "VERIFICATION"]>>;
40
- }, {
41
- type: z.ZodOptional<z.ZodLiteral<"FORM">>;
42
- }>, "strip", z.ZodTypeAny, {
43
- id: string;
44
- title: TranslationConfig;
45
- fields: import("./FieldConfig").Inferred[];
46
- type?: "FORM" | undefined;
47
+ cancel: z.ZodObject<{
48
+ label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
49
+ id: string;
50
+ description: string;
51
+ defaultMessage: string;
52
+ }>;
53
+ confirmation: z.ZodObject<{
54
+ title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
55
+ id: string;
56
+ description: string;
57
+ defaultMessage: string;
58
+ }>;
59
+ body: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
60
+ id: string;
61
+ description: string;
62
+ defaultMessage: string;
63
+ }>;
64
+ }, "strip", z.ZodTypeAny, {
65
+ title: TranslationConfig;
66
+ body: TranslationConfig;
67
+ }, {
68
+ title: {
69
+ id: string;
70
+ description: string;
71
+ defaultMessage: string;
72
+ };
73
+ body: {
74
+ id: string;
75
+ description: string;
76
+ defaultMessage: string;
77
+ };
78
+ }>;
79
+ }, "strip", z.ZodTypeAny, {
80
+ label: TranslationConfig;
81
+ confirmation: {
82
+ title: TranslationConfig;
83
+ body: TranslationConfig;
84
+ };
85
+ }, {
86
+ label: {
87
+ id: string;
88
+ description: string;
89
+ defaultMessage: string;
90
+ };
91
+ confirmation: {
92
+ title: {
93
+ id: string;
94
+ description: string;
95
+ defaultMessage: string;
96
+ };
97
+ body: {
98
+ id: string;
99
+ description: string;
100
+ defaultMessage: string;
101
+ };
102
+ };
103
+ }>;
104
+ }, "strip", z.ZodTypeAny, {
105
+ verify: {
106
+ label: TranslationConfig;
107
+ };
108
+ cancel: {
109
+ label: TranslationConfig;
110
+ confirmation: {
111
+ title: TranslationConfig;
112
+ body: TranslationConfig;
113
+ };
114
+ };
47
115
  }, {
48
- id: string;
49
- title: {
50
- id: string;
51
- description: string;
52
- defaultMessage: string;
116
+ verify: {
117
+ label: {
118
+ id: string;
119
+ description: string;
120
+ defaultMessage: string;
121
+ };
122
+ };
123
+ cancel: {
124
+ label: {
125
+ id: string;
126
+ description: string;
127
+ defaultMessage: string;
128
+ };
129
+ confirmation: {
130
+ title: {
131
+ id: string;
132
+ description: string;
133
+ defaultMessage: string;
134
+ };
135
+ body: {
136
+ id: string;
137
+ description: string;
138
+ defaultMessage: string;
139
+ };
140
+ };
53
141
  };
54
- fields: import("./FieldConfig").Inferred[];
55
- type?: "FORM" | undefined;
56
142
  }>;
57
143
  export declare const VerificationPage: z.ZodObject<z.objectUtil.extendShape<{
58
144
  id: z.ZodString;
@@ -61,8 +147,8 @@ export declare const VerificationPage: z.ZodObject<z.objectUtil.extendShape<{
61
147
  description: string;
62
148
  defaultMessage: string;
63
149
  }>;
64
- fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").Inferred>, "many">;
65
- type: z.ZodDefault<z.ZodEnum<["FORM", "VERIFICATION"]>>;
150
+ fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").InferredInput>, "many">;
151
+ type: z.ZodDefault<z.ZodLiteral<"FORM">>;
66
152
  }, {
67
153
  type: z.ZodLiteral<"VERIFICATION">;
68
154
  actions: z.ZodObject<{
@@ -230,12 +316,13 @@ export declare const VerificationPage: z.ZodObject<z.objectUtil.extendShape<{
230
316
  };
231
317
  };
232
318
  };
233
- fields: import("./FieldConfig").Inferred[];
319
+ fields: import("./FieldConfig").InferredInput[];
234
320
  }>;
235
- export type AllPageConfigs = typeof FormPage | typeof VerificationPage;
236
- export declare const PageConfig: z.ZodDiscriminatedUnion<"type", AllPageConfigs[]>;
237
- export type PageInput = z.input<typeof PageConfig>;
238
- export type Page = z.infer<typeof PageConfig>;
321
+ export type VerificationPageConfig = z.infer<typeof VerificationPageConfig>;
322
+ type AllPageConfigs = typeof FormPage | typeof VerificationPage;
323
+ export declare const FormPageConfig: z.ZodDiscriminatedUnion<"type", AllPageConfigs[]>;
324
+ export type FormPageConfigInput = z.input<typeof FormPageConfig>;
325
+ export type FormPageConfig = z.infer<typeof FormPageConfig>;
239
326
  export declare const FormConfig: z.ZodObject<{
240
327
  label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
241
328
  id: string;
@@ -268,7 +355,7 @@ export declare const FormConfig: z.ZodObject<{
268
355
  description: string;
269
356
  defaultMessage: string;
270
357
  }>;
271
- fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").Inferred>, "many">;
358
+ fields: z.ZodArray<z.ZodType<import("./FieldConfig").Inferred, any, import("./FieldConfig").InferredInput>, "many">;
272
359
  }, "strip", z.ZodTypeAny, {
273
360
  title: TranslationConfig;
274
361
  fields: import("./FieldConfig").Inferred[];
@@ -278,7 +365,7 @@ export declare const FormConfig: z.ZodObject<{
278
365
  description: string;
279
366
  defaultMessage: string;
280
367
  };
281
- fields: import("./FieldConfig").Inferred[];
368
+ fields: import("./FieldConfig").InferredInput[];
282
369
  }>;
283
370
  }, "strip", z.ZodTypeAny, {
284
371
  active: boolean;
@@ -288,10 +375,10 @@ export declare const FormConfig: z.ZodObject<{
288
375
  };
289
376
  label: TranslationConfig;
290
377
  pages: ({
378
+ type: "FORM";
291
379
  id: string;
292
380
  title: TranslationConfig;
293
381
  fields: import("./FieldConfig").Inferred[];
294
- type?: "FORM" | undefined;
295
382
  } | {
296
383
  type: "VERIFICATION";
297
384
  id: string;
@@ -335,7 +422,7 @@ export declare const FormConfig: z.ZodObject<{
335
422
  description: string;
336
423
  defaultMessage: string;
337
424
  };
338
- fields: import("./FieldConfig").Inferred[];
425
+ fields: import("./FieldConfig").InferredInput[];
339
426
  type?: "FORM" | undefined;
340
427
  } | {
341
428
  type: "VERIFICATION";
@@ -373,7 +460,7 @@ export declare const FormConfig: z.ZodObject<{
373
460
  };
374
461
  };
375
462
  };
376
- fields: import("./FieldConfig").Inferred[];
463
+ fields: import("./FieldConfig").InferredInput[];
377
464
  })[];
378
465
  review: {
379
466
  title: {
@@ -381,12 +468,11 @@ export declare const FormConfig: z.ZodObject<{
381
468
  description: string;
382
469
  defaultMessage: string;
383
470
  };
384
- fields: import("./FieldConfig").Inferred[];
471
+ fields: import("./FieldConfig").InferredInput[];
385
472
  };
386
473
  active?: boolean | undefined;
387
474
  }>;
388
- export type FormPage = z.infer<typeof FormPage>;
389
- export type FormPageInput = z.input<typeof FormPage>;
390
475
  export type FormConfig = z.infer<typeof FormConfig>;
391
476
  export type FormConfigInput = z.input<typeof FormConfig>;
477
+ export {};
392
478
  //# sourceMappingURL=FormConfig.d.ts.map
package/dist/commons/events/defineConfig.d.ts CHANGED
@@ -23,10 +23,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
23
23
  };
24
24
  label: import("./TranslationConfig").TranslationConfig;
25
25
  pages: ({
26
+ type: "FORM";
26
27
  id: string;
27
28
  title: import("./TranslationConfig").TranslationConfig;
28
29
  fields: import("./FieldConfig").Inferred[];
29
- type?: "FORM" | undefined;
30
30
  } | {
31
31
  type: "VERIFICATION";
32
32
  id: string;
@@ -69,10 +69,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
69
69
  };
70
70
  label: import("./TranslationConfig").TranslationConfig;
71
71
  pages: ({
72
+ type: "FORM";
72
73
  id: string;
73
74
  title: import("./TranslationConfig").TranslationConfig;
74
75
  fields: import("./FieldConfig").Inferred[];
75
- type?: "FORM" | undefined;
76
76
  } | {
77
77
  type: "VERIFICATION";
78
78
  id: string;
@@ -99,7 +99,6 @@ export declare const defineConfig: (config: EventConfigInput) => {
99
99
  draft?: boolean | undefined;
100
100
  } | {
101
101
  type: "REJECT";
102
- comment: string;
103
102
  conditionals: ({
104
103
  type: "SHOW";
105
104
  conditional: import(".").JSONSchema;
@@ -116,10 +115,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
116
115
  };
117
116
  label: import("./TranslationConfig").TranslationConfig;
118
117
  pages: ({
118
+ type: "FORM";
119
119
  id: string;
120
120
  title: import("./TranslationConfig").TranslationConfig;
121
121
  fields: import("./FieldConfig").Inferred[];
122
- type?: "FORM" | undefined;
123
122
  } | {
124
123
  type: "VERIFICATION";
125
124
  id: string;
@@ -143,11 +142,9 @@ export declare const defineConfig: (config: EventConfigInput) => {
143
142
  fields: import("./FieldConfig").Inferred[];
144
143
  };
145
144
  }[];
146
- isDuplicate: boolean;
147
145
  draft?: boolean | undefined;
148
146
  } | {
149
147
  type: "MARKED_AS_DUPLICATE";
150
- comment: string;
151
148
  conditionals: ({
152
149
  type: "SHOW";
153
150
  conditional: import(".").JSONSchema;
@@ -164,10 +161,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
164
161
  };
165
162
  label: import("./TranslationConfig").TranslationConfig;
166
163
  pages: ({
164
+ type: "FORM";
167
165
  id: string;
168
166
  title: import("./TranslationConfig").TranslationConfig;
169
167
  fields: import("./FieldConfig").Inferred[];
170
- type?: "FORM" | undefined;
171
168
  } | {
172
169
  type: "VERIFICATION";
173
170
  id: string;
@@ -191,11 +188,9 @@ export declare const defineConfig: (config: EventConfigInput) => {
191
188
  fields: import("./FieldConfig").Inferred[];
192
189
  };
193
190
  }[];
194
- duplicates: string[];
195
191
  draft?: boolean | undefined;
196
192
  } | {
197
- type: "ARCHIVED";
198
- comment: string;
193
+ type: "ARCHIVE";
199
194
  conditionals: ({
200
195
  type: "SHOW";
201
196
  conditional: import(".").JSONSchema;
@@ -212,10 +207,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
212
207
  };
213
208
  label: import("./TranslationConfig").TranslationConfig;
214
209
  pages: ({
210
+ type: "FORM";
215
211
  id: string;
216
212
  title: import("./TranslationConfig").TranslationConfig;
217
213
  fields: import("./FieldConfig").Inferred[];
218
- type?: "FORM" | undefined;
219
214
  } | {
220
215
  type: "VERIFICATION";
221
216
  id: string;
@@ -239,7 +234,6 @@ export declare const defineConfig: (config: EventConfigInput) => {
239
234
  fields: import("./FieldConfig").Inferred[];
240
235
  };
241
236
  }[];
242
- isDuplicate: boolean;
243
237
  draft?: boolean | undefined;
244
238
  } | {
245
239
  type: "REGISTER";
@@ -259,10 +253,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
259
253
  };
260
254
  label: import("./TranslationConfig").TranslationConfig;
261
255
  pages: ({
256
+ type: "FORM";
262
257
  id: string;
263
258
  title: import("./TranslationConfig").TranslationConfig;
264
259
  fields: import("./FieldConfig").Inferred[];
265
- type?: "FORM" | undefined;
266
260
  } | {
267
261
  type: "VERIFICATION";
268
262
  id: string;
@@ -305,10 +299,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
305
299
  };
306
300
  label: import("./TranslationConfig").TranslationConfig;
307
301
  pages: ({
302
+ type: "FORM";
308
303
  id: string;
309
304
  title: import("./TranslationConfig").TranslationConfig;
310
305
  fields: import("./FieldConfig").Inferred[];
311
- type?: "FORM" | undefined;
312
306
  } | {
313
307
  type: "VERIFICATION";
314
308
  id: string;
@@ -351,10 +345,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
351
345
  };
352
346
  label: import("./TranslationConfig").TranslationConfig;
353
347
  pages: ({
348
+ type: "FORM";
354
349
  id: string;
355
350
  title: import("./TranslationConfig").TranslationConfig;
356
351
  fields: import("./FieldConfig").Inferred[];
357
- type?: "FORM" | undefined;
358
352
  } | {
359
353
  type: "VERIFICATION";
360
354
  id: string;
@@ -397,10 +391,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
397
391
  };
398
392
  label: import("./TranslationConfig").TranslationConfig;
399
393
  pages: ({
394
+ type: "FORM";
400
395
  id: string;
401
396
  title: import("./TranslationConfig").TranslationConfig;
402
397
  fields: import("./FieldConfig").Inferred[];
403
- type?: "FORM" | undefined;
404
398
  } | {
405
399
  type: "VERIFICATION";
406
400
  id: string;
@@ -424,18 +418,52 @@ export declare const defineConfig: (config: EventConfigInput) => {
424
418
  fields: import("./FieldConfig").Inferred[];
425
419
  };
426
420
  }[];
427
- onboardingForm: {
421
+ onboardingForm: ({
422
+ type: "FORM";
428
423
  id: string;
429
424
  title: import("./TranslationConfig").TranslationConfig;
430
425
  fields: import("./FieldConfig").Inferred[];
431
- type?: "FORM" | undefined;
432
- }[];
433
- additionalDetailsForm: {
426
+ } | {
427
+ type: "VERIFICATION";
434
428
  id: string;
435
429
  title: import("./TranslationConfig").TranslationConfig;
430
+ actions: {
431
+ verify: {
432
+ label: import("./TranslationConfig").TranslationConfig;
433
+ };
434
+ cancel: {
435
+ label: import("./TranslationConfig").TranslationConfig;
436
+ confirmation: {
437
+ title: import("./TranslationConfig").TranslationConfig;
438
+ body: import("./TranslationConfig").TranslationConfig;
439
+ };
440
+ };
441
+ };
436
442
  fields: import("./FieldConfig").Inferred[];
437
- type?: "FORM" | undefined;
438
- }[];
443
+ })[];
444
+ additionalDetailsForm: ({
445
+ type: "FORM";
446
+ id: string;
447
+ title: import("./TranslationConfig").TranslationConfig;
448
+ fields: import("./FieldConfig").Inferred[];
449
+ } | {
450
+ type: "VERIFICATION";
451
+ id: string;
452
+ title: import("./TranslationConfig").TranslationConfig;
453
+ actions: {
454
+ verify: {
455
+ label: import("./TranslationConfig").TranslationConfig;
456
+ };
457
+ cancel: {
458
+ label: import("./TranslationConfig").TranslationConfig;
459
+ confirmation: {
460
+ title: import("./TranslationConfig").TranslationConfig;
461
+ body: import("./TranslationConfig").TranslationConfig;
462
+ };
463
+ };
464
+ };
465
+ fields: import("./FieldConfig").Inferred[];
466
+ })[];
439
467
  draft?: boolean | undefined;
440
468
  } | {
441
469
  type: "REJECT_CORRECTION";
@@ -455,10 +483,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
455
483
  };
456
484
  label: import("./TranslationConfig").TranslationConfig;
457
485
  pages: ({
486
+ type: "FORM";
458
487
  id: string;
459
488
  title: import("./TranslationConfig").TranslationConfig;
460
489
  fields: import("./FieldConfig").Inferred[];
461
- type?: "FORM" | undefined;
462
490
  } | {
463
491
  type: "VERIFICATION";
464
492
  id: string;
@@ -501,10 +529,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
501
529
  };
502
530
  label: import("./TranslationConfig").TranslationConfig;
503
531
  pages: ({
532
+ type: "FORM";
504
533
  id: string;
505
534
  title: import("./TranslationConfig").TranslationConfig;
506
535
  fields: import("./FieldConfig").Inferred[];
507
- type?: "FORM" | undefined;
508
536
  } | {
509
537
  type: "VERIFICATION";
510
538
  id: string;
@@ -547,10 +575,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
547
575
  };
548
576
  label: import("./TranslationConfig").TranslationConfig;
549
577
  pages: ({
578
+ type: "FORM";
550
579
  id: string;
551
580
  title: import("./TranslationConfig").TranslationConfig;
552
581
  fields: import("./FieldConfig").Inferred[];
553
- type?: "FORM" | undefined;
554
582
  } | {
555
583
  type: "VERIFICATION";
556
584
  id: string;