@flusys/nestjs-notification 7.1.0 → 8.0.0

package/cjs/controllers/notification.controller.spec.js

@@ -1,214 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _enums = require("@flusys/nestjs-shared/enums");
-const _loggedusermock = require("@test-utils/mocks/logged-user.mock");
-const _notificationcontroller = require("./notification.controller");
-const _config = require("../config");
-function buildNotification(overrides = {}) {
-    return {
-        id: 'notif-1',
-        userId: 'user-uuid-1',
-        type: _enums.NotificationType.INFO,
-        title: 'Title',
-        message: 'Message',
-        data: null,
-        isRead: false,
-        readAt: null,
-        createdAt: new Date(),
-        updatedAt: new Date(),
-        ...overrides
-    };
-}
-describe('NotificationController', ()=>{
-    let controller;
-    let mockService;
-    let mockHelper;
-    beforeEach(()=>{
-        mockService = {
-            markAsRead: jest.fn(),
-            markAllAsRead: jest.fn(),
-            getUnreadCount: jest.fn(),
-            insert: jest.fn(),
-            insertMany: jest.fn(),
-            findById: jest.fn(),
-            findByIds: jest.fn(),
-            update: jest.fn(),
-            updateMany: jest.fn(),
-            bulkUpsert: jest.fn(),
-            getAll: jest.fn(),
-            delete: jest.fn()
-        };
-        mockHelper = {
-            send: jest.fn(),
-            sendToMany: jest.fn(),
-            isUserOnline: jest.fn(),
-            getOnlineUserCount: jest.fn()
-        };
-        controller = new _notificationcontroller.NotificationController(mockService, mockHelper);
-    });
-    describe('markAsRead', ()=>{
-        it('marks the notification as read and returns the mapped response', async ()=>{
-            const user = (0, _loggedusermock.buildMockUser)();
-            const notification = buildNotification({
-                isRead: true
-            });
-            mockService.markAsRead.mockResolvedValue(notification);
-            const result = await controller.markAsRead({
-                id: 'notif-1'
-            }, user);
-            expect(mockService.markAsRead).toHaveBeenCalledWith('notif-1', user);
-            expect(result.success).toBe(true);
-            expect(result.messageKey).toBe(_config.NOTIFICATION_MESSAGES.MARK_READ_SUCCESS);
-            expect(result.data?.id).toBe('notif-1');
-            expect(result.data?.isRead).toBe(true);
-        });
-        it('propagates a not-found error from the service', async ()=>{
-            mockService.markAsRead.mockRejectedValue(new Error(_config.NOTIFICATION_MESSAGES.NOT_FOUND));
-            await expect(controller.markAsRead({
-                id: 'missing'
-            }, (0, _loggedusermock.buildMockUser)())).rejects.toThrow();
-        });
-    });
-    describe('markAllAsRead', ()=>{
-        it('returns the count of notifications marked as read', async ()=>{
-            mockService.markAllAsRead.mockResolvedValue(3);
-            const result = await controller.markAllAsRead((0, _loggedusermock.buildMockUser)());
-            expect(result.success).toBe(true);
-            expect(result.messageKey).toBe(_config.NOTIFICATION_MESSAGES.MARK_ALL_READ_SUCCESS);
-            expect(result.messageVariables).toEqual({
-                count: 3
-            });
-            expect(result.message).toBe('3 notifications marked as read');
-        });
-        it('handles a user with zero unread notifications gracefully', async ()=>{
-            mockService.markAllAsRead.mockResolvedValue(0);
-            const result = await controller.markAllAsRead((0, _loggedusermock.buildMockUser)());
-            expect(result.messageVariables).toEqual({
-                count: 0
-            });
-            expect(result.message).toBe('0 notifications marked as read');
-        });
-    });
-    describe('getUnreadCount', ()=>{
-        it('returns the unread count wrapped in a single response', async ()=>{
-            mockService.getUnreadCount.mockResolvedValue(5);
-            const result = await controller.getUnreadCount((0, _loggedusermock.buildMockUser)());
-            expect(result.success).toBe(true);
-            expect(result.messageKey).toBe(_config.NOTIFICATION_MESSAGES.UNREAD_COUNT_SUCCESS);
-            expect(result.data).toEqual({
-                count: 5
-            });
-        });
-        it('returns zero for a user with no unread notifications', async ()=>{
-            mockService.getUnreadCount.mockResolvedValue(0);
-            const result = await controller.getUnreadCount((0, _loggedusermock.buildMockUser)());
-            expect(result.data).toEqual({
-                count: 0
-            });
-        });
-    });
-    describe('sendNotification', ()=>{
-        it('sends a notification via the helper service and returns the mapped response', async ()=>{
-            const notification = buildNotification({
-                id: 'notif-2'
-            });
-            mockHelper.send.mockResolvedValue(notification);
-            const result = await controller.sendNotification({
-                userId: 'user-uuid-1',
-                title: 'Hello',
-                message: 'World'
-            });
-            expect(mockHelper.send).toHaveBeenCalledWith({
-                userId: 'user-uuid-1',
-                title: 'Hello',
-                message: 'World',
-                type: undefined,
-                data: undefined,
-                companyId: undefined
-            });
-            expect(result.success).toBe(true);
-            expect(result.messageKey).toBe(_config.NOTIFICATION_MESSAGES.SEND_SUCCESS);
-            expect(result.data?.id).toBe('notif-2');
-        });
-        it('propagates errors from the helper service', async ()=>{
-            mockHelper.send.mockRejectedValue(new Error('db down'));
-            await expect(controller.sendNotification({
-                userId: 'user-1',
-                title: 'X'
-            })).rejects.toThrow('db down');
-        });
-    });
-    describe('sendBulkNotification', ()=>{
-        it('sends notifications to multiple users and returns bulk meta', async ()=>{
-            const notifications = [
-                buildNotification({
-                    id: 'n1',
-                    userId: 'user-1'
-                }),
-                buildNotification({
-                    id: 'n2',
-                    userId: 'user-2'
-                })
-            ];
-            mockHelper.sendToMany.mockResolvedValue(notifications);
-            const result = await controller.sendBulkNotification({
-                userIds: [
-                    'user-1',
-                    'user-2'
-                ],
-                title: 'Broadcast'
-            });
-            expect(mockHelper.sendToMany).toHaveBeenCalledWith({
-                userIds: [
-                    'user-1',
-                    'user-2'
-                ],
-                title: 'Broadcast',
-                message: undefined,
-                type: undefined,
-                data: undefined,
-                companyId: undefined
-            });
-            expect(result.success).toBe(true);
-            expect(result.messageKey).toBe(_config.NOTIFICATION_MESSAGES.BROADCAST_SUCCESS);
-            expect(result.data).toHaveLength(2);
-            expect(result.meta).toEqual({
-                count: 2,
-                total: 2
-            });
-        });
-        it('reports a mismatch between requested and sent counts in the meta', async ()=>{
-            mockHelper.sendToMany.mockResolvedValue([
-                buildNotification({
-                    id: 'n1'
-                })
-            ]);
-            const result = await controller.sendBulkNotification({
-                userIds: [
-                    'user-1',
-                    'user-2',
-                    'user-3'
-                ],
-                title: 'Partial broadcast'
-            });
-            expect(result.meta).toEqual({
-                count: 1,
-                total: 3
-            });
-        });
-        it('handles an empty userIds bulk send without throwing', async ()=>{
-            mockHelper.sendToMany.mockResolvedValue([]);
-            const result = await controller.sendBulkNotification({
-                userIds: [],
-                title: 'Nobody'
-            });
-            expect(result.data).toEqual([]);
-            expect(result.meta).toEqual({
-                count: 0,
-                total: 0
-            });
-        });
-    });
-});

package/cjs/docs/index.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./notification-swagger.config"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}

package/cjs/docs/notification-swagger.config.js

@@ -1,97 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "notificationSwaggerConfig", {
-    enumerable: true,
-    get: function() {
-        return notificationSwaggerConfig;
-    }
-});
-/** Schema properties to exclude when company feature is disabled */ const COMPANY_SCHEMA_EXCLUSIONS = [
-    {
-        schemaName: 'NotificationResponseDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'CreateNotificationDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'SendNotificationDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'SendBulkNotificationDto',
-        properties: [
-            'companyId'
-        ]
-    },
-    {
-        schemaName: 'UpdateNotificationDto',
-        properties: [
-            'companyId'
-        ]
-    }
-];
-function notificationSwaggerConfig(bootstrapConfig) {
-    const enableCompanyFeature = bootstrapConfig?.enableCompanyFeature ?? true;
-    const isMultiTenant = bootstrapConfig?.databaseMode === 'multi-tenant';
-    const multiTenantNote = isMultiTenant ? `\n> **Multi-Tenant Mode**: Include \`x-tenant-id\` header to target a specific tenant database.\n` : '';
-    return {
-        title: 'Notification API',
-        description: `
-## Notification API
-${multiTenantNote}
-Real-time notification system with WebSocket support.
-
-### Features
-- Push notifications to users
-- Mark notifications as read
-- Unread count tracking
-- Real-time delivery via WebSocket
-- Bulk notification sending
-
-### Endpoints
-
-#### User Notifications
-- \`POST /notification/get-all\` - Get user's notifications (paginated, sorted by newest)
-- \`POST /notification/get/:id\` - Get single notification
-- \`POST /notification/mark-read\` - Mark notification as read
-- \`POST /notification/mark-all-read\` - Mark all notifications as read
-- \`POST /notification/unread-count\` - Get unread notification count
-
-#### Admin/System
-- \`POST /notification/send\` - Send notification to a user
-- \`POST /notification/send-bulk\` - Send notification to multiple users
-
-### WebSocket Events
-
-Connect to WebSocket with JWT authentication:
-\`\`\`
-ws://localhost:2002/notification?token=<jwt>
-\`\`\`
-
-**Events:**
-- \`notification:new\` - New notification received
-- \`notification:read\` - Notification marked as read
-- \`notification:read-all\` - All notifications marked as read
-
-### Notification Types
-- \`info\` - General information
-- \`success\` - Success message
-- \`warning\` - Warning message
-- \`error\` - Error message
-    `,
-        version: '1.0',
-        path: 'api/docs/notification',
-        bearerAuth: true,
-        excludeSchemaProperties: enableCompanyFeature ? undefined : COMPANY_SCHEMA_EXCLUSIONS
-    };
-}

package/cjs/docs/notification-swagger.config.spec.js

@@ -1,68 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _notificationswaggerconfig = require("./notification-swagger.config");
-describe('notificationSwaggerConfig', ()=>{
-    it('should default to company feature enabled and single-database mode when no config is given', ()=>{
-        const config = (0, _notificationswaggerconfig.notificationSwaggerConfig)();
-        expect(config.title).toBe('Notification API');
-        expect(config.path).toBe('api/docs/notification');
-        expect(config.bearerAuth).toBe(true);
-        expect(config.excludeSchemaProperties).toBeUndefined();
-        expect(config.description).not.toContain('Multi-Tenant Mode');
-    });
-    it('should exclude companyId schema properties across all notification DTOs when the company feature is disabled', ()=>{
-        const config = (0, _notificationswaggerconfig.notificationSwaggerConfig)({
-            enableCompanyFeature: false
-        });
-        expect(config.excludeSchemaProperties).toEqual([
-            {
-                schemaName: 'NotificationResponseDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'CreateNotificationDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'SendNotificationDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'SendBulkNotificationDto',
-                properties: [
-                    'companyId'
-                ]
-            },
-            {
-                schemaName: 'UpdateNotificationDto',
-                properties: [
-                    'companyId'
-                ]
-            }
-        ]);
-    });
-    it('should not exclude any schema properties when the company feature is enabled', ()=>{
-        const config = (0, _notificationswaggerconfig.notificationSwaggerConfig)({
-            enableCompanyFeature: true
-        });
-        expect(config.excludeSchemaProperties).toBeUndefined();
-    });
-    it('should mention multi-tenant mode in the description only for multi-tenant database mode', ()=>{
-        const multiTenant = (0, _notificationswaggerconfig.notificationSwaggerConfig)({
-            databaseMode: 'multi-tenant'
-        });
-        const single = (0, _notificationswaggerconfig.notificationSwaggerConfig)({
-            databaseMode: 'single'
-        });
-        expect(multiTenant.description).toContain('Multi-Tenant Mode');
-        expect(single.description).not.toContain('Multi-Tenant Mode');
-    });
-});

package/cjs/dtos/index.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./notification.dto"), exports);
-function _export_star(from, to) {
-    Object.keys(from).forEach(function(k) {
-        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}