@opencrvs/toolkit 2.0.0-rc.fe35c20 → 2.0.0-rc.fe577a4

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

@@ -58,6 +58,12 @@ export declare const CheckboxFieldValue: z.ZodBoolean;
 export type CheckboxFieldValue = z.infer<typeof CheckboxFieldValue>;
 export declare const NumberFieldValue: z.ZodNumber;
 export type NumberFieldValue = z.infer<typeof NumberFieldValue>;
+export declare const SignatureFieldValue: z.ZodObject<{
+    path: z.core.$ZodBranded<z.ZodString, "DocumentPath", "out">;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+}, z.core.$strip>;
+export type SignatureFieldValue = z.infer<typeof SignatureFieldValue>;
 export declare const ButtonFieldValue: z.ZodNumber;
 export type ButtonFieldValue = z.infer<typeof ButtonFieldValue>;
 export declare const VerificationStatusValue: z.ZodEnum<{

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

@@ -1,6 +1,30 @@
+import { FormConditionalParameters } from '../conditionals/conditionals';
 import { FieldConditional } from './Conditional';
 import { TranslationConfig } from './TranslationConfig';
-import { SelectOption, ValidationConfig } from './FieldConfig';
+import { ComputedDefaultValue, SelectOption, ValidationConfig } from './FieldConfig';
+/**
+ * Creates a {@link ComputedDefaultValue} descriptor for use in a field's `defaultValue`.
+ *
+ * Unlike `field(id).customClientEvaluation(fn)`, this builder is **not tied to any
+ * specific field**. Use it when the initial value should be derived purely from
+ * context variables (`$now`, `$online`, system variables such as `$user`) rather
+ * than from another field's current value.
+ *
+ * The serialised function receives `(undefined, context)` at runtime, where
+ * `context` is a {@link FormConditionalParameters} object.
+ *
+ * External references (e.g. lodash) are **not** available inside the function body —
+ * all logic must be self-contained so the code survives serialisation.
+ *
+ * @example
+ * // Default a date field to today
+ * defaultValue: evaluate((_, ctx) => ctx.$now)
+ *
+ * @example
+ * // Default to the current user's role
+ * defaultValue: evaluate((_, ctx) => ctx.user.role)
+ */
+export declare function evaluate(computationFn: (fieldValue: undefined, context: FormConditionalParameters) => unknown): ComputedDefaultValue;
 /**
  * Entry point for defining conditional logic or configuration for a form field.
  * @param fieldId - The ID of the field to define rules or config for.
@@ -107,6 +131,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         asDob(): any;
         asAge(): any;
@@ -144,6 +170,8 @@ export declare function field(fieldId: string, options?: {
             fieldId: string;
         };
         object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+        customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
     };
     getByPath(fieldPath: string[]): {
         $$subfield: string[];
@@ -189,6 +217,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         getByPath(fieldPath: string[]): any;
         asDob(): {
@@ -232,6 +262,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         asAge(): {
             $$subfield: string[];
@@ -274,6 +306,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         isAfter(): {
             days: (days: number) => {
@@ -309,6 +343,8 @@ export declare function field(fieldId: string, options?: {
             fieldId: string;
         };
         object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+        customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
     };
     asDob(): {
         $$subfield: string[];
@@ -355,6 +391,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         asDob(): any;
         asAge(): any;
@@ -392,6 +430,8 @@ export declare function field(fieldId: string, options?: {
             fieldId: string;
         };
         object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+        customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
     };
     asAge(): {
         $$subfield: string[];
@@ -438,6 +478,8 @@ export declare function field(fieldId: string, options?: {
                 fieldId: string;
             };
             object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+            customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+            customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
         };
         asDob(): any;
         asAge(): any;
@@ -475,6 +517,8 @@ export declare function field(fieldId: string, options?: {
             fieldId: string;
         };
         object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+        customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+        customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
     };
     isAfter(): {
         days: (days: number) => {
@@ -510,5 +554,7 @@ export declare function field(fieldId: string, options?: {
         fieldId: string;
     };
     object: (options: Record<string, any>) => import("../conditionals/conditionals").JSONSchema;
+    customClientValidator(validationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => boolean): import("../conditionals/conditionals").JSONSchema;
+    customClientEvaluation(computationFn: (fieldValue: unknown, context: import(".").ClientFunctionContext) => unknown): import("./FieldConfig").CodeToEvaluate;
 };
 //# sourceMappingURL=field.d.ts.map

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

@@ -241,6 +241,9 @@ export declare function getActionUpdateMetadata(actions: Action[]): Partial<{
     createdAtLocation?: (string & import("zod").$brand<"UUID">) | null | undefined;
     annotation?: Record<string, import("..").FieldUpdateValue> | null | undefined;
     originalActionId?: (string & import("zod").$brand<"UUID">) | null | undefined;
+    content?: {
+        immediateCorrection?: boolean | undefined;
+    } | undefined;
 } | {
     id: string & import("zod").$brand<"UUID">;
     transactionId: string;

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

@@ -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

@@ -1005,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
+      };
+    }
   };
 }