@opencrvs/toolkit 1.8.0-rc.fb2e700 → 1.8.0-rc.fb5b9fe

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

@@ -0,0 +1,54 @@
+import { EventFieldId } from './AdvancedSearchConfig';
+import { SelectOption } from './FieldConfig';
+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: EventFieldId, options?: SelectOption[]): {
+    range: () => {
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
+        options: {
+            value: string;
+            label: import("./TranslationConfig").TranslationConfig;
+        }[] | undefined;
+        fieldType: "event";
+    } & {
+        config: {
+            type: "range";
+        };
+    };
+    exact: () => {
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
+        options: {
+            value: string;
+            label: import("./TranslationConfig").TranslationConfig;
+        }[] | undefined;
+        fieldType: "event";
+    } & {
+        config: {
+            type: "exact";
+        };
+    };
+    fuzzy: () => {
+        fieldId: "status" | "updatedAt" | "trackingId" | "legalStatus.REGISTERED.createdAt" | "legalStatus.REGISTERED.createdAtLocation";
+        options: {
+            value: string;
+            label: import("./TranslationConfig").TranslationConfig;
+        }[] | undefined;
+        fieldType: "event";
+    } & {
+        config: {
+            type: "fuzzy";
+        };
+    };
+};
+declare const event: typeof eventFn & {
+    field(field: WorkqueueColumnKeys): WorkqueueColumnValue;
+    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,73 @@
+import { FieldConditional } from './Conditional';
+import { TranslationConfig } from './TranslationConfig';
+/**
+ * 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, options?: {
+    conditionals?: FieldConditional[];
+    searchCriteriaLabelPrefix?: TranslationConfig;
+}): {
+    range: () => {
+        conditionals?: FieldConditional[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "range";
+        };
+    };
+    exact: () => {
+        conditionals?: FieldConditional[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "exact";
+        };
+    };
+    fuzzy: () => {
+        conditionals?: FieldConditional[];
+        searchCriteriaLabelPrefix?: TranslationConfig;
+        fieldId: string;
+        fieldType: "field";
+    } & {
+        config: {
+            type: "fuzzy";
+        };
+    };
+    $$field: string;
+    isAfter: () => {
+        days: (days: number) => {
+            inPast: () => import("../conditionals/conditionals").JSONSchema;
+            inFuture: () => import("../conditionals/conditionals").JSONSchema;
+        };
+        date: (date: string | {
+            $$field: 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 | {
+            $$field: string;
+        }) => import("../conditionals/conditionals").JSONSchema;
+        now: () => import("../conditionals/conditionals").JSONSchema;
+    };
+    isEqualTo: (value: string | boolean | {
+        $$field: 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;
+};
+//# sourceMappingURL=field.d.ts.map

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

@@ -1,3 +1,4 @@
+export * from './Constants';
 export * from './ActionConfig';
 export * from './offline';
 export * from './EventConfig';
@@ -6,6 +7,8 @@ export * from './FieldConfig';
 export * from './PageConfig';
 export * from './SummaryConfig';
 export * from './WorkqueueConfig';
+export * from './WorkqueueColumnConfig';
+export * from './workqueueDefaultColumns';
 export * from './Draft';
 export * from './EventMetadata';
 export * from './EventInput';
@@ -30,6 +33,10 @@ export * from './Conditional';
 export * from './AdvancedSearchConfig';
 export * from './test.utils';
 export * from './TemplateConfig';
+export * from './scopes';
+export * from './serializer';
 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,45 @@
+import { Scope } from '../scopes';
+import { ActionType } from './ActionType';
+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 const ACTION_ALLOWED_CONFIGURABLE_SCOPES: {
+    READ: never[];
+    CREATE: "record.notify"[];
+    NOTIFY: "record.notify"[];
+    DECLARE: never[];
+    DELETE: never[];
+    VALIDATE: never[];
+    REGISTER: never[];
+    PRINT_CERTIFICATE: never[];
+    REQUEST_CORRECTION: never[];
+    REJECT_CORRECTION: never[];
+    APPROVE_CORRECTION: never[];
+    MARKED_AS_DUPLICATE: never[];
+    ARCHIVE: never[];
+    REJECT: never[];
+    ASSIGN: never[];
+    UNASSIGN: never[];
+    DETECT_DUPLICATE: never[];
+};
+export declare function hasAnyOfScopes(a: Scope[], b: Scope[]): boolean;
+export declare function filterUnallowedActions(actions: ActionType[], userScopes: Scope[]): ActionType[];
+//# sourceMappingURL=scopes.d.ts.map

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

@@ -0,0 +1,2 @@
+export { deserializeQuery } from './serializers/user/deserializer';
+//# sourceMappingURL=serializer.d.ts.map

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

@@ -1,4 +1,5 @@
-import { ActionDocument, ActionUpdate } from './ActionDocument';
+import { UUID } from '../uuid';
+import { ActionDocument, ActionUpdate, EventState } from './ActionDocument';
 import { ArchiveActionInput, AssignActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, UnassignActionInput, ValidateActionInput } from './ActionInput';
 import { ActionType } from './ActionType';
 import { Draft } from './Draft';
@@ -6,46 +7,9 @@ import { EventConfig } from './EventConfig';
 import { EventDocument } from './EventDocument';
 import { EventIndex } from './EventIndex';
 import { EventInput } from './EventInput';
-import { FieldValue } from './FieldValue';
 import { TranslationConfig } from './TranslationConfig';
-export declare function generateActionDeclarationInput(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>;
+import { WorkqueueConfig } from './WorkqueueConfig';
+export declare function generateActionDeclarationInput(configuration: EventConfig, action: ActionType): EventState;
 export declare function generateActionAnnotationInput(configuration: EventConfig, action: ActionType): {};
 export declare const eventPayloadGenerator: {
     create: (input?: Partial<EventInput>) => {
@@ -58,7 +22,7 @@ export declare const eventPayloadGenerator: {
         id: string;
     };
     draft: ({ eventId, actionType }: {
-        eventId: string;
+        eventId: UUID;
         actionType: ActionType;
     }, input?: Partial<Draft>) => Draft;
     actions: {
@@ -102,7 +66,7 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
+            }[] | [string, string] | undefined>;
             annotation: {};
             eventId: string;
         };
@@ -152,7 +116,7 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>>;
+            }[] | [string, string] | undefined>>;
             eventId: string;
         };
         validate: (eventId: string, input?: Partial<Pick<ValidateActionInput, "transactionId" | "declaration" | "annotation">>) => {
@@ -195,7 +159,7 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
+            }[] | [string, string] | undefined>;
             annotation: {};
             duplicates: never[];
             eventId: string;
@@ -218,11 +182,13 @@ export declare const eventPayloadGenerator: {
             type: "ARCHIVE";
             transactionId: string;
             declaration: {};
-            annotation: {
-                isDuplicate: boolean;
-            };
+            annotation: {};
             duplicates: never[];
             eventId: string;
+            reason: {
+                message: string;
+                isDuplicate: boolean;
+            };
         };
         reject: (eventId: string, input?: Partial<Pick<RejectDeclarationActionInput, "transactionId" | "annotation">>) => {
             type: "REJECT";
@@ -231,6 +197,9 @@ export declare const eventPayloadGenerator: {
             annotation: {};
             duplicates: never[];
             eventId: string;
+            reason: {
+                message: string;
+            };
         };
         register: (eventId: string, input?: Partial<Pick<RegisterActionInput, "transactionId" | "declaration" | "annotation">>) => {
             type: "REGISTER";
@@ -272,7 +241,7 @@ export declare const eventPayloadGenerator: {
                 option: string;
                 filename: string;
                 originalFilename: string;
-            }[] | undefined>;
+            }[] | [string, string] | undefined>;
             annotation: {};
             eventId: string;
         };
@@ -324,7 +293,7 @@ export declare const eventPayloadGenerator: {
                     option: string;
                     filename: string;
                     originalFilename: string;
-                }[] | undefined>;
+                }[] | [string, string] | undefined>;
                 annotation: {};
                 eventId: string;
             };
@@ -356,7 +325,22 @@ export declare function generateEventDocument({ configuration, actions }: {
     configuration: EventConfig;
     actions: ActionType[];
 }): EventDocument;
-export declare function generateEventDraftDocument(eventId: string, actionType?: ActionType, declaration?: Record<string, FieldValue>): Draft;
-export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>) => EventIndex;
+export declare function generateEventDraftDocument(eventId: UUID, actionType?: ActionType, declaration?: EventState): Draft;
+export declare function getRandomDatetime(rng: () => number, start: Date, end: Date): string;
+/**
+ * Useful for testing when we need deterministic outcome.
+ * @param seed - Seed value for the pseudo-random number generator
+ *
+ * @returns A function that generates pseudo-random numbers between 0 and 1
+ */
+export declare function createPseudoRandomNumberGenerator(seed: number): () => number;
+export declare function generateRandomSignature(rng: () => number): string;
+export declare const eventQueryDataGenerator: (overrides?: Partial<EventIndex>, seed?: number) => EventIndex;
 export declare const generateTranslationConfig: (message: string) => TranslationConfig;
+export declare const BearerTokenByUserType: {
+    fieldAgent: string;
+    registrationAgent: string;
+    localRegistrar: string;
+};
+export declare const generateWorkqueues: (slug?: string) => WorkqueueConfig[];
 //# sourceMappingURL=test.utils.d.ts.map

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

@@ -1,2 +1,2 @@
-export declare function generateTransactionId(): import("../uuid").UUID;
+export declare function generateTransactionId(): string & import("zod").BRAND<"UUID">;
 //# sourceMappingURL=transactions.d.ts.map