@sap-ux/preview-middleware 0.16.131 → 0.16.133

package/dist/client/adp/quick-actions/fe-v4/lr-enable-table-filtering.js

@@ -0,0 +1,84 @@
+"use strict";
+
+sap.ui.define(["./table-quick-action-base", "../../../cpe/quick-actions/utils", "../../../utils/fe-v4", "../../../utils/version"], function (___table_quick_action_base, _____cpe_quick_actions_utils, _____utils_fe_v4, _____utils_version) {
+  "use strict";
+
+  const TableQuickActionDefinitionBase = ___table_quick_action_base["TableQuickActionDefinitionBase"];
+  const getRelevantControlFromActivePage = _____cpe_quick_actions_utils["getRelevantControlFromActivePage"];
+  const createManifestPropertyChange = _____utils_fe_v4["createManifestPropertyChange"];
+  const getUi5Version = _____utils_version["getUi5Version"];
+  const isLowerThanMinimalUi5Version = _____utils_version["isLowerThanMinimalUi5Version"];
+  const ENABLE_TABLE_FILTERING = 'enable-table-filtering';
+  const CONTROL_TYPE = 'sap.ui.mdc.Table';
+  /**
+   * Quick Action for enabling table filtering using table personalization settings.
+   */
+  class EnableTableFilteringQuickAction extends TableQuickActionDefinitionBase {
+    constructor(context) {
+      super(ENABLE_TABLE_FILTERING, 'QUICK_ACTION_ENABLE_TABLE_FILTERING', context);
+    }
+    forceRefreshAfterExecution = true;
+    async initialize() {
+      const version = await getUi5Version();
+      if (isLowerThanMinimalUi5Version(version, {
+        major: 1,
+        minor: 131
+      })) {
+        this.isApplicable = false;
+        return;
+      }
+      const tooltipText = this.context.resourceBundle.getText('THE_CHANGE_HAS_ALREADY_BEEN_MADE');
+      let index = 0;
+      for (const smartTable of getRelevantControlFromActivePage(this.context.controlIndex, this.context.view, [CONTROL_TYPE])) {
+        const personalizationData = smartTable.getP13nMode();
+        const value = this.context.changeService.getConfigurationPropertyValue(smartTable.getId(), 'personalization');
+        const isFilterEnabled = value?.filter === undefined ? personalizationData.includes('Filter') : value.filter;
+        this.children.push({
+          label: `'${smartTable.getHeader()}' table`,
+          enabled: !isFilterEnabled,
+          tooltip: isFilterEnabled ? tooltipText : undefined,
+          children: []
+        });
+        this.tableMap[`${this.children.length - 1}`] = index;
+        index++;
+      }
+      if (this.children.length > 0) {
+        this.isApplicable = true;
+      }
+      return Promise.resolve();
+    }
+    async execute(path) {
+      const {
+        flexSettings
+      } = this.context;
+      const index = this.tableMap[path];
+      const smartTables = getRelevantControlFromActivePage(this.context.controlIndex, this.context.view, [CONTROL_TYPE]);
+      const modifiedControl = smartTables[index];
+      if (!modifiedControl) {
+        return [];
+      }
+      const propertyChange = {
+        personalization: {
+          sort: true,
+          column: true,
+          filter: true,
+          group: true,
+          aggregate: true
+        }
+      };
+      const command = await createManifestPropertyChange(modifiedControl, flexSettings, propertyChange);
+      if (command) {
+        return [command];
+      } else {
+        return [];
+      }
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.ENABLE_TABLE_FILTERING = ENABLE_TABLE_FILTERING;
+  __exports.EnableTableFilteringQuickAction = EnableTableFilteringQuickAction;
+  return __exports;
+});
+//# sourceMappingURL=lr-enable-table-filtering.js.map

package/dist/client/adp/quick-actions/fe-v4/lr-enable-table-filtering.ts

@@ -0,0 +1,96 @@
+import FlexCommand from 'sap/ui/rta/command/FlexCommand';
+
+import { NestedQuickActionDefinition, QuickActionContext } from '../../../cpe/quick-actions/quick-action-definition';
+import Table from 'sap/ui/mdc/Table';
+import { TableQuickActionDefinitionBase } from './table-quick-action-base';
+import { getRelevantControlFromActivePage } from '../../../cpe/quick-actions/utils';
+import { createManifestPropertyChange } from '../../../utils/fe-v4';
+import { getUi5Version, isLowerThanMinimalUi5Version } from '../../../utils/version';
+
+export const ENABLE_TABLE_FILTERING = 'enable-table-filtering';
+const CONTROL_TYPE = 'sap.ui.mdc.Table';
+
+type Personalization = {
+    sort: boolean;
+    column: boolean;
+    filter: boolean;
+    group: boolean;
+    aggregate: boolean;
+};
+
+/**
+ * Quick Action for enabling table filtering using table personalization settings.
+ */
+export class EnableTableFilteringQuickAction
+    extends TableQuickActionDefinitionBase
+    implements NestedQuickActionDefinition
+{
+    constructor(context: QuickActionContext) {
+        super(ENABLE_TABLE_FILTERING, 'QUICK_ACTION_ENABLE_TABLE_FILTERING', context);
+    }
+    readonly forceRefreshAfterExecution = true;
+
+    async initialize(): Promise<void> {
+        const version = await getUi5Version();
+        if (isLowerThanMinimalUi5Version(version, { major: 1, minor: 131 })) {
+            this.isApplicable = false;
+            return;
+        }
+
+        const tooltipText = this.context.resourceBundle.getText('THE_CHANGE_HAS_ALREADY_BEEN_MADE');
+        let index = 0;
+        for (const smartTable of getRelevantControlFromActivePage(this.context.controlIndex, this.context.view, [
+            CONTROL_TYPE
+        ])) {
+            const personalizationData = (smartTable as Table).getP13nMode();
+            const value = this.context.changeService.getConfigurationPropertyValue(
+                smartTable.getId(),
+                'personalization'
+            ) as Personalization;
+            const isFilterEnabled = value?.filter === undefined ? personalizationData.includes('Filter') : value.filter;
+            this.children.push({
+                label: `'${(smartTable as Table).getHeader()}' table`,
+                enabled: !isFilterEnabled,
+                tooltip: isFilterEnabled ? tooltipText : undefined,
+                children: []
+            });
+            this.tableMap[`${this.children.length - 1}`] = index;
+            index++;
+        }
+
+        if (this.children.length > 0) {
+            this.isApplicable = true;
+        }
+
+        return Promise.resolve();
+    }
+
+    async execute(path: string): Promise<FlexCommand[]> {
+        const { flexSettings } = this.context;
+        const index = this.tableMap[path];
+
+        const smartTables = getRelevantControlFromActivePage(this.context.controlIndex, this.context.view, [
+            CONTROL_TYPE
+        ]);
+
+        const modifiedControl = smartTables[index];
+        if (!modifiedControl) {
+            return [];
+        }
+        const propertyChange = {
+            personalization: {
+                sort: true,
+                column: true,
+                filter: true,
+                group: true,
+                aggregate: true
+            }
+        };
+        const command = await createManifestPropertyChange(modifiedControl, flexSettings, propertyChange);
+        if (command) {
+            return [command];
+        } else {
+            return [];
+        }
+    }
+}

package/dist/client/adp/quick-actions/fe-v4/registry.js

@@ -1,6 +1,6 @@
 "use strict";
 
-sap.ui.define(["../../../cpe/quick-actions/registry", "../common/add-controller-to-page", "./lr-toggle-clear-filter-bar", "./change-table-columns", "../common/op-add-header-field", "../common/op-add-custom-section", "./create-table-custom-column", "../common/create-page-action", "./create-table-action", "./lr-enable-semantic-date-range-filter-bar"], function (_____cpe_quick_actions_registry, ___common_add_controller_to_page, ___lr_toggle_clear_filter_bar, ___change_table_columns, ___common_op_add_header_field, ___common_op_add_custom_section, ___create_table_custom_column, ___common_create_page_action, ___create_table_action, ___lr_enable_semantic_date_range_filter_bar) {
+sap.ui.define(["../../../cpe/quick-actions/registry", "../common/add-controller-to-page", "./lr-toggle-clear-filter-bar", "./change-table-columns", "../common/op-add-header-field", "../common/op-add-custom-section", "./create-table-custom-column", "../common/create-page-action", "./create-table-action", "./lr-enable-table-filtering", "./lr-enable-semantic-date-range-filter-bar"], function (_____cpe_quick_actions_registry, ___common_add_controller_to_page, ___lr_toggle_clear_filter_bar, ___change_table_columns, ___common_op_add_header_field, ___common_op_add_custom_section, ___create_table_custom_column, ___common_create_page_action, ___create_table_action, ___lr_enable_table_filtering, ___lr_enable_semantic_date_range_filter_bar) {
   "use strict";
 
   const QuickActionDefinitionRegistry = _____cpe_quick_actions_registry["QuickActionDefinitionRegistry"];
@@ -12,6 +12,7 @@ sap.ui.define(["../../../cpe/quick-actions/registry", "../common/add-controller-
   const AddTableCustomColumnQuickAction = ___create_table_custom_column["AddTableCustomColumnQuickAction"];
   const AddPageActionQuickAction = ___common_create_page_action["AddPageActionQuickAction"];
   const AddTableActionQuickAction = ___create_table_action["AddTableActionQuickAction"];
+  const EnableTableFilteringQuickAction = ___lr_enable_table_filtering["EnableTableFilteringQuickAction"];
   const ToggleSemanticDateRangeFilterBar = ___lr_enable_semantic_date_range_filter_bar["ToggleSemanticDateRangeFilterBar"];
   const LIST_REPORT_TYPE = 'sap.fe.templates.ListReport.ListReport';
   const OBJECT_PAGE_TYPE = 'sap.fe.templates.ObjectPage.ObjectPage';
@@ -35,7 +36,7 @@ sap.ui.define(["../../../cpe/quick-actions/registry", "../common/add-controller-
         if (name === 'listReport') {
           definitionGroups.push({
             title: 'LIST REPORT',
-            definitions: [AddControllerToPageQuickAction, AddPageActionQuickAction, ToggleClearFilterBarQuickAction, ToggleSemanticDateRangeFilterBar, ChangeTableColumnsQuickAction, AddTableActionQuickAction, AddTableCustomColumnQuickAction],
+            definitions: [AddControllerToPageQuickAction, AddPageActionQuickAction, ToggleClearFilterBarQuickAction, ToggleSemanticDateRangeFilterBar, ChangeTableColumnsQuickAction, AddTableActionQuickAction, AddTableCustomColumnQuickAction, EnableTableFilteringQuickAction],
             view,
             key: name + index
           });

package/dist/client/adp/quick-actions/fe-v4/registry.ts

@@ -12,6 +12,7 @@ import { AddCustomSectionQuickAction } from '../common/op-add-custom-section';
 import { AddTableCustomColumnQuickAction } from './create-table-custom-column';
 import { AddPageActionQuickAction } from '../common/create-page-action';
 import { AddTableActionQuickAction } from './create-table-action';
+import { EnableTableFilteringQuickAction } from './lr-enable-table-filtering';
 import { ToggleSemanticDateRangeFilterBar } from './lr-enable-semantic-date-range-filter-bar';
 
 type PageName = 'listReport' | 'objectPage';
@@ -43,7 +44,8 @@ export default class FEV4QuickActionRegistry extends QuickActionDefinitionRegist
                         ToggleSemanticDateRangeFilterBar,
                         ChangeTableColumnsQuickAction,
                         AddTableActionQuickAction,
-                        AddTableCustomColumnQuickAction
+                        AddTableCustomColumnQuickAction,
+                        EnableTableFilteringQuickAction
                     ],
                     view,
                     key: name + index

package/dist/client/adp/quick-actions/fe-v4/table-quick-action-base.js

@@ -17,7 +17,11 @@ sap.ui.define([
         get textKey() {
             return this.defaultTextKey;
         }
-        isActive = false;
+        isApplicable = false;
+        isDisabled = false;
+        get tooltip() {
+            return undefined;
+        }
         isClearButtonEnabled = false;
         children = [];
         tableMap = {};
@@ -41,6 +45,7 @@ sap.ui.define([
                 if (changeColumnAction) {
                     this.children.push({
                         label: `'${ smartTable.getHeader() }' table`,
+                        enabled: true,
                         children: []
                     });
                     this.tableMap[`${ this.children.length - 1 }`] = index;
@@ -48,14 +53,15 @@ sap.ui.define([
                 }
             }
             if (this.children.length > 0) {
-                this.isActive = true;
+                this.isApplicable = true;
             }
         }
         getActionObject() {
             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
             };

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

@@ -17,7 +17,12 @@ export abstract class TableQuickActionDefinitionBase {
     protected get textKey(): string {
         return this.defaultTextKey;
     }
-    isActive = false;
+    isApplicable = false;
+    protected isDisabled = false;
+    public get tooltip(): string | undefined {
+        return undefined;
+    }
+
     isClearButtonEnabled = false;
     children: NestedQuickActionChild[] = [];
     tableMap: Record<string, number> = {};
@@ -45,6 +50,7 @@ export abstract class TableQuickActionDefinitionBase {
             if (changeColumnAction) {
                 this.children.push({
                     label: `'${(smartTable as Table).getHeader()}' table`,
+                    enabled: true,
                     children: []
                 });
                 this.tableMap[`${this.children.length - 1}`] = index;
@@ -53,7 +59,7 @@ export abstract class TableQuickActionDefinitionBase {
         }
 
         if (this.children.length > 0) {
-            this.isActive = true;
+            this.isApplicable = true;
         }
     }
 
@@ -61,7 +67,8 @@ 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
         };

package/dist/client/adp/quick-actions/simple-quick-action-base.js

@@ -11,9 +11,12 @@ sap.ui.define([
         get id() {
             return `${ this.context.key }-${ this.type }`;
         }
-        get isActive() {
+        get isApplicable() {
             return this.control !== undefined;
         }
+        get tooltip() {
+            return undefined;
+        }
         get textKey() {
             return this.defaultTextKey;
         }
@@ -33,7 +36,8 @@ sap.ui.define([
             return {
                 kind: SIMPLE_QUICK_ACTION_KIND,
                 id: this.id,
-                enabled: this.isActive,
+                enabled: !this.isDisabled,
+                tooltip: this.tooltip,
                 title: this.context.resourceBundle.getText(this.textKey)
             };
         }

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

@@ -14,10 +14,16 @@ export abstract class SimpleQuickActionDefinitionBase {
         return `${this.context.key}-${this.type}`;
     }
 
-    public get isActive(): boolean {
+    public get isApplicable(): boolean {
         return this.control !== undefined;
     }
 
+    protected isDisabled: boolean | undefined;
+
+    public get tooltip(): string | undefined {
+        return undefined;
+    }
+
     protected get textKey(): string {
         return this.defaultTextKey;
     }
@@ -46,7 +52,8 @@ export abstract class SimpleQuickActionDefinitionBase {
         return {
             kind: SIMPLE_QUICK_ACTION_KIND,
             id: this.id,
-            enabled: this.isActive,
+            enabled: !this.isDisabled,
+            tooltip: this.tooltip,
             title: this.context.resourceBundle.getText(this.textKey)
         };
     }

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

@@ -44,18 +44,22 @@ sap.ui.define([
         get id() {
             return `${ this.context.key }-${ this.type }`;
         }
-        isActive = false;
+        isApplicable = false;
+        get tooltip() {
+            return undefined;
+        }
         children = [];
         tableMap = {};
         get textKey() {
             return this.defaultTextKey;
         }
-        constructor(type, controlTypes, defaultTextKey, context, includeServiceAction) {
+        constructor(type, controlTypes, defaultTextKey, context) {
+            let options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
             this.type = type;
             this.controlTypes = controlTypes;
             this.defaultTextKey = defaultTextKey;
             this.context = context;
-            this.includeServiceAction = includeServiceAction;
+            this.options = options;
         }
         async initialize() {
             const version = await getUi5Version();
@@ -63,7 +67,7 @@ sap.ui.define([
                     major: 1,
                     minor: 96
                 })) {
-                this.isActive = false;
+                this.isApplicable = false;
                 return;
             }
             const iconTabBarfilterMap = this.buildIconTabBarFilterMap();
@@ -73,10 +77,9 @@ sap.ui.define([
                 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,
@@ -85,7 +88,7 @@ sap.ui.define([
                 } else {
                     this.processTable(table);
                 }
-                if (this.includeServiceAction) {
+                if (this.options.includeServiceAction) {
                     const actions = await this.context.actionService.get(table.getId());
                     const actionsIds = await getActionId(table);
                     const changeColumnAction = actionsIds.find(actionId => actions.findIndex(action => action.id === actionId) > -1);
@@ -95,7 +98,24 @@ sap.ui.define([
                 }
             }
             if (this.children.length > 0) {
-                this.isActive = true;
+                this.isApplicable = true;
+            }
+        }
+        getInternalTable(table) {
+            try {
+                let tableInternal;
+                if (isA(SMART_TABLE_TYPE, table)) {
+                    const itemsAggregation = table.getAggregation('items');
+                    tableInternal = itemsAggregation.find(item => [
+                        M_TABLE_TYPE,
+                        TREE_TABLE_TYPE,
+                        ANALYTICAL_TABLE_TYPE,
+                        GRID_TABLE_TYPE
+                    ].some(tType => isA(tType, item)));
+                }
+                return tableInternal;
+            } catch (error) {
+                return undefined;
             }
         }
         getTableLabel(table) {
@@ -142,21 +162,18 @@ sap.ui.define([
                 } 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] = {
                         table,
@@ -177,10 +194,9 @@ sap.ui.define([
                     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 }`] = {
                 table,
@@ -198,11 +214,29 @@ sap.ui.define([
             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, table) {
+            const child = {
+                label,
+                enabled: true,
+                children: []
+            };
+            if (!this.options.areTableRowsRequired) {
+                return child;
+            }
+            const innerTable = this.getInternalTable(table);
+            const tableRows = innerTable?.getAggregation('items') || [];
+            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;
+        }
     }
     var __exports = { __esModule: true };
     __exports.SMART_TABLE_TYPE = SMART_TABLE_TYPE;