@sap-ux/backend-proxy-middleware-cf 0.0.99 → 0.1.1

package/dist/token/factory.js

@@ -1,97 +0,0 @@
-"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

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

package/dist/token/index.js

@@ -1,8 +0,0 @@
-"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

@@ -1,42 +0,0 @@
-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

@@ -1,109 +0,0 @@
-"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/validation.d.ts

@@ -1,11 +0,0 @@
-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

@@ -1,30 +0,0 @@
-"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.backends || !Array.isArray(config.backends) || config.backends.length === 0) {
-        throw new Error('Backend proxy middleware (CF) requires "backends" array configuration.');
-    }
-    // Validate each backend
-    for (const backend of config.backends) {
-        if (!backend.url) {
-            throw new Error('Backend proxy middleware (CF) requires url for each backend.');
-        }
-        if (!backend.paths || !Array.isArray(backend.paths) || backend.paths.length === 0) {
-            throw new Error(`Backend proxy middleware (CF) has no paths configured for URL: ${backend.url}`);
-        }
-    }
-    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