@ecrvs/opencrvs-toolkit 1.8.1-rc.a7ee8fb

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

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+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 SELECT_DATE_RANGE: "SELECT_DATE_RANGE";
+    readonly TIME: "TIME";
+    readonly PARAGRAPH: "PARAGRAPH";
+    readonly PAGE_HEADER: "PAGE_HEADER";
+    readonly RADIO_GROUP: "RADIO_GROUP";
+    readonly FILE: "FILE";
+    readonly FILE_WITH_OPTIONS: "FILE_WITH_OPTIONS";
+    readonly BULLET_LIST: "BULLET_LIST";
+    readonly CHECKBOX: "CHECKBOX";
+    readonly SELECT: "SELECT";
+    readonly COUNTRY: "COUNTRY";
+    readonly LOCATION: "LOCATION";
+    readonly DIVIDER: "DIVIDER";
+    readonly ADMINISTRATIVE_AREA: "ADMINISTRATIVE_AREA";
+    readonly FACILITY: "FACILITY";
+    readonly OFFICE: "OFFICE";
+    readonly SIGNATURE: "SIGNATURE";
+    readonly DATA: "DATA";
+    readonly BUTTON: "BUTTON";
+    readonly HTTP: "HTTP";
+    readonly LINK_BUTTON: "LINK_BUTTON";
+};
+/**
+ * Union of types that handle files. Using common type should help with compiler to know where to add new cases.
+ */
+export declare const FileFieldType: z.ZodEnum<["FILE", "FILE_WITH_OPTIONS", "SIGNATURE"]>;
+export declare const fieldTypes: ("NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "TEXTAREA" | "EMAIL" | "DATE" | "DATE_RANGE" | "SELECT_DATE_RANGE" | "TIME" | "PARAGRAPH" | "PAGE_HEADER" | "RADIO_GROUP" | "FILE" | "FILE_WITH_OPTIONS" | "BULLET_LIST" | "CHECKBOX" | "SELECT" | "COUNTRY" | "LOCATION" | "DIVIDER" | "ADMINISTRATIVE_AREA" | "FACILITY" | "OFFICE" | "SIGNATURE" | "DATA" | "BUTTON" | "HTTP" | "LINK_BUTTON")[];
+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")[];
+export declare const FieldTypesToHideInReview: ("PARAGRAPH" | "PAGE_HEADER" | "BULLET_LIST" | "DIVIDER")[];
+//# sourceMappingURL=FieldType.d.ts.map

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

@@ -0,0 +1,537 @@
+import { z } from 'zod';
+import { AddressField, AdministrativeArea, BulletList, Checkbox, Country, DateField, Divider, Facility, EmailField, FieldConfig, File, FileUploadWithOptions, LocationInput, Office, PageHeader, Paragraph, RadioGroup, SelectField, SignatureField, TextAreaField, TextField, NumberField, DataField, NameField, PhoneField, IdField, DateRangeField, SelectDateRangeField, TimeField, HttpField, ButtonField, LinkButtonField } from './FieldConfig';
+import { FieldType } from './FieldType';
+import { FieldValue, FieldUpdateValueSchema, DateRangeFieldValue, SelectDateRangeValue } from './FieldValue';
+import { FullDocumentPath } from '../documents';
+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.ZodString | z.ZodOptional<z.ZodNullable<z.ZodString>> | z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    path: string;
+    originalFilename: string;
+}, {
+    type: string;
+    path: string;
+    originalFilename: string;
+}> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    path: string;
+    originalFilename: string;
+}, {
+    type: string;
+    path: 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.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodEnum<["DOMESTIC", "INTERNATIONAL"]>;
+    administrativeArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    streetLevelDetails: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    addressType: "DOMESTIC" | "INTERNATIONAL";
+    administrativeArea?: string | null | undefined;
+    streetLevelDetails?: Record<string, string> | null | undefined;
+}, {
+    country: string;
+    addressType: "DOMESTIC" | "INTERNATIONAL";
+    administrativeArea?: string | null | undefined;
+    streetLevelDetails?: Record<string, string> | null | undefined;
+}> | z.ZodArray<z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+    option: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    option: string;
+    path: string;
+    originalFilename: string;
+}, {
+    type: string;
+    option: string;
+    path: string;
+    originalFilename: string;
+}>, "many"> | z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
+    originalFilename: z.ZodString;
+    type: z.ZodString;
+    option: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    option: string;
+    path: string;
+    originalFilename: string;
+}, {
+    type: string;
+    option: string;
+    path: string;
+    originalFilename: string;
+}>, "many">>> | z.ZodBoolean | z.ZodNumber | z.ZodOptional<z.ZodNullable<z.ZodNumber>> | z.ZodOptional<z.ZodNullable<z.ZodBoolean>> | z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+    loading: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    error: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        statusCode: z.ZodNumber;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        statusCode: number;
+    }, {
+        message: string;
+        statusCode: number;
+    }>>>;
+    data: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    data?: any;
+    error?: {
+        message: string;
+        statusCode: number;
+    } | null | undefined;
+    loading?: boolean | null | undefined;
+}, {
+    data?: any;
+    error?: {
+        message: string;
+        statusCode: number;
+    } | null | undefined;
+    loading?: boolean | null | undefined;
+}>, z.ZodNull]>, z.ZodUndefined]> | z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]> | z.ZodUnion<[z.ZodObject<{
+    start: z.ZodString;
+    end: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    start: string;
+    end: string;
+}, {
+    start: string;
+    end: string;
+}>, z.ZodString]> | z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodObject<{
+    start: z.ZodString;
+    end: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    start: string;
+    end: string;
+}, {
+    start: string;
+    end: string;
+}>, z.ZodString]>>> | z.ZodOptional<z.ZodNullable<z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>>> | z.ZodOptional<z.ZodNullable<z.ZodUndefined>> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    country: z.ZodString;
+    addressType: z.ZodEnum<["DOMESTIC", "INTERNATIONAL"]>;
+    administrativeArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    streetLevelDetails: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
+}, "strip", z.ZodTypeAny, {
+    country: string;
+    addressType: "DOMESTIC" | "INTERNATIONAL";
+    administrativeArea?: string | null | undefined;
+    streetLevelDetails?: Record<string, string> | null | undefined;
+}, {
+    country: string;
+    addressType: "DOMESTIC" | "INTERNATIONAL";
+    administrativeArea?: string | null | undefined;
+    streetLevelDetails?: Record<string, string> | null | undefined;
+}>>> | z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
+    loading: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    error: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        statusCode: z.ZodNumber;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        statusCode: number;
+    }, {
+        message: string;
+        statusCode: number;
+    }>>>;
+    data: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    data?: any;
+    error?: {
+        message: string;
+        statusCode: number;
+    } | null | undefined;
+    loading?: boolean | null | undefined;
+}, {
+    data?: any;
+    error?: {
+        message: string;
+        statusCode: number;
+    } | null | undefined;
+    loading?: boolean | null | undefined;
+}>, z.ZodNull]>, z.ZodUndefined]>>>;
+export declare function createValidationSchema(config: FieldConfig[]): z.ZodObject<Record<string, FieldUpdateValueSchema | NullishFieldValueSchema>, "strip", z.ZodTypeAny, {
+    [x: string]: string | number | boolean | {
+        type: string;
+        path: string;
+        originalFilename: string;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | null | undefined;
+    } | {
+        country: string;
+        addressType: "DOMESTIC" | "INTERNATIONAL";
+        administrativeArea?: string | null | undefined;
+        streetLevelDetails?: Record<string, string> | null | undefined;
+    } | {
+        type: string;
+        option: string;
+        path: string;
+        originalFilename: string;
+    }[] | {
+        data?: any;
+        error?: {
+            message: string;
+            statusCode: number;
+        } | null | undefined;
+        loading?: boolean | null | undefined;
+    } | {
+        start: string;
+        end: string;
+    } | null | undefined;
+}, {
+    [x: string]: string | number | boolean | {
+        type: string;
+        path: string;
+        originalFilename: string;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | undefined;
+    } | {
+        firstname: string;
+        surname: string;
+        middlename?: string | null | undefined;
+    } | {
+        country: string;
+        addressType: "DOMESTIC" | "INTERNATIONAL";
+        administrativeArea?: string | null | undefined;
+        streetLevelDetails?: Record<string, string> | null | undefined;
+    } | {
+        type: string;
+        option: string;
+        path: string;
+        originalFilename: string;
+    }[] | {
+        data?: any;
+        error?: {
+            message: string;
+            statusCode: number;
+        } | null | undefined;
+        loading?: boolean | null | undefined;
+    } | {
+        start: string;
+        end: string;
+    } | null | undefined;
+}>;
+/**
+ * Maps complex or nested field types, such as Address fields, to their corresponding empty values.
+ */
+export declare function mapFieldTypeToEmptyValue(field: FieldConfig): never[] | {
+    country: string;
+    addressType: "DOMESTIC";
+    administrativeArea: string;
+    streetLevelDetails: {};
+    path?: undefined;
+    originalFilename?: undefined;
+    type?: undefined;
+} | {
+    path: FullDocumentPath;
+    originalFilename: string;
+    type: string;
+    country?: undefined;
+    addressType?: undefined;
+    administrativeArea?: undefined;
+    streetLevelDetails?: undefined;
+} | null;
+export declare const isParagraphFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: Paragraph;
+};
+export declare const isDateFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: DateField;
+};
+export declare const isTimeFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: TimeField;
+};
+export declare const isDateRangeFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: DateRangeFieldValue;
+    config: DateRangeField;
+};
+export declare const isSelectDateRangeFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: SelectDateRangeValue;
+    config: SelectDateRangeField;
+};
+export declare const isPageHeaderFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: PageHeader;
+};
+export declare const isTextFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: TextField;
+};
+export declare const isNumberFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    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;
+}) => field is {
+    value: string;
+    config: TextAreaField;
+};
+export declare const isSignatureFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue | undefined;
+}) => field is {
+    value: FileFieldValue | undefined;
+    config: SignatureField;
+};
+export declare const isEmailFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: EmailField;
+};
+export declare const isFileFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: FileFieldValue;
+    config: File;
+};
+export declare const isFileFieldWithOptionType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: FileFieldWithOptionValue;
+    config: FileUploadWithOptions;
+};
+export declare const isBulletListFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: BulletList;
+};
+export declare const isSelectFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: SelectField;
+};
+export declare const isAddressFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: AddressFieldValue;
+    config: AddressField;
+};
+export declare const isCountryFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: Country;
+};
+export declare const isCheckboxFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: boolean;
+    config: Checkbox;
+};
+export declare const isRadioGroupFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: RadioGroup;
+};
+export declare const isLocationFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: LocationInput;
+};
+export declare const isDividerFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: Divider;
+};
+export declare const isAdministrativeAreaFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: AdministrativeArea;
+};
+export declare const isFacilityFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: Facility;
+};
+export declare const isOfficeFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: string;
+    config: Office;
+};
+export declare const isDataFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: undefined;
+    config: DataField;
+};
+export declare const isButtonFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: undefined;
+    config: ButtonField;
+};
+export declare const isHttpFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: undefined;
+    config: HttpField;
+};
+export declare const isLinkButtonFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: undefined;
+    config: LinkButtonField;
+};
+export type NonInteractiveFieldType = Divider | PageHeader | Paragraph | BulletList | DataField | HttpField | LinkButtonField;
+export type InteractiveFieldType = Exclude<FieldConfig, NonInteractiveFieldType>;
+export declare const isNonInteractiveFieldType: (field: FieldConfig) => field is NonInteractiveFieldType;
+export {};
+//# sourceMappingURL=FieldTypeMapping.d.ts.map