@opencrvs/toolkit 1.8.0-rc.fc43738 → 1.8.0-rc.fd6feaa

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

@@ -16,7 +16,7 @@ export declare const EventIndex: z.ZodObject<z.objectUtil.extendShape<{
     createdBy: z.ZodString;
     createdAtLocation: z.ZodString;
     modifiedAt: z.ZodString;
-    assignedTo: z.ZodNullable<z.ZodString>;
+    assignedTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     updatedBy: z.ZodString;
     trackingId: z.ZodString;
 }, {
@@ -29,10 +29,10 @@ export declare const EventIndex: z.ZodObject<z.objectUtil.extendShape<{
     createdAt: string;
     createdBy: string;
     createdAtLocation: string;
-    assignedTo: string | null;
     trackingId: string;
     modifiedAt: string;
     updatedBy: string;
+    assignedTo?: string | null | undefined;
 }, {
     type: string;
     id: string;
@@ -41,10 +41,10 @@ export declare const EventIndex: z.ZodObject<z.objectUtil.extendShape<{
     createdAt: string;
     createdBy: string;
     createdAtLocation: string;
-    assignedTo: string | null;
     trackingId: string;
     modifiedAt: string;
     updatedBy: string;
+    assignedTo?: string | null | undefined;
 }>;
 export declare const EventSearchIndex: z.ZodIntersection<z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodObject<{
     type: z.ZodString;

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

@@ -47,7 +47,7 @@ export declare const EventMetadata: z.ZodObject<{
     createdBy: z.ZodString;
     createdAtLocation: z.ZodString;
     modifiedAt: z.ZodString;
-    assignedTo: z.ZodNullable<z.ZodString>;
+    assignedTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     updatedBy: z.ZodString;
     trackingId: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -57,10 +57,10 @@ export declare const EventMetadata: z.ZodObject<{
     createdAt: string;
     createdBy: string;
     createdAtLocation: string;
-    assignedTo: string | null;
     trackingId: string;
     modifiedAt: string;
     updatedBy: string;
+    assignedTo?: string | null | undefined;
 }, {
     type: string;
     id: string;
@@ -68,10 +68,10 @@ export declare const EventMetadata: z.ZodObject<{
     createdAt: string;
     createdBy: string;
     createdAtLocation: string;
-    assignedTo: string | null;
     trackingId: string;
     modifiedAt: string;
     updatedBy: string;
+    assignedTo?: string | null | undefined;
 }>;
 export type EventMetadata = z.infer<typeof EventMetadata>;
 export type EventMetadataKeys = `event.${keyof EventMetadata}`;

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

@@ -1170,6 +1170,8 @@ declare const DateField: z.ZodObject<z.objectUtil.extendShape<{
     } | undefined;
 }>;
 export type DateField = z.infer<typeof DateField>;
+declare const HtmlFontVariant: z.ZodEnum<["reg12", "reg14", "reg16", "reg18", "h4", "h3", "h2", "h1"]>;
+export type HtmlFontVariant = z.infer<typeof HtmlFontVariant>;
 declare const Paragraph: z.ZodObject<z.objectUtil.extendShape<{
     id: z.ZodString;
     defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodString, z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.ZodObject<{
@@ -2317,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;
@@ -3047,8 +3050,8 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
     hideLabel: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
 }, {
     type: z.ZodLiteral<"ADDRESS">;
-    defaultValue: z.ZodOptional<z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
-        country: z.ZodString;
+    defaultValue: z.ZodOptional<z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+        country: z.ZodLiteral<string>;
         province: z.ZodString;
         district: z.ZodString;
     }, {
@@ -3079,7 +3082,7 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
         street?: string | undefined;
         zipCode?: string | undefined;
     }>, z.ZodObject<z.objectUtil.extendShape<{
-        country: z.ZodString;
+        country: z.ZodLiteral<string>;
         province: z.ZodString;
         district: z.ZodString;
     }, {
@@ -3097,6 +3100,33 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
         province: string;
         urbanOrRural: "RURAL";
         village?: string | undefined;
+    }>]>, z.ZodObject<{
+        country: z.ZodEffects<z.ZodString, string, string>;
+        state: z.ZodString;
+        district2: z.ZodString;
+        cityOrTown: z.ZodOptional<z.ZodString>;
+        addressLine1: z.ZodOptional<z.ZodString>;
+        addressLine2: z.ZodOptional<z.ZodString>;
+        addressLine3: z.ZodOptional<z.ZodString>;
+        postcodeOrZip: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        country: string;
+        state: string;
+        district2: string;
+        cityOrTown?: string | undefined;
+        addressLine1?: string | undefined;
+        addressLine2?: string | undefined;
+        addressLine3?: string | undefined;
+        postcodeOrZip?: string | undefined;
+    }, {
+        country: string;
+        state: string;
+        district2: string;
+        cityOrTown?: string | undefined;
+        addressLine1?: string | undefined;
+        addressLine2?: string | undefined;
+        addressLine3?: string | undefined;
+        postcodeOrZip?: string | undefined;
     }>]>>;
 }>, "strip", z.ZodTypeAny, {
     type: "ADDRESS";
@@ -3124,6 +3154,15 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
         province: string;
         urbanOrRural: "RURAL";
         village?: string | undefined;
+    } | {
+        country: string;
+        state: string;
+        district2: string;
+        cityOrTown?: string | undefined;
+        addressLine1?: string | undefined;
+        addressLine2?: string | undefined;
+        addressLine3?: string | undefined;
+        postcodeOrZip?: string | undefined;
     } | undefined;
     conditionals?: ({
         type: "SHOW";
@@ -3170,6 +3209,15 @@ declare const Address: z.ZodObject<z.objectUtil.extendShape<{
         province: string;
         urbanOrRural: "RURAL";
         village?: string | undefined;
+    } | {
+        country: string;
+        state: string;
+        district2: string;
+        cityOrTown?: string | undefined;
+        addressLine1?: string | undefined;
+        addressLine2?: string | undefined;
+        addressLine3?: string | undefined;
+        postcodeOrZip?: string | undefined;
     } | undefined;
     conditionals?: ({
         type: "SHOW";

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

@@ -1,18 +1,36 @@
 import { z } from 'zod';
 import { AddressField, AdministrativeArea, BulletList, Checkbox, Country, DateField, Divider, Facility, EmailField, FieldConfig, File, FileUploadWithOptions, Location, Office, PageHeader, Paragraph, RadioGroup, SelectField, SignatureField, TextAreaField, TextField, NumberField } from './FieldConfig';
 import { FieldType } from './FieldType';
-import { AddressFieldValue, FieldValue, FieldValueSchema, FileFieldValue, FileFieldWithOptionValue, OptionalFieldValueSchema } from './FieldValue';
+import { FieldValue, FieldUpdateValueSchema } from './FieldValue';
+import { AddressFieldValue, FileFieldValue, FileFieldWithOptionValue } from './CompositeFieldValue';
 /**
  * FieldTypeMapping.ts should include functions that map field types to different formats dynamically.
  * File is separated from FieldType and FieldConfig to avoid circular dependencies.
  *
  * We can move the specific mapFieldTypeTo* functions where they are used once the core fields are implemented.
  */
+/**
+ * Optionality of a field is defined in FieldConfig, not in FieldValue.
+ * Allows for nullishness of a field value during validations based on FieldConfig.
+ */
+type NullishFieldValueSchema = z.ZodOptional<z.ZodNullable<FieldUpdateValueSchema>>;
 /**
  * Mapping of field types to Zod schema.
  * Useful for building dynamic validations against FieldConfig
  */
-export declare function mapFieldTypeToZod(type: FieldType, required?: boolean): z.ZodOptional<z.ZodString> | z.ZodOptional<z.ZodObject<{
+export declare function mapFieldTypeToZod(type: FieldType, required?: boolean): z.ZodString | z.ZodOptional<z.ZodNullable<z.ZodString>> | z.ZodObject<{
+    filename: z.ZodString;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    filename: string;
+    originalFilename: string;
+}, {
+    type: string;
+    filename: string;
+    originalFilename: string;
+}> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
     filename: z.ZodString;
     originalFilename: z.ZodString;
     type: z.ZodString;
@@ -24,57 +42,99 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     type: string;
     filename: string;
     originalFilename: string;
-}>> | z.ZodOptional<z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodString;
+}>>> | z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodLiteral<string>;
     province: z.ZodString;
     district: z.ZodString;
 }, {
     urbanOrRural: z.ZodLiteral<"URBAN">;
-    town: z.ZodOptional<z.ZodString>;
-    residentialArea: z.ZodOptional<z.ZodString>;
-    street: z.ZodOptional<z.ZodString>;
-    number: z.ZodOptional<z.ZodString>;
-    zipCode: z.ZodOptional<z.ZodString>;
+    town: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    residentialArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    street: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    number: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    zipCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
     province: string;
     urbanOrRural: "URBAN";
-    number?: string | undefined;
-    town?: string | undefined;
-    residentialArea?: string | undefined;
-    street?: string | undefined;
-    zipCode?: string | undefined;
+    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: "URBAN";
-    number?: string | undefined;
-    town?: string | undefined;
-    residentialArea?: string | undefined;
-    street?: string | undefined;
-    zipCode?: string | undefined;
+    number?: string | null | undefined;
+    town?: string | null | undefined;
+    residentialArea?: string | null | undefined;
+    street?: string | null | undefined;
+    zipCode?: string | null | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodString;
+    country: z.ZodLiteral<string>;
     province: z.ZodString;
     district: z.ZodString;
 }, {
     urbanOrRural: z.ZodLiteral<"RURAL">;
-    village: z.ZodOptional<z.ZodString>;
+    village: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
     province: string;
     urbanOrRural: "RURAL";
-    village?: string | undefined;
+    village?: string | null | undefined;
 }, {
     country: string;
     district: string;
     province: string;
     urbanOrRural: "RURAL";
-    village?: string | undefined;
-}>]>> | z.ZodOptional<z.ZodArray<z.ZodObject<{
+    village?: string | null | undefined;
+}>]>, z.ZodObject<{
+    country: z.ZodEffects<z.ZodString, string, string>;
+    state: z.ZodString;
+    district2: z.ZodString;
+    cityOrTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine3: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    postcodeOrZip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    state: string;
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
+}, {
+    country: string;
+    state: string;
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
+}>]> | z.ZodArray<z.ZodObject<{
+    filename: z.ZodString;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+    option: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    option: string;
+    filename: string;
+    originalFilename: string;
+}, {
+    type: string;
+    option: string;
+    filename: string;
+    originalFilename: string;
+}>, "many"> | z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
     filename: z.ZodString;
     originalFilename: z.ZodString;
     type: z.ZodString;
@@ -89,8 +149,85 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     option: string;
     filename: string;
     originalFilename: string;
-}>, "many">> | z.ZodOptional<z.ZodBoolean> | z.ZodOptional<z.ZodNumber> | FieldValueSchema;
-export declare function createValidationSchema(config: FieldConfig[]): z.ZodObject<Record<string, FieldValueSchema | OptionalFieldValueSchema>, "strip", z.ZodTypeAny, {
+}>, "many">>> | z.ZodBoolean | z.ZodOptional<z.ZodNullable<z.ZodBoolean>> | z.ZodNumber | z.ZodOptional<z.ZodNullable<z.ZodNumber>> | z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodLiteral<string>;
+    province: z.ZodString;
+    district: z.ZodString;
+}, {
+    urbanOrRural: z.ZodLiteral<"URBAN">;
+    town: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    residentialArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    street: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    number: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    zipCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}>, "strip", z.ZodTypeAny, {
+    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: "URBAN";
+    number?: string | null | undefined;
+    town?: string | null | undefined;
+    residentialArea?: string | null | undefined;
+    street?: string | null | undefined;
+    zipCode?: string | null | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodLiteral<string>;
+    province: z.ZodString;
+    district: z.ZodString;
+}, {
+    urbanOrRural: z.ZodLiteral<"RURAL">;
+    village: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}>, "strip", z.ZodTypeAny, {
+    country: string;
+    district: string;
+    province: string;
+    urbanOrRural: "RURAL";
+    village?: string | null | undefined;
+}, {
+    country: string;
+    district: string;
+    province: string;
+    urbanOrRural: "RURAL";
+    village?: string | null | undefined;
+}>]>, z.ZodObject<{
+    country: z.ZodEffects<z.ZodString, string, string>;
+    state: z.ZodString;
+    district2: z.ZodString;
+    cityOrTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    addressLine3: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    postcodeOrZip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    state: string;
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
+}, {
+    country: string;
+    state: string;
+    district2: string;
+    cityOrTown?: string | null | undefined;
+    addressLine1?: string | null | undefined;
+    addressLine2?: string | null | undefined;
+    addressLine3?: string | null | undefined;
+    postcodeOrZip?: string | null | undefined;
+}>]>>>;
+export declare function createValidationSchema(config: FieldConfig[]): z.ZodObject<Record<string, FieldUpdateValueSchema | NullishFieldValueSchema>, "strip", z.ZodTypeAny, {
     [x: string]: string | number | boolean | {
         type: string;
         filename: string;
@@ -100,23 +237,32 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
         district: string;
         province: string;
         urbanOrRural: "URBAN";
-        number?: string | undefined;
-        town?: string | undefined;
-        residentialArea?: string | undefined;
-        street?: string | undefined;
-        zipCode?: string | undefined;
+        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 | undefined;
+        village?: string | null | undefined;
+    } | {
+        country: string;
+        state: string;
+        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;
+    }[] | null | undefined;
 }, {
     [x: string]: string | number | boolean | {
         type: string;
@@ -127,23 +273,32 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
         district: string;
         province: string;
         urbanOrRural: "URBAN";
-        number?: string | undefined;
-        town?: string | undefined;
-        residentialArea?: string | undefined;
-        street?: string | undefined;
-        zipCode?: string | undefined;
+        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 | undefined;
+        village?: string | null | undefined;
+    } | {
+        country: string;
+        state: string;
+        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;
+    }[] | null | undefined;
 }>;
 /**
  * Quick-and-dirty mock data generator for event actions.
@@ -175,6 +330,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;
@@ -322,4 +507,5 @@ export declare const isOfficeFieldType: (field: {
     value: string;
     config: Office;
 };
+export {};
 //# sourceMappingURL=FieldTypeMapping.d.ts.map