@sap-ux/preview-middleware 0.16.117 → 0.16.118

package/dist/client/flp/init.js

@@ -7,8 +7,10 @@ sap.ui.define([
     '../adp/api-handler',
     '../utils/error',
     './initConnectors',
-    '../utils/version'
-], function (Log, ___sap_ux_private_control_property_editor_common, IconPool, ResourceBundle, ___adp_api_handler, ___utils_error, __initConnectors, ___utils_version) {
+    '../utils/version',
+    '../cpe/communication-service',
+    '../i18n'
+], function (Log, ___sap_ux_private_control_property_editor_common, IconPool, ResourceBundle, ___adp_api_handler, ___utils_error, __initConnectors, ___utils_version, ___cpe_communication_service, ___i18n) {
     'use strict';
     function _interopRequireDefault(obj) {
         return obj && obj.__esModule && typeof obj.default !== 'undefined' ? obj.default : obj;
@@ -27,11 +29,14 @@ sap.ui.define([
         });
     }
     const SCENARIO = ___sap_ux_private_control_property_editor_common['SCENARIO'];
+    const showMessage = ___sap_ux_private_control_property_editor_common['showMessage'];
     const getManifestAppdescr = ___adp_api_handler['getManifestAppdescr'];
     const getError = ___utils_error['getError'];
     const initConnectors = _interopRequireDefault(__initConnectors);
     const getUi5Version = ___utils_version['getUi5Version'];
     const isLowerThanMinimalUi5Version = ___utils_version['isLowerThanMinimalUi5Version'];
+    const CommunicationService = ___cpe_communication_service['CommunicationService'];
+    const getTextBundle = ___i18n['getTextBundle'];
     const UI5_LIBS = [
         'sap.apf',
         'sap.base',
@@ -202,7 +207,11 @@ sap.ui.define([
                         flexSettings
                     };
                     sap.ui.require(libs, async function (startAdaptation, pluginScript) {
-                        await startAdaptation(options, pluginScript);
+                        try {
+                            await startAdaptation(options, pluginScript);
+                        } catch (error) {
+                            await handleHigherLayerChanges(error, ui5VersionInfo);
+                        }
                     });
                 });
             });
@@ -234,6 +243,23 @@ sap.ui.define([
             Log.error('Sandbox initialization failed: ' + error.message);
         });
     }
+    async function handleHigherLayerChanges(error, ui5VersionInfo) {
+        const err = getError(error);
+        if (err.message.includes('Reload triggered')) {
+            if (!isLowerThanMinimalUi5Version(ui5VersionInfo, {
+                    major: 1,
+                    minor: 84
+                })) {
+                const bundle = await getTextBundle();
+                const action = showMessage({
+                    message: bundle.getText('HIGHER_LAYER_CHANGES_INFO_MESSAGE'),
+                    shouldHideIframe: false
+                });
+                CommunicationService.sendAction(action);
+            }
+            window.location.reload();
+        }
+    }
     var __exports = { __esModule: true };
     __exports.resetAppState = resetAppState;
     __exports.registerComponentDependencyPaths = registerComponentDependencyPaths;
@@ -241,5 +267,6 @@ sap.ui.define([
     __exports.loadI18nResourceBundle = loadI18nResourceBundle;
     __exports.setI18nTitle = setI18nTitle;
     __exports.init = init;
+    __exports.handleHigherLayerChanges = handleHigherLayerChanges;
     return __exports;
 });

package/dist/client/flp/init.ts

@@ -1,7 +1,7 @@
 import Log from 'sap/base/Log';
 import type AppLifeCycle from 'sap/ushell/services/AppLifeCycle';
 import type { InitRtaScript, RTAPlugin, StartAdaptation } from 'sap/ui/rta/api/startAdaptation';
-import { SCENARIO, type Scenario } from '@sap-ux-private/control-property-editor-common';
+import { SCENARIO, showMessage, type Scenario } from '@sap-ux-private/control-property-editor-common';
 import type { FlexSettings, RTAOptions } from 'sap/ui/rta/RuntimeAuthoring';
 import IconPool from 'sap/ui/core/IconPool';
 import ResourceBundle from 'sap/base/i18n/ResourceBundle';
@@ -9,7 +9,9 @@ import AppState from 'sap/ushell/services/AppState';
 import { getManifestAppdescr } from '../adp/api-handler';
 import { getError } from '../utils/error';
 import initConnectors from './initConnectors';
-import { getUi5Version, isLowerThanMinimalUi5Version } from '../utils/version';
+import { getUi5Version, isLowerThanMinimalUi5Version, Ui5VersionInfo } from '../utils/version';
+import { CommunicationService } from '../cpe/communication-service';
+import { getTextBundle } from '../i18n';
 
 /**
  * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
@@ -304,7 +306,11 @@ export async function init({
                     libs,
                     // eslint-disable-next-line no-shadow
                     async function (startAdaptation: StartAdaptation | InitRtaScript, pluginScript: RTAPlugin) {
-                        await startAdaptation(options, pluginScript);
+                        try {
+                            await startAdaptation(options, pluginScript);
+                        } catch (error) {
+                            await handleHigherLayerChanges(error, ui5VersionInfo);
+                        }
                     }
                 );
             });
@@ -318,7 +324,7 @@ export async function init({
 
     // Load custom library paths if configured
     if (appUrls) {
-        await registerComponentDependencyPaths(JSON.parse(appUrls) as string[] ?? [], urlParams);
+        await registerComponentDependencyPaths((JSON.parse(appUrls) as string[]) ?? [], urlParams);
     }
 
     // Load rta connector
@@ -351,3 +357,28 @@ if (bootstrapConfig) {
         Log.error('Sandbox initialization failed: ' + error.message);
     });
 }
+
+/**
+ * Handle higher layer changes when starting UI Adaptation.
+ * When RTA detects higher layer changes an error with Reload triggered text is thrown, the RTA instance is destroyed and the application is reloaded.
+ * For UI5 version lower than 1.84.0 RTA is showing a popup with notification text about the detection of higher layer changes.
+ *
+ * @param error the error thrown when there are higher layer changes when starting UI Adaptation.
+ * @param ui5VersionInfo ui5 version info
+ */
+export async function handleHigherLayerChanges(error: unknown, ui5VersionInfo: Ui5VersionInfo): Promise<void> {
+    const err = getError(error);
+    if (err.message.includes('Reload triggered')) {
+        if (!isLowerThanMinimalUi5Version(ui5VersionInfo, { major: 1, minor: 84 })) {
+            const bundle = await getTextBundle();
+            const action = showMessage({
+                message: bundle.getText('HIGHER_LAYER_CHANGES_INFO_MESSAGE'),
+                shouldHideIframe: false
+            });
+            CommunicationService.sendAction(action);
+        }
+
+        // eslint-disable-next-line fiori-custom/sap-no-location-reload
+        window.location.reload();
+    }
+}

package/dist/client/messagebundle.properties

@@ -37,3 +37,5 @@ ADP_REUSE_COMPONENTS_MESSAGE = Reuse components are detected for some views in t
 CPE_CHANGES_VISIBLE_AFTER_SAVE_AND_RELOAD_MESSAGE = Note: The change will be visible after save and reload. 
 
 TABLE_ROWS_NEEDED_TO_CREATE_CUSTOM_COLUMN=At least one table row is required to create new custom column. Make sure the table data is loaded and try again.
+
+HIGHER_LAYER_CHANGES_INFO_MESSAGE=The preview of the project was reloaded due to detected changes in higher layer than the one used in your project.

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.117",
+  "version": "0.16.118",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -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.30",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.31",
     "@sap-ux/axios-extension": "1.17.2",
     "@sap-ux/store": "0.9.3",
     "@sap-ux/ui5-info": "0.8.3",