@powerlines/plugin-env 0.15.161 → 0.15.162

package/dist/types/plugin.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.mjs","names":[],"sources":["../../src/types/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 { Children } from \"@alloy-js/core\";\nimport { Reflection } from \"@powerlines/deepkit/types\";\nimport {\n  AlloyPluginContext,\n  AlloyPluginOptions,\n  AlloyPluginResolvedConfig,\n  AlloyPluginUserConfig\n} from \"@powerlines/plugin-alloy/types\";\nimport { AutoMDPluginOptions } from \"@powerlines/plugin-automd/types/plugin\";\nimport {\n  BabelPluginContext,\n  BabelPluginOptions,\n  BabelPluginResolvedConfig,\n  BabelPluginUserConfig\n} from \"@powerlines/plugin-babel/types\";\nimport type { DotenvParseOutput } from \"@stryke/env/types\";\nimport {\n  DotenvConfiguration,\n  TypeDefinition,\n  TypeDefinitionParameter\n} from \"@stryke/types/configuration\";\nimport { EnvInterface, SecretsInterface } from \"./runtime\";\n\nexport type EnvType = \"env\" | \"secrets\";\n\nexport type EnvPluginOptions = Omit<DotenvConfiguration, \"types\"> & {\n  /**\n   * 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\"`.\n   */\n  types?: TypeDefinitionParameter;\n\n  /**\n   * 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\"`.\n   */\n  secrets?: TypeDefinitionParameter;\n\n  /**\n   * An additional prefix (or list of additional prefixes) to apply to the environment variables\n   *\n   * @remarks\n   * By default, the plugin will use the `POWERLINES_` prefix. This option is useful for avoiding conflicts with other environment variables.\n   */\n  prefix?: string | string[];\n\n  /**\n   * Should the plugin inject the env variables in the source code with their values?\n   *\n   * @defaultValue false\n   */\n  inject?: boolean;\n\n  /**\n   * The default configuration to use when loading environment variables.\n   *\n   * @remarks\n   * 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.\n   */\n  defaultConfig?: Children;\n\n  /**\n   * Babel configuration options to use when injecting environment variables into the source code.\n   *\n   * @remarks\n   * 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.\n   */\n  babel?: BabelPluginOptions;\n\n  /**\n   * AutoMD configuration options to allow injecting environment variables documentation into a markdown file such as a README.md.\n   *\n   * @remarks\n   * The README.md file should contain the `<!-- automd:env --><!-- /automd -->` comment block where the documentation will be injected.\n   */\n  automd?: AutoMDPluginOptions;\n\n  /**\n   * Alloy configuration options to use when injecting environment variables into the source code.\n   *\n   * @remarks\n   * This option allows you to customize the Alloy transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Alloy settings.\n   */\n  alloy?: AlloyPluginOptions;\n};\n\nexport type EnvPluginUserConfig = BabelPluginUserConfig &\n  AlloyPluginUserConfig & {\n    env: EnvPluginOptions;\n  };\n\nexport type EnvPluginResolvedConfig = BabelPluginResolvedConfig &\n  AlloyPluginResolvedConfig & {\n    env: Required<Pick<DotenvConfiguration, \"additionalFiles\">> &\n      Required<Pick<EnvPluginOptions, \"defaultConfig\">> & {\n        /**\n         * The type definition for the expected env variable parameters\n         *\n         * @remarks\n         * This value is parsed from the {@link EnvPluginOptions.types} option.\n         */\n        types: TypeDefinition;\n\n        /**\n         * The type definition for the expected env secret parameters\n         *\n         * @remarks\n         * This value is parsed from the {@link EnvPluginOptions.secrets} option.\n         */\n        secrets: TypeDefinition;\n\n        /**\n         * Should the plugin inject the env variables in the source code with their values?\n         *\n         * @remarks\n         * This value is the result of reflecting the {@link EnvPluginOptions.inject} option.\n         */\n        inject: EnvPluginOptions[\"inject\"];\n\n        /**\n         * The prefix used for environment variables\n         *\n         * @remarks\n         * This value is used to filter environment variables that are loaded from the .env file and the process environment.\n         */\n        prefix: string[];\n      };\n  };\n\nexport interface EnvPluginContext<\n  TResolvedConfig extends EnvPluginResolvedConfig = EnvPluginResolvedConfig\n>\n  extends\n    BabelPluginContext<TResolvedConfig>,\n    AlloyPluginContext<TResolvedConfig> {\n  env: {\n    /**\n     * The type definitions reflection for the env variables and secrets\n     *\n     * @remarks\n     * These reflections contains the structure of the expected environment variables and secrets as defined by the type definitions provided in the plugin configuration.\n     */\n    types: {\n      /**\n       * The type definitions for the expected env variables\n       */\n      env: Reflection;\n\n      /**\n       * The type definitions for the expected env secrets\n       */\n      secrets: Reflection;\n    };\n\n    /**\n     * The current **used** environment variables and secrets reflection\n     *\n     * @remarks\n     * 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.\n     */\n    used: {\n      /**\n       * The current env variables reflection\n       */\n      env: Reflection<EnvInterface>;\n\n      /**\n       * The current env secrets reflection\n       */\n      secrets: Reflection<SecretsInterface>;\n    };\n\n    /**\n     * The parsed .env configuration object\n     *\n     * @remarks\n     * 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}\n     */\n    parsed: DotenvParseOutput;\n\n    /**\n     * The injected environment variables and secrets reflection\n     *\n     * @remarks\n     * This reflection contains the structure of the injected environment variables and secrets that were injected into the source code during the build process.\n     */\n    injected: Reflection;\n  };\n}\n"],"mappings":";;;;;;;AAAA,MAAM,UAAU;CAAC;CAAK;OAAW;OAAe;CAAY;CAAQ;CAAC;;;;;;AAErE,MAAM,UAAU;CAAC;CAAK;CAAK;CAAQ;CAAY;;;;;;;AA0B/C,MAAM,aAAa;CAAC;CAAA;CAAA;CAAA;CAAA;AAEpB,MAAM,sBAAqB;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;OAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAE3B,MAAM,yBAAyB;OAAO;OAAC;OAAA;CAAA;CAAA;CAAA;CAAA;AAEvC,MAAM,6BAAC;OAAA;OAAA;OAAA;OAAA;CAAA;OAAA;OAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;CAAA;AAEP,MAAM,sBAAU;OAAA;CAAA;OAAA;OAAA;OAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;OAAA;OAAA;CAAA;OAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA;OAAA;CAAA;CAAA;CAAA;CAAA;CAAA"}

package/dist/types/runtime.cjs

@@ -1,4 +1,243 @@
-const require_runtime = require('../runtime-g0TEIoZK.cjs');
 
-exports.__ΩEnvInterface = require_runtime.__ΩEnvInterface;
-exports.__ΩSecretsInterface = require_runtime.__ΩSecretsInterface;
+//#region src/types/runtime.ts
+const __ΩEnvInterface = [
+	"APP_NAME",
+	"The name of the application.",
+	"APP_VERSION",
+	"1.0.0",
+	"The version of the application.",
+	"BUILD_ID",
+	"The unique identifier for the build.",
+	"BUILD_TIMESTAMP",
+	"The timestamp the build was ran at.",
+	"BUILD_CHECKSUM",
+	"A checksum hash created during the build.",
+	"RELEASE_ID",
+	"The unique identifier for the release.",
+	"RELEASE_TAG",
+	"The tag for the release. This is generally in the format of \"\\<APP_NAME\\>\\@\\<APP_VERSION\\>\".",
+	"ORGANIZATION",
+	"The name of the organization that maintains the application.",
+	{ alias: ["ORG"] },
+	"node",
+	"neutral",
+	"browser",
+	"PLATFORM",
+	"neutral",
+	"The platform for which the application was built.",
+	"development",
+	"test",
+	"production",
+	"MODE",
+	"production",
+	"The mode in which the application is running.",
+	{ alias: ["NODE_ENV", "VERCEL_ENV"] },
+	"ENVIRONMENT",
+	"The environment the application is running in. This value will be populated with the value of `MODE` if not provided.",
+	"DEBUG",
+	"Indicates if the application is running in debug mode.",
+	"TEST",
+	"An indicator that specifies the current runtime is a test environment.",
+	"MINIMAL",
+	"An indicator that specifies the current runtime is a minimal environment.",
+	"NO_COLOR",
+	"An indicator that specifies the current runtime is a no color environment.",
+	"FORCE_COLOR",
+	"An indicator that specifies the current runtime is a force color environment.",
+	"FORCE_HYPERLINK",
+	"An indicator that specifies the current runtime should force hyperlinks in terminal output.",
+	"AGENT_NAME",
+	"The name of the agent running the application. This variable is set by certain CI/CD systems.",
+	"COLORTERM",
+	"The color terminal type. This variable is set by certain terminal emulators.",
+	"TERM",
+	"The terminal type. This variable is set by certain CI/CD systems.",
+	"TERM_PROGRAM",
+	"The terminal program name. This variable is set by certain terminal emulators.",
+	"TERM_PROGRAM_VERSION",
+	"The terminal program version. This variable is set by certain terminal emulators.",
+	"TERMINAL_EMULATOR",
+	"The terminal emulator name. This variable is set by certain terminal emulators.",
+	"WT_SESSION",
+	"The terminal emulator session ID. This variable is set by certain terminal emulators.",
+	"TERMINUS_SUBLIME",
+	"An indicator that specifies the current terminal is running Terminus Sublime. This variable is set by certain terminal emulators.",
+	"ConEmuTask",
+	"The ConEmu task name. This variable is set by certain terminal emulators.",
+	"CURSOR_TRACE_ID",
+	"The cursor trace ID. This variable is set by certain terminal emulators.",
+	"VTE_VERSION",
+	"The VTE version. This variable is set by certain terminal emulators.",
+	"STACKTRACE",
+	"Indicates if error stack traces should be captured.",
+	"INCLUDE_ERROR_DATA",
+	"Indicates if error data should be included.",
+	"ERROR_URL",
+	"A web page to lookup error messages and display additional information given an error code.",
+	{ title: "Error Details URL" },
+	"DEFAULT_TIMEZONE",
+	"America/New_York",
+	"The default timezone for the application.",
+	"DEFAULT_LOCALE",
+	"en_US",
+	"The default locale to be used in the application.",
+	"error",
+	"warn",
+	"info",
+	"debug",
+	"LOG_LEVEL",
+	"info",
+	"The default lowest log level to accept. If `null`, the logger will reject all records.",
+	"CI",
+	"An indicator that specifies the current runtime is a continuous integration environment.",
+	{
+		alias: ["CONTINUOUS_INTEGRATION"],
+		title: "Continuous Integration"
+	},
+	"RUN_ID",
+	"The unique identifier for the current run. This value is set by certain CI/CD systems.",
+	"AGOLA_GIT_REF",
+	"The agola git reference. This value is set by certain CI/CD systems.",
+	"AC_APPCIRCLE",
+	"The appcircle build ID. This value is set by certain CI/CD systems.",
+	"APPVEYOR",
+	"The appveyor build ID. This value is set by certain CI/CD systems.",
+	"CODEBUILD",
+	"The codebuild build ID. This value is set by certain CI/CD systems.",
+	"TF_BUILD",
+	"The task force build ID. This value is set by certain CI/CD systems.",
+	"bamboo_planKey",
+	"The bamboo plan key. This value is set by certain CI/CD systems.",
+	"BITBUCKET_COMMIT",
+	"The bitbucket commit. This value is set by certain CI/CD systems.",
+	"BITRISE_IO",
+	"The bitrise build ID. This value is set by certain CI/CD systems.",
+	"BUDDY_WORKSPACE_ID",
+	"The buddy workspace ID. This value is set by certain CI/CD systems.",
+	"BUILDKITE",
+	"The buildkite build ID. This value is set by certain CI/CD systems.",
+	"CIRCLECI",
+	"The circleci build ID. This value is set by certain CI/CD systems.",
+	"CIRRUS_CI",
+	"The cirrus-ci build ID. This value is set by certain CI/CD systems.",
+	"CF_BUILD_ID",
+	"The cf build ID. This value is set by certain CI/CD systems.",
+	"CM_BUILD_ID",
+	"The cm build ID. This value is set by certain CI/CD systems.",
+	"CI_NAME",
+	"The ci name. This value is set by certain CI/CD systems.",
+	"DRONE",
+	"The drone build ID. This value is set by certain CI/CD systems.",
+	"DSARI",
+	"The dsari build ID. This value is set by certain CI/CD systems.",
+	"EARTHLY_CI",
+	"The earthly build ID. This value is set by certain CI/CD systems.",
+	"EAS_BUILD",
+	"The eas build ID. This value is set by certain CI/CD systems.",
+	"GERRIT_PROJECT",
+	"The gerrit project. This value is set by certain CI/CD systems.",
+	"GITEA_ACTIONS",
+	"The gitea actions build ID. This value is set by certain CI/CD systems.",
+	"GITHUB_ACTIONS",
+	"The github actions build ID. This value is set by certain CI/CD systems.",
+	"GITLAB_CI",
+	"The gitlab ci build ID. This value is set by certain CI/CD systems.",
+	"GOCD",
+	"The go cd build ID. This value is set by certain CI/CD systems.",
+	"BUILDER_OUTPUT",
+	"The builder output build ID. This value is set by certain CI/CD systems.",
+	"HARNESS_BUILD_ID",
+	"The harness build ID. This value is set by certain CI/CD systems.",
+	"JENKINS_URL",
+	"The jenkins url. This value is set by certain CI/CD systems.",
+	"LAYERCI",
+	"The layerci build ID. This value is set by certain CI/CD systems.",
+	"MAGNUM",
+	"The magnum build ID. This value is set by certain CI/CD systems.",
+	"NETLIFY",
+	"The netlify build ID. This value is set by certain CI/CD systems.",
+	"NEVERCODE",
+	"The nevercode build ID. This value is set by certain CI/CD systems.",
+	"PROW_JOB_ID",
+	"The prow job ID. This value is set by certain CI/CD systems.",
+	"RELEASE_BUILD_ID",
+	"The release build ID. This value is set by certain CI/CD systems.",
+	"RENDER",
+	"The render build ID. This value is set by certain CI/CD systems.",
+	"SAILCI",
+	"The sailci build ID. This value is set by certain CI/CD systems.",
+	"HUDSON",
+	"The hudson build ID. This value is set by certain CI/CD systems.",
+	"SCREWDRIVER",
+	"The screwdriver build ID. This value is set by certain CI/CD systems.",
+	"SEMAPHORE",
+	"The semaphore build ID. This value is set by certain CI/CD systems.",
+	"SOURCEHUT",
+	"The sourcehut build ID. This value is set by certain CI/CD systems.",
+	"SPACESHIP_CI",
+	"The spaceship build ID. This value is set by certain CI/CD systems.",
+	"STRIDER",
+	"The strider build ID. This value is set by certain CI/CD systems.",
+	"TASK_ID",
+	"The task ID. This value is set by certain CI/CD systems.",
+	"TEAMCITY_VERSION",
+	"The teamcity version. This value is set by certain CI/CD systems.",
+	"TRAVIS",
+	"The travis build ID. This value is set by certain CI/CD systems.",
+	"VELA",
+	"The vela build ID. This value is set by certain CI/CD systems.",
+	"NOW_BUILDER",
+	"The now builder build ID. This value is set by certain CI/CD systems.",
+	"APPCENTER_BUILD_ID",
+	"The appcenter build ID. This value is set by certain CI/CD systems.",
+	"CI_XCODE_PROJECT",
+	"The xcode project build ID. This value is set by certain CI/CD systems.",
+	"XCS",
+	"The xcode server build ID. This value is set by certain CI/CD systems.",
+	"DATA_DIR",
+	"The application's runtime data directory.",
+	{ title: "Data Directory" },
+	"CONFIG_DIR",
+	"The application's configuration data directory.",
+	{ title: "Configuration Directory" },
+	"CACHE_DIR",
+	"The application's cached data directory.",
+	{ title: "Cache Directory" },
+	"LOG_DIR",
+	"The application's logging directory.",
+	{ title: "Log Directory" },
+	"TEMP_DIR",
+	"The application's temporary data directory.",
+	{ title: "Temporary Directory" },
+	"LOCALAPPDATA",
+	"A variable that specifies the current user's local application data directory on Windows.",
+	"APPDATA",
+	"A variable that specifies the application data directory on Windows.",
+	"XDG_DATA_HOME",
+	"A variable that specifies the data path in the home directory on Linux systems using the XDG base directory specification.",
+	"XDG_CONFIG_HOME",
+	"A variable that specifies the configuration path in the home directory on Linux systems using the XDG base directory specification.",
+	"XDG_CACHE_HOME",
+	"A variable that specifies the cache path in the home directory on Linux systems using the XDG base directory specification.",
+	"XDG_STATE_HOME",
+	"A variable that specifies the state directory on Linux systems using the XDG base directory specification.",
+	"XDG_RUNTIME_DIR",
+	"A variable that specifies the runtime directory on Linux systems using the XDG base directory specification.",
+	"DEVENV_RUNTIME",
+	"A variable that specifies the [Devenv](https://devenv.sh/) runtime directory.",
+	"The base environment configuration used by Powerlines applications",
+	"EnvInterface",
+	"P&4!9?\"&4#9>$?%&4&9?'&4(9?)&4*9?+&4,9?-&4.9?/&40?1z2P.3.4.5J46>7?8P.9.:.;J4<>=?>z?&4@>=?A)4B?C)4D?E)4F?G)4H?IP)'J4J?KP)'J4L?M&4N89?O&4P89?Q&4R89?S&4T89?U&4V89?W&4X89?Y&4Z89?[)4\\89?]&4^89?_&4`89?a&4b89?c)4d?e)4f?g&4h?izj&4k>l?m&4n>o?pP.q.r.s.t,J4u8>v?w)4x?yzz&4{89?|&4}89?~&489?€&489?‚&4ƒ89?„&4…89?†&4‡89?ˆ&4‰89?Š&4‹89?Œ&489?Ž&489?&4‘89?’&4“89?”&4•89?–&4—89?˜&4™89?š&4›89?œ&489?ž&4Ÿ89?\xA0&4¡89?¢&4£89?¤&4¥89?¦&4§89?¨&4©89?ª&4«89?¬&4­89?®&4¯89?°&4±89?²&4³89?´&4µ89?¶&4·89?¸&4¹89?º&4»89?¼&4½89?¾&4¿89?À&4Á89?Â&4Ã89?Ä&4Å89?Æ&4Ç89?È&4É89?Ê&4Ë89?Ì&4Í89?Î&4Ï89?Ð&4Ñ89?Ò&4Ó89?Ô&4Õ89?Ö&4×89?Ø&4Ù89?Ú&4Û89?Ü&4Ý89?Þ&4ß8?àzá&4â8?ãzä&4å8?æzç&4è8?ézê&4ë8?ìzí&4î89?ï&4ð89?ñ&4ò89?ó&4ô89?õ&4ö89?÷&4ø89?ù&4ú89?û&4ü8?ýM?þwÿy"
+];
+const __ΩSecretsInterface = [
+	"ENCRYPTION_KEY",
+	"The secret key used for encryption and decryption.",
+	{ title: "Encryption Key" },
+	"The base secrets configuration used by Powerlines applications",
+	"SecretsInterface",
+	"P&4!?\"z#M?$w%y"
+];
+
+//#endregion
+exports.__ΩEnvInterface = __ΩEnvInterface;
+exports.__ΩSecretsInterface = __ΩSecretsInterface;