@opencrvs/toolkit 1.8.0-rc.f9911ed → 1.8.0-rc.f9d33b7

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

@@ -0,0 +1,25 @@
+import { EventFieldId } from './AdvancedSearchConfig';
+import { SelectOption } from './FieldConfig';
+/**
+ * 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: EventFieldId, options?: SelectOption[]): {
+    fieldId: "status" | "trackingId";
+    options: {
+        value: string;
+        label: import("./TranslationConfig").TranslationConfig;
+    }[] | undefined;
+    config: {
+        type: "EXACT";
+    };
+    fieldType: "event";
+};
+declare const event: typeof eventFn & {
+    hasAction: (action: import("./ActionType").ActionType) => import("../conditionals/conditionals").JSONSchema;
+};
+export { event };
+//# sourceMappingURL=event.d.ts.map

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

@@ -0,0 +1,68 @@
+/**
+ * Entry point for defining conditional logic or configuration for a form field.
+ * @param fieldId - The ID of the field to define rules or config for.
+ * @returns An object combining conditional methods and configuration builders.
+ */
+export declare function field(fieldId: string): {
+    range: () => {
+        config: {
+            type: "RANGE";
+        };
+        fieldId: string;
+        fieldType: "field";
+    };
+    exact: () => {
+        config: {
+            type: "EXACT";
+        };
+        fieldId: string;
+        fieldType: "field";
+    };
+    fuzzy: () => {
+        config: {
+            type: "FUZZY";
+        };
+        fieldId: string;
+        fieldType: "field";
+    };
+    isAfter: () => {
+        days: (days: number) => {
+            inPast: () => import("../conditionals/conditionals").JSONSchema;
+            inFuture: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        date: (date: string | {
+            [key: string]: unknown;
+            _fieldId: string;
+        }) => import("../conditionals/conditionals").JSONSchema;
+        now: () => import("../conditionals/conditionals").JSONSchema;
+    };
+    isBefore: () => {
+        days: (days: number) => {
+            inPast: () => import("../conditionals/conditionals").JSONSchema;
+            inFuture: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        date: (date: string | {
+            [key: string]: unknown;
+            _fieldId: string;
+        }) => import("../conditionals/conditionals").JSONSchema;
+        now: () => import("../conditionals/conditionals").JSONSchema;
+    };
+    isEqualTo: (value: string | boolean | {
+        [key: string]: unknown;
+        _fieldId: string;
+    }) => import("../conditionals/conditionals").JSONSchema;
+    isFalsy: () => import("../conditionals/conditionals").JSONSchema;
+    isUndefined: () => import("../conditionals/conditionals").JSONSchema;
+    inArray: (values: string[]) => import("../conditionals/conditionals").JSONSchema;
+    isValidEnglishName: () => import("../conditionals/conditionals").JSONSchema;
+    matches: (pattern: string) => import("../conditionals/conditionals").JSONSchema;
+    isBetween: (min: number, max: number) => import("../conditionals/conditionals").JSONSchema;
+    getId: () => {
+        fieldId: string;
+    };
+    /**
+     * @private Internal property used for field reference tracking.
+     */
+    _fieldId: string;
+};
+//# sourceMappingURL=field.d.ts.map

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

@@ -3,7 +3,7 @@ export * from './offline';
 export * from './EventConfig';
 export * from './EventConfigInput';
 export * from './FieldConfig';
-export * from './FormConfig';
+export * from './PageConfig';
 export * from './SummaryConfig';
 export * from './WorkqueueConfig';
 export * from './Draft';
@@ -15,6 +15,7 @@ export * from './ActionDocument';
 export * from './EventIndex';
 export * from './TranslationConfig';
 export * from './FieldValue';
+export * from './FormConfig';
 export * from './CompositeFieldValue';
 export * from './state';
 export * from './utils';
@@ -29,6 +30,9 @@ export * from './Conditional';
 export * from './AdvancedSearchConfig';
 export * from './test.utils';
 export * from './TemplateConfig';
+export * from './scopes';
 export * from '../conditionals/conditionals';
 export * from '../conditionals/validate';
+export * from './field';
+export * from './event';
 //# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,26 @@
+import { Scope } from '../scopes';
+import { ActionType } from './ActionType';
+export declare function hasAnyOfScopes(a: Scope[], b: Scope[]): boolean;
+export declare const CONFIG_GET_ALLOWED_SCOPES: ["record.declare-birth", "record.read", "record.declaration-submit-incomplete", "record.declaration-submit-for-review", "record.register", "record.export-records", "config", "config.update:all"];
+export declare const CONFIG_SEARCH_ALLOWED_SCOPES: ("search.birth:my-jurisdiction" | "search.birth" | "search.death:my-jurisdiction" | "search.death" | "search.marriage:my-jurisdiction" | "search.marriage")[];
+export declare const ACTION_ALLOWED_SCOPES: {
+    READ: ["record.declare-birth", "record.read", "record.declaration-submit-incomplete", "record.declaration-submit-for-review", "record.register", "record.export-records"];
+    CREATE: ["record.declare-birth", "record.declaration-submit-incomplete", "record.declaration-submit-for-review"];
+    NOTIFY: ["record.declaration-submit-incomplete"];
+    DECLARE: ["record.declare-birth", "record.declaration-submit-for-approval", "record.register"];
+    DELETE: ["record.declare-birth"];
+    VALIDATE: ["record.declaration-submit-for-approval", "record.register"];
+    REGISTER: ["record.register"];
+    PRINT_CERTIFICATE: ["record.registration-print&issue-certified-copies"];
+    REQUEST_CORRECTION: ["record.registration-request-correction"];
+    REJECT_CORRECTION: ["record.registration-correct"];
+    APPROVE_CORRECTION: ["record.registration-correct"];
+    MARKED_AS_DUPLICATE: ["record.declaration-archive"];
+    ARCHIVE: ["record.declaration-archive"];
+    REJECT: ["record.declaration-submit-for-updates"];
+    ASSIGN: null;
+    UNASSIGN: null;
+    DETECT_DUPLICATE: [];
+};
+export declare function filterUnallowedActions(actions: ActionType[], userScopes: Scope[]): ActionType[];
+//# sourceMappingURL=scopes.d.ts.map

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

@@ -1,5 +1,5 @@
-import { ActionDocument } from './ActionDocument';
-import { ArchiveActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
+import { ActionDocument, ActionUpdate } from './ActionDocument';
+import { ArchiveActionInput, AssignActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, ValidateActionInput } from './ActionInput';
 import { ActionType } from './ActionType';
 import { Draft } from './Draft';
 import { EventConfig } from './EventConfig';
@@ -8,45 +8,8 @@ import { EventIndex } from './EventIndex';
 import { EventInput } from './EventInput';
 import { FieldValue } from './FieldValue';
 import { TranslationConfig } from './TranslationConfig';
-export declare function generateActionInput(configuration: EventConfig, action: ActionType): import("lodash").Dictionary<string | number | boolean | {
-    type: string;
-    filename: string;
-    originalFilename: string;
-} | {
-    country: string;
-    district: string;
-    addressType: "DOMESTIC";
-    province: string;
-    urbanOrRural: "URBAN";
-    number?: string | undefined;
-    town?: string | undefined;
-    residentialArea?: string | undefined;
-    street?: string | undefined;
-    zipCode?: string | undefined;
-} | {
-    country: string;
-    district: string;
-    addressType: "DOMESTIC";
-    province: string;
-    urbanOrRural: "RURAL";
-    village?: string | undefined;
-} | {
-    country: string;
-    state: string;
-    addressType: "INTERNATIONAL";
-    district2: string;
-    cityOrTown?: string | undefined;
-    addressLine1?: string | undefined;
-    addressLine2?: string | undefined;
-    addressLine3?: string | undefined;
-    postcodeOrZip?: string | undefined;
-} | {
-    type: string;
-    option: string;
-    filename: string;
-    originalFilename: string;
-}[] | undefined>;
-export declare function generateActionMetadataInput(configuration: EventConfig, action: ActionType): {};
+export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType): Partial<import("./ActionDocument").EventState>;
+export declare function generateActionAnnotationInput(configuration: EventConfig, action: ActionType): {};
 export declare const eventPayloadGenerator: {
     create: (input?: Partial<EventInput>) => {
         transactionId: string;
@@ -57,35 +20,15 @@ export declare const eventPayloadGenerator: {
         type: string;
         id: string;
     };
-    draft: (eventId: string, input?: Partial<Draft>) => {
-        id: import("../uuid").UUID;
+    draft: ({ eventId, actionType }: {
         eventId: string;
-        createdAt: string;
-        transactionId: import("../uuid").UUID;
-        action: {
-            type: "REQUEST_CORRECTION";
-            data: {
-                'applicant.firstname': string;
-                'applicant.surname': string;
-                'applicant.dob': string;
-                'recommender.none': boolean;
-            };
-            metadata: {
-                'correction.requester.relationship': string;
-                'correction.request.reason': string;
-            };
-            createdAt: string;
-            createdBy: string;
-            createdAtLocation: string;
-        };
-    } & Partial<{
-        id: string;
-        createdAt: string;
-        eventId: string;
-        transactionId: string;
-        action: {
-            type: ActionType;
-            data: Record<string, string | number | boolean | {
+        actionType: ActionType;
+    }, input?: Partial<Draft>) => Draft;
+    actions: {
+        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "declaration" | "annotation">>) => {
+            type: "DECLARE";
+            transactionId: string;
+            declaration: Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -123,54 +66,19 @@ export declare const eventPayloadGenerator: {
                 filename: string;
                 originalFilename: string;
             }[] | undefined>;
-            createdAt: string;
-            createdBy: string;
-            createdAtLocation: string;
-            metadata?: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: string | null | undefined;
-            } | {
-                country: string;
-                state: string;
-                addressType: "INTERNATIONAL";
-                district2: string;
-                cityOrTown?: string | null | undefined;
-                addressLine1?: string | null | undefined;
-                addressLine2?: string | null | undefined;
-                addressLine3?: string | null | undefined;
-                postcodeOrZip?: string | null | undefined;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[] | undefined> | undefined;
+            annotation: {};
+            eventId: string;
         };
-    }>;
-    actions: {
-        declare: (eventId: string, input?: Partial<Pick<DeclareActionInput, "transactionId" | "data">>) => {
-            type: "DECLARE";
+        /**
+         * Notify allows sending incomplete data. Think it as 'partial declare' for now.
+         */
+        notify: (eventId: string, input?: {
+            transactionId?: string;
+            declaration?: Partial<ActionUpdate>;
+        }) => {
+            type: "NOTIFY";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Partial<Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -207,13 +115,13 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
+            }[] | undefined>>;
             eventId: string;
         };
-        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "data">>) => {
+        validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation">>) => {
             type: "VALIDATE";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -251,104 +159,46 @@ export declare const eventPayloadGenerator: {
                 filename: string;
                 originalFilename: string;
             }[] | undefined>;
+            annotation: {};
             duplicates: never[];
             eventId: string;
         };
-        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "data">>, isDuplicate?: boolean) => {
+        assign: (eventId: string, input?: Partial<Pick<AssignActionInput, "transactionId" | "assignedTo">>) => {
+            type: "ASSIGN";
+            transactionId: string;
+            declaration: {};
+            assignedTo: string;
+            eventId: string;
+        };
+        unassign: (eventId: string, input?: Partial<Pick<UnassignActionInput, "transactionId">>) => {
+            type: "UNASSIGN";
+            transactionId: string;
+            declaration: {};
+            assignedTo: null;
+            eventId: string;
+        };
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "declaration">>, isDuplicate?: boolean) => {
             type: "ARCHIVE";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: string | null | undefined;
-            } | {
-                country: string;
-                state: string;
-                addressType: "INTERNATIONAL";
-                district2: string;
-                cityOrTown?: string | null | undefined;
-                addressLine1?: string | null | undefined;
-                addressLine2?: string | null | undefined;
-                addressLine3?: string | null | undefined;
-                postcodeOrZip?: string | null | undefined;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[] | undefined>;
-            metadata: {
+            declaration: {};
+            annotation: {
                 isDuplicate: boolean;
             };
             duplicates: never[];
             eventId: string;
         };
-        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "data">>) => {
+        reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation">>) => {
             type: "REJECT";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: string | null | undefined;
-            } | {
-                country: string;
-                state: string;
-                addressType: "INTERNATIONAL";
-                district2: string;
-                cityOrTown?: string | null | undefined;
-                addressLine1?: string | null | undefined;
-                addressLine2?: string | null | undefined;
-                addressLine3?: string | null | undefined;
-                postcodeOrZip?: string | null | undefined;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[] | undefined>;
+            declaration: {};
+            annotation: {};
             duplicates: never[];
             eventId: string;
         };
-        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data">>) => {
+        register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation">>) => {
             type: "REGISTER";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
+            declaration: Record<string, string | number | boolean | {
                 type: string;
                 filename: string;
                 originalFilename: string;
@@ -386,57 +236,21 @@ export declare const eventPayloadGenerator: {
                 filename: string;
                 originalFilename: string;
             }[] | undefined>;
+            annotation: {};
             eventId: string;
         };
-        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "data" | "metadata">>) => {
+        printCertificate: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "annotation">>) => {
             type: "PRINT_CERTIFICATE";
             transactionId: string;
-            data: Record<string, string | number | boolean | {
-                type: string;
-                filename: string;
-                originalFilename: string;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "URBAN";
-                number?: string | null | undefined;
-                town?: string | null | undefined;
-                residentialArea?: string | null | undefined;
-                street?: string | null | undefined;
-                zipCode?: string | null | undefined;
-            } | {
-                country: string;
-                district: string;
-                addressType: "DOMESTIC";
-                province: string;
-                urbanOrRural: "RURAL";
-                village?: string | null | undefined;
-            } | {
-                country: string;
-                state: string;
-                addressType: "INTERNATIONAL";
-                district2: string;
-                cityOrTown?: string | null | undefined;
-                addressLine1?: string | null | undefined;
-                addressLine2?: string | null | undefined;
-                addressLine3?: string | null | undefined;
-                postcodeOrZip?: string | null | undefined;
-            } | {
-                type: string;
-                option: string;
-                filename: string;
-                originalFilename: string;
-            }[] | undefined>;
-            metadata: {};
+            declaration: {};
+            annotation: {};
             eventId: string;
         };
         correction: {
-            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            request: (eventId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "declaration" | "annotation">>) => {
                 type: "REQUEST_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
+                declaration: Record<string, string | number | boolean | {
                     type: string;
                     filename: string;
                     originalFilename: string;
@@ -474,94 +288,22 @@ export declare const eventPayloadGenerator: {
                     filename: string;
                     originalFilename: string;
                 }[] | undefined>;
-                metadata: {};
+                annotation: {};
                 eventId: string;
             };
-            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            approve: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
                 type: "APPROVE_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
-                    type: string;
-                    filename: string;
-                    originalFilename: string;
-                } | {
-                    country: string;
-                    district: string;
-                    addressType: "DOMESTIC";
-                    province: string;
-                    urbanOrRural: "URBAN";
-                    number?: string | null | undefined;
-                    town?: string | null | undefined;
-                    residentialArea?: string | null | undefined;
-                    street?: string | null | undefined;
-                    zipCode?: string | null | undefined;
-                } | {
-                    country: string;
-                    district: string;
-                    addressType: "DOMESTIC";
-                    province: string;
-                    urbanOrRural: "RURAL";
-                    village?: string | null | undefined;
-                } | {
-                    country: string;
-                    state: string;
-                    addressType: "INTERNATIONAL";
-                    district2: string;
-                    cityOrTown?: string | null | undefined;
-                    addressLine1?: string | null | undefined;
-                    addressLine2?: string | null | undefined;
-                    addressLine3?: string | null | undefined;
-                    postcodeOrZip?: string | null | undefined;
-                } | {
-                    type: string;
-                    option: string;
-                    filename: string;
-                    originalFilename: string;
-                }[] | undefined>;
+                declaration: {};
+                annotation: {};
                 eventId: string;
                 requestId: string;
             };
-            reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "data">>) => {
+            reject: (eventId: string, requestId: string, input?: Partial<Pick<RequestCorrectionActionInput, "transactionId" | "annotation">>) => {
                 type: "REJECT_CORRECTION";
                 transactionId: string;
-                data: Record<string, string | number | boolean | {
-                    type: string;
-                    filename: string;
-                    originalFilename: string;
-                } | {
-                    country: string;
-                    district: string;
-                    addressType: "DOMESTIC";
-                    province: string;
-                    urbanOrRural: "URBAN";
-                    number?: string | null | undefined;
-                    town?: string | null | undefined;
-                    residentialArea?: string | null | undefined;
-                    street?: string | null | undefined;
-                    zipCode?: string | null | undefined;
-                } | {
-                    country: string;
-                    district: string;
-                    addressType: "DOMESTIC";
-                    province: string;
-                    urbanOrRural: "RURAL";
-                    village?: string | null | undefined;
-                } | {
-                    country: string;
-                    state: string;
-                    addressType: "INTERNATIONAL";
-                    district2: string;
-                    cityOrTown?: string | null | undefined;
-                    addressLine1?: string | null | undefined;
-                    addressLine2?: string | null | undefined;
-                    addressLine3?: string | null | undefined;
-                    postcodeOrZip?: string | null | undefined;
-                } | {
-                    type: string;
-                    option: string;
-                    filename: string;
-                    originalFilename: string;
-                }[] | undefined>;
+                declaration: {};
+                annotation: {};
                 eventId: string;
                 requestId: string;
             };
@@ -577,7 +319,7 @@ export declare function generateEventDocument({ configuration, actions }: {
     configuration: EventConfig;
     actions: ActionType[];
 }): EventDocument;
-export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, data?: Record<string, FieldValue>): Draft;
+export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, declaration?: Record<string, FieldValue>): Draft;
 export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>) => EventIndex;
 export declare const generateTranslationConfig: (message: string) => TranslationConfig;
 //# sourceMappingURL=test.utils.d.ts.map