@adobe/spacecat-shared-athena-client 1.3.7 → 1.4.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-athena-client-v1.4.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.3.8...@adobe/spacecat-shared-athena-client-v1.4.0) (2025-11-07)
+
+
+### Features
+
+* PTA2 Summary query ([#1102](https://github.com/adobe/spacecat-shared/issues/1102)) ([06e902a](https://github.com/adobe/spacecat-shared/commit/06e902a5487c2fc2e79a3f15d7acf1072900fab4))
+
+# [@adobe/spacecat-shared-athena-client-v1.3.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.3.7...@adobe/spacecat-shared-athena-client-v1.3.8) (2025-11-01)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#1081](https://github.com/adobe/spacecat-shared/issues/1081)) ([4476494](https://github.com/adobe/spacecat-shared/commit/44764944350f9344d0ca5e2af5a2161cc7470899))
+
 # [@adobe/spacecat-shared-athena-client-v1.3.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-athena-client-v1.3.6...@adobe/spacecat-shared-athena-client-v1.3.7) (2025-10-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-athena-client",
-  "version": "1.3.7",
+  "version": "1.4.0",
   "description": "Shared modules of the Spacecat Services - AWS Athena Client",
   "type": "module",
   "engines": {
@@ -35,7 +35,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@aws-sdk/client-athena": "3.917.0",
+    "@aws-sdk/client-athena": "3.922.0",
     "@adobe/spacecat-shared-utils": "1.66.0"
   },
   "devDependencies": {

package/src/index.js

@@ -264,3 +264,5 @@ export {
 } from './traffic-analysis/queries.js';
 export { TrafficDataResponseDto } from './traffic-analysis/traffic-data-base-response.js';
 export { TrafficDataWithCWVDto } from './traffic-analysis/traffic-data-with-cwv.js';
+
+export { getPTASummaryQuery, PTASummaryResponseDto } from './pta2/queries.js';

package/src/pta2/queries.js

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2025 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 { getTemporalCondition } from '@adobe/spacecat-shared-utils';
+
+/**
+ * Generates the PTA summary query template using template literals.
+ * @param {Object} params - Template parameters
+ * @param {string} params.siteId - Site ID
+ * @param {string} params.tableName - Table name
+ * @param {string} params.temporalCondition - Temporal condition
+ * @param {number} params.week - Week number (either week or month must be provided)
+ * @param {number} params.month - Month number (either week or month year must be provided)
+ * @param {number} params.year - Year number
+ * @returns {string} The SQL query string
+ */
+export function getPTASummaryQuery({
+  siteId,
+  tableName,
+  week,
+  month,
+  year,
+}) {
+  if (!siteId || !tableName) {
+    throw new Error('Missing required parameters: siteId, or tableName');
+  }
+
+  if ((!week && !month) || !year) {
+    throw new Error('Missing required parameters: week, month or year');
+  }
+
+  const temporalCondition = getTemporalCondition({ week, month, year });
+
+  return `
+  SELECT
+        CAST(SUM(pageviews) AS BIGINT) AS total_pageviews,
+        CAST(SUM(clicked) AS BIGINT) AS total_clicks,
+        CAST(SUM(engaged) AS BIGINT) AS total_engaged,
+        COUNT(*) AS total_rows,
+        CAST(SUM(clicked) AS DOUBLE) / NULLIF(COUNT(*), 0) AS click_rate,
+        CAST(SUM(engaged) AS DOUBLE) / NULLIF(COUNT(*), 0) AS engagement_rate,
+        1 - CAST(SUM(engaged) AS DOUBLE) / NULLIF(COUNT(*), 0) AS bounce_rate
+    FROM ${tableName}
+    WHERE siteid = '${siteId}'
+        AND (${temporalCondition})
+        AND trf_type = 'paid'
+  `;
+}
+
+export const PTASummaryResponseDto = {
+  /**
+   * Converts a traffic data object into a JSON object.
+   * @param {object} data - traffic data object.
+   * @returns {{
+   *   pageviews: number,
+   *   click_rate: number,
+   *   engagement_rate: number,
+   *   bounce_rate: number
+   * }} JSON object.
+   */
+  toJSON: (data) => ({
+    pageviews: data.total_pageviews,
+    click_rate: data.click_rate,
+    engagement_rate: data.engagement_rate,
+    bounce_rate: data.bounce_rate,
+  }),
+};