@sap/ux-ui5-tooling 1.20.4 → 1.22.0

package/dist/preview-middleware/dist/client/adp/controllers/ExtensionPoint.controller.ts

@@ -0,0 +1,195 @@
+/** sap.m */
+import type Button from 'sap/m/Button';
+import type Dialog from 'sap/m/Dialog';
+import type Select from 'sap/m/Select';
+
+/** sap.ui.core */
+import type UI5Element from 'sap/ui/core/Element';
+
+/** sap.ui.base */
+import type Event from 'sap/ui/base/Event';
+
+/** sap.ui.model */
+import JSONModel from 'sap/ui/model/json/JSONModel';
+
+/** sap.ui.rta */
+import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+
+import { MessageBarType } from '@sap-ux-private/control-property-editor-common';
+import { getError } from '../../utils/error';
+import { sendInfoCenterMessage } from '../../utils/info-center-message';
+import { getFragments } from '../api-handler';
+import { ExtensionPointData, ExtensionPointInfo } from '../extension-point';
+import BaseDialog from './BaseDialog.controller';
+
+type ExtensionPointModel = JSONModel & {
+    getProperty(sPath: '/newFragmentName'): string;
+    getProperty(sPath: '/extensionPointName'): string;
+};
+
+/**
+ * @namespace open.ux.preview.client.adp.controllers
+ */
+export default class ExtensionPoint extends BaseDialog<ExtensionPointModel> {
+    public readonly data: ExtensionPointData;
+
+    constructor(name: string, _overlays: UI5Element, rta: RuntimeAuthoring, data: ExtensionPointData) {
+        super(name);
+        this.model = new JSONModel();
+        this.data = data;
+        this.rta = rta;
+    }
+
+    /**
+     * Setups the Dialog and the JSON Model
+     *
+     * @param {Dialog} dialog - Dialog instance
+     */
+    async setup(dialog: Dialog): Promise<void> {
+        this.dialog = dialog;
+
+        this.setEscapeHandler();
+
+        await this.buildDialogData();
+
+        this.dialog.setModel(this.model);
+
+        this.dialog.open();
+    }
+
+    /**
+     * Handles create button press
+     *
+     * @param event Event
+     */
+    async onCreateBtnPress(event: Event) {
+        const source = event.getSource<Button>();
+        source.setEnabled(false);
+
+        await super.onCreateBtnPressHandler();
+
+        const fragmentName = this.model.getProperty('/newFragmentName');
+
+        this.createExtensionPointFragmentChange(fragmentName);
+
+        await sendInfoCenterMessage({
+            title: { key: 'ADP_CREATE_XML_FRAGMENT_TITLE' },
+            description: { key: 'ADP_CREATE_XML_FRAGMENT_DESCRIPTION', params: [fragmentName] },
+            type: MessageBarType.info
+        });
+
+        this.handleDialogClose();
+    }
+
+    /**
+     * Handler for extension point select control
+     *
+     * @param event Select control change event
+     */
+    onExtensionPointHandler(event: Event): void {
+        const source = event.getSource<Select>();
+
+        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.
+     */
+    private hasDefaultContentForName(name: string): boolean {
+        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
+     */
+    async buildDialogData(): Promise<void> {
+        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: ExtensionPointInfo, idx: number) => {
+                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) {
+            const error = getError(e);
+            await sendInfoCenterMessage({
+                title: { key: 'ADP_EXTENSION_POINT_ERROR_TITLE' },
+                description: error.message,
+                type: MessageBarType.error
+            });
+            throw error;
+        }
+    }
+
+    /**
+     * 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
+     */
+    private updateModel(
+        name: string,
+        key: number,
+        list: { key: number; value: string }[],
+        enabled: boolean,
+        hasDefaultContent: boolean
+    ): void {
+        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
+     */
+    private createExtensionPointFragmentChange(fragmentName: string): void {
+        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);
+    }
+}

package/dist/preview-middleware/dist/client/adp/controllers/FileExistsDialog.controller.js

@@ -0,0 +1,68 @@
+"use strict";
+
+sap.ui.define(["sap/ui/model/json/JSONModel", "./BaseDialog.controller", "../../i18n"], function (JSONModel, __BaseDialog, ____i18n) {
+  "use strict";
+
+  function _interopRequireDefault(obj) {
+    return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
+  }
+  const BaseDialog = _interopRequireDefault(__BaseDialog);
+  const getResourceModel = ____i18n["getResourceModel"];
+  /**
+   * @namespace open.ux.preview.client.adp.controllers
+   */
+  const FileExistsDialog = BaseDialog.extend("open.ux.preview.client.adp.controllers.FileExistsDialog", {
+    constructor: function _constructor(name, options) {
+      BaseDialog.prototype.constructor.call(this, name);
+      this.model = new JSONModel();
+      this.options = options;
+    },
+    /**
+     * Setups the Dialog and the JSON Model
+     *
+     * @param {Dialog} dialog - Dialog instance
+     */
+    setup: async function _setup(dialog) {
+      this.dialog = dialog;
+      this.setEscapeHandler();
+      this.model.setProperty('/filePath', this.options.filePath);
+      this.model.setProperty('/filePathFromRoot', this.options.fileName);
+      this.model.setProperty('/isRunningInBAS', this.options.isRunningInBAS);
+      this.buildDialogData();
+      const resourceModel = await getResourceModel();
+      this.dialog.setModel(this.model);
+      this.dialog.setModel(resourceModel, 'i18n');
+      this.dialog.open();
+    },
+    /**
+     * Handles create button press
+     *
+     * @param _event Event
+     */
+    onShowFileInVscodeBtn: function _onShowFileInVscodeBtn(_event) {
+      const annotationPath = this.model.getProperty('/filePath');
+      window.open(`vscode://file${annotationPath}`);
+      this.handleDialogClose();
+    },
+    /**
+     * Builds data that is used in the dialog.
+     */
+    buildDialogData: function _buildDialogData() {
+      const content = this.dialog.getContent();
+      const messageForm = content[0];
+      messageForm.setVisible(true);
+      const isRunningInBAS = this.model.getProperty('/isRunningInBAS');
+      if (isRunningInBAS) {
+        this.dialog.getBeginButton().setVisible(false);
+      }
+    },
+    /**
+     * Handles create button press
+     *
+     * @param _event Event
+     */
+    onCreateBtnPress: function _onCreateBtnPress(_event) {}
+  });
+  return FileExistsDialog;
+});
+//# sourceMappingURL=FileExistsDialog.controller.js.map

package/dist/preview-middleware/dist/client/adp/controllers/FileExistsDialog.controller.ts

@@ -0,0 +1,86 @@
+import JSONModel from 'sap/ui/model/json/JSONModel';
+import type Dialog from 'sap/m/Dialog';
+
+import type Event from 'sap/ui/base/Event';
+
+import type SimpleForm from 'sap/ui/layout/form/SimpleForm';
+import BaseDialog from './BaseDialog.controller';
+import { getResourceModel } from '../../i18n';
+
+export interface FileExistsDialogOptions {
+    title: string;
+    fileName: string;
+    filePath: string;
+    isRunningInBAS: boolean;
+}
+
+type FileExistModel = JSONModel & {
+    getProperty(sPath: '/filePath'): string;
+    getProperty(sPath: '/filePathFromRoot'): string;
+    getProperty(sPath: '/isRunningInBAS'): boolean;
+};
+
+/**
+ * @namespace open.ux.preview.client.adp.controllers
+ */
+export default class FileExistsDialog extends BaseDialog<FileExistModel> {
+    private readonly options: FileExistsDialogOptions;
+    public model: JSONModel;
+    constructor(name: string, options: FileExistsDialogOptions) {
+        super(name);
+        this.model = new JSONModel();
+        this.options = options;
+    }
+
+    /**
+     * Setups the Dialog and the JSON Model
+     *
+     * @param {Dialog} dialog - Dialog instance
+     */
+    async setup(dialog: Dialog): Promise<void> {
+        this.dialog = dialog;
+        this.setEscapeHandler();
+        this.model.setProperty('/filePath', this.options.filePath);
+        this.model.setProperty('/filePathFromRoot', this.options.fileName);
+        this.model.setProperty('/isRunningInBAS', this.options.isRunningInBAS);
+        this.buildDialogData();
+        const resourceModel = await getResourceModel();
+        this.dialog.setModel(this.model);
+        this.dialog.setModel(resourceModel, 'i18n');
+        this.dialog.open();
+    }
+
+    /**
+     * Handles create button press
+     *
+     * @param _event Event
+     */
+    onShowFileInVscodeBtn(_event: Event) {
+        const annotationPath = this.model.getProperty('/filePath');
+        window.open(`vscode://file${annotationPath}`);
+
+        this.handleDialogClose();
+    }
+
+    /**
+     * Builds data that is used in the dialog.
+     */
+    buildDialogData(): void {
+        const content = this.dialog.getContent();
+
+        const messageForm = content[0] as SimpleForm;
+        messageForm.setVisible(true);
+
+        const isRunningInBAS = this.model.getProperty('/isRunningInBAS');
+        if (isRunningInBAS) {
+            this.dialog.getBeginButton().setVisible(false);
+        }
+    }
+
+    /**
+     * Handles create button press
+     *
+     * @param _event Event
+     */
+    onCreateBtnPress(_event: Event): Promise<void> | void {}
+}

package/dist/preview-middleware/dist/client/adp/controllers/types.js

@@ -0,0 +1,2 @@
+"use strict";
+//# sourceMappingURL=types.js.map

package/dist/preview-middleware/dist/client/adp/controllers/types.ts

@@ -0,0 +1,10 @@
+import type AppComponentV4 from 'sap/fe/core/AppComponent';
+export interface PageDescriptorV4 {
+    appType: 'fe-v4';
+    appComponent: AppComponentV4;
+    pageId: string;
+    routePattern?: string;
+    projectId?: string;
+    anchor?: string;
+}
+

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

@@ -0,0 +1,151 @@
+"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", "./controllers/AddCustomFragment.controller", "./controllers/AddActionFragment.controller"], function (Fragment, ___i18n, __AddFragment, __AddTableColumnFragments, __ControllerExtension, __ExtensionPoint, __FileExistsDialog, __AddSubpage, __AddCustomFragment, __AddActionFragment) {
+  "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);
+  const AddCustomFragment = _interopRequireDefault(__AddCustomFragment);
+  const AddActionFragment = _interopRequireDefault(__AddActionFragment);
+  var DialogNames = /*#__PURE__*/function (DialogNames) {
+    DialogNames["ADD_FRAGMENT"] = "AddFragment";
+    DialogNames["ADD_ACTION"] = "AddAction";
+    DialogNames["ADD_TABLE_COLUMN_FRAGMENTS"] = "AddTableColumnFragments";
+    DialogNames["CONTROLLER_EXTENSION"] = "ControllerExtension";
+    DialogNames["ADD_FRAGMENT_AT_EXTENSION_POINT"] = "ExtensionPoint";
+    DialogNames["ADD_CUSTOM_FRAGMENT"] = "AddCustomFragment";
+    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, options = {}, telemetryData) {
+      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_CUSTOM_FRAGMENT:
+          controller = new AddCustomFragment(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
+            ...options,
+            title: resources.getText(options.title ?? 'ADP_ADD_FRAGMENT_DIALOG_TITLE')
+          });
+          break;
+        case DialogNames.ADD_ACTION:
+          controller = new AddActionFragment(`open.ux.preview.client.adp.controllers.${dialogName}`, overlay, rta, {
+            ...options,
+            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' 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