@defra/fcp-sfd-frontend-engine 0.8.6 → 0.9.1

package/dist/index.cjs

@@ -266,6 +266,24 @@ var businessVatSchema = Joi.object({
   })
 });
 
+// src/schemas/business/business-vat-change-schema.js
+var businessVatChangeSchema = Joi.object({
+  vatNumber: Joi.string().pattern(/^\d{9}$/).required().messages({
+    "string.pattern.base": "Enter a VAT registration number, like 123456789",
+    "string.empty": "Enter a VAT registration number",
+    "any.required": "Enter a VAT registration number",
+    "string.noControlChars": "VAT registration number must not contain invalid characters"
+  })
+});
+
+// src/schemas/business/business-vat-remove-schema.js
+var businessVatRemoveSchema = Joi.object({
+  confirmRemove: Joi.string().valid("yes", "no").required().messages({
+    "any.required": "Select yes if you want to remove your VAT registration number",
+    "any.only": "Select yes if you want to remove your VAT registration number"
+  })
+});
+
 // src/schemas/business/business-schemas.js
 var businessSchemas = {
   sbi: businessSbiSchema,
@@ -275,6 +293,10 @@ var businessSchemas = {
     phone: businessPhoneSchema,
     email: businessEmailSchema,
     vat: businessVatSchema
+  },
+  vat: {
+    change: businessVatChangeSchema,
+    remove: businessVatRemoveSchema
   }
 };
 
@@ -503,11 +525,60 @@ var personalSchemas = {
   email: personalEmailSchema
 };
 
+// src/schemas/os-places/address-lookup-schema.js
+var addressLookupSchema = Joi.object({
+  properties: Joi.object({
+    UPRN: Joi.string().required(),
+    ADDRESS: Joi.string().required(),
+    ORGANISATION_NAME: Joi.string().allow(null),
+    DEPARTMENT_NAME: Joi.string().allow(null),
+    SUB_BUILDING_NAME: Joi.string().allow(null),
+    BUILDING_NAME: Joi.string().allow(null),
+    BUILDING_NUMBER: Joi.string().allow(null),
+    DEPENDENT_THOROUGHFARE_NAME: Joi.string().allow(null),
+    THOROUGHFARE_NAME: Joi.string().allow(null),
+    DOUBLE_DEPENDENT_LOCALITY: Joi.string().allow(null),
+    DEPENDENT_LOCALITY: Joi.string().allow(null),
+    POST_TOWN: Joi.string().required(),
+    POSTCODE: Joi.string().required(),
+    LOCAL_CUSTODIAN_CODE_DESCRIPTION: Joi.string().allow(null),
+    COUNTRY_CODE: Joi.string().required()
+  }).unknown(true).required()
+}).unknown(true);
+
+// src/schemas/os-places/addresses-schema.js
+var CHOOSE_ADDRESS_ERROR = "Choose an address";
+var addressesSchema = Joi.object({
+  addresses: Joi.string().invalid("display").required().messages({
+    "any.required": CHOOSE_ADDRESS_ERROR,
+    "string.empty": CHOOSE_ADDRESS_ERROR,
+    "any.invalid": CHOOSE_ADDRESS_ERROR
+  })
+});
+
+// src/schemas/os-places/uk-postcode-schema.js
+var ukPostcodeSchema = Joi.object({
+  postcode: Joi.string().trim().required().uppercase().max(POSTCODE_MAX).pattern(/^([A-Z]{1,2}\d[A-Z\d]? ?\d[A-Z]{2}|GIR ?0A{2})$/).messages({
+    "any.required": "Enter a postcode",
+    "string.empty": "Enter a postcode",
+    "string.max": `Postal code must be ${POSTCODE_MAX} characters or less`,
+    "string.pattern.base": "Enter a full UK postcode, like AA3 1AB"
+  })
+});
+
+// src/schemas/os-places/os-places-schemas.js
+var osPlacesSchemas = {
+  addressLookup: addressLookupSchema,
+  addresses: addressesSchema,
+  ukPostcode: ukPostcodeSchema
+};
+
 // src/schemas/schemas.js
 var schemas = {
   business: businessSchemas,
   customer: customerSchemas,
-  personal: personalSchemas
+  personal: personalSchemas,
+  osPlaces: osPlacesSchemas
 };
 
 // src/utils/format-validation-errors.js

package/dist/index.js

@@ -227,6 +227,24 @@ var businessVatSchema = Joi.object({
   })
 });
 
+// src/schemas/business/business-vat-change-schema.js
+var businessVatChangeSchema = Joi.object({
+  vatNumber: Joi.string().pattern(/^\d{9}$/).required().messages({
+    "string.pattern.base": "Enter a VAT registration number, like 123456789",
+    "string.empty": "Enter a VAT registration number",
+    "any.required": "Enter a VAT registration number",
+    "string.noControlChars": "VAT registration number must not contain invalid characters"
+  })
+});
+
+// src/schemas/business/business-vat-remove-schema.js
+var businessVatRemoveSchema = Joi.object({
+  confirmRemove: Joi.string().valid("yes", "no").required().messages({
+    "any.required": "Select yes if you want to remove your VAT registration number",
+    "any.only": "Select yes if you want to remove your VAT registration number"
+  })
+});
+
 // src/schemas/business/business-schemas.js
 var businessSchemas = {
   sbi: businessSbiSchema,
@@ -236,6 +254,10 @@ var businessSchemas = {
     phone: businessPhoneSchema,
     email: businessEmailSchema,
     vat: businessVatSchema
+  },
+  vat: {
+    change: businessVatChangeSchema,
+    remove: businessVatRemoveSchema
   }
 };
 
@@ -464,11 +486,60 @@ var personalSchemas = {
   email: personalEmailSchema
 };
 
+// src/schemas/os-places/address-lookup-schema.js
+var addressLookupSchema = Joi.object({
+  properties: Joi.object({
+    UPRN: Joi.string().required(),
+    ADDRESS: Joi.string().required(),
+    ORGANISATION_NAME: Joi.string().allow(null),
+    DEPARTMENT_NAME: Joi.string().allow(null),
+    SUB_BUILDING_NAME: Joi.string().allow(null),
+    BUILDING_NAME: Joi.string().allow(null),
+    BUILDING_NUMBER: Joi.string().allow(null),
+    DEPENDENT_THOROUGHFARE_NAME: Joi.string().allow(null),
+    THOROUGHFARE_NAME: Joi.string().allow(null),
+    DOUBLE_DEPENDENT_LOCALITY: Joi.string().allow(null),
+    DEPENDENT_LOCALITY: Joi.string().allow(null),
+    POST_TOWN: Joi.string().required(),
+    POSTCODE: Joi.string().required(),
+    LOCAL_CUSTODIAN_CODE_DESCRIPTION: Joi.string().allow(null),
+    COUNTRY_CODE: Joi.string().required()
+  }).unknown(true).required()
+}).unknown(true);
+
+// src/schemas/os-places/addresses-schema.js
+var CHOOSE_ADDRESS_ERROR = "Choose an address";
+var addressesSchema = Joi.object({
+  addresses: Joi.string().invalid("display").required().messages({
+    "any.required": CHOOSE_ADDRESS_ERROR,
+    "string.empty": CHOOSE_ADDRESS_ERROR,
+    "any.invalid": CHOOSE_ADDRESS_ERROR
+  })
+});
+
+// src/schemas/os-places/uk-postcode-schema.js
+var ukPostcodeSchema = Joi.object({
+  postcode: Joi.string().trim().required().uppercase().max(POSTCODE_MAX).pattern(/^([A-Z]{1,2}\d[A-Z\d]? ?\d[A-Z]{2}|GIR ?0A{2})$/).messages({
+    "any.required": "Enter a postcode",
+    "string.empty": "Enter a postcode",
+    "string.max": `Postal code must be ${POSTCODE_MAX} characters or less`,
+    "string.pattern.base": "Enter a full UK postcode, like AA3 1AB"
+  })
+});
+
+// src/schemas/os-places/os-places-schemas.js
+var osPlacesSchemas = {
+  addressLookup: addressLookupSchema,
+  addresses: addressesSchema,
+  ukPostcode: ukPostcodeSchema
+};
+
 // src/schemas/schemas.js
 var schemas = {
   business: businessSchemas,
   customer: customerSchemas,
-  personal: personalSchemas
+  personal: personalSchemas,
+  osPlaces: osPlacesSchemas
 };
 
 // src/utils/format-validation-errors.js

package/package.json

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

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

@@ -4,12 +4,23 @@ 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'
+import { businessVatChangeSchema } from './business-vat-change-schema.js'
+import { businessVatRemoveSchema } from './business-vat-remove-schema.js'
 
 /**
  * The businessSchema object has a nested property of `details`.
  * This is due to the interrupter journey. The journey required the business details to be validated in a single step,
  * these include name, address, phone, email and vat. The `details` property is used to group these schemas together.
  * The `sbi` property is separate as it is validated in a different step of the journey.
+ *
+ * The `vat` property groups the schemas for the standalone VAT action pages:
+ * - `vat.change` validates the dedicated VAT change page where a VAT registration number is mandatory
+ *   (9 digits, `.required()`), so it is deliberately separate from `details.vat`.
+ * - `vat.remove` validates the VAT removal confirmation page (yes/no).
+ *
+ * Note `details.vat` and `vat.change` are two distinct validation contexts for the same field: within the
+ * interrupter `details` set VAT is optional and an empty string is allowed, whereas on the dedicated change
+ * page a valid VAT number must be entered (removal is handled by its own journey).
  */
 export const businessSchemas = {
   sbi: businessSbiSchema,
@@ -19,5 +30,9 @@ export const businessSchemas = {
     phone: businessPhoneSchema,
     email: businessEmailSchema,
     vat: businessVatSchema
+  },
+  vat: {
+    change: businessVatChangeSchema,
+    remove: businessVatRemoveSchema
   }
 }

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

@@ -0,0 +1,13 @@
+import { Joi } from '../../utils/joi.js'
+
+export const businessVatChangeSchema = Joi.object({
+  vatNumber: Joi.string()
+    .pattern(/^\d{9}$/)
+    .required()
+    .messages({
+      'string.pattern.base': 'Enter a VAT registration number, like 123456789',
+      'string.empty': 'Enter a VAT registration number',
+      'any.required': 'Enter a VAT registration number',
+      'string.noControlChars': 'VAT registration number must not contain invalid characters'
+    })
+})

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

@@ -0,0 +1,11 @@
+import { Joi } from '../../utils/joi.js'
+
+export const businessVatRemoveSchema = Joi.object({
+  confirmRemove: Joi.string()
+    .valid('yes', 'no')
+    .required()
+    .messages({
+      'any.required': 'Select yes if you want to remove your VAT registration number',
+      'any.only': 'Select yes if you want to remove your VAT registration number'
+    })
+})

package/src/schemas/os-places/address-lookup-schema.js

@@ -0,0 +1,21 @@
+import { Joi } from '../../utils/joi.js'
+
+export const addressLookupSchema = Joi.object({
+  properties: Joi.object({
+    UPRN: Joi.string().required(),
+    ADDRESS: Joi.string().required(),
+    ORGANISATION_NAME: Joi.string().allow(null),
+    DEPARTMENT_NAME: Joi.string().allow(null),
+    SUB_BUILDING_NAME: Joi.string().allow(null),
+    BUILDING_NAME: Joi.string().allow(null),
+    BUILDING_NUMBER: Joi.string().allow(null),
+    DEPENDENT_THOROUGHFARE_NAME: Joi.string().allow(null),
+    THOROUGHFARE_NAME: Joi.string().allow(null),
+    DOUBLE_DEPENDENT_LOCALITY: Joi.string().allow(null),
+    DEPENDENT_LOCALITY: Joi.string().allow(null),
+    POST_TOWN: Joi.string().required(),
+    POSTCODE: Joi.string().required(),
+    LOCAL_CUSTODIAN_CODE_DESCRIPTION: Joi.string().allow(null),
+    COUNTRY_CODE: Joi.string().required()
+  }).unknown(true).required()
+}).unknown(true)

package/src/schemas/os-places/addresses-schema.js

@@ -0,0 +1,14 @@
+import { Joi } from '../../utils/joi.js'
+
+const CHOOSE_ADDRESS_ERROR = 'Choose an address'
+
+export const addressesSchema = Joi.object({
+  addresses: Joi.string()
+    .invalid('display')
+    .required()
+    .messages({
+      'any.required': CHOOSE_ADDRESS_ERROR,
+      'string.empty': CHOOSE_ADDRESS_ERROR,
+      'any.invalid': CHOOSE_ADDRESS_ERROR
+    })
+})

package/src/schemas/os-places/os-places-schemas.js

@@ -0,0 +1,9 @@
+import { addressLookupSchema } from './address-lookup-schema.js'
+import { addressesSchema } from './addresses-schema.js'
+import { ukPostcodeSchema } from './uk-postcode-schema.js'
+
+export const osPlacesSchemas = {
+  addressLookup: addressLookupSchema,
+  addresses: addressesSchema,
+  ukPostcode: ukPostcodeSchema
+}

package/src/schemas/os-places/uk-postcode-schema.js

@@ -0,0 +1,17 @@
+import { Joi } from '../../utils/joi.js'
+import { POSTCODE_MAX } from '../../constants/validation-fields.js'
+
+export const ukPostcodeSchema = Joi.object({
+  postcode: Joi.string()
+    .trim()
+    .required()
+    .uppercase()
+    .max(POSTCODE_MAX)
+    .pattern(/^([A-Z]{1,2}\d[A-Z\d]? ?\d[A-Z]{2}|GIR ?0A{2})$/)
+    .messages({
+      'any.required': 'Enter a postcode',
+      'string.empty': 'Enter a postcode',
+      'string.max': `Postal code must be ${POSTCODE_MAX} characters or less`,
+      'string.pattern.base': 'Enter a full UK postcode, like AA3 1AB'
+    })
+})

package/src/schemas/schemas.js

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