@arkstack/notifications 0.17.10 → 0.17.12

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import { DotPath, DotPathValue, MergedConfig } from "@arkstack/common";
-import { Transport, Transporter } from "nodemailer";
+import { TransportOptions, Transporter } from "nodemailer";
 import { Model } from "@arkstack/database";
 import { Logger } from "nodemailer/lib/shared/index.js";
+import MailMessage from "nodemailer/lib/mailer/mail-message.js";
 import { User } from "@app/models/User";
 import { User as User$1 } from "@arkstack/auth";
 import { PhoneNumber } from "@kanun-hq/plugin-phone";
@@ -33,6 +34,15 @@ type NotificationData = Record<string, unknown>;
 type SmsDriverName = 'africastalking' | 'twilio';
 type RealtimeDriverName = 'pusher' | 'firebase';
 type NotificationChannel = 'mail' | 'sms' | 'db' | 'realtime';
+interface Transport<T = any, D extends TransportOptions = TransportOptions> {
+  mailer?: Transporter<T, D> | undefined;
+  name: string;
+  version: string;
+  send(mail: MailMessage<T>, callback: (err: Error | null, info: T) => void): void;
+  verify?(callback: (err: Error | null, success: true) => void): void;
+  verify?(): Promise<true>;
+  close?(): void;
+}
 type MailDriverOptions = {
   transport?: 'file' | 'smtp' | 'sendmail' | 'ses';
   url?: string;
@@ -648,4 +658,4 @@ declare const configure: <T extends DotPath<NotificationConfig>>(key: T, default
 //#region src/utils/template.d.ts
 declare const interpolate: (value: string, data?: NotificationData) => string;
 //#endregion
-export { AfricasTalkingSmsDriver, DbNotification, DbNotificationPayload, DbNotificationType, DriverResult, FirebaseMulticastResult, FirebaseRealtimeDriver, FirebaseTransportConfig, MailDriverOptions, MailNotification, MailNotificationOptions, MailRecipient, MailRecipientAddress, MergedTransportConfig, Notification, NotificationChannel, NotificationConfig, NotificationContract, NotificationData, NotificationDriverMap, NotificationRecipient, PusherRealtimeDriver, PusherTransportConfig, RealtimeBroadcastResult, RealtimeDriver, RealtimeDriverName, RealtimeDriverOptions, RealtimeNotification, RealtimeNotificationDriver, RealtimeNotificationPayload, SmsDriverName, SmsDriverOptions, SmsNotification, TwilioSmsDriver, UserNotification, UserNotificationCenter, configure, interpolate };
+export { AfricasTalkingSmsDriver, DbNotification, DbNotificationPayload, DbNotificationType, DriverResult, FirebaseMulticastResult, FirebaseRealtimeDriver, FirebaseTransportConfig, MailDriverOptions, MailNotification, MailNotificationOptions, MailRecipient, MailRecipientAddress, MergedTransportConfig, Notification, NotificationChannel, NotificationConfig, NotificationContract, NotificationData, NotificationDriverMap, NotificationRecipient, PusherRealtimeDriver, PusherTransportConfig, RealtimeBroadcastResult, RealtimeDriver, RealtimeDriverName, RealtimeDriverOptions, RealtimeNotification, RealtimeNotificationDriver, RealtimeNotificationPayload, SmsDriverName, SmsDriverOptions, SmsNotification, Transport, TwilioSmsDriver, UserNotification, UserNotificationCenter, configure, interpolate };

package/dist/index.js

@@ -222,18 +222,19 @@ var MailNotification = class extends NotificationContract {
 	* Prepare the mail driver so we can use it to relay the message
 	*/
 	async prepareDriver() {
+		const options = this.options;
+		this.fromAddress = options.from ?? this.driverConfig.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
 		if (typeof this.transport !== "string") {
 			this.driver = nodemailer.createTransport(this.transport);
 			return;
 		}
-		const options = this.options;
 		const transport = configure(`transports.${this.transport}`, {});
+		this.fromAddress = transport.from || this.fromAddress;
 		/**
 		* 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 ?? this.driverConfig.from ?? transport.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
 			this.driver = nodemailer.createTransport({
 				streamTransport: true,
 				buffer: true
@@ -272,7 +273,6 @@ var MailNotification = class extends NotificationContract {
 		}
 		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 ?? this.driverConfig.from ?? transport.from ?? env("MAIL_FROM_ADDRESS", "no-reply@example.com");
 		this.driver = nodemailer.createTransport({
 			url: transport.url ?? options.url ?? env("MAIL_URL"),
 			host: options.host ?? transport.host ?? env("MAIL_HOST", "localhost"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.17.10",
+  "version": "0.17.12",
   "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": "^9.0.3",
     "twilio": "^6.0.2",
-    "@arkstack/common": "^0.17.10"
+    "@arkstack/common": "^0.17.12"
   },
   "peerDependencies": {
     "@kanun-hq/plugin-phone": "^0.1.8",
     "firebase-admin": "^13.0.0",
     "pusher": "^5.2.0",
-    "@arkstack/contract": "^0.17.10",
-    "@arkstack/database": "^0.17.10"
+    "@arkstack/database": "^0.17.12",
+    "@arkstack/contract": "^0.17.12"
   },
   "peerDependenciesMeta": {
     "pusher": {