@sap/ux-ui5-tooling 1.20.4 → 1.22.0

package/dist/preview-middleware/dist/client/cpe/ui5-utils.js

@@ -0,0 +1,35 @@
+"use strict";
+
+sap.ui.define(["sap/ui/core/IconPool"], function (IconPool) {
+  "use strict";
+
+  /**
+   * Get ui5 icons.
+   *
+   * @returns IconDetails[]
+   */
+  function getIcons() {
+    return IconPool.getIconNames('undefined').map(icon => {
+      const iconInfo = IconPool.getIconInfo(icon);
+      return {
+        name: icon.toLowerCase(),
+        content: iconInfo.content,
+        fontFamily: iconInfo.fontFamily
+      };
+    }).sort((item1, item2) => {
+      if (item1.name < item2.name) {
+        return -1;
+      }
+      if (item1.name > item2.name) {
+        return 1;
+      }
+      return 0;
+    });
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getIcons = getIcons;
+  return __exports;
+});
+//# sourceMappingURL=ui5-utils.js.map

package/dist/preview-middleware/dist/client/cpe/ui5-utils.ts

@@ -0,0 +1,28 @@
+import type { IconDetails } from '@sap-ux-private/control-property-editor-common';
+import IconPool from 'sap/ui/core/IconPool';
+
+/**
+ * Get ui5 icons.
+ *
+ * @returns IconDetails[]
+ */
+export function getIcons(): IconDetails[] {
+    return IconPool.getIconNames('undefined')
+        .map((icon: string) => {
+            const iconInfo = IconPool.getIconInfo(icon) as IconDetails;
+            return {
+                name: icon.toLowerCase(),
+                content: iconInfo.content,
+                fontFamily: iconInfo.fontFamily
+            } as IconDetails;
+        })
+        .sort((item1: IconDetails, item2: IconDetails) => {
+            if (item1.name < item2.name) {
+                return -1;
+            }
+            if (item1.name > item2.name) {
+                return 1;
+            }
+            return 0;
+        });
+}

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

@@ -0,0 +1,113 @@
+"use strict";
+
+sap.ui.define(["sap/ui/core/mvc/XMLView", "sap/ui/core/UIComponent", "../utils/core", "sap/ui/dt/OverlayRegistry", "sap/ui/dt/OverlayUtil"], function (XMLView, UIComponent, ___utils_core, OverlayRegistry, OverlayUtil) {
+  "use strict";
+
+  const getComponent = ___utils_core["getComponent"];
+  /**
+   * Get runtime control.
+   *
+   * @param overlayControl - element overlay.
+   * @returns ManagedObject
+   */
+  function getRuntimeControl(overlayControl) {
+    let runtimeControl;
+    if (overlayControl.getElementInstance) {
+      runtimeControl = overlayControl.getElementInstance();
+    } else {
+      runtimeControl = overlayControl.getElement();
+    }
+    return runtimeControl;
+  }
+
+  /**
+   * Get library of a control name.
+   *
+   * @param controlName - name of the ui5 control eg: sap.m.Button.
+   * @returns Promise<string>
+   */
+  async function getLibrary(controlName) {
+    return new Promise(resolve => {
+      const controlPath = controlName.replace(/\./g, '/');
+      sap.ui.require([controlPath], control => {
+        const contMetadata = control.getMetadata();
+        // getLibraryName method does not exist on events
+        if (contMetadata?.getLibraryName) {
+          const contLibName = contMetadata.getLibraryName();
+          resolve(contLibName);
+        } else {
+          resolve(''); // return empty for events
+        }
+      });
+    });
+  }
+
+  /**
+   * Gets the root view of component for the provided ComponentContainer control.
+   *
+   * @param container ComponentContainer control.
+   * @returns XMLView which is the root control of the component if it exists.
+   */
+  function getRootControlFromComponentContainer(container) {
+    if (container) {
+      const componentId = container.getComponent();
+      const component = getComponent(componentId);
+      if (component instanceof UIComponent) {
+        const rootControl = component.getRootControl();
+        if (rootControl instanceof XMLView) {
+          return rootControl;
+        }
+      }
+    }
+    return undefined;
+  }
+  function getManifestProperties(control, changeService, controlOverlay) {
+    const overlayData = controlOverlay?.getDesignTimeMetadata().getData();
+    if (!controlOverlay || !overlayData?.manifestSettings) {
+      return {};
+    }
+    const manifestPropertiesValue = overlayData?.manifestSettingsValues(overlayData?.manifestSettings(control), control);
+    const manifestProperties = overlayData?.manifestSettings(control).reduce((acc, item) => {
+      const propertyId = item.path ?? item.id;
+      const value = changeService.getConfigurationPropertyValue(control.getId(), propertyId);
+      let propertyValue = value === 0 || value === false || value ? value : manifestPropertiesValue[propertyId];
+      if (item?.type && ['boolean', 'number', 'string'].includes(item?.type)) {
+        if (propertyValue === undefined) {
+          propertyValue = item.value; // set default value of property
+        }
+      }
+      if (!acc[propertyId]) {
+        acc[propertyId] = {
+          ...item,
+          defaultValue: item.value,
+          configuration: true,
+          name: item.id,
+          readableName: item.name,
+          manifestPropertyPath: `${overlayData?.manifestPropertyPath(control)}/${propertyId}`,
+          type: item.type === 'number' ? 'int' : item.type,
+          value: propertyValue
+        };
+      }
+      return acc;
+    }, {});
+    return manifestProperties;
+  }
+  const getOverlay = control => {
+    let controlOverlay = OverlayRegistry.getOverlay(control);
+    if (!controlOverlay?.getDomRef()) {
+      //look for closest control
+      controlOverlay = OverlayUtil.getClosestOverlayFor(control);
+    }
+    return controlOverlay;
+  };
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getRuntimeControl = getRuntimeControl;
+  __exports.getLibrary = getLibrary;
+  __exports.getRootControlFromComponentContainer = getRootControlFromComponentContainer;
+  __exports.getManifestProperties = getManifestProperties;
+  __exports.getOverlay = getOverlay;
+  return __exports;
+});
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1,162 @@
+import type ManagedObject from 'sap/ui/base/ManagedObject';
+import type Control from 'sap/ui/core/Control';
+import type ElementOverlay from 'sap/ui/dt/ElementOverlay';
+import DataType from 'sap/ui/base/DataType';
+import ComponentContainer from 'sap/ui/core/ComponentContainer';
+import XMLView from 'sap/ui/core/mvc/XMLView';
+import UIComponent from 'sap/ui/core/UIComponent';
+
+import { getComponent } from '../utils/core';
+import { DesigntimeSetting } from 'sap/ui/dt/DesignTimeMetadata';
+import { ChangeService } from './changes';
+import UI5Element from 'sap/ui/core/Element';
+import OverlayRegistry from 'sap/ui/dt/OverlayRegistry';
+import OverlayUtil from 'sap/ui/dt/OverlayUtil';
+
+
+export interface PropertiesInfo {
+    defaultValue: string;
+    description: string;
+    propertyName: string;
+    type: string;
+    propertyType: string | undefined;
+}
+export interface Properties {
+    [key: string]: PropertiesInfo;
+}
+
+export interface ManagedObjectMetadataProperties {
+    name: string;
+    defaultValue: string | null;
+    deprecated: boolean;
+    getType: () => DataType;
+    getName: () => string;
+    getDefaultValue: () => unknown;
+}
+
+export interface MergedSetting extends DesigntimeSetting {
+    defaultValue: unknown;
+    value: unknown;
+    configuration: boolean;
+    name: string;
+    readableName: string;
+    manifestPropertyPath: string;
+    type: 'string' | 'int' | 'boolean' | 'undefined';
+}
+
+/**
+ * Get runtime control.
+ *
+ * @param overlayControl - element overlay.
+ * @returns ManagedObject
+ */
+export function getRuntimeControl(overlayControl: ElementOverlay): ManagedObject {
+    let runtimeControl;
+    if (overlayControl.getElementInstance) {
+        runtimeControl = overlayControl.getElementInstance();
+    } else {
+        runtimeControl = overlayControl.getElement();
+    }
+    return runtimeControl;
+}
+
+/**
+ * Get library of a control name.
+ *
+ * @param controlName - name of the ui5 control eg: sap.m.Button.
+ * @returns Promise<string>
+ */
+export async function getLibrary(controlName: string): Promise<string> {
+    return new Promise((resolve) => {
+        const controlPath = controlName.replace(/\./g, '/');
+        sap.ui.require([controlPath], (control: Control) => {
+            const contMetadata = control.getMetadata();
+            // getLibraryName method does not exist on events
+            if (contMetadata?.getLibraryName) {
+                const contLibName = contMetadata.getLibraryName();
+                resolve(contLibName);
+            } else {
+                resolve(''); // return empty for events
+            }
+        });
+    });
+}
+
+/**
+ * Gets the root view of component for the provided ComponentContainer control.
+ *
+ * @param container ComponentContainer control.
+ * @returns XMLView which is the root control of the component if it exists.
+ */
+export function getRootControlFromComponentContainer(container?: ComponentContainer): XMLView | undefined {
+    if (container) {
+        const componentId = container.getComponent();
+        const component = getComponent(componentId);
+        if (component instanceof UIComponent) {
+            const rootControl = component.getRootControl();
+            if (rootControl instanceof XMLView) {
+                return rootControl;
+            }
+        }
+    }
+    return undefined;
+}
+
+export function getManifestProperties(
+    control: ManagedObject,
+    changeService: ChangeService,
+    controlOverlay?: ElementOverlay
+): {
+    [key: string]: MergedSetting;
+} {
+    const overlayData = controlOverlay?.getDesignTimeMetadata().getData();
+    if (!controlOverlay || !overlayData?.manifestSettings) {
+        return {};
+    }
+    const manifestPropertiesValue = overlayData?.manifestSettingsValues(
+        overlayData?.manifestSettings(control),
+        control
+    );
+    const manifestProperties = overlayData?.manifestSettings(control).reduce(
+        (
+            acc: {
+                [key: string]: MergedSetting;
+            },
+            item: DesigntimeSetting
+        ) => {
+            const propertyId = item.path ?? item.id;
+            const value = changeService.getConfigurationPropertyValue(control.getId(), propertyId);
+            let propertyValue = value === 0 || value === false || value ? value : manifestPropertiesValue[propertyId];
+            if (item?.type && ['boolean', 'number', 'string'].includes(item?.type)) {
+                if (propertyValue === undefined) {
+                    propertyValue = item.value as string | boolean | number; // set default value of property
+                }
+            }
+            if (!acc[propertyId]) {
+                acc[propertyId] = {
+                    ...item,
+                    defaultValue: item.value,
+                    configuration: true,
+                    name: item.id,
+                    readableName: item.name,
+                    manifestPropertyPath: `${overlayData?.manifestPropertyPath(control)}/${propertyId}`,
+                    type: item.type === 'number' ? 'int' : (item.type as 'string' | 'boolean' | 'undefined'),
+                    value: propertyValue
+                };
+            }
+            return acc;
+        },
+        {}
+    );
+    return manifestProperties;
+}
+
+export const getOverlay = (control: UI5Element): ElementOverlay | undefined => {
+    let controlOverlay = OverlayRegistry.getOverlay(control);
+    if (!controlOverlay?.getDomRef()) {
+        //look for closest control
+        controlOverlay = OverlayUtil.getClosestOverlayFor(control);
+    }
+
+    return controlOverlay;
+};

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

@@ -0,0 +1,97 @@
+"use strict";
+
+sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStorageConnector", "sap/ui/fl/Layer", "./common", "../utils/version", "../utils/additional-change-info"], function (merge, ObjectStorageConnector, Layer, ___common, ___utils_version, ___utils_additional_change_info) {
+  "use strict";
+
+  const CHANGES_API_PATH_STATIC = ___common["CHANGES_API_PATH"];
+  const getFlexSettings = ___common["getFlexSettings"];
+  const getUi5Version = ___utils_version["getUi5Version"];
+  const isLowerThanMinimalUi5Version = ___utils_version["isLowerThanMinimalUi5Version"];
+  const getAdditionalChangeInfo = ___utils_additional_change_info["getAdditionalChangeInfo"];
+  const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ?? '';
+  const changesApiPath = `${baseUrl}${CHANGES_API_PATH_STATIC}`;
+  const connector = merge({}, ObjectStorageConnector, {
+    layers: [Layer.VENDOR, Layer.CUSTOMER_BASE],
+    storage: {
+      _itemsStoredAsObjects: true,
+      fileChangeRequestNotifier: undefined,
+      setItem: function (_key, change) {
+        const settings = getFlexSettings();
+        if (settings) {
+          change.support ??= {};
+          change.support.generator = settings.generator;
+        }
+        const additionalChangeInfo = getAdditionalChangeInfo(change);
+        if (typeof this.fileChangeRequestNotifier === 'function' && change.fileName) {
+          try {
+            this.fileChangeRequestNotifier(change.fileName, 'create', change, additionalChangeInfo);
+          } catch {
+            // exceptions in the listener call are ignored
+          }
+        }
+        const body = {
+          change,
+          additionalChangeInfo
+        };
+        return fetch(changesApiPath, {
+          method: 'POST',
+          body: JSON.stringify(body, null, 2),
+          headers: {
+            'content-type': 'application/json'
+          }
+        });
+      },
+      removeItem: function (key) {
+        if (typeof this.fileChangeRequestNotifier === 'function') {
+          try {
+            this.fileChangeRequestNotifier(key, 'delete');
+          } catch {
+            // exceptions in the listener call are ignored
+          }
+        }
+        return fetch(changesApiPath, {
+          method: 'DELETE',
+          body: JSON.stringify({
+            fileName: key
+          }),
+          headers: {
+            'content-type': 'application/json'
+          }
+        });
+      },
+      clear: function () {
+        // not implemented
+      },
+      getItem: function (_key) {
+        // not implemented
+      },
+      getItems: async function () {
+        const response = await fetch(changesApiPath, {
+          method: 'GET',
+          headers: {
+            'content-type': 'application/json'
+          }
+        });
+        return await response.json();
+      }
+    },
+    loadFeatures: async function () {
+      const features = await ObjectStorageConnector.loadFeatures();
+      features.isVariantAdaptationEnabled = !isLowerThanMinimalUi5Version(await getUi5Version(), {
+        major: 1,
+        minor: 90
+      });
+      const settings = getFlexSettings();
+      if (settings?.developerMode) {
+        features.isVariantAdaptationEnabled = false;
+      }
+      if (settings?.scenario === 'ADAPTATION_PROJECT') {
+        features.isVariantAdaptationEnabled = true;
+      }
+      features.isAnnotationChangeEnabled = false;
+      return features;
+    }
+  });
+  return connector;
+});
+//# sourceMappingURL=WorkspaceConnector.js.map

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

@@ -0,0 +1,101 @@
+import merge from 'sap/base/util/merge';
+import ObjectStorageConnector from 'sap/ui/fl/write/api/connectors/ObjectStorageConnector';
+import Layer from 'sap/ui/fl/Layer';
+import type { FlexChange } from './common';
+import { CHANGES_API_PATH as CHANGES_API_PATH_STATIC, getFlexSettings } from './common';
+import { getUi5Version, isLowerThanMinimalUi5Version } from '../utils/version';
+import { getAdditionalChangeInfo } from '../utils/additional-change-info';
+
+const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ??'';
+const changesApiPath = `${baseUrl}${CHANGES_API_PATH_STATIC}`;
+
+const connector = merge({}, ObjectStorageConnector, {
+    layers: [Layer.VENDOR, Layer.CUSTOMER_BASE],
+    storage: {
+        _itemsStoredAsObjects: true,
+        fileChangeRequestNotifier: undefined,
+        setItem: function (_key: string, change: FlexChange) {
+            const settings = getFlexSettings();
+            if (settings) {
+                change.support ??= {};
+                change.support.generator = settings.generator;
+            }
+
+            const additionalChangeInfo = getAdditionalChangeInfo(change);
+
+            if (typeof this.fileChangeRequestNotifier === 'function' && change.fileName) {
+                try {
+                    this.fileChangeRequestNotifier(change.fileName, 'create', change, additionalChangeInfo);
+                } catch {
+                    // exceptions in the listener call are ignored
+                }
+            }
+
+            const body = {
+                change,
+                additionalChangeInfo
+            };
+
+            return fetch(changesApiPath, {
+                method: 'POST',
+                body: JSON.stringify(body, null, 2),
+                headers: {
+                    'content-type': 'application/json'
+                }
+            });
+        },
+        removeItem: function (key: string) {
+            if (typeof this.fileChangeRequestNotifier === 'function') {
+                try {
+                    this.fileChangeRequestNotifier(key, 'delete');
+                } catch {
+                    // exceptions in the listener call are ignored
+                }
+            }
+
+            return fetch(changesApiPath, {
+                method: 'DELETE',
+                body: JSON.stringify({ fileName: key }),
+                headers: {
+                    'content-type': 'application/json'
+                }
+            });
+        },
+        clear: function () {
+            // not implemented
+        },
+        getItem: function (_key: string) {
+            // not implemented
+        },
+        getItems: async function () {
+            const response = await fetch(changesApiPath, {
+                method: 'GET',
+                headers: {
+                    'content-type': 'application/json'
+                }
+            });
+            return (await response.json()) as unknown as FlexChange[];
+        }
+    } as typeof ObjectStorageConnector.storage,
+    loadFeatures: async function () {
+        const features = await ObjectStorageConnector.loadFeatures();
+        features.isVariantAdaptationEnabled = !isLowerThanMinimalUi5Version(await getUi5Version(), {
+            major: 1,
+            minor: 90
+        });
+        const settings = getFlexSettings();
+        if (settings?.developerMode) {
+            features.isVariantAdaptationEnabled = false;
+        }
+
+        if (settings?.scenario === 'ADAPTATION_PROJECT') {
+            features.isVariantAdaptationEnabled = true;
+        }
+
+        features.isAnnotationChangeEnabled = false;
+
+        return features;
+    }
+}) as typeof ObjectStorageConnector;
+
+export default connector;

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

@@ -0,0 +1,30 @@
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  const CHANGES_API_PATH = '/preview/api/changes';
+
+  /**
+   * Retrieves Flex settings from a 'sap-ui-bootstrap' element's data attribute.
+   * Parses the 'data-open-ux-preview-flex-settings' attribute as JSON.
+   *
+   * @returns {FlexSettings | undefined} The parsed Flex settings if available, otherwise undefined.
+   */
+  function getFlexSettings() {
+    let result;
+    const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
+    const flexSetting = bootstrapConfig?.dataset.openUxPreviewFlexSettings;
+    if (flexSetting) {
+      result = JSON.parse(flexSetting);
+    }
+    return result;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.CHANGES_API_PATH = CHANGES_API_PATH;
+  __exports.getFlexSettings = getFlexSettings;
+  return __exports;
+});
+//# sourceMappingURL=common.js.map

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

@@ -0,0 +1,28 @@
+import type { FlexSettings } from 'sap/ui/rta/RuntimeAuthoring';
+
+export interface FlexChange {
+    [key: string]: string | object | undefined;
+    changeType: string;
+    fileName: string;
+    support: {
+        generator?: string;
+    };
+}
+
+export const CHANGES_API_PATH = '/preview/api/changes';
+
+/**
+ * Retrieves Flex settings from a 'sap-ui-bootstrap' element's data attribute.
+ * Parses the 'data-open-ux-preview-flex-settings' attribute as JSON.
+ *
+ * @returns {FlexSettings | undefined} The parsed Flex settings if available, otherwise undefined.
+ */
+export function getFlexSettings(): FlexSettings | undefined {
+    let result: FlexSettings | undefined;
+    const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
+    const flexSetting = bootstrapConfig?.dataset.openUxPreviewFlexSettings;
+    if (flexSetting) {
+        result = JSON.parse(flexSetting) as FlexSettings;
+    }
+    return result;
+}

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

@@ -0,0 +1,92 @@
+"use strict";
+
+sap.ui.define(["sap/ui/fl/LrepConnector", "sap/ui/fl/FakeLrepConnector", "../utils/additional-change-info", "./common"], function (LrepConnector, FakeLrepConnector, ___utils_additional_change_info, ___common) {
+  "use strict";
+
+  const getAdditionalChangeInfo = ___utils_additional_change_info["getAdditionalChangeInfo"];
+  const CHANGES_API_PATH_STATIC = ___common["CHANGES_API_PATH"];
+  const getFlexSettings = ___common["getFlexSettings"];
+  const baseUrl = document.getElementById('sap-ui-bootstrap')?.dataset.openUxPreviewBaseUrl ?? '';
+  const changesApiPath = `${baseUrl}${CHANGES_API_PATH_STATIC}`;
+
+  /**
+   * 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;
+      }
+      const additionalChangeInfo = getAdditionalChangeInfo(change);
+      if (typeof FakeLrepConnector.fileChangeRequestNotifier === 'function' && change.fileName) {
+        try {
+          FakeLrepConnector.fileChangeRequestNotifier(change.fileName, 'create', change, additionalChangeInfo);
+        } catch {
+          // exceptions in the listener call are ignored
+        }
+      }
+      const body = {
+        change,
+        additionalChangeInfo
+      };
+      return fetch(changesApiPath, {
+        method: 'POST',
+        body: JSON.stringify(body, 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(...args) {
+    const lrep = new LrepConnector();
+    const response = await fetch(changesApiPath, {
+      method: 'GET',
+      headers: {
+        'content-type': 'application/json'
+      }
+    });
+    const changes = await response.json();
+    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 an 'ui.version' property,
+   * and global jQuery object with 'extend' method.
+   *
+   * @returns {void}
+   */
+  var __exports = function () {
+    // eslint-disable-next-line no-undef
+    jQuery.extend(FakeLrepConnector.prototype, {
+      create,
+      loadChanges,
+      loadSettings: () => Promise.resolve()
+    });
+    FakeLrepConnector.enableFakeConnector();
+  };
+  __exports.create = create;
+  __exports.loadChanges = loadChanges;
+  return __exports;
+});
+//# sourceMappingURL=enableFakeConnector.js.map