@decaf-ts/utils 0.1.6

package/dist/types/output/logging.d.ts

@@ -0,0 +1,177 @@
+import { LogLevel } from "../utils/constants";
+import { LoggingConfig, LoggingContext, StringLike, Theme, VerbosityLogger } from "./types";
+/**
+ * @description A minimal logger implementation.
+ * @summary MiniLogger is a lightweight logging class that implements the VerbosityLogger interface.
+ * It provides basic logging functionality with support for different log levels and verbosity.
+ *
+ * @class
+ */
+export declare class MiniLogger implements VerbosityLogger {
+    protected context: string;
+    protected conf?: Partial<LoggingConfig> | undefined;
+    protected id?: string | undefined;
+    /**
+     * @description Creates a new MiniLogger instance.
+     * @summary Initializes a MiniLogger with the given class name, optional configuration, and method name.
+     *
+     * @param context - The name of the class using this logger.
+     * @param [conf] - Optional logging configuration. Defaults to Info level and verbosity 0.
+     * @param [id] - Optional unique identifier for the logger instance.
+     */
+    constructor(context: string, conf?: Partial<LoggingConfig> | undefined, id?: string | undefined);
+    protected config(key: keyof LoggingConfig): LoggingConfig[keyof LoggingConfig];
+    for(method?: string | ((...args: any[]) => any), config?: Partial<LoggingConfig>): VerbosityLogger;
+    /**
+     * @description Creates a formatted log string.
+     * @summary Generates a log string with timestamp, colored log level, and message.
+     *
+     * @param level - The log level as a string.
+     * @param message
+     * @param stack
+     * @return A formatted log string.
+     */
+    protected createLog(level: LogLevel, message: StringLike | Error, stack?: string): string;
+    /**
+     * @description Logs a message with the specified log level.
+     * @summary Checks if the message should be logged based on the current log level,
+     * then uses the appropriate console method to output the log.
+     *
+     * @param level - The log level of the message.
+     * @param msg - The message to be logged.
+     * @param stack
+     */
+    protected log(level: LogLevel, msg: StringLike | Error, stack?: string): void;
+    /**
+     * @description LLogs a `way too verbose` or a silly message.
+     * @summary Logs a message at the Silly level if the current verbosity allows it.
+     *
+     * @param msg - The message to be logged.
+     * @param verbosity - The verbosity level of the message (default: 0).
+     */
+    silly(msg: StringLike, verbosity?: number): void;
+    /**
+     * @description Logs a verbose message.
+     * @summary Logs a message at the Verbose level if the current verbosity allows it.
+     *
+     * @param msg - The message to be logged.
+     * @param verbosity - The verbosity level of the message (default: 0).
+     */
+    verbose(msg: StringLike, verbosity?: number): void;
+    /**
+     * @description Logs an info message.
+     * @summary Logs a message at the Info level.
+     *
+     * @param msg - The message to be logged.
+     */
+    info(msg: StringLike): void;
+    /**
+     * @description Logs a debug message.
+     * @summary Logs a message at the Debug level.
+     *
+     * @param msg - The message to be logged.
+     */
+    debug(msg: StringLike): void;
+    /**
+     * @description Logs an error message.
+     * @summary Logs a message at the Error level.
+     *
+     * @param msg - The message to be logged.
+     */
+    error(msg: StringLike | Error): void;
+    setConfig(config: Partial<LoggingConfig>): void;
+}
+/**
+ * @description A static class for managing logging operations.
+ * @summary The Logging class provides a centralized logging mechanism with support for
+ * different log levels and verbosity. It uses a singleton pattern to maintain a global
+ * logger instance and allows creating specific loggers for different classes and methods.
+ *
+ * @class
+ */
+export declare class Logging {
+    /**
+     * @description The global logger instance.
+     * @summary A singleton instance of VerbosityLogger used for global logging.
+     */
+    private static global?;
+    /**
+     * @description Factory function for creating logger instances.
+     * @summary A function that creates new VerbosityLogger instances. By default, it creates a MiniLogger.
+     */
+    private static _factory;
+    /**
+     * @description Configuration for the logging system.
+     * @summary Stores the global verbosity level and log level settings.
+     */
+    private static _config;
+    /**
+     * @description Private constructor to prevent instantiation.
+     * @summary Ensures that the Logging class cannot be instantiated as it's designed to be used statically.
+     */
+    private constructor();
+    /**
+     * @description Setter for the logging configuration.
+     * @summary Allows updating the global logging configuration.
+     *
+     * @param config - An object containing verbosity and log level settings.
+     */
+    static setConfig(config: Partial<LoggingConfig>): void;
+    static getConfig(): LoggingConfig;
+    /**
+     * @description Retrieves or creates the global logger instance.
+     * @summary Returns the existing global logger or creates a new one if it doesn't exist.
+     *
+     * @return The global VerbosityLogger instance.
+     */
+    static get(): VerbosityLogger;
+    /**
+     * @description Logs a verbose message.
+     * @summary Delegates the verbose logging to the global logger instance.
+     *
+     * @param msg - The message to be logged.
+     * @param verbosity - The verbosity level of the message (default: 0).
+     */
+    static verbose(msg: StringLike, verbosity?: number): void;
+    /**
+     * @description Logs an info message.
+     * @summary Delegates the info logging to the global logger instance.
+     *
+     * @param msg - The message to be logged.
+     */
+    static info(msg: StringLike): void;
+    /**
+     * @description Logs a debug message.
+     * @summary Delegates the debug logging to the global logger instance.
+     *
+     * @param msg - The message to be logged.
+     */
+    static debug(msg: StringLike): void;
+    /**
+     * @description Logs a silly message.
+     * @summary Delegates the debug logging to the global logger instance.
+     *
+     * @param msg - The message to be logged.
+     */
+    static silly(msg: StringLike): void;
+    /**
+     * @description Logs an error message.
+     * @summary Delegates the error logging to the global logger instance.
+     *
+     * @param msg - The message to be logged.
+     */
+    static error(msg: StringLike): void;
+    static for(object: LoggingContext, id?: string | Partial<LoggingConfig>, config?: Partial<LoggingConfig>): VerbosityLogger;
+    /**
+     * @description Creates a logger for a specific reason or context.
+     *
+     * @summary This static method creates a new logger instance using the factory function,
+     * based on a given reason or context.
+     *
+     * @param reason - A string describing the reason or context for creating this logger.
+     * @param id
+     * @returns A new VerbosityLogger or ClassLogger instance.
+     */
+    static because(reason: string, id?: string): VerbosityLogger;
+    static theme(text: string, type: keyof Theme | keyof LogLevel, loggerLevel: LogLevel, template?: Theme): string;
+}

package/dist/types/output/types.d.ts

@@ -0,0 +1,203 @@
+import { LogLevel } from "../utils/constants";
+import { styles } from "styled-string-builder";
+export type StringLike = string | {
+    toString: () => string;
+};
+export type LoggingContext = string | {
+    new (...args: any[]): any;
+} | ((...args: any[]) => any);
+/**
+ * @description Interface for a logger with verbosity levels.
+ * @summary Defines methods for logging at different verbosity levels.
+ * @interface VerbosityLogger
+ * @memberOf @decaf-ts/utils
+ */
+export interface VerbosityLogger {
+    /**
+     * @description Logs a `way too verbose` or a silly message.
+     * @param {StringLike} msg - The message to log.
+     */
+    silly(msg: StringLike): void;
+    /**
+     * @description Logs a verbose message.
+     * @param {StringLike} msg - The message to log.
+     * @param {number} verbosity - The verbosity level of the message.
+     */
+    verbose(msg: StringLike, verbosity?: number): void;
+    /**
+     * @description Logs an info message.
+     * @param {StringLike} msg - The message to log.
+     */
+    info(msg: StringLike): void;
+    /**
+     * @description Logs an error message.
+     * @param {StringLike | Error} msg - The message to log.
+     */
+    error(msg: StringLike | Error): void;
+    /**
+     * @description Logs a debug message.
+     * @param {string} msg - The message to log.
+     */
+    debug(msg: StringLike): void;
+    for(method?: string | ((...args: any[]) => any), config?: Partial<LoggingConfig>): VerbosityLogger;
+    setConfig(config: Partial<LoggingConfig>): void;
+}
+/**
+ * @description Configuration for logging.
+ * @summary Defines the log level and verbosity for logging.
+ * @typedef {Object} LoggingConfig
+ * @property {LogLevel} level - The logging level.
+ * @property {number} verbose - The verbosity level.
+ * @memberOf @decaf-ts/utils
+ */
+export type LoggingConfig = {
+    level: LogLevel;
+    logLevel?: boolean;
+    verbose: number;
+    separator: string;
+    style?: boolean;
+    timestamp?: boolean;
+    timestampFormat?: string;
+    context?: boolean;
+    theme?: Theme;
+};
+/**
+ /**
+ * @description Represents a theme option for console output styling.
+ * @summary Defines the structure for styling a specific element in the console output.
+ * It allows for customization of foreground color, background color, and additional styles.
+ * Colors can be specified as a single number, an RGB array, or left undefined for default.
+ *
+ * @interface ThemeOption
+ * @memberOf @decaf-ts/utils
+ */
+export interface ThemeOption {
+    fg?: number | [number] | [number, number, number];
+    bg?: number | [number] | [number, number, number];
+    style?: number[] | [keyof typeof styles];
+}
+export type ThemeOptionByLogLevel = Partial<Record<LogLevel, ThemeOption>>;
+/**
+ /**
+ * @description Defines the color theme for console output.
+ * @summary This interface specifies the color scheme for various elements of console output,
+ * including styling for different log levels and components. It uses ThemeOption to
+ * define the styling for each element, allowing for customization of colors and styles
+ * for different parts of the log output.
+ *
+ * @interface Theme
+ * @memberOf @decaf-ts/utils
+ */
+export interface Theme {
+    /**
+     * @description Styling for class names in the output.
+     */
+    class: ThemeOption | ThemeOptionByLogLevel;
+    /**
+     * @description Styling for timestamps in the output.
+     */
+    timestamp: ThemeOption | ThemeOptionByLogLevel;
+    /**
+     * @description Styling for the main message text in the output.
+     */
+    message: ThemeOption | ThemeOptionByLogLevel;
+    /**
+     * @description Styling for method names in the output.
+     */
+    method: ThemeOption | ThemeOptionByLogLevel;
+    /**
+     * @description Styling for identifier elements in the output.
+     */
+    id: ThemeOption | ThemeOptionByLogLevel;
+    /**
+     * @description Styling for identifier elements in the output.
+     */
+    stack: ThemeOption;
+    /**
+     * @description Styling for different log levels in the output.
+     */
+    logLevel: ThemeOptionByLogLevel;
+}
+/**
+ * @description Represents a color function in the Kleur library.
+ * @summary The Color interface defines a function that can be called with or without arguments
+ * to apply color styling to text or chain multiple color operations.
+ *
+ * @interface Color
+ * @memberOf module:@decaf-ts/utils
+ * */
+export interface Color {
+    /**
+     * @description Applies the color to the given text.
+     * @param {string | number} x - The text or number to be colored.
+     * @return {string} The colored text.
+     */
+    (x: string | number): string;
+    /**
+     * @description Allows chaining of multiple color operations.
+     * @return {Kleur} The Kleur instance for method chaining.
+     */
+    (): Kleur;
+}
+/**
+ * @description Represents the main Kleur interface with all available color and style methods.
+ * @summary The Kleur interface provides methods for applying various colors, background colors,
+ * and text styles to strings in terminal output.
+ *
+ * @interface Kleur
+ * @memberOf module:@decaf-ts/utils
+ */
+export interface Kleur {
+    /** @description Applies black color to the text. */
+    black: Color;
+    /** @description Applies red color to the text. */
+    red: Color;
+    /** @description Applies green color to the text. */
+    green: Color;
+    /** @description Applies yellow color to the text. */
+    yellow: Color;
+    /** @description Applies blue color to the text. */
+    blue: Color;
+    /** @description Applies magenta color to the text. */
+    magenta: Color;
+    /** @description Applies cyan color to the text. */
+    cyan: Color;
+    /** @description Applies white color to the text. */
+    white: Color;
+    /** @description Applies gray color to the text. */
+    gray: Color;
+    /** @description Alias for gray color. */
+    grey: Color;
+    /** @description Applies black background to the text. */
+    bgBlack: Color;
+    /** @description Applies red background to the text. */
+    bgRed: Color;
+    /** @description Applies green background to the text. */
+    bgGreen: Color;
+    /** @description Applies yellow background to the text. */
+    bgYellow: Color;
+    /** @description Applies blue background to the text. */
+    bgBlue: Color;
+    /** @description Applies magenta background to the text. */
+    bgMagenta: Color;
+    /** @description Applies cyan background to the text. */
+    bgCyan: Color;
+    /** @description Applies white background to the text. */
+    bgWhite: Color;
+    /** @description Resets all applied styles. */
+    reset: Color;
+    /** @description Applies bold style to the text. */
+    bold: Color;
+    /** @description Applies dim (decreased intensity) style to the text. */
+    dim: Color;
+    /** @description Applies italic style to the text. */
+    italic: Color;
+    /** @description Applies underline style to the text. */
+    underline: Color;
+    /** @description Inverts the foreground and background colors. */
+    inverse: Color;
+    /** @description Hides the text (same color as background). */
+    hidden: Color;
+    /** @description Applies strikethrough style to the text. */
+    strikethrough: Color;
+}

package/dist/types/utils/accumulator.d.ts

@@ -0,0 +1,105 @@
+/**
+ * @class ObjectAccumulator
+ * @template T - The type of the accumulated object, extends object
+ * @description A class that accumulates objects and provides type-safe access to their properties.
+ * It allows for dynamic addition of properties while maintaining type information.
+ * @summary Accumulates objects and maintains type information for accumulated properties
+ * @memberOf utils
+ */
+export declare class ObjectAccumulator<T extends object> {
+    /**
+     * @private
+     * @description The size of the accumulated object
+     * @type {number}
+     */
+    private __size;
+    constructor();
+    /**
+     * @protected
+     * @description Expands the accumulator with properties from a new object
+     * @summary Adds new properties to the accumulator
+     * @template V - The type of the object being expanded
+     * @param {V} value - The object to expand with
+     * @returns {void}
+     */
+    protected expand<V extends object>(value: V): void;
+    /**
+     * @description Accumulates a new object into the accumulator
+     * @summary Adds properties from a new object to the accumulator, maintaining type information
+     * @template V - The type of the object being accumulated
+     * @param {V} value - The object to accumulate
+     * @returns A new ObjectAccumulator instance with updated type information
+     * @mermaid
+     * sequenceDiagram
+     *   participant A as Accumulator
+     *   participant O as Object
+     *   A->>O: Get entries
+     *   loop For each entry
+     *     A->>A: Define property
+     *   end
+     *   A->>A: Update size
+     *   A->>A: Return updated accumulator
+     */
+    accumulate<V extends object>(value: V): T & V & ObjectAccumulator<T & V>;
+    /**
+     * @description Retrieves a value from the accumulator by its key
+     * @summary Gets a value from the accumulated object using a type-safe key
+     * @template K - The key type, must be a key of this
+     * @param {K} key - The key of the value to retrieve
+     * @returns {any | undefined} The value associated with the key, or undefined if not found
+     */
+    get<K extends keyof this>(key: K): this[K] | undefined;
+    /**
+     * @description Checks if a key exists in the accumulator
+     * @summary Determines whether the accumulator contains a specific key
+     * @param {string} key - The key to check for existence
+     * @returns {boolean} True if the key exists, false otherwise
+     */
+    has(key: string): boolean;
+    /**
+     * @description Removes a key-value pair from the accumulator
+     * @summary Deletes a property from the accumulated object
+     * @param {string} key - The key of the property to remove
+     * @returns {} The accumulator instance with the specified property removed
+     */
+    remove(key: keyof this | string): (Omit<this, typeof key> & ObjectAccumulator<Omit<this, typeof key>>) | this;
+    /**
+     * @description Retrieves all keys from the accumulator
+     * @summary Gets an array of all accumulated property keys
+     * @returns {string[]} An array of keys as strings
+     */
+    keys(): string[];
+    /**
+     * @description Retrieves all values from the accumulator
+     * @summary Gets an array of all accumulated property values
+     * @returns An array of values
+     */
+    values(): T[keyof T][];
+    /**
+     * @description Gets the number of key-value pairs in the accumulator
+     * @summary Returns the count of accumulated properties
+     * @returns {number} The number of key-value pairs
+     */
+    size(): number;
+    /**
+     * @description Clears all accumulated key-value pairs
+     * @summary Removes all properties from the accumulator and returns a new empty instance
+     * @returns {ObjectAccumulator<never>} A new empty ObjectAccumulator instance
+     */
+    clear(): ObjectAccumulator<never>;
+    /**
+     * @description Executes a callback for each key-value pair in the accumulator
+     * @summary Iterates over all accumulated properties, calling a function for each
+     * @param {function(any, string, number): void} callback - The function to execute for each entry
+     * @returns {void}
+     */
+    forEach(callback: (value: this[keyof this], key: keyof this, i: number) => void): void;
+    /**
+     * @description Creates a new array with the results of calling a provided function on every element in the accumulator
+     * @summary Maps each accumulated property to a new value using a callback function
+     * @template R - The type of the mapped values
+     * @param {function(any, string,number): R} callback - Function that produces an element of the new array
+     * @returns {R[]} A new array with each element being the result of the callback function
+     */
+    map<R>(callback: (value: this[keyof this], key: keyof this, i: number) => R): R[];
+}

package/dist/types/utils/constants.d.ts

@@ -0,0 +1,136 @@
+import { LoggingConfig, Theme } from "../output/types";
+/**
+ * @description Default encoding for text operations.
+ * @summary The standard UTF-8 encoding used for text processing.
+ * @const {string} Encoding
+ * @memberOf @decaf-ts/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 @decaf-ts/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 @decaf-ts/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 @decaf-ts/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 @decaf-ts/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 @decaf-ts/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 Enum for log levels.
+ * @summary Defines different levels of logging for the application.
+ * @enum {string}
+ * @memberOf @decaf-ts/utils
+ */
+export declare enum LogLevel {
+    /** Error events that are likely to cause problems. */
+    error = "error",
+    /** Routine information, such as ongoing status or performance. */
+    info = "info",
+    /** Additional relevant information. */
+    verbose = "verbose",
+    /** Debug or trace information. */
+    debug = "debug",
+    /** way too verbose or silly information. */
+    silly = "silly"
+}
+/**
+ * @description Numeric values associated with log levels.
+ * @summary Provides a numeric representation of log levels for comparison and filtering.
+ * @const {Object} NumericLogLevels
+ * @property {number} error - Numeric value for error level (0).
+ * @property {number} info - Numeric value for info level (2).
+ * @property {number} verbose - Numeric value for verbose level (4).
+ * @property {number} debug - Numeric value for debug level (5).
+ * @property {number} silly - Numeric value for silly level (8).
+ * @memberOf @decaf-ts/utils
+ */
+export declare const NumericLogLevels: {
+    error: number;
+    info: number;
+    verbose: number;
+    debug: number;
+    silly: number;
+};
+/**
+ * @description Default theme for styling log output.
+ * @summary Defines the default color and style settings for various components of log messages.
+ * @const DefaultTheme
+ * @typedef {Theme} DefaultTheme
+ * @property {Object} class - Styling for class names.
+ * @property {number} class.fg - Foreground color code for class names (4).
+ * @property {Object} id - Styling for identifiers.
+ * @property {number} id.fg - Foreground color code for identifiers (36).
+ * @property {Object} stack - Styling for stack traces (empty object).
+ * @property {Object} timestamp - Styling for timestamps (empty object).
+ * @property {Object} message - Styling for different types of messages.
+ * @property {Object} message.error - Styling for error messages.
+ * @property {number} message.error.fg - Foreground color code for error messages (34).
+ * @property {Object} method - Styling for method names (empty object).
+ * @property {Object} logLevel - Styling for different log levels.
+ * @property {Object} logLevel.error - Styling for error level logs.
+ * @property {number} logLevel.error.fg - Foreground color code for error level logs (6).
+ * @property {Object} logLevel.info - Styling for info level logs (empty object).
+ * @property {Object} logLevel.verbose - Styling for verbose level logs (empty object).
+ * @property {Object} logLevel.debug - Styling for debug level logs.
+ * @property {number} logLevel.debug.fg - Foreground color code for debug level logs (7).
+ * @memberOf @decaf-ts/utils
+ */
+export declare const DefaultTheme: Theme;
+/**
+ * @description Default configuration for logging.
+ * @summary Defines the default settings for the logging system, including verbosity, log level, styling, and timestamp format.
+ * @const DefaultLoggingConfig
+ * @typedef {LoggingConfig} DefaultLoggingConfig
+ * @property {number} verbose - Verbosity level (0).
+ * @property {LogLevel} level - Default log level (LogLevel.info).
+ * @property {boolean} style - Whether to apply styling to log output (false).
+ * @property {boolean} timestamp - Whether to include timestamps in log messages (true).
+ * @property {string} timestampFormat - Format for timestamps ("HH:mm:ss.SSS").
+ * @property {boolean} context - Whether to include context information in log messages (true).
+ * @property {Theme} theme - The theme to use for styling log messages (DefaultTheme).
+ * @memberOf @decaf-ts/utils
+ */
+export declare const DefaultLoggingConfig: LoggingConfig;
+export declare const AbortCode = "Aborted";

package/dist/types/utils/environment.d.ts

@@ -0,0 +1,57 @@
+import { ObjectAccumulator } from "./accumulator";
+import { EnvironmentFactory } from "./types";
+/**
+ * @class Environment
+ * @extends {ObjectAccumulator<T>}
+ * @template T
+ * @description A class representing an environment with accumulation capabilities.
+ * @summary Manages environment-related data and provides methods for accumulation and key retrieval.
+ * @param {T} [initialData] - The initial data to populate the environment with.
+ */
+export declare class Environment<T extends object> extends ObjectAccumulator<T> {
+    /**
+     * @static
+     * @protected
+     * @description A factory function for creating Environment instances.
+     * @summary Defines how new instances of the Environment class should be created.
+     * @return {Environment<any>} A new instance of the Environment class.
+     */
+    protected static factory: EnvironmentFactory<any, any>;
+    /**
+     * @static
+     * @private
+     * @description The singleton instance of the Environment class.
+     * @type {Environment<any>}
+     */
+    private static _instance;
+    protected constructor();
+    protected fromEnv(k: string): unknown;
+    protected expand<V extends object>(value: V): void;
+    /**
+     * @protected
+     * @static
+     * @description Retrieves or creates the singleton instance of the Environment class.
+     * @summary Ensures only one instance of the Environment class exists.
+     * @template E
+     * @param {...unknown[]} args - Arguments to pass to the factory function if a new instance is created.
+     * @return {E} The singleton instance of the Environment class.
+     */
+    protected static instance<E extends Environment<any>>(...args: unknown[]): E;
+    /**
+     * @static
+     * @description Accumulates the given value into the environment.
+     * @summary Adds new properties to the environment from the provided object.
+     * @template V
+     * @param {V} value - The object to accumulate into the environment.
+     * @return {V} The updated environment instance.
+     */
+    static accumulate<V extends object>(value: V): typeof Environment._instance & V & ObjectAccumulator<typeof Environment._instance & V>;
+    /**
+     * @static
+     * @description Retrieves the keys of the environment, optionally converting them to ENV format.
+     * @summary Gets all keys in the environment, with an option to format them for environment variables.
+     * @param {boolean} [toEnv=true] - Whether to convert the keys to ENV format.
+     * @return {string[]} An array of keys from the environment.
+     */
+    static keys(toEnv?: boolean): string[];
+}