@financial-times/n-conversion-forms 37.2.1 → 37.2.2

package/.toolkitstate/ci.json

@@ -1,6 +1,6 @@
 {
   "branch": "",
   "repo": "n-conversion-forms",
-  "version": "56f6ac0285fa7afa997c8bee965da17a69a9315d",
-  "tag": "v37.2.1"
+  "version": "c9dd25fe954591fd5d8e7167bdd51ff78d765bb3",
+  "tag": "v37.2.2"
 }

package/components/delivery-option.jsx

@@ -9,7 +9,7 @@ import {
 
 export function DeliveryOption({
 	fieldId = 'deliveryOptionField',
-	country,
+	country: countryCode,
 	productCode = undefined,
 	options = [],
 	isSingle = false,
@@ -20,7 +20,7 @@ export function DeliveryOption({
 		{ 'ncf__delivery-option--single': isSingle },
 	]);
 
-	const FTShippingZone = identifyFTShippingZone(country);
+	const shippingZone = identifyFTShippingZone(countryCode);
 
 	return (
 		<div
@@ -32,12 +32,12 @@ export function DeliveryOption({
 			<span className="o-forms-input o-forms-input--radio-round">
 				{options.map((option) => {
 					const { value, isValidDeliveryOption, isSelected } = option;
-					const deliveryOptionValue = getDeliveryOption(
+					const deliveryOptionValue = getDeliveryOption({
 						productCode,
 						option,
-						FTShippingZone,
-						country
-					);
+						shippingZone,
+						countryCode,
+					});
 
 					if (!isValidDeliveryOption || !deliveryOptionValue) {
 						return null;

package/dist/delivery-option.jsx

@@ -13,7 +13,7 @@ var _supportedCountries = require("../helpers/supportedCountries");
 function DeliveryOption(_ref) {
   var _ref$fieldId = _ref.fieldId,
     fieldId = _ref$fieldId === void 0 ? 'deliveryOptionField' : _ref$fieldId,
-    country = _ref.country,
+    countryCode = _ref.country,
     _ref$productCode = _ref.productCode,
     productCode = _ref$productCode === void 0 ? undefined : _ref$productCode,
     _ref$options = _ref.options,
@@ -23,7 +23,7 @@ function DeliveryOption(_ref) {
   var divClassName = (0, _classnames["default"])(['o-forms-field', 'ncf__delivery-option', {
     'ncf__delivery-option--single': isSingle
   }]);
-  var FTShippingZone = (0, _supportedCountries.identifyFTShippingZone)(country);
+  var shippingZone = (0, _supportedCountries.identifyFTShippingZone)(countryCode);
   return /*#__PURE__*/_react["default"].createElement("div", {
     id: fieldId,
     className: divClassName,
@@ -35,7 +35,12 @@ function DeliveryOption(_ref) {
     var value = option.value,
       isValidDeliveryOption = option.isValidDeliveryOption,
       isSelected = option.isSelected;
-    var deliveryOptionValue = (0, _deliveryOptionMessages.getDeliveryOption)(productCode, option, FTShippingZone, country);
+    var deliveryOptionValue = (0, _deliveryOptionMessages.getDeliveryOption)({
+      productCode: productCode,
+      option: option,
+      shippingZone: shippingZone,
+      countryCode: countryCode
+    });
     if (!isValidDeliveryOption || !deliveryOptionValue) {
       return null;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/n-conversion-forms",
-  "version": "37.2.1",
+  "version": "37.2.2",
   "description": "Containing jsx components and styles for forms included on Accounts and Acquisition apps (next-signup, next-profile, next-retention, etc).",
   "main": "./dist/index.js",
   "scripts": {

package/utils/delivery-option-messages.js

@@ -257,38 +257,38 @@ function includesDeliveryFrequency(productCode = '', item) {
 	});
 }
 
-function mailStrategy(productCode, option, FTShippingZone, item) {
+function mailStrategy(productCode, shippingZone, item) {
 	return (
 		includesDeliveryFrequency(productCode, item) &&
 		item.distributorType === MAIL &&
-		item.country.includes(FTShippingZone)
+		item.country.includes(shippingZone)
 	);
 }
 
-function handDeliveryStrategy(productCode, option, FTShippingZone, item) {
+function handDeliveryStrategy(productCode, option, shippingZone, item) {
 	return (
 		includesDeliveryFrequency(productCode, item) &&
 		item.distributorType === HAND_DELIVERY &&
 		item.deliveryOnPublicationDate === option.deliveryOnPublicationDate &&
 		item.flightMarket === option.flightMarket &&
-		item.country.includes(FTShippingZone)
+		item.country.includes(shippingZone)
 	);
 }
 
 /**
- * Method to find a specific delivery option based on the delivery frequency, FTShippingZone and option values.
+ * Method to find a specific delivery option based on the delivery frequency, shippingZone and option values.
  * There are two different strategies, one for options with mailDelivery = true and other by the opposite.
  * Both cases are represented by system option code 'HD', but differ on the mailDelivery property value.
  * If no message matchs, then undefined is returned.
  */
-function findCustomDeliveryOption(productCode, option, FTShippingZone) {
+function findCustomDeliveryOption(productCode, option, shippingZone) {
 	let deliveryOption;
 
 	if (option.value === HAND_DELIVERY) {
 		const filteredMessages = deliveryOptionMessages.filter((item) => {
 			return option.mailDelivery
-				? mailStrategy(productCode, option, FTShippingZone, item)
-				: handDeliveryStrategy(productCode, option, FTShippingZone, item);
+				? mailStrategy(productCode, shippingZone, item)
+				: handDeliveryStrategy(productCode, option, shippingZone, item);
 		});
 
 		if (filteredMessages.length) {
@@ -300,13 +300,15 @@ function findCustomDeliveryOption(productCode, option, FTShippingZone) {
 	return deliveryOption;
 }
 
-function getDeliveryOption(productCode, option, FTShippingZone, country) {
+function getDeliveryOption({ productCode, option, shippingZone, countryCode }) {
 	// Custom delivery messages are displayed for certain countries
-	if (Object.keys(countryCodeToCustomDeliveryOptionsMap).includes(country)) {
-		return countryCodeToCustomDeliveryOptionsMap[country][option.value];
+	if (
+		Object.keys(countryCodeToCustomDeliveryOptionsMap).includes(countryCode)
+	) {
+		return countryCodeToCustomDeliveryOptionsMap[countryCode][option.value];
 	}
 
-	return findCustomDeliveryOption(productCode, option, FTShippingZone);
+	return findCustomDeliveryOption(productCode, option, shippingZone);
 }
 
 module.exports = {

package/utils/delivery-option-messages.spec.js

@@ -14,14 +14,24 @@ describe('Find Custom Delivery Option', () => {
 
 		it('returns undefined when other country than custom messages', () => {
 			expect(
-				getDeliveryOption(sixDaysProductCode, stubOption, 'AAA', 'AAA')
+				getDeliveryOption({
+					productCode: sixDaysProductCode,
+					option: stubOption,
+					shippingZone: 'AAA',
+					countryCode: 'AAA',
+				})
 			).toBeUndefined();
 		});
 
 		it('returns undefined when invalid distributor type code', () => {
 			const option = { ...stubOption, value: 'ZZ' };
 			expect(
-				getDeliveryOption(sixDaysProductCode, option, 'USA', 'USA')
+				getDeliveryOption({
+					productCode: sixDaysProductCode,
+					option: option,
+					shippingZone: 'USA',
+					countryCode: 'USA',
+				})
 			).toBeUndefined();
 		});
 
@@ -29,7 +39,12 @@ describe('Find Custom Delivery Option', () => {
 			stubOption.deliveryOnPublicationDate = undefined;
 			stubOption.flightMarket = undefined;
 			expect(
-				getDeliveryOption(sixDaysProductCode, stubOption, 'AAA', 'AAA')
+				getDeliveryOption({
+					productCode: sixDaysProductCode,
+					option: stubOption,
+					shippingZone: 'AAA',
+					countryCode: 'AAA',
+				})
 			).toBeUndefined();
 		});
 	});
@@ -48,12 +63,12 @@ describe('Find Custom Delivery Option', () => {
 					'Enjoy delivery of the newspaper daily to your home or office address.',
 			};
 
-			const deliveryOption = getDeliveryOption(
-				sixDaysProductCode,
-				stubOption,
-				'USA',
-				'USA'
-			);
+			const deliveryOption = getDeliveryOption({
+				productCode: sixDaysProductCode,
+				option: stubOption,
+				shippingZone: 'USA',
+				countryCode: 'USA',
+			});
 
 			expect(deliveryOption).toEqual(expected);
 		});
@@ -67,12 +82,12 @@ describe('Find Custom Delivery Option', () => {
 					'Enjoy delivery of the newspaper daily to your home or office address. \nPlease note: Your FT Weekend will be delivered on Sunday.',
 			};
 
-			const deliveryOption = getDeliveryOption(
-				weekendProductCode,
-				stubOption,
-				'USA',
-				'USA'
-			);
+			const deliveryOption = getDeliveryOption({
+				productCode: weekendProductCode,
+				option: stubOption,
+				shippingZone: 'USA',
+				countryCode: 'USA',
+			});
 
 			expect(deliveryOption).toEqual(expected);
 		});
@@ -91,12 +106,12 @@ describe('Find Custom Delivery Option', () => {
 					"We can only deliver the newspaper to your location by postal mail which means your delivery will arrive up to 5 business days after the date of publication and will not include the HTSI Magazine. We also fly the newspaper to your location which means delivery is subject to flight delays/cancellations outside the FT's control. If you prefer to read the printed content on the day of publication, please proceed to subscribe to the FT ePaper - a digital replica of the print edition.",
 			};
 
-			const deliveryOption = getDeliveryOption(
-				sixDaysProductCode,
-				stubOption,
-				'USA',
-				'USA'
-			);
+			const deliveryOption = getDeliveryOption({
+				productCode: sixDaysProductCode,
+				option: stubOption,
+				shippingZone: 'USA',
+				countryCode: 'USA',
+			});
 
 			expect(deliveryOption).toEqual(expected);
 		});
@@ -109,12 +124,12 @@ describe('Find Custom Delivery Option', () => {
 					"We can only deliver the FT Weekend newspaper to your location by postal mail which means your delivery will arrive up to 5 business days after the date of publication and will not include the HTSI Magazine. We also fly the newspaper to your location which means delivery is subject to flight delays/cancellations outside the FT's control. If you prefer to read the printed content on the day of publication, please proceed to subscribe to the FT ePaper - a digital replica of the print edition.",
 			};
 
-			const deliveryOption = getDeliveryOption(
-				weekendProductCode,
-				stubOption,
-				'CAN',
-				'CAN'
-			);
+			const deliveryOption = getDeliveryOption({
+				productCode: weekendProductCode,
+				option: stubOption,
+				shippingZone: 'CAN',
+				countryCode: 'CAN',
+			});
 
 			expect(deliveryOption).toEqual(expected);
 		});
@@ -128,12 +143,12 @@ describe('Find Custom Delivery Option', () => {
 					'Delivered via email and card, redeemable at retailers nationwide.',
 			};
 
-			const deliveryOption = getDeliveryOption(
-				sixDaysProductCode,
-				{ value: 'EV' },
-				'GBR',
-				'GBR'
-			);
+			const deliveryOption = getDeliveryOption({
+				productCode: sixDaysProductCode,
+				option: { value: 'EV' },
+				shippingZone: 'GBR',
+				countryCode: 'GBR',
+			});
 
 			expect(deliveryOption).toEqual(expected);
 		});
@@ -146,12 +161,12 @@ describe('Find Custom Delivery Option', () => {
 					'Enjoy delivery of the newspaper to your home or office address.',
 			};
 
-			const deliveryOption = getDeliveryOption(
-				sixDaysProductCode,
-				stubOption,
-				'APAC',
-				'JPN'
-			);
+			const deliveryOption = getDeliveryOption({
+				productCode: sixDaysProductCode,
+				option: stubOption,
+				shippingZone: 'APAC',
+				countryCode: 'JPN',
+			});
 
 			expect(deliveryOption).toEqual(expected);
 		});
@@ -168,12 +183,12 @@ describe('Find Custom Delivery Option', () => {
 					'Enjoy the delivery of the newspaper to your home or office address. Please note we fly the newspaper to your location which means delivery is subject to flight delays/cancellations outside of the FT’s control. In those circumstances, your newspaper will be delivered the next delivery day. Please also be aware that your FT weekend will be delivered on Sunday.',
 			};
 
-			const deliveryOption = getDeliveryOption(
-				'N6D',
-				stubOption,
-				'CEMEA_V1',
-				'BGR'
-			);
+			const deliveryOption = getDeliveryOption({
+				productCode: 'N6D',
+				option: stubOption,
+				shippingZone: 'CEMEA_V1',
+				countryCode: 'BGR',
+			});
 
 			expect(deliveryOption).toEqual(expected);
 		});
@@ -188,12 +203,12 @@ describe('Find Custom Delivery Option', () => {
 					'Enjoy delivery of the newspaper to your home or office address. Note this is a postal delivery - expect delivery after the day of publication. If you would prefer to read the newspaper on the day of publication, purchase an FT ePaper subscription, our digital replica of each daily edition.',
 			};
 
-			const deliveryOption = getDeliveryOption(
-				'N6D',
-				stubOption,
-				'APAC',
-				'HKG'
-			);
+			const deliveryOption = getDeliveryOption({
+				productCode: 'N6D',
+				option: stubOption,
+				shippingZone: 'APAC',
+				countryCode: 'HKG',
+			});
 
 			expect(deliveryOption).toEqual(expected);
 		});