@sap-ux/ui5-proxy-middleware 1.6.0 → 1.6.1

package/README.md

@@ -3,14 +3,17 @@
 The `@sap-ux/ui5-proxy-middleware` is a [Custom UI5 Server Middleware](https://sap.github.io/ui5-tooling/pages/extensibility/CustomServerMiddleware) for loading the UI5 sources in your application. It can be used either with the `ui5 serve` or the `fiori run` commands.
 
 ## Configuration Options
-| Option       | Default Value | Description |
-| ------------ | ------------- | ----------- |
-| `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 |
-| `proxy`      | `undefined`   | Use for adding corporate proxy configuration |
-| `directLoad` | false         | Defines whether the UI5 sources should be loaded directly from UI5 CDN |
+| Option       | Value Type    | Requirement Type | Default Value | Description |
+| ------------ | ------------- |------------- | ----------- |----------- |
+| `ui5`        | object  | optional | ---       | Configuration object for the UI5 proxy middleware |
+| `ui5.path`   |  string | optional | `/resources`, `/test-resources`       | Path that is to be proxied |
+| `ui5.url`     | string  | optional |`https://ui5.sap.com`      | URL pointing to the resources |
+| `ui5.pathReplace`| string  | optional | `undefined` | If provided then the path will be replaced with this value before forwarding |
+| `ui5.version`    | string  | optional |`undefined` | The UI5 version. If this property is not defined, then the `minUI5Version` from the `manifest.json` will be used |
+| `secure`     | boolean  | optional | true      | Defines if SSL certs should be verified |
+| `debug`      | boolean  | optional | false         | Enables debug output |
+| `proxy`      |  string | optional | `undefined`   | Use for adding corporate proxy configuration |
+| `directLoad` |  boolean | optional | 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. All requests to `/resources` and `/test-resources` will be proxied to the latest UI5 version at https://ui5.sap.com.
@@ -40,7 +43,7 @@ server:
         url: https://ui5.sap.com
 ```
 
-Alternatively you can use the following syntax if all paths should be proxied to the same url.
+Alternatively you can use the following syntax if all paths should be proxied to the same URL.
 
 ```Yaml
 server:
@@ -54,10 +57,11 @@ server:
         - /test-resources
         url: https://ui5.sap.com
 ```
-**NOTE: You can't mix both syntaxes!**
+
+**NOTE: You can't mix the syntaxes!**
 
 ### Loading a specific UI5 version
-To load a specific a UI5 version in your application you can use the `version` parameter, e.g.
+To load a specific UI5 version in your application you can use the `version` parameter, e.g.
 
 ```Yaml
 server:
@@ -92,6 +96,23 @@ server:
       directLoad: true
 ```
 
+### Loading UI5 sources from a different Host
+If you want to load UI5 sources from a different host, then you can set the property `pathReplace` to point to the desired resources. If provided then the `path` will be replaced with this value before forwarding.
+
+**NOTE: using `pathReplace` will not consider a specified UI5 version. If a specific UI5 version is needed, then it needs to be part of the `pathReplace`.**
+
+```Yaml
+server:
+  customMiddleware:
+  - name: ui5-proxy-middleware
+    afterMiddleware: compression
+    configuration:
+      ui5:
+      - path: /resources          
+        url: https://my.backend.example:1234
+        pathReplace: /sap/public/ui5/resources    
+```
+
 ### Adding corporate proxy configuration
 By default the `ui5-proxy-middleware` will read the proxy configuration from the OS environment variables `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY` or from the Node.js environment variables `proxy`, `https-proxy`, and `noproxy`. If those variables are not set, then you can also provide the proxy configuration in the `ui5.yaml` file.
 

package/dist/base/proxy.js

@@ -39,9 +39,7 @@ const ui5Proxy = (config, options, filter, logger = new logger_1.ToolsLogger({
         },
         target: config.url,
         changeOrigin: true,
-        pathRewrite: (path, _req) => {
-            return path.startsWith(config.path) ? ui5Ver + path : ui5Ver + config.path + path;
-        },
+        pathRewrite: (0, utils_1.getPathRewrite)(config, ui5Ver),
         pathFilter: proxyFilter,
         ...options
     };

package/dist/base/types.d.ts

@@ -1,9 +1,25 @@
 import type { NextFunction } from 'express';
 import type { IncomingMessage } from 'http';
 export interface ProxyConfig {
+    /**
+     * Path that is to be proxied.
+     */
     path: string;
+    /**
+     * If provided then the path will be replaced with this value before forwarding.
+     */
+    pathReplace?: string;
+    /**
+     * The target URL to proxy the request to.
+     */
     url: string;
+    /**
+     * If provided then the proxy will try to load the specified version of UI5 resources.
+     */
     version?: string;
+    /**
+     * If set then it will override the proxy settings from node.
+     */
     proxy?: string;
 }
 export interface UI5ProxyRequest {

package/dist/base/utils.d.ts

@@ -1,4 +1,5 @@
 import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
+import type { Options } from 'http-proxy-middleware';
 import type { ToolsLogger } from '@sap-ux/logger';
 import { type Manifest } from '@sap-ux/project-access';
 import type { RequestHandler, NextFunction, Request, Response } from 'express';
@@ -131,4 +132,12 @@ export declare function proxyErrorHandler(err: Error & {
  * @returns RequestHandler to adjust bootstraps
  */
 export declare function directLoadProxy(ui5Configs: ProxyConfig[], rootProject: ReaderCollection, logger: ToolsLogger): RequestHandler;
+/**
+ * Create a rewrite based on the provided configuration.
+ *
+ * @param config proxy configuration
+ * @param ui5Ver UI5 version string
+ * @returns a path rewrite
+ */
+export declare function getPathRewrite(config: ProxyConfig, ui5Ver: string): Options['pathRewrite'];
 //# sourceMappingURL=utils.d.ts.map

package/dist/base/utils.js

@@ -6,6 +6,7 @@ exports.resolveUI5Version = resolveUI5Version;
 exports.injectUI5Url = injectUI5Url;
 exports.proxyErrorHandler = proxyErrorHandler;
 exports.directLoadProxy = directLoadProxy;
+exports.getPathRewrite = getPathRewrite;
 const project_access_1 = require("@sap-ux/project-access");
 const constants_1 = require("./constants");
 const i18n_1 = require("../i18n");
@@ -310,4 +311,19 @@ function directLoadProxy(ui5Configs, rootProject, logger) {
         }
     };
 }
+/**
+ * Create a rewrite based on the provided configuration.
+ *
+ * @param config proxy configuration
+ * @param ui5Ver UI5 version string
+ * @returns a path rewrite
+ */
+function getPathRewrite(config, ui5Ver) {
+    if (config.pathReplace) {
+        // Remove trailing slash from pathReplace if present
+        const sanitizedPathReplace = config.pathReplace?.replace(/\/$/, '');
+        return (path) => path.replace(config.path, sanitizedPathReplace);
+    }
+    return (path) => (path.startsWith(config.path) ? ui5Ver + path : ui5Ver + config.path + path);
+}
 //# sourceMappingURL=utils.js.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%3Aui5-proxy-middleware"
   },
-  "version": "1.6.0",
+  "version": "1.6.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",