@arkstack/notifications 0.12.6 → 0.12.7

package/dist/index.d.ts

@@ -173,12 +173,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/notifications",
-  "version": "0.12.6",
+  "version": "0.12.7",
   "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.7"
   },
   "peerDependencies": {
-    "@arkstack/database": "^0.12.6",
-    "@arkstack/contract": "^0.12.6"
+    "@arkstack/contract": "^0.12.7",
+    "@arkstack/database": "^0.12.7"
   },
   "devDependencies": {
     "@types/nodemailer": "^7.0.11"