@softure-ai/mailing 0.1.7 → 0.1.9

package/src/server/suppressions.ts

@@ -6,7 +6,7 @@
 import { err, ok, type ModuleContext, type Result } from "@softure-ai/core";
 import type { Queryable } from "@softure-ai/db";
 import { and, eq, inArray } from "drizzle-orm";
-import type { SuppressionSource, UnsubscribeErrorCode } from "../contract.js";
+import type { SuppressionSource, UnsubscribeErrorCode, VerifiedUnsubscribeLink } from "../contract.js";
 import { suppressions } from "../schema.js";
 import { getMailingOptions } from "./options.js";
 import { getRecipientKey, readUnsubscribeSecrets, verifyUnsubscribeToken, type Env, type UnsubscribeLink, type UnsubscribeToken } from "./unsubscribe-link.js";
@@ -67,26 +67,33 @@ export async function unsubscribe(
   source: Exclude<SuppressionSource, "operator">,
   env: Env = process.env,
 ): Promise<Result<undefined, UnsubscribeErrorCode>> {
-  const recipientKey = await verifyLink(ctx, link, env);
-  if (recipientKey === null) return err("mailing.invalid_link");
+  const verified = await verifyLink(ctx, link, env);
+  if (verified === null) return err("mailing.invalid_link");
+  const { recipientKey } = verified;
   const { onUnsubscribed } = getMailingOptions(ctx.config);
   await ctx.db.transaction(async (tx) => {
     const txCtx: SuppressionContext = { ...ctx, db: tx };
     await recordSuppression(txCtx, recipientKey, source);
-    await onUnsubscribed?.({ recipientKey, source }, txCtx);
+    await onUnsubscribed?.({ recipientKey, source, link: verified.link }, txCtx);
   });
   return ok();
 }
 
-/** The recipient key a link proves, or `null` when it proves none. */
-async function verifyLink(ctx: SuppressionContext, link: UnsubscribeLink | UnsubscribeToken | null, env: Env): Promise<string | null> {
+interface VerifiedLink {
+  readonly recipientKey: string;
+  readonly link: VerifiedUnsubscribeLink;
+}
+
+/** The recipient key a link proves and the link it came through, or `null` when it proves none. */
+async function verifyLink(ctx: SuppressionContext, link: UnsubscribeLink | UnsubscribeToken | null, env: Env): Promise<VerifiedLink | null> {
   if (link === null) return null;
   if (!("scheme" in link) || link.scheme === "signed") {
     const token = "scheme" in link ? link.token : link;
-    return verifyUnsubscribeToken(token, readUnsubscribeSecrets(env)) ? token.recipientKey : null;
+    return verifyUnsubscribeToken(token, readUnsubscribeSecrets(env)) ? { recipientKey: token.recipientKey, link: { scheme: "signed" } } : null;
   }
   const legacy = getMailingOptions(ctx.config).legacyUnsubscribe;
   if (legacy === undefined) return null;
   const address: unknown = await legacy.verify(link.values, ctx);
-  return typeof address === "string" && address.trim() !== "" ? getRecipientKey(address) : null;
+  if (typeof address !== "string" || address.trim() === "") return null;
+  return { recipientKey: getRecipientKey(address), link: { scheme: "legacy", values: link.values } };
 }

package/src/server/unsubscribe-link.ts

@@ -117,8 +117,9 @@ export interface LinkParams {
 /**
  * The link in a query or a form. A link with the recipient parameter (`r`) is a signed link, whatever else it
  * carries, so a crafted URL cannot route a signed link to the app's legacy check. Without it, and with
- * `mailing({ legacyUnsubscribe })`, a link that has every legacy parameter (non-empty, at most 512 characters) is
- * a legacy link. Anything else is `null`. Checks no signature: `unsubscribe` does.
+ * `mailing({ legacyUnsubscribe })`, a link that has every required legacy parameter (non-empty, at most 512
+ * characters) is a legacy link; its values also hold the optional parameters it has (an empty one is absent, one
+ * over 512 characters makes the link invalid). Anything else is `null`. Checks no signature: `unsubscribe` does.
  */
 export function readUnsubscribeLink(params: LinkParams, config: SoftureConfig): UnsubscribeLink | null {
   if (params.get(RECIPIENT_PARAM) !== null && params.get(RECIPIENT_PARAM) !== undefined) {
@@ -128,11 +129,17 @@ export function readUnsubscribeLink(params: LinkParams, config: SoftureConfig):
   const legacy = getMailingOptions(config).legacyUnsubscribe;
   if (legacy === undefined) return null;
   const values: Record<string, string> = {};
-  for (const name of legacy.params) {
+  for (const name of legacy.params.required) {
     const value = params.get(name);
     if (typeof value !== "string" || value === "" || value.length > MAX_LEGACY_VALUE_LENGTH) return null;
     values[name] = value;
   }
+  for (const name of legacy.params.optional) {
+    const value = params.get(name);
+    if (typeof value !== "string" || value === "") continue;
+    if (value.length > MAX_LEGACY_VALUE_LENGTH) return null;
+    values[name] = value;
+  }
   return { scheme: "legacy", values };
 }