@breautek/storm 9.7.4 → 9.8.0

package/lib/RawHandlerAttacher.d.ts

@@ -0,0 +1,11 @@
+import Express = require('express');
+import { Application } from './Application';
+import { Handler } from './Handler';
+import { IHandlerAttachBridge } from './IHandlerAttachBridge';
+export declare class RawHandlerAttacher implements IHandlerAttachBridge {
+    private $server;
+    private $app;
+    private $parser;
+    constructor(app: Application, server: Express.Application);
+    attach(path: string, handler: Handler): void;
+}

package/lib/RawHandlerAttacher.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RawHandlerAttacher = void 0;
+const tslib_1 = require("tslib");
+const Request_1 = require("./Request");
+const Response_1 = require("./Response");
+const BodyParser = tslib_1.__importStar(require("body-parser"));
+class RawHandlerAttacher {
+    constructor(app, server) {
+        this.$server = server;
+        this.$app = app;
+        this.$parser = BodyParser.raw({
+            type: '*/*',
+            limit: app.getRequestSizeLimit()
+        });
+    }
+    attach(path, handler) {
+        this.$server.get(path, this.$parser, (request, response) => {
+            let r = new Request_1.Request(request);
+            void handler.get(r, new Response_1.Response(this.$app, response, r.getURL()));
+        });
+        this.$server.post(path, this.$parser, (request, response) => {
+            let r = new Request_1.Request(request);
+            void handler.post(r, new Response_1.Response(this.$app, response, r.getURL()));
+        });
+        this.$server.put(path, this.$parser, (request, response) => {
+            let r = new Request_1.Request(request);
+            void handler.put(r, new Response_1.Response(this.$app, response, r.getURL()));
+        });
+        this.$server.delete(path, this.$parser, (request, response) => {
+            let r = new Request_1.Request(request);
+            void handler.delete(r, new Response_1.Response(this.$app, response, r.getURL()));
+        });
+    }
+}
+exports.RawHandlerAttacher = RawHandlerAttacher;
+//# sourceMappingURL=RawHandlerAttacher.js.map

package/lib/RawHandlerAttacher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RawHandlerAttacher.js","sourceRoot":"","sources":["../src/RawHandlerAttacher.ts"],"names":[],"mappings":";;;;AAMA,uCAAkC;AAClC,yCAAoC;AACpC,gEAA0C;AAE1C,MAAa,kBAAkB;IAK3B,YAAmB,GAAgB,EAAE,MAA2B;QAC5D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAEhB,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC;YAC1B,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,GAAG,CAAC,mBAAmB,EAAE;SACnC,CAAC,CAAC;IACP,CAAC;IAEM,MAAM,CAAC,IAAY,EAAE,OAAgB;QACxC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,OAAwB,EAAE,QAA0B,EAAE,EAAE;YAC1F,IAAI,CAAC,GAAY,IAAI,iBAAO,CAAC,OAAO,CAAC,CAAC;YACtC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,mBAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,OAAwB,EAAE,QAA0B,EAAE,EAAE;YAC3F,IAAI,CAAC,GAAY,IAAI,iBAAO,CAAC,OAAO,CAAC,CAAC;YACtC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,mBAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,OAAwB,EAAE,QAA0B,EAAE,EAAE;YAC1F,IAAI,CAAC,GAAY,IAAI,iBAAO,CAAC,OAAO,CAAC,CAAC;YACtC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,mBAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,OAAwB,EAAE,QAA0B,EAAE,EAAE;YAC7F,IAAI,CAAC,GAAY,IAAI,iBAAO,CAAC,OAAO,CAAC,CAAC;YACtC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,mBAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AAjCD,gDAiCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breautek/storm",
-  "version": "9.7.4",
+  "version": "9.8.0",
   "description": "Object-Oriented REST API framework",
   "main": "lib/api.js",
   "types": "lib/api.d.ts",
@@ -17,7 +17,6 @@
     "unit": "jest",
     "test": "npm run-script lint && jest",
     "coverage": "codecov",
-    "clean": "rm -r ./lib && rm -r ./docs",
     "prepublishOnly": "npm run-script build-lib",
     "changelog": "auto-changelog --output CHANGELOG.md -p --release-summary --ignore-commit-pattern chore",
     "preversion": "npm test",
@@ -56,9 +55,9 @@
     "form-data": "4.0.6",
     "formidable": "3.5.4",
     "jsonwebtoken": "9.0.3",
-    "mysql2": "3.22.5",
+    "mysql2": "3.24.2",
     "prom-client": "15.1.3",
-    "sql-formatter": "15.8.1",
+    "sql-formatter": "15.8.2",
     "tslib": "2.8.1"
   },
   "peerDependencies": {
@@ -67,20 +66,20 @@
   },
   "devDependencies": {
     "@arashi/interfaces": "1.2.1",
-    "@arashi/logger": "4.1.5",
+    "@arashi/logger": "4.1.7",
     "@jest/types": "30.4.1",
-    "@totalpave/eslint-plugin": "7.1.1",
+    "@totalpave/eslint-plugin": "7.1.2",
     "@types/body-parser": "1.19.6",
     "@types/jest": "30.0.0",
     "@types/jsonwebtoken": "9.0.10",
     "@types/mysql": "2.15.27",
-    "@types/node": "24.10.1",
+    "@types/node": "26.3.0",
     "auto-changelog": "2.6.0",
     "jest": "30.4.2",
     "jest-jasmine2": "30.4.2",
-    "ts-jest": "29.4.11",
+    "ts-jest": "29.4.12",
     "ts-node": "10.9.2",
-    "typedoc": "0.28.19",
+    "typedoc": "0.28.20",
     "typedoc-plugin-markdown": "4.12.0",
     "typescript": "5.9.3"
   }

package/pnpm-workspace.yaml

@@ -1,6 +1,12 @@
+allowBuilds:
+  unrs-resolver: true
+
+minimumReleaseAgeExclude:
+  - '@totalpave/eslint-plugin@7.1.2'
+  - '@types/node@26.3.0'
+
 onlyBuiltDependencies:
   - unrs-resolver
 
 publicHoistPattern:
   - eslint
-

package/src/Application.ts

@@ -40,6 +40,9 @@ import { StormError } from './StormError';
 import { PrometheusServer } from './PrometheusServer';
 import { MetricStore } from './MetricStore';
 import * as OS from 'node:os';
+import { IHandlerAttachBridge } from './IHandlerAttachBridge';
+import { RawHandlerAttacher } from './RawHandlerAttacher';
+import { HandlerAttacher } from './HandlerAttacher';
 
 export interface IStormCLIArgs {
     bind?: string;
@@ -192,6 +195,10 @@ export abstract class Application
 
         this.$getLogger().trace(TAG, 'Starting server...');
         this.$server = Express();
+        this.$server.set('trust proxy', 'loopback');
+
+        await this._attachRawHandlers(new RawHandlerAttacher(this, this.$server));
+
         this.$server.use(BodyParser.json({
             type : 'application/json',
             limit : this.getRequestSizeLimit()
@@ -211,7 +218,7 @@ export abstract class Application
 
         this.$getLogger().trace(TAG, 'Attaching handlers...');
         await this.$attachHandlers();
-        await this._attachHandlers();
+        await this._attachHandlers(new HandlerAttacher(this, this.$server));
 
         await this._onBeforeReadyAsync();
 
@@ -400,11 +407,17 @@ export abstract class Application
      * 
      * @param path The URL API path. E.g. /api/myService/myCommand/
      * @param Handler
+     * @deprecated - Use {@link IHandlerAttachBridge} instead
      */
     public attachHandler(path: string, handler: Handler): void {
         this.attachHandlerInstance(path, handler);
     }
 
+    /**
+     * @deprecated - Use {@link IHandlerAttachBridge} instead
+     * @param path 
+     * @param handler 
+     */
     public attachHandlerInstance(path: string, handler: Handler): void {
         this.$server.get(path, (request: Express.Request, response: Express.Response) => {
             let r: Request = new Request(request);
@@ -454,7 +467,9 @@ export abstract class Application
      * Subclasses are expected to attach the API handlers for their service. This will be invoked during application startup.
      * @returns Promise<void>
      */
-    protected abstract _attachHandlers(): Promise<void>;
+    protected abstract _attachHandlers(attacher: IHandlerAttachBridge): Promise<void>;
+
+    protected async _attachRawHandlers(attacher: IHandlerAttachBridge): Promise<void> {}
 
     /**
      * @deprecated Supply the configs via --config and --local-config arguments

package/src/HandlerAttacher.ts

@@ -0,0 +1,37 @@
+
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+import Express = require('express');
+import {Application} from './Application';
+import { Handler } from './Handler';
+import { IHandlerAttachBridge } from './IHandlerAttachBridge';
+import {Request} from './Request';
+import {Response} from './Response';
+
+export class HandlerAttacher implements IHandlerAttachBridge {
+    private $server: Express.Application;
+    private $app: Application;
+
+    public constructor(app: Application, server: Express.Application) {
+        this.$server = server;
+        this.$app = app;
+    }
+
+    public attach(path: string, handler: Handler): void {
+        this.$server.get(path, (request: Express.Request, response: Express.Response) => {
+            let r: Request = new Request(request);
+            void handler.get(r, new Response(this.$app, response, r.getURL()));
+        });
+        this.$server.post(path, (request: Express.Request, response: Express.Response) => {
+            let r: Request = new Request(request);
+            void handler.post(r, new Response(this.$app, response, r.getURL()));
+        });
+        this.$server.put(path, (request: Express.Request, response: Express.Response) => {
+            let r: Request = new Request(request);
+            void handler.put(r, new Response(this.$app, response, r.getURL()));
+        });
+        this.$server.delete(path, (request: Express.Request, response: Express.Response) => {
+            let r: Request = new Request(request);
+            void handler.delete(r, new Response(this.$app, response, r.getURL()));
+        });
+    }
+}

package/src/IHandlerAttachBridge.ts

@@ -0,0 +1,6 @@
+
+import { Handler } from './Handler';
+
+export interface IHandlerAttachBridge {
+    attach(path: string, handler: Handler): void;
+}

package/src/MySQLConnection.ts

@@ -266,8 +266,8 @@ export class MySQLConnection extends DatabaseConnection<MySQL.PoolConnection> {
             streamOptions = {};
         }
 
-        if (!streamOptions.highWatermark) {
-            streamOptions.highWatermark = DEFAULT_HIGH_WATERMARK;
+        if (!streamOptions.highWaterMark) {
+            streamOptions.highWaterMark = DEFAULT_HIGH_WATERMARK;
         }
 
         let queryObject: MySQL.Query = this.getAPI().query({

package/src/RawHandlerAttacher.ts

@@ -0,0 +1,44 @@
+
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+import Express = require('express');
+import {Application} from './Application';
+import { Handler } from './Handler';
+import { IHandlerAttachBridge } from './IHandlerAttachBridge';
+import {Request} from './Request';
+import {Response} from './Response';
+import * as BodyParser from 'body-parser';
+
+export class RawHandlerAttacher implements IHandlerAttachBridge {
+    private $server: Express.Application;
+    private $app: Application;
+    private $parser: ReturnType<typeof BodyParser.raw>;
+
+    public constructor(app: Application, server: Express.Application) {
+        this.$server = server;
+        this.$app = app;
+
+        this.$parser = BodyParser.raw({
+            type: '*/*',
+            limit: app.getRequestSizeLimit()
+        });
+    }
+
+    public attach(path: string, handler: Handler): void {
+        this.$server.get(path, this.$parser, (request: Express.Request, response: Express.Response) => {
+            let r: Request = new Request(request);
+            void handler.get(r, new Response(this.$app, response, r.getURL()));
+        });
+        this.$server.post(path, this.$parser, (request: Express.Request, response: Express.Response) => {
+            let r: Request = new Request(request);
+            void handler.post(r, new Response(this.$app, response, r.getURL()));
+        });
+        this.$server.put(path, this.$parser, (request: Express.Request, response: Express.Response) => {
+            let r: Request = new Request(request);
+            void handler.put(r, new Response(this.$app, response, r.getURL()));
+        });
+        this.$server.delete(path, this.$parser, (request: Express.Request, response: Express.Response) => {
+            let r: Request = new Request(request);
+            void handler.delete(r, new Response(this.$app, response, r.getURL()));
+        });
+    }
+}