mailery 0.16.6 → 0.16.7
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.
- package/dist/index.cjs +95 -14
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +95 -14
- package/dist/index.js.map +1 -1
- package/dist/{null-CDlseQxO.d.cts → null-oKPS74Gr.d.cts} +43 -0
- package/dist/{null-CDlseQxO.d.ts → null-oKPS74Gr.d.ts} +43 -0
- package/dist/testing.cjs +50 -0
- package/dist/testing.cjs.map +1 -1
- package/dist/testing.d.cts +2 -2
- package/dist/testing.d.ts +2 -2
- package/dist/testing.js +50 -0
- package/dist/testing.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { R as RunnerContext, N as NormalizedEvent, C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, c as MailTesterFeedback, d as Mailer, T as TemplateDoc, F as FlowStep, e as Collections, f as FlowDoc, g as SuppressionScope, D as DeliveryWindow, h as SegmentFilter, P as Predicate } from './null-
|
|
2
|
-
export { i as AuditLogDoc, B as BotFilterConfig, j as BroadcastDoc, k as BroadcastStatus, l as CircuitBreakerThresholds, m as ContactTagDoc, E as EventDoc, n as FlowGoal, o as FlowRunDoc, p as FlowRunStatus, q as FlowVersionDoc, H as HealthDoc, r as HealthStatus, L as LeadDoc, s as MailerConfig, t as NullProvider, O as OutboxDoc, u as RESERVED_VAR_KEYS, v as RedisOptions, w as SegmentDefinition, x as SendDoc, y as SendStatus, z as SenderDomainConfig, G as SenderDomainRegistry, I as SenderDomainValidation, J as SubscriptionDoc, K as SubscriptionStatus, Q as SuppressionDoc, U as SuppressionReason, V as TemplateKind, W as TemplateVersionDoc, X as VarsAdapter, Y as VarsResolveInfo, Z as WebhookEventDoc, _ as defineVars, $ as ensureIndexes, a0 as getCollections, a1 as validateSenderDomain, a2 as varsJsonSchema } from './null-
|
|
1
|
+
import { R as RunnerContext, N as NormalizedEvent, C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, c as MailTesterFeedback, d as Mailer, T as TemplateDoc, F as FlowStep, e as Collections, f as FlowDoc, g as SuppressionScope, D as DeliveryWindow, h as SegmentFilter, P as Predicate } from './null-oKPS74Gr.cjs';
|
|
2
|
+
export { i as AuditLogDoc, B as BotFilterConfig, j as BroadcastDoc, k as BroadcastStatus, l as CircuitBreakerThresholds, m as ContactTagDoc, E as EventDoc, n as FlowGoal, o as FlowRunDoc, p as FlowRunStatus, q as FlowVersionDoc, H as HealthDoc, r as HealthStatus, L as LeadDoc, s as MailerConfig, t as NullProvider, O as OutboxDoc, u as RESERVED_VAR_KEYS, v as RedisOptions, w as SegmentDefinition, x as SendDoc, y as SendStatus, z as SenderDomainConfig, G as SenderDomainRegistry, I as SenderDomainValidation, J as SubscriptionDoc, K as SubscriptionStatus, Q as SuppressionDoc, U as SuppressionReason, V as TemplateKind, W as TemplateVersionDoc, X as VarsAdapter, Y as VarsResolveInfo, Z as WebhookEventDoc, _ as defineVars, $ as ensureIndexes, a0 as getCollections, a1 as validateSenderDomain, a2 as varsJsonSchema } from './null-oKPS74Gr.cjs';
|
|
3
3
|
import { ObjectId, Db, Filter } from 'mongodb';
|
|
4
4
|
import { Request, Router } from 'express';
|
|
5
5
|
import Handlebars from 'handlebars';
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { R as RunnerContext, N as NormalizedEvent, C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, c as MailTesterFeedback, d as Mailer, T as TemplateDoc, F as FlowStep, e as Collections, f as FlowDoc, g as SuppressionScope, D as DeliveryWindow, h as SegmentFilter, P as Predicate } from './null-
|
|
2
|
-
export { i as AuditLogDoc, B as BotFilterConfig, j as BroadcastDoc, k as BroadcastStatus, l as CircuitBreakerThresholds, m as ContactTagDoc, E as EventDoc, n as FlowGoal, o as FlowRunDoc, p as FlowRunStatus, q as FlowVersionDoc, H as HealthDoc, r as HealthStatus, L as LeadDoc, s as MailerConfig, t as NullProvider, O as OutboxDoc, u as RESERVED_VAR_KEYS, v as RedisOptions, w as SegmentDefinition, x as SendDoc, y as SendStatus, z as SenderDomainConfig, G as SenderDomainRegistry, I as SenderDomainValidation, J as SubscriptionDoc, K as SubscriptionStatus, Q as SuppressionDoc, U as SuppressionReason, V as TemplateKind, W as TemplateVersionDoc, X as VarsAdapter, Y as VarsResolveInfo, Z as WebhookEventDoc, _ as defineVars, $ as ensureIndexes, a0 as getCollections, a1 as validateSenderDomain, a2 as varsJsonSchema } from './null-
|
|
1
|
+
import { R as RunnerContext, N as NormalizedEvent, C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, c as MailTesterFeedback, d as Mailer, T as TemplateDoc, F as FlowStep, e as Collections, f as FlowDoc, g as SuppressionScope, D as DeliveryWindow, h as SegmentFilter, P as Predicate } from './null-oKPS74Gr.js';
|
|
2
|
+
export { i as AuditLogDoc, B as BotFilterConfig, j as BroadcastDoc, k as BroadcastStatus, l as CircuitBreakerThresholds, m as ContactTagDoc, E as EventDoc, n as FlowGoal, o as FlowRunDoc, p as FlowRunStatus, q as FlowVersionDoc, H as HealthDoc, r as HealthStatus, L as LeadDoc, s as MailerConfig, t as NullProvider, O as OutboxDoc, u as RESERVED_VAR_KEYS, v as RedisOptions, w as SegmentDefinition, x as SendDoc, y as SendStatus, z as SenderDomainConfig, G as SenderDomainRegistry, I as SenderDomainValidation, J as SubscriptionDoc, K as SubscriptionStatus, Q as SuppressionDoc, U as SuppressionReason, V as TemplateKind, W as TemplateVersionDoc, X as VarsAdapter, Y as VarsResolveInfo, Z as WebhookEventDoc, _ as defineVars, $ as ensureIndexes, a0 as getCollections, a1 as validateSenderDomain, a2 as varsJsonSchema } from './null-oKPS74Gr.js';
|
|
3
3
|
import { ObjectId, Db, Filter } from 'mongodb';
|
|
4
4
|
import { Request, Router } from 'express';
|
|
5
5
|
import Handlebars from 'handlebars';
|
package/dist/index.js
CHANGED
|
@@ -453,6 +453,15 @@ var unsubscribeInputSchema = z.object({
|
|
|
453
453
|
source: z.string().max(256).default("manual"),
|
|
454
454
|
notes: z.string().max(1024).optional()
|
|
455
455
|
});
|
|
456
|
+
var resubscribeInputSchema = z.object({
|
|
457
|
+
externalId: externalIdSchema,
|
|
458
|
+
/** `marketing` clears marketing + all-scope opt-outs; `all` clears every scope. */
|
|
459
|
+
scope: z.enum(["marketing", "all"]).default("marketing"),
|
|
460
|
+
source: z.string().min(1).max(256),
|
|
461
|
+
consentTimestamp: z.date().optional(),
|
|
462
|
+
consentIp: z.string().optional(),
|
|
463
|
+
consentUserAgent: z.string().optional()
|
|
464
|
+
});
|
|
456
465
|
var suppressInputSchema = z.object({
|
|
457
466
|
email: emailSchema,
|
|
458
467
|
scope: unsubscribeScopeSchema,
|
|
@@ -1014,6 +1023,15 @@ function verifyDoiToken(token, secret, now = /* @__PURE__ */ new Date()) {
|
|
|
1014
1023
|
}
|
|
1015
1024
|
|
|
1016
1025
|
// src/server/unsubscribe.ts
|
|
1026
|
+
async function clearUnsubscribeSuppressions(collections, email, scope) {
|
|
1027
|
+
const scopes = scope === "all" ? ["all", "marketing", "transactional"] : ["marketing", "all"];
|
|
1028
|
+
const result = await collections.suppressions.deleteMany({
|
|
1029
|
+
email,
|
|
1030
|
+
reason: "unsubscribed",
|
|
1031
|
+
scope: { $in: scopes }
|
|
1032
|
+
});
|
|
1033
|
+
return result.deletedCount ?? 0;
|
|
1034
|
+
}
|
|
1017
1035
|
async function applyUnsubscribe(collections, input, now = /* @__PURE__ */ new Date()) {
|
|
1018
1036
|
const normalized = input.email;
|
|
1019
1037
|
await collections.suppressions.updateOne(
|
|
@@ -4717,6 +4735,38 @@ var Mailer = class _Mailer {
|
|
|
4717
4735
|
}
|
|
4718
4736
|
}
|
|
4719
4737
|
}
|
|
4738
|
+
/**
|
|
4739
|
+
* An explicit opt-in from a contact who unsubscribed before.
|
|
4740
|
+
*
|
|
4741
|
+
* `upsertSubscription` alone is not enough: an unsubscribe also writes a
|
|
4742
|
+
* `mailer_suppressions` row, and the suppression check runs at enqueue
|
|
4743
|
+
* time regardless of subscription status — so a contact re-subscribed
|
|
4744
|
+
* through `upsertSubscription` reads as subscribed while every send comes
|
|
4745
|
+
* back `suppressed`. This clears the opt-out rows (only those: a bounce or
|
|
4746
|
+
* complaint is not the contact's to reverse), then upserts the subscription
|
|
4747
|
+
* through the normal path, double opt-in included.
|
|
4748
|
+
*
|
|
4749
|
+
* Deliberately a separate method rather than a side effect of
|
|
4750
|
+
* `upsertSubscription`, so a backfill or a model hook that re-upserts every
|
|
4751
|
+
* account cannot silently resurrect addresses that opted out.
|
|
4752
|
+
*/
|
|
4753
|
+
async resubscribe(input) {
|
|
4754
|
+
const parsed = resubscribeInputSchema.parse(input);
|
|
4755
|
+
const contact = await this.adapter.getById(parsed.externalId);
|
|
4756
|
+
if (!contact) throw new Error(`adapter has no contact for externalId ${parsed.externalId}`);
|
|
4757
|
+
const removedSuppressions = await clearUnsubscribeSuppressions(this.collections, contact.email, parsed.scope);
|
|
4758
|
+
const { scope: _scope, ...subscription } = parsed;
|
|
4759
|
+
await this.upsertSubscription(subscription);
|
|
4760
|
+
if (removedSuppressions > 0) {
|
|
4761
|
+
await this.audit({
|
|
4762
|
+
actor: `host:${parsed.source}`,
|
|
4763
|
+
action: "contact.resubscribe",
|
|
4764
|
+
resource: { collection: "mailer_suppressions", id: parsed.externalId },
|
|
4765
|
+
diffSummary: `${contact.email}: removed ${removedSuppressions} unsubscribed suppression${removedSuppressions === 1 ? "" : "s"} (${parsed.scope})`
|
|
4766
|
+
});
|
|
4767
|
+
}
|
|
4768
|
+
return { removedSuppressions };
|
|
4769
|
+
}
|
|
4720
4770
|
/**
|
|
4721
4771
|
* The writes live in `server/unsubscribe.ts` so the pending-unsubscribe
|
|
4722
4772
|
* drain (INVARIANT 8) replays a journaled opt-out through exactly this path
|
|
@@ -5208,7 +5258,7 @@ ${input.plainText}`);
|
|
|
5208
5258
|
});
|
|
5209
5259
|
}
|
|
5210
5260
|
}
|
|
5211
|
-
const offDomain = findOffDomainLinkHosts(input.html, input.fromEmail);
|
|
5261
|
+
const offDomain = findOffDomainLinkHosts(input.html, input.fromEmail, ownHosts(config));
|
|
5212
5262
|
if (offDomain.majority && offDomain.hosts.length > 0) {
|
|
5213
5263
|
issues.push({
|
|
5214
5264
|
rule: "offdomain_links",
|
|
@@ -5293,12 +5343,23 @@ function hostnameOf(url) {
|
|
|
5293
5343
|
}
|
|
5294
5344
|
}
|
|
5295
5345
|
function hasBareUrlInVisibleText(html) {
|
|
5296
|
-
const stripped = html.replace(/<a\b[^>]*>.*?<\/a>/gis, " ").replace(/<style\b[^>]*>.*?<\/style>/gis, " ").replace(/<script\b[^>]*>.*?<\/script>/gis, " ").replace(/<head\b[^>]*>.*?<\/head>/gis, " ");
|
|
5346
|
+
const stripped = html.replace(/<a\b[^>]*>.*?<\/a>/gis, " ").replace(/<style\b[^>]*>.*?<\/style>/gis, " ").replace(/<script\b[^>]*>.*?<\/script>/gis, " ").replace(/<head\b[^>]*>.*?<\/head>/gis, " ").replace(/<[^>]*>/g, " ");
|
|
5297
5347
|
return /https?:\/\/[^\s<>"']+/i.test(stripped);
|
|
5298
5348
|
}
|
|
5299
|
-
function
|
|
5349
|
+
function ownHosts(config) {
|
|
5350
|
+
const hosts = [];
|
|
5351
|
+
const publicHost = config.publicUrl ? hostnameOf(config.publicUrl) : null;
|
|
5352
|
+
if (publicHost) hosts.push(publicHost);
|
|
5353
|
+
for (const d of config.linkDomains ?? []) {
|
|
5354
|
+
const host = hostnameOf(/^https?:\/\//i.test(d) ? d : `https://${d}`);
|
|
5355
|
+
if (host) hosts.push(host);
|
|
5356
|
+
}
|
|
5357
|
+
return hosts;
|
|
5358
|
+
}
|
|
5359
|
+
function findOffDomainLinkHosts(html, fromEmail, extraOwnHosts = []) {
|
|
5300
5360
|
const fromDomain = fromEmail.split("@")[1]?.toLowerCase();
|
|
5301
5361
|
if (!fromDomain) return { hosts: [], majority: false };
|
|
5362
|
+
const own = [fromDomain, ...extraOwnHosts.map((h) => h.toLowerCase())];
|
|
5302
5363
|
const hosts = /* @__PURE__ */ new Set();
|
|
5303
5364
|
let total = 0;
|
|
5304
5365
|
let off = 0;
|
|
@@ -5307,7 +5368,7 @@ function findOffDomainLinkHosts(html, fromEmail) {
|
|
|
5307
5368
|
const host = hostnameOf(href);
|
|
5308
5369
|
if (!host) continue;
|
|
5309
5370
|
total++;
|
|
5310
|
-
if (sameSite(host,
|
|
5371
|
+
if (own.some((o) => sameSite(host, o))) continue;
|
|
5311
5372
|
off++;
|
|
5312
5373
|
hosts.add(host);
|
|
5313
5374
|
}
|
|
@@ -7335,7 +7396,12 @@ function createAdminApiRouter(mailer, opts = {}) {
|
|
|
7335
7396
|
if (!plainText && typeof tpl.body?.plainText === "string") plainText = tpl.body.plainText;
|
|
7336
7397
|
const lint = lintTemplate(
|
|
7337
7398
|
{ subject, preheader, mjml, editorJson, html, plainText, kind, fromEmail },
|
|
7338
|
-
{
|
|
7399
|
+
{
|
|
7400
|
+
senderDomains: mailer.config.senderDomains,
|
|
7401
|
+
varsJsonSchema: varsSchema,
|
|
7402
|
+
publicUrl: mailer.config.publicUrl,
|
|
7403
|
+
linkDomains: mailer.config.linkDomains
|
|
7404
|
+
}
|
|
7339
7405
|
);
|
|
7340
7406
|
res.json({ ...lint, compileFailed: false });
|
|
7341
7407
|
})
|
|
@@ -7386,7 +7452,12 @@ function createAdminApiRouter(mailer, opts = {}) {
|
|
|
7386
7452
|
kind: tpl.kind,
|
|
7387
7453
|
fromEmail: tpl.fromEmail
|
|
7388
7454
|
},
|
|
7389
|
-
{
|
|
7455
|
+
{
|
|
7456
|
+
senderDomains: mailer.config.senderDomains,
|
|
7457
|
+
varsJsonSchema: varsSchema,
|
|
7458
|
+
publicUrl: mailer.config.publicUrl,
|
|
7459
|
+
linkDomains: mailer.config.linkDomains
|
|
7460
|
+
}
|
|
7390
7461
|
);
|
|
7391
7462
|
if (lint.errors.length > 0) {
|
|
7392
7463
|
return res.status(422).json({
|
|
@@ -8253,7 +8324,7 @@ function unitToMs2(value, unit) {
|
|
|
8253
8324
|
}
|
|
8254
8325
|
|
|
8255
8326
|
// src/server/api/agent.ts
|
|
8256
|
-
var VERSION = "0.16.
|
|
8327
|
+
var VERSION = "0.16.7" ;
|
|
8257
8328
|
var agentTagsInputSchema = z.object({
|
|
8258
8329
|
add: z.array(z.string().min(1).max(128)).max(25).default([]),
|
|
8259
8330
|
remove: z.array(z.string().min(1).max(128)).max(25).default([])
|
|
@@ -8502,7 +8573,12 @@ function createAgentRouter(mailer, opts) {
|
|
|
8502
8573
|
kind: input.kind,
|
|
8503
8574
|
fromEmail: input.fromEmail
|
|
8504
8575
|
},
|
|
8505
|
-
{
|
|
8576
|
+
{
|
|
8577
|
+
senderDomains: mailer.config.senderDomains,
|
|
8578
|
+
varsJsonSchema: varsSchema,
|
|
8579
|
+
publicUrl: mailer.config.publicUrl,
|
|
8580
|
+
linkDomains: mailer.config.linkDomains
|
|
8581
|
+
}
|
|
8506
8582
|
);
|
|
8507
8583
|
if (lint.errors.length > 0) {
|
|
8508
8584
|
return res.status(422).json({
|
|
@@ -8833,15 +8909,15 @@ function createAgentRouter(mailer, opts) {
|
|
|
8833
8909
|
const contact = await loadContact(res, String(req.params.externalId));
|
|
8834
8910
|
if (!contact) return;
|
|
8835
8911
|
if (!guardTestContact(res, contact)) return;
|
|
8836
|
-
await mailer.
|
|
8912
|
+
const { removedSuppressions } = await mailer.resubscribe({ externalId: contact.externalId, source: "agent" });
|
|
8837
8913
|
const sub = await c.subscriptions.findOne({ externalId: contact.externalId });
|
|
8838
8914
|
await mailer.audit({
|
|
8839
8915
|
actor: actorOf(req),
|
|
8840
8916
|
action: "agent.contact.subscribe",
|
|
8841
8917
|
resource: { collection: "mailer_subscriptions", id: sub?._id },
|
|
8842
|
-
diffSummary: contact.email
|
|
8918
|
+
diffSummary: `${contact.email} (removed ${removedSuppressions} opt-out suppression${removedSuppressions === 1 ? "" : "s"})`
|
|
8843
8919
|
});
|
|
8844
|
-
res.json({ subscription: sub });
|
|
8920
|
+
res.json({ subscription: sub, removedSuppressions });
|
|
8845
8921
|
})
|
|
8846
8922
|
);
|
|
8847
8923
|
router.post(
|
|
@@ -9166,7 +9242,12 @@ async function verifyTemplate(mailer, tpl, contact, opts = {}) {
|
|
|
9166
9242
|
kind: tpl.kind,
|
|
9167
9243
|
fromEmail: tpl.fromEmail
|
|
9168
9244
|
},
|
|
9169
|
-
{
|
|
9245
|
+
{
|
|
9246
|
+
senderDomains: mailer.config.senderDomains,
|
|
9247
|
+
varsJsonSchema: opts.varsSchema ?? null,
|
|
9248
|
+
publicUrl: mailer.config.publicUrl,
|
|
9249
|
+
linkDomains: mailer.config.linkDomains
|
|
9250
|
+
}
|
|
9170
9251
|
);
|
|
9171
9252
|
push("lint", lint.errors.length ? "fail" : lint.warnings.length ? "warn" : "pass", {
|
|
9172
9253
|
errors: lint.errors.map((i) => ({ rule: i.rule, message: i.message })),
|
|
@@ -9412,7 +9493,7 @@ var ENDPOINTS = [
|
|
|
9412
9493
|
{ method: "GET", path: "/contacts/:externalId", summary: "Contact with subscription, suppressions, recent events, sends and runs." },
|
|
9413
9494
|
{ method: "GET", path: "/contacts/by-email/:email", summary: "Same, looked up by email." },
|
|
9414
9495
|
{ method: "GET", path: "/contacts/:externalId/unsubscribe-url", summary: "A signed one-click unsubscribe URL for a test contact, to exercise POST /m/unsub/:token.", testContactsOnly: true },
|
|
9415
|
-
{ method: "POST", path: "/contacts/:externalId/subscribe", summary: "Subscribe a test contact.", testContactsOnly: true },
|
|
9496
|
+
{ method: "POST", path: "/contacts/:externalId/subscribe", summary: "Subscribe a test contact, clearing any opt-out suppression it has (never bounce/complaint rows).", testContactsOnly: true },
|
|
9416
9497
|
{ method: "POST", path: "/contacts/:externalId/unsubscribe", summary: "Unsubscribe a test contact (marketing scope).", testContactsOnly: true },
|
|
9417
9498
|
{ method: "POST", path: "/contacts/:externalId/tags", summary: "Add or remove tags on a test contact ({add: [...], remove: [...]}), so a gated flow lets it through.", testContactsOnly: true },
|
|
9418
9499
|
{ method: "POST", path: "/contacts/:externalId/reset", summary: "Delete a test contact's runs, sends, events ({events: [names]} to narrow) and suppressions, then resubscribe. Each part can be turned off with false.", testContactsOnly: true },
|
|
@@ -10131,7 +10212,7 @@ var DEDUPE_POLICIES = [
|
|
|
10131
10212
|
];
|
|
10132
10213
|
|
|
10133
10214
|
// src/server/index.ts
|
|
10134
|
-
var VERSION2 = "0.16.
|
|
10215
|
+
var VERSION2 = "0.16.7" ;
|
|
10135
10216
|
|
|
10136
10217
|
export { DEDUPE_POLICIES, DEFAULT_BOT_UA_RE, FLOW_STEP_KINDS, FlowOperationError, MIN_AGENT_TOKEN_LENGTH, Mailer, MongoContactAdapter, NullProvider, PREDICATE_KINDS, RESERVED_VAR_KEYS, SEGMENT_FILTER_KINDS, SendGridProvider, TRACKING_SIG_LENGTH, VERSION2 as VERSION, applyTracking, applyWebhookEvent, armFlow, compileMailyTemplate, compileTemplate, computeDeliveryTime, createAdminApiRouter, createAdminRouter, createAgentRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, defineVars, derivePlaintext, disarmFlow, dispatchSend, drainPendingUnsubscribes, ensureIndexes, gateFlow, getCollections, isCanaryGate, predicateKind, processNewlyFiredEventTriggers, processOneRunStep, referencedPaths, renderForContact, renderTemplate, runTick, sendgridInboundParser, sha256Hex, signTrackingToken, signUnsubscribeToken, simulateFlow, stampWatermarkIfNull, sweepStrandedFlowRuns, ungateFlow, validateSenderDomain, varsJsonSchema, verifyTemplate, verifyTrackingToken, verifyUnsubscribeToken };
|
|
10137
10218
|
//# sourceMappingURL=index.js.map
|