@sap/cli-core 2024.15.0 → 2024.18.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.17.0
+
+### Added
+
+- Support for binary files. Binary files can be specified as input for a command. The content is send as a buffer to the server. The `Content-Type` header is set to `multipart/form-data`.
+
 ## 2024.15.0
 
 ### Changed

package/cache/secrets/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSecretConsistent = exports.getTenantUrl = exports.isCustomClient = void 0;
+exports.getTenantUrl = exports.isCustomClient = void 0;
+exports.isSecretConsistent = isSecretConsistent;
 const config_1 = require("../../config");
 const constants_1 = require("../../constants");
 // Pre-delivered OAuth Client ID: 5a638330-5899-366e-ac00-ab62cc32dcda
@@ -23,4 +24,3 @@ function isSecretConsistent(secret) {
         (!!secret.access_token ||
             (!!secret.refresh_token && !!secret.client_id && !!secret.client_secret)));
 }
-exports.isSecretConsistent = isSecretConsistent;

package/commands/config.command/cache.command/init.command/utils.js

@@ -3,13 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeDiscoveries = exports.getLowerVersion = void 0;
+exports.getLowerVersion = getLowerVersion;
+exports.mergeDiscoveries = mergeDiscoveries;
 const compare_versions_1 = require("compare-versions");
 const lodash_1 = __importDefault(require("lodash"));
 function getLowerVersion(a, b) {
     return [a, b].sort(compare_versions_1.compareVersions)[0];
 }
-exports.getLowerVersion = getLowerVersion;
 function mergeDiscoveries(discovery, newDiscovery) {
     lodash_1.default.merge(discovery, newDiscovery);
     // eslint-disable-next-line no-param-reassign
@@ -17,4 +17,3 @@ function mergeDiscoveries(discovery, newDiscovery) {
     // eslint-disable-next-line no-param-reassign
     discovery.info["x-document-version"] = getLowerVersion(discovery.info["x-document-version"], newDiscovery.info["x-document-version"]);
 }
-exports.mergeDiscoveries = mergeDiscoveries;

package/commands/handler/fetch/utils.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { URL } from "url";
 import { AxiosResponseHeaders, RawAxiosResponseHeaders } from "axios";
 import { HTTPConfig, HTTPMethod, KeyValuePair, ParameterMapping, ParameterMappings } from "../../../types";

package/commands/handler/fetch/utils.js

@@ -3,7 +3,10 @@ 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.handleResponseHeaders = exports.handleResponseData = exports.checkResponseDataForInvalidLoginData = exports.getOutputFileName = exports.buildParameters = exports.handleParameterMapping = exports.getValueFromMappping = exports.handleMappingIn = exports.removeLeadingPathSegmentForPasscode = exports.checkConfiguration = void 0;
+exports.buildHttpConfig = exports.configRequiresBody = exports.handleResponse = exports.handleResponseData = exports.buildParameters = exports.handleParameterMapping = exports.getValueFromMappping = exports.handleMappingIn = exports.removeLeadingPathSegmentForPasscode = exports.checkConfiguration = void 0;
+exports.getOutputFileName = getOutputFileName;
+exports.checkResponseDataForInvalidLoginData = checkResponseDataForInvalidLoginData;
+exports.handleResponseHeaders = handleResponseHeaders;
 const os_1 = require("os");
 const url_1 = require("url");
 const lodash_1 = __importDefault(require("lodash"));
@@ -92,10 +95,19 @@ const handleParameterMapping = (config, url, headers, bodyWrapper) => (mapping)
 exports.handleParameterMapping = handleParameterMapping;
 const buildParameters = (path, parameterMappings) => {
     const config = (0, config_1.get)();
-    const headers = {};
     const bodyWrapper = {
-        body: config.data,
+        body: undefined,
     };
+    let headers = {};
+    if (config.data?.type === "file") {
+        // stackoverflow.com/a/59177066
+        headers = config.data.content.getHeaders();
+        bodyWrapper.body = config.data.content;
+    }
+    else if (config.data?.type === "json") {
+        headers = { "Content-Type": "application/json" };
+        bodyWrapper.body = config.data.content;
+    }
     const url = getUrl(path);
     parameterMappings?.forEach((0, exports.handleParameterMapping)(config, url, headers, bodyWrapper));
     return {
@@ -119,7 +131,6 @@ function getOutputFileName(outputPath = "") {
     }
     return config.options[constants_1.OPTION_OUTPUT.longName];
 }
-exports.getOutputFileName = getOutputFileName;
 function checkResponseDataForInvalidLoginData(response) {
     if (
     // jira.tools.sap/browse/DW101-73607
@@ -132,7 +143,6 @@ function checkResponseDataForInvalidLoginData(response) {
     }
     return false;
 }
-exports.checkResponseDataForInvalidLoginData = checkResponseDataForInvalidLoginData;
 const handleResponseData = async (data, outputPath) => {
     checkResponseDataForInvalidLoginData(data);
     const config = (0, config_1.get)();
@@ -185,7 +195,6 @@ function handleResponseHeaders(headers) {
         }
     }
 }
-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] });
@@ -212,6 +221,7 @@ const buildHttpConfig = (method, path, parameterMappings) => {
         headers: {
             ...config.authorization,
             ...headers,
+            ...config.headers,
             publicfqdn: config.publicfqdn,
         },
     };

package/commands/handler/input/file.js

@@ -5,6 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = void 0;
 const fs_extra_1 = __importDefault(require("fs-extra"));
+const form_data_1 = __importDefault(require("form-data"));
+const path_1 = __importDefault(require("path"));
 const config_1 = require("../../../config");
 const logger_1 = require("../../../logger");
 const constants_1 = require("../../../constants");
@@ -19,9 +21,26 @@ const readBodyFromFile = async () => async () => {
     const { debug, trace } = logger;
     debug("reading request body from %s", filePath);
     try {
-        (0, config_1.set)({
-            data: JSON.parse(await fs_extra_1.default.readFile(filePath, "utf-8")),
-        });
+        if (filePath.endsWith(".json")) {
+            (0, config_1.set)({
+                data: {
+                    type: "json",
+                    content: JSON.parse(await fs_extra_1.default.readFile(filePath, "utf-8")),
+                },
+            });
+        }
+        else {
+            const form = new form_data_1.default();
+            form.append("file", fs_extra_1.default.createReadStream(filePath));
+            (0, config_1.set)({
+                data: {
+                    type: "file",
+                    content: form,
+                },
+            });
+        }
+        const filename = path_1.default.basename(filePath);
+        (0, config_1.set)({ headers: { [constants_1.X_OUTPUT_FILE_NAME]: filename } });
     }
     catch (err) {
         (0, utils_1.logVerbose)(logger, `Failed to read content from file ${filePath}. Does the file really exist and does it contain valid JSON?`);

package/dwc/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.getOptionValueFromArgv = exports.compareEtags = exports.checkVersion = exports.verifyNodeVersion = exports.addCommandsFromFolder = void 0;
+exports.getOptionValueFromArgv = exports.compareEtags = exports.checkVersion = exports.addCommandsFromFolder = void 0;
+exports.verifyNodeVersion = verifyNodeVersion;
 const path_1 = __importDefault(require("path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const compare_versions_1 = require("compare-versions");
@@ -48,7 +49,6 @@ function verifyNodeVersion() {
             ` 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": "2024.15.0",
+  "version": "2024.18.0",
   "description": "Command-Line Interface (CLI) Core Module",
   "license": "SEE LICENSE IN LICENSE",
   "author": "SAP SE",
@@ -17,19 +17,20 @@
     "cli-core"
   ],
   "dependencies": {
-    "ajv": "8.16.0",
-    "axios": "1.7.2",
+    "ajv": "8.17.1",
+    "axios": "1.7.3",
     "commander": "12.1.0",
-    "compare-versions": "6.1.0",
-    "config": "3.3.11",
+    "compare-versions": "6.1.1",
+    "config": "3.3.12",
     "dotenv": "16.4.5",
+    "form-data": "4.0.0",
     "fs-extra": "11.2.0",
     "https": "1.0.0",
-    "https-proxy-agent": "7.0.4",
+    "https-proxy-agent": "7.0.5",
     "lodash": "4.17.21",
     "open": "8.4.2",
     "path": "0.12.7",
     "prompts": "2.4.2",
-    "qs": "6.12.1"
+    "qs": "6.13.0"
   }
 }

package/utils/commands.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.buildCommand = exports.buildOption = exports.registerLongName = exports.isOptionAlreadyRegistered = exports.getShortFlagForLongName = exports.getAbsoluteCommandName = exports.createCommand = void 0;
+exports.buildCommand = exports.buildOption = exports.registerLongName = exports.isOptionAlreadyRegistered = exports.getShortFlagForLongName = exports.createCommand = void 0;
+exports.getAbsoluteCommandName = getAbsoluteCommandName;
 const commander_1 = require("commander");
 const lodash_1 = __importDefault(require("lodash"));
 const types_1 = require("../types");
@@ -44,7 +45,6 @@ function getAbsoluteCommandName(command) {
     }
     return `${getAbsoluteCommandName(command.parent)}.${command.name()}`;
 }
-exports.getAbsoluteCommandName = getAbsoluteCommandName;
 const getShortFlagForLongName = (command, option) => {
     const commandName = getAbsoluteCommandName(command);
     for (const s of Object.keys(registeredOptions[commandName] ?? {})) {

package/utils/openUtils.js

@@ -23,7 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openUrlInBrowser = exports.getDefaultBrowser = exports.getSupportedBrowsers = void 0;
+exports.openUrlInBrowser = void 0;
+exports.getSupportedBrowsers = getSupportedBrowsers;
+exports.getDefaultBrowser = getDefaultBrowser;
 const open_1 = __importStar(require("open"));
 const constants_1 = require("../constants");
 const options_1 = require("./options");
@@ -35,11 +37,9 @@ function getSupportedBrowsers() {
         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];

package/utils/utils.js

@@ -26,7 +26,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.toConstantCase = exports.sha256 = exports.getInfoFromTenant = exports.parseTenant = exports.removeScopeFromPackageName = exports.getBin = exports.getEngines = exports.getDescription = exports.getPackageName = exports.getName = exports.getVersion = exports.readPackageJson = exports.requireFile = exports.parseVersion = void 0;
+exports.buildOptionName = buildOptionName;
+exports.removeQueryParametersFromUrl = removeQueryParametersFromUrl;
 const crypto = __importStar(require("crypto"));
 const path_1 = __importDefault(require("path"));
 const lodash_1 = require("lodash");
@@ -39,7 +41,6 @@ function buildOptionName(command, option) {
     const shortFlag = (0, commands_1.getShortFlagForLongName)(command, option);
     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) };
@@ -161,7 +162,6 @@ 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");