@sap-ux/deploy-tooling 0.9.4 → 0.9.6

package/dist/base/config.d.ts

@@ -1,11 +1,4 @@
-import type { AbapDeployConfig, AbapTarget, UrlAbapTarget } from '../types';
-/**
- * Check if it is a url or destination target.
- *
- * @param target target configuration
- * @returns true is it is a UrlAbapTarget
- */
-export declare function isUrlTarget(target: AbapTarget): target is UrlAbapTarget;
+import type { AbapDeployConfig } from '../types';
 /**
  * Clones the given config and removes secrets so that it can be printed to a log file.
  *

package/dist/base/config.js

@@ -1,17 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateConfig = exports.replaceEnvVariables = exports.getConfigForLogging = exports.isUrlTarget = void 0;
+exports.validateConfig = exports.replaceEnvVariables = exports.getConfigForLogging = void 0;
 const btp_utils_1 = require("@sap-ux/btp-utils");
-/**
- * Check if it is a url or destination target.
- *
- * @param target target configuration
- * @returns true is it is a UrlAbapTarget
- */
-function isUrlTarget(target) {
-    return target.url !== undefined;
-}
-exports.isUrlTarget = isUrlTarget;
+const system_access_1 = require("@sap-ux/system-access");
 /**
  * Clones the given config and removes secrets so that it can be printed to a log file.
  *
@@ -61,7 +52,7 @@ function throwConfigMissingError(property) {
  * @returns reference to the given target config
  */
 function validateTarget(target) {
-    if (isUrlTarget(target)) {
+    if ((0, system_access_1.isUrlTarget)(target)) {
         if (target.client) {
             target.client = (target.client + '').padStart(3, '0');
         }

package/dist/base/deploy.d.ts

@@ -2,19 +2,7 @@
 /// <reference types="node" />
 import type { AbapServiceProvider } from '@sap-ux/axios-extension';
 import type { Logger } from '@sap-ux/logger';
-import type { BackendSystem } from '@sap-ux/store';
-import type { AbapDeployConfig, UrlAbapTarget } from '../types';
-type BasicAuth = Required<Pick<BackendSystem, 'username' | 'password'>>;
-type ServiceAuth = Required<Pick<BackendSystem, 'serviceKeys' | 'name'>> & {
-    refreshToken?: string;
-};
-/**
- * Check the secure storage if it has credentials for the given target.
- *
- * @param target - ABAP target
- * @returns {*}  {(Promise<T | undefined>)} - Credentials
- */
-export declare function getCredentials<T extends BasicAuth | ServiceAuth | undefined>(target: UrlAbapTarget): Promise<T | undefined>;
+import type { AbapDeployConfig } from '../types';
 /**
  * Creates a new transport request using adt service.
  *
@@ -40,5 +28,4 @@ export declare function deploy(archive: Buffer, config: AbapDeployConfig, logger
  * @param logger - reference to the logger instance
  */
 export declare function undeploy(config: AbapDeployConfig, logger: Logger): Promise<void>;
-export {};
 //# sourceMappingURL=deploy.d.ts.map

package/dist/base/deploy.js

@@ -9,151 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.undeploy = exports.deploy = exports.createTransportRequest = exports.getCredentials = void 0;
+exports.undeploy = exports.deploy = exports.createTransportRequest = void 0;
 const axios_extension_1 = require("@sap-ux/axios-extension");
-const btp_utils_1 = require("@sap-ux/btp-utils");
-const store_1 = require("@sap-ux/store");
 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 deploymentCommands = { tryUndeploy, tryDeploy };
-/**
- * Check the secure storage if it has credentials for the given target.
- *
- * @param target - ABAP target
- * @returns {*}  {(Promise<T | undefined>)} - Credentials
- */
-function getCredentials(target) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (!(0, btp_utils_1.isAppStudio)()) {
-            const systemService = yield (0, store_1.getService)({ entityName: 'system' });
-            let system = yield systemService.read(new store_1.BackendSystemKey({ url: target.url, client: target.client }));
-            if (!system && target.client) {
-                // check if there are credentials for the default client
-                system = yield systemService.read(new store_1.BackendSystemKey({ url: target.url }));
-            }
-            return system;
-        }
-        else {
-            return undefined;
-        }
-    });
-}
-exports.getCredentials = getCredentials;
-/**
- * Enhance axios options and create a service provider instance for an ABAP Cloud system.
- *
- * @param options - predefined axios options
- * @param target - url target configuration
- * @param noPrompt - only if not truthy prompt for anything
- * @param logger - reference to the logger instance
- * @returns {*}  {(Promise<AbapServiceProvider>)} - ABAP Service Provider
- */
-function createAbapCloudServiceProvider(options, target, noPrompt, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const providerConfig = Object.assign(Object.assign({}, options), { environment: axios_extension_1.AbapCloudEnvironment.Standalone, service: target.serviceKey });
-        if (!target.serviceKey) {
-            const storedOpts = yield getCredentials(target);
-            if (logger && storedOpts) {
-                providerConfig.service = storedOpts.serviceKeys;
-                providerConfig.refreshToken = storedOpts.refreshToken;
-                logger.info(`Using system [${storedOpts.name}] from System store`);
-            }
-            if (!storedOpts && !noPrompt) {
-                providerConfig.service = yield (0, prompt_1.promptServiceKeys)();
-            }
-        }
-        if (providerConfig.service) {
-            return (0, axios_extension_1.createForAbapOnCloud)(providerConfig);
-        }
-        else {
-            throw new Error('Service keys required for deployment to an ABAP Cloud environment.');
-        }
-    });
-}
-/**
- * Checks if credentials are of basic auth type.
- *
- * @param authOpts credential options
- * @returns boolean
- */
-function isBasicAuth(authOpts) {
-    return !!authOpts && authOpts.password !== undefined;
-}
-/**
- * Enhance axios options and create a service provider instance for an on-premise ABAP system.
- *
- * @param options - predefined axios options
- * @param target - url target configuration
- * @returns {*}  {(Promise<AbapServiceProvider>)}
- */
-function createAbapServiceProvider(options, target) {
-    return __awaiter(this, void 0, void 0, function* () {
-        options.baseURL = target.url;
-        if (target.client) {
-            options.params['sap-client'] = target.client;
-        }
-        if (!options.auth) {
-            const storedOpts = yield getCredentials(target);
-            if (isBasicAuth(storedOpts)) {
-                options.auth = {
-                    username: storedOpts.username,
-                    password: storedOpts.password
-                };
-            }
-            if (storedOpts === null || storedOpts === void 0 ? void 0 : storedOpts.serviceKeys) {
-                throw new Error('This is an ABAP Cloud system, please add the --cloud arg to ensure the correct deployment flow.');
-            }
-        }
-        return (0, axios_extension_1.createForAbap)(options);
-    });
-}
-/**
- * Create an instance of an AbapServiceProvider connected to the given target configuration.
- *
- * @param config - deployment configuration
- * @param logger - optional reference to the logger instance
- * @returns service instance
- */
-function getAbapServiceProvider(config, logger) {
-    var _a, _b, _c;
-    return __awaiter(this, void 0, void 0, function* () {
-        let provider;
-        const options = {};
-        if (config.strictSsl === false) {
-            options.ignoreCertErrors = true;
-        }
-        if ((_a = config.credentials) === null || _a === void 0 ? void 0 : _a.password) {
-            options.auth = {
-                username: (_b = config.credentials) === null || _b === void 0 ? void 0 : _b.username,
-                password: (_c = config.credentials) === null || _c === void 0 ? void 0 : _c.password
-            };
-        }
-        options.params = config.target.params || {};
-        // Destination only supported on Business Application studio
-        if ((0, btp_utils_1.isAppStudio)() && config.target.destination) {
-            // Need additional properties to determine the type of destination we are dealing with
-            const destinations = yield (0, btp_utils_1.listDestinations)();
-            const destination = destinations === null || destinations === void 0 ? void 0 : destinations[config.target.destination];
-            if (!destination) {
-                throw new Error(`Destination ${config.target.destination} not found on subaccount`);
-            }
-            provider = (0, axios_extension_1.createForDestination)(options, destination);
-        }
-        else if ((0, config_1.isUrlTarget)(config.target)) {
-            if (config.target.cloud) {
-                provider = yield createAbapCloudServiceProvider(options, config.target, config.retry, logger);
-            }
-            else {
-                provider = yield createAbapServiceProvider(options, config.target);
-            }
-        }
-        else {
-            throw new Error('Unable to handle the configuration in the current environment.');
-        }
-        return provider;
-    });
-}
 /**
  * Handle exceptions thrown, in some cases we to retry them.
  *
@@ -220,7 +82,7 @@ function handle401Error(command, provider, config, logger, archive) {
         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, prompt_1.promptCredentials)((_a = service.defaults.auth) === null || _a === void 0 ? void 0 : _a.username);
+        const credentials = yield (0, system_access_1.getCredentialsWithPrompts)((_a = service.defaults.auth) === null || _a === void 0 ? void 0 : _a.username);
         if (Object.keys(credentials).length) {
             if (config.target.serviceKey) {
                 config.target.serviceKey.uaa.username = credentials.username;
@@ -290,7 +152,10 @@ function createTransportRequest(config, logger, provider) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         if (!provider) {
-            provider = yield getAbapServiceProvider(config, logger);
+            provider = yield (0, system_access_1.createAbapServiceProvider)(config.target, {
+                auth: config.credentials,
+                ignoreCertErrors: !config.strictSsl
+            }, !!config.target.scp, logger);
         }
         const adtService = yield provider.getAdtService(axios_extension_1.TransportRequestService);
         const transportRequest = yield (adtService === null || adtService === void 0 ? void 0 : adtService.createTransportRequest({
@@ -316,7 +181,10 @@ exports.createTransportRequest = createTransportRequest;
  */
 function runCommand(command, config, logger, archive = Buffer.from('')) {
     return __awaiter(this, void 0, void 0, function* () {
-        const provider = yield getAbapServiceProvider(config, logger);
+        const provider = 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);
     });

package/dist/base/prompt.d.ts

@@ -1,5 +1,3 @@
-import type { ServiceInfo } from '@sap-ux/btp-utils';
-import prompts from 'prompts';
 /**
  * Prompt for confirmation.
  *
@@ -7,17 +5,4 @@ import prompts from 'prompts';
  * @returns true if confirmed, otherwise false
  */
 export declare function promptConfirmation(message: string): Promise<boolean>;
-/**
- * Prompt for username and password.
- *
- * @param username - optional username that is to be offered as default
- * @returns credentials object with username/password
- */
-export declare function promptCredentials(username?: string): Promise<prompts.Answers<"username" | "password">>;
-/**
- * Prompt for the location of the service keys.
- *
- * @returns credentials object with service keys
- */
-export declare function promptServiceKeys(): Promise<ServiceInfo>;
 //# sourceMappingURL=prompt.d.ts.map

package/dist/base/prompt.js

@@ -12,8 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptServiceKeys = exports.promptCredentials = exports.promptConfirmation = void 0;
-const fs_1 = require("fs");
+exports.promptConfirmation = void 0;
 const prompts_1 = __importDefault(require("prompts"));
 /**
  * Prompt for confirmation.
@@ -39,48 +38,4 @@ function promptConfirmation(message) {
     });
 }
 exports.promptConfirmation = promptConfirmation;
-/**
- * Prompt for username and password.
- *
- * @param username - optional username that is to be offered as default
- * @returns credentials object with username/password
- */
-function promptCredentials(username) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const credentials = yield (0, prompts_1.default)([
-            {
-                type: 'text',
-                name: 'username',
-                initial: username,
-                message: 'Username:'
-            },
-            {
-                type: 'password',
-                name: 'password',
-                message: 'Password:'
-            }
-        ]);
-        return credentials;
-    });
-}
-exports.promptCredentials = promptCredentials;
-/**
- * Prompt for the location of the service keys.
- *
- * @returns credentials object with service keys
- */
-function promptServiceKeys() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { path } = yield (0, prompts_1.default)([
-            {
-                type: 'text',
-                name: 'path',
-                message: 'Please provide the service keys as file:',
-                validate: (input) => (0, fs_1.existsSync)(input)
-            }
-        ]);
-        return JSON.parse((0, fs_1.readFileSync)(path, 'utf-8'));
-    });
-}
-exports.promptServiceKeys = promptServiceKeys;
 //# sourceMappingURL=prompt.js.map

package/dist/cli/config.js

@@ -138,7 +138,7 @@ function mergeTarget(baseTarget, options) {
     return {
         url: targetUrl,
         client: (_b = options.client) !== null && _b !== void 0 ? _b : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.client,
-        cloud: options.cloud !== undefined ? options.cloud : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.cloud,
+        scp: options.cloud !== undefined ? options.cloud : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.cloud,
         destination: (_c = options.destination) !== null && _c !== void 0 ? _c : baseTarget === null || baseTarget === void 0 ? void 0 : baseTarget.destination,
         serviceKey: getServiceKey(options, targetUrl),
         params: options.queryParams ? parseQueryParams(options.queryParams) : undefined,

package/dist/types/index.d.ts

@@ -1,18 +1,7 @@
-import type { AxiosRequestConfig, BspConfig, ServiceInfo } from '@sap-ux/axios-extension';
+import type { AxiosRequestConfig, BspConfig } from '@sap-ux/axios-extension';
 import type { LogLevel } from '@sap-ux/logger';
+import type { AbapTarget as BaseAbapTarget, DestinationAbapTarget, UrlAbapTarget } from '@sap-ux/system-access';
 export declare const NAME = "abap-deploy-task";
-export interface UrlAbapTarget {
-    url: string;
-    client?: string;
-    service?: string;
-    cloud?: boolean;
-    serviceKey?: ServiceInfo;
-    params?: AxiosRequestConfig['params'];
-}
-export interface DestinationAbapTarget {
-    destination: string;
-}
-export type AbapTarget = (UrlAbapTarget & Partial<DestinationAbapTarget>) | (DestinationAbapTarget & Partial<UrlAbapTarget>);
 export interface CommonOptions {
     /**
      * Deploy with test mode true i.e. everything is sent to the backend but the backend only checks the inputs without a real deployment
@@ -55,20 +44,29 @@ export interface CommonOptions {
      */
     createTransport?: boolean;
 }
+/**
+ * Enhancing the target with an optional service property allowing to use an alias for the deployment service.
+ */
+export type AbapTarget = BaseAbapTarget & {
+    service?: string;
+};
 export interface AbapDeployConfig extends CommonOptions {
     target: AbapTarget;
     app: BspConfig;
     credentials?: AxiosRequestConfig['auth'];
+    exclude?: string[];
 }
-export interface CliOptions extends Partial<BspConfig>, Partial<DestinationAbapTarget>, Pick<Partial<UrlAbapTarget>, Exclude<keyof UrlAbapTarget, 'serviceKey'>>, Partial<CommonOptions> {
+export interface CliOptions extends Partial<BspConfig>, Partial<DestinationAbapTarget>, Pick<Partial<UrlAbapTarget>, Exclude<keyof UrlAbapTarget, 'serviceKey' | 'scp'>>, Partial<CommonOptions> {
     config?: string;
     archiveFolder?: string;
     archivePath?: string;
     archiveUrl?: string;
     cloudServiceKey?: string;
     queryParams?: string;
+    cloud?: boolean;
     cloudServiceEnv?: boolean;
     username?: string;
     password?: string;
+    service?: string;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/ui5/archive.d.ts

@@ -8,7 +8,8 @@ import type { DuplexCollection } from '@ui5/fs';
  * @param logger - reference to the logger instance
  * @param workspace - reference to the UI5 tooling workspace object
  * @param projectName - project properties and configuration
+ * @param exclude - array of regex patterns used to exclude folders from archive
  * @returns {*}  {Promise<Buffer>} - archive
  */
-export declare function createUi5Archive(logger: ToolsLogger, workspace: DuplexCollection, projectName: string): Promise<Buffer>;
+export declare function createUi5Archive(logger: ToolsLogger, workspace: DuplexCollection, projectName: string, exclude?: string[]): Promise<Buffer>;
 //# sourceMappingURL=archive.d.ts.map

package/dist/ui5/archive.js

@@ -18,19 +18,22 @@ const base_1 = require("../base");
  * @param logger - reference to the logger instance
  * @param workspace - reference to the UI5 tooling workspace object
  * @param projectName - project properties and configuration
+ * @param exclude - array of regex patterns used to exclude folders from archive
  * @returns {*}  {Promise<Buffer>} - archive
  */
-function createUi5Archive(logger, workspace, projectName) {
+function createUi5Archive(logger, workspace, projectName, exclude = []) {
     return __awaiter(this, void 0, void 0, function* () {
         logger.info('Creating archive with UI5 build result.');
         const prefix = `/resources/${projectName}/`;
         const zip = new yazl_1.ZipFile();
         const resources = yield workspace.byGlob(`${prefix}**/*`);
         for (const resource of resources) {
-            const path = resource.getPath().replace(prefix, '');
-            logger.debug(`Adding ${path}`);
-            const buffer = yield resource.getBuffer();
-            zip.addBuffer(buffer, path);
+            if (!exclude.some((regex) => RegExp(regex, 'g').exec(resource.getPath()))) {
+                const path = resource.getPath().replace(prefix, '');
+                logger.debug(`Adding ${path}`);
+                const buffer = yield resource.getBuffer();
+                zip.addBuffer(buffer, path);
+            }
         }
         logger.info('Archive created.');
         return (0, base_1.createBuffer)(zip);

package/dist/ui5/index.js

@@ -35,7 +35,7 @@ function task({ workspace, options }) {
         const config = (0, base_1.validateConfig)(options.configuration);
         (0, base_1.replaceEnvVariables)(config);
         // The calling client can use either the projectNamespace or projectName when creating the workspace, needs to match when creating the archive.
-        const archive = yield (0, archive_1.createUi5Archive)(logger, workspace, (_e = options.projectNamespace) !== null && _e !== void 0 ? _e : options.projectName);
+        const archive = yield (0, archive_1.createUi5Archive)(logger, workspace, (_e = options.projectNamespace) !== null && _e !== void 0 ? _e : options.projectName, config.exclude);
         yield (0, base_1.deploy)(archive, config, logger);
     });
 }

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.9.4",
+  "version": "0.9.6",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -34,12 +34,13 @@
     "@sap-ux/axios-extension": "1.4.1",
     "@sap-ux/btp-utils": "0.11.8",
     "@sap-ux/logger": "0.3.7",
-    "@sap-ux/store": "0.3.12",
+    "@sap-ux/system-access": "0.2.0",
     "@sap-ux/ui5-config": "0.19.0"
   },
   "devDependencies": {
     "@types/prompts": "2.0.14",
-    "@types/yazl": "2.4.2"
+    "@types/yazl": "2.4.2",
+    "@sap-ux/store": "0.3.12"
   },
   "ui5": {
     "dependencies": []