@grandlinex/kernel 1.0.2 → 1.1.1

package/dist/mjs/actions/ApiVersionAction.d.ts

@@ -1,7 +1,5 @@
-import { IBaseKernelModule } from '../lib/index.js';
-import { BaseApiAction } from '../classes/index.js';
+import { RouteApiAction } from '../classes/index.js';
 import { XActionEvent } from '../lib/express.js';
-export default class ApiVersionAction extends BaseApiAction {
-    constructor(module: IBaseKernelModule);
+export default class ApiVersionAction extends RouteApiAction {
     handler({ res, extension }: XActionEvent): Promise<void>;
 }

package/dist/mjs/actions/ApiVersionAction.js

@@ -4,17 +4,10 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 import { SPath, SPathUtil } from '@grandlinex/swagger-mate';
-import { ActionMode, BaseApiAction } from '../classes/index.js';
-let ApiVersionAction = class ApiVersionAction extends BaseApiAction {
-    constructor(module) {
-        super('GET', '/version', module);
-        this.handler = this.handler.bind(this);
-        this.setMode(ActionMode.DMZ);
-    }
+import { ActionMode, RouteApiAction } from '../classes/index.js';
+import { Route } from '../annotation/index.js';
+let ApiVersionAction = class ApiVersionAction extends RouteApiAction {
     async handler({ res, extension }) {
         extension.done();
         res.status(200).send({ api: this.getKernel().getApiVersion() });
@@ -39,6 +32,6 @@ ApiVersionAction = __decorate([
             },
         },
     }),
-    __metadata("design:paramtypes", [Object])
+    Route('GET', '/version', ActionMode.DMZ)
 ], ApiVersionAction);
 export default ApiVersionAction;

package/dist/mjs/actions/GetTokenAction.d.ts

@@ -1,11 +1,10 @@
-import { IBaseKernelModule } from '../lib/index.js';
-import { BaseApiAction, JwtToken } from '../classes/index.js';
+import { JwtToken, RouteApiAction } from '../classes/index.js';
 import { XActionEvent } from '../lib/express.js';
-export default class GetTokenAction extends BaseApiAction {
-    /**
-     *
-     * @param module Parent Module
-     */
-    constructor(module: IBaseKernelModule<any, any, any, any>);
-    handler({ req, res, extension, }: XActionEvent<JwtToken>): Promise<void>;
+type SchemaType = {
+    username: string;
+    token: string;
+};
+export default class GetTokenAction extends RouteApiAction {
+    handler({ req, res, extension, body, }: XActionEvent<JwtToken, SchemaType>): Promise<void>;
 }
+export {};

package/dist/mjs/actions/GetTokenAction.js

@@ -4,32 +4,25 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
 import { SPath, SPathUtil } from '@grandlinex/swagger-mate';
-import { ActionMode, BaseApiAction } from '../classes/index.js';
-let GetTokenAction = class GetTokenAction extends BaseApiAction {
-    /**
-     *
-     * @param module Parent Module
-     */
-    constructor(module) {
-        super('POST', '/token', module);
-        this.handler = this.handler.bind(this);
-        this.setMode(ActionMode.DMZ);
-    }
-    async handler({ req, res, extension, }) {
+import { ActionMode, RouteApiAction } from '../classes/index.js';
+import { Route } from '../annotation/index.js';
+const schema = {
+    type: 'object',
+    properties: {
+        username: {
+            type: 'string',
+        },
+        token: {
+            type: 'string',
+        },
+    },
+    required: ['username', 'token'],
+};
+let GetTokenAction = class GetTokenAction extends RouteApiAction {
+    async handler({ req, res, extension, body, }) {
         const cc = this.getKernel().getCryptoClient();
-        if (!req.body.token) {
-            res.status(400).send('no token');
-            return;
-        }
-        if (!req.body.username) {
-            res.status(401).send('no username');
-            return;
-        }
-        const { username, token } = req.body;
+        const { username, token } = body;
         const valid = await extension.timing.startFunc('validation', () => cc.apiTokenValidation(username, token, 'api'));
         if (valid.valid && valid.userId) {
             const jwt = await cc.jwtGenerateAccessToken({
@@ -51,18 +44,7 @@ GetTokenAction = __decorate([
                 operationId: 'getToken',
                 summary: 'Get API token',
                 tags: ['kernel'],
-                requestBody: SPathUtil.jsonBody({
-                    type: 'object',
-                    properties: {
-                        username: {
-                            type: 'string',
-                        },
-                        token: {
-                            type: 'string',
-                        },
-                    },
-                    required: ['username', 'token'],
-                }),
+                requestBody: SPathUtil.jsonBody(schema),
                 responses: SPathUtil.jsonResponse('200', {
                     type: 'object',
                     properties: {
@@ -75,6 +57,6 @@ GetTokenAction = __decorate([
             },
         },
     }),
-    __metadata("design:paramtypes", [Object])
+    Route('POST', '/token', ActionMode.DMZ, schema)
 ], GetTokenAction);
 export default GetTokenAction;

package/dist/mjs/annotation/index.d.ts

@@ -0,0 +1,13 @@
+import 'reflect-metadata';
+import { ObjectLike } from '@grandlinex/core';
+import { SSchemaEl } from '@grandlinex/swagger-mate';
+import { ActionTypes } from '../lib/index.js';
+import { ActionMode } from '../classes/index.js';
+export type RouteMeta = {
+    type: ActionTypes;
+    path: string;
+    mode?: ActionMode;
+    schema?: SSchemaEl;
+};
+export declare const Route: (type: ActionTypes, path: string, mode?: ActionMode, schema?: SSchemaEl) => ClassDecorator;
+export declare function getRouteMeta<T extends ObjectLike>(target: T): RouteMeta | undefined;

package/dist/mjs/annotation/index.js

@@ -0,0 +1,16 @@
+import 'reflect-metadata';
+const routeKey = Symbol('route');
+export const Route = (type, path, mode, schema) => {
+    return (target) => {
+        const metadata = {
+            type,
+            path,
+            mode,
+            schema,
+        };
+        Reflect.defineMetadata(routeKey, metadata, target.prototype);
+    };
+};
+export function getRouteMeta(target) {
+    return Reflect.getMetadata(routeKey, target.constructor.prototype);
+}

package/dist/mjs/classes/BaseAction.d.ts

@@ -1,4 +1,5 @@
 import { CoreAction, IDataBase } from '@grandlinex/core';
+import { ErrorType, SSchemaEl } from '@grandlinex/swagger-mate';
 import { IBaseAction, IBaseCache, IBaseClient, IBaseKernelModule, IBasePresenter, IKernel } from '../lib/index.js';
 import { XActionEvent, XRequest, XResponse } from '../lib/express.js';
 export declare enum ActionMode {
@@ -9,8 +10,12 @@ 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;
     forceDebug: boolean;
+    schema: SSchemaEl | null;
     constructor(chanel: string, module: IBaseKernelModule<K, T, P, C, E>);
     abstract handler(event: XActionEvent): Promise<void>;
+    static validateSchema(error: ErrorType, schema: SSchemaEl, key: string, field: any, required?: boolean): void;
+    bodyValidation<A>(req: XRequest): A | ErrorType | null;
+    static sendError(res: XResponse, code: number, error: Partial<ErrorType>): void;
     secureHandler(req: XRequest, res: XResponse, next: () => void): Promise<void>;
     setMode(mode: ActionMode): void;
     abstract register(): void;

package/dist/mjs/classes/BaseAction.js

@@ -1,4 +1,5 @@
 import { CoreAction } from '@grandlinex/core';
+import { isErrorType, isSwaggerRef, } from '@grandlinex/swagger-mate';
 import { ExpressServerTiming } from './timing/index.js';
 import { BaseUserAgent } from './BaseUserAgent.js';
 export var ActionMode;
@@ -13,6 +14,102 @@ export default class BaseAction extends CoreAction {
         this.secureHandler = this.secureHandler.bind(this);
         this.mode = ActionMode.DEFAULT;
         this.forceDebug = false;
+        this.schema = null;
+    }
+    static validateSchema(error, schema, key, field, required = true) {
+        if (isSwaggerRef(schema)) {
+            error.field?.push({
+                key,
+                message: `Ref schema body validation is not supported yet`,
+            });
+            return;
+        }
+        if (!required && (field === undefined || field === null)) {
+            return;
+        }
+        switch (schema?.type) {
+            case 'boolean':
+                if (typeof field !== 'boolean') {
+                    error.field?.push({
+                        key,
+                        message: `must be a boolean`,
+                    });
+                }
+                break;
+            case 'integer':
+            case 'number':
+                if (typeof field !== 'number') {
+                    error.field?.push({
+                        key,
+                        message: `must be a number`,
+                    });
+                }
+                break;
+            case 'string':
+                if (typeof field !== 'string') {
+                    error.field?.push({
+                        key,
+                        message: `must be a string`,
+                    });
+                }
+                break;
+            case 'array':
+                if (!Array.isArray(field)) {
+                    error.field?.push({
+                        key,
+                        message: `must be a array`,
+                    });
+                }
+                if (schema.items) {
+                    field.forEach((it, id) => {
+                        this.validateSchema(error, schema.items, `${key}[${id}]`, it);
+                    });
+                }
+                break;
+            case 'object':
+                if (typeof field !== 'object') {
+                    error.field?.push({
+                        key,
+                        message: `must be a object`,
+                    });
+                }
+                if (schema.properties) {
+                    Object.entries(schema.properties).forEach(([k, s]) => {
+                        this.validateSchema(error, s, `${key}.${k}`, field[k], schema.required ? schema.required.includes(k) : false);
+                    });
+                }
+                break;
+            case undefined:
+            default:
+                error.field?.push({
+                    key,
+                    message: `Schema type is not defined or not supported`,
+                });
+        }
+    }
+    bodyValidation(req) {
+        if (!this.schema) {
+            return null;
+        }
+        if (!req.body) {
+            return null;
+        }
+        const error = {
+            type: 'error',
+            global: [],
+            field: [],
+        };
+        BaseAction.validateSchema(error, this.schema, 'body', req.body);
+        if (error.field.length > 0 || error.global.length > 0) {
+            return error;
+        }
+        return req.body;
+    }
+    static sendError(res, code, error) {
+        res.status(code).send({
+            type: 'error',
+            ...error,
+        });
     }
     async secureHandler(req, res, next) {
         const extension = this.initExtension(res);
@@ -31,6 +128,18 @@ export default class BaseAction extends CoreAction {
         if (this.mode === ActionMode.DMZ) {
             auth.stop();
             try {
+                let body = null;
+                if (this.schema) {
+                    body = this.bodyValidation(req);
+                }
+                if (isErrorType(body)) {
+                    res.status(400).send(body);
+                    return;
+                }
+                if (this.schema && body === null) {
+                    res.sendStatus(400);
+                    return;
+                }
                 await this.handler({
                     res,
                     req,
@@ -38,6 +147,8 @@ export default class BaseAction extends CoreAction {
                     data: null,
                     extension,
                     agent: new BaseUserAgent(req),
+                    body,
+                    sendError: (code, error) => BaseAction.sendError(res, code, error),
                 });
             }
             catch (e) {
@@ -53,6 +164,18 @@ export default class BaseAction extends CoreAction {
         auth.stop();
         if (dat && typeof dat !== 'number') {
             try {
+                let body = null;
+                if (this.schema) {
+                    body = this.bodyValidation(req);
+                }
+                if (isErrorType(body)) {
+                    res.status(400).send(body);
+                    return;
+                }
+                if (this.schema && body === null) {
+                    res.sendStatus(400);
+                    return;
+                }
                 await this.handler({
                     res,
                     req,
@@ -60,6 +183,8 @@ export default class BaseAction extends CoreAction {
                     data: dat,
                     extension,
                     agent: new BaseUserAgent(req),
+                    body,
+                    sendError: (code, error) => BaseAction.sendError(res, code, error),
                 });
             }
             catch (e) {
@@ -72,6 +197,18 @@ export default class BaseAction extends CoreAction {
         }
         else if (this.mode === ActionMode.DMZ_WITH_USER) {
             try {
+                let body = null;
+                if (this.schema) {
+                    body = this.bodyValidation(req);
+                }
+                if (isErrorType(body)) {
+                    res.status(400).send(body);
+                    return;
+                }
+                if (this.schema && body === null) {
+                    res.sendStatus(400);
+                    return;
+                }
                 await this.handler({
                     res,
                     req,
@@ -79,6 +216,8 @@ export default class BaseAction extends CoreAction {
                     data: null,
                     extension,
                     agent: new BaseUserAgent(req),
+                    body,
+                    sendError: (code, error) => BaseAction.sendError(res, code, error),
                 });
             }
             catch (e) {
@@ -93,7 +232,7 @@ export default class BaseAction extends CoreAction {
             res.sendStatus(dat);
         }
         else {
-            res.status(401).send('no no no ...');
+            res.sendStatus(401);
         }
     }
     setMode(mode) {

package/dist/mjs/classes/BaseApiAction.js

@@ -11,7 +11,7 @@ export default class BaseApiAction extends BaseAction {
             endpoint = this.exmod.getPresenter();
         }
         else {
-            endpoint = this.getModule().getPresenter();
+            endpoint = this.getKernel().getModule().getPresenter();
         }
         if (endpoint) {
             this.debug(`register ${this.type} ${this.getName()}`);

package/dist/mjs/classes/RouteApiAction.d.ts

@@ -0,0 +1,6 @@
+import { IDataBase } from '@grandlinex/core';
+import { IBaseAction, IBaseCache, IBaseClient, IBaseKernelModule, IBasePresenter, IKernel } from '../lib/index.js';
+import BaseApiAction from './BaseApiAction.js';
+export default abstract class RouteApiAction<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 BaseApiAction<K, T, P, C, E> implements IBaseAction<K, T, P, C, E> {
+    constructor(module: IBaseKernelModule<K, T, P, C, E>, extMod?: IBaseKernelModule<K>);
+}

package/dist/mjs/classes/RouteApiAction.js

@@ -0,0 +1,19 @@
+import { getRouteMeta } from '../annotation/index.js';
+import BaseApiAction from './BaseApiAction.js';
+export default class RouteApiAction extends BaseApiAction {
+    constructor(module, extMod) {
+        super('GET', 'action', module, extMod);
+        this.exmod = extMod;
+        const meta = getRouteMeta(this);
+        if (!meta) {
+            throw this.lError('No route meta found for action');
+        }
+        const { type, path, mode, schema } = meta;
+        this.type = type;
+        this.channel = path;
+        if (mode) {
+            this.setMode(mode);
+        }
+        this.schema = schema ?? null;
+    }
+}

package/dist/mjs/classes/index.d.ts

@@ -3,9 +3,10 @@ import BaseAction, { ActionMode } from './BaseAction.js';
 import BaseEndpoint, { keepRawBody } from './BaseEndpoint.js';
 import BaseKernelModule from './BaseKernelModule.js';
 import BaseApiAction from './BaseApiAction.js';
+import RouteApiAction from './RouteApiAction.js';
 import BaseAuthProvider from './BaseAuthProvider.js';
 export * from './BaseAction.js';
 export * from './BaseUserAgent.js';
 export * from './BaseAuthProvider.js';
 export * from './timing/index.js';
-export { BaseLoopService, BaseAuthProvider, BaseKernelModule, BaseService, BaseApiAction, BaseEndpoint, BaseElement, BaseCache, BaseAction, BaseClient, BaseBridge, keepRawBody, ActionMode, };
+export { BaseLoopService, BaseAuthProvider, BaseKernelModule, BaseService, BaseApiAction, BaseEndpoint, BaseElement, RouteApiAction, BaseCache, BaseAction, BaseClient, BaseBridge, keepRawBody, ActionMode, };

package/dist/mjs/classes/index.js

@@ -3,9 +3,10 @@ import BaseAction, { ActionMode } from './BaseAction.js';
 import BaseEndpoint, { keepRawBody } from './BaseEndpoint.js';
 import BaseKernelModule from './BaseKernelModule.js';
 import BaseApiAction from './BaseApiAction.js';
+import RouteApiAction from './RouteApiAction.js';
 import BaseAuthProvider from './BaseAuthProvider.js';
 export * from './BaseAction.js';
 export * from './BaseUserAgent.js';
 export * from './BaseAuthProvider.js';
 export * from './timing/index.js';
-export { BaseLoopService, BaseAuthProvider, BaseKernelModule, BaseService, BaseApiAction, BaseEndpoint, BaseElement, BaseCache, BaseAction, BaseClient, BaseBridge, keepRawBody, ActionMode, };
+export { BaseLoopService, BaseAuthProvider, BaseKernelModule, BaseService, BaseApiAction, BaseEndpoint, BaseElement, RouteApiAction, BaseCache, BaseAction, BaseClient, BaseBridge, keepRawBody, ActionMode, };

package/dist/mjs/index.d.ts

@@ -6,6 +6,7 @@ import Kernel from './Kernel.js';
 import KernelModule from './KernelModule.js';
 export * from './actions/index.js';
 export * from './api/index.js';
+export * from './annotation/index.js';
 export * from './classes/index.js';
 export * from './modules/crypto/index.js';
 export * from './lib/index.js';

package/dist/mjs/index.js

@@ -6,6 +6,7 @@ import Kernel from './Kernel.js';
 import KernelModule from './KernelModule.js';
 export * from './actions/index.js';
 export * from './api/index.js';
+export * from './annotation/index.js';
 export * from './classes/index.js';
 export * from './modules/crypto/index.js';
 export * from './lib/index.js';

package/dist/mjs/lib/express.d.ts

@@ -1,15 +1,18 @@
 import express from 'express';
+import { ErrorType } from '@grandlinex/swagger-mate';
 import { BaseUserAgent, IExtensionInterface, JwtToken } from '../classes/index.js';
 export type XRequest = express.Request & {
     rawBody?: string | null;
 };
 export type XResponse = express.Response;
 export type XNextFc = express.NextFunction;
-export type XActionEvent<G = JwtToken | null> = {
+export type XActionEvent<G = JwtToken | null, B = any> = {
     req: XRequest;
     res: XResponse;
     next: XNextFc;
     data: G;
     extension: IExtensionInterface;
     agent: BaseUserAgent;
+    body: B;
+    sendError: (code: number, error: Partial<ErrorType>) => void;
 };

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

@@ -1,16 +1,17 @@
 import { CoreCryptoClient } from '@grandlinex/core';
+import { type StringValue } from 'ms';
 import { ICClient, IKernel } from '../../lib/index.js';
 import { IAuthProvider, JwtExtend, JwtToken } from '../../classes/index.js';
 import { XRequest } from '../../lib/express.js';
 export default class CryptoClient<T extends JwtExtend = JwtExtend> extends CoreCryptoClient implements ICClient<T> {
     protected authProvider: IAuthProvider<T> | null;
     protected kernel: IKernel;
-    protected expiresIn: string;
+    protected expiresIn: StringValue;
     constructor(key: string, kernel: IKernel);
     setAuthProvider(provider: IAuthProvider<T>): boolean;
     jwtVerifyAccessToken(token: string): Promise<JwtToken<T> | number>;
     jwtDecodeAccessToken(token: string): JwtToken<T> | null;
-    jwtGenerateAccessToken(data: JwtToken<T>, extend?: Record<string, any>, expire?: string | number): Promise<string>;
+    jwtGenerateAccessToken(data: JwtToken<T>, extend?: Record<string, any>, expire?: StringValue | number): Promise<string>;
     apiTokenValidation(username: string, token: string, requestType: string): Promise<{
         valid: boolean;
         userId: string | null;

package/dist/mjs/modules/crypto/CryptoClient.js

@@ -5,7 +5,8 @@ export default class CryptoClient extends CoreCryptoClient {
         super(kernel, key);
         this.kernel = kernel;
         this.authProvider = null;
-        this.expiresIn = kernel.getConfigStore().get('JWT_EXPIRE') || '1 days';
+        this.expiresIn = (kernel.getConfigStore().get('JWT_EXPIRE') ||
+            '1 days');
     }
     setAuthProvider(provider) {
         if (this.authProvider) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grandlinex/kernel",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "GrandLineX is an out-of-the-box server framework on top of ExpressJs.",
   "type": "module",
   "exports": {
@@ -31,7 +31,7 @@
     "doc-converage": "jest --runInBand --ci --collectCoverage   --coverageDirectory=\"./docs/coverage\"  --reporters=default --reporters=jest-junit",
     "makeDocs": "typedoc",
     "openDocs": "npm run makeDocs",
-    "makeSpec": "makeOpenApi"
+    "makeSpec": "swagger-mate"
   },
   "keywords": [
     "typescript",
@@ -46,22 +46,23 @@
   },
   "license": "BSD-3-Clause",
   "dependencies": {
-    "@grandlinex/core": "1.0.1",
-    "@grandlinex/swagger-mate": "1.0.2",
-    "axios": "1.10.0",
+    "reflect-metadata": "0.2.2",
+    "@grandlinex/core": "1.1.1",
+    "@grandlinex/swagger-mate": "1.1.1",
+    "axios": "1.11.0",
     "body-parser": "1.20.3",
     "express": "5.1.0",
     "jsonwebtoken": "9.0.2",
     "@types/express": "5.0.3",
-    "@types/jsonwebtoken": "9.0.6"
+    "@types/jsonwebtoken": "9.0.10",
+    "@types/ms": "2.1.0"
   },
   "devDependencies": {
     "@types/jest": "29.5.14",
-    "@types/node": "22.15.32",
+    "@types/node": "22.15.20",
     "@typescript-eslint/eslint-plugin": "7.18.0",
     "@typescript-eslint/parser": "7.18.0",
-    "cross-env": "7.0.3",
-    "eslint": "8.57.0",
+    "eslint": "8.57.1",
     "eslint-config-airbnb": "19.0.4",
     "eslint-config-airbnb-typescript": "18.0.0",
     "eslint-config-prettier": "9.1.0",
@@ -71,12 +72,12 @@
     "eslint-plugin-prettier": "5.2.1",
     "jest": "29.7.0",
     "jest-junit": "16.0.0",
-    "prettier": "3.3.3",
+    "prettier": "3.5.3",
     "ts-jest": "29.3.4",
     "ts-loader": "9.5.2",
     "ts-node": "10.9.2",
-    "typedoc": "0.28.5",
-    "typescript": "5.8.3"
+    "typedoc": "0.28.10",
+    "typescript": "5.9.2"
   },
   "engines": {
     "node": ">=22.0.0"