@sap-ux/preview-middleware 0.16.155 → 0.16.157

package/dist/client/adp/controllers/ExtensionPoint.controller.js

@@ -1,140 +1,140 @@
-"use strict";
-
-sap.ui.define(["sap/ui/model/json/JSONModel", "../api-handler", "./BaseDialog.controller", "../utils"], function (JSONModel, ___api_handler, __BaseDialog, ___utils) {
-  "use strict";
-
-  function _interopRequireDefault(obj) {
-    return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
-  }
-  const getFragments = ___api_handler["getFragments"];
-  const BaseDialog = _interopRequireDefault(__BaseDialog);
-  const notifyUser = ___utils["notifyUser"];
-  /**
-   * @namespace open.ux.preview.client.adp.controllers
-   */
-  const ExtensionPoint = BaseDialog.extend("open.ux.preview.client.adp.controllers.ExtensionPoint", {
-    constructor: function _constructor(name, _overlays, rta, data) {
-      BaseDialog.prototype.constructor.call(this, name);
-      this.model = new JSONModel();
-      this.data = data;
-      this.rta = rta;
-    },
-    /**
-     * Setups the Dialog and the JSON Model
-     *
-     * @param {Dialog} dialog - Dialog instance
-     */
-    setup: async function _setup(dialog) {
-      this.dialog = dialog;
-      this.setEscapeHandler();
-      await this.buildDialogData();
-      this.dialog.setModel(this.model);
-      this.dialog.open();
-    },
-    /**
-     * Handles create button press
-     *
-     * @param event Event
-     */
-    onCreateBtnPress: function _onCreateBtnPress(event) {
-      const source = event.getSource();
-      source.setEnabled(false);
-      const fragmentName = this.model.getProperty('/newFragmentName');
-      this.createExtensionPointFragmentChange(fragmentName);
-      notifyUser(`Note: The '${fragmentName}.fragment.xml' fragment will be created once you save the change.`, 8000);
-      this.handleDialogClose();
-    },
-    /**
-     * Handler for extension point select control
-     *
-     * @param event Select control change event
-     */
-    onExtensionPointHandler: function _onExtensionPointHandler(event) {
-      const source = event.getSource();
-      const selectedItem = source.getSelectedItem();
-      let extensionPointName = '';
-      if (selectedItem) {
-        extensionPointName = selectedItem.getText();
-      }
-      this.model.setProperty('/extensionPointName', extensionPointName);
-      const hasDefaultContent = this.hasDefaultContentForName(extensionPointName);
-      this.model.setProperty('/hasDefaultContent', hasDefaultContent);
-    },
-    /**
-     * Determines whether there is default content associated with the given name.
-     *
-     * @param {string} name - The name to check for associated default content.
-     * @returns {boolean} - True if there is non-empty default content associated with the name, false otherwise.
-     */
-    hasDefaultContentForName: function _hasDefaultContentForName(name) {
-      const defaultContent = this.data?.info.find(v => v.name === name)?.defaultContent;
-      return defaultContent ? defaultContent.length > 0 : false;
-    },
-    /**
-     * Builds data that is used in the dialog
-     */
-    buildDialogData: async function _buildDialogData() {
-      const name = this.data?.name;
-      if (name) {
-        const hasDefaultContent = this.hasDefaultContentForName(name);
-        const extensionPointList = [{
-          key: 0,
-          value: name
-        }];
-        this.updateModel(name, 0, extensionPointList, false, hasDefaultContent);
-      } else {
-        // In this case we are selecting from the application. There can be many extension points under one control.
-        const extensionPointList = this.data.info.map((v, idx) => {
-          return {
-            key: idx,
-            value: v.name
-          };
-        });
-        const firstElName = extensionPointList[0].value;
-        const enabled = extensionPointList.length > 1;
-        const hasDefaultContent = this.hasDefaultContentForName(firstElName);
-        this.updateModel(firstElName, 0, extensionPointList, enabled, hasDefaultContent);
-      }
-      try {
-        const {
-          fragments
-        } = await getFragments();
-        this.model.setProperty('/fragmentList', fragments);
-      } catch (e) {
-        this.handleError(e);
-      }
-    },
-    /**
-     * Updates the Select control according to provided values
-     *
-     * @param name Extension point name
-     * @param key Selected extension point key
-     * @param list All of the extension points that are under a view
-     * @param enabled Enables the select control
-     * @param hasDefaultContent Whether there is default content associated with the extension name
-     */
-    updateModel: function _updateModel(name, key, list, enabled, hasDefaultContent) {
-      this.model.setProperty('/extensionPointName', name);
-      this.model.setProperty('/extensionPointKey', key);
-      this.model.setProperty('/extensionPointList', list);
-      this.model.setProperty('/extensionListEnabled', enabled);
-      this.model.setProperty('/hasDefaultContent', hasDefaultContent);
-    },
-    /**
-     * Creates add xml at extension point changes
-     *
-     * @param fragmentName Fragment name
-     */
-    createExtensionPointFragmentChange: function _createExtensionPointFragmentChange(fragmentName) {
-      const extensionPointName = this.model.getProperty('/extensionPointName');
-      const modifiedValue = {
-        fragment: `<core:FragmentDefinition xmlns:core='sap.ui.core'></core:FragmentDefinition>`,
-        fragmentPath: `fragments/${fragmentName}.fragment.xml`,
-        extensionPointName
-      };
-      this.data.deferred.resolve(modifiedValue);
-    }
-  });
-  return ExtensionPoint;
+"use strict";
+
+sap.ui.define(["sap/ui/model/json/JSONModel", "../api-handler", "./BaseDialog.controller", "../utils"], function (JSONModel, ___api_handler, __BaseDialog, ___utils) {
+  "use strict";
+
+  function _interopRequireDefault(obj) {
+    return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
+  }
+  const getFragments = ___api_handler["getFragments"];
+  const BaseDialog = _interopRequireDefault(__BaseDialog);
+  const notifyUser = ___utils["notifyUser"];
+  /**
+   * @namespace open.ux.preview.client.adp.controllers
+   */
+  const ExtensionPoint = BaseDialog.extend("open.ux.preview.client.adp.controllers.ExtensionPoint", {
+    constructor: function _constructor(name, _overlays, rta, data) {
+      BaseDialog.prototype.constructor.call(this, name);
+      this.model = new JSONModel();
+      this.data = data;
+      this.rta = rta;
+    },
+    /**
+     * Setups the Dialog and the JSON Model
+     *
+     * @param {Dialog} dialog - Dialog instance
+     */
+    setup: async function _setup(dialog) {
+      this.dialog = dialog;
+      this.setEscapeHandler();
+      await this.buildDialogData();
+      this.dialog.setModel(this.model);
+      this.dialog.open();
+    },
+    /**
+     * Handles create button press
+     *
+     * @param event Event
+     */
+    onCreateBtnPress: function _onCreateBtnPress(event) {
+      const source = event.getSource();
+      source.setEnabled(false);
+      const fragmentName = this.model.getProperty('/newFragmentName');
+      this.createExtensionPointFragmentChange(fragmentName);
+      notifyUser(`Note: The '${fragmentName}.fragment.xml' fragment will be created once you save the change.`, 8000);
+      this.handleDialogClose();
+    },
+    /**
+     * Handler for extension point select control
+     *
+     * @param event Select control change event
+     */
+    onExtensionPointHandler: function _onExtensionPointHandler(event) {
+      const source = event.getSource();
+      const selectedItem = source.getSelectedItem();
+      let extensionPointName = '';
+      if (selectedItem) {
+        extensionPointName = selectedItem.getText();
+      }
+      this.model.setProperty('/extensionPointName', extensionPointName);
+      const hasDefaultContent = this.hasDefaultContentForName(extensionPointName);
+      this.model.setProperty('/hasDefaultContent', hasDefaultContent);
+    },
+    /**
+     * Determines whether there is default content associated with the given name.
+     *
+     * @param {string} name - The name to check for associated default content.
+     * @returns {boolean} - True if there is non-empty default content associated with the name, false otherwise.
+     */
+    hasDefaultContentForName: function _hasDefaultContentForName(name) {
+      const defaultContent = this.data?.info.find(v => v.name === name)?.defaultContent;
+      return defaultContent ? defaultContent.length > 0 : false;
+    },
+    /**
+     * Builds data that is used in the dialog
+     */
+    buildDialogData: async function _buildDialogData() {
+      const name = this.data?.name;
+      if (name) {
+        const hasDefaultContent = this.hasDefaultContentForName(name);
+        const extensionPointList = [{
+          key: 0,
+          value: name
+        }];
+        this.updateModel(name, 0, extensionPointList, false, hasDefaultContent);
+      } else {
+        // In this case we are selecting from the application. There can be many extension points under one control.
+        const extensionPointList = this.data.info.map((v, idx) => {
+          return {
+            key: idx,
+            value: v.name
+          };
+        });
+        const firstElName = extensionPointList[0].value;
+        const enabled = extensionPointList.length > 1;
+        const hasDefaultContent = this.hasDefaultContentForName(firstElName);
+        this.updateModel(firstElName, 0, extensionPointList, enabled, hasDefaultContent);
+      }
+      try {
+        const {
+          fragments
+        } = await getFragments();
+        this.model.setProperty('/fragmentList', fragments);
+      } catch (e) {
+        this.handleError(e);
+      }
+    },
+    /**
+     * Updates the Select control according to provided values
+     *
+     * @param name Extension point name
+     * @param key Selected extension point key
+     * @param list All of the extension points that are under a view
+     * @param enabled Enables the select control
+     * @param hasDefaultContent Whether there is default content associated with the extension name
+     */
+    updateModel: function _updateModel(name, key, list, enabled, hasDefaultContent) {
+      this.model.setProperty('/extensionPointName', name);
+      this.model.setProperty('/extensionPointKey', key);
+      this.model.setProperty('/extensionPointList', list);
+      this.model.setProperty('/extensionListEnabled', enabled);
+      this.model.setProperty('/hasDefaultContent', hasDefaultContent);
+    },
+    /**
+     * Creates add xml at extension point changes
+     *
+     * @param fragmentName Fragment name
+     */
+    createExtensionPointFragmentChange: function _createExtensionPointFragmentChange(fragmentName) {
+      const extensionPointName = this.model.getProperty('/extensionPointName');
+      const modifiedValue = {
+        fragment: `<core:FragmentDefinition xmlns:core='sap.ui.core'></core:FragmentDefinition>`,
+        fragmentPath: `fragments/${fragmentName}.fragment.xml`,
+        extensionPointName
+      };
+      this.data.deferred.resolve(modifiedValue);
+    }
+  });
+  return ExtensionPoint;
 });
 //# sourceMappingURL=ExtensionPoint.controller.js.map

package/dist/client/adp/dialog-factory.js

@@ -0,0 +1,115 @@
+"use strict";
+
+sap.ui.define(["sap/ui/core/Fragment", "../i18n", "./controllers/AddFragment.controller", "./controllers/AddTableColumnFragments.controller", "./controllers/ControllerExtension.controller", "./controllers/ExtensionPoint.controller"], function (Fragment, ___i18n, __AddFragment, __AddTableColumnFragments, __ControllerExtension, __ExtensionPoint) {
+  "use strict";
+
+  function _interopRequireDefault(obj) {
+    return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
+  }
+  const getTextBundle = ___i18n["getTextBundle"];
+  const AddFragment = _interopRequireDefault(__AddFragment);
+  const AddTableColumnFragments = _interopRequireDefault(__AddTableColumnFragments);
+  const ControllerExtension = _interopRequireDefault(__ControllerExtension);
+  const ExtensionPoint = _interopRequireDefault(__ExtensionPoint);
+  var DialogNames = /*#__PURE__*/function (DialogNames) {
+    DialogNames["ADD_FRAGMENT"] = "AddFragment";
+    DialogNames["ADD_TABLE_COLUMN_FRAGMENTS"] = "AddTableColumnFragments";
+    DialogNames["CONTROLLER_EXTENSION"] = "ControllerExtension";
+    DialogNames["ADD_FRAGMENT_AT_EXTENSION_POINT"] = "ExtensionPoint";
+    return DialogNames;
+  }(DialogNames || {});
+  const OPEN_DIALOG_STATUS_CHANGED = 'OPEN_DIALOG_STATUS_CHANGED';
+  class DialogFactory {
+    static eventTarget = new EventTarget();
+    static isDialogOpen = false;
+    /**
+     * Only one dialog can be open at a time. This flag indicates if a new dialog can be opened.
+     */
+
+    static get canOpenDialog() {
+      return !this.isDialogOpen;
+    }
+
+    /**
+     * Factory method for creating a new dialog.
+     *
+     * @param overlay - Control overlay.
+     * @param rta - Runtime Authoring instance.
+     * @param dialogName - Dialog name.
+     * @param extensionPointData - Control ID.
+     * @param options - Dialog options.
+     */
+    static async createDialog(overlay, rta, dialogName, extensionPointData) {
+      let options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
+      if (this.isDialogOpen) {
+        return;
+      }
+      let controller;
+      const resources = await getTextBundle();
+      switch (dialogName) {
+        case DialogNames.ADD_FRAGMENT:
+          controller = new AddFragment(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
+            aggregation: options.aggregation,
+            title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
+          });
+          break;
+        case DialogNames.ADD_TABLE_COLUMN_FRAGMENTS:
+          controller = new AddTableColumnFragments(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
+            aggregation: options.aggregation,
+            title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
+          });
+          break;
+        case DialogNames.CONTROLLER_EXTENSION:
+          controller = new ControllerExtension(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta);
+          break;
+        case DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT:
+          controller = new ExtensionPoint(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, extensionPointData);
+          break;
+      }
+      const id = dialogName === DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT ? `dialog--${dialogName}` : undefined;
+      const dialog = await Fragment.load({
+        name: `open.ux.preview.client.adp.ui.${dialogName}`,
+        controller,
+        id
+      });
+      this.isDialogOpen = true;
+      dialog.attachBeforeClose(() => {
+        this.updateStatus(false);
+      });
+      await controller.setup(dialog);
+      this.updateStatus(true);
+    }
+
+    /**
+     * Updates open dialog status.
+     * 
+     * @param isDialogOpen Flag indicating if there is an open dialog.
+     */
+    static updateStatus(isDialogOpen) {
+      this.isDialogOpen = isDialogOpen;
+      const event = new CustomEvent(OPEN_DIALOG_STATUS_CHANGED);
+      this.eventTarget.dispatchEvent(event);
+    }
+
+    /**
+     * Attach event handler for OPEN_DIALOG_STATUS_CHANGED event.
+     * 
+     * @param handler Event handler.
+     * @returns Function that removes listener.
+     */
+    static onOpenDialogStatusChange(handler) {
+      this.eventTarget.addEventListener(OPEN_DIALOG_STATUS_CHANGED, handler);
+      return () => {
+        this.eventTarget.removeEventListener(OPEN_DIALOG_STATUS_CHANGED, handler);
+      };
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.DialogNames = DialogNames;
+  __exports.OPEN_DIALOG_STATUS_CHANGED = OPEN_DIALOG_STATUS_CHANGED;
+  __exports.DialogFactory = DialogFactory;
+  return __exports;
+});
+//# sourceMappingURL=dialog-factory.js.map

package/dist/client/adp/dialog-factory.ts

@@ -0,0 +1,134 @@
+import Dialog from 'sap/m/Dialog';
+import UI5Element from 'sap/ui/core/Element';
+import Fragment from 'sap/ui/core/Fragment';
+import RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+
+import { getTextBundle } from '../i18n';
+
+import AddFragment, { AddFragmentOptions } from './controllers/AddFragment.controller';
+import AddTableColumnFragments from './controllers/AddTableColumnFragments.controller';
+import ControllerExtension from './controllers/ControllerExtension.controller';
+import ExtensionPoint from './controllers/ExtensionPoint.controller';
+
+import { ExtensionPointData } from './extension-point';
+
+export const enum DialogNames {
+    ADD_FRAGMENT = 'AddFragment',
+    ADD_TABLE_COLUMN_FRAGMENTS = 'AddTableColumnFragments',
+    CONTROLLER_EXTENSION = 'ControllerExtension',
+    ADD_FRAGMENT_AT_EXTENSION_POINT = 'ExtensionPoint'
+}
+
+type Controller = AddFragment | AddTableColumnFragments | ControllerExtension | ExtensionPoint;
+
+export const OPEN_DIALOG_STATUS_CHANGED = 'OPEN_DIALOG_STATUS_CHANGED';
+
+export class DialogFactory {
+    private static readonly eventTarget = new EventTarget();
+    private static isDialogOpen = false;
+    /**
+     * Only one dialog can be open at a time. This flag indicates if a new dialog can be opened.
+     */
+
+    public static get canOpenDialog(): boolean {
+        return !this.isDialogOpen;
+    }
+
+    /**
+     * Factory method for creating a new dialog.
+     *
+     * @param overlay - Control overlay.
+     * @param rta - Runtime Authoring instance.
+     * @param dialogName - Dialog name.
+     * @param extensionPointData - Control ID.
+     * @param options - Dialog options.
+     */
+    public static async createDialog(
+        overlay: UI5Element,
+        rta: RuntimeAuthoring,
+        dialogName: DialogNames,
+        extensionPointData?: ExtensionPointData,
+        options: Partial<AddFragmentOptions> = {}
+    ): Promise<void> {
+        if (this.isDialogOpen) {
+            return;
+        }
+        let controller: Controller;
+        const resources = await getTextBundle();
+
+        switch (dialogName) {
+            case DialogNames.ADD_FRAGMENT:
+                controller = new AddFragment(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
+                    aggregation: options.aggregation,
+                    title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
+                });
+                break;
+            case DialogNames.ADD_TABLE_COLUMN_FRAGMENTS:
+                controller = new AddTableColumnFragments(
+                    `open.ux.preview.client.adp.controllers.${dialogName}`,
+                    overlay,
+                    rta,
+                    {
+                        aggregation: options.aggregation,
+                        title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
+                    }
+                );
+                break;
+            case DialogNames.CONTROLLER_EXTENSION:
+                controller = new ControllerExtension(
+                    `open.ux.preview.client.adp.controllers.${dialogName}`,
+                    overlay,
+                    rta
+                );
+                break;
+            case DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT:
+                controller = new ExtensionPoint(
+                    `open.ux.preview.client.adp.controllers.${dialogName}`,
+                    overlay,
+                    rta,
+                    extensionPointData!
+                );
+                break;
+        }
+
+        const id = dialogName === DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT ? `dialog--${dialogName}` : undefined;
+
+        const dialog = (await Fragment.load({
+            name: `open.ux.preview.client.adp.ui.${dialogName}`,
+            controller,
+            id
+        })) as Dialog;
+
+        this.isDialogOpen = true;
+        dialog.attachBeforeClose(() => {
+            this.updateStatus(false);
+        });
+
+        await controller.setup(dialog);
+        this.updateStatus(true);
+    }
+
+    /**
+     * Updates open dialog status.
+     * 
+     * @param isDialogOpen Flag indicating if there is an open dialog.
+     */
+    private static updateStatus(isDialogOpen: boolean) {
+        this.isDialogOpen = isDialogOpen;
+        const event = new CustomEvent(OPEN_DIALOG_STATUS_CHANGED);
+        this.eventTarget.dispatchEvent(event);
+    }
+
+    /**
+     * Attach event handler for OPEN_DIALOG_STATUS_CHANGED event.
+     * 
+     * @param handler Event handler.
+     * @returns Function that removes listener.
+     */
+    public static onOpenDialogStatusChange(handler: (event: CustomEvent) => void | Promise<void>): () => void {
+        this.eventTarget.addEventListener(OPEN_DIALOG_STATUS_CHANGED, handler as EventListener);
+        return () => {
+            this.eventTarget.removeEventListener(OPEN_DIALOG_STATUS_CHANGED, handler as EventListener);
+        };
+    }
+}

package/dist/client/adp/extension-point.js

@@ -4,15 +4,15 @@ sap.ui.define([
     'sap/ui/rta/command/CommandFactory',
     'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
     './utils',
-    '../cpe/communication-service',
-    './init-dialogs'
-], function (AddXMLAtExtensionPoint, CommandFactory, ___sap_ux_private_control_property_editor_common, ___utils, ___cpe_communication_service, ___init_dialogs) {
+    './dialog-factory',
+    '../cpe/communication-service'
+], function (AddXMLAtExtensionPoint, CommandFactory, ___sap_ux_private_control_property_editor_common, ___utils, ___dialog_factory, ___cpe_communication_service) {
     'use strict';
     const addExtensionPoint = ___sap_ux_private_control_property_editor_common['addExtensionPoint'];
     const createDeferred = ___utils['createDeferred'];
+    const DialogFactory = ___dialog_factory['DialogFactory'];
+    const DialogNames = ___dialog_factory['DialogNames'];
     const CommunicationService = ___cpe_communication_service['CommunicationService'];
-    const DialogNames = ___init_dialogs['DialogNames'];
-    const handler = ___init_dialogs['handler'];
     class ExtensionPointService {
         actionId = 'CTX_ADDXML_AT_EXTENSIONPOINT';
         constructor(rta) {
@@ -47,7 +47,7 @@ sap.ui.define([
         async fragmentHandler(overlay, info) {
             let deferred = createDeferred();
             const name = this.selectedExtensionPointName;
-            await handler(overlay, this.rta, DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT, {
+            await DialogFactory.createDialog(overlay, this.rta, DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT, {
                 name,
                 info,
                 deferred

package/dist/client/adp/extension-point.ts

@@ -7,9 +7,9 @@ import CommandFactory from 'sap/ui/rta/command/CommandFactory';
 import { ExternalAction, addExtensionPoint } from '@sap-ux-private/control-property-editor-common';
 
 import { Deferred, createDeferred } from './utils';
+import { DialogFactory, DialogNames } from './dialog-factory';
 
 import { CommunicationService } from '../cpe/communication-service';
-import { DialogNames, handler } from './init-dialogs';
 
 type ActionService = {
     execute: (controlId: string, actionId: string) => void;
@@ -100,7 +100,7 @@ export default class ExtensionPointService {
         let deferred = createDeferred<DeferredExtPointData>();
         const name = this.selectedExtensionPointName;
 
-        await handler(overlay, this.rta, DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT, {
+        await DialogFactory.createDialog(overlay, this.rta, DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT, {
             name,
             info,
             deferred