@adobe/spacecat-shared-utils 1.87.1 → 1.89.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.89.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.88.0...@adobe/spacecat-shared-utils-v1.89.0) (2026-01-22)
+
+
+### Features
+
+* moved `calculateCpcValue` function to spacecat-shared-utils ([#1048](https://github.com/adobe/spacecat-shared/issues/1048)) ([5006e5b](https://github.com/adobe/spacecat-shared/commit/5006e5be51c8959f2e6d72664251e1e0264d44a1))
+
+# [@adobe/spacecat-shared-utils-v1.88.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.87.1...@adobe/spacecat-shared-utils-v1.88.0) (2026-01-22)
+
+
+### Features
+
+* new json obj in S3 for storing opportunity workspace data ([#1278](https://github.com/adobe/spacecat-shared/issues/1278)) ([68b0db0](https://github.com/adobe/spacecat-shared/commit/68b0db054d9eb43d485cdec9dd55059f8e07318e))
+
 # [@adobe/spacecat-shared-utils-v1.87.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.87.0...@adobe/spacecat-shared-utils-v1.87.1) (2026-01-19)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.87.1",
+  "version": "1.89.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "exports": {

package/src/constants.js

@@ -68,3 +68,5 @@ export const OPPORTUNITY_TYPES = /** @type {const} */ ({
   // Wikipedia Analysis (LLMO)
   WIKIPEDIA_ANALYSIS: 'wikipedia-analysis',
 });
+
+export const DEFAULT_CPC_VALUE = 1.5;

package/src/index.d.ts

@@ -17,6 +17,8 @@ export { AUTHORING_TYPES, DELIVERY_TYPES } from './aem.js';
 
 export { OPPORTUNITY_TYPES } from './constants.js';
 
+export const DEFAULT_CPC_VALUE: number;
+
 /** UTILITY FUNCTIONS */
 export function arrayEquals<T>(a: T[], b: T[]): boolean;
 
@@ -287,6 +289,35 @@ export function getStoredMetrics(config: object, context: object):
  */
 export function storeMetrics(content: object, config: object, context: object): Promise<string>;
 
+/**
+ * Retrieves an object from S3 by its key and returns its JSON parsed content.
+ * If the object is not JSON, returns the raw body.
+ * If the object is not found, returns null.
+ * @param s3Client - The S3 client
+ * @param bucketName - The name of the S3 bucket
+ * @param key - The key of the S3 object
+ * @param log - A logger instance
+ * @returns The content of the S3 object or null if not found
+ */
+export function getObjectFromKey(
+  s3Client: any,
+  bucketName: string,
+  key: string,
+  log: any
+): Promise<any | null>;
+
+/**
+ * Fetches the organic traffic data for a site from S3 and calculates the CPC value
+ * @param context - Context object
+ * @param context.env - Environment variables
+ * @param context.env.S3_IMPORTER_BUCKET_NAME - S3 importer bucket name
+ * @param context.s3Client - S3 client
+ * @param context.log - Logger
+ * @param siteId - The site ID
+ * @returns CPC value in dollars
+ */
+export function calculateCPCValue(context: object, siteId: string): Promise<number>;
+
 export function s3Wrapper(fn: (request: object, context: object) => Promise<Response>):
   (request: object, context: object) => Promise<Response>;
 
@@ -327,6 +358,7 @@ export function extractUrlsFromOpportunity(opts: {
 }): string[];
 
 export * as llmoConfig from './llmo-config.js';
+export * as llmoStrategy from './llmo-strategy.js';
 export * as schemas from './schemas.js';
 
 export { type detectLocale } from './locale-detect/index.js';

package/src/index.js

@@ -76,11 +76,11 @@ export {
   extractUrlsFromSuggestion,
 } from './url-extractors.js';
 
-export { getStoredMetrics, storeMetrics } from './metrics-store.js';
+export { getStoredMetrics, storeMetrics, calculateCPCValue } from './metrics-store.js';
 
-export { s3Wrapper } from './s3.js';
+export { s3Wrapper, getObjectFromKey } from './s3.js';
 
-export { OPPORTUNITY_TYPES } from './constants.js';
+export { OPPORTUNITY_TYPES, DEFAULT_CPC_VALUE } from './constants.js';
 
 export { fetch } from './adobe-fetch.js';
 export { tracingFetch, SPACECAT_USER_AGENT } from './tracing-fetch.js';
@@ -107,6 +107,7 @@ export { detectAEMVersion, DELIVERY_TYPES, AUTHORING_TYPES } from './aem.js';
 export { determineAEMCSPageId, getPageEditUrl } from './aem-content-api-utils.js';
 
 export * as llmoConfig from './llmo-config.js';
+export * as llmoStrategy from './llmo-strategy.js';
 export * as schemas from './schemas.js';
 
 export { detectLocale } from './locale-detect/locale-detect.js';

package/src/llmo-strategy.d.ts

@@ -0,0 +1,93 @@
+/*
+ * 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 { S3Client } from '@aws-sdk/client-s3';
+
+/**
+ * Returns the S3 path for the strategy file.
+ * @param siteId - The ID of the site.
+ * @returns The strategy file path.
+ */
+export function strategyPath(siteId: string): string;
+
+export interface ReadStrategyOptions {
+  /**
+   * Optional version ID of the strategy to read.
+   * Defaults to the latest version.
+   */
+  version?: string;
+  /**
+   * Optional S3 bucket name.
+   */
+  s3Bucket?: string;
+}
+
+export interface ReadStrategyResult {
+  /**
+   * The strategy data, or null if it doesn't exist.
+   */
+  data: object | null;
+  /**
+   * Whether the strategy exists.
+   */
+  exists: boolean;
+  /**
+   * The version ID of the strategy, if it exists.
+   */
+  version?: string;
+}
+
+/**
+ * Reads the strategy JSON for a given site.
+ * Returns null if the strategy does not exist.
+ *
+ * @param siteId - The ID of the site.
+ * @param s3Client - The S3 client to use for reading the strategy.
+ * @param options - Optional configuration.
+ * @returns The strategy data, existence flag, and version ID.
+ * @throws Error if reading the strategy fails for reasons other than it not existing.
+ */
+export function readStrategy(
+  siteId: string,
+  s3Client: S3Client,
+  options?: ReadStrategyOptions
+): Promise<ReadStrategyResult>;
+
+export interface WriteStrategyOptions {
+  /**
+   * Optional S3 bucket name.
+   */
+  s3Bucket?: string;
+}
+
+export interface WriteStrategyResult {
+  /**
+   * The version ID of the written strategy.
+   */
+  version: string;
+}
+
+/**
+ * Writes the strategy JSON for a given site.
+ *
+ * @param siteId - The ID of the site.
+ * @param data - The data object to write (any valid JSON).
+ * @param s3Client - The S3 client to use for writing the strategy.
+ * @param options - Optional configuration.
+ * @returns The version of the strategy written.
+ */
+export function writeStrategy(
+  siteId: string,
+  data: object,
+  s3Client: S3Client,
+  options?: WriteStrategyOptions
+): Promise<WriteStrategyResult>;

package/src/llmo-strategy.js

@@ -0,0 +1,95 @@
+/*
+ * 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 { GetObjectCommand, PutObjectCommand } from '@aws-sdk/client-s3';
+
+/**
+ * @import { S3Client } from "@aws-sdk/client-s3"
+ */
+
+/**
+ * @param {string} siteId The ID of the site to get the strategy file path for.
+ * @returns {string} The strategy file path for the given site ID.
+ */
+export function strategyPath(siteId) {
+  return `workspace/llmo/${siteId}/strategy.json`;
+}
+
+/**
+ * Reads the strategy JSON for a given site.
+ * Returns null if the strategy does not exist.
+ *
+ * @param {string} siteId The ID of the site.
+ * @param {S3Client} s3Client The S3 client to use for reading the strategy.
+ * @param {object} [options]
+ * @param {string} [options.version] Optional version ID of the strategy to read.
+ *        Defaults to the latest version.
+ * @param {string} [options.s3Bucket] Optional S3 bucket name.
+ * @returns {Promise<{data: object | null, exists: boolean, version?: string}>} The strategy data,
+ *        a flag indicating if it existed, and the version ID if it exists.
+ * @throws {Error} If reading the strategy fails for reasons other than it not existing.
+ */
+export async function readStrategy(siteId, s3Client, options) {
+  const version = options?.version;
+  const s3Bucket = options?.s3Bucket || process.env.S3_BUCKET_NAME;
+
+  const getObjectCommand = new GetObjectCommand({
+    Bucket: s3Bucket,
+    Key: strategyPath(siteId),
+    VersionId: version,
+  });
+
+  let res;
+  try {
+    res = await s3Client.send(getObjectCommand);
+  } catch (e) {
+    if (e.name === 'NoSuchKey' || e.name === 'NotFound') {
+      // Strategy does not exist yet. Return null.
+      return { data: null, exists: false, version: undefined };
+    }
+    throw e;
+  }
+
+  const body = res.Body;
+  if (!body) {
+    throw new Error('Strategy body is empty');
+  }
+  const text = await body.transformToString();
+  const data = JSON.parse(text);
+  return { data, exists: true, version: res.VersionId || undefined };
+}
+
+/**
+ * Writes the strategy JSON for a given site.
+ * @param {string} siteId The ID of the site.
+ * @param {object} data The data object to write (any valid JSON).
+ * @param {S3Client} s3Client The S3 client to use for writing the strategy.
+ * @param {object} [options]
+ * @param {string} [options.s3Bucket] Optional S3 bucket name.
+ * @returns {Promise<{ version: string }>} The version of the strategy written.
+ */
+export async function writeStrategy(siteId, data, s3Client, options) {
+  const s3Bucket = options?.s3Bucket || process.env.S3_BUCKET_NAME;
+
+  const putObjectCommand = new PutObjectCommand({
+    Bucket: s3Bucket,
+    Key: strategyPath(siteId),
+    Body: JSON.stringify(data, null, 2),
+    ContentType: 'application/json',
+  });
+
+  const res = await s3Client.send(putObjectCommand);
+  if (!res.VersionId) {
+    throw new Error('Failed to get version ID after writing strategy');
+  }
+  return { version: res.VersionId };
+}

package/src/metrics-store.js

@@ -10,6 +10,8 @@
  * governing permissions and limitations under the License.
  */
 import { GetObjectCommand, PutObjectCommand } from '@aws-sdk/client-s3';
+import { getObjectFromKey } from './s3.js';
+import { DEFAULT_CPC_VALUE } from './constants.js';
 
 function createFilePath({ siteId, source, metric }) {
   if (!siteId) {
@@ -80,3 +82,61 @@ export async function storeMetrics(content, config, context) {
     throw new Error(`Failed to upload metrics to ${filePath}, error: ${e.message}`);
   }
 }
+
+/**
+ * Fetches the organic traffic data for a site from S3 and calculate the CPC value as per
+ * https://wiki.corp.adobe.com/pages/viewpage.action?spaceKey=AEMSites&title=Success+Studio+Projected+Business+Impact+Metrics#SuccessStudioProjectedBusinessImpactMetrics-IdentifyingCPCvalueforadomain
+ * @param context
+ * @param siteId
+ * @returns {object} Object containing either { success: true, value: number } on success
+ * or { success: false, reason: string, value: number } on failure
+ */
+export async function calculateCPCValue(context, siteId) {
+  if (!context?.env?.S3_IMPORTER_BUCKET_NAME) {
+    throw new Error('S3 importer bucket name is required');
+  }
+  if (!context.s3Client) {
+    throw new Error('S3 client is required');
+  }
+  if (!context.log) {
+    throw new Error('Logger is required');
+  }
+  if (!siteId) {
+    throw new Error('SiteId is required');
+  }
+  const { s3Client, log } = context;
+  const bucketName = context.env.S3_IMPORTER_BUCKET_NAME;
+  const key = `metrics/${siteId}/ahrefs/organic-traffic.json`;
+  try {
+    const organicTrafficData = await getObjectFromKey(s3Client, bucketName, key, log);
+    if (!Array.isArray(organicTrafficData) || organicTrafficData.length === 0) {
+      log.warn(`Organic traffic data not available for ${siteId}. Using Default CPC value.`);
+      return {
+        success: false,
+        reason: 'Organic traffic data not available',
+        value: DEFAULT_CPC_VALUE,
+      };
+    }
+    const lastTraffic = organicTrafficData.at(-1);
+    if (!lastTraffic.cost || !lastTraffic.value) {
+      log.warn(`Invalid organic traffic data present for ${siteId} - cost:${lastTraffic.cost} value:${lastTraffic.value}, Using Default CPC value.`);
+      return {
+        success: false,
+        reason: 'Invalid organic traffic data',
+        value: DEFAULT_CPC_VALUE,
+      };
+    }
+    // dividing by 100 for cents to dollar conversion
+    return {
+      success: true,
+      value: lastTraffic.cost / lastTraffic.value / 100,
+    };
+  } catch (err) {
+    log.error(`Error fetching organic traffic data for site ${siteId}. Using Default CPC value.`, err);
+    return {
+      success: false,
+      reason: 'Error fetching organic traffic data',
+      value: DEFAULT_CPC_VALUE,
+    };
+  }
+}

package/src/s3.js

@@ -10,9 +10,55 @@
  * governing permissions and limitations under the License.
  */
 
-import { S3Client } from '@aws-sdk/client-s3';
+import { GetObjectCommand, S3Client } from '@aws-sdk/client-s3';
 import { instrumentAWSClient } from './xray.js';
 
+/**
+ * Retrieves an object from S3 by its key and returns its JSON parsed content.
+ * If the object is not JSON, returns the raw body.
+ * If the object is not found, returns null.
+ * @param {import('@aws-sdk/client-s3').S3Client} s3Client - an S3 client
+ * @param {string} bucketName - the name of the S3 bucket
+ * @param {string} key - the key of the S3 object
+ * @param {import('@azure/logger').Logger} log - a logger instance
+ * @returns {Promise<import('@aws-sdk/client-s3').GetObjectOutput['Body'] | null>}
+ * - the content of the S3 object
+ */
+export async function getObjectFromKey(s3Client, bucketName, key, log) {
+  if (!s3Client || !bucketName || !key) {
+    log.error(
+      'Invalid input parameters in getObjectFromKey: ensure s3Client, bucketName, and key are provided.',
+    );
+    return null;
+  }
+  const command = new GetObjectCommand({
+    Bucket: bucketName,
+    Key: key,
+  });
+  try {
+    const response = await s3Client.send(command);
+    const contentType = response.ContentType;
+    const body = await response.Body.transformToString();
+
+    if (contentType && contentType.includes('application/json')) {
+      try {
+        return JSON.parse(body);
+      } catch (parseError) {
+        log.error(`Unable to parse content for key ${key}`, parseError);
+        return null;
+      }
+    }
+    // Always return body for non-JSON content types
+    return body;
+  } catch (err) {
+    log.error(
+      `Error while fetching S3 object from bucket ${bucketName} using key ${key}`,
+      err,
+    );
+    return null;
+  }
+}
+
 /**
  * Adds an S3Client instance and bucket to the context.
  *