@breautek/storm 8.2.0 → 8.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breautek/storm",
-  "version": "8.2.0",
+  "version": "8.4.0",
   "description": "Object-Oriented REST API framework",
   "main": "lib/api.js",
   "types": "lib/api.d.ts",
@@ -12,8 +12,8 @@
     "build:release": "NODE_ENV=production tsc",
     "build-lib": "rm -rf ./lib && tsc",
     "build-docs": "typedoc --excludePrivate --readme none --out ./docs ./src/api.ts",
-    "lint": "eslint --ext .ts '?(src|spec)/**/*.ts' --cache",
-    "lint:fix": "eslint --ext .ts '?(src|spec)/**/*.ts' --fix",
+    "lint": "eslint ./src ./spec",
+    "lint:fix": "eslint --fix ./src ./spec",
     "unit": "jest",
     "test": "npm run-script lint && jest",
     "coverage": "codecov",
@@ -51,19 +51,19 @@
     "@types/formidable": "3.4.5",
     "@types/jsonwebtoken": "9.0.7",
     "@types/mysql": "2.15.26",
-    "@types/node": "22.13.4",
+    "@types/node": "22.13.10",
     "@types/uuid": "10.0.0",
     "ajv": "8.17.1",
     "body-parser": "1.20.3",
-    "commander": "12.1.0",
+    "commander": "13.1.0",
     "express": "4.21.2",
     "form-data": "4.0.2",
     "formidable": "3.5.2",
     "jsonwebtoken": "9.0.2",
     "mysql": "2.18.1",
-    "sql-formatter": "15.4.10",
+    "sql-formatter": "15.4.11",
     "tslib": "2.8.1",
-    "uuid": "11.0.3"
+    "uuid": "11.1.0"
   },
   "peerDependencies": {
     "@arashi/interfaces": "1.x",
@@ -72,18 +72,15 @@
   "devDependencies": {
     "@arashi/interfaces": "1.2.1",
     "@arashi/logger": "4.1.3",
-    "@totalpave/eslint-plugin": "6.3.2",
+    "@totalpave/eslint-plugin": "7.0.10",
     "@types/jest": "29.5.14",
-    "@typescript-eslint/eslint-plugin": "7.18.0",
-    "@typescript-eslint/parser": "7.18.0",
     "auto-changelog": "2.5.0",
-    "eslint": "8.57.1",
     "jest": "29.7.0",
     "jest-jasmine2": "29.7.0",
-    "ts-jest": "29.2.5",
+    "ts-jest": "29.2.6",
     "ts-node": "10.9.2",
-    "typedoc": "0.27.7",
+    "typedoc": "0.27.9",
     "typedoc-plugin-markdown": "4.4.2",
-    "typescript": "5.6.3"
+    "typescript": "5.8.2"
   }
 }

package/src/Application.ts

@@ -26,6 +26,7 @@ import {Response} from './Response';
 import {ConfigLoader} from './ConfigLoader';
 import {ICloudwatchConfig, IConfig} from './IConfig';
 import {Command} from 'commander';
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 import Express = require('express');
 import * as BodyParser from 'body-parser';
 import * as http from 'http';
@@ -300,11 +301,12 @@ export abstract class Application
     }
 
     private $getVersionString(): string {
+        // eslint-disable-next-line @typescript-eslint/no-require-imports
         let pkg: any = require('../package.json');
         return `${this._getVersion()} (Storm ${pkg.version})`;
     }
 
-    private $buildArgOptions() {
+    private $buildArgOptions(): void {
         this.$program = new Command();
         
         this.$program.version(this.$getVersionString(), '-v, --version');

package/src/BackendAuthenticationMiddleware.ts

@@ -42,7 +42,6 @@ export class BackendAuthenticationMiddleware {
      * @param response 
      * @param options Arbituary object containing any relevant information used for authentication.
      */
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public execute(request: Request, options?: any): Promise<any> {
         let config: IConfig = getInstance().getConfig();
 

package/src/ConfigLoader.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
 /// <reference path="./defs/merge-change.d.ts" />
 
 /*
@@ -85,7 +86,7 @@ export class ConfigLoader<TConfig extends IConfig = IConfig> {
 
         await this.$validateSchema(config);
 
-        return <TConfig>config;
+        return config as TConfig;
     }
 
     /**

package/src/DatabaseConnection.ts

@@ -75,7 +75,7 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
         return this.$instantiationStack;
     }
 
-    private $armLingerWarning() {
+    private $armLingerWarning(): void {
         if (this.$lingerTimer) {
             clearTimeout(this.$lingerTimer);
         }
@@ -93,6 +93,8 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
         return this.$api;
     }
 
+    public abstract formatQuery(query: IQueryable<any>, params?: any): string;
+
     /**
      * Returns true if connection was created without
      * write access
@@ -138,8 +140,24 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
         let params: Record<string, any> = query.getParametersForQuery();
 
         await query.onPreQuery(this);
-        let results: TQueryResult = await this._query<TQueryResult>(queryStr, params);
-        return await (<any>query.onPostProcess(this, <any>results));
+        
+        let out: TQueryResult = null;
+        let e: unknown = null;
+        try {
+            let results: TQueryResult = await this._query<TQueryResult>(queryStr, params);
+            out = await (query.onPostProcess(this, results as any) as any);
+        }
+        catch (ex) {
+            e = ex;
+        }
+        
+        await query.onPostQuery(this);
+
+        if (e !== null) {
+            throw e;
+        }
+
+        return out;
     }
 
     /**
@@ -149,7 +167,6 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
      * @param streamOptions Stream options
      * @returns Readable
      */
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public stream(query: IQueryable<any>, streamOptions?: any): Readable {
         this.$armLingerWarning();
         let queryStr: string = null;
@@ -247,7 +264,6 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
      * @async
      * @returns Promise
      */
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     protected abstract _query<TQueryResult>(query: string, params?: any): Promise<TQueryResult>;
 
     /**
@@ -259,7 +275,6 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
      * @param streamOptions `Readable` stream options
      * @returns `Readable`
      */
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     protected abstract _stream(query: string, params?: any, streamOptions?: any): Readable;
 
     /**

package/src/DatabaseQueryError.ts

@@ -21,7 +21,6 @@ export class DatabaseQueryError extends StormError<{
     query: string;
     error: any;
 }> {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public constructor(query: string, error: any) {
         super({
             query: query,

package/src/DropTemporaryTableQuery.ts

@@ -22,11 +22,11 @@ export interface IDropTemporaryTableQueryInput {
 
 export class DropTemporaryTableQuery extends Query<IDropTemporaryTableQueryInput> {
 
-    public getParameters(): IDropTemporaryTableQueryInput {
-        return <IDropTemporaryTableQueryInput>super.getParameters();
+    public override getParameters(): IDropTemporaryTableQueryInput {
+        return super.getParameters();
     }
 
-    protected _getQuery(): string {
+    protected override _getQuery(): string {
         return `
             DROP TEMPORARY TABLE \`${this.getParameters().tableName}\`
         `;

package/src/ExpiredTokenError.ts

@@ -19,7 +19,6 @@ import {ErrorCode} from './ErrorCode';
 import {StatusCode} from './StatusCode';
 
 export class ExpiredTokenError extends StormError<any> {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public constructor(details?: any) {
         super(details);
     }

package/src/IDatabaseConnection.ts

@@ -35,6 +35,13 @@ export interface IDatabaseConnection {
     commit(): Promise<void>;
     rollback(): Promise<void>;
 
+    /**
+     * @since 8.4.0
+     * @param query 
+     * @param params 
+     */
+    formatQuery(query: IQueryable<any>): string;
+
     /**
      * @since 8.1.0
      */

package/src/IQueryable.ts

@@ -18,6 +18,7 @@ import { IDatabaseConnection } from './IDatabaseConnection';
 
 export interface IQueryable<T> {
     onPreQuery(connection: IDatabaseConnection): Promise<void>;
+    onPostQuery(connection: IDatabaseConnection): Promise<void>;
     getQuery(connection: IDatabaseConnection): string;
     execute(connection: IDatabaseConnection): Promise<T>;
     getParametersForQuery(): Record<string, any>;

package/src/InternalError.ts

@@ -19,7 +19,6 @@ import {ErrorCode} from './ErrorCode';
 import {StatusCode} from './StatusCode';
 
 export class InternalError extends StormError<any> {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public constructor(details?: any) {
         super(details);
     }

package/src/InvalidCredentialsError.ts

@@ -19,7 +19,6 @@ import {ErrorCode} from './ErrorCode';
 import {StatusCode} from './StatusCode';
 
 export class InvalidCredentialsError extends StormError<any> {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public constructor(details?: any) {
         super(details);
     }

package/src/InvalidValueError.ts

@@ -23,7 +23,6 @@ export class InvalidValueError extends StormError<{
     expected: any;
     got: any;
 }> {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public constructor(variable: string, expected: any, got: any) {
         super({
             variable: variable,

package/src/ManagedDatabaseConnection.ts

@@ -20,6 +20,7 @@ import {Readable} from 'stream';
 import { Query } from './Query';
 import { IsolationLevel } from './IsolationLevel';
 import { IDatabasePosition } from './IDatabasePosition';
+import { IQueryable } from './IQueryable';
 
 const TAG: string = 'ManagedDatabaseConnection';
 
@@ -42,6 +43,10 @@ export class ManagedDatabaseConnection implements IDatabaseConnection {
         this.$instantionStack = new Error().stack;
     }
 
+    public formatQuery(query: IQueryable<any>): string {
+        throw new Error('Unsupported API call');
+    }
+
     // TODO(Breaking): Turn this API into async
     public setConnection(connection: IDatabaseConnection): void {
         if (this.$connection) {
@@ -130,6 +135,8 @@ export class ManagedDatabaseConnection implements IDatabaseConnection {
     public setTimeout(timeout: number): void {
         this.$getConnection().then((connection: IDatabaseConnection) => {
             connection.setTimeout(timeout);
+        }).catch((error: unknown) => {
+            console.error(error);
         });
     }
 
@@ -142,7 +149,6 @@ export class ManagedDatabaseConnection implements IDatabaseConnection {
         }
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public query(query: Query, params?: any): Promise<any> {
         return new Promise<any>((resolve, reject) => {
             this.$getConnection().then((connection: IDatabaseConnection) => {
@@ -151,7 +157,6 @@ export class ManagedDatabaseConnection implements IDatabaseConnection {
         })
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public stream(query: Query, params?: any, streamOptions?: any): Readable {
         throw new Error('stream is not supported on Managed Connections');
     }

package/src/Middleware.ts

@@ -19,7 +19,6 @@ import {Response} from './Response';
 import {IRequestResponse} from './IRequestResponse';
 
 export abstract class Middleware {
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
     public constructor() {}
 
     protected abstract _execute(request: Request, response: Response): Promise<IRequestResponse>;

package/src/MySQLConnection.ts

@@ -35,6 +35,8 @@ import { IDatabasePosition } from './IDatabasePosition';
 import { GetBinLogPositionQuery } from './private/GetBinLogPositionQuery';
 import { GetSlavePositionQuery } from './private/GetSlavePositionQuery';
 import { GetMasterPositionQuery } from './private/GetMasterPositionQuery';
+import { IQueryable } from './IQueryable';
+import { queryFormatter } from './mysql/queryFormatter';
 
 const DEFAULT_HIGH_WATERMARK: number = 512; // in number of result objects
 const TAG: string = 'MySQLConnection';
@@ -70,17 +72,19 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
         this.$transaction = false;
         this.$isMasterConnection = null;
 
-        connection.config.queryFormat = function(query: string, values: any) {
-            if (!values) return query;
+        connection.config.queryFormat = queryFormatter.bind(this);
 
-            return query.replace(/:(\w+)/g, function(this: any, txt: string, key: string): string {
-                // eslint-disable-next-line no-prototype-builtins
-                if (values.hasOwnProperty(key)) {
-                    return this.escape(values[key]);
-                }
-                return txt;
-            }.bind(this));
-        };
+        // connection.config.queryFormat = function(query: string, values: any) {
+        //     if (!values) return query;
+
+        //     return query.replace(/:(\w+)/g, function(this: any, txt: string, key: string): string {
+        //         // eslint-disable-next-line no-prototype-builtins
+        //         if (values.hasOwnProperty(key)) {
+        //             return this.escape(values[key]);
+        //         }
+        //         return txt;
+        //     }.bind(this));
+        // };
     }
 
     /**
@@ -91,6 +95,10 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
         this.$isMasterConnection = result === null;
     }
 
+    public override formatQuery(query: IQueryable<any>): string {
+        return this.getAPI().config.queryFormat(query.getQuery(this), query.getParametersForQuery());
+    }
+
     public isMaster(): boolean {
         return this.$isMasterConnection;
     }
@@ -112,7 +120,6 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
         return await statusQuery.execute(this);
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     protected _query(query: string, params?: any): Promise<any> {
         let logger: BaseLogger = getInstance().getLogger();
         return new Promise((resolve, reject) => {
@@ -170,7 +177,6 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
         });
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     protected _stream(query: string, params?: any, streamOptions?: any): Readable {
         if (!streamOptions) {
             streamOptions = {};

package/src/MySQLDatabase.ts

@@ -38,12 +38,10 @@ export class MySQLDatabase extends Database<MySQL.PoolConfig, MySQL.PoolConnecti
         });
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public escape(value: any): string {
         return MySQLDatabase.escape(value);
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public static escape(value: any): string {
         return MySQL.escape(value);
     }

package/src/Query.ts

@@ -57,6 +57,22 @@ export abstract class Query<TQueryParameters = any, TQueryResultSet = any, TQuer
         return Promise.resolve();
     }
 
+    /**
+     * Overridable to execute statements after the main query.
+     * Can be used to clean up session variables or temporary tables, etc
+     * 
+     * Unlike {@link onPostProcess}, this hook does not provide the result set,
+     * and will be invoked even if the main query produces an error.
+     * 
+     * @since 8.3.0
+     * 
+     * @param connection 
+     * @returns {void}
+     */
+    public onPostQuery(connection: IDatabaseConnection): Promise<void> {
+        return Promise.resolve();
+    }
+
     /**
      * Override to augment/manipulate the returned result set.
      * 
@@ -65,7 +81,7 @@ export abstract class Query<TQueryParameters = any, TQueryResultSet = any, TQuer
      */
     public async onPostProcess(connection: IDatabaseConnection, resultSet: TQueryResultSet): Promise<TQueryPostProcessedResultSet> {
         // By default, simply return the result set without any post processing.
-        return Promise.resolve(<any>resultSet);
+        return Promise.resolve(resultSet as any);
     }
 
     public async execute(connection: IDatabaseConnection): Promise<TQueryPostProcessedResultSet> {

package/src/Request.ts

@@ -30,6 +30,7 @@ import { JWTError } from './JWTError';
 import { ResponseData } from './ResponseData';
 import {StatusCode} from './StatusCode';
 import { InternalError } from './InternalError';
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 import IncomingForm = require('formidable/Formidable');
 
 export interface IParameterMap {
@@ -133,7 +134,7 @@ export class Request<TBody = any, TAuthToken extends IAuthTokenData = IAuthToken
         let authHeader: string = getInstance().getConfig().authentication_header;
         let tdata: TAuthToken = null;
         try {
-            tdata = <TAuthToken>(await getInstance().getTokenManager().verify(new Token(this.getHeader(authHeader))));
+            tdata = (await getInstance().getTokenManager().verify(new Token(this.getHeader(authHeader)))) as TAuthToken;
         }
         catch (ex) {
             let error: ResponseData = null;

package/src/Response.ts

@@ -140,7 +140,7 @@ export class Response<TResponse = SendableData, TErrorResponse = Error | IErrorR
                 }
                 // If it was not ResponseData<TResponse> then
                 // the method signature should have caught it
-                this.send((<TErrorResponse><unknown>error));
+                this.send((error as unknown as TErrorResponse));
             }
             else {
                 this.send(new InternalError(error));

package/src/ServiceProvider.ts

@@ -78,7 +78,6 @@ export abstract class ServiceProvider {
         return `/api/${this._getBase()}/${this.getVersion()}/${url}${this.urlSuffix()}${queryString}`;
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public request(method: HTTPMethod, url: string, accessToken: string, data: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return new Promise<ServiceResponse>((resolve, reject) => {
             let httpOpts: http.RequestOptions = {
@@ -138,22 +137,18 @@ export abstract class ServiceProvider {
         request.end();
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public get(url: string, accessToken: string, data?: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return this.request(HTTPMethod.GET, this._createURL(url, data), accessToken, NO_DATA, headers, additionalOptions);
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public post(url: string, accessToken: string, data?: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return this.request(HTTPMethod.POST, this._createURL(url), accessToken, data, headers, additionalOptions);
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public put(url: string, accessToken: string, data?: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return this.request(HTTPMethod.PUT, this._createURL(url), accessToken, data, headers, additionalOptions);
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     public delete(url: string, accessToken: string, data?: any, headers?: IServiceHeaders, additionalOptions?: any): Promise<ServiceResponse> {
         return this.request(HTTPMethod.DELETE, this._createURL(url), accessToken, data, headers, additionalOptions);
     }

package/src/TokenManager.ts

@@ -78,7 +78,7 @@ export class TokenManager<TAuthToken extends IAuthTokenData = IAuthTokenData> {
     public decode(token: Token): Promise<TAuthToken> {
         return new Promise<any>((resolve, reject) => {
             try {
-                let decoded: TAuthToken = <TAuthToken>jwt.decode(token.getSignature());
+                let decoded: TAuthToken = jwt.decode(token.getSignature()) as TAuthToken;
                 resolve(decoded);
             }
             catch (ex) {

package/src/Transaction.ts

@@ -60,6 +60,7 @@ export class Transaction implements IQueryable<void> {
     }
     
     public async onPreQuery(connection: IDatabaseConnection): Promise<void> {}
+    public async onPostQuery(connection: IDatabaseConnection): Promise<void> {}
 
     public getQuery(connection: IDatabaseConnection): string {
         return null;

package/src/mysql/queryFormatter.ts

@@ -0,0 +1,14 @@
+
+import * as MySQL from 'mysql';
+
+export function queryFormatter(query: string, values: any): string {
+    if (!values) return query;
+
+    return query.replace(/:(\w+)/g, function(this: any, txt: string, key: string): string {
+        // eslint-disable-next-line no-prototype-builtins
+        if (values.hasOwnProperty(key)) {
+            return MySQL.escape(values[key]);
+        }
+        return txt;
+    });
+}

package/src/private/ConnectionReplicationWaiter.ts

@@ -66,7 +66,6 @@ export class ConnectionReplicationWaiter {
             shouldTimeout = true;
         }, timeout);
 
-        // eslint-disable-next-line no-constant-condition
         while (true) {
             if (shouldTimeout) {
                 didTimeout = true;
@@ -75,6 +74,8 @@ export class ConnectionReplicationWaiter {
 
             let currentPos: IDatabasePosition = await this.$conn.getCurrentDatabasePosition();
 
+            // TODO: I have no idea what my intent is here, but it's obviously wrong
+            // eslint-disable-next-line no-constant-binary-expression
             if (currentPos === null || (currentPos && !currentPos.page === null) || (currentPos && !currentPos.position === null)) {
                 throw new InternalError('Database Position not supported');
             }

package/.eslintrc.js

@@ -1,61 +0,0 @@
-/*
-   Copyright 2017-2021 Norman Breau
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-*/
-
-module.exports = {
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/eslint-recommended",
-        "plugin:@typescript-eslint/recommended",
-        "plugin:@totalpave/recommendedTS"
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "project": "./spec/tsconfig.json",
-        "sourceType": "module",
-        "tsconfigRootDir": __dirname
-    },
-    "plugins": [
-        "@typescript-eslint",
-        "@totalpave"
-    ],
-    "env": {
-        "node": true,
-        "jasmine": true
-    },
-    "rules": {
-        "@typescript-eslint/explicit-function-return-type": "off",
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/no-inferrable-types": "off",
-        "prefer-const": "off",
-        "@typescript-eslint/no-unused-vars": [
-            "error",
-            {
-                "args": "none",
-                "vars": "local"
-            }
-        ],
-        "@typescript-eslint/consistent-type-definitions": "off",
-        "@typescript-eslint/consistent-type-assertions": [
-            "error",
-            {
-                "assertionStyle": "angle-bracket"
-            }
-        ],
-        "no-empty-function": "off",
-        "@typescript-eslint/no-empty-function": "off",
-        "@typescript-eslint/camelcase": "off"
-    }
-};