@tryghost/email-mock-receiver 0.1.1 → 0.2.0

package/lib/email-mock-receiver.js

@@ -33,7 +33,13 @@ class EmailMockReceiver {
         assert.equal(this.#snapshots.length, count, 'Email count does not match');
     }
 
-    matchHTMLSnapshot(snapshotIndex = 0) {
+    /**
+     *
+     * @param {Replacement[]} replacements replacement patterns
+     * @param {Number} snapshotIndex index of snapshot to match
+     * @returns {EmailMockReceiver} current instance
+     */
+    matchHTMLSnapshot(replacements = [], snapshotIndex = 0) {
         const error = new AssertionError({});
 
         let assertion = {
@@ -43,14 +49,27 @@ class EmailMockReceiver {
             error
         };
 
+        let html = this.#snapshots[snapshotIndex].html;
+        if (replacements.length) {
+            for (const [, {pattern, replacement}] of Object.entries(replacements)) {
+                html = html.replaceAll(pattern, replacement);
+            }
+        }
+
         this.#snapshotManager.assertSnapshot({
-            html: this.#snapshots[snapshotIndex].html
+            html: html
         }, assertion);
 
         return this;
     }
 
-    matchMetadataSnapshot(snapshotIndex = 0, properties = {}) {
+    /**
+     *
+     * @param {Object} [properties] - properties to match
+     * @param {Number} [snapshotIndex] - index of snapshot to match
+     * @returns {EmailMockReceiver} current instance
+     */
+    matchMetadataSnapshot(properties = {}, snapshotIndex = 0) {
         const error = new AssertionError({});
         let assertion = {
             properties: properties,
@@ -75,3 +94,9 @@ class EmailMockReceiver {
 }
 
 module.exports = EmailMockReceiver;
+
+/**
+ * @typedef {Object} Replacement
+ * @prop {String|RegExp} [pattern] - pattern to match the dynamic content
+ * @prop {String} [replacement] - replacement for the matched pattern
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/email-mock-receiver",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/email-mock-receiver",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -23,7 +23,7 @@
   "devDependencies": {
     "c8": "7.13.0",
     "mocha": "10.2.0",
-    "sinon": "15.0.1"
+    "sinon": "15.0.3"
   },
-  "gitHead": "ca399175e6fe217dd222067bc47b09cd8c973f5b"
+  "gitHead": "ef4fed43a97573417f518409af0bfe957b3a1564"
 }