@sap-ux/preview-middleware 0.19.29 → 0.19.31

package/dist/client/adp/control-utils.js

@@ -1,46 +1,46 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  /**
-   * Handles calling control specific functions for retrieving control data
-   */
-  class ControlUtils {
-    /**
-     * Returns ManagedObject runtime control
-     *
-     * @param overlayControl Overlay
-     * @returns {ManagedObject} Managed Object instance
-     */
-    static getRuntimeControl(overlayControl) {
-      let runtimeControl;
-      if (overlayControl.getElementInstance) {
-        runtimeControl = overlayControl.getElementInstance();
-      } else {
-        runtimeControl = overlayControl.getElement();
-      }
-      return runtimeControl;
-    }
-
-    /**
-     * Returns control aggregation names in an array
-     *
-     * @param control Managed Object runtime control
-     * @param name Aggregation name
-     * @returns Array of control aggregations
-     */
-    static getControlAggregationByName(control, name) {
-      let result = [];
-      const aggregation = (control ? control.getMetadata().getAllAggregations() : {})[name];
-      if (aggregation) {
-        // This executes a _sGetter function that can vary from control to control (_sGetter can be: getContent, getItems, etc)
-        const names = aggregation._sGetter && control[aggregation._sGetter]() || [];
-        result = Array.isArray(names) ? names : [names];
-      }
-      return result;
-    }
-  }
-  return ControlUtils;
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Handles calling control specific functions for retrieving control data
+   */
+  class ControlUtils {
+    /**
+     * Returns ManagedObject runtime control
+     *
+     * @param overlayControl Overlay
+     * @returns {ManagedObject} Managed Object instance
+     */
+    static getRuntimeControl(overlayControl) {
+      let runtimeControl;
+      if (overlayControl.getElementInstance) {
+        runtimeControl = overlayControl.getElementInstance();
+      } else {
+        runtimeControl = overlayControl.getElement();
+      }
+      return runtimeControl;
+    }
+
+    /**
+     * Returns control aggregation names in an array
+     *
+     * @param control Managed Object runtime control
+     * @param name Aggregation name
+     * @returns Array of control aggregations
+     */
+    static getControlAggregationByName(control, name) {
+      let result = [];
+      const aggregation = (control ? control.getMetadata().getAllAggregations() : {})[name];
+      if (aggregation) {
+        // This executes a _sGetter function that can vary from control to control (_sGetter can be: getContent, getItems, etc)
+        const names = aggregation._sGetter && control[aggregation._sGetter]() || [];
+        result = Array.isArray(names) ? names : [names];
+      }
+      return result;
+    }
+  }
+  return ControlUtils;
 });
 //# sourceMappingURL=control-utils.js.map

package/dist/client/adp/controllers/AddFragment.controller.js

@@ -2,36 +2,33 @@
 sap.ui.define([
     'sap/ui/model/json/JSONModel',
     'sap/ui/dt/OverlayRegistry',
-    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
     '../../i18n',
-    '../../cpe/communication-service',
     '../control-utils',
     '../command-executor',
     '../api-handler',
     './BaseDialog.controller',
     '../utils',
-    '../quick-actions/control-types'
-], function (JSONModel, OverlayRegistry, ___sap_ux_private_control_property_editor_common, ____i18n, ____cpe_communication_service, __ControlUtils, __CommandExecutor, ___api_handler, __BaseDialog, ___utils, ___quick_actions_control_types) {
+    '../../cpe/additional-change-info/add-xml-additional-info',
+    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
+    '../../cpe/communication-service'
+], function (JSONModel, OverlayRegistry, ____i18n, __ControlUtils, __CommandExecutor, ___api_handler, __BaseDialog, ___utils, ____cpe_additional_change_info_add_xml_additional_info, ___sap_ux_private_control_property_editor_common, ____cpe_communication_service) {
     'use strict';
     function _interopRequireDefault(obj) {
         return obj && obj.__esModule && typeof obj.default !== 'undefined' ? obj.default : obj;
     }
-    const setApplicationRequiresReload = ___sap_ux_private_control_property_editor_common['setApplicationRequiresReload'];
     const getResourceModel = ____i18n['getResourceModel'];
     const getTextBundle = ____i18n['getTextBundle'];
-    const CommunicationService = ____cpe_communication_service['CommunicationService'];
     const ControlUtils = _interopRequireDefault(__ControlUtils);
     const CommandExecutor = _interopRequireDefault(__CommandExecutor);
     const getFragments = ___api_handler['getFragments'];
     const BaseDialog = _interopRequireDefault(__BaseDialog);
     const notifyUser = ___utils['notifyUser'];
-    const ANALYTICAL_TABLE_TYPE = ___quick_actions_control_types['ANALYTICAL_TABLE_TYPE'];
-    const GRID_TABLE_TYPE = ___quick_actions_control_types['GRID_TABLE_TYPE'];
-    const MDC_TABLE_TYPE = ___quick_actions_control_types['MDC_TABLE_TYPE'];
-    const TREE_TABLE_TYPE = ___quick_actions_control_types['TREE_TABLE_TYPE'];
+    const getFragmentTemplateName = ____cpe_additional_change_info_add_xml_additional_info['getFragmentTemplateName'];
+    const setApplicationRequiresReload = ___sap_ux_private_control_property_editor_common['setApplicationRequiresReload'];
+    const CommunicationService = ____cpe_communication_service['CommunicationService'];
     const radix = 10;
     const AddFragment = BaseDialog.extend('open.ux.preview.client.adp.controllers.AddFragment', {
-        constructor: function _constructor(name, overlays, rta, options, telemetryData) {
+        constructor: function _constructor(name, overlays, rta, options, data, telemetryData) {
             BaseDialog.prototype.constructor.call(this, name, telemetryData);
             this.options = options;
             this.rta = rta;
@@ -41,6 +38,7 @@ sap.ui.define([
                 completeView: options.aggregation === undefined
             });
             this.commandExecutor = new CommandExecutor(this.rta);
+            this.data = data;
         },
         setup: async function _setup(dialog) {
             this.dialog = dialog;
@@ -76,16 +74,24 @@ sap.ui.define([
             await BaseDialog.prototype.onCreateBtnPressHandler.call(this);
             const fragmentName = this.model.getProperty('/newFragmentName');
             const index = this.model.getProperty('/selectedIndex');
-            const targetAggregation = this.model.getProperty('/selectedAggregation/value');
-            const fragmentData = {
-                index,
-                fragmentName,
-                targetAggregation
+            const targetAggregation = this.model.getProperty('/selectedAggregation/value') ?? 'content';
+            const modifiedValue = {
+                fragment: `<core:FragmentDefinition xmlns:core='sap.ui.core'></core:FragmentDefinition>`,
+                fragmentPath: `fragments/${ fragmentName }.fragment.xml`,
+                index: index ?? 0,
+                targetAggregation: targetAggregation ?? 'content'
             };
-            const templateName = await this.createFragmentChange(fragmentData);
-            const textKey = templateName ? 'ADP_ADD_FRAGMENT_WITH_TEMPLATE_NOTIFICATION' : 'ADP_ADD_FRAGMENT_NOTIFICATION';
+            if (this.data) {
+                this.data.deferred.resolve(modifiedValue);
+            } else {
+                await this.createFragmentChange(modifiedValue);
+            }
+            const templateName = getFragmentTemplateName(this.runtimeControl.getId(), targetAggregation);
+            if (templateName) {
+                CommunicationService.sendAction(setApplicationRequiresReload(true));
+            }
             const bundle = await getTextBundle();
-            notifyUser(bundle.getText(textKey, [fragmentName]), 8000);
+            notifyUser(bundle.getText('ADP_ADD_FRAGMENT_NOTIFICATION', [fragmentName]), 8000);
             this.handleDialogClose();
         },
         buildDialogData: async function _buildDialogData() {
@@ -133,78 +139,12 @@ sap.ui.define([
                 this.model.setProperty('/selectedIndex', indexArray.length - 1 > 0 ? defaultIndex : 0);
             }
         },
-        createFragmentChange: async function _createFragmentChange(fragmentData) {
-            const {fragmentName, index, targetAggregation} = fragmentData;
+        createFragmentChange: async function _createFragmentChange(modifiedValue) {
             const flexSettings = this.rta.getFlexSettings();
             const overlay = OverlayRegistry.getOverlay(this.runtimeControl);
             const designMetadata = overlay.getDesignTimeMetadata();
-            const modifiedValue = {
-                fragment: `<core:FragmentDefinition xmlns:core='sap.ui.core'></core:FragmentDefinition>`,
-                fragmentPath: `fragments/${ fragmentName }.fragment.xml`,
-                index: index ?? 0,
-                targetAggregation: targetAggregation ?? 'content'
-            };
             const command = await this.commandExecutor.getCommand(this.runtimeControl, 'addXML', modifiedValue, designMetadata, flexSettings);
-            const templateName = this.getFragmentTemplateName(modifiedValue.targetAggregation);
-            if (templateName) {
-                const preparedChange = command.getPreparedChange();
-                const content = preparedChange.getContent();
-                preparedChange.setContent({
-                    ...content,
-                    templateName
-                });
-                CommunicationService.sendAction(setApplicationRequiresReload(true));
-            }
             await this.commandExecutor.pushAndExecuteCommand(command);
-            return templateName;
-        },
-        getFragmentTemplateName: function _getFragmentTemplateName(targetAggregation) {
-            const currentControlName = this.runtimeControl.getMetadata().getName();
-            if (currentControlName === 'sap.uxap.ObjectPageLayout' && targetAggregation === 'sections') {
-                return 'OBJECT_PAGE_CUSTOM_SECTION';
-            } else if (this.isCustomAction(currentControlName, targetAggregation)) {
-                return 'CUSTOM_ACTION';
-            } else if (this.isObjectPageHeaderField(currentControlName, targetAggregation)) {
-                return 'OBJECT_PAGE_HEADER_FIELD';
-            } else if (targetAggregation === 'columns') {
-                switch (currentControlName) {
-                case MDC_TABLE_TYPE:
-                    return 'V4_MDC_TABLE_COLUMN';
-                case TREE_TABLE_TYPE:
-                case GRID_TABLE_TYPE:
-                    return 'GRID_TREE_TABLE_COLUMN';
-                case ANALYTICAL_TABLE_TYPE:
-                    return 'ANALYTICAL_TABLE_COLUMN';
-                default:
-                    return '';
-                }
-            } else if (currentControlName === 'sap.ui.mdc.Table' && targetAggregation === 'actions') {
-                return 'TABLE_ACTION';
-            }
-            return '';
-        },
-        isCustomAction: function _isCustomAction(currentControlName, targetAggregation) {
-            if ([
-                    'sap.f.DynamicPageTitle',
-                    'sap.uxap.ObjectPageHeader',
-                    'sap.uxap.ObjectPageDynamicHeaderTitle'
-                ].includes(currentControlName)) {
-                return targetAggregation === 'actions';
-            } else if (currentControlName === 'sap.m.OverflowToolbar' || currentControlName === 'sap.m.Toolbar') {
-                return targetAggregation === 'content';
-            }
-            return false;
-        },
-        isObjectPageHeaderField: function _isObjectPageHeaderField(currentControlName, targetAggregation) {
-            if (currentControlName === 'sap.uxap.ObjectPageLayout') {
-                return targetAggregation === 'headerContent';
-            } else if (currentControlName === 'sap.m.FlexBox') {
-                const parentName = this.runtimeControl.getParent()?.getMetadata().getName();
-                if (parentName === 'sap.uxap.ObjectPageDynamicHeaderContent' || parentName === 'sap.uxap.ObjectPageLayout') {
-                    return targetAggregation === 'items';
-                }
-            }
-            return false;
         }
     });
     return AddFragment;

package/dist/client/adp/controllers/AddFragment.controller.ts

@@ -21,29 +21,18 @@ import OverlayRegistry from 'sap/ui/dt/OverlayRegistry';
 /** sap.ui.fl */
 import { type AddFragmentChangeContentType } from 'sap/ui/fl/Change';
 
-import { setApplicationRequiresReload } from '@sap-ux-private/control-property-editor-common';
-
 import { getResourceModel, getTextBundle } from '../../i18n';
-import { CommunicationService } from '../../cpe/communication-service';
 
 import ControlUtils from '../control-utils';
 import CommandExecutor from '../command-executor';
 import { getFragments } from '../api-handler';
 import BaseDialog from './BaseDialog.controller';
 import { notifyUser } from '../utils';
-import {
-    ANALYTICAL_TABLE_TYPE,
-    GRID_TABLE_TYPE,
-    MDC_TABLE_TYPE,
-    TREE_TABLE_TYPE
-} from '../quick-actions/control-types';
 import { QuickActionTelemetryData } from '../../cpe/quick-actions/quick-action-definition';
-
-interface CreateFragmentProps {
-    fragmentName: string;
-    index: string | number;
-    targetAggregation: string;
-}
+import { getFragmentTemplateName } from '../../cpe/additional-change-info/add-xml-additional-info';
+import type { AddFragmentData, DeferredXmlFragmentData } from '../add-fragment';
+import { setApplicationRequiresReload } from '@sap-ux-private/control-property-editor-common';
+import { CommunicationService } from '../../cpe/communication-service';
 
 const radix = 10;
 
@@ -65,11 +54,14 @@ export interface AddFragmentOptions {
  * @namespace open.ux.preview.client.adp.controllers
  */
 export default class AddFragment extends BaseDialog<AddFragmentModel> {
+    private readonly data?: AddFragmentData;
+
     constructor(
         name: string,
         overlays: UI5Element,
         rta: RuntimeAuthoring,
         readonly options: AddFragmentOptions,
+        data?: AddFragmentData,
         telemetryData?: QuickActionTelemetryData
     ) {
         super(name, telemetryData);
@@ -80,6 +72,7 @@ export default class AddFragment extends BaseDialog<AddFragmentModel> {
             completeView: options.aggregation === undefined
         });
         this.commandExecutor = new CommandExecutor(this.rta);
+        this.data = data;
     }
 
     /**
@@ -149,18 +142,28 @@ export default class AddFragment extends BaseDialog<AddFragmentModel> {
 
         const fragmentName = this.model.getProperty('/newFragmentName');
         const index = this.model.getProperty('/selectedIndex');
-        const targetAggregation = this.model.getProperty('/selectedAggregation/value');
-        const fragmentData = {
-            index,
-            fragmentName,
-            targetAggregation
+        const targetAggregation = this.model.getProperty('/selectedAggregation/value') ?? 'content';
+
+        const modifiedValue = {
+            fragment: `<core:FragmentDefinition xmlns:core='sap.ui.core'></core:FragmentDefinition>`,
+            fragmentPath: `fragments/${fragmentName}.fragment.xml`,
+            index: index ?? 0,
+            targetAggregation: targetAggregation ?? 'content'
         };
 
-        const templateName = await this.createFragmentChange(fragmentData);
+        if (this.data) {
+            this.data.deferred.resolve(modifiedValue);
+        } else {
+            await this.createFragmentChange(modifiedValue);
+        }
+
+        const templateName = getFragmentTemplateName(this.runtimeControl.getId(), targetAggregation);
+        if (templateName) {
+            CommunicationService.sendAction(setApplicationRequiresReload(true));
+        }
 
-        const textKey = templateName ? 'ADP_ADD_FRAGMENT_WITH_TEMPLATE_NOTIFICATION' : 'ADP_ADD_FRAGMENT_NOTIFICATION';
         const bundle = await getTextBundle();
-        notifyUser(bundle.getText(textKey, [fragmentName]), 8000);
+        notifyUser(bundle.getText('ADP_ADD_FRAGMENT_NOTIFICATION', [fragmentName]), 8000);
 
         this.handleDialogClose();
     }
@@ -227,23 +230,15 @@ export default class AddFragment extends BaseDialog<AddFragmentModel> {
     /**
      * Creates an addXML fragment command and pushes it to the command stack
      *
-     * @param fragmentData Fragment Data
+     * @param modifiedValue - modified value
+     * @param templateName - fragment template name
      */
-    private async createFragmentChange(fragmentData: CreateFragmentProps): Promise<string | undefined> {
-        const { fragmentName, index, targetAggregation } = fragmentData;
-
+    private async createFragmentChange(modifiedValue: DeferredXmlFragmentData): Promise<void> {
         const flexSettings = this.rta.getFlexSettings();
 
         const overlay = OverlayRegistry.getOverlay(this.runtimeControl as UI5Element);
         const designMetadata = overlay.getDesignTimeMetadata();
 
-        const modifiedValue = {
-            fragment: `<core:FragmentDefinition xmlns:core='sap.ui.core'></core:FragmentDefinition>`,
-            fragmentPath: `fragments/${fragmentName}.fragment.xml`,
-            index: index ?? 0,
-            targetAggregation: targetAggregation ?? 'content'
-        };
-
         const command = await this.commandExecutor.getCommand<AddFragmentChangeContentType>(
             this.runtimeControl,
             'addXML',
@@ -252,85 +247,6 @@ export default class AddFragment extends BaseDialog<AddFragmentModel> {
             flexSettings
         );
 
-        const templateName = this.getFragmentTemplateName(modifiedValue.targetAggregation);
-        if (templateName) {
-            const preparedChange = command.getPreparedChange();
-            const content = preparedChange.getContent();
-            preparedChange.setContent({ ...content, templateName });
-            CommunicationService.sendAction(setApplicationRequiresReload(true));
-        }
         await this.commandExecutor.pushAndExecuteCommand(command);
-        return templateName;
-    }
-
-    /**
-     * Determines fragment template name based on current control name and provided target aggregation
-     * @param targetAggregation - target aggregation name
-     * @returns fragment template name or empty string
-     */
-    private getFragmentTemplateName(targetAggregation: string): string {
-        const currentControlName = this.runtimeControl.getMetadata().getName();
-        if (currentControlName === 'sap.uxap.ObjectPageLayout' && targetAggregation === 'sections') {
-            return 'OBJECT_PAGE_CUSTOM_SECTION';
-        } else if (this.isCustomAction(currentControlName, targetAggregation)) {
-            return 'CUSTOM_ACTION';
-        } else if (this.isObjectPageHeaderField(currentControlName, targetAggregation)) {
-            return 'OBJECT_PAGE_HEADER_FIELD';
-        } else if (targetAggregation === 'columns') {
-            switch (currentControlName) {
-                case MDC_TABLE_TYPE:
-                    return 'V4_MDC_TABLE_COLUMN';
-                case TREE_TABLE_TYPE:
-                case GRID_TABLE_TYPE:
-                    return 'GRID_TREE_TABLE_COLUMN';
-                case ANALYTICAL_TABLE_TYPE:
-                    return 'ANALYTICAL_TABLE_COLUMN';
-                default:
-                    return '';
-            }
-        } else if (currentControlName === 'sap.ui.mdc.Table' && targetAggregation === 'actions') {
-            return 'TABLE_ACTION';
-        }
-        return '';
-    }
-
-    /**
-     * Determines conditions for custom action fragment creation
-     * @param currentControlName - current control name
-     * @param targetAggregation - target aggregation name
-     * @returns true if control and aggregation combination allows to create custom action fragment
-     */
-    private isCustomAction(currentControlName: string, targetAggregation: string): boolean {
-        if (
-            ['sap.f.DynamicPageTitle', 'sap.uxap.ObjectPageHeader', 'sap.uxap.ObjectPageDynamicHeaderTitle'].includes(
-                currentControlName
-            )
-        ) {
-            return targetAggregation === 'actions';
-        } else if (currentControlName === 'sap.m.OverflowToolbar' || currentControlName === 'sap.m.Toolbar') {
-            return targetAggregation === 'content';
-        }
-        return false;
-    }
-
-    /**
-     * Determines conditions for object page header field fragment creation
-     * @param currentControlName - current control name
-     * @param targetAggregation - target aggregation name
-     * @returns true if conditions allow to create object page header field fragment
-     */
-    private isObjectPageHeaderField(currentControlName: string, targetAggregation: string): boolean {
-        if (currentControlName === 'sap.uxap.ObjectPageLayout') {
-            return targetAggregation === 'headerContent';
-        } else if (currentControlName === 'sap.m.FlexBox') {
-            const parentName = this.runtimeControl.getParent()?.getMetadata().getName();
-            if (
-                parentName === 'sap.uxap.ObjectPageDynamicHeaderContent' ||
-                parentName === 'sap.uxap.ObjectPageLayout'
-            ) {
-                return targetAggregation === 'items';
-            }
-        }
-        return false;
     }
 }