@cyberskill/shared 1.217.0 → 2.0.0

package/dist/config/config.util.d.ts

@@ -1,3 +1,20 @@
 import { T_Object } from '../typescript/index.js';
 import { T_ConfigType } from './config.type.js';
+/**
+ * Merges configurations based on the specified type.
+ * This function provides a unified interface for merging different types of
+ * configurations using their respective handlers. It supports ESLint, commitlint,
+ * lint-staged, and Vitest configurations with appropriate processing for each type.
+ *
+ * The function automatically:
+ * - Selects the appropriate handler for the config type
+ * - Merges multiple configuration objects
+ * - Handles empty configuration arrays gracefully
+ * - Provides error handling for unknown config types
+ *
+ * @param type - The type of configuration to merge (ESLint, commitlint, lint-staged, or Vitest).
+ * @param config - Configuration objects to merge, can be empty for default handling.
+ * @returns A merged configuration object processed according to the specified type.
+ * @throws {Error} When an unknown configuration type is provided.
+ */
 export declare function mergeConfigs(type: T_ConfigType, ...config: T_Object[]): T_Object;

package/dist/config/env/env.util.d.ts

@@ -1,3 +1,29 @@
 import { I_Environment } from './env.type.js';
+/**
+ * Loads environment variables from .env files.
+ * This function loads environment variables from .env files using dotenvx,
+ * but only in non-production environments. It includes a safety mechanism
+ * to prevent multiple loading of the same environment file.
+ *
+ * The function:
+ * - Checks if the current environment is not production
+ * - Loads environment variables from .env files
+ * - Prevents duplicate loading with a flag mechanism
+ * - Uses dotenvx for enhanced environment file support
+ */
 export declare function loadEnvFile(): void;
+/**
+ * Retrieves and validates the application environment configuration.
+ * This function loads environment variables, validates them using envalid,
+ * and returns a typed environment object with default values for missing
+ * variables. It ensures all required environment variables are present
+ * and properly typed.
+ *
+ * The function validates:
+ * - CWD: Current working directory (defaults to process.cwd())
+ * - DEBUG: Debug mode flag (defaults to false)
+ * - CYBERSKILL_STORAGE_DIRECTORY: Storage directory path (defaults to user home directory)
+ *
+ * @returns A validated environment object with all required configuration values.
+ */
 export declare function getEnv(): I_Environment;

package/dist/config/eslint/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Base ESLint configuration.
+ * This config provides the foundation for ESLint rules.
+ */
 declare const _default: {
     languageOptions: {
         globals: {

package/dist/config/graphql-codegen/graphql-codegen.util.d.ts

@@ -1,3 +1,26 @@
 import { CodegenConfig } from '@graphql-codegen/cli';
 import { I_GraphqlCodegenConfig } from './graphql-codegen.type.js';
+/**
+ * Creates a GraphQL Code Generator configuration for client or server code generation.
+ * This function generates a complete GraphQL Code Generator configuration based on
+ * the specified target (client or server) with appropriate presets and settings.
+ *
+ * For client targets, it configures:
+ * - Client preset with fragment masking disabled
+ * - Persisted documents support
+ * - Type imports and naming convention settings
+ * - Document processing from specified source
+ *
+ * For server targets, it configures:
+ * - TypeScript resolver files generation
+ * - Server-side GraphQL type definitions
+ * - Resolver function generation
+ *
+ * @param options - Configuration object containing uri, from, to, and target properties.
+ * @param options.uri - The GraphQL schema URI to generate types from.
+ * @param options.from - The source path for GraphQL documents (used for client generation).
+ * @param options.to - The output path for generated files.
+ * @param options.target - The generation target ('client' for frontend, 'server' for backend).
+ * @returns A complete GraphQL Code Generator configuration object.
+ */
 export declare function createGraphqlCodegenConfig({ uri, from, to, target, }: I_GraphqlCodegenConfig): CodegenConfig;

package/dist/config/vitest/vitest.e2e.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("@vitejs/plugin-react-swc"),i=require("lodash-es"),o=require("../../node_modules/.pnpm/vitest@3.2.4_@types_debug@4.1.12_@types_node@24.0.14_@vitest_browser@3.2.4_jiti@2.4.2_j_5b4f3b6d03b5e1745ce439b75ce4a42f/node_modules/vitest/dist/config.cjs");function s(e){const r={plugins:[t()],test:{include:["**/*.test.e2e.?(c|m)[jt]s?(x)"],browser:{enabled:!0,provider:"playwright",instances:[{browser:"chromium"},{browser:"firefox"},{browser:"webkit"}]}}};return o.defineConfig(i.merge(r,e))}exports.vitestE2E=s;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("@vitejs/plugin-react-swc"),i=require("lodash-es"),o=require("../../node_modules/.pnpm/vitest@3.2.4_@types_debug@4.1.12_@types_node@24.0.15_@vitest_browser@3.2.4_jiti@2.4.2_j_e4a333d8aa4b05d17db10875e249d94f/node_modules/vitest/dist/config.cjs");function s(e){const r={plugins:[t()],test:{include:["**/*.test.e2e.?(c|m)[jt]s?(x)"],browser:{enabled:!0,provider:"playwright",instances:[{browser:"chromium"},{browser:"firefox"},{browser:"webkit"}]}}};return o.defineConfig(i.merge(r,e))}exports.vitestE2E=s;

package/dist/config/vitest/vitest.e2e.d.ts

@@ -1,2 +1,18 @@
 import { UserConfig } from 'vite';
+/**
+ * Creates a Vitest configuration for end-to-end testing with browser automation.
+ * This function generates a Vitest configuration specifically designed for E2E testing
+ * using Playwright with multiple browser instances. It includes React support and
+ * browser automation capabilities for comprehensive end-to-end testing.
+ *
+ * The configuration includes:
+ * - React SWC plugin for fast React compilation
+ * - Browser automation with Playwright provider
+ * - Multiple browser instances (Chromium, Firefox, WebKit)
+ * - E2E test file pattern matching
+ * - Configurable options merging
+ *
+ * @param options - Additional Vite configuration options to merge with the E2E config.
+ * @returns A Vitest configuration object optimized for end-to-end testing with browser automation.
+ */
 export declare function vitestE2E(options: UserConfig): UserConfig;

package/dist/config/vitest/vitest.e2e.js

@@ -1,6 +1,6 @@
 import t from "@vitejs/plugin-react-swc";
 import { merge as o } from "lodash-es";
-import { defineConfig as i } from "../../node_modules/.pnpm/vitest@3.2.4_@types_debug@4.1.12_@types_node@24.0.14_@vitest_browser@3.2.4_jiti@2.4.2_j_5b4f3b6d03b5e1745ce439b75ce4a42f/node_modules/vitest/dist/config.js";
+import { defineConfig as i } from "../../node_modules/.pnpm/vitest@3.2.4_@types_debug@4.1.12_@types_node@24.0.15_@vitest_browser@3.2.4_jiti@2.4.2_j_e4a333d8aa4b05d17db10875e249d94f/node_modules/vitest/dist/config.js";
 function f(r) {
   const e = {
     plugins: [t()],

package/dist/config/vitest/vitest.unit.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("@vitejs/plugin-react-swc"),n=require("lodash-es"),s=require("../../node_modules/.pnpm/vitest@3.2.4_@types_debug@4.1.12_@types_node@24.0.14_@vitest_browser@3.2.4_jiti@2.4.2_j_5b4f3b6d03b5e1745ce439b75ce4a42f/node_modules/vitest/dist/config.cjs");function r(e){const t={plugins:[i()],test:{globals:!0,environment:"jsdom",pool:"vmThreads",include:["**/*.test.unit.?(c|m)[jt]s?(x)"],setupFiles:["./vitest.unit.setup.ts"]}};return s.defineConfig(n.merge(t,e))}exports.vitestUnit=r;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("@vitejs/plugin-react-swc"),n=require("lodash-es"),s=require("../../node_modules/.pnpm/vitest@3.2.4_@types_debug@4.1.12_@types_node@24.0.15_@vitest_browser@3.2.4_jiti@2.4.2_j_e4a333d8aa4b05d17db10875e249d94f/node_modules/vitest/dist/config.cjs");function r(e){const t={plugins:[i()],test:{globals:!0,environment:"jsdom",pool:"vmThreads",include:["**/*.test.unit.?(c|m)[jt]s?(x)"],setupFiles:["./vitest.unit.setup.ts"]}};return s.defineConfig(n.merge(t,e))}exports.vitestUnit=r;

package/dist/config/vitest/vitest.unit.d.ts

@@ -1,2 +1,20 @@
 import { UserConfig } from 'vite';
+/**
+ * Creates a Vitest configuration for unit testing with React support.
+ * This function generates a Vitest configuration specifically designed for unit testing
+ * React components and JavaScript/TypeScript modules. It includes JSDOM environment
+ * for DOM simulation and comprehensive testing setup.
+ *
+ * The configuration includes:
+ * - React SWC plugin for fast React compilation
+ * - JSDOM environment for DOM simulation
+ * - Global test functions availability
+ * - VM threads pool for parallel test execution
+ * - Unit test file pattern matching
+ * - Setup files for testing library configuration
+ * - Configurable options merging
+ *
+ * @param options - Additional Vite configuration options to merge with the unit test config.
+ * @returns A Vitest configuration object optimized for unit testing with React and DOM support.
+ */
 export declare function vitestUnit(options: UserConfig): UserConfig;

package/dist/config/vitest/vitest.unit.js

@@ -1,6 +1,6 @@
 import i from "@vitejs/plugin-react-swc";
 import { merge as o } from "lodash-es";
-import { defineConfig as n } from "../../node_modules/.pnpm/vitest@3.2.4_@types_debug@4.1.12_@types_node@24.0.14_@vitest_browser@3.2.4_jiti@2.4.2_j_5b4f3b6d03b5e1745ce439b75ce4a42f/node_modules/vitest/dist/config.js";
+import { defineConfig as n } from "../../node_modules/.pnpm/vitest@3.2.4_@types_debug@4.1.12_@types_node@24.0.15_@vitest_browser@3.2.4_jiti@2.4.2_j_e4a333d8aa4b05d17db10875e249d94f/node_modules/vitest/dist/config.js";
 function u(t) {
   const e = {
     plugins: [i()],

package/dist/constant/common.d.ts

@@ -1 +1,5 @@
+/**
+ * Indicates if the current environment is a browser (as opposed to Node.js).
+ * This constant is true if the global `window` object is defined, false otherwise.
+ */
 export declare const IS_BROWSER: boolean;

package/dist/constant/index.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Re-exports all common constants for shared usage across the codebase.
+ */
 export * from './common.js';
 export * from './response-status.js';

package/dist/node/apollo-server/apollo-server.util.d.ts

@@ -1,5 +1,19 @@
 import { ApolloServer } from '@apollo/server';
 import { expressMiddleware } from '@as-integrations/express5';
 import { I_ApolloServerOptions } from './apollo-server.type.js';
+/**
+ * Creates and configures an Apollo Server instance with appropriate plugins and settings.
+ * This function sets up an Apollo Server with development or production landing pages,
+ * HTTP server draining capabilities, and optional custom drain server hooks.
+ *
+ * The server is configured with:
+ * - Development or production landing page based on the isDev flag
+ * - HTTP server draining plugin for graceful shutdowns
+ * - Optional custom drain server hook for additional cleanup
+ * - Development-specific settings (introspection and stack traces) when isDev is true
+ *
+ * @param options - Configuration options for the Apollo Server including server instance, schema, and environment settings.
+ * @returns A configured Apollo Server instance ready to be started.
+ */
 export declare function createApolloServer(options: I_ApolloServerOptions): ApolloServer;
 export { expressMiddleware };

package/dist/node/command/command.type.d.ts

@@ -1,24 +1,44 @@
+/**
+ * Interface representing an ESLint error structure.
+ */
 export interface I_EslintError {
     filePath: string;
     messages: Array<{
-        line: number;
-        column: number;
+        ruleId: string;
         severity: number;
         message: string;
-        ruleId: string;
+        line: number;
+        column: number;
     }>;
 }
+/**
+ * Interface representing the command execution context.
+ */
 export interface I_CommandContext {
     isCurrentProject: boolean;
 }
+/**
+ * Interface representing a command with raw flag and command string.
+ */
 export interface I_Command {
     raw: boolean;
     cmd: string;
 }
+/**
+ * Type for a function that generates a command string based on context.
+ */
 export type T_CommandFunction = (context?: I_CommandContext) => string;
-export type T_Command = string | I_Command | T_CommandFunction;
-export type T_CommandMap = Record<string, T_Command>;
-export type T_CommandMapInput = T_CommandMap | ((ctx: I_CommandContext) => T_CommandMap);
+/**
+ * Type for a command, which can be a string, function that returns a string, or a raw command object.
+ */
+export type T_Command = string | T_CommandFunction | I_Command;
+/**
+ * Type for a command map input, which can be a record or a function returning a record.
+ */
+export type T_CommandMapInput = Record<string, T_Command> | ((context: I_CommandContext) => Record<string, T_Command>);
+/**
+ * Enum for command types: CLI, STRING, or FUNCTION.
+ */
 export declare enum E_CommandType {
     CLI = "CLI",
     STRING = "STRING",

package/dist/node/command/command.util.d.ts

@@ -1,13 +1,63 @@
 import { I_IssueEntry } from '../log/index.js';
 import { I_CommandContext, T_Command, T_CommandMapInput } from './command.type.js';
+/**
+ * Retrieves all stored error lists from persistent storage.
+ * This function fetches error entries that were previously saved using the package name as the key.
+ *
+ * @returns A promise that resolves to an array of error entries, or an empty array if none are found.
+ */
 export declare function getStoredErrorLists(): Promise<I_IssueEntry[]>;
+/**
+ * Clears all stored error lists from persistent storage.
+ * This function removes all error entries associated with the current package name.
+ *
+ * @returns A promise that resolves when the clearing operation is complete.
+ */
 export declare function clearAllErrorLists(): Promise<void>;
+/**
+ * Creates a raw command object that bypasses CLI formatting.
+ * This function wraps a command string in an object that indicates it should be executed
+ * as-is without any additional CLI formatting or path resolution.
+ *
+ * @param cmd - The raw command string to be executed directly.
+ * @returns An object containing the raw command with a flag indicating it should not be formatted.
+ */
 export declare function rawCommand(cmd: string): {
     raw: boolean;
     cmd: string;
 };
+/**
+ * Formats a command based on its type and context.
+ * This function handles different command types:
+ * - Function commands: Executes the function with context and formats the result
+ * - Raw commands: Returns the command as-is without formatting
+ * - String commands: Formats them as CLI commands
+ *
+ * @param command - The command to format, which can be a string, function, or raw command object.
+ * @param context - Optional context information for command execution.
+ * @returns The formatted command string ready for execution.
+ */
 export declare function formatCommand(command: T_Command, context?: I_CommandContext): string | import('./command.type.js').I_Command;
+/**
+ * Resolves a map of commands by formatting them based on the current project context.
+ * This function takes a command map (either static or dynamic) and formats all commands
+ * using the appropriate CLI paths based on whether the current project is the Cyberskill package.
+ *
+ * @param input - The command map to resolve, which can be static or a function that returns a map.
+ * @returns A promise that resolves to an object with formatted command strings, or undefined if package info cannot be retrieved.
+ */
 export declare function resolveCommands(input: T_CommandMapInput): Promise<{
     [k: string]: string | import('./command.type.js').I_Command;
 } | undefined>;
+/**
+ * Executes a command with proper logging and error handling.
+ * This function provides a standardized way to run commands with:
+ * - Progress logging with start and success messages
+ * - Debug logging of the actual command when DEBUG mode is enabled
+ * - Error handling and reporting
+ *
+ * @param label - A human-readable label describing what the command does.
+ * @param command - The command string to execute, or undefined if no command should be run.
+ * @returns A promise that resolves when the command execution is complete.
+ */
 export declare function runCommand(label: string, command: string | void): Promise<void>;

package/dist/node/express/express.util.d.ts

@@ -4,16 +4,63 @@ import { SessionOptions } from 'express-session';
 import { default as bodyParser } from 'body-parser';
 import { default as cors } from 'cors';
 import { I_ExpressOptions, I_NestOptions, T_CorsOptions, T_CorsType } from './express.type.js';
+/**
+ * Creates CORS options with environment-specific configuration.
+ * This function generates CORS options based on the development environment,
+ * including whitelist configuration for allowed origins.
+ *
+ * @param options - CORS configuration options.
+ * @param options.isDev - Whether the application is running in development mode.
+ * @param options.whiteList - Array of allowed origins for CORS requests.
+ * @returns CORS options object configured for the specified environment.
+ */
 export declare function createCorsOptions<T extends T_CorsType>({ isDev, whiteList, ...rest }: T_CorsOptions<T>): {
     origin: (origin: string | undefined, callback: (err: Error | null, allow?: boolean) => void) => void;
     credentials: boolean;
 } & Omit<T_CorsOptions<T>, "isDev" | "whiteList">;
+/**
+ * Creates a CORS middleware function with the specified configuration.
+ * This function creates a CORS middleware that can be used with both Express and NestJS applications,
+ * applying the configured CORS options for origin validation and credential handling.
+ *
+ * @param options - CORS configuration options to apply to the middleware.
+ * @returns A CORS middleware function ready to be used in Express or NestJS applications.
+ */
 export declare function createCors<T extends T_CorsType>(options: T_CorsOptions<T>): (req: cors.CorsRequest, res: {
     statusCode?: number | undefined;
     setHeader(key: string, value: string): any;
     end(): any;
 }, next: (err?: any) => any) => void;
+/**
+ * Creates a session middleware function with the specified configuration.
+ * This function creates an Express session middleware that can be used to handle user sessions
+ * with the provided session options including secret, cookie settings, and storage configuration.
+ *
+ * @param options - Session configuration options including secret, cookie settings, and storage.
+ * @returns A session middleware function ready to be used in Express applications.
+ */
 export declare function createSession(options: SessionOptions): RequestHandler;
+/**
+ * Creates and configures an Express application with common middleware and settings.
+ * This function sets up a complete Express application with:
+ * - Essential middleware (cookies, body parsing, compression, user agent)
+ * - Static file serving for specified folders
+ * - GraphQL upload support for file uploads
+ *
+ * @param options - Optional configuration for the Express application including static folder paths.
+ * @returns A configured Express application instance ready for use.
+ */
 export declare function createExpress(options?: I_ExpressOptions): Application;
+/**
+ * Creates and configures a NestJS application with Express integration.
+ * This function sets up a NestJS application with:
+ * - Express HTTP adapter configuration
+ * - Common middleware (cookies, body parsing, compression, user agent)
+ * - Static file serving for specified folders
+ * - Global filters and pipes if provided
+ *
+ * @param options - Configuration options for the NestJS application including module, static folders, filters, and pipes.
+ * @returns A promise that resolves to a configured NestJS application instance.
+ */
 export declare function createNest(options: I_NestOptions): Promise<INestApplication>;
 export { bodyParser, express };

package/dist/node/fs/fs.type.d.ts

@@ -1,4 +1,10 @@
 import { CopyOptionsSync } from 'fs-extra';
+/**
+ * Options for synchronous copy operations, extending fs-extra's CopyOptionsSync.
+ */
 export interface I_CopySyncOptions extends CopyOptionsSync {
+    /**
+     * Optional array of file extensions to filter which files are copied.
+     */
     extensions?: string[];
 }

package/dist/node/fs/fs.util.d.ts

@@ -1,10 +1,57 @@
 import { default as fsExtra } from 'fs-extra';
 import { I_CopySyncOptions } from './fs.type.js';
+/**
+ * Re-export of the fs-extra module for file system operations.
+ */
 export declare const fs: typeof fsExtra;
 export declare const lstatSync: fsExtra.StatSyncFn, readdirSync: typeof fsExtra.readdirSync, mkdirSync: typeof fsExtra.mkdirSync, readFileSync: typeof fsExtra.readFileSync, unlinkSync: typeof fsExtra.unlinkSync, statSync: fsExtra.StatSyncFn, createWriteStream: typeof fsExtra.createWriteStream;
 export declare const readJsonSync: typeof fsExtra.readJsonSync;
-export declare function writeFileSync(file: fsExtra.PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: fsExtra.WriteFileOptions): void;
+/**
+ * Writes data to a file synchronously with UTF-8 encoding as default.
+ * This function provides a simplified interface for writing files with automatic UTF-8 encoding
+ * when no specific options are provided.
+ *
+ * @param file - The file path or file descriptor to write to.
+ * @param data - The data to write to the file (string or Uint8Array).
+ * @param options - Optional write file options (defaults to UTF-8 encoding).
+ */
+export declare function writeFileSync(file: fsExtra.PathOrFileDescriptor, data: string | Uint8Array, options?: fsExtra.WriteFileOptions): void;
+/**
+ * Appends data to a file synchronously with UTF-8 encoding as default.
+ * This function provides a simplified interface for appending to files with automatic UTF-8 encoding
+ * when no specific options are provided.
+ *
+ * @param path - The file path or file descriptor to append to.
+ * @param data - The data to append to the file (string or Uint8Array).
+ * @param options - Optional write file options (defaults to UTF-8 encoding).
+ */
 export declare function appendFileSync(path: fsExtra.PathOrFileDescriptor, data: string | Uint8Array, options?: fsExtra.WriteFileOptions): void;
+/**
+ * Checks if all specified paths exist synchronously.
+ * This function verifies that every path in the provided array exists in the file system.
+ * Returns true only if all paths exist, false if any path is missing.
+ *
+ * @param paths - An array of file or directory paths to check for existence.
+ * @returns True if all paths exist, false if any path is missing.
+ */
 export declare function pathExistsSync(...paths: string[]): boolean;
+/**
+ * Removes files or directories synchronously if they exist.
+ * This function safely removes multiple files or directories by checking for existence
+ * before attempting removal, preventing errors for non-existent paths.
+ *
+ * @param paths - An array of file or directory paths to remove.
+ */
 export declare function removeSync(...paths: string[]): void;
+/**
+ * Copies files and directories synchronously with optional filtering.
+ * This function copies files from source to destination with support for:
+ * - Extension-based filtering (only copy files with specified extensions)
+ * - Directory preservation (always copy directories regardless of extension filter)
+ * - Additional copy options from fs-extra
+ *
+ * @param src - The source path to copy from.
+ * @param dest - The destination path to copy to.
+ * @param options - Optional copy configuration including extensions filter and other fs-extra options.
+ */
 export declare function copySync(src: string, dest: string, options?: I_CopySyncOptions): void;

package/dist/node/log/log.type.d.ts

@@ -1,4 +1,9 @@
 import { I_Log as I_LogCommon } from '../../typescript/index.js';
+/**
+ * Enum representing the type of issues for logging and error handling.
+ * - Error: Represents an error issue.
+ * - Warning: Represents a warning issue.
+ */
 export declare enum E_IssueType {
     Error = "error",
     Warning = "warning"
@@ -10,7 +15,7 @@ export interface I_IssueEntry {
     position?: string;
     rule?: string;
 }
-export interface T_ThrowError {
+export interface I_ThrowError {
     message?: string;
     status?: {
         CODE: string | number;

package/dist/node/log/log.util.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("chalk"),r=require("consola"),i=require("graphql"),f=require("../../config/env/env.util.cjs"),g=require("../../constant/response-status.cjs"),h=f.getEnv();function R({message:o,status:e=g.RESPONSE_STATUS.INTERNAL_SERVER_ERROR,type:l="graphql"}){var t;const n=(t=o!=null?o:e.MESSAGE)!=null?t:"Internal server error";throw l==="graphql"?new i.GraphQLError(n,{extensions:{code:e.CODE}}):new Error(n)}h.DEBUG||(r.level=4);function s(o){const e=c[o];return typeof e=="function"?e:c.green}const E={silent:r.silent,level:r.level,fatal:r.fatal,error:r.error,warn:r.warn,log:r.log,info:r.info,success:r.success,ready:r.ready,start:r.start,box:r.box,debug:r.debug,trace:r.trace,verbose:r.verbose,printBoxedLog(o,e,l="red"){if(!(e!=null&&e.length)){r.box(c.green(o));return}e.forEach(({file:t,position:n,rule:a,message:u})=>{r.log(`${c.gray("File:")} ${c.blue(`${t}${n?`:${n}`:""}`)}`),a&&r.log(`   ${s(l)("Rule:")} ${a}`),r.log(`   ${s(l)("Message:")} ${u}`)}),r.box(s(l)(`${o} : ${e.length}`)),r.log(c.gray("─".repeat(40)))}};function S(o,e){const{shouldLog:l=!0,returnValue:t,callback:n}=e!=null?e:{},a=o instanceof Error?o:new Error(typeof o=="string"?o:"Unknown error");return l&&E.error(a.message),n&&typeof n=="function"&&n(a),t||{success:!1,message:a.message,code:g.RESPONSE_STATUS.INTERNAL_SERVER_ERROR.CODE}}exports.catchError=S;exports.log=E;exports.throwError=R;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("chalk"),e=require("consola"),h=require("graphql"),S=require("../../config/env/env.util.cjs"),g=require("../../constant/response-status.cjs"),R=S.getEnv();function d({message:o,status:r=g.RESPONSE_STATUS.INTERNAL_SERVER_ERROR,type:t="graphql"}){var l;const n=(l=o!=null?o:r.MESSAGE)!=null?l:"Internal server error";throw t==="graphql"?new h.GraphQLError(n,{extensions:{code:r.CODE}}):new Error(n)}R.DEBUG||(e.level=4);function s(o){const r=c[o];return typeof r=="function"?r:c.green}const i={silent:e.silent,level:e.level,fatal:e.fatal,error:e.error,warn:e.warn,log:e.log,info:e.info,success:e.success,ready:e.ready,start:e.start,box:e.box,debug:e.debug,trace:e.trace,verbose:e.verbose,printBoxedLog(o,r,t="red"){if(!(r!=null&&r.length)){e.box(c.green(o));return}r.forEach(({file:l,position:n,rule:a,message:u})=>{const E=n?`:${n}`:"",f=`${l}${E}`;e.log(`${c.gray("File:")} ${c.blue(f)}`),a&&e.log(`   ${s(t)("Rule:")} ${a}`),e.log(`   ${s(t)("Message:")} ${u}`)}),e.box(s(t)(`${o} : ${r.length}`)),e.log(c.gray("─".repeat(40)))}};function b(o,r){const{shouldLog:t=!0,returnValue:l,callback:n}=r!=null?r:{},a=o instanceof Error?o:new Error(typeof o=="string"?o:"Unknown error");return t&&i.error(a.message),n&&typeof n=="function"&&n(a),l||{success:!1,message:a.message,code:g.RESPONSE_STATUS.INTERNAL_SERVER_ERROR.CODE}}exports.catchError=b;exports.log=i;exports.throwError=d;

package/dist/node/log/log.util.d.ts

@@ -1,7 +1,35 @@
 import { I_Return } from '../../typescript/index.js';
-import { I_CatchErrorOptions, I_Log, T_ThrowError } from './log.type.js';
-export declare function throwError({ message, status, type, }: T_ThrowError): never;
+import { I_CatchErrorOptions, I_Log, I_ThrowError } from './log.type.js';
+/**
+ * Throws a standardized error with optional status information and type specification.
+ * This function creates and throws errors that can be either GraphQL errors (with extensions)
+ * or standard JavaScript errors, depending on the specified type.
+ *
+ * @param options - Error configuration including message, status information, and error type.
+ * @param options.message - The error message to display.
+ * @param options.status - The response status information (defaults to INTERNAL_SERVER_ERROR).
+ * @param options.type - The type of error to throw ('graphql' or 'rest', defaults to 'graphql').
+ * @throws {GraphQLError} When type is 'graphql', throws a GraphQL error with extensions.
+ * @throws {Error} When type is 'rest' or unspecified, throws a standard JavaScript error.
+ */
+export declare function throwError({ message, status, type, }: I_ThrowError): never;
+/**
+ * Enhanced logging interface that extends consola with custom functionality.
+ * This object provides all standard consola logging methods plus additional features
+ * like boxed log printing for structured error/warning display.
+ */
 export declare const log: I_Log;
+/**
+ * Catches and handles errors with configurable behavior.
+ * This function provides a standardized way to handle errors with options for:
+ * - Logging control (whether to log the error)
+ * - Return value specification (what to return on error)
+ * - Custom callback execution (additional error handling)
+ *
+ * @param errorInput - The error to catch and handle.
+ * @param options - Configuration options for error handling behavior.
+ * @returns Either the specified return value or a standardized error response object.
+ */
 export declare function catchError<T = unknown>(errorInput: unknown, options: I_CatchErrorOptions & {
     returnValue: T;
 }): T;

package/dist/node/log/log.util.js

@@ -1,26 +1,26 @@
 import c from "chalk";
 import r from "consola";
-import { GraphQLError as E } from "graphql";
-import { getEnv as i } from "../../config/env/env.util.js";
+import { GraphQLError as u } from "graphql";
+import { getEnv as h } from "../../config/env/env.util.js";
 import { RESPONSE_STATUS as s } from "../../constant/response-status.js";
-const u = i();
-function p({
+const R = h();
+function w({
   message: o,
   status: e = s.INTERNAL_SERVER_ERROR,
-  type: l = "graphql"
+  type: t = "graphql"
 }) {
-  var t;
-  const n = (t = o != null ? o : e.MESSAGE) != null ? t : "Internal server error";
-  throw l === "graphql" ? new E(n, {
+  var l;
+  const n = (l = o != null ? o : e.MESSAGE) != null ? l : "Internal server error";
+  throw t === "graphql" ? new u(n, {
     extensions: { code: e.CODE }
   }) : new Error(n);
 }
-u.DEBUG || (r.level = 4);
+R.DEBUG || (r.level = 4);
 function f(o) {
   const e = c[o];
   return typeof e == "function" ? e : c.green;
 }
-const h = {
+const m = {
   silent: r.silent,
   level: r.level,
   fatal: r.fatal,
@@ -35,26 +35,39 @@ const h = {
   debug: r.debug,
   trace: r.trace,
   verbose: r.verbose,
-  printBoxedLog(o, e, l = "red") {
+  /**
+   * Prints a boxed log with structured issue information.
+   * This method displays issues (errors or warnings) in a formatted box with:
+   * - File paths and line/column positions
+   * - Rule violations (if applicable)
+   * - Error/warning messages
+   * - Color-coded output based on issue type
+   *
+   * @param title - The title to display in the box header.
+   * @param issues - An array of issue entries to display.
+   * @param color - The color to use for highlighting (defaults to 'red').
+   */
+  printBoxedLog(o, e, t = "red") {
     if (!(e != null && e.length)) {
       r.box(c.green(o));
       return;
     }
-    e.forEach(({ file: t, position: n, rule: a, message: g }) => {
-      r.log(`${c.gray("File:")} ${c.blue(`${t}${n ? `:${n}` : ""}`)}`), a && r.log(`   ${f(l)("Rule:")} ${a}`), r.log(`   ${f(l)("Message:")} ${g}`);
-    }), r.box(f(l)(`${o} : ${e.length}`)), r.log(c.gray("─".repeat(40)));
+    e.forEach(({ file: l, position: n, rule: a, message: g }) => {
+      const i = n ? `:${n}` : "", E = `${l}${i}`;
+      r.log(`${c.gray("File:")} ${c.blue(E)}`), a && r.log(`   ${f(t)("Rule:")} ${a}`), r.log(`   ${f(t)("Message:")} ${g}`);
+    }), r.box(f(t)(`${o} : ${e.length}`)), r.log(c.gray("─".repeat(40)));
   }
 };
-function v(o, e) {
-  const { shouldLog: l = !0, returnValue: t, callback: n } = e != null ? e : {}, a = o instanceof Error ? o : new Error(typeof o == "string" ? o : "Unknown error");
-  return l && h.error(a.message), n && typeof n == "function" && n(a), t || {
+function S(o, e) {
+  const { shouldLog: t = !0, returnValue: l, callback: n } = e != null ? e : {}, a = o instanceof Error ? o : new Error(typeof o == "string" ? o : "Unknown error");
+  return t && m.error(a.message), n && typeof n == "function" && n(a), l || {
     success: !1,
     message: a.message,
     code: s.INTERNAL_SERVER_ERROR.CODE
   };
 }
 export {
-  v as catchError,
-  h as log,
-  p as throwError
+  S as catchError,
+  m as log,
+  w as throwError
 };

package/dist/node/mongo/mongo.constant.d.ts

@@ -1 +1,6 @@
+/**
+ * Environment variable key for MongoDB migration options.
+ * This constant defines the environment variable name that can be used to configure
+ * MongoDB migration settings and options for database schema management.
+ */
 export declare const MONGO_MIGRATE_OPTIONS = "MONGO_MIGRATE_OPTIONS";

package/dist/node/mongo/mongo.type.d.ts

@@ -85,7 +85,7 @@ export interface I_CreateModelOptions<T extends Partial<C_Document>> extends I_M
     pagination?: boolean;
 }
 export type T_Input_Populate = string | string[] | T_PopulateOptions | T_PopulateOptions[];
-export interface T_PaginateOptionsWithPopulate extends T_PaginateOptions, Omit<T_PopulateOption, 'populate'> {
+export interface I_PaginateOptionsWithPopulate extends T_PaginateOptions, Omit<T_PopulateOption, 'populate'> {
     populate?: T_Input_Populate;
 }
 export interface I_Input_FindOne<T> extends T_PopulateOption {
@@ -99,14 +99,14 @@ export interface I_Input_FindAll<T> extends T_PopulateOption {
     options?: T_QueryOptions<T>;
 }
 export type I_Input_FindPaging<T = undefined> = T extends undefined ? {
-    options?: T_PaginateOptionsWithPopulate;
+    options?: I_PaginateOptionsWithPopulate;
 } : {
     filter?: T_FilterQuery<T>;
-    options?: T_PaginateOptionsWithPopulate;
+    options?: I_PaginateOptionsWithPopulate;
 };
 export interface I_Input_FindPagingAggregate {
     pipeline: T_PipelineStage[];
-    options?: T_PaginateOptionsWithPopulate;
+    options?: I_PaginateOptionsWithPopulate;
 }
 export interface I_Input_CreateOne<T> {
     doc: T;