@shware/workflow 5.0.1 → 6.1.0

package/dist/email.cjs

@@ -25,15 +25,34 @@ function mimeAddress(address) {
 	if (SPECIALS.test(name)) return `"${name.replace(/(["\\])/g, "\\$1")}" <${email}>`;
 	return `${name} <${email}>`;
 }
-/** The template's metadata, its `unsubscribeUrl` falling back to the config's. Leaves both untouched. */
-function resolveEmail(template, config) {
-	const unsubscribeUrl = template.unsubscribeUrl ?? config?.unsubscribeUrl;
+/**
+* The message id a preview renders with: the preferences link shows in the studio and
+* `GET /preview`, pointing at a copy that does not exist.
+*/
+const PREVIEW_MESSAGE_ID = "00000000-0000-0000-0000-000000000000";
+/**
+* The template's metadata, its `unsubscribeUrl` falling back to the config's, and the
+* preferences link built from the config's page and the copy's message id — for a topic email; a
+* transactional one resolves to neither link. Leaves the inputs untouched.
+*/
+function resolveEmail(template, config, options = {}) {
+	const topical = template.topic !== null;
+	const unsubscribeUrl = topical ? template.unsubscribeUrl ?? config?.unsubscribeUrl : void 0;
+	const preferencesUrl = topical && config?.preferencesUrl !== void 0 && options.messageId !== void 0 ? preferencesLink(config.preferencesUrl, options.messageId) : void 0;
 	return {
 		from: template.from,
+		topic: template.topic,
 		...template.replyTo === void 0 ? {} : { replyTo: template.replyTo },
-		...unsubscribeUrl === void 0 ? {} : { unsubscribeUrl }
+		...unsubscribeUrl === void 0 ? {} : { unsubscribeUrl },
+		...preferencesUrl === void 0 ? {} : { preferencesUrl }
 	};
 }
+/** The preference page's URL for one copy: `m=<message id>` set on its query, the rest of it kept. */
+function preferencesLink(preferencesUrl, messageId) {
+	const url = new URL(preferencesUrl);
+	url.searchParams.set("m", messageId);
+	return url.toString();
+}
 const ADDRESS = /^[^\s@<>]+@[^\s@<>]+$/;
 /** Throws naming `where` when `address` is neither `user@host` nor `{ email: 'user@host', name? }`. */
 function assertEmailAddress(address, where) {
@@ -43,7 +62,7 @@ function assertEmailAddress(address, where) {
 	if (name !== void 0 && typeof name !== "string") throw new TypeError(`${where}.name must be a string`);
 }
 /** Throws naming `where` unless `url` is an absolute http(s) URL; '' and null are not a way to leave it out. */
-function assertUnsubscribeUrl(url, where) {
+function assertHttpUrl(url, where) {
 	let parsed;
 	try {
 		parsed = typeof url === "string" ? new URL(url) : void 0;
@@ -52,22 +71,54 @@ function assertUnsubscribeUrl(url, where) {
 	}
 	if (parsed === void 0 || parsed.protocol !== "https:" && parsed.protocol !== "http:") throw new TypeError(`${where} must be an http(s) URL (leave it out for none)`);
 }
+/** `assertHttpUrl`, under its earlier name. */
+const assertUnsubscribeUrl = assertHttpUrl;
 /** The config's `email` and every registered template's metadata; throws on the first invalid value. */
 function assertEmailConfig(config, templates) {
-	if (Object.hasOwn(config, "emails")) throw new TypeError("the config's `emails` is gone: `from` and `replyTo` are declared on each emailTemplate, and the rest moved to `email: { unsubscribeUrl, tracking }`");
+	if (Object.hasOwn(config, "emails")) throw new TypeError("the config's `emails` is gone: `from` and `replyTo` are declared on each emailTemplate, and the rest moved to `email: { unsubscribeUrl, preferencesUrl, tracking }`");
 	const email = config.email;
 	if (email !== void 0) {
-		if (email.unsubscribeUrl !== void 0) assertUnsubscribeUrl(email.unsubscribeUrl, "email.unsubscribeUrl");
+		if (email.unsubscribeUrl !== void 0) assertHttpUrl(email.unsubscribeUrl, "email.unsubscribeUrl");
+		if (email.preferencesUrl !== void 0) {
+			assertHttpUrl(email.preferencesUrl, "email.preferencesUrl");
+			if (isUnsubscribeLink(email.preferencesUrl, email.unsubscribeUrl)) throw new TypeError("email.preferencesUrl must not share its origin and path with email.unsubscribeUrl: the sender would track the preferences link as the unsubscribe link");
+		}
 		const quick = email.tracking?.quickClickMs;
 		if (quick !== void 0 && !(typeof quick === "number" && Number.isFinite(quick) && quick >= 0)) throw new TypeError("email.tracking.quickClickMs must be a non-negative number");
 	}
-	for (const template of templates) assertEmailMetadata(template, `email template '${template.id}'`);
+	for (const template of templates) {
+		const where = `email template '${template.id}'`;
+		assertEmailMetadata(template, where, true);
+		if (email?.preferencesUrl !== void 0 && isUnsubscribeLink(email.preferencesUrl, template.unsubscribeUrl)) throw new TypeError(`${where}: its unsubscribeUrl shares its origin and path with email.preferencesUrl, so the sender would track the preferences link as the unsubscribe link`);
+	}
 }
-/** A template's own `from` / `replyTo` / `unsubscribeUrl`, as `emailTemplate` checks them. */
-function assertEmailMetadata(template, where) {
+/**
+* A template's own `from` / `replyTo` / `unsubscribeUrl` and what it is (`topic` or
+* `transactional: true`), as `emailTemplate` checks them — and `compileConfig` again, for a
+* definition that did not come through `emailTemplate`. A declared template carries `topic`
+* (a string, or null for transactional); a definition carries one of the two options.
+*/
+function assertEmailMetadata(template, where, declared = false) {
 	assertEmailAddress(template.from, `${where}: from`);
 	if (template.replyTo !== void 0) assertEmailAddress(template.replyTo, `${where}: replyTo`);
-	if (template.unsubscribeUrl !== void 0) assertUnsubscribeUrl(template.unsubscribeUrl, `${where}: unsubscribeUrl`);
+	if (template.unsubscribeUrl !== void 0) assertHttpUrl(template.unsubscribeUrl, `${where}: unsubscribeUrl`);
+	if (assertTemplateTopic(template, where, "email", declared) && template.unsubscribeUrl !== void 0) throw new TypeError(`${where}: a transactional email has no unsubscribe link, so it takes no 'unsubscribeUrl'`);
+}
+/**
+* What a template is — `topic: <id>` or `transactional: true`, one of the two — as `emailTemplate`
+* and `pushTemplate` check their argument and `compileConfig` checks a declared template (where
+* `topic: null` is transactional). Answers whether the template is transactional. Whether the
+* topic is one the contract declares is `compileConfig`'s check, where the contract is at hand.
+*/
+function assertTemplateTopic(template, where, channel, declared = false) {
+	const { topic } = template;
+	const transactional = template.transactional === true || declared && topic === null;
+	if (template.transactional !== void 0 && template.transactional !== true) throw new TypeError(`${where}: 'transactional' must be the literal true (leave it out for a topic ${channel})`);
+	const hasTopic = topic !== void 0 && topic !== null;
+	if (hasTopic && (typeof topic !== "string" || topic.trim() === "")) throw new TypeError(`${where}: 'topic' must be a topic id the contract declares`);
+	if (hasTopic && transactional) throw new TypeError(`${where}: give either 'topic' or 'transactional: true', not both`);
+	if (!hasTopic && !transactional) throw new TypeError(`${where}: every ${channel} template says what it is — 'topic: <id>' (one the contract's subscriptions.topics declares) or 'transactional: true'`);
+	return transactional;
 }
 /** The unsubscribe link may carry its own query (a token, a list): the path names it. */
 function isUnsubscribeLink(url, unsubscribeUrl) {
@@ -80,13 +131,17 @@ function isUnsubscribeLink(url, unsubscribeUrl) {
 		return false;
 	}
 }
+exports.PREVIEW_MESSAGE_ID = PREVIEW_MESSAGE_ID;
 exports.assertEmailAddress = assertEmailAddress;
 exports.assertEmailConfig = assertEmailConfig;
 exports.assertEmailMetadata = assertEmailMetadata;
+exports.assertHttpUrl = assertHttpUrl;
+exports.assertTemplateTopic = assertTemplateTopic;
 exports.assertUnsubscribeUrl = assertUnsubscribeUrl;
 exports.formatEmailAddress = formatEmailAddress;
 exports.isUnsubscribeLink = isUnsubscribeLink;
 exports.mimeAddress = mimeAddress;
+exports.preferencesLink = preferencesLink;
 exports.resolveEmail = resolveEmail;
 
 //# sourceMappingURL=email.cjs.map

package/dist/email.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"email.cjs","names":[],"sources":["../src/email.ts"],"sourcesContent":["import type { EmailTemplate } from './templates';\n\n/**\n * Email metadata: who a template's email comes from, where replies go, and the unsubscribe link\n * its layout carries. Each `emailTemplate` declares its own `from` (and `replyTo`, if replies should\n * go elsewhere); the unsubscribe link is the template's `unsubscribeUrl`, else the config's\n * `email.unsubscribeUrl`, else none. `resolveEmail` is that rule, and the sender, the renderer,\n * the Worker's preview and the studio all go through it. No React and no I/O here, so a browser\n * can import it.\n */\n\n/** An address as the transports take it: bare, or with a display name. */\nexport type EmailAddress = string | { email: string; name?: string };\n\n/** `Name <email>`, or the bare address. */\nexport function formatEmailAddress(address: EmailAddress): string {\n  if (typeof address === 'string') return address;\n  return address.name === undefined ? address.email : `${address.name} <${address.email}>`;\n}\n\nconst ASCII = /^[\\x20-\\x7e]*$/;\nconst SPECIALS = /[()<>[\\]:;@\\\\,.\"]/;\n\n/**\n * An address as a mail API reads it (RFC 5322): a display name with specials is quoted, one\n * outside ASCII is a MIME encoded-word — raw non-ASCII names are refused (SES), and an unquoted\n * comma splits the address in two.\n */\nexport function mimeAddress(address: EmailAddress): string {\n  if (typeof address === 'string') return address;\n  const { email, name } = address;\n  if (name === undefined || name === '') return email;\n  if (!ASCII.test(name)) {\n    const bytes = new TextEncoder().encode(name);\n    let binary = '';\n    for (const byte of bytes) binary += String.fromCharCode(byte);\n    return `=?UTF-8?B?${btoa(binary)}?= <${email}>`;\n  }\n  if (SPECIALS.test(name)) return `\"${name.replace(/([\"\\\\])/g, '\\\\$1')}\" <${email}>`;\n  return `${name} <${email}>`;\n}\n\n/** The config's `email`: what every email template shares. */\nexport interface EmailConfig {\n  /**\n   * The unsubscribe link of every email template that names none of its own. The layout reads it\n   * with `useEmailContext()`; sent, it is tracked like every link, but following it shows a\n   * confirmation page, and only the confirmation (a POST no link scanner sends) unsubscribes.\n   */\n  unsubscribeUrl?: string;\n  /** How the Worker tells a person's opens and clicks from a machine's (see the reporting classifier). */\n  tracking?: {\n    /**\n     * An open or click this many milliseconds after delivery is a weak machine signal — machine\n     * only together with another (a second link within seconds); 1000 by default. A person\n     * tapping a mail notification can click within a few seconds, so keep it short.\n     */\n    quickClickMs?: number;\n  };\n}\n\n/** One template's email metadata, resolved against the config. */\nexport interface ResolvedEmail {\n  from: EmailAddress;\n  /** Absent when the template names none: the email goes out without a Reply-To. */\n  replyTo?: EmailAddress;\n  /** Absent when neither the template nor the config names one: the email has no unsubscribe link. */\n  unsubscribeUrl?: string;\n}\n\n/** The template's metadata, its `unsubscribeUrl` falling back to the config's. Leaves both untouched. */\nexport function resolveEmail(\n  template: Pick<EmailTemplate, 'from' | 'replyTo' | 'unsubscribeUrl'>,\n  config?: EmailConfig\n): ResolvedEmail {\n  const unsubscribeUrl = template.unsubscribeUrl ?? config?.unsubscribeUrl;\n  return {\n    from: template.from,\n    ...(template.replyTo === undefined ? {} : { replyTo: template.replyTo }),\n    ...(unsubscribeUrl === undefined ? {} : { unsubscribeUrl }),\n  };\n}\n\nconst ADDRESS = /^[^\\s@<>]+@[^\\s@<>]+$/;\n\n/** Throws naming `where` when `address` is neither `user@host` nor `{ email: 'user@host', name? }`. */\nexport function assertEmailAddress(address: unknown, where: string): void {\n  const email =\n    typeof address === 'object' && address !== null\n      ? (address as { email?: unknown }).email\n      : address;\n  const name =\n    typeof address === 'object' && address !== null\n      ? (address as { name?: unknown }).name\n      : undefined;\n  if (typeof email !== 'string' || !ADDRESS.test(email)) {\n    throw new TypeError(`${where} must be an email address or { email, name? }`);\n  }\n  if (name !== undefined && typeof name !== 'string') {\n    throw new TypeError(`${where}.name must be a string`);\n  }\n}\n\n/** Throws naming `where` unless `url` is an absolute http(s) URL; '' and null are not a way to leave it out. */\nexport function assertUnsubscribeUrl(url: unknown, where: string): void {\n  let parsed: URL | undefined;\n  try {\n    parsed = typeof url === 'string' ? new URL(url) : undefined;\n  } catch {\n    parsed = undefined;\n  }\n  if (parsed === undefined || (parsed.protocol !== 'https:' && parsed.protocol !== 'http:')) {\n    throw new TypeError(`${where} must be an http(s) URL (leave it out for none)`);\n  }\n}\n\n/** The config's `email` and every registered template's metadata; throws on the first invalid value. */\nexport function assertEmailConfig(\n  config: { email?: EmailConfig },\n  templates: Iterable<EmailTemplate>\n): void {\n  if (Object.hasOwn(config, 'emails')) {\n    throw new TypeError(\n      \"the config's `emails` is gone: `from` and `replyTo` are declared on each emailTemplate, \" +\n        'and the rest moved to `email: { unsubscribeUrl, tracking }`'\n    );\n  }\n  const email = config.email;\n  if (email !== undefined) {\n    if (email.unsubscribeUrl !== undefined) {\n      assertUnsubscribeUrl(email.unsubscribeUrl, 'email.unsubscribeUrl');\n    }\n    const quick = email.tracking?.quickClickMs;\n    if (\n      quick !== undefined &&\n      !(typeof quick === 'number' && Number.isFinite(quick) && quick >= 0)\n    ) {\n      throw new TypeError('email.tracking.quickClickMs must be a non-negative number');\n    }\n  }\n  for (const template of templates)\n    assertEmailMetadata(template, `email template '${template.id}'`);\n}\n\n/** A template's own `from` / `replyTo` / `unsubscribeUrl`, as `emailTemplate` checks them. */\nexport function assertEmailMetadata(\n  template: { from?: unknown; replyTo?: unknown; unsubscribeUrl?: unknown },\n  where: string\n): void {\n  assertEmailAddress(template.from, `${where}: from`);\n  if (template.replyTo !== undefined) assertEmailAddress(template.replyTo, `${where}: replyTo`);\n  if (template.unsubscribeUrl !== undefined) {\n    assertUnsubscribeUrl(template.unsubscribeUrl, `${where}: unsubscribeUrl`);\n  }\n}\n\n/** The unsubscribe link may carry its own query (a token, a list): the path names it. */\nexport function isUnsubscribeLink(url: string, unsubscribeUrl: string | undefined): boolean {\n  if (unsubscribeUrl === undefined) return false;\n  try {\n    const a = new URL(url);\n    const b = new URL(unsubscribeUrl);\n    return a.origin === b.origin && a.pathname === b.pathname;\n  } catch {\n    return false;\n  }\n}\n"],"mappings":";;;AAeA,SAAgB,mBAAmB,SAA+B;CAChE,IAAI,OAAO,YAAY,UAAU,OAAO;CACxC,OAAO,QAAQ,SAAS,KAAA,IAAY,QAAQ,QAAQ,GAAG,QAAQ,KAAK,IAAI,QAAQ,MAAM;AACxF;AAEA,MAAM,QAAQ;AACd,MAAM,WAAW;;;;;;AAOjB,SAAgB,YAAY,SAA+B;CACzD,IAAI,OAAO,YAAY,UAAU,OAAO;CACxC,MAAM,EAAE,OAAO,SAAS;CACxB,IAAI,SAAS,KAAA,KAAa,SAAS,IAAI,OAAO;CAC9C,IAAI,CAAC,MAAM,KAAK,IAAI,GAAG;EACrB,MAAM,QAAQ,IAAI,YAAY,CAAC,CAAC,OAAO,IAAI;EAC3C,IAAI,SAAS;EACb,KAAK,MAAM,QAAQ,OAAO,UAAU,OAAO,aAAa,IAAI;EAC5D,OAAO,aAAa,KAAK,MAAM,EAAE,MAAM,MAAM;CAC/C;CACA,IAAI,SAAS,KAAK,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,YAAY,MAAM,EAAE,KAAK,MAAM;CAChF,OAAO,GAAG,KAAK,IAAI,MAAM;AAC3B;;AA+BA,SAAgB,aACd,UACA,QACe;CACf,MAAM,iBAAiB,SAAS,kBAAkB,QAAQ;CAC1D,OAAO;EACL,MAAM,SAAS;EACf,GAAI,SAAS,YAAY,KAAA,IAAY,CAAC,IAAI,EAAE,SAAS,SAAS,QAAQ;EACtE,GAAI,mBAAmB,KAAA,IAAY,CAAC,IAAI,EAAE,eAAe;CAC3D;AACF;AAEA,MAAM,UAAU;;AAGhB,SAAgB,mBAAmB,SAAkB,OAAqB;CACxE,MAAM,QACJ,OAAO,YAAY,YAAY,YAAY,OACtC,QAAgC,QACjC;CACN,MAAM,OACJ,OAAO,YAAY,YAAY,YAAY,OACtC,QAA+B,OAChC,KAAA;CACN,IAAI,OAAO,UAAU,YAAY,CAAC,QAAQ,KAAK,KAAK,GAClD,MAAM,IAAI,UAAU,GAAG,MAAM,8CAA8C;CAE7E,IAAI,SAAS,KAAA,KAAa,OAAO,SAAS,UACxC,MAAM,IAAI,UAAU,GAAG,MAAM,uBAAuB;AAExD;;AAGA,SAAgB,qBAAqB,KAAc,OAAqB;CACtE,IAAI;CACJ,IAAI;EACF,SAAS,OAAO,QAAQ,WAAW,IAAI,IAAI,GAAG,IAAI,KAAA;CACpD,QAAQ;EACN,SAAS,KAAA;CACX;CACA,IAAI,WAAW,KAAA,KAAc,OAAO,aAAa,YAAY,OAAO,aAAa,SAC/E,MAAM,IAAI,UAAU,GAAG,MAAM,gDAAgD;AAEjF;;AAGA,SAAgB,kBACd,QACA,WACM;CACN,IAAI,OAAO,OAAO,QAAQ,QAAQ,GAChC,MAAM,IAAI,UACR,qJAEF;CAEF,MAAM,QAAQ,OAAO;CACrB,IAAI,UAAU,KAAA,GAAW;EACvB,IAAI,MAAM,mBAAmB,KAAA,GAC3B,qBAAqB,MAAM,gBAAgB,sBAAsB;EAEnE,MAAM,QAAQ,MAAM,UAAU;EAC9B,IACE,UAAU,KAAA,KACV,EAAE,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,KAAK,SAAS,IAElE,MAAM,IAAI,UAAU,2DAA2D;CAEnF;CACA,KAAK,MAAM,YAAY,WACrB,oBAAoB,UAAU,mBAAmB,SAAS,GAAG,EAAE;AACnE;;AAGA,SAAgB,oBACd,UACA,OACM;CACN,mBAAmB,SAAS,MAAM,GAAG,MAAM,OAAO;CAClD,IAAI,SAAS,YAAY,KAAA,GAAW,mBAAmB,SAAS,SAAS,GAAG,MAAM,UAAU;CAC5F,IAAI,SAAS,mBAAmB,KAAA,GAC9B,qBAAqB,SAAS,gBAAgB,GAAG,MAAM,iBAAiB;AAE5E;;AAGA,SAAgB,kBAAkB,KAAa,gBAA6C;CAC1F,IAAI,mBAAmB,KAAA,GAAW,OAAO;CACzC,IAAI;EACF,MAAM,IAAI,IAAI,IAAI,GAAG;EACrB,MAAM,IAAI,IAAI,IAAI,cAAc;EAChC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE;CACnD,QAAQ;EACN,OAAO;CACT;AACF"}
+{"version":3,"file":"email.cjs","names":[],"sources":["../src/email.ts"],"sourcesContent":["import type { EmailTemplate } from './templates';\n\n/**\n * Email metadata: who a template's email comes from, where replies go, and the unsubscribe and\n * preference links its layout carries. Each `emailTemplate` declares its own `from` (and\n * `replyTo`, if replies should go elsewhere) and says what it is: a `topic` the recipient may\n * unsubscribe from, or `transactional: true`. A topic email's unsubscribe link is the template's\n * `unsubscribeUrl`, else the config's `email.unsubscribeUrl`, else none; its preferences link is\n * the config's `email.preferencesUrl` with the copy's message id, when the copy has one (reporting\n * on); a transactional email never has either, whatever the config says. `resolveEmail` is that\n * rule, and the sender, the renderer, the Worker's preview and the studio all go through it. No\n * React and no I/O here, so a browser can import it.\n */\n\n/** An address as the transports take it: bare, or with a display name. */\nexport type EmailAddress = string | { email: string; name?: string };\n\n/** `Name <email>`, or the bare address. */\nexport function formatEmailAddress(address: EmailAddress): string {\n  if (typeof address === 'string') return address;\n  return address.name === undefined ? address.email : `${address.name} <${address.email}>`;\n}\n\nconst ASCII = /^[\\x20-\\x7e]*$/;\nconst SPECIALS = /[()<>[\\]:;@\\\\,.\"]/;\n\n/**\n * An address as a mail API reads it (RFC 5322): a display name with specials is quoted, one\n * outside ASCII is a MIME encoded-word — raw non-ASCII names are refused (SES), and an unquoted\n * comma splits the address in two.\n */\nexport function mimeAddress(address: EmailAddress): string {\n  if (typeof address === 'string') return address;\n  const { email, name } = address;\n  if (name === undefined || name === '') return email;\n  if (!ASCII.test(name)) {\n    const bytes = new TextEncoder().encode(name);\n    let binary = '';\n    for (const byte of bytes) binary += String.fromCharCode(byte);\n    return `=?UTF-8?B?${btoa(binary)}?= <${email}>`;\n  }\n  if (SPECIALS.test(name)) return `\"${name.replace(/([\"\\\\])/g, '\\\\$1')}\" <${email}>`;\n  return `${name} <${email}>`;\n}\n\n/** The config's `email`: what every email template shares. */\nexport interface EmailConfig {\n  /**\n   * The unsubscribe link of every email template that names none of its own. The layout reads it\n   * with `useEmailContext()`; sent, it is tracked like every link, but following it shows a\n   * confirmation page, and only the confirmation (a POST no link scanner sends) unsubscribes.\n   */\n  unsubscribeUrl?: string;\n  /**\n   * The app's email preference page. A topic email sent with reporting on links to it with the\n   * copy's message id as the `m` query parameter (`useEmailContext().preferencesUrl`), and the\n   * page reads and sets the recipient's subscriptions by that id — no sign-in — through\n   * `GET` / `PUT /subscriptions/by-message/:messageId` (`JourneyClient.getSubscriptionsByMessage`\n   * / `setSubscriptionsByMessage`). Tracked as an ordinary link; it must not share its origin and\n   * path with `unsubscribeUrl`, which would make it the unsubscribe link instead.\n   */\n  preferencesUrl?: string;\n  /** How the Worker tells a person's opens and clicks from a machine's (see the reporting classifier). */\n  tracking?: {\n    /**\n     * An open or click this many milliseconds after delivery is a weak machine signal — machine\n     * only together with another (a second link within seconds); 1000 by default. A person\n     * tapping a mail notification can click within a few seconds, so keep it short.\n     */\n    quickClickMs?: number;\n  };\n}\n\n/** One template's email metadata, resolved against the config. */\nexport interface ResolvedEmail {\n  from: EmailAddress;\n  /** The template's subscription topic; null for a transactional email. */\n  topic: string | null;\n  /** Absent when the template names none: the email goes out without a Reply-To. */\n  replyTo?: EmailAddress;\n  /**\n   * Absent when the email is transactional, or neither the template nor the config names one:\n   * the email has no unsubscribe link.\n   */\n  unsubscribeUrl?: string;\n  /**\n   * The config's `preferencesUrl` with this copy's message id as `m`. Absent when the email is\n   * transactional, the config names no page, or the copy has no message id (reporting off): the\n   * email has no preferences link, and a layout renders none.\n   */\n  preferencesUrl?: string;\n}\n\n/** What a render knows of the copy beyond the template: its message id, when reporting records one. */\nexport interface EmailRenderOptions {\n  /** The copy's id in the reporting tables — what `/t/...` and `/subscriptions/by-message` key on. */\n  messageId?: string | undefined;\n}\n\n/**\n * The message id a preview renders with: the preferences link shows in the studio and\n * `GET /preview`, pointing at a copy that does not exist.\n */\nexport const PREVIEW_MESSAGE_ID = '00000000-0000-0000-0000-000000000000';\n\n/**\n * The template's metadata, its `unsubscribeUrl` falling back to the config's, and the\n * preferences link built from the config's page and the copy's message id — for a topic email; a\n * transactional one resolves to neither link. Leaves the inputs untouched.\n */\nexport function resolveEmail(\n  template: Pick<EmailTemplate, 'from' | 'replyTo' | 'unsubscribeUrl' | 'topic'>,\n  config?: EmailConfig,\n  options: EmailRenderOptions = {}\n): ResolvedEmail {\n  const topical = template.topic !== null;\n  const unsubscribeUrl = topical ? (template.unsubscribeUrl ?? config?.unsubscribeUrl) : undefined;\n  const preferencesUrl =\n    topical && config?.preferencesUrl !== undefined && options.messageId !== undefined\n      ? preferencesLink(config.preferencesUrl, options.messageId)\n      : undefined;\n  return {\n    from: template.from,\n    topic: template.topic,\n    ...(template.replyTo === undefined ? {} : { replyTo: template.replyTo }),\n    ...(unsubscribeUrl === undefined ? {} : { unsubscribeUrl }),\n    ...(preferencesUrl === undefined ? {} : { preferencesUrl }),\n  };\n}\n\n/** The preference page's URL for one copy: `m=<message id>` set on its query, the rest of it kept. */\nexport function preferencesLink(preferencesUrl: string, messageId: string): string {\n  const url = new URL(preferencesUrl);\n  url.searchParams.set('m', messageId);\n  return url.toString();\n}\n\nconst ADDRESS = /^[^\\s@<>]+@[^\\s@<>]+$/;\n\n/** Throws naming `where` when `address` is neither `user@host` nor `{ email: 'user@host', name? }`. */\nexport function assertEmailAddress(address: unknown, where: string): void {\n  const email =\n    typeof address === 'object' && address !== null\n      ? (address as { email?: unknown }).email\n      : address;\n  const name =\n    typeof address === 'object' && address !== null\n      ? (address as { name?: unknown }).name\n      : undefined;\n  if (typeof email !== 'string' || !ADDRESS.test(email)) {\n    throw new TypeError(`${where} must be an email address or { email, name? }`);\n  }\n  if (name !== undefined && typeof name !== 'string') {\n    throw new TypeError(`${where}.name must be a string`);\n  }\n}\n\n/** Throws naming `where` unless `url` is an absolute http(s) URL; '' and null are not a way to leave it out. */\nexport function assertHttpUrl(url: unknown, where: string): void {\n  let parsed: URL | undefined;\n  try {\n    parsed = typeof url === 'string' ? new URL(url) : undefined;\n  } catch {\n    parsed = undefined;\n  }\n  if (parsed === undefined || (parsed.protocol !== 'https:' && parsed.protocol !== 'http:')) {\n    throw new TypeError(`${where} must be an http(s) URL (leave it out for none)`);\n  }\n}\n\n/** `assertHttpUrl`, under its earlier name. */\nexport const assertUnsubscribeUrl: typeof assertHttpUrl = assertHttpUrl;\n\n/** The config's `email` and every registered template's metadata; throws on the first invalid value. */\nexport function assertEmailConfig(\n  config: { email?: EmailConfig },\n  templates: Iterable<EmailTemplate>\n): void {\n  if (Object.hasOwn(config, 'emails')) {\n    throw new TypeError(\n      \"the config's `emails` is gone: `from` and `replyTo` are declared on each emailTemplate, \" +\n        'and the rest moved to `email: { unsubscribeUrl, preferencesUrl, tracking }`'\n    );\n  }\n  const email = config.email;\n  if (email !== undefined) {\n    if (email.unsubscribeUrl !== undefined) {\n      assertHttpUrl(email.unsubscribeUrl, 'email.unsubscribeUrl');\n    }\n    if (email.preferencesUrl !== undefined) {\n      assertHttpUrl(email.preferencesUrl, 'email.preferencesUrl');\n      // The sender tells the unsubscribe link from the others by origin and path: a preference\n      // page at the same address would be tracked as the unsubscribe link and land on `/t/u`\n      if (isUnsubscribeLink(email.preferencesUrl, email.unsubscribeUrl)) {\n        throw new TypeError(\n          'email.preferencesUrl must not share its origin and path with email.unsubscribeUrl: ' +\n            'the sender would track the preferences link as the unsubscribe link'\n        );\n      }\n    }\n    const quick = email.tracking?.quickClickMs;\n    if (\n      quick !== undefined &&\n      !(typeof quick === 'number' && Number.isFinite(quick) && quick >= 0)\n    ) {\n      throw new TypeError('email.tracking.quickClickMs must be a non-negative number');\n    }\n  }\n  for (const template of templates) {\n    const where = `email template '${template.id}'`;\n    assertEmailMetadata(template, where, true);\n    if (\n      email?.preferencesUrl !== undefined &&\n      isUnsubscribeLink(email.preferencesUrl, template.unsubscribeUrl)\n    ) {\n      throw new TypeError(\n        `${where}: its unsubscribeUrl shares its origin and path with email.preferencesUrl, so ` +\n          'the sender would track the preferences link as the unsubscribe link'\n      );\n    }\n  }\n}\n\n/**\n * A template's own `from` / `replyTo` / `unsubscribeUrl` and what it is (`topic` or\n * `transactional: true`), as `emailTemplate` checks them — and `compileConfig` again, for a\n * definition that did not come through `emailTemplate`. A declared template carries `topic`\n * (a string, or null for transactional); a definition carries one of the two options.\n */\nexport function assertEmailMetadata(\n  template: {\n    from?: unknown;\n    replyTo?: unknown;\n    unsubscribeUrl?: unknown;\n    topic?: unknown;\n    transactional?: unknown;\n  },\n  where: string,\n  /** True for a declared template (`topic: string | null`), false for `emailTemplate`'s argument. */\n  declared = false\n): void {\n  assertEmailAddress(template.from, `${where}: from`);\n  if (template.replyTo !== undefined) assertEmailAddress(template.replyTo, `${where}: replyTo`);\n  if (template.unsubscribeUrl !== undefined) {\n    assertHttpUrl(template.unsubscribeUrl, `${where}: unsubscribeUrl`);\n  }\n  const transactional = assertTemplateTopic(template, where, 'email', declared);\n  if (transactional && template.unsubscribeUrl !== undefined) {\n    throw new TypeError(\n      `${where}: a transactional email has no unsubscribe link, so it takes no 'unsubscribeUrl'`\n    );\n  }\n}\n\n/**\n * What a template is — `topic: <id>` or `transactional: true`, one of the two — as `emailTemplate`\n * and `pushTemplate` check their argument and `compileConfig` checks a declared template (where\n * `topic: null` is transactional). Answers whether the template is transactional. Whether the\n * topic is one the contract declares is `compileConfig`'s check, where the contract is at hand.\n */\nexport function assertTemplateTopic(\n  template: { topic?: unknown; transactional?: unknown },\n  where: string,\n  channel: 'email' | 'push',\n  declared = false\n): boolean {\n  const { topic } = template;\n  // A declared template says `topic: null` for transactional; a definition says `transactional: true`\n  const transactional = template.transactional === true || (declared && topic === null);\n  if (template.transactional !== undefined && template.transactional !== true) {\n    throw new TypeError(\n      `${where}: 'transactional' must be the literal true (leave it out for a topic ${channel})`\n    );\n  }\n  const hasTopic = topic !== undefined && topic !== null;\n  if (hasTopic && (typeof topic !== 'string' || topic.trim() === '')) {\n    throw new TypeError(`${where}: 'topic' must be a topic id the contract declares`);\n  }\n  if (hasTopic && transactional) {\n    throw new TypeError(`${where}: give either 'topic' or 'transactional: true', not both`);\n  }\n  if (!hasTopic && !transactional) {\n    throw new TypeError(\n      `${where}: every ${channel} template says what it is — 'topic: <id>' (one the contract's subscriptions.topics declares) or 'transactional: true'`\n    );\n  }\n  return transactional;\n}\n\n/** The unsubscribe link may carry its own query (a token, a list): the path names it. */\nexport function isUnsubscribeLink(url: string, unsubscribeUrl: string | undefined): boolean {\n  if (unsubscribeUrl === undefined) return false;\n  try {\n    const a = new URL(url);\n    const b = new URL(unsubscribeUrl);\n    return a.origin === b.origin && a.pathname === b.pathname;\n  } catch {\n    return false;\n  }\n}\n"],"mappings":";;;AAkBA,SAAgB,mBAAmB,SAA+B;CAChE,IAAI,OAAO,YAAY,UAAU,OAAO;CACxC,OAAO,QAAQ,SAAS,KAAA,IAAY,QAAQ,QAAQ,GAAG,QAAQ,KAAK,IAAI,QAAQ,MAAM;AACxF;AAEA,MAAM,QAAQ;AACd,MAAM,WAAW;;;;;;AAOjB,SAAgB,YAAY,SAA+B;CACzD,IAAI,OAAO,YAAY,UAAU,OAAO;CACxC,MAAM,EAAE,OAAO,SAAS;CACxB,IAAI,SAAS,KAAA,KAAa,SAAS,IAAI,OAAO;CAC9C,IAAI,CAAC,MAAM,KAAK,IAAI,GAAG;EACrB,MAAM,QAAQ,IAAI,YAAY,CAAC,CAAC,OAAO,IAAI;EAC3C,IAAI,SAAS;EACb,KAAK,MAAM,QAAQ,OAAO,UAAU,OAAO,aAAa,IAAI;EAC5D,OAAO,aAAa,KAAK,MAAM,EAAE,MAAM,MAAM;CAC/C;CACA,IAAI,SAAS,KAAK,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,YAAY,MAAM,EAAE,KAAK,MAAM;CAChF,OAAO,GAAG,KAAK,IAAI,MAAM;AAC3B;;;;;AA4DA,MAAa,qBAAqB;;;;;;AAOlC,SAAgB,aACd,UACA,QACA,UAA8B,CAAC,GAChB;CACf,MAAM,UAAU,SAAS,UAAU;CACnC,MAAM,iBAAiB,UAAW,SAAS,kBAAkB,QAAQ,iBAAkB,KAAA;CACvF,MAAM,iBACJ,WAAW,QAAQ,mBAAmB,KAAA,KAAa,QAAQ,cAAc,KAAA,IACrE,gBAAgB,OAAO,gBAAgB,QAAQ,SAAS,IACxD,KAAA;CACN,OAAO;EACL,MAAM,SAAS;EACf,OAAO,SAAS;EAChB,GAAI,SAAS,YAAY,KAAA,IAAY,CAAC,IAAI,EAAE,SAAS,SAAS,QAAQ;EACtE,GAAI,mBAAmB,KAAA,IAAY,CAAC,IAAI,EAAE,eAAe;EACzD,GAAI,mBAAmB,KAAA,IAAY,CAAC,IAAI,EAAE,eAAe;CAC3D;AACF;;AAGA,SAAgB,gBAAgB,gBAAwB,WAA2B;CACjF,MAAM,MAAM,IAAI,IAAI,cAAc;CAClC,IAAI,aAAa,IAAI,KAAK,SAAS;CACnC,OAAO,IAAI,SAAS;AACtB;AAEA,MAAM,UAAU;;AAGhB,SAAgB,mBAAmB,SAAkB,OAAqB;CACxE,MAAM,QACJ,OAAO,YAAY,YAAY,YAAY,OACtC,QAAgC,QACjC;CACN,MAAM,OACJ,OAAO,YAAY,YAAY,YAAY,OACtC,QAA+B,OAChC,KAAA;CACN,IAAI,OAAO,UAAU,YAAY,CAAC,QAAQ,KAAK,KAAK,GAClD,MAAM,IAAI,UAAU,GAAG,MAAM,8CAA8C;CAE7E,IAAI,SAAS,KAAA,KAAa,OAAO,SAAS,UACxC,MAAM,IAAI,UAAU,GAAG,MAAM,uBAAuB;AAExD;;AAGA,SAAgB,cAAc,KAAc,OAAqB;CAC/D,IAAI;CACJ,IAAI;EACF,SAAS,OAAO,QAAQ,WAAW,IAAI,IAAI,GAAG,IAAI,KAAA;CACpD,QAAQ;EACN,SAAS,KAAA;CACX;CACA,IAAI,WAAW,KAAA,KAAc,OAAO,aAAa,YAAY,OAAO,aAAa,SAC/E,MAAM,IAAI,UAAU,GAAG,MAAM,gDAAgD;AAEjF;;AAGA,MAAa,uBAA6C;;AAG1D,SAAgB,kBACd,QACA,WACM;CACN,IAAI,OAAO,OAAO,QAAQ,QAAQ,GAChC,MAAM,IAAI,UACR,qKAEF;CAEF,MAAM,QAAQ,OAAO;CACrB,IAAI,UAAU,KAAA,GAAW;EACvB,IAAI,MAAM,mBAAmB,KAAA,GAC3B,cAAc,MAAM,gBAAgB,sBAAsB;EAE5D,IAAI,MAAM,mBAAmB,KAAA,GAAW;GACtC,cAAc,MAAM,gBAAgB,sBAAsB;GAG1D,IAAI,kBAAkB,MAAM,gBAAgB,MAAM,cAAc,GAC9D,MAAM,IAAI,UACR,wJAEF;EAEJ;EACA,MAAM,QAAQ,MAAM,UAAU;EAC9B,IACE,UAAU,KAAA,KACV,EAAE,OAAO,UAAU,YAAY,OAAO,SAAS,KAAK,KAAK,SAAS,IAElE,MAAM,IAAI,UAAU,2DAA2D;CAEnF;CACA,KAAK,MAAM,YAAY,WAAW;EAChC,MAAM,QAAQ,mBAAmB,SAAS,GAAG;EAC7C,oBAAoB,UAAU,OAAO,IAAI;EACzC,IACE,OAAO,mBAAmB,KAAA,KAC1B,kBAAkB,MAAM,gBAAgB,SAAS,cAAc,GAE/D,MAAM,IAAI,UACR,GAAG,MAAM,kJAEX;CAEJ;AACF;;;;;;;AAQA,SAAgB,oBACd,UAOA,OAEA,WAAW,OACL;CACN,mBAAmB,SAAS,MAAM,GAAG,MAAM,OAAO;CAClD,IAAI,SAAS,YAAY,KAAA,GAAW,mBAAmB,SAAS,SAAS,GAAG,MAAM,UAAU;CAC5F,IAAI,SAAS,mBAAmB,KAAA,GAC9B,cAAc,SAAS,gBAAgB,GAAG,MAAM,iBAAiB;CAGnE,IADsB,oBAAoB,UAAU,OAAO,SAAS,QACpD,KAAK,SAAS,mBAAmB,KAAA,GAC/C,MAAM,IAAI,UACR,GAAG,MAAM,iFACX;AAEJ;;;;;;;AAQA,SAAgB,oBACd,UACA,OACA,SACA,WAAW,OACF;CACT,MAAM,EAAE,UAAU;CAElB,MAAM,gBAAgB,SAAS,kBAAkB,QAAS,YAAY,UAAU;CAChF,IAAI,SAAS,kBAAkB,KAAA,KAAa,SAAS,kBAAkB,MACrE,MAAM,IAAI,UACR,GAAG,MAAM,uEAAuE,QAAQ,EAC1F;CAEF,MAAM,WAAW,UAAU,KAAA,KAAa,UAAU;CAClD,IAAI,aAAa,OAAO,UAAU,YAAY,MAAM,KAAK,MAAM,KAC7D,MAAM,IAAI,UAAU,GAAG,MAAM,mDAAmD;CAElF,IAAI,YAAY,eACd,MAAM,IAAI,UAAU,GAAG,MAAM,yDAAyD;CAExF,IAAI,CAAC,YAAY,CAAC,eAChB,MAAM,IAAI,UACR,GAAG,MAAM,UAAU,QAAQ,sHAC7B;CAEF,OAAO;AACT;;AAGA,SAAgB,kBAAkB,KAAa,gBAA6C;CAC1F,IAAI,mBAAmB,KAAA,GAAW,OAAO;CACzC,IAAI;EACF,MAAM,IAAI,IAAI,IAAI,GAAG;EACrB,MAAM,IAAI,IAAI,IAAI,cAAc;EAChC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE;CACnD,QAAQ;EACN,OAAO;CACT;AACF"}

package/dist/email.d.cts

@@ -1,11 +1,14 @@
 import { EmailTemplate } from "./templates.cjs";
 /**
- * Email metadata: who a template's email comes from, where replies go, and the unsubscribe link
- * its layout carries. Each `emailTemplate` declares its own `from` (and `replyTo`, if replies should
- * go elsewhere); the unsubscribe link is the template's `unsubscribeUrl`, else the config's
- * `email.unsubscribeUrl`, else none. `resolveEmail` is that rule, and the sender, the renderer,
- * the Worker's preview and the studio all go through it. No React and no I/O here, so a browser
- * can import it.
+ * Email metadata: who a template's email comes from, where replies go, and the unsubscribe and
+ * preference links its layout carries. Each `emailTemplate` declares its own `from` (and
+ * `replyTo`, if replies should go elsewhere) and says what it is: a `topic` the recipient may
+ * unsubscribe from, or `transactional: true`. A topic email's unsubscribe link is the template's
+ * `unsubscribeUrl`, else the config's `email.unsubscribeUrl`, else none; its preferences link is
+ * the config's `email.preferencesUrl` with the copy's message id, when the copy has one (reporting
+ * on); a transactional email never has either, whatever the config says. `resolveEmail` is that
+ * rule, and the sender, the renderer, the Worker's preview and the studio all go through it. No
+ * React and no I/O here, so a browser can import it.
  */
 /** An address as the transports take it: bare, or with a display name. */
 export type EmailAddress = string | {
@@ -28,6 +31,15 @@ export interface EmailConfig {
    * confirmation page, and only the confirmation (a POST no link scanner sends) unsubscribes.
    */
   unsubscribeUrl?: string;
+  /**
+   * The app's email preference page. A topic email sent with reporting on links to it with the
+   * copy's message id as the `m` query parameter (`useEmailContext().preferencesUrl`), and the
+   * page reads and sets the recipient's subscriptions by that id — no sign-in — through
+   * `GET` / `PUT /subscriptions/by-message/:messageId` (`JourneyClient.getSubscriptionsByMessage`
+   * / `setSubscriptionsByMessage`). Tracked as an ordinary link; it must not share its origin and
+   * path with `unsubscribeUrl`, which would make it the unsubscribe link instead.
+   */
+  preferencesUrl?: string;
   /** How the Worker tells a person's opens and clicks from a machine's (see the reporting classifier). */
   tracking?: {
     /**
@@ -41,27 +53,75 @@ export interface EmailConfig {
 /** One template's email metadata, resolved against the config. */
 export interface ResolvedEmail {
   from: EmailAddress;
+  /** The template's subscription topic; null for a transactional email. */
+  topic: string | null;
   /** Absent when the template names none: the email goes out without a Reply-To. */
   replyTo?: EmailAddress;
-  /** Absent when neither the template nor the config names one: the email has no unsubscribe link. */
+  /**
+   * Absent when the email is transactional, or neither the template nor the config names one:
+   * the email has no unsubscribe link.
+   */
   unsubscribeUrl?: string;
+  /**
+   * The config's `preferencesUrl` with this copy's message id as `m`. Absent when the email is
+   * transactional, the config names no page, or the copy has no message id (reporting off): the
+   * email has no preferences link, and a layout renders none.
+   */
+  preferencesUrl?: string;
 }
-/** The template's metadata, its `unsubscribeUrl` falling back to the config's. Leaves both untouched. */
-export declare function resolveEmail(template: Pick<EmailTemplate, 'from' | 'replyTo' | 'unsubscribeUrl'>, config?: EmailConfig): ResolvedEmail;
+/** What a render knows of the copy beyond the template: its message id, when reporting records one. */
+export interface EmailRenderOptions {
+  /** The copy's id in the reporting tables — what `/t/...` and `/subscriptions/by-message` key on. */
+  messageId?: string | undefined;
+}
+/**
+ * The message id a preview renders with: the preferences link shows in the studio and
+ * `GET /preview`, pointing at a copy that does not exist.
+ */
+export declare const PREVIEW_MESSAGE_ID = "00000000-0000-0000-0000-000000000000";
+/**
+ * The template's metadata, its `unsubscribeUrl` falling back to the config's, and the
+ * preferences link built from the config's page and the copy's message id — for a topic email; a
+ * transactional one resolves to neither link. Leaves the inputs untouched.
+ */
+export declare function resolveEmail(template: Pick<EmailTemplate, 'from' | 'replyTo' | 'unsubscribeUrl' | 'topic'>, config?: EmailConfig, options?: EmailRenderOptions): ResolvedEmail;
+/** The preference page's URL for one copy: `m=<message id>` set on its query, the rest of it kept. */
+export declare function preferencesLink(preferencesUrl: string, messageId: string): string;
 /** Throws naming `where` when `address` is neither `user@host` nor `{ email: 'user@host', name? }`. */
 export declare function assertEmailAddress(address: unknown, where: string): void;
 /** Throws naming `where` unless `url` is an absolute http(s) URL; '' and null are not a way to leave it out. */
-export declare function assertUnsubscribeUrl(url: unknown, where: string): void;
+export declare function assertHttpUrl(url: unknown, where: string): void;
+/** `assertHttpUrl`, under its earlier name. */
+export declare const assertUnsubscribeUrl: typeof assertHttpUrl;
 /** The config's `email` and every registered template's metadata; throws on the first invalid value. */
 export declare function assertEmailConfig(config: {
   email?: EmailConfig;
 }, templates: Iterable<EmailTemplate>): void;
-/** A template's own `from` / `replyTo` / `unsubscribeUrl`, as `emailTemplate` checks them. */
+/**
+ * A template's own `from` / `replyTo` / `unsubscribeUrl` and what it is (`topic` or
+ * `transactional: true`), as `emailTemplate` checks them — and `compileConfig` again, for a
+ * definition that did not come through `emailTemplate`. A declared template carries `topic`
+ * (a string, or null for transactional); a definition carries one of the two options.
+ */
 export declare function assertEmailMetadata(template: {
   from?: unknown;
   replyTo?: unknown;
   unsubscribeUrl?: unknown;
-}, where: string): void;
+  topic?: unknown;
+  transactional?: unknown;
+}, where: string,
+/** True for a declared template (`topic: string | null`), false for `emailTemplate`'s argument. */
+declared?: boolean): void;
+/**
+ * What a template is — `topic: <id>` or `transactional: true`, one of the two — as `emailTemplate`
+ * and `pushTemplate` check their argument and `compileConfig` checks a declared template (where
+ * `topic: null` is transactional). Answers whether the template is transactional. Whether the
+ * topic is one the contract declares is `compileConfig`'s check, where the contract is at hand.
+ */
+export declare function assertTemplateTopic(template: {
+  topic?: unknown;
+  transactional?: unknown;
+}, where: string, channel: 'email' | 'push', declared?: boolean): boolean;
 /** The unsubscribe link may carry its own query (a token, a list): the path names it. */
 export declare function isUnsubscribeLink(url: string, unsubscribeUrl: string | undefined): boolean;
 //# sourceMappingURL=email.d.cts.map

package/dist/email.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"email.d.cts","names":[],"sources":["../src/email.ts"],"mappings":";;;;;;;;;;YAYY;EAA0B;EAAe;;;wBAGrC,mBAAmB,SAAS;;;;;;wBAa5B,YAAY,SAAS;;iBAepB;;;;;;EAMf;;EAEA;;;;;;IAME;;;;iBAKa;EACf,MAAM;;EAEN,UAAU;;EAEV;;;wBAIc,aACd,UAAU,KAAK,uDACf,SAAS,cACR;;wBAYa,mBAAmB,kBAAkB;;wBAkBrC,qBAAqB,cAAc;;wBAanC,kBACd;EAAU,QAAQ;GAClB,WAAW,SAAS;;wBA0BN,oBACd;EAAY;EAAgB;EAAmB;GAC/C;;wBAUc,kBAAkB,aAAa"}
+{"version":3,"file":"email.d.cts","names":[],"sources":["../src/email.ts"],"mappings":";;;;;;;;;;;;;YAeY;EAA0B;EAAe;;;wBAGrC,mBAAmB,SAAS;;;;;;wBAa5B,YAAY,SAAS;;iBAepB;;;;;;EAMf;;;;;;;;;EASA;;EAEA;;;;;;IAME;;;;iBAKa;EACf,MAAM;;EAEN;;EAEA,UAAU;;;;;EAKV;;;;;;EAMA;;;iBAIe;;EAEf;;;;;;qBAOW;;;;;;wBAOG,aACd,UAAU,KAAK,iEACf,SAAS,aACT,UAAS,qBACR;;wBAiBa,gBAAgB,wBAAwB;;wBASxC,mBAAmB,kBAAkB;;wBAkBrC,cAAc,cAAc;;qBAa/B,6BAA6B;;wBAG1B,kBACd;EAAU,QAAQ;GAClB,WAAW,SAAS;;;;;;;wBAqDN,oBACd;EACE;EACA;EACA;EACA;EACA;GAEF;;AAEA;;;;;;;wBAqBc,oBACd;EAAY;EAAiB;GAC7B,eACA,2BACA;;wBA0Bc,kBAAkB,aAAa"}

package/dist/email.d.mts

@@ -1,11 +1,14 @@
 import { EmailTemplate } from "./templates.mjs";
 /**
- * Email metadata: who a template's email comes from, where replies go, and the unsubscribe link
- * its layout carries. Each `emailTemplate` declares its own `from` (and `replyTo`, if replies should
- * go elsewhere); the unsubscribe link is the template's `unsubscribeUrl`, else the config's
- * `email.unsubscribeUrl`, else none. `resolveEmail` is that rule, and the sender, the renderer,
- * the Worker's preview and the studio all go through it. No React and no I/O here, so a browser
- * can import it.
+ * Email metadata: who a template's email comes from, where replies go, and the unsubscribe and
+ * preference links its layout carries. Each `emailTemplate` declares its own `from` (and
+ * `replyTo`, if replies should go elsewhere) and says what it is: a `topic` the recipient may
+ * unsubscribe from, or `transactional: true`. A topic email's unsubscribe link is the template's
+ * `unsubscribeUrl`, else the config's `email.unsubscribeUrl`, else none; its preferences link is
+ * the config's `email.preferencesUrl` with the copy's message id, when the copy has one (reporting
+ * on); a transactional email never has either, whatever the config says. `resolveEmail` is that
+ * rule, and the sender, the renderer, the Worker's preview and the studio all go through it. No
+ * React and no I/O here, so a browser can import it.
  */
 /** An address as the transports take it: bare, or with a display name. */
 export type EmailAddress = string | {
@@ -28,6 +31,15 @@ export interface EmailConfig {
    * confirmation page, and only the confirmation (a POST no link scanner sends) unsubscribes.
    */
   unsubscribeUrl?: string;
+  /**
+   * The app's email preference page. A topic email sent with reporting on links to it with the
+   * copy's message id as the `m` query parameter (`useEmailContext().preferencesUrl`), and the
+   * page reads and sets the recipient's subscriptions by that id — no sign-in — through
+   * `GET` / `PUT /subscriptions/by-message/:messageId` (`JourneyClient.getSubscriptionsByMessage`
+   * / `setSubscriptionsByMessage`). Tracked as an ordinary link; it must not share its origin and
+   * path with `unsubscribeUrl`, which would make it the unsubscribe link instead.
+   */
+  preferencesUrl?: string;
   /** How the Worker tells a person's opens and clicks from a machine's (see the reporting classifier). */
   tracking?: {
     /**
@@ -41,27 +53,75 @@ export interface EmailConfig {
 /** One template's email metadata, resolved against the config. */
 export interface ResolvedEmail {
   from: EmailAddress;
+  /** The template's subscription topic; null for a transactional email. */
+  topic: string | null;
   /** Absent when the template names none: the email goes out without a Reply-To. */
   replyTo?: EmailAddress;
-  /** Absent when neither the template nor the config names one: the email has no unsubscribe link. */
+  /**
+   * Absent when the email is transactional, or neither the template nor the config names one:
+   * the email has no unsubscribe link.
+   */
   unsubscribeUrl?: string;
+  /**
+   * The config's `preferencesUrl` with this copy's message id as `m`. Absent when the email is
+   * transactional, the config names no page, or the copy has no message id (reporting off): the
+   * email has no preferences link, and a layout renders none.
+   */
+  preferencesUrl?: string;
 }
-/** The template's metadata, its `unsubscribeUrl` falling back to the config's. Leaves both untouched. */
-export declare function resolveEmail(template: Pick<EmailTemplate, 'from' | 'replyTo' | 'unsubscribeUrl'>, config?: EmailConfig): ResolvedEmail;
+/** What a render knows of the copy beyond the template: its message id, when reporting records one. */
+export interface EmailRenderOptions {
+  /** The copy's id in the reporting tables — what `/t/...` and `/subscriptions/by-message` key on. */
+  messageId?: string | undefined;
+}
+/**
+ * The message id a preview renders with: the preferences link shows in the studio and
+ * `GET /preview`, pointing at a copy that does not exist.
+ */
+export declare const PREVIEW_MESSAGE_ID = "00000000-0000-0000-0000-000000000000";
+/**
+ * The template's metadata, its `unsubscribeUrl` falling back to the config's, and the
+ * preferences link built from the config's page and the copy's message id — for a topic email; a
+ * transactional one resolves to neither link. Leaves the inputs untouched.
+ */
+export declare function resolveEmail(template: Pick<EmailTemplate, 'from' | 'replyTo' | 'unsubscribeUrl' | 'topic'>, config?: EmailConfig, options?: EmailRenderOptions): ResolvedEmail;
+/** The preference page's URL for one copy: `m=<message id>` set on its query, the rest of it kept. */
+export declare function preferencesLink(preferencesUrl: string, messageId: string): string;
 /** Throws naming `where` when `address` is neither `user@host` nor `{ email: 'user@host', name? }`. */
 export declare function assertEmailAddress(address: unknown, where: string): void;
 /** Throws naming `where` unless `url` is an absolute http(s) URL; '' and null are not a way to leave it out. */
-export declare function assertUnsubscribeUrl(url: unknown, where: string): void;
+export declare function assertHttpUrl(url: unknown, where: string): void;
+/** `assertHttpUrl`, under its earlier name. */
+export declare const assertUnsubscribeUrl: typeof assertHttpUrl;
 /** The config's `email` and every registered template's metadata; throws on the first invalid value. */
 export declare function assertEmailConfig(config: {
   email?: EmailConfig;
 }, templates: Iterable<EmailTemplate>): void;
-/** A template's own `from` / `replyTo` / `unsubscribeUrl`, as `emailTemplate` checks them. */
+/**
+ * A template's own `from` / `replyTo` / `unsubscribeUrl` and what it is (`topic` or
+ * `transactional: true`), as `emailTemplate` checks them — and `compileConfig` again, for a
+ * definition that did not come through `emailTemplate`. A declared template carries `topic`
+ * (a string, or null for transactional); a definition carries one of the two options.
+ */
 export declare function assertEmailMetadata(template: {
   from?: unknown;
   replyTo?: unknown;
   unsubscribeUrl?: unknown;
-}, where: string): void;
+  topic?: unknown;
+  transactional?: unknown;
+}, where: string,
+/** True for a declared template (`topic: string | null`), false for `emailTemplate`'s argument. */
+declared?: boolean): void;
+/**
+ * What a template is — `topic: <id>` or `transactional: true`, one of the two — as `emailTemplate`
+ * and `pushTemplate` check their argument and `compileConfig` checks a declared template (where
+ * `topic: null` is transactional). Answers whether the template is transactional. Whether the
+ * topic is one the contract declares is `compileConfig`'s check, where the contract is at hand.
+ */
+export declare function assertTemplateTopic(template: {
+  topic?: unknown;
+  transactional?: unknown;
+}, where: string, channel: 'email' | 'push', declared?: boolean): boolean;
 /** The unsubscribe link may carry its own query (a token, a list): the path names it. */
 export declare function isUnsubscribeLink(url: string, unsubscribeUrl: string | undefined): boolean;
 //# sourceMappingURL=email.d.mts.map

package/dist/email.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"email.d.mts","names":[],"sources":["../src/email.ts"],"mappings":";;;;;;;;;;YAYY;EAA0B;EAAe;;;wBAGrC,mBAAmB,SAAS;;;;;;wBAa5B,YAAY,SAAS;;iBAepB;;;;;;EAMf;;EAEA;;;;;;IAME;;;;iBAKa;EACf,MAAM;;EAEN,UAAU;;EAEV;;;wBAIc,aACd,UAAU,KAAK,uDACf,SAAS,cACR;;wBAYa,mBAAmB,kBAAkB;;wBAkBrC,qBAAqB,cAAc;;wBAanC,kBACd;EAAU,QAAQ;GAClB,WAAW,SAAS;;wBA0BN,oBACd;EAAY;EAAgB;EAAmB;GAC/C;;wBAUc,kBAAkB,aAAa"}
+{"version":3,"file":"email.d.mts","names":[],"sources":["../src/email.ts"],"mappings":";;;;;;;;;;;;;YAeY;EAA0B;EAAe;;;wBAGrC,mBAAmB,SAAS;;;;;;wBAa5B,YAAY,SAAS;;iBAepB;;;;;;EAMf;;;;;;;;;EASA;;EAEA;;;;;;IAME;;;;iBAKa;EACf,MAAM;;EAEN;;EAEA,UAAU;;;;;EAKV;;;;;;EAMA;;;iBAIe;;EAEf;;;;;;qBAOW;;;;;;wBAOG,aACd,UAAU,KAAK,iEACf,SAAS,aACT,UAAS,qBACR;;wBAiBa,gBAAgB,wBAAwB;;wBASxC,mBAAmB,kBAAkB;;wBAkBrC,cAAc,cAAc;;qBAa/B,6BAA6B;;wBAG1B,kBACd;EAAU,QAAQ;GAClB,WAAW,SAAS;;;;;;;wBAqDN,oBACd;EACE;EACA;EACA;EACA;EACA;GAEF;;AAEA;;;;;;;wBAqBc,oBACd;EAAY;EAAiB;GAC7B,eACA,2BACA;;wBA0Bc,kBAAkB,aAAa"}

package/dist/email.mjs

@@ -24,15 +24,34 @@ function mimeAddress(address) {
 	if (SPECIALS.test(name)) return `"${name.replace(/(["\\])/g, "\\$1")}" <${email}>`;
 	return `${name} <${email}>`;
 }
-/** The template's metadata, its `unsubscribeUrl` falling back to the config's. Leaves both untouched. */
-function resolveEmail(template, config) {
-	const unsubscribeUrl = template.unsubscribeUrl ?? config?.unsubscribeUrl;
+/**
+* The message id a preview renders with: the preferences link shows in the studio and
+* `GET /preview`, pointing at a copy that does not exist.
+*/
+const PREVIEW_MESSAGE_ID = "00000000-0000-0000-0000-000000000000";
+/**
+* The template's metadata, its `unsubscribeUrl` falling back to the config's, and the
+* preferences link built from the config's page and the copy's message id — for a topic email; a
+* transactional one resolves to neither link. Leaves the inputs untouched.
+*/
+function resolveEmail(template, config, options = {}) {
+	const topical = template.topic !== null;
+	const unsubscribeUrl = topical ? template.unsubscribeUrl ?? config?.unsubscribeUrl : void 0;
+	const preferencesUrl = topical && config?.preferencesUrl !== void 0 && options.messageId !== void 0 ? preferencesLink(config.preferencesUrl, options.messageId) : void 0;
 	return {
 		from: template.from,
+		topic: template.topic,
 		...template.replyTo === void 0 ? {} : { replyTo: template.replyTo },
-		...unsubscribeUrl === void 0 ? {} : { unsubscribeUrl }
+		...unsubscribeUrl === void 0 ? {} : { unsubscribeUrl },
+		...preferencesUrl === void 0 ? {} : { preferencesUrl }
 	};
 }
+/** The preference page's URL for one copy: `m=<message id>` set on its query, the rest of it kept. */
+function preferencesLink(preferencesUrl, messageId) {
+	const url = new URL(preferencesUrl);
+	url.searchParams.set("m", messageId);
+	return url.toString();
+}
 const ADDRESS = /^[^\s@<>]+@[^\s@<>]+$/;
 /** Throws naming `where` when `address` is neither `user@host` nor `{ email: 'user@host', name? }`. */
 function assertEmailAddress(address, where) {
@@ -42,7 +61,7 @@ function assertEmailAddress(address, where) {
 	if (name !== void 0 && typeof name !== "string") throw new TypeError(`${where}.name must be a string`);
 }
 /** Throws naming `where` unless `url` is an absolute http(s) URL; '' and null are not a way to leave it out. */
-function assertUnsubscribeUrl(url, where) {
+function assertHttpUrl(url, where) {
 	let parsed;
 	try {
 		parsed = typeof url === "string" ? new URL(url) : void 0;
@@ -51,22 +70,54 @@ function assertUnsubscribeUrl(url, where) {
 	}
 	if (parsed === void 0 || parsed.protocol !== "https:" && parsed.protocol !== "http:") throw new TypeError(`${where} must be an http(s) URL (leave it out for none)`);
 }
+/** `assertHttpUrl`, under its earlier name. */
+const assertUnsubscribeUrl = assertHttpUrl;
 /** The config's `email` and every registered template's metadata; throws on the first invalid value. */
 function assertEmailConfig(config, templates) {
-	if (Object.hasOwn(config, "emails")) throw new TypeError("the config's `emails` is gone: `from` and `replyTo` are declared on each emailTemplate, and the rest moved to `email: { unsubscribeUrl, tracking }`");
+	if (Object.hasOwn(config, "emails")) throw new TypeError("the config's `emails` is gone: `from` and `replyTo` are declared on each emailTemplate, and the rest moved to `email: { unsubscribeUrl, preferencesUrl, tracking }`");
 	const email = config.email;
 	if (email !== void 0) {
-		if (email.unsubscribeUrl !== void 0) assertUnsubscribeUrl(email.unsubscribeUrl, "email.unsubscribeUrl");
+		if (email.unsubscribeUrl !== void 0) assertHttpUrl(email.unsubscribeUrl, "email.unsubscribeUrl");
+		if (email.preferencesUrl !== void 0) {
+			assertHttpUrl(email.preferencesUrl, "email.preferencesUrl");
+			if (isUnsubscribeLink(email.preferencesUrl, email.unsubscribeUrl)) throw new TypeError("email.preferencesUrl must not share its origin and path with email.unsubscribeUrl: the sender would track the preferences link as the unsubscribe link");
+		}
 		const quick = email.tracking?.quickClickMs;
 		if (quick !== void 0 && !(typeof quick === "number" && Number.isFinite(quick) && quick >= 0)) throw new TypeError("email.tracking.quickClickMs must be a non-negative number");
 	}
-	for (const template of templates) assertEmailMetadata(template, `email template '${template.id}'`);
+	for (const template of templates) {
+		const where = `email template '${template.id}'`;
+		assertEmailMetadata(template, where, true);
+		if (email?.preferencesUrl !== void 0 && isUnsubscribeLink(email.preferencesUrl, template.unsubscribeUrl)) throw new TypeError(`${where}: its unsubscribeUrl shares its origin and path with email.preferencesUrl, so the sender would track the preferences link as the unsubscribe link`);
+	}
 }
-/** A template's own `from` / `replyTo` / `unsubscribeUrl`, as `emailTemplate` checks them. */
-function assertEmailMetadata(template, where) {
+/**
+* A template's own `from` / `replyTo` / `unsubscribeUrl` and what it is (`topic` or
+* `transactional: true`), as `emailTemplate` checks them — and `compileConfig` again, for a
+* definition that did not come through `emailTemplate`. A declared template carries `topic`
+* (a string, or null for transactional); a definition carries one of the two options.
+*/
+function assertEmailMetadata(template, where, declared = false) {
 	assertEmailAddress(template.from, `${where}: from`);
 	if (template.replyTo !== void 0) assertEmailAddress(template.replyTo, `${where}: replyTo`);
-	if (template.unsubscribeUrl !== void 0) assertUnsubscribeUrl(template.unsubscribeUrl, `${where}: unsubscribeUrl`);
+	if (template.unsubscribeUrl !== void 0) assertHttpUrl(template.unsubscribeUrl, `${where}: unsubscribeUrl`);
+	if (assertTemplateTopic(template, where, "email", declared) && template.unsubscribeUrl !== void 0) throw new TypeError(`${where}: a transactional email has no unsubscribe link, so it takes no 'unsubscribeUrl'`);
+}
+/**
+* What a template is — `topic: <id>` or `transactional: true`, one of the two — as `emailTemplate`
+* and `pushTemplate` check their argument and `compileConfig` checks a declared template (where
+* `topic: null` is transactional). Answers whether the template is transactional. Whether the
+* topic is one the contract declares is `compileConfig`'s check, where the contract is at hand.
+*/
+function assertTemplateTopic(template, where, channel, declared = false) {
+	const { topic } = template;
+	const transactional = template.transactional === true || declared && topic === null;
+	if (template.transactional !== void 0 && template.transactional !== true) throw new TypeError(`${where}: 'transactional' must be the literal true (leave it out for a topic ${channel})`);
+	const hasTopic = topic !== void 0 && topic !== null;
+	if (hasTopic && (typeof topic !== "string" || topic.trim() === "")) throw new TypeError(`${where}: 'topic' must be a topic id the contract declares`);
+	if (hasTopic && transactional) throw new TypeError(`${where}: give either 'topic' or 'transactional: true', not both`);
+	if (!hasTopic && !transactional) throw new TypeError(`${where}: every ${channel} template says what it is — 'topic: <id>' (one the contract's subscriptions.topics declares) or 'transactional: true'`);
+	return transactional;
 }
 /** The unsubscribe link may carry its own query (a token, a list): the path names it. */
 function isUnsubscribeLink(url, unsubscribeUrl) {
@@ -79,6 +130,6 @@ function isUnsubscribeLink(url, unsubscribeUrl) {
 		return false;
 	}
 }
-export { assertEmailAddress, assertEmailConfig, assertEmailMetadata, assertUnsubscribeUrl, formatEmailAddress, isUnsubscribeLink, mimeAddress, resolveEmail };
+export { PREVIEW_MESSAGE_ID, assertEmailAddress, assertEmailConfig, assertEmailMetadata, assertHttpUrl, assertTemplateTopic, assertUnsubscribeUrl, formatEmailAddress, isUnsubscribeLink, mimeAddress, preferencesLink, resolveEmail };
 
 //# sourceMappingURL=email.mjs.map