@powerlines/core 0.48.32 → 0.48.33

package/dist/types/config.d.cts

@@ -0,0 +1,739 @@
+import { StoragePort, StoragePreset } from "./fs.cjs";
+import { Plugin } from "./plugin.cjs";
+import { LogFn, LogLevelResolvedConfig, LogLevelUserConfig } from "./logging.cjs";
+import { TSConfig } from "./tsconfig.cjs";
+import { PluginContext } from "./context.cjs";
+import { Format } from "@storm-software/build-tools/types";
+import { StormWorkspaceConfig } from "@storm-software/config/types";
+import { DeepPartial, DeepReadonly, MaybePromise, NonUndefined, RequiredKeys } from "@stryke/types/base";
+import { FileReference, FileReferenceInput } from "@stryke/types/configuration";
+import { AssetGlob } from "@stryke/types/file";
+import { ConfigLayer, ResolvedConfig } from "c12";
+import { CompatibilityDateSpec, CompatibilityDates } from "compatx";
+import { PreviewOptions, ResolvedPreviewOptions } from "vite";
+
+//#region src/types/config.d.ts
+/**
+ * The {@link StormWorkspaceConfig | configuration} object for an entire Powerlines workspace
+ */
+type WorkspaceConfig = Partial<StormWorkspaceConfig> & Required<Pick<StormWorkspaceConfig, "workspaceRoot">>;
+type PluginFactory<in out TContext extends PluginContext = PluginContext, TOptions = any> = (options: TOptions) => MaybePromise<Plugin<TContext> | Plugin<TContext>[]>;
+/**
+ * A configuration tuple for a Powerlines plugin.
+ */
+type PluginConfigTuple<TContext extends PluginContext = PluginContext, TOptions = any> = [string | PluginFactory<TContext, TOptions>, TOptions] | [Plugin<TContext>];
+/**
+ * A configuration object for a Powerlines plugin.
+ */
+type PluginConfigObject<TContext extends PluginContext = PluginContext, TOptions = any> = {
+  plugin: string | PluginFactory<TContext, TOptions>;
+  options: TOptions;
+} | {
+  plugin: Plugin<TContext>;
+  options?: never;
+};
+/**
+ * A configuration tuple for a Powerlines plugin.
+ */
+type PluginConfig<TContext extends PluginContext = PluginContext> = string | PluginFactory<TContext, void> | Plugin<TContext> | PluginConfigTuple<TContext> | PluginConfigObject<TContext> | Promise<PluginConfig<TContext>> | PluginConfig<TContext>[];
+type PartialPlugin<TContext extends PluginContext = PluginContext> = DeepPartial<Plugin<TContext>>;
+type PartialPluginFactory<in out TContext extends PluginContext = PluginContext, TOptions = any> = (options: TOptions) => MaybePromise<PartialPlugin<TContext> | PartialPlugin<TContext>[]>;
+type ProjectType = "application" | "library";
+type Mode = "development" | "test" | "production";
+/**
+ * The configuration options for resolving modules in a Powerlines project.
+ */
+interface ResolveConfig {
+  /**
+   * List of fields in `package.json` to try when resolving a package's entry point. Note this takes lower precedence than conditional exports resolved from the exports field: if an entry point is successfully resolved from exports, the main field will be ignored.
+   *
+   * @defaultValue `["browser", "module", "jsnext:main", "jsnext"]`
+   *
+   * @see https://vite.dev/config/shared-options#resolve-mainfields
+   */
+  mainFields?: string[];
+  /**
+   * Array of strings indicating what conditions should be allowed when resolving [conditional exports](https://nodejs.org/api/packages.html#packages_conditional_exports) from a package.
+   *
+   * @defaultValue `["import", "require", "default"]`
+   *
+   * @see https://vite.dev/config/shared-options#resolve-conditions
+   */
+  conditions?: string[];
+  /**
+   * List of file extensions to try for imports that omit extensions. Note it is NOT recommended to omit extensions for custom import types (e.g. .vue) since it can interfere with IDE and type support.
+   *
+   * @defaultValue `[".mjs", ".js", ".mts", ".ts", ".jsx", ".tsx", ".json"]`
+   *
+   * @see https://vite.dev/config/shared-options#resolve-extensions
+   */
+  extensions?: string[];
+  /**
+   * Array of strings indicating what modules should be deduplicated to a single version in the build.
+   *
+   * @remarks
+   * This option is useful for ensuring that only one version of a module is included in the bundle, which can help reduce bundle size and avoid conflicts. If you have duplicated copies of the same dependency in your app (likely due to hoisting or linked packages in monorepos), use this option to force Powerlines to always resolve listed dependencies to the same copy (from project root).
+   *
+   * @see https://vite.dev/config/shared-options#resolve-dedupe
+   */
+  dedupe?: string[];
+  /**
+   * The alias mappings to use for module resolution during the build process.
+   *
+   * @remarks
+   * This option allows you to define custom path aliases for modules, which can be useful for simplifying imports and managing dependencies.
+   *
+   * @example
+   * ```ts
+   * {
+   *   alias: {
+   *     "@utils": "./src/utils",
+   *     "@components": "./src/components"
+   *   }
+   * }
+   * ```
+   *
+   * @see https://vite.dev/config/shared-options#resolve-alias
+   * @see https://github.com/rollup/plugins/tree/master/packages/alias
+   */
+  alias?: Record<string, string> | Array<{
+    find: string | RegExp;
+    replacement: string;
+  }>;
+  /**
+   * Enabling this setting causes Powerlines to determine file identity by the original file path (i.e. the path without following symlinks) instead of the real file path (i.e. the path after following symlinks).
+   *
+   * @defaultValue false
+   *
+   * @see https://esbuild.github.io/api/#preserve-symlinks
+   * @see https://rollupjs.org/configuration-options/#preservesymlinks
+   * @see https://webpack.js.org/configuration/resolve/#resolvesymlinks
+   * @see https://rolldown.rs/reference/InputOptions.resolve#symlinks
+   * @see https://vite.dev/config/shared-options#resolve-preservesymlinks
+   */
+  preserveSymlinks?: boolean;
+  /**
+   * A list of modules that should not be bundled, even if they are external dependencies.
+   *
+   * @remarks
+   * This option is useful for excluding specific modules from the bundle, such as Node.js built-in modules or other libraries that should not be bundled.
+   */
+  external?: (string | RegExp)[];
+  /**
+   * A list of modules that should always be bundled, even if they are external dependencies.
+   */
+  noExternal?: (string | RegExp)[];
+  /**
+   * Should the Powerlines CLI processes skip bundling the `node_modules` directory?
+   */
+  skipNodeModulesBundle?: boolean;
+}
+interface CopyConfig {
+  /**
+   * An optional path to a secondary/copied output directory for collecting distributable files prior to publishing/deployment.
+   *
+   * @remarks
+   * This option is useful when a separate directory is needed for collecting distributable files that are copied from the project, such as static assets or other non-code files. When using [Nx monorepo tools](https://nx.dev/), it is common for the {@link OutputConfig.path | project's output} to be copied to the `{workspaceRoot}/dist/{root}` directory, so that all of the monorepo's output is consolidated in a single location.
+   */
+  path: string;
+  /**
+   * A list of assets to copy to the output directory
+   *
+   * @remarks
+   * The assets can be specified as a string (path to the asset) or as an object with a `glob` property (to match multiple files). The paths are relative to the project root directory.
+   */
+  assets?: Array<string | AssetGlob>;
+}
+interface OutputConfig {
+  /**
+   * The output directory path for the project build.
+   *
+   * @remarks
+   * If a value is not provided, Powerlines will attempt to:
+   * 1. Use the `outDir` value in the `tsconfig.json` file.
+   * 2. Use the `dist` directory in the project root directory.
+   *
+   * @defaultValue "\{root\}/dist"
+   */
+  path?: string;
+  /**
+   * Configuration that specifies a secondary/copied output directory for potentially collecting distributable files prior to publishing/deployment.
+   *
+   * @remarks
+   * These options are useful when a separate directory is needed for collecting distributable files that are copied from the project, such as static assets or other non-code files. When using [Nx monorepo tools](https://nx.dev/), it is common for the {@link OutputConfig.path | project's output} to be copied to the `{workspaceRoot}/dist/{root}` directory, so that all of the monorepo's output is consolidated in a single location.
+   */
+  copy?: CopyConfig | false;
+  /**
+   * The folder where the generated runtime artifacts will be located
+   *
+   * @remarks
+   * This folder will contain all runtime artifacts and builtins generated during the "prepare" phase.
+   *
+   * @defaultValue "\{root\}/.powerlines"
+   */
+  artifactsPath?: string;
+  /**
+   * Should typescript declaration modules be generated during the build for the project?
+   */
+  dts?: boolean;
+  /**
+   * The path of the generated runtime types declaration file relative to the workspace root.
+   *
+   * @remarks
+   * This value will be set to `true` automatically when {@link OutputConfig.dts | dts} is set to `true`.
+   *
+   * @defaultValue "\{root\}/powerlines.d.ts"
+   */
+  types?: string | false;
+  /**
+   * The module format of the output files
+   *
+   * @remarks
+   * This option can be a single format or an array of formats. If an array is provided, multiple builds will be generated for each format.
+   *
+   * @defaultValue "esm"
+   */
+  format?: Format | Format[];
+  /**
+   * Generate source maps for the output files
+   *
+   * @remarks
+   * This option can be a boolean or a string specifying the type of source map to generate. If set to `true`, external source maps will be generated. If set to `"inline"`, source maps will be included in the output files as data URIs. If set to `"hidden"`, external source maps will be generated but not referenced in the output files.
+   */
+  sourceMap?: boolean | "inline" | "hidden";
+  /**
+   * Minify the output files
+   *
+   * @remarks
+   * This option can be a boolean or a string specifying the type of minification to apply. If set to `true`, the output files will be minified. If set to `"terser"`, the Terser minifier will be used. If set to `"esbuild"`, the esbuild minifier will be used.
+   *
+   * @defaultValue false
+   */
+  minify?: boolean;
+  /**
+   * Control whether built-in Node.js module imports use the `node:` protocol.
+   *
+   * @remarks
+   * If no option is provided, built-in module imports are not transformed. The following options are available for this setting:
+   * - `true`: Add the node: prefix to built-in module imports.
+   * - `"strip"`: Remove the node: prefix from built-in module imports.
+   *
+   * @see https://tsdown.dev/reference/api/Interface.InlineConfig#nodeprotocol
+   * @see https://nodejs.org/api/esm.html#node-imports
+   */
+  nodeProtocol?: "strip" | true;
+  /**
+   * Whether to overwrite previously generated files in the artifacts directory during the build process.
+   *
+   * @remarks
+   * When set to `true`, Powerlines will overwrite any existing files in the artifacts directory with the newly generated files during the build process. When set to `false`, Powerlines will skip generating files that already exist in the artifacts directory, which can help speed up the build process by avoiding unnecessary file writes. This option is only relevant when the {@link OutputConfig.storage | storage option} is configured to use an adapter that writes files to the local file system. If using a `virtual` storage adapter, this option has no effect.
+   *
+   * @defaultValue true
+   */
+  overwrite?: boolean;
+  /**
+   * A string preset or a custom {@link StoragePort} to provide fine-grained control over generated/output file storage.
+   *
+   * @remarks
+   * If a string preset is provided, it must be one of the following values:
+   * - `"fs"`: Uses the local file system for storage.
+   * - `"virtual"`: Uses an in-memory virtual file system for storage.
+   *
+   * If a custom {@link StoragePort} is provided, it will be used for all file storage operations during the build process.
+   *
+   * @defaultValue "virtual"
+   */
+  storage?: StoragePort | StoragePreset;
+}
+interface FrameworkOptions {
+  /**
+   * The name of the framework
+   *
+   * @remarks
+   * This value is used to identify the framework in logs, error messages, and other places where the framework's name is needed.
+   *
+   * @defaultValue "powerlines"
+   */
+  name: string;
+  /**
+   * The version of the framework
+   *
+   * @remarks
+   * This value is used to identify the version of the framework in logs, error messages, and other places where the framework's version is needed.
+   *
+   * @defaultValue "0.0.1"
+   */
+  version?: string;
+  /**
+   * The organization or author of the framework
+   *
+   * @defaultValue "storm-software"
+   */
+  orgId: string;
+}
+interface Options {
+  /**
+   * The current working directory the Powerlines processes should operate in
+   *
+   * @remarks
+   * If not provided, the {@link WorkspaceConfig.workspaceRoot | workspace root} will be used as the current working directory. If the workspace root cannot be determined, the process's current working directory will be used.
+   */
+  cwd?: string;
+  /**
+   * The log level label indicating the severity of the log message, or a more detailed log level configuration object that allows for specifying different log levels for different categories of logs.
+   *
+   * @remarks
+   * The log level determines the minimum severity of messages that will be logged. For example, if the log level is set to `LogLevel.INFO`, then messages with a severity of `INFO`, `WARN`, and `ERROR` will be logged, while messages with a severity of `DEBUG` and `TRACE` will be ignored. Setting the log level to `LogLevel.SILENT` will disable all logging. Alternatively, you can provide a more detailed configuration object that allows you to specify different log levels for different categories of logs, providing granular control over the logging behavior for different aspects of the system.
+   *
+   * @defaultValue "info"
+   */
+  logLevel?: LogLevelUserConfig;
+  /**
+   * Details about the framework being used in the current execution, which can be used by plugins and other parts of the system to customize behavior based on the framework.
+   */
+  framework?: FrameworkOptions;
+}
+interface BaseExecutionOptions extends RequiredKeys<Options, "cwd"> {
+  /**
+   * The root directory of the project
+   */
+  root: string;
+}
+interface ExecutionOptions extends BaseExecutionOptions {
+  /**
+   * A unique identifier for the current execution instance, which can be used for logging and other purposes to distinguish between different executions in the same process.
+   */
+  executionId?: string;
+  /**
+   * The index of the current execution instance among all configured instances in the Powerlines process
+   */
+  configIndex?: number;
+  /**
+   * A path to a custom configuration file to be used instead of the default `powerlines.json`, `powerlines.config.js`, or `powerlines.config.ts` files.
+   *
+   * @remarks
+   * This option is useful for running Powerlines commands with different configuration files, such as in CI/CD environments or when testing different configurations.
+   */
+  configFile: string;
+  /**
+   * A logging function provided by the code invoking the Powerlines execution process, which can be used for logging messages during the build process instead of the default Powerlines logger.
+   *
+   * @remarks
+   * Providing a custom logging function allows you to integrate Powerlines logging with your own logging system or to customize the logging behavior, such as formatting log messages differently or sending logs to an external service. If a custom logging function is not provided, Powerlines will use its default logger implementation.
+   *
+   * @important
+   * This function cannot be provided by the Powerlines engine, as it is not serializable. It must be passed directly to the execution context when creating it, and will not be preserved if the context is cloned or serialized.
+   */
+  logFn?: LogFn;
+}
+interface Config {
+  /**
+   * Defines entries and location(s) of entry modules for the bundle. Relative paths are resolved based on the `root` option.
+   */
+  input?: FileReferenceInput | FileReferenceInput[] | Record<string, FileReferenceInput | FileReferenceInput[]>;
+  /**
+   * Configuration for the output files generated by processing the source code
+   */
+  output?: OutputConfig;
+  /**
+   * The date to use for compatibility checks
+   *
+   * @remarks
+   * This date can be used by plugins and build processes to determine compatibility with certain features or APIs. It is recommended to set this date to the date when the project was last known to be compatible with the desired features or APIs. If no value is provided, the latest compatibility date will be used.
+   *
+   * @see https://developers.cloudflare.com/pages/platform/compatibility-dates/
+   * @see https://docs.netlify.com/configure-builds/get-started/#set-a-compatibility-date
+   * @see https://github.com/unjs/compatx
+   */
+  compatibilityDate?: CompatibilityDateSpec;
+  /**
+   * The log level label indicating the severity of the log message, or a more detailed log level configuration object that allows for specifying different log levels for different categories of logs.
+   *
+   * @remarks
+   * The log level determines the minimum severity of messages that will be logged. For example, if the log level is set to `LogLevel.INFO`, then messages with a severity of `INFO`, `WARN`, and `ERROR` will be logged, while messages with a severity of `DEBUG` and `TRACE` will be ignored. Setting the log level to `LogLevel.SILENT` will disable all logging. Alternatively, you can provide a more detailed configuration object that allows you to specify different log levels for different categories of logs, providing granular control over the logging behavior for different aspects of the system.
+   *
+   * @defaultValue "info"
+   */
+  logLevel?: LogLevelUserConfig;
+  /**
+   * Configuration for module resolution during processing of the source code
+   */
+  resolve?: ResolveConfig;
+  /**
+   * The platform to build the project for
+   *
+   * @defaultValue "neutral"
+   */
+  platform?: "node" | "browser" | "neutral";
+  /**
+   * Define global constant replacements. Entries will be defined as globals during dev and statically replaced during build.
+   *
+   * @remarks
+   * This option allows you to specify global constants that will be replaced in the code during the build process. It is similar to the `define` option in esbuild and Vite, enabling you to replace specific identifiers with constant expressions at build time.
+   *
+   * @example
+   * ```ts
+   * {
+   *   define: {
+   *     __VERSION__: '"1.0.0"',
+   *     __DEV__: 'process.env.NODE_ENV !== "production"'
+   *   }
+   * }
+   * ```
+   *
+   * @see https://esbuild.github.io/api/#define
+   * @see https://vitejs.dev/config/build-options.html#define
+   * @see https://github.com/rollup/plugins/tree/master/packages/replace
+   */
+  define?: Record<string, any>;
+  /**
+   * Global variables that will have import statements injected where necessary
+   *
+   * @remarks
+   * This option allows you to specify global variables that should be automatically imported from specified modules whenever they are used in the code. This is particularly useful for polyfilling Node.js globals in a browser environment.
+   *
+   * @example
+   * ```ts
+   * {
+   *   inject: {
+   *     process: 'process/browser',
+   *     Buffer: ['buffer', 'Buffer'],
+   *   }
+   * }
+   * ```
+   *
+   * @see https://github.com/rollup/plugins/tree/master/packages/inject
+   */
+  inject?: Record<string, string | string[]>;
+  /**
+   * The path to the tsconfig file to be used by the compiler
+   *
+   * @remarks
+   * If a value is not provided, the plugin will attempt to find the `tsconfig.json` file in the project root directory. The parsed tsconfig compiler options will be merged with the {@link Options.tsconfigRaw} value (if provided).
+   *
+   * @defaultValue "\{projectRoot\}/tsconfig.json"
+   */
+  tsconfig?: string;
+  /**
+   * The raw {@link TSConfig} object to be used by the compiler. This object will be merged with the `tsconfig.json` file.
+   *
+   * @see https://www.typescriptlang.org/tsconfig
+   *
+   * @remarks
+   * If populated, this option takes higher priority than `tsconfig`
+   */
+  tsconfigRaw?: TSConfig;
+}
+interface EnvironmentConfig extends Config {
+  /**
+   * Configuration options for the preview server
+   */
+  preview?: PreviewOptions;
+  /**
+   * A flag indicating whether the build is for a Server-Side Rendering environment.
+   */
+  ssr?: boolean;
+  /**
+   * The runtime environment for the build, which can be used by plugins to determine how to process the source code and generate runtime artifacts.
+   *
+   * @remarks
+   * This option can be used to specify the target runtime environment for the build, such as "nodejs", "browser", "workerd", or "edge". Plugins can use this information to determine how to process the source code and generate runtime artifacts that are compatible with the specified environment. If no value is provided, plugins will need to determine the runtime environment based on other factors, such as the presence of certain dependencies or configuration options.
+   */
+  runtime?: "nodejs" | "browser" | "workerd" | "edge";
+  /**
+   * Define if this environment is used for Server-Side Rendering
+   *
+   * @defaultValue "server" (if it isn't the client environment)
+   */
+  consumer?: "client" | "server";
+}
+interface UserConfig extends Config {
+  /**
+   * The name of the project
+   */
+  name?: string;
+  /**
+   * The project display title
+   *
+   * @remarks
+   * This option is used in documentation generation and other places where a human-readable title is needed.
+   */
+  title?: string;
+  /**
+   * A description of the project
+   *
+   * @remarks
+   * If this option is not provided, the build process will try to use the \`description\` value from the `\package.json\` file.
+   */
+  description?: string;
+  /**
+   * The organization or author of the project
+   *
+   * @remarks
+   * If this option is not provided, the build process will try to use the \`author\` value from the \`package.json\` file. If the \`author\` value cannot be determined, the {@link name | name configuration} will be used.
+   */
+  organization?: string;
+  /**
+   * Explicitly set a mode to run in. This mode will be used at various points throughout the Powerlines processes, such as when compiling the source code.
+   *
+   * @defaultValue "production"
+   */
+  mode?: Mode;
+  /**
+   * The type of project being built
+   *
+   * @defaultValue "application"
+   */
+  projectType?: ProjectType;
+  /**
+   * Should the Powerlines processes automatically install missing package dependencies?
+   *
+   * @remarks
+   * When set to `true`, Powerlines will attempt to install any missing dependencies using the package manager detected in the project (e.g., npm, yarn, pnpm). This can be useful for ensuring that all required packages are available during the build and preparation phases.
+   *
+   * @defaultValue false
+   */
+  autoInstall?: boolean;
+  /**
+   * Should the compiler processes skip any improvements that make use of cache?
+   *
+   * @defaultValue false
+   */
+  skipCache?: boolean;
+  /**
+   * A list of resolvable paths to plugins used during the build process
+   */
+  plugins?: PluginConfig<any>[];
+  /**
+   * Environment-specific configurations
+   */
+  environments?: Record<string, EnvironmentConfig>;
+  /**
+   * Should a single `build` process be ran for each environment?
+   *
+   * @remarks
+   * This option determines how environments are managed during the `build` process. The available options are:
+   *
+   * - `false`: A separate build is ran for each environment.
+   * - `true`: A single build is ran for all environments.
+   *
+   * @defaultValue false
+   */
+  singleBuild?: boolean;
+}
+type ConfigParams = BaseExecutionOptions & Pick<Required<UserConfig>, "mode"> & {
+  /**
+   * A string identifier for the Powerlines command being executed
+   */
+  command: string;
+};
+type UserConfigFnObject = (env: ConfigParams) => UserConfig | UserConfig[];
+type UserConfigFnPromise = (env: ConfigParams) => Promise<UserConfig | UserConfig[]>;
+type UserConfigFn = (env: ConfigParams) => UserConfig | UserConfig[] | Promise<UserConfig | UserConfig[]>;
+type UserConfigExport = UserConfig | UserConfig[] | Promise<UserConfig | UserConfig[]> | UserConfigFnObject | UserConfigFnPromise | UserConfigFn;
+type ParsedUserConfig = ResolvedConfig<UserConfig> & {
+  /**
+   * The path to the user configuration file, if it exists.
+   *
+   * @remarks
+   * This is typically the `powerlines.json`, `powerlines.config.js`, or `powerlines.config.ts` file in the project root.
+   */
+  configFile?: ConfigLayer<UserConfig>["configFile"];
+};
+type InlineConfigPaths = {
+  /**
+   * The root directory of the project
+   */
+  root: string;
+  /**
+   * A path to a custom configuration file to be used instead of the default `powerlines.json`, `powerlines.config.js`, or `powerlines.config.ts` files.
+   *
+   * @remarks
+   * This option is useful for running Powerlines commands with different configuration files, such as in CI/CD environments or when testing different configurations.
+   */
+  configFile?: string;
+} | {
+  /**
+   * The root directory of the project
+   */
+  root?: string;
+  /**
+   * A path to a custom configuration file to be used instead of the default `powerlines.json`, `powerlines.config.js`, or `powerlines.config.ts` files.
+   *
+   * @remarks
+   * This option is useful for running Powerlines commands with different configuration files, such as in CI/CD environments or when testing different configurations.
+   */
+  configFile?: string;
+};
+/**
+ * The configuration provided while executing Powerlines commands.
+ */
+type InlineConfig<TUserConfig extends UserConfig = UserConfig> = DeepPartial<TUserConfig> & {
+  /**
+   * The root directory of the project
+   */
+  root?: string;
+  /**
+   * A path to a custom configuration file to be used instead of the default `powerlines.json`, `powerlines.config.js`, or `powerlines.config.ts` files.
+   *
+   * @remarks
+   * This option is useful for running Powerlines commands with different configuration files, such as in CI/CD environments or when testing different configurations.
+   */
+  configFile?: string;
+  /**
+   * A string identifier for the Powerlines command being executed
+   */
+  command: 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.
+   */
+  additionalArgs?: Record<string, string | string[]>;
+  /**
+   * Details about the framework being used in the current execution, which can be used by plugins and other parts of the system to customize behavior based on the framework.
+   *
+   * @remarks
+   * This should only be used by framework plugins to ensure the correct framework name is applied
+   *
+   * @internal
+   */
+  framework?: FrameworkOptions;
+};
+type CreateInlineConfig<TUserConfig extends UserConfig = UserConfig> = RequiredKeys<InlineConfig<TUserConfig>, "root"> & {
+  /**
+   * The package name (from the \`package.json\`) for the project that will be used in the \`create\` command to create a new project based on this configuration
+   */
+  packageName?: string;
+};
+type CleanInlineConfig<TUserConfig extends UserConfig = UserConfig> = InlineConfig<TUserConfig>;
+type PrepareInlineConfig<TUserConfig extends UserConfig = UserConfig> = InlineConfig<TUserConfig>;
+type TypesInlineConfig<TUserConfig extends UserConfig = UserConfig> = InlineConfig<TUserConfig>;
+type BuildInlineConfig<TUserConfig extends UserConfig = UserConfig> = InlineConfig<TUserConfig>;
+type LintInlineConfig<TUserConfig extends UserConfig = UserConfig> = InlineConfig<TUserConfig>;
+type TestInlineConfig<TUserConfig extends UserConfig = UserConfig> = InlineConfig<TUserConfig>;
+type DocsInlineConfig<TUserConfig extends UserConfig = UserConfig> = InlineConfig<TUserConfig>;
+type DeployInlineConfig<TUserConfig extends UserConfig = UserConfig> = InlineConfig<TUserConfig>;
+interface ResolvedEntryFileReference extends FileReference {
+  /**
+   * The user provided entry point in the source code
+   */
+  input?: FileReference;
+  /**
+   * An optional name to use in the package export during the build process
+   */
+  output?: string;
+}
+type ResolvedEnvironmentConfig = RequiredKeys<Omit<EnvironmentConfig, "preview">, "input" | "consumer" | "ssr"> & {
+  /**
+   * A string identifier for the environment used by the system and plugins to determine which environment-specific configuration to use during the build process.
+   */
+  id: string;
+  /**
+   * The name of the environment provided by the user in the {@link UserConfig.environments | environments} configuration.
+   */
+  name: string;
+  /**
+   * Configuration options for the preview server
+   */
+  preview?: ResolvedPreviewOptions;
+};
+/**
+ * The configuration options for resolving modules in a Powerlines project.
+ */
+type ResolvedResolveConfig = Required<Omit<ResolveConfig, "external" | "noExternal">> & {
+  /**
+   * A list of modules that should not be bundled, even if they are external dependencies.
+   *
+   * @remarks
+   * This option is useful for excluding specific modules from the bundle, such as Node.js built-in modules or other libraries that should not be bundled.
+   */
+  external?: string[];
+  /**
+   * A list of modules that should always be bundled, even if they are external dependencies.
+   */
+  noExternal?: string[];
+};
+type ResolvedAssetGlob = AssetGlob & Required<Pick<AssetGlob, "input">>;
+type ResolvedCopyConfig = Required<Omit<CopyConfig, "assets">> & {
+  assets: ResolvedAssetGlob[];
+};
+type ResolvedOutputConfig = Required<Omit<OutputConfig, "copy" | "storage">> & Pick<OutputConfig, "storage"> & {
+  copy: ResolvedCopyConfig | false;
+};
+/**
+ * The base resolved configuration options for a Powerlines project, after being processed and normalized by the configuration loading process.
+ */
+type ResolvedConfig$1<TUserConfig extends UserConfig = UserConfig, TExecutionOptions extends ExecutionOptions = ExecutionOptions> = Omit<TExecutionOptions, "logLevel"> & Omit<RequiredKeys<TUserConfig, "input" | "name" | "title" | "plugins" | "mode" | "input" | "tsconfig" | "platform" | "projectType">, "compatibilityDate" | "output" | "resolve" | "logLevel" | "environments"> & {
+  /**
+   * 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.
+   */
+  readonly userConfig: DeepReadonly<TUserConfig>;
+  /**
+   * The configuration options provided by plugins added by the user (and other plugins)
+   */
+  readonly inlineConfig: DeepReadonly<InlineConfig<TUserConfig>>;
+  /**
+   * The configuration options that were provided by Powerlines plugins, which may have been merged with the user configuration and modified by the configuration loading process.
+   */
+  readonly pluginConfig: DeepReadonly<DeepPartial<TUserConfig>>;
+  /**
+   * A string identifier for the Powerlines command being executed.
+   */
+  readonly command: NonUndefined<InlineConfig<TUserConfig>["command"]>;
+  /**
+   * A path to a custom configuration file to be used instead of the default `powerlines.json`, `powerlines.config.js`, or `powerlines.config.ts` files.
+   *
+   * @remarks
+   * This option is useful for running Powerlines commands with different configuration files, such as in CI/CD environments or when testing different configurations.
+   */
+  readonly configFile: string;
+  /**
+   * The output configuration options to use for the build process
+   */
+  output: ResolvedOutputConfig;
+  /**
+   * Configuration for module resolution during processing of the source code
+   */
+  resolve: ResolvedResolveConfig;
+  /**
+   * The date to use for compatibility checks
+   *
+   * @remarks
+   * This date can be used by plugins and build processes to determine compatibility with certain features or APIs. It is recommended to set this date to the date when the project was last known to be compatible with the desired features or APIs.
+   *
+   * @see https://developers.cloudflare.com/pages/platform/compatibility-dates/
+   * @see https://docs.netlify.com/configure-builds/get-started/#set-a-compatibility-date
+   * @see https://github.com/unjs/compatx
+   */
+  compatibilityDate: CompatibilityDates;
+  /**
+   * The log level label indicating the severity of the log message, or a more detailed log level configuration object that allows for specifying different log levels for different categories of logs.
+   *
+   * @remarks
+   * The log level determines the minimum severity of messages that will be logged. For example, if the log level is set to `LogLevel.INFO`, then messages with a severity of `INFO`, `WARN`, and `ERROR` will be logged, while messages with a severity of `DEBUG` and `TRACE` will be ignored. Setting the log level to `LogLevel.SILENT` will disable all logging. Alternatively, you can provide a more detailed configuration object that allows you to specify different log levels for different categories of logs, providing granular control over the logging behavior for different aspects of the system.
+   */
+  logLevel: LogLevelResolvedConfig;
+  /**
+   * Environment-specific configurations
+   */
+  environments: Record<string, ResolvedEnvironmentConfig>;
+};
+type InferOverridableConfig<TResolvedConfig extends ResolvedConfig$1 = ResolvedConfig$1> = DeepPartial<Omit<TResolvedConfig, "userConfig" | "inlineConfig" | "pluginConfig" | "cwd" | "configFile" | "command">>;
+/**
+ * The resolved configuration options for a Powerlines environment, after being processed and normalized by the configuration loading process.
+ */
+type EnvironmentResolvedConfig<TResolvedConfig extends ResolvedConfig$1 = ResolvedConfig$1> = TResolvedConfig & {
+  /**
+   * The configuration provided when initializing the Powerlines API.
+   *
+   * @remarks
+   * This configuration is used during the initialization of the Powerlines API.
+   */
+  readonly environmentConfig: DeepReadonly<EnvironmentConfig>;
+  /**
+   * The resolved configuration options for the environment, which may include additional properties or modifications made during the configuration loading process.
+   */
+  environment: ResolvedEnvironmentConfig;
+};
+//#endregion
+export { BaseExecutionOptions, BuildInlineConfig, CleanInlineConfig, Config, ConfigParams, CopyConfig, CreateInlineConfig, DeployInlineConfig, DocsInlineConfig, EnvironmentConfig, EnvironmentResolvedConfig, ExecutionOptions, FrameworkOptions, InferOverridableConfig, InlineConfig, InlineConfigPaths, LintInlineConfig, Mode, Options, OutputConfig, ParsedUserConfig, PartialPlugin, PartialPluginFactory, PluginConfig, PluginConfigObject, PluginConfigTuple, PluginFactory, PrepareInlineConfig, ProjectType, ResolveConfig, ResolvedAssetGlob, ResolvedConfig$1 as ResolvedConfig, ResolvedCopyConfig, ResolvedEntryFileReference, ResolvedEnvironmentConfig, ResolvedOutputConfig, ResolvedResolveConfig, TestInlineConfig, TypesInlineConfig, UserConfig, UserConfigExport, UserConfigFn, UserConfigFnObject, UserConfigFnPromise, WorkspaceConfig };
+//# sourceMappingURL=config.d.cts.map