@opencrvs/toolkit 1.9.6-rc.92becff → 1.9.6-rc.9a9f99f

package/dist/commons/conditionals/conditionals.d.ts

@@ -4,6 +4,7 @@ import { ITokenPayload as TokenPayload, Scope } from '../authentication';
 import { PartialSchema as AjvJSONSchemaType } from 'ajv/dist/types/json-schema';
 import { userSerializer } from '../events/serializers/user/serializer';
 import { UUID } from '../uuid';
+import { todayDateTimeValueSerializer } from '../events/serializers/date/serializer';
 /** @knipignore */
 export type JSONSchema = {
     $id: string;
@@ -64,6 +65,10 @@ type FieldReference = {
     $$field: string;
     $$subfield: string[];
 };
+/**
+ * Generate conditional rules for current date
+ */
+export declare const now: typeof todayDateTimeValueSerializer;
 /**
  *
  * Generate conditional rules for user.

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

@@ -10,10 +10,13 @@ declare const FuzzyMatcher: z.ZodObject<z.objectUtil.extendShape<{
     fieldId: z.ZodString;
     options: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         boost: z.ZodOptional<z.ZodNumber>;
+        matchAgainst: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
     }, {
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
     }>>>;
 }, {
     type: z.ZodLiteral<"fuzzy">;
@@ -25,11 +28,14 @@ declare const FuzzyMatcher: z.ZodObject<z.objectUtil.extendShape<{
          */
         fuzziness: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>;
         boost: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        matchAgainst: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         boost: number;
         fuzziness: string | number;
+        matchAgainst?: string | undefined;
     }, {
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
         fuzziness?: string | number | undefined;
     }>>>;
 }>, "strip", z.ZodTypeAny, {
@@ -37,6 +43,7 @@ declare const FuzzyMatcher: z.ZodObject<z.objectUtil.extendShape<{
     options: {
         boost: number;
         fuzziness: string | number;
+        matchAgainst?: string | undefined;
     };
     fieldId: string;
 }, {
@@ -44,6 +51,7 @@ declare const FuzzyMatcher: z.ZodObject<z.objectUtil.extendShape<{
     fieldId: string;
     options?: {
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
         fuzziness?: string | number | undefined;
     } | undefined;
 }>;
@@ -58,10 +66,13 @@ declare const StrictMatcher: z.ZodObject<z.objectUtil.extendShape<{
     fieldId: z.ZodString;
     options: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         boost: z.ZodOptional<z.ZodNumber>;
+        matchAgainst: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
     }, {
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
     }>>>;
 }, {
     type: z.ZodLiteral<"strict">;
@@ -71,18 +82,22 @@ declare const StrictMatcher: z.ZodObject<z.objectUtil.extendShape<{
          * The constant value to be present in the field for both records
          */
         value: z.ZodOptional<z.ZodString>;
+        matchAgainst: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         boost: number;
         value?: string | undefined;
+        matchAgainst?: string | undefined;
     }, {
         value?: string | undefined;
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
     }>>>;
 }>, "strip", z.ZodTypeAny, {
     type: "strict";
     options: {
         boost: number;
         value?: string | undefined;
+        matchAgainst?: string | undefined;
     };
     fieldId: string;
 }, {
@@ -91,6 +106,7 @@ declare const StrictMatcher: z.ZodObject<z.objectUtil.extendShape<{
     options?: {
         value?: string | undefined;
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
     } | undefined;
 }>;
 export type StrictMatcherOptions = z.input<typeof StrictMatcher>['options'];
@@ -104,10 +120,13 @@ declare const DateRangeMatcher: z.ZodObject<z.objectUtil.extendShape<{
     fieldId: z.ZodString;
     options: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         boost: z.ZodOptional<z.ZodNumber>;
+        matchAgainst: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
     }, {
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
     }>>>;
 }, {
     type: z.ZodLiteral<"dateRange">;
@@ -119,13 +138,16 @@ declare const DateRangeMatcher: z.ZodObject<z.objectUtil.extendShape<{
         pivot: z.ZodOptional<z.ZodNumber>;
         days: z.ZodNumber;
         boost: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        matchAgainst: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         boost: number;
         days: number;
+        matchAgainst?: string | undefined;
         pivot?: number | undefined;
     }, {
         days: number;
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
         pivot?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
@@ -133,6 +155,7 @@ declare const DateRangeMatcher: z.ZodObject<z.objectUtil.extendShape<{
     options: {
         boost: number;
         days: number;
+        matchAgainst?: string | undefined;
         pivot?: number | undefined;
     };
     fieldId: string;
@@ -141,6 +164,7 @@ declare const DateRangeMatcher: z.ZodObject<z.objectUtil.extendShape<{
     options: {
         days: number;
         boost?: number | undefined;
+        matchAgainst?: string | undefined;
         pivot?: number | undefined;
     };
     fieldId: string;

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

@@ -1768,7 +1768,13 @@ declare const DateField: z.ZodObject<z.objectUtil.extendShape<{
     analytics: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
 }, {
     type: z.ZodLiteral<"DATE">;
-    defaultValue: z.ZodOptional<z.ZodString>;
+    defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        $$now: z.ZodLiteral<true>;
+    }, "strip", z.ZodTypeAny, {
+        $$now: true;
+    }, {
+        $$now: true;
+    }>, z.ZodString]>>;
     configuration: z.ZodOptional<z.ZodObject<{
         notice: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
             id: string;
@@ -1825,7 +1831,9 @@ declare const DateField: z.ZodObject<z.objectUtil.extendShape<{
     hideLabel?: boolean | undefined;
     uncorrectable?: boolean | undefined;
     analytics?: boolean | undefined;
-    defaultValue?: string | undefined;
+    defaultValue?: string | {
+        $$now: true;
+    } | undefined;
     configuration?: {
         notice?: TranslationConfig | undefined;
     } | undefined;
@@ -1890,7 +1898,9 @@ declare const DateField: z.ZodObject<z.objectUtil.extendShape<{
     hideLabel?: boolean | undefined;
     uncorrectable?: boolean | undefined;
     analytics?: boolean | undefined;
-    defaultValue?: string | undefined;
+    defaultValue?: string | {
+        $$now: true;
+    } | undefined;
     configuration?: {
         notice?: {
             id: string;
@@ -2265,7 +2275,13 @@ declare const TimeField: z.ZodObject<z.objectUtil.extendShape<{
     analytics: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
 }, {
     type: z.ZodLiteral<"TIME">;
-    defaultValue: z.ZodOptional<z.ZodString>;
+    defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
+        $$now: z.ZodLiteral<true>;
+    }, "strip", z.ZodTypeAny, {
+        $$now: true;
+    }, {
+        $$now: true;
+    }>, z.ZodString]>>;
     configuration: z.ZodOptional<z.ZodObject<{
         use12HourFormat: z.ZodOptional<z.ZodBoolean>;
         notice: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
@@ -2325,7 +2341,9 @@ declare const TimeField: z.ZodObject<z.objectUtil.extendShape<{
     hideLabel?: boolean | undefined;
     uncorrectable?: boolean | undefined;
     analytics?: boolean | undefined;
-    defaultValue?: string | undefined;
+    defaultValue?: string | {
+        $$now: true;
+    } | undefined;
     configuration?: {
         notice?: TranslationConfig | undefined;
         use12HourFormat?: boolean | undefined;
@@ -2391,7 +2409,9 @@ declare const TimeField: z.ZodObject<z.objectUtil.extendShape<{
     hideLabel?: boolean | undefined;
     uncorrectable?: boolean | undefined;
     analytics?: boolean | undefined;
-    defaultValue?: string | undefined;
+    defaultValue?: string | {
+        $$now: true;
+    } | undefined;
     configuration?: {
         notice?: {
             id: string;

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

@@ -230,6 +230,15 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
 }, {
     data?: any;
 }>>> | z.ZodObject<{
+    numericValue: z.ZodNumber;
+    unit: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    numericValue: number;
+    unit: string;
+}, {
+    numericValue: number;
+    unit: string;
+}> | z.ZodObject<{
     numericValue: z.ZodOptional<z.ZodNumber>;
     unit: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
@@ -239,6 +248,15 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
     numericValue?: number | undefined;
     unit?: string | undefined;
 }> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    numericValue: z.ZodNumber;
+    unit: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    numericValue: number;
+    unit: string;
+}, {
+    numericValue: number;
+    unit: string;
+}>>> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
     numericValue: z.ZodOptional<z.ZodNumber>;
     unit: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {

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

@@ -38,6 +38,7 @@ export declare const AgeUpdateValue: z.ZodNullable<z.ZodOptional<z.ZodObject<{
     asOfDateRef: string;
 }>>>;
 export declare const TimeValue: z.ZodString;
+export type TimeValue = z.infer<typeof TimeValue>;
 export declare const DatetimeValue: z.ZodString;
 export declare const SelectDateRangeValue: z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>;
 export declare const DateRangeFieldValue: z.ZodUnion<[z.ZodObject<{

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

@@ -8,6 +8,7 @@ export declare function field(fieldId: string): {
         type: "fuzzy";
         options: {
             boost?: number | undefined;
+            matchAgainst?: string | undefined;
             fuzziness?: string | number | undefined;
         } | undefined;
     };
@@ -17,14 +18,57 @@ export declare function field(fieldId: string): {
         options: {
             value?: string | undefined;
             boost?: number | undefined;
+            matchAgainst?: string | undefined;
         } | undefined;
     };
+    /**
+     * Creates a date range matcher that finds records where date fields fall within a specified range.
+     *
+     * By default, matches against the field specified in `field()` (e.g., 'mother.dob').
+     * When `matchAgainst` is provided, it overwrites the default field and searches across multiple fields with OR logic .
+     *
+     * @param options - Configuration for the date range matching
+     * @param options.days - Number of days before and after the target date to search (creates a ±days range)
+     * @param options.pivot - Optional. Distance in days where relevance scoring drops by 50%. Defaults to ⌊(days * 2) / 3⌋
+     * @param options.boost - Optional. Scoring boost multiplier for matching results. Defaults to 1
+     * @param options.matchAgainst - Optional. Additional fields to match against. When provided,
+     * the query matches if any of these fields fall within the date range. The default field is always excluded in the search in that case.
+     * If you want to add the default field, you have to explicitly add that field in `matchAgainst` option
+     *
+     * @returns A clause that matches records where at least one of the specified date fields is within the range
+     *
+     * @example
+     * // Matches only against mother.dob (±365 days)
+     * field('mother.dob').dateRangeMatches({ days: 365 })
+     *
+     * @example
+     * // Matches against mother.age OR spouse.dob, not mother.dob
+     * field('mother.dob').dateRangeMatches({
+     *   days: 365,
+     *   matchAgainst: [$field('mother.age'), $field('spouse.dob')]
+     * })
+     *
+     * If you want to add mother.dob, then
+     * field('mother.dob').dateRangeMatches({
+     *   days: 365,
+     *   matchAgainst: [$field('mother.age'), $field('spouse.dob'), $field('mother.dob')]
+     * })
+     *
+     * @example
+     * // With custom pivot and boost
+     * field('mother.dob').dateRangeMatches({
+     *   days: 730,
+     *   pivot: 365,
+     *   boost: 2
+     * })
+     */
     dateRangeMatches: (options: DateRangeMatcherOptions) => {
         fieldId: string;
         type: "dateRange";
         options: {
             days: number;
             boost?: number | undefined;
+            matchAgainst?: string | undefined;
             pivot?: number | undefined;
         };
     };

package/dist/conditionals/index.js

@@ -38,6 +38,7 @@ __export(conditionals_exports, {
   isFieldReference: () => isFieldReference,
   never: () => never,
   not: () => not,
+  now: () => now,
   or: () => or,
   user: () => user
 });
@@ -106,6 +107,15 @@ function omitKeyDeep(obj, keyToRemove) {
   return newObj;
 }
 
+// ../commons/src/events/serializers/date/serializer.ts
+var import_zod2 = require("zod");
+var SerializedNowDateTime = import_zod2.z.object({
+  $$now: import_zod2.z.literal(true)
+});
+function todayDateTimeValueSerializer() {
+  return { $$now: true };
+}
+
 // ../commons/src/conditionals/conditionals.ts
 function defineConditional(schema) {
   const schemaWithooutIDRef = omitKeyDeep(schema, "$id");
@@ -179,6 +189,7 @@ function wrapToPathOptional(condition, path) {
     };
   }, condition);
 }
+var now = Object.assign(todayDateTimeValueSerializer, {});
 var user = Object.assign(userSerializer, {
   hasScope: (scope) => defineConditional({
     type: "object",

package/dist/events/deduplication.d.ts

@@ -8,6 +8,7 @@ export declare function field(fieldId: string): {
         type: "fuzzy";
         options: {
             boost?: number | undefined;
+            matchAgainst?: string | undefined;
             fuzziness?: string | number | undefined;
         } | undefined;
     };
@@ -17,14 +18,57 @@ export declare function field(fieldId: string): {
         options: {
             value?: string | undefined;
             boost?: number | undefined;
+            matchAgainst?: string | undefined;
         } | undefined;
     };
+    /**
+     * Creates a date range matcher that finds records where date fields fall within a specified range.
+     *
+     * By default, matches against the field specified in `field()` (e.g., 'mother.dob').
+     * When `matchAgainst` is provided, it overwrites the default field and searches across multiple fields with OR logic .
+     *
+     * @param options - Configuration for the date range matching
+     * @param options.days - Number of days before and after the target date to search (creates a ±days range)
+     * @param options.pivot - Optional. Distance in days where relevance scoring drops by 50%. Defaults to ⌊(days * 2) / 3⌋
+     * @param options.boost - Optional. Scoring boost multiplier for matching results. Defaults to 1
+     * @param options.matchAgainst - Optional. Additional fields to match against. When provided,
+     * the query matches if any of these fields fall within the date range. The default field is always excluded in the search in that case.
+     * If you want to add the default field, you have to explicitly add that field in `matchAgainst` option
+     *
+     * @returns A clause that matches records where at least one of the specified date fields is within the range
+     *
+     * @example
+     * // Matches only against mother.dob (±365 days)
+     * field('mother.dob').dateRangeMatches({ days: 365 })
+     *
+     * @example
+     * // Matches against mother.age OR spouse.dob, not mother.dob
+     * field('mother.dob').dateRangeMatches({
+     *   days: 365,
+     *   matchAgainst: [$field('mother.age'), $field('spouse.dob')]
+     * })
+     *
+     * If you want to add mother.dob, then
+     * field('mother.dob').dateRangeMatches({
+     *   days: 365,
+     *   matchAgainst: [$field('mother.age'), $field('spouse.dob'), $field('mother.dob')]
+     * })
+     *
+     * @example
+     * // With custom pivot and boost
+     * field('mother.dob').dateRangeMatches({
+     *   days: 730,
+     *   pivot: 365,
+     *   boost: 2
+     * })
+     */
     dateRangeMatches: (options: DateRangeMatcherOptions) => {
         fieldId: string;
         type: "dateRange";
         options: {
             days: number;
             boost?: number | undefined;
+            matchAgainst?: string | undefined;
             pivot?: number | undefined;
         };
     };

package/dist/events/deduplication.js

@@ -58,6 +58,47 @@ function field(fieldId) {
       type: "strict",
       options
     }),
+    /**
+     * Creates a date range matcher that finds records where date fields fall within a specified range.
+     *
+     * By default, matches against the field specified in `field()` (e.g., 'mother.dob').
+     * When `matchAgainst` is provided, it overwrites the default field and searches across multiple fields with OR logic .
+     *
+     * @param options - Configuration for the date range matching
+     * @param options.days - Number of days before and after the target date to search (creates a ±days range)
+     * @param options.pivot - Optional. Distance in days where relevance scoring drops by 50%. Defaults to ⌊(days * 2) / 3⌋
+     * @param options.boost - Optional. Scoring boost multiplier for matching results. Defaults to 1
+     * @param options.matchAgainst - Optional. Additional fields to match against. When provided,
+     * the query matches if any of these fields fall within the date range. The default field is always excluded in the search in that case.
+     * If you want to add the default field, you have to explicitly add that field in `matchAgainst` option
+     *
+     * @returns A clause that matches records where at least one of the specified date fields is within the range
+     *
+     * @example
+     * // Matches only against mother.dob (±365 days)
+     * field('mother.dob').dateRangeMatches({ days: 365 })
+     *
+     * @example
+     * // Matches against mother.age OR spouse.dob, not mother.dob
+     * field('mother.dob').dateRangeMatches({
+     *   days: 365,
+     *   matchAgainst: [$field('mother.age'), $field('spouse.dob')]
+     * })
+     *
+     * If you want to add mother.dob, then
+     * field('mother.dob').dateRangeMatches({
+     *   days: 365,
+     *   matchAgainst: [$field('mother.age'), $field('spouse.dob'), $field('mother.dob')]
+     * })
+     *
+     * @example
+     * // With custom pivot and boost
+     * field('mother.dob').dateRangeMatches({
+     *   days: 730,
+     *   pivot: 365,
+     *   boost: 2
+     * })
+     */
     dateRangeMatches: (options) => ({
       fieldId,
       type: "dateRange",