@sap-ux/adp-tooling 0.10.6 → 0.10.8

package/dist/types.d.ts

@@ -2,6 +2,7 @@ import type { UI5FlexLayer } from '@sap-ux/project-access';
 import type { DestinationAbapTarget, UrlAbapTarget } from '@sap-ux/system-access';
 import type { Adp } from '@sap-ux/ui5-config';
 import type { Editor } from 'mem-fs-editor';
+import type { OperationsType } from '@sap-ux/axios-extension';
 export interface DescriptorVariant {
     layer: UI5FlexLayer;
     reference: string;
@@ -30,11 +31,14 @@ export interface AdpWriterConfig {
     target: AbapTarget;
     ui5?: {
         minVersion?: string;
+        version?: string;
+        frameworkUrl?: string;
     };
     package?: {
         name?: string;
         description?: string;
     };
+    customConfig?: AdpCustomConfig;
     /**
      * Optional: configuration for deployment to ABAP
      */
@@ -308,5 +312,11 @@ export interface AdpProjectData {
     reference: string;
     id: string;
 }
+export interface AdpCustomConfig {
+    adp: {
+        safeMode: boolean;
+        environment: OperationsType;
+    };
+}
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/writer/index.js

@@ -13,8 +13,7 @@ exports.migrate = 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");
-const options_1 = require("./options");
+const project_utils_1 = require("./project-utils");
 const tmplPath = (0, path_1.join)(__dirname, '../../templates/project');
 /**
  * Set default values for optional properties.
@@ -30,7 +29,8 @@ function setDefaults(config) {
         target: Object.assign({}, config.target),
         ui5: Object.assign({}, config.ui5),
         deploy: config.deploy ? Object.assign({}, config.deploy) : undefined,
-        options: Object.assign({}, config.options)
+        options: Object.assign({}, config.options),
+        customConfig: config.customConfig ? Object.assign({}, config.customConfig) : undefined
     };
     (_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');
@@ -39,22 +39,6 @@ function setDefaults(config) {
     (_e = (_j = configWithDefaults.package).description) !== null && _e !== void 0 ? _e : (_j.description = configWithDefaults.app.title);
     return configWithDefaults;
 }
-function writeUi5Yaml(basePath, config, fs) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // ui5.yaml
-        const ui5ConfigPath = (0, path_1.join)(basePath, 'ui5.yaml');
-        const baseUi5ConfigContent = fs.read(ui5ConfigPath);
-        const ui5Config = yield ui5_config_1.UI5Config.newInstance(baseUi5ConfigContent);
-        (0, options_1.enhanceUI5Yaml)(ui5Config, config);
-        fs.write(ui5ConfigPath, ui5Config.toString());
-        // ui5-deploy.yaml
-        if ((0, options_1.hasDeployConfig)(config)) {
-            const ui5DeployConfig = yield ui5_config_1.UI5Config.newInstance(baseUi5ConfigContent);
-            (0, options_1.enhanceUI5DeployYaml)(ui5DeployConfig, config);
-            fs.write((0, path_1.join)(basePath, 'ui5-deploy.yaml'), ui5DeployConfig.toString());
-        }
-    });
-}
 /**
  * Writes the adp-project template to the mem-fs-editor instance.
  *
@@ -69,11 +53,9 @@ function generate(basePath, config, fs) {
             fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
         }
         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')
-        });
-        yield writeUi5Yaml(basePath, fullConfig, fs);
+        (0, project_utils_1.writeTemplateToFolder)((0, path_1.join)(tmplPath, '**/*.*'), (0, path_1.join)(basePath), fullConfig, fs);
+        yield (0, project_utils_1.writeUI5DeployYaml)(basePath, fullConfig, fs);
+        yield (0, project_utils_1.writeUI5Yaml)(basePath, fullConfig, fs);
         return fs;
     });
 }
@@ -105,13 +87,14 @@ function migrate(basePath, config, fs) {
         });
         // delete .che folder
         if (fs.exists((0, path_1.join)(basePath, '.che/project.json'))) {
-            fs.delete((0, path_1.join)(basePath, '.che/'));
+            fs.delete((0, path_1.join)(basePath, '.che/*'));
         }
         // delete neo-app.json
         if (fs.exists((0, path_1.join)(basePath, 'neo-app.json'))) {
             fs.delete((0, path_1.join)(basePath, 'neo-app.json'));
         }
-        yield writeUi5Yaml(basePath, fullConfig, fs);
+        yield (0, project_utils_1.writeUI5Yaml)(basePath, fullConfig, fs);
+        yield (0, project_utils_1.writeUI5DeployYaml)(basePath, fullConfig, fs);
         return fs;
     });
 }

package/dist/writer/options.d.ts

@@ -1,5 +1,5 @@
 import type { UI5Config } from '@sap-ux/ui5-config';
-import type { AdpWriterConfig } from '../types';
+import type { AdpCustomConfig, AdpWriterConfig } from '../types';
 /**
  * Generate the configuration for the middlewares required for the ui5.yaml.
  *
@@ -27,5 +27,12 @@ export declare function hasDeployConfig(config: AdpWriterConfig): config is AdpW
  * @param config full project configuration
  */
 export declare function enhanceUI5DeployYaml(ui5Config: UI5Config, config: AdpWriterConfigWithDeploy): void;
+/**
+ * Generate custom configuration required for the ui5.yaml.
+ *
+ * @param ui5Config configuration representing the ui5.yaml
+ * @param config full project configuration
+ */
+export declare function enhanceUI5YamlWithCustomConfig(ui5Config: UI5Config, config?: AdpCustomConfig): void;
 export {};
 //# sourceMappingURL=options.d.ts.map

package/dist/writer/options.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.enhanceUI5DeployYaml = exports.hasDeployConfig = exports.enhanceUI5Yaml = void 0;
+exports.enhanceUI5YamlWithCustomConfig = exports.enhanceUI5DeployYaml = exports.hasDeployConfig = exports.enhanceUI5Yaml = void 0;
 /**
  * Generate the configuration for the middlewares required for the ui5.yaml.
  *
@@ -10,6 +10,7 @@ exports.enhanceUI5DeployYaml = exports.hasDeployConfig = exports.enhanceUI5Yaml
 function enhanceUI5Yaml(ui5Config, config) {
     var _a;
     const middlewares = ((_a = config.options) === null || _a === void 0 ? void 0 : _a.fioriTools) ? getFioriToolsMiddlwares(config) : getOpenSourceMiddlewares(config);
+    ui5Config.setConfiguration({ propertiesFileSourceEncoding: 'UTF-8' });
     ui5Config.addCustomMiddleware(middlewares);
 }
 exports.enhanceUI5Yaml = enhanceUI5Yaml;
@@ -34,6 +35,19 @@ function enhanceUI5DeployYaml(ui5Config, config) {
     ui5Config.addAbapDeployTask(config.target, config.deploy, ((_a = config.options) === null || _a === void 0 ? void 0 : _a.fioriTools) === true);
 }
 exports.enhanceUI5DeployYaml = enhanceUI5DeployYaml;
+/**
+ * Generate custom configuration required for the ui5.yaml.
+ *
+ * @param ui5Config configuration representing the ui5.yaml
+ * @param config full project configuration
+ */
+function enhanceUI5YamlWithCustomConfig(ui5Config, config) {
+    if (config === null || config === void 0 ? void 0 : config.adp) {
+        const { safeMode } = config.adp;
+        ui5Config.addCustomConfiguration('adp', { safeMode });
+    }
+}
+exports.enhanceUI5YamlWithCustomConfig = enhanceUI5YamlWithCustomConfig;
 /**
  * Get a list of required middlewares using the Fiori tools.
  *
@@ -41,10 +55,20 @@ exports.enhanceUI5DeployYaml = enhanceUI5DeployYaml;
  * @returns list of required middlewares.
  */
 function getFioriToolsMiddlwares(config) {
+    var _a, _b, _c, _d;
     return [
         {
-            name: 'fiori-tools-preview',
+            name: 'fiori-tools-appreload',
             afterMiddleware: 'compression',
+            configuration: {
+                port: 35729,
+                path: 'webapp',
+                delay: 300,
+            }
+        },
+        {
+            name: 'fiori-tools-preview',
+            afterMiddleware: 'fiori-tools-appreload',
             configuration: {
                 adp: {
                     target: config.target,
@@ -58,8 +82,9 @@ function getFioriToolsMiddlwares(config) {
             configuration: {
                 ignoreCertErrors: false,
                 ui5: {
+                    version: (_b = (_a = config === null || config === void 0 ? void 0 : config.ui5) === null || _a === void 0 ? void 0 : _a.minVersion) !== null && _b !== void 0 ? _b : '', //default to latest if version is not set
                     path: ['/resources', '/test-resources'],
-                    url: 'https://ui5.sap.com'
+                    url: (_d = (_c = config === null || config === void 0 ? void 0 : config.ui5) === null || _c === void 0 ? void 0 : _c.frameworkUrl) !== null && _d !== void 0 ? _d : 'https://ui5.sap.com'
                 },
                 backend: [
                     Object.assign(Object.assign({}, config.target), { path: '/sap' })
@@ -76,6 +101,15 @@ function getFioriToolsMiddlwares(config) {
  */
 function getOpenSourceMiddlewares(config) {
     return [
+        {
+            name: 'reload-middleware',
+            afterMiddleware: 'compression',
+            configuration: {
+                port: 35729,
+                path: 'webapp',
+                delay: 300,
+            }
+        },
         {
             name: 'preview-middleware',
             afterMiddleware: 'compression',

package/dist/writer/project-utils.d.ts

@@ -0,0 +1,31 @@
+import type { Editor } from 'mem-fs-editor';
+import { AdpWriterConfig } from '../types';
+/**
+ * Writes a given project template files within a specified folder in the project directory.
+ *
+ * @param {string} templatePath - The root path of the project template.
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfModuleData | AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export declare function writeTemplateToFolder(templatePath: string, projectPath: string, data: AdpWriterConfig, fs: Editor): void;
+/**
+ * Writes a ui5.yaml file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export declare function writeUI5Yaml(projectPath: string, data: AdpWriterConfig, fs: Editor): Promise<void>;
+/**
+ * Writes a ui5-deploy.yaml file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+export declare function writeUI5DeployYaml(projectPath: string, data: AdpWriterConfig, fs: Editor): Promise<void>;
+//# sourceMappingURL=project-utils.d.ts.map

package/dist/writer/project-utils.js

@@ -0,0 +1,86 @@
+"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.writeUI5DeployYaml = exports.writeUI5Yaml = exports.writeTemplateToFolder = void 0;
+const path_1 = require("path");
+const options_1 = require("./options");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+/**
+ * Writes a given project template files within a specified folder in the project directory.
+ *
+ * @param {string} templatePath - The root path of the project template.
+ * @param {string} projectPath - The root path of the project.
+ * @param {CfModuleData | AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+function writeTemplateToFolder(templatePath, projectPath, data, fs) {
+    try {
+        fs.copyTpl(templatePath, projectPath, data, undefined, {
+            globOptions: { dot: true },
+            processDestinationPath: (filePath) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
+        });
+    }
+    catch (e) {
+        throw new Error(`Could not write template files to folder. Reason: ${e.message}`);
+    }
+}
+exports.writeTemplateToFolder = writeTemplateToFolder;
+/**
+ * Writes a ui5.yaml file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+function writeUI5Yaml(projectPath, data, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const ui5ConfigPath = (0, path_1.join)(projectPath, 'ui5.yaml');
+            const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+            const ui5Config = yield ui5_config_1.UI5Config.newInstance(baseUi5ConfigContent);
+            (0, options_1.enhanceUI5Yaml)(ui5Config, data);
+            (0, options_1.enhanceUI5YamlWithCustomConfig)(ui5Config, data === null || data === void 0 ? void 0 : data.customConfig);
+            fs.write(ui5ConfigPath, ui5Config.toString());
+        }
+        catch (e) {
+            throw new Error(`Could not write ui5.yaml file. Reason: ${e.message}`);
+        }
+    });
+}
+exports.writeUI5Yaml = writeUI5Yaml;
+/**
+ * Writes a ui5-deploy.yaml file within a specified folder in the project directory.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {AdpWriterConfig} data - The data to be populated in the template file.
+ * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
+ * @returns {void}
+ */
+function writeUI5DeployYaml(projectPath, data, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            if ((0, options_1.hasDeployConfig)(data)) {
+                const ui5ConfigPath = (0, path_1.join)(projectPath, 'ui5.yaml');
+                const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+                const ui5DeployConfig = yield ui5_config_1.UI5Config.newInstance(baseUi5ConfigContent);
+                (0, options_1.enhanceUI5DeployYaml)(ui5DeployConfig, data);
+                fs.write((0, path_1.join)(projectPath, 'ui5-deploy.yaml'), ui5DeployConfig.toString());
+            }
+        }
+        catch (e) {
+            throw new Error(`Could not write ui5-deploy.yaml file. Reason: ${e.message}`);
+        }
+    });
+}
+exports.writeUI5DeployYaml = writeUI5DeployYaml;
+//# sourceMappingURL=project-utils.js.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.10.6",
+  "version": "0.10.8",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -29,10 +29,10 @@
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
     "adm-zip": "0.5.10",
-    "@sap-ux/axios-extension": "1.12.3",
+    "@sap-ux/axios-extension": "1.12.4",
     "@sap-ux/project-access": "1.20.0",
     "@sap-ux/logger": "0.5.1",
-    "@sap-ux/system-access": "0.3.27",
+    "@sap-ux/system-access": "0.3.29",
     "@sap-ux/ui5-config": "0.22.4",
     "@sap-ux/btp-utils": "0.14.4"
   },

package/templates/project/package.json

@@ -17,7 +17,7 @@
         "@ui5/cli": "^3.9.1"
     },
     "scripts": {
-        "build": "ui5 build --exclude-task generateFlexChangesBundle generateComponentPreload --clean-dest",
+        "build": "ui5 build --exclude-task generateFlexChangesBundle generateComponentPreload minify --clean-dest",
         "start": "<%= locals.options?.fioriTools ? 'fiori run' : 'ui5 serve' %> --open /test/flp.html#app-preview",
         "start-editor": "<%= locals.options?.fioriTools ? 'fiori run' : 'ui5 serve' %> --open /test/adaptation-editor.html"<%if (locals.deploy) {%>,
         "deploy": "ui5 build --config ui5-deploy.yaml --exclude-task <%= locals.options?.fioriTools ? 'deploy-to-abap' : 'abap-deploy-task' %> generateFlexChangesBundle generateComponentPreload --clean-dest && <%= locals.options?.fioriTools ? 'fiori deploy' : 'deploy' %> --config ui5-deploy.yaml",