@sap-ux/preview-middleware 0.23.134 → 0.23.135

package/dist/client/adp/quick-actions/table-quick-action-base.ts

@@ -26,6 +26,7 @@ import {
     TREE_TABLE_TYPE
 } from './control-types';
 import { isVariantManagementEnabledOPPage } from './fe-v2/utils';
+import { isMacroTable } from '../../utils/fe-v4';
 
 const SMART_TABLE_ACTION_ID = 'CTX_COMP_VARIANT_CONTENT';
 const M_TABLE_ACTION_ID = 'CTX_ADD_ELEMENTS_AS_CHILD';
@@ -59,6 +60,7 @@ export type TableQuickActionsOptions = {
     includeServiceAction?: boolean;
     areTableRowsRequired?: boolean;
     validatePageVariantManagement?: boolean;
+    validateTableColumns?: boolean;
 };
 
 /**
@@ -129,6 +131,36 @@ export abstract class TableQuickActionDefinitionBase extends QuickActionDefiniti
         }
     }
 
+    /**
+     * Builds a map of custom tab keys to their associated table building blocks.
+     *
+     * @param iconTabBarFilterMap - A map of icon tab bar filter keys to their labels.
+     * @returns A map where each key is a combination of contextPath and metaPath, and the value is the corresponding custom tab key.
+     */
+    private getCustomViewTableBuildingBlocksMap(iconTabBarFilterMap: { [key: string]: string }): {
+        [key: string]: string;
+    } {
+        const customTabTableBuildingBlockMap: { [key: string]: string } = {};
+
+        const customTabs = Object.keys(iconTabBarFilterMap).filter((key) => /^fe::CustomTab::\d+$/.test(key));
+        for (const key of customTabs) {
+            const items = (this.iconTabBar?.getItems() ?? []) as unknown as ManagedObject[];
+            const filterItem = items.find(
+                (item) => isA<IconTabFilter>('sap.m.IconTabFilter', item) && item.getKey() === key
+            );
+            if (filterItem && isA<IconTabFilter>('sap.m.IconTabFilter', filterItem)) {
+                filterItem.getContent().forEach((content) => {
+                    if (isMacroTable(content)) {
+                        const { metaPath, contextPath } = content;
+                        const path = metaPath.startsWith(contextPath) ? metaPath : `${contextPath}${metaPath}`;
+                        customTabTableBuildingBlockMap[path] = key;
+                    }
+                });
+            }
+        }
+        return customTabTableBuildingBlockMap;
+    }
+
     /**
      * Initializes action object instance
      */
@@ -139,20 +171,21 @@ export abstract class TableQuickActionDefinitionBase extends QuickActionDefiniti
             this.isApplicable = false;
             return;
         }
-        const iconTabBarfilterMap = this.buildIconTabBarFilterMap();
+        const iconTabBarFilterMap = this.buildIconTabBarFilterMap();
+        const customViewTableBuildingBlockMap = this.getCustomViewTableBuildingBlocksMap(iconTabBarFilterMap);
         for (const table of getRelevantControlFromActivePage(
             this.context.controlIndex,
             this.context.view,
             this.controlTypes
         )) {
-            const tabKey = Object.keys(iconTabBarfilterMap).find((key) => table.getId().endsWith(key));
+            const tabKey = Object.keys(iconTabBarFilterMap).find((key) => table.getId().endsWith(key));
             const section = getParentContainer<ObjectPageSection>(table, 'sap.uxap.ObjectPageSection');
             if (section) {
                 await this.collectChildrenInSection(section, table);
             } else if (this.iconTabBar && tabKey) {
-                const label = `'${iconTabBarfilterMap[tabKey]}' table`;
+                const label = `'${iconTabBarFilterMap[tabKey]}' table`;
                 const tableMapKey = this.children.length.toString();
-                const child = this.createChild(label, table, tableMapKey);
+                const child = this.createChild(label, table, tableMapKey, customViewTableBuildingBlockMap);
                 this.children.push(child);
                 this.tableMap[tableMapKey] = {
                     table,
@@ -351,13 +384,31 @@ export abstract class TableQuickActionDefinitionBase extends QuickActionDefiniti
         };
     }
 
-    createChild(label: string, table: UI5Element, path: string): NestedQuickActionChild {
+    createChild(
+        label: string,
+        table: UI5Element,
+        path: string,
+        customViewTableBuildingBlockMap?: {
+            [key: string]: string;
+        }
+    ): NestedQuickActionChild {
         const child: NestedQuickActionChild = {
             path,
             label,
             enabled: true,
             children: []
         };
+        const parent = table.getParent();
+        const macroTable = isMacroTable(parent) ? parent : undefined;
+        if (this.options.validateTableColumns && macroTable) {
+            const { metaPath, contextPath } = macroTable;
+            const finalPath = metaPath.startsWith(contextPath) ? metaPath : `${contextPath}${metaPath}`;
+            if (customViewTableBuildingBlockMap?.[finalPath]) {
+                child.enabled = false;
+                child.tooltip = this.context.resourceBundle.getText('CUSTOM_COLUMNS_NOT_SUPPORTED');
+                return child;
+            }
+        }
         if (this.options.validatePageVariantManagement) {
             const variantEnabledV2 = isVariantManagementEnabledOPPage(this.context, table);
             if (variantEnabledV2 === false) {

package/dist/client/adp/ui/AddCustomFragment.fragment.xml

@@ -14,6 +14,12 @@
             labelSpanS="4"
             singleContainerFullSize="false">
             <f:content>
+                <Label visible="{/isCustomColumnFragment}" text="{i18n>ADP_ADD_CUSTOM_FRAGMENT_DIALOG_COLUMN_ID_LABEL}" required="true" />
+                <Input 
+                    value="{/id}"
+                    visible="{/isCustomColumnFragment}"
+                    liveChange="onIdInputChange">
+                </Input>
                 <Label text="{i18n>ADP_ADD_FRAGMENT_DIALOG_FRAGMENT_NAME_LABEL}" required="true" />
                 <Input 
                     id="bbFragmentName"

package/dist/client/messagebundle.properties

@@ -135,5 +135,9 @@ FRAGMENT_PATH=FRAGMENT PATH
 ACTION_ID_REQUIRED=Action ID is required.
 ACTION_WITH_GIVEN_ID_ALREADY_EXISTS=An action with the ''{0}''  ID is already defined. Please choose a different ID.
 ACTION_ID_CANNOT_CONTAIN_SPACES=Action ID cannot contain spaces.
-ACTION_ID_INVALID_FORMAT=Action ID must start with a letter or _ and may contain letters, digits, _, ., :, and -.
 BUTTON_TEXT_REQUIRED=Button Text is required.
+CUSTOM_COLUMNS_NOT_SUPPORTED=Custom columns defined in the manifest.json file are not supported when using the Table building block.
+ADP_ADD_CUSTOM_FRAGMENT_DIALOG_COLUMN_ID_LABEL=Column ID
+ID_REQUIRED={0} ID is required.
+GIVEN_ID_ALREADY_EXISTS={0} with ID ''{1}'' is already defined.
+ID_INVALID_FORMAT={0} ID must start with a letter or _ and may contain letters, digits, _, ., :, and -.

package/dist/client/utils/fe-v4.js

@@ -141,6 +141,17 @@ sap.ui.define(["sap/ui/core/Component", "./core", "sap/ui/rta/command/CommandFac
     }
     return result;
   }
+  /** * Checks if the given control is inside a table and returns the table instance.
+   * For UI5 version greater than 1.144 the table is 'sap.fe.macros.Table' and for lower versions it is 'sap.fe.macros.table.TableAPI'
+   * @param control - UI5 control instance.
+   * @returns Table instance if the control is inside a table, otherwise undefined.
+   */
+  function isMacroTable(table) {
+    if (table && (isA('sap.fe.macros.Table', table) || isA('sap.fe.macros.table.TableAPI', table))) {
+      return true;
+    }
+    return false;
+  }
   var __exports = {
     __esModule: true
   };
@@ -151,6 +162,7 @@ sap.ui.define(["sap/ui/core/Component", "./core", "sap/ui/rta/command/CommandFac
   __exports.getConfigMapControlIdMap = getConfigMapControlIdMap;
   __exports.createManifestPropertyChange = createManifestPropertyChange;
   __exports.getV4ApplicationPages = getV4ApplicationPages;
+  __exports.isMacroTable = isMacroTable;
   return __exports;
 });
 //# sourceMappingURL=fe-v4.js.map

package/dist/client/utils/fe-v4.ts

@@ -10,6 +10,12 @@ import CommandFactory from 'sap/ui/rta/command/CommandFactory';
 import { getOverlay } from '../cpe/utils';
 import UI5Element from 'sap/ui/core/Element';
 import FlexCommand from 'sap/ui/rta/command/FlexCommand';
+import TableAPI from 'sap/fe/macros/table/TableAPI';
+
+export type MacroTable = TableAPI & {
+    metaPath: string;
+    contextPath: string;
+};
 
 /**
  * Gets app component of a v4 project.
@@ -167,3 +173,14 @@ export function getV4ApplicationPages(manifest: Manifest): { id: string; entityS
     }
     return result;
 }
+/** * Checks if the given control is inside a table and returns the table instance.
+ * For UI5 version greater than 1.144 the table is 'sap.fe.macros.Table' and for lower versions it is 'sap.fe.macros.table.TableAPI'
+ * @param control - UI5 control instance.
+ * @returns Table instance if the control is inside a table, otherwise undefined.
+ */
+export function isMacroTable(table: ManagedObject | null): table is MacroTable {
+    if (table && (isA<MacroTable>('sap.fe.macros.Table', table) || isA<MacroTable>('sap.fe.macros.table.TableAPI', table))) {
+        return true;
+    }
+    return false;
+}

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.23.134",
+  "version": "0.23.135",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,9 +27,9 @@
     "mem-fs-editor": "9.4.0",
     "qrcode": "1.5.4",
     "@sap/bas-sdk": "3.13.3",
-    "@sap-ux/adp-tooling": "0.18.74",
+    "@sap-ux/adp-tooling": "0.18.75",
     "@sap-ux/btp-utils": "1.1.9",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.7.14",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.7.16",
     "@sap-ux/feature-toggle": "0.3.7",
     "@sap-ux/logger": "0.8.1",
     "@sap-ux/project-access": "1.35.9",
@@ -53,7 +53,7 @@
     "nock": "13.4.0",
     "npm-run-all2": "8.0.4",
     "supertest": "7.2.2",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.18.22",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.18.23",
     "@sap-ux/axios-extension": "1.25.16",
     "@sap-ux/store": "1.5.7",
     "@sap-ux/ui5-info": "0.13.13"

package/dist/client/adp/quick-actions/fe-v4/create-table-custom-column.js

@@ -1,51 +0,0 @@
-"use strict";
-
-sap.ui.define(["sap/ui/dt/OverlayRegistry", "../../dialog-factory", "../control-types", "../table-quick-action-base", "../fe-v2/create-table-custom-column", "../dialog-enablement-validator"], function (OverlayRegistry, ____dialog_factory, ___control_types, ___table_quick_action_base, ___fe_v2_create_table_custom_column, ___dialog_enablement_validator) {
-  "use strict";
-
-  const DialogFactory = ____dialog_factory["DialogFactory"];
-  const DialogNames = ____dialog_factory["DialogNames"];
-  const SMART_TABLE_TYPE = ___control_types["SMART_TABLE_TYPE"];
-  const GRID_TABLE_TYPE = ___control_types["GRID_TABLE_TYPE"];
-  const MDC_TABLE_TYPE = ___control_types["MDC_TABLE_TYPE"];
-  const TREE_TABLE_TYPE = ___control_types["TREE_TABLE_TYPE"];
-  const TableQuickActionDefinitionBase = ___table_quick_action_base["TableQuickActionDefinitionBase"];
-  const preprocessActionExecution = ___fe_v2_create_table_custom_column["preprocessActionExecution"];
-  const DIALOG_ENABLEMENT_VALIDATOR = ___dialog_enablement_validator["DIALOG_ENABLEMENT_VALIDATOR"];
-  const CREATE_TABLE_CUSTOM_COLUMN = 'create-table-custom-column';
-  const CONTROL_TYPES = [SMART_TABLE_TYPE, MDC_TABLE_TYPE, TREE_TABLE_TYPE, GRID_TABLE_TYPE];
-  class AddTableCustomColumnQuickAction extends TableQuickActionDefinitionBase {
-    constructor(context) {
-      super(CREATE_TABLE_CUSTOM_COLUMN, CONTROL_TYPES, 'QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN', context, undefined, [DIALOG_ENABLEMENT_VALIDATOR]);
-    }
-    async execute(path) {
-      const {
-        table,
-        iconTabBarFilterKey,
-        sectionInfo
-      } = this.tableMap[path];
-      if (!table) {
-        return [];
-      }
-      preprocessActionExecution(table, sectionInfo, this.iconTabBar, iconTabBarFilterKey);
-      this.selectOverlay(table);
-      const overlay = OverlayRegistry.getOverlay(table);
-      await DialogFactory.createDialog(overlay, this.context.rta, DialogNames.ADD_FRAGMENT, undefined, {
-        aggregation: 'columns',
-        title: 'QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN'
-      }, {
-        actionName: this.type,
-        telemetryEventIdentifier: this.getTelemetryIdentifier()
-      });
-      return [];
-    }
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.CREATE_TABLE_CUSTOM_COLUMN = CREATE_TABLE_CUSTOM_COLUMN;
-  __exports.CONTROL_TYPES = CONTROL_TYPES;
-  __exports.AddTableCustomColumnQuickAction = AddTableCustomColumnQuickAction;
-  return __exports;
-});
-//# sourceMappingURL=create-table-custom-column.js.map

package/dist/client/adp/quick-actions/fe-v4/create-table-custom-column.ts

@@ -1,52 +0,0 @@
-import type FlexCommand from 'sap/ui/rta/command/FlexCommand';
-import OverlayRegistry from 'sap/ui/dt/OverlayRegistry';
-
-import {
-    QuickActionContext,
-    NestedQuickActionDefinition
-} from '../../../cpe/quick-actions/quick-action-definition';
-import { DialogFactory, DialogNames } from '../../dialog-factory';
-import { SMART_TABLE_TYPE, GRID_TABLE_TYPE, MDC_TABLE_TYPE, TREE_TABLE_TYPE } from '../control-types';
-import { TableQuickActionDefinitionBase } from '../table-quick-action-base';
-
-import { preprocessActionExecution } from '../fe-v2/create-table-custom-column';
-import { DIALOG_ENABLEMENT_VALIDATOR } from '../dialog-enablement-validator';
-
-export const CREATE_TABLE_CUSTOM_COLUMN = 'create-table-custom-column';
-
-export const CONTROL_TYPES = [SMART_TABLE_TYPE, MDC_TABLE_TYPE, TREE_TABLE_TYPE, GRID_TABLE_TYPE];
-
-export class AddTableCustomColumnQuickAction
-    extends TableQuickActionDefinitionBase
-    implements NestedQuickActionDefinition
-{
-    constructor(context: QuickActionContext) {
-        super(CREATE_TABLE_CUSTOM_COLUMN, CONTROL_TYPES, 'QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN', context, undefined, [
-            DIALOG_ENABLEMENT_VALIDATOR
-        ]);
-    }
-
-    async execute(path: string): Promise<FlexCommand[]> {
-        const { table, iconTabBarFilterKey, sectionInfo } = this.tableMap[path];
-        if (!table) {
-            return [];
-        }
-
-        preprocessActionExecution(table, sectionInfo, this.iconTabBar, iconTabBarFilterKey);
-        this.selectOverlay(table);
-
-        const overlay = OverlayRegistry.getOverlay(table);
-        await DialogFactory.createDialog(
-            overlay,
-            this.context.rta,
-            DialogNames.ADD_FRAGMENT,
-            undefined,
-            {
-                aggregation: 'columns',
-                title: 'QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN'
-            },
-            { actionName: this.type, telemetryEventIdentifier: this.getTelemetryIdentifier() }
-        );
-        return [];
-    }
-}