namirasoft-node 1.1.4 → 1.1.5

package/src/BaseApplication.ts

@@ -1,187 +1,187 @@
-import express, { Router } from 'express';
-import cors from "cors";
-import fs from "fs";
-import swaggerUi from 'swagger-ui-express';
-import swaggerJSDoc from 'swagger-jsdoc';
-import { BaseDatabase } from './BaseDatabase';
-import { ILogger } from "namirasoft-log";
-import { BaseApplicationLink } from './BaseApplicationLink';
-import path from 'path';
-import { PackageService } from 'namirasoft-core';
-
-export abstract class BaseApplication<D extends BaseDatabase>
-{
-    private title: string;
-    private description: string;
-    private logo: string;
-    private version: string;
-    private serverPath: string;
-    private swaggerPath: string;
-    private linkLoader?: () => Promise<void>;
-    private links: BaseApplicationLink[] = [];
-    public app!: express.Express;
-    public database!: D;
-    public logger: ILogger;
-    protected abstract getDatabase(): D;
-    protected abstract getLogger(): ILogger;
-    protected abstract getRouter(): Router;
-    protected abstract getPort(): number;
-    constructor(serverPath: string, swaggerPath: string | null = null)
-    {
-        let json = PackageService.getMain();
-        this.title = json?.getTitle() ?? "";
-        this.description = json?.getDescription() ?? "";
-        this.logo = json?.getLogo() ?? "";
-        this.version = json?.getVersion() ?? "";
-        this.serverPath = serverPath;
-        this.swaggerPath = swaggerPath ?? (serverPath + "/swagger");
-        this.logger = this.getLogger();
-        this.addLink = this.addLink.bind(this);
-        this.addSwaggerLink = this.addSwaggerLink.bind(this);
-    }
-    setLinkLoader(linkLoader: () => Promise<void>)
-    {
-        this.linkLoader = linkLoader;
-    }
-    addLink(link: BaseApplicationLink)
-    {
-        this.links.push(link);
-    }
-    addSwaggerLink()
-    {
-        this.addLink({
-            name: "Swagger",
-            url: this.swaggerPath + "/",
-            logo: "https://static.namirasoft.com/logo/swagger/base.png",
-            description: this.description + " Swagger"
-        });
-    }
-    async start()
-    {
-        await this.startCrashHandler();
-        await this.startDatabase();
-        await this.startServer();
-        await this.startSwagger();
-        await this.startHomePage();
-        await this.onStart();
-    }
-    protected async startCrashHandler(): Promise<void>
-    {
-        process.on('unhandledRejection', (reason) =>
-        {
-            if (reason instanceof Error)
-                this.logger.onCatchCritical(reason);
-            else
-                this.logger.critical(reason + "");
-        });
-        process.on('uncaughtException', (error) =>
-        {
-            this.logger.onCatchFatal(error);
-        });
-    }
-    protected async startDatabase(): Promise<void>
-    {
-        this.database = this.getDatabase();
-        this.database.init();
-        await this.database.sync(false);
-    }
-    protected async startServer(): Promise<void>
-    {
-        this.app = express();
-        this.app.use((req, res, next) =>
-        {
-            let excludes: string[] = [];
-            if (excludes.includes(req.path))
-                next();
-            else
-                express.json({ limit: '100kb' })(req, res, next);
-        });
-        // Express
-        this.app.use(express.static('static'));
-        // Cors
-        this.app.use(cors({ exposedHeaders: '*', }));
-        // api routes
-        this.app.use('/', this.getRouter());
-        // start server
-        const port = this.getPort();
-        this.app.listen(port, async () =>
-        {
-            this.logger.info(`Server listening on port ${port}`);
-        });
-    }
-    protected async startSwagger(): Promise<void>
-    {
-        const joptions = {
-            definition: {
-                openapi: "3.0.1",
-                info: {
-                    title: this.title,
-                    description: this.description,
-                    version: this.version,
-                    // license: {
-                    //     name: "MIT",
-                    //     url: "https://spdx.org/licenses/MIT.html",
-                    // },
-                    // contact: {
-                    //     name: "Amir Abolhasani",
-                    //     url: "https://namirasoft.com",
-                    //     email: "accounts@namirasoft.com",
-                    // },
-                },
-                servers: [
-                    {
-                        url: this.serverPath,
-                    },
-                ],
-            },
-            apis: ['./src/route/*.ts'],
-        };
-        const swaggerSpec = swaggerJSDoc(joptions);
-        var options = {
-            explorer: true
-        };
-        this.app.use(this.swaggerPath + "/", swaggerUi.serve, swaggerUi.setup(swaggerSpec, options));
-    }
-    protected async startHomePage(): Promise<void>
-    {
-        this.app.get(this.serverPath + "/", (_, res) =>
-        {
-            const htmlFilePath = path.join(__dirname, '../public/index.html');
-            fs.readFile(htmlFilePath, 'utf8', async (err: any, data: string) =>
-            {
-                if (err)
-                    return res.status(500).send('Error reading HTML file');
-
-                data = data.replace(/\@title/gm, this.title);
-                data = data.replace(/\@description/gm, this.description);
-                data = data.replace(/\@logo/gm, this.logo);
-                let match = /<\@row>([\w\W]*)<\/\@row>/gm.exec(data);
-                if (match)
-                {
-                    let rows: string[] = [];
-                    if (this.linkLoader)
-                    {
-                        this.links = [];
-                        await this.linkLoader();
-                    }
-                    this.links.forEach(link =>
-                    {
-                        if (match)
-                        {
-                            let row = match[1];
-                            row = row.replace(/\@row_name/gm, link.name);
-                            row = row.replace(/\@row_url/gm, link.url);
-                            row = row.replace(/\@row_logo/gm, link.logo);
-                            row = row.replace(/\@row_description/gm, link.description);
-                            rows.push(row);
-                        }
-                    });
-                    data = data.replace(match[0], rows.join(" "));
-                }
-                res.send(data);
-                return;
-            });
-        });
-    }
-    abstract onStart(): Promise<void>;
+import express, { Router } from 'express';
+import cors from "cors";
+import fs from "fs";
+import swaggerUi from 'swagger-ui-express';
+import swaggerJSDoc from 'swagger-jsdoc';
+import { BaseDatabase } from './BaseDatabase';
+import { ILogger } from "namirasoft-log";
+import { BaseApplicationLink } from './BaseApplicationLink';
+import path from 'path';
+import { PackageService } from 'namirasoft-core';
+
+export abstract class BaseApplication<D extends BaseDatabase>
+{
+    private title: string;
+    private description: string;
+    private logo: string;
+    private version: string;
+    private serverPath: string;
+    private swaggerPath: string;
+    private linkLoader?: () => Promise<void>;
+    private links: BaseApplicationLink[] = [];
+    public app!: express.Express;
+    public database!: D;
+    public logger: ILogger;
+    protected abstract getDatabase(): D;
+    protected abstract getLogger(): ILogger;
+    protected abstract getRouter(): Router;
+    protected abstract getPort(): number;
+    constructor(serverPath: string, swaggerPath: string | null = null)
+    {
+        let json = PackageService.getMain();
+        this.title = json?.getTitle() ?? "";
+        this.description = json?.getDescription() ?? "";
+        this.logo = json?.getLogo() ?? "";
+        this.version = json?.getVersion() ?? "";
+        this.serverPath = serverPath;
+        this.swaggerPath = swaggerPath ?? (serverPath + "/swagger");
+        this.logger = this.getLogger();
+        this.addLink = this.addLink.bind(this);
+        this.addSwaggerLink = this.addSwaggerLink.bind(this);
+    }
+    setLinkLoader(linkLoader: () => Promise<void>)
+    {
+        this.linkLoader = linkLoader;
+    }
+    addLink(link: BaseApplicationLink)
+    {
+        this.links.push(link);
+    }
+    addSwaggerLink()
+    {
+        this.addLink({
+            name: "Swagger",
+            url: this.swaggerPath + "/",
+            logo: "https://static.namirasoft.com/logo/swagger/base.png",
+            description: this.description + " Swagger"
+        });
+    }
+    async start()
+    {
+        await this.startCrashHandler();
+        await this.startDatabase();
+        await this.startServer();
+        await this.startSwagger();
+        await this.startHomePage();
+        await this.onStart();
+    }
+    protected async startCrashHandler(): Promise<void>
+    {
+        process.on('unhandledRejection', (reason) =>
+        {
+            if (reason instanceof Error)
+                this.logger.onCatchCritical(reason);
+            else
+                this.logger.critical(reason + "");
+        });
+        process.on('uncaughtException', (error) =>
+        {
+            this.logger.onCatchFatal(error);
+        });
+    }
+    protected async startDatabase(): Promise<void>
+    {
+        this.database = this.getDatabase();
+        this.database.init();
+        await this.database.sync(false);
+    }
+    protected async startServer(): Promise<void>
+    {
+        this.app = express();
+        this.app.use((req, res, next) =>
+        {
+            let excludes: string[] = [];
+            if (excludes.includes(req.path))
+                next();
+            else
+                express.json({ limit: '100kb' })(req, res, next);
+        });
+        // Express
+        this.app.use(express.static('static'));
+        // Cors
+        this.app.use(cors({ exposedHeaders: '*', }));
+        // api routes
+        this.app.use('/', this.getRouter());
+        // start server
+        const port = this.getPort();
+        this.app.listen(port, async () =>
+        {
+            this.logger.info(`Server listening on port ${port}`);
+        });
+    }
+    protected async startSwagger(): Promise<void>
+    {
+        const joptions = {
+            definition: {
+                openapi: "3.0.1",
+                info: {
+                    title: this.title,
+                    description: this.description,
+                    version: this.version,
+                    // license: {
+                    //     name: "MIT",
+                    //     url: "https://spdx.org/licenses/MIT.html",
+                    // },
+                    // contact: {
+                    //     name: "Amir Abolhasani",
+                    //     url: "https://namirasoft.com",
+                    //     email: "accounts@namirasoft.com",
+                    // },
+                },
+                servers: [
+                    {
+                        url: this.serverPath,
+                    },
+                ],
+            },
+            apis: ['./src/route/*.ts'],
+        };
+        const swaggerSpec = swaggerJSDoc(joptions);
+        var options = {
+            explorer: true
+        };
+        this.app.use(this.swaggerPath + "/", swaggerUi.serve, swaggerUi.setup(swaggerSpec, options));
+    }
+    protected async startHomePage(): Promise<void>
+    {
+        this.app.get(this.serverPath + "/", (_, res) =>
+        {
+            const htmlFilePath = path.join(__dirname, '../public/index.html');
+            fs.readFile(htmlFilePath, 'utf8', async (err: any, data: string) =>
+            {
+                if (err)
+                    return res.status(500).send('Error reading HTML file');
+
+                data = data.replace(/\@title/gm, this.title);
+                data = data.replace(/\@description/gm, this.description);
+                data = data.replace(/\@logo/gm, this.logo);
+                let match = /<\@row>([\w\W]*)<\/\@row>/gm.exec(data);
+                if (match)
+                {
+                    let rows: string[] = [];
+                    if (this.linkLoader)
+                    {
+                        this.links = [];
+                        await this.linkLoader();
+                    }
+                    this.links.forEach(link =>
+                    {
+                        if (match)
+                        {
+                            let row = match[1];
+                            row = row.replace(/\@row_name/gm, link.name);
+                            row = row.replace(/\@row_url/gm, link.url);
+                            row = row.replace(/\@row_logo/gm, link.logo);
+                            row = row.replace(/\@row_description/gm, link.description);
+                            rows.push(row);
+                        }
+                    });
+                    data = data.replace(match[0], rows.join(" "));
+                }
+                res.send(data);
+                return;
+            });
+        });
+    }
+    abstract onStart(): Promise<void>;
 }

package/src/BaseApplicationLink.ts

@@ -1,7 +1,7 @@
-export type BaseApplicationLink =
-    {
-        name: string;
-        url: string;
-        logo: string;
-        description: string;
+export type BaseApplicationLink =
+    {
+        name: string;
+        url: string;
+        logo: string;
+        description: string;
     };

package/src/BaseController.ts

@@ -1,132 +1,132 @@
-import * as express from 'express';
-import { BaseDatabase } from './BaseDatabase';
-import { SchemaLike } from 'joi';
-import { AnomalyDetector } from './AnomalyDetector';
-import { ILogger } from 'namirasoft-log';
-import { Meta } from './Meta';
-import Joi from 'joi';
-import { ErrorOperation, HTTPError } from 'namirasoft-core';
-
-export abstract class BaseController<D extends BaseDatabase, State, Props>
-{
-    protected showLogAtTheBeginning: boolean = false;
-    protected showLogAtTheEnd: boolean = true;
-    protected req: express.Request;
-    protected res: express.Response;
-    protected logger: ILogger;
-    protected meta!: Meta;
-    protected result!: {};
-    protected database!: D;
-    protected state!: State;
-    protected props!: Props;
-    constructor(req: express.Request, res: express.Response)
-    {
-        this.req = req;
-        this.res = res;
-        this.logger = this.getLogger();
-    }
-    abstract getLogger(): ILogger;
-    abstract getDatabase(): D;
-    abstract getAnomaly(): AnomalyDetector | null;
-    abstract getBodySchema(): SchemaLike | null;
-    abstract getQuerySchema(): SchemaLike | null;
-    abstract getState(): Promise<State>;
-    abstract getProps(): Promise<Props>;
-    abstract preHandle(): Promise<void>;
-    abstract handle(): Promise<any>;
-    abstract postHandle(): Promise<void>;
-
-    async run()
-    {
-        this.meta = new Meta(this.req);
-        // result
-        this.result = {};
-        try
-        {
-            // meta
-            this.meta.onStart();
-            if (this.showLogAtTheBeginning)
-                this.logger.info(JSON.stringify(this.meta));
-            // init controller
-            this.database = this.getDatabase();
-            this.database.init();
-            this.state = await this.getState();
-            this.props = await this.getProps();
-
-            // preHandle
-            await this.preHandle();
-
-            // check for anomaly
-            let anomaly: AnomalyDetector | null = this.getAnomaly();
-            if (anomaly != null)
-                if (anomaly.isAnomaly(this.meta.ip, this.meta.url))
-                    ErrorOperation.throwHTTP(403, 'Suspicious activity detected.');
-
-            // check body validation
-            let bodySchema = this.getBodySchema();
-            if (bodySchema != null)
-            {
-                const validation = await Joi.compile(bodySchema)
-                    .prefs({ errors: { label: 'key' } })
-                    .validate(this.req.body);
-                if (validation.error)
-                {
-                    let message = validation.error.details.map((details) => details.message).join(', ');
-                    ErrorOperation.throwHTTP(400, message);
-                }
-            }
-            // check query validation
-            let querySchema = this.getQuerySchema();
-            if (querySchema != null)
-            {
-                const validation = await Joi.compile(querySchema)
-                    .prefs({ errors: { label: 'key' } })
-                    .validate(this.req.query);
-                if (validation.error)
-                {
-                    let message = validation.error.details.map((details) => details.message).join(', ');
-                    ErrorOperation.throwHTTP(400, message);
-                }
-            }
-
-            // call controller
-            this.result = await this.handle();
-            if (this.result == null)
-                this.result = "Success";
-
-            // postHandle
-            await this.postHandle();
-        } catch (error)
-        {
-            let message: string;
-            if (error instanceof Error)
-            {
-                this.meta.error = error;
-                message = error.message;
-            }
-            else
-                message = error + "";
-
-            if (error instanceof HTTPError)
-            {
-                this.meta.code = error.code;
-                this.logger.error(error.message + "\n" + JSON.stringify(this.meta), undefined, error.stack);
-            }
-            else
-            {
-                this.meta.code = 500;
-                if (error instanceof Error)
-                    this.logger.critical(error.message + "\n" + JSON.stringify(this.meta), undefined, error.stack);
-            }
-            this.meta.message = message;
-            if (error instanceof HTTPError)
-                this.result = this.meta.message;
-            else
-                this.result = "Sorry, internl server error.";
-        }
-        this.meta.onFinish();
-        if (this.showLogAtTheEnd)
-            this.logger.info(JSON.stringify(this.meta));
-        return this.res.status(this.meta.code).send(this.result);
-    }
+import * as express from 'express';
+import { BaseDatabase } from './BaseDatabase';
+import { SchemaLike } from 'joi';
+import { AnomalyDetector } from './AnomalyDetector';
+import { ILogger } from 'namirasoft-log';
+import { Meta } from './Meta';
+import Joi from 'joi';
+import { ErrorOperation, HTTPError } from 'namirasoft-core';
+
+export abstract class BaseController<D extends BaseDatabase, State, Props>
+{
+    protected showLogAtTheBeginning: boolean = false;
+    protected showLogAtTheEnd: boolean = true;
+    protected req: express.Request;
+    protected res: express.Response;
+    protected logger: ILogger;
+    protected meta!: Meta;
+    protected result!: {};
+    protected database!: D;
+    protected state!: State;
+    protected props!: Props;
+    constructor(req: express.Request, res: express.Response)
+    {
+        this.req = req;
+        this.res = res;
+        this.logger = this.getLogger();
+    }
+    abstract getLogger(): ILogger;
+    abstract getDatabase(): D;
+    abstract getAnomaly(): AnomalyDetector | null;
+    abstract getBodySchema(): SchemaLike | null;
+    abstract getQuerySchema(): SchemaLike | null;
+    abstract getState(): Promise<State>;
+    abstract getProps(): Promise<Props>;
+    abstract preHandle(): Promise<void>;
+    abstract handle(): Promise<any>;
+    abstract postHandle(): Promise<void>;
+
+    async run()
+    {
+        this.meta = new Meta(this.req);
+        // result
+        this.result = {};
+        try
+        {
+            // meta
+            this.meta.onStart();
+            if (this.showLogAtTheBeginning)
+                this.logger.info(JSON.stringify(this.meta));
+            // init controller
+            this.database = this.getDatabase();
+            this.database.init();
+            this.state = await this.getState();
+            this.props = await this.getProps();
+
+            // preHandle
+            await this.preHandle();
+
+            // check for anomaly
+            let anomaly: AnomalyDetector | null = this.getAnomaly();
+            if (anomaly != null)
+                if (anomaly.isAnomaly(this.meta.ip, this.meta.url))
+                    ErrorOperation.throwHTTP(403, 'Suspicious activity detected.');
+
+            // check body validation
+            let bodySchema = this.getBodySchema();
+            if (bodySchema != null)
+            {
+                const validation = await Joi.compile(bodySchema)
+                    .prefs({ errors: { label: 'key' } })
+                    .validate(this.req.body);
+                if (validation.error)
+                {
+                    let message = validation.error.details.map((details) => details.message).join(', ');
+                    ErrorOperation.throwHTTP(400, message);
+                }
+            }
+            // check query validation
+            let querySchema = this.getQuerySchema();
+            if (querySchema != null)
+            {
+                const validation = await Joi.compile(querySchema)
+                    .prefs({ errors: { label: 'key' } })
+                    .validate(this.req.query);
+                if (validation.error)
+                {
+                    let message = validation.error.details.map((details) => details.message).join(', ');
+                    ErrorOperation.throwHTTP(400, message);
+                }
+            }
+
+            // call controller
+            this.result = await this.handle();
+            if (this.result == null)
+                this.result = "Success";
+
+            // postHandle
+            await this.postHandle();
+        } catch (error)
+        {
+            let message: string;
+            if (error instanceof Error)
+            {
+                this.meta.error = error;
+                message = error.message;
+            }
+            else
+                message = error + "";
+
+            if (error instanceof HTTPError)
+            {
+                this.meta.code = error.code;
+                this.logger.error(error.message + "\n" + JSON.stringify(this.meta), undefined, error.stack);
+            }
+            else
+            {
+                this.meta.code = 500;
+                if (error instanceof Error)
+                    this.logger.critical(error.message + "\n" + JSON.stringify(this.meta), undefined, error.stack);
+            }
+            this.meta.message = message;
+            if (error instanceof HTTPError)
+                this.result = this.meta.message;
+            else
+                this.result = "Sorry, internl server error.";
+        }
+        this.meta.onFinish();
+        if (this.showLogAtTheEnd)
+            this.logger.info(JSON.stringify(this.meta));
+        return this.res.status(this.meta.code).send(this.result);
+    }
 }

package/src/BaseDatabase.ts

@@ -1,5 +1,5 @@
-export abstract class BaseDatabase
-{
-    abstract init(): void;
-    abstract sync(force: boolean): Promise<void>;
+export abstract class BaseDatabase
+{
+    abstract init(): void;
+    abstract sync(force: boolean): Promise<void>;
 }