@futdevpro/nts-dynamo 1.15.157 → 1.15.160

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

@@ -1,229 +0,0 @@
-
-import { DyFM_EnvironmentFlag, DyFM_Log } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-
-import { DyNTS_App_Params } from './app-params.control-model';
-
-describe('| DyNTS_App_Params', () => {
-  let originalEnv: any;
-
-  // Ensure env_settings exists before tests
-  beforeAll(() => {
-    if (!DyNTS_global_settings.env_settings) {
-      (DyNTS_global_settings as any).env_settings = {
-        environment: DyFM_EnvironmentFlag.local,
-        discord: {},
-        mongoUri: undefined,
-        openAi: {},
-      };
-    }
-  });
-
-  beforeEach(() => {
-    originalEnv = DyNTS_global_settings.env_settings?.environment;
-    DyNTS_global_settings.env_settings.environment = DyFM_EnvironmentFlag.local;
-  });
-
-  afterEach(() => {
-    if (DyNTS_global_settings.env_settings) {
-      DyNTS_global_settings.env_settings.environment = originalEnv;
-    }
-  });
-  it('| should initialize with provided values', () => {
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      title: 'Test Application',
-      version: '1.0.0',
-      dbName: 'testdb',
-      dbUri: 'mongodb://0.0.0.0:29017/testdb',
-      systemName: 'Test-App',
-      systemShortCodeName: 'TA'
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.name).toBe('TestApp');
-    expect(appParams.title).toBe('Test Application');
-    expect(appParams.version).toBe('1.0.0');
-    expect(appParams.dbName).toBe('testdb');
-    expect(appParams.dbUri).toBe('mongodb://0.0.0.0:29017/testdb');
-    expect(appParams.systemName).toBe('Test-App');
-    expect(appParams.systemShortCodeName).toBe('TA_LOCAL');
-  });
-
-  it('| should set default values when optional parameters are not provided', () => {
-    (DyNTS_global_settings.env_settings as any).mongoUri = undefined;
-
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'testdb',
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.name).toBe('TestApp');
-    expect(appParams.title).toBe('');
-    expect(appParams.version).toBe('1.0.0');
-    expect(appParams.dbName).toBe('testdb');
-    expect(appParams.dbUri).toBe('mongodb://0.0.0.0:27017/testdb');
-    expect(appParams.systemName).toBe('TestApp');
-    expect(appParams.systemShortCodeName).toBe('TA_LOCAL');
-  });
-
-  it('| should generate systemShortCodeName from systemName if not provided', () => {
-    const params: DyNTS_App_Params = {
-      name: 'Test Application',
-      version: '1.0.0',
-      dbName: 'testdb',
-      systemName: 'Test-App',
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.systemShortCodeName).toBe('TA_LOCAL');
-  });
-
-  it('| should generate systemName from name if not provided', () => {
-    const params: DyNTS_App_Params = {
-      name: 'Test Application',
-      version: '1.0.0',
-      dbName: 'testdb'
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.systemName).toBe('Test-Application');
-  });
-
-  it('| should generate dbUri from global mongoUri when dbUri is not provided', () => {
-    // This test assumes global settings have mongoUri set
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'testdb',
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.dbUri).toBeDefined();
-    expect(appParams.dbName).toBe('testdb');
-  });
-
-  it('| should use provided dbUri when set', () => {
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'testdb',
-      dbUri: 'mongodb://custom:27017/testdb',
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.dbUri).toBe('mongodb://custom:27017/testdb');
-  });
-
-  it('| should set default dbOptions when not provided', () => {
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'testdb',
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.dbOptions).toBeDefined();
-    expect(appParams.dbOptions?.directConnection).toBe(true);
-  });
-
-  it('| should use provided dbOptions', () => {
-    const customOptions = {
-      directConnection: false,
-      maxPoolSize: 10,
-    };
-
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'testdb',
-      dbOptions: customOptions,
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.dbOptions).toEqual(customOptions);
-  });
-
-  it('| should set default openHost and secureHost', () => {
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'testdb',
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.openHost).toBe('0.0.0.0');
-    expect(appParams.secureHost).toBe('0.0.0.0');
-  });
-
-  it('| should set default expressBacklog', () => {
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'testdb',
-    };
-
-    const appParams = new DyNTS_App_Params(params);
-
-    expect(appParams.expressBacklog).toBe(0);
-  });
-
-  it('| should log error when dbName is not set', () => {
-    const { DyFM_Log } = require('@futdevpro/fsm-dynamo');
-    const logSpy = spyOn(DyFM_Log, 'error');
-
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-    } as any;
-
-    new DyNTS_App_Params(params);
-
-    expect(logSpy).toHaveBeenCalled();
-  });
-
-  it('| should log warning when dbName contains uppercase letters', () => {
-    const { DyFM_Log } = require('@futdevpro/fsm-dynamo');
-    const logSpy = spyOn(DyFM_Log, 'warn');
-
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'TestDB',
-    };
-
-    new DyNTS_App_Params(params);
-
-    expect(logSpy).toHaveBeenCalled();
-  });
-
-  it('| should warn without logging a malformed credential-bearing dbUri', () => {
-    const logSpy = spyOn(DyFM_Log, 'warn');
-    const canary: string = 'mongodb://canary-user:canary-secret@localhost:27017//testdb';
-
-    const params: DyNTS_App_Params = {
-      name: 'TestApp',
-      version: '1.0.0',
-      dbName: 'testdb',
-      dbUri: canary,
-    };
-
-    new DyNTS_App_Params(params);
-
-    expect(logSpy).toHaveBeenCalled();
-    expect(JSON.stringify(logSpy.calls.allArgs())).not.toContain(canary);
-    expect(JSON.stringify(logSpy.calls.allArgs())).not.toContain('canary-secret');
-  });
-});

package/src/_models/control-models/app-params.control-model.ts

@@ -1,137 +0,0 @@
-import { ConnectOptions } from 'mongoose';
-
-import { DyFM_Log, DyFM_String } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-
-/**
- * This will hold and set the basic settings of an application
- */
-export class DyNTS_App_Params {
-  /**
-   * name of the application
-   */
-  readonly name: string;
-  /**
-   * title will be shown on the start of the application
-   */
-  readonly title?: string;
-  /**
-   * version of the application
-   * you should set the version,
-   * probably, you should set from the package.json as follows:
-   * import { version } from '../package.json';
-   */
-  readonly version: string;
-
-  /**
-   * name of your MongoDB table
-   * by default, its: `mongodb://localhost:27017/${this.dbName}`
-   */
-  readonly dbUri?: string;
-  /**
-   * name of your MongoDB table
-   */
-  readonly dbName?: string;
-  /**
-   * options for the MongoDB connection
-   */
-  readonly dbOptions?: ConnectOptions;
-
-  readonly openHost?: string;
-  readonly secureHost?: string;
-  /** 
-   * specify the maximum
-   * length of the queue of pending connections. 
-   * The actual length will be determined by the OS through sysctl.
-   * */
-  readonly expressBacklog?: number;
-
-  /**
-   * name of the system, by default, its: this.name.replace(' ', '-')
-   */
-  readonly systemName?: string;
-  /**
-   * short code name of the system
-   */
-  readonly systemShortCodeName?: string;
-  //readonly dontUseEnvInSystemShortCodeName?: boolean;
-
-  constructor(
-    set: DyNTS_App_Params
-  ) {
-    this.name = set.name;
-    this.title = set.title ?? '';
-    this.version = set.version;
-    if (DyNTS_global_settings.systemVersion === 'unknown-version') {
-      DyNTS_global_settings.systemVersion = this.version;
-    }
-
-    if (set.dbName || set.dbUri || set.dbOptions) {
-      this.dbName = set.dbName;
-
-      if (!set.dbUri) {
-        if (DyNTS_global_settings.env_settings.mongoUri) {
-          if (set.dbName) {
-            this.dbUri = `${DyNTS_global_settings.env_settings.mongoUri}/${set.dbName}`;
-          } else {
-            this.dbUri = DyNTS_global_settings.env_settings.mongoUri;
-          }
-        } else {
-          this.dbUri = `mongodb://0.0.0.0:27017/${set.dbName}`;
-        }
-      } else {
-        this.dbUri = set.dbUri;
-      }
-
-      if (this.dbUri.split('//').length > 2) {
-        DyFM_Log.warn(
-          'DyNTS_App_Params.constructor: dbUri should not contain more than one "//".'
-        );
-      }
-
-      this.dbOptions = set.dbOptions ?? {
-        directConnection: true,
-      };
-    }
-    
-    this.systemName = set.systemName ?? this.name.replace(' ', '-');
-    DyNTS_global_settings.systemName ??= this.systemName;
-
-    let sysShortCodeName: string;
-    sysShortCodeName = set.systemShortCodeName ?? DyFM_String.anyNameToShortCode(this.systemName);
-    //if (!set.dontUseEnvInSystemShortCodeName) {
-    sysShortCodeName += '_' + DyNTS_global_settings.env_settings.environment.toUpperCase();
-    //}
-    this.systemShortCodeName = sysShortCodeName;
-    DyNTS_global_settings.systemShortCodeName ??= this.systemShortCodeName;
-
-    this.openHost = set.openHost ?? '0.0.0.0';
-    this.secureHost = set.secureHost ?? '0.0.0.0';
-    this.expressBacklog = set.expressBacklog ?? 0;
-
-    if (!this.dbName) {
-      DyFM_Log.error(
-        'DyNTS_App_Params.constructor: ' +
-        `dbName is not set in "${this.name}" model.` +
-        'For future compatibility.'
-      );
-    }
-    
-    if (RegExp(/[A-Z]/).exec(this.dbName)) {
-      DyFM_Log.warn(
-        'DyNTS_App_Params.constructor: ' +
-        `dbName should be in snake_case in "${this.dbName}" model.` +
-        'For future compatibility.'
-      );
-    }
-
-    /* if (this.dbName?.includes('-')) {
-      DyFM_Log.warn(
-        'DyNTS_App_Params.constructor: ' +
-        `dbName should not contain "-" in "${this.dbName}" model.` +
-        'For future compatibility.'
-      );
-    } */
-  }
-}

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

@@ -1,31 +0,0 @@
-
-import { DyNTS_AppSystemControls } from './app-system-controls.control-model';
-import { DyNTS_SystemControl } from './system-control.control-model';
-
-describe('| DyNTS_AppSystemControls', () => {
-  let appSystemControls: DyNTS_AppSystemControls;
-
-  beforeEach(() => {
-    appSystemControls = new DyNTS_AppSystemControls();
-  });
-
-  it('| should create an instance of DyNTS_AppSystemControls', () => {
-    expect(appSystemControls).toBeTruthy();
-  });
-
-  it('| should initialize "app" as an instance of DyNTS_SystemControl', () => {
-    expect(appSystemControls.app).toBeInstanceOf(DyNTS_SystemControl);
-  });
-
-  it('| should initialize "mongoose" as an instance of DyNTS_SystemControl', () => {
-    expect(appSystemControls.mongoose).toBeInstanceOf(DyNTS_SystemControl);
-  });
-
-  it('| should initialize "httpServer" as an instance of DyNTS_SystemControl', () => {
-    expect(appSystemControls.httpServer).toBeInstanceOf(DyNTS_SystemControl);
-  });
-
-  it('| should initialize "httpsServer" as an instance of DyNTS_SystemControl', () => {
-    expect(appSystemControls.httpsServer).toBeInstanceOf(DyNTS_SystemControl);
-  });
-});

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

@@ -1,9 +0,0 @@
-
-import { DyNTS_SystemControl } from './system-control.control-model';
-
-export class DyNTS_AppSystemControls {
-  app: DyNTS_SystemControl = new DyNTS_SystemControl();
-  mongoose: DyNTS_SystemControl = new DyNTS_SystemControl();
-  httpServer: DyNTS_SystemControl = new DyNTS_SystemControl();
-  httpsServer: DyNTS_SystemControl = new DyNTS_SystemControl();  
-}