@sap-ux/preview-middleware 0.16.4 → 0.16.6

package/dist/client/adp/utils.js

@@ -1,63 +1,63 @@
-"use strict";
-
-sap.ui.define(["sap/m/MessageToast"], function (MessageToast) {
-  "use strict";
-
-  /**
-   * Defers the resolution of the promise, stores resolve/reject functions so that they can be accessed at a later stage.
-   *
-   * @description A Deferred object contains an unresolved promise along with the functions to resolve or reject that promise.
-   *
-   * @returns {Deferred} Deferred object
-   */
-  function createDeferred() {
-    let resolve = null;
-    let reject = null;
-    const promise = new Promise((res, rej) => {
-      resolve = res;
-      reject = rej;
-    });
-    if (resolve === null || reject === null) {
-      throw new Error('Failed to initialize resolve and reject functions.');
-    }
-    return {
-      promise,
-      resolve,
-      reject
-    };
-  }
-
-  /**
-   * Checks if the fragment name associated with a command matches the specified fragment name.
-   *
-   * @param {FlexCommand} command - The command object containing the prepared change to be examined.
-   * @param {string} fragmentName - The name of the fragment to match against the command's change.
-   * @returns {boolean} Returns true if the command's change contains a fragment path that matches
-   *                    the specified fragment name; otherwise, returns false.
-   */
-  function matchesFragmentName(command, fragmentName) {
-    const change = command.getPreparedChange().getDefinition();
-    return change.content?.fragmentPath?.includes(`${fragmentName}.fragment.xml`) || false;
-  }
-
-  /**
-   * Displays a message to the user indicating that an XML fragment will be created upon saving a change.
-   *
-   * @param {string} message - The message to be shown in the message toast.
-   * @param {number} duration - The duration during which message toast will be active.
-   */
-  function notifyUser(message) {
-    let duration = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 5000;
-    MessageToast.show(message, {
-      duration
-    });
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.createDeferred = createDeferred;
-  __exports.matchesFragmentName = matchesFragmentName;
-  __exports.notifyUser = notifyUser;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/m/MessageToast"], function (MessageToast) {
+  "use strict";
+
+  /**
+   * Defers the resolution of the promise, stores resolve/reject functions so that they can be accessed at a later stage.
+   *
+   * @description A Deferred object contains an unresolved promise along with the functions to resolve or reject that promise.
+   *
+   * @returns {Deferred} Deferred object
+   */
+  function createDeferred() {
+    let resolve = null;
+    let reject = null;
+    const promise = new Promise((res, rej) => {
+      resolve = res;
+      reject = rej;
+    });
+    if (resolve === null || reject === null) {
+      throw new Error('Failed to initialize resolve and reject functions.');
+    }
+    return {
+      promise,
+      resolve,
+      reject
+    };
+  }
+
+  /**
+   * Checks if the fragment name associated with a command matches the specified fragment name.
+   *
+   * @param {FlexCommand} command - The command object containing the prepared change to be examined.
+   * @param {string} fragmentName - The name of the fragment to match against the command's change.
+   * @returns {boolean} Returns true if the command's change contains a fragment path that matches
+   *                    the specified fragment name; otherwise, returns false.
+   */
+  function matchesFragmentName(command, fragmentName) {
+    const change = command.getPreparedChange().getDefinition();
+    return change.content?.fragmentPath?.includes(`${fragmentName}.fragment.xml`) || false;
+  }
+
+  /**
+   * Displays a message to the user indicating that an XML fragment will be created upon saving a change.
+   *
+   * @param {string} message - The message to be shown in the message toast.
+   * @param {number} duration - The duration during which message toast will be active.
+   */
+  function notifyUser(message) {
+    let duration = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 5000;
+    MessageToast.show(message, {
+      duration
+    });
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.createDeferred = createDeferred;
+  __exports.matchesFragmentName = matchesFragmentName;
+  __exports.notifyUser = notifyUser;
+  return __exports;
 });
 //# sourceMappingURL=utils.js.map

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

@@ -1,53 +1,53 @@
-"use strict";
-
-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.
-   *
-   * @param value value to be checked.
-   * @returns boolean
-   */
-  function isBindingExpression(value) {
-    return value.includes('{') && value.includes('}') && value.indexOf('{') < value.indexOf('}');
-  }
-
-  /**
-   *
-   * @param options UI5 adaptation options
-   * @param change changed property of a control
-   */
-  async function applyChange(options, change) {
-    const {
-      rta
-    } = options;
-    const modifiedControl = sap.ui.getCore().byId(change.controlId);
-    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 = isBindingString ? 'BindProperty' : 'Property';
-    if (isBindingModel) {
-      validateBindingModel(modifiedControl, change.value);
-    }
-    const property = isBindingString ? 'newBinding' : 'newValue';
-    const modifiedValue = {
-      generator: flexSettings.generator,
-      propertyName: change.propertyName,
-      [property]: change.value
-    };
-    const command = await CommandFactory.getCommandFor(modifiedControl, changeType, modifiedValue, null, flexSettings);
-    await rta.getCommandStack().pushAndExecute(command);
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.applyChange = applyChange;
-  return __exports;
+"use strict";
+
+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.
+   *
+   * @param value value to be checked.
+   * @returns boolean
+   */
+  function isBindingExpression(value) {
+    return value.includes('{') && value.includes('}') && value.indexOf('{') < value.indexOf('}');
+  }
+
+  /**
+   *
+   * @param options UI5 adaptation options
+   * @param change changed property of a control
+   */
+  async function applyChange(options, change) {
+    const {
+      rta
+    } = options;
+    const modifiedControl = sap.ui.getCore().byId(change.controlId);
+    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 = isBindingString ? 'BindProperty' : 'Property';
+    if (isBindingModel) {
+      validateBindingModel(modifiedControl, change.value);
+    }
+    const property = isBindingString ? 'newBinding' : 'newValue';
+    const modifiedValue = {
+      generator: flexSettings.generator,
+      propertyName: change.propertyName,
+      [property]: change.value
+    };
+    const command = await CommandFactory.getCommandFor(modifiedControl, changeType, modifiedValue, null, flexSettings);
+    await rta.getCommandStack().pushAndExecute(command);
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.applyChange = applyChange;
+  return __exports;
 });
 //# sourceMappingURL=flex-change.js.map

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

@@ -1,12 +1,12 @@
-"use strict";
-
-sap.ui.define(["./service"], function (___service) {
-  "use strict";
-
-  var __exports = {
-    __esModule: true
-  };
-  __exports.ChangeService = ___service.ChangeService;
-  return __exports;
+"use strict";
+
+sap.ui.define(["./service"], function (___service) {
+  "use strict";
+
+  var __exports = {
+    __esModule: true
+  };
+  __exports.ChangeService = ___service.ChangeService;
+  return __exports;
 });
 //# sourceMappingURL=index.js.map

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

@@ -1,36 +1,36 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  /**
-   * Function to validate if a given value is a valid binding model.
-   *
-   * @param modifiedControl control to be modified.
-   * @param value value to be checked.
-   */
-  function validateBindingModel(modifiedControl, 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 resourceKey = bindingParts[1].trim();
-        const resourceBundle = modifiedControl.getModel('i18n').getResourceBundle();
-        if (!resourceBundle.getText(resourceKey, undefined, true)) {
-          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;
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Function to validate if a given value is a valid binding model.
+   *
+   * @param modifiedControl control to be modified.
+   * @param value value to be checked.
+   */
+  function validateBindingModel(modifiedControl, 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 resourceKey = bindingParts[1].trim();
+        const resourceBundle = modifiedControl.getModel('i18n').getResourceBundle();
+        if (!resourceBundle.getText(resourceKey, undefined, true)) {
+          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/documentation.js

@@ -1,166 +1,166 @@
-"use strict";
-
-sap.ui.define(["./utils", "sap/base/Log"], function (___utils, Log) {
-  "use strict";
-
-  const getLibrary = ___utils["getLibrary"];
-  /**
-   * Get ui5 metadata of given library name.
-   *
-   * @param libName library name for eg: sap.m
-   * @returns Promise<SchemaForApiJsonFiles>
-   */
-  async function getUi5ApiDtMetadata(libName) {
-    const libUrl = '/test-resources/' + libName.split('.').join('/') + '/designtime/api.json';
-    return fetch(libUrl).then(res => res.json());
-  }
-
-  /**
-   * load ui5 controls design time metadata api.json for following libraries
-   * sap.m, sap.ui.comp, sap.f, sap.ui.core
-   * loading libraries(more in file size) in parallel during initialization.
-   * Others (less in file size) are loaded dynamically in getControlMetadata method
-   */
-  const ui5ApiDtMetadata = new Map();
-  function loadDefaultLibraries() {
-    const allData = Promise.all([getUi5ApiDtMetadata('sap.m'), getUi5ApiDtMetadata('sap.ui.comp'), getUi5ApiDtMetadata('sap.ui.core'), getUi5ApiDtMetadata('sap.f')]);
-    allData.then(res => {
-      res.forEach(api => {
-        if (api.library) {
-          ui5ApiDtMetadata.set(api.library, api);
-        }
-      });
-    }).catch(reason => Log.error('Loading Library Failed: ' + reason));
-  }
-
-  /**
-   * Format html text.
-   *
-   * @param sHtml - html string
-   * @returns string
-   */
-  function formatHtmlText(sHtml) {
-    // replaced "sHtml.replace(new RegExp('<[^>]*>', 'g')" due to regex runtime vulnerability
-    const parts = (sHtml || '').split('<');
-    let result = '';
-    for (const part of parts) {
-      if (!result) {
-        result = part;
-      } else {
-        const indexClosingBracket = part.indexOf('>');
-        result += indexClosingBracket >= 0 ? part.substring(indexClosingBracket + 1) : `<${part}`;
-      }
-    }
-    return result;
-  }
-
-  /**
-   * Method to parse ui5 control metadata.
-   *
-   * @param controlLibMetadata control library metadata
-   * @param controlName name of the control
-   * @returns ControlMetadata
-   */
-  function parseControlMetaModel(controlLibMetadata, controlName) {
-    const controlInfo = {
-      baseType: '',
-      doc: '',
-      properties: {}
-    };
-    const selectedControlMetadata = (controlLibMetadata.symbols ?? []).find(control => control.name === controlName);
-    if (selectedControlMetadata) {
-      // base type info of control is available on property 'extends'
-      controlInfo.baseType = selectedControlMetadata.extends;
-      controlInfo.doc = selectedControlMetadata.description ?? '';
-      const properties = selectedControlMetadata['ui5-metadata'].properties;
-      if (properties) {
-        properties.forEach(prop => {
-          prop.description = formatHtmlText(prop.description || '');
-          prop.propertyName = prop.name;
-          prop.propertyType = prop.type;
-          if (prop.defaultValue === null || prop.defaultValue === '') {
-            prop.defaultValue = '-';
-          }
-          controlInfo.properties[prop.name] = {
-            ...prop
-          };
-        });
-      }
-    }
-    return controlInfo;
-  }
-
-  /**
-   * Get control metadata for a given control.
-   *
-   * @param controlName name of the control
-   * @param contLibName library name of the control
-   * @returns Promise<ControlMetadata | undefined>
-   */
-  async function getControlMetadata(controlName, contLibName) {
-    let result;
-    let controlLibMetadata = ui5ApiDtMetadata.get(contLibName);
-    if (controlLibMetadata) {
-      result = parseControlMetaModel(controlLibMetadata, controlName);
-    } else {
-      controlLibMetadata = await getUi5ApiDtMetadata(contLibName);
-      ui5ApiDtMetadata.set(contLibName, controlLibMetadata);
-      result = parseControlMetaModel(controlLibMetadata, controlName);
-    }
-    return result;
-  }
-
-  /**
-   * Get Control Property Documentation for a give control name and control library.
-   *
-   * @param controlName name of the control
-   * @param contLibName library name of the control
-   * @returns Promise<Properties | undefined>
-   */
-  async function getControlPropertyDocumentation(controlName, contLibName) {
-    const doc = await getControlMetadata(controlName, contLibName);
-    if (doc) {
-      const baseControlType = doc.baseType;
-      if (baseControlType) {
-        const baseContLibName = await getLibrary(baseControlType);
-        if (baseContLibName) {
-          const baseControlProps = await getControlPropertyDocumentation(baseControlType, baseContLibName);
-          return {
-            ...baseControlProps,
-            ...doc.properties
-          };
-        }
-      }
-      return {
-        ...doc.properties
-      };
-    } else {
-      return undefined;
-    }
-  }
-
-  /**
-   * Get documentation of a given control of a ui5 library.
-   *
-   * @param controlName name of the control.
-   * @param contLibName library name of the control
-   * @returns Promise<Properties | undefined>
-   */
-  async function getDocumentation(controlName, contLibName) {
-    let doc;
-    try {
-      doc = await getControlPropertyDocumentation(controlName, contLibName);
-    } catch (err) {
-      Log.error(`Error in getting documentation for ${contLibName}`);
-    }
-    return doc;
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.getUi5ApiDtMetadata = getUi5ApiDtMetadata;
-  __exports.loadDefaultLibraries = loadDefaultLibraries;
-  __exports.getDocumentation = getDocumentation;
-  return __exports;
+"use strict";
+
+sap.ui.define(["./utils", "sap/base/Log"], function (___utils, Log) {
+  "use strict";
+
+  const getLibrary = ___utils["getLibrary"];
+  /**
+   * Get ui5 metadata of given library name.
+   *
+   * @param libName library name for eg: sap.m
+   * @returns Promise<SchemaForApiJsonFiles>
+   */
+  async function getUi5ApiDtMetadata(libName) {
+    const libUrl = '/test-resources/' + libName.split('.').join('/') + '/designtime/api.json';
+    return fetch(libUrl).then(res => res.json());
+  }
+
+  /**
+   * load ui5 controls design time metadata api.json for following libraries
+   * sap.m, sap.ui.comp, sap.f, sap.ui.core
+   * loading libraries(more in file size) in parallel during initialization.
+   * Others (less in file size) are loaded dynamically in getControlMetadata method
+   */
+  const ui5ApiDtMetadata = new Map();
+  function loadDefaultLibraries() {
+    const allData = Promise.all([getUi5ApiDtMetadata('sap.m'), getUi5ApiDtMetadata('sap.ui.comp'), getUi5ApiDtMetadata('sap.ui.core'), getUi5ApiDtMetadata('sap.f')]);
+    allData.then(res => {
+      res.forEach(api => {
+        if (api.library) {
+          ui5ApiDtMetadata.set(api.library, api);
+        }
+      });
+    }).catch(reason => Log.error('Loading Library Failed: ' + reason));
+  }
+
+  /**
+   * Format html text.
+   *
+   * @param sHtml - html string
+   * @returns string
+   */
+  function formatHtmlText(sHtml) {
+    // replaced "sHtml.replace(new RegExp('<[^>]*>', 'g')" due to regex runtime vulnerability
+    const parts = (sHtml || '').split('<');
+    let result = '';
+    for (const part of parts) {
+      if (!result) {
+        result = part;
+      } else {
+        const indexClosingBracket = part.indexOf('>');
+        result += indexClosingBracket >= 0 ? part.substring(indexClosingBracket + 1) : `<${part}`;
+      }
+    }
+    return result;
+  }
+
+  /**
+   * Method to parse ui5 control metadata.
+   *
+   * @param controlLibMetadata control library metadata
+   * @param controlName name of the control
+   * @returns ControlMetadata
+   */
+  function parseControlMetaModel(controlLibMetadata, controlName) {
+    const controlInfo = {
+      baseType: '',
+      doc: '',
+      properties: {}
+    };
+    const selectedControlMetadata = (controlLibMetadata.symbols ?? []).find(control => control.name === controlName);
+    if (selectedControlMetadata) {
+      // base type info of control is available on property 'extends'
+      controlInfo.baseType = selectedControlMetadata.extends;
+      controlInfo.doc = selectedControlMetadata.description ?? '';
+      const properties = selectedControlMetadata['ui5-metadata'].properties;
+      if (properties) {
+        properties.forEach(prop => {
+          prop.description = formatHtmlText(prop.description || '');
+          prop.propertyName = prop.name;
+          prop.propertyType = prop.type;
+          if (prop.defaultValue === null || prop.defaultValue === '') {
+            prop.defaultValue = '-';
+          }
+          controlInfo.properties[prop.name] = {
+            ...prop
+          };
+        });
+      }
+    }
+    return controlInfo;
+  }
+
+  /**
+   * Get control metadata for a given control.
+   *
+   * @param controlName name of the control
+   * @param contLibName library name of the control
+   * @returns Promise<ControlMetadata | undefined>
+   */
+  async function getControlMetadata(controlName, contLibName) {
+    let result;
+    let controlLibMetadata = ui5ApiDtMetadata.get(contLibName);
+    if (controlLibMetadata) {
+      result = parseControlMetaModel(controlLibMetadata, controlName);
+    } else {
+      controlLibMetadata = await getUi5ApiDtMetadata(contLibName);
+      ui5ApiDtMetadata.set(contLibName, controlLibMetadata);
+      result = parseControlMetaModel(controlLibMetadata, controlName);
+    }
+    return result;
+  }
+
+  /**
+   * Get Control Property Documentation for a give control name and control library.
+   *
+   * @param controlName name of the control
+   * @param contLibName library name of the control
+   * @returns Promise<Properties | undefined>
+   */
+  async function getControlPropertyDocumentation(controlName, contLibName) {
+    const doc = await getControlMetadata(controlName, contLibName);
+    if (doc) {
+      const baseControlType = doc.baseType;
+      if (baseControlType) {
+        const baseContLibName = await getLibrary(baseControlType);
+        if (baseContLibName) {
+          const baseControlProps = await getControlPropertyDocumentation(baseControlType, baseContLibName);
+          return {
+            ...baseControlProps,
+            ...doc.properties
+          };
+        }
+      }
+      return {
+        ...doc.properties
+      };
+    } else {
+      return undefined;
+    }
+  }
+
+  /**
+   * Get documentation of a given control of a ui5 library.
+   *
+   * @param controlName name of the control.
+   * @param contLibName library name of the control
+   * @returns Promise<Properties | undefined>
+   */
+  async function getDocumentation(controlName, contLibName) {
+    let doc;
+    try {
+      doc = await getControlPropertyDocumentation(controlName, contLibName);
+    } catch (err) {
+      Log.error(`Error in getting documentation for ${contLibName}`);
+    }
+    return doc;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getUi5ApiDtMetadata = getUi5ApiDtMetadata;
+  __exports.loadDefaultLibraries = loadDefaultLibraries;
+  __exports.getDocumentation = getDocumentation;
+  return __exports;
 });
 //# sourceMappingURL=documentation.js.map