@sap-ux/fe-fpm-writer 0.37.3 → 0.38.0

package/dist/building-block/prompts/questions/page.js

@@ -4,6 +4,7 @@ exports.getPageBuildingBlockPrompts = getPageBuildingBlockPrompts;
 const i18n_1 = require("../../../i18n");
 const utils_1 = require("../utils");
 const types_1 = require("../../types");
+const i18n_2 = require("@sap-ux/i18n");
 /**
  * Returns a list of prompts required to generate a page building block.
  *
@@ -39,13 +40,23 @@ async function getPageBuildingBlockPrompts(context) {
                 name: 'buildingBlockData.title',
                 message: t('title.message'),
                 guiOptions: {
-                    mandatory: true
+                    mandatory: true,
+                    translationProperties: {
+                        type: i18n_2.SapShortTextType.Heading,
+                        annotation: t('title.translationAnnotation')
+                    }
                 }
             },
             {
                 type: 'input',
                 name: 'buildingBlockData.description',
-                message: t('description.message')
+                message: t('description.message'),
+                guiOptions: {
+                    translationProperties: {
+                        type: i18n_2.SapLongTextType.Description,
+                        annotation: t('description.translationAnnotation')
+                    }
+                }
             }
         ],
         initialAnswers: {

package/dist/building-block/prompts/utils/xml.d.ts

@@ -8,6 +8,14 @@ import type { Editor } from 'mem-fs-editor';
  * @returns true if passed id is available.
  */
 export declare function isElementIdAvailable(fs: Editor, viewOrFragmentPath: string, id: string): boolean;
+/**
+ * Converts the provided xpath string from `/mvc:View/Page/content` to
+ * `/mvc:View/*[local-name()='Page']/*[local-name()='content']`.
+ *
+ * @param path - the xpath string
+ * @returns the augmented xpath string.
+ */
+export declare const augmentXpathWithLocalNames: (path: string) => string;
 /**
  * Returns a list of xpath strings for each element of the xml file provided.
  *

package/dist/building-block/prompts/utils/xml.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.augmentXpathWithLocalNames = void 0;
 exports.isElementIdAvailable = isElementIdAvailable;
 exports.getXPathStringsForXmlFile = getXPathStringsForXmlFile;
 exports.getFilterBarIdsInFile = getFilterBarIdsInFile;
@@ -32,6 +33,7 @@ const augmentXpathWithLocalNames = (path) => {
     }
     return result.join('/');
 };
+exports.augmentXpathWithLocalNames = augmentXpathWithLocalNames;
 /**
  * Returns a list of xpath strings for each element of the xml file provided.
  *
@@ -64,7 +66,7 @@ function getXPathStringsForXmlFile(xmlFilePath, fs) {
                 child.localName === 'Page' &&
                 child.nodeName === pageMacroDefinition);
             if (!hasPageMacroChild) {
-                result[`${parentNode}/${node.nodeName}`] = augmentXpathWithLocalNames(`${parentNode}/${node.nodeName}`);
+                result[`${parentNode}/${node.nodeName}`] = (0, exports.augmentXpathWithLocalNames)(`${parentNode}/${node.nodeName}`);
             }
             const childNodes = Array.from(node.childNodes);
             for (const childNode of childNodes) {

package/dist/page/custom.js

@@ -15,6 +15,9 @@ const templates_1 = require("../templates");
 const semver_1 = require("semver");
 const utils_1 = require("../common/utils");
 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");
 /**
  * Enhances the provided custom page configuration with default data.
  *
@@ -100,6 +103,18 @@ async function generate(basePath, data, fs) {
             fs.copyTpl(i18TemplatePath, i18nPath, config);
         }
     }
+    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);
+    }
     const ext = data.typescript ? 'ts' : 'js';
     const controllerPath = (0, path_1.join)(config.path, `${config.name}.controller.${ext}`);
     if (!fs.exists(controllerPath)) {

package/dist/page/types.d.ts

@@ -107,6 +107,10 @@ export interface CustomPage extends FpmPage, CustomElement {
          */
         title?: string;
     };
+    /**
+     * If page building block title is defined then it will be used to automatically add a macro page to the generated custom page.
+     */
+    pageBuildingBlockTitle?: string;
 }
 export interface FCL {
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.37.3",
+  "version": "0.38.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -41,7 +41,7 @@
     "@types/semver": "7.5.2",
     "@types/vinyl": "2.0.7",
     "@sap-ux/i18n": "0.3.3",
-    "@sap-ux/ui-prompting": "0.4.1"
+    "@sap-ux/ui-prompting": "0.4.2"
   },
   "engines": {
     "node": ">=20.x"