@sap-ux/preview-middleware 0.20.73 → 0.21.0

package/dist/client/utils/version.js

@@ -1,106 +1,71 @@
-"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');
+'use strict';
+sap.ui.define([
+    'sap/ui/VersionInfo',
+    'sap/base/Log',
+    './info-center-message',
+    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common'
+], function (VersionInfo, Log, ___info_center_message, ___sap_ux_private_control_property_editor_common) {
+    'use strict';
+    const sendInfoCenterMessage = ___info_center_message['sendInfoCenterMessage'];
+    const MessageBarType = ___sap_ux_private_control_property_editor_common['MessageBarType'];
+    const minVersionInfo = {
+        major: 1,
+        minor: 71
+    };
+    function checkVersionInfo(versionInfo) {
+        if (isNaN(versionInfo.major) || isNaN(versionInfo.minor) || isNaN(versionInfo.patch ?? 0)) {
+            void sendInfoCenterMessage({
+                title: { key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_TITLE' },
+                description: { key: 'FLP_UI_INVALID_UI5_VERSION_DESCRIPTION' },
+                type: MessageBarType.error
+            });
+            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 version: 1.130.0 as fallback.');
-      version = '1.130.0';
+    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 version: 1.130.0 as fallback.');
+            version = '1.130.0';
+            await sendInfoCenterMessage({
+                title: { key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_TITLE' },
+                description: {
+                    key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_DESCRIPTION',
+                    params: [version]
+                },
+                type: MessageBarType.error
+            });
+        }
+        const [major, minor, patch] = version.split('.').map(versionPart => parseInt(versionPart, 10));
+        const label = version.split(/-(.*)/s)?.[1];
+        return {
+            major,
+            minor,
+            patch,
+            label
+        };
     }
-    const [major, minor, patch] = version.split('.').map(versionPart => parseInt(versionPart, 10));
-    const label = version.split(/-(.*)/s)?.[1];
-    return {
-      major,
-      minor,
-      patch,
-      label
-    };
-  }
-
-  /**
-   * 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
+    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);
+    }
+    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);
+    }
+    function getFullyQualifiedUi5Version(ui5VersionInfo) {
+        return `${ ui5VersionInfo.major }.${ ui5VersionInfo.minor }`;
+    }
+    var __exports = { __esModule: true };
+    __exports.minVersionInfo = minVersionInfo;
+    __exports.getUi5Version = getUi5Version;
+    __exports.isLowerThanMinimalUi5Version = isLowerThanMinimalUi5Version;
+    __exports.isVersionEqualOrHasNewerPatch = isVersionEqualOrHasNewerPatch;
+    __exports.getFullyQualifiedUi5Version = getFullyQualifiedUi5Version;
+    return __exports;
+});

package/dist/client/utils/version.ts

@@ -1,11 +1,13 @@
 import VersionInfo from 'sap/ui/VersionInfo';
 import Log from 'sap/base/Log';
+import { sendInfoCenterMessage } from './info-center-message';
+import { MessageBarType } from '@sap-ux-private/control-property-editor-common';
 
 type SingleVersionInfo =
     | {
-        name: string;
-        version: string;
-    }
+          name: string;
+          version: string;
+      }
     | undefined;
 
 export type Ui5VersionInfo = {
@@ -18,7 +20,7 @@ export type Ui5VersionInfo = {
 /**
  * Default minimal supported UI5 version
  */
-const minVersionInfo = {
+export const minVersionInfo = {
     major: 1,
     minor: 71
 } as Readonly<Ui5VersionInfo>;
@@ -29,9 +31,12 @@ const minVersionInfo = {
  * @throws Error if the version info is invalid
  */
 function checkVersionInfo(versionInfo: Ui5VersionInfo): void {
-    if(isNaN(versionInfo.major) ||
-       isNaN(versionInfo.minor) ||
-       isNaN(versionInfo.patch ?? 0)) {
+    if (isNaN(versionInfo.major) || isNaN(versionInfo.minor) || isNaN(versionInfo.patch ?? 0)) {
+        void sendInfoCenterMessage({
+            title: { key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_TITLE' },
+            description: { key: 'FLP_UI_INVALID_UI5_VERSION_DESCRIPTION' },
+            type: MessageBarType.error
+        });
         throw new Error('Invalid version info');
     }
 }
@@ -50,6 +55,11 @@ export async function getUi5Version(library: string = 'sap.ui.core'): Promise<Ui
     if (!version) {
         Log.error('Could not get UI5 version of application. Using version: 1.130.0 as fallback.');
         version = '1.130.0';
+        await sendInfoCenterMessage({
+            title: { key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_TITLE' },
+            description: { key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_DESCRIPTION', params: [version] },
+            type: MessageBarType.error
+        });
     }
     const [major, minor, patch] = version.split('.').map((versionPart) => parseInt(versionPart, 10));
     const label = version.split(/-(.*)/s)?.[1];
@@ -83,8 +93,8 @@ export function isLowerThanMinimalUi5Version(
         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))
+            ui5VersionInfo.minor === minUi5VersionInfo.minor &&
+            (ui5VersionInfo?.patch ?? 0) < (minUi5VersionInfo?.patch ?? 0))
     );
 }
 
@@ -113,10 +123,11 @@ export function isVersionEqualOrHasNewerPatch(
 }
 
 /**
- * Get UI5 version validation message.
- * @param ui5VersionInfo to be mentioned in the message
- * @returns string with validation message.
+ * Returns the fully qualified UI5 version string - major and minor version concatenated.
+ *
+ * @param {Ui5VersionInfo} ui5VersionInfo - The ui5 version info object containing major and minor version.
+ * @returns {string} The fully qualified UI5 version string.
  */
-export function getUI5VersionValidationMessage(ui5VersionInfo: Ui5VersionInfo): string {
-    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}`;
+export function getFullyQualifiedUi5Version(ui5VersionInfo: Ui5VersionInfo): string {
+    return `${ui5VersionInfo.major}.${ui5VersionInfo.minor}`;
 }

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.73",
+  "version": "0.21.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -25,13 +25,13 @@
     "ejs": "3.1.10",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/adp-tooling": "0.15.10",
+    "@sap-ux/adp-tooling": "0.15.12",
     "@sap-ux/btp-utils": "1.1.0",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.6.8",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.7.0",
     "@sap-ux/feature-toggle": "0.3.0",
     "@sap-ux/logger": "0.7.0",
-    "@sap-ux/project-access": "1.30.9",
-    "@sap-ux/system-access": "0.6.11",
+    "@sap-ux/project-access": "1.30.10",
+    "@sap-ux/system-access": "0.6.12",
     "@sap-ux/i18n": "0.3.2"
   },
   "devDependencies": {
@@ -50,8 +50,8 @@
     "nock": "13.4.0",
     "npm-run-all2": "6.2.0",
     "supertest": "7.1.4",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.14.11",
-    "@sap-ux/axios-extension": "1.22.4",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.15.0",
+    "@sap-ux/axios-extension": "1.22.5",
     "@sap-ux/store": "1.1.2",
     "@sap-ux/ui5-info": "0.12.1"
   },