@sap-ux/preview-middleware 0.16.155 → 0.16.156

package/dist/client/utils/fe-v4.ts

@@ -10,7 +10,6 @@ import { getOverlay } from '../cpe/utils';
 import UI5Element from 'sap/ui/core/Element';
 import FlexCommand from 'sap/ui/rta/command/FlexCommand';
 
-
 /**
  * Gets app component of a v4 project.
  *
@@ -85,20 +84,29 @@ export function getConfigMapControlIdMap(page: string | undefined, propertyPathS
 }
 
 /**
-* Get the modified value for a control.
-* @param modifiedControl - The modified control.
-* @param flexSettings - Flex Settings of the control.
-* @param propertyChanges - The change object
-* 
-* @returns  A Promise resolving to an array of FlexCommand objects.
-*/
-export async function createManifestPropertyChange(modifiedControl: UI5Element, flexSettings: FlexSettings, propertyChanges: Record<string, string | string[] | boolean | number | object | undefined>): Promise<FlexCommand | undefined> {
+ * Get the modified value for a control.
+ * @param modifiedControl - The modified control.
+ * @param flexSettings - Flex Settings of the control.
+ * @param propertyChanges - The change object
+ * @param propertyPathExtraSegments - optional path segments which are added to the default modified control manifest path
+ *
+ * @returns  A Promise resolving to an array of FlexCommand objects.
+ */
+export async function createManifestPropertyChange(
+    modifiedControl: UI5Element,
+    flexSettings: FlexSettings,
+    propertyChanges: Record<string, string | string[] | boolean | number | object | undefined>,
+    propertyPathExtraSegments?: string[]
+): Promise<FlexCommand | undefined> {
     const overlay = getOverlay(modifiedControl);
     if (!overlay) {
         return undefined;
     }
     const overlayData = overlay?.getDesignTimeMetadata().getData();
-    const manifestPropertyPath = overlayData.manifestPropertyPath(modifiedControl);
+    let manifestPropertyPath = overlayData.manifestPropertyPath(modifiedControl);
+    if (propertyPathExtraSegments) {
+        manifestPropertyPath += '/' + propertyPathExtraSegments.join('/');
+    }
     const [manifestPropertyChange] = overlayData.manifestPropertyChange(
         propertyChanges,
         manifestPropertyPath,
@@ -122,4 +130,4 @@ export async function createManifestPropertyChange(modifiedControl: UI5Element,
     );
 
     return command;
-}
+}

package/dist/client/utils/version.js

@@ -1,104 +1,104 @@
-"use strict";
-
-sap.ui.define(["sap/ui/VersionInfo", "sap/base/Log"], function (VersionInfo, Log) {
-  "use strict";
-
-  /**
-   * Default minimal supported UI5 version
-   */
-  const minVersionInfo = {
-    major: 1,
-    minor: 71
-  };
-
-  /**
-   * Check if the given version info is valid.
-   * @param versionInfo to check
-   * @throws Error if the version info is invalid
-   */
-  function checkVersionInfo(versionInfo) {
-    if (isNaN(versionInfo.major) || isNaN(versionInfo.minor) || isNaN(versionInfo.patch ?? 0)) {
-      throw new Error('Invalid version info');
-    }
-  }
-
-  /**
-   * Retrieve the UI5 version.
-   * If no library is given, the version from 'sap.ui.core' will be retrieved.
-   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
-   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
-   *
-   * @param library - (optional) specific library name to get the version from, e.g. 'sap.m'
-   * @returns Ui5VersionInfo
-   */
-  async function getUi5Version() {
-    let library = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'sap.ui.core';
-    let version = (await VersionInfo.load({
-      library
-    }))?.version;
-    if (!version) {
-      Log.error('Could not get UI5 version of application. Using 1.121.0 as fallback.');
-      version = '1.121.0';
-    }
-    const [major, minor, patch] = version.split('.').map(versionPart => parseInt(versionPart, 10));
-    return {
-      major: major,
-      minor: minor,
-      patch: patch
-    };
-  }
-
-  /**
-   * Checks if the given version is lower than the required minimal version.
-   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
-   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
-   *
-   * @param ui5VersionInfo to check
-   * @param minUi5VersionInfo to check against (default is 1.71)
-   * @throws Error if the version info is invalid
-   *
-   * @returns boolean
-   */
-  function isLowerThanMinimalUi5Version(ui5VersionInfo) {
-    let minUi5VersionInfo = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : minVersionInfo;
-    checkVersionInfo(ui5VersionInfo);
-    checkVersionInfo(minUi5VersionInfo);
-    return ui5VersionInfo.major < minUi5VersionInfo.major || ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor < minUi5VersionInfo.minor || ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor === minUi5VersionInfo.minor && (ui5VersionInfo?.patch ?? 0) < (minUi5VersionInfo?.patch ?? 0);
-  }
-
-  /**
-   * Checks if the given version is equal to the specified version.
-   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
-   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
-   *
-   * @param ui5VersionInfo to check
-   * @param targetUi5VersionInfo to check against (default is 1.71)
-   * @throws Error if the version info is invalid
-   *
-   * @returns boolean
-   */
-  function isVersionEqualOrHasNewerPatch(ui5VersionInfo) {
-    let targetUi5VersionInfo = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : minVersionInfo;
-    checkVersionInfo(ui5VersionInfo);
-    checkVersionInfo(targetUi5VersionInfo);
-    return ui5VersionInfo.major === targetUi5VersionInfo.major && ui5VersionInfo.minor === targetUi5VersionInfo.minor && (ui5VersionInfo?.patch ?? 0) >= (targetUi5VersionInfo?.patch ?? 0);
-  }
-
-  /**
-   * Get UI5 version validation message.
-   * @param ui5VersionInfo to be mentioned in the message
-   * @returns string with validation message.
-   */
-  function getUI5VersionValidationMessage(ui5VersionInfo) {
-    return `The current SAPUI5 version set for this Adaptation project is ${ui5VersionInfo.major}.${ui5VersionInfo.minor}. The minimum version to use for SAPUI5 Adaptation Project and its SAPUI5 Visual Editor is ${minVersionInfo.major}.${minVersionInfo.minor}`;
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.getUi5Version = getUi5Version;
-  __exports.isLowerThanMinimalUi5Version = isLowerThanMinimalUi5Version;
-  __exports.isVersionEqualOrHasNewerPatch = isVersionEqualOrHasNewerPatch;
-  __exports.getUI5VersionValidationMessage = getUI5VersionValidationMessage;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/ui/VersionInfo", "sap/base/Log"], function (VersionInfo, Log) {
+  "use strict";
+
+  /**
+   * Default minimal supported UI5 version
+   */
+  const minVersionInfo = {
+    major: 1,
+    minor: 71
+  };
+
+  /**
+   * Check if the given version info is valid.
+   * @param versionInfo to check
+   * @throws Error if the version info is invalid
+   */
+  function checkVersionInfo(versionInfo) {
+    if (isNaN(versionInfo.major) || isNaN(versionInfo.minor) || isNaN(versionInfo.patch ?? 0)) {
+      throw new Error('Invalid version info');
+    }
+  }
+
+  /**
+   * Retrieve the UI5 version.
+   * If no library is given, the version from 'sap.ui.core' will be retrieved.
+   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+   *
+   * @param library - (optional) specific library name to get the version from, e.g. 'sap.m'
+   * @returns Ui5VersionInfo
+   */
+  async function getUi5Version() {
+    let library = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'sap.ui.core';
+    let version = (await VersionInfo.load({
+      library
+    }))?.version;
+    if (!version) {
+      Log.error('Could not get UI5 version of application. Using 1.121.0 as fallback.');
+      version = '1.121.0';
+    }
+    const [major, minor, patch] = version.split('.').map(versionPart => parseInt(versionPart, 10));
+    return {
+      major: major,
+      minor: minor,
+      patch: patch
+    };
+  }
+
+  /**
+   * Checks if the given version is lower than the required minimal version.
+   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+   *
+   * @param ui5VersionInfo to check
+   * @param minUi5VersionInfo to check against (default is 1.71)
+   * @throws Error if the version info is invalid
+   *
+   * @returns boolean
+   */
+  function isLowerThanMinimalUi5Version(ui5VersionInfo) {
+    let minUi5VersionInfo = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : minVersionInfo;
+    checkVersionInfo(ui5VersionInfo);
+    checkVersionInfo(minUi5VersionInfo);
+    return ui5VersionInfo.major < minUi5VersionInfo.major || ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor < minUi5VersionInfo.minor || ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor === minUi5VersionInfo.minor && (ui5VersionInfo?.patch ?? 0) < (minUi5VersionInfo?.patch ?? 0);
+  }
+
+  /**
+   * Checks if the given version is equal to the specified version.
+   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+   *
+   * @param ui5VersionInfo to check
+   * @param targetUi5VersionInfo to check against (default is 1.71)
+   * @throws Error if the version info is invalid
+   *
+   * @returns boolean
+   */
+  function isVersionEqualOrHasNewerPatch(ui5VersionInfo) {
+    let targetUi5VersionInfo = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : minVersionInfo;
+    checkVersionInfo(ui5VersionInfo);
+    checkVersionInfo(targetUi5VersionInfo);
+    return ui5VersionInfo.major === targetUi5VersionInfo.major && ui5VersionInfo.minor === targetUi5VersionInfo.minor && (ui5VersionInfo?.patch ?? 0) >= (targetUi5VersionInfo?.patch ?? 0);
+  }
+
+  /**
+   * Get UI5 version validation message.
+   * @param ui5VersionInfo to be mentioned in the message
+   * @returns string with validation message.
+   */
+  function getUI5VersionValidationMessage(ui5VersionInfo) {
+    return `The current SAPUI5 version set for this Adaptation project is ${ui5VersionInfo.major}.${ui5VersionInfo.minor}. The minimum version to use for SAPUI5 Adaptation Project and its SAPUI5 Visual Editor is ${minVersionInfo.major}.${minVersionInfo.minor}`;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getUi5Version = getUi5Version;
+  __exports.isLowerThanMinimalUi5Version = isLowerThanMinimalUi5Version;
+  __exports.isVersionEqualOrHasNewerPatch = isVersionEqualOrHasNewerPatch;
+  __exports.getUI5VersionValidationMessage = getUI5VersionValidationMessage;
+  return __exports;
 });
 //# sourceMappingURL=version.js.map

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.16.155",
+  "version": "0.16.156",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,9 +27,9 @@
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/feature-toggle": "0.2.3",
-    "@sap-ux/btp-utils": "0.17.2",
     "@sap-ux/adp-tooling": "0.12.101",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.29",
+    "@sap-ux/btp-utils": "0.17.2",
     "@sap-ux/project-access": "1.28.10"
   },
   "devDependencies": {
@@ -46,7 +46,7 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.1.0",
     "dotenv": "16.3.1",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.43",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.44",
     "@sap-ux/axios-extension": "1.17.8",
     "@sap-ux/store": "1.0.0",
     "@sap-ux/ui5-info": "0.8.3",