@facteurjs/adonisjs 2.0.0-beta.4 → 2.0.0-beta.5

package/dist/channels.d.mts

@@ -7,10 +7,17 @@ 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 { DiscordOptions } from "@facteurjs/core/channels/discord/types";
+import { SlackWebhookChannel } from "@facteurjs/core/channels/slack";
+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 { ConfigProvider } from "@adonisjs/core/types";
 
 //#region src/channels.d.ts
-
 interface DatabaseConfig {
   connectionName?: string;
   tableNames?: {

package/dist/define_config.d.mts

@@ -1,7 +1,5 @@
 import { database_d_exports } from "./channels/database.mjs";
-import { Channel } from "./core/src/types/channel.mjs";
-import { DefaultPreferences } from "./core/src/types/preferences.mjs";
-import { FacteurConfiguration } from "./core/src/types/options.mjs";
+import { Channel, DefaultPreferences, FacteurConfiguration } from "@facteurjs/core/types";
 import { ConfigProvider } from "@adonisjs/core/types";
 import { HttpContext } from "@adonisjs/core/http";
 

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { defineConfig } from "./define_config.mjs";
 import { channels } from "./channels.mjs";
 import { NotificationManager } from "./manager.mjs";
-import { configure } from "./adonisjs/configure.mjs";
+import { configure } from "./configure.mjs";
 export * from "@facteurjs/core";
 export { NotificationManager, channels, configure, defineConfig };

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { defineConfig } from "./define_config.mjs";
 import { channels } from "./channels.mjs";
 import { NotificationManager } from "./manager.mjs";
-import { configure } from "./adonisjs/configure.mjs";
+import { configure } from "./configure.mjs";
 
 export * from "@facteurjs/core"
 

package/dist/manager.d.mts

@@ -1,6 +1,6 @@
-import { DatabaseAdapter } from "./core/src/database/types.mjs";
 import { AdonisAuthorizationCallback, types_d_exports } from "./types.mjs";
 import { Facteur } from "@facteurjs/core";
+import { DatabaseAdapter } from "@facteurjs/core/database/types";
 import { HttpRouterService } from "@adonisjs/core/types";
 
 //#region src/manager.d.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@facteurjs/adonisjs",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.5",
   "description": "AdonisJS integration for Facteur - Send notifications via multiple channels in your AdonisJS application",
   "keywords": [
     "adonis",

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

@@ -1,74 +0,0 @@
-import { ChannelName } from "../types/extend.mjs";
-
-//#region ../core/src/database/types.d.ts
-type NotificationStatus = 'read' | 'seen' | 'unread' | 'unseen';
-type Identifier = string | number;
-interface AdapterGetNotificationsParams {
-  notifiableId: Identifier;
-  tenantId: Identifier | undefined;
-  page?: number | undefined;
-  status?: NotificationStatus | undefined;
-  limit?: number;
-  tags?: string[] | undefined;
-}
-interface Notification {
-  id: Identifier;
-  notifiableId: Identifier;
-  tenantId?: Identifier | undefined;
-  type: string;
-  content: Record<string, any>;
-  status: NotificationStatus;
-  tags?: string[];
-  readAt?: Date;
-  seenAt?: Date;
-  createdAt?: Date;
-  updatedAt?: Date;
-}
-interface SaveToDatabaseParams extends Omit<Notification, 'id'> {}
-interface UpdateNotificationParams {
-  id: Identifier;
-  status: NotificationStatus;
-}
-interface UpdateAllNotificationsParams {
-  notifiableId: Identifier;
-  tenantId?: Identifier | undefined;
-  status: NotificationStatus;
-}
-interface PruneNotificationsParams {
-  notifiableId?: Identifier;
-  tenantId?: Identifier;
-  olderThan?: Date;
-}
-interface GetPreferencesParams {
-  notifiableId: Identifier;
-  tenantId?: Identifier;
-}
-interface RawPreferenceRow {
-  id: Identifier;
-  user_id: Identifier;
-  tenant_id?: Identifier | null;
-  notification_name?: string | null;
-  channels: Record<string, boolean>;
-  created_at: Date;
-  updated_at?: Date | null;
-}
-interface UpdatePreferencesParams {
-  notifiableId: Identifier;
-  tenantId?: Identifier;
-  notificationName: string;
-  channelPreferences: Record<ChannelName, boolean>;
-}
-/**
- * The interface for implementing a new database adapter
- */
-interface DatabaseAdapter {
-  save: (options: SaveToDatabaseParams) => Promise<void>;
-  getNotifications: (options: AdapterGetNotificationsParams) => Promise<Notification[]>;
-  updateNotification: (options: UpdateNotificationParams) => Promise<void>;
-  updateAllNotifications: (options: UpdateAllNotificationsParams) => Promise<void>;
-  pruneNotifications: (options: PruneNotificationsParams) => Promise<void>;
-  getPreferences: (options: GetPreferencesParams) => Promise<RawPreferenceRow[]>;
-  updatePreferences: (options: UpdatePreferencesParams) => Promise<void>;
-}
-//#endregion
-export { DatabaseAdapter, Identifier };

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

@@ -1,56 +0,0 @@
-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

@@ -1,13 +0,0 @@
-//#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.mts

@@ -1,13 +0,0 @@
-//#region ../core/src/types/extend.d.ts
-
-/**
- * List of available channels
- */
-type ChannelName = keyof NotificationChannels;
-/**
- * The list of channels configured in the Facteur instance. This must
- * be extended user-land with module augmentation
- */
-interface NotificationChannels {}
-//#endregion
-export { ChannelName, NotificationChannels };

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

@@ -1,40 +0,0 @@
-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 };

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

@@ -1,141 +0,0 @@
-import { DatabaseAdapter, Identifier } from "../database/types.mjs";
-import { Channel } from "./channel.mjs";
-import { QueueAdapter } from "./queue.mjs";
-import { DefaultPreferences } from "./preferences.mjs";
-import { ChannelName } from "./extend.mjs";
-import { Emitter } from "./events.mjs";
-import { Notifiable, Notification } from "./notifications.mjs";
-import { Awaitable } from "@julr/utils/types";
-import { Logger } from "@julr/utils/logger";
-import { Duration } from "@julr/tenace/types";
-
-//#region ../core/src/types/options.d.ts
-
-/**
- * Configuration options for the Facteur library
- */
-interface FacteurConfiguration<KnownChannels extends Record<string, Channel> = Record<string, Channel>, DBAdapter extends DatabaseAdapter | null = null> {
-  logger?: Logger;
-  emitter?: Emitter;
-  /**
-   * Channels to use for sending notifications.
-   */
-  channels: KnownChannels;
-  /**
-   * A queue adapter to use for sending notifications.
-   * Needs to be provided if you want to use some queueing capabilities.
-   */
-  queueAdapter?: QueueAdapter;
-  /**
-   * Database adapter to use for storing things, like topics and preferences.
-   * If not provided, you will not be able these features.
-   */
-  databaseAdapter?: DBAdapter;
-  /**
-   * Discoverer configuration
-   */
-  discoverer: {
-    /**
-     * Directory to search for notification classes. Will scan recursively.
-     */
-    searchDirectory: URL;
-    /**
-     * Suffix for notification files.
-     * @default '_notification.ts'
-     */
-    fileSuffix?: string;
-  };
-  /**
-   * The default preferences for the users.
-   */
-  preferences?: DefaultPreferences<KnownChannels>;
-  /**
-   * A callback that will be called to instantiate a notification class.
-   * Can be handy for using dependency injection or other custom instantiation logic.
-   * If not provided, the default constructor will be used.
-   */
-  notificationResolver?: NotificationResolver;
-  /**
-   * Global retry configuration for channel sends.
-   * Can be overridden per-channel or per-send.
-   */
-  retry?: RetryConfig<KnownChannels>;
-}
-/**
- * Resolver function type for notifications
- */
-type NotificationResolver = (notification: new (ctx: MessageCtx<any, any>, ...args: any[]) => Notification, ctx: MessageCtx<any, any>) => Awaitable<Notification>;
-interface NotificationOptions<N extends Notifiable = Notifiable> {
-  /**
-   * A human readable name for the notification.
-   * Used for UI purpose
-   */
-  name: string;
-  /**
-   * A unique identifier for the notification.
-   * Used to identify the notification in the database and preferences.
-   *
-   * By default it is the class name
-   */
-  identifier?: string;
-  /**
-   * Bypass preferences and send the notification regardless of user settings.
-   * Useful for critical notifications that should always be sent.
-   */
-  critical?: boolean;
-  /**
-   * Human readable tags. Also used for UI purpose
-   */
-  tags?: string[];
-  /**
-   * Channel category
-   */
-  category?: string;
-  /**
-   * Channels to deliver the notification by.
-   */
-  deliverBy: Partial<Record<ChannelName, boolean | DeliverByOptions<N>>>;
-}
-interface DeliverByOptions<N extends Notifiable = Notifiable> {
-  if: (options: {
-    to: N;
-    params?: any;
-    preferences?: Record<string, boolean | undefined>;
-  }) => boolean;
-}
-/**
- * Parameters received by the `as*Message` methods of a notification.
- */
-interface MessageCtx<N extends Notifiable | undefined = Notifiable, Params extends Record<string, any> = {}> {
-  to: N;
-  params: Params;
-  tenantId?: Identifier | undefined;
-}
-type ExtractChannelTargets<T> = T extends Channel<any, any, any, infer U> ? U : never;
-/**
- * Retry options for channel sends
- */
-interface RetryOptions {
-  /**
-   * Number of retry attempts when a channel send fails.
-   * Uses exponential backoff with jitter.
-   * @default 0 (no retries)
-   */
-  retries?: number;
-  /**
-   * Timeout for each channel send operation.
-   * Accepts milliseconds or duration strings like '30s', '1m'.
-   */
-  timeout?: Duration;
-}
-/**
- * Global retry configuration with per-channel overrides
- */
-interface RetryConfig<KnownChannels extends Record<string, Channel> = Record<string, Channel>> extends RetryOptions {
-  /**
-   * Per-channel retry overrides
-   */
-  channels?: { [K in keyof KnownChannels]?: RetryOptions };
-}
-//#endregion
-export { ExtractChannelTargets, FacteurConfiguration, MessageCtx, NotificationOptions };

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

@@ -1,28 +0,0 @@
-import { Channel } from "./channel.mjs";
-
-//#region ../core/src/types/preferences.d.ts
-type ChannelPreferences<KnownChannels extends Record<string, Channel>> = Record<keyof KnownChannels, boolean>;
-/**
- * Shape for the `preferences` option in facteur configuration
- */
-interface DefaultPreferences<KnownChannels extends Record<string, Channel>> {
-  /**
-   * If false, user preferences will not be taken into account before sending notifications.
-   */
-  enabled?: boolean;
-  /**
-   * Global preferences for all notifications.
-   */
-  global?: {
-    channels?: ChannelPreferences<KnownChannels>;
-  };
-  /**
-   * Per-category preferences.
-   * Use `Notification.options.category` to define category on a notification.
-   */
-  categories?: Record<string, {
-    channels?: Partial<ChannelPreferences<KnownChannels>>;
-  } | boolean>;
-}
-//#endregion
-export { DefaultPreferences };

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

@@ -1,11 +0,0 @@
-//#region ../core/src/types/queue.d.ts
-interface QueueItemOptions {
-  delay?: number;
-}
-interface QueueAdapter {
-  queue(message: any, options?: QueueItemOptions): Promise<void>;
-  startQueueProcessor(): void;
-  disconnect(): void;
-}
-//#endregion
-export { QueueAdapter };