@sap-ux/ui5-application-writer 0.22.3 → 0.23.0

package/dist/data/defaults.d.ts

@@ -7,31 +7,6 @@ import type { App, AppOptions, Package, UI5 } from '../types';
  * @returns {Partial<Package>} the package instance
  */
 export declare function packageDefaults(version?: string, description?: string): Partial<Package>;
-/**
- * Merges two objects. All properties from base and from extension will be present.
- * Overlapping properties will be used from extension. Arrays will be concatenated and de-duped.
- *
- * @param base - any object definition
- * @param extension - another object definition
- * @returns - a merged package defintion
- */
-export declare function mergeObjects<B, E>(base: B, extension: E): B & E;
-export declare const enum UI5_DEFAULT {
-    DEFAULT_UI5_VERSION = "",
-    DEFAULT_LOCAL_UI5_VERSION = "1.95.0",
-    MIN_UI5_VERSION = "1.60.0",
-    MIN_LOCAL_SAPUI5_VERSION = "1.76.0",
-    MIN_LOCAL_OPENUI5_VERSION = "1.52.5",
-    SAPUI5_CDN = "https://ui5.sap.com",
-    OPENUI5_CDN = "https://openui5.hana.ondemand.com",
-    TYPES_VERSION_SINCE = "1.76.0",
-    TYPES_VERSION_BEST_MIN = "1.102.0",
-    TYPES_VERSION_PREVIOUS = "1.71.15",
-    TYPES_VERSION_BEST = "1.108.0",
-    ESM_TYPES_VERSION_SINCE = "1.94.0",
-    MANIFEST_VERSION = "1.12.0",
-    BASE_COMPONENT = "sap/ui/core/UIComponent"
-}
 /**
  * Returns an app instance merged with default properties.
  *
@@ -49,23 +24,6 @@ export declare const defaultUI5Libs: string[];
  * @returns {UI5} the updated copy of UI5 instance (does not change `ui5`)
  */
 export declare function mergeUi5(ui5: Partial<UI5>, options?: Partial<AppOptions>): UI5;
-/**
- * Get the best types version for the given minUI5Version for https://www.npmjs.com/package/@sapui5/ts-types where specific versions are missing.
- *
- * @param minUI5Version the minimum UI5 version that needs to be supported
- * @returns semantic version representing the types version.
- */
-export declare function getTypesVersion(minUI5Version?: string): string;
-/**
- * Get the best types version for the given minUI5Version within a selective range, starting at 1.90.0
- * for https://www.npmjs.com/package/@sapui5/ts-types-esm
- * For the latest versions the LTS S/4 on-premise version (1.102.x) is used, for anything before we
- * match the versions as far back as available.
- *
- * @param minUI5Version the minimum UI5 version that needs to be supported
- * @returns semantic version representing the types version.
- */
-export declare function getEsmTypesVersion(minUI5Version?: string): string;
 /**
  * Retrieve the tag version of the @sap/ux-specification based on the given version.
  *

package/dist/data/defaults.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSpecTagVersion = exports.getEsmTypesVersion = exports.getTypesVersion = exports.mergeUi5 = exports.defaultUI5Libs = exports.mergeApp = exports.mergeObjects = exports.packageDefaults = void 0;
+exports.getSpecTagVersion = exports.mergeUi5 = exports.defaultUI5Libs = exports.mergeApp = exports.packageDefaults = void 0;
+const ui5_config_1 = require("@sap-ux/ui5-config");
 const mapping_json_1 = __importDefault(require("@ui5/manifest/mapping.json")); // from https://github.com/SAP/ui5-manifest/blob/master/mapping.json
 const ui5Libs_1 = require("./ui5Libs");
 const semver_1 = __importDefault(require("semver"));
@@ -32,26 +33,6 @@ function packageDefaults(version, description) {
     };
 }
 exports.packageDefaults = packageDefaults;
-/**
- * Merges two objects. All properties from base and from extension will be present.
- * Overlapping properties will be used from extension. Arrays will be concatenated and de-duped.
- *
- * @param base - any object definition
- * @param extension - another object definition
- * @returns - a merged package defintion
- */
-function mergeObjects(base, extension) {
-    return (0, mergeWith_1.default)({}, base, extension, (objValue, srcValue) => {
-        // merge and de-dup arrays
-        if (objValue instanceof Array && srcValue instanceof Array) {
-            return [...new Set([...objValue, ...srcValue])];
-        }
-        else {
-            return undefined;
-        }
-    });
-}
-exports.mergeObjects = mergeObjects;
 /**
  * Returns an app instance merged with default properties.
  *
@@ -97,54 +78,12 @@ function mergeUi5(ui5, options) {
     };
     merged.descriptorVersion = getManifestVersion(merged.minUI5Version, ui5.descriptorVersion);
     merged.typesVersion =
-        (_d = ui5.typesVersion) !== null && _d !== void 0 ? _d : ((options === null || options === void 0 ? void 0 : options.typescript) ? getEsmTypesVersion : getTypesVersion)(merged.minUI5Version);
+        (_d = ui5.typesVersion) !== null && _d !== void 0 ? _d : ((options === null || options === void 0 ? void 0 : options.typescript) ? ui5_config_1.getEsmTypesVersion : ui5_config_1.getTypesVersion)(merged.minUI5Version);
     merged.ui5Theme = (_e = ui5.ui5Theme) !== null && _e !== void 0 ? _e : 'sap_fiori_3';
     merged.ui5Libs = (0, ui5Libs_1.getUI5Libs)(ui5.ui5Libs);
     return Object.assign({}, ui5, merged);
 }
 exports.mergeUi5 = mergeUi5;
-/**
- * Get the best types version for the given minUI5Version for https://www.npmjs.com/package/@sapui5/ts-types where specific versions are missing.
- *
- * @param minUI5Version the minimum UI5 version that needs to be supported
- * @returns semantic version representing the types version.
- */
-function getTypesVersion(minUI5Version) {
-    const version = semver_1.default.coerce(minUI5Version);
-    if (!version) {
-        return `~${"1.108.0" /* UI5_DEFAULT.TYPES_VERSION_BEST */}`;
-    }
-    else if (semver_1.default.gte(version, "1.108.0" /* UI5_DEFAULT.TYPES_VERSION_BEST */)) {
-        return `~${"1.108.0" /* UI5_DEFAULT.TYPES_VERSION_BEST */}`;
-    }
-    else {
-        return semver_1.default.gte(version, "1.76.0" /* UI5_DEFAULT.TYPES_VERSION_SINCE */)
-            ? `~${semver_1.default.major(version)}.${semver_1.default.minor(version)}.${semver_1.default.patch(version)}`
-            : "1.71.15" /* UI5_DEFAULT.TYPES_VERSION_PREVIOUS */;
-    }
-}
-exports.getTypesVersion = getTypesVersion;
-/**
- * Get the best types version for the given minUI5Version within a selective range, starting at 1.90.0
- * for https://www.npmjs.com/package/@sapui5/ts-types-esm
- * For the latest versions the LTS S/4 on-premise version (1.102.x) is used, for anything before we
- * match the versions as far back as available.
- *
- * @param minUI5Version the minimum UI5 version that needs to be supported
- * @returns semantic version representing the types version.
- */
-function getEsmTypesVersion(minUI5Version) {
-    const version = semver_1.default.coerce(minUI5Version);
-    if (!version || semver_1.default.gte(version, "1.102.0" /* UI5_DEFAULT.TYPES_VERSION_BEST_MIN */)) {
-        return `~${"1.108.0" /* UI5_DEFAULT.TYPES_VERSION_BEST */}`;
-    }
-    else {
-        return semver_1.default.gte(version, "1.94.0" /* UI5_DEFAULT.ESM_TYPES_VERSION_SINCE */)
-            ? `~${semver_1.default.major(version)}.${semver_1.default.minor(version)}.0`
-            : `~${"1.94.0" /* UI5_DEFAULT.ESM_TYPES_VERSION_SINCE */}`;
-    }
-}
-exports.getEsmTypesVersion = getEsmTypesVersion;
 /**
  * Gets the miminum UI5 version based on the specified version.
  *

package/dist/data/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeWithDefaults = void 0;
+const ui5_config_1 = require("@sap-ux/ui5-config");
 const defaults_1 = require("./defaults");
 const validators_1 = require("./validators");
 /**
@@ -19,7 +20,7 @@ function mergeWithDefaults(ui5App) {
         ui5App.appOptions.codeAssist = false;
     }
     ui5App.ui5 = (0, defaults_1.mergeUi5)(ui5App.ui5 || {}, ui5App.appOptions);
-    ui5App.package = (0, defaults_1.mergeObjects)((0, defaults_1.packageDefaults)(ui5App.package.version, ui5App.app.description), ui5App.package);
+    ui5App.package = (0, ui5_config_1.mergeObjects)((0, defaults_1.packageDefaults)(ui5App.package.version, ui5App.app.description), ui5App.package);
     if (ui5App.appOptions.sapux) {
         ui5App.package.devDependencies = ui5App.package.devDependencies || {};
         ui5App.package.devDependencies['@sap/ux-specification'] = (0, defaults_1.getSpecTagVersion)(ui5App.ui5.version);

package/dist/index.js

@@ -17,7 +17,6 @@ const ui5_config_1 = require("@sap-ux/ui5-config");
 const data_1 = require("./data");
 const ui5Libs_1 = require("./data/ui5Libs");
 const options_1 = require("./options");
-const defaults_1 = require("./data/defaults");
 /**
  * Writes the template to the memfs editor instance.
  *
@@ -57,7 +56,7 @@ function generate(basePath, ui5AppConfig, fs) {
         ui5LocalConfig.addUI5Framework(ui5App.ui5.framework, ui5App.ui5.localVersion, ui5App.ui5.ui5Libs, ui5App.ui5.ui5Theme);
         ui5LocalConfig.addFioriToolsAppReloadMiddleware();
         // Add optional features
-        (0, options_1.applyOptionalFeatures)(ui5App, fs, basePath, tmplPath, [ui5Config, ui5LocalConfig]);
+        yield (0, options_1.applyOptionalFeatures)(ui5App, fs, basePath, tmplPath, [ui5Config, ui5LocalConfig]);
         // write ui5 yamls
         fs.write(ui5ConfigPath, ui5Config.toString());
         fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
@@ -116,10 +115,10 @@ function enableTypescript(basePath, fs) {
         const ui5App = {
             app: manifest['sap.app'],
             ui5: {
-                typesVersion: (0, defaults_1.getEsmTypesVersion)((_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.dependencies) === null || _b === void 0 ? void 0 : _b.minUI5Version)
+                typesVersion: (0, ui5_config_1.getEsmTypesVersion)((_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.dependencies) === null || _b === void 0 ? void 0 : _b.minUI5Version)
             }
         };
-        (0, options_1.enableTypescript)({ basePath, fs, ui5Configs: [ui5Config], tmplPath, ui5App }, true);
+        yield (0, options_1.enableTypescript)({ basePath, fs, ui5Configs: [ui5Config], tmplPath, ui5App }, true);
         fs.write(ui5ConfigPath, ui5Config.toString());
         return fs;
     });

package/dist/options.d.ts

@@ -22,13 +22,13 @@ export interface FeatureInput {
  * @param input Input required to enable the optional typescript features
  * @param keepOldComponent if set to true then the old Component.js will be renamed but kept.
  */
-export declare function enableTypescript(input: FeatureInput, keepOldComponent?: boolean): void;
+export declare function enableTypescript(input: FeatureInput, keepOldComponent?: boolean): Promise<void>;
 /**
  * Enable npm module import for the given input.
  *
  * @param input Input required to enable the optional npm modules import
  */
-export declare function enableNpmPackageConsumption(input: FeatureInput): void;
+export declare function enableNpmPackageConsumption(input: FeatureInput): Promise<void>;
 /**
  * Check if the ui5 app config requires optional features to be enabled and if yes, enable them.
  *
@@ -38,5 +38,5 @@ export declare function enableNpmPackageConsumption(input: FeatureInput): void;
  * @param tmplPath template basepath
  * @param ui5Configs available UI5 configs
  */
-export declare function applyOptionalFeatures(ui5App: Ui5App, fs: Editor, basePath: string, tmplPath: string, ui5Configs: UI5Config[]): void;
+export declare function applyOptionalFeatures(ui5App: Ui5App, fs: Editor, basePath: string, tmplPath: string, ui5Configs: UI5Config[]): Promise<void>;
 //# sourceMappingURL=options.d.ts.map

package/dist/options.js

@@ -1,11 +1,20 @@
 "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.applyOptionalFeatures = exports.enableNpmPackageConsumption = exports.enableTypescript = void 0;
 const path_1 = require("path");
 const ejs_1 = require("ejs");
-const files_1 = require("./files");
+const project_access_1 = require("@sap-ux/project-access");
 const ui5Libs_1 = require("./data/ui5Libs");
-const defaults_1 = require("./data/defaults");
+const ui5_config_1 = require("@sap-ux/ui5-config");
 /**
  * Copy all template files into the target project.
  *
@@ -17,35 +26,37 @@ const defaults_1 = require("./data/defaults");
  * @param input.tmplPath template basepath
  */
 function copyTemplates(name, { ui5App, fs, basePath, tmplPath }) {
-    const optTmplDirPath = (0, path_1.join)(tmplPath, 'optional', `${name}`);
-    const optTmplFilePaths = (0, files_1.getFilePaths)(optTmplDirPath);
-    optTmplFilePaths.forEach((optTmplFilePath) => {
-        const relPath = optTmplFilePath.replace(optTmplDirPath, '');
-        const outPath = (0, path_1.join)(basePath, relPath);
-        // Extend or add
-        if (!fs.exists(outPath)) {
-            fs.copyTpl(optTmplFilePath, outPath, ui5App, undefined, {
-                globOptions: { dot: true }
-            });
-        }
-        else {
-            const add = JSON.parse((0, ejs_1.render)(fs.read(optTmplFilePath), ui5App, {}));
-            const existingFile = JSON.parse(fs.read(outPath));
-            const merged = (0, defaults_1.mergeObjects)(existingFile, add);
-            fs.writeJSON(outPath, merged);
-        }
+    return __awaiter(this, void 0, void 0, function* () {
+        const optTmplDirPath = (0, path_1.join)(tmplPath, 'optional', `${name}`);
+        const optTmplFilePaths = yield (0, project_access_1.getFilePaths)(optTmplDirPath);
+        optTmplFilePaths.forEach((optTmplFilePath) => {
+            const relPath = optTmplFilePath.replace(optTmplDirPath, '');
+            const outPath = (0, path_1.join)(basePath, relPath);
+            // Extend or add
+            if (!fs.exists(outPath)) {
+                fs.copyTpl(optTmplFilePath, outPath, ui5App, undefined, {
+                    globOptions: { dot: true }
+                });
+            }
+            else {
+                const add = JSON.parse((0, ejs_1.render)(fs.read(optTmplFilePath), ui5App, {}));
+                const existingFile = JSON.parse(fs.read(outPath));
+                const merged = (0, ui5_config_1.mergeObjects)(existingFile, add);
+                fs.writeJSON(outPath, merged);
+            }
+        });
     });
 }
 /**
  * Factory functions for applying optional features.
  */
 const factories = {
-    codeAssist: (input) => copyTemplates('codeAssist', input),
-    eslint: (input) => copyTemplates('eslint', input),
-    loadReuseLibs: (input) => copyTemplates('loadReuseLibs', input),
-    sapux: (input) => copyTemplates('sapux', input),
-    typescript: enableTypescript,
-    npmPackageConsumption: enableNpmPackageConsumption
+    codeAssist: (input) => __awaiter(void 0, void 0, void 0, function* () { return yield copyTemplates('codeAssist', input); }),
+    eslint: (input) => __awaiter(void 0, void 0, void 0, function* () { return yield copyTemplates('eslint', input); }),
+    loadReuseLibs: (input) => __awaiter(void 0, void 0, void 0, function* () { return yield copyTemplates('loadReuseLibs', input); }),
+    sapux: (input) => __awaiter(void 0, void 0, void 0, function* () { return yield copyTemplates('sapux', input); }),
+    typescript: (input) => __awaiter(void 0, void 0, void 0, function* () { return yield enableTypescript(input); }),
+    npmPackageConsumption: (input) => __awaiter(void 0, void 0, void 0, function* () { return yield enableNpmPackageConsumption(input); })
 };
 /**
  * Enable typescript for the given input.
@@ -55,19 +66,21 @@ const factories = {
  */
 function enableTypescript(input, keepOldComponent = false) {
     var _a;
-    input.ui5App.app.baseComponent = (_a = input.ui5App.app.baseComponent) !== null && _a !== void 0 ? _a : "sap/ui/core/UIComponent" /* UI5_DEFAULT.BASE_COMPONENT */;
-    copyTemplates('typescript', input);
-    input.ui5Configs.forEach((ui5Config) => {
-        ui5Config.addCustomMiddleware([ui5Libs_1.ui5TSSupport.middleware]);
-        ui5Config.addCustomTasks([ui5Libs_1.ui5TSSupport.task]);
+    return __awaiter(this, void 0, void 0, function* () {
+        input.ui5App.app.baseComponent = (_a = input.ui5App.app.baseComponent) !== null && _a !== void 0 ? _a : "sap/ui/core/UIComponent" /* UI5_DEFAULT.BASE_COMPONENT */;
+        yield copyTemplates('typescript', input);
+        input.ui5Configs.forEach((ui5Config) => {
+            ui5Config.addCustomMiddleware([ui5Libs_1.ui5TSSupport.middleware]);
+            ui5Config.addCustomTasks([ui5Libs_1.ui5TSSupport.task]);
+        });
+        const compPath = (0, path_1.join)(input.basePath, 'webapp/Component.js');
+        if (keepOldComponent) {
+            input.fs.move(compPath, `${compPath}.old`);
+        }
+        else {
+            input.fs.delete(compPath);
+        }
     });
-    const compPath = (0, path_1.join)(input.basePath, 'webapp/Component.js');
-    if (keepOldComponent) {
-        input.fs.move(compPath, `${compPath}.old`);
-    }
-    else {
-        input.fs.delete(compPath);
-    }
 }
 exports.enableTypescript = enableTypescript;
 /**
@@ -76,10 +89,12 @@ exports.enableTypescript = enableTypescript;
  * @param input Input required to enable the optional npm modules import
  */
 function enableNpmPackageConsumption(input) {
-    copyTemplates('npmPackageConsumption', input);
-    input.ui5Configs.forEach((ui5Config) => {
-        ui5Config.addCustomMiddleware([ui5Libs_1.ui5NPMSupport.middleware]);
-        ui5Config.addCustomTasks([ui5Libs_1.ui5NPMSupport.task]);
+    return __awaiter(this, void 0, void 0, function* () {
+        yield copyTemplates('npmPackageConsumption', input);
+        input.ui5Configs.forEach((ui5Config) => {
+            ui5Config.addCustomMiddleware([ui5Libs_1.ui5NPMSupport.middleware]);
+            ui5Config.addCustomTasks([ui5Libs_1.ui5NPMSupport.task]);
+        });
     });
 }
 exports.enableNpmPackageConsumption = enableNpmPackageConsumption;
@@ -93,14 +108,16 @@ exports.enableNpmPackageConsumption = enableNpmPackageConsumption;
  * @param ui5Configs available UI5 configs
  */
 function applyOptionalFeatures(ui5App, fs, basePath, tmplPath, ui5Configs) {
-    if (ui5App.appOptions) {
-        Object.entries(ui5App.appOptions).forEach(([key, value]) => {
-            var _a;
-            if (value === true) {
-                (_a = factories[key]) === null || _a === void 0 ? void 0 : _a.call(factories, { ui5App, fs, basePath, tmplPath, ui5Configs });
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        if (ui5App.appOptions) {
+            for (const [key, value] of Object.entries(ui5App.appOptions)) {
+                if (value === true) {
+                    yield ((_a = factories[key]) === null || _a === void 0 ? void 0 : _a.call(factories, { ui5App, fs, basePath, tmplPath, ui5Configs }));
+                }
             }
-        });
-    }
+        }
+    });
 }
 exports.applyOptionalFeatures = applyOptionalFeatures;
 //# sourceMappingURL=options.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%3Aui5-application-writer"
   },
-  "version": "0.22.3",
+  "version": "0.23.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -20,25 +20,25 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@sap-ux/ui5-config": "0.16.6",
     "@ui5/manifest": "1.49.2",
     "ejs": "3.1.7",
     "i18next": "21.6.11",
     "lodash": "4.17.21",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "semver": "7.3.5"
+    "semver": "7.3.5",
+    "@sap-ux/ui5-config": "0.17.0"
   },
   "devDependencies": {
-    "@sap-ux/eslint-plugin-fiori-tools": "0.1.5",
-    "@sap-ux/project-access": "1.5.0",
     "@types/ejs": "3.1.0",
     "@types/fs-extra": "9.0.13",
     "@types/lodash": "4.14.176",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/semver": "7.3.9",
-    "fs-extra": "10.0.0"
+    "fs-extra": "10.0.0",
+    "@sap-ux/eslint-plugin-fiori-tools": "0.1.5",
+    "@sap-ux/project-access": "1.7.0"
   },
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",

package/dist/files.d.ts

@@ -1,9 +0,0 @@
-/**
- * @description Returns a flat list of all file paths under a directory tree,
- * recursing through all subdirectories
- * @param {string} dir - the directory to walk
- * @returns {string[]} - array of file path strings
- * @throws if an error occurs reading a file path
- */
-export declare function getFilePaths(dir: string): string[] | [];
-//# sourceMappingURL=files.d.ts.map

package/dist/files.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFilePaths = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
-/**
- * @description Returns a flat list of all file paths under a directory tree,
- * recursing through all subdirectories
- * @param {string} dir - the directory to walk
- * @returns {string[]} - array of file path strings
- * @throws if an error occurs reading a file path
- */
-function getFilePaths(dir) {
-    return (0, fs_1.readdirSync)(dir).reduce((files, entry) => {
-        const entryPath = (0, path_1.join)(dir, entry);
-        const isDirectory = (0, fs_1.statSync)(entryPath).isDirectory();
-        return isDirectory ? [...files, ...getFilePaths(entryPath)] : [...files, entryPath];
-    }, []);
-}
-exports.getFilePaths = getFilePaths;
-//# sourceMappingURL=files.js.map