@sap-ux/preview-middleware 0.10.7 → 0.11.1

package/dist/client/adp/api-handler.js

@@ -7,6 +7,7 @@ sap.ui.define([], function () {
     ApiEndpoints["CHANGES"] = "/preview/api/changes";
     ApiEndpoints["FRAGMENT"] = "/adp/api/fragment";
     ApiEndpoints["CONTROLLER"] = "/adp/api/controller";
+    ApiEndpoints["CODE_EXT"] = "/adp/api/code_ext";
     ApiEndpoints["MANIFEST_APP_DESCRIPTOR"] = "/manifest.appdescr_variant";
     return ApiEndpoints;
   }(ApiEndpoints || {});
@@ -37,7 +38,9 @@ sap.ui.define([], function () {
     try {
       const response = await fetch(endpoint, config);
       if (!response.ok) {
-        throw new Error(`Request failed, status: ${response.status}.`);
+        const errorData = await response.json();
+        const message = errorData?.message ?? '';
+        throw new Error(`Request failed, status: ${response.status}. ${message}`.trim());
       }
       switch (method) {
         case RequestMethod.GET:
@@ -103,6 +106,16 @@ sap.ui.define([], function () {
     return request(ApiEndpoints.CONTROLLER, RequestMethod.POST, data);
   }
 
+  /**
+   * Checks for existing controller in the project's workspace
+   *
+   * @param controllerName Name of the controller
+   * @returns {CodeExtResponse} Returns path to existing controller if found
+   */
+  async function getExistingController(controllerName) {
+    return request(`${ApiEndpoints.CODE_EXT}/${controllerName}`, RequestMethod.GET);
+  }
+
   /**
    * Writes a change object to the project's workspace
    *
@@ -123,6 +136,7 @@ sap.ui.define([], function () {
   __exports.getManifestAppdescr = getManifestAppdescr;
   __exports.readControllers = readControllers;
   __exports.writeController = writeController;
+  __exports.getExistingController = getExistingController;
   __exports.writeChange = writeChange;
   return __exports;
 });

package/dist/client/adp/api-handler.ts

@@ -4,6 +4,7 @@ export const enum ApiEndpoints {
     CHANGES = '/preview/api/changes',
     FRAGMENT = '/adp/api/fragment',
     CONTROLLER = '/adp/api/controller',
+    CODE_EXT = '/adp/api/code_ext',
     MANIFEST_APP_DESCRIPTOR = '/manifest.appdescr_variant'
 }
 
@@ -23,6 +24,12 @@ export interface FragmentsResponse {
     message: string;
 }
 
+export interface CodeExtResponse {
+    controllerExists: boolean;
+    controllerPath: string;
+    controllerPathFromRoot: string;
+}
+
 export interface ControllersResponse {
     controllers: Controllers;
     message: string;
@@ -60,7 +67,9 @@ export async function request<T>(endpoint: ApiEndpoints, method: RequestMethod,
         const response: Response = await fetch(endpoint, config);
 
         if (!response.ok) {
-            throw new Error(`Request failed, status: ${response.status}.`);
+            const errorData = await response.json();
+            const message = errorData?.message ?? '';
+            throw new Error(`Request failed, status: ${response.status}. ${message}`.trim());
         }
 
         switch (method) {
@@ -127,6 +136,16 @@ export async function writeController<T>(data: T): Promise<T> {
     return request<T>(ApiEndpoints.CONTROLLER, RequestMethod.POST, data);
 }
 
+/**
+ * Checks for existing controller in the project's workspace
+ *
+ * @param controllerName Name of the controller
+ * @returns {CodeExtResponse} Returns path to existing controller if found
+ */
+export async function getExistingController(controllerName: string): Promise<CodeExtResponse> {
+    return request<CodeExtResponse>(`${ApiEndpoints.CODE_EXT}/${controllerName}` as ApiEndpoints, RequestMethod.GET);
+}
+
 /**
  * Writes a change object to the project's workspace
  *

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

@@ -9,6 +9,7 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
   /** sap.ui.core */
   const ValueState = sap_ui_core_library["ValueState"];
   /** sap.ui.base */
+  const getExistingController = ___api_handler["getExistingController"];
   const getManifestAppdescr = ___api_handler["getManifestAppdescr"];
   const readControllers = ___api_handler["readControllers"];
   const writeChange = ___api_handler["writeChange"];
@@ -65,19 +66,71 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
     },
     onCreateBtnPress: async function _onCreateBtnPress(event) {
       const source = event.getSource();
-      source.setEnabled(false);
-      const controllerName = this.model.getProperty('/newControllerName');
-      const viewId = this.model.getProperty('/viewId');
-      await this.createNewController(controllerName, viewId);
+      const controllerExists = this.model.getProperty('/controllerExists');
+      if (!controllerExists) {
+        source.setEnabled(false);
+        const controllerName = this.model.getProperty('/newControllerName');
+        const viewId = this.model.getProperty('/viewId');
+        await this.createNewController(controllerName, viewId);
+      } else {
+        const controllerPath = this.model.getProperty('/controllerPath');
+        window.open(`vscode://file${controllerPath}`);
+      }
       this.handleDialogClose();
     },
     buildDialogData: async function _buildDialogData() {
       const selectorId = this.overlays.getId();
       const overlayControl = sap.ui.getCore().byId(selectorId);
+      const {
+        controllerName,
+        viewId
+      } = this.getControllerInfo(overlayControl);
+      const {
+        controllerExists,
+        controllerPath,
+        controllerPathFromRoot
+      } = await this.getExistingController(controllerName);
+      if (controllerExists) {
+        this.updateModelForExistingController(controllerExists, controllerPath, controllerPathFromRoot);
+      } else {
+        this.updateModelForNewController(viewId);
+        await this.getControllers();
+      }
+    },
+    getControllerInfo: function _getControllerInfo(overlayControl) {
       const control = overlayControl.getElement();
-      const viewId = Utils.getViewForControl(control).getId();
+      const view = Utils.getViewForControl(control);
+      const controllerName = view.getController().getMetadata().getName();
+      const viewId = view.getId();
+      return {
+        controllerName,
+        viewId
+      };
+    },
+    updateModelForExistingController: function _updateModelForExistingController(controllerExists, controllerPath, controllerPathFromRoot) {
+      this.model.setProperty('/controllerExists', controllerExists);
+      this.model.setProperty('/controllerPath', controllerPath);
+      this.model.setProperty('/controllerPathFromRoot', controllerPathFromRoot);
+      const form = this.byId('controllerExtensionDialog_Form');
+      form.setVisible(false);
+      const messageForm = this.byId('controllerExtensionDialog_Form--existingController');
+      messageForm.setVisible(true);
+      this.dialog.getBeginButton().setText('Open in VS Code').setEnabled(true);
+      this.dialog.getEndButton().setText('Close');
+    },
+    updateModelForNewController: function _updateModelForNewController(viewId) {
       this.model.setProperty('/viewId', viewId);
-      await this.getControllers();
+    },
+    getExistingController: async function _getExistingController(controllerName) {
+      try {
+        const data = await getExistingController(controllerName);
+        return data;
+      } catch (e) {
+        MessageToast.show(e.message, {
+          duration: 5000
+        });
+        throw new Error(e.message);
+      }
     },
     getControllers: async function _getControllers() {
       try {
@@ -86,7 +139,9 @@ sap.ui.define(["sap/m/MessageToast", "sap/ui/core/library", "sap/ui/model/json/J
         } = await readControllers();
         this.model.setProperty('/controllersList', controllers);
       } catch (e) {
-        MessageToast.show(e.message);
+        MessageToast.show(e.message, {
+          duration: 5000
+        });
         throw new Error(e.message);
       }
     },

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

@@ -20,17 +20,31 @@ import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 /** sap.ui.fl */
 import Utils from 'sap/ui/fl/Utils';
 
+/** 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 { ControllersResponse } from '../api-handler';
-import { getManifestAppdescr, readControllers, writeChange, writeController } from '../api-handler';
+import type { CodeExtResponse, ControllersResponse } from '../api-handler';
+import {
+    getExistingController,
+    getManifestAppdescr,
+    readControllers,
+    writeChange,
+    writeController
+} from '../api-handler';
 import BaseDialog from './BaseDialog.controller';
 
 interface ControllerExtensionService {
     add: (codeRef: string, viewId: string) => Promise<unknown>;
 }
 
+interface ControllerInfo {
+    controllerName: string;
+    viewId: string;
+}
+
 /**
  * @namespace open.ux.preview.client.adp.controllers
  */
@@ -100,19 +114,15 @@ export default class ControllerExtension extends BaseDialog {
             return;
         }
 
-       if(controllerName.length > 64) {
-            updateDialogState(
-                ValueState.Error,
-                'A controller file name cannot contain more than 64 characters.'
-            );
+        if (controllerName.length > 64) {
+            updateDialogState(ValueState.Error, 'A controller file name cannot contain more than 64 characters.');
             return;
         }
-        
+
         updateDialogState(ValueState.Success);
         this.model.setProperty('/newControllerName', controllerName);
     }
 
-
     /**
      * Handles create button press
      *
@@ -120,28 +130,108 @@ export default class ControllerExtension extends BaseDialog {
      */
     async onCreateBtnPress(event: Event) {
         const source = event.getSource<Button>();
-        source.setEnabled(false);
+        const controllerExists = this.model.getProperty('/controllerExists');
 
-        const controllerName = this.model.getProperty('/newControllerName');
-        const viewId = this.model.getProperty('/viewId');
+        if (!controllerExists) {
+            source.setEnabled(false);
 
-        await this.createNewController(controllerName, viewId);
+            const controllerName = this.model.getProperty('/newControllerName');
+            const viewId = this.model.getProperty('/viewId');
+
+            await this.createNewController(controllerName, viewId);
+        } else {
+            const controllerPath = this.model.getProperty('/controllerPath');
+            window.open(`vscode://file${controllerPath}`);
+        }
 
         this.handleDialogClose();
     }
 
     /**
-     * Builds data that is used in the dialog
+     * Builds data that is used in the dialog.
      */
     async buildDialogData(): Promise<void> {
         const selectorId = this.overlays.getId();
         const overlayControl = sap.ui.getCore().byId(selectorId) as unknown as ElementOverlay;
+
+        const { controllerName, viewId } = this.getControllerInfo(overlayControl);
+
+        const { controllerExists, controllerPath, controllerPathFromRoot } = await this.getExistingController(
+            controllerName
+        );
+
+        if (controllerExists) {
+            this.updateModelForExistingController(controllerExists, controllerPath, controllerPathFromRoot);
+        } else {
+            this.updateModelForNewController(viewId);
+
+            await this.getControllers();
+        }
+    }
+
+    /**
+     * Gets controller name and view ID for the given overlay control.
+     *
+     * @param overlayControl The overlay control.
+     * @returns The controller name and view ID.
+     */
+    private getControllerInfo(overlayControl: ElementOverlay): ControllerInfo {
         const control = overlayControl.getElement();
-        const viewId = Utils.getViewForControl(control).getId();
+        const view = Utils.getViewForControl(control);
+        const controllerName = view.getController().getMetadata().getName();
+        const viewId = view.getId();
+        return { controllerName, viewId };
+    }
+
+    /**
+     * Updates the model properties for an existing controller.
+     *
+     * @param controllerExists Whether the controller exists
+     * @param controllerPath The controller path
+     * @param controllerPathFromRoot The controller path from the project root
+     */
+    private updateModelForExistingController(
+        controllerExists: boolean,
+        controllerPath: string,
+        controllerPathFromRoot: string
+    ): void {
+        this.model.setProperty('/controllerExists', controllerExists);
+        this.model.setProperty('/controllerPath', controllerPath);
+        this.model.setProperty('/controllerPathFromRoot', controllerPathFromRoot);
+
+        const form = this.byId('controllerExtensionDialog_Form') as SimpleForm;
+        form.setVisible(false);
+
+        const messageForm = this.byId('controllerExtensionDialog_Form--existingController') as SimpleForm;
+        messageForm.setVisible(true);
+
+        this.dialog.getBeginButton().setText('Open in VS Code').setEnabled(true);
+        this.dialog.getEndButton().setText('Close');
+    }
 
+    /**
+     * Updates the model property for a new controller.
+     *
+     * @param viewId The view ID
+     */
+    private updateModelForNewController(viewId: string): void {
         this.model.setProperty('/viewId', viewId);
+    }
 
-        await this.getControllers();
+    /**
+     * Retrieves existing controller data if found in the project's workspace.
+     *
+     * @param controllerName Controller name that exists in the view
+     * @returns Returnsexisting controller data
+     */
+    private async getExistingController(controllerName: string): Promise<CodeExtResponse> {
+        try {
+            const data = await getExistingController(controllerName);
+            return data;
+        } catch (e) {
+            MessageToast.show(e.message, { duration: 5000 });
+            throw new Error(e.message);
+        }
     }
 
     /**
@@ -152,7 +242,7 @@ export default class ControllerExtension extends BaseDialog {
             const { controllers } = await readControllers<ControllersResponse>();
             this.model.setProperty('/controllersList', controllers);
         } catch (e) {
-            MessageToast.show(e.message);
+            MessageToast.show(e.message, { duration: 5000 });
             throw new Error(e.message);
         }
     }

package/dist/client/adp/ui/ControllerExtension.view.xml

@@ -18,6 +18,17 @@
                         </Input>
                     </f:content>
                 </f:SimpleForm>
+                <f:SimpleForm id="controllerExtensionDialog_Form--existingController"
+                    editable="true"
+                    layout="ResponsiveGridLayout"
+                    labelSpanS="12"
+                    visible="false"
+                    singleContainerFullSize="false">
+                    <f:content>
+                        <Label text="An existing controller extension has been found. Please use the previously created extension controller" />
+                        <Text text="{/controllerPathFromRoot}" />
+                    </f:content>
+                </f:SimpleForm>
             </content>
             <beginButton>
                 <Button 

package/dist/client/cpe/changes/flex-change.js

@@ -1,8 +1,9 @@
 "use strict";
 
-sap.ui.define(["sap/ui/rta/command/CommandFactory"], function (CommandFactory) {
+sap.ui.define(["sap/ui/rta/command/CommandFactory", "./validator"], function (CommandFactory, ___validator) {
   "use strict";
 
+  const validateBindingModel = ___validator["validateBindingModel"];
   /**
    * Function to check a give value is a binding expression.
    *
@@ -10,7 +11,7 @@ sap.ui.define(["sap/ui/rta/command/CommandFactory"], function (CommandFactory) {
    * @returns boolean
    */
   function isBindingExpression(value) {
-    return value.includes('{') && value.includes('}');
+    return value.includes('{') && value.includes('}') && value.indexOf('{') < value.indexOf('}');
   }
 
   /**
@@ -26,9 +27,15 @@ sap.ui.define(["sap/ui/rta/command/CommandFactory"], function (CommandFactory) {
     if (!modifiedControl) {
       return;
     }
+    const isBindingString = typeof change.value === 'string' && isBindingExpression(change.value);
+    const modifiedControlModifiedProperties = modifiedControl.getMetadata().getAllProperties()[change.propertyName];
+    const isBindingModel = isBindingString && modifiedControlModifiedProperties?.type === 'string';
     const flexSettings = rta.getFlexSettings();
-    const changeType = typeof change.value === 'string' && isBindingExpression(change.value) ? 'BindProperty' : 'Property';
-    const property = typeof change.value === 'string' && isBindingExpression(change.value) ? 'newBinding' : 'newValue';
+    const changeType = isBindingString ? 'BindProperty' : 'Property';
+    if (isBindingModel) {
+      validateBindingModel(change.value);
+    }
+    const property = isBindingString ? 'newBinding' : 'newValue';
     const modifiedValue = {
       generator: flexSettings.generator,
       propertyName: change.propertyName,

package/dist/client/cpe/changes/flex-change.ts

@@ -2,6 +2,7 @@ import type FlexCommand from 'sap/ui/rta/command/FlexCommand';
 import CommandFactory from 'sap/ui/rta/command/CommandFactory';
 import type { PropertyChange } from '@sap-ux-private/control-property-editor-common';
 import type { UI5AdaptationOptions } from '../types';
+import { validateBindingModel } from './validator';
 
 /**
  * Function to check a give value is a binding expression.
@@ -10,7 +11,7 @@ import type { UI5AdaptationOptions } from '../types';
  * @returns boolean
  */
 function isBindingExpression(value: string): boolean {
-    return value.includes('{') && value.includes('}');
+    return value.includes('{') && value.includes('}') && value.indexOf('{') < value.indexOf('}');
 }
 
 /**
@@ -25,12 +26,17 @@ export async function applyChange(options: UI5AdaptationOptions, change: Propert
         return;
     }
 
+    const isBindingString = typeof change.value === 'string' && isBindingExpression(change.value);
+    const modifiedControlModifiedProperties = modifiedControl.getMetadata().getAllProperties()[change.propertyName];
+    const isBindingModel = isBindingString && modifiedControlModifiedProperties?.type === 'string';
     const flexSettings = rta.getFlexSettings();
+    const changeType = isBindingString ? 'BindProperty' : 'Property';
 
-    const changeType =
-        typeof change.value === 'string' && isBindingExpression(change.value) ? 'BindProperty' : 'Property';
+    if (isBindingModel) {
+        validateBindingModel(change.value as string);
+    }
 
-    const property = typeof change.value === 'string' && isBindingExpression(change.value) ? 'newBinding' : 'newValue';
+    const property = isBindingString ? 'newBinding' : 'newValue';
     const modifiedValue = {
         generator: flexSettings.generator,
         propertyName: change.propertyName,

package/dist/client/cpe/changes/validator.js

@@ -0,0 +1,37 @@
+"use strict";
+
+sap.ui.define(["sap/base/i18n/ResourceBundle"], function (ResourceBundle) {
+  "use strict";
+
+  /**
+   * Function to validate if a given value is a valid binding model.
+   *
+   * @param value value to be checked.
+   */
+  function validateBindingModel(value) {
+    const bindingValue = value.replace(/[{}]/gi, '').trim();
+    const bindingParts = bindingValue.split('>').filter(el => el != '');
+    if (!bindingParts.length) {
+      throw new SyntaxError('Invalid binding string.');
+    }
+    if (bindingParts[0].trim() === 'i18n') {
+      if (bindingParts.length === 2) {
+        const resourceBundle = ResourceBundle.create({
+          url: '../i18n/i18n.properties'
+        });
+        const resourceKey = bindingParts[1].trim();
+        if (!resourceBundle.hasText(resourceKey)) {
+          throw new SyntaxError('Invalid key in the binding string. Supported value pattern is {i18n>YOUR_KEY}. Check if the key already exists in i18n.properties. If not, add the key in the i18n.properties file and reload the editor for the new key to take effect.');
+        }
+      } else {
+        throw new SyntaxError('Invalid binding string. Supported value pattern is {i18n>YOUR_KEY}');
+      }
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.validateBindingModel = validateBindingModel;
+  return __exports;
+});
+//# sourceMappingURL=validator.js.map

package/dist/client/cpe/changes/validator.ts

@@ -0,0 +1,31 @@
+import ResourceBundle from 'sap/base/i18n/ResourceBundle';
+
+/**
+ * Function to validate if a given value is a valid binding model.
+ *
+ * @param value value to be checked.
+ */
+export function validateBindingModel(value: string): void {
+    const bindingValue = value.replace(/[{}]/gi, '').trim();
+    const bindingParts = bindingValue.split('>').filter((el) => el != '');
+
+    if (!bindingParts.length) {
+        throw new SyntaxError('Invalid binding string.');
+    }
+
+    if (bindingParts[0].trim() === 'i18n') {
+        if (bindingParts.length === 2) {
+            const resourceBundle = ResourceBundle.create({
+                url: '../i18n/i18n.properties'
+            }) as ResourceBundle;
+            const resourceKey = bindingParts[1].trim();
+            if (!resourceBundle.hasText(resourceKey)) {
+                throw new SyntaxError(
+                    'Invalid key in the binding string. Supported value pattern is {i18n>YOUR_KEY}. Check if the key already exists in i18n.properties. If not, add the key in the i18n.properties file and reload the editor for the new key to take effect.'
+                );
+            }
+        } else {
+            throw new SyntaxError('Invalid binding string. Supported value pattern is {i18n>YOUR_KEY}');
+        }
+    }
+}

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.10.7",
+  "version": "0.11.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -24,7 +24,7 @@
   "dependencies": {
     "ejs": "3.1.9",
     "@sap-ux/logger": "0.4.0",
-    "@sap-ux/adp-tooling": "0.5.5",
+    "@sap-ux/adp-tooling": "0.6.0",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.2"
   },
   "devDependencies": {
@@ -36,8 +36,8 @@
     "npm-run-all": "4.1.5",
     "nock": "13.2.1",
     "supertest": "6.3.3",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.7.4",
-    "@sap-ux/project-access": "1.15.1",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.8.1",
+    "@sap-ux/project-access": "1.15.2",
     "@sap-ux/store": "0.4.0"
   },
   "peerDependencies": {