@facteurjs/adonisjs 1.0.0-beta.3 → 2.0.0-beta.0

package/README.md

@@ -0,0 +1,25 @@
+# @facteurjs/adonisjs
+
+AdonisJS integration for Facteur - Send notifications via multiple channels in your AdonisJS application.
+
+## Installation
+
+```bash
+npm install @facteurjs/adonisjs
+node ace configure @facteurjs/adonisjs
+```
+
+## Features
+
+- Full integration with AdonisJS ecosystem
+- Support for `@adonisjs/mail`, `@adonisjs/redis`, `@adonisjs/lucid`, `@adonisjs/transmit`
+- Queueable notifications
+- Database storage for notification history
+
+## Documentation
+
+Full documentation available at [facteur.julr.dev](https://facteur.julr.dev)
+
+## License
+
+MIT

package/dist/_virtual/rolldown_runtime.mjs

@@ -0,0 +1,36 @@
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __exportAll = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+
+//#endregion
+export { __exportAll, __reExport };

package/dist/adonisjs/configure.d.mts

@@ -0,0 +1,6 @@
+import ConfigureCommand from "@adonisjs/core/commands/configure";
+
+//#region configure.d.ts
+declare function configure(command: ConfigureCommand): Promise<void>;
+//#endregion
+export { configure };

package/dist/adonisjs/configure.mjs

@@ -0,0 +1,44 @@
+import { stubsRoot } from "./stubs/index.mjs";
+import { fileURLToPath } from "node:url";
+import { join } from "node:path";
+import { readFile, writeFile } from "node:fs/promises";
+
+//#region configure.ts
+async function addSubpathImport(command) {
+	try {
+		const pkgJson = await readFile(join(fileURLToPath(command.app.appRoot), "package.json"), "utf-8");
+		const pkg = JSON.parse(pkgJson);
+		pkg.imports ??= {};
+		pkg.imports["#notifications/*"] = "./app/notifications/*.js";
+		await writeFile(join(fileURLToPath(command.app.appRoot), "package.json"), JSON.stringify(pkg, null, 2) + "\n");
+	} catch (error) {
+		command.logger.error("Failed to add subpath import in your package.json :" + error.message);
+		command.logger.error("Please add the following to your package.json:\n");
+		command.logger.error(`\n"imports": {\n  "#notifications/*": "./app/notifications/*.js"\n},\n`);
+	}
+}
+async function configure(command) {
+	const codemods = await command.createCodemods();
+	await codemods.makeUsingStub(stubsRoot, "config/notifications.stub", {});
+	await codemods.updateRcFile((rcFile) => {
+		rcFile.addProvider("@facteurjs/adonisjs/facteur_provider");
+	});
+	await addSubpathImport(command);
+	await codemods.makeUsingStub(stubsRoot, "migration.stub", {
+		entity: command.app.generators.createEntity("notifications"),
+		migration: {
+			folder: "database/migrations",
+			fileName: `${(/* @__PURE__ */ new Date()).getTime()}_create_notifications_table.ts`
+		}
+	});
+	await codemods.makeUsingStub(stubsRoot, "migrations/preferences.stub", {
+		entity: command.app.generators.createEntity("notifications_preferences"),
+		migration: {
+			folder: "database/migrations",
+			fileName: `${(/* @__PURE__ */ new Date()).getTime()}_create_notifications_preferences_table.ts`
+		}
+	});
+}
+
+//#endregion
+export { configure };

package/dist/adonisjs/stubs/index.mjs

@@ -0,0 +1,5 @@
+//#region stubs/index.ts
+const stubsRoot = import.meta.dirname;
+
+//#endregion
+export { stubsRoot };

package/dist/adonisjs/stubs/stubs/config/notifications.stub

@@ -0,0 +1,17 @@
+import { databases } from '@facteurjs/adonisjs/database'
+import { defineConfig, channels } from '@facteurjs/adonisjs'
+import type { InferChannels } from '@facteurjs/adonisjs/types'
+
+const config = defineConfig({
+  databaseAdapter: databases.lucid({ connectionName: '' }),
+  channels: {
+    mail: channels.mail(),
+    database: channels.database({ connectionName: '' }),
+  },
+})
+
+export default config
+
+declare module '@facteurjs/adonisjs/types' {
+  interface NotificationChannels extends InferChannels<typeof config> {}
+}

package/dist/adonisjs/stubs/stubs/index.ts

@@ -0,0 +1 @@
+export const stubsRoot = import.meta.dirname

package/dist/adonisjs/stubs/stubs/make/notification.stub

@@ -0,0 +1,9 @@
+{{{
+  exports({
+    to: app.makePath(app.rcFile.directories['notifications'], notificationFileName)
+  })
+}}}
+import User from '#models/user'
+
+interface NotificationParams {}
+export default class {{ notificationName }} extends Notification<User, NotificationParams> {}

package/dist/adonisjs/stubs/stubs/migrations/notifications.stub

@@ -0,0 +1,36 @@
+{{{
+  exports({
+    to: app.makePath(migration.folder, entity.path, migration.fileName)
+  })
+}}}
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+export default class extends BaseSchema {
+  protected tableName = 'notifications'
+
+  async up() {
+    this.schema.createTable(this.tableName, (table) => {
+      table.increments('id').primary()
+      table.text('notifiable_id').notNullable()
+      table.text('tenant_id').nullable()
+      table.text('type').notNullable()
+      table.jsonb('content').notNullable()
+      table.text('status').notNullable().defaultTo('unseen')
+      table.jsonb('tags').nullable()
+      table.timestamp('read_at').nullable()
+      table.timestamp('seen_at').nullable()
+
+      table.timestamp('created_at').notNullable()
+      table.timestamp('updated_at').nullable()
+
+      table.index(['notifiable_id'])
+      table.index(['tenant_id'])
+      table.index(['status'])
+      table.index(['notifiable_id', 'tenant_id'])
+    })
+  }
+
+  async down() {
+    this.schema.dropTable(this.tableName)
+  }
+}

package/dist/adonisjs/stubs/stubs/migrations/preferences.stub

@@ -0,0 +1,32 @@
+{{{
+  exports({
+    to: app.makePath(migration.folder, entity.path, migration.fileName)
+  })
+}}}
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+export default class extends BaseSchema {
+  protected tableName = 'notification_preferences'
+
+  async up() {
+    this.schema.createTable(this.tableName, (table) => {
+      table.increments('id').primary()
+
+      table.text('user_id').notNullable()
+      table.text('tenant_id').nullable()
+      table.text('notification_name').nullable()
+      table.json('channels').notNullable()
+
+      table.timestamp('created_at').notNullable()
+      table.timestamp('updated_at').nullable()
+
+      table.index(['user_id'])
+      table.index(['tenant_id'])
+      table.unique(['user_id', 'tenant_id', 'notification_name'])
+    })
+  }
+
+  async down() {
+    this.schema.dropTable(this.tableName)
+  }
+}

package/dist/channels/aws-sns.d.mts

@@ -0,0 +1,9 @@
+export * from "@facteurjs/core/channels/aws-sns";
+export * from "@facteurjs/core/channels/aws-sns/types";
+
+//#region src/channels/aws-sns.d.ts
+
+import * as import__facteurjs_core_channels_aws_sns from "@facteurjs/core/channels/aws-sns";
+import * as import__facteurjs_core_channels_aws_sns_types from "@facteurjs/core/channels/aws-sns/types";
+//#endregion
+export { import__facteurjs_core_channels_aws_sns_types as aws_sns_d_exports };

package/dist/channels/{aws-sns.js → aws-sns.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/aws-sns"
 
 export * from "@facteurjs/core/channels/aws-sns/types"
+
+export {  };

package/dist/channels/database.d.mts

@@ -0,0 +1,9 @@
+export * from "@facteurjs/core/database";
+export * from "@facteurjs/core/database/types";
+
+//#region src/channels/database.d.ts
+
+import * as import__facteurjs_core_database from "@facteurjs/core/database";
+import * as import__facteurjs_core_database_types from "@facteurjs/core/database/types";
+//#endregion
+export { import__facteurjs_core_database_types as database_d_exports };

package/dist/channels/{database.js → database.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/database"
 
 export * from "@facteurjs/core/database/types"
+
+export {  };

package/dist/channels/discord.d.mts

@@ -0,0 +1,9 @@
+export * from "@facteurjs/core/channels/discord";
+export * from "@facteurjs/core/channels/discord/types";
+
+//#region src/channels/discord.d.ts
+
+import * as import__facteurjs_core_channels_discord from "@facteurjs/core/channels/discord";
+import * as import__facteurjs_core_channels_discord_types from "@facteurjs/core/channels/discord/types";
+//#endregion
+export { import__facteurjs_core_channels_discord_types as discord_d_exports };

package/dist/channels/{discord.js → discord.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/discord"
 
 export * from "@facteurjs/core/channels/discord/types"
+
+export {  };

package/dist/channels/{expo.js → expo.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/expo"
 
 export * from "@facteurjs/core/channels/expo/types"
+
+export {  };

package/dist/channels/fcm.d.mts

@@ -0,0 +1,9 @@
+export * from "@facteurjs/core/channels/fcm";
+export * from "@facteurjs/core/channels/fcm/types";
+
+//#region src/channels/fcm.d.ts
+
+import * as import__facteurjs_core_channels_fcm from "@facteurjs/core/channels/fcm";
+import * as import__facteurjs_core_channels_fcm_types from "@facteurjs/core/channels/fcm/types";
+//#endregion
+export { import__facteurjs_core_channels_fcm_types as fcm_d_exports };

package/dist/channels/{fcm.js → fcm.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/fcm"
 
 export * from "@facteurjs/core/channels/fcm/types"
+
+export {  };

package/dist/channels/{mail.d.ts → mail.d.mts}

@@ -1,4 +1,4 @@
-import { types_d_exports } from "../types.js";
+import { types_d_exports } from "../types.mjs";
 import { BaseMail, Message } from "@adonisjs/mail";
 import { MailService } from "@adonisjs/mail/types";
 

package/dist/channels/{mail.js → mail.mjs}

@@ -1,4 +1,4 @@
-import { types_exports } from "../types.js";
+import { types_exports } from "../types.mjs";
 import { errors } from "@facteurjs/core";
 import { BaseMail, Message } from "@adonisjs/mail";
 
@@ -15,6 +15,7 @@ var MailChannel = class {
 	async send(options) {
 		const targets = options.targets;
 		if (!targets || !targets.email) throw new errors.E_UNAVAILABLE_TARGETS(["Mail"]);
+		console.log(options.message);
 		if (options.message instanceof BaseMail) {
 			options.message.message.to(targets.email);
 			this.config.mailer.send(options.message);

package/dist/channels/{slack.js → slack.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/slack"
 
 export * from "@facteurjs/core/channels/slack/types"
+
+export {  };

package/dist/channels/socketio.d.mts

@@ -0,0 +1,9 @@
+export * from "@facteurjs/core/channels/socketio";
+export * from "@facteurjs/core/channels/socketio/types";
+
+//#region src/channels/socketio.d.ts
+
+import * as import__facteurjs_core_channels_socketio from "@facteurjs/core/channels/socketio";
+import * as import__facteurjs_core_channels_socketio_types from "@facteurjs/core/channels/socketio/types";
+//#endregion
+export { import__facteurjs_core_channels_socketio_types as socketio_d_exports };

package/dist/channels/{socketio.js → socketio.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/socketio"
 
 export * from "@facteurjs/core/channels/socketio/types"
+
+export {  };

package/dist/channels/transmit.d.mts

@@ -0,0 +1,9 @@
+export * from "@facteurjs/core/channels/transmit";
+export * from "@facteurjs/core/channels/transmit/types";
+
+//#region src/channels/transmit.d.ts
+
+import * as import__facteurjs_core_channels_transmit from "@facteurjs/core/channels/transmit";
+import * as import__facteurjs_core_channels_transmit_types from "@facteurjs/core/channels/transmit/types";
+//#endregion
+export { import__facteurjs_core_channels_transmit_types as transmit_d_exports };

package/dist/channels/{transmit.js → transmit.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/transmit"
 
 export * from "@facteurjs/core/channels/transmit/types"
+
+export {  };

package/dist/channels/twilio.d.mts

@@ -0,0 +1,9 @@
+export * from "@facteurjs/core/channels/twilio";
+export * from "@facteurjs/core/channels/twilio/types";
+
+//#region src/channels/twilio.d.ts
+
+import * as import__facteurjs_core_channels_twilio from "@facteurjs/core/channels/twilio";
+import * as import__facteurjs_core_channels_twilio_types from "@facteurjs/core/channels/twilio/types";
+//#endregion
+export { import__facteurjs_core_channels_twilio_types as twilio_d_exports };

package/dist/channels/{twilio.js → twilio.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/twilio"
 
 export * from "@facteurjs/core/channels/twilio/types"
+
+export {  };

package/dist/channels/{webhook.js → webhook.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/webhook"
 
 export * from "@facteurjs/core/channels/webhook/types"
+
+export {  };

package/dist/channels/webpush.d.mts

@@ -0,0 +1,9 @@
+export * from "@facteurjs/core/channels/webpush";
+export * from "@facteurjs/core/channels/webpush/types";
+
+//#region src/channels/webpush.d.ts
+
+import * as import__facteurjs_core_channels_webpush from "@facteurjs/core/channels/webpush";
+import * as import__facteurjs_core_channels_webpush_types from "@facteurjs/core/channels/webpush/types";
+//#endregion
+export { import__facteurjs_core_channels_webpush_types as webpush_d_exports };

package/dist/channels/{webpush.js → webpush.mjs}

@@ -1,3 +1,5 @@
 export * from "@facteurjs/core/channels/webpush"
 
 export * from "@facteurjs/core/channels/webpush/types"
+
+export {  };

package/dist/{channels.d.ts → channels.d.mts}

@@ -1,22 +1,16 @@
-import { aws_sns_d_exports } from "./channels/aws-sns.js";
-import { database_d_exports } from "./channels/database.js";
-import { discord_d_exports } from "./channels/discord.js";
-import { fcm_d_exports } from "./channels/fcm.js";
-import { socketio_d_exports } from "./channels/socketio.js";
-import { transmit_d_exports } from "./channels/transmit.js";
-import { twilio_d_exports } from "./channels/twilio.js";
-import { webpush_d_exports } from "./channels/webpush.js";
-import { MailChannel } from "./channels/mail.js";
-import { DiscordOptions } from "@facteurjs/core/channels/discord/types";
-import { SlackOptions } from "@facteurjs/core/channels/slack/types";
-import { TwilioConfig } from "@facteurjs/core/channels/twilio/types";
-import { FcmConfig } from "@facteurjs/core/channels/fcm/types";
-import { WebpushConfig } from "@facteurjs/core/channels/webpush/types";
-import { ExpoChannel } from "@facteurjs/core/channels/expo";
-import { ExpoConfig } from "@facteurjs/core/channels/expo/types";
+import { aws_sns_d_exports } from "./channels/aws-sns.mjs";
+import { database_d_exports } from "./channels/database.mjs";
+import { discord_d_exports } from "./channels/discord.mjs";
+import { fcm_d_exports } from "./channels/fcm.mjs";
+import { socketio_d_exports } from "./channels/socketio.mjs";
+import { transmit_d_exports } from "./channels/transmit.mjs";
+import { twilio_d_exports } from "./channels/twilio.mjs";
+import { webpush_d_exports } from "./channels/webpush.mjs";
+import { MailChannel } from "./channels/mail.mjs";
 import { ConfigProvider } from "@adonisjs/core/types";
 
 //#region src/channels.d.ts
+
 interface DatabaseConfig {
   connectionName?: string;
   tableNames?: {
@@ -26,7 +20,7 @@ interface DatabaseConfig {
 }
 declare const channels: {
   discordWebhook<Options extends DiscordOptions<any>>(config: Options): ConfigProvider<discord_d_exports.DiscordProvider<Options>>;
-  slackWebhook<Options extends SlackOptions<any>>(config: Options): ConfigProvider<discord_d_exports.DiscordProvider<Options>>;
+  slackWebhook<Options extends SlackOptions<any>>(config: Options): ConfigProvider<SlackWebhookChannel<Options>>;
   database(config: DatabaseConfig): ConfigProvider<database_d_exports.DatabaseChannel>;
   kysely(config: database_d_exports.KyselyConfig): ConfigProvider<database_d_exports.DatabaseChannel>;
   twilio(config: TwilioConfig): ConfigProvider<twilio_d_exports.TwilioChannel>;

package/dist/{channels.js → channels.mjs}

@@ -1,5 +1,5 @@
-import { configProvider } from "@adonisjs/core";
 import { RuntimeException } from "@adonisjs/core/exceptions";
+import { configProvider } from "@adonisjs/core";
 
 //#region src/channels.ts
 const channels = {
@@ -19,12 +19,11 @@ const channels = {
 		return configProvider.create(async (app) => {
 			const db = await app.container.make("lucid.db");
 			const connectionName = config?.connectionName || db.primaryConnectionName;
-			const connection = db.manager.get(connectionName);
 			/**
 			* Throw error when mentioned connection is not specified
 			* in the database file
 			*/
-			if (!connection) throw new RuntimeException(`Invalid connection name "${connectionName}" referenced by "config/notifications.ts" file. First register the connection inside "config/database.ts" file`);
+			if (!db.manager.get(connectionName)) throw new RuntimeException(`Invalid connection name "${connectionName}" referenced by "config/notifications.ts" file. First register the connection inside "config/database.ts" file`);
 			const { databaseChannel } = await import("@facteurjs/core/database");
 			const { knexAdapter } = await import("@facteurjs/core/database/adapters/knex");
 			return databaseChannel({ adapter: knexAdapter({
@@ -52,15 +51,13 @@ const channels = {
 	transmit() {
 		return configProvider.create(async (app) => {
 			const { transmitChannel } = await import("@facteurjs/core/channels/transmit");
-			const transmit = await app.container.make("transmit");
-			return transmitChannel({ transmit });
+			return transmitChannel({ transmit: await app.container.make("transmit") });
 		});
 	},
 	mail() {
 		return configProvider.create(async (app) => {
-			const { mailChannel } = await import("./channels/mail.js");
-			const mailer = await app.container.make("mail.manager");
-			return mailChannel({ mailer });
+			const { mailChannel } = await import("./channels/mail.mjs");
+			return mailChannel({ mailer: await app.container.make("mail.manager") });
 		});
 	},
 	fcm(config) {

package/dist/core/src/database/{types.d.ts → types.d.mts}

@@ -1,4 +1,4 @@
-import { ChannelName } from "../types/extend.js";
+import { ChannelName } from "../types/extend.mjs";
 
 //#region ../core/src/database/types.d.ts
 type NotificationStatus = 'read' | 'seen' | 'unread' | 'unseen';
@@ -39,10 +39,6 @@ interface PruneNotificationsParams {
   tenantId?: Identifier;
   olderThan?: Date;
 }
-/**
- * Options accepted by the database provider
- */
-
 interface GetPreferencesParams {
   notifiableId: Identifier;
   tenantId?: Identifier;
@@ -75,4 +71,4 @@ interface DatabaseAdapter {
   updatePreferences: (options: UpdatePreferencesParams) => Promise<void>;
 }
 //#endregion
-export { DatabaseAdapter };
+export { DatabaseAdapter, Identifier };

package/dist/core/src/types/channel.d.mts

@@ -0,0 +1,56 @@
+import { Identifier } from "../database/types.mjs";
+import { Awaitable } from "@julr/utils/types";
+
+//#region ../core/src/types/channel.d.ts
+type ChannelSendParams<Message, Targets> = {
+  to?: any;
+  message: Message;
+  targets?: Targets;
+  tenantId?: Identifier | undefined;
+};
+/**
+ * Result of a batch send operation
+ */
+interface BatchSendResult {
+  success: number;
+  failed: number;
+  results: Array<{
+    index: number;
+    status: 'success' | 'failed';
+    error?: Error;
+    response?: any;
+  }>;
+}
+/**
+ * Configuration for batch sending capabilities
+ */
+interface BatchConfig {
+  /**
+   * Maximum number of messages per batch API call.
+   * E.g. 500 for FCM, 100 for Expo
+   */
+  maxSize: number;
+  /**
+   * Whether batching is enabled for this channel.
+   * @default true
+   */
+  enabled?: boolean;
+}
+declare const kTargetSymbol: unique symbol;
+interface Channel<_Options = any, Message = any, Response = any, Targets = any> {
+  [kTargetSymbol]: Targets;
+  name: string;
+  send: (options: ChannelSendParams<Message, Targets>) => Awaitable<Response>;
+  /**
+   * Optional batch send method for providers that support sending multiple messages in one API call.
+   * When implemented, the orchestration layer will group messages and use this method.
+   */
+  sendBatch?: (messages: ChannelSendParams<Message, Targets>[]) => Awaitable<BatchSendResult>;
+  /**
+   * Configuration for batch sending.
+   * Required when sendBatch is implemented.
+   */
+  batchConfig?: BatchConfig;
+}
+//#endregion
+export { Channel };

package/dist/core/src/types/events.d.mts

@@ -0,0 +1,13 @@
+//#region ../core/src/types/events.d.ts
+/**
+ * Shape of the emitter accepted by facteur
+ * Should be compatible with node's EventEmitter and Emittery
+ */
+interface Emitter {
+  on: (event: string, callback: (...values: any[]) => void) => void;
+  once: (event: string, callback: (...values: any[]) => void) => void;
+  off: (event: string, callback: (...values: any[]) => void) => void;
+  emit: (event: string, ...values: any[]) => void;
+}
+//#endregion
+export { Emitter };

package/dist/core/src/types/{extend.d.ts → extend.d.mts}

@@ -9,9 +9,5 @@ type ChannelName = keyof NotificationChannels;
  * be extended user-land with module augmentation
  */
 interface NotificationChannels {}
-/**
- * The type of the notification.content in database notifications.
- * This must be extended user-land with module augmentation
- */
 //#endregion
-export { ChannelName };
+export { ChannelName, NotificationChannels };

package/dist/core/src/types/notifications.d.mts

@@ -0,0 +1,40 @@
+import { Identifier } from "../database/types.mjs";
+import { NotificationChannels } from "./extend.mjs";
+import { ExtractChannelTargets, MessageCtx, NotificationOptions } from "./options.mjs";
+import { Awaitable } from "@julr/utils/types";
+
+//#region ../core/src/types/notifications.d.ts
+
+/**
+ * Base abstract class for all notifications
+ */
+declare abstract class Notification<N extends Notifiable | undefined = Notifiable | undefined, Params extends Record<string, any> = any> {
+  protected notifiable: N;
+  protected params: Params;
+  protected tenantId: Identifier | undefined;
+  constructor(ctx: MessageCtx<N, Params>);
+  static options: NotificationOptions<any>;
+  /**
+   * Determine if the notification should be sent or not
+   */
+  shouldSend(): Awaitable<boolean>;
+  /**
+   * Method invoked before sending the notification.
+   * Can be used to perform any pre-send logic.
+   */
+  beforeSend(): Awaitable<void>;
+  /**
+   * Method invoked after the notification has been sent.
+   * Can be used to perform any post-send logic.
+   */
+  afterSend(): Awaitable<void>;
+}
+/**
+ * Interface for entities that can receive notifications
+ */
+interface Notifiable {
+  notificationTargets?(): NotifiableTargets;
+}
+type NotifiableTargets = { [K in keyof NotificationChannels]?: ExtractChannelTargets<NotificationChannels[K]> };
+//#endregion
+export { Notifiable, Notification };