@arkstack/notifications 0.12.6 → 0.12.8

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { DotPath, DotPathValue, MergedConfig } from "@arkstack/common";
-import { Model } from "@arkstack/database";
 import { Transporter } from "nodemailer";
+import { Model } from "@arkstack/database";
 import * as _$arkormx from "arkormx";
 import { User } from "@arkstack/auth";
 import * as _$twilio_lib_rest_api_v2010_account_message0 from "twilio/lib/rest/api/v2010/account/message.js";
@@ -30,11 +30,6 @@ type MailRecipient = string | MailRecipientAddress | Array<string | MailRecipien
 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?: 'africastalking' | 'twilio' | 'file' | 'smtp';
   host?: string;
@@ -147,17 +142,28 @@ declare abstract class NotificationContract<TResult = DriverResult> {
   };
 }
 //#endregion
+//#region src/Contracts/User.d.ts
+declare abstract class User$1 extends Model {
+  [key: string]: any;
+  email: string;
+  name: string;
+  password: string;
+  createdAt: Date;
+  updatedAt: Date;
+  protected static table?: string | undefined;
+}
+//#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;
+  recipient(recipient: NotificationRecipient | User$1): 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>>;
+  create(user: User$1, payload: DbNotificationPayload): Promise<UserNotification & _$arkormx.Model<any, any>>;
   send(message: string, subject?: string, _recipient?: NotificationRecipient, data?: NotificationData): Promise<UserNotification & _$arkormx.Model<any, any>>;
 }
 //#endregion
@@ -173,12 +179,56 @@ declare class MailNotification extends NotificationContract {
   private fileDirectory?;
   constructor(options?: MailDriverOptions);
   from(from: string): this;
+  /**
+   * The email subject
+   *
+   * @param subject
+   * @returns
+   */
   subject(subject: string): this;
+  /**
+   * Set email the notification recipeint
+   *
+   * @param recipient string or array of email addresses
+   * @returns
+   */
   recipient(recipient: MailRecipient): this;
+  /**
+   * Set email the notification view name
+   *
+   * @param view view name
+   * @returns
+   */
   view(view: string): this;
+  /**
+   * Set email the notification html template
+   *
+   * @param content view name
+   * @returns
+   */
   html(content: string): this;
+  /**
+   * Set email the notification text template
+   *
+   * @param content view name
+   * @returns
+   */
   text(content: string): this;
+  /**
+   * Prepare a notification to be sent.
+   *
+   * @param user The recipient user(s) for the notification.
+   */
   prepare(user?: null | string | string[] | User, data?: Record<string, any>): this;
+  /**
+   * Send a notification to the specified recipient(s) with the given message.
+   *
+   * @param message The message content to be sent to the recipient(s).
+   * @param subject The message subject to be sent to the recipient(s).
+   * @param recipient An array of recipient identifiers
+   * @param data Additioal context data
+   * @returns
+   */
   send(message: string, subject?: string, recipient?: MailRecipient, data?: NotificationData): Promise<any>;
   private storeFileMail;
   private resolveRecipients;
@@ -231,18 +281,18 @@ declare class Notification<D extends keyof DriverMap = keyof DriverMap> {
   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];
+  prepare(recipient?: null | MailRecipient | NotificationRecipient | User$1, 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 create(user: User$1, payload: DbNotificationPayload): Promise<UserNotification & _$arkormx.Model<any, any>>;
+  static forUser(user: User$1): Promise<_$arkormx.ArkormCollection<UserNotification & _$arkormx.Model<any, any>, (UserNotification & _$arkormx.Model<any, any>)[]>>;
+  static unreadForUser(user: User$1): 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 markAllRead(user: User$1): Promise<void>;
   static delete(notification: UserNotification | UserNotification['id']): Promise<void>;
 }
 //#endregion
@@ -252,4 +302,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, MailDriverOptions, MailNotification, MailRecipient, MailRecipientAddress, MergedTransportConfig, Notification, NotificationChannel, NotificationConfig, NotificationContract, NotificationData, NotificationDriverMap, NotificationRecipient, NotificationUser, SmsDriverName, SmsDriverOptions, SmsNotification, TwilioSmsDriver, UserNotification, UserNotificationCenter, configure, interpolate };
+export { AfricasTalkingSmsDriver, DbNotification, DbNotificationPayload, DbNotificationType, DriverResult, MailDriverOptions, MailNotification, MailRecipient, MailRecipientAddress, MergedTransportConfig, Notification, NotificationChannel, NotificationConfig, NotificationContract, NotificationData, NotificationDriverMap, NotificationRecipient, SmsDriverName, SmsDriverOptions, SmsNotification, TwilioSmsDriver, UserNotification, UserNotificationCenter, configure, interpolate };

package/dist/index.js

@@ -1,11 +1,11 @@
 import { config, env, getModel } from "@arkstack/common";
-import { Model } from "@arkstack/database";
 import { mkdir, writeFile } from "node:fs/promises";
 import { join } from "node:path";
 import nodemailer from "nodemailer";
 import { Arkstack } from "@arkstack/contract";
 import africastalking from "africastalking";
 import twilio from "twilio";
+import { Model } from "@arkstack/database";
 //#region src/Contracts/NotificationContract.ts
 var NotificationContract = class {
 	contextData = {};
@@ -22,12 +22,6 @@ var NotificationContract = class {
 	}
 };
 //#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() {
@@ -55,10 +49,10 @@ var UserNotificationCenter = class {
 	}
 	static async markRead(notification) {
 		const Model = await this.getModel();
-		const id = notification instanceof UserNotification ? notification.id : notification;
+		const id = typeof notification === "object" ? notification.id : notification;
 		const readAt = /* @__PURE__ */ new Date();
 		await Model.query().where({ id }).update({ readAt });
-		if (notification instanceof UserNotification) notification.readAt = readAt;
+		if (typeof notification === "object") notification.readAt = readAt;
 	}
 	static async markAllRead(user) {
 		await (await this.getModel()).query().where({
@@ -68,7 +62,7 @@ var UserNotificationCenter = class {
 	}
 	static async delete(notification) {
 		const Model = await this.getModel();
-		const id = notification instanceof UserNotification ? notification.id : notification;
+		const id = typeof notification === "object" ? notification.id : notification;
 		await Model.query().where({ id }).delete();
 	}
 };
@@ -469,4 +463,10 @@ var Notification = class Notification {
 	}
 };
 //#endregion
+//#region src/Contracts/UserNotification.ts
+var UserNotification = class extends Model {
+	static table = "user_notifications";
+	casts = { meta: "json" };
+};
+//#endregion
 export { AfricasTalkingSmsDriver, DbNotification, MailNotification, Notification, NotificationContract, SmsNotification, TwilioSmsDriver, UserNotification, UserNotificationCenter, configure, interpolate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.12.6",
+  "version": "0.12.8",
   "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,11 +34,11 @@
     "africastalking": "^0.8.0",
     "nodemailer": "^8.0.7",
     "twilio": "^6.0.0",
-    "@arkstack/common": "^0.12.6"
+    "@arkstack/common": "^0.12.8"
   },
   "peerDependencies": {
-    "@arkstack/database": "^0.12.6",
-    "@arkstack/contract": "^0.12.6"
+    "@arkstack/database": "^0.12.8",
+    "@arkstack/contract": "^0.12.8"
   },
   "devDependencies": {
     "@types/nodemailer": "^7.0.11"