@adobe/spacecat-shared-rum-api-client 2.15.7 → 2.16.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-rum-api-client-v2.16.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.15.7...@adobe/spacecat-shared-rum-api-client-v2.16.0) (2024-12-20)
+
+
+### Features
+
+* support site metrics overview ([99a7c66](https://github.com/adobe/spacecat-shared/commit/99a7c66f18ff1ba869ffdb07b17b9505d1f00069))
+
 # [@adobe/spacecat-shared-rum-api-client-v2.15.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-rum-api-client-v2.15.6...@adobe/spacecat-shared-rum-api-client-v2.15.7) (2024-12-16)
 
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@adobe/spacecat-shared-rum-api-client",
-  "version": "2.15.7",
+  "version": "2.16.0",
   "description": "Shared modules of the Spacecat Services - Rum API client",
   "type": "module",
   "engines": {
     "node": ">=20.0.0 <23.0.0",
-    "npm": ">=10.0.0 <11.0.0"
+    "npm": ">=10.0.0 <12.0.0"
   },
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/functions/total-metrics.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2024 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { DataChunks, series } from '@adobe/rum-distiller';
+import { loadBundles } from '../utils.js';
+
+function handler(bundles) {
+  const dataChunks = new DataChunks();
+  loadBundles(bundles, dataChunks);
+  dataChunks.addSeries('traffic_domain', series.pageViews);
+  dataChunks.addSeries('ctr', (bundle) => (bundle.events.some((e) => e.checkpoint === 'click')
+    ? bundle.weight
+    : 0));
+  const totalPageViews = dataChunks?.totals?.traffic_domain?.weight;
+  const sum = dataChunks?.totals?.ctr?.sum ?? 0;
+  const weight = dataChunks?.totals?.ctr?.weight ?? 0;
+  const totalCTR = weight !== 0 ? sum / weight : 0;
+  return {
+    totalPageViews,
+    totalCTR,
+  };
+}
+
+export default {
+  handler,
+  checkpoints: ['click'],
+};

package/src/index.js

@@ -16,6 +16,7 @@ import cwv from './functions/cwv.js';
 import formVitals from './functions/form-vitals.js';
 import experiment from './functions/experiment.js';
 import trafficAcquisition from './functions/traffic-acquisition.js';
+import totalMetrics from './functions/total-metrics.js';
 import variant from './functions/variant.js';
 import rageclick from './functions/opportunities/rageclick.js';
 import highInorganicHighBounceRate from './functions/opportunities/high-inorganic-high-bounce-rate.js';
@@ -30,6 +31,7 @@ const HANDLERS = {
   'traffic-acquisition': trafficAcquisition,
   variant,
   rageclick,
+  totalMetrics,
   'high-inorganic-high-bounce-rate': highInorganicHighBounceRate,
   'high-organic-low-ctr': highOrganicLowCtr,
 };