@sap/cli-core 2024.9.0 → 2024.12.0

package/dwc/dwc.js

@@ -43,9 +43,9 @@ const setTenant = async () => {
     if (config.host) {
         return;
     }
-    const readHostFromArgv = async () => (0, utils_1.getOptionValueFromArgv)(constants_1.ROOT_COMMAND_NAME, constants_1.OPTION_HOST);
+    const readHostFromArgv = async () => (0, utils_1.getOptionValueFromArgv)(constants_1.ROOT_COMMAND, constants_1.OPTION_HOST);
     const readHostFromOptionsFile = async () => {
-        const filePath = (0, utils_1.getOptionValueFromArgv)(constants_1.ROOT_COMMAND_NAME, constants_1.OPTION_OPTIONS_FILE);
+        const filePath = (0, utils_1.getOptionValueFromArgv)(constants_1.ROOT_COMMAND, constants_1.OPTION_OPTIONS_FILE);
         return (0, utils_2.getValueFromOptionsFile)(filePath, constants_1.OPTION_HOST);
     };
     const readHostFromOptions = async () => {
@@ -100,7 +100,7 @@ const initCacheTolerant = async () => {
     }
 };
 const registerMandatoryOptions = () => {
-    MANDATORY_OPTIONS.forEach((option) => (0, commands_1.registerLongName)(constants_1.ROOT_COMMAND_NAME, option));
+    MANDATORY_OPTIONS.forEach((option) => (0, commands_1.registerLongName)(constants_1.ROOT_COMMAND, option));
 };
 async function setupSecretsStorage() {
     const instance = new SecretsStorageImpl_1.SecretsStorageImpl();
@@ -129,8 +129,8 @@ const init = async () => {
         ` config host set "<Server_URL>". Did you initialize the CLI by running ${cliName} config` +
         ` cache init --host "<Server_URL>"?` +
         ` Add option --help, -h or go to ${(0, config_1.get)()[constants_1.CLI_SAP_HELP]} for additional information.`);
-    program.addOption(await (0, commands_1.buildOption)(constants_1.ROOT_COMMAND_NAME, constants_1.OPTION_HOST));
-    program.addOption(await (0, commands_1.buildOption)(constants_1.ROOT_COMMAND_NAME, constants_1.OPTION_OPTIONS_FILE));
+    program.addOption(await (0, commands_1.buildOption)(constants_1.ROOT_COMMAND, constants_1.OPTION_HOST));
+    program.addOption(await (0, commands_1.buildOption)(constants_1.ROOT_COMMAND, constants_1.OPTION_OPTIONS_FILE));
     program.configureHelp({ sortSubcommands: true });
     program.addHelpText("afterAll", `Only command-specific options are listed here. To learn more about available generic options,` +
         ` visit ${(0, core_1.getGenericOptionsHelp)()}`);

package/dwc/run.js

@@ -26,7 +26,7 @@ const run = async () => {
     finally {
         await (0, utils_1.compareEtags)();
         if ((0, core_1.isDeprecated)()) {
-            const message = (0, core_1.getDeprecationMessage)() ||
+            const message = (0, core_1.getDeprecationMessage)() ??
                 "WARNING: This package has been deprecated. Please consult the README or CHANGELOG for more information.";
             output(message);
         }

package/dwc/utils.d.ts

@@ -4,4 +4,4 @@ export declare const addCommandsFromFolder: (pathToFolder: string, program: Comm
 export declare function verifyNodeVersion(): void;
 export declare const checkVersion: () => Promise<void>;
 export declare const compareEtags: () => Promise<void>;
-export declare const getOptionValueFromArgv: (commandName: string, option: Option) => string;
+export declare const getOptionValueFromArgv: (command: Command, option: Option) => string;

package/dwc/utils.js

@@ -20,11 +20,11 @@ const addCommandsFromFolder = async (pathToFolder, program) => {
         withFileTypes: false,
     })).filter((f) => f.includes(".command") && !f.endsWith(".d.ts"))) {
         try {
-            // eslint-disable-next-line
+            // eslint-disable-next-line import/no-dynamic-require, global-require, @typescript-eslint/no-var-requires
             const content = require(path_1.default.join(pathToFolder, file));
             if (content.addCommands) {
                 debug("adding commands from file %s.addCommands", file);
-                // eslint-disable-next-line
+                // eslint-disable-next-line no-await-in-loop
                 await content.addCommands(program);
             }
             else {
@@ -69,8 +69,8 @@ const compareEtags = async () => {
     }
 };
 exports.compareEtags = compareEtags;
-const getOptionValueFromArgv = (commandName, option) => {
-    const shortFlag = (0, commands_1.getShortFlagForLongName)(commandName, option);
+const getOptionValueFromArgv = (command, option) => {
+    const shortFlag = (0, commands_1.getShortFlagForLongName)(command, option);
     const index = process.argv.findIndex((a) => a === `-${shortFlag}` || a === `--${option.longName}`);
     if (index > -1) {
         return process.argv[index + 1];

package/index.d.ts

@@ -9,9 +9,9 @@ export declare const configureCoreModule: ({ name, packageName, discoveryPaths,
     discoveryPaths: Array<string>;
     description: string;
     sapHelpLink: string;
-    authenticationMethods?: AuthenticationMethod[] | undefined;
+    authenticationMethods?: Array<AuthenticationMethod>;
     version: string;
     genericOptionsHelp: string;
-    deprecated?: boolean | undefined;
-    deprecationMessage?: string | undefined;
+    deprecated?: boolean;
+    deprecationMessage?: string;
 }) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap/cli-core",
-  "version": "2024.9.0",
+  "version": "2024.12.0",
   "description": "Command-Line Interface (CLI) Core Module",
   "license": "SEE LICENSE IN LICENSE",
   "author": "SAP SE",
@@ -17,9 +17,9 @@
     "cli-core"
   ],
   "dependencies": {
-    "ajv": "8.12.0",
-    "axios": "1.6.8",
-    "commander": "11.1.0",
+    "ajv": "8.13.0",
+    "axios": "1.7.1",
+    "commander": "12.1.0",
     "compare-versions": "6.1.0",
     "config": "3.3.11",
     "dotenv": "16.4.5",
@@ -30,6 +30,6 @@
     "open": "8.4.2",
     "path": "0.12.7",
     "prompts": "2.4.2",
-    "qs": "6.12.0"
+    "qs": "6.12.1"
   }
 }

package/schemas/discovery.json

@@ -93,9 +93,21 @@
                 "description": {
                   "type": "string"
                 },
-                "x-requestbody-fileonly": {
+                "deprecated": {
                   "type": "boolean"
                 },
+                "x-deprecated-with-wave": {
+                  "type": "string"
+                },
+                "x-decommissioned-after-wave": {
+                  "type": "string"
+                },
+                "x-deprecation-new-command": {
+                  "type": "string"
+                },
+                "x-deprecation-sap-help-url": {
+                  "type": "string"
+                },
                 "x-user-to-confirm": {
                   "type": "string"
                 },

package/types.d.ts

@@ -17,6 +17,7 @@ export type Secret = {
     scope: string;
     id_token: string;
 };
+export declare const ALLOWED_SECRET_TYPES: string[];
 export { HTTPMethod, HTTPConfig, HTTPResponse };
 export type In = "query" | "body" | "header" | "path";
 export type DataType = "boolean" | "string" | "number";
@@ -76,6 +77,11 @@ export type Operation = {
     parameters?: Array<JSONReference | Parameter>;
     summary?: string;
     description?: string;
+    deprecated?: boolean;
+    "x-deprecation-new-command"?: string;
+    "x-deprecated-with-wave"?: string;
+    "x-decommissioned-after-wave"?: string;
+    "x-deprecation-sap-help-url"?: string;
     "x-requestbody-fileonly"?: boolean;
     "x-user-to-confirm"?: string;
     "x-read-path"?: string;
@@ -136,6 +142,7 @@ export type PackageJson = {
 export type DiscoveryMetadata = {
     tenant: string;
     addedAt: number;
+    hash: string;
 };
 export type KeyValuePair = {
     [key: string]: any;
@@ -144,7 +151,6 @@ export type DefaultFunction = () => Promise<string>;
 export type ChoicesFunction = () => Promise<Array<string>>;
 export type Choices = Array<string>;
 export type Option = {
-    commandName?: string;
     longName: string;
     description: string;
     default?: string | DefaultFunction;
@@ -185,9 +191,23 @@ export type LeafCommand = {
     command: string;
     description: string;
     options?: Array<Option>;
+    deprecationInfo?: {
+        deprecated: boolean;
+        newCommand?: string;
+        deprecatedWithWave?: string;
+        decommissionedAfterWave?: string;
+        sapHelpUrl?: string;
+    };
     args?: Array<CommandsArgument>;
     handler: Handler;
 };
+export type DeprecatedProperties = Array<{
+    name: string;
+    deprecatedWithWave?: string;
+    decommissionedAfterWave?: string;
+    sapHelpUrl?: string;
+    customMessage?: string;
+}>;
 export type Command = TopCommand | LeafCommand;
 export type AddCommands = (program: CommandType) => Promise<void>;
 export type ResponsePostProcessor = (response: HTTPResponse) => Promise<void>;

package/types.js

@@ -1,6 +1,26 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CHARACTERS = exports.LogLevel = void 0;
+exports.CHARACTERS = exports.LogLevel = exports.ALLOWED_SECRET_TYPES = void 0;
+// unfortunately there does not seem to be a good solution to automatically
+// create the below array from a statically defined type. Thus, the array must
+// always be kept in sync with the type Secret defined above.
+exports.ALLOWED_SECRET_TYPES = [
+    "id",
+    "tenantUrl",
+    "customClient",
+    "client_id",
+    "client_secret",
+    "access_token",
+    "expires_in",
+    "expires_after",
+    "refresh_token",
+    "token_url",
+    "authorization_url",
+    "token_type",
+    "jti",
+    "scope",
+    "id_token",
+];
 var LogLevel;
 (function (LogLevel) {
     LogLevel[LogLevel["INACTIVE"] = 1] = "INACTIVE";

package/utils/commands.d.ts

@@ -1,9 +1,9 @@
 import commander, { Command, Option } from "commander";
 import { Command as CommandType, Option as OptionType } from "../types";
 export declare const createCommand: (name?: string) => Command;
-export declare function getCommandNameForShortFlag(commandName: string, option: OptionType): string;
-export declare const getShortFlagForLongName: (commandName: string, option: OptionType) => string;
+export declare function getAbsoluteCommandName(command: Command): string;
+export declare const getShortFlagForLongName: (command: Command, option: OptionType) => string;
 export declare const isOptionAlreadyRegistered: ({ longName }: OptionType, command: Command) => boolean;
-export declare const registerLongName: (commandName: string, option: OptionType) => string;
-export declare const buildOption: (commandName: string, option: OptionType) => Promise<Option>;
+export declare const registerLongName: (command: Command, option: OptionType) => string;
+export declare const buildOption: (command: Command, option: OptionType) => Promise<Option>;
 export declare const buildCommand: (topCommand: commander.Command, command: CommandType) => Promise<commander.Command>;

package/utils/commands.js

@@ -1,7 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildCommand = exports.buildOption = exports.registerLongName = exports.isOptionAlreadyRegistered = exports.getShortFlagForLongName = exports.getCommandNameForShortFlag = exports.createCommand = void 0;
+exports.buildCommand = exports.buildOption = exports.registerLongName = exports.isOptionAlreadyRegistered = exports.getShortFlagForLongName = exports.getAbsoluteCommandName = exports.createCommand = void 0;
 const commander_1 = require("commander");
+const lodash_1 = __importDefault(require("lodash"));
 const types_1 = require("../types");
 const root_1 = require("../commands/handler/root");
 const logger_1 = require("../logger");
@@ -34,18 +38,21 @@ const createCommand = (name) => {
     return command;
 };
 exports.createCommand = createCommand;
-function getCommandNameForShortFlag(commandName, option) {
-    return option.commandName ?? commandName;
+function getAbsoluteCommandName(command) {
+    if (!command.parent) {
+        return command.name();
+    }
+    return `${getAbsoluteCommandName(command.parent)}.${command.name()}`;
 }
-exports.getCommandNameForShortFlag = getCommandNameForShortFlag;
-const getShortFlagForLongName = (commandName, option) => {
-    const cName = getCommandNameForShortFlag(commandName, option);
-    for (const s of Object.keys(registeredOptions[cName] ?? {})) {
-        if (registeredOptions[cName][s] === option.longName) {
+exports.getAbsoluteCommandName = getAbsoluteCommandName;
+const getShortFlagForLongName = (command, option) => {
+    const commandName = getAbsoluteCommandName(command);
+    for (const s of Object.keys(registeredOptions[commandName] ?? {})) {
+        if (registeredOptions[commandName][s] === option.longName) {
             return s;
         }
     }
-    throw new Error(`no short flag registered for command ${cName}, long name ${option.longName}`);
+    throw new Error(`no short flag registered for command ${commandName}, long name ${option.longName}`);
 };
 exports.getShortFlagForLongName = getShortFlagForLongName;
 const isOptionAlreadyRegistered = ({ longName }, command) => {
@@ -53,32 +60,60 @@ const isOptionAlreadyRegistered = ({ longName }, command) => {
     return !!opts?.includes(longName);
 };
 exports.isOptionAlreadyRegistered = isOptionAlreadyRegistered;
-const registerLongName = (commandName, option) => {
-    const cName = getCommandNameForShortFlag(commandName, option);
+function shortFlagFromAnyCommand(optionLongName) {
+    let shortFlag;
+    Object.keys(registeredOptions).find((c) => {
+        shortFlag = Object.entries(registeredOptions[c]).find(([_command, longName]) => optionLongName === longName)?.[0];
+        return !!shortFlag;
+    });
+    return shortFlag;
+}
+function removeUsedShortFlags(possibleShortFlags) {
+    const usedShortFlags = lodash_1.default.uniq(Object.keys(registeredOptions).reduce((p1, c1) => {
+        return p1.concat(Object.keys(registeredOptions[c1]));
+    }, []));
+    return possibleShortFlags.filter((s) => !usedShortFlags.includes(s));
+}
+const getInitialShortFlagOptions = (option) => {
+    return [
+        option.longName[0],
+        option.longName[0].toUpperCase() === option.longName[0]
+            ? option.longName[0].toLowerCase()
+            : option.longName[0].toUpperCase(),
+        ...types_1.CHARACTERS,
+    ];
+};
+const registerLongName = (command, option) => {
     try {
-        return (0, exports.getShortFlagForLongName)(cName, option);
+        return (0, exports.getShortFlagForLongName)(command, option);
     }
     catch (err) {
-        for (const c of [
-            option.longName[0],
-            option.longName[0].toUpperCase() === option.longName[0]
-                ? option.longName[0].toLowerCase()
-                : option.longName[0].toUpperCase(),
-            ...types_1.CHARACTERS,
-        ]) {
-            if (!registeredOptions[cName]?.[c]) {
-                registeredOptions[cName] = registeredOptions[cName] ?? {};
-                registeredOptions[cName][c] = option.longName;
+        let possibleShortFlags = getInitialShortFlagOptions(option);
+        possibleShortFlags = removeUsedShortFlags(possibleShortFlags);
+        if (possibleShortFlags.length === 0) {
+            // no short flag is left (possibleShortFlags.length === 0),
+            // fall back to the initial set of options
+            possibleShortFlags = getInitialShortFlagOptions(option);
+        }
+        const alreadyUsedShortFlag = shortFlagFromAnyCommand(option.longName);
+        if (alreadyUsedShortFlag) {
+            possibleShortFlags.unshift(alreadyUsedShortFlag);
+        }
+        const commandName = getAbsoluteCommandName(command);
+        for (const c of possibleShortFlags) {
+            if (!registeredOptions[commandName]?.[c]) {
+                registeredOptions[commandName] = registeredOptions[commandName] ?? {};
+                registeredOptions[commandName][c] = option.longName;
                 return c;
             }
         }
-        throw new Error(`no short flag found for name ${option.longName}, command ${cName}`);
+        throw new Error(`no short flag found for name ${option.longName}, command ${commandName}`);
     }
 };
 exports.registerLongName = registerLongName;
-const buildOption = async (commandName, option) => {
+const buildOption = async (command, option) => {
     const mandatory = !!option.required;
-    const shortFlag = (0, exports.registerLongName)(commandName, option);
+    const shortFlag = (0, exports.registerLongName)(command, option);
     let newDescr = option.description;
     if (!mandatory) {
         newDescr = newDescr ? `${newDescr} (optional)` : "(optional)";
@@ -114,11 +149,12 @@ const buildCommand = async (topCommand, command) => {
         .forEach((c) => checkCommand(c));
     const { command: name, description, options } = command;
     const comm = (0, exports.createCommand)(name);
+    topCommand.addCommand(comm);
     comm.description(description);
     comm.enablePositionalOptions();
     for (const option of options ?? []) {
         // eslint-disable-next-line no-await-in-loop
-        comm.addOption(await (0, exports.buildOption)(name, option));
+        comm.addOption(await (0, exports.buildOption)(comm, option));
     }
     if (command.type === "topCommand") {
         const { subCommands } = command;
@@ -129,14 +165,13 @@ const buildCommand = async (topCommand, command) => {
     }
     else {
         // command.type === "command"
-        const { args, handler } = command;
+        const { args } = command;
         if (args) {
             args.forEach((a) => comm.argument(`<${a.argument}>`, a.description));
         }
-        const rootHandler = await (0, root_1.create)(handler, `Failed to ${command.description}`)(comm);
+        const rootHandler = await (0, root_1.create)(command, `Failed to ${command.description}`)(comm);
         comm.action(rootHandler);
     }
-    topCommand.addCommand(comm);
     return comm;
 };
 exports.buildCommand = buildCommand;

package/utils/http/index.js

@@ -11,6 +11,7 @@ const logger_1 = require("../../logger");
 const constants_1 = require("../../constants");
 const utils_1 = require("./utils");
 const core_1 = require("../../config/core");
+const utils_2 = require("../../logger/utils");
 exports.DEFAULTS = {
     maxBodyLength: -1,
     maxContentLength: -1,
@@ -34,11 +35,10 @@ const getCsrfTokenFromConfig = () => {
 };
 const fetch = async (config) => {
     const cnfg = (0, config_1.get)();
-    const { debug, trace, error, output } = getLogger();
+    const logger = getLogger();
+    const { debug, output, trace, error } = logger;
     try {
-        if (cnfg.verbose) {
-            output("%s %s", config.method.toUpperCase(), config.url);
-        }
+        (0, utils_2.logVerbose)(logger, "%s %s", config.method.toUpperCase(), config.url);
         debug("http config: %s", JSON.stringify(config));
         const httpsAgent = HTTPS_PROXY ? new https_proxy_agent_1.HttpsProxyAgent(HTTPS_PROXY) : null;
         if (httpsAgent && cnfg.verbose) {
@@ -60,7 +60,7 @@ const fetch = async (config) => {
             },
         });
         if (cnfg.verbose) {
-            output("%d %s", res.status, res.statusText);
+            (0, utils_2.logVerbose)(logger, "%d %s", res.status, res.statusText);
             (0, utils_1.printCorrelationId)(res);
         }
         trace("response", res);

package/utils/utils.d.ts

@@ -1,5 +1,6 @@
+import { Command } from "commander";
 import { Option, PackageJson } from "../types";
-export declare function buildOptionName(commandName: string, option: Option): string;
+export declare function buildOptionName(command: Command, option: Option): string;
 export declare const parseVersion: (version: string) => {
     major: number;
     minor: number;

package/utils/utils.js

@@ -35,8 +35,8 @@ const commands_1 = require("./commands");
 let pgk;
 const getLogger = () => (0, logger_1.get)("utils.utils");
 const REGEX_HTTPS = /http(s)*:\/\//;
-function buildOptionName(commandName, option) {
-    const shortFlag = (0, commands_1.getShortFlagForLongName)(commandName, option);
+function buildOptionName(command, option) {
+    const shortFlag = (0, commands_1.getShortFlagForLongName)(command, option);
     return `-${shortFlag}, --${option.longName}`;
 }
 exports.buildOptionName = buildOptionName;