@tryghost/email-mock-receiver 0.2.1 → 0.2.3

package/lib/email-mock-receiver.js

@@ -31,6 +31,8 @@ class EmailMockReceiver {
 
     sentEmailCount(count) {
         assert.equal(this.#snapshots.length, count, 'Email count does not match');
+
+        return this;
     }
 
     /**
@@ -39,30 +41,50 @@ class EmailMockReceiver {
      * @param {Number} snapshotIndex index of snapshot to match
      * @returns {EmailMockReceiver} current instance
      */
-    matchHTMLSnapshot(replacements = [], snapshotIndex = 0) {
+    #matchTextSnapshot(replacements, snapshotIndex, field) {
         const error = new AssertionError({});
 
         let assertion = {
             properties: null,
-            field: 'html',
-            hint: `[html ${snapshotIndex + 1}]`,
+            field: field,
+            hint: `[${field} ${snapshotIndex + 1}]`,
             error
         };
 
-        let html = this.#snapshots[snapshotIndex].html;
+        let text = this.#snapshots[snapshotIndex][field];
         if (replacements.length) {
             for (const [, {pattern, replacement}] of Object.entries(replacements)) {
-                html = html.replace(pattern, replacement);
+                text = text.replace(pattern, replacement);
             }
         }
 
-        this.#snapshotManager.assertSnapshot({
-            html: html
-        }, assertion);
+        const assertedObject = {};
+        assertedObject[field] = text;
+        this.#snapshotManager.assertSnapshot(assertedObject, assertion);
 
         return this;
     }
 
+    /**
+     *
+     * @param {Replacement[]} [replacements] replacement patterns
+     * @param {Number} [snapshotIndex] index of snapshot to match
+     * @returns {EmailMockReceiver} current instance
+     */
+    matchHTMLSnapshot(replacements = [], snapshotIndex = 0) {
+        return this.#matchTextSnapshot(replacements, snapshotIndex, 'html');
+    }
+
+    /**
+     *
+     * @param {Replacement[]} [replacements replacement patterns
+     * @param {Number} [snapshotIndex] index of snapshot to match
+     * @returns {EmailMockReceiver} current instance
+     */
+    matchPlaintextSnapshot(replacements = [], snapshotIndex = 0) {
+        return this.#matchTextSnapshot(replacements, snapshotIndex, 'text');
+    }
+
     /**
      *
      * @param {Object} [properties] - properties to match
@@ -80,6 +102,7 @@ class EmailMockReceiver {
 
         const metadata = Object.assign({}, this.#snapshots[snapshotIndex]);
         delete metadata.html;
+        delete metadata.text;
 
         this.#snapshotManager.assertSnapshot({
             metadata

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/email-mock-receiver",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/email-mock-receiver",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -25,5 +25,5 @@
     "mocha": "10.2.0",
     "sinon": "15.0.3"
   },
-  "gitHead": "886860d772381ed643fc23251ba9dde3d605d0b0"
+  "gitHead": "2e7899ed169bdfbfa05b0126519e632d000aac6d"
 }