@sap/ux-ui5-tooling 1.20.4 → 1.22.0

package/dist/preview-middleware/dist/client/utils/additional-change-info.js

@@ -0,0 +1,69 @@
+"use strict";
+
+sap.ui.define(["../cpe/additional-change-info/add-xml-additional-info"], function (___cpe_additional_change_info_add_xml_additional_info) {
+  "use strict";
+
+  const getAddXMLAdditionalInfo = ___cpe_additional_change_info_add_xml_additional_info["getAddXMLAdditionalInfo"];
+  const additionalChangeInfoMap = new Map();
+
+  /**
+   * This function is used to set additional change information for a given change.
+   *
+   * @param change - The change object for which additional information is to be set.
+   * @param appComponent - The app component (optional), used to resolve controls in projects with local IDs.
+   */
+  function setAdditionalChangeInfo(change, appComponent) {
+    if (!change) {
+      return;
+    }
+    let additionalChangeInfo;
+    const key = change.getDefinition().fileName;
+    if (change?.getChangeType?.() === 'addXML') {
+      additionalChangeInfo = getAddXMLAdditionalInfo(change, appComponent);
+    }
+    if (additionalChangeInfo) {
+      const existingInfo = additionalChangeInfoMap.get(key);
+      if (existingInfo) {
+        // Merge new info with existing info, keeping existing values and only adding new ones
+        const mergedInfo = {
+          ...additionalChangeInfo,
+          ...existingInfo
+        };
+        additionalChangeInfoMap.set(key, mergedInfo);
+      } else {
+        // No existing info, set the new info
+        additionalChangeInfoMap.set(key, additionalChangeInfo);
+      }
+    }
+  }
+  function setAdditionalChangeInfoForChangeFile(fileName, additionalChangeInfo) {
+    additionalChangeInfoMap.set(fileName, additionalChangeInfo);
+  }
+
+  /**
+   * Retrieves additional change information for a given change.
+   *
+   * @param change - The change object containing details about a file modification.
+   * @returns The additional change information associated with the file name of the change,
+   *          or `undefined` if no additional information is available.
+   */
+  function getAdditionalChangeInfo(change) {
+    return additionalChangeInfoMap.get(change.fileName);
+  }
+
+  /**
+   * Should only be used in tests.
+   */
+  function clearAdditionalChangeInfo() {
+    additionalChangeInfoMap.clear();
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.setAdditionalChangeInfo = setAdditionalChangeInfo;
+  __exports.setAdditionalChangeInfoForChangeFile = setAdditionalChangeInfoForChangeFile;
+  __exports.getAdditionalChangeInfo = getAdditionalChangeInfo;
+  __exports.clearAdditionalChangeInfo = clearAdditionalChangeInfo;
+  return __exports;
+});
+//# sourceMappingURL=additional-change-info.js.map

package/dist/preview-middleware/dist/client/utils/additional-change-info.ts

@@ -0,0 +1,73 @@
+import FlexChange from 'sap/ui/fl/Change';
+import {
+    getAddXMLAdditionalInfo,
+    type AddXMLAdditionalInfo,
+    type AddXMLChangeContent
+} from '../cpe/additional-change-info/add-xml-additional-info';
+import { FlexChange as Change } from '../flp/common';
+import type Component from 'sap/ui/core/Component';
+
+export type AdditionalChangeInfo = AddXMLAdditionalInfo | undefined;
+
+const additionalChangeInfoMap = new Map<string, AdditionalChangeInfo>();
+
+/**
+ * This function is used to set additional change information for a given change.
+ *
+ * @param change - The change object for which additional information is to be set.
+ * @param appComponent - The app component (optional), used to resolve controls in projects with local IDs.
+ */
+export function setAdditionalChangeInfo(
+    change: FlexChange<AddXMLChangeContent> | undefined,
+    appComponent?: Component
+): void {
+    if (!change) {
+        return;
+    }
+
+    let additionalChangeInfo;
+    const key = change.getDefinition().fileName;
+    if (change?.getChangeType?.() === 'addXML') {
+        additionalChangeInfo = getAddXMLAdditionalInfo(change, appComponent);
+    }
+
+    if (additionalChangeInfo) {
+        const existingInfo = additionalChangeInfoMap.get(key);
+        if (existingInfo) {
+            // Merge new info with existing info, keeping existing values and only adding new ones
+            const mergedInfo = {
+                ...additionalChangeInfo,
+                ...existingInfo
+            };
+            additionalChangeInfoMap.set(key, mergedInfo);
+        } else {
+            // No existing info, set the new info
+            additionalChangeInfoMap.set(key, additionalChangeInfo);
+        }
+    }
+}
+
+export function setAdditionalChangeInfoForChangeFile(
+    fileName: string,
+    additionalChangeInfo: AdditionalChangeInfo
+): void {
+    additionalChangeInfoMap.set(fileName, additionalChangeInfo);
+}
+
+/**
+ * Retrieves additional change information for a given change.
+ *
+ * @param change - The change object containing details about a file modification.
+ * @returns The additional change information associated with the file name of the change,
+ *          or `undefined` if no additional information is available.
+ */
+export function getAdditionalChangeInfo(change: Change): AdditionalChangeInfo {
+    return additionalChangeInfoMap.get(change.fileName);
+}
+
+/**
+ * Should only be used in tests.
+ */
+export function clearAdditionalChangeInfo(): void {
+    additionalChangeInfoMap.clear();
+}

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

@@ -0,0 +1,34 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Determines application type based on the manifest.json.
+   *
+   * @param manifest - Application Manifest.
+   * @returns Application type.
+   */
+  function getApplicationType(manifest) {
+    if (manifest['sap.ui.generic.app'] || manifest['sap.ovp']) {
+      return 'fe-v2';
+    } else if (manifest['sap.ui5']?.routing?.targets) {
+      let hasV4pPages = false;
+      Object.keys(manifest?.['sap.ui5']?.routing?.targets ?? []).forEach(target => {
+        if (manifest?.['sap.ui5']?.routing?.targets?.[target]?.name?.startsWith('sap.fe.templates.')) {
+          hasV4pPages = true;
+        }
+      });
+      if (hasV4pPages) {
+        return 'fe-v4';
+      }
+    }
+    return 'freestyle';
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getApplicationType = getApplicationType;
+  return __exports;
+});
+//# sourceMappingURL=application.js.map

package/dist/preview-middleware/dist/client/utils/application.ts

@@ -0,0 +1,27 @@
+import type { Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+
+export type ApplicationType = 'fe-v2' | 'fe-v4' | 'freestyle';
+
+/**
+ * Determines application type based on the manifest.json.
+ *
+ * @param manifest - Application Manifest.
+ * @returns Application type.
+ */
+export function getApplicationType(manifest: Manifest): ApplicationType {
+    if (manifest['sap.ui.generic.app'] || manifest['sap.ovp']) {
+        return 'fe-v2';
+    } else if (manifest['sap.ui5']?.routing?.targets) {
+        let hasV4pPages = false;
+        Object.keys(manifest?.['sap.ui5']?.routing?.targets ?? []).forEach((target) => {
+            if (manifest?.['sap.ui5']?.routing?.targets?.[target]?.name?.startsWith('sap.fe.templates.')) {
+                hasV4pPages = true;
+            }
+        });
+        if (hasV4pPages) {
+            return 'fe-v4';
+        }
+    }
+
+    return 'freestyle';
+}

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

@@ -0,0 +1,144 @@
+"use strict";
+
+sap.ui.define(["sap/ui/core/Component", "sap/ui/core/Element", "sap/ui/core/util/reflection/JsControlTreeModifier", "sap/base/Log", "./error"], function (Component, Element, JsControlTreeModifier, Log, ___error) {
+  "use strict";
+
+  const getError = ___error["getError"];
+  /**
+   * Gets Component by id.
+   *
+   * @param id - unique identifier for control
+   * @returns Component | undefined
+   */
+  function getComponent(id) {
+    if (Component?.getComponentById) {
+      return Component.getComponentById(id);
+    } else if (Component?.get) {
+      // Older version must be still supported until maintenance period.
+      return Component.get(id); // NOSONAR
+    } else {
+      // Older version must be still supported until maintenance period.
+      return sap.ui.getCore().getComponent(id); // NOSONAR
+    }
+  }
+
+  /**
+   * Returns control by its global ID.
+   *
+   * @param id Id of the control.
+   * @returns Control instance if it exists.
+   */
+  function getControlById(id) {
+    if (typeof Element.getElementById === 'function') {
+      return Element.getElementById(id);
+    } else {
+      return sap.ui.getCore().byId(id);
+    }
+  }
+
+  /**
+   * Gets target control by trying getControlById first, then falling back to JsControlTreeModifier.bySelector
+   * for projects where the control may not be found by global ID.
+   *
+   * @param selector - The selector object from the change.
+   * @param appComponent - The app component (optional).
+   * @returns The target control element or undefined.
+   */
+  function getControlBySelector(selector, appComponent) {
+    if (!selector?.id) {
+      return undefined;
+    }
+    let control = getControlById(selector.id);
+    if (!control && appComponent && selector) {
+      try {
+        control = JsControlTreeModifier.bySelector(selector, appComponent);
+      } catch (error) {
+        Log.warning('Failed to get control by selector:', getError(error));
+      }
+    }
+    return control;
+  }
+
+  /**
+   * Checks wether this object is an instance of a ManagedObject.
+   *
+   * @param element An object.
+   * @returns True if element is an instance of a ManagedObject.
+   */
+  function isManagedObject(element) {
+    if (typeof element?.isA === 'function') {
+      return element.isA('sap.ui.base.ManagedObject');
+    }
+    return false;
+  }
+
+  /**
+   * Checks whether this object is an instance of the named type.
+   *
+   * @param type - Type to check for.
+   * @param element - Object to check
+   * @returns Whether this object is an instance of the given type.
+   */
+  function isA(type, element) {
+    return !!element?.isA(type);
+  }
+  function hasParent(component, parentIdToFind) {
+    const parent = component.getParent();
+    if (!parent) {
+      return false;
+    }
+    if (parent.getId() === parentIdToFind) {
+      return true;
+    }
+    return hasParent(parent, parentIdToFind);
+  }
+
+  /**
+   * Utility function to safely call getParent on UI5 elements
+   * @param element UI5 element
+   * @returns parent element or null
+   */
+  function getElementParent(element) {
+    if (typeof element.getParent === 'function') {
+      return element.getParent();
+    }
+    return null;
+  }
+
+  /**
+   * Finds the view that contains the given control.
+   *
+   * @param control - Control instance  
+   * @returns View instance if found, undefined otherwise
+   */
+  function findViewByControl(control) {
+    if (!control) {
+      return undefined;
+    }
+    if (isA('sap.ui.core.mvc.View', control)) {
+      return control;
+    }
+    const parent = getElementParent(control);
+    if (!parent) {
+      return undefined;
+    }
+    return findViewByControl(parent);
+  }
+  function findNestedElements(ownerElement, candidates) {
+    const ownerId = ownerElement.getId();
+    return candidates.filter(item => hasParent(item, ownerId));
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getComponent = getComponent;
+  __exports.getControlById = getControlById;
+  __exports.getControlBySelector = getControlBySelector;
+  __exports.isManagedObject = isManagedObject;
+  __exports.isA = isA;
+  __exports.hasParent = hasParent;
+  __exports.findViewByControl = findViewByControl;
+  __exports.findNestedElements = findNestedElements;
+  return __exports;
+});
+//# sourceMappingURL=core.js.map

package/dist/preview-middleware/dist/client/utils/core.ts

@@ -0,0 +1,145 @@
+import Component from 'sap/ui/core/Component';
+import type { ID } from 'sap/ui/core/library';
+import type ManagedObject from 'sap/ui/base/ManagedObject';
+import Element from 'sap/ui/core/Element';
+import View from 'sap/ui/core/mvc/View';
+import type Selector from 'sap/ui/fl/Selector';
+import JsControlTreeModifier from 'sap/ui/core/util/reflection/JsControlTreeModifier';
+import Log from 'sap/base/Log';
+import { getError } from './error';
+
+/**
+ * Gets Component by id.
+ *
+ * @param id - unique identifier for control
+ * @returns Component | undefined
+ */
+export function getComponent<T extends Component = Component>(id: ID): T | undefined {
+    if (Component?.getComponentById) {
+        return Component.getComponentById(id) as T;
+    } else if (Component?.get) {
+        // Older version must be still supported until maintenance period.
+        return Component.get(id) as T; // NOSONAR
+    } else {
+        // Older version must be still supported until maintenance period.
+        return sap.ui.getCore().getComponent(id) as T; // NOSONAR
+    }
+}
+
+/**
+ * Returns control by its global ID.
+ *
+ * @param id Id of the control.
+ * @returns Control instance if it exists.
+ */
+export function getControlById<T extends Element = Element>(id: string): T | undefined {
+    if (typeof Element.getElementById === 'function') {
+        return Element.getElementById(id) as T;
+    } else {
+        return sap.ui.getCore().byId(id) as T;
+    }
+}
+
+/**
+ * Gets target control by trying getControlById first, then falling back to JsControlTreeModifier.bySelector
+ * for projects where the control may not be found by global ID.
+ *
+ * @param selector - The selector object from the change.
+ * @param appComponent - The app component (optional).
+ * @returns The target control element or undefined.
+ */
+export function getControlBySelector<T extends Element = Element>(
+    selector: Selector | undefined,
+    appComponent?: Component
+): T | undefined {
+    if (!selector?.id) {
+        return undefined;
+    }
+
+    let control = getControlById<T>(selector.id);
+    if (!control && appComponent && selector) {
+        try {
+            control = JsControlTreeModifier.bySelector(selector, appComponent) as unknown as T | undefined;
+        } catch (error) {
+            Log.warning('Failed to get control by selector:', getError(error));
+        }
+    }
+
+    return control;
+}
+
+/**
+ * Checks wether this object is an instance of a ManagedObject.
+ *
+ * @param element An object.
+ * @returns True if element is an instance of a ManagedObject.
+ */
+export function isManagedObject(element: object | undefined): element is ManagedObject {
+    if (typeof (element as unknown as { isA?: (_type: string) => boolean })?.isA === 'function') {
+        return (element as unknown as { isA: (_type: string) => boolean }).isA('sap.ui.base.ManagedObject');
+    }
+
+    return false;
+}
+
+/**
+ * Checks whether this object is an instance of the named type.
+ *
+ * @param type - Type to check for.
+ * @param element - Object to check
+ * @returns Whether this object is an instance of the given type.
+ */
+export function isA<T extends ManagedObject>(type: string, element: ManagedObject | undefined): element is T {
+    return !!element?.isA(type);
+}
+
+export function hasParent(component: ManagedObject, parentIdToFind: string): boolean  {
+    const parent = component.getParent();
+    if (!parent) {
+        return false;
+    }
+    if (parent.getId() === parentIdToFind) {
+        return true;
+    }
+    return hasParent(parent, parentIdToFind);
+}
+
+/**
+ * Utility function to safely call getParent on UI5 elements
+ * @param element UI5 element
+ * @returns parent element or null
+ */
+function getElementParent(element: Element | ManagedObject): ManagedObject | null {
+    if (typeof element.getParent === 'function') {
+        return element.getParent();
+    }
+    return null;
+}
+
+/**
+ * Finds the view that contains the given control.
+ *
+ * @param control - Control instance  
+ * @returns View instance if found, undefined otherwise
+ */
+export function findViewByControl(control: Element | ManagedObject): View | undefined {
+    if (!control) {
+        return undefined;
+    }
+    if (isA<View>('sap.ui.core.mvc.View', control)) {
+        return control;
+    }
+    const parent = getElementParent(control);
+    if (!parent) {
+        return undefined;
+    }
+    return findViewByControl(parent);
+}
+
+export function findNestedElements(
+    ownerElement: Element,
+    candidates: Element[]
+): Element[] {
+    const ownerId = ownerElement.getId();
+    return candidates.filter((item) => hasParent(item, ownerId));
+}

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

@@ -0,0 +1,28 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Returns the Error if the error is an instance of `Error` otherwise a new Error instance with string representation of the error.
+   *
+   * @param error {unknown} - the error instance
+   * @returns {Error} the error
+   */
+  function getError(error) {
+    return error instanceof Error ? error : new Error(JSON.stringify(error));
+  }
+  class FetchError extends Error {
+    constructor(response) {
+      super(`Fetch error: ${response.url}, ${response.status} - ${response.statusText}`);
+      this.status = response.status;
+    }
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getError = getError;
+  __exports.FetchError = FetchError;
+  return __exports;
+});
+//# sourceMappingURL=error.js.map

package/dist/preview-middleware/dist/client/utils/error.ts

@@ -0,0 +1,18 @@
+/**
+ * Returns the Error if the error is an instance of `Error` otherwise a new Error instance with string representation of the error.
+ *
+ * @param error {unknown} - the error instance
+ * @returns {Error} the error
+ */
+export function getError(error: unknown): Error {
+    return error instanceof Error ? error : new Error(JSON.stringify(error));
+}
+
+export class FetchError extends Error {
+    readonly status: number;
+
+    constructor(response: Response) {
+        super(`Fetch error: ${response.url}, ${response.status} - ${response.statusText}`);
+        this.status = response.status;
+    }
+}

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

@@ -0,0 +1,58 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  const OBJECT_PAGE_COMPONENT_NAME = 'sap.suite.ui.generic.template.ObjectPage';
+
+  /**
+   * Returns application object page definitions found in manifest
+   *
+   * @param manifest - manifest object
+   * @returns array with page descriptors
+   */
+  function getV2ApplicationPages(manifest) {
+    // do we need to distinguish both navigation source and target entitySets to differentiate alternative routes?
+    const rootEntry = manifest['sap.ui.generic.app'] || manifest['sap.ovp'];
+    if (rootEntry) {
+      const result = [];
+      const collectPageData = (pagesDefinitions, idPrefix) => {
+        if (!pagesDefinitions) {
+          return;
+        }
+        if (Array.isArray(pagesDefinitions)) {
+          pagesDefinitions.forEach((entry, idx) => {
+            const id = `${idPrefix}-${idx}`;
+            if (entry.component.name === OBJECT_PAGE_COMPONENT_NAME) {
+              result.push({
+                id,
+                entitySet: entry.entitySet
+              });
+            }
+            collectPageData(entry.pages, id);
+          });
+        } else {
+          const pageIds = Object.keys(pagesDefinitions);
+          for (const pageId of pageIds) {
+            if (pagesDefinitions[pageId].component.name === OBJECT_PAGE_COMPONENT_NAME) {
+              result.push({
+                id: pageId,
+                entitySet: pagesDefinitions[pageId].entitySet
+              });
+            }
+            collectPageData(pagesDefinitions[pageId].pages, idPrefix);
+          }
+        }
+      };
+      collectPageData(rootEntry.pages, 'page');
+      return result;
+    }
+    return [];
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getV2ApplicationPages = getV2ApplicationPages;
+  return __exports;
+});
+//# sourceMappingURL=fe-v2.js.map

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

@@ -0,0 +1,61 @@
+import type { Manifest } from 'sap/ui/rta/RuntimeAuthoring';
+
+interface V2ManifestPageDefinition {
+    component: {
+        name: string;
+    };
+    entitySet: string;
+    pages?: Record<string, V2ManifestPageDefinition> | Array<V2ManifestPageDefinition>;
+}
+
+const OBJECT_PAGE_COMPONENT_NAME = 'sap.suite.ui.generic.template.ObjectPage';
+
+/**
+ * Returns application object page definitions found in manifest
+ *
+ * @param manifest - manifest object
+ * @returns array with page descriptors
+ */
+export function getV2ApplicationPages(manifest: Manifest): { id: string; entitySet: string | undefined }[] {
+    // do we need to distinguish both navigation source and target entitySets to differentiate alternative routes?
+    const rootEntry = manifest['sap.ui.generic.app'] || manifest['sap.ovp'];
+    if (rootEntry) {
+        const result: { id: string; entitySet: string | undefined }[] = [];
+
+        const collectPageData = <T extends Record<string, V2ManifestPageDefinition> | Array<V2ManifestPageDefinition>>(
+            pagesDefinitions: T | undefined,
+            idPrefix: string
+        ) => {
+            if (!pagesDefinitions) {
+                return;
+            }
+
+            if (Array.isArray(pagesDefinitions)) {
+                pagesDefinitions.forEach((entry, idx) => {
+                    const id = `${idPrefix}-${idx}`;
+                    if (entry.component.name === OBJECT_PAGE_COMPONENT_NAME) {
+                        result.push({
+                            id,
+                            entitySet: entry.entitySet
+                        });
+                    }
+                    collectPageData(entry.pages, id);
+                });
+            } else {
+                const pageIds = Object.keys(pagesDefinitions);
+                for (const pageId of pageIds) {
+                    if (pagesDefinitions[pageId].component.name === OBJECT_PAGE_COMPONENT_NAME) {
+                        result.push({
+                            id: pageId,
+                            entitySet: pagesDefinitions[pageId].entitySet
+                        });
+                    }
+                    collectPageData(pagesDefinitions[pageId].pages, idPrefix);
+                }
+            }
+        };
+        collectPageData(rootEntry.pages, 'page');
+        return result;
+    }
+    return [];
+}