@powerlines/plugin-env 0.1.0

package/dist/types/index.cjs

@@ -0,0 +1 @@
+'use strict';var plugin=require('./plugin'),runtime=require('./runtime');Object.keys(plugin).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return plugin[k]}})});Object.keys(runtime).forEach(function(k){if(k!=='default'&&!Object.prototype.hasOwnProperty.call(exports,k))Object.defineProperty(exports,k,{enumerable:true,get:function(){return runtime[k]}})});

package/dist/types/index.d.cts

@@ -0,0 +1,27 @@
+export { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType } from './plugin.cjs';
+export { E as EnvInterface, S as SecretsInterface, _ as __ΩEnvInterface, b as __ΩSecretsInterface } from '../runtime-I3P49niA.cjs';
+import '@alloy-js/core/jsx-runtime';
+import '@stryke/env/types';
+import '@stryke/types/configuration';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import '@deepkit/type';
+import 'unplugin';
+import '@stryke/capnp';
+import '@storm-software/config-tools/types';
+import '@stryke/types/base';
+import '@stryke/types/file';
+import 'vite';
+import '@babel/core';
+import '@storm-software/build-tools/types';
+import '@storm-software/config/types';
+import '@babel/helper-plugin-utils';
+import 'semver';
+import '@stryke/types/array';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '../vfs-COoZkq8D.cjs';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';

package/dist/types/index.d.ts

@@ -0,0 +1,27 @@
+export { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType } from './plugin.js';
+export { E as EnvInterface, S as SecretsInterface, _ as __ΩEnvInterface, b as __ΩSecretsInterface } from '../runtime-DqvtGYT3.js';
+import '@alloy-js/core/jsx-runtime';
+import '@stryke/env/types';
+import '@stryke/types/configuration';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import '@deepkit/type';
+import 'unplugin';
+import '@stryke/capnp';
+import '@storm-software/config-tools/types';
+import '@stryke/types/base';
+import '@stryke/types/file';
+import 'vite';
+import '@babel/core';
+import '@storm-software/build-tools/types';
+import '@storm-software/config/types';
+import '@babel/helper-plugin-utils';
+import 'semver';
+import '@stryke/types/array';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '../vfs-COoZkq8D.js';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';

package/dist/types/index.js

@@ -0,0 +1 @@
+export*from'./plugin';export*from'./runtime';

package/dist/types/plugin.cjs

@@ -0,0 +1 @@
+'use strict';

package/dist/types/plugin.d.cts

@@ -0,0 +1,169 @@
+import { Children } from '@alloy-js/core/jsx-runtime';
+import { c as BabelUserConfig, U as UserConfig, R as ResolvedConfig, d as BabelResolvedConfig, e as PluginContext, f as Reflection, E as EnvInterface, S as SecretsInterface } from '../runtime-I3P49niA.cjs';
+import { DotenvParseOutput } from '@stryke/env/types';
+import { DotenvConfiguration, TypeDefinitionParameter, TypeDefinition } from '@stryke/types/configuration';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import '@deepkit/type';
+import 'unplugin';
+import '@stryke/capnp';
+import '@storm-software/config-tools/types';
+import '@stryke/types/base';
+import '@stryke/types/file';
+import 'vite';
+import '@babel/core';
+import '@storm-software/build-tools/types';
+import '@storm-software/config/types';
+import '@babel/helper-plugin-utils';
+import 'semver';
+import '@stryke/types/array';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '../vfs-COoZkq8D.cjs';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+
+type BabelPluginOptions = Partial<BabelUserConfig>;
+type BabelPluginUserConfig = UserConfig;
+interface BabelPluginResolvedConfig extends ResolvedConfig {
+    transform: {
+        babel: BabelResolvedConfig;
+    };
+}
+type BabelPluginContext<TResolvedConfig extends BabelPluginResolvedConfig = BabelPluginResolvedConfig> = PluginContext<TResolvedConfig>;
+
+type EnvType = "env" | "secrets";
+type EnvPluginOptions = Omit<DotenvConfiguration, "types"> & {
+    /**
+     * A path to the type definition for the expected env configuration parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#ConfigConfiguration"`.
+     */
+    types?: TypeDefinitionParameter;
+    /**
+     * A path to the type definition for the expected env secret parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#ConfigSecrets"`.
+     */
+    secrets?: TypeDefinitionParameter;
+    /**
+     * An additional prefix (or list of additional prefixes) to apply to the environment variables
+     *
+     * @remarks
+     * By default, the plugin will use the `POWERLINES_` prefix. This option is useful for avoiding conflicts with other environment variables.
+     */
+    prefix?: string | string[];
+    /**
+     * Should the plugin inject the env variables in the source code with their values?
+     *
+     * @remarks
+     * This option is set to `true` when building an application project.
+     *
+     * @defaultValue false
+     */
+    inject?: boolean;
+    /**
+     * The default configuration to use when loading environment variables.
+     *
+     * @remarks
+     * This configuration is used as the base configuration when loading environment variables, and will be overridden by any values found in the `.env` file or the process environment.
+     */
+    defaultConfig?: Children;
+    /**
+     * Babel configuration options to use when injecting environment variables into the source code.
+     *
+     * @remarks
+     * This option allows you to customize the Babel transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Babel settings.
+     */
+    babel?: BabelPluginOptions;
+};
+type EnvPluginUserConfig = BabelPluginUserConfig & {
+    env: EnvPluginOptions;
+};
+type EnvPluginResolvedConfig = BabelPluginResolvedConfig & {
+    env: Required<Pick<DotenvConfiguration, "additionalFiles">> & Required<Pick<EnvPluginOptions, "defaultConfig">> & {
+        /**
+         * The type definition for the expected env variable parameters
+         *
+         * @remarks
+         * This value is parsed from the {@link EnvPluginOptions.types} option.
+         */
+        types: TypeDefinition;
+        /**
+         * The type definition for the expected env secret parameters
+         *
+         * @remarks
+         * This value is parsed from the {@link EnvPluginOptions.secrets} option.
+         */
+        secrets: TypeDefinition;
+        /**
+         * Should the plugin inject the env variables in the source code with their values?
+         *
+         * @remarks
+         * This value is the result of reflecting the {@link EnvPluginOptions.inject} option.
+         */
+        inject: EnvPluginOptions["inject"];
+        /**
+         * The prefix used for environment variables
+         *
+         * @remarks
+         * This value is used to filter environment variables that are loaded from the .env file and the process environment.
+         */
+        prefix: string[];
+    };
+};
+interface EnvPluginContext<TResolvedConfig extends EnvPluginResolvedConfig = EnvPluginResolvedConfig> extends BabelPluginContext<TResolvedConfig> {
+    env: {
+        /**
+         * The type definitions reflection for the env variables and secrets
+         *
+         * @remarks
+         * These reflections contains the structure of the expected environment variables and secrets as defined by the type definitions provided in the plugin configuration.
+         */
+        types: {
+            /**
+             * The type definitions for the expected env variables
+             */
+            env: Reflection;
+            /**
+             * The type definitions for the expected env secrets
+             */
+            secrets: Reflection;
+        };
+        /**
+         * The current **used** environment variables and secrets reflection
+         *
+         * @remarks
+         * This reflection contains the structure of the current environment variables and secrets as defined during the plugin initialization by extracting the values from the source code.
+         */
+        used: {
+            /**
+             * The current env variables reflection
+             */
+            env: Reflection<EnvInterface>;
+            /**
+             * The current env secrets reflection
+             */
+            secrets: Reflection<SecretsInterface>;
+        };
+        /**
+         * The parsed .env configuration object
+         *
+         * @remarks
+         * This value is the result of loading the .env configuration file found in the project root directory and merging it with the values provided at {@link EnvPluginOptions.values}
+         */
+        parsed: DotenvParseOutput;
+        /**
+         * The injected environment variables and secrets reflection
+         *
+         * @remarks
+         * This reflection contains the structure of the injected environment variables and secrets that were injected into the source code during the build process.
+         */
+        injected: Reflection;
+    };
+}
+declare type __ΩEnvType = any[];
+declare type __ΩEnvPluginOptions = any[];
+declare type __ΩEnvPluginUserConfig = any[];
+declare type __ΩEnvPluginResolvedConfig = any[];
+declare type __ΩEnvPluginContext = any[];
+
+export type { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType };

package/dist/types/plugin.d.ts

@@ -0,0 +1,169 @@
+import { Children } from '@alloy-js/core/jsx-runtime';
+import { c as BabelUserConfig, U as UserConfig, R as ResolvedConfig, d as BabelResolvedConfig, e as PluginContext, f as Reflection, E as EnvInterface, S as SecretsInterface } from '../runtime-DqvtGYT3.js';
+import { DotenvParseOutput } from '@stryke/env/types';
+import { DotenvConfiguration, TypeDefinitionParameter, TypeDefinition } from '@stryke/types/configuration';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import '@deepkit/type';
+import 'unplugin';
+import '@stryke/capnp';
+import '@storm-software/config-tools/types';
+import '@stryke/types/base';
+import '@stryke/types/file';
+import 'vite';
+import '@babel/core';
+import '@storm-software/build-tools/types';
+import '@storm-software/config/types';
+import '@babel/helper-plugin-utils';
+import 'semver';
+import '@stryke/types/array';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '../vfs-COoZkq8D.js';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';
+
+type BabelPluginOptions = Partial<BabelUserConfig>;
+type BabelPluginUserConfig = UserConfig;
+interface BabelPluginResolvedConfig extends ResolvedConfig {
+    transform: {
+        babel: BabelResolvedConfig;
+    };
+}
+type BabelPluginContext<TResolvedConfig extends BabelPluginResolvedConfig = BabelPluginResolvedConfig> = PluginContext<TResolvedConfig>;
+
+type EnvType = "env" | "secrets";
+type EnvPluginOptions = Omit<DotenvConfiguration, "types"> & {
+    /**
+     * A path to the type definition for the expected env configuration parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#ConfigConfiguration"`.
+     */
+    types?: TypeDefinitionParameter;
+    /**
+     * A path to the type definition for the expected env secret parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#ConfigSecrets"`.
+     */
+    secrets?: TypeDefinitionParameter;
+    /**
+     * An additional prefix (or list of additional prefixes) to apply to the environment variables
+     *
+     * @remarks
+     * By default, the plugin will use the `POWERLINES_` prefix. This option is useful for avoiding conflicts with other environment variables.
+     */
+    prefix?: string | string[];
+    /**
+     * Should the plugin inject the env variables in the source code with their values?
+     *
+     * @remarks
+     * This option is set to `true` when building an application project.
+     *
+     * @defaultValue false
+     */
+    inject?: boolean;
+    /**
+     * The default configuration to use when loading environment variables.
+     *
+     * @remarks
+     * This configuration is used as the base configuration when loading environment variables, and will be overridden by any values found in the `.env` file or the process environment.
+     */
+    defaultConfig?: Children;
+    /**
+     * Babel configuration options to use when injecting environment variables into the source code.
+     *
+     * @remarks
+     * This option allows you to customize the Babel transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Babel settings.
+     */
+    babel?: BabelPluginOptions;
+};
+type EnvPluginUserConfig = BabelPluginUserConfig & {
+    env: EnvPluginOptions;
+};
+type EnvPluginResolvedConfig = BabelPluginResolvedConfig & {
+    env: Required<Pick<DotenvConfiguration, "additionalFiles">> & Required<Pick<EnvPluginOptions, "defaultConfig">> & {
+        /**
+         * The type definition for the expected env variable parameters
+         *
+         * @remarks
+         * This value is parsed from the {@link EnvPluginOptions.types} option.
+         */
+        types: TypeDefinition;
+        /**
+         * The type definition for the expected env secret parameters
+         *
+         * @remarks
+         * This value is parsed from the {@link EnvPluginOptions.secrets} option.
+         */
+        secrets: TypeDefinition;
+        /**
+         * Should the plugin inject the env variables in the source code with their values?
+         *
+         * @remarks
+         * This value is the result of reflecting the {@link EnvPluginOptions.inject} option.
+         */
+        inject: EnvPluginOptions["inject"];
+        /**
+         * The prefix used for environment variables
+         *
+         * @remarks
+         * This value is used to filter environment variables that are loaded from the .env file and the process environment.
+         */
+        prefix: string[];
+    };
+};
+interface EnvPluginContext<TResolvedConfig extends EnvPluginResolvedConfig = EnvPluginResolvedConfig> extends BabelPluginContext<TResolvedConfig> {
+    env: {
+        /**
+         * The type definitions reflection for the env variables and secrets
+         *
+         * @remarks
+         * These reflections contains the structure of the expected environment variables and secrets as defined by the type definitions provided in the plugin configuration.
+         */
+        types: {
+            /**
+             * The type definitions for the expected env variables
+             */
+            env: Reflection;
+            /**
+             * The type definitions for the expected env secrets
+             */
+            secrets: Reflection;
+        };
+        /**
+         * The current **used** environment variables and secrets reflection
+         *
+         * @remarks
+         * This reflection contains the structure of the current environment variables and secrets as defined during the plugin initialization by extracting the values from the source code.
+         */
+        used: {
+            /**
+             * The current env variables reflection
+             */
+            env: Reflection<EnvInterface>;
+            /**
+             * The current env secrets reflection
+             */
+            secrets: Reflection<SecretsInterface>;
+        };
+        /**
+         * The parsed .env configuration object
+         *
+         * @remarks
+         * This value is the result of loading the .env configuration file found in the project root directory and merging it with the values provided at {@link EnvPluginOptions.values}
+         */
+        parsed: DotenvParseOutput;
+        /**
+         * The injected environment variables and secrets reflection
+         *
+         * @remarks
+         * This reflection contains the structure of the injected environment variables and secrets that were injected into the source code during the build process.
+         */
+        injected: Reflection;
+    };
+}
+declare type __ΩEnvType = any[];
+declare type __ΩEnvPluginOptions = any[];
+declare type __ΩEnvPluginUserConfig = any[];
+declare type __ΩEnvPluginResolvedConfig = any[];
+declare type __ΩEnvPluginContext = any[];
+
+export type { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType };

package/dist/types/runtime.cjs

@@ -0,0 +1 @@
+'use strict';

package/dist/types/runtime.d.cts

@@ -0,0 +1,24 @@
+export { E as EnvInterface, S as SecretsInterface, _ as __ΩEnvInterface, b as __ΩSecretsInterface } from '../runtime-I3P49niA.cjs';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import '@deepkit/type';
+import 'unplugin';
+import '@stryke/capnp';
+import '@storm-software/config-tools/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'vite';
+import '@babel/core';
+import '@storm-software/build-tools/types';
+import '@storm-software/config/types';
+import '@babel/helper-plugin-utils';
+import 'semver';
+import '@stryke/types/array';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '../vfs-COoZkq8D.cjs';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';

package/dist/types/runtime.d.ts

@@ -0,0 +1,24 @@
+export { E as EnvInterface, S as SecretsInterface, _ as __ΩEnvInterface, b as __ΩSecretsInterface } from '../runtime-DqvtGYT3.js';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jiti';
+import '@deepkit/type';
+import 'unplugin';
+import '@stryke/capnp';
+import '@storm-software/config-tools/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'vite';
+import '@babel/core';
+import '@storm-software/build-tools/types';
+import '@storm-software/config/types';
+import '@babel/helper-plugin-utils';
+import 'semver';
+import '@stryke/types/array';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '../vfs-COoZkq8D.js';
+import 'memfs';
+import 'node:fs';
+import 'unionfs';