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

package/dist/action/index.js

@@ -77,11 +77,11 @@ function generateCustomAction(basePath, actionConfig, fs) {
     const root = path_1.join(__dirname, '../../templates');
     // Apply event handler
     if (config.eventHandler) {
-        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler);
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, 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(path_1.join(root, `action/manifest.action.json`)), config, {})));
     fs.writeJSON(manifestPath, manifest);
     return fs;
 }

package/dist/app/index.d.ts

@@ -13,6 +13,7 @@ export interface FPMConfig {
      * (Note: if set to false, nothing will be done i.e. FCL is not disabled)
      */
     fcl?: boolean;
+    typescript?: boolean;
 }
 export declare const MIN_VERSION = "1.94.0";
 /**

package/dist/app/index.js

@@ -68,8 +68,9 @@ function enableFPM(basePath, config = {}, fs) {
     }
     // replace Component.js
     if (config.replaceAppComponent) {
-        const componentTemplate = path_1.join(__dirname, '../../templates/app/Component.js');
-        fs.copyTpl(componentTemplate, path_1.join(basePath, 'webapp/Component.js'), manifest['sap.app']);
+        const ext = config.typescript ? 'ts' : 'js';
+        const componentTemplate = path_1.join(__dirname, `../../templates/app/Component.${ext}`);
+        fs.copyTpl(componentTemplate, path_1.join(basePath, `webapp/Component.${ext}`), manifest['sap.app']);
     }
     return fs;
 }

package/dist/building-block/index.js

@@ -95,6 +95,7 @@ function getOrAddMacrosNamespace(ui5XmlDocument) {
     const macrosNamespaceEntry = Object.entries(namespaceMap).find(([_, value]) => value === 'sap.fe.macros');
     if (!macrosNamespaceEntry) {
         ui5XmlDocument.firstChild._nsMap['macros'] = 'sap.fe.macros';
+        ui5XmlDocument.documentElement.setAttributeNS('http://www.w3.org/2000/xmlns/', 'xmlns:macros', 'sap.fe.macros');
     }
     return macrosNamespaceEntry ? macrosNamespaceEntry[0] : 'macros';
 }
@@ -112,7 +113,7 @@ function getTemplateDocument(buildingBlockData, viewDocument, fs) {
     const templateContent = ejs_1.render(fs.read(templateFilePath), {
         macrosNamespace: getOrAddMacrosNamespace(viewDocument),
         data: buildingBlockData
-    });
+    }, {});
     const errorHandler = (level, message) => {
         throw new Error(`Unable to parse template file with building block data. Details: [${level}] - ${message}`);
     };

package/dist/column/index.js

@@ -42,7 +42,7 @@ function enhanceConfig(fs, root, data, manifestPath, manifest) {
     defaults_1.setCommonDefaults(config, manifestPath, manifest);
     // Apply event handler
     if (config.eventHandler) {
-        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler);
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler, false, config.typescript);
     }
     // generate column content
     const content = config.properties && config.properties.length > 0
@@ -72,7 +72,7 @@ function generateCustomColumn(basePath, customColumn, fs) {
     const completeColumn = enhanceConfig(fs, root, 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);
+    const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeColumn, {});
     fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
     // add fragment
     const viewPath = path_1.join(completeColumn.path, `${completeColumn.name}.fragment.xml`);

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

@@ -8,7 +8,8 @@ import type { EventHandlerConfiguration, InternalCustomElement } from '../common
  * @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): string;
+export declare function applyEventHandlerConfiguration(fs: Editor, root: string, config: Partial<InternalCustomElement>, eventHandler: EventHandlerConfiguration | true | string, controllerSuffix?: boolean, typescript?: boolean): string;
 //# sourceMappingURL=event-handler.d.ts.map

package/dist/common/event-handler.js

@@ -11,9 +11,10 @@ const utils_1 = require("../common/utils");
  * @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) {
+function applyEventHandlerConfiguration(fs, root, config, eventHandler, controllerSuffix = false, typescript) {
     if (typeof eventHandler === 'string') {
         // Existing event handler is passed - no need for file creation/update
         return eventHandler;
@@ -33,9 +34,10 @@ function applyEventHandlerConfiguration(fs, root, config, eventHandler, controll
             fileName = eventHandler.fileName;
         }
     }
-    const controllerPath = path_1.join(config.path || '', `${fileName}${controllerSuffix ? '.controller' : ''}.js`);
+    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.js'), controllerPath, {
+        fs.copyTpl(path_1.join(root, `common/EventHandler.${ext}`), controllerPath, {
             eventHandlerFnName
         });
     }

package/dist/common/types.d.ts

@@ -21,6 +21,10 @@ export interface CustomElement {
      * If nothing can be generated for the given version then an exception is thrown.
      */
     ui5Version?: number;
+    /**
+     * If set to true then all code snippets are generated in Typescript instead of Javascript.
+     */
+    typescript?: boolean;
 }
 export interface InternalCustomElement extends CustomElement {
     ns: string;

package/dist/page/custom.js

@@ -66,15 +66,16 @@ function generate(basePath, data, fs) {
     // merge content into existing files
     const root = getTemplateRoot(data.ui5Version);
     // enhance manifest.json
-    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(path_1.join(root, `manifest.json`)), config)), common_1.getManifestJsonExtensionHelper(config));
+    fs.extendJSON(manifestPath, JSON.parse(ejs_1.render(fs.read(path_1.join(root, `manifest.json`)), config, {})), common_1.getManifestJsonExtensionHelper(config));
     // add extension content
     const viewPath = path_1.join(config.path, `${config.name}.view.xml`);
     if (!fs.exists(viewPath)) {
         fs.copyTpl(path_1.join(root, 'ext/View.xml'), viewPath, config);
     }
-    const controllerPath = path_1.join(config.path, `${config.name}.controller.js`);
+    const ext = data.typescript ? 'ts' : 'js';
+    const controllerPath = path_1.join(config.path, `${config.name}.controller.${ext}`);
     if (!fs.exists(controllerPath)) {
-        fs.copyTpl(path_1.join(root, 'ext/Controller.js'), controllerPath, config);
+        fs.copyTpl(path_1.join(root, `ext/Controller.${ext}`), controllerPath, config);
     }
     return fs;
 }

package/dist/page/list.js

@@ -50,7 +50,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(path_1.join(__dirname, '../../templates/page/list/manifest.json')), config, {})), common_1.getManifestJsonExtensionHelper(config));
     return fs;
 }
 exports.generate = generate;

package/dist/page/object.js

@@ -41,7 +41,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(path_1.join(__dirname, '../../templates/page/object/manifest.json')), config, {})), common_1.getManifestJsonExtensionHelper(config));
     return fs;
 }
 exports.generate = generate;

package/dist/section/index.js

@@ -39,7 +39,7 @@ function enhanceConfig(fs, root, data, manifestPath, manifest) {
     defaults_1.setCommonDefaults(config, manifestPath, manifest);
     // Apply event handler
     if (config.eventHandler) {
-        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler);
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler, false, config.typescript);
     }
     // generate section content
     config.content = config.control || defaults_1.getDefaultFragmentContent(config.name, config.eventHandler);
@@ -66,7 +66,7 @@ function generateCustomSection(basePath, customSection, fs) {
     const completeSection = enhanceConfig(fs, root, customSection, manifestPath, manifest);
     // enhance manifest with section definition
     const manifestRoot = getManifestRoot(root, customSection.ui5Version);
-    const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeSection);
+    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`);

package/dist/view/index.js

@@ -24,7 +24,7 @@ function enhanceConfig(fs, root, data, manifestPath, manifest) {
     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.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, 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])
@@ -61,7 +61,7 @@ function generateCustomView(basePath, customView, fs) {
     // merge with defaults
     const completeView = enhanceConfig(fs, root, 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(path_1.join(root, 'view', `manifest.json`)), completeView, {});
     fs.extendJSON(manifestPath, JSON.parse(filledTemplate));
     // add fragment
     const viewPath = path_1.join(completeView.path, `${completeView.name}.fragment.xml`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.13.4",
+  "version": "0.14.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -33,7 +33,7 @@
     "@types/semver": "7.3.9",
     "@types/mem-fs-editor": "7.0.1",
     "@types/mem-fs": "1.1.2",
-    "@sap-ux/ui5-config": "0.14.4"
+    "@sap-ux/ui5-config": "0.14.5"
   },
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",

package/templates/app/Component.ts

@@ -0,0 +1,20 @@
+import AppComponent from 'sap/fe/core/AppComponent';
+
+/**
+ * @namespace <%- app.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();
+	//}
+}

package/templates/common/EventHandler.ts

@@ -0,0 +1,5 @@
+import MessageToast from 'sap/m/MessageToast';
+
+export function <%- (typeof eventHandlerFnName !== 'undefined' && eventHandlerFnName) || 'onPress' %>() {
+    MessageToast.show("Custom handler invoked.");
+}

package/templates/page/custom/1.84/ext/Controller.ts

@@ -0,0 +1,42 @@
+import Controller from 'sap/ui/core/mvc/Controller'; /** If UI5 version 1.94 or newer can be used, the change the base controller to sap/fe/core/PageController to get full FEv4 FPM support */
+
+/**
+ * @namespace <%- ns %>.<%- name %>.controller
+ */
+export default class <%- name %> extends Controller {
+
+    /**
+     * Called when a controller is instantiated and its View controls (if available) are already created.
+     * Can be used to modify the View before it is displayed, to bind event handlers and do other one-time initialization.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public onInit(): void {
+    //
+    //}
+
+    /**
+     * Similar to onAfterRendering, but this hook is invoked before the controller's View is re-rendered
+     * (NOT before the first rendering! onInit() is used for that one!).
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public  onBeforeRendering(): void {
+    //
+    //  },
+
+    /**
+     * Called when the View has been rendered (so its HTML is part of the document). Post-rendering manipulations of the HTML could be done here.
+     * This hook is the same one that SAPUI5 controls get after being rendered.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public  onAfterRendering(): void {
+    //
+    //  },
+
+    /**
+     * Called when the Controller is destroyed. Use this one to free resources and finalize activities.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public onExit(): void {
+    //
+    //  }
+}

package/templates/page/custom/1.84/ext/View.xml

@@ -1,6 +1,6 @@
 <mvc:View xmlns:core="sap.ui.core" xmlns:mvc="sap.ui.core.mvc" xmlns="sap.m"
     xmlns:html="http://www.w3.org/1999/xhtml" controllerName="<%- ns %>.<%- name %>">
-    <Page title="<%- view.title %>">
+    <Page id="<%- name %>" title="<%- view.title %>">
         <content></content>
     </Page>
 </mvc:View>

package/templates/page/custom/1.94/ext/Controller.ts

@@ -0,0 +1,42 @@
+import Controller from 'sap/fe/core/PageController';
+
+/**
+ * @namespace <%- ns %>.<%- name %>.controller
+ */
+export default class <%- name %> extends Controller {
+
+    /**
+     * Called when a controller is instantiated and its View controls (if available) are already created.
+     * Can be used to modify the View before it is displayed, to bind event handlers and do other one-time initialization.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public onInit(): void {
+    //
+    //}
+
+    /**
+     * Similar to onAfterRendering, but this hook is invoked before the controller's View is re-rendered
+     * (NOT before the first rendering! onInit() is used for that one!).
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public  onBeforeRendering(): void {
+    //
+    //  },
+
+    /**
+     * Called when the View has been rendered (so its HTML is part of the document). Post-rendering manipulations of the HTML could be done here.
+     * This hook is the same one that SAPUI5 controls get after being rendered.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public  onAfterRendering(): void {
+    //
+    //  },
+
+    /**
+     * Called when the Controller is destroyed. Use this one to free resources and finalize activities.
+     * @memberOf <%- ns %>.<%- name %>
+     */
+    // public onExit(): void {
+    //
+    //  }
+}

package/templates/page/custom/1.94/ext/View.xml

@@ -1,6 +1,6 @@
 <mvc:View xmlns:core="sap.ui.core" xmlns:mvc="sap.ui.core.mvc" xmlns="sap.m"
     xmlns:html="http://www.w3.org/1999/xhtml" controllerName="<%- ns %>.<%- name %>">
-    <Page title="<%- view.title %>">
+    <Page id="<%- name %>" title="<%- view.title %>">
         <content></content>
     </Page>
 </mvc:View>