@krizaka/mail 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# @krizaka/mail
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Mail for every Krizaka product: queued in the caller's transaction through `@krizaka/outbox`, delivered once per idempotency key, never to a suppressed address, with the provider the admin chose. No vendor SDK, no environment variable, no wall clock, no database client.
+
+- **It takes mail already rendered.** Templates are `@krizaka/email`'s (a UI package this one never imports). `emailPorts(store, clock)` gives `@krizaka/email` its three ports (`DeliveryLog`, `SuppressionList`, `IdempotencyStore`) over the same tables, so a direct `sendEmail` and the queue share one log, one suppression list and one set of keys.
+- **At least once, never lost.** `deliver` checks the suppression list, checks the key, sends, and only then claims the key: a crash between the send and the claim sends again (a duplicate reset mail beats a lost one); a redelivery after the claim is a no-op.
+- **Addresses are hashed** (SHA-256 of the normal form) in the suppression list and in the delivery log. The queued message holds the address until the outbox purges it.
+- **Providers** are adapters over an injected `fetch`: `mailgunProvider`, `resendProvider`, `logProvider` (development, writes no body). `providerFor(settings.provider, keys, fetch, write)` picks the one the admin chose and refuses a provider without its key instead of falling back to `log`.
+- **Bounces and complaints** come back through the provider's signed webhook: `parseMailgunWebhook` and `parseResendWebhook` verify the signature and the age, and answer the addresses to suppress (a permanent failure or hard bounce, a complaint, an unsubscribe). A transient bounce is ignored.
+- **The admin's settings** (`@krizaka/mail/settings`): `mail.provider` (`log`, `mailgun`, `resend`), `mail.from`, `mail.replyTo`, `mail.retentionDays`. Keys, the Mailgun domain and the webhook signing keys stay in the environment (`MAIL_PROVIDER`-style names, read by the product and passed in).
+
+```ts
+import { createOutbox, runWorker } from "@krizaka/outbox";
+import { createMail, dbMailStore, MAIL_TOPIC, providerFor } from "@krizaka/mail";
+import { mailSettings, readMailSettings } from "@krizaka/mail/settings";
+
+const mail = createMail({
+  clock,
+  outbox: createOutbox({ clock, settings: outboxSettings }),
+  settings: () => readMailSettings((key) => settings.get(key)),
+  store: dbMailStore(query),
+  provider: (s) => providerFor(s.provider, { apiKey: env.MAIL_API_KEY, domain: env.MAIL_DOMAIN }, fetch, console.log),
+});
+
+// in the use case's transaction: the mail leaves only if the transaction commits
+await mail.queue(tx, { to, subject, text, category: "transactional", template: "password-reset", locale: "fr", idempotencyKey: `reset:${resetId}` });
+
+// in the worker process
+await runWorker({ outbox, query, owner, topic: MAIL_TOPIC, deliver: (m) => mail.deliver(m).then(() => undefined), sleep });
+
+// in the webhook route
+const suppression = parseMailgunWebhook(rawBody, env.MAIL_WEBHOOK_SIGNING_KEY, nowSeconds);
+if (suppression) await mail.suppress(suppression);
+```
+
+Tables (schema `mail`, `mailSchema`): `delivery`, `suppression`, `idempotency`. Event: `evt.mail.requested.v1` on topic `mail`. `mailStoreContract` (`@krizaka/mail/testkit`) is the contract every store runs.
+
+Apache-2.0.

package/dist/chunk-YDSARDFP.js

@@ -0,0 +1,80 @@
+// src/port.ts
+var SUPPRESSION_REASON = { bounce: "bounce", complaint: "complaint", unsubscribed: "unsubscribed" };
+var DELIVERY_STATUS = { sent: "sent", failed: "failed", suppressed: "suppressed", duplicate: "duplicate" };
+var MAIL_CODE = {
+  badAddress: "MAIL_BAD_ADDRESS",
+  badMessage: "MAIL_BAD_MESSAGE",
+  badSettings: "MAIL_BAD_SETTINGS",
+  provider: "MAIL_PROVIDER_FAILED",
+  badWebhook: "MAIL_BAD_WEBHOOK"
+};
+var MailError = class extends Error {
+  constructor(code, message) {
+    super(message);
+    this.code = code;
+    this.name = "MailError";
+  }
+  code;
+};
+
+// src/rules.ts
+import { createHash } from "crypto";
+var MAIL_BOUNDS = { retentionDays: [1, 3650] };
+var MAIL_DEFAULTS = { provider: "log", from: "Krizaka <no-reply@krizaka.com>", replyTo: "", retentionDays: 90 };
+var ADDRESS = /^[^\s@<>]+@[^\s@<>]+\.[^\s@<>]+$/;
+var TOKEN = /^[a-z][a-z0-9_.-]{0,39}$/;
+var MAX_ADDRESS = 254;
+var MAX_SUBJECT = 200;
+var MAX_BODY = 5e5;
+var MAX_KEY = 200;
+var normalizeAddress = (email) => email.trim().toLowerCase();
+var hashAddress = (email) => createHash("sha256").update(normalizeAddress(email)).digest("hex");
+function uuidOf(seed) {
+  const h = createHash("sha256").update(`krizaka.mail:${seed}`).digest();
+  h[6] = h[6] & 15 | 80;
+  h[8] = h[8] & 63 | 128;
+  const x = h.subarray(0, 16).toString("hex");
+  return `${x.slice(0, 8)}-${x.slice(8, 12)}-${x.slice(12, 16)}-${x.slice(16, 20)}-${x.slice(20, 32)}`;
+}
+function bareAddress(from) {
+  const match = /<([^<>]+)>\s*$/.exec(from);
+  return (match?.[1] ?? from).trim();
+}
+var oneLine = (value) => !/[\r\n]/.test(value);
+function checkAddress(address, what = "address") {
+  if (typeof address !== "string" || address.length > MAX_ADDRESS || !oneLine(address) || !ADDRESS.test(bareAddress(address))) throw new MailError(MAIL_CODE.badAddress, `${what} is not a valid address`);
+}
+function checkMessage(message) {
+  checkAddress(message.to, "to");
+  if (message.replyTo !== void 0 && message.replyTo !== "") checkAddress(message.replyTo, "replyTo");
+  if (typeof message.subject !== "string" || message.subject.trim() === "" || message.subject.length > MAX_SUBJECT || !oneLine(message.subject)) throw new MailError(MAIL_CODE.badMessage, "subject must be one line of 1 to 200 characters");
+  if (typeof message.text !== "string" || message.text.trim() === "" || message.text.length > MAX_BODY) throw new MailError(MAIL_CODE.badMessage, "text is required");
+  if (message.html !== void 0 && (typeof message.html !== "string" || message.html.length > MAX_BODY)) throw new MailError(MAIL_CODE.badMessage, "html is too long");
+  if (!TOKEN.test(message.category) || !TOKEN.test(message.template)) throw new MailError(MAIL_CODE.badMessage, "category and template are lower-case tokens");
+  if (typeof message.locale !== "string" || !/^[a-z]{2}(-[A-Z]{2})?$/.test(message.locale)) throw new MailError(MAIL_CODE.badMessage, "locale is a language tag like fr or en-CA");
+  if (typeof message.idempotencyKey !== "string" || message.idempotencyKey === "" || message.idempotencyKey.length > MAX_KEY) throw new MailError(MAIL_CODE.badMessage, "idempotencyKey is required (1 to 200 characters)");
+}
+function checkSettings(s) {
+  const [min, max] = MAIL_BOUNDS.retentionDays;
+  if (!Number.isInteger(s.retentionDays) || s.retentionDays < min || s.retentionDays > max) throw new MailError(MAIL_CODE.badSettings, `retentionDays must be ${min} to ${max}`);
+  checkAddress(s.from, "from");
+  if (s.replyTo !== "") checkAddress(s.replyTo, "replyTo");
+  return s;
+}
+
+export {
+  SUPPRESSION_REASON,
+  DELIVERY_STATUS,
+  MAIL_CODE,
+  MailError,
+  MAIL_BOUNDS,
+  MAIL_DEFAULTS,
+  normalizeAddress,
+  hashAddress,
+  uuidOf,
+  bareAddress,
+  checkAddress,
+  checkMessage,
+  checkSettings
+};
+//# sourceMappingURL=chunk-YDSARDFP.js.map

package/dist/chunk-YDSARDFP.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/port.ts","../src/rules.ts"],"sourcesContent":["/**\n * The ports of « mail »: a message queued in the caller's transaction and delivered after the commit, once per idempotency key,\n * never to a suppressed address. Generic: no vendor SDK (providers are adapters over an injected `fetch`), no environment variable\n * (keys come in as parameters), no wall clock, no database client. The module takes mail ALREADY RENDERED: templates are\n * `@krizaka/email`'s (a UI package this one never imports), and its three ports are satisfied structurally by `emailPorts`.\n */\nexport type { Clock, Query } from \"@krizaka/db\";\n\n/** Why an address is never mailed again. The same values as `@krizaka/email`'s `SuppressionReason`. */\nexport const SUPPRESSION_REASON = { bounce: \"bounce\", complaint: \"complaint\", unsubscribed: \"unsubscribed\" } as const;\nexport type SuppressionReason = (typeof SUPPRESSION_REASON)[keyof typeof SUPPRESSION_REASON];\n\n/** The mail a product queues. */\nexport interface MailMessage {\n  to: string;\n  subject: string;\n  text: string;\n  html?: string;\n  /** What kind of mail it is (`transactional`, `notification`, `digest`…): lower-case token, kept in the delivery log. */\n  category: string;\n  /** The template that rendered it, for the log (never the body). */\n  template: string;\n  locale: string;\n  /** One key sends once: queueing it twice is one message, and delivering it twice sends one mail. */\n  idempotencyKey: string;\n  /** Overrides `mail.replyTo` for this message. */\n  replyTo?: string;\n}\n\n/** A mail the provider receives: the message with the sender the settings give. */\nexport interface OutgoingMail extends MailMessage {\n  from: string;\n}\n\n/** What the provider answered. */\nexport interface Sent {\n  messageId: string | null;\n}\n\n/** One provider of mail (an adapter over `fetch`). It resolves on acceptance and throws on any failure: the outbox retries. */\nexport interface MailProvider {\n  readonly name: string;\n  send(mail: OutgoingMail): Promise<Sent>;\n}\n\nexport const DELIVERY_STATUS = { sent: \"sent\", failed: \"failed\", suppressed: \"suppressed\", duplicate: \"duplicate\" } as const;\nexport type DeliveryStatus = (typeof DELIVERY_STATUS)[keyof typeof DELIVERY_STATUS];\n\n/** One line of the delivery log: what, to whom (a hash, never the address), how it went. The shape of `@krizaka/email`'s `DeliveryLogEntry`. */\nexport interface DeliveryEntry {\n  at?: string;\n  template: string;\n  category: string;\n  locale: string;\n  to: string;\n  status: DeliveryStatus;\n  messageId?: string | undefined;\n  idempotencyKey?: string | undefined;\n  detail?: string | undefined;\n}\n\n/** A line to write: the instant is a `Date`. */\nexport type DeliveryInput = Omit<DeliveryEntry, \"at\"> & { at: Date };\n\n/** A line as read back. */\nexport interface DeliveryRecord extends DeliveryEntry {\n  id: number;\n  at: string;\n}\n\n/** Where the module keeps its state. Every adapter runs `mailStoreContract` (`@krizaka/mail/testkit`). Addresses arrive hashed. */\nexport interface MailStore {\n  record(entry: DeliveryInput): Promise<void>;\n  recent(limit: number): Promise<DeliveryRecord[]>;\n  isSuppressed(addressHash: string): Promise<boolean>;\n  /** `false` when the address was already suppressed (the first reason stays). */\n  suppress(addressHash: string, reason: SuppressionReason, now: Date): Promise<boolean>;\n  /** Lifts a suppression (the person re-subscribed, or it was a mistake). */\n  unsuppress(addressHash: string): Promise<boolean>;\n  hasKey(key: string): Promise<boolean>;\n  /** `true` the first time a key is claimed. */\n  claimKey(key: string, now: Date): Promise<boolean>;\n  releaseKey(key: string): Promise<void>;\n  /** Removes the keys and log lines older than `before` (suppressions are kept for good). Returns how many. */\n  purgeBefore(before: Date): Promise<number>;\n}\n\nexport interface MailSettings {\n  provider: \"log\" | \"mailgun\" | \"resend\";\n  /** The sender, `Name <address>` or an address. */\n  from: string;\n  /** Where replies go; empty for none. */\n  replyTo: string;\n  /** Days the delivery log and the idempotency keys are kept. */\n  retentionDays: number;\n}\n\nexport const MAIL_CODE = {\n  badAddress: \"MAIL_BAD_ADDRESS\",\n  badMessage: \"MAIL_BAD_MESSAGE\",\n  badSettings: \"MAIL_BAD_SETTINGS\",\n  provider: \"MAIL_PROVIDER_FAILED\",\n  badWebhook: \"MAIL_BAD_WEBHOOK\",\n} as const;\nexport type MailCode = (typeof MAIL_CODE)[keyof typeof MAIL_CODE];\n\nexport class MailError extends Error {\n  constructor(\n    readonly code: MailCode,\n    message: string,\n  ) {\n    super(message);\n    this.name = \"MailError\";\n  }\n}\n","import { createHash } from \"node:crypto\";\n\nimport { MAIL_CODE, MailError, type MailMessage, type MailSettings } from \"./port\";\n\nexport const MAIL_BOUNDS = { retentionDays: [1, 3650] } as const;\nexport const MAIL_DEFAULTS: MailSettings = { provider: \"log\", from: \"Krizaka <no-reply@krizaka.com>\", replyTo: \"\", retentionDays: 90 };\n\nconst ADDRESS = /^[^\\s@<>]+@[^\\s@<>]+\\.[^\\s@<>]+$/;\nconst TOKEN = /^[a-z][a-z0-9_.-]{0,39}$/;\n// @fixed: RFC 5321's longest forward path\nconst MAX_ADDRESS = 254;\n// @fixed: a subject is one short line; a body past this is not a transactional mail\nconst MAX_SUBJECT = 200;\nconst MAX_BODY = 500_000;\nconst MAX_KEY = 200;\n\nexport const normalizeAddress = (email: string) => email.trim().toLowerCase();\n\n/** The full SHA-256 of an address: suppressions and the log never hold the address itself (Loi 25). */\nexport const hashAddress = (email: string) => createHash(\"sha256\").update(normalizeAddress(email)).digest(\"hex\");\n\n/** A stable UUID (version 5 shaped) from a seed: the same key queued twice is one outbox message. */\nexport function uuidOf(seed: string): string {\n  const h = createHash(\"sha256\").update(`krizaka.mail:${seed}`).digest();\n  h[6] = (h[6]! & 0x0f) | 0x50;\n  h[8] = (h[8]! & 0x3f) | 0x80;\n  const x = h.subarray(0, 16).toString(\"hex\");\n  return `${x.slice(0, 8)}-${x.slice(8, 12)}-${x.slice(12, 16)}-${x.slice(16, 20)}-${x.slice(20, 32)}`;\n}\n\n/** The bare address of `Name <address>` or `address`. */\nexport function bareAddress(from: string): string {\n  const match = /<([^<>]+)>\\s*$/.exec(from);\n  return (match?.[1] ?? from).trim();\n}\n\nconst oneLine = (value: string) => !/[\\r\\n]/.test(value);\n\n/** @throws MailError when the address is not one mailbox on one line (no header injection). */\nexport function checkAddress(address: string, what = \"address\"): void {\n  if (typeof address !== \"string\" || address.length > MAX_ADDRESS || !oneLine(address) || !ADDRESS.test(bareAddress(address))) throw new MailError(MAIL_CODE.badAddress, `${what} is not a valid address`);\n}\n\n/** @throws MailError on the first thing wrong with a message. */\nexport function checkMessage(message: MailMessage): void {\n  checkAddress(message.to, \"to\");\n  if (message.replyTo !== undefined && message.replyTo !== \"\") checkAddress(message.replyTo, \"replyTo\");\n  if (typeof message.subject !== \"string\" || message.subject.trim() === \"\" || message.subject.length > MAX_SUBJECT || !oneLine(message.subject)) throw new MailError(MAIL_CODE.badMessage, \"subject must be one line of 1 to 200 characters\");\n  if (typeof message.text !== \"string\" || message.text.trim() === \"\" || message.text.length > MAX_BODY) throw new MailError(MAIL_CODE.badMessage, \"text is required\");\n  if (message.html !== undefined && (typeof message.html !== \"string\" || message.html.length > MAX_BODY)) throw new MailError(MAIL_CODE.badMessage, \"html is too long\");\n  if (!TOKEN.test(message.category) || !TOKEN.test(message.template)) throw new MailError(MAIL_CODE.badMessage, \"category and template are lower-case tokens\");\n  if (typeof message.locale !== \"string\" || !/^[a-z]{2}(-[A-Z]{2})?$/.test(message.locale)) throw new MailError(MAIL_CODE.badMessage, \"locale is a language tag like fr or en-CA\");\n  if (typeof message.idempotencyKey !== \"string\" || message.idempotencyKey === \"\" || message.idempotencyKey.length > MAX_KEY) throw new MailError(MAIL_CODE.badMessage, \"idempotencyKey is required (1 to 200 characters)\");\n}\n\n/** @throws MailError when the settings are out of bounds. */\nexport function checkSettings(s: MailSettings): MailSettings {\n  const [min, max] = MAIL_BOUNDS.retentionDays;\n  if (!Number.isInteger(s.retentionDays) || s.retentionDays < min || s.retentionDays > max) throw new MailError(MAIL_CODE.badSettings, `retentionDays must be ${min} to ${max}`);\n  checkAddress(s.from, \"from\");\n  if (s.replyTo !== \"\") checkAddress(s.replyTo, \"replyTo\");\n  return s;\n}\n"],"mappings":";AASO,IAAM,qBAAqB,EAAE,QAAQ,UAAU,WAAW,aAAa,cAAc,eAAe;AAoCpG,IAAM,kBAAkB,EAAE,MAAM,QAAQ,QAAQ,UAAU,YAAY,cAAc,WAAW,YAAY;AAoD3G,IAAM,YAAY;AAAA,EACvB,YAAY;AAAA,EACZ,YAAY;AAAA,EACZ,aAAa;AAAA,EACb,UAAU;AAAA,EACV,YAAY;AACd;AAGO,IAAM,YAAN,cAAwB,MAAM;AAAA,EACnC,YACW,MACT,SACA;AACA,UAAM,OAAO;AAHJ;AAIT,SAAK,OAAO;AAAA,EACd;AAAA,EALW;AAMb;;;AClHA,SAAS,kBAAkB;AAIpB,IAAM,cAAc,EAAE,eAAe,CAAC,GAAG,IAAI,EAAE;AAC/C,IAAM,gBAA8B,EAAE,UAAU,OAAO,MAAM,kCAAkC,SAAS,IAAI,eAAe,GAAG;AAErI,IAAM,UAAU;AAChB,IAAM,QAAQ;AAEd,IAAM,cAAc;AAEpB,IAAM,cAAc;AACpB,IAAM,WAAW;AACjB,IAAM,UAAU;AAET,IAAM,mBAAmB,CAAC,UAAkB,MAAM,KAAK,EAAE,YAAY;AAGrE,IAAM,cAAc,CAAC,UAAkB,WAAW,QAAQ,EAAE,OAAO,iBAAiB,KAAK,CAAC,EAAE,OAAO,KAAK;AAGxG,SAAS,OAAO,MAAsB;AAC3C,QAAM,IAAI,WAAW,QAAQ,EAAE,OAAO,gBAAgB,IAAI,EAAE,EAAE,OAAO;AACrE,IAAE,CAAC,IAAK,EAAE,CAAC,IAAK,KAAQ;AACxB,IAAE,CAAC,IAAK,EAAE,CAAC,IAAK,KAAQ;AACxB,QAAM,IAAI,EAAE,SAAS,GAAG,EAAE,EAAE,SAAS,KAAK;AAC1C,SAAO,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,CAAC;AACpG;AAGO,SAAS,YAAY,MAAsB;AAChD,QAAM,QAAQ,iBAAiB,KAAK,IAAI;AACxC,UAAQ,QAAQ,CAAC,KAAK,MAAM,KAAK;AACnC;AAEA,IAAM,UAAU,CAAC,UAAkB,CAAC,SAAS,KAAK,KAAK;AAGhD,SAAS,aAAa,SAAiB,OAAO,WAAiB;AACpE,MAAI,OAAO,YAAY,YAAY,QAAQ,SAAS,eAAe,CAAC,QAAQ,OAAO,KAAK,CAAC,QAAQ,KAAK,YAAY,OAAO,CAAC,EAAG,OAAM,IAAI,UAAU,UAAU,YAAY,GAAG,IAAI,yBAAyB;AACzM;AAGO,SAAS,aAAa,SAA4B;AACvD,eAAa,QAAQ,IAAI,IAAI;AAC7B,MAAI,QAAQ,YAAY,UAAa,QAAQ,YAAY,GAAI,cAAa,QAAQ,SAAS,SAAS;AACpG,MAAI,OAAO,QAAQ,YAAY,YAAY,QAAQ,QAAQ,KAAK,MAAM,MAAM,QAAQ,QAAQ,SAAS,eAAe,CAAC,QAAQ,QAAQ,OAAO,EAAG,OAAM,IAAI,UAAU,UAAU,YAAY,iDAAiD;AAC1O,MAAI,OAAO,QAAQ,SAAS,YAAY,QAAQ,KAAK,KAAK,MAAM,MAAM,QAAQ,KAAK,SAAS,SAAU,OAAM,IAAI,UAAU,UAAU,YAAY,kBAAkB;AAClK,MAAI,QAAQ,SAAS,WAAc,OAAO,QAAQ,SAAS,YAAY,QAAQ,KAAK,SAAS,UAAW,OAAM,IAAI,UAAU,UAAU,YAAY,kBAAkB;AACpK,MAAI,CAAC,MAAM,KAAK,QAAQ,QAAQ,KAAK,CAAC,MAAM,KAAK,QAAQ,QAAQ,EAAG,OAAM,IAAI,UAAU,UAAU,YAAY,6CAA6C;AAC3J,MAAI,OAAO,QAAQ,WAAW,YAAY,CAAC,yBAAyB,KAAK,QAAQ,MAAM,EAAG,OAAM,IAAI,UAAU,UAAU,YAAY,2CAA2C;AAC/K,MAAI,OAAO,QAAQ,mBAAmB,YAAY,QAAQ,mBAAmB,MAAM,QAAQ,eAAe,SAAS,QAAS,OAAM,IAAI,UAAU,UAAU,YAAY,kDAAkD;AAC1N;AAGO,SAAS,cAAc,GAA+B;AAC3D,QAAM,CAAC,KAAK,GAAG,IAAI,YAAY;AAC/B,MAAI,CAAC,OAAO,UAAU,EAAE,aAAa,KAAK,EAAE,gBAAgB,OAAO,EAAE,gBAAgB,IAAK,OAAM,IAAI,UAAU,UAAU,aAAa,yBAAyB,GAAG,OAAO,GAAG,EAAE;AAC7K,eAAa,EAAE,MAAM,MAAM;AAC3B,MAAI,EAAE,YAAY,GAAI,cAAa,EAAE,SAAS,SAAS;AACvD,SAAO;AACT;","names":[]}

package/dist/index.d.ts

@@ -0,0 +1,186 @@
+import { M as MailStore, D as DeliveryEntry, S as SuppressionReason, a as MailMessage, b as MailSettings, c as MailProvider } from './port-Pk4TboMq.js';
+export { d as DELIVERY_STATUS, e as DeliveryInput, f as DeliveryRecord, g as DeliveryStatus, h as MAIL_CODE, i as MailCode, j as MailError, O as OutgoingMail, k as SUPPRESSION_REASON, l as Sent } from './port-Pk4TboMq.js';
+import * as _krizaka_db from '@krizaka/db';
+import { Clock, Query } from '@krizaka/db';
+export { Clock, Query } from '@krizaka/db';
+
+/**
+ * The three ports of `@krizaka/email` (`DeliveryLog`, `SuppressionList`, `IdempotencyStore`) over this module's store, so a product
+ * that calls `sendEmail` directly writes to the same tables as the queue. Structural: this package never imports `@krizaka/email`.
+ */
+declare function emailPorts(store: MailStore, clock: Clock): {
+    log: {
+        record: (entry: Omit<DeliveryEntry, "at"> & {
+            at?: string;
+        }) => Promise<void>;
+    };
+    suppression: {
+        has: (email: string) => Promise<boolean>;
+        add: (email: string, reason: SuppressionReason) => Promise<void>;
+    };
+    idempotency: {
+        claim: (key: string) => Promise<boolean>;
+        release: (key: string) => Promise<void>;
+    };
+};
+
+/** What a provider's webhook tells us about one address. */
+interface Suppression {
+    address: string;
+    reason: SuppressionReason;
+}
+/**
+ * A Mailgun webhook (JSON body): checks the signature (HMAC-SHA256 of `timestamp + token` with the webhook signing key, hex) and
+ * its age, then answers the address to suppress, or `null` for an event that is not a permanent bounce, a complaint or an unsubscribe.
+ * @throws MailError when the body is not Mailgun's, the signature is wrong or the timestamp is stale
+ */
+declare function parseMailgunWebhook(rawBody: string, signingKey: string, nowSeconds: number): Suppression | null;
+interface SvixHeaders {
+    id: string | null | undefined;
+    timestamp: string | null | undefined;
+    signature: string | null | undefined;
+}
+/**
+ * A Resend webhook (signed the Svix way): HMAC-SHA256 over `id.timestamp.body` with the base64 secret that follows `whsec_`, any of
+ * the space-separated `v1,<base64>` signatures matching. Answers the addresses to suppress (a hard bounce or a complaint).
+ * @throws MailError when the headers are missing, the signature is wrong or the timestamp is stale
+ */
+declare function parseResendWebhook(rawBody: string, headers: SvixHeaders, secret: string, nowSeconds: number): Suppression[];
+
+/** The topic the mail is queued on, and the event that names it: the outbox routes by these. */
+declare const MAIL_TOPIC = "mail";
+declare const MAIL_EVENT: {
+    readonly requested: "evt.mail.requested.v1";
+};
+/** What the module needs of `@krizaka/outbox` (its `Outbox` satisfies it): append in the caller's transaction. */
+interface MailOutbox {
+    append(tx: Query, message: {
+        topic: string;
+        type: string;
+        payload: unknown;
+        id: string;
+    }): Promise<{
+        id: string;
+        appended: boolean;
+    }>;
+}
+/** The part of an outbox message the deliverer reads (`OutboxMessage` satisfies it). */
+interface QueuedMail {
+    id: string;
+    payload: unknown;
+}
+interface MailDeps {
+    clock: Clock;
+    outbox: MailOutbox;
+    /** The settings, read at each call so the admin's change applies at once. */
+    settings: MailSettings | (() => MailSettings | Promise<MailSettings>);
+    /** The state of the module over a query (a pool; a transaction is never needed). */
+    store: MailStore;
+    /** The provider the admin chose: a function so a change of `mail.provider` applies at once. */
+    provider: MailProvider | ((settings: MailSettings) => MailProvider);
+}
+interface Mail {
+    /** Queues a mail INSIDE the caller's transaction: it is sent after the commit, and only if the transaction commits. `queued` is `false` when the same key was already queued. */
+    queue(tx: Query, message: MailMessage): Promise<{
+        id: string;
+        queued: boolean;
+    }>;
+    /** Delivers one queued mail: skipped if its address is suppressed or its key was already sent, thrown (for a retry) if the provider fails. Give it to `runWorker` / `drainOnce` as `deliver`. */
+    deliver(message: QueuedMail): Promise<DeliveryEntry["status"]>;
+    /** A provider's webhook said this address bounced, complained or unsubscribed: it is never mailed again. */
+    suppress(suppression: Suppression): Promise<boolean>;
+    /** Lifts a suppression. */
+    unsuppress(address: string): Promise<boolean>;
+    isSuppressed(address: string): Promise<boolean>;
+    /** Removes the log and the keys older than the retention. */
+    purge(): Promise<number>;
+}
+/**
+ * The mail of a product.
+ *
+ * The guarantee is AT LEAST ONCE: a mail is sent, THEN its key is claimed, so a crash in between sends it again rather than never
+ * (a duplicate reset mail beats a lost one). A second delivery after the claim is a no-op.
+ * @param deps the clock, the outbox, the settings, the store and the provider
+ * @returns the mail functions
+ */
+declare function createMail(deps: MailDeps): Mail;
+
+/** An in-memory store, for unit tests and demos: the behaviour of the database's (the contract kit runs on both). */
+declare function memoryMailStore(): MailStore;
+
+/**
+ * The PostgreSQL store of « mail » over a `Query`, in schema `mail` (or the one the product renamed it to).
+ * @param query a pool-level query
+ * @param schema the Postgres schema, default `mail`
+ */
+declare function dbMailStore(query: Query, schema?: string): MailStore;
+
+/** The part of `fetch` the providers use: inject the global one (`fetch`), or a fake in a test. */
+type FetchLike = (url: string, init: {
+    method: "POST";
+    headers: Record<string, string>;
+    body: string;
+}) => Promise<{
+    ok: boolean;
+    status: number;
+    text(): Promise<string>;
+}>;
+interface MailgunOptions {
+    apiKey: string;
+    /** The sending domain. */
+    domain: string;
+    /** `https://api.mailgun.net` (default) or `https://api.eu.mailgun.net`. */
+    apiUrl?: string;
+    fetch: FetchLike;
+}
+/** Mailgun's messages API (form-encoded, basic auth). */
+declare function mailgunProvider(options: MailgunOptions): MailProvider;
+interface ResendOptions {
+    apiKey: string;
+    /** Default `https://api.resend.com`. */
+    apiUrl?: string;
+    fetch: FetchLike;
+}
+/** Resend's emails API (JSON, bearer key, its own `Idempotency-Key`). */
+declare function resendProvider(options: ResendOptions): MailProvider;
+/** The development provider: writes one JSON line per mail (without its body) and sends nothing. */
+declare function logProvider(write: (line: string) => void): MailProvider;
+/** The keys a provider needs: they stay in the environment, the product reads them and passes them here. */
+interface ProviderKeys {
+    apiKey?: string;
+    domain?: string;
+    apiUrl?: string;
+}
+/**
+ * The provider the admin chose (`mail.provider`). A provider chosen without its key is refused loudly, never replaced by `log`:
+ * a reset mail must not vanish silently.
+ * @throws MailError when the chosen provider lacks its key (or its domain, for Mailgun)
+ */
+declare function providerFor(kind: MailSettings["provider"], keys: ProviderKeys, fetch: FetchLike, write: (line: string) => void): MailProvider;
+
+declare const MAIL_BOUNDS: {
+    readonly retentionDays: readonly [1, 3650];
+};
+declare const MAIL_DEFAULTS: MailSettings;
+declare const normalizeAddress: (email: string) => string;
+/** The full SHA-256 of an address: suppressions and the log never hold the address itself (Loi 25). */
+declare const hashAddress: (email: string) => string;
+/** A stable UUID (version 5 shaped) from a seed: the same key queued twice is one outbox message. */
+declare function uuidOf(seed: string): string;
+/** The bare address of `Name <address>` or `address`. */
+declare function bareAddress(from: string): string;
+/** @throws MailError when the address is not one mailbox on one line (no header injection). */
+declare function checkAddress(address: string, what?: string): void;
+/** @throws MailError on the first thing wrong with a message. */
+declare function checkMessage(message: MailMessage): void;
+/** @throws MailError when the settings are out of bounds. */
+declare function checkSettings(s: MailSettings): MailSettings;
+
+/**
+ * The tables of « mail », in their own Postgres schema: `delivery` (the log, with the recipient as a hash, never a body),
+ * `suppression` (the addresses never mailed again, as a SHA-256 hash: the list holds no address) and `idempotency` (the keys
+ * already sent). They reference no product table. Version 1 is frozen once released: a change is version 2.
+ */
+declare const mailSchema: _krizaka_db.ModuleSchema;
+
+export { DeliveryEntry, type FetchLike, MAIL_BOUNDS, MAIL_DEFAULTS, MAIL_EVENT, MAIL_TOPIC, type Mail, type MailDeps, MailMessage, type MailOutbox, MailProvider, MailSettings, MailStore, type MailgunOptions, type ProviderKeys, type QueuedMail, type ResendOptions, type Suppression, SuppressionReason, type SvixHeaders, bareAddress, checkAddress, checkMessage, checkSettings, createMail, dbMailStore, emailPorts, hashAddress, logProvider, mailSchema, mailgunProvider, memoryMailStore, normalizeAddress, parseMailgunWebhook, parseResendWebhook, providerFor, resendProvider, uuidOf };