@sap-ux/ui5-proxy-middleware 1.1.35 → 1.2.1

package/README.md

@@ -5,7 +5,7 @@ The `@sap-ux/ui5-proxy-middleware` is a [Custom UI5 Server Middleware](https://s
 ## Configuration Options
 | Option       | Default Value | Description |
 | ------------ | ------------- | ----------- |
-| `ui5`        | mandatory     | List of mount paths and target urls that should be handled by the proxy |
+| `ui5`        | `object`      | List of mount paths and target urls that should be handled by the proxy. If not provided then `/resources` and `/test-resources` are proxied to `https://ui5.sap.com` |
 | `version`    | `undefined`   | The UI5 version. If this property is not defined, then the `minUI5Version` from the `manifest.json` will be used |
 | `secure`     | true          | Defines if SSL certs should be verified |
 | `debug`      | false         | Enables debug output |
@@ -13,7 +13,19 @@ The `@sap-ux/ui5-proxy-middleware` is a [Custom UI5 Server Middleware](https://s
 | `directLoad` | false         | Defines whether the UI5 sources should be loaded directly from UI5 CDN |
 
 ## Usage
-In order to use the middleware this is the minimal configuration that you need to provide in the `ui5.yaml` of your application.
+In order to use the middleware this is the minimal configuration that you need to provide in the `ui5.yaml` of your application. All requests to `/resources` and `/test-resources` will be proxied to the latest UI5 version at https://ui5.sap.com.
+
+```yaml
+server:
+  customMiddleware:
+  - name: ui5-proxy-middleware
+    afterMiddleware: compression
+```
+
+## Examples
+
+### Defining url and path
+If you want to explicitly define paths that should be proxied to a specific server, the following configuration is required.
 
 ```Yaml
 server:
@@ -44,17 +56,6 @@ server:
 ```
 **NOTE: You can't mix both syntaxes!**
 
-Finally don't forget to add the following in your `package.json`.
-
-```JSON
-"ui5": {
-    "dependencies": [
-        "@sap-ux/ui5-proxy-middleware"
-    ]
-}
-```
-
-## Examples
 ### Loading a specific UI5 version
 To load a specific a UI5 version in your application you can use the `version` parameter, e.g.
 

package/dist/base/utils.js

@@ -38,7 +38,7 @@ exports.proxyResponseHandler = proxyResponseHandler;
  * @param logger - Logger for loging the requests
  */
 const proxyRequestHandler = (proxyReq, res, etag, logger) => {
-    logger.info(proxyReq.path);
+    logger.debug(proxyReq.path);
     if (proxyReq.getHeader('if-none-match') === etag) {
         res.statusCode = 304;
         res.end();

package/dist/ui5/middleware.js

@@ -64,16 +64,14 @@ function loadManifest(rootProject) {
     });
 }
 module.exports = ({ resources, options }) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
     const logger = new logger_1.ToolsLogger({
         transports: [new logger_1.UI5ToolingTransport({ moduleName: 'ui5-proxy-middleware' })]
     });
-    if (!((_a = options.configuration) === null || _a === void 0 ? void 0 : _a.ui5)) {
-        logger.error('Configuration missing, no proxy created.');
-        return (_req, _res, next) => next();
-    }
     dotenv_1.default.config();
-    const config = options.configuration;
+    const config = Object.assign({ ui5: {
+            path: ['/resources', '/test-resources'],
+            url: 'https://ui5.sap.com'
+        } }, options.configuration);
     let ui5Version = '';
     try {
         const manifest = yield loadManifest(resources.rootProject);
@@ -107,7 +105,7 @@ module.exports = ({ resources, options }) => __awaiter(void 0, void 0, void 0, f
         }
     }
     if (directLoad) {
-        const directLoadProxy = (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+        const directLoadProxy = ((req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
             try {
                 yield (0, base_1.injectScripts)(req, res, next, ui5Configs);
             }
@@ -115,7 +113,7 @@ module.exports = ({ resources, options }) => __awaiter(void 0, void 0, void 0, f
                 logger.error(error);
                 next(error);
             }
-        });
+        }));
         base_1.HTML_MOUNT_PATHS.forEach((path) => {
             routes.push({ route: path, handler: directLoadProxy });
         });

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%3Aui5-proxy-middleware"
   },
-  "version": "1.1.35",
+  "version": "1.2.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,7 +27,7 @@
     "i18next": "20.3.2",
     "proxy-from-env": "1.1.0",
     "@sap-ux/logger": "0.3.7",
-    "@sap-ux/ui5-config": "0.19.0"
+    "@sap-ux/ui5-config": "0.19.1"
   },
   "devDependencies": {
     "@types/express": "4.17.17",
@@ -37,7 +37,7 @@
     "nock": "13.2.4",
     "supertest": "6.3.3",
     "yaml": "2.2.2",
-    "@sap-ux/project-access": "1.13.2"
+    "@sap-ux/project-access": "1.13.4"
   },
   "ui5": {
     "dependencies": []