@sap-ux/preview-middleware 0.20.0 → 0.20.2

package/dist/client/adp/quick-actions/quick-action-base.js

@@ -1,66 +1,66 @@
-"use strict";
-
-sap.ui.define(["./dialog-enablement-validator"], function (___dialog_enablement_validator) {
-  "use strict";
-
-  const DIALOG_ENABLEMENT_VALIDATOR = ___dialog_enablement_validator["DIALOG_ENABLEMENT_VALIDATOR"];
-  /**
-   * Base class for all  quick actions.
-   */
-  class QuickActionDefinitionBase {
-    get id() {
-      return `${this.context.key}-${this.type}`;
-    }
-    getTelemetryIdentifier() {
-      let update = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
-      if (update === true) {
-        this.telemetryIdentifier = new Date().toISOString();
-      }
-      return this.telemetryIdentifier;
-    }
-    get quickActionSteps() {
-      return this.enablementValidators.find(item => item === DIALOG_ENABLEMENT_VALIDATOR) ? 2 : 1;
-    }
-
-    /**
-     * Quick Actions tooltip.
-     */
-    get tooltip() {
-      if (this.validationResult) {
-        const validationErrors = this.validationResult.filter(result => result?.type === 'error');
-        if (validationErrors.length > 0) {
-          const error = validationErrors[0];
-          return error.message;
-        }
-      }
-      return undefined;
-    }
-    get isDisabled() {
-      if (this.validationResult === undefined) {
-        return false;
-      }
-      const validationErrors = this.validationResult.filter(result => result?.type === 'error');
-      return validationErrors.length > 0;
-    }
-    get textKey() {
-      return this.defaultTextKey;
-    }
-    constructor(type, kind, defaultTextKey, context) {
-      let enablementValidators = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
-      this.type = type;
-      this.kind = kind;
-      this.defaultTextKey = defaultTextKey;
-      this.context = context;
-      this.enablementValidators = enablementValidators;
-    }
-    async runEnablementValidators() {
-      this.validationResult = await Promise.all(this.enablementValidators.map(async validator => await validator.run()));
-    }
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.QuickActionDefinitionBase = QuickActionDefinitionBase;
-  return __exports;
+"use strict";
+
+sap.ui.define(["./dialog-enablement-validator"], function (___dialog_enablement_validator) {
+  "use strict";
+
+  const DIALOG_ENABLEMENT_VALIDATOR = ___dialog_enablement_validator["DIALOG_ENABLEMENT_VALIDATOR"];
+  /**
+   * Base class for all  quick actions.
+   */
+  class QuickActionDefinitionBase {
+    get id() {
+      return `${this.context.key}-${this.type}`;
+    }
+    getTelemetryIdentifier() {
+      let update = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+      if (update === true) {
+        this.telemetryIdentifier = new Date().toISOString();
+      }
+      return this.telemetryIdentifier;
+    }
+    get quickActionSteps() {
+      return this.enablementValidators.find(item => item === DIALOG_ENABLEMENT_VALIDATOR) ? 2 : 1;
+    }
+
+    /**
+     * Quick Actions tooltip.
+     */
+    get tooltip() {
+      if (this.validationResult) {
+        const validationErrors = this.validationResult.filter(result => result?.type === 'error');
+        if (validationErrors.length > 0) {
+          const error = validationErrors[0];
+          return error.message;
+        }
+      }
+      return undefined;
+    }
+    get isDisabled() {
+      if (this.validationResult === undefined) {
+        return false;
+      }
+      const validationErrors = this.validationResult.filter(result => result?.type === 'error');
+      return validationErrors.length > 0;
+    }
+    get textKey() {
+      return this.defaultTextKey;
+    }
+    constructor(type, kind, defaultTextKey, context) {
+      let enablementValidators = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
+      this.type = type;
+      this.kind = kind;
+      this.defaultTextKey = defaultTextKey;
+      this.context = context;
+      this.enablementValidators = enablementValidators;
+    }
+    async runEnablementValidators() {
+      this.validationResult = await Promise.all(this.enablementValidators.map(async validator => await validator.run()));
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.QuickActionDefinitionBase = QuickActionDefinitionBase;
+  return __exports;
 });
 //# sourceMappingURL=quick-action-base.js.map

package/dist/client/adp/ui/ControllerExtension.fragment.xml

@@ -11,7 +11,8 @@
             editable="true"
             layout="ResponsiveGridLayout"
             labelSpanS="4"
-            singleContainerFullSize="false">
+            singleContainerFullSize="false"
+            visible="{/inputFormVisibility}">
             <f:content>
                 <Label text="Controller Name" />
                 <Input 
@@ -26,13 +27,23 @@
             editable="true"
             layout="ResponsiveGridLayout"
             labelSpanS="12"
-            visible="false"
+            visible="{/existingControllerFormVisibility}"
             singleContainerFullSize="false">
             <f:content>
-                <Label text="An existing controller extension has been found. Please use the previously created extension controller" />
+                <Label text="{i18n>ADP_CONTROLLER_EXTENSION_EXISTS}" />
                 <Text text="{/controllerPathFromRoot}" />
             </f:content>
         </f:SimpleForm>
+        <f:SimpleForm
+            editable="true"
+            layout="ResponsiveGridLayout"
+            labelSpanS="12"
+            visible="{/pendingChangeFormVisibility}"
+            singleContainerFullSize="false">
+            <f:content>
+                <Text text="{i18n>ADP_CONTROLLER_PENDING_CHANGE_EXISTS}" />
+            </f:content>
+        </f:SimpleForm>
     </content>
     <beginButton>
         <Button 

package/dist/client/adp/utils.js

@@ -1,220 +1,261 @@
-"use strict";
-
-sap.ui.define(["sap/m/MessageToast", "sap/ui/core/Element", "sap/base/Log", "sap/ui/fl/Utils", "../utils/core", "../utils/error", "../utils/version"], function (MessageToast, Element, Log, FlexUtils, ___utils_core, ___utils_error, ___utils_version) {
-  "use strict";
-
-  function __ui5_require_async(path) {
-    return new Promise(function (resolve, reject) {
-      sap.ui.require([path], function (module) {
-        if (!(module && module.__esModule)) {
-          module = module === null || !(typeof module === "object" && path.endsWith("/library")) ? {
-            default: module
-          } : module;
-          Object.defineProperty(module, "__esModule", {
-            value: true
-          });
-        }
-        resolve(module);
-      }, function (err) {
-        reject(err);
-      });
-    });
-  }
-  const getControlById = ___utils_core["getControlById"];
-  const getError = ___utils_error["getError"];
-  const isLowerThanMinimalUi5Version = ___utils_version["isLowerThanMinimalUi5Version"];
-  let reuseComponentChecker;
-
-  /**
-   * Resets the reuse component checker.
-   */
-  function resetReuseComponentChecker() {
-    reuseComponentChecker = undefined;
-  }
-
-  /**
-   * Defers the resolution of the promise, stores resolve/reject functions so that they can be accessed at a later stage.
-   *
-   * @description A Deferred object contains an unresolved promise along with the functions to resolve or reject that promise.
-   *
-   * @returns {Deferred} Deferred object
-   */
-  function createDeferred() {
-    let resolve = null;
-    let reject = null;
-    const promise = new Promise((res, rej) => {
-      resolve = res;
-      reject = rej;
-    });
-    if (resolve === null || reject === null) {
-      throw new Error('Failed to initialize resolve and reject functions.');
-    }
-    return {
-      promise,
-      resolve,
-      reject
-    };
-  }
-
-  /**
-   * Checks if the fragment name associated with a command matches the specified fragment name.
-   *
-   * @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.
-   */
-  function matchesFragmentName(command, fragmentName) {
-    if (typeof command.getPreparedChange !== 'function') {
-      return false;
-    }
-    const change = command.getPreparedChange().getDefinition();
-    return change.content?.fragmentPath?.includes(`${fragmentName}.fragment.xml`) || false;
-  }
-
-  /**
-   * Displays a message to the user indicating that an XML fragment will be created upon saving a change.
-   *
-   * @param {string} message - The message to be shown in the message toast.
-   * @param {number} duration - The duration during which message toast will be active.
-   */
-  function notifyUser(message) {
-    let duration = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 5000;
-    MessageToast.show(message, {
-      duration
-    });
-  }
-
-  /**
-   * Check if element is sync view
-   *
-   * @param element Design time Element
-   * @returns boolean if element is sync view or not
-   */
-  function isSyncView(element) {
-    return element?.getMetadata()?.getName()?.includes('XMLView') && element?.oAsyncState === undefined;
-  }
-
-  /**
-   * Get Ids for all sync views
-   *
-   * @param ui5VersionInfo UI5 Version Information
-   *
-   * @returns array of Ids for application sync views
-   */
-  async function getAllSyncViewsIds(ui5VersionInfo) {
-    const syncViewIds = [];
-    try {
-      if (isLowerThanMinimalUi5Version(ui5VersionInfo, {
-        major: 1,
-        minor: 120
-      })) {
-        const elements = Element.registry.filter(() => true);
-        elements.forEach(ui5Element => {
-          if (isSyncView(ui5Element)) {
-            syncViewIds.push(ui5Element.getId());
-          }
-        });
-      } else {
-        const ElementRegistry = (await __ui5_require_async('sap/ui/core/ElementRegistry')).default;
-        const elements = ElementRegistry.all();
-        Object.entries(elements).forEach(_ref => {
-          let [key, ui5Element] = _ref;
-          if (isSyncView(ui5Element)) {
-            syncViewIds.push(key);
-          }
-        });
-      }
-    } catch (error) {
-      Log.error('Could not get application sync views', getError(error));
-    }
-    return syncViewIds;
-  }
-  /**
-   * Gets controller name and view ID for the given UI5 control.
-   *
-   * @param control UI5 control.
-   * @returns The controller name and view ID.
-   */
-  function getControllerInfoForControl(control) {
-    const view = FlexUtils.getViewForControl(control);
-    const moduleName = view?.getControllerModuleName?.();
-    const controllerName = moduleName ? `module:${moduleName}` : view.getController()?.getMetadata().getName();
-    const viewId = view.getId();
-    return {
-      controllerName,
-      viewId
-    };
-  }
-
-  /**
-   * Gets controller name and view ID for the given overlay control.
-   *
-   * @param overlayControl The overlay control.
-   * @returns The controller name and view ID.
-   */
-
-  function getControllerInfo(overlayControl) {
-    const control = overlayControl.getElement();
-    return getControllerInfoForControl(control);
-  }
-
-  /**
-   * Gets the reuse component checker function.
-   *
-   * @param ui5VersionInfo UI5 version information.
-   * @returns The reuse component checker function.
-   */
-  async function getReuseComponentChecker(ui5VersionInfo) {
-    if (reuseComponentChecker) {
-      return reuseComponentChecker;
-    }
-    let reuseComponentApi;
-    if (!isLowerThanMinimalUi5Version(ui5VersionInfo, {
-      major: 1,
-      minor: 134
-    })) {
-      reuseComponentApi = (await __ui5_require_async('sap/ui/rta/util/isReuseComponent')).default;
-    }
-    reuseComponentChecker = function isReuseComponent(controlId) {
-      const ui5Control = getControlById(controlId);
-      if (!ui5Control) {
-        return false;
-      }
-      const component = FlexUtils.getComponentForControl(ui5Control);
-      if (reuseComponentApi) {
-        return reuseComponentApi(component);
-      }
-      if (!component) {
-        return false;
-      }
-      const appComponent = FlexUtils.getAppComponentForControl(component);
-      if (!appComponent) {
-        return false;
-      }
-      const manifest = component.getManifest();
-      const appManifest = appComponent.getManifest();
-      const componentName = manifest?.['sap.app']?.id;
-
-      // Look for component name in component usages of app component manifest
-      const componentUsages = appManifest?.['sap.ui5']?.componentUsages;
-      return Object.values(componentUsages || {}).some(componentUsage => {
-        return componentUsage.name === componentName;
-      });
-    };
-    return reuseComponentChecker;
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.resetReuseComponentChecker = resetReuseComponentChecker;
-  __exports.createDeferred = createDeferred;
-  __exports.matchesFragmentName = matchesFragmentName;
-  __exports.notifyUser = notifyUser;
-  __exports.getAllSyncViewsIds = getAllSyncViewsIds;
-  __exports.getControllerInfoForControl = getControllerInfoForControl;
-  __exports.getControllerInfo = getControllerInfo;
-  __exports.getReuseComponentChecker = getReuseComponentChecker;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/m/MessageToast", "sap/ui/core/Element", "sap/base/Log", "sap/ui/fl/Utils", "../utils/core", "../utils/error", "../utils/version"], function (MessageToast, Element, Log, FlexUtils, ___utils_core, ___utils_error, ___utils_version) {
+  "use strict";
+
+  function __ui5_require_async(path) {
+    return new Promise(function (resolve, reject) {
+      sap.ui.require([path], function (module) {
+        if (!(module && module.__esModule)) {
+          module = module === null || !(typeof module === "object" && path.endsWith("/library")) ? {
+            default: module
+          } : module;
+          Object.defineProperty(module, "__esModule", {
+            value: true
+          });
+        }
+        resolve(module);
+      }, function (err) {
+        reject(err);
+      });
+    });
+  }
+  const getControlById = ___utils_core["getControlById"];
+  const getError = ___utils_error["getError"];
+  const isLowerThanMinimalUi5Version = ___utils_version["isLowerThanMinimalUi5Version"];
+  let reuseComponentChecker;
+
+  /**
+   * Resets the reuse component checker.
+   */
+  function resetReuseComponentChecker() {
+    reuseComponentChecker = undefined;
+  }
+
+  /**
+   * Defers the resolution of the promise, stores resolve/reject functions so that they can be accessed at a later stage.
+   *
+   * @description A Deferred object contains an unresolved promise along with the functions to resolve or reject that promise.
+   *
+   * @returns {Deferred} Deferred object
+   */
+  function createDeferred() {
+    let resolve = null;
+    let reject = null;
+    const promise = new Promise((res, rej) => {
+      resolve = res;
+      reject = rej;
+    });
+    if (resolve === null || reject === null) {
+      throw new Error('Failed to initialize resolve and reject functions.');
+    }
+    return {
+      promise,
+      resolve,
+      reject
+    };
+  }
+
+  /**
+   * 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`.
+   */
+  function checkForExistingChange(rta, commandName, propertyPath, propertyValue) {
+    const allCommands = rta.getCommandStack().getCommands();
+    return allCommands.some(command => {
+      if (typeof command.getCommands === 'function') {
+        const subCommand = command.getCommands().find(c => 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.
+   */
+  function getNestedProperty(obj, path) {
+    return path.split('.').reduce((acc, key) => {
+      return acc?.[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} 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.
+   */
+  function matchesChangeProperty(command, propertyPath, propertyValue) {
+    if (typeof command.getPreparedChange !== 'function') {
+      return false;
+    }
+    const change = command.getPreparedChange()?.getDefinition?.();
+    if (!change) {
+      return false;
+    }
+    const nestedProperty = getNestedProperty(change, propertyPath);
+    return typeof nestedProperty === 'string' ? nestedProperty.includes(propertyValue) : false;
+  }
+
+  /**
+   * Displays a message to the user indicating that an XML fragment will be created upon saving a change.
+   *
+   * @param {string} message - The message to be shown in the message toast.
+   * @param {number} duration - The duration during which message toast will be active.
+   */
+  function notifyUser(message) {
+    let duration = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 5000;
+    MessageToast.show(message, {
+      duration
+    });
+  }
+
+  /**
+   * Check if element is sync view
+   *
+   * @param element Design time Element
+   * @returns boolean if element is sync view or not
+   */
+  function isSyncView(element) {
+    return element?.getMetadata()?.getName()?.includes('XMLView') && element?.oAsyncState === undefined;
+  }
+
+  /**
+   * Get Ids for all sync views
+   *
+   * @param ui5VersionInfo UI5 Version Information
+   *
+   * @returns array of Ids for application sync views
+   */
+  async function getAllSyncViewsIds(ui5VersionInfo) {
+    const syncViewIds = [];
+    try {
+      if (isLowerThanMinimalUi5Version(ui5VersionInfo, {
+        major: 1,
+        minor: 120
+      })) {
+        const elements = Element.registry.filter(() => true);
+        elements.forEach(ui5Element => {
+          if (isSyncView(ui5Element)) {
+            syncViewIds.push(ui5Element.getId());
+          }
+        });
+      } else {
+        const ElementRegistry = (await __ui5_require_async('sap/ui/core/ElementRegistry')).default;
+        const elements = ElementRegistry.all();
+        Object.entries(elements).forEach(_ref => {
+          let [key, ui5Element] = _ref;
+          if (isSyncView(ui5Element)) {
+            syncViewIds.push(key);
+          }
+        });
+      }
+    } catch (error) {
+      Log.error('Could not get application sync views', getError(error));
+    }
+    return syncViewIds;
+  }
+  /**
+   * Gets controller name and view ID for the given UI5 control.
+   *
+   * @param control UI5 control.
+   * @returns The controller name and view ID.
+   */
+  function getControllerInfoForControl(control) {
+    const view = FlexUtils.getViewForControl(control);
+    const moduleName = view?.getControllerModuleName?.();
+    const controllerName = moduleName ? `module:${moduleName}` : view.getController()?.getMetadata().getName();
+    const viewId = view.getId();
+    return {
+      controllerName,
+      viewId
+    };
+  }
+
+  /**
+   * Gets controller name and view ID for the given overlay control.
+   *
+   * @param overlayControl The overlay control.
+   * @returns The controller name and view ID.
+   */
+
+  function getControllerInfo(overlayControl) {
+    const control = overlayControl.getElement();
+    return getControllerInfoForControl(control);
+  }
+
+  /**
+   * Gets the reuse component checker function.
+   *
+   * @param ui5VersionInfo UI5 version information.
+   * @returns The reuse component checker function.
+   */
+  async function getReuseComponentChecker(ui5VersionInfo) {
+    if (reuseComponentChecker) {
+      return reuseComponentChecker;
+    }
+    let reuseComponentApi;
+    if (!isLowerThanMinimalUi5Version(ui5VersionInfo, {
+      major: 1,
+      minor: 134
+    })) {
+      reuseComponentApi = (await __ui5_require_async('sap/ui/rta/util/isReuseComponent')).default;
+    }
+    reuseComponentChecker = function isReuseComponent(controlId) {
+      const ui5Control = getControlById(controlId);
+      if (!ui5Control) {
+        return false;
+      }
+      const component = FlexUtils.getComponentForControl(ui5Control);
+      if (reuseComponentApi) {
+        return reuseComponentApi(component);
+      }
+      if (!component) {
+        return false;
+      }
+      const appComponent = FlexUtils.getAppComponentForControl(component);
+      if (!appComponent) {
+        return false;
+      }
+      const manifest = component.getManifest();
+      const appManifest = appComponent.getManifest();
+      const componentName = manifest?.['sap.app']?.id;
+
+      // Look for component name in component usages of app component manifest
+      const componentUsages = appManifest?.['sap.ui5']?.componentUsages;
+      return Object.values(componentUsages || {}).some(componentUsage => {
+        return componentUsage.name === componentName;
+      });
+    };
+    return reuseComponentChecker;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.resetReuseComponentChecker = resetReuseComponentChecker;
+  __exports.createDeferred = createDeferred;
+  __exports.checkForExistingChange = checkForExistingChange;
+  __exports.getNestedProperty = getNestedProperty;
+  __exports.matchesChangeProperty = matchesChangeProperty;
+  __exports.notifyUser = notifyUser;
+  __exports.getAllSyncViewsIds = getAllSyncViewsIds;
+  __exports.getControllerInfoForControl = getControllerInfoForControl;
+  __exports.getControllerInfo = getControllerInfo;
+  __exports.getReuseComponentChecker = getReuseComponentChecker;
+  return __exports;
 });
 //# sourceMappingURL=utils.js.map