@sap-ux/preview-middleware 0.2.0 → 0.3.0

package/README.md

@@ -3,32 +3,35 @@
 The `@sap-ux/preview-middleware` is a [Custom UI5 Server Middleware](https://sap.github.io/ui5-tooling/pages/extensibility/CustomServerMiddleware) for previewing an application in a local Fiori launchpad . It can be used either with the `ui5 serve` or the `fiori run` commands.
 
 ## Configuration Options
-| Option       | Type  | Default Value | Description |
-| ------------ | ------| ------------- | ----------- |
-| `flp`        |           |                  |Optional configuration object for the local Fiori launchpad |
-| `flp.path`   | `string`  | `/test/flp.html` | The mount point of the local Fiori launchpad. |
-| `flp.apps`   | `array`   | `[]`          | Optional additional local apps that are available in local Fiori launchpad |
-| `adp.target` |           |               | Required configuration for adaptation projects defining the connected backend
-| `adp.ignoreCertErrors` |  `boolean`  | `false`              | Optional setting to ignore certification validation errors when working with e.g. development systems with self signed certificates |
-| `debug`      | `boolean` | false         | Enables debug output |
+| Option                 | Type      | Default Value    | Description                                                                                                                         |
+| ---------------------- | --------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `flp`                  |           |                  | Optional configuration object for the local Fiori launchpad                                                                         |
+| `flp.path`             | `string`  | `/test/flp.html` | The mount point of the local Fiori launchpad.                                                                                       |
+| `flp.intent`           |           |                  | Optional intent to be used for the application                                                                                      |
+| `flp.intent.object`    | `string`  | `app`            | Optional intent object                                                                                                              |
+| `flp.intent.action`    | `string`  | `preview`        | Optional intent action                                                                                                              |
+| `flp.apps`             | `array`   | `[]`             | Optional additional local apps that are available in local Fiori launchpad                                                          |
+| `adp.target`           |           |                  | Required configuration for adaptation projects defining the connected backend                                                       |
+| `adp.ignoreCertErrors` | `boolean` | `false`          | Optional setting to ignore certification validation errors when working with e.g. development systems with self signed certificates |
+| `debug`                | `boolean` | false            | Enables debug output                                                                                                                |
 
 ### `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`         | `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                                                                               |
 
 ### `adp.target`
-| Option        | Type | Description |
-| ------------- | ------------- | ----------- |
-| `url`         | `string` mandatory (local)  | Mandatory URL pointing to the backend system. *Not required if destination is provided and the proxy is running SAP Business Application Studio |
-| `destination` | `string` mandatory (if no url) | Required if the backend system is available as destination in SAP Business Application Studio. |
-| `client`      | `string` optional      | sap-client parameter |
-| `scp`         | `boolean` optional      | If set to true the proxy will execute the required OAuth routine for the ABAP environment on SAP BTP |
+| Option        | Type                           | Description                                                                                                                                     |
+| ------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| `url`         | `string` mandatory (local)     | Mandatory URL pointing to the backend system. *Not required if destination is provided and the proxy is running SAP Business Application Studio |
+| `destination` | `string` mandatory (if no url) | Required if the backend system is available as destination in SAP Business Application Studio.                                                  |
+| `client`      | `string` optional              | sap-client parameter                                                                                                                            |
+| `scp`         | `boolean` optional             | If set to true the proxy will execute the required OAuth routine for the ABAP environment on SAP BTP                                            |
 
 ## Usage
 The middleware can be used without configuration. However, since the middleware intercepts a few requests that might otherwise be handled by a different middleware, it is strongly recommended to run other file serving middlewares after the `preview-middleware` e.g. `backend-proxy-middleware` and `ui5-proxy-middleware` (and the corresponding middlewares in the `@sap/ux-ui5-tooling`).
@@ -83,3 +86,18 @@ server:
           url: http://sap.example
         ignoreCertErrors: true
 ```
+### Programmatic Usage
+Alternatively you can use the underlying middleware fuction programmatically, e.g. for the case when you want to incorporate the `preview-middleware` functionality in your own middleware.
+
+```
+import { FlpSandbox } from '@sap-ux/preview-middleware';
+const flp = new FlpSandbox(flpConfig, rootProject, middlewareUtil, logger);
+const files = await resources.rootProject.byGlob('/manifest.json');
+flp.init(JSON.parse(await files[0].getString()));
+
+return flp.router
+```
+- `flpConfig` - the FLP configuration
+- `rootProject` - [Reader](https://sap.github.io/ui5-tooling/stable/api/@ui5_fs_AbstractReader.html) to access 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.

package/dist/base/flp.js

@@ -23,6 +23,13 @@ const DEFAULT_THEME = 'sap_horizon';
  * Default path for mounting the local FLP.
  */
 const DEFAULT_PATH = '/test/flp.html';
+/**
+ * Default intent
+ */
+const DEFAULT_INTENT = {
+    object: 'app',
+    action: 'preview'
+};
 /**
  * Class handling preview of a sandbox FLP.
  */
@@ -36,13 +43,14 @@ class FlpSandbox {
      * @param logger logger instance
      */
     constructor(config, project, utils, logger) {
-        var _a, _b;
+        var _a, _b, _c;
         this.project = project;
         this.utils = utils;
         this.logger = logger;
         this.config = {
             path: (_a = config.path) !== null && _a !== void 0 ? _a : DEFAULT_PATH,
-            apps: (_b = config.apps) !== null && _b !== void 0 ? _b : [],
+            intent: (_b = config.intent) !== null && _b !== void 0 ? _b : DEFAULT_INTENT,
+            apps: (_c = config.apps) !== null && _c !== void 0 ? _c : [],
             rta: config.rta
         };
         logger.debug(`Config: ${JSON.stringify(this.config)}`);
@@ -74,10 +82,7 @@ class FlpSandbox {
                 componentId,
                 target: (_f = resources[componentId !== null && componentId !== void 0 ? componentId : manifest['sap.app'].id]) !== null && _f !== void 0 ? _f : '/',
                 local: '.',
-                intent: {
-                    object: 'app',
-                    action: 'preview'
-                }
+                intent: this.config.intent
             });
             // add route for the sandbox.html
             this.router.get(this.config.path, (req, res) => {

package/dist/base/index.d.ts

@@ -0,0 +1,2 @@
+export { FlpSandbox } from './flp';
+//# sourceMappingURL=index.d.ts.map

package/dist/base/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlpSandbox = void 0;
+var flp_1 = require("./flp");
+Object.defineProperty(exports, "FlpSandbox", { enumerable: true, get: function () { return flp_1.FlpSandbox; } });
+//# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './ui5/middleware';
+export { FlpSandbox } from './base';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,5 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FlpSandbox = void 0;
 __exportStar(require("./ui5/middleware"), exports);
+var base_1 = require("./base");
+Object.defineProperty(exports, "FlpSandbox", { enumerable: true, get: function () { return base_1.FlpSandbox; } });
 //# sourceMappingURL=index.js.map

package/dist/types/index.d.ts

@@ -1,5 +1,9 @@
 import type { AdpPreviewConfig } from '@sap-ux/adp-tooling';
 import type { UI5FlexLayer } from '@sap-ux/project-access';
+interface Intent {
+    object: string;
+    action: string;
+}
 /**
  * Configuration for additional applications
  */
@@ -10,16 +14,14 @@ export interface App {
      * Optional component id if it differs from the manifest (e.g. for adaptation projects)
      */
     componentId?: string;
-    intent?: {
-        object: string;
-        action: string;
-    };
+    intent?: Intent;
 }
 /**
  * FLP preview configuration.
  */
 export interface FlpConfig {
     path: string;
+    intent?: Intent;
     rta?: {
         layer?: UI5FlexLayer;
     };
@@ -33,4 +35,5 @@ export interface Config {
     adp?: AdpPreviewConfig;
     debug?: boolean;
 }
+export {};
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.2.0",
+  "version": "0.3.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -34,7 +34,7 @@
     "express": "4.18.2",
     "nock": "13.2.1",
     "supertest": "6.3.2",
-    "@sap-ux/project-access": "1.10.1",
+    "@sap-ux/project-access": "1.11.0",
     "@sap-ux/store": "0.3.12"
   },
   "peerDependencies": {