npm - @bernierllc/email-webhook-events - Versions diffs - 1.0.0 - Mend

@bernierllc/email-webhook-events 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (97) hide show

package/.eslintrc.cjs +29 -0
package/README.md +349 -0
package/__tests__/EmailWebhookEventsService.test.ts +247 -0
package/__tests__/analytics/AnalyticsEngine.test.ts +244 -0
package/__tests__/normalizers/MailgunNormalizer.test.ts +149 -0
package/__tests__/normalizers/PostmarkNormalizer.test.ts +112 -0
package/__tests__/normalizers/SESNormalizer.test.ts +168 -0
package/__tests__/normalizers/SMTP2GONormalizer.test.ts +83 -0
package/__tests__/normalizers/SendGridNormalizer.test.ts +181 -0
package/__tests__/persistence/PersistenceAdapter.test.ts +103 -0
package/coverage/clover.xml +328 -0
package/coverage/coverage-final.json +10 -0
package/coverage/lcov-report/base.css +224 -0
package/coverage/lcov-report/block-navigation.js +87 -0
package/coverage/lcov-report/favicon.png +0 -0
package/coverage/lcov-report/index.html +161 -0
package/coverage/lcov-report/prettify.css +1 -0
package/coverage/lcov-report/prettify.js +2 -0
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +210 -0
package/coverage/lcov-report/src/EmailWebhookEventsService.ts.html +826 -0
package/coverage/lcov-report/src/analytics/AnalyticsEngine.ts.html +775 -0
package/coverage/lcov-report/src/analytics/index.html +116 -0
package/coverage/lcov-report/src/index.html +131 -0
package/coverage/lcov-report/src/normalizers/MailgunNormalizer.ts.html +301 -0
package/coverage/lcov-report/src/normalizers/PostmarkNormalizer.ts.html +301 -0
package/coverage/lcov-report/src/normalizers/SESNormalizer.ts.html +436 -0
package/coverage/lcov-report/src/normalizers/SMTP2GONormalizer.ts.html +247 -0
package/coverage/lcov-report/src/normalizers/SendGridNormalizer.ts.html +274 -0
package/coverage/lcov-report/src/normalizers/index.html +176 -0
package/coverage/lcov-report/src/persistence/InMemoryPersistenceAdapter.ts.html +289 -0
package/coverage/lcov-report/src/persistence/index.html +116 -0
package/coverage/lcov-report/src/types.ts.html +823 -0
package/coverage/lcov.info +710 -0
package/dist/EmailWebhookEventsService.d.ts +53 -0
package/dist/EmailWebhookEventsService.d.ts.map +1 -0
package/dist/EmailWebhookEventsService.js +198 -0
package/dist/EmailWebhookEventsService.js.map +1 -0
package/dist/analytics/AnalyticsEngine.d.ts +20 -0
package/dist/analytics/AnalyticsEngine.d.ts.map +1 -0
package/dist/analytics/AnalyticsEngine.js +160 -0
package/dist/analytics/AnalyticsEngine.js.map +1 -0
package/dist/index.d.ts +12 -0
package/dist/index.d.ts.map +1 -0
package/dist/index.js +31 -0
package/dist/index.js.map +1 -0
package/dist/normalizers/EventNormalizer.d.ts +5 -0
package/dist/normalizers/EventNormalizer.d.ts.map +1 -0
package/dist/normalizers/EventNormalizer.js +10 -0
package/dist/normalizers/EventNormalizer.js.map +1 -0
package/dist/normalizers/MailgunNormalizer.d.ts +9 -0
package/dist/normalizers/MailgunNormalizer.d.ts.map +1 -0
package/dist/normalizers/MailgunNormalizer.js +73 -0
package/dist/normalizers/MailgunNormalizer.js.map +1 -0
package/dist/normalizers/PostmarkNormalizer.d.ts +10 -0
package/dist/normalizers/PostmarkNormalizer.d.ts.map +1 -0
package/dist/normalizers/PostmarkNormalizer.js +75 -0
package/dist/normalizers/PostmarkNormalizer.js.map +1 -0
package/dist/normalizers/SESNormalizer.d.ts +16 -0
package/dist/normalizers/SESNormalizer.d.ts.map +1 -0
package/dist/normalizers/SESNormalizer.js +107 -0
package/dist/normalizers/SESNormalizer.js.map +1 -0
package/dist/normalizers/SMTP2GONormalizer.d.ts +9 -0
package/dist/normalizers/SMTP2GONormalizer.d.ts.map +1 -0
package/dist/normalizers/SMTP2GONormalizer.js +55 -0
package/dist/normalizers/SMTP2GONormalizer.js.map +1 -0
package/dist/normalizers/SendGridNormalizer.d.ts +9 -0
package/dist/normalizers/SendGridNormalizer.d.ts.map +1 -0
package/dist/normalizers/SendGridNormalizer.js +64 -0
package/dist/normalizers/SendGridNormalizer.js.map +1 -0
package/dist/persistence/InMemoryPersistenceAdapter.d.ts +12 -0
package/dist/persistence/InMemoryPersistenceAdapter.d.ts.map +1 -0
package/dist/persistence/InMemoryPersistenceAdapter.js +58 -0
package/dist/persistence/InMemoryPersistenceAdapter.js.map +1 -0
package/dist/persistence/PersistenceAdapter.d.ts +7 -0
package/dist/persistence/PersistenceAdapter.d.ts.map +1 -0
package/dist/persistence/PersistenceAdapter.js +10 -0
package/dist/persistence/PersistenceAdapter.js.map +1 -0
package/dist/types.d.ts +178 -0
package/dist/types.d.ts.map +1 -0
package/dist/types.js +41 -0
package/dist/types.js.map +1 -0
package/jest.config.cjs +29 -0
package/package.json +51 -0
package/src/EmailWebhookEventsService.ts +247 -0
package/src/analytics/AnalyticsEngine.ts +230 -0
package/src/index.ts +39 -0
package/src/normalizers/EventNormalizer.ts +13 -0
package/src/normalizers/MailgunNormalizer.ts +72 -0
package/src/normalizers/PostmarkNormalizer.ts +72 -0
package/src/normalizers/SESNormalizer.ts +117 -0
package/src/normalizers/SMTP2GONormalizer.ts +54 -0
package/src/normalizers/SendGridNormalizer.ts +63 -0
package/src/persistence/InMemoryPersistenceAdapter.ts +68 -0
package/src/persistence/PersistenceAdapter.ts +15 -0
package/src/types.ts +246 -0
package/tsconfig.json +31 -0

package/coverage/lcov-report/src/normalizers/PostmarkNormalizer.ts.html ADDED Viewed

@@ -0,0 +1,301 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <title>Code coverage report for src/normalizers/PostmarkNormalizer.ts</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="../../prettify.css" />
+    <link rel="stylesheet" href="../../base.css" />
+    <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style type='text/css'>
+        .coverage-summary .sorter {
+            background-image: url(../../sort-arrow-sprite.png);
+        }
+    </style>
+</head>
+<body>
+<div class='wrapper'>
+    <div class='pad1'>
+        <h1><a href="../../index.html">All files</a> / <a href="index.html">src/normalizers</a> PostmarkNormalizer.ts</h1>
+        <div class='clearfix'>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">77.27% </span>
+                <span class="quiet">Statements</span>
+                <span class='fraction'>17/22</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">55.55% </span>
+                <span class="quiet">Branches</span>
+                <span class='fraction'>10/18</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">100% </span>
+                <span class="quiet">Functions</span>
+                <span class='fraction'>5/5</span>
+            </div>
+            <div class='fl pad1y space-right2'>
+                <span class="strong">87.5% </span>
+                <span class="quiet">Lines</span>
+                <span class='fraction'>14/16</span>
+            </div>
+        </div>
+        <p class="quiet">
+            Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
+        </p>
+        <template id="filterTemplate">
+            <div class="quiet">
+                Filter:
+                <input type="search" id="fileSearch">
+            </div>
+        </template>
+    </div>
+    <div class='status-line medium'></div>
+    <pre><table class="coverage">
+<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
+<a name='L2'></a><a href='#L2'>2</a>
+<a name='L3'></a><a href='#L3'>3</a>
+<a name='L4'></a><a href='#L4'>4</a>
+<a name='L5'></a><a href='#L5'>5</a>
+<a name='L6'></a><a href='#L6'>6</a>
+<a name='L7'></a><a href='#L7'>7</a>
+<a name='L8'></a><a href='#L8'>8</a>
+<a name='L9'></a><a href='#L9'>9</a>
+<a name='L10'></a><a href='#L10'>10</a>
+<a name='L11'></a><a href='#L11'>11</a>
+<a name='L12'></a><a href='#L12'>12</a>
+<a name='L13'></a><a href='#L13'>13</a>
+<a name='L14'></a><a href='#L14'>14</a>
+<a name='L15'></a><a href='#L15'>15</a>
+<a name='L16'></a><a href='#L16'>16</a>
+<a name='L17'></a><a href='#L17'>17</a>
+<a name='L18'></a><a href='#L18'>18</a>
+<a name='L19'></a><a href='#L19'>19</a>
+<a name='L20'></a><a href='#L20'>20</a>
+<a name='L21'></a><a href='#L21'>21</a>
+<a name='L22'></a><a href='#L22'>22</a>
+<a name='L23'></a><a href='#L23'>23</a>
+<a name='L24'></a><a href='#L24'>24</a>
+<a name='L25'></a><a href='#L25'>25</a>
+<a name='L26'></a><a href='#L26'>26</a>
+<a name='L27'></a><a href='#L27'>27</a>
+<a name='L28'></a><a href='#L28'>28</a>
+<a name='L29'></a><a href='#L29'>29</a>
+<a name='L30'></a><a href='#L30'>30</a>
+<a name='L31'></a><a href='#L31'>31</a>
+<a name='L32'></a><a href='#L32'>32</a>
+<a name='L33'></a><a href='#L33'>33</a>
+<a name='L34'></a><a href='#L34'>34</a>
+<a name='L35'></a><a href='#L35'>35</a>
+<a name='L36'></a><a href='#L36'>36</a>
+<a name='L37'></a><a href='#L37'>37</a>
+<a name='L38'></a><a href='#L38'>38</a>
+<a name='L39'></a><a href='#L39'>39</a>
+<a name='L40'></a><a href='#L40'>40</a>
+<a name='L41'></a><a href='#L41'>41</a>
+<a name='L42'></a><a href='#L42'>42</a>
+<a name='L43'></a><a href='#L43'>43</a>
+<a name='L44'></a><a href='#L44'>44</a>
+<a name='L45'></a><a href='#L45'>45</a>
+<a name='L46'></a><a href='#L46'>46</a>
+<a name='L47'></a><a href='#L47'>47</a>
+<a name='L48'></a><a href='#L48'>48</a>
+<a name='L49'></a><a href='#L49'>49</a>
+<a name='L50'></a><a href='#L50'>50</a>
+<a name='L51'></a><a href='#L51'>51</a>
+<a name='L52'></a><a href='#L52'>52</a>
+<a name='L53'></a><a href='#L53'>53</a>
+<a name='L54'></a><a href='#L54'>54</a>
+<a name='L55'></a><a href='#L55'>55</a>
+<a name='L56'></a><a href='#L56'>56</a>
+<a name='L57'></a><a href='#L57'>57</a>
+<a name='L58'></a><a href='#L58'>58</a>
+<a name='L59'></a><a href='#L59'>59</a>
+<a name='L60'></a><a href='#L60'>60</a>
+<a name='L61'></a><a href='#L61'>61</a>
+<a name='L62'></a><a href='#L62'>62</a>
+<a name='L63'></a><a href='#L63'>63</a>
+<a name='L64'></a><a href='#L64'>64</a>
+<a name='L65'></a><a href='#L65'>65</a>
+<a name='L66'></a><a href='#L66'>66</a>
+<a name='L67'></a><a href='#L67'>67</a>
+<a name='L68'></a><a href='#L68'>68</a>
+<a name='L69'></a><a href='#L69'>69</a>
+<a name='L70'></a><a href='#L70'>70</a>
+<a name='L71'></a><a href='#L71'>71</a>
+<a name='L72'></a><a href='#L72'>72</a>
+<a name='L73'></a><a href='#L73'>73</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">4x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">4x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">4x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">4x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">4x</span>
+<span class="cline-any cline-yes">1x</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-no">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">4x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-yes">4x</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">/*
+Copyright (c) 2025 Bernier LLC
+&nbsp;
+This file is licensed to the client under a limited-use license.
+The client may use and modify this code *only within the scope of the project it was delivered for*.
+Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
+*/
+&nbsp;
+import { EventNormalizer } from './EventNormalizer';
+import { EmailEvent, EmailEventType, EmailProvider, WebhookPayload } from '../types';
+&nbsp;
+export class PostmarkNormalizer implements EventNormalizer {
+  normalize(webhook: WebhookPayload): EmailEvent {
+    const event = webhook.payload as Record&lt;string, unknown&gt;;
+&nbsp;
+    return {
+      id: this.generateEventId(event),
+      emailId: (event.MessageID as string) || <span class="branch-1 cbranch-no" title="branch not covered" >'',</span>
+      messageId: (event.MessageID as string) || <span class="branch-1 cbranch-no" title="branch not covered" >'',</span>
+      type: this.mapEventType(event.RecordType as string),
+      recipient: (event.Recipient as string) || <span class="branch-1 cbranch-no" title="branch not covered" >'',</span>
+      timestamp: new Date(event.ReceivedAt as string),
+      provider: EmailProvider.POSTMARK,
+      metadata: {
+        url: event.OriginalLink as string | undefined,
+        bounceType: this.mapBounceType(event.Type as string | undefined),
+        bounceReason: event.Description as string | undefined,
+        bounceCode: event.TypeCode?.toString(),
+        complaintFeedbackType: event.Type as string | undefined,
+        userAgent: event.UserAgent as string | undefined,
+        deviceType: this.detectDeviceType(event.UserAgent as string | undefined),
+        location: {
+          country: (event.Geo as Record&lt;string, string&gt; | undefined)?.Country,
+          region: (event.Geo as Record&lt;string, string&gt; | undefined)?.Region,
+          city: (event.Geo as Record&lt;string, string&gt; | undefined)?.City
+        }
+      },
+      rawEvent: event
+    };
+  }
+&nbsp;
+  private mapEventType(postmarkEvent: string): EmailEventType {
+    const mapping: Record&lt;string, EmailEventType&gt; = {
+      'Delivery': EmailEventType.DELIVERED,
+      'Open': EmailEventType.OPENED,
+      'Click': EmailEventType.CLICKED,
+      'Bounce': EmailEventType.BOUNCED,
+      'SpamComplaint': EmailEventType.COMPLAINED,
+      'SubscriptionChange': EmailEventType.UNSUBSCRIBED
+    };
+    return mapping[postmarkEvent] || <span class="branch-1 cbranch-no" title="branch not covered" >EmailEventType.FAILED;</span>
+  }
+&nbsp;
+  private mapBounceType(bounceType?: string): 'hard' | 'soft' | undefined {
+    if (!bounceType) return undefined;
+    if (bounceType.includes('Hard')) return 'hard';
+<span class="cstat-no" title="statement not covered" >    <span class="missing-if-branch" title="if path not taken" >I</span>if (bounceType.includes('Soft')) <span class="cstat-no" title="statement not covered" >return 'soft';</span></span>
+<span class="cstat-no" title="statement not covered" >    return undefined;</span>
+  }
+&nbsp;
+  private generateEventId(event: Record&lt;string, unknown&gt;): string {
+    return `postmark-${(event.MessageID as string) || <span class="branch-1 cbranch-no" title="branch not covered" >''}</span>-${Date.now()}`;
+  }
+&nbsp;
+  private detectDeviceType(userAgent?: string): 'desktop' | 'mobile' | 'tablet' | 'unknown' {
+    if (!userAgent) return 'unknown';
+    const ua = userAgent.toLowerCase();
+    <span class="missing-if-branch" title="if path not taken" >I</span>if (ua.includes('mobile')) <span class="cstat-no" title="statement not covered" >return 'mobile';</span>
+    <span class="missing-if-branch" title="if path not taken" >I</span>if (ua.includes('tablet') || ua.includes('ipad')) <span class="cstat-no" title="statement not covered" >return 'tablet';</span>
+    return 'desktop';
+  }
+}
+&nbsp;</pre></td></tr></table></pre>
+                <div class='push'></div><!-- for sticky footer -->
+            </div><!-- /wrapper -->
+            <div class='footer quiet pad2 space-top1 center small'>
+                Code coverage generated by
+                <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
+                at 2025-11-25T22:14:07.056Z
+            </div>
+        <script src="../../prettify.js"></script>
+        <script>
+            window.onload = function () {
+                prettyPrint();
+            };
+        </script>
+        <script src="../../sorter.js"></script>
+        <script src="../../block-navigation.js"></script>
+    </body>
+</html>