@nira-opencrvs/toolkit 1.9.11-rc.39d8d68

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

@@ -0,0 +1,69 @@
+import { ClauseInput, DateRangeMatcherOptions, FuzzyMatcherOptions, StrictMatcherOptions } from '.';
+export declare function not(clause: ClauseInput): ClauseInput;
+export declare function and(...clauses: ClauseInput[]): ClauseInput;
+export declare function or(...clauses: ClauseInput[]): ClauseInput;
+export declare function field(fieldId: string): {
+    fuzzyMatches: (options?: FuzzyMatcherOptions) => {
+        fieldId: string;
+        type: "fuzzy";
+        options: {
+            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;
+            matchAgainst?: string | undefined;
+        } | 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
+    * })
+    */
+    dateRangeMatches: (options: DateRangeMatcherOptions) => {
+        fieldId: string;
+        type: "dateRange";
+        options: {
+            days: number;
+            boost?: number | undefined;
+            matchAgainst?: string | undefined;
+            pivot?: number | undefined;
+        };
+    };
+};
+//# sourceMappingURL=deduplication.d.ts.map

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

@@ -0,0 +1,234 @@
+import { EventConfigInput } from './EventConfigInput';
+/**
+ * Builds a validated configuration for an event
+ * @param config - Event specific configuration
+ */
+export declare const defineConfig: (config: EventConfigInput) => {
+    id: string;
+    title: import("./TranslationConfig").TranslationConfig;
+    declaration: {
+        label: import("./TranslationConfig").TranslationConfig;
+        pages: {
+            type: "FORM";
+            id: string;
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: import("./FieldConfig").FieldConfig[];
+            requireCompletionToContinue: boolean;
+            conditional?: import(".").JSONSchema | undefined;
+        }[];
+    };
+    actions: ({
+        type: "READ";
+        label: import("./TranslationConfig").TranslationConfig;
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: import("./FieldConfig").FieldConfig[];
+        };
+    } | {
+        type: "DECLARE";
+        label: import("./TranslationConfig").TranslationConfig;
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: import("./FieldConfig").FieldConfig[];
+        };
+        deduplication?: {
+            id: string;
+            query: import("./DeduplicationConfig").ClauseOutput;
+            label: import("./TranslationConfig").TranslationConfig;
+        } | undefined;
+    } | {
+        type: "VALIDATE";
+        label: import("./TranslationConfig").TranslationConfig;
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: import("./FieldConfig").FieldConfig[];
+        };
+        deduplication?: {
+            id: string;
+            query: import("./DeduplicationConfig").ClauseOutput;
+            label: import("./TranslationConfig").TranslationConfig;
+        } | undefined;
+    } | {
+        type: "REJECT";
+        label: import("./TranslationConfig").TranslationConfig;
+    } | {
+        type: "ARCHIVE";
+        label: import("./TranslationConfig").TranslationConfig;
+    } | {
+        type: "REGISTER";
+        label: import("./TranslationConfig").TranslationConfig;
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: import("./FieldConfig").FieldConfig[];
+        };
+        deduplication?: {
+            id: string;
+            query: import("./DeduplicationConfig").ClauseOutput;
+            label: import("./TranslationConfig").TranslationConfig;
+        } | undefined;
+    } | {
+        type: "DELETE";
+        label: import("./TranslationConfig").TranslationConfig;
+    } | {
+        type: "PRINT_CERTIFICATE";
+        label: import("./TranslationConfig").TranslationConfig;
+        printForm: {
+            label: import("./TranslationConfig").TranslationConfig;
+            pages: ({
+                type: "FORM";
+                id: string;
+                title: import("./TranslationConfig").TranslationConfig;
+                fields: import("./FieldConfig").FieldConfig[];
+                requireCompletionToContinue: boolean;
+                conditional?: import(".").JSONSchema | undefined;
+            } | {
+                type: "VERIFICATION";
+                id: string;
+                title: import("./TranslationConfig").TranslationConfig;
+                actions: {
+                    cancel: {
+                        label: import("./TranslationConfig").TranslationConfig;
+                        confirmation: {
+                            title: import("./TranslationConfig").TranslationConfig;
+                            body: import("./TranslationConfig").TranslationConfig;
+                        };
+                    };
+                    verify: {
+                        label: import("./TranslationConfig").TranslationConfig;
+                    };
+                };
+                fields: import("./FieldConfig").FieldConfig[];
+                requireCompletionToContinue: boolean;
+                conditional?: import(".").JSONSchema | undefined;
+            })[];
+        };
+    } | {
+        type: "REQUEST_CORRECTION";
+        label: import("./TranslationConfig").TranslationConfig;
+        correctionForm: {
+            label: import("./TranslationConfig").TranslationConfig;
+            pages: ({
+                type: "FORM";
+                id: string;
+                title: import("./TranslationConfig").TranslationConfig;
+                fields: import("./FieldConfig").FieldConfig[];
+                requireCompletionToContinue: boolean;
+                conditional?: import(".").JSONSchema | undefined;
+            } | {
+                type: "VERIFICATION";
+                id: string;
+                title: import("./TranslationConfig").TranslationConfig;
+                actions: {
+                    cancel: {
+                        label: import("./TranslationConfig").TranslationConfig;
+                        confirmation: {
+                            title: import("./TranslationConfig").TranslationConfig;
+                            body: import("./TranslationConfig").TranslationConfig;
+                        };
+                    };
+                    verify: {
+                        label: import("./TranslationConfig").TranslationConfig;
+                    };
+                };
+                fields: import("./FieldConfig").FieldConfig[];
+                requireCompletionToContinue: boolean;
+                conditional?: import(".").JSONSchema | undefined;
+            })[];
+        };
+    } | {
+        type: "REJECT_CORRECTION";
+        label: import("./TranslationConfig").TranslationConfig;
+    } | {
+        type: "APPROVE_CORRECTION";
+        label: import("./TranslationConfig").TranslationConfig;
+    })[];
+    label: import("./TranslationConfig").TranslationConfig;
+    summary: {
+        fields: ({
+            fieldId: string;
+            label?: import("./TranslationConfig").TranslationConfig | undefined;
+            conditionals?: {
+                type: "SHOW";
+                conditional: import(".").JSONSchema;
+            }[] | undefined;
+            emptyValueMessage?: import("./TranslationConfig").TranslationConfig | undefined;
+        } | {
+            id: string;
+            value: import("./TranslationConfig").TranslationConfig;
+            label: import("./TranslationConfig").TranslationConfig;
+            conditionals?: {
+                type: "SHOW";
+                conditional: import(".").JSONSchema;
+            }[] | undefined;
+            emptyValueMessage?: import("./TranslationConfig").TranslationConfig | undefined;
+        })[];
+    };
+    advancedSearch: {
+        title: import("./TranslationConfig").TranslationConfig;
+        fields: ({
+            config: {
+                type: "exact" | "fuzzy" | "range" | "within";
+                searchFields?: string[] | undefined;
+            };
+            fieldId: string;
+            fieldType: "field";
+            type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "NUMBER_WITH_UNIT" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
+            options?: {
+                value: string;
+                label: string | import("./TranslationConfig").TranslationConfig;
+            }[] | undefined;
+            label?: import("./TranslationConfig").TranslationConfig | undefined;
+            conditionals?: ({
+                type: "SHOW";
+                conditional: import(".").JSONSchema;
+            } | {
+                type: "ENABLE";
+                conditional: import(".").JSONSchema;
+            } | {
+                type: "DISPLAY_ON_REVIEW";
+                conditional: import(".").JSONSchema;
+            })[] | undefined;
+            searchCriteriaLabelPrefix?: import("./TranslationConfig").TranslationConfig | undefined;
+            validations?: {
+                message: import("./TranslationConfig").TranslationConfig;
+                validator: import(".").JSONSchema;
+            }[] | undefined;
+        } | {
+            config: {
+                type: "exact" | "fuzzy" | "range" | "within";
+                searchFields?: string[] | undefined;
+            };
+            fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
+            fieldType: "event";
+            type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "NUMBER_WITH_UNIT" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER" | undefined;
+            options?: {
+                value: string;
+                label: string | import("./TranslationConfig").TranslationConfig;
+            }[] | undefined;
+            label?: import("./TranslationConfig").TranslationConfig | undefined;
+            conditionals?: ({
+                type: "SHOW";
+                conditional: import(".").JSONSchema;
+            } | {
+                type: "ENABLE";
+                conditional: import(".").JSONSchema;
+            } | {
+                type: "DISPLAY_ON_REVIEW";
+                conditional: import(".").JSONSchema;
+            })[] | undefined;
+            searchCriteriaLabelPrefix?: import("./TranslationConfig").TranslationConfig | undefined;
+            validations?: {
+                message: import("./TranslationConfig").TranslationConfig;
+                validator: import(".").JSONSchema;
+            }[] | undefined;
+        })[];
+    }[];
+    dateOfEvent?: {
+        $$field: string;
+        $$subfield: string[];
+    } | {
+        $$event: "createdAt" | "updatedAt" | "legalStatuses.DECLARED.createdAt" | "legalStatuses.DECLARED.acceptedAt" | "legalStatuses.REGISTERED.createdAt" | "legalStatuses.REGISTERED.acceptedAt";
+    } | undefined;
+    fallbackTitle?: import("./TranslationConfig").TranslationConfig | undefined;
+};
+//# sourceMappingURL=defineConfig.d.ts.map

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

@@ -0,0 +1,80 @@
+import { NonSearchableEventMetadataTimeFieldIdInput, AdvancedSearchConfig } from '../event-config/event-configuration';
+import { ActionType } from './ActionType';
+import { EventFieldIdInput } from './AdvancedSearchConfig';
+import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConfig';
+/**
+ * Creates a function that acts like a callable + static method container.
+ *
+ * @example
+ * event('status') // → returns search config
+ * event.hasAction('CLICKED') // → returns conditional
+ */
+declare function eventFn(fieldId: EventFieldIdInput): AdvancedSearchConfig;
+declare function eventFn(fieldId: NonSearchableEventMetadataTimeFieldIdInput): {
+    $$event: NonSearchableEventMetadataTimeFieldIdInput;
+};
+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) => {
+        /**
+         * 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;
+        };
+        $id: string;
+        __nominal__type: "JSONSchema";
+    };
+    field(field: WorkqueueColumnKeys): WorkqueueColumnValue;
+};
+export { event };
+//# sourceMappingURL=event.d.ts.map