@defra/fcp-sfd-frontend-engine 0.3.0 → 0.5.0

package/src/schemas/address-schema.js

@@ -0,0 +1,61 @@
+import Joi from 'joi'
+import {
+  ADDRESS_LINE_MAX,
+  TOWN_CITY_MAX,
+  COUNTY_MAX,
+  POSTCODE_MAX,
+  COUNTRY_MAX
+} from '../constants/validation-fields.js'
+
+export const addressSchema = Joi.object({
+  address1: Joi.string()
+    .required()
+    .max(ADDRESS_LINE_MAX)
+    .messages({
+      'string.empty': 'Enter address line 1, typically the building and street',
+      'string.max': `Address line 1 must be ${ADDRESS_LINE_MAX} characters or less`,
+      'any.required': 'Enter address line 1, typically the building and street'
+    }),
+  address2: Joi.string()
+    .allow('')
+    .max(ADDRESS_LINE_MAX)
+    .messages({
+      'string.max': `Address line 2 must be ${ADDRESS_LINE_MAX} characters or less`
+    }),
+  address3: Joi.string()
+    .allow('')
+    .max(ADDRESS_LINE_MAX)
+    .messages({
+      'string.max': `Address line 3 must be ${ADDRESS_LINE_MAX} characters or less`
+    }),
+  city: Joi.string()
+    .required()
+    .max(TOWN_CITY_MAX)
+    .messages({
+      'string.empty': 'Enter town or city',
+      'string.max': `Town or city must be ${TOWN_CITY_MAX} characters or less`,
+      'any.required': 'Enter town or city'
+    }),
+  county: Joi.string()
+    .allow('')
+    .max(COUNTY_MAX)
+    .messages({
+      'string.max': `County must be ${COUNTY_MAX} characters or less`
+    }),
+  postcode: Joi.string()
+    .required()
+    .max(POSTCODE_MAX)
+    .messages({
+      'any.required': 'Enter a postal code or zip code',
+      'string.empty': 'Enter a postal code or zip code',
+      'string.max': `Postal code or zip code must be ${POSTCODE_MAX} characters or less`
+    }),
+  country: Joi.string()
+    .required()
+    .max(COUNTRY_MAX)
+    .messages({
+      'string.empty': 'Enter a country',
+      'string.max': `Country must be ${COUNTRY_MAX} characters or less`,
+      'any.required': 'Enter a country'
+    })
+})

package/src/schemas/business/business-email-schema.js

@@ -0,0 +1,19 @@
+import Joi from 'joi'
+import { EMAIL_MAX } from '../../constants/validation-fields.js'
+
+export const businessEmailSchema = Joi.object({
+  businessEmail: Joi.string()
+    .required()
+    .max(EMAIL_MAX)
+    .email({
+      minDomainSegments: 2,
+      tlds: {
+        allow: true
+      }
+    })
+    .messages({
+      'string.max': `Business email address must be ${EMAIL_MAX} characters or less`,
+      'string.empty': 'Enter business email address',
+      'string.email': 'Enter an email address, like name@example.com'
+    })
+})

package/src/schemas/business/business-name-schema.js

@@ -0,0 +1,13 @@
+import Joi from 'joi'
+import { BUSINESS_NAME_MAX } from '../../constants/validation-fields.js'
+
+export const businessNameSchema = Joi.object({
+  businessName: Joi.string()
+    .required()
+    .max(BUSINESS_NAME_MAX)
+    .messages({
+      'string.empty': 'Enter business name',
+      'string.max': `Business name must be ${BUSINESS_NAME_MAX} characters or less`,
+      'any.required': 'Enter business name'
+    })
+})

package/src/schemas/business/business-phone-schema.js

@@ -0,0 +1,33 @@
+import Joi from 'joi'
+import {
+  PHONE_NUMBER_MIN,
+  PHONE_NUMBER_MAX
+} from '../../constants/validation-fields.js'
+import { PHONE_NUMBER_PATTERN } from '../../constants/patterns.js'
+
+export const businessPhoneSchema = Joi.object({
+  businessTelephone: Joi.string()
+    .empty('')
+    .min(PHONE_NUMBER_MIN)
+    .max(PHONE_NUMBER_MAX)
+    .pattern(PHONE_NUMBER_PATTERN)
+    .messages({
+      'string.min': `Business telephone number must be ${PHONE_NUMBER_MIN} characters or more`,
+      'string.max': `Business telephone number must be ${PHONE_NUMBER_MAX} characters or less`,
+      'string.pattern.base': 'Business telephone number must only include numbers 0 to 9 and special characters such as spaces, brackets and +'
+    }),
+  businessMobile: Joi.string()
+    .empty('')
+    .min(PHONE_NUMBER_MIN)
+    .max(PHONE_NUMBER_MAX)
+    .pattern(PHONE_NUMBER_PATTERN)
+    .messages({
+      'string.min': `Business mobile phone number must be ${PHONE_NUMBER_MIN} characters or more`,
+      'string.max': `Business mobile phone number must be ${PHONE_NUMBER_MAX} characters or less`,
+      'string.pattern.base': 'Business mobile phone number must only include numbers 0 to 9 and special characters such as spaces, brackets and +'
+    })
+})
+  .or('businessTelephone', 'businessMobile')
+  .messages({
+    'object.missing': 'Enter at least one phone number'
+  })

package/src/schemas/business/business-schemas.js

@@ -1,5 +1,18 @@
 import { businessSbiSchema } from './business-sbi-schema.js'
+import { addressSchema } from '../address-schema.js'
+import { businessNameSchema } from './business-name-schema.js'
+import { businessEmailSchema } from './business-email-schema.js'
+import { businessPhoneSchema } from './business-phone-schema.js'
+import { businessVatSchema } from './business-vat-schema.js'
 
 export const businessSchemas = {
-  sbi: businessSbiSchema
+  sbi: businessSbiSchema,
+  address: addressSchema,
+  details: {
+    name: businessNameSchema,
+    address: addressSchema,
+    phone: businessPhoneSchema,
+    email: businessEmailSchema,
+    vat: businessVatSchema
+  }
 }

package/src/schemas/business/business-vat-schema.js

@@ -0,0 +1,11 @@
+import Joi from 'joi'
+
+export const businessVatSchema = Joi.object({
+  vatNumber: Joi.string()
+    .pattern(/^\d{9}$/)
+    .allow('')
+    .optional()
+    .messages({
+      'string.pattern.base': 'Enter a VAT registration number, like 123456789'
+    })
+})

package/src/schemas/personal/personal-dob-schema.js

@@ -0,0 +1,178 @@
+import Joi from 'joi'
+import { MONTH_MAP, MAX_AGE_YEARS } from '../../constants/validation-fields-export.js'
+
+export const personalDobSchema = Joi.object({
+  day: Joi.string().allow(''),
+  month: Joi.string().allow(''),
+  year: Joi.string().allow('')
+}).custom((value, helpers) => {
+  const { day, month, year } = value
+
+  // Check for missing fields or combinations
+  const missingFieldsError = checkMissingFields(day, month, year, helpers)
+  if (missingFieldsError) {
+    return missingFieldsError
+  }
+
+  // Year format check (must be 4 digits)
+  if (year && year.length !== 4) {
+    return makeError(helpers, 'dob.yearLength', ['year'])
+  }
+
+  // Normalise and validate month input (can be name, abbreviation, or number)
+  const monthValue = getMonthNumber(month, helpers)
+  if (monthValue.isJoiError) {
+    return monthValue
+  }
+
+  // Validate that a real, valid date exists
+  const fullDate = getFullDate(day, monthValue, year, helpers)
+  if (fullDate.isJoiError) {
+    return fullDate
+  }
+
+  // Date must be in the past
+  if (fullDate > new Date()) {
+    return makeError(helpers, 'dob.future', ['day', 'month', 'year'])
+  }
+
+  // Date must not be more than 120 years ago
+  const tooOldError = checkNotTooOld(fullDate, helpers)
+  if (tooOldError) {
+    return tooOldError
+  }
+
+  return value
+}).messages({
+  'dob.missingAll': 'Enter your date of birth',
+  'dob.missingDay': 'Date of birth must include a day',
+  'dob.missingMonth': 'Date of birth must include a month',
+  'dob.missingYear': 'Date of birth must include a year',
+  'dob.missingDayMonth': 'Date of birth must include a day and month',
+  'dob.missingDayYear': 'Date of birth must include a day and year',
+  'dob.missingMonthYear': 'Date of birth must include a month and year',
+  'dob.yearLength': 'Enter a year with 4 numbers, like 1975',
+  'dob.invalid': 'Date of birth must be a real date',
+  'dob.future': 'Date of birth must be in the past',
+  'dob.tooOld': 'Date of birth must be on or after {{#oldest}}'
+})
+
+const checkNotTooOld = (fullDate, helpers) => {
+  const oldestDateAllowed = getOldestAllowedDate()
+
+  if (fullDate < oldestDateAllowed) {
+    // Create date string from 120 years ago (to use for the error)
+    const oldestDateString = oldestDateAllowed.toLocaleDateString('en-GB', {
+      day: 'numeric',
+      month: 'long',
+      year: 'numeric'
+    })
+
+    // Pass the date string as context so the message template can use it
+    const error = helpers.error('dob.tooOld', { oldest: oldestDateString })
+    error.path = ['day', 'month', 'year']
+
+    return error
+  }
+
+  return null
+}
+
+const getOldestAllowedDate = () => {
+  const date = new Date()
+  date.setUTCHours(0, 0, 0, 0)
+  date.setUTCFullYear(date.getUTCFullYear() - MAX_AGE_YEARS)
+
+  return date
+}
+
+/**
+ * Gets and validates a full date (day, month, year) to ensure it is a real and valid date.
+ */
+const getFullDate = (day, monthValue, year, helpers) => {
+  const dayValue = Number.parseInt(day, 10)
+  const yearValue = Number.parseInt(year, 10)
+  const date = new Date(Date.UTC(yearValue, monthValue - 1, dayValue))
+
+  if (
+    date.getUTCFullYear() !== yearValue ||
+    date.getUTCMonth() + 1 !== monthValue ||
+    date.getUTCDate() !== dayValue
+  ) {
+    return makeError(helpers, 'dob.invalid', ['day', 'month', 'year'])
+  }
+
+  return date
+}
+
+/**
+ * Normalises a month value entered by the user.
+ *
+ * A user can enter either:
+ * - a month number (e.g. "10")
+ * - a full month name (e.g. "October")
+ * - or a common abbreviation (e.g. "Oct")
+ *
+ * If the value is not numeric, it is converted to lowercase and looked up in the MONTH_MAP,
+ * which maps all valid month names and abbreviations to their corresponding number values
+ * (e.g. "january" → 1, "feb" → 2).
+ *
+ * If a valid mapping is found, the mapped number is returned.
+ * If no mapping exists, an error is returned via `makeError`, as the input is likely invalid.
+ * If the month is already numeric, it is simply parsed and returned as a number.
+ */
+const getMonthNumber = (month, helpers) => {
+  if (Number.isNaN(Number(month))) {
+    const lower = month.toLowerCase()
+    const mapped = MONTH_MAP[lower]
+
+    if (!mapped) {
+      return makeError(helpers, 'dob.invalid', ['month'])
+    }
+
+    return mapped
+  }
+
+  return Number.parseInt(month, 10)
+}
+
+/**
+ * Validates combinations of missing date fields
+ * (e.g. day missing, month+year entered, etc.)
+ */
+const checkMissingFields = (day, month, year, helpers) => {
+  if (!day && !month && !year) {
+    return makeError(helpers, 'dob.missingAll', ['day', 'month', 'year'])
+  }
+  if (!day && month && year) {
+    return makeError(helpers, 'dob.missingDay', ['day'])
+  }
+  if (day && !month && year) {
+    return makeError(helpers, 'dob.missingMonth', ['month'])
+  }
+  if (day && month && !year) {
+    return makeError(helpers, 'dob.missingYear', ['year'])
+  }
+  if (!day && !month && year) {
+    return makeError(helpers, 'dob.missingDayMonth', ['day', 'month'])
+  }
+  if (!day && month && !year) {
+    return makeError(helpers, 'dob.missingDayYear', ['day', 'year'])
+  }
+  if (day && !month && !year) {
+    return makeError(helpers, 'dob.missingMonthYear', ['month', 'year'])
+  }
+
+  return null
+}
+
+/**
+ * Creates a Joi error and manually sets its path so the right input fields highlight.
+ */
+const makeError = (helpers, code, fields) => {
+  const error = helpers.error(code)
+  error.path = fields
+  error.isJoiError = true
+
+  return error
+}

package/src/schemas/personal/personal-email-schema.js

@@ -0,0 +1,20 @@
+import Joi from 'joi'
+import { EMAIL_MAX } from '../../constants/validation-fields.js'
+
+export const personalEmailSchema = Joi.object({
+  personalEmail: Joi.string()
+    .required()
+    .max(EMAIL_MAX)
+    .email({
+      minDomainSegments: 2,
+      tlds: {
+        allow: true,
+        min: 2
+      }
+    })
+    .messages({
+      'string.max': `Email address must be ${EMAIL_MAX} characters or less`,
+      'string.empty': 'Enter a personal email address',
+      'string.email': 'Enter an email address, like name@example.com'
+    })
+})

package/src/schemas/personal/personal-name-schema.js

@@ -0,0 +1,31 @@
+import Joi from 'joi'
+import {
+  FIRST_NAME_MAX,
+  LAST_NAME_MAX,
+  MIDDLE_NAMES_MAX
+} from '../../constants/validation-fields.js'
+
+export const personalNameSchema = Joi.object({
+  first: Joi.string()
+    .required()
+    .max(FIRST_NAME_MAX)
+    .messages({
+      'string.empty': 'Enter first name',
+      'string.max': `First name must be ${FIRST_NAME_MAX} characters or less`,
+      'any.required': 'Enter first name'
+    }),
+  last: Joi.string()
+    .required()
+    .max(LAST_NAME_MAX)
+    .messages({
+      'string.empty': 'Enter last name',
+      'string.max': `Last name must be ${LAST_NAME_MAX} characters or less`,
+      'any.required': 'Enter last name'
+    }),
+  middle: Joi.string()
+    .allow('')
+    .max(MIDDLE_NAMES_MAX)
+    .messages({
+      'string.max': `Middle names must be ${MIDDLE_NAMES_MAX} characters or less`
+    })
+})

package/src/schemas/personal/personal-phone-schema.js

@@ -0,0 +1,33 @@
+import Joi from 'joi'
+import {
+  PHONE_NUMBER_MIN,
+  PHONE_NUMBER_MAX,
+  PHONE_NUMBER_PATTERN
+} from '../../constants/validation-fields-export.js'
+
+export const personalPhoneSchema = Joi.object({
+  personalTelephone: Joi.string()
+    .empty('')
+    .min(PHONE_NUMBER_MIN)
+    .max(PHONE_NUMBER_MAX)
+    .pattern(PHONE_NUMBER_PATTERN)
+    .messages({
+      'string.min': `Personal telephone number must be ${PHONE_NUMBER_MIN} characters or more`,
+      'string.max': `Personal telephone number must be ${PHONE_NUMBER_MAX} characters or less`,
+      'string.pattern.base': 'Personal telephone number must only include numbers 0 to 9 and special characters such as spaces, brackets and +'
+    }),
+  personalMobile: Joi.string()
+    .empty('')
+    .min(PHONE_NUMBER_MIN)
+    .max(PHONE_NUMBER_MAX)
+    .pattern(PHONE_NUMBER_PATTERN)
+    .messages({
+      'string.min': `Personal mobile phone number must be ${PHONE_NUMBER_MIN} characters or more`,
+      'string.max': `Personal mobile phone number must be ${PHONE_NUMBER_MAX} characters or less`,
+      'string.pattern.base': 'Personal mobile phone number must only include numbers 0 to 9 and special characters such as spaces, brackets and +'
+    })
+})
+  .or('personalTelephone', 'personalMobile')
+  .messages({
+    'object.missing': 'Enter at least one phone number'
+  })

package/src/schemas/personal/personal-schemas.js

@@ -0,0 +1,13 @@
+import { personalNameSchema } from './personal-name-schema.js'
+import { personalDobSchema } from './personal-dob-schema.js'
+import { addressSchema } from '../address-schema.js'
+import { personalEmailSchema } from './personal-email-schema.js'
+import { personalPhoneSchema } from './personal-phone-schema.js'
+
+export const personalSchemas = {
+  name: personalNameSchema,
+  dob: personalDobSchema,
+  address: addressSchema,
+  phone: personalPhoneSchema,
+  email: personalEmailSchema
+}

package/src/schemas/schemas.js

@@ -1,7 +1,9 @@
 import { businessSchemas } from './business/business-schemas.js'
 import { customerSchemas } from './customer/customer-schemas.js'
+import { personalSchemas } from './personal/personal-schemas.js'
 
 export const schemas = {
   business: businessSchemas,
-  customer: customerSchemas
+  customer: customerSchemas,
+  personal: personalSchemas
 }