@expressots/core 1.0.1 → 1.2.0

package/lib/esm/types/logger/general-logger.d.ts

@@ -0,0 +1,46 @@
+/**
+ * LogLevel enumeration defines the available log levels.
+ */
+declare enum LogLevel {
+    Debug = 0,
+    Error = 1,
+    Info = 2
+}
+/**
+ * GeneralLogger class is a utility class to manage logging within the application.
+ */
+declare class GeneralLogger {
+    private logger;
+    constructor();
+    /**
+     * Creates a console transport for logging.
+     * @returns {transports.ConsoleTransportInstance} A Winston console transport instance.
+     */
+    private createConsoleTransport;
+    /**
+     * Creates a rotational file transport for logging.
+     * @returns {DailyRotateFile} A Winston daily rotate file transport instance.
+     */
+    private createRotationalFileTransport;
+    /**
+     * Creates a logger options object for Winston.
+     * @returns {LoggerOptions} A Winston logger options object.
+     */
+    private createLoggerOptions;
+    /**
+     * Retrieves the path and line number of the error.
+     * @param error - An Error object containing error details.
+     * @returns {string} A string containing the path and line number of the error.
+     */
+    private getPathAndLine;
+    /**
+     * Logs a message or error with the specified log level and service.
+     * @param logLevel - The log level to use (Debug, Error, or Info).
+     * @param content - The message or Error object to log.
+     * @param service - The service name (optional) associated with the log.
+     */
+    log(logLevel: LogLevel, content: Error | string, service?: string): void;
+}
+declare const log: (logLevel: LogLevel, content: Error | string, service?: string) => void;
+export { LogLevel, GeneralLogger, log };
+//# sourceMappingURL=general-logger.d.ts.map

package/lib/esm/types/logger/general-logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"general-logger.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/logger/general-logger.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,aAAK,QAAQ;IACT,KAAK,IAAA;IACL,KAAK,IAAA;IACL,IAAI,IAAA;CACP;AAED;;GAEG;AACH,cACM,aAAa;IAEf,OAAO,CAAC,MAAM,CAAS;;IAMvB;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAW9B;;;OAGG;IACH,OAAO,CAAC,6BAA6B;IAerC;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAqB3B;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAYtB;;;;;OAKG;IACI,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;CAwB3E;AAGD,QAAA,MAAM,GAAG,aA3BgB,QAAQ,WAAW,KAAK,GAAG,MAAM,YAAY,MAAM,SA2B9C,CAAC;AAE/B,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC"}

package/lib/esm/types/logger/index.d.ts

@@ -0,0 +1,2 @@
+export { GeneralLogger, LogLevel, log } from './general-logger';
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/types/logger/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/logger/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC"}

package/lib/package.json

@@ -0,0 +1,146 @@
+{
+  "name": "@expressots/core",
+  "version": "1.2.0",
+  "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
+  "author": "Richard Zampieri",
+  "main": "./lib/cjs/index.js",
+  "types": "./lib/cjs/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/esm/types/index.d.ts",
+        "default": "./lib/esm/index.mjs"
+      },
+      "require": {
+        "types": "./lib/cjs/types/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      }
+    }
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "license": "MIT",
+  "homepage": "https://expresso-ts.com",
+  "funding": {
+    "type": "",
+    "url": ""
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/expressots/expressots"
+  },
+  "bugs": {
+    "url": "https://github.com/expressots/expressots/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "expressots",
+    "nodejs",
+    "microservices",
+    "typescript",
+    "clean-architecture",
+    "typescript-framework",
+    "framework",
+    "server-side"
+  ],
+  "engines": {
+    "node": ">=18.10.0"
+  },
+  "scripts": {
+    "win-clean": "if exist lib (del /q lib\\*)",
+    "linux-clean": "rm -f lib/*",
+    "win-cpy": "xcopy package.json lib\\ && xcopy README.md lib\\ && xcopy CHANGELOG.md lib\\ /Y",
+    "linux-cpy": "cp package.json README.md CHANGELOG.md lib/",
+    "build:win": "npm run win-clean && npm run build:esm && npm run build:cjs && npm run win-cpy",
+    "build:linux": "npm run linux-clean && npm run build:esm && npm run build:cjs && npm run linux-cpy",
+    "build:esm": "tsc -p tsconfig.esm.json && mv lib/esm/index.js lib/esm/index.mjs ",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "git": "powershell -Command \"git add .; git commit -m \"%1\"; npm run release\"",
+    "release": "release-it",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@commitlint/cli": "^17.5.1",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@release-it/conventional-changelog": "^5.1.1",
+    "chalk": "^4.1.2",
+    "dotenv": "^16.0.3",
+    "express": "^4.18.2",
+    "husky": "^8.0.3",
+    "inversify": "^6.0.1",
+    "inversify-binding-decorators": "^4.0.0",
+    "inversify-express-utils": "^6.4.3",
+    "jest": "^29.5.0",
+    "reflect-metadata": "^0.1.13",
+    "release-it": "^15.9.3",
+    "winston": "^3.8.2",
+    "winston-daily-rotate-file": "^4.7.1"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.11",
+    "ts-jest": "^29.0.5",
+    "typescript": "^5.0.3"
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore(release): ${version}"
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": false
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "infile": "CHANGELOG.md",
+        "preset": {
+          "name": "conventionalcommits",
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "perf",
+              "section": "Performance Improvements"
+            },
+            {
+              "type": "revert",
+              "section": "Reverts"
+            },
+            {
+              "type": "docs",
+              "section": "Documentation"
+            },
+            {
+              "type": "refactor",
+              "section": "Code Refactoring"
+            },
+            {
+              "type": "test",
+              "section": "Tests"
+            },
+            {
+              "type": "build",
+              "section": "Build System"
+            },
+            {
+              "type": "ci",
+              "section": "Continuous Integrations"
+            }
+          ]
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,9 +1,25 @@
 {
   "name": "@expressots/core",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
   "author": "Richard Zampieri",
-  "types": "./dist/index.d.ts",
+  "main": "./lib/cjs/index.js",
+  "types": "./lib/cjs/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/esm/types/index.d.ts",
+        "default": "./lib/esm/index.mjs"
+      },
+      "require": {
+        "types": "./lib/cjs/types/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      }
+    }
+  },
+  "files": [
+    "lib/**/*"
+  ],
   "license": "MIT",
   "homepage": "https://expresso-ts.com",
   "funding": {
@@ -14,36 +30,117 @@
     "type": "git",
     "url": "https://github.com/expressots/expressots"
   },
+  "bugs": {
+    "url": "https://github.com/expressots/expressots/issues"
+  },
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "expressots",
+    "nodejs",
+    "microservices",
+    "typescript",
+    "clean-architecture",
+    "typescript-framework",
+    "framework",
+    "server-side"
+  ],
   "engines": {
     "node": ">=18.10.0"
   },
   "scripts": {
-    "build": "tsc",
-    "postbuild": "xcopy \"package.json\" \"dist\" /y && xcopy \"README.md\" \"dist\" /y",
-    "release": "npm run build && npm run postbuild",
+    "win-clean": "if exist lib (del /q lib\\*)",
+    "linux-clean": "rm -f lib/*",
+    "win-cpy": "xcopy package.json lib\\ && xcopy README.md lib\\ && xcopy CHANGELOG.md lib\\ /Y",
+    "linux-cpy": "cp package.json README.md CHANGELOG.md lib/",
+    "build:win": "npm run win-clean && npm run build:esm && npm run build:cjs && npm run win-cpy",
+    "build:linux": "npm run linux-clean && npm run build:esm && npm run build:cjs && npm run linux-cpy",
+    "build:esm": "tsc -p tsconfig.esm.json && mv lib/esm/index.js lib/esm/index.mjs ",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "git": "powershell -Command \"git add .; git commit -m \"%1\"; npm run release\"",
+    "release": "release-it",
     "test": "jest"
   },
-  "keywords": [],
   "dependencies": {
+    "@commitlint/cli": "^17.5.1",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@release-it/conventional-changelog": "^5.1.1",
     "chalk": "^4.1.2",
     "dotenv": "^16.0.3",
     "express": "^4.18.2",
+    "husky": "^8.0.3",
     "inversify": "^6.0.1",
     "inversify-binding-decorators": "^4.0.0",
-    "inversify-express-utils": "^6.3.2",
+    "inversify-express-utils": "^6.4.3",
+    "jest": "^29.5.0",
     "reflect-metadata": "^0.1.13",
-    "typescript": "^4.9.5",
-    "winston": "^3.8.1",
+    "release-it": "^15.9.3",
+    "winston": "^3.8.2",
     "winston-daily-rotate-file": "^4.7.1"
   },
   "devDependencies": {
     "@types/express": "^4.17.17",
-    "@types/jest": "^29.4.0",
-    "jest": "^29.4.2",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.11",
     "ts-jest": "^29.0.5",
-    "ts-node-dev": "^2.0.0"
+    "typescript": "^5.0.3"
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore(release): ${version}"
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": false
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "infile": "CHANGELOG.md",
+        "preset": {
+          "name": "conventionalcommits",
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "perf",
+              "section": "Performance Improvements"
+            },
+            {
+              "type": "revert",
+              "section": "Reverts"
+            },
+            {
+              "type": "docs",
+              "section": "Documentation"
+            },
+            {
+              "type": "refactor",
+              "section": "Code Refactoring"
+            },
+            {
+              "type": "test",
+              "section": "Tests"
+            },
+            {
+              "type": "build",
+              "section": "Build System"
+            },
+            {
+              "type": "ci",
+              "section": "Continuous Integrations"
+            }
+          ]
+        }
+      }
+    }
   }
 }

package/application/app-container.d.ts

@@ -1,7 +0,0 @@
-import { Container, ContainerModule } from "inversify";
-declare class AppContainer {
-    private container;
-    constructor();
-    create(modules: ContainerModule[]): Container;
-}
-export { AppContainer };

package/application/app-container.js

@@ -1,20 +0,0 @@
-"use strict";
-var AppContainer_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppContainer = void 0;
-const tslib_1 = require("tslib");
-const inversify_1 = require("inversify");
-const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-let AppContainer = AppContainer_1 = class AppContainer {
-    constructor() { }
-    create(modules) {
-        this.container = new inversify_1.Container();
-        this.container.load((0, inversify_binding_decorators_1.buildProviderModule)(), ...modules);
-        return this.container;
-    }
-};
-AppContainer = AppContainer_1 = tslib_1.__decorate([
-    (0, inversify_binding_decorators_1.provide)(AppContainer_1),
-    tslib_1.__metadata("design:paramtypes", [])
-], AppContainer);
-exports.AppContainer = AppContainer;

package/application/application.d.ts

@@ -1,21 +0,0 @@
-import express from "express";
-import { Container } from "inversify";
-import { IApplicationMessageToConsole } from "../console/console";
-declare enum ServerEnvironment {
-    Development = "development",
-    Staging = "staging",
-    Production = "production"
-}
-declare class Application {
-    private app;
-    private port;
-    private environment;
-    constructor();
-    protected configureServices(): void;
-    protected postServerInitialization(): void;
-    protected serverShutdown(): void;
-    create(container: Container, middlewares?: express.RequestHandler[]): Application;
-    listen(port: number, environment: ServerEnvironment, consoleMessage?: IApplicationMessageToConsole): void;
-}
-declare const appServerInstance: Application;
-export { appServerInstance as AppInstance, Application, ServerEnvironment };

package/console/console.d.ts

@@ -1,9 +0,0 @@
-interface IApplicationMessageToConsole {
-    appName: string;
-    appVersion: string;
-}
-declare class Console {
-    private printColor;
-    messageServer(port: any, environment: string, consoleMessage?: IApplicationMessageToConsole): Promise<void>;
-}
-export { Console, IApplicationMessageToConsole };

package/console/console.js

@@ -1,56 +0,0 @@
-"use strict";
-var Console_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Console = void 0;
-const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-var ColorStyle;
-(function (ColorStyle) {
-    ColorStyle[ColorStyle["None"] = 0] = "None";
-    ColorStyle[ColorStyle["Yellow"] = 1] = "Yellow";
-    ColorStyle[ColorStyle["Blue"] = 2] = "Blue";
-    ColorStyle[ColorStyle["Green"] = 3] = "Green";
-    ColorStyle[ColorStyle["Red"] = 4] = "Red";
-})(ColorStyle || (ColorStyle = {}));
-let Console = Console_1 = class Console {
-    async printColor(message, colorStyle) {
-        switch (colorStyle) {
-            case ColorStyle.Yellow:
-                return console.log(chalk_1.default.bgYellow.black(message));
-            case ColorStyle.Blue:
-                return console.log(chalk_1.default.bgBlue.black(message));
-            case ColorStyle.Green:
-                return console.log(chalk_1.default.bgGreen.black(message));
-            case ColorStyle.Red:
-                return console.log(chalk_1.default.bgRed.black(message));
-        }
-    }
-    async messageServer(port, environment, consoleMessage) {
-        const appConsoleMessage = {
-            appName: (consoleMessage === null || consoleMessage === void 0 ? void 0 : consoleMessage.appName) || "Application",
-            appVersion: (consoleMessage === null || consoleMessage === void 0 ? void 0 : consoleMessage.appVersion) || "not provided",
-        };
-        let terminalColor = ColorStyle.None;
-        switch (environment.toLowerCase()) {
-            case "development":
-                terminalColor = ColorStyle.Yellow;
-                break;
-            case "staging":
-                terminalColor = ColorStyle.Blue;
-                break;
-            case "production":
-                terminalColor = ColorStyle.Green;
-                break;
-            default:
-                terminalColor = ColorStyle.Red;
-                break;
-        }
-        this.printColor(`${appConsoleMessage.appName} version ${appConsoleMessage.appVersion} is running on ` +
-            `port ${port} - Environment: ${environment}`, terminalColor);
-    }
-};
-Console = Console_1 = tslib_1.__decorate([
-    (0, inversify_binding_decorators_1.provide)(Console_1)
-], Console);
-exports.Console = Console;

package/container-module/container-module.d.ts

@@ -1,8 +0,0 @@
-import { ContainerModule } from "inversify";
-declare class BaseModule {
-    constructor();
-    private static createSymbols;
-    static createContainerModule(controllers: any[]): ContainerModule;
-}
-declare const CreateModule: typeof BaseModule.createContainerModule;
-export { CreateModule };

package/container-module/container-module.js

@@ -1,34 +0,0 @@
-"use strict";
-var BaseModule_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CreateModule = void 0;
-const tslib_1 = require("tslib");
-const inversify_1 = require("inversify");
-const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-let BaseModule = BaseModule_1 = class BaseModule {
-    constructor() { }
-    static createSymbols(controllers) {
-        const symbols = new Map();
-        for (const controller of controllers) {
-            const target = controller;
-            const symbol = Symbol.for(target.name);
-            symbols.set(symbol, target);
-        }
-        return symbols;
-    }
-    static createContainerModule(controllers) {
-        const symbols = BaseModule_1.createSymbols(controllers);
-        return new inversify_1.ContainerModule(bind => {
-            for (const symbol of symbols) {
-                const target = symbol.valueOf();
-                bind(target[0]).to(target[1]);
-            }
-        });
-    }
-};
-BaseModule = BaseModule_1 = tslib_1.__decorate([
-    (0, inversify_binding_decorators_1.provide)(BaseModule_1),
-    tslib_1.__metadata("design:paramtypes", [])
-], BaseModule);
-const CreateModule = BaseModule.createContainerModule;
-exports.CreateModule = CreateModule;

package/controller/base-controller.d.ts

@@ -1,8 +0,0 @@
-import { interfaces } from 'inversify-express-utils';
-declare abstract class BaseController implements interfaces.Controller {
-    private serviceName;
-    constructor(serviceName: string);
-    protected callUseCaseAsync(useCase: Promise<any>, res: any, successStatusCode: number): Promise<any>;
-    protected callUseCase(useCase: any, res: any, successStatusCode: number): any;
-}
-export { BaseController };

package/controller/base-controller.js

@@ -1,37 +0,0 @@
-"use strict";
-var BaseController_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseController = void 0;
-const tslib_1 = require("tslib");
-const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-const error_1 = require("../error");
-let BaseController = BaseController_1 = class BaseController {
-    constructor(serviceName) {
-        this.serviceName = serviceName;
-    }
-    async callUseCaseAsync(useCase, res, successStatusCode) {
-        let dataReturn;
-        try {
-            dataReturn = await useCase;
-            return res.status(successStatusCode).json(dataReturn);
-        }
-        catch (error) {
-            error_1.Report.Error(error);
-        }
-    }
-    callUseCase(useCase, res, successStatusCode) {
-        let dataReturn;
-        try {
-            dataReturn = useCase;
-            return res.status(successStatusCode).json(dataReturn);
-        }
-        catch (error) {
-            error_1.Report.Error(error);
-        }
-    }
-};
-BaseController = BaseController_1 = tslib_1.__decorate([
-    (0, inversify_binding_decorators_1.provide)(BaseController_1),
-    tslib_1.__metadata("design:paramtypes", [String])
-], BaseController);
-exports.BaseController = BaseController;

package/environment/env-validator.d.ts

@@ -1,12 +0,0 @@
-declare class EnvValidatorProvider {
-    static get(key: string, defaultValue?: any): any;
-    static checkAll(): void;
-}
-declare global {
-    interface String {
-        AsBoolean(): boolean | undefined;
-        AsNumber(): number | undefined;
-        AsString(): string | undefined;
-    }
-}
-export { EnvValidatorProvider as Environments };

package/error/application-error.d.ts

@@ -1,6 +0,0 @@
-declare class AppError extends Error {
-    statusCode: number;
-    service: string;
-    constructor(statusCode: number, message: string, service?: string);
-}
-export { AppError };

package/error/application-error.js

@@ -1,18 +0,0 @@
-"use strict";
-var AppError_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppError = void 0;
-const tslib_1 = require("tslib");
-const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-let AppError = AppError_1 = class AppError extends Error {
-    constructor(statusCode, message, service) {
-        super(message);
-        this.statusCode = statusCode;
-        this.service = service;
-    }
-};
-AppError = AppError_1 = tslib_1.__decorate([
-    (0, inversify_binding_decorators_1.provide)(AppError_1),
-    tslib_1.__metadata("design:paramtypes", [Number, String, String])
-], AppError);
-exports.AppError = AppError;

package/error/error-handler-middleware.d.ts

@@ -1,4 +0,0 @@
-import { NextFunction, Request, Response } from "express";
-import { AppError } from "./application-error";
-declare function errorHandler(error: AppError, req: Request, res: Response, next: NextFunction): void;
-export default errorHandler;

package/error/report.d.ts

@@ -1,5 +0,0 @@
-import { AppError } from "./application-error";
-declare class Report {
-    static Error(error: AppError): void;
-}
-export { Report };

package/error/report.js

@@ -1,15 +0,0 @@
-"use strict";
-var Report_1;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Report = void 0;
-const tslib_1 = require("tslib");
-const inversify_binding_decorators_1 = require("inversify-binding-decorators");
-let Report = Report_1 = class Report {
-    static Error(error) {
-        throw error;
-    }
-};
-Report = Report_1 = tslib_1.__decorate([
-    (0, inversify_binding_decorators_1.provide)(Report_1)
-], Report);
-exports.Report = Report;

package/index.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./application"), exports);
-tslib_1.__exportStar(require("./console"), exports);
-tslib_1.__exportStar(require("./container-module"), exports);
-tslib_1.__exportStar(require("./controller"), exports);
-tslib_1.__exportStar(require("./environment"), exports);
-tslib_1.__exportStar(require("./error"), exports);
-tslib_1.__exportStar(require("./logger"), exports);