@sap-ux/fe-fpm-writer 0.24.8 → 0.24.10

package/dist/common/defaults.d.ts

@@ -1,4 +1,4 @@
-import type { CustomElement, InternalCustomElement, Manifest } from './types';
+import type { CustomElement, FragmentContentData, InternalCustomElement, Manifest } from './types';
 export declare const FCL_ROUTER = "sap.f.routing.Router";
 /**
  * Sets the common default values for all custom elements.
@@ -9,6 +9,19 @@ export declare const FCL_ROUTER = "sap.f.routing.Router";
  * @returns enhanced configuration
  */
 export declare function setCommonDefaults<T extends CustomElement & Partial<InternalCustomElement>>(config: T, manifestPath: string, manifest: Manifest): InternalCustomElement & T;
+/**
+ * Method to generate default content data for xml fragment.
+ *
+ * @param {string} text - text of button or label
+ * @param {string} [eventHandler] - event handler path
+ *      if value is passed then "Button" control with 'press' event would be generated
+ *      if value is not passed then "Text" control would be generated
+ * @param {boolean} isController - controls if `controller` should be added to handler path
+ * @param {boolean} prefferInput - controls if `input` element should be added to default fragment content
+ * @param {boolean} includeRequireInContent - controls if `core:require` attribute should be included to fragment content
+ * @returns default content for fragment
+ */
+export declare function getDefaultFragmentContentData(text: string, eventHandler?: string, isController?: boolean, prefferInput?: boolean, includeRequireInContent?: boolean): FragmentContentData;
 /**
  * Method to generate default content for xml fragment.
  *

package/dist/common/defaults.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDefaultFragmentContent = exports.setCommonDefaults = exports.FCL_ROUTER = void 0;
+exports.getDefaultFragmentContent = exports.getDefaultFragmentContentData = exports.setCommonDefaults = exports.FCL_ROUTER = void 0;
 const path_1 = require("path");
 exports.FCL_ROUTER = 'sap.f.routing.Router';
 /**
@@ -21,7 +21,7 @@ function setCommonDefaults(config, manifestPath, manifest) {
 }
 exports.setCommonDefaults = setCommonDefaults;
 /**
- * Method to generate default content for xml fragment.
+ * Method to generate default content data for xml fragment.
  *
  * @param {string} text - text of button or label
  * @param {string} [eventHandler] - event handler path
@@ -29,20 +29,30 @@ exports.setCommonDefaults = setCommonDefaults;
  *      if value is not passed then "Text" control would be generated
  * @param {boolean} isController - controls if `controller` should be added to handler path
  * @param {boolean} prefferInput - controls if `input` element should be added to default fragment content
+ * @param {boolean} includeRequireInContent - controls if `core:require` attribute should be included to fragment content
  * @returns default content for fragment
  */
-function getDefaultFragmentContent(text, eventHandler, isController = false, prefferInput = false) {
+function getDefaultFragmentContentData(text, eventHandler, isController = false, prefferInput = false, includeRequireInContent = true) {
     let content;
+    let requireAttribute;
     if (eventHandler) {
         const parts = eventHandler.split('.');
         const method = parts.pop();
         const handler = `${parts.join('/')}${isController ? '.controller' : ''}`;
-        const requireAttr = `core:require="{ handler: '${handler}'}"`;
+        requireAttribute = `core:require="{ handler: '${handler}'}"`;
+        const attributes = [];
+        if (includeRequireInContent) {
+            attributes.push(requireAttribute);
+        }
         if (prefferInput) {
-            content = `<Input ${requireAttr} value="${text}" change="handler.${method}" />`;
+            attributes.push(`value="${text}"`);
+            attributes.push(`change="handler.${method}"`);
+            content = `<Input ${attributes.join(' ')} />`;
         }
         else {
-            content = `<Button ${requireAttr} text="${text}" press="handler.${method}" />`;
+            attributes.push(`text="${text}"`);
+            attributes.push(`press="handler.${method}"`);
+            content = `<Button ${attributes.join(' ')} />`;
         }
     }
     else if (prefferInput) {
@@ -51,7 +61,26 @@ function getDefaultFragmentContent(text, eventHandler, isController = false, pre
     else {
         content = `<Text text="${text}" />`;
     }
-    return content;
+    return {
+        content,
+        requireAttribute
+    };
+}
+exports.getDefaultFragmentContentData = getDefaultFragmentContentData;
+/**
+ * Method to generate default content for xml fragment.
+ *
+ * @param {string} text - text of button or label
+ * @param {string} [eventHandler] - event handler path
+ *      if value is passed then "Button" control with 'press' event would be generated
+ *      if value is not passed then "Text" control would be generated
+ * @param {boolean} isController - controls if `controller` should be added to handler path
+ * @param {boolean} prefferInput - controls if `input` element should be added to default fragment content
+ * @returns default content for fragment
+ */
+function getDefaultFragmentContent(text, eventHandler, isController = false, prefferInput = false) {
+    const contentData = getDefaultFragmentContentData(text, eventHandler, isController, prefferInput);
+    return contentData.content;
 }
 exports.getDefaultFragmentContent = getDefaultFragmentContent;
 //# sourceMappingURL=defaults.js.map

package/dist/common/event-handler.js

@@ -22,6 +22,25 @@ exports.contextParameter = {
     importType: 'Context',
     importSource: 'sap/ui/model/odata/v4/Context'
 };
+/**
+ * Method returns file name to use in namespace.
+ *
+ * @param fileName - event handler file name
+ * @param controllerPrefix - controller prefix '.extension'
+ * @returns {string} file name part for namespace
+ */
+function getFileName(fileName, controllerPrefix) {
+    let resolvedName;
+    // For name part in namespace we use passed file name or if it's controller extension, then remove 'controller' part from path
+    // 'Handler.controller' should be resolved as 'Handler' in namespace
+    if (controllerPrefix && fileName.endsWith('.controller')) {
+        resolvedName = fileName.replace('.controller', '');
+    }
+    else {
+        resolvedName = fileName;
+    }
+    return resolvedName;
+}
 /**
  * Method creates or updates handler js file and update 'settings.eventHandler' entry with namespace path entry to method.
  *
@@ -43,7 +62,10 @@ function applyEventHandlerConfiguration(fs, config, eventHandler, eventHandlerOp
     let controllerPrefix = '';
     // By default - use config name for created file name
     let fileName = config.name;
+    // Name part used in namespace
+    let resolvedName = fileName;
     if (typeof eventHandler === 'object') {
+        controllerPrefix = eventHandler.controllerPrefix;
         if (eventHandler.fnName) {
             eventHandlerFnName = eventHandler.fnName;
         }
@@ -51,8 +73,8 @@ function applyEventHandlerConfiguration(fs, config, eventHandler, eventHandlerOp
         if (eventHandler.fileName) {
             // Use passed file name
             fileName = eventHandler.fileName;
+            resolvedName = getFileName(fileName, controllerPrefix);
         }
-        controllerPrefix = eventHandler.controllerPrefix;
     }
     const ext = typescript ? 'ts' : 'js';
     const controllerPath = (0, path_1.join)(config.path || '', `${fileName}${controllerSuffix ? '.controller' : ''}.${ext}`);
@@ -73,7 +95,7 @@ function applyEventHandlerConfiguration(fs, config, eventHandler, eventHandlerOp
         fs.write(controllerPath, content);
     }
     // Return full namespace path to method
-    const fullNamespace = `${config.ns}.${fileName}.${eventHandlerFnName}`;
+    const fullNamespace = `${config.ns}.${resolvedName}.${eventHandlerFnName}`;
     return controllerPrefix ? `${controllerPrefix}.${fullNamespace}` : `${fullNamespace}`;
 }
 exports.applyEventHandlerConfiguration = applyEventHandlerConfiguration;

package/dist/common/types.d.ts

@@ -170,4 +170,11 @@ export interface CustomFragment {
      */
     fragmentFile?: string;
 }
+/**
+ * Interface represents content data of generated fragment.
+ */
+export interface FragmentContentData {
+    content: string;
+    requireAttribute?: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/dist/section/index.js

@@ -58,7 +58,12 @@ function enhanceConfig(fs, data, manifestPath, manifest) {
         });
     }
     // generate section content
-    config.content = config.control || (0, defaults_1.getDefaultFragmentContent)(config.name, config.eventHandler);
+    if (config.control) {
+        config.content = config.control;
+    }
+    else {
+        Object.assign(config, (0, defaults_1.getDefaultFragmentContentData)(config.name, config.eventHandler, undefined, undefined, false));
+    }
     // Additional dependencies to include into 'Fragment.xml'
     config.dependencies = getAdditionalDependencies(config.minUI5Version);
     return config;
@@ -106,7 +111,6 @@ function generate(basePath, customSection, manifestTemplateRoot, fs) {
  * @returns {Promise<Editor>} the updated mem-fs editor instance
  */
 function generateCustomHeaderSection(basePath, customHeaderSection, fs) {
-    var _a;
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
@@ -134,8 +138,12 @@ function generateCustomHeaderSection(basePath, customHeaderSection, fs) {
             });
         }
         // Generate edit fragment content
-        editSection.content =
-            (_a = editSection.control) !== null && _a !== void 0 ? _a : (0, defaults_1.getDefaultFragmentContent)(editSection.name, editSection.eventHandler, false, true);
+        if (editSection.control) {
+            editSection.content = editSection.control;
+        }
+        else {
+            Object.assign(editSection, (0, defaults_1.getDefaultFragmentContentData)(editSection.name, editSection.eventHandler, false, true, false));
+        }
         if (editSection.path) {
             const viewPath = (0, path_1.join)(editSection.path, `${editSection.name}.fragment.xml`);
             if (!editor.exists(viewPath)) {

package/dist/section/types.d.ts

@@ -1,4 +1,4 @@
-import type { CustomElement, InternalCustomElement, Position, EventHandler, CustomFragment } from '../common/types';
+import type { CustomElement, InternalCustomElement, Position, EventHandler, CustomFragment, FragmentContentData } from '../common/types';
 export interface CustomSection extends CustomElement, EventHandler, CustomFragment {
     /**
      * Name of the routing target
@@ -17,8 +17,7 @@ export interface CustomSection extends CustomElement, EventHandler, CustomFragme
      */
     control?: string;
 }
-export interface InternalCustomSection extends CustomHeaderSection, CustomSection, CustomSubSection, InternalCustomElement {
-    content: string;
+export interface InternalCustomSection extends CustomHeaderSection, CustomSection, CustomSubSection, InternalCustomElement, FragmentContentData {
     dependencies?: string;
 }
 export type HeaderSectionEditProperty = Pick<CustomElement, 'name' | 'folder'> & EventHandler;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.24.8",
+  "version": "0.24.10",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -33,7 +33,7 @@
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/semver": "7.5.2",
-    "@sap-ux/project-access": "1.17.4"
+    "@sap-ux/project-access": "1.19.12"
   },
   "engines": {
     "node": ">=18.x"

package/templates/common/FragmentWithForm.xml

@@ -1,5 +1,5 @@
 <core:FragmentDefinition xmlns:core="sap.ui.core" xmlns="sap.m" xmlns:f="sap.ui.layout.form"<%- typeof dependencies !== 'undefined' ? ` ${dependencies}` : '' %>>
-    <f:FormElement>
+    <f:FormElement<%- typeof requireAttribute !== 'undefined' ? ` ${requireAttribute}` : '' %>>
         <f:fields>
             <%- content %>
         </f:fields>

package/templates/common/FragmentWithVBox.xml

@@ -1,5 +1,5 @@
 <core:FragmentDefinition xmlns:core="sap.ui.core" xmlns="sap.m"<%- typeof dependencies !== 'undefined' ? ` ${dependencies}` : '' %>>
-	<VBox>
+	<VBox<%- typeof requireAttribute !== 'undefined' ? ` ${requireAttribute}` : '' %>>
 		<%- content %>
 	</VBox>
 </core:FragmentDefinition>