@adobe/spacecat-shared-rum-api-client 2.19.1 → 2.20.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.20.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.19.1...@adobe/spacecat-shared-rum-api-client-v2.20.0) (2025-02-06)
+
+
+### Features
+
+* add timeOnPage data for HOTLC ([#567](https://github.com/adobe/spacecat-shared/issues/567)) ([e055eb9](https://github.com/adobe/spacecat-shared/commit/e055eb9d035d0191cbd1fa521918796f584e99b6))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.19.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.19.0...@adobe/spacecat-shared-rum-api-client-v2.19.1) (2025-01-31)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.19.1",
+  "version": "2.20.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {
@@ -46,7 +46,7 @@
   "devDependencies": {
     "chai": "5.1.2",
     "chai-as-promised": "8.0.1",
-    "nock": "13.5.6",
+    "nock": "14.0.0",
     "sinon": "19.0.2",
     "sinon-chai": "4.0.0",
     "typescript": "5.7.3"

package/src/functions/opportunities/high-organic-low-ctr.js

@@ -22,7 +22,7 @@ const MAIN_TYPES = ['paid', 'earned', 'owned'];
 
 function convertToOpportunity(traffic) {
   const {
-    url, total, ctr, paid, owned, earned, sources, siteAvgCTR, ctrByUrlAndVendor,
+    url, total, ctr, paid, owned, earned, sources, siteAvgCTR, ctrByUrlAndVendor, pageOnTime,
   } = traffic;
 
   const vendors = sources.reduce((acc, { type, views }) => {
@@ -66,6 +66,12 @@ function convertToOpportunity(traffic) {
       value: {
         page: ctr,
       },
+    }, {
+      type: 'pageOnTime',
+      vendor: '*',
+      value: {
+        time: pageOnTime,
+      },
     }],
   };
   opportunity.metrics.push(...topVendors.flatMap(([vendor, {
@@ -88,7 +94,14 @@ function convertToOpportunity(traffic) {
         page: ctrByUrlAndVendor[vendor],
       },
     };
-    return [trafficMetrics, ctrMetrics];
+    const pageOnTimeMetrics = {
+      type: 'pageOnTime',
+      vendor,
+      value: {
+        time: pageOnTime,
+      },
+    };
+    return [trafficMetrics, ctrMetrics, pageOnTimeMetrics];
   }));
   return opportunity;
 }
@@ -117,11 +130,11 @@ function handler(bundles, opts = {}) {
       ctr: ctrByUrlAndVendor[traffic.url].value,
       siteAvgCTR,
       ctrByUrlAndVendor: ctrByUrlAndVendor[traffic.url].vendors,
+      pageOnTime: traffic.maxTimeDelta,
     }))
     .map(convertToOpportunity);
 }
 
 export default {
   handler,
-  checkpoints: ['email', 'enter', 'paid', 'utm', 'click', 'experiment'],
 };

package/src/functions/traffic-acquisition.js

@@ -15,13 +15,14 @@ import { classifyTraffic } from '../common/traffic.js';
 const MAIN_TYPES = ['total', 'paid', 'earned', 'owned'];
 
 function collectByUrlAndTrafficSource(acc, {
-  url, weight, trafficSource,
+  url, weight, trafficSource, maxTimeDelta,
 }) {
   acc[url] = acc[url] || {
-    total: 0, owned: 0, earned: 0, paid: 0,
+    total: 0, owned: 0, earned: 0, paid: 0, maxTimeDelta: 0,
   };
   acc[url][trafficSource] = (acc[url][trafficSource] || 0) + weight;
   acc[url].total += weight;
+  acc[url].maxTimeDelta = maxTimeDelta;
   const trafficType = trafficSource.split(':')[0];
   acc[url][trafficType] += weight;
   return acc;
@@ -34,26 +35,34 @@ function transformFormat(trafficSources) {
     earned: value.earned,
     owned: value.owned,
     paid: value.paid,
+    maxTimeDelta: value.maxTimeDelta,
     sources: Object.entries(value)
-      .filter(([source]) => !MAIN_TYPES.includes(source))
+      .filter(([source]) => !MAIN_TYPES.includes(source) && source !== 'maxTimeDelta')
       .map(([source, views]) => ({ type: source, views })),
   }));
 }
 
 function formatTraffic(row) {
   const {
-    url, weight, type, category, vendor,
+    url, weight, type, category, vendor, events = [],
   } = row;
+
+  const maxTimeDelta = events.reduce((max, e) => Math.max(max, e.timeDelta), 0);
+
   return {
     url,
     weight,
     trafficSource: vendor ? `${type}:${category}:${vendor}` : `${type}:${category}`,
+    maxTimeDelta,
   };
 }
 
 function handler(bundles) {
   const trafficSources = bundles
-    .map(classifyTraffic)
+    .map((bundle) => ({
+      ...classifyTraffic(bundle),
+      events: bundle.events,
+    }))
     .map(formatTraffic)
     .reduce(collectByUrlAndTrafficSource, {});
 
@@ -63,5 +72,4 @@ function handler(bundles) {
 
 export default {
   handler,
-  checkpoints: ['email', 'enter', 'paid', 'utm', 'experiment'],
 };