nuxt-mail 7.0.1 → 8.0.0

package/README.md

@@ -71,11 +71,11 @@ $ yarn nuxi module add nuxt-mail
 
 ## Configuration
 
-Add the module to the `modules` array in your `nuxt.config.js`. Note to add it to `modules` instead of `buildModules`, otherwise the server route will not be generated.
+Add the module to the `modules` array in your Nuxt config:
 
-```js
-// nuxt.config.js
-export default {
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
   modules: [
     ['nuxt-mail', {
       message: {
@@ -97,52 +97,26 @@ export default {
       port: 587,
     },
   },
-  // or use runtimeConfig
-  runtimeConfig: {
-    mail: {
-      message: {
-        to: 'foo@bar.de',
-      },
-      smtp: {
-        host: "smtp.example.com",
-        port: 587,
-      },
-    },
-  },
-}
+});
 ```
 
-The `smtp` options are required and directly passed to [nodemailer](https://nodemailer.com/smtp/). Refer to their documentation for available options. Also, you have to pass at least `to`, `cc` or `bcc` via the `message` config. This has security reasons, this way the client cannot send emails from your SMTP server to arbitrary recipients. You can actually preconfigure the message via the `message` config, so if you always want to send emails with the same subject or from address, you can configure them here.
+You can also set environment variables like `NUXT_MAIL`, `NUXT_MAIL_SMTP`, `NUXT_MAIL_MESSAGE`, etc. as JSON. They will be deserialized and put into the runtime config automatically.
 
-The module injects the `$mail` variable, which we now use to send emails:
+The `smtp` options are required and directly passed to [nodemailer](https://nodemailer.com/smtp/). Refer to their documentation for available options. Also, you have to pass at least `to`, `cc` or `bcc` via the `message` config. This has security reasons, this way the client cannot send emails from your SMTP server to arbitrary recipients. You can actually preconfigure the message via the `message` config, so if you always want to send emails with the same subject or from address, you can configure them here.
 
-## Nuxt 3
+Now we can send emails:
 
 ### Via composable
 
 ```html
 <script setup>
-const mail = useMail()
+const mail = useMail();
 
 mail.send({
   from: 'John Doe',
   subject: 'Incredible',
   text: 'This is an incredible test message',
-})
-</script>
-```
-
-### Via injected variable
-
-```html
-<script setup>
-const { $mail } = useNuxtApp()
-
-$mail.send({
-  from: 'John Doe',
-  subject: 'Incredible',
-  text: 'This is an incredible test message',
-})
+});
 </script>
 ```
 
@@ -157,10 +131,10 @@ export default {
         from: 'John Doe',
         subject: 'Incredible',
         text: 'This is an incredible test message',
-      })
+      });
     },
   },
-}
+};
 </script>
 ```
 
@@ -168,9 +142,9 @@ export default {
 
 It is also possible to provide multiple message configurations by changing the `message` config into an array.
 
-```js
-// nuxt.config.js
-export default {
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
   modules: [
     ['nuxt-mail', {
       message: [
@@ -180,29 +154,29 @@ export default {
       ...
     }],
   ],
-}
+});
 ```
 
 Then you can reference the config like this:
 
-```js
+```ts
 mail.send({
   config: 'support',
   from: 'John Doe',
   subject: 'Incredible',
   text: 'This is an incredible test message',
-})
+});
 ```
 
 Or via index (in which case you do not need the `name` property):
 
-```js
+```ts
 mail.send({
   config: 1, // Resolves to 'support'
   from: 'John Doe',
   subject: 'Incredible',
   text: 'This is an incredible test message',
-})
+});
 ```
 
 Also, the module does not work for static sites (via `nuxt generate`) because the module creates a server route.
@@ -213,9 +187,9 @@ Also, the module does not work for static sites (via `nuxt generate`) because th
 
 You have to setup an [app-specific password](https://myaccount.google.com/apppasswords) to log into the SMTP server. Then, add the following config to your `nuxt-mail` config. Looks like there are multiple ways to configure Gmail, so it's best to try out the options:
 
-```js
-// nuxt.config.js
-export default {
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
   modules: [
     ['nuxt-mail', {
       smtp: {
@@ -227,12 +201,12 @@ export default {
       },
     }],
   ],
-}
+});
 ```
 
-```js
-// nuxt.config.js
-export default {
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
   modules: [
     ['nuxt-mail', {
       smtp: {
@@ -245,7 +219,7 @@ export default {
       },
     }],
   ],
-}
+});
 ```
 
 Missing something? Add your service here via a [pull request](https://github.com/dword-design/nuxt-mail/pulls).

package/dist/check-options.d.ts

@@ -0,0 +1,3 @@
+import type { MailOptions } from './types';
+declare const _default: (options: MailOptions) => void;
+export default _default;

package/dist/check-options.js

@@ -0,0 +1,11 @@
+export default options => {
+  if (!options.smtp) {
+    throw new Error("SMTP config is missing.");
+  }
+  if (options.message.length === 0) {
+    throw new Error("You have to provide at least one config.");
+  }
+  if (options.message.some(c => !c.to && !c.cc && !c.bcc)) {
+    throw new Error("You have to provide to/cc/bcc in all configs.");
+  }
+};

package/dist/module.d.ts

@@ -1,21 +1,8 @@
-import type { SendMailOptions, TransportOptions } from 'nodemailer';
-type Message = SendMailOptions & {
-    name?: string;
-};
-type MailOptions = {
-    message?: Message | Message[];
-    smtp: TransportOptions;
-};
-declare const _default: import("@nuxt/schema").NuxtModule<import("@nuxt/schema").ModuleOptions, import("@nuxt/schema").ModuleOptions, false>;
-export default _default;
+import type { MailOptionsInput } from './types';
 declare module '@nuxt/schema' {
-    interface NuxtConfig {
-        ['mail']?: MailOptions;
-    }
-    interface NuxtOptions {
-        ['mail']?: MailOptions;
-    }
     interface RuntimeConfig {
-        mail?: MailOptions;
+        mail: MailOptionsInput;
     }
 }
+declare const _default: import("@nuxt/schema").NuxtModule<MailOptionsInput, MailOptionsInput, false>;
+export default _default;

package/dist/module.js

@@ -1,45 +1,27 @@
-import P from "node:path";
-import { addImports, addPlugin, addServerHandler, addTemplate, createResolver, defineNuxtModule } from "@nuxt/kit";
-import fs from "fs-extra";
-import nuxtAliasPath from "nuxt-alias-path";
-import parsePackagejsonName from "parse-packagejson-name";
+import { addImports, addPlugin, addServerHandler, addServerPlugin, createResolver, defineNuxtModule, useRuntimeConfig } from "@nuxt/kit";
+import defu from "defu";
+import checkOptions from "./check-options.js";
+import normalizeOptions from "./normalize-options.js";
 const resolver = createResolver(import.meta.url);
-const packageConfig = fs.readJsonSync(resolver.resolve("../package.json"));
-const moduleName = parsePackagejsonName(packageConfig.name).fullName;
 export default defineNuxtModule({
-  setup: async (options, nuxt) => {
-    options = {
-      ...nuxt.options.runtimeConfig.mail,
-      ...nuxt.options.mail,
-      ...options
-    };
+  meta: {
+    compatibility: {
+      nuxt: ">=3.0.0"
+    },
+    configKey: "mail",
+    name: "nuxt-mail"
+  },
+  setup: (optionsInput, nuxt) => {
+    const options = defu(optionsInput, nuxt.options.runtimeConfig.mail, {
+      message: [],
+      smtp: null
+    });
+    nuxt.options.runtimeConfig.mail = normalizeOptions(options);
     if (!nuxt.options._prepare) {
-      if (!options.smtp) {
-        throw new Error("SMTP config is missing.");
-      }
-      if (Array.isArray(options.message) && options.message.length === 0 || !options.message) {
-        throw new Error("You have to provide at least one config.");
-      }
-    }
-    if (!Array.isArray(options.message)) {
-      options.message = [options.message];
-    }
-    if (!nuxt.options._prepare && options.message.some(c => !c.to && !c.cc && !c.bcc)) {
-      throw new Error("You have to provide to/cc/bcc in all configs.");
+      const resolvedOptions = normalizeOptions(useRuntimeConfig().mail);
+      checkOptions(resolvedOptions);
     }
-    addTemplate({
-      filename: P.join(moduleName, "options.mjs"),
-      getContents: () => `export default ${JSON.stringify(options, void 0, 2)}`,
-      write: true
-    });
-    const sendTemplatePathWithoutExt = resolver.resolve("./send");
-    const sendTemplatePath = (await fs.exists(`${sendTemplatePathWithoutExt}.ts`)) ? `${sendTemplatePathWithoutExt}.ts` : `${sendTemplatePathWithoutExt}.js`;
-    addTemplate({
-      filename: P.join(moduleName, "send.mjs"),
-      getContents: () => fs.readFile(sendTemplatePath, "utf8"),
-      write: true
-    });
-    nuxt.options.alias["#mail"] = nuxtAliasPath(moduleName, nuxt);
+    addServerPlugin(resolver.resolve("./server-plugin"));
     addServerHandler({
       handler: resolver.resolve("./server-handler.post"),
       route: "/mail/send"

package/dist/normalize-options.d.ts

@@ -0,0 +1,6 @@
+import type { MailOptionsInput } from './types';
+declare const _default: (options: MailOptionsInput) => {
+    message: import("./types").Message[];
+    smtp: import("nodemailer").TransportOptions;
+};
+export default _default;

package/dist/normalize-options.js

@@ -0,0 +1,10 @@
+const normalizeMessage = message => {
+  if (Array.isArray(message)) {
+    return message;
+  }
+  return [message];
+};
+export default options => ({
+  ...options,
+  message: normalizeMessage(options.message)
+});

package/dist/plugin.js

@@ -1,3 +1,4 @@
+import { FetchError } from "ofetch";
 import { defineNuxtPlugin } from "#imports";
 export default defineNuxtPlugin(() => ({
   provide: {
@@ -9,7 +10,10 @@ export default defineNuxtPlugin(() => ({
             method: "POST"
           });
         } catch (error) {
-          throw new Error(error.response._data.statusMessage);
+          if (error instanceof FetchError) {
+            throw new TypeError(error.response?._data.statusMessage);
+          }
+          throw error;
         }
       }
     }

package/dist/send.d.ts

@@ -1,2 +1,4 @@
-declare const _default: (body: any, options: any, transport: any) => Promise<void>;
+import type { Transporter } from 'nodemailer';
+import type { MailOptions, MessageWithConfigInput } from './types';
+declare const _default: (bodyInput: MessageWithConfigInput, options: MailOptions, transport: Transporter) => Promise<void>;
 export default _default;

package/dist/send.js

@@ -1,16 +1,24 @@
+import defu from "defu";
 import { omit } from "lodash-es";
-export default async (body, options, transport) => {
-  body = {
-    config: 0,
-    ...body
-  };
-  if (typeof body.config === "string") {
-    const configIndex = options.message.findIndex(_ => _.name === body.config);
+const resolveConfig = (bodyInput, options) => {
+  const bodyWithDefaults = defu(bodyInput, {
+    config: 0
+  });
+  if (typeof bodyWithDefaults.config === "string") {
+    const configIndex = options.message.findIndex(_ => _.name === bodyWithDefaults.config);
     if (configIndex === -1) {
-      throw new Error(`Message config with name '${body.config}' not found.`);
+      throw new Error(`Message config with name '${bodyWithDefaults.config}' not found.`);
     }
-    body.config = configIndex;
-  } else if (!options.message[body.config]) {
+    return {
+      ...bodyWithDefaults,
+      config: configIndex
+    };
+  }
+  return bodyWithDefaults;
+};
+export default async (bodyInput, options, transport) => {
+  const body = resolveConfig(bodyInput, options);
+  if (!options.message[body.config]) {
     throw new Error(`Message config not found at index ${body.config}.`);
   }
   await transport.sendMail({

package/dist/server-handler.post.js

@@ -1,15 +1,20 @@
 import { createError, defineEventHandler, readBody } from "h3";
 import nodemailer from "nodemailer";
-import options from "#mail/options.mjs";
-import send from "#mail/send.mjs";
-const transport = nodemailer.createTransport(options.smtp);
+import { useRuntimeConfig } from "#imports";
+import normalizeOptions from "./normalize-options.js";
+import send from "./send.js";
+const options = normalizeOptions(useRuntimeConfig().mail);
+let transport = null;
 export default defineEventHandler(async event => {
+  if (!transport) {
+    transport = nodemailer.createTransport(options.smtp);
+  }
   try {
     await send(await readBody(event), options, transport);
   } catch (error) {
     throw createError({
       statusCode: 500,
-      statusMessage: error.message
+      statusMessage: error instanceof Error ? error.message : String(error)
     });
   }
   return "";

package/dist/server-plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("nitropack").NitroAppPlugin;
+export default _default;

package/dist/server-plugin.js

@@ -0,0 +1,6 @@
+import { defineNitroPlugin } from "nitropack/runtime";
+import { useRuntimeConfig } from "#imports";
+import checkOptions from "./check-options.js";
+import normalizeOptions from "./normalize-options.js";
+const options = normalizeOptions(useRuntimeConfig().mail);
+export default defineNitroPlugin(() => checkOptions(options));

package/dist/types.d.ts

@@ -0,0 +1,29 @@
+import type { SendMailOptions, TransportOptions } from 'nodemailer';
+
+export interface MailOptions {
+  message: Message[];
+  smtp: TransportOptions | null;
+}
+
+export interface Message extends Omit<SendMailOptions, 'to' | 'cc' | 'bcc'> {
+  to: SendMailOptions['to'];
+  cc: SendMailOptions['cc'];
+  bcc: SendMailOptions['bcc'];
+  name?: string;
+}
+
+export interface MailOptionsInput extends Omit<MailOptions, 'message'> {
+  message: MailOptions['message'] | Message;
+  smtp: TransportOptions;
+}
+
+export interface MessageWithConfig extends Message {
+  config: number;
+}
+
+export interface MessageWithConfigInput extends Omit<
+  MessageWithConfig,
+  'config'
+> {
+  config?: MessageWithConfig['config'] | string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-mail",
-  "version": "7.0.1",
+  "version": "8.0.0",
   "description": "Adds email sending capability to a Nuxt.js app. Adds a server route, an injected variable, and uses nodemailer to send emails.",
   "keywords": [
     "email",
@@ -26,10 +26,8 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "default": "./dist/module.js",
-        "types": "./dist/module.d.ts"
-      }
+      "default": "./dist/module.js",
+      "types": "./dist/module.d.ts"
     }
   },
   "main": "dist/module.js",
@@ -49,34 +47,38 @@
     "verify": "base verify"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.17.4",
-    "fs-extra": "^11.3.0",
-    "h3": "^1.15.3",
+    "@nuxt/kit": "^4.2.1",
+    "defu": "^6.1.4",
     "lodash-es": "^4.17.21",
-    "nodemailer": "^7.0.3",
-    "nuxt-alias-path": "^2.0.0",
-    "parse-packagejson-name": "^1.0.1"
+    "nodemailer": "^7.0.11"
   },
   "devDependencies": {
-    "@dword-design/base": "^15.1.2",
-    "@dword-design/base-config-nuxt-module": "^3.0.0",
-    "@playwright/browser-chromium": "^1.54.1",
-    "@playwright/test": "^1.54.1",
-    "@types/nodemailer": "^6.4.17",
-    "axios": "^1.9.0",
+    "@dword-design/base": "^16.1.4",
+    "@dword-design/base-config-nuxt-module": "^5.0.0",
+    "@playwright/browser-chromium": "^1.57.0",
+    "@playwright/test": "^1.57.0",
+    "@types/fs-extra": "^11.0.4",
+    "@types/lodash-es": "^4.17.12",
+    "@types/nodemailer": "^7.0.4",
+    "axios": "^1.13.2",
     "endent": "npm:@dword-design/endent@^1.4.7",
-    "execa": "^9.6.0",
+    "execa": "^9.6.1",
     "get-port": "^7.1.0",
-    "nuxt": "^3.17.4",
+    "nuxt": "^4.2.1",
     "nuxt-dev-ready": "^5.0.1",
     "output-files": "^3.0.0",
-    "port-ready": "^0.1.0",
+    "port-ready": "npm:@dword-design/port-ready-fork@^0.0.3",
     "smtp-tester": "npm:@dword-design/smtp-tester-fork@^0.0.1",
     "tree-kill-promise": "^4.0.0"
   },
+  "peerDependencies": {
+    "h3": "*",
+    "nitropack": "*",
+    "ofetch": "*"
+  },
   "packageManager": "pnpm@10.13.1+sha512.37ebf1a5c7a30d5fabe0c5df44ee8da4c965ca0c5af3dbab28c3a1681b70a256218d05c81c9c0dcf767ef6b8551eb5b960042b9ed4300c59242336377e01cfad",
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "publishConfig": {
     "access": "public"