@breautek/storm 6.0.1 → 6.0.3

package/src/Application.ts

@@ -32,7 +32,8 @@ import * as http from 'http';
 import { IAuthTokenData } from '@arashi/token';
 import {
     Logger,
-    CloudWatchStream
+    CloudWatchStream,
+    BaseLogger
 } from '@arashi/logger';
 import { StormError } from './StormError';
 
@@ -49,7 +50,7 @@ export abstract class Application
         TDBConnectionAPI = any
     >
     extends EventEmitter {
-    private $logger: Logger;
+    private $logger: BaseLogger;
     private $name: string;
     private $configPath: string;
     private $config: TConfig;
@@ -161,9 +162,13 @@ export abstract class Application
     protected _initialize(config: TConfig): Promise<void> {
         return Promise.resolve();
     }
+
+    protected _createLogger(config: TConfig): BaseLogger {
+        return new Logger(this.getName(), config.log?.level);
+    }
     
-    protected _initLogger(config: TConfig): Logger {
-        let logger: Logger = new Logger(this.getName(), config.log?.level);
+    protected _initLogger(config: TConfig): BaseLogger {
+        let logger: BaseLogger = this._createLogger(config);
 
         if (config?.log?.cloudwatch) {
             let cwConfig: ICloudwatchConfig = config.log.cloudwatch;
@@ -179,7 +184,7 @@ export abstract class Application
         return logger;
     }
 
-    private $connectCW(logger: Logger, cwConfig: ICloudwatchConfig): void {
+    private $connectCW(logger: BaseLogger, cwConfig: ICloudwatchConfig): void {
         logger.pipe(new CloudWatchStream({
             region: cwConfig.region,
             credentials: {
@@ -226,7 +231,7 @@ export abstract class Application
         return null;
     }
 
-    public getLogger(): Logger {
+    public getLogger(): BaseLogger {
         return this.$logger;
     }
 
@@ -362,7 +367,7 @@ export abstract class Application
         return this.$name;
     }
 
-    private $getLogger(): Logger {
+    private $getLogger(): BaseLogger {
         return this.$logger;
     }
 

package/src/BackendAuthenticationMiddleware.ts

@@ -17,7 +17,7 @@
 import {StatusCode} from './StatusCode';
 import {Request} from './Request';
 import {ResponseData} from './ResponseData';
-import {Logger} from '@arashi/logger';
+import {BaseLogger} from '@arashi/logger';
 import {getInstance} from './instance';
 import {IConfig} from './IConfig';
 
@@ -30,7 +30,7 @@ const TAG: string = 'BackendAuthenticationMiddleware';
  * for their specific use cases.
  */
 export class BackendAuthenticationMiddleware {
-    private $logger: Logger;
+    private $logger: BaseLogger;
 
     public constructor() {
         this.$logger = getInstance().getLogger();

package/src/ConfigLoader.ts

@@ -138,7 +138,29 @@ export class ConfigLoader {
                                 null
                             ]
                         },
-                        directory: { type: [ 'string', 'null' ] },
+                        cloudwatch: {
+                            type: [ 'object', 'null' ],
+                            additionalProperties: false,
+                            properties: {
+                                region: { type: 'string' },
+                                credentials: {
+                                    type: 'object',
+                                    additionalProperties: false,
+                                    properties: {
+                                        accessKeyId: { type: 'string' },
+                                        secretAccessKey: { type: 'string' }
+                                    }
+                                },
+                                stream: {
+                                    type: 'object',
+                                    additionalProperties: false,
+                                    properties: {
+                                        group: { type: 'string' },
+                                        name: { type: 'string' }
+                                    }
+                                }
+                            }
+                        },
                         filters: {
                             type: [ 'array', 'null' ],
                             items: { type: 'string' }

package/src/Handler.ts

@@ -23,12 +23,11 @@ import {StormError} from './StormError';
 import {IConfig} from './IConfig';
 import { InternalError } from './InternalError';
 import { IRequestResponse } from './IRequestResponse';
-import { Logger } from '@arashi/logger';
+import { BaseLogger } from '@arashi/logger';
 import { ResponseData } from './ResponseData';
 import { ReadStream } from 'fs';
 import { NotImplementedError } from './NotImplementedError';
 import { HTTPMethod } from './HTTPMethod';
-// import { Stream } from 'stream';
 
 const TAG: string = 'Handler';
 
@@ -94,7 +93,7 @@ export class Handler<
             response
         };
 
-        let logger: Logger = getInstance().getLogger();
+        let logger: BaseLogger = getInstance().getLogger();
 
         try {
             for (let i: number = 0; i < this.$middlewares.length; i++) {

package/src/MySQLConnection.ts

@@ -24,7 +24,7 @@ import { StartTransactionQuery } from './private/StartTransactionQuery';
 import { CommitQuery } from './private/CommitQuery';
 import { RollbackQuery } from './private/RollbackQuery';
 import * as SQLFormatter from 'sql-formatter';
-import { Logger } from '@arashi/logger';
+import { BaseLogger } from '@arashi/logger';
 import {LogLevel} from '@arashi/interfaces';
 import { StormError } from './StormError';
 import { DeadLockError } from './DeadLockError';
@@ -86,7 +86,7 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
 
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     protected _query(query: string, params?: any): Promise<any> {
-        let logger: Logger = getInstance().getLogger();
+        let logger: BaseLogger = getInstance().getLogger();
         return new Promise((resolve, reject) => {
             let queryObject: MySQL.Query = this.getAPI().query({
                 sql: query,

package/src/StormError.ts

@@ -15,7 +15,7 @@
 */
 
 import {getInstance} from './instance';
-import {Logger} from '@arashi/logger';
+import {BaseLogger} from '@arashi/logger';
 import {StatusCode} from './StatusCode';
 import { ExitCode } from './ExitCode';
 
@@ -46,7 +46,7 @@ export abstract class StormError<TErrorDetails = any> extends Error {
 
         this.$details = details;
 
-        let logger: Logger = getInstance().getLogger();
+        let logger: BaseLogger = getInstance().getLogger();
         logger.error(TAG, `${this.getMessage()}... See details below:`);
         logger.info(TAG, this.getPrivateDetails());
     }

package/src/instance.ts

@@ -18,6 +18,10 @@ import {Application} from './Application';
 
 let instance: Application;
 
+/**
+ * @deprecated No replacement.
+ * @param app 
+ */
 let setInstance = (app: Application): void => {
     if (instance) {
         instance.getLogger().warn('ApplicationInstance', 'Storm application already initialized');
@@ -25,6 +29,10 @@ let setInstance = (app: Application): void => {
     instance = app;
 };
 
+/**
+ * @deprecated Pass down Application via constructors/factory methods, when applicable.
+ * @returns 
+ */
 let getInstance = (): Application => {
     return instance;
 };