@opencrvs/toolkit 1.8.0-rc.ffe24c3 → 1.8.1-rc.008155b

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

@@ -9,6 +9,8 @@ export declare const FieldType: {
     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";
@@ -26,7 +28,7 @@ export declare const FieldType: {
     readonly SIGNATURE: "SIGNATURE";
     readonly DATA: "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 declare const fieldTypes: ("ID" | "NAME" | "PHONE" | "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")[];
 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,7 +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, NameField, PhoneField, IdField } 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, DateRangeField, SelectDateRangeField, TimeField } from './FieldConfig';
 import { FieldType } from './FieldType';
-import { FieldValue, FieldUpdateValueSchema } from './FieldValue';
+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.
@@ -19,28 +20,28 @@ type NullishFieldValueSchema = z.ZodOptional<z.ZodNullable<FieldUpdateValueSchem
  * 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<{
-    filename: z.ZodString;
+    path: z.ZodEffects<z.ZodString, string, string>;
     originalFilename: z.ZodString;
     type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }, {
     type: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
-    filename: z.ZodString;
+    path: z.ZodEffects<z.ZodString, string, string>;
     originalFilename: z.ZodString;
     type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }, {
     type: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }>>> | z.ZodObject<{
     firstname: z.ZodString;
@@ -55,16 +56,16 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     surname: string;
     middlename?: string | undefined;
 }> | z.ZodUndefined | z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
-    firstname: z.ZodString;
-    surname: z.ZodString;
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    surname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    firstname: string;
-    surname: string;
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
     middlename?: string | null | undefined;
 }, {
-    firstname: string;
-    surname: string;
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
     middlename?: string | null | undefined;
 }>, z.ZodNull]>, z.ZodUndefined]> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
     firstname: z.ZodString;
@@ -79,16 +80,16 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     surname: string;
     middlename?: string | undefined;
 }>>> | z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
-    firstname: z.ZodString;
-    surname: z.ZodString;
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    surname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    firstname: string;
-    surname: string;
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
     middlename?: string | null | undefined;
 }, {
-    firstname: string;
-    surname: string;
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
     middlename?: string | null | undefined;
 }>, z.ZodNull]>, z.ZodUndefined]>>> | z.ZodUnion<[z.ZodDiscriminatedUnion<"urbanOrRural", [z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
@@ -177,36 +178,54 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
     addressLine3?: string | null | undefined;
     postcodeOrZip?: string | null | undefined;
 }>]> | z.ZodArray<z.ZodObject<{
-    filename: z.ZodString;
+    path: z.ZodEffects<z.ZodString, string, string>;
     originalFilename: z.ZodString;
     type: z.ZodString;
     option: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: string;
     option: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }, {
     type: string;
     option: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }>, "many"> | z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
-    filename: z.ZodString;
+    path: z.ZodEffects<z.ZodString, string, string>;
     originalFilename: z.ZodString;
     type: z.ZodString;
     option: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: string;
     option: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }, {
     type: string;
     option: string;
-    filename: string;
+    path: 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<{
+}>, "many">>> | 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.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;
@@ -296,7 +315,7 @@ export declare function mapFieldTypeToZod(type: FieldType, required?: boolean):
 export declare function createValidationSchema(config: FieldConfig[]): z.ZodObject<Record<string, FieldUpdateValueSchema | NullishFieldValueSchema>, "strip", z.ZodTypeAny, {
     [x: string]: string | number | boolean | {
         type: string;
-        filename: string;
+        path: string;
         originalFilename: string;
     } | {
         country: string;
@@ -314,8 +333,8 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
         surname: string;
         middlename?: string | undefined;
     } | {
-        firstname: string;
-        surname: string;
+        firstname?: string | null | undefined;
+        surname?: string | null | undefined;
         middlename?: string | null | undefined;
     } | {
         country: string;
@@ -337,13 +356,16 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
     } | {
         type: string;
         option: string;
-        filename: string;
+        path: string;
         originalFilename: string;
-    }[] | [string, string] | null | undefined;
+    }[] | {
+        start: string;
+        end: string;
+    } | null | undefined;
 }, {
     [x: string]: string | number | boolean | {
         type: string;
-        filename: string;
+        path: string;
         originalFilename: string;
     } | {
         country: string;
@@ -361,8 +383,8 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
         surname: string;
         middlename?: string | undefined;
     } | {
-        firstname: string;
-        surname: string;
+        firstname?: string | null | undefined;
+        surname?: string | null | undefined;
         middlename?: string | null | undefined;
     } | {
         country: string;
@@ -384,9 +406,12 @@ export declare function createValidationSchema(config: FieldConfig[]): z.ZodObje
     } | {
         type: string;
         option: string;
-        filename: string;
+        path: string;
         originalFilename: string;
-    }[] | [string, string] | null | undefined;
+    }[] | {
+        start: string;
+        end: string;
+    } | null | undefined;
 }>;
 /**
  * Maps complex or nested field types, such as Address fields, to their corresponding empty values.
@@ -402,11 +427,11 @@ export declare function mapFieldTypeToEmptyValue(field: FieldConfig): never[] |
     street: null;
     number: null;
     zipCode: null;
-    filename?: undefined;
+    path?: undefined;
     originalFilename?: undefined;
     type?: undefined;
 } | {
-    filename: string;
+    path: FullDocumentPath;
     originalFilename: string;
     type: string;
     country?: undefined;
@@ -434,12 +459,26 @@ export declare const isDateFieldType: (field: {
     value: string;
     config: DateField;
 };
-export declare const isDateRangeFieldType: (field: {
+export declare const isTimeFieldType: (field: {
     config: FieldConfig;
     value: FieldValue;
 }) => field is {
     value: string;
-    config: DateField;
+    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;

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

@@ -15,9 +15,21 @@ import { AddressFieldValue, AddressFieldUpdateValue, FileFieldValue, FileFieldWi
 export declare const TextValue: z.ZodString;
 export declare const NonEmptyTextValue: z.ZodString;
 export declare const DateValue: z.ZodString;
+export declare const TimeValue: z.ZodString;
 export declare const DatetimeValue: z.ZodString;
-export declare const DateRangeFieldValue: z.ZodUnion<[z.ZodString, z.ZodTuple<[z.ZodString, z.ZodString], null>]>;
+export declare const SelectDateRangeValue: z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>;
+export declare const DateRangeFieldValue: z.ZodUnion<[z.ZodObject<{
+    start: z.ZodString;
+    end: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    start: string;
+    end: string;
+}, {
+    start: string;
+    end: string;
+}>, z.ZodString]>;
 export type DateRangeFieldValue = z.infer<typeof DateRangeFieldValue>;
+export type SelectDateRangeValue = z.infer<typeof SelectDateRangeValue>;
 export declare const EmailValue: z.ZodString;
 export declare const CheckboxFieldValue: z.ZodBoolean;
 export type CheckboxFieldValue = z.infer<typeof CheckboxFieldValue>;
@@ -27,32 +39,41 @@ 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;
+export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodString, z.ZodUnion<[z.ZodObject<{
+    start: z.ZodString;
+    end: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    start: string;
+    end: string;
+}, {
+    start: string;
+    end: string;
+}>, z.ZodString]>, z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
     originalFilename: z.ZodString;
     type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }, {
     type: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }>, z.ZodArray<z.ZodObject<{
-    filename: z.ZodString;
+    path: z.ZodEffects<z.ZodString, string, string>;
     originalFilename: z.ZodString;
     type: z.ZodString;
     option: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: string;
     option: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }, {
     type: string;
     option: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }>, "many">, z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
@@ -153,45 +174,54 @@ export declare const FieldValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodUnio
     surname: string;
     middlename?: string | undefined;
 }>, z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
-    firstname: z.ZodString;
-    surname: z.ZodString;
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    surname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    firstname: string;
-    surname: string;
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
     middlename?: string | null | undefined;
 }, {
-    firstname: string;
-    surname: string;
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
     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;
+export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.ZodString, z.ZodUnion<[z.ZodObject<{
+    start: z.ZodString;
+    end: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    start: string;
+    end: string;
+}, {
+    start: string;
+    end: string;
+}>, z.ZodString]>, z.ZodEnum<["last7Days", "last30Days", "last90Days", "last365Days"]>, z.ZodBoolean, z.ZodNumber, z.ZodObject<{
+    path: z.ZodEffects<z.ZodString, string, string>;
     originalFilename: z.ZodString;
     type: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }, {
     type: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }>, z.ZodArray<z.ZodObject<{
-    filename: z.ZodString;
+    path: z.ZodEffects<z.ZodString, string, string>;
     originalFilename: z.ZodString;
     type: z.ZodString;
     option: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     type: string;
     option: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }, {
     type: string;
     option: string;
-    filename: string;
+    path: string;
     originalFilename: string;
 }>, "many">, z.ZodObject<z.objectUtil.extendShape<{
     country: z.ZodString;
@@ -280,16 +310,16 @@ export declare const FieldUpdateValue: z.ZodUnion<[z.ZodString, z.ZodString, z.Z
     addressLine3?: string | null | undefined;
     postcodeOrZip?: string | null | undefined;
 }>, z.ZodUnion<[z.ZodUnion<[z.ZodObject<{
-    firstname: z.ZodString;
-    surname: z.ZodString;
+    firstname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    surname: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     middlename: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    firstname: string;
-    surname: string;
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
     middlename?: string | null | undefined;
 }, {
-    firstname: string;
-    surname: string;
+    firstname?: string | null | undefined;
+    surname?: string | null | undefined;
     middlename?: string | null | undefined;
 }>, z.ZodNull]>, z.ZodUndefined]>]>;
 export type FieldUpdateValue = z.infer<typeof FieldUpdateValue>;
@@ -302,5 +332,5 @@ export type FieldValueSchema = typeof FileFieldValue | typeof FileFieldWithOptio
  *
  * 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 | typeof NameFieldValue | typeof NameFieldUpdateValue | z.ZodString | z.ZodBoolean;
+export type FieldUpdateValueSchema = typeof DateRangeFieldValue | typeof SelectDateRangeValue | 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