@sap/cli-core 2023.24.0 → 2024.1.0

package/CHANGELOG.md

@@ -5,6 +5,59 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2024.1.0
+
+### Fixed
+
+- The `--browser` option introduced with version `2023.25.0` did not apply the default correctly in case the option `--browser` was not explicitly specified.
+
+## 2023.25.0
+
+### Added
+
+- A check for the correct node version environment when using the CLI. In case the node version does not satisfy the minimum node version required by the CLI to function correctly, a warning is printed to the console.
+
+- When printing the help information for the `login` command, the list of options now includes the login-specific options such as `--authorization-url` and `--token-url`. Previously the help showed the following options:
+
+  ```bash
+  <CLI> login --help
+  Usage: <CLI> login [options]
+  log in to your account using interactive OAuth authentication
+  Options:
+    -H, --host <host>  specifies the url where the tenant is hosted (optional)
+    -h, --help         display help for command
+  ```
+
+  With this version, the help looks like this:
+
+  ```bash
+  <CLI> login --help
+  Usage: <CLI> login [options]
+  log in to your account using interactive OAuth authentication
+  Options:
+    -H, --host <host>              specifies the url where the tenant is hosted (optional)
+    -A, --authorization-url <url>  authorization url for interactive oauth session authentication (optional)
+    -t, --token-url <url>          token url for interactive oauth session authentication (optional)
+    -c, --client-id <id>           client id for interactive oauth session authentication (optional)
+    -C, --client-secret <secret>   client secret for interactive oauth session authentication (optional)
+    -a, --access-token <token>     access token for interactive oauth session authentication (optional)
+    -b, --code <code>              code for oauth token retrieval (optional)
+    -r, --refresh-token <token>    refresh token for interactive oauth session authentication (optional)
+    -s, --secrets-file <file>      path to secrets file (optional)
+    -h, --help                     display help for command
+  Only command-specific options are listed here. To learn more about available generic options, visit https://tinyurl.com/yck8vv4w
+  ```
+
+- Added the option `--browser <browser>` to the login command. Users can now choose explicitly which browser to open when logging in to a tenant. By default the system's default browser is used.
+
+### Fixed
+
+- The HTTPS proxy support introduced with `2023.24.0` did not respect the underlying `axios` module configuration need to disable the native proxy handling by passing `proxy: false` to the request configuration.
+
+### Changed
+
+- Previously, when running the `logout` command but no secrets existed anymore, the command would fail with exit code 1 and an error message. Now, when running the `logout` command but there are no secrets to logout from, the command fails silently.
+
 ## 2023.24.0
 
 ### Fixed

package/commands/handler/authentication/oauth/tokenProvider/utils.js

@@ -8,8 +8,8 @@ const utils_1 = require("../utils");
 const setAuthorization_1 = require("./setAuthorization");
 const constants_1 = require("../../../../../constants");
 const options_1 = require("../../../../../utils/options");
-const utils_2 = require("../../../../../utils/utils");
 const SecretsStorageSingleton_1 = require("../../../../../cache/secrets/SecretsStorageSingleton");
+const openUtils_1 = require("../../../../../utils/openUtils");
 const getLogger = () => (0, logger_1.get)("commands.handler.authentication.oauth.tokenProvider.utils.refreshToken");
 const refreshToken = async (forceRefresh = false) => {
     const { info: logInfo, debug } = getLogger();
@@ -90,7 +90,7 @@ const getCode = async (authorizeUrl, clientId) => {
         debug("failed to retrieve code from options", err);
         return (await Promise.all([
             (0, exports.retrieveCode)(),
-            (0, utils_2.openUrlInBrowser)(authorizeUrl, {
+            (0, openUtils_1.openUrlInBrowser)(authorizeUrl, {
                 response_type: "code",
                 client_id: clientId,
             }),

package/commands/login.command.js

@@ -8,6 +8,8 @@ const init_command_1 = require("./config.command/cache.command/init.command");
 const utils_1 = require("../cache/secrets/utils");
 const utils_2 = require("../logger/utils");
 const utils_3 = require("../utils/utils");
+const utils_4 = require("./utils");
+const openUtils_1 = require("../utils/openUtils");
 const getLogger = () => (0, logger_1.get)("commands.login");
 const verifyHost = async () => async () => {
     const logger = getLogger();
@@ -41,6 +43,19 @@ const loginCommand = {
         { ...constants_1.OPTION_HOST, hidden: false, required: true },
         constants_1.OPTION_VERBOSE,
         constants_1.OPTION_OPTIONS_FILE,
+        { ...constants_1.OPTION_AUTHORIZATION_URL, hidden: false },
+        { ...constants_1.OPTION_TOKEN_URL, hidden: false },
+        { ...constants_1.OPTION_CLIENT_ID, hidden: false },
+        { ...constants_1.OPTION_CLIENT_SECRET, hidden: false },
+        { ...constants_1.OPTION_ACCESS_TOKEN, hidden: false },
+        { ...constants_1.OPTION_CODE, hidden: false },
+        { ...constants_1.OPTION_REFRESH_TOKEN, hidden: false },
+        { ...constants_1.OPTION_SECRETS_FILE, hidden: false },
+        {
+            ...constants_1.OPTION_BROWSER,
+            choices: utils_4.getBrowserChoices,
+            default: openUtils_1.getDefaultBrowser,
+        },
     ]), (0, handler_1.createMandatoryOptionsHandler)(), verifyHost, (0, handler_1.createOauthHandler)(), initializeCache),
 };
 exports.default = loginCommand;

package/commands/logout.command.js

@@ -16,7 +16,6 @@ const handler = async () => async () => {
         const logger = (0, logger_1.get)("commands.logout");
         logger.error("failed to delete secrets file from cache", err);
         (0, utils_1.logVerbose)(logger, err.message);
-        throw new Error("failed to delete secrets file from cache");
     }
 };
 const logoutCommand = {

package/commands/utils.d.ts

@@ -1,2 +1,3 @@
 import { ChoicesFunction } from "../types";
 export declare const getChoices: ChoicesFunction;
+export declare const getBrowserChoices: ChoicesFunction;

package/commands/utils.js

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getChoices = void 0;
+exports.getBrowserChoices = exports.getChoices = void 0;
+const open_1 = require("open");
 const SecretsStorageSingleton_1 = require("../cache/secrets/SecretsStorageSingleton");
 const getChoices = async () => {
     return SecretsStorageSingleton_1.SecretsStorageSingleton.SINGLETON.getAllSecrets().map((secret) => secret.id.toString(10));
 };
 exports.getChoices = getChoices;
+const getBrowserChoices = async () => {
+    return Object.keys(open_1.apps);
+};
+exports.getBrowserChoices = getBrowserChoices;

package/constants.d.ts

@@ -44,3 +44,4 @@ export declare const CONFIG_PASSCODE_FUNCTION = "passcodeFunction";
 export declare const OPTION_OPTIONS_FILE: Option;
 export declare const OPTION_FILE_PATH: Option;
 export declare const OPTION_INPUT: Option;
+export declare const OPTION_BROWSER: Option;

package/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OPTION_INPUT = exports.OPTION_FILE_PATH = exports.OPTION_OPTIONS_FILE = exports.CONFIG_PASSCODE_FUNCTION = exports.OPTION_PASSCODE = exports.OPTION_CODE = exports.OPTION_SECRETS_FILE = exports.OPTION_EXPIRES_IN = exports.OPTION_REFRESH_TOKEN = exports.OPTION_ACCESS_TOKEN = exports.OPTION_TOKEN_URL = exports.OPTION_AUTHORIZATION_URL = exports.OPTION_CLIENT_SECRET = exports.OPTION_CLIENT_ID = exports.OPTION_FORCE = exports.OPTION_VERBOSE = exports.OPTION_NO_PRETTY = exports.OPTION_OUTPUT = exports.OPTION_LOGIN_ID = exports.OPTION_HOST = exports.OPTION_HELP = exports.OPTION_VERSION = exports.CACHE_SECRETS_FILE = exports.PATH_TO_ERROR_HTML = exports.PATH_TO_SUCCESS_HTML = exports.X_OUTPUT_FILE_NAME = exports.X_CSRF_TOKEN = exports.DISCOVERY_METADATA_PATH = exports.SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH = exports.CLI_GENERIC_OPTIONS_HELP = exports.CLI_SUPPORTED_AUTHENTICATION_METHODS = exports.CLI_DEPRECATION_MESSAGE = exports.CLI_DEPRECATED = exports.CLI_VERSION = exports.CLI_SAP_HELP = exports.CLI_DISCOVERY_PATH = exports.CLI_DESCRIPTION = exports.CLI_PACKAGE_NAME = exports.CLI_NAME = exports.AuthenticationMethod = exports.DISCOVERY_DOCUMENT_PREFIX = exports.VERSION = void 0;
+exports.OPTION_BROWSER = exports.OPTION_INPUT = exports.OPTION_FILE_PATH = exports.OPTION_OPTIONS_FILE = exports.CONFIG_PASSCODE_FUNCTION = exports.OPTION_PASSCODE = exports.OPTION_CODE = exports.OPTION_SECRETS_FILE = exports.OPTION_EXPIRES_IN = exports.OPTION_REFRESH_TOKEN = exports.OPTION_ACCESS_TOKEN = exports.OPTION_TOKEN_URL = exports.OPTION_AUTHORIZATION_URL = exports.OPTION_CLIENT_SECRET = exports.OPTION_CLIENT_ID = exports.OPTION_FORCE = exports.OPTION_VERBOSE = exports.OPTION_NO_PRETTY = exports.OPTION_OUTPUT = exports.OPTION_LOGIN_ID = exports.OPTION_HOST = exports.OPTION_HELP = exports.OPTION_VERSION = exports.CACHE_SECRETS_FILE = exports.PATH_TO_ERROR_HTML = exports.PATH_TO_SUCCESS_HTML = exports.X_OUTPUT_FILE_NAME = exports.X_CSRF_TOKEN = exports.DISCOVERY_METADATA_PATH = exports.SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH = exports.CLI_GENERIC_OPTIONS_HELP = exports.CLI_SUPPORTED_AUTHENTICATION_METHODS = exports.CLI_DEPRECATION_MESSAGE = exports.CLI_DEPRECATED = exports.CLI_VERSION = exports.CLI_SAP_HELP = exports.CLI_DISCOVERY_PATH = exports.CLI_DESCRIPTION = exports.CLI_PACKAGE_NAME = exports.CLI_NAME = exports.AuthenticationMethod = exports.DISCOVERY_DOCUMENT_PREFIX = exports.VERSION = void 0;
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("./utils/utils");
 exports.VERSION = (0, utils_1.getVersion)();
@@ -203,3 +203,12 @@ exports.OPTION_INPUT = {
         type: "text",
     },
 };
+exports.OPTION_BROWSER = {
+    longName: "browser",
+    description: "specifies the browser to open",
+    args: [{ name: "browser" }],
+    prompts: {
+        message: "Select your browser:",
+        type: "select",
+    },
+};

package/dwc/run.js

@@ -31,6 +31,7 @@ const run = async () => {
             output(message);
         }
         await SecretsStorageSingleton_1.SecretsStorageSingleton.SINGLETON.synchronizeSecretsToStorage();
+        (0, utils_1.verifyNodeVersion)();
         if (exitCode > 0) {
             process.exit(exitCode);
         }

package/dwc/utils.d.ts

@@ -1,6 +1,7 @@
 import { Command } from "commander";
 import { Option } from "../types";
 export declare const addCommandsFromFolder: (pathToFolder: string, program: Command) => Promise<void>;
+export declare function verifyNodeVersion(): void;
 export declare const checkVersion: () => Promise<void>;
 export declare const compareEtags: () => Promise<void>;
 export declare const getOptionValueFromArgv: ({ longName }: Option) => string;

package/dwc/utils.js

@@ -3,9 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOptionValueFromArgv = exports.compareEtags = exports.checkVersion = exports.addCommandsFromFolder = void 0;
+exports.getOptionValueFromArgv = exports.compareEtags = exports.checkVersion = exports.verifyNodeVersion = exports.addCommandsFromFolder = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const compare_versions_1 = require("compare-versions");
 const logger_1 = require("../logger");
 const discovery_1 = require("../discovery");
 const commands_1 = require("../utils/commands");
@@ -38,6 +39,16 @@ const addCommandsFromFolder = async (pathToFolder, program) => {
     }
 };
 exports.addCommandsFromFolder = addCommandsFromFolder;
+function verifyNodeVersion() {
+    const { output } = getLogger();
+    const { node } = (0, utils_1.getEngines)();
+    const version = process.version.replace("v", "").trim();
+    if (!(0, compare_versions_1.satisfies)(version, node)) {
+        output(`WARNING: the current node version ${version} does not satisfy the required node version ${node}.` +
+            ` The CLI might not behave as expected. Please make sure to install a matching node version.`);
+    }
+}
+exports.verifyNodeVersion = verifyNodeVersion;
 const checkVersion = async () => {
     const { output, error } = getLogger();
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cli-core",
-  "version": "2023.24.0",
+  "version": "2024.1.0",
   "description": "Command-Line Interface (CLI) Core Module",
   "license": "SEE LICENSE IN LICENSE",
   "author": "SAP SE",
@@ -18,8 +18,9 @@
   ],
   "dependencies": {
     "ajv": "8.12.0",
-    "axios": "1.5.1",
+    "axios": "1.6.1",
     "commander": "11.1.0",
+    "compare-versions": "6.1.0",
     "config": "3.3.9",
     "dotenv": "16.3.1",
     "fs-extra": "11.1.1",

package/types.d.ts

@@ -129,6 +129,9 @@ export type PackageJson = {
     bin?: {
         [key: string]: string;
     };
+    engines: {
+        node: string;
+    };
 };
 export type DiscoveryMetadata = {
     tenant: string;
@@ -137,12 +140,13 @@ export type DiscoveryMetadata = {
 export type KeyValuePair = {
     [key: string]: any;
 };
+export type DefaultFunction = () => Promise<string>;
 export type ChoicesFunction = () => Promise<Array<string>>;
 export type Choices = Array<string>;
 export type Option = {
     longName: string;
     description: string;
-    default?: string;
+    default?: string | DefaultFunction;
     required?: boolean;
     choices?: Choices | ChoicesFunction;
     args?: Array<{

package/utils/commands.js

@@ -81,8 +81,11 @@ const buildOption = async ({ longName, description, choices, required, default:
         : "";
     const option = new commander_1.Option(`-${shortFlag}, --${longName}${argStr}`, newDescr)
         .makeOptionMandatory(mandatory)
-        .default(defaultValue)
         .hideHelp(!!hidden);
+    if (defaultValue) {
+        const defaultStr = typeof defaultValue === "function" ? await defaultValue() : defaultValue;
+        option.default(defaultStr);
+    }
     let choicesArr = [];
     if (choices) {
         choicesArr = typeof choices === "function" ? await choices() : choices;

package/utils/http/index.js

@@ -50,6 +50,7 @@ const fetch = async (config) => {
         }
         const res = await (0, axios_1.default)({
             httpsAgent,
+            proxy: false,
             ...config,
             ...exports.DEFAULTS,
             headers: {

package/utils/openUtils.d.ts

@@ -0,0 +1,10 @@
+import { AppName } from "open";
+export type Browser = {
+    name: AppName;
+    app: string;
+};
+export declare function getSupportedBrowsers(): Array<Browser>;
+export declare function getDefaultBrowser(): Promise<string>;
+export declare const openUrlInBrowser: (url: string, queryParameters?: {
+    [key: string]: string;
+}) => Promise<void>;

package/utils/openUtils.js

@@ -0,0 +1,58 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.openUrlInBrowser = exports.getDefaultBrowser = exports.getSupportedBrowsers = void 0;
+const open_1 = __importStar(require("open"));
+const constants_1 = require("../constants");
+const options_1 = require("./options");
+const logger_1 = require("../logger");
+const getLogger = () => (0, logger_1.get)("utils.open");
+function getSupportedBrowsers() {
+    return Object.entries(open_1.apps).map(([key, value]) => ({
+        name: key,
+        app: value,
+    }));
+}
+exports.getSupportedBrowsers = getSupportedBrowsers;
+async function getDefaultBrowser() {
+    return getSupportedBrowsers()[0].name;
+}
+exports.getDefaultBrowser = getDefaultBrowser;
+async function getBrowser() {
+    const browser = (0, options_1.getOptionValueFromConfig)(constants_1.OPTION_BROWSER, await getDefaultBrowser());
+    return open_1.apps[browser];
+}
+const openUrlInBrowser = async (url, queryParameters = {}) => {
+    const browser = await getBrowser();
+    const u = new URL(url);
+    for (const [key, value] of Object.entries(queryParameters)) {
+        u.searchParams.append(key, value);
+    }
+    const urlString = u.toString();
+    const { debug } = getLogger();
+    debug(`open browser ${browser} at ${urlString}`);
+    await (0, open_1.default)(urlString, { app: { name: browser } });
+};
+exports.openUrlInBrowser = openUrlInBrowser;

package/utils/utils.d.ts

@@ -10,6 +10,7 @@ export declare const getVersion: (cwd?: string) => string;
 export declare const getName: (cwd?: string) => string;
 export declare const getPackageName: (cwd?: string) => string;
 export declare const getDescription: (cwd?: string) => string;
+export declare const getEngines: (cwd?: string) => PackageJson["engines"];
 export declare const getBin: (cwd?: string) => string;
 export declare const removeScopeFromPackageName: (packageName: string) => string;
 export declare const parseTenant: (tenant: string) => string;
@@ -24,6 +25,3 @@ export declare const getInfoFromTenant: (tenant: string, verbose: boolean, print
 export declare function removeQueryParametersFromUrl(sUrl: string): string;
 export declare const sha256: (string: string) => string;
 export declare const toConstantCase: (string: string) => string;
-export declare const openUrlInBrowser: (url: string, queryParameters?: {
-    [key: string]: string;
-}) => Promise<void>;

package/utils/utils.js

@@ -26,11 +26,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openUrlInBrowser = exports.toConstantCase = exports.sha256 = exports.removeQueryParametersFromUrl = exports.getInfoFromTenant = exports.parseTenant = exports.removeScopeFromPackageName = exports.getBin = exports.getDescription = exports.getPackageName = exports.getName = exports.getVersion = exports.readPackageJson = exports.requireFile = exports.parseVersion = exports.buildOptionName = void 0;
+exports.toConstantCase = exports.sha256 = exports.removeQueryParametersFromUrl = exports.getInfoFromTenant = exports.parseTenant = exports.removeScopeFromPackageName = exports.getBin = exports.getEngines = exports.getDescription = exports.getPackageName = exports.getName = exports.getVersion = exports.readPackageJson = exports.requireFile = exports.parseVersion = exports.buildOptionName = void 0;
 const crypto = __importStar(require("crypto"));
 const path_1 = __importDefault(require("path"));
 const lodash_1 = require("lodash");
-const open_1 = __importDefault(require("open"));
 const logger_1 = require("../logger");
 const commands_1 = require("./commands");
 let pgk;
@@ -92,6 +91,10 @@ const getDescription = (cwd = "") => {
     return (0, exports.readPackageJson)(cwd, true).description;
 };
 exports.getDescription = getDescription;
+const getEngines = (cwd = "") => {
+    return (0, exports.readPackageJson)(cwd, true).engines;
+};
+exports.getEngines = getEngines;
 const getBin = (cwd = "") => {
     const keys = Object.keys((0, exports.readPackageJson)(cwd, true).bin || {});
     if (keys.length === 0) {
@@ -165,14 +168,3 @@ crypto.createHash("sha256").update(string).digest("base64");
 exports.sha256 = sha256;
 const toConstantCase = (string) => (0, lodash_1.upperCase)(string).replace(/ /g, "_");
 exports.toConstantCase = toConstantCase;
-const openUrlInBrowser = async (url, queryParameters = {}) => {
-    const u = new URL(url);
-    for (const [key, value] of Object.entries(queryParameters)) {
-        u.searchParams.append(key, value);
-    }
-    const urlString = u.toString();
-    const { debug } = getLogger();
-    debug(`open browser at ${urlString}`);
-    await (0, open_1.default)(urlString);
-};
-exports.openUrlInBrowser = openUrlInBrowser;