@sap-ux/preview-middleware 0.11.35 → 0.12.0

package/dist/base/flp.d.ts

@@ -20,6 +20,7 @@ export interface CustomConnector {
 export interface FlexConnector {
     connector: string;
     layers: string[];
+    url?: string;
 }
 /**
  * Internal structure used to fill the sandbox.html template
@@ -108,9 +109,14 @@ export declare class FlpSandbox {
      */
     private addRoutesForAdditionalApps;
     /**
-     * Create required routes for flex.
+     * Retrieves the configuration settings for UI5 flexibility services.
      *
-     * @returns template configuration for flex.
+     * @returns An array of flexibility service configurations, each specifying a connector
+     *          and its options, such as the layers it applies to and its service URL, if applicable.
+     */
+    private getFlexSettings;
+    /**
+     * Create required routes for flex.
      */
     private createFlexHandler;
     /**

package/dist/base/flp.js

@@ -120,7 +120,8 @@ class FlpSandbox {
         var _a, _b, _c, _d, _e, _f, _g;
         var _h;
         return __awaiter(this, void 0, void 0, function* () {
-            const flex = this.createFlexHandler();
+            this.createFlexHandler();
+            const flex = this.getFlexSettings();
             const supportedThemes = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.supportedThemes) !== null && _b !== void 0 ? _b : [DEFAULT_THEME];
             const ui5Theme = (_c = this.config.theme) !== null && _c !== void 0 ? _c : (supportedThemes.includes(DEFAULT_THEME) ? DEFAULT_THEME : supportedThemes[0]);
             this.templateConfig = {
@@ -271,12 +272,30 @@ class FlpSandbox {
         }
     }
     /**
-     * Create required routes for flex.
+     * Retrieves the configuration settings for UI5 flexibility services.
      *
-     * @returns template configuration for flex.
+     * @returns An array of flexibility service configurations, each specifying a connector
+     *          and its options, such as the layers it applies to and its service URL, if applicable.
+     */
+    getFlexSettings() {
+        const localConnectorPath = 'custom.connectors.WorkspaceConnector';
+        return [
+            { connector: 'LrepConnector', layers: [], url: '/sap/bc/lrep' },
+            {
+                applyConnector: localConnectorPath,
+                writeConnector: localConnectorPath,
+                custom: true
+            },
+            {
+                connector: 'LocalStorageConnector',
+                layers: ['CUSTOMER', 'USER']
+            }
+        ];
+    }
+    /**
+     * Create required routes for flex.
      */
     createFlexHandler() {
-        const workspaceConnectorPath = 'open/ux/preview/client/flp/WorkspaceConnector';
         const api = `${PREVIEW_URL.api}/changes`;
         this.router.use(api, (0, express_1.json)());
         this.router.get(api, ((_req, res) => __awaiter(this, void 0, void 0, function* () {
@@ -312,17 +331,6 @@ class FlpSandbox {
                 res.status(500).send(error.message);
             }
         })));
-        return [
-            {
-                applyConnector: workspaceConnectorPath,
-                writeConnector: workspaceConnectorPath,
-                custom: true
-            },
-            {
-                connector: 'LocalStorageConnector',
-                layers: ['CUSTOMER', 'USER']
-            }
-        ];
     }
     /**
      * Add an application to the local FLP preview.
@@ -344,9 +352,7 @@ class FlpSandbox {
             additionalInformation: `SAPUI5.Component=${(_f = app.componentId) !== null && _f !== void 0 ? _f : id}`,
             applicationType: 'URL',
             url: app.target,
-            applicationDependencies: {
-                manifest: true
-            }
+            applicationDependencies: { manifest: true }
         };
     }
     /**
@@ -424,7 +430,10 @@ function initAdp(rootProject, config, flp, util, logger) {
                     (_a = editor.pluginScript) !== null && _a !== void 0 ? _a : (editor.pluginScript = 'open/ux/preview/client/adp/init');
                 }
             }
-            yield flp.init(adp.descriptor.manifest, adp.descriptor.name, adp.resources);
+            const descriptor = adp.descriptor;
+            descriptor.asyncHints.requests = [];
+            const { name, manifest } = descriptor;
+            yield flp.init(manifest, name, adp.resources);
             flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));
             adp.addApis(flp.router);
         }

package/dist/client/adp/api-handler.js

@@ -1,143 +1,143 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  var ApiEndpoints = /*#__PURE__*/function (ApiEndpoints) {
-    ApiEndpoints["CHANGES"] = "/preview/api/changes";
-    ApiEndpoints["FRAGMENT"] = "/adp/api/fragment";
-    ApiEndpoints["CONTROLLER"] = "/adp/api/controller";
-    ApiEndpoints["CODE_EXT"] = "/adp/api/code_ext";
-    ApiEndpoints["MANIFEST_APP_DESCRIPTOR"] = "/manifest.appdescr_variant";
-    return ApiEndpoints;
-  }(ApiEndpoints || {});
-  var RequestMethod = /*#__PURE__*/function (RequestMethod) {
-    RequestMethod["GET"] = "GET";
-    RequestMethod["PUT"] = "PUT";
-    RequestMethod["POST"] = "POST";
-    RequestMethod["PATCH"] = "PATCH";
-    RequestMethod["DELETE"] = "DELETE";
-    return RequestMethod;
-  }(RequestMethod || {});
-  /**
-   * Requests a given endpoint
-   *
-   * @param endpoint API Endpoint
-   * @param method RequestMethod
-   * @param data Data to be sent to the server
-   * @returns Data from the server request
-   */
-  async function request(endpoint, method, data) {
-    const config = {
-      method,
-      body: JSON.stringify(data),
-      headers: {
-        'content-type': 'application/json'
-      }
-    };
-    try {
-      const response = await fetch(endpoint, config);
-      if (!response.ok) {
-        const errorData = await response.json();
-        const message = errorData?.message ?? '';
-        throw new Error(`Request failed, status: ${response.status}. ${message}`.trim());
-      }
-      switch (method) {
-        case RequestMethod.GET:
-          return response.json();
-        case RequestMethod.POST:
-          /**
-           * Since POST usually creates something
-           * and returns nothing (or a message) we just parse the text from res.send(msg)
-           */
-          return response.text();
-        default:
-          return response.json();
-      }
-    } catch (e) {
-      throw new Error(e.message);
-    }
-  }
-
-  /**
-   * Retrieves all XML fragments from the project's workspace
-   *
-   * @returns Generic Promise<T>
-   */
-  async function getFragments() {
-    return request(ApiEndpoints.FRAGMENT, RequestMethod.GET);
-  }
-
-  /**
-   * Writes an XML fragment to the project's workspace
-   *
-   * @param data Data to be send to the server
-   * @returns Generic Promise<T>
-   */
-  async function writeFragment(data) {
-    return request(ApiEndpoints.FRAGMENT, RequestMethod.POST, data);
-  }
-
-  /**
-   * Retrieves manifest.appdescr_variant from the project's workspace
-   *
-   * @returns Generic Promise<T>
-   */
-  async function getManifestAppdescr() {
-    return request(ApiEndpoints.MANIFEST_APP_DESCRIPTOR, RequestMethod.GET);
-  }
-
-  /**
-   * Retrieves all controller extensions from the project's workspace
-   *
-   * @returns Generic Promise<T>
-   */
-  async function readControllers() {
-    return request(ApiEndpoints.CONTROLLER, RequestMethod.GET);
-  }
-
-  /**
-   * Writes a Controller to the project's workspace
-   *
-   * @param data Data to be send to the server
-   * @returns Generic Promise<T>
-   */
-  async function writeController(data) {
-    return request(ApiEndpoints.CONTROLLER, RequestMethod.POST, data);
-  }
-
-  /**
-   * Checks for existing controller in the project's workspace
-   *
-   * @param controllerName Name of the controller
-   * @returns {CodeExtResponse} Returns path to existing controller if found
-   */
-  async function getExistingController(controllerName) {
-    return request(`${ApiEndpoints.CODE_EXT}/${controllerName}`, RequestMethod.GET);
-  }
-
-  /**
-   * Writes a change object to the project's workspace
-   *
-   * @param data Data to be send to the server
-   * @returns Generic Promise<T>
-   */
-  async function writeChange(data) {
-    return request(ApiEndpoints.CHANGES, RequestMethod.POST, data);
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.ApiEndpoints = ApiEndpoints;
-  __exports.RequestMethod = RequestMethod;
-  __exports.request = request;
-  __exports.getFragments = getFragments;
-  __exports.writeFragment = writeFragment;
-  __exports.getManifestAppdescr = getManifestAppdescr;
-  __exports.readControllers = readControllers;
-  __exports.writeController = writeController;
-  __exports.getExistingController = getExistingController;
-  __exports.writeChange = writeChange;
-  return __exports;
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  var ApiEndpoints = /*#__PURE__*/function (ApiEndpoints) {
+    ApiEndpoints["CHANGES"] = "/preview/api/changes";
+    ApiEndpoints["FRAGMENT"] = "/adp/api/fragment";
+    ApiEndpoints["CONTROLLER"] = "/adp/api/controller";
+    ApiEndpoints["CODE_EXT"] = "/adp/api/code_ext";
+    ApiEndpoints["MANIFEST_APP_DESCRIPTOR"] = "/manifest.appdescr_variant";
+    return ApiEndpoints;
+  }(ApiEndpoints || {});
+  var RequestMethod = /*#__PURE__*/function (RequestMethod) {
+    RequestMethod["GET"] = "GET";
+    RequestMethod["PUT"] = "PUT";
+    RequestMethod["POST"] = "POST";
+    RequestMethod["PATCH"] = "PATCH";
+    RequestMethod["DELETE"] = "DELETE";
+    return RequestMethod;
+  }(RequestMethod || {});
+  /**
+   * Requests a given endpoint
+   *
+   * @param endpoint API Endpoint
+   * @param method RequestMethod
+   * @param data Data to be sent to the server
+   * @returns Data from the server request
+   */
+  async function request(endpoint, method, data) {
+    const config = {
+      method,
+      body: JSON.stringify(data),
+      headers: {
+        'content-type': 'application/json'
+      }
+    };
+    try {
+      const response = await fetch(endpoint, config);
+      if (!response.ok) {
+        const errorData = await response.json();
+        const message = errorData?.message ?? '';
+        throw new Error(`Request failed, status: ${response.status}. ${message}`.trim());
+      }
+      switch (method) {
+        case RequestMethod.GET:
+          return response.json();
+        case RequestMethod.POST:
+          /**
+           * Since POST usually creates something
+           * and returns nothing (or a message) we just parse the text from res.send(msg)
+           */
+          return response.text();
+        default:
+          return response.json();
+      }
+    } catch (e) {
+      throw new Error(e.message);
+    }
+  }
+
+  /**
+   * Retrieves all XML fragments from the project's workspace
+   *
+   * @returns Generic Promise<T>
+   */
+  async function getFragments() {
+    return request(ApiEndpoints.FRAGMENT, RequestMethod.GET);
+  }
+
+  /**
+   * Writes an XML fragment to the project's workspace
+   *
+   * @param data Data to be send to the server
+   * @returns Generic Promise<T>
+   */
+  async function writeFragment(data) {
+    return request(ApiEndpoints.FRAGMENT, RequestMethod.POST, data);
+  }
+
+  /**
+   * Retrieves manifest.appdescr_variant from the project's workspace
+   *
+   * @returns Generic Promise<T>
+   */
+  async function getManifestAppdescr() {
+    return request(ApiEndpoints.MANIFEST_APP_DESCRIPTOR, RequestMethod.GET);
+  }
+
+  /**
+   * Retrieves all controller extensions from the project's workspace
+   *
+   * @returns Generic Promise<T>
+   */
+  async function readControllers() {
+    return request(ApiEndpoints.CONTROLLER, RequestMethod.GET);
+  }
+
+  /**
+   * Writes a Controller to the project's workspace
+   *
+   * @param data Data to be send to the server
+   * @returns Generic Promise<T>
+   */
+  async function writeController(data) {
+    return request(ApiEndpoints.CONTROLLER, RequestMethod.POST, data);
+  }
+
+  /**
+   * Checks for existing controller in the project's workspace
+   *
+   * @param controllerName Name of the controller
+   * @returns {CodeExtResponse} Returns path to existing controller if found
+   */
+  async function getExistingController(controllerName) {
+    return request(`${ApiEndpoints.CODE_EXT}/${controllerName}`, RequestMethod.GET);
+  }
+
+  /**
+   * Writes a change object to the project's workspace
+   *
+   * @param data Data to be send to the server
+   * @returns Generic Promise<T>
+   */
+  async function writeChange(data) {
+    return request(ApiEndpoints.CHANGES, RequestMethod.POST, data);
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.ApiEndpoints = ApiEndpoints;
+  __exports.RequestMethod = RequestMethod;
+  __exports.request = request;
+  __exports.getFragments = getFragments;
+  __exports.writeFragment = writeFragment;
+  __exports.getManifestAppdescr = getManifestAppdescr;
+  __exports.readControllers = readControllers;
+  __exports.writeController = writeController;
+  __exports.getExistingController = getExistingController;
+  __exports.writeChange = writeChange;
+  return __exports;
 });
 //# sourceMappingURL=api-handler.js.map

package/dist/client/adp/command-executor.js

@@ -1,43 +1,56 @@
-"use strict";
-
-sap.ui.define(["sap/m/MessageToast", "sap/ui/rta/command/CommandFactory"], function (MessageToast, CommandFactory) {
-  "use strict";
-
-  /**
-   * Class responsible for handling rta calls
-   */
-  class CommandExecutor {
-    /**
-     *
-     * @param rta Runtime Authoring
-     */
-    constructor(rta) {
-      this.rta = rta;
-    }
-
-    /**
-     * Generates command based on given values and executes it
-     *
-     * @param runtimeControl Managed object
-     * @param commandName Command name
-     * @param modifiedValue Modified value/s
-     * @param designMetadata Design time metadata
-     * @param flexSettings Additional flex settings
-     */
-    async generateAndExecuteCommand(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings) {
-      try {
-        const command = await CommandFactory.getCommandFor(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings);
-
-        /**
-         * The change will have pending state and will only be saved to the workspace when the user clicks save icon
-         */
-        await this.rta.getCommandStack().pushAndExecute(command);
-      } catch (e) {
-        MessageToast.show(e.message);
-        throw new Error(e.message);
-      }
-    }
-  }
-  return CommandExecutor;
+"use strict";
+
+sap.ui.define(["sap/m/MessageToast", "sap/ui/rta/command/CommandFactory"], function (MessageToast, CommandFactory) {
+  "use strict";
+
+  /**
+   * Class responsible for handling rta calls
+   */
+  class CommandExecutor {
+    /**
+     *
+     * @param rta Runtime Authoring
+     */
+    constructor(rta) {
+      this.rta = rta;
+    }
+
+    /**
+     * Generates command based on given values
+     *
+     * @param runtimeControl Managed object
+     * @param commandName Command name
+     * @param modifiedValue Modified value/s
+     * @param designMetadata Design time metadata
+     * @param flexSettings Additional flex settings
+     */
+    async getCommand(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings) {
+      try {
+        return await CommandFactory.getCommandFor(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings);
+      } catch (e) {
+        const errorMsg = `Could not get command for '${commandName}'. ${e.message}`;
+        MessageToast.show(errorMsg);
+        throw new Error(errorMsg);
+      }
+    }
+
+    /**
+     * Pushed and executes the provided command
+     *
+     * @param command Command
+     */
+    async pushAndExecuteCommand(command) {
+      try {
+        /**
+         * The change will have pending state and will only be saved to the workspace when the user clicks save icon
+         */
+        await this.rta.getCommandStack().pushAndExecute(command);
+      } catch (e) {
+        MessageToast.show(e.message);
+        throw new Error(e.message);
+      }
+    }
+  }
+  return CommandExecutor;
 });
 //# sourceMappingURL=command-executor.js.map

package/dist/client/adp/command-executor.ts

@@ -4,6 +4,7 @@ import CommandFactory from 'sap/ui/rta/command/CommandFactory';
 import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 import type { FlexSettings } from 'sap/ui/rta/RuntimeAuthoring';
 import type DesignTimeMetadata from 'sap/ui/dt/DesignTimeMetadata';
+import type FlexCommand from 'sap/ui/rta/command/FlexCommand';
 
 type CommandNames = 'addXML';
 
@@ -18,7 +19,7 @@ export default class CommandExecutor {
     constructor(private readonly rta: RuntimeAuthoring) {}
 
     /**
-     * Generates command based on given values and executes it
+     * Generates command based on given values
      *
      * @param runtimeControl Managed object
      * @param commandName Command name
@@ -26,22 +27,35 @@ export default class CommandExecutor {
      * @param designMetadata Design time metadata
      * @param flexSettings Additional flex settings
      */
-    public async generateAndExecuteCommand(
+    public async getCommand(
         runtimeControl: ManagedObject,
         commandName: CommandNames,
         modifiedValue: object,
         designMetadata: DesignTimeMetadata,
         flexSettings: FlexSettings
-    ): Promise<void> {
+    ): Promise<FlexCommand> {
         try {
-            const command = await CommandFactory.getCommandFor(
+            return await CommandFactory.getCommandFor(
                 runtimeControl,
                 commandName,
                 modifiedValue,
                 designMetadata,
                 flexSettings
             );
+        } catch (e) {
+            const errorMsg = `Could not get command for '${commandName}'. ${e.message}`;
+            MessageToast.show(errorMsg);
+            throw new Error(errorMsg);
+        }
+    }
 
+    /**
+     * Pushed and executes the provided command
+     *
+     * @param command Command
+     */
+    public async pushAndExecuteCommand(command: FlexCommand): Promise<void> {
+        try {
             /**
              * The change will have pending state and will only be saved to the workspace when the user clicks save icon
              */

package/dist/client/adp/control-utils.js

@@ -1,46 +1,46 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  /**
-   * Handles calling control specific functions for retrieving control data
-   */
-  class ControlUtils {
-    /**
-     * Returns ManagedObject runtime control
-     *
-     * @param overlayControl Overlay
-     * @returns {ManagedObject} Managed Object instance
-     */
-    static getRuntimeControl(overlayControl) {
-      let runtimeControl;
-      if (overlayControl.getElementInstance) {
-        runtimeControl = overlayControl.getElementInstance();
-      } else {
-        runtimeControl = overlayControl.getElement();
-      }
-      return runtimeControl;
-    }
-
-    /**
-     * Returns control aggregation names in an array
-     *
-     * @param control Managed Object runtime control
-     * @param name Aggregation name
-     * @returns Array of control aggregations
-     */
-    static getControlAggregationByName(control, name) {
-      let result = [];
-      const aggregation = (control ? control.getMetadata().getAllAggregations() : {})[name];
-      if (aggregation) {
-        // This executes a _sGetter function that can vary from control to control (_sGetter can be: getContent, getItems, etc)
-        const names = aggregation._sGetter && control[aggregation._sGetter]() || [];
-        result = Array.isArray(names) ? names : [names];
-      }
-      return result;
-    }
-  }
-  return ControlUtils;
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Handles calling control specific functions for retrieving control data
+   */
+  class ControlUtils {
+    /**
+     * Returns ManagedObject runtime control
+     *
+     * @param overlayControl Overlay
+     * @returns {ManagedObject} Managed Object instance
+     */
+    static getRuntimeControl(overlayControl) {
+      let runtimeControl;
+      if (overlayControl.getElementInstance) {
+        runtimeControl = overlayControl.getElementInstance();
+      } else {
+        runtimeControl = overlayControl.getElement();
+      }
+      return runtimeControl;
+    }
+
+    /**
+     * Returns control aggregation names in an array
+     *
+     * @param control Managed Object runtime control
+     * @param name Aggregation name
+     * @returns Array of control aggregations
+     */
+    static getControlAggregationByName(control, name) {
+      let result = [];
+      const aggregation = (control ? control.getMetadata().getAllAggregations() : {})[name];
+      if (aggregation) {
+        // This executes a _sGetter function that can vary from control to control (_sGetter can be: getContent, getItems, etc)
+        const names = aggregation._sGetter && control[aggregation._sGetter]() || [];
+        result = Array.isArray(names) ? names : [names];
+      }
+      return result;
+    }
+  }
+  return ControlUtils;
 });
 //# sourceMappingURL=control-utils.js.map