@futdevpro/nts-dynamo 1.15.2 → 1.15.3

package/src/_collections/get-environment-settings.util.spec.ts

@@ -0,0 +1,210 @@
+
+import { DyFM_EnvironmentFlag, DyFM_Log } from '@futdevpro/fsm-dynamo';
+import { DyNTS_getEnvironment_settings } from './get-environment-settings.util';
+
+describe('| DyNTS_getEnvironment_settings', () => {
+  let originalEnv: string | undefined;
+  let originalNodeEnv: string | undefined;
+  let originalEnvironment: string | undefined;
+
+  beforeEach(() => {
+    // Save original environment variables
+    originalEnv = process.env.ENV;
+    originalNodeEnv = process.env.NODE_ENV;
+    originalEnvironment = process.env.ENVIRONMENT;
+    
+    // Clear environment variables
+    delete process.env.ENV;
+    delete process.env.NODE_ENV;
+    delete process.env.ENVIRONMENT;
+    delete process.env.DISCORD_GUILD_ID;
+    delete process.env.DISCORD_BOT_TOKEN;
+    delete process.env.DISCORD_BOT_CLIENT_ID;
+    delete process.env.DISCORD_BOT_OAUTH2_URL;
+    delete process.env.MONGO_URL;
+    delete process.env.MONGO_URI;
+    delete process.env.OPENAI_API_KEY;
+    delete process.env.OPENAI_ORGANIZATION;
+    delete process.env.OPENAI_PROJECT;
+    delete process.env.OPENAI_TTS_API_KEY;
+  });
+
+  afterEach(() => {
+    // Restore original environment variables
+    if (originalEnv !== undefined) {
+      process.env.ENV = originalEnv;
+    } else {
+      delete process.env.ENV;
+    }
+    if (originalNodeEnv !== undefined) {
+      process.env.NODE_ENV = originalNodeEnv;
+    } else {
+      delete process.env.NODE_ENV;
+    }
+    if (originalEnvironment !== undefined) {
+      process.env.ENVIRONMENT = originalEnvironment;
+    } else {
+      delete process.env.ENVIRONMENT;
+    }
+  });
+
+  it('| should return local environment when no environment variables are set', () => {
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.environment).toBe(DyFM_EnvironmentFlag.local);
+  });
+
+  it('| should use ENV variable when set', () => {
+    process.env.ENV = 'prod';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.environment).toBe(DyFM_EnvironmentFlag.prod);
+  });
+
+  it('| should use NODE_ENV when ENV is not set', () => {
+    process.env.NODE_ENV = 'dev';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.environment).toBe(DyFM_EnvironmentFlag.local);
+  });
+
+  it('| should use ENVIRONMENT when ENV and NODE_ENV are not set', () => {
+    process.env.ENVIRONMENT = 'test';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.environment).toBe(DyFM_EnvironmentFlag.local);
+  });
+
+  it('| should prioritize ENV over NODE_ENV and ENVIRONMENT', () => {
+    process.env.ENV = 'prod';
+    process.env.NODE_ENV = 'dev';
+    process.env.ENVIRONMENT = 'test';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.environment).toBe(DyFM_EnvironmentFlag.prod);
+  });
+
+  it('| should handle lowercase environment values', () => {
+    process.env.ENV = 'prod';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.environment).toBe(DyFM_EnvironmentFlag.prod);
+  });
+
+  it('| should log error and use local for unknown environment', () => {
+    const logSpy = spyOn(DyFM_Log, 'error');
+    process.env.ENV = 'unknown-env';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(logSpy).toHaveBeenCalled();
+    expect(settings.environment).toBe(DyFM_EnvironmentFlag.local);
+  });
+
+  it('| should return discord settings from environment variables', () => {
+    process.env.DISCORD_GUILD_ID = 'guild123';
+    process.env.DISCORD_BOT_TOKEN = 'token123';
+    process.env.DISCORD_BOT_CLIENT_ID = 'client123';
+    process.env.DISCORD_BOT_OAUTH2_URL = 'https://discord.com/oauth2';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.discord.guildId).toBe('guild123');
+    expect(settings.discord.token).toBe('token123');
+    expect(settings.discord.clientId).toBe('client123');
+    expect(settings.discord.oauth2Url).toBe('https://discord.com/oauth2');
+  });
+
+  it('| should return undefined for discord settings when not set', () => {
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.discord.guildId).toBeUndefined();
+    expect(settings.discord.token).toBeUndefined();
+    expect(settings.discord.clientId).toBeUndefined();
+    expect(settings.discord.oauth2Url).toBeUndefined();
+  });
+
+  it('| should return mongoUri from MONGO_URL', () => {
+    process.env.MONGO_URL = 'mongodb://localhost:27017';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.mongoUri).toBe('mongodb://localhost:27017');
+  });
+
+  it('| should return mongoUri from MONGO_URI when MONGO_URL is not set', () => {
+    process.env.MONGO_URI = 'mongodb://localhost:27017';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.mongoUri).toBe('mongodb://localhost:27017');
+  });
+
+  it('| should prioritize MONGO_URL over MONGO_URI', () => {
+    process.env.MONGO_URL = 'mongodb://localhost:27017';
+    process.env.MONGO_URI = 'mongodb://other:27017';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.mongoUri).toBe('mongodb://localhost:27017');
+  });
+
+  it('| should return undefined for mongoUri when not set', () => {
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.mongoUri).toBeUndefined();
+  });
+
+  it('| should return openAi settings from environment variables', () => {
+    process.env.OPENAI_API_KEY = 'api-key-123';
+    process.env.OPENAI_ORGANIZATION = 'org-123';
+    process.env.OPENAI_PROJECT = 'project-123';
+    process.env.OPENAI_TTS_API_KEY = 'tts-key-123';
+
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.openAi.apiKey).toBe('api-key-123');
+    expect(settings.openAi.organization).toBe('org-123');
+    expect(settings.openAi.project).toBe('project-123');
+    expect(settings.openAi.ttsApiKey).toBe('tts-key-123');
+  });
+
+  it('| should return undefined for openAi settings when not set', () => {
+    const settings = DyNTS_getEnvironment_settings();
+
+    expect(settings.openAi.apiKey).toBeUndefined();
+    expect(settings.openAi.organization).toBeUndefined();
+    expect(settings.openAi.project).toBeUndefined();
+    expect(settings.openAi.ttsApiKey).toBeUndefined();
+  });
+
+  it('| should handle dotenv.config() being called', () => {
+    // This test ensures that dotenv.config() is called without errors
+    const settings = DyNTS_getEnvironment_settings();
+    expect(settings).toBeDefined();
+    expect(settings.environment).toBeDefined();
+  });
+
+  it('| should return consistent results on multiple calls', () => {
+    const settings1 = DyNTS_getEnvironment_settings();
+    const settings2 = DyNTS_getEnvironment_settings();
+
+    expect(settings1.environment).toBe(settings2.environment);
+    expect(settings1.discord).toEqual(settings2.discord);
+    expect(settings1.mongoUri).toBe(settings2.mongoUri);
+    expect(settings1.openAi).toEqual(settings2.openAi);
+  });
+
+  it('| should handle mixed case environment variables', () => {
+    process.env.ENV = 'PROD';
+    const settings = DyNTS_getEnvironment_settings();
+    // The function should handle case conversion
+    expect(settings.environment).toBeDefined();
+  });
+});
+

package/src/_collections/star.controller.spec.ts

@@ -0,0 +1,224 @@
+
+import { DyNTS_Star_Controller, DyNTS_getStarRoute } from './star.controller';
+import { DyFM_HttpCallType, DyFM_Error } from '@futdevpro/fsm-dynamo';
+import { DyNTS_RoutingModule } from '../_services/route/routing-module.service';
+
+describe('| DyNTS_Star_Controller', () => {
+  let controller: DyNTS_Star_Controller;
+
+  beforeEach(() => {
+    controller = DyNTS_Star_Controller.getInstance();
+  });
+
+  it('| should be a singleton instance', () => {
+    const instance1 = DyNTS_Star_Controller.getInstance();
+    const instance2 = DyNTS_Star_Controller.getInstance();
+
+    expect(instance1).toBe(instance2);
+    expect(instance1).toBeInstanceOf(DyNTS_Star_Controller);
+  });
+
+  describe('| setupEndpoints', () => {
+    it('| should setup all default endpoints', () => {
+      controller.setupEndpoints();
+
+      expect(controller.endpoints).toBeDefined();
+      expect(controller.endpoints.length).toBe(5);
+    });
+
+    it('| should setup defaultGet endpoint', () => {
+      controller.setupEndpoints();
+
+      const defaultGetEndpoint = controller.endpoints.find(ep => ep.name === 'defaultGet');
+      expect(defaultGetEndpoint).toBeDefined();
+      expect(defaultGetEndpoint?.type).toBe(DyFM_HttpCallType.get);
+      expect(defaultGetEndpoint?.endpoint).toBe('/*');
+      expect((defaultGetEndpoint as any)?.tasks).toBeDefined();
+      expect((defaultGetEndpoint as any)?.tasks?.length).toBe(1);
+    });
+
+    it('| should setup defaultPost endpoint', () => {
+      controller.setupEndpoints();
+
+      const defaultPostEndpoint = controller.endpoints.find(ep => ep.name === 'defaultPost');
+      expect(defaultPostEndpoint).toBeDefined();
+      expect(defaultPostEndpoint?.type).toBe(DyFM_HttpCallType.post);
+      expect(defaultPostEndpoint?.endpoint).toBe('/*');
+      expect((defaultPostEndpoint as any)?.tasks).toBeDefined();
+      expect((defaultPostEndpoint as any)?.tasks?.length).toBe(1);
+    });
+
+    it('| should setup defaultPut endpoint', () => {
+      controller.setupEndpoints();
+
+      const defaultPutEndpoint = controller.endpoints.find(ep => ep.name === 'defaultPut');
+      expect(defaultPutEndpoint).toBeDefined();
+      expect(defaultPutEndpoint?.type).toBe(DyFM_HttpCallType.put);
+      expect(defaultPutEndpoint?.endpoint).toBe('/*');
+      expect((defaultPutEndpoint as any)?.tasks).toBeDefined();
+      expect((defaultPutEndpoint as any)?.tasks?.length).toBe(1);
+    });
+
+    it('| should setup defaultPatch endpoint', () => {
+      controller.setupEndpoints();
+
+      const defaultPatchEndpoint = controller.endpoints.find(ep => ep.name === 'defaultPatch');
+      expect(defaultPatchEndpoint).toBeDefined();
+      expect(defaultPatchEndpoint?.type).toBe(DyFM_HttpCallType.patch);
+      expect(defaultPatchEndpoint?.endpoint).toBe('/*');
+      expect((defaultPatchEndpoint as any)?.tasks).toBeDefined();
+      expect((defaultPatchEndpoint as any)?.tasks?.length).toBe(1);
+    });
+
+    it('| should setup defaultDelete endpoint', () => {
+      controller.setupEndpoints();
+
+      const defaultDeleteEndpoint = controller.endpoints.find(ep => ep.name === 'defaultDelete');
+      expect(defaultDeleteEndpoint).toBeDefined();
+      expect(defaultDeleteEndpoint?.type).toBe(DyFM_HttpCallType.delete);
+      expect(defaultDeleteEndpoint?.endpoint).toBe('/*');
+      expect((defaultDeleteEndpoint as any)?.tasks).toBeDefined();
+      expect((defaultDeleteEndpoint as any)?.tasks?.length).toBe(1);
+    });
+  });
+
+  describe('| DyNTS_getStarRoute', () => {
+    it('| should return routing module', () => {
+      const routingModule = DyNTS_getStarRoute();
+
+      expect(routingModule).toBeInstanceOf(DyNTS_RoutingModule);
+      // The route might be modified by RoutingModule, check if it contains /**
+      expect(routingModule.route).toContain('**');
+      expect((routingModule as any).controllers).toBeDefined();
+      expect((routingModule as any).controllers.length).toBe(1);
+      expect((routingModule as any).controllers[0]).toBeInstanceOf(DyNTS_Star_Controller);
+    });
+
+    it('| should return routing module with correct route', () => {
+      const routingModule = DyNTS_getStarRoute();
+      expect(routingModule.route).toBe('/api/**');
+    });
+  });
+
+  describe('| endpoint tasks', () => {
+    it('| should throw 404 error for defaultGet endpoint', async () => {
+      controller.setupEndpoints();
+      const defaultGetEndpoint = controller.endpoints.find(ep => ep.name === 'defaultGet');
+      expect(defaultGetEndpoint).toBeDefined();
+
+      const mockReq = {
+        originalUrl: '/test-route',
+      } as any;
+      const mockRes = {} as any;
+
+      try {
+        await (defaultGetEndpoint as any).tasks[0](mockReq, mockRes, 'test-issuer');
+        fail('Should have thrown an error');
+      } catch (error) {
+        expect(error).toBeInstanceOf(DyFM_Error);
+        expect((error as DyFM_Error).___status).toBe(404);
+        expect((error as DyFM_Error)._errorCode).toContain('DyNTS-RMS-G404');
+      }
+    });
+
+    it('| should throw 404 error for defaultPost endpoint', async () => {
+      controller.setupEndpoints();
+      const defaultPostEndpoint = controller.endpoints.find(ep => ep.name === 'defaultPost');
+      expect(defaultPostEndpoint).toBeDefined();
+
+      const mockReq = {
+        originalUrl: '/test-route',
+      } as any;
+      const mockRes = {} as any;
+
+      try {
+        await (defaultPostEndpoint as any).tasks[0](mockReq, mockRes, 'test-issuer');
+        fail('Should have thrown an error');
+      } catch (error) {
+        expect(error).toBeInstanceOf(DyFM_Error);
+        expect((error as DyFM_Error).___status).toBe(404);
+        expect((error as DyFM_Error)._errorCode).toContain('DyNTS-RMS-PO404');
+      }
+    });
+
+    it('| should throw 404 error for defaultPut endpoint', async () => {
+      controller.setupEndpoints();
+      const defaultPutEndpoint = controller.endpoints.find(ep => ep.name === 'defaultPut');
+      expect(defaultPutEndpoint).toBeDefined();
+
+      const mockReq = {
+        originalUrl: '/test-route',
+      } as any;
+      const mockRes = {} as any;
+
+      try {
+        await (defaultPutEndpoint as any).tasks[0](mockReq, mockRes, 'test-issuer');
+        fail('Should have thrown an error');
+      } catch (error) {
+        expect(error).toBeInstanceOf(DyFM_Error);
+        expect((error as DyFM_Error).___status).toBe(404);
+        expect((error as DyFM_Error)._errorCode).toContain('DyNTS-RMS-PU404');
+      }
+    });
+
+    it('| should throw 404 error for defaultPatch endpoint', async () => {
+      controller.setupEndpoints();
+      const defaultPatchEndpoint = controller.endpoints.find(ep => ep.name === 'defaultPatch');
+      expect(defaultPatchEndpoint).toBeDefined();
+
+      const mockReq = {
+        originalUrl: '/test-route',
+      } as any;
+      const mockRes = {} as any;
+
+      try {
+        await (defaultPatchEndpoint as any).tasks[0](mockReq, mockRes, 'test-issuer');
+        fail('Should have thrown an error');
+      } catch (error) {
+        expect(error).toBeInstanceOf(DyFM_Error);
+        expect((error as DyFM_Error).___status).toBe(404);
+        expect((error as DyFM_Error)._errorCode).toContain('DyNTS-RMS-PA404');
+      }
+    });
+
+    it('| should throw 404 error for defaultDelete endpoint', async () => {
+      controller.setupEndpoints();
+      const defaultDeleteEndpoint = controller.endpoints.find(ep => ep.name === 'defaultDelete');
+      expect(defaultDeleteEndpoint).toBeDefined();
+
+      const mockReq = {
+        originalUrl: '/test-route',
+      } as any;
+      const mockRes = {} as any;
+
+      try {
+        await (defaultDeleteEndpoint as any).tasks[0](mockReq, mockRes, 'test-issuer');
+        fail('Should have thrown an error');
+      } catch (error) {
+        expect(error).toBeInstanceOf(DyFM_Error);
+        expect((error as DyFM_Error).___status).toBe(404);
+        expect((error as DyFM_Error)._errorCode).toContain('DyNTS-RMS-D404');
+      }
+    });
+
+    it('| should include originalUrl in error message', async () => {
+      controller.setupEndpoints();
+      const defaultGetEndpoint = controller.endpoints.find(ep => ep.name === 'defaultGet');
+      expect(defaultGetEndpoint).toBeDefined();
+
+      const mockReq = {
+        originalUrl: '/custom-route',
+      } as any;
+      const mockRes = {} as any;
+
+      try {
+        await (defaultGetEndpoint as any).tasks[0](mockReq, mockRes, 'test-issuer');
+        fail('Should have thrown an error');
+      } catch (error) {
+        expect(error).toBeInstanceOf(DyFM_Error);
+        expect((error as DyFM_Error)._message).toContain('/custom-route');
+      }
+    });
+  });
+});
+

package/src/_models/control-models/api-call-params.control-model.spec.ts

@@ -46,7 +46,7 @@ describe('| DyNTS_ApiCall_Params', () => {
     expect(params.httpOptions).toEqual(httpOptions);
   });
 
-  xit('should replace deprecated endpoint parameter braces', () => {
+  it('| should replace deprecated endpoint parameter braces', () => {
     spyOn(DyFM_Log, 'warn');
 
     const params = new DyNTS_ApiCall_Params({
@@ -57,11 +57,70 @@ describe('| DyNTS_ApiCall_Params', () => {
     });
 
     expect(DyFM_Log.warn).toHaveBeenCalledWith(
-      'using {param} bracets in endpoint definitions will be deprecated... (/test/{param}/endpoint)' +
-      'use :param instead ({pathparam} --> :pathparam)'
+      'WARNING: using {param} bracets in endpoint definitions will be deprecated... (/test/{param}/endpoint)' +
+      '\n  use :param instead ({pathparam} --> :pathparam)'
     );
     expect(params.endpoint).toBe('/test/:param/endpoint');
   });
+
+  it('| should extract pathParamKeys from endpoint with colons', () => {
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/:userId/:itemId',
+      baseUrl: 'https://example.com/api',
+    });
+
+    expect(params.pathParamKeys).toEqual(['userId', 'itemId']);
+  });
+
+  it('| should handle endpoint without path parameters', () => {
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/endpoint',
+      baseUrl: 'https://example.com/api',
+    });
+
+    expect(params.pathParamKeys).toEqual([]);
+  });
+
+  it('| should use global baseUrl when baseUrl is not provided', () => {
+    spyOn(DyFM_Log, 'error');
+
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/endpoint',
+    } as any);
+
+    expect(DyFM_Log.error).toHaveBeenCalled();
+    expect(params.baseUrl).toBeDefined();
+  });
+
+  it('| should handle missing endpoint', () => {
+    spyOn(DyFM_Log, 'warn');
+
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      baseUrl: 'https://example.com/api',
+    } as any);
+
+    expect(DyFM_Log.warn).toHaveBeenCalled();
+    expect(params.endpoint).toBe('');
+  });
+
+  it('| should throw error when endpoint is invalid', () => {
+    expect(() => {
+      new DyNTS_ApiCall_Params({
+        name: 'testCall',
+        type: DyFM_HttpCallType.get,
+        endpoint: { includes: false } as any,
+        baseUrl: 'https://example.com/api',
+      });
+    }).toThrowError(/DyNTS_ApiCall_Params Error: something went wrong with the endpoint, it is provided but not valid/);
+  });
 });
 
 describe('| DyNTS_HttpOptions', () => {

package/src/_models/control-models/app-ext-system-controls.control-model.spec.ts

@@ -0,0 +1,52 @@
+
+import { DyNTS_AppExtSysControls } from './app-ext-system-controls.control-model';
+import { DyNTS_SystemControl } from './system-control.control-model';
+
+describe('| DyNTS_AppExtSysControls', () => {
+  let appExtSysControls: DyNTS_AppExtSysControls;
+
+  beforeEach(() => {
+    appExtSysControls = new DyNTS_AppExtSysControls();
+  });
+
+  it('| should create an instance of DyNTS_AppExtSysControls', () => {
+    expect(appExtSysControls).toBeTruthy();
+  });
+
+  it('| should initialize "appExtended" as an instance of DyNTS_SystemControl', () => {
+    expect(appExtSysControls.appExtended).toBeInstanceOf(DyNTS_SystemControl);
+  });
+
+  it('| should initialize "httpSocketServer" as an instance of DyNTS_SystemControl', () => {
+    expect(appExtSysControls.httpSocketServer).toBeInstanceOf(DyNTS_SystemControl);
+  });
+
+  it('| should initialize "httpsSocketServer" as an instance of DyNTS_SystemControl', () => {
+    expect(appExtSysControls.httpsSocketServer).toBeInstanceOf(DyNTS_SystemControl);
+  });
+
+  it('| should have independent SystemControl instances', () => {
+    expect(appExtSysControls.appExtended).not.toBe(appExtSysControls.httpSocketServer);
+    expect(appExtSysControls.appExtended).not.toBe(appExtSysControls.httpsSocketServer);
+    expect(appExtSysControls.httpSocketServer).not.toBe(appExtSysControls.httpsSocketServer);
+  });
+
+  it('| should allow setting init and started on appExtended', () => {
+    appExtSysControls.appExtended.init = true;
+    appExtSysControls.appExtended.started = true;
+    expect(appExtSysControls.appExtended.getIsReady()).toBeTrue();
+  });
+
+  it('| should allow setting init and started on httpSocketServer', () => {
+    appExtSysControls.httpSocketServer.init = true;
+    appExtSysControls.httpSocketServer.started = false;
+    expect(appExtSysControls.httpSocketServer.getIsReady()).toBeFalse();
+  });
+
+  it('| should allow setting init and started on httpsSocketServer', () => {
+    appExtSysControls.httpsSocketServer.init = true;
+    appExtSysControls.httpsSocketServer.started = true;
+    expect(appExtSysControls.httpsSocketServer.getIsReady()).toBeTrue();
+  });
+});
+