@sap-ux/preview-middleware 0.13.27 → 0.13.28

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

@@ -23,6 +23,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
       this.ui5Version = sap.ui.version;
       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();
@@ -30,6 +35,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
       this.dialog.setModel(this.model);
       this.dialog.open();
     },
+    /**
+     * Handles the index field whenever a specific aggregation is chosen
+     *
+     * @param specialIndexAggregation string | number
+     */
     specialIndexHandling: function _specialIndexHandling(specialIndexAggregation) {
       const overlay = OverlayRegistry.getOverlay(this.runtimeControl);
       const aggregations = overlay.getDesignTimeMetadata().getData().aggregations;
@@ -44,6 +54,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
         this.model.setProperty('/specialIndexHandlingIconPressed', false);
       }
     },
+    /**
+     * Handles the change in aggregations
+     *
+     * @param event Event
+     */
     onAggregationChanged: function _onAggregationChanged(event) {
       const source = event.getSource();
       const selectedKey = source.getSelectedKey();
@@ -63,6 +78,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
       this.model.setProperty('/index', updatedIndexArray);
       this.model.setProperty('/selectedIndex', updatedIndexArray.length - 1);
     },
+    /**
+     * Handles create button press
+     *
+     * @param event Event
+     */
     onCreateBtnPress: async function _onCreateBtnPress(event) {
       const source = event.getSource();
       source.setEnabled(false);
@@ -78,6 +98,9 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
       notifyUser(`Note: The '${fragmentName}.fragment.xml' fragment will be created once you save the change.`, 8000);
       this.handleDialogClose();
     },
+    /**
+     * Builds data that is used in the dialog
+     */
     buildDialogData: async function _buildDialogData() {
       const selectorId = this.overlays.getId();
       let controlMetadata;
@@ -138,6 +161,12 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
       this.model.setProperty('/targetAggregation', controlAggregation);
       this.model.setProperty('/index', indexArray);
     },
+    /**
+     * Fills indexArray from selected control children
+     *
+     * @param selectedControlChildren Array of numbers
+     * @returns Array of key value pairs
+     */
     fillIndexArray: function _fillIndexArray(selectedControlChildren) {
       let indexArray = [];
       if (selectedControlChildren.length === 0) {
@@ -163,6 +192,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
       }
       return indexArray;
     },
+    /**
+     * Creates an addXML fragment command and pushes it to the command stack
+     *
+     * @param fragmentData Fragment Data
+     */
     createFragmentChange: async function _createFragmentChange(fragmentData) {
       const {
         fragmentName,

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

@@ -9,6 +9,11 @@ sap.ui.define(["sap/ui/core/library", "sap/ui/core/mvc/Controller", "../utils"],
    * @namespace open.ux.preview.client.adp.controllers
    */
   const BaseDialog = Controller.extend("open.ux.preview.client.adp.controllers.BaseDialog", {
+    /**
+     * Handles fragment name input change
+     *
+     * @param event Event
+     */
     onFragmentNameInputChange: function _onFragmentNameInputChange(event) {
       const input = event.getSource();
       const beginBtn = this.dialog.getBeginButton();
@@ -46,6 +51,12 @@ sap.ui.define(["sap/ui/core/library", "sap/ui/core/mvc/Controller", "../utils"],
       updateDialogState(ValueState.Success);
       this.model.setProperty('/newFragmentName', fragmentName);
     },
+    /**
+     * Checks for the existence of a change associated with a specific fragment name in the RTA command stack.
+     *
+     * @param {string} fragmentName - The name of the fragment to check for existing changes.
+     * @returns {Promise<boolean>} A promise that resolves to `true` if a matching change is found, otherwise `false`.
+     */
     checkForExistingChange: function _checkForExistingChange(fragmentName) {
       const allCommands = this.rta.getCommandStack().getCommands();
       return allCommands.some(command => {
@@ -57,6 +68,9 @@ sap.ui.define(["sap/ui/core/library", "sap/ui/core/mvc/Controller", "../utils"],
         }
       });
     },
+    /**
+     * Sets custom function that fires when user presses escape key.
+     */
     setEscapeHandler: function _setEscapeHandler() {
       this.dialog.setEscapeHandler(_ref => {
         let {
@@ -66,6 +80,9 @@ sap.ui.define(["sap/ui/core/library", "sap/ui/core/mvc/Controller", "../utils"],
         resolve();
       });
     },
+    /**
+     * Handles the dialog closing and destruction of it.
+     */
     handleDialogClose: function _handleDialogClose() {
       this.dialog.close();
       this.dialog.destroy();

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

@@ -25,6 +25,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
       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();
@@ -32,6 +37,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
       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();
@@ -64,6 +74,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
       updateDialogState(ValueState.Success);
       this.model.setProperty('/newControllerName', controllerName);
     },
+    /**
+     * Handles create button press
+     *
+     * @param event Event
+     */
     onCreateBtnPress: async function _onCreateBtnPress(event) {
       const source = event.getSource();
       const controllerExists = this.model.getProperty('/controllerExists');
@@ -78,6 +93,9 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
       }
       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);
@@ -98,6 +116,12 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
         await this.getControllers();
       }
     },
+    /**
+     * Gets controller name and view ID for the given overlay control.
+     *
+     * @param overlayControl The overlay control.
+     * @returns The controller name and view ID.
+     */
     getControllerInfo: function _getControllerInfo(overlayControl) {
       const control = overlayControl.getElement();
       const view = Utils.getViewForControl(control);
@@ -108,6 +132,14 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
         viewId
       };
     },
+    /**
+     * Updates the model properties for an existing controller.
+     *
+     * @param {boolean} controllerExists - Whether the controller exists.
+     * @param {string} controllerPath - The controller path.
+     * @param {string} controllerPathFromRoot - The controller path from the project root.
+     * @param {boolean} isRunningInBAS - Whether the environment is BAS or VS Code.
+     */
     updateModelForExistingController: function _updateModelForExistingController(controllerExists, controllerPath, controllerPathFromRoot, isRunningInBAS) {
       this.model.setProperty('/controllerExists', controllerExists);
       this.model.setProperty('/controllerPath', controllerPath);
@@ -124,9 +156,20 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
       }
       this.dialog.getEndButton().setText('Close');
     },
+    /**
+     * Updates the model property for a new controller.
+     *
+     * @param viewId The view ID
+     */
     updateModelForNewController: function _updateModelForNewController(viewId) {
       this.model.setProperty('/viewId', viewId);
     },
+    /**
+     * Retrieves existing controller data if found in the project's workspace.
+     *
+     * @param controllerName Controller name that exists in the view
+     * @returns Returnsexisting controller data
+     */
     getExistingController: async function _getExistingController(controllerName) {
       try {
         const data = await getExistingController(controllerName);
@@ -138,6 +181,9 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
         throw new Error(e.message);
       }
     },
+    /**
+     * Retrieves controller files and fills the model with data
+     */
     getControllers: async function _getControllers() {
       try {
         const {
@@ -151,6 +197,12 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
         throw new Error(e.message);
       }
     },
+    /**
+     * Creates a new fragment for the specified control
+     *
+     * @param controllerName Controller Name
+     * @param viewId View Id
+     */
     createNewController: async function _createNewController(controllerName, viewId) {
       try {
         const manifest = await getManifestAppdescr();

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

@@ -19,6 +19,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "../api-hand
       this.data = data;
       this.rta = rta;
     },
+    /**
+     * Setups the Dialog and the JSON Model
+     *
+     * @param {Dialog} dialog - Dialog instance
+     */
     setup: async function _setup(dialog) {
       this.dialog = dialog;
       this.setEscapeHandler();
@@ -26,6 +31,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "../api-hand
       this.dialog.setModel(this.model);
       this.dialog.open();
     },
+    /**
+     * Handles create button press
+     *
+     * @param event Event
+     */
     onCreateBtnPress: function _onCreateBtnPress(event) {
       const source = event.getSource();
       source.setEnabled(false);
@@ -34,6 +44,11 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "../api-hand
       notifyUser(`Note: The '${fragmentName}.fragment.xml' fragment will be created once you save the change.`, 8000);
       this.handleDialogClose();
     },
+    /**
+     * Handler for extension point select control
+     *
+     * @param event Select control change event
+     */
     onExtensionPointHandler: function _onExtensionPointHandler(event) {
       const source = event.getSource();
       const selectedItem = source.getSelectedItem();
@@ -43,6 +58,9 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "../api-hand
       }
       this.model.setProperty('/extensionPointName', extensionPointName);
     },
+    /**
+     * Builds data that is used in the dialog
+     */
     buildDialogData: async function _buildDialogData() {
       const name = this.data?.name;
       if (name) {
@@ -71,12 +89,25 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "../api-hand
         throw new Error(e.message);
       }
     },
+    /**
+     * Updates the Select control according to provided values
+     *
+     * @param name Extension point name
+     * @param key Selected extension point key
+     * @param list All of the extension points that are under a view
+     * @param enabled Enables the select control
+     */
     updateModel: function _updateModel(name, key, list, enabled) {
       this.model.setProperty('/extensionPointName', name);
       this.model.setProperty('/extensionPointKey', key);
       this.model.setProperty('/extensionPointList', list);
       this.model.setProperty('/extensionListEnabled', enabled);
     },
+    /**
+     * Creates add xml at extension point changes
+     *
+     * @param fragmentName Fragment name
+     */
     createExtensionPointFragmentChange: function _createExtensionPointFragmentChange(fragmentName) {
       const extensionPointName = this.model.getProperty('/extensionPointName');
       const modifiedValue = {

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.13.27",
+  "version": "0.13.28",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,7 +27,7 @@
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.5.1",
     "@sap-ux/btp-utils": "0.14.4",
-    "@sap-ux/adp-tooling": "0.9.26",
+    "@sap-ux/adp-tooling": "0.9.27",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.19",
     "@sap-ux/project-access": "1.19.14"
   },
@@ -46,7 +46,7 @@
     "@sap-ux-private/playwright": "0.0.3",
     "dotenv": "16.3.1",
     "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.8",
-    "@sap-ux/axios-extension": "1.11.9",
+    "@sap-ux/axios-extension": "1.12.0",
     "@sap-ux/store": "0.5.0",
     "@sap-ux/i18n": "0.0.6"
   },