@futdevpro/nts-dynamo 1.15.68 → 1.15.71

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

@@ -1,78 +1,78 @@
-import { timer, of, Subscription } from 'rxjs';
-import { switchMap, filter, tap } from 'rxjs/operators';
-
-import { DyFM_Async, DyFM_Error } from '@futdevpro/fsm-dynamo';
-import { DyNTS_SingletonService } from '../../../_services/base/singleton.service';
-import { DyNTS_Bot_Main_ControlService } from './bot-main.control-service';
-import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
-import { DyNTS_Bot_MessagingProvider_ServiceBase } from './bot-messaging-provider.service-base';
-
-export abstract class DyNTS_Bot_Routines_ControlService extends DyNTS_SingletonService {
-  
-  protected mainBot_CS: DyNTS_Bot_Main_ControlService;
-  protected abstract getMainBotControlService(): DyNTS_Bot_Main_ControlService;
-
-  /* get provider(): any {
-    return this.mainBot_CS?.provider;
-  } */
-
-  get defaultProvider(): DyNTS_Bot_MessagingProvider_ServiceBase<any, any, any> {
-    return this.mainBot_CS.defaultProvider;
-  }
-
-  private _routinesStarted: boolean;
-  get routinesStarted(): boolean {
-    return this._routinesStarted;
-  }
-
-  /* protected constructor() {
-    super();
-  } */
-
-  async setup(issuer: string): Promise<void> {
-    try {
-      this.mainBot_CS = this.getMainBotControlService();
-
-      if (!this.mainBot_CS) {
-        throw new DyFM_Error({
-          ...this.getDefaultErrorSettings('setup', new Error('Main Bot Control Service not found'), issuer),
-          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-RCS-S01`,
-        })
-      }
-    } catch (error) {
-      throw new DyFM_Error({
-        ...this.getDefaultErrorSettings('setup', error, issuer),
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-RCS-S000`,
-      })
-    }
-  }
-
-  async start(issuer: string): Promise<void> {
-    try {
-      if (!this.defaultProvider) {
-        throw new DyFM_Error({
-          ...this.getDefaultErrorSettings(
-            'start', 
-            new Error(
-              'Bot routines not yet started, ' +
-              'should only be called after DyNTS_Bot_Main_ControlService.start'
-            ), 
-            'system-init'
-          ),
-          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-RCS-ST00`,
-        })
-      }
-
-      await this.startRoutines(issuer);
-
-      this._routinesStarted = true;
-    } catch (error) {
-      throw new DyFM_Error({
-        ...this.getDefaultErrorSettings('start', error, issuer),
-        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-RCS-ST0`,
-      })
-    }
-  }
-
-  abstract startRoutines(issuer: string): Promise<void>;
-}
+import { timer, of, Subscription } from 'rxjs';
+import { switchMap, filter, tap } from 'rxjs/operators';
+
+import { DyFM_Async, DyFM_Error } from '@futdevpro/fsm-dynamo';
+import { DyNTS_SingletonService } from '../../../_services/base/singleton.service';
+import { DyNTS_Bot_Main_ControlService } from './bot-main.control-service';
+import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
+import { DyNTS_Bot_MessagingProvider_ServiceBase } from './bot-messaging-provider.service-base';
+
+export abstract class DyNTS_Bot_Routines_ControlService extends DyNTS_SingletonService {
+  
+  protected mainBot_CS: DyNTS_Bot_Main_ControlService;
+  protected abstract getMainBotControlService(): DyNTS_Bot_Main_ControlService;
+
+  /* get provider(): any {
+    return this.mainBot_CS?.provider;
+  } */
+
+  get defaultProvider(): DyNTS_Bot_MessagingProvider_ServiceBase<any, any, any> {
+    return this.mainBot_CS.defaultProvider;
+  }
+
+  private _routinesStarted: boolean;
+  get routinesStarted(): boolean {
+    return this._routinesStarted;
+  }
+
+  /* protected constructor() {
+    super();
+  } */
+
+  async setup(issuer: string): Promise<void> {
+    try {
+      this.mainBot_CS = this.getMainBotControlService();
+
+      if (!this.mainBot_CS) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings('setup', new Error('Main Bot Control Service not found'), issuer),
+          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-RCS-S01`,
+        })
+      }
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings('setup', error, issuer),
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-RCS-S000`,
+      })
+    }
+  }
+
+  async start(issuer: string): Promise<void> {
+    try {
+      if (!this.defaultProvider) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'start', 
+            new Error(
+              'Bot routines not yet started, ' +
+              'should only be called after DyNTS_Bot_Main_ControlService.start'
+            ), 
+            'system-init'
+          ),
+          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-RCS-ST00`,
+        })
+      }
+
+      await this.startRoutines(issuer);
+
+      this._routinesStarted = true;
+    } catch (error) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings('start', error, issuer),
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-RCS-ST0`,
+      })
+    }
+  }
+
+  abstract startRoutines(issuer: string): Promise<void>;
+}

package/src/_modules/bot/index.ts

@@ -1,37 +1,37 @@
-//
-// Bot module (platform-agnostic)
-//
-// This module provides platform-agnostic bot functionality
-// It creates universal solutions for the most common use cases
-//
-
-// MODELS
-/* export * from './_models/bot-message.interface'; */
-export * from './_models/bot-message-wrapper.interface';
-/* export * from './_models/bot-channel.interface'; */
-export * from './_models/bot-channel-wrapper.interface';
-/* export * from './_models/bot-user.interface'; */
-export * from './_models/bot-user-wrapper.interface';
-export * from './_services/bot-messaging-provider.service-base';
-export * from './_models/bot-command.interface';
-export * from './_models/bot-global-settings.interface';
-export * from './_models/bot-last-message-date.interface';
-export * from './_models/bot-last-mention-date.interface';
-
-// COLLECTIONS
-/* export * from './_collections/bot-operations.util'; */
-export * from './_collections/bot-global-settings.const';
-export * from './_collections/bot-default-commands.const';
-
-// SERVICES
-export * from './_services/bot-main.control-service';
-export * from './_services/bot-io.control-service';
-export * from './_services/bot-commands.control-service';
-export * from './_services/bot-routines.control-service';
-/* export * from './_services/bot-messaging-provider-factory.service'; */
-
-// PROVIDERS
-export * from './_modules/discord-bot';
-export * from './_modules/slack-bot';
-export * from './_modules/teams-bot';
-/* export * from './_modules/dynamo-bot'; */
+//
+// Bot module (platform-agnostic)
+//
+// This module provides platform-agnostic bot functionality
+// It creates universal solutions for the most common use cases
+//
+
+// MODELS
+/* export * from './_models/bot-message.interface'; */
+export * from './_models/bot-message-wrapper.interface';
+/* export * from './_models/bot-channel.interface'; */
+export * from './_models/bot-channel-wrapper.interface';
+/* export * from './_models/bot-user.interface'; */
+export * from './_models/bot-user-wrapper.interface';
+export * from './_services/bot-messaging-provider.service-base';
+export * from './_models/bot-command.interface';
+export * from './_models/bot-global-settings.interface';
+export * from './_models/bot-last-message-date.interface';
+export * from './_models/bot-last-mention-date.interface';
+
+// COLLECTIONS
+/* export * from './_collections/bot-operations.util'; */
+export * from './_collections/bot-global-settings.const';
+export * from './_collections/bot-default-commands.const';
+
+// SERVICES
+export * from './_services/bot-main.control-service';
+export * from './_services/bot-io.control-service';
+export * from './_services/bot-commands.control-service';
+export * from './_services/bot-routines.control-service';
+/* export * from './_services/bot-messaging-provider-factory.service'; */
+
+// PROVIDERS
+export * from './_modules/discord-bot';
+export * from './_modules/slack-bot';
+export * from './_modules/teams-bot';
+/* export * from './_modules/dynamo-bot'; */

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

@@ -1,49 +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);
-  });
-});
-
+
+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

@@ -1,67 +1,67 @@
-
-import { Request, Response } from 'express';
-
-import { DyFM_HttpCallType } from '@futdevpro/fsm-dynamo';
-import { DyFM_customDataModule_settings } from '@futdevpro/fsm-dynamo/custom-data';
-
-import {
-  DyNTS_Endpoint_Params
-} from '../../_models/control-models/endpoint-params.control-model';
-import { DyNTS_Controller } from '../../_services/route/controller.service';
-import { DyNTS_CustomData_DataService } from './custom-data.data-service';
-
-export class DyNTS_CustomData_Controller extends DyNTS_Controller {
-
-  static getInstance(): DyNTS_CustomData_Controller {
-    return DyNTS_CustomData_Controller.getSingletonInstance();
-  }
-
-  setupEndpoints(): void {
-    this.endpoints = [
-      // CUSTOM DATA
-      new DyNTS_Endpoint_Params({
-        name: 'getCustomData',
-        type: DyFM_HttpCallType.get,
-        endpoint: DyFM_customDataModule_settings.endPoints.getCustomData,
-        tasks: [
-          async (req: Request, res: Response): Promise<void> => {
-            const customDataService = new DyNTS_CustomData_DataService({ 
-              _id: req.params.customId,
-            });
-
-            await customDataService.getDataById();
-
-            res.send({
-              url: req.url,
-              result: 'get custom call was successful!',
-              response: customDataService.data,
-              request: `.../custom/get/${req.params.customId}`,
-            });
-          },
-        ],
-      }),
-
-      new DyNTS_Endpoint_Params({
-        name: 'modifyCustomData',
-        type: DyFM_HttpCallType.post,
-        endpoint: DyFM_customDataModule_settings.endPoints.modifyCustomData,
-        tasks: [
-          async (req: Request, res: Response, issuer: string): Promise<void> => {
-            const customDataService = new DyNTS_CustomData_DataService(req.body, issuer);
-
-            res.send({
-              url: req.url,
-              result: 'post custom call was successful!',
-              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',
-              request: req.body,
-            });
-          },
-        ],
-      }),
-    ];
-  }
-}
-
+
+import { Request, Response } from 'express';
+
+import { DyFM_HttpCallType } from '@futdevpro/fsm-dynamo';
+import { DyFM_customDataModule_settings } from '@futdevpro/fsm-dynamo/custom-data';
+
+import {
+  DyNTS_Endpoint_Params
+} from '../../_models/control-models/endpoint-params.control-model';
+import { DyNTS_Controller } from '../../_services/route/controller.service';
+import { DyNTS_CustomData_DataService } from './custom-data.data-service';
+
+export class DyNTS_CustomData_Controller extends DyNTS_Controller {
+
+  static getInstance(): DyNTS_CustomData_Controller {
+    return DyNTS_CustomData_Controller.getSingletonInstance();
+  }
+
+  setupEndpoints(): void {
+    this.endpoints = [
+      // CUSTOM DATA
+      new DyNTS_Endpoint_Params({
+        name: 'getCustomData',
+        type: DyFM_HttpCallType.get,
+        endpoint: DyFM_customDataModule_settings.endPoints.getCustomData,
+        tasks: [
+          async (req: Request, res: Response): Promise<void> => {
+            const customDataService = new DyNTS_CustomData_DataService({ 
+              _id: req.params.customId,
+            });
+
+            await customDataService.getDataById();
+
+            res.send({
+              url: req.url,
+              result: 'get custom call was successful!',
+              response: customDataService.data,
+              request: `.../custom/get/${req.params.customId}`,
+            });
+          },
+        ],
+      }),
+
+      new DyNTS_Endpoint_Params({
+        name: 'modifyCustomData',
+        type: DyFM_HttpCallType.post,
+        endpoint: DyFM_customDataModule_settings.endPoints.modifyCustomData,
+        tasks: [
+          async (req: Request, res: Response, issuer: string): Promise<void> => {
+            const customDataService = new DyNTS_CustomData_DataService(req.body, issuer);
+
+            res.send({
+              url: req.url,
+              result: 'post custom call was successful!',
+              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',
+              request: req.body,
+            });
+          },
+        ],
+      }),
+    ];
+  }
+}
+

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

@@ -1,54 +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);
-  });
-});
-
+
+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/custom-data.data-service.ts

@@ -1,22 +1,22 @@
-
-
-
-import {
-  DyFM_CustomData,
-  DyFM_customData_dataParams
-} from '@futdevpro/fsm-dynamo/custom-data';
-import { DyNTS_DataService } from '../../_services/base/data.service';
-
-export class DyNTS_CustomData_DataService extends DyNTS_DataService<DyFM_CustomData> {
-
-  constructor(
-    customData?: DyFM_CustomData,
-    issuer?: string
-  ) {
-    super(
-      new DyFM_CustomData(customData),
-      DyFM_customData_dataParams,
-      issuer
-    );
-  }
+
+
+
+import {
+  DyFM_CustomData,
+  DyFM_customData_dataParams
+} from '@futdevpro/fsm-dynamo/custom-data';
+import { DyNTS_DataService } from '../../_services/base/data.service';
+
+export class DyNTS_CustomData_DataService extends DyNTS_DataService<DyFM_CustomData> {
+
+  constructor(
+    customData?: DyFM_CustomData,
+    issuer?: string
+  ) {
+    super(
+      new DyFM_CustomData(customData),
+      DyFM_customData_dataParams,
+      issuer
+    );
+  }
 }