@powerlines/plugin-env 0.16.121 → 0.16.123

package/dist/babel/plugin.cjs

@@ -20,17 +20,7 @@ const envBabelPlugin = (_powerlines_plugin_babel_helpers_create_plugin.createBab
 			"P\"2!\"/\""
 		]));
 		if (node.name) {
-			const prefix = context.config.env.prefix.find(__assignType((pre) => node.name && node.name.startsWith(pre) && (context.env.types.env?.hasProperty(node.name.replace(`${pre}_`, "")) || envTypesAliasProperties.some(__assignType((prop) => prop.getAlias().includes(node.name.replace(`${pre}_`, "")), [
-				"prop",
-				"",
-				"P\"2!\"/\""
-			]))), [
-				"pre",
-				"",
-				"P\"2!\"/\""
-			]));
-			let name = node.name;
-			if (prefix) name = node.name.replace(`${prefix}_`, "");
+			const name = node.name.replace(new RegExp(`^(${context.config.env.prefix.join("|")})_`), "");
 			log(_storm_software_config_tools_types.LogLevelLabel.TRACE, `Environment variable ${name} found in ${pass.filename || "unknown file"}.`);
 			if (context.env.types.env?.hasProperty(name) || envTypesAliasProperties.some(__assignType((prop) => prop.getAlias().includes(name), [
 				"prop",

package/dist/babel/plugin.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/babel/plugin.ts"],"mappings":";;;;cAiCa,cAAA,EAAc,2BAAA,CAAA,iCAAA,CAAA,gBAAA,CA4M1B,uBAAA,GA5M0B,MAAA"}
+{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/babel/plugin.ts"],"mappings":";;;;cAiCa,cAAA,EAAc,2BAAA,CAAA,iCAAA,CAAA,gBAAA,CAgM1B,uBAAA,GAhM0B,MAAA"}

package/dist/babel/plugin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/babel/plugin.ts"],"mappings":";;;;cAiCa,cAAA,EAAc,2BAAA,CAAA,iCAAA,CAAA,gBAAA,CA4M1B,uBAAA,GA5M0B,MAAA"}
+{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/babel/plugin.ts"],"mappings":";;;;cAiCa,cAAA,EAAc,2BAAA,CAAA,iCAAA,CAAA,gBAAA,CAgM1B,uBAAA,GAhM0B,MAAA"}

package/dist/babel/plugin.mjs

@@ -18,17 +18,7 @@ const envBabelPlugin = (createBabelPlugin.Ω = [[() => __ΩEnvPluginContext, "n!
 			"P\"2!\"/\""
 		]));
 		if (node.name) {
-			const prefix = context.config.env.prefix.find(__assignType((pre) => node.name && node.name.startsWith(pre) && (context.env.types.env?.hasProperty(node.name.replace(`${pre}_`, "")) || envTypesAliasProperties.some(__assignType((prop) => prop.getAlias().includes(node.name.replace(`${pre}_`, "")), [
-				"prop",
-				"",
-				"P\"2!\"/\""
-			]))), [
-				"pre",
-				"",
-				"P\"2!\"/\""
-			]));
-			let name = node.name;
-			if (prefix) name = node.name.replace(`${prefix}_`, "");
+			const name = node.name.replace(new RegExp(`^(${context.config.env.prefix.join("|")})_`), "");
 			log(LogLevelLabel.TRACE, `Environment variable ${name} found in ${pass.filename || "unknown file"}.`);
 			if (context.env.types.env?.hasProperty(name) || envTypesAliasProperties.some(__assignType((prop) => prop.getAlias().includes(name), [
 				"prop",

package/dist/babel/plugin.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.mjs","names":[],"sources":["../../src/babel/plugin.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { NodePath } from \"@babel/core\";\nimport * as t from \"@babel/types\";\nimport { stringifyDefaultValue } from \"@powerlines/deepkit/utilities\";\nimport { createBabelPlugin } from \"@powerlines/plugin-babel/helpers/create-plugin\";\nimport { addImport } from \"@powerlines/plugin-babel/helpers/module-helpers\";\nimport { BabelPluginPass } from \"@powerlines/plugin-babel/types/config\";\nimport { LogLevelLabel } from \"@storm-software/config-tools/types\";\nimport { EnvPluginContext } from \"../types/plugin\";\n\n/*\n * The Powerlines - Environment Configuration Babel Plugin\n *\n * @param babel - The Babel core module\n * @returns The Babel plugin object\n */\nexport const envBabelPlugin = createBabelPlugin<EnvPluginContext>(\n  \"env\",\n  ({ log, context }) => {\n    function extractEnv(\n      node: t.Identifier,\n      pass: BabelPluginPass,\n      isInjectable = false,\n      isUsingBuiltin = false\n    ) {\n      const envTypesAliasProperties = context.env.types.env\n        ?.getProperties()\n        .filter(prop => prop.getAlias().length > 0);\n\n      if (node.name) {\n        const prefix = context.config.env.prefix.find(\n          pre =>\n            node.name &&\n            node.name.startsWith(pre) &&\n            (context.env.types.env?.hasProperty(\n              node.name.replace(`${pre}_`, \"\")\n            ) ||\n              envTypesAliasProperties.some(prop =>\n                prop.getAlias().includes(node.name.replace(`${pre}_`, \"\"))\n              ))\n        );\n\n        let name = node.name;\n        if (prefix) {\n          name = node.name.replace(`${prefix}_`, \"\");\n        }\n\n        log(\n          LogLevelLabel.TRACE,\n          `Environment variable ${name} found in ${\n            pass.filename || \"unknown file\"\n          }.`\n        );\n\n        if (\n          context.env.types.env?.hasProperty(name) ||\n          envTypesAliasProperties.some(prop => prop.getAlias().includes(name))\n        ) {\n          const envProperty = context.env.types.env.hasProperty(name)\n            ? context.env.types.env.getProperty(name)\n            : envTypesAliasProperties.find(prop =>\n                prop.getAlias().includes(name)\n              );\n          if (!envProperty || envProperty.isIgnored()) {\n            return;\n          }\n\n          if (!context.env.used.env.hasProperty(name)) {\n            log(\n              LogLevelLabel.DEBUG,\n              `Adding \"${name}\" environment variables found in \"${\n                pass.filename || \"unknown file\"\n              }\" to used environment configuration reflection object.`\n            );\n\n            context.env.used.env.addProperty(envProperty.property);\n          }\n\n          if (context.config.env.inject && isInjectable) {\n            let value = context.env.parsed?.[name];\n            if (value === undefined) {\n              const prefix = context.config.env.prefix.find(pre => {\n                return context.env.parsed[`${pre.replace(/_$/g, \"\")}_${name}`];\n              });\n              if (prefix) {\n                value =\n                  context.env.parsed[`${prefix.replace(/_$/g, \"\")}_${name}`];\n              }\n            }\n\n            value ??= envProperty.getDefaultValue();\n\n            if (envProperty.isValueRequired() && value === undefined) {\n              throw new Error(\n                `Environment variable \\`${name}\\` is not defined in the .env configuration files`\n              );\n            }\n\n            return stringifyDefaultValue(envProperty, value);\n          }\n        } else if (context.config.env.validate) {\n          throw new Error(\n            `The \"${name}\" environment variable is not defined in the \\`env\\` type definition, but is used in the source code file ${\n              pass.filename ? pass.filename : \"unknown\"\n            }.\n\n          The following environment configuration names are defined in the \\`env\\` type definition: \\n${context.env.types.env\n            ?.getPropertyNames()\n            .sort((a, b) => String(a).localeCompare(String(b)))\n            .map(\n              typeDef =>\n                ` - ${String(typeDef)} ${\n                  envTypesAliasProperties.some(\n                    prop =>\n                      prop.getNameAsString() === String(typeDef) &&\n                      prop.getAlias().length > 0\n                  )\n                    ? `(Alias: ${envTypesAliasProperties\n                        ?.find(\n                          prop => prop.getNameAsString() === String(typeDef)\n                        )\n                        ?.getAlias()\n                        .join(\", \")})`\n                    : \"\"\n                }`\n            )\n            .join(\n              \"\\n\"\n            )} \\n\\nUsing the following env prefix: \\n${context.config.env.prefix\n            .map(prefix => ` - ${prefix}`)\n            .join(\n              \"\\n\"\n            )} \\n\\nPlease check your \\`env\\` configuration option. If you are using a custom dotenv type definition, please make sure that the configuration names match the ones in the code. \\n\\n`\n          );\n        } else if (pass.filename && isUsingBuiltin) {\n          context.warn(\n            `The \"${\n              name\n            }\" environment variable is used in the source code file ${\n              pass.filename\n            }, but is not defined in the \\`env\\` type definition. If this is intentional, you can ignore this warning. Otherwise, please check your \\`env\\` configuration option. If you are using a custom dotenv type definition, please make sure that the configuration names match the ones in the code.`\n          );\n        }\n      }\n\n      return undefined;\n    }\n\n    return {\n      visitor: {\n        MemberExpression(\n          path: NodePath<t.MemberExpression>,\n          pass: BabelPluginPass\n        ) {\n          if (\n            path\n              .get(\"object\")\n              ?.get(\"property\")\n              ?.isIdentifier({ name: \"env\" }) &&\n            path\n              .get(\"object\")\n              ?.get(\"object\")\n              ?.isIdentifier({ name: \"process\" }) &&\n            path.get(\"property\")?.isIdentifier()\n          ) {\n            // process.env.CONFIG_NAME\n\n            const identifier = path.get(\"property\")?.node as t.Identifier;\n            if (!identifier.name) {\n              return;\n            }\n\n            extractEnv(identifier, pass, false, false);\n\n            path.replaceWithSourceString(`env.${identifier.name}`);\n            addImport(path, {\n              module: `${context.config.framework || \"powerlines\"}:env`,\n              name: \"env\",\n              imported: \"env\"\n            });\n          } else if (\n            path\n              .get(\"object\")\n              ?.get(\"property\")\n              ?.isIdentifier({ name: \"env\" }) &&\n            path.get(\"object\")?.get(\"object\")?.isMetaProperty() &&\n            path.get(\"property\")?.isIdentifier()\n          ) {\n            // import.meta.env.CONFIG_NAME\n\n            const identifier = path.get(\"property\")?.node as t.Identifier;\n            if (!identifier.name) {\n              return;\n            }\n\n            extractEnv(identifier, pass, false, false);\n\n            path.replaceWithSourceString(`env.${identifier.name}`);\n            addImport(path, {\n              module: `${context.config.framework || \"powerlines\"}:env`,\n              name: \"env\",\n              imported: \"env\"\n            });\n          } else if (\n            path.get(\"object\")?.isIdentifier({ name: \"env\" }) &&\n            path.get(\"property\")?.isIdentifier()\n          ) {\n            // env.CONFIG_NAME\n\n            const identifier = path.get(\"property\")?.node as t.Identifier;\n            if (!identifier.name) {\n              return;\n            }\n\n            extractEnv(identifier, pass, false, true);\n          }\n        }\n      }\n    };\n  }\n);\n"],"mappings":";;;;;;;;AAEA,SAAS,aAAY,IAAK,MAAC;;AAE1B,QAAU;;AA8BX,MAAO,kBAAA,kBAAA,IAAA,CAAA,OAAA,qBAAA,KAAA,CAAA,EAAA,kBAAA,OAAA,cAAA,EAAA,KAAA,cAAA;CACH,SAAM,WAAc,MAAA,MAAA,eAAA,OAAA,iBAAA,OAAA;EACpB,MAAS,0BAAU,QAAA,IAAA,MAAA,KACT,eAAU,CACZ,OAAA,cAAe,SAAA,KAAA,UAAA,CAAA,SAAA,GAAA;GAAA;GAAA;GAAA;GAAA,CAAA,CAAA;AACrB,MAAA,KAAA,MAAe;GACf,MAAA,SAAiB,QAAA,OAAA,IAAA,OAAA,KAAA,cAAA,QAAA,KAAA,QACjB,KAAA,KAAA,WAAA,IAAA,KACM,QAAA,IAAA,MAAuB,KAAG,YAAY,KAAM,KAAA,QAAA,GAAA,IAAA,IAAA,GAAA,CAAA,IAC9C,wBAAc,KAAA,cAAA,SAAA,KAAA,UAAA,CAAA,SAAA,KAAA,KAAA,QAAA,GAAA,IAAA,IAAA,GAAA,CAAA,EAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA,GAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA;GACf,IAAO,OAAO,KAAK;cAEb,QAAM,KAAA,KAAA,QAAA,GAAA,OAAA,IAAA,GAAA;AAEX,OAAK,cAAA,OAAA,wBAAA,KAAA,YAAA,KAAA,YAAA,eAAA,GAAA;AACH,OAAI,QAAO,IAAA,MAAA,KAAA,YAAA,KAAA,IACP,wBAAuB,KAAA,cAAA,SAAA,KAAA,UAAA,CAAA,SAAA,KAAA,EAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA,EAAA;IAC1B,MAAQ,cAAe,QAAA,IAAW,MAAA,IAAA,YAAA,KAAA,GAC5B,QAAK,IAAU,MAAM,IAAI,YAAC,KAAA,GAC9B,wBAAA,KAAA,cAAA,SAAA,KAAA,UAAA,CAAA,SAAA,KAAA,EAAA;KAAA;KAAA;KAAA;KAAA,CAAA,CAAA;AACD,QAAA,CAAA,eAAA,YAAkC,WAAC,CAC7B;AAEX,QAAA,CAAA,QAAA,IAAA,KAAA,IAAA,YAAA,KAAA,EAAA;;AAEU,aAAS,IAAA,KAAA,IAAA,YAAA,YAAA,SAAA;;AAEZ,QAAC,QAAU,OAAQ,IAAG,UAAW,cAAG;KAC5C,IAAA,QAAA,QAAA,IAAA,SAAA;;MAEG,MAAA,SAAA,QAAA,OAAA,IAAA,OAAA,KAAA,cAAA,QAAA;AACa,cAAK,QAAA,IAAA,OAAA,GAAA,IAAA,QAAA,OAAA,GAAA,CAAA,GAAA;SACN;OAAA;OAAW;OAAK;OAAU,CAAC,CAAA;AACjC,UAAW,OAChB,SACH,QAAA,IAAA,OAAA,GAAA,OAAA,QAAA,OAAA,GAAA,CAAA,GAAA;;AAGS,eAAU,YAAK,iBAAmB;AAC1C,SAAA,YAAwB,iBAAkB,IAAA,UAAW,OACrD,OAAA,IAAA,MAAA,0BAAA,KAAA,mDAAA;AAEI,YAAY,sBAAsB,aAAI,MAAA;;cAGrC,QAAA,OAAA,IAAA,SACA,OAAA,IAAW,MAAI,QAAA,KAAY,4GAAa,KAAA,WAAA,KAAA,WAAA,UAAA;;wGAE7C,QAAA,IAAA,MAAA,wBAEK,KAAW,cAAU,GAAA,MAAY,OAAO,EAAA,CAAA,cAAA,OAAA,EAAA,CAAA,EAAA;IAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA,CACxC,IAAA,cAAA,YAAA,MAAA,OAAA,QAAA,CAAA,GAAA,wBAAA,KAAA,cAAA,SAAA,KAAA,iBAAA,KAAA,OAAA,QAAA,IACD,KAAA,UAAmB,CAAA,SAAA,GAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA,GACX,WAAU,yBACX,KAAU,cAAW,SAAI,KAAA,iBAAA,KAAA,OAAA,QAAA,EAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA,EACrB,UAAW,CACvB,KAAA,KAAA,CAAA;;;;OAEO,KAAI,KAAK,CAAG,yCAAkC,QAAA,OAAA,IAAA,OACxD,IAAA,cAAA,WAAA,MAAA,UAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA;YAGW,KAAG,YAAY,eACpB,SAAQ,KAAE,QAAW,KAAA,yDAAA,KAAA,SAAA,kSAAA;;;AAKjC,YAAW,SAAO;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;AAClB,QAAO,EACH,SAAM,EACF,kBAAA,aAAA,SAAA,iBAAA,MAAA,MAAA;WAES,IAAC,SAAY,mBAElB,aAAY,EAAA,MAAe,OAAM,CAAA,IAC7B,KACH,IAAY,SAAS,EACvB,IAAA,SAAA,EACH,aAAA,EAAA,MAAA,WAAA,CAAA;GAGF,MAAA,aAAA,KAAA,IAAA,WAAA,EAAA;AACS,OAAA,CAAA,WAAe,KACd;AAED,cAAW,YAAa,MAAI,OAAO,MAAA;AACzC,QAAA,wBAAA,OAAA,WAAA,OAAA;;IAEW,QAAA,GAAW,QAAC,OAAc,aAAU,aAAgB;IAC9D,MAAgB;IACN,UAAU;IAClB,CAAA;aAEM,KACJ,IAAA,SAAA,EACE,IAAM,WAAA,EACJ,aAAK,EAAA,MAAgB,OAAM,CAAA,IAC7B,KAAE,IAAK,SAAW,EAAA,IAAM,SAAG,EAAA,gBAAA,IAC7B,KAAA,IAAA,WAAA,EAAA,cAAA,EAAA;GAEE,MAAM,aAAI,KAAA,IAAA,WAAA,EAAA;AACV,OAAI,CAAC,WAAS,KACV;AAEJ,cAAW,YAAM,MAAA,OAAA,MAAA;AACjB,QAAG,wBAAA,OAAA,WAAA,OAAA;AACN,aAAA,MAAA;IACL,QAAA,GAAA,QAAA,OAAA,aAAA,aAAA;IACK,MAAA;IACA,UAAA;IACC,CAAA;aAED,KAAA,IAAA,SAAA,EAAA,aAAA,EAAA,MAAA,OAAA,CAAA,IACA,KAAA,IAAA,WAAA,EAAA,cAAA,EAAA;GAEN,MAAA,aAAA,KAAA,IAAA,WAAA,EAAA;AACQ,OAAK,CAAA,WAAY,KACd;AAER,cAAA,YAAA,MAAA,OAAA,KAAA;;IAEA;QAAK;EAAA;EAAA;EAAA;EAAA;EAAA,CAAA,EACV,EACJ;GACF;CAAC;CAAI;CAAA;CAAA,CAAA,CAAA"}
+{"version":3,"file":"plugin.mjs","names":[],"sources":["../../src/babel/plugin.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { NodePath } from \"@babel/core\";\nimport * as t from \"@babel/types\";\nimport { stringifyDefaultValue } from \"@powerlines/deepkit/utilities\";\nimport { createBabelPlugin } from \"@powerlines/plugin-babel/helpers/create-plugin\";\nimport { addImport } from \"@powerlines/plugin-babel/helpers/module-helpers\";\nimport { BabelPluginPass } from \"@powerlines/plugin-babel/types/config\";\nimport { LogLevelLabel } from \"@storm-software/config-tools/types\";\nimport { EnvPluginContext } from \"../types/plugin\";\n\n/*\n * The Powerlines - Environment Configuration Babel Plugin\n *\n * @param babel - The Babel core module\n * @returns The Babel plugin object\n */\nexport const envBabelPlugin = createBabelPlugin<EnvPluginContext>(\n  \"env\",\n  ({ log, context }) => {\n    function extractEnv(\n      node: t.Identifier,\n      pass: BabelPluginPass,\n      isInjectable = false,\n      isUsingBuiltin = false\n    ) {\n      const envTypesAliasProperties = context.env.types.env\n        ?.getProperties()\n        .filter(prop => prop.getAlias().length > 0);\n\n      if (node.name) {\n        const name = node.name.replace(\n          new RegExp(`^(${context.config.env.prefix.join(\"|\")})_`),\n          \"\"\n        );\n\n        log(\n          LogLevelLabel.TRACE,\n          `Environment variable ${name} found in ${\n            pass.filename || \"unknown file\"\n          }.`\n        );\n\n        if (\n          context.env.types.env?.hasProperty(name) ||\n          envTypesAliasProperties.some(prop => prop.getAlias().includes(name))\n        ) {\n          const envProperty = context.env.types.env.hasProperty(name)\n            ? context.env.types.env.getProperty(name)\n            : envTypesAliasProperties.find(prop =>\n                prop.getAlias().includes(name)\n              );\n          if (!envProperty || envProperty.isIgnored()) {\n            return;\n          }\n\n          if (!context.env.used.env.hasProperty(name)) {\n            log(\n              LogLevelLabel.DEBUG,\n              `Adding \"${name}\" environment variables found in \"${\n                pass.filename || \"unknown file\"\n              }\" to used environment configuration reflection object.`\n            );\n\n            context.env.used.env.addProperty(envProperty.property);\n          }\n\n          if (context.config.env.inject && isInjectable) {\n            let value = context.env.parsed?.[name];\n            if (value === undefined) {\n              const prefix = context.config.env.prefix.find(pre => {\n                return context.env.parsed[`${pre.replace(/_$/g, \"\")}_${name}`];\n              });\n              if (prefix) {\n                value =\n                  context.env.parsed[`${prefix.replace(/_$/g, \"\")}_${name}`];\n              }\n            }\n\n            value ??= envProperty.getDefaultValue();\n\n            if (envProperty.isValueRequired() && value === undefined) {\n              throw new Error(\n                `Environment variable \\`${name}\\` is not defined in the .env configuration files`\n              );\n            }\n\n            return stringifyDefaultValue(envProperty, value);\n          }\n        } else if (context.config.env.validate) {\n          throw new Error(\n            `The \"${name}\" environment variable is not defined in the \\`env\\` type definition, but is used in the source code file ${\n              pass.filename ? pass.filename : \"unknown\"\n            }.\n\n          The following environment configuration names are defined in the \\`env\\` type definition: \\n${context.env.types.env\n            ?.getPropertyNames()\n            .sort((a, b) => String(a).localeCompare(String(b)))\n            .map(\n              typeDef =>\n                ` - ${String(typeDef)} ${\n                  envTypesAliasProperties.some(\n                    prop =>\n                      prop.getNameAsString() === String(typeDef) &&\n                      prop.getAlias().length > 0\n                  )\n                    ? `(Alias: ${envTypesAliasProperties\n                        ?.find(\n                          prop => prop.getNameAsString() === String(typeDef)\n                        )\n                        ?.getAlias()\n                        .join(\", \")})`\n                    : \"\"\n                }`\n            )\n            .join(\n              \"\\n\"\n            )} \\n\\nUsing the following env prefix: \\n${context.config.env.prefix\n            .map(prefix => ` - ${prefix}`)\n            .join(\n              \"\\n\"\n            )} \\n\\nPlease check your \\`env\\` configuration option. If you are using a custom dotenv type definition, please make sure that the configuration names match the ones in the code. \\n\\n`\n          );\n        } else if (pass.filename && isUsingBuiltin) {\n          context.warn(\n            `The \"${\n              name\n            }\" environment variable is used in the source code file ${\n              pass.filename\n            }, but is not defined in the \\`env\\` type definition. If this is intentional, you can ignore this warning. Otherwise, please check your \\`env\\` configuration option. If you are using a custom dotenv type definition, please make sure that the configuration names match the ones in the code.`\n          );\n        }\n      }\n\n      return undefined;\n    }\n\n    return {\n      visitor: {\n        MemberExpression(\n          path: NodePath<t.MemberExpression>,\n          pass: BabelPluginPass\n        ) {\n          if (\n            path\n              .get(\"object\")\n              ?.get(\"property\")\n              ?.isIdentifier({ name: \"env\" }) &&\n            path\n              .get(\"object\")\n              ?.get(\"object\")\n              ?.isIdentifier({ name: \"process\" }) &&\n            path.get(\"property\")?.isIdentifier()\n          ) {\n            // process.env.CONFIG_NAME\n\n            const identifier = path.get(\"property\")?.node as t.Identifier;\n            if (!identifier.name) {\n              return;\n            }\n\n            extractEnv(identifier, pass, false, false);\n\n            path.replaceWithSourceString(`env.${identifier.name}`);\n            addImport(path, {\n              module: `${context.config.framework || \"powerlines\"}:env`,\n              name: \"env\",\n              imported: \"env\"\n            });\n          } else if (\n            path\n              .get(\"object\")\n              ?.get(\"property\")\n              ?.isIdentifier({ name: \"env\" }) &&\n            path.get(\"object\")?.get(\"object\")?.isMetaProperty() &&\n            path.get(\"property\")?.isIdentifier()\n          ) {\n            // import.meta.env.CONFIG_NAME\n\n            const identifier = path.get(\"property\")?.node as t.Identifier;\n            if (!identifier.name) {\n              return;\n            }\n\n            extractEnv(identifier, pass, false, false);\n\n            path.replaceWithSourceString(`env.${identifier.name}`);\n            addImport(path, {\n              module: `${context.config.framework || \"powerlines\"}:env`,\n              name: \"env\",\n              imported: \"env\"\n            });\n          } else if (\n            path.get(\"object\")?.isIdentifier({ name: \"env\" }) &&\n            path.get(\"property\")?.isIdentifier()\n          ) {\n            // env.CONFIG_NAME\n\n            const identifier = path.get(\"property\")?.node as t.Identifier;\n            if (!identifier.name) {\n              return;\n            }\n\n            extractEnv(identifier, pass, false, true);\n          }\n        }\n      }\n    };\n  }\n);\n"],"mappings":";;;;;;;;AAEA,SAAS,aAAY,IAAK,MAAC;;AAE1B,QAAU;;AA8BX,MAAO,kBAAA,kBAAA,IAAA,CAAA,OAAA,qBAAA,KAAA,CAAA,EAAA,kBAAA,OAAA,cAAA,EAAA,KAAA,cAAA;CACH,SAAM,WAAc,MAAA,MAAA,eAAA,OAAA,iBAAA,OAAA;EACpB,MAAS,0BAAU,QAAA,IAAA,MAAA,KACT,eAAU,CACZ,OAAA,cAAe,SAAA,KAAA,UAAA,CAAA,SAAA,GAAA;GAAA;GAAA;GAAA;GAAA,CAAA,CAAA;AACrB,MAAA,KAAA,MAAe;GACf,MAAA,OAAiB,KAAA,KAAA,QAAA,IAAA,OAAA,KAAA,QAAA,OAAA,IAAA,OAAA,KAAA,IAAA,CAAA,IAAA,EAAA,GAAA;AACjB,OAAA,cAAA,OAAA,wBAAA,KAAA,YAAA,KAAA,YAAA,eAAA,GAAA;AACM,OAAA,QAAA,IAAA,MAAA,KAA0B,YAAY,KAAM,IAC9C,wBAAc,KAAA,cAAA,SAAA,KAAA,UAAA,CAAA,SAAA,KAAA,EAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA,EAAA;IACR,MAAM,cAAO,QAAW,IAAQ,MAAG,IAAA,YAAA,KAAA,6CAE9B,wBAAA,KAAA,cAAA,SAAA,KAAA,UAAA,CAAA,SAAA,KAAA,EAAA;KAAA;KAAA;KAAA;KAAA,CAAA,CAAA;AACP,QAAM,CAAC,eAAU,YAAO,WAAA,CAClB;AAEX,QAAA,CAAA,QAAA,IAAA,KAAA,IAAA,YAAA,KAAA,EAAA;;AAEE,aAAA,IAAA,KAAA,IAAA,YAAA,YAAA,SAAA;;AAEA,QAAA,QAAY,OAAW,IAAK,UAAU,cAAC;KACjC,IAAA,QAAa,QAAQ,IAAI,SAAA;AAC9B,SAAA,UAAA,QAAA;MACH,MAAA,SAAA,QAAA,OAAA,IAAA,OAAA,KAAA,cAAA,QAAA;;SAEE;OAAA;OAAA;OAAA;OAAA,CAAA,CAAA;AACW,UAAM,OAClB,SACA,QAAA,IAAA,OAAA,GAAA,OAAA,QAAA,OAAA,GAAA,CAAA,GAAA;;AAGI,eAAA,YAA4B,iBAAO;AAC7B,SAAC,YAAW,iBAAa,IAAA,UAAA,OAC9B,OAAA,IAAA,MAAA,0BAAA,KAAA,mDAAA;AAEG,YAAA,sBAAA,aAAA,MAAA;;cAGH,QAAY,OAAS,IAAA,SACrB,OAAA,IAAA,MAAA,QAAA,KAAA,4GAAA,KAAA,WAAA,KAAA,WAAA,UAAA;;wGAEkD,QAAA,IAAA,MAAA,KAC5C,kBAAa,CACd,KAAK,cAAY,GAAA,MAAA,OAAc,EAAA,CAAA,cAAkB,OAAA,EAAA,CAAA,EAAA;IAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA,CACxD,IAAA,cAAA,YAAA,MAAA,OAAA,QAAA,CAAA,GAAA,wBAAA,KAAA,cAAA,SAAA,KAAA,iBAAA,KAAA,OAAA,QAAA;;;;SAEO,WAAa,yBACvB,KAAA,cAAA,SAAA,KAAA,iBAAA,KAAA,OAAA,QAAA,EAAA;IAAA;IAAA;IAAA;IAAA,CAAA,CAAA,aAEY,KAAO,KAAI,CAAA,KACX,MAAE;IAAA;IAAY;IAAQ;IAAM,CAAA,CAAA,CAC7B,KAAK,KAAA,CAAA,yCAAW,QAAA,OAAA,IAAA,OACjB,IAAA,cAAiB,WAAW,MAAM,UAAU;IAAC;IAAE;IAAA;IAAA,CAAA,CAAA,CACnD,KAAO,KAAQ,CAAA,uLAA+C;YAE5D,KAAQ,YAAA,eACV,SAAM,KAAA,QAAA,KAAA,yDAAA,KAAA,SAAA,kSAAA;;;AAKlB,YAAQ,SAAU;EAAA;EAAW;EAAC;EAAiB;EAAA;EAAA;EAAA;UAE3C,SAAQ,EACJ,kBAAiB,aAAA,SAAA,iBAAA,MAAA,MAAA;AACb,MAAC,KACF,IAAA,SAAA,EACH,IAAA,WAAA,mCAEO,KACT,IAAA,SAAA,EACgB,IAAC,SAAW,EACb,aAAA,EAAA,MAAA,WAAA,CAAA,IACL,KAAK,IAAE,WAAY,EAAA,cAAgB,EAAA;GAE1C,MAAA,aAAA,KAAA,IAAA,WAAA,EAAA;wBAEW;AAEJ,cAAQ,YAAU,MAAA,OAAc,MAAU;AAC9C,QAAA,wBAAA,OAAA,WAAA,OAAA;AACF,aAAS,MAAA;IACD,QAAO,GAAA,QAAW,OAAA,aAAA,aAAA;IACtB,MAAA;IACM,UAAE;IACL,CAAC;aAEJ,KACG,IAAG,SAAS,EACX,IAAI,WAAI,EACR,aAAY,EAAA,MAAK,OAAA,CAAA,IACnB,KAAI,IAAA,SAAA,EAAA,IAAA,SAAA,EAAA,gBAAA,IACJ,KAAK,IAAC,WAAS,EAAA,cAAA,EAAA;GAEf,MAAG,aAAA,KAAA,IAAA,WAAA,EAAA;AACN,OAAA,CAAA,WAAA,KACL;AAEK,cAAA,YAAA,MAAA,OAAA,MAAA;AACC,QAAO,wBAAwB,OAAM,WAAQ,OAAW;AACzD,aAAa,MAAG;IAChB,QAAA,GAAA,QAAA,OAAA,aAAA,aAAA;IACA,MAAA;IACC,UAAc;IACrB,CAAA;aAEW,KAAA,IAAA,SAAA,EAAA,aAAA,EAAA,MAAA,OAAA,CAAA,IACH,KAAA,IAAA,WAAA,EAAA,cAAA,EAAA;GAEJ,MAAW,aAAa,KAAK,IAAG,WAAW,EAAA;AACvC,OAAA,CAAA,WAAA,KACG;AAEd,cAAA,YAAA,MAAA,OAAA,KAAA;;;;;;;;KAGF,EACF"}

package/dist/components/docs.cjs

@@ -1,5 +1,6 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+const require_types_plugin = require('../types/plugin.cjs');
 const require_helpers_docs_helper = require('../helpers/docs-helper.cjs');
 let _powerlines_deepkit_vendor_type = require("@powerlines/deepkit/vendor/type");
 let _stryke_path_join = require("@stryke/path/join");
@@ -12,12 +13,30 @@ let _powerlines_plugin_alloy_markdown_components_markdown_file = require("@power
 let _powerlines_plugin_alloy_markdown_components_markdown_table = require("@powerlines/plugin-alloy/markdown/components/markdown-table");
 
 //#region src/components/docs.tsx
+const __ΩPartial = [
+	"T",
+	"Partial",
+	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
+];
+function __assignType(fn, args) {
+	fn.__type = args;
+	return fn;
+}
+const __ΩEnvDocsFileProps = [
+	() => __ΩPartial,
+	"levelOffset",
+	0,
+	"The heading level offset to apply to the generated documentation.",
+	"reflection",
+	"EnvDocsFileProps",
+	"P!o!\"'4\"8>#?$!4%Mw&y"
+];
 /**
 * Generates the environment configuration markdown documentation for the Powerlines project.
 */
 function EnvDocsFile(props) {
 	const { levelOffset = 0, reflection, ...rest } = props;
-	const context = (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	const context = (_powerlines_plugin_alloy_core_contexts_context.usePowerlines.Ω = [[() => require_types_plugin.__ΩEnvPluginContext, "n!"]], (0, _powerlines_plugin_alloy_core_contexts_context.usePowerlines)());
 	return (0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_markdown_components_markdown_file.MarkdownFile, (0, _alloy_js_core_jsx_runtime.mergeProps)({ get path() {
 		return (0, _stryke_path_join.joinPaths)(require_helpers_docs_helper.getDocsOutputPath(context), "env.md");
 	} }, rest, { get children() {
@@ -52,7 +71,16 @@ function EnvDocsFile(props) {
 			_alloy_js_core.code`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.`,
 			(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 			(0, _alloy_js_core_jsx_runtime.createComponent)(_powerlines_plugin_alloy_markdown_components_markdown_table.MarkdownTable, { get data() {
-				return reflection?.getProperties().filter((property) => property.getNameAsString() !== "__POWERLINES_INJECTED__" && !property.isHidden()).sort((a, b) => a.getNameAsString().localeCompare(b.getNameAsString())).map((reflectionProperty) => {
+				return reflection?.getProperties().filter(__assignType((property) => property.getNameAsString() !== "__POWERLINES_INJECTED__" && !property.isHidden(), [
+					"property",
+					"",
+					"P\"2!\"/\""
+				])).sort(__assignType((a, b) => a.getNameAsString().localeCompare(b.getNameAsString()), [
+					"a",
+					"b",
+					"",
+					"P\"2!\"2\"\"/#"
+				])).map(__assignType((reflectionProperty) => {
 					return {
 						name: reflectionProperty.getNameAsString().trim(),
 						description: (reflectionProperty.getDescription() ?? "").trim(),
@@ -60,11 +88,23 @@ function EnvDocsFile(props) {
 						defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
 						required: reflectionProperty.isValueRequired() ? "" : "✔"
 					};
-				}) ?? [];
+				}, [
+					"reflectionProperty",
+					"",
+					"P\"2!\"/\""
+				])) ?? [];
 			} })
 		];
 	} }));
 }
+EnvDocsFile.__type = [
+	() => __ΩEnvDocsFileProps,
+	"props",
+	"EnvDocsFile",
+	"Generates the environment configuration markdown documentation for the Powerlines project.",
+	"Pn!2\"\"/#?$"
+];
 
 //#endregion
-exports.EnvDocsFile = EnvDocsFile;
+exports.EnvDocsFile = EnvDocsFile;
+exports.__ΩEnvDocsFileProps = __ΩEnvDocsFileProps;

package/dist/components/docs.mjs

@@ -1,3 +1,4 @@
+import { __ΩEnvPluginContext } from "../types/plugin.mjs";
 import { getDocsOutputPath } from "../helpers/docs-helper.mjs";
 import { stringifyType } from "@powerlines/deepkit/vendor/type";
 import { joinPaths } from "@stryke/path/join";
@@ -10,12 +11,30 @@ import { MarkdownFile } from "@powerlines/plugin-alloy/markdown/components/markd
 import { MarkdownTable } from "@powerlines/plugin-alloy/markdown/components/markdown-table";
 
 //#region src/components/docs.tsx
+const __ΩPartial = [
+	"T",
+	"Partial",
+	"l+e#!e\"!fRb!Pde\"!gN#\"w\"y"
+];
+function __assignType(fn, args) {
+	fn.__type = args;
+	return fn;
+}
+const __ΩEnvDocsFileProps = [
+	() => __ΩPartial,
+	"levelOffset",
+	0,
+	"The heading level offset to apply to the generated documentation.",
+	"reflection",
+	"EnvDocsFileProps",
+	"P!o!\"'4\"8>#?$!4%Mw&y"
+];
 /**
 * Generates the environment configuration markdown documentation for the Powerlines project.
 */
 function EnvDocsFile(props) {
 	const { levelOffset = 0, reflection, ...rest } = props;
-	const context = usePowerlines();
+	const context = (usePowerlines.Ω = [[() => __ΩEnvPluginContext, "n!"]], usePowerlines());
 	return createComponent(MarkdownFile, mergeProps({ get path() {
 		return joinPaths(getDocsOutputPath(context), "env.md");
 	} }, rest, { get children() {
@@ -50,7 +69,16 @@ function EnvDocsFile(props) {
 			code`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.`,
 			createComponent(Spacing, {}),
 			createComponent(MarkdownTable, { get data() {
-				return reflection?.getProperties().filter((property) => property.getNameAsString() !== "__POWERLINES_INJECTED__" && !property.isHidden()).sort((a, b) => a.getNameAsString().localeCompare(b.getNameAsString())).map((reflectionProperty) => {
+				return reflection?.getProperties().filter(__assignType((property) => property.getNameAsString() !== "__POWERLINES_INJECTED__" && !property.isHidden(), [
+					"property",
+					"",
+					"P\"2!\"/\""
+				])).sort(__assignType((a, b) => a.getNameAsString().localeCompare(b.getNameAsString()), [
+					"a",
+					"b",
+					"",
+					"P\"2!\"2\"\"/#"
+				])).map(__assignType((reflectionProperty) => {
 					return {
 						name: reflectionProperty.getNameAsString().trim(),
 						description: (reflectionProperty.getDescription() ?? "").trim(),
@@ -58,12 +86,23 @@ function EnvDocsFile(props) {
 						defaultValue: reflectionProperty.hasDefault() ? String(reflectionProperty.getDefaultValue())?.includes("\"") ? reflectionProperty.getDefaultValue() : `\`${reflectionProperty.getDefaultValue()}\`` : "",
 						required: reflectionProperty.isValueRequired() ? "" : "✔"
 					};
-				}) ?? [];
+				}, [
+					"reflectionProperty",
+					"",
+					"P\"2!\"/\""
+				])) ?? [];
 			} })
 		];
 	} }));
 }
+EnvDocsFile.__type = [
+	() => __ΩEnvDocsFileProps,
+	"props",
+	"EnvDocsFile",
+	"Generates the environment configuration markdown documentation for the Powerlines project.",
+	"Pn!2\"\"/#?$"
+];
 
 //#endregion
-export { EnvDocsFile };
+export { EnvDocsFile, __ΩEnvDocsFileProps };
 //# sourceMappingURL=docs.mjs.map

package/dist/components/docs.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"docs.mjs","names":[],"sources":["../../src/components/docs.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, Show } from \"@alloy-js/core\";\nimport { Heading, Link } from \"@alloy-js/markdown\";\nimport {\n  ReflectionClass,\n  stringifyType\n} from \"@powerlines/deepkit/vendor/type\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport {\n  MarkdownFile,\n  MarkdownFileProps\n} from \"@powerlines/plugin-alloy/markdown/components/markdown-file\";\nimport { MarkdownTable } from \"@powerlines/plugin-alloy/markdown/components/markdown-table\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { getDocsOutputPath } from \"../helpers/docs-helper\";\nimport { EnvPluginContext } from \"../types/plugin\";\n\nexport interface EnvDocsFileProps extends Partial<MarkdownFileProps> {\n  /**\n   * The heading level offset to apply to the generated documentation.\n   *\n   * @remarks\n   * This is useful when nesting the documentation within other markdown files.\n   *\n   * @defaultValue 0\n   */\n  levelOffset?: number;\n\n  reflection: ReflectionClass<any>;\n}\n\n/**\n * Generates the environment configuration markdown documentation for the Powerlines project.\n */\nexport function EnvDocsFile(props: EnvDocsFileProps) {\n  const { levelOffset = 0, reflection, ...rest } = props;\n\n  const context = usePowerlines<EnvPluginContext>();\n\n  return (\n    <MarkdownFile\n      path={joinPaths(getDocsOutputPath(context), \"env.md\")}\n      {...rest}>\n      <Heading level={1 + levelOffset}>Environment Configuration</Heading>\n      {code`Below is a list of environment variables used by the`}\n      <Show when={!!context.packageJson.name}>\n        <Link\n          href={`https://www.npmjs.com/package/${context.packageJson.name}`}\n          title={context.packageJson.name!}\n        />\n      </Show>\n      {code`package. These values can be updated in the \\`.env\\` file in the root of the project.`}\n      <Spacing />\n      <Heading level={2 + levelOffset}>Environment Variables</Heading>\n      <Spacing />\n      {code`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.`}\n      <Spacing />\n      <MarkdownTable\n        data={\n          reflection\n            ?.getProperties()\n            .filter(\n              property =>\n                property.getNameAsString() !== \"__POWERLINES_INJECTED__\" &&\n                !property.isHidden()\n            )\n            .sort((a, b) =>\n              a.getNameAsString().localeCompare(b.getNameAsString())\n            )\n            .map(reflectionProperty => {\n              return {\n                name: reflectionProperty.getNameAsString().trim(),\n                description: (reflectionProperty.getDescription() ?? \"\").trim(),\n                type: stringifyType(reflectionProperty.getType())\n                  .trim()\n                  .replaceAll(\" | \", \", or \"),\n                defaultValue: reflectionProperty.hasDefault()\n                  ? String(reflectionProperty.getDefaultValue())?.includes('\"')\n                    ? reflectionProperty.getDefaultValue()\n                    : `\\`${reflectionProperty.getDefaultValue()}\\``\n                  : \"\",\n                required: reflectionProperty.isValueRequired() ? \"\" : \"✔\"\n              };\n            }) ?? []\n        }\n      />\n    </MarkdownFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;CA8CE,MAAA,EACF,cAAA,eAEE,GAAA,SACC;CACD,MAAA,UAAA,eAAA;AACF,QAAO,gBAAoB,cAAQ,WAAkB,EACnD,IAAM,OAAE;;cAIR,IAAM,WAAC;AACJ,SAAA;GAAA,gBAAA,SAAA;IACC,OAAM,IAAA;IACJ,UAAO;IACR,CAAA;GAAA,IAAO;GAAoD,gBAAO,MAAA;IAClE,IAAK,OAAM;AACX,YAAU,CAAC,CAAC,QAAQ,YAAY;;IAE/B,IAAE,WAAa;AACb,YAAO,gBAAQ,MAAgB;MAChC,IAAA,OAAA;AACG,cAAA,iCAAA,QAAA,YAAA;;MAEL,IAAS,QAAA;AACF,cAAO,QAAK,YAAa;;MAE5B,CAAC;;IAEL,CAAA;GAAA,IAAA;GAAA,gBAAA,SAAA,EAAA,CAAA;GAAA,gBAAA,SAAA;IACC,OAAK,IAAA;IACL,UAAE;IACH,CAAC;GAAE,gBAAkB,SAAA,EAAA,CAAA;GAAA,IAAA;GAAA,gBAAA,SAAA,EAAA,CAAA;GAAA,gBAAA,eAAA,EACpB,IAAI,OAAO;AACT,WAAI,YAAU,eAAA,CAAA,QAAA,aAAA,SAAA,iBAAA,KAAA,6BAAA,CAAA,SAAA,UAAA,CAAA,CAAA,MAAA,GAAA,MAAA,EAAA,iBAAA,CAAA,cAAA,EAAA,iBAAA,CAAA,CAAA,CAAA,KAAA,uBAAA;AACZ,YAAI;MACF,MAAG,mBAAkB,iBAAA,CAAA,MAAA;MACvB,cAAA,mBAAA,gBAAA,IAAA,IAAA,MAAA;MACC,MAAO,cAAM,mBAAA,SAAA,CAAA,CAAA,MAAA,CAAA,WAAA,OAAA,QAAA;MACZ,cAAE,mBAA+B,YAAG,GAAA,OAAiB,mBAAA,iBAAA,CAAA,EAAA,SAAA,KAAA,GAAA,mBAAA,iBAAA,GAAA,KAAA,mBAAA,iBAAA,CAAA,MAAA;MACvD,UAAA,mBAAA,iBAAA,GAAA,KAAA;MACC;MACD,IAAE,EAAA;MAEP,CAAC;GAAC;IAEN,CAAC,CAAC"}
+{"version":3,"file":"docs.mjs","names":[],"sources":["../../src/components/docs.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { code, Show } from \"@alloy-js/core\";\nimport { Heading, Link } from \"@alloy-js/markdown\";\nimport {\n  ReflectionClass,\n  stringifyType\n} from \"@powerlines/deepkit/vendor/type\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport {\n  MarkdownFile,\n  MarkdownFileProps\n} from \"@powerlines/plugin-alloy/markdown/components/markdown-file\";\nimport { MarkdownTable } from \"@powerlines/plugin-alloy/markdown/components/markdown-table\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { getDocsOutputPath } from \"../helpers/docs-helper\";\nimport { EnvPluginContext } from \"../types/plugin\";\n\nexport interface EnvDocsFileProps extends Partial<MarkdownFileProps> {\n  /**\n   * The heading level offset to apply to the generated documentation.\n   *\n   * @remarks\n   * This is useful when nesting the documentation within other markdown files.\n   *\n   * @defaultValue 0\n   */\n  levelOffset?: number;\n\n  reflection: ReflectionClass<any>;\n}\n\n/**\n * Generates the environment configuration markdown documentation for the Powerlines project.\n */\nexport function EnvDocsFile(props: EnvDocsFileProps) {\n  const { levelOffset = 0, reflection, ...rest } = props;\n\n  const context = usePowerlines<EnvPluginContext>();\n\n  return (\n    <MarkdownFile\n      path={joinPaths(getDocsOutputPath(context), \"env.md\")}\n      {...rest}>\n      <Heading level={1 + levelOffset}>Environment Configuration</Heading>\n      {code`Below is a list of environment variables used by the`}\n      <Show when={!!context.packageJson.name}>\n        <Link\n          href={`https://www.npmjs.com/package/${context.packageJson.name}`}\n          title={context.packageJson.name!}\n        />\n      </Show>\n      {code`package. These values can be updated in the \\`.env\\` file in the root of the project.`}\n      <Spacing />\n      <Heading level={2 + levelOffset}>Environment Variables</Heading>\n      <Spacing />\n      {code`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.`}\n      <Spacing />\n      <MarkdownTable\n        data={\n          reflection\n            ?.getProperties()\n            .filter(\n              property =>\n                property.getNameAsString() !== \"__POWERLINES_INJECTED__\" &&\n                !property.isHidden()\n            )\n            .sort((a, b) =>\n              a.getNameAsString().localeCompare(b.getNameAsString())\n            )\n            .map(reflectionProperty => {\n              return {\n                name: reflectionProperty.getNameAsString().trim(),\n                description: (reflectionProperty.getDescription() ?? \"\").trim(),\n                type: stringifyType(reflectionProperty.getType())\n                  .trim()\n                  .replaceAll(\" | \", \", or \"),\n                defaultValue: reflectionProperty.hasDefault()\n                  ? String(reflectionProperty.getDefaultValue())?.includes('\"')\n                    ? reflectionProperty.getDefaultValue()\n                    : `\\`${reflectionProperty.getDefaultValue()}\\``\n                  : \"\",\n                required: reflectionProperty.isValueRequired() ? \"\" : \"✔\"\n              };\n            }) ?? []\n        }\n      />\n    </MarkdownFile>\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAIA,SAAM,aAAS,IAAW,MAAM;AAC/B,IAAG,SAAU;AACb,QAAQ;;;;;;;;;;;;;;AAiCT,SAAM,YAAA,OAAA;CACJ,MAAG,EACF,cAAA,GACC,YACA,GAAA,SACF;;AAEA,QAAA,gBAAY,cAAoB,WAAA,EAClC,IAAA,OAAA;;IAGG,EAAA,MAAA,EACD,IAAA,WAAA;AACI,SAAC;GAAA,gBAAqB,SAAO;IAC3B,OAAE,IAAA;;IAEH,CAAC;GAAA,IAAA;GAA2C,gBAAA,MAAA;;AAE1C,YAAA,CAAA,CAAA,QAAA,YAAA;;IAEH,IAAM,WAAU;AACZ,YAAK,gBAAA,MAAA;MACR,IAAQ,OAAQ;AACX,cAAS,iCAAgC,QAAQ,YAAI;;MAExD,IAAA,QAAA;AACK,cAAG,QAAY,YAAU;;MAE9B,CAAA;;IAEF,CAAA;GAAA,IAAK;GAAsF,gBAAA,SAAA,EAAA,CAAA;GAAA,gBAAA,SAAA;IAC3F,OAAQ,IAAC;IACT,UAAQ;IACR,CAAA;GAAA,gBAAS,SAAA,EAAA,CAAA;GAAA,IAAA;GAAA,gBAAA,SAAA,EAAA,CAAA;GAAA,gBAAA,eAAA,EACT,IAAK,OAAI;AACT,WAAS,YAAA,eAAA,CAAA,OAAA,cAAA,aAAA,SAAA,iBAAA,KAAA,6BAAA,CAAA,SAAA,UAAA,EAAA;KAAA;KAAA;KAAA;KAAA,CAAA,CAAA,CAAA,KAAA,cAAA,GAAA,MAAA,EAAA,iBAAA,CAAA,cAAA,EAAA,iBAAA,CAAA,EAAA;KAAA;KAAA;KAAA;KAAA;KAAA,CAAA,CAAA,CAAA,IAAA,cAAA,uBAAA;AACT,YAAA;MACM,MAAA,mBAAA,iBAAA,CAAA,MAAA;MACH,cAAA,mBAAA,gBAAA,IAAA,IAAA,MAAA;MACI,MAAA,cAAc,mBAAA,SAAA,CAAA,CAAA,MAAA,CAAA,WAAA,OAAA,QAAA;MACf,cAAM,mBAAA,YAAA,GAAA,OAAA,mBAAA,iBAAA,CAAA,EAAA,SAAA,KAAA,GAAA,mBAAA,iBAAA,GAAA,KAAA,mBAAA,iBAAA,CAAA,MAAA;MACL,UAAU,mBAAA,iBAAA,GAAA,KAAA;MACX;OACA;KAAC;KAAqB;KAAA;KAAA,CAAA,CAAA,IAAA,EAAA;MAE5B,CAAC;GAAC;IAEN,CAAC,CAAC;;AAEL,YAAY,SAAS;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}