@sap-ux/preview-middleware 0.12.15 → 0.13.1

package/README.md

@@ -34,13 +34,13 @@ When this middleware is used together with the `reload-middleware`, then the ord
 
 ### `flp.apps`
 Array of additional application configurations:
-| Option          | Type     | Default Value  | Description                                                                                          |
-| --------------- | -------- | -------------- | ---------------------------------------------------------------------------------------------------- |
-| `target`        | `string` |                | Target path of the additional application                                                            |
-| `local`         | `string` |                | Local path to the folder containing the application                                                  |
-| `intent`        |          |                | Optional intent to be used for the application                                                       |
-| `intent.object` | `string` | `(calculated)` | Optional intent object, if it is not provided then it will be calculated based on the application id |
-| `intent.action` | `string` | `preview`      | Optional intent action                                                                               |
+| Option                   | Type     | Default Value  | Description                                                                                                   |
+| ------------------------ | -------- | -------------- | ------------------------------------------------------------------------------------------------------------- |
+| `target`                 | `string` |                | Target path of the additional application                                                                     |
+| `local` or `componentId` | `string` |                | Either a local path to a folder containing the application or the `componentId` of a remote app is required   |
+| `intent`                 |          |                | Optional intent to be used for the application                                                                |
+| `intent.object`          | `string` | `(calculated)` | Optional intent object, if it is not provided then it will be calculated based on the application id          |
+| `intent.action`          | `string` | `preview`      | Optional intent action                                                                                        |
 
 ### `adp.target`
 | Option        | Type                           | Description                                                                                                                                     |
@@ -93,7 +93,7 @@ server:
 
 ### Additional Applications
 If you want to test cross application navigation, then you can add additional applications into the local FLP.
-With this configuration, an application that is locally available in `../local-folder` will be available at `/apps/other-app` and will also be added as tile to the local FLP.
+With this configuration, an application that is locally available in `../local-folder` will be available at `/apps/other-app` and will also be added as tile to the local FLP as well as one of the UI5 sample apps will be bound to the intent `TheOther-preview`.
 ```Yaml
 server:
   customMiddleware:
@@ -101,8 +101,16 @@ server:
     afterMiddleware: compression
     configuration:
       apps:
-        - local: ../local-folder
-          target: /apps/other-app
+        - target: /apps/other-app
+          local: ../local-folder
+          intent: 
+            object: TheLocal
+            action: preview
+        - target: /test-resources/sap/ushell/demoapps/AppNavSample
+          componentId: sap.ushell.demo.AppNavSample
+          intent: 
+            object: TheOther
+            action: preview
 ```
 
 ### Runtime Adaptation Support

package/dist/base/flp.d.ts

@@ -134,7 +134,16 @@ export declare class FlpSandbox {
      * @param manifest manifest of the additional target app
      * @param app configuration for the preview
      */
-    addApp(manifest: Manifest, app: App): void;
+    addApp(manifest: Manifest, app: App): Promise<void>;
+    /**
+     * Get the i18n text of the given property.
+     *
+     * @param projectRoot absolute path to the project root
+     * @param propertyValue value of the property
+     * @returns i18n text of the property
+     * @private
+     */
+    private getI18nTextFromProperty;
     /**
      * Gets the UI5 libs dependencies from manifest.json.
      *

package/dist/base/flp.js

@@ -15,6 +15,7 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const express_1 = require("express");
 const flex_1 = require("./flex");
+const project_access_1 = require("@sap-ux/project-access");
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
 const test_1 = require("./test");
 const DEVELOPER_MODE_CONFIG = new Map([
@@ -143,7 +144,7 @@ class FlpSandbox {
                 },
                 locateReuseLibsScript: (_e = this.config.libs) !== null && _e !== void 0 ? _e : (yield this.hasLocateReuseLibsScript())
             };
-            this.addApp(manifest, {
+            yield this.addApp(manifest, {
                 componentId,
                 target: (_f = resources[componentId !== null && componentId !== void 0 ? componentId : id]) !== null && _f !== void 0 ? _f : this.templateConfig.basePath,
                 local: '.',
@@ -159,7 +160,7 @@ class FlpSandbox {
             if (this.test) {
                 this.addTestRoutes(this.test, id);
             }
-            this.addRoutesForAdditionalApps();
+            yield this.addRoutesForAdditionalApps();
             this.logger.info(`Initialized for app ${id}`);
             this.logger.debug(`Configured apps: ${JSON.stringify(this.templateConfig.apps)}`);
         });
@@ -268,14 +269,32 @@ class FlpSandbox {
      * Add additional routes for apps also to be shown in the local FLP.
      */
     addRoutesForAdditionalApps() {
-        for (const app of this.config.apps) {
-            if (app.local) {
-                const manifest = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(app.local, 'webapp/manifest.json'), 'utf-8'));
-                this.addApp(manifest, app);
-                this.router.use(app.target, (0, express_1.static)((0, path_1.join)(app.local, 'webapp')));
-                this.logger.info(`Serving additional application at ${app.target} from ${app.local}`);
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const app of this.config.apps) {
+                let manifest;
+                if (app.local) {
+                    manifest = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(app.local, 'webapp/manifest.json'), 'utf-8'));
+                    this.router.use(app.target, (0, express_1.static)((0, path_1.join)(app.local, 'webapp')));
+                    this.logger.info(`Serving additional application at ${app.target} from ${app.local}`);
+                }
+                else if (app.componentId) {
+                    manifest = {
+                        'sap.app': {
+                            id: app.componentId,
+                            title: app.intent ? `${app.intent.object}-${app.intent.action}` : app.componentId
+                        }
+                    };
+                }
+                if (manifest) {
+                    yield this.addApp(manifest, app);
+                    this.logger.info(`Adding additional intent: ${(_a = app.intent) === null || _a === void 0 ? void 0 : _a.object}-${(_b = app.intent) === null || _b === void 0 ? void 0 : _b.action}`);
+                }
+                else {
+                    this.logger.info(`Invalid application config for route ${app.target} because neither componentId nor local folder provided.`);
+                }
             }
-        }
+        });
     }
     /**
      * Retrieves the configuration settings for UI5 flexibility services.
@@ -400,21 +419,56 @@ class FlpSandbox {
      * @param app configuration for the preview
      */
     addApp(manifest, app) {
-        var _a, _b, _c, _d, _e, _f;
-        const id = manifest['sap.app'].id;
-        (_a = app.intent) !== null && _a !== void 0 ? _a : (app.intent = {
-            object: id.replace(/\./g, ''),
-            action: 'preview'
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        return __awaiter(this, void 0, void 0, function* () {
+            const id = manifest['sap.app'].id;
+            (_a = app.intent) !== null && _a !== void 0 ? _a : (app.intent = {
+                object: id.replace(/\./g, ''),
+                action: 'preview'
+            });
+            let title = (_b = manifest['sap.app'].title) !== null && _b !== void 0 ? _b : id;
+            let description = (_c = manifest['sap.app'].description) !== null && _c !== void 0 ? _c : '';
+            if (app.local) {
+                title = (_d = (yield this.getI18nTextFromProperty(app.local, manifest['sap.app'].title))) !== null && _d !== void 0 ? _d : id;
+                description = (_e = (yield this.getI18nTextFromProperty(app.local, manifest['sap.app'].description))) !== null && _e !== void 0 ? _e : '';
+            }
+            this.templateConfig.ui5.resources[id] = app.target;
+            this.templateConfig.apps[`${(_f = app.intent) === null || _f === void 0 ? void 0 : _f.object}-${(_g = app.intent) === null || _g === void 0 ? void 0 : _g.action}`] = {
+                title: title,
+                description: description,
+                additionalInformation: `SAPUI5.Component=${(_h = app.componentId) !== null && _h !== void 0 ? _h : id}`,
+                applicationType: 'URL',
+                url: app.target,
+                applicationDependencies: { manifest: true }
+            };
+        });
+    }
+    /**
+     * Get the i18n text of the given property.
+     *
+     * @param projectRoot absolute path to the project root
+     * @param propertyValue value of the property
+     * @returns i18n text of the property
+     * @private
+     */
+    getI18nTextFromProperty(projectRoot, propertyValue) {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            //i18n model format could be {{key}} or {i18n>key}
+            if (!propertyValue || propertyValue.search(/{{\w+}}|{i18n>\w+}/g) === -1) {
+                return propertyValue;
+            }
+            const propertyI18nKey = propertyValue.replace(/i18n>|[{}]/g, '');
+            const projectAccess = yield (0, project_access_1.createProjectAccess)(projectRoot);
+            try {
+                const bundle = (yield projectAccess.getApplication('').getI18nBundles())['sap.app'];
+                return (_d = (_c = (_b = (_a = bundle[propertyI18nKey]) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.value) === null || _c === void 0 ? void 0 : _c.value) !== null && _d !== void 0 ? _d : propertyI18nKey;
+            }
+            catch (e) {
+                this.logger.warn('Failed to load i18n properties bundle');
+            }
+            return propertyI18nKey;
         });
-        this.templateConfig.ui5.resources[id] = app.target;
-        this.templateConfig.apps[`${(_b = app.intent) === null || _b === void 0 ? void 0 : _b.object}-${(_c = app.intent) === null || _c === void 0 ? void 0 : _c.action}`] = {
-            title: (_d = manifest['sap.app'].title) !== null && _d !== void 0 ? _d : id,
-            description: (_e = manifest['sap.app'].description) !== null && _e !== void 0 ? _e : '',
-            additionalInformation: `SAPUI5.Component=${(_f = app.componentId) !== null && _f !== void 0 ? _f : id}`,
-            applicationType: 'URL',
-            url: app.target,
-            applicationDependencies: { manifest: true }
-        };
     }
     /**
      * Gets the UI5 libs dependencies from manifest.json.

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,56 +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
-     *
-     * @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;
+"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