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

package/dist/index.cjs

@@ -923,6 +923,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,
@@ -933,7 +975,8 @@ var mutations = {
   updateCustomerDob: updateCustomerDobMutation,
   updateCustomerPhone: updateCustomerPhoneMutation,
   updateCustomerEmail: updateCustomerEmailMutation,
-  updateCustomerAddress: updateCustomerAddressMutation
+  updateCustomerAddress: updateCustomerAddressMutation,
+  updateCustomerDetails: updateCustomerDetailsMutation
 };
 
 // src/presenters/base-presenter.js
@@ -1639,6 +1682,126 @@ var setFixSessionDataService = (yar, sessionData, payload, journeyKey, updateKey
   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,
@@ -1647,7 +1810,9 @@ var services = {
   checkInterrupterJourneySession: checkInterrupterJourneySessionService,
   initialiseFixJourney: initialiseFixJourneyService,
   validateFixDetails: validateFixDetailsService,
-  setFixSessionData: setFixSessionDataService
+  setFixSessionData: setFixSessionDataService,
+  buildFixSuccessMessage: buildFixSuccessMessageService,
+  buildCustomerFixUpdateVariables: buildCustomerFixUpdateVariablesService
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.js

@@ -882,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,
@@ -892,7 +934,8 @@ var mutations = {
   updateCustomerDob: updateCustomerDobMutation,
   updateCustomerPhone: updateCustomerPhoneMutation,
   updateCustomerEmail: updateCustomerEmailMutation,
-  updateCustomerAddress: updateCustomerAddressMutation
+  updateCustomerAddress: updateCustomerAddressMutation,
+  updateCustomerDetails: updateCustomerDetailsMutation
 };
 
 // src/presenters/base-presenter.js
@@ -1598,6 +1641,126 @@ var setFixSessionDataService = (yar, sessionData, payload, journeyKey, updateKey
   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,
@@ -1606,7 +1769,9 @@ var services = {
   checkInterrupterJourneySession: checkInterrupterJourneySessionService,
   initialiseFixJourney: initialiseFixJourneyService,
   validateFixDetails: validateFixDetailsService,
-  setFixSessionData: setFixSessionDataService
+  setFixSessionData: setFixSessionDataService,
+  buildFixSuccessMessage: buildFixSuccessMessageService,
+  buildCustomerFixUpdateVariables: buildCustomerFixUpdateVariablesService
 };
 export {
   constants,

package/package.json

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

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/personal/build-customer-fix-update-variables-service.js

@@ -0,0 +1,76 @@
+/**
+ * Builds mutation variables for updating a user's personal details via the fix journey.
+ * Only includes the sections that actually need updating, using the
+ * unified `input` format for the GraphQL mutation.
+ *
+ * @module buildCustomerFixUpdateVariablesService
+ */
+
+import { buildManualAddress } from '../build-address-variables-service.js'
+
+const buildCustomerFixUpdateVariablesService = (personalDetails) => {
+  const { orderedSectionsToFix, crn } = personalDetails
+
+  const input = { crn }
+
+  // Conditionally merge each section into input if it's been updated by the user
+  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 }
+}
+
+const buildPhoneInput = (change) => {
+  return {
+    phone: {
+      landline: change.personalTelephone ?? null,
+      mobile: change.personalMobile ?? null
+    }
+  }
+}
+
+const buildEmailInput = (change) => {
+  return {
+    email: {
+      address: change.personalEmail
+    }
+  }
+}
+
+const buildNameInput = (change) => {
+  return {
+    first: change.first,
+    middle: change.middle ?? null,
+    last: change.last
+  }
+}
+
+const 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')}`
+  }
+}
+
+export {
+  buildCustomerFixUpdateVariablesService
+}

package/src/services/services.js

@@ -4,6 +4,8 @@ import { checkInterrupterJourneySessionService } from './check-interrupter-journ
 import { initialiseFixJourneyService } from './initialise-fix-journey-service.js'
 import { validateFixDetailsService } from './validate-fix-details-service.js'
 import { setFixSessionDataService } from './set-fix-session-data-service.js'
+import { buildFixSuccessMessageService } from './build-fix-success-message-service.js'
+import { buildCustomerFixUpdateVariablesService } from './personal/build-customer-fix-update-variables-service.js'
 
 export const services = {
   addressLookup: addressLookupService,
@@ -12,5 +14,7 @@ export const services = {
   checkInterrupterJourneySession: checkInterrupterJourneySessionService,
   initialiseFixJourney: initialiseFixJourneyService,
   validateFixDetails: validateFixDetailsService,
-  setFixSessionData: setFixSessionDataService
+  setFixSessionData: setFixSessionDataService,
+  buildFixSuccessMessage: buildFixSuccessMessageService,
+  buildCustomerFixUpdateVariables: buildCustomerFixUpdateVariablesService
 }