@arkstack/notifications 0.17.3 → 0.17.5

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { DotPath, DotPathValue, MergedConfig } from "@arkstack/common";
 import { Transporter } from "nodemailer";
 import { Model } from "@arkstack/database";
+import { Logger } from "nodemailer/lib/shared/index.js";
 import { User } from "@app/models/User";
 import { User as User$1 } from "@arkstack/auth";
 import { PhoneNumber } from "@kanun-hq/plugin-phone";
@@ -33,15 +34,26 @@ type SmsDriverName = 'africastalking' | 'twilio';
 type RealtimeDriverName = 'pusher' | 'firebase';
 type NotificationChannel = 'mail' | 'sms' | 'db' | 'realtime';
 type MailDriverOptions = {
-  transport?: 'africastalking' | 'twilio' | 'file' | 'smtp';
+  transport?: 'file' | 'smtp' | 'sendmail' | 'ses';
+  url?: string;
   host?: string;
   port?: number;
-  secure?: boolean;
   user?: string;
   pass?: string;
   from?: string;
-  testAddress?: string;
+  debug?: boolean;
+  logger?: boolean | Logger;
+  secure?: boolean;
+  service?: string;
+  sesRegion?: string;
   directory?: string;
+  ignoreTLS?: boolean;
+  requireTLS?: boolean;
+  authMethod?: 'PLAIN' | 'LOGIN' | 'CRAM-MD5';
+  testAddress?: string;
+  sendmailArgs?: string[];
+  sendmailPath?: string;
+  transactionLog?: boolean;
 };
 type SmsDriverOptions = {
   transport?: SmsDriverName;
@@ -118,7 +130,7 @@ interface NotificationConfig {
   default_driver: 'mail' | 'sms' | 'db';
   drivers: {
     mail: {
-      transport: 'smtp' | 'file';
+      transport: 'smtp' | 'file' | 'sendmail' | 'ses';
       from: string | {
         name: string;
         address: string;
@@ -140,28 +152,42 @@ interface NotificationConfig {
     };
   };
   transports: {
-    smtp: {
+    smtp: ({
       host: string;
       port: number;
       secure: boolean;
+      debug?: boolean;
+      logger?: boolean | Logger;
+      service?: string;
+      ignore_tls?: boolean;
+      require_tls?: boolean;
+      auth_method?: 'PLAIN' | 'LOGIN' | 'CRAM-MD5';
+      test_address?: string;
+      transaction_log?: boolean;
+    } & ({
       auth: {
         user: string;
         pass: string;
       };
       user?: string;
       pass?: string;
-      test_address?: string;
     } | {
-      host: string;
-      port: number;
-      secure: boolean;
       auth?: {
         user: string;
         pass: string;
       };
       user: string;
       pass: string;
-      test_address?: string;
+    })) | {
+      url: string;
+    };
+    ses?: {
+      region: string;
+      [key: string]: any;
+    };
+    sendmail?: {
+      path?: string;
+      args?: string[];
     };
     file: {
       directory: string;
@@ -196,7 +222,7 @@ interface NotificationConfig {
     };
   };
 }
-type MergedTransportConfig = MergedConfig<NotificationConfig['transports'][NonNullable<MailDriverOptions['transport']>]>;
+type MergedTransportConfig = MergedConfig<Required<NotificationConfig['transports']>[NonNullable<MailDriverOptions['transport']>]>;
 //#endregion
 //#region src/Contracts/NotificationContract.d.ts
 declare abstract class NotificationContract<TResult = DriverResult> {
@@ -244,14 +270,22 @@ declare class DbNotification extends NotificationContract<UserNotification> {
 //#region src/drivers/MailNotification.d.ts
 declare class MailNotification extends NotificationContract {
   driver: Transporter;
+  private options;
+  private ViewName;
+  private transport;
+  private sesOptions?;
+  private recipients?;
   private fromAddress?;
   private subjectLine?;
-  private recipients?;
-  private ViewName;
+  private driverConfig;
   private htmlTemplate?;
   private textTemplate?;
   private fileDirectory?;
   constructor(options?: MailDriverOptions);
+  /**
+   * Prepare the mail driver so we can use it to relay the message
+   */
+  private prepareDriver;
   from(from: string): this;
   /**
    * The email subject
@@ -439,7 +473,7 @@ declare class Notification<D extends keyof DriverMap = keyof DriverMap> {
   static sms(options?: SmsDriverOptions): SmsNotification;
   static db(): DbNotification;
   static realtime(options?: RealtimeDriverOptions): RealtimeNotification;
-  static channel(channel?: NotificationChannel | 'email', options?: DriverOptions): RealtimeNotification | SmsNotification | MailNotification | DbNotification;
+  static channel(channel?: NotificationChannel | 'email', options?: DriverOptions): MailNotification | SmsNotification | DbNotification | RealtimeNotification;
   prepare(recipient?: null | MailRecipient | NotificationRecipient | User, data?: NotificationData): DriverMap[D];
   private static createDriver;
 }

package/dist/index.js

@@ -201,41 +201,89 @@ const configure = (key, defaultValue) => {
 //#region src/drivers/MailNotification.ts
 var MailNotification = class extends NotificationContract {
 	driver;
+	options = {};
+	ViewName = "~arkstack/notifications.mail";
+	transport = "smtp";
+	sesOptions;
+	recipients;
 	fromAddress;
 	subjectLine;
-	recipients;
-	ViewName = "~arkstack/notifications.mail";
+	driverConfig;
 	htmlTemplate;
 	textTemplate;
 	fileDirectory;
 	constructor(options = {}) {
 		super();
-		const driver = configure("drivers.mail", {});
-		const trpt = driver.transport ?? "smtp";
-		const transport = configure(`transports.${trpt}`, {});
-		if (trpt === "file") {
+		this.driverConfig = configure("drivers.mail", {});
+		this.transport = this.driverConfig.transport ?? "smtp";
+		this.options = options;
+	}
+	/**
+	* Prepare the mail driver so we can use it to relay the message
+	*/
+	async prepareDriver() {
+		const options = this.options;
+		const transport = configure(`transports.${this.transport}`, {});
+		/**
+		* Setup nodemailer to stream messages so we can store the mail to file
+		*/
+		if (this.transport === "file") {
 			this.fileDirectory = options.directory ?? transport.directory ?? env("MAIL_FILE_PATH", join(Arkstack.rootDir(), "./storage/framework/mails"));
-			this.fromAddress = options.from ?? driver.from ?? transport.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
+			this.fromAddress = options.from ?? this.driverConfig.from ?? transport.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
 			this.driver = nodemailer.createTransport({
 				streamTransport: true,
 				buffer: true
 			});
 			return;
 		}
-		const host = options.host ?? transport.host ?? env("MAIL_HOST", "localhost");
-		const port = options.port ?? transport.port ?? env("MAIL_PORT", 1025);
-		const secure = options.secure ?? transport.secure ?? env("MAIL_SECURE", false);
+		/**
+		* Setup nodemailer to use sendmail
+		*/
+		if (this.transport === "sendmail") {
+			const path = transport.path ?? options.sendmailPath ?? env("MAIL_SENDMAIL_PATH", "/usr/sbin/sendmail");
+			this.driver = nodemailer.createTransport({
+				path,
+				sendmail: true,
+				args: transport.args ?? options.sendmailArgs
+			});
+			return;
+		}
+		/**
+		* Setup nodemailer to use Amazon SES
+		*/
+		if (this.transport === "ses") {
+			try {
+				const { SESv2Client, SendEmailCommand } = await import("@aws-sdk/client-sesv2");
+				const { region, ...sesOptions } = transport;
+				const sesClient = new SESv2Client({ region: options.sesRegion ?? region ?? env("MAIL_SES_REGION") ?? env("AWS_DEFAULT_REGION") });
+				this.sesOptions = sesOptions;
+				this.driver = nodemailer.createTransport({ SES: {
+					sesClient,
+					SendEmailCommand
+				} });
+			} catch (error) {
+				throw new Error("Please install \"@aws-sdk/client-sesv2\" to use the ses transport", { cause: error });
+			}
+			return;
+		}
 		const user = options.user ?? transport.auth?.user ?? transport.user ?? env("MAIL_USERNAME", "");
 		const pass = options.pass ?? transport.auth?.pass ?? transport.pass ?? env("MAIL_PASSWORD", "");
-		this.fromAddress = options.from ?? driver.from ?? transport.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
+		this.fromAddress = options.from ?? this.driverConfig.from ?? transport.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
 		this.driver = nodemailer.createTransport({
-			host,
-			port: Number(port),
-			secure: Boolean(secure),
+			url: transport.url ?? options.url ?? env("MAIL_URL"),
+			host: options.host ?? transport.host ?? env("MAIL_HOST", "localhost"),
+			port: Number(options.port ?? transport.port ?? env("MAIL_PORT", 1025)),
 			auth: user || pass ? {
 				user,
 				pass
-			} : void 0
+			} : void 0,
+			debug: transport.debug ?? options.debug ?? env("MAIL_DEBUG", false),
+			secure: Boolean(options.secure ?? transport.secure ?? env("MAIL_SECURE", false)),
+			logger: transport.logger ?? options.logger ?? env("MAIL_LOGGER", false),
+			service: transport.service ?? options.service ?? env("MAIL_SERVICE"),
+			ignoreTLS: transport.ignore_tls ?? options.ignoreTLS ?? env("MAIL_IGNORE_TLS"),
+			requireTLS: transport.require_tls ?? options.requireTLS ?? env("MAIL_REQUIRE_TLS"),
+			authMethod: transport.auth_method ?? options.authMethod ?? env("MAIL_AUTH_METHOD")
 		});
 	}
 	from(from) {
@@ -321,6 +369,7 @@ var MailNotification = class extends NotificationContract {
 		const resolvedMessage = interpolate(message, mergedData);
 		const to = this.resolveRecipients(recipient);
 		if (to.length < 1) throw new Error("No recipient provided for mail notification");
+		await this.prepareDriver();
 		const templateData = {
 			...mergedData,
 			message: resolvedMessage,
@@ -337,6 +386,7 @@ var MailNotification = class extends NotificationContract {
 			}),
 			html: this.htmlTemplate ? interpolate(this.htmlTemplate, templateData) : await globalThis.view(this.ViewName, templateData)
 		};
+		if (this.transport === "ses") payload.ses = this.sesOptions;
 		const result = await this.driver.sendMail(payload);
 		if (this.fileDirectory) await this.storeFileMail(payload, result);
 		return result;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.17.3",
+  "version": "0.17.5",
   "type": "module",
   "description": "Framework-agnostic notification module for Arkstack and Nodejs, providing support for multi-channel notification delivery.",
   "homepage": "https://arkstack.toneflix.net/guide/notifications",
@@ -34,14 +34,14 @@
     "africastalking": "^0.8.0",
     "nodemailer": "^8.0.7",
     "twilio": "^6.0.0",
-    "@arkstack/common": "^0.17.3"
+    "@arkstack/common": "^0.17.5"
   },
   "peerDependencies": {
     "@kanun-hq/plugin-phone": "^0.1.8",
     "firebase-admin": "^13.0.0",
     "pusher": "^5.2.0",
-    "@arkstack/contract": "^0.17.3",
-    "@arkstack/database": "^0.17.3"
+    "@arkstack/contract": "^0.17.5",
+    "@arkstack/database": "^0.17.5"
   },
   "peerDependenciesMeta": {
     "pusher": {