@sap-ux/preview-middleware 0.12.13 → 0.12.15

package/dist/client/cpe/outline/utils.js

@@ -1,39 +1,39 @@
-"use strict";
-
-sap.ui.define(["../control-data", "../utils", "sap/ui/dt/OverlayUtil", "sap/ui/dt/OverlayRegistry", "../ui5-utils"], function (___control_data, ___utils, OverlayUtil, OverlayRegistry, ___ui5_utils) {
-  "use strict";
-
-  const buildControlData = ___control_data["buildControlData"];
-  const getRuntimeControl = ___utils["getRuntimeControl"];
-  const getComponent = ___ui5_utils["getComponent"];
-  const isEditable = function () {
-    let id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-    let editable = false;
-    const control = sap.ui.getCore().byId(id);
-    if (!control) {
-      const component = getComponent(id);
-      if (component) {
-        return editable;
-      }
-    } else {
-      let controlOverlay = OverlayRegistry.getOverlay(control);
-      if (!controlOverlay?.getDomRef()) {
-        //look for closest control
-        controlOverlay = OverlayUtil.getClosestOverlayFor(control);
-      }
-      if (controlOverlay) {
-        const runtimeControl = getRuntimeControl(controlOverlay);
-        const controlData = buildControlData(runtimeControl, controlOverlay);
-        const prop = controlData.properties.find(item => item.isEnabled === true);
-        editable = prop !== undefined;
-      }
-    }
-    return editable;
-  };
-  var __exports = {
-    __esModule: true
-  };
-  __exports.isEditable = isEditable;
-  return __exports;
+"use strict";
+
+sap.ui.define(["../control-data", "../utils", "sap/ui/dt/OverlayUtil", "sap/ui/dt/OverlayRegistry", "../ui5-utils"], function (___control_data, ___utils, OverlayUtil, OverlayRegistry, ___ui5_utils) {
+  "use strict";
+
+  const buildControlData = ___control_data["buildControlData"];
+  const getRuntimeControl = ___utils["getRuntimeControl"];
+  const getComponent = ___ui5_utils["getComponent"];
+  const isEditable = function () {
+    let id = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+    let editable = false;
+    const control = sap.ui.getCore().byId(id);
+    if (!control) {
+      const component = getComponent(id);
+      if (component) {
+        return editable;
+      }
+    } else {
+      let controlOverlay = OverlayRegistry.getOverlay(control);
+      if (!controlOverlay?.getDomRef()) {
+        //look for closest control
+        controlOverlay = OverlayUtil.getClosestOverlayFor(control);
+      }
+      if (controlOverlay) {
+        const runtimeControl = getRuntimeControl(controlOverlay);
+        const controlData = buildControlData(runtimeControl, controlOverlay);
+        const prop = controlData.properties.find(item => item.isEnabled === true);
+        editable = prop !== undefined;
+      }
+    }
+    return editable;
+  };
+  var __exports = {
+    __esModule: true
+  };
+  __exports.isEditable = isEditable;
+  return __exports;
 });
 //# sourceMappingURL=utils.js.map

package/dist/client/cpe/types.js

@@ -1,6 +1,6 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
 });
 //# sourceMappingURL=types.js.map

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

@@ -1,51 +1,51 @@
-"use strict";
-
-sap.ui.define(["sap/ui/core/Component", "sap/ui/core/IconPool"], function (Component, IconPool) {
-  "use strict";
-
-  /**
-   * Gets Component by id.
-   *
-   * @param id - unique identifier for control
-   * @returns Component | undefined
-   */
-  function getComponent(id) {
-    if (Component?.get) {
-      return Component.get(id);
-    } else {
-      // Older version must be still supported until maintenance period.
-      return sap.ui.getCore().getComponent(id); // NOSONAR
-    }
-  }
-
-  /**
-   * 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.getComponent = getComponent;
-  __exports.getIcons = getIcons;
-  return __exports;
+"use strict";
+
+sap.ui.define(["sap/ui/core/Component", "sap/ui/core/IconPool"], function (Component, IconPool) {
+  "use strict";
+
+  /**
+   * Gets Component by id.
+   *
+   * @param id - unique identifier for control
+   * @returns Component | undefined
+   */
+  function getComponent(id) {
+    if (Component?.get) {
+      return Component.get(id);
+    } else {
+      // Older version must be still supported until maintenance period.
+      return sap.ui.getCore().getComponent(id); // NOSONAR
+    }
+  }
+
+  /**
+   * 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.getComponent = getComponent;
+  __exports.getIcons = getIcons;
+  return __exports;
 });
 //# sourceMappingURL=ui5-utils.js.map

package/dist/client/cpe/utils.js

@@ -1,50 +1,50 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  /**
-   * 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
-        }
-      });
-    });
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.getRuntimeControl = getRuntimeControl;
-  __exports.getLibrary = getLibrary;
-  return __exports;
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * 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
+        }
+      });
+    });
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.getRuntimeControl = getRuntimeControl;
+  __exports.getLibrary = getLibrary;
+  return __exports;
 });
 //# sourceMappingURL=utils.js.map

package/dist/client/flp/WorkspaceConnector.js

@@ -1,71 +1,86 @@
-"use strict";
-
-sap.ui.define(["sap/base/util/merge", "sap/ui/fl/write/api/connectors/ObjectStorageConnector", "sap/ui/fl/Layer", "sap/ui/VersionInfo", "./common"], function (merge, ObjectStorageConnector, Layer, VersionInfo, ___common) {
-  "use strict";
-
-  const CHANGES_API_PATH = ___common["CHANGES_API_PATH"];
-  const getFlexSettings = ___common["getFlexSettings"];
-  const connector = merge({}, ObjectStorageConnector, {
-    layers: [Layer.VENDOR, Layer.CUSTOMER_BASE],
-    storage: {
-      _itemsStoredAsObjects: true,
-      setItem: function (_key, change) {
-        const settings = getFlexSettings();
-        if (settings) {
-          change.support ??= {};
-          change.support.generator = settings.generator;
-        }
-        return fetch(CHANGES_API_PATH, {
-          method: 'POST',
-          body: JSON.stringify(change, null, 2),
-          headers: {
-            'content-type': 'application/json'
-          }
-        });
-      },
-      removeItem: function (key) {
-        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'
-          }
-        });
-        const changes = await response.json();
-        return changes;
-      }
-    },
-    loadFeatures: async function () {
-      const features = await ObjectStorageConnector.loadFeatures();
-      const ui5Version = await VersionInfo.load();
-      const [majorVersion, minorVersion] = ui5Version.version.split('.').map(v => parseInt(v, 10));
-      features.isVariantAdaptationEnabled = majorVersion >= 1 && minorVersion >= 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", "sap/ui/VersionInfo", "./common"], function (merge, ObjectStorageConnector, Layer, VersionInfo, ___common) {
+  "use strict";
+
+  const CHANGES_API_PATH = ___common["CHANGES_API_PATH"];
+  const getFlexSettings = ___common["getFlexSettings"];
+  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.changeType);
+          } 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'
+          }
+        });
+        const changes = await response.json();
+        return changes;
+      }
+    },
+    loadFeatures: async function () {
+      const features = await ObjectStorageConnector.loadFeatures();
+      const ui5Version = await VersionInfo.load();
+      const [majorVersion, minorVersion] = ui5Version.version.split('.').map(v => parseInt(v, 10));
+      features.isVariantAdaptationEnabled = majorVersion >= 1 && minorVersion >= 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

@@ -8,6 +8,7 @@ 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) {
@@ -15,6 +16,14 @@ const connector = merge({}, ObjectStorageConnector, {
                 change.support.generator = settings.generator;
             }
 
+            if (typeof this.fileChangeRequestNotifier === 'function' && change.fileName) {
+                try {
+                    this.fileChangeRequestNotifier(change.fileName, 'create',  change.changeType);
+                } catch (e) {
+                    // exceptions in the listener call are ignored
+                }
+            }
+
             return fetch(CHANGES_API_PATH, {
                 method: 'POST',
                 body: JSON.stringify(change, null, 2),
@@ -24,6 +33,14 @@ const connector = merge({}, ObjectStorageConnector, {
             });
         },
         removeItem: function (key: string) {
+            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 }),
@@ -48,7 +65,7 @@ const connector = merge({}, ObjectStorageConnector, {
             const changes = await response.json();
             return changes;
         }
-    },
+    } as typeof ObjectStorageConnector.storage,
     loadFeatures: async function () {
         const features = await ObjectStorageConnector.loadFeatures();
 

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

package/dist/client/flp/common.ts

@@ -2,6 +2,8 @@ import { FlexSettings } from 'sap/ui/rta/RuntimeAuthoring';
 
 export interface FlexChange {
     [key: string]: string | object | undefined;
+    changeType: string;
+    fileName: string;
     support: {
         generator?: string;
     };