@huloglobal/vendure-plugin-email-tracking 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to `@huloglobal/vendure-plugin-email-tracking` are documented
+here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [semantic versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] — Unreleased
+
+### Added
+- `EmailTrackingPlugin` — wraps `@vendure/email-plugin` and persists every
+  send to the `email_log` table.
+- `TrackingEmailSender` — drop-in `EmailSender` replacement that wraps
+  the default Nodemailer sender and injects an open-tracking pixel and a
+  click redirector into the outgoing HTML.
+- `EmailTrackingService` — exposed for custom controllers that send
+  transactional email outside the email-plugin pipeline.
+- Public endpoints `/email-track/open/:id.gif` (1×1 pixel),
+  `/email-track/click/:id?u=<encoded>` (302 redirect), and
+  `/email-track/bounce` (webhook hook for DSN parsers).
+- Admin endpoints `/email-track/log` (paginated list with filters),
+  `/email-track/log/summary` and `/email-track/log/:id`.
+- Admin UI: standalone Email Log page + a per-customer Emails view.
+- Licence verification via `@huloglobal/vendure-licence-sdk` with revocation
+  polling against the HULO licence server.

package/LICENSE

@@ -0,0 +1,34 @@
+HULO Global Limited — Commercial Plugin Licence
+
+Copyright (c) 2026 HULO Global Limited. All rights reserved.
+
+This software is licensed, not sold, and is made available only to users
+who hold a valid, active subscription or perpetual licence purchased
+from HULO Global Limited.
+
+Permitted use:
+
+  1. The software may be installed and run on a single Vendure
+     instance per active subscription (or per perpetual licence). Each
+     licence is bound to one or more hostnames named at purchase time.
+
+  2. The source code is published only so that customers may audit it
+     for security review. Modification of the source for production use
+     is permitted, but redistribution of the modified source or of any
+     derivative work — in whole or in part — is not permitted.
+
+Prohibited use:
+
+  - Use without a valid, active licence key, except for non-production
+    evaluation under the plugin's "unlicensed mode" (which writes basic
+    delivery rows but disables the open/click endpoints).
+  - Use of the package to circumvent the licence verification routine,
+    or to extract or replace the embedded RSA public key.
+  - Resale, sublicensing, or distribution of the package outside of an
+    application that itself holds a valid HULO Vendure plugin licence.
+
+No warranty. To the maximum extent permitted by law, HULO Global Limited
+disclaims all warranties and all liability arising from use of this
+software.
+
+For commercial licensing enquiries: sales@eliteenterprisesoftware.com

package/README.md

@@ -0,0 +1,129 @@
+# @huloglobal/vendure-plugin-email-tracking
+
+Track delivery, opens and clicks on every transactional email a Vendure
+server sends. Wraps `@vendure/email-plugin`, persists every send + open
++ click in a dedicated `email_log` table, and ships an admin UI to audit
+the trail per customer / order / invoice.
+
+Maintained by Wayne Garrison.
+
+## What you get
+
+- **Universal capture**. Every email produced by the standard
+  `@vendure/email-plugin` (order confirmation, password reset, OTP,
+  invoice, etc.) is logged automatically — no per-handler wiring.
+- **Custom-send helper**. Inject `EmailTrackingService` into your own
+  controllers and call `sendTracked(transporter, mailOpts, meta)` to log
+  ad-hoc sends with the same engagement tracking.
+- **Open tracking** via a 1×1 pixel served at
+  `/email-track/open/:id.gif`. First open captures IP + user-agent.
+- **Click tracking** via a redirector at `/email-track/click/:id?u=…`.
+  Skips `mailto:`, `tel:`, `#`-anchors, and `unsubscribe`/`opt-out`
+  links (ESP rules + privacy expectations).
+- **Per-order / per-customer / per-invoice cross-references** stored on
+  every row.
+- **Admin UI** — global Email Log page + a per-customer Emails action
+  bar item.
+
+## Install
+
+```bash
+yarn add @huloglobal/vendure-plugin-email-tracking
+```
+
+## Wire up
+
+```ts
+import { EmailPlugin } from '@vendure/email-plugin';
+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 (templates, handlers, transport) ...
+      emailSender: new TrackingEmailSender(),
+    }),
+  ],
+};
+```
+
+Add to your admin-ui compile step:
+
+```ts
+import { EmailTrackingPlugin } from '@huloglobal/vendure-plugin-email-tracking';
+
+compileUiExtensions({
+  outputPath: 'admin-ui',
+  extensions: [EmailTrackingPlugin.uiExtensions /* + your other extensions */],
+});
+```
+
+## Init options
+
+| Option | Type | Required | Description |
+| --- | --- | --- | --- |
+| `publicBaseUrl` | `string` | yes | Externally reachable hostname (incl. scheme) of your Vendure server. The pixel + click URLs embedded in outgoing email point here. e.g. `https://shop.example.com`. |
+| `licenceKey` | `string` | no\* | JWT licence key issued by HULO. Without it the plugin runs in **unlicensed mode**: rows are still written, but open/click endpoints return 410 Gone and the admin UI shows an "Unlicensed" banner. |
+| `trackedHosts` | `string[]` | no | Extra hostnames considered "ours" by the click rewriter — useful if you serve `/email-track/*` from a CDN-aliased host. |
+
+\* **Required for production use.** Buy at
+`https://elite-software.co.uk/licence/buy/vendure-plugin-email-tracking`.
+
+## Behind Cloudflare / nginx / Akamai
+
+The plugin extracts the visitor's real IP for the open-tracking pixel
+and click-redirector from the upstream proxy's headers in this order:
+
+1. `CF-Connecting-IP` (Cloudflare)
+2. `True-Client-IP` (Akamai / Cloudflare Enterprise)
+3. `X-Real-IP` (nginx default)
+4. First entry of `X-Forwarded-For` (RFC 7239)
+5. `req.ip` (Express socket — only useful if `app.set('trust proxy')`
+   has been set)
+
+If you sit Vendure behind a proxy that doesn't set any of those — set
+either `cf-connecting-ip` or `x-real-ip` on the proxy. Otherwise the
+pixel will see the proxy's IP, not the visitor's, and `firstOpenIp`
+will be the same value on every row.
+
+No additional config is required on the plugin side.
+
+## Migrations
+
+The plugin owns the `email_log` table. Run `yarn migration:generate
+AddEmailLog` (Vendure picks up the entity automatically) and apply with
+`yarn migration:run`.
+
+## Sending custom tracked emails
+
+```ts
+import { EmailTrackingService } from '@huloglobal/vendure-plugin-email-tracking';
+
+@Controller('my-feature')
+export class MyController {
+  constructor(private tracking: EmailTrackingService) {}
+
+  @Post('send-quote')
+  async sendQuote(/* ... */) {
+    await this.tracking.sendTracked(myNodemailerTransporter, {
+      from: '"You" <you@example.com>',
+      to: customer.email,
+      subject: 'Your quote',
+      html: '<h1>Your quote</h1><p>...</p>',
+    }, {
+      type: 'quote',
+      customerId: customer.id,
+      channelId: 1,
+    });
+  }
+}
+```
+
+## Licence
+
+Commercial — see [LICENSE](./LICENSE). Requires an active subscription
+(monthly $9.95) or a perpetual licence to run in licensed mode.

package/dist/email-log.entity.d.ts

@@ -0,0 +1,57 @@
+import { DeepPartial, VendureEntity } from '@vendure/core';
+export type EmailLogStatus = 'sent' | 'failed' | 'deferred' | 'bounced' | 'complained';
+/**
+ * One row per outgoing email. Captures send metadata + engagement:
+ *   - Send: who, what, when, related order/invoice/customer/application,
+ *           SMTP response, smtpMessageId.
+ *   - Opens: first and last timestamp, count, the IP + UA of the first
+ *            open (most useful — subsequent opens are usually the same
+ *            recipient or a privacy-protection prefetch).
+ *   - Clicks: JSON array of click events with url + ts + ip + ua.
+ *
+ * The tracking pixel and click-redirect endpoints live at
+ *   /email-track/open/:id.gif  and  /email-track/click/:id?u=<encoded>.
+ */
+export declare class EmailLog extends VendureEntity {
+    constructor(input?: DeepPartial<EmailLog>);
+    /** Logical email type: 'welcome', 'order-confirmation', 'invoice',
+     * 'credit-chase', 'credit-chase-T-7', 'payment-terms-invite',
+     * 'fraud-alert', 'gdpr-notice', 'newsletter-welcome', 'quote-request',
+     * 'otp-code', 'password-reset', 'email-verification', etc. */
+    type: string;
+    recipient: string;
+    subject: string;
+    /** Optional FROM display, captured for the audit. */
+    fromAddress: string;
+    /** BCC (almost always sales@). Captured for completeness. */
+    bcc: string;
+    /** Reply-To override (e.g. quote-request emails reply-to the buyer). */
+    replyTo: string;
+    /** Free-text context, e.g. the chase stage 'T-7' / 'due' / 'T+14'. */
+    context: string;
+    channelId: number;
+    customerId: number;
+    orderId: number;
+    orderCode: string;
+    invoiceId: number;
+    applicationId: number;
+    status: EmailLogStatus;
+    smtpResponse: string;
+    smtpMessageId: string;
+    errorMessage: string;
+    openCount: number;
+    firstOpenedAt: Date;
+    lastOpenedAt: Date;
+    firstOpenIp: string;
+    firstOpenUserAgent: string;
+    clickCount: number;
+    /** JSON-encoded array of { url, ts, ip, ua }. Capped to a sensible
+     * size; older clicks beyond the cap are summarised numerically. */
+    clicksJson: string;
+    firstClickedAt: Date;
+    /** Whether the email was sent via our "tracked" pipeline at all.
+     * Always true for emails created by the service; left as a guard
+     * for any future direct-insert tooling. */
+    tracked: boolean;
+}
+//# sourceMappingURL=email-log.entity.d.ts.map

package/dist/email-log.entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-log.entity.d.ts","sourceRoot":"","sources":["../src/email-log.entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAG3D,MAAM,MAAM,cAAc,GACpB,MAAM,GACN,QAAQ,GACR,UAAU,GACV,SAAS,GACT,YAAY,CAAC;AAEnB;;;;;;;;;;;GAWG;AACH,qBACa,QAAS,SAAQ,aAAa;gBAC3B,KAAK,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC;IAIzC;;;kEAG8D;IAG9D,IAAI,EAAG,MAAM,CAAC;IAId,SAAS,EAAG,MAAM,CAAC;IAGnB,OAAO,EAAG,MAAM,CAAC;IAEjB,qDAAqD;IAErD,WAAW,EAAG,MAAM,CAAC;IAErB,6DAA6D;IAE7D,GAAG,EAAG,MAAM,CAAC;IAEb,wEAAwE;IAExE,OAAO,EAAG,MAAM,CAAC;IAEjB,sEAAsE;IAEtE,OAAO,EAAG,MAAM,CAAC;IAGjB,SAAS,EAAG,MAAM,CAAC;IAKnB,UAAU,EAAG,MAAM,CAAC;IAIpB,OAAO,EAAG,MAAM,CAAC;IAIjB,SAAS,EAAG,MAAM,CAAC;IAGnB,SAAS,EAAG,MAAM,CAAC;IAGnB,aAAa,EAAG,MAAM,CAAC;IAKvB,MAAM,EAAG,cAAc,CAAC;IAGxB,YAAY,EAAG,MAAM,CAAC;IAGtB,aAAa,EAAG,MAAM,CAAC;IAGvB,YAAY,EAAG,MAAM,CAAC;IAItB,SAAS,EAAG,MAAM,CAAC;IAGnB,aAAa,EAAG,IAAI,CAAC;IAGrB,YAAY,EAAG,IAAI,CAAC;IAGpB,WAAW,EAAG,MAAM,CAAC;IAGrB,kBAAkB,EAAG,MAAM,CAAC;IAG5B,UAAU,EAAG,MAAM,CAAC;IAEpB;uEACmE;IAEnE,UAAU,EAAG,MAAM,CAAC;IAGpB,cAAc,EAAG,IAAI,CAAC;IAEtB;;+CAE2C;IAE3C,OAAO,EAAG,OAAO,CAAC;CACrB"}

package/dist/email-log.entity.js

@@ -0,0 +1,147 @@
+"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 __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmailLog = void 0;
+const core_1 = require("@vendure/core");
+const typeorm_1 = require("typeorm");
+/**
+ * One row per outgoing email. Captures send metadata + engagement:
+ *   - Send: who, what, when, related order/invoice/customer/application,
+ *           SMTP response, smtpMessageId.
+ *   - Opens: first and last timestamp, count, the IP + UA of the first
+ *            open (most useful — subsequent opens are usually the same
+ *            recipient or a privacy-protection prefetch).
+ *   - Clicks: JSON array of click events with url + ts + ip + ua.
+ *
+ * The tracking pixel and click-redirect endpoints live at
+ *   /email-track/open/:id.gif  and  /email-track/click/:id?u=<encoded>.
+ */
+let EmailLog = class EmailLog extends core_1.VendureEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+exports.EmailLog = EmailLog;
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], EmailLog.prototype, "type", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], EmailLog.prototype, "recipient", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'varchar', length: 512 }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "subject", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, length: 512 }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "fromAddress", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, length: 512 }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "bcc", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, length: 512 }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "replyTo", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "context", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'int', default: 1 }),
+    __metadata("design:type", Number)
+], EmailLog.prototype, "channelId", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", Number)
+], EmailLog.prototype, "customerId", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", Number)
+], EmailLog.prototype, "orderId", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "orderCode", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", Number)
+], EmailLog.prototype, "invoiceId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", Number)
+], EmailLog.prototype, "applicationId", void 0);
+__decorate([
+    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)({ type: 'varchar', default: 'sent' }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, length: 512 }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "smtpResponse", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, length: 512 }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "smtpMessageId", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'text', nullable: true }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "errorMessage", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'int', default: 0 }),
+    __metadata("design:type", Number)
+], EmailLog.prototype, "openCount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'datetime', nullable: true }),
+    __metadata("design:type", Date)
+], EmailLog.prototype, "firstOpenedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'datetime', nullable: true }),
+    __metadata("design:type", Date)
+], EmailLog.prototype, "lastOpenedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "firstOpenIp", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'text', nullable: true }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "firstOpenUserAgent", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'int', default: 0 }),
+    __metadata("design:type", Number)
+], EmailLog.prototype, "clickCount", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'text', nullable: true }),
+    __metadata("design:type", String)
+], EmailLog.prototype, "clicksJson", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'datetime', nullable: true }),
+    __metadata("design:type", Date)
+], EmailLog.prototype, "firstClickedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: 'boolean', default: true }),
+    __metadata("design:type", Boolean)
+], EmailLog.prototype, "tracked", void 0);
+exports.EmailLog = EmailLog = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], EmailLog);
+//# sourceMappingURL=email-log.entity.js.map

package/dist/email-log.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"email-log.entity.js","sourceRoot":"","sources":["../src/email-log.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAA2D;AAC3D,qCAAgD;AAShD;;;;;;;;;;;GAWG;AAEI,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,oBAAa;IACvC,YAAY,KAA6B;QACrC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;CAqGJ,CAAA;AAxGY,4BAAQ;AAWjB;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,gBAAM,GAAE;;sCACK;AAId;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,gBAAM,GAAE;;2CACU;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;yCACxB;AAIjB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;6CACnB;AAIrB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;qCAC3B;AAIb;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;yCACvB;AAIjB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yCACV;AAGjB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;2CACjB;AAKnB;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACP;AAIpB;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;yCACV;AAIjB;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACR;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2CACR;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;+CACJ;AAKvB;IAFC,IAAA,eAAK,GAAE;IACP,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;;wCACrB;AAGxB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;8CAClB;AAGtB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;;+CACjB;AAGvB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;8CACnB;AAItB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;2CACjB;AAGnB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BAC7B,IAAI;+CAAC;AAGrB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BAC9B,IAAI;8CAAC;AAGpB;IADC,IAAA,gBAAM,EAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;6CACN;AAGrB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACb;AAG5B;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;;4CAChB;AAKpB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;4CACrB;AAGpB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BAC5B,IAAI;gDAAC;AAMtB;IADC,IAAA,gBAAM,EAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;;yCACzB;mBAvGT,QAAQ;IADpB,IAAA,gBAAM,GAAE;;GACI,QAAQ,CAwGpB"}

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

@@ -0,0 +1,51 @@
+import { RequestContext, TransactionalConnection } from '@vendure/core';
+import { Request, Response } from 'express';
+import { EmailTrackingService } from './email-tracking.service';
+export declare class EmailTrackingController {
+    private connection;
+    private tracking;
+    constructor(connection: TransactionalConnection, tracking: EmailTrackingService);
+    /**
+     * Open-tracking pixel. Returns a 1×1 transparent GIF and logs the
+     * open against the event. No-cache so privacy-protecting prefetchers
+     * still get caught per fetch (and we count opens accurately).
+     *
+     * GET /email-track/open/:id.gif
+     */
+    open(idParam: string, req: Request, res: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * Click redirect. Logs the click then 302-redirects to the original
+     * URL. Returns 400 if the URL is missing or malformed (we never
+     * redirect to an empty / javascript: target).
+     *
+     * GET /email-track/click/:id?u=<encoded>
+     */
+    click(idParam: string, u: string, req: Request, res: Response): Promise<void | Response<any, Record<string, any>>>;
+    /**
+     * Bounce webhook. Wire up a postmaster / mail-server hook (or have a
+     * scheduled DSN-parser POST here) to mark messages as bounced or
+     * complained. Both fields are required; the messageId is the
+     * `<...@domain>` value Gmail returned at submit time.
+     *
+     * POST /email-track/bounce
+     * Body: { messageId, status: 'bounced'|'complained', reason? }
+     *
+     * Currently unauthenticated to keep the integration simple — gate
+     * behind a shared secret header if you expose the endpoint to the
+     * public internet (it's fine on a private network).
+     */
+    bounce(body: any, res: Response): Promise<Response<any, Record<string, any>>>;
+    /**
+     * Admin: list email events, with filtering for the "Email Log" page
+     * and the per-customer Emails tab. Filterable by customerId, orderId,
+     * orderCode, status, type, recipient, and a date range.
+     *
+     * GET /email-track/log?customerId=&orderId=&status=&take=
+     */
+    listLog(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Admin: aggregate counts by status for a quick dashboard tile. */
+    logSummary(ctx: RequestContext, req: Request, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+    /** Admin: full detail for one event including the clicks JSON. */
+    logDetail(ctx: RequestContext, idParam: string, res: Response): Promise<Response<any, Record<string, any>> | undefined>;
+}
+//# sourceMappingURL=email-tracking.controller.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"email-tracking.controller.d.ts","sourceRoot":"","sources":["../src/email-tracking.controller.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,cAAc,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACjG,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AA0BhE,qBACa,uBAAuB;IAE5B,OAAO,CAAC,UAAU;IAClB,OAAO,CAAC,QAAQ;gBADR,UAAU,EAAE,uBAAuB,EACnC,QAAQ,EAAE,oBAAoB;IAG1C;;;;;;OAMG;IAEG,IAAI,CAAc,OAAO,EAAE,MAAM,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAalF;;;;;;OAMG;IAEG,KAAK,CAAc,OAAO,EAAE,MAAM,EAAc,CAAC,EAAE,MAAM,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAc1G;;;;;;;;;;;;OAYG;IAEG,MAAM,CAAS,IAAI,EAAE,GAAG,EAAS,GAAG,EAAE,QAAQ;IAQpD;;;;;;OAMG;IAEG,OAAO,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAmCnF,oEAAoE;IAE9D,UAAU,CAAQ,GAAG,EAAE,cAAc,EAAS,GAAG,EAAE,OAAO,EAAS,GAAG,EAAE,QAAQ;IAmBtF,kEAAkE;IAE5D,SAAS,CAAQ,GAAG,EAAE,cAAc,EAAe,OAAO,EAAE,MAAM,EAAS,GAAG,EAAE,QAAQ;CAUjG"}