depflow 2.0.0-dev.1 → 2.0.0-dev.2

package/build/support/Dependency.d.ts

@@ -0,0 +1,127 @@
+import { ChildProcessWithoutNullStreams } from "child_process";
+import schemas from "../config/schemas.js";
+import Config from "../config/Config.js";
+export declare class Dependency implements Dependency.Dependency {
+    protected readonly config: Config.Config;
+    static include: string[];
+    readonly name: string;
+    readonly repo: Dependency.repo;
+    readonly branch?: string;
+    readonly builder: Dependency.Builder[];
+    readonly resolver: Dependency.Resolver[];
+    constructor(config: Config.Config, dependency: Dependency.Dependency);
+    /** Get the folder of the dependency */
+    get folder(): string;
+    /**
+     * Clones the dependency's repository to the local file system. If the target folder already exists, it checks the 'force' option: if 'force' is false, it performs a pull to update the existing repository; if 'force' is true, it uninstalls (deletes) the existing folder before cloning.
+     * This method ensures that the local copy of the dependency is up-to-date with the remote repository, allowing for both fresh installations and updates based on user preference.
+     * @param options An object containing options for managing the dependency, such as 'force' to determine whether to overwrite existing files.
+     * @returns A promise that resolves to a string message indicating the result of the clone or pull operation.
+     * @throws Will throw an error if the cloning or pulling process fails.
+     */
+    clone(options?: Dependency.manageOptions): Promise<string>;
+    /**
+     * Pulls the latest changes from the dependency's repository to the local file system. It uses the Git utility to perform a pull operation on the existing local repository, ensuring that it is updated with any new commits or changes from the remote repository. This method is essential for keeping the local copy of the dependency in sync with its source, allowing for seamless updates without needing to reinstall the entire dependency.
+     * @returns A promise that resolves to a string message indicating the result of the pull operation.
+     * @throws Will throw an error if the pull process fails, such as if the local repository is not properly set up or if there are conflicts that cannot be automatically resolved.
+     */
+    pull(): Promise<string>;
+    /**
+     * Installs the dependency by first cloning its repository (or pulling updates if it already exists) and then executing any build steps defined in the builder property. It manages the entire installation process, including handling the cloning/pulling of the repository and running any necessary commands to set up the dependency according to its configuration. This method ensures that the dependency is properly installed and ready for use, providing feedback on each step of the process through returned messages.
+     * @returns A promise that resolves to an array of string messages indicating the results of the cloning/pulling and building processes.
+     * @throws Will throw an error if any step of the installation process fails, such as issues with cloning, pulling, or executing build commands.
+     */
+    install(): Promise<string[]>;
+    /**
+     * Uninstalls the dependency by removing its local folder and any additional folders specified in the builder's move steps.
+     * It checks for the existence of each folder before attempting to remove it, ensuring that it only tries to delete valid paths.
+     * This method is crucial for cleanly removing a dependency from the local file system, allowing for a complete uninstallation that includes all related files and directories as defined by the dependency's configuration.
+     * @return A promise that resolves to an array of string messages indicating the results of the uninstallation process, such as which folders were removed.
+     * @throws Will throw an error if any issues occur during the uninstallation process, such as problems with file system access or if the specified folders cannot be removed.
+     */
+    uninstall(): Promise<string[]>;
+    /**
+     * Builds the dependency by executing the commands specified in the builder property.
+     * It iterates through each build step, running any defined commands and handling file movements as necessary.
+     * The method uses a child process to execute shell commands, capturing the output and errors for each step.
+     * This allows for a flexible build process that can accommodate various setup requirements defined by the dependency's configuration, ensuring that the dependency is properly built and ready for use after installation.
+     * @return A promise that resolves to an array of string messages indicating the results of the build process, including any command outputs and file movements.
+     * @throws Will throw an error if any issues occur during the build process, such as command execution failures or problems with file movements.
+     */
+    protected build(): Promise<string[]>;
+    /**
+     * Handles the file movements defined in the builder's move steps.
+     * It supports various formats for specifying destinations, including strings, arrays, and objects with keys representing source paths.
+     * The method checks for the existence of source files or directories before attempting to move them to the specified destinations, ensuring that it only operates on valid paths.
+     * This function is essential for managing the organization of files after building a dependency, allowing for flexible configurations that can accommodate different project structures and requirements.
+     * @param move The move configuration from the builder, which can be a string, an array of strings, or an object mapping source paths to destination paths.
+     * @returns A promise that resolves to an array of string messages indicating the results of the file movements, including any errors encountered during the process.
+     * @throws Will throw an error if any issues occur during the file movement process, such as missing source paths or problems with file system access.
+     */
+    protected move(move: Dependency.Builder['move']): Promise<string[]>;
+    /**
+     * Executes a series of shell commands in a child process, capturing the output and errors for each command.
+     * It writes each command to the child process's stdin and listens for output on stdout and stderr.
+     * The method uses a marker to determine when a command has finished executing, allowing it to capture the complete output for each command before proceeding to the next one.
+     * This function is crucial for running build commands defined in the dependency's configuration, providing feedback on the execution of each command and handling any errors that may arise during the process.
+     * @param commands An array of shell commands to execute.
+     * @param shell The child process in which to execute the commands.
+     * @returns A promise that resolves to an array of string messages indicating the results of the command executions, including any output or errors captured during the process.
+     * @throws Will throw an error if any command fails to execute properly, providing details about the failed command and the associated error message.
+     */
+    protected executeCommands(commands: string[], shell: ChildProcessWithoutNullStreams): Promise<string[]>;
+    /**
+     * Executes a single shell command in the provided child process, capturing its output and handling errors.
+     * It writes the command to the child process's stdin and listens for output on stdout and stderr.
+     * The method uses a unique marker to determine when the command has finished executing, allowing it to capture the complete output before resolving.
+     * If an error occurs during execution, it captures the error message and rejects the promise with a descriptive error.
+     * This function is essential for running individual build commands as part of the dependency installation process, providing detailed feedback on the execution of each command and ensuring that any issues are properly handled and reported.
+     * @param shell The child process in which to execute the command.
+     * @param command The shell command to execute.
+     * @returns A promise that resolves to an array of string messages indicating the result of the command execution, including any output captured during the process.
+     * @throws Will throw an error if the command fails to execute properly, providing details about the failed command and the associated error message.
+     */
+    protected executeCommand(shell: ChildProcessWithoutNullStreams, command: string): Promise<string[]>;
+    /**
+     * Handles the file movements for a specific source and destination.
+     * It checks for the existence of the source path and creates the destination folder if it does not exist.
+     * The method uses fs.cp to copy files or directories from the source to the destination, supporting recursive copying for directories.
+     * It captures any errors that occur during the process and provides descriptive error messages to help identify issues with file movements.
+     * This function is crucial for managing the organization of files after building a dependency, allowing for flexible configurations that can accommodate different project structures and requirements.
+     * @param destination The target path(s) where the source should be moved to.
+     * @param source An optional specific source path within the dependency folder to move, defaulting to the entire folder if not provided.
+     * @returns A promise that resolves to an array of string messages indicating the results of the file movements, including any errors encountered during the process.
+     * @throws Will throw an error if any issues occur during the file movement process, such as missing source paths or problems with file system access.
+     */
+    protected moveFiles(destination: string | string[], source?: string): Promise<string[]>;
+    /**
+     * Constructs the source path for file movements based on the dependency's folder and an optional specific source path.
+     * If a specific source is provided, it concatenates it with the dependency's folder; otherwise, it returns the dependency's folder as the source path.
+     * The method also ensures that any trailing slashes are removed from the folder and that any leading slashes are removed from the source to create a valid path for file operations.
+     * This function is essential for determining the correct source path when moving files as part of the build process, allowing for flexible configurations that can specify either the entire dependency folder or specific subpaths within it.
+     * @param folder The base folder of the dependency.
+     * @param source An optional specific source path within the dependency folder to use for file movements.
+     * @returns A string representing the constructed source path for file operations.
+     */
+    static getSourcePath(folder: string, source?: string): string;
+    /**
+     * Recursively extracts all destination folders from the builder's move configuration, supporting various formats such as strings, arrays, and nested objects.
+     * It traverses the move configuration, collecting all destination paths into a single array, which can then be used for file operations during the build process.
+     * This method is crucial for managing the organization of files after building a dependency, allowing for flexible configurations that can accommodate different project structures and requirements.
+     * @param builder The move configuration from the builder, which can be a string, an array of strings, or an object mapping source paths to destination paths.
+     * @returns An array of strings representing all destination folders extracted from the move configuration.
+     */
+    static getAllOutFolders(builder: Dependency.Builder['move']): string[];
+}
+export declare namespace Dependency {
+    type logCallback = (messages: string[]) => void;
+    type repo = `https://github.com/${string}/${string}.git` | `git@github.com:${string}/${string}.git`;
+    type Builder = schemas.builder['infer'];
+    type Resolver = schemas.pathResolverEntry['infer'];
+    type Dependency = schemas.dependency['infer'];
+    type newDependency = schemas.dependency['inferToProcess'];
+    interface manageOptions {
+        force?: boolean;
+    }
+}
+export default Dependency;

package/build/support/Dependency.js

@@ -0,0 +1,307 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>
+ * @description Dependency utility.
+ * @license Apache-2.0
+ */
+import { promises as FS } from "fs";
+import { spawn } from "child_process";
+import { File, Path } from '@netfeez/common-node';
+import Git from "./Git.js";
+import Validator from "./Validator.js";
+export class Dependency {
+    config;
+    static include = ['*'];
+    name;
+    repo;
+    branch;
+    builder;
+    resolver;
+    constructor(config, dependency) {
+        this.config = config;
+        Validator.validateRepo(dependency.repo);
+        this.name = dependency.name;
+        this.repo = dependency.repo;
+        this.branch = dependency.branch;
+        this.builder = dependency.builder;
+        this.resolver = dependency.resolver;
+    }
+    /** Get the folder of the dependency */
+    get folder() {
+        let path = Path.join(this.config.flowFolder, this.name);
+        path = Path.normalize(path);
+        return path;
+    }
+    /**
+     * Clones the dependency's repository to the local file system. If the target folder already exists, it checks the 'force' option: if 'force' is false, it performs a pull to update the existing repository; if 'force' is true, it uninstalls (deletes) the existing folder before cloning.
+     * This method ensures that the local copy of the dependency is up-to-date with the remote repository, allowing for both fresh installations and updates based on user preference.
+     * @param options An object containing options for managing the dependency, such as 'force' to determine whether to overwrite existing files.
+     * @returns A promise that resolves to a string message indicating the result of the clone or pull operation.
+     * @throws Will throw an error if the cloning or pulling process fails.
+     */
+    async clone(options = {}) {
+        if (await File.exists(this.folder)) {
+            if (!options.force)
+                return await this.pull();
+            else
+                await this.uninstall();
+        }
+        return await Git.clone(this.repo, this.folder, this.branch);
+    }
+    /**
+     * Pulls the latest changes from the dependency's repository to the local file system. It uses the Git utility to perform a pull operation on the existing local repository, ensuring that it is updated with any new commits or changes from the remote repository. This method is essential for keeping the local copy of the dependency in sync with its source, allowing for seamless updates without needing to reinstall the entire dependency.
+     * @returns A promise that resolves to a string message indicating the result of the pull operation.
+     * @throws Will throw an error if the pull process fails, such as if the local repository is not properly set up or if there are conflicts that cannot be automatically resolved.
+     */
+    async pull() {
+        return await Git.pull(this.folder, this.branch);
+    }
+    /**
+     * Installs the dependency by first cloning its repository (or pulling updates if it already exists) and then executing any build steps defined in the builder property. It manages the entire installation process, including handling the cloning/pulling of the repository and running any necessary commands to set up the dependency according to its configuration. This method ensures that the dependency is properly installed and ready for use, providing feedback on each step of the process through returned messages.
+     * @returns A promise that resolves to an array of string messages indicating the results of the cloning/pulling and building processes.
+     * @throws Will throw an error if any step of the installation process fails, such as issues with cloning, pulling, or executing build commands.
+     */
+    async install() {
+        const output = [];
+        try {
+            const cloneResult = await this.clone();
+            output.push(cloneResult);
+            const buildResult = await this.build();
+            output.push(...buildResult);
+            return output;
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Uninstalls the dependency by removing its local folder and any additional folders specified in the builder's move steps.
+     * It checks for the existence of each folder before attempting to remove it, ensuring that it only tries to delete valid paths.
+     * This method is crucial for cleanly removing a dependency from the local file system, allowing for a complete uninstallation that includes all related files and directories as defined by the dependency's configuration.
+     * @return A promise that resolves to an array of string messages indicating the results of the uninstallation process, such as which folders were removed.
+     * @throws Will throw an error if any issues occur during the uninstallation process, such as problems with file system access or if the specified folders cannot be removed.
+     */
+    async uninstall() {
+        try {
+            const output = [];
+            const moves = this.builder
+                ? this.builder
+                    .map(step => step.move ? Dependency.getAllOutFolders(step.move) : [])
+                    .reduce((acc, val) => acc.concat(val), [])
+                : [];
+            const folders = [this.folder, ...moves];
+            for (const folder of folders) {
+                if (!await File.exists(folder))
+                    continue;
+                output.push(`Removing &C4${folder}`);
+                await FS.rm(folder, { recursive: true });
+            }
+            return output;
+        }
+        catch (error) {
+            throw error;
+        }
+    }
+    /**
+     * Builds the dependency by executing the commands specified in the builder property.
+     * It iterates through each build step, running any defined commands and handling file movements as necessary.
+     * The method uses a child process to execute shell commands, capturing the output and errors for each step.
+     * This allows for a flexible build process that can accommodate various setup requirements defined by the dependency's configuration, ensuring that the dependency is properly built and ready for use after installation.
+     * @return A promise that resolves to an array of string messages indicating the results of the build process, including any command outputs and file movements.
+     * @throws Will throw an error if any issues occur during the build process, such as command execution failures or problems with file movements.
+     */
+    async build() {
+        const output = [];
+        if (!this.builder || this.builder.length === 0)
+            return output;
+        const shell = spawn('/bin/bash', [], {
+            stdio: ['pipe', 'pipe', 'pipe']
+        });
+        try {
+            for (const step of this.builder) {
+                if (step.run) {
+                    const run = typeof step.run === 'string' ? [step.run] : step.run;
+                    const commands = [`cd ${this.folder}`, ...run];
+                    const results = await this.executeCommands(commands, shell);
+                    output.push(...results);
+                }
+                if (step.move) {
+                    const moveResults = await this.move(step.move);
+                    output.push(...moveResults);
+                }
+            }
+        }
+        catch (error) {
+            throw error;
+        }
+        finally {
+            shell.kill();
+        }
+        return output;
+    }
+    /**
+     * Handles the file movements defined in the builder's move steps.
+     * It supports various formats for specifying destinations, including strings, arrays, and objects with keys representing source paths.
+     * The method checks for the existence of source files or directories before attempting to move them to the specified destinations, ensuring that it only operates on valid paths.
+     * This function is essential for managing the organization of files after building a dependency, allowing for flexible configurations that can accommodate different project structures and requirements.
+     * @param move The move configuration from the builder, which can be a string, an array of strings, or an object mapping source paths to destination paths.
+     * @returns A promise that resolves to an array of string messages indicating the results of the file movements, including any errors encountered during the process.
+     * @throws Will throw an error if any issues occur during the file movement process, such as missing source paths or problems with file system access.
+     */
+    async move(move) {
+        if (!move)
+            return [];
+        const output = [];
+        if (typeof move === 'string' || Array.isArray(move)) {
+            const moves = Array.isArray(move) ? move : [move];
+            for (const destination of moves) {
+                const moveResult = await this.moveFiles(destination);
+                output.push(...moveResult);
+            }
+        }
+        else {
+            for (const key in move) {
+                const value = move[key];
+                const destinations = typeof value === 'string' ? [value] : value;
+                for (const destination of destinations) {
+                    const moveResult = await this.moveFiles(destination, key);
+                    output.push(...moveResult);
+                }
+            }
+        }
+        return output;
+    }
+    /**
+     * Executes a series of shell commands in a child process, capturing the output and errors for each command.
+     * It writes each command to the child process's stdin and listens for output on stdout and stderr.
+     * The method uses a marker to determine when a command has finished executing, allowing it to capture the complete output for each command before proceeding to the next one.
+     * This function is crucial for running build commands defined in the dependency's configuration, providing feedback on the execution of each command and handling any errors that may arise during the process.
+     * @param commands An array of shell commands to execute.
+     * @param shell The child process in which to execute the commands.
+     * @returns A promise that resolves to an array of string messages indicating the results of the command executions, including any output or errors captured during the process.
+     * @throws Will throw an error if any command fails to execute properly, providing details about the failed command and the associated error message.
+     */
+    async executeCommands(commands, shell) {
+        const output = [];
+        shell.stderr.on('data', data => output.push(data.toString()));
+        for (const command of commands) {
+            const result = await this.executeCommand(shell, command);
+            output.push(...result);
+        }
+        shell.kill();
+        return output;
+    }
+    /**
+     * Executes a single shell command in the provided child process, capturing its output and handling errors.
+     * It writes the command to the child process's stdin and listens for output on stdout and stderr.
+     * The method uses a unique marker to determine when the command has finished executing, allowing it to capture the complete output before resolving.
+     * If an error occurs during execution, it captures the error message and rejects the promise with a descriptive error.
+     * This function is essential for running individual build commands as part of the dependency installation process, providing detailed feedback on the execution of each command and ensuring that any issues are properly handled and reported.
+     * @param shell The child process in which to execute the command.
+     * @param command The shell command to execute.
+     * @returns A promise that resolves to an array of string messages indicating the result of the command execution, including any output captured during the process.
+     * @throws Will throw an error if the command fails to execute properly, providing details about the failed command and the associated error message.
+     */
+    async executeCommand(shell, command) {
+        const output = [];
+        output.push(`&RRunning command &C4${command}`);
+        await new Promise((resolve, reject) => {
+            shell.stdin.write(command + '\n');
+            const marker = `__END_${Date.now()}__`;
+            shell.stdin.write(`echo ${marker}\n`);
+            let out = '';
+            const listener = (data) => {
+                if (data.toString().includes(marker)) {
+                    shell.stdout.off('data', listener);
+                    output.push(out.trim());
+                    resolve();
+                }
+                else
+                    out += data.toString().trim();
+            };
+            shell.stdout.on('data', listener);
+            shell.stderr.once('data', data => {
+                shell.stdout.off('data', listener);
+                output.push(data.toString().trim());
+                reject(new Error(`Command "${command}" failed with error: ${data.toString().trim()}`));
+            });
+        });
+        return output;
+    }
+    /**
+     * Handles the file movements for a specific source and destination.
+     * It checks for the existence of the source path and creates the destination folder if it does not exist.
+     * The method uses fs.cp to copy files or directories from the source to the destination, supporting recursive copying for directories.
+     * It captures any errors that occur during the process and provides descriptive error messages to help identify issues with file movements.
+     * This function is crucial for managing the organization of files after building a dependency, allowing for flexible configurations that can accommodate different project structures and requirements.
+     * @param destination The target path(s) where the source should be moved to.
+     * @param source An optional specific source path within the dependency folder to move, defaulting to the entire folder if not provided.
+     * @returns A promise that resolves to an array of string messages indicating the results of the file movements, including any errors encountered during the process.
+     * @throws Will throw an error if any issues occur during the file movement process, such as missing source paths or problems with file system access.
+     */
+    async moveFiles(destination, source) {
+        const output = [];
+        destination = Array.isArray(destination) ? destination : [destination];
+        source = Dependency.getSourcePath(this.folder, source);
+        for (const folder of destination) {
+            try {
+                if (!await File.exists(source))
+                    throw new Error(`Source path ${source} does not exist.`);
+                if (!await File.exists(folder)) {
+                    if (!await File.isFile(source))
+                        await FS.mkdir(folder, { recursive: true });
+                    else {
+                        const toCreate = folder.slice(0, folder.lastIndexOf('/'));
+                        if (!await File.exists(toCreate))
+                            await FS.mkdir(toCreate, { recursive: true });
+                    }
+                }
+                output.push(`&RMoving source &C4${source} &Rto &C4${folder}`);
+                await FS.cp(source, folder, { recursive: true, force: true });
+            }
+            catch (error) {
+                throw new Error(`Failed to move files from ${this.name} to ${folder}, \n${error}`);
+            }
+        }
+        return output;
+    }
+    /**
+     * Constructs the source path for file movements based on the dependency's folder and an optional specific source path.
+     * If a specific source is provided, it concatenates it with the dependency's folder; otherwise, it returns the dependency's folder as the source path.
+     * The method also ensures that any trailing slashes are removed from the folder and that any leading slashes are removed from the source to create a valid path for file operations.
+     * This function is essential for determining the correct source path when moving files as part of the build process, allowing for flexible configurations that can specify either the entire dependency folder or specific subpaths within it.
+     * @param folder The base folder of the dependency.
+     * @param source An optional specific source path within the dependency folder to use for file movements.
+     * @returns A string representing the constructed source path for file operations.
+     */
+    static getSourcePath(folder, source) {
+        folder = folder.endsWith('/') ? folder.slice(0, -1) : folder;
+        if (!source)
+            return folder;
+        source = source.startsWith('/') ? source.slice(1) : source;
+        return `${folder}/${source}`.replace(/ /g, '\\ ');
+    }
+    /**
+     * Recursively extracts all destination folders from the builder's move configuration, supporting various formats such as strings, arrays, and nested objects.
+     * It traverses the move configuration, collecting all destination paths into a single array, which can then be used for file operations during the build process.
+     * This method is crucial for managing the organization of files after building a dependency, allowing for flexible configurations that can accommodate different project structures and requirements.
+     * @param builder The move configuration from the builder, which can be a string, an array of strings, or an object mapping source paths to destination paths.
+     * @returns An array of strings representing all destination folders extracted from the move configuration.
+     */
+    static getAllOutFolders(builder) {
+        if (!builder)
+            return [];
+        const folders = [];
+        if (typeof builder === 'string')
+            folders.push(builder);
+        else if (Array.isArray(builder))
+            folders.push(...builder);
+        else
+            for (const key in builder) {
+                const out = this.getAllOutFolders(builder[key]);
+                folders.push(...out);
+            }
+        return folders;
+    }
+}
+export default Dependency;
+//# sourceMappingURL=Dependency.js.map

package/build/support/Dependency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Dependency.js","sourceRoot":"","sources":["../../src/support/Dependency.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,EAAkC,KAAK,EAAE,MAAM,eAAe,CAAC;AAEtE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAGlD,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAGvC,MAAM,OAAO,UAAU;IASI;IARhB,MAAM,CAAC,OAAO,GAAa,CAAE,GAAG,CAAE,CAAC;IAC1B,IAAI,CAAS;IACb,IAAI,CAAkB;IACtB,MAAM,CAAU;IAChB,OAAO,CAAuB;IAC9B,QAAQ,CAAwB;IAEhD,YACuB,MAAqB,EACxC,UAAiC;QADd,WAAM,GAAN,MAAM,CAAe;QAGxC,SAAS,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;IACxC,CAAC;IACD,uCAAuC;IACvC,IAAW,MAAM;QACb,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACxD,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IAChB,CAAC;IACD;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CAAC,UAAoC,EAAE;QACrD,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,IAAI,CAAC,OAAO,CAAC,KAAK;gBAAE,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;;gBACxC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAChC,CAAC;QACD,OAAO,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;IACD;;;;OAIG;IACI,KAAK,CAAC,IAAI;QACb,OAAO,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IACD;;;;OAIG;IACI,KAAK,CAAC,OAAO;QAChB,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,CAAC;YACD,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACzB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;YAC5B,OAAO,MAAM,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAAC,MAAM,KAAK,CAAC;QAAC,CAAC;IACpC,CAAC;IACD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS;QAClB,IAAI,CAAC;YACD,MAAM,MAAM,GAAa,EAAE,CAAC;YAE5B,MAAM,KAAK,GAAa,IAAI,CAAC,OAAO;gBAChC,CAAC,CAAC,IAAI,CAAC,OAAO;qBACT,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;qBACpE,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBAC9C,CAAC,CAAC,EAAE,CAAC;YAET,MAAM,OAAO,GAAa,CAAE,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAE,CAAC;YAEpD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC3B,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;oBAAE,SAAS;gBACzC,MAAM,CAAC,IAAI,CAAC,eAAe,MAAM,EAAE,CAAC,CAAC;gBACrC,MAAM,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC7C,CAAC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAAC,MAAM,KAAK,CAAC;QAAC,CAAC;IACpC,CAAC;IACD;;;;;;;OAOG;IACO,KAAK,CAAC,KAAK;QACjB,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,MAAM,CAAC;QAE9D,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,EAAE,EAAE;YACjC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;SAClC,CAAC,CAAC;QACH,IAAI,CAAC;YAAC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACpC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;oBACX,MAAM,GAAG,GAAG,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAE,IAAI,CAAC,GAAG,CAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;oBACnE,MAAM,QAAQ,GAAG,CAAE,MAAM,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,GAAG,CAAE,CAAC;oBACjD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;oBAC5D,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;gBAC5B,CAAC;gBACD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACZ,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC/C,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;gBAChC,CAAC;YACL,CAAC;QAAC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAAC,MAAM,KAAK,CAAC;QAAC,CAAC;gBAC1B,CAAC;YAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QAAC,CAAC;QACzB,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;;;;OAQG;IACO,KAAK,CAAC,IAAI,CAAC,IAAgC;QACjD,IAAI,CAAC,IAAI;YAAE,OAAO,EAAE,CAAC;QACrB,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAClD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAE,IAAI,CAAE,CAAC;YACpD,KAAK,MAAM,WAAW,IAAI,KAAK,EAAE,CAAC;gBAC9B,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACrD,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;YAC/B,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;gBACxB,MAAM,YAAY,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAE,KAAK,CAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gBACnE,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;oBACrC,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;oBAC1D,MAAM,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAC;gBAC/B,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;;;;;OASG;IACO,KAAK,CAAC,eAAe,CAAC,QAAkB,EAAE,KAAqC;QACrF,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC9D,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACzD,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAC3B,CAAC;QACD,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;;;;;;OAUG;IACO,KAAK,CAAC,cAAc,CAAC,KAAqC,EAAE,OAAe;QACjF,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,wBAAwB,OAAO,EAAE,CAAC,CAAC;QAC/C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACxC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;YAElC,MAAM,MAAM,GAAG,SAAS,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC;YACvC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,MAAM,IAAI,CAAC,CAAC;YAEtC,IAAI,GAAG,GAAW,EAAE,CAAC;YAErB,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE;gBAC9B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;oBACnC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;oBACnC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;oBACxB,OAAO,EAAE,CAAC;gBACd,CAAC;;oBAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAA;YACxC,CAAC,CAAC;YACF,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAClC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC7B,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;gBACnC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;gBACpC,MAAM,CAAC,IAAI,KAAK,CAAC,YAAY,OAAO,wBAAwB,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;YAC3F,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;;;;;;OAUG;IACO,KAAK,CAAC,SAAS,CAAC,WAA8B,EAAE,MAAe;QACrE,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAE,WAAW,CAAE,CAAC;QACzE,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACvD,KAAK,MAAM,MAAM,IAAI,WAAW,EAAE,CAAC;YAC/B,IAAI,CAAC;gBACD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,eAAe,MAAM,kBAAkB,CAAC,CAAC;gBACzF,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC7B,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;wBAAE,MAAM,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;yBACvE,CAAC;wBACF,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;wBAC1D,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;4BAAE,MAAM,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;oBACpF,CAAC;gBACL,CAAC;gBACD,MAAM,CAAC,IAAI,CAAC,sBAAsB,MAAM,YAAY,MAAM,EAAE,CAAC,CAAC;gBAC9D,MAAM,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAClE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAAC,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,IAAI,OAAO,MAAM,OAAO,KAAK,EAAE,CAAC,CAAC;YAAC,CAAC;QAC3G,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,aAAa,CAAC,MAAc,EAAE,MAAe;QACvD,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAC7D,IAAI,CAAC,MAAM;YAAE,OAAO,MAAM,CAAC;QAC3B,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAC3D,OAAO,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,gBAAgB,CAAC,OAAmC;QAC9D,IAAI,CAAC,OAAO;YAAE,OAAO,EAAE,CAAC;QACxB,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAClD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;;YACrD,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;gBAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;gBAChD,OAAO,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;YACzB,CAAC;QAAC,OAAO,OAAO,CAAC;IACrB,CAAC;;AAaL,eAAe,UAAU,CAAC"}

package/build/support/File.d.ts

@@ -0,0 +1,80 @@
+export declare class File {
+    /**
+     * Checks if a given path exists in the file system.
+     * It uses fs.access to determine if the path is accessible, returning true if it exists and false if it does not.
+     * This method is useful for verifying the presence of files or directories before attempting to read, write, or perform other operations on them, helping to prevent errors related to non-existent paths.
+     * @param path The file system path to check for existence.
+     * @returns A promise that resolves to true if the path exists, or false if it does not.
+     */
+    static exists(path: string): Promise<boolean>;
+    /**
+     * Checks if the given path is a file.
+     * It uses fs.stat to retrieve the file system statistics for the path and checks if it is a file using the isFile method.
+     * If the path does not exist or is not a file, it returns false.
+     * This method is useful for validating that a specific path points to a file before performing operations that require a file, such as reading or writing content.
+     * It helps to ensure that the expected file structure is in place and can prevent errors related to invalid paths or types.
+     * @param path The file system path to check.
+     * @returns A promise that resolves to true if the path is a file, or false if it is not.
+     * @throws Will throw an error if the path does not exist or is not a file.
+     */
+    static isFile(path: string): Promise<boolean>;
+    /**
+     * Checks if the given path is a directory.
+     * It uses fs.stat to retrieve the file system statistics for the path and checks if it is a directory using the isDirectory method.
+     * If the path does not exist or is not a directory, it returns false.
+     * This method is useful for validating that a specific path points to a directory before performing operations that require a directory, such as creating files within it or listing its contents.
+     * It helps to ensure that the expected directory structure is in place and can prevent errors related to invalid paths or types.
+     * @param path The file system path to check.
+     * @returns A promise that resolves to true if the path is a directory, or false if it is not.
+     * @throws Will throw an error if the path does not exist or is not a directory.
+     */
+    static isDirectory(path: string): Promise<boolean>;
+    /**
+     * Reads the content of a file at the specified path using the given encoding (defaulting to 'utf-8').
+     * It first checks if the path is a file using the isFile method, and if it is not, it throws an error indicating that the path is not a file.
+     * If the path is valid, it uses fs.readFile to read the content of the file and returns it as a string.
+     * This method is essential for safely reading files while ensuring that the provided path points to a valid file, preventing errors related to invalid paths or types.
+     * @param path The file system path of the file to read.
+     * @param encoding The character encoding to use when reading the file (default is 'utf-8').
+     * @returns A promise that resolves to the content of the file as a string.
+     * @throws Will throw an error if the path does not point to a valid file.
+     */
+    static read(path: string, encoding?: BufferEncoding): Promise<string>;
+    /**
+     * Writes the specified content to a file at the given path using the provided encoding (defaulting to 'utf-8').
+     * It uses fs.writeFile to write the content to the file, creating the file if it does not exist or overwriting it if it does.
+     * This method is crucial for saving data to files while ensuring that the content is properly encoded and that any necessary directories are in place before writing.
+     * It can be used for a variety of purposes, such as saving configuration files, logs, or any other data that needs to be persisted in the file system.
+     * @param path The file system path where the content should be written.
+     * @param content The string content to write to the file.
+     * @param encoding The character encoding to use when writing the file (default is 'utf-8').
+     * @returns A promise that resolves when the write operation is complete.
+     */
+    static write(path: string, content: string, encoding?: BufferEncoding): Promise<void>;
+    /**
+     * Creates a directory at the specified path with the given options (such as recursive creation). It first checks if the path already exists using the exists method, and if it does, it throws an error to prevent overwriting existing files or directories. If the path does not exist, it uses fs.mkdir to create the directory according to the provided options. This method is essential for safely creating directories while ensuring that existing paths are not unintentionally overwritten, and it can be used to set up necessary directory structures for applications or projects.
+     * @param path The file system path where the directory should be created.
+     * @param options Optional settings for directory creation, such as { recursive: true } to create parent directories if they do not exist.
+     * @returns A promise that resolves when the directory has been successfully created.
+     * @throws Will throw an error if the path already exists or if there is an issue during directory creation.
+     */
+    static mkdir(path: string, options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    /**
+     * Recursively retrieves all files with specified extensions from a given directory.
+     * It uses fs.readdir with the "withFileTypes" option to efficiently determine if an entry is a file or a directory.
+     * For directories, it calls itself recursively to gather files from subdirectories. For files, it checks if their extensions match the provided list and includes them in the result.
+     * This method returns a flat array of file paths that can be processed by the path resolver.
+     * @param dir The directory to scan for files.
+     * @param extensions An array of file extensions to filter the results (e.g., ['.js', '.ts']).
+     * @returns A promise that resolves to an array of file paths matching the specified extensions.
+     */
+    static getAllFiles(dir: string, extensions: string[]): Promise<string[]>;
+}
+export declare namespace File {
+    interface ReadDirOptions {
+        withFileTypes?: boolean;
+    }
+}
+export default File;