@opencrvs/toolkit 1.9.2-rc.fd254a6 → 1.9.3-rc.0263d03

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 (59) hide show
  1. package/dist/commons/api/router.d.ts +28094 -2317
  2. package/dist/commons/conditionals/conditionals.d.ts +54 -1
  3. package/dist/commons/conditionals/validate.d.ts +12 -4
  4. package/dist/commons/events/ActionConfig.d.ts +23125 -1523
  5. package/dist/commons/events/ActionDocument.d.ts +840 -1849
  6. package/dist/commons/events/ActionInput.d.ts +290 -1066
  7. package/dist/commons/events/ActionType.d.ts +91 -8
  8. package/dist/commons/events/AdvancedSearchConfig.d.ts +222 -1238
  9. package/dist/commons/events/CompositeFieldValue.d.ts +25 -176
  10. package/dist/commons/events/Conditional.d.ts +26 -38
  11. package/dist/commons/events/Constants.d.ts +1 -1
  12. package/dist/commons/events/CountryConfigQueryInput.d.ts +931 -4169
  13. package/dist/commons/events/CreatedAtLocation.d.ts +1 -1
  14. package/dist/commons/events/DeduplicationConfig.d.ts +15 -150
  15. package/dist/commons/events/Draft.d.ts +72 -105
  16. package/dist/commons/events/DynamicFieldValue.d.ts +7 -91
  17. package/dist/commons/events/EventConfig.d.ts +18322 -2096
  18. package/dist/commons/events/EventConfigInput.d.ts +1 -1
  19. package/dist/commons/events/EventDocument.d.ts +336 -1326
  20. package/dist/commons/events/EventIndex.d.ts +197 -967
  21. package/dist/commons/events/EventInput.d.ts +2 -8
  22. package/dist/commons/events/EventMetadata.d.ts +106 -346
  23. package/dist/commons/events/FieldConfig.d.ts +4173 -11778
  24. package/dist/commons/events/FieldType.d.ts +9 -4
  25. package/dist/commons/events/FieldTypeMapping.d.ts +172 -811
  26. package/dist/commons/events/FieldValue.d.ts +82 -355
  27. package/dist/commons/events/Flag.d.ts +70 -0
  28. package/dist/commons/events/FormConfig.d.ts +12882 -697
  29. package/dist/commons/events/PageConfig.d.ts +8605 -314
  30. package/dist/commons/events/SummaryConfig.d.ts +14 -161
  31. package/dist/commons/events/TemplateConfig.d.ts +5 -4
  32. package/dist/commons/events/TranslationConfig.d.ts +2 -2
  33. package/dist/commons/events/WorkqueueColumnConfig.d.ts +74 -37
  34. package/dist/commons/events/WorkqueueConfig.d.ts +1695 -7156
  35. package/dist/commons/events/deduplication.d.ts +3 -3
  36. package/dist/commons/events/defineConfig.d.ts +25160 -147
  37. package/dist/commons/events/event.d.ts +4 -4
  38. package/dist/commons/events/field.d.ts +110 -0
  39. package/dist/commons/events/index.d.ts +1 -0
  40. package/dist/commons/events/locations.d.ts +15 -19
  41. package/dist/commons/events/scopes.d.ts +3 -1
  42. package/dist/commons/events/state/availableActions.d.ts +2 -1
  43. package/dist/commons/events/state/flags.d.ts +21 -3
  44. package/dist/commons/events/state/index.d.ts +23 -19
  45. package/dist/commons/events/state/utils.d.ts +142 -110
  46. package/dist/commons/events/test.utils.d.ts +23 -6
  47. package/dist/commons/events/transactions.d.ts +1 -1
  48. package/dist/commons/events/utils.d.ts +50377 -357
  49. package/dist/commons/notification/UserNotifications.d.ts +55 -636
  50. package/dist/conditionals/index.d.ts.map +1 -1
  51. package/dist/conditionals/index.js +103 -10
  52. package/dist/events/deduplication.d.ts +3 -3
  53. package/dist/events/index.js +1921 -1501
  54. package/dist/notification/index.d.ts.map +1 -1
  55. package/dist/notification/index.js +1645 -1471
  56. package/dist/scopes/index.d.ts +138 -138
  57. package/dist/scopes/index.d.ts.map +1 -1
  58. package/dist/scopes/index.js +123 -93
  59. package/package.json +5 -5
package/dist/commons/conditionals/conditionals.d.ts CHANGED
@@ -4,6 +4,7 @@ import { ITokenPayload as TokenPayload, Scope } from '../authentication';
4
4
  import { PartialSchema as AjvJSONSchemaType } from 'ajv/dist/types/json-schema';
5
5
  import { userSerializer } from '../events/serializers/user/serializer';
6
6
  import { UUID } from '../uuid';
7
+ import { EventStatus } from '../events/EventMetadata';
7
8
  /** @knipignore */
8
9
  export type JSONSchema = {
9
10
  $id: string;
@@ -27,7 +28,11 @@ export type FormConditionalParameters = CommonConditionalParameters & {
27
28
  id: UUID;
28
29
  }>;
29
30
  };
30
- export type ConditionalParameters = UserConditionalParameters | EventConditionalParameters | FormConditionalParameters;
31
+ export type EventStateConditionalParameters = CommonConditionalParameters & {
32
+ $flags: string[];
33
+ $status: EventStatus;
34
+ };
35
+ export type ConditionalParameters = UserConditionalParameters | EventConditionalParameters | FormConditionalParameters | EventStateConditionalParameters;
31
36
  type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
32
37
  type AjvJSONSchema = AjvJSONSchemaType<UnionToIntersection<ConditionalParameters>>;
33
38
  /**
@@ -79,6 +84,10 @@ export declare const user: typeof userSerializer & {
79
84
  };
80
85
  };
81
86
  export declare function isFieldReference(value: unknown): value is FieldReference;
87
+ /** Check if an event flag is present */
88
+ export declare function flag(flagvalue: string): JSONSchema;
89
+ /** Check if an event flag is present */
90
+ export declare function status(statusValue: EventStatus): JSONSchema;
82
91
  /**
83
92
  * Generate conditional rules for a form field.
84
93
  *
@@ -117,6 +126,8 @@ export declare function createFieldConditionals(fieldId: string): {
117
126
  days: (days: number) => {
118
127
  inPast: () => JSONSchema;
119
128
  inFuture: () => JSONSchema;
129
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
130
+ fromNow: () => JSONSchema;
120
131
  };
121
132
  date: (date: string | FieldReference) => JSONSchema;
122
133
  now: () => JSONSchema;
@@ -125,6 +136,8 @@ export declare function createFieldConditionals(fieldId: string): {
125
136
  days: (days: number) => {
126
137
  inPast: () => JSONSchema;
127
138
  inFuture: () => JSONSchema;
139
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
140
+ fromNow: () => JSONSchema;
128
141
  };
129
142
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
130
143
  now: () => JSONSchema;
@@ -172,6 +185,8 @@ export declare function createFieldConditionals(fieldId: string): {
172
185
  days: (days: number) => {
173
186
  inPast: () => JSONSchema;
174
187
  inFuture: () => JSONSchema;
188
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
189
+ fromNow: () => JSONSchema;
175
190
  };
176
191
  date: (date: string | FieldReference) => JSONSchema;
177
192
  now: () => JSONSchema;
@@ -180,6 +195,8 @@ export declare function createFieldConditionals(fieldId: string): {
180
195
  days: (days: number) => {
181
196
  inPast: () => JSONSchema;
182
197
  inFuture: () => JSONSchema;
198
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
199
+ fromNow: () => JSONSchema;
183
200
  };
184
201
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
185
202
  now: () => JSONSchema;
@@ -241,6 +258,8 @@ export declare function createFieldConditionals(fieldId: string): {
241
258
  days: (days: number) => {
242
259
  inPast: () => JSONSchema;
243
260
  inFuture: () => JSONSchema;
261
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
262
+ fromNow: () => JSONSchema;
244
263
  };
245
264
  date: (date: string | FieldReference) => JSONSchema;
246
265
  now: () => JSONSchema;
@@ -249,6 +268,8 @@ export declare function createFieldConditionals(fieldId: string): {
249
268
  days: (days: number) => {
250
269
  inPast: () => JSONSchema;
251
270
  inFuture: () => JSONSchema;
271
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
272
+ fromNow: () => JSONSchema;
252
273
  };
253
274
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
254
275
  now: () => JSONSchema;
@@ -305,6 +326,8 @@ export declare function createFieldConditionals(fieldId: string): {
305
326
  days: (days: number) => {
306
327
  inPast: () => JSONSchema;
307
328
  inFuture: () => JSONSchema;
329
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
330
+ fromNow: () => JSONSchema;
308
331
  };
309
332
  date: (date: string | FieldReference) => JSONSchema;
310
333
  now: () => JSONSchema;
@@ -313,6 +336,8 @@ export declare function createFieldConditionals(fieldId: string): {
313
336
  days: (days: number) => {
314
337
  inPast: () => JSONSchema;
315
338
  inFuture: () => JSONSchema;
339
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
340
+ fromNow: () => JSONSchema;
316
341
  };
317
342
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
318
343
  now: () => JSONSchema;
@@ -368,6 +393,8 @@ export declare function createFieldConditionals(fieldId: string): {
368
393
  days: (days: number) => {
369
394
  inPast: () => JSONSchema;
370
395
  inFuture: () => JSONSchema;
396
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
397
+ fromNow: () => JSONSchema;
371
398
  };
372
399
  date: (date: string | FieldReference) => JSONSchema;
373
400
  now: () => JSONSchema;
@@ -376,6 +403,8 @@ export declare function createFieldConditionals(fieldId: string): {
376
403
  days: (days: number) => {
377
404
  inPast: () => JSONSchema;
378
405
  inFuture: () => JSONSchema;
406
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
407
+ fromNow: () => JSONSchema;
379
408
  };
380
409
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
381
410
  now: () => JSONSchema;
@@ -421,6 +450,8 @@ export declare function createFieldConditionals(fieldId: string): {
421
450
  days: (days: number) => {
422
451
  inPast: () => JSONSchema;
423
452
  inFuture: () => JSONSchema;
453
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
454
+ fromNow: () => JSONSchema;
424
455
  };
425
456
  date: (date: string | FieldReference) => JSONSchema;
426
457
  now: () => JSONSchema;
@@ -429,6 +460,8 @@ export declare function createFieldConditionals(fieldId: string): {
429
460
  days: (days: number) => {
430
461
  inPast: () => JSONSchema;
431
462
  inFuture: () => JSONSchema;
463
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
464
+ fromNow: () => JSONSchema;
432
465
  };
433
466
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
434
467
  now: () => JSONSchema;
@@ -491,6 +524,8 @@ export declare function createFieldConditionals(fieldId: string): {
491
524
  days: (days: number) => {
492
525
  inPast: () => JSONSchema;
493
526
  inFuture: () => JSONSchema;
527
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
528
+ fromNow: () => JSONSchema;
494
529
  };
495
530
  date: (date: string | FieldReference) => JSONSchema;
496
531
  now: () => JSONSchema;
@@ -499,6 +534,8 @@ export declare function createFieldConditionals(fieldId: string): {
499
534
  days: (days: number) => {
500
535
  inPast: () => JSONSchema;
501
536
  inFuture: () => JSONSchema;
537
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
538
+ fromNow: () => JSONSchema;
502
539
  };
503
540
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
504
541
  now: () => JSONSchema;
@@ -546,6 +583,8 @@ export declare function createFieldConditionals(fieldId: string): {
546
583
  days: (days: number) => {
547
584
  inPast: () => JSONSchema;
548
585
  inFuture: () => JSONSchema;
586
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
587
+ fromNow: () => JSONSchema;
549
588
  };
550
589
  date: (date: string | FieldReference) => JSONSchema;
551
590
  now: () => JSONSchema;
@@ -554,6 +593,8 @@ export declare function createFieldConditionals(fieldId: string): {
554
593
  days: (days: number) => {
555
594
  inPast: () => JSONSchema;
556
595
  inFuture: () => JSONSchema;
596
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
597
+ fromNow: () => JSONSchema;
557
598
  };
558
599
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
559
600
  now: () => JSONSchema;
@@ -616,6 +657,8 @@ export declare function createFieldConditionals(fieldId: string): {
616
657
  days: (days: number) => {
617
658
  inPast: () => JSONSchema;
618
659
  inFuture: () => JSONSchema;
660
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
661
+ fromNow: () => JSONSchema;
619
662
  };
620
663
  date: (date: string | FieldReference) => JSONSchema;
621
664
  now: () => JSONSchema;
@@ -624,6 +667,8 @@ export declare function createFieldConditionals(fieldId: string): {
624
667
  days: (days: number) => {
625
668
  inPast: () => JSONSchema;
626
669
  inFuture: () => JSONSchema;
670
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
671
+ fromNow: () => JSONSchema;
627
672
  };
628
673
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
629
674
  now: () => JSONSchema;
@@ -671,6 +716,8 @@ export declare function createFieldConditionals(fieldId: string): {
671
716
  days: (days: number) => {
672
717
  inPast: () => JSONSchema;
673
718
  inFuture: () => JSONSchema;
719
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
720
+ fromNow: () => JSONSchema;
674
721
  };
675
722
  date: (date: string | FieldReference) => JSONSchema;
676
723
  now: () => JSONSchema;
@@ -679,6 +726,8 @@ export declare function createFieldConditionals(fieldId: string): {
679
726
  days: (days: number) => {
680
727
  inPast: () => JSONSchema;
681
728
  inFuture: () => JSONSchema;
729
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
730
+ fromNow: () => JSONSchema;
682
731
  };
683
732
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
684
733
  now: () => JSONSchema;
@@ -724,6 +773,8 @@ export declare function createFieldConditionals(fieldId: string): {
724
773
  days: (days: number) => {
725
774
  inPast: () => JSONSchema;
726
775
  inFuture: () => JSONSchema;
776
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
777
+ fromNow: () => JSONSchema;
727
778
  };
728
779
  date: (date: string | FieldReference) => JSONSchema;
729
780
  now: () => JSONSchema;
@@ -732,6 +783,8 @@ export declare function createFieldConditionals(fieldId: string): {
732
783
  days: (days: number) => {
733
784
  inPast: () => JSONSchema;
734
785
  inFuture: () => JSONSchema;
786
+ fromDate: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
787
+ fromNow: () => JSONSchema;
735
788
  };
736
789
  date: (date: `${string}-${string}-${string}` | FieldReference) => JSONSchema;
737
790
  now: () => JSONSchema;
package/dist/commons/conditionals/validate.d.ts CHANGED
@@ -6,21 +6,25 @@ import { FieldUpdateValue, FieldValue } from '../events/FieldValue';
6
6
  import { TranslationConfig } from '../events/TranslationConfig';
7
7
  import { ITokenPayload } from '../authentication';
8
8
  import { UUID } from '../uuid';
9
- import { ActionType } from '../client';
9
+ import { ActionConfig, ActionType, EventDocument, EventIndex } from '../client';
10
10
  export declare function validate(schema: JSONSchema, data: ConditionalParameters): boolean;
11
11
  export declare function validateValue(schema: JSONSchema, data: unknown): boolean;
12
12
  export declare function isOnline(): boolean;
13
- export declare function isConditionMet(conditional: JSONSchema, values: EventState | ActionUpdate, context: ValidatorContext): boolean;
14
- export declare function areConditionsMet(conditions: FieldConditional[], values: Record<string, FieldValue>, context: ValidatorContext): boolean;
13
+ export declare function isConditionMet(conditional: JSONSchema, values: EventState | ActionUpdate, context: ValidatorContext, eventIndex?: EventIndex): boolean;
14
+ export declare function areConditionsMet(conditions: FieldConditional[], values: Record<string, FieldValue>, context: ValidatorContext, event: EventIndex): boolean;
15
15
  export type ValidatorContext = {
16
16
  user?: ITokenPayload;
17
17
  leafAdminStructureLocationIds?: Array<{
18
18
  id: UUID;
19
19
  }>;
20
+ event?: EventDocument;
20
21
  };
21
22
  export declare function isFieldVisible(field: FieldConfig, form: Partial<ActionUpdate | EventState>, context: ValidatorContext): boolean;
22
23
  export declare function isFieldEnabled(field: FieldConfig, form: ActionUpdate | EventState, context: ValidatorContext): boolean;
23
24
  export declare function isFieldDisplayedOnReview(field: FieldConfig, form: ActionUpdate | EventState, context: ValidatorContext): boolean;
25
+ export declare function isActionEnabled(actionConfig: ActionConfig, event: EventIndex, context: ValidatorContext): boolean;
26
+ export declare function isActionVisible(actionConfig: ActionConfig, event: EventIndex, context: ValidatorContext): boolean;
27
+ export declare function isActionAvailable(actionConfig: ActionConfig, event: EventIndex, context: ValidatorContext): boolean;
24
28
  export declare const errorMessages: {
25
29
  hiddenField: {
26
30
  id: string;
@@ -93,7 +97,11 @@ export declare function runFieldValidations({ field, values, context }: {
93
97
  values: ActionUpdate;
94
98
  context: ValidatorContext;
95
99
  }): {
96
- message: TranslationConfig;
100
+ message: {
101
+ id: string;
102
+ defaultMessage: string;
103
+ description: string;
104
+ };
97
105
  }[];
98
106
  export declare function getValidatorsForField(fieldId: FieldConfig['id'], validations: NonNullable<FieldConfig['validation']>): NonNullable<FieldConfig['validation']>;
99
107
  export declare function areCertificateConditionsMet(conditions: FieldConditional[], values: ConditionalParameters): boolean;