@sap/cli-core 2024.8.0 → 2024.12.0

package/commands/handler/fetch/utils.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildHttpConfig = exports.configRequiresBody = exports.handleResponse = exports.handleResponseData = exports.getOutputFileName = exports.buildParameters = exports.removeLeadingPathSegmentForPasscode = exports.checkConfiguration = void 0;
+exports.buildHttpConfig = exports.configRequiresBody = exports.handleResponse = exports.handleResponseHeaders = exports.handleResponseData = exports.checkResponseDataForInvalidLoginData = exports.getOutputFileName = exports.buildParameters = exports.handleParameterMapping = exports.getValueFromMappping = exports.handleMappingIn = exports.removeLeadingPathSegmentForPasscode = exports.checkConfiguration = void 0;
+const os_1 = require("os");
 const url_1 = require("url");
 const lodash_1 = __importDefault(require("lodash"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
@@ -59,8 +60,6 @@ const handleMappingIn = (mapping, url, value, headers, bodyWrapper) => {
         url.pathname = url.pathname.replace(new RegExp(`${CURLY_OPEN_ENCODED}${mapping.name}${CURLY_CLOSED_ENCODED}`, "g"), value);
     }
     else {
-        // NOSONAR
-        // if (mapping.in === "body") {
         if (!bodyWrapper.body) {
             // eslint-disable-next-line no-param-reassign
             bodyWrapper.body = {};
@@ -68,6 +67,7 @@ const handleMappingIn = (mapping, url, value, headers, bodyWrapper) => {
         lodash_1.default.set(bodyWrapper.body, mapping.name, value);
     }
 };
+exports.handleMappingIn = handleMappingIn;
 const getValueFromMappping = (mapping, config) => {
     if (mapping.source.type === "value") {
         return mapping.source.value;
@@ -81,13 +81,15 @@ const getValueFromMappping = (mapping, config) => {
     // mapping.source.type === "option"
     return config.options[mapping.source.name];
 };
+exports.getValueFromMappping = getValueFromMappping;
 const handleParameterMapping = (config, url, headers, bodyWrapper) => (mapping) => {
-    const value = getValueFromMappping(mapping, config);
+    const value = (0, exports.getValueFromMappping)(mapping, config);
     if (value === undefined || value === null) {
         return;
     }
-    handleMappingIn(mapping, url, value, headers, bodyWrapper);
+    (0, exports.handleMappingIn)(mapping, url, value, headers, bodyWrapper);
 };
+exports.handleParameterMapping = handleParameterMapping;
 const buildParameters = (path, parameterMappings) => {
     const config = (0, config_1.get)();
     const headers = {};
@@ -95,7 +97,7 @@ const buildParameters = (path, parameterMappings) => {
         body: config.data,
     };
     const url = getUrl(path);
-    parameterMappings?.forEach(handleParameterMapping(config, url, headers, bodyWrapper));
+    parameterMappings?.forEach((0, exports.handleParameterMapping)(config, url, headers, bodyWrapper));
     return {
         url,
         headers,
@@ -118,7 +120,21 @@ function getOutputFileName(outputPath = "") {
     return config.options[constants_1.OPTION_OUTPUT.longName];
 }
 exports.getOutputFileName = getOutputFileName;
+function checkResponseDataForInvalidLoginData(response) {
+    if (
+    // jira.tools.sap/browse/DW101-73607
+    typeof response === "string" &&
+        response.includes("Please contact your system administrator and ensure you have an active account on this system.")) {
+        const logger = (0, logger_1.get)("checkResponseDataForInvalidLoginData");
+        logger.output("WARNING: You are using an access token which is not known to the tenant. Please check your login credentials.");
+        logger.debug(response);
+        return true;
+    }
+    return false;
+}
+exports.checkResponseDataForInvalidLoginData = checkResponseDataForInvalidLoginData;
 const handleResponseData = async (data, outputPath) => {
+    checkResponseDataForInvalidLoginData(data);
     const config = (0, config_1.get)();
     if (!config.doNotStoreResult) {
         ResultHandlerFactory_1.ResultHandlerFactory.get().setResult(data);
@@ -139,12 +155,48 @@ const handleResponseData = async (data, outputPath) => {
     }
 };
 exports.handleResponseData = handleResponseData;
+function handleResponseHeaders(headers) {
+    const { error, output } = (0, logger_1.get)("handler.fetch.handleResponseHeaders");
+    if (headers[constants_1.X_DSP_API_DEPRECATED_PROPERTIES]) {
+        try {
+            const deprecatedProperties = JSON.parse(headers[constants_1.X_DSP_API_DEPRECATED_PROPERTIES]);
+            const deprecatedPropertiesStr = deprecatedProperties
+                .map((dp) => {
+                let msg = dp.name;
+                if (dp.deprecatedWithWave) {
+                    msg += `. Deprecated since version ${dp.deprecatedWithWave}`;
+                }
+                if (dp.decommissionedAfterWave) {
+                    msg += `. Decommissioned after version ${dp.decommissionedAfterWave}`;
+                }
+                if (dp.sapHelpUrl) {
+                    msg += `. See the SAP Help documentation at ${dp.sapHelpUrl} for more information`;
+                }
+                if (dp.customMessage) {
+                    msg += `. ${dp.customMessage}`;
+                }
+                return msg;
+            })
+                .reduce((prev, curr) => `${prev}${os_1.EOL}\t${curr}`, "");
+            output(`WARNING: the following properties are deprecated:${deprecatedPropertiesStr}`);
+        }
+        catch (err) {
+            error(`failed to parse deprecated properties via header ${constants_1.X_DSP_API_DEPRECATED_PROPERTIES}`, err);
+        }
+    }
+}
+exports.handleResponseHeaders = handleResponseHeaders;
 const handleResponse = async (data, headers) => {
     if (headers?.[constants_1.X_CSRF_TOKEN]) {
         (0, config_1.set)({ [constants_1.X_CSRF_TOKEN]: headers[constants_1.X_CSRF_TOKEN] });
     }
-    else if (data) {
-        await (0, exports.handleResponseData)(data, headers?.[constants_1.X_OUTPUT_FILE_NAME]);
+    else {
+        if (data) {
+            await (0, exports.handleResponseData)(data, headers?.[constants_1.X_OUTPUT_FILE_NAME]);
+        }
+        if (headers) {
+            handleResponseHeaders(headers);
+        }
     }
 };
 exports.handleResponse = handleResponse;

package/commands/handler/input/file.js

@@ -11,10 +11,12 @@ const constants_1 = require("../../../constants");
 const checkOptionsExistence_1 = require("../checkOptionsExistence");
 const next_1 = require("../next");
 const options_1 = require("../options");
+const utils_1 = require("../../../logger/utils");
 const readBodyFromFile = async () => async () => {
     const config = (0, config_1.get)();
     const filePath = config.options[constants_1.OPTION_FILE_PATH.longName];
-    const { debug, trace } = (0, logger_1.get)("commands.handler.input.file");
+    const logger = (0, logger_1.get)("commands.handler.input.file");
+    const { debug, trace } = logger;
     debug("reading request body from %s", filePath);
     try {
         (0, config_1.set)({
@@ -22,10 +24,7 @@ const readBodyFromFile = async () => async () => {
         });
     }
     catch (err) {
-        if (config.verbose) {
-            // eslint-disable-next-line
-            console.log(`Failed to read content from file ${filePath}. Does the file really exist and does it contain valid JSON?`);
-        }
+        (0, utils_1.logVerbose)(logger, `Failed to read content from file ${filePath}. Does the file really exist and does it contain valid JSON?`);
         trace(`Failed to read content from file ${filePath}`, err);
         throw err;
     }

package/commands/handler/input/input.js

@@ -9,11 +9,12 @@ const config_1 = require("../../../config");
 const constants_1 = require("../../../constants");
 const logger_1 = require("../../../logger");
 const commands_1 = require("../../../utils/commands");
+const utils_1 = require("../../../logger/utils");
 const create = () => async (command) => {
-    command.addOption(await (0, commands_1.buildOption)(command.name(), constants_1.OPTION_INPUT));
+    command.addOption(await (0, commands_1.buildOption)(command, constants_1.OPTION_INPUT));
     return async () => {
         const config = (0, config_1.get)();
-        const { debug } = (0, logger_1.get)("handler.input.input");
+        const logger = (0, logger_1.get)("handler.input.input");
         if (config.options[constants_1.OPTION_FILE_PATH.longName]) {
             throw new Error(`input provided through option --${constants_1.OPTION_FILE_PATH.longName}`);
         }
@@ -28,15 +29,12 @@ const create = () => async (command) => {
         if (!input) {
             throw new Error("no input");
         }
-        debug("reading request body from data");
+        logger.debug("reading request body from data");
         try {
             (0, config_1.set)({ data: JSON.parse(input) });
         }
         catch (err) {
-            if (config.verbose) {
-                // eslint-disable-next-line
-                console.log("Failed to parse input data. Is it a valid escaped JSON string?");
-            }
+            (0, utils_1.logVerbose)(logger, "Failed to parse input data. Is it a valid escaped JSON string?");
             throw err;
         }
     };

package/commands/handler/next.js

@@ -16,7 +16,7 @@ const nextHandler = (origin, ...handlers) => async (command) => {
     return async (...args) => {
         getLogger(origin).trace(`next:${origin}: processing handlers`);
         for (const handler of commandHandlers) {
-            // eslint-disable-next-line
+            // eslint-disable-next-line no-await-in-loop
             await handler(...args);
         }
     };

package/commands/handler/options/utils.js

@@ -15,7 +15,7 @@ const checkOptions = async (options, command) => {
         if (!(0, commands_1.isOptionAlreadyRegistered)(option, command)) {
             command.addOption(
             // eslint-disable-next-line no-await-in-loop
-            await (0, commands_1.buildOption)(command.name(), { ...option, required: false }));
+            await (0, commands_1.buildOption)(command, { ...option, required: false }));
         }
     }
 };

package/commands/handler/or.js

@@ -22,7 +22,7 @@ const create = (origin, ...handlers) => {
             for (const handler of commandHandlers) {
                 handlerFailed = false;
                 try {
-                    // eslint-disable-next-line
+                    // eslint-disable-next-line no-await-in-loop
                     await handler(...args);
                     trace(`handler succeeded, exiting loop`);
                     break;

package/commands/handler/root/index.d.ts

@@ -1,2 +1,2 @@
-import { Handler } from "../../../types";
-export declare const create: (handler: Handler, errorMessage?: string) => Handler;
+import { Handler, LeafCommand } from "../../../types";
+export declare const create: (command: LeafCommand, errorMessage?: string) => Handler;

package/commands/handler/root/index.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = void 0;
 const logger_1 = require("../../../logger");
-const create = (handler, errorMessage = "Command failed") => async (command) => {
+const create = (command, errorMessage = "Command failed") => async (cCommand) => {
     const { output } = (0, logger_1.get)("handler.root");
-    const hdlr = await handler(command);
+    const hdlr = await command.handler(cCommand);
     return async (...args) => {
         try {
             await hdlr(...args);
@@ -13,6 +13,26 @@ const create = (handler, errorMessage = "Command failed") => async (command) =>
             output(errorMessage);
             throw err;
         }
+        finally {
+            if (command.deprecationInfo?.deprecated) {
+                let message = `WARNING: The command '${command.command}' is deprecated.`;
+                if (command.deprecationInfo.deprecatedWithWave) {
+                    message =
+                        `WARNING: The command '${command.command}' is deprecated from version ` +
+                            `${command.deprecationInfo.deprecatedWithWave} onwards.`;
+                }
+                if (command.deprecationInfo.decommissionedAfterWave) {
+                    message += ` It will be removed after version ${command.deprecationInfo.decommissionedAfterWave}.`;
+                }
+                if (command.deprecationInfo.newCommand) {
+                    message += ` Please start using the new command '${command.deprecationInfo.newCommand}'.`;
+                }
+                if (command.deprecationInfo.sapHelpUrl) {
+                    message += ` See ${command.deprecationInfo.sapHelpUrl} for more information.`;
+                }
+                output(message);
+            }
+        }
     };
 };
 exports.create = create;

package/commands/login.command.js

@@ -33,7 +33,7 @@ const initializeCache = async () => async () => {
         await (await (0, init_command_1.init)())();
     }
     catch (err) {
-        warn(`option ${(0, utils_3.buildOptionName)(constants_1.ROOT_COMMAND_NAME, constants_1.OPTION_HOST)} not defined, skipping cache init`);
+        warn(`option ${(0, utils_3.buildOptionName)(constants_1.ROOT_COMMAND, constants_1.OPTION_HOST)} not defined, skipping cache init`);
     }
 };
 const loginCommand = {

package/commands/openAPI.command/index.js

@@ -12,7 +12,7 @@ const getCommandDescription = (document, segments, index) => {
     const segment = segments
         .slice(0, index + 1)
         .reduce((prev, curr) => (prev !== "" ? `${prev} ${curr}` : curr), "");
-    return document.tags.find((t) => t.name === segment)?.description || "";
+    return document.tags.find((t) => t.name === segment)?.description ?? "";
 };
 const addCommandToArray = (document, commands, segments, index) => {
     const segment = segments[index];
@@ -44,7 +44,7 @@ const addCommandToArray = (document, commands, segments, index) => {
     return { command, remove: () => commands.splice(commands.length - 1, 1) };
 };
 const setHandler = (command, method, path, parameterMappings, readPathResponseHandler, ...handler) => {
-    // eslint-disable-next-line
+    // eslint-disable-next-line no-param-reassign
     command.handler = (0, handler_1.createNextHandler)("openAPI.command", (0, handler_1.createParseArgumentsHandler)(), (0, handler_1.createMandatoryOptionsHandler)(), (0, handler_1.createAuthenticationHandler)(), ...handler, (0, handler_1.createFetchHandler)(method, path, parameterMappings, readPathResponseHandler));
 };
 const addCommands = async (program) => {
@@ -68,6 +68,7 @@ const addCommands = async (program) => {
                     (0, utils_1.handleForceOption)(operation, handler);
                     (0, utils_1.handleResponses)(operation, command);
                     (0, utils_1.handleParameters)(operation, doc, parameterMappings, command, (0, utils_1.getSchema)(pathItem.parameters || [], doc));
+                    (0, utils_1.handleDeprecationNotice)(operation, command);
                     const readPathResponseHandler = (0, utils_1.handleReadPathHandler)(doc, operation);
                     setHandler(command, method, (0, utils_1.updatePath)(doc, path), parameterMappings, readPathResponseHandler, ...[(0, handler_1.createOptionsHandler)(command.options), ...handler]);
                     delete command.options;

package/commands/openAPI.command/utils.d.ts

@@ -11,9 +11,10 @@ export declare const handleReadPathHandler: (doc: Discovery, operation: Operatio
 export declare const getDescriptionForCommand: (command: Command, operation: Operation) => string;
 export declare const getSchema: <T>(obj: JSONReference | T, doc: Discovery) => T;
 export declare const addOptionToCommand: (option: Option, options: Array<Option>) => void;
-export declare const buildOptionFromType: (doc: Discovery, parameterIn: In, name: string, type: JSONSchema & ExtendedType, parameterMappings: ParameterMappings, options: Array<Option>, description?: string) => void;
+export declare const buildOptionFromType: (commandName: string, doc: Discovery, parameterIn: In, name: string, type: JSONSchema & ExtendedType, parameterMappings: ParameterMappings, options: Array<Option>, description?: string) => void;
 export declare const handleRequestBody: (operation: Operation, handler: Array<Handler>, doc: Discovery, parameterMappings: ParameterMappings, command: Command) => void;
 export declare const handleForceOption: (operation: Operation, handler: Array<Handler>) => void;
 export declare const handleResponses: (operation: Operation, command: Command) => void;
 export declare const handleParameters: (operation: Operation, doc: Discovery, parameterMappings: ParameterMappings, command: Command, topLevelParameters?: Parameters) => void;
+export declare const handleDeprecationNotice: (operation: Operation, command: Command) => void;
 export {};

package/commands/openAPI.command/utils.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleParameters = exports.handleResponses = exports.handleForceOption = exports.handleRequestBody = exports.buildOptionFromType = exports.addOptionToCommand = exports.getSchema = exports.getDescriptionForCommand = exports.handleReadPathHandler = exports.getSegments = exports.writeParameter = exports.isPathParameter = exports.updatePath = void 0;
+exports.handleDeprecationNotice = exports.handleParameters = exports.handleResponses = exports.handleForceOption = exports.handleRequestBody = exports.buildOptionFromType = exports.addOptionToCommand = exports.getSchema = exports.getDescriptionForCommand = exports.handleReadPathHandler = exports.getSegments = exports.writeParameter = exports.isPathParameter = exports.updatePath = void 0;
 const lodash_1 = __importStar(require("lodash"));
 const constants_1 = require("../../constants");
 const logger_1 = require("../../logger");
@@ -221,7 +221,7 @@ const handleOptionName = (name, params, description) => {
         description: newDescription,
     };
 };
-const buildOption = (longName, types, params, description, def) => {
+const buildOption = (commandName, longName, types, params, description, def) => {
     const option = {
         longName,
         required: !types[0].allowEmptyValue && types[0].required,
@@ -246,13 +246,13 @@ const buildOption = (longName, types, params, description, def) => {
     }
     return option;
 };
-const handleOption = (name, params, types, options, description) => {
+const handleOption = (commandName, name, params, types, options, description) => {
     const { optionName, def, description: newDescription, } = handleOptionName(name, params, description);
-    const option = buildOption(optionName, types, params, newDescription, def);
+    const option = buildOption(commandName, optionName, types, params, newDescription, def);
     (0, exports.addOptionToCommand)(option, options);
 };
 const requiresUserInput = (name) => name !== constants_1.X_CSRF_TOKEN;
-const buildOptionFromType = (doc, parameterIn, name, type, parameterMappings, options, description) => {
+const buildOptionFromType = (commandName, doc, parameterIn, name, type, parameterMappings, options, description) => {
     try {
         const types = flattenType(type, doc);
         checkTypes(types);
@@ -266,7 +266,7 @@ const buildOptionFromType = (doc, parameterIn, name, type, parameterMappings, op
         else {
             const params = initParams(types);
             if (requiresUserInput(name)) {
-                handleOption(name, params, types, options, description);
+                handleOption(commandName, name, params, types, options, description);
             }
             parameterMappings.push({
                 in: parameterIn,
@@ -301,7 +301,7 @@ const handleRequestBody = (operation, handler, doc, parameterMappings, command)
             if (key.schema.oneOf) {
                 throw new Error("invalid request body parameter resolution, oneOf not supported");
             }
-            (0, exports.buildOptionFromType)(doc, "body", key.key, {
+            (0, exports.buildOptionFromType)(command.command, doc, "body", key.key, {
                 ...key.schema,
                 required: key.required,
             }, parameterMappings, command.options, key.schema.description);
@@ -327,15 +327,28 @@ const handleParameters = (operation, doc, parameterMappings, command, topLevelPa
     (operation.parameters || []).concat(topLevelParameters).forEach((p) => {
         try {
             const parameter = (0, exports.getSchema)(p, doc);
-            (0, exports.buildOptionFromType)(doc, parameter.in, parameter.name, {
+            (0, exports.buildOptionFromType)(command.command, doc, parameter.in, parameter.name, {
                 ...parameter.schema,
                 allowEmptyValue: parameter.allowEmptyValue,
                 required: parameter.required,
             }, parameterMappings, command.options, parameter.description);
         }
         catch (err) {
-            error("cannot add option", err.stack);
+            error(`cannot add option ${p} for operation ${operation.operationId}`, err.stack);
         }
     });
 };
 exports.handleParameters = handleParameters;
+const handleDeprecationNotice = (operation, command) => {
+    if (operation.deprecated && command.type === "command") {
+        // eslint-disable-next-line no-param-reassign
+        command.deprecationInfo = {
+            deprecated: true,
+            deprecatedWithWave: operation["x-deprecated-with-wave"],
+            decommissionedAfterWave: operation["x-decommissioned-after-wave"],
+            newCommand: operation["x-deprecation-new-command"],
+            sapHelpUrl: operation["x-deprecation-sap-help-url"],
+        };
+    }
+};
+exports.handleDeprecationNotice = handleDeprecationNotice;

package/constants.d.ts

@@ -17,7 +17,7 @@ export declare enum AuthenticationMethod {
     oauth = "oauth",
     passcode = "passcode"
 }
-export declare const ROOT_COMMAND_NAME = "ROOT";
+export declare const ROOT_COMMAND: any;
 export declare const CLI_NAME = "cli-name";
 export declare const CLI_PACKAGE_NAME = "cli-package-name";
 export declare const CLI_DESCRIPTION = "cli-description";
@@ -31,6 +31,7 @@ export declare const CLI_GENERIC_OPTIONS_HELP = "cli-generic-options-help";
 export declare const SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH: string[];
 export declare const DISCOVERY_METADATA_PATH = "discovery-metadata.json";
 export declare const X_CSRF_TOKEN = "x-csrf-token";
+export declare const X_DSP_API_DEPRECATED_PROPERTIES = "x-dsp-api-deprecated-properties";
 export declare const X_OUTPUT_FILE_NAME = "x-sap-datasphere-cli-file-name";
 export declare const PATH_TO_SUCCESS_HTML: string;
 export declare const PATH_TO_ERROR_HTML: string;

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_PATHS = exports.CLI_DESCRIPTION = exports.CLI_PACKAGE_NAME = exports.CLI_NAME = exports.ROOT_COMMAND_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_DSP_API_DEPRECATED_PROPERTIES = 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_PATHS = exports.CLI_DESCRIPTION = exports.CLI_PACKAGE_NAME = exports.CLI_NAME = exports.ROOT_COMMAND = 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,7 @@ var AuthenticationMethod;
     AuthenticationMethod["oauth"] = "oauth";
     AuthenticationMethod["passcode"] = "passcode";
 })(AuthenticationMethod || (exports.AuthenticationMethod = AuthenticationMethod = {}));
-exports.ROOT_COMMAND_NAME = "ROOT";
+exports.ROOT_COMMAND = { name: () => "ROOT", parent: null };
 exports.CLI_NAME = "cli-name";
 exports.CLI_PACKAGE_NAME = "cli-package-name";
 exports.CLI_DESCRIPTION = "cli-description";
@@ -27,25 +27,23 @@ exports.CLI_GENERIC_OPTIONS_HELP = "cli-generic-options-help";
 exports.SEGMENTS_TO_REMOVE_FOR_PASSCODE_AUTH = ["dwaas-core"];
 exports.DISCOVERY_METADATA_PATH = "discovery-metadata.json";
 exports.X_CSRF_TOKEN = "x-csrf-token";
+exports.X_DSP_API_DEPRECATED_PROPERTIES = "x-dsp-api-deprecated-properties";
 exports.X_OUTPUT_FILE_NAME = "x-sap-datasphere-cli-file-name";
 exports.PATH_TO_SUCCESS_HTML = path_1.default.join(__dirname, "assets", "success.html");
 exports.PATH_TO_ERROR_HTML = path_1.default.join(__dirname, "assets", "error.html");
 exports.CACHE_SECRETS_FILE = "secrets.json";
 exports.OPTION_VERSION = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "version",
     description: "print version",
     hidden: true,
 };
 exports.OPTION_HELP = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "help",
     description: "print help for a command",
     args: [{ name: "command" }],
     hidden: true,
 };
 exports.OPTION_HOST = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "host",
     description: "specifies the url where the tenant is hosted",
     args: [{ name: "host" }],
@@ -56,7 +54,6 @@ exports.OPTION_HOST = {
     },
 };
 exports.OPTION_LOGIN_ID = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "login-id",
     description: "specifies the login ID",
     args: [{ name: "id" }],
@@ -68,31 +65,26 @@ exports.OPTION_LOGIN_ID = {
     },
 };
 exports.OPTION_OUTPUT = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "output",
     description: "specifies the file to store the output of the command",
     args: [{ name: "output", optional: true }],
     hidden: true,
 };
 exports.OPTION_NO_PRETTY = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "no-pretty",
     description: "do not pretty-format JSON responses",
     hidden: true,
 };
 exports.OPTION_VERBOSE = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "verbose",
     description: "print detailed log information to console",
     hidden: true,
 };
 exports.OPTION_FORCE = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "force",
     description: "force the command execution",
 };
 exports.OPTION_CLIENT_ID = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "client-id",
     description: "client id for interactive oauth session authentication",
     args: [{ name: "id" }],
@@ -103,7 +95,6 @@ exports.OPTION_CLIENT_ID = {
     },
 };
 exports.OPTION_CLIENT_SECRET = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "client-secret",
     description: "client secret for interactive oauth session authentication",
     args: [{ name: "secret" }],
@@ -114,7 +105,6 @@ exports.OPTION_CLIENT_SECRET = {
     },
 };
 exports.OPTION_AUTHORIZATION_URL = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "authorization-url",
     description: "authorization url for interactive oauth session authentication",
     args: [{ name: "url" }],
@@ -125,7 +115,6 @@ exports.OPTION_AUTHORIZATION_URL = {
     },
 };
 exports.OPTION_TOKEN_URL = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "token-url",
     description: "token url for interactive oauth session authentication",
     args: [{ name: "url" }],
@@ -136,7 +125,6 @@ exports.OPTION_TOKEN_URL = {
     },
 };
 exports.OPTION_ACCESS_TOKEN = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "access-token",
     description: "access token for interactive oauth session authentication",
     args: [{ name: "token" }],
@@ -147,7 +135,6 @@ exports.OPTION_ACCESS_TOKEN = {
     },
 };
 exports.OPTION_REFRESH_TOKEN = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "refresh-token",
     description: "refresh token for interactive oauth session authentication",
     args: [{ name: "token" }],
@@ -158,7 +145,6 @@ exports.OPTION_REFRESH_TOKEN = {
     },
 };
 exports.OPTION_EXPIRES_IN = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "expires-in",
     description: "expires in information for interactive oauth session authentication",
     args: [{ name: "expires" }],
@@ -169,7 +155,6 @@ exports.OPTION_EXPIRES_IN = {
     },
 };
 exports.OPTION_SECRETS_FILE = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "secrets-file",
     description: "path to secrets file",
     args: [{ name: "file" }],
@@ -180,7 +165,6 @@ exports.OPTION_SECRETS_FILE = {
     },
 };
 exports.OPTION_CODE = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "code",
     description: "code for oauth token retrieval",
     args: [{ name: "code" }],
@@ -191,7 +175,6 @@ exports.OPTION_CODE = {
     },
 };
 exports.OPTION_PASSCODE = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "passcode",
     description: "passcode for interactive session authentication",
     args: [{ name: "passcode" }],
@@ -199,14 +182,12 @@ exports.OPTION_PASSCODE = {
 };
 exports.CONFIG_PASSCODE_FUNCTION = "passcodeFunction";
 exports.OPTION_OPTIONS_FILE = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "options-file",
     description: "path to options file",
     args: [{ name: "file" }],
     hidden: true,
 };
 exports.OPTION_FILE_PATH = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "file-path",
     description: "specifies the file to use as input for the command",
     args: [{ name: "path" }],
@@ -216,7 +197,6 @@ exports.OPTION_FILE_PATH = {
     },
 };
 exports.OPTION_INPUT = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "input",
     description: "specifies input as string to use for the command",
     args: [{ name: "input" }],
@@ -226,7 +206,6 @@ exports.OPTION_INPUT = {
     },
 };
 exports.OPTION_BROWSER = {
-    commandName: exports.ROOT_COMMAND_NAME,
     longName: "browser",
     description: "specifies the browser to open",
     args: [{ name: "browser" }],

package/discovery/index.d.ts

@@ -1,7 +1,7 @@
 import { Discovery, DiscoveryMetadata } from "../types";
 export declare const getPathToDiscoveryDocument: () => string;
 export declare const getMetadata: () => Promise<Array<DiscoveryMetadata>>;
-export declare const addMetadata: ({ tenant, addedAt, }: DiscoveryMetadata) => Promise<void>;
+export declare const addMetadata: ({ tenant, addedAt, }: Omit<DiscoveryMetadata, "hash">) => Promise<void>;
 export declare const clear: () => void;
 export declare const init: () => Promise<Discovery>;
 export declare const compareEtags: () => Promise<boolean>;

package/discovery/index.js

@@ -17,11 +17,14 @@ const getLogger = () => (0, logger_1.get)("discovery");
 let initialized = false;
 let document;
 let metadata;
+function getHash(tenant) {
+    return (0, utils_2.sha256)(`${tenant}${JSON.stringify((0, core_1.getDiscoveryPaths)())}`).replace(/[/\\]/g, "_");
+}
 const getDocumentName = () => {
     const { trace } = getLogger();
     const config = (0, config_1.get)();
-    const sha = (0, utils_2.sha256)(`${config.publicfqdn}${JSON.stringify((0, core_1.getDiscoveryPaths)())}`).replace(/[/\\]/g, "_");
-    const name = `${constants_1.DISCOVERY_DOCUMENT_PREFIX}${sha}.json`;
+    const hash = getHash(config.publicfqdn);
+    const name = `${constants_1.DISCOVERY_DOCUMENT_PREFIX}${hash}.json`;
     trace(`calculating document name for host ${config.host}, name ${name}`);
     return name;
 };
@@ -47,7 +50,8 @@ exports.getMetadata = getMetadata;
 const addMetadata = async ({ tenant, addedAt, }) => {
     await initMetadata();
     metadata = metadata.filter((t) => t.tenant !== tenant);
-    metadata.push({ tenant, addedAt });
+    const hash = getHash(tenant);
+    metadata.push({ tenant, addedAt, hash });
     await (0, cache_1.writeFile)(constants_1.DISCOVERY_METADATA_PATH, JSON.stringify(metadata));
 };
 exports.addMetadata = addMetadata;