@ecrvs/opencrvs-toolkit 1.8.1-rc.a7ee8fb

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

@@ -0,0 +1,501 @@
+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 { Draft } from './Draft';
+import { EventDocument } from './EventDocument';
+import { UUID } from '../uuid';
+import { ActionConfig } from './ActionConfig';
+import { FormConfig } from './FormConfig';
+import { SelectDateRangeValue } from './FieldValue';
+export declare function getDeclarationFields(configuration: EventConfig): FieldConfig[];
+export declare function getDeclarationPages(configuration: EventConfig): {
+    type: "FORM";
+    id: string;
+    title: import("./TranslationConfig").TranslationConfig;
+    fields: FieldConfig[];
+    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[];
+        conditional?: import(".").JSONSchema | undefined;
+    }[];
+};
+export declare function getPrintCertificatePages(configuration: EventConfig): ({
+    type: "FORM";
+    id: string;
+    title: import("./TranslationConfig").TranslationConfig;
+    fields: FieldConfig[];
+    conditional?: import(".").JSONSchema | undefined;
+} | {
+    type: "VERIFICATION";
+    id: string;
+    title: import("./TranslationConfig").TranslationConfig;
+    actions: {
+        verify: {
+            label: import("./TranslationConfig").TranslationConfig;
+        };
+        cancel: {
+            label: import("./TranslationConfig").TranslationConfig;
+            confirmation: {
+                title: import("./TranslationConfig").TranslationConfig;
+                body: import("./TranslationConfig").TranslationConfig;
+            };
+        };
+    };
+    fields: FieldConfig[];
+    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): boolean;
+export declare function omitHiddenFields<T extends EventState | ActionUpdate>(fields: FieldConfig[], values: T, visibleVerificationPageIds?: string[]): Partial<T>;
+export declare function omitHiddenPaginatedFields(formConfig: FormConfig, declaration: EventState): Partial<Record<string, string | number | boolean | {
+    type: string;
+    path: string;
+    originalFilename: string;
+} | {
+    firstname: string;
+    surname: string;
+    middlename?: string | undefined;
+} | {
+    firstname: string;
+    surname: string;
+    middlename?: string | null | undefined;
+} | Record<string, string> | {
+    country: string;
+    addressType: "DOMESTIC" | "INTERNATIONAL";
+    administrativeArea?: string | undefined;
+    streetLevelDetails?: Record<string, string> | undefined;
+} | {
+    type: string;
+    option: string;
+    path: string;
+    originalFilename: string;
+}[] | {
+    loading: boolean;
+    data?: any;
+    error?: {
+        message: string;
+        statusCode: number;
+    } | null | undefined;
+} | {
+    start: string;
+    end: string;
+} | null | undefined>>;
+/**
+ *
+ * @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): string[];
+export declare function getActionVerificationPageIds(actionConfig: ActionConfig, annotation: ActionUpdate): string[];
+export declare function omitHiddenAnnotationFields(actionConfig: ActionConfig, declaration: EventState, annotation: ActionUpdate): Partial<{
+    [x: string]: string | number | boolean | {
+        type: string;
+        path: string;
+        originalFilename: string;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | null | undefined;
+    } | Record<string, string> | {
+        country: string;
+        addressType: "DOMESTIC" | "INTERNATIONAL";
+        administrativeArea?: string | undefined;
+        streetLevelDetails?: Record<string, string> | undefined;
+    } | {
+        country: string;
+        addressType: "DOMESTIC" | "INTERNATIONAL";
+        administrativeArea?: string | null | undefined;
+        streetLevelDetails?: Record<string, string> | 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;
+    } | {
+        start: string;
+        end: string;
+    } | 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[];
+            conditional?: import(".").JSONSchema | undefined;
+        }[];
+    };
+    actions: ({
+        type: "READ";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: FieldConfig[];
+        };
+        draft?: boolean | undefined;
+    } | {
+        type: "DECLARE";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: FieldConfig[];
+        };
+        draft?: boolean | undefined;
+        deduplication?: {
+            id: string;
+            label: import("./TranslationConfig").TranslationConfig;
+            query: import("./DeduplicationConfig").ClauseOutput;
+        } | undefined;
+    } | {
+        type: "VALIDATE";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: FieldConfig[];
+        };
+        draft?: boolean | undefined;
+        deduplication?: {
+            id: string;
+            label: import("./TranslationConfig").TranslationConfig;
+            query: import("./DeduplicationConfig").ClauseOutput;
+        } | undefined;
+    } | {
+        type: "REGISTER";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        review: {
+            title: import("./TranslationConfig").TranslationConfig;
+            fields: FieldConfig[];
+        };
+        draft?: boolean | undefined;
+        deduplication?: {
+            id: string;
+            label: import("./TranslationConfig").TranslationConfig;
+            query: import("./DeduplicationConfig").ClauseOutput;
+        } | undefined;
+    } | {
+        type: "REJECT";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        draft?: boolean | undefined;
+    } | {
+        type: "ARCHIVE";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        draft?: boolean | undefined;
+    } | {
+        type: "DELETE";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        draft?: boolean | undefined;
+    } | {
+        type: "PRINT_CERTIFICATE";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        printForm: {
+            label: import("./TranslationConfig").TranslationConfig;
+            pages: ({
+                type: "FORM";
+                id: string;
+                title: import("./TranslationConfig").TranslationConfig;
+                fields: FieldConfig[];
+                conditional?: import(".").JSONSchema | undefined;
+            } | {
+                type: "VERIFICATION";
+                id: string;
+                title: import("./TranslationConfig").TranslationConfig;
+                actions: {
+                    verify: {
+                        label: import("./TranslationConfig").TranslationConfig;
+                    };
+                    cancel: {
+                        label: import("./TranslationConfig").TranslationConfig;
+                        confirmation: {
+                            title: import("./TranslationConfig").TranslationConfig;
+                            body: import("./TranslationConfig").TranslationConfig;
+                        };
+                    };
+                };
+                fields: FieldConfig[];
+                conditional?: import(".").JSONSchema | undefined;
+            })[];
+        };
+        draft?: boolean | undefined;
+    } | {
+        type: "REQUEST_CORRECTION";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        correctionForm: {
+            label: import("./TranslationConfig").TranslationConfig;
+            pages: ({
+                type: "FORM";
+                id: string;
+                title: import("./TranslationConfig").TranslationConfig;
+                fields: FieldConfig[];
+                conditional?: import(".").JSONSchema | undefined;
+            } | {
+                type: "VERIFICATION";
+                id: string;
+                title: import("./TranslationConfig").TranslationConfig;
+                actions: {
+                    verify: {
+                        label: import("./TranslationConfig").TranslationConfig;
+                    };
+                    cancel: {
+                        label: import("./TranslationConfig").TranslationConfig;
+                        confirmation: {
+                            title: import("./TranslationConfig").TranslationConfig;
+                            body: import("./TranslationConfig").TranslationConfig;
+                        };
+                    };
+                };
+                fields: FieldConfig[];
+                conditional?: import(".").JSONSchema | undefined;
+            })[];
+        };
+        draft?: boolean | undefined;
+    } | {
+        type: "REJECT_CORRECTION";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        draft?: boolean | undefined;
+    } | {
+        type: "APPROVE_CORRECTION";
+        label: import("./TranslationConfig").TranslationConfig;
+        conditionals: ({
+            type: "SHOW";
+            conditional: import(".").JSONSchema;
+        } | {
+            type: "ENABLE";
+            conditional: import(".").JSONSchema;
+        })[];
+        draft?: boolean | undefined;
+    })[];
+    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";
+            };
+            fieldId: string;
+            fieldType: "field";
+            options?: {
+                value: string;
+                label: string | 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";
+            };
+            fieldId: "event.trackingId" | "event.status" | "event.legalStatuses.REGISTERED.acceptedAt" | "event.legalStatuses.REGISTERED.createdAtLocation" | "event.updatedAt";
+            fieldType: "event";
+            options?: {
+                value: string;
+                label: string | 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[] | undefined;
+    } | 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: EventState, event: EventDocument, action: ActionDocument): EventState;
+export declare function getCompleteActionDeclaration(declaration: EventState, event: EventDocument, action: ActionDocument): EventState;
+export declare function getAcceptedActions(event: EventDocument): ActionDocument[];
+export declare function aggregateActionDeclarations(event: EventDocument, config: EventConfig): 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