@sap-ux/preview-middleware 0.23.48 → 0.23.50

package/dist/client/utils/info-center-message.js

@@ -1,33 +1,61 @@
-'use strict';
-sap.ui.define([
-    'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
-    '../cpe/communication-service',
-    '../i18n'
-], function (___sap_ux_private_control_property_editor_common, ___cpe_communication_service, ___i18n) {
-    'use strict';
-    const showInfoCenterMessage = ___sap_ux_private_control_property_editor_common['showInfoCenterMessage'];
-    const CommunicationService = ___cpe_communication_service['CommunicationService'];
-    const getTextBundle = ___i18n['getTextBundle'];
-    async function sendInfoCenterMessage(_ref) {
-        let {title, description, details, type} = _ref;
-        CommunicationService.sendAction(showInfoCenterMessage({
-            title: await getTranslation(title),
-            description: await getTranslation(description),
-            details: await getTranslation(details),
-            type
-        }));
+"use strict";
+
+sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../cpe/communication-service", "../i18n"], function (___sap_ux_private_control_property_editor_common, ___cpe_communication_service, ___i18n) {
+  "use strict";
+
+  const showInfoCenterMessage = ___sap_ux_private_control_property_editor_common["showInfoCenterMessage"];
+  const CommunicationService = ___cpe_communication_service["CommunicationService"];
+  const getTextBundle = ___i18n["getTextBundle"];
+  /**
+   * Localization key interface for defining message keys and optional parameters.
+   */
+  /**
+   * InfoCenterMessage interface for defining the structure of an Info center message.
+   * It includes title, description, optional details, and type.
+   */
+  /**
+   * Shows a localized/plain string message in the Info center.
+   *
+   * @param {InfoCenterMessage} message - The message object containing title, description,
+   * details and type for the message. Each text in the message can be localized or
+   * left as a plain string.
+   */
+  async function sendInfoCenterMessage(_ref) {
+    let {
+      title,
+      description,
+      details,
+      type
+    } = _ref;
+    CommunicationService.sendAction(showInfoCenterMessage({
+      title: await getTranslation(title),
+      description: await getTranslation(description),
+      details: await getTranslation(details),
+      type
+    }));
+  }
+
+  /**
+   * Util function which returns translation for a localization key or a plain string.
+   * If the value is undefined, it returns undefined.
+   *
+   * @param {LocalizationKey | string | undefined} value - The localization key, plain string or undefined.
+   * @returns {Promise<string>} A promise that resolves to the translated string.
+   */
+  async function getTranslation(value) {
+    if (value === undefined) {
+      return undefined;
     }
-    async function getTranslation(value) {
-        if (value === undefined) {
-            return undefined;
-        }
-        if (typeof value === 'string') {
-            return value;
-        }
-        const bundle = await getTextBundle();
-        return bundle.getText(value.key, value.params);
+    if (typeof value === 'string') {
+      return value;
     }
-    var __exports = { __esModule: true };
-    __exports.sendInfoCenterMessage = sendInfoCenterMessage;
-    return __exports;
-});
+    const bundle = await getTextBundle();
+    return bundle.getText(value.key, value.params);
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.sendInfoCenterMessage = sendInfoCenterMessage;
+  return __exports;
+});
+//# sourceMappingURL=info-center-message.js.map

package/dist/client/utils/version.js

@@ -1,74 +1,130 @@
-'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 (Number.isNaN(versionInfo.major) || Number.isNaN(versionInfo.minor) || Number.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');
-        }
-    }
-    async function getUi5Version() {
-        let library = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'sap.ui.core';
-        const versionInfo = await VersionInfo.load();
-        let version = versionInfo?.libraries?.find(lib => lib.name === library)?.version;
-        const isCdn = versionInfo?.name === 'SAPUI5 Distribution';
-        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 => Number.parseInt(versionPart, 10));
-        const label = version.split(/-(.*)/s)?.[1];
-        return {
-            major,
-            minor,
-            patch,
-            label,
-            isCdn
-        };
-    }
-    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);
+"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"];
+  /**
+   * 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 (Number.isNaN(versionInfo.major) || Number.isNaN(versionInfo.minor) || Number.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');
     }
-    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);
+  }
+
+  /**
+   * 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';
+    const versionInfo = await VersionInfo.load();
+    let version = versionInfo?.libraries?.find(lib => lib.name === library)?.version;
+    const isCdn = versionInfo?.name === 'SAPUI5 Distribution';
+    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
+      });
     }
-    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;
-});
+    const [major, minor, patch] = version.split('.').map(versionPart => Number.parseInt(versionPart, 10));
+    const label = version.split(/-(.*)/s)?.[1];
+    return {
+      major,
+      minor,
+      patch,
+      label,
+      isCdn
+    };
+  }
+
+  /**
+   * 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);
+  }
+
+  /**
+   * 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.
+   */
+  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;
+});
+//# 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.23.48",
+  "version": "0.23.50",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,7 +27,7 @@
     "mem-fs-editor": "9.4.0",
     "qrcode": "1.5.4",
     "@sap/bas-sdk": "3.12.0",
-    "@sap-ux/adp-tooling": "0.17.7",
+    "@sap-ux/adp-tooling": "0.17.8",
     "@sap-ux/btp-utils": "1.1.5",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.7.2",
     "@sap-ux/feature-toggle": "0.3.4",
@@ -53,10 +53,10 @@
     "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.17.3",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.17.4",
     "@sap-ux/axios-extension": "1.24.2",
     "@sap-ux/store": "1.3.3",
-    "@sap-ux/ui5-info": "0.13.1"
+    "@sap-ux/ui5-info": "0.13.2"
   },
   "peerDependencies": {
     "express": "4"