@sap-ux/preview-middleware 0.11.0 → 0.11.1

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.11.0",
+  "version": "0.11.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -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.8.0",
-    "@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": {