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

package/dist/migrations/v2.0/index.js

@@ -2394,14 +2394,20 @@ var encodeScope = (scope) => {
     encode: false
   });
 };
+var decodedScopeCache = /* @__PURE__ */ new Map();
 var decodeScope = (query) => {
+  if (decodedScopeCache.has(query)) {
+    return decodedScopeCache.get(query);
+  }
   const scope = qs.parse(query, {
     ignoreQueryPrefix: true,
     comma: true,
     allowDots: true
   });
   const unflattenedScope = unflattenScope(scope);
-  return Scope2.safeParse(unflattenedScope)?.data;
+  const result = Scope2.safeParse(unflattenedScope)?.data;
+  decodedScopeCache.set(query, result);
+  return result;
 };
 var DEFAULT_SCOPE_OPTIONS = {
   placeOfEvent: JurisdictionFilter.enum.all,

package/dist/notification/index.js

@@ -917,6 +917,7 @@ var DateRangeFieldValue = z12.object({
 var EmailValue = z12.email();
 var CheckboxFieldValue = z12.boolean();
 var NumberFieldValue = z12.number();
+var SignatureFieldValue = FileFieldValue;
 var ButtonFieldValue = z12.number();
 var VerificationStatusValue = z12.enum([
   "verified",
@@ -1215,8 +1216,9 @@ var RequestedCorrectionAction = ActionBase.extend(
 var ApprovedCorrectionAction = ActionBase.extend(
   z14.object({
     type: z14.literal(ActionType.APPROVE_CORRECTION),
-    requestId: z14.string()
+    requestId: z14.string(),
     // TODO move into 'content' property
+    content: z14.object({ immediateCorrection: z14.boolean().optional() }).optional()
   }).shape
 );
 var RejectedCorrectionAction = ActionBase.extend(
@@ -1665,8 +1667,18 @@ var FieldReference = import_v43.default.object({
   $$field: FieldId.describe("Id of the field to reference"),
   $$subfield: import_v43.default.array(import_v43.default.string()).optional().default([]).describe(
     'If the FieldValue is an object, subfield can be used to refer to e.g. `["foo", "bar"]` in `{ foo: { bar: 3 } }`'
+  ),
+  $$code: import_v43.default.string().optional().describe(
+    "Serialised client-side function body. When present the expression is evaluated rather than dereferenced."
   )
-}).describe("Reference to a field by its ID");
+}).describe(
+  "Reference to a field value, with an optional client-side computation applied."
+);
+var ComputedDefaultValue = import_v43.default.object({
+  $$code: import_v43.default.string().describe(
+    "Serialised client-side function body. Receives (undefined, context) where context includes $now, $online, and system variables."
+  )
+}).describe("A context-only computation used as a field default value.");
 var ValidationConfig = import_v43.default.object({
   validator: Conditional.describe(
     "Conditional expression that must hold for the field value to be considered valid."
@@ -1707,7 +1719,7 @@ var BaseField = import_v43.default.object({
     "Indicates whether the field can be modified during record correction."
   ),
   value: FieldReference.or(import_v43.default.array(FieldReference)).optional().describe(
-    "Reference to the source field or fields. When a value is defined, it is copied from the parent field when changed. If multiple references are provided, the first truthy value is used."
+    "Reference to the source field or fields. When a value is defined, it is copied from the parent field when changed. If multiple references are provided, the first truthy value is used. A FieldReference with $$code computes the value via a custom client-side function."
   ),
   analytics: import_v43.default.boolean().default(false).optional().describe(
     "Indicates whether the field is included in analytics. When enabled, its value becomes available in the analytics dashboard."
@@ -1721,7 +1733,7 @@ var Divider = BaseField.extend({
 });
 var TextField = BaseField.extend({
   type: import_v43.default.literal(FieldType.TEXT),
-  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
+  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
   configuration: import_v43.default.object({
     maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
     type: import_v43.default.enum(["text", "password"]).optional(),
@@ -1734,7 +1746,7 @@ var TextField = BaseField.extend({
 });
 var NumberField = BaseField.extend({
   type: import_v43.default.literal(FieldType.NUMBER),
-  defaultValue: NumberFieldValue.optional(),
+  defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     min: import_v43.default.number().optional().describe("Minimum value"),
     max: import_v43.default.number().optional().describe("Maximum value"),
@@ -1747,7 +1759,7 @@ var NumberField = BaseField.extend({
 });
 var TextAreaField = BaseField.extend({
   type: import_v43.default.literal(FieldType.TEXTAREA),
-  defaultValue: NonEmptyTextValue.optional(),
+  defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     maxLength: import_v43.default.number().optional().describe("Maximum length of the text"),
     rows: import_v43.default.number().optional().describe("Number of visible text lines"),
@@ -1781,7 +1793,7 @@ var SignatureField = BaseField.extend({
   signaturePromptLabel: TranslationConfig.describe(
     "Title of the signature modal"
   ),
-  defaultValue: FieldValue.optional(),
+  defaultValue: SignatureFieldValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
     acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature")
@@ -1797,14 +1809,14 @@ var EmailField = BaseField.extend({
   configuration: import_v43.default.object({
     maxLength: import_v43.default.number().optional().describe("Maximum length of the text")
   }).default({ maxLength: 255 }).optional(),
-  defaultValue: NonEmptyTextValue.optional()
+  defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional()
 }).meta({
   description: "An email input field",
   id: "EmailField"
 });
 var DateField = BaseField.extend({
   type: import_v43.default.literal(FieldType.DATE),
-  defaultValue: SerializedNowDateTime.or(PlainDate).optional().describe("Default date value(yyyy-MM-dd)"),
+  defaultValue: SerializedNowDateTime.or(PlainDate).or(ComputedDefaultValue).optional().describe("Default date value(yyyy-MM-dd)"),
   configuration: import_v43.default.object({
     notice: TranslationConfig.describe(
       "Text to display above the date input"
@@ -1816,7 +1828,7 @@ var DateField = BaseField.extend({
 });
 var AgeField = BaseField.extend({
   type: import_v43.default.literal(FieldType.AGE),
-  defaultValue: NumberFieldValue.optional(),
+  defaultValue: NumberFieldValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     asOfDate: FieldReference,
     prefix: TranslationConfig.optional(),
@@ -1828,7 +1840,7 @@ var AgeField = BaseField.extend({
 });
 var TimeField = BaseField.extend({
   type: import_v43.default.literal(FieldType.TIME),
-  defaultValue: SerializedNowDateTime.or(TimeValue).optional().describe("Default time value (HH-mm)"),
+  defaultValue: SerializedNowDateTime.or(TimeValue).or(ComputedDefaultValue).optional().describe("Default time value (HH-mm)"),
   configuration: import_v43.default.object({
     use12HourFormat: import_v43.default.boolean().optional().describe("Whether to use 12-hour format"),
     notice: TranslationConfig.describe(
@@ -1841,7 +1853,7 @@ var TimeField = BaseField.extend({
 });
 var DateRangeField = BaseField.extend({
   type: import_v43.default.literal(FieldType.DATE_RANGE),
-  defaultValue: DateRangeFieldValue.optional(),
+  defaultValue: DateRangeFieldValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     notice: TranslationConfig.describe(
       "Text to display above the date input"
@@ -1920,7 +1932,7 @@ var PageHeader = BaseField.extend({
 });
 var File = BaseField.extend({
   type: import_v43.default.literal(FieldType.FILE),
-  defaultValue: FileFieldValue.optional(),
+  defaultValue: FileFieldValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
     acceptedFileTypes: MimeType.array().optional().describe("List of allowed file formats for the signature"),
@@ -1947,7 +1959,7 @@ var SelectOption = import_v43.default.object({
 });
 var NumberWithUnitField = BaseField.extend({
   type: import_v43.default.literal(FieldType.NUMBER_WITH_UNIT),
-  defaultValue: NumberWithUnitFieldValue.optional(),
+  defaultValue: NumberWithUnitFieldValue.or(ComputedDefaultValue).optional(),
   options: import_v43.default.array(SelectOption).describe("A list of options for the unit select"),
   configuration: import_v43.default.object({
     min: import_v43.default.number().optional().describe("Minimum value of the number field"),
@@ -1962,7 +1974,7 @@ var NumberWithUnitField = BaseField.extend({
 });
 var RadioGroup = BaseField.extend({
   type: import_v43.default.literal(FieldType.RADIO_GROUP),
-  defaultValue: TextValue.optional(),
+  defaultValue: TextValue.or(ComputedDefaultValue).optional(),
   options: import_v43.default.array(SelectOption).describe("A list of options"),
   configuration: import_v43.default.object({
     styles: import_v43.default.object({
@@ -1987,7 +1999,7 @@ var BulletList = BaseField.extend({
 });
 var Select = BaseField.extend({
   type: import_v43.default.literal(FieldType.SELECT),
-  defaultValue: TextValue.optional(),
+  defaultValue: TextValue.or(ComputedDefaultValue).optional(),
   options: import_v43.default.array(SelectOption).describe("A list of options"),
   noOptionsMessage: TranslationConfig.optional().describe(
     `
@@ -2009,7 +2021,7 @@ var SelectDateRangeOption = import_v43.default.object({
 });
 var SelectDateRangeField = BaseField.extend({
   type: import_v43.default.literal(FieldType.SELECT_DATE_RANGE),
-  defaultValue: SelectDateRangeValue.optional(),
+  defaultValue: SelectDateRangeValue.or(ComputedDefaultValue).optional(),
   options: import_v43.default.array(SelectDateRangeOption).describe("A list of options")
 }).meta({
   description: "A date range selection field",
@@ -2026,7 +2038,7 @@ var NameField = BaseField.extend({
     firstname: SerializedUserField.or(NonEmptyTextValue).optional(),
     middlename: SerializedUserField.or(NonEmptyTextValue).optional(),
     surname: SerializedUserField.or(NonEmptyTextValue).optional()
-  }).optional(),
+  }).or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     name: NameConfig.default({
       firstname: { required: true },
@@ -2050,14 +2062,14 @@ var NameField = BaseField.extend({
   id: "NameField"
 });
 var PhoneField = BaseField.extend({
-  defaultValue: NonEmptyTextValue.optional(),
+  defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
   type: import_v43.default.literal(FieldType.PHONE)
 }).meta({
   description: "A field for entering a phone number",
   id: "PhoneField"
 });
 var IdField = BaseField.extend({
-  defaultValue: NonEmptyTextValue.optional(),
+  defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
   type: import_v43.default.literal(FieldType.ID)
 }).meta({
   description: "A field for entering an ID",
@@ -2065,14 +2077,14 @@ var IdField = BaseField.extend({
 });
 var Checkbox = BaseField.extend({
   type: import_v43.default.literal(FieldType.CHECKBOX),
-  defaultValue: CheckboxFieldValue.default(false)
+  defaultValue: CheckboxFieldValue.or(ComputedDefaultValue).default(false)
 }).meta({
   description: "A boolean checkbox field",
   id: "Checkbox"
 });
 var Country = BaseField.extend({
   type: import_v43.default.literal(FieldType.COUNTRY),
-  defaultValue: NonEmptyTextValue.optional(),
+  defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
   optionOverrides: import_v43.default.array(SelectOption.omit({ label: true })).optional().describe(
     "Conditionals for specific countries. Countries not listed are always shown and enabled."
   )
@@ -2090,7 +2102,7 @@ var AdministrativeAreas = import_v43.default.enum([
 ]);
 var AdministrativeAreaField = BaseField.extend({
   type: import_v43.default.literal(FieldType.ADMINISTRATIVE_AREA),
-  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
+  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
   configuration: import_v43.default.object({
     partOf: FieldReference.optional().describe("Parent location"),
     type: AdministrativeAreas,
@@ -2102,7 +2114,7 @@ var AdministrativeAreaField = BaseField.extend({
 });
 var LocationInput = BaseField.extend({
   type: import_v43.default.literal(FieldType.LOCATION),
-  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField]).optional(),
+  defaultValue: import_v43.default.union([NonEmptyTextValue, SerializedUserField, ComputedDefaultValue]).optional(),
   configuration: import_v43.default.object({
     locationTypes: import_v43.default.array(import_v43.default.string()).optional().describe("Types of the locations that are available for selection."),
     allowedLocations: AllowedLocations
@@ -2114,7 +2126,7 @@ var LocationInput = BaseField.extend({
 var FileUploadWithOptions = BaseField.extend({
   type: import_v43.default.literal(FieldType.FILE_WITH_OPTIONS),
   options: import_v43.default.array(SelectOption).describe("A list of options"),
-  defaultValue: FileFieldWithOptionValue.optional(),
+  defaultValue: FileFieldWithOptionValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     maxFileSize: import_v43.default.number().describe("Maximum file size in bytes").default(DEFAULT_MAX_FILE_SIZE_BYTES),
     maxImageSize: import_v43.default.object({
@@ -2130,12 +2142,12 @@ var FileUploadWithOptions = BaseField.extend({
 });
 var Facility = BaseField.extend({
   type: import_v43.default.literal(FieldType.FACILITY),
-  defaultValue: NonEmptyTextValue.optional(),
+  defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
 }).describe("Input field for a facility");
 var Office = BaseField.extend({
   type: import_v43.default.literal(FieldType.OFFICE),
-  defaultValue: NonEmptyTextValue.optional(),
+  defaultValue: NonEmptyTextValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({ allowedLocations: AllowedLocations }).optional()
 }).describe("Input field for an office");
 var DefaultAddressFieldValue = DomesticAddressFieldValue.extend({
@@ -2171,7 +2183,7 @@ var Address = BaseField.extend({
     ).optional(),
     allowedLocations: AllowedLocations
   }).optional(),
-  defaultValue: DefaultAddressFieldValue.optional()
+  defaultValue: DefaultAddressFieldValue.or(ComputedDefaultValue).optional()
 }).meta({
   description: "Address input field \u2013 a combination of location and text fields",
   id: "Address"
@@ -2218,7 +2230,7 @@ var ButtonConfiguration = import_v43.default.object({
 });
 var ButtonField = BaseField.extend({
   type: import_v43.default.literal(FieldType.BUTTON),
-  defaultValue: ButtonFieldValue.optional(),
+  defaultValue: ButtonFieldValue.or(ComputedDefaultValue).optional(),
   configuration: ButtonConfiguration
 }).meta({
   description: "A generic button that can be used to trigger an action",
@@ -2246,7 +2258,7 @@ var AlphaPrintButton = BaseField.extend({
 });
 var HttpField = BaseField.extend({
   type: import_v43.default.literal(FieldType.HTTP),
-  defaultValue: HttpFieldValue.optional(),
+  defaultValue: HttpFieldValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     trigger: FieldReference.optional().describe(
       "Reference to the field that triggers the HTTP request when its value changes. If not provided, the HTTP request is triggered once on component mount."
@@ -2332,7 +2344,7 @@ var LinkButtonField = BaseField.extend({
 });
 var VerificationStatus = BaseField.extend({
   type: import_v43.default.literal(FieldType.VERIFICATION_STATUS),
-  defaultValue: VerificationStatusValue.optional(),
+  defaultValue: VerificationStatusValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     status: TranslationConfig.describe("Text to display on the status pill."),
     description: TranslationConfig.describe(
@@ -2354,7 +2366,7 @@ var QueryParamReaderField = BaseField.extend({
 });
 var QrReaderField = BaseField.extend({
   type: import_v43.default.literal(FieldType.QR_READER),
-  defaultValue: QrReaderFieldValue.optional(),
+  defaultValue: QrReaderFieldValue.or(ComputedDefaultValue).optional(),
   configuration: import_v43.default.object({
     validator: import_v43.default.any().meta({
       description: "JSON Schema to validate the scanned QR code data against before populating the form fields.",
@@ -2367,7 +2379,7 @@ var QrReaderField = BaseField.extend({
 });
 var IdReaderField = BaseField.extend({
   type: import_v43.default.literal(FieldType.ID_READER),
-  defaultValue: IdReaderFieldValue.optional(),
+  defaultValue: IdReaderFieldValue.or(ComputedDefaultValue).optional(),
   methods: import_v43.default.array(
     import_v43.default.union([QrReaderField, LinkButtonField]).describe("Methods for reading an ID")
   )
@@ -3032,7 +3044,37 @@ function resolveDataPath(rootData, dataPath, instancePath) {
   }
   return current;
 }
+function todayISO() {
+  return (0, import_date_fns.formatISO)(/* @__PURE__ */ new Date(), { representation: "date" });
+}
+var compiledFunctionCache = /* @__PURE__ */ new Map();
+function compileClientFunction(code) {
+  let fn = compiledFunctionCache.get(code);
+  if (!fn) {
+    fn = new Function(`return (${code})`)();
+    compiledFunctionCache.set(code, fn);
+  }
+  return fn;
+}
 (0, import_ajv_formats.default)(ajv);
+function buildClientFunctionContext(input) {
+  return {
+    $form: input.form,
+    $now: todayISO(),
+    // eslint-disable-next-line @typescript-eslint/no-use-before-define
+    $online: isOnline(),
+    $user: input.validatorContext?.user,
+    $event: input.validatorContext?.event,
+    $leafAdminStructureLocationIds: input.validatorContext?.leafAdminStructureLocationIds ?? [],
+    user: input.systemVariables?.user,
+    $window: input.systemVariables?.$window,
+    locations: input.locations,
+    adminLevelIds: input.adminLevelIds
+  };
+}
+function runClientFunction(code, data, context) {
+  return compileClientFunction(code)(data, context);
+}
 ajv.addKeyword({
   keyword: "daysFromDate",
   type: "string",
@@ -3077,12 +3119,35 @@ ajv.addKeyword({
   $data: true,
   errors: true,
   // @ts-ignore -- Force type. We will move this away from AJV next. Parsing the array will take seconds and is only called by core.
-  validate(schema, data, _2, dataContext) {
+  validate(_schema, data, _2, dataContext) {
     const locationIdInput = data;
     const locations = dataContext?.rootData.$leafAdminStructureLocationIds ?? [];
     return locations.some((location) => location.id === locationIdInput);
   }
 });
+ajv.addKeyword({
+  keyword: "customClientValidator",
+  schemaType: "object",
+  errors: true,
+  // @ts-expect-error -- AJV's public types don't expose `rootData`. All
+  // `validate()` callers build root data via `buildClientFunctionContext`,
+  // so the cast holds.
+  validate(schema, data, _2, dataContext) {
+    return Boolean(
+      runClientFunction(
+        schema.code,
+        data,
+        dataContext?.rootData ?? buildClientFunctionContext({ form: {} })
+      )
+    );
+  }
+});
+function isOnline() {
+  if (typeof window !== "undefined" && typeof navigator !== "undefined") {
+    return navigator.onLine;
+  }
+  return true;
+}
 
 // ../commons/src/utils.ts
 var z32 = __toESM(require("zod/v4"));
@@ -3701,7 +3766,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
+      };
+    }
   };
 }
 
@@ -4469,7 +4581,8 @@ var RejectCorrectionActionInput = BaseActionInput.extend(
 var ApproveCorrectionActionInput = BaseActionInput.extend(
   z38.object({
     requestId: z38.string(),
-    type: z38.literal(ActionType.APPROVE_CORRECTION).default(ActionType.APPROVE_CORRECTION)
+    type: z38.literal(ActionType.APPROVE_CORRECTION).default(ActionType.APPROVE_CORRECTION),
+    content: z38.object({ immediateCorrection: z38.boolean().optional() }).optional()
   }).shape
 );
 var ReadActionInput = BaseActionInput.extend(

package/dist/scopes/index.js

@@ -354,14 +354,20 @@ var encodeScope = (scope) => {
     encode: false
   });
 };
+var decodedScopeCache = /* @__PURE__ */ new Map();
 var decodeScope = (query) => {
+  if (decodedScopeCache.has(query)) {
+    return decodedScopeCache.get(query);
+  }
   const scope = qs.parse(query, {
     ignoreQueryPrefix: true,
     comma: true,
     allowDots: true
   });
   const unflattenedScope = unflattenScope(scope);
-  return Scope2.safeParse(unflattenedScope)?.data;
+  const result = Scope2.safeParse(unflattenedScope)?.data;
+  decodedScopeCache.set(query, result);
+  return result;
 };
 var DEFAULT_SCOPE_OPTIONS = {
   placeOfEvent: JurisdictionFilter.enum.all,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencrvs/toolkit",
-  "version": "2.0.0-rc.fe35c20",
+  "version": "2.0.0-rc.fe577a4",
   "description": "OpenCRVS toolkit for building country configurations",
   "license": "MPL-2.0",
   "bin": {