@defra/forms-model 3.0.645 → 3.0.647

package/schemas/page-schema-v2.json

@@ -297,8 +297,8 @@
                       },
                       "amount": {
                         "type": "number",
-                        "description": "Payment amount in GBP (£0.30 - £100,000)",
-                        "minimum": 0.3,
+                        "description": "Payment amount in GBP (£0 - £100,000)",
+                        "minimum": 0,
                         "maximum": 100000,
                         "title": "Amount"
                       },
@@ -307,6 +307,39 @@
                         "description": "Payment description (max 230 chars)",
                         "maxLength": 230,
                         "title": "Description"
+                      },
+                      "conditionalAmounts": {
+                        "type": "array",
+                        "description": "Conditional payment amounts evaluated in order",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "condition": {
+                              "type": "string",
+                              "description": "Condition ID for this amount",
+                              "title": "Condition"
+                            },
+                            "amount": {
+                              "type": "number",
+                              "description": "Amount in GBP when condition is true (min £0.30)",
+                              "minimum": 0.3,
+                              "maximum": 100000,
+                              "title": "Amount"
+                            }
+                          },
+                          "required": [
+                            "condition",
+                            "amount"
+                          ],
+                          "additionalProperties": false,
+                          "title": "Conditional Amounts Item"
+                        },
+                        "title": "Conditional Amounts"
+                      },
+                      "emailField": {
+                        "type": "string",
+                        "description": "Name of EmailAddressField to prepopulate GOV.UK Pay email",
+                        "title": "Email Field"
                       }
                     },
                     "additionalProperties": true,
@@ -506,8 +539,8 @@
                       },
                       "amount": {
                         "type": "number",
-                        "description": "Payment amount in GBP (£0.30 - £100,000)",
-                        "minimum": 0.3,
+                        "description": "Payment amount in GBP (£0 - £100,000)",
+                        "minimum": 0,
                         "maximum": 100000,
                         "title": "Amount"
                       },
@@ -516,6 +549,39 @@
                         "description": "Payment description (max 230 chars)",
                         "maxLength": 230,
                         "title": "Description"
+                      },
+                      "conditionalAmounts": {
+                        "type": "array",
+                        "description": "Conditional payment amounts evaluated in order",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "condition": {
+                              "type": "string",
+                              "description": "Condition ID for this amount",
+                              "title": "Condition"
+                            },
+                            "amount": {
+                              "type": "number",
+                              "description": "Amount in GBP when condition is true (min £0.30)",
+                              "minimum": 0.3,
+                              "maximum": 100000,
+                              "title": "Amount"
+                            }
+                          },
+                          "required": [
+                            "condition",
+                            "amount"
+                          ],
+                          "additionalProperties": false,
+                          "title": "Conditional Amounts Item"
+                        },
+                        "title": "Conditional Amounts"
+                      },
+                      "emailField": {
+                        "type": "string",
+                        "description": "Name of EmailAddressField to prepopulate GOV.UK Pay email",
+                        "title": "Email Field"
                       }
                     },
                     "additionalProperties": true,
@@ -798,8 +864,8 @@
                   },
                   "amount": {
                     "type": "number",
-                    "description": "Payment amount in GBP (£0.30 - £100,000)",
-                    "minimum": 0.3,
+                    "description": "Payment amount in GBP (£0 - £100,000)",
+                    "minimum": 0,
                     "maximum": 100000,
                     "title": "Amount"
                   },
@@ -808,6 +874,39 @@
                     "description": "Payment description (max 230 chars)",
                     "maxLength": 230,
                     "title": "Description"
+                  },
+                  "conditionalAmounts": {
+                    "type": "array",
+                    "description": "Conditional payment amounts evaluated in order",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "condition": {
+                          "type": "string",
+                          "description": "Condition ID for this amount",
+                          "title": "Condition"
+                        },
+                        "amount": {
+                          "type": "number",
+                          "description": "Amount in GBP when condition is true (min £0.30)",
+                          "minimum": 0.3,
+                          "maximum": 100000,
+                          "title": "Amount"
+                        }
+                      },
+                      "required": [
+                        "condition",
+                        "amount"
+                      ],
+                      "additionalProperties": false,
+                      "title": "Conditional Amounts Item"
+                    },
+                    "title": "Conditional Amounts"
+                  },
+                  "emailField": {
+                    "type": "string",
+                    "description": "Name of EmailAddressField to prepopulate GOV.UK Pay email",
+                    "title": "Email Field"
                   }
                 },
                 "additionalProperties": true,

package/schemas/page-schema.json

@@ -160,8 +160,8 @@
               },
               "amount": {
                 "type": "number",
-                "description": "Payment amount in GBP (£0.30 - £100,000)",
-                "minimum": 0.3,
+                "description": "Payment amount in GBP (£0 - £100,000)",
+                "minimum": 0,
                 "maximum": 100000,
                 "title": "Amount"
               },
@@ -170,6 +170,39 @@
                 "description": "Payment description (max 230 chars)",
                 "maxLength": 230,
                 "title": "Description"
+              },
+              "conditionalAmounts": {
+                "type": "array",
+                "description": "Conditional payment amounts evaluated in order",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "condition": {
+                      "type": "string",
+                      "description": "Condition ID for this amount",
+                      "title": "Condition"
+                    },
+                    "amount": {
+                      "type": "number",
+                      "description": "Amount in GBP when condition is true (min £0.30)",
+                      "minimum": 0.3,
+                      "maximum": 100000,
+                      "title": "Amount"
+                    }
+                  },
+                  "required": [
+                    "condition",
+                    "amount"
+                  ],
+                  "additionalProperties": false,
+                  "title": "Conditional Amounts Item"
+                },
+                "title": "Conditional Amounts"
+              },
+              "emailField": {
+                "type": "string",
+                "description": "Name of EmailAddressField to prepopulate GOV.UK Pay email",
+                "title": "Email Field"
               }
             },
             "additionalProperties": true,

package/src/components/component-types.ts

@@ -198,7 +198,8 @@ export const ComponentTypes: readonly ComponentDef[] = Object.freeze([
     hint: '',
     options: {
       amount: 1,
-      description: 'payment desc'
+      description: 'payment desc',
+      conditionalAmounts: []
     }
   } as PaymentFieldComponent,
   {

package/src/components/types.ts

@@ -260,6 +260,11 @@ export interface PaymentFieldComponent extends FormFieldBase {
   options: FormFieldBase['options'] & {
     amount: number
     description: string
+    conditionalAmounts?: {
+      condition: string
+      amount: number
+    }[]
+    emailField?: string
   }
 }
 
@@ -325,6 +330,11 @@ export interface CheckboxesFieldComponent extends ListFieldBase {
     bold?: boolean
     condition?: string
   }
+  schema?: {
+    max?: number
+    min?: number
+    length?: number
+  }
 }
 
 export interface RadiosFieldComponent extends ListFieldBase {

package/src/form/form-definition/index.ts

@@ -580,10 +580,10 @@ export const componentSchema = Joi.object<ComponentDef>()
       amount: Joi.when('type', {
         is: Joi.string().trim().valid(ComponentType.PaymentField).required(),
         then: Joi.number()
-          .min(0.3)
+          .min(0)
           .max(100000)
           .required()
-          .description('Payment amount in GBP (£0.30 - £100,000)')
+          .description('Payment amount in GBP (£0 - £100,000)')
       }).description('Payment amount - for PaymentField only'),
       description: Joi.when('type', {
         is: Joi.string().trim().valid(ComponentType.PaymentField).required(),
@@ -591,7 +591,35 @@ export const componentSchema = Joi.object<ComponentDef>()
           .max(230)
           .required()
           .description('Payment description (max 230 chars)')
-      }).description('Payment description - for PaymentField only')
+      }).description('Payment description - for PaymentField only'),
+      conditionalAmounts: Joi.when('type', {
+        is: Joi.string().trim().valid(ComponentType.PaymentField).required(),
+        then: Joi.array()
+          .items(
+            Joi.object({
+              condition: Joi.string()
+                .trim()
+                .required()
+                .description('Condition ID for this amount'),
+              amount: Joi.number()
+                .min(0.3)
+                .max(100000)
+                .required()
+                .description('Amount in GBP when condition is true (min £0.30)')
+            })
+          )
+          .optional()
+          .description('Conditional payment amounts evaluated in order')
+      }).description('Conditional amounts - for PaymentField only'),
+      emailField: Joi.when('type', {
+        is: Joi.string().trim().valid(ComponentType.PaymentField).required(),
+        then: Joi.string()
+          .trim()
+          .optional()
+          .description(
+            'Name of EmailAddressField to prepopulate GOV.UK Pay email'
+          )
+      }).description('Email field reference - for PaymentField only')
     })
       .default({})
       .unknown(true)

package/src/form/form-editor/index.ts

@@ -429,6 +429,24 @@ export const paymentApiKeySchema = Joi.string()
   .trim()
   .description('API key for payment configuration')
 
+export const exactChecksSchema = Joi.number()
+  .empty('')
+  .integer()
+  .min(2)
+  .description('Specifies the exact number of items required to be selected.')
+
+export const minChecksSchema = Joi.number()
+  .empty('')
+  .integer()
+  .min(2)
+  .description('Minimum number of items required to be selected.')
+
+export const maxChecksSchema = Joi.number()
+  .empty('')
+  .integer()
+  .min(2)
+  .description('Maximum number of items allowed to be selected.')
+
 type GenericRuleOptions<K extends string, T> = Omit<GetRuleOptions, 'args'> & {
   args: Record<K, T>
 }
@@ -617,7 +635,10 @@ export const questionDetailsFullSchema = {
   shortDescriptionSchema,
   suffixSchema,
   tabularDataTypesSchema,
-  usePostcodeLookupSchema
+  usePostcodeLookupSchema,
+  minChecksSchema,
+  maxChecksSchema,
+  exactChecksSchema
 }
 
 export const formEditorInputPageKeys = {

package/src/form/form-editor/types.ts

@@ -270,6 +270,21 @@ export interface FormEditor {
    */
   listItemsData: string
 
+  /**
+   * The exact number of items to select
+   */
+  exactChecks: string
+
+  /**
+   * The minimum number of items to select
+   */
+  minChecks: string
+
+  /**
+   * The maximum number of items to select
+   */
+  maxChecks: string
+
   /**
    * An array of options for autocomplete
    */
@@ -402,6 +417,9 @@ export type FormEditorInputQuestion = Pick<
   | 'radioValue'
   | 'list'
   | 'listItemsData'
+  | 'exactChecks'
+  | 'minChecks'
+  | 'maxChecks'
   | 'jsEnabled'
   | 'usePostcodeLookup'
   | 'giveInstructions'