@financial-times/n-myft-ui 28.1.0 → 28.2.0

package/build-state/npm-shrinkwrap.json

@@ -15,7 +15,7 @@
         "form-serialize": "^0.7.2",
         "ftdomdelegate": "^4.0.6",
         "js-cookie": "^2.2.1",
-        "next-myft-client": "^10.1.0",
+        "next-myft-client": "^10.3.0",
         "next-session-client": "^4.0.0",
         "superstore-sync": "^2.1.1"
       },
@@ -14265,9 +14265,9 @@
       }
     },
     "node_modules/next-myft-client": {
-      "version": "10.1.0",
-      "resolved": "https://registry.npmjs.org/next-myft-client/-/next-myft-client-10.1.0.tgz",
-      "integrity": "sha512-PqnNE1gxV00yVv6pA+1jWaySJkonQBUx2uWchPNGNcB20SzVmYleSWLeD3bdxdNOD5Tpy8DDl58CEQrKja7bqA==",
+      "version": "10.3.0",
+      "resolved": "https://registry.npmjs.org/next-myft-client/-/next-myft-client-10.3.0.tgz",
+      "integrity": "sha512-dAaIs6PhvYGczEsOHGNrI3FKKFDOcm6rSv06SaL9emltqlHqUXt7esun8m4N3D2iL2FzVXKLeMd9/gv/GDryOg==",
       "hasInstallScript": true,
       "dependencies": {
         "black-hole-stream": "0.0.1",
@@ -34770,9 +34770,9 @@
       }
     },
     "next-myft-client": {
-      "version": "10.1.0",
-      "resolved": "https://registry.npmjs.org/next-myft-client/-/next-myft-client-10.1.0.tgz",
-      "integrity": "sha512-PqnNE1gxV00yVv6pA+1jWaySJkonQBUx2uWchPNGNcB20SzVmYleSWLeD3bdxdNOD5Tpy8DDl58CEQrKja7bqA==",
+      "version": "10.3.0",
+      "resolved": "https://registry.npmjs.org/next-myft-client/-/next-myft-client-10.3.0.tgz",
+      "integrity": "sha512-dAaIs6PhvYGczEsOHGNrI3FKKFDOcm6rSv06SaL9emltqlHqUXt7esun8m4N3D2iL2FzVXKLeMd9/gv/GDryOg==",
       "requires": {
         "black-hole-stream": "0.0.1",
         "fetchres": "^1.7.2",

package/myft/main.scss

@@ -314,6 +314,12 @@ $spacing-unit: 20px;
 			}
 			&-container {
 				margin-top: 0;
+				max-height: 92px;
+				padding-bottom: 2px;
+				overflow-y: auto;
+				@include oGridRespondTo($from: M) {
+					max-height: 126px;
+				}
 			}
 		}
 	}

package/myft/ui/lib/relationship-config.js

@@ -11,12 +11,6 @@ const relationshipConfig = {
 		subjectType: 'concept',
 		uiSelector: '[data-myft-ui="follow"]'
 	},
-	contained: {
-		actorType: 'list',
-		idProperty: 'data-content-id',
-		subjectType: 'content',
-		uiSelector: '[data-myft-ui="contained"]'
-	}
 };
 
 export default relationshipConfig;

package/myft/ui/lib/tracking.js

@@ -39,12 +39,10 @@ const getExtraContext = (subjectType, subjectId) => {
  * @param {Object} postedData Event's extra data (required for checking if an instant alert was turned on or off)
  * @return {String} label for the action to send in the custom event
  */
-const getAction = (subjectType, action, postedData, resultData) => {
+const getAction = (subjectType, action, postedData) => {
 	if (action === 'update' && subjectType === 'concept') {
 		const updateState = (postedData && postedData._rel && postedData._rel.instant && postedData._rel.instant === 'true') ? 'on' : 'off';
 		return `instant-alert-${updateState}`;
-	} else if (resultData && resultData.rel && resultData.rel.type && resultData.rel.type === 'contained') {
-		return `${action}-to-list-success`;
 	} else {
 		return customDataSettings[subjectType][action];
 	}
@@ -57,7 +55,7 @@ const getAction = (subjectType, action, postedData, resultData) => {
 export function custom (eventData) {
 	if (Object.keys(customDataSettings).indexOf(eventData.subjectType) !== -1) {
 		const options = Object.assign(
-			{action: getAction(eventData.subjectType, eventData.action, eventData.postedData, eventData.resultData)},
+			{action: getAction(eventData.subjectType, eventData.action, eventData.postedData)},
 			eventData.trackingInfo);
 		const extraContext = getExtraContext(eventData.subjectType, eventData.subjectId);
 		Object.assign(options, extraContext);

package/myft/ui/lists.js

@@ -51,6 +51,18 @@ function updateAfterAddToList (listId, contentId, wasAdded) {
 				content: message,
 				trackable: 'myft-feedback-notification'
 			});
+
+			document.body.dispatchEvent(new CustomEvent('oTracking.event', {
+				detail: {
+					category: 'list',
+					action: 'copy-success',
+					article_id: contentId,
+					list_id: listId,
+					teamName: 'customer-products-us-growth',
+					amplitudeExploratory: true
+				},
+				bubbles: true
+			}));
 		});
 }
 
@@ -83,6 +95,10 @@ function setUpCreateListListeners (overlay, contentId) {
 	const createListButton = overlay.content.querySelector('.js-create-list');
 	const nameInput = overlay.content.querySelector('.js-name');
 
+	if (!createListButton) {
+		return;
+	}
+
 	createListButton.addEventListener('click', event => {
 		event.preventDefault();
 
@@ -184,6 +200,63 @@ function openCreateListAndAddArticleOverlay (contentId) {
 		});
 }
 
+function handleRemoveToggleSubmit (event) {
+	event.preventDefault();
+
+	const formEl = event.target;
+	const submitBtnEl = formEl.querySelector('button[type="submit"]');
+
+	if (submitBtnEl.hasAttribute('disabled')) {
+		return;
+	}
+
+	const isSubmitBtnPressed = submitBtnEl.getAttribute('aria-pressed') === 'true';
+	const action = isSubmitBtnPressed ? 'remove' : 'add';
+	const contentId = formEl.dataset.contentId;
+	const listId = formEl.dataset.actorId;
+	const csrfToken = formEl.elements.token;
+
+	if (!csrfToken || !csrfToken.value) {
+		document.body.dispatchEvent(new CustomEvent('oErrors.log', {
+			bubbles: true,
+			detail: {
+				error: new Error('myFT form submitted without a CSRF token'),
+				info: {
+					action,
+					actorType: 'list',
+					actorId: listId,
+					relationshipName: 'contained',
+					subjectType: 'content',
+					subjectId: contentId,
+				},
+			},
+		}));
+	}
+
+	submitBtnEl.setAttribute('disabled', '');
+
+	myFtClient[action]('list', listId, 'contained', 'content', contentId, { token: csrfToken.value })
+		.then(() => {
+			myFtUiButtonStates.toggleButton(submitBtnEl, !isSubmitBtnPressed);
+
+			document.body.dispatchEvent(new CustomEvent('oTracking.event', {
+				detail: {
+					category: 'list',
+					action: action === 'add' ? 'add-success' : 'remove-success',
+					article_id: contentId,
+					list_id: listId,
+					teamName: 'customer-products-us-growth',
+					amplitudeExploratory: true
+				},
+				bubbles: true
+			}));
+		})
+		.catch(error => {
+			setTimeout(() => submitBtnEl.removeAttribute('disabled'));
+			throw error;
+		});
+}
+
 function initialEventListeners () {
 
 	document.body.addEventListener('myft.user.saved.content.add', event => {
@@ -208,6 +281,8 @@ function initialEventListeners () {
 		ev.preventDefault();
 		showCreateListOverlay();
 	});
+
+	delegate.on('submit', '[data-myft-ui="contained"]', handleRemoveToggleSubmit);
 }
 
 export function init () {

package/myft/ui/myft-buttons/init.js

@@ -65,6 +65,7 @@ function signedInEventListeners () {
 						const resultData = event.detail.results && event.detail.results[0];
 						const isPressed = !!event.detail.results;
 						buttonStates.setStateOfButton(relationshipName, event.detail.subject, isPressed, undefined, resultData, true);
+
 						tracking.custom({
 							subjectType,
 							action,

package/myft/ui/save-article-to-list-variant.js

@@ -7,9 +7,10 @@ const csrfToken = getToken();
 
 let lists = [];
 let haveLoadedLists = false;
+let createListOverlay;
 
 export default async function openSaveArticleToListVariant (name, contentId) {
-	function createList (list) {
+	function createList (list, cb) {
 		if(!list) {
 			if (!lists.length) attachDescription();
 			return contentElement.addEventListener('click', openFormHandler, { once: true });
@@ -18,14 +19,14 @@ export default async function openSaveArticleToListVariant (name, contentId) {
 		myFtClient.add('user', null, 'created', 'list', uuid(), { name: list,	token: csrfToken })
 			.then(detail => {
 				myFtClient.add('list', detail.subject, 'contained', 'content', contentId, { token: csrfToken }).then((createdList) => {
-					lists.push({ name: list, uuid: createdList.actorId, checked: true });
+					lists.unshift({ name: list, uuid: createdList.actorId, checked: true });
 					const listElement = ListsElement(lists, addToList, removeFromList);
 					const overlayContent = document.querySelector('.o-overlay__content');
 					overlayContent.insertAdjacentElement('afterbegin', listElement);
 					const announceListContainer = document.querySelector('.myft-ui-create-list-variant-announcement');
 					announceListContainer.textContent = `${list} created`;
-					triggerCreateListEvent(contentId);
 					contentElement.addEventListener('click', openFormHandler, { once: true });
+					cb(contentId, createdList.actorId);
 				});
 			})
 			.catch(() => {
@@ -34,33 +35,25 @@ export default async function openSaveArticleToListVariant (name, contentId) {
 			});
 	}
 
-	function addToList (list) {
+	function addToList (list, cb) {
 		if(!list) {
 			return;
 		}
 
-		myFtClient.add('list', list.uuid, 'contained', 'content', contentId, { token: csrfToken }).then(() => {
-			const indexToUpdate = lists.indexOf(list);
-			lists[indexToUpdate] = { ...lists[indexToUpdate], checked: true };
-			const listElement = ListsElement(lists, addToList, removeFromList);
-			const overlayContent = document.querySelector('.o-overlay__content');
-			overlayContent.insertAdjacentElement('afterbegin', listElement);
-			triggerAddToListEvent(contentId);
+		myFtClient.add('list', list.uuid, 'contained', 'content', contentId, { token: csrfToken }).then((addedList) => {
+			cb();
+			triggerAddToListEvent(contentId, addedList.actorId);
 		});
 	}
 
-	function removeFromList (list) {
+	function removeFromList (list, cb) {
 		if(!list) {
 			return;
 		}
 
-		myFtClient.remove('list', list.uuid, 'contained', 'content', contentId, { token: csrfToken }).then(() => {
-			const indexToUpdate = lists.indexOf(list);
-			lists[indexToUpdate] = { ...lists[indexToUpdate], checked: false };
-			const listElement = ListsElement(lists, addToList, removeFromList);
-			const overlayContent = document.querySelector('.o-overlay__content');
-			overlayContent.insertAdjacentElement('afterbegin', listElement);
-			triggerRemoveFromListEvent(contentId);
+		myFtClient.remove('list', list.uuid, 'contained', 'content', contentId, { token: csrfToken }).then((removedList) => {
+			cb();
+			triggerRemoveFromListEvent(contentId, removedList.actorId);
 		});
 	}
 
@@ -78,7 +71,7 @@ export default async function openSaveArticleToListVariant (name, contentId) {
 	const headingElement = HeadingElement();
 	let [contentElement, removeDescription, attachDescription] = ContentElement(!lists.length);
 
-	const createListOverlay = new Overlay(name, {
+	createListOverlay = new Overlay(name, {
 		html: contentElement,
 		heading: { title: headingElement.outerHTML },
 		modal: false,
@@ -88,7 +81,11 @@ export default async function openSaveArticleToListVariant (name, contentId) {
 
 	function outsideClickHandler (e) {
 		const overlayContent = document.querySelector('.o-overlay__content');
-		if(createListOverlay.visible && (!overlayContent || !overlayContent.contains(e.target))) {
+		const overlayContainer = document.querySelector('.o-overlay');
+		// we don't want to close the overlay if the click happened inside the
+		// overlay, except if the click happened on the overlay close button
+		const isTargetInsideOverlay = overlayContainer.contains(e.target) && !e.target.classList.contains('o-overlay__close');
+		if(createListOverlay.visible && (!overlayContent || !isTargetInsideOverlay)) {
 			createListOverlay.close();
 		}
 	}
@@ -114,17 +111,17 @@ export default async function openSaveArticleToListVariant (name, contentId) {
 	const scrollHandler = getScrollHandler(createListOverlay.wrapper);
 
 	createListOverlay.wrapper.addEventListener('oOverlay.ready', (data) => {
-		positionOverlay(data.currentTarget);
-
 		if (lists.length) {
 			const listElement = ListsElement(lists, addToList, removeFromList);
 			const overlayContent = document.querySelector('.o-overlay__content');
 			overlayContent.insertAdjacentElement('afterbegin', listElement);
 		}
 
+		positionOverlay(data.currentTarget);
+
 		contentElement.addEventListener('click', openFormHandler, { once: true });
 
-		document.querySelector('.article-content').addEventListener('click', outsideClickHandler, { once: true });
+		document.querySelector('.article-content').addEventListener('click', outsideClickHandler);
 
 		window.addEventListener('scroll', scrollHandler);
 
@@ -135,6 +132,8 @@ export default async function openSaveArticleToListVariant (name, contentId) {
 		window.removeEventListener('scroll', scrollHandler);
 
 		window.removeEventListener('oViewport.resize', resizeHandler);
+
+		document.querySelector('.article-content').removeEventListener('click', outsideClickHandler);
 	});
 }
 
@@ -164,7 +163,11 @@ function FormElement (createList) {
 		event.preventDefault();
 		event.stopPropagation();
 		const inputListName = formElement.querySelector('input[name="list-name"]');
-		createList(inputListName.value);
+		createList(inputListName.value, ((contentId, listId) => {
+			triggerCreateListEvent(contentId, listId);
+			triggerAddToListEvent(contentId, listId);
+			positionOverlay(createListOverlay.wrapper);
+		}));
 		inputListName.value = '';
 		formElement.remove();
 	}
@@ -179,7 +182,7 @@ function ContentElement (hasDescription) {
 
 	const content = `
 		<div class="myft-ui-create-list-variant-footer">
-			<button class="myft-ui-create-list-variant-add">Add to a new list</button>
+			<button class="myft-ui-create-list-variant-add" data-trackable="add-to-new-list" text="Add to a new list">Add to a new list</button>
 			${hasDescription ? `
 			${description}
 		` : ''}
@@ -205,7 +208,7 @@ function ContentElement (hasDescription) {
 
 function HeadingElement () {
 	const heading = `
-		<span class="myft-ui-create-list-variant-heading">Added to <a href="https://www.ft.com/myft/saved-articles">saved articles</a> in <span class="myft-ui-create-list-variant-icon"><span class="myft-ui-create-list-variant-icon-visually-hidden">my FT</span></span></span>
+		<span class="myft-ui-create-list-variant-heading">Added to <a href="https://www.ft.com/myft/saved-articles" data-trackable="saved-articles">saved articles</a> in <span class="myft-ui-create-list-variant-icon"><span class="myft-ui-create-list-variant-icon-visually-hidden">my FT</span></span></span>
 		`;
 
 	return stringToHTMLElement(heading);
@@ -237,8 +240,9 @@ function ListsElement (lists, addToList, removeFromList) {
 
 function ListCheckboxElement (addToList, removeFromList) {
 	return function (list) {
+
 		const listCheckbox = `<label>
-		<input type="checkbox" name="default" value="${list.name}" ${list.checked ? 'checked' : ''}>
+		<input type="checkbox" name="default" value="${list.uuid}" ${list.checked ? 'checked' : ''}>
 		<span class="o-forms-input__label">
 			<span class="o-normalise-visually-hidden">
 			${list.checked ? 'Remove article from ' : 'Add article to ' }
@@ -254,7 +258,15 @@ function ListCheckboxElement (addToList, removeFromList) {
 
 		function handleCheck (event) {
 			event.preventDefault();
-			return event.target.checked ? addToList(list) : removeFromList(list);
+			const isChecked = event.target.checked;
+
+			function onListUpdated () {
+				const indexToUpdate = lists.indexOf(list);
+				lists[indexToUpdate] = { ...lists[indexToUpdate], checked: isChecked };
+				listCheckboxElement.querySelector('input').checked = isChecked;
+			}
+
+			return isChecked ? addToList(list, onListUpdated) : removeFromList(list, onListUpdated);
 		}
 
 		input.addEventListener('click', handleCheck);
@@ -287,10 +299,11 @@ function positionOverlay (target) {
 
 	if (isMobile()) {
 		const shareNavComponent = document.querySelector('.share-nav__horizontal');
+		const topHalfOffset = target.clientHeight + 10;
 		target.style['position'] = 'absolute';
 		target.style['margin-left'] = 0;
 		target.style['margin-top'] = 0;
-		target.style['top'] = calculateLargerScreenHalf(shareNavComponent) === 'ABOVE' ? '-120px' : '50px';
+		target.style['top'] = calculateLargerScreenHalf(shareNavComponent) === 'ABOVE' ? `-${topHalfOffset}px` : '50px';
 	} else {
 		target.style['position'] = 'absolute';
 		target.style['margin-left'] = '45px';
@@ -318,20 +331,21 @@ function calculateLargerScreenHalf (target) {
 	return spaceBelow < spaceAbove ? 'ABOVE' : 'BELOW';
 }
 
-async function getLists () {
-	return myFtClient.getAll('created', 'list')
-		.then(lists => lists.filter(list => !list.isRedirect))
-		.then(lists => {
-			return lists.map(list => ({ name: list.name, uuid: list.uuid, checked: false }));
-		});
+async function getLists (contentId) {
+	return myFtClient.getListsContent()
+		.then(results => results.items.map(list => {
+			const isChecked = Array.isArray(list.content) && list.content.some(content => content.uuid === contentId);
+			return { name: list.name, uuid: list.uuid, checked: isChecked, content: list.content };
+		}));
 }
 
-function triggerAddToListEvent (contentId) {
+function triggerAddToListEvent (contentId, listId) {
 	return document.body.dispatchEvent(new CustomEvent('oTracking.event', {
 		detail: {
-			category: 'professorLists',
-			action: 'add-to-list',
+			category: 'list',
+			action: 'add-success',
 			article_id: contentId,
+			list_id: listId,
 			teamName: 'customer-products-us-growth',
 			amplitudeExploratory: true
 		},
@@ -339,12 +353,13 @@ function triggerAddToListEvent (contentId) {
 	}));
 }
 
-function triggerRemoveFromListEvent (contentId) {
+function triggerRemoveFromListEvent (contentId, listId) {
 	return document.body.dispatchEvent(new CustomEvent('oTracking.event', {
 		detail: {
-			category: 'professorLists',
-			action: 'remove-from-list',
+			category: 'list',
+			action: 'remove-success',
 			article_id: contentId,
+			list_id: listId,
 			teamName: 'customer-products-us-growth',
 			amplitudeExploratory: true
 		},
@@ -352,24 +367,16 @@ function triggerRemoveFromListEvent (contentId) {
 	}));
 }
 
-function triggerCreateListEvent (contentId) {
+function triggerCreateListEvent (contentId, listId) {
 	document.body.dispatchEvent(new CustomEvent('oTracking.event', {
 		detail: {
-			category: 'professorLists',
-			action: 'create-list',
+			category: 'list',
+			action: 'create-success',
 			article_id: contentId,
+			list_id: listId,
 			teamName: 'customer-products-us-growth',
 			amplitudeExploratory: true
 		},
 		bubbles: true
 	}));
-
-	return document.body.dispatchEvent(new CustomEvent('oTracking.event', {
-		detail: {
-			category: 'myFT',
-			action: 'create-list-success',
-			article_id: contentId
-		},
-		bubbles: true
-	}));
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@financial-times/n-myft-ui",
-  "version": "28.1.0",
+  "version": "28.2.0",
   "description": "Client side component for interaction with myft",
   "main": "server.js",
   "scripts": {
@@ -103,13 +103,13 @@
     "form-serialize": "^0.7.2",
     "ftdomdelegate": "^4.0.6",
     "js-cookie": "^2.2.1",
-    "next-myft-client": "^10.1.0",
+    "next-myft-client": "^10.3.0",
     "next-session-client": "^4.0.0",
     "superstore-sync": "^2.1.1"
   },
   "volta": {
     "node": "16.14.2",
-    "npm": "7.20.2"
+    "npm": "7.24.2"
   },
   "engines": {
     "node": "14.x || 16.x",