@sap-ux/preview-middleware 0.16.66 → 0.16.68

package/dist/client/cpe/changes/service.js

@@ -4,8 +4,10 @@ sap.ui.define([
     './flex-change',
     'sap/base/Log',
     '../rta-service',
-    '../../utils/error'
-], function (___sap_ux_private_control_property_editor_common, ___flex_change, Log, ___rta_service, ____utils_error) {
+    '../../utils/error',
+    'sap/m/MessageToast',
+    '../../i18n'
+], function (___sap_ux_private_control_property_editor_common, ___flex_change, Log, ___rta_service, ____utils_error, MessageToast, ____i18n) {
     'use strict';
     const changeProperty = ___sap_ux_private_control_property_editor_common['changeProperty'];
     const changeStackModified = ___sap_ux_private_control_property_editor_common['changeStackModified'];
@@ -13,9 +15,12 @@ sap.ui.define([
     const propertyChangeFailed = ___sap_ux_private_control_property_editor_common['propertyChangeFailed'];
     const FlexChangesEndPoints = ___sap_ux_private_control_property_editor_common['FlexChangesEndPoints'];
     const reloadApplication = ___sap_ux_private_control_property_editor_common['reloadApplication'];
+    const numberOfChangesRequiringReloadChanged = ___sap_ux_private_control_property_editor_common['numberOfChangesRequiringReloadChanged'];
+    const save = ___sap_ux_private_control_property_editor_common['save'];
     const applyChange = ___flex_change['applyChange'];
     const modeAndStackChangeHandler = ___rta_service['modeAndStackChangeHandler'];
     const getError = ____utils_error['getError'];
+    const getTextBundle = ____i18n['getTextBundle'];
     function assertProperties(properties, target) {
         for (const property of properties) {
             const value = target[property];
@@ -39,6 +44,7 @@ sap.ui.define([
     }
     class ChangeService {
         savedChanges = [];
+        changesRequiringReload = 0;
         constructor(options, selectionService) {
             this.options = options;
             this.selectionService = selectionService;
@@ -69,14 +75,14 @@ sap.ui.define([
                 } else if (deletePropertyChanges.match(action)) {
                     await this.deleteChange(action.payload.controlId, action.payload.propertyName, action.payload.fileName);
                 } else if (reloadApplication.match(action)) {
-                    await this.options.rta.stop(false, true);
+                    this.sendAction(numberOfChangesRequiringReloadChanged(0));
+                } else if (save.match(action)) {
+                    this.changesRequiringReload = 0;
+                    this.sendAction(numberOfChangesRequiringReloadChanged(0));
                 }
             });
             await this.fetchSavedChanges();
             this.updateStack();
-            this.options.rta.attachStop(() => {
-                location.reload();
-            });
             this.options.rta.attachUndoRedoStackModified(this.createOnStackChangeHandler());
         }
         updateStack() {
@@ -171,6 +177,13 @@ sap.ui.define([
                     }
                 });
                 activeChanges = activeChanges.filter(change => !!change);
+                const changesRequiringReload = activeChanges.reduce((sum, change) => change.changeType === 'appdescr_fe_changePageConfiguration' ? sum + 1 : sum, 0);
+                if (changesRequiringReload > this.changesRequiringReload) {
+                    const resourceBundle = await getTextBundle();
+                    MessageToast.show(resourceBundle.getText('CPE_CHANGES_VISIBLE_AFTER_SAVE_AND_RELOAD_MESSAGE'), { duration: 8000 });
+                    this.sendAction(numberOfChangesRequiringReloadChanged(changesRequiringReload));
+                }
+                this.changesRequiringReload = changesRequiringReload;
                 if (Array.isArray(allCommands) && allCommands.length === 0) {
                     await this.fetchSavedChanges();
                 }

package/dist/client/cpe/changes/service.ts

@@ -10,7 +10,9 @@ import {
     deletePropertyChanges,
     propertyChangeFailed,
     FlexChangesEndPoints,
-    reloadApplication
+    reloadApplication,
+    numberOfChangesRequiringReloadChanged,
+    save
 } from '@sap-ux-private/control-property-editor-common';
 import { applyChange } from './flex-change';
 import type { SelectionService } from '../selection';
@@ -21,6 +23,8 @@ import type FlexCommand from 'sap/ui/rta/command/FlexCommand';
 import Log from 'sap/base/Log';
 import { modeAndStackChangeHandler } from '../rta-service';
 import { getError } from '../../utils/error';
+import MessageToast from 'sap/m/MessageToast';
+import { getTextBundle } from '../../i18n';
 
 interface ChangeContent {
     property: string;
@@ -91,6 +95,7 @@ function modifyRTAErrorMessage(errorMessage: string, id: string, type: string):
  */
 export class ChangeService {
     private savedChanges: SavedPropertyChange[] = [];
+    private changesRequiringReload = 0;
     private sendAction: (action: ExternalAction) => void;
     /**
      *
@@ -136,16 +141,16 @@ export class ChangeService {
             } else if (deletePropertyChanges.match(action)) {
                 await this.deleteChange(action.payload.controlId, action.payload.propertyName, action.payload.fileName);
             } else if (reloadApplication.match(action)) {
-                await this.options.rta.stop(false, true);
+                this.sendAction(numberOfChangesRequiringReloadChanged(0));
+            } else if (save.match(action)) {
+                this.changesRequiringReload = 0;
+                this.sendAction(numberOfChangesRequiringReloadChanged(0));
             }
         });
 
         await this.fetchSavedChanges();
         this.updateStack();
-        this.options.rta.attachStop(() => {
-            // eslint-disable-next-line fiori-custom/sap-no-location-reload
-            location.reload();
-        });
+
         this.options.rta.attachUndoRedoStackModified(this.createOnStackChangeHandler());
     }
 
@@ -284,6 +289,18 @@ export class ChangeService {
             });
 
             activeChanges = activeChanges.filter((change): boolean => !!change);
+            const changesRequiringReload = activeChanges.reduce(
+                (sum, change) => (change.changeType === 'appdescr_fe_changePageConfiguration' ? sum + 1 : sum),
+                0
+            );
+            if (changesRequiringReload > this.changesRequiringReload) {
+                const resourceBundle = await getTextBundle();
+                MessageToast.show(resourceBundle.getText('CPE_CHANGES_VISIBLE_AFTER_SAVE_AND_RELOAD_MESSAGE'), {
+                    duration: 8000
+                });
+                this.sendAction(numberOfChangesRequiringReloadChanged(changesRequiringReload));
+            }
+            this.changesRequiringReload = changesRequiringReload;
 
             if (Array.isArray(allCommands) && allCommands.length === 0) {
                 await this.fetchSavedChanges();

package/dist/client/cpe/connector-service.js

@@ -17,29 +17,35 @@ sap.ui.define([
             });
         });
     }
+    const reloadApplication = ___sap_ux_private_control_property_editor_common['reloadApplication'];
     const storageFileChanged = ___sap_ux_private_control_property_editor_common['storageFileChanged'];
     const getUi5Version = ___utils_version['getUi5Version'];
     const isLowerThanMinimalUi5Version = ___utils_version['isLowerThanMinimalUi5Version'];
     class WorkspaceConnectorService {
-        async init(sendAction) {
+        isReloadPending = false;
+        async init(sendAction, subscribe) {
+            this.sendAction = sendAction;
+            subscribe(action => {
+                if (reloadApplication.match(action)) {
+                    this.isReloadPending = true;
+                }
+            });
             if (isLowerThanMinimalUi5Version(await getUi5Version(), {
                     major: 1,
                     minor: 73
                 })) {
                 const FakeLrepConnector = (await __ui5_require_async('sap/ui/fl/FakeLrepConnector')).default;
-                FakeLrepConnector.fileChangeRequestNotifier = notifier(sendAction);
+                FakeLrepConnector.fileChangeRequestNotifier = this.onChangeSaved.bind(this);
             } else {
                 const connector = (await __ui5_require_async('open/ux/preview/client/flp/WorkspaceConnector')).default;
-                connector.storage.fileChangeRequestNotifier = notifier(sendAction);
+                connector.storage.fileChangeRequestNotifier = this.onChangeSaved.bind(this);
             }
         }
-    }
-    function notifier(sendAction) {
-        return (fileName, kind, changeType) => {
-            if (changeType && changeType !== 'appdescr_fe_changePageConfiguration' || kind === 'delete') {
-                sendAction(storageFileChanged(fileName?.replace('sap.ui.fl.', '')));
+        onChangeSaved(fileName, kind, changeType) {
+            if (changeType && changeType !== 'appdescr_fe_changePageConfiguration' || kind === 'delete' || this.isReloadPending) {
+                this.sendAction(storageFileChanged(fileName?.replace('sap.ui.fl.', '')));
             }
-        };
+        }
     }
     var __exports = { __esModule: true };
     __exports.WorkspaceConnectorService = WorkspaceConnectorService;

package/dist/client/cpe/connector-service.ts

@@ -1,32 +1,47 @@
-import { ExternalAction, storageFileChanged } from '@sap-ux-private/control-property-editor-common';
-import { ActionSenderFunction } from './types';
+import { ExternalAction, reloadApplication, storageFileChanged } from '@sap-ux-private/control-property-editor-common';
+import { ActionSenderFunction, SubscribeFunction } from './types';
 import { getUi5Version, isLowerThanMinimalUi5Version } from '../utils/version';
 
 /**
  * A Class of WorkspaceConnectorService
  */
 export class WorkspaceConnectorService {
+    /**
+     * When save and reload is triggered, we do not need special handling for changes that are not directly visible in preview.
+     */
+    private isReloadPending = false;
+    private sendAction: (action: ExternalAction) => void;
     /**
      * Initializes connector service.
      *
      * @param sendAction action sender function
+     * @param subscribe subscriber function
      */
-    public async init(sendAction: ActionSenderFunction): Promise<void> {
+    public async init(sendAction: ActionSenderFunction, subscribe: SubscribeFunction): Promise<void> {
+        this.sendAction = sendAction;
+        subscribe((action): void => {
+            if (reloadApplication.match(action)) {
+                this.isReloadPending = true;
+            }
+        });
+
         if (isLowerThanMinimalUi5Version(await getUi5Version(), { major: 1, minor: 73 })) {
             const FakeLrepConnector = (await import('sap/ui/fl/FakeLrepConnector')).default;
-            FakeLrepConnector.fileChangeRequestNotifier = notifier(sendAction);
+            FakeLrepConnector.fileChangeRequestNotifier = this.onChangeSaved.bind(this);
         } else {
             const connector = (await import('open/ux/preview/client/flp/WorkspaceConnector')).default;
             // hook the file deletion listener to the UI5 workspace connector
-            connector.storage.fileChangeRequestNotifier = notifier(sendAction);
+            connector.storage.fileChangeRequestNotifier = this.onChangeSaved.bind(this);
         }
     }
-}
 
-function notifier(sendAction: (action: ExternalAction) => void) {
-    return (fileName: string, kind: 'delete' | 'create', changeType?: string) => {
-        if ((changeType && changeType !== 'appdescr_fe_changePageConfiguration') || kind === 'delete') {
-            sendAction(storageFileChanged(fileName?.replace('sap.ui.fl.', '')));
+    private onChangeSaved(fileName: string, kind: 'delete' | 'create', changeType?: string) {
+        if (
+            (changeType && changeType !== 'appdescr_fe_changePageConfiguration') ||
+            kind === 'delete' ||
+            this.isReloadPending
+        ) {
+            this.sendAction(storageFileChanged(fileName?.replace('sap.ui.fl.', '')));
         }
-    };
+    }
 }

package/dist/client/cpe/init.js

@@ -46,9 +46,9 @@ sap.ui.define([
         const outlineService = new OutlineService(rta);
         const quickActionService = new QuickActionService(rta, outlineService, registries);
         const services = [
+            connectorService,
             selectionService,
             changesService,
-            connectorService,
             outlineService,
             rtaService,
             quickActionService

package/dist/client/cpe/init.ts

@@ -51,9 +51,9 @@ export default function init(
     const outlineService = new OutlineService(rta);
     const quickActionService = new QuickActionService(rta, outlineService, registries);
     const services: Service[] = [
+        connectorService,
         selectionService,
         changesService,
-        connectorService,
         outlineService,
         rtaService,
         quickActionService

package/dist/client/cpe/rta-service.js

@@ -7,6 +7,7 @@ sap.ui.define(['open/ux/preview/client/thirdparty/@sap-ux-private/control-proper
     const undo = ___sap_ux_private_control_property_editor_common['undo'];
     const redo = ___sap_ux_private_control_property_editor_common['redo'];
     const save = ___sap_ux_private_control_property_editor_common['save'];
+    const reloadApplication = ___sap_ux_private_control_property_editor_common['reloadApplication'];
     class RtaService {
         constructor(rta) {
             this.rta = rta;
@@ -22,17 +23,29 @@ sap.ui.define(['open/ux/preview/client/thirdparty/@sap-ux-private/control-proper
                 if (redo.match(action)) {
                     this.rta.redo();
                 }
-                if (save.match(action)) {
-                    if (this.rta.save) {
-                        this.rta.save();
-                    } else {
-                        this.rta?._serializeToLrep();
+                if (reloadApplication.match(action)) {
+                    if (action.payload.save === true) {
+                        await this.save();
                     }
+                    await this.rta.stop(false, true);
+                }
+                if (save.match(action)) {
+                    await this.save();
                 }
                 return Promise.resolve();
             });
+            this.rta.attachStop(() => {
+                location.reload();
+            });
             this.rta.attachModeChanged(modeAndStackChangeHandler(sendAction, this.rta));
         }
+        save() {
+            if (this.rta.save) {
+                return this.rta.save();
+            } else {
+                return this.rta?._serializeToLrep();
+            }
+        }
     }
     function modeAndStackChangeHandler(sendAction, rta) {
         return () => {

package/dist/client/cpe/rta-service.ts

@@ -5,7 +5,8 @@ import {
     undo,
     redo,
     save,
-    ExternalAction
+    ExternalAction,
+    reloadApplication
 } from '@sap-ux-private/control-property-editor-common';
 import { ActionSenderFunction, SubscribeFunction } from './types';
 import RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
@@ -37,20 +38,35 @@ export class RtaService {
             if (redo.match(action)) {
                 this.rta.redo();
             }
+            if (reloadApplication.match(action)) {
+                if (action.payload.save === true) {
+                    await this.save();
+                }
+                await this.rta.stop(false, true);
+            }
 
             if (save.match(action)) {
-                if (this.rta.save) {
-                    // v1.107.x and above
-                    this.rta.save();
-                } else {
-                    // v1.71.x and above
-                    this.rta?._serializeToLrep();
-                }
+                await this.save();
             }
             return Promise.resolve();
         });
+
+        this.rta.attachStop(() => {
+            // eslint-disable-next-line fiori-custom/sap-no-location-reload
+            location.reload();
+        });
         this.rta.attachModeChanged(modeAndStackChangeHandler(sendAction, this.rta));
     }
+
+    private save(): Promise<void> {
+        if (this.rta.save) {
+            // v1.107.x and above
+            return this.rta.save();
+        } else {
+            // v1.71.x and above
+            return this.rta?._serializeToLrep();
+        }
+    }
 }
 
 export function modeAndStackChangeHandler(sendAction: (action: ExternalAction) => void, rta: RuntimeAuthoring) {

package/dist/client/cpe/types.ts

@@ -32,7 +32,7 @@ export interface UI5ControlData {
     type: string;
 }
 
-export type ActionHandler = (action: ExternalAction) => Promise<void>;
+export type ActionHandler = (action: ExternalAction) => void | Promise<void>;
 export type ActionSenderFunction = (action: ExternalAction) => void;
 export type SubscribeFunction = (handler: ActionHandler) => void;
 export type UnSubscribeFunction = (handler: ActionHandler) => void;

package/dist/client/messagebundle.properties

@@ -16,3 +16,5 @@ V4_QUICK_ACTION_LR_DISABLE_CLEAR_FILTER_BAR=Disable "Clear" Button in Filter Bar
 
 ADP_SYNC_VIEWS_MESSAGE = Have in mind that synchronous views are detected for this application and controller extensions are not supported for such views. Controller extension functionality on these views will be disabled.
 ADP_REUSE_COMPONENTS_MESSAGE = Have in mind that reuse components are detected for some views in this application and controller extensions and adding fragments are not supported for such views. Controller extension and adding fragment functionality on these views will be disabled.
+
+CPE_CHANGES_VISIBLE_AFTER_SAVE_AND_RELOAD_MESSAGE = Note: The change will be visible after save and reload. 

package/dist/client/thirdparty/@sap-ux-private/control-property-editor-common.js

@@ -8,7 +8,7 @@ sap.ui.define((function () { 'use strict';
 
 	(function (exports) {
 		Object.defineProperty(exports, "__esModule", { value: true });
-		exports.executeQuickAction = exports.updateQuickAction = exports.quickActionListChanged = exports.save = exports.redo = exports.undo = exports.appLoaded = exports.setSaveEnablement = exports.setUndoRedoEnablement = exports.setAppMode = exports.storageFileChanged = exports.reloadApplication = exports.showMessage = exports.changeStackModified = exports.propertyChangeFailed = exports.propertyChanged = exports.changeProperty = exports.outlineChanged = exports.deletePropertyChanges = exports.addExtensionPoint = exports.selectControl = exports.controlSelected = exports.iconsLoaded = exports.EXTERNAL_ACTION_PREFIX = exports.NESTED_QUICK_ACTION_KIND = exports.SIMPLE_QUICK_ACTION_KIND = exports.UNKNOWN_CHANGE_KIND = exports.PROPERTY_CHANGE_KIND = exports.SAVED_CHANGE_TYPE = exports.PENDING_CHANGE_TYPE = exports.SCENARIO = exports.CHECKBOX_EDITOR_TYPE = exports.DROPDOWN_EDITOR_TYPE = exports.INPUT_EDITOR_TYPE = exports.STRING_VALUE_TYPE = exports.FLOAT_VALUE_TYPE = exports.INTEGER_VALUE_TYPE = exports.BOOLEAN_VALUE_TYPE = void 0;
+		exports.numberOfChangesRequiringReloadChanged = exports.executeQuickAction = exports.updateQuickAction = exports.quickActionListChanged = exports.save = exports.redo = exports.undo = exports.appLoaded = exports.setSaveEnablement = exports.setUndoRedoEnablement = exports.setAppMode = exports.storageFileChanged = exports.reloadApplication = exports.showMessage = exports.changeStackModified = exports.propertyChangeFailed = exports.propertyChanged = exports.changeProperty = exports.outlineChanged = exports.deletePropertyChanges = exports.addExtensionPoint = exports.selectControl = exports.controlSelected = exports.iconsLoaded = exports.EXTERNAL_ACTION_PREFIX = exports.NESTED_QUICK_ACTION_KIND = exports.SIMPLE_QUICK_ACTION_KIND = exports.UNKNOWN_CHANGE_KIND = exports.PROPERTY_CHANGE_KIND = exports.SAVED_CHANGE_TYPE = exports.PENDING_CHANGE_TYPE = exports.SCENARIO = exports.CHECKBOX_EDITOR_TYPE = exports.DROPDOWN_EDITOR_TYPE = exports.INPUT_EDITOR_TYPE = exports.STRING_VALUE_TYPE = exports.FLOAT_VALUE_TYPE = exports.INTEGER_VALUE_TYPE = exports.BOOLEAN_VALUE_TYPE = void 0;
 		exports.BOOLEAN_VALUE_TYPE = 'boolean';
 		exports.INTEGER_VALUE_TYPE = 'integer';
 		exports.FLOAT_VALUE_TYPE = 'float';
@@ -90,6 +90,7 @@ sap.ui.define((function () { 'use strict';
 		exports.quickActionListChanged = createExternalAction('quick-action-list-changed');
 		exports.updateQuickAction = createExternalAction('update-quick-action');
 		exports.executeQuickAction = createExternalAction('execute-quick-action');
+		exports.numberOfChangesRequiringReloadChanged = createExternalAction('number-of-changes-requiring-reload-changed');
 		
 	} (api));
 

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.66",
+  "version": "0.16.68",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -25,10 +25,10 @@
     "ejs": "3.1.10",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/btp-utils": "0.15.2",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/adp-tooling": "0.12.49",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.5",
+    "@sap-ux/btp-utils": "0.15.2",
+    "@sap-ux/adp-tooling": "0.12.50",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.5.7",
     "@sap-ux/project-access": "1.27.3"
   },
   "devDependencies": {
@@ -45,7 +45,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.4",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.11.5",
     "@sap-ux/axios-extension": "1.16.6",
     "@sap-ux/store": "0.9.1",
     "@sap-ux/ui5-info": "0.8.1",