@breautek/storm 3.3.1 → 4.1.0

package/lib/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AAiBA,uCAAuC;AAA/B,uGAAA,WAAW,OAAA;AACnB,6CAA0C;AAAlC,0GAAA,WAAW,OAAA;AAGnB,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AAGpB,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,yEAAsE;AAA9D,sIAAA,yBAAyB,OAAA;AACjC,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,6DAAqF;AAA7E,0HAAA,mBAAmB,OAAA;AAC3B,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAMhB,yCAAsC;AAA9B,sGAAA,SAAS,OAAA;AACjB,2CAIsB;AAHlB,wGAAA,UAAU,OAAA;AAId,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,iEAA8D;AAAtD,8HAAA,qBAAqB,OAAA;AAC7B,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,yDAAsD;AAA9C,sHAAA,iBAAiB,OAAA;AACzB,yDAAsD;AAA9C,sHAAA,iBAAiB,OAAA;AACzB,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAG1B,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qCAAiD;AAAzC,kGAAA,OAAO,OAAA;AACf,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AACpB,qCAAmE;AAA3D,kGAAA,OAAO,OAAA;AACf,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,qFAAkF;AAA1E,kJAAA,+BAA+B,OAAA;AAcvC,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AAGpB,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAGlB,yCAAyC;AACjC,gCAAU"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":";;;AAiBA,uCAAuC;AAA/B,uGAAA,WAAW,OAAA;AACnB,6CAA0C;AAAlC,0GAAA,WAAW,OAAA;AAGnB,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AAGpB,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,yEAAsE;AAA9D,sIAAA,yBAAyB,OAAA;AACjC,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,6DAAqF;AAA7E,0HAAA,mBAAmB,OAAA;AAC3B,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAIhB,qEAAiG;AAAzF,kIAAA,uBAAuB,OAAA;AAG/B,yCAAsC;AAA9B,sGAAA,SAAS,OAAA;AACjB,2CAIsB;AAHlB,wGAAA,UAAU,OAAA;AAId,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,iEAA8D;AAAtD,8HAAA,qBAAqB,OAAA;AAC7B,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,iDAA8C;AAAtC,8GAAA,aAAa,OAAA;AACrB,yDAAsD;AAA9C,sHAAA,iBAAiB,OAAA;AACzB,yDAAsD;AAA9C,sHAAA,iBAAiB,OAAA;AACzB,qEAAkE;AAA1D,kIAAA,uBAAuB,OAAA;AAC/B,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,6DAA0D;AAAlD,0HAAA,mBAAmB,OAAA;AAC3B,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAC1B,2DAAwD;AAAhD,wHAAA,kBAAkB,OAAA;AAG1B,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qCAAiD;AAAzC,kGAAA,OAAO,OAAA;AACf,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AACpB,qCAAmE;AAA3D,kGAAA,OAAO,OAAA;AACf,mDAAgD;AAAxC,gHAAA,cAAc,OAAA;AACtB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAClB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,qFAAkF;AAA1E,kJAAA,+BAA+B,OAAA;AAcvC,iCAA8B;AAAtB,8FAAA,KAAK,OAAA;AACb,+CAA4C;AAApC,4GAAA,YAAY,OAAA;AAGpB,uCAAoC;AAA5B,oGAAA,QAAQ,OAAA;AAChB,2CAAwC;AAAhC,wGAAA,UAAU,OAAA;AAGlB,yCAAyC;AACjC,gCAAU"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breautek/storm",
-  "version": "3.3.1",
+  "version": "4.1.0",
   "description": "Object-Oriented REST API framework",
   "main": "lib/api.js",
   "types": "lib/api.d.ts",
@@ -11,7 +11,7 @@
     "build": "npm run lint && tsc",
     "build:release": "NODE_ENV=production tsc",
     "build-lib": "rm -r ./lib && tsc",
-    "build-docs": "typedoc --excludePrivate --readme none --out ./docs ./src",
+    "build-docs": "typedoc --excludePrivate --readme none --out ./docs ./src/api.ts",
     "lint": "eslint --ext .ts '?(src|spec)/**/*.ts' --cache",
     "unit": "jest",
     "test": "npm run-script lint && jest",
@@ -40,29 +40,28 @@
     "node": ">= 12.0.0"
   },
   "author": "norman@normanbreau.com",
-  "license": "GPL-3.0",
+  "license": "Apache-2.0",
   "homepage": "https://github.com/breautek/storm.git",
   "dependencies": {
     "@arashi/token": "1.0.1",
     "@breautek/merge-change": "1.0.0",
-    "@totalpave/interfaces": "3.0.0",
     "@types/body-parser": "1.19.2",
     "@types/express": "4.17.13",
     "@types/formidable": "1.2.3",
-    "@types/jsonwebtoken": "8.5.6",
-    "@types/mysql": "2.15.20",
-    "@types/node": "16.11.9",
+    "@types/jsonwebtoken": "8.5.8",
+    "@types/mysql": "2.15.21",
+    "@types/node": "16.11.26",
     "@types/uuid": "8.3.4",
-    "ajv": "8.8.2",
-    "body-parser": "1.19.1",
+    "ajv": "8.11.0",
+    "body-parser": "1.20.0",
     "commander": "8.3.0",
-    "express": "4.17.2",
+    "express": "4.18.1",
     "form-data": "4.0.0",
     "formidable": "1.2.2",
     "jsonwebtoken": "8.5.1",
     "mysql": "2.18.1",
     "sql-formatter": "4.0.2",
-    "tslib": "2.3.1",
+    "tslib": "2.4.0",
     "uuid": "8.3.2"
   },
   "peerDependencies": {
@@ -70,17 +69,17 @@
   },
   "devDependencies": {
     "@arashi/logger": "2.1.0",
-    "@totalpave/eslint-plugin": "6.0.1",
-    "@types/jest": "27.4.0",
-    "@typescript-eslint/eslint-plugin": "5.9.0",
-    "@typescript-eslint/parser": "5.9.0",
-    "auto-changelog": "2.3.0",
-    "eslint": "8.6.0",
-    "jest": "27.4.7",
-    "ts-jest": "27.1.2",
-    "ts-node": "10.4.0",
-    "typedoc": "0.21.9",
-    "typedoc-plugin-markdown": "3.10.4",
-    "typescript": "4.3.5"
+    "@totalpave/eslint-plugin": "6.0.2",
+    "@types/jest": "27.5.1",
+    "@typescript-eslint/eslint-plugin": "5.27.0",
+    "@typescript-eslint/parser": "5.27.0",
+    "auto-changelog": "2.4.0",
+    "eslint": "8.16.0",
+    "jest": "27.5.1",
+    "ts-jest": "27.1.3",
+    "ts-node": "10.8.0",
+    "typedoc": "0.22.17",
+    "typedoc-plugin-markdown": "3.12.1",
+    "typescript": "4.7.2"
   }
 }

package/src/Database.ts

@@ -14,7 +14,6 @@
    limitations under the License.
 */
 
-import { IDictionary } from '@totalpave/interfaces';
 import * as UUID from 'uuid';
 import {DatabaseConnection} from './DatabaseConnection';
 import { getInstance } from './instance';
@@ -23,7 +22,7 @@ const MASTER_NAME: string = 'MASTER';
 const TAG: string = 'Database';
 
 export abstract class Database<TDatabaseConfig, TConnectionAPI> {
-    private $clusterConfigMap: IDictionary;
+    private $clusterConfigMap: Record<any, any>;
 
     constructor() {
         this.$clusterConfigMap = {};

package/src/DatabaseConnection.ts

@@ -21,7 +21,6 @@ import {Readable} from 'stream';
 import {IDatabaseConnection} from './IDatabaseConnection';
 import {Query} from './Query';
 import { IConfig } from './IConfig';
-import { IDictionary } from '@totalpave/interfaces';
 
 export const LINGER_WARNING: number = 10000;
 export const DEFAULT_QUERY_TIMEOUT: number = 3600000;
@@ -133,8 +132,8 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
         this.$armLingerWarning();
         
         let queryStr: string = null;
-        queryStr = query.getQuery();
-        let params: IDictionary = query.getParametersForQuery();
+        queryStr = query.getQuery(this);
+        let params: Record<any, any> = query.getParametersForQuery();
 
         await query.onPreQuery(this);
         let results: TQueryResult = await this._query<TQueryResult>(queryStr, params);
@@ -152,8 +151,8 @@ export abstract class DatabaseConnection<TAPI> implements IDatabaseConnection {
     public stream(query: Query, streamOptions?: any): Readable {
         this.$armLingerWarning();
         let queryStr: string = null;
-        let params: IDictionary = query.getParametersForQuery();
-        queryStr = query.getQuery();
+        let params: Record<any, any> = query.getParametersForQuery();
+        queryStr = query.getQuery(this);
         return this._stream(queryStr, params, streamOptions);
     }
 

package/src/Query.ts

@@ -14,7 +14,6 @@
    limitations under the License.
 */
 
-import { IDictionary } from '@totalpave/interfaces';
 import { IDatabaseConnection } from './IDatabaseConnection';
 
 export abstract class Query<TQueryParameters = any, TQueryResultSet = any, TQueryPostProcessedResultSet = TQueryResultSet> {
@@ -28,14 +27,14 @@ export abstract class Query<TQueryParameters = any, TQueryResultSet = any, TQuer
         return this.$params;
     }
 
-    public getParametersForQuery(): IDictionary {
+    public getParametersForQuery(): Record<any, any> {
         return this.$params;
     }
 
-    protected abstract _getQuery(): string;
+    protected abstract _getQuery(connection: IDatabaseConnection): string;
 
-    public getQuery(): string {
-        return this._getQuery();
+    public getQuery(connection: IDatabaseConnection): string {
+        return this._getQuery(connection);
     }
 
     /**

package/src/RawQuery.ts

@@ -16,7 +16,7 @@
 
 import {Query} from './Query';
 
-export class RawQuery<TQueryParameters = any, TQueryResultSet = any> extends Query<TQueryParameters, TQueryResultSet, TQueryResultSet> {
+export class RawQuery<TQueryParameters = any, TQueryResultSet = any, TQueryPostProcessedResultSet = TQueryResultSet> extends Query<TQueryParameters, TQueryResultSet, TQueryPostProcessedResultSet> {
     private $query: string;
 
     public constructor(query: string, parameters?: TQueryParameters) {

package/src/ServiceProvider.ts

@@ -19,7 +19,6 @@ import {IServiceHeaders} from './IServiceHeaders';
 import {HTTPMethod} from './HTTPMethod';
 import {ServiceResponse} from './ServiceResponse';
 import * as http from 'http';
-import { IDictionary } from '@totalpave/interfaces';
 
 const TAG: string = 'ServiceProvider';
 const NO_DATA: string = `|${0x0}|`;
@@ -62,7 +61,7 @@ export abstract class ServiceProvider {
         return 'v1';
     }
 
-    protected _createURL(url: string, queryParams?: IDictionary): string {
+    protected _createURL(url: string, queryParams?: Record<any, any>): string {
         let queryString: string = '';
 
         if (queryParams) {

package/src/SetSessionVariableQuery.ts

@@ -0,0 +1,28 @@
+
+import {
+    Query
+} from './Query';
+
+export interface ISetSessionVariableQueryInput {
+    name: string;
+    value: any;
+}
+
+export class SetSessionVariableQuery extends Query<ISetSessionVariableQueryInput, void> {
+    protected _getQuery(): string {
+        let params: ISetSessionVariableQueryInput = this.getParameters();
+
+        if (!/[a-zA-Z_]/ig.test(params.name)) {
+            throw new Error('Illegal Variable Name');
+        }
+
+        // Only allow alpha letters & underscores for variable names
+        return `SET SESSION ${params.name} = :value`;
+    }
+
+    public getParametersForQuery(): Record<any, any> {
+        return {
+            value: this.getParameters().value
+        };
+    }
+}

package/src/TemporaryTableQuery.ts

@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-import { IDictionary } from '@totalpave/interfaces';
+import { IDatabaseConnection } from './IDatabaseConnection';
 import {Query} from './Query';
 
 export interface ITemporaryTableQueryInput {
@@ -24,20 +24,20 @@ export interface ITemporaryTableQueryInput {
 
 export class TemporaryTableQuery extends Query<any> {
 
-    public getParametersForQuery(): IDictionary {
-        let params: IDictionary = this.getParameters();
+    public getParametersForQuery(): Record<any, any> {
+        let params: Record<any, any> = this.getParameters();
         return {
             ...params.selectQuery.getParametersForQuery(),
             tableName: params.tableName
         };
     }
 
-    protected _getQuery(): string {
+    protected override _getQuery(connection: IDatabaseConnection): string {
         let params: ITemporaryTableQueryInput = this.getParameters();
 
         return `
             CREATE TEMPORARY TABLE \`${params.tableName}\`
-            ${params.selectQuery.getQuery()}
+            ${params.selectQuery.getQuery(connection)}
         `;
     }
 }

package/src/api.ts

@@ -34,6 +34,7 @@ export {RawQuery} from './RawQuery';
 export {IInsertQueryResult} from './IInsertQueryResult';
 export {IDeleteQueryResult} from './IDeleteQueryResult';
 export {IUpdateQueryResult} from './IUpdateQueryResult';
+export {SetSessionVariableQuery, ISetSessionVariableQueryInput} from './SetSessionVariableQuery';
 
 // Errors
 export {ErrorCode} from './ErrorCode';

package/.nyc_output/01d7f3ed-ada5-4fbf-bf72-17458de5eda1.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/07a372ea-5f20-411a-8f9b-5cfd38c9f7cf.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/1a03fe29-15f4-4d36-a6f1-061f95c919d2.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/1be973a3-2986-4e51-9bef-ffa834a81029.json

@@ -1 +0,0 @@
-{}