@sap-ux/preview-middleware 0.20.0 → 0.20.2

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/additional-change-info/add-xml-additional-info.js

@@ -1,77 +1,77 @@
-"use strict";
-
-sap.ui.define(["../../utils/core", "../../adp/quick-actions/control-types"], function (____utils_core, ____adp_quick_actions_control_types) {
-  "use strict";
-
-  const getControlById = ____utils_core["getControlById"];
-  const ANALYTICAL_TABLE_TYPE = ____adp_quick_actions_control_types["ANALYTICAL_TABLE_TYPE"];
-  const GRID_TABLE_TYPE = ____adp_quick_actions_control_types["GRID_TABLE_TYPE"];
-  const MDC_TABLE_TYPE = ____adp_quick_actions_control_types["MDC_TABLE_TYPE"];
-  const TREE_TABLE_TYPE = ____adp_quick_actions_control_types["TREE_TABLE_TYPE"];
-  function getAddXMLAdditionalInfo(change) {
-    const selectorId = change.getSelector()?.id ?? '';
-    const targetAggregation = change.getContent()?.targetAggregation ?? '';
-    const templateName = getFragmentTemplateName(selectorId, targetAggregation);
-    if (templateName) {
-      return {
-        templateName
-      };
-    }
-    return undefined;
-  }
-  function getFragmentTemplateName(selectorId, targetAggregation) {
-    const control = getControlById(selectorId);
-    if (!control) {
-      return '';
-    }
-    const controlName = control.getMetadata().getName();
-    if (controlName === 'sap.uxap.ObjectPageLayout' && targetAggregation === 'sections') {
-      return 'OBJECT_PAGE_CUSTOM_SECTION';
-    } else if (isCustomAction(controlName, targetAggregation)) {
-      return 'CUSTOM_ACTION';
-    } else if (isObjectPageHeaderField(control, controlName, targetAggregation)) {
-      return 'OBJECT_PAGE_HEADER_FIELD';
-    } else if (targetAggregation === 'columns') {
-      switch (controlName) {
-        case MDC_TABLE_TYPE:
-          return 'V4_MDC_TABLE_COLUMN';
-        case TREE_TABLE_TYPE:
-        case GRID_TABLE_TYPE:
-          return 'GRID_TREE_TABLE_COLUMN';
-        case ANALYTICAL_TABLE_TYPE:
-          return 'ANALYTICAL_TABLE_COLUMN';
-        default:
-          return '';
-      }
-    } else if (controlName === 'sap.ui.mdc.Table' && targetAggregation === 'actions') {
-      return 'TABLE_ACTION';
-    }
-    return '';
-  }
-  function isCustomAction(controlName, targetAggregation) {
-    if (['sap.f.DynamicPageTitle', 'sap.uxap.ObjectPageHeader', 'sap.uxap.ObjectPageDynamicHeaderTitle'].includes(controlName)) {
-      return targetAggregation === 'actions';
-    } else if (controlName === 'sap.m.OverflowToolbar' || controlName === 'sap.m.Toolbar') {
-      return targetAggregation === 'content';
-    }
-    return false;
-  }
-  function isObjectPageHeaderField(control, controlName, targetAggregation) {
-    if (controlName === 'sap.uxap.ObjectPageLayout') {
-      return targetAggregation === 'headerContent';
-    } else if (controlName === 'sap.m.FlexBox') {
-      const parentName = control.getParent()?.getMetadata().getName();
-      if (parentName === 'sap.uxap.ObjectPageDynamicHeaderContent' || parentName === 'sap.uxap.ObjectPageLayout') {
-        return targetAggregation === 'items';
-      }
-    }
-    return false;
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.getAddXMLAdditionalInfo = getAddXMLAdditionalInfo;
-  __exports.getFragmentTemplateName = getFragmentTemplateName;
-  return __exports;
+"use strict";
+
+sap.ui.define(["../../utils/core", "../../adp/quick-actions/control-types"], function (____utils_core, ____adp_quick_actions_control_types) {
+  "use strict";
+
+  const getControlById = ____utils_core["getControlById"];
+  const ANALYTICAL_TABLE_TYPE = ____adp_quick_actions_control_types["ANALYTICAL_TABLE_TYPE"];
+  const GRID_TABLE_TYPE = ____adp_quick_actions_control_types["GRID_TABLE_TYPE"];
+  const MDC_TABLE_TYPE = ____adp_quick_actions_control_types["MDC_TABLE_TYPE"];
+  const TREE_TABLE_TYPE = ____adp_quick_actions_control_types["TREE_TABLE_TYPE"];
+  function getAddXMLAdditionalInfo(change) {
+    const selectorId = change.getSelector()?.id ?? '';
+    const targetAggregation = change.getContent()?.targetAggregation ?? '';
+    const templateName = getFragmentTemplateName(selectorId, targetAggregation);
+    if (templateName) {
+      return {
+        templateName
+      };
+    }
+    return undefined;
+  }
+  function getFragmentTemplateName(selectorId, targetAggregation) {
+    const control = getControlById(selectorId);
+    if (!control) {
+      return '';
+    }
+    const controlName = control.getMetadata().getName();
+    if (controlName === 'sap.uxap.ObjectPageLayout' && targetAggregation === 'sections') {
+      return 'OBJECT_PAGE_CUSTOM_SECTION';
+    } else if (isCustomAction(controlName, targetAggregation)) {
+      return 'CUSTOM_ACTION';
+    } else if (isObjectPageHeaderField(control, controlName, targetAggregation)) {
+      return 'OBJECT_PAGE_HEADER_FIELD';
+    } else if (targetAggregation === 'columns') {
+      switch (controlName) {
+        case MDC_TABLE_TYPE:
+          return 'V4_MDC_TABLE_COLUMN';
+        case TREE_TABLE_TYPE:
+        case GRID_TABLE_TYPE:
+          return 'GRID_TREE_TABLE_COLUMN';
+        case ANALYTICAL_TABLE_TYPE:
+          return 'ANALYTICAL_TABLE_COLUMN';
+        default:
+          return '';
+      }
+    } else if (controlName === 'sap.ui.mdc.Table' && targetAggregation === 'actions') {
+      return 'TABLE_ACTION';
+    }
+    return '';
+  }
+  function isCustomAction(controlName, targetAggregation) {
+    if (['sap.f.DynamicPageTitle', 'sap.uxap.ObjectPageHeader', 'sap.uxap.ObjectPageDynamicHeaderTitle'].includes(controlName)) {
+      return targetAggregation === 'actions';
+    } else if (controlName === 'sap.m.OverflowToolbar' || controlName === 'sap.m.Toolbar') {
+      return targetAggregation === 'content';
+    }
+    return false;
+  }
+  function isObjectPageHeaderField(control, controlName, targetAggregation) {
+    if (controlName === 'sap.uxap.ObjectPageLayout') {
+      return targetAggregation === 'headerContent';
+    } else if (controlName === 'sap.m.FlexBox') {
+      const parentName = control.getParent()?.getMetadata().getName();
+      if (parentName === 'sap.uxap.ObjectPageDynamicHeaderContent' || parentName === 'sap.uxap.ObjectPageLayout') {
+        return targetAggregation === 'items';
+      }
+    }
+    return false;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getAddXMLAdditionalInfo = getAddXMLAdditionalInfo;
+  __exports.getFragmentTemplateName = getFragmentTemplateName;
+  return __exports;
 });
 //# sourceMappingURL=add-xml-additional-info.js.map