@flusys/nestjs-notification 7.1.0 → 8.0.0

package/cjs/adapters/index.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./notification.adapter"), 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/adapters/notification.adapter.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "NotificationAdapter", {
-    enumerable: true,
-    get: function() {
-        return NotificationAdapter;
-    }
-});
-const _common = require("@nestjs/common");
-const _notificationhelperservice = require("../services/notification-helper.service");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-function _ts_decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.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;
-}
-function _ts_metadata(k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-function _ts_param(paramIndex, decorator) {
-    return function(target, key) {
-        decorator(target, key, paramIndex);
-    };
-}
-let NotificationAdapter = class NotificationAdapter {
-    async send(options) {
-        await this.notificationHelper.send(options);
-    }
-    async sendToMany(options) {
-        await this.notificationHelper.sendToMany(options);
-    }
-    isUserOnline(userId) {
-        return this.notificationHelper.isUserOnline(userId);
-    }
-    constructor(notificationHelper){
-        _define_property(this, "notificationHelper", void 0);
-        this.notificationHelper = notificationHelper;
-    }
-};
-NotificationAdapter = _ts_decorate([
-    (0, _common.Injectable)(),
-    _ts_param(0, (0, _common.Inject)(_notificationhelperservice.NotificationHelperService)),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _notificationhelperservice.NotificationHelperService === "undefined" ? Object : _notificationhelperservice.NotificationHelperService
-    ])
-], NotificationAdapter);

package/cjs/adapters/notification.adapter.spec.js

@@ -1,73 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-const _notificationadapter = require("./notification.adapter");
-describe('NotificationAdapter', ()=>{
-    let adapter;
-    let mockHelper;
-    beforeEach(()=>{
-        mockHelper = {
-            send: jest.fn(),
-            sendToMany: jest.fn(),
-            isUserOnline: jest.fn()
-        };
-        adapter = new _notificationadapter.NotificationAdapter(mockHelper);
-    });
-    describe('send', ()=>{
-        it('delegates to NotificationHelperService.send with the same options', async ()=>{
-            const options = {
-                userId: 'user-uuid-1',
-                title: 'Hello',
-                message: 'World'
-            };
-            mockHelper.send.mockResolvedValue(undefined);
-            await adapter.send(options);
-            expect(mockHelper.send).toHaveBeenCalledWith(options);
-            expect(mockHelper.send).toHaveBeenCalledTimes(1);
-        });
-        it('propagates errors thrown by the helper service', async ()=>{
-            const options = {
-                userId: 'user-uuid-1',
-                title: 'Hello'
-            };
-            mockHelper.send.mockRejectedValue(new Error('boom'));
-            await expect(adapter.send(options)).rejects.toThrow('boom');
-        });
-    });
-    describe('sendToMany', ()=>{
-        it('delegates to NotificationHelperService.sendToMany with the same options', async ()=>{
-            const options = {
-                userIds: [
-                    'user-uuid-1',
-                    'user-uuid-2'
-                ],
-                title: 'Broadcast'
-            };
-            mockHelper.sendToMany.mockResolvedValue(undefined);
-            await adapter.sendToMany(options);
-            expect(mockHelper.sendToMany).toHaveBeenCalledWith(options);
-            expect(mockHelper.sendToMany).toHaveBeenCalledTimes(1);
-        });
-        it('handles an empty userIds array without throwing', async ()=>{
-            const options = {
-                userIds: [],
-                title: 'Nobody'
-            };
-            mockHelper.sendToMany.mockResolvedValue(undefined);
-            await expect(adapter.sendToMany(options)).resolves.toBeUndefined();
-            expect(mockHelper.sendToMany).toHaveBeenCalledWith(options);
-        });
-    });
-    describe('isUserOnline', ()=>{
-        it('returns true when the helper reports the user online', ()=>{
-            mockHelper.isUserOnline.mockReturnValue(true);
-            expect(adapter.isUserOnline('user-uuid-1')).toBe(true);
-            expect(mockHelper.isUserOnline).toHaveBeenCalledWith('user-uuid-1');
-        });
-        it('returns false when the helper reports the user offline', ()=>{
-            mockHelper.isUserOnline.mockReturnValue(false);
-            expect(adapter.isUserOnline('user-uuid-2')).toBe(false);
-        });
-    });
-});

package/cjs/config/event-actions.js

@@ -1,33 +0,0 @@
-/**
- * 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

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_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)) {
-            Object.defineProperty(to, k, {
-                enumerable: true,
-                get: function() {
-                    return from[k];
-                }
-            });
-        }
-    });
-    return from;
-}

package/cjs/config/message-keys.js

@@ -1,19 +0,0 @@
-// ==================== NOTIFICATION MODULE MESSAGE KEYS ====================
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "NOTIFICATION_MESSAGES", {
-    enumerable: true,
-    get: function() {
-        return NOTIFICATION_MESSAGES;
-    }
-});
-const NOTIFICATION_MESSAGES = {
-    NOT_FOUND: 'notification.not.found',
-    MARK_READ_SUCCESS: 'notification.mark.read.success',
-    MARK_ALL_READ_SUCCESS: 'notification.mark.all.read.success',
-    UNREAD_COUNT_SUCCESS: 'notification.unread.count.success',
-    SEND_SUCCESS: 'notification.send.success',
-    BROADCAST_SUCCESS: 'notification.broadcast.success'
-};

package/cjs/config/notification.constants.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "NOTIFICATION_MODULE_OPTIONS", {
-    enumerable: true,
-    get: function() {
-        return NOTIFICATION_MODULE_OPTIONS;
-    }
-});
-const NOTIFICATION_MODULE_OPTIONS = 'NOTIFICATION_MODULE_OPTIONS';

package/cjs/controllers/index.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-_export_star(require("./notification.controller"), 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/controllers/notification.controller.js

@@ -1,299 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-Object.defineProperty(exports, "NotificationController", {
-    enumerable: true,
-    get: function() {
-        return NotificationController;
-    }
-});
-const _classes = require("@flusys/nestjs-shared/classes");
-const _decorators = require("@flusys/nestjs-shared/decorators");
-const _dtos = require("@flusys/nestjs-shared/dtos");
-const _guards = require("@flusys/nestjs-shared/guards");
-const _interfaces = require("@flusys/nestjs-shared/interfaces");
-const _common = require("@nestjs/common");
-const _swagger = require("@nestjs/swagger");
-const _classtransformer = require("class-transformer");
-const _config = require("../config");
-const _dtos1 = require("../dtos");
-const _notificationhelperservice = require("../services/notification-helper.service");
-const _notificationservice = require("../services/notification.service");
-function _define_property(obj, key, value) {
-    if (key in obj) {
-        Object.defineProperty(obj, key, {
-            value: value,
-            enumerable: true,
-            configurable: true,
-            writable: true
-        });
-    } else {
-        obj[key] = value;
-    }
-    return obj;
-}
-function _ts_decorate(decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.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;
-}
-function _ts_metadata(k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-}
-function _ts_param(paramIndex, decorator) {
-    return function(target, key) {
-        decorator(target, key, paramIndex);
-    };
-}
-let NotificationController = class NotificationController extends (0, _classes.createApiController)(_dtos1.CreateNotificationDto, _dtos1.UpdateNotificationDto, _dtos1.NotificationResponseDto, {
-    entityName: 'notification',
-    security: {
-        insert: {
-            level: 'permission',
-            permissions: [
-                _classes.NOTIFICATION_PERMISSIONS.CREATE
-            ]
-        },
-        insertMany: {
-            level: 'permission',
-            permissions: [
-                _classes.NOTIFICATION_PERMISSIONS.CREATE
-            ]
-        },
-        getById: {
-            level: 'permission',
-            permissions: [
-                _classes.NOTIFICATION_PERMISSIONS.READ
-            ]
-        },
-        getAll: {
-            level: 'jwt'
-        },
-        update: {
-            level: 'permission',
-            permissions: [
-                _classes.NOTIFICATION_PERMISSIONS.UPDATE
-            ]
-        },
-        updateMany: {
-            level: 'permission',
-            permissions: [
-                _classes.NOTIFICATION_PERMISSIONS.UPDATE
-            ]
-        },
-        delete: {
-            level: 'permission',
-            permissions: [
-                _classes.NOTIFICATION_PERMISSIONS.DELETE
-            ]
-        }
-    }
-}) {
-    async markAsRead(dto, user) {
-        const notification = await this.service.markAsRead(dto.id, user);
-        const plainOptions = {
-            excludeExtraneousValues: true
-        };
-        return {
-            success: true,
-            message: 'Notification marked as read',
-            messageKey: _config.NOTIFICATION_MESSAGES.MARK_READ_SUCCESS,
-            data: (0, _classtransformer.plainToInstance)(_dtos1.NotificationResponseDto, notification, plainOptions)
-        };
-    }
-    async markAllAsRead(user) {
-        const count = await this.service.markAllAsRead(user);
-        return {
-            success: true,
-            message: `${count} notifications marked as read`,
-            messageKey: _config.NOTIFICATION_MESSAGES.MARK_ALL_READ_SUCCESS,
-            messageVariables: {
-                count
-            }
-        };
-    }
-    async getUnreadCount(user) {
-        const count = await this.service.getUnreadCount(user);
-        return {
-            success: true,
-            message: 'Unread count retrieved',
-            messageKey: _config.NOTIFICATION_MESSAGES.UNREAD_COUNT_SUCCESS,
-            data: {
-                count
-            }
-        };
-    }
-    async sendNotification(dto) {
-        const notification = await this.notificationHelper.send({
-            userId: dto.userId,
-            title: dto.title,
-            message: dto.message,
-            type: dto.type,
-            data: dto.data,
-            companyId: dto.companyId
-        });
-        const plainOptions = {
-            excludeExtraneousValues: true
-        };
-        return {
-            success: true,
-            message: 'Notification sent successfully',
-            messageKey: _config.NOTIFICATION_MESSAGES.SEND_SUCCESS,
-            data: (0, _classtransformer.plainToInstance)(_dtos1.NotificationResponseDto, notification, plainOptions)
-        };
-    }
-    async sendBulkNotification(dto) {
-        const notifications = await this.notificationHelper.sendToMany({
-            userIds: dto.userIds,
-            title: dto.title,
-            message: dto.message,
-            type: dto.type,
-            data: dto.data,
-            companyId: dto.companyId
-        });
-        const plainOptions = {
-            excludeExtraneousValues: true
-        };
-        return {
-            success: true,
-            message: `${notifications.length} notifications sent successfully`,
-            messageKey: _config.NOTIFICATION_MESSAGES.BROADCAST_SUCCESS,
-            messageVariables: {
-                count: notifications.length
-            },
-            data: notifications.map((n)=>(0, _classtransformer.plainToInstance)(_dtos1.NotificationResponseDto, n, plainOptions)),
-            meta: {
-                count: notifications.length,
-                total: dto.userIds.length
-            }
-        };
-    }
-    constructor(service, notificationHelper){
-        super(service), _define_property(this, "service", void 0), _define_property(this, "notificationHelper", void 0), this.service = service, this.notificationHelper = notificationHelper;
-    }
-};
-_ts_decorate([
-    (0, _common.Post)('mark-read'),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _common.UseGuards)(_guards.JwtAuthGuard),
-    (0, _swagger.ApiBearerAuth)(),
-    (0, _swagger.ApiOperation)({
-        summary: 'Mark a notification as read'
-    }),
-    (0, _swagger.ApiBody)({
-        type: _dtos1.MarkReadDto
-    }),
-    (0, _swagger.ApiResponse)({
-        status: 200,
-        description: 'Notification marked as read',
-        type: _dtos.SingleResponseDto
-    }),
-    _ts_param(0, (0, _common.Body)()),
-    _ts_param(1, (0, _decorators.CurrentUser)()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _dtos1.MarkReadDto === "undefined" ? Object : _dtos1.MarkReadDto,
-        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], NotificationController.prototype, "markAsRead", null);
-_ts_decorate([
-    (0, _common.Post)('mark-all-read'),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _common.UseGuards)(_guards.JwtAuthGuard),
-    (0, _swagger.ApiBearerAuth)(),
-    (0, _swagger.ApiOperation)({
-        summary: 'Mark all notifications as read'
-    }),
-    (0, _swagger.ApiResponse)({
-        status: 200,
-        description: 'All notifications marked as read',
-        type: _dtos.MessageResponseDto
-    }),
-    _ts_param(0, (0, _decorators.CurrentUser)()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], NotificationController.prototype, "markAllAsRead", null);
-_ts_decorate([
-    (0, _common.Post)('unread-count'),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _common.UseGuards)(_guards.JwtAuthGuard),
-    (0, _swagger.ApiBearerAuth)(),
-    (0, _swagger.ApiOperation)({
-        summary: 'Get unread notification count'
-    }),
-    (0, _swagger.ApiResponse)({
-        status: 200,
-        description: 'Unread count retrieved',
-        type: _dtos.SingleResponseDto
-    }),
-    _ts_param(0, (0, _decorators.CurrentUser)()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _interfaces.ILoggedUserInfo === "undefined" ? Object : _interfaces.ILoggedUserInfo
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], NotificationController.prototype, "getUnreadCount", null);
-_ts_decorate([
-    (0, _common.Post)('send'),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _common.UseGuards)(_guards.JwtAuthGuard, _guards.PermissionGuard),
-    (0, _decorators.RequirePermission)(_classes.NOTIFICATION_PERMISSIONS.CREATE),
-    (0, _swagger.ApiOperation)({
-        summary: 'Send a notification to a user'
-    }),
-    (0, _swagger.ApiBody)({
-        type: _dtos1.SendNotificationDto
-    }),
-    (0, _swagger.ApiResponse)({
-        status: 200,
-        description: 'Notification sent successfully',
-        type: _dtos.SingleResponseDto
-    }),
-    _ts_param(0, (0, _common.Body)()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _dtos1.SendNotificationDto === "undefined" ? Object : _dtos1.SendNotificationDto
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], NotificationController.prototype, "sendNotification", null);
-_ts_decorate([
-    (0, _common.Post)('send-bulk'),
-    (0, _common.HttpCode)(_common.HttpStatus.OK),
-    (0, _common.UseGuards)(_guards.JwtAuthGuard, _guards.PermissionGuard),
-    (0, _decorators.RequirePermission)(_classes.NOTIFICATION_PERMISSIONS.CREATE),
-    (0, _swagger.ApiOperation)({
-        summary: 'Send a notification to multiple users'
-    }),
-    (0, _swagger.ApiBody)({
-        type: _dtos1.SendBulkNotificationDto
-    }),
-    (0, _swagger.ApiResponse)({
-        status: 200,
-        description: 'Notifications sent successfully',
-        type: _dtos.BulkResponseDto
-    }),
-    _ts_param(0, (0, _common.Body)()),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _dtos1.SendBulkNotificationDto === "undefined" ? Object : _dtos1.SendBulkNotificationDto
-    ]),
-    _ts_metadata("design:returntype", Promise)
-], NotificationController.prototype, "sendBulkNotification", null);
-NotificationController = _ts_decorate([
-    (0, _swagger.ApiTags)('Notifications'),
-    (0, _swagger.ApiBearerAuth)(),
-    (0, _common.Controller)('notification'),
-    _ts_param(0, (0, _common.Inject)(_notificationservice.NotificationService)),
-    _ts_param(1, (0, _common.Inject)(_notificationhelperservice.NotificationHelperService)),
-    _ts_metadata("design:type", Function),
-    _ts_metadata("design:paramtypes", [
-        typeof _notificationservice.NotificationService === "undefined" ? Object : _notificationservice.NotificationService,
-        typeof _notificationhelperservice.NotificationHelperService === "undefined" ? Object : _notificationhelperservice.NotificationHelperService
-    ])
-], NotificationController);