@sap/cli-core 2023.25.0 → 2024.2.0

package/CHANGELOG.md

@@ -5,6 +5,18 @@ 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.2.0
+
+### Changed
+
+- The required version of `npm` changes from `^9` to `^10`.
+
+## 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

package/README.md

@@ -2,7 +2,7 @@
 
 Command-Line Interface (CLI) Core Module.
 
-[![Node Version](https://img.shields.io/badge/node-18.15.0-brightgreen)](https://nodejs.org/dist/latest-v18.x/docs/api/#) [![npm version](https://badge.fury.io/js/@sap%2Fcli-core.svg)](https://badge.fury.io/js/@sap%2Fcli-core)
+[![Node Version](https://img.shields.io/badge/node-20.10.0-brightgreen)](https://nodejs.org/dist/latest-v20.x/docs/api/#) [![npm version](https://badge.fury.io/js/@sap%2Fcli-core.svg)](https://badge.fury.io/js/@sap%2Fcli-core)
 
 ## Content
 

package/commands/login.command.js

@@ -9,6 +9,7 @@ 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();
@@ -50,7 +51,11 @@ const loginCommand = {
         { ...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 },
+        {
+            ...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/constants.d.ts

@@ -5,7 +5,6 @@ export declare enum AuthenticationMethod {
     oauth = "oauth",
     passcode = "passcode"
 }
-export declare const DEFAULT_BROWSER = "browser";
 export declare const CLI_NAME = "cli-name";
 export declare const CLI_PACKAGE_NAME = "cli-package-name";
 export declare const CLI_DESCRIPTION = "cli-description";

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_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.DEFAULT_BROWSER = 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)();
@@ -13,7 +13,6 @@ var AuthenticationMethod;
     AuthenticationMethod["oauth"] = "oauth";
     AuthenticationMethod["passcode"] = "passcode";
 })(AuthenticationMethod || (exports.AuthenticationMethod = AuthenticationMethod = {}));
-exports.DEFAULT_BROWSER = "browser";
 exports.CLI_NAME = "cli-name";
 exports.CLI_PACKAGE_NAME = "cli-package-name";
 exports.CLI_DESCRIPTION = "cli-description";

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@sap/cli-core",
-  "version": "2023.25.0",
+  "version": "2024.2.0",
   "description": "Command-Line Interface (CLI) Core Module",
   "license": "SEE LICENSE IN LICENSE",
   "author": "SAP SE",
   "homepage": "https://www.sap.com",
   "main": "index.js",
   "engines": {
-    "node": "^18",
-    "npm": "^9"
+    "node": "^20",
+    "npm": "^10"
   },
   "keywords": [
     "cli",
@@ -18,12 +18,12 @@
   ],
   "dependencies": {
     "ajv": "8.12.0",
-    "axios": "1.6.0",
+    "axios": "1.6.2",
     "commander": "11.1.0",
     "compare-versions": "6.1.0",
     "config": "3.3.9",
     "dotenv": "16.3.1",
-    "fs-extra": "11.1.1",
+    "fs-extra": "11.2.0",
     "https": "1.0.0",
     "https-proxy-agent": "7.0.2",
     "lodash": "4.17.21",

package/types.d.ts

@@ -140,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/openUtils.d.ts

@@ -1,3 +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

@@ -1,16 +1,51 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+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 = void 0;
-const open_1 = __importDefault(require("open"));
+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 = (0, options_1.getOptionValueFromConfig)(constants_1.OPTION_BROWSER, constants_1.DEFAULT_BROWSER);
+    const browser = await getBrowser();
     const u = new URL(url);
     for (const [key, value] of Object.entries(queryParameters)) {
         u.searchParams.append(key, value);