@opencrvs/toolkit 1.8.0-rc.f876361 → 1.8.0-rc.f8e4107

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 (23) hide show
  1. package/dist/commons/api/router.d.ts +3159 -158
  2. package/dist/commons/conditionals/conditionals.d.ts +80 -8
  3. package/dist/commons/conditionals/validate.d.ts +14 -17
  4. package/dist/commons/events/ActionDocument.d.ts +212 -101
  5. package/dist/commons/events/ActionInput.d.ts +1109 -214
  6. package/dist/commons/events/ActionType.d.ts +5 -3
  7. package/dist/commons/events/AdvancedSearchConfig.d.ts +107 -14
  8. package/dist/commons/events/Conditional.d.ts +21 -5
  9. package/dist/commons/events/Draft.d.ts +24 -12
  10. package/dist/commons/events/EventConfig.d.ts +132 -66
  11. package/dist/commons/events/EventDocument.d.ts +161 -76
  12. package/dist/commons/events/EventIndex.d.ts +746 -4
  13. package/dist/commons/events/EventMetadata.d.ts +6 -3
  14. package/dist/commons/events/FieldConfig.d.ts +208 -70
  15. package/dist/commons/events/PageConfig.d.ts +0 -24
  16. package/dist/commons/events/TemplateConfig.d.ts +5 -5
  17. package/dist/commons/events/defineConfig.d.ts +15 -11
  18. package/dist/commons/events/test.utils.d.ts +20 -112
  19. package/dist/commons/events/utils.d.ts +60 -54
  20. package/dist/commons/events/utils.test.d.ts +2 -0
  21. package/dist/conditionals/index.js +180 -151
  22. package/dist/events/index.js +1325 -1103
  23. package/package.json +1 -1
package/dist/commons/events/ActionType.d.ts CHANGED
@@ -27,11 +27,13 @@ export declare const ConfirmableActions: readonly ["NOTIFY", "DECLARE", "VALIDAT
27
27
  export declare const ActionTypes: z.ZodEnum<["DELETE", "CREATE", "NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION", "READ", "ASSIGN", "UNASSIGN"]>;
28
28
  /** Actions which change event data (declaration) before registration / during declaration. */
29
29
  export declare const DeclarationActions: z.ZodEnum<["DECLARE", "VALIDATE", "REGISTER"]>;
30
- export type DeclarationAction = z.infer<typeof DeclarationActions>;
30
+ export type DeclarationActionType = z.infer<typeof DeclarationActions>;
31
31
  /** Actions that can modify declaration data. Request can be corrected after declaring it. */
32
32
  export declare const DeclarationUpdateActions: z.ZodEnum<["DECLARE", "VALIDATE", "REGISTER", "REQUEST_CORRECTION"]>;
33
- export type DeclarationUpdateAction = z.infer<typeof DeclarationUpdateActions>;
33
+ export type DeclarationUpdateActionType = z.infer<typeof DeclarationUpdateActions>;
34
34
  /** Actions which update annotation or status of an event. */
35
35
  export declare const annotationActions: z.ZodEnum<["DELETE", "CREATE", "NOTIFY", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION", "READ", "ASSIGN", "UNASSIGN"]>;
36
- export type MetadataAction = z.infer<typeof annotationActions>;
36
+ export type AnnotationActionType = z.infer<typeof annotationActions>;
37
+ /** Actions which requires the user to be assigned */
38
+ export declare const writeActions: z.ZodEnum<["DELETE", "NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION"]>;
37
39
  //# sourceMappingURL=ActionType.d.ts.map
package/dist/commons/events/AdvancedSearchConfig.d.ts CHANGED
@@ -1,5 +1,55 @@
1
1
  import { z } from 'zod';
2
2
  import { TranslationConfig } from './TranslationConfig';
3
+ export declare const FieldConfigSchema: z.ZodObject<{
4
+ fieldId: z.ZodString;
5
+ config: z.ZodObject<{
6
+ type: z.ZodEnum<["FUZZY", "EXACT", "RANGE"]>;
7
+ }, "strip", z.ZodTypeAny, {
8
+ type: "FUZZY" | "EXACT" | "RANGE";
9
+ }, {
10
+ type: "FUZZY" | "EXACT" | "RANGE";
11
+ }>;
12
+ options: z.ZodOptional<z.ZodArray<z.ZodObject<{
13
+ value: z.ZodString;
14
+ label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
15
+ id: string;
16
+ description: string;
17
+ defaultMessage: string;
18
+ }>;
19
+ }, "strip", z.ZodTypeAny, {
20
+ value: string;
21
+ label: TranslationConfig;
22
+ }, {
23
+ value: string;
24
+ label: {
25
+ id: string;
26
+ description: string;
27
+ defaultMessage: string;
28
+ };
29
+ }>, "many">>;
30
+ }, "strip", z.ZodTypeAny, {
31
+ config: {
32
+ type: "FUZZY" | "EXACT" | "RANGE";
33
+ };
34
+ fieldId: string;
35
+ options?: {
36
+ value: string;
37
+ label: TranslationConfig;
38
+ }[] | undefined;
39
+ }, {
40
+ config: {
41
+ type: "FUZZY" | "EXACT" | "RANGE";
42
+ };
43
+ fieldId: string;
44
+ options?: {
45
+ value: string;
46
+ label: {
47
+ id: string;
48
+ description: string;
49
+ defaultMessage: string;
50
+ };
51
+ }[] | undefined;
52
+ }>;
3
53
  export declare const AdvancedSearchConfig: z.ZodObject<{
4
54
  title: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
5
55
  id: string;
@@ -8,31 +58,65 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
8
58
  }>;
9
59
  fields: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
10
60
  fieldId: z.ZodString;
11
- config: z.ZodOptional<z.ZodObject<{
61
+ config: z.ZodObject<{
12
62
  type: z.ZodEnum<["FUZZY", "EXACT", "RANGE"]>;
13
63
  }, "strip", z.ZodTypeAny, {
14
64
  type: "FUZZY" | "EXACT" | "RANGE";
15
65
  }, {
16
66
  type: "FUZZY" | "EXACT" | "RANGE";
17
- }>>;
67
+ }>;
68
+ options: z.ZodOptional<z.ZodArray<z.ZodObject<{
69
+ value: z.ZodString;
70
+ label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
71
+ id: string;
72
+ description: string;
73
+ defaultMessage: string;
74
+ }>;
75
+ }, "strip", z.ZodTypeAny, {
76
+ value: string;
77
+ label: TranslationConfig;
78
+ }, {
79
+ value: string;
80
+ label: {
81
+ id: string;
82
+ description: string;
83
+ defaultMessage: string;
84
+ };
85
+ }>, "many">>;
18
86
  }, "strip", z.ZodTypeAny, {
19
- fieldId: string;
20
- config?: {
87
+ config: {
21
88
  type: "FUZZY" | "EXACT" | "RANGE";
22
- } | undefined;
23
- }, {
89
+ };
24
90
  fieldId: string;
25
- config?: {
91
+ options?: {
92
+ value: string;
93
+ label: TranslationConfig;
94
+ }[] | undefined;
95
+ }, {
96
+ config: {
26
97
  type: "FUZZY" | "EXACT" | "RANGE";
27
- } | undefined;
98
+ };
99
+ fieldId: string;
100
+ options?: {
101
+ value: string;
102
+ label: {
103
+ id: string;
104
+ description: string;
105
+ defaultMessage: string;
106
+ };
107
+ }[] | undefined;
28
108
  }>, "many">>>;
29
109
  }, "strip", z.ZodTypeAny, {
30
110
  title: TranslationConfig;
31
111
  fields: {
32
- fieldId: string;
33
- config?: {
112
+ config: {
34
113
  type: "FUZZY" | "EXACT" | "RANGE";
35
- } | undefined;
114
+ };
115
+ fieldId: string;
116
+ options?: {
117
+ value: string;
118
+ label: TranslationConfig;
119
+ }[] | undefined;
36
120
  }[];
37
121
  }, {
38
122
  title: {
@@ -41,11 +125,20 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
41
125
  defaultMessage: string;
42
126
  };
43
127
  fields?: {
44
- fieldId: string;
45
- config?: {
128
+ config: {
46
129
  type: "FUZZY" | "EXACT" | "RANGE";
47
- } | undefined;
130
+ };
131
+ fieldId: string;
132
+ options?: {
133
+ value: string;
134
+ label: {
135
+ id: string;
136
+ description: string;
137
+ defaultMessage: string;
138
+ };
139
+ }[] | undefined;
48
140
  }[] | undefined;
49
141
  }>;
142
+ export type AdvancedSearchConfigInput = z.infer<typeof AdvancedSearchConfig>;
50
143
  export type AdvancedSearchConfig = z.infer<typeof AdvancedSearchConfig>;
51
144
  //# sourceMappingURL=AdvancedSearchConfig.d.ts.map
package/dist/commons/events/Conditional.d.ts CHANGED
@@ -1,15 +1,15 @@
1
1
  import { JSONSchema } from '../conditionals/conditionals';
2
2
  import { z } from 'zod';
3
- export declare function Conditional(): z.ZodType<JSONSchema, z.ZodTypeDef, JSONSchema>;
3
+ export declare const Conditional: z.ZodType<JSONSchema, z.ZodTypeDef, JSONSchema>;
4
4
  /**
5
5
  * By default, when conditionals are undefined, action is visible and enabled to everyone.
6
6
  */
7
7
  export declare const ConditionalType: {
8
- /** When 'SHOW' conditional is defined, the action is shown to the user only if the condition is met */
9
8
  readonly SHOW: "SHOW";
10
- /** If 'ENABLE' conditional is defined, the action is enabled only if the condition is met */
11
9
  readonly ENABLE: "ENABLE";
10
+ readonly DISPLAY_ON_REVIEW: "DISPLAY_ON_REVIEW";
12
11
  };
12
+ export type ConditionalType = (typeof ConditionalType)[keyof typeof ConditionalType];
13
13
  export declare const ShowConditional: z.ZodObject<{
14
14
  type: z.ZodLiteral<"SHOW">;
15
15
  conditional: z.ZodType<JSONSchema, z.ZodTypeDef, JSONSchema>;
@@ -31,9 +31,25 @@ export declare const EnableConditional: z.ZodObject<{
31
31
  conditional: JSONSchema;
32
32
  }>;
33
33
  /** @knipignore */
34
- export type AllActionConditionalFields = typeof ShowConditional | typeof EnableConditional;
34
+ export type ActionConditionalType = typeof ShowConditional | typeof EnableConditional;
35
35
  /** @knipignore */
36
36
  export type InferredActionConditional = z.infer<typeof ShowConditional> | z.infer<typeof EnableConditional>;
37
- export declare const ActionConditional: z.ZodDiscriminatedUnion<"type", AllActionConditionalFields[]>;
37
+ export declare const ActionConditional: z.ZodDiscriminatedUnion<"type", ActionConditionalType[]>;
38
38
  export type ActionConditional = InferredActionConditional;
39
+ export declare const DisplayOnReviewConditional: z.ZodObject<{
40
+ type: z.ZodLiteral<"DISPLAY_ON_REVIEW">;
41
+ conditional: z.ZodType<JSONSchema, z.ZodTypeDef, JSONSchema>;
42
+ }, "strip", z.ZodTypeAny, {
43
+ type: "DISPLAY_ON_REVIEW";
44
+ conditional: JSONSchema;
45
+ }, {
46
+ type: "DISPLAY_ON_REVIEW";
47
+ conditional: JSONSchema;
48
+ }>;
49
+ /** @knipignore */
50
+ export type FieldConditionalType = typeof ShowConditional | typeof EnableConditional | typeof DisplayOnReviewConditional;
51
+ /** @knipignore */
52
+ export type InferredFieldConditional = z.infer<typeof ShowConditional> | z.infer<typeof EnableConditional> | z.infer<typeof DisplayOnReviewConditional>;
53
+ export declare const FieldConditional: z.ZodDiscriminatedUnion<"type", FieldConditionalType[]>;
54
+ export type FieldConditional = z.infer<typeof FieldConditional>;
39
55
  //# sourceMappingURL=Conditional.d.ts.map
package/dist/commons/events/Draft.d.ts CHANGED
@@ -236,13 +236,15 @@ export declare const Draft: z.ZodObject<{
236
236
  addressLine3?: string | null | undefined;
237
237
  postcodeOrZip?: string | null | undefined;
238
238
  }>]>>>;
239
- createdAtLocation: z.ZodString;
239
+ createdAtLocation: z.ZodOptional<z.ZodString>;
240
+ updatedAtLocation: z.ZodOptional<z.ZodString>;
240
241
  status: z.ZodEnum<["Requested", "Accepted", "Rejected"]>;
241
242
  originalActionId: z.ZodOptional<z.ZodString>;
242
243
  }, {
243
244
  type: z.ZodEnum<["DELETE", "CREATE", "NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION", "READ", "ASSIGN", "UNASSIGN"]>;
244
- }>, "id" | "status">, "strip", z.ZodTypeAny, {
245
+ }>, "id">, "strip", z.ZodTypeAny, {
245
246
  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";
247
+ status: "Rejected" | "Requested" | "Accepted";
246
248
  createdAt: string;
247
249
  createdBy: string;
248
250
  declaration: Record<string, string | number | boolean | {
@@ -283,7 +285,6 @@ export declare const Draft: z.ZodObject<{
283
285
  filename: string;
284
286
  originalFilename: string;
285
287
  }[] | undefined>;
286
- createdAtLocation: string;
287
288
  annotation?: Record<string, string | number | boolean | {
288
289
  type: string;
289
290
  filename: string;
@@ -322,9 +323,12 @@ export declare const Draft: z.ZodObject<{
322
323
  filename: string;
323
324
  originalFilename: string;
324
325
  }[] | undefined> | undefined;
326
+ createdAtLocation?: string | undefined;
327
+ updatedAtLocation?: string | undefined;
325
328
  originalActionId?: string | undefined;
326
329
  }, {
327
330
  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";
331
+ status: "Rejected" | "Requested" | "Accepted";
328
332
  createdAt: string;
329
333
  createdBy: string;
330
334
  declaration: Record<string, string | number | boolean | {
@@ -365,7 +369,6 @@ export declare const Draft: z.ZodObject<{
365
369
  filename: string;
366
370
  originalFilename: string;
367
371
  }[] | undefined>;
368
- createdAtLocation: string;
369
372
  annotation?: Record<string, string | number | boolean | {
370
373
  type: string;
371
374
  filename: string;
@@ -404,6 +407,8 @@ export declare const Draft: z.ZodObject<{
404
407
  filename: string;
405
408
  originalFilename: string;
406
409
  }[] | undefined> | undefined;
410
+ createdAtLocation?: string | undefined;
411
+ updatedAtLocation?: string | undefined;
407
412
  originalActionId?: string | undefined;
408
413
  }>;
409
414
  }, "strip", z.ZodTypeAny, {
@@ -413,6 +418,7 @@ export declare const Draft: z.ZodObject<{
413
418
  transactionId: string;
414
419
  action: {
415
420
  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";
421
+ status: "Rejected" | "Requested" | "Accepted";
416
422
  createdAt: string;
417
423
  createdBy: string;
418
424
  declaration: Record<string, string | number | boolean | {
@@ -453,7 +459,6 @@ export declare const Draft: z.ZodObject<{
453
459
  filename: string;
454
460
  originalFilename: string;
455
461
  }[] | undefined>;
456
- createdAtLocation: string;
457
462
  annotation?: Record<string, string | number | boolean | {
458
463
  type: string;
459
464
  filename: string;
@@ -492,6 +497,8 @@ export declare const Draft: z.ZodObject<{
492
497
  filename: string;
493
498
  originalFilename: string;
494
499
  }[] | undefined> | undefined;
500
+ createdAtLocation?: string | undefined;
501
+ updatedAtLocation?: string | undefined;
495
502
  originalActionId?: string | undefined;
496
503
  };
497
504
  }, {
@@ -501,6 +508,7 @@ export declare const Draft: z.ZodObject<{
501
508
  transactionId: string;
502
509
  action: {
503
510
  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";
511
+ status: "Rejected" | "Requested" | "Accepted";
504
512
  createdAt: string;
505
513
  createdBy: string;
506
514
  declaration: Record<string, string | number | boolean | {
@@ -541,7 +549,6 @@ export declare const Draft: z.ZodObject<{
541
549
  filename: string;
542
550
  originalFilename: string;
543
551
  }[] | undefined>;
544
- createdAtLocation: string;
545
552
  annotation?: Record<string, string | number | boolean | {
546
553
  type: string;
547
554
  filename: string;
@@ -580,13 +587,15 @@ export declare const Draft: z.ZodObject<{
580
587
  filename: string;
581
588
  originalFilename: string;
582
589
  }[] | undefined> | undefined;
590
+ createdAtLocation?: string | undefined;
591
+ updatedAtLocation?: string | undefined;
583
592
  originalActionId?: string | undefined;
584
593
  };
585
594
  }>;
586
595
  export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
587
596
  eventId: z.ZodString;
588
597
  transactionId: z.ZodString;
589
- declaration: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
598
+ declaration: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
590
599
  filename: z.ZodString;
591
600
  originalFilename: z.ZodString;
592
601
  type: z.ZodString;
@@ -699,7 +708,7 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
699
708
  addressLine2?: string | null | undefined;
700
709
  addressLine3?: string | null | undefined;
701
710
  postcodeOrZip?: string | null | undefined;
702
- }>]>>;
711
+ }>]>>>;
703
712
  annotation: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
704
713
  filename: z.ZodString;
705
714
  originalFilename: z.ZodString;
@@ -815,6 +824,7 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
815
824
  postcodeOrZip?: string | null | undefined;
816
825
  }>]>>>;
817
826
  originalActionId: z.ZodOptional<z.ZodString>;
827
+ keepAssignment: z.ZodOptional<z.ZodBoolean>;
818
828
  }, {
819
829
  type: z.ZodEnum<["DELETE", "CREATE", "NOTIFY", "DECLARE", "VALIDATE", "REGISTER", "DETECT_DUPLICATE", "REJECT", "MARKED_AS_DUPLICATE", "ARCHIVE", "PRINT_CERTIFICATE", "REQUEST_CORRECTION", "REJECT_CORRECTION", "APPROVE_CORRECTION", "READ", "ASSIGN", "UNASSIGN"]>;
820
830
  }>, "strip", z.ZodTypeAny, {
@@ -898,9 +908,12 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
898
908
  originalFilename: string;
899
909
  }[] | undefined> | undefined;
900
910
  originalActionId?: string | undefined;
911
+ keepAssignment?: boolean | undefined;
901
912
  }, {
902
913
  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";
903
- declaration: Record<string, string | number | boolean | {
914
+ eventId: string;
915
+ transactionId: string;
916
+ declaration?: Record<string, string | number | boolean | {
904
917
  type: string;
905
918
  filename: string;
906
919
  originalFilename: string;
@@ -937,9 +950,7 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
937
950
  option: string;
938
951
  filename: string;
939
952
  originalFilename: string;
940
- }[] | undefined>;
941
- eventId: string;
942
- transactionId: string;
953
+ }[] | undefined> | undefined;
943
954
  annotation?: Record<string, string | number | boolean | {
944
955
  type: string;
945
956
  filename: string;
@@ -979,6 +990,7 @@ export declare const DraftInput: z.ZodObject<z.objectUtil.extendShape<{
979
990
  originalFilename: string;
980
991
  }[] | undefined> | undefined;
981
992
  originalActionId?: string | undefined;
993
+ keepAssignment?: boolean | undefined;
982
994
  }>;
983
995
  export type Draft = z.infer<typeof Draft>;
984
996
  export type DraftInput = z.infer<typeof DraftInput>;