@opencrvs/toolkit 2.0.0-rc.b4856ad → 2.0.0-rc.b600229
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 +103 -0
- package/create-countryconfig/package.json +21 -0
- package/dist/application-config/index.js +305 -129
- package/dist/cli.js +1952 -347
- package/dist/commons/api/router.d.ts +3380 -241
- package/dist/commons/application-config/index.d.ts +17 -4
- package/dist/commons/conditionals/conditionals.d.ts +360 -10
- package/dist/commons/conditionals/validate.d.ts +52 -2
- package/dist/commons/events/ActionDocument.d.ts +6 -0
- package/dist/commons/events/ActionInput.d.ts +114 -0
- package/dist/commons/events/Draft.d.ts +4 -2
- package/dist/commons/events/EventDocument.d.ts +3 -0
- package/dist/commons/events/EventIndex.d.ts +0 -3
- package/dist/commons/events/EventMetadata.d.ts +0 -7
- package/dist/commons/events/FieldConfig.d.ts +387 -50
- package/dist/commons/events/FieldValue.d.ts +6 -0
- package/dist/commons/events/WorkqueueConfig.d.ts +150 -150
- package/dist/commons/events/field.d.ts +47 -1
- package/dist/commons/events/index.d.ts +2 -0
- package/dist/commons/events/locations.d.ts +38 -1
- package/dist/commons/events/mocks.test.utils.d.ts +19 -0
- package/dist/commons/events/scopes.d.ts +24 -1
- package/dist/commons/events/state/flags.d.ts +16 -0
- package/dist/commons/events/state/index.d.ts +0 -4
- package/dist/commons/events/state/utils.d.ts +3 -2
- package/dist/commons/events/utils.d.ts +13 -2
- package/dist/conditionals/index.js +92 -9
- package/dist/events/index.js +1071 -257
- package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.d.ts.map +1 -1
- package/dist/migrations/v2.0/add-birth-certificate-issuance-flag.js +63 -39
- package/dist/migrations/v2.0/add-resend-invite-notification.d.ts +3 -0
- package/dist/migrations/v2.0/add-resend-invite-notification.d.ts.map +1 -0
- package/dist/migrations/v2.0/add-resend-invite-notification.js +373 -0
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts +19 -0
- package/dist/migrations/v2.0/checkout-upstream-files.d.ts.map +1 -1
- package/dist/migrations/v2.0/checkout-upstream-files.js +17 -14
- package/dist/migrations/v2.0/convert-config-files-to-ts.d.ts.map +1 -1
- package/dist/migrations/v2.0/convert-config-files-to-ts.js +4 -5
- package/dist/migrations/v2.0/convert-paragraph-to-heading.d.ts.map +1 -1
- package/dist/migrations/v2.0/convert-paragraph-to-heading.js +4 -5
- package/dist/migrations/v2.0/create-events-index.d.ts.map +1 -1
- package/dist/migrations/v2.0/create-events-index.js +1 -2
- package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts +11 -0
- package/dist/migrations/v2.0/delete-infrastructure-directory.d.ts.map +1 -0
- package/dist/migrations/v2.0/delete-infrastructure-directory.js +123 -0
- package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts +3 -0
- package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.d.ts.map +1 -0
- package/dist/migrations/v2.0/fix-accept-requested-registration-function-type.js +110 -0
- package/dist/migrations/v2.0/index.d.ts +10 -4
- package/dist/migrations/v2.0/index.d.ts.map +1 -1
- package/dist/migrations/v2.0/index.js +1920 -344
- package/dist/migrations/v2.0/make-built-in-validate-actions-custom.d.ts.map +1 -1
- package/dist/migrations/v2.0/make-built-in-validate-actions-custom.js +95 -7
- package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts +13 -0
- package/dist/migrations/v2.0/merge-infrastructure-directory.d.ts.map +1 -0
- package/dist/migrations/v2.0/merge-infrastructure-directory.js +222 -0
- package/dist/migrations/v2.0/migrate-application-config-url.d.ts +3 -0
- package/dist/migrations/v2.0/migrate-application-config-url.d.ts.map +1 -0
- package/dist/migrations/v2.0/migrate-application-config-url.js +342 -0
- package/dist/migrations/v2.0/migrate-scopes.d.ts.map +1 -1
- package/dist/migrations/v2.0/migrate-scopes.js +55 -32
- package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.d.ts.map +1 -1
- package/dist/migrations/v2.0/migrate-validated-workqueue-status-to-flag.js +3 -4
- package/dist/migrations/v2.0/migrate-workqueue-configs.d.ts.map +1 -1
- package/dist/migrations/v2.0/migrate-workqueue-configs.js +143 -63
- package/dist/migrations/v2.0/remove-delete-actions.d.ts.map +1 -1
- package/dist/migrations/v2.0/remove-delete-actions.js +3 -4
- package/dist/migrations/v2.0/remove-demo-scope.d.ts.map +1 -1
- package/dist/migrations/v2.0/remove-demo-scope.js +2 -3
- package/dist/migrations/v2.0/remove-deprecated-imports.d.ts.map +1 -1
- package/dist/migrations/v2.0/remove-deprecated-imports.js +3 -4
- package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts +3 -0
- package/dist/migrations/v2.0/remove-fhir-url-helpers.d.ts.map +1 -0
- package/dist/migrations/v2.0/remove-fhir-url-helpers.js +163 -0
- package/dist/migrations/v2.0/remove-hearth-migrations.d.ts.map +1 -1
- package/dist/migrations/v2.0/remove-hearth-migrations.js +1 -2
- package/dist/migrations/v2.0/remove-old-statistics-service.d.ts +3 -0
- package/dist/migrations/v2.0/remove-old-statistics-service.d.ts.map +1 -0
- package/dist/migrations/v2.0/remove-old-statistics-service.js +356 -0
- package/dist/migrations/v2.0/remove-pending-certification-flag.d.ts.map +1 -1
- package/dist/migrations/v2.0/remove-pending-certification-flag.js +3 -4
- package/dist/migrations/v2.0/remove-review-from-register-action.d.ts.map +1 -1
- package/dist/migrations/v2.0/remove-review-from-register-action.js +3 -4
- package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts +3 -0
- package/dist/migrations/v2.0/remove-unused-environment-variables.d.ts.map +1 -0
- package/dist/migrations/v2.0/remove-unused-environment-variables.js +186 -0
- package/dist/migrations/v2.0/rename-api-paths.d.ts.map +1 -1
- package/dist/migrations/v2.0/rename-api-paths.js +3 -4
- package/dist/migrations/v2.0/rename-location-parent-id.d.ts.map +1 -1
- package/dist/migrations/v2.0/rename-location-parent-id.js +3 -4
- package/dist/migrations/v2.0/simplify-analytics-precalculations.d.ts.map +1 -1
- package/dist/migrations/v2.0/simplify-analytics-precalculations.js +1 -2
- package/dist/migrations/v2.0/update-package-json.d.ts +3 -0
- package/dist/migrations/v2.0/update-package-json.d.ts.map +1 -0
- package/dist/migrations/v2.0/update-package-json.js +105 -0
- package/dist/notification/index.js +838 -160
- package/dist/scopes/index.d.ts +87 -10
- package/dist/scopes/index.js +46 -9
- package/opencrvs-toolkit-2.0.0-rc.b600229.tgz +0 -0
- package/package.json +6 -2
- package/tsconfig.tsbuildinfo +1 -1
- package/opencrvs-toolkit-2.0.0-rc.b4856ad.tgz +0 -0
|
@@ -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
|
|
@@ -9,7 +9,6 @@ import { UUID } from '../../uuid';
|
|
|
9
9
|
import { DocumentPath } from '../../documents';
|
|
10
10
|
export declare function getStatusFromActions(actions: Array<Action>): "CREATED" | "NOTIFIED" | "DECLARED" | "REGISTERED" | "ARCHIVED";
|
|
11
11
|
export declare function getAssignedUserFromActions(actions: Array<ActionDocument>): string | null;
|
|
12
|
-
export declare function getAssignedUserSignatureFromActions(actions: Array<ActionDocument>): string | null;
|
|
13
12
|
type NonNullableDeep<T> = T extends [unknown, ...unknown[]] ? {
|
|
14
13
|
[K in keyof T]: NonNullableDeep<NonNullable<T[K]>>;
|
|
15
14
|
} : T extends UUID ? T : T extends DocumentPath ? T : T extends string ? NonNullable<T> : T extends (infer U)[] ? NonNullableDeep<U>[] : T extends object ? {
|
|
@@ -73,7 +72,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
|
|
|
73
72
|
createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
74
73
|
createdByUserType?: "user" | "system" | null | undefined;
|
|
75
74
|
createdByRole?: string | undefined;
|
|
76
|
-
createdBySignature?: string | null | undefined;
|
|
77
75
|
} | null | undefined;
|
|
78
76
|
REGISTERED?: {
|
|
79
77
|
createdAt: string;
|
|
@@ -83,7 +81,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
|
|
|
83
81
|
createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
84
82
|
createdByUserType?: "user" | "system" | null | undefined;
|
|
85
83
|
createdByRole?: string | undefined;
|
|
86
|
-
createdBySignature?: string | null | undefined;
|
|
87
84
|
} | null | undefined;
|
|
88
85
|
};
|
|
89
86
|
createdAt: string;
|
|
@@ -101,7 +98,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
|
|
|
101
98
|
createdByUserType?: "user" | "system" | null | undefined;
|
|
102
99
|
updatedByUserRole?: string | null | undefined;
|
|
103
100
|
createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
104
|
-
createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
|
|
105
101
|
updatedAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
106
102
|
assignedTo?: string | null | undefined;
|
|
107
103
|
updatedBy?: string | null | undefined;
|
|
@@ -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;
|
|
@@ -312,7 +315,6 @@ export declare function getLegalStatuses(actions: Action[]): {
|
|
|
312
315
|
createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
313
316
|
acceptedAt: string;
|
|
314
317
|
createdByRole: string | undefined;
|
|
315
|
-
createdBySignature: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
|
|
316
318
|
registrationNumber: string | null | undefined;
|
|
317
319
|
} | null;
|
|
318
320
|
REGISTERED: {
|
|
@@ -322,7 +324,6 @@ export declare function getLegalStatuses(actions: Action[]): {
|
|
|
322
324
|
createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
|
|
323
325
|
acceptedAt: string;
|
|
324
326
|
createdByRole: string | undefined;
|
|
325
|
-
createdBySignature: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
|
|
326
327
|
registrationNumber: string | null | undefined;
|
|
327
328
|
} | null;
|
|
328
329
|
};
|
|
@@ -131,7 +131,7 @@ export declare function isPageVisible(page: PageConfig, formValues: ActionUpdate
|
|
|
131
131
|
* * @param validatorContext - custom validation context
|
|
132
132
|
* @returns {Partial<T>} A new object containing only the values for visible fields
|
|
133
133
|
*/
|
|
134
|
-
export declare function omitHiddenFields<T extends EventState | ActionUpdate>(fields: FieldConfig[], formValues: T, validatorContext: ValidatorContext, includeHiddenFieldsWithNullValues?: boolean
|
|
134
|
+
export declare function omitHiddenFields<T extends EventState | ActionUpdate>(fields: FieldConfig[], formValues: T, validatorContext: ValidatorContext, includeHiddenFieldsWithNullValues?: boolean): Partial<T>;
|
|
135
135
|
export declare function omitHiddenPaginatedFields<T extends EventState | ActionUpdate>(formConfig: FormConfig, values: T, validatorContext: ValidatorContext, includeHiddenFieldsWithNullValues?: boolean): Partial<Partial<T>>;
|
|
136
136
|
/**
|
|
137
137
|
*
|
|
@@ -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;
|
|
@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
30
30
|
// src/conditionals/index.ts
|
|
31
31
|
var conditionals_exports = {};
|
|
32
32
|
__export(conditionals_exports, {
|
|
33
|
+
always: () => always,
|
|
33
34
|
alwaysTrue: () => alwaysTrue,
|
|
34
35
|
and: () => and,
|
|
35
36
|
createFieldConditionals: () => createFieldConditionals,
|
|
@@ -182,6 +183,10 @@ var scopeByEvent = z6.preprocess(
|
|
|
182
183
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
183
184
|
z6.array(z6.string()).optional()
|
|
184
185
|
).describe("Event type, e.g. birth, death");
|
|
186
|
+
var userRole = z6.preprocess(
|
|
187
|
+
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
188
|
+
z6.array(z6.string()).optional()
|
|
189
|
+
).describe("User role, e.g. admin, field agent");
|
|
185
190
|
var scopeOptionsPlaceEvent = z6.object({
|
|
186
191
|
event: scopeByEvent,
|
|
187
192
|
placeOfEvent: JurisdictionFilter.optional()
|
|
@@ -205,6 +210,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
|
|
|
205
210
|
var AccessLevelOptions = z6.object({
|
|
206
211
|
accessLevel: JurisdictionFilter.optional()
|
|
207
212
|
});
|
|
213
|
+
var AllUserScopeOptions = AccessLevelOptions.extend({
|
|
214
|
+
role: userRole.optional()
|
|
215
|
+
});
|
|
208
216
|
var WorkqueueOrDashboardOptions = z6.object({
|
|
209
217
|
ids: z6.preprocess(
|
|
210
218
|
(val) => val === void 0 ? void 0 : [val].flat(),
|
|
@@ -214,6 +222,7 @@ var WorkqueueOrDashboardOptions = z6.object({
|
|
|
214
222
|
var AllScopeOptions = z6.object({
|
|
215
223
|
...AllRecordScopeOptions.shape,
|
|
216
224
|
...AccessLevelOptions.shape,
|
|
225
|
+
...AllUserScopeOptions.shape,
|
|
217
226
|
...WorkqueueOrDashboardOptions.shape
|
|
218
227
|
});
|
|
219
228
|
var ScopeOptionKey = AllScopeOptions.keyof();
|
|
@@ -286,6 +295,30 @@ var RecordScopeV2 = z6.discriminatedUnion("type", [
|
|
|
286
295
|
]).describe(
|
|
287
296
|
"Scopes used to check user's permission to perform actions on a record."
|
|
288
297
|
);
|
|
298
|
+
var SystemScopeType = z6.enum([
|
|
299
|
+
"organisation.read-locations",
|
|
300
|
+
"user.read",
|
|
301
|
+
"user.create",
|
|
302
|
+
"user.edit",
|
|
303
|
+
"user.search"
|
|
304
|
+
]);
|
|
305
|
+
var UserScopeType = SystemScopeType.extract([
|
|
306
|
+
"user.read",
|
|
307
|
+
"user.create",
|
|
308
|
+
"user.edit",
|
|
309
|
+
"user.search"
|
|
310
|
+
]);
|
|
311
|
+
var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
|
|
312
|
+
var UserScopeV2 = z6.discriminatedUnion("type", [
|
|
313
|
+
z6.object({
|
|
314
|
+
type: ScopesWithRoleOption,
|
|
315
|
+
options: AllUserScopeOptions.optional()
|
|
316
|
+
}),
|
|
317
|
+
z6.object({
|
|
318
|
+
type: UserScopeType.extract(["user.read", "user.search"]),
|
|
319
|
+
options: AccessLevelOptions.optional()
|
|
320
|
+
})
|
|
321
|
+
]);
|
|
289
322
|
var ResolvedRecordScopeV2 = z6.discriminatedUnion("type", [
|
|
290
323
|
z6.object({
|
|
291
324
|
type: ScopesWithPlaceEventOptions,
|
|
@@ -306,16 +339,14 @@ var ResolvedRecordScopeV2 = z6.discriminatedUnion("type", [
|
|
|
306
339
|
}).optional()
|
|
307
340
|
})
|
|
308
341
|
]).describe("Resolved scope with location/user IDs instead of filters.");
|
|
309
|
-
var SystemScopeType = z6.enum([
|
|
310
|
-
"organisation.read-locations",
|
|
311
|
-
"user.read",
|
|
312
|
-
"user.create",
|
|
313
|
-
"user.edit"
|
|
314
|
-
]);
|
|
315
342
|
var Scope2 = z6.discriminatedUnion("type", [
|
|
316
343
|
z6.object({ type: PlainScopeType }),
|
|
317
344
|
...RecordScopeV2.options,
|
|
318
|
-
|
|
345
|
+
...UserScopeV2.options,
|
|
346
|
+
z6.object({
|
|
347
|
+
type: z6.literal("organisation.read-locations"),
|
|
348
|
+
options: AccessLevelOptions.optional()
|
|
349
|
+
}),
|
|
319
350
|
z6.object({
|
|
320
351
|
type: z6.literal("workqueue"),
|
|
321
352
|
options: WorkqueueOrDashboardOptions
|
|
@@ -335,7 +366,9 @@ var ScopeType2 = z6.enum([
|
|
|
335
366
|
var EncodedScope2 = z6.string().brand("EncodedScope");
|
|
336
367
|
var DEFAULT_SCOPE_OPTIONS = {
|
|
337
368
|
placeOfEvent: JurisdictionFilter.enum.all,
|
|
338
|
-
accessLevel: JurisdictionFilter.enum.all
|
|
369
|
+
accessLevel: JurisdictionFilter.enum.all,
|
|
370
|
+
registeredIn: JurisdictionFilter.enum.all,
|
|
371
|
+
declaredIn: JurisdictionFilter.enum.all
|
|
339
372
|
};
|
|
340
373
|
|
|
341
374
|
// ../commons/src/users/userReferences.ts
|
|
@@ -422,6 +455,9 @@ function not(condition) {
|
|
|
422
455
|
function never() {
|
|
423
456
|
return not(alwaysTrue());
|
|
424
457
|
}
|
|
458
|
+
function always() {
|
|
459
|
+
return defineConditional(alwaysTrue());
|
|
460
|
+
}
|
|
425
461
|
function jsonFieldPath(field) {
|
|
426
462
|
return [field.$$field, ...field.$$subfield].join("/");
|
|
427
463
|
}
|
|
@@ -969,7 +1005,54 @@ function createFieldConditionals(fieldId) {
|
|
|
969
1005
|
}
|
|
970
1006
|
},
|
|
971
1007
|
required: [fieldId]
|
|
972
|
-
})
|
|
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
|
+
}
|
|
973
1056
|
};
|
|
974
1057
|
}
|
|
975
1058
|
|