@powerlines/plugin-env 0.15.4 → 0.15.6

package/dist/types/plugin.d.cts

@@ -1,4 +1,157 @@
-import "../resolved-BZG2cwRG.cjs";
-import { a as EnvType, c as __ΩEnvPluginResolvedConfig, i as EnvPluginUserConfig, l as __ΩEnvPluginUserConfig, n as EnvPluginOptions, o as __ΩEnvPluginContext, r as EnvPluginResolvedConfig, s as __ΩEnvPluginOptions, t as EnvPluginContext, u as __ΩEnvType } from "../plugin-BwuEBScL.cjs";
-import "../runtime-Q8Ni8SeN.cjs";
+import { Reflection } from "../deepkit/src/types.cjs";
+import { AlloyPluginContext, AlloyPluginOptions, AlloyPluginResolvedConfig, AlloyPluginUserConfig } from "../plugin-alloy/src/types/plugin.cjs";
+import { AutoMDPluginOptions } from "../plugin-automd/src/types/plugin.cjs";
+import { BabelPluginContext, BabelPluginOptions, BabelPluginResolvedConfig, BabelPluginUserConfig } from "../plugin-babel/src/types/plugin.cjs";
+import { EnvInterface, SecretsInterface } from "./runtime.cjs";
+import { DotenvConfiguration, TypeDefinition, TypeDefinitionParameter } from "@stryke/types/configuration";
+import { Children } from "@alloy-js/core/jsx-runtime";
+import { DotenvParseOutput } from "@stryke/env/types";
+
+//#region src/types/plugin.d.ts
+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;
+  /**
+   * AutoMD configuration options to allow injecting environment variables documentation into a markdown file such as a README.md.
+   *
+   * @remarks
+   * The README.md file should contain the `<!-- automd:env --><!-- /automd -->` comment block where the documentation will be injected.
+   */
+  automd?: AutoMDPluginOptions;
+  /**
+   * Alloy configuration options to use when injecting environment variables into the source code.
+   *
+   * @remarks
+   * This option allows you to customize the Alloy transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Alloy settings.
+   */
+  alloy?: AlloyPluginOptions;
+};
+type EnvPluginUserConfig = BabelPluginUserConfig & AlloyPluginUserConfig & {
+  env: EnvPluginOptions;
+};
+type EnvPluginResolvedConfig = BabelPluginResolvedConfig & AlloyPluginResolvedConfig & {
+  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>, AlloyPluginContext<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[];
+//#endregion
 export { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType };

package/dist/types/plugin.d.mts

@@ -1,5 +1,159 @@
-import "../resolved-V5COsfDu.mjs";
-import "../components-8W0Zgj0y.mjs";
-import { a as EnvType, c as __ΩEnvPluginResolvedConfig, i as EnvPluginUserConfig, l as __ΩEnvPluginUserConfig, n as EnvPluginOptions, o as __ΩEnvPluginContext, r as EnvPluginResolvedConfig, s as __ΩEnvPluginOptions, t as EnvPluginContext, u as __ΩEnvType } from "../plugin-BaInAuAh.mjs";
-import "../runtime-qZ0Z2kEd.mjs";
+import { Reflection } from "../deepkit/src/types.mjs";
+import { AlloyPluginContext, AlloyPluginOptions, AlloyPluginResolvedConfig, AlloyPluginUserConfig } from "../plugin-alloy/src/types/plugin.mjs";
+import "../plugin-alloy/src/types/index.mjs";
+import { AutoMDPluginOptions } from "../plugin-automd/src/types/plugin.mjs";
+import { BabelPluginContext, BabelPluginOptions, BabelPluginResolvedConfig, BabelPluginUserConfig } from "../plugin-babel/src/types/plugin.mjs";
+import "../plugin-babel/src/types/index.mjs";
+import { EnvInterface, SecretsInterface } from "./runtime.mjs";
+import { Children } from "@alloy-js/core/jsx-runtime";
+import { DotenvParseOutput } from "@stryke/env/types";
+import { DotenvConfiguration, TypeDefinition, TypeDefinitionParameter } from "@stryke/types/configuration";
+
+//#region src/types/plugin.d.ts
+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;
+  /**
+   * AutoMD configuration options to allow injecting environment variables documentation into a markdown file such as a README.md.
+   *
+   * @remarks
+   * The README.md file should contain the `<!-- automd:env --><!-- /automd -->` comment block where the documentation will be injected.
+   */
+  automd?: AutoMDPluginOptions;
+  /**
+   * Alloy configuration options to use when injecting environment variables into the source code.
+   *
+   * @remarks
+   * This option allows you to customize the Alloy transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Alloy settings.
+   */
+  alloy?: AlloyPluginOptions;
+};
+type EnvPluginUserConfig = BabelPluginUserConfig & AlloyPluginUserConfig & {
+  env: EnvPluginOptions;
+};
+type EnvPluginResolvedConfig = BabelPluginResolvedConfig & AlloyPluginResolvedConfig & {
+  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>, AlloyPluginContext<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[];
+//#endregion
 export { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType };

package/dist/types/plugin.mjs

@@ -1,3 +1,129 @@
-import "../plugin-D3B5E_Hg.mjs";
+import { __ΩAutoMDPluginOptions } from "../plugin-automd/src/types/plugin.mjs";
+import { __ΩBabelPluginContext, __ΩBabelPluginOptions, __ΩBabelPluginResolvedConfig, __ΩBabelPluginUserConfig } from "../plugin-babel/src/types/plugin.mjs";
+import { __ΩAlloyPluginContext, __ΩAlloyPluginOptions, __ΩAlloyPluginResolvedConfig, __ΩAlloyPluginUserConfig } from "../plugin-alloy/src/types/plugin.mjs";
+import { __ΩReflection } from "../deepkit/src/types.mjs";
+import { __ΩEnvInterface, __ΩSecretsInterface } from "./runtime.mjs";
 
-export {  };
+//#region src/types/plugin.ts
+const __ΩOmit = [
+	"T",
+	"K",
+	() => __ΩPick,
+	() => __ΩExclude,
+	"Omit",
+	"b!b\"e!!e!!ge!\"o$#o##w%y"
+];
+const __ΩRequired = [
+	"T",
+	"Required",
+	"l+e#!e\"!fRb!Pde\"!gN##w\"y"
+];
+const __ΩPick = [
+	"T",
+	"K",
+	"Pick",
+	"l+e#!e\"!fRb!b\"Pde\"\"N#!w#y"
+];
+const __ΩExclude = [
+	"T",
+	"U",
+	"Exclude",
+	"l6!Re$!RPe#!e$\"qk#%QRb!b\"Pde\"!p)w#y"
+];
+const __ΩEnvType = [
+	"env",
+	"secrets",
+	"EnvType",
+	"P.!.\"Jw#y"
+];
+const __ΩEnvPluginOptions = [
+	() => __ΩOmit,
+	"types",
+	"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\"`.",
+	"secrets",
+	"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\"`.",
+	"prefix",
+	"An additional prefix (or list of additional prefixes) to apply to the environment variables",
+	"inject",
+	true,
+	"Should the plugin inject the env variables in the source code with their values?",
+	"Children",
+	"defaultConfig",
+	"The default configuration to use when loading environment variables.",
+	() => __ΩBabelPluginOptions,
+	"babel",
+	"Babel configuration options to use when injecting environment variables into the source code.",
+	() => __ΩAutoMDPluginOptions,
+	"automd",
+	"AutoMD configuration options to allow injecting environment variables documentation into a markdown file such as a README.md.",
+	() => __ΩAlloyPluginOptions,
+	"alloy",
+	"Alloy configuration options to use when injecting environment variables into the source code.",
+	"EnvPluginOptions",
+	"P!.\"o!#P!4#8?$!4%8?&P&&FJ4'8?()4)8>*?+\"w,4-8?.n/408?1n2438?4n5468?7MKw8y"
+];
+const __ΩEnvPluginUserConfig = [
+	() => __ΩBabelPluginUserConfig,
+	() => __ΩAlloyPluginUserConfig,
+	() => __ΩEnvPluginOptions,
+	"env",
+	"EnvPluginUserConfig",
+	"Pn!n\"Pn#4$MKw%y"
+];
+const __ΩEnvPluginResolvedConfig = [
+	() => __ΩBabelPluginResolvedConfig,
+	() => __ΩAlloyPluginResolvedConfig,
+	() => __ΩRequired,
+	() => __ΩPick,
+	"additionalFiles",
+	() => __ΩRequired,
+	() => __ΩPick,
+	() => __ΩEnvPluginOptions,
+	"defaultConfig",
+	"types",
+	"The type definition for the expected env variable parameters",
+	"secrets",
+	"The type definition for the expected env secret parameters",
+	() => __ΩEnvPluginOptions,
+	"inject",
+	"inject",
+	"Should the plugin inject the env variables in the source code with their values?",
+	"prefix",
+	"The prefix used for environment variables",
+	"env",
+	"EnvPluginResolvedConfig",
+	"Pn!n\"PP!.%o$#o#\"n(.)o'#o&\"P!4*?+!4,?-n../f40?1&F42?3MK44MKw5y"
+];
+const __ΩEnvPluginContext = [
+	() => __ΩEnvPluginResolvedConfig,
+	"TResolvedConfig",
+	() => __ΩBabelPluginContext,
+	() => __ΩAlloyPluginContext,
+	() => __ΩReflection,
+	"env",
+	"The type definitions for the expected env variables",
+	() => __ΩReflection,
+	"secrets",
+	"The type definitions for the expected env secrets",
+	"The type definitions reflection for the env variables and secrets",
+	"types",
+	() => __ΩReflection,
+	() => __ΩEnvInterface,
+	"The current env variables reflection",
+	() => __ΩReflection,
+	() => __ΩSecretsInterface,
+	"The current env secrets reflection",
+	"The current **used** environment variables and secrets reflection",
+	"used",
+	"parsed",
+	"The parsed .env configuration object",
+	() => __ΩReflection,
+	"injected",
+	"The injected environment variables and secrets reflection",
+	"EnvPluginContext",
+	"n!c\"Pe\"!o#\"e\"!o$\"PPn%4&?'n(4)?*M?+4,?+Pn.o-\"4&?/n1o0\"4)?2M?344?3!45?6n748?9M4&Mw:y"
+];
+
+//#endregion
+export { __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType };