@breadstone-infrastructure/utilities 0.0.71 → 0.0.73

package/IO/FileTracker.d.ts

@@ -0,0 +1,73 @@
+import type { IFileTracker } from './Interfaces/IFileTracker';
+/**
+ * FileTracker manages and cleans up generated files based on a manifest.
+ * It also provides utility methods for writing and tracking files cleanly.
+ *
+ * @public
+ */
+export declare class FileTracker implements IFileTracker {
+    private readonly _rootDir;
+    private readonly _manifest;
+    /**
+     * Constructs a new instance of the `FileTracker` class.
+     *
+     * @public
+     * @param rootDir The root directory where files will be tracked.
+     * @param manifestFilename The name of the manifest file (default is '.filetracker.json').
+     */
+    constructor(rootDir: string, manifestFilename?: string);
+    /**
+     * Loads the previous manifest to determine which files were generated in the last run.
+     * This is necessary for cleanup operations.
+     *
+     * @public
+     */
+    loadPreviousManifest(): Promise<void>;
+    /**
+     * Adds a file to the manifest as a generated file.
+     * The path is resolved relative to the root directory.
+     *
+     * @public
+     * @param relativePath Path relative to the root directory
+     */
+    addGeneratedFile(relativePath: string): void;
+    /**
+     * Cleans up files that were generated in previous runs but not in the current run.
+     * This helps to remove stale files that are no longer needed.
+     *
+     * @public
+     */
+    cleanup(): Promise<void>;
+    /**
+     * Saves the current manifest, which includes all files tracked in this run.
+     * This should be called after all file operations are complete.
+     *
+     * @public
+     */
+    saveManifest(): Promise<void>;
+    /**
+     * Writes a file to disk and tracks it in the manifest.
+     *
+     * @public
+     * @param relativePath Path relative to the root directory
+     * @param content File content
+     * @param options Optional write options
+     */
+    writeFile(relativePath: string, content: string): Promise<void>;
+    /**
+     * Executes a custom file-writing callback and tracks the file.
+     *
+     * @public
+     * @param relativePath Path relative to the root directory
+     * @param writer A callback that receives the absolute path to write content
+     */
+    trackFile(relativePath: string, writer: (absolutePath: string) => Promise<void>): Promise<void>;
+    /**
+     * Ensures that the directory for the given file path exists.
+     *
+     * @private
+     * @param fullFilePath The full path of the file to ensure its directory exists.
+     */
+    private ensureDirectoryExists;
+}
+//# sourceMappingURL=FileTracker.d.ts.map

package/IO/FileTracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileTracker.d.ts","sourceRoot":"","sources":["../../src/IO/FileTracker.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAO9D;;;;;GAKG;AACH,qBAAa,WAAY,YAAW,YAAY;IAI5C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IAMzC;;;;;;OAMG;gBACgB,OAAO,EAAE,MAAM,EAAE,gBAAgB,GAAE,MAA4B;IAWlF;;;;;OAKG;IACU,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIlD;;;;;;OAMG;IACI,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAKnD;;;;;OAKG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrC;;;;;OAKG;IACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAI1C;;;;;;;OAOG;IACU,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5E;;;;;;OAMG;IACU,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5G;;;;;OAKG;YACW,qBAAqB;CAUtC"}

package/IO/FileTracker.js

@@ -0,0 +1,116 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileTracker = void 0;
+const FileManifest_1 = require("./FileManifest");
+const Path_1 = require("./Path");
+const File_1 = require("./File");
+const Directory_1 = require("./Directory");
+// #endregion
+/**
+ * FileTracker manages and cleans up generated files based on a manifest.
+ * It also provides utility methods for writing and tracking files cleanly.
+ *
+ * @public
+ */
+class FileTracker {
+    // #region Fields
+    _rootDir;
+    _manifest;
+    // #endregion
+    // #region Ctor
+    /**
+     * Constructs a new instance of the `FileTracker` class.
+     *
+     * @public
+     * @param rootDir The root directory where files will be tracked.
+     * @param manifestFilename The name of the manifest file (default is '.filetracker.json').
+     */
+    constructor(rootDir, manifestFilename = '.filetracker.json') {
+        this._rootDir = Path_1.Path.resolve(rootDir);
+        this._manifest = new FileManifest_1.FileManifest({
+            manifestPath: Path_1.Path.combine(this._rootDir, manifestFilename)
+        });
+    }
+    // #endregion
+    // #region Methods
+    /**
+     * Loads the previous manifest to determine which files were generated in the last run.
+     * This is necessary for cleanup operations.
+     *
+     * @public
+     */
+    async loadPreviousManifest() {
+        await this._manifest.load();
+    }
+    /**
+     * Adds a file to the manifest as a generated file.
+     * The path is resolved relative to the root directory.
+     *
+     * @public
+     * @param relativePath Path relative to the root directory
+     */
+    addGeneratedFile(relativePath) {
+        const fullPath = Path_1.Path.resolve(this._rootDir, relativePath);
+        this._manifest.add(fullPath);
+    }
+    /**
+     * Cleans up files that were generated in previous runs but not in the current run.
+     * This helps to remove stale files that are no longer needed.
+     *
+     * @public
+     */
+    async cleanup() {
+        await this._manifest.cleanup();
+    }
+    /**
+     * Saves the current manifest, which includes all files tracked in this run.
+     * This should be called after all file operations are complete.
+     *
+     * @public
+     */
+    async saveManifest() {
+        await this._manifest.save();
+    }
+    /**
+     * Writes a file to disk and tracks it in the manifest.
+     *
+     * @public
+     * @param relativePath Path relative to the root directory
+     * @param content File content
+     * @param options Optional write options
+     */
+    async writeFile(relativePath, content) {
+        const fullPath = Path_1.Path.resolve(this._rootDir, relativePath);
+        await this.ensureDirectoryExists(fullPath);
+        await File_1.File.writeAllTextAsync(fullPath, content);
+        this.addGeneratedFile(relativePath);
+    }
+    /**
+     * Executes a custom file-writing callback and tracks the file.
+     *
+     * @public
+     * @param relativePath Path relative to the root directory
+     * @param writer A callback that receives the absolute path to write content
+     */
+    async trackFile(relativePath, writer) {
+        const fullPath = Path_1.Path.resolve(this._rootDir, relativePath);
+        await this.ensureDirectoryExists(fullPath);
+        await writer(fullPath);
+        this.addGeneratedFile(relativePath);
+    }
+    /**
+     * Ensures that the directory for the given file path exists.
+     *
+     * @private
+     * @param fullFilePath The full path of the file to ensure its directory exists.
+     */
+    async ensureDirectoryExists(fullFilePath) {
+        const dir = Path_1.Path.getDirectoryName(fullFilePath);
+        if (!Directory_1.Directory.exists(dir)) {
+            await Directory_1.Directory.createAsync(dir);
+        }
+    }
+}
+exports.FileTracker = FileTracker;
+//# sourceMappingURL=FileTracker.js.map

package/IO/FileTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileTracker.js","sourceRoot":"","sources":["../../src/IO/FileTracker.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;AAElB,iDAA8C;AAE9C,iCAA8B;AAC9B,iCAA8B;AAC9B,2CAAwC;AAExC,aAAa;AAEb;;;;;GAKG;AACH,MAAa,WAAW;IAEpB,iBAAiB;IAEA,QAAQ,CAAS;IACjB,SAAS,CAAe;IAEzC,aAAa;IAEb,eAAe;IAEf;;;;;;OAMG;IACH,YAAmB,OAAe,EAAE,mBAA2B,mBAAmB;QAC9E,IAAI,CAAC,QAAQ,GAAG,WAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,SAAS,GAAG,IAAI,2BAAY,CAAC;YAC9B,YAAY,EAAE,WAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,gBAAgB,CAAC;SAC9D,CAAC,CAAC;IACP,CAAC;IAED,aAAa;IAEb,kBAAkB;IAElB;;;;;OAKG;IACI,KAAK,CAAC,oBAAoB;QAC7B,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,YAAoB;QACxC,MAAM,QAAQ,GAAG,WAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC3D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO;QAChB,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY;QACrB,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAChC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,OAAe;QACxD,MAAM,QAAQ,GAAG,WAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,WAAI,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChD,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,YAAoB,EAAE,MAA+C;QACxF,MAAM,QAAQ,GAAG,WAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvB,IAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;IACxC,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,qBAAqB,CAAC,YAAoB;QACpD,MAAM,GAAG,GAAG,WAAI,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC;QAEhD,IAAI,CAAC,qBAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,qBAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;CAIJ;AApHD,kCAoHC"}

package/IO/Interfaces/IDirectory.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Represents a directory utility interface that provides methods for directory operations.
+ *
+ * @public
+ */
+export interface IDirectory {
+    /**
+     * Creates all directories and subdirectories in the specified path unless they already exist.
+     * @param path The directory to create.
+     */
+    create(path: string): void;
+    /**
+     * Asynchronously creates all directories and subdirectories in the specified path unless they already exist.
+     * @param path The directory to create.
+     * @returns A promise that resolves when the directory is created.
+     */
+    createAsync(path: string): Promise<void>;
+    /**
+     * Deletes an empty directory from a specified path.
+     * @param path The name of the directory to remove.
+     */
+    delete(path: string): void;
+    /**
+     * Asynchronously deletes an empty directory from a specified path.
+     * @param path The name of the directory to remove.
+     * @returns A promise that resolves when the directory is deleted.
+     */
+    deleteAsync(path: string): Promise<void>;
+    /**
+     * Determines whether the given path refers to an existing directory on disk.
+     * @param path The path to test.
+     * @returns true if path refers to an existing directory; false if the directory does not exist or an error occurs.
+     */
+    exists(path: string): boolean;
+    /**
+     * Asynchronously determines whether the given path refers to an existing directory on disk.
+     * @param path The path to test.
+     * @returns A promise that resolves to true if the directory exists; otherwise, false.
+     */
+    existsAsync(path: string): Promise<boolean>;
+    /**
+     * Determines the total count of files and folders in the directory.
+     * @param path The directory path.
+     * @returns The number of files and folders.
+     */
+    count(path: string): number;
+    /**
+     * Asynchronously determines the total count of files and folders in the directory.
+     * @param path The directory path.
+     * @returns A promise that resolves to the number of files and folders.
+     */
+    countAsync(path: string): Promise<number>;
+    /**
+     * Gets the size of a directory.
+     * @param path The directory path.
+     * @returns The directory size in bytes.
+     */
+    size(path: string): number;
+    /**
+     * Asynchronously gets the size of a directory.
+     * @param path The directory path.
+     * @returns A promise that resolves to the directory size in bytes.
+     */
+    sizeAsync(path: string): Promise<number>;
+    /**
+     * Retrieves the parent directory of the specified path.
+     * @param path The path for which to retrieve the parent directory.
+     * @returns The parent directory path or null if not available.
+     */
+    getParent(path: string): string | null;
+    /**
+     * Asynchronously retrieves the parent directory of the specified path.
+     * @param path The path for which to retrieve the parent directory.
+     * @returns A promise that resolves to the parent directory path or null if not available.
+     */
+    getParentAsync(path: string): Promise<string | null>;
+    /**
+     * Lists all files in a directory recursively in a synchronous fashion.
+     * @param path The root directory path.
+     * @returns An iterable iterator of file paths.
+     */
+    walk(path: string): IterableIterator<string>;
+    /**
+     * Lists all files in a directory recursively in an asynchronous fashion.
+     * @param path The root directory path.
+     * @returns An async iterable iterator of file paths.
+     */
+    walkAsync(path: string): AsyncIterableIterator<string>;
+    /**
+     * Finds directories using glob patterns.
+     * @param pattern The globbing pattern(s).
+     * @returns An array of directory paths.
+     */
+    glob(pattern: string | Array<string>): Array<string>;
+    /**
+     * Asynchronously finds directories using glob patterns.
+     * @param pattern The globbing pattern(s).
+     * @returns A promise that resolves to an array of directory paths.
+     */
+    globAsync(pattern: string | Array<string>): Promise<Array<string>>;
+    /**
+     * Copies a directory to a new location.
+     * @param sourcePath The source directory path.
+     * @param targetPath The target directory path.
+     */
+    copy(sourcePath: string, targetPath: string): void;
+    /**
+     * Asynchronously copies a directory to a new location.
+     * @param sourcePath The source directory path.
+     * @param targetPath The target directory path.
+     * @returns A promise that resolves when the copy operation is complete.
+     */
+    copyAsync(sourcePath: string, targetPath: string): Promise<void>;
+}
+//# sourceMappingURL=IDirectory.d.ts.map

package/IO/Interfaces/IDirectory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDirectory.d.ts","sourceRoot":"","sources":["../../../src/IO/Interfaces/IDirectory.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,UAAU;IAIvB;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAE9B;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5C;;;;OAIG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAE5B;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1C;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEzC;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAEvC;;;;OAIG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAErD;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAE7C;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAEvD;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAErD;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAEnE;;;;OAIG;IACH,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnD;;;;;OAKG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAIpE"}

package/IO/Interfaces/IDirectory.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IDirectory.js.map

package/IO/Interfaces/IDirectory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDirectory.js","sourceRoot":"","sources":["../../../src/IO/Interfaces/IDirectory.ts"],"names":[],"mappings":""}

package/IO/Interfaces/IFile.d.ts

@@ -0,0 +1,152 @@
+import { Encoding } from '../Encoding';
+import { JSONObject } from '../Json';
+import { IResxEntry } from '../Resx';
+import { SymbolicLink } from '../SymbolicLink';
+/**
+ * Represents a file utility interface that provides methods for file operations.
+ *
+ * @public
+ */
+export interface IFile {
+    /**
+     * Determines whether the specified file exists.
+     * @param path The file to check.
+     * @returns `true` if the file exists; otherwise, `false`.
+     */
+    exists(path: string): boolean;
+    /**
+     * Copies an existing file to a new file.
+     * @param sourceFileName The file to copy.
+     * @param destFileName The destination file.
+     * @param overwrite If true, overwrite the destination file.
+     */
+    copy(sourceFileName: string, destFileName: string, overwrite?: boolean): void;
+    /**
+     * Reads all text from a file.
+     * @param path The file to read.
+     * @param encoding The encoding to use.
+     * @param validateCase If true, checks casing of the path.
+     * @returns The file content as string.
+     */
+    readAllText(path: string, encoding?: Encoding, validateCase?: boolean): string;
+    /**
+     * Asynchronously reads all text from a file.
+     * @param path The file to read.
+     * @param encoding The encoding to use.
+     * @param validateCase If true, checks casing of the path.
+     * @returns A promise with the file content as string.
+     */
+    readAllTextAsync(path: string, encoding?: Encoding, validateCase?: boolean): Promise<string>;
+    /**
+     * Reads all bytes from a file.
+     * @param path The file to read.
+     * @returns The content as Buffer.
+     */
+    readAllBytes(path: string): Buffer;
+    /**
+     * Asynchronously reads all bytes from a file.
+     * @param path The file to read.
+     * @returns A promise with the content as Buffer.
+     */
+    readAllBytesAsync(path: string): Promise<Buffer>;
+    /**
+     * Writes all text to a file, overwriting if it exists.
+     * @param path The file to write.
+     * @param contents The text to write.
+     * @param encoding The encoding to use.
+     * @param validateCase If true, checks casing of the path.
+     */
+    writeAllText(path: string, contents: string, encoding?: Encoding, validateCase?: boolean): void;
+    /**
+     * Asynchronously writes all text to a file, overwriting if it exists.
+     * @param path The file to write.
+     * @param contents The text to write.
+     * @param encoding The encoding to use.
+     * @param validateCase If true, checks casing of the path.
+     */
+    writeAllTextAsync(path: string, contents: string, encoding?: Encoding, validateCase?: boolean): Promise<void>;
+    /**
+     * Writes JSON data to a file.
+     * @param path The file to write.
+     * @param data The JSON data to write.
+     * @param encoding The encoding to use.
+     */
+    writeAllJson(path: string, data: unknown, encoding?: Encoding): void;
+    /**
+     * Asynchronously writes JSON data to a file.
+     * @param path The file to write.
+     * @param data The JSON data to write.
+     * @param encoding The encoding to use.
+     * @returns A promise that resolves when the write operation is complete.
+     */
+    writeAllJsonAsync(path: string, data: unknown, encoding?: Encoding): Promise<void>;
+    /**
+     * Deletes the specified file.
+     * @param path The file to delete.
+     */
+    delete(path: string): void;
+    /**
+     * Asynchronously deletes the specified file.
+     * @param path The file to delete.
+     */
+    deleteAsync(path: string): Promise<void>;
+    /**
+     * Moves a file to a new location.
+     * @param sourceFileName The source file.
+     * @param destFileName The destination file.
+     */
+    move(sourceFileName: string, destFileName: string): void;
+    /**
+     * Reads JSON data from a file.
+     * @param file The file to read.
+     * @returns The JSON object.
+     */
+    readAllJson(file: string): JSONObject;
+    /**
+     * Reads a RESX file and returns entries.
+     * @param file The resx file to read.
+     * @returns Array of RESX entries.
+     */
+    readAllResx(file: string): Array<IResxEntry>;
+    /**
+     * Reads and parses an XML file.
+     * @param file The xml file to read.
+     * @returns Parsed XML object.
+     */
+    readAllXml<T = unknown>(file: string): T;
+    /**
+     * Creates a hash from a file.
+     * @param file The file to hash.
+     * @param algorithm Hash algorithm.
+     * @param encoding Hash encoding.
+     * @returns A promise with hash as string or buffer.
+     */
+    hash(file: string, algorithm?: 'sha1' | 'md5', encoding?: 'hex' | 'binary'): Promise<string | Buffer>;
+    /**
+     * Finds files using glob patterns.
+     * @param pattern The glob pattern(s).
+     * @returns Array of file paths.
+     */
+    glob(pattern: string | Array<string>): Array<string>;
+    /**
+     * Extracts the locale from a file.
+     * @param file The file.
+     * @param defaultLocale The default locale.
+     * @returns The locale string.
+     */
+    getLocale(file: string, defaultLocale?: string): string;
+    /**
+     * Gets the size of a file.
+     * @param file The file.
+     * @returns The file size.
+     */
+    size(file: string): number;
+    /**
+     * Creates a symbolic link.
+     * @param src The source path.
+     * @param dest The destination path.
+     * @param symbolicLink The symbolic link type.
+     */
+    createSymbolicLink(src: string, dest: string, symbolicLink: SymbolicLink): void;
+}
+//# sourceMappingURL=IFile.d.ts.map

package/IO/Interfaces/IFile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFile.d.ts","sourceRoot":"","sources":["../../../src/IO/Interfaces/IFile.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAI/C;;;;GAIG;AACH,MAAM,WAAW,KAAK;IAIlB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAE9B;;;;;OAKG;IACH,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE9E;;;;;;OAMG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/E;;;;;;OAMG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7F;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAEnC;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjD;;;;;;OAMG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAEhG;;;;;;OAMG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9G;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAErE;;;;;;OAMG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnF;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;OAIG;IACH,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzD;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAC;IAEtC;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAE7C;;;;OAIG;IACH,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,CAAC,CAAC;IAEzC;;;;;;OAMG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IAEtG;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAErD;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAExD;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAE3B;;;;;OAKG;IACH,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;CAInF"}

package/IO/Interfaces/IFile.js

@@ -0,0 +1,4 @@
+"use strict";
+//#region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IFile.js.map

package/IO/Interfaces/IFile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFile.js","sourceRoot":"","sources":["../../../src/IO/Interfaces/IFile.ts"],"names":[],"mappings":";AAAA,iBAAiB"}

package/IO/Interfaces/IFileCache.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Interface for configuring the file cache.
+ *
+ * @public
+ */
+export interface IFileCacheOptions {
+    /**
+     * The directory path where cached files are stored.
+     */
+    dirPath: string;
+    /**
+     * Flag indicating whether caching is enabled.
+     */
+    enabled?: boolean;
+}
+/**
+ * Interface defining the operations of the file cache.
+ *
+ * @public
+ */
+export interface IFileCache {
+    /**
+     * Checks if a directory is cached.
+     *
+     * @public
+     * @param dirPath - The directory to check.
+     * @returns A promise resolving to `true` if the directory is cached, otherwise `false`.
+     */
+    isDirectoryCached(dirPath: string): Promise<boolean>;
+    /**
+     * Checks if a file is cached.
+     * If not and caching is enabled, the file will be cached.
+     *
+     * @public
+     * @param file - The file to check.
+     * @returns A promise resolving to `true` if the file is cached, otherwise `false`.
+     */
+    isFileCached(file: string): Promise<boolean>;
+    /**
+     * Gets the token of a file.
+     * The token is used to identify the file in the cache.
+     *
+     * @public
+     * @param file - The file for which to generate a token.
+     * @returns The token of the file.
+     */
+    getFileToken(file: string): string;
+    /**
+     * Deletes a file from the cache.
+     *
+     * @public
+     * @param token - The token of the file to delete.
+     */
+    deleteFile(token: string): void;
+}
+//# sourceMappingURL=IFileCache.d.ts.map

package/IO/Interfaces/IFileCache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileCache.d.ts","sourceRoot":"","sources":["../../../src/IO/Interfaces/IFileCache.ts"],"names":[],"mappings":"AACA;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAI9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CAIrB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAU;IAIvB;;;;;;OAMG;IACH,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErD;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7C;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAEnC;;;;;OAKG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CAInC"}

package/IO/Interfaces/IFileCache.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IFileCache.js.map

package/IO/Interfaces/IFileCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileCache.js","sourceRoot":"","sources":["../../../src/IO/Interfaces/IFileCache.ts"],"names":[],"mappings":""}

package/IO/Interfaces/IFileSystem.d.ts

@@ -0,0 +1,43 @@
+import { IFile } from './IFile';
+import { IDirectory } from './IDirectory';
+import { IPath } from './IPath';
+import { EventEmitter } from 'node:stream';
+/**
+ * Utility type to create unique method names by appending a suffix to each key of an interface.
+ *
+ * @private
+ */
+type UniqueMethods<T, Key extends string> = {
+    [K in keyof T as `${Lowercase<Key>}${Capitalize<string & K>}`]: T[K];
+};
+/**
+ * Represents the event map for file system events.
+ *
+ * @public
+ */
+export interface IFileSystemEventMap {
+    directoryCreated: [filePath: string];
+    directoryChanged: [filePath: string];
+    directoryDeleted: [filePath: string];
+    fileCreated: [filePath: string];
+    fileChanged: [filePath: string];
+    fileDeleted: [filePath: string];
+    error: [error: Error];
+}
+/**
+ * Represents a file system interface that provides methods for file, directory, and path operations.
+ *
+ * @public
+ */
+export interface IFileSystem extends UniqueMethods<IFile, 'File'>, UniqueMethods<IDirectory, 'Directory'>, UniqueMethods<IPath, 'Path'>, EventEmitter<IFileSystemEventMap> {
+    /**
+     * Checks if a file or directory exists and returns its type.
+     *
+     * @public
+     * @param filePath - The path to the file.
+     * @returns 'file' if it is a file, 'directory' if it is a directory, or 'unknown' if it does not exist or is neither.
+     */
+    isFileOrDirectory(inputPath: string): 'file' | 'directory' | 'unknown';
+}
+export {};
+//# sourceMappingURL=IFileSystem.d.ts.map

package/IO/Interfaces/IFileSystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileSystem.d.ts","sourceRoot":"","sources":["../../../src/IO/Interfaces/IFileSystem.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAI3C;;;;GAIG;AACH,KAAK,aAAa,CAAC,CAAC,EAAE,GAAG,SAAS,MAAM,IAAI;KACvC,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,SAAS,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;CACvE,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACrC,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChC,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChC,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAChC,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,WACb,SAAQ,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE,aAAa,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,mBAAmB,CAAC;IAI7I;;;;;;OAMG;IACH,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW,GAAG,SAAS,CAAC;CAI1E"}

package/IO/Interfaces/IFileSystem.js

@@ -0,0 +1,4 @@
+"use strict";
+//#region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IFileSystem.js.map

package/IO/Interfaces/IFileSystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileSystem.js","sourceRoot":"","sources":["../../../src/IO/Interfaces/IFileSystem.ts"],"names":[],"mappings":";AAAA,iBAAiB"}

package/IO/Interfaces/IFileTracker.d.ts

@@ -0,0 +1,15 @@
+import type { WriteFileOptions } from 'fs';
+/**
+ * Interface defining the contract for tracking generated files.
+ *
+ * @public
+ */
+export interface IFileTracker {
+    loadPreviousManifest(): Promise<void>;
+    addGeneratedFile(relativePath: string): void;
+    cleanup(): Promise<void>;
+    saveManifest(): Promise<void>;
+    writeFile(relativePath: string, content: string, options?: WriteFileOptions): Promise<void>;
+    trackFile(relativePath: string, writer: (absolutePath: string) => Promise<void>): Promise<void>;
+}
+//# sourceMappingURL=IFileTracker.d.ts.map

package/IO/Interfaces/IFileTracker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileTracker.d.ts","sourceRoot":"","sources":["../../../src/IO/Interfaces/IFileTracker.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,IAAI,CAAC;AAI3C;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACzB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5F,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnG"}

package/IO/Interfaces/IFileTracker.js

@@ -0,0 +1,4 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IFileTracker.js.map

package/IO/Interfaces/IFileTracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileTracker.js","sourceRoot":"","sources":["../../../src/IO/Interfaces/IFileTracker.ts"],"names":[],"mappings":";AAAA,kBAAkB"}