@sap-ux/fe-fpm-writer 1.3.8 → 1.3.9

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

@@ -5,9 +5,9 @@ import { type IdGeneratorFunction } from '../common/file.js';
 /**
  * Returns the UI5 xml file document (view/fragment).
  *
- * @param {string} basePath - the base path
- * @param {string} viewPath - the path of the xml view relative to the base path
- * @param {Editor} fs - the memfs editor instance
+ * @param basePath - the base path
+ * @param viewPath - the path of the xml view relative to the base path
+ * @param fs - the memfs editor instance
  * @returns {Document} the view xml file document
  */
 export declare function getUI5XmlDocument(basePath: string, viewPath: string, fs: Editor): Document;
@@ -26,7 +26,6 @@ export declare function getPageAggregationNames(data: BuildingBlock): readonly P
  * @param manifest - the manifest content, or undefined if not available
  */
 export declare function validateFullPageTemplateVersion(manifest: Manifest | undefined): void;
-/** IDs needed per aggregation template, keyed by the variable name used in the EJS template. */
 /** Controls to generate IDs for per aggregation. `key` is the EJS template variable name, `base` is passed to generateId. */
 export declare const AGGREGATION_ID_KEYS: Partial<Record<PageAggregationName, {
     key: string;
@@ -38,16 +37,17 @@ export declare const AGGREGATION_ID_KEYS: Partial<Record<PageAggregationName, {
  *
  * @param aggName - the aggregation name
  * @param generateId - the project-aware ID generator
- * @returns an object mapping each template variable name to a unique ID string
+ * @param existingIds - IDs already present in the container (prevents collision on subsequent adds)
+ * @returns {Record<string, string>} an object mapping each template variable name to a unique ID string
  */
-export declare function buildAggregationIds(aggName: PageAggregationName, generateId: IdGeneratorFunction): Record<string, string>;
+export declare function buildAggregationIds(aggName: PageAggregationName, generateId: IdGeneratorFunction, existingIds?: string[]): Record<string, string>;
 /**
  *
- * @param {Editor} fs - the memfs editor instance
- * @param {Document} xmlDocument - the view XML document (used to resolve namespace prefixes)
- * @param {Document} templateDocument - the template document whose root element receives the children
- * @param {IdGeneratorFunction} generateId - function to generate unique IDs
- * @param {readonly PageAggregationName[]} [aggNames] - aggregation names to append; defaults to all PAGE_AGGREGATIONS
+ * @param fs - the memfs editor instance
+ * @param xmlDocument - the view XML document (used to resolve namespace prefixes)
+ * @param templateDocument - the template document whose root element receives the children
+ * @param generateId - function to generate unique IDs
+ * @param [aggNames] - aggregation names to append; defaults to all PAGE_AGGREGATIONS
  * @param useDefaults - when true, the items aggregation renders its default IconTabBar content
  */
 export declare function appendPageAggregations(fs: Editor, xmlDocument: Document, templateDocument: Document, generateId: IdGeneratorFunction, aggNames?: readonly PageAggregationName[], useDefaults?: boolean): void;
@@ -65,16 +65,16 @@ export declare function sortPageAggregationChildren(pageElement: Node): void;
  * via the path prefix and the element is inserted in place. This allows generateBuildingBlock to
  * handle missing aggregation containers in a single write pass, avoiding a separate commit.
  *
- * @param {Document} xmlDocument - The XML document to mutate
- * @param {string} aggregationPath - Full XPath to the target aggregation (e.g. '/mvc:View/macros:Page/macros:items')
+ * @param xmlDocument - The XML document to mutate
+ * @param aggregationPath - Full XPath to the target aggregation (e.g. '/mvc:View/macros:Page/macros:items')
  */
 export declare function ensureMissingAggregation(xmlDocument: Document, aggregationPath: string): void;
 /**
  * Appends a single Page building block aggregation template to an existing `<macros:Page>` element in a view XML file.
  *
- * @param {string} basePath - the base path of the application
- * @param {GenerateBuildingBlockAggregationConfig} config - the aggregation configuration containing aggregationName
- * @param {Editor} [fs] - the memfs editor instance
+ * @param basePath - the base path of the application
+ * @param config - the aggregation configuration containing aggregationName
+ * @param [fs] - the memfs editor instance
  * @returns {Editor} the updated memfs editor instance
  */
 export declare function generateBuildingBlockAggregation(basePath: string, config: GenerateBuildingBlockAggregationConfig, fs?: Editor): Promise<Editor>;

package/dist/building-block/processAggregation.js

@@ -17,9 +17,9 @@ import { resolveAggregationPath } from './processor.js';
 /**
  * Returns the UI5 xml file document (view/fragment).
  *
- * @param {string} basePath - the base path
- * @param {string} viewPath - the path of the xml view relative to the base path
- * @param {Editor} fs - the memfs editor instance
+ * @param basePath - the base path
+ * @param viewPath - the path of the xml view relative to the base path
+ * @param fs - the memfs editor instance
  * @returns {Document} the view xml file document
  */
 export function getUI5XmlDocument(basePath, viewPath, fs) {
@@ -71,7 +71,7 @@ export function validateFullPageTemplateVersion(manifest) {
  * so that generated prefixed elements like <macros:items> remain valid.
  *
  * @param xmlDocument - the view XML document
- * @returns the resolved namespace prefix string (e.g. 'macros')
+ * @returns {string} the resolved namespace prefix string (e.g. 'macros')
  */
 function resolveMacrosPrefix(xmlDocument) {
     const prefix = getOrAddNamespace(xmlDocument, 'sap.fe.macros', 'macros');
@@ -81,20 +81,24 @@ function resolveMacrosPrefix(xmlDocument) {
     }
     return prefix;
 }
-/** IDs needed per aggregation template, keyed by the variable name used in the EJS template. */
+/**
+ * Page aggregations that can only appear once in the view.
+ * A second "Add" for these is a no-op; their creation form is disabled once present.
+ */
+const SINGLE_INSTANCE_PAGE_AGGREGATIONS = new Set(['breadcrumbs', 'footer']);
 /** Controls to generate IDs for per aggregation. `key` is the EJS template variable name, `base` is passed to generateId. */
 export const AGGREGATION_ID_KEYS = {
     breadcrumbs: [
         { key: 'Breadcrumbs', base: 'breadcrumbs_breadcrumbs' },
         { key: 'Link', base: 'breadcrumbs_link' },
-        { key: 'Link1', base: 'breadcrumbs_link_1' },
-        { key: 'Link2', base: 'breadcrumbs_link_2' }
+        { key: 'Link1', base: 'breadcrumbs_link' },
+        { key: 'Link2', base: 'breadcrumbs_link' }
     ],
     navigationActions: [{ key: 'Button', base: 'navigationActions_button' }],
     titleContent: [{ key: 'GenericTag', base: 'titleContent_genericTag' }],
     actions: [
         { key: 'Button', base: 'actions_button' },
-        { key: 'Button1', base: 'actions_button_1' }
+        { key: 'Button1', base: 'actions_button' }
     ],
     headerContent: [
         { key: 'VBox', base: 'headerContent_vbox' },
@@ -104,7 +108,7 @@ export const AGGREGATION_ID_KEYS = {
         { key: 'OverflowToolbar', base: 'footer_overflowToolbar' },
         { key: 'ToolbarSpacer', base: 'footer_toolbarSpacer' },
         { key: 'Button', base: 'footer_button' },
-        { key: 'Button1', base: 'footer_button_1' }
+        { key: 'Button1', base: 'footer_button' }
     ]
 };
 /**
@@ -113,11 +117,12 @@ export const AGGREGATION_ID_KEYS = {
  *
  * @param aggName - the aggregation name
  * @param generateId - the project-aware ID generator
- * @returns an object mapping each template variable name to a unique ID string
+ * @param existingIds - IDs already present in the container (prevents collision on subsequent adds)
+ * @returns {Record<string, string>} an object mapping each template variable name to a unique ID string
  */
-export function buildAggregationIds(aggName, generateId) {
+export function buildAggregationIds(aggName, generateId, existingIds = []) {
     const entries = AGGREGATION_ID_KEYS[aggName] ?? [];
-    const validatedIds = [];
+    const validatedIds = [...existingIds];
     const ids = {};
     for (const { key, base } of entries) {
         const id = generateId(base, validatedIds);
@@ -137,6 +142,7 @@ export function buildAggregationIds(aggName, generateId) {
  * @param aggContext.aggId - the generated unique ID for the aggregation element
  * @param aggContext.showDefaultContent - when true, the items template renders the default IconTabBar
  * @param aggContext.ids - map of unique IDs for named controls in the template (e.g. ids.Button, ids.Link)
+ * @param aggContext.aggIndex - 1-based counter for this aggregation add (used to number text/press handler names)
  * @param fragMacrosNS - the namespace prefix resolved for sap.fe.macros
  * @param xmlDocument - the view XML document (used to inherit namespace declarations)
  * @returns parsed XML document whose documentElement contains the aggregation child nodes
@@ -155,11 +161,11 @@ function buildPageAggregationFragment(fs, aggName, aggContext, fragMacrosNS, xml
 }
 /**
  *
- * @param {Editor} fs - the memfs editor instance
- * @param {Document} xmlDocument - the view XML document (used to resolve namespace prefixes)
- * @param {Document} templateDocument - the template document whose root element receives the children
- * @param {IdGeneratorFunction} generateId - function to generate unique IDs
- * @param {readonly PageAggregationName[]} [aggNames] - aggregation names to append; defaults to all PAGE_AGGREGATIONS
+ * @param fs - the memfs editor instance
+ * @param xmlDocument - the view XML document (used to resolve namespace prefixes)
+ * @param templateDocument - the template document whose root element receives the children
+ * @param generateId - function to generate unique IDs
+ * @param [aggNames] - aggregation names to append; defaults to all PAGE_AGGREGATIONS
  * @param useDefaults - when true, the items aggregation renders its default IconTabBar content
  */
 export function appendPageAggregations(fs, xmlDocument, templateDocument, generateId, aggNames = PAGE_AGGREGATIONS, useDefaults = true) {
@@ -171,7 +177,7 @@ export function appendPageAggregations(fs, xmlDocument, templateDocument, genera
         const aggId = generateId(aggName);
         const showDefaultContent = aggName === 'items' && useDefaults;
         const ids = buildAggregationIds(aggName, generateId);
-        const aggContext = { macrosPrefix, aggId, showDefaultContent, ids };
+        const aggContext = { macrosPrefix, aggId, showDefaultContent, ids, aggIndex: 1 };
         const aggDoc = buildPageAggregationFragment(fs, aggName, aggContext, fragMacrosNS, xmlDocument);
         for (const node of Array.from(aggDoc.documentElement.childNodes)) {
             if (node.nodeType === 1 /* Element */) {
@@ -268,8 +274,8 @@ export function sortPageAggregationChildren(pageElement) {
  * via the path prefix and the element is inserted in place. This allows generateBuildingBlock to
  * handle missing aggregation containers in a single write pass, avoiding a separate commit.
  *
- * @param {Document} xmlDocument - The XML document to mutate
- * @param {string} aggregationPath - Full XPath to the target aggregation (e.g. '/mvc:View/macros:Page/macros:items')
+ * @param xmlDocument - The XML document to mutate
+ * @param aggregationPath - Full XPath to the target aggregation (e.g. '/mvc:View/macros:Page/macros:items')
  */
 export function ensureMissingAggregation(xmlDocument, aggregationPath) {
     const nsMap = xmlDocument.documentElement?._nsMap ?? {};
@@ -339,12 +345,73 @@ function wrapLooseBuildingBlocksInItems(pageElement, xmlDocument, macrosNS, macr
         itemsEl.appendChild(child);
     }
 }
+/**
+ * Collects all `id` attribute values from direct Element children of the given container.
+ * Used to seed the ID generator so new IDs don't collide with existing ones.
+ *
+ * @param container - the aggregation container element, or undefined if not present
+ * @returns {string[]} array of existing child element IDs
+ */
+function getExistingContainerIds(container) {
+    if (!container) {
+        return [];
+    }
+    return Array.from(container.childNodes)
+        .filter((n) => n.nodeType === 1 /* Element */)
+        .map((n) => n.getAttribute('id'))
+        .filter((id) => !!id);
+}
+/**
+ * Derives the 1-based sequential index for a new aggregation add from the existing container.
+ * The index equals the number of existing child elements + 1, ensuring text/press handler
+ * names continue sequentially (e.g. "Action 3" after two buttons already exist).
+ *
+ * @param existingContainer - the existing aggregation container, or undefined on first add
+ * @returns {number} 1-based start index for text/press handler numbering
+ */
+function deriveAggregationIndex(existingContainer) {
+    if (!existingContainer) {
+        return 1;
+    }
+    const existingChildCount = Array.from(existingContainer.childNodes).filter((n) => n.nodeType === 1 /* Element */).length;
+    return existingChildCount + 1;
+}
+/**
+ * Serializes and writes the XML document to the view file on disk.
+ *
+ * @param fs - the memfs editor instance
+ * @param basePath - the base path of the application
+ * @param viewPath - the path of the xml view relative to the base path
+ * @param xmlDocument - the XML document to serialize and write
+ */
+function writeXmlDocument(fs, basePath, viewPath, xmlDocument) {
+    fs.write(join(basePath, viewPath), format(new XMLSerializer().serializeToString(xmlDocument)));
+}
+/**
+ * Appends child elements from the rendered aggregation template into an existing container element.
+ * aggDoc.documentElement is `<root xmlns:macros=...>`; its first Element child is `<macros:aggName>`.
+ *
+ * @param existingContainer - the existing aggregation container element in the view
+ * @param aggDoc - the rendered template document whose first Element child holds the new children
+ * @param xmlDocument - the owner document (used to import nodes)
+ */
+function appendChildrenIntoContainer(existingContainer, aggDoc, xmlDocument) {
+    const renderedWrapper = Array.from(aggDoc.documentElement.childNodes).find((n) => n.nodeType === 1 /* Element */);
+    if (!renderedWrapper) {
+        return;
+    }
+    for (const child of Array.from(renderedWrapper.childNodes)) {
+        if (child.nodeType === 1 /* Element */) {
+            existingContainer.appendChild(xmlDocument.importNode(child, true));
+        }
+    }
+}
 /**
  * Appends a single Page building block aggregation template to an existing `<macros:Page>` element in a view XML file.
  *
- * @param {string} basePath - the base path of the application
- * @param {GenerateBuildingBlockAggregationConfig} config - the aggregation configuration containing aggregationName
- * @param {Editor} [fs] - the memfs editor instance
+ * @param basePath - the base path of the application
+ * @param config - the aggregation configuration containing aggregationName
+ * @param [fs] - the memfs editor instance
  * @returns {Editor} the updated memfs editor instance
  */
 export async function generateBuildingBlockAggregation(basePath, config, fs) {
@@ -358,9 +425,6 @@ export async function generateBuildingBlockAggregation(basePath, config, fs) {
     const aggId = generateId(aggName);
     const fragMacrosNS = resolveMacrosPrefix(xmlDocument);
     const macrosPrefix = `${fragMacrosNS}:`;
-    const ids = buildAggregationIds(aggName, generateId);
-    const aggContext = { macrosPrefix, aggId, showDefaultContent: false, ids };
-    const aggDoc = buildPageAggregationFragment(fs, aggName, aggContext, fragMacrosNS, xmlDocument);
     const nsMap = xmlDocument.documentElement?._nsMap ?? {};
     // Prefix-agnostic XPath — works regardless of the alias used in the view for sap.fe.macros.
     const xpathSelect = xpath.useNamespaces(nsMap);
@@ -373,20 +437,39 @@ export async function generateBuildingBlockAggregation(basePath, config, fs) {
         pageElement.setAttribute('showFooter', 'true');
     }
     const childNodes = Array.from(pageElement.childNodes);
+    const macrosNsUri = nsMap[fragMacrosNS] ?? 'sap.fe.macros';
     const hasExistingAggregation = childNodes.some((node) => node.nodeType === 1 /* Element */ &&
         node.localName === aggName &&
-        node.namespaceURI === (nsMap[fragMacrosNS] ?? 'sap.fe.macros'));
+        node.namespaceURI === macrosNsUri);
+    // Find existing container early so its child IDs can seed the ID generator,
+    // preventing collisions when appending to an already-populated aggregation.
+    const existingContainer = hasExistingAggregation
+        ? childNodes.find((n) => n.nodeType === 1 /* Element */ &&
+            n.localName === aggName &&
+            n.namespaceURI === macrosNsUri)
+        : undefined;
+    if (hasExistingAggregation && SINGLE_INSTANCE_PAGE_AGGREGATIONS.has(aggName)) {
+        return fs;
+    }
+    const existingContainerIds = getExistingContainerIds(existingContainer);
+    const ids = buildAggregationIds(aggName, generateId, existingContainerIds);
+    const aggIndex = deriveAggregationIndex(existingContainer);
+    const aggContext = { macrosPrefix, aggId, showDefaultContent: false, ids, aggIndex };
+    const aggDoc = buildPageAggregationFragment(fs, aggName, aggContext, fragMacrosNS, xmlDocument);
     if (hasExistingAggregation) {
+        // Append-children aggregations (navigationActions, titleContent, actions, headerContent):
+        // append new children from the rendered template into the existing container.
+        if (existingContainer) {
+            appendChildrenIntoContainer(existingContainer, aggDoc, xmlDocument);
+        }
         sortPageAggregationChildren(pageElement);
-        const existingXmlContent = new XMLSerializer().serializeToString(xmlDocument);
-        fs.write(join(basePath, viewPath), format(existingXmlContent));
+        writeXmlDocument(fs, basePath, viewPath, xmlDocument);
         return fs;
     }
     const hasExistingElementChildren = childNodes.some((n) => n.nodeType === 1 /* Element */);
     const hasTemplateComment = childNodes.some((n) => n.nodeType === 8 /* Comment */ && n.data?.includes(PAGE_TEMPLATE_COMMENT));
     // Move any loose macros building blocks (e.g. macros:Form, macros:Table) into macros:items
     // before inserting the new named aggregation so the Page DOM stays well-formed.
-    const macrosNsUri = nsMap[fragMacrosNS] ?? 'sap.fe.macros';
     wrapLooseBuildingBlocksInItems(pageElement, xmlDocument, macrosNsUri, fragMacrosNS);
     if (!hasExistingElementChildren && !hasTemplateComment) {
         pageElement.appendChild(xmlDocument.createComment(PAGE_TEMPLATE_COMMENT));
@@ -397,8 +480,7 @@ export async function generateBuildingBlockAggregation(basePath, config, fs) {
         }
     }
     sortPageAggregationChildren(pageElement);
-    const newXmlContent = new XMLSerializer().serializeToString(xmlDocument);
-    fs.write(join(basePath, viewPath), format(newXmlContent));
+    writeXmlDocument(fs, basePath, viewPath, xmlDocument);
     return fs;
 }
 //# sourceMappingURL=processAggregation.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "1.3.8",
+  "version": "1.3.9",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,8 +31,8 @@
     "semver": "7.8.5",
     "xml-formatter": "3.7.0",
     "xpath": "0.0.34",
-    "@sap-ux/fiori-annotation-api": "1.0.20",
     "@sap-ux/i18n": "1.0.2",
+    "@sap-ux/fiori-annotation-api": "1.0.20",
     "@sap-ux/project-access": "2.1.9",
     "@sap-ux/logger": "1.0.3"
   },

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

@@ -1,5 +1,5 @@
 <<%- macrosPrefix %>actions>
     <!-- Actions aggregation -->
-    <Button id="<%- ids.Button %>" text="Action 1" press=".onActionsClickAction1" type="Ghost" />
-    <Button id="<%- ids.Button1 %>" text="Action 2" press=".onActionsClickAction2" type="Ghost" />
+    <Button id="<%- ids.Button %>" text="Action <%- aggIndex %>" press=".onActionsClickAction<%- aggIndex %>" type="Ghost" /><% if (aggIndex === 1) { %>
+    <Button id="<%- ids.Button1 %>" text="Action <%- aggIndex + 1 %>" press=".onActionsClickAction<%- aggIndex + 1 %>" type="Ghost" /><% } %>
 </<%- macrosPrefix %>actions>

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

@@ -1,6 +1,6 @@
 <<%- macrosPrefix %>headerContent>
     <!-- Header content aggregation (content after avatar) -->
     <VBox id="<%- ids.VBox %>">
-        <Title id="<%- ids.Title %>" text="Page Title" />
+        <Title id="<%- ids.Title %>" text="Page Title <%- aggIndex %>" />
     </VBox>
 </<%- macrosPrefix %>headerContent>

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

@@ -1,4 +1,4 @@
 <<%- macrosPrefix %>navigationActions>
     <!-- Navigation actions aggregation -->
-    <Button id="<%- ids.Button %>" icon="sap-icon://full-screen" press=".onNavigationActionsFullScreen" type="Transparent" />
+    <Button id="<%- ids.Button %>" icon="sap-icon://full-screen" press=".onNavigationActionsFullScreen<%- aggIndex %>" type="Transparent" />
 </<%- macrosPrefix %>navigationActions>

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

@@ -1,4 +1,4 @@
 <<%- macrosPrefix %>titleContent>
     <!-- Title content aggregation (content next to title) -->
-    <GenericTag id="<%- ids.GenericTag %>" text="Status" design="StatusIconHidden" status="Information" />
+    <GenericTag id="<%- ids.GenericTag %>" text="Status <%- aggIndex %>" design="StatusIconHidden" status="Information" />
 </<%- macrosPrefix %>titleContent>