@adaptivestone/framework 5.0.0-beta.4 → 5.0.0-beta.40

package/dist/modules/AbstractController.js

@@ -0,0 +1,323 @@
+import express from 'express';
+import DocumentationGenerator from '../services/documentation/DocumentationGenerator.js';
+import Auth from "../services/http/middleware/Auth.js";
+import GetUserByToken from "../services/http/middleware/GetUserByToken.js";
+import ValidateService from '../services/validate/ValidateService.js';
+import Base from "./Base.js";
+/**
+ * Abstract controller. You should extend any controller from them.
+ * Place you cintroller into controller folder and it be inited in auto way.
+ * By default name of route will be controller name not file name. But please name it in same ways.
+ * You can overwrite base controllers byt creating controllers with tha same file name (yes file name, not class name)
+ * In most cases you will want to have a 'home' route that not include controller name. For this case please check '  getHttpPath'
+ */
+class AbstractController extends Base {
+    prefix = '';
+    router;
+    constructor(app, prefix, isExpressMergeParams = false) {
+        const time = Date.now();
+        super(app);
+        this.prefix = prefix;
+        this.router = express.Router({
+            mergeParams: isExpressMergeParams,
+        });
+        const { routes } = this;
+        const httpPath = this.getHttpPath();
+        /**
+         * Grab route middleware into one Map
+         */
+        const routeMiddlewares = new Map();
+        Object.entries(routes).forEach(([method, methodRoutes]) => {
+            Object.entries(methodRoutes).forEach(([route, routeParam]) => {
+                if (typeof routeParam === 'object' &&
+                    routeParam !== null &&
+                    'middleware' in routeParam &&
+                    routeParam.middleware) {
+                    const fullRoute = method.toUpperCase() + route;
+                    if (!routeMiddlewares.has(fullRoute)) {
+                        routeMiddlewares.set(fullRoute, []);
+                    }
+                    routeMiddlewares.set(fullRoute, [
+                        ...routeMiddlewares.get(fullRoute),
+                        ...routeParam.middleware,
+                    ]);
+                }
+            });
+        });
+        const routeMiddlewaresReg = this.parseMiddlewares(routeMiddlewares, httpPath);
+        const middlewaresInfo = this.parseMiddlewares(this.constructor.middleware, httpPath);
+        const routesInfo = [];
+        /**
+         *  Register controller middleware
+         */
+        for (const middleware of middlewaresInfo) {
+            this.router[middleware.method](middleware.path, new middleware.MiddlewareFunction(this.app, middleware.params).getMiddleware());
+        }
+        /**
+         *  Register routes itself
+         */
+        for (const verb in routes) {
+            if (typeof this.router[verb] !== 'function') {
+                this.logger?.error(`Method ${verb} not exist for router. Please check your codebase`);
+                continue;
+            }
+            for (const path in routes[verb]) {
+                const routeAdditionalMiddlewares = routeMiddlewaresReg.filter((middleware) => middleware.path === path && middleware.method === verb);
+                let routeObject = routes[verb][path];
+                if (Object.prototype.toString.call(routeObject) !== '[object Object]') {
+                    // for support firect pass function instead of object
+                    routeObject = {
+                        handler: routeObject,
+                        request: null,
+                        query: null,
+                        middleware: null,
+                    };
+                    if (typeof routeObject.handler !== 'function') {
+                        this.logger?.error(`Can't resolve function '${routeObject.handler}' for controller '${this.getConstructorName()}'`);
+                        continue;
+                    }
+                }
+                const { handler } = routeObject;
+                let fnName;
+                if (typeof handler === 'function') {
+                    fnName = handler.name;
+                }
+                else {
+                    fnName = undefined;
+                }
+                const fullPath = `/${httpPath}/${path}`
+                    .split('//')
+                    .join('/')
+                    .split('//')
+                    .join('/');
+                routesInfo.push({
+                    name: fnName,
+                    description: routeObject?.description,
+                    method: verb.toUpperCase(),
+                    fields: routeObject?.request?.fields,
+                    queryFields: routeObject?.query?.fields,
+                    path,
+                    fullPath,
+                });
+                // this.logger.verbose(
+                //   `Controller '${this.getConstructorName()}' register function '${fnName}'  for method '${verb}' and path '${path}' Full path '${fullPath}'`,
+                // );
+                let additionalMiddlewares;
+                if (routeAdditionalMiddlewares.length > 0) {
+                    additionalMiddlewares = Array.from(routeAdditionalMiddlewares, ({ MiddlewareFunction, params }) => new MiddlewareFunction(this.app, params).getMiddleware());
+                }
+                this.router[verb](path, additionalMiddlewares || [], async (req, res, next) => {
+                    const requestObj = {
+                        query: req.query,
+                        body: req.body,
+                        appInfo: req.appInfo,
+                    };
+                    try {
+                        req.appInfo.request = await new ValidateService(this.app, routeObject?.request).validateReqData(requestObj, {
+                            selectedReqData: req.body,
+                            additionalMiddlewareFieldsData: {
+                                middlewaresInfo,
+                                routeMiddlewaresReg,
+                                options: {
+                                    method: verb,
+                                    path: fullPath,
+                                    prefix: 'request',
+                                },
+                            },
+                        });
+                        req.appInfo.query = await new ValidateService(this.app, routeObject?.query).validateReqData(requestObj, {
+                            selectedReqData: req.query,
+                            additionalMiddlewareFieldsData: {
+                                middlewaresInfo,
+                                routeMiddlewaresReg,
+                                options: {
+                                    method: verb,
+                                    path: fullPath,
+                                    prefix: 'query',
+                                },
+                            },
+                        });
+                    }
+                    catch (err) {
+                        return res.status(400).json({
+                            errors: err instanceof Error ? err.message : String(err),
+                        });
+                    }
+                    // req.body = new Proxy(req.body, {
+                    //   get: (target, prop) => {
+                    //     this.logger.warn(
+                    //       'Please not use "req.body" directly. Implement "request" and use "req.appInfo.request" ',
+                    //     );
+                    //     return target[prop];
+                    //   },
+                    // });
+                    // req.query = new Proxy(req.query, {
+                    //   get: (target, prop) => {
+                    //     this.logger.warn(
+                    //       'Please not use "req.query" directly. Implement "query" and use "req.appInfo.query" ',
+                    //     );
+                    //     return target[prop];
+                    //   },
+                    // });
+                    if (!routeObject.handler) {
+                        this.logger?.error(`Route object have no handler defined`);
+                        return res.status(500).json({
+                            message: 'Platform error 2. Please check later or contact support',
+                        });
+                    }
+                    if (routeObject.handler.constructor.name !== 'AsyncFunction') {
+                        const error = "Handler should be AsyncFunction. Perhabs you miss 'async' of function declaration?";
+                        this.logger?.error(error);
+                        return res.status(500).json({
+                            message: 'Platform error. Please check later or contact support',
+                        });
+                    }
+                    return routeObject.handler
+                        .call(this, req, res, next)
+                        .catch((e) => {
+                        this.logger?.error(e);
+                        return res.status(500).json({
+                            message: 'Platform error. Please check later or contact support',
+                        });
+                    });
+                });
+            }
+        }
+        /**
+         * Generate text info
+         */
+        const text = ['', `Controller '${this.getConstructorName()}' registered.`];
+        const reports = {
+            'Middlewares:': middlewaresInfo,
+            'Route middlewares:': routeMiddlewaresReg,
+            'Callbacks:': routesInfo,
+        };
+        for (const key in reports) {
+            text.push(`${key}`);
+            for (const item of reports[key]) {
+                text.push(`Path:'${item.path}'. Full path: '${item.fullPath}'. Method: '${item.method.toUpperCase()}'. Function: '${item.name}'`);
+            }
+        }
+        text.push(`Time: ${Date.now() - time} ms`);
+        this.logger?.verbose(text.join('\n'));
+        /**
+         * Generate documentation
+         */
+        if (!this.app.httpServer) {
+            this.app.documentation?.push(new DocumentationGenerator(this.app).convertDataToDocumentationElement(this.getConstructorName(), routesInfo, middlewaresInfo, routeMiddlewaresReg));
+        }
+        else {
+            this.app.httpServer.express.use(httpPath, this.router);
+        }
+    }
+    /**
+     * Parse middlewares to be an object.
+     */
+    parseMiddlewares(middlewareMap, httpPath) {
+        const middlewaresInfo = [];
+        for (let [path, middleware] of middlewareMap) {
+            if (!Array.isArray(middleware)) {
+                middleware = [middleware];
+            }
+            for (const M of middleware) {
+                let method = 'all';
+                let realPath = path;
+                if (typeof realPath !== 'string') {
+                    this.logger?.error(`Path not a string ${realPath}. Please check it`);
+                    continue;
+                }
+                if (!realPath.startsWith('/')) {
+                    method = realPath.split('/')[0]?.toLowerCase();
+                    if (!method) {
+                        this.logger?.error(`Method not found for ${realPath}`);
+                        continue;
+                    }
+                    realPath = realPath.substring(method.length);
+                }
+                if (typeof this.router[method] !== 'function') {
+                    this.logger?.error(`Method ${method} not exist for middleware. Please check your codebase`);
+                    continue;
+                }
+                const fullPath = `/${httpPath}/${realPath.toUpperCase()}`
+                    .split('//')
+                    .join('/')
+                    .split('//')
+                    .join('/');
+                let MiddlewareFunction;
+                let middlewareParams = {};
+                if (Array.isArray(M)) {
+                    [MiddlewareFunction, middlewareParams] = M;
+                }
+                else {
+                    MiddlewareFunction = M;
+                }
+                middlewaresInfo.push({
+                    name: MiddlewareFunction.name,
+                    method,
+                    path: realPath,
+                    fullPath,
+                    params: middlewareParams,
+                    relatedQueryParameters: new MiddlewareFunction(this.app, middlewareParams)?.relatedQueryParameters,
+                    authParams: new MiddlewareFunction(this.app, middlewareParams)
+                        ?.usedAuthParameters,
+                    MiddlewareFunction,
+                });
+            }
+        }
+        return middlewaresInfo;
+    }
+    /**
+     * Object with routes. Routes relative to controller
+     * @example
+     * return {
+     *   post: {
+     *     "/someUrl": {
+     *       handler: this.postSomeUrl,
+     *       request: yup.object().shape({
+     *         count: yup.number().max(100)required(),
+     *       })
+     *     }
+     *   },
+     * };
+     */
+    get routes() {
+        this.logger?.warn('Please implement "routes" method on controller.');
+        return {};
+    }
+    /**
+     * Array of middlewares to append for route
+     * You should provide path relative to controller and then array of middlewares to apply.
+     * Order is matter.
+     * Be default path apply to ANY' method, but you can preattach 'METHOD' into patch to scope patch to this METHOD
+     * @example
+     * return new Map([
+     *    ['/{*splat}', [GetUserByToken]] // for any method for this controller
+     *    ['POST/', [Auth]] // for POST method
+     *    ['/superSecretMethod', [OnlySuperSecretUsers]] // route with ANY method
+     *    ['PUT/superSecretMathod', [OnlySuperSecretAdmin]] // route with PUT method
+     * ]);
+     */
+    static get middleware() {
+        return new Map([['/{*splat}', [GetUserByToken, Auth]]]);
+    }
+    /**
+     * Get constructor name that can include preix
+     */
+    getConstructorName() {
+        if (this.prefix) {
+            return `${this.prefix.charAt(0).toUpperCase()}${this.prefix.slice(1)}/${this.constructor.name}`;
+        }
+        return this.constructor.name;
+    }
+    /**
+     * Get http path with inheritance of path
+     */
+    getHttpPath() {
+        return `/${this.getConstructorName().toLowerCase()}`.replace('//', '/');
+    }
+    static get loggerGroup() {
+        return 'controller';
+    }
+}
+export default AbstractController;
+//# sourceMappingURL=AbstractController.js.map

package/dist/modules/AbstractController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractController.js","sourceRoot":"","sources":["../../src/modules/AbstractController.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,sBAAsB,MAAM,qDAAqD,CAAC;AAGzF,OAAO,IAAI,MAAM,qCAAqC,CAAC;AACvD,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,eAAe,MAAM,yCAAyC,CAAC;AACtE,OAAO,IAAI,MAAM,WAAW,CAAC;AAuB7B;;;;;;GAMG;AACH,MAAM,kBAAmB,SAAQ,IAAI;IACnC,MAAM,GAAG,EAAE,CAAC;IACZ,MAAM,CAAU;IAEhB,YAAY,GAAS,EAAE,MAAc,EAAE,oBAAoB,GAAG,KAAK;QACjE,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACxB,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAC3B,WAAW,EAAE,oBAAoB;SAClC,CAAC,CAAC;QACH,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAEpC;;WAEG;QACH,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAAE,CAAC;QACnC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,EAAE;YACxD,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,EAAE;gBAC3D,IACE,OAAO,UAAU,KAAK,QAAQ;oBAC9B,UAAU,KAAK,IAAI;oBACnB,YAAY,IAAI,UAAU;oBAC1B,UAAU,CAAC,UAAU,EACrB,CAAC;oBACD,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC;oBAE/C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;wBACrC,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;oBACtC,CAAC;oBAED,gBAAgB,CAAC,GAAG,CAAC,SAAS,EAAE;wBAC9B,GAAG,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC;wBAClC,GAAG,UAAU,CAAC,UAAU;qBACzB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAG,IAAI,CAAC,gBAAgB,CAC/C,gBAAgB,EAChB,QAAQ,CACT,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAC1C,IAAI,CAAC,WAAyC,CAAC,UAAU,EAC1D,QAAQ,CACT,CAAC;QAEF,MAAM,UAAU,GAAG,EAAE,CAAC;QAEtB;;WAEG;QACH,KAAK,MAAM,UAAU,IAAI,eAAe,EAAE,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAuB,CAAc,CAC3D,UAAU,CAAC,IAAI,EACf,IAAI,UAAU,CAAC,kBAAkB,CAC/B,IAAI,CAAC,GAAG,EACR,UAAU,CAAC,MAAM,CAClB,CAAC,aAAa,EAAE,CAClB,CAAC;QACJ,CAAC;QAED;;WAEG;QACH,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,IAAqB,CAAC,KAAK,UAAU,EAAE,CAAC;gBAC7D,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,UAAU,IAAI,mDAAmD,CAClE,CAAC;gBACF,SAAS;YACX,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAChC,MAAM,0BAA0B,GAAG,mBAAmB,CAAC,MAAM,CAC3D,CAAC,UAAU,EAAE,EAAE,CACb,UAAU,CAAC,IAAI,KAAK,IAAI,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,CACzD,CAAC;gBAEF,IAAI,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAgB,CAAC;gBACpD,IAAI,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,iBAAiB,EAAE,CAAC;oBACtE,qDAAqD;oBACrD,WAAW,GAAG;wBACZ,OAAO,EAAE,WAAkC;wBAC3C,OAAO,EAAE,IAAI;wBACb,KAAK,EAAE,IAAI;wBACX,UAAU,EAAE,IAAI;qBACjB,CAAC;oBAEF,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;wBAC9C,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,2BACE,WAAW,CAAC,OACd,qBAAqB,IAAI,CAAC,kBAAkB,EAAE,GAAG,CAClD,CAAC;wBACF,SAAS;oBACX,CAAC;gBACH,CAAC;gBAED,MAAM,EAAE,OAAO,EAAE,GAAG,WAAW,CAAC;gBAChC,IAAI,MAA0B,CAAC;gBAC/B,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;oBAClC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;gBACxB,CAAC;qBAAM,CAAC;oBACN,MAAM,GAAG,SAAS,CAAC;gBACrB,CAAC;gBAED,MAAM,QAAQ,GAAG,IAAI,QAAQ,IAAI,IAAI,EAAE;qBACpC,KAAK,CAAC,IAAI,CAAC;qBACX,IAAI,CAAC,GAAG,CAAC;qBACT,KAAK,CAAC,IAAI,CAAC;qBACX,IAAI,CAAC,GAAG,CAAC,CAAC;gBAEb,UAAU,CAAC,IAAI,CAAC;oBACd,IAAI,EAAE,MAAM;oBACZ,WAAW,EAAE,WAAW,EAAE,WAAW;oBACrC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE;oBAC1B,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM;oBACpC,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM;oBACvC,IAAI;oBACJ,QAAQ;iBACT,CAAC,CAAC;gBACH,uBAAuB;gBACvB,gJAAgJ;gBAChJ,KAAK;gBAEL,IAAI,qBAA0B,CAAC;gBAE/B,IAAI,0BAA0B,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1C,qBAAqB,GAAG,KAAK,CAAC,IAAI,CAChC,0BAA0B,EAC1B,CAAC,EAAE,kBAAkB,EAAE,MAAM,EAAE,EAAE,EAAE,CACjC,IAAI,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,aAAa,EAAE,CAC3D,CAAC;gBACJ,CAAC;gBAEA,IAAI,CAAC,MAAM,CAAC,IAAqB,CAAc,CAC9C,IAAI,EACJ,qBAAqB,IAAI,EAAE,EAC3B,KAAK,EAAE,GAAqB,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;oBACjE,MAAM,UAAU,GAAG;wBACjB,KAAK,EAAE,GAAG,CAAC,KAAK;wBAChB,IAAI,EAAE,GAAG,CAAC,IAAI;wBACd,OAAO,EAAE,GAAG,CAAC,OAAO;qBACrB,CAAC;oBACF,IAAI,CAAC;wBACH,GAAG,CAAC,OAAO,CAAC,OAAO,GAAG,MAAM,IAAI,eAAe,CAC7C,IAAI,CAAC,GAAG,EACR,WAAW,EAAE,OAAO,CACrB,CAAC,eAAe,CAAC,UAAU,EAAE;4BAC5B,eAAe,EAAE,GAAG,CAAC,IAAI;4BACzB,8BAA8B,EAAE;gCAC9B,eAAe;gCACf,mBAAmB;gCACnB,OAAO,EAAE;oCACP,MAAM,EAAE,IAAI;oCACZ,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE,SAAS;iCAClB;6BACF;yBACF,CAAC,CAAC;wBACH,GAAG,CAAC,OAAO,CAAC,KAAK,GAAG,MAAM,IAAI,eAAe,CAC3C,IAAI,CAAC,GAAG,EACR,WAAW,EAAE,KAAK,CACnB,CAAC,eAAe,CAAC,UAAU,EAAE;4BAC5B,eAAe,EAAE,GAAG,CAAC,KAAK;4BAC1B,8BAA8B,EAAE;gCAC9B,eAAe;gCACf,mBAAmB;gCACnB,OAAO,EAAE;oCACP,MAAM,EAAE,IAAI;oCACZ,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE,OAAO;iCAChB;6BACF;yBACF,CAAC,CAAC;oBACL,CAAC;oBAAC,OAAO,GAAY,EAAE,CAAC;wBACtB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;4BAC1B,MAAM,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;yBACzD,CAAC,CAAC;oBACL,CAAC;oBACD,mCAAmC;oBACnC,6BAA6B;oBAC7B,wBAAwB;oBACxB,kGAAkG;oBAClG,SAAS;oBACT,2BAA2B;oBAC3B,OAAO;oBACP,MAAM;oBACN,qCAAqC;oBACrC,6BAA6B;oBAC7B,wBAAwB;oBACxB,+FAA+F;oBAC/F,SAAS;oBACT,2BAA2B;oBAC3B,OAAO;oBACP,MAAM;oBAEN,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;wBACzB,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,sCAAsC,CAAC,CAAC;wBAC3D,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;4BAC1B,OAAO,EACL,yDAAyD;yBAC5D,CAAC,CAAC;oBACL,CAAC;oBAED,IAAI,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;wBAC7D,MAAM,KAAK,GACT,oFAAoF,CAAC;wBACvF,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;wBAC1B,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;4BAC1B,OAAO,EACL,uDAAuD;yBAC1D,CAAC,CAAC;oBACL,CAAC;oBACD,OAAO,WAAW,CAAC,OAAO;yBACvB,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;yBAC1B,KAAK,CAAC,CAAC,CAAQ,EAAE,EAAE;wBAClB,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;wBACtB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;4BAC1B,OAAO,EACL,uDAAuD;yBAC1D,CAAC,CAAC;oBACL,CAAC,CAAC,CAAC;gBACP,CAAC,CACF,CAAC;YACJ,CAAC;QACH,CAAC;QAED;;WAEG;QACH,MAAM,IAAI,GAAG,CAAC,EAAE,EAAE,eAAe,IAAI,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;QAE3E,MAAM,OAAO,GAET;YACF,cAAc,EAAE,eAAe;YAC/B,oBAAoB,EAAE,mBAAmB;YACzC,YAAY,EAAE,UAAU;SACzB,CAAC;QACF,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;YACpB,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,IAAI,CACP,SAAS,IAAI,CAAC,IAAI,kBAChB,IAAI,CAAC,QACP,eAAe,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,iBAAiB,IAAI,CAAC,IAAI,GAAG,CACtE,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,KAAK,CAAC,CAAC;QAE3C,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEtC;;WAEG;QACH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAC1B,IAAI,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,iCAAiC,CACpE,IAAI,CAAC,kBAAkB,EAAE,EACzB,UAAU,EACV,eAAe,EACf,mBAAmB,CACpB,CACF,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,aAAuC,EAAE,QAAgB;QACxE,MAAM,eAAe,GAAG,EAAE,CAAC;QAC3B,KAAK,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,aAAa,EAAE,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC/B,UAAU,GAAG,CAAC,UAAU,CAAC,CAAC;YAC5B,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;gBAC3B,IAAI,MAAM,GAAG,KAAK,CAAC;gBACnB,IAAI,QAAQ,GAAG,IAAI,CAAC;gBACpB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBACjC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,qBAAqB,QAAQ,mBAAmB,CAAC,CAAC;oBACrE,SAAS;gBACX,CAAC;gBACD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBAC9B,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;oBAC/C,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,wBAAwB,QAAQ,EAAE,CAAC,CAAC;wBACvD,SAAS;oBACX,CAAC;oBACD,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC/C,CAAC;gBACD,IAAI,OAAO,IAAI,CAAC,MAAM,CAAC,MAAuB,CAAC,KAAK,UAAU,EAAE,CAAC;oBAC/D,IAAI,CAAC,MAAM,EAAE,KAAK,CAChB,UAAU,MAAM,uDAAuD,CACxE,CAAC;oBACF,SAAS;gBACX,CAAC;gBACD,MAAM,QAAQ,GAAG,IAAI,QAAQ,IAAI,QAAQ,CAAC,WAAW,EAAE,EAAE;qBACtD,KAAK,CAAC,IAAI,CAAC;qBACX,IAAI,CAAC,GAAG,CAAC;qBACT,KAAK,CAAC,IAAI,CAAC;qBACX,IAAI,CAAC,GAAG,CAAC,CAAC;gBACb,IAAI,kBAA6C,CAAC;gBAClD,IAAI,gBAAgB,GAAG,EAAE,CAAC;gBAC1B,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;oBACrB,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC;gBAC7C,CAAC;qBAAM,CAAC;oBACN,kBAAkB,GAAG,CAAC,CAAC;gBACzB,CAAC;gBAED,eAAe,CAAC,IAAI,CAAC;oBACnB,IAAI,EAAE,kBAAkB,CAAC,IAAI;oBAC7B,MAAM;oBACN,IAAI,EAAE,QAAQ;oBACd,QAAQ;oBACR,MAAM,EAAE,gBAAgB;oBACxB,sBAAsB,EAAE,IAAI,kBAAkB,CAC5C,IAAI,CAAC,GAAG,EACR,gBAAgB,CACjB,EAAE,sBAAsB;oBACzB,UAAU,EAAE,IAAI,kBAAkB,CAAC,IAAI,CAAC,GAAG,EAAE,gBAAgB,CAAC;wBAC5D,EAAE,kBAAkB;oBACtB,kBAAkB;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,MAAM;QACR,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,iDAAiD,CAAC,CAAC;QACrE,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,KAAK,UAAU;QACnB,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,IAClE,IAAI,CAAC,WAAW,CAAC,IACnB,EAAE,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC1E,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AAED,eAAe,kBAAkB,CAAC"}

package/dist/modules/AbstractModel.d.ts

@@ -0,0 +1,29 @@
+import type { Model, Schema } from 'mongoose';
+import type { IApp } from '../server.ts';
+import Base from './Base.ts';
+export interface IAbstractModelMethods<T> {
+    getSuper(): AbstractModel<T> & this;
+}
+export interface IAbstractModel<IDocument, IMethods> extends Model<IDocument, object, IMethods> {
+    getSuper(): AbstractModel<IDocument> & this;
+}
+declare class AbstractModel<IDocument = object, IMethods extends IAbstractModelMethods<IDocument> = IAbstractModelMethods<IDocument>, IModel extends IAbstractModel<IDocument, IMethods> = IAbstractModel<IDocument, IMethods>> extends Base {
+    mongooseSchema: Schema<IDocument, IModel, IMethods>;
+    mongooseModel: IModel;
+    /**
+     * @param IApp app
+     * @param function callback optional callback when connection ready
+     */
+    constructor(app: IApp);
+    /**
+     * Mongoose schema
+     */
+    get modelSchema(): {};
+    /**
+     * Mongoose schema options
+     */
+    get modelSchemaOptions(): {};
+    static get loggerGroup(): string;
+    initHooks(): void;
+}
+export default AbstractModel;

package/dist/modules/AbstractModel.js

@@ -0,0 +1,42 @@
+import mongoose from 'mongoose';
+import Base from "./Base.js";
+class AbstractModel extends Base {
+    mongooseSchema;
+    mongooseModel;
+    /**
+     * @param IApp app
+     * @param function callback optional callback when connection ready
+     */
+    constructor(app) {
+        super(app);
+        this.mongooseSchema = new mongoose.Schema(this.modelSchema, this.modelSchemaOptions);
+        this.mongooseSchema.set('timestamps', true);
+        this.mongooseSchema.set('minimize', false);
+        this.mongooseSchema.loadClass(this.constructor);
+        this.mongooseSchema.static('getSuper', () => this);
+        this.mongooseSchema.method('getSuper', () => this);
+        this.initHooks();
+        this.mongooseModel = mongoose.model(this.constructor.name, this.mongooseSchema);
+    }
+    /**
+     * Mongoose schema
+     */
+    get modelSchema() {
+        this.logger?.warn('You should provide modelSchema');
+        return {};
+    }
+    /**
+     * Mongoose schema options
+     */
+    get modelSchemaOptions() {
+        return {};
+    }
+    static get loggerGroup() {
+        return 'model';
+    }
+    initHooks() {
+        this.logger?.verbose(`Model ${this.constructor.name} has no custom hooks.`);
+    }
+}
+export default AbstractModel;
+//# sourceMappingURL=AbstractModel.js.map

package/dist/modules/AbstractModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractModel.js","sourceRoot":"","sources":["../../src/modules/AbstractModel.ts"],"names":[],"mappings":"AACA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAGhC,OAAO,IAAI,MAAM,WAAW,CAAC;AAW7B,MAAM,aAQJ,SAAQ,IAAI;IACZ,cAAc,CAAsC;IAEpD,aAAa,CAAS;IAEtB;;;OAGG;IACH,YAAY,GAAS;QACnB,KAAK,CAAC,GAAG,CAAC,CAAC;QACX,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,MAAM,CACvC,IAAI,CAAC,WAAW,EAChB,IAAI,CAAC,kBAAkB,CACxB,CAAC;QACF,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,KAAK,CACjC,IAAI,CAAC,WAAW,CAAC,IAAI,EACrB,IAAI,CAAC,cAAc,CACpB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACb,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,gCAAgC,CAAC,CAAC;QACpD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,IAAI,kBAAkB;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,KAAK,WAAW;QACpB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,SAAS;QACP,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,SAAS,IAAI,CAAC,WAAW,CAAC,IAAI,uBAAuB,CAAC,CAAC;IAC9E,CAAC;CACF;AACD,eAAe,aAAa,CAAC"}

package/dist/modules/Base.d.ts

@@ -0,0 +1,29 @@
+import type winston from 'winston';
+import type { IApp } from '../server.ts';
+declare class Base {
+    #private;
+    app: IApp;
+    constructor(app: IApp);
+    /**
+     * In case of logging sometimes we might need to replace name
+     */
+    getConstructorName(): string;
+    /**
+     * Optimzation to lazy load logger. It will be inited only on request
+     */
+    get logger(): winston.Logger | null;
+    /**
+     * Get winston loger for given label
+     * @param {string} label name of logger
+     */
+    getLogger(label: string): winston.Logger;
+    getFilesPathWithInheritance(internalFolder: string, externalFolder: string, isUseSimpleLogger?: boolean): Promise<{
+        path: string;
+        file: string;
+    }[]>;
+    /**
+     * Return logger group. Just to have all logs groupped logically
+     */
+    static get loggerGroup(): string;
+}
+export default Base;

package/dist/modules/Base.js

@@ -0,0 +1,58 @@
+import { getFilesPathWithInheritance } from "../helpers/files.js";
+import { consoleLogger } from "../helpers/logger.js";
+class Base {
+    #realLogger = null;
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    /**
+     * In case of logging sometimes we might need to replace name
+     */
+    getConstructorName() {
+        return this.constructor.name;
+    }
+    /**
+     * Optimzation to lazy load logger. It will be inited only on request
+     */
+    get logger() {
+        let l;
+        try {
+            l = this.#realLogger;
+        }
+        catch {
+            console.warn(`You try to accees logger not from class. that can be ok in case of models.`);
+            return null;
+        }
+        if (!l) {
+            const { loggerGroup } = this.constructor;
+            this.#realLogger = this.getLogger(loggerGroup + this.getConstructorName());
+        }
+        return this.#realLogger;
+    }
+    /**
+     * Get winston loger for given label
+     * @param {string} label name of logger
+     */
+    getLogger(label) {
+        return this.app.logger.child({ label });
+    }
+    async getFilesPathWithInheritance(internalFolder, externalFolder, isUseSimpleLogger = false) {
+        const logger = isUseSimpleLogger
+            ? (m) => consoleLogger('info', m)
+            : (m) => this.logger?.verbose(m);
+        return getFilesPathWithInheritance({
+            internalFolder,
+            externalFolder,
+            logger,
+        });
+    }
+    /**
+     * Return logger group. Just to have all logs groupped logically
+     */
+    static get loggerGroup() {
+        return 'Base_please_overwrite_';
+    }
+}
+export default Base;
+//# sourceMappingURL=Base.js.map

package/dist/modules/Base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.js","sourceRoot":"","sources":["../../src/modules/Base.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,2BAA2B,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAGrD,MAAM,IAAI;IACR,WAAW,GAA0B,IAAI,CAAC;IAE1C,GAAG,CAAO;IAEV,YAAY,GAAS;QACnB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,IAAI,CAAwB,CAAC;QAC7B,IAAI,CAAC;YACH,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvB,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,CAAC,IAAI,CACV,4EAA4E,CAC7E,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,CAAC,EAAE,CAAC;YACP,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,WAA0B,CAAC;YACxD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAC/B,WAAW,GAAG,IAAI,CAAC,kBAAkB,EAAE,CACxC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,KAAa;QACrB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,2BAA2B,CAC/B,cAAsB,EACtB,cAAsB,EACtB,iBAAiB,GAAG,KAAK;QAEzB,MAAM,MAAM,GAAG,iBAAiB;YAC9B,CAAC,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;YACzC,CAAC,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QAC3C,OAAO,2BAA2B,CAAC;YACjC,cAAc;YACd,cAAc;YACd,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,KAAK,WAAW;QACpB,OAAO,wBAAwB,CAAC;IAClC,CAAC;CACF;AAED,eAAe,IAAI,CAAC"}

package/dist/modules/BaseCli.d.ts

@@ -0,0 +1,25 @@
+import type { ParseArgsOptionDescriptor } from 'node:util';
+import type AbstractCommand from '../modules/AbstractCommand.ts';
+import type Server from '../server.ts';
+import Base from './Base.ts';
+export interface ParseArgsOptionsConfigExtended extends ParseArgsOptionDescriptor {
+    /**
+     * A description of the option.
+     */
+    description?: string;
+    /**
+     * Is it required?
+     */
+    required?: boolean;
+}
+declare class Cli extends Base {
+    server: Server;
+    commands: Record<string, string>;
+    constructor(server: Server);
+    loadCommands(): Promise<boolean>;
+    printCommandTable(): Promise<void>;
+    static showHelp(Command: typeof AbstractCommand, finalArguments: Record<string, ParseArgsOptionsConfigExtended>): void;
+    run(command: string): Promise<boolean | void>;
+    static get loggerGroup(): string;
+}
+export default Cli;