@flusys/nestjs-notification 5.1.1 → 5.1.2

package/cjs/controllers/notification.controller.js

@@ -9,7 +9,6 @@ Object.defineProperty(exports, "NotificationController", {
     }
 });
 const _classes = require("@flusys/nestjs-shared/classes");
-const _config = require("../config");
 const _decorators = require("@flusys/nestjs-shared/decorators");
 const _dtos = require("@flusys/nestjs-shared/dtos");
 const _guards = require("@flusys/nestjs-shared/guards");
@@ -17,6 +16,7 @@ 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");
@@ -93,11 +93,14 @@ let NotificationController = class NotificationController extends (0, _classes.c
 }) {
     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)
+            data: (0, _classtransformer.plainToInstance)(_dtos1.NotificationResponseDto, notification, plainOptions)
         };
     }
     async markAllAsRead(user) {
@@ -131,11 +134,14 @@ let NotificationController = class NotificationController extends (0, _classes.c
             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)
+            data: (0, _classtransformer.plainToInstance)(_dtos1.NotificationResponseDto, notification, plainOptions)
         };
     }
     async sendBulkNotification(dto) {
@@ -147,6 +153,9 @@ let NotificationController = class NotificationController extends (0, _classes.c
             data: dto.data,
             companyId: dto.companyId
         });
+        const plainOptions = {
+            excludeExtraneousValues: true
+        };
         return {
             success: true,
             message: `${notifications.length} notifications sent successfully`,
@@ -154,7 +163,7 @@ let NotificationController = class NotificationController extends (0, _classes.c
             messageVariables: {
                 count: notifications.length
             },
-            data: notifications.map((n)=>(0, _classtransformer.plainToInstance)(_dtos1.NotificationResponseDto, n)),
+            data: notifications.map((n)=>(0, _classtransformer.plainToInstance)(_dtos1.NotificationResponseDto, n, plainOptions)),
             meta: {
                 count: notifications.length,
                 total: dto.userIds.length

package/cjs/dtos/notification.dto.js

@@ -31,10 +31,10 @@ _export(exports, {
         return UpdateNotificationDto;
     }
 });
+const _enums = require("@flusys/nestjs-shared/enums");
 const _swagger = require("@nestjs/swagger");
 const _classtransformer = require("class-transformer");
 const _classvalidator = require("class-validator");
-const _enums = require("@flusys/nestjs-shared/enums");
 function _define_property(obj, key, value) {
     if (key in obj) {
         Object.defineProperty(obj, key, {
@@ -173,59 +173,106 @@ let NotificationResponseDto = class NotificationResponseDto {
 };
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Unique identifier of the notification',
+        example: '018e1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c'
+    }),
     _ts_metadata("design:type", String)
 ], NotificationResponseDto.prototype, "id", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'ID of the user this notification belongs to',
+        example: '018e1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c'
+    }),
     _ts_metadata("design:type", String)
 ], NotificationResponseDto.prototype, "userId", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
     (0, _swagger.ApiProperty)({
-        enum: _enums.NotificationType
+        description: 'Category of the notification',
+        enum: _enums.NotificationType,
+        example: _enums.NotificationType.SUCCESS
     }),
-    _ts_metadata("design:type", String)
+    _ts_metadata("design:type", typeof _enums.NotificationType === "undefined" ? Object : _enums.NotificationType)
 ], NotificationResponseDto.prototype, "type", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Short title of the notification',
+        example: 'Your export is ready'
+    }),
     _ts_metadata("design:type", String)
 ], NotificationResponseDto.prototype, "title", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiPropertyOptional)(),
+    (0, _swagger.ApiPropertyOptional)({
+        description: 'Optional longer body text for the notification',
+        example: 'Your CSV export has finished processing and is ready to download.',
+        nullable: true
+    }),
     _ts_metadata("design:type", Object)
 ], NotificationResponseDto.prototype, "message", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiPropertyOptional)(),
+    (0, _swagger.ApiPropertyOptional)({
+        description: 'Arbitrary JSON payload attached to the notification',
+        type: 'object',
+        additionalProperties: true,
+        nullable: true,
+        example: {
+            exportId: 'abc123',
+            fileUrl: 'https://cdn.example.com/export.csv'
+        }
+    }),
     _ts_metadata("design:type", Object)
 ], NotificationResponseDto.prototype, "data", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Whether the user has read this notification',
+        example: false
+    }),
     _ts_metadata("design:type", Boolean)
 ], NotificationResponseDto.prototype, "isRead", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiPropertyOptional)(),
+    (0, _swagger.ApiPropertyOptional)({
+        description: 'Timestamp when the notification was marked as read; null if unread',
+        type: 'string',
+        format: 'date-time',
+        nullable: true,
+        example: '2024-03-15T10:30:00.000Z'
+    }),
     _ts_metadata("design:type", Object)
 ], NotificationResponseDto.prototype, "readAt", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiPropertyOptional)(),
+    (0, _swagger.ApiPropertyOptional)({
+        description: 'Company scope for the notification; null for personal notifications',
+        example: '018e1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c',
+        nullable: true
+    }),
     _ts_metadata("design:type", Object)
 ], NotificationResponseDto.prototype, "companyId", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Timestamp when the notification was created',
+        type: 'string',
+        format: 'date-time',
+        example: '2024-03-15T10:00:00.000Z'
+    }),
     _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
 ], NotificationResponseDto.prototype, "createdAt", void 0);
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Timestamp when the notification was last updated',
+        type: 'string',
+        format: 'date-time',
+        example: '2024-03-15T10:30:00.000Z'
+    }),
     _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
 ], NotificationResponseDto.prototype, "updatedAt", void 0);
 let UnreadCountResponseDto = class UnreadCountResponseDto {
@@ -235,7 +282,11 @@ let UnreadCountResponseDto = class UnreadCountResponseDto {
 };
 _ts_decorate([
     (0, _classtransformer.Expose)(),
-    (0, _swagger.ApiProperty)(),
+    (0, _swagger.ApiProperty)({
+        description: 'Total number of unread notifications for the user',
+        example: 5,
+        minimum: 0
+    }),
     _ts_metadata("design:type", Number)
 ], UnreadCountResponseDto.prototype, "count", void 0);
 let SendNotificationDto = class SendNotificationDto extends (0, _swagger.IntersectionType)(UserIdDto, NotificationContentDto) {

package/dtos/notification.dto.d.ts

@@ -25,7 +25,7 @@ export declare class MarkReadDto {
 export declare class NotificationResponseDto {
     id: string;
     userId: string;
-    type: string;
+    type: NotificationType;
     title: string;
     message?: string | null;
     data?: Record<string, unknown> | null;

package/fesm/controllers/notification.controller.js

@@ -26,7 +26,6 @@ function _ts_param(paramIndex, decorator) {
     };
 }
 import { createApiController, NOTIFICATION_PERMISSIONS } from '@flusys/nestjs-shared/classes';
-import { NOTIFICATION_MESSAGES } from '../config';
 import { CurrentUser, RequirePermission } from '@flusys/nestjs-shared/decorators';
 import { BulkResponseDto, MessageResponseDto, SingleResponseDto } from '@flusys/nestjs-shared/dtos';
 import { JwtAuthGuard, PermissionGuard } from '@flusys/nestjs-shared/guards';
@@ -34,6 +33,7 @@ import { ILoggedUserInfo } from '@flusys/nestjs-shared/interfaces';
 import { Body, Controller, HttpCode, HttpStatus, Inject, Post, UseGuards } from '@nestjs/common';
 import { ApiBearerAuth, ApiBody, ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { plainToInstance } from 'class-transformer';
+import { NOTIFICATION_MESSAGES } from '../config';
 import { CreateNotificationDto, MarkReadDto, NotificationResponseDto, SendBulkNotificationDto, SendNotificationDto, UpdateNotificationDto } from '../dtos';
 import { NotificationHelperService } from '../services/notification-helper.service';
 import { NotificationService } from '../services/notification.service';
@@ -83,11 +83,14 @@ export class NotificationController extends createApiController(CreateNotificati
 }) {
     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: NOTIFICATION_MESSAGES.MARK_READ_SUCCESS,
-            data: plainToInstance(NotificationResponseDto, notification)
+            data: plainToInstance(NotificationResponseDto, notification, plainOptions)
         };
     }
     async markAllAsRead(user) {
@@ -121,11 +124,14 @@ export class NotificationController extends createApiController(CreateNotificati
             data: dto.data,
             companyId: dto.companyId
         });
+        const plainOptions = {
+            excludeExtraneousValues: true
+        };
         return {
             success: true,
             message: 'Notification sent successfully',
             messageKey: NOTIFICATION_MESSAGES.SEND_SUCCESS,
-            data: plainToInstance(NotificationResponseDto, notification)
+            data: plainToInstance(NotificationResponseDto, notification, plainOptions)
         };
     }
     async sendBulkNotification(dto) {
@@ -137,6 +143,9 @@ export class NotificationController extends createApiController(CreateNotificati
             data: dto.data,
             companyId: dto.companyId
         });
+        const plainOptions = {
+            excludeExtraneousValues: true
+        };
         return {
             success: true,
             message: `${notifications.length} notifications sent successfully`,
@@ -144,7 +153,7 @@ export class NotificationController extends createApiController(CreateNotificati
             messageVariables: {
                 count: notifications.length
             },
-            data: notifications.map((n)=>plainToInstance(NotificationResponseDto, n)),
+            data: notifications.map((n)=>plainToInstance(NotificationResponseDto, n, plainOptions)),
             meta: {
                 count: notifications.length,
                 total: dto.userIds.length

package/fesm/dtos/notification.dto.js

@@ -20,10 +20,10 @@ function _ts_decorate(decorators, target, key, desc) {
 function _ts_metadata(k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 }
+import { NotificationType } from '@flusys/nestjs-shared/enums';
 import { ApiProperty, ApiPropertyOptional, IntersectionType, OmitType, PartialType } from '@nestjs/swagger';
 import { Expose } from 'class-transformer';
 import { IsEnum, IsNotEmpty, IsObject, IsOptional, IsString, IsUUID, MaxLength } from 'class-validator';
-import { NotificationType } from '@flusys/nestjs-shared/enums';
 let NotificationContentDto = class NotificationContentDto {
     constructor(){
         _define_property(this, "title", void 0);
@@ -140,59 +140,106 @@ export class NotificationResponseDto {
 }
 _ts_decorate([
     Expose(),
-    ApiProperty(),
+    ApiProperty({
+        description: 'Unique identifier of the notification',
+        example: '018e1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c'
+    }),
     _ts_metadata("design:type", String)
 ], NotificationResponseDto.prototype, "id", void 0);
 _ts_decorate([
     Expose(),
-    ApiProperty(),
+    ApiProperty({
+        description: 'ID of the user this notification belongs to',
+        example: '018e1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c'
+    }),
     _ts_metadata("design:type", String)
 ], NotificationResponseDto.prototype, "userId", void 0);
 _ts_decorate([
     Expose(),
     ApiProperty({
-        enum: NotificationType
+        description: 'Category of the notification',
+        enum: NotificationType,
+        example: NotificationType.SUCCESS
     }),
-    _ts_metadata("design:type", String)
+    _ts_metadata("design:type", typeof NotificationType === "undefined" ? Object : NotificationType)
 ], NotificationResponseDto.prototype, "type", void 0);
 _ts_decorate([
     Expose(),
-    ApiProperty(),
+    ApiProperty({
+        description: 'Short title of the notification',
+        example: 'Your export is ready'
+    }),
     _ts_metadata("design:type", String)
 ], NotificationResponseDto.prototype, "title", void 0);
 _ts_decorate([
     Expose(),
-    ApiPropertyOptional(),
+    ApiPropertyOptional({
+        description: 'Optional longer body text for the notification',
+        example: 'Your CSV export has finished processing and is ready to download.',
+        nullable: true
+    }),
     _ts_metadata("design:type", Object)
 ], NotificationResponseDto.prototype, "message", void 0);
 _ts_decorate([
     Expose(),
-    ApiPropertyOptional(),
+    ApiPropertyOptional({
+        description: 'Arbitrary JSON payload attached to the notification',
+        type: 'object',
+        additionalProperties: true,
+        nullable: true,
+        example: {
+            exportId: 'abc123',
+            fileUrl: 'https://cdn.example.com/export.csv'
+        }
+    }),
     _ts_metadata("design:type", Object)
 ], NotificationResponseDto.prototype, "data", void 0);
 _ts_decorate([
     Expose(),
-    ApiProperty(),
+    ApiProperty({
+        description: 'Whether the user has read this notification',
+        example: false
+    }),
     _ts_metadata("design:type", Boolean)
 ], NotificationResponseDto.prototype, "isRead", void 0);
 _ts_decorate([
     Expose(),
-    ApiPropertyOptional(),
+    ApiPropertyOptional({
+        description: 'Timestamp when the notification was marked as read; null if unread',
+        type: 'string',
+        format: 'date-time',
+        nullable: true,
+        example: '2024-03-15T10:30:00.000Z'
+    }),
     _ts_metadata("design:type", Object)
 ], NotificationResponseDto.prototype, "readAt", void 0);
 _ts_decorate([
     Expose(),
-    ApiPropertyOptional(),
+    ApiPropertyOptional({
+        description: 'Company scope for the notification; null for personal notifications',
+        example: '018e1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c',
+        nullable: true
+    }),
     _ts_metadata("design:type", Object)
 ], NotificationResponseDto.prototype, "companyId", void 0);
 _ts_decorate([
     Expose(),
-    ApiProperty(),
+    ApiProperty({
+        description: 'Timestamp when the notification was created',
+        type: 'string',
+        format: 'date-time',
+        example: '2024-03-15T10:00:00.000Z'
+    }),
     _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
 ], NotificationResponseDto.prototype, "createdAt", void 0);
 _ts_decorate([
     Expose(),
-    ApiProperty(),
+    ApiProperty({
+        description: 'Timestamp when the notification was last updated',
+        type: 'string',
+        format: 'date-time',
+        example: '2024-03-15T10:30:00.000Z'
+    }),
     _ts_metadata("design:type", typeof Date === "undefined" ? Object : Date)
 ], NotificationResponseDto.prototype, "updatedAt", void 0);
 export class UnreadCountResponseDto {
@@ -202,7 +249,11 @@ export class UnreadCountResponseDto {
 }
 _ts_decorate([
     Expose(),
-    ApiProperty(),
+    ApiProperty({
+        description: 'Total number of unread notifications for the user',
+        example: 5,
+        minimum: 0
+    }),
     _ts_metadata("design:type", Number)
 ], UnreadCountResponseDto.prototype, "count", void 0);
 export class SendNotificationDto extends IntersectionType(UserIdDto, NotificationContentDto) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-notification",
-  "version": "5.1.1",
+  "version": "5.1.2",
   "description": "Notification module with real-time Socket.IO support",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -92,8 +92,8 @@
     "express": "^4.18.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "5.1.1",
-    "@flusys/nestjs-shared": "5.1.1",
+    "@flusys/nestjs-core": "5.1.2",
+    "@flusys/nestjs-shared": "5.1.2",
     "jsonwebtoken": "^9.0.0"
   }
 }