@sap-ux/backend-proxy-middleware 0.5.0

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,153 @@
+#  `@sap-ux/backend-proxy-middleware`
+
+The `@sap-ux/backend-proxy-middleware` is a [Custom UI5 Server Middleware](https://sap.github.io/ui5-tooling/pages/extensibility/CustomServerMiddleware) for proxying requests to backend servers. The middleware is agnostic to running in local environments and SAP Business Application Studio. Additionally, if credentials are maintained with the SAP Fiori tools then these will be used.
+
+It can be used either with the `ui5 serve` or the `fiori run` commands.
+
+## Configuration Options
+
+### `backend`
+| Option        | Type | Description |
+| ------------- | ------------- | ----------- |
+| `url`         | `string` mandatory (local)  | Mandatory URL pointing to the backend system. *Not required if destination is provided and the proxy is running SAP Business Application Studio |
+| `destination` | `string` mandatory (if no url) | Required if the backend system is available as destination in SAP Business Application Studio. |
+| `destinationInstance` | `string` optional | If a destination needs to be read by a specific instance of a destination service then you need to provide the id of the service as optional property `destinationInstance`.|
+| `path`        | `string` mandatory     | Path that is to be proxied |
+| `pathReplace`  | `string` optional      | If provided then the path will be replaced with this value before forwarding |
+| `client`      | `string` optional      | sap-client parameter |
+| `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.
+
+Additional optional experimental property `bsp` (type `string`): The BSP property is only needed for the FLP Embedded Flow. The property refers to the BSP Application Name. In that case, we need to redirect the manifest.appdescr request to the local manifest.json in order to overwrite the deployed application with the local one.
+
+### `options`
+Optional object that can be used to directly set options of the used `http-proxy-middleware` modules (https://www.npmjs.com/package/http-proxy-middleware#http-proxy-middleware-options). Note: only declarative options (i.e. no functions) are supported.
+
+## Configuration Examples
+
+### [Connecting to a backend system](#connecting-to-a-backend-system)
+
+Executing `ui5 serve` in your project with the configuration below in the `ui5.yaml` file would forward any request starting with the `path` parameter to the provided backend `url`.
+
+```
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    backend:
+      path: /sap
+      url: https://my.backend.example:1234
+```
+
+### [Connecting to a backend system with destination](#connecting-to-a-backend-system-with-destination)
+
+If working in SAP Business Application Studio and the backend is configured as destination then you can also provide the `destination` in the configuration. 
+If a destination needs to be read by a specific instance of a destination service then you need to provide the id of the service as optional property `destinationInstance`.
+
+```
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    backend:
+      path: /sap
+      destination: my_example_destination
+```
+
+### [Connecting to a backend system with destination and principal propagation](#connecting-to-a-backend-system-with-destination-and-principal-propagation)
+
+If the backend destination is configured to use principal propagation, then in some cases the requests might fail. If this occurs then you will need to set the optional property `xfwd` to `true`. This will add the x-forwared headers to the proxy requests.
+
+```
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    backend:
+      path: /sap
+      destination: my_example_destination
+    options:
+      xfwd: true
+```
+
+### [Connecting to the SAP Business Technology Platform](#connecting-to-the-sap-business-technology-platform)
+If you want to connect to an ABAP Environment on SAP Business Technology Platform then you will need to set the optional property `scp` to `true`. For any other target, remove this property or set it to `false`.
+
+```
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    backend:
+      path: /sap
+      url: https://my.steampunk.example:1234
+      scp: true
+```
+
+### [Connecting to the SAP API Business Hub](#connecting-to-the-sap-api-business-hub)
+If you want to connect to the SAP API Business Hub then you will need to set the optional property `apiHub` to `true`, and set the corresponding `path` and `url`, e.g.
+
+```
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    backend:
+      path: /s4hanacloud
+      url: https://api.sap.com
+      apiHub: true
+```
+
+### [Proxying WebSockets](#proxying-websockets)
+If you want the proxy to handle also WebSockets, then you need to set the optional property `ws` to `true`, e.g.
+
+```
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    backend:
+      path: /sap
+      url: https://my.backend.example:1234
+    options:
+      ws: true
+```
+
+### [Changing the path to which a request is proxied](#changing-the-path-to-which-a-request-is-proxied)
+If you want to configure the proxy to send requests from a certain path `/services/odata` to your backend (local url or destination) with a specified entry path `/my/entry/path`. Then you need to do the following:
+
+```
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    backend:
+    - path: /services/odata
+      pathReplace: /my/entry/path
+      url: https://my.backend.example:1234
+      destination: my_example_destination
+```
+
+### [Providing Proxy Configuration](#providing-proxy-configuration)
+By default the `backend-proxy-middleware` will read the proxy configuration 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. 
+**Please note: if you want to exclude any domains from the proxy then you will need to set the `noproxy` variable, e.g. `npm config set noproxy "sap.com"`**.
+
+```
+- name: backend-proxy-middleware
+  afterMiddleware: compression
+  configuration:
+    proxy: https://myproxy.example:8443
+    backend:
+    - path: /sap
+      url: https://my.backend.example:1234
+
+```
+## Programmatic Usage
+Alternatively you can only use the underlying proxy function, e.g. for the case when you want to use the `backend-proxy-middleware` functionality in your `express` server.
+
+```Typescript
+import { createProxy } from '@sap-ux/backend-proxy-middleware';
+const proxy = createProxy(backend, options);
+```
+- **config** - The backend configuration
+- **options** - Options of the [http-proxy-middleware](https://www.npmjs.com/package/http-proxy-middleware#options)
+
+## Keywords
+* Backend Proxy Middleware
+* Fiori tools
+* Fiori elements
+* SAP UI5

package/dist/base/config.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Get the effective proxy string from runtime args (highest priority), given config value or environment variables.
+ *
+ * @param proxyFromConfig - optional proxy string from configuration
+ * @returns proxy server if required, otherwise undefined
+ */
+export declare function getCorporateProxyServer(proxyFromConfig?: string): string | undefined;
+/**
+ * Checks if a host is excluded from user's corporate proxy.
+ *
+ * @param url - url to be checked
+ * @returns true if host is excluded from user's corporate server, false otherwise
+ */
+export declare const isHostExcludedFromProxy: (url: string) => boolean;
+//# sourceMappingURL=config.d.ts.map

package/dist/base/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/base/config.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAkBpF;AAED;;;;;GAKG;AACH,eAAO,MAAM,uBAAuB,QAAS,MAAM,KAAG,OAWrD,CAAC"}

package/dist/base/config.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHostExcludedFromProxy = exports.getCorporateProxyServer = void 0;
+/**
+ * Get the effective proxy string from runtime args (highest priority), given config value or environment variables.
+ *
+ * @param proxyFromConfig - optional proxy string from configuration
+ * @returns proxy server if required, otherwise undefined
+ */
+function getCorporateProxyServer(proxyFromConfig) {
+    let proxyFromArgs;
+    process.argv.forEach((arg) => {
+        if (arg.match(/proxy=/g)) {
+            proxyFromArgs = arg.split('=')[1];
+        }
+    });
+    return (proxyFromArgs ||
+        proxyFromConfig ||
+        process.env.FIORI_TOOLS_PROXY ||
+        process.env.http_proxy ||
+        process.env.HTTP_PROXY ||
+        process.env.https_proxy ||
+        process.env.HTTPS_PROXY ||
+        process.env.npm_config_proxy ||
+        process.env.npm_config_https_proxy);
+}
+exports.getCorporateProxyServer = getCorporateProxyServer;
+/**
+ * Checks if a host is excluded from user's corporate proxy.
+ *
+ * @param url - url to be checked
+ * @returns true if host is excluded from user's corporate server, false otherwise
+ */
+exports.isHostExcludedFromProxy = (url) => {
+    const noProxyConfig = process.env.no_proxy || process.env.npm_config_noproxy;
+    if (noProxyConfig === '*') {
+        return true;
+    }
+    else {
+        const host = new URL(url).host;
+        const noProxyList = noProxyConfig ? noProxyConfig.split(',') : [];
+        return !!noProxyList.find((entry) => entry.startsWith('.') ? host.endsWith(entry) : host.endsWith(`.${entry}`));
+    }
+};
+//# sourceMappingURL=config.js.map

package/dist/base/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/base/config.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,eAAwB;IAC5D,IAAI,aAAiC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACzB,IAAI,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE;YACtB,aAAa,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;SACrC;IACL,CAAC,CAAC,CAAC;IACH,OAAO,CACH,aAAa;QACb,eAAe;QACf,OAAO,CAAC,GAAG,CAAC,iBAAiB;QAC7B,OAAO,CAAC,GAAG,CAAC,UAAU;QACtB,OAAO,CAAC,GAAG,CAAC,UAAU;QACtB,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,WAAW;QACvB,OAAO,CAAC,GAAG,CAAC,gBAAgB;QAC5B,OAAO,CAAC,GAAG,CAAC,sBAAsB,CACrC,CAAC;AACN,CAAC;AAlBD,0DAkBC;AAED;;;;;GAKG;AACU,QAAA,uBAAuB,GAAG,CAAC,GAAW,EAAW,EAAE;IAC5D,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;IAC7E,IAAI,aAAa,KAAK,GAAG,EAAE;QACvB,OAAO,IAAI,CAAC;KACf;SAAM;QACH,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;QAC/B,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,OAAO,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAChC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC,CAC5E,CAAC;KACL;AACL,CAAC,CAAC"}

package/dist/base/i18n.json

@@ -0,0 +1,14 @@
+{
+    "info": {
+        "username": "Username",
+        "password": "Password",
+        "credentialsRequiredForFLP": "The FLP Embedded Preview requires credentials. Please enter your credentials below",
+        "authNeeded": "The FLP Embedded Preview might require credentials. Do you want to enter your credentials?",
+        "operationAborted": "Operation aborted by the user."
+    },
+    "error": {
+        "emptyUsername": "Username can not be empty.",
+        "emptyPassword": "Password can not be empty.",
+        "sslProxy": "You are trying to connect to a server with a self signed certificate. Please check (https://help.sap.com/viewer/17d50220bcd848aa854c9c182d65b699/Latest/en-US/4b318bede7eb4021a8be385c46c74045.html) for guidance."
+    }
+}

package/dist/base/proxy.d.ts

@@ -0,0 +1,114 @@
+/// <reference types="node" />
+import type { ServerOptions } from 'http-proxy';
+import type { RequestHandler, Options } from 'http-proxy-middleware';
+import type { ClientRequest, IncomingMessage, ServerResponse } from 'http';
+import type { Logger } from '@sap-ux/logger';
+import type { BackendConfig, DestinationBackendConfig } from './types';
+import type { BackendSystem } from '@sap-ux/store';
+import type { Url } from 'url';
+/**
+ * Collection of custom event handler for the proxy.
+ */
+export declare const ProxyEventHandlers: {
+    /**
+     * Modifies the request to the proxy server if the `FioriLaunchpad.html` is requested to add a required header.
+     *
+     * @param proxyReq request to the proxy server that can be modified
+     * @param _req (not used) original request
+     * @param _res (not used)
+     * @param _options (not used)
+     */
+    onProxyReq(proxyReq: ClientRequest, _req?: IncomingMessage | undefined, _res?: ServerResponse | undefined, _options?: ServerOptions | undefined): void;
+    /**
+     * Retrieve the set-cookie headers from the response and transform secure cookies to insecure ones.
+     *
+     * @param proxyRes request to the proxy server that can be modified
+     * @param _req (not used) original request
+     * @param _res (not used)
+     */
+    onProxyRes(proxyRes: IncomingMessage, _req?: IncomingMessage | undefined, _res?: ServerResponse | undefined): void;
+    /**
+     * Specifically handling errors due to unsigned certificates.
+     *
+     * @param err the error thrown when proxying the request or processing the response
+     * @param req request causing the error
+     * @param _res (not used)
+     * @param _target (not used)
+     */
+    onError(err: Error & {
+        code?: string;
+    }, req: IncomingMessage & {
+        next?: Function;
+    }, _res?: ServerResponse | undefined, _target?: string | Partial<Url> | undefined): void;
+};
+/**
+ * Collection of path rewrite functions.
+ */
+export declare const PathRewriters: {
+    /**
+     * Generates a rewrite funtion that replace the match string with the prefix in the given string.
+     *
+     * @param match part of the path that is to be replaced
+     * @param prefix new path that is used as replacement
+     * @returns a path rewrite function
+     */
+    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.
+     *
+     * @param client sap-client as string
+     * @returns a path rewrite function
+     */
+    replaceClient(client: string): (path: string) => string;
+    /**
+     * Create a chain of rewrite function calls based on the provided configuration.
+     *
+     * @param config backend configuration
+     * @param log logger instance
+     * @returns a path rewrite function
+     */
+    getPathRewrite(config: BackendConfig, log: Logger): ((path: string) => string) | undefined;
+};
+/**
+ * Initialize i18next with the translations for this module.
+ */
+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
+ */
+export declare function enhanceConfigsForDestination(proxyOptions: Options & {
+    headers: object;
+}, backend: DestinationBackendConfig): Promise<void>;
+/**
+ * Enhance the proxy options with information read from the store.
+ *
+ * @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 tokenChangedCallback function to call if a new refreshToken is available
+ */
+export declare function enhanceConfigForSystem(proxyOptions: Options & {
+    headers: object;
+}, system: BackendSystem, oAuthRequired: boolean | undefined, tokenChangedCallback: (refreshToken?: string) => void): Promise<void>;
+/**
+ * Generate options for the proxy middleware based on the input.
+ *
+ * @param backend backend system specific configuration
+ * @param options optional base options for the http-proxy-middleware
+ * @param logger optional logger instance
+ * @returns options for the http-proxy-middleware
+ */
+export declare function generateProxyMiddlewareOptions(backend: BackendConfig, options?: Options, logger?: Logger): Promise<Options>;
+/**
+ * Generate an instance of the proxy middleware based on the input.
+ *
+ * @param backend backend system specific configuration
+ * @param options optional base options for the http-proxy-middleware
+ * @param logger optional logger instance
+ * @returns an instance of http-proxy-middleware
+ */
+export declare function createProxy(backend: BackendConfig, options?: Options, logger?: Logger): Promise<RequestHandler>;
+//# sourceMappingURL=proxy.d.ts.map

package/dist/base/proxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.d.ts","sourceRoot":"","sources":["../../src/base/proxy.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAGrE,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAW7C,OAAO,KAAK,EAAE,aAAa,EAAE,wBAAwB,EAAsB,MAAM,SAAS,CAAC;AAG3F,OAAO,KAAK,EAA4D,aAAa,EAAE,MAAM,eAAe,CAAC;AAG7G,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,kBAAkB;IAC3B;;;;;;;OAOG;yBACkB,aAAa;IAMlC;;;;;;OAMG;yBACkB,eAAe;IAUpC;;;;;;;OAOG;iBAEM,KAAK,GAAG;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,OACzB,eAAe,GAAG;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAA;KAAE;CAkBjD,CAAC;AAqBF;;GAEG;AACH,eAAO,MAAM,aAAa;IACtB;;;;;;OAMG;yBACkB,MAAM,UAAU,MAAM,UAAU,MAAM,KAAK,MAAM;IAItE;;;;;OAKG;0BACmB,MAAM,UAAU,MAAM,KAAK,MAAM;IAWvD;;;;;;OAMG;2BACoB,aAAa,OAAO,MAAM,WAAW,MAAM,KAAK,MAAM;CAuBhF,CAAC;AAEF;;GAEG;AACH,wBAAsB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAa9C;AAED;;;;;GAKG;AACH,wBAAsB,4BAA4B,CAC9C,YAAY,EAAE,OAAO,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,EAC3C,OAAO,EAAE,wBAAwB,GAClC,OAAO,CAAC,IAAI,CAAC,CAqBf;AAED;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CACxC,YAAY,EAAE,OAAO,GAAG;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,EAC3C,MAAM,EAAE,aAAa,EACrB,aAAa,EAAE,OAAO,GAAG,SAAS,EAClC,oBAAoB,EAAE,CAAC,YAAY,CAAC,EAAE,MAAM,KAAK,IAAI,GACtD,OAAO,CAAC,IAAI,CAAC,CAgCf;AAED;;;;;;;GAOG;AACH,wBAAsB,8BAA8B,CAChD,OAAO,EAAE,aAAa,EACtB,OAAO,GAAE,OAAY,EACrB,MAAM,GAAE,MAA0B,GACnC,OAAO,CAAC,OAAO,CAAC,CAwDlB;AAED;;;;;;;GAOG;AACH,wBAAsB,WAAW,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAErH"}