@sap-ux/preview-middleware 0.19.29 → 0.19.31

package/dist/client/cpe/utils.js

@@ -1,113 +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.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;
+"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.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/client/flp/WorkspaceConnector.js

@@ -1,88 +1,94 @@
-"use strict";
-
-sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStorageConnector", "sap/ui/fl/Layer", "./common", "../utils/version"], function (merge, ObjectStorageConnector, Layer, ___common, ___utils_version) {
-  "use strict";
-
-  const CHANGES_API_PATH = ___common["CHANGES_API_PATH"];
-  const getFlexSettings = ___common["getFlexSettings"];
-  const getUi5Version = ___utils_version["getUi5Version"];
-  const isLowerThanMinimalUi5Version = ___utils_version["isLowerThanMinimalUi5Version"];
-  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;
-        }
-        if (typeof this.fileChangeRequestNotifier === 'function' && change.fileName) {
-          try {
-            this.fileChangeRequestNotifier(change.fileName, 'create', change);
-          } catch (e) {
-            // exceptions in the listener call are ignored
-          }
-        }
-        return fetch(CHANGES_API_PATH, {
-          method: 'POST',
-          body: JSON.stringify(change, null, 2),
-          headers: {
-            'content-type': 'application/json'
-          }
-        });
-      },
-      removeItem: function (key) {
-        if (typeof this.fileChangeRequestNotifier === 'function') {
-          try {
-            this.fileChangeRequestNotifier(key, 'delete');
-          } catch (e) {
-            // exceptions in the listener call are ignored
-          }
-        }
-        return fetch(CHANGES_API_PATH, {
-          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(CHANGES_API_PATH, {
-          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;
-      }
-      return features;
-    }
-  });
-  return connector;
+"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 = ___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 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 (e) {
+            // exceptions in the listener call are ignored
+          }
+        }
+        const body = {
+          change,
+          additionalChangeInfo
+        };
+        return fetch(CHANGES_API_PATH, {
+          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 (e) {
+            // exceptions in the listener call are ignored
+          }
+        }
+        return fetch(CHANGES_API_PATH, {
+          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(CHANGES_API_PATH, {
+          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;
+      }
+      return features;
+    }
+  });
+  return connector;
 });
 //# sourceMappingURL=WorkspaceConnector.js.map

package/dist/client/flp/WorkspaceConnector.ts

@@ -3,6 +3,7 @@ import ObjectStorageConnector from 'sap/ui/fl/write/api/connectors/ObjectStorage
 import Layer from 'sap/ui/fl/Layer';
 import { CHANGES_API_PATH, FlexChange, getFlexSettings } from './common';
 import { getUi5Version, isLowerThanMinimalUi5Version } from '../utils/version';
+import { getAdditionalChangeInfo } from '../utils/additional-change-info';
 
 const connector = merge({}, ObjectStorageConnector, {
     layers: [Layer.VENDOR, Layer.CUSTOMER_BASE],
@@ -16,17 +17,24 @@ const connector = merge({}, ObjectStorageConnector, {
                 change.support.generator = settings.generator;
             }
 
+            const additionalChangeInfo = getAdditionalChangeInfo(change);
+
             if (typeof this.fileChangeRequestNotifier === 'function' && change.fileName) {
                 try {
-                    this.fileChangeRequestNotifier(change.fileName, 'create', change);
+                    this.fileChangeRequestNotifier(change.fileName, 'create', change, additionalChangeInfo);
                 } catch (e) {
                     // exceptions in the listener call are ignored
                 }
             }
 
+            const body = {
+                change,
+                additionalChangeInfo
+            };
+
             return fetch(CHANGES_API_PATH, {
                 method: 'POST',
-                body: JSON.stringify(change, null, 2),
+                body: JSON.stringify(body, null, 2),
                 headers: {
                     'content-type': 'application/json'
                 }

package/dist/client/flp/common.js

@@ -1,30 +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?.getAttribute('data-open-ux-preview-flex-settings');
-    if (flexSetting) {
-      result = JSON.parse(flexSetting);
-    }
-    return result;
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.CHANGES_API_PATH = CHANGES_API_PATH;
-  __exports.getFlexSettings = getFlexSettings;
-  return __exports;
+"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?.getAttribute('data-open-ux-preview-flex-settings');
+    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