@sap-ux/fe-fpm-writer 0.35.14 → 0.36.0

package/dist/building-block/index.js

@@ -54,6 +54,7 @@ const semver_1 = require("semver");
 const project_access_1 = require("@sap-ux/project-access");
 const file_1 = require("../common/file");
 const utils_1 = require("../common/utils");
+const xml_1 = require("./prompts/utils/xml");
 const PLACEHOLDERS = {
     'id': 'REPLACE_WITH_BUILDING_BLOCK_ID',
     'entitySet': 'REPLACE_WITH_ENTITY',
@@ -81,7 +82,7 @@ async function generateBuildingBlock(basePath, config, fs) {
     const xmlDocument = getUI5XmlDocument(basePath, viewOrFragmentPath, fs);
     const { content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
     const templateDocument = getTemplateDocument(buildingBlockData, xmlDocument, fs, manifest);
-    fs = updateViewFile(basePath, viewOrFragmentPath, aggregationPath, xmlDocument, templateDocument, fs);
+    fs = updateViewFile(basePath, viewOrFragmentPath, aggregationPath, xmlDocument, templateDocument, fs, config.replace);
     if (allowAutoAddDependencyLib && manifest && !(0, validate_1.validateDependenciesLibs)(manifest, ['sap.fe.macros'])) {
         // "sap.fe.macros" is missing - enhance manifest.json for missing "sap.fe.macros"
         const manifestPath = await (0, utils_1.getManifestPath)(basePath, fs);
@@ -125,21 +126,6 @@ function getUI5XmlDocument(basePath, viewPath, fs) {
     }
     return viewDocument;
 }
-/**
- * Returns the macros namespace from the xml document if it exists or creates a new one and returns it.
- *
- * @param {Document} ui5XmlDocument - the view/fragment xml file document
- * @returns {string} the macros namespace
- */
-function getOrAddMacrosNamespace(ui5XmlDocument) {
-    const namespaceMap = ui5XmlDocument.firstChild._nsMap;
-    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';
-}
 /**
  * Method returns default values for metadata path.
  *
@@ -219,7 +205,7 @@ function getTemplateContent(buildingBlockData, viewDocument, manifest, fs, usePl
         buildingBlockData.id = PLACEHOLDERS.id;
     }
     return (0, ejs_1.render)(fs.read(templateFilePath), {
-        macrosNamespace: viewDocument ? getOrAddMacrosNamespace(viewDocument) : 'macros',
+        macrosNamespace: viewDocument ? (0, xml_1.getOrAddMacrosNamespace)(viewDocument) : 'macros',
         data: buildingBlockData
     }, {});
 }
@@ -267,16 +253,23 @@ function getTemplateDocument(buildingBlockData, viewDocument, fs, manifest) {
  * @param {Document} viewDocument - the view xml document
  * @param {Document} templateDocument - the template xml document
  * @param {Editor} [fs] - the memfs editor instance
+ * @param {boolean} [replace] - If true, replaces the target element with the template xml document;
+ * if false, appends the source node.
  * @returns {Editor} the updated memfs editor instance
  */
-function updateViewFile(basePath, viewPath, aggregationPath, viewDocument, templateDocument, fs) {
+function updateViewFile(basePath, viewPath, aggregationPath, viewDocument, templateDocument, fs, replace = false) {
     const xpathSelect = xpath.useNamespaces(viewDocument.firstChild._nsMap);
     // Find target aggregated element and append template as child
     const targetNodes = xpathSelect(aggregationPath, viewDocument);
     if (targetNodes && Array.isArray(targetNodes) && targetNodes.length > 0) {
         const targetNode = targetNodes[0];
         const sourceNode = viewDocument.importNode(templateDocument.documentElement, true);
-        targetNode.appendChild(sourceNode);
+        if (replace) {
+            targetNode.parentNode?.replaceChild(sourceNode, targetNode);
+        }
+        else {
+            targetNode.appendChild(sourceNode);
+        }
         // Serialize and format new view xml document
         const newXmlContent = new xmldom_1.XMLSerializer().serializeToString(viewDocument);
         fs.write((0, path_1.join)(basePath, viewPath), (0, xml_formatter_1.default)(newXmlContent));

package/dist/building-block/prompts/questions/index.d.ts

@@ -2,4 +2,5 @@ export * from './building-blocks';
 export * from './chart';
 export * from './filter-bar';
 export * from './table';
+export * from './page';
 //# sourceMappingURL=index.d.ts.map

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

@@ -18,4 +18,5 @@ __exportStar(require("./building-blocks"), exports);
 __exportStar(require("./chart"), exports);
 __exportStar(require("./filter-bar"), exports);
 __exportStar(require("./table"), exports);
+__exportStar(require("./page"), exports);
 //# sourceMappingURL=index.js.map

package/dist/building-block/prompts/questions/page.d.ts

@@ -0,0 +1,12 @@
+import type { Answers } from 'inquirer';
+import type { PromptContext, Prompts } from '../../../prompts/types';
+import type { BuildingBlockConfig, Page } from '../../types';
+export type PagePromptsAnswer = BuildingBlockConfig<Page> & Answers;
+/**
+ * Returns a list of prompts required to generate a page building block.
+ *
+ * @param context - prompt context including data about project
+ * @returns Prompt with questions for page.
+ */
+export declare function getPageBuildingBlockPrompts(context: PromptContext): Promise<Prompts<PagePromptsAnswer>>;
+//# sourceMappingURL=page.d.ts.map

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

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPageBuildingBlockPrompts = getPageBuildingBlockPrompts;
+const i18n_1 = require("../../../i18n");
+const utils_1 = require("../utils");
+const types_1 = require("../../types");
+/**
+ * Returns a list of prompts required to generate a page building block.
+ *
+ * @param context - prompt context including data about project
+ * @returns Prompt with questions for page.
+ */
+async function getPageBuildingBlockPrompts(context) {
+    const t = (0, i18n_1.translate)(i18n_1.i18nNamespaces.buildingBlock, 'prompts.page.');
+    return {
+        questions: [
+            (0, utils_1.getViewOrFragmentPathPrompt)(context, t('viewOrFragmentPath.validate'), {
+                message: t('viewOrFragmentPath.message'),
+                guiOptions: {
+                    mandatory: true,
+                    dependantPromptNames: ['aggregationPath']
+                }
+            }),
+            (0, utils_1.getAggregationPathPrompt)(context, {
+                message: t('aggregation'),
+                guiOptions: {
+                    mandatory: true
+                }
+            }),
+            (0, utils_1.getBuildingBlockIdPrompt)(context, t('id.validation'), {
+                message: t('id.message'),
+                default: 'Page',
+                guiOptions: {
+                    mandatory: true
+                }
+            }),
+            {
+                type: 'input',
+                name: 'buildingBlockData.title',
+                message: t('title.message'),
+                guiOptions: {
+                    mandatory: true
+                }
+            },
+            {
+                type: 'input',
+                name: 'buildingBlockData.description',
+                message: t('description.message')
+            }
+        ],
+        initialAnswers: {
+            buildingBlockData: {
+                buildingBlockType: types_1.BuildingBlockType.Page
+            }
+        }
+    };
+}
+//# sourceMappingURL=page.js.map

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

@@ -196,6 +196,7 @@ function getAggregationPathPrompt(context, properties = {}) {
         ...properties,
         type: 'list',
         name: 'aggregationPath',
+        defaultIndex: 0,
         choices: project
             ? (answers) => {
                 const { viewOrFragmentPath } = answers;

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

@@ -24,4 +24,11 @@ export declare function getXPathStringsForXmlFile(xmlFilePath: string, fs: Edito
  * @returns an array of ids found in passed xml file.
  */
 export declare function getFilterBarIdsInFile(viewOrFragmentPath: string, fs: Editor): Promise<string[]>;
+/**
+ * Returns the macros namespace from the xml document if it exists or creates a new one and returns it.
+ *
+ * @param {Document} ui5XmlDocument - the view/fragment xml file document
+ * @returns {string} the macros namespace
+ */
+export declare function getOrAddMacrosNamespace(ui5XmlDocument: Document): string;
 //# sourceMappingURL=xml.d.ts.map

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isElementIdAvailable = isElementIdAvailable;
 exports.getXPathStringsForXmlFile = getXPathStringsForXmlFile;
 exports.getFilterBarIdsInFile = getFilterBarIdsInFile;
+exports.getOrAddMacrosNamespace = getOrAddMacrosNamespace;
 const xmldom_1 = require("@xmldom/xmldom");
 /**
  * Method validates if passed id is available.
@@ -47,12 +48,23 @@ function getXPathStringsForXmlFile(xmlFilePath, fs) {
         };
         const xmlDocument = new xmldom_1.DOMParser({ errorHandler }).parseFromString(xmlContent);
         const nodes = [{ parentNode: '', node: xmlDocument.firstChild }];
+        // check macros namespace and page macro definition
+        const macrosNamespace = getOrAddMacrosNamespace(xmlDocument);
+        const pageMacroDefinition = macrosNamespace ? `${macrosNamespace}:Page` : 'macros:Page';
+        let hasPageMacroChild = false;
         while (nodes && nodes.length > 0) {
             const { parentNode, node } = nodes.shift();
             if (!node) {
                 continue;
             }
-            result[`${parentNode}/${node.nodeName}`] = augmentXpathWithLocalNames(`${parentNode}/${node.nodeName}`);
+            // If the current node does NOT have a <macros:Page> child, add <mvc:View> XPath to the result.
+            // This prevents suggesting insertion points outside macros:Page when a macros:Page is present.
+            hasPageMacroChild = Array.from(node.childNodes).some((child) => child.nodeType === child.ELEMENT_NODE &&
+                child.localName === 'Page' &&
+                child.nodeName === pageMacroDefinition);
+            if (!hasPageMacroChild) {
+                result[`${parentNode}/${node.nodeName}`] = augmentXpathWithLocalNames(`${parentNode}/${node.nodeName}`);
+            }
             const childNodes = Array.from(node.childNodes);
             for (const childNode of childNodes) {
                 if (childNode.nodeType === childNode.ELEMENT_NODE) {
@@ -100,4 +112,19 @@ async function getFilterBarIdsInFile(viewOrFragmentPath, fs) {
     }
     return ids;
 }
+/**
+ * Returns the macros namespace from the xml document if it exists or creates a new one and returns it.
+ *
+ * @param {Document} ui5XmlDocument - the view/fragment xml file document
+ * @returns {string} the macros namespace
+ */
+function getOrAddMacrosNamespace(ui5XmlDocument) {
+    const namespaceMap = ui5XmlDocument.firstChild._nsMap;
+    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';
+}
 //# sourceMappingURL=xml.js.map

package/dist/building-block/types.d.ts

@@ -7,6 +7,7 @@ export declare enum BuildingBlockType {
     FilterBar = "filter-bar",
     Chart = "chart",
     Field = "field",
+    Page = "page",
     Table = "table"
 }
 /**
@@ -367,6 +368,24 @@ export interface Table extends BuildingBlock {
      */
     variantManagement?: string;
 }
+/**
+ * Building block used to create a page.
+ * The page building block allows configuration of the title, and description.
+ *
+ * @example
+ * <macro:Page title="My Page Title" description="My Page Description" />
+ * @extends {BuildingBlock}
+ */
+export interface Page extends BuildingBlock {
+    /**
+     * The title of the page.
+     */
+    title?: string;
+    /**
+     * The description of the page.
+     */
+    description?: string;
+}
 /**
  * Input configuration for the generate function.
  */
@@ -390,5 +409,10 @@ export interface BuildingBlockConfig<T extends BuildingBlock> {
      * @default true
      */
     allowAutoAddDependencyLib?: boolean;
+    /**
+     * If true, replaces the element selected by aggregationPath in the view with the page building block.
+     * If false or undefined, the page building block will be appended.
+     */
+    replace?: boolean;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/building-block/types.js

@@ -11,6 +11,7 @@ var BuildingBlockType;
     BuildingBlockType["FilterBar"] = "filter-bar";
     BuildingBlockType["Chart"] = "chart";
     BuildingBlockType["Field"] = "field";
+    BuildingBlockType["Page"] = "page";
     BuildingBlockType["Table"] = "table";
 })(BuildingBlockType || (exports.BuildingBlockType = BuildingBlockType = {}));
 //# sourceMappingURL=types.js.map

package/dist/index.d.ts

@@ -12,9 +12,9 @@ export { CustomView } from './view/types';
 export { generateCustomView } from './view';
 export { enableFPM, FPMConfig } from './app';
 export { validateBasePath, validateVersion } from './common/validate';
-export { BuildingBlockType, FilterBar, Chart, Field, FieldFormatOptions, Table, BuildingBlockConfig } from './building-block/types';
+export { BuildingBlockType, FilterBar, Chart, Field, FieldFormatOptions, Table, BuildingBlockConfig, Page } from './building-block/types';
 export { generateBuildingBlock, getSerializedFileContent } from './building-block';
-export { ChartPromptsAnswer, FilterBarPromptsAnswer, TablePromptsAnswer, BuildingBlockTypePromptsAnswer } from './building-block/prompts/questions';
+export { ChartPromptsAnswer, FilterBarPromptsAnswer, TablePromptsAnswer, PagePromptsAnswer, BuildingBlockTypePromptsAnswer } from './building-block/prompts/questions';
 export { PromptsType, SupportedGeneratorAnswers, PromptsAPI, PromptsGroup, Prompts, ValidationResults, Answers, Subset, CodeSnippet } from './prompts';
 export { ControllerExtension, ControllerExtensionPageType } from './controller-extension/types';
 export { generateControllerExtension } from './controller-extension';

package/dist/prompts/map.d.ts

@@ -1,10 +1,11 @@
 import type { PromptContext, Prompts, Subset } from './types';
 import { PromptsType } from './types';
-import type { ChartPromptsAnswer, TablePromptsAnswer, FilterBarPromptsAnswer, BuildingBlockTypePromptsAnswer } from '../building-block/prompts/questions';
+import type { ChartPromptsAnswer, TablePromptsAnswer, PagePromptsAnswer, FilterBarPromptsAnswer, BuildingBlockTypePromptsAnswer } from '../building-block/prompts/questions';
 import { generateBuildingBlock, getSerializedFileContent } from '../building-block';
 type AnswerMapping = {
     [PromptsType.Chart]: ChartPromptsAnswer;
     [PromptsType.Table]: TablePromptsAnswer;
+    [PromptsType.Page]: PagePromptsAnswer;
     [PromptsType.FilterBar]: FilterBarPromptsAnswer;
     [PromptsType.BuildingBlocks]: BuildingBlockTypePromptsAnswer;
 };
@@ -13,8 +14,8 @@ type BasePrompt<T extends keyof AnswerMapping> = {
     answers: AnswerMapping[T];
     initialAnswers?: Subset<AnswerMapping[T]>;
 };
-export type SupportedPrompts = BasePrompt<PromptsType.Chart> | BasePrompt<PromptsType.Table> | BasePrompt<PromptsType.FilterBar> | BasePrompt<PromptsType.BuildingBlocks>;
-export type SupportedGeneratorPrompts = BasePrompt<PromptsType.Chart> | BasePrompt<PromptsType.Table> | BasePrompt<PromptsType.FilterBar>;
+export type SupportedPrompts = BasePrompt<PromptsType.Chart> | BasePrompt<PromptsType.Table> | BasePrompt<PromptsType.FilterBar> | BasePrompt<PromptsType.Page> | BasePrompt<PromptsType.BuildingBlocks>;
+export type SupportedGeneratorPrompts = BasePrompt<PromptsType.Chart> | BasePrompt<PromptsType.Table> | BasePrompt<PromptsType.Page> | BasePrompt<PromptsType.FilterBar>;
 export type NarrowPrompt<T, N = SupportedPrompts> = N extends {
     type: T;
 } ? N : never;
@@ -26,12 +27,14 @@ export declare const PromptsGeneratorsMap: {
     chart: typeof generateBuildingBlock;
     table: typeof generateBuildingBlock;
     "filter-bar": typeof generateBuildingBlock;
+    page: typeof generateBuildingBlock;
 };
 export declare const PromptsCodePreviewMap: {
     chart: typeof getSerializedFileContent;
     table: typeof getSerializedFileContent;
     "filter-bar": typeof getSerializedFileContent;
+    page: typeof getSerializedFileContent;
 };
-export type SupportedGeneratorAnswers = TablePromptsAnswer | ChartPromptsAnswer | FilterBarPromptsAnswer;
+export type SupportedGeneratorAnswers = TablePromptsAnswer | ChartPromptsAnswer | FilterBarPromptsAnswer | PagePromptsAnswer;
 export {};
 //# sourceMappingURL=map.d.ts.map

package/dist/prompts/map.js

@@ -8,16 +8,19 @@ exports.PromptsQuestionsMap = {
     [types_1.PromptsType.Chart]: questions_1.getChartBuildingBlockPrompts,
     [types_1.PromptsType.Table]: questions_1.getTableBuildingBlockPrompts,
     [types_1.PromptsType.FilterBar]: questions_1.getFilterBarBuildingBlockPrompts,
-    [types_1.PromptsType.BuildingBlocks]: questions_1.getBuildingBlockTypePrompts
+    [types_1.PromptsType.BuildingBlocks]: questions_1.getBuildingBlockTypePrompts,
+    [types_1.PromptsType.Page]: questions_1.getPageBuildingBlockPrompts
 };
 exports.PromptsGeneratorsMap = {
     [types_1.PromptsType.Chart]: building_block_1.generateBuildingBlock,
     [types_1.PromptsType.Table]: building_block_1.generateBuildingBlock,
-    [types_1.PromptsType.FilterBar]: building_block_1.generateBuildingBlock
+    [types_1.PromptsType.FilterBar]: building_block_1.generateBuildingBlock,
+    [types_1.PromptsType.Page]: building_block_1.generateBuildingBlock
 };
 exports.PromptsCodePreviewMap = {
     [types_1.PromptsType.Chart]: building_block_1.getSerializedFileContent,
     [types_1.PromptsType.Table]: building_block_1.getSerializedFileContent,
-    [types_1.PromptsType.FilterBar]: building_block_1.getSerializedFileContent
+    [types_1.PromptsType.FilterBar]: building_block_1.getSerializedFileContent,
+    [types_1.PromptsType.Page]: building_block_1.getSerializedFileContent
 };
 //# sourceMappingURL=map.js.map

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

@@ -182,6 +182,27 @@ declare const ns1: {
             tableSearchableToggle: string;
             valuesDependentOnEntityTypeInfo: string;
         };
+        page: {
+            id: {
+                message: string;
+                validation: string;
+            };
+            viewOrFragmentPath: {
+                message: string;
+                validation: string;
+            };
+            aggregation: string;
+            title: {
+                message: string;
+                validation: string;
+                translationAnnotation: string;
+            };
+            description: {
+                message: string;
+                validation: string;
+                translationAnnotation: string;
+            };
+        };
     };
 };
 export default ns1;

package/dist/prompts/translations/i18n.js

@@ -207,6 +207,27 @@ const ns1 = {
             'pasteFromClipboard': 'Enable Paste From Clipboard',
             'tableSearchableToggle': 'Table Searchable Toggle',
             'valuesDependentOnEntityTypeInfo': 'Values are dependent on entity set'
+        },
+        'page': {
+            'id': {
+                'message': 'Building Block ID',
+                'validation': 'An ID is required to generate the page building block.'
+            },
+            'viewOrFragmentPath': {
+                'message': 'View or Fragment File',
+                'validation': 'A View or Fragment is required to generate the page building block.'
+            },
+            'aggregation': 'Aggregation Path',
+            'title': {
+                'message': 'Page Title',
+                'validation': 'Enter a Page Title',
+                'translationAnnotation': 'Title of the Page.'
+            },
+            'description': {
+                'message': 'Page Description',
+                'validation': 'Enter a Page Description',
+                'translationAnnotation': 'Description of the Page.'
+            }
         }
     }
 };

package/dist/prompts/types.d.ts

@@ -6,6 +6,7 @@ export declare enum PromptsType {
     FilterBar = "filter-bar",
     Chart = "chart",
     Table = "table",
+    Page = "page",
     BuildingBlocks = "building-blocks"
 }
 export interface Prompts<T extends Answers = Answers> {

package/dist/prompts/types.js

@@ -6,6 +6,7 @@ var PromptsType;
     PromptsType["FilterBar"] = "filter-bar";
     PromptsType["Chart"] = "chart";
     PromptsType["Table"] = "table";
+    PromptsType["Page"] = "page";
     PromptsType["BuildingBlocks"] = "building-blocks";
 })(PromptsType || (exports.PromptsType = PromptsType = {}));
 var CodeSnippetLanguage;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.35.14",
+  "version": "0.36.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,8 +30,8 @@
     "semver": "7.5.4",
     "xml-formatter": "2.6.1",
     "xpath": "0.0.33",
-    "@sap-ux/fiori-annotation-api": "0.6.12",
-    "@sap-ux/project-access": "1.30.9"
+    "@sap-ux/fiori-annotation-api": "0.6.13",
+    "@sap-ux/project-access": "1.30.10"
   },
   "devDependencies": {
     "@types/inquirer": "8.2.6",
@@ -41,7 +41,7 @@
     "@types/semver": "7.5.2",
     "@types/vinyl": "2.0.7",
     "@sap-ux/i18n": "0.3.2",
-    "@sap-ux/ui-prompting": "0.3.35"
+    "@sap-ux/ui-prompting": "0.3.37"
   },
   "engines": {
     "node": ">=20.x"

package/templates/building-block/page/View.xml

@@ -0,0 +1,5 @@
+<<%- macrosNamespace %>:Page
+    id="<%- data.id %>"<% if (data.title) { %>
+    title="<%- data.title %>"<% } %><% if (data.description) { %>
+    description="<%- data.description %>"<% } %>
+/>