@opencrvs/toolkit 2.0.0-rc.ac001d6 → 2.0.0-rc.ac231e2
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/dist/application-config/index.js +46 -33
- package/dist/commons/api/router.d.ts +81 -15
- package/dist/commons/application-config/index.d.ts +1 -0
- package/dist/commons/conditionals/conditionals.d.ts +348 -4
- package/dist/commons/conditionals/validate.d.ts +51 -2
- package/dist/commons/events/ActionDocument.d.ts +6 -0
- package/dist/commons/events/ActionInput.d.ts +6 -0
- package/dist/commons/events/AdvancedSearchConfig.d.ts +342 -0
- package/dist/commons/events/EventDocument.d.ts +3 -0
- package/dist/commons/events/FieldConfig.d.ts +377 -50
- package/dist/commons/events/FieldValue.d.ts +6 -0
- package/dist/commons/events/field.d.ts +53 -1
- package/dist/commons/events/index.d.ts +1 -0
- package/dist/commons/events/state/flags.d.ts +1 -0
- package/dist/commons/events/state/utils.d.ts +3 -0
- package/dist/commons/events/utils.d.ts +12 -1
- package/dist/conditionals/index.js +48 -1
- package/dist/events/index.js +219 -81
- package/dist/notification/index.js +152 -36
- package/opencrvs-toolkit-2.0.0-rc.ac231e2.tgz +0 -0
- package/package.json +1 -1
- package/opencrvs-toolkit-2.0.0-rc.ac001d6.tgz +0 -0
|
@@ -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<{
|
|
@@ -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';
|
|
@@ -3,6 +3,7 @@ import { Flag, CustomFlag } from '../Flag';
|
|
|
3
3
|
import { EventConfig } from '../EventConfig';
|
|
4
4
|
import { EventDocument } from '../EventDocument';
|
|
5
5
|
export declare function findPendingCorrectionAction(writeActions: Action[]): RequestedCorrectionAction | undefined;
|
|
6
|
+
export declare function isPotentialDuplicate(actions: Action[]): boolean;
|
|
6
7
|
/**
|
|
7
8
|
* This function resolves custom flags for an event based on its actions.
|
|
8
9
|
* Flags are not stored to the event state or any database directly, instead they are always computed/evaluated from the event actions.
|
|
@@ -241,6 +241,9 @@ export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
|
|
|
241
241
|
createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
242
242
|
annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
|
|
243
243
|
originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
244
|
+
content?: {
|
|
245
|
+
immediateCorrection?: boolean | undefined;
|
|
246
|
+
} | undefined;
|
|
244
247
|
} | {
|
|
245
248
|
id: string & import("zod").$brand<"UUID">;
|
|
246
249
|
transactionId: string;
|
|
@@ -386,6 +386,9 @@ export declare function findLastAssignmentAction(actions: Action[]): {
|
|
|
386
386
|
createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
387
387
|
annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
|
|
388
388
|
originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
389
|
+
content?: {
|
|
390
|
+
immediateCorrection?: boolean | undefined;
|
|
391
|
+
} | undefined;
|
|
389
392
|
} | {
|
|
390
393
|
id: string & import("zod").$brand<"UUID">;
|
|
391
394
|
transactionId: string;
|
|
@@ -559,7 +562,15 @@ export declare function timePeriodToDateRange(value: SelectDateRangeValue): {
|
|
|
559
562
|
};
|
|
560
563
|
export declare function mergeDrafts(currentDraft: Draft, incomingDraft: Draft): Draft;
|
|
561
564
|
export declare function getPendingAction(actions: Action[]): ActionDocument;
|
|
562
|
-
export declare function getCompleteActionAnnotation(
|
|
565
|
+
export declare function getCompleteActionAnnotation(event: EventDocument, action: ActionDocument): ActionUpdate;
|
|
566
|
+
/**
|
|
567
|
+
* Resolves the complete content for an action, inheriting from its original
|
|
568
|
+
* Requested action when the Accepted action carries no content of its own.
|
|
569
|
+
*
|
|
570
|
+
* Mirrors the same "originalActionId → merge from Requested" pattern used by
|
|
571
|
+
* getCompleteActionAnnotation and getCompleteActionDeclaration.
|
|
572
|
+
*/
|
|
573
|
+
export declare function getCompleteActionContent(event: EventDocument, action: ActionDocument): Record<string, unknown> | null | undefined;
|
|
563
574
|
export declare function getCompleteActionDeclaration<T extends EventState | ActionUpdate>(declaration: T, event: EventDocument, action: ActionDocument): T;
|
|
564
575
|
export declare function getAcceptedActions(event: EventDocument): ActionDocument[];
|
|
565
576
|
export declare function aggregateActionDeclarations(event: EventDocument): EventState;
|
|
@@ -1005,7 +1005,54 @@ function createFieldConditionals(fieldId) {
|
|
|
1005
1005
|
}
|
|
1006
1006
|
},
|
|
1007
1007
|
required: [fieldId]
|
|
1008
|
-
})
|
|
1008
|
+
}),
|
|
1009
|
+
/**
|
|
1010
|
+
* Custom client-side validator. The provided function is serialised and executed
|
|
1011
|
+
* just-in-time on the client only. External references (e.g. lodash) are not
|
|
1012
|
+
* available inside the function body — all logic must be self-contained.
|
|
1013
|
+
*
|
|
1014
|
+
* @example
|
|
1015
|
+
* field('nid').customClientValidator((value) => {
|
|
1016
|
+
* // LUHN check — all logic must be inline
|
|
1017
|
+
* const digits = String(value).split('').map(Number)
|
|
1018
|
+
* // ...
|
|
1019
|
+
* return isValid
|
|
1020
|
+
* })
|
|
1021
|
+
*/
|
|
1022
|
+
customClientValidator(validationFn) {
|
|
1023
|
+
const code = validationFn.toString();
|
|
1024
|
+
return defineFormConditional({
|
|
1025
|
+
type: "object",
|
|
1026
|
+
properties: wrapToPath(
|
|
1027
|
+
{ [fieldId]: { customClientValidator: { code } } },
|
|
1028
|
+
this.$$subfield
|
|
1029
|
+
),
|
|
1030
|
+
required: [fieldId]
|
|
1031
|
+
});
|
|
1032
|
+
},
|
|
1033
|
+
/**
|
|
1034
|
+
* Custom client-side evaluation. Returns a {@link FieldReference} descriptor
|
|
1035
|
+
* that can be used as the `value` property or a DATA component entry.
|
|
1036
|
+
* The function receives the referenced field's value as the first argument and
|
|
1037
|
+
* the full form context as the second; its return value replaces the field reference.
|
|
1038
|
+
* The function is serialised and executed just-in-time on the client only.
|
|
1039
|
+
* External references (e.g. lodash) are not available inside the function body.
|
|
1040
|
+
*
|
|
1041
|
+
* For computing a default value without referencing a specific field, use
|
|
1042
|
+
* `evaluate(fn)` in the `defaultValue` property instead.
|
|
1043
|
+
*
|
|
1044
|
+
* @example
|
|
1045
|
+
* field('a').customClientEvaluation((aValue, ctx) =>
|
|
1046
|
+
* Number(aValue) + Number(ctx.$form.b)
|
|
1047
|
+
* )
|
|
1048
|
+
*/
|
|
1049
|
+
customClientEvaluation(computationFn) {
|
|
1050
|
+
return {
|
|
1051
|
+
$$code: computationFn.toString(),
|
|
1052
|
+
$$field: fieldId,
|
|
1053
|
+
$$subfield: this.$$subfield
|
|
1054
|
+
};
|
|
1055
|
+
}
|
|
1009
1056
|
};
|
|
1010
1057
|
}
|
|
1011
1058
|
|