@opencrvs/toolkit 1.8.0-rc.fcd89ec → 1.8.0-rc.fcf7cb3

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 (48) hide show
  1. package/dist/commons/api/router.d.ts +8046 -8610
  2. package/dist/commons/conditionals/conditionals.d.ts +8 -15
  3. package/dist/commons/conditionals/validate.d.ts +14 -0
  4. package/dist/commons/events/ActionConfig.d.ts +68541 -36072
  5. package/dist/commons/events/ActionDocument.d.ts +3961 -1227
  6. package/dist/commons/events/ActionInput.d.ts +3138 -966
  7. package/dist/commons/events/ActionType.d.ts +4 -0
  8. package/dist/commons/events/AdvancedSearchConfig.d.ts +414 -71
  9. package/dist/commons/events/CompositeFieldValue.d.ts +37 -9
  10. package/dist/commons/events/Constants.d.ts +3 -0
  11. package/dist/commons/events/CountryConfigQueryInput.d.ts +4132 -0
  12. package/dist/commons/events/CreatedAtLocation.d.ts +1 -2
  13. package/dist/commons/events/Draft.d.ts +271 -93
  14. package/dist/commons/events/EventConfig.d.ts +33783 -18386
  15. package/dist/commons/events/EventDocument.d.ts +2522 -816
  16. package/dist/commons/events/EventIndex.d.ts +1411 -313
  17. package/dist/commons/events/EventInput.d.ts +0 -13
  18. package/dist/commons/events/EventMetadata.d.ts +113 -76
  19. package/dist/commons/events/FieldConfig.d.ts +4017 -1558
  20. package/dist/commons/events/FieldType.d.ts +10 -1
  21. package/dist/commons/events/FieldTypeMapping.d.ts +149 -75
  22. package/dist/commons/events/FieldValue.d.ts +87 -20
  23. package/dist/commons/events/FormConfig.d.ts +18663 -8055
  24. package/dist/commons/events/PageConfig.d.ts +4601 -1945
  25. package/dist/commons/events/SummaryConfig.d.ts +0 -5
  26. package/dist/commons/events/User.d.ts +34 -7
  27. package/dist/commons/events/WorkqueueColumnConfig.d.ts +53 -0
  28. package/dist/commons/events/WorkqueueConfig.d.ts +7802 -308
  29. package/dist/commons/events/defineConfig.d.ts +3535 -860
  30. package/dist/commons/events/event.d.ts +21 -21
  31. package/dist/commons/events/field.d.ts +36 -10
  32. package/dist/commons/events/index.d.ts +5 -0
  33. package/dist/commons/events/scopes.d.ts +1 -2
  34. package/dist/commons/events/serializer.d.ts +2 -0
  35. package/dist/commons/events/test.utils.d.ts +206 -52
  36. package/dist/commons/events/transactions.d.ts +1 -1
  37. package/dist/commons/events/utils.d.ts +14324 -1570
  38. package/dist/commons/events/workqueueDefaultColumns.d.ts +3 -0
  39. package/dist/conditionals/index.js +70 -62
  40. package/dist/events/index.js +3527 -1656
  41. package/dist/scopes/index.d.ts +96 -7
  42. package/dist/scopes/index.js +105 -26
  43. package/package.json +3 -3
  44. package/tsconfig.json +1 -1
  45. package/dist/commons/conditionals/conditionals.test.d.ts +0 -2
  46. package/dist/commons/conditionals/validate-address.test.d.ts +0 -2
  47. package/dist/commons/conditionals/validate.test.d.ts +0 -2
  48. package/dist/commons/events/utils.test.d.ts +0 -2
@@ -1,33 +1,43 @@
1
1
  import { z } from 'zod';
2
2
  import { TranslationConfig } from './TranslationConfig';
3
+ import { FieldConfig } from './FieldConfig';
3
4
  export declare const SearchQueryParams: z.ZodObject<{
4
5
  eventType: z.ZodOptional<z.ZodString>;
5
- }, "strip", z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
6
- filename: z.ZodString;
6
+ }, "strip", z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodObject<{
7
+ start: z.ZodString;
8
+ end: z.ZodString;
9
+ }, "strip", z.ZodTypeAny, {
10
+ start: string;
11
+ end: string;
12
+ }, {
13
+ start: string;
14
+ end: string;
15
+ }>, z.ZodString]>, z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
16
+ path: z.ZodEffects<z.ZodString, string, string>;
7
17
  originalFilename: z.ZodString;
8
18
  type: z.ZodString;
9
19
  }, "strip", z.ZodTypeAny, {
10
20
  type: string;
11
- filename: string;
21
+ path: string;
12
22
  originalFilename: string;
13
23
  }, {
14
24
  type: string;
15
- filename: string;
25
+ path: string;
16
26
  originalFilename: string;
17
27
  }>, z.ZodArray<z.ZodObject<{
18
- filename: z.ZodString;
28
+ path: z.ZodEffects<z.ZodString, string, string>;
19
29
  originalFilename: z.ZodString;
20
30
  type: z.ZodString;
21
31
  option: z.ZodString;
22
32
  }, "strip", z.ZodTypeAny, {
23
33
  type: string;
24
34
  option: string;
25
- filename: string;
35
+ path: string;
26
36
  originalFilename: string;
27
37
  }, {
28
38
  type: string;
29
39
  option: string;
30
- filename: string;
40
+ path: string;
31
41
  originalFilename: string;
32
42
  }>, "many">, z.ZodObject<z.objectUtil.extendShape<{
33
43
  country: z.ZodString;
@@ -115,34 +125,67 @@ export declare const SearchQueryParams: z.ZodObject<{
115
125
  addressLine2?: string | undefined;
116
126
  addressLine3?: string | undefined;
117
127
  postcodeOrZip?: string | undefined;
118
- }>]>, z.objectOutputType<{
128
+ }>, z.ZodObject<{
129
+ firstname: z.ZodString;
130
+ surname: z.ZodString;
131
+ middlename: z.ZodOptional<z.ZodString>;
132
+ }, "strip", z.ZodTypeAny, {
133
+ firstname: string;
134
+ surname: string;
135
+ middlename?: string | undefined;
136
+ }, {
137
+ firstname: string;
138
+ surname: string;
139
+ middlename?: string | undefined;
140
+ }>, z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
141
+ firstname: z.ZodString;
142
+ surname: z.ZodString;
143
+ middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
144
+ }, "strip", z.ZodTypeAny, {
145
+ firstname: string;
146
+ surname: string;
147
+ middlename?: string | null | undefined;
148
+ }, {
149
+ firstname: string;
150
+ surname: string;
151
+ middlename?: string | null | undefined;
152
+ }>, z.ZodNull]>, z.ZodUndefined]>]>, z.objectOutputType<{
119
153
  eventType: z.ZodOptional<z.ZodString>;
120
- }, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
121
- filename: z.ZodString;
154
+ }, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodObject<{
155
+ start: z.ZodString;
156
+ end: z.ZodString;
157
+ }, "strip", z.ZodTypeAny, {
158
+ start: string;
159
+ end: string;
160
+ }, {
161
+ start: string;
162
+ end: string;
163
+ }>, z.ZodString]>, z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
164
+ path: z.ZodEffects<z.ZodString, string, string>;
122
165
  originalFilename: z.ZodString;
123
166
  type: z.ZodString;
124
167
  }, "strip", z.ZodTypeAny, {
125
168
  type: string;
126
- filename: string;
169
+ path: string;
127
170
  originalFilename: string;
128
171
  }, {
129
172
  type: string;
130
- filename: string;
173
+ path: string;
131
174
  originalFilename: string;
132
175
  }>, z.ZodArray<z.ZodObject<{
133
- filename: z.ZodString;
176
+ path: z.ZodEffects<z.ZodString, string, string>;
134
177
  originalFilename: z.ZodString;
135
178
  type: z.ZodString;
136
179
  option: z.ZodString;
137
180
  }, "strip", z.ZodTypeAny, {
138
181
  type: string;
139
182
  option: string;
140
- filename: string;
183
+ path: string;
141
184
  originalFilename: string;
142
185
  }, {
143
186
  type: string;
144
187
  option: string;
145
- filename: string;
188
+ path: string;
146
189
  originalFilename: string;
147
190
  }>, "many">, z.ZodObject<z.objectUtil.extendShape<{
148
191
  country: z.ZodString;
@@ -230,34 +273,67 @@ export declare const SearchQueryParams: z.ZodObject<{
230
273
  addressLine2?: string | undefined;
231
274
  addressLine3?: string | undefined;
232
275
  postcodeOrZip?: string | undefined;
233
- }>]>, "strip">, z.objectInputType<{
276
+ }>, z.ZodObject<{
277
+ firstname: z.ZodString;
278
+ surname: z.ZodString;
279
+ middlename: z.ZodOptional<z.ZodString>;
280
+ }, "strip", z.ZodTypeAny, {
281
+ firstname: string;
282
+ surname: string;
283
+ middlename?: string | undefined;
284
+ }, {
285
+ firstname: string;
286
+ surname: string;
287
+ middlename?: string | undefined;
288
+ }>, z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
289
+ firstname: z.ZodString;
290
+ surname: z.ZodString;
291
+ middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
292
+ }, "strip", z.ZodTypeAny, {
293
+ firstname: string;
294
+ surname: string;
295
+ middlename?: string | null | undefined;
296
+ }, {
297
+ firstname: string;
298
+ surname: string;
299
+ middlename?: string | null | undefined;
300
+ }>, z.ZodNull]>, z.ZodUndefined]>]>, "strip">, z.objectInputType<{
234
301
  eventType: z.ZodOptional<z.ZodString>;
235
- }, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
236
- filename: z.ZodString;
302
+ }, z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodObject<{
303
+ start: z.ZodString;
304
+ end: z.ZodString;
305
+ }, "strip", z.ZodTypeAny, {
306
+ start: string;
307
+ end: string;
308
+ }, {
309
+ start: string;
310
+ end: string;
311
+ }>, z.ZodString]>, z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
312
+ path: z.ZodEffects<z.ZodString, string, string>;
237
313
  originalFilename: z.ZodString;
238
314
  type: z.ZodString;
239
315
  }, "strip", z.ZodTypeAny, {
240
316
  type: string;
241
- filename: string;
317
+ path: string;
242
318
  originalFilename: string;
243
319
  }, {
244
320
  type: string;
245
- filename: string;
321
+ path: string;
246
322
  originalFilename: string;
247
323
  }>, z.ZodArray<z.ZodObject<{
248
- filename: z.ZodString;
324
+ path: z.ZodEffects<z.ZodString, string, string>;
249
325
  originalFilename: z.ZodString;
250
326
  type: z.ZodString;
251
327
  option: z.ZodString;
252
328
  }, "strip", z.ZodTypeAny, {
253
329
  type: string;
254
330
  option: string;
255
- filename: string;
331
+ path: string;
256
332
  originalFilename: string;
257
333
  }, {
258
334
  type: string;
259
335
  option: string;
260
- filename: string;
336
+ path: string;
261
337
  originalFilename: string;
262
338
  }>, "many">, z.ZodObject<z.objectUtil.extendShape<{
263
339
  country: z.ZodString;
@@ -345,15 +421,39 @@ export declare const SearchQueryParams: z.ZodObject<{
345
421
  addressLine2?: string | undefined;
346
422
  addressLine3?: string | undefined;
347
423
  postcodeOrZip?: string | undefined;
348
- }>]>, "strip">>;
424
+ }>, z.ZodObject<{
425
+ firstname: z.ZodString;
426
+ surname: z.ZodString;
427
+ middlename: z.ZodOptional<z.ZodString>;
428
+ }, "strip", z.ZodTypeAny, {
429
+ firstname: string;
430
+ surname: string;
431
+ middlename?: string | undefined;
432
+ }, {
433
+ firstname: string;
434
+ surname: string;
435
+ middlename?: string | undefined;
436
+ }>, z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
437
+ firstname: z.ZodString;
438
+ surname: z.ZodString;
439
+ middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
440
+ }, "strip", z.ZodTypeAny, {
441
+ firstname: string;
442
+ surname: string;
443
+ middlename?: string | null | undefined;
444
+ }, {
445
+ firstname: string;
446
+ surname: string;
447
+ middlename?: string | null | undefined;
448
+ }>, z.ZodNull]>, z.ZodUndefined]>]>, "strip">>;
349
449
  export type SearchQueryParams = z.infer<typeof SearchQueryParams>;
350
450
  export declare const FieldConfigSchema: z.ZodObject<z.objectUtil.extendShape<{
351
451
  config: z.ZodObject<{
352
- type: z.ZodEnum<["fuzzy", "exact", "range"]>;
452
+ type: z.ZodEnum<["fuzzy", "exact", "range", "within"]>;
353
453
  }, "strip", z.ZodTypeAny, {
354
- type: "exact" | "fuzzy" | "range";
454
+ type: "exact" | "fuzzy" | "range" | "within";
355
455
  }, {
356
- type: "exact" | "fuzzy" | "range";
456
+ type: "exact" | "fuzzy" | "range" | "within";
357
457
  }>;
358
458
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
359
459
  value: z.ZodString;
@@ -379,12 +479,32 @@ export declare const FieldConfigSchema: z.ZodObject<z.objectUtil.extendShape<{
379
479
  defaultMessage: string;
380
480
  }>>;
381
481
  conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", import("./Conditional").FieldConditionalType[]>, "many">>>;
482
+ validations: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
483
+ validator: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
484
+ message: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
485
+ id: string;
486
+ description: string;
487
+ defaultMessage: string;
488
+ }>;
489
+ }, "strip", z.ZodTypeAny, {
490
+ message: TranslationConfig;
491
+ validator: import(".").JSONSchema;
492
+ }, {
493
+ message: {
494
+ id: string;
495
+ description: string;
496
+ defaultMessage: string;
497
+ };
498
+ validator: import(".").JSONSchema;
499
+ }>, "many">>>;
382
500
  }, {
383
501
  fieldId: z.ZodString;
384
502
  fieldType: z.ZodLiteral<"field">;
503
+ alternateFieldIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
504
+ excludeInSearchQuery: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
385
505
  }>, "strip", z.ZodTypeAny, {
386
506
  config: {
387
- type: "exact" | "fuzzy" | "range";
507
+ type: "exact" | "fuzzy" | "range" | "within";
388
508
  };
389
509
  fieldId: string;
390
510
  fieldType: "field";
@@ -403,9 +523,15 @@ export declare const FieldConfigSchema: z.ZodObject<z.objectUtil.extendShape<{
403
523
  conditional: import(".").JSONSchema;
404
524
  })[] | undefined;
405
525
  searchCriteriaLabelPrefix?: TranslationConfig | undefined;
526
+ validations?: {
527
+ message: TranslationConfig;
528
+ validator: import(".").JSONSchema;
529
+ }[] | undefined;
530
+ alternateFieldIds?: string[] | undefined;
531
+ excludeInSearchQuery?: boolean | undefined;
406
532
  }, {
407
533
  config: {
408
- type: "exact" | "fuzzy" | "range";
534
+ type: "exact" | "fuzzy" | "range" | "within";
409
535
  };
410
536
  fieldId: string;
411
537
  fieldType: "field";
@@ -432,16 +558,41 @@ export declare const FieldConfigSchema: z.ZodObject<z.objectUtil.extendShape<{
432
558
  description: string;
433
559
  defaultMessage: string;
434
560
  } | undefined;
561
+ validations?: {
562
+ message: {
563
+ id: string;
564
+ description: string;
565
+ defaultMessage: string;
566
+ };
567
+ validator: import(".").JSONSchema;
568
+ }[] | undefined;
569
+ alternateFieldIds?: string[] | undefined;
570
+ excludeInSearchQuery?: boolean | undefined;
435
571
  }>;
436
- export declare const EventFieldId: z.ZodEnum<["trackingId", "status", "legalStatus.REGISTERED.createdAt", "legalStatus.REGISTERED.createdAtLocation", "updatedAt"]>;
572
+ /**
573
+ * The event fields that are available for advanced search. These are the values
574
+ * that can be passed to the `event` function to create a field config.
575
+ */
576
+ export declare const EventFieldIdInput: z.ZodEnum<["trackingId", "status", "legalStatuses.REGISTERED.acceptedAt", "legalStatuses.REGISTERED.createdAtLocation", "updatedAt"]>;
577
+ /**
578
+ * Represent the prefix used to differentiate event metadata fields from
579
+ * the declaration ones in advanced search form.
580
+ */
581
+ export declare const METADATA_FIELD_PREFIX = "event.";
582
+ /**
583
+ * The field IDs that are actually used in the advanced search. The `event`
584
+ * function prefixes the `EventFieldIdInput` values with METADATA_FIELD_PREFIX.
585
+ */
586
+ export declare const EventFieldId: z.ZodEnum<["event.trackingId", "event.status", "event.legalStatuses.REGISTERED.acceptedAt", "event.legalStatuses.REGISTERED.createdAtLocation", "event.updatedAt"]>;
587
+ export type EventFieldIdInput = z.infer<typeof EventFieldIdInput>;
437
588
  export type EventFieldId = z.infer<typeof EventFieldId>;
438
589
  export declare const EventFieldConfigSchema: z.ZodObject<z.objectUtil.extendShape<{
439
590
  config: z.ZodObject<{
440
- type: z.ZodEnum<["fuzzy", "exact", "range"]>;
591
+ type: z.ZodEnum<["fuzzy", "exact", "range", "within"]>;
441
592
  }, "strip", z.ZodTypeAny, {
442
- type: "exact" | "fuzzy" | "range";
593
+ type: "exact" | "fuzzy" | "range" | "within";
443
594
  }, {
444
- type: "exact" | "fuzzy" | "range";
595
+ type: "exact" | "fuzzy" | "range" | "within";
445
596
  }>;
446
597
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
447
598
  value: z.ZodString;
@@ -467,14 +618,32 @@ export declare const EventFieldConfigSchema: z.ZodObject<z.objectUtil.extendShap
467
618
  defaultMessage: string;
468
619
  }>>;
469
620
  conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", import("./Conditional").FieldConditionalType[]>, "many">>>;
621
+ validations: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
622
+ validator: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
623
+ message: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
624
+ id: string;
625
+ description: string;
626
+ defaultMessage: string;
627
+ }>;
628
+ }, "strip", z.ZodTypeAny, {
629
+ message: TranslationConfig;
630
+ validator: import(".").JSONSchema;
631
+ }, {
632
+ message: {
633
+ id: string;
634
+ description: string;
635
+ defaultMessage: string;
636
+ };
637
+ validator: import(".").JSONSchema;
638
+ }>, "many">>>;
470
639
  }, {
471
- fieldId: z.ZodEnum<["trackingId", "status", "legalStatus.REGISTERED.createdAt", "legalStatus.REGISTERED.createdAtLocation", "updatedAt"]>;
640
+ fieldId: z.ZodEnum<["event.trackingId", "event.status", "event.legalStatuses.REGISTERED.acceptedAt", "event.legalStatuses.REGISTERED.createdAtLocation", "event.updatedAt"]>;
472
641
  fieldType: z.ZodLiteral<"event">;
473
642
  }>, "strip", z.ZodTypeAny, {
474
643
  config: {
475
- type: "exact" | "fuzzy" | "range";
644
+ type: "exact" | "fuzzy" | "range" | "within";
476
645
  };
477
- fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
646
+ fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
478
647
  fieldType: "event";
479
648
  options?: {
480
649
  value: string;
@@ -491,11 +660,15 @@ export declare const EventFieldConfigSchema: z.ZodObject<z.objectUtil.extendShap
491
660
  conditional: import(".").JSONSchema;
492
661
  })[] | undefined;
493
662
  searchCriteriaLabelPrefix?: TranslationConfig | undefined;
663
+ validations?: {
664
+ message: TranslationConfig;
665
+ validator: import(".").JSONSchema;
666
+ }[] | undefined;
494
667
  }, {
495
668
  config: {
496
- type: "exact" | "fuzzy" | "range";
669
+ type: "exact" | "fuzzy" | "range" | "within";
497
670
  };
498
- fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
671
+ fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
499
672
  fieldType: "event";
500
673
  options?: {
501
674
  value: string;
@@ -520,14 +693,22 @@ export declare const EventFieldConfigSchema: z.ZodObject<z.objectUtil.extendShap
520
693
  description: string;
521
694
  defaultMessage: string;
522
695
  } | undefined;
696
+ validations?: {
697
+ message: {
698
+ id: string;
699
+ description: string;
700
+ defaultMessage: string;
701
+ };
702
+ validator: import(".").JSONSchema;
703
+ }[] | undefined;
523
704
  }>;
524
705
  export declare const SearchField: z.ZodDiscriminatedUnion<"fieldType", [z.ZodObject<z.objectUtil.extendShape<{
525
706
  config: z.ZodObject<{
526
- type: z.ZodEnum<["fuzzy", "exact", "range"]>;
707
+ type: z.ZodEnum<["fuzzy", "exact", "range", "within"]>;
527
708
  }, "strip", z.ZodTypeAny, {
528
- type: "exact" | "fuzzy" | "range";
709
+ type: "exact" | "fuzzy" | "range" | "within";
529
710
  }, {
530
- type: "exact" | "fuzzy" | "range";
711
+ type: "exact" | "fuzzy" | "range" | "within";
531
712
  }>;
532
713
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
533
714
  value: z.ZodString;
@@ -553,12 +734,32 @@ export declare const SearchField: z.ZodDiscriminatedUnion<"fieldType", [z.ZodObj
553
734
  defaultMessage: string;
554
735
  }>>;
555
736
  conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", import("./Conditional").FieldConditionalType[]>, "many">>>;
737
+ validations: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
738
+ validator: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
739
+ message: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
740
+ id: string;
741
+ description: string;
742
+ defaultMessage: string;
743
+ }>;
744
+ }, "strip", z.ZodTypeAny, {
745
+ message: TranslationConfig;
746
+ validator: import(".").JSONSchema;
747
+ }, {
748
+ message: {
749
+ id: string;
750
+ description: string;
751
+ defaultMessage: string;
752
+ };
753
+ validator: import(".").JSONSchema;
754
+ }>, "many">>>;
556
755
  }, {
557
756
  fieldId: z.ZodString;
558
757
  fieldType: z.ZodLiteral<"field">;
758
+ alternateFieldIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
759
+ excludeInSearchQuery: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
559
760
  }>, "strip", z.ZodTypeAny, {
560
761
  config: {
561
- type: "exact" | "fuzzy" | "range";
762
+ type: "exact" | "fuzzy" | "range" | "within";
562
763
  };
563
764
  fieldId: string;
564
765
  fieldType: "field";
@@ -577,9 +778,15 @@ export declare const SearchField: z.ZodDiscriminatedUnion<"fieldType", [z.ZodObj
577
778
  conditional: import(".").JSONSchema;
578
779
  })[] | undefined;
579
780
  searchCriteriaLabelPrefix?: TranslationConfig | undefined;
781
+ validations?: {
782
+ message: TranslationConfig;
783
+ validator: import(".").JSONSchema;
784
+ }[] | undefined;
785
+ alternateFieldIds?: string[] | undefined;
786
+ excludeInSearchQuery?: boolean | undefined;
580
787
  }, {
581
788
  config: {
582
- type: "exact" | "fuzzy" | "range";
789
+ type: "exact" | "fuzzy" | "range" | "within";
583
790
  };
584
791
  fieldId: string;
585
792
  fieldType: "field";
@@ -606,13 +813,23 @@ export declare const SearchField: z.ZodDiscriminatedUnion<"fieldType", [z.ZodObj
606
813
  description: string;
607
814
  defaultMessage: string;
608
815
  } | undefined;
816
+ validations?: {
817
+ message: {
818
+ id: string;
819
+ description: string;
820
+ defaultMessage: string;
821
+ };
822
+ validator: import(".").JSONSchema;
823
+ }[] | undefined;
824
+ alternateFieldIds?: string[] | undefined;
825
+ excludeInSearchQuery?: boolean | undefined;
609
826
  }>, z.ZodObject<z.objectUtil.extendShape<{
610
827
  config: z.ZodObject<{
611
- type: z.ZodEnum<["fuzzy", "exact", "range"]>;
828
+ type: z.ZodEnum<["fuzzy", "exact", "range", "within"]>;
612
829
  }, "strip", z.ZodTypeAny, {
613
- type: "exact" | "fuzzy" | "range";
830
+ type: "exact" | "fuzzy" | "range" | "within";
614
831
  }, {
615
- type: "exact" | "fuzzy" | "range";
832
+ type: "exact" | "fuzzy" | "range" | "within";
616
833
  }>;
617
834
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
618
835
  value: z.ZodString;
@@ -638,14 +855,32 @@ export declare const SearchField: z.ZodDiscriminatedUnion<"fieldType", [z.ZodObj
638
855
  defaultMessage: string;
639
856
  }>>;
640
857
  conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", import("./Conditional").FieldConditionalType[]>, "many">>>;
858
+ validations: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
859
+ validator: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
860
+ message: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
861
+ id: string;
862
+ description: string;
863
+ defaultMessage: string;
864
+ }>;
865
+ }, "strip", z.ZodTypeAny, {
866
+ message: TranslationConfig;
867
+ validator: import(".").JSONSchema;
868
+ }, {
869
+ message: {
870
+ id: string;
871
+ description: string;
872
+ defaultMessage: string;
873
+ };
874
+ validator: import(".").JSONSchema;
875
+ }>, "many">>>;
641
876
  }, {
642
- fieldId: z.ZodEnum<["trackingId", "status", "legalStatus.REGISTERED.createdAt", "legalStatus.REGISTERED.createdAtLocation", "updatedAt"]>;
877
+ fieldId: z.ZodEnum<["event.trackingId", "event.status", "event.legalStatuses.REGISTERED.acceptedAt", "event.legalStatuses.REGISTERED.createdAtLocation", "event.updatedAt"]>;
643
878
  fieldType: z.ZodLiteral<"event">;
644
879
  }>, "strip", z.ZodTypeAny, {
645
880
  config: {
646
- type: "exact" | "fuzzy" | "range";
881
+ type: "exact" | "fuzzy" | "range" | "within";
647
882
  };
648
- fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
883
+ fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
649
884
  fieldType: "event";
650
885
  options?: {
651
886
  value: string;
@@ -662,11 +897,15 @@ export declare const SearchField: z.ZodDiscriminatedUnion<"fieldType", [z.ZodObj
662
897
  conditional: import(".").JSONSchema;
663
898
  })[] | undefined;
664
899
  searchCriteriaLabelPrefix?: TranslationConfig | undefined;
900
+ validations?: {
901
+ message: TranslationConfig;
902
+ validator: import(".").JSONSchema;
903
+ }[] | undefined;
665
904
  }, {
666
905
  config: {
667
- type: "exact" | "fuzzy" | "range";
906
+ type: "exact" | "fuzzy" | "range" | "within";
668
907
  };
669
- fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
908
+ fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
670
909
  fieldType: "event";
671
910
  options?: {
672
911
  value: string;
@@ -691,6 +930,14 @@ export declare const SearchField: z.ZodDiscriminatedUnion<"fieldType", [z.ZodObj
691
930
  description: string;
692
931
  defaultMessage: string;
693
932
  } | undefined;
933
+ validations?: {
934
+ message: {
935
+ id: string;
936
+ description: string;
937
+ defaultMessage: string;
938
+ };
939
+ validator: import(".").JSONSchema;
940
+ }[] | undefined;
694
941
  }>]>;
695
942
  export type SearchField = z.infer<typeof SearchField>;
696
943
  export declare const AdvancedSearchConfig: z.ZodObject<{
@@ -701,11 +948,11 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
701
948
  }>;
702
949
  fields: z.ZodArray<z.ZodDiscriminatedUnion<"fieldType", [z.ZodObject<z.objectUtil.extendShape<{
703
950
  config: z.ZodObject<{
704
- type: z.ZodEnum<["fuzzy", "exact", "range"]>;
951
+ type: z.ZodEnum<["fuzzy", "exact", "range", "within"]>;
705
952
  }, "strip", z.ZodTypeAny, {
706
- type: "exact" | "fuzzy" | "range";
953
+ type: "exact" | "fuzzy" | "range" | "within";
707
954
  }, {
708
- type: "exact" | "fuzzy" | "range";
955
+ type: "exact" | "fuzzy" | "range" | "within";
709
956
  }>;
710
957
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
711
958
  value: z.ZodString;
@@ -731,12 +978,32 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
731
978
  defaultMessage: string;
732
979
  }>>;
733
980
  conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", import("./Conditional").FieldConditionalType[]>, "many">>>;
981
+ validations: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
982
+ validator: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
983
+ message: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
984
+ id: string;
985
+ description: string;
986
+ defaultMessage: string;
987
+ }>;
988
+ }, "strip", z.ZodTypeAny, {
989
+ message: TranslationConfig;
990
+ validator: import(".").JSONSchema;
991
+ }, {
992
+ message: {
993
+ id: string;
994
+ description: string;
995
+ defaultMessage: string;
996
+ };
997
+ validator: import(".").JSONSchema;
998
+ }>, "many">>>;
734
999
  }, {
735
1000
  fieldId: z.ZodString;
736
1001
  fieldType: z.ZodLiteral<"field">;
1002
+ alternateFieldIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
1003
+ excludeInSearchQuery: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
737
1004
  }>, "strip", z.ZodTypeAny, {
738
1005
  config: {
739
- type: "exact" | "fuzzy" | "range";
1006
+ type: "exact" | "fuzzy" | "range" | "within";
740
1007
  };
741
1008
  fieldId: string;
742
1009
  fieldType: "field";
@@ -755,9 +1022,15 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
755
1022
  conditional: import(".").JSONSchema;
756
1023
  })[] | undefined;
757
1024
  searchCriteriaLabelPrefix?: TranslationConfig | undefined;
1025
+ validations?: {
1026
+ message: TranslationConfig;
1027
+ validator: import(".").JSONSchema;
1028
+ }[] | undefined;
1029
+ alternateFieldIds?: string[] | undefined;
1030
+ excludeInSearchQuery?: boolean | undefined;
758
1031
  }, {
759
1032
  config: {
760
- type: "exact" | "fuzzy" | "range";
1033
+ type: "exact" | "fuzzy" | "range" | "within";
761
1034
  };
762
1035
  fieldId: string;
763
1036
  fieldType: "field";
@@ -784,13 +1057,23 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
784
1057
  description: string;
785
1058
  defaultMessage: string;
786
1059
  } | undefined;
1060
+ validations?: {
1061
+ message: {
1062
+ id: string;
1063
+ description: string;
1064
+ defaultMessage: string;
1065
+ };
1066
+ validator: import(".").JSONSchema;
1067
+ }[] | undefined;
1068
+ alternateFieldIds?: string[] | undefined;
1069
+ excludeInSearchQuery?: boolean | undefined;
787
1070
  }>, z.ZodObject<z.objectUtil.extendShape<{
788
1071
  config: z.ZodObject<{
789
- type: z.ZodEnum<["fuzzy", "exact", "range"]>;
1072
+ type: z.ZodEnum<["fuzzy", "exact", "range", "within"]>;
790
1073
  }, "strip", z.ZodTypeAny, {
791
- type: "exact" | "fuzzy" | "range";
1074
+ type: "exact" | "fuzzy" | "range" | "within";
792
1075
  }, {
793
- type: "exact" | "fuzzy" | "range";
1076
+ type: "exact" | "fuzzy" | "range" | "within";
794
1077
  }>;
795
1078
  options: z.ZodOptional<z.ZodArray<z.ZodObject<{
796
1079
  value: z.ZodString;
@@ -816,14 +1099,32 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
816
1099
  defaultMessage: string;
817
1100
  }>>;
818
1101
  conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", import("./Conditional").FieldConditionalType[]>, "many">>>;
1102
+ validations: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
1103
+ validator: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
1104
+ message: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
1105
+ id: string;
1106
+ description: string;
1107
+ defaultMessage: string;
1108
+ }>;
1109
+ }, "strip", z.ZodTypeAny, {
1110
+ message: TranslationConfig;
1111
+ validator: import(".").JSONSchema;
1112
+ }, {
1113
+ message: {
1114
+ id: string;
1115
+ description: string;
1116
+ defaultMessage: string;
1117
+ };
1118
+ validator: import(".").JSONSchema;
1119
+ }>, "many">>>;
819
1120
  }, {
820
- fieldId: z.ZodEnum<["trackingId", "status", "legalStatus.REGISTERED.createdAt", "legalStatus.REGISTERED.createdAtLocation", "updatedAt"]>;
1121
+ fieldId: z.ZodEnum<["event.trackingId", "event.status", "event.legalStatuses.REGISTERED.acceptedAt", "event.legalStatuses.REGISTERED.createdAtLocation", "event.updatedAt"]>;
821
1122
  fieldType: z.ZodLiteral<"event">;
822
1123
  }>, "strip", z.ZodTypeAny, {
823
1124
  config: {
824
- type: "exact" | "fuzzy" | "range";
1125
+ type: "exact" | "fuzzy" | "range" | "within";
825
1126
  };
826
- fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
1127
+ fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
827
1128
  fieldType: "event";
828
1129
  options?: {
829
1130
  value: string;
@@ -840,11 +1141,15 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
840
1141
  conditional: import(".").JSONSchema;
841
1142
  })[] | undefined;
842
1143
  searchCriteriaLabelPrefix?: TranslationConfig | undefined;
1144
+ validations?: {
1145
+ message: TranslationConfig;
1146
+ validator: import(".").JSONSchema;
1147
+ }[] | undefined;
843
1148
  }, {
844
1149
  config: {
845
- type: "exact" | "fuzzy" | "range";
1150
+ type: "exact" | "fuzzy" | "range" | "within";
846
1151
  };
847
- fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
1152
+ fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
848
1153
  fieldType: "event";
849
1154
  options?: {
850
1155
  value: string;
@@ -869,12 +1174,20 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
869
1174
  description: string;
870
1175
  defaultMessage: string;
871
1176
  } | undefined;
1177
+ validations?: {
1178
+ message: {
1179
+ id: string;
1180
+ description: string;
1181
+ defaultMessage: string;
1182
+ };
1183
+ validator: import(".").JSONSchema;
1184
+ }[] | undefined;
872
1185
  }>]>, "many">;
873
1186
  }, "strip", z.ZodTypeAny, {
874
1187
  title: TranslationConfig;
875
1188
  fields: ({
876
1189
  config: {
877
- type: "exact" | "fuzzy" | "range";
1190
+ type: "exact" | "fuzzy" | "range" | "within";
878
1191
  };
879
1192
  fieldId: string;
880
1193
  fieldType: "field";
@@ -893,11 +1206,17 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
893
1206
  conditional: import(".").JSONSchema;
894
1207
  })[] | undefined;
895
1208
  searchCriteriaLabelPrefix?: TranslationConfig | undefined;
1209
+ validations?: {
1210
+ message: TranslationConfig;
1211
+ validator: import(".").JSONSchema;
1212
+ }[] | undefined;
1213
+ alternateFieldIds?: string[] | undefined;
1214
+ excludeInSearchQuery?: boolean | undefined;
896
1215
  } | {
897
1216
  config: {
898
- type: "exact" | "fuzzy" | "range";
1217
+ type: "exact" | "fuzzy" | "range" | "within";
899
1218
  };
900
- fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
1219
+ fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
901
1220
  fieldType: "event";
902
1221
  options?: {
903
1222
  value: string;
@@ -914,6 +1233,10 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
914
1233
  conditional: import(".").JSONSchema;
915
1234
  })[] | undefined;
916
1235
  searchCriteriaLabelPrefix?: TranslationConfig | undefined;
1236
+ validations?: {
1237
+ message: TranslationConfig;
1238
+ validator: import(".").JSONSchema;
1239
+ }[] | undefined;
917
1240
  })[];
918
1241
  }, {
919
1242
  title: {
@@ -923,7 +1246,7 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
923
1246
  };
924
1247
  fields: ({
925
1248
  config: {
926
- type: "exact" | "fuzzy" | "range";
1249
+ type: "exact" | "fuzzy" | "range" | "within";
927
1250
  };
928
1251
  fieldId: string;
929
1252
  fieldType: "field";
@@ -950,11 +1273,21 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
950
1273
  description: string;
951
1274
  defaultMessage: string;
952
1275
  } | undefined;
1276
+ validations?: {
1277
+ message: {
1278
+ id: string;
1279
+ description: string;
1280
+ defaultMessage: string;
1281
+ };
1282
+ validator: import(".").JSONSchema;
1283
+ }[] | undefined;
1284
+ alternateFieldIds?: string[] | undefined;
1285
+ excludeInSearchQuery?: boolean | undefined;
953
1286
  } | {
954
1287
  config: {
955
- type: "exact" | "fuzzy" | "range";
1288
+ type: "exact" | "fuzzy" | "range" | "within";
956
1289
  };
957
- fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
1290
+ fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
958
1291
  fieldType: "event";
959
1292
  options?: {
960
1293
  value: string;
@@ -979,8 +1312,18 @@ export declare const AdvancedSearchConfig: z.ZodObject<{
979
1312
  description: string;
980
1313
  defaultMessage: string;
981
1314
  } | undefined;
1315
+ validations?: {
1316
+ message: {
1317
+ id: string;
1318
+ description: string;
1319
+ defaultMessage: string;
1320
+ };
1321
+ validator: import(".").JSONSchema;
1322
+ }[] | undefined;
982
1323
  })[];
983
1324
  }>;
984
- export type AdvancedSearchConfigInput = z.infer<typeof AdvancedSearchConfig>;
985
1325
  export type AdvancedSearchConfig = z.infer<typeof AdvancedSearchConfig>;
1326
+ export type AdvancedSearchConfigWithFieldsResolved = Omit<AdvancedSearchConfig, 'fields'> & {
1327
+ fields: FieldConfig[];
1328
+ };
986
1329
  //# sourceMappingURL=AdvancedSearchConfig.d.ts.map