@sap-ux/preview-middleware 0.11.36 → 0.12.1

package/dist/client/flp/WorkspaceConnector.ts

@@ -2,40 +2,20 @@ 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 VersionInfo from 'sap/ui/VersionInfo';
-
-const path = '/preview/api/changes';
-interface Change {
-    support?: {
-        generator?: string;
-    };
-}
-
-function getFlexSettings(): {
-    generator?: string;
-    developerMode?: boolean;
-    scenario?: string;
-} | undefined {
-    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;
-}
+import { CHANGES_API_PATH, FlexChange, getFlexSettings } from './common';
 
 const connector = merge({}, ObjectStorageConnector, {
     layers: [Layer.VENDOR, Layer.CUSTOMER_BASE],
     storage: {
         _itemsStoredAsObjects: true,
-        setItem: function (_key: string, change: Change) {
+        setItem: function (_key: string, change: FlexChange) {
             const settings = getFlexSettings();
             if (settings) {
                 change.support ??= {};
                 change.support.generator = settings.generator;
             }
 
-            return fetch(path, {
+            return fetch(CHANGES_API_PATH, {
                 method: 'POST',
                 body: JSON.stringify(change, null, 2),
                 headers: {
@@ -44,7 +24,7 @@ const connector = merge({}, ObjectStorageConnector, {
             });
         },
         removeItem: function (key: string) {
-            return fetch(path, {
+            return fetch(CHANGES_API_PATH, {
                 method: 'DELETE',
                 body: JSON.stringify({ fileName: key }),
                 headers: {
@@ -59,7 +39,7 @@ const connector = merge({}, ObjectStorageConnector, {
             // not implemented
         },
         getItems: async function () {
-            const response = await fetch(path, {
+            const response = await fetch(CHANGES_API_PATH, {
                 method: 'GET',
                 headers: {
                     'content-type': 'application/json'

package/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?.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

@@ -0,0 +1,26 @@
+import { FlexSettings } from 'sap/ui/rta/RuntimeAuthoring';
+
+export interface FlexChange {
+    [key: string]: string | object | undefined;
+    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;
+    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;
+}

package/dist/client/flp/enableFakeConnector.js

@@ -0,0 +1,79 @@
+"use strict";
+
+sap.ui.define(["sap/ui/fl/LrepConnector", "sap/ui/fl/FakeLrepConnector", "./common"], function (LrepConnector, FakeLrepConnector, ___common) {
+  "use strict";
+
+  const CHANGES_API_PATH = ___common["CHANGES_API_PATH"];
+  const getFlexSettings = ___common["getFlexSettings"];
+  /**
+   * Processes an array of FlexChange objects.
+   * It updates each change object with settings and sends them to a API endpoint.
+   *
+   * @param {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(changes.map(change => {
+      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'
+        }
+      });
+    }));
+  }
+
+  /**
+   * 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() {
+    const lrep = new LrepConnector();
+    const response = await fetch(CHANGES_API_PATH, {
+      method: 'GET',
+      headers: {
+        'content-type': 'application/json'
+      }
+    });
+    const changes = await response.json();
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    return LrepConnector.prototype.loadChanges.apply(lrep, args).then(res => {
+      const flexChanges = Object.values(changes);
+      res.changes.changes = flexChanges;
+      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 a 'ui.version' property,
+   * and global jQuery object with 'extend' method.
+   *
+   * @returns {void}
+   */
+  var __exports = function () {
+    jQuery.extend(FakeLrepConnector.prototype, {
+      create,
+      loadChanges,
+      loadSettings: () => Promise.resolve()
+    });
+    FakeLrepConnector.enableFakeConnector();
+  };
+  __exports.create = create;
+  __exports.loadChanges = loadChanges;
+  return __exports;
+});
+//# sourceMappingURL=enableFakeConnector.js.map

package/dist/client/flp/enableFakeConnector.ts

@@ -0,0 +1,93 @@
+import LrepConnector from 'sap/ui/fl/LrepConnector';
+import FakeLrepConnector from 'sap/ui/fl/FakeLrepConnector';
+
+import { CHANGES_API_PATH, FlexChange, getFlexSettings } from './common';
+
+interface FetchedChanges {
+    [key: string]: FlexChange;
+}
+
+interface LoadChangesResult {
+    changes: {
+        loadModules: boolean;
+        changes: FlexChange[];
+        settings: {
+            [key: string]: string | boolean | undefined;
+        };
+    };
+    componentClassName: string;
+    etag: string;
+    loadModules: boolean;
+    messagebundle: string | undefined;
+}
+
+/**
+ * Processes an array of FlexChange objects.
+ * It updates each change object with settings and sends them to a API endpoint.
+ *
+ * @param {FlexChange[]} changes - Array of FlexChange objects to be processed.
+ * @returns {Promise<void>} A promise that resolves when all changes are processed.
+ */
+export async function create(changes: FlexChange[]): Promise<void> {
+    const settings = getFlexSettings();
+    await Promise.all(
+        changes.map((change) => {
+            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'
+                }
+            });
+        })
+    );
+}
+
+/**
+ * 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.
+ */
+export async function loadChanges(...args: []): Promise<LoadChangesResult> {
+    const lrep = new LrepConnector();
+
+    const response = await fetch(CHANGES_API_PATH, {
+        method: 'GET',
+        headers: {
+            'content-type': 'application/json'
+        }
+    });
+    const changes = (await response.json()) as FetchedChanges;
+
+    return LrepConnector.prototype.loadChanges.apply(lrep, args).then((res: LoadChangesResult) => {
+        const flexChanges = Object.values(changes);
+        res.changes.changes = flexChanges;
+        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 a 'ui.version' property,
+ * and global jQuery object with 'extend' method.
+ *
+ * @returns {void}
+ */
+export default function (): void {
+    jQuery.extend(FakeLrepConnector.prototype, {
+        create,
+        loadChanges,
+        loadSettings: () => Promise.resolve()
+    });
+
+    FakeLrepConnector.enableFakeConnector();
+}