@flusys/nestjs-notification 6.4.0 → 7.0.0-beta.1

package/cjs/config/event-actions.js

@@ -0,0 +1,33 @@
+/**
+ * Domain event actions published by the notification module, alongside the CRUD
+ * lifecycle actions every ApiService emits.
+ */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: Object.getOwnPropertyDescriptor(all, name).get
+    });
+}
+_export(exports, {
+    get NOTIFICATION_EVENT_ACTIONS () {
+        return NOTIFICATION_EVENT_ACTIONS;
+    },
+    get NOTIFICATION_EVENT_ENTITIES () {
+        return NOTIFICATION_EVENT_ENTITIES;
+    },
+    get NOTIFICATION_EVENT_MODULE () {
+        return NOTIFICATION_EVENT_MODULE;
+    }
+});
+const NOTIFICATION_EVENT_ACTIONS = {
+    SENT: 'sent',
+    READ: 'read',
+    ALL_READ: 'all-read'
+};
+const NOTIFICATION_EVENT_ENTITIES = {
+    NOTIFICATION: 'notification'
+};
+const NOTIFICATION_EVENT_MODULE = 'notification';

package/cjs/config/index.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_export_star(require("./notification.constants"), exports);
+_export_star(require("./event-actions"), exports);
 _export_star(require("./message-keys"), exports);
+_export_star(require("./notification.constants"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {
         if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {

package/cjs/modules/notification.module.js

@@ -95,6 +95,7 @@ let NotificationModule = class NotificationModule {
                 useValue: options
             });
         }
+        providers.push((0, _modules.createModuleEventsProvider)('notification', _notificationconstants.NOTIFICATION_MODULE_OPTIONS));
         return providers;
     }
     static createAsyncProviders(options) {

package/cjs/services/notification-helper.service.js

@@ -13,6 +13,7 @@ const _classes = require("@flusys/nestjs-shared/classes");
 const _enums = require("@flusys/nestjs-shared/enums");
 const _modules = require("@flusys/nestjs-shared/modules");
 const _common = require("@nestjs/common");
+const _config = require("../config");
 const _entities = require("../entities");
 const _gateways = require("../gateways");
 const _notificationconfigservice = require("./notification-config.service");
@@ -51,6 +52,11 @@ let NotificationHelperService = class NotificationHelperService {
         const saved = await repo.save(entity);
         await this.clearCache();
         this.emitToUser(saved, options.realtime !== false);
+        await this.publishSentEvent([
+            saved
+        ], [
+            options.userId
+        ]);
         return saved;
     }
     async sendToMany(options) {
@@ -65,6 +71,7 @@ let NotificationHelperService = class NotificationHelperService {
                 }
             });
         }
+        await this.publishSentEvent(saved, options.userIds);
         return saved;
     }
     isUserOnline(userId) {
@@ -73,6 +80,17 @@ let NotificationHelperService = class NotificationHelperService {
     getOnlineUserCount() {
         return this.gateway?.getOnlineUserCount() ?? 0;
     }
+    async publishSentEvent(notifications, userIds) {
+        await (0, _classes.publishDomainEvent)({
+            module: _config.NOTIFICATION_EVENT_MODULE,
+            entity: _config.NOTIFICATION_EVENT_ENTITIES.NOTIFICATION,
+            action: _config.NOTIFICATION_EVENT_ACTIONS.SENT,
+            ids: notifications.map((notification)=>notification.id),
+            metadata: {
+                recipientCount: userIds.length
+            }
+        });
+    }
     async getDataSource() {
         if (!this.dataSource) {
             this.dataSource = await this.dataSourceProvider.getDataSource();

package/cjs/services/notification-helper.service.spec.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 const _testing = require("@nestjs/testing");
+const _classes = require("@flusys/nestjs-shared/classes");
 const _modules = require("@flusys/nestjs-shared/modules");
 const _enums = require("@flusys/nestjs-shared/enums");
 const _notificationhelperservice = require("./notification-helper.service");
@@ -303,4 +304,89 @@ describe('NotificationHelperService', ()=>{
             expect(service.getOnlineUserCount()).toBe(0);
         });
     });
+    describe('domain events', ()=>{
+        let publish;
+        beforeEach(()=>{
+            publish = jest.fn().mockResolvedValue(undefined);
+            _classes.EventBusRegistry.reset();
+            _classes.EventBusRegistry.setBus({
+                publish,
+                subscribe: jest.fn(),
+                close: jest.fn()
+            });
+            _classes.EventBusRegistry.configureModule('notification', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            _classes.EventBusRegistry.reset();
+        });
+        it('publishes notification.notification.sent for a single send', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue({
+                id: 'notif-1',
+                userId: 'user-1'
+            });
+            await service.send({
+                userId: 'user-1',
+                title: 'Hi'
+            });
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'notification.notification.sent',
+                payload: expect.objectContaining({
+                    ids: [
+                        'notif-1'
+                    ],
+                    metadata: expect.objectContaining({
+                        recipientCount: 1
+                    })
+                })
+            }));
+        });
+        it('reports the recipient count for a bulk send', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue([
+                {
+                    id: 'notif-1',
+                    userId: 'user-1'
+                },
+                {
+                    id: 'notif-2',
+                    userId: 'user-2'
+                }
+            ]);
+            await service.sendToMany({
+                userIds: [
+                    'user-1',
+                    'user-2'
+                ],
+                title: 'Hi',
+                realtime: false
+            });
+            expect(publish.mock.calls[0][0].payload).toEqual(expect.objectContaining({
+                ids: [
+                    'notif-1',
+                    'notif-2'
+                ],
+                metadata: expect.objectContaining({
+                    recipientCount: 2
+                })
+            }));
+        });
+        it('does not publish when the notification module has events disabled', async ()=>{
+            _classes.EventBusRegistry.configureModule('notification', {
+                enabled: false
+            });
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue({
+                id: 'notif-1',
+                userId: 'user-1'
+            });
+            await service.send({
+                userId: 'user-1',
+                title: 'Hi'
+            });
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/cjs/services/notification.service.js

@@ -171,6 +171,12 @@ let NotificationService = class NotificationService extends _classes.ApiService
         this.emitToUser(user.id, ext.companyId ?? user.companyId, 'notification:read', {
             id
         });
+        await this.publishDomainAction(_config.NOTIFICATION_EVENT_ACTIONS.READ, {
+            ids: [
+                notification.id
+            ],
+            user
+        });
         return notification;
     }
     async markAllAsRead(user) {
@@ -189,6 +195,12 @@ let NotificationService = class NotificationService extends _classes.ApiService
         await this.clearCacheForAll();
         // Emit to user's sockets in the current company context
         this.emitToUser(user.id, user.companyId, 'notification:read-all', {});
+        await this.publishDomainAction(_config.NOTIFICATION_EVENT_ACTIONS.ALL_READ, {
+            metadata: {
+                count: result.affected ?? 0
+            },
+            user
+        });
         return result.affected ?? 0;
     }
     async getUnreadCount(user) {

package/cjs/services/notification.service.spec.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", {
     value: true
 });
 const _testing = require("@nestjs/testing");
+const _classes = require("@flusys/nestjs-shared/classes");
 const _modules = require("@flusys/nestjs-shared/modules");
 const _repositorymock = require("@test-utils/mocks/repository.mock");
 const _loggedusermock = require("@test-utils/mocks/logged-user.mock");
@@ -487,4 +488,72 @@ describe('NotificationService', ()=>{
             await expect(noGatewayService.markAsRead('notif-1', user)).resolves.toBeDefined();
         });
     });
+    describe('domain events', ()=>{
+        let publish;
+        beforeEach(()=>{
+            publish = jest.fn().mockResolvedValue(undefined);
+            _classes.EventBusRegistry.reset();
+            _classes.EventBusRegistry.setBus({
+                publish,
+                subscribe: jest.fn(),
+                close: jest.fn()
+            });
+            _classes.EventBusRegistry.configureModule('notification', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            _classes.EventBusRegistry.reset();
+        });
+        it('publishes notification.notification.read when one is marked read', async ()=>{
+            const user = (0, _loggedusermock.buildMockUser)();
+            const notification = buildNotification({
+                id: 'notif-1',
+                userId: user.id,
+                isRead: false
+            });
+            mockRepo.findOne.mockResolvedValue(notification);
+            mockRepo.save.mockResolvedValue({
+                ...notification,
+                isRead: true
+            });
+            await service.markAsRead('notif-1', user);
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'notification.notification.read',
+                payload: expect.objectContaining({
+                    ids: [
+                        'notif-1'
+                    ]
+                })
+            }));
+        });
+        it('publishes notification.notification.all-read with the affected count', async ()=>{
+            mockRepo.update.mockResolvedValue({
+                affected: 4,
+                raw: {},
+                generatedMaps: []
+            });
+            await service.markAllAsRead((0, _loggedusermock.buildMockUser)());
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'notification.notification.all-read',
+                payload: expect.objectContaining({
+                    metadata: {
+                        count: 4
+                    }
+                })
+            }));
+        });
+        it('does not publish when the notification module has events disabled', async ()=>{
+            _classes.EventBusRegistry.configureModule('notification', {
+                enabled: false
+            });
+            mockRepo.update.mockResolvedValue({
+                affected: 1,
+                raw: {},
+                generatedMaps: []
+            });
+            await service.markAllAsRead((0, _loggedusermock.buildMockUser)());
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/config/event-actions.d.ts

@@ -0,0 +1,9 @@
+export declare const NOTIFICATION_EVENT_ACTIONS: {
+    readonly SENT: "sent";
+    readonly READ: "read";
+    readonly ALL_READ: "all-read";
+};
+export declare const NOTIFICATION_EVENT_ENTITIES: {
+    readonly NOTIFICATION: "notification";
+};
+export declare const NOTIFICATION_EVENT_MODULE = "notification";

package/config/index.d.ts

@@ -1,2 +1,3 @@
-export * from './notification.constants';
+export * from './event-actions';
 export * from './message-keys';
+export * from './notification.constants';

package/fesm/config/event-actions.js

@@ -0,0 +1,12 @@
+/**
+ * Domain event actions published by the notification module, alongside the CRUD
+ * lifecycle actions every ApiService emits.
+ */ export const NOTIFICATION_EVENT_ACTIONS = {
+    SENT: 'sent',
+    READ: 'read',
+    ALL_READ: 'all-read'
+};
+export const NOTIFICATION_EVENT_ENTITIES = {
+    NOTIFICATION: 'notification'
+};
+export const NOTIFICATION_EVENT_MODULE = 'notification';

package/fesm/config/index.js

@@ -1,2 +1,3 @@
-export * from './notification.constants';
+export * from './event-actions';
 export * from './message-keys';
+export * from './notification.constants';

package/fesm/modules/notification.module.js

@@ -4,7 +4,7 @@ function _ts_decorate(decorators, target, key, desc) {
     else for(var i = decorators.length - 1; i >= 0; i--)if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 }
-import { CacheModule, UtilsModule } from '@flusys/nestjs-shared/modules';
+import { CacheModule, UtilsModule, createModuleEventsProvider } from '@flusys/nestjs-shared/modules';
 import { NOTIFICATION_ADAPTER } from '@flusys/nestjs-shared/interfaces';
 import { Module } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
@@ -85,6 +85,7 @@ export class NotificationModule {
                 useValue: options
             });
         }
+        providers.push(createModuleEventsProvider('notification', NOTIFICATION_MODULE_OPTIONS));
         return providers;
     }
     static createAsyncProviders(options) {

package/fesm/services/notification-helper.service.js

@@ -26,10 +26,11 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 import { INotificationBulkSendOptions, INotificationSendOptions, LogAction } from '@flusys/nestjs-shared';
-import { HybridCache } from '@flusys/nestjs-shared/classes';
+import { HybridCache, publishDomainEvent } from '@flusys/nestjs-shared/classes';
 import { NotificationType } from '@flusys/nestjs-shared/enums';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { Inject, Injectable, Optional } from '@nestjs/common';
+import { NOTIFICATION_EVENT_ACTIONS, NOTIFICATION_EVENT_ENTITIES, NOTIFICATION_EVENT_MODULE } from '../config';
 import { Notification, NotificationWithCompany } from '../entities';
 import { NotificationGateway } from '../gateways';
 import { NotificationConfigService } from './notification-config.service';
@@ -41,6 +42,11 @@ export class NotificationHelperService {
         const saved = await repo.save(entity);
         await this.clearCache();
         this.emitToUser(saved, options.realtime !== false);
+        await this.publishSentEvent([
+            saved
+        ], [
+            options.userId
+        ]);
         return saved;
     }
     async sendToMany(options) {
@@ -55,6 +61,7 @@ export class NotificationHelperService {
                 }
             });
         }
+        await this.publishSentEvent(saved, options.userIds);
         return saved;
     }
     isUserOnline(userId) {
@@ -63,6 +70,17 @@ export class NotificationHelperService {
     getOnlineUserCount() {
         return this.gateway?.getOnlineUserCount() ?? 0;
     }
+    async publishSentEvent(notifications, userIds) {
+        await publishDomainEvent({
+            module: NOTIFICATION_EVENT_MODULE,
+            entity: NOTIFICATION_EVENT_ENTITIES.NOTIFICATION,
+            action: NOTIFICATION_EVENT_ACTIONS.SENT,
+            ids: notifications.map((notification)=>notification.id),
+            metadata: {
+                recipientCount: userIds.length
+            }
+        });
+    }
     async getDataSource() {
         if (!this.dataSource) {
             this.dataSource = await this.dataSourceProvider.getDataSource();

package/fesm/services/notification-helper.service.spec.js

@@ -1,4 +1,5 @@
 import { Test } from '@nestjs/testing';
+import { EventBusRegistry } from '@flusys/nestjs-shared/classes';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { NotificationType } from '@flusys/nestjs-shared/enums';
 import { NotificationHelperService } from './notification-helper.service';
@@ -299,4 +300,89 @@ describe('NotificationHelperService', ()=>{
             expect(service.getOnlineUserCount()).toBe(0);
         });
     });
+    describe('domain events', ()=>{
+        let publish;
+        beforeEach(()=>{
+            publish = jest.fn().mockResolvedValue(undefined);
+            EventBusRegistry.reset();
+            EventBusRegistry.setBus({
+                publish,
+                subscribe: jest.fn(),
+                close: jest.fn()
+            });
+            EventBusRegistry.configureModule('notification', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            EventBusRegistry.reset();
+        });
+        it('publishes notification.notification.sent for a single send', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue({
+                id: 'notif-1',
+                userId: 'user-1'
+            });
+            await service.send({
+                userId: 'user-1',
+                title: 'Hi'
+            });
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'notification.notification.sent',
+                payload: expect.objectContaining({
+                    ids: [
+                        'notif-1'
+                    ],
+                    metadata: expect.objectContaining({
+                        recipientCount: 1
+                    })
+                })
+            }));
+        });
+        it('reports the recipient count for a bulk send', async ()=>{
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue([
+                {
+                    id: 'notif-1',
+                    userId: 'user-1'
+                },
+                {
+                    id: 'notif-2',
+                    userId: 'user-2'
+                }
+            ]);
+            await service.sendToMany({
+                userIds: [
+                    'user-1',
+                    'user-2'
+                ],
+                title: 'Hi',
+                realtime: false
+            });
+            expect(publish.mock.calls[0][0].payload).toEqual(expect.objectContaining({
+                ids: [
+                    'notif-1',
+                    'notif-2'
+                ],
+                metadata: expect.objectContaining({
+                    recipientCount: 2
+                })
+            }));
+        });
+        it('does not publish when the notification module has events disabled', async ()=>{
+            EventBusRegistry.configureModule('notification', {
+                enabled: false
+            });
+            const service = await buildService();
+            mockRepo.save.mockResolvedValue({
+                id: 'notif-1',
+                userId: 'user-1'
+            });
+            await service.send({
+                userId: 'user-1',
+                title: 'Hi'
+            });
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/fesm/services/notification.service.js

@@ -31,7 +31,7 @@ import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { applyCompanyFilter } from '@flusys/nestjs-shared/utils';
 import { Inject, Injectable, NotFoundException, Optional, Scope } from '@nestjs/common';
-import { NOTIFICATION_MESSAGES } from '../config';
+import { NOTIFICATION_EVENT_ACTIONS, NOTIFICATION_MESSAGES } from '../config';
 import { Notification, NotificationWithCompany } from '../entities';
 import { NotificationGateway } from '../gateways';
 import { NotificationConfigService } from './notification-config.service';
@@ -161,6 +161,12 @@ export class NotificationService extends ApiService {
         this.emitToUser(user.id, ext.companyId ?? user.companyId, 'notification:read', {
             id
         });
+        await this.publishDomainAction(NOTIFICATION_EVENT_ACTIONS.READ, {
+            ids: [
+                notification.id
+            ],
+            user
+        });
         return notification;
     }
     async markAllAsRead(user) {
@@ -179,6 +185,12 @@ export class NotificationService extends ApiService {
         await this.clearCacheForAll();
         // Emit to user's sockets in the current company context
         this.emitToUser(user.id, user.companyId, 'notification:read-all', {});
+        await this.publishDomainAction(NOTIFICATION_EVENT_ACTIONS.ALL_READ, {
+            metadata: {
+                count: result.affected ?? 0
+            },
+            user
+        });
         return result.affected ?? 0;
     }
     async getUnreadCount(user) {

package/fesm/services/notification.service.spec.js

@@ -1,4 +1,5 @@
 import { Test } from '@nestjs/testing';
+import { EventBusRegistry } from '@flusys/nestjs-shared/classes';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { createMockDataSourceProvider, createMockRepository } from '@test-utils/mocks/repository.mock';
 import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
@@ -483,4 +484,72 @@ describe('NotificationService', ()=>{
             await expect(noGatewayService.markAsRead('notif-1', user)).resolves.toBeDefined();
         });
     });
+    describe('domain events', ()=>{
+        let publish;
+        beforeEach(()=>{
+            publish = jest.fn().mockResolvedValue(undefined);
+            EventBusRegistry.reset();
+            EventBusRegistry.setBus({
+                publish,
+                subscribe: jest.fn(),
+                close: jest.fn()
+            });
+            EventBusRegistry.configureModule('notification', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            EventBusRegistry.reset();
+        });
+        it('publishes notification.notification.read when one is marked read', async ()=>{
+            const user = buildMockUser();
+            const notification = buildNotification({
+                id: 'notif-1',
+                userId: user.id,
+                isRead: false
+            });
+            mockRepo.findOne.mockResolvedValue(notification);
+            mockRepo.save.mockResolvedValue({
+                ...notification,
+                isRead: true
+            });
+            await service.markAsRead('notif-1', user);
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'notification.notification.read',
+                payload: expect.objectContaining({
+                    ids: [
+                        'notif-1'
+                    ]
+                })
+            }));
+        });
+        it('publishes notification.notification.all-read with the affected count', async ()=>{
+            mockRepo.update.mockResolvedValue({
+                affected: 4,
+                raw: {},
+                generatedMaps: []
+            });
+            await service.markAllAsRead(buildMockUser());
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'notification.notification.all-read',
+                payload: expect.objectContaining({
+                    metadata: {
+                        count: 4
+                    }
+                })
+            }));
+        });
+        it('does not publish when the notification module has events disabled', async ()=>{
+            EventBusRegistry.configureModule('notification', {
+                enabled: false
+            });
+            mockRepo.update.mockResolvedValue({
+                affected: 1,
+                raw: {},
+                generatedMaps: []
+            });
+            await service.markAllAsRead(buildMockUser());
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/interfaces/notification-module.interface.d.ts

@@ -1,7 +1,9 @@
 import { IBootstrapAppConfig, IDataSourceServiceOptions, IDynamicModuleConfig, IModuleOptionsFactory } from '@flusys/nestjs-core';
+import { IModuleEventsConfig } from '@flusys/nestjs-shared/interfaces';
 import { ModuleMetadata, Type } from '@nestjs/common';
 export interface INotificationModuleConfig extends IDataSourceServiceOptions {
     jwtSecret?: string;
+    events?: IModuleEventsConfig;
 }
 export interface NotificationModuleOptions extends IDynamicModuleConfig {
     bootstrapAppConfig?: IBootstrapAppConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-notification",
-  "version": "6.4.0",
+  "version": "7.0.0-beta.1",
   "description": "Notification module with real-time Socket.IO support",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -93,7 +93,7 @@
     "express": "^5.0.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "6.4.0",
-    "@flusys/nestjs-shared": "6.4.0"
+    "@flusys/nestjs-core": "7.0.0-beta.1",
+    "@flusys/nestjs-shared": "7.0.0-beta.1"
   }
 }

package/services/notification-helper.service.d.ts

@@ -17,6 +17,7 @@ export declare class NotificationHelperService {
     sendToMany(options: INotificationBulkSendOptions): Promise<NotificationBase[]>;
     isUserOnline(userId: string): boolean;
     getOnlineUserCount(): number;
+    private publishSentEvent;
     private getDataSource;
     private getRepository;
     private buildEntity;