@sap/ux-ui5-tooling 1.20.4 → 1.22.0

package/dist/preview-middleware/dist/client/cpe/communication-service.js

@@ -0,0 +1,44 @@
+"use strict";
+
+sap.ui.define(["sap/base/Log", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/error"], function (Log, ___sap_ux_private_control_property_editor_common, ___utils_error) {
+  "use strict";
+
+  const startPostMessageCommunication = ___sap_ux_private_control_property_editor_common["startPostMessageCommunication"];
+  const getError = ___utils_error["getError"];
+  class CommunicationService {
+    /**
+     * Sends an action to the CPE.
+     */
+
+    static actionHandlers = [];
+    static {
+      const {
+        sendAction
+      } = startPostMessageCommunication(window.parent, async action => {
+        for (const handler of this.actionHandlers) {
+          try {
+            await handler(action);
+          } catch (error) {
+            Log.error('Handler Failed: ', getError(error));
+          }
+        }
+      });
+      this.sendAction = sendAction;
+    }
+
+    /**
+     * Creates a listener to receive actions from the CPE.
+     *
+     * @param handler - Action handler.
+     */
+    static subscribe(handler) {
+      this.actionHandlers.push(handler);
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.CommunicationService = CommunicationService;
+  return __exports;
+});
+//# sourceMappingURL=communication-service.js.map

package/dist/preview-middleware/dist/client/cpe/communication-service.ts

@@ -0,0 +1,41 @@
+import Log from 'sap/base/Log';
+
+import type { ExternalAction } from '@sap-ux-private/control-property-editor-common';
+import { startPostMessageCommunication } from '@sap-ux-private/control-property-editor-common';
+
+import { getError } from '../utils/error';
+
+import type { ActionHandler } from './types';
+
+export class CommunicationService {
+    /**
+     * Sends an action to the CPE.
+     */
+    static sendAction: (action: ExternalAction) => void;
+    private static readonly actionHandlers: ActionHandler[] = [];
+
+    static {
+        const { sendAction } = startPostMessageCommunication<ExternalAction>(
+            window.parent,
+            async (action: ExternalAction) => {
+                for (const handler of this.actionHandlers) {
+                    try {
+                        await handler(action);
+                    } catch (error) {
+                        Log.error('Handler Failed: ', getError(error));
+                    }
+                }
+            }
+        );
+        this.sendAction = sendAction;
+    }
+
+    /**
+     * Creates a listener to receive actions from the CPE.
+     *
+     * @param handler - Action handler.
+     */
+    static subscribe(handler: ActionHandler): void {
+        this.actionHandlers.push(handler);
+    }
+}

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

@@ -0,0 +1,88 @@
+"use strict";
+
+sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../utils/version"], function (___sap_ux_private_control_property_editor_common, ___utils_version) {
+  "use strict";
+
+  function __ui5_require_async(path) {
+    return new Promise(function (resolve, reject) {
+      sap.ui.require([path], function (module) {
+        if (!(module && module.__esModule)) {
+          module = module === null || !(typeof module === "object" && path.endsWith("/library")) ? {
+            default: module
+          } : module;
+          Object.defineProperty(module, "__esModule", {
+            value: true
+          });
+        }
+        resolve(module);
+      }, function (err) {
+        reject(err);
+      });
+    });
+  }
+  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"];
+  /**
+   * A Class of WorkspaceConnectorService
+   */
+  class WorkspaceConnectorService {
+    /**
+     * When save and reload is triggered, we do not need special handling for changes that are not directly visible in preview.
+     */
+    isReloadPending = false;
+    /**
+     * Initializes connector service.
+     *
+     * @param sendAction action sender function
+     * @param subscribe subscriber function
+     */
+    async init(sendAction, subscribe) {
+      this.sendAction = sendAction;
+      subscribe(action => {
+        if (reloadApplication.match(action)) {
+          this.isReloadPending = true;
+        }
+      });
+      const ui5Version = await getUi5Version();
+      if (isLowerThanMinimalUi5Version(ui5Version, {
+        major: 1,
+        minor: 84
+      })) {
+        if (ui5Version.isCdn) {
+          const FakeLrepConnector = (await __ui5_require_async('sap/ui/fl/FakeLrepConnector')).default;
+          FakeLrepConnector.fileChangeRequestNotifier = this.onChangeSaved.bind(this);
+        } else {
+          // For UI5 versions below 1.84 served from npmjs, we do not support any connector service
+          return;
+        }
+      } else {
+        const connector = (await __ui5_require_async('open/ux/preview/client/flp/WorkspaceConnector')).default;
+        // hook the file deletion listener to the UI5 workspace connector
+        connector.storage.fileChangeRequestNotifier = this.onChangeSaved.bind(this);
+      }
+    }
+    onChangeSaved(fileName, kind, change = {}, additionalChangeInfo = {}) {
+      const {
+        changeType,
+        content
+      } = change;
+      if (changeType && !['appdescr_fe_changePageConfiguration', 'appdescr_ui_generic_app_changePageConfiguration'].includes(changeType) || kind === 'delete' || this.isReloadPending) {
+        this.sendAction(storageFileChanged(fileName?.replace('sap.ui.fl.', '')));
+      }
+      if (changeType === 'addXML' && additionalChangeInfo?.templateName && content?.fragmentPath) {
+        // If there is template available, then we save and reload right away,
+        // so we should ignore the first file change event that comes for the fragment.
+        // (We don't want to show "Reload" button)
+        this.sendAction(storageFileChanged(content.fragmentPath));
+      }
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.WorkspaceConnectorService = WorkspaceConnectorService;
+  return __exports;
+});
+//# sourceMappingURL=connector-service.js.map

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

@@ -0,0 +1,74 @@
+import type { ExternalAction } from '@sap-ux-private/control-property-editor-common';
+import { reloadApplication, storageFileChanged } from '@sap-ux-private/control-property-editor-common';
+import type { ActionSenderFunction, SubscribeFunction } from './types';
+import { getUi5Version, isLowerThanMinimalUi5Version } from '../utils/version';
+import { AdditionalChangeInfo } from '../utils/additional-change-info';
+/**
+ * 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, subscribe: SubscribeFunction): Promise<void> {
+        this.sendAction = sendAction;
+        subscribe((action): void => {
+            if (reloadApplication.match(action)) {
+                this.isReloadPending = true;
+            }
+        });
+        const ui5Version = await getUi5Version();
+        if (isLowerThanMinimalUi5Version(ui5Version, { major: 1, minor: 84 })) {
+            if (ui5Version.isCdn) {
+                const FakeLrepConnector = (await import('sap/ui/fl/FakeLrepConnector')).default;
+                FakeLrepConnector.fileChangeRequestNotifier = this.onChangeSaved.bind(this);
+            } else {
+                // For UI5 versions below 1.84 served from npmjs, we do not support any connector service
+                return;
+            }
+        } 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 = this.onChangeSaved.bind(this);
+        }
+    }
+
+    private onChangeSaved(
+        fileName: string,
+        kind: 'delete' | 'create',
+        change: unknown = {},
+        additionalChangeInfo: unknown = {}
+    ): void {
+        const { changeType, content } = change as {
+            changeType?: string;
+            content?: {
+                fragmentPath?: string;
+                codeRef?: string;
+            };
+        };
+        if (
+            (changeType &&
+                !['appdescr_fe_changePageConfiguration', 'appdescr_ui_generic_app_changePageConfiguration'].includes(
+                    changeType
+                )) ||
+            kind === 'delete' ||
+            this.isReloadPending
+        ) {
+            this.sendAction(storageFileChanged(fileName?.replace('sap.ui.fl.', '')));
+        }
+        if (changeType === 'addXML' && (additionalChangeInfo as AdditionalChangeInfo )?.templateName && content?.fragmentPath) {
+            // If there is template available, then we save and reload right away,
+            // so we should ignore the first file change event that comes for the fragment.
+            // (We don't want to show "Reload" button)
+            this.sendAction(storageFileChanged(content.fragmentPath));
+        }
+    }
+}

package/dist/preview-middleware/dist/client/cpe/context-menu-service.js

@@ -0,0 +1,90 @@
+"use strict";
+
+sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../adp/dialog-factory", "../i18n", "sap/base/Log", "../utils/core", "../utils/version", "../utils/application"], function (___sap_ux_private_control_property_editor_common, ___adp_dialog_factory, ___i18n, Log, ___utils_core, ___utils_version, ___utils_application) {
+  "use strict";
+
+  const executeContextMenuAction = ___sap_ux_private_control_property_editor_common["executeContextMenuAction"];
+  const reportTelemetry = ___sap_ux_private_control_property_editor_common["reportTelemetry"];
+  const requestControlContextMenu = ___sap_ux_private_control_property_editor_common["requestControlContextMenu"];
+  const DialogFactory = ___adp_dialog_factory["DialogFactory"];
+  const getTextBundle = ___i18n["getTextBundle"];
+  const getControlById = ___utils_core["getControlById"];
+  const getUi5Version = ___utils_version["getUi5Version"];
+  const getApplicationType = ___utils_application["getApplicationType"];
+  /**
+   * A Class of ContextMenuService
+   */
+  class ContextMenuService {
+    sendAction = () => {};
+    /**
+     *
+     * @param rta Runtime Authoring instance.
+     */
+    constructor(rta) {
+      this.rta = rta;
+    }
+
+    /**
+     * Initializes rta service.
+     *
+     * @param sendAction action sender function
+     * @param subscribe subscriber function
+     */
+    async init(sendAction, subscribe) {
+      this.sendAction = sendAction;
+      this.actionService = await this.rta.getService('action');
+      const resourceBundle = await getTextBundle();
+      subscribe(async action => {
+        if (executeContextMenuAction.match(action)) {
+          const {
+            actionName,
+            controlId
+          } = action.payload;
+          await this.actionService.execute(controlId, actionName);
+          try {
+            const controlName = getControlById(controlId)?.getMetadata().getName();
+            const versionInfo = await getUi5Version();
+            await reportTelemetry({
+              category: 'OutlineContextMenu',
+              actionName,
+              controlName,
+              ui5Version: `${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`,
+              appType: getApplicationType(this.rta.getRootControlInstance().getManifest())
+            });
+          } catch (err) {
+            Log.error('Error in reporting Telemetry:', err);
+          }
+        }
+        if (requestControlContextMenu.pending.match(action)) {
+          const controlId = action.payload;
+          const actions = await this.actionService.get(controlId);
+          const responsePayload = {
+            controlId: controlId,
+            contextMenuItems: (actions ?? []).map(val => {
+              let enabled = val.enabled;
+              let tooltip;
+              if (!DialogFactory.canOpenDialog) {
+                enabled = false;
+                tooltip = resourceBundle.getText('ADP_QUICK_ACTION_DIALOG_OPEN_MESSAGE');
+              }
+              return {
+                id: val.id,
+                title: val.text,
+                enabled,
+                tooltip
+              };
+            })
+          };
+          const requestControlActions = requestControlContextMenu.fulfilled(responsePayload);
+          this.sendAction(requestControlActions);
+        }
+      });
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.ContextMenuService = ContextMenuService;
+  return __exports;
+});
+//# sourceMappingURL=context-menu-service.js.map

package/dist/preview-middleware/dist/client/cpe/context-menu-service.ts

@@ -0,0 +1,77 @@
+import {
+    executeContextMenuAction,
+    ExternalAction,
+    reportTelemetry,
+    requestControlContextMenu
+} from '@sap-ux-private/control-property-editor-common';
+import { ActionSenderFunction, SubscribeFunction } from './types';
+import RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+import { ActionService } from 'sap/ui/rta/service/Action';
+import { DialogFactory } from '../adp/dialog-factory';
+import { getTextBundle } from '../i18n';
+import Log from 'sap/base/Log';
+import { getControlById } from '../utils/core';
+import { getUi5Version } from '../utils/version';
+import { getApplicationType } from '../utils/application';
+
+/**
+ * A Class of ContextMenuService
+ */
+export class ContextMenuService {
+    private sendAction: ActionSenderFunction = () => {};
+    private actionService: ActionService;
+    /**
+     *
+     * @param rta Runtime Authoring instance.
+     */
+    constructor(private readonly rta: RuntimeAuthoring) {}
+
+    /**
+     * Initializes rta service.
+     *
+     * @param sendAction action sender function
+     * @param subscribe subscriber function
+     */
+    public async init(sendAction: ActionSenderFunction, subscribe: SubscribeFunction): Promise<void> {
+        this.sendAction = sendAction;
+        this.actionService = await this.rta.getService('action');
+        const resourceBundle = await getTextBundle();
+        subscribe(async (action: ExternalAction): Promise<void> => {
+            if (executeContextMenuAction.match(action)) {
+                const { actionName, controlId } = action.payload;
+                await this.actionService.execute(controlId, actionName);
+                try {
+                    const controlName = getControlById(controlId)?.getMetadata().getName();
+                    const versionInfo = await getUi5Version();
+                    await reportTelemetry({
+                        category: 'OutlineContextMenu',
+                        actionName,
+                        controlName,
+                        ui5Version: `${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`,
+                        appType: getApplicationType(this.rta.getRootControlInstance().getManifest())
+                    });
+                } catch (err) {
+                    Log.error('Error in reporting Telemetry:', err);
+                }
+            }
+            if (requestControlContextMenu.pending.match(action)) {
+                const controlId = action.payload;
+                const actions = await this.actionService.get(controlId);
+                const responsePayload = {
+                    controlId: controlId,
+                    contextMenuItems: (actions ?? []).map((val) => {
+                        let enabled = val.enabled;
+                        let tooltip;
+                        if (!DialogFactory.canOpenDialog) {
+                            enabled = false;
+                            tooltip = resourceBundle.getText('ADP_QUICK_ACTION_DIALOG_OPEN_MESSAGE');
+                        }
+                        return { id: val.id, title: val.text, enabled, tooltip };
+                    })
+                };
+                const requestControlActions = requestControlContextMenu.fulfilled(responsePayload);
+                this.sendAction(requestControlActions);
+            }
+        });
+    }
+}