@opencrvs/toolkit 1.9.5-rc.4858075 → 1.9.5-rc.4d0fc4f

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

@@ -6,6 +6,7 @@ export declare const FieldType: {
     readonly ADDRESS: "ADDRESS";
     readonly TEXT: "TEXT";
     readonly NUMBER: "NUMBER";
+    readonly NUMBER_WITH_UNIT: "NUMBER_WITH_UNIT";
     readonly TEXTAREA: "TEXTAREA";
     readonly EMAIL: "EMAIL";
     readonly DATE: "DATE";
@@ -44,11 +45,11 @@ export declare const FieldType: {
  * 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" | "AGE" | "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" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER")[];
+export declare const fieldTypes: ("NAME" | "PHONE" | "ID" | "ADDRESS" | "TEXT" | "NUMBER" | "NUMBER_WITH_UNIT" | "TEXTAREA" | "EMAIL" | "DATE" | "AGE" | "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" | "SEARCH" | "ALPHA_PRINT_BUTTON" | "HTTP" | "LINK_BUTTON" | "VERIFICATION_STATUS" | "QUERY_PARAM_READER" | "QR_READER" | "ID_READER" | "LOADER")[];
 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" | "DATA" | "ID_READER")[];
+export declare const compositeFieldTypes: ("NAME" | "ADDRESS" | "DATE_RANGE" | "FILE" | "FILE_WITH_OPTIONS" | "DATA" | "ID_READER")[];
 export declare const FieldTypesToHideInReview: ("PARAGRAPH" | "PAGE_HEADER" | "BULLET_LIST" | "DIVIDER" | "DATA" | "HTTP" | "QUERY_PARAM_READER" | "ID_READER" | "LOADER")[];
 //# sourceMappingURL=FieldType.d.ts.map

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, LocationInput, Office, PageHeader, Paragraph, RadioGroup, SelectField, SignatureField, TextAreaField, TextField, NumberField, DataField, NameField, PhoneField, IdField, DateRangeField, SelectDateRangeField, TimeField, AlphaPrintButton, HttpField, SearchField, ButtonField, LinkButtonField, VerificationStatus, QueryParamReaderField, QrReaderField, IdReaderField, LoaderField, AgeField } from './FieldConfig';
-import { FieldValue, DataFieldValue, DateRangeFieldValue, SelectDateRangeValue, VerificationStatusValue, AgeValue } from './FieldValue';
+import { AddressField, AdministrativeArea, BulletList, Checkbox, Country, DateField, Divider, Facility, EmailField, FieldConfig, File, FileUploadWithOptions, LocationInput, Office, PageHeader, Paragraph, RadioGroup, SelectField, SignatureField, TextAreaField, TextField, NumberField, NumberWithUnitField, DataField, NameField, PhoneField, IdField, DateRangeField, SelectDateRangeField, TimeField, AlphaPrintButton, HttpField, SearchField, ButtonField, LinkButtonField, VerificationStatus, QueryParamReaderField, QrReaderField, IdReaderField, LoaderField, AgeField } from './FieldConfig';
+import { FieldValue, DataFieldValue, DateRangeFieldValue, SelectDateRangeValue, VerificationStatusValue, AgeValue, FieldUpdateValue } from './FieldValue';
 import { FullDocumentPath } from '../documents';
-import { AddressFieldValue, FileFieldValue, FileFieldWithOptionValue, NameFieldValue } from './CompositeFieldValue';
+import { AddressFieldValue, FileFieldValue, FileFieldWithOptionValue, NameFieldValue, NumberWithUnitFieldValue } from './CompositeFieldValue';
 import { ActionType } from './ActionType';
 /**
  * Mapping of field types to Zod schema.
@@ -229,6 +229,24 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
     data?: any;
 }, {
     data?: any;
+}>>> | z.ZodObject<{
+    numericValue: z.ZodOptional<z.ZodNumber>;
+    unit: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    numericValue?: number | undefined;
+    unit?: string | undefined;
+}, {
+    numericValue?: number | undefined;
+    unit?: string | undefined;
+}> | z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    numericValue: z.ZodOptional<z.ZodNumber>;
+    unit: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    numericValue?: number | undefined;
+    unit?: string | undefined;
+}, {
+    numericValue?: number | undefined;
+    unit?: string | undefined;
 }>>> | z.ZodObject<{
     age: z.ZodNumber;
     asOfDateRef: z.ZodString;
@@ -409,6 +427,24 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
         data?: any;
     }, {
         data?: any;
+    }>, z.ZodObject<{
+        numericValue: z.ZodNumber;
+        unit: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        numericValue: number;
+        unit: string;
+    }, {
+        numericValue: number;
+        unit: string;
+    }>, z.ZodObject<{
+        numericValue: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
+    }, {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     }>]>>;
 }, "strip", z.ZodTypeAny, {
     data: Record<string, string | number | boolean | {
@@ -448,6 +484,12 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
         data: Record<string, string>;
     } | {
         data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     } | {
         age: number;
         asOfDateRef: string;
@@ -493,6 +535,12 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
         data: Record<string, string>;
     } | {
         data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     } | {
         age: number;
         asOfDateRef: string;
@@ -644,6 +692,24 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
         data?: any;
     }, {
         data?: any;
+    }>, z.ZodObject<{
+        numericValue: z.ZodNumber;
+        unit: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        numericValue: number;
+        unit: string;
+    }, {
+        numericValue: number;
+        unit: string;
+    }>, z.ZodObject<{
+        numericValue: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
+    }, {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     }>]>>;
 }, "strip", z.ZodTypeAny, {
     data: Record<string, string | number | boolean | {
@@ -683,6 +749,12 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
         data: Record<string, string>;
     } | {
         data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     } | {
         age: number;
         asOfDateRef: string;
@@ -728,6 +800,12 @@ export declare function mapFieldTypeToZod(field: FieldConfig, actionType?: Actio
         data: Record<string, string>;
     } | {
         data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     } | {
         age: number;
         asOfDateRef: string;
@@ -970,6 +1048,13 @@ export declare const isNumberFieldType: (field: {
     value: number;
     config: NumberField;
 };
+export declare const isNumberWithUnitFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue | FieldUpdateValue;
+}) => field is {
+    value: NumberWithUnitFieldValue;
+    config: NumberWithUnitField;
+};
 export declare const isNameFieldType: (field: {
     config: FieldConfig;
     value: FieldValue;

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

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { AddressFieldValue, AddressFieldUpdateValue, FileFieldValue, FileFieldWithOptionValue, NameFieldValue, NameFieldUpdateValue, HttpFieldUpdateValue, QueryParamReaderFieldUpdateValue, QrReaderFieldValue, IdReaderFieldValue } from './CompositeFieldValue';
+import { AddressFieldValue, AddressFieldUpdateValue, FileFieldValue, FileFieldWithOptionValue, NameFieldValue, NameFieldUpdateValue, NumberWithUnitFieldValue, NumberWithUnitFieldUpdateValue, HttpFieldUpdateValue, QueryParamReaderFieldUpdateValue, QrReaderFieldValue, IdReaderFieldValue } 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).
@@ -206,6 +206,24 @@ declare const FieldValuesWithoutDataField: z.ZodUnion<[z.ZodDiscriminatedUnion<"
     data?: any;
 }, {
     data?: any;
+}>, z.ZodObject<{
+    numericValue: z.ZodNumber;
+    unit: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    numericValue: number;
+    unit: string;
+}, {
+    numericValue: number;
+    unit: string;
+}>, z.ZodObject<{
+    numericValue: z.ZodOptional<z.ZodNumber>;
+    unit: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    numericValue?: number | undefined;
+    unit?: string | undefined;
+}, {
+    numericValue?: number | undefined;
+    unit?: string | undefined;
 }>]>;
 type FieldValuesWithoutDataField = z.infer<typeof FieldValuesWithoutDataField>;
 export declare const DataFieldValue: z.ZodOptional<z.ZodNullable<z.ZodObject<{
@@ -352,6 +370,24 @@ export declare const DataFieldValue: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         data?: any;
     }, {
         data?: any;
+    }>, z.ZodObject<{
+        numericValue: z.ZodNumber;
+        unit: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        numericValue: number;
+        unit: string;
+    }, {
+        numericValue: number;
+        unit: string;
+    }>, z.ZodObject<{
+        numericValue: z.ZodOptional<z.ZodNumber>;
+        unit: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
+    }, {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     }>]>>;
 }, "strip", z.ZodTypeAny, {
     data: Record<string, string | number | boolean | {
@@ -391,6 +427,12 @@ export declare const DataFieldValue: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         data: Record<string, string>;
     } | {
         data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     } | {
         age: number;
         asOfDateRef: string;
@@ -436,6 +478,12 @@ export declare const DataFieldValue: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         data: Record<string, string>;
     } | {
         data?: any;
+    } | {
+        numericValue: number;
+        unit: string;
+    } | {
+        numericValue?: number | undefined;
+        unit?: string | undefined;
     } | {
         age: number;
         asOfDateRef: string;
@@ -448,17 +496,17 @@ export type DataFieldValue = z.infer<typeof DataFieldValue>;
 export type FieldValue = FieldValuesWithoutDataField | DataFieldValue;
 export declare const FieldValue: z.ZodType<FieldValue>;
 export declare function safeUnion<T extends [z.ZodTypeAny, ...z.ZodTypeAny[]]>(schemas: T): z.ZodType<z.TypeOf<T[number]>, z.ZodTypeDef, z.TypeOf<T[number]>>;
-export type FieldUpdateValue = z.infer<typeof TextValue> | z.infer<typeof DateValue> | z.infer<typeof TimeValue> | z.infer<typeof AgeUpdateValue> | z.infer<typeof AddressFieldUpdateValue> | z.infer<typeof DateRangeFieldValue> | z.infer<typeof SelectDateRangeValue> | z.infer<typeof CheckboxFieldValue> | z.infer<typeof NumberFieldValue> | z.infer<typeof FileFieldValue> | z.infer<typeof FileFieldWithOptionValue> | z.infer<typeof DataFieldValue> | z.infer<typeof NameFieldUpdateValue> | z.infer<typeof HttpFieldUpdateValue> | z.infer<typeof QueryParamReaderFieldUpdateValue>;
+export type FieldUpdateValue = z.infer<typeof TextValue> | z.infer<typeof DateValue> | z.infer<typeof TimeValue> | z.infer<typeof AgeUpdateValue> | z.infer<typeof AddressFieldUpdateValue> | z.infer<typeof DateRangeFieldValue> | z.infer<typeof SelectDateRangeValue> | z.infer<typeof CheckboxFieldValue> | z.infer<typeof NumberFieldValue> | z.infer<typeof NumberWithUnitFieldUpdateValue> | z.infer<typeof FileFieldValue> | z.infer<typeof FileFieldWithOptionValue> | z.infer<typeof DataFieldValue> | z.infer<typeof NameFieldUpdateValue> | z.infer<typeof HttpFieldUpdateValue> | z.infer<typeof QueryParamReaderFieldUpdateValue>;
 export declare const FieldUpdateValue: z.ZodType<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 | typeof NameFieldValue | z.ZodString | z.ZodBoolean;
+export type FieldValueSchema = typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldValue | typeof NumberFieldValue | typeof NumberWithUnitFieldValue | 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 AgeValue | typeof SelectDateRangeValue | typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | typeof DataFieldValue | typeof NameFieldValue | typeof NameFieldUpdateValue | typeof HttpFieldUpdateValue | typeof QueryParamReaderFieldUpdateValue | typeof ButtonFieldValue | typeof QrReaderFieldValue | typeof IdReaderFieldValue | z.ZodString | z.ZodBoolean;
+export type FieldUpdateValueSchema = typeof DateRangeFieldValue | typeof AgeValue | typeof SelectDateRangeValue | typeof FileFieldValue | typeof FileFieldWithOptionValue | typeof CheckboxFieldValue | typeof AddressFieldUpdateValue | typeof NumberFieldValue | typeof NumberWithUnitFieldValue | typeof NumberWithUnitFieldUpdateValue | typeof DataFieldValue | typeof NameFieldValue | typeof NameFieldUpdateValue | typeof HttpFieldUpdateValue | typeof QueryParamReaderFieldUpdateValue | typeof ButtonFieldValue | typeof QrReaderFieldValue | typeof IdReaderFieldValue | z.ZodString | z.ZodBoolean;
 export {};
 //# sourceMappingURL=FieldValue.d.ts.map

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

@@ -2,14 +2,26 @@
  * TemplateConfig defines configuration rules for system-based variables (e.g. $user.province).
  * They are currently used for providing default values in FieldConfig.
  */
+import { UUID } from '../uuid';
 import { FieldValue } from './FieldValue';
 /**
  * Available system variables for configuration.
  */
 export type SystemVariables = {
-    $user: {
-        province: string;
-        district: string;
+    user: {
+        id: string;
+        province?: string;
+        district?: string;
+        name?: string;
+        role?: string;
+        firstname?: string;
+        middlename?: string;
+        surname?: string;
+        primaryOfficeId?: UUID;
+        fullHonorificName?: string;
+        device?: string;
+        avatar?: string;
+        signature?: string;
     };
     $window: {
         location: {