@sap-ux/preview-middleware 0.13.28 → 0.13.30

package/dist/client/adp/init-dialogs.js

@@ -1,6 +1,6 @@
 "use strict";
 
-sap.ui.define(["sap/ui/core/Fragment", "./controllers/AddFragment.controller", "./controllers/ControllerExtension.controller", "./controllers/ExtensionPoint.controller"], function (Fragment, __AddFragment, __ControllerExtension, __ExtensionPoint) {
+sap.ui.define(["sap/ui/core/Fragment", "sap/ui/fl/Utils", "./controllers/AddFragment.controller", "./controllers/ControllerExtension.controller", "./controllers/ExtensionPoint.controller"], function (Fragment, FlUtils, __AddFragment, __ControllerExtension, __ExtensionPoint) {
   "use strict";
 
   function _interopRequireDefault(obj) {
@@ -19,8 +19,9 @@ sap.ui.define(["sap/ui/core/Fragment", "./controllers/AddFragment.controller", "
    * Adds a new item to the context menu
    *
    * @param rta Runtime Authoring
+   * @param syncViewsIds Ids of all application sync views
    */
-  const initDialogs = rta => {
+  const initDialogs = (rta, syncViewsIds) => {
     const contextMenu = rta.getDefaultPlugins().contextMenu;
     contextMenu.addMenuItem({
       id: 'ADD_FRAGMENT',
@@ -32,10 +33,24 @@ sap.ui.define(["sap/ui/core/Fragment", "./controllers/AddFragment.controller", "
       id: 'EXTEND_CONTROLLER',
       text: 'Extend With Controller',
       handler: async overlays => await handler(overlays[0], rta, DialogNames.CONTROLLER_EXTENSION),
-      icon: 'sap-icon://create-form'
+      icon: 'sap-icon://create-form',
+      enabled: overlays => isControllerExtensionEnabled(overlays, syncViewsIds)
     });
   };
 
+  /**
+   * Handler for enablement of Extend With Controller context menu entry
+   *
+   * @param overlays Control overlays
+   * @param syncViewsIds Runtime Authoring
+   *
+   * @returns boolean 
+   */
+  const isControllerExtensionEnabled = (overlays, syncViewsIds) => {
+    const clickedControlId = FlUtils.getViewForControl(overlays[0].getElement()).getId();
+    return overlays.length <= 1 && !syncViewsIds.includes(clickedControlId);
+  };
+
   /**
    * Handler for new context menu entry
    *
@@ -70,6 +85,7 @@ sap.ui.define(["sap/ui/core/Fragment", "./controllers/AddFragment.controller", "
   };
   __exports.DialogNames = DialogNames;
   __exports.initDialogs = initDialogs;
+  __exports.isControllerExtensionEnabled = isControllerExtensionEnabled;
   __exports.handler = handler;
   return __exports;
 });

package/dist/client/adp/init-dialogs.ts

@@ -3,11 +3,16 @@ import type Dialog from 'sap/m/Dialog';
 
 /** sap.ui.core */
 import Fragment from 'sap/ui/core/Fragment';
-import type UI5Element from 'sap/ui/core/Element';
+import UI5Element from 'sap/ui/core/Element';
 
 /** sap.ui.rta */
 import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 
+/** sap.ui.fl */
+import FlUtils from 'sap/ui/fl/Utils';
+
+import ElementOverlay from 'sap/ui/dt/ElementOverlay';
+
 import AddFragment from './controllers/AddFragment.controller';
 import ControllerExtension from './controllers/ControllerExtension.controller';
 import { ExtensionPointData } from './extension-point';
@@ -25,8 +30,9 @@ type Controller = AddFragment | ControllerExtension | ExtensionPoint;
  * Adds a new item to the context menu
  *
  * @param rta Runtime Authoring
+ * @param syncViewsIds Ids of all application sync views
  */
-export const initDialogs = (rta: RuntimeAuthoring): void => {
+export const initDialogs = (rta: RuntimeAuthoring, syncViewsIds: string[]): void => {
     const contextMenu = rta.getDefaultPlugins().contextMenu;
 
     contextMenu.addMenuItem({
@@ -40,10 +46,25 @@ export const initDialogs = (rta: RuntimeAuthoring): void => {
         id: 'EXTEND_CONTROLLER',
         text: 'Extend With Controller',
         handler: async (overlays: UI5Element[]) => await handler(overlays[0], rta, DialogNames.CONTROLLER_EXTENSION),
-        icon: 'sap-icon://create-form'
+        icon: 'sap-icon://create-form',
+        enabled: (overlays: ElementOverlay[]) => isControllerExtensionEnabled(overlays, syncViewsIds)
     });
 };
 
+/**
+ * Handler for enablement of Extend With Controller context menu entry
+ *
+ * @param overlays Control overlays
+ * @param syncViewsIds Runtime Authoring
+ *
+ * @returns boolean 
+ */
+export const isControllerExtensionEnabled = (overlays: ElementOverlay[], syncViewsIds: string[]): boolean => {
+    const clickedControlId = FlUtils.getViewForControl(overlays[0].getElement()).getId();
+
+    return overlays.length <= 1 && !syncViewsIds.includes(clickedControlId);
+};
+
 /**
  * Handler for new context menu entry
  *

package/dist/client/adp/init.js

@@ -1,12 +1,13 @@
 'use strict';
 sap.ui.define([
     'sap/base/Log',
+    'sap/ui/core/ElementRegistry',
     '../cpe/init',
     './init-dialogs',
     'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
     'sap/ui/VersionInfo',
     './ui5-version-utils'
-], function (log, __init, ___init_dialogs, ___sap_ux_private_control_property_editor_common, VersionInfo, ___ui5_version_utils) {
+], function (log, UI5ElementRegistry, __init, ___init_dialogs, ___sap_ux_private_control_property_editor_common, VersionInfo, ___ui5_version_utils) {
     'use strict';
     function _interopRequireDefault(obj) {
         return obj && obj.__esModule && typeof obj.default !== 'undefined' ? obj.default : obj;
@@ -51,7 +52,8 @@ sap.ui.define([
                 }
             }
         });
-        initDialogs(rta);
+        const syncViewsIds = getAllSyncViewsIds();
+        initDialogs(rta, syncViewsIds);
         if (minor > 77) {
             const ExtensionPointService = (await __ui5_require_async('open/ux/preview/client/adp/extension-point')).default;
             const extPointService = new ExtensionPointService(rta);
@@ -60,9 +62,30 @@ sap.ui.define([
         await init(rta);
         const ui5VersionValidationMsg = getUI5VersionValidationMessage(version);
         if (ui5VersionValidationMsg) {
-            sendAction(showMessage(ui5VersionValidationMsg));
+            sendAction(showMessage({
+                message: ui5VersionValidationMsg,
+                shouldHideIframe: true
+            }));
+            return;
+        }
+        if (syncViewsIds.length > 0) {
+            sendAction(showMessage({
+                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.',
+                shouldHideIframe: false
+            }));
         }
         log.debug('ADP init executed.');
     };
+    function getAllSyncViewsIds() {
+        const elements = UI5ElementRegistry.all();
+        const syncViewIds = [];
+        Object.entries(elements).forEach(_ref => {
+            let [key, ui5Element] = _ref;
+            if (ui5Element?.getMetadata()?.getName()?.includes('XMLView') && ui5Element?.oAsyncState === undefined) {
+                syncViewIds.push(key);
+            }
+        });
+        return syncViewIds;
+    }
     return __exports;
 });

package/dist/client/adp/init.ts

@@ -1,5 +1,6 @@
 import log from 'sap/base/Log';
 import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+import UI5ElementRegistry from 'sap/ui/core/ElementRegistry';
 
 import init from '../cpe/init';
 import { initDialogs } from './init-dialogs';
@@ -13,6 +14,7 @@ import {
 import { ActionHandler } from '../cpe/types';
 import VersionInfo from 'sap/ui/VersionInfo';
 import { getUI5VersionValidationMessage } from './ui5-version-utils';
+import UI5Element from 'sap/ui/dt/Element';
 
 export default async function (rta: RuntimeAuthoring) {
     const { version } = (await VersionInfo.load()) as { version: string };
@@ -44,23 +46,50 @@ export default async function (rta: RuntimeAuthoring) {
         }
     );
 
-    // initialize fragment content menu entry
-    initDialogs(rta);
+    const syncViewsIds = getAllSyncViewsIds();
+    initDialogs(rta, syncViewsIds);
 
-    // initialize extension point service
     if (minor > 77) {
         const ExtensionPointService = (await import('open/ux/preview/client/adp/extension-point')).default;
         const extPointService = new ExtensionPointService(rta);
         extPointService.init(subscribe);
     }
 
-    // also initialize the editor
     await init(rta);
-
     const ui5VersionValidationMsg = getUI5VersionValidationMessage(version);
 
     if (ui5VersionValidationMsg) {
-        sendAction(showMessage(ui5VersionValidationMsg));
+        sendAction(showMessage({ message: ui5VersionValidationMsg, shouldHideIframe: true }));
+
+        return;
     }
+    if (syncViewsIds.length > 0) {
+        sendAction(
+            showMessage({
+                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.',
+                shouldHideIframe: false
+            })
+        );
+    }
+
     log.debug('ADP init executed.');
 }
+
+/**
+ *
+ * Get Ids for all sync views
+ *
+ * @returns array of Ids for application sync views
+ */
+function getAllSyncViewsIds(): string[] {
+    const elements = UI5ElementRegistry.all() as Record<string, UI5Element>;
+    const syncViewIds: string[] = [];
+    Object.entries(elements).forEach(([key, ui5Element]) => {
+        if (ui5Element?.getMetadata()?.getName()?.includes('XMLView') && ui5Element?.oAsyncState === undefined) {
+            syncViewIds.push(key);
+        }
+    });
+
+    return syncViewIds;
+}

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.13.28",
+  "version": "0.13.30",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,8 +27,8 @@
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.5.1",
     "@sap-ux/btp-utils": "0.14.4",
-    "@sap-ux/adp-tooling": "0.9.27",
-    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.19",
+    "@sap-ux/adp-tooling": "0.9.28",
+    "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.20",
     "@sap-ux/project-access": "1.19.14"
   },
   "devDependencies": {
@@ -45,8 +45,8 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.0.3",
     "dotenv": "16.3.1",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.8",
-    "@sap-ux/axios-extension": "1.12.0",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.9",
+    "@sap-ux/axios-extension": "1.12.1",
     "@sap-ux/store": "0.5.0",
     "@sap-ux/i18n": "0.0.6"
   },