@sap-ux/preview-middleware 0.16.149 → 0.16.152

package/dist/client/utils/version.js

@@ -1,87 +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
-  };
-
-  /**
-   * Retrieve the UI5 version from sap.ui.core library
-   *
-   * @returns Ui5VersionInfo
-   */
-  async function getUi5Version() {
-    let version = (await VersionInfo.load({
-      library: 'sap.ui.core'
-    }))?.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.
-   * @param ui5VersionInfo to check
-   * @param minUi5VersionInfo to check against (default is 1.71)
-   *
-   * @returns boolean
-   */
-  function isLowerThanMinimalUi5Version(ui5VersionInfo) {
-    let minUi5VersionInfo = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : minVersionInfo;
-    if (!isNaN(ui5VersionInfo.major) && !isNaN(ui5VersionInfo.minor)) {
-      if (ui5VersionInfo.major < minUi5VersionInfo.major) {
-        return true;
-      }
-      if (ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor < minUi5VersionInfo.minor) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  /**
-   * Checks if the given version is equal to the specified version.
-   * @param ui5VersionInfo to check
-   * @param targetUi5VersionInfo to check against (default is 1.71)
-   *
-   * @returns boolean
-   */
-  function isVersionEqualOrHasNewerPatch(ui5VersionInfo) {
-    let targetUi5VersionInfo = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : minVersionInfo;
-    if (!isNaN(ui5VersionInfo.major) && !isNaN(ui5VersionInfo.minor)) {
-      return ui5VersionInfo.major === targetUi5VersionInfo.major && ui5VersionInfo.minor === targetUi5VersionInfo.minor && (ui5VersionInfo?.patch ?? 0) >= (targetUi5VersionInfo?.patch ?? 0);
-    }
-    return false;
-  }
-
-  /**
-   * 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/dist/client/utils/version.ts

@@ -23,12 +23,29 @@ const minVersionInfo = {
 } as Readonly<Ui5VersionInfo>;
 
 /**
- * Retrieve the UI5 version from sap.ui.core library
+ * Check if the given version info is valid.
+ * @param versionInfo to check
+ * @throws Error if the version info is invalid
+ */
+function checkVersionInfo(versionInfo: Ui5VersionInfo): void {
+    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
  */
-export async function getUi5Version(): Promise<Ui5VersionInfo> {
-    let version = ((await VersionInfo.load({ library: 'sap.ui.core' })) as SingleVersionInfo)?.version;
+export async function getUi5Version(library: string = 'sap.ui.core'): Promise<Ui5VersionInfo> {
+    let version = ((await VersionInfo.load({ library })) as SingleVersionInfo)?.version;
     if (!version) {
         Log.error('Could not get UI5 version of application. Using 1.121.0 as fallback.');
         version = '1.121.0';
@@ -44,8 +61,12 @@ export async function getUi5Version(): Promise<Ui5VersionInfo> {
 
 /**
  * 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
  */
@@ -53,21 +74,25 @@ export function isLowerThanMinimalUi5Version(
     ui5VersionInfo: Ui5VersionInfo,
     minUi5VersionInfo: Ui5VersionInfo = minVersionInfo
 ): boolean {
-    if (!isNaN(ui5VersionInfo.major) && !isNaN(ui5VersionInfo.minor)) {
-        if (ui5VersionInfo.major < minUi5VersionInfo.major) {
-            return true;
-        }
-        if (ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor < minUi5VersionInfo.minor) {
-            return true;
-        }
-    }
-    return false;
+    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
  */
@@ -75,13 +100,13 @@ export function isVersionEqualOrHasNewerPatch(
     ui5VersionInfo: Ui5VersionInfo,
     targetUi5VersionInfo: Ui5VersionInfo = minVersionInfo
 ): boolean {
-    if (!isNaN(ui5VersionInfo.major) && !isNaN(ui5VersionInfo.minor)) {
-        return (
-            ui5VersionInfo.major === targetUi5VersionInfo.major &&
-            ui5VersionInfo.minor === targetUi5VersionInfo.minor &&
-            (ui5VersionInfo?.patch ?? 0) >= (targetUi5VersionInfo?.patch ?? 0));
-    }
-    return false;
+    checkVersionInfo(ui5VersionInfo);
+    checkVersionInfo(targetUi5VersionInfo);
+    return (
+        ui5VersionInfo.major === targetUi5VersionInfo.major &&
+        ui5VersionInfo.minor === targetUi5VersionInfo.minor &&
+        (ui5VersionInfo?.patch ?? 0) >= (targetUi5VersionInfo?.patch ?? 0)
+    );
 }
 
 /**

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.149",
+  "version": "0.16.152",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,10 +27,10 @@
     "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.1",
-    "@sap-ux/adp-tooling": "0.12.96",
+    "@sap-ux/btp-utils": "0.17.2",
+    "@sap-ux/adp-tooling": "0.12.98",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.28",
-    "@sap-ux/project-access": "1.28.9"
+    "@sap-ux/project-access": "1.28.10"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -46,9 +46,9 @@
     "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.42",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.43",
+    "@sap-ux/axios-extension": "1.17.8",
     "@sap-ux/store": "1.0.0",
-    "@sap-ux/axios-extension": "1.17.7",
     "@sap-ux/ui5-info": "0.8.3",
     "@sap-ux/i18n": "0.2.0"
   },