@sap-ux/preview-middleware 0.11.3 → 0.11.5

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

@@ -29,6 +29,20 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
       this.getView()?.setModel(this.model);
       this.dialog.open();
     },
+    specialIndexHandling: function _specialIndexHandling(specialIndexAggregation) {
+      const overlay = OverlayRegistry.getOverlay(this.runtimeControl);
+      const aggregations = overlay.getDesignTimeMetadata().getData().aggregations;
+      if (specialIndexAggregation in aggregations && 'specialIndexHandling' in aggregations[specialIndexAggregation]) {
+        const controlType = this.runtimeControl.getMetadata().getName();
+        this.model.setProperty('/indexHandlingFlag', false);
+        this.model.setProperty('/specialIndexHandlingIcon', true);
+        this.model.setProperty('/iconTooltip', `Index is defined by special logic of ${controlType} and can't be set here`);
+      } else {
+        this.model.setProperty('/indexHandlingFlag', true);
+        this.model.setProperty('/specialIndexHandlingIcon', false);
+        this.model.setProperty('/specialIndexHandlingIconPressed', false);
+      }
+    },
     onAggregationChanged: function _onAggregationChanged(event) {
       const source = event.getSource();
       const selectedKey = source.getSelectedKey();
@@ -43,6 +57,7 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
       newSelectedControlChildren = newSelectedControlChildren.map(key => {
         return parseInt(key);
       });
+      this.specialIndexHandling(selectedItemText);
       const updatedIndexArray = this.fillIndexArray(newSelectedControlChildren);
       this.model.setProperty('/index', updatedIndexArray);
       this.model.setProperty('/selectedIndex', updatedIndexArray.length - 1);
@@ -105,11 +120,13 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/model/json/JSONModel", "sap/ui/dt/O
             obj.key = 'default';
             this.model.setProperty('/selectedAggregation/key', obj.key);
             this.model.setProperty('/selectedAggregation/value', obj.value);
+            this.specialIndexHandling(obj.value);
           }
         });
       } else {
         this.model.setProperty('/selectedAggregation/key', controlAggregation[0].key);
         this.model.setProperty('/selectedAggregation/value', controlAggregation[0].value);
+        this.specialIndexHandling(controlAggregation[0].value);
       }
       try {
         const {

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

@@ -59,6 +59,28 @@ export default class AddFragment extends BaseDialog {
         this.dialog.open();
     }
 
+    /**
+    * Handles the index field whenever a specific aggregation is chosen
+    * 
+    * @param specialIndexAggregation string | number
+    */
+    private specialIndexHandling(specialIndexAggregation: string | number): void {
+        const overlay = OverlayRegistry.getOverlay(this.runtimeControl as UI5Element);
+        const aggregations = overlay.getDesignTimeMetadata().getData().aggregations;
+
+        if(specialIndexAggregation in aggregations && 'specialIndexHandling' in aggregations[specialIndexAggregation]) {
+            const controlType = this.runtimeControl.getMetadata().getName();
+            this.model.setProperty('/indexHandlingFlag', false);
+            this.model.setProperty('/specialIndexHandlingIcon', true);
+            this.model.setProperty('/iconTooltip', `Index is defined by special logic of ${controlType} and can't be set here`);
+            
+        } else {
+            this.model.setProperty('/indexHandlingFlag', true);
+            this.model.setProperty('/specialIndexHandlingIcon', false);
+            this.model.setProperty('/specialIndexHandlingIconPressed', false);
+        }
+    }
+
     /**
      * Handles the change in aggregations
      *
@@ -85,6 +107,8 @@ export default class AddFragment extends BaseDialog {
         newSelectedControlChildren = newSelectedControlChildren.map((key) => {
             return parseInt(key);
         });
+        
+        this.specialIndexHandling(selectedItemText);
 
         const updatedIndexArray: { key: number; value: number }[] = this.fillIndexArray(newSelectedControlChildren);
 
@@ -178,11 +202,13 @@ export default class AddFragment extends BaseDialog {
                     obj.key = 'default';
                     this.model.setProperty('/selectedAggregation/key', obj.key);
                     this.model.setProperty('/selectedAggregation/value', obj.value);
+                    this.specialIndexHandling(obj.value);
                 }
             });
         } else {
             this.model.setProperty('/selectedAggregation/key', controlAggregation[0].key);
             this.model.setProperty('/selectedAggregation/value', controlAggregation[0].value);
+            this.specialIndexHandling(controlAggregation[0].value);
         }
 
         try {

package/dist/client/adp/ui/AddFragment.view.xml

@@ -23,14 +23,23 @@
                             <core:Item key="{key}" text="{value}" />
                         </ComboBox>
                         <Label text="Index" />
-                        <ComboBox
-                            selectedKey='{/selectedIndex}'
-                            items="{
-                                path: '/index',
-                                sorter: { path: 'text' }
-                            }">
-                            <core:Item key="{key}" text="{value}" />
-                        </ComboBox>
+                        <HBox alignItems="Center">
+                            <ComboBox
+                                enabled="{/indexHandlingFlag}"
+                                selectedKey='{/selectedIndex}'
+                                items="{
+                                    path: '/index',
+                                    sorter: { path: 'text' }
+                                }">
+                                <core:Item key="{key}" text="{value}" />
+                            </ComboBox>
+                            <core:Icon
+                                useIconTooltip="false"
+                                visible="{/specialIndexHandlingIcon}" 
+                                src="sap-icon://message-information" 
+                                class= "sapUiTinyMarginBegin" 
+                                tooltip="{/iconTooltip}" />
+                        </HBox>
                         <Label text="Fragment Name" />
                         <Input 
                             description=".fragment.xml" 

package/dist/client/cpe/changes/service.js

@@ -142,10 +142,16 @@ sap.ui.define([
                         if (typeof command.getCommands === 'function') {
                             const subCommands = command.getCommands();
                             subCommands.forEach(command => {
-                                activeChanges.push(this.prepareChangeType(command, inactiveCommandCount, i));
+                                const pendingChange = this.prepareChangeType(command, inactiveCommandCount, i);
+                                if (pendingChange) {
+                                    activeChanges.push(pendingChange);
+                                }
                             });
                         } else {
-                            activeChanges.push(this.prepareChangeType(command, inactiveCommandCount, i));
+                            const pendingChange = this.prepareChangeType(command, inactiveCommandCount, i);
+                            if (pendingChange) {
+                                activeChanges.push(pendingChange);
+                            }
                         }
                     } catch (error) {
                         Log.error('CPE: Change creation Failed', error);
@@ -161,8 +167,11 @@ sap.ui.define([
         prepareChangeType(command, inactiveCommandCount, index) {
             let result;
             let value = '';
-            const selector = command.getSelector();
-            const changeType = command.getChangeType();
+            const selectorId = this.getCommandSelectorId(command);
+            const changeType = this.getCommandChangeType(command);
+            if (!selectorId || !changeType) {
+                return undefined;
+            }
             switch (changeType) {
             case 'propertyChange':
                 value = command.getProperty('newValue');
@@ -175,7 +184,7 @@ sap.ui.define([
                 result = {
                     type: 'pending',
                     changeType,
-                    controlId: selector.id,
+                    controlId: selectorId,
                     propertyName: command.getProperty('propertyName'),
                     isActive: index >= inactiveCommandCount,
                     value,
@@ -184,7 +193,7 @@ sap.ui.define([
             } else {
                 result = {
                     type: 'pending',
-                    controlId: selector.id,
+                    controlId: selectorId,
                     changeType,
                     isActive: index >= inactiveCommandCount,
                     controlName: command.getElement().getMetadata().getName().split('.').pop() ?? ''
@@ -192,6 +201,29 @@ sap.ui.define([
             }
             return result;
         }
+        retryOperations(operations) {
+            for (const operation of operations) {
+                try {
+                    return operation();
+                } catch (error) {
+                    Log.error(`Retry operation failed: ${ error?.message }`);
+                    continue;
+                }
+            }
+            return undefined;
+        }
+        getCommandChangeType(command) {
+            return this.retryOperations([
+                () => command.getChangeType(),
+                () => command.getPreparedChange().getDefinition().changeType
+            ]);
+        }
+        getCommandSelectorId(command) {
+            return this.retryOperations([
+                () => command.getSelector().id,
+                () => command.getElement().getProperty('persistencyKey')
+            ]);
+        }
     }
     var __exports = { __esModule: true };
     __exports.ChangeService = ChangeService;

package/dist/client/cpe/changes/service.ts

@@ -16,7 +16,7 @@ import type { SelectionService } from '../selection';
 
 import type { ActionSenderFunction, SubscribeFunction, UI5AdaptationOptions } from '../types';
 import type Event from 'sap/ui/base/Event';
-import type BaseCommand from 'sap/ui/rta/command/BaseCommand';
+import type FlexCommand from 'sap/ui/rta/command/FlexCommand';
 import Log from 'sap/base/Log';
 
 interface ChangeContent {
@@ -247,15 +247,21 @@ export class ChangeService {
             const executedCommands = stack.getAllExecutedCommands();
             const inactiveCommandCount = allCommands.length - executedCommands.length;
             let activeChanges: PendingChange[] = [];
-            allCommands.forEach((command: BaseCommand, i): void => {
+            allCommands.forEach((command: FlexCommand, i): void => {
                 try {
                     if (typeof command.getCommands === 'function') {
                         const subCommands = command.getCommands();
                         subCommands.forEach((command) => {
-                            activeChanges.push(this.prepareChangeType(command, inactiveCommandCount, i));
+                            const pendingChange = this.prepareChangeType(command, inactiveCommandCount, i);
+                            if (pendingChange) {
+                                activeChanges.push(pendingChange);
+                            }
                         });
                     } else {
-                        activeChanges.push(this.prepareChangeType(command, inactiveCommandCount, i));
+                        const pendingChange = this.prepareChangeType(command, inactiveCommandCount, i);
+                        if (pendingChange) {
+                            activeChanges.push(pendingChange);
+                        }
                     }
                 } catch (error) {
                     Log.error('CPE: Change creation Failed', error);
@@ -272,11 +278,20 @@ export class ChangeService {
         };
     }
 
-    private prepareChangeType(command: BaseCommand, inactiveCommandCount: number, index: number): PendingChange {
+    private prepareChangeType(
+        command: FlexCommand,
+        inactiveCommandCount: number,
+        index: number
+    ): PendingChange | undefined {
         let result: PendingChange;
         let value = '';
-        const selector = command.getSelector();
-        const changeType = command.getChangeType();
+        const selectorId = this.getCommandSelectorId(command);
+        const changeType = this.getCommandChangeType(command);
+
+        if (!selectorId || !changeType) {
+            return undefined;
+        }
+
         switch (changeType) {
             case 'propertyChange':
                 value = command.getProperty('newValue');
@@ -289,7 +304,7 @@ export class ChangeService {
             result = {
                 type: 'pending',
                 changeType,
-                controlId: selector.id,
+                controlId: selectorId,
                 propertyName: command.getProperty('propertyName'),
                 isActive: index >= inactiveCommandCount,
                 value,
@@ -298,7 +313,7 @@ export class ChangeService {
         } else {
             result = {
                 type: 'pending',
-                controlId: selector.id,
+                controlId: selectorId,
                 changeType,
                 isActive: index >= inactiveCommandCount,
                 controlName: command.getElement().getMetadata().getName().split('.').pop() ?? ''
@@ -307,4 +322,48 @@ export class ChangeService {
 
         return result;
     }
+
+    /**
+     * Retry operations.
+     *
+     * @param operations to be executed
+     * @returns first successfull operation result or undefined
+     */
+    private retryOperations<T>(operations: Array<() => T>): T | undefined {
+        for (const operation of operations) {
+            try {
+                return operation();
+            } catch (error) {
+                Log.error(`Retry operation failed: ${error?.message}`);
+                continue;
+            }
+        }
+        return undefined;
+    }
+
+    /**
+     * Get command change type.
+     *
+     * @param command to be executed for creating change
+     * @returns command change type or undefined
+     */
+    private getCommandChangeType(command: FlexCommand): string | undefined {
+        return this.retryOperations([
+            () => command.getChangeType(),
+            () => command.getPreparedChange().getDefinition().changeType
+        ]);
+    }
+
+    /**
+     * Get command selector id.
+     *
+     * @param command to be executed for creating change
+     * @returns command selector id or undefined
+     */
+    private getCommandSelectorId(command: FlexCommand): string | undefined {
+        return this.retryOperations([
+            () => command.getSelector().id,
+            () => command.getElement().getProperty('persistencyKey')
+        ]);
+    }
 }

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.11.3",
+  "version": "0.11.5",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -23,9 +23,9 @@
   ],
   "dependencies": {
     "ejs": "3.1.9",
-    "@sap-ux/logger": "0.4.0",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.3",
     "@sap-ux/adp-tooling": "0.7.1",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.2"
+    "@sap-ux/logger": "0.4.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -36,7 +36,7 @@
     "npm-run-all": "4.1.5",
     "nock": "13.2.1",
     "supertest": "6.3.3",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.8.1",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.8.3",
     "@sap-ux/project-access": "1.15.5",
     "@sap-ux/store": "0.4.0"
   },