@sap-ux/backend-proxy-middleware-cf 0.0.56 → 0.0.58

package/README.md

@@ -14,6 +14,7 @@ It can be used either with the `ui5 serve` or the `fiori run` commands.
 | ------------------- | ---------- | ---------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- |
 | `url`               | `string`   | **required**     | `undefined`   | Destination URL to proxy requests to.                                                                           |
 | `paths`             | `string[]` | **required**     | `[]`          | Array of OData source paths to proxy to this destination. Each path represents an OData service that should be proxied. Requests matching these paths will have the path prefix removed before forwarding. |
+| `pathRewrite`       | `string`   | optional         | `undefined`   | Optional path rewriting. When specified, the matched path prefix will be replaced with this value before forwarding to the backend. If not specified, the matched path is simply removed. Example: path `/resources/lib/api` with pathRewrite `/api` transforms `/resources/lib/api/v1/Service` to `/api/v1/Service`. |
 | `credentials`       | object     | optional         | `undefined`    | Manual OAuth credentials. If not provided, middleware attempts to auto-detect from Cloud Foundry ADP project.   |
 | `credentials.clientId` | `string` | mandatory (if credentials provided) | `undefined` | OAuth2 client ID.                                                                                                |
 | `credentials.clientSecret` | `string` | mandatory (if credentials provided) | `undefined` | OAuth2 client secret.                                                                                            |
@@ -103,7 +104,36 @@ server:
               - /odata/v4/service2
               - /odata/v2/legacy
 ```
-### Miltiple Backend Services
+
+### Path Rewriting with pathRewrite
+
+When your application requests resources with a specific path prefix (e.g., from a UI5 library), but the backend API expects a different path structure, use `pathRewrite`:
+
+```yaml
+server:
+  customMiddleware:
+    - name: backend-proxy-middleware-cf
+      afterMiddleware: compression
+      configuration:
+        backends:
+          - url: https://my-backend.example.com
+            paths:
+              - /resources/my/app/ui/api/example
+            pathRewrite: /api/example
+```
+
+**How it works:**
+- **Request from app:** `/resources/my/app/ui/api/example/v1/ExampleService/$metadata`
+- **Matched path:** `/resources/my/app/ui/api/example`
+- **Path rewriting:** `/api/example`
+- **Forwarded to backend:** `/api/example/v1/ExampleService/$metadata`
+
+Without `pathRewrite`, the matched path prefix is simply removed:
+- **Request:** `/odata/v4/service/EntitySet`
+- **Matched path:** `/odata`
+- **Forwarded:** `/v4/service/EntitySet`
+
+### Multiple Backend Services
 
 You can proxy multiple backend services:
 

package/dist/proxy.d.ts

@@ -9,24 +9,27 @@ export type EnhancedIncomingMessage = (IncomingMessage & Pick<Request, 'original
  * Creates proxy options for http-proxy-middleware.
  *
  * @param {string} targetUrl - The target URL to proxy to.
+ * @param {string} matchedPath - The path prefix that was matched by the router.
+ * @param {string | undefined} pathRewrite - Optional replacement path.
  * @param {ToolsLogger} logger - Logger instance.
  * @returns {Options} Proxy options configuration.
  */
-export declare function createProxyOptions(targetUrl: string, logger: ToolsLogger): Options;
+export declare function createProxyOptions(targetUrl: string, matchedPath: string, pathRewrite: string | undefined, logger: ToolsLogger): Options;
 /**
  * Registers a proxy route for a given path.
  *
  * @param {string} path - Path to register.
  * @param {string} destinationUrl - Target URL for proxying.
+ * @param {string | undefined} pathRewrite - Optional rewrite path.
  * @param {OAuthTokenProvider} tokenProvider - Token provider instance.
  * @param {ToolsLogger} logger - Logger instance.
  * @param {Router} router - Express router instance.
  */
-export declare function registerProxyRoute(path: string, destinationUrl: string, tokenProvider: OAuthTokenProvider, logger: ToolsLogger, router: Router): void;
+export declare function registerProxyRoute(path: string, destinationUrl: string, pathRewrite: string | undefined, tokenProvider: OAuthTokenProvider, logger: ToolsLogger, router: Router): void;
 /**
  * Sets up all proxy routes for the configured backends.
  *
- * @param {Array<{url: string, paths: string[]}>} backends - Array of backend configurations.
+ * @param {Array<{url: string, paths: string[], pathRewrite?: string}>} backends - Array of backend configurations.
  * @param {OAuthTokenProvider} tokenProvider - Token provider instance.
  * @param {ToolsLogger} logger - Logger instance.
  * @returns {Router} Configured Express router.
@@ -34,5 +37,6 @@ export declare function registerProxyRoute(path: string, destinationUrl: string,
 export declare function setupProxyRoutes(backends: Array<{
     url: string;
     paths: string[];
+    pathRewrite?: string;
 }>, tokenProvider: OAuthTokenProvider, logger: ToolsLogger): Router;
 //# sourceMappingURL=proxy.d.ts.map

package/dist/proxy.js

@@ -9,10 +9,12 @@ const http_proxy_middleware_1 = require("http-proxy-middleware");
  * Creates proxy options for http-proxy-middleware.
  *
  * @param {string} targetUrl - The target URL to proxy to.
+ * @param {string} matchedPath - The path prefix that was matched by the router.
+ * @param {string | undefined} pathRewrite - Optional replacement path.
  * @param {ToolsLogger} logger - Logger instance.
  * @returns {Options} Proxy options configuration.
  */
-function createProxyOptions(targetUrl, logger) {
+function createProxyOptions(targetUrl, matchedPath, pathRewrite, logger) {
     return {
         target: targetUrl,
         changeOrigin: true,
@@ -22,9 +24,19 @@ function createProxyOptions(targetUrl, logger) {
             const originalUrl = req.originalUrl ?? req.url ?? path;
             const urlPath = originalUrl.split('?')?.[0];
             const queryString = originalUrl.includes('?') ? originalUrl.substring(originalUrl.indexOf('?')) : '';
-            const fullPath = urlPath + queryString;
-            logger.debug(`Rewrite path ${path} > ${fullPath}`);
-            return fullPath;
+            // Strip the matched path prefix
+            let rewrittenPath = urlPath;
+            if (urlPath.startsWith(matchedPath)) {
+                rewrittenPath = urlPath.substring(matchedPath.length);
+            }
+            // Add the replacement prefix if specified
+            if (pathRewrite !== undefined) {
+                const sanitizedRewrite = pathRewrite.replace(/\/$/, ''); // Remove trailing slash
+                rewrittenPath = sanitizedRewrite + rewrittenPath;
+            }
+            const finalPath = rewrittenPath + queryString;
+            logger.debug(`Rewrite path ${originalUrl} > ${finalPath}`);
+            return finalPath;
         },
         on: {
             error: (err, req, _res, _target) => {
@@ -41,21 +53,23 @@ function createProxyOptions(targetUrl, logger) {
  *
  * @param {string} path - Path to register.
  * @param {string} destinationUrl - Target URL for proxying.
+ * @param {string | undefined} pathRewrite - Optional rewrite path.
  * @param {OAuthTokenProvider} tokenProvider - Token provider instance.
  * @param {ToolsLogger} logger - Logger instance.
  * @param {Router} router - Express router instance.
  */
-function registerProxyRoute(path, destinationUrl, tokenProvider, logger, router) {
-    const proxyOptions = createProxyOptions(destinationUrl, logger);
+function registerProxyRoute(path, destinationUrl, pathRewrite, tokenProvider, logger, router) {
+    const proxyOptions = createProxyOptions(destinationUrl, path, pathRewrite, logger);
     const proxyFn = (0, http_proxy_middleware_1.createProxyMiddleware)(proxyOptions);
     const tokenMiddleware = tokenProvider.createTokenMiddleware();
     router.use(path, tokenMiddleware, proxyFn);
-    logger.info(`Registered proxy for path: ${path} -> ${destinationUrl}`);
+    const rewriteInfo = pathRewrite ? ` (rewrite to: ${pathRewrite})` : ' (strip prefix)';
+    logger.info(`Registered proxy for path: ${path} -> ${destinationUrl}${rewriteInfo}`);
 }
 /**
  * Sets up all proxy routes for the configured backends.
  *
- * @param {Array<{url: string, paths: string[]}>} backends - Array of backend configurations.
+ * @param {Array<{url: string, paths: string[], pathRewrite?: string}>} backends - Array of backend configurations.
  * @param {OAuthTokenProvider} tokenProvider - Token provider instance.
  * @param {ToolsLogger} logger - Logger instance.
  * @returns {Router} Configured Express router.
@@ -65,7 +79,7 @@ function setupProxyRoutes(backends, tokenProvider, logger) {
     for (const backend of backends) {
         for (const path of backend.paths) {
             try {
-                registerProxyRoute(path, backend.url, tokenProvider, logger, router);
+                registerProxyRoute(path, backend.url, backend.pathRewrite, tokenProvider, logger, router);
             }
             catch (e) {
                 throw new Error(`Failed to register proxy for ${path}. Check configuration in yaml file. \n\t${e.message}`);

package/dist/types.d.ts

@@ -12,6 +12,12 @@ export interface BackendDestination {
      * Requests matching these paths will have the path prefix removed before forwarding.
      */
     paths: string[];
+    /**
+     * Optional path rewriting. When specified, the matched path prefix will be replaced
+     * with this value before forwarding to the backend.
+     * If not specified, the matched path is simply removed.
+     */
+    pathRewrite?: string;
 }
 /**
  * Configuration for Cloud Foundry OAuth middleware.

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%3Abackend-proxy-middleware-cf"
   },
-  "version": "0.0.56",
+  "version": "0.0.58",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -23,9 +23,9 @@
   "dependencies": {
     "axios": "1.13.5",
     "http-proxy-middleware": "3.0.5",
-    "@sap-ux/adp-tooling": "0.18.66",
+    "@sap-ux/adp-tooling": "0.18.68",
     "@sap-ux/logger": "0.8.1",
-    "@sap-ux/project-access": "1.35.5"
+    "@sap-ux/project-access": "1.35.6"
   },
   "devDependencies": {
     "@types/express": "4.17.21",