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

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

@@ -0,0 +1,486 @@
+import { ActionType, DeclarationActionType } from './ActionType';
+import { EventConfig } from './EventConfig';
+import { FieldConfig } from './FieldConfig';
+import { Action, ActionDocument, ActionUpdate, EventState } from './ActionDocument';
+import { PageConfig, VerificationPageConfig } from './PageConfig';
+import { ValidatorContext } from '../conditionals/validate';
+import { Draft } from './Draft';
+import { EventDocument } from './EventDocument';
+import { UUID } from '../uuid';
+import { ActionConfig } from './ActionConfig';
+import { FormConfig } from './FormConfig';
+import { PlainDate, SelectDateRangeValue } from './FieldValue';
+export declare function ageToDate(age: number, asOfDate: PlainDate): string & import("zod").BRAND<"PlainDate">;
+export declare function getDeclarationFields(configuration: EventConfig): FieldConfig[];
+export declare function getDeclarationPages(configuration: EventConfig): {
+    type: "FORM";
+    id: string;
+    title: import("./TranslationConfig").TranslationConfig;
+    fields: FieldConfig[];
+    requireCompletionToContinue: boolean;
+    conditional?: import(".").JSONSchema | undefined;
+}[];
+export declare function getDeclaration(configuration: EventConfig): {
+    label: import("./TranslationConfig").TranslationConfig;
+    pages: {
+        type: "FORM";
+        id: string;
+        title: import("./TranslationConfig").TranslationConfig;
+        fields: FieldConfig[];
+        requireCompletionToContinue: boolean;
+        conditional?: import(".").JSONSchema | undefined;
+    }[];
+};
+export declare function getPrintCertificatePages(configuration: EventConfig): ({
+    type: "FORM";
+    id: string;
+    title: import("./TranslationConfig").TranslationConfig;
+    fields: 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: FieldConfig[];
+    requireCompletionToContinue: boolean;
+    conditional?: import(".").JSONSchema | undefined;
+})[];
+export declare const getActionAnnotationFields: (actionConfig: ActionConfig) => FieldConfig[];
+export declare function getAllUniqueFields(eventConfig: EventConfig): FieldConfig[];
+export declare function getDeclarationFieldById(config: EventConfig, fieldId: string): FieldConfig;
+/**
+ * @TODO: Request correction should have same format as print certificate
+ */
+export declare const findRecordActionPages: (config: EventConfig, actionType: ActionType) => PageConfig[];
+export declare function getActionReview(configuration: EventConfig, actionType: ActionType): {
+    title: import("./TranslationConfig").TranslationConfig;
+    fields: FieldConfig[];
+};
+export declare function getActionReviewFields(configuration: EventConfig, actionType: DeclarationActionType): FieldConfig[];
+export declare function isPageVisible(page: PageConfig, formValues: ActionUpdate, context: ValidatorContext): boolean;
+/**
+ * Removes values from the form that correspond to hidden fields.
+ * This function recursively omits any fields from the form values that are not visible
+ * according to their FieldConfig and the current form state. It ensures that only values
+ * for visible fields are retained, which is useful for conditional forms where hidden field
+ * values should not affect validation or submission.
+ *
+ * @template T - The type of the form values
+ * @param {T} formValues - The current form values
+ * @param {FieldConfig[]} fields - The list of field configurations to check visibility against
+ * * @param validatorContext - custom validation context
+ * @returns {Partial<T>} A new object containing only the values for visible fields
+ */
+export declare function omitHiddenFields<T extends EventState | ActionUpdate>(fields: FieldConfig[], formValues: T, validatorContext: ValidatorContext, includeHiddenFieldsWithNullValues?: boolean): Partial<T>;
+export declare function omitHiddenPaginatedFields<T extends EventState | ActionUpdate>(formConfig: FormConfig, values: T, validatorContext: ValidatorContext, includeHiddenFieldsWithNullValues?: boolean): Partial<Partial<T>>;
+/**
+ *
+ * @returns a draft for the event that has been created since the last non-read action.
+ */
+export declare function findActiveDraftForEvent(event: EventDocument, draft: Draft): Draft | undefined;
+export declare function createEmptyDraft(eventId: UUID, draftId: UUID, actionType: Exclude<ActionType, 'DELETE'>): Draft;
+export declare function isVerificationPage(page: PageConfig): page is VerificationPageConfig;
+export declare function getVisibleVerificationPageIds(pages: PageConfig[], annotation: ActionUpdate, context: ValidatorContext): string[];
+export declare function omitHiddenAnnotationFields(actionConfig: ActionConfig, declaration: EventState, annotation: ActionUpdate, context: ValidatorContext): Partial<{
+    [x: string]: string | number | boolean | {
+        type: string;
+        path: string;
+        originalFilename: string;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | {
+        firstname?: string | null | undefined;
+        surname?: string | null | undefined;
+        middlename?: string | null | undefined;
+    } | {
+        country: string;
+        addressType: "DOMESTIC";
+        administrativeArea: string;
+        streetLevelDetails?: Record<string, string> | undefined;
+    } | {
+        country: string;
+        addressType: "INTERNATIONAL";
+        streetLevelDetails?: Record<string, string> | undefined;
+    } | {
+        addressType: "DOMESTIC";
+        country?: string | null | undefined;
+        streetLevelDetails?: Record<string, string | null> | null | undefined;
+        administrativeArea?: string | null | undefined;
+    } | {
+        addressType: "INTERNATIONAL";
+        country?: string | null | undefined;
+        streetLevelDetails?: Record<string, string | null> | null | undefined;
+    } | {
+        type: string;
+        option: string;
+        path: string;
+        originalFilename: string;
+    }[] | {
+        loading: boolean;
+        data?: any;
+        error?: {
+            message: string;
+            statusCode: number;
+        } | null | undefined;
+    } | {
+        data?: any;
+        error?: {
+            message: string;
+            statusCode: number;
+        } | null | undefined;
+        loading?: boolean | null | undefined;
+    } | {
+        data: Record<string, string>;
+    } | {
+        data: Record<string, string>;
+    } | {
+        data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
+    } | (string & import("zod").BRAND<"PlainDate">) | {
+        age: number;
+        asOfDateRef: string;
+    } | {
+        start: string & import("zod").BRAND<"PlainDate">;
+        end: string & import("zod").BRAND<"PlainDate">;
+    } | {
+        data: Record<string, string | number | boolean | {
+            type: string;
+            path: string;
+            originalFilename: string;
+        } | {
+            firstname: string;
+            surname: string;
+            middlename?: string | undefined;
+        } | {
+            firstname?: string | null | undefined;
+            surname?: string | null | undefined;
+            middlename?: string | null | undefined;
+        } | {
+            country: string;
+            addressType: "DOMESTIC";
+            administrativeArea: string;
+            streetLevelDetails?: Record<string, string> | undefined;
+        } | {
+            country: string;
+            addressType: "INTERNATIONAL";
+            streetLevelDetails?: Record<string, string> | undefined;
+        } | {
+            type: string;
+            option: string;
+            path: string;
+            originalFilename: string;
+        }[] | {
+            loading: boolean;
+            data?: any;
+            error?: {
+                message: string;
+                statusCode: number;
+            } | null | undefined;
+        } | {
+            data: Record<string, string>;
+        } | {
+            data?: any;
+        } | {
+            numericValue: number;
+            unit: string;
+        } | {
+            numericValue?: number | undefined;
+            unit?: string | undefined;
+        } | (string & import("zod").BRAND<"PlainDate">) | {
+            age: number;
+            asOfDateRef: string;
+        } | {
+            start: string & import("zod").BRAND<"PlainDate">;
+            end: string & import("zod").BRAND<"PlainDate">;
+        } | null | undefined>;
+    } | null | undefined;
+}>;
+/**
+ * Merges two documents together.
+ *
+ * @example deepMerge({'review.signature': { path: '/path.png', type: 'image/png' }}, { foo: 'bar'}) } => { 'review.signature': { path: '/path.png', type: 'image/png' }, foo: 'bar' }
+ *
+ * NOTE: When merging deep objects, the values from the second object will override the first one.
+ * @example { annotation: {'review.signature': { path: '/path.png', type: 'image/png' }}, { annotation: { foo: 'bar'}) } } => { annotation: { foo: 'bar' } }
+ */
+export declare function deepMerge<T extends Record<string, unknown>, K extends Record<string, unknown>>(currentDocument: T, actionDocument: K): T & K;
+export declare function findLastAssignmentAction(actions: Action[]): Action | undefined;
+/** Tell compiler that accessing record with arbitrary key might result to undefined
+ * Use when you **cannot guarantee**  that key exists in the record
+ */
+export type IndexMap<T> = {
+    [id: string]: T | undefined;
+};
+export declare function isWriteAction(actionType: ActionType): boolean;
+/**
+ * @returns All the fields in the event configuration.
+ */
+export declare const findAllFields: (config: EventConfig) => FieldConfig[];
+/**
+ * Returns the value of the object at the given path with the ability of resolving mixed paths. See examples.
+ *
+ * @param obj Entity we want to get the value from
+ * @param path property path e.g. `a.b.c`
+ * @param defaultValue
+ * @returns the value of the object at the given path.
+ */
+export declare function getMixedPath<T = unknown>(obj: Record<string, unknown>, path: string, defaultValue?: T | undefined): T | undefined;
+export declare function getEventConfigById(eventConfigs: EventConfig[], id: string): {
+    id: string;
+    title: import("./TranslationConfig").TranslationConfig;
+    declaration: {
+        label: import("./TranslationConfig").TranslationConfig;
+        pages: {
+            type: "FORM";
+            id: string;
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: FieldConfig[];
+            requireCompletionToContinue: boolean;
+            conditional?: import(".").JSONSchema | undefined;
+        }[];
+    };
+    actions: ({
+        type: "READ";
+        label: import("./TranslationConfig").TranslationConfig;
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: FieldConfig[];
+        };
+    } | {
+        type: "DECLARE";
+        label: import("./TranslationConfig").TranslationConfig;
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: 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: 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: 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: 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: 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: 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: 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;
+};
+export declare function timePeriodToDateRange(value: SelectDateRangeValue): {
+    startDate: string;
+    endDate: string;
+};
+export declare function mergeDrafts(currentDraft: Draft, incomingDraft: Draft): Draft;
+export declare function getPendingAction(actions: Action[]): ActionDocument;
+export declare function getCompleteActionAnnotation(annotation: ActionUpdate, event: EventDocument, action: ActionDocument): ActionUpdate;
+export declare function getCompleteActionDeclaration<T extends EventState | ActionUpdate>(declaration: T, event: EventDocument, action: ActionDocument): T;
+export declare function getAcceptedActions(event: EventDocument): ActionDocument[];
+export declare function aggregateActionDeclarations(event: EventDocument): EventState;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1,3 @@
+import { WorkqueueColumn } from './WorkqueueColumnConfig';
+export declare const defaultWorkqueueColumns: WorkqueueColumn[];
+//# sourceMappingURL=workqueueDefaultColumns.d.ts.map