@sap-ux/fe-fpm-writer 0.14.0 → 0.14.3

package/dist/action/index.js

@@ -9,6 +9,7 @@ const ejs_1 = require("ejs");
 const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const event_handler_1 = require("../common/event-handler");
+const templates_1 = require("../templates");
 /**
  * Enhances the provided custom action configuration with default data.
  *
@@ -74,14 +75,13 @@ function generateCustomAction(basePath, actionConfig, fs) {
     const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
     const manifest = fs.readJSON(manifestPath);
     const config = enhanceConfig(actionConfig, manifestPath, manifest);
-    const root = path_1.join(__dirname, '../../templates');
     // Apply event handler
     if (config.eventHandler) {
-        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler, false, config.typescript);
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, config, config.eventHandler, false, config.typescript);
     }
     // enhance manifest with action definition and controller reference
     const actions = enhanceManifestAndGetActionsElementReference(manifest, config.target);
-    Object.assign(actions, JSON.parse(ejs_1.render(fs.read(path_1.join(root, `action/manifest.action.json`)), config, {})));
+    Object.assign(actions, JSON.parse(ejs_1.render(fs.read(templates_1.getTemplatePath(`action/manifest.action.json`)), config, {})));
     fs.writeJSON(manifestPath, manifest);
     return fs;
 }

package/dist/app/index.js

@@ -6,6 +6,7 @@ const mem_fs_editor_1 = require("mem-fs-editor");
 const path_1 = require("path");
 const semver_1 = require("semver");
 const defaults_1 = require("../common/defaults");
+const templates_1 = require("../templates");
 exports.MIN_VERSION = '1.94.0';
 /**
  * Enable the flexible programming model for an application.
@@ -69,7 +70,7 @@ function enableFPM(basePath, config = {}, fs) {
     // replace Component.js
     if (config.replaceAppComponent) {
         const ext = config.typescript ? 'ts' : 'js';
-        const componentTemplate = path_1.join(__dirname, `../../templates/app/Component.${ext}`);
+        const componentTemplate = templates_1.getTemplatePath(`/app/Component.${ext}`);
         fs.copyTpl(componentTemplate, path_1.join(basePath, `webapp/Component.${ext}`), manifest['sap.app']);
     }
     return fs;

package/dist/building-block/index.js

@@ -31,6 +31,7 @@ const xmldom_1 = require("@xmldom/xmldom");
 const xpath = __importStar(require("xpath"));
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
 const validate_1 = require("../common/validate");
+const templates_1 = require("../templates");
 /**
  * Generates a building block into the provided xml view file.
  *
@@ -109,7 +110,7 @@ function getOrAddMacrosNamespace(ui5XmlDocument) {
  */
 function getTemplateDocument(buildingBlockData, viewDocument, fs) {
     const templateFolderName = buildingBlockData.buildingBlockType;
-    const templateFilePath = path_1.join(__dirname, `../../templates/building-block/${templateFolderName}/View.xml`);
+    const templateFilePath = templates_1.getTemplatePath(`/building-block/${templateFolderName}/View.xml`);
     const templateContent = ejs_1.render(fs.read(templateFilePath), {
         macrosNamespace: getOrAddMacrosNamespace(viewDocument),
         data: buildingBlockData

package/dist/column/index.js

@@ -8,6 +8,7 @@ const path_1 = require("path");
 const defaults_1 = require("../common/defaults");
 const validate_1 = require("../common/validate");
 const event_handler_1 = require("../common/event-handler");
+const templates_1 = require("../templates");
 /**
  * Get the template folder for the given UI5 version.
  *
@@ -16,13 +17,13 @@ const event_handler_1 = require("../common/event-handler");
  */
 function getManifestRoot(ui5Version) {
     if (ui5Version === undefined || ui5Version >= 1.86) {
-        return path_1.join(__dirname, '../../templates/column/1.86');
+        return templates_1.getTemplatePath('/column/1.86');
     }
     else if (ui5Version === 1.85) {
-        return path_1.join(__dirname, '../../templates/column/1.85');
+        return templates_1.getTemplatePath('/column/1.85');
     }
     else {
-        return path_1.join(__dirname, '../../templates/column/1.84');
+        return templates_1.getTemplatePath('column/1.84');
     }
 }
 exports.getManifestRoot = getManifestRoot;
@@ -30,19 +31,18 @@ exports.getManifestRoot = getManifestRoot;
  * Enhances the provided custom table column configuration with default data.
  *
  * @param {Editor} fs - the mem-fs editor instance
- * @param {string} root - root path
  * @param {CustomTableColumn} data - a custom column configuration object
  * @param {string} manifestPath - path to the project's manifest.json
  * @param {Manifest} manifest - the application manifest
  * @returns enhanced configuration
  */
-function enhanceConfig(fs, root, data, manifestPath, manifest) {
+function enhanceConfig(fs, data, manifestPath, manifest) {
     // clone input and set defaults
     const config = Object.assign({}, data);
     defaults_1.setCommonDefaults(config, manifestPath, manifest);
     // Apply event handler
     if (config.eventHandler) {
-        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler, false, config.typescript);
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, config, config.eventHandler, false, config.typescript);
     }
     // generate column content
     const content = config.properties && config.properties.length > 0
@@ -67,9 +67,8 @@ function generateCustomColumn(basePath, customColumn, fs) {
     validate_1.validateBasePath(basePath, fs);
     const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
     const manifest = fs.readJSON(manifestPath);
-    const root = path_1.join(__dirname, '../../templates');
     // merge with defaults
-    const completeColumn = enhanceConfig(fs, root, customColumn, manifestPath, manifest);
+    const completeColumn = enhanceConfig(fs, customColumn, manifestPath, manifest);
     // enhance manifest with column definition
     const manifestRoot = getManifestRoot(customColumn.ui5Version);
     const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeColumn, {});
@@ -77,7 +76,7 @@ function generateCustomColumn(basePath, customColumn, fs) {
     // add fragment
     const viewPath = path_1.join(completeColumn.path, `${completeColumn.name}.fragment.xml`);
     if (completeColumn.control || !fs.exists(viewPath)) {
-        fs.copyTpl(path_1.join(root, 'common/Fragment.xml'), viewPath, completeColumn);
+        fs.copyTpl(templates_1.getTemplatePath('common/Fragment.xml'), viewPath, completeColumn);
     }
     return fs;
 }

package/dist/common/event-handler.d.ts

@@ -4,12 +4,11 @@ import type { EventHandlerConfiguration, InternalCustomElement } from '../common
  * Method creates or updates handler js file and update 'settings.eventHandler' entry with namespace path entry to method.
  *
  * @param {Editor} fs - the memfs editor instance
- * @param {string} root - the root path
  * @param {InternalCustomElement} config - configuration
  * @param {EventHandlerConfiguration | true | string} [eventHandler] - eventHandler for creation
  * @param {boolean} [controllerSuffix=false] - append controller suffix to new file
  * @param {boolean} typescript - create Typescript file instead of Javascript
  * @returns {string} full namespace path to method
  */
-export declare function applyEventHandlerConfiguration(fs: Editor, root: string, config: Partial<InternalCustomElement>, eventHandler: EventHandlerConfiguration | true | string, controllerSuffix?: boolean, typescript?: boolean): string;
+export declare function applyEventHandlerConfiguration(fs: Editor, config: Partial<InternalCustomElement>, eventHandler: EventHandlerConfiguration | true | string, controllerSuffix?: boolean, typescript?: boolean): string;
 //# sourceMappingURL=event-handler.d.ts.map

package/dist/common/event-handler.js

@@ -2,19 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.applyEventHandlerConfiguration = void 0;
 const path_1 = require("path");
+const templates_1 = require("../templates");
 const utils_1 = require("../common/utils");
 /**
  * Method creates or updates handler js file and update 'settings.eventHandler' entry with namespace path entry to method.
  *
  * @param {Editor} fs - the memfs editor instance
- * @param {string} root - the root path
  * @param {InternalCustomElement} config - configuration
  * @param {EventHandlerConfiguration | true | string} [eventHandler] - eventHandler for creation
  * @param {boolean} [controllerSuffix=false] - append controller suffix to new file
  * @param {boolean} typescript - create Typescript file instead of Javascript
  * @returns {string} full namespace path to method
  */
-function applyEventHandlerConfiguration(fs, root, config, eventHandler, controllerSuffix = false, typescript) {
+function applyEventHandlerConfiguration(fs, config, eventHandler, controllerSuffix = false, typescript) {
     if (typeof eventHandler === 'string') {
         // Existing event handler is passed - no need for file creation/update
         return eventHandler;
@@ -37,7 +37,7 @@ function applyEventHandlerConfiguration(fs, root, config, eventHandler, controll
     const ext = typescript ? 'ts' : 'js';
     const controllerPath = path_1.join(config.path || '', `${fileName}${controllerSuffix ? '.controller' : ''}.${ext}`);
     if (!fs.exists(controllerPath)) {
-        fs.copyTpl(path_1.join(root, `common/EventHandler.${ext}`), controllerPath, {
+        fs.copyTpl(templates_1.getTemplatePath(`common/EventHandler.${ext}`), controllerPath, {
             eventHandlerFnName
         });
     }

package/dist/page/custom.js

@@ -8,6 +8,7 @@ const ejs_1 = require("ejs");
 const common_1 = require("./common");
 const defaults_1 = require("../common/defaults");
 const validate_1 = require("../common/validate");
+const templates_1 = require("../templates");
 /**
  * Enhances the provided custom page configuration with default data.
  *
@@ -40,10 +41,10 @@ exports.enhanceData = enhanceData;
  */
 function getTemplateRoot(ui5Version) {
     if (ui5Version === undefined || ui5Version >= 1.94) {
-        return path_1.join(__dirname, '../../templates/page/custom/1.94');
+        return templates_1.getTemplatePath('/page/custom/1.94');
     }
     else {
-        return path_1.join(__dirname, '../../templates/page/custom/1.84');
+        return templates_1.getTemplatePath('/page/custom/1.84');
     }
 }
 exports.getTemplateRoot = getTemplateRoot;

package/dist/page/list.js

@@ -6,6 +6,7 @@ const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const ejs_1 = require("ejs");
 const common_1 = require("./common");
+const templates_1 = require("../templates");
 /**
  * Enhances the provided list report configuration with default data.
  *
@@ -50,7 +51,7 @@ function generate(basePath, data, fs) {
     const manifest = fs.readJSON(manifestPath);
     const config = enhanceData(data, manifest);
     // enhance manifest.json
-    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(path_1.join(__dirname, '../../templates/page/list/manifest.json')), config, {})), common_1.getManifestJsonExtensionHelper(config));
+    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(templates_1.getTemplatePath('page/list/manifest.json')), config, {})), common_1.getManifestJsonExtensionHelper(config));
     return fs;
 }
 exports.generate = generate;

package/dist/page/object.js

@@ -6,6 +6,7 @@ const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const ejs_1 = require("ejs");
 const common_1 = require("./common");
+const templates_1 = require("../templates");
 /**
  * Enhances the provided list report configuration with default data.
  *
@@ -41,7 +42,7 @@ function generate(basePath, data, fs) {
     const manifest = fs.readJSON(manifestPath);
     const config = enhanceData(data, manifest);
     // enhance manifest.json
-    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(path_1.join(__dirname, '../../templates/page/object/manifest.json')), config, {})), common_1.getManifestJsonExtensionHelper(config));
+    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(templates_1.getTemplatePath('/page/object/manifest.json')), config, {})), common_1.getManifestJsonExtensionHelper(config));
     return fs;
 }
 exports.generate = generate;

package/dist/section/index.d.ts

@@ -3,11 +3,10 @@ import type { CustomSection } from './types';
 /**
  * Get the template folder for the given UI5 version.
  *
- * @param root root path to templates folder.
  * @param ui5Version required UI5 version.
  * @returns path to the template folder containing the manifest.json ejs template
  */
-export declare function getManifestRoot(root: string, ui5Version?: number): string;
+export declare function getManifestRoot(ui5Version?: number): string;
 /**
  * Add a custom section to an existing UI5 application.
  *

package/dist/section/index.js

@@ -8,38 +8,37 @@ const ejs_1 = require("ejs");
 const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const event_handler_1 = require("../common/event-handler");
+const templates_1 = require("../templates");
 /**
  * Get the template folder for the given UI5 version.
  *
- * @param root root path to templates folder.
  * @param ui5Version required UI5 version.
  * @returns path to the template folder containing the manifest.json ejs template
  */
-function getManifestRoot(root, ui5Version) {
+function getManifestRoot(ui5Version) {
     let subFolder = '1.86';
     if (ui5Version !== undefined && ui5Version < 1.86) {
         // Old
         subFolder = '1.85';
     }
-    return path_1.join(root, 'section', subFolder);
+    return templates_1.getTemplatePath(path_1.join('section', subFolder));
 }
 exports.getManifestRoot = getManifestRoot;
 /**
  * Enhances the provided custom section configuration with additonal data.
  *
  * @param {Editor} fs - the mem-fs editor instance
- * @param {string} root - root path
  * @param {CustomSection} data - a custom section configuration object
  * @param {string} manifestPath - path to the project's manifest.json
  * @param {Manifest} manifest - the application manifest
  * @returns enhanced configuration
  */
-function enhanceConfig(fs, root, data, manifestPath, manifest) {
+function enhanceConfig(fs, data, manifestPath, manifest) {
     const config = Object.assign({}, data);
     defaults_1.setCommonDefaults(config, manifestPath, manifest);
     // Apply event handler
     if (config.eventHandler) {
-        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler, false, config.typescript);
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, config, config.eventHandler, false, config.typescript);
     }
     // generate section content
     config.content = config.control || defaults_1.getDefaultFragmentContent(config.name, config.eventHandler);
@@ -61,17 +60,16 @@ function generateCustomSection(basePath, customSection, fs) {
     validate_1.validateBasePath(basePath, fs);
     const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
     const manifest = fs.readJSON(manifestPath);
-    const root = path_1.join(__dirname, '../../templates');
     // merge with defaults
-    const completeSection = enhanceConfig(fs, root, customSection, manifestPath, manifest);
+    const completeSection = enhanceConfig(fs, customSection, manifestPath, manifest);
     // enhance manifest with section definition
-    const manifestRoot = getManifestRoot(root, customSection.ui5Version);
+    const manifestRoot = getManifestRoot(customSection.ui5Version);
     const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeSection, {});
     fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
     // add fragment
     const viewPath = path_1.join(completeSection.path, `${completeSection.name}.fragment.xml`);
     if (!fs.exists(viewPath)) {
-        fs.copyTpl(path_1.join(root, 'common/Fragment.xml'), viewPath, completeSection);
+        fs.copyTpl(templates_1.getTemplatePath('common/Fragment.xml'), viewPath, completeSection);
     }
     return fs;
 }

package/dist/templates.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Locates template files relative to the dist folder.
+ * This helps to locate templates when this module is bundled and the dir structure is flattened, maintaining the relative paths.
+ *
+ * @param relativeTemplatePath - optional, the path of the required template relative to the ./templates folder. If not specified the root templates folder is returned.
+ * @returns the path of the template specified or templates root folder
+ */
+export declare function getTemplatePath(relativeTemplatePath?: string): string;
+//# sourceMappingURL=templates.d.ts.map

package/dist/templates.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTemplatePath = void 0;
+const path_1 = require("path");
+/**
+ * Locates template files relative to the dist folder.
+ * This helps to locate templates when this module is bundled and the dir structure is flattened, maintaining the relative paths.
+ *
+ * @param relativeTemplatePath - optional, the path of the required template relative to the ./templates folder. If not specified the root templates folder is returned.
+ * @returns the path of the template specified or templates root folder
+ */
+function getTemplatePath(relativeTemplatePath = '') {
+    return path_1.join(__dirname, '../templates', relativeTemplatePath);
+}
+exports.getTemplatePath = getTemplatePath;
+//# sourceMappingURL=templates.js.map

package/dist/view/index.js

@@ -8,23 +8,23 @@ const ejs_1 = require("ejs");
 const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
 const event_handler_1 = require("../common/event-handler");
+const templates_1 = require("../templates");
 /**
  * Enhances the provided custom view configuration with default data.
  *
  * @param {Editor} fs - the mem-fs editor instance
- * @param {string} root - root path
  * @param {CustomView} data - a custom view configuration object
  * @param {string} manifestPath - path to the project's manifest.json
  * @param {Manifest} manifest - the application manifest
  * @returns enhanced configuration
  */
-function enhanceConfig(fs, root, data, manifestPath, manifest) {
+function enhanceConfig(fs, data, manifestPath, manifest) {
     var _a, _b, _c, _d, _e;
     const config = Object.assign({}, data);
     defaults_1.setCommonDefaults(config, manifestPath, manifest);
     // Apply event handler
     if (config.eventHandler) {
-        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler, true, config.typescript);
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, config, config.eventHandler, true, config.typescript);
     }
     // existing views
     const existingViews = (_e = (_d = ((_c = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.routing) === null || _b === void 0 ? void 0 : _b.targets) === null || _c === void 0 ? void 0 : _c[data.target])
@@ -57,19 +57,18 @@ function generateCustomView(basePath, customView, fs) {
     validate_1.validateBasePath(basePath, fs);
     const manifestPath = path_1.join(basePath, 'webapp/manifest.json');
     const manifest = fs.readJSON(manifestPath);
-    const root = path_1.join(__dirname, '../../templates');
     // merge with defaults
-    const completeView = enhanceConfig(fs, root, customView, manifestPath, manifest);
+    const completeView = enhanceConfig(fs, customView, manifestPath, manifest);
     // enhance manifest with view definition
-    const filledTemplate = ejs_1.render(fs.read(path_1.join(root, 'view', `manifest.json`)), completeView, {});
+    const filledTemplate = ejs_1.render(fs.read(templates_1.getTemplatePath('view/manifest.json')), completeView, {});
     fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
     // add fragment
     const viewPath = path_1.join(completeView.path, `${completeView.name}.fragment.xml`);
     if (completeView.control === true) {
-        fs.copyTpl(path_1.join(root, 'view/ext/CustomViewWithTable.xml'), viewPath, completeView);
+        fs.copyTpl(templates_1.getTemplatePath('view/ext/CustomViewWithTable.xml'), viewPath, completeView);
     }
     else if (!fs.exists(viewPath)) {
-        fs.copyTpl(path_1.join(root, 'common/Fragment.xml'), viewPath, completeView);
+        fs.copyTpl(templates_1.getTemplatePath('common/Fragment.xml'), viewPath, completeView);
     }
     return fs;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.14.0",
+  "version": "0.14.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",

package/templates/app/Component.js

@@ -9,14 +9,5 @@ sap.ui.define(
             metadata: {
                 manifest: "json"
             }
-            
-            /**
-             * The component is initialized by UI5 automatically during the startup of the app and calls the init method once.
-             * @public
-             * @override
-             */
-            //init: function() {
-            //    AppComponent.prototype.init.apply(this, arguments);
-            //}
         });
 });

package/templates/app/Component.ts

@@ -1,20 +1,11 @@
 import AppComponent from 'sap/fe/core/AppComponent';
 
 /**
- * @namespace <%- app.id %>
+ * @namespace <%- id %>
  */
 export default class Component extends AppComponent {
 
 	public static metadata = {
 		manifest: "json"
 	};
-
-    /**
-     * The component is initialized by UI5 automatically during the startup of the app and calls the init method once.
-     * @public
-     * @override
-     */
-	//public init() : void {
-    //    super.init();
-	//}
-}
+}