@powerlines/plugin-react 0.1.104 → 0.1.106

package/dist/plugin-env/src/index.mjs

@@ -1,10 +0,0 @@
-import{type_exports as e}from"../../deepkit/src/vendor/type.mjs";import{createAlloyPlugin as t}from"../../alloy/src/create-plugin.mjs";import n from"../../plugin-babel/src/index.mjs";import r from"../../plugin-automd/src/index.mjs";import{BaseEnv as i,BaseSecrets as a,createEnvReflection as o,createSecretsReflection as s,mergeEnvReflections as c,mergeSecretsReflections as l,reflectEnv as u,reflectSecrets as d}from"./helpers/reflect.mjs";import{getEnvDefaultTypeDefinition as f,getEnvReflectionsPath as p,getEnvTypeReflectionsPath as m,getSecretsDefaultTypeDefinition as h,readEnvReflection as g,readEnvTypeReflection as _,readSecretsReflection as v,resolveRuntimeTypeFile as y,writeEnvReflection as b,writeEnvTypeReflection as x}from"./helpers/persistence.mjs";import{envBabelPlugin as S}from"./babel/plugin.mjs";import{removeEnvPrefix as C}from"./helpers/source-file-env.mjs";import{loadEnv as w,loadEnvFromContext as T}from"./helpers/load.mjs";import{createReflectionResource as E}from"./helpers/create-reflection-resource.mjs";import{EnvBuiltin as D,EnvTypeDefinition as O}from"./components/env.mjs";import{env as k}from"./helpers/automd-generator.mjs";import"./babel/index.mjs";import"./components/index.mjs";import"./helpers/index.mjs";import{createComponent as A}from"@alloy-js/core/jsx-runtime";import{titleCase as j}from"@stryke/string-format/title-case";import M from"defu";import{LogLevelLabel as N}from"@storm-software/config-tools/types";import{isParentPath as P}from"@stryke/path/is-parent-path";import{toArray as F}from"@stryke/convert/to-array";import{parseTypeDefinition as I}from"@stryke/convert/parse-type-definition";import{ENV_PREFIXES as L}from"@stryke/env/types";import{existsSync as R}from"@stryke/fs/exists";import{createDirectory as z}from"@stryke/fs/helpers";import{joinPaths as B}from"@stryke/path/join";import{constantCase as V}from"@stryke/string-format/constant-case";const H=t((t={})=>({name:`env`,async config(){this.log(N.TRACE,"Providing default configuration for the Powerlines `env` build plugin.");let e={env:M(t,{types:{},prefix:[]}),transform:{babel:{plugins:[S]}}};if(e.env.types)e.env.types=I(e.env.types);else{this.log(N.WARN,"The `env.types` configuration parameter was not provided. Please ensure this is expected.");let t=await f(this);e.env.types=I(`${t.file}#${t.name}`)}if(e.env.secrets)e.env.secrets=I(e.env.secrets);else{let t=await h(this);e.env.secrets=I(`${t.file}#${t.name}`)}return e.env.prefix=F(e.env.prefix??[]).reduce((e,t)=>{let n=V(t);return e.includes(n)||e.push(n),e},[...L,`POWERLINES_`]),e.env.prefix=e.env.prefix.reduce((e,t)=>(e.includes(t.replace(/_$/g,``))||e.push(t.replace(/_$/g,``)),e),[]),e},async configResolved(){if(this.log(N.TRACE,`Environment plugin configuration has been resolved for the Powerlines project.`),this.config.env.inject??=this.config.projectType===`application`,this.env=M({parsed:await w(this,this.config.env)},this.env??{},{types:{env:{}},used:{env:{},secrets:{}},parsed:{},injected:{}}),this.config.command!==`prepare`&&this.persistedMeta?.checksum===this.meta.checksum&&R(m(this,`env`)))this.log(N.TRACE,`Skipping reflection initialization as the meta checksum has not changed.`),this.env.types.env=await _(this,`env`),R(p(this,`env`))&&(this.env.used.env=await g(this)),R(m(this,`secrets`))&&(this.env.types.secrets=await _(this,`secrets`)),R(p(this,`secrets`))&&(this.env.used.secrets=await v(this));else{if(this.env.types.env=await u(this,this.config.env.types?.file?P(this.config.env.types?.file,this.workspaceConfig.workspaceRoot)?this.config.env.types?.file:B(this.config.projectRoot,this.config.env.types?.file):void 0,this.config.env.types?.name),!this.env.types.env)throw Error(`Failed to find the environment configuration type reflection in the context.`);if(await x(this,this.env.types.env,`env`),this.env.types.secrets=await d(this,this.config.env.secrets?.file?P(this.config.env.secrets?.file,this.workspaceConfig.workspaceRoot)?this.config.env.secrets?.file:B(this.config.projectRoot,this.config.env.secrets?.file):void 0,this.config.env.secrets?.name),!this.env.types.secrets)throw Error(`Failed to find the secrets configuration type reflection in the context.`);await x(this,this.env.types.secrets,`secrets`),this.log(N.TRACE,`Resolved ${this.env.types.env.getProperties().length??0} environment configuration parameters and ${this.env.types.secrets?.getProperties().length??0} secret configuration parameters`);let t=this.env.types.env.getProperties().filter(e=>e.getAlias().length>0);Object.entries(await w(this,this.config.env)).forEach(([e,n])=>{let r=this.config.env.prefix.reduce((t,n)=>e.replace(/_$/g,``).startsWith(n)?e.replace(/_$/g,``).slice(n.length):t,e),i=t.find(e=>e?.getAlias().reverse().includes(r));(this.env.types.env?.hasProperty(r)||i)&&this.env.types.env.getProperty(r).setDefaultValue(n)}),this.env.used.env=new e.ReflectionClass({kind:e.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 b(this,this.env.used.env,`env`),this.env.types.secrets&&(await x(this,this.env.types.secrets,`secrets`),this.env.used.secrets=new e.ReflectionClass({kind:e.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 b(this,this.env.used.secrets,`secrets`))}},render(){let e=this;return this.log(N.TRACE,`Preparing the Environment runtime artifacts for the Powerlines project.`),A(D,{get defaultConfig(){return e.config.env.defaultConfig}})},async docs(){this.log(N.TRACE,`Writing Environment documentation for the Powerlines project artifacts.`);let t=B(this.config.projectRoot,`docs`,`generated`);R(t)||await z(t);let n=await _(this,`env`),r=B(t,`env.md`);this.log(N.TRACE,`Documenting environment variables configuration in "${r}"`),await this.fs.write(r,`<!-- Generated by ${j(this.config.framework)||`Powerlines`} -->
-
-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. The variables in the list below 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 |
-| ---- | ----------- | ---- | ------------- | :------: |
-${n.getProperties().filter(e=>e.getNameAsString()!==`__POWERLINES_INJECTED__`).sort((e,t)=>e.getNameAsString().localeCompare(t.getNameAsString())).map(t=>`| ${t.getNameAsString().trim()} | ${(t.getDescription()?.replaceAll(`\r`,``)?.replaceAll(`
-`,``)??``).trim()} | ${(0,e.stringifyType)(t.getType()).trim().replaceAll(` | `,`, or `)} | ${t.hasDefault()?String(t.getDefaultValue())?.includes(`"`)?t.getDefaultValue():`\`${t.getDefaultValue()}\``:``} | ${t.isValueRequired()?``:`✔`} |`).join(`
-`)}
-`)},async buildEnd(){let e=p(this,`env`);this.log(N.TRACE,`Writing env reflection types to ${e}.`),await b(this,this.env.used.env,`env`)}}));var U=(e={})=>[n(e.babel),H(e),{name:`env:automd-generator`,config(){return{automd:M(e.automd??{},{generators:{env:k(this)}})}}},{name:`env:vite`,vite:{configResolved(){return{envPrefix:this.config?.env?.prefix}}}},r(e.automd)];export{U as default};

package/dist/plugin-env/src/types/plugin.d.cts

@@ -1,143 +0,0 @@
-import { BabelPluginContext, BabelPluginOptions, BabelPluginResolvedConfig, BabelPluginUserConfig } from "../../../plugin-babel/src/types/plugin.cjs";
-import { Reflection } from "../../../deepkit/src/types.cjs";
-import { AutoMDPluginOptions } from "../../../plugin-automd/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 ../plugin-env/src/types/plugin.d.ts
-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;
-};
-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;
-  };
-}
-//#endregion
-export { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig };

package/dist/plugin-env/src/types/plugin.d.mts

@@ -1,144 +0,0 @@
-import { BabelPluginContext, BabelPluginOptions, BabelPluginResolvedConfig, BabelPluginUserConfig } from "../../../plugin-babel/src/types/plugin.mjs";
-import { Reflection } from "../../../deepkit/src/types.mjs";
-import { AutoMDPluginOptions } from "../../../plugin-automd/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 ../plugin-env/src/types/plugin.d.ts
-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;
-};
-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;
-  };
-}
-//#endregion
-export { EnvPluginContext, EnvPluginOptions, EnvPluginResolvedConfig, EnvPluginUserConfig };