@sap-ux/deploy-tooling 0.10.2 → 0.11.1

package/dist/base/archive.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+/**
+ * Check whether a given zip files contains an adaptation project and if yes returns the contained manisfest.appdesc_variant.
+ *
+ * @param archive buffer representing a zip file
+ * @returns the descriptor as object if the archive contains an adaptation project otherwise undefined
+ */
+export declare function getAppDescriptorVariant(archive: Buffer): {
+    namespace: string;
+    layer: 'CUSTOMER_BASE' | 'VENDOR';
+} | undefined;
+//# sourceMappingURL=archive.d.ts.map

package/dist/base/archive.js

@@ -0,0 +1,30 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppDescriptorVariant = void 0;
+const adm_zip_1 = __importDefault(require("adm-zip"));
+/**
+ * Check whether a given zip files contains an adaptation project and if yes returns the contained manisfest.appdesc_variant.
+ *
+ * @param archive buffer representing a zip file
+ * @returns the descriptor as object if the archive contains an adaptation project otherwise undefined
+ */
+function getAppDescriptorVariant(archive) {
+    try {
+        const zip = new adm_zip_1.default(archive);
+        const file = zip.getEntry('manifest.appdescr_variant');
+        if (file) {
+            return JSON.parse(file.getData().toString());
+        }
+        else {
+            return undefined;
+        }
+    }
+    catch (error) {
+        return undefined;
+    }
+}
+exports.getAppDescriptorVariant = getAppDescriptorVariant;
+//# sourceMappingURL=archive.js.map

package/dist/base/config.d.ts

@@ -1,4 +1,5 @@
 import type { AbapDeployConfig } from '../types';
+import type { BspConfig } from '@sap-ux/axios-extension';
 /**
  * Clones the given config and removes secrets so that it can be printed to a log file.
  *
@@ -14,6 +15,19 @@ export declare function getConfigForLogging(config: AbapDeployConfig): AbapDeplo
  * @param obj - any object structure
  */
 export declare function replaceEnvVariables(obj: object): void;
+/**
+ * Helper function for throwing a missing property error.
+ *
+ * @param property Invalid missing property
+ */
+export declare function throwConfigMissingError(property: string): void;
+/**
+ * Type checking the config object.
+ *
+ * @param config - config to be checked
+ * @returns true if it is of type BSP config
+ */
+export declare function isBspConfig(config: Partial<BspConfig>): config is BspConfig;
 /**
  * Validate the given config. If anything mandatory is missing throw an error.
  *

package/dist/base/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateConfig = exports.replaceEnvVariables = exports.getConfigForLogging = void 0;
+exports.validateConfig = exports.isBspConfig = exports.throwConfigMissingError = exports.replaceEnvVariables = exports.getConfigForLogging = void 0;
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const system_access_1 = require("@sap-ux/system-access");
 /**
@@ -45,6 +45,7 @@ exports.replaceEnvVariables = replaceEnvVariables;
 function throwConfigMissingError(property) {
     throw new Error(`Invalid deployment configuration. Property ${property} is missing.`);
 }
+exports.throwConfigMissingError = throwConfigMissingError;
 /**
  * Validate the given target config. If anything mandatory is missing throw an error.
  *
@@ -62,6 +63,16 @@ function validateTarget(target) {
     }
     return target;
 }
+/**
+ * Type checking the config object.
+ *
+ * @param config - config to be checked
+ * @returns true if it is of type BSP config
+ */
+function isBspConfig(config) {
+    return config.name !== undefined;
+}
+exports.isBspConfig = isBspConfig;
 /**
  * Validate the given config. If anything mandatory is missing throw an error.
  *
@@ -78,12 +89,7 @@ function validateConfig(config) {
     else {
         throwConfigMissingError('target');
     }
-    if (config.app) {
-        if (!config.app.name) {
-            throwConfigMissingError('app-name');
-        }
-    }
-    else {
+    if (!config.app) {
         throwConfigMissingError('app');
     }
     return config;

package/dist/base/deploy.js

@@ -15,8 +15,8 @@ const fs_1 = require("fs");
 const config_1 = require("./config");
 const prompt_1 = require("./prompt");
 const system_access_1 = require("@sap-ux/system-access");
+const archive_1 = require("./archive");
 const validate_1 = require("./validate");
-const deploymentCommands = { tryUndeploy, tryDeploy };
 /**
  * Handle exceptions thrown, in some cases we to retry them.
  *
@@ -36,7 +36,7 @@ function handleError(command, error, provider, config, logger, archive) {
                 return;
             }
         }
-        logger.error(`${command === "tryDeploy" /* TryCommands.Deploy */ ? 'Deployment' : 'Undeployment'} has failed.`);
+        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)');
@@ -58,7 +58,7 @@ 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 deploymentCommands[command](provider, Object.assign(Object.assign({}, config), { safe: false, retry: false }), logger, archive);
+            yield command(provider, Object.assign(Object.assign({}, config), { safe: false, retry: false }), logger, archive);
             return true;
         }
         else {
@@ -77,13 +77,12 @@ function handle412Error(command, provider, config, logger, archive) {
  * @returns true if the error was handled otherwise false is returned
  */
 function handle401Error(command, provider, config, logger, archive) {
-    var _a;
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
-        logger.warn(`${command === "tryDeploy" /* TryCommands.Deploy */ ? 'Deployment' : 'Undeployment'} failed with authentication error.`);
+        logger.warn(`${command === tryDeploy ? 'Deployment' : 'Undeployment'} failed with authentication error.`);
         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 service = getUi5AbapRepositoryService(provider, config, logger);
-        const credentials = yield (0, system_access_1.getCredentialsWithPrompts)((_a = service.defaults.auth) === null || _a === void 0 ? void 0 : _a.username);
+        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;
@@ -92,7 +91,9 @@ function handle401Error(command, provider, config, logger, archive) {
             else {
                 config.credentials = credentials;
             }
-            yield runCommand(command, config, logger, archive);
+            // Need to re-init the provider with the updated credentials
+            provider = yield createProvider(config, logger);
+            yield command(provider, config, logger, archive);
             return true;
         }
         else {
@@ -124,16 +125,16 @@ function axiosErrorRetryHandler(command, response, provider, config, logger, arc
     });
 }
 /**
- * Generate a Ui5AbapRepositoryService instance from the supplied deployment config.
+ * Generate a service instance for deployment from the supplied deployment config.
  *
- * @param provider - instance of the axios-extension abap service provider
+ * @param factoryFn - function to create a service
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
  * @returns service returns the UI5 ABAP Repository service
  */
-function getUi5AbapRepositoryService(provider, config, logger) {
+function getDeployService(factoryFn, config, logger) {
     var _a;
-    const service = provider.getUi5AbapRepository((_a = config.target) === null || _a === void 0 ? void 0 : _a.service);
+    const service = factoryFn((_a = config.target) === null || _a === void 0 ? void 0 : _a.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).');
@@ -153,41 +154,68 @@ function createTransportRequest(config, logger, provider) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         if (!provider) {
-            provider = yield (0, system_access_1.createAbapServiceProvider)(config.target, {
-                auth: config.credentials,
-                ignoreCertErrors: !config.strictSsl
-            }, !!config.target.scp, logger);
+            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 transportRequest = yield (adtService === null || adtService === void 0 ? void 0 : adtService.createTransportRequest({
             packageName: (_a = config.app.package) !== null && _a !== void 0 ? _a : '',
-            ui5AppName: config.app.name,
+            ui5AppName,
             description: 'Created by @sap-ux/deploy-tooling'
         }));
         if (transportRequest) {
-            logger.info(`Transport request ${transportRequest} created for application ${config.app.name}.`);
+            logger.info(`Transport request ${transportRequest} created for application ${ui5AppName}.`);
             return transportRequest;
         }
-        throw new Error(`Transport request could not be created for application ${config.app.name}.`);
+        throw new Error(`Transport request could not be created for application ${ui5AppName}.`);
     });
 }
 exports.createTransportRequest = createTransportRequest;
 /**
- * Generic method to run the deployment request i.e. deploy | undeploy.
+ * Create a service provider based on the given config.
  *
- * @param command - the request type deploy | undeploy to be executed
  * @param config - deployment configuration
  * @param logger - reference to the logger instance
- * @param archive - archive file that is to be deployed
+ * @returns an instance of an ABAP service provider
  */
-function runCommand(command, config, logger, archive = Buffer.from('')) {
+function createProvider(config, logger) {
     return __awaiter(this, void 0, void 0, function* () {
-        const provider = yield (0, system_access_1.createAbapServiceProvider)(config.target, {
+        return yield (0, system_access_1.createAbapServiceProvider)(config.target, {
             auth: config.credentials,
             ignoreCertErrors: !config.strictSsl
         }, !!config.target.scp, logger);
-        logger.info(`Starting to ${command === "tryDeploy" /* TryCommands.Deploy */ ? 'deploy' : 'undeploy'}${config.test === true ? ' in test mode' : ''}.`);
-        yield deploymentCommands[command](provider, config, logger, archive);
+    });
+}
+/**
+ * Check if the archive is an adapation project and if yes, try to deploy it to the layered repository.
+ *
+ * @param provider - instance of the axios-extension abap service provider
+ * @param config - deployment configuration
+ * @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
+                });
+            }
+        }
+        else {
+            (0, config_1.throwConfigMissingError)('app-name');
+        }
     });
 }
 /**
@@ -199,30 +227,27 @@ function runCommand(command, config, logger, archive = Buffer.from('')) {
  * @param archive - archive file that is to be deployed
  */
 function tryDeploy(provider, config, logger, archive) {
-    var _a, _b, _c, _d, _e;
     return __awaiter(this, void 0, void 0, function* () {
         try {
             if (config.createTransport) {
                 config.app.transport = yield createTransportRequest(config, logger, provider);
-                // Reset as we dont want other flows kicking it off again!
+                // Reset as we don't want other flows kicking it off again!
                 config.createTransport = false;
             }
-            let validateOutput;
-            if (config.test === true) {
-                validateOutput = yield (0, validate_1.validateBeforeDeploy)({
-                    appName: config.app.name,
-                    description: (_a = config.app.description) !== null && _a !== void 0 ? _a : '',
-                    package: (_b = config.app.package) !== null && _b !== void 0 ? _b : '',
-                    transport: (_c = config.app.transport) !== null && _c !== void 0 ? _c : '',
-                    client: (_d = config.target.client) !== null && _d !== void 0 ? _d : '',
-                    url: (_e = config.target.url) !== null && _e !== void 0 ? _e : ''
-                }, provider, logger);
-                if (!validateOutput.result) {
-                    logger.info(`Results of validating the deployment configuration settings:${(0, validate_1.formatSummary)(validateOutput.summary)}`);
+            // 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);
+                    if (!validateOutput.result) {
+                        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);
             }
-            const service = getUi5AbapRepositoryService(provider, config, logger);
-            yield service.deploy({ archive, bsp: config.app, testMode: config.test, safeMode: config.safe });
             if (config.test === true) {
                 logger.info('Deployment in TestMode completed. A successful TestMode execution does not necessarily mean that your upload will be successful.');
             }
@@ -231,7 +256,7 @@ function tryDeploy(provider, config, logger, archive) {
             }
         }
         catch (error) {
-            yield handleError("tryDeploy" /* TryCommands.Deploy */, error, provider, config, logger, archive);
+            yield handleError(tryDeploy, error, provider, config, logger, archive);
         }
     });
 }
@@ -247,7 +272,9 @@ function deploy(archive, config, logger) {
         if (config.keep) {
             (0, fs_1.writeFileSync)(`archive.zip`, archive);
         }
-        yield runCommand("tryDeploy" /* TryCommands.Deploy */, config, logger, archive);
+        const provider = yield createProvider(config, logger);
+        logger.info(`Starting to deploy${config.test === true ? ' in test mode' : ''}.`);
+        yield tryDeploy(provider, config, logger, archive);
     });
 }
 exports.deploy = deploy;
@@ -265,8 +292,20 @@ function tryUndeploy(provider, config, logger) {
                 config.app.transport = yield createTransportRequest(config, logger, provider);
                 config.createTransport = false;
             }
-            const service = getUi5AbapRepositoryService(provider, config, logger);
-            yield service.undeploy({ bsp: config.app, testMode: config.test });
+            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.');
             }
@@ -275,7 +314,7 @@ function tryUndeploy(provider, config, logger) {
             }
         }
         catch (error) {
-            yield handleError("tryUndeploy" /* TryCommands.UnDeploy */, error, provider, config, logger, Buffer.from(''));
+            yield handleError(tryUndeploy, error, provider, config, logger, Buffer.from(''));
         }
     });
 }
@@ -287,7 +326,9 @@ function tryUndeploy(provider, config, logger) {
  */
 function undeploy(config, logger) {
     return __awaiter(this, void 0, void 0, function* () {
-        yield runCommand("tryUndeploy" /* TryCommands.UnDeploy */, config, logger);
+        const provider = yield createProvider(config, logger);
+        logger.info(`Starting to undeploy ${config.test === true ? ' in test mode' : ''}.`);
+        yield tryUndeploy(provider, config, logger);
     });
 }
 exports.undeploy = undeploy;

package/dist/base/validate.d.ts

@@ -1,5 +1,6 @@
 import type { AbapServiceProvider } from '@sap-ux/axios-extension';
 import type { Logger } from '@sap-ux/logger';
+import type { AbapDeployConfig } from '../types';
 export type ValidationInputs = {
     appName: string;
     description: string;
@@ -36,12 +37,12 @@ export declare const summaryMessage: {
 /**
  * Validation of deploy configuration before running deploy-test.
  *
- * @param input Deploy configuration that needs to be validated
+ * @param config Deploy configuration that needs to be validated
  * @param provider AbapServiceProvider
  * @param logger Logger used by deploy tooling
  * @returns Validation result and a summary report of identified issues.
  */
-export declare function validateBeforeDeploy(input: ValidationInputs, provider: AbapServiceProvider, logger: Logger): Promise<ValidationOutput>;
+export declare function validateBeforeDeploy(config: AbapDeployConfig, provider: AbapServiceProvider, logger: Logger): Promise<ValidationOutput>;
 /**
  * Format a list of summary records that is ready to be printed on the console.
  *

package/dist/base/validate.js

@@ -35,17 +35,26 @@ exports.summaryMessage = {
 /**
  * Validation of deploy configuration before running deploy-test.
  *
- * @param input Deploy configuration that needs to be validated
+ * @param config Deploy configuration that needs to be validated
  * @param provider AbapServiceProvider
  * @param logger Logger used by deploy tooling
  * @returns Validation result and a summary report of identified issues.
  */
-function validateBeforeDeploy(input, provider, logger) {
+function validateBeforeDeploy(config, provider, logger) {
+    var _a, _b, _c, _d, _e, _f;
     return __awaiter(this, void 0, void 0, function* () {
         const output = {
             summary: [],
             result: true
         };
+        const input = {
+            appName: (_a = config.app.name) !== null && _a !== void 0 ? _a : '',
+            description: (_b = config.app.description) !== null && _b !== void 0 ? _b : '',
+            package: (_c = config.app.package) !== null && _c !== void 0 ? _c : '',
+            transport: (_d = config.app.transport) !== null && _d !== void 0 ? _d : '',
+            client: (_e = config.target.client) !== null && _e !== void 0 ? _e : '',
+            url: (_f = config.target.url) !== null && _f !== void 0 ? _f : ''
+        };
         // output is passed by reference and status updated during the internal pipeline below.
         yield validateInputTextFormat(input, output, provider, logger);
         yield validatePackageWithAdt(input, output, provider, logger);

package/dist/cli/config.js

@@ -185,6 +185,7 @@ function mergeConfig(taskConfig, options) {
         config.yes = mergeFlag(options.yes, taskConfig.yes);
         config.createTransport = mergeFlag(options.createTransport, taskConfig.createTransport);
         config.retry = process.env.NO_RETRY ? !process.env.NO_RETRY : mergeFlag(options.retry, taskConfig.retry);
+        config.lrep = options.lrep;
         if (!options.archiveUrl && !options.archivePath && !options.archiveFolder) {
             options.archiveFolder = 'dist';
         }

package/dist/cli/index.d.ts

@@ -7,11 +7,11 @@ import { Command } from 'commander';
  */
 export declare function createCommand(name: 'deploy' | 'undeploy'): Command;
 /**
- * Function that is to be execute when the exposed deploy command is executed.
+ * Function that is to be executed when the exposed deploy command is executed.
  */
 export declare function runDeploy(): Promise<void>;
 /**
- * Function that is to be execute when the exposed undeploy command is executed.
+ * Function that is to be executed when the exposed undeploy command is executed.
  */
 export declare function runUndeploy(): Promise<void>;
 //# sourceMappingURL=index.d.ts.map

package/dist/cli/index.js

@@ -35,7 +35,7 @@ function createCommand(name) {
         .addOption(new commander_1.Option('--url <target-url>', 'URL of target ABAP system').conflicts('destination'))
         .addOption(new commander_1.Option('--client <sap-client>', 'Client number of target ABAP system').conflicts('destination'))
         .addOption(new commander_1.Option('--cloud', 'Target is an ABAP Cloud system').conflicts('destination'))
-        .addOption(new commander_1.Option('--service <service-path>', 'Target SAPUI5 Repository OData Service'))
+        .addOption(new commander_1.Option('--service <service-path>', 'Target alias for deployment service'))
         .addOption(new commander_1.Option('--cloud-service-key <file-location>', 'JSON file location with the ABAP cloud service key.').conflicts('destination'))
         .addOption(new commander_1.Option('--cloud-service-env', 'Read ABAP cloud service properties from environment variables or .env file').conflicts(['cloudServiceKey', 'destination']))
         .option('--package <abap-package>', 'Package name for deploy target ABAP system')
@@ -72,6 +72,9 @@ function createCommand(name) {
             'archivePath'
         ]));
     }
+    else if (name === 'undeploy') {
+        command.addOption(new commander_1.Option('--lrep <namespace>', 'Undeploy the given namespace from the layered repository (for adaptation projects)').conflicts(['test', 'name']));
+    }
     return command.version((0, config_1.getVersion)(), '-v, --version', 'version of the deploy tooling');
 }
 exports.createCommand = createCommand;
@@ -106,7 +109,7 @@ function prepareRun(cmd) {
     });
 }
 /**
- * Function that is to be execute when the exposed deploy command is executed.
+ * Function that is to be executed when the exposed deploy command is executed.
  */
 function runDeploy() {
     return __awaiter(this, void 0, void 0, function* () {
@@ -123,7 +126,7 @@ function runDeploy() {
 }
 exports.runDeploy = runDeploy;
 /**
- * Function that is to be execute when the exposed undeploy command is executed.
+ * Function that is to be executed when the exposed undeploy command is executed.
  */
 function runUndeploy() {
     return __awaiter(this, void 0, void 0, function* () {

package/dist/types/index.d.ts

@@ -43,6 +43,10 @@ export interface CommonOptions {
      * If set to true, a transport request will be created during deployment
      */
     createTransport?: boolean;
+    /**
+     * Optional layered repository namespace.
+     */
+    lrep?: string;
 }
 /**
  * Enhancing the target with an optional service property allowing to use an alias for the deployment service.
@@ -52,7 +56,7 @@ export type AbapTarget = BaseAbapTarget & {
 };
 export interface AbapDeployConfig extends CommonOptions {
     target: AbapTarget;
-    app: BspConfig;
+    app: Partial<BspConfig>;
     credentials?: AxiosRequestConfig['auth'];
     exclude?: string[];
 }

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Adeploy-tooling"
   },
-  "version": "0.10.2",
+  "version": "0.11.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",