@arkstack/notifications 0.3.17

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Toneflix Technologies Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# @arkstack/notifications
+
+Framework-neutral notifications for Arkstack applications.
+
+```ts
+import { Notification } from '@arkstack/notifications';
+
+await Notification.mail()
+  .recipient({ 'ada@example.com': 'Ada Lovelace' })
+  .subject('Welcome, {name}')
+  .data({ name: 'Ada' })
+  .send('Hello {name}, thanks for joining.');
+
+await Notification.sms()
+  .recipient('+2348012345678')
+  .send('Your code is {code}', undefined, undefined, { code: '123456' });
+
+await Notification.db()
+  .recipient(user)
+  .send('Your payout has settled', 'Payout settled');
+```
+
+Apps using database notifications should provide a `UserNotification` model backed by a `user_notifications` table. The starter templates include this model and migration.
+
+## Config
+
+```ts
+export default () => ({
+  default_driver: 'mail',
+  drivers: {
+    mail: {
+      transport: 'smtp',
+      from: env('SMTP_FROM_ADDRESS', 'no-reply@example.com'),
+    },
+    sms: {
+      transport: 'africastalking',
+      from: env('SMS_FROM'),
+    },
+    db: {
+      table: 'user_notifications',
+    },
+  },
+  transports: {
+    smtp: {
+      host: env('SMTP_HOST', 'localhost'),
+      port: env('SMTP_PORT', 1025),
+    },
+    africastalking: {
+      username: env('AFRICASTALKING_USERNAME', 'sandbox'),
+      apiKey: env('AFRICASTALKING_API_KEY', 'sandbox'),
+    },
+    twilio: {
+      accountSid: env('TWILIO_ACCOUNT_SID'),
+      authToken: env('TWILIO_AUTH_TOKEN'),
+      from: env('TWILIO_FROM'),
+    },
+  },
+});
+```
+
+`default_driver` selects the notification channel used by `Notification.channel()`. `drivers.sms.transport` selects the SMS provider transport, either `africastalking` or `twilio`.

package/dist/index.d.ts

@@ -0,0 +1,188 @@
+import * as arkormx from "arkormx";
+import { Model } from "arkormx";
+import { Transporter } from "nodemailer";
+import * as twilio_lib_rest_api_v2010_account_message0 from "twilio/lib/rest/api/v2010/account/message";
+
+//#region src/Contracts/UserNotification.d.ts
+declare abstract class UserNotification extends Model {
+  id: number | string;
+  userId: number | string;
+  type: DbNotificationType | null;
+  title: string;
+  description: string;
+  actionText: string | null;
+  actionLink: string | null;
+  meta: NotificationData | null;
+  readAt: Date | null;
+  createdAt: Date;
+  updatedAt: Date;
+  protected static table?: string | undefined;
+  protected casts: {
+    readonly meta: "json";
+  };
+}
+//#endregion
+//#region src/types.d.ts
+type NotificationRecipient = string | string[];
+type MailRecipientAddress = Record<string, string>;
+type MailRecipient = string | MailRecipientAddress | Array<string | MailRecipientAddress>;
+type NotificationData = Record<string, unknown>;
+type SmsDriverName = 'africastalking' | 'twilio';
+type NotificationChannel = 'mail' | 'sms' | 'db';
+type NotificationUser = {
+  id: string | number;
+  email?: string | null;
+  phone?: string | null;
+};
+type MailDriverOptions = {
+  transport?: string;
+  host?: string;
+  port?: number;
+  secure?: boolean;
+  user?: string;
+  pass?: string;
+  from?: string;
+  testAddress?: string;
+};
+type SmsDriverOptions = {
+  transport?: SmsDriverName;
+  from?: string;
+  africastalking?: {
+    username?: string;
+    apiKey?: string;
+    senderId?: string;
+  };
+  twilio?: {
+    accountSid?: string;
+    authToken?: string;
+    from?: string;
+  };
+};
+type DbNotificationType = 'transaction' | 'pocket' | 'family' | 'security' | 'promo' | 'bill' | 'goal' | string;
+type DbNotificationPayload = {
+  type?: DbNotificationType | null;
+  title: string;
+  description: string;
+  actionText?: string | null;
+  actionLink?: string | null;
+  meta?: NotificationData | null;
+};
+type DriverResult = unknown;
+type NotificationDriverMap = {
+  mail: DriverResult;
+  sms: DriverResult;
+  db: UserNotification;
+};
+//#endregion
+//#region src/Contracts/NotificationContract.d.ts
+declare abstract class NotificationContract<TResult = DriverResult> {
+  protected contextData: NotificationData;
+  abstract send(message: string, subject?: string, recipient?: NotificationRecipient, data?: NotificationData): Promise<TResult>;
+  abstract from(from: string): this;
+  abstract subject(subject: string): this;
+  abstract recipient(recipient: NotificationRecipient): this;
+  data(data: NotificationData): this;
+  protected mergeData(data?: NotificationData): {
+    year: number;
+  };
+}
+//#endregion
+//#region src/drivers/DbNotification.d.ts
+declare class DbNotification extends NotificationContract<UserNotification> {
+  private user?;
+  private payload;
+  from(_from: string): this;
+  subject(subject: string): this;
+  recipient(recipient: NotificationRecipient | NotificationUser): this;
+  type(type: DbNotificationPayload['type']): this;
+  action(text?: string | null, link?: string | null): this;
+  meta(meta?: NotificationData | null): this;
+  create(user: NotificationUser, payload: DbNotificationPayload): Promise<UserNotification & arkormx.Model<any, any>>;
+  send(message: string, subject?: string, _recipient?: NotificationRecipient, data?: NotificationData): Promise<UserNotification & arkormx.Model<any, any>>;
+}
+//#endregion
+//#region src/drivers/MailNotification.d.ts
+declare class MailNotification extends NotificationContract {
+  driver: Transporter;
+  private fromAddress?;
+  private subjectLine?;
+  private recipients?;
+  static defaultHtmlTemplate: string;
+  constructor(options?: MailDriverOptions);
+  from(from: string): this;
+  subject(subject: string): this;
+  recipient(recipient: MailRecipient): this;
+  send(message: string, subject?: string, recipient?: MailRecipient, data?: NotificationData): Promise<any>;
+  private resolveRecipients;
+  private normalizeRecipient;
+}
+//#endregion
+//#region src/drivers/sms/AfricasTalkingSmsDriver.d.ts
+declare class AfricasTalkingSmsDriver {
+  private driver;
+  private senderId?;
+  constructor(options?: SmsDriverOptions['africastalking']);
+  send(message: string, recipient: NotificationRecipient, data?: NotificationData): Promise<unknown>;
+}
+//#endregion
+//#region src/drivers/sms/TwilioSmsDriver.d.ts
+declare class TwilioSmsDriver {
+  private client;
+  private fromNumber;
+  constructor(options?: SmsDriverOptions['twilio']);
+  send(message: string, recipient: NotificationRecipient, data?: NotificationData): Promise<twilio_lib_rest_api_v2010_account_message0.MessageInstance[]>;
+}
+//#endregion
+//#region src/drivers/SmsNotification.d.ts
+type SmsProvider = AfricasTalkingSmsDriver | TwilioSmsDriver;
+declare class SmsNotification extends NotificationContract {
+  driver: SmsProvider;
+  private recipients?;
+  private fromValue?;
+  constructor(options?: SmsDriverOptions);
+  from(from: string): this;
+  subject(_subject: string): this;
+  recipient(recipient: NotificationRecipient): this;
+  send(message: string, _subject?: string, recipient?: NotificationRecipient, data?: NotificationData): Promise<unknown>;
+}
+//#endregion
+//#region src/Contracts/Maps.d.ts
+type DriverMap = {
+  mail: MailNotification;
+  email: MailNotification;
+  sms: SmsNotification;
+  db: DbNotification;
+};
+//#endregion
+//#region src/Notification.d.ts
+declare class Notification<D extends keyof DriverMap = keyof DriverMap> {
+  private driver;
+  constructor(driver: D, options?: MailDriverOptions | SmsDriverOptions);
+  static mail(options?: MailDriverOptions): MailNotification;
+  static email(options?: MailDriverOptions): MailNotification;
+  static sms(options?: SmsDriverOptions): SmsNotification;
+  static db(): DbNotification;
+  static channel(channel?: NotificationChannel | 'email', options?: MailDriverOptions | SmsDriverOptions): MailNotification | SmsNotification | DbNotification;
+  prepare(recipient?: null | MailRecipient | NotificationRecipient | NotificationUser, data?: NotificationData): DriverMap[D];
+  private static createDriver;
+}
+//#endregion
+//#region src/UserNotificationCenter.d.ts
+declare class UserNotificationCenter {
+  private static getModel;
+  static create(user: NotificationUser, payload: DbNotificationPayload): Promise<UserNotification & arkormx.Model<any, any>>;
+  static forUser(user: NotificationUser): Promise<arkormx.ArkormCollection<UserNotification & arkormx.Model<any, any>, (UserNotification & arkormx.Model<any, any>)[]>>;
+  static unreadForUser(user: NotificationUser): Promise<arkormx.ArkormCollection<UserNotification & arkormx.Model<any, any>, (UserNotification & arkormx.Model<any, any>)[]>>;
+  static markRead(notification: UserNotification | UserNotification['id']): Promise<void>;
+  static markAllRead(user: NotificationUser): Promise<void>;
+  static delete(notification: UserNotification | UserNotification['id']): Promise<void>;
+}
+//#endregion
+//#region src/config.d.ts
+declare const notificationConfig: <T = unknown>(key: string, defaultValue: T) => T;
+//#endregion
+//#region src/utils/template.d.ts
+declare const interpolate: (value: string, data?: NotificationData) => string;
+//#endregion
+export { AfricasTalkingSmsDriver, DbNotification, DbNotificationPayload, DbNotificationType, DriverResult, MailDriverOptions, MailNotification, MailRecipient, MailRecipientAddress, Notification, NotificationChannel, NotificationContract, NotificationData, NotificationDriverMap, NotificationRecipient, NotificationUser, SmsDriverName, SmsDriverOptions, SmsNotification, TwilioSmsDriver, UserNotification, UserNotificationCenter, interpolate, notificationConfig };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/Contracts/UserNotification.ts","../src/types.ts","../src/Contracts/NotificationContract.ts","../src/drivers/DbNotification.ts","../src/drivers/MailNotification.ts","../src/drivers/sms/AfricasTalkingSmsDriver.ts","../src/drivers/sms/TwilioSmsDriver.ts","../src/drivers/SmsNotification.ts","../src/Contracts/Maps.ts","../src/Notification.ts","../src/UserNotificationCenter.ts","../src/config.ts","../src/utils/template.ts"],"mappings":";;;;;;uBAIsB,gBAAA,SAAyB,KAAA;EACnC,EAAA;EACA,MAAA;EACA,IAAA,EAAM,kBAAA;EACN,KAAA;EACA,WAAA;EACA,UAAA;EACA,UAAA;EACA,IAAA,EAAM,gBAAA;EACN,MAAA,EAAQ,IAAA;EACR,SAAA,EAAW,IAAA;EACX,SAAA,EAAW,IAAA;EAAA,iBAEF,KAAA;EAAA,UAEP,KAAA;IAAA;;;;;KCjBF,qBAAA;AAAA,KAEA,oBAAA,GAAuB,MAAA;AAAA,KAEvB,aAAA,YAAyB,oBAAA,GAAuB,KAAA,UAAe,oBAAA;AAAA,KAE/D,gBAAA,GAAmB,MAAA;AAAA,KAEnB,aAAA;AAAA,KAEA,mBAAA;AAAA,KAEA,gBAAA;EACR,EAAA;EACA,KAAA;EACA,KAAA;AAAA;AAAA,KAGQ,iBAAA;EACR,SAAA;EACA,IAAA;EACA,IAAA;EACA,MAAA;EACA,IAAA;EACA,IAAA;EACA,IAAA;EACA,WAAA;AAAA;AAAA,KAGQ,gBAAA;EACR,SAAA,GAAY,aAAA;EACZ,IAAA;EACA,cAAA;IACI,QAAA;IACA,MAAA;IACA,QAAA;EAAA;EAEJ,MAAA;IACI,UAAA;IACA,SAAA;IACA,IAAA;EAAA;AAAA;AAAA,KAII,kBAAA;AAAA,KAEA,qBAAA;EACR,IAAA,GAAO,kBAAA;EACP,KAAA;EACA,WAAA;EACA,UAAA;EACA,UAAA;EACA,IAAA,GAAO,gBAAA;AAAA;AAAA,KAGC,YAAA;AAAA,KAEA,qBAAA;EACR,IAAA,EAAM,YAAA;EACN,GAAA,EAAK,YAAA;EACL,EAAA,EAAI,gBAAA;AAAA;;;uBC5Dc,oBAAA,WAA+B,YAAA;EAAA,UACvC,WAAA,EAAa,gBAAA;EAAA,SAEd,IAAA,CACL,OAAA,UACA,OAAA,WACA,SAAA,GAAY,qBAAA,EACZ,IAAA,GAAO,gBAAA,GACR,OAAA,CAAQ,OAAA;EAAA,SAEF,IAAA,CAAM,IAAA;EAAA,SACN,OAAA,CAAS,OAAA;EAAA,SACT,SAAA,CAAW,SAAA,EAAW,qBAAA;EAE/B,IAAA,CAAM,IAAA,EAAM,gBAAA;EAAA,UAMF,SAAA,CAAW,IAAA,GAAO,gBAAA;;;;;;cCdnB,cAAA,SAAuB,oBAAA,CAAqB,gBAAA;EAAA,QAC7C,IAAA;EAAA,QACA,OAAA;EAER,IAAA,CAAM,KAAA;EAIN,OAAA,CAAS,OAAA;EAMT,SAAA,CAAW,SAAA,EAAW,qBAAA,GAAwB,gBAAA;EAU9C,IAAA,CAAM,IAAA,EAAM,qBAAA;EAMZ,MAAA,CAAQ,IAAA,kBAAsB,IAAA;EAO9B,IAAA,CAAM,IAAA,GAAO,gBAAA;EAMP,MAAA,CAAQ,IAAA,EAAM,gBAAA,EAAkB,OAAA,EAAS,qBAAA,GAAqB,OAAA,CAAA,gBAAA,GAAA,OAAA,CAAA,KAAA;EAM9D,IAAA,CACF,OAAA,UACA,OAAA,WACA,UAAA,GAAa,qBAAA,EACb,IAAA,GAAO,gBAAA,GAAgB,OAAA,CAAA,gBAAA,GAAA,OAAA,CAAA,KAAA;AAAA;;;cCrDlB,gBAAA,SAAyB,oBAAA;EAClC,MAAA,EAAQ,WAAA;EAAA,QACA,WAAA;EAAA,QACA,WAAA;EAAA,QACA,UAAA;EAAA,OACD,mBAAA;cAWK,OAAA,GAAS,iBAAA;EA4BrB,IAAA,CAAM,IAAA;EAMN,OAAA,CAAS,OAAA;EAMT,SAAA,CAAW,SAAA,EAAW,aAAA;EAMhB,IAAA,CACF,OAAA,UACA,OAAA,WACA,SAAA,GAAY,aAAA,EACZ,IAAA,GAAO,gBAAA,GAAgB,OAAA;EAAA,QA2BnB,iBAAA;EAAA,QAyBA,kBAAA;AAAA;;;cCxHC,uBAAA;EAAA,QACD,MAAA;EAAA,QAIA,QAAA;cAEI,OAAA,GAAS,gBAAA;EAUf,IAAA,CAAM,OAAA,UAAiB,SAAA,EAAW,qBAAA,EAAuB,IAAA,GAAM,gBAAA,GAAqB,OAAA;AAAA;;;cCjBjF,eAAA;EAAA,QACD,MAAA;EAAA,QACA,UAAA;cAEI,OAAA,GAAS,gBAAA;EAQf,IAAA,CAAM,OAAA,UAAiB,SAAA,EAAW,qBAAA,EAAuB,IAAA,GAAM,gBAAA,GAAqB,OAAA,CAAA,0CAAA,CAAA,eAAA;AAAA;;;KCVzF,WAAA,GAAc,uBAAA,GAA0B,eAAA;AAAA,cAEhC,eAAA,SAAwB,oBAAA;EACjC,MAAA,EAAQ,WAAA;EAAA,QACA,UAAA;EAAA,QACA,SAAA;cAEI,OAAA,GAAS,gBAAA;EAyBrB,IAAA,CAAM,IAAA;EAMN,OAAA,CAAS,QAAA;EAIT,SAAA,CAAW,SAAA,EAAW,qBAAA;EAMhB,IAAA,CACF,OAAA,UACA,QAAA,WACA,SAAA,GAAY,qBAAA,EACZ,IAAA,GAAO,gBAAA,GAAgB,OAAA;AAAA;;;KCxDnB,SAAA;EACR,IAAA,EAAM,gBAAA;EACN,KAAA,EAAO,gBAAA;EACP,GAAA,EAAK,eAAA;EACL,EAAA,EAAI,cAAA;AAAA;;;cCAK,YAAA,iBAA6B,SAAA,SAAkB,SAAA;EAAA,QAChD,MAAA;cAEI,MAAA,EAAQ,CAAA,EAAG,OAAA,GAAS,iBAAA,GAAoB,gBAAA;EAAA,OAI7C,IAAA,CAAM,OAAA,GAAU,iBAAA,GAAiB,gBAAA;EAAA,OAIjC,KAAA,CAAO,OAAA,GAAU,iBAAA,GAAiB,gBAAA;EAAA,OAIlC,GAAA,CAAK,OAAA,GAAU,gBAAA,GAAgB,eAAA;EAAA,OAI/B,EAAA,CAAA,GAAE,cAAA;EAAA,OAIF,OAAA,CACH,OAAA,GAAU,mBAAA,YACV,OAAA,GAAU,iBAAA,GAAoB,gBAAA,GAAgB,gBAAA,GAAA,eAAA,GAAA,cAAA;EAKlD,OAAA,CACI,SAAA,UAAmB,aAAA,GAAgB,qBAAA,GAAwB,gBAAA,EAC3D,IAAA,GAAM,gBAAA,GAAqB,SAAA,CAAA,CAAA;EAAA,eA2BhB,YAAA;AAAA;;;cC9DN,sBAAA;EAAA,eACY,QAAA;EAAA,OAIR,MAAA,CAAQ,IAAA,EAAM,gBAAA,EAAkB,OAAA,EAAS,qBAAA,GAAqB,OAAA,CAAA,gBAAA,GAAA,OAAA,CAAA,KAAA;EAAA,OAc9D,OAAA,CAAS,IAAA,EAAM,gBAAA,GAAgB,OAAA,CAAA,OAAA,CAAA,gBAAA,CAAA,gBAAA,GAAA,OAAA,CAAA,KAAA,aAAA,gBAAA,GAAA,OAAA,CAAA,KAAA;EAAA,OAM/B,aAAA,CAAe,IAAA,EAAM,gBAAA,GAAgB,OAAA,CAAA,OAAA,CAAA,gBAAA,CAAA,gBAAA,GAAA,OAAA,CAAA,KAAA,aAAA,gBAAA,GAAA,OAAA,CAAA,KAAA;EAAA,OAMrC,QAAA,CAAU,YAAA,EAAc,gBAAA,GAAmB,gBAAA,SAAsB,OAAA;EAAA,OAYjE,WAAA,CAAa,IAAA,EAAM,gBAAA,GAAgB,OAAA;EAAA,OAMnC,MAAA,CAAQ,YAAA,EAAc,gBAAA,GAAmB,gBAAA,SAAsB,OAAA;AAAA;;;cCpDnE,kBAAA,gBAAoC,GAAA,UAAa,YAAA,EAAc,CAAA,KAAI,CAAA;;;cCAnE,WAAA,GAAe,KAAA,UAAe,IAAA,GAAM,gBAAA"}

package/dist/index.js

@@ -0,0 +1,387 @@
+import { config, env, getModel } from "@arkstack/common";
+import { Model } from "arkormx";
+import nodemailer from "nodemailer";
+import africastalking from "africastalking";
+import twilio from "twilio";
+
+//#region src/Contracts/NotificationContract.ts
+var NotificationContract = class {
+	contextData = {};
+	data(data) {
+		this.contextData = data;
+		return this;
+	}
+	mergeData(data) {
+		return {
+			...this.contextData,
+			...data,
+			year: (/* @__PURE__ */ new Date()).getFullYear()
+		};
+	}
+};
+
+//#endregion
+//#region src/Contracts/UserNotification.ts
+var UserNotification = class extends Model {
+	static table = "user_notifications";
+	casts = { meta: "json" };
+};
+
+//#endregion
+//#region src/UserNotificationCenter.ts
+var UserNotificationCenter = class {
+	static async getModel() {
+		return await getModel("UserNotification");
+	}
+	static async create(user, payload) {
+		return await (await this.getModel()).query().create({
+			userId: user.id,
+			type: payload.type ?? null,
+			title: payload.title,
+			description: payload.description,
+			actionText: payload.actionText ?? null,
+			actionLink: payload.actionLink ?? null,
+			meta: payload.meta ?? null
+		});
+	}
+	static async forUser(user) {
+		return await (await this.getModel()).query().where({ userId: user.id }).get();
+	}
+	static async unreadForUser(user) {
+		return await (await this.getModel()).query().where({
+			userId: user.id,
+			readAt: null
+		}).get();
+	}
+	static async markRead(notification) {
+		const Model = await this.getModel();
+		const id = notification instanceof UserNotification ? notification.id : notification;
+		const readAt = /* @__PURE__ */ new Date();
+		await Model.query().where({ id }).update({ readAt });
+		if (notification instanceof UserNotification) notification.readAt = readAt;
+	}
+	static async markAllRead(user) {
+		await (await this.getModel()).query().where({
+			userId: user.id,
+			readAt: null
+		}).update({ readAt: /* @__PURE__ */ new Date() });
+	}
+	static async delete(notification) {
+		const Model = await this.getModel();
+		const id = notification instanceof UserNotification ? notification.id : notification;
+		await Model.query().where({ id }).delete();
+	}
+};
+
+//#endregion
+//#region src/utils/template.ts
+const interpolate = (value, data = {}) => {
+	return value.replace(/\{([^{}]+)\}/g, (match, key) => {
+		const replacement = data[key.trim()];
+		return replacement === void 0 || replacement === null ? match : String(replacement);
+	});
+};
+
+//#endregion
+//#region src/drivers/DbNotification.ts
+var DbNotification = class extends NotificationContract {
+	user;
+	payload = {};
+	from(_from) {
+		return this;
+	}
+	subject(subject) {
+		this.payload.title = subject;
+		return this;
+	}
+	recipient(recipient) {
+		if (typeof recipient === "object" && !Array.isArray(recipient) && "id" in recipient) {
+			this.user = recipient;
+			return this;
+		}
+		throw new Error("Database notifications require a user recipient");
+	}
+	type(type) {
+		this.payload.type = type;
+		return this;
+	}
+	action(text, link) {
+		this.payload.actionText = text;
+		this.payload.actionLink = link;
+		return this;
+	}
+	meta(meta) {
+		this.payload.meta = meta;
+		return this;
+	}
+	async create(user, payload) {
+		await getModel("UserNotification");
+		return await UserNotificationCenter.create(user, payload);
+	}
+	async send(message, subject, _recipient, data) {
+		if (!this.user) throw new Error("No user recipient provided for database notification");
+		const mergedData = this.mergeData(data);
+		return await this.create(this.user, {
+			type: this.payload.type ?? null,
+			title: interpolate(subject ?? this.payload.title ?? "", mergedData),
+			description: interpolate(message, mergedData),
+			actionText: this.payload.actionText ?? null,
+			actionLink: this.payload.actionLink ?? null,
+			meta: this.payload.meta ?? null
+		});
+	}
+};
+
+//#endregion
+//#region src/config.ts
+const notificationConfig = (key, defaultValue) => {
+	try {
+		return config(`notifications.${key}`, defaultValue);
+	} catch {
+		return defaultValue;
+	}
+};
+
+//#endregion
+//#region src/drivers/MailNotification.ts
+var MailNotification = class MailNotification extends NotificationContract {
+	driver;
+	fromAddress;
+	subjectLine;
+	recipients;
+	static defaultHtmlTemplate = [
+		"<!doctype html>",
+		"<html>",
+		"<body style=\"font-family:Arial,sans-serif;line-height:1.5;color:#111827\">",
+		"<h2>{subject}</h2>",
+		"<div>{message}</div>",
+		"<p style=\"color:#6b7280;font-size:12px\">&copy; {year} {app_name}</p>",
+		"</body>",
+		"</html>"
+	].join("");
+	constructor(options = {}) {
+		super();
+		const driverConfig = notificationConfig("drivers.mail", {});
+		const transportConfig = notificationConfig(`transports.${options.transport ?? driverConfig.transport ?? "smtp"}`, {});
+		const legacyMailConfig = notificationConfig("mail", {});
+		const smtpConfig = {
+			...notificationConfig("smtp", {}),
+			...legacyMailConfig.smtp ?? {},
+			...transportConfig
+		};
+		const host = options.host ?? smtpConfig.host ?? env("SMTP_HOST", "localhost");
+		const port = options.port ?? smtpConfig.port ?? env("SMTP_PORT", 1025);
+		const secure = options.secure ?? smtpConfig.secure ?? env("SMTP_SECURE", false);
+		const user = options.user ?? smtpConfig.auth?.user ?? smtpConfig.user ?? env("SMTP_USERNAME", "");
+		const pass = options.pass ?? smtpConfig.auth?.pass ?? smtpConfig.pass ?? env("SMTP_PASSWORD", "");
+		this.fromAddress = options.from ?? driverConfig.from ?? legacyMailConfig.from ?? smtpConfig.from ?? env("SMTP_FROM_ADDRESS", "no-reply@example.com");
+		this.driver = nodemailer.createTransport({
+			host,
+			port: Number(port),
+			secure: Boolean(secure),
+			auth: user || pass ? {
+				user,
+				pass
+			} : void 0
+		});
+	}
+	from(from) {
+		this.fromAddress = from;
+		return this;
+	}
+	subject(subject) {
+		this.subjectLine = subject;
+		return this;
+	}
+	recipient(recipient) {
+		this.recipients = recipient;
+		return this;
+	}
+	async send(message, subject, recipient, data) {
+		const mergedData = {
+			app_name: env("APP_NAME", "Arkstack"),
+			...this.mergeData(data)
+		};
+		const resolvedSubject = interpolate(subject ?? this.subjectLine ?? "", mergedData);
+		const resolvedMessage = interpolate(message, mergedData);
+		const to = this.resolveRecipients(recipient);
+		if (to.length < 1) throw new Error("No recipient provided for mail notification");
+		return await this.driver.sendMail({
+			to,
+			subject: resolvedSubject,
+			from: this.fromAddress,
+			text: resolvedMessage.replace(/<\/?[^>]+(>|$)/g, ""),
+			html: interpolate(MailNotification.defaultHtmlTemplate, {
+				...mergedData,
+				message: resolvedMessage,
+				subject: resolvedSubject
+			})
+		});
+	}
+	resolveRecipients(recipient) {
+		const recipients = recipient ?? this.recipients;
+		const resolved = (Array.isArray(recipients) ? [...recipients] : recipients ? [recipients] : []).flatMap((recipient) => this.normalizeRecipient(recipient));
+		const driverConfig = notificationConfig("drivers.mail", {});
+		const transportConfig = notificationConfig(`transports.${driverConfig.transport ?? "smtp"}`, {});
+		const testAddress = driverConfig.testAddress ?? driverConfig.test_address ?? transportConfig.testAddress ?? transportConfig.test_address ?? env("SMTP_TEST_ADDRESS");
+		if (env("NODE_ENV") !== "production" && testAddress) resolved.push(testAddress);
+		return resolved;
+	}
+	normalizeRecipient(recipient) {
+		if (typeof recipient === "string") return [recipient];
+		return Object.entries(recipient).map(([address, name]) => ({
+			address,
+			name
+		}));
+	}
+};
+
+//#endregion
+//#region src/drivers/sms/AfricasTalkingSmsDriver.ts
+var AfricasTalkingSmsDriver = class {
+	driver;
+	senderId;
+	constructor(options = {}) {
+		const username = options.username ?? env("AFRICASTALKING_USERNAME", "sandbox");
+		const apiKey = options.apiKey ?? env("AFRICASTALKING_API_KEY", "sandbox");
+		this.senderId = options.senderId ?? env("AFRICASTALKING_SENDER_ID", env("SMS_FROM", "Arkstack"));
+		this.driver = africastalking({
+			username,
+			apiKey
+		}).SMS;
+	}
+	async send(message, recipient, data = {}) {
+		const recipients = Array.isArray(recipient) ? recipient : [recipient];
+		const resolvedMessage = interpolate(message, data);
+		if (recipients.length > 1) return await this.driver.sendBulk({
+			to: recipients,
+			from: this.senderId,
+			message: resolvedMessage
+		});
+		return await this.driver.send({
+			to: recipients[0],
+			from: this.senderId,
+			message: resolvedMessage
+		});
+	}
+};
+
+//#endregion
+//#region src/drivers/sms/TwilioSmsDriver.ts
+var TwilioSmsDriver = class {
+	client;
+	fromNumber;
+	constructor(options = {}) {
+		const accountSid = options.accountSid ?? env("TWILIO_ACCOUNT_SID", "");
+		const authToken = options.authToken ?? env("TWILIO_AUTH_TOKEN", "");
+		this.fromNumber = options.from ?? env("TWILIO_FROM", env("SMS_FROM", ""));
+		this.client = twilio(accountSid, authToken);
+	}
+	async send(message, recipient, data = {}) {
+		const recipients = Array.isArray(recipient) ? recipient : [recipient];
+		const resolvedMessage = interpolate(message, data);
+		return await Promise.all(recipients.map(async (to) => await this.client.messages.create({
+			body: resolvedMessage,
+			from: this.fromNumber,
+			to
+		})));
+	}
+};
+
+//#endregion
+//#region src/drivers/SmsNotification.ts
+var SmsNotification = class extends NotificationContract {
+	driver;
+	recipients;
+	fromValue;
+	constructor(options = {}) {
+		super();
+		const driverConfig = notificationConfig("drivers.sms", {});
+		const transport = options.transport ?? driverConfig.transport ?? "twilio";
+		const transportConfig = notificationConfig(`transports.${transport}`, {});
+		const legacySmsConfig = notificationConfig("sms", {});
+		const from = options.from ?? driverConfig.from ?? legacySmsConfig.from;
+		this.fromValue = from;
+		this.driver = transport === "twilio" ? new TwilioSmsDriver({
+			...legacySmsConfig.twilio,
+			...transportConfig,
+			...options.twilio,
+			from: options.twilio?.from ?? transportConfig.from ?? legacySmsConfig.twilio?.from ?? from
+		}) : new AfricasTalkingSmsDriver({
+			...legacySmsConfig.africastalking,
+			...transportConfig,
+			...options.africastalking,
+			senderId: options.africastalking?.senderId ?? transportConfig.senderId ?? legacySmsConfig.africastalking?.senderId ?? from
+		});
+	}
+	from(from) {
+		this.fromValue = from;
+		return this;
+	}
+	subject(_subject) {
+		return this;
+	}
+	recipient(recipient) {
+		this.recipients = recipient;
+		return this;
+	}
+	async send(message, _subject, recipient, data) {
+		const resolvedRecipient = recipient ?? this.recipients;
+		if (!resolvedRecipient) throw new Error("No recipient provided for SMS notification");
+		return await this.driver.send(message, resolvedRecipient, {
+			app_name: env("APP_NAME", "Arkstack"),
+			from: this.fromValue,
+			...this.mergeData(data)
+		});
+	}
+};
+
+//#endregion
+//#region src/Notification.ts
+var Notification = class Notification {
+	driver;
+	constructor(driver, options = {}) {
+		this.driver = Notification.createDriver(driver, options);
+	}
+	static mail(options) {
+		return new MailNotification(options);
+	}
+	static email(options) {
+		return this.mail(options);
+	}
+	static sms(options) {
+		return new SmsNotification(options);
+	}
+	static db() {
+		return new DbNotification();
+	}
+	static channel(channel, options) {
+		return Notification.createDriver(channel ?? notificationConfig("default_driver", "mail"), options);
+	}
+	prepare(recipient, data = {}) {
+		this.driver.data(data);
+		if (recipient && typeof recipient === "object" && !Array.isArray(recipient) && "id" in recipient) {
+			if (this.driver instanceof MailNotification) {
+				if (recipient.email) this.driver.recipient(recipient.email);
+			} else if (this.driver instanceof SmsNotification) {
+				if (recipient.phone) this.driver.recipient(recipient.phone);
+			} else this.driver.recipient(recipient);
+			return this.driver;
+		}
+		if (recipient) this.driver.recipient(recipient);
+		return this.driver;
+	}
+	static createDriver(driver, options = {}) {
+		switch (driver) {
+			case "mail":
+			case "email": return new MailNotification(options);
+			case "sms": return new SmsNotification(options);
+			case "db": return new DbNotification();
+			default: throw new Error(`Unsupported notification driver: ${driver}`);
+		}
+	}
+};
+
+//#endregion
+export { AfricasTalkingSmsDriver, DbNotification, MailNotification, Notification, NotificationContract, SmsNotification, TwilioSmsDriver, UserNotification, UserNotificationCenter, interpolate, notificationConfig };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/Contracts/NotificationContract.ts","../src/Contracts/UserNotification.ts","../src/UserNotificationCenter.ts","../src/utils/template.ts","../src/drivers/DbNotification.ts","../src/config.ts","../src/drivers/MailNotification.ts","../src/drivers/sms/AfricasTalkingSmsDriver.ts","../src/drivers/sms/TwilioSmsDriver.ts","../src/drivers/SmsNotification.ts","../src/Notification.ts"],"sourcesContent":["import type { DriverResult, NotificationData, NotificationRecipient } from '../types'\n\nexport abstract class NotificationContract<TResult = DriverResult> {\n    protected contextData: NotificationData = {}\n\n    abstract send (\n        message: string,\n        subject?: string,\n        recipient?: NotificationRecipient,\n        data?: NotificationData\n    ): Promise<TResult>\n\n    abstract from (from: string): this\n    abstract subject (subject: string): this\n    abstract recipient (recipient: NotificationRecipient): this\n\n    data (data: NotificationData): this {\n        this.contextData = data\n\n        return this\n    }\n\n    protected mergeData (data?: NotificationData) {\n        return {\n            ...this.contextData,\n            ...data,\n            year: new Date().getFullYear(),\n        }\n    }\n}\n","import { Model } from 'arkormx'\n\nimport type { DbNotificationType, NotificationData } from '../types'\n\nexport abstract class UserNotification extends Model {\n    declare id: number | string\n    declare userId: number | string\n    declare type: DbNotificationType | null\n    declare title: string\n    declare description: string\n    declare actionText: string | null\n    declare actionLink: string | null\n    declare meta: NotificationData | null\n    declare readAt: Date | null\n    declare createdAt: Date\n    declare updatedAt: Date\n\n    protected static table?: string | undefined = 'user_notifications'\n\n    protected casts = {\n        meta: 'json',\n    } as const\n}\n","import { getModel } from '@arkstack/common'\n\nimport { UserNotification } from './Contracts/UserNotification'\nimport type { DbNotificationPayload, NotificationUser } from './types'\n\nexport class UserNotificationCenter {\n    private static async getModel () {\n        return await getModel<typeof UserNotification>('UserNotification')\n    }\n\n    static async create (user: NotificationUser, payload: DbNotificationPayload) {\n        const Model = await this.getModel()\n\n        return await Model.query().create({\n            userId: user.id,\n            type: payload.type ?? null,\n            title: payload.title,\n            description: payload.description,\n            actionText: payload.actionText ?? null,\n            actionLink: payload.actionLink ?? null,\n            meta: payload.meta ?? null,\n        })\n    }\n\n    static async forUser (user: NotificationUser) {\n        const Model = await this.getModel()\n\n        return await Model.query().where({ userId: user.id }).get()\n    }\n\n    static async unreadForUser (user: NotificationUser) {\n        const Model = await this.getModel()\n\n        return await Model.query().where({ userId: user.id, readAt: null }).get()\n    }\n\n    static async markRead (notification: UserNotification | UserNotification['id']) {\n        const Model = await this.getModel()\n        const id = notification instanceof UserNotification ? notification.id : notification\n        const readAt = new Date()\n\n        await Model.query().where({ id }).update({ readAt })\n\n        if (notification instanceof UserNotification) {\n            notification.readAt = readAt\n        }\n    }\n\n    static async markAllRead (user: NotificationUser) {\n        const Model = await this.getModel()\n\n        await Model.query().where({ userId: user.id, readAt: null }).update({ readAt: new Date() })\n    }\n\n    static async delete (notification: UserNotification | UserNotification['id']) {\n        const Model = await this.getModel()\n        const id = notification instanceof UserNotification ? notification.id : notification\n\n        await Model.query().where({ id }).delete()\n    }\n}\n","import type { NotificationData } from '../types'\n\nexport const interpolate = (value: string, data: NotificationData = {}) => {\n    return value.replace(/\\{([^{}]+)\\}/g, (match, key) => {\n        const replacement = data[key.trim()]\n\n        return replacement === undefined || replacement === null ? match : String(replacement)\n    })\n}\n","import type { DbNotificationPayload, NotificationData, NotificationRecipient, NotificationUser } from '../types'\n\nimport { NotificationContract } from '../Contracts/NotificationContract'\nimport { UserNotification } from '../Contracts/UserNotification'\nimport { UserNotificationCenter } from '../UserNotificationCenter'\nimport { getModel } from '@arkstack/common'\nimport { interpolate } from '../utils/template'\n\nexport class DbNotification extends NotificationContract<UserNotification> {\n    private user?: NotificationUser\n    private payload: Partial<DbNotificationPayload> = {}\n\n    from (_from: string): this {\n        return this\n    }\n\n    subject (subject: string): this {\n        this.payload.title = subject\n\n        return this\n    }\n\n    recipient (recipient: NotificationRecipient | NotificationUser): this {\n        if (typeof recipient === 'object' && !Array.isArray(recipient) && 'id' in recipient) {\n            this.user = recipient\n\n            return this\n        }\n\n        throw new Error('Database notifications require a user recipient')\n    }\n\n    type (type: DbNotificationPayload['type']): this {\n        this.payload.type = type\n\n        return this\n    }\n\n    action (text?: string | null, link?: string | null): this {\n        this.payload.actionText = text\n        this.payload.actionLink = link\n\n        return this\n    }\n\n    meta (meta?: NotificationData | null): this {\n        this.payload.meta = meta\n\n        return this\n    }\n\n    async create (user: NotificationUser, payload: DbNotificationPayload) {\n        await getModel<typeof UserNotification>('UserNotification')\n\n        return await UserNotificationCenter.create(user, payload)\n    }\n\n    async send (\n        message: string,\n        subject?: string,\n        _recipient?: NotificationRecipient,\n        data?: NotificationData\n    ) {\n        if (!this.user) {\n            throw new Error('No user recipient provided for database notification')\n        }\n\n        const mergedData = this.mergeData(data)\n\n        return await this.create(this.user, {\n            type: this.payload.type ?? null,\n            title: interpolate(subject ?? this.payload.title ?? '', mergedData),\n            description: interpolate(message, mergedData),\n            actionText: this.payload.actionText ?? null,\n            actionLink: this.payload.actionLink ?? null,\n            meta: this.payload.meta ?? null,\n        })\n    }\n}\n","import { config } from '@arkstack/common'\n\nexport const notificationConfig = <T = unknown> (key: string, defaultValue: T): T => {\n    try {\n        return config(`notifications.${key}`, defaultValue) as T\n    } catch {\n        return defaultValue\n    }\n}\n","import { env } from '@arkstack/common'\nimport nodemailer, { type Transporter } from 'nodemailer'\n\nimport { NotificationContract } from '../Contracts/NotificationContract'\nimport { interpolate } from '../utils/template'\nimport { notificationConfig } from '../config'\nimport type { MailDriverOptions, MailRecipient, MailRecipientAddress, NotificationData } from '../types'\n\nexport class MailNotification extends NotificationContract {\n    driver: Transporter\n    private fromAddress?: string\n    private subjectLine?: string\n    private recipients?: MailRecipient\n    static defaultHtmlTemplate = [\n        '<!doctype html>',\n        '<html>',\n        '<body style=\"font-family:Arial,sans-serif;line-height:1.5;color:#111827\">',\n        '<h2>{subject}</h2>',\n        '<div>{message}</div>',\n        '<p style=\"color:#6b7280;font-size:12px\">&copy; {year} {app_name}</p>',\n        '</body>',\n        '</html>',\n    ].join('')\n\n    constructor(options: MailDriverOptions = {}) {\n        super()\n\n        const driverConfig = notificationConfig<Record<string, any>>('drivers.mail', {})\n        const transport = options.transport ?? driverConfig.transport ?? 'smtp'\n        const transportConfig = notificationConfig<Record<string, any>>(`transports.${transport}`, {})\n        const legacyMailConfig = notificationConfig<Record<string, any>>('mail', {})\n        const legacySmtpConfig = notificationConfig<Record<string, any>>('smtp', {})\n        const smtpConfig = {\n            ...legacySmtpConfig,\n            ...(legacyMailConfig.smtp ?? {}),\n            ...transportConfig,\n        }\n        const host = options.host ?? smtpConfig.host ?? env('SMTP_HOST', 'localhost')\n        const port = options.port ?? smtpConfig.port ?? env('SMTP_PORT', 1025)\n        const secure = options.secure ?? smtpConfig.secure ?? env('SMTP_SECURE', false)\n        const user = options.user ?? smtpConfig.auth?.user ?? smtpConfig.user ?? env('SMTP_USERNAME', '')\n        const pass = options.pass ?? smtpConfig.auth?.pass ?? smtpConfig.pass ?? env('SMTP_PASSWORD', '')\n\n        this.fromAddress = options.from ?? driverConfig.from ?? legacyMailConfig.from ?? smtpConfig.from ?? env('SMTP_FROM_ADDRESS', 'no-reply@example.com')\n        this.driver = nodemailer.createTransport({\n            host,\n            port: Number(port),\n            secure: Boolean(secure),\n            auth: user || pass ? { user, pass } : undefined,\n        })\n    }\n\n    from (from: string): this {\n        this.fromAddress = from\n\n        return this\n    }\n\n    subject (subject: string): this {\n        this.subjectLine = subject\n\n        return this\n    }\n\n    recipient (recipient: MailRecipient): this {\n        this.recipients = recipient\n\n        return this\n    }\n\n    async send (\n        message: string,\n        subject?: string,\n        recipient?: MailRecipient,\n        data?: NotificationData\n    ) {\n        const mergedData = {\n            app_name: env('APP_NAME', 'Arkstack'),\n            ...this.mergeData(data),\n        }\n        const resolvedSubject = interpolate(subject ?? this.subjectLine ?? '', mergedData)\n        const resolvedMessage = interpolate(message, mergedData)\n        const to = this.resolveRecipients(recipient)\n\n        if (to.length < 1) {\n            throw new Error('No recipient provided for mail notification')\n        }\n\n        return await this.driver.sendMail({\n            to: to as never,\n            subject: resolvedSubject,\n            from: this.fromAddress,\n            text: resolvedMessage.replace(/<\\/?[^>]+(>|$)/g, ''),\n            html: interpolate(MailNotification.defaultHtmlTemplate, {\n                ...mergedData,\n                message: resolvedMessage,\n                subject: resolvedSubject,\n            }),\n        })\n    }\n\n    private resolveRecipients (recipient?: MailRecipient) {\n        const recipients = recipient ?? this.recipients\n        const resolved = (Array.isArray(recipients)\n            ? [...recipients]\n            : recipients\n                ? [recipients]\n                : []\n        ).flatMap(recipient => this.normalizeRecipient(recipient) as unknown)\n\n        const driverConfig = notificationConfig<Record<string, any>>('drivers.mail', {})\n        const transport = driverConfig.transport ?? 'smtp'\n        const transportConfig = notificationConfig<Record<string, any>>(`transports.${transport}`, {})\n        const testAddress = driverConfig.testAddress\n            ?? driverConfig.test_address\n            ?? transportConfig.testAddress\n            ?? transportConfig.test_address\n            ?? env<string | undefined>('SMTP_TEST_ADDRESS')\n\n        if (env('NODE_ENV') !== 'production' && testAddress) {\n            resolved.push(testAddress)\n        }\n\n        return resolved\n    }\n\n    private normalizeRecipient (recipient: string | MailRecipientAddress) {\n        if (typeof recipient === 'string') {\n            return [recipient]\n        }\n\n        return Object.entries(recipient).map(([address, name]) => ({ address, name }))\n    }\n}\n","import { env } from '@arkstack/common'\nimport africastalking from 'africastalking'\n\nimport { interpolate } from '../../utils/template'\nimport type { NotificationData, NotificationRecipient, SmsDriverOptions } from '../../types'\n\nexport class AfricasTalkingSmsDriver {\n    private driver: {\n        send: (payload: { to: string; from?: string; message: string }) => Promise<unknown>\n        sendBulk: (payload: { to: string[]; from?: string; message: string }) => Promise<unknown>\n    }\n    private senderId?: string\n\n    constructor(options: SmsDriverOptions['africastalking'] = {}) {\n        const username = options.username ?? env('AFRICASTALKING_USERNAME', 'sandbox')\n        const apiKey = options.apiKey ?? env('AFRICASTALKING_API_KEY', 'sandbox')\n\n        this.senderId = options.senderId ?? env('AFRICASTALKING_SENDER_ID', env('SMS_FROM', 'Arkstack'))\n        this.driver = (africastalking as (config: { username: string; apiKey: string }) => {\n            SMS: AfricasTalkingSmsDriver['driver']\n        })({ username, apiKey }).SMS\n    }\n\n    async send (message: string, recipient: NotificationRecipient, data: NotificationData = {}) {\n        const recipients = Array.isArray(recipient) ? recipient : [recipient]\n        const resolvedMessage = interpolate(message, data)\n\n        if (recipients.length > 1) {\n            return await this.driver.sendBulk({\n                to: recipients,\n                from: this.senderId,\n                message: resolvedMessage,\n            })\n        }\n\n        return await this.driver.send({\n            to: recipients[0],\n            from: this.senderId,\n            message: resolvedMessage,\n        })\n    }\n}\n","import type { NotificationData, NotificationRecipient, SmsDriverOptions } from '../../types'\n\nimport { env } from '@arkstack/common'\nimport { interpolate } from '../../utils/template'\nimport twilio from 'twilio'\n\nexport class TwilioSmsDriver {\n    private client: ReturnType<typeof twilio>\n    private fromNumber: string\n\n    constructor(options: SmsDriverOptions['twilio'] = {}) {\n        const accountSid = options.accountSid ?? env('TWILIO_ACCOUNT_SID', '')\n        const authToken = options.authToken ?? env('TWILIO_AUTH_TOKEN', '')\n\n        this.fromNumber = options.from ?? env('TWILIO_FROM', env('SMS_FROM', ''))\n        this.client = twilio(accountSid, authToken)\n    }\n\n    async send (message: string, recipient: NotificationRecipient, data: NotificationData = {}) {\n        const recipients = Array.isArray(recipient) ? recipient : [recipient]\n        const resolvedMessage = interpolate(message, data)\n\n        return await Promise.all(recipients.map(async to => await this.client.messages.create({\n            body: resolvedMessage,\n            from: this.fromNumber,\n            to,\n        })))\n    }\n}\n","import type { NotificationData, NotificationRecipient, SmsDriverOptions } from '../types'\n\nimport { AfricasTalkingSmsDriver } from './sms/AfricasTalkingSmsDriver'\nimport { NotificationContract } from '../Contracts/NotificationContract'\nimport { TwilioSmsDriver } from './sms/TwilioSmsDriver'\nimport { env } from '@arkstack/common'\nimport { notificationConfig } from '../config'\n\ntype SmsProvider = AfricasTalkingSmsDriver | TwilioSmsDriver\n\nexport class SmsNotification extends NotificationContract {\n    driver: SmsProvider\n    private recipients?: NotificationRecipient\n    private fromValue?: string\n\n    constructor(options: SmsDriverOptions = {}) {\n        super()\n\n        const driverConfig = notificationConfig<SmsDriverOptions>('drivers.sms', {})\n        const transport = options.transport ?? driverConfig.transport ?? 'twilio'\n        const transportConfig = notificationConfig<Record<string, any>>(`transports.${transport}`, {})\n        const legacySmsConfig = notificationConfig<SmsDriverOptions>('sms', {})\n        const from = options.from ?? driverConfig.from ?? legacySmsConfig.from\n\n        this.fromValue = from\n        this.driver = transport === 'twilio'\n            ? new TwilioSmsDriver({\n                ...legacySmsConfig.twilio,\n                ...transportConfig,\n                ...options.twilio,\n                from: options.twilio?.from ?? transportConfig.from ?? legacySmsConfig.twilio?.from ?? from,\n            })\n            : new AfricasTalkingSmsDriver({\n                ...legacySmsConfig.africastalking,\n                ...transportConfig,\n                ...options.africastalking,\n                senderId: options.africastalking?.senderId ?? transportConfig.senderId ?? legacySmsConfig.africastalking?.senderId ?? from,\n            })\n    }\n\n    from (from: string): this {\n        this.fromValue = from\n\n        return this\n    }\n\n    subject (_subject: string): this {\n        return this\n    }\n\n    recipient (recipient: NotificationRecipient): this {\n        this.recipients = recipient\n\n        return this\n    }\n\n    async send (\n        message: string,\n        _subject?: string,\n        recipient?: NotificationRecipient,\n        data?: NotificationData\n    ) {\n        const resolvedRecipient = recipient ?? this.recipients\n\n        if (!resolvedRecipient) {\n            throw new Error('No recipient provided for SMS notification')\n        }\n\n        return await this.driver.send(message, resolvedRecipient, {\n            app_name: env('APP_NAME', 'Arkstack'),\n            from: this.fromValue,\n            ...this.mergeData(data),\n        })\n    }\n}\n","import type { MailDriverOptions, MailRecipient, NotificationChannel, NotificationData, NotificationRecipient, NotificationUser, SmsDriverOptions } from './types'\n\nimport { DbNotification } from './drivers/DbNotification'\nimport { DriverMap } from './Contracts/Maps'\nimport { MailNotification } from './drivers/MailNotification'\nimport { SmsNotification } from './drivers/SmsNotification'\nimport { notificationConfig } from './config'\n\nexport class Notification<D extends keyof DriverMap = keyof DriverMap> {\n    private driver: DriverMap[D]\n\n    constructor(driver: D, options: MailDriverOptions | SmsDriverOptions = {}) {\n        this.driver = Notification.createDriver(driver, options) as DriverMap[D]\n    }\n\n    static mail (options?: MailDriverOptions) {\n        return new MailNotification(options)\n    }\n\n    static email (options?: MailDriverOptions) {\n        return this.mail(options)\n    }\n\n    static sms (options?: SmsDriverOptions) {\n        return new SmsNotification(options)\n    }\n\n    static db () {\n        return new DbNotification()\n    }\n\n    static channel (\n        channel?: NotificationChannel | 'email',\n        options?: MailDriverOptions | SmsDriverOptions\n    ) {\n        return Notification.createDriver(channel ?? notificationConfig<NotificationChannel>('default_driver', 'mail'), options)\n    }\n\n    prepare (\n        recipient?: null | MailRecipient | NotificationRecipient | NotificationUser,\n        data: NotificationData = {}\n    ) {\n        this.driver.data(data)\n\n        if (recipient && typeof recipient === 'object' && !Array.isArray(recipient) && 'id' in recipient) {\n            if (this.driver instanceof MailNotification) {\n                if (recipient.email) {\n                    this.driver.recipient(recipient.email)\n                }\n            } else if (this.driver instanceof SmsNotification) {\n                if (recipient.phone) {\n                    this.driver.recipient(recipient.phone)\n                }\n            } else {\n                this.driver.recipient(recipient as never)\n            }\n\n            return this.driver\n        }\n\n        if (recipient) {\n            this.driver.recipient(recipient as NotificationRecipient)\n        }\n\n        return this.driver\n    }\n\n    private static createDriver (\n        driver: NotificationChannel | 'email',\n        options: MailDriverOptions | SmsDriverOptions = {}\n    ) {\n        switch (driver) {\n            case 'mail':\n            case 'email':\n                return new MailNotification(options as MailDriverOptions)\n            case 'sms':\n                return new SmsNotification(options as SmsDriverOptions)\n            case 'db':\n                return new DbNotification()\n            default:\n                throw new Error(`Unsupported notification driver: ${driver}`)\n        }\n    }\n}\n"],"mappings":";;;;;;;AAEA,IAAsB,uBAAtB,MAAmE;CAC/D,AAAU,cAAgC,EAAE;CAa5C,KAAM,MAA8B;AAChC,OAAK,cAAc;AAEnB,SAAO;;CAGX,AAAU,UAAW,MAAyB;AAC1C,SAAO;GACH,GAAG,KAAK;GACR,GAAG;GACH,uBAAM,IAAI,MAAM,EAAC,aAAa;GACjC;;;;;;ACvBT,IAAsB,mBAAtB,cAA+C,MAAM;CAajD,OAAiB,QAA6B;CAE9C,AAAU,QAAQ,EACd,MAAM,QACT;;;;;AChBL,IAAa,yBAAb,MAAoC;CAChC,aAAqB,WAAY;AAC7B,SAAO,MAAM,SAAkC,mBAAmB;;CAGtE,aAAa,OAAQ,MAAwB,SAAgC;AAGzE,SAAO,OAFO,MAAM,KAAK,UAAU,EAEhB,OAAO,CAAC,OAAO;GAC9B,QAAQ,KAAK;GACb,MAAM,QAAQ,QAAQ;GACtB,OAAO,QAAQ;GACf,aAAa,QAAQ;GACrB,YAAY,QAAQ,cAAc;GAClC,YAAY,QAAQ,cAAc;GAClC,MAAM,QAAQ,QAAQ;GACzB,CAAC;;CAGN,aAAa,QAAS,MAAwB;AAG1C,SAAO,OAFO,MAAM,KAAK,UAAU,EAEhB,OAAO,CAAC,MAAM,EAAE,QAAQ,KAAK,IAAI,CAAC,CAAC,KAAK;;CAG/D,aAAa,cAAe,MAAwB;AAGhD,SAAO,OAFO,MAAM,KAAK,UAAU,EAEhB,OAAO,CAAC,MAAM;GAAE,QAAQ,KAAK;GAAI,QAAQ;GAAM,CAAC,CAAC,KAAK;;CAG7E,aAAa,SAAU,cAAyD;EAC5E,MAAM,QAAQ,MAAM,KAAK,UAAU;EACnC,MAAM,KAAK,wBAAwB,mBAAmB,aAAa,KAAK;EACxE,MAAM,yBAAS,IAAI,MAAM;AAEzB,QAAM,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC;AAEpD,MAAI,wBAAwB,iBACxB,cAAa,SAAS;;CAI9B,aAAa,YAAa,MAAwB;AAG9C,SAFc,MAAM,KAAK,UAAU,EAEvB,OAAO,CAAC,MAAM;GAAE,QAAQ,KAAK;GAAI,QAAQ;GAAM,CAAC,CAAC,OAAO,EAAE,wBAAQ,IAAI,MAAM,EAAE,CAAC;;CAG/F,aAAa,OAAQ,cAAyD;EAC1E,MAAM,QAAQ,MAAM,KAAK,UAAU;EACnC,MAAM,KAAK,wBAAwB,mBAAmB,aAAa,KAAK;AAExE,QAAM,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,QAAQ;;;;;;ACxDlD,MAAa,eAAe,OAAe,OAAyB,EAAE,KAAK;AACvE,QAAO,MAAM,QAAQ,kBAAkB,OAAO,QAAQ;EAClD,MAAM,cAAc,KAAK,IAAI,MAAM;AAEnC,SAAO,gBAAgB,UAAa,gBAAgB,OAAO,QAAQ,OAAO,YAAY;GACxF;;;;;ACCN,IAAa,iBAAb,cAAoC,qBAAuC;CACvE,AAAQ;CACR,AAAQ,UAA0C,EAAE;CAEpD,KAAM,OAAqB;AACvB,SAAO;;CAGX,QAAS,SAAuB;AAC5B,OAAK,QAAQ,QAAQ;AAErB,SAAO;;CAGX,UAAW,WAA2D;AAClE,MAAI,OAAO,cAAc,YAAY,CAAC,MAAM,QAAQ,UAAU,IAAI,QAAQ,WAAW;AACjF,QAAK,OAAO;AAEZ,UAAO;;AAGX,QAAM,IAAI,MAAM,kDAAkD;;CAGtE,KAAM,MAA2C;AAC7C,OAAK,QAAQ,OAAO;AAEpB,SAAO;;CAGX,OAAQ,MAAsB,MAA4B;AACtD,OAAK,QAAQ,aAAa;AAC1B,OAAK,QAAQ,aAAa;AAE1B,SAAO;;CAGX,KAAM,MAAsC;AACxC,OAAK,QAAQ,OAAO;AAEpB,SAAO;;CAGX,MAAM,OAAQ,MAAwB,SAAgC;AAClE,QAAM,SAAkC,mBAAmB;AAE3D,SAAO,MAAM,uBAAuB,OAAO,MAAM,QAAQ;;CAG7D,MAAM,KACF,SACA,SACA,YACA,MACF;AACE,MAAI,CAAC,KAAK,KACN,OAAM,IAAI,MAAM,uDAAuD;EAG3E,MAAM,aAAa,KAAK,UAAU,KAAK;AAEvC,SAAO,MAAM,KAAK,OAAO,KAAK,MAAM;GAChC,MAAM,KAAK,QAAQ,QAAQ;GAC3B,OAAO,YAAY,WAAW,KAAK,QAAQ,SAAS,IAAI,WAAW;GACnE,aAAa,YAAY,SAAS,WAAW;GAC7C,YAAY,KAAK,QAAQ,cAAc;GACvC,YAAY,KAAK,QAAQ,cAAc;GACvC,MAAM,KAAK,QAAQ,QAAQ;GAC9B,CAAC;;;;;;AC1EV,MAAa,sBAAoC,KAAa,iBAAuB;AACjF,KAAI;AACA,SAAO,OAAO,iBAAiB,OAAO,aAAa;SAC/C;AACJ,SAAO;;;;;;ACEf,IAAa,mBAAb,MAAa,yBAAyB,qBAAqB;CACvD;CACA,AAAQ;CACR,AAAQ;CACR,AAAQ;CACR,OAAO,sBAAsB;EACzB;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACH,CAAC,KAAK,GAAG;CAEV,YAAY,UAA6B,EAAE,EAAE;AACzC,SAAO;EAEP,MAAM,eAAe,mBAAwC,gBAAgB,EAAE,CAAC;EAEhF,MAAM,kBAAkB,mBAAwC,cAD9C,QAAQ,aAAa,aAAa,aAAa,UAC0B,EAAE,CAAC;EAC9F,MAAM,mBAAmB,mBAAwC,QAAQ,EAAE,CAAC;EAE5E,MAAM,aAAa;GACf,GAFqB,mBAAwC,QAAQ,EAAE,CAAC;GAGxE,GAAI,iBAAiB,QAAQ,EAAE;GAC/B,GAAG;GACN;EACD,MAAM,OAAO,QAAQ,QAAQ,WAAW,QAAQ,IAAI,aAAa,YAAY;EAC7E,MAAM,OAAO,QAAQ,QAAQ,WAAW,QAAQ,IAAI,aAAa,KAAK;EACtE,MAAM,SAAS,QAAQ,UAAU,WAAW,UAAU,IAAI,eAAe,MAAM;EAC/E,MAAM,OAAO,QAAQ,QAAQ,WAAW,MAAM,QAAQ,WAAW,QAAQ,IAAI,iBAAiB,GAAG;EACjG,MAAM,OAAO,QAAQ,QAAQ,WAAW,MAAM,QAAQ,WAAW,QAAQ,IAAI,iBAAiB,GAAG;AAEjG,OAAK,cAAc,QAAQ,QAAQ,aAAa,QAAQ,iBAAiB,QAAQ,WAAW,QAAQ,IAAI,qBAAqB,uBAAuB;AACpJ,OAAK,SAAS,WAAW,gBAAgB;GACrC;GACA,MAAM,OAAO,KAAK;GAClB,QAAQ,QAAQ,OAAO;GACvB,MAAM,QAAQ,OAAO;IAAE;IAAM;IAAM,GAAG;GACzC,CAAC;;CAGN,KAAM,MAAoB;AACtB,OAAK,cAAc;AAEnB,SAAO;;CAGX,QAAS,SAAuB;AAC5B,OAAK,cAAc;AAEnB,SAAO;;CAGX,UAAW,WAAgC;AACvC,OAAK,aAAa;AAElB,SAAO;;CAGX,MAAM,KACF,SACA,SACA,WACA,MACF;EACE,MAAM,aAAa;GACf,UAAU,IAAI,YAAY,WAAW;GACrC,GAAG,KAAK,UAAU,KAAK;GAC1B;EACD,MAAM,kBAAkB,YAAY,WAAW,KAAK,eAAe,IAAI,WAAW;EAClF,MAAM,kBAAkB,YAAY,SAAS,WAAW;EACxD,MAAM,KAAK,KAAK,kBAAkB,UAAU;AAE5C,MAAI,GAAG,SAAS,EACZ,OAAM,IAAI,MAAM,8CAA8C;AAGlE,SAAO,MAAM,KAAK,OAAO,SAAS;GAC1B;GACJ,SAAS;GACT,MAAM,KAAK;GACX,MAAM,gBAAgB,QAAQ,mBAAmB,GAAG;GACpD,MAAM,YAAY,iBAAiB,qBAAqB;IACpD,GAAG;IACH,SAAS;IACT,SAAS;IACZ,CAAC;GACL,CAAC;;CAGN,AAAQ,kBAAmB,WAA2B;EAClD,MAAM,aAAa,aAAa,KAAK;EACrC,MAAM,YAAY,MAAM,QAAQ,WAAW,GACrC,CAAC,GAAG,WAAW,GACf,aACI,CAAC,WAAW,GACZ,EAAE,EACV,SAAQ,cAAa,KAAK,mBAAmB,UAAU,CAAY;EAErE,MAAM,eAAe,mBAAwC,gBAAgB,EAAE,CAAC;EAEhF,MAAM,kBAAkB,mBAAwC,cAD9C,aAAa,aAAa,UAC+C,EAAE,CAAC;EAC9F,MAAM,cAAc,aAAa,eAC1B,aAAa,gBACb,gBAAgB,eAChB,gBAAgB,gBAChB,IAAwB,oBAAoB;AAEnD,MAAI,IAAI,WAAW,KAAK,gBAAgB,YACpC,UAAS,KAAK,YAAY;AAG9B,SAAO;;CAGX,AAAQ,mBAAoB,WAA0C;AAClE,MAAI,OAAO,cAAc,SACrB,QAAO,CAAC,UAAU;AAGtB,SAAO,OAAO,QAAQ,UAAU,CAAC,KAAK,CAAC,SAAS,WAAW;GAAE;GAAS;GAAM,EAAE;;;;;;AC7HtF,IAAa,0BAAb,MAAqC;CACjC,AAAQ;CAIR,AAAQ;CAER,YAAY,UAA8C,EAAE,EAAE;EAC1D,MAAM,WAAW,QAAQ,YAAY,IAAI,2BAA2B,UAAU;EAC9E,MAAM,SAAS,QAAQ,UAAU,IAAI,0BAA0B,UAAU;AAEzE,OAAK,WAAW,QAAQ,YAAY,IAAI,4BAA4B,IAAI,YAAY,WAAW,CAAC;AAChG,OAAK,SAAU,eAEZ;GAAE;GAAU;GAAQ,CAAC,CAAC;;CAG7B,MAAM,KAAM,SAAiB,WAAkC,OAAyB,EAAE,EAAE;EACxF,MAAM,aAAa,MAAM,QAAQ,UAAU,GAAG,YAAY,CAAC,UAAU;EACrE,MAAM,kBAAkB,YAAY,SAAS,KAAK;AAElD,MAAI,WAAW,SAAS,EACpB,QAAO,MAAM,KAAK,OAAO,SAAS;GAC9B,IAAI;GACJ,MAAM,KAAK;GACX,SAAS;GACZ,CAAC;AAGN,SAAO,MAAM,KAAK,OAAO,KAAK;GAC1B,IAAI,WAAW;GACf,MAAM,KAAK;GACX,SAAS;GACZ,CAAC;;;;;;ACjCV,IAAa,kBAAb,MAA6B;CACzB,AAAQ;CACR,AAAQ;CAER,YAAY,UAAsC,EAAE,EAAE;EAClD,MAAM,aAAa,QAAQ,cAAc,IAAI,sBAAsB,GAAG;EACtE,MAAM,YAAY,QAAQ,aAAa,IAAI,qBAAqB,GAAG;AAEnE,OAAK,aAAa,QAAQ,QAAQ,IAAI,eAAe,IAAI,YAAY,GAAG,CAAC;AACzE,OAAK,SAAS,OAAO,YAAY,UAAU;;CAG/C,MAAM,KAAM,SAAiB,WAAkC,OAAyB,EAAE,EAAE;EACxF,MAAM,aAAa,MAAM,QAAQ,UAAU,GAAG,YAAY,CAAC,UAAU;EACrE,MAAM,kBAAkB,YAAY,SAAS,KAAK;AAElD,SAAO,MAAM,QAAQ,IAAI,WAAW,IAAI,OAAM,OAAM,MAAM,KAAK,OAAO,SAAS,OAAO;GAClF,MAAM;GACN,MAAM,KAAK;GACX;GACH,CAAC,CAAC,CAAC;;;;;;AChBZ,IAAa,kBAAb,cAAqC,qBAAqB;CACtD;CACA,AAAQ;CACR,AAAQ;CAER,YAAY,UAA4B,EAAE,EAAE;AACxC,SAAO;EAEP,MAAM,eAAe,mBAAqC,eAAe,EAAE,CAAC;EAC5E,MAAM,YAAY,QAAQ,aAAa,aAAa,aAAa;EACjE,MAAM,kBAAkB,mBAAwC,cAAc,aAAa,EAAE,CAAC;EAC9F,MAAM,kBAAkB,mBAAqC,OAAO,EAAE,CAAC;EACvE,MAAM,OAAO,QAAQ,QAAQ,aAAa,QAAQ,gBAAgB;AAElE,OAAK,YAAY;AACjB,OAAK,SAAS,cAAc,WACtB,IAAI,gBAAgB;GAClB,GAAG,gBAAgB;GACnB,GAAG;GACH,GAAG,QAAQ;GACX,MAAM,QAAQ,QAAQ,QAAQ,gBAAgB,QAAQ,gBAAgB,QAAQ,QAAQ;GACzF,CAAC,GACA,IAAI,wBAAwB;GAC1B,GAAG,gBAAgB;GACnB,GAAG;GACH,GAAG,QAAQ;GACX,UAAU,QAAQ,gBAAgB,YAAY,gBAAgB,YAAY,gBAAgB,gBAAgB,YAAY;GACzH,CAAC;;CAGV,KAAM,MAAoB;AACtB,OAAK,YAAY;AAEjB,SAAO;;CAGX,QAAS,UAAwB;AAC7B,SAAO;;CAGX,UAAW,WAAwC;AAC/C,OAAK,aAAa;AAElB,SAAO;;CAGX,MAAM,KACF,SACA,UACA,WACA,MACF;EACE,MAAM,oBAAoB,aAAa,KAAK;AAE5C,MAAI,CAAC,kBACD,OAAM,IAAI,MAAM,6CAA6C;AAGjE,SAAO,MAAM,KAAK,OAAO,KAAK,SAAS,mBAAmB;GACtD,UAAU,IAAI,YAAY,WAAW;GACrC,MAAM,KAAK;GACX,GAAG,KAAK,UAAU,KAAK;GAC1B,CAAC;;;;;;AChEV,IAAa,eAAb,MAAa,aAA0D;CACnE,AAAQ;CAER,YAAY,QAAW,UAAgD,EAAE,EAAE;AACvE,OAAK,SAAS,aAAa,aAAa,QAAQ,QAAQ;;CAG5D,OAAO,KAAM,SAA6B;AACtC,SAAO,IAAI,iBAAiB,QAAQ;;CAGxC,OAAO,MAAO,SAA6B;AACvC,SAAO,KAAK,KAAK,QAAQ;;CAG7B,OAAO,IAAK,SAA4B;AACpC,SAAO,IAAI,gBAAgB,QAAQ;;CAGvC,OAAO,KAAM;AACT,SAAO,IAAI,gBAAgB;;CAG/B,OAAO,QACH,SACA,SACF;AACE,SAAO,aAAa,aAAa,WAAW,mBAAwC,kBAAkB,OAAO,EAAE,QAAQ;;CAG3H,QACI,WACA,OAAyB,EAAE,EAC7B;AACE,OAAK,OAAO,KAAK,KAAK;AAEtB,MAAI,aAAa,OAAO,cAAc,YAAY,CAAC,MAAM,QAAQ,UAAU,IAAI,QAAQ,WAAW;AAC9F,OAAI,KAAK,kBAAkB,kBACvB;QAAI,UAAU,MACV,MAAK,OAAO,UAAU,UAAU,MAAM;cAEnC,KAAK,kBAAkB,iBAC9B;QAAI,UAAU,MACV,MAAK,OAAO,UAAU,UAAU,MAAM;SAG1C,MAAK,OAAO,UAAU,UAAmB;AAG7C,UAAO,KAAK;;AAGhB,MAAI,UACA,MAAK,OAAO,UAAU,UAAmC;AAG7D,SAAO,KAAK;;CAGhB,OAAe,aACX,QACA,UAAgD,EAAE,EACpD;AACE,UAAQ,QAAR;GACI,KAAK;GACL,KAAK,QACD,QAAO,IAAI,iBAAiB,QAA6B;GAC7D,KAAK,MACD,QAAO,IAAI,gBAAgB,QAA4B;GAC3D,KAAK,KACD,QAAO,IAAI,gBAAgB;GAC/B,QACI,OAAM,IAAI,MAAM,oCAAoC,SAAS"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@arkstack/notifications",
+  "version": "0.3.17",
+  "type": "module",
+  "description": "Notification package for Arkstack applications, providing mail, SMS, and database notification drivers.",
+  "homepage": "https://arkstack.toneflix.net",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arkstack-hq/arkstack.git",
+    "directory": "packages/notifications"
+  },
+  "keywords": [
+    "notifications",
+    "mail",
+    "email",
+    "sms",
+    "twilio",
+    "africastalking",
+    "database",
+    "arkstack"
+  ],
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "africastalking": "^0.8.0",
+    "nodemailer": "^8.0.7",
+    "twilio": "^6.0.0",
+    "@arkstack/common": "^0.3.17"
+  },
+  "peerDependencies": {
+    "arkormx": "^2.0.7"
+  },
+  "devDependencies": {
+    "@types/nodemailer": "^7.0.11"
+  },
+  "scripts": {
+    "build": "tsdown --config-loader unconfig",
+    "test": "vitest",
+    "version:patch": "pnpm version patch"
+  }
+}