@sap-ux/fe-fpm-writer 1.3.19 → 1.3.21

package/dist/building-block/index.js

@@ -60,14 +60,18 @@ export async function generateBuildingBlock(basePath, config, fs) {
         hasAggregation,
         aggregationNamespace
     };
-    const templateDocument = getTemplateDocument({ ...processedBuildingBlockData, generateId: fnGenerateId }, xmlDocument, fs, manifest, templateConfig);
     const fullPageTemplate = isFullPageTemplate(buildingBlockData);
     const pageAggregationNames = getPageAggregationNames(buildingBlockData);
+    // The full page template renders a default IconTabBar that acts as the page's sticky subheader
+    // (removing the empty gap between header and tab bar). Generate its id once so the Page's
+    // stickySubheaderProvider and the IconTabBar share the same collision-safe id.
+    const stickySubheaderId = fullPageTemplate ? fnGenerateId('stickySubheaderBar') : undefined;
+    const templateDocument = getTemplateDocument({ ...processedBuildingBlockData, stickySubheaderId, generateId: fnGenerateId }, xmlDocument, fs, manifest, templateConfig);
     if (fullPageTemplate) {
         validateFullPageTemplateVersion(manifest);
     }
     if (pageAggregationNames) {
-        appendPageAggregations(fs, xmlDocument, templateDocument, fnGenerateId, pageAggregationNames, fullPageTemplate);
+        appendPageAggregations(fs, xmlDocument, templateDocument, fnGenerateId, pageAggregationNames, fullPageTemplate, stickySubheaderId);
     }
     if (buildingBlockData.buildingBlockType === BuildingBlockType.RichTextEditor ||
         buildingBlockData.buildingBlockType === BuildingBlockType.RichTextEditorButtonGroups) {
@@ -315,7 +319,8 @@ export async function getSerializedFileContent(basePath, config, fs) {
     const xmlDocument = viewOrFragmentPath ? getUI5XmlDocument(basePath, viewOrFragmentPath, fs) : undefined;
     const { content: manifest, path: manifestPath } = await getManifest(basePath, fs, false);
     const fnGenerateId = buildingBlockData.generateId ?? (await createIdGenerator({ basePath, fsEditor: fs }));
-    const content = getTemplateContent({ ...buildingBlockData, generateId: fnGenerateId }, xmlDocument, manifest, fs, true);
+    const stickySubheaderId = isFullPageTemplate(buildingBlockData) ? fnGenerateId('stickySubheaderBar') : undefined;
+    const content = getTemplateContent({ ...buildingBlockData, stickySubheaderId, generateId: fnGenerateId }, xmlDocument, manifest, fs, true);
     // For full Page templates, augment the snippet with all PAGE_AGGREGATIONS
     let viewOrFragmentContent = content;
     const pageAggNames = getPageAggregationNames(buildingBlockData);
@@ -333,7 +338,7 @@ export async function getSerializedFileContent(basePath, config, fs) {
         const snippetDoc = new DOMParser(getDOMParserOptions(TEMPLATE_NAMESPACES, (level, message) => {
             throw new Error(`Unable to parse Page building block snippet. Details: [${level}] - ${message}`);
         })).parseFromString(snippetContent, 'text/xml');
-        appendPageAggregations(fs, nsDoc, snippetDoc, fnGenerateId, pageAggNames, isFullPageTemplate(buildingBlockData));
+        appendPageAggregations(fs, nsDoc, snippetDoc, fnGenerateId, pageAggNames, isFullPageTemplate(buildingBlockData), stickySubheaderId);
         const resultNode = snippetDoc.documentElement;
         viewOrFragmentContent = resultNode ? format(new XMLSerializer().serializeToString(resultNode)) : content;
     }

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

@@ -49,8 +49,9 @@ export declare function buildAggregationIds(aggName: PageAggregationName, genera
  * @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
+ * @param stickySubheaderId - collision-safe id for the default IconTabBar, shared with the Page's stickySubheaderProvider
  */
-export declare function appendPageAggregations(fs: Editor, xmlDocument: Document, templateDocument: Document, generateId: IdGeneratorFunction, aggNames?: readonly PageAggregationName[], useDefaults?: boolean): void;
+export declare function appendPageAggregations(fs: Editor, xmlDocument: Document, templateDocument: Document, generateId: IdGeneratorFunction, aggNames?: readonly PageAggregationName[], useDefaults?: boolean, stickySubheaderId?: string): void;
 /**
  * Reorders the child elements of a macros:Page node to match the canonical PAGE_AGGREGATIONS order.
  * Preserves relative order of siblings with the same local name. Pure whitespace text nodes are dropped

package/dist/building-block/processAggregation.js

@@ -143,6 +143,7 @@ export function buildAggregationIds(aggName, generateId, existingIds = []) {
  * @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 aggContext.stickySubheaderId - collision-safe id for the default IconTabBar, shared with the Page's stickySubheaderProvider
  * @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
@@ -167,8 +168,9 @@ function buildPageAggregationFragment(fs, aggName, aggContext, fragMacrosNS, xml
  * @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
+ * @param stickySubheaderId - collision-safe id for the default IconTabBar, shared with the Page's stickySubheaderProvider
  */
-export function appendPageAggregations(fs, xmlDocument, templateDocument, generateId, aggNames = PAGE_AGGREGATIONS, useDefaults = true) {
+export function appendPageAggregations(fs, xmlDocument, templateDocument, generateId, aggNames = PAGE_AGGREGATIONS, useDefaults = true, stickySubheaderId) {
     const fragMacrosNS = resolveMacrosPrefix(xmlDocument);
     const macrosPrefix = `${fragMacrosNS}:`;
     const pageElement = templateDocument.documentElement;
@@ -177,7 +179,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, aggIndex: 1 };
+        const aggContext = { macrosPrefix, aggId, showDefaultContent, ids, aggIndex: 1, stickySubheaderId };
         const aggDoc = buildPageAggregationFragment(fs, aggName, aggContext, fragMacrosNS, xmlDocument);
         for (const node of Array.from(aggDoc.documentElement.childNodes)) {
             if (node.nodeType === 1 /* Element */) {

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

@@ -398,6 +398,12 @@ export interface Page extends BuildingBlock {
      * When templateType is 'full', each entry is written as the inner XML of the corresponding aggregation.
      */
     aggregations?: Partial<Record<PageAggregationName, string>>;
+    /**
+     * Collision-safe id of the IconTabBar that acts as the page's sticky subheader.
+     * Set internally for the full template so the Page's stickySubheaderProvider and the
+     * generated IconTabBar share the same id. Not part of the public input.
+     */
+    stickySubheaderId?: string;
 }
 export declare const PAGE_TEMPLATE_COMMENT = "This is a sample template, event handlers should be added for implementation";
 export declare const MACROS_NAMESPACE_URI = "sap.fe.macros";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "1.3.19",
+  "version": "1.3.21",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,9 +31,9 @@
     "semver": "7.8.5",
     "xml-formatter": "3.7.0",
     "xpath": "0.0.34",
-    "@sap-ux/fiori-annotation-api": "1.1.0",
-    "@sap-ux/i18n": "1.0.4",
-    "@sap-ux/project-access": "2.2.1",
+    "@sap-ux/fiori-annotation-api": "1.1.1",
+    "@sap-ux/i18n": "1.0.5",
+    "@sap-ux/project-access": "2.2.2",
     "@sap-ux/logger": "1.0.3"
   },
   "devDependencies": {

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

@@ -2,5 +2,6 @@
     id="<%- data.id %>"<% if (data.title) { %>
     title="<%- data.title %>"<% } %><% if (data.description) { %>
     description="<%- data.description %>"<% } %><% if (data.templateType === 'full') { %>
-    showFooter="true"<% } %>
-/>
+    showFooter="true"
+    stickySubheaderProvider="<%- data.stickySubheaderId %>"<% } %>
+/>

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

@@ -1,7 +1,7 @@
 <<%- macrosPrefix %>items>
     <!-- Main content -->
 <% if (showDefaultContent) { -%>
-    <IconTabBar id="iconTabBar<%- aggId %>" class="sapUiResponsiveContentPadding">
+    <IconTabBar id="<%- stickySubheaderId %>" class="sapUiResponsiveContentPadding">
         <items>
             <IconTabFilter id="iconTabFilter<%- aggId %>" text="Tab 1">
             </IconTabFilter>