@sap/ux-ui5-tooling 1.5.4 → 1.6.1

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 All notable changes to this project are documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/) and the changelog is formatted based on [Keep a Changelog](http://keepachangelog.com/).
+## [1.6.0] - 2022-05-05
+### Changed
+- The `fiori-tools-proxy` is now using the [@sap-ux/ui5-proxy-middleware](https://www.npmjs.com/package/@sap-ux/ui5-proxy-middleware) for proxying the UI5 sources
+
+## [1.5.5] - 2022-04-21
+### Fixed
+- Fixed an issue with the `fiori-tools-servestatic` middleware not serving files starting with a dot
+
 ## [1.5.4] - 2022-04-07
 ### Fixed
 - Fixed an issue with escaping runtime arguments on Windows with Node.js version 16

package/README.md

@@ -204,6 +204,21 @@ By using the `version` parameter one can choose the SAPUI5 version which will us
       directLoad: true
 ```
 
+Starting with version `1.6.0` one can use the following syntax for proxying different UI5 requests to different URLs, e.g.
+
+```
+- name: fiori-tools-proxy
+  afterMiddleware: compression
+  configuration:
+    ui5:
+      paths:
+        - path: /resources
+          url: https://ui5.sap.com
+        - path: /test-resources
+          src: https://sapui5.hana.ondemand.com
+      version: '1.100.1'
+```
+
 ### [**3. Serve Static**](#3-serve-static)
 
 The serve static middleware provides the capability to serve any static resources locally from your machine. E.g. you can serve SAPUI5 locally or any other resources.
@@ -245,9 +260,10 @@ server:
           src: "Path/To/libs"
 ```
 
-### Configuration options
+### [Configuration options](#configuration-options-1)
+Additionaly you can specify any of the configuration options (excluding `setHeaders`!) of the [serve-static](https://www.npmjs.com/package/serve-static) middleware.
 
-- **`fallthrough`** (default: true) - client errors fall-through as just unhandled requests, otherwise forward a client error. E.g. If set to true, then the `fiori-tools-servestatic` middleware will not return 404 error, when it can't find a file on the local system, but it will simply pass the request to the next available middleware. Otherwise 404 error will be returned.
+E.g. you can set `fallthrough: false`, which will cause the middleware to return 404 error, when it can't find a file on the local system:
 
 ```
 server:
@@ -256,9 +272,27 @@ server:
     afterMiddleware: compression
     configuration:
       paths:
-        - path: /libs
-          src: "Path/To/libs"
+        - path: /resources
+          src: "Path/To/SAPUI5-SDK"
+        - path: /test-resources
+          src: "Path/To/SAPUI5-SDK"
+      fallthrough: false
+```
+
+Alternatively you can set e.g. `fallthrough: false` only for specific requests:
+
+```
+server:
+  customMiddleware:
+  - name: fiori-tools-servestatic
+    afterMiddleware: compression
+    configuration:
+      paths:
+        - path: /resources
+          src: "Path/To/SAPUI5-SDK"
           fallthrough: false
+        - path: /test-resources
+          src: "Path/To/SAPUI5-SDK"
 ```
 
 ### [**4. Preview**](#4-preview)