@powerlines/plugin-env 0.13.53 → 0.13.54

package/dist/index.d.ts

@@ -1,71 +0,0 @@
-import { P as PluginContext, b as Plugin } from './runtime-B75FziIk.js';
-export { E as EnvInterface, S as SecretsInterface, _ as __ΩEnvInterface, c as __ΩSecretsInterface } from './runtime-B75FziIk.js';
-import { Children } from '@alloy-js/core/jsx-runtime';
-import { PrintTreeOptions } from '@alloy-js/core';
-import { EnvPluginContext, EnvPluginResolvedConfig } from './types/plugin.js';
-export { EnvPluginOptions, EnvPluginUserConfig, EnvType, __ΩEnvPluginContext, __ΩEnvPluginOptions, __ΩEnvPluginResolvedConfig, __ΩEnvPluginUserConfig, __ΩEnvType } from './types/plugin.js';
-export { envBabelPlugin } from './babel/plugin.js';
-export { EnvBuiltin, EnvBuiltinProps, EnvTypeDefinition, __ΩEnvBuiltinProps } from './components/env.js';
-export { loadEnv, loadEnvFromContext } from './helpers/load.js';
-export { getEnvDefaultTypeDefinition, getEnvReflectionsPath, getEnvTypeReflectionsPath, getSecretsDefaultTypeDefinition, readEnvReflection, readEnvTypeReflection, readSecretsReflection, resolveRuntimeTypeFile, writeEnvReflection, writeEnvReflectionSync, writeEnvTypeReflection } from './helpers/persistence.js';
-export { BaseEnv, BaseSecrets, CreateEnvReflectionOptions, __ΩCreateEnvReflectionOptions, createEnvReflection, createSecretsReflection, mergeEnvReflections, mergeSecretsReflections, reflectEnv, reflectSecrets } from './helpers/reflect.js';
-export { formatEnvField, removeEnvPrefix } from './helpers/source-file-env.js';
-export { createTemplateReflection } from './helpers/template-helpers.js';
-import '@stryke/env/get-env-paths';
-import '@stryke/http/fetch';
-import '@stryke/types/base';
-import '@stryke/types/package-json';
-import 'jiti';
-import 'magic-string';
-import 'oxc-parser';
-import 'semver';
-import 'ts-morph';
-import 'undici';
-import 'unplugin';
-import '@babel/core';
-import '@storm-software/build-tools/types';
-import '@storm-software/config-tools/types';
-import '@storm-software/config/types';
-import '@stryke/types/configuration';
-import '@stryke/types/file';
-import 'vite';
-import '@babel/helper-plugin-utils';
-import './fs-ECFlqnPg.js';
-import '@stryke/fs/resolve';
-import '@stryke/types/array';
-import '@stryke/types/tsconfig';
-import 'typescript';
-import '@deepkit/type';
-import '@stryke/capnp';
-import '@stryke/env/types';
-import '@alloy-js/typescript';
-
-type PluginPluginAlloyOptions = Partial<PrintTreeOptions> & {
-    /**
-     * If true, the Alloy framework is used to generate JSON output files.
-     *
-     * @defaultValue false
-     */
-    generatesJson?: boolean;
-    /**
-     * If true, the Alloy framework is used to generate Markdown output files.
-     *
-     * @defaultValue false
-     */
-    generatesMarkdown?: boolean;
-};
-
-interface AlloyPluginOptions {
-    alloy?: PluginPluginAlloyOptions;
-}
-type AlloyPluginBuilderResult<TContext extends PluginContext = PluginContext> = Plugin<TContext> & {
-    render: (this: TContext) => Children;
-};
-type AlloyPluginBuilder<TContext extends PluginContext = PluginContext, TOptions = any> = <T extends TContext>(options: TOptions) => AlloyPluginBuilderResult<T>;
-
-/**
- * A Powerlines plugin to inject environment variables into the source code.
- */
-declare const plugin: <T extends EnvPluginContext<EnvPluginResolvedConfig>>(options: Parameters<AlloyPluginBuilder<EnvPluginContext<EnvPluginResolvedConfig>>>[0] & AlloyPluginOptions) => Plugin<T>;
-
-export { EnvPluginContext, EnvPluginResolvedConfig, plugin as default, plugin };

package/dist/index.js

@@ -1,22 +0,0 @@
-import'./chunk-UCUR73HG.js';import {createComponent}from'@alloy-js/core/jsx-runtime';import {createAlloyPlugin}from'@powerlines/alloy/create-plugin';import {stringifyType,ReflectionClass,ReflectionKind}from'@powerlines/deepkit/vendor/type';import A from'@powerlines/plugin-babel';import {LogLevelLabel}from'@storm-software/config-tools/types';import {parseTypeDefinition}from'@stryke/convert/parse-type-definition';import {toArray}from'@stryke/convert/to-array';import {ENV_PREFIXES}from'@stryke/env/types';import {existsSync}from'@stryke/fs/exists';import {createDirectory}from'@stryke/fs/helpers';import {isParentPath}from'@stryke/path/is-parent-path';import {joinPaths}from'@stryke/path/join';import {constantCase}from'@stryke/string-format/constant-case';import w from'defu';import {envBabelPlugin}from'./babel/plugin';import {EnvBuiltin}from'./components/env';import {loadEnv}from'./helpers/load';import {getEnvReflectionsPath,writeEnvReflection,readEnvTypeReflection,getEnvTypeReflectionsPath,readEnvReflection,readSecretsReflection,writeEnvTypeReflection,getEnvDefaultTypeDefinition,getSecretsDefaultTypeDefinition}from'./helpers/persistence';import {reflectEnv,reflectSecrets}from'./helpers/reflect';export*from'./babel';export*from'./components';export*from'./helpers';export*from'./types';/*****************************************
-*
-*      ⚡ Built by Storm Software
-*
-*****************************************/
-
-const F=createAlloyPlugin((g={})=>({name:"env",dependsOn:[A(g.babel)],async config(){this.log(LogLevelLabel.TRACE,"Providing default configuration for the Powerlines `env` build plugin.");const e={env:w(g,{types:{},prefix:[]}),transform:{babel:{plugins:[envBabelPlugin]}}};if(e.env.types)e.env.types=parseTypeDefinition(e.env.types);else {this.log(LogLevelLabel.WARN,"The `env.types` configuration parameter was not provided. Please ensure this is expected.");const t=await getEnvDefaultTypeDefinition(this);e.env.types=parseTypeDefinition(`${t.file}#${t.name}`);}if(e.env.secrets)e.env.secrets=parseTypeDefinition(e.env.secrets);else {const t=await getSecretsDefaultTypeDefinition(this);e.env.secrets=parseTypeDefinition(`${t.file}#${t.name}`);}return e.env.prefix=toArray(e.env.prefix??[]).reduce((t,n)=>{const i=constantCase(n);return t.includes(i)||t.push(i),t},[...ENV_PREFIXES,"POWERLINES_"]),e.env.prefix=e.env.prefix.reduce((t,n)=>(t.includes(n.replace(/_$/g,""))||t.push(n.replace(/_$/g,"")),t),[]),e},async configResolved(){if(this.log(LogLevelLabel.TRACE,"Environment plugin configuration has been resolved for the Powerlines project."),this.config.env.inject??=this.config.projectType==="application",this.env=w({parsed:await loadEnv(this,this.config.env)},this.env??{},{types:{env:{}},used:{env:{},secrets:{}},parsed:{},injected:{}}),this.config.command!=="prepare"&&this.persistedMeta?.checksum===this.meta.checksum&&existsSync(getEnvTypeReflectionsPath(this,"env")))this.log(LogLevelLabel.TRACE,"Skipping reflection initialization as the meta checksum has not changed."),this.env.types.env=await readEnvTypeReflection(this,"env"),existsSync(getEnvReflectionsPath(this,"env"))&&(this.env.used.env=await readEnvReflection(this)),existsSync(getEnvTypeReflectionsPath(this,"secrets"))&&(this.env.types.secrets=await readEnvTypeReflection(this,"secrets")),existsSync(getEnvReflectionsPath(this,"secrets"))&&(this.env.used.secrets=await readSecretsReflection(this));else {if(this.env.types.env=await reflectEnv(this,this.config.env.types?.file?isParentPath(this.config.env.types?.file,this.workspaceConfig.workspaceRoot)?this.config.env.types?.file:joinPaths(this.config.projectRoot,this.config.env.types?.file):void 0,this.config.env.types?.name),!this.env.types.env)throw new Error("Failed to find the environment configuration type reflection in the context.");if(await writeEnvTypeReflection(this,this.env.types.env,"env"),this.env.types.secrets=await reflectSecrets(this,this.config.env.secrets?.file?isParentPath(this.config.env.secrets?.file,this.workspaceConfig.workspaceRoot)?this.config.env.secrets?.file:joinPaths(this.config.projectRoot,this.config.env.secrets?.file):void 0,this.config.env.secrets?.name),!this.env.types.secrets)throw new Error("Failed to find the secrets configuration type reflection in the context.");await writeEnvTypeReflection(this,this.env.types.secrets,"secrets"),this.log(LogLevelLabel.TRACE,`Resolved ${this.env.types.env.getProperties().length??0} environment configuration parameters and ${this.env.types.secrets?.getProperties().length??0} secret configuration parameters`);const e=this.env.types.env.getProperties().filter(t=>t.getAlias().length>0);Object.entries(await loadEnv(this,this.config.env)).forEach(([t,n])=>{const i=this.config.env.prefix.reduce((f,m)=>t.replace(/_$/g,"").startsWith(m)?t.replace(/_$/g,"").slice(m.length):f,t),c=e.find(f=>f?.getAlias().reverse().includes(i));(this.env.types.env?.hasProperty(i)||c)&&this.env.types.env.getProperty(i).setDefaultValue(n);}),this.env.used.env=new ReflectionClass({kind:ReflectionKind.objectLiteral,typeName:"Env",description:`An object containing the environment configuration parameters used by the ${this.config.name?`${this.config.name} application`:"application"}.`,types:[]},this.env.types.env),await writeEnvReflection(this,this.env.used.env,"env"),this.env.types.secrets&&(await writeEnvTypeReflection(this,this.env.types.secrets,"secrets"),this.env.used.secrets=new ReflectionClass({kind:ReflectionKind.objectLiteral,typeName:"Secrets",description:`An object containing the secret configuration parameters used by the ${this.config.name?`${this.config.name} application`:"application"}.`,types:[]},this.env.types.secrets),await writeEnvReflection(this,this.env.used.secrets,"secrets"));}},render(){const e=this;return this.log(LogLevelLabel.TRACE,"Preparing the Environment runtime artifacts for the Powerlines project."),createComponent(EnvBuiltin,{get defaultConfig(){return e.config.env.defaultConfig}})},async docs(){this.log(LogLevelLabel.TRACE,"Writing Environment documentation for the Powerlines project artifacts.");const e=joinPaths(this.config.projectRoot,"docs","generated");existsSync(e)||await createDirectory(e);const t=await readEnvTypeReflection(this,"env"),n=joinPaths(e,"env.md");this.log(LogLevelLabel.TRACE,`Documenting environment variables configuration in "${n}"`),await this.fs.write(n,`<!-- Generated by Powerlines -->
-
-      # Environment variables configuration
-
-      Below is a list of environment variables used by the [${this.packageJson.name}](https://www.npmjs.com/package/${this.packageJson.name}) package. These values can be updated in the \`.env\` file in the root of the project.
-
-      ## Environment Configuration
-
-      The below list of environment variables are used as configuration parameters to drive the processing of the application. The data contained in these variables are **not** considered sensitive or confidential. Any values provided in these variables will be available in plain text to the public.
-
-      | Name | Description | Type | Default Value | Required |
-      | ---- | ----------- | ---- | ------------- | :------: |
-      ${t.getProperties().filter(i=>i.getNameAsString()!=="__STORM_INJECTED__").sort((i,c)=>i.getNameAsString().localeCompare(c.getNameAsString())).map(i=>`| ${i.getNameAsString().trim()} | ${(i.getDescription()?.replaceAll("\r","")?.replaceAll(`
-`,"")??"").trim()} | ${stringifyType(i.getType()).trim().replaceAll(" | ",", or ")} | ${i.hasDefault()?String(i.getDefaultValue())?.includes('"')?i.getDefaultValue():`\`${i.getDefaultValue()}\``:""} | ${i.isValueRequired()?"":"\u2714"} |`).join(`
-`)}
-      `);},async buildEnd(){const e=getEnvReflectionsPath(this,"env");this.log(LogLevelLabel.TRACE,`Writing env reflection types to ${e}.`),await writeEnvReflection(this,this.env.used.env,"env");}}));var re=F;export{re as default,F as plugin};