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

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

@@ -1,4 +1,7 @@
 export declare const FieldType: {
+    readonly NAME: "NAME";
+    readonly PHONE: "PHONE";
+    readonly ID: "ID";
     readonly ADDRESS: "ADDRESS";
     readonly TEXT: "TEXT";
     readonly NUMBER: "NUMBER";
@@ -23,7 +26,7 @@ export declare const FieldType: {
     readonly SIGNATURE: "SIGNATURE";
     readonly DATA: "DATA";
 };
-export declare const fieldTypes: ("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 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.

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

@@ -1,8 +1,8 @@
 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, DataField } 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 { FieldValue, FieldUpdateValueSchema } from './FieldValue';
-import { AddressFieldValue, FileFieldValue, FileFieldWithOptionValue } from './CompositeFieldValue';
+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.
@@ -42,7 +42,55 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     type: string;
     filename: string;
     originalFilename: string;
-}>>> | z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+}>>> | 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;
@@ -158,7 +206,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     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.ZodUndefined | z.ZodOptional<z.ZodNullable<z.ZodUndefined>> | z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
+}>, "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;
@@ -261,6 +309,14 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
         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;
@@ -300,6 +356,14 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
         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;
@@ -324,52 +388,6 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
         originalFilename: string;
     }[] | [string, string] | null | undefined;
 }>;
-/**
- * Quick-and-dirty mock data generator for event actions.
- */
-export declare function mapFieldTypeToMockValue(field: FieldConfig, i: number): string | true | string[] | 19 | {
-    country: string;
-    addressType: "DOMESTIC";
-    province: string;
-    district: string;
-    urbanOrRural: string;
-    town: string;
-    residentialArea: string;
-    street: string;
-    number: string;
-    zipCode: string;
-    filename?: undefined;
-    originalFilename?: undefined;
-    type?: undefined;
-} | {
-    filename: string;
-    originalFilename: string;
-    type: string;
-    country?: undefined;
-    addressType?: undefined;
-    province?: undefined;
-    district?: undefined;
-    urbanOrRural?: undefined;
-    town?: undefined;
-    residentialArea?: undefined;
-    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.
  */
@@ -444,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;
@@ -453,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: {
@@ -563,5 +602,8 @@ export declare const isDataFieldType: (field: {
     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

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { AddressFieldValue, AddressFieldUpdateValue, FileFieldValue, FileFieldWithOptionValue } from './CompositeFieldValue';
+import { AddressFieldValue, AddressFieldUpdateValue, FileFieldValue, FileFieldWithOptionValue, NameFieldValue, NameFieldUpdateValue } from './CompositeFieldValue';
 /**
  * FieldValues defined in this file are primitive field values.
  * FieldValues defined in CompositeFieldValue.ts are composed of multiple primitive field values (Address, File etc).
@@ -25,6 +25,8 @@ 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 SignatureFieldValue: z.ZodString;
+export type SignatureFieldValue = z.infer<typeof SignatureFieldValue>;
 export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
     filename: z.ZodString;
     originalFilename: z.ZodString;
@@ -138,7 +140,31 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnio
     addressLine2?: string | undefined;
     addressLine3?: string | undefined;
     postcodeOrZip?: string | undefined;
-}>]>;
+}>, 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.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]>]>;
 export type FieldValue = z.infer<typeof FieldValue>;
 export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
     filename: z.ZodString;
@@ -253,16 +279,28 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
     addressLine2?: string | null | undefined;
     addressLine3?: string | null | undefined;
     postcodeOrZip?: string | null | undefined;
-}>]>;
+}>, 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]>]>;
 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 | typeof DataFieldValue | z.ZodString | z.ZodBoolean;
+export type FieldValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldValue | typeof NumberFieldValue | typeof DataFieldValue | typeof NameFieldValue | 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 DateRangeFieldValue | typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | typeof DataFieldValue | z.ZodString | z.ZodBoolean;
+export type FieldUpdateValueSchema = typeof DateRangeFieldValue | typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | typeof DataFieldValue | typeof NameFieldValue | typeof NameFieldUpdateValue | z.ZodString | z.ZodBoolean;
 //# sourceMappingURL=FieldValue.d.ts.map