@opencrvs/toolkit 1.8.1-rc.38ac682 → 1.8.1-rc.3a45fd9

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

@@ -1,5 +1,5 @@
 import { ActionType } from './ActionType';
-import { EventFieldId } from './AdvancedSearchConfig';
+import { EventFieldIdInput } from './AdvancedSearchConfig';
 import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConfig';
 /**
  * Creates a function that acts like a callable + static method container.
@@ -8,9 +8,9 @@ import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConf
  * event('status') // → returns search config
  * event.hasAction('CLICKED') // → returns conditional
  */
-declare function eventFn(fieldId: EventFieldId): {
+declare function eventFn(fieldId: EventFieldIdInput): {
     range: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
+        fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
         fieldType: "event";
     } & {
         config: {
@@ -18,7 +18,7 @@ declare function eventFn(fieldId: EventFieldId): {
         };
     };
     exact: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
+        fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
         fieldType: "event";
     } & {
         config: {
@@ -26,20 +26,82 @@ declare function eventFn(fieldId: EventFieldId): {
         };
     };
     fuzzy: () => {
-        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatuses.REGISTERED.acceptedAt" | "legalStatuses.REGISTERED.createdAtLocation";
+        fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
         fieldType: "event";
     } & {
         config: {
             type: "fuzzy";
         };
     };
+    within: () => {
+        fieldId: "event.status" | "event.updatedAt" | "event.trackingId" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldType: "event";
+    } & {
+        config: {
+            type: "within";
+        };
+    };
 };
 declare const event: typeof eventFn & {
     /**
      * Checks if the event contains a specific action type.
+     * Can be used directly as a conditional or chained with additional methods.
      * @param action - The action type to check for.
      */
-    hasAction: (action: ActionType) => import("../conditionals/conditionals").JSONSchema;
+    hasAction: (action: ActionType) => {
+        /**
+         * Creates a conditional that checks if the event contains a specific action type
+         * with a minimum count of occurrences.
+         *
+         * @param minCount - The minimum number of actions required.
+         */
+        minCount: (minCount: number) => import("../conditionals/conditionals").JSONSchema;
+        /**
+         * Builds a conditional that sets a maximum count for the number of actions.
+         * This is useful for limiting the number of actions of a specific type in a single event.
+         */
+        maxCount: (maxCount: number) => import("../conditionals/conditionals").JSONSchema;
+        /**
+         * Adds additional field constraints to the action matching.
+         *
+         * @param fields - Object containing additional fields to match on the action.
+         */
+        withFields: (fields: Record<string, unknown>) => {
+            /**
+             * Creates a conditional that checks if the event contains a specific action type
+             * with a minimum count of occurrences.
+             *
+             * @param minCount - The minimum number of actions required.
+             */
+            minCount: (minCount: number) => import("../conditionals/conditionals").JSONSchema;
+            /**
+             * Builds a conditional that sets a maximum count for the number of actions.
+             * This is useful for limiting the number of actions of a specific type in a single event.
+             */
+            maxCount: (maxCount: number) => import("../conditionals/conditionals").JSONSchema;
+        };
+        /**
+         * Adds template ID constraint to the action matching.
+         * This is a convenience method that adds content.templateId to the fields.
+         *
+         * @param id - The template ID to match against.
+         */
+        withTemplate: (id: string) => {
+            /**
+             * Creates a conditional that checks if the event contains a specific action type
+             * with a minimum count of occurrences.
+             *
+             * @param minCount - The minimum number of actions required.
+             */
+            minCount: (minCount: number) => import("../conditionals/conditionals").JSONSchema;
+            /**
+             * Builds a conditional that sets a maximum count for the number of actions.
+             * This is useful for limiting the number of actions of a specific type in a single event.
+             */
+            maxCount: (maxCount: number) => import("../conditionals/conditionals").JSONSchema;
+        };
+        __nominal__type: "JSONSchema";
+    };
     field(field: WorkqueueColumnKeys): WorkqueueColumnValue;
 };
 export { event };

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

@@ -56,6 +56,20 @@ export declare function field(fieldId: string, options?: {
             type: "fuzzy";
         };
     };
+    within: () => {
+        options?: SelectOption[];
+        excludeInSearchQuery?: boolean;
+        alternateFieldIds?: string[];
+        conditionals?: FieldConditional[];
+        validations?: ValidationConfig[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "within";
+        };
+    };
     $$field: string;
     isAfter: () => {
         days: (days: number) => {

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

@@ -67,8 +67,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
+                firstname: string;
+                surname: string;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -123,8 +123,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
+                firstname: string;
+                surname: string;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -173,8 +173,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
+                firstname: string;
+                surname: string;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -240,8 +240,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
+                firstname: string;
+                surname: string;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -309,8 +309,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                 street?: string | null | undefined;
                 zipCode?: string | null | undefined;
             } | {
-                firstname?: string | null | undefined;
-                surname?: string | null | undefined;
+                firstname: string;
+                surname: string;
                 middlename?: string | null | undefined;
             } | {
                 country: string;
@@ -372,8 +372,8 @@ export declare function eventPayloadGenerator(rng: () => number): {
                     street?: string | null | undefined;
                     zipCode?: string | null | undefined;
                 } | {
-                    firstname?: string | null | undefined;
-                    surname?: string | null | undefined;
+                    firstname: string;
+                    surname: string;
                     middlename?: string | null | undefined;
                 } | {
                     country: string;