@expressots/core 1.1.0 → 1.2.1

package/lib/esm/logger/general-logger.js

@@ -1,96 +1,125 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var GeneralLogger_1;
-import { format, transports, createLogger } from "winston";
-import DailyRotateFile from "winston-daily-rotate-file";
-import { provide } from "inversify-binding-decorators";
-var LogLevel;
-(function (LogLevel) {
-    LogLevel[LogLevel["Debug"] = 0] = "Debug";
-    LogLevel[LogLevel["Error"] = 1] = "Error";
-    LogLevel[LogLevel["Info"] = 2] = "Info";
-})(LogLevel || (LogLevel = {}));
-let GeneralLogger = GeneralLogger_1 = class GeneralLogger {
-    logger;
-    constructor() {
-        this.logger = createLogger(this.createLoggerOptions());
-    }
-    createConsoleTransport() {
-        const consoleTransport = new transports.Console({
-            level: "debug",
-            handleExceptions: true,
-            handleRejections: true
-        });
-        return consoleTransport;
-    }
-    createRotationalFileTransport() {
-        const rotationalFileTransport = new DailyRotateFile({
-            level: "error",
-            filename: "logs/general-%DATE%.log",
-            datePattern: "YYYY-MM-DD",
-            zippedArchive: true,
-            maxSize: "20m",
-            maxFiles: "7d",
-            silent: false
-        });
-        return rotationalFileTransport;
-    }
-    createLoggerOptions() {
-        const loggerOptions = {
-            transports: [
-                this.createConsoleTransport(),
-                this.createRotationalFileTransport()
-            ],
-            defaultMeta: { service: "service-unknown" },
-            format: format.combine(format.splat(), format.timestamp({ format: "YYYY-MM-DD HH:mm:ss" }), format.label({ label: "core-api" }), format.printf(({ timestamp, level, message, service, label }) => {
-                return `[${timestamp}] [${label}] [${service}] ${level}: ${message}`;
-            }))
-        };
-        return loggerOptions;
-    }
-    getPathAndLine(error) {
-        let pathLine = "";
-        if (error.stack) {
-            let callerLine = error.stack.split("\n")[1];
-            let index = callerLine.indexOf("at ");
-            pathLine = callerLine.substring(index + +2, callerLine.length);
-        }
-        return pathLine;
-    }
-    log(logLevel, content, service) {
-        let pathLine = "";
-        let logMessageFormat = "";
-        if (typeof content === "object") {
-            pathLine = this.getPathAndLine(content);
-            logMessageFormat = `${content.message} - (${content.name}) [file: %s]`;
-        }
-        else {
-            logMessageFormat = content;
-        }
-        switch (logLevel) {
-            case LogLevel.Debug:
-                console.log(logMessageFormat, pathLine, { service });
-                break;
-            case LogLevel.Error:
-                this.logger.error(logMessageFormat, pathLine, { service });
-                break;
-            case LogLevel.Info:
-                this.logger.info(content, { service });
-                break;
-        }
-    }
-};
-GeneralLogger = GeneralLogger_1 = __decorate([
-    provide(GeneralLogger_1),
-    __metadata("design:paramtypes", [])
-], GeneralLogger);
-const Log = new GeneralLogger();
-const log = Log.log.bind(Log);
-export { LogLevel, GeneralLogger, log };
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var GeneralLogger_1;
+import { format, transports, createLogger } from "winston";
+import DailyRotateFile from "winston-daily-rotate-file";
+import { provide } from "inversify-binding-decorators";
+/**
+ * LogLevel enumeration defines the available log levels.
+ */
+var LogLevel;
+(function (LogLevel) {
+    LogLevel[LogLevel["Debug"] = 0] = "Debug";
+    LogLevel[LogLevel["Error"] = 1] = "Error";
+    LogLevel[LogLevel["Info"] = 2] = "Info";
+})(LogLevel || (LogLevel = {}));
+/**
+ * GeneralLogger class is a utility class to manage logging within the application.
+ */
+let GeneralLogger = GeneralLogger_1 = class GeneralLogger {
+    logger;
+    constructor() {
+        this.logger = createLogger(this.createLoggerOptions());
+    }
+    /**
+     * Creates a console transport for logging.
+     * @returns {transports.ConsoleTransportInstance} A Winston console transport instance.
+     */
+    createConsoleTransport() {
+        const consoleTransport = new transports.Console({
+            level: "debug",
+            handleExceptions: true,
+            handleRejections: true
+        });
+        return consoleTransport;
+    }
+    /**
+     * Creates a rotational file transport for logging.
+     * @returns {DailyRotateFile} A Winston daily rotate file transport instance.
+     */
+    createRotationalFileTransport() {
+        const rotationalFileTransport = new DailyRotateFile({
+            level: "error",
+            filename: "logs/general-%DATE%.log",
+            datePattern: "YYYY-MM-DD",
+            zippedArchive: true,
+            maxSize: "20m",
+            maxFiles: "7d",
+            silent: false
+        });
+        return rotationalFileTransport;
+    }
+    /**
+     * Creates a logger options object for Winston.
+     * @returns {LoggerOptions} A Winston logger options object.
+     */
+    createLoggerOptions() {
+        const loggerOptions = {
+            transports: [
+                this.createConsoleTransport(),
+                this.createRotationalFileTransport()
+            ],
+            defaultMeta: { service: "service-unknown" },
+            format: format.combine(format.splat(), format.timestamp({ format: "YYYY-MM-DD HH:mm:ss" }), format.label({ label: "core-api" }), format.printf(({ timestamp, level, message, service, label }) => {
+                return `[${timestamp}] [${label}] [${service}] ${level}: ${message}`;
+            }))
+        };
+        return loggerOptions;
+    }
+    /**
+     * 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.
+     */
+    getPathAndLine(error) {
+        let pathLine = "";
+        if (error.stack) {
+            let callerLine = error.stack.split("\n")[1];
+            let index = callerLine.indexOf("at ");
+            pathLine = callerLine.substring(index + +2, callerLine.length);
+        }
+        return pathLine;
+    }
+    /**
+     * 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, content, service) {
+        let pathLine = "";
+        let logMessageFormat = "";
+        if (typeof content === "object") {
+            pathLine = this.getPathAndLine(content);
+            logMessageFormat = `${content.message} - (${content.name}) [file: %s]`;
+        }
+        else {
+            logMessageFormat = content;
+        }
+        switch (logLevel) {
+            case LogLevel.Debug:
+                console.log(logMessageFormat, pathLine, { service });
+                break;
+            case LogLevel.Error:
+                this.logger.error(logMessageFormat, pathLine, { service });
+                break;
+            case LogLevel.Info:
+                this.logger.info(content, { service });
+                break;
+        }
+    }
+};
+GeneralLogger = GeneralLogger_1 = __decorate([
+    provide(GeneralLogger_1),
+    __metadata("design:paramtypes", [])
+], GeneralLogger);
+const Log = new GeneralLogger();
+const log = Log.log.bind(Log);
+export { LogLevel, GeneralLogger, log };

package/lib/esm/logger/index.js

@@ -1 +1 @@
-export { GeneralLogger, LogLevel, log } from './general-logger';
+export { GeneralLogger, LogLevel, log } from './general-logger';

package/lib/esm/types/application/app-container.d.ts

@@ -1,8 +1,20 @@
-import { Container, ContainerModule } from "inversify";
-declare class AppContainer {
-    private container;
-    constructor();
-    create(modules: ContainerModule[]): Container;
-}
-export { AppContainer };
+import { Container, ContainerModule } from "inversify";
+/**
+ * The AppContainer class provides a container for managing dependency injection.
+ * @provide AppContainer
+ */
+declare class AppContainer {
+    private container;
+    /**
+     * Constructs a new instance of the AppContainer class.
+     */
+    constructor();
+    /**
+     * Creates and configures a new dependency injection container.
+     * @param modules - An array of ContainerModule instances to load into the container.
+     * @returns The configured dependency injection container.
+     */
+    create(modules: ContainerModule[]): Container;
+}
+export { AppContainer };
 //# sourceMappingURL=app-container.d.ts.map

package/lib/esm/types/application/app-container.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app-container.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/application/app-container.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAGvD,cACM,YAAY;IAEd,OAAO,CAAC,SAAS,CAAY;;IAItB,MAAM,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,SAAS;CAKvD;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"app-container.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/application/app-container.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAGvD;;;GAGG;AACH,cACM,YAAY;IAEd,OAAO,CAAC,SAAS,CAAY;IAE7B;;OAEG;;IAGH;;;;OAIG;IACI,MAAM,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,SAAS;CAKvD;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/lib/esm/types/application/application.d.ts

@@ -1,22 +1,53 @@
-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 };
+import express from "express";
+import { Container } from "inversify";
+import { IApplicationMessageToConsole } from "../console/console";
+/**
+ * Enum representing possible server environments.
+ */
+declare enum ServerEnvironment {
+    Development = "development",
+    Staging = "staging",
+    Production = "production"
+}
+/**
+ * The Application class provides a way to configure and manage an Express application.
+ * @provide Application
+ */
+declare class Application {
+    private app;
+    private port;
+    private environment;
+    /**
+     * Constructs a new instance of the Application class.
+     */
+    constructor();
+    /**
+     * Configure services that should be initialized before the server starts.
+     */
+    protected configureServices(): void;
+    /**
+     * Configure services that should be executed after the server starts.
+     */
+    protected postServerInitialization(): void;
+    /**
+     * Perform actions or cleanup after the server is shutdown.
+     */
+    protected serverShutdown(): void;
+    /**
+     * Create and configure the Express application.
+     * @param container - The InversifyJS container.
+     * @param middlewares - An array of Express middlewares to be applied.
+     * @returns The configured Application instance.
+     */
+    create(container: Container, middlewares?: express.RequestHandler[]): Application;
+    /**
+     * Start listening on the given port and environment.
+     * @param port - The port number to listen on.
+     * @param environment - The server environment.
+     * @param consoleMessage - Optional message to display in the console.
+     */
+    listen(port: number, environment: ServerEnvironment, consoleMessage?: IApplicationMessageToConsole): void;
+}
+declare const appServerInstance: Application;
+export { appServerInstance as AppInstance, Application, ServerEnvironment };
 //# sourceMappingURL=application.d.ts.map

package/lib/esm/types/application/application.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/application/application.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAItC,OAAO,EAAW,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAG3E,aAAK,iBAAiB;IAClB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;CAC5B;AAED,cACM,WAAW;IAEb,OAAO,CAAC,GAAG,CAAsB;IACjC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,WAAW,CAAoB;;IAKvC,SAAS,CAAC,iBAAiB,IAAI,IAAI;IAGnC,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAG1C,SAAS,CAAC,cAAc,IAAI,IAAI;IAIzB,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,GAAE,OAAO,CAAC,cAAc,EAAO,GAAG,WAAW;IA2BrF,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,cAAc,CAAC,EAAE,4BAA4B,GAAG,IAAI;CAanH;AAED,QAAA,MAAM,iBAAiB,EAAE,WAA+B,CAAC;AAEzD,OAAO,EAAE,iBAAiB,IAAI,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/application/application.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAItC,OAAO,EAAW,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAG3E;;GAEG;AACH,aAAK,iBAAiB;IAClB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;IACnB,UAAU,eAAe;CAC5B;AAED;;;GAGG;AACH,cACM,WAAW;IAEb,OAAO,CAAC,GAAG,CAAsB;IACjC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,WAAW,CAAoB;IAEvC;;OAEG;;IAGH;;OAEG;IACH,SAAS,CAAC,iBAAiB,IAAI,IAAI;IAEnC;;OAEG;IACH,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAE1C;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;IAIhC;;;;;OAKG;IACI,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,WAAW,GAAE,OAAO,CAAC,cAAc,EAAO,GAAG,WAAW;IAoC5F;;;;;OAKG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,cAAc,CAAC,EAAE,4BAA4B,GAAG,IAAI;CAanH;AAED,QAAA,MAAM,iBAAiB,EAAE,WAA+B,CAAC;AAEzD,OAAO,EAAE,iBAAiB,IAAI,WAAW,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC"}

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

@@ -1,3 +1,3 @@
-export { AppInstance, Application, ServerEnvironment } from './application';
-export { AppContainer } from './app-container';
+export { AppInstance, Application, ServerEnvironment } from './application';
+export { AppContainer } from './app-container';
 //# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,2 @@
+export { Pattern, ExpressoConfig } from "./project-config.provider";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/common/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC"}

package/lib/esm/types/common/project-config.provider.d.ts

@@ -0,0 +1,22 @@
+declare const enum Pattern {
+    LOWER_CASE = "lowercase",
+    KEBAB_CASE = "kebab-case",
+    PASCAL_CASE = "PascalCase",
+    CAMEL_CASE = "camelCase"
+}
+/**
+ * The configuration object for the Expresso CLI.
+ *
+ * @property {Pattern} scaffoldPattern - The pattern to use when scaffolding files.
+ * @property {string} sourceRoot - The root directory for the source files.
+ * @property {boolean} opinionated - Whether or not to use the opinionated configuration.
+ *
+ * @see [ExpressoConfig](https://expresso-ts.com/docs)
+ */
+interface ExpressoConfig {
+    scaffoldPattern: Pattern;
+    sourceRoot: string;
+    opinionated: boolean;
+}
+export { ExpressoConfig, Pattern };
+//# sourceMappingURL=project-config.provider.d.ts.map

package/lib/esm/types/common/project-config.provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-config.provider.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/common/project-config.provider.ts"],"names":[],"mappings":"AAAA,mBAAW,OAAO;IACjB,UAAU,cAAc;IACxB,UAAU,eAAe;IACzB,WAAW,eAAe;IAC1B,UAAU,cAAc;CACxB;AAED;;;;;;;;GAQG;AACH,UAAU,cAAc;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;CACrB;AAED,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC"}

package/lib/esm/types/console/console.d.ts

@@ -1,10 +1,28 @@
-interface IApplicationMessageToConsole {
-    appName: string;
-    appVersion: string;
-}
-declare class Console {
-    private printColor;
-    messageServer(port: any, environment: string, consoleMessage?: IApplicationMessageToConsole): Promise<void>;
-}
-export { Console, IApplicationMessageToConsole };
+/**
+ * Interface representing application message details for console output.
+ */
+interface IApplicationMessageToConsole {
+    appName: string;
+    appVersion: string;
+}
+/**
+ * The Console class provides methods for displaying styled messages in the console.
+ * @provide Console
+ */
+declare class Console {
+    /**
+     * Print a message to the console with the specified color style.
+     * @param message - The message to be printed.
+     * @param colorStyle - The color style for the message.
+     */
+    private printColor;
+    /**
+     * Display a message in the console with details about the running server.
+     * @param port - The port number the server is running on.
+     * @param environment - The server environment.
+     * @param consoleMessage - Optional application message details for console output.
+     */
+    messageServer(port: any, environment: string, consoleMessage?: IApplicationMessageToConsole): Promise<void>;
+}
+export { Console, IApplicationMessageToConsole };
 //# sourceMappingURL=console.d.ts.map

package/lib/esm/types/console/console.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"console.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/console/console.ts"],"names":[],"mappings":"AAWA,UAAU,4BAA4B;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,cACM,OAAO;YAEK,UAAU;IAcX,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;CA+B3H;AAED,OAAO,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC"}
+{"version":3,"file":"console.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/console/console.ts"],"names":[],"mappings":"AAcA;;GAEG;AACH,UAAU,4BAA4B;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,cACM,OAAO;IAET;;;;OAIG;YACW,UAAU;IAcxB;;;;;OAKG;IACU,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;CA+B3H;AAED,OAAO,EAAE,OAAO,EAAE,4BAA4B,EAAE,CAAC"}

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

@@ -1,2 +1,2 @@
-export { Console, IApplicationMessageToConsole } from "./console";
+export { Console, IApplicationMessageToConsole } from "./console";
 //# sourceMappingURL=index.d.ts.map

package/lib/esm/types/container-module/container-module.d.ts

@@ -1,9 +1,23 @@
-import { ContainerModule } from "inversify";
-declare class BaseModule {
-    constructor();
-    private static createSymbols;
-    static createContainerModule(controllers: any[]): ContainerModule;
-}
-declare const CreateModule: typeof BaseModule.createContainerModule;
-export { CreateModule };
+import { ContainerModule } from "inversify";
+/**
+ * The BaseModule class provides methods for creating InversifyJS container modules.
+ * @provide BaseModule
+ */
+declare class BaseModule {
+    constructor();
+    /**
+     * Create a map of symbols for the provided controllers.
+     * @param controllers - An array of controller classes.
+     * @returns A map of symbols mapped to controller constructor functions.
+     */
+    private static createSymbols;
+    /**
+    * Create an InversifyJS ContainerModule for the provided controllers.
+    * @param controllers - An array of controller classes.
+    * @returns A ContainerModule with the controller bindings.
+    */
+    static createContainerModule(controllers: any[]): ContainerModule;
+}
+declare const CreateModule: typeof BaseModule.createContainerModule;
+export { CreateModule };
 //# sourceMappingURL=container-module.d.ts.map

package/lib/esm/types/container-module/container-module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"container-module.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/container-module/container-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAK5C,cACM,UAAU;;IAIZ,OAAO,CAAC,MAAM,CAAC,aAAa;WAad,qBAAqB,CAAC,WAAW,EAAE,GAAG,EAAE,GAAG,eAAe;CAY3E;AAED,QAAA,MAAM,YAAY,yCAAmC,CAAC;AAEtD,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"container-module.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/container-module/container-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAQ5C;;;GAGG;AACH,cACM,UAAU;;IAIZ;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,aAAa;IAa3B;;;;MAIE;WACW,qBAAqB,CAAC,WAAW,EAAE,GAAG,EAAE,GAAG,eAAe;CAY3E;AAED,QAAA,MAAM,YAAY,yCAAmC,CAAC;AAEtD,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/lib/esm/types/container-module/index.d.ts

@@ -1,2 +1,2 @@
-export { CreateModule } from "./container-module";
+export { CreateModule } from "./container-module";
 //# sourceMappingURL=index.d.ts.map

package/lib/esm/types/controller/base-controller.d.ts

@@ -1,9 +1,30 @@
-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 };
+import { interfaces } from 'inversify-express-utils';
+/**
+ * The BaseController class is an abstract base class for controllers.
+ * It provides methods for handling use case calls and sending appropriate responses.
+ * @provide BaseController
+ */
+declare abstract class BaseController implements interfaces.Controller {
+    private serviceName;
+    /**
+     * Constructs a new BaseController instance with a specified service name.
+     * @param serviceName - The name of the service associated with the controller.
+     */
+    constructor(serviceName: string);
+    /**
+     * Calls an asynchronous use case and sends an appropriate response based on the result.
+     * @param useCase - A promise representing the asynchronous use case to call.
+     * @param res - The Express response object.
+     * @param successStatusCode - The HTTP status code to return upon successful execution.
+     */
+    protected callUseCaseAsync(useCase: Promise<any>, res: any, successStatusCode: number): Promise<any>;
+    /**
+     * Calls a use case and sends an appropriate response based on the result.
+     * @param useCase - The use case to call.
+     * @param res - The Express response object.
+     * @param successStatusCode - The HTTP status code to return upon successful execution.
+     */
+    protected callUseCase(useCase: any, res: any, successStatusCode: number): any;
+}
+export { BaseController };
 //# sourceMappingURL=base-controller.d.ts.map

package/lib/esm/types/controller/base-controller.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base-controller.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/controller/base-controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD,uBACe,cAAe,YAAW,UAAU,CAAC,UAAU;IAE1D,OAAO,CAAC,WAAW,CAAS;gBAEhB,WAAW,EAAE,MAAM;cAIf,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM;IAa3F,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM;CAc1E;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"base-controller.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/controller/base-controller.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAGrD;;;;GAIG;AACH,uBACe,cAAe,YAAW,UAAU,CAAC,UAAU;IAE1D,OAAO,CAAC,WAAW,CAAS;IAE5B;;;OAGG;gBACS,WAAW,EAAE,MAAM;IAI/B;;;;;OAKG;cACa,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM;IAa3F;;;;;OAKG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM;CAc1E;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}

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

@@ -1,2 +1,2 @@
-export { BaseController } from './base-controller';
+export { BaseController } from './base-controller';
 //# sourceMappingURL=index.d.ts.map

package/lib/esm/types/environment/env-validator.d.ts

@@ -1,13 +1,28 @@
-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 };
+/**
+ * The EnvValidatorProvider class provides utility methods for working with environment variables.
+ * It validates, loads, and retrieves environment variables from the .env file.
+ * @provide EnvValidatorProvider
+ */
+declare class EnvValidatorProvider {
+    /**
+     * Retrieves the value of an environment variable, or a default value if the variable is not set.
+     * @param key - The key of the environment variable.
+     * @param defaultValue - The default value to return if the environment variable is not set.
+     * @returns The value of the environment variable, or the default value if not set.
+     */
+    static get(key: string, defaultValue?: any): any;
+    /**
+     * Validates and loads all environment variables from the .env file.
+     * If the .env file does not exist or any environment variables are not set, the process will exit with an error.
+     */
+    static checkAll(): void;
+}
+declare global {
+    interface String {
+        AsBoolean(): boolean | undefined;
+        AsNumber(): number | undefined;
+        AsString(): string | undefined;
+    }
+}
+export { EnvValidatorProvider as Environments };
 //# sourceMappingURL=env-validator.d.ts.map

package/lib/esm/types/environment/env-validator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"env-validator.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/environment/env-validator.ts"],"names":[],"mappings":"AAOA,cACM,oBAAoB;WAER,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,GAAE,GAAe,GAAG,GAAG;WAIpD,QAAQ,IAAI,IAAI;CA+BjC;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM;QACZ,SAAS,IAAI,OAAO,GAAG,SAAS,CAAC;QACjC,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;QAC/B,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;KAClC;CACJ;AAyBD,OAAO,EAAE,oBAAoB,IAAI,YAAY,EAAE,CAAA"}
+{"version":3,"file":"env-validator.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/environment/env-validator.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AACH,cACM,oBAAoB;IAEtB;;;;;OAKG;WACW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,GAAE,GAAe,GAAG,GAAG;IAIlE;;;OAGG;WACW,QAAQ,IAAI,IAAI;CA+BjC;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM;QACZ,SAAS,IAAI,OAAO,GAAG,SAAS,CAAC;QACjC,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;QAC/B,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;KAClC;CACJ;AAyBD,OAAO,EAAE,oBAAoB,IAAI,YAAY,EAAE,CAAA"}

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

@@ -1,2 +1,2 @@
-export { Environments } from './env-validator';
+export { Environments } from './env-validator';
 //# sourceMappingURL=index.d.ts.map

package/lib/esm/types/error/application-error.d.ts

@@ -1,7 +1,18 @@
-declare class AppError extends Error {
-    statusCode: number;
-    service: string;
-    constructor(statusCode: number, message: string, service?: string);
-}
-export { AppError };
+/**
+ * The AppError class extends the built-in Error class, adding a status code and service property.
+ * It is designed for handling application-specific errors with more detailed information.
+ * @provide AppError
+ */
+declare class AppError extends Error {
+    statusCode: number;
+    service: string;
+    /**
+     * Constructs a new AppError instance.
+     * @param statusCode - The status code associated with the error.
+     * @param message - The error message.
+     * @param service - An optional service name related to the error.
+     */
+    constructor(statusCode: number, message: string, service?: string);
+}
+export { AppError };
 //# sourceMappingURL=application-error.d.ts.map

package/lib/esm/types/error/application-error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"application-error.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/error/application-error.ts"],"names":[],"mappings":"AAEA,cACM,QAAS,SAAQ,KAAK;IAEjB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;gBAEX,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;CAMpE;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}
+{"version":3,"file":"application-error.d.ts","sourceRoot":"","sources":["../../../../packages/core/src/error/application-error.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,cACM,QAAS,SAAQ,KAAK;IAEjB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAEvB;;;;;OAKG;gBACS,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;CAMpE;AAED,OAAO,EAAE,QAAQ,EAAE,CAAC"}