@sap-ux/preview-middleware 0.1.0 → 0.2.0

package/README.md

@@ -8,6 +8,8 @@ The `@sap-ux/preview-middleware` is a [Custom UI5 Server Middleware](https://sap
 | `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 |
 
 ### `flp.apps`
@@ -20,6 +22,14 @@ Array of additional application configurations:
 | `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 |
+
 ## 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`).
 Example: [./test/fixtures/simple-app/ui5.yaml](./test/fixtures/simple-app/ui5.yaml) 
@@ -59,3 +69,17 @@ server:
         - local: ../local-folder
           target: /apps/other-app
 ```
+
+### Adaptation Project
+If you want to use the middleware in an adaption project, the additional `adp` object needs to be configured. This example would preview a local adaptation project merged with its reference application from the target system at `http://sap.example` and it will ignore certification validation errors.
+```Yaml
+server:
+  customMiddleware:
+  - name: preview-middleware
+    afterMiddleware: compression
+    configuration:
+      adp: 
+        target: 
+          url: http://sap.example
+        ignoreCertErrors: true
+```

package/dist/base/flp.d.ts

@@ -38,7 +38,7 @@ export declare class FlpSandbox {
     private readonly utils;
     private readonly logger;
     protected templateConfig: TemplateConfig;
-    protected readonly config: FlpConfig;
+    readonly config: FlpConfig;
     readonly router: any;
     /**
      * Constructor setting defaults and keeping reference to workspace resources.
@@ -53,8 +53,10 @@ export declare class FlpSandbox {
      * Initialize the FLP sandbox router.
      *
      * @param manifest application manifest
+     * @param componentId optional componentId e.g. for adaptation projects
+     * @param resources optional additional resource mappings
      */
-    init(manifest: Manifest): Promise<void>;
+    init(manifest: Manifest, componentId?: string, resources?: Record<string, string>): Promise<void>;
     /**
      * Try finding the locate-reuse-libs script.
      *

package/dist/base/flp.js

@@ -52,9 +52,11 @@ class FlpSandbox {
      * Initialize the FLP sandbox router.
      *
      * @param manifest application manifest
+     * @param componentId optional componentId e.g. for adaptation projects
+     * @param resources optional additional resource mappings
      */
-    init(manifest) {
-        var _a, _b, _c, _d, _e;
+    init(manifest, componentId, resources = {}) {
+        var _a, _b, _c, _d, _e, _f;
         return __awaiter(this, void 0, void 0, function* () {
             const flex = this.createFlexHandler();
             const supportedThemes = (_b = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.supportedThemes) !== null && _b !== void 0 ? _b : [DEFAULT_THEME];
@@ -64,12 +66,13 @@ class FlpSandbox {
                     libs: Object.keys((_e = (_d = (_c = manifest['sap.ui5']) === null || _c === void 0 ? void 0 : _c.dependencies) === null || _d === void 0 ? void 0 : _d.libs) !== null && _e !== void 0 ? _e : {}).join(','),
                     theme: supportedThemes.includes(DEFAULT_THEME) ? DEFAULT_THEME : supportedThemes[0],
                     flex,
-                    resources: {}
+                    resources: Object.assign({}, resources)
                 },
                 locateReuseLibsScript: yield this.findLocateReuseLibsScript()
             };
             this.addApp(manifest, {
-                target: '/',
+                componentId,
+                target: (_f = resources[componentId !== null && componentId !== void 0 ? componentId : manifest['sap.app'].id]) !== null && _f !== void 0 ? _f : '/',
                 local: '.',
                 intent: {
                     object: 'app',
@@ -80,11 +83,12 @@ class FlpSandbox {
             this.router.get(this.config.path, (req, res) => {
                 var _a, _b;
                 const config = Object.assign({}, this.templateConfig);
-                if (req.query['fiori-tools-rta-mode']) {
+                const fioriToolsRtaMode = req.query['fiori-tools-rta-mode'];
+                if (fioriToolsRtaMode) {
                     if ((_a = this.config.rta) === null || _a === void 0 ? void 0 : _a.layer) {
                         config.flex = {
                             layer: (_b = this.config.rta) === null || _b === void 0 ? void 0 : _b.layer,
-                            developerMode: false
+                            developerMode: fioriToolsRtaMode === 'forAdaptation'
                         };
                     }
                     else {
@@ -195,7 +199,7 @@ class FlpSandbox {
      * @param app configuration for the preview
      */
     addApp(manifest, app) {
-        var _a, _b, _c, _d, _e;
+        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, ''),
@@ -205,7 +209,7 @@ class FlpSandbox {
         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=${id}`,
+            additionalInformation: `SAPUI5.Component=${(_f = app.componentId) !== null && _f !== void 0 ? _f : id}`,
             applicationType: 'URL',
             url: app.target
         };

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+import type { AdpPreviewConfig } from '@sap-ux/adp-tooling';
 import type { UI5FlexLayer } from '@sap-ux/project-access';
 /**
  * Configuration for additional applications
@@ -5,6 +6,10 @@ import type { UI5FlexLayer } from '@sap-ux/project-access';
 export interface App {
     target: string;
     local: string;
+    /**
+     * Optional component id if it differs from the manifest (e.g. for adaptation projects)
+     */
+    componentId?: string;
     intent?: {
         object: string;
         action: string;
@@ -25,6 +30,7 @@ export interface FlpConfig {
  */
 export interface Config {
     flp?: Partial<FlpConfig>;
+    adp?: AdpPreviewConfig;
     debug?: boolean;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/ui5/middleware.js

@@ -11,6 +11,30 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const logger_1 = require("@sap-ux/logger");
 const flp_1 = require("../base/flp");
+const adp_tooling_1 = require("@sap-ux/adp-tooling");
+/**
+ * Initialize the preview for an adaptation project.
+ *
+ * @param rootProject reference to the project
+ * @param config configuration from the ui5.yaml
+ * @param flp FlpSandbox instance
+ * @param logger logger instance
+ */
+function initAdp(rootProject, config, flp, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const files = yield rootProject.byGlob('/manifest.appdescr_variant');
+        if (files.length === 1) {
+            const adp = new adp_tooling_1.AdpPreview(config, logger);
+            const layer = yield adp.init(JSON.parse(yield files[0].getString()), yield rootProject.byGlob('**/*.*'));
+            flp.config.rta = { layer };
+            yield flp.init(adp.descriptor.manifest, adp.descriptor.name, adp.resources);
+            flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));
+        }
+        else {
+            throw new Error('ADP configured but no manifest.appdescr_variant found.');
+        }
+    });
+}
 /**
  * Create the router that is to be exposed as UI5 middleware.
  *
@@ -29,12 +53,17 @@ function createRouter({ resources, options, middlewareUtil }, logger) {
         (_b = config.flp) !== null && _b !== void 0 ? _b : (config.flp = {});
         // configure the FLP sandbox based on information from the manifest
         const flp = new flp_1.FlpSandbox(config.flp, resources.rootProject, middlewareUtil, logger);
-        const files = yield resources.rootProject.byGlob('/manifest.json');
-        if (files.length === 1) {
-            yield flp.init(JSON.parse(yield files[0].getString()));
+        if (config.adp) {
+            yield initAdp(resources.rootProject, config.adp, flp, logger);
         }
         else {
-            throw new Error('No manifest.json found.');
+            const files = yield resources.rootProject.byGlob('/manifest.json');
+            if (files.length === 1) {
+                yield flp.init(JSON.parse(yield files[0].getString()));
+            }
+            else {
+                throw new Error('No manifest.json found.');
+            }
         }
         return flp.router;
     });

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.1.0",
+  "version": "0.2.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -23,15 +23,19 @@
   ],
   "dependencies": {
     "ejs": "3.1.7",
-    "@sap-ux/logger": "0.3.7"
+    "@sap-ux/logger": "0.3.7",
+    "@sap-ux/adp-tooling": "0.1.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.0",
     "@types/express": "4.17.13",
+    "@types/prompts": "2.0.14",
     "@types/supertest": "2.0.12",
     "express": "4.18.2",
+    "nock": "13.2.1",
     "supertest": "6.3.2",
-    "@sap-ux/project-access": "1.10.0"
+    "@sap-ux/project-access": "1.10.1",
+    "@sap-ux/store": "0.3.12"
   },
   "peerDependencies": {
     "express": "4"