@powerlines/plugin-env 0.13.64 → 0.13.66

package/dist/powerlines/src/types/tsconfig.d.cts

@@ -0,0 +1,69 @@
+import { CompilerOptions, TsConfigJson } from "@stryke/types/tsconfig";
+import ts from "typescript";
+
+//#region ../powerlines/src/types/tsconfig.d.ts
+type ReflectionMode = "default" | "explicit" | "never";
+type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
+/**
+ * Defines the level of reflection to be used during the transpilation process.
+ *
+ * @remarks
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+ * - `minimal` - Only the essential type information is captured.
+ * - `normal` - Additional type information is captured, including some contextual data.
+ * - `verbose` - All available type information is captured, including detailed contextual data.
+ */
+type ReflectionLevel = "minimal" | "normal" | "verbose";
+interface DeepkitOptions {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+}
+type TSCompilerOptions = CompilerOptions & DeepkitOptions;
+/**
+ * The TypeScript compiler configuration.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
+ */
+interface TSConfig extends Omit<TsConfigJson, "reflection"> {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+  /**
+   * Instructs the TypeScript compiler how to compile `.ts` files.
+   */
+  compilerOptions?: TSCompilerOptions;
+}
+type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
+  originalTsconfigJson: TsConfigJson;
+  tsconfigJson: TSConfig;
+  tsconfigFilePath: string;
+};
+//#endregion
+export { ParsedTypeScriptConfig, TSConfig };

package/dist/powerlines/src/types/tsconfig.d.mts

@@ -0,0 +1,69 @@
+import { CompilerOptions, TsConfigJson } from "@stryke/types/tsconfig";
+import ts from "typescript";
+
+//#region ../powerlines/src/types/tsconfig.d.ts
+type ReflectionMode = "default" | "explicit" | "never";
+type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
+/**
+ * Defines the level of reflection to be used during the transpilation process.
+ *
+ * @remarks
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+ * - `minimal` - Only the essential type information is captured.
+ * - `normal` - Additional type information is captured, including some contextual data.
+ * - `verbose` - All available type information is captured, including detailed contextual data.
+ */
+type ReflectionLevel = "minimal" | "normal" | "verbose";
+interface DeepkitOptions {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+}
+type TSCompilerOptions = CompilerOptions & DeepkitOptions;
+/**
+ * The TypeScript compiler configuration.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
+ */
+interface TSConfig extends Omit<TsConfigJson, "reflection"> {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+  /**
+   * Instructs the TypeScript compiler how to compile `.ts` files.
+   */
+  compilerOptions?: TSCompilerOptions;
+}
+type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
+  originalTsconfigJson: TsConfigJson;
+  tsconfigJson: TSConfig;
+  tsconfigFilePath: string;
+};
+//#endregion
+export { DeepkitOptions, ParsedTypeScriptConfig, RawReflectionMode, ReflectionLevel, ReflectionMode, TSCompilerOptions, TSConfig };

package/dist/powerlines/src/types/unplugin.d.mts

@@ -0,0 +1,7 @@
+import "./build.mjs";
+import "./resolved.mjs";
+import "./plugin.mjs";
+import "./context.mjs";
+import "./config.mjs";
+import "./api.mjs";
+import { UnpluginOptions } from "unplugin";

package/dist/types/index.cjs

@@ -1 +0,0 @@
-require(`../plugin-CRYQ682C.cjs`),require(`../runtime-BaZivi6m.cjs`),require(`../types-DS7T32tb.cjs`);

package/dist/types/index.d.cts

@@ -1,6 +1,3 @@
-import "../type-D6dRgWJT.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-Ds60xmj5.cjs";
-import "../config-CxGVaXL4.cjs";
-import { i as __ΩSecretsInterface, n as SecretsInterface, r as __ΩEnvInterface, t as EnvInterface } from "../runtime-BxuH9yuK.cjs";
-import "../index-CspKFJM1.cjs";
+import { EnvInterface, SecretsInterface, __ΩEnvInterface, __ΩSecretsInterface } from "./runtime.cjs";
+import { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType } from "./plugin.cjs";
 export { EnvInterface, EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, SecretsInterface, __ΩEnvInterface, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType, __ΩSecretsInterface };

package/dist/types/index.d.mts

@@ -1,6 +1,3 @@
-import "../type-CnPIyotQ.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-BC31CJSb.mjs";
-import "../config-CYnsaVbs.mjs";
-import { i as __ΩSecretsInterface, n as SecretsInterface, r as __ΩEnvInterface, t as EnvInterface } from "../runtime-qQN60UNu.mjs";
-import "../index-CRo77wc3.mjs";
+import { EnvInterface, SecretsInterface, __ΩEnvInterface, __ΩSecretsInterface } from "./runtime.mjs";
+import { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType } from "./plugin.mjs";
 export { EnvInterface, EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, SecretsInterface, __ΩEnvInterface, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType, __ΩSecretsInterface };

package/dist/types/index.mjs

@@ -1 +1 @@
-import"../plugin-DrnPbdzR.mjs";import"../runtime-DqCYc37d.mjs";import"../types-BCto_Rzj.mjs";export{};
+export{};

package/dist/types/plugin.cjs

@@ -1 +0,0 @@
-require(`../plugin-CRYQ682C.cjs`);

package/dist/types/plugin.d.cts

@@ -1,5 +1,141 @@
-import "../type-D6dRgWJT.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-Ds60xmj5.cjs";
-import "../config-CxGVaXL4.cjs";
-import "../runtime-BxuH9yuK.cjs";
+import { Reflection } from "../deepkit/src/types.cjs";
+import { BabelPluginContext, BabelPluginOptions, BabelPluginResolvedConfig, BabelPluginUserConfig } from "../plugin-babel/src/types/plugin.cjs";
+import { EnvInterface, SecretsInterface } from "./runtime.cjs";
+import { Children } from "@alloy-js/core/jsx-runtime";
+import { DotenvConfiguration, TypeDefinition, TypeDefinitionParameter } from "@stryke/types/configuration";
+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;
+};
+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[];
+//#endregion
 export { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType };

package/dist/types/plugin.d.mts

@@ -1,5 +1,142 @@
-import "../type-CnPIyotQ.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-BC31CJSb.mjs";
-import "../config-CYnsaVbs.mjs";
-import "../runtime-qQN60UNu.mjs";
+import { Reflection } from "../deepkit/src/types.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;
+};
+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[];
+//#endregion
 export { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType };

package/dist/types/plugin.mjs

@@ -1 +1 @@
-import"../plugin-DrnPbdzR.mjs";export{};
+export{};

package/dist/types/runtime.cjs

@@ -1 +0,0 @@
-require(`../runtime-BaZivi6m.cjs`);