@sap-ux/adp-tooling 0.1.3 → 0.1.5

package/dist/base/prompt.d.ts

@@ -1,6 +1,8 @@
-import type { ServiceInfo } from '@sap-ux/btp-utils';
-import prompts from 'prompts';
 import type { AdpWriterConfig } from '../types';
+export declare const enum flexLayer {
+    CUSTOMER_BASE = "CUSTOMER_BASE",
+    VENDOR = "VENDOR"
+}
 /**
  * Prompt the user for the required properties for an adaptation project.
  *
@@ -15,17 +17,4 @@ export declare function promptGeneratorInput({ id, reference, url }?: {
     reference?: string;
     url?: string;
 }): Promise<AdpWriterConfig>;
-/**
- * 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<"password" | "username">>;
-/**
- * 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.promptGeneratorInput = void 0;
-const fs_1 = require("fs");
+exports.promptGeneratorInput = void 0;
 const prompts_1 = __importDefault(require("prompts"));
 /**
  * Prompt the user for the required properties for an adaptation project.
@@ -84,48 +83,4 @@ function promptGeneratorInput({ id, reference, url } = {}) {
     });
 }
 exports.promptGeneratorInput = promptGeneratorInput;
-/**
- * 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/preview/adp-preview.js

@@ -8,10 +8,55 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdpPreview = void 0;
 const yazl_1 = require("yazl");
-const service_1 = require("./service");
+const system_access_1 = require("@sap-ux/system-access");
+/**
+ * Create a buffer based on the given zip file object.
+ *
+ * @param zip object representing a zip file
+ * @returns a buffer
+ */
+function createBuffer(zip) {
+    var _a, e_1, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        yield new Promise((resolve) => {
+            zip.end({ forceZip64Format: false }, () => {
+                resolve();
+            });
+        });
+        const chunks = [];
+        try {
+            for (var _d = true, _e = __asyncValues(zip.outputStream), _f; _f = yield _e.next(), _a = _f.done, !_a;) {
+                _c = _f.value;
+                _d = false;
+                try {
+                    const chunk = _c;
+                    chunks.push(chunk);
+                }
+                finally {
+                    _d = true;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return Buffer.concat(chunks);
+    });
+}
 /**
  * Instance of an adaptation project handling requests and data transformation.
  */
@@ -67,14 +112,14 @@ class AdpPreview {
      */
     init(descriptorVariant) {
         return __awaiter(this, void 0, void 0, function* () {
-            const provider = yield (0, service_1.createProvider)(this.config, this.logger);
+            const provider = yield (0, system_access_1.createAbapServiceProvider)(this.config.target, { ignoreCertErrors: this.config.ignoreCertErrors }, true, this.logger);
             const lrep = provider.getLayeredRepository();
             const zip = new yazl_1.ZipFile();
             const files = yield this.project.byGlob('**/*.*');
             for (const file of files) {
                 zip.addBuffer(yield file.getBuffer(), file.getPath().substring(1));
             }
-            const buffer = yield (0, service_1.createBuffer)(zip);
+            const buffer = yield createBuffer(zip);
             // validate namespace & layer combination and fetch csrf token
             yield lrep.isExistingVariant(descriptorVariant.namespace, descriptorVariant.layer);
             this.mergedDescriptor = (yield lrep.mergeAppDescriptorVariant(buffer))[descriptorVariant.id];

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import type { UI5FlexLayer } from '@sap-ux/project-access';
+import type { DestinationAbapTarget, UrlAbapTarget } from '@sap-ux/system-access';
 export interface DescriptorVariant {
     layer: UI5FlexLayer;
     reference: string;
@@ -6,15 +7,10 @@ export interface DescriptorVariant {
     namespace: string;
     content: object[];
 }
-export interface UrlAbapTarget {
-    url: string;
-    client?: string;
-    scp?: boolean;
-}
-export interface DestinationAbapTarget {
-    destination: string;
-}
-export type AbapTarget = (UrlAbapTarget & Partial<DestinationAbapTarget>) | (DestinationAbapTarget & Partial<UrlAbapTarget>);
+/**
+ * Reduce the options exposed as target configuration.
+ */
+type AbapTarget = DestinationAbapTarget | Pick<UrlAbapTarget, 'url' | 'client' | 'scp'>;
 export interface AdpPreviewConfig {
     target: AbapTarget;
     /**
@@ -38,4 +34,5 @@ export interface AdpWriterConfig {
         description?: string;
     };
 }
+export {};
 //# sourceMappingURL=types.d.ts.map

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%3Aadp-tooling"
   },
-  "version": "0.1.3",
+  "version": "0.1.5",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -29,10 +29,9 @@
     "prompts": "2.4.2",
     "yazl": "2.5.1",
     "@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/ui5-config": "0.18.2"
+    "@sap-ux/system-access": "0.2.0",
+    "@sap-ux/ui5-config": "0.19.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.0",
@@ -47,7 +46,8 @@
     "nock": "13.2.1",
     "rimraf": "5.0.1",
     "supertest": "6.3.2",
-    "@sap-ux/project-access": "1.11.1"
+    "@sap-ux/project-access": "1.11.2",
+    "@sap-ux/store": "0.3.12"
   },
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",

package/dist/preview/service.d.ts

@@ -1,42 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type { Logger } from '@sap-ux/logger';
-import type { BackendSystem } from '@sap-ux/store';
-import type { AbapTarget, AdpPreviewConfig, UrlAbapTarget } from '../types';
-import type { AbapServiceProvider } from '@sap-ux/axios-extension';
-import type { ZipFile } from 'yazl';
-type BasicAuth = Required<Pick<BackendSystem, 'username' | 'password'>>;
-type ServiceAuth = Required<Pick<BackendSystem, 'serviceKeys' | 'name'>> & {
-    refreshToken?: string;
-};
-/**
- * Create a buffer based on the given zip file object.
- *
- * @param zip object representing a zip file
- * @returns a buffer
- */
-export declare function createBuffer(zip: ZipFile): Promise<Buffer>;
-/**
- * Check the secure storage if it has credentials for the given target.
- *
- * @param target ABAP target
- * @returns credentials from the store or undefined.
- */
-export declare function getCredentials<T extends BasicAuth | ServiceAuth | undefined>(target: UrlAbapTarget): Promise<T | undefined>;
-/**
- * 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;
-/**
- * Create an instance of a UI5AbapRepository service connected to the given target configuration.
- *
- * @param config - deployment configuration
- * @param logger - optional reference to the logger instance
- * @returns service instance
- */
-export declare function createProvider(config: AdpPreviewConfig, logger: Logger): Promise<AbapServiceProvider>;
-export {};
-//# sourceMappingURL=service.d.ts.map

package/dist/preview/service.js

@@ -1,205 +0,0 @@
-"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 __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProvider = exports.isUrlTarget = exports.getCredentials = exports.createBuffer = void 0;
-const store_1 = require("@sap-ux/store");
-const btp_utils_1 = require("@sap-ux/btp-utils");
-const axios_extension_1 = require("@sap-ux/axios-extension");
-const prompt_1 = require("../base/prompt");
-/**
- * Create a buffer based on the given zip file object.
- *
- * @param zip object representing a zip file
- * @returns a buffer
- */
-function createBuffer(zip) {
-    var _a, e_1, _b, _c;
-    return __awaiter(this, void 0, void 0, function* () {
-        yield new Promise((resolve) => {
-            zip.end({ forceZip64Format: false }, () => {
-                resolve();
-            });
-        });
-        const chunks = [];
-        try {
-            for (var _d = true, _e = __asyncValues(zip.outputStream), _f; _f = yield _e.next(), _a = _f.done, !_a;) {
-                _c = _f.value;
-                _d = false;
-                try {
-                    const chunk = _c;
-                    chunks.push(chunk);
-                }
-                finally {
-                    _d = true;
-                }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-        return Buffer.concat(chunks);
-    });
-}
-exports.createBuffer = createBuffer;
-/**
- * Check the secure storage if it has credentials for the given target.
- *
- * @param target ABAP target
- * @returns credentials from the store or undefined.
- */
-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 logger - reference to the logger instance
- * @returns an abap service provider
- */
-function createAbapCloudServiceProvider(options, target, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const providerConfig = Object.assign(Object.assign({}, options), { environment: axios_extension_1.AbapCloudEnvironment.Standalone });
-        // first try reading the keys from the store
-        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`);
-        }
-        // next prompt the user for the keys
-        if (!storedOpts) {
-            providerConfig.service = yield (0, prompt_1.promptServiceKeys)();
-        }
-        // if no keys are available throw and error
-        if (providerConfig.service) {
-            return (0, axios_extension_1.createForAbapOnCloud)(providerConfig);
-        }
-        else {
-            throw new Error('Service keys required for deployment to an ABAP Cloud environment.');
-        }
-    });
-}
-/**
- * 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
- * @param logger reference to the logger instance
- * @returns an ABAPServiceProvider instance
- */
-function createAbapServiceProvider(options, target, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        options.baseURL = target.url;
-        if (target.client) {
-            options.params['sap-client'] = target.client;
-        }
-        if (!options.auth) {
-            let storedOpts;
-            try {
-                storedOpts = yield getCredentials(target);
-            }
-            catch (error) {
-                logger.debug('Could not read credentials from store.');
-                // something went wrong but it doesn't matter, we just prompt the user
-            }
-            if ((storedOpts === null || storedOpts === void 0 ? void 0 : storedOpts.username) && (storedOpts === null || storedOpts === void 0 ? void 0 : storedOpts.password)) {
-                options.auth = {
-                    username: storedOpts.username,
-                    password: storedOpts.password
-                };
-            }
-            else {
-                const credentials = yield (0, prompt_1.promptCredentials)(storedOpts === null || storedOpts === void 0 ? void 0 : storedOpts.username);
-                options.auth = credentials;
-                process.env.FIORI_TOOLS_USER = credentials.username;
-                process.env.FIORI_TOOLS_PASSWORD = credentials.password;
-            }
-        }
-        return (0, axios_extension_1.createForAbap)(options);
-    });
-}
-/**
- * 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;
-/**
- * Create an instance of a UI5AbapRepository service connected to the given target configuration.
- *
- * @param config - deployment configuration
- * @param logger - optional reference to the logger instance
- * @returns service instance
- */
-function createProvider(config, logger) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let provider;
-        const options = {
-            params: {},
-            ignoreCertErrors: config.ignoreCertErrors
-        };
-        // 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 (isUrlTarget(config.target)) {
-            if (config.target.scp) {
-                provider = yield createAbapCloudServiceProvider(options, config.target, logger);
-            }
-            else {
-                provider = yield createAbapServiceProvider(options, config.target, logger);
-            }
-        }
-        else {
-            throw new Error('Unable to handle the configuration in the current environment.');
-        }
-        return provider;
-    });
-}
-exports.createProvider = createProvider;
-//# sourceMappingURL=service.js.map