@storyshelf/notify-email 0.6.2 → 0.8.0

package/README.md

@@ -19,13 +19,22 @@ const sender = smtpPreset({ host: "mail.example.com", port: 587, from: "shelf@ex
 const app = createShelfApp({
   database,
   storage,
-  notifiers: [createEmailNotifier(sender, { from: "shelf@example.com" })],
+  notifications: { notifiers: [createEmailNotifier(sender, { from: "shelf@example.com" })] },
   // Optional: invites and password resets share the same transport.
   // auth: createShelfAuth({ db, secret, baseURL, emailSender: sender }),
 });
 ```
 
-Presets: `smtpPreset` (corporate relay, Postfix, SES-over-SMTP), `mailpitPreset` (local dev, `localhost:1025`), `logPreset` (tests/unconfigured), `httpPreset` (Resend/Postmark-style JSON endpoint). See [Notifications](/guides/notifications/).
+## Presets
+
+| Preset          | Use for                                                                                                          |
+| --------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `smtpPreset`    | A corporate relay, Postfix, or SES over SMTP. `smtpPresetFromEnv` reads the settings from environment variables. |
+| `mailpitPreset` | Local development against Mailpit (`localhost:1025`).                                                            |
+| `httpPreset`    | A Resend- or Postmark-style JSON HTTP endpoint.                                                                  |
+| `logPreset`     | Tests and unconfigured setups — messages are written to the log.                                                 |
+
+See [Notifications](https://storyshelf.js.org/guides/notifications/) for how email channels, subscriptions, and auth mail fit together.
 
 ## Install notes
 

package/dist/email.d.mts

@@ -1,9 +1,8 @@
 import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
 import { EmailSender } from "@storyshelf/core/adapter/email-sender";
-import { NotifierProvider } from "@storyshelf/core/adapter/notifier";
+import { MessageNotifierProvider } from "@storyshelf/core/adapter/notifier";
 import { Logger } from "@storyshelf/core/logger";
-//#region src/email.d.ts
 /** Defaults applied when a channel omits sender identity. */
 interface EmailNotifierDefaults {
   from?: string;
@@ -15,9 +14,8 @@ interface EmailNotifierDefaults {
  */
 declare function createEmailNotifier(sender: EmailSender, defaults?: EmailNotifierDefaults & {
   logger?: Logger;
-}): NotifierProvider;
+}): MessageNotifierProvider;
 /** Describe the email provider (name, version, config schema). */
-declare function getMetadata(): NotifierProvider["metadata"];
-//#endregion
+declare function getMetadata(): MessageNotifierProvider["metadata"];
 export { EmailNotifierDefaults, createEmailNotifier, getMetadata };
 //# sourceMappingURL=email.d.mts.map

package/dist/email.mjs

@@ -2,7 +2,7 @@ import "node:path";
 import "node:url";
 import.meta.url;
 import { emailChannelConfigSchema } from "./types.mjs";
-//#region src/email.ts
+// src/email.ts
 /**
 * Create the `email` channel provider over a shared transport.
 * The same {@link EmailSender} can also serve auth mail (invites, resets).
@@ -38,14 +38,13 @@ function createEmailNotifier(sender, defaults = {}) {
 function getMetadata() {
 	return {
 		name: "Email",
-		version: globalThis.__PKG_VERSION__ ?? "0.0.0",
+		version: "0.8.0",
 		description: "Email notifications over a shared SMTP/HTTP transport",
 		kind: "email",
 		category: "notifier",
 		schema: emailChannelConfigSchema
 	};
 }
-//#endregion
 export { createEmailNotifier, getMetadata };
 
 //# sourceMappingURL=email.mjs.map

package/dist/email.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"email.mjs","names":[],"sources":["../src/email.ts"],"sourcesContent":["import type { EmailSender } from \"@storyshelf/core/adapter/email-sender\";\nimport type { NotifierAdapter, NotifierProvider } from \"@storyshelf/core/adapter/notifier\";\nimport type { Logger } from \"@storyshelf/core/logger\";\nimport { emailChannelConfigSchema } from \"./types.ts\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\n/** Defaults applied when a channel omits sender identity. */\nexport interface EmailNotifierDefaults {\n  from?: string;\n  replyTo?: string;\n}\n\n/**\n * Create the `email` channel provider over a shared transport.\n * The same {@link EmailSender} can also serve auth mail (invites, resets).\n */\nexport function createEmailNotifier(\n  sender: EmailSender,\n  defaults: EmailNotifierDefaults & { logger?: Logger } = {},\n): NotifierProvider {\n  return {\n    metadata: getMetadata(),\n    create(opts: { config: unknown; secret?: string; logger?: Logger }): NotifierAdapter {\n      const config = emailChannelConfigSchema.parse(opts.config);\n      const logger = (opts.logger ?? defaults.logger)?.child({ component: \"notify-email\" });\n      return {\n        metadata: getMetadata(),\n        async send(input): Promise<void> {\n          logger?.debug({ channelId: input.channel.id }, \"sending email notification\");\n          await sender.send({\n            to: config.to,\n            subject: input.formatted.subject,\n            text: input.formatted.text,\n            html: input.formatted.html,\n            from: config.from ?? defaults.from,\n            replyTo: config.replyTo ?? defaults.replyTo,\n          });\n          logger?.info({ channelId: input.channel.id, to: config.to }, \"email sent\");\n        },\n      };\n    },\n  };\n}\n\n/** Describe the email provider (name, version, config schema). */\nexport function getMetadata(): NotifierProvider[\"metadata\"] {\n  return {\n    name: \"Email\",\n    version: (globalThis as unknown as { __PKG_VERSION__?: string }).__PKG_VERSION__ ?? \"0.0.0\",\n    description: \"Email notifications over a shared SMTP/HTTP transport\",\n    kind: \"email\",\n    category: \"notifier\",\n    schema: emailChannelConfigSchema,\n  };\n}\n"],"mappings":";;;;;;;;;AAiBA,SAAgB,oBACd,QACA,WAAwD,CAAC,GACvC;CAClB,OAAO;EACL,UAAU,YAAY;EACtB,OAAO,MAA8E;GACnF,MAAM,SAAS,yBAAyB,MAAM,KAAK,MAAM;GACzD,MAAM,UAAU,KAAK,UAAU,SAAS,OAAA,EAAS,MAAM,EAAE,WAAW,eAAe,CAAC;GACpF,OAAO;IACL,UAAU,YAAY;IACtB,MAAM,KAAK,OAAsB;KAC/B,QAAQ,MAAM,EAAE,WAAW,MAAM,QAAQ,GAAG,GAAG,4BAA4B;KAC3E,MAAM,OAAO,KAAK;MAChB,IAAI,OAAO;MACX,SAAS,MAAM,UAAU;MACzB,MAAM,MAAM,UAAU;MACtB,MAAM,MAAM,UAAU;MACtB,MAAM,OAAO,QAAQ,SAAS;MAC9B,SAAS,OAAO,WAAW,SAAS;KACtC,CAAC;KACD,QAAQ,KAAK;MAAE,WAAW,MAAM,QAAQ;MAAI,IAAI,OAAO;KAAG,GAAG,YAAY;IAC3E;GACF;EACF;CACF;AACF;;AAGA,SAAgB,cAA4C;CAC1D,OAAO;EACL,MAAM;EACN,SAAU,WAAuD,mBAAmB;EACpF,aAAa;EACb,MAAM;EACN,UAAU;EACV,QAAQ;CACV;AACF"}
+{"version":3,"file":"email.mjs","names":[],"sources":["../src/email.ts"],"sourcesContent":["import type { EmailSender } from \"@storyshelf/core/adapter/email-sender\";\nimport type {\n  MessageNotifierAdapter,\n  MessageNotifierProvider,\n} from \"@storyshelf/core/adapter/notifier\";\nimport type { Logger } from \"@storyshelf/core/logger\";\nimport { emailChannelConfigSchema } from \"./types.ts\";\n\ndeclare const __PKG_VERSION__: string | undefined;\n\n/** Defaults applied when a channel omits sender identity. */\nexport interface EmailNotifierDefaults {\n  from?: string;\n  replyTo?: string;\n}\n\n/**\n * Create the `email` channel provider over a shared transport.\n * The same {@link EmailSender} can also serve auth mail (invites, resets).\n */\nexport function createEmailNotifier(\n  sender: EmailSender,\n  defaults: EmailNotifierDefaults & { logger?: Logger } = {},\n): MessageNotifierProvider {\n  return {\n    metadata: getMetadata(),\n    create(opts: { config: unknown; secret?: string; logger?: Logger }): MessageNotifierAdapter {\n      const config = emailChannelConfigSchema.parse(opts.config);\n      const logger = (opts.logger ?? defaults.logger)?.child({ component: \"notify-email\" });\n      return {\n        metadata: getMetadata(),\n        async send(input): Promise<void> {\n          logger?.debug({ channelId: input.channel.id }, \"sending email notification\");\n          await sender.send({\n            to: config.to,\n            subject: input.formatted.subject,\n            text: input.formatted.text,\n            html: input.formatted.html,\n            from: config.from ?? defaults.from,\n            replyTo: config.replyTo ?? defaults.replyTo,\n          });\n          logger?.info({ channelId: input.channel.id, to: config.to }, \"email sent\");\n        },\n      };\n    },\n  };\n}\n\n/** Describe the email provider (name, version, config schema). */\nexport function getMetadata(): MessageNotifierProvider[\"metadata\"] {\n  return {\n    name: \"Email\",\n    version: typeof __PKG_VERSION__ === \"string\" ? __PKG_VERSION__ : \"0.0.0\",\n    description: \"Email notifications over a shared SMTP/HTTP transport\",\n    kind: \"email\",\n    category: \"notifier\",\n    schema: emailChannelConfigSchema,\n  };\n}\n"],"mappings":";;;;;;;;;AAoBA,SAAgB,oBACd,QACA,WAAwD,CAAC,GAChC;CACzB,OAAO;EACL,UAAU,YAAY;EACtB,OAAO,MAAqF;GAC1F,MAAM,SAAS,yBAAyB,MAAM,KAAK,MAAM;GACzD,MAAM,UAAU,KAAK,UAAU,SAAS,OAAA,EAAS,MAAM,EAAE,WAAW,eAAe,CAAC;GACpF,OAAO;IACL,UAAU,YAAY;IACtB,MAAM,KAAK,OAAsB;KAC/B,QAAQ,MAAM,EAAE,WAAW,MAAM,QAAQ,GAAG,GAAG,4BAA4B;KAC3E,MAAM,OAAO,KAAK;MAChB,IAAI,OAAO;MACX,SAAS,MAAM,UAAU;MACzB,MAAM,MAAM,UAAU;MACtB,MAAM,MAAM,UAAU;MACtB,MAAM,OAAO,QAAQ,SAAS;MAC9B,SAAS,OAAO,WAAW,SAAS;KACtC,CAAC;KACD,QAAQ,KAAK;MAAE,WAAW,MAAM,QAAQ;MAAI,IAAI,OAAO;KAAG,GAAG,YAAY;IAC3E;GACF;EACF;CACF;AACF;;AAGA,SAAgB,cAAmD;CACjE,OAAO;EACL,MAAM;EACN,SAAA;EACA,aAAa;EACb,MAAM;EACN,UAAU;EACV,QAAQ;CACV;AACF"}

package/dist/http.d.mts

@@ -3,11 +3,9 @@ import __tsdown_shims_url from 'node:url';
 import { HttpPresetOptions } from "./types.mjs";
 import { EmailSender } from "@storyshelf/core/adapter/email-sender";
 import { Logger } from "@storyshelf/core/logger";
-//#region src/http.d.ts
 /** HTTP email-API preset (Resend/Postmark-style JSON endpoint). */
 declare function httpPreset(options: HttpPresetOptions & {
   logger?: Logger;
 }): EmailSender;
-//#endregion
 export { httpPreset };
 //# sourceMappingURL=http.d.mts.map

package/dist/http.mjs

@@ -3,7 +3,7 @@ import "node:url";
 import.meta.url;
 import { version } from "./version.mjs";
 import { httpText } from "@storyshelf/core/utils";
-//#region src/http.ts
+// src/http.ts
 /** HTTP email-API preset (Resend/Postmark-style JSON endpoint). */
 function httpPreset(options) {
 	let logger = options.logger?.child({ component: "notify-email-http" });
@@ -38,7 +38,6 @@ function httpPreset(options) {
 		}
 	};
 }
-//#endregion
 export { httpPreset };
 
 //# sourceMappingURL=http.mjs.map

package/dist/index.mjs

@@ -7,13 +7,4 @@ import { httpPreset } from "./http.mjs";
 import { logPreset } from "./log.mjs";
 import { smtpPreset, smtpPresetFromEnv } from "./smtp.mjs";
 import { mailpitPreset } from "./mailpit.mjs";
-//#region src/index.ts
-/**
-* Email notification transport: SMTP/Mailpit/log/HTTP presets plus the
-* `email` channel provider. One transport serves notification channels
-* and (optionally) auth mail — wire the same sender into both.
-*/
-//#endregion
 export { createEmailNotifier, emailChannelConfigSchema, httpPreset, logPreset, mailpitPreset, smtpPreset, smtpPresetFromEnv };
-
-//# sourceMappingURL=index.mjs.map

package/dist/log.d.mts

@@ -2,11 +2,9 @@ import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
 import { EmailSender } from "@storyshelf/core/adapter/email-sender";
 import { Logger } from "@storyshelf/core/logger";
-//#region src/log.d.ts
 /** Log-only preset for tests and unconfigured servers (no delivery). */
 declare function logPreset(options?: {
   logger?: Logger;
 }): EmailSender;
-//#endregion
 export { logPreset };
 //# sourceMappingURL=log.d.mts.map

package/dist/log.mjs

@@ -2,7 +2,7 @@ import "node:path";
 import "node:url";
 import.meta.url;
 import { version } from "./version.mjs";
-//#region src/log.ts
+// src/log.ts
 /** Log-only preset for tests and unconfigured servers (no delivery). */
 function logPreset(options = {}) {
 	let logger = options.logger?.child({ component: "notify-email-log" });
@@ -24,7 +24,6 @@ function logPreset(options = {}) {
 		}
 	};
 }
-//#endregion
 export { logPreset };
 
 //# sourceMappingURL=log.mjs.map

package/dist/mailpit.d.mts

@@ -2,7 +2,6 @@ import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
 import { EmailSender } from "@storyshelf/core/adapter/email-sender";
 import { Logger } from "@storyshelf/core/logger";
-//#region src/mailpit.d.ts
 /** Mailpit/Mailhog preset for local development (no real delivery). */
 declare function mailpitPreset(options?: {
   from?: string;
@@ -10,6 +9,5 @@ declare function mailpitPreset(options?: {
   port?: number;
   logger?: Logger;
 }): EmailSender;
-//#endregion
 export { mailpitPreset };
 //# sourceMappingURL=mailpit.d.mts.map

package/dist/mailpit.mjs

@@ -2,7 +2,7 @@ import "node:path";
 import "node:url";
 import.meta.url;
 import { smtpPreset } from "./smtp.mjs";
-//#region src/mailpit.ts
+// src/mailpit.ts
 /** Mailpit/Mailhog preset for local development (no real delivery). */
 function mailpitPreset(options = {}) {
 	return smtpPreset({
@@ -12,7 +12,6 @@ function mailpitPreset(options = {}) {
 		logger: options.logger
 	});
 }
-//#endregion
 export { mailpitPreset };
 
 //# sourceMappingURL=mailpit.mjs.map

package/dist/smtp.d.mts

@@ -3,7 +3,6 @@ import __tsdown_shims_url from 'node:url';
 import { SmtpPresetOptions } from "./types.mjs";
 import { EmailSender } from "@storyshelf/core/adapter/email-sender";
 import { Logger } from "@storyshelf/core/logger";
-//#region src/smtp.d.ts
 /**
  * SMTP transport preset (corporate relay, Postfix, SES-over-SMTP).
  *
@@ -20,6 +19,5 @@ declare function smtpPreset(options: SmtpPresetOptions & {
  * Requires the optional `nodemailer` peer when a sender is built.
  */
 declare function smtpPresetFromEnv(env?: Record<string, string | undefined>, logger?: Logger): EmailSender | undefined;
-//#endregion
 export { smtpPreset, smtpPresetFromEnv };
 //# sourceMappingURL=smtp.d.mts.map

package/dist/smtp.mjs

@@ -3,7 +3,7 @@ import "node:url";
 import.meta.url;
 import { version } from "./version.mjs";
 import nodemailer from "nodemailer";
-//#region src/smtp.ts
+// src/smtp.ts
 /**
 * SMTP transport preset (corporate relay, Postfix, SES-over-SMTP).
 *
@@ -70,7 +70,6 @@ function smtpPresetFromEnv(env = process.env, logger) {
 		logger
 	});
 }
-//#endregion
 export { smtpPreset, smtpPresetFromEnv };
 
 //# sourceMappingURL=smtp.mjs.map

package/dist/types.d.mts

@@ -1,7 +1,6 @@
 import __tsdown_shims_path from 'node:path';
 import __tsdown_shims_url from 'node:url';
 import { z } from "zod";
-//#region src/types.d.ts
 /** Display toggles plus addressing for email channels. */
 declare const emailChannelConfigSchema: z.ZodObject<{
   to: z.ZodString;
@@ -33,6 +32,5 @@ interface HttpPresetOptions {
   headers?: Record<string, string>;
   from: string;
 }
-//#endregion
 export { EmailChannelConfig, HttpPresetOptions, SmtpPresetOptions, emailChannelConfigSchema };
 //# sourceMappingURL=types.d.mts.map

package/dist/types.mjs

@@ -2,7 +2,7 @@ import "node:path";
 import "node:url";
 import.meta.url;
 import { z } from "zod";
-//#region src/types.ts
+// src/types.ts
 /** Display toggles plus addressing for email channels. */
 const emailChannelConfigSchema = z.object({
 	to: z.string().min(1),
@@ -14,7 +14,6 @@ const emailChannelConfigSchema = z.object({
 	includeMessage: z.boolean().optional(),
 	includeCounts: z.boolean().optional()
 });
-//#endregion
 export { emailChannelConfigSchema };
 
 //# sourceMappingURL=types.mjs.map

package/dist/version.mjs

@@ -1,12 +1,11 @@
 import "node:path";
 import "node:url";
 import.meta.url;
-//#region src/version.ts
+// src/version.ts
 /** Package version injected at build via __PKG_VERSION__. */
 function version() {
-	return globalThis.__PKG_VERSION__ ?? "0.0.0";
+	return "0.8.0";
 }
-//#endregion
 export { version };
 
 //# sourceMappingURL=version.mjs.map

package/dist/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["declare const __PKG_VERSION__: string | undefined;\n\n/** Package version injected at build via __PKG_VERSION__. */\nexport function version(): string {\n  return (globalThis as unknown as { __PKG_VERSION__?: string }).__PKG_VERSION__ ?? \"0.0.0\";\n}\n"],"mappings":";;;;;AAGA,SAAgB,UAAkB;CAChC,OAAQ,WAAuD,mBAAmB;AACpF"}
+{"version":3,"file":"version.mjs","names":[],"sources":["../src/version.ts"],"sourcesContent":["declare const __PKG_VERSION__: string | undefined;\n\n/** Package version injected at build via __PKG_VERSION__. */\nexport function version(): string {\n  return typeof __PKG_VERSION__ === \"string\" ? __PKG_VERSION__ : \"0.0.0\";\n}\n"],"mappings":";;;;;AAGA,SAAgB,UAAkB;CAChC,OAAA;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storyshelf/notify-email",
-  "version": "0.6.2",
+  "version": "0.8.0",
   "description": "Email notification transport for StoryShelf (SMTP, Mailpit, log, HTTP APIs).",
   "keywords": [
     "email",
@@ -27,9 +27,6 @@
     "dist"
   ],
   "type": "module",
-  "engines": {
-    "node": ">=24"
-  },
   "sideEffects": false,
   "types": "./dist/index.d.mts",
   "exports": {
@@ -80,29 +77,32 @@
     "prepublishOnly": "nub run build"
   },
   "dependencies": {
-    "@storyshelf/core": "0.6.2",
-    "zod": "^4.2.0"
+    "@storyshelf/core": "0.8.0",
+    "zod": "^4.6.7"
   },
   "devDependencies": {
     "@types/node": "^26.0.0",
     "@types/nodemailer": "^8.0.2",
     "@vitest/coverage-v8": "^4.0.0",
-    "nodemailer": "^10.0.12",
+    "nodemailer": "^10.2.1",
     "oxfmt": "^0.65.0",
     "oxlint": "^1.80.0",
     "oxlint-tsgolint": "^7.0.2001",
     "tsdown": "^0.22.14",
     "typescript": "^7.0.2",
-    "vitest": "^5.0.0"
+    "vitest": "^5.0.5"
   },
   "peerDependencies": {
-    "nodemailer": "^10.0.12"
+    "nodemailer": "^10.2.1"
   },
   "peerDependenciesMeta": {
     "nodemailer": {
       "optional": true
     }
   },
+  "engines": {
+    "node": ">=24"
+  },
   "jsr": {
     "runtimeCompat": {
       "node": true,

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { createEmailNotifier } from \"./email.ts\";\n/**\n * Email notification transport: SMTP/Mailpit/log/HTTP presets plus the\n * `email` channel provider. One transport serves notification channels\n * and (optionally) auth mail — wire the same sender into both.\n */\nimport { httpPreset } from \"./http.ts\";\nimport { logPreset } from \"./log.ts\";\nimport { mailpitPreset } from \"./mailpit.ts\";\nimport { smtpPreset, smtpPresetFromEnv } from \"./smtp.ts\";\n\n/** SMTP transport preset (corporate relay, Postfix, SES-over-SMTP). */\nexport { smtpPreset };\n/** SMTP sender from `SMTP_*` environment (undefined unless configured). */\nexport { smtpPresetFromEnv };\n/** Mailpit/Mailhog preset for local development (no real delivery). */\nexport { mailpitPreset };\n/** Log-only preset for tests and unconfigured servers (no delivery). */\nexport { logPreset };\n/** HTTP email-API preset (Resend/Postmark-style JSON endpoint). */\nexport { httpPreset };\n/** `email` channel provider over a shared transport. */\nexport { createEmailNotifier };\n\nexport type { EmailNotifierDefaults } from \"./email.ts\";\nexport type { EmailChannelConfig, HttpPresetOptions, SmtpPresetOptions } from \"./types.ts\";\nexport { emailChannelConfigSchema } from \"./types.ts\";\n"],"mappings":""}