@sap-ux/preview-middleware 0.18.20 → 0.18.23

package/dist/client/flp/enableFakeConnector.js

@@ -1,85 +1,85 @@
-"use strict";
-
-sap.ui.define(["sap/ui/fl/LrepConnector", "sap/ui/fl/FakeLrepConnector", "./common"], function (LrepConnector, FakeLrepConnector, ___common) {
-  "use strict";
-
-  const CHANGES_API_PATH = ___common["CHANGES_API_PATH"];
-  const getFlexSettings = ___common["getFlexSettings"];
-  /**
-   * Processes an array of FlexChange objects.
-   * It updates each change object with settings and sends them to a API endpoint.
-   *
-   * @param {FlexChange | FlexChange[]} changes - Array of FlexChange objects to be processed.
-   * @returns {Promise<void>} A promise that resolves when all changes are processed.
-   */
-  async function create(changes) {
-    const settings = getFlexSettings();
-    await Promise.all((Array.isArray(changes) ? changes : [changes]).map(change => {
-      if (settings) {
-        change.support ??= {};
-        change.support.generator = settings.generator;
-      }
-      if (typeof FakeLrepConnector.fileChangeRequestNotifier === 'function' && change.fileName) {
-        try {
-          FakeLrepConnector.fileChangeRequestNotifier(change.fileName, 'create', change);
-        } catch (e) {
-          // exceptions in the listener call are ignored
-        }
-      }
-      return fetch(CHANGES_API_PATH, {
-        method: 'POST',
-        body: JSON.stringify(change, null, 2),
-        headers: {
-          'content-type': 'application/json'
-        }
-      });
-    }));
-  }
-
-  /**
-   * Loads changes from a given path and processes them using an LrepConnector instance.
-   * The changes are then formatted and returned in a specified structure.
-   *
-   * @returns {Promise<LoadChangesResult>} A promise that resolves to an object of type LoadChangesResult.
-   */
-  async function loadChanges() {
-    const lrep = new LrepConnector();
-    const response = await fetch(CHANGES_API_PATH, {
-      method: 'GET',
-      headers: {
-        'content-type': 'application/json'
-      }
-    });
-    const changes = await response.json();
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-    return LrepConnector.prototype.loadChanges.apply(lrep, args).then(res => {
-      res.changes.changes = Object.values(changes);
-      return res;
-    });
-  }
-
-  /**
-   * Configures and enables the FakeLrepConnector based on the SAP UI5 version.
-   * If the minor version of the SAP UI5 is less than 72, this function extends
-   * the FakeLrepConnector's prototype with specific methods and enables the fake connector.
-   *
-   * Assumes the existence of a global 'sap' object with a 'ui.version' property,
-   * and global jQuery object with 'extend' method.
-   *
-   * @returns {void}
-   */
-  var __exports = function () {
-    jQuery.extend(FakeLrepConnector.prototype, {
-      create,
-      loadChanges,
-      loadSettings: () => Promise.resolve()
-    });
-    FakeLrepConnector.enableFakeConnector();
-  };
-  __exports.create = create;
-  __exports.loadChanges = loadChanges;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/ui/fl/LrepConnector", "sap/ui/fl/FakeLrepConnector", "./common"], function (LrepConnector, FakeLrepConnector, ___common) {
+  "use strict";
+
+  const CHANGES_API_PATH = ___common["CHANGES_API_PATH"];
+  const getFlexSettings = ___common["getFlexSettings"];
+  /**
+   * Processes an array of FlexChange objects.
+   * It updates each change object with settings and sends them to a API endpoint.
+   *
+   * @param {FlexChange | FlexChange[]} changes - Array of FlexChange objects to be processed.
+   * @returns {Promise<void>} A promise that resolves when all changes are processed.
+   */
+  async function create(changes) {
+    const settings = getFlexSettings();
+    await Promise.all((Array.isArray(changes) ? changes : [changes]).map(change => {
+      if (settings) {
+        change.support ??= {};
+        change.support.generator = settings.generator;
+      }
+      if (typeof FakeLrepConnector.fileChangeRequestNotifier === 'function' && change.fileName) {
+        try {
+          FakeLrepConnector.fileChangeRequestNotifier(change.fileName, 'create', change);
+        } catch (e) {
+          // exceptions in the listener call are ignored
+        }
+      }
+      return fetch(CHANGES_API_PATH, {
+        method: 'POST',
+        body: JSON.stringify(change, null, 2),
+        headers: {
+          'content-type': 'application/json'
+        }
+      });
+    }));
+  }
+
+  /**
+   * Loads changes from a given path and processes them using an LrepConnector instance.
+   * The changes are then formatted and returned in a specified structure.
+   *
+   * @returns {Promise<LoadChangesResult>} A promise that resolves to an object of type LoadChangesResult.
+   */
+  async function loadChanges() {
+    const lrep = new LrepConnector();
+    const response = await fetch(CHANGES_API_PATH, {
+      method: 'GET',
+      headers: {
+        'content-type': 'application/json'
+      }
+    });
+    const changes = await response.json();
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    return LrepConnector.prototype.loadChanges.apply(lrep, args).then(res => {
+      res.changes.changes = Object.values(changes);
+      return res;
+    });
+  }
+
+  /**
+   * Configures and enables the FakeLrepConnector based on the SAP UI5 version.
+   * If the minor version of the SAP UI5 is less than 72, this function extends
+   * the FakeLrepConnector's prototype with specific methods and enables the fake connector.
+   *
+   * Assumes the existence of a global 'sap' object with a 'ui.version' property,
+   * and global jQuery object with 'extend' method.
+   *
+   * @returns {void}
+   */
+  var __exports = function () {
+    jQuery.extend(FakeLrepConnector.prototype, {
+      create,
+      loadChanges,
+      loadSettings: () => Promise.resolve()
+    });
+    FakeLrepConnector.enableFakeConnector();
+  };
+  __exports.create = create;
+  __exports.loadChanges = loadChanges;
+  return __exports;
 });
 //# sourceMappingURL=enableFakeConnector.js.map

package/dist/client/flp/initConnectors.js

@@ -1,30 +1,30 @@
-"use strict";
-
-sap.ui.define(["../utils/version"], function (___utils_version) {
-  "use strict";
-
-  const getUi5Version = ___utils_version["getUi5Version"];
-  const isLowerThanMinimalUi5Version = ___utils_version["isLowerThanMinimalUi5Version"];
-  /**
-   * Initializes UI5 connectors based on the current UI5 version.
-   *
-   * For UI5 versions below 1.72, this function dynamically requires and executes a FakeLrepConnector.
-   * For UI5 versions 1.72 and above, it defines a local connector that reuses the WorkspaceConnector.
-   * This setup allows for flexibility in using different connectors based on the UI5 version.
-   *
-   * @example
-   * intiConnectors(); // Simply call the function without any arguments.
-   */
-  async function initConnectors() {
-    if (isLowerThanMinimalUi5Version(await getUi5Version(), {
-      major: 1,
-      minor: 72
-    })) {
-      sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector) {
-        enableFakeConnector();
-      });
-    }
-  }
-  return initConnectors;
+"use strict";
+
+sap.ui.define(["../utils/version"], function (___utils_version) {
+  "use strict";
+
+  const getUi5Version = ___utils_version["getUi5Version"];
+  const isLowerThanMinimalUi5Version = ___utils_version["isLowerThanMinimalUi5Version"];
+  /**
+   * Initializes UI5 connectors based on the current UI5 version.
+   *
+   * For UI5 versions below 1.72, this function dynamically requires and executes a FakeLrepConnector.
+   * For UI5 versions 1.72 and above, it defines a local connector that reuses the WorkspaceConnector.
+   * This setup allows for flexibility in using different connectors based on the UI5 version.
+   *
+   * @example
+   * intiConnectors(); // Simply call the function without any arguments.
+   */
+  async function initConnectors() {
+    if (isLowerThanMinimalUi5Version(await getUi5Version(), {
+      major: 1,
+      minor: 72
+    })) {
+      sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector) {
+        enableFakeConnector();
+      });
+    }
+  }
+  return initConnectors;
 });
 //# sourceMappingURL=initConnectors.js.map

package/dist/client/flp/initRta.js

@@ -1,180 +1,180 @@
-"use strict";
-
-sap.ui.define(["sap/base/util/merge", "sap/ui/core/Control", "sap/ui/core/UIComponent", "sap/ui/fl/Utils", "sap/ui/fl/write/api/FeaturesAPI", "sap/ui/rta/RuntimeAuthoring"], function (merge, Control, UIComponent, Utils, FeaturesAPI, RuntimeAuthoring) {
-  "use strict";
-
-  const defaultOptions = {
-    flexSettings: {
-      developerMode: false,
-      layer: 'CUSTOMER'
-    }
-  };
-  const layers = {
-    BASE: 'BASE',
-    CUSTOMER: 'CUSTOMER',
-    CUSTOMER_BASE: 'CUSTOMER_BASE',
-    PARTNER: 'PARTNER',
-    PUBLIC: 'PUBLIC',
-    USER: 'USER',
-    VENDOR: 'VENDOR'
-  };
-
-  /**
-   * Checks if the given layer is a valid layer.
-   *
-   * @param {string} layer - The layer name to be validated.
-   * @returns {boolean} Returns true if the layer is valid, otherwise false.
-   */
-  function isValidLayer(layer) {
-    return Object.keys(layers).some(existingLayer => existingLayer === layer);
-  }
-
-  /**
-   * Validates a given layer and throws an error if it is invalid.
-   *
-   * @param {string} layer - The layer name to be checked.
-   * @throws {Error} Throws an error if the layer is not valid.
-   */
-  function checkLayer(layer) {
-    if (!isValidLayer(layer)) {
-      throw new Error('An invalid layer is passed');
-    }
-  }
-
-  /**
-   * Checks if the given root control is an instance of Control or UIComponent.
-   *
-   * @param {Control | UIComponent} rootControl - The root control to be checked.
-   * @throws {Error} Throws an error if the root control is not an instance of Control or UIComponent.
-   */
-  function checkRootControl(rootControl) {
-    if (!(rootControl instanceof Control) && !(rootControl instanceof UIComponent)) {
-      throw new Error('An invalid root control was passed');
-    }
-  }
-
-  /**
-   * Checks if key user adaptation is enabled for the specified component.
-   * Fiori tools mode is considered a developer scenario where the `flexEnabled` flag should not be evaluated.
-   *
-   * @param {Control} component - The UI5 control component to check for flex (key user adaptation) enabled status.
-   * @throws {Error} Throws an error if key user adaptation is explicitly disabled in the component's manifest.
-   */
-  function checkFlexEnabled(component) {
-    // fiori tools is always a developer scenario where the flexEnabled flag should not be evaluated
-    const fioriToolsMode = new URLSearchParams(window.location.search).get('fiori-tools-rta-mode');
-    if (!fioriToolsMode || fioriToolsMode === 'false') {
-      const manifest = component.getManifest() || {};
-      const flexEnabled = manifest['sap.ui5']?.flexEnabled;
-      if (flexEnabled === false) {
-        throw new Error('This app is not enabled for key user adaptation');
-      }
-    }
-  }
-
-  /**
-   * Checks if the current user is a key user for the given layer.
-   * Specifically, it checks for key user rights if the layer is the CUSTOMER layer.
-   * If the user is not a key user and the layer is CUSTOMER, an error is thrown.
-   *
-   * Note: The function assumes the presence of 'layers.CUSTOMER'. In case of non-CUSTOMER layers,
-   * it simply resolves the promise without any additional checks.
-   *
-   * @param {string} layer - The layer for which to check key user rights.
-   * @returns {Promise<void>} A promise that resolves if the user is a key user or the layer is not CUSTOMER.
-   *                          Rejects with an error if the user is not a key user for the CUSTOMER layer.
-   * @throws {Error} Throws an error with the message 'No key user rights found' if the user lacks key user rights.
-   */
-  async function checkKeyUser(layer) {
-    if (layers.CUSTOMER === layer) {
-      const isKeyUser = await FeaturesAPI.isKeyUser();
-      if (!isKeyUser) {
-        throw new Error('No key user rights found');
-      }
-    }
-  }
-
-  /**
-   * Checks the validity of the specified layer and root control.
-   * It ensures that the layer is valid and the root control is an instance of Control or UIComponent.
-   * Additionally, it checks key user permissions for the specified layer.
-   *
-   * @param {Control} rootControl - The root control to be validated.
-   * @param {string} layer - The layer name to be validated.
-   * @returns {Promise<void>} A promise that resolves when all checks pass without errors.
-   * @throws {Error} Throws an error if any of the checks fail.
-   */
-  async function checkLayerAndControl(rootControl, layer) {
-    checkLayer(layer);
-    checkRootControl(rootControl);
-    await checkKeyUser(layer);
-  }
-
-  /**
-   * Retrieves the first HTML element with the specified title attribute.
-   *
-   * @param {string} title - The title attribute value to search for in the HTML elements.
-   * @param {Element | null} element - The target element that will be searched.
-   * @returns {Element | null} The first HTML element that matches the given title attribute value, or null if no such element is found.
-   */
-  function getElementByTitle(title, element) {
-    const selector = `[title="${title}"]`;
-    return element ? element.querySelector(selector) : document.querySelector(selector);
-  }
-
-  /**
-   * Hides a UI5 Button control with the specified ID.
-   *
-   * This function attempts to find a UI5 Button control by its ID and then sets its visibility to false.
-   *
-   * @param {string | undefined} buttonId - The ID of the Button control to hide. If undefined, no action is taken.
-   * @returns {void}
-   */
-  function hideButtonById(buttonId) {
-    const button = sap.ui.getCore().byId(buttonId);
-    button?.setVisible(false);
-  }
-
-  /**
-   * Hides specific buttons by ID from the RTA toolbar.
-   * This function specifically targets buttons 'Reset' and 'Publish'.
-   */
-  function removeExtraBtnsFromToolbar() {
-    const rtaToolbarEl = document.querySelector('.sapUiRtaToolbar');
-    const resetEl = getElementByTitle('Reset', rtaToolbarEl);
-    const publishEl = getElementByTitle('Publish', rtaToolbarEl);
-    hideButtonById(resetEl?.id);
-    hideButtonById(publishEl?.id);
-  }
-
-  /**
-   * Initializes custom RuntimeAuthoring for UI5 Versions < 1.72 and start UI Adaptation.
-   * Ensures that the passed options are valid.
-   *
-   * @param {RTAOptions} options - Options that are passed to RuntimeAuthoring upon initialization.
-   * @param {RTAPlugin} loadPlugins - Script that needs to be executed after rta is initialized.
-   * @returns {Promise<void>} A promise that resolves when all the checks have passed and RuntimeAuthoring is started.
-   */
-  var __exports = async function (options, loadPlugins) {
-    options = merge(defaultOptions, options);
-    const layer = options.flexSettings.layer;
-    const rootControl = options.rootControl;
-    await checkLayerAndControl(rootControl, layer);
-    options.rootControl = Utils.getAppComponentForControl(rootControl);
-    checkFlexEnabled(options.rootControl);
-    const rta = new RuntimeAuthoring(options);
-    rta.attachEvent('stop', () => rta.destroy());
-    if (loadPlugins) {
-      await loadPlugins(rta);
-    }
-    await rta.start();
-    removeExtraBtnsFromToolbar();
-  };
-  __exports.isValidLayer = isValidLayer;
-  __exports.checkLayer = checkLayer;
-  __exports.checkRootControl = checkRootControl;
-  __exports.checkFlexEnabled = checkFlexEnabled;
-  __exports.checkKeyUser = checkKeyUser;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/base/util/merge", "sap/ui/core/Control", "sap/ui/core/UIComponent", "sap/ui/fl/Utils", "sap/ui/fl/write/api/FeaturesAPI", "sap/ui/rta/RuntimeAuthoring"], function (merge, Control, UIComponent, Utils, FeaturesAPI, RuntimeAuthoring) {
+  "use strict";
+
+  const defaultOptions = {
+    flexSettings: {
+      developerMode: false,
+      layer: 'CUSTOMER'
+    }
+  };
+  const layers = {
+    BASE: 'BASE',
+    CUSTOMER: 'CUSTOMER',
+    CUSTOMER_BASE: 'CUSTOMER_BASE',
+    PARTNER: 'PARTNER',
+    PUBLIC: 'PUBLIC',
+    USER: 'USER',
+    VENDOR: 'VENDOR'
+  };
+
+  /**
+   * Checks if the given layer is a valid layer.
+   *
+   * @param {string} layer - The layer name to be validated.
+   * @returns {boolean} Returns true if the layer is valid, otherwise false.
+   */
+  function isValidLayer(layer) {
+    return Object.keys(layers).some(existingLayer => existingLayer === layer);
+  }
+
+  /**
+   * Validates a given layer and throws an error if it is invalid.
+   *
+   * @param {string} layer - The layer name to be checked.
+   * @throws {Error} Throws an error if the layer is not valid.
+   */
+  function checkLayer(layer) {
+    if (!isValidLayer(layer)) {
+      throw new Error('An invalid layer is passed');
+    }
+  }
+
+  /**
+   * Checks if the given root control is an instance of Control or UIComponent.
+   *
+   * @param {Control | UIComponent} rootControl - The root control to be checked.
+   * @throws {Error} Throws an error if the root control is not an instance of Control or UIComponent.
+   */
+  function checkRootControl(rootControl) {
+    if (!(rootControl instanceof Control) && !(rootControl instanceof UIComponent)) {
+      throw new Error('An invalid root control was passed');
+    }
+  }
+
+  /**
+   * Checks if key user adaptation is enabled for the specified component.
+   * Fiori tools mode is considered a developer scenario where the `flexEnabled` flag should not be evaluated.
+   *
+   * @param {Control} component - The UI5 control component to check for flex (key user adaptation) enabled status.
+   * @throws {Error} Throws an error if key user adaptation is explicitly disabled in the component's manifest.
+   */
+  function checkFlexEnabled(component) {
+    // fiori tools is always a developer scenario where the flexEnabled flag should not be evaluated
+    const fioriToolsMode = new URLSearchParams(window.location.search).get('fiori-tools-rta-mode');
+    if (!fioriToolsMode || fioriToolsMode === 'false') {
+      const manifest = component.getManifest() || {};
+      const flexEnabled = manifest['sap.ui5']?.flexEnabled;
+      if (flexEnabled === false) {
+        throw new Error('This app is not enabled for key user adaptation');
+      }
+    }
+  }
+
+  /**
+   * Checks if the current user is a key user for the given layer.
+   * Specifically, it checks for key user rights if the layer is the CUSTOMER layer.
+   * If the user is not a key user and the layer is CUSTOMER, an error is thrown.
+   *
+   * Note: The function assumes the presence of 'layers.CUSTOMER'. In case of non-CUSTOMER layers,
+   * it simply resolves the promise without any additional checks.
+   *
+   * @param {string} layer - The layer for which to check key user rights.
+   * @returns {Promise<void>} A promise that resolves if the user is a key user or the layer is not CUSTOMER.
+   *                          Rejects with an error if the user is not a key user for the CUSTOMER layer.
+   * @throws {Error} Throws an error with the message 'No key user rights found' if the user lacks key user rights.
+   */
+  async function checkKeyUser(layer) {
+    if (layers.CUSTOMER === layer) {
+      const isKeyUser = await FeaturesAPI.isKeyUser();
+      if (!isKeyUser) {
+        throw new Error('No key user rights found');
+      }
+    }
+  }
+
+  /**
+   * Checks the validity of the specified layer and root control.
+   * It ensures that the layer is valid and the root control is an instance of Control or UIComponent.
+   * Additionally, it checks key user permissions for the specified layer.
+   *
+   * @param {Control} rootControl - The root control to be validated.
+   * @param {string} layer - The layer name to be validated.
+   * @returns {Promise<void>} A promise that resolves when all checks pass without errors.
+   * @throws {Error} Throws an error if any of the checks fail.
+   */
+  async function checkLayerAndControl(rootControl, layer) {
+    checkLayer(layer);
+    checkRootControl(rootControl);
+    await checkKeyUser(layer);
+  }
+
+  /**
+   * Retrieves the first HTML element with the specified title attribute.
+   *
+   * @param {string} title - The title attribute value to search for in the HTML elements.
+   * @param {Element | null} element - The target element that will be searched.
+   * @returns {Element | null} The first HTML element that matches the given title attribute value, or null if no such element is found.
+   */
+  function getElementByTitle(title, element) {
+    const selector = `[title="${title}"]`;
+    return element ? element.querySelector(selector) : document.querySelector(selector);
+  }
+
+  /**
+   * Hides a UI5 Button control with the specified ID.
+   *
+   * This function attempts to find a UI5 Button control by its ID and then sets its visibility to false.
+   *
+   * @param {string | undefined} buttonId - The ID of the Button control to hide. If undefined, no action is taken.
+   * @returns {void}
+   */
+  function hideButtonById(buttonId) {
+    const button = sap.ui.getCore().byId(buttonId);
+    button?.setVisible(false);
+  }
+
+  /**
+   * Hides specific buttons by ID from the RTA toolbar.
+   * This function specifically targets buttons 'Reset' and 'Publish'.
+   */
+  function removeExtraBtnsFromToolbar() {
+    const rtaToolbarEl = document.querySelector('.sapUiRtaToolbar');
+    const resetEl = getElementByTitle('Reset', rtaToolbarEl);
+    const publishEl = getElementByTitle('Publish', rtaToolbarEl);
+    hideButtonById(resetEl?.id);
+    hideButtonById(publishEl?.id);
+  }
+
+  /**
+   * Initializes custom RuntimeAuthoring for UI5 Versions < 1.72 and start UI Adaptation.
+   * Ensures that the passed options are valid.
+   *
+   * @param {RTAOptions} options - Options that are passed to RuntimeAuthoring upon initialization.
+   * @param {RTAPlugin} loadPlugins - Script that needs to be executed after rta is initialized.
+   * @returns {Promise<void>} A promise that resolves when all the checks have passed and RuntimeAuthoring is started.
+   */
+  var __exports = async function (options, loadPlugins) {
+    options = merge(defaultOptions, options);
+    const layer = options.flexSettings.layer;
+    const rootControl = options.rootControl;
+    await checkLayerAndControl(rootControl, layer);
+    options.rootControl = Utils.getAppComponentForControl(rootControl);
+    checkFlexEnabled(options.rootControl);
+    const rta = new RuntimeAuthoring(options);
+    rta.attachEvent('stop', () => rta.destroy());
+    if (loadPlugins) {
+      await loadPlugins(rta);
+    }
+    await rta.start();
+    removeExtraBtnsFromToolbar();
+  };
+  __exports.isValidLayer = isValidLayer;
+  __exports.checkLayer = checkLayer;
+  __exports.checkRootControl = checkRootControl;
+  __exports.checkFlexEnabled = checkFlexEnabled;
+  __exports.checkKeyUser = checkKeyUser;
+  return __exports;
 });
 //# sourceMappingURL=initRta.js.map