@opencrvs/toolkit 1.8.0-rc.f8f3eb3 → 1.8.0-rc.fa72fdf

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

@@ -285,7 +285,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
         draft?: boolean | undefined;
     } | {
         type: "REJECT";
-        comment: string;
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -311,11 +310,9 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
     } | {
         type: "MARKED_AS_DUPLICATE";
-        comment: string;
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -341,11 +338,9 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        duplicates: string[];
         draft?: boolean | undefined;
     } | {
-        type: "ARCHIVED";
-        comment: string;
+        type: "ARCHIVE";
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -371,7 +366,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
     } | {
         type: "REGISTER";
@@ -714,7 +708,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
         })[] | undefined;
     } | {
         type: "REJECT";
-        comment: string;
         label: {
             id: string;
             description: string;
@@ -753,7 +746,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
             };
             active?: boolean | undefined;
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
         conditionals?: ({
             type: "SHOW";
@@ -764,7 +756,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
         })[] | undefined;
     } | {
         type: "MARKED_AS_DUPLICATE";
-        comment: string;
         label: {
             id: string;
             description: string;
@@ -803,7 +794,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
             };
             active?: boolean | undefined;
         }[];
-        duplicates: string[];
         draft?: boolean | undefined;
         conditionals?: ({
             type: "SHOW";
@@ -813,8 +803,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
             conditional: import(".").JSONSchema;
         })[] | undefined;
     } | {
-        type: "ARCHIVED";
-        comment: string;
+        type: "ARCHIVE";
         label: {
             id: string;
             description: string;
@@ -853,7 +842,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
             };
             active?: boolean | undefined;
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
         conditionals?: ({
             type: "SHOW";
@@ -1343,7 +1331,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
         draft?: boolean | undefined;
     } | {
         type: "REJECT";
-        comment: string;
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -1369,11 +1356,9 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
     } | {
         type: "MARKED_AS_DUPLICATE";
-        comment: string;
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -1399,11 +1384,9 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        duplicates: string[];
         draft?: boolean | undefined;
     } | {
-        type: "ARCHIVED";
-        comment: string;
+        type: "ARCHIVE";
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -1429,7 +1412,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
     } | {
         type: "REGISTER";
@@ -1772,7 +1754,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
         })[] | undefined;
     } | {
         type: "REJECT";
-        comment: string;
         label: {
             id: string;
             description: string;
@@ -1811,7 +1792,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
             };
             active?: boolean | undefined;
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
         conditionals?: ({
             type: "SHOW";
@@ -1822,7 +1802,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
         })[] | undefined;
     } | {
         type: "MARKED_AS_DUPLICATE";
-        comment: string;
         label: {
             id: string;
             description: string;
@@ -1861,7 +1840,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
             };
             active?: boolean | undefined;
         }[];
-        duplicates: string[];
         draft?: boolean | undefined;
         conditionals?: ({
             type: "SHOW";
@@ -1871,8 +1849,7 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
             conditional: import(".").JSONSchema;
         })[] | undefined;
     } | {
-        type: "ARCHIVED";
-        comment: string;
+        type: "ARCHIVE";
         label: {
             id: string;
             description: string;
@@ -1911,7 +1888,6 @@ export declare const EventConfig: z.ZodEffects<z.ZodObject<{
             };
             active?: boolean | undefined;
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
         conditionals?: ({
             type: "SHOW";

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

@@ -1282,9 +1282,9 @@ export declare const EventDocument: z.ZodObject<{
         }>]>>>;
         createdAtLocation: z.ZodString;
     }, {
-        type: z.ZodLiteral<"ARCHIVED">;
+        type: z.ZodLiteral<"ARCHIVE">;
     }>, "strip", z.ZodTypeAny, {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         id: string;
         data: Record<string, string | number | boolean | {
             type: string;
@@ -1342,7 +1342,7 @@ export declare const EventDocument: z.ZodObject<{
             originalFilename: string;
         }[]> | undefined;
     }, {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         id: string;
         data: Record<string, string | number | boolean | {
             type: string;
@@ -4636,7 +4636,7 @@ export declare const EventDocument: z.ZodObject<{
             originalFilename: string;
         }[]> | undefined;
     } | {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         id: string;
         data: Record<string, string | number | boolean | {
             type: string;
@@ -5520,7 +5520,7 @@ export declare const EventDocument: z.ZodObject<{
             originalFilename: string;
         }[]> | undefined;
     } | {
-        type: "ARCHIVED";
+        type: "ARCHIVE";
         id: string;
         data: Record<string, string | number | boolean | {
             type: string;

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

@@ -2319,6 +2319,7 @@ declare const Country: z.ZodObject<z.objectUtil.extendShape<{
     hideLabel?: boolean | undefined;
 }>;
 export type Country = z.infer<typeof Country>;
+export declare const AdministrativeAreas: z.ZodEnum<["ADMIN_STRUCTURE", "HEALTH_FACILITY", "CRVS_OFFICE"]>;
 declare const AdministrativeAreaConfiguration: z.ZodObject<{
     partOf: z.ZodOptional<z.ZodObject<{
         $data: z.ZodString;

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

@@ -24,4 +24,8 @@ export declare const FieldType: {
 };
 export declare const fieldTypes: ("ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "HIDDEN" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE")[];
 export type FieldType = (typeof fieldTypes)[number];
+/**
+ * Composite field types are field types that consist of multiple field values.
+ */
+export declare const compositeFieldTypes: ("ADDRESS" | "FILE" | "FILE_WITH_OPTIONS")[];
 //# sourceMappingURL=FieldType.d.ts.map

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

@@ -258,6 +258,36 @@ export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number):
     number?: undefined;
     zipCode?: undefined;
 } | null;
+/**
+ * Maps complex or nested field types, such as Address fields, to their corresponding empty values.
+ */
+export declare function mapFieldTypeToEmptyValue(field: FieldConfig): never[] | {
+    country: null;
+    province: null;
+    district: null;
+    urbanOrRural: string;
+    town: null;
+    residentialArea: null;
+    street: null;
+    number: null;
+    zipCode: null;
+    filename?: undefined;
+    originalFilename?: undefined;
+    type?: undefined;
+} | {
+    filename: string;
+    originalFilename: string;
+    type: string;
+    country?: undefined;
+    province?: undefined;
+    district?: undefined;
+    urbanOrRural?: undefined;
+    town?: undefined;
+    residentialArea?: undefined;
+    street?: undefined;
+    number?: undefined;
+    zipCode?: undefined;
+} | null;
 export declare const isParagraphFieldType: (field: {
     config: FieldConfig;
     value: FieldValue;

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

@@ -0,0 +1,38 @@
+/**
+ * TemplateConfig defines configuration rules for system-based variables (e.g. $user.province).
+ * They are currently used for providing default values in FieldConfig.
+ */
+import { FieldValue } from './FieldValue';
+/**
+ * Available system variables for configuration.
+ */
+export interface MetaFields {
+    $user: {
+        province: string;
+        district: string;
+    };
+}
+/**
+ * Recursively flatten the keys of an object. Used to limit types when configuring default values in country config.
+ * @example
+ * type Test = FlattenedKeyStrings<{ a: { b: string, c: { d: string } } }>
+ * // 'a.b' | 'a.c.d' but not 'a' or 'a.c'
+ */
+type FlattenedKeyStrings<T, Prefix extends string = ''> = {
+    [K in keyof T]: T[K] extends Record<string, any> ? FlattenedKeyStrings<T[K], `${Prefix}${K & string}.`> : `${Prefix}${K & string}`;
+}[keyof T];
+export type FlattenedMetaFields = FlattenedKeyStrings<MetaFields>;
+/**
+ * Default value for a field when configuring a form.
+ */
+export type FieldConfigDefaultValue = FieldValue | FlattenedMetaFields | Record<string, FlattenedMetaFields | FieldValue>;
+export declare function isTemplateVariable(value: FieldConfigDefaultValue): value is FlattenedMetaFields;
+export declare function isFieldValue(value: FieldConfigDefaultValue): value is FieldValue;
+/**
+ * Checks if given value is valid for a field, and known template variables are already resolved.
+ * @todo: Extend functionality to arbitrary depth objects. Currently only checks first level since our compoosite fields are only 1 level deep.
+ */
+export declare function isFieldValueWithoutTemplates(value: FieldConfigDefaultValue): value is FieldValue;
+export declare function isFieldConfigDefaultValue(value: any): value is FieldConfigDefaultValue;
+export {};
+//# sourceMappingURL=TemplateConfig.d.ts.map

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

@@ -63,7 +63,6 @@ export declare const defineConfig: (config: EventConfigInput) => {
         draft?: boolean | undefined;
     } | {
         type: "REJECT";
-        comment: string;
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -89,11 +88,9 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
     } | {
         type: "MARKED_AS_DUPLICATE";
-        comment: string;
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -119,11 +116,9 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        duplicates: string[];
         draft?: boolean | undefined;
     } | {
-        type: "ARCHIVED";
-        comment: string;
+        type: "ARCHIVE";
         conditionals: ({
             type: "SHOW";
             conditional: import(".").JSONSchema;
@@ -149,7 +144,6 @@ export declare const defineConfig: (config: EventConfigInput) => {
                 fields: import("./FieldConfig").Inferred[];
             };
         }[];
-        isDuplicate: boolean;
         draft?: boolean | undefined;
     } | {
         type: "REGISTER";

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

@@ -28,6 +28,7 @@ export * from './FieldTypeMapping';
 export * from './Conditional';
 export * from './AdvancedSearchConfig';
 export * from './test.utils';
+export * from './TemplateConfig';
 export * from '../conditionals/conditionals';
 export * from '../conditionals/validate';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1,5 +1,5 @@
 import { ActionDocument } from './ActionDocument';
-import { ArchivedActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
+import { ArchiveActionInput, DeclareActionInput, RegisterActionInput, RejectDeclarationActionInput, RequestCorrectionActionInput, ValidateActionInput } from './ActionInput';
 import { ActionType } from './ActionType';
 import { Draft } from './Draft';
 import { EventConfig } from './EventConfig';
@@ -192,8 +192,8 @@ export declare const eventPayloadGenerator: {
             duplicates: never[];
             eventId: string;
         };
-        archive: (eventId: string, input?: Partial<Pick<ArchivedActionInput, "transactionId" | "data">>, isDuplicate?: boolean) => {
-            type: "ARCHIVED";
+        archive: (eventId: string, input?: Partial<Pick<ArchiveActionInput, "transactionId" | "data">>, isDuplicate?: boolean) => {
+            type: "ARCHIVE";
             transactionId: string;
             data: Record<string, string | number | boolean | {
                 type: string;

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

@@ -7,6 +7,8 @@ import { FieldConfig } from './FieldConfig';
 import { WorkqueueConfig } from './WorkqueueConfig';
 import { EventState } from './ActionDocument';
 import { FormConfig } from './FormConfig';
+import { Draft } from './Draft';
+import { EventDocument } from './EventDocument';
 /**
  * @returns All the fields in the event configuration input.
  */
@@ -75,6 +77,11 @@ export declare const findActiveActionFormFields: (configuration: EventConfig, ac
  * Returns all fields for the action type, including review fields, if any.
  */
 export declare const findActiveActionFields: (configuration: EventConfig, action: ActionType) => FieldConfig[] | undefined;
+export declare const getActiveActionFormPages: (configuration: EventConfig, action: ActionType) => {
+    id: string;
+    title: TranslationConfig;
+    fields: import("./FieldConfig").Inferred[];
+}[];
 /**
  * Returns all fields for the action type, including review fields, or throws
  */
@@ -106,4 +113,82 @@ export declare function stripHiddenFields(fields: FieldConfig[], data: EventStat
     filename: string;
     originalFilename: string;
 }[]>;
+export declare function findActiveDrafts(event: EventDocument, drafts: Draft[]): {
+    id: string;
+    createdAt: string;
+    eventId: string;
+    transactionId: string;
+    action: {
+        type: ActionType;
+        data: Record<string, string | number | boolean | {
+            type: string;
+            filename: string;
+            originalFilename: string;
+        } | {
+            country: string;
+            district: string;
+            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;
+            province: string;
+            urbanOrRural: "RURAL";
+            village?: string | null | undefined;
+        } | {
+            type: string;
+            option: string;
+            filename: string;
+            originalFilename: string;
+        }[]>;
+        createdAt: string;
+        createdBy: string;
+        createdAtLocation: string;
+        metadata?: Record<string, string | number | boolean | {
+            type: string;
+            filename: string;
+            originalFilename: string;
+        } | {
+            country: string;
+            district: string;
+            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;
+            province: string;
+            urbanOrRural: "RURAL";
+            village?: string | null | undefined;
+        } | {
+            type: string;
+            option: string;
+            filename: string;
+            originalFilename: string;
+        }[]> | undefined;
+    };
+}[];
+export declare function createEmptyDraft(eventId: string, draftId: string, actionType: ActionType): {
+    id: string;
+    eventId: string;
+    createdAt: string;
+    transactionId: import("../uuid").UUID;
+    action: {
+        type: ActionType;
+        data: {};
+        metadata: {};
+        createdAt: string;
+        createdBy: string;
+        createdAtLocation: string;
+    };
+};
 //# sourceMappingURL=utils.d.ts.map