@sap/ux-ui5-tooling 1.20.4 → 1.22.0

package/dist/preview-middleware/dist/client/utils/fe-v4.js

@@ -0,0 +1,168 @@
+"use strict";
+
+sap.ui.define(["sap/ui/core/Component", "./core", "sap/ui/rta/command/CommandFactory", "../cpe/utils"], function (Component, ___core, CommandFactory, ___cpe_utils) {
+  "use strict";
+
+  const isA = ___core["isA"];
+  const getOverlay = ___cpe_utils["getOverlay"];
+  /**
+   * Gets app component of a v4 project.
+   *
+   * @param control - ManagedObject.
+   * @returns AppComponent.
+   */
+  function getV4AppComponent(control) {
+    const ownerComponent = Component.getOwnerComponentFor(control);
+    if (ownerComponent?.isA('sap.fe.core.TemplateComponent')) {
+      if (ownerComponent.getAppComponent) {
+        return ownerComponent.getAppComponent();
+      } else if (ownerComponent?.oAppComponent) {
+        return ownerComponent.oAppComponent;
+      }
+    }
+    return undefined;
+  }
+
+  /**
+   * Gets reference id of the app.
+   *
+   * @param control - ManagedObject.
+   * @returns string.
+   */
+  function getReference(control) {
+    const manifest = getV4AppComponent(control)?.getManifest();
+    return manifest?.['sap.app']?.id ?? '';
+  }
+
+  /**
+   * Determines the page type of v4 app.
+   *
+   * @param control - ManagedObject.
+   * @returns 'ObjectPage' | 'ListReport' | undefined.
+   */
+  function getV4PageType(control) {
+    const component = Component.getOwnerComponentFor(control);
+    if (!component?.isA('sap.fe.core.TemplateComponent')) {
+      return undefined;
+    }
+    const view = component.getRootControl();
+    const name = view.getViewName();
+    if (name === 'sap.fe.templates.ObjectPage.ObjectPage') {
+      return 'ObjectPage';
+    }
+    if (name === 'sap.fe.templates.ListReport.ListReport') {
+      return 'ListReport';
+    }
+    return undefined;
+  }
+
+  /**
+   * Get the containing page name of a control.
+   *
+   * @param control - UI5 control instance.
+   * @returns Page name to which the control belongs.
+   */
+  function getPageName(control) {
+    const component = Component.getOwnerComponentFor(control);
+    if (!isA('sap.fe.core.TemplateComponent', component)) {
+      return undefined;
+    }
+    const view = component.getRootControl();
+    return view.getId().split('::').pop();
+  }
+  function getConfigMapControlIdMap(page, propertyPathSegments) {
+    if (page && !propertyPathSegments.length) {
+      return page;
+    }
+    if (page) {
+      return `${page}-${propertyPathSegments.join('/')}`;
+    }
+    return propertyPathSegments.join('/');
+  }
+
+  /**
+   * Get the modified value for a control.
+   * @param modifiedControl - The modified control.
+   * @param flexSettings - Flex Settings of the control.
+   * @param propertyChanges - The change object
+   * @param propertyPathExtraSegments - optional path segments which are added to the default modified control manifest path
+   *
+   * @returns  A Promise resolving to an array of FlexCommand objects.
+   */
+  async function createManifestPropertyChange(modifiedControl, flexSettings, propertyChanges, propertyPathExtraSegments) {
+    const overlay = getOverlay(modifiedControl);
+    if (!overlay) {
+      return undefined;
+    }
+    const overlayData = overlay.getDesignTimeMetadata().getData();
+    const settings = overlayData.manifestSettings(modifiedControl);
+    let manifestPropertyPath = overlayData.manifestPropertyPath(modifiedControl);
+    if (propertyPathExtraSegments) {
+      manifestPropertyPath += '/' + propertyPathExtraSegments.join('/');
+    }
+    const adjustedChanges = {};
+    for (const [key, value] of Object.entries(propertyChanges)) {
+      const setting = settings.find(s => s.id === key);
+      if (setting) {
+        adjustedChanges[setting.path ?? setting.id] = value;
+      } else {
+        adjustedChanges[key] = value;
+      }
+    }
+    const [manifestPropertyChange] = overlayData.manifestPropertyChange(adjustedChanges, manifestPropertyPath, modifiedControl);
+    const modifiedValue = {
+      reference: getReference(modifiedControl),
+      appComponent: manifestPropertyChange.appComponent,
+      changeType: manifestPropertyChange.changeSpecificData.appDescriptorChangeType,
+      parameters: manifestPropertyChange.changeSpecificData.content.parameters,
+      selector: manifestPropertyChange.selector
+    };
+    const command = await CommandFactory.getCommandFor(modifiedControl, 'appDescriptor', modifiedValue, null, flexSettings);
+    return command;
+  }
+
+  /**
+   * Returns application object page definitions found in manifest
+   *
+   * @param manifest - manifest object
+   * @returns array with page descriptors
+   */
+  function getV4ApplicationPages(manifest) {
+    const result = [];
+    const targets = manifest['sap.ui5'].routing?.targets ?? {};
+    for (const target of Object.values(targets)) {
+      if (target.name === 'sap.fe.templates.ObjectPage') {
+        result.push({
+          id: target.id,
+          entitySet: target.options?.settings?.entitySet,
+          contextPath: target.options?.settings?.contextPath
+        });
+      }
+    }
+    return result;
+  }
+  /** * Checks if the given control is inside a table and returns the table instance.
+   * For UI5 version greater than 1.144 the table is 'sap.fe.macros.Table' and for lower versions it is 'sap.fe.macros.table.TableAPI'
+   * @param control - UI5 control instance.
+   * @returns Table instance if the control is inside a table, otherwise undefined.
+   */
+  function isMacroTable(table) {
+    if (table && (isA('sap.fe.macros.Table', table) || isA('sap.fe.macros.table.TableAPI', table))) {
+      return true;
+    }
+    return false;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getV4AppComponent = getV4AppComponent;
+  __exports.getReference = getReference;
+  __exports.getV4PageType = getV4PageType;
+  __exports.getPageName = getPageName;
+  __exports.getConfigMapControlIdMap = getConfigMapControlIdMap;
+  __exports.createManifestPropertyChange = createManifestPropertyChange;
+  __exports.getV4ApplicationPages = getV4ApplicationPages;
+  __exports.isMacroTable = isMacroTable;
+  return __exports;
+});
+//# sourceMappingURL=fe-v4.js.map

package/dist/preview-middleware/dist/client/utils/fe-v4.ts

@@ -0,0 +1,186 @@
+import ManagedObject from 'sap/ui/base/ManagedObject';
+import TemplateComponent from 'sap/fe/core/TemplateComponent';
+import Component from 'sap/ui/core/Component';
+import AppComponent from 'sap/fe/core/AppComponent';
+import XMLView from 'sap/ui/core/mvc/XMLView';
+import type { FlexSettings, Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+
+import { isA } from './core';
+import CommandFactory from 'sap/ui/rta/command/CommandFactory';
+import { getOverlay } from '../cpe/utils';
+import UI5Element from 'sap/ui/core/Element';
+import FlexCommand from 'sap/ui/rta/command/FlexCommand';
+import TableAPI from 'sap/fe/macros/table/TableAPI';
+
+export type MacroTable = TableAPI & {
+    metaPath: string;
+    contextPath: string;
+};
+
+/**
+ * Gets app component of a v4 project.
+ *
+ * @param control - ManagedObject.
+ * @returns AppComponent.
+ */
+export function getV4AppComponent(control: ManagedObject): AppComponent | undefined {
+    const ownerComponent = Component.getOwnerComponentFor(control);
+    if (ownerComponent?.isA<TemplateComponent>('sap.fe.core.TemplateComponent')) {
+        if (ownerComponent.getAppComponent) {
+            return ownerComponent.getAppComponent();
+        } else if ((ownerComponent as unknown as { oAppComponent: AppComponent })?.oAppComponent) {
+            return (ownerComponent as unknown as { oAppComponent: AppComponent }).oAppComponent;
+        }
+    }
+    return undefined;
+}
+
+/**
+ * Gets reference id of the app.
+ *
+ * @param control - ManagedObject.
+ * @returns string.
+ */
+export function getReference(control: ManagedObject): string {
+    const manifest = getV4AppComponent(control)?.getManifest() as Manifest;
+    return manifest?.['sap.app']?.id ?? '';
+}
+
+/**
+ * Determines the page type of v4 app.
+ *
+ * @param control - ManagedObject.
+ * @returns 'ObjectPage' | 'ListReport' | undefined.
+ */
+export function getV4PageType(control: ManagedObject): 'ObjectPage' | 'ListReport' | undefined {
+    const component = Component.getOwnerComponentFor(control);
+    if (!component?.isA<TemplateComponent>('sap.fe.core.TemplateComponent')) {
+        return undefined;
+    }
+    const view = component.getRootControl();
+    const name = (view as XMLView).getViewName();
+    if (name === 'sap.fe.templates.ObjectPage.ObjectPage') {
+        return 'ObjectPage';
+    }
+    if (name === 'sap.fe.templates.ListReport.ListReport') {
+        return 'ListReport';
+    }
+    return undefined;
+}
+
+/**
+ * Get the containing page name of a control.
+ *
+ * @param control - UI5 control instance.
+ * @returns Page name to which the control belongs.
+ */
+export function getPageName(control: ManagedObject): string | undefined {
+    const component = Component.getOwnerComponentFor(control);
+    if (!isA<TemplateComponent>('sap.fe.core.TemplateComponent', component)) {
+        return undefined;
+    }
+    const view = component.getRootControl();
+    return view.getId().split('::').pop();
+}
+
+export function getConfigMapControlIdMap(page: string | undefined, propertyPathSegments: string[]): string {
+    if (page && !propertyPathSegments.length) {
+        return page;
+    }
+
+    if (page) {
+        return `${page}-${propertyPathSegments.join('/')}`;
+    }
+    return propertyPathSegments.join('/');
+}
+
+/**
+ * Get the modified value for a control.
+ * @param modifiedControl - The modified control.
+ * @param flexSettings - Flex Settings of the control.
+ * @param propertyChanges - The change object
+ * @param propertyPathExtraSegments - optional path segments which are added to the default modified control manifest path
+ *
+ * @returns  A Promise resolving to an array of FlexCommand objects.
+ */
+export async function createManifestPropertyChange(
+    modifiedControl: UI5Element,
+    flexSettings: FlexSettings,
+    propertyChanges: Record<string, string | string[] | boolean | number | object | undefined>,
+    propertyPathExtraSegments?: string[]
+): Promise<FlexCommand | undefined> {
+    const overlay = getOverlay(modifiedControl);
+    if (!overlay) {
+        return undefined;
+    }
+    const overlayData = overlay.getDesignTimeMetadata().getData();
+    const settings = overlayData.manifestSettings(modifiedControl);
+    let manifestPropertyPath = overlayData.manifestPropertyPath(modifiedControl);
+    if (propertyPathExtraSegments) {
+        manifestPropertyPath += '/' + propertyPathExtraSegments.join('/');
+    }
+    const adjustedChanges: Record<string, string | string[] | boolean | number | object | undefined> = {};
+    for (const [key, value] of Object.entries(propertyChanges)) {
+        const setting = settings.find((s) => s.id === key);
+        if (setting) {
+            adjustedChanges[setting.path ?? setting.id] = value;
+        } else {
+            adjustedChanges[key] = value;
+        }
+    }
+    const [manifestPropertyChange] = overlayData.manifestPropertyChange(
+        adjustedChanges,
+        manifestPropertyPath,
+        modifiedControl
+    );
+
+    const modifiedValue = {
+        reference: getReference(modifiedControl),
+        appComponent: manifestPropertyChange.appComponent,
+        changeType: manifestPropertyChange.changeSpecificData.appDescriptorChangeType,
+        parameters: manifestPropertyChange.changeSpecificData.content.parameters,
+        selector: manifestPropertyChange.selector
+    };
+
+    const command = await CommandFactory.getCommandFor(
+        modifiedControl,
+        'appDescriptor',
+        modifiedValue,
+        null,
+        flexSettings
+    );
+
+    return command;
+}
+
+/**
+ * Returns application object page definitions found in manifest
+ *
+ * @param manifest - manifest object
+ * @returns array with page descriptors
+ */
+export function getV4ApplicationPages(manifest: Manifest): { id: string; entitySet?: string; contextPath?: string }[] {
+    const result: { id: string; entitySet?: string; contextPath?: string }[] = [];
+    const targets = manifest['sap.ui5'].routing?.targets ?? {};
+    for (const target of Object.values(targets)) {
+        if (target.name === 'sap.fe.templates.ObjectPage') {
+            result.push({
+                id: target.id,
+                entitySet: target.options?.settings?.entitySet,
+                contextPath: target.options?.settings?.contextPath
+            });
+        }
+    }
+    return result;
+}
+/** * Checks if the given control is inside a table and returns the table instance.
+ * For UI5 version greater than 1.144 the table is 'sap.fe.macros.Table' and for lower versions it is 'sap.fe.macros.table.TableAPI'
+ * @param control - UI5 control instance.
+ * @returns Table instance if the control is inside a table, otherwise undefined.
+ */
+export function isMacroTable(table: ManagedObject | null): table is MacroTable {
+    if (table && (isA<MacroTable>('sap.fe.macros.Table', table) || isA<MacroTable>('sap.fe.macros.table.TableAPI', table))) {
+        return true;
+    }
+    return false;
+}

package/dist/preview-middleware/dist/client/utils/info-center-message.js

@@ -0,0 +1,60 @@
+"use strict";
+
+sap.ui.define(["open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common", "../cpe/communication-service", "../i18n"], function (___sap_ux_private_control_property_editor_common, ___cpe_communication_service, ___i18n) {
+  "use strict";
+
+  const showInfoCenterMessage = ___sap_ux_private_control_property_editor_common["showInfoCenterMessage"];
+  const CommunicationService = ___cpe_communication_service["CommunicationService"];
+  const getTextBundle = ___i18n["getTextBundle"];
+  /**
+   * Localization key interface for defining message keys and optional parameters.
+   */
+  /**
+   * InfoCenterMessage interface for defining the structure of an Info center message.
+   * It includes title, description, optional details, and type.
+   */
+  /**
+   * Shows a localized/plain string message in the Info center.
+   *
+   * @param {InfoCenterMessage} message - The message object containing title, description,
+   * details and type for the message. Each text in the message can be localized or
+   * left as a plain string.
+   */
+  async function sendInfoCenterMessage({
+    title,
+    description,
+    details,
+    type
+  }) {
+    CommunicationService.sendAction(showInfoCenterMessage({
+      title: await getTranslation(title),
+      description: await getTranslation(description),
+      details: await getTranslation(details),
+      type
+    }));
+  }
+
+  /**
+   * Util function which returns translation for a localization key or a plain string.
+   * If the value is undefined, it returns undefined.
+   *
+   * @param {LocalizationKey | string | undefined} value - The localization key, plain string or undefined.
+   * @returns {Promise<string>} A promise that resolves to the translated string.
+   */
+  async function getTranslation(value) {
+    if (value === undefined) {
+      return undefined;
+    }
+    if (typeof value === 'string') {
+      return value;
+    }
+    const bundle = await getTextBundle();
+    return bundle.getText(value.key, value.params);
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.sendInfoCenterMessage = sendInfoCenterMessage;
+  return __exports;
+});
+//# sourceMappingURL=info-center-message.js.map

package/dist/preview-middleware/dist/client/utils/info-center-message.ts

@@ -0,0 +1,60 @@
+import { MessageBarType, showInfoCenterMessage } from '@sap-ux-private/control-property-editor-common';
+import { CommunicationService } from '../cpe/communication-service';
+import { getTextBundle } from '../i18n';
+
+/**
+ * Localization key interface for defining message keys and optional parameters.
+ */
+interface LocalizationKey {
+    key: string;
+    params?: string[];
+}
+
+/**
+ * InfoCenterMessage interface for defining the structure of an Info center message.
+ * It includes title, description, optional details, and type.
+ */
+interface InfoCenterMessage {
+    title: LocalizationKey | string;
+    description: LocalizationKey | string;
+    details?: LocalizationKey | string;
+    type: MessageBarType;
+}
+
+/**
+ * Shows a localized/plain string message in the Info center.
+ *
+ * @param {InfoCenterMessage} message - The message object containing title, description,
+ * details and type for the message. Each text in the message can be localized or
+ * left as a plain string.
+ */
+export async function sendInfoCenterMessage({ title, description, details, type }: InfoCenterMessage): Promise<void> {
+    CommunicationService.sendAction(
+        showInfoCenterMessage({
+            title: (await getTranslation(title))!,
+            description: (await getTranslation(description))!,
+            details: await getTranslation(details),
+            type
+        })
+    );
+}
+
+/**
+ * Util function which returns translation for a localization key or a plain string.
+ * If the value is undefined, it returns undefined.
+ *
+ * @param {LocalizationKey | string | undefined} value - The localization key, plain string or undefined.
+ * @returns {Promise<string>} A promise that resolves to the translated string.
+ */
+async function getTranslation(value: LocalizationKey | string | undefined): Promise<string | undefined> {
+    if (value === undefined) {
+        return undefined;
+    }
+
+    if (typeof value === 'string') {
+        return value;
+    }
+
+    const bundle = await getTextBundle();
+    return bundle.getText(value.key, value.params);
+}

package/dist/preview-middleware/dist/client/utils/version.js

@@ -0,0 +1,126 @@
+"use strict";
+
+sap.ui.define(["sap/ui/VersionInfo", "sap/base/Log", "./info-center-message", "open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common"], function (VersionInfo, Log, ___info_center_message, ___sap_ux_private_control_property_editor_common) {
+  "use strict";
+
+  const sendInfoCenterMessage = ___info_center_message["sendInfoCenterMessage"];
+  const MessageBarType = ___sap_ux_private_control_property_editor_common["MessageBarType"];
+  /**
+   * Default minimal supported UI5 version
+   */
+  const minVersionInfo = {
+    major: 1,
+    minor: 71
+  };
+
+  /**
+   * Check if the given version info is valid.
+   *
+   * @param versionInfo to check
+   * @throws Error if the version info is invalid
+   */
+  function checkVersionInfo(versionInfo) {
+    if (Number.isNaN(versionInfo.major) || Number.isNaN(versionInfo.minor) || Number.isNaN(versionInfo.patch ?? 0)) {
+      void sendInfoCenterMessage({
+        title: {
+          key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_TITLE'
+        },
+        description: {
+          key: 'FLP_UI_INVALID_UI5_VERSION_DESCRIPTION'
+        },
+        type: MessageBarType.error
+      });
+      throw new Error('Invalid version info');
+    }
+  }
+
+  /**
+   * Retrieve the UI5 version.
+   * If no library is given, the version from 'sap.ui.core' will be retrieved.
+   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+   *
+   * @param library - (optional) specific library name to get the version from, e.g. 'sap.m'
+   * @returns Ui5VersionInfo
+   */
+  async function getUi5Version(library = 'sap.ui.core') {
+    const versionInfo = await VersionInfo.load();
+    let version = versionInfo?.libraries?.find(lib => lib.name === library)?.version;
+    const isCdn = versionInfo?.name === 'SAPUI5 Distribution';
+    if (!version) {
+      Log.error('Could not get UI5 version of application. Using version: 1.130.9 as fallback.');
+      version = '1.130.9';
+      await sendInfoCenterMessage({
+        title: {
+          key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_TITLE'
+        },
+        description: {
+          key: 'FLP_UI_VERSION_RETRIEVAL_FAILURE_DESCRIPTION',
+          params: [version]
+        },
+        type: MessageBarType.error
+      });
+    }
+    const [major, minor, patch] = version.split('.').map(versionPart => Number.parseInt(versionPart, 10));
+    const label = version.split(/-(.*)/s)?.[1];
+    return {
+      major,
+      minor,
+      patch,
+      label,
+      isCdn
+    };
+  }
+
+  /**
+   * Checks if the given version is lower than the required minimal version.
+   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+   *
+   * @param ui5VersionInfo to check
+   * @param minUi5VersionInfo to check against (default is 1.71)
+   * @throws Error if the version info is invalid
+   * @returns boolean
+   */
+  function isLowerThanMinimalUi5Version(ui5VersionInfo, minUi5VersionInfo = minVersionInfo) {
+    checkVersionInfo(ui5VersionInfo);
+    checkVersionInfo(minUi5VersionInfo);
+    return ui5VersionInfo.major < minUi5VersionInfo.major || ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor < minUi5VersionInfo.minor || ui5VersionInfo.major === minUi5VersionInfo.major && ui5VersionInfo.minor === minUi5VersionInfo.minor && (ui5VersionInfo?.patch ?? 0) < (minUi5VersionInfo?.patch ?? 0);
+  }
+
+  /**
+   * Checks if the given version is equal to the specified version.
+   * Note that the patch version of actual SAPUI5 version might differ from the lib that has been used for the version request (e.g. SAPUI5 1.96.38 contains sap.ui.core 1.96.36).
+   * For details see the patch info of the respective SAPUI5 version (e.g. https://ui5.sap.com/1.96.38/patchinfo.html).
+   *
+   * @param ui5VersionInfo to check
+   * @param targetUi5VersionInfo to check against (default is 1.71)
+   * @throws Error if the version info is invalid
+   * @returns boolean
+   */
+  function isVersionEqualOrHasNewerPatch(ui5VersionInfo, targetUi5VersionInfo = minVersionInfo) {
+    checkVersionInfo(ui5VersionInfo);
+    checkVersionInfo(targetUi5VersionInfo);
+    return ui5VersionInfo.major === targetUi5VersionInfo.major && ui5VersionInfo.minor === targetUi5VersionInfo.minor && (ui5VersionInfo?.patch ?? 0) >= (targetUi5VersionInfo?.patch ?? 0);
+  }
+
+  /**
+   * Returns the fully qualified UI5 version string - major and minor version concatenated.
+   *
+   * @param {Ui5VersionInfo} ui5VersionInfo - The ui5 version info object containing major and minor version.
+   * @returns {string} The fully qualified UI5 version string.
+   */
+  function getFullyQualifiedUi5Version(ui5VersionInfo) {
+    return `${ui5VersionInfo.major}.${ui5VersionInfo.minor}`;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.minVersionInfo = minVersionInfo;
+  __exports.getUi5Version = getUi5Version;
+  __exports.isLowerThanMinimalUi5Version = isLowerThanMinimalUi5Version;
+  __exports.isVersionEqualOrHasNewerPatch = isVersionEqualOrHasNewerPatch;
+  __exports.getFullyQualifiedUi5Version = getFullyQualifiedUi5Version;
+  return __exports;
+});
+//# sourceMappingURL=version.js.map