@zowe/imperative/lib/imperative/src/env/EnvironmentalVariableSettings.js

framework for building configurable CLIs

"use strict";
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.EnvironmentalVariableSettings = void 0;
const expect_1 = require("../../../expect");
const Constants_1 = require("../../../constants/src/Constants");
/**
 * Service for reading environmental variable settings
 * exposed for CLIs built on Imperative CLI framework
 * @export
 * @class EnvironmentalVariableSettings
 */
class EnvironmentalVariableSettings {
    /**
     * Read all environmental variable settings for a CLI
     * @param {string} prefix - the environmental variables for a CLI will begin with this prefix e.g. "SAMPLE_CLI".
     *                          by default, this should be the same as the Imperative.loadedConfig.name field
     *                          unless you specify envVariablePrefix on your Imperative configuration
     * @returns {IImperativeEnvironmentalVariableSettings} - object populated with the settings specified by the user
     * @memberof EnvironmentalVariableSettings
     */
    static read(prefix) {
        expect_1.ImperativeExpect.toBeDefinedAndNonBlank(prefix, "prefix", "You must specify the environmental variable prefix.");
        // helper to create an object matching IImperativeEnvironmentalVariableSetting from a key
        const getSetting = (key, defaultValue) => {
            return { key, value: process.env[key] || defaultValue };
        };
        return {
            imperativeLogLevel: getSetting(prefix + this.IMPERATIVE_LOG_LEVEL_KEY_SUFFIX),
            appLogLevel: getSetting(prefix + this.APP_LOG_LEVEL_KEY_SUFFIX),
            cliHome: getSetting(prefix + this.CLI_HOME_SUFFIX),
            promptPhrase: // Maybe this could default to Constants.DEFAULT_PROMPT_PHRASE
            getSetting(prefix + this.PROMPT_PHRASE_SUFFIX),
            maskOutput: getSetting(prefix + this.APP_MASK_OUTPUT_SUFFIX, Constants_1.Constants.DEFAULT_MASK_OUTPUT),
            pluginsDir: getSetting(prefix + this.CLI_PLUGINS_DIR_SUFFIX),
            showSecureArgs: getSetting(prefix + this.ENV_SHOW_SECURE_SUFFIX, Constants_1.Constants.DEFAULT_SHOW_SECURE),
            socketConnectTimeout: getSetting(prefix + this.ENV_SOCKET_CONNECT_TIMEOUT_SUFFIX, Constants_1.Constants.DEFAULT_SOCKET_CONNECT_TIMEOUT),
            requestCompletionTimeout: getSetting(prefix + this.ENV_REQUEST_COMPLETION_TIMEOUT_SUFFIX),
        };
    }
}
exports.EnvironmentalVariableSettings = EnvironmentalVariableSettings;
/**
 * The end of the environmental variable for configuring the log level for the imperative logger of your CLI
 * The prefix will be added to the beginning of this value to construct the full key
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.IMPERATIVE_LOG_LEVEL_KEY_SUFFIX = "_IMPERATIVE_LOG_LEVEL";
/**
 * The end of the environmental variable for configuring the log level for the appLogger of your CLI
 * The prefix will be added to the beginning of this value to construct the full key
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.APP_LOG_LEVEL_KEY_SUFFIX = "_APP_LOG_LEVEL";
/**
 * The end of the environmental variable for configuring the ability to mask output of your CLI
 * The prefix will be added to the beginning of this value to construct the full key
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.APP_MASK_OUTPUT_SUFFIX = "_APP_MASK_OUTPUT";
/**
 * The end of the environmental variable for configuring the home directory for your CLI
 * The prefix will be added to the beginning of this value to construct the full key
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.CLI_HOME_SUFFIX = "_CLI_HOME";
/**
 * The end of the environmental variable for configuring the prompt phrase for your CLI
 * The prefix will be added to the beginning of this value to construct the full key
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.PROMPT_PHRASE_SUFFIX = "_PROMPT_PHRASE";
/**
 * The end of the environmental variable for configuring the plugins directory for your CLI
 * The prefix will be added to the beginning of this value to contruct the full key
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.CLI_PLUGINS_DIR_SUFFIX = "_CLI_PLUGINS_DIR";
/**
 * Show secure fields in the output of the command ENV var suffix
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.ENV_SHOW_SECURE_SUFFIX = `_SHOW_SECURE_ARGS`;
/**
 * Set the socket connection timeout in milliseconds
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.ENV_SOCKET_CONNECT_TIMEOUT_SUFFIX = "_SOCKET_CONNECT_TIMEOUT";
/**
 * Set the request completion timeout, in milliseconds
 * @type {string}
 * @memberof EnvironmentalVariableSettings
 */
EnvironmentalVariableSettings.ENV_REQUEST_COMPLETION_TIMEOUT_SUFFIX = "_REQUEST_COMPLETION_TIMEOUT";
//# sourceMappingURL=EnvironmentalVariableSettings.js.map