@futdevpro/nts-dynamo 1.15.1 → 1.15.3

package/src/_modules/bot/_services/bot-messaging-provider.service-base.spec.ts

@@ -0,0 +1,349 @@
+
+import { DyNTS_Bot_MessagingProvider_ServiceBase, DyNTS_Bot_MessagingProvider_Config } from './bot-messaging-provider.service-base';
+import { DyFM_Msg_Provider_Type } from '@futdevpro/fsm-dynamo/messaging';
+import { DyNTS_Bot_ChannelWrapper } from '../_models/bot-channel-wrapper.interface';
+import { DyNTS_Bot_MessageWrapper } from '../_models/bot-message-wrapper.interface';
+import { DyNTS_Bot_UserWrapper } from '../_models/bot-user-wrapper.interface';
+
+class MockChannel {
+  id: string;
+  name: string;
+}
+
+class MockMessage {
+  id: string;
+  content: string;
+}
+
+class MockUser {
+  id: string;
+  username: string;
+}
+
+class MockRole {
+  id: string;
+  name: string;
+}
+
+class TestMessagingProvider extends DyNTS_Bot_MessagingProvider_ServiceBase<
+  MockChannel,
+  MockMessage,
+  MockUser,
+  DyNTS_Bot_MessagingProvider_Config,
+  MockRole
+> {
+  readonly name = 'test-provider';
+  readonly type = DyFM_Msg_Provider_Type.dynamo;
+  readonly config: DyNTS_Bot_MessagingProvider_Config = {
+    reportChannelName: 'test-channel',
+  };
+
+  get botId(): string {
+    return 'bot-123';
+  }
+
+  get botDisplayName(): string {
+    return 'Test Bot';
+  }
+
+  async setup(issuer: string): Promise<void> {
+    // Mock implementation
+  }
+
+  async start(issuer: string): Promise<void> {
+    // Mock implementation
+  }
+
+  async getChannelByName(name: string): Promise<DyNTS_Bot_ChannelWrapper<MockChannel>> {
+    const channel = this.channelCache.get(name) || { id: 'channel-1', name };
+    return this.wrapChannel(channel);
+  }
+
+  async getChannelById(id: string): Promise<DyNTS_Bot_ChannelWrapper<MockChannel>> {
+    const channel = { id, name: 'test-channel' };
+    return this.wrapChannel(channel);
+  }
+
+  async sendMessageToChannelByName(channelName: string, message: string, issuer: string): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    const channel = await this.getChannelByName(channelName);
+    return this.sendMessageToChannel(channel, message, issuer);
+  }
+
+  async getMessagesFromChannelByChannelName(channelName: string, limit?: number): Promise<DyNTS_Bot_MessageWrapper<MockMessage>[]> {
+    return [];
+  }
+
+  async getLastMessageInChannel(channelName: string): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    return this.wrapMessage({ id: 'msg-1', content: 'Last message' });
+  }
+
+  async clearChannel(channelWrapper: DyNTS_Bot_ChannelWrapper<MockChannel>): Promise<void> {
+    // Mock implementation
+  }
+
+  async sendMessageToChannel(channelWrapper: DyNTS_Bot_ChannelWrapper<MockChannel>, content: string, issuer: string): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    return this.wrapMessage({ id: 'msg-1', content });
+  }
+
+  async replyToMessage(messageWrapper: DyNTS_Bot_MessageWrapper<MockMessage>, content: string): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    return this.wrapMessage({ id: 'msg-2', content });
+  }
+
+  async sendTyping(channelWrapper: DyNTS_Bot_ChannelWrapper<MockChannel>): Promise<void> {
+    // Mock implementation
+  }
+
+  async sendTypingForMessage(messageWrapper: DyNTS_Bot_MessageWrapper<MockMessage>): Promise<void> {
+    // Mock implementation
+  }
+
+  async fetchMessages(channelWrapper: DyNTS_Bot_ChannelWrapper<MockChannel>, limit: number): Promise<DyNTS_Bot_MessageWrapper<MockMessage>[]> {
+    return [];
+  }
+
+  async fetchMessagesById(id: string, limit: number): Promise<DyNTS_Bot_MessageWrapper<MockMessage>[]> {
+    return [];
+  }
+
+  async fetchMessagesForMessage(messageWrapper: DyNTS_Bot_MessageWrapper<MockMessage>, limit: number): Promise<DyNTS_Bot_MessageWrapper<MockMessage>[]> {
+    return [];
+  }
+
+  async fetchAllMessagesWithPaging(channelWrapper: DyNTS_Bot_ChannelWrapper<MockChannel>, maxFetch?: number): Promise<DyNTS_Bot_MessageWrapper<MockMessage>[]> {
+    return [];
+  }
+
+  async deleteMessage(messageWrapper: DyNTS_Bot_MessageWrapper<MockMessage>): Promise<void> {
+    // Mock implementation
+  }
+
+  async updateMessage(message: MockMessage, issuer: string): Promise<void> {
+    // Mock implementation
+  }
+
+  async getUserByName(username: string): Promise<DyNTS_Bot_UserWrapper<MockUser>> {
+    return this.wrapUser({ id: 'user-1', username });
+  }
+
+  getUserMention(userId: string): string {
+    return `<@${userId}>`;
+  }
+
+  async readMembersInChannel(channelName: string): Promise<DyNTS_Bot_UserWrapper<MockUser>[]> {
+    return [];
+  }
+
+  async readMemberNamesInChannel(channelName: string): Promise<string[]> {
+    return [];
+  }
+
+  async getLastMessageSentBy(channelName: string, username: string): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    return this.wrapMessage({ id: 'msg-1', content: 'Last message' });
+  }
+
+  async getLastMentionOf(channelName: string, username: string): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    return this.wrapMessage({ id: 'msg-1', content: 'Last mention' });
+  }
+
+  async readLastMessageDatesByMembers(channelName: string, memberNames: string[]): Promise<any[]> {
+    return [];
+  }
+
+  async readLastMessageWithMemberNamePingInIt(channelName: string, users: DyNTS_Bot_UserWrapper<MockUser>[]): Promise<any[]> {
+    return [];
+  }
+
+  getRoleByName?(roleName: string): any {
+    return this.roleCache.get(roleName) || { id: 'role-1', name: roleName };
+  }
+
+  async getRolePingByName?(roleName: string): Promise<string> {
+    return `<@&role-1>`;
+  }
+
+  async getRolePingsByName?(roleNames: string[]): Promise<string> {
+    return roleNames.map(name => `<@&role-1>`).join(' ');
+  }
+
+  async create_onMessageEventListener(
+    handler: (message: DyNTS_Bot_MessageWrapper<MockMessage>, issuer: string) => Promise<void>
+  ): Promise<void> {
+    // Mock implementation
+  }
+
+  create_onErrorEventListener(handler: (error: any) => void): void {
+    // Mock implementation
+  }
+
+  async sendReport(message: string): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    return this.sendMessageToChannelByName(this.config.reportChannelName, message, 'system');
+  }
+
+  async sendReportIn(message: string): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    return this.sendMessageToChannelByName(this.config.reportChannelName, message, 'system');
+  }
+
+  async wrapMessage(message: MockMessage): Promise<DyNTS_Bot_MessageWrapper<MockMessage>> {
+    const self = this;
+    return {
+      id: message.id,
+      content: message.content,
+      rawPlatformMessage: message,
+      channelId: 'channel-1',
+      userId: 'user-1',
+      username: 'test-user',
+      timestamp: new Date(),
+      getChannel: async () => self.getChannelById('channel-1'),
+      getUser: async () => self.getUserByName('test-user'),
+      reply: async (content: string) => self.replyToMessage(await self.wrapMessage(message), content),
+      delete: async () => self.deleteMessage(await self.wrapMessage(message)),
+    } as any;
+  }
+
+  async wrapChannel(channel: MockChannel): Promise<DyNTS_Bot_ChannelWrapper<MockChannel>> {
+    const self = this;
+    return {
+      id: channel.id,
+      name: channel.name,
+      rawPlatformChannel: channel,
+      sendMessage: async (content: string, issuer: string) =>
+        self.sendMessageToChannel(await self.wrapChannel(channel), content, issuer),
+      getMessages: async (limit: number) => self.fetchMessages(await self.wrapChannel(channel), limit),
+      clear: async () => self.clearChannel(await self.wrapChannel(channel)),
+    } as any;
+  }
+
+  async wrapUser(user: MockUser): Promise<DyNTS_Bot_UserWrapper<MockUser>> {
+    return {
+      id: user.id,
+      username: user.username,
+      rawPlatformUser: user,
+      mention: this.getUserMention(user.id),
+    } as any;
+  }
+
+  static getInstance(): TestMessagingProvider {
+    return TestMessagingProvider.getSingletonInstance();
+  }
+}
+
+xdescribe('| DyNTS_Bot_MessagingProvider_ServiceBase', () => {
+  let provider: TestMessagingProvider;
+
+  beforeEach(() => {
+    provider = TestMessagingProvider.getInstance();
+  });
+
+  it('| should be a singleton instance', () => {
+    const instance1 = TestMessagingProvider.getInstance();
+    const instance2 = TestMessagingProvider.getInstance();
+
+    expect(instance1).toBe(instance2);
+    expect(instance1).toBeInstanceOf(TestMessagingProvider);
+  });
+
+  describe('| properties', () => {
+    it('| should have name property', () => {
+      expect(provider.name).toBe('test-provider');
+    });
+
+    it('| should have type property', () => {
+      expect(provider.type).toBe(DyFM_Msg_Provider_Type.dynamo);
+    });
+
+    it('| should have botId getter', () => {
+      expect(provider.botId).toBe('bot-123');
+    });
+
+    it('| should have botDisplayName getter', () => {
+      expect(provider.botDisplayName).toBe('Test Bot');
+    });
+
+    it('| should have config property', () => {
+      expect(provider.config).toBeDefined();
+      expect(provider.config.reportChannelName).toBe('test-channel');
+    });
+  });
+
+  describe('| channelCache', () => {
+    it('| should cache channels', () => {
+      const channel: MockChannel = { id: 'channel-1', name: 'test-channel' };
+      (provider as any).channelCache.set('test-channel', channel);
+
+      expect((provider as any).channelCache.get('test-channel')).toBe(channel);
+    });
+  });
+
+  describe('| roleCache', () => {
+    it('| should cache roles', () => {
+      const role: MockRole = { id: 'role-1', name: 'test-role' };
+      (provider as any).roleCache.set('test-role', role);
+
+      expect((provider as any).roleCache.get('test-role')).toBe(role);
+    });
+  });
+
+  describe('| wrapMessage', () => {
+    it('| should wrap message correctly', async () => {
+      const message: MockMessage = { id: 'msg-1', content: 'Test message' };
+      const wrapped = await provider.wrapMessage(message);
+
+      expect(wrapped.id).toBe('msg-1');
+      expect(wrapped.content).toBe('Test message');
+      expect(wrapped.rawPlatformMessage).toBe(message);
+    });
+  });
+
+  describe('| wrapChannel', () => {
+    it('| should wrap channel correctly', async () => {
+      const channel: MockChannel = { id: 'channel-1', name: 'test-channel' };
+      const wrapped = await provider.wrapChannel(channel);
+
+      expect(wrapped.id).toBe('channel-1');
+      expect(wrapped.name).toBe('test-channel');
+      expect(wrapped.rawPlatformChannel).toBe(channel);
+    });
+  });
+
+  describe('| wrapUser', () => {
+    it('| should wrap user correctly', async () => {
+      const user: MockUser = { id: 'user-1', username: 'test-user' };
+      const wrapped = await provider.wrapUser(user);
+
+      expect(wrapped.id).toBe('user-1');
+      expect(wrapped.username).toBe('test-user');
+      expect(wrapped.rawPlatformUser).toBe(user);
+    });
+  });
+
+  describe('| getUserMention', () => {
+    it('| should return user mention', () => {
+      const mention = provider.getUserMention('user-123');
+
+      expect(mention).toBe('<@user-123>');
+    });
+  });
+
+  describe('| sendReport', () => {
+    it('| should send report to report channel', async () => {
+      spyOn(provider, 'sendMessageToChannelByName').and.returnValue(provider.wrapMessage({ id: 'msg-1', content: 'Report' }));
+
+      const result = await provider.sendReport('Test report');
+
+      expect(provider.sendMessageToChannelByName).toHaveBeenCalledWith('test-channel', 'Test report', 'system');
+      expect(result).toBeDefined();
+    });
+  });
+
+  describe('| sendReportIn', () => {
+    it('| should send report in report channel', async () => {
+      spyOn(provider, 'sendMessageToChannelByName').and.returnValue(provider.wrapMessage({ id: 'msg-1', content: 'Report' }));
+
+      const result = await provider.sendReportIn('Test report');
+
+      expect(provider.sendMessageToChannelByName).toHaveBeenCalledWith('test-channel', 'Test report', 'system');
+      expect(result).toBeDefined();
+    });
+  });
+});
+

package/src/_modules/bot/_services/bot-routines.control-service.spec.ts

@@ -0,0 +1,111 @@
+
+import { DyNTS_Bot_Routines_ControlService } from './bot-routines.control-service';
+import { DyNTS_Bot_Main_ControlService } from './bot-main.control-service';
+import { DyNTS_Bot_MessagingProvider_ServiceBase } from './bot-messaging-provider.service-base';
+import { DyFM_Error } from '@futdevpro/fsm-dynamo';
+import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
+
+class TestBotRoutinesService extends DyNTS_Bot_Routines_ControlService {
+  protected declare mainBot_CS: any;
+  protected getMainBotControlService(): DyNTS_Bot_Main_ControlService {
+    return {
+      defaultProvider: {
+        botId: 'bot-123',
+      },
+    } as any;
+  }
+
+  startRoutines = async (issuer: string): Promise<void> => {
+    // Mock implementation
+  };
+
+  static getInstance(): TestBotRoutinesService {
+    return TestBotRoutinesService.getSingletonInstance();
+  }
+}
+
+xdescribe('| DyNTS_Bot_Routines_ControlService', () => {
+  let service: TestBotRoutinesService;
+
+  beforeEach(() => {
+    service = TestBotRoutinesService.getInstance();
+  });
+
+  it('| should be a singleton instance', () => {
+    const instance1 = TestBotRoutinesService.getInstance();
+    const instance2 = TestBotRoutinesService.getInstance();
+
+    expect(instance1).toBe(instance2);
+    expect(instance1).toBeInstanceOf(TestBotRoutinesService);
+  });
+
+  describe('| defaultProvider', () => {
+    it('| should return default provider from main bot service', () => {
+      (service as any).mainBot_CS = (service as any).getMainBotControlService();
+
+      expect(service.defaultProvider).toBeDefined();
+    });
+  });
+
+  describe('| routinesStarted', () => {
+    it('| should return undefined initially', () => {
+      // Reset the private _routinesStarted field to undefined for clean test
+      (service as any)._routinesStarted = undefined;
+      expect(service.routinesStarted).toBeFalsy();
+    });
+
+    it('| should return true after start', async () => {
+      (service as any).mainBot_CS = (service as any).getMainBotControlService();
+      await service.start('issuer-123');
+
+      expect(service.routinesStarted).toBe(true);
+    });
+  });
+
+  describe('| setup', () => {
+    it('| should setup main bot service', async () => {
+      await service.setup('issuer-123');
+
+      expect((service as any).mainBot_CS).toBeDefined();
+    });
+
+    it('| should throw error when main bot service not found', async () => {
+      const serviceWithoutMainBot = new (class extends TestBotRoutinesService {
+        protected override getMainBotControlService(): any {
+          return null;
+        }
+      } as any)();
+
+      await expectAsync(
+        serviceWithoutMainBot.setup('issuer-123')
+      ).toBeRejected();
+    });
+  });
+
+  describe('| start', () => {
+    it('| should throw error when default provider not started', async () => {
+      const serviceWithoutProvider = new (class extends TestBotRoutinesService {
+        protected override getMainBotControlService(): any {
+          return {
+            defaultProvider: null,
+          };
+        }
+      } as any)();
+
+      await expectAsync(
+        serviceWithoutProvider.start('issuer-123')
+      ).toBeRejected();
+    });
+
+    it('| should start routines and set routinesStarted flag', async () => {
+      (service as any).mainBot_CS = (service as any).getMainBotControlService();
+      spyOn(service, 'startRoutines').and.returnValue(Promise.resolve());
+
+      await service.start('issuer-123');
+
+      expect(service.startRoutines).toHaveBeenCalledWith('issuer-123');
+      expect(service.routinesStarted).toBe(true);
+    });
+  });
+});
+

package/src/_modules/custom-data/custom-data.controller.spec.ts

@@ -0,0 +1,49 @@
+
+import { DyNTS_CustomData_Controller } from './custom-data.controller';
+import { DyFM_HttpCallType } from '@futdevpro/fsm-dynamo';
+
+describe('| DyNTS_CustomData_Controller', () => {
+  let controller: DyNTS_CustomData_Controller;
+
+  beforeEach(() => {
+    controller = DyNTS_CustomData_Controller.getInstance();
+  });
+
+  it('| should be a singleton instance', () => {
+    const instance1 = DyNTS_CustomData_Controller.getInstance();
+    const instance2 = DyNTS_CustomData_Controller.getInstance();
+
+    expect(instance1).toBe(instance2);
+    expect(instance1).toBeInstanceOf(DyNTS_CustomData_Controller);
+  });
+
+  it('| should setup endpoints', () => {
+    controller.setupEndpoints();
+
+    expect(controller.endpoints).toBeDefined();
+    expect(controller.endpoints.length).toBeGreaterThan(0);
+  });
+
+  it('| should have getCustomData endpoint', () => {
+    controller.setupEndpoints();
+
+    const getCustomDataEndpoint = controller.endpoints.find(ep => ep.name === 'getCustomData');
+
+    expect(getCustomDataEndpoint).toBeDefined();
+    expect(getCustomDataEndpoint?.type).toBe(DyFM_HttpCallType.get);
+    expect((getCustomDataEndpoint as any)?.tasks).toBeDefined();
+    expect((getCustomDataEndpoint as any)?.tasks.length).toBeGreaterThan(0);
+  });
+
+  it('| should have modifyCustomData endpoint', () => {
+    controller.setupEndpoints();
+
+    const modifyCustomDataEndpoint = controller.endpoints.find(ep => ep.name === 'modifyCustomData');
+
+    expect(modifyCustomDataEndpoint).toBeDefined();
+    expect(modifyCustomDataEndpoint?.type).toBe(DyFM_HttpCallType.post);
+    expect((modifyCustomDataEndpoint as any)?.tasks).toBeDefined();
+    expect((modifyCustomDataEndpoint as any)?.tasks.length).toBeGreaterThan(0);
+  });
+});
+

package/src/_modules/custom-data/custom-data.controller.ts

@@ -49,12 +49,10 @@ export class DyNTS_CustomData_Controller extends DyNTS_Controller {
           async (req: Request, res: Response, issuer: string): Promise<void> => {
             const customDataService = new DyNTS_CustomData_DataService(req.body, issuer);
 
-            await customDataService.saveData();
-
             res.send({
               url: req.url,
               result: 'post custom call was successful!',
-              response: customDataService.data,
+              response: await customDataService.saveData(req.body),
               warning: 
                 'keep in mind that this is a playground DB, ' +
                 'and it will be cleared out from time to time',

package/src/_modules/custom-data/custom-data.data-service.spec.ts

@@ -0,0 +1,54 @@
+
+import { DyNTS_CustomData_DataService } from './custom-data.data-service';
+import { DyFM_CustomData } from '@futdevpro/fsm-dynamo/custom-data';
+import { DyNTS_global_settings } from '../../_collections/global-settings.const';
+import { DyFM_EnvironmentFlag } from '@futdevpro/fsm-dynamo';
+import { DyNTS_GlobalService } from '../../_services/core/global.service';
+
+describe('| DyNTS_CustomData_DataService', () => {
+  let mockDBService: jasmine.SpyObj<{ find: () => Promise<unknown[]>; findOne: () => Promise<unknown> }>;
+
+  beforeAll(() => {
+    if (!DyNTS_global_settings.systemShortCodeName) {
+      (DyNTS_global_settings as { systemShortCodeName?: string }).systemShortCodeName = 'TEST';
+    }
+    if (!DyNTS_global_settings.env_settings) {
+      (DyNTS_global_settings as { env_settings?: unknown }).env_settings = {
+        environment: DyFM_EnvironmentFlag.local,
+      };
+    }
+  });
+
+  beforeEach(() => {
+    mockDBService = jasmine.createSpyObj('DyNTS_DBService', ['find', 'findOne', 'getDataById', 'getAll', 'createData', 'modifyData']);
+    mockDBService.find.and.returnValue(Promise.resolve([]));
+    mockDBService.findOne.and.returnValue(Promise.resolve(null));
+    spyOn(DyNTS_GlobalService, 'getDBService').and.returnValue(mockDBService as never);
+  });
+
+  it('| should create service with custom data', () => {
+    const customData = new DyFM_CustomData({
+      _id: 'test-data-id',
+    } as any);
+
+    const service = new DyNTS_CustomData_DataService(customData, 'issuer-123');
+
+    expect(service).toBeInstanceOf(DyNTS_CustomData_DataService);
+    expect(service.data).toBeDefined();
+    expect(service.data._id).toBe('test-data-id');
+  });
+
+  it('| should create service without custom data', () => {
+    const service = new DyNTS_CustomData_DataService();
+
+    expect(service).toBeInstanceOf(DyNTS_CustomData_DataService);
+    expect(service.data).toBeDefined();
+  });
+
+  it('| should create service with issuer', () => {
+    const service = new DyNTS_CustomData_DataService(undefined, 'issuer-123');
+
+    expect(service).toBeInstanceOf(DyNTS_CustomData_DataService);
+  });
+});
+

package/src/_modules/custom-data/get-custom-data-routing-module.util.spec.ts

@@ -0,0 +1,28 @@
+
+import { DyNTS_getCustomDataRoutingModule } from './get-custom-data-routing-module.util';
+import { DyNTS_RouteSecurity } from '../../_enums/route-security.enum';
+import { DyNTS_RoutingModule } from '../../_services/route/routing-module.service';
+
+describe('| DyNTS_getCustomDataRoutingModule', () => {
+  it('| should create routing module with default settings', () => {
+    const module = DyNTS_getCustomDataRoutingModule();
+
+    expect(module).toBeInstanceOf(DyNTS_RoutingModule);
+    expect(module).toBeTruthy();
+  });
+
+  it('| should create routing module with security override', () => {
+    const module = DyNTS_getCustomDataRoutingModule(DyNTS_RouteSecurity.secure);
+
+    expect(module).toBeInstanceOf(DyNTS_RoutingModule);
+    expect(module).toBeTruthy();
+  });
+
+  it('| should create routing module with both security', () => {
+    const module = DyNTS_getCustomDataRoutingModule(DyNTS_RouteSecurity.both);
+
+    expect(module).toBeInstanceOf(DyNTS_RoutingModule);
+    expect(module).toBeTruthy();
+  });
+});
+