@sap-ux/preview-middleware 0.16.155 → 0.16.157

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

@@ -0,0 +1,55 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Base class for all  quick actions.
+   */
+  class QuickActionDefinitionBase {
+    get id() {
+      return `${this.context.key}-${this.type}`;
+    }
+
+    /**
+     * Quick Actions tooltip.
+     */
+    get tooltip() {
+      if (this.validationResult) {
+        const validationErrors = this.validationResult.filter(result => result?.type === 'error');
+        if (validationErrors.length > 0) {
+          const error = validationErrors[0];
+          return error.message;
+        }
+      }
+      return undefined;
+    }
+    get isDisabled() {
+      if (this.validationResult === undefined) {
+        return false;
+      }
+      const validationErrors = this.validationResult.filter(result => result?.type === 'error');
+      return validationErrors.length > 0;
+    }
+    get textKey() {
+      return this.defaultTextKey;
+    }
+    constructor(type, kind, defaultTextKey, context) {
+      let enablementValidators = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
+      this.type = type;
+      this.kind = kind;
+      this.defaultTextKey = defaultTextKey;
+      this.context = context;
+      this.enablementValidators = enablementValidators;
+    }
+    async runEnablementValidators() {
+      this.validationResult = await Promise.all(this.enablementValidators.map(async validator => await validator.run()));
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.QuickActionDefinitionBase = QuickActionDefinitionBase;
+  return __exports;
+});
+//# sourceMappingURL=quick-action-base.js.map

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

@@ -0,0 +1,55 @@
+import { QuickActionContext } from '../../cpe/quick-actions/quick-action-definition';
+
+import { EnablementValidator, EnablementValidatorError, EnablementValidatorResult } from './enablement-validator';
+
+/**
+ * Base class for all  quick actions.
+ */
+export abstract class QuickActionDefinitionBase<T extends string> {
+    public get id(): string {
+        return `${this.context.key}-${this.type}`;
+    }
+
+    /**
+     * Quick Actions tooltip.
+     */
+    public get tooltip(): string | undefined {
+        if (this.validationResult) {
+            const validationErrors = this.validationResult.filter(
+                (result): result is EnablementValidatorError => result?.type === 'error'
+            );
+            if (validationErrors.length > 0) {
+                const error = validationErrors[0];
+                return error.message;
+            }
+        }
+        return undefined;
+    }
+
+    protected validationResult: EnablementValidatorResult[] | undefined;
+    protected get isDisabled(): boolean {
+        if (this.validationResult === undefined) {
+            return false;
+        }
+        const validationErrors = this.validationResult.filter((result) => result?.type === 'error');
+        return validationErrors.length > 0;
+    }
+
+    protected get textKey(): string {
+        return this.defaultTextKey;
+    }
+
+    constructor(
+        public readonly type: string,
+        public readonly kind: T,
+        protected readonly defaultTextKey: string,
+        protected readonly context: QuickActionContext,
+        protected readonly enablementValidators: EnablementValidator[] = []
+    ) {}
+
+    async runEnablementValidators(): Promise<void> {
+        this.validationResult = await Promise.all(
+            this.enablementValidators.map(async (validator) => await validator.run())
+        );
+    }
+}

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

@@ -1,30 +1,25 @@
 'use strict';
 sap.ui.define([
     'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
-    '../../cpe/quick-actions/utils'
-], function (___sap_ux_private_control_property_editor_common, ____cpe_quick_actions_utils) {
+    '../../cpe/quick-actions/utils',
+    './quick-action-base'
+], function (___sap_ux_private_control_property_editor_common, ____cpe_quick_actions_utils, ___quick_action_base) {
     'use strict';
     const SIMPLE_QUICK_ACTION_KIND = ___sap_ux_private_control_property_editor_common['SIMPLE_QUICK_ACTION_KIND'];
     const getRelevantControlFromActivePage = ____cpe_quick_actions_utils['getRelevantControlFromActivePage'];
-    class SimpleQuickActionDefinitionBase {
-        kind = SIMPLE_QUICK_ACTION_KIND;
-        get id() {
-            return `${ this.context.key }-${ this.type }`;
-        }
+    const QuickActionDefinitionBase = ___quick_action_base['QuickActionDefinitionBase'];
+    class SimpleQuickActionDefinitionBase extends QuickActionDefinitionBase {
         get isApplicable() {
             return this.control !== undefined;
         }
-        get tooltip() {
-            return undefined;
-        }
-        get textKey() {
-            return this.defaultTextKey;
-        }
         constructor(type, controlTypes, defaultTextKey, context) {
+            let enablementValidators = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
+            super(type, SIMPLE_QUICK_ACTION_KIND, defaultTextKey, context, enablementValidators);
             this.type = type;
             this.controlTypes = controlTypes;
             this.defaultTextKey = defaultTextKey;
             this.context = context;
+            this.enablementValidators = enablementValidators;
         }
         initialize() {
             for (const control of getRelevantControlFromActivePage(this.context.controlIndex, this.context.view, this.controlTypes)) {

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

@@ -4,38 +4,30 @@ import { SIMPLE_QUICK_ACTION_KIND, SimpleQuickAction } from '@sap-ux-private/con
 
 import { getRelevantControlFromActivePage } from '../../cpe/quick-actions/utils';
 import { QuickActionContext } from '../../cpe/quick-actions/quick-action-definition';
+import { EnablementValidator } from './enablement-validator';
+import { QuickActionDefinitionBase } from './quick-action-base';
 
 /**
  * Base class for all simple quick actions.
  */
-export abstract class SimpleQuickActionDefinitionBase {
-    readonly kind = SIMPLE_QUICK_ACTION_KIND;
-    public get id(): string {
-        return `${this.context.key}-${this.type}`;
-    }
-
+export abstract class SimpleQuickActionDefinitionBase extends QuickActionDefinitionBase<
+    typeof SIMPLE_QUICK_ACTION_KIND
+> {
     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;
-    }
-
     protected control: UI5Element | undefined;
 
     constructor(
         public readonly type: string,
         protected readonly controlTypes: string[],
         protected readonly defaultTextKey: string,
-        protected readonly context: QuickActionContext
-    ) {}
+        protected readonly context: QuickActionContext,
+        protected readonly enablementValidators: EnablementValidator[] = []
+    ) {
+        super(type, SIMPLE_QUICK_ACTION_KIND, defaultTextKey, context, enablementValidators);
+    }
 
     initialize(): void {
         for (const control of getRelevantControlFromActivePage(

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

@@ -4,8 +4,10 @@ sap.ui.define([
     'sap/ui/dt/OverlayUtil',
     '../../cpe/quick-actions/utils',
     '../../utils/core',
-    '../../utils/version'
-], function (___sap_ux_private_control_property_editor_common, OverlayUtil, ____cpe_quick_actions_utils, ____utils_core, ____utils_version) {
+    '../../utils/version',
+    './quick-action-base',
+    './control-types'
+], function (___sap_ux_private_control_property_editor_common, OverlayUtil, ____cpe_quick_actions_utils, ____utils_core, ____utils_version, ___quick_action_base, ___control_types) {
     'use strict';
     const NESTED_QUICK_ACTION_KIND = ___sap_ux_private_control_property_editor_common['NESTED_QUICK_ACTION_KIND'];
     const getParentContainer = ____cpe_quick_actions_utils['getParentContainer'];
@@ -15,16 +17,17 @@ sap.ui.define([
     const isManagedObject = ____utils_core['isManagedObject'];
     const getUi5Version = ____utils_version['getUi5Version'];
     const isLowerThanMinimalUi5Version = ____utils_version['isLowerThanMinimalUi5Version'];
+    const QuickActionDefinitionBase = ___quick_action_base['QuickActionDefinitionBase'];
+    const ANALYTICAL_TABLE_TYPE = ___control_types['ANALYTICAL_TABLE_TYPE'];
+    const GRID_TABLE_TYPE = ___control_types['GRID_TABLE_TYPE'];
+    const M_TABLE_TYPE = ___control_types['M_TABLE_TYPE'];
+    const MDC_TABLE_TYPE = ___control_types['MDC_TABLE_TYPE'];
+    const SMART_TABLE_TYPE = ___control_types['SMART_TABLE_TYPE'];
+    const TREE_TABLE_TYPE = ___control_types['TREE_TABLE_TYPE'];
     const SMART_TABLE_ACTION_ID = 'CTX_COMP_VARIANT_CONTENT';
     const M_TABLE_ACTION_ID = 'CTX_ADD_ELEMENTS_AS_CHILD';
     const SETTINGS_ID = 'CTX_SETTINGS';
     const ICON_TAB_BAR_TYPE = 'sap.m.IconTabBar';
-    const SMART_TABLE_TYPE = 'sap.ui.comp.smarttable.SmartTable';
-    const M_TABLE_TYPE = 'sap.m.Table';
-    const MDC_TABLE_TYPE = 'sap.ui.mdc.Table';
-    const TREE_TABLE_TYPE = 'sap.ui.table.TreeTable';
-    const GRID_TABLE_TYPE = 'sap.ui.table.Table';
-    const ANALYTICAL_TABLE_TYPE = 'sap.ui.table.AnalyticalTable';
     async function getActionId(table) {
         const {major, minor} = await getUi5Version();
         if (isA(SMART_TABLE_TYPE, table)) {
@@ -39,15 +42,8 @@ sap.ui.define([
             SETTINGS_ID
         ];
     }
-    class TableQuickActionDefinitionBase {
-        kind = NESTED_QUICK_ACTION_KIND;
-        get id() {
-            return `${ this.context.key }-${ this.type }`;
-        }
+    class TableQuickActionDefinitionBase extends QuickActionDefinitionBase {
         isApplicable = false;
-        get tooltip() {
-            return undefined;
-        }
         children = [];
         tableMap = {};
         get textKey() {
@@ -55,11 +51,14 @@ sap.ui.define([
         }
         constructor(type, controlTypes, defaultTextKey, context) {
             let options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
+            let enablementValidators = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : [];
+            super(type, NESTED_QUICK_ACTION_KIND, defaultTextKey, context, enablementValidators);
             this.type = type;
             this.controlTypes = controlTypes;
             this.defaultTextKey = defaultTextKey;
             this.context = context;
             this.options = options;
+            this.enablementValidators = enablementValidators;
         }
         async initialize() {
             const version = await getUi5Version();
@@ -160,20 +159,20 @@ sap.ui.define([
                         layout
                     });
                 } else if (subSections.length > 1) {
-                    const sectionChild = this.children.find(val => val.label === `${ section.getTitle() } section`);
-                    let tableMapIndex = `${ this.children.length - 1 }`;
+                    const existingChildIdx = this.children.findIndex(val => val.label === `'${ section.getTitle() }' section`);
+                    let tableMapIndex;
                     const label = this.getTableLabel(table);
                     const child = this.createChild(label, table);
-                    if (!sectionChild) {
-                        tableMapIndex = `${ tableMapIndex }/0`;
+                    if (existingChildIdx < 0) {
                         this.children.push({
                             label: `'${ section?.getTitle() }' section`,
                             enabled: true,
                             children: [child]
                         });
+                        tableMapIndex = `${ this.children.length - 1 }/0`;
                     } else {
-                        tableMapIndex = `${ tableMapIndex }/${ sectionChild.children.length - 1 }`;
-                        sectionChild.children.push(child);
+                        this.children[existingChildIdx].children.push(child);
+                        tableMapIndex = `${ existingChildIdx.toFixed(0) }/${ this.children[existingChildIdx].children.length - 1 }`;
                     }
                     this.tableMap[tableMapIndex] = {
                         table,
@@ -192,7 +191,9 @@ sap.ui.define([
                     SMART_TABLE_TYPE,
                     M_TABLE_TYPE,
                     MDC_TABLE_TYPE,
-                    TREE_TABLE_TYPE
+                    TREE_TABLE_TYPE,
+                    GRID_TABLE_TYPE,
+                    ANALYTICAL_TABLE_TYPE
                 ].some(type => isA(type, table))) {
                 const label = this.getTableLabel(table);
                 const child = this.createChild(label, table);
@@ -239,12 +240,6 @@ sap.ui.define([
         }
     }
     var __exports = { __esModule: true };
-    __exports.SMART_TABLE_TYPE = SMART_TABLE_TYPE;
-    __exports.M_TABLE_TYPE = M_TABLE_TYPE;
-    __exports.MDC_TABLE_TYPE = MDC_TABLE_TYPE;
-    __exports.TREE_TABLE_TYPE = TREE_TABLE_TYPE;
-    __exports.GRID_TABLE_TYPE = GRID_TABLE_TYPE;
-    __exports.ANALYTICAL_TABLE_TYPE = ANALYTICAL_TABLE_TYPE;
     __exports.TableQuickActionDefinitionBase = TableQuickActionDefinitionBase;
     return __exports;
 });

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

@@ -15,17 +15,21 @@ 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';
+import { EnablementValidator } from './enablement-validator';
+import { QuickActionDefinitionBase } from './quick-action-base';
+import {
+    ANALYTICAL_TABLE_TYPE,
+    GRID_TABLE_TYPE,
+    M_TABLE_TYPE,
+    MDC_TABLE_TYPE,
+    SMART_TABLE_TYPE,
+    TREE_TABLE_TYPE
+} from './control-types';
 
 const SMART_TABLE_ACTION_ID = 'CTX_COMP_VARIANT_CONTENT';
 const M_TABLE_ACTION_ID = 'CTX_ADD_ELEMENTS_AS_CHILD';
 const SETTINGS_ID = 'CTX_SETTINGS';
 const ICON_TAB_BAR_TYPE = 'sap.m.IconTabBar';
-export const SMART_TABLE_TYPE = 'sap.ui.comp.smarttable.SmartTable';
-export const M_TABLE_TYPE = 'sap.m.Table';
-export const MDC_TABLE_TYPE = 'sap.ui.mdc.Table';
-export const TREE_TABLE_TYPE = 'sap.ui.table.TreeTable';
-export const GRID_TABLE_TYPE = 'sap.ui.table.Table';
-export const ANALYTICAL_TABLE_TYPE = 'sap.ui.table.AnalyticalTable';
 
 async function getActionId(table: UI5Element): Promise<string[]> {
     const { major, minor } = await getUi5Version();
@@ -48,20 +52,11 @@ export type TableQuickActionsOptions = {
 /**
  * Base class for table quick actions.
  */
-export abstract class TableQuickActionDefinitionBase {
-    readonly kind = NESTED_QUICK_ACTION_KIND;
-    public get id(): string {
-        return `${this.context.key}-${this.type}`;
-    }
-
+export abstract class TableQuickActionDefinitionBase extends QuickActionDefinitionBase<
+    typeof NESTED_QUICK_ACTION_KIND
+> {
     public isApplicable = false;
 
-    protected isDisabled: boolean | undefined;
-
-    public get tooltip(): string | undefined {
-        return undefined;
-    }
-
     public children: NestedQuickActionChild[] = [];
     public tableMap: Record<
         string,
@@ -90,8 +85,11 @@ export abstract class TableQuickActionDefinitionBase {
         protected readonly controlTypes: string[],
         protected readonly defaultTextKey: string,
         protected readonly context: QuickActionContext,
-        protected options: TableQuickActionsOptions = {}
-    ) {}
+        protected options: TableQuickActionsOptions = {},
+        protected readonly enablementValidators: EnablementValidator[] = []
+    ) {
+        super(type, NESTED_QUICK_ACTION_KIND, defaultTextKey, context, enablementValidators);
+    }
 
     /**
      * Initializes action object instance
@@ -229,21 +227,25 @@ export abstract class TableQuickActionDefinitionBase {
             if (subSections?.length === 1) {
                 this.processTable(table, { section, subSection: subSections[0], layout });
             } else if (subSections.length > 1) {
-                const sectionChild = this.children.find((val) => val.label === `${section.getTitle()} section`);
-                let tableMapIndex = `${this.children.length - 1}`;
+                const existingChildIdx = this.children.findIndex(
+                    (val) => val.label === `'${section.getTitle()}' section`
+                );
+                let tableMapIndex;
                 const label = this.getTableLabel(table);
                 const child = this.createChild(label, table);
-                if (!sectionChild) {
-                    tableMapIndex = `${tableMapIndex}/0`;
-
+                if (existingChildIdx < 0) {
                     this.children.push({
                         label: `'${section?.getTitle()}' section`,
                         enabled: true,
                         children: [child]
                     });
+
+                    tableMapIndex = `${this.children.length - 1}/0`;
                 } else {
-                    tableMapIndex = `${tableMapIndex}/${sectionChild.children.length - 1}`;
-                    sectionChild.children.push(child);
+                    this.children[existingChildIdx].children.push(child);
+                    tableMapIndex = `${existingChildIdx.toFixed(0)}/${
+                        this.children[existingChildIdx].children.length - 1
+                    }`;
                 }
 
                 this.tableMap[tableMapIndex] = {
@@ -264,7 +266,16 @@ export abstract class TableQuickActionDefinitionBase {
         table: UI5Element,
         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))) {
+        if (
+            [
+                SMART_TABLE_TYPE,
+                M_TABLE_TYPE,
+                MDC_TABLE_TYPE,
+                TREE_TABLE_TYPE,
+                GRID_TABLE_TYPE,
+                ANALYTICAL_TABLE_TYPE
+            ].some((type) => isA(type, table))
+        ) {
             const label = this.getTableLabel(table);
             const child = this.createChild(label, table);
             this.children.push(child);