@sap-ux/backend-proxy-middleware 0.10.1 → 0.10.3

package/dist/base/proxy.d.ts

@@ -1,13 +1,14 @@
-import type { ServerOptions } from 'http-proxy';
-import type { RequestHandler, Options } from 'http-proxy-middleware';
-import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
 import { ToolsLogger, type Logger } from '@sap-ux/logger';
+import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
+import type { ServerOptions } from 'http-proxy';
+import type { Options, RequestHandler } from 'http-proxy-middleware';
 import type { BackendConfig, DestinationBackendConfig } from './types';
 import type { BackendSystem } from '@sap-ux/store';
-import type { Url } from 'node:url';
-import type { Socket } from 'node:net';
-import type { Request } from 'express';
+import { AuthenticationType } from '@sap-ux/store';
 import type connect from 'connect';
+import type { Request } from 'express';
+import type { Socket } from 'node:net';
+import type { Url } from 'node:url';
 export type EnhancedIncomingMessage = (IncomingMessage & Pick<Request, 'originalUrl'>) | connect.IncomingMessage;
 /**
  * Collection of custom event handler for the proxy.
@@ -50,6 +51,13 @@ export declare function proxyErrorHandler(err: Error & {
  * Collection of path rewrite functions.
  */
 export declare const PathRewriters: {
+    /**
+     * Generates a rewrite function that replaces the matched string with '/manifest.json'.
+     *
+     * @param bspPath the bsp path from the yaml config
+     * @returns a path rewrite function
+     */
+    convertAppDescriptorToManifest(bspPath: string): (path: string) => string;
     /**
      * Generates a rewrite function that replaces the matched string with the prefix in the given string.
      *
@@ -59,7 +67,7 @@ export declare const PathRewriters: {
      */
     replacePrefix(match: string, prefix: string): (path: string) => string;
     /**
-     * Add or replace the sap-client url parameter if missing or inocrrect in the original request path.
+     * Add or replace the sap-client url parameter if missing or incorrect in the original request path.
      *
      * @param client sap-client as string
      * @returns a path rewrite function
@@ -82,7 +90,7 @@ export declare function initI18n(): Promise<void>;
  * Enhance the proxy options and backend configurations for the usage of destinations in SAP Business Application Studio.
  *
  * @param proxyOptions reference to a proxy options object that the function will enhance
- * @param backend reference to the backend configuration that the the function may enhance
+ * @param backend reference to the backend configuration that the function may enhance
  */
 export declare function enhanceConfigsForDestination(proxyOptions: Options & {
     headers: object;
@@ -92,12 +100,12 @@ export declare function enhanceConfigsForDestination(proxyOptions: Options & {
  *
  * @param proxyOptions reference to a proxy options object that the function will enhance
  * @param system backend system information (most likely) read from the store
- * @param oAuthRequired if true then the OAuth flow is triggered to get cookies
+ * @param authType determines the authentication protocol to be used
  * @param tokenChangedCallback function to call if a new refreshToken is available
  */
 export declare function enhanceConfigForSystem(proxyOptions: Options & {
     headers: object;
-}, system: BackendSystem | undefined, oAuthRequired: boolean | undefined, tokenChangedCallback: (refreshToken?: string) => void): Promise<void>;
+}, system: BackendSystem | undefined, authType: AuthenticationType, tokenChangedCallback: (refreshToken?: string) => void): Promise<void>;
 /**
  * Generate options for the proxy middleware based on the input.
  *

package/dist/base/proxy.js

@@ -10,17 +10,17 @@ exports.enhanceConfigsForDestination = enhanceConfigsForDestination;
 exports.enhanceConfigForSystem = enhanceConfigForSystem;
 exports.generateProxyMiddlewareOptions = generateProxyMiddlewareOptions;
 exports.createProxy = createProxy;
-const https_proxy_agent_1 = require("https-proxy-agent");
-const http_proxy_middleware_1 = require("http-proxy-middleware");
-const i18next_1 = __importDefault(require("i18next"));
-const logger_1 = require("@sap-ux/logger");
 const axios_extension_1 = require("@sap-ux/axios-extension");
 const btp_utils_1 = require("@sap-ux/btp-utils");
+const logger_1 = require("@sap-ux/logger");
+const http_proxy_middleware_1 = require("http-proxy-middleware");
+const https_proxy_agent_1 = require("https-proxy-agent");
+const i18next_1 = __importDefault(require("i18next"));
 const i18n_json_1 = __importDefault(require("./i18n.json"));
 const store_1 = require("@sap-ux/store");
-const config_1 = require("./config");
-const bsp_1 = require("../ext/bsp");
 const proxy_from_env_1 = require("proxy-from-env");
+const bsp_1 = require("../ext/bsp");
+const config_1 = require("./config");
 /**
  * Collection of custom event handler for the proxy.
  */
@@ -107,6 +107,16 @@ async function getApiHubKey(logger) {
  * Collection of path rewrite functions.
  */
 exports.PathRewriters = {
+    /**
+     * Generates a rewrite function that replaces the matched string with '/manifest.json'.
+     *
+     * @param bspPath the bsp path from the yaml config
+     * @returns a path rewrite function
+     */
+    convertAppDescriptorToManifest(bspPath) {
+        const regex = new RegExp('(' + bspPath + '/manifest\\.appdescr\\b)');
+        return (path) => (path.match(regex) ? '/manifest.json' : path);
+    },
     /**
      * Generates a rewrite function that replaces the matched string with the prefix in the given string.
      *
@@ -118,7 +128,7 @@ exports.PathRewriters = {
         return (path) => path.replace(match, prefix.replace(/\/$/, ''));
     },
     /**
-     * Add or replace the sap-client url parameter if missing or inocrrect in the original request path.
+     * Add or replace the sap-client url parameter if missing or incorrect in the original request path.
      *
      * @param client sap-client as string
      * @returns a path rewrite function
@@ -154,6 +164,9 @@ exports.PathRewriters = {
         if (config.client) {
             functions.push(exports.PathRewriters.replaceClient(config.client));
         }
+        if (config.bsp) {
+            functions.push(exports.PathRewriters.convertAppDescriptorToManifest(config.bsp));
+        }
         if (functions.length > 0) {
             return (path, req) => {
                 let newPath = path;
@@ -199,7 +212,7 @@ async function initI18n() {
  * Enhance the proxy options and backend configurations for the usage of destinations in SAP Business Application Studio.
  *
  * @param proxyOptions reference to a proxy options object that the function will enhance
- * @param backend reference to the backend configuration that the the function may enhance
+ * @param backend reference to the backend configuration that the function may enhance
  */
 async function enhanceConfigsForDestination(proxyOptions, backend) {
     proxyOptions.target = (0, btp_utils_1.getDestinationUrlForAppStudio)(backend.destination);
@@ -226,11 +239,11 @@ async function enhanceConfigsForDestination(proxyOptions, backend) {
  *
  * @param proxyOptions reference to a proxy options object that the function will enhance
  * @param system backend system information (most likely) read from the store
- * @param oAuthRequired if true then the OAuth flow is triggered to get cookies
+ * @param authType determines the authentication protocol to be used
  * @param tokenChangedCallback function to call if a new refreshToken is available
  */
-async function enhanceConfigForSystem(proxyOptions, system, oAuthRequired, tokenChangedCallback) {
-    if (oAuthRequired) {
+async function enhanceConfigForSystem(proxyOptions, system, authType, tokenChangedCallback) {
+    if (authType === store_1.AuthenticationType.OAuth2RefreshToken) {
         if (system?.serviceKeys) {
             const provider = (0, axios_extension_1.createForAbapOnCloud)({
                 environment: axios_extension_1.AbapCloudEnvironment.Standalone,
@@ -242,10 +255,10 @@ async function enhanceConfigForSystem(proxyOptions, system, oAuthRequired, token
             await provider.getAtoInfo();
         }
         else {
-            throw new Error('Cannot connect to ABAP Environment on BTP without service keys.');
+            throw new Error('Cannot connect to ABAP Environment on BTP using OAuth without service keys.');
         }
     }
-    else if (system?.authenticationType === store_1.AuthenticationType.ReentranceTicket) {
+    else if (system && authType === store_1.AuthenticationType.ReentranceTicket) {
         const provider = (0, axios_extension_1.createForAbapOnCloud)({
             ignoreCertErrors: proxyOptions.secure === false,
             environment: axios_extension_1.AbapCloudEnvironment.EmbeddedSteampunk,
@@ -296,33 +309,7 @@ async function generateProxyMiddlewareOptions(backend, options = {}, logger = ne
         }
     }
     else {
-        const localBackend = backend;
-        // check if system credentials are stored in the store
-        try {
-            const systemStore = await (0, store_1.getService)({ logger, entityName: 'system' });
-            const system = (await systemStore.read(new store_1.BackendSystemKey({ url: localBackend.url, client: localBackend.client }))) ?? {
-                name: '<unknown>',
-                url: localBackend.url,
-                authenticationType: localBackend.authenticationType
-            };
-            await enhanceConfigForSystem(proxyOptions, system, backend.scp, (refreshToken, accessToken) => {
-                if (refreshToken) {
-                    logger.info('Updating refresh token for: ' + localBackend.url);
-                    systemStore.write({ ...system, refreshToken }).catch((error) => logger.error(error));
-                }
-                if (accessToken) {
-                    logger.info('Setting access token');
-                    proxyOptions.headers['authorization'] = `bearer ${accessToken}`;
-                }
-                else {
-                    logger.warn('Setting of access token failed.');
-                }
-            });
-        }
-        catch (error) {
-            logger.warn('Accessing the credentials store failed.');
-            logger.debug(error);
-        }
+        await updateProxyConfigFromStore(backend, logger, proxyOptions);
     }
     if (!proxyOptions.auth && process.env.FIORI_TOOLS_USER && process.env.FIORI_TOOLS_PASSWORD) {
         proxyOptions.auth = `${process.env.FIORI_TOOLS_USER}:${process.env.FIORI_TOOLS_PASSWORD}`;
@@ -348,6 +335,44 @@ async function generateProxyMiddlewareOptions(backend, options = {}, logger = ne
     logger.info(`Backend proxy created for ${proxyOptions.target}`);
     return proxyOptions;
 }
+/**
+ * Determine the correct authentication configuration for connections from a non-BAS platform.
+ *
+ * @param backend the backend config loaded from the yaml config
+ * @param logger a logger instance
+ * @param proxyOptions additional proxy header, request and response settings
+ */
+async function updateProxyConfigFromStore(backend, logger, proxyOptions) {
+    const localBackend = backend;
+    // check if system credentials are stored in the store
+    try {
+        const systemStore = await (0, store_1.getService)({ logger, entityName: 'system' });
+        const system = (await systemStore.read(new store_1.BackendSystemKey({ url: localBackend.url, client: localBackend.client }))) ?? {
+            name: '<unknown>',
+            url: localBackend.url,
+            authenticationType: localBackend.authenticationType
+        };
+        // Auth type is determined from app config as we may have multiple stored systems with the same url/client using different auth types
+        await enhanceConfigForSystem(proxyOptions, system, localBackend.authenticationType ??
+            (localBackend.scp ? store_1.AuthenticationType.OAuth2RefreshToken : store_1.AuthenticationType.Basic), (refreshToken, accessToken) => {
+            if (refreshToken) {
+                logger.info('Updating refresh token for: ' + localBackend.url);
+                systemStore.write({ ...system, refreshToken }).catch((error) => logger.error(error));
+            }
+            if (accessToken) {
+                logger.info('Setting access token');
+                proxyOptions.headers['authorization'] = `bearer ${accessToken}`;
+            }
+            else {
+                logger.warn('Setting of access token failed.');
+            }
+        });
+    }
+    catch (error) {
+        logger.warn('Accessing the credentials store failed.');
+        logger.debug(error);
+    }
+}
 /**
  * Generate an instance of the proxy middleware based on the input.
  *

package/dist/ext/bsp.d.ts

@@ -1,12 +1,5 @@
 import type { Options } from 'http-proxy-middleware';
 import type { Logger } from '@sap-ux/logger';
-/**
- * Replace calls to manifest.appdescr file if we are running the FLP embedded flow.
- *
- * @param bsp path of the BSP page
- * @returns a path rewrite function
- */
-export declare function convertAppDescriptorToManifest(bsp: string): (path: string) => string;
 /**
  * Prompts the user for credentials.
  *

package/dist/ext/bsp.js

@@ -3,23 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertAppDescriptorToManifest = convertAppDescriptorToManifest;
 exports.promptUserPass = promptUserPass;
 exports.addOptionsForEmbeddedBSP = addOptionsForEmbeddedBSP;
 const chalk_1 = require("chalk");
 const i18next_1 = __importDefault(require("i18next"));
 const prompts_1 = __importDefault(require("prompts"));
 const btp_utils_1 = require("@sap-ux/btp-utils");
-/**
- * Replace calls to manifest.appdescr file if we are running the FLP embedded flow.
- *
- * @param bsp path of the BSP page
- * @returns a path rewrite function
- */
-function convertAppDescriptorToManifest(bsp) {
-    const regex = new RegExp('(' + bsp + '/manifest\\.appdescr\\b)');
-    return (path) => (path.match(regex) ? '/manifest.json' : path);
-}
 /**
  * Prompts the user for credentials.
  *
@@ -98,14 +87,6 @@ async function addOptionsForEmbeddedBSP(bspPath, proxyOptions, logger) {
             return undefined;
         }
     };
-    if (proxyOptions.pathRewrite) {
-        const oldRewrite = proxyOptions.pathRewrite;
-        const appDescrRewrite = convertAppDescriptorToManifest(bspPath);
-        proxyOptions.pathRewrite = (path) => appDescrRewrite(oldRewrite(path));
-    }
-    else {
-        proxyOptions.pathRewrite = convertAppDescriptorToManifest(bspPath);
-    }
     if (!proxyOptions.auth) {
         proxyOptions.auth = await promptUserPass(logger);
     }

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.10.1",
+  "version": "0.10.3",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -28,10 +28,10 @@
     "i18next": "25.3.0",
     "prompts": "2.4.2",
     "proxy-from-env": "1.1.0",
-    "@sap-ux/axios-extension": "1.22.10",
+    "@sap-ux/axios-extension": "1.23.0",
     "@sap-ux/btp-utils": "1.1.4",
     "@sap-ux/logger": "0.7.0",
-    "@sap-ux/store": "1.1.5"
+    "@sap-ux/store": "1.2.0"
   },
   "devDependencies": {
     "@types/express": "4.17.21",