@grandlinex/kernel 0.27.0 → 0.27.1

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [v0.27.1] - 2023-01-26
+### Added
+- Add raw body field for express calls 
+- change BaseEndpoint variables from private to protected
+
 ## [v0.25.2] - 2022-08-07
 ### Added
 - Add express timing api in dev mode

package/dist/Kernel.d.ts

@@ -1,6 +1,6 @@
 import CoreKernel, { CoreLogger } from '@grandlinex/core';
-import { Request } from 'express';
 import { ICClient, IKernel } from './lib';
+import { XRequest } from './lib/express';
 /**
  *  @class Kernel
  */
@@ -23,6 +23,6 @@ export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     setAppServerPort(port: number): void;
     responseCodeFunction(data: {
         code: number;
-        req: Request;
+        req: XRequest;
     }): void;
 }

package/dist/actions/ApiAuthTestAction.d.ts

@@ -1,6 +1,6 @@
-import e from 'express';
 import { IBaseKernelModule } from '../lib';
 import { BaseApiAction, JwtToken } from '../classes';
+import { XRequest, XResponse } from '../lib/express';
 /**
  * @name ApiAuthTestAction
  *
@@ -23,5 +23,5 @@ import { BaseApiAction, JwtToken } from '../classes';
  */
 export default class ApiAuthTestAction extends BaseApiAction {
     constructor(module: IBaseKernelModule<any, any, any, any>);
-    handler(req: e.Request, res: e.Response, next: () => void, data: JwtToken): Promise<void>;
+    handler(req: XRequest, res: XResponse, next: () => void, data: JwtToken): Promise<void>;
 }

package/dist/actions/ApiVersionAction.d.ts

@@ -1,7 +1,7 @@
-import e from 'express';
 import { IBaseKernelModule } from '../lib';
 import { BaseApiAction } from '../classes';
 import { IExtensionInterface } from '../classes/timing/ExpressServerTiming';
+import { XRequest, XResponse } from '../lib/express';
 /**
  * @name ApiVersionAction
  *
@@ -27,5 +27,5 @@ import { IExtensionInterface } from '../classes/timing/ExpressServerTiming';
  */
 export default class ApiVersionAction extends BaseApiAction {
     constructor(module: IBaseKernelModule);
-    handler(req: e.Request, res: e.Response, next: () => void, data: any, ex: IExtensionInterface): Promise<void>;
+    handler(req: XRequest, res: XResponse, next: () => void, data: any, ex: IExtensionInterface): Promise<void>;
 }

package/dist/actions/GetTokenAction.d.ts

@@ -1,7 +1,7 @@
-import { Request, Response } from 'express';
 import { IBaseKernelModule } from '../lib';
 import { BaseApiAction } from '../classes';
 import { IExtensionInterface } from '../classes/timing/ExpressServerTiming';
+import { XRequest, XResponse } from '../lib/express';
 /**
  * @openapi
  * /token:
@@ -40,5 +40,5 @@ export default class GetTokenAction extends BaseApiAction {
      * @param module Parent Module
      */
     constructor(module: IBaseKernelModule<any, any, any, any>);
-    handler(req: Request, res: Response, next: () => void, data: any, ex: IExtensionInterface): Promise<void>;
+    handler(req: XRequest, res: XResponse, next: () => void, data: any, ex: IExtensionInterface): Promise<void>;
 }

package/dist/classes/BaseAction.d.ts

@@ -1,8 +1,8 @@
-import { Request, Response } from 'express';
 import { CoreAction, IDataBase } from '@grandlinex/core';
 import { IBaseAction, IBaseCache, IBaseClient, IBaseKernelModule, IBasePresenter, IKernel } from '../lib';
 import { JwtToken } from './BaseAuthProvider';
 import { IExtensionInterface } from './timing/ExpressServerTiming';
+import { XNextFc, XRequest, XResponse } from '../lib/express';
 export declare enum ActionMode {
     'DEFAULT' = 0,
     'DMZ' = 1,
@@ -11,8 +11,8 @@ export declare enum ActionMode {
 export default abstract class BaseAction<K extends IKernel = IKernel, T extends IDataBase<any, any> | null = any, P extends IBaseClient | null = any, C extends IBaseCache | null = any, E extends IBasePresenter | null = any> extends CoreAction<K, T, P, C, E> implements IBaseAction<K, T, P, C, E> {
     mode: ActionMode;
     constructor(chanel: string, module: IBaseKernelModule<K, T, P, C, E>);
-    abstract handler(req: Request, res: Response, next: () => void, data: JwtToken | null, extension: IExtensionInterface): Promise<void>;
-    secureHandler(req: Request, res: Response, next: () => void): Promise<void>;
+    abstract handler(req: XRequest, res: XResponse, next: XNextFc, data: JwtToken | null, extension: IExtensionInterface): Promise<void>;
+    secureHandler(req: XRequest, res: XResponse, next: () => void): Promise<void>;
     setMode(mode: ActionMode): void;
     abstract register(): void;
     private initExtension;

package/dist/classes/BaseAuthProvider.d.ts

@@ -1,4 +1,4 @@
-import { Request } from 'express';
+import { XRequest } from '../lib/express';
 export interface JwtTokenData {
     username: string;
     userid: string;
@@ -14,10 +14,10 @@ export type AuthResult = {
 export interface IAuthProvider {
     authorizeToken(userid: string, token: string, requestType: string): Promise<AuthResult>;
     validateAccess(token: JwtToken, requestType: string): Promise<boolean>;
-    bearerTokenValidation(req: Request): Promise<JwtToken | null>;
+    bearerTokenValidation(req: XRequest): Promise<JwtToken | null>;
 }
 export default abstract class BaseAuthProvider implements IAuthProvider {
     abstract authorizeToken(username: string, token: string, requestType: string): Promise<AuthResult>;
     abstract validateAccess(token: JwtToken, requestType: string): Promise<boolean>;
-    abstract bearerTokenValidation(req: Request): Promise<JwtToken | null>;
+    abstract bearerTokenValidation(req: XRequest): Promise<JwtToken | null>;
 }

package/dist/classes/BaseEndpoint.d.ts

@@ -1,12 +1,15 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import express from 'express';
 import http from 'http';
 import { CorePresenter, IDataBase } from '@grandlinex/core';
 import { IBaseCache, IBaseClient, IBaseKernelModule, IBasePresenter, IKernel } from '../lib';
+import { XRequest, XResponse } from '../lib/express';
+export declare function keepRawBody(req: XRequest, res: XResponse, buf: Buffer, encoding: string): void;
 export default abstract class BaseEndpoint<K extends IKernel = IKernel, T extends IDataBase<any, any> | null = any, P extends IBaseClient | null = any, C extends IBaseCache | null = any, E extends IBasePresenter | null = any> extends CorePresenter<express.Express, K, T, P, C, E> implements IBasePresenter {
-    private appServer;
-    private httpServer;
-    private port;
+    protected appServer: express.Express;
+    protected httpServer: http.Server;
+    protected port: number;
     constructor(chanel: string, module: IBaseKernelModule<any, any, any, any>, port: number);
     start(): Promise<boolean>;
     stop(): Promise<boolean>;

package/dist/classes/BaseEndpoint.js

@@ -3,16 +3,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.keepRawBody = void 0;
 const express_1 = __importDefault(require("express"));
 const http_1 = __importDefault(require("http"));
 const body_parser_1 = require("body-parser");
 const core_1 = require("@grandlinex/core");
+function keepRawBody(req, res, buf, encoding) {
+    if (buf && buf.length) {
+        try {
+            req.rawBody = buf.toString(encoding || 'utf8');
+        }
+        catch (e) {
+            req.rawBody = null;
+        }
+    }
+}
+exports.keepRawBody = keepRawBody;
 class BaseEndpoint extends core_1.CorePresenter {
     constructor(chanel, module, port) {
         super(`endpoint-${chanel}`, module);
         this.port = port;
         this.appServer = (0, express_1.default)();
-        this.appServer.use((0, body_parser_1.json)());
+        this.appServer.use((0, body_parser_1.json)({ verify: keepRawBody }));
         this.httpServer = http_1.default.createServer(this.appServer);
     }
     start() {

package/dist/classes/index.d.ts

@@ -1,9 +1,9 @@
 import { CoreBridge as BaseBridge, CoreCache as BaseCache, CoreClient as BaseClient, CoreElement as BaseElement, CoreLoopService as BaseLoopService, CoreService as BaseService } from '@grandlinex/core';
 import BaseAction from './BaseAction';
-import BaseEndpoint from './BaseEndpoint';
+import BaseEndpoint, { keepRawBody } from './BaseEndpoint';
 import BaseKernelModule from './BaseKernelModule';
 import BaseApiAction from './BaseApiAction';
 import BaseAuthProvider from './BaseAuthProvider';
 export * from './BaseAuthProvider';
 export * from './timing';
-export { BaseLoopService, BaseAuthProvider, BaseKernelModule, BaseService, BaseApiAction, BaseEndpoint, BaseElement, BaseCache, BaseAction, BaseClient, BaseBridge, };
+export { BaseLoopService, BaseAuthProvider, BaseKernelModule, BaseService, BaseApiAction, BaseEndpoint, BaseElement, BaseCache, BaseAction, BaseClient, BaseBridge, keepRawBody, };

package/dist/classes/index.js

@@ -10,6 +10,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
@@ -17,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseBridge = exports.BaseClient = exports.BaseAction = exports.BaseCache = exports.BaseElement = exports.BaseEndpoint = exports.BaseApiAction = exports.BaseService = exports.BaseKernelModule = exports.BaseAuthProvider = exports.BaseLoopService = void 0;
+exports.keepRawBody = exports.BaseBridge = exports.BaseClient = exports.BaseAction = exports.BaseCache = exports.BaseElement = exports.BaseEndpoint = exports.BaseApiAction = exports.BaseService = exports.BaseKernelModule = exports.BaseAuthProvider = exports.BaseLoopService = void 0;
 const core_1 = require("@grandlinex/core");
 Object.defineProperty(exports, "BaseBridge", { enumerable: true, get: function () { return core_1.CoreBridge; } });
 Object.defineProperty(exports, "BaseCache", { enumerable: true, get: function () { return core_1.CoreCache; } });
@@ -27,8 +39,9 @@ Object.defineProperty(exports, "BaseLoopService", { enumerable: true, get: funct
 Object.defineProperty(exports, "BaseService", { enumerable: true, get: function () { return core_1.CoreService; } });
 const BaseAction_1 = __importDefault(require("./BaseAction"));
 exports.BaseAction = BaseAction_1.default;
-const BaseEndpoint_1 = __importDefault(require("./BaseEndpoint"));
+const BaseEndpoint_1 = __importStar(require("./BaseEndpoint"));
 exports.BaseEndpoint = BaseEndpoint_1.default;
+Object.defineProperty(exports, "keepRawBody", { enumerable: true, get: function () { return BaseEndpoint_1.keepRawBody; } });
 const BaseKernelModule_1 = __importDefault(require("./BaseKernelModule"));
 exports.BaseKernelModule = BaseKernelModule_1.default;
 const BaseApiAction_1 = __importDefault(require("./BaseApiAction"));

package/dist/classes/timing/ExpressServerTiming.d.ts

@@ -1,5 +1,5 @@
-import { Response } from 'express';
 import { CoreElement } from '@grandlinex/core';
+import { XResponse } from '../../lib/express';
 export type IExtensionInterface = {
     done: () => void;
     timing: ExpressServerTiming;
@@ -12,6 +12,6 @@ export default class ExpressServerTiming {
     startFunc<T>(chanel: string, fc: () => Promise<T>): Promise<T>;
     dbQuery<T>(fc: () => Promise<T>): Promise<T>;
     getHeader(): string;
-    addHeader(res: Response): void;
-    static init(baseApiAction: CoreElement<any>, res: Response): [ExpressServerTiming, () => void];
+    addHeader(res: XResponse): void;
+    static init(baseApiAction: CoreElement<any>, res: XResponse): [ExpressServerTiming, () => void];
 }

package/dist/index.d.ts

@@ -9,6 +9,7 @@ export * from './api';
 export * from './classes';
 export * from './modules/crypto';
 export * from './lib';
+export * from './lib/express';
 export * from '@grandlinex/core';
 export { KernelModule, Kernel };
 export default Kernel;

package/dist/index.js

@@ -31,5 +31,6 @@ __exportStar(require("./api"), exports);
 __exportStar(require("./classes"), exports);
 __exportStar(require("./modules/crypto"), exports);
 __exportStar(require("./lib"), exports);
+__exportStar(require("./lib/express"), exports);
 __exportStar(require("@grandlinex/core"), exports);
 exports.default = Kernel_1.default;

package/dist/lib/express.d.ts

@@ -0,0 +1,6 @@
+import express from 'express';
+export type XRequest = express.Request & {
+    rawBody?: string | null | undefined;
+};
+export type XResponse = express.Response;
+export type XNextFc = express.NextFunction;

package/dist/lib/express.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/lib/index.d.ts

@@ -1,7 +1,8 @@
-import express, { Request, Response } from 'express';
 import { ICoreAction, ICoreBridge, ICoreCache, ICoreCClient, ICoreClient, ICoreElement, ICoreKernel, ICoreKernelModule, ICorePresenter, ICoreService, IDataBase } from '@grandlinex/core';
+import express from 'express';
 import { IAuthProvider, JwtToken } from '../classes/BaseAuthProvider';
 import { IExtensionInterface } from '../classes/timing/ExpressServerTiming';
+import { XNextFc, XRequest, XResponse } from './express';
 export type ActionTypes = 'POST' | 'GET' | 'USE' | 'PATCH' | 'DELETE';
 export interface ICClient extends ICoreCClient {
     setAuthProvider(provider: IAuthProvider): boolean;
@@ -14,14 +15,14 @@ export interface ICClient extends ICoreCClient {
         userId: string | null;
     }>;
     permissionValidation(token: JwtToken, requestType: string): Promise<boolean>;
-    bearerTokenValidation(req: Request): Promise<JwtToken | null>;
+    bearerTokenValidation(req: XRequest): Promise<JwtToken | null>;
 }
 export interface IKernel extends ICoreKernel<ICClient> {
     getAppServerPort(): number;
     setAppServerPort(port: number): void;
     responseCodeFunction(data: {
         code: number;
-        req: Request;
+        req: XRequest;
     }): void;
 }
 export type IBaseKernelModule<K extends IKernel = IKernel, T extends IDataBase<any, any> | null = any, P extends IBaseClient | null = any, C extends IBaseCache | null = any, E extends IBasePresenter | null = any> = ICoreKernelModule<K, T, P, C, E>;
@@ -32,5 +33,5 @@ export type IBaseBrige = ICoreBridge;
 export type IBaseCache<K extends IKernel = IKernel, T extends IDataBase<any, any> | null = any, P extends IBaseClient | null = any, C extends IBaseCache | null = any, E extends IBasePresenter | null = any> = ICoreCache<K, T, P, C, E>;
 export type IBaseElement<K extends IKernel = IKernel, T extends IDataBase<any, any> | null = any, P extends IBaseClient | null = any, C extends IBaseCache | null = any, E extends IBasePresenter | null = any> = ICoreElement<K, T, P, C, E>;
 export interface IBaseAction<K extends IKernel = IKernel, T extends IDataBase<any, any> | null = any, P extends IBaseClient | null = any, C extends IBaseCache | null = any, E extends IBasePresenter | null = any> extends ICoreAction<K, T, P, C, E> {
-    handler(req: Request, res: Response, next: () => void, data: JwtToken | null, extension: IExtensionInterface): Promise<void>;
+    handler(req: XRequest, res: XResponse, next: XNextFc, data: JwtToken | null, extension: IExtensionInterface): Promise<void>;
 }

package/dist/modules/crypto/CryptoClient.d.ts

@@ -1,7 +1,7 @@
-import { Request } from 'express';
 import { CoreCryptoClient } from '@grandlinex/core';
 import { ICClient, IKernel } from '../../lib';
 import { IAuthProvider, JwtToken, JwtTokenData } from '../../classes/BaseAuthProvider';
+import { XRequest } from '../../lib/express';
 export default class CryptoClient extends CoreCryptoClient implements ICClient {
     protected authProvider: IAuthProvider | null;
     protected kernel: IKernel;
@@ -15,5 +15,5 @@ export default class CryptoClient extends CoreCryptoClient implements ICClient {
         userId: string | null;
     }>;
     permissionValidation(token: JwtToken, requestType: string): Promise<boolean>;
-    bearerTokenValidation(req: Request): Promise<JwtToken | null>;
+    bearerTokenValidation(req: XRequest): Promise<JwtToken | null>;
 }

package/dist/modules/crypto/utils/cors.d.ts

@@ -1,3 +1,3 @@
-import { NextFunction, Request, Response } from 'express';
-export type CorsMiddleWare = (req: Request, res: Response, next: NextFunction) => void;
+import { XNextFc, XRequest, XResponse } from '../../../lib/express';
+export type CorsMiddleWare = (req: XRequest, res: XResponse, next: XNextFc) => void;
 export declare const cors: CorsMiddleWare;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grandlinex/kernel",
-  "version": "0.27.0",
+  "version": "0.27.1",
   "description": "GrandLineX is an out-of-the-box server framework on top of ExpressJs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -27,11 +27,11 @@
   },
   "license": "BSD-3-Clause",
   "dependencies": {
-    "@grandlinex/core": "^0.27.0",
-    "axios": "^0.27.2",
-    "body-parser": "^1.20.1",
-    "express": "^4.18.2",
-    "jsonwebtoken": "^8.5.1"
+    "@grandlinex/core": "0.27.0",
+    "axios": "0.27.2",
+    "body-parser": "1.20.1",
+    "express": "4.18.2",
+    "jsonwebtoken": "9.0.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.14",