@adobe/spacecat-shared-utils 1.26.6 → 1.27.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.27.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.26.6...@adobe/spacecat-shared-utils-v1.27.0) (2025-01-21)
+
+
+### Features
+
+* introduce replace placeholders for prompts ([#551](https://github.com/adobe/spacecat-shared/issues/551)) ([d3b542c](https://github.com/adobe/spacecat-shared/commit/d3b542cf1b546256b3108f989220d07410cdc87d))
+
 # [@adobe/spacecat-shared-utils-v1.26.6](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.26.5...@adobe/spacecat-shared-utils-v1.26.6) (2025-01-18)
 
 

package/package.json

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

package/src/helpers.js

@@ -92,3 +92,21 @@ export function generateCSVFile(data) {
   const json2csvParser = new Parser();
   return Buffer.from(json2csvParser.parse(data), 'utf-8');
 }
+
+/**
+ * Replaces placeholders in the prompt content with their corresponding values.
+ *
+ * @param {string} content - The prompt content with placeholders.
+ * @param {Object} placeholders - The placeholders and their values.
+ * @returns {string} - The content with placeholders replaced.
+ */
+export function replacePlaceholders(content, placeholders) {
+  return content.replace(/{{(.*?)}}/g, (match, key) => {
+    if (key in placeholders) {
+      const value = placeholders[key];
+      return typeof value === 'object' && value !== null ? JSON.stringify(value) : value;
+    } else {
+      return match;
+    }
+  });
+}

package/src/index.d.ts

@@ -143,6 +143,15 @@ declare function getRUMDomainKey(baseURL: string, ctx: object): Promise<string>;
  */
 declare function generateCSVFile(data: object[]): Buffer;
 
+/**
+ * Replaces placeholders in the prompt content with their corresponding values.
+ *
+ * @param {string} content - The prompt content with placeholders.
+ * @param {Object} placeholders - The placeholders and their values.
+ * @returns {string} - The content with placeholders replaced.
+ */
+declare function replacePlaceholders(content: string, placeholders: object): string;
+
 /**
  * Retrieves stored metrics from S3.
  * @param config - Configuration object