@expressots/core 2.9.1 → 2.11.0

package/lib/cjs/types/common/{project-config.provider.d.ts → project-config.d.ts}

@@ -1,56 +1,56 @@
-/**
- * Enum representing different string patterns.
- *
- * - LOWER_CASE: Represents strings in all lowercase letters. E.g. "hello"
- * - KEBAB_CASE: Represents strings separated by hyphens. E.g. "hello-world"
- * - PASCAL_CASE: Represents strings where the first letter of each word is capitalized. E.g. "HelloWorld"
- * - CAMEL_CASE: Represents strings where the first letter of the first word is lowercase and the first letter of subsequent words are capitalized. E.g. "helloWorld"
- */
-declare const enum Pattern {
-    LOWER_CASE = "lowercase",
-    KEBAB_CASE = "kebab-case",
-    PASCAL_CASE = "PascalCase",
-    CAMEL_CASE = "camelCase"
-}
-/**
- * Interface describing configuration specific to Prisma provider.
- *
- * @property {string} schemaName - The name of the Prisma schema.
- * @property {string} schemaPath - The path to the Prisma schema file.
- * @property {string} entitiesPath - The path to the directory containing entities.
- * @property {string} entityNamePattern - The naming convention to use for entity names.
- */
-interface IProviders {
-    prisma?: {
-        schemaName: string;
-        schemaPath: string;
-        entitiesPath: string;
-        entityNamePattern: string;
-    };
-}
-/**
- * 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.
- * @property {IProviders} providers - Specific configuration for each provider added.
- *
- * @see [Doc](https://doc.expresso-ts.com/)
- */
-interface ExpressoConfig {
-    scaffoldPattern: Pattern;
-    sourceRoot: string;
-    opinionated: boolean;
-    providers?: IProviders;
-    scaffoldSchematics?: {
-        entity?: string;
-        controller?: string;
-        usecase?: string;
-        dto?: string;
-        module?: string;
-        provider?: string;
-        middleware?: string;
-    };
-}
-export { ExpressoConfig, Pattern };
+/**
+ * Enum representing different string patterns.
+ *
+ * - LOWER_CASE: Represents strings in all lowercase letters. E.g. "hello"
+ * - KEBAB_CASE: Represents strings separated by hyphens. E.g. "hello-world"
+ * - PASCAL_CASE: Represents strings where the first letter of each word is capitalized. E.g. "HelloWorld"
+ * - CAMEL_CASE: Represents strings where the first letter of the first word is lowercase and the first letter of subsequent words are capitalized. E.g. "helloWorld"
+ */
+declare const enum Pattern {
+    LOWER_CASE = "lowercase",
+    KEBAB_CASE = "kebab-case",
+    PASCAL_CASE = "PascalCase",
+    CAMEL_CASE = "camelCase"
+}
+/**
+ * Interface describing configuration specific to Prisma provider.
+ *
+ * @property {string} schemaName - The name of the Prisma schema.
+ * @property {string} schemaPath - The path to the Prisma schema file.
+ * @property {string} entitiesPath - The path to the directory containing entities.
+ * @property {string} entityNamePattern - The naming convention to use for entity names.
+ */
+interface IProviders {
+    prisma?: {
+        schemaName: string;
+        schemaPath: string;
+        entitiesPath: string;
+        entityNamePattern: string;
+    };
+}
+/**
+ * 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.
+ * @property {IProviders} providers - Specific configuration for each provider added.
+ *
+ * @see [Doc](https://doc.expresso-ts.com/)
+ */
+interface ExpressoConfig {
+    scaffoldPattern: Pattern;
+    sourceRoot: string;
+    opinionated: boolean;
+    providers?: IProviders;
+    scaffoldSchematics?: {
+        entity?: string;
+        controller?: string;
+        usecase?: string;
+        dto?: string;
+        module?: string;
+        provider?: string;
+        middleware?: string;
+    };
+}
+export { ExpressoConfig, Pattern };

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

@@ -1,27 +1,27 @@
-/**
- * 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: number, 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: number, environment: string, consoleMessage?: IApplicationMessageToConsole): Promise<void>;
+}
+export { Console, IApplicationMessageToConsole };

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

@@ -1 +1 @@
-export { Console, IApplicationMessageToConsole } from "./console";
+export { Console, IApplicationMessageToConsole } from "./console";

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

@@ -1,28 +1,28 @@
-import { ContainerModule, interfaces } from "inversify";
-/**
- * The scope decorator is a higher order function that can be used to decorate a class with a binding type.
- * @param binding An instance of interfaces.BindingScope which represents the binding type.
- * @returns A decorator function that can be used to decorate a class with a binding type.
- */
-declare const scope: (binding: interfaces.BindingScope) => (target: any) => void;
-/**
- * The BaseModule class provides methods for creating InversifyJS container modules.
- * @provide BaseModule
- */
-declare class BaseModule {
-    /**
-     * 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.
-     * @param scope - An optional binding scope to be used for all controllers.
-     * @returns A ContainerModule with the controller bindings.
-     */
-    static createContainerModule(controllers: Array<any>, scope?: interfaces.BindingScope): ContainerModule;
-}
-declare const CreateModule: typeof BaseModule.createContainerModule;
-export { CreateModule, scope };
+import { ContainerModule, interfaces } from "inversify";
+/**
+ * The scope decorator is a higher order function that can be used to decorate a class with a binding type.
+ * @param binding An instance of interfaces.BindingScope which represents the binding type.
+ * @returns A decorator function that can be used to decorate a class with a binding type.
+ */
+declare const scope: (binding: interfaces.BindingScope) => (target: any) => void;
+/**
+ * The BaseModule class provides methods for creating InversifyJS container modules.
+ * @provide BaseModule
+ */
+declare class BaseModule {
+    /**
+     * 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.
+     * @param scope - An optional binding scope to be used for all controllers.
+     * @returns A ContainerModule with the controller bindings.
+     */
+    static createContainerModule(controllers: Array<any>, scope?: interfaces.BindingScope): ContainerModule;
+}
+declare const CreateModule: typeof BaseModule.createContainerModule;
+export { CreateModule, scope };

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

@@ -1 +1 @@
-export { CreateModule, scope } from "./container-module";
+export { CreateModule, scope } from "./container-module";

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

@@ -1,48 +1,48 @@
-import { Response } from "express";
-import { Controller } from "@expressots/adapter-express";
-/**
- * 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 Controller {
-    /**
-     * 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: Response, 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: Response, successStatusCode: number): any;
-    /**
-     * Synchronously renders a template with the given options using the Express `Response` object's render method.
-     *
-     * @protected
-     * @method callUseRender
-     *
-     * @param {Response} res - The Express `Response` object.
-     * @param {string} template - The name of the template to render.
-     * @param {Object} [options={}] - An optional object containing data to be passed to the template.
-     *
-     */
-    protected callUseRender(res: Response, template: string, options?: object): void;
-    /**
-     * Asynchronously renders a template with the given options using the Express `Response` object's render method.
-     *
-     * @protected
-     * @method callUseRenderAsync
-     *
-     * @param {Response} res - The Express `Response` object.
-     * @param {string} template - The name of the template to render.
-     * @param {Object} [options={}] - An optional object containing data to be passed to the template.
-     *
-     */
-    protected callUseRenderAsync(res: Response, template: string, options?: object): Promise<string>;
-}
-export { BaseController };
+import { Response } from "express";
+import { Controller } from "@expressots/adapter-express";
+/**
+ * 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 Controller {
+    /**
+     * 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: Response, 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: Response, successStatusCode: number): any;
+    /**
+     * Synchronously renders a template with the given options using the Express `Response` object's render method.
+     *
+     * @protected
+     * @method callUseRender
+     *
+     * @param {Response} res - The Express `Response` object.
+     * @param {string} template - The name of the template to render.
+     * @param {Object} [options={}] - An optional object containing data to be passed to the template.
+     *
+     */
+    protected callUseRender(res: Response, template: string, options?: object): void;
+    /**
+     * Asynchronously renders a template with the given options using the Express `Response` object's render method.
+     *
+     * @protected
+     * @method callUseRenderAsync
+     *
+     * @param {Response} res - The Express `Response` object.
+     * @param {string} template - The name of the template to render.
+     * @param {Object} [options={}] - An optional object containing data to be passed to the template.
+     *
+     */
+    protected callUseRenderAsync(res: Response, template: string, options?: object): Promise<string>;
+}
+export { BaseController };

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

@@ -1 +1 @@
-export { BaseController } from "./base-controller";
+export { BaseController } from "./base-controller";

package/lib/cjs/types/decorator/index.d.ts

@@ -1 +1 @@
-export * from "./scope-binding";
+export * from "./scope-binding";

package/lib/cjs/types/decorator/scope-binding.d.ts

@@ -1,33 +1,33 @@
-/**
- * Provides a singleton binding for the given identifier.
- *
- * @remarks
- * Singleton binding ensures that the same instance of a dependency is reused within the entire container.
- *
- * @param identifier - The identifier (e.g., symbol, string, class) for the dependency being registered.
- * @returns A fluent interface for further configuring the binding.
- *
- * @example
- * ```typescript
- * @provideSingleton(ServiceIdentifier)
- * class MyService {}
- * ```
- */
-declare const provideSingleton: (identifier: any) => (target: any) => any;
-/**
- * Provides a transient binding for the given identifier.
- *
- * @remarks
- * Transient binding ensures that a new instance of a dependency is created every time it is resolved.
- *
- * @param identifier - The identifier (e.g., symbol, string, class) for the dependency being registered.
- * @returns A fluent interface for further configuring the binding.
- *
- * @example
- * ```typescript
- * @provideTransient(ServiceIdentifier)
- * class MyService {}
- * ```
- */
-declare const provideTransient: (identifier: any) => (target: any) => any;
-export { provideSingleton, provideTransient };
+/**
+ * Provides a singleton binding for the given identifier.
+ *
+ * @remarks
+ * Singleton binding ensures that the same instance of a dependency is reused within the entire container.
+ *
+ * @param identifier - The identifier (e.g., symbol, string, class) for the dependency being registered.
+ * @returns A fluent interface for further configuring the binding.
+ *
+ * @example
+ * ```typescript
+ * @provideSingleton(ServiceIdentifier)
+ * class MyService {}
+ * ```
+ */
+declare const provideSingleton: (identifier: any) => (target: any) => any;
+/**
+ * Provides a transient binding for the given identifier.
+ *
+ * @remarks
+ * Transient binding ensures that a new instance of a dependency is created every time it is resolved.
+ *
+ * @param identifier - The identifier (e.g., symbol, string, class) for the dependency being registered.
+ * @returns A fluent interface for further configuring the binding.
+ *
+ * @example
+ * ```typescript
+ * @provideTransient(ServiceIdentifier)
+ * class MyService {}
+ * ```
+ */
+declare const provideTransient: (identifier: any) => (target: any) => any;
+export { provideSingleton, provideTransient };

package/lib/cjs/types/error/app-error.d.ts

@@ -1,29 +1,29 @@
-/**
- * The AppError class extends the built-in Error class in JavaScript,
- * providing additional properties to manage custom application errors.
- * It captures detailed information about the error, including a status code
- * and an optional service identifier, which can be useful for error handling
- * and logging within the application.
- *
- * @extends {Error}
- */
-declare class AppError extends Error {
-    /**
-     * The HTTP status code associated with the error.
-     * Commonly used to define the HTTP response status code.
-     */
-    statusCode: number;
-    /**
-     * The service identifier associated with the error.
-     * This property can be used to trace the origin of the error in the application.
-     * It is optional and can be left undefined.
-     */
-    service?: string;
-    /**
-     * @param {string} message - The error message to be displayed.
-     * @param {number} [statusCode=500] - The HTTP status code associated with the error (default: 500).
-     * @param {string} [service] - The service identifier associated with the error.
-     */
-    constructor(message: string, statusCode?: number, service?: string);
-}
-export { AppError };
+/**
+ * The AppError class extends the built-in Error class in JavaScript,
+ * providing additional properties to manage custom application errors.
+ * It captures detailed information about the error, including a status code
+ * and an optional service identifier, which can be useful for error handling
+ * and logging within the application.
+ *
+ * @extends {Error}
+ */
+declare class AppError extends Error {
+    /**
+     * The HTTP status code associated with the error.
+     * Commonly used to define the HTTP response status code.
+     */
+    statusCode: number;
+    /**
+     * The service identifier associated with the error.
+     * This property can be used to trace the origin of the error in the application.
+     * It is optional and can be left undefined.
+     */
+    service?: string;
+    /**
+     * @param {string} message - The error message to be displayed.
+     * @param {number} [statusCode=500] - The HTTP status code associated with the error (default: 500).
+     * @param {string} [service] - The service identifier associated with the error.
+     */
+    constructor(message: string, statusCode?: number, service?: string);
+}
+export { AppError };

package/lib/cjs/types/error/error-handler-middleware.d.ts

@@ -1,11 +1,11 @@
-import { NextFunction, Request, Response } from "express";
-/**
- * errorHandler is a custom Express error-handling middleware function.
- * It logs the error, sets the status code, and sends a JSON response containing the status code and error message.
- * @param error - An instance of IAppError containing error details.
- * @param req - The Express request object.
- * @param res - The Express response object.
- * @param next - The Express next function for passing control to the next middleware function.
- */
-declare function defaultErrorHandler(error: Error, req: Request, res: Response, next: NextFunction): void;
-export default defaultErrorHandler;
+import { NextFunction, Request, Response } from "express";
+/**
+ * errorHandler is a custom Express error-handling middleware function.
+ * It logs the error, sets the status code, and sends a JSON response containing the status code and error message.
+ * @param error - An instance of IAppError containing error details.
+ * @param req - The Express request object.
+ * @param res - The Express response object.
+ * @param next - The Express next function for passing control to the next middleware function.
+ */
+declare function defaultErrorHandler(error: Error, req: Request, res: Response, next: NextFunction): void;
+export default defaultErrorHandler;

package/lib/cjs/types/error/index.d.ts

@@ -1,3 +1,3 @@
-export { StatusCode } from "./status-code";
-export { Report } from "./report";
-export { AppError } from "./app-error";
+export { StatusCode } from "./status-code";
+export { Report } from "./report";
+export { AppError } from "./app-error";

package/lib/cjs/types/error/report.d.ts

@@ -1,25 +1,25 @@
-import { AppError } from "./app-error";
-/**
- * Report class is a utility class to manage and log errors within the application.
- * It is responsible for creating a standardized error object, logging it,
- * and then throwing the error for further handling.
- */
-declare class Report {
-    static stack: string;
-    private logger;
-    constructor();
-    /**
-     * The Error method is responsible for generating a standardized error object,
-     * logging the error, and then throwing it for further handling.
-     * The error thrown is of the custom type AppError, which extends the built-in Error class.
-     *
-     * @param error - An instance of Error or a string that describes the error.
-     * @param statusCode - The HTTP status code associated with the error (default is 500).
-     * @param service - The service name associated with the error. If not specified,
-     *                  it defaults to the name of the calling function.
-     *
-     * @throws An object of the custom type AppError, which includes details about the error.
-     */
-    error(error: Error | string, statusCode?: number, service?: string): AppError;
-}
-export { Report };
+import { AppError } from "./app-error";
+/**
+ * Report class is a utility class to manage and log errors within the application.
+ * It is responsible for creating a standardized error object, logging it,
+ * and then throwing the error for further handling.
+ */
+declare class Report {
+    static stack: string;
+    private logger;
+    constructor();
+    /**
+     * The Error method is responsible for generating a standardized error object,
+     * logging the error, and then throwing it for further handling.
+     * The error thrown is of the custom type AppError, which extends the built-in Error class.
+     *
+     * @param error - An instance of Error or a string that describes the error.
+     * @param statusCode - The HTTP status code associated with the error (default is 500).
+     * @param service - The service name associated with the error. If not specified,
+     *                  it defaults to the name of the calling function.
+     *
+     * @throws An object of the custom type AppError, which includes details about the error.
+     */
+    error(error: Error | string, statusCode?: number, service?: string): AppError;
+}
+export { Report };