nuxt-mail 6.0.2 → 7.0.0

package/README.md

@@ -3,49 +3,49 @@
 <!-- /TITLE -->
 
 <!-- BADGES/ -->
-  <p>
-    <a href="https://npmjs.org/package/nuxt-mail">
-      <img
-        src="https://img.shields.io/npm/v/nuxt-mail.svg"
-        alt="npm version"
-      >
-    </a><img src="https://img.shields.io/badge/os-linux%20%7C%C2%A0macos%20%7C%C2%A0windows-blue" alt="Linux macOS Windows compatible"><a href="https://github.com/dword-design/nuxt-mail/actions">
-      <img
-        src="https://github.com/dword-design/nuxt-mail/workflows/build/badge.svg"
-        alt="Build status"
-      >
-    </a><a href="https://codecov.io/gh/dword-design/nuxt-mail">
-      <img
-        src="https://codecov.io/gh/dword-design/nuxt-mail/branch/master/graph/badge.svg"
-        alt="Coverage status"
-      >
-    </a><a href="https://david-dm.org/dword-design/nuxt-mail">
-      <img src="https://img.shields.io/david/dword-design/nuxt-mail" alt="Dependency status">
-    </a><img src="https://img.shields.io/badge/renovate-enabled-brightgreen" alt="Renovate enabled"><br/><a href="https://gitpod.io/#https://github.com/dword-design/nuxt-mail">
-      <img
-        src="https://gitpod.io/button/open-in-gitpod.svg"
-        alt="Open in Gitpod"
-        width="114"
-      >
-    </a><a href="https://www.buymeacoffee.com/dword">
-      <img
-        src="https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg"
-        alt="Buy Me a Coffee"
-        width="114"
-      >
-    </a><a href="https://paypal.me/SebastianLandwehr">
-      <img
-        src="https://sebastianlandwehr.com/images/paypal.svg"
-        alt="PayPal"
-        width="163"
-      >
-    </a><a href="https://www.patreon.com/dworddesign">
-      <img
-        src="https://sebastianlandwehr.com/images/patreon.svg"
-        alt="Patreon"
-        width="163"
-      >
-    </a>
+<p>
+  <a href="https://npmjs.org/package/nuxt-mail">
+    <img
+      src="https://img.shields.io/npm/v/nuxt-mail.svg"
+      alt="npm version"
+    >
+  </a><img src="https://img.shields.io/badge/os-linux%20%7C%C2%A0macos%20%7C%C2%A0windows-blue" alt="Linux macOS Windows compatible"><a href="https://github.com/dword-design/nuxt-mail/actions">
+    <img
+      src="https://github.com/dword-design/nuxt-mail/workflows/build/badge.svg"
+      alt="Build status"
+    >
+  </a><a href="https://codecov.io/gh/dword-design/nuxt-mail">
+    <img
+      src="https://codecov.io/gh/dword-design/nuxt-mail/branch/master/graph/badge.svg"
+      alt="Coverage status"
+    >
+  </a><a href="https://david-dm.org/dword-design/nuxt-mail">
+    <img src="https://img.shields.io/david/dword-design/nuxt-mail" alt="Dependency status">
+  </a><img src="https://img.shields.io/badge/renovate-enabled-brightgreen" alt="Renovate enabled"><br/><a href="https://gitpod.io/#https://github.com/dword-design/nuxt-mail">
+    <img
+      src="https://gitpod.io/button/open-in-gitpod.svg"
+      alt="Open in Gitpod"
+      width="114"
+    >
+  </a><a href="https://www.buymeacoffee.com/dword">
+    <img
+      src="https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg"
+      alt="Buy Me a Coffee"
+      width="114"
+    >
+  </a><a href="https://paypal.me/SebastianLandwehr">
+    <img
+      src="https://sebastianlandwehr.com/images/paypal.svg"
+      alt="PayPal"
+      width="163"
+    >
+  </a><a href="https://www.patreon.com/dworddesign">
+    <img
+      src="https://sebastianlandwehr.com/images/patreon.svg"
+      alt="Patreon"
+      width="163"
+    >
+  </a>
 </p>
 <!-- /BADGES -->
 
@@ -164,53 +164,6 @@ export default {
 </script>
 ```
 
-## Nuxt 2
-
-For Nuxt 2, you need to install [@nuxtjs/axios](https://www.npmjs.com/package/@nuxtjs/axios) and add it to your module list before `nuxt-mail`:
-
-```js
-// nuxt.config.js
-export default {
-  modules: [
-    [
-      '@nuxtjs/axios',
-      ['nuxt-mail', { /* ... */ }],
-    }],
-  ],
-}
-```
-
-Then you can use the injected variable like so:
-
-```html
-<script>
-export default {
-  methods: {
-    sendEmail() {
-      this.$mail.send({
-        from: 'John Doe',
-        subject: 'Incredible',
-        text: 'This is an incredible test message',
-      })
-    },
-  },
-}
-</script>
-```
-
-### Note about production use
-
-When you use `nuxt-mail` in production and you configured a reverse proxy that hides your localhost behind a domain, you need to tell `@nuxt/axios` which base URL you are using. Otherwise `nuxt-mail` won't find the send route. Refer to [@nuxt/axios options](https://axios.nuxtjs.org/options) on how to do that. The easiest option is to set the `API_URL` environment variable, or set something else in your `nuxt.config.js`:
-
-```js
-// nuxt.config.js
-export default {
-  axios: {
-    baseURL: process.env.BASE_URL,
-  },
-}
-```
-
 ## Multiple message configs
 
 It is also possible to provide multiple message configurations by changing the `message` config into an array.

package/dist/composable.d.ts

@@ -0,0 +1 @@
+export declare const useMail: () => any;

package/dist/composable.js

@@ -1,2 +1,2 @@
-import { useNuxtApp } from '#imports';
+import { useNuxtApp } from "#imports";
 export const useMail = () => useNuxtApp().$mail;

package/dist/module.d.ts

@@ -0,0 +1,21 @@
+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;
+declare module '@nuxt/schema' {
+    interface NuxtConfig {
+        ['mail']?: MailOptions;
+    }
+    interface NuxtOptions {
+        ['mail']?: MailOptions;
+    }
+    interface RuntimeConfig {
+        mail?: MailOptions;
+    }
+}

package/dist/module.js

@@ -0,0 +1,53 @@
+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";
+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
+    };
+    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.");
+    }
+    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);
+    addServerHandler({
+      handler: resolver.resolve("./server-handler.post"),
+      route: "/mail/send"
+    });
+    addImports([{
+      from: resolver.resolve("./composable"),
+      name: "useMail"
+    }]);
+    addPlugin(resolver.resolve(`./plugin`));
+  }
+});

package/dist/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/plugin.js

@@ -1,12 +1,12 @@
-import { defineNuxtPlugin } from '#imports';
+import { defineNuxtPlugin } from "#imports";
 export default defineNuxtPlugin(() => ({
   provide: {
     mail: {
       send: async config => {
         try {
-          await $fetch('/mail/send', {
+          await $fetch("/mail/send", {
             body: config,
-            method: 'POST'
+            method: "POST"
           });
         } catch (error) {
           throw new Error(error.response._data.statusMessage);

package/dist/send.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (body: any, options: any, transport: any) => Promise<void>;
+export default _default;

package/dist/send.js

@@ -1,11 +1,11 @@
-import { findIndex, omit } from '@dword-design/functions';
+import { omit } from "lodash-es";
 export default async (body, options, transport) => {
   body = {
     config: 0,
     ...body
   };
-  if (typeof body.config === 'string') {
-    const configIndex = findIndex(_ => _.name === body.config)(options.message);
+  if (typeof body.config === "string") {
+    const configIndex = options.message.findIndex(_ => _.name === body.config);
     if (configIndex === -1) {
       throw new Error(`Message config with name '${body.config}' not found.`);
     }
@@ -14,7 +14,7 @@ export default async (body, options, transport) => {
     throw new Error(`Message config not found at index ${body.config}.`);
   }
   await transport.sendMail({
-    ...omit(['config', 'to', 'cc', 'bcc'])(body),
-    ...omit(['name'])(options.message[body.config])
+    ...omit(body, ["config", "to", "cc", "bcc"]),
+    ...omit(options.message[body.config], ["name"])
   });
 };

package/dist/server-handler.post.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<string>>;
+export default _default;

package/dist/server-handler.post.js

@@ -1,7 +1,7 @@
-import { createError, defineEventHandler, readBody } from 'h3';
-import nodemailer from 'nodemailer';
-import options from '#mail/options.mjs';
-import send from '#mail/send.mjs';
+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);
 export default defineEventHandler(async event => {
   try {
@@ -12,5 +12,5 @@ export default defineEventHandler(async event => {
       statusMessage: error.message
     });
   }
-  return '';
+  return "";
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-mail",
-  "version": "6.0.2",
+  "version": "7.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",
@@ -24,8 +24,15 @@
   "license": "MIT",
   "author": "Sebastian Landwehr <info@sebastianlandwehr.com>",
   "type": "module",
-  "exports": "./dist/index.js",
-  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "default": "./dist/module.js",
+        "types": "./dist/module.d.ts"
+      }
+    }
+  },
+  "main": "dist/module.js",
   "files": [
     "dist"
   ],
@@ -37,37 +44,39 @@
     "lint": "base lint",
     "prepare": "base prepare",
     "prepublishOnly": "base prepublishOnly",
-    "test": "base test"
+    "test": "base test",
+    "typecheck": "base typecheck",
+    "verify": "base verify"
   },
   "dependencies": {
-    "@dword-design/functions": "^6.0.2",
     "@nuxt/kit": "^3.17.4",
     "fs-extra": "^11.3.0",
     "h3": "^1.15.3",
+    "lodash-es": "^4.17.21",
     "nodemailer": "^7.0.3",
     "nuxt-alias-path": "^2.0.0",
-    "nuxt-push-plugins": "^2.1.34",
     "parse-packagejson-name": "^1.0.1"
   },
   "devDependencies": {
-    "@dword-design/base": "^12.0.5",
-    "@dword-design/base-config-nuxt-module": "^1.0.3",
+    "@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",
+    "endent": "npm:@dword-design/endent@^1.4.7",
     "execa": "^9.6.0",
     "get-port": "^7.1.0",
     "nuxt": "^3.17.4",
-    "nuxt-dev-ready": "^3.0.0",
-    "output-files": "^2.0.32",
-    "playwright": "^1.52.0",
-    "playwright-chromium": "^1.52.0",
+    "nuxt-dev-ready": "^5.0.1",
+    "output-files": "^3.0.0",
     "port-ready": "^0.1.0",
-    "smtp-tester": "^2.1.0",
-    "tree-kill-promise": "^3.0.14",
-    "with-local-tmp-dir": "^5.1.1"
+    "smtp-tester": "npm:@dword-design/smtp-tester-fork@^0.0.1",
+    "tree-kill-promise": "^4.0.0"
   },
   "packageManager": "pnpm@10.8.1+sha512.c50088ba998c67b8ca8c99df8a5e02fd2ae2e2b29aaf238feaa9e124248d3f48f9fb6db2424949ff901cffbb5e0f0cc1ad6aedb602cd29450751d11c35023677",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "publishConfig": {
     "access": "public"

package/dist/index.js

@@ -1,49 +0,0 @@
-import P from 'node:path';
-import { some } from '@dword-design/functions';
-import { addImports, addServerHandler, addTemplate, createResolver } from '@nuxt/kit';
-import fs from 'fs-extra';
-import nuxtAliasPath from 'nuxt-alias-path';
-import nuxtPushPlugins from 'nuxt-push-plugins';
-import parsePackagejsonName from 'parse-packagejson-name';
-const resolver = createResolver(import.meta.url);
-const packageConfig = fs.readJsonSync(resolver.resolve('../package.json'));
-const moduleName = parsePackagejsonName(packageConfig.name).fullName;
-export default (options, nuxt) => {
-  options = {
-    ...nuxt.options.runtimeConfig.mail,
-    ...nuxt.options.mail,
-    ...options
-  };
-  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 (some(c => !c.to && !c.cc && !c.bcc)(options.message)) {
-    throw new Error('You have to provide to/cc/bcc in all configs.');
-  }
-  addTemplate({
-    filename: P.join(moduleName, 'options.mjs'),
-    getContents: () => `export default ${JSON.stringify(options, undefined, 2)}`,
-    write: true
-  });
-  addTemplate({
-    filename: P.join(moduleName, 'send.mjs'),
-    getContents: () => fs.readFile(resolver.resolve('./send.js'), 'utf8'),
-    write: true
-  });
-  nuxt.options.alias['#mail'] = nuxtAliasPath(moduleName, nuxt);
-  addServerHandler({
-    handler: resolver.resolve('./server-handler.post.js'),
-    route: '/mail/send'
-  });
-  addImports([{
-    from: resolver.resolve('./composable.js'),
-    name: 'useMail'
-  }]);
-  nuxtPushPlugins(nuxt, resolver.resolve(`./plugin.js`));
-};