@opencrvs/toolkit 1.8.1-rc.25f3d5c → 1.8.1-rc.38ac682

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

@@ -4724,13 +4724,164 @@ declare const DataField: z.ZodObject<z.objectUtil.extendShape<{
     uncorrectable?: boolean | undefined;
 }>;
 export type DataField = z.infer<typeof DataField>;
+declare const PrintButton: z.ZodObject<z.objectUtil.extendShape<{
+    id: z.ZodString;
+    label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>;
+    parent: z.ZodOptional<z.ZodObject<{
+        $$field: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        $$field: string;
+    }, {
+        $$field: string;
+    }>>;
+    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", import("./Conditional").FieldConditionalType[]>, "many">>>;
+    secured: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    placeholder: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>>;
+    validation: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
+        validator: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
+        message: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        message: TranslationConfig;
+        validator: import(".").JSONSchema;
+    }, {
+        message: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+        validator: import(".").JSONSchema;
+    }>, "many">>>;
+    helperText: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>>;
+    hideLabel: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    uncorrectable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, {
+    type: z.ZodLiteral<"PRINT_BUTTON">;
+    configuration: z.ZodObject<{
+        template: z.ZodString;
+        buttonLabel: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        template: string;
+        buttonLabel?: TranslationConfig | undefined;
+    }, {
+        template: string;
+        buttonLabel?: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        } | undefined;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: "PRINT_BUTTON";
+    id: string;
+    label: TranslationConfig;
+    configuration: {
+        template: string;
+        buttonLabel?: TranslationConfig | undefined;
+    };
+    parent?: {
+        $$field: string;
+    } | undefined;
+    validation?: {
+        message: TranslationConfig;
+        validator: import(".").JSONSchema;
+    }[] | undefined;
+    required?: boolean | undefined;
+    conditionals?: ({
+        type: "SHOW";
+        conditional: import(".").JSONSchema;
+    } | {
+        type: "ENABLE";
+        conditional: import(".").JSONSchema;
+    } | {
+        type: "DISPLAY_ON_REVIEW";
+        conditional: import(".").JSONSchema;
+    })[] | undefined;
+    secured?: boolean | undefined;
+    placeholder?: TranslationConfig | undefined;
+    helperText?: TranslationConfig | undefined;
+    hideLabel?: boolean | undefined;
+    uncorrectable?: boolean | undefined;
+}, {
+    type: "PRINT_BUTTON";
+    id: string;
+    label: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    };
+    configuration: {
+        template: string;
+        buttonLabel?: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        } | undefined;
+    };
+    parent?: {
+        $$field: string;
+    } | undefined;
+    validation?: {
+        message: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+        validator: import(".").JSONSchema;
+    }[] | undefined;
+    required?: boolean | undefined;
+    conditionals?: ({
+        type: "SHOW";
+        conditional: import(".").JSONSchema;
+    } | {
+        type: "ENABLE";
+        conditional: import(".").JSONSchema;
+    } | {
+        type: "DISPLAY_ON_REVIEW";
+        conditional: import(".").JSONSchema;
+    })[] | undefined;
+    secured?: boolean | undefined;
+    placeholder?: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    } | undefined;
+    helperText?: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    } | undefined;
+    hideLabel?: boolean | undefined;
+    uncorrectable?: boolean | undefined;
+}>;
+export type PrintButton = z.infer<typeof PrintButton>;
 /** @knipignore */
-export type Inferred = z.infer<typeof Address> | z.infer<typeof TextField> | z.infer<typeof NumberField> | z.infer<typeof TextAreaField> | z.infer<typeof DateField> | z.infer<typeof TimeField> | z.infer<typeof DateRangeField> | z.infer<typeof SelectDateRangeField> | z.infer<typeof Paragraph> | z.infer<typeof RadioGroup> | z.infer<typeof BulletList> | z.infer<typeof PageHeader> | z.infer<typeof Select> | z.infer<typeof NameField> | z.infer<typeof PhoneField> | z.infer<typeof IdField> | z.infer<typeof Checkbox> | z.infer<typeof File> | z.infer<typeof FileUploadWithOptions> | z.infer<typeof Country> | z.infer<typeof AdministrativeArea> | z.infer<typeof Divider> | z.infer<typeof Location> | z.infer<typeof Facility> | z.infer<typeof Office> | z.infer<typeof SignatureField> | z.infer<typeof EmailField> | z.infer<typeof DataField>;
+export type Inferred = z.infer<typeof Address> | z.infer<typeof TextField> | z.infer<typeof NumberField> | z.infer<typeof TextAreaField> | z.infer<typeof DateField> | z.infer<typeof TimeField> | z.infer<typeof DateRangeField> | z.infer<typeof SelectDateRangeField> | z.infer<typeof Paragraph> | z.infer<typeof RadioGroup> | z.infer<typeof BulletList> | z.infer<typeof PageHeader> | z.infer<typeof Select> | z.infer<typeof NameField> | z.infer<typeof PhoneField> | z.infer<typeof IdField> | z.infer<typeof Checkbox> | z.infer<typeof File> | z.infer<typeof FileUploadWithOptions> | z.infer<typeof Country> | z.infer<typeof AdministrativeArea> | z.infer<typeof Divider> | z.infer<typeof Location> | z.infer<typeof Facility> | z.infer<typeof Office> | z.infer<typeof SignatureField> | z.infer<typeof EmailField> | z.infer<typeof DataField> | z.infer<typeof PrintButton>;
 /** @knipignore */
 /**
  * This is the type that should be used for the input of the FieldConfig. Useful when config uses zod defaults.
  */
-export type InferredInput = z.input<typeof Address> | z.input<typeof TextField> | z.input<typeof NumberField> | z.input<typeof TextAreaField> | z.input<typeof DateField> | z.input<typeof TimeField> | z.input<typeof DateRangeField> | z.input<typeof Paragraph> | z.input<typeof RadioGroup> | z.input<typeof BulletList> | z.input<typeof PageHeader> | z.input<typeof Select> | z.input<typeof NameField> | z.input<typeof PhoneField> | z.input<typeof IdField> | z.input<typeof Checkbox> | z.input<typeof File> | z.input<typeof FileUploadWithOptions> | z.input<typeof Country> | z.input<typeof AdministrativeArea> | z.input<typeof Divider> | z.input<typeof Location> | z.input<typeof Facility> | z.input<typeof Office> | z.input<typeof SignatureField> | z.input<typeof EmailField> | z.input<typeof DataField>;
+export type InferredInput = z.input<typeof Address> | z.input<typeof TextField> | z.input<typeof NumberField> | z.input<typeof TextAreaField> | z.input<typeof DateField> | z.input<typeof TimeField> | z.input<typeof DateRangeField> | z.input<typeof Paragraph> | z.input<typeof RadioGroup> | z.input<typeof BulletList> | z.input<typeof PageHeader> | z.input<typeof Select> | z.input<typeof NameField> | z.input<typeof PhoneField> | z.input<typeof IdField> | z.input<typeof Checkbox> | z.input<typeof File> | z.input<typeof FileUploadWithOptions> | z.input<typeof Country> | z.input<typeof AdministrativeArea> | z.input<typeof Divider> | z.input<typeof Location> | z.input<typeof Facility> | z.input<typeof Office> | z.input<typeof SignatureField> | z.input<typeof EmailField> | z.input<typeof DataField> | z.input<typeof PrintButton>;
 export declare const FieldConfig: z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
     id: z.ZodString;
     label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
@@ -9139,6 +9290,155 @@ export declare const FieldConfig: z.ZodDiscriminatedUnion<"type", [z.ZodObject<z
     } | undefined;
     hideLabel?: boolean | undefined;
     uncorrectable?: boolean | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    id: z.ZodString;
+    label: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>;
+    parent: z.ZodOptional<z.ZodObject<{
+        $$field: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        $$field: string;
+    }, {
+        $$field: string;
+    }>>;
+    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    conditionals: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<"type", import("./Conditional").FieldConditionalType[]>, "many">>>;
+    secured: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    placeholder: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>>;
+    validation: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
+        validator: z.ZodType<import(".").JSONSchema, z.ZodTypeDef, import(".").JSONSchema>;
+        message: z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        message: TranslationConfig;
+        validator: import(".").JSONSchema;
+    }, {
+        message: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+        validator: import(".").JSONSchema;
+    }>, "many">>>;
+    helperText: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    }>>;
+    hideLabel: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+    uncorrectable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
+}, {
+    type: z.ZodLiteral<"PRINT_BUTTON">;
+    configuration: z.ZodObject<{
+        template: z.ZodString;
+        buttonLabel: z.ZodOptional<z.ZodObject<import("./TranslationConfig").MessageDescriptorZod, "strip", z.ZodTypeAny, TranslationConfig, {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        template: string;
+        buttonLabel?: TranslationConfig | undefined;
+    }, {
+        template: string;
+        buttonLabel?: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        } | undefined;
+    }>;
+}>, "strip", z.ZodTypeAny, {
+    type: "PRINT_BUTTON";
+    id: string;
+    label: TranslationConfig;
+    configuration: {
+        template: string;
+        buttonLabel?: TranslationConfig | undefined;
+    };
+    parent?: {
+        $$field: string;
+    } | undefined;
+    validation?: {
+        message: TranslationConfig;
+        validator: import(".").JSONSchema;
+    }[] | undefined;
+    required?: boolean | undefined;
+    conditionals?: ({
+        type: "SHOW";
+        conditional: import(".").JSONSchema;
+    } | {
+        type: "ENABLE";
+        conditional: import(".").JSONSchema;
+    } | {
+        type: "DISPLAY_ON_REVIEW";
+        conditional: import(".").JSONSchema;
+    })[] | undefined;
+    secured?: boolean | undefined;
+    placeholder?: TranslationConfig | undefined;
+    helperText?: TranslationConfig | undefined;
+    hideLabel?: boolean | undefined;
+    uncorrectable?: boolean | undefined;
+}, {
+    type: "PRINT_BUTTON";
+    id: string;
+    label: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    };
+    configuration: {
+        template: string;
+        buttonLabel?: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        } | undefined;
+    };
+    parent?: {
+        $$field: string;
+    } | undefined;
+    validation?: {
+        message: {
+            id: string;
+            description: string;
+            defaultMessage: string;
+        };
+        validator: import(".").JSONSchema;
+    }[] | undefined;
+    required?: boolean | undefined;
+    conditionals?: ({
+        type: "SHOW";
+        conditional: import(".").JSONSchema;
+    } | {
+        type: "ENABLE";
+        conditional: import(".").JSONSchema;
+    } | {
+        type: "DISPLAY_ON_REVIEW";
+        conditional: import(".").JSONSchema;
+    })[] | undefined;
+    secured?: boolean | undefined;
+    placeholder?: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    } | undefined;
+    helperText?: {
+        id: string;
+        description: string;
+        defaultMessage: string;
+    } | undefined;
+    hideLabel?: boolean | undefined;
+    uncorrectable?: boolean | undefined;
 }>]>;
 export type SelectField = z.infer<typeof Select>;
 export type NameField = z.infer<typeof NameField>;

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

@@ -27,8 +27,9 @@ export declare const FieldType: {
     readonly OFFICE: "OFFICE";
     readonly SIGNATURE: "SIGNATURE";
     readonly DATA: "DATA";
+    readonly PRINT_BUTTON: "PRINT_BUTTON";
 };
-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 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" | "PRINT_BUTTON")[];
 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, DataField, NameField, PhoneField, IdField, DateRangeField, SelectDateRangeField, TimeField } 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, PrintButton } from './FieldConfig';
 import { FieldType } from './FieldType';
 import { FieldValue, FieldUpdateValueSchema, DateRangeFieldValue, SelectDateRangeValue } from './FieldValue';
 import { FullDocumentPath } from '../documents';
@@ -641,7 +641,14 @@ export declare const isDataFieldType: (field: {
     value: undefined;
     config: DataField;
 };
-export type NonInteractiveFieldType = Divider | PageHeader | Paragraph | BulletList | DataField;
+export declare const isPrintButtonFieldType: (field: {
+    config: FieldConfig;
+    value: FieldValue;
+}) => field is {
+    value: undefined;
+    config: PrintButton;
+};
+export type NonInteractiveFieldType = Divider | PageHeader | Paragraph | BulletList | DataField | PrintButton;
 export type InteractiveFieldType = Exclude<FieldConfig, NonInteractiveFieldType>;
 export declare const isNonInteractiveFieldType: (field: FieldConfig) => field is NonInteractiveFieldType;
 export {};