@sap-ux/preview-middleware 0.20.0 → 0.20.2

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

@@ -1,137 +1,137 @@
-"use strict";
-
-sap.ui.define(["sap/ui/core/Fragment", "../i18n", "./controllers/AddFragment.controller", "./controllers/AddTableColumnFragments.controller", "./controllers/ControllerExtension.controller", "./controllers/ExtensionPoint.controller", "./controllers/FileExistsDialog.controller", "./controllers/AddSubpage.controller"], function (Fragment, ___i18n, __AddFragment, __AddTableColumnFragments, __ControllerExtension, __ExtensionPoint, __FileExistsDialog, __AddSubpage) {
-  "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);
-  const FileExistsDialog = _interopRequireDefault(__FileExistsDialog);
-  const AddSubpage = _interopRequireDefault(__AddSubpage);
-  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";
-    DialogNames["FILE_EXISTS"] = "FileExistsDialog";
-    DialogNames["ADD_SUBPAGE"] = "AddSubpage";
-    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 data - Data to be passed to the dialog.
-     * @param options - Dialog options.
-     * @param telemetryData - Telemetry data.
-     */
-    static async createDialog(overlay, rta, dialogName, data) {
-      let options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
-      let telemetryData = arguments.length > 5 ? arguments[5] : undefined;
-      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' in options && {
-              aggregation: options.aggregation
-            }),
-            ...('defaultAggregationArrayIndex' in options && {
-              defaultAggregationArrayIndex: options.defaultAggregationArrayIndex
-            }),
-            title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
-          }, data, telemetryData);
-          break;
-        case DialogNames.ADD_TABLE_COLUMN_FRAGMENTS:
-          controller = new AddTableColumnFragments(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
-            ...('aggregation' in options && {
-              aggregation: options.aggregation
-            }),
-            title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
-          }, telemetryData);
-          break;
-        case DialogNames.CONTROLLER_EXTENSION:
-          controller = new ControllerExtension(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, telemetryData);
-          break;
-        case DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT:
-          controller = new ExtensionPoint(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, data);
-          break;
-        case DialogNames.FILE_EXISTS:
-          controller = new FileExistsDialog(`open.ux.preview.client.adp.controllers.${dialogName}`, options);
-          break;
-        case DialogNames.ADD_SUBPAGE:
-          controller = new AddSubpage(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
-            ...options,
-            title: resources.getText(options.title ?? 'ADD_SUB_PAGE_DIALOG_TITLE')
-          });
-          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;
+"use strict";
+
+sap.ui.define(["sap/ui/core/Fragment", "../i18n", "./controllers/AddFragment.controller", "./controllers/AddTableColumnFragments.controller", "./controllers/ControllerExtension.controller", "./controllers/ExtensionPoint.controller", "./controllers/FileExistsDialog.controller", "./controllers/AddSubpage.controller"], function (Fragment, ___i18n, __AddFragment, __AddTableColumnFragments, __ControllerExtension, __ExtensionPoint, __FileExistsDialog, __AddSubpage) {
+  "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);
+  const FileExistsDialog = _interopRequireDefault(__FileExistsDialog);
+  const AddSubpage = _interopRequireDefault(__AddSubpage);
+  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";
+    DialogNames["FILE_EXISTS"] = "FileExistsDialog";
+    DialogNames["ADD_SUBPAGE"] = "AddSubpage";
+    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 data - Data to be passed to the dialog.
+     * @param options - Dialog options.
+     * @param telemetryData - Telemetry data.
+     */
+    static async createDialog(overlay, rta, dialogName, data) {
+      let options = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
+      let telemetryData = arguments.length > 5 ? arguments[5] : undefined;
+      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' in options && {
+              aggregation: options.aggregation
+            }),
+            ...('defaultAggregationArrayIndex' in options && {
+              defaultAggregationArrayIndex: options.defaultAggregationArrayIndex
+            }),
+            title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
+          }, data, telemetryData);
+          break;
+        case DialogNames.ADD_TABLE_COLUMN_FRAGMENTS:
+          controller = new AddTableColumnFragments(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
+            ...('aggregation' in options && {
+              aggregation: options.aggregation
+            }),
+            title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
+          }, telemetryData);
+          break;
+        case DialogNames.CONTROLLER_EXTENSION:
+          controller = new ControllerExtension(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, data, telemetryData);
+          break;
+        case DialogNames.ADD_FRAGMENT_AT_EXTENSION_POINT:
+          controller = new ExtensionPoint(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, data);
+          break;
+        case DialogNames.FILE_EXISTS:
+          controller = new FileExistsDialog(`open.ux.preview.client.adp.controllers.${dialogName}`, options);
+          break;
+        case DialogNames.ADD_SUBPAGE:
+          controller = new AddSubpage(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
+            ...options,
+            title: resources.getText(options.title ?? 'ADD_SUB_PAGE_DIALOG_TITLE')
+          });
+          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

@@ -12,6 +12,7 @@ import ExtensionPoint from './controllers/ExtensionPoint.controller';
 
 import type { ExtensionPointData } from './extension-point';
 import { AddFragmentData } from './add-fragment';
+import { ExtendControllerData } from './extend-controller';
 import FileExistsDialog, { FileExistsDialogOptions } from './controllers/FileExistsDialog.controller';
 import AddSubpage, { AddSubpageOptions } from './controllers/AddSubpage.controller';
 import { QuickActionTelemetryData } from '../cpe/quick-actions/quick-action-definition';
@@ -33,7 +34,7 @@ type Controller =
     | FileExistsDialog
     | AddSubpage;
 
-type DialogData = ExtensionPointData | AddFragmentData;
+type DialogData = ExtensionPointData | AddFragmentData | ExtendControllerData;
 
 export const OPEN_DIALOG_STATUS_CHANGED = 'OPEN_DIALOG_STATUS_CHANGED';
 
@@ -106,6 +107,7 @@ export class DialogFactory {
                     `open.ux.preview.client.adp.controllers.${dialogName}`,
                     overlay,
                     rta,
+                    (data as ExtendControllerData),
                     telemetryData
                 );
                 break;

package/dist/client/adp/extend-controller.js

@@ -0,0 +1,48 @@
+"use strict";
+
+sap.ui.define(["sap/ui/rta/command/CommandFactory", "./utils", "./dialog-factory", "sap/ui/rta/plugin/ExtendControllerPlugin"], function (CommandFactory, ___utils, ___dialog_factory, ExtendController) {
+  "use strict";
+
+  const createDeferred = ___utils["createDeferred"];
+  const DialogFactory = ___dialog_factory["DialogFactory"];
+  const DialogNames = ___dialog_factory["DialogNames"];
+  /**
+   * Initializes the ExtendControllerPlugin and includes it in the Runtime Authoring (RTA) plugins.
+   *
+   * @param rta Runtime Authoring instance
+   */
+  function initExtendControllerPlugin(rta) {
+    const flexSettings = rta.getFlexSettings();
+    const commandFactory = new CommandFactory({
+      flexSettings
+    });
+    const plugin = new ExtendController({
+      commandFactory,
+      handlerFunction: async overlay => await handlerFunction(rta, overlay)
+    });
+    const plugins = rta.getPlugins();
+    plugins.extendControllerPlugin = plugin;
+    rta.setPlugins(plugins);
+  }
+
+  /**
+   * Handles the creation of a controller extension by opening a dialog and resolving the deferred data.
+   *
+   * @param rta Runtime Authoring instance
+   * @param overlay UI5 Element overlay
+   * @returns A promise that resolves with DeferredXmlFragmentData
+   */
+  async function handlerFunction(rta, overlay) {
+    const deferred = createDeferred();
+    await DialogFactory.createDialog(overlay, rta, DialogNames.CONTROLLER_EXTENSION, {
+      deferred
+    });
+    return deferred.promise;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.initExtendControllerPlugin = initExtendControllerPlugin;
+  return __exports;
+});
+//# sourceMappingURL=extend-controller.js.map

package/dist/client/adp/extend-controller.ts

@@ -0,0 +1,49 @@
+import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+import type UI5Element from 'sap/ui/core/Element';
+import CommandFactory from 'sap/ui/rta/command/CommandFactory';
+import { Deferred, createDeferred } from './utils';
+import { DialogFactory, DialogNames } from './dialog-factory';
+import ExtendController from 'sap/ui/rta/plugin/ExtendControllerPlugin';
+
+export interface ExtendControllerData {
+    deferred: Deferred<DeferredExtendControllerData>;
+}
+
+export type DeferredExtendControllerData = {
+    codeRef: string;
+    viewId: string;
+};
+
+/**
+ * Initializes the ExtendControllerPlugin and includes it in the Runtime Authoring (RTA) plugins.
+ *
+ * @param rta Runtime Authoring instance
+ */
+export function initExtendControllerPlugin(rta: RuntimeAuthoring): void {
+    const flexSettings = rta.getFlexSettings();
+    const commandFactory = new CommandFactory({ flexSettings });
+
+    const plugin = new ExtendController({
+        commandFactory,
+        handlerFunction: async (overlay: UI5Element) => await handlerFunction(rta, overlay)
+    });
+
+    const plugins = rta.getPlugins();
+    plugins.extendControllerPlugin = plugin;
+    rta.setPlugins(plugins);
+}
+
+/**
+ * Handles the creation of a controller extension by opening a dialog and resolving the deferred data.
+ *
+ * @param rta Runtime Authoring instance
+ * @param overlay UI5 Element overlay
+ * @returns A promise that resolves with DeferredXmlFragmentData
+ */
+async function handlerFunction(rta: RuntimeAuthoring, overlay: UI5Element): Promise<DeferredExtendControllerData> {
+    const deferred = createDeferred<DeferredExtendControllerData>();
+
+    await DialogFactory.createDialog(overlay, rta, DialogNames.CONTROLLER_EXTENSION, { deferred });
+
+    return deferred.promise;
+}