@opencrvs/toolkit 1.9.8-rc.d187100 → 1.9.8-rc.f0948d3

package/dist/conditionals/index.js

@@ -509,7 +509,7 @@ function createFieldConditionals(fieldId) {
     },
     /**
      * Use case: Some fields are rendered when selection is not made, or boolean false is explicitly selected.
-     * @example field('recommender.none').isFalsy() vs not(field('recommender.none').isEqualTo(true))
+     * @example event.declaration('recommender.none').isFalsy() vs not(event.declaration('recommender.none').isEqualTo(true))
      * @returns whether the field is falsy (undefined, false, null, empty string)
      *
      * NOTE: For now, this only works with string, boolean, and null types. 0 is still allowed.
@@ -657,11 +657,11 @@ function createFieldConditionals(fieldId) {
     getId: () => ({ fieldId }),
     /**
      * @deprecated
-     * use field(fieldId).get(nestedProperty) instead
+     * use event.declaration(fieldId).get(nestedProperty) instead
      * with 'and' combinator e.g.
      * and(
-     *   field('child.name').get('firstname').isEqualTo('John'),
-     *   field('child.name').get('surname').isEqualTo('Doe')
+     *   event.declaration('child.name').get('firstname').isEqualTo('John'),
+     *   event.declaration('child.name').get('surname').isEqualTo('Doe')
      * )
      */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/events/deduplication.d.ts

@@ -22,39 +22,39 @@ export declare function field(fieldId: string): {
         } | undefined;
     };
     /**
-    * Creates a date range matcher that finds records where date field 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 against that field 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 field to match against. When provided,
-    * the query matches if the field fall within the date range. The default field is always excluded in the search in that case.
-    *
-    * @returns A clause that matches records where at least one of the specified date field 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')
-    * })
-    *
-    * @example
-    * // With custom pivot and boost
-    * field('mother.dob').dateRangeMatches({
-    *   days: 730,
-    *   pivot: 365,
-    *   boost: 2
-    * })
-    */
+     * Creates a date range matcher that finds records where date field fall within a specified range.
+     *
+     * By default, matches against the field specified in `event.declaration()` (e.g., 'mother.dob').
+     * When `matchAgainst` is provided, it overwrites the default field and searches against that field 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 field to match against. When provided,
+     * the query matches if the field fall within the date range. The default field is always excluded in the search in that case.
+     *
+     * @returns A clause that matches records where at least one of the specified date field is within the range
+     *
+     * @example
+     * // Matches only against mother.dob (±365 days)
+     * event.declaration('mother.dob').dateRangeMatches({ days: 365 })
+     *
+     * @example
+     * // Matches against mother.age OR spouse.dob, not mother.dob
+     * event.declaration('mother.dob').dateRangeMatches({
+     *   days: 365,
+     *   matchAgainst: $event.declaration('mother.age')
+     * })
+     *
+     * @example
+     * // With custom pivot and boost
+     * event.declaration('mother.dob').dateRangeMatches({
+     *   days: 730,
+     *   pivot: 365,
+     *   boost: 2
+     * })
+     */
     dateRangeMatches: (options: DateRangeMatcherOptions) => {
         fieldId: string;
         type: "dateRange";

package/dist/events/deduplication.js

@@ -59,39 +59,39 @@ function field(fieldId) {
       options
     }),
     /**
-    * Creates a date range matcher that finds records where date field 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 against that field 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 field to match against. When provided,
-    * the query matches if the field fall within the date range. The default field is always excluded in the search in that case.
-    *
-    * @returns A clause that matches records where at least one of the specified date field 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')
-    * })
-    *
-    * @example
-    * // With custom pivot and boost
-    * field('mother.dob').dateRangeMatches({
-    *   days: 730,
-    *   pivot: 365,
-    *   boost: 2
-    * })
-    */
+     * Creates a date range matcher that finds records where date field fall within a specified range.
+     *
+     * By default, matches against the field specified in `event.declaration()` (e.g., 'mother.dob').
+     * When `matchAgainst` is provided, it overwrites the default field and searches against that field 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 field to match against. When provided,
+     * the query matches if the field fall within the date range. The default field is always excluded in the search in that case.
+     *
+     * @returns A clause that matches records where at least one of the specified date field is within the range
+     *
+     * @example
+     * // Matches only against mother.dob (±365 days)
+     * event.declaration('mother.dob').dateRangeMatches({ days: 365 })
+     *
+     * @example
+     * // Matches against mother.age OR spouse.dob, not mother.dob
+     * event.declaration('mother.dob').dateRangeMatches({
+     *   days: 365,
+     *   matchAgainst: $event.declaration('mother.age')
+     * })
+     *
+     * @example
+     * // With custom pivot and boost
+     * event.declaration('mother.dob').dateRangeMatches({
+     *   days: 730,
+     *   pivot: 365,
+     *   boost: 2
+     * })
+     */
     dateRangeMatches: (options) => ({
       fieldId,
       type: "dateRange",