@sap-ux/preview-middleware 0.16.143 → 0.16.144

package/README.md

@@ -182,6 +182,38 @@ flp.init(JSON.parse(await files[0].getString()));
 return flp.router
 ```
 - `flpConfig` - the middleware configuration
-- `rootProject` - [Reader](https://sap.github.io/ui5-tooling/stable/api/@ui5_fs_AbstractReader.html) to access resources of the root project
+- `rootProject` - [Reader](https://sap.github.io/ui5-tooling/stable/api/@ui5_fs_AbstractReader.html) to access the resources of the root project
 - `middlewareUtil` - [MiddlewareUtil](https://sap.github.io/ui5-tooling/v3/api/@ui5_server_middleware_MiddlewareUtil.html) of the UI5 server
-- `logger` - Logger instance for use in the middleware.
+- `logger` - Logger instance to be used in the middleware.
+
+
+## [Migration](#migration)
+If you have no custom modifications in the local Fiori Launchpad sandbox files (`webapp/test/flpSandbox.html` or `webapp/test/flpSandboxMockserver.html`), the conversion is finished.
+
+If you have custom modifications in the local Fiori Launchpad sandbox files, you need to migrate them into a custom .js or .ts file (depending on your setup) and integrate this file as a custom `init` script into the configuration options of the middleware.
+
+Sample:
+
+from custom modification in `flpSandbox.html`:
+```HTML
+<script type="text/javascript">
+    sap.ui.getCore().attachInit(function () {
+        console.log('my custom code');
+    });
+</script>
+```
+to custom `test/init.ts`:
+```ts 
+console.log('my custom code');
+```
+integrated via `ui5.yaml`:
+
+```YAML
+server:
+  customMiddleware:
+  - name: preview-middleware
+    afterMiddleware: compression
+    configuration:
+      flp:
+        init: /test/init # <-- path to your custom init script
+```

package/dist/base/config.d.ts

@@ -1,5 +1,5 @@
 import { ToolsLogger, type Logger } from '@sap-ux/logger';
-import type { App, FlpConfig, Intent, InternalTestConfig, MiddlewareConfig, TestConfig } from '../types';
+import type { App, DefaultFlpPath, DefaultIntent, FlpConfig, Intent, InternalTestConfig, MiddlewareConfig, TestConfig } from '../types';
 import { type Manifest, type UI5FlexLayer } from '@sap-ux/project-access';
 import { type Editor } from 'mem-fs-editor';
 import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
@@ -76,11 +76,11 @@ export declare const DEFAULT_THEME = "sap_horizon";
 /**
  * Default path for mounting the local FLP.
  */
-export declare const DEFAULT_PATH = "/test/flp.html";
+export declare const DEFAULT_PATH: DefaultFlpPath;
 /**
  * Default intent
  */
-export declare const DEFAULT_INTENT: Readonly<Intent>;
+export declare const DEFAULT_INTENT: Readonly<DefaultIntent>;
 /**
  * Default configuration for the FLP.
  *

package/dist/base/flp.js

@@ -221,6 +221,7 @@ class FlpSandbox {
                     params['sap-ui-xx-viewCache'] = 'false';
                     params['fiori-tools-rta-mode'] = 'true';
                     params['sap-ui-rta-skip-flex-validation'] = 'true';
+                    params['sap-ui-xx-condense-changes'] = 'true';
                     res.redirect(302, `${previewUrl}?${new URLSearchParams(params)}`);
                     return;
                 }

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

@@ -1,144 +1,144 @@
-"use strict";
-
-sap.ui.define(["../utils/error"], function (___utils_error) {
-  "use strict";
-
-  const getError = ___utils_error["getError"];
-  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 getError(e);
-    }
-  }
-
-  /**
-   * 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(["../utils/error"], function (___utils_error) {
+  "use strict";
+
+  const getError = ___utils_error["getError"];
+  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 getError(e);
+    }
+  }
+
+  /**
+   * 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,77 +1,77 @@
-"use strict";
-
-sap.ui.define(["sap/m/MessageToast", "sap/ui/rta/command/CommandFactory", "../utils/error"], function (MessageToast, CommandFactory, ___utils_error) {
-  "use strict";
-
-  const getError = ___utils_error["getError"];
-  /**
-   * 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 error = getError(e);
-        const msgToastErrorMsg = `Could not get command for '${commandName}'. ${error.message}`;
-        error.message = msgToastErrorMsg;
-        MessageToast.show(msgToastErrorMsg);
-        throw error;
-      }
-    }
-
-    /**
-     * Creates composite command without nested commands
-     *
-     * @param runtimeControl Managed object
-     */
-    async createCompositeCommand(runtimeControl) {
-      try {
-        return await CommandFactory.getCommandFor(runtimeControl, 'composite');
-      } catch (e) {
-        const error = getError(e);
-        const msgToastErrorMsg = `Could not get composite command'. ${error.message}`;
-        error.message = msgToastErrorMsg;
-        MessageToast.show(msgToastErrorMsg);
-        throw error;
-      }
-    }
-
-    /**
-     * 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) {
-        const error = getError(e);
-        MessageToast.show(error.message);
-        throw error;
-      }
-    }
-  }
-  return CommandExecutor;
+"use strict";
+
+sap.ui.define(["sap/m/MessageToast", "sap/ui/rta/command/CommandFactory", "../utils/error"], function (MessageToast, CommandFactory, ___utils_error) {
+  "use strict";
+
+  const getError = ___utils_error["getError"];
+  /**
+   * 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 error = getError(e);
+        const msgToastErrorMsg = `Could not get command for '${commandName}'. ${error.message}`;
+        error.message = msgToastErrorMsg;
+        MessageToast.show(msgToastErrorMsg);
+        throw error;
+      }
+    }
+
+    /**
+     * Creates composite command without nested commands
+     *
+     * @param runtimeControl Managed object
+     */
+    async createCompositeCommand(runtimeControl) {
+      try {
+        return await CommandFactory.getCommandFor(runtimeControl, 'composite');
+      } catch (e) {
+        const error = getError(e);
+        const msgToastErrorMsg = `Could not get composite command'. ${error.message}`;
+        error.message = msgToastErrorMsg;
+        MessageToast.show(msgToastErrorMsg);
+        throw error;
+      }
+    }
+
+    /**
+     * 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) {
+        const error = getError(e);
+        MessageToast.show(error.message);
+        throw error;
+      }
+    }
+  }
+  return CommandExecutor;
 });
 //# sourceMappingURL=command-executor.js.map

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