npm - @sap-ux/deploy-tooling - Versions diffs - 0.14.47 → 0.15.1 - Mend

@sap-ux/deploy-tooling 0.14.47 → 0.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/dist/base/config.js CHANGED Viewed

@@ -10,9 +10,11 @@ const system_access_1 = require("@sap-ux/system-access");
  * @returns config object that can be logged
  */
 function getConfigForLogging(config) {
-    var _a;
-    if ((_a = config.credentials) === null || _a === void 0 ? void 0 : _a.password) {
-        return Object.assign(Object.assign({}, config), { credentials: 'hidden' });
+    if (config.credentials?.password) {
+        return {
+            ...config,
+            credentials: 'hidden'
+        };
     }
     else {
         return config;

package/dist/base/deploy.js CHANGED Viewed

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.undeploy = exports.deploy = exports.createTransportRequest = void 0;
 const axios_extension_1 = require("@sap-ux/axios-extension");
@@ -27,22 +18,20 @@ const validate_1 = require("./validate");
  * @param logger - reference to the logger instance
  * @param archive - archive file that is to be deployed
  */
-function handleError(command, error, provider, config, logger, archive) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const retry = config.retry === undefined ? true : config.retry;
-        if (retry && (0, axios_extension_1.isAxiosError)(error)) {
-            const success = yield axiosErrorRetryHandler(command, error.response, provider, config, logger, archive);
-            if (success) {
-                return;
-            }
-        }
-        logger.error(`${command === tryDeploy ? 'Deployment' : 'Undeployment'} has failed.`);
-        logger.debug((0, config_1.getConfigForLogging)(config));
-        if (!config.verbose) {
-            logger.error('Change logging level to debug your issue\n\t(see examples https://github.com/SAP/open-ux-tools/tree/main/packages/deploy-tooling#configuration-with-logging-enabled)');
+async function handleError(command, error, provider, config, logger, archive) {
+    const retry = config.retry === undefined ? true : config.retry;
+    if (retry && (0, axios_extension_1.isAxiosError)(error)) {
+        const success = await axiosErrorRetryHandler(command, error.response, provider, config, logger, archive);
+        if (success) {
+            return;
         }
-        throw error;
-    });
+    }
+    logger.error(`${command === tryDeploy ? 'Deployment' : 'Undeployment'} has failed.`);
+    logger.debug((0, config_1.getConfigForLogging)(config));
+    if (!config.verbose) {
+        logger.error('Change logging level to debug your issue\n\t(see examples https://github.com/SAP/open-ux-tools/tree/main/packages/deploy-tooling#configuration-with-logging-enabled)');
+    }
+    throw error;
 }
 /**
  * Handler for 412 error code.
@@ -54,17 +43,15 @@ function handleError(command, error, provider, config, logger, archive) {
  * @param archive - archive file that is to be deployed
  * @returns true if the error was handled otherwise false is returned
  */
-function handle412Error(command, provider, config, logger, archive) {
-    return __awaiter(this, void 0, void 0, function* () {
-        logger.warn('An app in the same repository with different sap app id found.');
-        if (config.yes || (yield (0, prompt_1.promptConfirmation)('Do you want to overwrite (Y/n)?'))) {
-            yield command(provider, Object.assign(Object.assign({}, config), { safe: false, retry: false }), logger, archive);
-            return true;
-        }
-        else {
-            return false;
-        }
-    });
+async function handle412Error(command, provider, config, logger, archive) {
+    logger.warn('An app in the same repository with different sap app id found.');
+    if (config.yes || (await (0, prompt_1.promptConfirmation)('Do you want to overwrite (Y/n)?'))) {
+        await command(provider, { ...config, safe: false, retry: false }, logger, archive);
+        return true;
+    }
+    else {
+        return false;
+    }
 }
 /**
  * Handler for 401 error code.
@@ -76,30 +63,27 @@ function handle412Error(command, provider, config, logger, archive) {
  * @param archive - archive file that is to be deployed
  * @returns true if the error was handled otherwise false is returned
  */
-function handle401Error(command, provider, config, logger, archive) {
-    var _a, _b;
-    return __awaiter(this, void 0, void 0, function* () {
-        logger.warn(`${command === tryDeploy ? 'Deployment' : 'Undeployment'} failed with authentication error.`);
-        if (yield (0, validate_1.checkForCredentials)(config.target.destination, logger)) {
-            logger.info('Please maintain correct credentials to avoid seeing this error\n\t(see help: https://www.npmjs.com/package/@sap/ux-ui5-tooling#setting-environment-variables-in-a-env-file)');
-            logger.info('Please enter your credentials.');
-            const credentials = yield (0, system_access_1.getCredentialsWithPrompts)((_b = (_a = provider.defaults) === null || _a === void 0 ? void 0 : _a.auth) === null || _b === void 0 ? void 0 : _b.username);
-            if (Object.keys(credentials).length) {
-                if (config.target.serviceKey) {
-                    config.target.serviceKey.uaa.username = credentials.username;
-                    config.target.serviceKey.uaa.password = credentials.password;
-                }
-                else {
-                    config.credentials = credentials;
-                }
-                // Need to re-init the provider with the updated credentials
-                provider = yield createProvider(config, logger);
-                yield command(provider, config, logger, archive);
-                return true;
+async function handle401Error(command, provider, config, logger, archive) {
+    logger.warn(`${command === tryDeploy ? 'Deployment' : 'Undeployment'} failed with authentication error.`);
+    if (await (0, validate_1.checkForCredentials)(config.target.destination, logger)) {
+        logger.info('Please maintain correct credentials to avoid seeing this error\n\t(see help: https://www.npmjs.com/package/@sap/ux-ui5-tooling#setting-environment-variables-in-a-env-file)');
+        logger.info('Please enter your credentials.');
+        const credentials = await (0, system_access_1.getCredentialsWithPrompts)(provider.defaults?.auth?.username);
+        if (Object.keys(credentials).length) {
+            if (config.target.serviceKey) {
+                config.target.serviceKey.uaa.username = credentials.username;
+                config.target.serviceKey.uaa.password = credentials.password;
             }
+            else {
+                config.credentials = credentials;
+            }
+            // Need to re-init the provider with the updated credentials
+            provider = await createProvider(config, logger);
+            await command(provider, config, logger, archive);
+            return true;
         }
-        return false;
-    });
+    }
+    return false;
 }
 /**
  * Main function for different deploy retry handling.
@@ -112,17 +96,15 @@ function handle401Error(command, provider, config, logger, archive) {
  * @param archive - archive file that is to be deployed
  * @returns true if the error was handled otherwise false is return or an error is raised
  */
-function axiosErrorRetryHandler(command, response, provider, config, logger, archive) {
-    return __awaiter(this, void 0, void 0, function* () {
-        switch (response === null || response === void 0 ? void 0 : response.status) {
-            case 401:
-                return handle401Error(command, provider, config, logger, archive);
-            case 412:
-                return handle412Error(command, provider, config, logger, archive);
-            default:
-                return false;
-        }
-    });
+async function axiosErrorRetryHandler(command, response, provider, config, logger, archive) {
+    switch (response?.status) {
+        case 401:
+            return handle401Error(command, provider, config, logger, archive);
+        case 412:
+            return handle412Error(command, provider, config, logger, archive);
+        default:
+            return false;
+    }
 }
 /**
  * Generate a service instance for deployment from the supplied deployment config.
@@ -133,8 +115,7 @@ function axiosErrorRetryHandler(command, response, provider, config, logger, arc
  * @returns service returns the UI5 ABAP Repository service
  */
 function getDeployService(factoryFn, config, logger) {
-    var _a;
-    const service = factoryFn((_a = config.target) === null || _a === void 0 ? void 0 : _a.service);
+    const service = factoryFn(config.target?.service);
     service.log = logger;
     if (!config.strictSsl) {
         logger.warn('You chose not to validate SSL certificate. Please verify the server certificate is trustful before proceeding. See documentation for recommended configuration (https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/4b318bede7eb4021a8be385c46c74045.html).');
@@ -150,26 +131,23 @@ function getDeployService(factoryFn, config, logger) {
  * @throws error if transport request creation fails
  * @returns transportRequest
  */
-function createTransportRequest(config, logger, provider) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!provider) {
-            provider = yield createProvider(config, logger);
-        }
-        const adtService = yield provider.getAdtService(axios_extension_1.TransportRequestService);
-        const ui5AppName = (0, config_1.isBspConfig)(config.app) ? config.app.name : '';
-        const description = `For ABAP repository ${ui5AppName}, created by SAP Open UX Tools`;
-        const transportRequest = yield (adtService === null || adtService === void 0 ? void 0 : adtService.createTransportRequest({
-            packageName: (_a = config.app.package) !== null && _a !== void 0 ? _a : '',
-            ui5AppName,
-            description: description.length > 60 ? description.slice(0, 57) + '...' : description
-        }));
-        if (transportRequest) {
-            logger.info(`Transport request ${transportRequest} created for application ${ui5AppName}.`);
-            return transportRequest;
-        }
-        throw new Error(`Transport request could not be created for application ${ui5AppName}.`);
+async function createTransportRequest(config, logger, provider) {
+    if (!provider) {
+        provider = await createProvider(config, logger);
+    }
+    const adtService = await provider.getAdtService(axios_extension_1.TransportRequestService);
+    const ui5AppName = (0, config_1.isBspConfig)(config.app) ? config.app.name : '';
+    const description = `For ABAP repository ${ui5AppName}, created by SAP Open UX Tools`;
+    const transportRequest = await adtService?.createTransportRequest({
+        packageName: config.app.package ?? '',
+        ui5AppName,
+        description: description.length > 60 ? description.slice(0, 57) + '...' : description
     });
+    if (transportRequest) {
+        logger.info(`Transport request ${transportRequest} created for application ${ui5AppName}.`);
+        return transportRequest;
+    }
+    throw new Error(`Transport request could not be created for application ${ui5AppName}.`);
 }
 exports.createTransportRequest = createTransportRequest;
 /**
@@ -179,13 +157,11 @@ exports.createTransportRequest = createTransportRequest;
  * @param logger - reference to the logger instance
  * @returns an instance of an ABAP service provider
  */
-function createProvider(config, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        return yield (0, system_access_1.createAbapServiceProvider)(config.target, {
-            auth: config.credentials,
-            ignoreCertErrors: !config.strictSsl
-        }, !!config.target.scp, logger);
-    });
+async function createProvider(config, logger) {
+    return await (0, system_access_1.createAbapServiceProvider)(config.target, {
+        auth: config.credentials,
+        ignoreCertErrors: !config.strictSsl
+    }, !!config.target.scp, logger);
 }
 /**
  * Check if the archive is an adapation project and if yes, try to deploy it to the layered repository.
@@ -195,29 +171,27 @@ function createProvider(config, logger) {
  * @param logger - reference to the logger instance
  * @param archive - archive file that is to be deployed
  */
-function tryDeployToLrep(provider, config, logger, archive) {
-    return __awaiter(this, void 0, void 0, function* () {
-        logger.debug('No BSP name provided, checking if it is an adaptation project');
-        const descriptor = (0, archive_1.getAppDescriptorVariant)(archive);
-        if (descriptor) {
-            if (config.test) {
-                throw new Error('Deployment in test mode not supported for deployments to the layered repository.');
-            }
-            else {
-                logger.debug('Deploying an adaptation project to LREP');
-                const service = getDeployService(provider.getLayeredRepository.bind(provider), config, logger);
-                yield service.deploy(archive, {
-                    namespace: descriptor.namespace,
-                    layer: descriptor.layer,
-                    package: config.app.package,
-                    transport: config.app.transport
-                });
-            }
+async function tryDeployToLrep(provider, config, logger, archive) {
+    logger.debug('No BSP name provided, checking if it is an adaptation project');
+    const descriptor = (0, archive_1.getAppDescriptorVariant)(archive);
+    if (descriptor) {
+        if (config.test) {
+            throw new Error('Deployment in test mode not supported for deployments to the layered repository.');
         }
         else {
-            (0, config_1.throwConfigMissingError)('app-name');
+            logger.debug('Deploying an adaptation project to LREP');
+            const service = getDeployService(provider.getLayeredRepository.bind(provider), config, logger);
+            await service.deploy(archive, {
+                namespace: descriptor.namespace,
+                layer: descriptor.layer,
+                package: config.app.package,
+                transport: config.app.transport
+            });
         }
-    });
+    }
+    else {
+        (0, config_1.throwConfigMissingError)('app-name');
+    }
 }
 /**
  * Try executing the deployment command and handle known errors.
@@ -227,45 +201,43 @@ function tryDeployToLrep(provider, config, logger, archive) {
  * @param logger - reference to the logger instance
  * @param archive - archive file that is to be deployed
  */
-function tryDeploy(provider, config, logger, archive) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            if (config.createTransport) {
-                config.app.transport = yield createTransportRequest(config, logger, provider);
-                // Reset as we don't want other flows kicking it off again!
-                config.createTransport = false;
-            }
-            // check if deployment of BSP is requested
-            if ((0, config_1.isBspConfig)(config.app)) {
-                if (config.test === true) {
-                    const validateOutput = yield (0, validate_1.validateBeforeDeploy)(config, provider, logger);
-                    logger.info(`Results of validating the deployment configuration settings:${(0, validate_1.formatSummary)(validateOutput.summary)}`);
-                }
-                const service = getDeployService(provider.getUi5AbapRepository.bind(provider), config, logger);
-                yield service.deploy({
-                    archive,
-                    bsp: config.app,
-                    testMode: config.test,
-                    safeMode: config.safe
-                });
-            }
-            else {
-                yield tryDeployToLrep(provider, config, logger, archive);
-            }
+async function tryDeploy(provider, config, logger, archive) {
+    try {
+        if (config.createTransport) {
+            config.app.transport = await createTransportRequest(config, logger, provider);
+            // Reset as we don't want other flows kicking it off again!
+            config.createTransport = false;
+        }
+        // check if deployment of BSP is requested
+        if ((0, config_1.isBspConfig)(config.app)) {
             if (config.test === true) {
-                logger.info('Deployment in TestMode completed. A successful TestMode execution does not necessarily mean that your upload will be successful.');
-            }
-            else {
-                logger.info('Deployment Successful.');
-                if (yield (0, validate_1.showAdditionalInfoForOnPrem)(`${config.target.destination}`)) {
-                    logger.info('(Note: As the destination is configured using an On-Premise SAP Cloud Connector, you will need to replace the host in the URL above with the internal host)');
-                }
+                const validateOutput = await (0, validate_1.validateBeforeDeploy)(config, provider, logger);
+                logger.info(`Results of validating the deployment configuration settings:${(0, validate_1.formatSummary)(validateOutput.summary)}`);
             }
+            const service = getDeployService(provider.getUi5AbapRepository.bind(provider), config, logger);
+            await service.deploy({
+                archive,
+                bsp: config.app,
+                testMode: config.test,
+                safeMode: config.safe
+            });
         }
-        catch (error) {
-            yield handleError(tryDeploy, error, provider, config, logger, archive);
+        else {
+            await tryDeployToLrep(provider, config, logger, archive);
         }
-    });
+        if (config.test === true) {
+            logger.info('Deployment in TestMode completed. A successful TestMode execution does not necessarily mean that your upload will be successful.');
+        }
+        else {
+            logger.info('Deployment Successful.');
+            if (await (0, validate_1.showAdditionalInfoForOnPrem)(`${config.target.destination}`)) {
+                logger.info('(Note: As the destination is configured using an On-Premise SAP Cloud Connector, you will need to replace the host in the URL above with the internal host)');
+            }
+        }
+    }
+    catch (error) {
+        await handleError(tryDeploy, error, provider, config, logger, archive);
+    }
 }
 /**
  * Deploy the given archive to the given target using the given app description.
@@ -274,15 +246,13 @@ function tryDeploy(provider, config, logger, archive) {
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
  */
-function deploy(archive, config, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (config.keep) {
-            (0, fs_1.writeFileSync)(`archive.zip`, archive);
-        }
-        const provider = yield createProvider(config, logger);
-        logger.info(`Starting to deploy${config.test === true ? ' in test mode' : ''}.`);
-        yield tryDeploy(provider, config, logger, archive);
-    });
+async function deploy(archive, config, logger) {
+    if (config.keep) {
+        (0, fs_1.writeFileSync)(`archive.zip`, archive);
+    }
+    const provider = await createProvider(config, logger);
+    logger.info(`Starting to deploy${config.test === true ? ' in test mode' : ''}.`);
+    await tryDeploy(provider, config, logger, archive);
 }
 exports.deploy = deploy;
 /**
@@ -292,38 +262,36 @@ exports.deploy = deploy;
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
  */
-function tryUndeploy(provider, config, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            if (config.createTransport) {
-                config.app.transport = yield createTransportRequest(config, logger, provider);
-                config.createTransport = false;
-            }
-            if (config.lrep) {
-                const service = getDeployService(provider.getLayeredRepository.bind(provider), config, logger);
-                yield service.undeploy({
-                    namespace: config.lrep,
-                    transport: config.app.transport
-                });
-            }
-            else if ((0, config_1.isBspConfig)(config.app)) {
-                const service = getDeployService(provider.getUi5AbapRepository.bind(provider), config, logger);
-                yield service.undeploy({ bsp: config.app, testMode: config.test });
-            }
-            else {
-                (0, config_1.throwConfigMissingError)('app-name');
-            }
-            if (config.test === true) {
-                logger.info('Undeployment in TestMode completed. A successful TestMode execution does not necessarily mean that your undeploy will be successful.');
-            }
-            else {
-                logger.info('Undeployment Successful.');
-            }
+async function tryUndeploy(provider, config, logger) {
+    try {
+        if (config.createTransport) {
+            config.app.transport = await createTransportRequest(config, logger, provider);
+            config.createTransport = false;
         }
-        catch (error) {
-            yield handleError(tryUndeploy, error, provider, config, logger, Buffer.from(''));
+        if (config.lrep) {
+            const service = getDeployService(provider.getLayeredRepository.bind(provider), config, logger);
+            await service.undeploy({
+                namespace: config.lrep,
+                transport: config.app.transport
+            });
         }
-    });
+        else if ((0, config_1.isBspConfig)(config.app)) {
+            const service = getDeployService(provider.getUi5AbapRepository.bind(provider), config, logger);
+            await service.undeploy({ bsp: config.app, testMode: config.test });
+        }
+        else {
+            (0, config_1.throwConfigMissingError)('app-name');
+        }
+        if (config.test === true) {
+            logger.info('Undeployment in TestMode completed. A successful TestMode execution does not necessarily mean that your undeploy will be successful.');
+        }
+        else {
+            logger.info('Undeployment Successful.');
+        }
+    }
+    catch (error) {
+        await handleError(tryUndeploy, error, provider, config, logger, Buffer.from(''));
+    }
 }
 /**
  * Undeploy the given project from the given target using the given app name.
@@ -331,12 +299,10 @@ function tryUndeploy(provider, config, logger) {
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
  */
-function undeploy(config, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const provider = yield createProvider(config, logger);
-        logger.info(`Starting to undeploy ${config.test === true ? ' in test mode' : ''}.`);
-        yield tryUndeploy(provider, config, logger);
-    });
+async function undeploy(config, logger) {
+    const provider = await createProvider(config, logger);
+    logger.info(`Starting to undeploy ${config.test === true ? ' in test mode' : ''}.`);
+    await tryUndeploy(provider, config, logger);
 }
 exports.undeploy = undeploy;
 //# sourceMappingURL=deploy.js.map

package/dist/base/prompt.js CHANGED Viewed

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -20,22 +11,20 @@ const prompts_1 = __importDefault(require("prompts"));
  * @param message - the message to be shown for confirmation.
  * @returns true if confirmed, otherwise false
  */
-function promptConfirmation(message) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let abort = false;
-        const { confirm } = yield (0, prompts_1.default)({
-            type: 'confirm',
-            name: 'confirm',
-            initial: true,
-            message
-        }, {
-            onCancel() {
-                abort = true;
-                return false;
-            }
-        });
-        return confirm && !abort;
+async function promptConfirmation(message) {
+    let abort = false;
+    const { confirm } = await (0, prompts_1.default)({
+        type: 'confirm',
+        name: 'confirm',
+        initial: true,
+        message
+    }, {
+        onCancel() {
+            abort = true;
+            return false;
+        }
     });
+    return confirm && !abort;
 }
 exports.promptConfirmation = promptConfirmation;
 //# sourceMappingURL=prompt.js.map