@grandlinex/kernel 0.32.0 → 0.32.10

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [v0.32.10] - 2023-10-06
+### Changed
+- Breaking Change: BaseApiAction now use XActionEvent
+
 ## [v0.31.1] - 2023-07-07
 ### Added
 - @/token pass the token body to jwt generator function

package/dist/cjs/Kernel.d.ts

@@ -1,4 +1,4 @@
-import { CoreLogger, CoreKernel } from '@grandlinex/core';
+import { CoreKernel, CoreLogger } from '@grandlinex/core';
 import { ICClient, IKernel } from './lib/index.js';
 import { XRequest } from './lib/express.js';
 /**
@@ -6,6 +6,7 @@ import { XRequest } from './lib/express.js';
  */
 export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     private expressPort;
+    private readonly apiVersion;
     /**
      * Default Constructor
      * @param options App Name
@@ -13,6 +14,7 @@ export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     constructor(options: {
         appName: string;
         appCode: string;
+        apiVersion?: number;
         pathOverride?: string;
         portOverride?: number;
         envFilePath?: string;
@@ -21,6 +23,7 @@ export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     });
     getAppServerPort(): number;
     setAppServerPort(port: number): void;
+    getApiVersion(): number;
     responseCodeFunction(data: {
         code: number;
         req: XRequest;

package/dist/cjs/Kernel.js

@@ -16,6 +16,7 @@ class Kernel extends core_1.CoreKernel {
      */
     constructor(options) {
         super({ ...options });
+        this.apiVersion = options.apiVersion ?? 1;
         this.setBaseModule(new KernelModule_js_1.default(this));
         if (options.portOverride) {
             this.debug(`use custiom api port @ ${options.portOverride}`);
@@ -35,6 +36,9 @@ class Kernel extends core_1.CoreKernel {
     setAppServerPort(port) {
         this.expressPort = port;
     }
+    getApiVersion() {
+        return this.apiVersion;
+    }
     responseCodeFunction(data) {
         const { code } = data;
         if (code < 200 || code >= 300) {

package/dist/cjs/actions/ApiAuthTestAction.d.ts

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

package/dist/cjs/actions/ApiAuthTestAction.js

@@ -1,18 +1,37 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const swagger_mate_1 = require("@grandlinex/swagger-mate");
 const index_js_1 = require("../classes/index.js");
-/**
- * @name ApiAuthTestAction
- *
- */
-class ApiAuthTestAction extends index_js_1.BaseApiAction {
+let ApiAuthTestAction = class ApiAuthTestAction extends index_js_1.BaseApiAction {
     constructor(module) {
         super('GET', '/test/auth', module);
         this.handler = this.handler.bind(this);
     }
-    async handler(req, res, next, data) {
+    async handler({ data, res }) {
         this.debug(data.userid);
         res.status(200).send("It work's");
     }
-}
+};
+ApiAuthTestAction = __decorate([
+    (0, swagger_mate_1.SPath)({
+        '/test/auth': {
+            get: {
+                operationId: 'testAuth',
+                summary: 'Test user auth',
+                tags: ['kernel'],
+                responses: swagger_mate_1.SPathUtil.defaultResponse('200', '403'),
+            },
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
+], ApiAuthTestAction);
 exports.default = ApiAuthTestAction;

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

@@ -1,11 +1,7 @@
 import { IBaseKernelModule } from '../lib/index.js';
-import { BaseApiAction, IExtensionInterface } from '../classes/index.js';
-import { XRequest, XResponse } from '../lib/express.js';
-/**
- * @name ApiVersionAction
- *
- */
+import { BaseApiAction } from '../classes/index.js';
+import { XActionEvent } from '../lib/express.js';
 export default class ApiVersionAction extends BaseApiAction {
     constructor(module: IBaseKernelModule);
-    handler(req: XRequest, res: XResponse, next: () => void, data: any, ex: IExtensionInterface): Promise<void>;
+    handler({ res, extension }: XActionEvent): Promise<void>;
 }

package/dist/cjs/actions/ApiVersionAction.js

@@ -1,19 +1,46 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const swagger_mate_1 = require("@grandlinex/swagger-mate");
 const index_js_1 = require("../classes/index.js");
-/**
- * @name ApiVersionAction
- *
- */
-class ApiVersionAction extends index_js_1.BaseApiAction {
+let ApiVersionAction = class ApiVersionAction extends index_js_1.BaseApiAction {
     constructor(module) {
         super('GET', '/version', module);
         this.handler = this.handler.bind(this);
         this.setMode(index_js_1.ActionMode.DMZ);
     }
-    async handler(req, res, next, data, ex) {
-        ex.done();
-        res.status(200).send({ api: 1 });
+    async handler({ res, extension }) {
+        extension.done();
+        res.status(200).send({ api: this.getKernel().getApiVersion() });
     }
-}
+};
+ApiVersionAction = __decorate([
+    (0, swagger_mate_1.SPath)({
+        '/version': {
+            get: {
+                operationId: 'getVersion',
+                summary: 'Get API version',
+                tags: ['kernel'],
+                responses: swagger_mate_1.SPathUtil.jsonResponse('200', {
+                    type: 'object',
+                    properties: {
+                        api: {
+                            type: 'number',
+                        },
+                    },
+                    required: ['api'],
+                }, false, '403'),
+            },
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
+], ApiVersionAction);
 exports.default = ApiVersionAction;

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

@@ -1,11 +1,11 @@
 import { IBaseKernelModule } from '../lib/index.js';
-import { BaseApiAction, IExtensionInterface } from '../classes/index.js';
-import { XRequest, XResponse } from '../lib/express.js';
+import { BaseApiAction, JwtToken } 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: XRequest, res: XResponse, next: () => void, data: any, ex: IExtensionInterface): Promise<void>;
+    handler({ req, res, extension, }: XActionEvent<JwtToken>): Promise<void>;
 }

package/dist/cjs/actions/GetTokenAction.js

@@ -1,7 +1,17 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const swagger_mate_1 = require("@grandlinex/swagger-mate");
 const index_js_1 = require("../classes/index.js");
-class GetTokenAction extends index_js_1.BaseApiAction {
+let GetTokenAction = class GetTokenAction extends index_js_1.BaseApiAction {
     /**
      *
      * @param module Parent Module
@@ -11,7 +21,7 @@ class GetTokenAction extends index_js_1.BaseApiAction {
         this.handler = this.handler.bind(this);
         this.setMode(index_js_1.ActionMode.DMZ);
     }
-    async handler(req, res, next, data, ex) {
+    async handler({ req, res, extension, }) {
         const cc = this.getKernel().getCryptoClient();
         if (!req.body.token) {
             res.status(400).send('no token');
@@ -22,18 +32,51 @@ class GetTokenAction extends index_js_1.BaseApiAction {
             return;
         }
         const { username, token } = req.body;
-        const valid = await ex.timing.startFunc('validation', () => cc.apiTokenValidation(username, token, 'api'));
+        const valid = await extension.timing.startFunc('validation', () => cc.apiTokenValidation(username, token, 'api'));
         if (valid.valid && valid.userId) {
             const jwt = await cc.jwtGenerateAccessToken({
                 userid: valid.userId,
                 username,
             }, req.body);
-            ex.done();
+            extension.done();
             res.status(200).send({ token: jwt });
         }
         else {
             res.status(403).send('no no no ...');
         }
     }
-}
+};
+GetTokenAction = __decorate([
+    (0, swagger_mate_1.SPath)({
+        '/token': {
+            post: {
+                operationId: 'getToken',
+                summary: 'Get API token',
+                tags: ['kernel'],
+                requestBody: swagger_mate_1.SPathUtil.jsonBody({
+                    type: 'object',
+                    properties: {
+                        username: {
+                            type: 'string',
+                        },
+                        token: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['username', 'token'],
+                }),
+                responses: swagger_mate_1.SPathUtil.jsonResponse('200', {
+                    type: 'object',
+                    properties: {
+                        token: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['token'],
+                }, false, '403'),
+            },
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
+], GetTokenAction);
 exports.default = GetTokenAction;

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

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

package/dist/cjs/classes/BaseAction.js

@@ -32,16 +32,34 @@ class BaseAction extends core_1.CoreAction {
         }
         if (this.mode === ActionMode.DMZ) {
             auth.stop();
-            await this.handler(req, res, next, null, extension);
+            await this.handler({
+                res,
+                req,
+                next,
+                data: null,
+                extension,
+            });
             return;
         }
         const dat = await cc.bearerTokenValidation(req);
         auth.stop();
         if (dat && typeof dat !== 'number') {
-            await this.handler(req, res, next, dat, extension);
+            await this.handler({
+                res,
+                req,
+                next,
+                data: dat,
+                extension,
+            });
         }
         else if (this.mode === ActionMode.DMZ_WITH_USER) {
-            await this.handler(req, res, next, null, extension);
+            await this.handler({
+                res,
+                req,
+                next,
+                data: null,
+                extension,
+            });
         }
         else if (dat) {
             res.sendStatus(dat);

package/dist/cjs/classes/BaseAuthProvider.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class BaseAuthProvider {
-    async jwtAddData(token, extend) {
+    async jwtAddData(token, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    extend) {
         return token;
     }
 }

package/dist/cjs/index.d.ts

@@ -11,5 +11,6 @@ export * from './modules/crypto/index.js';
 export * from './lib/index.js';
 export * from './lib/express.js';
 export * from '@grandlinex/core';
+export * from '@grandlinex/swagger-mate';
 export { KernelModule, Kernel };
 export default Kernel;

package/dist/cjs/index.js

@@ -33,4 +33,5 @@ __exportStar(require("./modules/crypto/index.js"), exports);
 __exportStar(require("./lib/index.js"), exports);
 __exportStar(require("./lib/express.js"), exports);
 __exportStar(require("@grandlinex/core"), exports);
+__exportStar(require("@grandlinex/swagger-mate"), exports);
 exports.default = Kernel_js_1.default;

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

@@ -1,6 +1,14 @@
 import express from 'express';
+import { 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> = {
+    req: XRequest;
+    res: XResponse;
+    next: XNextFc;
+    data: G;
+    extension: IExtensionInterface;
+};

package/dist/cjs/lib/index.d.ts

@@ -1,8 +1,8 @@
 import { ICoreAction, ICoreBridge, ICoreCache, ICoreCClient, ICoreClient, ICoreElement, ICoreKernel, ICoreKernelModule, ICorePresenter, ICoreService, IDataBase } from '@grandlinex/core';
 import express from 'express';
 import * as jwt from 'jsonwebtoken';
-import { IAuthProvider, JwtToken, IExtensionInterface, JwtExtend } from '../classes/index.js';
-import { XNextFc, XRequest, XResponse } from './express.js';
+import { IAuthProvider, JwtExtend, JwtToken } from '../classes/index.js';
+import { XActionEvent, XRequest } from './express.js';
 export type ActionTypes = 'POST' | 'GET' | 'USE' | 'PATCH' | 'DELETE';
 export interface ICClient<T extends JwtExtend = JwtExtend> extends ICoreCClient {
     setAuthProvider(provider: IAuthProvider<T>): boolean;
@@ -18,6 +18,7 @@ export interface ICClient<T extends JwtExtend = JwtExtend> extends ICoreCClient
 }
 export interface IKernel<T extends JwtExtend = JwtExtend> extends ICoreKernel<ICClient<T>> {
     getAppServerPort(): number;
+    getApiVersion(): number;
     setAppServerPort(port: number): void;
     responseCodeFunction(data: {
         code: number;
@@ -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: XRequest, res: XResponse, next: XNextFc, data: JwtToken | null, extension: IExtensionInterface): Promise<void>;
+    handler(event: XActionEvent): Promise<void>;
 }

package/dist/mjs/Kernel.d.ts

@@ -1,4 +1,4 @@
-import { CoreLogger, CoreKernel } from '@grandlinex/core';
+import { CoreKernel, CoreLogger } from '@grandlinex/core';
 import { ICClient, IKernel } from './lib/index.js';
 import { XRequest } from './lib/express.js';
 /**
@@ -6,6 +6,7 @@ import { XRequest } from './lib/express.js';
  */
 export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     private expressPort;
+    private readonly apiVersion;
     /**
      * Default Constructor
      * @param options App Name
@@ -13,6 +14,7 @@ export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     constructor(options: {
         appName: string;
         appCode: string;
+        apiVersion?: number;
         pathOverride?: string;
         portOverride?: number;
         envFilePath?: string;
@@ -21,6 +23,7 @@ export default class Kernel extends CoreKernel<ICClient> implements IKernel {
     });
     getAppServerPort(): number;
     setAppServerPort(port: number): void;
+    getApiVersion(): number;
     responseCodeFunction(data: {
         code: number;
         req: XRequest;

package/dist/mjs/Kernel.js

@@ -11,6 +11,7 @@ export default class Kernel extends CoreKernel {
      */
     constructor(options) {
         super({ ...options });
+        this.apiVersion = options.apiVersion ?? 1;
         this.setBaseModule(new KernelModule(this));
         if (options.portOverride) {
             this.debug(`use custiom api port @ ${options.portOverride}`);
@@ -30,6 +31,9 @@ export default class Kernel extends CoreKernel {
     setAppServerPort(port) {
         this.expressPort = port;
     }
+    getApiVersion() {
+        return this.apiVersion;
+    }
     responseCodeFunction(data) {
         const { code } = data;
         if (code < 200 || code >= 300) {

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

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

package/dist/mjs/actions/ApiAuthTestAction.js

@@ -1,15 +1,35 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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 { BaseApiAction } from '../classes/index.js';
-/**
- * @name ApiAuthTestAction
- *
- */
-export default class ApiAuthTestAction extends BaseApiAction {
+let ApiAuthTestAction = class ApiAuthTestAction extends BaseApiAction {
     constructor(module) {
         super('GET', '/test/auth', module);
         this.handler = this.handler.bind(this);
     }
-    async handler(req, res, next, data) {
+    async handler({ data, res }) {
         this.debug(data.userid);
         res.status(200).send("It work's");
     }
-}
+};
+ApiAuthTestAction = __decorate([
+    SPath({
+        '/test/auth': {
+            get: {
+                operationId: 'testAuth',
+                summary: 'Test user auth',
+                tags: ['kernel'],
+                responses: SPathUtil.defaultResponse('200', '403'),
+            },
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
+], ApiAuthTestAction);
+export default ApiAuthTestAction;

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

@@ -1,11 +1,7 @@
 import { IBaseKernelModule } from '../lib/index.js';
-import { BaseApiAction, IExtensionInterface } from '../classes/index.js';
-import { XRequest, XResponse } from '../lib/express.js';
-/**
- * @name ApiVersionAction
- *
- */
+import { BaseApiAction } from '../classes/index.js';
+import { XActionEvent } from '../lib/express.js';
 export default class ApiVersionAction extends BaseApiAction {
     constructor(module: IBaseKernelModule);
-    handler(req: XRequest, res: XResponse, next: () => void, data: any, ex: IExtensionInterface): Promise<void>;
+    handler({ res, extension }: XActionEvent): Promise<void>;
 }

package/dist/mjs/actions/ApiVersionAction.js

@@ -1,16 +1,44 @@
-import { BaseApiAction, ActionMode, } from '../classes/index.js';
-/**
- * @name ApiVersionAction
- *
- */
-export default class ApiVersionAction extends BaseApiAction {
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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);
     }
-    async handler(req, res, next, data, ex) {
-        ex.done();
-        res.status(200).send({ api: 1 });
+    async handler({ res, extension }) {
+        extension.done();
+        res.status(200).send({ api: this.getKernel().getApiVersion() });
     }
-}
+};
+ApiVersionAction = __decorate([
+    SPath({
+        '/version': {
+            get: {
+                operationId: 'getVersion',
+                summary: 'Get API version',
+                tags: ['kernel'],
+                responses: SPathUtil.jsonResponse('200', {
+                    type: 'object',
+                    properties: {
+                        api: {
+                            type: 'number',
+                        },
+                    },
+                    required: ['api'],
+                }, false, '403'),
+            },
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
+], ApiVersionAction);
+export default ApiVersionAction;

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

@@ -1,11 +1,11 @@
 import { IBaseKernelModule } from '../lib/index.js';
-import { BaseApiAction, IExtensionInterface } from '../classes/index.js';
-import { XRequest, XResponse } from '../lib/express.js';
+import { BaseApiAction, JwtToken } 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: XRequest, res: XResponse, next: () => void, data: any, ex: IExtensionInterface): Promise<void>;
+    handler({ req, res, extension, }: XActionEvent<JwtToken>): Promise<void>;
 }

package/dist/mjs/actions/GetTokenAction.js

@@ -1,5 +1,15 @@
-import { BaseApiAction, ActionMode, } from '../classes/index.js';
-export default class GetTokenAction extends BaseApiAction {
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    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
@@ -9,7 +19,7 @@ export default class GetTokenAction extends BaseApiAction {
         this.handler = this.handler.bind(this);
         this.setMode(ActionMode.DMZ);
     }
-    async handler(req, res, next, data, ex) {
+    async handler({ req, res, extension, }) {
         const cc = this.getKernel().getCryptoClient();
         if (!req.body.token) {
             res.status(400).send('no token');
@@ -20,17 +30,51 @@ export default class GetTokenAction extends BaseApiAction {
             return;
         }
         const { username, token } = req.body;
-        const valid = await ex.timing.startFunc('validation', () => cc.apiTokenValidation(username, token, 'api'));
+        const valid = await extension.timing.startFunc('validation', () => cc.apiTokenValidation(username, token, 'api'));
         if (valid.valid && valid.userId) {
             const jwt = await cc.jwtGenerateAccessToken({
                 userid: valid.userId,
                 username,
             }, req.body);
-            ex.done();
+            extension.done();
             res.status(200).send({ token: jwt });
         }
         else {
             res.status(403).send('no no no ...');
         }
     }
-}
+};
+GetTokenAction = __decorate([
+    SPath({
+        '/token': {
+            post: {
+                operationId: 'getToken',
+                summary: 'Get API token',
+                tags: ['kernel'],
+                requestBody: SPathUtil.jsonBody({
+                    type: 'object',
+                    properties: {
+                        username: {
+                            type: 'string',
+                        },
+                        token: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['username', 'token'],
+                }),
+                responses: SPathUtil.jsonResponse('200', {
+                    type: 'object',
+                    properties: {
+                        token: {
+                            type: 'string',
+                        },
+                    },
+                    required: ['token'],
+                }, false, '403'),
+            },
+        },
+    }),
+    __metadata("design:paramtypes", [Object])
+], GetTokenAction);
+export default GetTokenAction;

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

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

package/dist/mjs/classes/BaseAction.js

@@ -29,16 +29,34 @@ export default class BaseAction extends CoreAction {
         }
         if (this.mode === ActionMode.DMZ) {
             auth.stop();
-            await this.handler(req, res, next, null, extension);
+            await this.handler({
+                res,
+                req,
+                next,
+                data: null,
+                extension,
+            });
             return;
         }
         const dat = await cc.bearerTokenValidation(req);
         auth.stop();
         if (dat && typeof dat !== 'number') {
-            await this.handler(req, res, next, dat, extension);
+            await this.handler({
+                res,
+                req,
+                next,
+                data: dat,
+                extension,
+            });
         }
         else if (this.mode === ActionMode.DMZ_WITH_USER) {
-            await this.handler(req, res, next, null, extension);
+            await this.handler({
+                res,
+                req,
+                next,
+                data: null,
+                extension,
+            });
         }
         else if (dat) {
             res.sendStatus(dat);

package/dist/mjs/classes/BaseAuthProvider.js

@@ -1,5 +1,7 @@
 export default class BaseAuthProvider {
-    async jwtAddData(token, extend) {
+    async jwtAddData(token, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    extend) {
         return token;
     }
 }

package/dist/mjs/index.d.ts

@@ -11,5 +11,6 @@ export * from './modules/crypto/index.js';
 export * from './lib/index.js';
 export * from './lib/express.js';
 export * from '@grandlinex/core';
+export * from '@grandlinex/swagger-mate';
 export { KernelModule, Kernel };
 export default Kernel;

package/dist/mjs/index.js

@@ -11,5 +11,6 @@ export * from './modules/crypto/index.js';
 export * from './lib/index.js';
 export * from './lib/express.js';
 export * from '@grandlinex/core';
+export * from '@grandlinex/swagger-mate';
 export { KernelModule, Kernel };
 export default Kernel;

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

@@ -1,6 +1,14 @@
 import express from 'express';
+import { 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> = {
+    req: XRequest;
+    res: XResponse;
+    next: XNextFc;
+    data: G;
+    extension: IExtensionInterface;
+};

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

@@ -1,8 +1,8 @@
 import { ICoreAction, ICoreBridge, ICoreCache, ICoreCClient, ICoreClient, ICoreElement, ICoreKernel, ICoreKernelModule, ICorePresenter, ICoreService, IDataBase } from '@grandlinex/core';
 import express from 'express';
 import * as jwt from 'jsonwebtoken';
-import { IAuthProvider, JwtToken, IExtensionInterface, JwtExtend } from '../classes/index.js';
-import { XNextFc, XRequest, XResponse } from './express.js';
+import { IAuthProvider, JwtExtend, JwtToken } from '../classes/index.js';
+import { XActionEvent, XRequest } from './express.js';
 export type ActionTypes = 'POST' | 'GET' | 'USE' | 'PATCH' | 'DELETE';
 export interface ICClient<T extends JwtExtend = JwtExtend> extends ICoreCClient {
     setAuthProvider(provider: IAuthProvider<T>): boolean;
@@ -18,6 +18,7 @@ export interface ICClient<T extends JwtExtend = JwtExtend> extends ICoreCClient
 }
 export interface IKernel<T extends JwtExtend = JwtExtend> extends ICoreKernel<ICClient<T>> {
     getAppServerPort(): number;
+    getApiVersion(): number;
     setAppServerPort(port: number): void;
     responseCodeFunction(data: {
         code: number;
@@ -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: XRequest, res: XResponse, next: XNextFc, data: JwtToken | null, extension: IExtensionInterface): Promise<void>;
+    handler(event: XActionEvent): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grandlinex/kernel",
-  "version": "0.32.0",
+  "version": "0.32.10",
   "description": "GrandLineX is an out-of-the-box server framework on top of ExpressJs.",
   "type": "module",
   "exports": {
@@ -47,35 +47,36 @@
   "license": "BSD-3-Clause",
   "dependencies": {
     "@grandlinex/core": "0.32.0",
-    "axios": "1.4.0",
+    "@grandlinex/swagger-mate": "0.32.1",
+    "axios": "1.5.1",
     "body-parser": "1.20.2",
     "express": "4.18.2",
-    "jsonwebtoken": "9.0.1"
+    "jsonwebtoken": "9.0.2",
+    "@types/express": "^4.17.18",
+    "@types/jsonwebtoken": "^9.0.3"
   },
   "devDependencies": {
-    "@types/express": "^4.17.17",
-    "@types/jest": "^29.5.2",
-    "@types/jsonwebtoken": "^9.0.2",
-    "@types/node": "^20.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.61.0",
-    "@typescript-eslint/parser": "^5.61.0",
+    "@types/jest": "^29.5.5",
+    "@types/node": "^20.8.2",
+    "@typescript-eslint/eslint-plugin": "^6.7.4",
+    "@typescript-eslint/parser": "^6.7.4",
     "cross-env": "^7.0.3",
-    "eslint": "^8.44.0",
+    "eslint": "^8.50.0",
     "eslint-config-airbnb": "^19.0.4",
-    "eslint-config-airbnb-typescript": "^17.0.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.2",
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jest": "^27.4.2",
     "eslint-plugin-jsx-a11y": "^6.7.1",
-    "eslint-plugin-prettier": "^4.2.1",
-    "jest": "^29.6.1",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.7.0",
     "jest-junit": "^16.0.0",
-    "prettier": "2.8.8",
+    "prettier": "3.0.3",
     "ts-jest": "^29.1.1",
     "ts-loader": "^9.4.4",
     "ts-node": "^10.9.1",
-    "typedoc": "^0.24.8",
-    "typescript": "^5.1.6"
+    "typedoc": "^0.25.1",
+    "typescript": "^5.2.2"
   },
   "repository": {
     "type": "git",