@opencrvs/toolkit 2.0.0-rc.fef9d21 → 2.0.0-rc.ff1424b

package/dist/commons/events/scopes.d.ts

@@ -1,8 +1,9 @@
 import { DisplayableAction } from './ActionType';
-import { EncodedScope } from '../scopes';
+import { EncodedScope, UserScopeV2 } from '../scopes';
 import { EventIndexWithAdministrativeHierarchy } from './locations';
 import { UserContext } from '../users/User';
 import { EventIndex } from './EventIndex';
+import { UUID } from 'src/uuid';
 export declare const ACTION_SCOPE_MAP: {
     READ: "record.read"[];
     CREATE: "record.create"[];
@@ -53,4 +54,26 @@ export declare function isActionInScope({ scopes, action, event, currentUser }:
     event: EventIndexWithAdministrativeHierarchy;
     currentUser: UserContext;
 }): boolean;
+/**
+ *
+ *
+ * @param allRoles - All possible roles in the system
+ * @param userLocation - The location and role information of the user whose role options are being determined
+ * @param acceptedScopes - The scopes of the user requesting the role update, used to determine which roles they can assign.
+ * @param userRequesting - The user context of the user requesting the role update, used to check location-based access to the target user's location.
+ *
+ * @returns An array of roles that the requesting user is allowed to assign to the target user based on their scopes and location
+ *
+ * 1) Used to determine which roles should be available in the dropdown when a user is editing another user's role in the user management interface.
+ * 2) Used to check if payload includes valid role.
+ */
+export declare function getAvailableRolesForUserUpdatePayload({ allRoles, userLocation, acceptedScopes, userRequesting }: {
+    allRoles: string[];
+    userRequesting: UserContext;
+    acceptedScopes: UserScopeV2[];
+    userLocation: {
+        administrativeHierarchy: UUID[];
+        primaryOfficeId: UUID;
+    };
+}): string[];
 //# sourceMappingURL=scopes.d.ts.map

package/dist/commons/events/state/flags.d.ts

@@ -1,6 +1,9 @@
+import { Action, RequestedCorrectionAction } from '../ActionDocument';
 import { Flag, CustomFlag } from '../Flag';
 import { EventConfig } from '../EventConfig';
 import { EventDocument } from '../EventDocument';
+export declare function findPendingCorrectionAction(writeActions: Action[]): RequestedCorrectionAction | undefined;
+export declare function isPotentialDuplicate(actions: Action[]): boolean;
 /**
  * This function resolves custom flags for an event based on its actions.
  * 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';
  * // Returns: ['flag-1', 'flag-3']
  */
 export declare function resolveEventCustomFlags(event: EventDocument, eventConfiguration: EventConfig): CustomFlag[];
+/**
+ * Computes all flags (inherent, action status, and custom) that should be attached to the given event,
+ * based on its actions and event-specific configuration.
+ *
+ * Flags are determined by combining:
+ *  - Action status flags (format 'ActionType:ActionStatus')
+ *  - Inherent flags (e.g. incomplete, rejected, correction requested, potential duplicate, edit in progress)
+ *  - Event type-specific custom flags defined in the event configuration
+ *
+ * @param event - The EventDocument containing the action history and payload
+ * @param config - The EventConfig providing rules for custom flag evaluation
+ * @returns An array of flags currently relevant/applicable to the event
+ */
 export declare function getEventFlags(event: EventDocument, config: EventConfig): Flag[];
 //# sourceMappingURL=flags.d.ts.map

package/dist/commons/events/state/index.d.ts

@@ -9,7 +9,6 @@ import { UUID } from '../../uuid';
 import { DocumentPath } from '../../documents';
 export declare function getStatusFromActions(actions: Array<Action>): "CREATED" | "NOTIFIED" | "DECLARED" | "REGISTERED" | "ARCHIVED";
 export declare function getAssignedUserFromActions(actions: Array<ActionDocument>): string | null;
-export declare function getAssignedUserSignatureFromActions(actions: Array<ActionDocument>): string | null;
 type NonNullableDeep<T> = T extends [unknown, ...unknown[]] ? {
     [K in keyof T]: NonNullableDeep<NonNullable<T[K]>>;
 } : 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
             createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
             createdByUserType?: "user" | "system" | null | undefined;
             createdByRole?: string | undefined;
-            createdBySignature?: string | null | undefined;
         } | null | undefined;
         REGISTERED?: {
             createdAt: string;
@@ -83,7 +81,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
             createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
             createdByUserType?: "user" | "system" | null | undefined;
             createdByRole?: string | undefined;
-            createdBySignature?: string | null | undefined;
         } | null | undefined;
     };
     createdAt: string;
@@ -101,7 +98,6 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
     createdByUserType?: "user" | "system" | null | undefined;
     updatedByUserRole?: string | null | undefined;
     createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
     updatedAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
     assignedTo?: string | null | undefined;
     updatedBy?: string | null | undefined;

package/dist/commons/events/state/utils.d.ts

@@ -1,279 +1,17 @@
 import { Action } from '../ActionDocument';
 /**
- * Given action type and actions, returns the action creation metadata for the event.
- * Since we do not consistently store the request action, we need to check if it exists.
- * @returns details of last user who triggered **Declaration** action.
- * @see EventIndex for the description of the returned object.
+ * Returns the creation metadata of the last update action (Requested or Accepted).
+ * Requested actions are included so that async flows (202) correctly reflect the
+ * metadata of the user who triggered the action before country config accepts it.
  *
- * */
-export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "REGISTER";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    registrationNumber?: string | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "DUPLICATE_DETECTED";
-    content: {
-        duplicates: {
-            id: string & import("zod").$brand<"UUID">;
-            trackingId: string;
-        }[];
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "EDIT";
-    content: {
-        comment?: string | undefined;
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "PRINT_CERTIFICATE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    content?: {
-        templateId?: string | undefined;
-    } | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "REQUEST_CORRECTION";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "CUSTOM";
-    customActionType: string;
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "CREATE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "REJECT";
-    content: {
-        reason: string;
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "MARK_AS_NOT_DUPLICATE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "MARK_AS_DUPLICATE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    content?: {
-        duplicateOf: string & import("zod").$brand<"UUID">;
-    } | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "ARCHIVE";
-    content: {
-        reason: string;
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "NOTIFY";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "DECLARE";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "ASSIGN";
-    assignedTo: string;
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "APPROVE_CORRECTION";
-    requestId: string;
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "REJECT_CORRECTION";
-    requestId: string;
-    content: {
-        reason: string;
-    };
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    declaration: Record<string, import("..").FieldUpdateValue>;
-    status: "Requested" | "Accepted" | "Rejected";
-    type: "UNASSIGN";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
+ * When an Accepted action carries an originalActionId, its metadata is sourced from
+ * the original Requested action (the human who triggered it), not from the system
+ * or 3rd party that accepted it.
+ *
+ * @returns metadata of the last user who triggered a status-changing action.
+ * @see EventIndex for the description of the returned object.
+ */
+export declare function getActionUpdateMetadata(actions: Action[]): Pick<{
     id: string & import("zod").$brand<"UUID">;
     transactionId: string;
     createdByUserType: "user" | "system";
@@ -281,25 +19,12 @@ export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
     createdBy: string;
     declaration: Record<string, import("..").FieldUpdateValue>;
     status: "Requested" | "Accepted" | "Rejected";
-    type: "READ";
     createdByRole?: string | undefined;
     createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
     createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
     annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
     originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-} | {
-    id: string & import("zod").$brand<"UUID">;
-    transactionId: string;
-    createdByUserType: "user" | "system";
-    createdAt: string;
-    createdBy: string;
-    type: "CUSTOM" | "NOTIFY" | "DECLARE" | "REGISTER" | "EDIT" | "REJECT" | "ARCHIVE" | "PRINT_CERTIFICATE" | "REQUEST_CORRECTION" | "REJECT_CORRECTION" | "APPROVE_CORRECTION";
-    status: "Rejected";
-    createdByRole?: string | undefined;
-    createdBySignature?: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
-    createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
-    originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
-}>;
+}, "createdByUserType" | "createdAt" | "createdBy" | "createdByRole" | "createdAtLocation">;
 /**
  * @returns the legal statuses of the event. Event is considered legal if it has been accepted.
  * @see EventIndex for the description of the returned object.
@@ -312,7 +37,6 @@ export declare function getLegalStatuses(actions: Action[]): {
         createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
         acceptedAt: string;
         createdByRole: string | undefined;
-        createdBySignature: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
         registrationNumber: string | null | undefined;
     } | null;
     REGISTERED: {
@@ -322,7 +46,6 @@ export declare function getLegalStatuses(actions: Action[]): {
         createdAtLocation: (string & import("zod").$brand<"UUID">) | null | undefined;
         acceptedAt: string;
         createdByRole: string | undefined;
-        createdBySignature: (string & import("zod").$brand<"DocumentPath">) | null | undefined;
         registrationNumber: string | null | undefined;
     } | null;
 };

package/dist/commons/events/utils.d.ts

@@ -131,7 +131,7 @@ export declare function isPageVisible(page: PageConfig, formValues: ActionUpdate
  * * @param validatorContext - custom validation context
  * @returns {Partial<T>} A new object containing only the values for visible fields
  */
-export declare function omitHiddenFields<T extends EventState | ActionUpdate>(fields: FieldConfig[], formValues: T, validatorContext: ValidatorContext, includeHiddenFieldsWithNullValues?: boolean, declarationContext?: EventState): Partial<T>;
+export declare function omitHiddenFields<T extends EventState | ActionUpdate>(fields: FieldConfig[], formValues: T, validatorContext: ValidatorContext, includeHiddenFieldsWithNullValues?: boolean): Partial<T>;
 export declare function omitHiddenPaginatedFields<T extends EventState | ActionUpdate>(formConfig: FormConfig, values: T, validatorContext: ValidatorContext, includeHiddenFieldsWithNullValues?: boolean): Partial<Partial<T>>;
 /**
  *
@@ -386,6 +386,9 @@ export declare function findLastAssignmentAction(actions: Action[]): {
     createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
     annotation?: Record<string, import("./FieldValue").FieldUpdateValue> | null | undefined;
     originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
+    content?: {
+        immediateCorrection?: boolean | undefined;
+    } | undefined;
 } | {
     id: string & import("zod").$brand<"UUID">;
     transactionId: string;
@@ -559,7 +562,15 @@ export declare function timePeriodToDateRange(value: SelectDateRangeValue): {
 };
 export declare function mergeDrafts(currentDraft: Draft, incomingDraft: Draft): Draft;
 export declare function getPendingAction(actions: Action[]): ActionDocument;
-export declare function getCompleteActionAnnotation(annotation: ActionUpdate, event: EventDocument, action: ActionDocument): ActionUpdate;
+export declare function getCompleteActionAnnotation(event: EventDocument, action: ActionDocument): ActionUpdate;
+/**
+ * Resolves the complete content for an action, inheriting from its original
+ * Requested action when the Accepted action carries no content of its own.
+ *
+ * Mirrors the same "originalActionId → merge from Requested" pattern used by
+ * getCompleteActionAnnotation and getCompleteActionDeclaration.
+ */
+export declare function getCompleteActionContent(event: EventDocument, action: ActionDocument): Record<string, unknown> | null | undefined;
 export declare function getCompleteActionDeclaration<T extends EventState | ActionUpdate>(declaration: T, event: EventDocument, action: ActionDocument): T;
 export declare function getAcceptedActions(event: EventDocument): ActionDocument[];
 export declare function aggregateActionDeclarations(event: EventDocument): EventState;

package/dist/conditionals/index.js

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/conditionals/index.ts
 var conditionals_exports = {};
 __export(conditionals_exports, {
+  always: () => always,
   alwaysTrue: () => alwaysTrue,
   and: () => and,
   createFieldConditionals: () => createFieldConditionals,
@@ -182,6 +183,10 @@ var scopeByEvent = z6.preprocess(
   (val) => val === void 0 ? void 0 : [val].flat(),
   z6.array(z6.string()).optional()
 ).describe("Event type, e.g. birth, death");
+var userRole = z6.preprocess(
+  (val) => val === void 0 ? void 0 : [val].flat(),
+  z6.array(z6.string()).optional()
+).describe("User role, e.g. admin, field agent");
 var scopeOptionsPlaceEvent = z6.object({
   event: scopeByEvent,
   placeOfEvent: JurisdictionFilter.optional()
@@ -205,6 +210,9 @@ var CustomActionScopeOptions = AllRecordScopeOptions.extend({
 var AccessLevelOptions = z6.object({
   accessLevel: JurisdictionFilter.optional()
 });
+var AllUserScopeOptions = AccessLevelOptions.extend({
+  role: userRole.optional()
+});
 var WorkqueueOrDashboardOptions = z6.object({
   ids: z6.preprocess(
     (val) => val === void 0 ? void 0 : [val].flat(),
@@ -214,6 +222,7 @@ var WorkqueueOrDashboardOptions = z6.object({
 var AllScopeOptions = z6.object({
   ...AllRecordScopeOptions.shape,
   ...AccessLevelOptions.shape,
+  ...AllUserScopeOptions.shape,
   ...WorkqueueOrDashboardOptions.shape
 });
 var ScopeOptionKey = AllScopeOptions.keyof();
@@ -286,6 +295,30 @@ var RecordScopeV2 = z6.discriminatedUnion("type", [
 ]).describe(
   "Scopes used to check user's permission to perform actions on a record."
 );
+var SystemScopeType = z6.enum([
+  "organisation.read-locations",
+  "user.read",
+  "user.create",
+  "user.edit",
+  "user.search"
+]);
+var UserScopeType = SystemScopeType.extract([
+  "user.read",
+  "user.create",
+  "user.edit",
+  "user.search"
+]);
+var ScopesWithRoleOption = UserScopeType.extract(["user.edit", "user.create"]);
+var UserScopeV2 = z6.discriminatedUnion("type", [
+  z6.object({
+    type: ScopesWithRoleOption,
+    options: AllUserScopeOptions.optional()
+  }),
+  z6.object({
+    type: UserScopeType.extract(["user.read", "user.search"]),
+    options: AccessLevelOptions.optional()
+  })
+]);
 var ResolvedRecordScopeV2 = z6.discriminatedUnion("type", [
   z6.object({
     type: ScopesWithPlaceEventOptions,
@@ -306,16 +339,14 @@ var ResolvedRecordScopeV2 = z6.discriminatedUnion("type", [
     }).optional()
   })
 ]).describe("Resolved scope with location/user IDs instead of filters.");
-var SystemScopeType = z6.enum([
-  "organisation.read-locations",
-  "user.read",
-  "user.create",
-  "user.edit"
-]);
 var Scope2 = z6.discriminatedUnion("type", [
   z6.object({ type: PlainScopeType }),
   ...RecordScopeV2.options,
-  z6.object({ type: SystemScopeType, options: AccessLevelOptions.optional() }),
+  ...UserScopeV2.options,
+  z6.object({
+    type: z6.literal("organisation.read-locations"),
+    options: AccessLevelOptions.optional()
+  }),
   z6.object({
     type: z6.literal("workqueue"),
     options: WorkqueueOrDashboardOptions
@@ -335,7 +366,9 @@ var ScopeType2 = z6.enum([
 var EncodedScope2 = z6.string().brand("EncodedScope");
 var DEFAULT_SCOPE_OPTIONS = {
   placeOfEvent: JurisdictionFilter.enum.all,
-  accessLevel: JurisdictionFilter.enum.all
+  accessLevel: JurisdictionFilter.enum.all,
+  registeredIn: JurisdictionFilter.enum.all,
+  declaredIn: JurisdictionFilter.enum.all
 };
 
 // ../commons/src/users/userReferences.ts
@@ -422,6 +455,9 @@ function not(condition) {
 function never() {
   return not(alwaysTrue());
 }
+function always() {
+  return defineConditional(alwaysTrue());
+}
 function jsonFieldPath(field) {
   return [field.$$field, ...field.$$subfield].join("/");
 }
@@ -969,7 +1005,54 @@ function createFieldConditionals(fieldId) {
         }
       },
       required: [fieldId]
-    })
+    }),
+    /**
+     * Custom client-side validator. The provided function is serialised and executed
+     * just-in-time on the client only. External references (e.g. lodash) are not
+     * available inside the function body — all logic must be self-contained.
+     *
+     * @example
+     * field('nid').customClientValidator((value) => {
+     *   // LUHN check — all logic must be inline
+     *   const digits = String(value).split('').map(Number)
+     *   // ...
+     *   return isValid
+     * })
+     */
+    customClientValidator(validationFn) {
+      const code = validationFn.toString();
+      return defineFormConditional({
+        type: "object",
+        properties: wrapToPath(
+          { [fieldId]: { customClientValidator: { code } } },
+          this.$$subfield
+        ),
+        required: [fieldId]
+      });
+    },
+    /**
+     * Custom client-side evaluation. Returns a {@link FieldReference} descriptor
+     * that can be used as the `value` property or a DATA component entry.
+     * The function receives the referenced field's value as the first argument and
+     * the full form context as the second; its return value replaces the field reference.
+     * The function is serialised and executed just-in-time on the client only.
+     * External references (e.g. lodash) are not available inside the function body.
+     *
+     * For computing a default value without referencing a specific field, use
+     * `evaluate(fn)` in the `defaultValue` property instead.
+     *
+     * @example
+     * field('a').customClientEvaluation((aValue, ctx) =>
+     *   Number(aValue) + Number(ctx.$form.b)
+     * )
+     */
+    customClientEvaluation(computationFn) {
+      return {
+        $$code: computationFn.toString(),
+        $$field: fieldId,
+        $$subfield: this.$$subfield
+      };
+    }
   };
 }