npm - @opencrvs/toolkit - Versions diffs - 1.9.2-rc.cb144d0 → 1.9.2-rc.f1d7235 - Mend

@opencrvs/toolkit 1.9.2-rc.cb144d0 → 1.9.2-rc.f1d7235

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

package/dist/commons/api/router.d.ts +495 -50
package/dist/commons/events/ActionConfig.d.ts +390 -0
package/dist/commons/events/AdvancedSearchConfig.d.ts +11 -0
package/dist/commons/events/EventConfig.d.ts +319 -0
package/dist/commons/events/EventIndex.d.ts +1 -0
package/dist/commons/events/EventMetadata.d.ts +3 -1
package/dist/commons/events/FieldConfig.d.ts +80 -0
package/dist/commons/events/FieldType.d.ts +2 -1
package/dist/commons/events/FieldTypeMapping.d.ts +8 -1
package/dist/commons/events/FieldValue.d.ts +2 -1
package/dist/commons/events/FormConfig.d.ts +234 -0
package/dist/commons/events/PageConfig.d.ts +156 -0
package/dist/commons/events/WorkqueueColumnConfig.d.ts +5 -2
package/dist/commons/events/WorkqueueConfig.d.ts +5 -3
package/dist/commons/events/defineConfig.d.ts +447 -3
package/dist/commons/events/event.d.ts +4 -4
package/dist/commons/events/state/index.d.ts +6 -0
package/dist/commons/events/utils.d.ts +888 -3
package/dist/events/index.js +93 -4
package/dist/notification/index.js +34 -3
package/package.json +1 -1

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

@@ -2589,6 +2589,61 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 $$subfield?: string[] | undefined;
             }[] | undefined;
             analytics?: boolean | undefined;
+        } | {
+            id: string;
+            label: {
+                id: string;
+                defaultMessage: string;
+                description: string;
+            };
+            type: "HIDDEN";
+            parent?: {
+                $$field: string;
+                $$subfield?: string[] | undefined;
+            } | {
+                $$field: string;
+                $$subfield?: string[] | undefined;
+            }[] | undefined;
+            conditionals?: ({
+                type: "SHOW";
+                conditional: any;
+            } | {
+                type: "ENABLE";
+                conditional: any;
+            } | {
+                type: "DISPLAY_ON_REVIEW";
+                conditional: any;
+            })[] | undefined;
+            secured?: boolean | undefined;
+            placeholder?: {
+                id: string;
+                defaultMessage: string;
+                description: string;
+            } | undefined;
+            validation?: {
+                validator: any;
+                message: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                };
+            }[] | undefined;
+            helperText?: {
+                id: string;
+                defaultMessage: string;
+                description: string;
+            } | undefined;
+            hideLabel?: boolean | undefined;
+            uncorrectable?: boolean | undefined;
+            value?: {
+                $$field: string;
+                $$subfield?: string[] | undefined;
+            } | {
+                $$field: string;
+                $$subfield?: string[] | undefined;
+            }[] | undefined;
+            analytics?: boolean | undefined;
+            required?: false | undefined;
         } | {
             id: string;
             label: {
@@ -5651,6 +5706,61 @@ export declare const defineConfig: (config: EventConfigInput) => {
                     $$subfield?: string[] | undefined;
                 }[] | undefined;
                 analytics?: boolean | undefined;
+            } | {
+                id: string;
+                label: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                };
+                type: "HIDDEN";
+                parent?: {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                } | {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                }[] | undefined;
+                conditionals?: ({
+                    type: "SHOW";
+                    conditional: any;
+                } | {
+                    type: "ENABLE";
+                    conditional: any;
+                } | {
+                    type: "DISPLAY_ON_REVIEW";
+                    conditional: any;
+                })[] | undefined;
+                secured?: boolean | undefined;
+                placeholder?: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                } | undefined;
+                validation?: {
+                    validator: any;
+                    message: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    };
+                }[] | undefined;
+                helperText?: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                } | undefined;
+                hideLabel?: boolean | undefined;
+                uncorrectable?: boolean | undefined;
+                value?: {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                } | {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                }[] | undefined;
+                analytics?: boolean | undefined;
+                required?: false | undefined;
             } | {
                 id: string;
                 label: {
@@ -8708,6 +8818,61 @@ export declare const defineConfig: (config: EventConfigInput) => {
                     $$subfield?: string[] | undefined;
                 }[] | undefined;
                 analytics?: boolean | undefined;
+            } | {
+                id: string;
+                label: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                };
+                type: "HIDDEN";
+                parent?: {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                } | {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                }[] | undefined;
+                conditionals?: ({
+                    type: "SHOW";
+                    conditional: any;
+                } | {
+                    type: "ENABLE";
+                    conditional: any;
+                } | {
+                    type: "DISPLAY_ON_REVIEW";
+                    conditional: any;
+                })[] | undefined;
+                secured?: boolean | undefined;
+                placeholder?: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                } | undefined;
+                validation?: {
+                    validator: any;
+                    message: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    };
+                }[] | undefined;
+                helperText?: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                } | undefined;
+                hideLabel?: boolean | undefined;
+                uncorrectable?: boolean | undefined;
+                value?: {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                } | {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                }[] | undefined;
+                analytics?: boolean | undefined;
+                required?: false | undefined;
             } | {
                 id: string;
                 label: {
@@ -11895,6 +12060,61 @@ export declare const defineConfig: (config: EventConfigInput) => {
                         $$subfield?: string[] | undefined;
                     }[] | undefined;
                     analytics?: boolean | undefined;
+                } | {
+                    id: string;
+                    label: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    };
+                    type: "HIDDEN";
+                    parent?: {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    } | {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    }[] | undefined;
+                    conditionals?: ({
+                        type: "SHOW";
+                        conditional: any;
+                    } | {
+                        type: "ENABLE";
+                        conditional: any;
+                    } | {
+                        type: "DISPLAY_ON_REVIEW";
+                        conditional: any;
+                    })[] | undefined;
+                    secured?: boolean | undefined;
+                    placeholder?: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    } | undefined;
+                    validation?: {
+                        validator: any;
+                        message: {
+                            id: string;
+                            defaultMessage: string;
+                            description: string;
+                        };
+                    }[] | undefined;
+                    helperText?: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    } | undefined;
+                    hideLabel?: boolean | undefined;
+                    uncorrectable?: boolean | undefined;
+                    value?: {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    } | {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    }[] | undefined;
+                    analytics?: boolean | undefined;
+                    required?: false | undefined;
                 } | {
                     id: string;
                     label: {
@@ -14930,6 +15150,61 @@ export declare const defineConfig: (config: EventConfigInput) => {
                         $$subfield?: string[] | undefined;
                     }[] | undefined;
                     analytics?: boolean | undefined;
+                } | {
+                    id: string;
+                    label: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    };
+                    type: "HIDDEN";
+                    parent?: {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    } | {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    }[] | undefined;
+                    conditionals?: ({
+                        type: "SHOW";
+                        conditional: any;
+                    } | {
+                        type: "ENABLE";
+                        conditional: any;
+                    } | {
+                        type: "DISPLAY_ON_REVIEW";
+                        conditional: any;
+                    })[] | undefined;
+                    secured?: boolean | undefined;
+                    placeholder?: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    } | undefined;
+                    validation?: {
+                        validator: any;
+                        message: {
+                            id: string;
+                            defaultMessage: string;
+                            description: string;
+                        };
+                    }[] | undefined;
+                    helperText?: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    } | undefined;
+                    hideLabel?: boolean | undefined;
+                    uncorrectable?: boolean | undefined;
+                    value?: {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    } | {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    }[] | undefined;
+                    analytics?: boolean | undefined;
+                    required?: false | undefined;
                 } | {
                     id: string;
                     label: {
@@ -18031,6 +18306,61 @@ export declare const defineConfig: (config: EventConfigInput) => {
                         $$subfield?: string[] | undefined;
                     }[] | undefined;
                     analytics?: boolean | undefined;
+                } | {
+                    id: string;
+                    label: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    };
+                    type: "HIDDEN";
+                    parent?: {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    } | {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    }[] | undefined;
+                    conditionals?: ({
+                        type: "SHOW";
+                        conditional: any;
+                    } | {
+                        type: "ENABLE";
+                        conditional: any;
+                    } | {
+                        type: "DISPLAY_ON_REVIEW";
+                        conditional: any;
+                    })[] | undefined;
+                    secured?: boolean | undefined;
+                    placeholder?: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    } | undefined;
+                    validation?: {
+                        validator: any;
+                        message: {
+                            id: string;
+                            defaultMessage: string;
+                            description: string;
+                        };
+                    }[] | undefined;
+                    helperText?: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    } | undefined;
+                    hideLabel?: boolean | undefined;
+                    uncorrectable?: boolean | undefined;
+                    value?: {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    } | {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    }[] | undefined;
+                    analytics?: boolean | undefined;
+                    required?: false | undefined;
                 } | {
                     id: string;
                     label: {
@@ -21066,6 +21396,61 @@ export declare const defineConfig: (config: EventConfigInput) => {
                         $$subfield?: string[] | undefined;
                     }[] | undefined;
                     analytics?: boolean | undefined;
+                } | {
+                    id: string;
+                    label: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    };
+                    type: "HIDDEN";
+                    parent?: {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    } | {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    }[] | undefined;
+                    conditionals?: ({
+                        type: "SHOW";
+                        conditional: any;
+                    } | {
+                        type: "ENABLE";
+                        conditional: any;
+                    } | {
+                        type: "DISPLAY_ON_REVIEW";
+                        conditional: any;
+                    })[] | undefined;
+                    secured?: boolean | undefined;
+                    placeholder?: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    } | undefined;
+                    validation?: {
+                        validator: any;
+                        message: {
+                            id: string;
+                            defaultMessage: string;
+                            description: string;
+                        };
+                    }[] | undefined;
+                    helperText?: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    } | undefined;
+                    hideLabel?: boolean | undefined;
+                    uncorrectable?: boolean | undefined;
+                    value?: {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    } | {
+                        $$field: string;
+                        $$subfield?: string[] | undefined;
+                    }[] | undefined;
+                    analytics?: boolean | undefined;
+                    required?: false | undefined;
                 } | {
                     id: string;
                     label: {
@@ -24156,6 +24541,61 @@ export declare const defineConfig: (config: EventConfigInput) => {
                     $$subfield?: string[] | undefined;
                 }[] | undefined;
                 analytics?: boolean | undefined;
+            } | {
+                id: string;
+                label: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                };
+                type: "HIDDEN";
+                parent?: {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                } | {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                }[] | undefined;
+                conditionals?: ({
+                    type: "SHOW";
+                    conditional: any;
+                } | {
+                    type: "ENABLE";
+                    conditional: any;
+                } | {
+                    type: "DISPLAY_ON_REVIEW";
+                    conditional: any;
+                })[] | undefined;
+                secured?: boolean | undefined;
+                placeholder?: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                } | undefined;
+                validation?: {
+                    validator: any;
+                    message: {
+                        id: string;
+                        defaultMessage: string;
+                        description: string;
+                    };
+                }[] | undefined;
+                helperText?: {
+                    id: string;
+                    defaultMessage: string;
+                    description: string;
+                } | undefined;
+                hideLabel?: boolean | undefined;
+                uncorrectable?: boolean | undefined;
+                value?: {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                } | {
+                    $$field: string;
+                    $$subfield?: string[] | undefined;
+                }[] | undefined;
+                analytics?: boolean | undefined;
+                required?: false | undefined;
             } | {
                 id: string;
                 label: {
@@ -24678,7 +25118,7 @@ export declare const defineConfig: (config: EventConfigInput) => {
             };
             fieldId: string;
             fieldType: "field";
-            type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "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;
+            type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "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" | "HIDDEN" | undefined;
             label?: {
                 id: string;
                 defaultMessage: string;
@@ -24720,9 +25160,9 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 type: "exact" | "fuzzy" | "range" | "within";
                 searchFields?: string[] | undefined;
             };
-            fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+            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" | "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;
+            type?: "NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "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" | "HIDDEN" | undefined;
             label?: {
                 id: string;
                 defaultMessage: string;
@@ -24774,6 +25214,10 @@ export declare const defineConfig: (config: EventConfigInput) => {
         $$field: string;
         $$subfield?: string[] | undefined;
     } | undefined;
+    placeOfEvent?: {
+        $$field: string;
+        $$subfield?: string[] | undefined;
+    } | undefined;
     fallbackTitle?: {
         id: string;
         defaultMessage: string;

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

@@ -10,7 +10,7 @@ import { WorkqueueColumnKeys, WorkqueueColumnValue } from './WorkqueueColumnConf
  */
 declare function eventFn(fieldId: EventFieldIdInput): {
     range: () => {
-        fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
         fieldType: "event";
     } & {
         config: {
@@ -18,7 +18,7 @@ declare function eventFn(fieldId: EventFieldIdInput): {
         };
     };
     exact: () => {
-        fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
         fieldType: "event";
     } & {
         config: {
@@ -26,7 +26,7 @@ declare function eventFn(fieldId: EventFieldIdInput): {
         };
     };
     fuzzy: () => {
-        fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
         fieldType: "event";
     } & {
         config: {
@@ -34,7 +34,7 @@ declare function eventFn(fieldId: EventFieldIdInput): {
         };
     };
     within: () => {
-        fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation";
+        fieldId: "event.status" | "event.trackingId" | "event.updatedAt" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.legalStatuses.REGISTERED.registrationNumber";
         fieldType: "event";
     } & {
         config: {

package/dist/commons/events/state/index.d.ts CHANGED Viewed

@@ -28,9 +28,14 @@ export declare const DEFAULT_DATE_OF_EVENT_PROPERTY = "createdAt";
 export declare function resolveDateOfEvent(eventMetadata: {
     createdAt: string;
 }, declaration: EventState, config: EventConfig): string | undefined;
+export declare const DEFAULT_PLACE_OF_EVENT_PROPERTY = "createdAtLocation";
+export declare function resolvePlaceOfEvent(eventMetadata: {
+    createdAtLocation?: UUID | undefined | null;
+}, declaration: EventState, config: EventConfig): UUID | undefined | null;
 export declare function extractPotentialDuplicatesFromActions(actions: Action[]): PotentialDuplicate[];
 /**
  * NOTE: This function should not run field validations. It should return the state based on the actions, without considering context (users, roles, permissions, etc).
+createdAtLocation: CreatedAtLocation
  *
  * If you update this function, please ensure @EventIndex type is updated accordingly.
  * In most cases, you won't need to add new parameters to this function. Discuss with the team before doing so.
@@ -96,6 +101,7 @@ export declare function applyDraftToEventIndex(eventIndex: EventIndex, draft: Dr
     flags: string[];
     declaration: Record<string, import("..").FieldValue>;
     dateOfEvent?: string | null | undefined;
+    placeOfEvent?: (string & import("zod/v4").$brand<"UUID">) | null | undefined;
     createdByUserType?: "system" | "user" | null | undefined;
     createdAtLocation?: (string & import("zod/v4").$brand<"UUID">) | null | undefined;
     createdBySignature?: string | null | undefined;