@storecraft/mailer-smtp 1.0.1

package/README.md

@@ -0,0 +1,45 @@
+# SMTP proxy client for Node.js
+
+<div style="text-align:center">
+  <img src='https://storecraft.app/storecraft-color.svg' 
+       width='90%' />
+</div><hr/><br/>
+
+## Features
+- Send emails using a known smtp server
+- uses `nodemailer` under the hood
+
+```bash
+npm i @storecraft/mailer-smtp
+```
+
+## Howto
+
+```js
+import { MailerSmtpNode } from '@storecraft/mailer-smtp';
+
+const mailer = new MailerSmtpNode(
+  {
+    host: "smtp.sendgrid.net",
+    port: 465,
+    secure: true, // true for 465, false for other ports
+    auth: {
+      user: 'apikey', // generated ethereal user
+      pass: process.env.SEND_GRID_SECRET, // generated ethereal password
+    },  
+  }
+);
+
+let { success, native_response } = await mailer.email({
+  from: {name: 'bob 👻', address: process.env.FROM_EMAIL }, // sender address
+  to: [ { address: process.env.TO_EMAIL } ], // list of receivers
+  subject: 'subject test', // Subject line
+  text: 'plain text test', // plain text body
+  html: '<p>html test</p>', // html body
+});
+
+```
+
+```text
+Author: Tomer Shalev (tomer.shalev@gmail.com)
+```

package/index.js

@@ -0,0 +1,77 @@
+import nodemailer from "nodemailer"
+import SMTPTransport from "nodemailer/lib/smtp-transport/index.js";
+import { attachment_convert } from "./index.utils.js";
+
+/**
+ * @typedef {nodemailer.Transporter<SMTPTransport.SentMessageInfo>} NodemailerClient
+ * @typedef {import("./types.public.d.ts").Config} Config
+ * @typedef {import('@storecraft/core/mailer').mailer<Config>} mailer
+ * @implements {mailer}
+ * 
+ * mailer with nodemailer for node.js
+ */
+export class MailerSmtpNode {
+  
+  /** @type {Config} */ #_config;
+  /** @type {NodemailerClient} */ #_client;
+
+  /**
+   * 
+   * @param {Config} config 
+   */
+  constructor(config) {
+    this.#_config = config;
+    this.#_client = nodemailer.createTransport(
+      config
+    );
+  }
+
+  get config() { return this.#_config; }
+  get client() { return this.#_client; }
+
+  /**
+   * 
+   * @type {mailer["email"]}
+   */
+  async email(o) {
+    let r;
+    try {
+      r = await this.client.sendMail(
+        {
+          from: { address: o.from.address, name: o.from.name ?? ''},
+          to: o.to.map(
+            t => (
+              {
+                address: t.address, 
+                name: t.name ?? ''
+              }
+            )
+          ),
+          subject: o.subject,
+          text: o.text,
+          html: o.html, 
+          attachments: o.attachments?.map(
+            a => (
+              {
+                cid: a.content_id, 
+                contentDisposition: a.disposition, 
+                filename: a.filename,
+                contentType: a.content_type, 
+                content: attachment_convert(a.content)
+              }
+            )
+          )
+        }
+      );
+    } catch(e) {
+      console.log(e);
+    }
+
+    return {
+      success: Boolean(r),
+      native_response: r
+    }
+  }
+
+}
+

package/index.utils.js

@@ -0,0 +1,15 @@
+import { Readable } from 'node:stream'
+
+/**
+ * convert:
+ * - arraybuffer -> Buffer
+ * - readablestream -> readable
+ * @param {import('@storecraft/core/mailer').MailObject["attachments"][0]["content"]} c 
+ */
+export const attachment_convert = c => {
+  if(c instanceof ArrayBuffer)
+    return Buffer.from(c);
+  else if(c instanceof ReadableStream)
+    return Readable.fromWeb(c);
+  else return c;
+} 

package/jsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "maxNodeModuleJsDepth": 10,
+    "checkJs": true,
+    "moduleResolution": "NodeNext",
+    "module": "NodeNext",
+    "composite": true,
+  },
+  "include": ["*", "*/*", "src/*"]
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@storecraft/mailer-smtp",
+  "version": "1.0.1",
+  "description": "Official SMTP email provider for node, deno and bun for storecraft",
+  "license": "MIT",
+  "author": "Tomer Shalev (https://github.com/store-craft)",
+  "homepage": "https://github.com/store-craft/storecraft",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/store-craft/storecraft.git",
+    "directory": "packages/mailers/mailer-smtp"
+  },
+  "keywords": [
+    "commerce",
+    "dashboard",
+    "code",
+    "storecraft"
+  ],
+  "type": "module",
+  "main": "index.js",
+  "types": "./types.public.d.ts",
+  "scripts": {
+    "mailer-smtp:test": "uvu -c",
+    "mailer-smtp:publish": "npm publish --access public"
+  },
+  "dependencies": {
+    "nodemailer": "^6.9.9"
+  },
+  "devDependencies": {
+    "@storecraft/core": "^1.0.0",
+    "@types/nodemailer": "^6.4.14",
+    "@types/node": "^20.11.0",
+    "uvu": "^0.5.6",
+    "dotenv": "^16.3.1"
+  }
+}

package/tests/test.js

@@ -0,0 +1,32 @@
+import 'dotenv/config';
+import { test } from 'uvu';
+import * as assert from 'uvu/assert';
+import { MailerSmtpNode } from '../index.js';
+
+const mailer = new MailerSmtpNode(
+  {
+    host: "smtp.sendgrid.net",
+    port: 465,
+    secure: true, // true for 465, false for other ports
+    auth: {
+      user: 'apikey', // generated ethereal user
+      pass: process.env.SEND_GRID_SECRET, // generated ethereal password
+    },  
+  }
+)
+
+test('send email', async () => {
+  
+  let { success, native_response } = await mailer.email({
+    from: {name: 'bob 👻', address: process.env.FROM_EMAIL }, // sender address
+    to: [ { address: process.env.TO_EMAIL } ], // list of receivers
+    subject: 'nodemailer test', // Subject line
+    text: 'nodemailer test text', // plain text body
+    html: '<p>nodemailer test html</p>', // html body
+  });
+
+  assert.ok(success, `failed with native_response ${JSON.stringify(native_response, null, 2)}`)
+  
+});
+
+test.run();

package/types.public.d.ts

@@ -0,0 +1,9 @@
+import SMTPTransport from 'nodemailer/lib/smtp-transport/index.js';
+
+export { MailerSmtpNode } from './index.js';
+
+/**
+ * @description nodemailer config
+ */
+export type Config = SMTPTransport.Options;
+