@defra/fcp-sfd-frontend-engine 0.2.12 → 0.4.0

package/dist/index.js

@@ -64,15 +64,66 @@ var businessSbiSchema = Joi.object({
   })
 });
 
+// src/schemas/address-schema.js
+import Joi2 from "joi";
+
+// src/constants/validation-fields.js
+var FIRST_NAME_MAX = 100;
+var LAST_NAME_MAX = 100;
+var MIDDLE_NAMES_MAX = 100;
+var EMAIL_MAX = 254;
+var PHONE_NUMBER_MIN = 10;
+var PHONE_NUMBER_MAX = 50;
+var MAX_AGE_YEARS = 120;
+var ADDRESS_LINE_MAX = 100;
+var TOWN_CITY_MAX = 60;
+var COUNTY_MAX = 60;
+var COUNTRY_MAX = 60;
+var POSTCODE_MAX = 8;
+
+// src/schemas/address-schema.js
+var addressSchema = Joi2.object({
+  address1: Joi2.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: Joi2.string().allow("").max(ADDRESS_LINE_MAX).messages({
+    "string.max": `Address line 2 must be ${ADDRESS_LINE_MAX} characters or less`
+  }),
+  address3: Joi2.string().allow("").max(ADDRESS_LINE_MAX).messages({
+    "string.max": `Address line 3 must be ${ADDRESS_LINE_MAX} characters or less`
+  }),
+  city: Joi2.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: Joi2.string().allow("").max(COUNTY_MAX).messages({
+    "string.max": `County must be ${COUNTY_MAX} characters or less`
+  }),
+  postcode: Joi2.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: Joi2.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"
+  })
+});
+
 // src/schemas/business/business-schemas.js
 var businessSchemas = {
-  sbi: businessSbiSchema
+  sbi: businessSbiSchema,
+  address: addressSchema
 };
 
 // src/schemas/customer/customer-crn-schema.js
-import Joi2 from "joi";
-var customerCrnSchema = Joi2.object({
-  crn: Joi2.string().pattern(/^\d{10}$/).allow("").optional().messages({
+import Joi3 from "joi";
+var customerCrnSchema = Joi3.object({
+  crn: Joi3.string().pattern(/^\d{10}$/).allow("").optional().messages({
     "string.pattern.base": "Enter the full CRN"
   })
 });
@@ -82,10 +133,219 @@ var customerSchemas = {
   crn: customerCrnSchema
 };
 
+// src/schemas/personal/personal-name-schema.js
+import Joi4 from "joi";
+var personalNameSchema = Joi4.object({
+  first: Joi4.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: Joi4.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: Joi4.string().allow("").max(MIDDLE_NAMES_MAX).messages({
+    "string.max": `Middle names must be ${MIDDLE_NAMES_MAX} characters or less`
+  })
+});
+
+// src/schemas/personal/personal-dob-schema.js
+import Joi5 from "joi";
+
+// src/constants/patterns.js
+var PHONE_NUMBER_PATTERN = /^\+?[0-9 ()]+$/;
+
+// src/constants/month-map.js
+var MONTH_MAP = {
+  january: 1,
+  jan: 1,
+  february: 2,
+  feb: 2,
+  march: 3,
+  mar: 3,
+  april: 4,
+  apr: 4,
+  may: 5,
+  june: 6,
+  jun: 6,
+  july: 7,
+  jul: 7,
+  august: 8,
+  aug: 8,
+  september: 9,
+  sep: 9,
+  sept: 9,
+  october: 10,
+  oct: 10,
+  november: 11,
+  nov: 11,
+  december: 12,
+  dec: 12
+};
+
+// src/schemas/personal/personal-dob-schema.js
+var personalDobSchema = Joi5.object({
+  day: Joi5.string().allow(""),
+  month: Joi5.string().allow(""),
+  year: Joi5.string().allow("")
+}).custom((value, helpers) => {
+  const { day, month, year } = value;
+  const missingFieldsError = checkMissingFields(day, month, year, helpers);
+  if (missingFieldsError) {
+    return missingFieldsError;
+  }
+  if (year && year.length !== 4) {
+    return makeError(helpers, "dob.yearLength", ["year"]);
+  }
+  const monthValue = getMonthNumber(month, helpers);
+  if (monthValue.isJoiError) {
+    return monthValue;
+  }
+  const fullDate = getFullDate(day, monthValue, year, helpers);
+  if (fullDate.isJoiError) {
+    return fullDate;
+  }
+  if (fullDate > /* @__PURE__ */ new Date()) {
+    return makeError(helpers, "dob.future", ["day", "month", "year"]);
+  }
+  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}}"
+});
+var checkNotTooOld = (fullDate, helpers) => {
+  const oldestDateAllowed = getOldestAllowedDate();
+  if (fullDate < oldestDateAllowed) {
+    const oldestDateString = oldestDateAllowed.toLocaleDateString("en-GB", {
+      day: "numeric",
+      month: "long",
+      year: "numeric"
+    });
+    const error = helpers.error("dob.tooOld", { oldest: oldestDateString });
+    error.path = ["day", "month", "year"];
+    return error;
+  }
+  return null;
+};
+var getOldestAllowedDate = () => {
+  const date = /* @__PURE__ */ new Date();
+  date.setUTCHours(0, 0, 0, 0);
+  date.setUTCFullYear(date.getUTCFullYear() - MAX_AGE_YEARS);
+  return date;
+};
+var 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;
+};
+var 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);
+};
+var 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;
+};
+var makeError = (helpers, code, fields) => {
+  const error = helpers.error(code);
+  error.path = fields;
+  error.isJoiError = true;
+  return error;
+};
+
+// src/schemas/personal/personal-email-schema.js
+import Joi6 from "joi";
+var personalEmailSchema = Joi6.object({
+  personalEmail: Joi6.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"
+  })
+});
+
+// src/schemas/personal/personal-phone-schema.js
+import Joi7 from "joi";
+var personalPhoneSchema = Joi7.object({
+  personalTelephone: Joi7.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: Joi7.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"
+});
+
+// src/schemas/personal/personal-schemas.js
+var personalSchemas = {
+  name: personalNameSchema,
+  dob: personalDobSchema,
+  address: addressSchema,
+  phone: personalPhoneSchema,
+  email: personalEmailSchema
+};
+
 // src/schemas/schemas.js
 var schemas = {
   business: businessSchemas,
-  customer: customerSchemas
+  customer: customerSchemas,
+  personal: personalSchemas
 };
 
 // src/utils/format-validation-errors.js
@@ -118,8 +378,158 @@ var formatValidationErrors = (errors) => {
 var utils = {
   formatValidationErrors
 };
+
+// src/presenters/base-presenter.js
+var BACK_LINK_DISPLAY_MAX = 50;
+var formatBackLink = (businessName) => {
+  if (businessName.length > BACK_LINK_DISPLAY_MAX) {
+    return `Back to ${businessName.slice(0, BACK_LINK_DISPLAY_MAX)}\u2026`;
+  }
+  return `Back to ${businessName}`;
+};
+var formatNumber = (payloadNumber, changedNumber, originalNumber) => {
+  if (payloadNumber !== void 0) {
+    return payloadNumber;
+  }
+  if (changedNumber !== void 0) {
+    return changedNumber;
+  }
+  return originalNumber;
+};
+var formatDisplayAddress = (address) => {
+  const { lookup, manual, postcode, country, city } = address;
+  let addressLines = [];
+  if (lookup.uprn) {
+    const buildingAndStreet = [
+      lookup.buildingNumberRange,
+      lookup.street
+    ].filter(Boolean).join(" ");
+    addressLines = [
+      lookup.pafOrganisationName,
+      lookup.flatName,
+      lookup.buildingName,
+      buildingAndStreet,
+      lookup.doubleDependentLocality,
+      lookup.dependentLocality,
+      city,
+      lookup.county
+    ];
+  } else {
+    addressLines = [
+      manual.line1,
+      manual.line2,
+      manual.line3,
+      city,
+      manual.line4,
+      // County
+      manual.line5
+    ];
+  }
+  return [
+    ...addressLines.filter(Boolean),
+    postcode,
+    country
+  ];
+};
+var buildAddressLine = (parts) => {
+  return parts.filter(Boolean).join(", ") || null;
+};
+var buildStreetLine = (buildingRange, street) => {
+  return [buildingRange, street].filter(Boolean).join(" ") || null;
+};
+var formatLookupAddress = (lookup, city, country, postcode) => ({
+  address1: buildAddressLine([lookup.pafOrganisationName, lookup.flatName, lookup.buildingName]),
+  address2: buildStreetLine(lookup.buildingNumberRange, lookup.street),
+  address3: buildAddressLine([lookup.doubleDependentLocality, lookup.dependentLocality]),
+  county: lookup.county ?? null,
+  city: city ?? null,
+  country: country ?? null,
+  postcode: postcode ?? null
+});
+var formatManualAddress = (manual, city, country, postcode) => ({
+  address1: manual.line1 ?? null,
+  address2: manual.line2 ?? null,
+  address3: manual.line3 ?? null,
+  city: city ?? null,
+  county: manual.line4 ?? null,
+  country: country ?? null,
+  postcode: postcode ?? null
+});
+var formatOriginalAddress = (originalAddress) => {
+  const { lookup, manual, city, country, postcode } = originalAddress;
+  return lookup.uprn ? formatLookupAddress(lookup, city, country, postcode) : formatManualAddress(manual, city, country, postcode);
+};
+var formatChangedAddress = (changeBusinessAddress) => {
+  if (!changeBusinessAddress.uprn) {
+    return changeBusinessAddress;
+  }
+  const {
+    pafOrganisationName,
+    flatName,
+    buildingName,
+    buildingNumberRange,
+    street,
+    doubleDependentLocality,
+    dependentLocality,
+    city,
+    county,
+    country,
+    postcode
+  } = changeBusinessAddress;
+  return {
+    address1: buildAddressLine([pafOrganisationName, flatName, buildingName]),
+    address2: buildStreetLine(buildingNumberRange, street),
+    address3: buildAddressLine([doubleDependentLocality, dependentLocality]),
+    city: city ?? null,
+    county: county ?? null,
+    country: country ?? null,
+    postcode: postcode ?? null
+  };
+};
+var formatDisplayAddresses = (addresses, previouslyPickedAddress) => {
+  const displayAddresses = addresses.map((address) => ({
+    value: `${address.uprn}${address.displayAddress}`,
+    text: address.displayAddress,
+    selected: (previouslyPickedAddress == null ? void 0 : previouslyPickedAddress.uprn) === address.uprn && (previouslyPickedAddress == null ? void 0 : previouslyPickedAddress.displayAddress) === address.displayAddress
+  }));
+  const hasSelectedAddress = displayAddresses.some((addr) => addr.selected);
+  const text = addresses.length === 1 ? "1 address found" : `${addresses.length} addresses found`;
+  displayAddresses.unshift({
+    value: "display",
+    text,
+    selected: !hasSelectedAddress
+  });
+  return displayAddresses;
+};
+var sortErrorsBySectionOrder = (errors, orderedSectionsToFix, SECTION_FIELD_ORDER) => {
+  const sortedErrors = [];
+  for (const section of orderedSectionsToFix) {
+    const fieldsInSection = SECTION_FIELD_ORDER[section] || [];
+    for (const field of fieldsInSection) {
+      if (errors[field]) {
+        sortedErrors.push({
+          field,
+          ...errors[field]
+        });
+      }
+    }
+  }
+  return sortedErrors;
+};
+
+// src/presenters/presenters.js
+var presenters = {
+  formatBackLink,
+  formatNumber,
+  formatDisplayAddress,
+  formatOriginalAddress,
+  formatChangedAddress,
+  formatDisplayAddresses,
+  sortErrorsBySectionOrder
+};
 export {
   mappers,
+  presenters,
   schemas,
   utils
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/fcp-sfd-frontend-engine",
-  "version": "0.2.12",
+  "version": "0.4.0",
   "description": "Shared frontend engine used by both the internal and external frontend applications.",
   "main": "./dist/index.cjs",
   "exports": {
@@ -47,4 +47,4 @@
   "dependencies": {
     "joi": "18.2.1"
   }
-}
+}

package/src/constants/index.js

@@ -0,0 +1,16 @@
+export {
+  FIRST_NAME_MAX,
+  LAST_NAME_MAX,
+  MIDDLE_NAMES_MAX,
+  EMAIL_MAX,
+  PHONE_NUMBER_MIN,
+  PHONE_NUMBER_MAX,
+  MAX_AGE_YEARS,
+  ADDRESS_LINE_MAX,
+  TOWN_CITY_MAX,
+  COUNTY_MAX,
+  COUNTRY_MAX,
+  POSTCODE_MAX,
+  PHONE_NUMBER_PATTERN,
+  MONTH_MAP
+} from './validation-fields-export.js'

package/src/constants/month-map.js

@@ -0,0 +1,26 @@
+export const MONTH_MAP = {
+  january: 1,
+  jan: 1,
+  february: 2,
+  feb: 2,
+  march: 3,
+  mar: 3,
+  april: 4,
+  apr: 4,
+  may: 5,
+  june: 6,
+  jun: 6,
+  july: 7,
+  jul: 7,
+  august: 8,
+  aug: 8,
+  september: 9,
+  sep: 9,
+  sept: 9,
+  october: 10,
+  oct: 10,
+  november: 11,
+  nov: 11,
+  december: 12,
+  dec: 12
+}

package/src/constants/patterns.js

@@ -0,0 +1 @@
+export const PHONE_NUMBER_PATTERN = /^\+?[0-9 ()]+$/

package/src/constants/validation-fields-export.js

@@ -0,0 +1,17 @@
+export {
+  FIRST_NAME_MAX,
+  LAST_NAME_MAX,
+  MIDDLE_NAMES_MAX,
+  EMAIL_MAX,
+  PHONE_NUMBER_MIN,
+  PHONE_NUMBER_MAX,
+  MAX_AGE_YEARS,
+  ADDRESS_LINE_MAX,
+  TOWN_CITY_MAX,
+  COUNTY_MAX,
+  COUNTRY_MAX,
+  POSTCODE_MAX
+} from './validation-fields.js'
+
+export { PHONE_NUMBER_PATTERN } from './patterns.js'
+export { MONTH_MAP } from './month-map.js'

package/src/constants/validation-fields.js

@@ -0,0 +1,14 @@
+export const FIRST_NAME_MAX = 100
+export const LAST_NAME_MAX = 100
+export const MIDDLE_NAMES_MAX = 100
+export const EMAIL_MAX = 254
+export const PHONE_NUMBER_MIN = 10
+export const PHONE_NUMBER_MAX = 50
+export const MAX_AGE_YEARS = 120
+
+// Address
+export const ADDRESS_LINE_MAX = 100
+export const TOWN_CITY_MAX = 60
+export const COUNTY_MAX = 60
+export const COUNTRY_MAX = 60
+export const POSTCODE_MAX = 8

package/src/index.js

@@ -1,3 +1,4 @@
 export { mappers } from './mappers/mappers.js'
 export { schemas } from './schemas/schemas.js'
 export { utils } from './utils/utils.js'
+export { presenters } from './presenters/presenters.js'