@flusys/nestjs-task-manager 6.4.1 → 7.0.0-beta.1

package/cjs/config/event-actions.js

@@ -0,0 +1,33 @@
+/**
+ * Domain event actions published by the task manager 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 TASK_MANAGER_EVENT_ACTIONS () {
+        return TASK_MANAGER_EVENT_ACTIONS;
+    },
+    get TASK_MANAGER_EVENT_ENTITIES () {
+        return TASK_MANAGER_EVENT_ENTITIES;
+    }
+});
+const TASK_MANAGER_EVENT_ACTIONS = {
+    MOVED: 'moved',
+    ASSIGNED: 'assigned',
+    REORDERED: 'reordered'
+};
+const TASK_MANAGER_EVENT_ENTITIES = {
+    TASK: 'task',
+    TASK_BOARD: 'task_board',
+    TASK_LIST: 'task_list',
+    TASK_LABEL: 'task_label',
+    TASK_COMMENT: 'task_comment'
+};

package/cjs/config/index.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-_export_star(require("./task-manager.constants"), exports);
+_export_star(require("./event-actions"), exports);
 _export_star(require("./message-keys"), exports);
+_export_star(require("./task-manager.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/task-manager.module.js

@@ -91,6 +91,7 @@ let TaskManagerModule = class TaskManagerModule {
                 useValue: options
             });
         }
+        providers.push((0, _modules.createModuleEventsProvider)('task-manager', _taskmanagerconstants.TASK_MANAGER_MODULE_OPTIONS));
         return providers;
     }
     static createAsyncProviders(options) {

package/cjs/services/task-list.service.js

@@ -103,6 +103,12 @@ let TaskListService = class TaskListService extends _classes.ApiService {
                     id
                 })))
         ]);
+        await this.publishDomainAction(_config.TASK_MANAGER_EVENT_ACTIONS.REORDERED, {
+            ids: dto.orderedIds,
+            metadata: {
+                boardId: dto.boardId
+            }
+        });
     }
     constructor(cacheManager, utilsService, dataSourceProvider){
         super('task_list', cacheManager, utilsService, TaskListService.name, true, 'task-manager', _entities.TaskList, dataSourceProvider), _define_property(this, "cacheManager", void 0), _define_property(this, "utilsService", void 0), _define_property(this, "dataSourceProvider", void 0), this.cacheManager = cacheManager, this.utilsService = utilsService, this.dataSourceProvider = dataSourceProvider;

package/cjs/services/task-list.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");
@@ -229,4 +230,55 @@ describe('TaskListService', ()=>{
             expect(mockRepo.update).not.toHaveBeenCalled();
         });
     });
+    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('task-manager', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            _classes.EventBusRegistry.reset();
+        });
+        it('publishes task-manager.task_list.reordered with every list id', async ()=>{
+            await service.reorderLists({
+                boardId: 'board-1',
+                orderedIds: [
+                    'list-a',
+                    'list-b'
+                ]
+            });
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'task-manager.task_list.reordered',
+                payload: expect.objectContaining({
+                    ids: [
+                        'list-a',
+                        'list-b'
+                    ],
+                    metadata: {
+                        boardId: 'board-1'
+                    }
+                })
+            }));
+        });
+        it('does not publish when the task manager module has events disabled', async ()=>{
+            _classes.EventBusRegistry.configureModule('task-manager', {
+                enabled: false
+            });
+            await service.reorderLists({
+                boardId: 'board-1',
+                orderedIds: [
+                    'list-a'
+                ]
+            });
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/cjs/services/task.service.js

@@ -195,6 +195,18 @@ let TaskService = class TaskService extends _classes.ApiService {
                 saved
             ])
         ]);
+        await this.publishDomainAction(_config.TASK_MANAGER_EVENT_ACTIONS.MOVED, {
+            ids: [
+                saved.id
+            ],
+            metadata: {
+                boardId: saved.boardId,
+                fromListId: oldListId,
+                toListId: dto.targetListId,
+                position: saved.position
+            },
+            user
+        });
         return saved;
     }
     async assignTask(dto, user) {
@@ -238,6 +250,17 @@ let TaskService = class TaskService extends _classes.ApiService {
             ])
         ]);
         saved.assignees = await this.loadAssigneesForTask(saved.id);
+        await this.publishDomainAction(_config.TASK_MANAGER_EVENT_ACTIONS.ASSIGNED, {
+            ids: [
+                saved.id
+            ],
+            metadata: {
+                boardId: saved.boardId,
+                previousAssigneeIds: oldIds,
+                assigneeIds: dto.assigneeIds
+            },
+            user
+        });
         return saved;
     }
     async syncAssignees(taskId, userIds) {

package/cjs/services/task.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");
@@ -631,4 +632,69 @@ describe('TaskService', ()=>{
             superGetAllSpy.mockRestore();
         });
     });
+    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('task-manager', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            _classes.EventBusRegistry.reset();
+        });
+        it('publishes task-manager.task.moved with the source and target lists', async ()=>{
+            const task = buildTask({
+                id: 'task-1',
+                listId: 'list-old',
+                boardId: 'board-1',
+                position: 0
+            });
+            mockRepo.findOne.mockResolvedValue(task);
+            mockRepo.save.mockImplementation((t)=>Promise.resolve(t));
+            await service.moveTask({
+                taskId: 'task-1',
+                targetListId: 'list-new',
+                position: 3
+            }, (0, _loggedusermock.buildMockUser)({
+                id: 'mover-1'
+            }));
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'task-manager.task.moved',
+                payload: expect.objectContaining({
+                    ids: [
+                        'task-1'
+                    ],
+                    metadata: expect.objectContaining({
+                        boardId: 'board-1',
+                        fromListId: 'list-old',
+                        toListId: 'list-new'
+                    })
+                })
+            }));
+        });
+        it('does not publish when the task manager module has events disabled', async ()=>{
+            _classes.EventBusRegistry.configureModule('task-manager', {
+                enabled: false
+            });
+            const task = buildTask({
+                id: 'task-1',
+                listId: 'list-old',
+                boardId: 'board-1'
+            });
+            mockRepo.findOne.mockResolvedValue(task);
+            mockRepo.save.mockImplementation((t)=>Promise.resolve(t));
+            await service.moveTask({
+                taskId: 'task-1',
+                targetListId: 'list-new'
+            }, (0, _loggedusermock.buildMockUser)());
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/config/event-actions.d.ts

@@ -0,0 +1,12 @@
+export declare const TASK_MANAGER_EVENT_ACTIONS: {
+    readonly MOVED: "moved";
+    readonly ASSIGNED: "assigned";
+    readonly REORDERED: "reordered";
+};
+export declare const TASK_MANAGER_EVENT_ENTITIES: {
+    readonly TASK: "task";
+    readonly TASK_BOARD: "task_board";
+    readonly TASK_LIST: "task_list";
+    readonly TASK_LABEL: "task_label";
+    readonly TASK_COMMENT: "task_comment";
+};

package/config/index.d.ts

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

package/fesm/config/event-actions.js

@@ -0,0 +1,15 @@
+/**
+ * Domain event actions published by the task manager module, alongside the CRUD
+ * lifecycle actions every ApiService emits.
+ */ export const TASK_MANAGER_EVENT_ACTIONS = {
+    MOVED: 'moved',
+    ASSIGNED: 'assigned',
+    REORDERED: 'reordered'
+};
+/** Every entity the task manager module publishes under */ export const TASK_MANAGER_EVENT_ENTITIES = {
+    TASK: 'task',
+    TASK_BOARD: 'task_board',
+    TASK_LIST: 'task_list',
+    TASK_LABEL: 'task_label',
+    TASK_COMMENT: 'task_comment'
+};

package/fesm/config/index.js

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

package/fesm/modules/task-manager.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 { Module } from '@nestjs/common';
 import { JwtService } from '@nestjs/jwt';
 import { TASK_MANAGER_MODULE_OPTIONS } from '../config/task-manager.constants';
@@ -81,6 +81,7 @@ export class TaskManagerModule {
                 useValue: options
             });
         }
+        providers.push(createModuleEventsProvider('task-manager', TASK_MANAGER_MODULE_OPTIONS));
         return providers;
     }
     static createAsyncProviders(options) {

package/fesm/services/task-list.service.js

@@ -28,7 +28,7 @@ function _ts_param(paramIndex, decorator) {
 import { ApiService, HybridCache } from '@flusys/nestjs-shared/classes';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { Inject, Injectable, NotFoundException, Scope } from '@nestjs/common';
-import { TASK_LIST_MESSAGES } from '../config';
+import { TASK_LIST_MESSAGES, TASK_MANAGER_EVENT_ACTIONS } from '../config';
 import { TaskList } from '../entities';
 import { TaskManagerDataSourceProvider } from './task-manager-datasource.provider';
 export class TaskListService extends ApiService {
@@ -93,6 +93,12 @@ export class TaskListService extends ApiService {
                     id
                 })))
         ]);
+        await this.publishDomainAction(TASK_MANAGER_EVENT_ACTIONS.REORDERED, {
+            ids: dto.orderedIds,
+            metadata: {
+                boardId: dto.boardId
+            }
+        });
     }
     constructor(cacheManager, utilsService, dataSourceProvider){
         super('task_list', cacheManager, utilsService, TaskListService.name, true, 'task-manager', TaskList, dataSourceProvider), _define_property(this, "cacheManager", void 0), _define_property(this, "utilsService", void 0), _define_property(this, "dataSourceProvider", void 0), this.cacheManager = cacheManager, this.utilsService = utilsService, this.dataSourceProvider = dataSourceProvider;

package/fesm/services/task-list.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, createMockQueryBuilder, createMockRepository } from '@test-utils/mocks/repository.mock';
 import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
@@ -225,4 +226,55 @@ describe('TaskListService', ()=>{
             expect(mockRepo.update).not.toHaveBeenCalled();
         });
     });
+    describe('domain events', ()=>{
+        let publish;
+        beforeEach(()=>{
+            publish = jest.fn().mockResolvedValue(undefined);
+            EventBusRegistry.reset();
+            EventBusRegistry.setBus({
+                publish,
+                subscribe: jest.fn(),
+                close: jest.fn()
+            });
+            EventBusRegistry.configureModule('task-manager', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            EventBusRegistry.reset();
+        });
+        it('publishes task-manager.task_list.reordered with every list id', async ()=>{
+            await service.reorderLists({
+                boardId: 'board-1',
+                orderedIds: [
+                    'list-a',
+                    'list-b'
+                ]
+            });
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'task-manager.task_list.reordered',
+                payload: expect.objectContaining({
+                    ids: [
+                        'list-a',
+                        'list-b'
+                    ],
+                    metadata: {
+                        boardId: 'board-1'
+                    }
+                })
+            }));
+        });
+        it('does not publish when the task manager module has events disabled', async ()=>{
+            EventBusRegistry.configureModule('task-manager', {
+                enabled: false
+            });
+            await service.reorderLists({
+                boardId: 'board-1',
+                orderedIds: [
+                    'list-a'
+                ]
+            });
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/fesm/services/task.service.js

@@ -29,7 +29,7 @@ import { ApiService, HybridCache } from '@flusys/nestjs-shared/classes';
 import { UtilsService } from '@flusys/nestjs-shared/modules';
 import { BadRequestException, Inject, Injectable, NotFoundException, Scope } from '@nestjs/common';
 import { In, IsNull } from 'typeorm';
-import { TASK_MESSAGES } from '../config';
+import { TASK_MANAGER_EVENT_ACTIONS, TASK_MESSAGES } from '../config';
 import { Task, TaskAssignee, TaskLabel, TaskTaskLabel } from '../entities';
 import { TaskActivityService } from './task-activity.service';
 import { TaskBoardService } from './task-board.service';
@@ -185,6 +185,18 @@ export class TaskService extends ApiService {
                 saved
             ])
         ]);
+        await this.publishDomainAction(TASK_MANAGER_EVENT_ACTIONS.MOVED, {
+            ids: [
+                saved.id
+            ],
+            metadata: {
+                boardId: saved.boardId,
+                fromListId: oldListId,
+                toListId: dto.targetListId,
+                position: saved.position
+            },
+            user
+        });
         return saved;
     }
     async assignTask(dto, user) {
@@ -228,6 +240,17 @@ export class TaskService extends ApiService {
             ])
         ]);
         saved.assignees = await this.loadAssigneesForTask(saved.id);
+        await this.publishDomainAction(TASK_MANAGER_EVENT_ACTIONS.ASSIGNED, {
+            ids: [
+                saved.id
+            ],
+            metadata: {
+                boardId: saved.boardId,
+                previousAssigneeIds: oldIds,
+                assigneeIds: dto.assigneeIds
+            },
+            user
+        });
         return saved;
     }
     async syncAssignees(taskId, userIds) {

package/fesm/services/task.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 { createMockQueryBuilder, createMockRepository } from '@test-utils/mocks/repository.mock';
 import { buildMockUser } from '@test-utils/mocks/logged-user.mock';
@@ -627,4 +628,69 @@ describe('TaskService', ()=>{
             superGetAllSpy.mockRestore();
         });
     });
+    describe('domain events', ()=>{
+        let publish;
+        beforeEach(()=>{
+            publish = jest.fn().mockResolvedValue(undefined);
+            EventBusRegistry.reset();
+            EventBusRegistry.setBus({
+                publish,
+                subscribe: jest.fn(),
+                close: jest.fn()
+            });
+            EventBusRegistry.configureModule('task-manager', {
+                enabled: true
+            });
+        });
+        afterEach(()=>{
+            EventBusRegistry.reset();
+        });
+        it('publishes task-manager.task.moved with the source and target lists', async ()=>{
+            const task = buildTask({
+                id: 'task-1',
+                listId: 'list-old',
+                boardId: 'board-1',
+                position: 0
+            });
+            mockRepo.findOne.mockResolvedValue(task);
+            mockRepo.save.mockImplementation((t)=>Promise.resolve(t));
+            await service.moveTask({
+                taskId: 'task-1',
+                targetListId: 'list-new',
+                position: 3
+            }, buildMockUser({
+                id: 'mover-1'
+            }));
+            expect(publish).toHaveBeenCalledWith(expect.objectContaining({
+                name: 'task-manager.task.moved',
+                payload: expect.objectContaining({
+                    ids: [
+                        'task-1'
+                    ],
+                    metadata: expect.objectContaining({
+                        boardId: 'board-1',
+                        fromListId: 'list-old',
+                        toListId: 'list-new'
+                    })
+                })
+            }));
+        });
+        it('does not publish when the task manager module has events disabled', async ()=>{
+            EventBusRegistry.configureModule('task-manager', {
+                enabled: false
+            });
+            const task = buildTask({
+                id: 'task-1',
+                listId: 'list-old',
+                boardId: 'board-1'
+            });
+            mockRepo.findOne.mockResolvedValue(task);
+            mockRepo.save.mockImplementation((t)=>Promise.resolve(t));
+            await service.moveTask({
+                taskId: 'task-1',
+                targetListId: 'list-new'
+            }, buildMockUser());
+            expect(publish).not.toHaveBeenCalled();
+        });
+    });
 });

package/interfaces/task-manager-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 ITaskManagerModuleConfig extends IDataSourceServiceOptions {
     jwtSecret?: string;
+    events?: IModuleEventsConfig;
 }
 export interface TaskManagerModuleOptions extends IDynamicModuleConfig {
     bootstrapAppConfig?: IBootstrapAppConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flusys/nestjs-task-manager",
-  "version": "6.4.1",
+  "version": "7.0.0-beta.1",
   "description": "Task management module with dynamic boards and real-time collaboration",
   "main": "cjs/index.js",
   "module": "fesm/index.js",
@@ -85,7 +85,7 @@
     "socket.io": "^4.8.0"
   },
   "dependencies": {
-    "@flusys/nestjs-core": "6.4.1",
-    "@flusys/nestjs-shared": "6.4.1"
+    "@flusys/nestjs-core": "7.0.0-beta.1",
+    "@flusys/nestjs-shared": "7.0.0-beta.1"
   }
 }