@defra/fcp-sfd-frontend-engine 0.22.1 → 0.24.0

package/dist/index.js

@@ -61,6 +61,52 @@ var BUSINESS_EMAIL_ADDRESS = "You have updated your business email address";
 var BUSINESS_NAME = "You have updated your business name";
 var BUSINESS_PHONE_NUMBERS = "You have updated your business phone numbers";
 
+// src/constants/interrupter-journey.js
+var PERSONAL_SECTION_FIELD_ORDER = {
+  name: ["first", "middle", "last"],
+  dob: ["day", "month", "year"],
+  address: ["address1", "address2", "address3", "city", "county", "postcode", "country"],
+  phone: ["personalTelephone", "personalMobile"],
+  email: ["personalEmail"]
+};
+var BUSINESS_SECTION_FIELD_ORDER = {
+  name: ["businessName"],
+  address: ["address1", "address2", "address3", "city", "county", "postcode", "country"],
+  phone: ["businessTelephone", "businessMobile"],
+  email: ["businessEmail"],
+  vat: ["vatNumber"]
+};
+var PERSONAL_SECTION_ORDER = ["name", "dob", "address", "phone", "email"];
+var BUSINESS_SECTION_ORDER = ["name", "address", "phone", "email", "vat"];
+var PERSONAL_SECTION_LABELS = {
+  name: "full name",
+  dob: "date of birth",
+  address: "personal address",
+  phone: "personal phone number",
+  email: "personal email address"
+};
+var BUSINESS_SECTION_LABELS = {
+  name: "business name",
+  address: "business address",
+  phone: "at least one business phone number",
+  email: "business email address",
+  vat: "business VAT number"
+};
+var PERSONAL_UPDATE_TEXT_LABELS = {
+  name: "your full name",
+  dob: "your date of birth",
+  address: "your personal address",
+  phone: "at least one personal phone number",
+  email: "your personal email address"
+};
+var BUSINESS_UPDATE_TEXT_LABELS = {
+  name: "your business name",
+  address: "your business address",
+  phone: "at least one business phone number",
+  email: "your business email address",
+  vat: "your business VAT number"
+};
+
 // src/constants/index.js
 var constants = {
   statusCodes: {
@@ -98,6 +144,16 @@ var constants = {
     BUSINESS_EMAIL_ADDRESS,
     BUSINESS_NAME,
     BUSINESS_PHONE_NUMBERS
+  },
+  interrupterJourney: {
+    PERSONAL_SECTION_FIELD_ORDER,
+    BUSINESS_SECTION_FIELD_ORDER,
+    PERSONAL_SECTION_ORDER,
+    BUSINESS_SECTION_ORDER,
+    PERSONAL_SECTION_LABELS,
+    BUSINESS_SECTION_LABELS,
+    PERSONAL_UPDATE_TEXT_LABELS,
+    BUSINESS_UPDATE_TEXT_LABELS
   }
 };
 
@@ -826,6 +882,48 @@ var updateBusinessAddressMutation = `
   }
 `;
 
+// src/mutations/personal/update-customer-details.js
+var updateCustomerDetailsMutation = `
+  mutation UpdateCustomerAllFields($input: UpdateCustomerAllFieldsInput!) {
+    updateCustomerAllFields(input: $input) {
+      success
+      customer {
+        info {
+          name {
+            first
+            middle
+            last
+          }
+          dateOfBirth
+          phone {
+            mobile
+            landline
+          }
+          email {
+            address
+          }
+          address {
+            line1
+            line2
+            line3
+            line4
+            line5
+            buildingNumberRange
+            buildingName
+            flatName
+            street
+            city
+            county
+            postalCode
+            country
+            uprn
+          }
+        }
+      }
+    }
+  }
+`;
+
 // src/mutations/mutations.js
 var mutations = {
   updateBusinessEmail: updateBusinessEmailMutation,
@@ -836,7 +934,8 @@ var mutations = {
   updateCustomerDob: updateCustomerDobMutation,
   updateCustomerPhone: updateCustomerPhoneMutation,
   updateCustomerEmail: updateCustomerEmailMutation,
-  updateCustomerAddress: updateCustomerAddressMutation
+  updateCustomerAddress: updateCustomerAddressMutation,
+  updateCustomerDetails: updateCustomerDetailsMutation
 };
 
 // src/presenters/base-presenter.js
@@ -1440,11 +1539,239 @@ var nullIfUndefined = (value) => {
   return value ?? null;
 };
 
+// src/services/check-interrupter-journey-session-service.js
+var checkInterrupterJourneySessionService = (yar, journeyKey) => {
+  const sessionData = yar.get(journeyKey);
+  if (!sessionData) {
+    return false;
+  }
+  if (Array.isArray(sessionData.orderedSectionsToFix)) {
+    return true;
+  }
+  return false;
+};
+
+// src/services/initialise-fix-journey-service.js
+var initialiseFixJourneyService = (yar, source, journeyType) => {
+  let sessionKey;
+  let sectionOrder = [];
+  if (journeyType === "business") {
+    sessionKey = "businessDetailsValidation";
+    sectionOrder = BUSINESS_SECTION_ORDER;
+  }
+  if (journeyType === "personal") {
+    sessionKey = "personalDetailsValidation";
+    sectionOrder = PERSONAL_SECTION_ORDER;
+  }
+  const sessionData = yar.get(sessionKey);
+  if (!(sessionData == null ? void 0 : sessionData.sectionsNeedingUpdate)) {
+    return sessionData;
+  }
+  const orderedSectionsToFix = orderSectionsToFix(
+    sessionData.sectionsNeedingUpdate,
+    source,
+    sectionOrder
+  );
+  updateSessionData(sessionData, source, orderedSectionsToFix);
+  yar.set(sessionKey, sessionData);
+  return sessionData;
+};
+var updateSessionData = (sessionData, source, orderedSectionsToFix) => {
+  sessionData.orderedSectionsToFix = orderedSectionsToFix;
+  delete sessionData.sectionsNeedingUpdate;
+  delete sessionData.personalFixUpdates;
+  delete sessionData.businessFixUpdates;
+  if (source) {
+    sessionData.source = source;
+  }
+};
+var orderSectionsToFix = (sectionsNeedingUpdate, source, SECTION_ORDER) => {
+  const sections = SECTION_ORDER.filter((section) => {
+    return sectionsNeedingUpdate.includes(section);
+  });
+  if (!source) {
+    return sections;
+  }
+  if (!SECTION_ORDER.includes(source)) {
+    return sections;
+  }
+  return [
+    source,
+    ...sections.filter((section) => section !== source)
+  ];
+};
+
+// src/services/validate-fix-details-service.js
+var validateFixDetailsService = (payload, orderedSectionsToFix, schemas2) => {
+  const errors = [];
+  for (const section of orderedSectionsToFix) {
+    const schema = schemas2[section];
+    const result = schema.validate(payload, {
+      abortEarly: false,
+      allowUnknown: true
+    });
+    if (result.error) {
+      errors.push(...result.error.details);
+    }
+  }
+  if (errors.length > 0) {
+    return {
+      error: {
+        details: errors
+      }
+    };
+  }
+  return { value: payload };
+};
+
+// src/services/set-fix-session-data-service.js
+var setFixSessionDataService = (yar, sessionData, payload, journeyKey, updateKey) => {
+  const orderedSectionsToFix = sessionData.orderedSectionsToFix;
+  const type = journeyKey === "businessDetailsValidation" ? "business" : "personal";
+  const SECTION_FIELD_ORDER = type === "business" ? BUSINESS_SECTION_FIELD_ORDER : PERSONAL_SECTION_FIELD_ORDER;
+  const fixUpdates = {};
+  for (const section of orderedSectionsToFix) {
+    const fields = SECTION_FIELD_ORDER[section];
+    fixUpdates[section] = {};
+    for (const field of fields) {
+      fixUpdates[section][field] = payload[field] ?? "";
+    }
+  }
+  sessionData[updateKey] = fixUpdates;
+  yar.set(journeyKey, sessionData);
+};
+
+// src/services/build-fix-success-message-service.js
+var LABEL_MAPS = {
+  personal: {
+    name: "full name",
+    email: "personal email address",
+    phone: "personal phone numbers",
+    dob: "date of birth",
+    address: "personal address"
+  },
+  business: {
+    name: "business name",
+    email: "business email address",
+    phone: "business phone numbers",
+    vat: "business vat number",
+    address: "business address"
+  }
+};
+var PROPERTY_MAPS = {
+  personal: {
+    name: "changePersonalName",
+    email: "changePersonalEmail",
+    phone: "changePersonalPhoneNumbers",
+    dob: "changePersonalDob",
+    address: "changePersonalAddress"
+  },
+  business: {
+    name: "changeBusinessName",
+    email: "changeBusinessEmail",
+    phone: "changeBusinessPhoneNumbers",
+    vat: "changeBusinessVat",
+    address: "changeBusinessAddress"
+  }
+};
+var buildFixSuccessMessageService = (type, details) => {
+  const { orderedSectionsToFix } = details;
+  const changes = loopThroughSections(type, details, orderedSectionsToFix);
+  if (changes.length === 0) {
+    return null;
+  }
+  if (changes.length === 1) {
+    return {
+      type: "text",
+      value: `You have updated your ${changes[0]}`
+    };
+  }
+  return {
+    type: "html",
+    value: `
+      <h3 class="govuk-notification-banner__heading">
+        You have updated your:
+      </h3>
+      <ul class="govuk-list govuk-list--bullet">
+        ${changes.map((change) => `<li>${change}</li>`).join("")}
+      </ul>
+    `
+  };
+};
+var loopThroughSections = (type, details, orderedSectionsToFix) => {
+  const changes = [];
+  const labelMap = LABEL_MAPS[type];
+  const propertyMap = PROPERTY_MAPS[type];
+  for (const section of orderedSectionsToFix) {
+    if (details[propertyMap[section]]) {
+      changes.push(labelMap[section]);
+    }
+  }
+  return changes;
+};
+
+// src/services/personal/build-customer-fix-update-variables-service.js
+var buildCustomerFixUpdateVariablesService = (personalDetails) => {
+  const { orderedSectionsToFix, crn } = personalDetails;
+  const input = { crn };
+  if (orderedSectionsToFix.includes("name") && personalDetails.changePersonalName) {
+    Object.assign(input, buildNameInput(personalDetails.changePersonalName));
+  }
+  if (orderedSectionsToFix.includes("email") && personalDetails.changePersonalEmail) {
+    Object.assign(input, buildEmailInput(personalDetails.changePersonalEmail));
+  }
+  if (orderedSectionsToFix.includes("phone") && personalDetails.changePersonalPhoneNumbers) {
+    Object.assign(input, buildPhoneInput(personalDetails.changePersonalPhoneNumbers));
+  }
+  if (orderedSectionsToFix.includes("dob") && personalDetails.changePersonalDob) {
+    Object.assign(input, buildDobInput(personalDetails.changePersonalDob));
+  }
+  if (orderedSectionsToFix.includes("address") && personalDetails.changePersonalAddress) {
+    Object.assign(input, { address: buildManualAddress(personalDetails.changePersonalAddress) });
+  }
+  return { input };
+};
+var buildPhoneInput = (change) => {
+  return {
+    phone: {
+      landline: change.personalTelephone ?? null,
+      mobile: change.personalMobile ?? null
+    }
+  };
+};
+var buildEmailInput = (change) => {
+  return {
+    email: {
+      address: change.personalEmail
+    }
+  };
+};
+var buildNameInput = (change) => {
+  return {
+    first: change.first,
+    middle: change.middle ?? null,
+    last: change.last
+  };
+};
+var buildDobInput = (change) => {
+  const { day, month, year } = change;
+  return {
+    // DAL expects dateOfBirth as YYYY-MM-DD e.g. '1990-04-05' not '1990-4-5'
+    dateOfBirth: `${year}-${String(month).padStart(2, "0")}-${String(day).padStart(2, "0")}`
+  };
+};
+
 // src/services/services.js
 var services = {
   addressLookup: addressLookupService,
   buildUprnAddress,
-  buildManualAddress
+  buildManualAddress,
+  checkInterrupterJourneySession: checkInterrupterJourneySessionService,
+  initialiseFixJourney: initialiseFixJourneyService,
+  validateFixDetails: validateFixDetailsService,
+  setFixSessionData: setFixSessionDataService,
+  buildFixSuccessMessage: buildFixSuccessMessageService,
+  buildCustomerFixUpdateVariables: buildCustomerFixUpdateVariablesService
 };
 export {
   constants,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/fcp-sfd-frontend-engine",
-  "version": "0.22.1",
+  "version": "0.24.0",
   "description": "Shared frontend engine used by both the internal and external frontend applications.",
   "main": "./dist/index.cjs",
   "exports": {

package/src/constants/index.js

@@ -39,6 +39,18 @@ import {
   BUSINESS_PHONE_NUMBERS
 } from './success-messages.js'
 
+// Interrupter journey constants
+import {
+  PERSONAL_SECTION_FIELD_ORDER,
+  BUSINESS_SECTION_FIELD_ORDER,
+  PERSONAL_SECTION_ORDER,
+  BUSINESS_SECTION_ORDER,
+  PERSONAL_SECTION_LABELS,
+  BUSINESS_SECTION_LABELS,
+  PERSONAL_UPDATE_TEXT_LABELS,
+  BUSINESS_UPDATE_TEXT_LABELS
+} from './interrupter-journey.js'
+
 export const constants = {
   statusCodes: {
     BAD_REQUEST,
@@ -75,5 +87,15 @@ export const constants = {
     BUSINESS_EMAIL_ADDRESS,
     BUSINESS_NAME,
     BUSINESS_PHONE_NUMBERS
+  },
+  interrupterJourney: {
+    PERSONAL_SECTION_FIELD_ORDER,
+    BUSINESS_SECTION_FIELD_ORDER,
+    PERSONAL_SECTION_ORDER,
+    BUSINESS_SECTION_ORDER,
+    PERSONAL_SECTION_LABELS,
+    BUSINESS_SECTION_LABELS,
+    PERSONAL_UPDATE_TEXT_LABELS,
+    BUSINESS_UPDATE_TEXT_LABELS
   }
 }

package/src/constants/interrupter-journey.js

@@ -0,0 +1,62 @@
+/**
+ * Constants for the interrupter journey.
+ *
+ * Defines the field order for personal and business detail sections,
+ * display labels, and the consistent ordering of sections for the fix journey.
+ *
+ * The ordering defined here is used throughout the fix journey to ensure
+ * consistent presentation of sections and error ordering.
+ *
+ * @module interrupter-journey-constants
+ */
+
+export const PERSONAL_SECTION_FIELD_ORDER = {
+  name: ['first', 'middle', 'last'],
+  dob: ['day', 'month', 'year'],
+  address: ['address1', 'address2', 'address3', 'city', 'county', 'postcode', 'country'],
+  phone: ['personalTelephone', 'personalMobile'],
+  email: ['personalEmail']
+}
+
+export const BUSINESS_SECTION_FIELD_ORDER = {
+  name: ['businessName'],
+  address: ['address1', 'address2', 'address3', 'city', 'county', 'postcode', 'country'],
+  phone: ['businessTelephone', 'businessMobile'],
+  email: ['businessEmail'],
+  vat: ['vatNumber']
+}
+
+export const PERSONAL_SECTION_ORDER = ['name', 'dob', 'address', 'phone', 'email']
+export const BUSINESS_SECTION_ORDER = ['name', 'address', 'phone', 'email', 'vat']
+
+export const PERSONAL_SECTION_LABELS = {
+  name: 'full name',
+  dob: 'date of birth',
+  address: 'personal address',
+  phone: 'personal phone number',
+  email: 'personal email address'
+}
+
+export const BUSINESS_SECTION_LABELS = {
+  name: 'business name',
+  address: 'business address',
+  phone: 'at least one business phone number',
+  email: 'business email address',
+  vat: 'business VAT number'
+}
+
+export const PERSONAL_UPDATE_TEXT_LABELS = {
+  name: 'your full name',
+  dob: 'your date of birth',
+  address: 'your personal address',
+  phone: 'at least one personal phone number',
+  email: 'your personal email address'
+}
+
+export const BUSINESS_UPDATE_TEXT_LABELS = {
+  name: 'your business name',
+  address: 'your business address',
+  phone: 'at least one business phone number',
+  email: 'your business email address',
+  vat: 'your business VAT number'
+}

package/src/mutations/mutations.js

@@ -7,6 +7,7 @@ import { updateCustomerPhoneMutation } from './personal/update-customer-phone.js
 import { updateCustomerEmailMutation } from './personal/update-customer-email.js'
 import { updateCustomerAddressMutation } from './personal/update-customer-address.js'
 import { updateBusinessAddressMutation } from './business/update-business-address.js'
+import { updateCustomerDetailsMutation } from './personal/update-customer-details.js'
 
 export const mutations = {
   updateBusinessEmail: updateBusinessEmailMutation,
@@ -17,5 +18,6 @@ export const mutations = {
   updateCustomerDob: updateCustomerDobMutation,
   updateCustomerPhone: updateCustomerPhoneMutation,
   updateCustomerEmail: updateCustomerEmailMutation,
-  updateCustomerAddress: updateCustomerAddressMutation
+  updateCustomerAddress: updateCustomerAddressMutation,
+  updateCustomerDetails: updateCustomerDetailsMutation
 }

package/src/mutations/personal/update-customer-details.js

@@ -0,0 +1,40 @@
+export const updateCustomerDetailsMutation = `
+  mutation UpdateCustomerAllFields($input: UpdateCustomerAllFieldsInput!) {
+    updateCustomerAllFields(input: $input) {
+      success
+      customer {
+        info {
+          name {
+            first
+            middle
+            last
+          }
+          dateOfBirth
+          phone {
+            mobile
+            landline
+          }
+          email {
+            address
+          }
+          address {
+            line1
+            line2
+            line3
+            line4
+            line5
+            buildingNumberRange
+            buildingName
+            flatName
+            street
+            city
+            county
+            postalCode
+            country
+            uprn
+          }
+        }
+      }
+    }
+  }
+`

package/src/services/build-fix-success-message-service.js

@@ -0,0 +1,95 @@
+/**
+ * Builds a success notification message based on which personal or business
+ * details were updated by the user.
+ *
+ * Returns either plain text (for a single change), HTML (for multiple changes),
+ * or null (when nothing changed) suitable for rendering inside a GOV.UK
+ * notification banner.
+ * @module buildFixSuccessMessageService
+ */
+
+const LABEL_MAPS = {
+  personal: {
+    name: 'full name',
+    email: 'personal email address',
+    phone: 'personal phone numbers',
+    dob: 'date of birth',
+    address: 'personal address'
+  },
+  business: {
+    name: 'business name',
+    email: 'business email address',
+    phone: 'business phone numbers',
+    vat: 'business vat number',
+    address: 'business address'
+  }
+}
+
+const PROPERTY_MAPS = {
+  personal: {
+    name: 'changePersonalName',
+    email: 'changePersonalEmail',
+    phone: 'changePersonalPhoneNumbers',
+    dob: 'changePersonalDob',
+    address: 'changePersonalAddress'
+  },
+  business: {
+    name: 'changeBusinessName',
+    email: 'changeBusinessEmail',
+    phone: 'changeBusinessPhoneNumbers',
+    vat: 'changeBusinessVat',
+    address: 'changeBusinessAddress'
+  }
+}
+
+const buildFixSuccessMessageService = (type, details) => {
+  const { orderedSectionsToFix } = details
+
+  const changes = loopThroughSections(type, details, orderedSectionsToFix)
+
+  if (changes.length === 0) {
+    return null
+  }
+
+  if (changes.length === 1) {
+    return {
+      type: 'text',
+      value: `You have updated your ${changes[0]}`
+    }
+  }
+
+  return {
+    type: 'html',
+    value: `
+      <h3 class="govuk-notification-banner__heading">
+        You have updated your:
+      </h3>
+      <ul class="govuk-list govuk-list--bullet">
+        ${changes.map(change => `<li>${change}</li>`).join('')}
+      </ul>
+    `
+  }
+}
+
+const loopThroughSections = (type, details, orderedSectionsToFix) => {
+  const changes = []
+
+  // Pick the personal/business label and property maps for this journey type
+  const labelMap = LABEL_MAPS[type]
+  const propertyMap = PROPERTY_MAPS[type]
+
+  // Loop through the ordered sections and check if each section has change data
+  for (const section of orderedSectionsToFix) {
+    // Only include a section if its change data is actually present
+    if (details[propertyMap[section]]) {
+      // Store the human-readable label rather than the raw section key
+      changes.push(labelMap[section])
+    }
+  }
+
+  return changes
+}
+
+export {
+  buildFixSuccessMessageService
+}

package/src/services/check-interrupter-journey-session-service.js

@@ -0,0 +1,37 @@
+/**
+ * Validates that an interrupter journey session is still usable.
+ *
+ * Ensures the expected session structure exists before allowing
+ * the user to continue a fix journey.
+ *
+ * If the session has been cleared or is incomplete (for example,
+ * due to multi-tab usage), the journey should be restarted.
+ *
+ * @module checkInterrupterJourneySessionService
+ */
+
+/**
+ * Returns true if the session contains valid data for the given journey.
+ * Returns false if the session is missing or incomplete.
+ *
+ * @param {Object} yar - Hapi session object
+ * @param {string} journeyKey - Session key for the journey (e.g., 'personalDetailsValidation')
+ * @returns {boolean} True if session has orderedSectionsToFix array, false otherwise
+ */
+const checkInterrupterJourneySessionService = (yar, journeyKey) => {
+  const sessionData = yar.get(journeyKey)
+
+  if (!sessionData) {
+    return false
+  }
+
+  if (Array.isArray(sessionData.orderedSectionsToFix)) {
+    return true
+  }
+
+  return false
+}
+
+export {
+  checkInterrupterJourneySessionService
+}