@sap-ux/preview-middleware 0.5.4 → 0.5.6

package/README.md

@@ -13,13 +13,12 @@ It hosts a local Fiori launchpad based on your configuration as well as offers a
 | `flp.intent.action`    | `string`  | `preview`        | Optional intent action                                                                                                              |
 | `flp.apps`             | `array`   | `undefined`      | Optional additional local apps that are available in local Fiori launchpad                                                          |
 | `flp.libs`             | `boolean` | `undefined`      | Optional flag to add a generic script fetching the paths of used libraries not available in UI5. To disable set it to `false`, if not set, then the project is checked for a `load-reuse-libs` script and if available the libraries are fetched as well. |
+| `flp.theme`             | `string` | `undefined`      | Optional flag for setting the UI5 Theme. |
 | `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 |
 | `rta`                  |           |                  | Optional configuration allowing to add mount points for runtime adaptation                                                          |
 | `rta.layer`            | `string`  | `(calculated)`   | Optional property for defining the runtime adaptation layer for changes (default is `CUSTOMER_BASE` or read from the project for adaptation projects) |
 | `rta.editors`          | `array`   | `undefined`      | Optional list of mount points for editing                                                                                           |
-
-
 | `debug`                | `boolean` | `false`          | Enables debug output                                                                                                                |
 
 ### `flp.apps`
@@ -44,7 +43,7 @@ Array of additional application configurations:
 | Option          | Type               | Description                                                                                    |
 | --------------- | -------------------| -----------------------------------------------------------------------------------------------|
 | `path`          | `string` mandatory | The mount point to be used for the editor.                                                     |
-| `developerMode` | `boolean` optional | Enables/disables the runtime adaptation developer mode (only supported for adaptation projects |
+| `developerMode` | `boolean` optional | Enables/disables the runtime adaptation developer mode (only supported for adaptation projects) |
 
 
 ## Usage
@@ -52,7 +51,7 @@ The middleware can be used without configuration. However, since the middleware
 Example: [./test/fixtures/simple-app/ui5.yaml](./test/fixtures/simple-app/ui5.yaml) 
 
 ### Minimal Configuration
-With no configuration provided, the app will be local FLP will be available at `/test/flp.html` and the log level is `info`.
+With no configuration provided, the local FLP will be available at `/test/flp.html` and the log level is `info`.
 ```Yaml
 server:
   customMiddleware:
@@ -61,7 +60,7 @@ server:
 ```
 
 ### Different Path and Debugging enabled
-With this configuration, the app will be local FLP will be available at `/preview.html` and the log level is `debug`.
+With this configuration, the local FLP will be available at `/test/myFLP.html` and the log level is `debug`.
 ```Yaml
 server:
   customMiddleware:
@@ -69,7 +68,7 @@ server:
     afterMiddleware: compression
     configuration:
       flp: 
-        path: /preview.html
+        path: /test/myFLP.html
       debug: true
 ```
 
@@ -98,7 +97,7 @@ server:
       rta:
         layer: CUSTOMER_BASE
         editors:
-          - path: /local/variant-editor.html
+          - path: /test/variant-editor.html
 ```
 
 
@@ -116,7 +115,7 @@ server:
         ignoreCertErrors: true
       rta:
         editors:
-          - path: /adp/editor.html
+          - path: /test/adaptation-editor.html
             developerMode: true
 ```
 

package/dist/base/flp.js

@@ -54,7 +54,7 @@ class FlpSandbox {
      * @param logger logger instance
      */
     constructor(config, project, utils, logger) {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         this.project = project;
         this.utils = utils;
         this.logger = logger;
@@ -62,7 +62,8 @@ class FlpSandbox {
             path: (_b = (_a = config.flp) === null || _a === void 0 ? void 0 : _a.path) !== null && _b !== void 0 ? _b : DEFAULT_PATH,
             intent: (_d = (_c = config.flp) === null || _c === void 0 ? void 0 : _c.intent) !== null && _d !== void 0 ? _d : DEFAULT_INTENT,
             apps: (_f = (_e = config.flp) === null || _e === void 0 ? void 0 : _e.apps) !== null && _f !== void 0 ? _f : [],
-            libs: (_g = config.flp) === null || _g === void 0 ? void 0 : _g.libs
+            libs: (_g = config.flp) === null || _g === void 0 ? void 0 : _g.libs,
+            theme: (_h = config.flp) === null || _h === void 0 ? void 0 : _h.theme
         };
         if (!this.config.path.startsWith('/')) {
             this.config.path = `/${this.config.path}`;
@@ -79,31 +80,32 @@ class FlpSandbox {
      * @param resources optional additional resource mappings
      */
     init(manifest, componentId, resources = {}) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-        var _k;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        var _l;
         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];
+            const ui5Theme = (_c = this.config.theme) !== null && _c !== void 0 ? _c : (supportedThemes.includes(DEFAULT_THEME) ? DEFAULT_THEME : supportedThemes[0]);
             this.templateConfig = {
-                basePath: (_c = (0, path_1.relative)((0, path_1.dirname)(this.config.path), '/')) !== null && _c !== void 0 ? _c : '.',
+                basePath: (_d = (0, path_1.relative)((0, path_1.dirname)(this.config.path), '/')) !== null && _d !== void 0 ? _d : '.',
                 apps: {},
                 ui5: {
-                    libs: Object.keys((_f = (_e = (_d = manifest['sap.ui5']) === null || _d === void 0 ? void 0 : _d.dependencies) === null || _e === void 0 ? void 0 : _e.libs) !== null && _f !== void 0 ? _f : {}).join(','),
-                    theme: supportedThemes.includes(DEFAULT_THEME) ? DEFAULT_THEME : supportedThemes[0],
+                    libs: Object.keys((_g = (_f = (_e = manifest['sap.ui5']) === null || _e === void 0 ? void 0 : _e.dependencies) === null || _f === void 0 ? void 0 : _f.libs) !== null && _g !== void 0 ? _g : {}).join(','),
+                    theme: ui5Theme,
                     flex,
                     resources: Object.assign(Object.assign({}, resources), { [PREVIEW_URL.client.ns]: PREVIEW_URL.client.url })
                 },
-                locateReuseLibsScript: (_g = this.config.libs) !== null && _g !== void 0 ? _g : (yield this.hasLocateReuseLibsScript())
+                locateReuseLibsScript: (_h = this.config.libs) !== null && _h !== void 0 ? _h : (yield this.hasLocateReuseLibsScript())
             };
             this.addApp(manifest, {
                 componentId,
-                target: (_h = resources[componentId !== null && componentId !== void 0 ? componentId : manifest['sap.app'].id]) !== null && _h !== void 0 ? _h : this.templateConfig.basePath,
+                target: (_j = resources[componentId !== null && componentId !== void 0 ? componentId : manifest['sap.app'].id]) !== null && _j !== void 0 ? _j : this.templateConfig.basePath,
                 local: '.',
                 intent: this.config.intent
             });
             this.addStandardRoutes();
             if (this.rta) {
-                (_j = (_k = this.rta).options) !== null && _j !== void 0 ? _j : (_k.options = {});
+                (_k = (_l = this.rta).options) !== null && _k !== void 0 ? _k : (_l.options = {});
                 this.rta.options.baseId = componentId !== null && componentId !== void 0 ? componentId : manifest['sap.app'].id;
                 this.addEditorRoutes(this.rta);
             }

package/dist/types/index.d.ts

@@ -41,6 +41,7 @@ export interface FlpConfig {
      */
     libs?: boolean;
     apps: App[];
+    theme?: string;
 }
 /**
  * Middleware configuration.

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.5.4",
+  "version": "0.5.6",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -29,14 +29,14 @@
   "devDependencies": {
     "@types/ejs": "3.1.2",
     "@types/express": "4.17.17",
-    "@types/prompts": "2.0.14",
+    "@types/prompts": "2.4.4",
     "@types/supertest": "2.0.12",
     "copyfiles": "2.4.1",
     "npm-run-all": "4.1.5",
     "express": "4.18.2",
     "nock": "13.2.1",
     "supertest": "6.3.3",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.1.0",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.1.1",
     "@sap-ux/project-access": "1.13.5",
     "@sap-ux/store": "0.3.13"
   },