@sap-ux/adp-tooling 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,12 @@
+#  `@sap-ux/adp-tooling`
+
+Module containing different tooling modules helpful when working with SAP UI5 adaptation projects.
+
+## preview
+The submodule preview contains functionality allowing to preview adaptation projects. It is not a standalone UI5 middleware but designed to be integrated into the `@sap-ux/preview-middleware.`.
+
+## writer
+The submodule writer contains functionality to generate the core project structure of an SAP UI5 adaptation project. It is not a standalone generator but designed to be integrated into `@sap-ux/create` or any kind of yeoman generator.
+
+## base
+The submodule contains functionality required in different scenarios, e.g. prompting for generation or when initializing the preview.

package/dist/base/prompt.d.ts

@@ -0,0 +1,31 @@
+import type { ServiceInfo } from '@sap-ux/btp-utils';
+import prompts from 'prompts';
+import type { AdpWriterConfig } from '../types';
+/**
+ * Prompt the user for the required properties for an adaptation project.
+ *
+ * @param defaults optional default values for the prompts
+ * @param defaults.id initial id to be used for the new adaptation id prompt
+ * @param defaults.reference initial id used for the original application id prompt
+ * @param defaults.url initial url used for the target url prompt
+ * @returns a configuration for the adp writer
+ */
+export declare function promptGeneratorInput({ id, reference, url }?: {
+    id?: string;
+    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

@@ -0,0 +1,131 @@
+"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 };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptServiceKeys = exports.promptCredentials = exports.promptGeneratorInput = void 0;
+const fs_1 = require("fs");
+const prompts_1 = __importDefault(require("prompts"));
+/**
+ * Prompt the user for the required properties for an adaptation project.
+ *
+ * @param defaults optional default values for the prompts
+ * @param defaults.id initial id to be used for the new adaptation id prompt
+ * @param defaults.reference initial id used for the original application id prompt
+ * @param defaults.url initial url used for the target url prompt
+ * @returns a configuration for the adp writer
+ */
+function promptGeneratorInput({ id, reference, url } = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const app = yield (0, prompts_1.default)([
+            {
+                type: 'select',
+                choices: [
+                    { title: "CUSTOMER_BASE" /* flexLayer.CUSTOMER_BASE */, value: "CUSTOMER_BASE" /* flexLayer.CUSTOMER_BASE */ },
+                    { title: "VENDOR" /* flexLayer.VENDOR */, value: "VENDOR" /* flexLayer.VENDOR */ }
+                ],
+                name: 'layer',
+                message: 'Flex layer:'
+            },
+            {
+                type: 'text',
+                name: 'id',
+                message: (_prev, values) => {
+                    if (values.layer === "CUSTOMER_BASE" /* flexLayer.CUSTOMER_BASE */) {
+                        return 'New adaptation id (CUSTOMER_BASE selected, customer prefix will be automatically added to the id):';
+                    }
+                    else {
+                        return 'New adaptation id:';
+                    }
+                },
+                initial: id,
+                format: (input, values) => {
+                    if (values.layer === "CUSTOMER_BASE" /* flexLayer.CUSTOMER_BASE */ && !input.startsWith('customer.')) {
+                        return `customer.${input}`;
+                    }
+                    else {
+                        return input;
+                    }
+                },
+                validate: (input) => (input === null || input === void 0 ? void 0 : input.length) > 0
+            },
+            {
+                type: 'text',
+                name: 'reference',
+                message: 'Original application id:',
+                initial: reference,
+                validate: (input) => (input === null || input === void 0 ? void 0 : input.length) > 0
+            },
+            {
+                type: 'text',
+                name: 'title',
+                message: 'Application title:'
+            }
+        ]);
+        const target = yield (0, prompts_1.default)([
+            {
+                type: 'text',
+                name: 'url',
+                message: 'Target system url:',
+                initial: url,
+                validate: (input) => (input === null || input === void 0 ? void 0 : input.length) > 0
+            }
+        ]);
+        return { app, target };
+    });
+}
+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/index.d.ts

@@ -0,0 +1,5 @@
+export { AdpPreviewConfig, AdpWriterConfig } from './types';
+export * from './preview/adp-preview';
+export { generate } from './writer';
+export * from './base/prompt';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generate = void 0;
+__exportStar(require("./preview/adp-preview"), exports);
+var writer_1 = require("./writer");
+Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return writer_1.generate; } });
+__exportStar(require("./base/prompt"), exports);
+//# sourceMappingURL=index.js.map

package/dist/preview/adp-preview.d.ts

@@ -0,0 +1,51 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { AdpPreviewConfig, DescriptorVariant } from '../types';
+import type { NextFunction, Request, Response } from 'express';
+import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
+import type { Resource } from '@ui5/fs';
+import type { UI5FlexLayer } from '@sap-ux/project-access';
+/**
+ * Instance of an adaptation project handling requests and data transformation.
+ */
+export declare class AdpPreview {
+    private readonly config;
+    private readonly logger;
+    /**
+     * Merged descriptor variant with reference app manifest
+     */
+    private mergedDescriptor;
+    /**
+     * @returns merged manifest.
+     */
+    get descriptor(): MergedAppDescriptor;
+    /**
+     * @returns a list of resources required to the adaptation project as well as the original app.
+     */
+    get resources(): {
+        [x: string]: string;
+    };
+    /**
+     * Constructor taking the config and a logger as input.
+     *
+     * @param config adp config
+     * @param logger logger instance
+     */
+    constructor(config: AdpPreviewConfig, logger: ToolsLogger);
+    /**
+     * Fetch all required configurations from the backend and initialize all configurations.
+     *
+     * @param descriptorVariant descriptor variant from the project
+     * @param files all relevant project files (e.g. webapp content)
+     * @returns the UI5 flex layer for which editing is enabled
+     */
+    init(descriptorVariant: DescriptorVariant, files: Resource[]): Promise<UI5FlexLayer>;
+    /**
+     * Proxy for the merged application manifest.json and blocking of preload files.
+     *
+     * @param req incoming request
+     * @param res outgoing response object
+     * @param next next middleware that is to be called if the request cannot be handled
+     */
+    proxy(req: Request, res: Response, next: NextFunction): void;
+}
+//# sourceMappingURL=adp-preview.d.ts.map

package/dist/preview/adp-preview.js

@@ -0,0 +1,104 @@
+"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.AdpPreview = void 0;
+const yazl_1 = require("yazl");
+const service_1 = require("./service");
+/**
+ * Instance of an adaptation project handling requests and data transformation.
+ */
+class AdpPreview {
+    /**
+     * @returns merged manifest.
+     */
+    get descriptor() {
+        if (this.mergedDescriptor) {
+            return this.mergedDescriptor;
+        }
+        else {
+            throw new Error('Not initialized');
+        }
+    }
+    /**
+     * @returns a list of resources required to the adaptation project as well as the original app.
+     */
+    get resources() {
+        if (this.mergedDescriptor) {
+            const resources = {
+                [this.mergedDescriptor.name]: this.mergedDescriptor.url,
+                [this.mergedDescriptor.manifest['sap.app'].id]: this.mergedDescriptor.url
+            };
+            this.mergedDescriptor.asyncHints.libs.forEach((lib) => {
+                var _a;
+                if ((_a = lib.url) === null || _a === void 0 ? void 0 : _a.url) {
+                    resources[lib.name] = lib.url.url;
+                }
+            });
+            return resources;
+        }
+        else {
+            throw new Error('Not initialized');
+        }
+    }
+    /**
+     * Constructor taking the config and a logger as input.
+     *
+     * @param config adp config
+     * @param logger logger instance
+     */
+    constructor(config, logger) {
+        this.config = config;
+        this.logger = logger;
+    }
+    /**
+     * Fetch all required configurations from the backend and initialize all configurations.
+     *
+     * @param descriptorVariant descriptor variant from the project
+     * @param files all relevant project files (e.g. webapp content)
+     * @returns the UI5 flex layer for which editing is enabled
+     */
+    init(descriptorVariant, files) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const provider = yield (0, service_1.createProvider)(this.config, this.logger);
+            const lrep = provider.getLayeredRepository();
+            const zip = new yazl_1.ZipFile();
+            for (const file of files) {
+                zip.addBuffer(yield file.getBuffer(), file.getPath().substring(1));
+            }
+            const buffer = yield (0, service_1.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];
+            return descriptorVariant.layer;
+        });
+    }
+    /**
+     * Proxy for the merged application manifest.json and blocking of preload files.
+     *
+     * @param req incoming request
+     * @param res outgoing response object
+     * @param next next middleware that is to be called if the request cannot be handled
+     */
+    proxy(req, res, next) {
+        if (req.path.endsWith('manifest.json')) {
+            res.status(200);
+            res.send(JSON.stringify(this.descriptor.manifest, undefined, 2));
+        }
+        else if (req.path.endsWith('Component-preload.js')) {
+            res.status(404).send();
+        }
+        else {
+            next();
+        }
+    }
+}
+exports.AdpPreview = AdpPreview;
+//# sourceMappingURL=adp-preview.js.map

package/dist/preview/service.d.ts

@@ -0,0 +1,42 @@
+/// <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

@@ -0,0 +1,205 @@
+"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

package/dist/types.d.ts

@@ -0,0 +1,41 @@
+import type { UI5FlexLayer } from '@sap-ux/project-access';
+export interface DescriptorVariant {
+    layer: UI5FlexLayer;
+    reference: string;
+    id: string;
+    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>);
+export interface AdpPreviewConfig {
+    target: AbapTarget;
+    /**
+     * If set to true then certification validation errors are ignored.
+     */
+    ignoreCertErrors?: boolean;
+}
+export interface AdpWriterConfig {
+    app: {
+        id: string;
+        reference: string;
+        layer?: UI5FlexLayer;
+        title?: string;
+    };
+    target: AbapTarget;
+    ui5?: {
+        minVersion?: string;
+    };
+    package?: {
+        name?: string;
+        description?: string;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/writer/index.d.ts

@@ -0,0 +1,12 @@
+import type { Editor } from 'mem-fs-editor';
+import type { AdpWriterConfig } from '../types';
+/**
+ * Writes the adp-project template to the memfs editor instance.
+ *
+ * @param basePath - the base path
+ * @param config - the writer configuration
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
+ */
+export declare function generate(basePath: string, config: AdpWriterConfig, fs?: Editor): Promise<Editor>;
+//# sourceMappingURL=index.d.ts.map

package/dist/writer/index.js

@@ -0,0 +1,97 @@
+"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.generate = void 0;
+const path_1 = require("path");
+const mem_fs_1 = require("mem-fs");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+/**
+ * Set default values for optional properties.
+ *
+ * @param config configuration provided by the calling middleware
+ * @returns enhanced configuration with default values
+ */
+function setDefaults(config) {
+    var _a, _b, _c, _d, _e;
+    var _f, _g, _h, _j;
+    const configWithDefaults = {
+        app: Object.assign({}, config.app),
+        target: Object.assign({}, config.target),
+        ui5: Object.assign({}, config.ui5)
+    };
+    (_a = (_f = configWithDefaults.app).title) !== null && _a !== void 0 ? _a : (_f.title = `Adaptation of ${config.app.reference}`);
+    (_b = (_g = configWithDefaults.app).layer) !== null && _b !== void 0 ? _b : (_g.layer = 'CUSTOMER_BASE');
+    (_c = configWithDefaults.package) !== null && _c !== void 0 ? _c : (configWithDefaults.package = config.package ? Object.assign({}, config.package) : {});
+    (_d = (_h = configWithDefaults.package).name) !== null && _d !== void 0 ? _d : (_h.name = config.app.id.toLowerCase().replace(/\./g, '-'));
+    (_e = (_j = configWithDefaults.package).description) !== null && _e !== void 0 ? _e : (_j.description = configWithDefaults.app.title);
+    return configWithDefaults;
+}
+/**
+ * Writes the adp-project template to the memfs editor instance.
+ *
+ * @param basePath - the base path
+ * @param config - the writer configuration
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
+ */
+function generate(basePath, config, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs) {
+            fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+        }
+        const tmplPath = (0, path_1.join)(__dirname, '../../templates');
+        const fullConfig = setDefaults(config);
+        fs.copyTpl((0, path_1.join)(tmplPath, '**/*.*'), (0, path_1.join)(basePath), fullConfig, undefined, {
+            globOptions: { dot: true },
+            processDestinationPath: (filePath) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
+        });
+        // ui5.yaml
+        const ui5ConfigPath = (0, path_1.join)(basePath, 'ui5.yaml');
+        const ui5Config = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5ConfigPath));
+        ui5Config.addCustomMiddleware([
+            {
+                name: 'preview-middleware',
+                afterMiddleware: 'compression',
+                configuration: {
+                    adp: {
+                        target: fullConfig.target,
+                        ignoreCertErrors: false
+                    }
+                }
+            },
+            {
+                name: 'ui5-proxy-middleware',
+                afterMiddleware: 'preview-middleware',
+                configuration: {
+                    ui5: {
+                        path: ['/resources', '/test-resources'],
+                        url: 'https://ui5.sap.com'
+                    }
+                }
+            },
+            {
+                name: 'backend-proxy-middleware',
+                afterMiddleware: 'preview-middleware',
+                configuration: {
+                    backend: Object.assign(Object.assign({}, fullConfig.target), { path: '/sap' }),
+                    options: {
+                        secure: true
+                    }
+                }
+            }
+        ]);
+        fs.write(ui5ConfigPath, ui5Config.toString());
+        return fs;
+    });
+}
+exports.generate = generate;
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@sap-ux/adp-tooling",
+  "description": "Tooling for UI5 adaptation projects",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/adp-tooling"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aadp-tooling"
+  },
+  "version": "0.1.0",
+  "license": "Apache-2.0",
+  "author": "@SAP/ux-tools-team",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "ui5.yaml",
+    "bin",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "ejs": "3.1.7",
+    "mem-fs": "2.1.0",
+    "mem-fs-editor": "9.4.0",
+    "prompts": "2.4.2",
+    "yazl": "2.5.1",
+    "@sap-ux/axios-extension": "1.4.0",
+    "@sap-ux/btp-utils": "0.11.7",
+    "@sap-ux/logger": "0.3.7",
+    "@sap-ux/store": "0.3.12",
+    "@sap-ux/ui5-config": "0.18.2"
+  },
+  "devDependencies": {
+    "@types/ejs": "3.1.0",
+    "@types/express": "4.17.13",
+    "@types/mem-fs": "1.1.2",
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/prompts": "2.0.14",
+    "@types/supertest": "2.0.12",
+    "@types/yazl": "2.4.2",
+    "dotenv": "16.0.0",
+    "express": "4.18.2",
+    "nock": "13.2.1",
+    "rimraf": "5.0.1",
+    "supertest": "6.3.2",
+    "@sap-ux/project-access": "1.10.1"
+  },
+  "engines": {
+    "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
+    "node": ">= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0 || >=18.0.0 < 19.0.0"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc --watch",
+    "clean": "rimraf --glob dist test/test-output coverage *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors --testPathPattern=test/unit",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}