@powerlines/plugin-env 0.13.15 → 0.13.17

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { P as PluginContext, b as Plugin } from './runtime-BRVCxO4z.cjs';
-export { E as EnvInterface, S as SecretsInterface } from './runtime-BRVCxO4z.cjs';
+import { P as PluginContext, b as Plugin } from './runtime-CXFOdIeH.cjs';
+export { E as EnvInterface, S as SecretsInterface } from './runtime-CXFOdIeH.cjs';
 import { Children } from '@alloy-js/core/jsx-runtime';
 import { PrintTreeOptions } from '@alloy-js/core';
 import { EnvPluginContext, EnvPluginResolvedConfig } from './types/plugin.cjs';
@@ -12,6 +12,7 @@ export { BaseEnv, BaseSecrets, CreateEnvReflectionOptions, createEnvReflection,
 export { formatEnvField, removeEnvPrefix } from './helpers/source-file-env.cjs';
 export { createTemplateReflection } from './helpers/template-helpers.cjs';
 import '@stryke/env/get-env-paths';
+import '@stryke/types/base';
 import '@stryke/types/package-json';
 import 'jiti';
 import 'oxc-parser';
@@ -21,7 +22,6 @@ import '@babel/core';
 import '@storm-software/build-tools/types';
 import '@storm-software/config-tools/types';
 import '@storm-software/config/types';
-import '@stryke/types/base';
 import '@stryke/types/configuration';
 import '@stryke/types/file';
 import 'vite';
@@ -29,11 +29,9 @@ import '@babel/helper-plugin-utils';
 import '@stryke/types/array';
 import '@stryke/types/tsconfig';
 import 'typescript';
-import './vfs-Bl84Hw2V.cjs';
+import './vfs-BGmsy47f.cjs';
 import '@stryke/json/types';
-import 'memfs';
 import 'node:fs';
-import 'unionfs';
 import '@deepkit/type';
 import '@stryke/capnp';
 import '@stryke/env/types';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { P as PluginContext, b as Plugin } from './runtime-nCpMYmRi.js';
-export { E as EnvInterface, S as SecretsInterface } from './runtime-nCpMYmRi.js';
+import { P as PluginContext, b as Plugin } from './runtime-BZR8Re97.js';
+export { E as EnvInterface, S as SecretsInterface } from './runtime-BZR8Re97.js';
 import { Children } from '@alloy-js/core/jsx-runtime';
 import { PrintTreeOptions } from '@alloy-js/core';
 import { EnvPluginContext, EnvPluginResolvedConfig } from './types/plugin.js';
@@ -12,6 +12,7 @@ export { BaseEnv, BaseSecrets, CreateEnvReflectionOptions, createEnvReflection,
 export { formatEnvField, removeEnvPrefix } from './helpers/source-file-env.js';
 export { createTemplateReflection } from './helpers/template-helpers.js';
 import '@stryke/env/get-env-paths';
+import '@stryke/types/base';
 import '@stryke/types/package-json';
 import 'jiti';
 import 'oxc-parser';
@@ -21,7 +22,6 @@ import '@babel/core';
 import '@storm-software/build-tools/types';
 import '@storm-software/config-tools/types';
 import '@storm-software/config/types';
-import '@stryke/types/base';
 import '@stryke/types/configuration';
 import '@stryke/types/file';
 import 'vite';
@@ -29,11 +29,9 @@ import '@babel/helper-plugin-utils';
 import '@stryke/types/array';
 import '@stryke/types/tsconfig';
 import 'typescript';
-import './vfs-Bl84Hw2V.js';
+import './vfs-BGmsy47f.js';
 import '@stryke/json/types';
-import 'memfs';
 import 'node:fs';
-import 'unionfs';
 import '@deepkit/type';
 import '@stryke/capnp';
 import '@stryke/env/types';

package/dist/{runtime-BRVCxO4z.d.cts → runtime-BZR8Re97.d.ts}

@@ -1,14 +1,14 @@
 import { EnvPaths } from '@stryke/env/get-env-paths';
+import { NonUndefined, MaybePromise, FunctionLike } from '@stryke/types/base';
 import { PackageJson } from '@stryke/types/package-json';
 import { Jiti } from 'jiti';
 import { ParserOptions, ParseResult } from 'oxc-parser';
 import { Range } from 'semver';
-import { TransformResult, ExternalIdResult, HookFilter, UnpluginOptions, UnpluginContext, UnpluginBuildContext, UnpluginMessage } from 'unplugin';
+import { TransformResult, ExternalIdResult, HookFilter, UnpluginOptions, UnpluginContext, UnpluginMessage, UnpluginBuildContext } from 'unplugin';
 import { PluginItem, PluginObj, PluginPass, transformAsync } from '@babel/core';
 import { Format } from '@storm-software/build-tools/types';
 import { LogLevelLabel } from '@storm-software/config-tools/types';
 import { StormWorkspaceConfig } from '@storm-software/config/types';
-import { NonUndefined, MaybePromise, FunctionLike } from '@stryke/types/base';
 import { TypeDefinition, TypeDefinitionParameter } from '@stryke/types/configuration';
 import { AssetGlob } from '@stryke/types/file';
 import { ResolvedPreviewOptions, PreviewOptions } from 'vite';
@@ -16,7 +16,7 @@ import { BabelAPI } from '@babel/helper-plugin-utils';
 import { ArrayValues } from '@stryke/types/array';
 import { TsConfigJson, CompilerOptions } from '@stryke/types/tsconfig';
 import ts from 'typescript';
-import { O as OutputModeType, V as VirtualFileSystemInterface, a as VirtualFile, P as PowerlinesWriteFileOptions } from './vfs-Bl84Hw2V.cjs';
+import { O as OutputModeType, V as VirtualFileSystemInterface, a as VirtualFile, P as PowerlinesWriteFileOptions } from './vfs-BGmsy47f.js';
 
 type BabelPluginPass<TState = unknown> = PluginPass & TState;
 type BabelTransformPluginFilter = (code: string, id: string) => boolean;
@@ -45,6 +45,87 @@ interface BuildConfig {
      * @defaultValue "neutral"
      */
     platform?: "node" | "browser" | "neutral";
+    /**
+     * Array of strings indicating the polyfills to include for the build.
+     *
+     * @remarks
+     * This option allows you to specify which polyfills should be included in the build process to ensure compatibility with the target environment. The paths for the polyfills can use placeholder tokens (the `replacePathTokens` helper function will be used to resolve the actual values).
+     *
+     * @example
+     * ```ts
+     * {
+     *   polyfill: ['{projectRoot}/custom-polyfill.ts']
+     * }
+     * ```
+     */
+    polyfill?: string[];
+    /**
+     * Array of strings indicating the order in which fields in a package.json file should be resolved to determine the entry point for a module.
+     *
+     * @defaultValue `['browser', 'module', 'jsnext:main', 'jsnext']`
+     */
+    mainFields?: string[];
+    /**
+     * Array of strings indicating what conditions should be used for module resolution.
+     */
+    conditions?: string[];
+    /**
+     * Array of strings indicating what file extensions should be used for module resolution.
+     *
+     * @defaultValue `['.mjs', '.js', '.mts', '.ts', '.jsx', '.tsx', '.json']`
+     */
+    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.
+     */
+    dedupe?: string[];
+    /**
+     * Array of strings or regular expressions that indicate what modules are builtin for the environment.
+     */
+    builtins?: (string | RegExp)[];
+    /**
+     * Define global variable replacements.
+     *
+     * @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 alias mappings to use for module resolution during the build process.
      *
@@ -60,8 +141,13 @@ interface BuildConfig {
      *   }
      * }
      * ```
+     *
+     * @see https://github.com/rollup/plugins/tree/master/packages/alias
      */
-    alias?: Record<string, string>;
+    alias?: Record<string, string> | Array<{
+        find: string | RegExp;
+        replacement: string;
+    }>;
     /**
      * A list of modules that should not be bundled, even if they are external dependencies.
      *
@@ -78,15 +164,16 @@ interface BuildConfig {
      */
     skipNodeModulesBundle?: boolean;
     /**
-     * Should the Powerlines processes skip the `"prepare"` task prior to building?
+     * An optional set of override options to apply to the selected build variant.
      *
-     * @defaultValue false
+     * @remarks
+     * This option allows you to provide configuration options with the guarantee that they will **not** be overridden and will take precedence over other build configurations.
      */
-    skipPrepare?: boolean;
+    override?: Record<string, any>;
 }
-type BuildResolvedConfig = BuildConfig;
+type BuildResolvedConfig = Omit<BuildConfig, "override">;
 
-declare const SUPPORTED_COMMANDS: readonly ["new", "clean", "prepare", "lint", "test", "build", "docs", "release", "finalize"];
+declare const SUPPORTED_COMMANDS: readonly ["new", "clean", "prepare", "lint", "test", "build", "docs", "deploy", "finalize"];
 type CommandType = ArrayValues<typeof SUPPORTED_COMMANDS>;
 
 interface ResolvedEntryTypeDefinition extends TypeDefinition {
@@ -100,7 +187,7 @@ interface ResolvedEntryTypeDefinition extends TypeDefinition {
     output?: string;
 }
 type BabelResolvedConfig = Omit<BabelUserConfig, "plugins" | "presets"> & Required<Pick<BabelUserConfig, "plugins" | "presets">>;
-type EnvironmentResolvedConfig = Omit<EnvironmentConfig, "consumer" | "mode" | "ssr" | "preview" | "mainFields" | "extensions"> & Required<Pick<EnvironmentConfig, "consumer" | "mode" | "ssr" | "mainFields" | "extensions">> & {
+type EnvironmentResolvedConfig = Omit<EnvironmentConfig, "consumer" | "mode" | "ssr" | "preview"> & Required<Pick<EnvironmentConfig, "consumer" | "mode" | "ssr">> & {
     /**
      * The name of the environment
      */
@@ -117,7 +204,7 @@ type OutputResolvedConfig = Required<Omit<OutputConfig, "assets"> & {
 /**
  * The resolved options for the Powerlines project configuration.
  */
-type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "platform" | "tsconfig" | "lint" | "test" | "build" | "transform" | "override" | "root" | "variant" | "type" | "output" | "logLevel" | "framework"> & Required<Pick<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "tsconfig" | "lint" | "test" | "build" | "transform" | "override" | "framework">> & {
+type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "platform" | "tsconfig" | "lint" | "test" | "build" | "transform" | "deploy" | "variant" | "type" | "output" | "logLevel" | "framework"> & Required<Pick<TUserConfig, "name" | "title" | "plugins" | "mode" | "environments" | "tsconfig" | "lint" | "test" | "build" | "transform" | "deploy" | "framework">> & {
     /**
      * The configuration options that were provided inline to the Powerlines CLI.
      */
@@ -148,6 +235,13 @@ type ResolvedConfig<TUserConfig extends UserConfig = UserConfig> = Omit<TUserCon
      * The output configuration options to use for the build process
      */
     output: OutputResolvedConfig;
+    /**
+     * Configuration provided to build processes
+     *
+     * @remarks
+     * This configuration can be used by plugins during the `build` command. It will generally contain options specific to the selected {@link BuildVariant | build variant}.
+     */
+    build: Omit<TUserConfig["build"], "override"> & Required<Pick<Required<TUserConfig["build"]>, "override">>;
     /**
      * The log level to use for the Powerlines processes.
      *
@@ -178,6 +272,10 @@ interface GenerateTypesResult {
     directives?: string[];
     code: string;
 }
+type DeepPartial<T> = {
+    [K in keyof T]?: DeepPartial<T[K]>;
+};
+type ConfigResult<TContext extends PluginContext = PluginContext> = DeepPartial<TContext["config"]> & Record<string, any>;
 interface BasePluginHookFunctions<TContext extends PluginContext = PluginContext> extends Record<CommandType, (this: TContext) => MaybePromise<void>> {
     /**
      * A function that returns configuration options to be merged with the build context's options.
@@ -193,7 +291,7 @@ interface BasePluginHookFunctions<TContext extends PluginContext = PluginContext
      * @param config - The partial configuration object to be modified.
      * @returns A promise that resolves to a partial configuration object.
      */
-    config: (this: Context<TContext["config"]>) => MaybePromise<Partial<TContext["config"]["userConfig"]>>;
+    config: (this: UnresolvedContext<TContext["config"]>) => MaybePromise<ConfigResult<TContext>>;
     /**
      * Modify environment configs before it's resolved. The hook can either mutate the passed-in environment config directly, or return a partial config object that will be deeply merged into existing config.
      *
@@ -296,7 +394,7 @@ type PluginHooks<TContext extends PluginContext = PluginContext> = {
      * @param config - The partial configuration object to be modified.
      * @returns A promise that resolves to a partial configuration object.
      */
-    config: PluginHook<(this: Context<TContext["config"]>) => MaybePromise<Partial<TContext["config"]["userConfig"]>>> | Partial<TContext["config"]["userConfig"]>;
+    config: PluginHook<(this: UnresolvedContext<TContext["config"]>) => MaybePromise<ConfigResult<TContext>>> | ConfigResult<TContext>;
     /**
      * A hook that is called to transform the source code.
      *
@@ -572,24 +670,33 @@ interface BaseConfig {
      * The entry point(s) for the application
      */
     entry?: TypeDefinitionParameter | TypeDefinitionParameter[];
+    /**
+     * Configuration for the output of the build process
+     */
+    output?: OutputConfig;
     /**
      * Configuration for linting the source code
+     *
+     * @remarks
+     * If set to `false`, linting will be disabled.
      */
     lint?: Record<string, any> | false;
     /**
      * Configuration for testing the source code
+     *
+     * @remarks
+     * If set to `false`, testing will be disabled.
      */
     test?: Record<string, any> | false;
-    /**
-     * Configuration for the output of the build process
-     */
-    output?: OutputConfig;
     /**
      * Configuration for the transformation of the source code
      */
     transform?: Record<string, any>;
     /**
-     * Options to to provide to the build process
+     * Configuration provided to build processes
+     *
+     * @remarks
+     * This configuration can be used by plugins during the `build` command. It will generally contain options specific to the selected {@link BuildVariant | build variant}.
      */
     build?: BuildConfig;
     /**
@@ -599,6 +706,13 @@ interface BaseConfig {
      * This configuration will be used by the documentation generation plugins during the `docs` command.
      */
     docs?: Record<string, any>;
+    /**
+     * Configuration for deploying the source code
+     *
+     * @remarks
+     * If set to `false`, the deployment will be disabled.
+     */
+    deploy?: Record<string, any> | false;
     /**
      * The path to the tsconfig file to be used by the compiler
      *
@@ -619,37 +733,6 @@ interface BaseConfig {
     tsconfigRaw?: TSConfig;
 }
 interface EnvironmentConfig extends BaseConfig {
-    /**
-     * Array of strings indicating the order in which fields in a package.json file should be resolved to determine the entry point for a module.
-     *
-     * @defaultValue `['browser', 'module', 'jsnext:main', 'jsnext']`
-     */
-    mainFields?: string[];
-    /**
-     * Array of strings indicating what conditions should be used for module resolution.
-     */
-    conditions?: string[];
-    /**
-     * Array of strings indicating what conditions should be used for external modules.
-     */
-    externalConditions?: string[];
-    /**
-     * Array of strings indicating what file extensions should be used for module resolution.
-     *
-     * @defaultValue `['.mjs', '.js', '.mts', '.ts', '.jsx', '.tsx', '.json']`
-     */
-    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.
-     */
-    dedupe?: string[];
-    /**
-     * Array of strings or regular expressions that indicate what modules are builtin for the environment.
-     */
-    builtins?: (string | RegExp)[];
     /**
      * Configuration options for the preview server
      */
@@ -722,16 +805,28 @@ interface CommonUserConfig extends BaseConfig {
      */
     framework?: string;
 }
-type UserConfig<TBuildConfig extends BuildConfig = BuildConfig, TBuildResolvedConfig extends BuildResolvedConfig = BuildResolvedConfig, TBuildVariant extends string = any> = CommonUserConfig & {
-    build?: TBuildConfig & {
+type UserConfig<TBuildConfig extends BuildConfig = BuildConfig, TBuildResolvedConfig extends BuildResolvedConfig = BuildResolvedConfig, TBuildVariant extends string = any> = Omit<CommonUserConfig, "build"> & {
+    /**
+     * Configuration provided to build processes
+     *
+     * @remarks
+     * This configuration can be used by plugins during the `build` command. It will generally contain options specific to the selected {@link BuildVariant | build variant}.
+     */
+    build: Omit<TBuildConfig, "override"> & {
         /**
          * The build variant being used by the Powerlines engine.
          */
         variant?: TBuildVariant;
+        /**
+         * An optional set of override options to apply to the selected build variant.
+         *
+         * @remarks
+         * This option allows you to provide configuration options with the guarantee that they will **not** be overridden and will take precedence over other build configurations.
+         */
+        override?: Partial<TBuildResolvedConfig>;
     };
-    override?: Partial<TBuildResolvedConfig>;
 };
-type PowerlinesCommand = "new" | "prepare" | "build" | "lint" | "test" | "docs" | "release" | "clean";
+type PowerlinesCommand = "new" | "prepare" | "build" | "lint" | "test" | "docs" | "deploy" | "clean";
 /**
  * The configuration provided while executing Powerlines commands.
  */
@@ -778,14 +873,6 @@ interface MetaInfo {
      * A hash that represents the path to the project root directory
      */
     configHash: string;
-    /**
-     * A mapping of runtime ids to their corresponding file paths
-     */
-    builtinIdMap: Record<string, string>;
-    /**
-     * A mapping of virtual file paths to their corresponding file contents
-     */
-    virtualFiles: Record<string, string | null>;
 }
 interface Resolver extends Jiti {
     plugin: Jiti;
@@ -798,7 +885,13 @@ interface InitContextOptions {
      */
     isHighPriority: boolean;
 }
-interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
+/**
+ * The unresolved Powerlines context.
+ *
+ * @remarks
+ * This context is used before the user configuration has been fully resolved after the `config`.
+ */
+interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
     /**
      * The Storm workspace configuration
      */
@@ -806,7 +899,10 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
     /**
      * An object containing the options provided to Powerlines
      */
-    config: TResolvedConfig;
+    config: Omit<TResolvedConfig["userConfig"], "build" | "output"> & Required<Pick<TResolvedConfig["userConfig"], "build" | "output">> & {
+        projectRoot: NonUndefined<TResolvedConfig["userConfig"]["root"]>;
+        output: TResolvedConfig["output"];
+    };
     /**
      * A logging function for the Powerlines engine
      */
@@ -963,6 +1059,12 @@ interface Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> {
      */
     extendLog: (name: string) => LogFn;
 }
+type Context<TResolvedConfig extends ResolvedConfig = ResolvedConfig> = Omit<UnresolvedContext<TResolvedConfig>, "config"> & {
+    /**
+     * The fully resolved Powerlines configuration
+     */
+    config: TResolvedConfig;
+};
 interface PluginContext<out TResolvedConfig extends ResolvedConfig = ResolvedConfig> extends Context<TResolvedConfig>, UnpluginContext {
     /**
      * The environment specific resolved configuration
@@ -1774,4 +1876,4 @@ interface SecretsInterface {
     ENCRYPTION_KEY: string;
 }
 
-export type { BabelUserConfig as B, Context as C, DeclareBabelTransformPluginReturn as D, EnvInterface as E, PluginContext as P, ResolvedConfig as R, SecretsInterface as S, UserConfig as U, EnvironmentResolvedConfig as a, Plugin as b, BabelResolvedConfig as c };
+export type { BabelUserConfig as B, Context as C, DeclareBabelTransformPluginReturn as D, EnvInterface as E, PluginContext as P, ResolvedConfig as R, SecretsInterface as S, UnresolvedContext as U, EnvironmentResolvedConfig as a, Plugin as b, UserConfig as c, BabelResolvedConfig as d };