@sap-ux/preview-middleware 0.20.1 → 0.20.3

package/dist/client/adp/utils.ts

@@ -9,6 +9,7 @@ import FlexUtils from 'sap/ui/fl/Utils';
 import IsReuseComponentApi from 'sap/ui/rta/util/isReuseComponent';
 import { getControlById } from '../utils/core';
 import type { Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+import RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 
 import { getError } from '../utils/error';
 import { isLowerThanMinimalUi5Version, Ui5VersionInfo } from '../utils/version';
@@ -60,19 +61,66 @@ export function createDeferred<T>(): Deferred<T> {
 }
 
 /**
- * Checks if the fragment name associated with a command matches the specified fragment name.
+ * Checks for the existence of a change associated with a specific fragment name in the RTA command stack.
+ *
+ * @param {RuntimeAuthoring} rta - The RuntimeAuthoring instance to check for existing changes.
+ * @param {string} commandName - The name of the fragment to check for existing changes.
+ * @param {string} propertyPath - The path to the property as string separated by dot in the change definition to check.
+ * @param {string} propertyValue - The value to match against the specified property.
+ * @returns {Promise<boolean>} A promise that resolves to `true` if a matching change is found, otherwise `false`.
+ */
+export function checkForExistingChange(
+    rta: RuntimeAuthoring,
+    commandName: string,
+    propertyPath: string,
+    propertyValue: string
+): boolean {
+    const allCommands = rta.getCommandStack().getCommands();
+
+    return allCommands.some((command: FlexCommand) => {
+        if (typeof command.getCommands === 'function') {
+            const subCommand = command.getCommands().find((c: FlexCommand) => c?.getProperty('name') === commandName);
+
+            return subCommand && matchesChangeProperty(subCommand, propertyPath, propertyValue);
+        } else {
+            return matchesChangeProperty(command, propertyPath, propertyValue);
+        }
+    });
+}
+
+/**
+ * Retrieves the value of a nested property from an object based on a dot-separated path.
+ *
+ * @param obj - The object from which to retrieve the nested property.
+ * @param path - A dot-separated string representing the path to the desired property.
+ *               For example, "a.b.c" will attempt to access `obj.a.b.c`.
+ * @returns The value of the nested property if it exists, or `undefined` if any part of the path is invalid.
+ */
+export function getNestedProperty(obj: object, path: string): unknown {
+    return path.split('.').reduce((acc: unknown, key) => {
+        return (acc as Record<string, unknown>)?.[key];
+    }, obj);
+}
+
+/**
+ * Checks if a specific property in the command's change matches the given value.
  *
  * @param {FlexCommand} command - The command object containing the prepared change to be examined.
- * @param {string} fragmentName - The name of the fragment to match against the command's change.
- * @returns {boolean} Returns true if the command's change contains a fragment path that matches
- *                    the specified fragment name; otherwise, returns false.
+ * @param {string} propertyPath - The path to the property in the change definition to check.
+ * @param {string} propertyValue - The value to match against the specified property.
+ * @returns {boolean} Returns true if the command's change contains the specified property with the matching value; otherwise, returns false.
  */
-export function matchesFragmentName(command: FlexCommand, fragmentName: string): boolean {
+export function matchesChangeProperty(command: FlexCommand, propertyPath: string, propertyValue: string): boolean {
     if (typeof command.getPreparedChange !== 'function') {
         return false;
     }
-    const change = command.getPreparedChange().getDefinition() as unknown as FragmentChange;
-    return change.content?.fragmentPath?.includes(`${fragmentName}.fragment.xml`) || false;
+    const change = command.getPreparedChange()?.getDefinition?.();
+    if (!change) {
+        return false;
+    }
+
+    const nestedProperty = getNestedProperty(change, propertyPath);
+    return typeof nestedProperty === 'string' ? nestedProperty.includes(propertyValue) : false;
 }
 
 /**

package/dist/client/cpe/connector-service.ts

@@ -45,6 +45,7 @@ export class WorkspaceConnectorService {
             changeType?: string;
             content?: {
                 fragmentPath?: string;
+                codeRef?: string;
             };
         };
         if (

package/dist/client/cpe/context-menu-service.js

@@ -5,8 +5,9 @@ sap.ui.define([
     '../i18n',
     'sap/base/Log',
     '../utils/core',
-    '../utils/version'
-], function (___sap_ux_private_control_property_editor_common, ___adp_dialog_factory, ___i18n, Log, ___utils_core, ___utils_version) {
+    '../utils/version',
+    '../utils/application'
+], function (___sap_ux_private_control_property_editor_common, ___adp_dialog_factory, ___i18n, Log, ___utils_core, ___utils_version, ___utils_application) {
     'use strict';
     const executeContextMenuAction = ___sap_ux_private_control_property_editor_common['executeContextMenuAction'];
     const reportTelemetry = ___sap_ux_private_control_property_editor_common['reportTelemetry'];
@@ -15,6 +16,7 @@ sap.ui.define([
     const getTextBundle = ___i18n['getTextBundle'];
     const getControlById = ___utils_core['getControlById'];
     const getUi5Version = ___utils_version['getUi5Version'];
+    const getApplicationType = ___utils_application['getApplicationType'];
     class ContextMenuService {
         sendAction = () => {
         };
@@ -36,7 +38,8 @@ sap.ui.define([
                             category: 'OutlineContextMenu',
                             actionName,
                             controlName,
-                            ui5Version: `${ versionInfo.major }.${ versionInfo.minor }.${ versionInfo.patch }`
+                            ui5Version: `${ versionInfo.major }.${ versionInfo.minor }.${ versionInfo.patch }`,
+                            appType: getApplicationType(this.rta.getRootControlInstance().getManifest())
                         });
                     } catch (err) {
                         Log.error('Error in reporting Telemetry:', err);

package/dist/client/cpe/context-menu-service.ts

@@ -12,6 +12,7 @@ import { getTextBundle } from '../i18n';
 import Log from 'sap/base/Log';
 import { getControlById } from '../utils/core';
 import { getUi5Version } from '../utils/version';
+import { getApplicationType } from '../utils/application';
 
 /**
  * A Class of ContextMenuService
@@ -46,7 +47,8 @@ export class ContextMenuService {
                         category: 'OutlineContextMenu',
                         actionName,
                         controlName,
-                        ui5Version: `${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`
+                        ui5Version: `${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`,
+                        appType: getApplicationType(this.rta.getRootControlInstance().getManifest())
                     });
                 } catch (err) {
                     Log.error('Error in reporting Telemetry:', err);

package/dist/client/cpe/quick-actions/quick-action-service.js

@@ -3,8 +3,10 @@ sap.ui.define([
     'sap/base/Log',
     'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
     '../../i18n',
-    '../../adp/dialog-factory'
-], function (Log, ___sap_ux_private_control_property_editor_common, ____i18n, ____adp_dialog_factory) {
+    '../../adp/dialog-factory',
+    '../../utils/application',
+    '../../utils/version'
+], function (Log, ___sap_ux_private_control_property_editor_common, ____i18n, ____adp_dialog_factory, ____utils_application, ____utils_version) {
     'use strict';
     const executeQuickAction = ___sap_ux_private_control_property_editor_common['executeQuickAction'];
     const quickActionListChanged = ___sap_ux_private_control_property_editor_common['quickActionListChanged'];
@@ -15,6 +17,8 @@ sap.ui.define([
     const reportTelemetry = ___sap_ux_private_control_property_editor_common['reportTelemetry'];
     const getTextBundle = ____i18n['getTextBundle'];
     const DialogFactory = ____adp_dialog_factory['DialogFactory'];
+    const getApplicationType = ____utils_application['getApplicationType'];
+    const getUi5Version = ____utils_version['getUi5Version'];
     class QuickActionService {
         sendAction = () => {
         };
@@ -104,11 +108,14 @@ sap.ui.define([
         }
         async executeAction(actionInstance, payload) {
             try {
+                const versionInfo = await getUi5Version();
                 await reportTelemetry({
                     category: 'QuickAction',
                     actionName: actionInstance.type,
                     telemetryEventIdentifier: actionInstance.getTelemetryIdentifier(true),
-                    quickActionSteps: actionInstance.quickActionSteps
+                    quickActionSteps: actionInstance.quickActionSteps,
+                    appType: getApplicationType(this.rta.getRootControlInstance().getManifest()),
+                    ui5Version: `${ versionInfo.major }.${ versionInfo.minor }.${ versionInfo.patch }`
                 });
             } catch (error) {
                 Log.error('Error in reporting Telemetry:', error);

package/dist/client/cpe/quick-actions/quick-action-service.ts

@@ -23,6 +23,9 @@ import { OutlineService } from '../outline/service';
 import { getTextBundle, TextBundle } from '../../i18n';
 import { ChangeService } from '../changes';
 import { DialogFactory } from '../../adp/dialog-factory';
+import { getApplicationType } from '../../utils/application';
+import { getUi5Version } from '../../utils/version';
+
 
 /**
  * Service providing Quick Actions.
@@ -152,11 +155,14 @@ export class QuickActionService implements Service {
 
     private async executeAction(actionInstance: QuickActionDefinition, payload: QuickActionExecutionPayload) {
         try {
+            const versionInfo = await getUi5Version();
             await reportTelemetry({
                 category: 'QuickAction',
                 actionName: actionInstance.type,
                 telemetryEventIdentifier: actionInstance.getTelemetryIdentifier(true),
-                quickActionSteps: actionInstance.quickActionSteps
+                quickActionSteps: actionInstance.quickActionSteps,
+                appType: getApplicationType(this.rta.getRootControlInstance().getManifest()),
+                ui5Version: `${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`
             });
         } catch (error) {
             Log.error('Error in reporting Telemetry:', error);

package/dist/client/messagebundle.properties

@@ -39,14 +39,19 @@ ADP_ADD_SUB_PAGE_DIALOG_PAGE_TYPE_LABEL = Page Type
 ADP_ADD_SUB_PAGE_DIALOG_NAVIGATION_LABEL = Navigation
 ADP_ADD_FRAGMENT_NOTIFICATION = Note: The `{0}.fragment.xml` fragment will be created once you save the change.
 ADP_ADD_FRAGMENT_WITH_TEMPLATE_NOTIFICATION = Note: The `{0}.fragment.xml` fragment will be created once you save the changes.
+ADP_CONTROLLER_EXTENSION_EXISTS = An existing controller extension has been found. Please use the previously created extension controller.
+ADP_CONTROLLER_PENDING_CHANGE_EXISTS = A pending change for controller extension has been found. Please use the previously created extension controller after saving the change or delete the pending change.
+ADP_CREATE_CONTROLLER_EXTENSION = Note: The `{0}` controller extension will be created once you save the change.
 ADP_ADD_TWO_FRAGMENTS_WITH_TEMPLATE_NOTIFICATION = Note: The `{0}.fragment.xml` and `{1}.fragment.xml` fragments will be created once you save the changes.
 ADP_SYNC_VIEWS_MESSAGE = Synchronous views are detected for this application. Controller extensions are not supported for such views and will be disabled.
 ADP_QUICK_ACTION_DIALOG_OPEN_MESSAGE = This action is disabled because a dialog is already open.
+ADP_QUICK_ACTION_CONTROLLER_PENDING_CHANGE_EXISTS =This action is disabled because a pending change for a controller extension has been found. 
 ADP_ADD_FRAGMENT_MENU_ITEM = Add: Fragment
 ADP_ADD_FRAGMENT_MENU_ITEM_REUSE_COMPONENT = Add: Fragment (This action is disabled because the control is a reuse component)
 ADP_ADD_FRAGMENT_MENU_ITEM_UNSTABLE_ID = Add: Fragment (This action is disabled because the control or parent control has an unstable ID)
 ADP_ADD_CONTROLLER_EXTENSION_MENU_ITEM = Extend with Controller
 ADP_ADD_CONTROLLER_EXTENSION_MENU_ITEM_REUSE_COMPONENT = Extend with Controller (This action is disabled because the control is a reuse component)
+ADP_ADD_CONTROLLER_EXTENSION_MENU_ITEM_SYNC_VIEW = Extend with Controller (This action is disabled because the controls are part of a synchronous view)
 CPE_CHANGES_VISIBLE_AFTER_SAVE_AND_RELOAD_MESSAGE = Note: The change will be visible after save and reload. 
 
 TABLE_ROWS_NEEDED_TO_CREATE_CUSTOM_COLUMN=At least one table row is required to create a new custom column. Make sure the table data is loaded and try again.

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.20.1",
+  "version": "0.20.3",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -25,11 +25,11 @@
     "ejs": "3.1.10",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/adp-tooling": "0.14.1",
     "@sap-ux/btp-utils": "1.1.0",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.6.5",
-    "@sap-ux/feature-toggle": "0.3.0",
+    "@sap-ux/adp-tooling": "0.14.2",
     "@sap-ux/logger": "0.7.0",
+    "@sap-ux/feature-toggle": "0.3.0",
     "@sap-ux/project-access": "1.30.1",
     "@sap-ux/system-access": "0.6.0"
   },
@@ -49,11 +49,11 @@
     "nock": "13.4.0",
     "npm-run-all2": "6.2.0",
     "supertest": "6.3.3",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.14.0",
     "@sap-ux/axios-extension": "1.21.0",
+    "@sap-ux/i18n": "0.3.0",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.14.2",
     "@sap-ux/store": "1.1.0",
-    "@sap-ux/ui5-info": "0.11.0",
-    "@sap-ux/i18n": "0.3.0"
+    "@sap-ux/ui5-info": "0.11.0"
   },
   "peerDependencies": {
     "express": "4"