@defra/forms-model 3.0.569 → 3.0.571

package/schemas/page-schema.json

@@ -181,6 +181,33 @@
                 "type": "number",
                 "description": "Exact length required for validation",
                 "title": "Length"
+              },
+              "regex": {
+                "type": [
+                  "array",
+                  "boolean",
+                  "number",
+                  "object",
+                  "string",
+                  "null"
+                ],
+                "oneOf": [
+                  {
+                    "type": "string",
+                    "description": "Regex expression for validation of user field content",
+                    "title": "Regex (string)"
+                  },
+                  {
+                    "type": "string",
+                    "title": "Regex (string)"
+                  }
+                ],
+                "title": "Regex",
+                "description": "The regex value.",
+                "oneOfTitles": [
+                  "Regex (string)",
+                  "Regex (string)"
+                ]
               }
             },
             "additionalProperties": true,

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

@@ -444,6 +444,21 @@ export const conditionWrapperSchemaV2 = Joi.object<ConditionWrapperV2>()
   })
   .description('Condition schema for V2 forms')
 
+export const regexCustomValidator = (
+  value: string,
+  helpers: CustomHelpers<string>
+) => {
+  try {
+    const _regex = new RegExp(value)
+  } catch {
+    return helpers.error('custom.incompatible', {
+      errorType: FormDefinitionErrorType.Incompatible,
+      errorCode: FormDefinitionError.IncompatibleQuestionRegex
+    })
+  }
+  return value
+}
+
 export const componentSchema = Joi.object<ComponentDef>()
   .description('Form component definition specifying UI element behavior')
   .keys({
@@ -531,7 +546,19 @@ export const componentSchema = Joi.object<ComponentDef>()
         .description('Maximum value or length for validation'),
       length: Joi.number()
         .empty('')
-        .description('Exact length required for validation')
+        .description('Exact length required for validation'),
+      regex: Joi.when('type', {
+        is: Joi.string().valid(
+          ComponentType.TextField,
+          ComponentType.MultilineTextField
+        ),
+        then: Joi.string() // NOSONAR
+          .trim()
+          .optional()
+          .description('Regex expression for validation of user field content')
+          .custom(regexCustomValidator),
+        otherwise: Joi.string().allow('')
+      }).messages({ 'custom.incompatible': 'The regex expression is invalid' })
     })
       .unknown(true)
       .default({})

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

@@ -46,6 +46,7 @@ export enum FormDefinitionError {
   RefConditionConditionId = 'ref_condition_condition_id',
   RefPageComponentList = 'ref_page_component_list',
   IncompatibleConditionComponentType = 'incompatible_condition_component_type',
+  IncompatibleQuestionRegex = 'incompatible_question_regex',
   Other = 'other'
 }
 
@@ -142,6 +143,10 @@ export const formDefinitionErrors: FormDefinitionErrors = {
     key: 'componentId',
     type: FormDefinitionErrorType.Incompatible
   },
+  [FormDefinitionError.IncompatibleQuestionRegex]: {
+    key: 'regex',
+    type: FormDefinitionErrorType.Incompatible
+  },
   [FormDefinitionError.Other]: {
     key: '',
     type: FormDefinitionErrorType.Type

package/src/pages/helpers.ts

@@ -135,27 +135,6 @@ export function showRepeaterSettings(page: Page): boolean {
   return true
 }
 
-/**
- * High level check for whether file upload component should be omitted
- * @param { Page | undefined } page
- * @returns {boolean}
- */
-export function omitFileUploadComponent(page: Page | undefined): boolean {
-  if (page?.controller === ControllerType.Repeat) {
-    return true
-  }
-  if (!hasComponents(page)) {
-    return false
-  }
-  if (page.components.length > 1) {
-    return true
-  }
-  if (includesFileUploadField(page.components)) {
-    return true
-  }
-  return false
-}
-
 /**
  * Gets page title, or title of first question (if no page title set)
  * @param {Page} page

package/src/pages/index.ts

@@ -18,7 +18,6 @@ export {
   includesFileUploadField,
   isControllerName,
   isSummaryPage,
-  omitFileUploadComponent,
   showRepeaterSettings,
   summaryPageControllers
 } from '~/src/pages/helpers.js'