@macive/ui 0.0.13 → 0.0.14

package/dist/src/utilities/renderSafeTemplate.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderSafeTemplate = void 0;
+/**
+ * Renders a template string by replacing placeholders with sanitized values.
+ * @param {string} template - The template string containing placeholders (e.g., `{{key}}`).
+ * @param {Record<ExtractPlaceholders<Template>, string>} values - An object containing key-value pairs for replacement.
+ * @returns {string} - The processed string with placeholders replaced and sanitized.
+ * @example
+ * // Scenario 1: Basic usage
+ * const template1 = "Hello, {{name}}! Welcome to {{app}}.";
+ * const values1 = { name: "John", app: "MyApp" };
+ * renderSafeTemplate(template1, values1); // Returns "Hello, John! Welcome to MyApp."
+ *
+ * @example
+ * // Scenario 2: Sanitization to prevent XSS
+ * const template2 = "Hello, {{name}}! Welcome to {{app}}.";
+ * const values2 = { name: "<script>alert('XSS')</script>John", app: "MyApp" };
+ * renderSafeTemplate(template2, values2); // Returns "Hello, &lt;script&gt;alert('XSS')&lt;/script&gt;John! Welcome to MyApp."
+ *
+ * @example
+ * // Scenario 3: Missing placeholder key
+ * const template3 = "Hello, {{name}}! Welcome to {{app}}.";
+ * const values3 = { name: "John" }; // `app` key is missing
+ * renderSafeTemplate(template3, values3); // Returns "Hello, John! Welcome to ."
+ *
+ * @example
+ * // Scenario 4: HTML link replacement
+ * const template4 = "Visit us at <a href='{{link}}'>{{link}}</a>.";
+ * const values4 = { link: "https://example.com" };
+ * renderSafeTemplate(template4, values4); // Returns "Visit us at <a href='https://example.com'>https://example.com</a>."
+ */
+function renderSafeTemplate(template, values) {
+    // Sanitize function to prevent XSS or unwanted HTML/script injection
+    const sanitize = (input) => {
+        return input.replace(/</g, '&lt;').replace(/>/g, '&gt;');
+    };
+    // Replace placeholders with sanitized values
+    return template.replace(/\{\{(\w+)\}\}/g, (_, key) => sanitize(values[key] || ''));
+}
+exports.renderSafeTemplate = renderSafeTemplate;