@sap-ux/ui5-application-writer 0.16.0 → 0.17.0

package/dist/data/defaults.d.ts

@@ -17,14 +17,7 @@ export declare function packageDefaults(version?: string, description?: string):
  * @returns - a merged package defintion
  */
 export declare function mergePackages(packageA: Partial<Package>, packageB: Partial<Package>): Package;
-/**
- * Returns an app instance merged with default properties.
- *
- * @param {App} app - specifies the application properties
- * @returns {Partial<App>} the App instance
- */
-export declare function mergeApp(app: App): App;
-export declare enum UI5_DEFAULT {
+export declare const enum UI5_DEFAULT {
     DEFAULT_UI5_VERSION = "",
     DEFAULT_LOCAL_UI5_VERSION = "1.95.0",
     MIN_UI5_VERSION = "1.60.0",
@@ -34,8 +27,16 @@ export declare enum UI5_DEFAULT {
     OPENUI5_CDN = "https://openui5.hana.ondemand.com",
     TYPES_VERSION_SINCE = "1.76.0",
     TYPES_VERSION_PREVIOUS = "1.71.18",
-    MANIFEST_VERSION = "1.12.0"
+    MANIFEST_VERSION = "1.12.0",
+    BASE_COMPONENT = "sap/ui/core/UIComponent"
 }
+/**
+ * Returns an app instance merged with default properties.
+ *
+ * @param {App} app - specifies the application properties
+ * @returns {Partial<App>} the App instance
+ */
+export declare function mergeApp(app: App): App;
 export declare const defaultUI5Libs: string[];
 /**
  * Merges version properties with the provided UI5 instance.

package/dist/data/defaults.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSpecTagVersion = exports.mergeUi5 = exports.defaultUI5Libs = exports.UI5_DEFAULT = exports.mergeApp = exports.mergePackages = exports.packageDefaults = void 0;
+exports.getSpecTagVersion = exports.mergeUi5 = exports.defaultUI5Libs = exports.mergeApp = exports.mergePackages = exports.packageDefaults = void 0;
 const version_to_descriptor_mapping_json_1 = __importDefault(require("./version-to-descriptor-mapping.json")); // from https://github.com/SAP/ui5-manifest/blob/master/mapping.json
 const ui5Libs_1 = require("./ui5Libs");
 const semver_1 = __importDefault(require("semver"));
@@ -69,7 +69,7 @@ function mergeApp(app) {
             version: '0.0.1',
             title: i18n_1.t('text.defaultAppTitle', { id: app.id }),
             description: i18n_1.t('text.defaultAppDescription', { id: app.id }),
-            baseComponent: 'sap/ui/core/UIComponent',
+            baseComponent: "sap/ui/core/UIComponent" /* BASE_COMPONENT */,
             sourceTemplate: {
                 id: (_b = (_a = app.sourceTemplate) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : '',
                 version: (_d = (_c = app.sourceTemplate) === null || _c === void 0 ? void 0 : _c.version) !== null && _d !== void 0 ? _d : '',
@@ -80,19 +80,6 @@ function mergeApp(app) {
     ]);
 }
 exports.mergeApp = mergeApp;
-var UI5_DEFAULT;
-(function (UI5_DEFAULT) {
-    UI5_DEFAULT["DEFAULT_UI5_VERSION"] = "";
-    UI5_DEFAULT["DEFAULT_LOCAL_UI5_VERSION"] = "1.95.0";
-    UI5_DEFAULT["MIN_UI5_VERSION"] = "1.60.0";
-    UI5_DEFAULT["MIN_LOCAL_SAPUI5_VERSION"] = "1.76.0";
-    UI5_DEFAULT["MIN_LOCAL_OPENUI5_VERSION"] = "1.52.5";
-    UI5_DEFAULT["SAPUI5_CDN"] = "https://ui5.sap.com";
-    UI5_DEFAULT["OPENUI5_CDN"] = "https://openui5.hana.ondemand.com";
-    UI5_DEFAULT["TYPES_VERSION_SINCE"] = "1.76.0";
-    UI5_DEFAULT["TYPES_VERSION_PREVIOUS"] = "1.71.18";
-    UI5_DEFAULT["MANIFEST_VERSION"] = "1.12.0";
-})(UI5_DEFAULT = exports.UI5_DEFAULT || (exports.UI5_DEFAULT = {}));
 // Required default libs
 exports.defaultUI5Libs = ['sap.m', 'sap.ui.core'];
 /**
@@ -104,9 +91,9 @@ exports.defaultUI5Libs = ['sap.m', 'sap.ui.core'];
  */
 function mergeUi5(ui5) {
     var _a, _b, _c, _d, _e;
-    const version = (_a = ui5.version) !== null && _a !== void 0 ? _a : UI5_DEFAULT.DEFAULT_UI5_VERSION; // Undefined or null indicates the latest available should be used
+    const version = (_a = ui5.version) !== null && _a !== void 0 ? _a : "" /* DEFAULT_UI5_VERSION */; // Undefined or null indicates the latest available should be used
     const framework = (_b = ui5.framework) !== null && _b !== void 0 ? _b : 'SAPUI5';
-    const defaultFrameworkUrl = framework === 'SAPUI5' ? UI5_DEFAULT.SAPUI5_CDN : UI5_DEFAULT.OPENUI5_CDN;
+    const defaultFrameworkUrl = framework === 'SAPUI5' ? "https://ui5.sap.com" /* SAPUI5_CDN */ : "https://openui5.hana.ondemand.com" /* OPENUI5_CDN */;
     const merged = {
         minUI5Version: getMinUI5Version(version, ui5.minUI5Version),
         localVersion: getLocalVersion({ framework, version, localVersion: ui5.localVersion }),
@@ -116,9 +103,9 @@ function mergeUi5(ui5) {
     };
     // typesVersion must be a valid npm semantic version, we know they cannot be null as already validated
     const localSemVer = semver_1.default.valid(semver_1.default.coerce(merged.localVersion));
-    const typesVersion = semver_1.default.gte(localSemVer, UI5_DEFAULT.TYPES_VERSION_SINCE)
+    const typesVersion = semver_1.default.gte(localSemVer, "1.76.0" /* TYPES_VERSION_SINCE */)
         ? localSemVer
-        : UI5_DEFAULT.TYPES_VERSION_PREVIOUS;
+        : "1.71.18" /* TYPES_VERSION_PREVIOUS */;
     merged.descriptorVersion = getManifestVersion(merged.minUI5Version, ui5.descriptorVersion);
     merged.typesVersion = (_d = ui5.typesVersion) !== null && _d !== void 0 ? _d : typesVersion;
     merged.ui5Theme = (_e = ui5.ui5Theme) !== null && _e !== void 0 ? _e : 'sap_fiori_3';
@@ -134,7 +121,7 @@ exports.mergeUi5 = mergeUi5;
  * @returns minimum UI5 version for manifest
  */
 function getMinUI5Version(ui5Version, minUI5Version) {
-    return minUI5Version !== null && minUI5Version !== void 0 ? minUI5Version : (ui5Version ? ui5Version : UI5_DEFAULT.MIN_UI5_VERSION);
+    return minUI5Version !== null && minUI5Version !== void 0 ? minUI5Version : (ui5Version ? ui5Version : "1.60.0" /* MIN_UI5_VERSION */);
 }
 /**
  * Get the manifest descriptor version from the specified UI5 version.
@@ -188,7 +175,7 @@ function getManifestVersion(ui5Version, manifestVersion) {
         }
         return matchVersion;
     };
-    return (_a = manifestVersion !== null && manifestVersion !== void 0 ? manifestVersion : (ui5SemVer && getClosestManifestVersion(ui5SemVer))) !== null && _a !== void 0 ? _a : UI5_DEFAULT.MANIFEST_VERSION;
+    return (_a = manifestVersion !== null && manifestVersion !== void 0 ? manifestVersion : (ui5SemVer && getClosestManifestVersion(ui5SemVer))) !== null && _a !== void 0 ? _a : "1.12.0" /* MANIFEST_VERSION */;
 }
 /**
  * If a specific local version is provided, use it, otherwise, sync with version but keep minimum versions in mind.
@@ -204,10 +191,10 @@ function getLocalVersion({ framework, version, localVersion }) {
     if (localVersion) {
         return localVersion;
     }
-    else if (version === UI5_DEFAULT.DEFAULT_UI5_VERSION) {
-        return UI5_DEFAULT.DEFAULT_LOCAL_UI5_VERSION;
+    else if (version === "" /* DEFAULT_UI5_VERSION */) {
+        return "1.95.0" /* DEFAULT_LOCAL_UI5_VERSION */;
     }
-    let result = framework === 'SAPUI5' ? UI5_DEFAULT.MIN_LOCAL_SAPUI5_VERSION : UI5_DEFAULT.MIN_LOCAL_OPENUI5_VERSION; // minimum version available as local libs
+    let result = framework === 'SAPUI5' ? "1.76.0" /* MIN_LOCAL_SAPUI5_VERSION */ : "1.52.5" /* MIN_LOCAL_OPENUI5_VERSION */; // minimum version available as local libs
     // If the ui5 `version` is higher than the min framework version 'result' then use that as the local version instead
     // Update to a valid coerced version string e.g. snapshot-1.80 -> 1.80.0. Cannot be null as previously validated.
     const versionSemVer = semver_1.default.coerce(version);

package/dist/data/index.js

@@ -17,6 +17,7 @@ function mergeWithDefaults(ui5App) {
     ui5App.ui5 = defaults_1.mergeUi5(ui5App.ui5 || {});
     ui5App.package = defaults_1.mergePackages(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'] = defaults_1.getSpecTagVersion(ui5App.ui5.version);
     }
     return ui5App;

package/dist/data/ui5Libs.d.ts

@@ -6,45 +6,42 @@
  */
 export declare const getUI5Libs: (ui5Libs?: string | string[] | undefined) => string[];
 /**
- * UI5 tasks configurations required for TypeScript projects
+ * UI5 task and middleware configurations required for TypeScript projects
  */
-export declare const ui5TsTasks: ({
-    name: string;
-    afterTask: string;
-    configuration: {
-        debug?: undefined;
-        removeConsoleStatements?: undefined;
-        transpileAsync?: undefined;
-        transpileTypeScript?: undefined;
+export declare const ui5TSSupport: {
+    task: {
+        name: string;
+        afterTask: string;
+        configuration: {
+            debug: boolean;
+            removeConsoleStatements: boolean;
+            transpileAsync: boolean;
+            transpileTypeScript: boolean;
+        };
     };
-} | {
-    name: string;
-    afterTask: string;
-    configuration: {
-        debug: boolean;
-        removeConsoleStatements: boolean;
-        transpileAsync: boolean;
-        transpileTypeScript: boolean;
+    middleware: {
+        name: string;
+        afterMiddleware: string;
+        configuration: {
+            debug: boolean;
+            transpileAsync: boolean;
+            transpileTypeScript: boolean;
+        };
     };
-})[];
+};
 /**
- * UI5 middleware configurations required for TypeScript projects
+ * UI5 tasks and middleware configurations required for including npm modules
  */
-export declare const ui5TsMiddlewares: ({
-    name: string;
-    afterMiddleware: string;
-    configuration: {
-        debug?: undefined;
-        transpileAsync?: undefined;
-        transpileTypeScript?: undefined;
+export declare const ui5NPMSupport: {
+    task: {
+        name: string;
+        afterTask: string;
+        configuration: {};
     };
-} | {
-    name: string;
-    afterMiddleware: string;
-    configuration: {
-        debug: boolean;
-        transpileAsync: boolean;
-        transpileTypeScript: boolean;
+    middleware: {
+        name: string;
+        afterMiddleware: string;
+        configuration: {};
     };
-})[];
+};
 //# sourceMappingURL=ui5Libs.d.ts.map

package/dist/data/ui5Libs.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ui5TsMiddlewares = exports.ui5TsTasks = exports.getUI5Libs = void 0;
+exports.ui5NPMSupport = exports.ui5TSSupport = exports.getUI5Libs = void 0;
 const defaults_1 = require("./defaults");
 /**
  * Merges the specified ui5 libs with the defaults.
@@ -15,15 +15,10 @@ exports.getUI5Libs = (ui5Libs) => {
     });
 };
 /**
- * UI5 tasks configurations required for TypeScript projects
+ * UI5 task and middleware configurations required for TypeScript projects
  */
-exports.ui5TsTasks = [
-    {
-        name: 'ui5-tooling-modules-task',
-        afterTask: 'replaceVersion',
-        configuration: {}
-    },
-    {
+exports.ui5TSSupport = {
+    task: {
         name: 'ui5-tooling-transpile-task',
         afterTask: 'replaceVersion',
         configuration: {
@@ -32,18 +27,8 @@ exports.ui5TsTasks = [
             transpileAsync: true,
             transpileTypeScript: true
         }
-    }
-];
-/**
- * UI5 middleware configurations required for TypeScript projects
- */
-exports.ui5TsMiddlewares = [
-    {
-        name: 'ui5-tooling-modules-middleware',
-        afterMiddleware: 'compression',
-        configuration: {}
     },
-    {
+    middleware: {
         name: 'ui5-tooling-transpile-middleware',
         afterMiddleware: 'compression',
         configuration: {
@@ -52,5 +37,20 @@ exports.ui5TsMiddlewares = [
             transpileTypeScript: true
         }
     }
-];
+};
+/**
+ * UI5 tasks and middleware configurations required for including npm modules
+ */
+exports.ui5NPMSupport = {
+    task: {
+        name: 'ui5-tooling-modules-task',
+        afterTask: 'replaceVersion',
+        configuration: {}
+    },
+    middleware: {
+        name: 'ui5-tooling-modules-middleware',
+        afterMiddleware: 'compression',
+        configuration: {}
+    }
+};
 //# sourceMappingURL=ui5Libs.js.map

package/dist/index.d.ts

@@ -4,12 +4,28 @@ import { Ui5App } from './types';
 /**
  * Writes the template to the memfs editor instance.
  *
- * @param {string} basePath - the base path
- * @param {Ui5App} ui5AppConfig - the Ui5App instance
- * @param {Editor} [fs] - the memfs editor instance
- * @returns {*}  {Promise<Editor>} the updated memfs editor instance
+ * @param basePath - the base path
+ * @param ui5AppConfig - the Ui5App instance
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
  */
 declare function generate(basePath: string, ui5AppConfig: Ui5App, fs?: Editor): Promise<Editor>;
-export { Ui5App, generate };
+/**
+ * Check if Typescript is enabled for the given path.
+ *
+ * @param basePath - the base path
+ * @param fs - the memfs editor instance
+ * @returns true is the project is ready for typescript code
+ */
+declare function isTypescriptEnabled(basePath: string, fs?: Editor): Promise<boolean>;
+/**
+ * Enable typescript in an existing valid UI5 project.
+ *
+ * @param basePath - the base path
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
+ */
+declare function enableTypescript(basePath: string, fs?: Editor): Promise<Editor>;
+export { Ui5App, generate, enableTypescript, isTypescriptEnabled };
 export { App, Package, UI5, AppOptions };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -9,34 +9,33 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = void 0;
+exports.isTypescriptEnabled = exports.enableTypescript = exports.generate = void 0;
 const path_1 = require("path");
-const data_1 = require("./data");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
-const json_merger_1 = require("json-merger");
-const ejs_1 = require("ejs");
-const files_1 = require("./files");
 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");
 /**
  * Writes the template to the memfs editor instance.
  *
- * @param {string} basePath - the base path
- * @param {Ui5App} ui5AppConfig - the Ui5App instance
- * @param {Editor} [fs] - the memfs editor instance
- * @returns {*}  {Promise<Editor>} the updated memfs editor instance
+ * @param basePath - the base path
+ * @param ui5AppConfig - the Ui5App instance
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
  */
 function generate(basePath, ui5AppConfig, fs) {
-    var _a;
+    var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         if (!fs) {
             fs = mem_fs_editor_1.create(mem_fs_1.create());
         }
         const ui5App = data_1.mergeWithDefaults(ui5AppConfig);
         const tmplPath = path_1.join(__dirname, '..', 'templates');
+        const ignore = [((_a = ui5AppConfig.appOptions) === null || _a === void 0 ? void 0 : _a.typescript) ? '**/*.js' : '**/*.ts'];
         fs.copyTpl(path_1.join(tmplPath, 'core', '**/*.*'), path_1.join(basePath), ui5App, undefined, {
-            globOptions: { dot: true },
+            globOptions: { dot: true, ignore },
             processDestinationPath: (filePath) => filePath.replace(/gitignore.tmpl/g, '.gitignore')
         });
         // ui5.yaml
@@ -44,7 +43,7 @@ function generate(basePath, ui5AppConfig, fs) {
         const ui5Config = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5ConfigPath));
         ui5Config.addFioriToolsProxydMiddleware({
             ui5: {
-                url: (_a = ui5App.ui5) === null || _a === void 0 ? void 0 : _a.frameworkUrl
+                url: (_b = ui5App.ui5) === null || _b === void 0 ? void 0 : _b.frameworkUrl
             }
         });
         ui5Config.addFioriToolsAppReloadMiddleware();
@@ -54,37 +53,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
-        if (ui5App.appOptions) {
-            Object.entries(ui5App.appOptions).forEach(([key, value]) => {
-                if (value === true) {
-                    const optTmplDirPath = path_1.join(tmplPath, 'optional', `${key}`);
-                    const optTmplFilePaths = files_1.getFilePaths(optTmplDirPath);
-                    optTmplFilePaths.forEach((optTmplFilePath) => {
-                        const relPath = optTmplFilePath.replace(optTmplDirPath, '');
-                        const outPath = path_1.join(basePath, relPath);
-                        // Extend or add
-                        if (!(fs === null || fs === void 0 ? void 0 : fs.exists(outPath))) {
-                            fs === null || fs === void 0 ? void 0 : fs.copyTpl(optTmplFilePath, outPath, ui5App, undefined, {
-                                globOptions: { dot: true }
-                            });
-                        }
-                        else {
-                            const add = JSON.parse(ejs_1.render(fs === null || fs === void 0 ? void 0 : fs.read(optTmplFilePath), ui5App, {}));
-                            const existingFile = JSON.parse(fs === null || fs === void 0 ? void 0 : fs.read(outPath));
-                            const merged = json_merger_1.mergeObjects([existingFile, add], { defaultArrayMergeOperation: 'concat' });
-                            fs === null || fs === void 0 ? void 0 : fs.writeJSON(outPath, merged);
-                        }
-                    });
-                }
-            });
-            if (ui5App.appOptions.typescript) {
-                fs.delete(path_1.join(basePath, 'webapp/Component.js'));
-                ui5Config.addCustomMiddleware(ui5Libs_1.ui5TsMiddlewares);
-                ui5Config.addCustomTasks(ui5Libs_1.ui5TsTasks);
-                ui5LocalConfig.addCustomMiddleware(ui5Libs_1.ui5TsMiddlewares);
-                ui5LocalConfig.addCustomTasks(ui5Libs_1.ui5TsTasks);
-            }
-        }
+        options_1.applyOptionalFeatures(ui5App, fs, basePath, tmplPath, [ui5Config, ui5LocalConfig]);
         // write ui5 yamls
         fs.write(ui5ConfigPath, ui5Config.toString());
         fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
@@ -92,4 +61,57 @@ function generate(basePath, ui5AppConfig, fs) {
     });
 }
 exports.generate = generate;
+/**
+ * Check if Typescript is enabled for the given path.
+ *
+ * @param basePath - the base path
+ * @param fs - the memfs editor instance
+ * @returns true is the project is ready for typescript code
+ */
+function isTypescriptEnabled(basePath, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs) {
+            fs = mem_fs_editor_1.create(mem_fs_1.create());
+        }
+        // check middlewares and tasks
+        const ui5Config = yield ui5_config_1.UI5Config.newInstance(fs.read(path_1.join(basePath, 'ui5.yaml')));
+        if (!ui5Config.findCustomMiddleware(ui5Libs_1.ui5TSSupport.middleware.name)) {
+            return false;
+        }
+        if (!ui5Config.findCustomTask(ui5Libs_1.ui5TSSupport.task.name)) {
+            return false;
+        }
+        return true;
+    });
+}
+exports.isTypescriptEnabled = isTypescriptEnabled;
+/**
+ * Enable typescript in an existing valid UI5 project.
+ *
+ * @param basePath - the base path
+ * @param fs - the memfs editor instance
+ * @returns the updated memfs editor instance
+ */
+function enableTypescript(basePath, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs) {
+            fs = mem_fs_editor_1.create(mem_fs_1.create());
+        }
+        const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
+        const ui5ConfigPath = path_1.join(basePath, 'ui5.yaml');
+        if (!fs.exists(manifestPath)) {
+            throw new Error(`Invalid project folder. Cannot find required file ${manifestPath}`);
+        }
+        if (!fs.exists(ui5ConfigPath)) {
+            throw new Error(`Invalid project folder. Cannot find required file ${ui5ConfigPath}`);
+        }
+        const manifest = fs.readJSON(manifestPath);
+        const ui5Config = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5ConfigPath));
+        const tmplPath = path_1.join(__dirname, '..', 'templates');
+        options_1.enableTypescript({ basePath, fs, ui5Configs: [ui5Config], tmplPath, ui5App: { app: manifest['sap.app'] } }, true);
+        fs.write(ui5ConfigPath, ui5Config.toString());
+        return fs;
+    });
+}
+exports.enableTypescript = enableTypescript;
 //# sourceMappingURL=index.js.map

package/dist/options.d.ts

@@ -0,0 +1,42 @@
+import type { Editor } from 'mem-fs-editor';
+import type { Ui5App } from './types';
+import type { UI5Config } from '@sap-ux/ui5-config';
+/**
+ * Input required to enable optional features.
+ */
+export interface FeatureInput {
+    ui5App: {
+        app: {
+            id: string;
+            baseComponent?: string;
+        };
+    };
+    fs: Editor;
+    basePath: string;
+    tmplPath: string;
+    ui5Configs: UI5Config[];
+}
+/**
+ * Enable typescript for the given input.
+ *
+ * @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;
+/**
+ * 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;
+/**
+ * Check if the ui5 app config requires optional features to be enabled and if yes, enable them.
+ *
+ * @param ui5App ui5 app config
+ * @param fs reference to the mem-fs instance
+ * @param basePath project base path
+ * @param tmplPath template basepath
+ * @param ui5Configs available UI5 configs
+ */
+export declare function applyOptionalFeatures(ui5App: Ui5App, fs: Editor, basePath: string, tmplPath: string, ui5Configs: UI5Config[]): void;
+//# sourceMappingURL=options.d.ts.map

package/dist/options.js

@@ -0,0 +1,105 @@
+"use strict";
+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 json_merger_1 = require("json-merger");
+const files_1 = require("./files");
+const ui5Libs_1 = require("./data/ui5Libs");
+/**
+ * Copy all template files into the target project.
+ *
+ * @param name the name of the optional feature
+ * @param input collection of input properties
+ * @param input.ui5App ui5 app config
+ * @param input.fs reference to the mem-fs instance
+ * @param input.basePath project base path
+ * @param input.tmplPath template basepath
+ */
+function copyTemplates(name, { ui5App, fs, basePath, tmplPath }) {
+    const optTmplDirPath = path_1.join(tmplPath, 'optional', `${name}`);
+    const optTmplFilePaths = files_1.getFilePaths(optTmplDirPath);
+    optTmplFilePaths.forEach((optTmplFilePath) => {
+        const relPath = optTmplFilePath.replace(optTmplDirPath, '');
+        const outPath = path_1.join(basePath, relPath);
+        // Extend or add
+        if (!(fs === null || fs === void 0 ? void 0 : fs.exists(outPath))) {
+            fs === null || fs === void 0 ? void 0 : fs.copyTpl(optTmplFilePath, outPath, ui5App, undefined, {
+                globOptions: { dot: true }
+            });
+        }
+        else {
+            const add = JSON.parse(ejs_1.render(fs === null || fs === void 0 ? void 0 : fs.read(optTmplFilePath), ui5App, {}));
+            const existingFile = JSON.parse(fs === null || fs === void 0 ? void 0 : fs.read(outPath));
+            const merged = json_merger_1.mergeObjects([existingFile, add], { defaultArrayMergeOperation: 'concat' });
+            fs === null || fs === void 0 ? void 0 : 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
+};
+/**
+ * Enable typescript for the given input.
+ *
+ * @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.
+ */
+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" /* BASE_COMPONENT */;
+    copyTemplates('typescript', input);
+    input.ui5Configs.forEach((ui5Config) => {
+        ui5Config.addCustomMiddleware([ui5Libs_1.ui5TSSupport.middleware]);
+        ui5Config.addCustomTasks([ui5Libs_1.ui5TSSupport.task]);
+    });
+    const compPath = path_1.join(input.basePath, 'webapp/Component.js');
+    if (keepOldComponent) {
+        input.fs.move(compPath, `${compPath}.old`);
+    }
+    else {
+        input.fs.delete(compPath);
+    }
+}
+exports.enableTypescript = enableTypescript;
+/**
+ * Enable npm module import for the given input.
+ *
+ * @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]);
+    });
+}
+exports.enableNpmPackageConsumption = enableNpmPackageConsumption;
+/**
+ * Check if the ui5 app config requires optional features to be enabled and if yes, enable them.
+ *
+ * @param ui5App ui5 app config
+ * @param fs reference to the mem-fs instance
+ * @param basePath project base path
+ * @param tmplPath template basepath
+ * @param ui5Configs available UI5 configs
+ */
+function applyOptionalFeatures(ui5App, fs, basePath, tmplPath, ui5Configs) {
+    if (ui5App.appOptions) {
+        Object.entries(ui5App.appOptions).forEach(([key, value]) => {
+            if (value === true) {
+                factories[key]({ ui5App, fs, basePath, tmplPath, ui5Configs });
+            }
+        });
+    }
+}
+exports.applyOptionalFeatures = applyOptionalFeatures;
+//# sourceMappingURL=options.js.map

package/dist/types.d.ts

@@ -59,6 +59,10 @@ export interface AppOptions {
      * Enable Typescript support and generate all files in Typescript instead of Javascript
      */
     typescript: boolean;
+    /**
+     * Enable support for importing functionality from npm packages in UI5 applications
+     */
+    npmPackageConsumption: boolean;
 }
 export interface Ui5App {
     app: App;

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.16.0",
+  "version": "0.17.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -20,7 +20,7 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@sap-ux/ui5-config": "0.14.5",
+    "@sap-ux/ui5-config": "0.15.0",
     "ejs": "3.1.7",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",

package/templates/optional/codeAssist/package.json

@@ -2,6 +2,6 @@
     "devDependencies": {
         "eslint": "7.32.0",
         "@sap/eslint-plugin-ui5-jsdocs": "2.0.5",
-        "@sapui5/ts-types": "1.92.2"
+        "@sapui5/ts-types": "1.102.x"
     }
 }

package/templates/optional/eslint/.eslintrc

@@ -6,7 +6,7 @@
     "./node_modules/eslint-plugin-fiori-custom/configure.eslintrc"
   ],
   "ignorePatterns": [
-    "webapp/localservice/**",
+    "webapp/localService/**",
     "webapp/test/**",
     "dist/**"
   ]

package/templates/optional/npmPackageConsumption/package.json

@@ -0,0 +1,10 @@
+{
+    "devDependencies": {
+        "ui5-tooling-modules": "^0.6.0"
+    },
+    "ui5": {
+        "dependencies": [
+            "ui5-tooling-modules"
+        ]
+    }
+}

package/templates/optional/typescript/package.json

@@ -3,8 +3,7 @@
         "ts-typecheck": "tsc --noEmit"
     },
     "devDependencies": {
-        "@sapui5/ts-types-esm": "latest",
-        "ui5-tooling-modules": "^0.6.0",
+        "@sapui5/ts-types-esm": "1.102.x",
         "ui5-tooling-transpile": "^0.2.0",
         "typescript": "^4.6.3",
         "@typescript-eslint/eslint-plugin": "^5.17.0",
@@ -12,7 +11,6 @@
     },
     "ui5": {
         "dependencies": [
-            "ui5-tooling-modules",
             "ui5-tooling-transpile"
         ]
     }