@messenger-box/platform-server 10.0.3-alpha.7 → 10.0.3-alpha.74

package/lib/services/messenger-notification-service.d.ts

@@ -1,24 +1,119 @@
 import { ServiceBroker } from 'moleculer';
-import { IChannel, IPost, IPreference_Account as IPreferenceAccount, IUserAccount, ICountryRepository, IChannelRepository, IExpoNotification, IExpoNotificationBodyData, IMessengerNotificationService, IPostRepository, IPostThreadRepository, ISupportServiceConfig, NotificationDurationUnitEnum, IExpoNotificationData } from 'common';
+import { IChannel, IPost, ICountryRepository, IChannelRepository, IExpoNotification, IExpoNotificationBodyData, IMessengerNotificationService, IPostRepository, IPostThreadRepository, ISupportServiceConfig, NotificationDurationUnitEnum, IExpoNotificationData } from 'common/server';
 import { CdmLogger } from '@cdm-logger/core';
+import { Disposable, DisposableCollection } from '@adminide-stack/core';
 export interface IChannelWithPost extends IChannel {
     post: IPost;
 }
 export interface IMemberWithAllChannels {
     [key: string]: IChannelWithPost[];
 }
-export declare class MessengerNotificationService implements IMessengerNotificationService {
+/**
+ * Messenger Notification Service Implementation
+ *
+ * This service handles comprehensive notification management within the messenger platform,
+ * providing operations for sending various types of notifications including email, SMS,
+ * push notifications, and Expo notifications across different messaging contexts.
+ *
+ * Key capabilities:
+ * - Multi-channel notification delivery (email, SMS, push, Expo)
+ * - Unread message notification scheduling and management
+ * - User preference-based notification filtering
+ * - Support service notification handling
+ * - Alert message notification broadcasting
+ * - Thread-based notification management
+ * - Real-time push notification integration
+ * - Template-based notification customization
+ * - Channel and post-based notification routing
+ * - User aggregation and preference management
+ *
+ * The service integrates with multiple external services through Moleculer broker
+ * and provides comprehensive error handling and logging for notification workflows.
+ */
+export declare class MessengerNotificationService implements IMessengerNotificationService, Disposable {
     private readonly channelRepository;
     private readonly postRepository;
     private readonly postThreadRepository;
     private readonly countryRepository;
     private readonly broker;
-    private readonly logger;
-    users: Record<string, IUserAccount>;
-    userPreferences: Record<string, IPreferenceAccount>;
-    supportServiceenvConfig: ISupportServiceConfig;
+    protected readonly toDispose: DisposableCollection;
+    private users;
+    private userPreferences;
+    private supportServiceenvConfig;
+    private logger;
     constructor(channelRepository: IChannelRepository, postRepository: IPostRepository, postThreadRepository: IPostThreadRepository, countryRepository: ICountryRepository, broker: ServiceBroker, logger: CdmLogger.ILogger);
-    setSupportServiceConfig(config: ISupportServiceConfig): Promise<void>;
+    /**
+     * Disposes of resources used by the service
+     */
+    dispose(): void;
+    /**
+     * Sets the support service configuration
+     *
+     * @description Updates the support service notification configuration for customized notifications
+     *
+     * @param {ISupportServiceConfig} config - Support service configuration
+     * @returns {Promise<void | Error>} - Void promise or error
+     */
+    setSupportServiceConfig(config: ISupportServiceConfig): Promise<void | Error>;
+    /**
+     * Sends notification for unread messages within a specified time frame
+     *
+     * @description Aggregates unread messages across channels and sends notifications
+     * to users based on their preferences within the specified duration
+     *
+     * @param {NotificationDurationUnitEnum} unit - Time unit for the duration
+     * @param {number} value - Number of time units to look back
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    sendNotificationOfUnreadMessages(unit: NotificationDurationUnitEnum, value: number): Promise<boolean | Error>;
+    /**
+     * Sends Expo push notifications
+     *
+     * @description Sends push notifications through the Expo notification service
+     *
+     * @param {IExpoNotificationData} data - Notification data
+     * @returns {Promise<IExpoNotification | Error>} - Notification result or error
+     */
+    sendPushNotificationsExpo(data: IExpoNotificationData): Promise<IExpoNotification | Error>;
+    /**
+     * Sends Expo notification when a post is created
+     *
+     * @description Handles push notification logic for new posts with thread and channel support
+     *
+     * @param {IPost} post - The post that triggered the notification
+     * @param {IExpoNotificationBodyData} notificationData - Optional notification data override
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    sendExpoNotificationOnPost(post: IPost, notificationData?: IExpoNotificationBodyData): Promise<boolean | Error>;
+    /**
+     * Sends general notifications for a post
+     *
+     * @description Handles email and SMS notifications for posts with template support
+     *
+     * @param {IPost} post - The post that triggered the notification
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    sendNotificationOnPost(post: IPost): Promise<boolean | Error>;
+    /**
+     * Sends notifications for alert messages within a time frame
+     *
+     * @description Processes and sends notifications for alert-type messages
+     *
+     * @param {NotificationDurationUnitEnum} unit - Time unit for the duration
+     * @param {number} value - Number of time units to look back
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    sendNotificationOfAlertMessages(unit: NotificationDurationUnitEnum, value: number): Promise<boolean | Error>;
+    /**
+     * Sends notifications for unread service messages
+     *
+     * @description Handles notifications for support service channels
+     *
+     * @param {NotificationDurationUnitEnum} unit - Time unit for the duration
+     * @param {number} value - Number of time units to look back
+     * @returns {Promise<boolean | Error>} - Success status or error
+     */
+    sendNotificationOfUnreadServiceMessages(unit: NotificationDurationUnitEnum, value: number): Promise<boolean | Error>;
     private getLatestMessageInAllChannels;
     private groupByMember;
     private findMembersWithUnreadMessage;
@@ -29,18 +124,16 @@ export declare class MessengerNotificationService implements IMessengerNotificat
     private getUser;
     private fetchUsersForMembers;
     private sendNotificationToUser;
-    sendNotificationOfUnreadMessages(unit: NotificationDurationUnitEnum, value: number): Promise<void>;
-    sendPushNotificationsExpo(data: IExpoNotificationData): Promise<IExpoNotification>;
     private getThreadWithParticipants;
     private getChannelWithMembers;
-    sendExpoNotificationOnPost(post: IPost, notificationData: IExpoNotificationBodyData): Promise<Boolean>;
+    private extractNotificationTokens;
+    private extractTemplateVariables;
+    private findChannelOwner;
+    private prepareNotificationContent;
     private sendMailOnPost;
     private sendSmsOnPost;
-    sendNotificationOnPost(post: IPost): Promise<Boolean>;
     private getLatestAlertMessage;
-    sendNotificationOfAlertMessages(unit: NotificationDurationUnitEnum, value: number): Promise<void>;
     private sendServiceNotificationOnPost;
     private getServiceThreads;
     private getServicePosts;
-    sendNotificationOfUnreadServiceMessages(unit: NotificationDurationUnitEnum, value: number): Promise<void>;
 }