@opencrvs/toolkit 2.0.0-rc.c4072b5 → 2.0.0-rc.c4538db
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.
- package/create-countryconfig/index.js +50 -20
- package/create-countryconfig/package.json +12 -2
- package/dist/application-config/index.js +252 -98
- package/dist/cli.js +10 -4
- package/dist/commons/api/router.d.ts +109 -21
- package/dist/commons/application-config/index.d.ts +1 -0
- package/dist/commons/conditionals/conditionals.d.ts +354 -4
- package/dist/commons/conditionals/validate.d.ts +51 -2
- package/dist/commons/events/ActionConfig.d.ts +28 -2
- package/dist/commons/events/ActionDocument.d.ts +6 -0
- package/dist/commons/events/ActionInput.d.ts +42 -36
- package/dist/commons/events/AdvancedSearchConfig.d.ts +342 -0
- package/dist/commons/events/CountryConfigQueryInput.d.ts +42 -0
- package/dist/commons/events/Draft.d.ts +2 -3
- package/dist/commons/events/EventDocument.d.ts +3 -0
- package/dist/commons/events/EventIndex.d.ts +14 -0
- package/dist/commons/events/FieldConfig.d.ts +378 -50
- package/dist/commons/events/FieldType.d.ts +1 -0
- package/dist/commons/events/FieldTypeMapping.d.ts +1 -1
- package/dist/commons/events/FieldValue.d.ts +6 -0
- package/dist/commons/events/WorkqueueConfig.d.ts +44 -5
- package/dist/commons/events/field.d.ts +53 -1
- package/dist/commons/events/index.d.ts +2 -0
- package/dist/commons/events/state/flags.d.ts +16 -0
- package/dist/commons/events/state/utils.d.ts +12 -287
- package/dist/commons/events/utils.d.ts +12 -1
- package/dist/conditionals/index.js +52 -1
- package/dist/events/index.js +1037 -223
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.js +1 -1
- package/dist/migrations/v2.0/index.js +10 -4
- package/dist/notification/index.js +871 -121
- package/dist/scopes/index.d.ts +4 -6
- package/dist/scopes/index.js +9 -3
- package/opencrvs-toolkit-2.0.0-rc.c4538db.tgz +0 -0
- package/package.json +6 -2
- package/opencrvs-toolkit-2.0.0-rc.c4072b5.tgz +0 -0
|
@@ -75,4 +75,5 @@ export type FieldType = (typeof fieldTypes)[number];
|
|
|
75
75
|
*/
|
|
76
76
|
export declare const compositeFieldTypes: ("NAME" | "ADDRESS" | "DATE_RANGE" | "FILE" | "FILE_WITH_OPTIONS" | "DATA" | "ID_READER")[];
|
|
77
77
|
export declare const FieldTypesToHideInReview: ("IMAGE_VIEW" | "PARAGRAPH" | "PAGE_HEADER" | "BULLET_LIST" | "DIVIDER" | "DATA" | "ALPHA_PRINT_BUTTON" | "HTTP" | "QUERY_PARAM_READER" | "ID_READER" | "LOADER" | "ALPHA_HIDDEN")[];
|
|
78
|
+
export declare const HiddenFieldTypes: ("HTTP" | "QUERY_PARAM_READER" | "ALPHA_HIDDEN")[];
|
|
78
79
|
//# sourceMappingURL=FieldType.d.ts.map
|
|
@@ -690,7 +690,7 @@ export declare const isHiddenFieldType: (field: {
|
|
|
690
690
|
value: undefined;
|
|
691
691
|
config: HiddenField;
|
|
692
692
|
};
|
|
693
|
-
export type NonInteractiveFieldType = Divider | PageHeader | ImageViewField | Paragraph | Heading | BulletList | DataField | AlphaPrintButton |
|
|
693
|
+
export type NonInteractiveFieldType = Divider | PageHeader | ImageViewField | Paragraph | Heading | BulletList | DataField | AlphaPrintButton | LinkButtonField | LoaderField | AutocompleteField;
|
|
694
694
|
export type InteractiveFieldType = Exclude<FieldConfig, NonInteractiveFieldType>;
|
|
695
695
|
export declare const isNonInteractiveFieldType: (field: FieldConfig) => field is NonInteractiveFieldType;
|
|
696
696
|
export {};
|
|
@@ -58,6 +58,12 @@ export declare const CheckboxFieldValue: z.ZodBoolean;
|
|
|
58
58
|
export type CheckboxFieldValue = z.infer<typeof CheckboxFieldValue>;
|
|
59
59
|
export declare const NumberFieldValue: z.ZodNumber;
|
|
60
60
|
export type NumberFieldValue = z.infer<typeof NumberFieldValue>;
|
|
61
|
+
export declare const SignatureFieldValue: z.ZodObject<{
|
|
62
|
+
path: z.core.$ZodBranded<z.ZodString, "DocumentPath", "out">;
|
|
63
|
+
originalFilename: z.ZodString;
|
|
64
|
+
type: z.ZodString;
|
|
65
|
+
}, z.core.$strip>;
|
|
66
|
+
export type SignatureFieldValue = z.infer<typeof SignatureFieldValue>;
|
|
61
67
|
export declare const ButtonFieldValue: z.ZodNumber;
|
|
62
68
|
export type ButtonFieldValue = z.infer<typeof ButtonFieldValue>;
|
|
63
69
|
export declare const VerificationStatusValue: z.ZodEnum<{
|
|
@@ -322,6 +322,13 @@ export declare const WorkqueueConfig: z.ZodObject<{
|
|
|
322
322
|
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
323
323
|
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
324
324
|
}>]>, z.ZodString]>>>;
|
|
325
|
+
allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
|
|
326
|
+
readonly INCOMPLETE: "incomplete";
|
|
327
|
+
readonly REJECTED: "rejected";
|
|
328
|
+
readonly CORRECTION_REQUESTED: "correction-requested";
|
|
329
|
+
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
330
|
+
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
331
|
+
}>]>, z.ZodString]>>>;
|
|
325
332
|
}, z.core.$strip>>>;
|
|
326
333
|
data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
327
334
|
}, z.core.$strip>>;
|
|
@@ -632,6 +639,13 @@ export declare const WorkqueueConfig: z.ZodObject<{
|
|
|
632
639
|
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
633
640
|
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
634
641
|
}>]>, z.ZodString]>>>;
|
|
642
|
+
allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
|
|
643
|
+
readonly INCOMPLETE: "incomplete";
|
|
644
|
+
readonly REJECTED: "rejected";
|
|
645
|
+
readonly CORRECTION_REQUESTED: "correction-requested";
|
|
646
|
+
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
647
|
+
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
648
|
+
}>]>, z.ZodString]>>>;
|
|
635
649
|
}, z.core.$strip>>>;
|
|
636
650
|
data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
637
651
|
}, z.core.$strip>>;
|
|
@@ -677,6 +691,7 @@ export declare const WorkqueueConfig: z.ZodObject<{
|
|
|
677
691
|
}, z.core.$strip>;
|
|
678
692
|
}, z.core.$strip>>>;
|
|
679
693
|
icon: z.ZodEnum<{
|
|
694
|
+
File: "File";
|
|
680
695
|
Archived: "Archived";
|
|
681
696
|
Assigned: "Assigned";
|
|
682
697
|
Briefcase: "Briefcase";
|
|
@@ -722,7 +737,6 @@ export declare const WorkqueueConfig: z.ZodObject<{
|
|
|
722
737
|
Eye: "Eye";
|
|
723
738
|
EyeSlash: "EyeSlash";
|
|
724
739
|
Envelope: "Envelope";
|
|
725
|
-
File: "File";
|
|
726
740
|
FileSearch: "FileSearch";
|
|
727
741
|
FileMinus: "FileMinus";
|
|
728
742
|
FilePlus: "FilePlus";
|
|
@@ -786,6 +800,7 @@ export declare const WorkqueueConfig: z.ZodObject<{
|
|
|
786
800
|
export declare const WorkqueueConfigWithoutQuery: z.ZodObject<{
|
|
787
801
|
name: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, z.core.$strip>;
|
|
788
802
|
icon: z.ZodEnum<{
|
|
803
|
+
File: "File";
|
|
789
804
|
Archived: "Archived";
|
|
790
805
|
Assigned: "Assigned";
|
|
791
806
|
Briefcase: "Briefcase";
|
|
@@ -831,7 +846,6 @@ export declare const WorkqueueConfigWithoutQuery: z.ZodObject<{
|
|
|
831
846
|
Eye: "Eye";
|
|
832
847
|
EyeSlash: "EyeSlash";
|
|
833
848
|
Envelope: "Envelope";
|
|
834
|
-
File: "File";
|
|
835
849
|
FileSearch: "FileSearch";
|
|
836
850
|
FileMinus: "FileMinus";
|
|
837
851
|
FilePlus: "FilePlus";
|
|
@@ -951,6 +965,7 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
|
|
|
951
965
|
}, z.core.$strip>;
|
|
952
966
|
}, z.core.$strip>>>;
|
|
953
967
|
icon: z.ZodEnum<{
|
|
968
|
+
File: "File";
|
|
954
969
|
Archived: "Archived";
|
|
955
970
|
Assigned: "Assigned";
|
|
956
971
|
Briefcase: "Briefcase";
|
|
@@ -996,7 +1011,6 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
|
|
|
996
1011
|
Eye: "Eye";
|
|
997
1012
|
EyeSlash: "EyeSlash";
|
|
998
1013
|
Envelope: "Envelope";
|
|
999
|
-
File: "File";
|
|
1000
1014
|
FileSearch: "FileSearch";
|
|
1001
1015
|
FileMinus: "FileMinus";
|
|
1002
1016
|
FilePlus: "FilePlus";
|
|
@@ -1361,6 +1375,13 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
|
|
|
1361
1375
|
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
1362
1376
|
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
1363
1377
|
}>]>, z.ZodString]>>>;
|
|
1378
|
+
allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
|
|
1379
|
+
readonly INCOMPLETE: "incomplete";
|
|
1380
|
+
readonly REJECTED: "rejected";
|
|
1381
|
+
readonly CORRECTION_REQUESTED: "correction-requested";
|
|
1382
|
+
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
1383
|
+
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
1384
|
+
}>]>, z.ZodString]>>>;
|
|
1364
1385
|
}, z.core.$strip>>>;
|
|
1365
1386
|
data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
1366
1387
|
}, z.core.$strip>, z.ZodObject<{
|
|
@@ -1670,6 +1691,13 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
|
|
|
1670
1691
|
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
1671
1692
|
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
1672
1693
|
}>]>, z.ZodString]>>>;
|
|
1694
|
+
allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
|
|
1695
|
+
readonly INCOMPLETE: "incomplete";
|
|
1696
|
+
readonly REJECTED: "rejected";
|
|
1697
|
+
readonly CORRECTION_REQUESTED: "correction-requested";
|
|
1698
|
+
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
1699
|
+
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
1700
|
+
}>]>, z.ZodString]>>>;
|
|
1673
1701
|
}, z.core.$strip>>>;
|
|
1674
1702
|
data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
1675
1703
|
}, z.core.$strip>>;
|
|
@@ -1980,6 +2008,13 @@ export declare const WorkqueueConfigInput: z.ZodObject<{
|
|
|
1980
2008
|
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
1981
2009
|
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
1982
2010
|
}>]>, z.ZodString]>>>;
|
|
2011
|
+
allOf: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodEnum<{
|
|
2012
|
+
readonly INCOMPLETE: "incomplete";
|
|
2013
|
+
readonly REJECTED: "rejected";
|
|
2014
|
+
readonly CORRECTION_REQUESTED: "correction-requested";
|
|
2015
|
+
readonly POTENTIAL_DUPLICATE: "potential-duplicate";
|
|
2016
|
+
readonly EDIT_IN_PROGRESS: "edit-in-progress";
|
|
2017
|
+
}>]>, z.ZodString]>>>;
|
|
1983
2018
|
}, z.core.$strip>>>;
|
|
1984
2019
|
data: z.ZodOptional<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
|
|
1985
2020
|
}, z.core.$strip>>;
|
|
@@ -2130,6 +2165,7 @@ export declare function defineWorkqueue(workqueueInput: WorkqueueConfigInput): {
|
|
|
2130
2165
|
flags?: {
|
|
2131
2166
|
anyOf?: string[] | undefined;
|
|
2132
2167
|
noneOf?: string[] | undefined;
|
|
2168
|
+
allOf?: string[] | undefined;
|
|
2133
2169
|
} | undefined;
|
|
2134
2170
|
data?: unknown;
|
|
2135
2171
|
}[];
|
|
@@ -2268,6 +2304,7 @@ export declare function defineWorkqueue(workqueueInput: WorkqueueConfigInput): {
|
|
|
2268
2304
|
flags?: {
|
|
2269
2305
|
anyOf?: string[] | undefined;
|
|
2270
2306
|
noneOf?: string[] | undefined;
|
|
2307
|
+
allOf?: string[] | undefined;
|
|
2271
2308
|
} | undefined;
|
|
2272
2309
|
data?: unknown;
|
|
2273
2310
|
}[];
|
|
@@ -2282,7 +2319,7 @@ export declare function defineWorkqueue(workqueueInput: WorkqueueConfigInput): {
|
|
|
2282
2319
|
$event: "id" | "title" | "type" | "updatedAt" | "placeOfEvent" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "status" | "assignedTo" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
|
|
2283
2320
|
};
|
|
2284
2321
|
}[];
|
|
2285
|
-
icon: "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "
|
|
2322
|
+
icon: "File" | "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
|
|
2286
2323
|
action?: {
|
|
2287
2324
|
type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
|
|
2288
2325
|
} | undefined;
|
|
@@ -2439,6 +2476,7 @@ export declare function defineWorkqueues(workqueues: WorkqueueConfigInputWithV19
|
|
|
2439
2476
|
flags?: {
|
|
2440
2477
|
anyOf?: string[] | undefined;
|
|
2441
2478
|
noneOf?: string[] | undefined;
|
|
2479
|
+
allOf?: string[] | undefined;
|
|
2442
2480
|
} | undefined;
|
|
2443
2481
|
data?: unknown;
|
|
2444
2482
|
}[];
|
|
@@ -2577,6 +2615,7 @@ export declare function defineWorkqueues(workqueues: WorkqueueConfigInputWithV19
|
|
|
2577
2615
|
flags?: {
|
|
2578
2616
|
anyOf?: string[] | undefined;
|
|
2579
2617
|
noneOf?: string[] | undefined;
|
|
2618
|
+
allOf?: string[] | undefined;
|
|
2580
2619
|
} | undefined;
|
|
2581
2620
|
data?: unknown;
|
|
2582
2621
|
}[];
|
|
@@ -2591,7 +2630,7 @@ export declare function defineWorkqueues(workqueues: WorkqueueConfigInputWithV19
|
|
|
2591
2630
|
$event: "id" | "title" | "type" | "updatedAt" | "placeOfEvent" | "createdByUserType" | "createdAt" | "createdBy" | "createdAtLocation" | "status" | "assignedTo" | "trackingId" | "legalStatuses" | "dateOfEvent" | "updatedByUserRole" | "updatedAtLocation" | "updatedBy" | "flags" | "outbox";
|
|
2592
2631
|
};
|
|
2593
2632
|
}[];
|
|
2594
|
-
icon: "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "
|
|
2633
|
+
icon: "File" | "Archived" | "Assigned" | "Briefcase" | "Certified" | "Close" | "Collapse" | "Draft" | "DuplicateYellow" | "Expand" | "ExternalValidate" | "FilledCheck" | "InReview" | "Offline" | "Registered" | "RequiresUpdates" | "Sent" | "Validated" | "WaitingApproval" | "ChartActivity" | "Activity" | "Archive" | "ArchiveTray" | "ArrowLeft" | "ArrowRight" | "Buildings" | "Circle" | "CaretDown" | "CaretLeft" | "CaretRight" | "ChartBar" | "ChartLine" | "ChatCircle" | "CheckSquare" | "Compass" | "Check" | "Copy" | "Database" | "DotsThreeVertical" | "ArrowCounterClockwise" | "MagnifyingGlassMinus" | "MagnifyingGlassPlus" | "Export" | "Eye" | "EyeSlash" | "Envelope" | "FileSearch" | "FileMinus" | "FilePlus" | "FileText" | "FileX" | "Handshake" | "Gear" | "GitBranch" | "IdentificationCard" | "List" | "ListBullets" | "Lock" | "MagnifyingGlass" | "MapPin" | "Medal" | "NotePencil" | "Paperclip" | "PaperPlaneTilt" | "Pen" | "PenNib" | "Pencil" | "PencilSimpleLine" | "Phone" | "Plus" | "Printer" | "SignOut" | "Stamp" | "Star" | "Target" | "TextT" | "Trash" | "UploadSimple" | "User" | "UserPlus" | "Users" | "WarningCircle" | "X" | "ChatText" | "CircleWavyCheck" | "CircleWavyQuestion" | "ArchiveBox" | "ArrowCircleDown" | "FileArrowUp" | "FileDotted" | "Files" | "PencilLine" | "PencilCircle" | "UserCircle" | "Clock" | "QrCode" | "Webcam" | "Sun" | "DeviceTabletCamera" | "Globe" | "Fingerprint" | "PushPin" | "Timer";
|
|
2595
2634
|
action?: {
|
|
2596
2635
|
type: "DELETE" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "MARK_AS_DUPLICATE" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "READ";
|
|
2597
2636
|
} | undefined;
|
|
@@ -1,6 +1,31 @@
|
|
|
1
|
+
import { FormConditionalParameters } from '../conditionals/conditionals';
|
|
1
2
|
import { FieldConditional } from './Conditional';
|
|
2
3
|
import { TranslationConfig } from './TranslationConfig';
|
|
3
|
-
import {
|
|
4
|
+
import { JurisdictionReference } from '../users/userReferences';
|
|
5
|
+
import { ComputedDefaultValue, SelectOption, ValidationConfig } from './FieldConfig';
|
|
6
|
+
/**
|
|
7
|
+
* Creates a {@link ComputedDefaultValue} descriptor for use in a field's `defaultValue`.
|
|
8
|
+
*
|
|
9
|
+
* Unlike `field(id).customClientEvaluation(fn)`, this builder is **not tied to any
|
|
10
|
+
* specific field**. Use it when the initial value should be derived purely from
|
|
11
|
+
* context variables (`$now`, `$online`, system variables such as `$user`) rather
|
|
12
|
+
* than from another field's current value.
|
|
13
|
+
*
|
|
14
|
+
* The serialised function receives `(undefined, context)` at runtime, where
|
|
15
|
+
* `context` is a {@link FormConditionalParameters} object.
|
|
16
|
+
*
|
|
17
|
+
* External references (e.g. lodash) are **not** available inside the function body —
|
|
18
|
+
* all logic must be self-contained so the code survives serialisation.
|
|
19
|
+
*
|
|
20
|
+
* @example
|
|
21
|
+
* // Default a date field to today
|
|
22
|
+
* defaultValue: evaluate((_, ctx) => ctx.$now)
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* // Default to the current user's role
|
|
26
|
+
* defaultValue: evaluate((_, ctx) => ctx.user.role)
|
|
27
|
+
*/
|
|
28
|
+
export declare function evaluate(computationFn: (fieldValue: undefined, context: FormConditionalParameters) => unknown): ComputedDefaultValue;
|
|
4
29
|
/**
|
|
5
30
|
* Entry point for defining conditional logic or configuration for a form field.
|
|
6
31
|
* @param fieldId - The ID of the field to define rules or config for.
|
|
@@ -11,12 +36,14 @@ export declare function field(fieldId: string, options?: {
|
|
|
11
36
|
conditionals?: FieldConditional[];
|
|
12
37
|
validations?: ValidationConfig[];
|
|
13
38
|
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
39
|
+
allowedLocations?: JurisdictionReference;
|
|
14
40
|
}): {
|
|
15
41
|
range: () => {
|
|
16
42
|
options?: SelectOption[];
|
|
17
43
|
conditionals?: FieldConditional[];
|
|
18
44
|
validations?: ValidationConfig[];
|
|
19
45
|
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
46
|
+
allowedLocations?: JurisdictionReference;
|
|
20
47
|
fieldId: string;
|
|
21
48
|
fieldType: "field";
|
|
22
49
|
} & {
|
|
@@ -29,6 +56,7 @@ export declare function field(fieldId: string, options?: {
|
|
|
29
56
|
conditionals?: FieldConditional[];
|
|
30
57
|
validations?: ValidationConfig[];
|
|
31
58
|
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
59
|
+
allowedLocations?: JurisdictionReference;
|
|
32
60
|
fieldId: string;
|
|
33
61
|
fieldType: "field";
|
|
34
62
|
} & {
|
|
@@ -41,6 +69,7 @@ export declare function field(fieldId: string, options?: {
|
|
|
41
69
|
conditionals?: FieldConditional[];
|
|
42
70
|
validations?: ValidationConfig[];
|
|
43
71
|
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
72
|
+
allowedLocations?: JurisdictionReference;
|
|
44
73
|
fieldId: string;
|
|
45
74
|
fieldType: "field";
|
|
46
75
|
} & {
|
|
@@ -53,6 +82,7 @@ export declare function field(fieldId: string, options?: {
|
|
|
53
82
|
conditionals?: FieldConditional[];
|
|
54
83
|
validations?: ValidationConfig[];
|
|
55
84
|
searchCriteriaLabelPrefix?: TranslationConfig;
|
|
85
|
+
allowedLocations?: JurisdictionReference;
|
|
56
86
|
fieldId: string;
|
|
57
87
|
fieldType: "field";
|
|
58
88
|
} & {
|
|
@@ -107,6 +137,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
107
137
|
fieldId: string;
|
|
108
138
|
};
|
|
109
139
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
140
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
141
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
110
142
|
};
|
|
111
143
|
asDob(): any;
|
|
112
144
|
asAge(): any;
|
|
@@ -144,6 +176,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
144
176
|
fieldId: string;
|
|
145
177
|
};
|
|
146
178
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
179
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
180
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
147
181
|
};
|
|
148
182
|
getByPath(fieldPath: string[]): {
|
|
149
183
|
$$subfield: string[];
|
|
@@ -189,6 +223,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
189
223
|
fieldId: string;
|
|
190
224
|
};
|
|
191
225
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
226
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
227
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
192
228
|
};
|
|
193
229
|
getByPath(fieldPath: string[]): any;
|
|
194
230
|
asDob(): {
|
|
@@ -232,6 +268,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
232
268
|
fieldId: string;
|
|
233
269
|
};
|
|
234
270
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
271
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
272
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
235
273
|
};
|
|
236
274
|
asAge(): {
|
|
237
275
|
$$subfield: string[];
|
|
@@ -274,6 +312,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
274
312
|
fieldId: string;
|
|
275
313
|
};
|
|
276
314
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
315
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
316
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
277
317
|
};
|
|
278
318
|
isAfter(): {
|
|
279
319
|
days: (days: number) => {
|
|
@@ -309,6 +349,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
309
349
|
fieldId: string;
|
|
310
350
|
};
|
|
311
351
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
352
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
353
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
312
354
|
};
|
|
313
355
|
asDob(): {
|
|
314
356
|
$$subfield: string[];
|
|
@@ -355,6 +397,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
355
397
|
fieldId: string;
|
|
356
398
|
};
|
|
357
399
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
400
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
401
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
358
402
|
};
|
|
359
403
|
asDob(): any;
|
|
360
404
|
asAge(): any;
|
|
@@ -392,6 +436,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
392
436
|
fieldId: string;
|
|
393
437
|
};
|
|
394
438
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
439
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
440
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
395
441
|
};
|
|
396
442
|
asAge(): {
|
|
397
443
|
$$subfield: string[];
|
|
@@ -438,6 +484,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
438
484
|
fieldId: string;
|
|
439
485
|
};
|
|
440
486
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
487
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
488
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
441
489
|
};
|
|
442
490
|
asDob(): any;
|
|
443
491
|
asAge(): any;
|
|
@@ -475,6 +523,8 @@ export declare function field(fieldId: string, options?: {
|
|
|
475
523
|
fieldId: string;
|
|
476
524
|
};
|
|
477
525
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
526
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
527
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
478
528
|
};
|
|
479
529
|
isAfter(): {
|
|
480
530
|
days: (days: number) => {
|
|
@@ -510,5 +560,7 @@ export declare function field(fieldId: string, options?: {
|
|
|
510
560
|
fieldId: string;
|
|
511
561
|
};
|
|
512
562
|
object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
|
|
563
|
+
customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
|
|
564
|
+
customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
|
|
513
565
|
};
|
|
514
566
|
//# sourceMappingURL=field.d.ts.map
|
|
@@ -22,6 +22,7 @@ export * from './FieldValue';
|
|
|
22
22
|
export * from './FormConfig';
|
|
23
23
|
export * from './CompositeFieldValue';
|
|
24
24
|
export * from './state';
|
|
25
|
+
export * from './state/flags';
|
|
25
26
|
export * from './utils';
|
|
26
27
|
export * from './defineConfig';
|
|
27
28
|
export * from './DeduplicationConfig';
|
|
@@ -37,6 +38,7 @@ export * from './scopes';
|
|
|
37
38
|
export * from './serializer';
|
|
38
39
|
export * from './state/availableActions';
|
|
39
40
|
export * from './FileUtils';
|
|
41
|
+
export * from './mocks.test.utils';
|
|
40
42
|
export * from '../conditionals/conditionals';
|
|
41
43
|
export * from '../conditionals/validate';
|
|
42
44
|
export * from './field';
|
|
@@ -1,6 +1,9 @@
|
|
|
1
|
+
import { Action, RequestedCorrectionAction } from '../ActionDocument';
|
|
1
2
|
import { Flag, CustomFlag } from '../Flag';
|
|
2
3
|
import { EventConfig } from '../EventConfig';
|
|
3
4
|
import { EventDocument } from '../EventDocument';
|
|
5
|
+
export declare function findPendingCorrectionAction(writeActions: Action[]): RequestedCorrectionAction | undefined;
|
|
6
|
+
export declare function isPotentialDuplicate(actions: Action[]): boolean;
|
|
4
7
|
/**
|
|
5
8
|
* This function resolves custom flags for an event based on its actions.
|
|
6
9
|
* Flags are not stored to the event state or any database directly, instead they are always computed/evaluated from the event actions.
|
|
@@ -18,5 +21,18 @@ import { EventDocument } from '../EventDocument';
|
|
|
18
21
|
* // Returns: ['flag-1', 'flag-3']
|
|
19
22
|
*/
|
|
20
23
|
export declare function resolveEventCustomFlags(event: EventDocument, eventConfiguration: EventConfig): CustomFlag[];
|
|
24
|
+
/**
|
|
25
|
+
* Computes all flags (inherent, action status, and custom) that should be attached to the given event,
|
|
26
|
+
* based on its actions and event-specific configuration.
|
|
27
|
+
*
|
|
28
|
+
* Flags are determined by combining:
|
|
29
|
+
* - Action status flags (format 'ActionType:ActionStatus')
|
|
30
|
+
* - Inherent flags (e.g. incomplete, rejected, correction requested, potential duplicate, edit in progress)
|
|
31
|
+
* - Event type-specific custom flags defined in the event configuration
|
|
32
|
+
*
|
|
33
|
+
* @param event - The EventDocument containing the action history and payload
|
|
34
|
+
* @param config - The EventConfig providing rules for custom flag evaluation
|
|
35
|
+
* @returns An array of flags currently relevant/applicable to the event
|
|
36
|
+
*/
|
|
21
37
|
export declare function getEventFlags(event: EventDocument, config: EventConfig): Flag[];
|
|
22
38
|
//# sourceMappingURL=flags.d.ts.map
|