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

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

@@ -21,8 +21,9 @@ 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: ("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" | "DATA")[];
 export type FieldType = (typeof fieldTypes)[number];
 /**
  * Composite field types are field types that consist of multiple field values.

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

@@ -1,5 +1,5 @@
 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 } from './FieldConfig';
 import { FieldType } from './FieldType';
 import { FieldValue, FieldUpdateValueSchema } from './FieldValue';
 import { AddressFieldValue, FileFieldValue, FileFieldWithOptionValue } from './CompositeFieldValue';
@@ -43,7 +43,8 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     filename: string;
     originalFilename: string;
 }>>> | z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodLiteral<string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -56,6 +57,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -66,6 +68,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -74,7 +77,8 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     street?: string | null | undefined;
     zipCode?: string | null | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodLiteral<string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -83,17 +87,20 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }>, "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.ZodEffects<z.ZodString, string, string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
     state: z.ZodString;
     district2: z.ZodString;
     cityOrTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -104,6 +111,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }, "strip", z.ZodTypeAny, {
     country: string;
     state: string;
+    addressType: "INTERNATIONAL";
     district2: string;
     cityOrTown?: string | null | undefined;
     addressLine1?: string | null | undefined;
@@ -113,6 +121,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }, {
     country: string;
     state: string;
+    addressType: "INTERNATIONAL";
     district2: string;
     cityOrTown?: string | null | undefined;
     addressLine1?: string | null | undefined;
@@ -149,8 +158,9 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     option: string;
     filename: string;
     originalFilename: string;
-}>, "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>;
+}>, "many">>> | z.ZodBoolean | z.ZodOptional<z.ZodNullable<z.ZodBoolean>> | z.ZodNumber | z.ZodOptional<z.ZodNullable<z.ZodNumber>> | z.ZodUndefined | 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;
 }, {
@@ -163,6 +173,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -173,6 +184,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -181,7 +193,8 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     street?: string | null | undefined;
     zipCode?: string | null | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodLiteral<string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -190,17 +203,20 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }>, "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.ZodEffects<z.ZodString, string, string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
     state: z.ZodString;
     district2: z.ZodString;
     cityOrTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -211,6 +227,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }, "strip", z.ZodTypeAny, {
     country: string;
     state: string;
+    addressType: "INTERNATIONAL";
     district2: string;
     cityOrTown?: string | null | undefined;
     addressLine1?: string | null | undefined;
@@ -220,6 +237,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 }, {
     country: string;
     state: string;
+    addressType: "INTERNATIONAL";
     district2: string;
     cityOrTown?: string | null | undefined;
     addressLine1?: string | null | undefined;
@@ -235,6 +253,7 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
     } | {
         country: string;
         district: string;
+        addressType: "DOMESTIC";
         province: string;
         urbanOrRural: "URBAN";
         number?: string | null | undefined;
@@ -245,12 +264,14 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
     } | {
         country: string;
         district: string;
+        addressType: "DOMESTIC";
         province: string;
         urbanOrRural: "RURAL";
         village?: string | null | undefined;
     } | {
         country: string;
         state: string;
+        addressType: "INTERNATIONAL";
         district2: string;
         cityOrTown?: string | null | undefined;
         addressLine1?: string | null | undefined;
@@ -271,6 +292,7 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
     } | {
         country: string;
         district: string;
+        addressType: "DOMESTIC";
         province: string;
         urbanOrRural: "URBAN";
         number?: string | null | undefined;
@@ -281,12 +303,14 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
     } | {
         country: string;
         district: string;
+        addressType: "DOMESTIC";
         province: string;
         urbanOrRural: "RURAL";
         village?: string | null | undefined;
     } | {
         country: string;
         state: string;
+        addressType: "INTERNATIONAL";
         district2: string;
         cityOrTown?: string | null | undefined;
         addressLine1?: string | null | undefined;
@@ -305,6 +329,7 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
  */
 export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number): string | true | 19 | {
     country: string;
+    addressType: "DOMESTIC";
     province: string;
     district: string;
     urbanOrRural: string;
@@ -321,6 +346,7 @@ export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number):
     originalFilename: string;
     type: string;
     country?: undefined;
+    addressType?: undefined;
     province?: undefined;
     district?: undefined;
     urbanOrRural?: undefined;
@@ -329,12 +355,27 @@ export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number):
     street?: undefined;
     number?: undefined;
     zipCode?: undefined;
+} | {
+    country?: undefined;
+    addressType?: undefined;
+    province?: undefined;
+    district?: undefined;
+    urbanOrRural?: undefined;
+    town?: undefined;
+    residentialArea?: undefined;
+    street?: undefined;
+    number?: undefined;
+    zipCode?: undefined;
+    filename?: undefined;
+    originalFilename?: undefined;
+    type?: 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;
+    addressType: "DOMESTIC";
     province: null;
     district: null;
     urbanOrRural: string;
@@ -351,6 +392,7 @@ export declare function mapFieldTypeToEmptyValue(field: FieldConfig): never[] |
     originalFilename: string;
     type: string;
     country?: undefined;
+    addressType?: undefined;
     province?: undefined;
     district?: undefined;
     urbanOrRural?: undefined;
@@ -507,5 +549,12 @@ 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 {};
 //# sourceMappingURL=FieldTypeMapping.d.ts.map

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

@@ -13,13 +13,15 @@ import { AddressFieldValue, AddressFieldUpdateValue, FileFieldValue, FileFieldWi
  *
  */
 export declare const TextValue: z.ZodString;
-export declare const RequiredTextValue: z.ZodString;
+export declare const NonEmptyTextValue: z.ZodString;
 export declare const DateValue: z.ZodString;
 export declare const EmailValue: z.ZodString;
 export declare const CheckboxFieldValue: z.ZodBoolean;
 export type CheckboxFieldValue = z.infer<typeof CheckboxFieldValue>;
 export declare const NumberFieldValue: z.ZodNumber;
 export type NumberFieldValue = z.infer<typeof NumberFieldValue>;
+export declare const DataFieldValue: z.ZodUndefined;
+export type DataFieldValue = z.infer<typeof DataFieldValue>;
 export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
     filename: z.ZodString;
     originalFilename: z.ZodString;
@@ -48,7 +50,8 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBool
     filename: string;
     originalFilename: string;
 }>, "many">, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodLiteral<string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -61,6 +64,7 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBool
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -71,6 +75,7 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBool
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | undefined;
@@ -79,7 +84,8 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBool
     street?: string | undefined;
     zipCode?: string | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodLiteral<string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -88,17 +94,20 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBool
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | undefined;
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "RURAL";
     village?: string | undefined;
-}>, z.ZodObject<{
-    country: z.ZodEffects<z.ZodString, string, string>;
+}>, z.ZodUndefined, z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
     state: z.ZodString;
     district2: z.ZodString;
     cityOrTown: z.ZodOptional<z.ZodString>;
@@ -109,6 +118,7 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBool
 }, "strip", z.ZodTypeAny, {
     country: string;
     state: string;
+    addressType: "INTERNATIONAL";
     district2: string;
     cityOrTown?: string | undefined;
     addressLine1?: string | undefined;
@@ -118,6 +128,7 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodBool
 }, {
     country: string;
     state: string;
+    addressType: "INTERNATIONAL";
     district2: string;
     cityOrTown?: string | undefined;
     addressLine1?: string | undefined;
@@ -154,7 +165,8 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
     filename: string;
     originalFilename: string;
 }>, "many">, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodLiteral<string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -167,6 +179,7 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
 }>, "strip", z.ZodTypeAny, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -177,6 +190,7 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
 }, {
     country: string;
     district: string;
+    addressType: "DOMESTIC";
     province: string;
     urbanOrRural: "URBAN";
     number?: string | null | undefined;
@@ -185,7 +199,8 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
     street?: string | null | undefined;
     zipCode?: string | null | undefined;
 }>, z.ZodObject<z.objectUtil.extendShape<{
-    country: z.ZodLiteral<string>;
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"DOMESTIC">;
     province: z.ZodString;
     district: z.ZodString;
 }, {
@@ -194,17 +209,20 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
 }>, "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.ZodEffects<z.ZodString, string, string>;
+}>, z.ZodUndefined, z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodLiteral<"INTERNATIONAL">;
     state: z.ZodString;
     district2: z.ZodString;
     cityOrTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -215,6 +233,7 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
 }, "strip", z.ZodTypeAny, {
     country: string;
     state: string;
+    addressType: "INTERNATIONAL";
     district2: string;
     cityOrTown?: string | null | undefined;
     addressLine1?: string | null | undefined;
@@ -224,6 +243,7 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
 }, {
     country: string;
     state: string;
+    addressType: "INTERNATIONAL";
     district2: string;
     cityOrTown?: string | null | undefined;
     addressLine1?: string | null | undefined;
@@ -235,11 +255,11 @@ export type FieldUpdateValue = z.infer<typeof FieldUpdateValue>;
 /**
  * NOTE: This is an exception. We need schema as a type in order to generate schema dynamically.
  * */
-export type FieldValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldValue | typeof NumberFieldValue | z.ZodString | z.ZodBoolean;
+export type FieldValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldValue | typeof NumberFieldValue | typeof DataFieldValue | z.ZodString | z.ZodBoolean;
 /**
  * NOTE: This is an exception. We need schema as a type in order to generate schema dynamically.
  *
  * FieldValueInputSchema uses Input types which have set optional values as nullish
  * */
-export type FieldUpdateValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | z.ZodString | z.ZodBoolean;
+export type FieldUpdateValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | typeof DataFieldValue | z.ZodString | z.ZodBoolean;
 //# sourceMappingURL=FieldValue.d.ts.map