@sap-ux/preview-middleware 0.16.131 → 0.16.133

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

@@ -14,6 +14,7 @@ import { getUi5Version, isLowerThanMinimalUi5Version } from '../../utils/version
 import ObjectPageSection from 'sap/uxap/ObjectPageSection';
 import ObjectPageSubSection from 'sap/uxap/ObjectPageSubSection';
 import ObjectPageLayout from 'sap/uxap/ObjectPageLayout';
+import ManagedObject from 'sap/ui/base/ManagedObject';
 
 const SMART_TABLE_ACTION_ID = 'CTX_COMP_VARIANT_CONTENT';
 const M_TABLE_ACTION_ID = 'CTX_ADD_ELEMENTS_AS_CHILD';
@@ -39,6 +40,10 @@ async function getActionId(table: UI5Element): Promise<string[]> {
 
     return [M_TABLE_ACTION_ID, SETTINGS_ID];
 }
+export type TableQuickActionsOptions = {
+    includeServiceAction?: boolean;
+    areTableRowsRequired?: boolean;
+};
 
 /**
  * Base class for table quick actions.
@@ -49,7 +54,13 @@ export abstract class TableQuickActionDefinitionBase {
         return `${this.context.key}-${this.type}`;
     }
 
-    public isActive = false;
+    public isApplicable = false;
+
+    protected isDisabled: boolean | undefined;
+
+    public get tooltip(): string | undefined {
+        return undefined;
+    }
 
     public children: NestedQuickActionChild[] = [];
     public tableMap: Record<
@@ -79,7 +90,7 @@ export abstract class TableQuickActionDefinitionBase {
         protected readonly controlTypes: string[],
         protected readonly defaultTextKey: string,
         protected readonly context: QuickActionContext,
-        protected includeServiceAction?: boolean
+        protected options: TableQuickActionsOptions = {}
     ) {}
 
     /**
@@ -89,7 +100,7 @@ export abstract class TableQuickActionDefinitionBase {
         // No action found in control design time for version < 1.96
         const version = await getUi5Version();
         if (isLowerThanMinimalUi5Version(version, { major: 1, minor: 96 })) {
-            this.isActive = false;
+            this.isApplicable = false;
             return;
         }
         const iconTabBarfilterMap = this.buildIconTabBarFilterMap();
@@ -103,10 +114,9 @@ export abstract class TableQuickActionDefinitionBase {
             if (section) {
                 this.collectChildrenInSection(section, table);
             } else if (this.iconTabBar && tabKey) {
-                this.children.push({
-                    label: `'${iconTabBarfilterMap[tabKey]}' table`,
-                    children: []
-                });
+                const label = `'${iconTabBarfilterMap[tabKey]}' table`;
+                const child = this.createChild(label, table);
+                this.children.push(child);
                 this.tableMap[`${this.children.length - 1}`] = {
                     table,
                     iconTabBarFilterKey: tabKey,
@@ -117,7 +127,7 @@ export abstract class TableQuickActionDefinitionBase {
             }
 
             // add action id to the table map, if the service actions are needed.
-            if (this.includeServiceAction) {
+            if (this.options.includeServiceAction) {
                 const actions = await this.context.actionService.get(table.getId());
                 const actionsIds = await getActionId(table);
 
@@ -131,7 +141,31 @@ export abstract class TableQuickActionDefinitionBase {
             }
         }
         if (this.children.length > 0) {
-            this.isActive = true;
+            this.isApplicable = true;
+        }
+    }
+
+    /**
+     * Retrieves the internal table control from a UI5Element.
+     *
+     * @param table - The UI5Element instance to analyze.
+     * @returns The internal table otherwise undefined.
+     */
+    protected getInternalTable(table: UI5Element): UI5Element | undefined {
+        try {
+            let tableInternal: ManagedObject | undefined;
+
+            if (isA<SmartTable>(SMART_TABLE_TYPE, table)) {
+                const itemsAggregation = table.getAggregation('items') as ManagedObject[];
+                tableInternal = itemsAggregation.find((item) =>
+                    [M_TABLE_TYPE, TREE_TABLE_TYPE, ANALYTICAL_TABLE_TYPE, GRID_TABLE_TYPE].some((tType) =>
+                        isA(tType, item)
+                    )
+                );
+            }
+            return tableInternal as UI5Element | undefined;
+        } catch (error) {
+            return undefined;
         }
     }
 
@@ -160,7 +194,7 @@ export abstract class TableQuickActionDefinitionBase {
      * Builds a map kay/tab_name for ICON_TAB_BAR control of the active page, if such exists
      * @returns built map
      */
-    private buildIconTabBarFilterMap(): { [key: string]: string } {
+    protected buildIconTabBarFilterMap(): { [key: string]: string } {
         const iconTabBarFilterMap: { [key: string]: string } = {};
 
         // Assumption only a tab bar control per page.
@@ -197,23 +231,19 @@ export abstract class TableQuickActionDefinitionBase {
             } else if (subSections.length > 1) {
                 const sectionChild = this.children.find((val) => val.label === `${section.getTitle()} section`);
                 let tableMapIndex = `${this.children.length - 1}`;
+                const label = this.getTableLabel(table);
+                const child = this.createChild(label, table);
                 if (!sectionChild) {
                     tableMapIndex = `${tableMapIndex}/0`;
+
                     this.children.push({
                         label: `'${section?.getTitle()}' section`,
-                        children: [
-                            {
-                                label: this.getTableLabel(table),
-                                children: []
-                            }
-                        ]
+                        enabled: true,
+                        children: [child]
                     });
                 } else {
                     tableMapIndex = `${tableMapIndex}/${sectionChild.children.length - 1}`;
-                    sectionChild.children.push({
-                        label: this.getTableLabel(table),
-                        children: []
-                    });
+                    sectionChild.children.push(child);
                 }
 
                 this.tableMap[tableMapIndex] = {
@@ -235,10 +265,9 @@ export abstract class TableQuickActionDefinitionBase {
         sectionInfo?: { section: ObjectPageSection; subSection: ObjectPageSubSection; layout?: ObjectPageLayout }
     ): void {
         if ([SMART_TABLE_TYPE, M_TABLE_TYPE, MDC_TABLE_TYPE, TREE_TABLE_TYPE].some((type) => isA(type, table))) {
-            this.children.push({
-                label: this.getTableLabel(table),
-                children: []
-            });
+            const label = this.getTableLabel(table);
+            const child = this.createChild(label, table);
+            this.children.push(child);
         }
 
         this.tableMap[`${this.children.length - 1}`] = {
@@ -267,9 +296,28 @@ export abstract class TableQuickActionDefinitionBase {
         return {
             kind: NESTED_QUICK_ACTION_KIND,
             id: this.id,
-            enabled: this.isActive,
+            enabled: !this.isDisabled,
+            tooltip: this.tooltip,
             title: this.context.resourceBundle.getText(this.textKey),
             children: this.children
         };
     }
+
+    createChild(label: string, table: UI5Element): NestedQuickActionChild {
+        const child: NestedQuickActionChild = {
+            label,
+            enabled: true,
+            children: []
+        };
+        if (!this.options.areTableRowsRequired) {
+            return child;
+        }
+        const innerTable = this.getInternalTable(table);
+        const tableRows = (innerTable?.getAggregation('items') as ManagedObject[]) || [];
+        if (isA(M_TABLE_TYPE, innerTable) && !tableRows.length) {
+            child.enabled = false;
+            child.tooltip = this.context.resourceBundle.getText('TABLE_CUSTOM_COLUMN_ACTION_NOT_AVAILABLE');
+        }
+        return child;
+    }
 }

package/dist/client/cpe/changes/flex-change.js

@@ -3,14 +3,12 @@ sap.ui.define([
     'sap/ui/rta/command/CommandFactory',
     'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
     './validator',
-    '../../utils/fe-v4',
-    '../utils'
-], function (CommandFactory, ___sap_ux_private_control_property_editor_common, ___validator, ____utils_fe_v4, ___utils) {
+    '../../utils/fe-v4'
+], function (CommandFactory, ___sap_ux_private_control_property_editor_common, ___validator, ____utils_fe_v4) {
     'use strict';
     const PropertyType = ___sap_ux_private_control_property_editor_common['PropertyType'];
     const validateBindingModel = ___validator['validateBindingModel'];
-    const getReference = ____utils_fe_v4['getReference'];
-    const getOverlay = ___utils['getOverlay'];
+    const createManifestPropertyChange = ____utils_fe_v4['createManifestPropertyChange'];
     function isBindingExpression(value) {
         return value.includes('{') && value.includes('}') && value.indexOf('{') < value.indexOf('}');
     }
@@ -38,22 +36,12 @@ sap.ui.define([
             const command = await CommandFactory.getCommandFor(modifiedControl, changeType, modifiedValue, null, flexSettings);
             await rta.getCommandStack().pushAndExecute(command);
         } else if (change.propertyType === PropertyType.Configuration) {
-            const overlay = getOverlay(modifiedControl);
-            if (!overlay) {
+            const command = await createManifestPropertyChange(modifiedControl, flexSettings, { [change.propertyName]: change.value });
+            if (command) {
+                await rta.getCommandStack().pushAndExecute(command);
+            } else {
                 return;
             }
-            const overlayData = overlay?.getDesignTimeMetadata().getData();
-            const manifestPropertyPath = overlayData.manifestPropertyPath(modifiedControl);
-            const [manifestPropertyChange] = overlayData.manifestPropertyChange({ [change.propertyName]: change.value }, manifestPropertyPath, modifiedControl);
-            const modifiedValue = {
-                reference: getReference(modifiedControl),
-                appComponent: manifestPropertyChange.appComponent,
-                changeType: manifestPropertyChange.changeSpecificData.appDescriptorChangeType,
-                parameters: manifestPropertyChange.changeSpecificData.content.parameters,
-                selector: manifestPropertyChange.selector
-            };
-            const command = await CommandFactory.getCommandFor(modifiedControl, 'appDescriptor', modifiedValue, null, flexSettings);
-            await rta.getCommandStack().pushAndExecute(command);
         }
     }
     var __exports = { __esModule: true };

package/dist/client/cpe/changes/flex-change.ts

@@ -3,9 +3,7 @@ import CommandFactory from 'sap/ui/rta/command/CommandFactory';
 import { PropertyType, type PropertyChange } from '@sap-ux-private/control-property-editor-common';
 import type { UI5AdaptationOptions } from '../types';
 import { validateBindingModel } from './validator';
-import { getReference } from '../../utils/fe-v4';
-import { getOverlay } from '../utils';
-
+import { createManifestPropertyChange } from '../../utils/fe-v4';
 /**
  * Function to check a give value is a binding expression.
  *
@@ -56,33 +54,11 @@ export async function applyChange(options: UI5AdaptationOptions, change: Propert
         );
         await rta.getCommandStack().pushAndExecute(command);
     } else if (change.propertyType === PropertyType.Configuration) {
-        const overlay = getOverlay(modifiedControl);
-        if (!overlay) {
+        const command = await createManifestPropertyChange(modifiedControl, flexSettings, { [change.propertyName]: change.value });
+        if (command) {
+            await rta.getCommandStack().pushAndExecute(command);
+        } else {
             return;
         }
-        const overlayData = overlay?.getDesignTimeMetadata().getData();
-        const manifestPropertyPath = overlayData.manifestPropertyPath(modifiedControl);
-        const [manifestPropertyChange] = overlayData.manifestPropertyChange(
-            { [change.propertyName]: change.value },
-            manifestPropertyPath,
-            modifiedControl
-        );
-
-        const modifiedValue = {
-            reference: getReference(modifiedControl),
-            appComponent: manifestPropertyChange.appComponent,
-            changeType: manifestPropertyChange.changeSpecificData.appDescriptorChangeType,
-            parameters: manifestPropertyChange.changeSpecificData.content.parameters,
-            selector: manifestPropertyChange.selector
-        };
-
-        const command = await CommandFactory.getCommandFor(
-            modifiedControl,
-            'appDescriptor',
-            modifiedValue,
-            null,
-            flexSettings
-        );
-        await rta.getCommandStack().pushAndExecute(command);
     }
 }

package/dist/client/cpe/quick-actions/quick-action-definition.ts

@@ -42,11 +42,6 @@ export interface QuickActionContext {
     changeService: ChangeService;
 }
 
-export type QuickActionActivationData = {
-    isActive: boolean;
-    title: string;
-};
-
 interface QuickActionDefinitionBase {
     /**
      * Used to identify between different Quick Action definitions.
@@ -65,7 +60,7 @@ interface QuickActionDefinitionBase {
     /**
      * Indicates that the Quick Action is applicable to the given context and should be displayed.
      */
-    isActive: boolean;
+    isApplicable: boolean;
     /**
      * Initializes the action and checks if it should be enabled in current context.
      */

package/dist/client/cpe/quick-actions/quick-action-service.js

@@ -85,7 +85,7 @@ sap.ui.define([
             this.sendAction(quickActionListChanged(groups));
         }
         addAction(group, instance) {
-            if (instance.isActive) {
+            if (instance.isApplicable) {
                 const quickAction = instance.getActionObject();
                 group.actions.push(quickAction);
                 this.actions.push(instance);

package/dist/client/cpe/quick-actions/quick-action-service.ts

@@ -132,7 +132,7 @@ export class QuickActionService implements Service {
     }
 
     private addAction(group: QuickActionGroup, instance: QuickActionDefinition): void {
-        if (instance.isActive) {
+        if (instance.isApplicable) {
             const quickAction = instance.getActionObject();
             group.actions.push(quickAction);
             this.actions.push(instance);

package/dist/client/messagebundle.properties

@@ -5,6 +5,7 @@ QUICK_ACTION_OP_ADD_CUSTOM_SECTION=Add Custom Section
 QUICK_ACTION_ADD_CUSTOM_PAGE_ACTION=Add Custom Page Action
 QUICK_ACTION_ADD_CUSTOM_TABLE_ACTION=Add Custom Table Action
 QUICK_ACTION_ADD_CUSTOM_TABLE_COLUMN=Add Custom Table Column
+QUICK_ACTION_ENABLE_TABLE_FILTERING=Enable Table Filtering for Page Variants
 
 V2_QUICK_ACTION_CHANGE_TABLE_COLUMNS=Change Table Columns
 
@@ -14,7 +15,6 @@ V2_QUICK_ACTION_LR_DISABLE_CLEAR_FILTER_BAR=Disable "Clear" Button in Filter Bar
 QUICK_ACTION_LR_ENABLE_SEMANTIC_DATE_RANGE_FILTER_BAR=Enable Semantic Date Range in Filter Bar
 QUICK_ACTION_LR_DISABLE_SEMANTIC_DATE_RANGE_FILTER_BAR=Disable Semantic Date Range in Filter Bar
 
-
 V4_QUICK_ACTION_CHANGE_TABLE_COLUMNS=Change Table Columns
 
 V4_QUICK_ACTION_LR_ENABLE_CLEAR_FILTER_BAR=Enable "Clear" Button in Filter Bar
@@ -38,3 +38,6 @@ CPE_CHANGES_VISIBLE_AFTER_SAVE_AND_RELOAD_MESSAGE = Note: The change will be vis
 TABLE_ROWS_NEEDED_TO_CREATE_CUSTOM_COLUMN=At least one table row is required to create new custom column. Make sure the table data is loaded and try again.
 
 HIGHER_LAYER_CHANGES_INFO_MESSAGE=The preview of the project was reloaded due to detected changes in higher layer than the one used in your project.
+
+TABLE_CUSTOM_COLUMN_ACTION_NOT_AVAILABLE=This action has been disabled because the table rows are not available. Please load the table data and try again
+THE_CHANGE_HAS_ALREADY_BEEN_MADE=This option has been disabled because the change has already been made

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

@@ -1,9 +1,10 @@
 "use strict";
 
-sap.ui.define(["sap/ui/core/Component", "./core"], function (Component, ___core) {
+sap.ui.define(["sap/ui/core/Component", "./core", "sap/ui/rta/command/CommandFactory", "../cpe/utils"], function (Component, ___core, CommandFactory, ___cpe_utils) {
   "use strict";
 
   const isA = ___core["isA"];
+  const getOverlay = ___cpe_utils["getOverlay"];
   /**
    * Gets app component of a v4 project.
    *
@@ -74,6 +75,33 @@ sap.ui.define(["sap/ui/core/Component", "./core"], function (Component, ___core)
     }
     return propertyPathSegments.join('/');
   }
+
+  /**
+  * Get the modified value for a control.
+  * @param modifiedControl - The modified control.
+  * @param flexSettings - Flex Settings of the control.
+  * @param propertyChanges - The change object
+  * 
+  * @returns  A Promise resolving to an array of FlexCommand objects.
+  */
+  async function createManifestPropertyChange(modifiedControl, flexSettings, propertyChanges) {
+    const overlay = getOverlay(modifiedControl);
+    if (!overlay) {
+      return undefined;
+    }
+    const overlayData = overlay?.getDesignTimeMetadata().getData();
+    const manifestPropertyPath = overlayData.manifestPropertyPath(modifiedControl);
+    const [manifestPropertyChange] = overlayData.manifestPropertyChange(propertyChanges, manifestPropertyPath, modifiedControl);
+    const modifiedValue = {
+      reference: getReference(modifiedControl),
+      appComponent: manifestPropertyChange.appComponent,
+      changeType: manifestPropertyChange.changeSpecificData.appDescriptorChangeType,
+      parameters: manifestPropertyChange.changeSpecificData.content.parameters,
+      selector: manifestPropertyChange.selector
+    };
+    const command = await CommandFactory.getCommandFor(modifiedControl, 'appDescriptor', modifiedValue, null, flexSettings);
+    return command;
+  }
   var __exports = {
     __esModule: true
   };
@@ -82,6 +110,7 @@ sap.ui.define(["sap/ui/core/Component", "./core"], function (Component, ___core)
   __exports.getV4PageType = getV4PageType;
   __exports.getPageName = getPageName;
   __exports.getConfigMapControlIdMap = getConfigMapControlIdMap;
+  __exports.createManifestPropertyChange = createManifestPropertyChange;
   return __exports;
 });
 //# sourceMappingURL=fe-v4.js.map

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

@@ -3,8 +3,12 @@ import TemplateComponent from 'sap/fe/core/TemplateComponent';
 import Component from 'sap/ui/core/Component';
 import AppComponent from 'sap/fe/core/AppComponent';
 import XMLView from 'sap/ui/core/mvc/XMLView';
-import type { Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+import type { FlexSettings, Manifest } from 'sap/ui/rta/RuntimeAuthoring';
 import { isA } from './core';
+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';
 
 
 /**
@@ -79,3 +83,43 @@ export function getConfigMapControlIdMap(page: string | undefined, propertyPathS
     }
     return propertyPathSegments.join('/');
 }
+
+/**
+* Get the modified value for a control.
+* @param modifiedControl - The modified control.
+* @param flexSettings - Flex Settings of the control.
+* @param propertyChanges - The change object
+* 
+* @returns  A Promise resolving to an array of FlexCommand objects.
+*/
+export async function createManifestPropertyChange(modifiedControl: UI5Element, flexSettings: FlexSettings, propertyChanges: Record<string, string | string[] | boolean | number | object | undefined>): Promise<FlexCommand | undefined> {
+    const overlay = getOverlay(modifiedControl);
+    if (!overlay) {
+        return undefined;
+    }
+    const overlayData = overlay?.getDesignTimeMetadata().getData();
+    const manifestPropertyPath = overlayData.manifestPropertyPath(modifiedControl);
+    const [manifestPropertyChange] = overlayData.manifestPropertyChange(
+        propertyChanges,
+        manifestPropertyPath,
+        modifiedControl
+    );
+
+    const modifiedValue = {
+        reference: getReference(modifiedControl),
+        appComponent: manifestPropertyChange.appComponent,
+        changeType: manifestPropertyChange.changeSpecificData.appDescriptorChangeType,
+        parameters: manifestPropertyChange.changeSpecificData.content.parameters,
+        selector: manifestPropertyChange.selector
+    };
+
+    const command = await CommandFactory.getCommandFor(
+        modifiedControl,
+        'appDescriptor',
+        modifiedValue,
+        null,
+        flexSettings
+    );
+
+    return command;
+}

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.16.131",
+  "version": "0.16.133",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -29,7 +29,7 @@
     "@sap-ux/feature-toggle": "0.2.2",
     "@sap-ux/btp-utils": "0.17.0",
     "@sap-ux/adp-tooling": "0.12.85",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.27",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.28",
     "@sap-ux/project-access": "1.28.7"
   },
   "devDependencies": {
@@ -46,9 +46,9 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.1.0",
     "dotenv": "16.3.1",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.36",
-    "@sap-ux/axios-extension": "1.17.4",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.38",
     "@sap-ux/store": "0.9.3",
+    "@sap-ux/axios-extension": "1.17.4",
     "@sap-ux/ui5-info": "0.8.3",
     "@sap-ux/i18n": "0.2.0"
   },