@sap-ux/preview-middleware 0.20.0 → 0.20.2

package/dist/client/adp/controllers/ControllerExtension.controller.ts

@@ -17,17 +17,19 @@ import JSONModel from 'sap/ui/model/json/JSONModel';
 /** sap.ui.rta */
 import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 
-/** sap.ui.layout */
-import type SimpleForm from 'sap/ui/layout/form/SimpleForm';
-
 /** sap.ui.dt */
 import type ElementOverlay from 'sap/ui/dt/ElementOverlay';
 
 import type { CodeExtResponse, ControllersResponse } from '../api-handler';
 import { getExistingController, readControllers, writeChange, writeController } from '../api-handler';
 import BaseDialog from './BaseDialog.controller';
-import { getControllerInfo } from '../utils';
+import type { ExtendControllerData, DeferredExtendControllerData } from '../extend-controller';
 import { QuickActionTelemetryData } from '../../cpe/quick-actions/quick-action-definition';
+import { getResourceModel, getTextBundle, TextBundle } from '../../i18n';
+import { notifyUser, checkForExistingChange, getControllerInfo } from '../utils';
+import { getUi5Version, isLowerThanMinimalUi5Version } from '../../utils/version';
+import CommandExecutor from '../command-executor';
+import { getControlById } from '../../utils/core';
 
 interface ControllerExtensionService {
     add: (codeRef: string, viewId: string) => Promise<{ creation: string }>;
@@ -53,11 +55,21 @@ type ControllerModel = JSONModel & {
  * @namespace open.ux.preview.client.adp.controllers
  */
 export default class ControllerExtension extends BaseDialog<ControllerModel> {
-    constructor(name: string, overlays: UI5Element, rta: RuntimeAuthoring, telemetryData?: QuickActionTelemetryData) {
+    public readonly data?: ExtendControllerData;
+    private bundle: TextBundle;
+
+    constructor(
+        name: string,
+        overlays: UI5Element,
+        rta: RuntimeAuthoring,
+        data?: ExtendControllerData,
+        telemetryData?: QuickActionTelemetryData
+    ) {
         super(name, telemetryData);
         this.rta = rta;
         this.overlays = overlays;
         this.model = new JSONModel();
+        this.data = data;
     }
 
     /**
@@ -70,8 +82,12 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
 
         this.setEscapeHandler();
 
+        const resourceModel = await getResourceModel('open.ux.preview.client');
+        this.bundle = await getTextBundle();
+
         await this.buildDialogData();
 
+        this.dialog.setModel(resourceModel, 'i18n');
         this.dialog.setModel(this.model);
 
         this.dialog.open();
@@ -102,6 +118,13 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
 
         const fileExists = controllerList.some((f) => f.controllerName === controllerName);
 
+        const pendingChangeExists = checkForExistingChange(
+            this.rta,
+            'codeExt',
+            'content.codeRef',
+            `${controllerName}.js`
+        );
+
         if (fileExists) {
             updateDialogState(
                 ValueState.Error,
@@ -110,6 +133,14 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
             return;
         }
 
+        if (pendingChangeExists) {
+            updateDialogState(
+                ValueState.Error,
+                'Enter a different name. The controller name that you entered already exists as a pending change.'
+            );
+            return;
+        }
+
         const isValidName = /^[a-zA-Z_][a-zA-Z0-9_-]*$/.test(controllerName);
 
         if (!isValidName) {
@@ -147,7 +178,16 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
             const controllerName = this.model.getProperty('/newControllerName');
             const viewId = this.model.getProperty('/viewId');
 
-            await this.createNewController(controllerName, viewId);
+            const controllerRef = {
+                codeRef: `coding/${controllerName}.js`,
+                viewId
+            };
+
+            if (this.data) {
+                this.data.deferred.resolve(controllerRef);
+            } else {
+                await this.createNewController(controllerName, controllerRef);
+            }
         } else {
             const controllerPath = this.model.getProperty('/controllerPath');
             window.open(`vscode://file${controllerPath}`);
@@ -166,8 +206,17 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
         const { controllerName, viewId } = getControllerInfo(overlayControl);
         const data = await this.getExistingController(controllerName);
 
+        const hasPendingChangeForView = checkForExistingChange(
+            this.rta,
+            'codeExt',
+            'selector.controllerName',
+            controllerName
+        );
+
         if (data) {
-            if (data?.controllerExists) {
+            if (hasPendingChangeForView) {
+                this.updateModelForExistingPendingChange();
+            } else if (data?.controllerExists) {
                 this.updateModelForExistingController(data);
             } else {
                 this.updateModelForNewController(viewId, data.isTsSupported);
@@ -187,14 +236,9 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
         this.model.setProperty('/controllerExists', controllerExists);
         this.model.setProperty('/controllerPath', controllerPath);
         this.model.setProperty('/controllerPathFromRoot', controllerPathFromRoot);
-
-        const content = this.dialog.getContent();
-
-        const form = content[0] as SimpleForm;
-        form.setVisible(false);
-
-        const messageForm = content[1] as SimpleForm;
-        messageForm.setVisible(true);
+        this.model.setProperty('/inputFormVisibility', false);
+        this.model.setProperty('/pendingChangeFormVisibility', false);
+        this.model.setProperty('/existingControllerFormVisibility', true);
 
         if (isRunningInBAS) {
             this.dialog.getBeginButton().setVisible(false);
@@ -204,6 +248,18 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
         this.dialog.getEndButton().setText('Close');
     }
 
+    /**
+     * Updates the model properties for an existing controller in a pending change.
+     */
+    private updateModelForExistingPendingChange(): void {
+        this.model.setProperty('/inputFormVisibility', false);
+        this.model.setProperty('/existingControllerFormVisibility', false);
+        this.model.setProperty('/pendingChangeFormVisibility', true);
+
+        this.dialog.getBeginButton().setVisible(false);
+        this.dialog.getEndButton().setText('Close');
+    }
+
     /**
      * Updates the model property for a new controller.
      *
@@ -213,6 +269,9 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
     private updateModelForNewController(viewId: string, isTsSupported: boolean): void {
         this.model.setProperty('/viewId', viewId);
         this.model.setProperty('/controllerExtension', isTsSupported ? '.ts' : '.js');
+        this.model.setProperty('/existingControllerFormVisibility', false);
+        this.model.setProperty('/pendingChangeFormVisibility', false);
+        this.model.setProperty('/inputFormVisibility', true);
     }
 
     /**
@@ -248,17 +307,20 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
      * Creates a new fragment for the specified control
      *
      * @param controllerName Controller Name
-     * @param viewId View Id
+     * @param controllerRef Controller reference
      */
-    private async createNewController(controllerName: string, viewId: string): Promise<void> {
+    private async createNewController(
+        controllerName: string,
+        controllerRef: DeferredExtendControllerData
+    ): Promise<void> {
+        const ui5Version = await getUi5Version();
+        if (!isLowerThanMinimalUi5Version(ui5Version, { major: 1, minor: 135 })) {
+            await this.createControllerCommand(controllerName, controllerRef);
+            return;
+        }
         try {
             await writeController({ controllerName });
 
-            const controllerRef = {
-                codeRef: `coding/${controllerName}.js`,
-                viewId
-            };
-
             const service = await this.rta.getService<ControllerExtensionService>('controllerExtension');
 
             const change = await service.add(controllerRef.codeRef, controllerRef.viewId);
@@ -273,4 +335,30 @@ export default class ControllerExtension extends BaseDialog<ControllerModel> {
             this.handleError(e);
         }
     }
+
+    /**
+     * Creates a controller command and executes it.
+     *
+     * @param controllerName Controller name
+     * @param controllerRef Controller reference
+     */
+    private async createControllerCommand(
+        controllerName: string,
+        controllerRef: DeferredExtendControllerData
+    ): Promise<void> {
+        const flexSettings = this.rta.getFlexSettings();
+        const commandExecutor = new CommandExecutor(this.rta);
+        const view = getControlById(controllerRef.viewId) as UI5Element;
+        const command = await commandExecutor.getCommand<DeferredExtendControllerData>(
+            view,
+            'codeExt',
+            controllerRef,
+            flexSettings
+        );
+
+        await commandExecutor.pushAndExecuteCommand(command);
+
+        const bundle = await getTextBundle();
+        notifyUser(bundle.getText('ADP_CREATE_CONTROLLER_EXTENSION', [controllerName]), 8000);
+    }
 }

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

@@ -1,141 +1,141 @@
-"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: async function _onCreateBtnPress(event) {
-      const source = event.getSource();
-      source.setEnabled(false);
-      await BaseDialog.prototype.onCreateBtnPressHandler.call(this);
-      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: async function _onCreateBtnPress(event) {
+      const source = event.getSource();
+      source.setEnabled(false);
+      await BaseDialog.prototype.onCreateBtnPressHandler.call(this);
+      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/controllers/FileExistsDialog.controller.js

@@ -1,68 +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;
+"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