@powerlines/engine 0.45.2 → 0.46.0

package/dist/execution-context-CU6iNchD.d.cts

@@ -0,0 +1,631 @@
+import { BaseContext, Context, EmitEntryOptions, EmitOptions, EngineOptions, EnvironmentContext, EnvironmentResolvedConfig, ExecutionContext, ExecutionOptions, FetchOptions, InferOverridableConfig, LogFn, LogLevelResolvedConfig, LogMessage, Logger, LoggerOptions, MetaInfo, Mode, ParseOptions, ParsedTypeScriptConfig, ParsedUserConfig, Plugin, PluginContext, ResolveOptions, ResolveResult, ResolvedConfig, ResolvedEntryTypeDefinition, Resolver, TransformResult, UserConfig, VirtualFile, VirtualFileSystemInterface, WorkspaceConfig } from "@powerlines/core";
+import { DeepPartial, RequiredKeys } from "@stryke/types/base";
+import { Unstable_ContextInternal, Unstable_EnvironmentContext } from "@powerlines/core/types/_internal";
+import { EnvPaths } from "@stryke/env/get-env-paths";
+import { FlatCache } from "flat-cache";
+import { ParseResult } from "oxc-parser";
+import { Range } from "semver";
+import { RequestInfo, Response } from "undici";
+import { PackageJson } from "@stryke/types/package-json";
+
+//#region src/context/base-context.d.ts
+declare class PowerlinesBaseContext implements BaseContext {
+  #private;
+  /**
+   * The path to the Powerlines package
+   */
+  powerlinesPath: string;
+  /**
+   * The module resolver for the project
+   */
+  resolver: Resolver;
+  /**
+   * The options provided to the Powerlines process, resolved with default values and merged with any configuration provided by plugins or other sources. This is typically the final configuration used during the build process, but may also include additional options that are relevant to the context and its interactions with the Powerlines engine.
+   */
+  options: RequiredKeys<EngineOptions, "mode" | "cwd" | "root" | "framework">;
+  /**
+   * The parsed `package.json` file for the project
+   */
+  packageJson: PackageJson;
+  /**
+   * The parsed `project.json` file for the project
+   */
+  projectJson: Record<string, any> | undefined;
+  /**
+   * The parsed configuration file for the project
+   */
+  configFile: ParsedUserConfig;
+  /**
+   * The logger instance for the context, which can be used to create log messages with consistent formatting and metadata. This logger is extended by plugin contexts to include additional metadata such as the plugin name and category, which can be used to filter and format log messages in a more granular way.
+   */
+  get logger(): Logger;
+  /**
+   * A timestamp representing when the context was initialized
+   */
+  get timestamp(): number;
+  get logLevel(): LogLevelResolvedConfig;
+  /**
+   * The environment paths for the project
+   */
+  get envPaths(): EnvPaths;
+  /**
+   * Creates a clone of the current context with the same configuration and workspace settings. This can be useful for running multiple builds in parallel or for creating isolated contexts for different parts of the build process.
+   *
+   * @remarks
+   * The cloned context will have the same configuration and workspace settings as the original context, but will have a different build ID, release ID, and timestamp. The virtual file system and caches will also be separate between the original and cloned contexts.
+   *
+   * @returns A promise that resolves to the cloned context.
+   */
+  clone(): Promise<BaseContext>;
+  /**
+   * A logging function for fatal messages
+   *
+   * @param message - The message to log.
+   */
+  fatal(message: string | LogMessage): void;
+  /**
+   * A logging function for error messages
+   *
+   * @param message - The message to log.
+   */
+  error(message: string | LogMessage): void;
+  /**
+   * A logging function for warning messages
+   *
+   * @param message - The message to log.
+   */
+  warn(message: string | LogMessage): void;
+  /**
+   * A logging function for informational messages
+   *
+   * @param message - The message to log.
+   */
+  info(message: string | LogMessage): void;
+  /**
+   * A logging function for debug messages
+   *
+   * @param message - The message to log.
+   */
+  debug(message: string | LogMessage): void;
+  /**
+   * A logging function for trace messages
+   *
+   * @param message - The message to log.
+   */
+  trace(message: string | LogMessage): void;
+  /**
+   * A function to create a timer for measuring the duration of asynchronous operations
+   *
+   * @example
+   * ```ts
+   * const stopTimer = context.timer("Your Async Operation");
+   * await performAsyncOperation();
+   * stopTimer(); // "Your Async Operation completed in 123.45 milliseconds"
+   * ```
+   *
+   * @param name - The name of the timer.
+   * @returns A function that, when called, stops the timer and logs the duration.
+   */
+  timer(name: string): () => void;
+  /**
+   * Create a new logger instance
+   *
+   * @param options - The configuration options to use for the logger instance, which can be used to customize the appearance and behavior of the log messages generated by the logger. This is typically the name of the plugin or module that is creating the logger instance.
+   * @param logFn - The custom logging function to use for logging messages, which can be used to override the default logging behavior of the original logger.
+   * @returns A logger client instance that can be used to generate log messages with consistent formatting and metadata.
+   */
+  createLogger(options: LoggerOptions, logFn?: LogFn): Logger;
+  /**
+   * Extend the base logger with additional configuration options
+   *
+   * @param options - The configuration options to extend the base logger with, which can be used to add additional metadata or customize the appearance of log messages generated by the logger. This is typically the name of the plugin or module that is creating the logger instance, as well as any additional metadata such as the plugin category or environment.
+   * @returns A new logger client instance that extends the base logger with the provided configuration options.
+   */
+  extendLogger(options: LoggerOptions): Logger;
+  /**
+   * The input options used to initialize the context, which may be used when cloning the context to ensure the same configuration is applied to the new context
+   */
+  protected initialOptions: EngineOptions;
+  /**
+   * The initial configuration provided when initializing the context, which may be used during the setup process to ensure that the configuration is properly merged and applied to the context. This is typically the user configuration provided in the Powerlines configuration file, but may also include additional configuration options provided by plugins or other sources.
+   */
+  protected initialConfig: DeepPartial<UserConfig>;
+  /**
+   * Initialize the context with the provided configuration options and set up the resolver and user configuration file. This method is called during the construction of the context and can also be called when cloning the context to ensure that the new context has the same configuration and resolver setup as the original context.
+   *
+   * @param options - The configuration options to initialize the context with, which can include properties such as the project root, mode, log level, and other settings that affect the behavior of the context and its plugins.
+   * @param initialConfig - The initial configuration to initialize the context with, which is typically the user configuration provided in the Powerlines configuration file. This can also include additional configuration options provided by plugins or other sources that should be merged with the user configuration during initialization
+   */
+  protected constructor(options: EngineOptions, initialConfig?: DeepPartial<UserConfig>);
+  /**
+   * Retrieve the workspace configuration for the current project, if it exists. This function will look for a configuration file in the project root and return its contents as a JavaScript object. If no configuration file is found, it will return undefined.
+   *
+   * @returns A promise that resolves to the workspace configuration object, or undefined if no configuration file is found.
+   */
+  protected getWorkspaceConfig(): Promise<WorkspaceConfig | undefined>;
+  /**
+   * Initialize the context with the provided configuration options
+   *
+   * @remarks
+   * This method will set up the resolver and load the user configuration file based on the provided options. It is called during the construction of the context and can also be called when cloning the context to ensure that the new context has the same configuration and resolver setup.
+   */
+  protected init(): Promise<void>;
+  /**
+   * Determine the default mode for the current execution based on the environment and workspace configuration. This function will check the `NODE_ENV` environment variable to determine if the current environment is development, production, or test. If `NODE_ENV` is not set, it will look for a `mode` property in the workspace configuration file. If no mode is specified in the workspace configuration, it will default to "production".
+   *
+   * @returns A promise that resolves to the default mode for the current execution, which can be "development", "production", or "test".
+   */
+  protected getDefaultMode(): Promise<Mode>;
+  /**
+   * Determine the default log level for the current execution based on the environment and workspace configuration. This function will check the `logLevel` property in the workspace configuration file and resolve it to a `LogLevelResolvedConfig` value. If no log level is specified in the workspace configuration, it will default to "info" for development mode and "warn" for production mode.
+   *
+   * @returns A promise that resolves to the default log level for the current execution, which can be "fatal", "error", "warn", "info", "debug", or "trace".
+   */
+  protected getDefaultLogLevel(): Promise<LogLevelResolvedConfig>;
+}
+//#endregion
+//#region src/context/context.d.ts
+declare class PowerlinesContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig> extends PowerlinesBaseContext implements Context<TResolvedConfig> {
+  #private;
+  /**
+   * Create a new context from the workspace root and user config.
+   *
+   * @param options - The options for resolving the context.
+   * @returns A promise that resolves to the new context.
+   */
+  static fromInitialConfig<TResolvedConfig extends ResolvedConfig = ResolvedConfig>(options: ExecutionOptions, initialConfig: TResolvedConfig["initialConfig"]): Promise<PowerlinesContext<TResolvedConfig>>;
+  /**
+   * The options provided to the Powerlines process, resolved with default values and merged with any configuration provided by plugins or other sources. This is typically the final configuration used during the build process, but may also include additional options that are relevant to the context and its interactions with the Powerlines engine.
+   */
+  options: RequiredKeys<ExecutionOptions, "mode" | "cwd" | "root" | "framework" | "logLevel">;
+  /**
+   * An object containing the dependencies that should be installed for the project
+   */
+  dependencies: Record<string, string | Range>;
+  /**
+   * An object containing the development dependencies that should be installed for the project
+   */
+  devDependencies: Record<string, string | Range>;
+  /**
+   * The persisted meta information about the current build
+   */
+  persistedMeta: MetaInfo | undefined;
+  /**
+   * The resolved tsconfig file paths for the project
+   */
+  resolvePatterns: RegExp[];
+  /**
+   * The input options used to initialize the context, which may be used when cloning the context to ensure the same configuration is applied to the new context
+   */
+  protected initialOptions: ExecutionOptions;
+  /**
+   * The resolved configuration for this context
+   */
+  protected resolvedConfig: TResolvedConfig;
+  /**
+   * The configuration options that were overridden by plugins during the build process, which may include additional properties or modifications made during the configuration loading process.
+   */
+  protected overriddenConfig: InferOverridableConfig<TResolvedConfig>;
+  /**
+   * The configuration options provided inline during execution, such as CLI flags or other parameters that may be relevant to the command being executed. These options can be used to override or supplement the configuration options defined in a configuration file on disk, and are typically provided as part of the execution context when running a Powerlines command.
+   */
+  protected inlineConfig: TResolvedConfig["inlineConfig"];
+  /**
+   * The configuration options read from a configuration file on disk, which may be used to resolve the final configuration for the context. This typically includes the user configuration options defined in the `powerlines.config.ts` file, as well as any inline configuration options provided during execution.
+   */
+  protected userConfig: TResolvedConfig["userConfig"];
+  /**
+   * The configuration options provided by plugins added by the user (and other plugins)
+   */
+  protected pluginConfig: TResolvedConfig["pluginConfig"];
+  /**
+   * The resolved entry type definitions for the project
+   */
+  get entry(): ResolvedEntryTypeDefinition[];
+  /**
+   * The TypeScript configuration parsed from the tsconfig file
+   */
+  get tsconfig(): ParsedTypeScriptConfig;
+  /**
+   * Sets the TypeScript configuration parsed from the tsconfig file
+   */
+  set tsconfig(value: ParsedTypeScriptConfig);
+  /**
+   * The virtual file system interface for the project
+   */
+  get fs(): VirtualFileSystemInterface;
+  /**
+   * Get the checksum of the project's current state
+   */
+  get checksum(): string | null;
+  /**
+   * The meta information about the current build
+   */
+  get meta(): MetaInfo;
+  /**
+   * The resolved configuration options
+   */
+  get config(): TResolvedConfig;
+  /**
+   * Get the path to the artifacts directory for the project
+   */
+  get artifactsPath(): string;
+  /**
+   * Get the path to the builtin modules used by the project
+   */
+  get builtinsPath(): string;
+  /**
+   * Get the path to the entry directory for the project
+   */
+  get entryPath(): string;
+  /**
+   * Get the path to the infrastructure modules used by the project
+   */
+  get infrastructurePath(): string;
+  /**
+   * Get the path to the data directory for the project
+   */
+  get dataPath(): string;
+  /**
+   * Get the path to the cache directory for the project
+   */
+  get cachePath(): string;
+  /**
+   * Get the path to the generated declaration file for the project
+   */
+  get typesPath(): string;
+  /**
+   * Get the project root relative to the workspace root
+   */
+  get relativeToWorkspaceRoot(): string;
+  /**
+   * The builtin module id that exist in the Powerlines virtual file system
+   */
+  get builtins(): string[];
+  /**
+   * Additional arguments provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed.
+   */
+  get additionalArgs(): Record<string, string | string[]>;
+  /**
+   * The alias mappings for the project used during module resolution
+   *
+   * @remarks
+   * This includes both the built-in module aliases as well as any custom aliases defined in the build configuration.
+   */
+  get alias(): Record<string, string>;
+  /**
+   * The log level for the context, which determines the minimum level of log messages that will be emitted by the logger. This is resolved based on the configuration options provided by the user, and can be set to different levels for development, production, and test environments. The log level can also be overridden by plugins or other parts of the build process to provide more granular control over logging output.
+   */
+  get logLevel(): LogLevelResolvedConfig;
+  /**
+   * The environment paths for the project, which provide the locations of various directories and files used by the Powerlines framework. These paths are resolved based on the organization ID, application ID, and workspace root directory, and can be used to access configuration files, cache directories, and other resources in a consistent manner.
+   */
+  get envPaths(): EnvPaths;
+  /**
+   * Gets the parser cache.
+   */
+  protected get parserCache(): FlatCache;
+  /**
+   * Gets the request cache.
+   */
+  protected get requestCache(): FlatCache;
+  /**
+   * The entry points that exist in the Powerlines virtual file system
+   */
+  protected get resolvedEntry(): ResolvedEntryTypeDefinition[];
+  /**
+   * Creates a new Context instance.
+   *
+   * @param options - The options to use for creating the context, including the resolved configuration and workspace settings.
+   * @param initialConfig - The initial configuration provided by the user, which can be used to resolve the final configuration for the context. This typically includes the user configuration options defined in the `powerlines.config.ts` file, as well as any inline configuration options provided during execution.
+   */
+  protected constructor(options: ExecutionOptions, initialConfig: TResolvedConfig["initialConfig"]);
+  /**
+   * Create a new logger instance
+   *
+   * @param options - The configuration options to use for the logger instance, which can be used to customize the appearance and behavior of the log messages generated by the logger. This is typically the name of the plugin or module that is creating the logger instance.
+   * @param logFn - The custom logging function to use for logging messages, which can be used to override the default logging behavior of the original logger.
+   * @returns A logger client instance that can be used to generate log messages with consistent formatting and metadata.
+   */
+  createLogger(options: LoggerOptions, logFn?: LogFn): Logger;
+  /**
+   * A function to perform HTTP fetch requests
+   *
+   * @remarks
+   * This function uses a caching layer to avoid duplicate requests during the Powerlines process.
+   *
+   * @example
+   * ```ts
+   * const response = await context.fetch("https://api.example.com/data");
+   * const data = await response.json();
+   * ```
+   *
+   * @see https://github.com/nodejs/undici
+   *
+   * @param input - The URL to fetch.
+   * @param options - The fetch request options.
+   * @returns A promise that resolves to a response returned by the fetch.
+   */
+  fetch(input: RequestInfo, options?: FetchOptions): Promise<Response>;
+  /**
+   * Parse code using [Oxc-Parser](https://github.com/oxc/oxc) into an (ESTree-compatible)[https://github.com/estree/estree] AST object.
+   *
+   * @remarks
+   * This function can be used to parse TypeScript code into an AST for further analysis or transformation.
+   *
+   * @example
+   * ```ts
+   * const ast = context.parse("const x: number = 42;");
+   * ```
+   *
+   * @see https://rollupjs.org/plugin-development/#this-parse
+   * @see https://github.com/oxc/oxc
+   *
+   * @param code - The source code to parse.
+   * @param options - The options to pass to the parser.
+   * @returns An (ESTree-compatible)[https://github.com/estree/estree] AST object.
+   */
+  parse(code: string, options?: ParseOptions): Promise<ParseResult>;
+  /**
+   * A helper function to resolve modules in the Virtual File System
+   *
+   * @remarks
+   * This function can be used to resolve modules relative to the project root directory.
+   *
+   * @example
+   * ```ts
+   * const resolved = await context.resolve("some-module", "/path/to/importer");
+   * ```
+   *
+   * @param id - The module to resolve.
+   * @param importer - An optional path to the importer module.
+   * @param options - Additional resolution options.
+   * @returns A promise that resolves to the resolved module path.
+   */
+  resolve(id: string, importer?: string, options?: ResolveOptions): Promise<ResolveResult | undefined>;
+  /**
+   * A helper function to load modules from the Virtual File System
+   *
+   * @remarks
+   * This function can be used to load modules relative to the project root directory.
+   *
+   * @example
+   * ```ts
+   * const module = await context.load("some-module", "/path/to/importer");
+   * ```
+   *
+   * @param id - The module to load.
+   * @returns A promise that resolves to the loaded module.
+   */
+  load(id: string): Promise<TransformResult | undefined>;
+  /**
+   * Get the builtin virtual files that exist in the Powerlines virtual file system
+   */
+  getBuiltins(): Promise<VirtualFile[]>;
+  /**
+   * Resolves a file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the file
+   * @param path - The path to write the file to
+   * @param options - Additional options for writing the file
+   */
+  emit(code: string, path: string, options?: EmitOptions): Promise<void>;
+  /**
+   * Synchronously resolves a file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the file
+   * @param path - The path to write the file to
+   * @param options - Additional options for writing the file
+   */
+  emitSync(code: string, path: string, options?: EmitOptions): void;
+  /**
+   * Resolves a entry virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the entry file
+   * @param path - A path to write the entry file to
+   * @param options - Optional write file options
+   */
+  emitEntry(code: string, path: string, options?: EmitEntryOptions): Promise<void>;
+  /**
+   * Synchronously resolves a entry virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the entry file
+   * @param path - A path to write the entry file to
+   * @param options - Optional write file options
+   */
+  emitEntrySync(code: string, path: string, options?: EmitEntryOptions): void;
+  /**
+   * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the builtin file
+   * @param id - The unique identifier of the builtin file
+   * @param options - Optional write file options
+   */
+  emitBuiltin(code: string, id: string, options?: EmitOptions): Promise<void>;
+  /**
+   * Synchronously resolves a builtin virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the builtin file
+   * @param id - The unique identifier of the builtin file
+   * @param options - Optional write file options
+   */
+  emitBuiltinSync(code: string, id: string, options?: EmitOptions): void;
+  /**
+   * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the builtin file
+   * @param id - The unique identifier of the builtin file
+   * @param options - Optional write file options
+   */
+  emitInfrastructure(code: string, id: string, options?: EmitOptions): Promise<void>;
+  /**
+   * Synchronously resolves an infrastructure virtual file and writes it to the VFS if it does not already exist
+   *
+   * @param code - The source code of the infrastructure file
+   * @param id - The unique identifier of the infrastructure file
+   * @param options - Optional write file options
+   */
+  emitInfrastructureSync(code: string, id: string, options?: EmitOptions): void;
+  /**
+   * Generates a checksum representing the current context state
+   *
+   * @param path - The root directory of the project to generate the checksum for
+   * @returns A promise that resolves to a string representing the checksum
+   */
+  generateChecksum(path?: string): Promise<string>;
+  /**
+   * A setter function to populate the inline config values provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed. This function can be used to update the context with the inline configuration values, which may be used during the configuration resolution process to ensure that the final configuration reflects both the user configuration and any inline configuration provided during execution.
+   *
+   * @param config - The inline configuration values to set.
+   * @returns A promise that resolves when the inline configuration values have been set.
+   */
+  setInlineConfig(config: TResolvedConfig["inlineConfig"]): Promise<void>;
+  /**
+   * A setter function to populate the plugin config values provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed. This function can be used to update the context with the plugin configuration values, which may be used during the configuration resolution process to ensure that the final configuration reflects both the user configuration and any plugin configuration provided during execution.
+   *
+   * @param config - The plugin configuration values to set.
+   * @returns A promise that resolves when the plugin configuration values have been set.
+   */
+  setPluginConfig(config: TResolvedConfig["pluginConfig"]): Promise<void>;
+  /**
+   * A function to merge the various configuration objects (initial, user, inline, and plugin) into a single resolved configuration object that can be used throughout the Powerlines process. This function takes into account the different sources of configuration and their respective priorities, ensuring that the final configuration reflects the intended settings for the project. The merged configuration is then returned as a new object that can be accessed through the `config` property of the context.
+   *
+   * @returns The merged configuration object that combines the initial, user, inline, and plugin configurations.
+   */
+  protected mergeConfig(): TResolvedConfig;
+  /**
+   * A setter function to populate the user config values provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed. This function can be used to update the context with the user configuration values, which may be used during the configuration resolution process to ensure that the final configuration reflects both the user configuration and any inline configuration provided during execution.
+   *
+   * @param config - The user configuration values to set.
+   * @returns A promise that resolves when the user configuration values have been set.
+   */
+  protected setUserConfig(config: TResolvedConfig["userConfig"]): Promise<void>;
+  /**
+   * Initialize the context with the provided configuration options
+   */
+  protected init(): Promise<void>;
+  /**
+   * Initialize the context with the provided configuration options
+   */
+  protected resolveConfig(): Promise<void>;
+  protected logConfig(config: TResolvedConfig | TResolvedConfig["initialConfig"] | TResolvedConfig["userConfig"] | TResolvedConfig["inlineConfig"] | TResolvedConfig["pluginConfig"]): string;
+  private createConfigProxy;
+}
+//#endregion
+//#region src/context/execution-context.d.ts
+declare class PowerlinesExecutionContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig> extends PowerlinesContext<TResolvedConfig> implements ExecutionContext<TResolvedConfig> {
+  #private;
+  /**
+   * Create a new Storm context from the workspace root and user config.
+   *
+   * @param options - The options for resolving the context.
+   * @returns A promise that resolves to the new context.
+   */
+  static fromInitialConfig<TResolvedConfig extends ResolvedConfig = ResolvedConfig>(options: ExecutionOptions, initialConfig: TResolvedConfig["initialConfig"]): Promise<PowerlinesExecutionContext<TResolvedConfig>>;
+  /**
+   * Create a new Storm context from the workspace root and user config.
+   *
+   * @param options - The options for resolving the context.
+   * @returns A promise that resolves to the new context.
+   */
+  static fromInlineConfig<TResolvedConfig extends ResolvedConfig = ResolvedConfig>(options: ExecutionOptions, initialConfig: TResolvedConfig["initialConfig"], inlineConfig: TResolvedConfig["inlineConfig"]): Promise<PowerlinesExecutionContext<TResolvedConfig>>;
+  /**
+   * Internal context fields and methods
+   *
+   * @danger
+   * This field is for internal use only and should not be accessed or modified directly. It is unstable and can be changed at anytime.
+   *
+   * @internal
+   */
+  get $$internal(): Unstable_ContextInternal<TResolvedConfig>;
+  /**
+   * Internal context fields and methods
+   *
+   * @danger
+   * This field is for internal use only and should not be accessed or modified directly. It is unstable and can be changed at anytime.
+   *
+   * @internal
+   */
+  set $$internal(value: Unstable_ContextInternal<TResolvedConfig>);
+  /**
+   * The unique identifier of the execution context, which can be used for logging and other purposes to distinguish between different executions in the same process.
+   */
+  get id(): string;
+  /**
+   * A record of all environments by name
+   */
+  get environments(): Record<string, Unstable_EnvironmentContext<TResolvedConfig>>;
+  get plugins(): Array<Plugin<PluginContext<TResolvedConfig>>>;
+  /**
+   * Creates a new instance.
+   *
+   * @param options - The options to use for creating the context, including the resolved configuration and workspace settings.
+   * @param initialConfig - The initial configuration options to use for the context, which can be used to provide default values for configuration options that may be overridden by user configuration or inline configuration. This is typically the configuration options provided by the user in a configuration file on disk, and can include any relevant settings such as environment definitions, plugin configurations, and other parameters that may be relevant to the execution of a Powerlines command.
+   */
+  protected constructor(options: ExecutionOptions, initialConfig?: TResolvedConfig["initialConfig"]);
+  /**
+   * A setter function to populate the inline config values provided during execution of the command, such as CLI flags or other parameters that may be relevant to the command being executed. This function can be used to update the context with the inline configuration values, which may be used during the configuration resolution process to ensure that the final configuration reflects both the user configuration and any inline configuration provided during execution.
+   *
+   * @param config - The inline configuration values to set.
+   * @returns A promise that resolves when the inline configuration values have been set.
+   */
+  setInlineConfig(config: TResolvedConfig["inlineConfig"]): Promise<void>;
+  /**
+   * Create a new logger instance
+   *
+   * @param options - The configuration options to use for the logger instance, which can be used to customize the appearance and behavior of the log messages generated by the logger. This is typically the name of the plugin or module that is creating the logger instance.
+   * @param logFn - The custom logging function to use for logging messages, which can be used to override the default logging behavior of the original logger.
+   * @returns A logger client instance that can be used to generate log messages with consistent formatting and metadata.
+   */
+  createLogger(options: LoggerOptions, logFn?: LogFn): Logger;
+  /**
+   * Extend the base logger with additional configuration options
+   *
+   * @param options - The configuration options to extend the base logger with, which can be used to add additional metadata or customize the appearance of log messages generated by the logger. This is typically the name of the plugin or module that is creating the logger instance, as well as any additional metadata such as the plugin category or environment.
+   * @returns A new logger client instance that extends the base logger with the provided configuration options.
+   */
+  extendLogger(options: LoggerOptions): Logger;
+  /**
+   * A function to copy the context and update the fields for a specific environment
+   *
+   * @param environment - The environment configuration to use.
+   * @returns A new context instance with the updated environment.
+   */
+  createEnvironment(environment: EnvironmentResolvedConfig<TResolvedConfig>["environment"]): Promise<Unstable_EnvironmentContext<TResolvedConfig>>;
+  /**
+   * Update the context using a new inline configuration options
+   */
+  resolveConfig(): Promise<void>;
+  /**
+   * Add a plugin to the API context and all environments
+   *
+   * @param plugin - The plugin to add.
+   */
+  addPlugin(plugin: Plugin<PluginContext<TResolvedConfig>>): Promise<void>;
+  /**
+   * Get an environment by name, or the default environment if no name is provided
+   *
+   * @param name - The name of the environment to retrieve.
+   * @returns The requested environment context.
+   */
+  getEnvironment(name?: string): Promise<EnvironmentContext<TResolvedConfig>>;
+  /**
+   * A safe version of `getEnvironment` that returns `undefined` if the environment is not found
+   *
+   * @param name - The name of the environment to retrieve.
+   * @returns The requested environment context or `undefined` if not found.
+   */
+  getEnvironmentSafe(name?: string): Promise<EnvironmentContext<TResolvedConfig> | undefined>;
+  /**
+   * A function to merge all configured environments into a single context.
+   *
+   * @remarks
+   * If only one environment is configured, that environment will be returned directly.
+   *
+   * @returns A promise that resolves to a merged/global environment context.
+   */
+  toEnvironment(): Promise<EnvironmentContext<TResolvedConfig>>;
+}
+//#endregion
+export { PowerlinesContext as n, PowerlinesBaseContext as r, PowerlinesExecutionContext as t };
+//# sourceMappingURL=execution-context-CU6iNchD.d.cts.map

package/dist/execution-context-CU6iNchD.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution-context-CU6iNchD.d.cts","names":[],"sources":["../src/context/base-context.ts","../src/context/context.ts","../src/context/execution-context.ts"],"mappings":";;;;;;;;;;;cA6Da,qBAAA,YAAiC,WAAA;EAAA;;;;EAMrC,cAAA;;AANT;;EAWS,QAAA,EAAW,QAAA;EAAA;;;EAKX,OAAA,EAAU,YAAA,CACf,aAAA;EAYkB;;;EALb,WAAA,EAAc,WAAA;EAiCE;;;EA5BhB,WAAA,EAAa,MAAA;EAiEW;;;EA5DxB,UAAA,EAAa,gBAAA;EAgGW;;;EAAA,IA3FpB,MAAA,CAAA,GAAU,MAAA;EAoJQ;;;EAAA,IA7IlB,SAAA,CAAA;EAAA,IAIA,QAAA,CAAA,GAAY,sBAAA;EA8JZ;;;EAAA,IAvJA,QAAA,CAAA,GAAY,QAAA;EAmKe;;;;;;;;EAnJzB,KAAA,CAAA,GAAS,OAAA,CAAQ,WAAA;EAzEc;;;;;EAqFrC,KAAA,CAAM,OAAA,WAAkB,UAAA;EArEd;;;;;EA8EV,KAAA,CAAM,OAAA,WAAkB,UAAA;EA5DxB;;;;;EAqEA,IAAA,CAAK,OAAA,WAAkB,UAAA;EArDP;;;;;EA8DhB,IAAA,CAAK,OAAA,WAAkB,UAAA;EA3BvB;;;;;EAoCA,KAAA,CAAM,OAAA,WAAkB,UAAA;EAlBxB;;;;;EA2BA,KAAA,CAAM,OAAA,WAAkB,UAAA;EATxB;;;;;;;;;;;;;EA0BA,KAAA,CAAM,IAAA;EAwCN;;;;;;;EAdA,YAAA,CAAa,OAAA,EAAS,aAAA,EAAe,KAAA,GAAQ,KAAA,GAAQ,MAAA;EA0BvB;;;;;;EAZ9B,YAAA,CAAa,OAAA,EAAS,aAAA,GAAgB,MAAA;EAiC7B;;;EAAA,UA1BN,cAAA,EAAgB,aAAA;EAkDN;;;EAAA,UA7CV,aAAA,EAAe,WAAA,CAAY,UAAA;EA+KrB;;;;;;EAAA,UAvKP,WAAA,CACP,OAAA,EAAS,aAAA,EACT,aAAA,GAAe,WAAA,CAAY,UAAA;;ACrI/B;;;;YDgJkB,kBAAA,CAAA,GAAsB,OAAA,CAAQ,eAAA;EC5I3B;;;;;;EAAA,UDoKH,IAAA,CAAA,GAAI,OAAA;ECvIjB;;;;;EAAA,UDwPa,cAAA,CAAA,GAAkB,OAAA,CAAQ,IAAA;EC3NlB;;;;;EAAA,UD4OR,kBAAA,CAAA,GAAsB,OAAA,CAAQ,sBAAA;AAAA;;;cC1SnC,iBAAA,yBACa,cAAA,GAAiB,cAAA,UAEjC,qBAAA,YACG,OAAA,CAAQ,eAAA;EAAA;EDhFR;;;;;;EAAA,OCwGS,iBAAA,yBACM,cAAA,GAAiB,cAAA,CAAA,CAEzC,OAAA,EAAS,gBAAA,EACT,aAAA,EAAe,eAAA,oBACd,OAAA,CAAQ,iBAAA,CAAkB,eAAA;EDhFT;;;EC6FJ,OAAA,EAAS,YAAA,CACvB,gBAAA;EDlEqB;;;EC4EhB,YAAA,EAAc,MAAA,kBAAwB,KAAA;EDvCd;;;EC4CxB,eAAA,EAAiB,MAAA,kBAAwB,KAAA;EDRjB;;;ECaxB,aAAA,EAAe,QAAA;ED4CO;;;ECvCtB,eAAA,EAAiB,MAAA;EDmDC;;;EAAA,UC9CN,cAAA,EAAgB,gBAAA;EDmEW;;;EAAA,UC9DpC,cAAA,EAAgB,eAAA;EDuMQ;;;EAAA,UClMxB,gBAAA,EAAkB,sBAAA,CAAuB,eAAA;EDnKI;;;EAAA,UCyK7C,YAAA,EAAc,eAAA;EDnKjB;;;EAAA,UCyKG,UAAA,EAAY,eAAA;ED/JL;;;EAAA,UCqKP,YAAA,EAAc,eAAA;EDxJjB;;;EAAA,IC6JI,KAAA,CAAA,GAAS,2BAAA;EDnJT;;;EAAA,ICqKA,QAAA,CAAA,GAAY,sBAAA;ED1JA;;;EAAA,ICuKZ,QAAA,CAAS,KAAA,EAAO,sBAAA;EDhJL;;;EAAA,ICwJX,EAAA,CAAA,GAAM,0BAAA;ED5IJ;;;EAAA,ICuJF,QAAA,CAAA;EDrIJ;;;EAAA,IC4II,IAAA,CAAA,GAkBJ,QAAA;EDrJuB;;;EAAA,IC2JnB,MAAA,CAAA,GAAU,eAAA;EDlJR;;;EAAA,IC6JF,aAAA,CAAA;EDnIJ;;;EAAA,IC+II,YAAA,CAAA;EDrHS;;;EAAA,IC4HT,SAAA,CAAA;ED9GJ;;;EAAA,ICqHI,kBAAA,CAAA;ED9GD;;;EAAA,ICqHC,QAAA,CAAA;EDhH0B;;;EAAA,IC2H1B,SAAA,CAAA;EDjHM;;;EAAA,ICoIN,SAAA,CAAA;EDzH2B;;;EAAA,ICkI3B,uBAAA,CAAA;EDOK;;;EAAA,ICAL,QAAA,CAAA;EDiB2B;;;EAAA,ICP3B,cAAA,CAAA,GAAkB,MAAA;;;;AAnS/B;;;MAoUa,KAAA,CAAA,GAAS,MAAA;EAnUqB;;;EAAA,IAsWrB,QAAA,CAAA,GAAY,sBAAA;EAxUrB;;;EAAA,IA+US,QAAA,CAAA,GAAY,QAAA;EA7U7B;;;EAAA,cAwVW,WAAA,CAAA,GAAe,SAAA;EAhUR;;;EAAA,cAiVP,YAAA,CAAA,GAAgB,SAAA;EAlUN;;;EAAA,cAmVV,aAAA,CAAA,GAAiB,2BAAA;EApUH;;;;;;EAAA,UA+WnB,WAAA,CACP,OAAA,EAAS,gBAAA,EACT,aAAA,EAAe,eAAA;EAnTA;;;;;;;EAiUD,YAAA,CAAa,OAAA,EAAS,aAAA,EAAe,KAAA,GAAQ,KAAA,GAAQ,MAAA;EA5EvC;;;;;;;;;;;;;;;;;;EA0HjB,KAAA,CACX,KAAA,EAAO,WAAA,EACP,OAAA,GAAS,YAAA,GACR,OAAA,CAAQ,QAAA;EAoRa;;;;;;;;;;;;;;;;;;EA3LX,KAAA,CAAM,IAAA,UAAc,OAAA,GAAS,YAAA,GAAiB,OAAA,CAAA,WAAA;EAmgBlC;;;;;;;;;;;;;;;;EAxdZ,OAAA,CACX,EAAA,UACA,QAAA,WACA,OAAA,GAAS,cAAA,GACR,OAAA,CAAQ,aAAA;EA5oBH;;;;;;;;;;;;;;EAuwBK,IAAA,CAAK,EAAA,WAAa,OAAA,CAAQ,eAAA;EA5tBvB;;;EA6uBH,WAAA,CAAA,GAAW,OAAA,CAAA,WAAA;EAluBH;;;;;;;EAsvBR,IAAA,CACX,IAAA,UACA,IAAA,UACA,OAAA,GAAS,WAAA,GACR,OAAA;EA3uBqB;;;;;;;EA+wBjB,QAAA,CAAS,IAAA,UAAc,IAAA,UAAc,OAAA,GAAS,WAAA;EA1vB3C;;;;;;;EA8xBG,SAAA,CACX,IAAA,UACA,IAAA,UACA,OAAA,GAAS,gBAAA,GACR,OAAA;EA/vBQ;;;;;;;EA4xBJ,aAAA,CACL,IAAA,UACA,IAAA,UACA,OAAA,GAAS,gBAAA;EAxvBA;;;;;;;EAsxBE,WAAA,CACX,IAAA,UACA,EAAA,UACA,OAAA,GAAS,WAAA,GACR,OAAA;EAttBQ;;;;;;;EAivBJ,eAAA,CAAgB,IAAA,UAAc,EAAA,UAAY,OAAA,GAAS,WAAA;EAxpBtC;;;;;;;EAmrBP,kBAAA,CACX,IAAA,UACA,EAAA,UACA,OAAA,GAAS,WAAA,GACR,OAAA;EAjnB2B;;;;;;;EA4oBvB,sBAAA,CACL,IAAA,UACA,EAAA,UACA,OAAA,GAAS,WAAA;EAnkBK;;;;;;EA8lBH,gBAAA,CAAiB,IAAA,YAAgB,OAAA;EA/iBrC;;;;;;EA2jBI,eAAA,CACX,MAAA,EAAQ,eAAA,mBACP,OAAA;EAlegB;;;;;;EAkfN,eAAA,CACX,MAAA,EAAQ,eAAA,mBACP,OAAA;EAvcD;;;;;EAAA,UAsdQ,WAAA,CAAA,GAAe,eAAA;EAzVP;;;;;;EAAA,UA4XF,aAAA,CACd,MAAA,EAAQ,eAAA,iBACP,OAAA;EAxVD;;;EAAA,UAqWuB,IAAA,CAAA,GAAI,OAAA;EAlW1B;;;EAAA,UAiYa,aAAA,CAAA,GAAiB,OAAA;EAAA,UA2SvB,SAAA,CACR,MAAA,EACI,eAAA,GACA,eAAA,oBACA,eAAA,iBACA,eAAA,mBACA,eAAA;EAAA,QAwBE,iBAAA;AAAA;;;cCplDG,0BAAA,yBACa,cAAA,GAAiB,cAAA,UAEjC,iBAAA,CAAkB,eAAA,aACf,gBAAA,CAAiB,eAAA;EAAA;;;;;;AFO9B;SEsB+B,iBAAA,yBACH,cAAA,GAAiB,cAAA,CAAA,CAEzC,OAAA,EAAS,gBAAA,EACT,aAAA,EAAe,eAAA,oBACd,OAAA,CAAQ,0BAAA,CAA2B,eAAA;;;;;;;SAgBlB,gBAAA,yBACM,cAAA,GAAiB,cAAA,CAAA,CAEzC,OAAA,EAAS,gBAAA,EACT,aAAA,EAAe,eAAA,mBACf,YAAA,EAAc,eAAA,mBACb,OAAA,CAAQ,0BAAA,CAA2B,eAAA;EFVjB;;;;;;;;EAAA,IE6BV,UAAA,CAAA,GAAc,wBAAA,CAAyB,eAAA;EFqDnB;;;;;;;;EAAA,IEzCpB,UAAA,CAAW,KAAA,EAAO,wBAAA,CAAyB,eAAA;EFuH7B;;;EAAA,IE5Gd,EAAA,CAAA;EFiImC;;;EAAA,IE1HnC,YAAA,CAAA,GAAgB,MAAA,SAEzB,2BAAA,CAA4B,eAAA;EAAA,IAKnB,OAAA,CAAA,GAAW,KAAA,CAAM,MAAA,CAAO,aAAA,CAAc,eAAA;EF6QH;;;;;;EAAA,UEnQrC,WAAA,CACP,OAAA,EAAS,gBAAA,EACT,aAAA,GAAe,eAAA;EF/GV;;;;;;EE4He,eAAA,CACpB,MAAA,EAAQ,eAAA,mBACP,OAAA;EF5GkB;;;;;;;EEsIL,YAAA,CAAa,OAAA,EAAS,aAAA,EAAe,KAAA,GAAQ,KAAA,GAAQ,MAAA;EF5G1D;;;;;;EE6HK,YAAA,CAAa,OAAA,EAAS,aAAA,GAAgB,MAAA;EF1F/C;;;;;;EEwGM,iBAAA,CACX,WAAA,EAAa,yBAAA,CAA0B,eAAA,mBACtC,OAAA,CAAQ,2BAAA,CAA4B,eAAA;EFxFT;;;EEkIR,aAAA,CAAA,GAAa,OAAA;EFzHvB;;;;;EE+IC,SAAA,CAAU,MAAA,EAAQ,MAAA,CAAO,aAAA,CAAc,eAAA,KAAiB,OAAA;EF7HxD;;;;;;EE6IA,cAAA,CAAe,IAAA,YAAa,OAAA,CAAA,kBAAA,CAAA,eAAA;EFlGG;;;;;;EE0J/B,kBAAA,CACX,IAAA,YACC,OAAA,CAAQ,kBAAA,CAAmB,eAAA;EFvIJ;;;;;;;;EEuJb,aAAA,CAAA,GAAiB,OAAA,CAAQ,kBAAA,CAAmB,eAAA;AAAA"}