@defra/fcp-sfd-frontend-engine 0.19.0 → 0.21.0

package/dist/index.cjs

@@ -100,6 +100,7 @@ var MONTH_MAP = {
 // src/constants/success-messages.js
 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/index.js
 var constants = {
@@ -136,7 +137,8 @@ var constants = {
   monthMap: MONTH_MAP,
   successMessages: {
     BUSINESS_EMAIL_ADDRESS,
-    BUSINESS_NAME
+    BUSINESS_NAME,
+    BUSINESS_PHONE_NUMBERS
   }
 };
 
@@ -704,7 +706,7 @@ var mappers = {
 
 // src/mutations/business/update-business-email.js
 var updateBusinessEmailMutation = `
-  mutation Mutation($input: UpdateBusinessEmailInput!) {
+  mutation UpdateBusinessEmail($input: UpdateBusinessEmailInput!) {
     updateBusinessEmail(input: $input) {
       business {
         info {
@@ -732,6 +734,22 @@ var updateBusinessNameMutation = `
   }
 `;
 
+// src/mutations/business/update-business-phone-numbers.js
+var updateBusinessPhoneNumbersMutation = `
+  mutation UpdateBusinessPhoneNumbers($input: UpdateBusinessPhoneNumbersInput!) {
+    updateBusinessPhone(input: $input) {
+      business {
+        info {
+          phone {
+            landline
+            mobile
+          }
+        }
+      }
+    }
+  }
+`;
+
 // src/mutations/personal/update-customer-name.js
 var updateCustomerNameMutation = `
   mutation UpdateCustomerName($input: UpdateCustomerNameInput!) {
@@ -793,14 +811,73 @@ var updateCustomerEmailMutation = `
   }
 `;
 
+// src/mutations/personal/update-customer-address.js
+var updateCustomerAddressMutation = `
+  mutation UpdateCustomerAddress($input: UpdateCustomerAddressInput!) {
+    updateCustomerAddress(input: $input) {
+      customer {
+        info {
+          address {
+            line1
+            line2
+            line3
+            line4
+            line5
+            postalCode
+            country
+            city
+            buildingNumberRange
+            buildingName
+            flatName
+            street
+            county
+            uprn
+          }
+        }
+      }
+    }
+  }
+`;
+
+// src/mutations/business/update-business-address.js
+var updateBusinessAddressMutation = `
+  mutation UpdateBusinessAddress($input: UpdateBusinessAddressInput!) {
+    updateBusinessAddress(input: $input) {
+      business {
+        info {
+          address {
+            line1
+            line2
+            line3
+            line4
+            line5
+            postalCode
+            country
+            city
+            buildingNumberRange
+            buildingName
+            flatName
+            street
+            county
+            uprn
+          }
+        }
+      }
+    }
+  }
+`;
+
 // src/mutations/mutations.js
 var mutations = {
   updateBusinessEmail: updateBusinessEmailMutation,
   updateBusinessName: updateBusinessNameMutation,
+  updateBusinessPhoneNumbers: updateBusinessPhoneNumbersMutation,
+  updateBusinessAddress: updateBusinessAddressMutation,
   updateCustomerName: updateCustomerNameMutation,
   updateCustomerDob: updateCustomerDobMutation,
   updateCustomerPhone: updateCustomerPhoneMutation,
-  updateCustomerEmail: updateCustomerEmailMutation
+  updateCustomerEmail: updateCustomerEmailMutation,
+  updateCustomerAddress: updateCustomerAddressMutation
 };
 
 // src/presenters/base-presenter.js
@@ -1071,12 +1148,26 @@ var buildUpdateBusinessNameVariables = (name, sbi) => {
   return { input: { name, sbi } };
 };
 
+// src/utils/build-update-business-phone-numbers-variables.js
+var buildUpdateBusinessPhoneNumbersVariables = (businessTelephone, businessMobile, sbi) => {
+  return {
+    input: {
+      phone: {
+        landline: businessTelephone ?? null,
+        mobile: businessMobile ?? null
+      },
+      sbi
+    }
+  };
+};
+
 // src/utils/utils.js
 var utils = {
   formatFullName,
   formatValidationErrors,
   buildUpdateBusinessEmailVariables,
-  buildUpdateBusinessNameVariables
+  buildUpdateBusinessNameVariables,
+  buildUpdateBusinessPhoneNumbersVariables
 };
 
 // src/services/os-places/address-lookup-service.js
@@ -1321,9 +1412,64 @@ var isRetryable = (error) => {
   return false;
 };
 
+// src/services/build-address-variables-service.js
+var buildUprnAddress = (change) => {
+  return {
+    pafOrganisationName: nullIfUndefined(change.pafOrganisationName),
+    buildingNumberRange: nullIfUndefined(change.buildingNumberRange),
+    buildingName: nullIfUndefined(change.buildingName),
+    flatName: nullIfUndefined(change.flatName),
+    street: nullIfUndefined(change.street),
+    city: nullIfUndefined(change.city),
+    county: nullIfUndefined(change.county),
+    postalCode: nullIfUndefined(change.postcode),
+    country: nullIfUndefined(change.country),
+    dependentLocality: nullIfUndefined(change.dependentLocality),
+    doubleDependentLocality: nullIfUndefined(change.doubleDependentLocality),
+    line1: null,
+    line2: null,
+    line3: null,
+    line4: null,
+    line5: null,
+    uprn: change.uprn
+    // required for DAL/v1
+  };
+};
+var buildManualAddress = (change) => {
+  return {
+    pafOrganisationName: null,
+    buildingNumberRange: null,
+    buildingName: null,
+    flatName: null,
+    street: null,
+    dependentLocality: null,
+    doubleDependentLocality: null,
+    county: null,
+    uprn: null,
+    line1: change.address1,
+    // required for DAL/v1
+    line2: nullIfUndefined(change.address2),
+    line3: nullIfUndefined(change.address3),
+    line4: nullIfUndefined(change.county),
+    // manual county mapped for validation
+    line5: null,
+    city: change.city,
+    // required for DAL/v1
+    postalCode: change.postcode,
+    // required for DAL/v1
+    country: change.country
+    // required for DAL/v1
+  };
+};
+var nullIfUndefined = (value) => {
+  return value ?? null;
+};
+
 // src/services/services.js
 var services = {
-  addressLookup: addressLookupService
+  addressLookup: addressLookupService,
+  buildUprnAddress,
+  buildManualAddress
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.js

@@ -59,6 +59,7 @@ var MONTH_MAP = {
 // src/constants/success-messages.js
 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/index.js
 var constants = {
@@ -95,7 +96,8 @@ var constants = {
   monthMap: MONTH_MAP,
   successMessages: {
     BUSINESS_EMAIL_ADDRESS,
-    BUSINESS_NAME
+    BUSINESS_NAME,
+    BUSINESS_PHONE_NUMBERS
   }
 };
 
@@ -663,7 +665,7 @@ var mappers = {
 
 // src/mutations/business/update-business-email.js
 var updateBusinessEmailMutation = `
-  mutation Mutation($input: UpdateBusinessEmailInput!) {
+  mutation UpdateBusinessEmail($input: UpdateBusinessEmailInput!) {
     updateBusinessEmail(input: $input) {
       business {
         info {
@@ -691,6 +693,22 @@ var updateBusinessNameMutation = `
   }
 `;
 
+// src/mutations/business/update-business-phone-numbers.js
+var updateBusinessPhoneNumbersMutation = `
+  mutation UpdateBusinessPhoneNumbers($input: UpdateBusinessPhoneNumbersInput!) {
+    updateBusinessPhone(input: $input) {
+      business {
+        info {
+          phone {
+            landline
+            mobile
+          }
+        }
+      }
+    }
+  }
+`;
+
 // src/mutations/personal/update-customer-name.js
 var updateCustomerNameMutation = `
   mutation UpdateCustomerName($input: UpdateCustomerNameInput!) {
@@ -752,14 +770,73 @@ var updateCustomerEmailMutation = `
   }
 `;
 
+// src/mutations/personal/update-customer-address.js
+var updateCustomerAddressMutation = `
+  mutation UpdateCustomerAddress($input: UpdateCustomerAddressInput!) {
+    updateCustomerAddress(input: $input) {
+      customer {
+        info {
+          address {
+            line1
+            line2
+            line3
+            line4
+            line5
+            postalCode
+            country
+            city
+            buildingNumberRange
+            buildingName
+            flatName
+            street
+            county
+            uprn
+          }
+        }
+      }
+    }
+  }
+`;
+
+// src/mutations/business/update-business-address.js
+var updateBusinessAddressMutation = `
+  mutation UpdateBusinessAddress($input: UpdateBusinessAddressInput!) {
+    updateBusinessAddress(input: $input) {
+      business {
+        info {
+          address {
+            line1
+            line2
+            line3
+            line4
+            line5
+            postalCode
+            country
+            city
+            buildingNumberRange
+            buildingName
+            flatName
+            street
+            county
+            uprn
+          }
+        }
+      }
+    }
+  }
+`;
+
 // src/mutations/mutations.js
 var mutations = {
   updateBusinessEmail: updateBusinessEmailMutation,
   updateBusinessName: updateBusinessNameMutation,
+  updateBusinessPhoneNumbers: updateBusinessPhoneNumbersMutation,
+  updateBusinessAddress: updateBusinessAddressMutation,
   updateCustomerName: updateCustomerNameMutation,
   updateCustomerDob: updateCustomerDobMutation,
   updateCustomerPhone: updateCustomerPhoneMutation,
-  updateCustomerEmail: updateCustomerEmailMutation
+  updateCustomerEmail: updateCustomerEmailMutation,
+  updateCustomerAddress: updateCustomerAddressMutation
 };
 
 // src/presenters/base-presenter.js
@@ -1030,12 +1107,26 @@ var buildUpdateBusinessNameVariables = (name, sbi) => {
   return { input: { name, sbi } };
 };
 
+// src/utils/build-update-business-phone-numbers-variables.js
+var buildUpdateBusinessPhoneNumbersVariables = (businessTelephone, businessMobile, sbi) => {
+  return {
+    input: {
+      phone: {
+        landline: businessTelephone ?? null,
+        mobile: businessMobile ?? null
+      },
+      sbi
+    }
+  };
+};
+
 // src/utils/utils.js
 var utils = {
   formatFullName,
   formatValidationErrors,
   buildUpdateBusinessEmailVariables,
-  buildUpdateBusinessNameVariables
+  buildUpdateBusinessNameVariables,
+  buildUpdateBusinessPhoneNumbersVariables
 };
 
 // src/services/os-places/address-lookup-service.js
@@ -1280,9 +1371,64 @@ var isRetryable = (error) => {
   return false;
 };
 
+// src/services/build-address-variables-service.js
+var buildUprnAddress = (change) => {
+  return {
+    pafOrganisationName: nullIfUndefined(change.pafOrganisationName),
+    buildingNumberRange: nullIfUndefined(change.buildingNumberRange),
+    buildingName: nullIfUndefined(change.buildingName),
+    flatName: nullIfUndefined(change.flatName),
+    street: nullIfUndefined(change.street),
+    city: nullIfUndefined(change.city),
+    county: nullIfUndefined(change.county),
+    postalCode: nullIfUndefined(change.postcode),
+    country: nullIfUndefined(change.country),
+    dependentLocality: nullIfUndefined(change.dependentLocality),
+    doubleDependentLocality: nullIfUndefined(change.doubleDependentLocality),
+    line1: null,
+    line2: null,
+    line3: null,
+    line4: null,
+    line5: null,
+    uprn: change.uprn
+    // required for DAL/v1
+  };
+};
+var buildManualAddress = (change) => {
+  return {
+    pafOrganisationName: null,
+    buildingNumberRange: null,
+    buildingName: null,
+    flatName: null,
+    street: null,
+    dependentLocality: null,
+    doubleDependentLocality: null,
+    county: null,
+    uprn: null,
+    line1: change.address1,
+    // required for DAL/v1
+    line2: nullIfUndefined(change.address2),
+    line3: nullIfUndefined(change.address3),
+    line4: nullIfUndefined(change.county),
+    // manual county mapped for validation
+    line5: null,
+    city: change.city,
+    // required for DAL/v1
+    postalCode: change.postcode,
+    // required for DAL/v1
+    country: change.country
+    // required for DAL/v1
+  };
+};
+var nullIfUndefined = (value) => {
+  return value ?? null;
+};
+
 // src/services/services.js
 var services = {
-  addressLookup: addressLookupService
+  addressLookup: addressLookupService,
+  buildUprnAddress,
+  buildManualAddress
 };
 export {
   constants,

package/package.json

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

package/src/constants/index.js

@@ -33,7 +33,11 @@ import { PHONE_NUMBER_PATTERN, NO_CONTROL_CHARS_PATTERN } from './patterns.js'
 import { MONTH_MAP } from './month-map.js'
 
 // Success messages
-import { BUSINESS_EMAIL_ADDRESS, BUSINESS_NAME } from './success-messages.js'
+import {
+  BUSINESS_EMAIL_ADDRESS,
+  BUSINESS_NAME,
+  BUSINESS_PHONE_NUMBERS
+} from './success-messages.js'
 
 export const constants = {
   statusCodes: {
@@ -69,6 +73,7 @@ export const constants = {
   monthMap: MONTH_MAP,
   successMessages: {
     BUSINESS_EMAIL_ADDRESS,
-    BUSINESS_NAME
+    BUSINESS_NAME,
+    BUSINESS_PHONE_NUMBERS
   }
 }

package/src/constants/success-messages.js

@@ -1,2 +1,3 @@
 export const BUSINESS_EMAIL_ADDRESS = 'You have updated your business email address'
 export const BUSINESS_NAME = 'You have updated your business name'
+export const BUSINESS_PHONE_NUMBERS = 'You have updated your business phone numbers'

package/src/mutations/business/update-business-address.js

@@ -0,0 +1,26 @@
+export const updateBusinessAddressMutation = `
+  mutation UpdateBusinessAddress($input: UpdateBusinessAddressInput!) {
+    updateBusinessAddress(input: $input) {
+      business {
+        info {
+          address {
+            line1
+            line2
+            line3
+            line4
+            line5
+            postalCode
+            country
+            city
+            buildingNumberRange
+            buildingName
+            flatName
+            street
+            county
+            uprn
+          }
+        }
+      }
+    }
+  }
+`

package/src/mutations/business/update-business-email.js

@@ -1,5 +1,5 @@
 export const updateBusinessEmailMutation = `
-  mutation Mutation($input: UpdateBusinessEmailInput!) {
+  mutation UpdateBusinessEmail($input: UpdateBusinessEmailInput!) {
     updateBusinessEmail(input: $input) {
       business {
         info {

package/src/mutations/business/update-business-phone-numbers.js

@@ -0,0 +1,14 @@
+export const updateBusinessPhoneNumbersMutation = `
+  mutation UpdateBusinessPhoneNumbers($input: UpdateBusinessPhoneNumbersInput!) {
+    updateBusinessPhone(input: $input) {
+      business {
+        info {
+          phone {
+            landline
+            mobile
+          }
+        }
+      }
+    }
+  }
+`

package/src/mutations/mutations.js

@@ -1,15 +1,21 @@
 import { updateBusinessEmailMutation } from './business/update-business-email.js'
 import { updateBusinessNameMutation } from './business/update-business-name.js'
+import { updateBusinessPhoneNumbersMutation } from './business/update-business-phone-numbers.js'
 import { updateCustomerNameMutation } from './personal/update-customer-name.js'
 import { updateCustomerDobMutation } from './personal/update-customer-dob.js'
 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'
 
 export const mutations = {
   updateBusinessEmail: updateBusinessEmailMutation,
   updateBusinessName: updateBusinessNameMutation,
+  updateBusinessPhoneNumbers: updateBusinessPhoneNumbersMutation,
+  updateBusinessAddress: updateBusinessAddressMutation,
   updateCustomerName: updateCustomerNameMutation,
   updateCustomerDob: updateCustomerDobMutation,
   updateCustomerPhone: updateCustomerPhoneMutation,
-  updateCustomerEmail: updateCustomerEmailMutation
+  updateCustomerEmail: updateCustomerEmailMutation,
+  updateCustomerAddress: updateCustomerAddressMutation
 }

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

@@ -0,0 +1,26 @@
+export const updateCustomerAddressMutation = `
+  mutation UpdateCustomerAddress($input: UpdateCustomerAddressInput!) {
+    updateCustomerAddress(input: $input) {
+      customer {
+        info {
+          address {
+            line1
+            line2
+            line3
+            line4
+            line5
+            postalCode
+            country
+            city
+            buildingNumberRange
+            buildingName
+            flatName
+            street
+            county
+            uprn
+          }
+        }
+      }
+    }
+  }
+`

package/src/services/build-address-variables-service.js

@@ -0,0 +1,107 @@
+/**
+ * Service to build address variables for DAL mutations
+ *
+ * Supports both postcode lookup (with UPRN) and manually entered addresses.
+ * Handles normalization of optional fields, city, county, PO BOX, dependentLocality,
+ * and doubleDependentLocality. Returns an address object ready for the DAL mutation.
+ *
+ * @module buildAddressVariablesService
+ */
+
+/**
+ * Builds address variables for an address chosen via postcode lookup (with UPRN).
+ * When a UPRN is present, it is the only required field. The rest of the address
+ * data is included but the DAL/v1 does not apply further validation.
+ *
+ * Optional fields are normalized using nullIfUndefined to ensure they are
+ * explicitly set to `null` rather than being left `undefined`.
+ *
+ * @param {Object} change - The address change object containing UPRN and address fields
+ * @returns {Object} Address object formatted for DAL/v1 with UPRN
+ */
+const buildUprnAddress = (change) => {
+  return {
+    pafOrganisationName: nullIfUndefined(change.pafOrganisationName),
+    buildingNumberRange: nullIfUndefined(change.buildingNumberRange),
+    buildingName: nullIfUndefined(change.buildingName),
+    flatName: nullIfUndefined(change.flatName),
+    street: nullIfUndefined(change.street),
+    city: nullIfUndefined(change.city),
+    county: nullIfUndefined(change.county),
+    postalCode: nullIfUndefined(change.postcode),
+    country: nullIfUndefined(change.country),
+    dependentLocality: nullIfUndefined(change.dependentLocality),
+    doubleDependentLocality: nullIfUndefined(change.doubleDependentLocality),
+    line1: null,
+    line2: null,
+    line3: null,
+    line4: null,
+    line5: null,
+    uprn: change.uprn // required for DAL/v1
+  }
+}
+
+/**
+ * Builds address variables for a manually entered address (without UPRN).
+ *
+ * When there is no UPRN, the DAL/v1 applies stricter validation and requires
+ * the following fields:
+ * - `line1`
+ * - `city`
+ * - `postalCode`
+ * - `country`
+ *
+ * The manually entered address fields are mapped into the DAL structure as follows:
+ *
+ * | User input field | DAL field |
+ * |------------------|-----------|
+ * | address1         | line1     |
+ * | address2         | line2     |
+ * | address3         | line3     |
+ * | county           | line4     |
+ * | city             | city      |
+ *
+ * `line5` is not used for manual addresses and is explicitly set to `null`.
+ *
+ * Optional fields are normalized using `nullIfUndefined` so that `undefined`
+ * values are converted to `null`, ensuring consistent data sent to the DAL.
+ *
+ * @param {Object} change - The address change object containing manually entered address fields
+ * @returns {Object} Address object formatted for DAL/v1 without UPRN
+ */
+const buildManualAddress = (change) => {
+  return {
+    pafOrganisationName: null,
+    buildingNumberRange: null,
+    buildingName: null,
+    flatName: null,
+    street: null,
+    dependentLocality: null,
+    doubleDependentLocality: null,
+    county: null,
+    uprn: null,
+    line1: change.address1, // required for DAL/v1
+    line2: nullIfUndefined(change.address2),
+    line3: nullIfUndefined(change.address3),
+    line4: nullIfUndefined(change.county), // manual county mapped for validation
+    line5: null,
+    city: change.city, // required for DAL/v1
+    postalCode: change.postcode, // required for DAL/v1
+    country: change.country // required for DAL/v1
+  }
+}
+
+/**
+ * Normalizes a value to null if it is undefined.
+ * @param {*} value - The value to normalize
+ * @returns {*|null} The value if defined, otherwise null
+ * @private
+ */
+const nullIfUndefined = (value) => {
+  return value ?? null
+}
+
+export {
+  buildUprnAddress,
+  buildManualAddress
+}

package/src/services/services.js

@@ -1,5 +1,8 @@
 import { addressLookupService } from './os-places/address-lookup-service.js'
+import { buildUprnAddress, buildManualAddress } from './build-address-variables-service.js'
 
 export const services = {
-  addressLookup: addressLookupService
+  addressLookup: addressLookupService,
+  buildUprnAddress,
+  buildManualAddress
 }

package/src/utils/build-update-business-phone-numbers-variables.js

@@ -0,0 +1,20 @@
+/**
+ * Builds the GraphQL variables for the `updateBusinessPhoneNumbers` mutation.
+ *
+ * @param {string|null} businessTelephone - The new business landline number
+ * @param {string|null} businessMobile - The new business mobile number
+ * @param {string} sbi = The Single Business Identifier of the business being updated
+ * @returns {object} The mutation variables in the shape `{ input: { phone { landline, mobile }, sbi } }
+ */
+
+export const buildUpdateBusinessPhoneNumbersVariables = (businessTelephone, businessMobile, sbi) => {
+  return {
+    input: {
+      phone: {
+        landline: businessTelephone ?? null,
+        mobile: businessMobile ?? null
+      },
+      sbi
+    }
+  }
+}

package/src/utils/utils.js

@@ -2,10 +2,12 @@ import { formatFullName } from './format-full-name.js'
 import { formatValidationErrors } from './format-validation-errors.js'
 import { buildUpdateBusinessEmailVariables } from './build-update-business-email-variables.js'
 import { buildUpdateBusinessNameVariables } from './build-update-business-name-variables.js'
+import { buildUpdateBusinessPhoneNumbersVariables } from './build-update-business-phone-numbers-variables.js'
 
 export const utils = {
   formatFullName,
   formatValidationErrors,
   buildUpdateBusinessEmailVariables,
-  buildUpdateBusinessNameVariables
+  buildUpdateBusinessNameVariables,
+  buildUpdateBusinessPhoneNumbersVariables
 }