@futdevpro/nts-dynamo 1.15.127 → 1.15.128

package/src/_services/base/singleton.service-base.spec.ts

@@ -1,28 +1,28 @@
-
-import { DyNTS_SingletonServiceBase } from './singleton.service-base';
-
-class TestSingletonService extends DyNTS_SingletonServiceBase {
-  static getInstance(): TestSingletonService {
-    return TestSingletonService.getSingletonInstance();
-  }
-}
-
-describe('| DyNTS_SingletonServiceBase', () => {
-  it('| should return the same instance on multiple calls', () => {
-    const instance1 = TestSingletonService.getInstance();
-    const instance2 = TestSingletonService.getInstance();
-
-    expect(instance1).toBe(instance2);
-    expect(instance1).toBeInstanceOf(TestSingletonService);
-  });
-
-  it('| should create instance only once', () => {
-    const instance1 = TestSingletonService.getInstance();
-    const instance2 = TestSingletonService.getInstance();
-    const instance3 = TestSingletonService.getInstance();
-
-    expect(instance1).toBe(instance2);
-    expect(instance2).toBe(instance3);
-  });
-});
-
+
+import { DyNTS_SingletonServiceBase } from './singleton.service-base';
+
+class TestSingletonService extends DyNTS_SingletonServiceBase {
+  static getInstance(): TestSingletonService {
+    return TestSingletonService.getSingletonInstance();
+  }
+}
+
+describe('| DyNTS_SingletonServiceBase', () => {
+  it('| should return the same instance on multiple calls', () => {
+    const instance1 = TestSingletonService.getInstance();
+    const instance2 = TestSingletonService.getInstance();
+
+    expect(instance1).toBe(instance2);
+    expect(instance1).toBeInstanceOf(TestSingletonService);
+  });
+
+  it('| should create instance only once', () => {
+    const instance1 = TestSingletonService.getInstance();
+    const instance2 = TestSingletonService.getInstance();
+    const instance3 = TestSingletonService.getInstance();
+
+    expect(instance1).toBe(instance2);
+    expect(instance2).toBe(instance3);
+  });
+});
+

package/src/_services/base/singleton.service-base.ts

@@ -1,24 +1,24 @@
-
-
-/**
- * 
- */
-export class DyNTS_SingletonServiceBase {
-
-  /// ---     ---     ---     SINGLETON     ---     ---     --- \\\
-  protected static instance;
-  
-  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-  protected static getSingletonInstance() {
-    if (!this.instance) {
-      this.instance = new this();
-    }
-
-    return this.instance;
-  }
-  /// ---     ---     ---     SINGLETON     ---     ---     --- ///
-  
-  // SINGLETON services are using private constructor  
-  protected constructor() {}
-  
-}
+
+
+/**
+ * 
+ */
+export class DyNTS_SingletonServiceBase {
+
+  /// ---     ---     ---     SINGLETON     ---     ---     --- \\\
+  protected static instance;
+  
+  // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+  protected static getSingletonInstance() {
+    if (!this.instance) {
+      this.instance = new this();
+    }
+
+    return this.instance;
+  }
+  /// ---     ---     ---     SINGLETON     ---     ---     --- ///
+  
+  // SINGLETON services are using private constructor  
+  protected constructor() {}
+  
+}

package/src/_services/base/singleton.service.spec.ts

@@ -1,114 +1,114 @@
-
-import { DyNTS_SingletonService } from './singleton.service';
-import { DyFM_Error, DyFM_Error_Settings } from '@futdevpro/fsm-dynamo';
-import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-
-class TestSingletonService extends DyNTS_SingletonService {
-  static getInstance(): TestSingletonService {
-    return TestSingletonService.getSingletonInstance();
-  }
-}
-
-describe('| DyNTS_SingletonService', () => {
-  let service: TestSingletonService;
-
-  beforeEach(() => {
-    service = TestSingletonService.getInstance();
-  });
-
-  it('| should be a singleton instance', () => {
-    const instance1 = TestSingletonService.getInstance();
-    const instance2 = TestSingletonService.getInstance();
-
-    expect(instance1).toBe(instance2);
-    expect(instance1).toBeInstanceOf(TestSingletonService);
-  });
-
-  it('| should have default error user message', () => {
-    expect(service.defaultErrorUserMsg).toBeDefined();
-    expect(service.defaultErrorUserMsg).toContain('Control Service Error');
-  });
-
-  describe('| getDefaultErrorSettings', () => {
-    it('| should return error settings with default values', () => {
-      const error = new Error('Test error');
-      const issuer = 'issuer-123';
-
-      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
-
-      expect(result).toBeDefined();
-      expect(result.message).toBe('Test error');
-      // useMessageAsUserMessage defaults to true, so userMessage will be error.message
-      expect(result.userMessage).toBe('Test error');
-      expect(result.issuer).toBe(issuer);
-      expect(result.issuerService).toBe('TestSingletonService');
-      expect(result.systemVersion).toBe(DyNTS_global_settings.systemVersion);
-      expect(result.error).toBe(error);
-    });
-
-    it('| should use DyFM_Error status when available', () => {
-      const error = new DyFM_Error({
-        status: 404,
-        message: 'Not found',
-      });
-      const issuer = 'issuer-123';
-
-      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
-
-      expect(result.status).toBe(404);
-    });
-
-    it('| should use default status when error is not DyFM_Error', () => {
-      const error = new Error('Test error');
-      const issuer = 'issuer-123';
-
-      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
-
-      expect(result.status).toBe(500);
-    });
-
-    it('| should use error message when available', () => {
-      const error = new Error('Test error message');
-      const issuer = 'issuer-123';
-
-      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
-
-      expect(result.message).toBe('Test error message');
-    });
-
-    it('| should use default message when error message is not available', () => {
-      const error = {} as Error;
-      const issuer = 'issuer-123';
-
-      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
-
-      expect(result.message).toContain('testFunction was UNSUCCESSFUL');
-    });
-
-    it('| should use DyFM_Error user message when available', () => {
-      const error = new DyFM_Error({
-        message: 'Test error',
-        userMessage: 'Custom user message',
-      });
-      const issuer = 'issuer-123';
-
-      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
-
-      expect(result.userMessage).toBe('Custom user message');
-      expect(result.addECToUserMsg).toBe(false);
-    });
-
-    it('| should use default user message when DyFM_Error user message is not available', () => {
-      const error = new DyFM_Error({
-        message: 'Test error',
-      });
-      const issuer = 'issuer-123';
-
-      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer, false);
-
-      expect(result.userMessage).toBe(service.defaultErrorUserMsg);
-      expect(result.addECToUserMsg).toBe(true);
-    });
-  });
-});
-
+
+import { DyNTS_SingletonService } from './singleton.service';
+import { DyFM_Error, DyFM_Error_Settings } from '@futdevpro/fsm-dynamo';
+import { DyNTS_global_settings } from '../../_collections/global-settings.const';
+
+class TestSingletonService extends DyNTS_SingletonService {
+  static getInstance(): TestSingletonService {
+    return TestSingletonService.getSingletonInstance();
+  }
+}
+
+describe('| DyNTS_SingletonService', () => {
+  let service: TestSingletonService;
+
+  beforeEach(() => {
+    service = TestSingletonService.getInstance();
+  });
+
+  it('| should be a singleton instance', () => {
+    const instance1 = TestSingletonService.getInstance();
+    const instance2 = TestSingletonService.getInstance();
+
+    expect(instance1).toBe(instance2);
+    expect(instance1).toBeInstanceOf(TestSingletonService);
+  });
+
+  it('| should have default error user message', () => {
+    expect(service.defaultErrorUserMsg).toBeDefined();
+    expect(service.defaultErrorUserMsg).toContain('Control Service Error');
+  });
+
+  describe('| getDefaultErrorSettings', () => {
+    it('| should return error settings with default values', () => {
+      const error = new Error('Test error');
+      const issuer = 'issuer-123';
+
+      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
+
+      expect(result).toBeDefined();
+      expect(result.message).toBe('Test error');
+      // useMessageAsUserMessage defaults to true, so userMessage will be error.message
+      expect(result.userMessage).toBe('Test error');
+      expect(result.issuer).toBe(issuer);
+      expect(result.issuerService).toBe('TestSingletonService');
+      expect(result.systemVersion).toBe(DyNTS_global_settings.systemVersion);
+      expect(result.error).toBe(error);
+    });
+
+    it('| should use DyFM_Error status when available', () => {
+      const error = new DyFM_Error({
+        status: 404,
+        message: 'Not found',
+      });
+      const issuer = 'issuer-123';
+
+      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
+
+      expect(result.status).toBe(404);
+    });
+
+    it('| should use default status when error is not DyFM_Error', () => {
+      const error = new Error('Test error');
+      const issuer = 'issuer-123';
+
+      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
+
+      expect(result.status).toBe(500);
+    });
+
+    it('| should use error message when available', () => {
+      const error = new Error('Test error message');
+      const issuer = 'issuer-123';
+
+      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
+
+      expect(result.message).toBe('Test error message');
+    });
+
+    it('| should use default message when error message is not available', () => {
+      const error = {} as Error;
+      const issuer = 'issuer-123';
+
+      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
+
+      expect(result.message).toContain('testFunction was UNSUCCESSFUL');
+    });
+
+    it('| should use DyFM_Error user message when available', () => {
+      const error = new DyFM_Error({
+        message: 'Test error',
+        userMessage: 'Custom user message',
+      });
+      const issuer = 'issuer-123';
+
+      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer);
+
+      expect(result.userMessage).toBe('Custom user message');
+      expect(result.addECToUserMsg).toBe(false);
+    });
+
+    it('| should use default user message when DyFM_Error user message is not available', () => {
+      const error = new DyFM_Error({
+        message: 'Test error',
+      });
+      const issuer = 'issuer-123';
+
+      const result = (service as any).getDefaultErrorSettings('testFunction', error, issuer, false);
+
+      expect(result.userMessage).toBe(service.defaultErrorUserMsg);
+      expect(result.addECToUserMsg).toBe(true);
+    });
+  });
+});
+

package/src/_services/base/singleton.service.ts

@@ -1,38 +1,38 @@
-import { DyFM_AnyError, DyFM_Error, DyFM_Error_Settings } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-import { DyNTS_SingletonServiceBase } from './singleton.service-base';
-
-/**
- * 
- */
-export class DyNTS_SingletonService extends DyNTS_SingletonServiceBase {
-  
-  readonly defaultErrorUserMsg: string = 
-    `We encountered an unhandled Control Service Error, ` +
-    `\nplease contact the responsible development team.`; 
-  
-  protected getDefaultErrorSettings(
-    fnName: string, 
-    error: DyFM_AnyError,
-    issuer: string,
-    /** @deprecated we wont support the separate user message in the future, use the message instead */
-    useMessageAsUserMessage: boolean = true,
-    /* errorCode: string, */
-  ): DyFM_Error_Settings {
-    return {
-      status: (error as DyFM_Error)?.___status ?? 500,
-      message: (error as Error)?.message ??
-        (error as DyFM_Error)?._message ??
-        `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
-      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
-      userMessage: (error as DyFM_Error)?.__userMessage ?? 
-        (useMessageAsUserMessage ? (error as Error)?.message : this.defaultErrorUserMsg),
-      /* errorCode: errorCode, */
-      issuer: issuer,
-      issuerService: this.constructor?.name,
-      systemVersion: DyNTS_global_settings.systemVersion,
-      error: error,
-    };
-  }
-}
+import { DyFM_AnyError, DyFM_Error, DyFM_Error_Settings } from '@futdevpro/fsm-dynamo';
+
+import { DyNTS_global_settings } from '../../_collections/global-settings.const';
+import { DyNTS_SingletonServiceBase } from './singleton.service-base';
+
+/**
+ * 
+ */
+export class DyNTS_SingletonService extends DyNTS_SingletonServiceBase {
+  
+  readonly defaultErrorUserMsg: string = 
+    `We encountered an unhandled Control Service Error, ` +
+    `\nplease contact the responsible development team.`; 
+  
+  protected getDefaultErrorSettings(
+    fnName: string, 
+    error: DyFM_AnyError,
+    issuer: string,
+    /** @deprecated we wont support the separate user message in the future, use the message instead */
+    useMessageAsUserMessage: boolean = true,
+    /* errorCode: string, */
+  ): DyFM_Error_Settings {
+    return {
+      status: (error as DyFM_Error)?.___status ?? 500,
+      message: (error as Error)?.message ??
+        (error as DyFM_Error)?._message ??
+        `${fnName} was UNSUCCESSFUL (${DyNTS_global_settings.systemShortCodeName})`,
+      addECToUserMsg: !(error as DyFM_Error)?.__userMessage,
+      userMessage: (error as DyFM_Error)?.__userMessage ?? 
+        (useMessageAsUserMessage ? (error as Error)?.message : this.defaultErrorUserMsg),
+      /* errorCode: errorCode, */
+      issuer: issuer,
+      issuerService: this.constructor?.name,
+      systemVersion: DyNTS_global_settings.systemVersion,
+      error: error,
+    };
+  }
+}