LPD-43539 | LPD-44536 LPD-44537 LPD-45319 Create new documentsFragmen…

…t plugin to support document mapped on a DXP fragment

modules/apps/analytics/analytics-client-js/src/plugins/defaults.js

@@ -6,6 +6,7 @@
 import blogs from './blogs';
 import custom from './custom';
 import documents from './documents';
+import documentsFragment from './documentsFragment';
 import dxp from './dxp';
 import forms from './forms';
 import read from './read';
@@ -14,7 +15,17 @@ import timing from './timing';
 import visibility from './visibility';
 import webContents from './web-contents';
 
-export {blogs, documents, dxp, forms, read, scrolling, timing, webContents};
+export {
+	blogs,
+	documents,
+	documentsFragment,
+	dxp,
+	forms,
+	read,
+	scrolling,
+	timing,
+	webContents,
+};
 export default [
 
 	// Dxp should be before other events plugins, because it can dispose analytics
@@ -24,6 +35,7 @@ export default [
 	blogs,
 	custom,
 	documents,
+	documentsFragment,
 	forms,
 	read,
 	scrolling,

modules/apps/analytics/analytics-client-js/src/plugins/documentsFragment.js

@@ -0,0 +1,118 @@
+/**
+ * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
+ * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
+ */
+
+import {
+	closest,
+	getClosestAssetElement,
+	isTrackable,
+	transformAssetTypeToSelector,
+} from '../utils/assets';
+import {DOCUMENT} from '../utils/constants';
+import {onReady} from '../utils/events';
+
+const applicationId = DOCUMENT;
+
+export const documentType =
+	'com.liferay.portal.kernel.repository.model.FileEntry';
+
+/**
+ * Returns analytics payload with Document information.
+ * @param {Object} documentElement The document DOM element
+ * @returns {Object} The payload with document information
+ */
+function getDocumentPayload({dataset}) {
+	const payload = {
+		fileEntryId: dataset.analyticsAssetId.trim(),
+		fileEntryVersion: dataset.analyticsAssetVersion,
+	};
+
+	if (dataset.analyticsAssetSubtype) {
+		Object.assign(payload, {subtype: dataset.analyticsAssetSubtype.trim()});
+	}
+
+	if (dataset.analyticsAssetTitle) {
+		Object.assign(payload, {title: dataset.analyticsAssetTitle.trim()});
+	}
+
+	if (dataset.analyticsAssetType) {
+		Object.assign(payload, {type: dataset.analyticsAssetType.trim()});
+	}
+
+	return payload;
+}
+
+/**
+ * Sends information when user clicks on a Document.
+ * @param {Object} The Analytics client instance
+ */
+function trackDocumentDownloaded(analytics) {
+	const onClick = ({target}) => {
+		if (isTrackable(target) && target.dataset.analyticsAssetAction === 'download') {
+			analytics.send(
+				'documentDownloaded',
+				applicationId,
+				getDocumentPayload(target)
+			);
+		}
+	};
+
+	document.addEventListener('click', onClick);
+
+	return () => document.removeEventListener('click', onClick);
+}
+
+/**
+ * Sends information when user scrolls on a Document.
+ * @param {Object} The Analytics client instance
+ */
+function trackDocument(analytics, {eventId, isTrackable}) {
+	const selector = transformAssetTypeToSelector(documentType);
+
+	const stopTrackingOnReady = onReady(() => {
+		Array.prototype.slice
+			.call(document.querySelectorAll(selector))
+			.filter((element) => isTrackable(element))
+			.forEach((element) => {
+				const payload = getDocumentPayload(element);
+
+				analytics.send(eventId, applicationId, payload);
+			});
+	});
+
+	return () => stopTrackingOnReady();
+}
+
+/**
+ * Plugin function that registers listeners for Document events.
+ * A link with action download should fire a documentImpressionMade event
+ * on load page to the documentsFragment plugin.
+ * @param {Object} analytics The Analytics client
+ */
+function documents(analytics) {
+	const stopTrackingDocumentDownloaded = trackDocumentDownloaded(analytics);
+	const stopTrackingDocumentImpressionMade = trackDocument(analytics, {
+		eventId: 'documentImpressionMade',
+		isTrackable: (element) =>
+			(isTrackable(element) &&
+				element.dataset.analyticsAssetAction === 'impression') ||
+			(isTrackable(element) &&
+				element.dataset.analyticsAssetAction === 'download'),
+	});
+	const stopTrackingDocumentPreviewed = trackDocument(analytics, {
+		eventId: 'documentPreviewed',
+		isTrackable: (element) =>
+			isTrackable(element) &&
+			element.dataset.analyticsAssetAction === 'view',
+	});
+
+	return () => {
+		stopTrackingDocumentDownloaded();
+		stopTrackingDocumentImpressionMade();
+		stopTrackingDocumentPreviewed();
+	};
+}
+
+export {documents};
+export default documents;