vortez 4.1.3 → 5.0.0-dev.15

package/build/utilities/Env.d.ts

@@ -0,0 +1,81 @@
+export declare class Env {
+    /**
+     * Gets all current environment variables.
+     * @returns An object containing key-value pairs of environment variables.
+     */
+    static get data(): Env.EnvList;
+    /**
+     * Load the environment variables from the given path.
+     * @param path - The path to the environment variables file.
+     * @param options - Options to load the environment variables.
+     * @returns A promise that resolves with the loaded environment variables as an object.
+     * @throws Error if the environment variables file does not exist and cannot be created.
+     * @throws Error if the environment variables file is not readable.
+     */
+    static load(path: string, options?: Env.LoadOptions): Promise<Env.EnvList>;
+    /**
+     * Load the environment variables from the given path synchronously.
+     * @param path - The path to the environment variables file.
+     * @param options - Options to load the environment variables.
+     * @returns The loaded environment variables as an object.
+     * @throws Error if the environment variables file does not exist and cannot be created.
+     * @throws Error if the environment variables file is not readable.
+     */
+    static loadSync(path: string, options?: Env.LoadOptions): Env.EnvList;
+    /**
+     * Extract the environment variables from the given content.
+     * @param content - The content to extract the environment variables from.
+     * @param defaultEnv - An optional object of default environment variables to include if not present in the content.
+     * @returns An object containing the extracted environment variables merged with defaults.
+     */
+    private static extractEnv;
+    /**
+     * Get the value of an environment variable.
+     * @param key - The key of the environment variable to get.
+     * @param options - Options to get the environment variable.
+     * @param options.default - The default value to return if the environment variable is not set.
+     * @param options.warning - If `true`, a warning will be logged if the environment variable is not set.
+     * @returns The value of the environment variable or undefined if not set.
+     */
+    static get(key: string, options: Env.getOptionsGranted): string;
+    static get(key: string, options: Env.getOptions): string | undefined;
+    /**
+     * Set an environment variable.
+     * @param key - The key of the environment variable to set.
+     * @param value - The value to set for the environment variable.
+     */
+    static set(key: string, value: string): void;
+    /**
+     * Sets multiple environment variables from an object.
+     * @param env - An object containing key-value pairs of environment variables to set.
+     */
+    static setMany(env: Env.EnvList): void;
+    /**
+     * Delete an environment variable.
+     * @param key - The key of the environment variable to delete.
+     */
+    static delete(key: string): void;
+    /**
+     * Convert an EnvList to a .env-formatted string.
+     * @param env - The environment variables object.
+     * @returns A string in .env format.
+     */
+    static toEnv(env: Env.EnvList): string;
+}
+export declare namespace Env {
+    interface EnvList {
+        [key: string]: string | undefined;
+    }
+    interface LoadOptions {
+        setEnv?: boolean;
+        defaultEnv?: EnvList;
+    }
+    interface getOptions {
+        default?: string;
+        warning?: boolean;
+    }
+    type getOptionsGranted = getOptions & {
+        default: string;
+    };
+}
+export default Env;

package/build/{Utilities → utilities}/Env.js

@@ -1,41 +1,53 @@
-import FS, { promises as FSPromises } from "fs";
+import FS, { promises as FSP } from "fs";
 import PATH from "path";
-import Debug from "../Debug.js";
+import Debug from "../logger/Debug.js";
+import Utilities from "./Utilities.js";
 export class Env {
-    static get variables() { return process.env; }
     /**
-     * Check if a file exists
-     * @param path - The path to the file
-     * @returns A promise that resolves to true if the file exists, false otherwise
+     * Gets all current environment variables.
+     * @returns An object containing key-value pairs of environment variables.
      */
-    static async fileExists(path) {
-        return FSPromises.access(path).then(() => true).catch(() => false);
-    }
+    static get data() { return process.env; }
     /**
-     * Load the environment variables from the given path
-     * @param path - The path to the environment variables file
-     * @param options - Options to load the environment variables
-     * @returns The loaded environment variables as an object
-     * @throws Error if the environment variables file does not exist and cannot be created
-     * @throws Error if the environment variables file is not readable
+     * Load the environment variables from the given path.
+     * @param path - The path to the environment variables file.
+     * @param options - Options to load the environment variables.
+     * @returns A promise that resolves with the loaded environment variables as an object.
+     * @throws Error if the environment variables file does not exist and cannot be created.
+     * @throws Error if the environment variables file is not readable.
      */
     static async load(path, options = {}) {
         Debug.log(`loading environment variables from &C6[${path}]`);
         const defaultEnv = options.defaultEnv ?? {};
         const setEnv = options.setEnv ?? true;
-        if (!await this.fileExists(path)) {
-            await FSPromises.mkdir(PATH.dirname(path), { recursive: true });
-            const env = this.toEnv(defaultEnv);
-            await FSPromises.writeFile(path, env, 'utf-8');
-            Debug.log(`environment variables file &C6[${path}]&R does not exist, creating it`);
+        if (!await Utilities.fileExists(path)) {
+            try {
+                Debug.log(`environment variables file &C6[${path}]&R does not exist, creating it`);
+                await FSP.mkdir(PATH.dirname(path), { recursive: true });
+                const env = this.toEnv(defaultEnv);
+                await FSP.writeFile(path, env, 'utf-8');
+                Debug.log(`environment variables file &C6[${path}]&R &C2was created successfully`);
+            }
+            catch (error) {
+                Debug.log(`environment variables file &C6[${path}]&R &C1could not be created`);
+                throw error;
+            }
         }
-        const env = await FSPromises.readFile(path, 'utf-8');
+        const env = await FSP.readFile(path, 'utf-8');
         const result = this.extractEnv(env, defaultEnv);
         if (setEnv)
             this.setMany(result);
         Debug.log(`environment variables loaded from &C6[${path}]`);
         return result;
     }
+    /**
+     * Load the environment variables from the given path synchronously.
+     * @param path - The path to the environment variables file.
+     * @param options - Options to load the environment variables.
+     * @returns The loaded environment variables as an object.
+     * @throws Error if the environment variables file does not exist and cannot be created.
+     * @throws Error if the environment variables file is not readable.
+     */
     static loadSync(path, options = {}) {
         Debug.log(`loading environment variables from &C6[${path}]`);
         const defaultEnv = options.defaultEnv ?? {};
@@ -54,10 +66,10 @@ export class Env {
         return result;
     }
     /**
-     * Extract the environment variables from the given content
-     * @param content - The content to extract the environment variables from
-     * @param defaultEnv - The default environment variables to use if none are found
-     * @returns The extracted environment variables as an object
+     * Extract the environment variables from the given content.
+     * @param content - The content to extract the environment variables from.
+     * @param defaultEnv - An optional object of default environment variables to include if not present in the content.
+     * @returns An object containing the extracted environment variables merged with defaults.
      */
     static extractEnv(content, defaultEnv = {}) {
         const lines = content.split('\n');
@@ -87,32 +99,32 @@ export class Env {
         return defaultVal;
     }
     /**
-     * Set an environment variable
-     * @param key - The environment variable key
-     * @param value - The value to set
+     * Set an environment variable.
+     * @param key - The key of the environment variable to set.
+     * @param value - The value to set for the environment variable.
      */
     static set(key, value) {
         process.env[key] = value;
     }
     /**
-     * Set multiple environment variables at once
-     * @param env - An object containing key-value pairs of environment variables
+     * Sets multiple environment variables from an object.
+     * @param env - An object containing key-value pairs of environment variables to set.
      */
     static setMany(env) {
         for (const key in env)
             process.env[key] = env[key] ?? '';
     }
     /**
-     * Delete an environment variable
-     * @param key - The environment variable key to delete
+     * Delete an environment variable.
+     * @param key - The key of the environment variable to delete.
      */
     static delete(key) {
         delete process.env[key];
     }
     /**
-     * Convert an EnvList to a .env-formatted string
-     * @param env - The environment variables object
-     * @returns A string in .env format
+     * Convert an EnvList to a .env-formatted string.
+     * @param env - The environment variables object.
+     * @returns A string in .env format.
      */
     static toEnv(env) {
         const filtered = Object.entries(env).filter(([key, value]) => typeof key === 'string' && typeof value === 'string');

package/build/utilities/Env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Env.js","sourceRoot":"","sources":["../../src/utilities/Env.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,QAAQ,IAAI,GAAG,EAAE,MAAM,IAAI,CAAC;AACzC,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,OAAO,KAAK,MAAM,oBAAoB,CAAC;AACvC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAEvC,MAAM,OAAO,GAAG;IACZ;;;OAGG;IACI,MAAM,KAAK,IAAI,KAAkB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7D;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAY,EAAE,UAA2B,EAAE;QAChE,KAAK,CAAC,GAAG,CAAC,0CAA0C,IAAI,GAAG,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC;QAEtC,IAAI,CAAC,MAAM,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACpC,IAAI,CAAC;gBACD,KAAK,CAAC,GAAG,CAAC,kCAAkC,IAAI,iCAAiC,CAAC,CAAC;gBACnF,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBACzD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;gBACnC,MAAM,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;gBACxC,KAAK,CAAC,GAAG,CAAC,kCAAkC,IAAI,iCAAiC,CAAC,CAAC;YACvF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,KAAK,CAAC,GAAG,CAAC,kCAAkC,IAAI,6BAA6B,CAAC,CAAC;gBAC/E,MAAM,KAAK,CAAC;YAChB,CAAC;QACL,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAChD,IAAI,MAAM;YAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjC,KAAK,CAAC,GAAG,CAAC,yCAAyC,IAAI,GAAG,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY,EAAE,UAA2B,EAAE;QAC9D,KAAK,CAAC,GAAG,CAAC,0CAA0C,IAAI,GAAG,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;QAC5C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,IAAI,CAAC;QAEtC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACtD,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;YACnC,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;YACrC,KAAK,CAAC,GAAG,CAAC,kCAAkC,IAAI,iCAAiC,CAAC,CAAC;QACvF,CAAC;QAED,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;QAChD,IAAI,MAAM;YAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAEjC,KAAK,CAAC,GAAG,CAAC,yCAAyC,IAAI,GAAG,CAAC,CAAC;QAC5D,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;OAKG;IACK,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,aAA0B,EAAE;QACnE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,MAAM,GAAgB,EAAE,GAAG,UAAU,EAAE,CAAC;QAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;YAChC,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,SAAS;YAE1D,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACvC,IAAI,KAAK,KAAK,CAAC,CAAC;gBAAE,SAAS;YAE3B,MAAM,GAAG,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;YACnD,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACtD,IAAI,CAAC,GAAG;gBAAE,SAAS;YAEnB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACxB,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAWM,MAAM,CAAC,GAAG,CAAC,GAAW,EAAE,UAA0B,EAAE;QACvD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;QACxB,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QACzD,IAAI,OAAO;YAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,GAAG,qBAAqB,UAAU,CAAC,CAAC,CAAC,kBAAkB,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACtH,OAAO,UAAU,CAAC;IACtB,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,GAAG,CAAC,GAAW,EAAE,KAAa;QACxC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC7B,CAAC;IACD;;;OAGG;IACI,MAAM,CAAC,OAAO,CAAC,GAAgB;QAClC,KAAK,MAAM,GAAG,IAAI,GAAG;YAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;IAC7D,CAAC;IACD;;;OAGG;IACI,MAAM,CAAC,MAAM,CAAC,GAAW;QAC5B,OAAO,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,GAAgB;QAChC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC;QACpH,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC;CACJ;AAeD,eAAe,GAAG,CAAC"}

package/build/utilities/Path.d.ts

@@ -0,0 +1,24 @@
+export declare class Path {
+    static readonly moduleDir: string;
+    static readonly moduleMain: string;
+    /**
+     * Normalizes a path by replacing all backslashes with the system-specific separator.
+     * @param path - The path to clean.
+     * @returns The normalized path.
+     */
+    static normalize(path: string): string;
+    /**
+     * Converts a relative path to an absolute one, relative to the module root directory.
+     * @param path - The relative path.
+     * @returns The absolute path.
+     */
+    static relative(path: string): string;
+    /**
+     * Gets the directory name of a path.
+     * @param path - The path to get the directory name from.
+     * @returns The directory name.
+     */
+    static dirname(path: string): string;
+}
+export declare namespace Path { }
+export default Path;

package/build/utilities/Path.js

@@ -0,0 +1,36 @@
+import PATH from 'path';
+import URL from 'url';
+export class Path {
+    static moduleDir = PATH.dirname(PATH.dirname(PATH.dirname(URL.fileURLToPath(import.meta.url))));
+    static moduleMain = PATH.join(this.moduleDir, 'build/Vortez.js');
+    /**
+     * Normalizes a path by replacing all backslashes with the system-specific separator.
+     * @param path - The path to clean.
+     * @returns The normalized path.
+     */
+    static normalize(path) {
+        path = path.replace(/[\\/]/gi, PATH.sep);
+        return path;
+    }
+    /**
+     * Converts a relative path to an absolute one, relative to the module root directory.
+     * @param path - The relative path.
+     * @returns The absolute path.
+     */
+    static relative(path) {
+        path = this.normalize(path);
+        path = PATH.join(this.moduleDir, path);
+        return PATH.normalize(path);
+    }
+    /**
+     * Gets the directory name of a path.
+     * @param path - The path to get the directory name from.
+     * @returns The directory name.
+     */
+    static dirname(path) {
+        path = this.normalize(path);
+        return PATH.dirname(path);
+    }
+}
+export default Path;
+//# sourceMappingURL=Path.js.map

package/build/{Utilities → utilities}/Path.js.map

@@ -1 +1 @@
-{"version":3,"file":"Path.js","sourceRoot":"","sources":["../../src/Utilities/Path.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,MAAM,OAAO,IAAI;IACN,MAAM,CAAU,SAAS,GAAW,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACjH,MAAM,CAAU,UAAU,GAAW,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;IACzF;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,IAAY;QAChC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY;QAC/B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;;AAGL,eAAe,IAAI,CAAC"}
+{"version":3,"file":"Path.js","sourceRoot":"","sources":["../../src/utilities/Path.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,MAAM,OAAO,IAAI;IACN,MAAM,CAAU,SAAS,GAAW,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACjH,MAAM,CAAU,UAAU,GAAW,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;IACzF;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,IAAY;QAChC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY;QAC/B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,IAAY;QAC9B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;;AAGL,eAAe,IAAI,CAAC"}

package/build/{Utilities → utilities}/Utilities.d.ts

@@ -5,72 +5,86 @@
  */
 import _Path from './Path.js';
 import _Env from './Env.js';
+import _ConsoleUI from './ConsoleUI.js';
+import _DebugUI from './DebugUI.js';
+export { Path } from './Path.js';
+export { Env } from './Env.js';
+export { ConsoleUI } from './ConsoleUI.js';
+export { DebugUI } from './DebugUI.js';
 export declare class Utilities {
     /**
-     * Deeply compares two objects.
-     * @param obj1 - The first object to compare
-     * @param obj2 - The second object to compare
-     * @returns True if the objects are equal, false otherwise
+     * Checks if a file exists asynchronously.
+     * @param path - The path to the file.
+     * @returns A promise that resolves to `true` if the file exists, `false` otherwise.
+     */
+    static fileExists(path: string): Promise<boolean>;
+    /**
+     * Compares two objects recursively for deep equality.
+     * @param obj1 - The first object to compare.
+     * @param obj2 - The second object to compare.
+     * @returns A boolean indicating whether the objects are deeply equal or not.
      */
     static deepEqual(obj1: any, obj2: any): boolean;
     /**
-     * Flattens an object into a single-level object.
-     * @param object - The object to flatten
-     * @param depth - Maximum depth to flatten (default: 10)
-     * @returns The flattened object
+     * Flattens a nested object into a single-level object with dot notation keys.
+     * @param object - The object to flatten.
+     * @param depth - The maximum depth to which the object should be flattened.
+     * @returns The flattened object.
      */
     static flattenObject<T extends object, D extends number = 10>(object: T, depth?: D): Utilities.Flatten.Object<T, D>;
-    protected static flattenCore(object: any, depth?: number, prefix?: string): any;
+    private static flattenCore;
     /**
-     * Reconstructs a nested object from a flattened one.
-     * @template Result - The type of the unflattened object
-     * @param obj - The object to unflatten
-     * @returns The unflattened object
+     * Reconstructs a nested object from a flattened object with dot notation keys.
+     * @template Result - The type of the unflattened object.
+     * @param obj - The flattened object to un flatten.
+     * @returns The unflattened object.
      */
     static unFlattenObject<Result extends any = any>(obj: any): Result;
     /**
-     * Delays execution for the specified number of milliseconds.
-     * @param ms - The number of milliseconds to wait
-     * @returns A promise that resolves after the given time
+     * Pauses the execution of the program for a specified duration.
+     * @param ms - The number of milliseconds to sleep.
+     * @returns A promise that resolves after the given time.
      */
     static sleep(ms: number): Promise<void>;
     /**
      * Encodes a string to base64url format.
-     * @param data - The string to encode
-     * @returns The base64url-encoded string
+     * @param data - The string that needs to be encoded.
+     * @returns The base64url-encoded string.
      */
     static base64UrlEncode(data: string): string;
     /**
      * Decodes a base64url-encoded string.
-     * @param data - The base64url-encoded string to decode
-     * @returns The decoded string
+     * @param data - The base64url-encoded string that needs to be decoded.
+     * @returns The decoded string.
      */
     static base64UrlDecode(data: string): string;
 }
 export declare namespace Utilities {
     export import Path = _Path;
     export import Env = _Env;
+    export import ConsoleUI = _ConsoleUI;
+    export import DebugUI = _DebugUI;
     namespace Types {
         type NumListAdd = [1, 2, 3, 4, 5, 6, 7, 8, 9, 0];
         type strToNum<str extends string> = str extends `${infer num extends number}` ? num : never;
         /**
-         * add one to a number
-         * @template Number the number to add one to
-         * @returns the number added one
+         * Adds one to a number type.
+         * @template Number the number to add one to.
+         * @returns The number incremented by one.
          */
         export type Inc<Number extends number | string> = (`${Number}` extends `${infer surPlus}${NumListAdd[number]}` ? `${Number}` extends `${surPlus}${infer unit extends number}` ? unit extends Exclude<NumListAdd[number], 9> ? strToNum<`${surPlus}${NumListAdd[unit]}`> : strToNum<`${surPlus extends `${infer Num extends number}` ? '' : '1'}${surPlus extends '' ? '' : Inc<surPlus>}${NumListAdd[unit]}`> : number : number);
         /**
-         * union to intersection
-         * @template U the union to convert
-         * @returns the intersection of the union
+         * Converts a union of object types into an intersection type.
+         * @template U the union to convert.
+         * @returns The intersection type of the given union.
         */
         export type UnionToIntersection<U extends object> = ((U extends any ? (arg: U) => void : never) extends (arg: infer I) => void ? I extends object ? {
             [K in keyof I]: I[K] extends object ? UnionToIntersection<I[K]> : I[K];
         } : I : never);
         /**
-         * convert the object property with undefined to optional
-         * @template T the object to convert
-         * @returns the converted object
+         * Converts properties with `undefined` in an object type to optional properties.
+         * @template T the object to convert.
+         * @returns The object type with properties containing `undefined` marked as optional.
          */
         export type undefinedToPartial<T extends object> = {
             [K in keyof T as undefined extends T[K] ? never : K]: T[K];
@@ -84,29 +98,28 @@ export declare namespace Utilities {
     }
     namespace Flatten {
         /**
-         * flatten an object into a single level and return an union of all the keys
-         * @template T the object to flatten
-         * @template depth the depth to flatten
-         * @template index the current index
-         * @returns the flattened object keys as a union
+         * Generates a union of all possible flattened keys for a given object type and depth.
+         * @template T the object to flatten.
+         * @template depth - The maximum depth to flatten.
+         * @template index - The current recursion index (internal use).
+         * @returns A union type of the flattened keys.
          */
         type ResourceKeys<T extends Types.Document, depth extends number = 5, index extends number = 1> = {
             [K in keyof T]-?: depth extends index ? K & string : Exclude<T[K], undefined> extends infer U ? U extends any[] ? K & string : U extends object ? `${K & string}.${ResourceKeys<U, depth, Types.Inc<index>>}` : K & string : "fail_in_flatten_inference";
         }[keyof T];
         /**
-         * flatten an object into a single level and return an union of all the keys
-         * @template T the object to flatten
-         * @template depth the depth to flatten
-         * @template index the current index
-         * @returns the flattened object keys as a union
+         * Recursively retrieves the type of a value based on a flattened key path.
+         * @template T the object to flatten.
+         * @template Keys - The flattened key path string.
+         * @returns The type of the value at the specified key path, or `never` if the path is invalid.
          */
         type RecurseObject<T extends Types.Document, Keys extends string> = (Keys extends `${infer K}.${infer Rest}` ? K extends keyof T ? undefined extends T[K] ? RecurseObject<Exclude<T[K], undefined>, Rest> | undefined : RecurseObject<T[K], Rest> : never : undefined extends T ? Keys extends keyof Exclude<T, undefined> ? Exclude<T, undefined>[Keys] | undefined : never : Keys extends keyof T ? T[Keys] : never);
         /**
-         * flatten an object into a single level
-         * @template T the object to flatten
-         * @template depth the depth to flatten
-         * @template index the current index
-         * @returns the flattened object
+         * Represents the type of a flattened object up to a specified depth.
+         * @template T the object to flatten.
+         * @template depth - The maximum depth of flattening.
+         * @template index the current index.
+         * @returns the flattened object.
          */
         export type Object<T extends Types.Document, depth extends number = 5, index extends number = 1> = Types.undefinedToPartial<{
             [P in ResourceKeys<T, depth, index>]: RecurseObject<T, P>;
@@ -115,25 +128,25 @@ export declare namespace Utilities {
     }
     namespace UnFlatten {
         /**
-         * split a string by a delimiter
-         * @template S the string to split
-         * @template Delimiter the delimiter to split by
-         * @returns the split string
+         * Splits a string into a tuple of strings based on a delimiter.
+         * @template S - The string to split.
+         * @template Delimiter - The delimiter to split by.
+         * @returns the split string.
          */
         type Split<S extends string, Delimiter extends string> = (S extends `${infer T}${Delimiter}${infer U}` ? [T, ...Split<U, Delimiter>] : [S]);
         /**
-         * build a nested object from a string
-         * @template Path the path to build
-         * @template Value the value to build
-         * @returns the nested object
+         * Builds a nested object type from a string path and a value type.
+         * @template Path - The path of keys as a string array.
+         * @template Value - The type of the value at the end of the path.
+         * @returns the nested object.
          */
         type BuildNestedObject<Path extends string[], Value> = (Path extends [infer Head extends string, ...infer Tail extends string[]] ? Types.undefinedToPartial<{
             [K in Head]: BuildNestedObject<Tail, Value>;
         }> : Value);
         /**
-         * unFlatten an object into a single level
-         * @template T the object to unFlatten
-         * @returns the unFlattened object
+         * Represents the type of a nested object reconstructed from a flattened object.
+         * @template T - The type of the flattened object.
+         * @returns the unFlattened object.
          */
         export type Object<T extends Types.Document> = Types.UnionToIntersection<Types.undefinedToPartial<({
             [K in keyof T]-?: BuildNestedObject<Split<Extract<K, string>, ".">, T[K]>;

package/build/{Utilities → utilities}/Utilities.js

@@ -3,14 +3,29 @@
  * @description add useful functions to the Vortez.
  * @license Apache-2.0
  */
+import { promises as FSP } from "fs";
 import _Path from './Path.js';
 import _Env from './Env.js';
+import _ConsoleUI from './ConsoleUI.js';
+import _DebugUI from './DebugUI.js';
+export { Path } from './Path.js';
+export { Env } from './Env.js';
+export { ConsoleUI } from './ConsoleUI.js';
+export { DebugUI } from './DebugUI.js';
 export class Utilities {
     /**
-     * Deeply compares two objects.
-     * @param obj1 - The first object to compare
-     * @param obj2 - The second object to compare
-     * @returns True if the objects are equal, false otherwise
+     * Checks if a file exists asynchronously.
+     * @param path - The path to the file.
+     * @returns A promise that resolves to `true` if the file exists, `false` otherwise.
+     */
+    static async fileExists(path) {
+        return FSP.access(path).then(() => true).catch(() => false);
+    }
+    /**
+     * Compares two objects recursively for deep equality.
+     * @param obj1 - The first object to compare.
+     * @param obj2 - The second object to compare.
+     * @returns A boolean indicating whether the objects are deeply equal or not.
      */
     static deepEqual(obj1, obj2) {
         if (obj1 === obj2)
@@ -29,10 +44,10 @@ export class Utilities {
         return true;
     }
     /**
-     * Flattens an object into a single-level object.
-     * @param object - The object to flatten
-     * @param depth - Maximum depth to flatten (default: 10)
-     * @returns The flattened object
+     * Flattens a nested object into a single-level object with dot notation keys.
+     * @param object - The object to flatten.
+     * @param depth - The maximum depth to which the object should be flattened.
+     * @returns The flattened object.
      */
     static flattenObject(object, depth = 10) {
         return this.flattenCore(object, depth);
@@ -52,10 +67,10 @@ export class Utilities {
         return result;
     }
     /**
-     * Reconstructs a nested object from a flattened one.
-     * @template Result - The type of the unflattened object
-     * @param obj - The object to unflatten
-     * @returns The unflattened object
+     * Reconstructs a nested object from a flattened object with dot notation keys.
+     * @template Result - The type of the unflattened object.
+     * @param obj - The flattened object to un flatten.
+     * @returns The unflattened object.
      */
     static unFlattenObject(obj) {
         const result = {};
@@ -78,25 +93,25 @@ export class Utilities {
         return result;
     }
     /**
-     * Delays execution for the specified number of milliseconds.
-     * @param ms - The number of milliseconds to wait
-     * @returns A promise that resolves after the given time
+     * Pauses the execution of the program for a specified duration.
+     * @param ms - The number of milliseconds to sleep.
+     * @returns A promise that resolves after the given time.
      */
     static sleep(ms) {
         return new Promise(resolve => setTimeout(resolve, ms));
     }
     /**
      * Encodes a string to base64url format.
-     * @param data - The string to encode
-     * @returns The base64url-encoded string
+     * @param data - The string that needs to be encoded.
+     * @returns The base64url-encoded string.
      */
     static base64UrlEncode(data) {
         return Buffer.from(data).toString('base64url');
     }
     /**
      * Decodes a base64url-encoded string.
-     * @param data - The base64url-encoded string to decode
-     * @returns The decoded string
+     * @param data - The base64url-encoded string that needs to be decoded.
+     * @returns The decoded string.
      */
     static base64UrlDecode(data) {
         return Buffer.from(data, 'base64url').toString('utf8');
@@ -105,6 +120,8 @@ export class Utilities {
 (function (Utilities) {
     Utilities.Path = _Path;
     Utilities.Env = _Env;
+    Utilities.ConsoleUI = _ConsoleUI;
+    Utilities.DebugUI = _DebugUI;
 })(Utilities || (Utilities = {}));
 export default Utilities;
 //# sourceMappingURL=Utilities.js.map

package/build/utilities/Utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utilities.js","sourceRoot":"","sources":["../../src/utilities/Utilities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,IAAI,GAAG,EAAE,MAAM,IAAI,CAAC;AAErC,OAAO,KAAK,MAAM,WAAW,CAAC;AAC9B,OAAO,IAAI,MAAM,UAAU,CAAC;AAC5B,OAAO,UAAU,MAAM,gBAAgB,CAAC;AACxC,OAAO,QAAQ,MAAM,cAAc,CAAC;AAEpC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,OAAO,SAAS;IAClB;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,IAAY;QACvC,OAAO,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,SAAS,CAAC,IAAS,EAAE,IAAS;QACxC,IAAI,IAAI,KAAK,IAAI;YAAE,OAAO,IAAI,CAAC;QAC/B,IACI,OAAO,IAAI,KAAK,OAAO,IAAI;YAC3B,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,IAAI;YAChC,OAAO,KAAK,CAAC;QACf,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAChD,KAAK,MAAM,GAAG,IAAI,KAAK;YAAE,IACrB,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;gBACpB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;gBACvC,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAA0C,MAAS,EAAE,QAAW,EAAO;QAC9F,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IACO,MAAM,CAAC,WAAW,CAAC,MAAW,EAAE,QAAgB,EAAE,EAAE,SAAiB,EAAE;QAC3E,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACvB,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YACjD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACpF,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YAC3E,CAAC;iBAAM,CAAC;gBACJ,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;YAC3B,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAA2B,GAAQ;QAC5D,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;YACpB,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;iBACxC,CAAC;gBACF,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAY,CAAC;gBAClC,MAAM,MAAM,GAAQ,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;gBACxC,IAAI,OAAO,GAAQ,MAAM,CAAC;gBAC1B,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBACf,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;gBACH,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;YAC3B,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,EAAU;QAC1B,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC3D,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY;QACtC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY;QACtC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3D,CAAC;CACJ;AAED,WAAiB,SAAS;IACR,cAAI,GAAG,KAAK,CAAC;IACb,aAAG,GAAG,IAAI,CAAC;IACX,mBAAS,GAAG,UAAU,CAAC;IACvB,iBAAO,GAAG,QAAQ,CAAC;AAmJrC,CAAC,EAvJgB,SAAS,KAAT,SAAS,QAuJzB;AACD,eAAe,SAAS,CAAC"}