@sap-ux/fe-fpm-writer 0.38.1 → 0.38.3

package/dist/action/index.js

@@ -99,7 +99,7 @@ async function generateCustomAction(basePath, actionConfig, fs) {
         config.eventHandler = (0, event_handler_1.applyEventHandlerConfiguration)(fs, config, config.eventHandler, {
             controllerSuffix: false,
             typescript: config.typescript
-        }, event_handler_1.contextParameter);
+        }, [event_handler_1.contextParameter, event_handler_1.selectedContextsParameter]);
     }
     // enhance manifest with action definition and controller reference
     const actions = enhanceManifestAndGetActionsElementReference(manifest, config.target);

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

@@ -9,23 +9,32 @@ interface EventHandlerConfigurationOptions {
     templatePath?: string;
     eventHandlerFnName?: string;
 }
+type EventHandlerTypescriptParameters = EventHandlerTypescriptParameter[];
 /**
  * Interface to describe the input parameters for the generated event handler function.
  */
-export interface EventHandlerTypescriptParameters {
+export interface EventHandlerTypescriptParameter {
+    /** Variable name in TypeScript style */
     name: string;
+    /** Variable name in JavaScript style (Hungarian notation) */
+    jsName: string;
     description: string;
     importType: string;
+    /**
+     * Optional. If not defined, the parameter type will be taken from `importType`.
+     */
+    paramType?: string;
     importSource: string;
 }
 /**
  * Default values for the input parameters of newly created event handlers.
  */
-export declare const defaultParameter: EventHandlerTypescriptParameters;
+export declare const defaultParameter: EventHandlerTypescriptParameter;
 /**
  * Values for the input parameters of newly created event handlers that are added as manifest actions.
  */
-export declare const contextParameter: EventHandlerTypescriptParameters;
+export declare const contextParameter: EventHandlerTypescriptParameter;
+export declare const selectedContextsParameter: EventHandlerTypescriptParameter;
 /**
  * Method creates or updates handler js file and update 'settings.eventHandler' entry with namespace path entry to method.
  *
@@ -33,7 +42,7 @@ export declare const contextParameter: EventHandlerTypescriptParameters;
  * @param config - configuration
  * @param eventHandler - eventHandler for creation
  * @param eventHandlerOptions - eventHandler options
- * @param parameters - parameter configurations for the event handler
+ * @param parameters - parameters and its configurations for the event handler
  * @returns {string} full namespace path to method
  */
 export declare function applyEventHandlerConfiguration(fs: Editor, config: Partial<InternalCustomElement>, eventHandler: EventHandlerConfiguration | true | string, eventHandlerOptions: EventHandlerConfigurationOptions, parameters?: EventHandlerTypescriptParameters): string;

package/dist/common/event-handler.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.contextParameter = exports.defaultParameter = void 0;
+exports.selectedContextsParameter = exports.contextParameter = exports.defaultParameter = void 0;
 exports.applyEventHandlerConfiguration = applyEventHandlerConfiguration;
 const path_1 = require("path");
 const templates_1 = require("../templates");
@@ -10,7 +10,8 @@ const utils_1 = require("../common/utils");
  */
 exports.defaultParameter = {
     name: 'event',
-    description: 'the event object provided by the event provider',
+    jsName: 'oEvent',
+    description: 'the event object provided by the event provider.',
     importType: 'UI5Event',
     importSource: 'sap/ui/base/Event'
 };
@@ -18,9 +19,19 @@ exports.defaultParameter = {
  * Values for the input parameters of newly created event handlers that are added as manifest actions.
  */
 exports.contextParameter = {
-    name: 'pageContext',
-    description: 'the context of the page on which the event was fired',
+    name: 'context',
+    jsName: 'oContext',
+    description: 'the context of the page on which the event was fired. `undefined` for list report page.',
     importType: 'Context',
+    paramType: 'Context | undefined',
+    importSource: 'sap/ui/model/odata/v4/Context'
+};
+exports.selectedContextsParameter = {
+    name: 'selectedContexts',
+    jsName: 'aSelectedContexts',
+    description: 'the selected contexts of the table rows.',
+    importType: 'Context',
+    paramType: 'Context[]',
     importSource: 'sap/ui/model/odata/v4/Context'
 };
 /**
@@ -49,10 +60,10 @@ function getFileName(fileName, controllerPrefix) {
  * @param config - configuration
  * @param eventHandler - eventHandler for creation
  * @param eventHandlerOptions - eventHandler options
- * @param parameters - parameter configurations for the event handler
+ * @param parameters - parameters and its configurations for the event handler
  * @returns {string} full namespace path to method
  */
-function applyEventHandlerConfiguration(fs, config, eventHandler, eventHandlerOptions, parameters = exports.defaultParameter) {
+function applyEventHandlerConfiguration(fs, config, eventHandler, eventHandlerOptions, parameters = [exports.defaultParameter]) {
     const { controllerSuffix, typescript, templatePath = 'common/EventHandler' } = eventHandlerOptions;
     let { eventHandlerFnName = 'onPress' } = eventHandlerOptions;
     if (typeof eventHandler === 'string') {

package/dist/filter/index.js

@@ -56,7 +56,7 @@ async function generateCustomFilter(basePath, filterConfig, fs) {
             controllerSuffix: false,
             typescript: config.typescript,
             templatePath: 'filter/Controller'
-        }, event_handler_1.contextParameter);
+        }, [event_handler_1.contextParameter]);
     }
     // enhance manifest with the filter definition and controller reference
     const filters = enhanceManifestAndGetFiltersReference(manifest);

package/dist/page/custom.d.ts

@@ -1,5 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
 import type { CustomPage, InternalCustomPage } from './types';
+import type { Logger } from '@sap-ux/logger';
 /**
  * Enhances the provided custom page configuration with default data.
  *
@@ -22,7 +23,8 @@ export declare function getTemplateRoot(ui5Version?: string): string;
  * @param {string} basePath - the base path
  * @param {CustomPage} data - the custom page configuration
  * @param {Editor} [fs] - the memfs editor instance
+ * @param {Logger} [log] - Logger instance
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-export declare function generate(basePath: string, data: CustomPage, fs?: Editor): Promise<Editor>;
+export declare function generate(basePath: string, data: CustomPage, fs?: Editor, log?: Logger): Promise<Editor>;
 //# sourceMappingURL=custom.d.ts.map

package/dist/page/custom.js

@@ -18,6 +18,7 @@ const file_1 = require("../common/file");
 const building_block_1 = require("../building-block");
 const types_2 = require("../building-block/types");
 const xml_1 = require("../building-block/prompts/utils/xml");
+const i18n_1 = require("../i18n");
 /**
  * Enhances the provided custom page configuration with default data.
  *
@@ -61,15 +62,46 @@ function getTemplateRoot(ui5Version) {
         return (0, templates_1.getTemplatePath)('/page/custom/1.84');
     }
 }
+/**
+ * Handles the creation of a page building block for a custom page.
+ *
+ * @param {string} basePath - The base path of the UI5 application.
+ * @param {{ pageBuildingBlockTitle: string; minUI5Version?: string }} data - Object containing the building block title and optional minimum UI5 version.
+ * @param data.pageBuildingBlockTitle
+ * @param data.minUI5Version
+ * @param {string} viewPath - The path to the view XML file.
+ * @param {Editor} fs - The memfs editor instance.
+ * @param {Logger} [log] - Logger instance.
+ * @returns {Promise<void>} Resolves when the building block is handled or skipped due to version constraints.
+ */
+async function handlePageBuildingBlock(basePath, data, viewPath, fs, log) {
+    const minVersion = (0, semver_1.coerce)(data.minUI5Version);
+    const t = (0, i18n_1.translate)(i18n_1.i18nNamespaces.buildingBlock, 'pageBuildingBlock.');
+    if (minVersion && (0, semver_1.lt)(minVersion.version, '1.136.0')) {
+        log?.warn(t('minUi5VersionRequirement', { minUI5Version: data.minUI5Version }));
+        return;
+    }
+    await (0, building_block_1.generateBuildingBlock)(basePath, {
+        viewOrFragmentPath: (0, path_1.relative)(basePath, viewPath),
+        aggregationPath: (0, xml_1.augmentXpathWithLocalNames)(`/mvc:View/Page`),
+        replace: true,
+        buildingBlockData: {
+            id: 'Page',
+            buildingBlockType: types_2.BuildingBlockType.Page,
+            title: data.pageBuildingBlockTitle
+        }
+    }, fs);
+}
 /**
  * Add a custom page to an existing UI5 application.
  *
  * @param {string} basePath - the base path
  * @param {CustomPage} data - the custom page configuration
  * @param {Editor} [fs] - the memfs editor instance
+ * @param {Logger} [log] - Logger instance
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-async function generate(basePath, data, fs) {
+async function generate(basePath, data, fs, log) {
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
@@ -104,16 +136,7 @@ async function generate(basePath, data, fs) {
         }
     }
     if (data.pageBuildingBlockTitle) {
-        await (0, building_block_1.generateBuildingBlock)(basePath, {
-            viewOrFragmentPath: (0, path_1.relative)(basePath, viewPath),
-            aggregationPath: (0, xml_1.augmentXpathWithLocalNames)(`/mvc:View/Page`),
-            replace: true,
-            buildingBlockData: {
-                id: 'Page',
-                buildingBlockType: types_2.BuildingBlockType.Page,
-                title: data.pageBuildingBlockTitle
-            }
-        }, fs);
+        await handlePageBuildingBlock(basePath, { pageBuildingBlockTitle: data.pageBuildingBlockTitle, minUI5Version: data.minUI5Version }, viewPath, fs, log);
     }
     const ext = data.typescript ? 'ts' : 'js';
     const controllerPath = (0, path_1.join)(config.path, `${config.name}.controller.${ext}`);

package/dist/prompts/translations/i18n.d.ts

@@ -204,6 +204,9 @@ declare const ns1: {
             };
         };
     };
+    pageBuildingBlock: {
+        minUi5VersionRequirement: string;
+    };
 };
 export default ns1;
 //# sourceMappingURL=i18n.d.ts.map

package/dist/prompts/translations/i18n.js

@@ -229,6 +229,9 @@ const ns1 = {
                 'translationAnnotation': 'Description of the Page.'
             }
         }
+    },
+    'pageBuildingBlock': {
+        'minUi5VersionRequirement': 'The Page building block feature requires SAPUI5 1.136.0 or higher. The current version is {{ minUI5Version }}, so the Page building block will not be added.'
     }
 };
 exports.default = ns1;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.38.1",
+  "version": "0.38.3",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,7 +31,8 @@
     "xml-formatter": "2.6.1",
     "xpath": "0.0.33",
     "@sap-ux/fiori-annotation-api": "0.6.17",
-    "@sap-ux/project-access": "1.30.13"
+    "@sap-ux/project-access": "1.30.13",
+    "@sap-ux/logger": "0.7.0"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.6",

package/templates/common/EventHandler.js

@@ -4,7 +4,21 @@ sap.ui.define([
     'use strict';
 
     return {
-        <%- eventHandlerFnName %>: function(oEvent) {
+<% if (typeof parameters !== "undefined" && parameters.length) { -%>
+        /**
+         * Generated event handler.
+         *
+<% parameters.forEach(function(param) { -%>
+         * @param <%- param.jsName %> <%- param.description %>
+<% }) -%>
+         */
+<% } -%>
+        <%- eventHandlerFnName %>: function(<%=
+            (typeof parameters !== "undefined" ? parameters : [])
+                .map(function(param) {
+                    return param.jsName;
+                }).join(", ")
+        -%>) {
             MessageToast.show("Custom handler invoked.");
         }
     };

package/templates/common/EventHandler.ts

@@ -1,13 +1,28 @@
 import ExtensionAPI from 'sap/fe/core/ExtensionAPI';
-import <%- parameters.importType %> from '<%- parameters.importSource %>';
+<%
+const importedTypes = new Set();
+parameters.forEach(param => {
+  if (param.importType && !importedTypes.has(param.importType)) {
+    importedTypes.add(param.importType);
+-%>
+import <%- param.importType %> from '<%- param.importSource %>';
+<% 
+  }
+}); -%>
 import MessageToast from 'sap/m/MessageToast';
 
 /**
  * Generated event handler.
  *
  * @param this reference to the 'this' that the event handler is bound to.
- * @param <%- parameters.name %> <%- parameters.description %>
+<% parameters.forEach(function(param) { -%>
+ * @param <%- param.name %> <%- param.description %>
+<% }) -%>
  */
-export function <%- eventHandlerFnName %>(this: ExtensionAPI, <%- parameters.name %>: <%- parameters.importType %>) {
+export function <%- eventHandlerFnName %>(this: ExtensionAPI, <%=
+    parameters.map(function(param) {
+        return param.name + ": " + (param.paramType ?? param.importType);
+    }).join(", ")
+%>) {
     MessageToast.show("Custom handler invoked.");
 }