@huloglobal/vendure-plugin-email-tracking 0.1.0

package/dist/options.js

@@ -0,0 +1,52 @@
+"use strict";
+/**
+ * Module-scoped plugin options. Populated by `EmailTrackingPlugin.init()`
+ * at boot and read by the service / sender / controller via the
+ * exported helpers below. Keeping options in module scope rather than
+ * threading them through every constructor avoids a refactor of the
+ * Nest providers — Nest creates services lazily and we want options
+ * available before that happens.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setOptions = setOptions;
+exports.getOptions = getOptions;
+exports.setLicenceStatus = setLicenceStatus;
+exports.getLicenceStatus = getLicenceStatus;
+exports.trackingBaseUrl = trackingBaseUrl;
+exports.ownTrackingPrefixes = ownTrackingPrefixes;
+let cachedOptions = {
+    publicBaseUrl: 'http://localhost:3000',
+    licenceKey: undefined,
+    trackedHosts: undefined,
+};
+let cachedStatus = null;
+function setOptions(opts) {
+    cachedOptions = {
+        publicBaseUrl: opts.publicBaseUrl.replace(/\/$/, ''),
+        licenceKey: opts.licenceKey,
+        trackedHosts: opts.trackedHosts,
+    };
+}
+function getOptions() {
+    return cachedOptions;
+}
+function setLicenceStatus(status) {
+    cachedStatus = status;
+}
+function getLicenceStatus() {
+    return cachedStatus;
+}
+/** Public tracking base URL — used by both the click-rewriter and the
+ *  open-pixel injector. Always returns a value without a trailing slash. */
+function trackingBaseUrl() {
+    return cachedOptions.publicBaseUrl;
+}
+/** Hostname prefixes the click-rewriter should treat as already-ours
+ *  and skip rewriting. */
+function ownTrackingPrefixes() {
+    const list = cachedOptions.trackedHosts && cachedOptions.trackedHosts.length
+        ? cachedOptions.trackedHosts
+        : [cachedOptions.publicBaseUrl];
+    return list.map(h => h.replace(/\/$/, '') + '/email-track/');
+}
+//# sourceMappingURL=options.js.map

package/dist/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../src/options.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;AAqCH,gCAMC;AAED,gCAEC;AAED,4CAEC;AAED,4CAEC;AAID,0CAEC;AAID,kDAKC;AAxCD,IAAI,aAAa,GAA+B;IAC5C,aAAa,EAAE,uBAAuB;IACtC,UAAU,EAAE,SAAS;IACrB,YAAY,EAAE,SAAS;CAC1B,CAAC;AACF,IAAI,YAAY,GAAyB,IAAI,CAAC;AAE9C,SAAgB,UAAU,CAAC,IAAgC;IACvD,aAAa,GAAG;QACZ,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;QACpD,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;KAClC,CAAC;AACN,CAAC;AAED,SAAgB,UAAU;IACtB,OAAO,aAAa,CAAC;AACzB,CAAC;AAED,SAAgB,gBAAgB,CAAC,MAAqB;IAClD,YAAY,GAAG,MAAM,CAAC;AAC1B,CAAC;AAED,SAAgB,gBAAgB;IAC5B,OAAO,YAAY,CAAC;AACxB,CAAC;AAED;4EAC4E;AAC5E,SAAgB,eAAe;IAC3B,OAAO,aAAa,CAAC,aAAa,CAAC;AACvC,CAAC;AAED;0BAC0B;AAC1B,SAAgB,mBAAmB;IAC/B,MAAM,IAAI,GAAG,aAAa,CAAC,YAAY,IAAI,aAAa,CAAC,YAAY,CAAC,MAAM;QACxE,CAAC,CAAC,aAAa,CAAC,YAAY;QAC5B,CAAC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACpC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC;AACjE,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,53 @@
+import { Type } from '@vendure/core';
+import { EmailTrackingPluginOptions } from './options';
+/**
+ * `@huloglobal/vendure-plugin-email-tracking`
+ *
+ * Logs every transactional email a Vendure server sends — Vendure-plugin
+ * sends (order confirmation, OTP, password reset, invoice, etc.) plus
+ * any custom sends routed through the exposed `EmailTrackingService`.
+ * Each row captures recipient, subject, links to the related order /
+ * customer / invoice, the SMTP response, plus per-event opens + clicks
+ * via a 1×1 tracking pixel and a click redirector.
+ *
+ * Add to your Vendure config:
+ *
+ * ```ts
+ * import { EmailTrackingPlugin, TrackingEmailSender } from '@huloglobal/vendure-plugin-email-tracking';
+ *
+ * export const config: VendureConfig = {
+ *   plugins: [
+ *     EmailTrackingPlugin.init({
+ *       publicBaseUrl: 'https://shop.example.com',
+ *       licenceKey: process.env.HULO_LICENCE_KEY,
+ *     }),
+ *     EmailPlugin.init({
+ *       // ... your existing email-plugin config ...
+ *       emailSender: new TrackingEmailSender(),
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * Add the admin UI extension by including `EmailTrackingPlugin.uiExtensions`
+ * in your `compileUiExtensions` config.
+ */
+export declare class EmailTrackingPlugin {
+    private static revocation;
+    static init(options: EmailTrackingPluginOptions): Type<EmailTrackingPlugin>;
+    static uiExtensions: {
+        extensionPath: string;
+        ngModules: ({
+            type: "lazy";
+            route: string;
+            ngModuleFileName: string;
+            ngModuleName: string;
+        } | {
+            type: "shared";
+            ngModuleFileName: string;
+            ngModuleName: string;
+            route?: undefined;
+        })[];
+    };
+}
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,IAAI,EAAiB,MAAM,eAAe,CAAC;AAMxE,OAAO,EAAE,0BAA0B,EAAgC,MAAM,WAAW,CAAC;AAmBrF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,qBAOa,mBAAmB;IAC5B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAkC;IAE3D,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CAAC,mBAAmB,CAAC;IAgC3E,MAAM,CAAC,YAAY;;;;;;;;;;;;;MAejB;CACL"}

package/dist/plugin.js

@@ -0,0 +1,118 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var EmailTrackingPlugin_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailTrackingPlugin = void 0;
+const core_1 = require("@vendure/core");
+const vendure_licence_sdk_1 = require("@huloglobal/vendure-licence-sdk");
+const email_log_entity_1 = require("./email-log.entity");
+const email_tracking_service_1 = require("./email-tracking.service");
+const email_tracking_controller_1 = require("./email-tracking.controller");
+const options_1 = require("./options");
+// Public key embedded at build time. The matching private key lives on
+// HULO's licence server and never leaves it. If you fork this plugin
+// privately you must replace this constant with your own public key.
+const HULO_PUBLIC_KEY = `-----BEGIN PUBLIC KEY-----
+MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoLmNM5UljRqe71drM6lR
+Ba5vXrLOcV3GAHkYvnVFQSqdE0avrge/jsD7WdA6x8qQFNRugxQcxDJa2l0+C+BH
+SbU9TimGwhA1yusHHfuz9LAXks5IQ48+2e6Pulh7iThXPJUnIKqKZUN5HhL79aaK
+vrZKIgSfVhwE5PMPXWZ+Ij5IRf74PLIUn1Er75qhBXlDJ4vF8y8/3owURNC1XiUB
+DGElwV/LYNoqAQei4oixe4EAxPGvFi11pgHiGuRxuWckA88y6ZHLt6urfAY9sCkj
+kF+2dc2yS3j7lD+SYAaV5LQYYjePP1CYvxCZ7HHRKqthHopxY1hsK2tBtni3f7/c
+UwIDAQAB
+-----END PUBLIC KEY-----`;
+const PLUGIN_ID = 'vendure-plugin-email-tracking';
+const REVOCATION_URL = process.env.HULO_LICENCE_REVOCATION_URL
+    || 'https://elite.charity/licence/revoked.json';
+/**
+ * `@huloglobal/vendure-plugin-email-tracking`
+ *
+ * Logs every transactional email a Vendure server sends — Vendure-plugin
+ * sends (order confirmation, OTP, password reset, invoice, etc.) plus
+ * any custom sends routed through the exposed `EmailTrackingService`.
+ * Each row captures recipient, subject, links to the related order /
+ * customer / invoice, the SMTP response, plus per-event opens + clicks
+ * via a 1×1 tracking pixel and a click redirector.
+ *
+ * Add to your Vendure config:
+ *
+ * ```ts
+ * import { EmailTrackingPlugin, TrackingEmailSender } from '@huloglobal/vendure-plugin-email-tracking';
+ *
+ * export const config: VendureConfig = {
+ *   plugins: [
+ *     EmailTrackingPlugin.init({
+ *       publicBaseUrl: 'https://shop.example.com',
+ *       licenceKey: process.env.HULO_LICENCE_KEY,
+ *     }),
+ *     EmailPlugin.init({
+ *       // ... your existing email-plugin config ...
+ *       emailSender: new TrackingEmailSender(),
+ *     }),
+ *   ],
+ * };
+ * ```
+ *
+ * Add the admin UI extension by including `EmailTrackingPlugin.uiExtensions`
+ * in your `compileUiExtensions` config.
+ */
+let EmailTrackingPlugin = EmailTrackingPlugin_1 = class EmailTrackingPlugin {
+    static init(options) {
+        (0, options_1.setOptions)(options);
+        // Start the revocation checker once; safe to call init() again
+        // during hot reloads — `RevocationChecker.start()` is idempotent.
+        if (!EmailTrackingPlugin_1.revocation) {
+            EmailTrackingPlugin_1.revocation = new vendure_licence_sdk_1.RevocationChecker(REVOCATION_URL);
+            EmailTrackingPlugin_1.revocation.start();
+        }
+        const host = (options.publicBaseUrl || '')
+            .replace(/^https?:\/\//, '').replace(/\/.*$/, '');
+        const status = (0, vendure_licence_sdk_1.verifyLicence)({
+            licenceKey: options.licenceKey,
+            pluginId: PLUGIN_ID,
+            host,
+            publicKey: HULO_PUBLIC_KEY,
+            revokedIds: EmailTrackingPlugin_1.revocation.getRevokedIds(),
+        });
+        (0, options_1.setLicenceStatus)(status);
+        if (!status.valid) {
+            // eslint-disable-next-line no-console
+            console.warn(`[@huloglobal/vendure-plugin-email-tracking] ${status.message}` +
+                ` — Running in unlicensed mode. Purchase a key at https://elite-software.co.uk/licence/buy/${PLUGIN_ID}`);
+        }
+        return EmailTrackingPlugin_1;
+    }
+};
+exports.EmailTrackingPlugin = EmailTrackingPlugin;
+EmailTrackingPlugin.revocation = null;
+EmailTrackingPlugin.uiExtensions = {
+    extensionPath: __dirname + '/../ui',
+    ngModules: [
+        {
+            type: 'lazy',
+            route: 'email-log',
+            ngModuleFileName: 'email-log.module.ts',
+            ngModuleName: 'EmailLogModule',
+        },
+        {
+            type: 'shared',
+            ngModuleFileName: 'email-log-nav.module.ts',
+            ngModuleName: 'EmailLogNavModule',
+        },
+    ],
+};
+exports.EmailTrackingPlugin = EmailTrackingPlugin = EmailTrackingPlugin_1 = __decorate([
+    (0, core_1.VendurePlugin)({
+        imports: [core_1.PluginCommonModule],
+        providers: [email_tracking_service_1.EmailTrackingService],
+        controllers: [email_tracking_controller_1.EmailTrackingController],
+        entities: [email_log_entity_1.EmailLog],
+        compatibility: '^3.0.0',
+    })
+], EmailTrackingPlugin);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,wCAAwE;AACxE,yEAAmF;AACnF,yDAA8C;AAC9C,qEAAgE;AAChE,2EAAsE;AAEtE,uCAAqF;AAErF,uEAAuE;AACvE,qEAAqE;AACrE,qEAAqE;AACrE,MAAM,eAAe,GAAG;;;;;;;;yBAQC,CAAC;AAE1B,MAAM,SAAS,GAAG,+BAA+B,CAAC;AAClD,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,2BAA2B;OACvD,4CAA4C,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAQI,IAAM,mBAAmB,2BAAzB,MAAM,mBAAmB;IAG5B,MAAM,CAAC,IAAI,CAAC,OAAmC;QAC3C,IAAA,oBAAU,EAAC,OAAO,CAAC,CAAC;QAEpB,+DAA+D;QAC/D,kEAAkE;QAClE,IAAI,CAAC,qBAAmB,CAAC,UAAU,EAAE,CAAC;YAClC,qBAAmB,CAAC,UAAU,GAAG,IAAI,uCAAiB,CAAC,cAAc,CAAC,CAAC;YACvE,qBAAmB,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QAC3C,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC;aACrC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAA,mCAAa,EAAC;YACzB,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,QAAQ,EAAE,SAAS;YACnB,IAAI;YACJ,SAAS,EAAE,eAAe;YAC1B,UAAU,EAAE,qBAAmB,CAAC,UAAU,CAAC,aAAa,EAAE;SAC7D,CAAC,CAAC;QACH,IAAA,0BAAgB,EAAC,MAAM,CAAC,CAAC;QAEzB,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAChB,sCAAsC;YACtC,OAAO,CAAC,IAAI,CACR,+CAA+C,MAAM,CAAC,OAAO,EAAE;gBAC/D,6FAA6F,SAAS,EAAE,CAC3G,CAAC;QACN,CAAC;QAED,OAAO,qBAAmB,CAAC;IAC/B,CAAC;;AAjCQ,kDAAmB;AACb,8BAAU,GAA6B,IAAI,AAAjC,CAAkC;AAkCpD,gCAAY,GAAG;IAClB,aAAa,EAAE,SAAS,GAAG,QAAQ;IACnC,SAAS,EAAE;QACP;YACI,IAAI,EAAE,MAAe;YACrB,KAAK,EAAE,WAAW;YAClB,gBAAgB,EAAE,qBAAqB;YACvC,YAAY,EAAE,gBAAgB;SACjC;QACD;YACI,IAAI,EAAE,QAAiB;YACvB,gBAAgB,EAAE,yBAAyB;YAC3C,YAAY,EAAE,mBAAmB;SACpC;KACJ;CACJ,AAfkB,CAejB;8BAlDO,mBAAmB;IAP/B,IAAA,oBAAa,EAAC;QACX,OAAO,EAAE,CAAC,yBAAkB,CAAC;QAC7B,SAAS,EAAE,CAAC,6CAAoB,CAAC;QACjC,WAAW,EAAE,CAAC,mDAAuB,CAAC;QACtC,QAAQ,EAAE,CAAC,2BAAQ,CAAC;QACpB,aAAa,EAAE,QAAQ;KAC1B,CAAC;GACW,mBAAmB,CAmD/B"}

package/dist/proxy-headers.d.ts

@@ -0,0 +1,37 @@
+import { Request } from 'express';
+/**
+ * Reverse-proxy aware visitor IP extraction.
+ *
+ * Order of precedence:
+ *   1. Cloudflare's `CF-Connecting-IP` (always the real client IP,
+ *      regardless of how many proxies sit in front of the worker).
+ *   2. `True-Client-IP` (Akamai / Cloudflare Enterprise).
+ *   3. `X-Real-IP` (nginx / Caddy default when proxying).
+ *   4. First entry in `X-Forwarded-For` (RFC 7239 ancestor; the
+ *      left-most entry is the original client when the upstream proxy
+ *      is trusted).
+ *   5. Express's `req.ip` — only useful when `app.set('trust proxy', ...)`
+ *      has been set on the Vendure host, otherwise this is the socket
+ *      address of the last hop.
+ *
+ * Returns `null` if none of the headers are populated and `req.ip`
+ * isn't available — the caller should treat this as "unknown" and
+ * skip IP-dependent enrichment rather than fail.
+ */
+export declare function getRealIp(req: Request): string | null;
+/**
+ * Cloudflare / Akamai populate the visitor's resolved country on the
+ * inbound request when the corresponding feature is enabled. Reading
+ * the upstream value avoids a per-request GeoIP lookup. Returns the
+ * ISO 3166-1 alpha-2 country code or `null` if no proxy header is
+ * present.
+ */
+export declare function getResolvedCountry(req: Request): string | null;
+/**
+ * Cloudflare's `cf-region-code` carries the ISO 3166-2 subdivision
+ * (e.g. `ENG`, `SCT`, `CA`) when the "Send subdivision data" option is
+ * enabled in the dashboard. Returns the bare code without the country
+ * prefix, or `null` if unavailable.
+ */
+export declare function getResolvedRegion(req: Request): string | null;
+//# sourceMappingURL=proxy-headers.d.ts.map

package/dist/proxy-headers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy-headers.d.ts","sourceRoot":"","sources":["../src/proxy-headers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAkBrD;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAe9D;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAK7D"}

package/dist/proxy-headers.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRealIp = getRealIp;
+exports.getResolvedCountry = getResolvedCountry;
+exports.getResolvedRegion = getResolvedRegion;
+/**
+ * Reverse-proxy aware visitor IP extraction.
+ *
+ * Order of precedence:
+ *   1. Cloudflare's `CF-Connecting-IP` (always the real client IP,
+ *      regardless of how many proxies sit in front of the worker).
+ *   2. `True-Client-IP` (Akamai / Cloudflare Enterprise).
+ *   3. `X-Real-IP` (nginx / Caddy default when proxying).
+ *   4. First entry in `X-Forwarded-For` (RFC 7239 ancestor; the
+ *      left-most entry is the original client when the upstream proxy
+ *      is trusted).
+ *   5. Express's `req.ip` — only useful when `app.set('trust proxy', ...)`
+ *      has been set on the Vendure host, otherwise this is the socket
+ *      address of the last hop.
+ *
+ * Returns `null` if none of the headers are populated and `req.ip`
+ * isn't available — the caller should treat this as "unknown" and
+ * skip IP-dependent enrichment rather than fail.
+ */
+function getRealIp(req) {
+    var _a;
+    const headers = req.headers || {};
+    const cfIp = String(headers['cf-connecting-ip'] || '').trim();
+    if (cfIp)
+        return cfIp;
+    const trueClient = String(headers['true-client-ip'] || '').trim();
+    if (trueClient)
+        return trueClient;
+    const realIp = String(headers['x-real-ip'] || '').trim();
+    if (realIp)
+        return realIp;
+    const xff = String(headers['x-forwarded-for'] || '').trim();
+    if (xff) {
+        const first = (_a = xff.split(',')[0]) === null || _a === void 0 ? void 0 : _a.trim();
+        if (first)
+            return first;
+    }
+    return req.ip || null;
+}
+/**
+ * Cloudflare / Akamai populate the visitor's resolved country on the
+ * inbound request when the corresponding feature is enabled. Reading
+ * the upstream value avoids a per-request GeoIP lookup. Returns the
+ * ISO 3166-1 alpha-2 country code or `null` if no proxy header is
+ * present.
+ */
+function getResolvedCountry(req) {
+    const headers = req.headers || {};
+    const cf = String(headers['cf-ipcountry'] || '').trim().toUpperCase();
+    if (cf && cf !== 'XX' && cf !== 'T1')
+        return cf;
+    const akamai = String(headers['x-akamai-edgescape'] || '').trim();
+    if (akamai) {
+        const m = akamai.match(/country_code=([A-Z]{2})/i);
+        if (m)
+            return m[1].toUpperCase();
+    }
+    const fastly = String(headers['x-country-code'] || '').trim().toUpperCase();
+    if (fastly && /^[A-Z]{2}$/.test(fastly))
+        return fastly;
+    return null;
+}
+/**
+ * Cloudflare's `cf-region-code` carries the ISO 3166-2 subdivision
+ * (e.g. `ENG`, `SCT`, `CA`) when the "Send subdivision data" option is
+ * enabled in the dashboard. Returns the bare code without the country
+ * prefix, or `null` if unavailable.
+ */
+function getResolvedRegion(req) {
+    const headers = req.headers || {};
+    const cf = String(headers['cf-region-code'] || '').trim().toUpperCase();
+    if (cf && /^[A-Z0-9]{1,4}$/.test(cf))
+        return cf;
+    return null;
+}
+//# sourceMappingURL=proxy-headers.js.map

package/dist/proxy-headers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy-headers.js","sourceRoot":"","sources":["../src/proxy-headers.ts"],"names":[],"mappings":";;AAqBA,8BAkBC;AASD,gDAeC;AAQD,8CAKC;AA1ED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,SAAS,CAAC,GAAY;;IAClC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;IAClC,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9D,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IAEtB,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAClE,IAAI,UAAU;QAAE,OAAO,UAAU,CAAC;IAElC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACzD,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAE1B,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5D,IAAI,GAAG,EAAE,CAAC;QACN,MAAM,KAAK,GAAG,MAAA,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,0CAAE,IAAI,EAAE,CAAC;QACxC,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;IAC5B,CAAC;IAED,OAAQ,GAAW,CAAC,EAAE,IAAI,IAAI,CAAC;AACnC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,GAAY;IAC3C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;IAClC,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACtE,IAAI,EAAE,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI;QAAE,OAAO,EAAE,CAAC;IAEhD,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAClE,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACnD,IAAI,CAAC;YAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACrC,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC5E,IAAI,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC;IAEvD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,iBAAiB,CAAC,GAAY;IAC1C,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;IAClC,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACxE,IAAI,EAAE,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;QAAE,OAAO,EAAE,CAAC;IAChD,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/tracking-email-sender.d.ts

@@ -0,0 +1,22 @@
+import { Injector } from '@vendure/core';
+import { EmailSender } from '@vendure/email-plugin/lib/src/sender/email-sender';
+import { EmailDetails, EmailTransportOptions } from '@vendure/email-plugin/lib/src/types';
+/**
+ * Wraps the default NodemailerEmailSender so every send by the Vendure
+ * email-plugin (order confirmation, password reset, OTP, invoice, etc.)
+ * also creates an EmailLog row and gets the open-pixel + click-tracking
+ * rewrites applied to its html body.
+ *
+ * The actual SMTP transport handling stays in the default sender — we just
+ * mutate the body in-place before delegating, and persist the row.
+ */
+export declare class TrackingEmailSender implements EmailSender {
+    private inner;
+    private connection;
+    init(injector: Injector): void;
+    send(email: EmailDetails, options: EmailTransportOptions): Promise<void>;
+    /** Best-effort categorisation of plugin-email sends. */
+    private inferType;
+    private wrapHtml;
+}
+//# sourceMappingURL=tracking-email-sender.d.ts.map

package/dist/tracking-email-sender.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracking-email-sender.d.ts","sourceRoot":"","sources":["../src/tracking-email-sender.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmC,MAAM,eAAe,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,mDAAmD,CAAC;AAChF,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAO1F;;;;;;;;GAQG;AACH,qBAAa,mBAAoB,YAAW,WAAW;IACnD,OAAO,CAAC,KAAK,CAA+B;IAC5C,OAAO,CAAC,UAAU,CAA2B;IAE7C,IAAI,CAAC,QAAQ,EAAE,QAAQ;IASjB,IAAI,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IA0C9E,wDAAwD;IACxD,OAAO,CAAC,SAAS;IAcjB,OAAO,CAAC,QAAQ;CAenB"}

package/dist/tracking-email-sender.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackingEmailSender = void 0;
+const core_1 = require("@vendure/core");
+const nodemailer_email_sender_1 = require("@vendure/email-plugin/lib/src/sender/nodemailer-email-sender");
+const email_log_entity_1 = require("./email-log.entity");
+const options_1 = require("./options");
+const loggerCtx = 'TrackingEmailSender';
+/**
+ * Wraps the default NodemailerEmailSender so every send by the Vendure
+ * email-plugin (order confirmation, password reset, OTP, invoice, etc.)
+ * also creates an EmailLog row and gets the open-pixel + click-tracking
+ * rewrites applied to its html body.
+ *
+ * The actual SMTP transport handling stays in the default sender — we just
+ * mutate the body in-place before delegating, and persist the row.
+ */
+class TrackingEmailSender {
+    constructor() {
+        this.inner = new nodemailer_email_sender_1.NodemailerEmailSender();
+    }
+    init(injector) {
+        try {
+            this.connection = injector.get(core_1.TransactionalConnection);
+            core_1.Logger.info('TrackingEmailSender init() OK — tracking enabled', loggerCtx);
+        }
+        catch (e) {
+            core_1.Logger.error(`TrackingEmailSender init() FAILED: ${e === null || e === void 0 ? void 0 : e.message}`, loggerCtx);
+        }
+    }
+    async send(email, options) {
+        var _a, _b;
+        const trackable = options.type === 'smtp' || options.type === 'ses' || options.type === 'sendmail';
+        if (!trackable) {
+            return this.inner.send(email, options);
+        }
+        if (!this.connection) {
+            core_1.Logger.warn(`TrackingEmailSender.send() called but connection is null — skipping tracking for "${email.subject}"`, loggerCtx);
+            return this.inner.send(email, options);
+        }
+        const repo = this.connection.rawConnection.getRepository(email_log_entity_1.EmailLog);
+        const row = repo.create({
+            type: this.inferType(email.subject),
+            recipient: (email.recipient || '').slice(0, 500),
+            subject: (email.subject || '').slice(0, 1000),
+            fromAddress: (email.from || '').slice(0, 500),
+            bcc: (_a = email.bcc) === null || _a === void 0 ? void 0 : _a.slice(0, 500),
+            replyTo: (_b = email.replyTo) === null || _b === void 0 ? void 0 : _b.slice(0, 500),
+            channelId: 1,
+            status: 'sent',
+            tracked: true,
+        });
+        const saved = await repo.save(row);
+        // Rewrite + pixel-inject the html body in place.
+        try {
+            email.body = this.wrapHtml(email.body || '', Number(saved.id));
+        }
+        catch (e) {
+            core_1.Logger.warn(`tracking wrap failed: ${e === null || e === void 0 ? void 0 : e.message}`, loggerCtx);
+        }
+        try {
+            await this.inner.send(email, options);
+        }
+        catch (e) {
+            saved.status = 'failed';
+            saved.errorMessage = String((e === null || e === void 0 ? void 0 : e.message) || e).slice(0, 2000);
+            await repo.save(saved);
+            throw e;
+        }
+        core_1.Logger.info(`Tracked plugin-email [${saved.type}] to ${saved.recipient} (id=${saved.id})`, loggerCtx);
+    }
+    /** Best-effort categorisation of plugin-email sends. */
+    inferType(subject) {
+        const s = (subject || '').toLowerCase();
+        if (s.includes('order confirmation') || s.includes('order receipt'))
+            return 'order-confirmation';
+        if (s.includes('verify'))
+            return 'email-verification';
+        if (s.includes('password'))
+            return 'password-reset';
+        if (s.includes('otp') || s.includes('one-time') || s.includes('login code'))
+            return 'otp-code';
+        if (s.includes('invoice'))
+            return 'invoice';
+        if (s.includes('review'))
+            return 'review-reminder';
+        if (s.includes('payment'))
+            return 'payment-due';
+        if (s.includes('abandoned'))
+            return 'abandoned-cart';
+        if (s.includes('email address'))
+            return 'email-address-change';
+        return 'plugin-email';
+    }
+    wrapHtml(html, eventId) {
+        const base = (0, options_1.trackingBaseUrl)();
+        const ownPrefixes = (0, options_1.ownTrackingPrefixes)();
+        const rewritten = html.replace(/<a\b([^>]*?)\bhref\s*=\s*(["'])(.*?)\2/gi, (m, attrs, q, url) => {
+            const trimmed = String(url).trim();
+            if (!trimmed)
+                return m;
+            if (/^(mailto:|tel:|#)/i.test(trimmed))
+                return m;
+            if (ownPrefixes.some(p => trimmed.startsWith(p)))
+                return m;
+            if (/unsubscribe/i.test(trimmed) || /\bopt[-_]?out\b/i.test(trimmed))
+                return m;
+            return `<a${attrs}href=${q}${base}/email-track/click/${eventId}?u=${encodeURIComponent(trimmed)}${q}`;
+        });
+        const pixel = `<img src="${base}/email-track/open/${eventId}.gif" width="1" height="1" alt="" border="0" style="display:none;border:0;max-height:1px;max-width:1px;outline:none;overflow:hidden;visibility:hidden">`;
+        if (/<\/body>/i.test(rewritten))
+            return rewritten.replace(/<\/body>/i, `${pixel}</body>`);
+        return rewritten + pixel;
+    }
+}
+exports.TrackingEmailSender = TrackingEmailSender;
+//# sourceMappingURL=tracking-email-sender.js.map

package/dist/tracking-email-sender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracking-email-sender.js","sourceRoot":"","sources":["../src/tracking-email-sender.ts"],"names":[],"mappings":";;;AAAA,wCAA0E;AAG1E,0GAAqG;AACrG,yDAA8D;AAC9D,uCAAiE;AAEjE,MAAM,SAAS,GAAG,qBAAqB,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAa,mBAAmB;IAAhC;QACY,UAAK,GAAG,IAAI,+CAAqB,EAAE,CAAC;IAoFhD,CAAC;IAjFG,IAAI,CAAC,QAAkB;QACnB,IAAI,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,GAAG,CAAC,8BAAuB,CAAC,CAAC;YACxD,aAAM,CAAC,IAAI,CAAC,kDAAkD,EAAE,SAAS,CAAC,CAAC;QAC/E,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,aAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,EAAE,EAAE,SAAS,CAAC,CAAC;QAChF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAmB,EAAE,OAA8B;;QAC1D,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,KAAK,MAAM,IAAI,OAAO,CAAC,IAAI,KAAK,KAAK,IAAI,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC;QACnG,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACnB,aAAM,CAAC,IAAI,CAAC,qFAAqF,KAAK,CAAC,OAAO,GAAG,EAAE,SAAS,CAAC,CAAC;YAC9H,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC,2BAAQ,CAAC,CAAC;QACnE,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;YACpB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC;YACnC,SAAS,EAAE,CAAC,KAAK,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;YAChD,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC;YAC7C,WAAW,EAAE,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;YAC7C,GAAG,EAAE,MAAA,KAAK,CAAC,GAAG,0CAAE,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;YAC7B,OAAO,EAAE,MAAA,KAAK,CAAC,OAAO,0CAAE,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;YACrC,SAAS,EAAE,CAAC;YACZ,MAAM,EAAE,MAAwB;YAChC,OAAO,EAAE,IAAI;SAChB,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEnC,iDAAiD;QACjD,IAAI,CAAC;YACD,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,aAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,EAAE,EAAE,SAAS,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACd,KAAK,CAAC,MAAM,GAAG,QAAQ,CAAC;YACxB,KAAK,CAAC,YAAY,GAAG,MAAM,CAAC,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,OAAO,KAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC5D,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,MAAM,CAAC,CAAC;QACZ,CAAC;QACD,aAAM,CAAC,IAAI,CAAC,yBAAyB,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,SAAS,QAAQ,KAAK,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;IAC1G,CAAC;IAED,wDAAwD;IAChD,SAAS,CAAC,OAAe;QAC7B,MAAM,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QACxC,IAAI,CAAC,CAAC,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;YAAE,OAAO,oBAAoB,CAAC;QACjG,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,OAAO,oBAAoB,CAAC;QACtD,IAAI,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;YAAE,OAAO,gBAAgB,CAAC;QACpD,IAAI,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;YAAE,OAAO,UAAU,CAAC;QAC/F,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;QAC5C,IAAI,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAAE,OAAO,iBAAiB,CAAC;QACnD,IAAI,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;YAAE,OAAO,aAAa,CAAC;QAChD,IAAI,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC;YAAE,OAAO,gBAAgB,CAAC;QACrD,IAAI,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC;YAAE,OAAO,sBAAsB,CAAC;QAC/D,OAAO,cAAc,CAAC;IAC1B,CAAC;IAEO,QAAQ,CAAC,IAAY,EAAE,OAAe;QAC1C,MAAM,IAAI,GAAG,IAAA,yBAAe,GAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,IAAA,6BAAmB,GAAE,CAAC;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,0CAA0C,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE;YAC5F,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YACnC,IAAI,CAAC,OAAO;gBAAE,OAAO,CAAC,CAAC;YACvB,IAAI,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC;gBAAE,OAAO,CAAC,CAAC;YACjD,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;gBAAE,OAAO,CAAC,CAAC;YAC3D,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC;gBAAE,OAAO,CAAC,CAAC;YAC/E,OAAO,KAAK,KAAK,QAAQ,CAAC,GAAG,IAAI,sBAAsB,OAAO,MAAM,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1G,CAAC,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,aAAa,IAAI,qBAAqB,OAAO,yJAAyJ,CAAC;QACrN,IAAI,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC;QAC1F,OAAO,SAAS,GAAG,KAAK,CAAC;IAC7B,CAAC;CACJ;AArFD,kDAqFC"}

package/package.json

@@ -0,0 +1,53 @@
+{
+    "name": "@huloglobal/vendure-plugin-email-tracking",
+    "version": "0.1.0",
+    "description": "Track delivery, opens and clicks on every transactional email a Vendure server sends. Wraps the @vendure/email-plugin pipeline plus an exposed helper for plugin-authored sends, persists every event to a dedicated EmailLog table, and ships an admin UI for per-customer / per-order audit trails.",
+    "license": "SEE LICENSE IN LICENSE",
+    "author": "Wayne Garrison <wayne@garrison.me.uk>",
+    "homepage": "https://github.com/exceeded/vendure-plugin-email-tracking",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/exceeded/vendure-plugin-email-tracking.git"
+    },
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist",
+        "ui",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE"
+    ],
+    "scripts": {
+        "build": "tsc -p tsconfig.json",
+        "prepublishOnly": "yarn build"
+    },
+    "dependencies": {
+        "@huloglobal/vendure-licence-sdk": "^0.1.0"
+    },
+    "peerDependencies": {
+        "@vendure/core": ">=3.0.0",
+        "@vendure/email-plugin": ">=3.0.0",
+        "@nestjs/common": ">=10.0.0",
+        "nodemailer": ">=6.0.0",
+        "typeorm": ">=0.3.0"
+    },
+    "devDependencies": {
+        "@huloglobal/vendure-licence-sdk": "^0.1.0",
+        "@nestjs/common": "^10.0.0",
+        "@types/nodemailer": "^6.0.0",
+        "@vendure/core": "^3.6.0",
+        "@vendure/email-plugin": "^3.6.0",
+        "nodemailer": "^6.9.0",
+        "typeorm": "^0.3.0",
+        "typescript": "^5.4.0"
+    },
+    "keywords": [
+        "vendure",
+        "vendure-plugin",
+        "email-tracking",
+        "email",
+        "transactional-email",
+        "analytics"
+    ]
+}