@backstage/plugin-proxy-backend 0.4.3 → 0.4.4

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @backstage/plugin-proxy-backend
 
+## 0.4.4
+
+### Patch Changes
+
+- f6c651fe3c6c: Switched to using `"exports"` field for `/alpha` subpath export.
+- Updated dependencies
+  - @backstage/backend-common@0.19.9
+  - @backstage/backend-plugin-api@0.6.7
+
 ## 0.4.3
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-proxy-backend",
-  "version": "0.4.3",
-  "main": "../dist/index.cjs.js",
-  "types": "../dist/index.alpha.d.ts"
+  "version": "0.4.4",
+  "main": "../dist/alpha.cjs.js",
+  "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -0,0 +1,35 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendCommon = require('@backstage/backend-common');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var router = require('./cjs/router-6fef2ff7.cjs.js');
+require('express-promise-router');
+require('http-proxy-middleware');
+
+var alpha = backendPluginApi.createBackendPlugin({
+  pluginId: "proxy",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.coreServices.rootConfig,
+        discovery: backendPluginApi.coreServices.discovery,
+        logger: backendPluginApi.coreServices.logger,
+        httpRouter: backendPluginApi.coreServices.httpRouter
+      },
+      async init({ config, discovery, logger, httpRouter }) {
+        httpRouter.use(
+          await router.createRouter({
+            config,
+            discovery,
+            logger: backendCommon.loggerToWinstonLogger(logger)
+          })
+        );
+      }
+    });
+  }
+});
+
+exports["default"] = alpha;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n  createBackendPlugin,\n  coreServices,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * The proxy backend plugin.\n *\n * @alpha\n */\nexport default createBackendPlugin({\n  pluginId: 'proxy',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        logger: coreServices.logger,\n        httpRouter: coreServices.httpRouter,\n      },\n      async init({ config, discovery, logger, httpRouter }) {\n        httpRouter.use(\n          await createRouter({\n            config,\n            discovery,\n            logger: loggerToWinstonLogger(logger),\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter","loggerToWinstonLogger"],"mappings":";;;;;;;;;;AA4BA,YAAeA,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,OAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,YAAYA,6BAAa,CAAA,UAAA;AAAA,OAC3B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,SAAW,EAAA,MAAA,EAAQ,YAAc,EAAA;AACpD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,WACrC,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,10 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * The proxy backend plugin.
+ *
+ * @alpha
+ */
+declare const _default: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { _default as default };

package/dist/cjs/router-6fef2ff7.cjs.js

@@ -0,0 +1,181 @@
+'use strict';
+
+var Router = require('express-promise-router');
+var httpProxyMiddleware = require('http-proxy-middleware');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
+
+const safeForwardHeaders = [
+  // https://fetch.spec.whatwg.org/#cors-safelisted-request-header
+  "cache-control",
+  "content-language",
+  "content-length",
+  "content-type",
+  "expires",
+  "last-modified",
+  "pragma",
+  // host is overridden by default. if changeOrigin is configured to false,
+  // we assume this is a intentional and should also be forwarded.
+  "host",
+  // other headers that we assume to be ok
+  "accept",
+  "accept-language",
+  "user-agent"
+];
+function buildMiddleware(pathPrefix, logger, route, config, reviveConsumedRequestBodies) {
+  var _a;
+  const fullConfig = typeof config === "string" ? { target: config } : { ...config };
+  const targetType = typeof fullConfig.target;
+  if (targetType !== "string") {
+    throw new Error(
+      `Proxy target for route "${route}" must be a string, but is of type ${targetType}`
+    );
+  }
+  try {
+    new URL(fullConfig.target);
+  } catch {
+    throw new Error(
+      `Proxy target is not a valid URL: ${(_a = fullConfig.target) != null ? _a : ""}`
+    );
+  }
+  if (fullConfig.pathRewrite === void 0) {
+    let routeWithSlash = route.endsWith("/") ? route : `${route}/`;
+    if (!pathPrefix.endsWith("/") && !routeWithSlash.startsWith("/")) {
+      routeWithSlash = `/${routeWithSlash}`;
+    } else if (pathPrefix.endsWith("/") && routeWithSlash.startsWith("/")) {
+      routeWithSlash = routeWithSlash.substring(1);
+    }
+    fullConfig.pathRewrite = {
+      [`^${pathPrefix}${routeWithSlash}?`]: "/"
+    };
+  }
+  if (fullConfig.changeOrigin === void 0) {
+    fullConfig.changeOrigin = true;
+  }
+  fullConfig.logProvider = () => logger;
+  fullConfig.logLevel = "debug";
+  const requestHeaderAllowList = new Set(
+    [
+      // allow all safe headers
+      ...safeForwardHeaders,
+      // allow all headers that are set by the proxy
+      ...fullConfig.headers && Object.keys(fullConfig.headers) || [],
+      // allow all configured headers
+      ...fullConfig.allowedHeaders || []
+    ].map((h) => h.toLocaleLowerCase())
+  );
+  const filter = (_pathname, req) => {
+    var _a2, _b;
+    const headerNames = Object.keys(req.headers);
+    headerNames.forEach((h) => {
+      if (!requestHeaderAllowList.has(h.toLocaleLowerCase())) {
+        delete req.headers[h];
+      }
+    });
+    return (_b = (_a2 = fullConfig == null ? void 0 : fullConfig.allowedMethods) == null ? void 0 : _a2.includes(req.method)) != null ? _b : true;
+  };
+  filter.toString = () => route;
+  const responseHeaderAllowList = new Set(
+    [
+      // allow all safe headers
+      ...safeForwardHeaders,
+      // allow all configured headers
+      ...fullConfig.allowedHeaders || []
+    ].map((h) => h.toLocaleLowerCase())
+  );
+  fullConfig.onProxyRes = (proxyRes) => {
+    const headerNames = Object.keys(proxyRes.headers);
+    headerNames.forEach((h) => {
+      if (!responseHeaderAllowList.has(h.toLocaleLowerCase())) {
+        delete proxyRes.headers[h];
+      }
+    });
+  };
+  if (reviveConsumedRequestBodies) {
+    fullConfig.onProxyReq = httpProxyMiddleware.fixRequestBody;
+  }
+  return httpProxyMiddleware.createProxyMiddleware(filter, fullConfig);
+}
+function readProxyConfig(config, logger) {
+  var _a, _b;
+  const endpoints = (_a = config.getOptionalConfig("proxy.endpoints")) == null ? void 0 : _a.get();
+  if (endpoints) {
+    return endpoints;
+  }
+  const root = (_b = config.getOptionalConfig("proxy")) == null ? void 0 : _b.get();
+  if (!root) {
+    return {};
+  }
+  const rootEndpoints = Object.fromEntries(
+    Object.entries(root).filter(([key]) => key.startsWith("/"))
+  );
+  if (Object.keys(rootEndpoints).length === 0) {
+    return {};
+  }
+  logger.warn(
+    "Configuring proxy endpoints in the root 'proxy' configuration is deprecated. Move this configuration to 'proxy.endpoints' instead."
+  );
+  return rootEndpoints;
+}
+async function createRouter(options) {
+  var _a, _b, _c, _d;
+  const router = Router__default["default"]();
+  let currentRouter = Router__default["default"]();
+  const skipInvalidProxies = (_b = (_a = options.skipInvalidProxies) != null ? _a : options.config.getOptionalBoolean("proxy.skipInvalidProxies")) != null ? _b : false;
+  const reviveConsumedRequestBodies = (_d = (_c = options.reviveConsumedRequestBodies) != null ? _c : options.config.getOptionalBoolean("proxy.reviveConsumedRequestBodies")) != null ? _d : false;
+  const proxyOptions = {
+    skipInvalidProxies,
+    reviveConsumedRequestBodies,
+    logger: options.logger
+  };
+  const externalUrl = await options.discovery.getExternalBaseUrl("proxy");
+  const { pathname: pathPrefix } = new URL(externalUrl);
+  const proxyConfig = readProxyConfig(options.config, options.logger);
+  configureMiddlewares(proxyOptions, currentRouter, pathPrefix, proxyConfig);
+  router.use((...args) => currentRouter(...args));
+  if (options.config.subscribe) {
+    let currentKey = JSON.stringify(proxyConfig);
+    options.config.subscribe(() => {
+      const newProxyConfig = readProxyConfig(options.config, options.logger);
+      const newKey = JSON.stringify(newProxyConfig);
+      if (currentKey !== newKey) {
+        currentKey = newKey;
+        currentRouter = Router__default["default"]();
+        configureMiddlewares(
+          proxyOptions,
+          currentRouter,
+          pathPrefix,
+          newProxyConfig
+        );
+      }
+    });
+  }
+  return router;
+}
+function configureMiddlewares(options, router, pathPrefix, proxyConfig) {
+  Object.entries(proxyConfig).forEach(([route, proxyRouteConfig]) => {
+    try {
+      router.use(
+        route,
+        buildMiddleware(
+          pathPrefix,
+          options.logger,
+          route,
+          proxyRouteConfig,
+          options.reviveConsumedRequestBodies
+        )
+      );
+    } catch (e) {
+      if (options.skipInvalidProxies) {
+        options.logger.warn(`skipped configuring ${route} due to ${e.message}`);
+      } else {
+        throw e;
+      }
+    }
+  });
+}
+
+exports.createRouter = createRouter;
+//# sourceMappingURL=router-6fef2ff7.cjs.js.map

package/dist/cjs/router-6fef2ff7.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router-6fef2ff7.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport {\n  createProxyMiddleware,\n  fixRequestBody,\n  Options,\n  RequestHandler,\n} from 'http-proxy-middleware';\nimport { Logger } from 'winston';\nimport http from 'http';\nimport { PluginEndpointDiscovery } from '@backstage/backend-common';\n\n// A list of headers that are always forwarded to the proxy targets.\nconst safeForwardHeaders = [\n  // https://fetch.spec.whatwg.org/#cors-safelisted-request-header\n  'cache-control',\n  'content-language',\n  'content-length',\n  'content-type',\n  'expires',\n  'last-modified',\n  'pragma',\n\n  // host is overridden by default. if changeOrigin is configured to false,\n  // we assume this is a intentional and should also be forwarded.\n  'host',\n\n  // other headers that we assume to be ok\n  'accept',\n  'accept-language',\n  'user-agent',\n];\n\n/** @public */\nexport interface RouterOptions {\n  logger: Logger;\n  config: Config;\n  discovery: PluginEndpointDiscovery;\n  skipInvalidProxies?: boolean;\n  reviveConsumedRequestBodies?: boolean;\n}\n\nexport interface ProxyConfig extends Options {\n  allowedMethods?: string[];\n  allowedHeaders?: string[];\n  reviveRequestBody?: boolean;\n}\n\n// Creates a proxy middleware, possibly with defaults added on top of the\n// given config.\nexport function buildMiddleware(\n  pathPrefix: string,\n  logger: Logger,\n  route: string,\n  config: string | ProxyConfig,\n  reviveConsumedRequestBodies?: boolean,\n): RequestHandler {\n  const fullConfig =\n    typeof config === 'string' ? { target: config } : { ...config };\n\n  // Validate that target is a valid URL.\n  const targetType = typeof fullConfig.target;\n  if (targetType !== 'string') {\n    throw new Error(\n      `Proxy target for route \"${route}\" must be a string, but is of type ${targetType}`,\n    );\n  }\n  try {\n    // eslint-disable-next-line no-new\n    new URL(fullConfig.target! as string);\n  } catch {\n    throw new Error(\n      `Proxy target is not a valid URL: ${fullConfig.target ?? ''}`,\n    );\n  }\n\n  // Default is to do a path rewrite that strips out the proxy's path prefix\n  // and the rest of the route.\n  if (fullConfig.pathRewrite === undefined) {\n    let routeWithSlash = route.endsWith('/') ? route : `${route}/`;\n\n    if (!pathPrefix.endsWith('/') && !routeWithSlash.startsWith('/')) {\n      // Need to insert a / between pathPrefix and routeWithSlash\n      routeWithSlash = `/${routeWithSlash}`;\n    } else if (pathPrefix.endsWith('/') && routeWithSlash.startsWith('/')) {\n      // Never expect this to happen at this point in time as\n      // pathPrefix is set using `getExternalBaseUrl` which \"Returns the\n      // external HTTP base backend URL for a given plugin,\n      // **without a trailing slash.**\". But in case this changes in future, we\n      // need to drop a / on either pathPrefix or routeWithSlash\n      routeWithSlash = routeWithSlash.substring(1);\n    }\n\n    // The ? makes the slash optional for the rewrite, so that a base path without an ending slash\n    // will also be matched (e.g. '/sample' and then requesting just '/api/proxy/sample' without an\n    // ending slash). Otherwise the target gets called with the full '/api/proxy/sample' path\n    // appended.\n    fullConfig.pathRewrite = {\n      [`^${pathPrefix}${routeWithSlash}?`]: '/',\n    };\n  }\n\n  // Default is to update the Host header to the target\n  if (fullConfig.changeOrigin === undefined) {\n    fullConfig.changeOrigin = true;\n  }\n\n  // Attach the logger to the proxy config\n  fullConfig.logProvider = () => logger;\n  // http-proxy-middleware uses this log level to check if it should log the\n  // requests that it proxies. Setting this to the most verbose log level\n  // ensures that it always logs these requests. Our logger ends up deciding\n  // if the logs are displayed or not.\n  fullConfig.logLevel = 'debug';\n\n  // Only return the allowed HTTP headers to not forward unwanted secret headers\n  const requestHeaderAllowList = new Set<string>(\n    [\n      // allow all safe headers\n      ...safeForwardHeaders,\n\n      // allow all headers that are set by the proxy\n      ...((fullConfig.headers && Object.keys(fullConfig.headers)) || []),\n\n      // allow all configured headers\n      ...(fullConfig.allowedHeaders || []),\n    ].map(h => h.toLocaleLowerCase()),\n  );\n\n  // Use the custom middleware filter to do two things:\n  //  1. Remove any headers not in the allow list to stop them being forwarded\n  //  2. Only permit the allowed HTTP methods if configured\n  //\n  // We are filtering the proxy request headers here rather than in\n  // `onProxyReq` because when global-agent is enabled then `onProxyReq`\n  // fires _after_ the agent has already sent the headers to the proxy\n  // target, causing a ERR_HTTP_HEADERS_SENT crash\n  const filter = (_pathname: string, req: http.IncomingMessage): boolean => {\n    const headerNames = Object.keys(req.headers);\n    headerNames.forEach(h => {\n      if (!requestHeaderAllowList.has(h.toLocaleLowerCase())) {\n        delete req.headers[h];\n      }\n    });\n\n    return fullConfig?.allowedMethods?.includes(req.method!) ?? true;\n  };\n  // Makes http-proxy-middleware logs look nicer and include the mount path\n  filter.toString = () => route;\n\n  // Only forward the allowed HTTP headers to not forward unwanted secret headers\n  const responseHeaderAllowList = new Set<string>(\n    [\n      // allow all safe headers\n      ...safeForwardHeaders,\n\n      // allow all configured headers\n      ...(fullConfig.allowedHeaders || []),\n    ].map(h => h.toLocaleLowerCase()),\n  );\n\n  // only forward the allowed headers in backend->client\n  fullConfig.onProxyRes = (proxyRes: http.IncomingMessage) => {\n    const headerNames = Object.keys(proxyRes.headers);\n\n    headerNames.forEach(h => {\n      if (!responseHeaderAllowList.has(h.toLocaleLowerCase())) {\n        delete proxyRes.headers[h];\n      }\n    });\n  };\n\n  if (reviveConsumedRequestBodies) {\n    fullConfig.onProxyReq = fixRequestBody;\n  }\n\n  return createProxyMiddleware(filter, fullConfig);\n}\n\nfunction readProxyConfig(config: Config, logger: Logger): unknown {\n  const endpoints = config.getOptionalConfig('proxy.endpoints')?.get();\n  if (endpoints) {\n    return endpoints;\n  }\n\n  const root = config.getOptionalConfig('proxy')?.get();\n  if (!root) {\n    return {};\n  }\n\n  const rootEndpoints = Object.fromEntries(\n    Object.entries(root).filter(([key]) => key.startsWith('/')),\n  );\n  if (Object.keys(rootEndpoints).length === 0) {\n    return {};\n  }\n\n  logger.warn(\n    \"Configuring proxy endpoints in the root 'proxy' configuration is deprecated. Move this configuration to 'proxy.endpoints' instead.\",\n  );\n\n  return rootEndpoints;\n}\n\n/**\n * Creates a new {@link https://expressjs.com/en/api.html#router | \"express router\"} that proxy each target configured under the `proxy` key of the config\n * @example\n * ```ts\n * let router = await createRouter({logger, config, discovery});\n * ```\n * @config\n * ```yaml\n * proxy:\n *  simple-example: http://simple.example.com:8080 # Opt 1 Simple URL String\n *  '/larger-example/v1': # Opt 2 `http-proxy-middleware` compatible object\n *    target: http://larger.example.com:8080/svc.v1\n *    headers:\n *      Authorization: Bearer ${EXAMPLE_AUTH_TOKEN}\n *```\n * @see https://backstage.io/docs/plugins/proxying\n * @public\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const router = Router();\n  let currentRouter = Router();\n\n  const skipInvalidProxies =\n    options.skipInvalidProxies ??\n    options.config.getOptionalBoolean('proxy.skipInvalidProxies') ??\n    false;\n  const reviveConsumedRequestBodies =\n    options.reviveConsumedRequestBodies ??\n    options.config.getOptionalBoolean('proxy.reviveConsumedRequestBodies') ??\n    false;\n  const proxyOptions = {\n    skipInvalidProxies,\n    reviveConsumedRequestBodies,\n    logger: options.logger,\n  };\n\n  const externalUrl = await options.discovery.getExternalBaseUrl('proxy');\n  const { pathname: pathPrefix } = new URL(externalUrl);\n\n  const proxyConfig = readProxyConfig(options.config, options.logger);\n  configureMiddlewares(proxyOptions, currentRouter, pathPrefix, proxyConfig);\n  router.use((...args) => currentRouter(...args));\n\n  if (options.config.subscribe) {\n    let currentKey = JSON.stringify(proxyConfig);\n\n    options.config.subscribe(() => {\n      const newProxyConfig = readProxyConfig(options.config, options.logger);\n      const newKey = JSON.stringify(newProxyConfig);\n\n      if (currentKey !== newKey) {\n        currentKey = newKey;\n        currentRouter = Router();\n        configureMiddlewares(\n          proxyOptions,\n          currentRouter,\n          pathPrefix,\n          newProxyConfig,\n        );\n      }\n    });\n  }\n\n  return router;\n}\n\nfunction configureMiddlewares(\n  options: {\n    reviveConsumedRequestBodies: boolean;\n    skipInvalidProxies: boolean;\n    logger: Logger;\n  },\n  router: express.Router,\n  pathPrefix: string,\n  proxyConfig: any,\n) {\n  Object.entries<any>(proxyConfig).forEach(([route, proxyRouteConfig]) => {\n    try {\n      router.use(\n        route,\n        buildMiddleware(\n          pathPrefix,\n          options.logger,\n          route,\n          proxyRouteConfig,\n          options.reviveConsumedRequestBodies,\n        ),\n      );\n    } catch (e) {\n      if (options.skipInvalidProxies) {\n        options.logger.warn(`skipped configuring ${route} due to ${e.message}`);\n      } else {\n        throw e;\n      }\n    }\n  });\n}\n"],"names":["_a","fixRequestBody","createProxyMiddleware","Router"],"mappings":";;;;;;;;;AA8BA,MAAM,kBAAqB,GAAA;AAAA;AAAA,EAEzB,eAAA;AAAA,EACA,kBAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,SAAA;AAAA,EACA,eAAA;AAAA,EACA,QAAA;AAAA;AAAA;AAAA,EAIA,MAAA;AAAA;AAAA,EAGA,QAAA;AAAA,EACA,iBAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAmBO,SAAS,eACd,CAAA,UAAA,EACA,MACA,EAAA,KAAA,EACA,QACA,2BACgB,EAAA;AAzElB,EAAA,IAAA,EAAA,CAAA;AA0EE,EAAM,MAAA,UAAA,GACJ,OAAO,MAAA,KAAW,QAAW,GAAA,EAAE,QAAQ,MAAO,EAAA,GAAI,EAAE,GAAG,MAAO,EAAA,CAAA;AAGhE,EAAM,MAAA,UAAA,GAAa,OAAO,UAAW,CAAA,MAAA,CAAA;AACrC,EAAA,IAAI,eAAe,QAAU,EAAA;AAC3B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wBAAA,EAA2B,KAAK,CAAA,mCAAA,EAAsC,UAAU,CAAA,CAAA;AAAA,KAClF,CAAA;AAAA,GACF;AACA,EAAI,IAAA;AAEF,IAAI,IAAA,GAAA,CAAI,WAAW,MAAiB,CAAA,CAAA;AAAA,GAC9B,CAAA,MAAA;AACN,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAoC,iCAAA,EAAA,CAAA,EAAA,GAAA,UAAA,CAAW,MAAX,KAAA,IAAA,GAAA,EAAA,GAAqB,EAAE,CAAA,CAAA;AAAA,KAC7D,CAAA;AAAA,GACF;AAIA,EAAI,IAAA,UAAA,CAAW,gBAAgB,KAAW,CAAA,EAAA;AACxC,IAAA,IAAI,iBAAiB,KAAM,CAAA,QAAA,CAAS,GAAG,CAAI,GAAA,KAAA,GAAQ,GAAG,KAAK,CAAA,CAAA,CAAA,CAAA;AAE3D,IAAI,IAAA,CAAC,WAAW,QAAS,CAAA,GAAG,KAAK,CAAC,cAAA,CAAe,UAAW,CAAA,GAAG,CAAG,EAAA;AAEhE,MAAA,cAAA,GAAiB,IAAI,cAAc,CAAA,CAAA,CAAA;AAAA,KACrC,MAAA,IAAW,WAAW,QAAS,CAAA,GAAG,KAAK,cAAe,CAAA,UAAA,CAAW,GAAG,CAAG,EAAA;AAMrE,MAAiB,cAAA,GAAA,cAAA,CAAe,UAAU,CAAC,CAAA,CAAA;AAAA,KAC7C;AAMA,IAAA,UAAA,CAAW,WAAc,GAAA;AAAA,MACvB,CAAC,CAAI,CAAA,EAAA,UAAU,CAAG,EAAA,cAAc,GAAG,GAAG,GAAA;AAAA,KACxC,CAAA;AAAA,GACF;AAGA,EAAI,IAAA,UAAA,CAAW,iBAAiB,KAAW,CAAA,EAAA;AACzC,IAAA,UAAA,CAAW,YAAe,GAAA,IAAA,CAAA;AAAA,GAC5B;AAGA,EAAA,UAAA,CAAW,cAAc,MAAM,MAAA,CAAA;AAK/B,EAAA,UAAA,CAAW,QAAW,GAAA,OAAA,CAAA;AAGtB,EAAA,MAAM,yBAAyB,IAAI,GAAA;AAAA,IACjC;AAAA;AAAA,MAEE,GAAG,kBAAA;AAAA;AAAA,MAGH,GAAK,WAAW,OAAW,IAAA,MAAA,CAAO,KAAK,UAAW,CAAA,OAAO,KAAM,EAAC;AAAA;AAAA,MAGhE,GAAI,UAAW,CAAA,cAAA,IAAkB,EAAC;AAAA,KAClC,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,mBAAmB,CAAA;AAAA,GAClC,CAAA;AAUA,EAAM,MAAA,MAAA,GAAS,CAAC,SAAA,EAAmB,GAAuC,KAAA;AA1J5E,IAAA,IAAAA,GAAA,EAAA,EAAA,CAAA;AA2JI,IAAA,MAAM,WAAc,GAAA,MAAA,CAAO,IAAK,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AAC3C,IAAA,WAAA,CAAY,QAAQ,CAAK,CAAA,KAAA;AACvB,MAAA,IAAI,CAAC,sBAAuB,CAAA,GAAA,CAAI,CAAE,CAAA,iBAAA,EAAmB,CAAG,EAAA;AACtD,QAAO,OAAA,GAAA,CAAI,QAAQ,CAAC,CAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAO,OAAA,CAAA,EAAA,GAAA,CAAAA,MAAA,UAAY,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,UAAA,CAAA,cAAA,KAAZ,gBAAAA,GAA4B,CAAA,QAAA,CAAS,GAAI,CAAA,MAAA,CAAA,KAAzC,IAAqD,GAAA,EAAA,GAAA,IAAA,CAAA;AAAA,GAC9D,CAAA;AAEA,EAAA,MAAA,CAAO,WAAW,MAAM,KAAA,CAAA;AAGxB,EAAA,MAAM,0BAA0B,IAAI,GAAA;AAAA,IAClC;AAAA;AAAA,MAEE,GAAG,kBAAA;AAAA;AAAA,MAGH,GAAI,UAAW,CAAA,cAAA,IAAkB,EAAC;AAAA,KAClC,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,mBAAmB,CAAA;AAAA,GAClC,CAAA;AAGA,EAAW,UAAA,CAAA,UAAA,GAAa,CAAC,QAAmC,KAAA;AAC1D,IAAA,MAAM,WAAc,GAAA,MAAA,CAAO,IAAK,CAAA,QAAA,CAAS,OAAO,CAAA,CAAA;AAEhD,IAAA,WAAA,CAAY,QAAQ,CAAK,CAAA,KAAA;AACvB,MAAA,IAAI,CAAC,uBAAwB,CAAA,GAAA,CAAI,CAAE,CAAA,iBAAA,EAAmB,CAAG,EAAA;AACvD,QAAO,OAAA,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA;AAAA,OAC3B;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAEA,EAAA,IAAI,2BAA6B,EAAA;AAC/B,IAAA,UAAA,CAAW,UAAa,GAAAC,kCAAA,CAAA;AAAA,GAC1B;AAEA,EAAO,OAAAC,yCAAA,CAAsB,QAAQ,UAAU,CAAA,CAAA;AACjD,CAAA;AAEA,SAAS,eAAA,CAAgB,QAAgB,MAAyB,EAAA;AApMlE,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAqME,EAAA,MAAM,SAAY,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,iBAAiB,MAA1C,IAA6C,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,GAAA,EAAA,CAAA;AAC/D,EAAA,IAAI,SAAW,EAAA;AACb,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAEA,EAAA,MAAM,IAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,MAAhC,IAAmC,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,GAAA,EAAA,CAAA;AAChD,EAAA,IAAI,CAAC,IAAM,EAAA;AACT,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAA,MAAM,gBAAgB,MAAO,CAAA,WAAA;AAAA,IAC3B,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAA,CAAE,MAAO,CAAA,CAAC,CAAC,GAAG,CAAM,KAAA,GAAA,CAAI,UAAW,CAAA,GAAG,CAAC,CAAA;AAAA,GAC5D,CAAA;AACA,EAAA,IAAI,MAAO,CAAA,IAAA,CAAK,aAAa,CAAA,CAAE,WAAW,CAAG,EAAA;AAC3C,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAO,MAAA,CAAA,IAAA;AAAA,IACL,oIAAA;AAAA,GACF,CAAA;AAEA,EAAO,OAAA,aAAA,CAAA;AACT,CAAA;AAoBA,eAAsB,aACpB,OACyB,EAAA;AAjP3B,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAkPE,EAAA,MAAM,SAASC,0BAAO,EAAA,CAAA;AACtB,EAAA,IAAI,gBAAgBA,0BAAO,EAAA,CAAA;AAE3B,EAAM,MAAA,kBAAA,GAAA,CACJ,mBAAQ,kBAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,MAAO,CAAA,kBAAA,CAAmB,0BAA0B,CAAA,KAD5D,IAEA,GAAA,EAAA,GAAA,KAAA,CAAA;AACF,EAAM,MAAA,2BAAA,GAAA,CACJ,mBAAQ,2BAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,MAAO,CAAA,kBAAA,CAAmB,mCAAmC,CAAA,KADrE,IAEA,GAAA,EAAA,GAAA,KAAA,CAAA;AACF,EAAA,MAAM,YAAe,GAAA;AAAA,IACnB,kBAAA;AAAA,IACA,2BAAA;AAAA,IACA,QAAQ,OAAQ,CAAA,MAAA;AAAA,GAClB,CAAA;AAEA,EAAA,MAAM,WAAc,GAAA,MAAM,OAAQ,CAAA,SAAA,CAAU,mBAAmB,OAAO,CAAA,CAAA;AACtE,EAAA,MAAM,EAAE,QAAU,EAAA,UAAA,EAAe,GAAA,IAAI,IAAI,WAAW,CAAA,CAAA;AAEpD,EAAA,MAAM,WAAc,GAAA,eAAA,CAAgB,OAAQ,CAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AAClE,EAAqB,oBAAA,CAAA,YAAA,EAAc,aAAe,EAAA,UAAA,EAAY,WAAW,CAAA,CAAA;AACzE,EAAA,MAAA,CAAO,IAAI,CAAI,GAAA,IAAA,KAAS,aAAc,CAAA,GAAG,IAAI,CAAC,CAAA,CAAA;AAE9C,EAAI,IAAA,OAAA,CAAQ,OAAO,SAAW,EAAA;AAC5B,IAAI,IAAA,UAAA,GAAa,IAAK,CAAA,SAAA,CAAU,WAAW,CAAA,CAAA;AAE3C,IAAQ,OAAA,CAAA,MAAA,CAAO,UAAU,MAAM;AAC7B,MAAA,MAAM,cAAiB,GAAA,eAAA,CAAgB,OAAQ,CAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AACrE,MAAM,MAAA,MAAA,GAAS,IAAK,CAAA,SAAA,CAAU,cAAc,CAAA,CAAA;AAE5C,MAAA,IAAI,eAAe,MAAQ,EAAA;AACzB,QAAa,UAAA,GAAA,MAAA,CAAA;AACb,QAAA,aAAA,GAAgBA,0BAAO,EAAA,CAAA;AACvB,QAAA,oBAAA;AAAA,UACE,YAAA;AAAA,UACA,aAAA;AAAA,UACA,UAAA;AAAA,UACA,cAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAEA,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAEA,SAAS,oBACP,CAAA,OAAA,EAKA,MACA,EAAA,UAAA,EACA,WACA,EAAA;AACA,EAAO,MAAA,CAAA,OAAA,CAAa,WAAW,CAAE,CAAA,OAAA,CAAQ,CAAC,CAAC,KAAA,EAAO,gBAAgB,CAAM,KAAA;AACtE,IAAI,IAAA;AACF,MAAO,MAAA,CAAA,GAAA;AAAA,QACL,KAAA;AAAA,QACA,eAAA;AAAA,UACE,UAAA;AAAA,UACA,OAAQ,CAAA,MAAA;AAAA,UACR,KAAA;AAAA,UACA,gBAAA;AAAA,UACA,OAAQ,CAAA,2BAAA;AAAA,SACV;AAAA,OACF,CAAA;AAAA,aACO,CAAG,EAAA;AACV,MAAA,IAAI,QAAQ,kBAAoB,EAAA;AAC9B,QAAA,OAAA,CAAQ,OAAO,IAAK,CAAA,CAAA,oBAAA,EAAuB,KAAK,CAAW,QAAA,EAAA,CAAA,CAAE,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,OACjE,MAAA;AACL,QAAM,MAAA,CAAA,CAAA;AAAA,OACR;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/dist/index.cjs.js

@@ -2,208 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var Router = require('express-promise-router');
-var httpProxyMiddleware = require('http-proxy-middleware');
-var backendCommon = require('@backstage/backend-common');
-var backendPluginApi = require('@backstage/backend-plugin-api');
+var router = require('./cjs/router-6fef2ff7.cjs.js');
+require('express-promise-router');
+require('http-proxy-middleware');
 
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
 
-const safeForwardHeaders = [
-  // https://fetch.spec.whatwg.org/#cors-safelisted-request-header
-  "cache-control",
-  "content-language",
-  "content-length",
-  "content-type",
-  "expires",
-  "last-modified",
-  "pragma",
-  // host is overridden by default. if changeOrigin is configured to false,
-  // we assume this is a intentional and should also be forwarded.
-  "host",
-  // other headers that we assume to be ok
-  "accept",
-  "accept-language",
-  "user-agent"
-];
-function buildMiddleware(pathPrefix, logger, route, config, reviveConsumedRequestBodies) {
-  var _a;
-  const fullConfig = typeof config === "string" ? { target: config } : { ...config };
-  const targetType = typeof fullConfig.target;
-  if (targetType !== "string") {
-    throw new Error(
-      `Proxy target for route "${route}" must be a string, but is of type ${targetType}`
-    );
-  }
-  try {
-    new URL(fullConfig.target);
-  } catch {
-    throw new Error(
-      `Proxy target is not a valid URL: ${(_a = fullConfig.target) != null ? _a : ""}`
-    );
-  }
-  if (fullConfig.pathRewrite === void 0) {
-    let routeWithSlash = route.endsWith("/") ? route : `${route}/`;
-    if (!pathPrefix.endsWith("/") && !routeWithSlash.startsWith("/")) {
-      routeWithSlash = `/${routeWithSlash}`;
-    } else if (pathPrefix.endsWith("/") && routeWithSlash.startsWith("/")) {
-      routeWithSlash = routeWithSlash.substring(1);
-    }
-    fullConfig.pathRewrite = {
-      [`^${pathPrefix}${routeWithSlash}?`]: "/"
-    };
-  }
-  if (fullConfig.changeOrigin === void 0) {
-    fullConfig.changeOrigin = true;
-  }
-  fullConfig.logProvider = () => logger;
-  fullConfig.logLevel = "debug";
-  const requestHeaderAllowList = new Set(
-    [
-      // allow all safe headers
-      ...safeForwardHeaders,
-      // allow all headers that are set by the proxy
-      ...fullConfig.headers && Object.keys(fullConfig.headers) || [],
-      // allow all configured headers
-      ...fullConfig.allowedHeaders || []
-    ].map((h) => h.toLocaleLowerCase())
-  );
-  const filter = (_pathname, req) => {
-    var _a2, _b;
-    const headerNames = Object.keys(req.headers);
-    headerNames.forEach((h) => {
-      if (!requestHeaderAllowList.has(h.toLocaleLowerCase())) {
-        delete req.headers[h];
-      }
-    });
-    return (_b = (_a2 = fullConfig == null ? void 0 : fullConfig.allowedMethods) == null ? void 0 : _a2.includes(req.method)) != null ? _b : true;
-  };
-  filter.toString = () => route;
-  const responseHeaderAllowList = new Set(
-    [
-      // allow all safe headers
-      ...safeForwardHeaders,
-      // allow all configured headers
-      ...fullConfig.allowedHeaders || []
-    ].map((h) => h.toLocaleLowerCase())
-  );
-  fullConfig.onProxyRes = (proxyRes) => {
-    const headerNames = Object.keys(proxyRes.headers);
-    headerNames.forEach((h) => {
-      if (!responseHeaderAllowList.has(h.toLocaleLowerCase())) {
-        delete proxyRes.headers[h];
-      }
-    });
-  };
-  if (reviveConsumedRequestBodies) {
-    fullConfig.onProxyReq = httpProxyMiddleware.fixRequestBody;
-  }
-  return httpProxyMiddleware.createProxyMiddleware(filter, fullConfig);
-}
-function readProxyConfig(config, logger) {
-  var _a, _b;
-  const endpoints = (_a = config.getOptionalConfig("proxy.endpoints")) == null ? void 0 : _a.get();
-  if (endpoints) {
-    return endpoints;
-  }
-  const root = (_b = config.getOptionalConfig("proxy")) == null ? void 0 : _b.get();
-  if (!root) {
-    return {};
-  }
-  const rootEndpoints = Object.fromEntries(
-    Object.entries(root).filter(([key]) => key.startsWith("/"))
-  );
-  if (Object.keys(rootEndpoints).length === 0) {
-    return {};
-  }
-  logger.warn(
-    "Configuring proxy endpoints in the root 'proxy' configuration is deprecated. Move this configuration to 'proxy.endpoints' instead."
-  );
-  return rootEndpoints;
-}
-async function createRouter(options) {
-  var _a, _b, _c, _d;
-  const router = Router__default["default"]();
-  let currentRouter = Router__default["default"]();
-  const skipInvalidProxies = (_b = (_a = options.skipInvalidProxies) != null ? _a : options.config.getOptionalBoolean("proxy.skipInvalidProxies")) != null ? _b : false;
-  const reviveConsumedRequestBodies = (_d = (_c = options.reviveConsumedRequestBodies) != null ? _c : options.config.getOptionalBoolean("proxy.reviveConsumedRequestBodies")) != null ? _d : false;
-  const proxyOptions = {
-    skipInvalidProxies,
-    reviveConsumedRequestBodies,
-    logger: options.logger
-  };
-  const externalUrl = await options.discovery.getExternalBaseUrl("proxy");
-  const { pathname: pathPrefix } = new URL(externalUrl);
-  const proxyConfig = readProxyConfig(options.config, options.logger);
-  configureMiddlewares(proxyOptions, currentRouter, pathPrefix, proxyConfig);
-  router.use((...args) => currentRouter(...args));
-  if (options.config.subscribe) {
-    let currentKey = JSON.stringify(proxyConfig);
-    options.config.subscribe(() => {
-      const newProxyConfig = readProxyConfig(options.config, options.logger);
-      const newKey = JSON.stringify(newProxyConfig);
-      if (currentKey !== newKey) {
-        currentKey = newKey;
-        currentRouter = Router__default["default"]();
-        configureMiddlewares(
-          proxyOptions,
-          currentRouter,
-          pathPrefix,
-          newProxyConfig
-        );
-      }
-    });
-  }
-  return router;
-}
-function configureMiddlewares(options, router, pathPrefix, proxyConfig) {
-  Object.entries(proxyConfig).forEach(([route, proxyRouteConfig]) => {
-    try {
-      router.use(
-        route,
-        buildMiddleware(
-          pathPrefix,
-          options.logger,
-          route,
-          proxyRouteConfig,
-          options.reviveConsumedRequestBodies
-        )
-      );
-    } catch (e) {
-      if (options.skipInvalidProxies) {
-        options.logger.warn(`skipped configuring ${route} due to ${e.message}`);
-      } else {
-        throw e;
-      }
-    }
-  });
-}
-
-const proxyPlugin = backendPluginApi.createBackendPlugin({
-  pluginId: "proxy",
-  register(env) {
-    env.registerInit({
-      deps: {
-        config: backendPluginApi.coreServices.rootConfig,
-        discovery: backendPluginApi.coreServices.discovery,
-        logger: backendPluginApi.coreServices.logger,
-        httpRouter: backendPluginApi.coreServices.httpRouter
-      },
-      async init({ config, discovery, logger, httpRouter }) {
-        httpRouter.use(
-          await createRouter({
-            config,
-            discovery,
-            logger: backendCommon.loggerToWinstonLogger(logger)
-          })
-        );
-      }
-    });
-  }
-});
-
-exports.createRouter = createRouter;
-exports["default"] = proxyPlugin;
+exports.createRouter = router.createRouter;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2020 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport {\n  createProxyMiddleware,\n  fixRequestBody,\n  Options,\n  RequestHandler,\n} from 'http-proxy-middleware';\nimport { Logger } from 'winston';\nimport http from 'http';\nimport { PluginEndpointDiscovery } from '@backstage/backend-common';\n\n// A list of headers that are always forwarded to the proxy targets.\nconst safeForwardHeaders = [\n  // https://fetch.spec.whatwg.org/#cors-safelisted-request-header\n  'cache-control',\n  'content-language',\n  'content-length',\n  'content-type',\n  'expires',\n  'last-modified',\n  'pragma',\n\n  // host is overridden by default. if changeOrigin is configured to false,\n  // we assume this is a intentional and should also be forwarded.\n  'host',\n\n  // other headers that we assume to be ok\n  'accept',\n  'accept-language',\n  'user-agent',\n];\n\n/** @public */\nexport interface RouterOptions {\n  logger: Logger;\n  config: Config;\n  discovery: PluginEndpointDiscovery;\n  skipInvalidProxies?: boolean;\n  reviveConsumedRequestBodies?: boolean;\n}\n\nexport interface ProxyConfig extends Options {\n  allowedMethods?: string[];\n  allowedHeaders?: string[];\n  reviveRequestBody?: boolean;\n}\n\n// Creates a proxy middleware, possibly with defaults added on top of the\n// given config.\nexport function buildMiddleware(\n  pathPrefix: string,\n  logger: Logger,\n  route: string,\n  config: string | ProxyConfig,\n  reviveConsumedRequestBodies?: boolean,\n): RequestHandler {\n  const fullConfig =\n    typeof config === 'string' ? { target: config } : { ...config };\n\n  // Validate that target is a valid URL.\n  const targetType = typeof fullConfig.target;\n  if (targetType !== 'string') {\n    throw new Error(\n      `Proxy target for route \"${route}\" must be a string, but is of type ${targetType}`,\n    );\n  }\n  try {\n    // eslint-disable-next-line no-new\n    new URL(fullConfig.target! as string);\n  } catch {\n    throw new Error(\n      `Proxy target is not a valid URL: ${fullConfig.target ?? ''}`,\n    );\n  }\n\n  // Default is to do a path rewrite that strips out the proxy's path prefix\n  // and the rest of the route.\n  if (fullConfig.pathRewrite === undefined) {\n    let routeWithSlash = route.endsWith('/') ? route : `${route}/`;\n\n    if (!pathPrefix.endsWith('/') && !routeWithSlash.startsWith('/')) {\n      // Need to insert a / between pathPrefix and routeWithSlash\n      routeWithSlash = `/${routeWithSlash}`;\n    } else if (pathPrefix.endsWith('/') && routeWithSlash.startsWith('/')) {\n      // Never expect this to happen at this point in time as\n      // pathPrefix is set using `getExternalBaseUrl` which \"Returns the\n      // external HTTP base backend URL for a given plugin,\n      // **without a trailing slash.**\". But in case this changes in future, we\n      // need to drop a / on either pathPrefix or routeWithSlash\n      routeWithSlash = routeWithSlash.substring(1);\n    }\n\n    // The ? makes the slash optional for the rewrite, so that a base path without an ending slash\n    // will also be matched (e.g. '/sample' and then requesting just '/api/proxy/sample' without an\n    // ending slash). Otherwise the target gets called with the full '/api/proxy/sample' path\n    // appended.\n    fullConfig.pathRewrite = {\n      [`^${pathPrefix}${routeWithSlash}?`]: '/',\n    };\n  }\n\n  // Default is to update the Host header to the target\n  if (fullConfig.changeOrigin === undefined) {\n    fullConfig.changeOrigin = true;\n  }\n\n  // Attach the logger to the proxy config\n  fullConfig.logProvider = () => logger;\n  // http-proxy-middleware uses this log level to check if it should log the\n  // requests that it proxies. Setting this to the most verbose log level\n  // ensures that it always logs these requests. Our logger ends up deciding\n  // if the logs are displayed or not.\n  fullConfig.logLevel = 'debug';\n\n  // Only return the allowed HTTP headers to not forward unwanted secret headers\n  const requestHeaderAllowList = new Set<string>(\n    [\n      // allow all safe headers\n      ...safeForwardHeaders,\n\n      // allow all headers that are set by the proxy\n      ...((fullConfig.headers && Object.keys(fullConfig.headers)) || []),\n\n      // allow all configured headers\n      ...(fullConfig.allowedHeaders || []),\n    ].map(h => h.toLocaleLowerCase()),\n  );\n\n  // Use the custom middleware filter to do two things:\n  //  1. Remove any headers not in the allow list to stop them being forwarded\n  //  2. Only permit the allowed HTTP methods if configured\n  //\n  // We are filtering the proxy request headers here rather than in\n  // `onProxyReq` because when global-agent is enabled then `onProxyReq`\n  // fires _after_ the agent has already sent the headers to the proxy\n  // target, causing a ERR_HTTP_HEADERS_SENT crash\n  const filter = (_pathname: string, req: http.IncomingMessage): boolean => {\n    const headerNames = Object.keys(req.headers);\n    headerNames.forEach(h => {\n      if (!requestHeaderAllowList.has(h.toLocaleLowerCase())) {\n        delete req.headers[h];\n      }\n    });\n\n    return fullConfig?.allowedMethods?.includes(req.method!) ?? true;\n  };\n  // Makes http-proxy-middleware logs look nicer and include the mount path\n  filter.toString = () => route;\n\n  // Only forward the allowed HTTP headers to not forward unwanted secret headers\n  const responseHeaderAllowList = new Set<string>(\n    [\n      // allow all safe headers\n      ...safeForwardHeaders,\n\n      // allow all configured headers\n      ...(fullConfig.allowedHeaders || []),\n    ].map(h => h.toLocaleLowerCase()),\n  );\n\n  // only forward the allowed headers in backend->client\n  fullConfig.onProxyRes = (proxyRes: http.IncomingMessage) => {\n    const headerNames = Object.keys(proxyRes.headers);\n\n    headerNames.forEach(h => {\n      if (!responseHeaderAllowList.has(h.toLocaleLowerCase())) {\n        delete proxyRes.headers[h];\n      }\n    });\n  };\n\n  if (reviveConsumedRequestBodies) {\n    fullConfig.onProxyReq = fixRequestBody;\n  }\n\n  return createProxyMiddleware(filter, fullConfig);\n}\n\nfunction readProxyConfig(config: Config, logger: Logger): unknown {\n  const endpoints = config.getOptionalConfig('proxy.endpoints')?.get();\n  if (endpoints) {\n    return endpoints;\n  }\n\n  const root = config.getOptionalConfig('proxy')?.get();\n  if (!root) {\n    return {};\n  }\n\n  const rootEndpoints = Object.fromEntries(\n    Object.entries(root).filter(([key]) => key.startsWith('/')),\n  );\n  if (Object.keys(rootEndpoints).length === 0) {\n    return {};\n  }\n\n  logger.warn(\n    \"Configuring proxy endpoints in the root 'proxy' configuration is deprecated. Move this configuration to 'proxy.endpoints' instead.\",\n  );\n\n  return rootEndpoints;\n}\n\n/**\n * Creates a new {@link https://expressjs.com/en/api.html#router | \"express router\"} that proxy each target configured under the `proxy` key of the config\n * @example\n * ```ts\n * let router = await createRouter({logger, config, discovery});\n * ```\n * @config\n * ```yaml\n * proxy:\n *  simple-example: http://simple.example.com:8080 # Opt 1 Simple URL String\n *  '/larger-example/v1': # Opt 2 `http-proxy-middleware` compatible object\n *    target: http://larger.example.com:8080/svc.v1\n *    headers:\n *      Authorization: Bearer ${EXAMPLE_AUTH_TOKEN}\n *```\n * @see https://backstage.io/docs/plugins/proxying\n * @public\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const router = Router();\n  let currentRouter = Router();\n\n  const skipInvalidProxies =\n    options.skipInvalidProxies ??\n    options.config.getOptionalBoolean('proxy.skipInvalidProxies') ??\n    false;\n  const reviveConsumedRequestBodies =\n    options.reviveConsumedRequestBodies ??\n    options.config.getOptionalBoolean('proxy.reviveConsumedRequestBodies') ??\n    false;\n  const proxyOptions = {\n    skipInvalidProxies,\n    reviveConsumedRequestBodies,\n    logger: options.logger,\n  };\n\n  const externalUrl = await options.discovery.getExternalBaseUrl('proxy');\n  const { pathname: pathPrefix } = new URL(externalUrl);\n\n  const proxyConfig = readProxyConfig(options.config, options.logger);\n  configureMiddlewares(proxyOptions, currentRouter, pathPrefix, proxyConfig);\n  router.use((...args) => currentRouter(...args));\n\n  if (options.config.subscribe) {\n    let currentKey = JSON.stringify(proxyConfig);\n\n    options.config.subscribe(() => {\n      const newProxyConfig = readProxyConfig(options.config, options.logger);\n      const newKey = JSON.stringify(newProxyConfig);\n\n      if (currentKey !== newKey) {\n        currentKey = newKey;\n        currentRouter = Router();\n        configureMiddlewares(\n          proxyOptions,\n          currentRouter,\n          pathPrefix,\n          newProxyConfig,\n        );\n      }\n    });\n  }\n\n  return router;\n}\n\nfunction configureMiddlewares(\n  options: {\n    reviveConsumedRequestBodies: boolean;\n    skipInvalidProxies: boolean;\n    logger: Logger;\n  },\n  router: express.Router,\n  pathPrefix: string,\n  proxyConfig: any,\n) {\n  Object.entries<any>(proxyConfig).forEach(([route, proxyRouteConfig]) => {\n    try {\n      router.use(\n        route,\n        buildMiddleware(\n          pathPrefix,\n          options.logger,\n          route,\n          proxyRouteConfig,\n          options.reviveConsumedRequestBodies,\n        ),\n      );\n    } catch (e) {\n      if (options.skipInvalidProxies) {\n        options.logger.warn(`skipped configuring ${route} due to ${e.message}`);\n      } else {\n        throw e;\n      }\n    }\n  });\n}\n","/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n  createBackendPlugin,\n  coreServices,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * The proxy backend plugin.\n *\n * @alpha\n */\nexport const proxyPlugin = createBackendPlugin({\n  pluginId: 'proxy',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        logger: coreServices.logger,\n        httpRouter: coreServices.httpRouter,\n      },\n      async init({ config, discovery, logger, httpRouter }) {\n        httpRouter.use(\n          await createRouter({\n            config,\n            discovery,\n            logger: loggerToWinstonLogger(logger),\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["_a","fixRequestBody","createProxyMiddleware","Router","createBackendPlugin","coreServices","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;AA8BA,MAAM,kBAAqB,GAAA;AAAA;AAAA,EAEzB,eAAA;AAAA,EACA,kBAAA;AAAA,EACA,gBAAA;AAAA,EACA,cAAA;AAAA,EACA,SAAA;AAAA,EACA,eAAA;AAAA,EACA,QAAA;AAAA;AAAA;AAAA,EAIA,MAAA;AAAA;AAAA,EAGA,QAAA;AAAA,EACA,iBAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAmBO,SAAS,eACd,CAAA,UAAA,EACA,MACA,EAAA,KAAA,EACA,QACA,2BACgB,EAAA;AAzElB,EAAA,IAAA,EAAA,CAAA;AA0EE,EAAM,MAAA,UAAA,GACJ,OAAO,MAAA,KAAW,QAAW,GAAA,EAAE,QAAQ,MAAO,EAAA,GAAI,EAAE,GAAG,MAAO,EAAA,CAAA;AAGhE,EAAM,MAAA,UAAA,GAAa,OAAO,UAAW,CAAA,MAAA,CAAA;AACrC,EAAA,IAAI,eAAe,QAAU,EAAA;AAC3B,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAA,wBAAA,EAA2B,KAAK,CAAA,mCAAA,EAAsC,UAAU,CAAA,CAAA;AAAA,KAClF,CAAA;AAAA,GACF;AACA,EAAI,IAAA;AAEF,IAAI,IAAA,GAAA,CAAI,WAAW,MAAiB,CAAA,CAAA;AAAA,GAC9B,CAAA,MAAA;AACN,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,CAAoC,iCAAA,EAAA,CAAA,EAAA,GAAA,UAAA,CAAW,MAAX,KAAA,IAAA,GAAA,EAAA,GAAqB,EAAE,CAAA,CAAA;AAAA,KAC7D,CAAA;AAAA,GACF;AAIA,EAAI,IAAA,UAAA,CAAW,gBAAgB,KAAW,CAAA,EAAA;AACxC,IAAA,IAAI,iBAAiB,KAAM,CAAA,QAAA,CAAS,GAAG,CAAI,GAAA,KAAA,GAAQ,GAAG,KAAK,CAAA,CAAA,CAAA,CAAA;AAE3D,IAAI,IAAA,CAAC,WAAW,QAAS,CAAA,GAAG,KAAK,CAAC,cAAA,CAAe,UAAW,CAAA,GAAG,CAAG,EAAA;AAEhE,MAAA,cAAA,GAAiB,IAAI,cAAc,CAAA,CAAA,CAAA;AAAA,KACrC,MAAA,IAAW,WAAW,QAAS,CAAA,GAAG,KAAK,cAAe,CAAA,UAAA,CAAW,GAAG,CAAG,EAAA;AAMrE,MAAiB,cAAA,GAAA,cAAA,CAAe,UAAU,CAAC,CAAA,CAAA;AAAA,KAC7C;AAMA,IAAA,UAAA,CAAW,WAAc,GAAA;AAAA,MACvB,CAAC,CAAI,CAAA,EAAA,UAAU,CAAG,EAAA,cAAc,GAAG,GAAG,GAAA;AAAA,KACxC,CAAA;AAAA,GACF;AAGA,EAAI,IAAA,UAAA,CAAW,iBAAiB,KAAW,CAAA,EAAA;AACzC,IAAA,UAAA,CAAW,YAAe,GAAA,IAAA,CAAA;AAAA,GAC5B;AAGA,EAAA,UAAA,CAAW,cAAc,MAAM,MAAA,CAAA;AAK/B,EAAA,UAAA,CAAW,QAAW,GAAA,OAAA,CAAA;AAGtB,EAAA,MAAM,yBAAyB,IAAI,GAAA;AAAA,IACjC;AAAA;AAAA,MAEE,GAAG,kBAAA;AAAA;AAAA,MAGH,GAAK,WAAW,OAAW,IAAA,MAAA,CAAO,KAAK,UAAW,CAAA,OAAO,KAAM,EAAC;AAAA;AAAA,MAGhE,GAAI,UAAW,CAAA,cAAA,IAAkB,EAAC;AAAA,KAClC,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,mBAAmB,CAAA;AAAA,GAClC,CAAA;AAUA,EAAM,MAAA,MAAA,GAAS,CAAC,SAAA,EAAmB,GAAuC,KAAA;AA1J5E,IAAA,IAAAA,GAAA,EAAA,EAAA,CAAA;AA2JI,IAAA,MAAM,WAAc,GAAA,MAAA,CAAO,IAAK,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AAC3C,IAAA,WAAA,CAAY,QAAQ,CAAK,CAAA,KAAA;AACvB,MAAA,IAAI,CAAC,sBAAuB,CAAA,GAAA,CAAI,CAAE,CAAA,iBAAA,EAAmB,CAAG,EAAA;AACtD,QAAO,OAAA,GAAA,CAAI,QAAQ,CAAC,CAAA,CAAA;AAAA,OACtB;AAAA,KACD,CAAA,CAAA;AAED,IAAO,OAAA,CAAA,EAAA,GAAA,CAAAA,MAAA,UAAY,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,UAAA,CAAA,cAAA,KAAZ,gBAAAA,GAA4B,CAAA,QAAA,CAAS,GAAI,CAAA,MAAA,CAAA,KAAzC,IAAqD,GAAA,EAAA,GAAA,IAAA,CAAA;AAAA,GAC9D,CAAA;AAEA,EAAA,MAAA,CAAO,WAAW,MAAM,KAAA,CAAA;AAGxB,EAAA,MAAM,0BAA0B,IAAI,GAAA;AAAA,IAClC;AAAA;AAAA,MAEE,GAAG,kBAAA;AAAA;AAAA,MAGH,GAAI,UAAW,CAAA,cAAA,IAAkB,EAAC;AAAA,KAClC,CAAA,GAAA,CAAI,CAAK,CAAA,KAAA,CAAA,CAAE,mBAAmB,CAAA;AAAA,GAClC,CAAA;AAGA,EAAW,UAAA,CAAA,UAAA,GAAa,CAAC,QAAmC,KAAA;AAC1D,IAAA,MAAM,WAAc,GAAA,MAAA,CAAO,IAAK,CAAA,QAAA,CAAS,OAAO,CAAA,CAAA;AAEhD,IAAA,WAAA,CAAY,QAAQ,CAAK,CAAA,KAAA;AACvB,MAAA,IAAI,CAAC,uBAAwB,CAAA,GAAA,CAAI,CAAE,CAAA,iBAAA,EAAmB,CAAG,EAAA;AACvD,QAAO,OAAA,QAAA,CAAS,QAAQ,CAAC,CAAA,CAAA;AAAA,OAC3B;AAAA,KACD,CAAA,CAAA;AAAA,GACH,CAAA;AAEA,EAAA,IAAI,2BAA6B,EAAA;AAC/B,IAAA,UAAA,CAAW,UAAa,GAAAC,kCAAA,CAAA;AAAA,GAC1B;AAEA,EAAO,OAAAC,yCAAA,CAAsB,QAAQ,UAAU,CAAA,CAAA;AACjD,CAAA;AAEA,SAAS,eAAA,CAAgB,QAAgB,MAAyB,EAAA;AApMlE,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAqME,EAAA,MAAM,SAAY,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,iBAAiB,MAA1C,IAA6C,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,GAAA,EAAA,CAAA;AAC/D,EAAA,IAAI,SAAW,EAAA;AACb,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAEA,EAAA,MAAM,IAAO,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,OAAO,MAAhC,IAAmC,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,GAAA,EAAA,CAAA;AAChD,EAAA,IAAI,CAAC,IAAM,EAAA;AACT,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAA,MAAM,gBAAgB,MAAO,CAAA,WAAA;AAAA,IAC3B,MAAO,CAAA,OAAA,CAAQ,IAAI,CAAA,CAAE,MAAO,CAAA,CAAC,CAAC,GAAG,CAAM,KAAA,GAAA,CAAI,UAAW,CAAA,GAAG,CAAC,CAAA;AAAA,GAC5D,CAAA;AACA,EAAA,IAAI,MAAO,CAAA,IAAA,CAAK,aAAa,CAAA,CAAE,WAAW,CAAG,EAAA;AAC3C,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAO,MAAA,CAAA,IAAA;AAAA,IACL,oIAAA;AAAA,GACF,CAAA;AAEA,EAAO,OAAA,aAAA,CAAA;AACT,CAAA;AAoBA,eAAsB,aACpB,OACyB,EAAA;AAjP3B,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAkPE,EAAA,MAAM,SAASC,0BAAO,EAAA,CAAA;AACtB,EAAA,IAAI,gBAAgBA,0BAAO,EAAA,CAAA;AAE3B,EAAM,MAAA,kBAAA,GAAA,CACJ,mBAAQ,kBAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,MAAO,CAAA,kBAAA,CAAmB,0BAA0B,CAAA,KAD5D,IAEA,GAAA,EAAA,GAAA,KAAA,CAAA;AACF,EAAM,MAAA,2BAAA,GAAA,CACJ,mBAAQ,2BAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,MAAO,CAAA,kBAAA,CAAmB,mCAAmC,CAAA,KADrE,IAEA,GAAA,EAAA,GAAA,KAAA,CAAA;AACF,EAAA,MAAM,YAAe,GAAA;AAAA,IACnB,kBAAA;AAAA,IACA,2BAAA;AAAA,IACA,QAAQ,OAAQ,CAAA,MAAA;AAAA,GAClB,CAAA;AAEA,EAAA,MAAM,WAAc,GAAA,MAAM,OAAQ,CAAA,SAAA,CAAU,mBAAmB,OAAO,CAAA,CAAA;AACtE,EAAA,MAAM,EAAE,QAAU,EAAA,UAAA,EAAe,GAAA,IAAI,IAAI,WAAW,CAAA,CAAA;AAEpD,EAAA,MAAM,WAAc,GAAA,eAAA,CAAgB,OAAQ,CAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AAClE,EAAqB,oBAAA,CAAA,YAAA,EAAc,aAAe,EAAA,UAAA,EAAY,WAAW,CAAA,CAAA;AACzE,EAAA,MAAA,CAAO,IAAI,CAAI,GAAA,IAAA,KAAS,aAAc,CAAA,GAAG,IAAI,CAAC,CAAA,CAAA;AAE9C,EAAI,IAAA,OAAA,CAAQ,OAAO,SAAW,EAAA;AAC5B,IAAI,IAAA,UAAA,GAAa,IAAK,CAAA,SAAA,CAAU,WAAW,CAAA,CAAA;AAE3C,IAAQ,OAAA,CAAA,MAAA,CAAO,UAAU,MAAM;AAC7B,MAAA,MAAM,cAAiB,GAAA,eAAA,CAAgB,OAAQ,CAAA,MAAA,EAAQ,QAAQ,MAAM,CAAA,CAAA;AACrE,MAAM,MAAA,MAAA,GAAS,IAAK,CAAA,SAAA,CAAU,cAAc,CAAA,CAAA;AAE5C,MAAA,IAAI,eAAe,MAAQ,EAAA;AACzB,QAAa,UAAA,GAAA,MAAA,CAAA;AACb,QAAA,aAAA,GAAgBA,0BAAO,EAAA,CAAA;AACvB,QAAA,oBAAA;AAAA,UACE,YAAA;AAAA,UACA,aAAA;AAAA,UACA,UAAA;AAAA,UACA,cAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAEA,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAEA,SAAS,oBACP,CAAA,OAAA,EAKA,MACA,EAAA,UAAA,EACA,WACA,EAAA;AACA,EAAO,MAAA,CAAA,OAAA,CAAa,WAAW,CAAE,CAAA,OAAA,CAAQ,CAAC,CAAC,KAAA,EAAO,gBAAgB,CAAM,KAAA;AACtE,IAAI,IAAA;AACF,MAAO,MAAA,CAAA,GAAA;AAAA,QACL,KAAA;AAAA,QACA,eAAA;AAAA,UACE,UAAA;AAAA,UACA,OAAQ,CAAA,MAAA;AAAA,UACR,KAAA;AAAA,UACA,gBAAA;AAAA,UACA,OAAQ,CAAA,2BAAA;AAAA,SACV;AAAA,OACF,CAAA;AAAA,aACO,CAAG,EAAA;AACV,MAAA,IAAI,QAAQ,kBAAoB,EAAA;AAC9B,QAAA,OAAA,CAAQ,OAAO,IAAK,CAAA,CAAA,oBAAA,EAAuB,KAAK,CAAW,QAAA,EAAA,CAAA,CAAE,OAAO,CAAE,CAAA,CAAA,CAAA;AAAA,OACjE,MAAA;AACL,QAAM,MAAA,CAAA,CAAA;AAAA,OACR;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;ACnSO,MAAM,cAAcC,oCAAoB,CAAA;AAAA,EAC7C,QAAU,EAAA,OAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,YAAYA,6BAAa,CAAA,UAAA;AAAA,OAC3B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAQ,SAAW,EAAA,MAAA,EAAQ,YAAc,EAAA;AACpD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,WACrC,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,15 +1,16 @@
-/**
- * A Backstage backend plugin that helps you set up proxy endpoints in the backend
- *
- * @packageDocumentation
- */
-
-import { BackendFeature } from '@backstage/backend-plugin-api';
 import { Config } from '@backstage/config';
 import express from 'express';
 import { Logger } from 'winston';
 import { PluginEndpointDiscovery } from '@backstage/backend-common';
 
+/** @public */
+interface RouterOptions {
+    logger: Logger;
+    config: Config;
+    discovery: PluginEndpointDiscovery;
+    skipInvalidProxies?: boolean;
+    reviveConsumedRequestBodies?: boolean;
+}
 /**
  * Creates a new {@link https://expressjs.com/en/api.html#router | "express router"} that proxy each target configured under the `proxy` key of the config
  * @example
@@ -28,17 +29,6 @@ import { PluginEndpointDiscovery } from '@backstage/backend-common';
  * @see https://backstage.io/docs/plugins/proxying
  * @public
  */
-export declare function createRouter(options: RouterOptions): Promise<express.Router>;
-
-/* Excluded from this release type: proxyPlugin */
-
-/** @public */
-export declare interface RouterOptions {
-    logger: Logger;
-    config: Config;
-    discovery: PluginEndpointDiscovery;
-    skipInvalidProxies?: boolean;
-    reviveConsumedRequestBodies?: boolean;
-}
+declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
-export { }
+export { RouterOptions, createRouter };

package/package.json

@@ -1,15 +1,25 @@
 {
   "name": "@backstage/plugin-proxy-backend",
   "description": "A Backstage backend plugin that helps you set up proxy endpoints in the backend",
-  "version": "0.4.3",
-  "main": "dist/index.cjs.js",
-  "types": "dist/index.d.ts",
+  "version": "0.4.4",
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
   "license": "Apache-2.0",
   "publishConfig": {
-    "access": "public",
-    "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts",
-    "alphaTypes": "dist/index.alpha.d.ts"
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./alpha": {
+      "require": "./dist/alpha.cjs.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.cjs.js"
+    },
+    "./package.json": "./package.json"
   },
   "backstage": {
     "role": "backend-plugin"
@@ -25,7 +35,7 @@
   ],
   "scripts": {
     "start": "backstage-cli package start",
-    "build": "backstage-cli package build --experimental-type-build",
+    "build": "backstage-cli package build",
     "lint": "backstage-cli package lint",
     "test": "backstage-cli package test",
     "prepack": "backstage-cli package prepack",

package/dist/index.alpha.d.ts

@@ -1,50 +0,0 @@
-/**
- * A Backstage backend plugin that helps you set up proxy endpoints in the backend
- *
- * @packageDocumentation
- */
-
-import { BackendFeature } from '@backstage/backend-plugin-api';
-import { Config } from '@backstage/config';
-import express from 'express';
-import { Logger } from 'winston';
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
-
-/**
- * Creates a new {@link https://expressjs.com/en/api.html#router | "express router"} that proxy each target configured under the `proxy` key of the config
- * @example
- * ```ts
- * let router = await createRouter({logger, config, discovery});
- * ```
- * @config
- * ```yaml
- * proxy:
- *  simple-example: http://simple.example.com:8080 # Opt 1 Simple URL String
- *  '/larger-example/v1': # Opt 2 `http-proxy-middleware` compatible object
- *    target: http://larger.example.com:8080/svc.v1
- *    headers:
- *      Authorization: Bearer ${EXAMPLE_AUTH_TOKEN}
- *```
- * @see https://backstage.io/docs/plugins/proxying
- * @public
- */
-export declare function createRouter(options: RouterOptions): Promise<express.Router>;
-
-/**
- * The proxy backend plugin.
- *
- * @alpha
- */
-declare const proxyPlugin: () => BackendFeature;
-export default proxyPlugin;
-
-/** @public */
-export declare interface RouterOptions {
-    logger: Logger;
-    config: Config;
-    discovery: PluginEndpointDiscovery;
-    skipInvalidProxies?: boolean;
-    reviveConsumedRequestBodies?: boolean;
-}
-
-export { }

package/dist/index.beta.d.ts

@@ -1,44 +0,0 @@
-/**
- * A Backstage backend plugin that helps you set up proxy endpoints in the backend
- *
- * @packageDocumentation
- */
-
-import { BackendFeature } from '@backstage/backend-plugin-api';
-import { Config } from '@backstage/config';
-import express from 'express';
-import { Logger } from 'winston';
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
-
-/**
- * Creates a new {@link https://expressjs.com/en/api.html#router | "express router"} that proxy each target configured under the `proxy` key of the config
- * @example
- * ```ts
- * let router = await createRouter({logger, config, discovery});
- * ```
- * @config
- * ```yaml
- * proxy:
- *  simple-example: http://simple.example.com:8080 # Opt 1 Simple URL String
- *  '/larger-example/v1': # Opt 2 `http-proxy-middleware` compatible object
- *    target: http://larger.example.com:8080/svc.v1
- *    headers:
- *      Authorization: Bearer ${EXAMPLE_AUTH_TOKEN}
- *```
- * @see https://backstage.io/docs/plugins/proxying
- * @public
- */
-export declare function createRouter(options: RouterOptions): Promise<express.Router>;
-
-/* Excluded from this release type: proxyPlugin */
-
-/** @public */
-export declare interface RouterOptions {
-    logger: Logger;
-    config: Config;
-    discovery: PluginEndpointDiscovery;
-    skipInvalidProxies?: boolean;
-    reviveConsumedRequestBodies?: boolean;
-}
-
-export { }