@sap-ux/backend-proxy-middleware-cf 0.0.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,107 @@
+[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/backend-proxy-middleware-cf/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/backend-proxy-middleware-cf)
+
+# [`@sap-ux/backend-proxy-middleware-cf`](https://github.com/SAP/open-ux-tools/tree/main/packages/backend-proxy-middleware-cf)
+
+The `@sap-ux/backend-proxy-middleware-cf` is a [Custom UI5 Server Middleware](https://sap.github.io/ui5-tooling/pages/extensibility/CustomServerMiddleware) for proxying requests to Cloud Foundry destinations with OAuth2 authentication. It supports proxying multiple OData source paths to a single destination URL with automatic OAuth token management.
+
+> **⚠️ Experimental**: This middleware is currently experimental and may be subject to breaking changes or even removal in future versions. Use with caution and be prepared to update your configuration or migrate to alternative solutions if needed.
+
+It can be used either with the `ui5 serve` or the `fiori run` commands.
+
+## [Configuration Options](#configuration-options)
+
+| Option              | Value Type | Requirement Type | Default Value | Description                                                                                                      |
+| ------------------- | ---------- | ---------------- | ------------- | ---------------------------------------------------------------------------------------------------------------- |
+| `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. |
+| `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.                                                                                            |
+| `credentials.url`    | `string`   | mandatory (if credentials provided) | `undefined` | Base URL for the OAuth service. The token endpoint will be constructed as `{url}/oauth/token`.                   |
+| `debug`             | `boolean`  | optional         | `false`        | Enable debug logging for troubleshooting.                                                                        |
+
+## [Usage](#usage)
+
+### [Basic Configuration](#basic-configuration)
+
+```yaml
+server:
+  customMiddleware:
+    - name: backend-proxy-middleware-cf
+      afterMiddleware: compression
+      configuration:
+        url: https://your-backend-service
+        paths:
+          - /odata/v4/visitorservice
+          - /odata
+```
+
+### [Automatic Detection (Recommended)](#automatic-detection-recommended)
+
+For Cloud Foundry adaptation projects, the middleware automatically detects the project configuration from `ui5.yaml` and extracts OAuth credentials from service keys. You only need to provide the `url` and `paths`:
+
+```yaml
+server:
+  customMiddleware:
+    - name: backend-proxy-middleware-cf
+      afterMiddleware: compression
+      configuration:
+        url: https://your-backend-service
+        paths:
+          - /odata/v4/visitorservice
+          - /odata
+```
+
+The middleware will:
+
+1. Read the `app-variant-bundler-build` custom task from `ui5.yaml`
+2. Extract `serviceInstanceName` and `serviceInstanceGuid`
+3. Retrieve service keys using `@sap-ux/adp-tooling`
+4. Extract UAA credentials and construct the token endpoint
+5. Automatically add Bearer tokens to proxied requests
+
+### [Manual Credentials](#manual-credentials)
+
+For custom setups or when auto-detection is not available, you can provide OAuth credentials manually:
+
+```yaml
+server:
+  customMiddleware:
+    - name: backend-proxy-middleware-cf
+      afterMiddleware: compression
+      configuration:
+        url: https://your-backend-service
+        paths:
+          - /odata/v4/visitorservice
+          - /odata
+        credentials:
+          clientId: "your-service-instance!b123|your-app!b456"
+          clientSecret: "your-client-secret"
+          url: "https://example.authentication"
+        debug: true
+```
+
+The `credentials.url` should be the base URL of the UAA service (without `/oauth/token`). The middleware will automatically construct the full token endpoint.
+
+### [With Debug Logging](#with-debug-logging)
+
+Enable debug logging to troubleshoot issues:
+
+```yaml
+server:
+  customMiddleware:
+    - name: backend-proxy-middleware-cf
+      afterMiddleware: compression
+      configuration:
+        url: https://your-backend-service
+        paths:
+          - /odata
+        debug: true
+```
+
+## [Keywords](#keywords)
+
+- OAuth2 Proxy Middleware
+- Cloud Foundry ADP
+- Fiori tools
+- SAP UI5

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export type { CfOAuthMiddlewareConfig } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/middleware.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=middleware.d.ts.map

package/dist/middleware.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("@sap-ux/logger");
+const proxy_1 = require("./proxy");
+const validation_1 = require("./validation");
+const token_1 = require("./token");
+/**
+ * UI5 middleware for proxying requests to Cloud Foundry destinations with OAuth2 authentication.
+ * Supports one destination URL with multiple OData source paths.
+ *
+ * @param {MiddlewareParameters<CfOAuthMiddlewareConfig>} params - Input parameters for UI5 middleware.
+ * @param {CfOAuthMiddlewareConfig} params.options - Configuration options.
+ * @returns {Promise<RequestHandler>} Express middleware handler.
+ */
+module.exports = async ({ options }) => {
+    const config = options.configuration;
+    if (!config) {
+        throw new Error('Backend proxy middleware (CF) has no configuration.');
+    }
+    const logger = new logger_1.ToolsLogger({
+        logLevel: config.debug ? logger_1.LogLevel.Debug : logger_1.LogLevel.Info,
+        transports: [new logger_1.UI5ToolingTransport({ moduleName: 'backend-proxy-middleware-cf' })]
+    });
+    await (0, validation_1.validateConfig)(config, logger);
+    const tokenProvider = await (0, token_1.createTokenProvider)(config, logger);
+    return (0, proxy_1.setupProxyRoutes)(config.paths, config.url, tokenProvider, logger);
+};
+//# sourceMappingURL=middleware.js.map

package/dist/proxy.d.ts

@@ -0,0 +1,36 @@
+import type connect from 'connect';
+import { type Request, Router } from 'express';
+import type { Options } from 'http-proxy-middleware';
+import type { IncomingMessage } from 'node:http';
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { OAuthTokenProvider } from './token';
+export type EnhancedIncomingMessage = (IncomingMessage & Pick<Request, 'originalUrl'>) | connect.IncomingMessage;
+/**
+ * Creates proxy options for http-proxy-middleware.
+ *
+ * @param {string} targetUrl - The target URL to proxy to.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {Options} Proxy options configuration.
+ */
+export declare function createProxyOptions(targetUrl: string, 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 {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;
+/**
+ * Sets up all proxy routes for the configured paths.
+ *
+ * @param {string[]} paths - Array of paths to register.
+ * @param {string} destinationUrl - Target URL for proxying.
+ * @param {OAuthTokenProvider} tokenProvider - Token provider instance.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {Router} Configured Express router.
+ */
+export declare function setupProxyRoutes(paths: string[], destinationUrl: string, tokenProvider: OAuthTokenProvider, logger: ToolsLogger): Router;
+//# sourceMappingURL=proxy.d.ts.map

package/dist/proxy.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProxyOptions = createProxyOptions;
+exports.registerProxyRoute = registerProxyRoute;
+exports.setupProxyRoutes = setupProxyRoutes;
+const express_1 = require("express");
+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 {ToolsLogger} logger - Logger instance.
+ * @returns {Options} Proxy options configuration.
+ */
+function createProxyOptions(targetUrl, logger) {
+    return {
+        target: targetUrl,
+        changeOrigin: true,
+        pathRewrite: (path, req) => {
+            // Express router.use() strips the matched path from req.url,
+            // use originalUrl to get the full path before Express stripped it
+            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;
+        },
+        on: {
+            error: (err, req, _res, _target) => {
+                logger.error(`Proxy error for ${req.originalUrl ?? req.url}: ${err.message}`);
+                if (typeof req.next === 'function') {
+                    req.next(err);
+                }
+            }
+        }
+    };
+}
+/**
+ * Registers a proxy route for a given path.
+ *
+ * @param {string} path - Path to register.
+ * @param {string} destinationUrl - Target URL for proxying.
+ * @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);
+    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}`);
+}
+/**
+ * Sets up all proxy routes for the configured paths.
+ *
+ * @param {string[]} paths - Array of paths to register.
+ * @param {string} destinationUrl - Target URL for proxying.
+ * @param {OAuthTokenProvider} tokenProvider - Token provider instance.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {Router} Configured Express router.
+ */
+function setupProxyRoutes(paths, destinationUrl, tokenProvider, logger) {
+    const router = (0, express_1.Router)();
+    for (const path of paths) {
+        try {
+            registerProxyRoute(path, destinationUrl, tokenProvider, logger, router);
+        }
+        catch (e) {
+            throw new Error(`Failed to register proxy for ${path}. Check configuration in yaml file. \n\t${e.message}`);
+        }
+    }
+    return router;
+}
+//# sourceMappingURL=proxy.js.map

package/dist/token/factory.d.ts

@@ -0,0 +1,41 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { ServiceKeys } from '@sap-ux/adp-tooling';
+import { OAuthTokenProvider } from './provider';
+import type { CfOAuthMiddlewareConfig } from '../types';
+/**
+ * Creates an OAuthTokenProvider from service keys (extracted from Cloud Foundry service instance).
+ *
+ * @param {ServiceKeys} serviceKeys - Service keys containing UAA information.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {OAuthTokenProvider} OAuthTokenProvider instance.
+ * @throws {Error} If service keys are invalid.
+ */
+export declare function createManagerFromServiceKeys(serviceKeys: ServiceKeys, logger: ToolsLogger): OAuthTokenProvider;
+/**
+ * Creates an OAuthTokenProvider from direct OAuth credentials (provided in configuration).
+ *
+ * @param {string} clientId - OAuth2 client ID.
+ * @param {string} clientSecret - OAuth2 client secret.
+ * @param {string} baseUrl - Base URL for the OAuth service (token endpoint will be constructed as {baseUrl}/oauth/token).
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {OAuthTokenProvider} OAuthTokenProvider instance.
+ */
+export declare function createManagerFromDirectCredentials(clientId: string, clientSecret: string, baseUrl: string, logger: ToolsLogger): OAuthTokenProvider;
+/**
+ * Creates an OAuth token provider based on configuration.
+ *
+ * @param {CfOAuthMiddlewareConfig} config - Configuration options.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {Promise<OAuthTokenProvider>} Token provider instance.
+ * @throws {Error} If token provider cannot be created.
+ */
+export declare function createTokenProvider(config: CfOAuthMiddlewareConfig, logger: ToolsLogger): Promise<OAuthTokenProvider>;
+/**
+ * Creates an OAuthTokenProvider from CF ADP project configuration (auto-detection).
+ *
+ * @param {string} projectPath - Path to the project root.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {Promise<OAuthTokenProvider>} Token provider instance.
+ */
+export declare function createManagerFromCfAdpProject(projectPath: string, logger: ToolsLogger): Promise<OAuthTokenProvider>;
+//# sourceMappingURL=factory.d.ts.map

package/dist/token/factory.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createManagerFromServiceKeys = createManagerFromServiceKeys;
+exports.createManagerFromDirectCredentials = createManagerFromDirectCredentials;
+exports.createTokenProvider = createTokenProvider;
+exports.createManagerFromCfAdpProject = createManagerFromCfAdpProject;
+const adp_tooling_1 = require("@sap-ux/adp-tooling");
+const project_access_1 = require("@sap-ux/project-access");
+const provider_1 = require("./provider");
+const OAUTH_TOKEN_PATH = '/oauth/token';
+/**
+ * Constructs the OAuth token endpoint URL from a base URL.
+ *
+ * @param {string} baseUrl - Base URL of the OAuth service.
+ * @returns {string} Full token endpoint URL.
+ */
+function buildTokenEndpoint(baseUrl) {
+    return `${baseUrl}${OAUTH_TOKEN_PATH}`;
+}
+/**
+ * Creates an OAuthTokenProvider from service keys (extracted from Cloud Foundry service instance).
+ *
+ * @param {ServiceKeys} serviceKeys - Service keys containing UAA information.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {OAuthTokenProvider} OAuthTokenProvider instance.
+ * @throws {Error} If service keys are invalid.
+ */
+function createManagerFromServiceKeys(serviceKeys, logger) {
+    const { uaa } = serviceKeys.credentials;
+    if (!uaa?.url) {
+        throw new Error('Invalid credentials: missing UAA URL');
+    }
+    if (!uaa?.clientid) {
+        throw new Error('Invalid credentials: missing client ID');
+    }
+    if (!uaa?.clientsecret) {
+        throw new Error('Invalid credentials: missing client secret');
+    }
+    const tokenEndpoint = buildTokenEndpoint(uaa.url);
+    return new provider_1.OAuthTokenProvider(uaa.clientid, uaa.clientsecret, tokenEndpoint, logger);
+}
+/**
+ * Creates an OAuthTokenProvider from direct OAuth credentials (provided in configuration).
+ *
+ * @param {string} clientId - OAuth2 client ID.
+ * @param {string} clientSecret - OAuth2 client secret.
+ * @param {string} baseUrl - Base URL for the OAuth service (token endpoint will be constructed as {baseUrl}/oauth/token).
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {OAuthTokenProvider} OAuthTokenProvider instance.
+ */
+function createManagerFromDirectCredentials(clientId, clientSecret, baseUrl, logger) {
+    const tokenEndpoint = buildTokenEndpoint(baseUrl);
+    return new provider_1.OAuthTokenProvider(clientId, clientSecret, tokenEndpoint, logger);
+}
+/**
+ * Creates an OAuth token provider based on configuration.
+ *
+ * @param {CfOAuthMiddlewareConfig} config - Configuration options.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {Promise<OAuthTokenProvider>} Token provider instance.
+ * @throws {Error} If token provider cannot be created.
+ */
+async function createTokenProvider(config, logger) {
+    if (config.credentials) {
+        logger.info('Initializing backend proxy middleware (CF) with provided credentials');
+        const { clientId, clientSecret, url } = config.credentials;
+        return createManagerFromDirectCredentials(clientId, clientSecret, url, logger);
+    }
+    logger.info('Attempting to auto-detect CF ADP project for OAuth credentials');
+    const tokenProvider = await createManagerFromCfAdpProject(process.cwd(), logger);
+    logger.info('CF ADP project detected, OAuth middleware enabled');
+    return tokenProvider;
+}
+/**
+ * Creates an OAuthTokenProvider from CF ADP project configuration (auto-detection).
+ *
+ * @param {string} projectPath - Path to the project root.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @returns {Promise<OAuthTokenProvider>} Token provider instance.
+ */
+async function createManagerFromCfAdpProject(projectPath, logger) {
+    const buildTask = (0, adp_tooling_1.extractCfBuildTask)(await (0, project_access_1.readUi5Yaml)(projectPath, project_access_1.FileName.Ui5Yaml));
+    const name = buildTask.serviceInstanceName;
+    const guid = buildTask.serviceInstanceGuid;
+    if (!name || !guid) {
+        throw new Error('No service instance name or guid found in CF adaptation project build task');
+    }
+    const credentials = await (0, adp_tooling_1.getOrCreateServiceKeys)({
+        name,
+        guid
+    }, logger);
+    if (!credentials || credentials.length === 0) {
+        throw new Error('No service keys found for CF ADP project');
+    }
+    return createManagerFromServiceKeys(credentials[0], logger);
+}
+//# sourceMappingURL=factory.js.map

package/dist/token/index.d.ts

@@ -0,0 +1,3 @@
+export { OAuthTokenProvider } from './provider';
+export { createTokenProvider } from './factory';
+//# sourceMappingURL=index.d.ts.map

package/dist/token/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTokenProvider = exports.OAuthTokenProvider = void 0;
+var provider_1 = require("./provider");
+Object.defineProperty(exports, "OAuthTokenProvider", { enumerable: true, get: function () { return provider_1.OAuthTokenProvider; } });
+var factory_1 = require("./factory");
+Object.defineProperty(exports, "createTokenProvider", { enumerable: true, get: function () { return factory_1.createTokenProvider; } });
+//# sourceMappingURL=index.js.map

package/dist/token/provider.d.ts

@@ -0,0 +1,42 @@
+import type { Request, Response, NextFunction } from 'express';
+import type { ToolsLogger } from '@sap-ux/logger';
+/**
+ * Provides OAuth2 tokens with caching and automatic refresh.
+ */
+export declare class OAuthTokenProvider {
+    private readonly clientId;
+    private readonly clientSecret;
+    private readonly tokenEndpoint;
+    private readonly logger;
+    private token;
+    private tokenExpiry;
+    private tokenFetchPromise;
+    /**
+     * Creates a new OAuthTokenProvider instance.
+     *
+     * @param {string} clientId - OAuth2 client ID.
+     * @param {string} clientSecret - OAuth2 client secret.
+     * @param {string} tokenEndpoint - OAuth2 token endpoint URL.
+     * @param {ToolsLogger} logger - Logger instance.
+     */
+    constructor(clientId: string, clientSecret: string, tokenEndpoint: string, logger: ToolsLogger);
+    /**
+     * Get a valid OAuth token, refreshing if necessary.
+     *
+     * @returns {Promise<string>} The access token.
+     */
+    private getAccessToken;
+    /**
+     * Fetches a new OAuth2 token from the token endpoint.
+     *
+     * @returns {Promise<string>} The access token.
+     */
+    private fetchToken;
+    /**
+     * Creates an Express middleware function that adds OAuth Bearer token to requests.
+     *
+     * @returns {RequestHandler} Express middleware function.
+     */
+    createTokenMiddleware(): (req: Request, res: Response, next: NextFunction) => Promise<void>;
+}
+//# sourceMappingURL=provider.d.ts.map

package/dist/token/provider.js

@@ -0,0 +1,109 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OAuthTokenProvider = void 0;
+const axios_1 = __importDefault(require("axios"));
+/**
+ * Number of seconds before token expiry to refresh the token (safety buffer).
+ */
+const TOKEN_REFRESH_BUFFER_SECONDS = 60;
+/**
+ * Provides OAuth2 tokens with caching and automatic refresh.
+ */
+class OAuthTokenProvider {
+    clientId;
+    clientSecret;
+    tokenEndpoint;
+    logger;
+    token = null;
+    tokenExpiry = 0;
+    tokenFetchPromise = null;
+    /**
+     * Creates a new OAuthTokenProvider instance.
+     *
+     * @param {string} clientId - OAuth2 client ID.
+     * @param {string} clientSecret - OAuth2 client secret.
+     * @param {string} tokenEndpoint - OAuth2 token endpoint URL.
+     * @param {ToolsLogger} logger - Logger instance.
+     */
+    constructor(clientId, clientSecret, tokenEndpoint, logger) {
+        this.clientId = clientId;
+        this.clientSecret = clientSecret;
+        this.tokenEndpoint = tokenEndpoint;
+        this.logger = logger;
+    }
+    /**
+     * Get a valid OAuth token, refreshing if necessary.
+     *
+     * @returns {Promise<string>} The access token.
+     */
+    async getAccessToken() {
+        if (this.token && Date.now() < this.tokenExpiry) {
+            return this.token;
+        }
+        // If a token fetch is already in progress, wait for it
+        if (this.tokenFetchPromise) {
+            return this.tokenFetchPromise;
+        }
+        this.tokenFetchPromise = this.fetchToken();
+        try {
+            const token = await this.tokenFetchPromise;
+            return token;
+        }
+        finally {
+            // Clear the promise so future requests can start a new fetch if needed
+            this.tokenFetchPromise = null;
+        }
+    }
+    /**
+     * Fetches a new OAuth2 token from the token endpoint.
+     *
+     * @returns {Promise<string>} The access token.
+     */
+    async fetchToken() {
+        try {
+            this.logger.debug('Fetching new OAuth2 token...');
+            const formData = new URLSearchParams({
+                grant_type: 'client_credentials',
+                client_id: this.clientId,
+                client_secret: this.clientSecret
+            });
+            const response = await axios_1.default.post(this.tokenEndpoint, formData.toString(), {
+                headers: {
+                    'Content-Type': 'application/x-www-form-urlencoded'
+                }
+            });
+            this.token = response.data.access_token;
+            const expiresIn = response.data.expires_in ?? 3600;
+            this.tokenExpiry = Date.now() + (expiresIn - TOKEN_REFRESH_BUFFER_SECONDS) * 1000;
+            this.logger.debug(`OAuth2 token obtained successfully (expires in ${expiresIn}s)`);
+            return this.token ?? '';
+        }
+        catch (e) {
+            throw new Error(`Failed to fetch OAuth2 token: ${e.message}`);
+        }
+    }
+    /**
+     * Creates an Express middleware function that adds OAuth Bearer token to requests.
+     *
+     * @returns {RequestHandler} Express middleware function.
+     */
+    createTokenMiddleware() {
+        return async (req, _res, next) => {
+            this.logger.debug(`Token middleware: req.url=${req.url}, req.originalUrl=${req.originalUrl}`);
+            try {
+                const token = await this.getAccessToken();
+                req.headers.authorization = `Bearer ${token}`;
+                this.logger.debug(`Added Bearer token to request: ${req.url}`);
+            }
+            catch (e) {
+                this.logger.error(`Failed to get access token: ${e.message}`);
+            }
+            next();
+        };
+    }
+}
+exports.OAuthTokenProvider = OAuthTokenProvider;
+//# sourceMappingURL=provider.js.map

package/dist/types.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Configuration for Cloud Foundry OAuth middleware.
+ */
+export interface CfOAuthMiddlewareConfig {
+    /**
+     * Destination URL to proxy requests to.
+     */
+    url: string;
+    /**
+     * Array of OData source paths to proxy to this destination.
+     * Each path represents an OData service that should be proxied to the destination URL.
+     * Requests matching these paths will have the path prefix removed before forwarding.
+     */
+    paths: string[];
+    /**
+     * Manual OAuth credentials (optional).
+     * If not provided, middleware will attempt to auto-detect from Cloud Foundry ADP project.
+     */
+    credentials?: {
+        /**
+         * OAuth2 client ID.
+         */
+        clientId: string;
+        /**
+         * OAuth2 client secret.
+         */
+        clientSecret: string;
+        /**
+         * Base URL for the OAuth token endpoint.
+         * The token endpoint will be constructed as: {url}/oauth/token
+         */
+        url: string;
+    };
+    /**
+     * Enable debug logging.
+     */
+    debug?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/validation.d.ts

@@ -0,0 +1,11 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { CfOAuthMiddlewareConfig } from './types';
+/**
+ * Validates the middleware configuration.
+ *
+ * @param {CfOAuthMiddlewareConfig} config - Configuration to validate.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @throws {Error} If configuration is invalid.
+ */
+export declare function validateConfig(config: CfOAuthMiddlewareConfig, logger: ToolsLogger): Promise<void>;
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConfig = validateConfig;
+const adp_tooling_1 = require("@sap-ux/adp-tooling");
+/**
+ * Validates the middleware configuration.
+ *
+ * @param {CfOAuthMiddlewareConfig} config - Configuration to validate.
+ * @param {ToolsLogger} logger - Logger instance.
+ * @throws {Error} If configuration is invalid.
+ */
+async function validateConfig(config, logger) {
+    if (!config.url) {
+        throw new Error('Backend proxy middleware (CF) requires url configuration.');
+    }
+    if (!config.paths || !Array.isArray(config.paths) || config.paths.length === 0) {
+        throw new Error('Backend proxy middleware (CF) has no paths configured.');
+    }
+    const cfConfig = (0, adp_tooling_1.loadCfConfig)(logger);
+    if (!(await (0, adp_tooling_1.isLoggedInCf)(cfConfig, logger))) {
+        throw new Error('User is not logged in to Cloud Foundry.');
+    }
+}
+//# sourceMappingURL=validation.js.map

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@sap-ux/backend-proxy-middleware-cf",
+  "description": "OAuth2 Bearer token middleware for Cloud Foundry adaptation projects",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/backend-proxy-middleware-cf"
+  },
+  "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.2",
+  "license": "Apache-2.0",
+  "author": "@SAP/ux-tools-team",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "ui5.yaml",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "axios": "1.12.2",
+    "http-proxy-middleware": "3.0.5",
+    "@sap-ux/adp-tooling": "0.18.12",
+    "@sap-ux/logger": "0.7.1",
+    "@sap-ux/project-access": "1.32.11"
+  },
+  "devDependencies": {
+    "@types/express": "4.17.21",
+    "@types/http-proxy": "^1.17.5",
+    "@types/supertest": "2.0.12",
+    "express": "4.21.2",
+    "nock": "13.4.0",
+    "supertest": "7.1.4",
+    "connect": "^3.7.0",
+    "@types/connect": "^3.4.38"
+  },
+  "engines": {
+    "node": ">=20.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc --watch",
+    "clean": "rimraf --glob dist test/test-output coverage *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors"
+  }
+}

package/ui5.yaml

@@ -0,0 +1,7 @@
+specVersion: '2.6'
+metadata:
+    name: backend-proxy-middleware-cf
+kind: extension
+type: server-middleware
+middleware:
+    path: dist/middleware.js