@powerlines/plugin-date 0.12.66 → 0.12.68

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

@@ -0,0 +1,792 @@
+import { LogLevel } from "../../../powerlines/src/types/context.mjs";
+
+//#region ../plugin-env/src/types/runtime.d.ts
+
+/**
+ * The base environment configuration used by Powerlines applications
+ *
+ * @remarks
+ * This interface is used to define the environment variables, configuration options, and runtime settings used by applications. It is used to provide type safety, autocompletion, and default values for the environment variables. The comments of each variable are used to provide documentation descriptions when running the \`powerlines docs\` command.
+ *
+ * @categoryDescription Platform
+ * The name of the platform the configuration parameter is intended for use in.
+ *
+ * @showCategories
+ */
+interface EnvInterface {
+  /**
+   * The name of the application.
+   *
+   * @readonly
+   * @category neutral
+   */
+  readonly APP_NAME: string;
+  /**
+   * The version of the application.
+   *
+   * @defaultValue "1.0.0"
+   *
+   * @readonly
+   * @category neutral
+   */
+  readonly APP_VERSION: string;
+  /**
+   * The unique identifier for the build.
+   *
+   * @readonly
+   * @category neutral
+   */
+  readonly BUILD_ID: string;
+  /**
+   * The timestamp the build was ran at.
+   *
+   * @readonly
+   * @category neutral
+   */
+  readonly BUILD_TIMESTAMP: string;
+  /**
+   * A checksum hash created during the build.
+   *
+   * @readonly
+   * @category neutral
+   */
+  readonly BUILD_CHECKSUM: string;
+  /**
+   * The unique identifier for the release.
+   *
+   * @readonly
+   * @category neutral
+   */
+  readonly RELEASE_ID: string;
+  /**
+   * The tag for the release. This is generally in the format of "\<APP_NAME\>\@\<APP_VERSION\>".
+   *
+   * @readonly
+   * @category neutral
+   */
+  readonly RELEASE_TAG: string;
+  /**
+   * The name of the organization that maintains the application.
+   *
+   * @remarks
+   * This variable is used to specify the name of the organization that maintains the application. If not provided in an environment, it will try to use the value in {@link @storm-software/config-tools/StormWorkspaceConfig#organization}.
+   *
+   * @alias ORG
+   * @alias ORG_ID
+   * @category neutral
+   */
+  ORGANIZATION: string;
+  /**
+   * The platform for which the application was built.
+   *
+   * @defaultValue "neutral"
+   *
+   * @category neutral
+   */
+  PLATFORM: "node" | "neutral" | "browser";
+  /**
+   * The mode in which the application is running.
+   *
+   * @defaultValue "production"
+   *
+   * @alias NODE_ENV
+   *
+   * @category neutral
+   */
+  MODE: "development" | "test" | "production";
+  /**
+   * The environment the application is running in. This value will be populated with the value of `MODE` if not provided.
+   *
+   * @defaultValue "production"
+   *
+   * @alias ENV
+   * @alias VERCEL_ENV
+   * @category neutral
+   */
+  ENVIRONMENT: string;
+  /**
+   * Indicates if the application is running in debug mode.
+   *
+   * @category neutral
+   */
+  DEBUG: boolean;
+  /**
+   * An indicator that specifies the current runtime is a test environment.
+   *
+   * @category neutral
+   */
+  TEST: boolean;
+  /**
+   * An indicator that specifies the current runtime is a minimal environment.
+   *
+   * @category node
+   */
+  MINIMAL: boolean;
+  /**
+   * An indicator that specifies the current runtime is a no color environment.
+   *
+   * @category node
+   */
+  NO_COLOR: boolean;
+  /**
+   * An indicator that specifies the current runtime is a force color environment.
+   *
+   * @category node
+   */
+  FORCE_COLOR: boolean | number;
+  /**
+   * An indicator that specifies the current runtime should force hyperlinks in terminal output.
+   *
+   * @remarks
+   * This variable is used to force hyperlinks in terminal output, even if the terminal does not support them. This is useful for debugging and development purposes.
+      * @category node
+   */
+  FORCE_HYPERLINK: boolean | number;
+  /**
+   * The name of the agent running the application. This variable is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category neutral
+   */
+  readonly AGENT_NAME?: string;
+  /**
+   * The color terminal type. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly COLORTERM?: string;
+  /**
+   * The terminal type. This variable is set by certain CI/CD systems.
+   *
+   * @remarks
+   * This variable is used to specify the terminal type that the application is running in. It can be used to determine how to format output for the terminal.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TERM?: string;
+  /**
+   * The terminal program name. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TERM_PROGRAM?: string;
+  /**
+   * The terminal program version. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TERM_PROGRAM_VERSION?: string;
+  /**
+   * The terminal emulator name. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TERMINAL_EMULATOR?: string;
+  /**
+   * The terminal emulator session ID. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly WT_SESSION?: string;
+  /**
+   * An indicator that specifies the current terminal is running Terminus Sublime. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TERMINUS_SUBLIME?: boolean;
+  /**
+   * The ConEmu task name. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly ConEmuTask?: string;
+  /**
+   * The cursor trace ID. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly CURSOR_TRACE_ID?: string;
+  /**
+   * The VTE version. This variable is set by certain terminal emulators.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly VTE_VERSION?: string;
+  /**
+   * Indicates if error stack traces should be captured.
+   *
+   * @category neutral
+   */
+  STACKTRACE: boolean;
+  /**
+   * Indicates if error data should be included.
+   *
+   * @category neutral
+   */
+  INCLUDE_ERROR_DATA: boolean;
+  /**
+   * A web page to lookup error messages and display additional information given an error code.
+   *
+   * @remarks
+   * This variable is used to provide a URL to a page that can be used to look up error messages given an error code. This is used to provide a more user-friendly error message to the user.
+   *
+   * @title Error Details URL
+   * @category neutral
+   */
+  ERROR_URL: string;
+  /**
+   * The default timezone for the application.
+   *
+   * @defaultValue "America/New_York"
+   * @category neutral
+   */
+  DEFAULT_TIMEZONE: string;
+  /**
+   * The default locale to be used in the application.
+   *
+   * @defaultValue "en_US"
+   * @category neutral
+   */
+  DEFAULT_LOCALE: string;
+  /**
+   * The default lowest log level to accept. If `null`, the logger will reject all records. This value only applies if `lowestLogLevel` is not provided to the `logs` configuration.
+   *
+   * @defaultValue "info"
+   *
+   * @category neutral
+   */
+  LOG_LEVEL?: LogLevel | null;
+  /**
+   * An indicator that specifies the current runtime is a continuous integration environment.
+   *
+   * @title Continuous Integration
+   * @alias CONTINUOUS_INTEGRATION
+   * @category neutral
+   */
+  CI: boolean;
+  /**
+   * The unique identifier for the current run. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly RUN_ID?: string;
+  /**
+   * The agola git reference. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly AGOLA_GIT_REF?: string;
+  /**
+   * The appcircle build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly AC_APPCIRCLE?: string;
+  /**
+   * The appveyor build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly APPVEYOR?: string;
+  /**
+   * The codebuild build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly CODEBUILD?: string;
+  /**
+   * The task force build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TF_BUILD?: string;
+  /**
+   * The bamboo plan key. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly bamboo_planKey?: string;
+  /**
+   * The bitbucket commit. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly BITBUCKET_COMMIT?: string;
+  /**
+   * The bitrise build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly BITRISE_IO?: string;
+  /**
+   * The buddy workspace ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly BUDDY_WORKSPACE_ID?: string;
+  /**
+   * The buildkite build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly BUILDKITE?: string;
+  /**
+   * The circleci build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly CIRCLECI?: string;
+  /**
+   * The cirrus-ci build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly CIRRUS_CI?: string;
+  /**
+   * The cf build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly CF_BUILD_ID?: string;
+  /**
+   * The cm build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly CM_BUILD_ID?: string;
+  /**
+   * The ci name. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly CI_NAME?: string;
+  /**
+   * The drone build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly DRONE?: string;
+  /**
+   * The dsari build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly DSARI?: string;
+  /**
+   * The earthly build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly EARTHLY_CI?: string;
+  /**
+   * The eas build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly EAS_BUILD?: string;
+  /**
+   * The gerrit project. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly GERRIT_PROJECT?: string;
+  /**
+   * The gitea actions build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly GITEA_ACTIONS?: string;
+  /**
+   * The github actions build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly GITHUB_ACTIONS?: string;
+  /**
+   * The gitlab ci build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly GITLAB_CI?: string;
+  /**
+   * The go cd build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly GOCD?: string;
+  /**
+   * The builder output build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly BUILDER_OUTPUT?: string;
+  /**
+   * The harness build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly HARNESS_BUILD_ID?: string;
+  /**
+   * The jenkins url. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly JENKINS_URL?: string;
+  /**
+   * The layerci build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly LAYERCI?: string;
+  /**
+   * The magnum build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly MAGNUM?: string;
+  /**
+   * The netlify build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly NETLIFY?: string;
+  /**
+   * The nevercode build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly NEVERCODE?: string;
+  /**
+   * The prow job ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly PROW_JOB_ID?: string;
+  /**
+   * The release build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly RELEASE_BUILD_ID?: string;
+  /**
+   * The render build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly RENDER?: string;
+  /**
+   * The sailci build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly SAILCI?: string;
+  /**
+   * The hudson build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly HUDSON?: string;
+  /**
+   * The screwdriver build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly SCREWDRIVER?: string;
+  /**
+   * The semaphore build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly SEMAPHORE?: string;
+  /**
+   * The sourcehut build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly SOURCEHUT?: string;
+  /**
+   * The spaceship build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly SPACESHIP_CI?: string;
+  /**
+   * The strider build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly STRIDER?: string;
+  /**
+   * The task ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TASK_ID?: string;
+  /**
+   * The teamcity version. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TEAMCITY_VERSION?: string;
+  /**
+   * The travis build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly TRAVIS?: string;
+  /**
+   * The vela build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly VELA?: string;
+  /**
+   * The now builder build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly NOW_BUILDER?: string;
+  /**
+   * The appcenter build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly APPCENTER_BUILD_ID?: string;
+  /**
+   * The xcode project build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly CI_XCODE_PROJECT?: string;
+  /**
+   * The xcode server build ID. This value is set by certain CI/CD systems.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly XCS?: string;
+  /**
+   * The application's runtime data directory.
+   *
+   * @remarks
+   * This variable is used to override the base path of the system's local application data directory. This variable is used to set the \`$storm.paths.data\` property.
+   *
+   * @title Data Directory
+   * @category node
+   */
+  DATA_DIR?: string;
+  /**
+   * The application's configuration data directory.
+   *
+   * @remarks
+   * This variable is used to override the base path of the system's local application configuration directory. This variable is used to set the \`$storm.paths.config\` property.
+   *
+   * @title Configuration Directory
+   * @category node
+   */
+  CONFIG_DIR?: string;
+  /**
+   * The application's cached data directory.
+   *
+   * @remarks
+   * This variable is used to override the base path of the system's local cache data directory. This variable is used to set the \`$storm.paths.cache\` property.
+   *
+   * @title Cache Directory
+   * @category node
+   */
+  CACHE_DIR?: string;
+  /**
+   * The application's logging directory.
+   *
+   * @remarks
+   * This variable is used to override the base path of the system's local application log directory. This variable is used to set the \`$storm.paths.log\` property.
+   *
+   * @title Log Directory
+   * @category node
+   */
+  LOG_DIR?: string;
+  /**
+   * The application's temporary data directory.
+   *
+   * @remarks
+   * This variable is used to override the base path of the system's local temporary data directory. This variable is used to set the \`$storm.paths.temp\` property.
+   *
+   * @title Temporary Directory
+   * @category node
+   */
+  TEMP_DIR?: string;
+  /**
+   * A variable that specifies the current user's local application data directory on Windows.
+   *
+   * @see https://www.advancedinstaller.com/appdata-localappdata-programdata.html
+   *
+   * @remarks
+   * This variable is used to specify a path to application data that is specific to the current user. This variable can be used to set the \`$storm.paths.data\`, \`$storm.paths.cache\`, and \`$storm.paths.log\` properties.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly LOCALAPPDATA?: string;
+  /**
+   * A variable that specifies the application data directory on Windows.
+   *
+   * @see https://www.advancedinstaller.com/appdata-localappdata-programdata.html
+   *
+   * @remarks
+   * This variable is used to specify a path to application data that is specific to the current user. This variable can be used to set the \`$storm.paths.config\` property.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly APPDATA?: string;
+  /**
+   * A variable that specifies the data path in the home directory on Linux systems using the XDG base directory specification.
+   *
+   * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
+   *
+   * @remarks
+   * This variable is used to specify a path to application data that is specific to the current user. This variable can be used to set the \`$storm.paths.data\` property.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly XDG_DATA_HOME?: string;
+  /**
+   * A variable that specifies the configuration path in the home directory on Linux systems using the XDG base directory specification.
+   *
+   * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
+   *
+   * @remarks
+   * This variable is used to specify a path to configuration data that is specific to the current user. This variable can be used to set the \`$storm.paths.config\` property.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly XDG_CONFIG_HOME?: string;
+  /**
+   * A variable that specifies the cache path in the home directory on Linux systems using the XDG base directory specification.
+   *
+   * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
+   *
+   * @remarks
+   * This variable is used to specify a path to cache data that is specific to the current user. This variable can be used to set the \`$storm.paths.cache\` property.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly XDG_CACHE_HOME?: string;
+  /**
+   * A variable that specifies the state directory on Linux systems using the XDG base directory specification.
+   *
+   * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
+   *
+   * @remarks
+   * This variable is used to specify a path to application state data that is specific to the current user. This variable can be used to set the \`$storm.paths.state\` property.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly XDG_STATE_HOME?: string;
+  /**
+   * A variable that specifies the runtime directory on Linux systems using the XDG base directory specification.
+   *
+   * @see https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c
+   *
+   * @remarks
+   * This variable is used to specify a path to runtime data that is specific to the current user. This variable can be used to set the \`$storm.paths.temp\` property.
+   *
+   * @readonly
+   * @category node
+   */
+  readonly XDG_RUNTIME_DIR?: string;
+  /**
+   * A variable that specifies the [Devenv](https://devenv.sh/) runtime directory.
+   *
+   * @see https://devenv.sh/files-and-variables/#devenv_dotfile
+   * @see https://nixos.org/
+   *
+   * @remarks
+   * This variable is used to specify a path to application data that is specific to the current [Nix](https://nixos.org/) environment. This variable can be used to set the \`$storm.paths.temp\` property.
+   *
+   * @category node
+   */
+  DEVENV_RUNTIME?: string;
+}
+/**
+ * The base secrets configuration used by Powerlines applications
+ *
+ * @remarks
+ * This interface is used to define the secret configuration options used by Powerlines applications. It is used to provide type safety, autocompletion, and default values for the environment variables. The comments of each variable are used to provide documentation descriptions when running the \`storm docs\` command. Since these are secrets, no default values should be provided and the values should be kept confidential (excluded from the client).
+ */
+interface SecretsInterface {
+  /**
+   * The secret key used for encryption and decryption.
+   *
+   * @remarks
+   * This variable is used to provide a secret key for encryption and decryption of sensitive data. It is important that this value is kept confidential and not exposed in client-side code or public repositories.
+   *
+   * @title Encryption Key
+   */
+  ENCRYPTION_KEY: string;
+}
+//#endregion
+export { EnvInterface, SecretsInterface };