@adobe/spacecat-shared-utils 1.23.7 → 1.24.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.24.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.23.8...@adobe/spacecat-shared-utils-v1.24.0) (2024-12-20)
+
+
+### Features
+
+* support site metrics overview ([99a7c66](https://github.com/adobe/spacecat-shared/commit/99a7c66f18ff1ba869ffdb07b17b9505d1f00069))
+
+# [@adobe/spacecat-shared-utils-v1.23.8](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.23.7...@adobe/spacecat-shared-utils-v1.23.8) (2024-12-14)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#492](https://github.com/adobe/spacecat-shared/issues/492)) ([d4daba5](https://github.com/adobe/spacecat-shared/commit/d4daba5686c856f9f0029d805fb2b9f1b9baf777))
+
 # [@adobe/spacecat-shared-utils-v1.23.7](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.23.6...@adobe/spacecat-shared-utils-v1.23.7) (2024-12-13)
 
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.23.7",
+  "version": "1.24.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "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",
@@ -45,8 +45,9 @@
   },
   "dependencies": {
     "@adobe/fetch": "4.1.11",
-    "@aws-sdk/client-s3": "3.705.0",
-    "@aws-sdk/client-sqs": "3.699.0",
+    "@aws-sdk/client-s3": "3.712.0",
+    "@aws-sdk/client-secrets-manager": "3.699.0",
+    "@aws-sdk/client-sqs": "3.712.0",
     "@json2csv/plainjs": "7.0.6",
     "aws-xray-sdk": "3.10.2"
   }

package/src/helpers.js

@@ -11,6 +11,7 @@
  */
 
 import { Parser } from '@json2csv/plainjs';
+import { GetSecretValueCommand, SecretsManagerClient } from '@aws-sdk/client-secrets-manager';
 import { isString } from './functions.js';
 
 /**
@@ -53,6 +54,30 @@ export function resolveCustomerSecretsName(baseURL, ctx) {
   return resolveSecretsName({}, ctx, `${basePath}/${customer}`);
 }
 
+/**
+ * Retrieves the RUM domain key for the specified base URL from the customer secrets.
+ *
+ * @param {string} baseURL - The base URL for which the RUM domain key is to be retrieved.
+ * @param {UniversalContext} context - Helix Universal Context. See https://github.com/adobe/helix-universal/blob/main/src/adapter.d.ts#L120
+ * @returns {Promise<string>} - A promise that resolves to the RUM domain key.
+ * @throws {Error} Throws an error if no domain key is found for the specified base URL.
+ */
+export async function getRUMDomainKey(baseURL, context) {
+  const customerSecretName = resolveCustomerSecretsName(baseURL, context);
+  const { runtime } = context;
+
+  try {
+    const client = new SecretsManagerClient({ region: runtime.region });
+    const command = new GetSecretValueCommand({
+      SecretId: customerSecretName,
+    });
+    const response = await client.send(command);
+    return JSON.parse(response.SecretString)?.RUM_DOMAIN_KEY;
+  } catch (error) {
+    throw new Error(`Error retrieving the domain key for ${baseURL}. Error: ${error.message}`);
+  }
+}
+
 /**
  * Generates a CSV file from the provided JSON data.
  *

package/src/index.d.ts

@@ -115,6 +115,16 @@ declare function resolveSecretsName(opts: object, ctx: object, defaultPath: stri
  */
 declare function resolveCustomerSecretsName(baseURL: string, ctx: object): string;
 
+/**
+ * Retrieves the RUM domain key for the specified base URL from the customer secrets.
+ *
+ * @param {string} baseURL - The base URL for which the RUM domain key is to be retrieved.
+ * @param {object} ctx - Helix Universal Context. See https://github.com/adobe/helix-universal/blob/main/src/adapter.d.ts#L120
+ * @returns {Promise<string>} - A promise that resolves to the RUM domain key.
+ * @throws {Error} Throws an error if no domain key is found for the specified base URL.
+ */
+declare function getRUMDomainKey(baseURL: string, ctx: object): Promise<string>;
+
 /**
  * Generates a CSV file from the provided JSON data.
  *

package/src/index.js

@@ -32,6 +32,7 @@ export {
 export {
   resolveSecretsName,
   resolveCustomerSecretsName,
+  getRUMDomainKey,
   generateCSVFile,
 } from './helpers.js';