@defra/forms-model 3.0.673 → 3.0.674

package/schemas/page-schema-v2.json

@@ -340,6 +340,44 @@
                         "type": "string",
                         "description": "Name of EmailAddressField to prepopulate GOV.UK Pay email",
                         "title": "Email Field"
+                      },
+                      "countries": {
+                        "type": "array",
+                        "description": "Country filters for geospatial data - for GeospatialField only",
+                        "items": {
+                          "type": "string",
+                          "enum": [
+                            "england",
+                            "northern-ireland",
+                            "scotland",
+                            "wales"
+                          ],
+                          "title": "Countries Item"
+                        },
+                        "title": "Countries"
+                      },
+                      "geometryTypes": {
+                        "type": "array",
+                        "description": "Geometry types for geospatial data - for GeospatialField only",
+                        "items": {
+                          "type": "string",
+                          "enum": [
+                            "point",
+                            "line",
+                            "shape"
+                          ],
+                          "title": "Geometry Types Item"
+                        },
+                        "title": "Geometry Types"
+                      },
+                      "format": {
+                        "type": "string",
+                        "description": "Format for telephone number - for TelephoneNumberField only",
+                        "enum": [
+                          "uk",
+                          "international"
+                        ],
+                        "title": "Format"
                       }
                     },
                     "additionalProperties": true,
@@ -582,6 +620,44 @@
                         "type": "string",
                         "description": "Name of EmailAddressField to prepopulate GOV.UK Pay email",
                         "title": "Email Field"
+                      },
+                      "countries": {
+                        "type": "array",
+                        "description": "Country filters for geospatial data - for GeospatialField only",
+                        "items": {
+                          "type": "string",
+                          "enum": [
+                            "england",
+                            "northern-ireland",
+                            "scotland",
+                            "wales"
+                          ],
+                          "title": "Countries Item"
+                        },
+                        "title": "Countries"
+                      },
+                      "geometryTypes": {
+                        "type": "array",
+                        "description": "Geometry types for geospatial data - for GeospatialField only",
+                        "items": {
+                          "type": "string",
+                          "enum": [
+                            "point",
+                            "line",
+                            "shape"
+                          ],
+                          "title": "Geometry Types Item"
+                        },
+                        "title": "Geometry Types"
+                      },
+                      "format": {
+                        "type": "string",
+                        "description": "Format for telephone number - for TelephoneNumberField only",
+                        "enum": [
+                          "uk",
+                          "international"
+                        ],
+                        "title": "Format"
                       }
                     },
                     "additionalProperties": true,
@@ -908,6 +984,44 @@
                     "type": "string",
                     "description": "Name of EmailAddressField to prepopulate GOV.UK Pay email",
                     "title": "Email Field"
+                  },
+                  "countries": {
+                    "type": "array",
+                    "description": "Country filters for geospatial data - for GeospatialField only",
+                    "items": {
+                      "type": "string",
+                      "enum": [
+                        "england",
+                        "northern-ireland",
+                        "scotland",
+                        "wales"
+                      ],
+                      "title": "Countries Item"
+                    },
+                    "title": "Countries"
+                  },
+                  "geometryTypes": {
+                    "type": "array",
+                    "description": "Geometry types for geospatial data - for GeospatialField only",
+                    "items": {
+                      "type": "string",
+                      "enum": [
+                        "point",
+                        "line",
+                        "shape"
+                      ],
+                      "title": "Geometry Types Item"
+                    },
+                    "title": "Geometry Types"
+                  },
+                  "format": {
+                    "type": "string",
+                    "description": "Format for telephone number - for TelephoneNumberField only",
+                    "enum": [
+                      "uk",
+                      "international"
+                    ],
+                    "title": "Format"
                   }
                 },
                 "additionalProperties": true,

package/schemas/page-schema.json

@@ -203,6 +203,44 @@
                 "type": "string",
                 "description": "Name of EmailAddressField to prepopulate GOV.UK Pay email",
                 "title": "Email Field"
+              },
+              "countries": {
+                "type": "array",
+                "description": "Country filters for geospatial data - for GeospatialField only",
+                "items": {
+                  "type": "string",
+                  "enum": [
+                    "england",
+                    "northern-ireland",
+                    "scotland",
+                    "wales"
+                  ],
+                  "title": "Countries Item"
+                },
+                "title": "Countries"
+              },
+              "geometryTypes": {
+                "type": "array",
+                "description": "Geometry types for geospatial data - for GeospatialField only",
+                "items": {
+                  "type": "string",
+                  "enum": [
+                    "point",
+                    "line",
+                    "shape"
+                  ],
+                  "title": "Geometry Types Item"
+                },
+                "title": "Geometry Types"
+              },
+              "format": {
+                "type": "string",
+                "description": "Format for telephone number - for TelephoneNumberField only",
+                "enum": [
+                  "uk",
+                  "international"
+                ],
+                "title": "Format"
               }
             },
             "additionalProperties": true,

package/src/components/enums.ts

@@ -42,6 +42,11 @@ export enum GeospatialFieldGeometryTypesEnum {
   Shape = 'shape'
 }
 
+export enum TelephoneNumberFieldOptionsFormatEnum {
+  UK = 'uk',
+  International = 'international'
+}
+
 export const PreviewTypeEnum = {
   ...ComponentType,
   Question: 'Question',

package/src/components/index.ts

@@ -3,7 +3,8 @@ export {
   ComponentType,
   GeospatialFieldGeometryTypesEnum,
   GeospatialFieldOptionsCountryEnum,
-  PreviewTypeEnum
+  PreviewTypeEnum,
+  TelephoneNumberFieldOptionsFormatEnum
 } from '~/src/components/enums.js'
 export {
   allDocumentTypes,

package/src/components/types.ts

@@ -118,10 +118,13 @@ export interface NumberFieldComponent extends FormFieldBase {
   }
 }
 
+export type TelephoneNumberFieldOptionsFormat = 'international' | 'uk'
+
 export interface TelephoneNumberFieldComponent extends FormFieldBase {
   type: ComponentType.TelephoneNumberField
   options: FormFieldBase['options'] & {
     condition?: string
+    format?: TelephoneNumberFieldOptionsFormat
     customValidationMessage?: string
   }
 }

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

@@ -3,7 +3,12 @@ import JoiBase, { type CustomHelpers, type LanguageMessages } from 'joi'
 import { v4 as uuidV4 } from 'uuid'
 
 import { rtrimOnly } from '~/src/common/rtrim-only.js'
-import { ComponentType } from '~/src/components/enums.js'
+import {
+  ComponentType,
+  GeospatialFieldGeometryTypesEnum,
+  GeospatialFieldOptionsCountryEnum,
+  TelephoneNumberFieldOptionsFormatEnum
+} from '~/src/components/enums.js'
 import { isConditionalType } from '~/src/components/helpers.js'
 import {
   type ComponentDef,
@@ -621,7 +626,42 @@ export const componentSchema = Joi.object<ComponentDef>()
           .description(
             'Name of EmailAddressField to prepopulate GOV.UK Pay email'
           )
-      }).description('Email field reference - for PaymentField only')
+      }).description('Email field reference - for PaymentField only'),
+      countries: Joi.when('type', {
+        is: Joi.string().trim().valid(ComponentType.GeospatialField).required(),
+        then: Joi.array()
+          .items(
+            Joi.string().valid(
+              ...Object.values(GeospatialFieldOptionsCountryEnum)
+            )
+          )
+          .description(
+            'Country filters for geospatial data - for GeospatialField only'
+          )
+      }).description('Country filters - for GeospatialField only'),
+      geometryTypes: Joi.when('type', {
+        is: Joi.string().trim().valid(ComponentType.GeospatialField).required(),
+        then: Joi.array()
+          .items(
+            Joi.string().valid(
+              ...Object.values(GeospatialFieldGeometryTypesEnum)
+            )
+          )
+          .description(
+            'Geometry types for geospatial data - for GeospatialField only'
+          )
+      }).description('Geometry types - for GeospatialField only'),
+      format: Joi.when('type', {
+        is: Joi.string()
+          .trim()
+          .valid(ComponentType.TelephoneNumberField)
+          .required(),
+        then: Joi.string()
+          .valid(...Object.values(TelephoneNumberFieldOptionsFormatEnum))
+          .description(
+            'Format for telephone number - for TelephoneNumberField only'
+          )
+      }).description('Format - for TelephoneNumberField only')
     })
       .default({})
       .unknown(true)

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

@@ -4,7 +4,8 @@ import { rtrimOnly } from '~/src/common/rtrim-only.js'
 import {
   ComponentType,
   GeospatialFieldGeometryTypesEnum,
-  GeospatialFieldOptionsCountryEnum
+  GeospatialFieldOptionsCountryEnum,
+  TelephoneNumberFieldOptionsFormatEnum
 } from '~/src/components/enums.js'
 import {
   MAX_NUMBER_OF_REPEAT_ITEMS,
@@ -484,6 +485,10 @@ export const geometryTypesSchema = Joi.array()
   .single()
   .description('The geometry types allowed in a geospatial field')
 
+export const telephoneNumberFormatSchema = Joi.string()
+  .valid(...Object.values(TelephoneNumberFieldOptionsFormatEnum), 'any')
+  .description('The format for the telephone number field')
+
 type GenericRuleOptions<K extends string, T> = Omit<GetRuleOptions, 'args'> & {
   args: Record<K, T>
 }
@@ -680,7 +685,8 @@ export const questionDetailsFullSchema = {
   minFeaturesSchema,
   maxFeaturesSchema,
   exactFeaturesSchema,
-  geometryTypesSchema
+  geometryTypesSchema,
+  telephoneNumberFormatSchema
 }
 
 export const formEditorInputPageKeys = {

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

@@ -4,7 +4,8 @@ import {
 } from '~/src/components/enums.js'
 import {
   type ComponentDef,
-  type GeospatialFieldOptionsCountry
+  type GeospatialFieldOptionsCountry,
+  type TelephoneNumberFieldOptionsFormat
 } from '~/src/components/types.js'
 import { type DateDirections, type DateUnits } from '~/src/conditions/enums.js'
 import {
@@ -396,6 +397,11 @@ export interface FormEditor {
    * The geometry types restriction for geospatial questions
    */
   geometryTypes?: GeospatialFieldGeometryTypesEnum[]
+
+  /**
+   * The format restriction for telephone number questions
+   */
+  telephoneNumberFormat?: TelephoneNumberFieldOptionsFormat | 'any'
 }
 
 export type FormEditorInputPage = Pick<
@@ -482,6 +488,7 @@ export type FormEditorInputQuestion = Pick<
   | 'exactFeatures'
   | 'minFeatures'
   | 'maxFeatures'
+  | 'telephoneNumberFormat'
 >
 
 export type FormEditorInputPageSettings = Pick<