@sap-ux/preview-middleware 0.19.37 → 0.19.39

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

@@ -10,8 +10,9 @@ sap.ui.define([
     '../api-handler',
     './BaseDialog.controller',
     '../utils',
-    'sap/ui/core/library'
-], function (JSONModel, OverlayRegistry, ___sap_ux_private_control_property_editor_common, ____i18n, ____cpe_communication_service, __ControlUtils, __CommandExecutor, ___api_handler, __BaseDialog, ___utils, sap_ui_core_library) {
+    'sap/ui/core/library',
+    '../../utils/additional-change-info'
+], function (JSONModel, OverlayRegistry, ___sap_ux_private_control_property_editor_common, ____i18n, ____cpe_communication_service, __ControlUtils, __CommandExecutor, ___api_handler, __BaseDialog, ___utils, sap_ui_core_library, ____utils_additional_change_info) {
     'use strict';
     function _interopRequireDefault(obj) {
         return obj && obj.__esModule && typeof obj.default !== 'undefined' ? obj.default : obj;
@@ -26,6 +27,7 @@ sap.ui.define([
     const BaseDialog = _interopRequireDefault(__BaseDialog);
     const notifyUser = ___utils['notifyUser'];
     const ValueState = sap_ui_core_library['ValueState'];
+    const setAdditionalChangeInfoForChangeFile = ____utils_additional_change_info['setAdditionalChangeInfoForChangeFile'];
     const radix = 10;
     const COLUMNS_AGGREGATION = 'columns';
     const ITEMS_AGGREGATION = 'items';
@@ -149,7 +151,6 @@ sap.ui.define([
             const flexSettings = this.rta.getFlexSettings();
             const overlay = OverlayRegistry.getOverlay(this.runtimeControl);
             const designMetadata = overlay.getDesignTimeMetadata();
-            const result = [];
             const compositeCommand = await this.commandExecutor.createCompositeCommand(this.runtimeControl);
             for (const fragment of fragments) {
                 const modifiedValue = {
@@ -162,17 +163,11 @@ sap.ui.define([
                 const command = await this.commandExecutor.getCommand(targetObject, 'addXML', modifiedValue, designMetadata, flexSettings);
                 const templateName = fragment.targetAggregation === COLUMNS_AGGREGATION ? `V2_SMART_TABLE_COLUMN` : 'V2_SMART_TABLE_CELL';
                 const preparedChange = command.getPreparedChange();
-                const content = {
-                    ...preparedChange.getContent(),
-                    templateName
-                };
-                preparedChange.setContent(content);
+                setAdditionalChangeInfoForChangeFile(preparedChange.getDefinition().fileName, { templateName });
                 compositeCommand.addCommand(command, false);
-                result.push(templateName);
             }
             await this.commandExecutor.pushAndExecuteCommand(compositeCommand);
             CommunicationService.sendAction(setApplicationRequiresReload(true));
-            return result;
         }
     });
     return AddTableColumnFragments;

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

@@ -39,6 +39,7 @@ import Input from 'sap/m/Input';
 import Control from 'sap/ui/core/Control';
 import ManagedObject from 'sap/ui/base/ManagedObject';
 import { QuickActionTelemetryData } from '../../cpe/quick-actions/quick-action-definition';
+import { setAdditionalChangeInfoForChangeFile } from '../../utils/additional-change-info';
 
 const radix = 10;
 
@@ -60,7 +61,6 @@ interface CreateFragmentProps {
  * @namespace open.ux.preview.client.adp.controllers
  */
 export default class AddTableColumnFragments extends BaseDialog<AddTableColumnsFragmentsModel> {
-
     constructor(
         name: string,
         overlays: UI5Element,
@@ -255,7 +255,7 @@ export default class AddTableColumnFragments extends BaseDialog<AddTableColumnsF
      *
      * @param fragmentData Fragment Data
      */
-    private async createFragmentChange(fragmentData: CreateFragmentProps): Promise<string[] | undefined> {
+    private async createFragmentChange(fragmentData: CreateFragmentProps): Promise<void> {
         const { fragments, index } = fragmentData;
 
         const flexSettings = this.rta.getFlexSettings();
@@ -263,8 +263,6 @@ export default class AddTableColumnFragments extends BaseDialog<AddTableColumnsF
         const overlay = OverlayRegistry.getOverlay(this.runtimeControl as UI5Element);
         const designMetadata = overlay.getDesignTimeMetadata();
 
-        const result: string[] = [];
-
         const compositeCommand = await this.commandExecutor.createCompositeCommand(this.runtimeControl);
 
         for (const fragment of fragments) {
@@ -292,15 +290,11 @@ export default class AddTableColumnFragments extends BaseDialog<AddTableColumnsF
             const templateName =
                 fragment.targetAggregation === COLUMNS_AGGREGATION ? `V2_SMART_TABLE_COLUMN` : 'V2_SMART_TABLE_CELL';
             const preparedChange = command.getPreparedChange();
-            const content = { ...preparedChange.getContent(), templateName };
-            preparedChange.setContent(content);
+            setAdditionalChangeInfoForChangeFile(preparedChange.getDefinition().fileName, { templateName });
             compositeCommand.addCommand(command, false);
-            result.push(templateName);
         }
 
         await this.commandExecutor.pushAndExecuteCommand(compositeCommand);
         CommunicationService.sendAction(setApplicationRequiresReload(true));
-
-        return result;
     }
 }

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

@@ -1,212 +1,212 @@
-"use strict";
-
-sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/JSONModel", "../api-handler", "./BaseDialog.controller", "../utils"], function (MessageToast, sap_ui_core_library, JSONModel, ___api_handler, __BaseDialog, ___utils) {
-  "use strict";
-
-  function _interopRequireDefault(obj) {
-    return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
-  }
-  /** sap.ui.core */
-  const ValueState = sap_ui_core_library["ValueState"];
-  /** sap.ui.base */
-  const getExistingController = ___api_handler["getExistingController"];
-  const readControllers = ___api_handler["readControllers"];
-  const writeChange = ___api_handler["writeChange"];
-  const writeController = ___api_handler["writeController"];
-  const BaseDialog = _interopRequireDefault(__BaseDialog);
-  const getControllerInfo = ___utils["getControllerInfo"];
-  /**
-   * @namespace open.ux.preview.client.adp.controllers
-   */
-  const ControllerExtension = BaseDialog.extend("open.ux.preview.client.adp.controllers.ControllerExtension", {
-    constructor: function _constructor(name, overlays, rta, telemetryData) {
-      BaseDialog.prototype.constructor.call(this, name, telemetryData);
-      this.rta = rta;
-      this.overlays = overlays;
-      this.model = new JSONModel();
-    },
-    /**
-     * 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();
-      this.dialog.setModel(this.model);
-      this.dialog.open();
-    },
-    /**
-     * Handles fragment name input change
-     *
-     * @param event Event
-     */
-    onControllerNameInputChange: function _onControllerNameInputChange(event) {
-      const input = event.getSource();
-      const beginBtn = this.dialog.getBeginButton();
-      const controllerName = input.getValue();
-      const controllerList = this.model.getProperty('/controllersList');
-      const updateDialogState = function (valueState) {
-        let valueStateText = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
-        input.setValueState(valueState).setValueStateText(valueStateText);
-        beginBtn.setEnabled(valueState === ValueState.Success);
-      };
-      if (controllerName.length <= 0) {
-        updateDialogState(ValueState.None);
-        this.model.setProperty('/newControllerName', null);
-        return;
-      }
-      const fileExists = controllerList.some(f => f.controllerName === controllerName);
-      if (fileExists) {
-        updateDialogState(ValueState.Error, 'Enter a different name. The controller name that you entered already exists in your project.');
-        return;
-      }
-      const isValidName = /^[a-zA-Z_][a-zA-Z0-9_-]*$/.test(controllerName);
-      if (!isValidName) {
-        updateDialogState(ValueState.Error, 'The controller name cannot contain white spaces or special characters.');
-        return;
-      }
-      if (controllerName.length > 64) {
-        updateDialogState(ValueState.Error, 'A controller file name cannot contain more than 64 characters.');
-        return;
-      }
-      updateDialogState(ValueState.Success);
-      this.model.setProperty('/newControllerName', controllerName);
-    },
-    /**
-     * Handles create button press
-     *
-     * @param event Event
-     */
-    onCreateBtnPress: async function _onCreateBtnPress(event) {
-      const source = event.getSource();
-      await BaseDialog.prototype.onCreateBtnPressHandler.call(this);
-      const controllerExists = this.model.getProperty('/controllerExists');
-      if (!controllerExists) {
-        source.setEnabled(false);
-        const controllerName = this.model.getProperty('/newControllerName');
-        const viewId = this.model.getProperty('/viewId');
-        await this.createNewController(controllerName, viewId);
-      } else {
-        const controllerPath = this.model.getProperty('/controllerPath');
-        window.open(`vscode://file${controllerPath}`);
-      }
-      this.handleDialogClose();
-    },
-    /**
-     * Builds data that is used in the dialog.
-     */
-    buildDialogData: async function _buildDialogData() {
-      const selectorId = this.overlays.getId();
-      const overlayControl = sap.ui.getCore().byId(selectorId);
-      const {
-        controllerName,
-        viewId
-      } = getControllerInfo(overlayControl);
-      const data = await this.getExistingController(controllerName);
-      if (data) {
-        if (data?.controllerExists) {
-          this.updateModelForExistingController(data);
-        } else {
-          this.updateModelForNewController(viewId, data.isTsSupported);
-          await this.getControllers();
-        }
-      }
-    },
-    /**
-     * Updates the model properties for an existing controller.
-     *
-     * @param {CodeExtResponse} data - Existing controller data from the server.
-     */
-    updateModelForExistingController: function _updateModelForExistingController(data) {
-      const {
-        controllerExists,
-        controllerPath,
-        controllerPathFromRoot,
-        isRunningInBAS
-      } = data;
-      this.model.setProperty('/controllerExists', controllerExists);
-      this.model.setProperty('/controllerPath', controllerPath);
-      this.model.setProperty('/controllerPathFromRoot', controllerPathFromRoot);
-      const content = this.dialog.getContent();
-      const form = content[0];
-      form.setVisible(false);
-      const messageForm = content[1];
-      messageForm.setVisible(true);
-      if (isRunningInBAS) {
-        this.dialog.getBeginButton().setVisible(false);
-      } else {
-        this.dialog.getBeginButton().setText('Open in VS Code').setEnabled(true);
-      }
-      this.dialog.getEndButton().setText('Close');
-    },
-    /**
-     * Updates the model property for a new controller.
-     *
-     * @param {string} viewId - The view ID.
-     * @param {boolean} isTsSupported - Whether TypeScript supported for the current project.
-     */
-    updateModelForNewController: function _updateModelForNewController(viewId, isTsSupported) {
-      this.model.setProperty('/viewId', viewId);
-      this.model.setProperty('/controllerExtension', isTsSupported ? '.ts' : '.js');
-    },
-    /**
-     * Retrieves existing controller data if found in the project's workspace.
-     *
-     * @param controllerName Controller name that exists in the view.
-     * @returns Returns existing controller data.
-     */
-    getExistingController: async function _getExistingController(controllerName) {
-      let data;
-      try {
-        data = await getExistingController(controllerName);
-      } catch (e) {
-        this.handleError(e);
-      }
-      return data;
-    },
-    /**
-     * Retrieves controller files and fills the model with data
-     */
-    getControllers: async function _getControllers() {
-      try {
-        const {
-          controllers
-        } = await readControllers();
-        this.model.setProperty('/controllersList', controllers);
-      } catch (e) {
-        this.handleError(e);
-      }
-    },
-    /**
-     * Creates a new fragment for the specified control
-     *
-     * @param controllerName Controller Name
-     * @param viewId View Id
-     */
-    createNewController: async function _createNewController(controllerName, viewId) {
-      try {
-        await writeController({
-          controllerName
-        });
-        const controllerRef = {
-          codeRef: `coding/${controllerName}.js`,
-          viewId
-        };
-        const service = await this.rta.getService('controllerExtension');
-        const change = await service.add(controllerRef.codeRef, controllerRef.viewId);
-        change.creation = new Date().toISOString();
-        await writeChange(change);
-        MessageToast.show(`Controller extension with name '${controllerName}' was created.`);
-      } catch (e) {
-        // We want to update the model incase we have already created a controller file but failed when creating a change file,
-        // so when the user types the same controller name again he does not get 409 from the server, instead an error is shown in the UI
-        await this.getControllers();
-        this.handleError(e);
-      }
-    }
-  });
-  return ControllerExtension;
+"use strict";
+
+sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/JSONModel", "../api-handler", "./BaseDialog.controller", "../utils"], function (MessageToast, sap_ui_core_library, JSONModel, ___api_handler, __BaseDialog, ___utils) {
+  "use strict";
+
+  function _interopRequireDefault(obj) {
+    return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
+  }
+  /** sap.ui.core */
+  const ValueState = sap_ui_core_library["ValueState"];
+  /** sap.ui.base */
+  const getExistingController = ___api_handler["getExistingController"];
+  const readControllers = ___api_handler["readControllers"];
+  const writeChange = ___api_handler["writeChange"];
+  const writeController = ___api_handler["writeController"];
+  const BaseDialog = _interopRequireDefault(__BaseDialog);
+  const getControllerInfo = ___utils["getControllerInfo"];
+  /**
+   * @namespace open.ux.preview.client.adp.controllers
+   */
+  const ControllerExtension = BaseDialog.extend("open.ux.preview.client.adp.controllers.ControllerExtension", {
+    constructor: function _constructor(name, overlays, rta, telemetryData) {
+      BaseDialog.prototype.constructor.call(this, name, telemetryData);
+      this.rta = rta;
+      this.overlays = overlays;
+      this.model = new JSONModel();
+    },
+    /**
+     * 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();
+      this.dialog.setModel(this.model);
+      this.dialog.open();
+    },
+    /**
+     * Handles fragment name input change
+     *
+     * @param event Event
+     */
+    onControllerNameInputChange: function _onControllerNameInputChange(event) {
+      const input = event.getSource();
+      const beginBtn = this.dialog.getBeginButton();
+      const controllerName = input.getValue();
+      const controllerList = this.model.getProperty('/controllersList');
+      const updateDialogState = function (valueState) {
+        let valueStateText = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+        input.setValueState(valueState).setValueStateText(valueStateText);
+        beginBtn.setEnabled(valueState === ValueState.Success);
+      };
+      if (controllerName.length <= 0) {
+        updateDialogState(ValueState.None);
+        this.model.setProperty('/newControllerName', null);
+        return;
+      }
+      const fileExists = controllerList.some(f => f.controllerName === controllerName);
+      if (fileExists) {
+        updateDialogState(ValueState.Error, 'Enter a different name. The controller name that you entered already exists in your project.');
+        return;
+      }
+      const isValidName = /^[a-zA-Z_][a-zA-Z0-9_-]*$/.test(controllerName);
+      if (!isValidName) {
+        updateDialogState(ValueState.Error, 'The controller name cannot contain white spaces or special characters.');
+        return;
+      }
+      if (controllerName.length > 64) {
+        updateDialogState(ValueState.Error, 'A controller file name cannot contain more than 64 characters.');
+        return;
+      }
+      updateDialogState(ValueState.Success);
+      this.model.setProperty('/newControllerName', controllerName);
+    },
+    /**
+     * Handles create button press
+     *
+     * @param event Event
+     */
+    onCreateBtnPress: async function _onCreateBtnPress(event) {
+      const source = event.getSource();
+      await BaseDialog.prototype.onCreateBtnPressHandler.call(this);
+      const controllerExists = this.model.getProperty('/controllerExists');
+      if (!controllerExists) {
+        source.setEnabled(false);
+        const controllerName = this.model.getProperty('/newControllerName');
+        const viewId = this.model.getProperty('/viewId');
+        await this.createNewController(controllerName, viewId);
+      } else {
+        const controllerPath = this.model.getProperty('/controllerPath');
+        window.open(`vscode://file${controllerPath}`);
+      }
+      this.handleDialogClose();
+    },
+    /**
+     * Builds data that is used in the dialog.
+     */
+    buildDialogData: async function _buildDialogData() {
+      const selectorId = this.overlays.getId();
+      const overlayControl = sap.ui.getCore().byId(selectorId);
+      const {
+        controllerName,
+        viewId
+      } = getControllerInfo(overlayControl);
+      const data = await this.getExistingController(controllerName);
+      if (data) {
+        if (data?.controllerExists) {
+          this.updateModelForExistingController(data);
+        } else {
+          this.updateModelForNewController(viewId, data.isTsSupported);
+          await this.getControllers();
+        }
+      }
+    },
+    /**
+     * Updates the model properties for an existing controller.
+     *
+     * @param {CodeExtResponse} data - Existing controller data from the server.
+     */
+    updateModelForExistingController: function _updateModelForExistingController(data) {
+      const {
+        controllerExists,
+        controllerPath,
+        controllerPathFromRoot,
+        isRunningInBAS
+      } = data;
+      this.model.setProperty('/controllerExists', controllerExists);
+      this.model.setProperty('/controllerPath', controllerPath);
+      this.model.setProperty('/controllerPathFromRoot', controllerPathFromRoot);
+      const content = this.dialog.getContent();
+      const form = content[0];
+      form.setVisible(false);
+      const messageForm = content[1];
+      messageForm.setVisible(true);
+      if (isRunningInBAS) {
+        this.dialog.getBeginButton().setVisible(false);
+      } else {
+        this.dialog.getBeginButton().setText('Open in VS Code').setEnabled(true);
+      }
+      this.dialog.getEndButton().setText('Close');
+    },
+    /**
+     * Updates the model property for a new controller.
+     *
+     * @param {string} viewId - The view ID.
+     * @param {boolean} isTsSupported - Whether TypeScript supported for the current project.
+     */
+    updateModelForNewController: function _updateModelForNewController(viewId, isTsSupported) {
+      this.model.setProperty('/viewId', viewId);
+      this.model.setProperty('/controllerExtension', isTsSupported ? '.ts' : '.js');
+    },
+    /**
+     * Retrieves existing controller data if found in the project's workspace.
+     *
+     * @param controllerName Controller name that exists in the view.
+     * @returns Returns existing controller data.
+     */
+    getExistingController: async function _getExistingController(controllerName) {
+      let data;
+      try {
+        data = await getExistingController(controllerName);
+      } catch (e) {
+        this.handleError(e);
+      }
+      return data;
+    },
+    /**
+     * Retrieves controller files and fills the model with data
+     */
+    getControllers: async function _getControllers() {
+      try {
+        const {
+          controllers
+        } = await readControllers();
+        this.model.setProperty('/controllersList', controllers);
+      } catch (e) {
+        this.handleError(e);
+      }
+    },
+    /**
+     * Creates a new fragment for the specified control
+     *
+     * @param controllerName Controller Name
+     * @param viewId View Id
+     */
+    createNewController: async function _createNewController(controllerName, viewId) {
+      try {
+        await writeController({
+          controllerName
+        });
+        const controllerRef = {
+          codeRef: `coding/${controllerName}.js`,
+          viewId
+        };
+        const service = await this.rta.getService('controllerExtension');
+        const change = await service.add(controllerRef.codeRef, controllerRef.viewId);
+        change.creation = new Date().toISOString();
+        await writeChange(change);
+        MessageToast.show(`Controller extension with name '${controllerName}' was created.`);
+      } catch (e) {
+        // We want to update the model incase we have already created a controller file but failed when creating a change file,
+        // so when the user types the same controller name again he does not get 409 from the server, instead an error is shown in the UI
+        await this.getControllers();
+        this.handleError(e);
+      }
+    }
+  });
+  return ControllerExtension;
 });
 //# sourceMappingURL=ControllerExtension.controller.js.map