@shopify/cli-kit/dist/public/node/environment.js

A set of utilities, interfaces, and models that are common across all the platform features

import { nonRandomUUID } from './crypto.js';
import { isTruthy } from './context/utilities.js';
import { sniffForJson } from './path.js';
import { environmentVariables, systemEnvironmentVariables } from '../../private/node/constants.js';
/**
 * It returns the environment variables of the environment
 * where the Node process is running.
 *
 * This function exists to prevent the access of the process
 * global variable which is discouraged via the no-process-env
 * ESLint rule.
 *
 * @returns Current process environment variables.
 */
export function getEnvironmentVariables() {
    return process.env;
}
/**
 * Returns the value of the SHOPIFY_CLI_PARTNERS_TOKEN environment variable.
 *
 * @returns Current process environment variables.
 */
export function getPartnersToken() {
    return getEnvironmentVariables()[environmentVariables.partnersToken];
}
/**
 * Check if the current proccess is running using the partners token.
 *
 * @returns True if the current proccess is running using the partners token.
 */
export function usePartnersToken() {
    return getPartnersToken() !== undefined;
}
/**
 * Returns the value of the organization id from the environment variables.
 *
 * @returns True if the current proccess is running using the partners token.
 */
export function getOrganization() {
    return getEnvironmentVariables()[environmentVariables.organization];
}
/**
 * Return the backend port value.
 *
 * @returns The port as a number. Undefined otherwise.
 */
export function getBackendPort() {
    const backendPort = getEnvironmentVariables()[systemEnvironmentVariables.backendPort];
    if (backendPort && !isNaN(Number(backendPort))) {
        return Number(backendPort);
    }
    return undefined;
}
/**
 * Returns the information of the identity & refresh tokens, provided by environment variables.
 *
 * @returns The identity token information in case it exists.
 */
export function getIdentityTokenInformation() {
    const identityToken = getEnvironmentVariables()[environmentVariables.identityToken];
    const refreshToken = getEnvironmentVariables()[environmentVariables.refreshToken];
    if (!identityToken || !refreshToken)
        return undefined;
    return {
        accessToken: identityToken,
        refreshToken,
        userId: nonRandomUUID(identityToken),
    };
}
/**
 * Checks if the JSON output is enabled via flag (--json or -j) or environment variable (SHOPIFY_FLAG_JSON).
 *
 * @param environment - Process environment variables.
 * @returns True if the JSON output is enabled, false otherwise.
 */
export function jsonOutputEnabled(environment = getEnvironmentVariables()) {
    return sniffForJson() || isTruthy(environment[environmentVariables.json]);
}
/**
 * If true, the CLI should not use the Partners API.
 *
 * @returns True when the CLI should not use the Partners API.
 */
export function blockPartnersAccess() {
    return isTruthy(getEnvironmentVariables()[environmentVariables.neverUsePartnersApi]);
}
/**
 * If true, the CLI should not use the network level retry.
 *
 * If there is an error when calling a network API that looks like a DNS or connectivity issue, the CLI will by default
 * automatically retry the request.
 *
 * @param environment - Process environment variables.
 * @returns True if the SHOPIFY_CLI_SKIP_NETWORK_LEVEL_RETRY environment variable is set.
 */
export function skipNetworkLevelRetry(environment = getEnvironmentVariables()) {
    return isTruthy(environment[environmentVariables.skipNetworkLevelRetry]);
}
/**
 * Returns the default maximum request time for network calls in milliseconds.
 *
 * After this long, API requests may be cancelled by an AbortSignal. The limit can be overridden by setting the
 * SHOPIFY_CLI_MAX_REQUEST_TIME_FOR_NETWORK_CALLS environment variable.
 *
 * @param environment - Process environment variables.
 * @returns The maximum request time in milliseconds.
 */
export function maxRequestTimeForNetworkCallsMs(environment = getEnvironmentVariables()) {
    const maxRequestTime = environment[environmentVariables.maxRequestTimeForNetworkCalls];
    if (maxRequestTime && !isNaN(Number(maxRequestTime))) {
        return Number(maxRequestTime);
    }
    // 30 seconds is the default
    return 30 * 1000;
}
//# sourceMappingURL=environment.js.map