@sap-ux/backend-proxy-middleware 0.11.2 → 0.12.0

package/README.md

@@ -18,6 +18,7 @@ It can be used either with the `ui5 serve` or the `fiori run` commands.
 | `pathReplace`  | `string` optional      | If provided then the path will be replaced with this value before forwarding |
 | `connectPath` | `string` optional      | Path used to fetch the correct credentials from the store when a full odata service url 'system' is used. |
 | `client`      | `string` optional      | sap-client parameter |
+| `params`      | `object` optional      | Map of additional query parameters appended to every proxied request (e.g. `{ saml2: 'disabled' }`) |
 | `scp`         | `boolean` optional      | If set to true the proxy will execute the required OAuth routine for the ABAP environment on SAP BTP |
 | `apiHub`      | `boolean` optional      | If set to true then the proxy will connect to the SAP API Business Hub |
 | `proxy`       | `string` optional      | If set then it will override the proxy settings from node. |
@@ -126,6 +127,21 @@ If you want to configure the proxy to send requests from a certain path `/servic
       destination: my_example_destination
 ```
 
+### [Appending additional query parameters to proxied requests](#appending-additional-query-parameters)
+If you need to append extra query parameters to all proxied backend requests (e.g. to disable SAML authentication for Basic Auth flows), use the `params` property. This is the recommended approach instead of injecting parameters via the `client` property.
+
+```yaml
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    backend:
+      path: /sap
+      url: https://my.backend.example:1234
+      client: '100'
+      params:
+        saml2: disabled
+```
+
 ### [Providing Proxy Configuration](#providing-proxy-configuration)
 By default the `backend-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.d.ts

@@ -73,6 +73,13 @@ export declare const PathRewriters: {
      * @returns a path rewrite function
      */
     replaceClient(client: string): (path: string) => string;
+    /**
+     * Append additional query parameters to every proxied request path.
+     *
+     * @param params map of query parameter key-value pairs
+     * @returns a path rewrite function
+     */
+    appendParams(params: Record<string, string>): (path: string) => string;
     /**
      * Create a chain of rewrite function calls based on the provided configuration.
      *

package/dist/base/proxy.js

@@ -144,6 +144,23 @@ exports.PathRewriters = {
             }
         };
     },
+    /**
+     * Append additional query parameters to every proxied request path.
+     *
+     * @param params map of query parameter key-value pairs
+     * @returns a path rewrite function
+     */
+    appendParams(params) {
+        const queryString = Object.entries(params)
+            .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
+            .join('&');
+        return (path) => {
+            if (!queryString) {
+                return path;
+            }
+            return path.includes('?') ? `${path}&${queryString}` : `${path}?${queryString}`;
+        };
+    },
     /**
      * Create a chain of rewrite function calls based on the provided configuration.
      *
@@ -162,8 +179,15 @@ exports.PathRewriters = {
             functions.push(exports.PathRewriters.replacePrefix(config.path, config.pathReplace));
         }
         if (config.client) {
+            if (!/^\d{1,3}$/.test(config.client)) {
+                log.warn(`Invalid "client" value "${config.client}": expected a 1-3 digit SAP client number. ` +
+                    `Use the "params" property to append additional query parameters.`);
+            }
             functions.push(exports.PathRewriters.replaceClient(config.client));
         }
+        if (config.params) {
+            functions.push(exports.PathRewriters.appendParams(config.params));
+        }
         if (config.bsp) {
             functions.push(exports.PathRewriters.convertAppDescriptorToManifest(config.bsp));
         }

package/dist/base/types.d.ts

@@ -13,6 +13,12 @@ export interface BaseBackendConfig {
      * sap-client parameter
      */
     client?: string;
+    /**
+     * Optional map of additional query parameters to append to every proxied request.
+     * Aligned with the `params` property in `UrlAbapTarget` from `@sap-ux/system-access`.
+     * Example: { saml2: 'disabled' }
+     */
+    params?: Record<string, string>;
     /**
      * If set to true the proxy will execute the required OAuth routine for the ABAP environment on SAP BTP
      */

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"
   },
-  "version": "0.11.2",
+  "version": "0.12.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -27,14 +27,14 @@
     "chalk": "4.1.2",
     "dotenv": "17.3.1",
     "http-proxy-middleware": "3.0.5",
-    "https-proxy-agent": "5.0.1",
-    "i18next": "25.8.20",
+    "https-proxy-agent": "7.0.6",
+    "i18next": "25.10.10",
     "prompts": "2.4.2",
     "proxy-from-env": "1.1.0",
-    "@sap-ux/axios-extension": "1.25.26",
-    "@sap-ux/btp-utils": "1.1.11",
-    "@sap-ux/logger": "0.8.3",
-    "@sap-ux/store": "1.5.11"
+    "@sap-ux/axios-extension": "1.25.28",
+    "@sap-ux/btp-utils": "1.1.12",
+    "@sap-ux/logger": "0.8.4",
+    "@sap-ux/store": "1.5.12"
   },
   "devDependencies": {
     "@types/connect": "^3.4.38",