badmfck-api-server 3.8.2 → 3.8.4

package/dist/apiServer/APIService.d.ts

@@ -22,17 +22,18 @@ export interface APIServiceNetworkLogItem {
     };
     error?: string | null;
 }
-export interface APIServiceOptions {
+export interface IInterceptor<T> {
+    intercept(req: HTTPRequestVO<any>): Promise<T | IError>;
+}
+export interface APIServiceOptions<TInterceptor = unknown> {
     port: number;
     baseEndPoint: string;
     corsHostWhiteList: string[];
     projectName: string;
     endpoints: IBaseEndpoint[];
     jsonLimit: string;
-    onNetworkLog?: ((log: APIServiceNetworkLogItem) => void) | null;
-    onError?: ((...rest: any[]) => void) | null;
     isProductionEnvironment: boolean;
-    interceptor?: IBaseEndpoint;
+    interceptor?: IInterceptor<TInterceptor>;
     postproducer?: (req: HTTPRequestVO | undefined | null, res: Response, data: TransferPacketVO<any>, requestTime: number, endpoint?: string, log?: APIServiceNetworkLogItem | null) => Promise<TransferPacketVO>;
     preproducer?: (req: HTTPRequestVO | undefined | null) => any;
     access: {
@@ -44,8 +45,11 @@ export interface APIServiceOptions {
     fileTempDir: string;
     fileLimit: number;
 }
-export declare function getDefaultOptions(): APIServiceOptions;
-export declare const REQ_CREATE_NET_LOG: Req<void, APIServiceNetworkLogItem>;
+type InferInterceptor<T> = T extends IInterceptor<infer U> ? U : unknown;
+export declare const getDefaultOptions: <I extends IInterceptor<any> | undefined>(overrides?: (Omit<Partial<APIServiceOptions<InferInterceptor<NonNullable<I>>>>, "interceptor"> & {
+    interceptor?: I | undefined;
+}) | undefined) => APIServiceOptions<InferInterceptor<NonNullable<I>>>;
+export declare const REQ_DEPREACTED_CREATE_NET_LOG: Req<void, APIServiceNetworkLogItem>;
 export declare const REQ_HTTP_LOG: Req<void, APIServiceNetworkLogItem[]>;
 export declare const REQ_HTTP_REQUESTS_COUNT: Req<void, number>;
 export declare const REQ_HTTP_SERVER: Req<void, {
@@ -64,8 +68,10 @@ export declare class APIService extends BaseService {
     private started;
     private requestsCount;
     netLog: APIServiceNetworkLogItem[];
-    constructor(options?: APIServiceOptions | null);
+    constructor(options: APIServiceOptions);
     init(): Promise<void>;
-    sendResponse(ref: string, res: Response, data: TransferPacketVO<any>, requestTime: number, endpoint?: string, log?: APIServiceNetworkLogItem | null, req?: HTTPRequestVO): Promise<void>;
+    addNetlog(data: TransferPacketVO, req: HTTPRequestVO, created: number, time: number): void;
+    sendResponse(ref: string, res: Response, data: TransferPacketVO<any>, requestTime: number, endpoint?: string, req?: HTTPRequestVO): Promise<void>;
     checkDataLength(data: any, result?: any, lvl?: number): any;
 }
+export {};

package/dist/apiServer/APIService.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.APIService = exports.Initializer = exports.REQ_DOC_USERS = exports.REQ_MONITOR_USERS = exports.REQ_INTERNAL_CALL = exports.REQ_HTTP_SERVER = exports.REQ_HTTP_REQUESTS_COUNT = exports.REQ_HTTP_LOG = exports.REQ_CREATE_NET_LOG = exports.getDefaultOptions = void 0;
+exports.APIService = exports.Initializer = exports.REQ_DOC_USERS = exports.REQ_MONITOR_USERS = exports.REQ_INTERNAL_CALL = exports.REQ_HTTP_SERVER = exports.REQ_HTTP_REQUESTS_COUNT = exports.REQ_HTTP_LOG = exports.REQ_DEPREACTED_CREATE_NET_LOG = exports.getDefaultOptions = void 0;
 const express_1 = __importDefault(require("express"));
 const BaseService_1 = require("./BaseService");
 const cors_1 = __importDefault(require("cors"));
@@ -35,9 +35,7 @@ const DefaultErrors_1 = __importStar(require("./structures/DefaultErrors"));
 const badmfck_signal_1 = require("badmfck-signal");
 const LogService_1 = require("./LogService");
 const Monitor_1 = require("./monitor/Monitor");
-const path_1 = __importDefault(require("path"));
 const express_fileupload_1 = __importDefault(require("express-fileupload"));
-const os_1 = __importDefault(require("os"));
 const Liveness_1 = require("./routes/Liveness");
 const Readiness_1 = require("./routes/Readiness");
 const http_1 = __importDefault(require("http"));
@@ -47,33 +45,35 @@ const MonitorService_1 = require("./MonitorService");
 const MysqlAdapter_1 = require("./db/MysqlAdapter");
 const DocumentService_1 = require("./DocumentService");
 const Documentation_1 = require("./documentation/Documentation");
-function getDefaultOptions() {
+let nextLogID = 0;
+function bindRequestToOptions(opts, req) {
+    return req;
+}
+function defaultOptions() {
     return {
-        port: 8091,
-        access: {
-            monitor: [],
-            documentation: [],
-        },
-        baseEndPoint: '/api/',
-        corsHostWhiteList: [
-            'http://localhost:3000',
-        ],
+        port: 8080,
+        baseEndPoint: "/api/",
+        corsHostWhiteList: [],
+        projectName: "App",
         endpoints: [],
         jsonLimit: "10mb",
-        onNetworkLog: function (log) {
-            (0, LogService_1.logAPI)("${APIService.js}", log);
-        },
-        onError: function (err) {
-            (0, LogService_1.logError)("${APIService.js}", err);
-        },
-        projectName: "API Service",
         isProductionEnvironment: false,
-        fileLimit: 50 * 1024 * 1024,
-        fileTempDir: path_1.default.resolve(os_1.default.tmpdir(), "fileTempDir")
+        interceptor: undefined,
+        postproducer: undefined,
+        preproducer: undefined,
+        access: {},
+        monitor: undefined,
+        appVersion: undefined,
+        fileTempDir: "/tmp",
+        fileLimit: 10_000_000,
     };
 }
+const getDefaultOptions = (overrides) => {
+    const base = defaultOptions();
+    return { ...base, ...overrides };
+};
 exports.getDefaultOptions = getDefaultOptions;
-exports.REQ_CREATE_NET_LOG = new badmfck_signal_1.Req(undefined, "REQ_CREATE_NET_LOG");
+exports.REQ_DEPREACTED_CREATE_NET_LOG = new badmfck_signal_1.Req(undefined, "REQ_CREATE_NET_LOG");
 exports.REQ_HTTP_LOG = new badmfck_signal_1.Req(undefined, "REQ_HTTP_LOG");
 exports.REQ_HTTP_REQUESTS_COUNT = new badmfck_signal_1.Req(undefined, "REQ_HTTP_REQUESTS_COUNT");
 exports.REQ_HTTP_SERVER = new badmfck_signal_1.Req(undefined, "REQ_HTTP_SERVER");
@@ -95,7 +95,7 @@ async function Initializer(services) {
 exports.Initializer = Initializer;
 class APIService extends BaseService_1.BaseService {
     static nextLogID = 0;
-    version = "3.8.2";
+    version = "3.8.4";
     options;
     monitor = null;
     started = new Date();
@@ -103,7 +103,7 @@ class APIService extends BaseService_1.BaseService {
     netLog = [];
     constructor(options) {
         super('HTTP Service');
-        this.options = options ?? getDefaultOptions();
+        this.options = options;
         if (!this.options.corsHostWhiteList)
             this.options.corsHostWhiteList = [];
         const self = "http://localhost:" + this.options.port;
@@ -121,21 +121,7 @@ class APIService extends BaseService_1.BaseService {
         exports.REQ_HTTP_REQUESTS_COUNT.listener = async () => this.requestsCount;
     }
     async init() {
-        exports.REQ_HTTP_LOG.listener = async (ignore) => this.netLog;
-        exports.REQ_CREATE_NET_LOG.listener = async (ignore) => {
-            const log = {
-                created: +new Date(),
-                time: 0,
-                request: {},
-                response: {},
-                error: null,
-                id: APIService.nextLogID++
-            };
-            this.netLog.push(log);
-            if (this.netLog.length > 1000)
-                this.netLog.shift();
-            return log;
-        };
+        exports.REQ_HTTP_LOG.listener = async (_) => this.netLog;
         exports.REQ_INTERNAL_CALL.listener = async (req) => {
             for (let i of this.options.endpoints) {
                 if (!i || !i.endpoints)
@@ -167,7 +153,17 @@ class APIService extends BaseService_1.BaseService {
                     error: DefaultErrors_1.default.FILE_TOO_LARGE,
                     data: null,
                     httpStatus: 413,
-                }, +new Date(), req.path);
+                }, +new Date(), req.path, {
+                    endpoint: req.path,
+                    headers: req.headers,
+                    method: req.method,
+                    data: req.body,
+                    params: req.params,
+                    interceptorResult: null,
+                    raw: req,
+                    response: undefined,
+                    files: undefined
+                });
             },
             limits: { fileSize: this.options.fileLimit },
             useTempFiles: true,
@@ -181,12 +177,6 @@ class APIService extends BaseService_1.BaseService {
                 return;
             }
             const tme = +new Date();
-            const log = await exports.REQ_CREATE_NET_LOG.request();
-            log.request = {
-                method: req.method,
-                data: "",
-                params: req.params
-            };
             let responseError = DefaultErrors_1.default.UNKNOWN_REQUEST;
             if (typeof err === "object" && err.status === 400 && 'body' in err && err.type === 'entity.parse.failed') {
                 responseError = DefaultErrors_1.default.JSON_MALFORMED;
@@ -195,7 +185,17 @@ class APIService extends BaseService_1.BaseService {
                 error: responseError,
                 data: null,
                 httpStatus: 400
-            }, tme, "", log);
+            }, tme, "", {
+                endpoint: "",
+                headers: req.headers,
+                method: req.method,
+                data: req.body,
+                params: req.params,
+                interceptorResult: null,
+                raw: req,
+                response: undefined,
+                files: undefined
+            });
         });
         const corsOptions = {
             origin: (origin, callback) => {
@@ -216,16 +216,6 @@ class APIService extends BaseService_1.BaseService {
                 app.all(ep, async (req, res) => {
                     this.requestsCount++;
                     const tme = +new Date();
-                    let log = null;
-                    if (!i.ignoreHttpLogging) {
-                        log = await exports.REQ_CREATE_NET_LOG.request();
-                        log.request = {
-                            url: req.url,
-                            method: req.method,
-                            data: this.checkDataLength(req.body),
-                            params: this.checkDataLength(req.params)
-                        };
-                    }
                     const execute = async () => {
                         const body = req.body;
                         if (req.query && typeof req.query === "object") {
@@ -233,7 +223,7 @@ class APIService extends BaseService_1.BaseService {
                                 body[i] = req.query[i];
                             }
                         }
-                        const httpRequest = {
+                        let httpRequest = {
                             raw: req,
                             response: res,
                             method: req.method,
@@ -259,10 +249,10 @@ class APIService extends BaseService_1.BaseService {
                                     stack = [e];
                                 }
                                 if ((0, MysqlAdapter_1.isError)(e)) {
-                                    this.sendResponse(req.get("Referer") ?? "", res, { error: { ...DefaultErrors_1.default.DB_ERROR, details: e.message } }, tme, ep, log, httpRequest);
+                                    this.sendResponse(req.get("Referer") ?? "", res, { error: { ...DefaultErrors_1.default.DB_ERROR, details: e.message } }, tme, ep, httpRequest);
                                     return;
                                 }
-                                this.sendResponse(req.get("Referer") ?? "", res, { error: { code: 10002, message: "Internal server error!", stack: stack, details: details }, data: null, httpStatus: 500 }, tme, ep, log, httpRequest);
+                                this.sendResponse(req.get("Referer") ?? "", res, { error: { code: 10002, message: "Internal server error!", stack: stack, details: details }, data: null, httpStatus: 500 }, tme, ep, httpRequest);
                                 return;
                             }
                         }
@@ -286,17 +276,19 @@ class APIService extends BaseService_1.BaseService {
                             if (!ignoreInterceptor) {
                                 let interceptorResult;
                                 if (this.options.interceptor) {
-                                    interceptorResult = await this.options.interceptor.__execute(httpRequest);
-                                    if (interceptorResult.error && !allowInterceptorError) {
-                                        this.sendResponse(req.get("Referer") ?? "", res, interceptorResult, tme, ep, log, httpRequest);
+                                    const httpRequestBound = bindRequestToOptions(this.options, httpRequest);
+                                    interceptorResult = await this.options.interceptor.intercept(httpRequest);
+                                    if (DefaultErrors_1.ErrorUtils.isError(interceptorResult) && !allowInterceptorError) {
+                                        this.sendResponse(req.get("Referer") ?? "", res, interceptorResult, tme, ep, httpRequest);
                                         return;
                                     }
-                                    httpRequest.interceptorResult = interceptorResult;
+                                    httpRequestBound.interceptorResult = interceptorResult;
+                                    httpRequest = httpRequestBound;
                                 }
                             }
                             const precheck = await i.__precheck(httpRequest);
                             if (precheck && precheck.error) {
-                                this.sendResponse(req.get("Referer") ?? "", res, precheck, tme, ep, log, httpRequest);
+                                this.sendResponse(req.get("Referer") ?? "", res, precheck, tme, ep, httpRequest);
                                 return;
                             }
                             httpRequest.precheck = precheck;
@@ -332,10 +324,10 @@ class APIService extends BaseService_1.BaseService {
                                     error: { ...DefaultErrors_1.default.DB_ERROR, details: e.message }
                                 };
                             }
-                            this.sendResponse(req.get("Referer") ?? "", res, data, tme, ep, log, httpRequest);
+                            this.sendResponse(req.get("Referer") ?? "", res, data, tme, ep, httpRequest);
                             return;
                         }
-                        this.sendResponse(req.get("Referer") ?? "", res, result, tme, ep, log, httpRequest);
+                        this.sendResponse(req.get("Referer") ?? "", res, result, tme, ep, httpRequest);
                     };
                     execute();
                 });
@@ -347,23 +339,51 @@ class APIService extends BaseService_1.BaseService {
                 error: DefaultErrors_1.default.UNKNOWN_REQUEST,
                 data: null,
                 httpStatus: 404
-            }, tme, req.path);
+            }, tme, req.path, {
+                endpoint: req.path,
+                headers: req.headers,
+                method: req.method,
+                data: req.body,
+                params: req.params,
+                interceptorResult: null,
+                raw: req,
+                response: undefined,
+                files: undefined
+            });
         });
         server.listen(this.options.port, () => {
             (0, LogService_1.logAPI)('${APIService.js}', 'API Service started at: ' + this.options.port + ", with base endpoint:" + this.options.baseEndPoint + ", ver.: " + this.version);
         });
     }
-    async sendResponse(ref, res, data, requestTime, endpoint, log, req) {
+    addNetlog(data, req, created, time) {
+        const logItem = {
+            id: nextLogID++,
+            created: created,
+            time: time,
+            request: {
+                endpoint: req?.endpoint,
+                headers: req?.headers,
+                method: req?.method,
+                data: req?.data,
+                params: req?.params,
+                interceptorResult: req?.interceptorResult
+            },
+            response: data
+        };
+        this.netLog.push(logItem);
+        if (this.netLog.length > 100)
+            this.netLog.shift();
+    }
+    async sendResponse(ref, res, data, requestTime, endpoint, req) {
         if (data.blockResponse) {
-            if (log)
-                log.error = "Response blocked";
-            if (this.options.onNetworkLog && log)
-                this.options.onNetworkLog(log);
+            (0, LogService_1.logAPI)("Response blocked");
+            if (req)
+                this.addNetlog(data, req, requestTime, 0);
             return;
         }
         if (this.options.postproducer) {
             try {
-                data = await this.options.postproducer(req, res, data, requestTime, endpoint, log);
+                data = await this.options.postproducer(req, res, data, requestTime, endpoint);
             }
             catch (e) {
                 (0, LogService_1.logError)("Postproducer error", e);
@@ -376,37 +396,28 @@ class APIService extends BaseService_1.BaseService {
         data.endpoint = endpoint ?? "no_endpoint";
         if (this.options.appVersion)
             data.version = this.options.appVersion;
-        if (log) {
-            log.time = data.responseTime;
-            log.referer = ref;
-        }
         MonitorService_1.S_STAT_REGISTRATE_REQUEST.invoke(data);
         if (res.destroyed || res.closed) {
-            if (log)
-                log.error = "Connection already closed, can't send response for: " + data.endpoint;
-            if (this.options.onError)
-                this.options.onError("Connection already closed, can't send response: " + data.endpoint, data);
+            (0, LogService_1.logAPI)("Connection already closed, can't send response for: " + data.endpoint);
         }
         else {
             try {
                 if (data.file) {
                     res.sendFile(data.file, err => {
                         if (err) {
-                            if (log)
-                                log.error = "Can't send file: " + data.file;
+                            (0, LogService_1.logError)("Can't send file: " + data.file);
                             this.sendResponse(ref, res, {
                                 error: DefaultErrors_1.default.CANT_SEND_FILE,
                                 data: null,
                                 httpStatus: 500
-                            }, requestTime, data.endpoint);
+                            }, requestTime, data.endpoint, req);
                         }
                     });
                     return;
                 }
                 if (data.redirect) {
                     res.redirect(data.redirect);
-                    if (log)
-                        log.response = { redirect: data.redirect };
+                    (0, LogService_1.logAPI)("redirect: " + data.redirect);
                 }
                 else {
                     if (data.headers) {
@@ -419,34 +430,20 @@ class APIService extends BaseService_1.BaseService {
                         res.statusCode = data.httpStatus ?? 200;
                     if (data.rawResponse) {
                         res.send(data.data);
-                        if (log)
-                            log.response = this.checkDataLength(data);
+                        (0, LogService_1.logAPI)(this.checkDataLength(data));
                     }
                     else {
                         res.send(data);
-                        if (log)
-                            log.response = this.checkDataLength(data);
-                        if (data.error) {
-                            if (log)
-                                log.error = data.error.message;
-                        }
+                        (0, LogService_1.logAPI)(this.checkDataLength(data));
+                        if (data.error)
+                            (0, LogService_1.logError)(data.error.message);
                     }
                 }
             }
             catch (e) {
-                if (this.options.onError)
-                    this.options.onError("Can't send response", e);
-                if (log)
-                    log.error = "Can't send response";
+                console.error(e);
             }
         }
-        if (log && log.error && this.options.onError) {
-            this.options.onError(log.error);
-        }
-        else {
-            if (this.options.onNetworkLog && log)
-                this.options.onNetworkLog(log);
-        }
     }
     checkDataLength(data, result, lvl) {
         if (!lvl)

package/dist/apiServer/TimeframeService.js

@@ -42,9 +42,8 @@ class TimeframeService extends BaseService_1.BaseService {
         super("TimeframeService");
     }
     async init() {
-        super.init();
         exports.REQ_TIMEFRAME_TASK_ADD.listener = async (req) => {
-            (0, LogService_1.logInfo)("Add tack to TimeframeService: " + req.name);
+            (0, LogService_1.logInfo)("Add tack " + req.name);
             this.tasks.push(req);
         };
         this.intervalId = setInterval(() => {
@@ -63,14 +62,14 @@ class TimeframeService extends BaseService_1.BaseService {
             if (now >= task.start && (!task.executed || task.executed < task.start)) {
                 if (now - task.start <= this.GRACE_WINDOW_MS) {
                     try {
-                        (0, LogService_1.logInfo)("Timeframe Servie - execute task ", task.name);
+                        (0, LogService_1.logInfo)("Execute task ", task.name);
                         if (task.callback.length > 0 && task.params)
                             task.callback(task.params);
                         else
                             task.callback();
                         task.executed = Date.now();
                         task.retries = 0;
-                        (0, LogService_1.logInfo)("Timeframe Servie - task executed ", task.name);
+                        (0, LogService_1.logInfo)("Executed task ", task.name);
                         if (task.repeat) {
                             task.start += task.repeat;
                         }

package/dist/apiServer/structures/Interfaces.d.ts

@@ -18,7 +18,7 @@ export interface TransferPacketVO<T = any> {
     blockResponse?: boolean;
     project?: string;
 }
-export interface HTTPRequestVO<T = any> {
+export interface HTTPRequestVO<T = any, TInterceport = any> {
     raw: any;
     response: any;
     method: string;
@@ -26,11 +26,9 @@ export interface HTTPRequestVO<T = any> {
     params: {
         [key: string]: string;
     };
-    headers: {
-        [key: string]: string;
-    };
+    headers: Record<string, string>;
     endpoint: string;
-    interceptorResult?: TransferPacketVO<any>;
+    interceptorResult?: any;
     preproducerResult?: any;
     precheck?: TransferPacketVO<any> | null;
     files: FileArray | null | undefined;

package/dist/index.d.ts

@@ -10,4 +10,5 @@ import { UID } from "./apiServer/helper/UID";
 import { ExternalService } from "./apiServer/external/ExternalService";
 import { DBService } from "./apiServer/DBService";
 import { YYYYMMDDHH } from "./apiServer/helper/YYYYMMDDHH";
-export { UID, YYYYMMDDHH, APIService, Initializer, LocalRequest, ValidationModel, MysqlService, Validator, LogService, DataProvider, ErrorUtils, ExternalService, DBService, S_MONITOR_REGISTRATE_ACTION };
+import { TimeframeService } from "./apiServer/TimeframeService";
+export { UID, YYYYMMDDHH, APIService, Initializer, LocalRequest, ValidationModel, MysqlService, TimeframeService, Validator, LogService, DataProvider, ErrorUtils, ExternalService, DBService, S_MONITOR_REGISTRATE_ACTION };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.S_MONITOR_REGISTRATE_ACTION = exports.DBService = exports.ExternalService = exports.ErrorUtils = exports.DataProvider = exports.LogService = exports.Validator = exports.MysqlService = exports.LocalRequest = exports.Initializer = exports.APIService = exports.YYYYMMDDHH = exports.UID = void 0;
+exports.S_MONITOR_REGISTRATE_ACTION = exports.DBService = exports.ExternalService = exports.ErrorUtils = exports.DataProvider = exports.LogService = exports.Validator = exports.TimeframeService = exports.MysqlService = exports.LocalRequest = exports.Initializer = exports.APIService = exports.YYYYMMDDHH = exports.UID = void 0;
 const APIService_1 = require("./apiServer/APIService");
 Object.defineProperty(exports, "APIService", { enumerable: true, get: function () { return APIService_1.APIService; } });
 Object.defineProperty(exports, "Initializer", { enumerable: true, get: function () { return APIService_1.Initializer; } });
@@ -26,3 +26,5 @@ const DBService_1 = require("./apiServer/DBService");
 Object.defineProperty(exports, "DBService", { enumerable: true, get: function () { return DBService_1.DBService; } });
 const YYYYMMDDHH_1 = require("./apiServer/helper/YYYYMMDDHH");
 Object.defineProperty(exports, "YYYYMMDDHH", { enumerable: true, get: function () { return YYYYMMDDHH_1.YYYYMMDDHH; } });
+const TimeframeService_1 = require("./apiServer/TimeframeService");
+Object.defineProperty(exports, "TimeframeService", { enumerable: true, get: function () { return TimeframeService_1.TimeframeService; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "badmfck-api-server",
-  "version": "3.8.2",
+  "version": "3.8.4",
   "description": "Simple API http server based on express",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",