@adobe/spacecat-shared-utils 1.30.4 → 1.31.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [@adobe/spacecat-shared-utils-v1.31.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.31.0...@adobe/spacecat-shared-utils-v1.31.1) (2025-02-16)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([#603](https://github.com/adobe/spacecat-shared/issues/603)) ([b58d4c7](https://github.com/adobe/spacecat-shared/commit/b58d4c7237fb2522bba9b722e9eed7b0ae9e5f70))
+
+# [@adobe/spacecat-shared-utils-v1.31.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.30.4...@adobe/spacecat-shared-utils-v1.31.0) (2025-02-12)
+
+
+### Features
+
+* util for reading .query static files, modeled after getPrompt ([#591](https://github.com/adobe/spacecat-shared/issues/591)) ([af3700d](https://github.com/adobe/spacecat-shared/commit/af3700d4a3d1953a312138f0ca46547eaa31eaac)), closes [#579](https://github.com/adobe/spacecat-shared/issues/579) [#579](https://github.com/adobe/spacecat-shared/issues/579)
+
 # [@adobe/spacecat-shared-utils-v1.30.4](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.30.3...@adobe/spacecat-shared-utils-v1.30.4) (2025-02-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.30.4",
+  "version": "1.31.1",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "engines": {
@@ -36,7 +36,7 @@
   "devDependencies": {
     "@adobe/helix-shared-wrap": "2.0.2",
     "@adobe/spacecat-shared-data-access": "2.0.2",
-    "chai": "5.1.2",
+    "chai": "5.2.0",
     "chai-as-promised": "8.0.1",
     "husky": "9.1.7",
     "nock": "14.0.1",
@@ -45,8 +45,8 @@
   },
   "dependencies": {
     "@adobe/fetch": "4.1.11",
-    "@aws-sdk/client-s3": "3.744.0",
-    "@aws-sdk/client-sqs": "3.744.0",
+    "@aws-sdk/client-s3": "3.749.0",
+    "@aws-sdk/client-sqs": "3.749.0",
     "@json2csv/plainjs": "7.0.6",
     "aws-xray-sdk": "3.10.3",
     "uuid": "11.0.5"

package/src/helpers.js

@@ -87,6 +87,19 @@ export function replacePlaceholders(content, placeholders) {
   });
 }
 
+/**
+ * Internal function to support reading static file
+ * and replace placeholder strings with values.
+ *
+ * @param {Object} placeholders - A JSON object containing values to replace in the prompt content.
+ * @param {String} filename - The path of the prompt file.
+ * @returns {Promise<string|null>} - A promise that resolves to a string with the prompt content.
+ */
+async function getStaticContent(placeholders, filename) {
+  const fileContent = await fs.readFile(filename, { encoding: 'utf8' });
+  return replacePlaceholders(fileContent, placeholders);
+}
+
 /**
  * Reads the content of a prompt file asynchronously and replaces any placeholders
  * with the corresponding values. Logs the error and returns null in case of an error.
@@ -99,10 +112,28 @@ export function replacePlaceholders(content, placeholders) {
  */
 export async function getPrompt(placeholders, filename, log = console) {
   try {
-    const promptContent = await fs.readFile(`./static/prompts/${filename}.prompt`, { encoding: 'utf8' });
-    return replacePlaceholders(promptContent, placeholders);
+    return await getStaticContent(placeholders, `./static/prompts/${filename}.prompt`);
   } catch (error) {
     log.error('Error reading prompt file:', error.message);
     return null;
   }
 }
+
+/**
+ * Reads the content of a query file asynchronously and replaces any placeholders
+ * with the corresponding values. Logs the error and returns null in case of an error.
+ *
+ * @param {Object} placeholders - A JSON object containing values to replace in the query content.
+ * @param {String} filename - The filename of the query file.
+ * @param {Object} log - The logger
+ * @returns {Promise<string|null>} - A promise that resolves to a string with the query content,
+ * or null if an error occurs.
+ */
+export async function getQuery(placeholders, filename, log = console) {
+  try {
+    return await getStaticContent(placeholders, `./static/queries/${filename}.query`);
+  } catch (error) {
+    log.error('Error reading query file:', error.message);
+    return null;
+  }
+}

package/src/index.d.ts

@@ -166,6 +166,19 @@ declare function replacePlaceholders(content: string, placeholders: object): str
 declare function getPrompt(placeholders: object, filename: string, log: object):
   Promise<string | null>;
 
+/**
+ * Reads the content of a query file asynchronously and replaces any placeholders
+ * with the corresponding values. Logs the error and returns null in case of an error.
+ *
+ * @param {Object} placeholders - A JSON object containing values to replace in the query content.
+ * @param {String} filename - The filename of the query file.
+ * @param {Object} log - The logger
+ * @returns {Promise<string|null>} - A promise that resolves to a string with the query content,
+ * or null if an error occurs.
+ */
+declare function getQuery(placeholders: object, filename: string, log: object):
+  Promise<string | null>;
+
 /**
  * Retrieves the high-form-view-low-form-conversion metrics from the provided array of form vitals.
  * @param {Object[]} formVitals - An array of form vitals.
@@ -181,7 +194,7 @@ declare function getHighFormViewsLowConversionMetrics(formVitals: object[], inte
  * @returns {Object[]} - An array of high-page-view-low-form-view metrics.
  */
 declare function getHighPageViewsLowFormViewsMetrics(formVitals: object[], interval: number):
-    object[];
+  object[];
 
 /**
  * Retrieves the high-page-view-low-form-ctr metrics from the provided array of form vitals.
@@ -189,7 +202,7 @@ declare function getHighPageViewsLowFormViewsMetrics(formVitals: object[], inter
  * @returns {Object[]} - An array of high-page-view-low-form-ctr metrics.
  */
 declare function getHighPageViewsLowFormCtrMetrics(formVitals: object[], interval: number):
-    object[];
+  object[];
 
 /**
  * Retrieves stored metrics from S3.

package/src/index.js

@@ -37,6 +37,7 @@ export {
   generateCSVFile,
   replacePlaceholders,
   getPrompt,
+  getQuery,
 } from './helpers.js';
 
 export { sqsWrapper } from './sqs.js';