@sap-ux/preview-middleware 0.23.48 → 0.23.49

package/dist/client/adp/command-executor.js

@@ -1,67 +1,100 @@
-'use strict';
-sap.ui.define([
-    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
-    'sap/ui/rta/command/CommandFactory',
-    '../utils/error',
-    '../utils/info-center-message'
-], function (___sap_ux_private_control_property_editor_common, CommandFactory, ___utils_error, ___utils_info_center_message) {
-    'use strict';
-    const MessageBarType = ___sap_ux_private_control_property_editor_common['MessageBarType'];
-    const getError = ___utils_error['getError'];
-    const sendInfoCenterMessage = ___utils_info_center_message['sendInfoCenterMessage'];
-    class CommandExecutor {
-        constructor(rta) {
-            this.rta = rta;
-        }
-        async getCommand(runtimeControl, commandName, modifiedValue, flexSettings, designMetadata) {
-            try {
-                return await CommandFactory.getCommandFor(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings);
-            } catch (e) {
-                const error = getError(e);
-                await sendInfoCenterMessage({
-                    title: { key: 'ADP_GET_COMMAND_FAILURE_TITLE' },
-                    description: {
-                        key: 'ADP_GET_COMMAND_FAILURE_DESCRIPTION',
-                        params: [
-                            commandName,
-                            error.message
-                        ]
-                    },
-                    type: MessageBarType.error
-                });
-                error.message = `Could not get command for '${ commandName }'. ${ error.message }`;
-                throw error;
-            }
-        }
-        async createCompositeCommand(runtimeControl) {
-            try {
-                return await CommandFactory.getCommandFor(runtimeControl, 'composite');
-            } catch (e) {
-                const error = getError(e);
-                await sendInfoCenterMessage({
-                    title: { key: 'ADP_GET_COMMAND_FAILURE_TITLE' },
-                    description: {
-                        key: 'ADP_GET_COMPOSITE_COMMAND_FAILURE_DESCRIPTION',
-                        params: [error.message]
-                    },
-                    type: MessageBarType.error
-                });
-                throw error;
-            }
-        }
-        async pushAndExecuteCommand(command) {
-            try {
-                await this.rta.getCommandStack().pushAndExecute(command);
-            } catch (e) {
-                const error = getError(e);
-                await sendInfoCenterMessage({
-                    title: { key: 'ADP_RUN_COMMAND_FAILED_TITLE' },
-                    description: error.message,
-                    type: MessageBarType.error
-                });
-                throw error;
-            }
-        }
+"use strict";
+
+sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "sap/ui/rta/command/CommandFactory", "../utils/error", "../utils/info-center-message"], function (___sap_ux_private_control_property_editor_common, CommandFactory, ___utils_error, ___utils_info_center_message) {
+  "use strict";
+
+  const MessageBarType = ___sap_ux_private_control_property_editor_common["MessageBarType"];
+  const getError = ___utils_error["getError"];
+  const sendInfoCenterMessage = ___utils_info_center_message["sendInfoCenterMessage"];
+  /**
+   * Class responsible for handling rta calls
+   */
+  class CommandExecutor {
+    /**
+     *
+     * @param rta Runtime Authoring
+     */
+    constructor(rta) {
+      this.rta = rta;
     }
-    return CommandExecutor;
-});
+
+    /**
+     * Generates command based on given values
+     *
+     * @param runtimeControl Managed object
+     * @param commandName Command name
+     * @param modifiedValue Modified value/s
+     * @param flexSettings Additional flex settings
+     * @param designMetadata Design time metadata
+     */
+    async getCommand(runtimeControl, commandName, modifiedValue, flexSettings, designMetadata) {
+      try {
+        return await CommandFactory.getCommandFor(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings);
+      } catch (e) {
+        const error = getError(e);
+        await sendInfoCenterMessage({
+          title: {
+            key: 'ADP_GET_COMMAND_FAILURE_TITLE'
+          },
+          description: {
+            key: 'ADP_GET_COMMAND_FAILURE_DESCRIPTION',
+            params: [commandName, error.message]
+          },
+          type: MessageBarType.error
+        });
+        error.message = `Could not get command for '${commandName}'. ${error.message}`;
+        throw error;
+      }
+    }
+
+    /**
+     * Creates composite command without nested commands
+     *
+     * @param runtimeControl Managed object
+     */
+    async createCompositeCommand(runtimeControl) {
+      try {
+        return await CommandFactory.getCommandFor(runtimeControl, 'composite');
+      } catch (e) {
+        const error = getError(e);
+        await sendInfoCenterMessage({
+          title: {
+            key: 'ADP_GET_COMMAND_FAILURE_TITLE'
+          },
+          description: {
+            key: 'ADP_GET_COMPOSITE_COMMAND_FAILURE_DESCRIPTION',
+            params: [error.message]
+          },
+          type: MessageBarType.error
+        });
+        throw error;
+      }
+    }
+
+    /**
+     * Pushed and executes the provided command
+     *
+     * @param command Command
+     */
+    async pushAndExecuteCommand(command) {
+      try {
+        /**
+         * The change will have pending state and will only be saved to the workspace when the user clicks save icon
+         */
+        await this.rta.getCommandStack().pushAndExecute(command);
+      } catch (e) {
+        const error = getError(e);
+        await sendInfoCenterMessage({
+          title: {
+            key: 'ADP_RUN_COMMAND_FAILED_TITLE'
+          },
+          description: error.message,
+          type: MessageBarType.error
+        });
+        throw error;
+      }
+    }
+  }
+  return CommandExecutor;
+});
+//# sourceMappingURL=command-executor.js.map

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

@@ -1,106 +1,124 @@
-'use strict';
-sap.ui.define([
-    'sap/ui/model/json/JSONModel',
-    '../../i18n',
-    '../command-executor',
-    '../api-handler',
-    './BaseDialog.controller',
-    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
-    '../../cpe/communication-service',
-    '../../utils/info-center-message',
-    '../../utils/error'
-], function (JSONModel, ____i18n, __CommandExecutor, ___api_handler, __BaseDialog, ___sap_ux_private_control_property_editor_common, ____cpe_communication_service, ____utils_info_center_message, ____utils_error) {
-    'use strict';
-    function _interopRequireDefault(obj) {
-        return obj && obj.__esModule && typeof obj.default !== 'undefined' ? obj.default : obj;
-    }
-    const getResourceModel = ____i18n['getResourceModel'];
-    const CommandExecutor = _interopRequireDefault(__CommandExecutor);
-    const getFragments = ___api_handler['getFragments'];
-    const BaseDialog = _interopRequireDefault(__BaseDialog);
-    const MessageBarType = ___sap_ux_private_control_property_editor_common['MessageBarType'];
-    const setApplicationRequiresReload = ___sap_ux_private_control_property_editor_common['setApplicationRequiresReload'];
-    const CommunicationService = ____cpe_communication_service['CommunicationService'];
-    const sendInfoCenterMessage = ____utils_info_center_message['sendInfoCenterMessage'];
-    const getError = ____utils_error['getError'];
-    const AddCustomFragment = BaseDialog.extend('open.ux.preview.client.adp.controllers.AddCustomFragment', {
-        constructor: function _constructor(name, overlays, rta, options, telemetryData) {
-            BaseDialog.prototype.constructor.call(this, name, telemetryData);
-            this.options = options;
-            this.rta = rta;
-            this.overlays = overlays;
-            this.model = new JSONModel({ title: options.title });
-            this.commandExecutor = new CommandExecutor(this.rta);
-        },
-        setup: async function _setup(dialog) {
-            this.dialog = dialog;
-            this.setEscapeHandler();
-            await this.buildDialogData();
-            const resourceModel = await getResourceModel('open.ux.preview.client');
-            this.dialog.setModel(resourceModel, 'i18n');
-            this.dialog.setModel(this.model);
-            this.dialog.open();
+"use strict";
+
+sap.ui.define(["sap/ui/model/json/JSONModel", "../../i18n", "../command-executor", "../api-handler", "./BaseDialog.controller", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../../cpe/communication-service", "../../utils/info-center-message", "../../utils/error"], function (JSONModel, ____i18n, __CommandExecutor, ___api_handler, __BaseDialog, ___sap_ux_private_control_property_editor_common, ____cpe_communication_service, ____utils_info_center_message, ____utils_error) {
+  "use strict";
+
+  function _interopRequireDefault(obj) {
+    return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
+  }
+  const getResourceModel = ____i18n["getResourceModel"];
+  const CommandExecutor = _interopRequireDefault(__CommandExecutor);
+  const getFragments = ___api_handler["getFragments"];
+  const BaseDialog = _interopRequireDefault(__BaseDialog);
+  const MessageBarType = ___sap_ux_private_control_property_editor_common["MessageBarType"];
+  const setApplicationRequiresReload = ___sap_ux_private_control_property_editor_common["setApplicationRequiresReload"];
+  const CommunicationService = ____cpe_communication_service["CommunicationService"];
+  const sendInfoCenterMessage = ____utils_info_center_message["sendInfoCenterMessage"];
+  const getError = ____utils_error["getError"];
+  /**
+   * @namespace open.ux.preview.client.adp.controllers
+   */
+  const AddCustomFragment = BaseDialog.extend("open.ux.preview.client.adp.controllers.AddCustomFragment", {
+    constructor: function _constructor(name, overlays, rta, options, telemetryData) {
+      BaseDialog.prototype.constructor.call(this, name, telemetryData);
+      this.options = options;
+      this.rta = rta;
+      this.overlays = overlays;
+      this.model = new JSONModel({
+        title: options.title
+      });
+      this.commandExecutor = new CommandExecutor(this.rta);
+    },
+    /**
+     * Setups the Dialog and the JSON Model
+     *
+     * @param {Dialog} dialog - Dialog instance
+     */
+    setup: async function _setup(dialog) {
+      this.dialog = dialog;
+      this.setEscapeHandler();
+      await this.buildDialogData();
+      const resourceModel = await getResourceModel('open.ux.preview.client');
+      this.dialog.setModel(resourceModel, 'i18n');
+      this.dialog.setModel(this.model);
+      this.dialog.open();
+    },
+    /**
+     * Handles create button press
+     *
+     * @param event Event
+     */
+    onCreateBtnPress: async function _onCreateBtnPress(event) {
+      const source = event.getSource();
+      source.setEnabled(false);
+      await BaseDialog.prototype.onCreateBtnPressHandler.call(this);
+      const fragmentName = this.model.getProperty('/newFragmentName');
+      const template = `fragments.${fragmentName}`;
+      await this.createAppDescriptorChangeForV4(template);
+      CommunicationService.sendAction(setApplicationRequiresReload(true));
+      await sendInfoCenterMessage({
+        title: {
+          key: 'ADP_ADD_FRAGMENT_DIALOG_TITLE'
         },
-        onCreateBtnPress: async function _onCreateBtnPress(event) {
-            const source = event.getSource();
-            source.setEnabled(false);
-            await BaseDialog.prototype.onCreateBtnPressHandler.call(this);
-            const fragmentName = this.model.getProperty('/newFragmentName');
-            const template = `fragments.${ fragmentName }`;
-            await this.createAppDescriptorChangeForV4(template);
-            CommunicationService.sendAction(setApplicationRequiresReload(true));
-            await sendInfoCenterMessage({
-                title: { key: 'ADP_ADD_FRAGMENT_DIALOG_TITLE' },
-                description: {
-                    key: 'ADP_ADD_FRAGMENT_NOTIFICATION',
-                    params: [fragmentName]
-                },
-                type: MessageBarType.warning
-            });
-            this.handleDialogClose();
+        description: {
+          key: 'ADP_ADD_FRAGMENT_NOTIFICATION',
+          params: [fragmentName]
         },
-        buildDialogData: async function _buildDialogData() {
-            try {
-                const {fragments} = await getFragments();
-                this.model.setProperty('/fragmentList', fragments);
-            } catch (e) {
-                const error = getError(e);
-                await sendInfoCenterMessage({
-                    title: { key: 'ADP_ADD_FRAGMENT_DIALOG_TITLE' },
-                    description: error.message,
-                    type: MessageBarType.error
-                });
-                throw error;
+        type: MessageBarType.warning
+      });
+      this.handleDialogClose();
+    },
+    /**
+     * Builds data that is used in the dialog
+     */
+    buildDialogData: async function _buildDialogData() {
+      try {
+        const {
+          fragments
+        } = await getFragments();
+        this.model.setProperty('/fragmentList', fragments);
+      } catch (e) {
+        const error = getError(e);
+        await sendInfoCenterMessage({
+          title: {
+            key: 'ADP_ADD_FRAGMENT_DIALOG_TITLE'
+          },
+          description: error.message,
+          type: MessageBarType.error
+        });
+        throw error;
+      }
+    },
+    createAppDescriptorChangeForV4: async function _createAppDescriptorChangeForV(templatePath) {
+      const fragmentName = this.model.getProperty('/newFragmentName');
+      const template = `${this.options.appDescriptor?.projectId}.changes.${templatePath}`;
+      let sectionId = this.options.appDescriptor?.anchor;
+      const flexSettings = this.rta.getFlexSettings();
+      const modifiedValue = {
+        reference: this.options.appDescriptor?.projectId,
+        appComponent: this.options.appDescriptor?.appComponent,
+        changeType: 'appdescr_fe_changePageConfiguration',
+        parameters: {
+          page: this.options.appDescriptor?.pageId,
+          entityPropertyChange: {
+            propertyPath: `${this.options.propertyPath}${fragmentName}`,
+            // e.g. 'content/body/sections/test'
+            operation: 'UPSERT',
+            propertyValue: {
+              template,
+              title: 'New Custom Section',
+              position: {
+                placement: 'After',
+                anchor: `${sectionId}`
+              }
             }
-        },
-        createAppDescriptorChangeForV4: async function _createAppDescriptorChangeForV(templatePath) {
-            const fragmentName = this.model.getProperty('/newFragmentName');
-            const template = `${ this.options.appDescriptor?.projectId }.changes.${ templatePath }`;
-            let sectionId = this.options.appDescriptor?.anchor;
-            const flexSettings = this.rta.getFlexSettings();
-            const modifiedValue = {
-                reference: this.options.appDescriptor?.projectId,
-                appComponent: this.options.appDescriptor?.appComponent,
-                changeType: 'appdescr_fe_changePageConfiguration',
-                parameters: {
-                    page: this.options.appDescriptor?.pageId,
-                    entityPropertyChange: {
-                        propertyPath: `${ this.options.propertyPath }${ fragmentName }`,
-                        operation: 'UPSERT',
-                        propertyValue: {
-                            template,
-                            title: 'New Custom Section',
-                            position: {
-                                placement: 'After',
-                                anchor: `${ sectionId }`
-                            }
-                        }
-                    }
-                }
-            };
-            const command = await this.commandExecutor.getCommand(this.getRuntimeControl(), 'appDescriptor', modifiedValue, flexSettings);
-            await this.commandExecutor.pushAndExecuteCommand(command);
+          }
         }
-    });
-    return AddCustomFragment;
-});
+      };
+      const command = await this.commandExecutor.getCommand(this.getRuntimeControl(), 'appDescriptor', modifiedValue, flexSettings);
+      await this.commandExecutor.pushAndExecuteCommand(command);
+    }
+  });
+  return AddCustomFragment;
+});
+//# sourceMappingURL=AddCustomFragment.controller.js.map