@decaf-ts/utils 1.1.0 → 1.2.0

package/lib/types/utils/constants.d.mts

@@ -0,0 +1,65 @@
+/**
+ * @description Default encoding for text operations.
+ * @summary The standard UTF-8 encoding used for text processing.
+ * @const {string} Encoding
+ * @memberOf module:utils
+ */
+export declare const Encoding = "utf-8";
+/**
+ * @description Regular expression for semantic versioning.
+ * @summary A regex pattern to match and parse semantic version strings.
+ * @const {RegExp} SemVersionRegex
+ * @memberOf module:utils
+ */
+export declare const SemVersionRegex: RegExp;
+/**
+ * @description Enum for semantic version components.
+ * @summary Defines the three levels of semantic versioning: PATCH, MINOR, and MAJOR.
+ * @enum {string}
+ * @memberOf module:utils
+ */
+export declare enum SemVersion {
+    /** Patch version for backwards-compatible bug fixes. */
+    PATCH = "patch",
+    /** Minor version for backwards-compatible new features. */
+    MINOR = "minor",
+    /** Major version for changes that break backwards compatibility. */
+    MAJOR = "major"
+}
+/**
+ * @description Flag to indicate non-CI environment.
+ * @summary Used to specify that a command should run outside of a Continuous Integration environment.
+ * @const {string} NoCIFLag
+ * @memberOf module:utils
+ */
+export declare const NoCIFLag = "-no-ci";
+/**
+ * @description Key for the setup script in package.json.
+ * @summary Identifies the script that runs after package installation.
+ * @const {string} SetupScriptKey
+ * @memberOf module:utils
+ */
+export declare const SetupScriptKey = "postinstall";
+/**
+ * @description Enum for various authentication tokens.
+ * @summary Defines the file names for storing different types of authentication tokens.
+ * @enum {string}
+ * @memberOf module:utils
+ */
+export declare enum Tokens {
+    /** Git authentication token file name. */
+    GIT = ".token",
+    /** NPM authentication token file name. */
+    NPM = ".npmtoken",
+    /** Docker authentication token file name. */
+    DOCKER = ".dockertoken",
+    /** Confluence authentication token file name. */
+    CONFLUENCE = ".confluence-token"
+}
+/**
+ * @description Code used to indicate an operation was aborted.
+ * @summary Standard message used when a process is manually terminated.
+ * @const {string} AbortCode
+ * @memberOf module:utils
+ */
+export declare const AbortCode = "Aborted";

package/lib/types/utils/fs.d.cts

@@ -0,0 +1,259 @@
+import fs from "fs";
+import { DependencyMap, SimpleDependencyMap } from "./types.cjs";
+/**
+ * @description Patches a file with given values.
+ * @summary Reads a file, applies patches using TextUtils, and writes the result back to the file.
+ *
+ * @param {string} path - The path to the file to be patched.
+ * @param {Record<string, number | string>} values - The values to patch into the file.
+ * @return {void}
+ *
+ * @function patchFile
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant patchFile
+ *   participant fs
+ *   participant readFile
+ *   participant TextUtils
+ *   participant writeFile
+ *   Caller->>patchFile: Call with path and values
+ *   patchFile->>fs: Check if file exists
+ *   patchFile->>readFile: Read file content
+ *   readFile->>fs: Read file
+ *   fs-->>readFile: Return file content
+ *   readFile-->>patchFile: Return file content
+ *   patchFile->>TextUtils: Patch string
+ *   TextUtils-->>patchFile: Return patched content
+ *   patchFile->>writeFile: Write patched content
+ *   writeFile->>fs: Write to file
+ *   fs-->>writeFile: File written
+ *   writeFile-->>patchFile: File written
+ *   patchFile-->>Caller: Patching complete
+ *
+ * @memberOf module:utils
+ */
+export declare function patchFile(path: string, values: Record<string, number | string>, filter?: (str: string) => boolean): void;
+/**
+ * @description Reads a file and returns its content.
+ * @summary Reads the content of a file at the specified path and returns it as a string.
+ *
+ * @param {string} path - The path to the file to be read.
+ * @return {string} The content of the file.
+ *
+ * @function readFile
+ *
+ * @memberOf module:utils
+ */
+export declare function readFile(path: string): string;
+/**
+ * @description Writes data to a file.
+ * @summary Writes the provided data to a file at the specified path.
+ *
+ * @param {string} path - The path to the file to be written.
+ * @param {string | Buffer} data - The data to be written to the file.
+ * @return {void}
+ *
+ * @function writeFile
+ *
+ * @memberOf module:utils
+ */
+export declare function writeFile(path: string, data: string | Buffer): void;
+/**
+ * @description Retrieves all files recursively from a directory.
+ * @summary Traverses through directories and subdirectories to collect all file paths.
+ *
+ * @param {string} p - The path to start searching from.
+ * @param {function} [filter] - Optional function to filter files by name or index.
+ * @return {string[]} Array of file paths.
+ *
+ * @function getAllFiles
+ *
+ * @memberOf module:utils
+ */
+export declare function getAllFiles(p: string, filter?: (f: string, i?: number) => boolean): string[];
+/**
+ * @description Renames a file or directory.
+ * @summary Moves a file or directory from the source path to the destination path.
+ *
+ * @param {string} source - The source path of the file or directory.
+ * @param {string} dest - The destination path for the file or directory.
+ * @return {Promise<void>} A promise that resolves when the rename operation is complete.
+ *
+ * @function renameFile
+ *
+ * @memberOf module:utils
+ */
+export declare function renameFile(source: string, dest: string): Promise<void>;
+/**
+ * @description Copies a file or directory.
+ * @summary Creates a copy of a file or directory from the source path to the destination path.
+ *
+ * @param {string} source - The source path of the file or directory.
+ * @param {string} dest - The destination path for the file or directory.
+ * @return {void}
+ *
+ * @function copyFile
+ *
+ * @memberOf module:utils
+ */
+export declare function copyFile(source: string, dest: string): void;
+/**
+ * @description Deletes a file or directory.
+ * @summary Removes a file or directory at the specified path, with recursive and force options enabled.
+ *
+ * @param {string} p - The path to the file or directory to delete.
+ * @return {void}
+ *
+ * @function deletePath
+ *
+ * @memberOf module:utils
+ */
+export declare function deletePath(p: string): void;
+/**
+ * @description Retrieves package information from package.json.
+ * @summary Loads and parses the package.json file from a specified directory or the current working directory. Can return the entire package object or a specific property.
+ * @param {string} [p=process.cwd()] - The directory path where the package.json file is located.
+ * @param {string} [property] - Optional. The specific property to retrieve from package.json.
+ * @return {object | string} The parsed contents of package.json or the value of the specified property.
+ * @function getPackage
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant getPackage
+ *   participant readFile
+ *   participant JSON
+ *   Caller->>getPackage: Call with path and optional property
+ *   getPackage->>readFile: Read package.json
+ *   readFile-->>getPackage: Return file content
+ *   getPackage->>JSON: Parse file content
+ *   JSON-->>getPackage: Return parsed object
+ *   alt property specified
+ *     getPackage->>getPackage: Check if property exists
+ *     alt property exists
+ *       getPackage-->>Caller: Return property value
+ *     else property doesn't exist
+ *       getPackage-->>Caller: Throw Error
+ *     end
+ *   else no property specified
+ *     getPackage-->>Caller: Return entire package object
+ *   end
+ * @memberOf module:utils
+ */
+export declare function getPackage(p?: string, property?: string): object | string;
+/**
+ * @description Sets an attribute in the package.json file.
+ * @summary Updates a specific attribute in the package.json file with the provided value.
+ *
+ * @param {string} attr - The attribute name to set in package.json.
+ * @param {string | number | object} value - The value to set for the attribute.
+ * @param {string} [p=process.cwd()] - The directory path where the package.json file is located.
+ * @return {void}
+ *
+ * @function setPackageAttribute
+ *
+ * @memberOf module:utils
+ */
+export declare function setPackageAttribute(attr: string, value: string, p?: string): void;
+/**
+ * @description Retrieves the version from package.json.
+ * @summary A convenience function that calls getPackage to retrieve the "version" property from package.json.
+ * @param {string} [p=process.cwd()] - The directory path where the package.json file is located.
+ * @return {string} The version string from package.json.
+ * @function getPackageVersion
+ * @memberOf module:utils
+ */
+export declare function getPackageVersion(p?: string): string;
+/**
+ * @description Retrieves all dependencies from the project.
+ * @summary Executes 'npm ls --json' command to get a detailed list of all dependencies (production, development, and peer) and their versions.
+ * @param {string} [path=process.cwd()] - The directory path of the project.
+ * @return {Promise<{prod: Array<{name: string, version: string}>, dev: Array<{name: string, version: string}>, peer: Array<{name: string, version: string}>}>} An object containing arrays of production, development, and peer dependencies.
+ * @function getDependencies
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant getDependencies
+ *   participant runCommand
+ *   participant JSON
+ *   Caller->>getDependencies: Call with optional path
+ *   getDependencies->>runCommand: Execute 'npm ls --json'
+ *   runCommand-->>getDependencies: Return command output
+ *   getDependencies->>JSON: Parse command output
+ *   JSON-->>getDependencies: Return parsed object
+ *   getDependencies->>getDependencies: Process dependencies
+ *   getDependencies-->>Caller: Return processed dependencies
+ * @memberOf module:utils
+ */
+export declare function getDependencies(p?: string): Promise<DependencyMap>;
+/**
+ * @description Updates project dependencies to their latest versions.
+ * @summary Runs npm-check-updates to update package.json and then installs the updated dependencies.
+ *
+ * @return {Promise<void>} A promise that resolves when dependencies are updated.
+ *
+ * @function updateDependencies
+ *
+ * @memberOf module:utils
+ */
+export declare function updateDependencies(): Promise<void>;
+/**
+ * @description Installs dependencies if they are not already available.
+ * @summary Checks if specified dependencies are installed and installs any that are missing.
+ *
+ * @param {string[] | string} deps - The dependencies to check and potentially install.
+ * @param {SimpleDependencyMap} [dependencies] - Optional map of existing dependencies.
+ * @return {Promise<SimpleDependencyMap>} Updated map of dependencies.
+ *
+ * @function installIfNotAvailable
+ *
+ * @memberOf module:utils
+ */
+export declare function installIfNotAvailable(deps: string[] | string, dependencies?: SimpleDependencyMap): Promise<SimpleDependencyMap>;
+/**
+ * @description Pushes changes to Git repository.
+ * @summary Temporarily changes Git user configuration, commits all changes, pushes to remote, and restores original user configuration.
+ *
+ * @return {Promise<void>} A promise that resolves when changes are pushed.
+ *
+ * @function pushToGit
+ *
+ * @memberOf module:utils
+ */
+export declare function pushToGit(): Promise<void>;
+/**
+ * @description Installs project dependencies.
+ * @summary Installs production, development, and peer dependencies as specified.
+ *
+ * @param {object} dependencies - Object containing arrays of dependencies to install.
+ * @param {string[]} [dependencies.prod] - Production dependencies to install.
+ * @param {string[]} [dependencies.dev] - Development dependencies to install.
+ * @param {string[]} [dependencies.peer] - Peer dependencies to install.
+ * @return {Promise<void>} A promise that resolves when all dependencies are installed.
+ *
+ * @function installDependencies
+ *
+ * @memberOf module:utils
+ */
+export declare function installDependencies(dependencies: {
+    prod?: string[];
+    dev?: string[];
+    peer?: string[];
+}): Promise<void>;
+/**
+ * @description Normalizes imports to handle both CommonJS and ESModule formats.
+ * @summary Utility function to handle module import differences between formats.
+ *
+ * @template T - Type of the imported module.
+ * @param {Promise<T>} importPromise - Promise returned by dynamic import.
+ * @return {Promise<T>} Normalized module.
+ *
+ * @function normalizeImport
+ *
+ * @memberOf module:utils
+ */
+export declare function normalizeImport<T>(importPromise: Promise<T>): Promise<T>;
+export declare function getFileSizeZipped(dir: string): Promise<number>;
+export declare function listFolder(basePath?: string, filter?: (name: string, dirent: fs.Dirent) => boolean): string[];
+export declare function listNodeModulesPackages(basePath?: string): string[];

package/lib/types/utils/fs.d.mts

@@ -0,0 +1,259 @@
+import fs from "fs";
+import { DependencyMap, SimpleDependencyMap } from "./types.js";
+/**
+ * @description Patches a file with given values.
+ * @summary Reads a file, applies patches using TextUtils, and writes the result back to the file.
+ *
+ * @param {string} path - The path to the file to be patched.
+ * @param {Record<string, number | string>} values - The values to patch into the file.
+ * @return {void}
+ *
+ * @function patchFile
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant patchFile
+ *   participant fs
+ *   participant readFile
+ *   participant TextUtils
+ *   participant writeFile
+ *   Caller->>patchFile: Call with path and values
+ *   patchFile->>fs: Check if file exists
+ *   patchFile->>readFile: Read file content
+ *   readFile->>fs: Read file
+ *   fs-->>readFile: Return file content
+ *   readFile-->>patchFile: Return file content
+ *   patchFile->>TextUtils: Patch string
+ *   TextUtils-->>patchFile: Return patched content
+ *   patchFile->>writeFile: Write patched content
+ *   writeFile->>fs: Write to file
+ *   fs-->>writeFile: File written
+ *   writeFile-->>patchFile: File written
+ *   patchFile-->>Caller: Patching complete
+ *
+ * @memberOf module:utils
+ */
+export declare function patchFile(path: string, values: Record<string, number | string>, filter?: (str: string) => boolean): void;
+/**
+ * @description Reads a file and returns its content.
+ * @summary Reads the content of a file at the specified path and returns it as a string.
+ *
+ * @param {string} path - The path to the file to be read.
+ * @return {string} The content of the file.
+ *
+ * @function readFile
+ *
+ * @memberOf module:utils
+ */
+export declare function readFile(path: string): string;
+/**
+ * @description Writes data to a file.
+ * @summary Writes the provided data to a file at the specified path.
+ *
+ * @param {string} path - The path to the file to be written.
+ * @param {string | Buffer} data - The data to be written to the file.
+ * @return {void}
+ *
+ * @function writeFile
+ *
+ * @memberOf module:utils
+ */
+export declare function writeFile(path: string, data: string | Buffer): void;
+/**
+ * @description Retrieves all files recursively from a directory.
+ * @summary Traverses through directories and subdirectories to collect all file paths.
+ *
+ * @param {string} p - The path to start searching from.
+ * @param {function} [filter] - Optional function to filter files by name or index.
+ * @return {string[]} Array of file paths.
+ *
+ * @function getAllFiles
+ *
+ * @memberOf module:utils
+ */
+export declare function getAllFiles(p: string, filter?: (f: string, i?: number) => boolean): string[];
+/**
+ * @description Renames a file or directory.
+ * @summary Moves a file or directory from the source path to the destination path.
+ *
+ * @param {string} source - The source path of the file or directory.
+ * @param {string} dest - The destination path for the file or directory.
+ * @return {Promise<void>} A promise that resolves when the rename operation is complete.
+ *
+ * @function renameFile
+ *
+ * @memberOf module:utils
+ */
+export declare function renameFile(source: string, dest: string): Promise<void>;
+/**
+ * @description Copies a file or directory.
+ * @summary Creates a copy of a file or directory from the source path to the destination path.
+ *
+ * @param {string} source - The source path of the file or directory.
+ * @param {string} dest - The destination path for the file or directory.
+ * @return {void}
+ *
+ * @function copyFile
+ *
+ * @memberOf module:utils
+ */
+export declare function copyFile(source: string, dest: string): void;
+/**
+ * @description Deletes a file or directory.
+ * @summary Removes a file or directory at the specified path, with recursive and force options enabled.
+ *
+ * @param {string} p - The path to the file or directory to delete.
+ * @return {void}
+ *
+ * @function deletePath
+ *
+ * @memberOf module:utils
+ */
+export declare function deletePath(p: string): void;
+/**
+ * @description Retrieves package information from package.json.
+ * @summary Loads and parses the package.json file from a specified directory or the current working directory. Can return the entire package object or a specific property.
+ * @param {string} [p=process.cwd()] - The directory path where the package.json file is located.
+ * @param {string} [property] - Optional. The specific property to retrieve from package.json.
+ * @return {object | string} The parsed contents of package.json or the value of the specified property.
+ * @function getPackage
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant getPackage
+ *   participant readFile
+ *   participant JSON
+ *   Caller->>getPackage: Call with path and optional property
+ *   getPackage->>readFile: Read package.json
+ *   readFile-->>getPackage: Return file content
+ *   getPackage->>JSON: Parse file content
+ *   JSON-->>getPackage: Return parsed object
+ *   alt property specified
+ *     getPackage->>getPackage: Check if property exists
+ *     alt property exists
+ *       getPackage-->>Caller: Return property value
+ *     else property doesn't exist
+ *       getPackage-->>Caller: Throw Error
+ *     end
+ *   else no property specified
+ *     getPackage-->>Caller: Return entire package object
+ *   end
+ * @memberOf module:utils
+ */
+export declare function getPackage(p?: string, property?: string): object | string;
+/**
+ * @description Sets an attribute in the package.json file.
+ * @summary Updates a specific attribute in the package.json file with the provided value.
+ *
+ * @param {string} attr - The attribute name to set in package.json.
+ * @param {string | number | object} value - The value to set for the attribute.
+ * @param {string} [p=process.cwd()] - The directory path where the package.json file is located.
+ * @return {void}
+ *
+ * @function setPackageAttribute
+ *
+ * @memberOf module:utils
+ */
+export declare function setPackageAttribute(attr: string, value: string, p?: string): void;
+/**
+ * @description Retrieves the version from package.json.
+ * @summary A convenience function that calls getPackage to retrieve the "version" property from package.json.
+ * @param {string} [p=process.cwd()] - The directory path where the package.json file is located.
+ * @return {string} The version string from package.json.
+ * @function getPackageVersion
+ * @memberOf module:utils
+ */
+export declare function getPackageVersion(p?: string): string;
+/**
+ * @description Retrieves all dependencies from the project.
+ * @summary Executes 'npm ls --json' command to get a detailed list of all dependencies (production, development, and peer) and their versions.
+ * @param {string} [path=process.cwd()] - The directory path of the project.
+ * @return {Promise<{prod: Array<{name: string, version: string}>, dev: Array<{name: string, version: string}>, peer: Array<{name: string, version: string}>}>} An object containing arrays of production, development, and peer dependencies.
+ * @function getDependencies
+ * @mermaid
+ * sequenceDiagram
+ *   participant Caller
+ *   participant getDependencies
+ *   participant runCommand
+ *   participant JSON
+ *   Caller->>getDependencies: Call with optional path
+ *   getDependencies->>runCommand: Execute 'npm ls --json'
+ *   runCommand-->>getDependencies: Return command output
+ *   getDependencies->>JSON: Parse command output
+ *   JSON-->>getDependencies: Return parsed object
+ *   getDependencies->>getDependencies: Process dependencies
+ *   getDependencies-->>Caller: Return processed dependencies
+ * @memberOf module:utils
+ */
+export declare function getDependencies(p?: string): Promise<DependencyMap>;
+/**
+ * @description Updates project dependencies to their latest versions.
+ * @summary Runs npm-check-updates to update package.json and then installs the updated dependencies.
+ *
+ * @return {Promise<void>} A promise that resolves when dependencies are updated.
+ *
+ * @function updateDependencies
+ *
+ * @memberOf module:utils
+ */
+export declare function updateDependencies(): Promise<void>;
+/**
+ * @description Installs dependencies if they are not already available.
+ * @summary Checks if specified dependencies are installed and installs any that are missing.
+ *
+ * @param {string[] | string} deps - The dependencies to check and potentially install.
+ * @param {SimpleDependencyMap} [dependencies] - Optional map of existing dependencies.
+ * @return {Promise<SimpleDependencyMap>} Updated map of dependencies.
+ *
+ * @function installIfNotAvailable
+ *
+ * @memberOf module:utils
+ */
+export declare function installIfNotAvailable(deps: string[] | string, dependencies?: SimpleDependencyMap): Promise<SimpleDependencyMap>;
+/**
+ * @description Pushes changes to Git repository.
+ * @summary Temporarily changes Git user configuration, commits all changes, pushes to remote, and restores original user configuration.
+ *
+ * @return {Promise<void>} A promise that resolves when changes are pushed.
+ *
+ * @function pushToGit
+ *
+ * @memberOf module:utils
+ */
+export declare function pushToGit(): Promise<void>;
+/**
+ * @description Installs project dependencies.
+ * @summary Installs production, development, and peer dependencies as specified.
+ *
+ * @param {object} dependencies - Object containing arrays of dependencies to install.
+ * @param {string[]} [dependencies.prod] - Production dependencies to install.
+ * @param {string[]} [dependencies.dev] - Development dependencies to install.
+ * @param {string[]} [dependencies.peer] - Peer dependencies to install.
+ * @return {Promise<void>} A promise that resolves when all dependencies are installed.
+ *
+ * @function installDependencies
+ *
+ * @memberOf module:utils
+ */
+export declare function installDependencies(dependencies: {
+    prod?: string[];
+    dev?: string[];
+    peer?: string[];
+}): Promise<void>;
+/**
+ * @description Normalizes imports to handle both CommonJS and ESModule formats.
+ * @summary Utility function to handle module import differences between formats.
+ *
+ * @template T - Type of the imported module.
+ * @param {Promise<T>} importPromise - Promise returned by dynamic import.
+ * @return {Promise<T>} Normalized module.
+ *
+ * @function normalizeImport
+ *
+ * @memberOf module:utils
+ */
+export declare function normalizeImport<T>(importPromise: Promise<T>): Promise<T>;
+export declare function getFileSizeZipped(dir: string): Promise<number>;
+export declare function listFolder(basePath?: string, filter?: (name: string, dirent: fs.Dirent) => boolean): string[];
+export declare function listNodeModulesPackages(basePath?: string): string[];

package/lib/types/utils/http.d.cts

@@ -0,0 +1,41 @@
+/**
+ * @description A simple HTTP client for downloading files.
+ * @summary This class provides functionality to download files from HTTPS URLs.
+ * It uses Node.js built-in https module to make requests.
+ *
+ * @class HttpClient
+ */
+export declare class HttpClient {
+    protected static log: import("@decaf-ts/logging").Logger;
+    /**
+     * @description Downloads a file from a given URL.
+     * @summary This method sends a GET request to the specified URL and returns the response body as a string.
+     * It handles different scenarios such as non-200 status codes and network errors.
+     *
+     * @param url - The URL of the file to download.
+     * @return A promise that resolves with the file content as a string.
+     *
+     * @mermaid
+     * sequenceDiagram
+     *   participant Client
+     *   participant HttpClient
+     *   participant HTTPS
+     *   participant Server
+     *   Client->>HttpClient: downloadFile(url)
+     *   HttpClient->>HTTPS: get(url)
+     *   HTTPS->>Server: GET request
+     *   Server-->>HTTPS: Response
+     *   HTTPS-->>HttpClient: Response object
+     *   alt Status code is 200
+     *     loop For each data chunk
+     *       HTTPS->>HttpClient: 'data' event
+     *       HttpClient->>HttpClient: Accumulate data
+     *     end
+     *     HTTPS->>HttpClient: 'end' event
+     *     HttpClient-->>Client: Resolve with data
+     *   else Status code is not 200
+     *     HttpClient-->>Client: Reject with error
+     *   end
+     */
+    static downloadFile(url: string): Promise<string>;
+}

package/lib/types/utils/http.d.mts

@@ -0,0 +1,41 @@
+/**
+ * @description A simple HTTP client for downloading files.
+ * @summary This class provides functionality to download files from HTTPS URLs.
+ * It uses Node.js built-in https module to make requests.
+ *
+ * @class HttpClient
+ */
+export declare class HttpClient {
+    protected static log: import("@decaf-ts/logging").Logger;
+    /**
+     * @description Downloads a file from a given URL.
+     * @summary This method sends a GET request to the specified URL and returns the response body as a string.
+     * It handles different scenarios such as non-200 status codes and network errors.
+     *
+     * @param url - The URL of the file to download.
+     * @return A promise that resolves with the file content as a string.
+     *
+     * @mermaid
+     * sequenceDiagram
+     *   participant Client
+     *   participant HttpClient
+     *   participant HTTPS
+     *   participant Server
+     *   Client->>HttpClient: downloadFile(url)
+     *   HttpClient->>HTTPS: get(url)
+     *   HTTPS->>Server: GET request
+     *   Server-->>HTTPS: Response
+     *   HTTPS-->>HttpClient: Response object
+     *   alt Status code is 200
+     *     loop For each data chunk
+     *       HTTPS->>HttpClient: 'data' event
+     *       HttpClient->>HttpClient: Accumulate data
+     *     end
+     *     HTTPS->>HttpClient: 'end' event
+     *     HttpClient-->>Client: Resolve with data
+     *   else Status code is not 200
+     *     HttpClient-->>Client: Reject with error
+     *   end
+     */
+    static downloadFile(url: string): Promise<string>;
+}

package/lib/types/utils/index.d.cts

@@ -0,0 +1,6 @@
+export * from "./constants.cjs";
+export * from "./fs.cjs";
+export * from "./http.cjs";
+export * from "./types.cjs";
+export * from "./utils.cjs";
+export * from "./performanceRunner.cjs";

package/lib/types/utils/index.d.mts

@@ -0,0 +1,6 @@
+export * from "./constants.js";
+export * from "./fs.js";
+export * from "./http.js";
+export * from "./types.js";
+export * from "./utils.js";
+export * from "./performanceRunner.js";