@sap/cli-core 2023.14.0 → 2023.18.0

package/dwc/dwc.js

@@ -8,7 +8,6 @@ if (process.env.SUPPRESS_NO_CONFIG_WARNING === undefined) {
     process.env.SUPPRESS_NO_CONFIG_WARNING = "true";
 }
 const path_1 = __importDefault(require("path"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
 const logger_1 = require("../logger");
 const constants_1 = require("../constants");
 const cache_1 = require("../cache");
@@ -21,6 +20,8 @@ const utils_2 = require("../commands/handler/options/utils");
 const core_1 = require("../config/core");
 const ResultHandlerImpl_1 = require("../result/ResultHandlerImpl");
 const ResultHandlerFactory_1 = require("../result/ResultHandlerFactory");
+const SecretsStorageImpl_1 = require("../cache/secrets/SecretsStorageImpl");
+const SecretsStorageSingleton_1 = require("../cache/secrets/SecretsStorageSingleton");
 let program;
 let initialized = false;
 const getLogger = () => (0, logger_1.get)("dwc.dwc");
@@ -95,8 +96,13 @@ const initCacheTolerant = async () => {
 const registerMandatoryOptions = () => {
     MANDATORY_OPTIONS.forEach((option) => (0, commands_1.registerLongName)(option.longName));
 };
+async function setupSecretsStorage() {
+    const instance = new SecretsStorageImpl_1.SecretsStorageImpl();
+    await instance.initializeStorage();
+    SecretsStorageSingleton_1.SecretsStorageSingleton.SINGLETON = instance;
+}
 const init = async () => {
-    const { error, debug } = getLogger();
+    const { debug } = getLogger();
     if (initialized) {
         return;
     }
@@ -107,36 +113,19 @@ const init = async () => {
     await setHost();
     await setTenant();
     await initCacheTolerant();
+    await setupSecretsStorage();
     program = (0, commands_1.createCommand)();
     program.version((0, core_1.getVersion)(), "-v, --version", "output the current version");
     program.description((0, config_1.get)()[constants_1.CLI_DESCRIPTION]);
-    program.showHelpAfterError(`Did you initialize the CLI by running ${(0, config_1.get)()[constants_1.CLI_NAME]} cache init -H "<Server_URL>"?` +
+    program.showHelpAfterError(`Did you initialize the CLI by running ${(0, config_1.get)()[constants_1.CLI_NAME]} config cache init --host "<Server_URL>"?` +
         ` Add --help, -h or go to ${(0, config_1.get)()[constants_1.CLI_SAP_HELP]} for additional information.`);
-    program.addOption((0, commands_1.buildOption)(constants_1.OPTION_HOST));
-    program.addOption((0, commands_1.buildOption)(constants_1.OPTION_OPTIONS_FILE));
+    program.addOption(await (0, commands_1.buildOption)(constants_1.OPTION_HOST));
+    program.addOption(await (0, commands_1.buildOption)(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)()}`);
     const commandsPath = path_1.default.join(__dirname, "..", "commands");
-    for (const file of (await fs_extra_1.default.readdir(commandsPath, {
-        encoding: "utf-8",
-        withFileTypes: false,
-    })).filter((f) => f.includes(".command") && !f.endsWith(".d.ts"))) {
-        try {
-            // eslint-disable-next-line
-            const content = require(path_1.default.join(commandsPath, file));
-            if (content.addCommands) {
-                debug("adding commands from file %s.addCommands", file);
-                // eslint-disable-next-line
-                await content.addCommands(program);
-            }
-            else {
-                debug("adding command from file %s.default", file);
-                (0, commands_1.buildCommand)(program, content.default);
-            }
-        }
-        catch (err) {
-            error("error while adding command from file %s:", file, err.stack);
-        }
-    }
+    await (0, utils_1.addCommandsFromFolder)(commandsPath, program);
     debug("cli initialized");
 };
 exports.init = init;

package/dwc/run.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.run = void 0;
+const SecretsStorageSingleton_1 = require("../cache/secrets/SecretsStorageSingleton");
 const core_1 = require("../config/core");
 const logger_1 = require("../logger");
 const dwc_1 = require("./dwc");
@@ -29,6 +30,7 @@ const run = async () => {
                 "WARNING: This package has been deprecated. Please consult the README or CHANGELOG for more information.";
             output(message);
         }
+        await SecretsStorageSingleton_1.SecretsStorageSingleton.SINGLETON.synchronizeSecretsToStorage();
         if (exitCode > 0) {
             process.exit(exitCode);
         }

package/dwc/utils.d.ts

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

package/dwc/utils.js

@@ -1,11 +1,43 @@
 "use strict";
+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 = void 0;
+exports.getOptionValueFromArgv = exports.compareEtags = exports.checkVersion = exports.addCommandsFromFolder = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
 const logger_1 = require("../logger");
 const discovery_1 = require("../discovery");
 const commands_1 = require("../utils/commands");
 const core_1 = require("../config/core");
+const utils_1 = require("../utils/utils");
 const getLogger = () => (0, logger_1.get)("dwc.utils");
+const addCommandsFromFolder = async (pathToFolder, program) => {
+    const { error, debug } = getLogger();
+    for (const file of (await fs_extra_1.default.readdir(pathToFolder, {
+        encoding: "utf-8",
+        withFileTypes: false,
+    })).filter((f) => f.includes(".command") && !f.endsWith(".d.ts"))) {
+        try {
+            // eslint-disable-next-line
+            const content = require(path_1.default.join(pathToFolder, file));
+            if (content.addCommands) {
+                debug("adding commands from file %s.addCommands", file);
+                // eslint-disable-next-line
+                await content.addCommands(program);
+            }
+            else {
+                debug("adding command from file %s.default", file);
+                // eslint-disable-next-line no-await-in-loop
+                await (0, commands_1.buildCommand)(program, content.default);
+            }
+        }
+        catch (err) {
+            error("error while adding command from file %s:", file, err.stack);
+        }
+    }
+};
+exports.addCommandsFromFolder = addCommandsFromFolder;
 const checkVersion = async () => {
     const { output, error } = getLogger();
     try {
@@ -22,7 +54,7 @@ exports.checkVersion = checkVersion;
 const compareEtags = async () => {
     if (!(await (0, discovery_1.compareEtags)())) {
         const { output } = getLogger();
-        output(`Your local CLI cache is outdated. Run 'dwc cache init' to update`);
+        output(`Your local CLI cache is outdated. Run '${(0, utils_1.getBin)()} config cache init' to update`);
     }
 };
 exports.compareEtags = compareEtags;

package/index.d.ts

@@ -3,7 +3,7 @@ export { run } from "./dwc/run";
 export { configure, getCommands } from "./module";
 export { AuthenticationMethod };
 export { getVersion, getBin, getDescription, getName, getPackageName, } from "./utils/utils";
-export declare const configureCoreModule: ({ name, packageName, discoveryPath, description, sapHelpLink, authenticationMethods, version, deprecated, deprecationMessage, }: {
+export declare const configureCoreModule: ({ name, packageName, discoveryPath, description, sapHelpLink, authenticationMethods, version, genericOptionsHelp, deprecated, deprecationMessage, }: {
     name: string;
     packageName: string;
     discoveryPath: string;
@@ -11,6 +11,7 @@ export declare const configureCoreModule: ({ name, packageName, discoveryPath, d
     sapHelpLink: string;
     authenticationMethods?: AuthenticationMethod[] | undefined;
     version: string;
+    genericOptionsHelp: string;
     deprecated?: boolean | undefined;
     deprecationMessage?: string | undefined;
 }) => void;

package/index.js

@@ -30,8 +30,10 @@ const configureLoggers_1 = require("./configureLoggers");
 dotenv.config();
 (0, configureLoggers_1.configureLoggers)();
 const config_1 = require("./config");
+/* jscpd:ignore-start */
 const constants_1 = require("./constants");
 Object.defineProperty(exports, "AuthenticationMethod", { enumerable: true, get: function () { return constants_1.AuthenticationMethod; } });
+/* jscpd:ignore-end */
 var run_1 = require("./dwc/run");
 Object.defineProperty(exports, "run", { enumerable: true, get: function () { return run_1.run; } });
 var module_1 = require("./module");
@@ -43,7 +45,7 @@ Object.defineProperty(exports, "getBin", { enumerable: true, get: function () {
 Object.defineProperty(exports, "getDescription", { enumerable: true, get: function () { return utils_1.getDescription; } });
 Object.defineProperty(exports, "getName", { enumerable: true, get: function () { return utils_1.getName; } });
 Object.defineProperty(exports, "getPackageName", { enumerable: true, get: function () { return utils_1.getPackageName; } });
-const configureCoreModule = ({ name, packageName, discoveryPath, description, sapHelpLink, authenticationMethods = [constants_1.AuthenticationMethod.oauth], version, deprecated = false, deprecationMessage, }) => {
+const configureCoreModule = ({ name, packageName, discoveryPath, description, sapHelpLink, authenticationMethods = [constants_1.AuthenticationMethod.oauth], version, genericOptionsHelp, deprecated = false, deprecationMessage, }) => {
     (0, config_1.set)({
         [constants_1.CLI_NAME]: name,
         [constants_1.CLI_PACKAGE_NAME]: packageName,
@@ -54,6 +56,7 @@ const configureCoreModule = ({ name, packageName, discoveryPath, description, sa
         [constants_1.CLI_VERSION]: version,
         [constants_1.CLI_DEPRECATED]: deprecated,
         [constants_1.CLI_DEPRECATION_MESSAGE]: deprecationMessage,
+        [constants_1.CLI_GENERIC_OPTIONS_HELP]: genericOptionsHelp,
     });
 };
 exports.configureCoreModule = configureCoreModule;

package/logger/index.d.ts

@@ -1,14 +1,5 @@
 import { LogLevel } from "../types";
-type Method = (...args: Array<any>) => void;
-export type Logger = {
-    output: Method;
-    error: Method;
-    warn: Method;
-    info: Method;
-    log: Method;
-    debug: Method;
-    trace: Method;
-};
+import { Logger, Method } from "./types";
 type CustomLogger = {
     output?: Method;
     error?: Method;

package/logger/types.d.ts

@@ -0,0 +1,10 @@
+export type Method = (...args: Array<any>) => void;
+export type Logger = {
+    output: Method;
+    error: Method;
+    warn: Method;
+    info: Method;
+    log: Method;
+    debug: Method;
+    trace: Method;
+};

package/logger/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/logger/utils.d.ts

@@ -0,0 +1,2 @@
+import { Logger } from "./types";
+export declare const logVerbose: (logger: Logger, ...args: Array<any>) => void;

package/logger/utils.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logVerbose = void 0;
+const constants_1 = require("../constants");
+const options_1 = require("../utils/options");
+const logVerbose = (logger, ...args) => {
+    const verbose = (0, options_1.getOptionValueFromConfigGracefully)(constants_1.OPTION_VERBOSE);
+    if (verbose) {
+        logger.output(...args);
+    }
+};
+exports.logVerbose = logVerbose;

package/package.json

@@ -1,26 +1,27 @@
 {
   "name": "@sap/cli-core",
-  "version": "2023.14.0",
+  "version": "2023.18.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": "^16",
-    "npm": "^8"
+    "node": "^18",
+    "npm": "^9"
   },
   "keywords": [
     "cli",
-    "sap data warehouse cloud",
+    "sap",
+    "sap datasphere",
     "cli-core"
   ],
   "dependencies": {
     "ajv": "8.12.0",
     "axios": "1.4.0",
-    "commander": "10.0.1",
+    "commander": "11.0.0",
     "config": "3.3.9",
-    "dotenv": "16.1.3",
+    "dotenv": "16.3.1",
     "fs-extra": "11.1.1",
     "https": "1.0.0",
     "lodash": "4.17.21",

package/result/ResultHandlerFactory.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResultHandlerFactory = void 0;
 class ResultHandlerFactory {
+    static INSTANCE;
     static get() {
         return ResultHandlerFactory.INSTANCE;
     }

package/result/ResultHandlerImpl.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResultHandlerImpl = void 0;
 class ResultHandlerImpl {
+    data;
     setResult(data) {
         this.data = data;
     }

package/types.d.ts

@@ -1,6 +1,9 @@
 import { Method as HTTPMethod, AxiosRequestConfig as HTTPConfig, AxiosResponse as HTTPResponse } from "axios";
 import { Command as CommandType } from "commander";
-export type Secrets = {
+export type Secret = {
+    id: number;
+    tenantUrl: string;
+    customClient: boolean;
     client_id: string;
     client_secret: string;
     access_token: string;
@@ -134,16 +137,19 @@ export type DiscoveryMetadata = {
 export type KeyValuePair = {
     [key: string]: any;
 };
+export type ChoicesFunction = () => Promise<Array<string>>;
+export type Choices = Array<string>;
 export type Option = {
     longName: string;
     description: string;
     default?: string;
     required?: boolean;
-    choices?: Array<string>;
+    choices?: Choices | ChoicesFunction;
     args?: Array<{
         name: string;
         optional?: boolean;
     }>;
+    hidden?: boolean;
     prompts?: {
         initial?: any;
         message: string | (() => string);
@@ -157,7 +163,7 @@ export type HandlerProps = {
     options: KeyValuePair;
 };
 export type CommanderHandler = (...args: any[]) => void | Promise<void>;
-export type Handler = (command: CommandType) => CommanderHandler;
+export type Handler = (command: CommandType) => Promise<CommanderHandler>;
 export type CommandsArgument = {
     argument: string;
     description: string;

package/utils/commands.d.ts

@@ -4,5 +4,5 @@ export declare const createCommand: (name?: string) => Command;
 export declare const getShortFlagForLongName: (longName: string) => string;
 export declare const isOptionAlreadyRegistered: ({ longName }: OptionType, command: Command) => boolean;
 export declare const registerLongName: (longName: string) => string;
-export declare const buildOption: ({ longName, description, choices, required, default: defaultValue, args, }: OptionType) => Option;
-export declare const buildCommand: (topCommand: commander.Command, command: CommandType) => void;
+export declare const buildOption: ({ longName, description, choices, required, default: defaultValue, args, hidden, }: OptionType) => Promise<Option>;
+export declare const buildCommand: (topCommand: commander.Command, command: CommandType) => Promise<commander.Command>;

package/utils/commands.js

@@ -44,9 +44,8 @@ const getShortFlagForLongName = (longName) => {
 };
 exports.getShortFlagForLongName = getShortFlagForLongName;
 const isOptionAlreadyRegistered = ({ longName }, command) => {
-    // @ts-expect-error ts(2551)
-    const opts = command.options.map((o) => o.long.replace("--", ""));
-    return opts.includes(longName);
+    const opts = command.options?.map((o) => o.long?.replace("--", ""));
+    return !!opts?.includes(longName);
 };
 exports.isOptionAlreadyRegistered = isOptionAlreadyRegistered;
 const registerLongName = (longName) => {
@@ -70,7 +69,7 @@ const registerLongName = (longName) => {
     }
 };
 exports.registerLongName = registerLongName;
-const buildOption = ({ longName, description, choices, required, default: defaultValue, args, }) => {
+const buildOption = async ({ longName, description, choices, required, default: defaultValue, args, hidden, }) => {
     const mandatory = !!required;
     const shortFlag = (0, exports.registerLongName)(longName);
     let newDescr = description;
@@ -82,14 +81,19 @@ const buildOption = ({ longName, description, choices, required, default: defaul
         : "";
     const option = new commander_1.Option(`-${shortFlag}, --${longName}${argStr}`, newDescr)
         .makeOptionMandatory(mandatory)
-        .default(defaultValue);
-    if (choices && choices.length > 0) {
-        option.choices(choices);
+        .default(defaultValue)
+        .hideHelp(!!hidden);
+    let choicesArr = [];
+    if (choices) {
+        choicesArr = typeof choices === "function" ? await choices() : choices;
+    }
+    if (choicesArr.length > 0) {
+        option.choices(choicesArr);
     }
     return option;
 };
 exports.buildOption = buildOption;
-const buildCommand = (topCommand, command) => {
+const buildCommand = async (topCommand, command) => {
     []
         .concat([command], command.type === "topCommand" ? command.subCommands : [])
         .forEach((c) => checkCommand(c));
@@ -97,10 +101,16 @@ const buildCommand = (topCommand, command) => {
     const comm = (0, exports.createCommand)(name);
     comm.description(description);
     comm.enablePositionalOptions();
-    options?.forEach((o) => comm.addOption((0, exports.buildOption)(o)));
+    for (const option of options || []) {
+        // eslint-disable-next-line no-await-in-loop
+        comm.addOption(await (0, exports.buildOption)(option));
+    }
     if (command.type === "topCommand") {
         const { subCommands } = command;
-        subCommands.forEach((s) => (0, exports.buildCommand)(comm, s));
+        for (const subCommand of subCommands) {
+            // eslint-disable-next-line no-await-in-loop
+            await (0, exports.buildCommand)(comm, subCommand);
+        }
     }
     else {
         // command.type === "command"
@@ -108,8 +118,10 @@ const buildCommand = (topCommand, command) => {
         if (args) {
             args.forEach((a) => comm.argument(`<${a.argument}>`, a.description));
         }
-        comm.action((0, root_1.create)(handler, `Failed to ${command.description}`)(comm));
+        const rootHandler = await (0, root_1.create)(handler, `Failed to ${command.description}`)(comm);
+        comm.action(rootHandler);
     }
     topCommand.addCommand(comm);
+    return comm;
 };
 exports.buildCommand = buildCommand;

package/utils/http/index.js

@@ -35,7 +35,6 @@ const fetch = async (config) => {
     const { debug, trace, error, output } = getLogger();
     try {
         if (cnfg.verbose) {
-            // eslint-disable-next-line
             output("%s %s", config.method.toUpperCase(), config.url);
         }
         debug("http config: %s", JSON.stringify(config));

package/utils/utils.d.ts

@@ -1,4 +1,5 @@
-import { PackageJson } from "../types";
+import { Option, PackageJson } from "../types";
+export declare function buildOptionName(option: Option): string;
 export declare const parseVersion: (version: string) => {
     major: number;
     minor: number;
@@ -17,7 +18,10 @@ export declare const getInfoFromTenant: (tenant: string, verbose: boolean, print
     publicfqdn: string;
     passcodeUrl: string;
     tenantUrl: string;
+    authorizationUrl: string;
+    tokenUrl: string;
 };
+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?: {

package/utils/utils.js

@@ -26,15 +26,21 @@ 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.getInfoFromTenant = exports.parseTenant = exports.removeScopeFromPackageName = exports.getBin = exports.getDescription = exports.getPackageName = exports.getName = exports.getVersion = exports.readPackageJson = exports.requireFile = exports.parseVersion = void 0;
+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;
 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;
 const getLogger = () => (0, logger_1.get)("utils.utils");
 const REGEX_HTTPS = /http(s)*:\/\//;
+function buildOptionName(option) {
+    const shortFlag = (0, commands_1.getShortFlagForLongName)(option.longName);
+    return `-${shortFlag}, --${option.longName}`;
+}
+exports.buildOptionName = buildOptionName;
 const parseVersion = (version) => {
     const segments = version.split(".");
     return { major: parseInt(segments[0], 10), minor: parseInt(segments[1], 10) };
@@ -94,9 +100,7 @@ const getBin = (cwd = "") => {
     return keys[0];
 };
 exports.getBin = getBin;
-const removeScopeFromPackageName = (packageName) => 
-// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-packageName.split("/").pop();
+const removeScopeFromPackageName = (packageName) => packageName.split("/").pop();
 exports.removeScopeFromPackageName = removeScopeFromPackageName;
 const removeProtocol = (tenant) => tenant.replace(REGEX_HTTPS, "");
 const parseTenant = (tenant) => {
@@ -144,10 +148,17 @@ const getInfoFromTenant = (tenant, verbose, printOutput = true) => {
         host: `${protocol}//dwaas-core.sac${region}.cfapps.orca.net.sap`,
         publicfqdn: parsedTenant,
         passcodeUrl: `https://${hostname}.authentication.${region}.hana.ondemand.com/passcode`,
+        authorizationUrl: `https://${hostname}.authentication.${region}.hana.ondemand.com/oauth/authorize`,
+        tokenUrl: `https://${hostname}.authentication.${region}.hana.ondemand.com/oauth/token`,
         tenantUrl: `${protocol}//${parsedTenant}`,
     };
 };
 exports.getInfoFromTenant = getInfoFromTenant;
+function removeQueryParametersFromUrl(sUrl) {
+    const url = new URL(sUrl);
+    return `${url.protocol}//${url.host}${url.pathname}`;
+}
+exports.removeQueryParametersFromUrl = removeQueryParametersFromUrl;
 const sha256 = (string) => 
 // NOSONAR actually sha256 (or SHA-256) is considered secure according to SonarQube
 crypto.createHash("sha256").update(string).digest("base64");

package/commands/cache.command/init.command.d.ts

@@ -1,3 +0,0 @@
-import { Command } from "../../types";
-declare const initCommand: Command;
-export default initCommand;