@sap-ux/axios-extension 1.16.6 → 1.17.0

package/README.adoc

@@ -117,3 +117,14 @@ const metadata = await service.metadata();
 
 ```
 See more examples in link:./test/factory.test.ts[/test/factory.test.ts]
+
+## Proxy Support
+
+To enable a patched version of `https-proxy-agent`, to support `tls.connect` connections, update your environment variable with the following `TOOLSUITE_FEATURES` environment variable;
+
+```bash
+export TOOLSUITE_FEATURES=sap.ux.enablePatchProxy
+export HTTPS_PROXY=<YOUR-PROXY:PORT>
+```
+
+

package/dist/abap/lrep-service.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { Service } from '../base/service-provider';
 import type { AxiosResponse } from 'axios';
 import { Axios } from 'axios';
@@ -117,9 +116,10 @@ export declare class LayeredRepositoryService extends Axios implements Service {
      * Merge a given app descriptor variant with the stord app descriptor.
      *
      * @param appDescriptorVariant zip file containing an app descriptor variant
+     * @param workspacePath value for workspacePath URL parameter
      * @returns a promise with an object containing merged app descriptors with their id as keys.
      */
-    mergeAppDescriptorVariant(appDescriptorVariant: Buffer): Promise<{
+    mergeAppDescriptorVariant(appDescriptorVariant: Buffer, workspacePath?: string): Promise<{
         [key: string]: MergedAppDescriptor;
     }>;
     /**

package/dist/abap/lrep-service.js

@@ -62,11 +62,19 @@ class LayeredRepositoryService extends axios_1.Axios {
      * Merge a given app descriptor variant with the stord app descriptor.
      *
      * @param appDescriptorVariant zip file containing an app descriptor variant
+     * @param workspacePath value for workspacePath URL parameter
      * @returns a promise with an object containing merged app descriptors with their id as keys.
      */
-    async mergeAppDescriptorVariant(appDescriptorVariant) {
+    async mergeAppDescriptorVariant(appDescriptorVariant, workspacePath) {
+        const path = '/appdescr_variant_preview/';
+        const params = new URLSearchParams(this.defaults?.params);
+        if (workspacePath) {
+            params.append('workspacePath', workspacePath);
+        }
         try {
-            const response = await this.put('/appdescr_variant_preview/', appDescriptorVariant, {
+            const response = await this.put(path, appDescriptorVariant, {
+                paramsSerializer: (params) => decodeURIComponent(params.toString()),
+                params,
                 headers: {
                     'Content-Type': 'application/zip'
                 }

package/dist/abap/message.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getErrorMessageFromString = exports.logError = exports.prettyPrintTimeInMs = exports.prettyPrintError = exports.prettyPrintMessage = void 0;
+exports.prettyPrintTimeInMs = void 0;
+exports.prettyPrintMessage = prettyPrintMessage;
+exports.prettyPrintError = prettyPrintError;
+exports.logError = logError;
+exports.getErrorMessageFromString = getErrorMessageFromString;
 const url_1 = require("url");
 const axios_1 = require("axios");
 /**
@@ -52,7 +56,6 @@ function prettyPrintMessage({ msg, log, host, isDest = false }) {
         log.debug(msg);
     }
 }
-exports.prettyPrintMessage = prettyPrintMessage;
 /**
  * @param root0 root0
  * @param root0.host hostname
@@ -101,7 +104,6 @@ function prettyPrintError({ error, log, host, isDest }, showAllMessages = true)
         }
     }
 }
-exports.prettyPrintError = prettyPrintError;
 /**
  * Print a user friendly time string.
  *
@@ -142,7 +144,6 @@ function logError({ error, host, log, isDest }) {
         }
     }
 }
-exports.logError = logError;
 /**
  * Get ErrorMessage object from response contain an error as a string.
  *
@@ -164,5 +165,4 @@ function getErrorMessageFromString(data) {
     }
     return error;
 }
-exports.getErrorMessageFromString = getErrorMessageFromString;
 //# sourceMappingURL=message.js.map

package/dist/abap/ui5-abap-repository-service.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { type AxiosResponse, type AxiosRequestConfig } from 'axios';
 import { ODataService } from '../base/odata-service';
 /**

package/dist/auth/connection.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attachConnectionHandler = exports.Cookies = exports.defaultTimeout = exports.CSRF = void 0;
+exports.Cookies = exports.defaultTimeout = exports.CSRF = void 0;
+exports.attachConnectionHandler = attachConnectionHandler;
 const axios_1 = require("axios");
 const detect_content_type_1 = __importDefault(require("detect-content-type"));
 var CSRF;
@@ -181,5 +182,4 @@ function attachConnectionHandler(provider) {
         return response;
     });
 }
-exports.attachConnectionHandler = attachConnectionHandler;
 //# sourceMappingURL=connection.js.map

package/dist/auth/index.js

@@ -14,7 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getReentranceTicketAuthInterceptor = exports.attachReentranceTicketAuthInterceptor = exports.attachUaaAuthInterceptor = exports.attachBasicAuthInterceptor = exports.Uaa = void 0;
+exports.Uaa = void 0;
+exports.attachBasicAuthInterceptor = attachBasicAuthInterceptor;
+exports.attachUaaAuthInterceptor = attachUaaAuthInterceptor;
+exports.attachReentranceTicketAuthInterceptor = attachReentranceTicketAuthInterceptor;
+exports.getReentranceTicketAuthInterceptor = getReentranceTicketAuthInterceptor;
 const axios_1 = require("axios");
 const reentrance_ticket_1 = require("./reentrance-ticket");
 const uaa_1 = require("./uaa");
@@ -31,7 +35,6 @@ function attachBasicAuthInterceptor(provider) {
         return response;
     });
 }
-exports.attachBasicAuthInterceptor = attachBasicAuthInterceptor;
 /**
  * @param provider  Abap Service Provider
  * @param service Service Information
@@ -59,7 +62,6 @@ function attachUaaAuthInterceptor(provider, service, refreshToken, refreshTokenU
         return request;
     });
 }
-exports.attachUaaAuthInterceptor = attachUaaAuthInterceptor;
 /**
  * Get the reentrace ticket from the backend and add it to the header.
  *
@@ -73,7 +75,6 @@ function attachReentranceTicketAuthInterceptor({ provider }) {
     const ejectCallback = () => provider.interceptors.request.eject(oneTimeInterceptorId);
     oneTimeInterceptorId = provider.interceptors.request.use(getReentranceTicketAuthInterceptor({ provider, ejectCallback }));
 }
-exports.attachReentranceTicketAuthInterceptor = attachReentranceTicketAuthInterceptor;
 /**
  * Get the interceptor that fetches and uses reentrance tickets from the backend.
  *
@@ -101,5 +102,4 @@ function getReentranceTicketAuthInterceptor({ provider, ejectCallback }) {
         return request;
     };
 }
-exports.getReentranceTicketAuthInterceptor = getReentranceTicketAuthInterceptor;
 //# sourceMappingURL=index.js.map

package/dist/auth/reentrance-ticket/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getReentranceTicket = void 0;
+exports.getReentranceTicket = getReentranceTicket;
 const open = require("open");
 const connection_1 = require("../connection");
 const abap_system_1 = require("./abap-system");
@@ -31,5 +31,4 @@ async function getReentranceTicket({ backendUrl, logger, timeout = connection_1.
         open(url)?.catch((error) => logger.error(error));
     });
 }
-exports.getReentranceTicket = getReentranceTicket;
 //# sourceMappingURL=index.js.map

package/dist/auth/reentrance-ticket/redirect.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { Logger } from '@sap-ux/logger';
 import http from 'http';
 import type { ABAPSystem } from './abap-system';

package/dist/auth/reentrance-ticket/redirect.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupRedirectHandling = void 0;
+exports.setupRedirectHandling = setupRedirectHandling;
 const http_1 = __importDefault(require("http"));
 const error_1 = require("../error");
 const message_1 = require("../../abap/message");
@@ -56,5 +56,4 @@ function setupRedirectHandling({ resolve, reject, timeout, backend, logger }) {
         redirectUrl: (port) => `http://localhost:${port}${REDIRECT_PATH}`
     };
 }
-exports.setupRedirectHandling = setupRedirectHandling;
 //# sourceMappingURL=redirect.js.map

package/dist/base/odata-request-error.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ODataRequestError = exports.isAxiosError = void 0;
+exports.ODataRequestError = void 0;
+exports.isAxiosError = isAxiosError;
 /**
  * Type guard to narrow an unknown exception to the AxiosError type if it is compatible.
  *
@@ -10,7 +11,6 @@ exports.ODataRequestError = exports.isAxiosError = void 0;
 function isAxiosError(e) {
     return typeof e === 'object' && e !== null && 'isAxiosError' in e;
 }
-exports.isAxiosError = isAxiosError;
 /**
  * Error object that is to be thrown if an OData service responds with an error
  */

package/dist/factory.d.ts

@@ -5,6 +5,28 @@ import type { ProviderConfiguration } from './base/service-provider';
 import { ServiceProvider } from './base/service-provider';
 import type { ODataService } from './base/odata-service';
 import { AbapServiceProvider } from './abap';
+import { type HttpsProxyAgentOptions, HttpsProxyAgent } from 'https-proxy-agent';
+/**
+ * PatchedHttpsProxyAgent is a custom implementation of HttpsProxyAgent that allows to pass additional options, currently not supported by the original implementation when calling tls.connect
+ */
+export declare class PatchedHttpsProxyAgent<Uri extends string> extends HttpsProxyAgent<Uri> {
+    private readonly extraOptions;
+    /**
+     * Extension of the base constructor.
+     *
+     * @param proxy
+     * @param opts
+     */
+    constructor(proxy: Uri | URL, opts?: HttpsProxyAgentOptions<Uri>);
+    /**
+     * Performs transparent encryption of written data and all required TLS negotiation.
+     *
+     * @param req
+     * @param opts
+     * @returns {Promise<net.Socket>}
+     */
+    connect(req: any, opts: any): Promise<import("net").Socket>;
+}
 /**
  * Create an instance of a basic service provider.
  *

package/dist/factory.js

@@ -3,7 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createServiceForUrl = exports.createForDestination = exports.createForAbapOnCloud = exports.AbapCloudEnvironment = exports.createForAbap = exports.create = void 0;
+exports.AbapCloudEnvironment = exports.PatchedHttpsProxyAgent = void 0;
+exports.create = create;
+exports.createForAbap = createForAbap;
+exports.createForAbapOnCloud = createForAbapOnCloud;
+exports.createForDestination = createForDestination;
+exports.createServiceForUrl = createServiceForUrl;
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const https_1 = require("https");
@@ -12,6 +17,38 @@ const service_provider_1 = require("./base/service-provider");
 const abap_1 = require("./abap");
 const util_1 = require("util");
 const patchTls_1 = require("./base/patchTls");
+const proxy_from_env_1 = require("proxy-from-env");
+const https_proxy_agent_1 = require("https-proxy-agent");
+const http_proxy_agent_1 = require("http-proxy-agent");
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
+/**
+ * PatchedHttpsProxyAgent is a custom implementation of HttpsProxyAgent that allows to pass additional options, currently not supported by the original implementation when calling tls.connect
+ */
+// eslint-disable-next-line jsdoc/require-jsdoc
+class PatchedHttpsProxyAgent extends https_proxy_agent_1.HttpsProxyAgent {
+    extraOptions;
+    /**
+     * Extension of the base constructor.
+     *
+     * @param proxy
+     * @param opts
+     */
+    constructor(proxy, opts) {
+        super(proxy, opts);
+        this.extraOptions = opts;
+    }
+    /**
+     * Performs transparent encryption of written data and all required TLS negotiation.
+     *
+     * @param req
+     * @param opts
+     * @returns {Promise<net.Socket>}
+     */
+    async connect(req, opts) {
+        return super.connect(req, { ...this.extraOptions, ...opts });
+    }
+}
+exports.PatchedHttpsProxyAgent = PatchedHttpsProxyAgent;
 /**
  * Create a new instance of given type and set default configuration merged with the given config.
  *
@@ -21,9 +58,21 @@ const patchTls_1 = require("./base/patchTls");
  */
 function createInstance(ProviderType, config) {
     const providerConfig = (0, cloneDeep_1.default)(config);
-    providerConfig.httpsAgent = new https_1.Agent({
+    const agentOptions = {
         rejectUnauthorized: !providerConfig.ignoreCertErrors
-    });
+    };
+    const localProxy = (0, proxy_from_env_1.getProxyForUrl)(config.baseURL);
+    const isPatchProxyEnabled = (0, feature_toggle_1.isFeatureEnabled)('sap.ux.enablePatchProxy');
+    if (isPatchProxyEnabled && localProxy) {
+        // axios doesn't handle proxies correctly, instead use a custom agent with axios proxy disabled
+        providerConfig.httpsAgent = new PatchedHttpsProxyAgent(localProxy, agentOptions);
+        providerConfig.httpAgent = new http_proxy_agent_1.HttpProxyAgent(localProxy);
+        providerConfig.proxy = false;
+    }
+    // Default httpsAgent with optional parameters passed to the agent
+    if (!providerConfig.httpsAgent) {
+        providerConfig.httpsAgent = new https_1.Agent(agentOptions);
+    }
     delete providerConfig.ignoreCertErrors;
     providerConfig.withCredentials = providerConfig?.auth && Object.keys(providerConfig.auth).length > 0;
     /**
@@ -73,7 +122,6 @@ function create(config) {
         return createInstance(service_provider_1.ServiceProvider, config);
     }
 }
-exports.create = create;
 /**
  * Create an instance of an ABAP service provider.
  *
@@ -83,7 +131,6 @@ exports.create = create;
 function createForAbap(config) {
     return createInstance(abap_1.AbapServiceProvider, config);
 }
-exports.createForAbap = createForAbap;
 /** Supported ABAP environments on the cloud */
 var AbapCloudEnvironment;
 (function (AbapCloudEnvironment) {
@@ -129,7 +176,6 @@ function createForAbapOnCloud(options) {
     }
     return provider;
 }
-exports.createForAbapOnCloud = createForAbapOnCloud;
 /**
  * Create an instance of a service provider for the given destination.
  *
@@ -168,7 +214,6 @@ function createForDestination(options, destination, destinationServiceInstance)
     }
     return provider;
 }
-exports.createForDestination = createForDestination;
 /**
  * Create an instance of a basic service provider and then generate an extension for a service based on the given url.
  *
@@ -187,5 +232,4 @@ function createServiceForUrl(url, config = {}) {
     const provider = createInstance(service_provider_1.ServiceProvider, config);
     return provider.service(urlObject.pathname);
 }
-exports.createServiceForUrl = createServiceForUrl;
 //# sourceMappingURL=factory.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/axios-extension",
-  "version": "1.16.6",
+  "version": "1.17.0",
   "description": "Extension of the Axios module adding convenience methods to interact with SAP systems especially with OData services.",
   "repository": {
     "type": "git",
@@ -22,14 +22,19 @@
     "qs": "6.11.0",
     "xpath": "0.0.33",
     "@xmldom/xmldom": "0.8.10",
+    "https-proxy-agent": "7.0.5",
+    "http-proxy-agent": "7.0.2",
+    "proxy-from-env": "1.1.0",
     "@sap-ux/btp-utils": "0.15.2",
-    "@sap-ux/logger": "0.6.0"
+    "@sap-ux/logger": "0.6.0",
+    "@sap-ux/feature-toggle": "0.2.2"
   },
   "devDependencies": {
     "@types/lodash": "4.14.202",
     "nock": "13.4.0",
     "supertest": "6.3.3",
-    "@sap-ux/project-access": "1.27.1"
+    "@types/proxy-from-env": "1.0.1",
+    "@sap-ux/project-access": "1.28.5"
   },
   "files": [
     "dist",