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

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

@@ -1,16 +1,19 @@
 export declare const FieldType: {
+    readonly NAME: "NAME";
+    readonly PHONE: "PHONE";
+    readonly ID: "ID";
     readonly ADDRESS: "ADDRESS";
     readonly TEXT: "TEXT";
     readonly NUMBER: "NUMBER";
     readonly TEXTAREA: "TEXTAREA";
     readonly EMAIL: "EMAIL";
     readonly DATE: "DATE";
+    readonly DATE_RANGE: "DATE_RANGE";
     readonly PARAGRAPH: "PARAGRAPH";
     readonly PAGE_HEADER: "PAGE_HEADER";
     readonly RADIO_GROUP: "RADIO_GROUP";
     readonly FILE: "FILE";
     readonly FILE_WITH_OPTIONS: "FILE_WITH_OPTIONS";
-    readonly HIDDEN: "HIDDEN";
     readonly BULLET_LIST: "BULLET_LIST";
     readonly CHECKBOX: "CHECKBOX";
     readonly SELECT: "SELECT";
@@ -21,7 +24,12 @@ export declare const FieldType: {
     readonly FACILITY: "FACILITY";
     readonly OFFICE: "OFFICE";
     readonly SIGNATURE: "SIGNATURE";
+    readonly DATA: "DATA";
 };
-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 declare const fieldTypes: ("ID" | "NAME" | "PHONE" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "DATE_RANGE" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA")[];
 export type FieldType = (typeof fieldTypes)[number];
+/**
+ * Composite field types are field types that consist of multiple field values.
+ */
+export declare const compositeFieldTypes: ("ADDRESS" | "DATE_RANGE" | "FILE" | "FILE_WITH_OPTIONS")[];
 //# sourceMappingURL=FieldType.d.ts.map

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

@@ -1,18 +1,24 @@
 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 { AddressField, AdministrativeArea, BulletList, Checkbox, Country, DateField, Divider, Facility, EmailField, FieldConfig, File, FileUploadWithOptions, Location, Office, PageHeader, Paragraph, RadioGroup, SelectField, SignatureField, TextAreaField, TextField, NumberField, DataField, NameField, PhoneField, IdField } from './FieldConfig';
 import { FieldType } from './FieldType';
-import { AddressFieldValue, FieldValue, FieldValueSchema, FileFieldValue, FileFieldWithOptionValue, OptionalFieldValueSchema } from './FieldValue';
+import { FieldValue, FieldUpdateValueSchema } from './FieldValue';
+import { AddressFieldValue, FileFieldValue, FileFieldWithOptionValue, NameFieldValue } 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;
@@ -24,57 +30,153 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     type: string;
     filename: string;
     originalFilename: string;
-}>> | z.ZodOptional<z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+}> | z.ZodOptional<z.ZodNullable<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.ZodObject<{
+    firstname: z.ZodString;
+    surname: z.ZodString;
+    middlename: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    firstname: string;
+    surname: string;
+    middlename?: string | undefined;
+}, {
+    firstname: string;
+    surname: string;
+    middlename?: string | undefined;
+}> | z.ZodUndefined | z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+    firstname: z.ZodString;
+    surname: z.ZodString;
+    middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    firstname: string;
+    surname: string;
+    middlename?: string | null | undefined;
+}, {
+    firstname: string;
+    surname: string;
+    middlename?: string | null | undefined;
+}>, z.ZodNull]>, z.ZodUndefined]> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    firstname: z.ZodString;
+    surname: z.ZodString;
+    middlename: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    firstname: string;
+    surname: string;
+    middlename?: string | undefined;
+}, {
+    firstname: string;
+    surname: string;
+    middlename?: string | undefined;
+}>>> | z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+    firstname: z.ZodString;
+    surname: z.ZodString;
+    middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    firstname: string;
+    surname: string;
+    middlename?: string | null | undefined;
+}, {
+    firstname: string;
+    surname: string;
+    middlename?: string | null | undefined;
+}>, z.ZodNull]>, z.ZodUndefined]>>> | z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     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;
+    addressType: "DOMESTIC";
     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;
+    addressType: "DOMESTIC";
     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;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     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;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
-    village?: string | undefined;
+    village?: string | null | undefined;
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
-    village?: string | undefined;
-}>]>> | z.ZodOptional<z.ZodArray<z.ZodObject<{
+    village?: string | null | undefined;
+}>]>, z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+    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;
+    addressType: "INTERNATIONAL";
+    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;
+    addressType: "INTERNATIONAL";
+    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;
@@ -89,8 +191,109 @@ 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.ZodOptional<z.ZodNullable<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.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>]> | z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>]>>> | z.ZodBoolean | z.ZodOptional<z.ZodNullable<z.ZodBoolean>> | z.ZodNumber | z.ZodOptional<z.ZodNullable<z.ZodNumber>> | z.ZodOptional<z.ZodNullable<z.ZodUndefined>> | z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
+    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;
+    addressType: "DOMESTIC";
+    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;
+    addressType: "DOMESTIC";
+    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.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
+    province: z.ZodString;
+    district: z.ZodString;
+}, {
+    urbanOrRural: z.ZodLiteral<"RURAL">;
+    village: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}>, "strip", z.ZodTypeAny, {
+    country: string;
+    district: string;
+    addressType: "DOMESTIC";
+    province: string;
+    urbanOrRural: "RURAL";
+    village?: string | null | undefined;
+}, {
+    country: string;
+    district: string;
+    addressType: "DOMESTIC";
+    province: string;
+    urbanOrRural: "RURAL";
+    village?: string | null | undefined;
+}>]>, z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
+    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;
+    addressType: "INTERNATIONAL";
+    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;
+    addressType: "INTERNATIONAL";
+    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;
@@ -98,25 +301,45 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
     } | {
         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;
+        number?: string | null | undefined;
+        town?: string | null | undefined;
+        residentialArea?: string | null | undefined;
+        street?: string | null | undefined;
+        zipCode?: string | null | undefined;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | null | undefined;
     } | {
         country: string;
         district: string;
+        addressType: "DOMESTIC";
         province: string;
         urbanOrRural: "RURAL";
-        village?: string | undefined;
+        village?: string | null | undefined;
+    } | {
+        country: string;
+        state: string;
+        addressType: "INTERNATIONAL";
+        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;
+    }[] | [string, string] | null | undefined;
 }, {
     [x: string]: string | number | boolean | {
         type: string;
@@ -125,39 +348,60 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
     } | {
         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;
+        number?: string | null | undefined;
+        town?: string | null | undefined;
+        residentialArea?: string | null | undefined;
+        street?: string | null | undefined;
+        zipCode?: string | null | undefined;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | null | undefined;
     } | {
         country: string;
         district: string;
+        addressType: "DOMESTIC";
         province: string;
         urbanOrRural: "RURAL";
-        village?: string | undefined;
+        village?: string | null | undefined;
+    } | {
+        country: string;
+        state: string;
+        addressType: "INTERNATIONAL";
+        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;
+    }[] | [string, string] | null | undefined;
 }>;
 /**
- * Quick-and-dirty mock data generator for event actions.
+ * Maps complex or nested field types, such as Address fields, to their corresponding empty values.
  */
-export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number): string | true | 19 | {
-    country: string;
-    province: string;
-    district: string;
+export declare function mapFieldTypeToEmptyValue(field: FieldConfig): never[] | {
+    country: null;
+    addressType: "DOMESTIC";
+    province: null;
+    district: null;
     urbanOrRural: string;
-    town: string;
-    residentialArea: string;
-    street: string;
-    number: string;
-    zipCode: string;
+    town: null;
+    residentialArea: null;
+    street: null;
+    number: null;
+    zipCode: null;
     filename?: undefined;
     originalFilename?: undefined;
     type?: undefined;
@@ -166,6 +410,7 @@ export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number):
     originalFilename: string;
     type: string;
     country?: undefined;
+    addressType?: undefined;
     province?: undefined;
     district?: undefined;
     urbanOrRural?: undefined;
@@ -189,6 +434,13 @@ export declare const isDateFieldType: (field: {
     value: string;
     config: DateField;
 };
+export declare const isDateRangeFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: DateField;
+};
 export declare const isPageHeaderFieldType: (field: {
     config: FieldConfig;
     value: FieldValue;
@@ -210,6 +462,27 @@ export declare const isNumberFieldType: (field: {
     value: number;
     config: NumberField;
 };
+export declare const isNameFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: NameFieldValue;
+    config: NameField;
+};
+export declare const isPhoneFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: PhoneField;
+};
+export declare const isIdFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: IdField;
+};
 export declare const isTextAreaFieldType: (field: {
     config: FieldConfig;
     value: FieldValue;
@@ -219,9 +492,9 @@ export declare const isTextAreaFieldType: (field: {
 };
 export declare const isSignatureFieldType: (field: {
     config: FieldConfig;
-    value: FieldValue;
+    value: FieldValue | undefined;
 }) => field is {
-    value: string;
+    value: FileFieldValue | undefined;
     config: SignatureField;
 };
 export declare const isEmailFieldType: (field: {
@@ -322,4 +595,15 @@ export declare const isOfficeFieldType: (field: {
     value: string;
     config: Office;
 };
+export declare const isDataFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: undefined;
+    config: DataField;
+};
+export type NonInteractiveFieldType = Divider | PageHeader | Paragraph | BulletList | DataField;
+export type InteractiveFieldType = Exclude<FieldConfig, NonInteractiveFieldType>;
+export declare const isNonInteractiveFieldType: (field: FieldConfig) => field is NonInteractiveFieldType;
+export {};
 //# sourceMappingURL=FieldTypeMapping.d.ts.map