@powerlines/plugin-env 0.15.2 → 0.15.4

package/dist/index.d.cts

@@ -1,16 +1,189 @@
-import { EnvDocs } from "./components/docs.cjs";
-import { Plugin } from "./powerlines/src/types/plugin.cjs";
-import { EnvBuiltin, EnvBuiltinProps, EnvTypeDefinition, __ΩEnvBuiltinProps } from "./components/env.cjs";
-import { EnvInterface, SecretsInterface, __ΩEnvInterface, __ΩSecretsInterface } from "./types/runtime.cjs";
-import { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType } from "./types/plugin.cjs";
-import { envBabelPlugin } from "./babel/plugin.cjs";
-import { createReflectionResource } from "./helpers/create-reflection-resource.cjs";
-import { loadEnv, loadEnvFromContext } from "./helpers/load.cjs";
-import { getEnvDefaultTypeDefinition, getEnvReflectionsPath, getEnvTypeReflectionsPath, getSecretsDefaultTypeDefinition, readEnvReflection, readEnvTypeReflection, readSecretsReflection, resolveRuntimeTypeFile, writeEnvReflection, writeEnvReflectionSync, writeEnvTypeReflection } from "./helpers/persistence.cjs";
-import { BaseEnv, BaseSecrets, CreateEnvReflectionOptions, __ΩCreateEnvReflectionOptions, createEnvReflection, createSecretsReflection, mergeEnvReflections, mergeSecretsReflections, reflectEnv, reflectSecrets } from "./helpers/reflect.cjs";
-import { formatEnvField, removeEnvPrefix } from "./helpers/source-file-env.cjs";
-import { createTemplateReflection } from "./helpers/template-helpers.cjs";
+import { t as EnvDocs } from "./docs-_MmTNBQX.cjs";
+import { d as Plugin, n as EnvironmentResolvedConfig, o as DeclareBabelTransformPluginReturn, s as Context, u as UnresolvedContext } from "./resolved-BZG2cwRG.cjs";
+import { i as __ΩEnvBuiltinProps, n as EnvBuiltinProps, r as EnvTypeDefinition, t as EnvBuiltin } from "./env-BPodCdD1.cjs";
+import "./index-DWPDThxu.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 { i as __ΩSecretsInterface, n as SecretsInterface, r as __ΩEnvInterface, t as EnvInterface } from "./runtime-Q8Ni8SeN.cjs";
+import "./index-CqdNToYT.cjs";
+import * as _alloy_js_core3 from "@alloy-js/core";
+import { TypeDefinition } from "@stryke/types/configuration";
+import { ReflectionClass, TypeClass, TypeObjectLiteral } from "@powerlines/deepkit/vendor/type";
+import { DotenvParseOutput } from "@stryke/env/types";
 
+//#region src/babel/plugin.d.ts
+declare const envBabelPlugin: DeclareBabelTransformPluginReturn<EnvPluginContext<EnvPluginResolvedConfig>, Record<string, any>>;
+//#endregion
+//#region src/helpers/create-reflection-resource.d.ts
+/**
+ * Creates a reflection resource for the environment configuration.
+ *
+ * @param context - The environment plugin context.
+ * @returns A resource that provides the reflection of the environment configuration.
+ */
+declare function createReflectionResource(context?: EnvPluginContext): _alloy_js_core3.Resource<ReflectionClass<Record<string, any>>>;
+//#endregion
+//#region src/helpers/load.d.ts
+/**
+ * Retrieves various dotenv configuration parameters from the context.
+ *
+ * @param context - The context to retrieve the dotenv configuration from.
+ * @param parsed - The parsed dotenv configuration.
+ * @returns An object containing the dotenv configuration.
+ */
+declare function loadEnvFromContext(context: EnvPluginContext, parsed: DotenvParseOutput): {
+  APP_NAME: string | undefined;
+  APP_VERSION: string | undefined;
+  BUILD_ID: string;
+  BUILD_TIMESTAMP: string;
+  BUILD_CHECKSUM: string;
+  RELEASE_ID: string;
+  RELEASE_TAG: string;
+  DEFAULT_LOCALE: string | undefined;
+  DEFAULT_TIMEZONE: string | undefined;
+  LOG_LEVEL: "error" | "warn" | "info" | "debug" | "trace" | null;
+  ERROR_URL: string | undefined;
+  ORGANIZATION: string | undefined;
+  PLATFORM: "node" | "browser" | "neutral" | undefined;
+  MODE: "test" | "development" | "production" | undefined;
+  DEBUG: boolean;
+  STACKTRACE: boolean;
+  ENVIRONMENT: EnvironmentResolvedConfig;
+};
+declare function loadEnv<TEnv extends DotenvParseOutput = DotenvParseOutput>(context: EnvPluginContext, options: EnvPluginOptions): Promise<TEnv>;
+//#endregion
+//#region src/helpers/persistence.d.ts
+/**
+ * Resolves the runtime type definition file for the environment variables.
+ *
+ * @param context - The plugin context.
+ * @returns The runtime type definition file for the environment variables.
+ */
+declare function resolveRuntimeTypeFile(context: UnresolvedContext<EnvPluginResolvedConfig>): Promise<string>;
+/**
+ * Gets the default type definition for the environment variables.
+ *
+ * @param context - The plugin context.
+ * @returns The default type definition for the environment variables.
+ */
+declare function getEnvDefaultTypeDefinition(context: UnresolvedContext<EnvPluginResolvedConfig>): Promise<TypeDefinition>;
+/** Gets the default type definition for the environment secrets.
+ *
+ * @param context - The plugin context.
+ * @returns The default type definition for the environment secrets.
+ */
+declare function getSecretsDefaultTypeDefinition(context: UnresolvedContext<EnvPluginResolvedConfig>): Promise<TypeDefinition>;
+/**
+ * Gets the path to the environment type reflections.
+ *
+ * @param context - The plugin context.
+ * @param name - The name of the type reflections.
+ * @returns The path to the environment type reflections.
+ */
+declare function getEnvTypeReflectionsPath(context: Context<EnvPluginResolvedConfig>, name?: EnvType): string;
+/**
+ * Reads the environment type reflection from the file system.
+ *
+ * @param context - The plugin context.
+ * @param name - The name of the type reflections.
+ * @returns The environment type reflection.
+ */
+declare function readEnvTypeReflection(context: EnvPluginContext, name?: EnvType): Promise<ReflectionClass<any>>;
+/**
+ * Writes the environment type reflection to the file system.
+ *
+ * @param context - The plugin context.
+ * @param reflection - The environment type reflection to write.
+ * @param name - The name of the type reflections.
+ */
+declare function writeEnvTypeReflection(context: EnvPluginContext, reflection: ReflectionClass<any>, name?: EnvType): Promise<void>;
+declare function getEnvReflectionsPath(context: EnvPluginContext, name: EnvType): string;
+/**
+ * Reads the environment reflection data from the file system.
+ *
+ * @param context - The plugin context.
+ * @returns The environment reflection data.
+ */
+declare function readEnvReflection(context: EnvPluginContext): Promise<ReflectionClass<any>>;
+/**
+ * Reads the secret environment reflection data from the file system.
+ *
+ * @param context - The plugin context.
+ * @returns The environment reflection data.
+ */
+declare function readSecretsReflection(context: EnvPluginContext): Promise<ReflectionClass<any>>;
+/**
+ * Writes the environment reflection data to the file system.
+ *
+ * @param context - The plugin context.
+ * @param reflection - The reflection data to write.
+ * @param name - The name of the reflection (either "env" or "secrets").
+ */
+declare function writeEnvReflection(context: EnvPluginContext, reflection: ReflectionClass<any>, name?: EnvType): Promise<void>;
+/**
+ * Writes the environment reflection data to the file system.
+ *
+ * @param context - The plugin context.
+ * @param reflection - The reflection data to write.
+ * @param name - The name of the reflection (either "env" or "secrets").
+ */
+declare function writeEnvReflectionSync(context: EnvPluginContext, reflection: ReflectionClass<any>, name?: EnvType): void;
+//#endregion
+//#region src/helpers/reflect.d.ts
+declare function mergeEnvReflections(context: EnvPluginContext, reflections: ReflectionClass<any>[]): ReflectionClass<any>;
+declare function mergeSecretsReflections(context: EnvPluginContext, reflections: ReflectionClass<any>[]): ReflectionClass<any>;
+interface CreateEnvReflectionOptions {
+  type?: TypeObjectLiteral | TypeClass;
+  superReflection?: ReflectionClass<any>;
+}
+declare class BaseEnv implements EnvInterface {
+  APP_NAME: string;
+  APP_VERSION: string;
+  BUILD_ID: string;
+  BUILD_TIMESTAMP: string;
+  BUILD_CHECKSUM: string;
+  RELEASE_ID: string;
+  RELEASE_TAG: string;
+  ORGANIZATION: string;
+  PLATFORM: "node" | "browser" | "neutral";
+  MODE: "development" | "test" | "production";
+  ENVIRONMENT: string;
+  DEBUG: boolean;
+  TEST: boolean;
+  MINIMAL: boolean;
+  NO_COLOR: boolean;
+  FORCE_COLOR: number | boolean;
+  FORCE_HYPERLINK: number | boolean;
+  STACKTRACE: boolean;
+  INCLUDE_ERROR_DATA: boolean;
+  ERROR_URL: string;
+  DEFAULT_TIMEZONE: string;
+  DEFAULT_LOCALE: string;
+  CI: boolean;
+}
+declare class BaseSecrets implements SecretsInterface {
+  ENCRYPTION_KEY: string;
+}
+declare function createEnvReflection(context: EnvPluginContext, options?: CreateEnvReflectionOptions): ReflectionClass<any>;
+declare function createSecretsReflection(context: EnvPluginContext, options?: CreateEnvReflectionOptions): ReflectionClass<any>;
+declare function reflectEnv(context: EnvPluginContext, file?: string, name?: string): Promise<ReflectionClass<any>>;
+declare function reflectSecrets(context: EnvPluginContext, file?: string, name?: string): Promise<ReflectionClass<any>>;
+declare type __ΩCreateEnvReflectionOptions = any[];
+//#endregion
+//#region src/helpers/source-file-env.d.ts
+type TReturned<TEnv> = TEnv extends string ? string : DotenvParseOutput;
+declare function removeEnvPrefix<TEnv extends DotenvParseOutput | string>(env: TEnv): TReturned<TEnv>;
+declare function formatEnvField(key: string): string;
+//#endregion
+//#region src/helpers/template-helpers.d.ts
+/**
+ * Creates the reflection data used when generating runtime template files.
+ *
+ * @param context - The context for the configuration plugin.
+ * @param name - The name of the configuration template.
+ * @returns The reflection for the specified configuration template.
+ */
+declare function createTemplateReflection(context: EnvPluginContext, name?: EnvType): Promise<ReflectionClass<any>>;
+//#endregion
 //#region src/index.d.ts
 /**
  * A Powerlines plugin to inject environment variables into the source code.

package/dist/index.d.mts

@@ -1,21 +1,194 @@
-import { EnvDocs } from "./components/docs.mjs";
-import { Plugin } from "./powerlines/src/types/plugin.mjs";
-import { EnvBuiltin, EnvBuiltinProps, EnvTypeDefinition, __ΩEnvBuiltinProps } from "./components/env.mjs";
-import "./components/index.mjs";
-import "./powerlines/src/index.mjs";
-import { EnvInterface, SecretsInterface, __ΩEnvInterface, __ΩSecretsInterface } from "./types/runtime.mjs";
-import { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType } from "./types/plugin.mjs";
-import { envBabelPlugin } from "./babel/plugin.mjs";
-import "./babel/index.mjs";
-import { createReflectionResource } from "./helpers/create-reflection-resource.mjs";
-import { loadEnv, loadEnvFromContext } from "./helpers/load.mjs";
-import { getEnvDefaultTypeDefinition, getEnvReflectionsPath, getEnvTypeReflectionsPath, getSecretsDefaultTypeDefinition, readEnvReflection, readEnvTypeReflection, readSecretsReflection, resolveRuntimeTypeFile, writeEnvReflection, writeEnvReflectionSync, writeEnvTypeReflection } from "./helpers/persistence.mjs";
-import { BaseEnv, BaseSecrets, CreateEnvReflectionOptions, __ΩCreateEnvReflectionOptions, createEnvReflection, createSecretsReflection, mergeEnvReflections, mergeSecretsReflections, reflectEnv, reflectSecrets } from "./helpers/reflect.mjs";
-import { formatEnvField, removeEnvPrefix } from "./helpers/source-file-env.mjs";
-import { createTemplateReflection } from "./helpers/template-helpers.mjs";
-import "./helpers/index.mjs";
-import "./types/index.mjs";
+import { t as EnvDocs } from "./docs-5r844zC1.mjs";
+import { d as Plugin, n as EnvironmentResolvedConfig, o as DeclareBabelTransformPluginReturn, s as Context, u as UnresolvedContext } from "./resolved-V5COsfDu.mjs";
+import "./components-8W0Zgj0y.mjs";
+import { i as __ΩEnvBuiltinProps, n as EnvBuiltinProps, r as EnvTypeDefinition, t as EnvBuiltin } from "./env-zhzvpUI5.mjs";
+import "./index-Cc7fCJU9.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 { i as __ΩSecretsInterface, n as SecretsInterface, r as __ΩEnvInterface, t as EnvInterface } from "./runtime-qZ0Z2kEd.mjs";
+import "./index-BXxhKmeA.mjs";
+import { ReflectionClass, TypeClass, TypeObjectLiteral } from "@powerlines/deepkit/vendor/type";
+import * as _alloy_js_core4 from "@alloy-js/core";
+import { DotenvParseOutput } from "@stryke/env/types";
+import "@stryke/capnp";
+import { MaybePromise } from "@stryke/types/base";
+import { TypeDefinition } from "@stryke/types/configuration";
+import { UnpluginOptions } from "unplugin";
+import { ArrayValues } from "@stryke/types/array";
 
+//#region src/babel/plugin.d.ts
+declare const envBabelPlugin: DeclareBabelTransformPluginReturn<EnvPluginContext<EnvPluginResolvedConfig>, Record<string, any>>;
+//#endregion
+//#region src/helpers/create-reflection-resource.d.ts
+/**
+ * Creates a reflection resource for the environment configuration.
+ *
+ * @param context - The environment plugin context.
+ * @returns A resource that provides the reflection of the environment configuration.
+ */
+declare function createReflectionResource(context?: EnvPluginContext): _alloy_js_core4.Resource<ReflectionClass<Record<string, any>>>;
+//#endregion
+//#region src/helpers/load.d.ts
+/**
+ * Retrieves various dotenv configuration parameters from the context.
+ *
+ * @param context - The context to retrieve the dotenv configuration from.
+ * @param parsed - The parsed dotenv configuration.
+ * @returns An object containing the dotenv configuration.
+ */
+declare function loadEnvFromContext(context: EnvPluginContext, parsed: DotenvParseOutput): {
+  APP_NAME: string | undefined;
+  APP_VERSION: string | undefined;
+  BUILD_ID: string;
+  BUILD_TIMESTAMP: string;
+  BUILD_CHECKSUM: string;
+  RELEASE_ID: string;
+  RELEASE_TAG: string;
+  DEFAULT_LOCALE: string | undefined;
+  DEFAULT_TIMEZONE: string | undefined;
+  LOG_LEVEL: "error" | "warn" | "info" | "debug" | "trace" | null;
+  ERROR_URL: string | undefined;
+  ORGANIZATION: string | undefined;
+  PLATFORM: "node" | "browser" | "neutral" | undefined;
+  MODE: "test" | "development" | "production" | undefined;
+  DEBUG: boolean;
+  STACKTRACE: boolean;
+  ENVIRONMENT: EnvironmentResolvedConfig;
+};
+declare function loadEnv<TEnv extends DotenvParseOutput = DotenvParseOutput>(context: EnvPluginContext, options: EnvPluginOptions): Promise<TEnv>;
+//#endregion
+//#region src/helpers/persistence.d.ts
+/**
+ * Resolves the runtime type definition file for the environment variables.
+ *
+ * @param context - The plugin context.
+ * @returns The runtime type definition file for the environment variables.
+ */
+declare function resolveRuntimeTypeFile(context: UnresolvedContext<EnvPluginResolvedConfig>): Promise<string>;
+/**
+ * Gets the default type definition for the environment variables.
+ *
+ * @param context - The plugin context.
+ * @returns The default type definition for the environment variables.
+ */
+declare function getEnvDefaultTypeDefinition(context: UnresolvedContext<EnvPluginResolvedConfig>): Promise<TypeDefinition>;
+/** Gets the default type definition for the environment secrets.
+ *
+ * @param context - The plugin context.
+ * @returns The default type definition for the environment secrets.
+ */
+declare function getSecretsDefaultTypeDefinition(context: UnresolvedContext<EnvPluginResolvedConfig>): Promise<TypeDefinition>;
+/**
+ * Gets the path to the environment type reflections.
+ *
+ * @param context - The plugin context.
+ * @param name - The name of the type reflections.
+ * @returns The path to the environment type reflections.
+ */
+declare function getEnvTypeReflectionsPath(context: Context<EnvPluginResolvedConfig>, name?: EnvType): string;
+/**
+ * Reads the environment type reflection from the file system.
+ *
+ * @param context - The plugin context.
+ * @param name - The name of the type reflections.
+ * @returns The environment type reflection.
+ */
+declare function readEnvTypeReflection(context: EnvPluginContext, name?: EnvType): Promise<ReflectionClass<any>>;
+/**
+ * Writes the environment type reflection to the file system.
+ *
+ * @param context - The plugin context.
+ * @param reflection - The environment type reflection to write.
+ * @param name - The name of the type reflections.
+ */
+declare function writeEnvTypeReflection(context: EnvPluginContext, reflection: ReflectionClass<any>, name?: EnvType): Promise<void>;
+declare function getEnvReflectionsPath(context: EnvPluginContext, name: EnvType): string;
+/**
+ * Reads the environment reflection data from the file system.
+ *
+ * @param context - The plugin context.
+ * @returns The environment reflection data.
+ */
+declare function readEnvReflection(context: EnvPluginContext): Promise<ReflectionClass<any>>;
+/**
+ * Reads the secret environment reflection data from the file system.
+ *
+ * @param context - The plugin context.
+ * @returns The environment reflection data.
+ */
+declare function readSecretsReflection(context: EnvPluginContext): Promise<ReflectionClass<any>>;
+/**
+ * Writes the environment reflection data to the file system.
+ *
+ * @param context - The plugin context.
+ * @param reflection - The reflection data to write.
+ * @param name - The name of the reflection (either "env" or "secrets").
+ */
+declare function writeEnvReflection(context: EnvPluginContext, reflection: ReflectionClass<any>, name?: EnvType): Promise<void>;
+/**
+ * Writes the environment reflection data to the file system.
+ *
+ * @param context - The plugin context.
+ * @param reflection - The reflection data to write.
+ * @param name - The name of the reflection (either "env" or "secrets").
+ */
+declare function writeEnvReflectionSync(context: EnvPluginContext, reflection: ReflectionClass<any>, name?: EnvType): void;
+//#endregion
+//#region src/helpers/reflect.d.ts
+declare function mergeEnvReflections(context: EnvPluginContext, reflections: ReflectionClass<any>[]): ReflectionClass<any>;
+declare function mergeSecretsReflections(context: EnvPluginContext, reflections: ReflectionClass<any>[]): ReflectionClass<any>;
+interface CreateEnvReflectionOptions {
+  type?: TypeObjectLiteral | TypeClass;
+  superReflection?: ReflectionClass<any>;
+}
+declare class BaseEnv implements EnvInterface {
+  APP_NAME: string;
+  APP_VERSION: string;
+  BUILD_ID: string;
+  BUILD_TIMESTAMP: string;
+  BUILD_CHECKSUM: string;
+  RELEASE_ID: string;
+  RELEASE_TAG: string;
+  ORGANIZATION: string;
+  PLATFORM: "node" | "browser" | "neutral";
+  MODE: "development" | "test" | "production";
+  ENVIRONMENT: string;
+  DEBUG: boolean;
+  TEST: boolean;
+  MINIMAL: boolean;
+  NO_COLOR: boolean;
+  FORCE_COLOR: number | boolean;
+  FORCE_HYPERLINK: number | boolean;
+  STACKTRACE: boolean;
+  INCLUDE_ERROR_DATA: boolean;
+  ERROR_URL: string;
+  DEFAULT_TIMEZONE: string;
+  DEFAULT_LOCALE: string;
+  CI: boolean;
+}
+declare class BaseSecrets implements SecretsInterface {
+  ENCRYPTION_KEY: string;
+}
+declare function createEnvReflection(context: EnvPluginContext, options?: CreateEnvReflectionOptions): ReflectionClass<any>;
+declare function createSecretsReflection(context: EnvPluginContext, options?: CreateEnvReflectionOptions): ReflectionClass<any>;
+declare function reflectEnv(context: EnvPluginContext, file?: string, name?: string): Promise<ReflectionClass<any>>;
+declare function reflectSecrets(context: EnvPluginContext, file?: string, name?: string): Promise<ReflectionClass<any>>;
+declare type __ΩCreateEnvReflectionOptions = any[];
+//#endregion
+//#region src/helpers/source-file-env.d.ts
+type TReturned<TEnv> = TEnv extends string ? string : DotenvParseOutput;
+declare function removeEnvPrefix<TEnv extends DotenvParseOutput | string>(env: TEnv): TReturned<TEnv>;
+declare function formatEnvField(key: string): string;
+//#endregion
+//#region src/helpers/template-helpers.d.ts
+/**
+ * Creates the reflection data used when generating runtime template files.
+ *
+ * @param context - The context for the configuration plugin.
+ * @param name - The name of the configuration template.
+ * @returns The reflection for the specified configuration template.
+ */
+declare function createTemplateReflection(context: EnvPluginContext, name?: EnvType): Promise<ReflectionClass<any>>;
+//#endregion
 //#region src/index.d.ts
 /**
  * A Powerlines plugin to inject environment variables into the source code.