@sap/ux-ui5-tooling 1.20.4 → 1.21.0

package/dist/preview-middleware/dist/client/flp/initConnectors.js

@@ -0,0 +1,31 @@
+"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.84, this function dynamically requires and executes a FakeLrepConnector.
+   * For UI5 versions 1.84 and above, a local connector that reuses the WorkspaceConnector is being defined in preview-middleware/src/base/config.ts.
+   * 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() {
+    const ui5Version = await getUi5Version();
+    if (isLowerThanMinimalUi5Version(ui5Version, {
+      major: 1,
+      minor: 84
+    }) && ui5Version.isCdn) {
+      sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector) {
+        enableFakeConnector();
+      });
+    }
+  }
+  return initConnectors;
+});
+//# sourceMappingURL=initConnectors.js.map

package/dist/preview-middleware/dist/client/flp/initConnectors.ts

@@ -0,0 +1,20 @@
+import { getUi5Version, isLowerThanMinimalUi5Version } from '../utils/version';
+
+/**
+ * Initializes UI5 connectors based on the current UI5 version.
+ *
+ * For UI5 versions below 1.84, this function dynamically requires and executes a FakeLrepConnector.
+ * For UI5 versions 1.84 and above, a local connector that reuses the WorkspaceConnector is being defined in preview-middleware/src/base/config.ts.
+ * This setup allows for flexibility in using different connectors based on the UI5 version.
+ *
+ * @example
+ * intiConnectors(); // Simply call the function without any arguments.
+ */
+export default async function initConnectors(): Promise<void> {
+    const ui5Version = await getUi5Version();
+    if (isLowerThanMinimalUi5Version(ui5Version, { major: 1, minor: 84 }) && ui5Version.isCdn) {
+        sap.ui.require(['open/ux/preview/client/flp/enableFakeConnector'], function (enableFakeConnector: () => void) {
+            enableFakeConnector();
+        });
+    }
+}

package/dist/preview-middleware/dist/client/flp/initRta.js

@@ -0,0 +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 {Component} 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 {Component} 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

package/dist/preview-middleware/dist/client/flp/initRta.ts

@@ -0,0 +1,194 @@
+import type Button from 'sap/m/Button';
+
+import merge from 'sap/base/util/merge';
+
+import Control from 'sap/ui/core/Control';
+import Component from 'sap/ui/core/Component';
+import UIComponent from 'sap/ui/core/UIComponent';
+
+import Utils from 'sap/ui/fl/Utils';
+import FeaturesAPI from 'sap/ui/fl/write/api/FeaturesAPI';
+
+import type { RTAPlugin } from 'sap/ui/rta/api/startAdaptation';
+import RuntimeAuthoring,  { type Manifest, type RTAOptions } from 'sap/ui/rta/RuntimeAuthoring';
+
+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.
+ */
+export function isValidLayer(layer: string): boolean {
+    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.
+ */
+export function checkLayer(layer: string): void {
+    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 {Component} rootControl - The root control to be checked.
+ * @throws {Error} Throws an error if the root control is not an instance of Control or UIComponent.
+ */
+export function checkRootControl(rootControl: Component): void {
+    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 {Component} 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.
+ */
+export function checkFlexEnabled(component: Component): void {
+    // 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 as Component& { getManifest: () => Manifest }).getManifest() || {}) as Manifest;
+        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.
+ */
+export async function checkKeyUser(layer: string): Promise<void> {
+    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: Component, layer: string): Promise<void> {
+    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: string, element?: Element | null): Element | null {
+    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: string | undefined): void {
+    const button = sap.ui.getCore().byId(buttonId) as Button;
+    button?.setVisible(false);
+}
+
+/**
+ * Hides specific buttons by ID from the RTA toolbar.
+ * This function specifically targets buttons 'Reset' and 'Publish'.
+ */
+function removeExtraBtnsFromToolbar(): void {
+    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.
+ */
+export default async function (options: RTAOptions, loadPlugins: RTAPlugin): Promise<void> {
+    options = merge(defaultOptions, options) as RTAOptions;
+
+    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();
+}

package/dist/preview-middleware/dist/client/i18n.js

@@ -0,0 +1,56 @@
+"use strict";
+
+sap.ui.define(["sap/base/i18n/ResourceBundle", "sap/ui/model/resource/ResourceModel"], function (ResourceBundle, ResourceModel) {
+  "use strict";
+
+  const BUNDLE_CACHE = {};
+  const MODEL_CACHE = {};
+  async function getResourceBundle(key) {
+    const cachedBundle = BUNDLE_CACHE[key];
+    if (cachedBundle) {
+      return cachedBundle;
+    }
+    const bundle = await ResourceBundle.create({
+      bundleUrl: '/preview/client/messagebundle.properties',
+      url: '/preview/client/messagebundle.properties',
+      supportedLocales: [''],
+      locale: '',
+      async: true
+    });
+    BUNDLE_CACHE[key] = bundle;
+    return bundle;
+  }
+  async function getResourceModel(key = 'open.ux.preview.client') {
+    const cachedModel = MODEL_CACHE[key];
+    if (cachedModel) {
+      return cachedModel;
+    }
+    const bundle = await getResourceBundle(key);
+    const model = new ResourceModel({
+      bundle
+    });
+    MODEL_CACHE[key] = model;
+    return model;
+  }
+  class TextBundle {
+    constructor(bundle) {
+      this.bundle = bundle;
+    }
+    getText(key, args) {
+      return this.bundle.getText(key, args) ?? key;
+    }
+  }
+  async function getTextBundle(key = 'open.ux.preview.client') {
+    const bundle = await getResourceBundle(key);
+    return new TextBundle(bundle);
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getResourceBundle = getResourceBundle;
+  __exports.getResourceModel = getResourceModel;
+  __exports.TextBundle = TextBundle;
+  __exports.getTextBundle = getTextBundle;
+  return __exports;
+});
+//# sourceMappingURL=i18n.js.map

package/dist/preview-middleware/dist/client/i18n.ts

@@ -0,0 +1,49 @@
+import ResourceBundle from 'sap/base/i18n/ResourceBundle';
+import ResourceModel from 'sap/ui/model/resource/ResourceModel';
+
+const BUNDLE_CACHE: Record<string, ResourceBundle> = {};
+const MODEL_CACHE: Record<string, ResourceModel> = {};
+
+export async function getResourceBundle(key: string): Promise<ResourceBundle> {
+    const cachedBundle = BUNDLE_CACHE[key];
+
+    if (cachedBundle) {
+        return cachedBundle;
+    }
+
+    const bundle = await ResourceBundle.create({
+        bundleUrl: '/preview/client/messagebundle.properties',
+        url: '/preview/client/messagebundle.properties',
+        supportedLocales: [''],
+        locale: '',
+        async: true
+    });
+    BUNDLE_CACHE[key] = bundle;
+    return bundle;
+}
+
+export async function getResourceModel(key = 'open.ux.preview.client'): Promise<ResourceModel> {
+    const cachedModel = MODEL_CACHE[key];
+
+    if (cachedModel) {
+        return cachedModel;
+    }
+
+    const bundle = await getResourceBundle(key);
+    const model = new ResourceModel({ bundle });
+    MODEL_CACHE[key] = model;
+    return model;
+}
+
+export class TextBundle {
+    constructor(private readonly bundle: ResourceBundle) {}
+
+    getText(key: string, args?: string[]): string {
+        return this.bundle.getText(key, args) ?? key;
+    }
+}
+
+export async function getTextBundle(key = 'open.ux.preview.client'): Promise<TextBundle> {
+    const bundle = await getResourceBundle(key);
+    return new TextBundle(bundle);
+}

package/dist/preview-middleware/dist/client/manifest.json

@@ -0,0 +1,8 @@
+{
+	"sap.app": {
+		"id": "open.ux.preview.client"
+	},
+	"sap.ui5": {
+		"flexBundle": false
+	}
+}