@opencrvs/toolkit 1.9.8-rc.0cafd28 → 1.9.8-rc.0cf339f

package/dist/conditionals/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/conditionals/index.ts"],"names":[],"mappings":"AAUA,cAAc,gCAAgC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/conditionals/index.ts"],"names":[],"mappings":"AAaA,cAAc,gCAAgC,CAAA"}

package/dist/conditionals/index.js

@@ -35,22 +35,26 @@ __export(conditionals_exports, {
   createFieldConditionals: () => createFieldConditionals,
   defineConditional: () => defineConditional,
   defineFormConditional: () => defineFormConditional,
+  flag: () => flag,
+  isCodeToEvaluate: () => isCodeToEvaluate,
   isFieldReference: () => isFieldReference,
   never: () => never,
   not: () => not,
   now: () => now,
   or: () => or,
+  status: () => status,
   user: () => user
 });
 module.exports = __toCommonJS(conditionals_exports);
+var z4 = __toESM(require("zod/v4"));
 
 // ../commons/src/conditionals/conditionals.ts
 var objectHash = __toESM(require("object-hash"));
 
 // ../commons/src/events/serializers/user/serializer.ts
-var import_zod = require("zod");
-var SerializedUserField = import_zod.z.object({
-  $userField: import_zod.z.enum([
+var z = __toESM(require("zod/v4"));
+var SerializedUserField = z.object({
+  $userField: z.enum([
     "id",
     "name",
     "role",
@@ -59,11 +63,12 @@ var SerializedUserField = import_zod.z.object({
     "firstname",
     "middlename",
     "surname",
-    "district",
-    "province",
-    "primaryOfficeId"
+    "signature",
+    "avatar",
+    "primaryOfficeId",
+    "administrativeAreaId"
   ]),
-  $location: import_zod.z.string().optional()
+  $location: z.string().optional()
 });
 function userSerializer(userField) {
   return {
@@ -83,7 +88,7 @@ function userSerializer(userField) {
 }
 
 // ../commons/src/utils.ts
-var z2 = __toESM(require("zod"));
+var z2 = __toESM(require("zod/v4"));
 var FullNameV1 = z2.array(
   z2.object({
     use: z2.string(),
@@ -108,9 +113,9 @@ function omitKeyDeep(obj, keyToRemove) {
 }
 
 // ../commons/src/events/serializers/date/serializer.ts
-var import_zod2 = require("zod");
-var SerializedNowDateTime = import_zod2.z.object({
-  $$now: import_zod2.z.literal(true)
+var import_zod = require("zod");
+var SerializedNowDateTime = import_zod.z.object({
+  $$now: import_zod.z.literal(true)
 });
 function todayDateTimeValueSerializer() {
   return { $$now: true };
@@ -245,6 +250,9 @@ var user = Object.assign(userSerializer, {
 function isFieldReference(value) {
   return typeof value === "object" && value !== null && "$$field" in value;
 }
+function isCodeToEvaluate(value) {
+  return typeof value === "object" && value !== null && "$$code" in value;
+}
 function getDateRangeToFieldReference(field, comparedField, clause) {
   return {
     type: "object",
@@ -329,6 +337,33 @@ function defineComparison(field, value, keyword) {
     required: [field.$$field]
   });
 }
+function flag(flagvalue) {
+  return defineConditional({
+    type: "object",
+    properties: {
+      $flags: {
+        type: "array",
+        contains: {
+          type: "string",
+          const: flagvalue
+        }
+      }
+    },
+    required: ["$flags"]
+  });
+}
+function status(statusValue) {
+  return defineConditional({
+    type: "object",
+    properties: {
+      $status: {
+        type: "string",
+        const: statusValue
+      }
+    },
+    required: ["$status"]
+  });
+}
 function createFieldConditionals(fieldId) {
   const getDayRange = (field, days, clause, referenceDate) => ({
     type: "object",
@@ -654,6 +689,112 @@ function createFieldConditionals(fieldId) {
         required: [fieldId]
       });
     },
+    /**
+     * Executes a custom validation function defined by country configuration.
+     * 
+     * **Use this as a last resort when predefined toolkit methods are insufficient.**
+     * 
+     * The function is serialized via toString() and transmitted as part of the JSON Schema.
+     * It is deserialized just-in-time during validation on the client.
+     * 
+     * @param fn - Validation function that receives the field value and form context.
+     *             Must return true if valid, false if invalid.
+     * 
+     * @returns JSONSchema conditional for AJV validation
+     * 
+     * @example
+     * // Simple age validation
+     * field('age').customClientValidator((value, ctx) => {
+     *   return value >= 18
+     * })
+     * 
+     * @example
+     * // Cross-field validation: child DOB must be after mother DOB
+     * field('child.dob').customClientValidator((value, ctx) => {
+     *   const motherDob = ctx.$form['mother.dob']
+     *   if (!motherDob || !value) return false
+     *   return new Date(value) > new Date(motherDob)
+     * })
+     * 
+     * @example
+     * // Two number fields validated together
+     * field('fieldA').customClientValidator((value, ctx) => {
+     *   const fieldB = ctx.$form['fieldB']
+     *   if (!fieldB) return false
+     *   return value + fieldB > 100
+     * })
+     * 
+     * @remarks
+     * Limitations:
+     * - Client-side only. For backend validation, use country config event triggers.
+     * - Cannot reference external libraries (lodash, etc.)
+     * - Function must be pure — no side effects, no closures over external state
+     * - Function must be serialisable via toString()
+     * - Receives (value, context) parameters where context contains $form, $now, $online, etc.
+     * - Must return boolean: true = valid, false = invalid
+     * 
+     * @see https://github.com/opencrvs/opencrvs-core/issues/11653
+     */
+    customClientValidator(fn) {
+      const serializedFn = fn.toString();
+      return defineFormConditional({
+        type: "object",
+        properties: {
+          [fieldId]: wrapToPath(
+            {
+              customClientValidator: serializedFn
+            },
+            this.$$subfield
+          )
+        },
+        required: [fieldId]
+      });
+    },
+    /**
+     * Defines a client-side computation function for dynamic field values.
+     * 
+     * **Use this as a last resort when predefined toolkit methods are insufficient.**
+     * 
+     * The function is serialized via toString() and transmitted to the client,
+     * where it is deserialized and executed to compute field values dynamically.
+     * 
+     * @param fn - Computation function that receives the field value and form context.
+     *             Returns the computed value (any type).
+     * 
+     * @returns CodeToEvaluate object for client-side execution
+     * 
+     * @example
+     * // Concatenate first and last name
+     * field('fullName').customClientEvaluation((value, ctx) => {
+     *   return `${ctx.$form.firstName} ${ctx.$form.lastName}`
+     * })
+     * 
+     * @example
+     * // Calculate age from date of birth
+     * field('childAge').customClientEvaluation((value, ctx) => {
+     *   const dob = ctx.$form['child.dob']
+     *   if (!dob) return undefined
+     *   const age = Math.floor((new Date(ctx.$now) - new Date(dob)) / (365.25 * 24 * 60 * 60 * 1000))
+     *   return age
+     * })
+     * 
+     * @remarks
+     * Limitations:
+     * - Client-side only. For backend computation, use country config event triggers.
+     * - Cannot reference external libraries (lodash, etc.)
+     * - Function must be pure — no side effects, no closures over external state
+     * - Function must be serialisable via toString()
+     * - Receives (value, context) parameters where context contains $form, $now, $online, etc.
+     * - Should return the computed value (any type)
+     * 
+     * @see https://github.com/opencrvs/opencrvs-core/issues/11653
+     */
+    customClientEvaluation(fn) {
+      const serializedFn = fn.toString();
+      return {
+        $$code: serializedFn
+      };
+    },
     getId: () => ({ fieldId }),
     /**
      * @deprecated
@@ -682,3 +823,6 @@ function createFieldConditionals(fieldId) {
     })
   };
 }
+
+// src/conditionals/index.ts
+z4.globalRegistry.clear();

package/dist/events/deduplication.d.ts

@@ -7,17 +7,17 @@ export declare function field(fieldId: string): {
         fieldId: string;
         type: "fuzzy";
         options: {
+            fuzziness?: string | number | undefined;
             boost?: number | undefined;
             matchAgainst?: string | undefined;
-            fuzziness?: string | number | undefined;
         } | undefined;
     };
     strictMatches: (options?: StrictMatcherOptions) => {
         fieldId: string;
         type: "strict";
         options: {
-            value?: string | undefined;
             boost?: number | undefined;
+            value?: string | undefined;
             matchAgainst?: string | undefined;
         } | undefined;
     };
@@ -60,9 +60,9 @@ export declare function field(fieldId: string): {
         type: "dateRange";
         options: {
             days: number;
+            pivot?: number | undefined;
             boost?: number | undefined;
             matchAgainst?: string | undefined;
-            pivot?: number | undefined;
         };
     };
 };