@axis-backstage/plugin-readme-backend 0.10.0 → 0.11.0

package/CHANGELOG.md

@@ -0,0 +1,97 @@
+# @axis-backstage/plugin-readme-backend
+
+## 0.11.0
+
+### Minor Changes
+
+- 6939770: **BREAKING**: The `readme-backend` has been migrated to the new backend system. If
+  you are using the new backend system module, this does not affect you.
+
+## 0.10.1
+
+### Patch Changes
+
+- cd4f853: Store `not found` results for entities.
+
+  If no README is found for an entity we now store that in the
+  cache so Backstage will not try again until the cache has
+  been invalidated.
+
+## 0.10.0
+
+### Minor Changes
+
+- 0726c03: Created the isReadmeAvailable function that returns false if no README content is found due to 404-error. If it returns false, no ReadmeCard is rendered in EntityPage. Also updated the error response from backend to be a NotFoundError.
+
+## 0.9.2
+
+### Patch Changes
+
+- 176243f: Updated deprecated types and fixed the standalone server
+- 1db0ada: Marked `createRouter` and `RouterOptions` as deprecated, to be removed soon after the Backstage `1.32.0` release in October
+- 3bfe58a: Removed the tokenmanager as dependency for new backend system plugin definition.
+
+## 0.9.1
+
+### Patch Changes
+
+- 65f00d4: Fixed missing auth argument to createRouter call
+
+## 0.9.0
+
+### Minor Changes
+
+- 6fd284d: Updated to Backstage v1.30.1.
+
+## 0.8.0
+
+### Minor Changes
+
+- 0b948ea: Generate pluginIds for plugins and bumping @backstage/cli
+
+## 0.7.0
+
+### Minor Changes
+
+- 916589b: Bumped Backstage to v.27.7 and removed the TechRadar plugin since it was not used and caused problems with the new version.
+
+## 0.6.1
+
+### Patch Changes
+
+- 882cfa7: Headers were being set after the response was sent, causing errors. Replaced break statements with return statements in the loop.
+
+## 0.6.0
+
+### Minor Changes
+
+- 0535af4: **BREAKING** The Readme backend now uses the new auth service introduced in Backstage v1.24.0. This is only applicable when using this plugin in the new Backstage backend. This could break the usage in Backstage installations older than v1.24.0 if the new backend system is used.
+
+### Patch Changes
+
+- 0535af4: Bumped backstage dependencies to match 1.26.0
+- 0535af4: Updated the installation instructions for the new backend system.
+
+## 0.5.0
+
+### Minor Changes
+
+- 371f5fd: Readme backend APIs adjusted to consume entityRef as /:kind/:namespace/:name. Fixes a 404 routing issue where a proxy like oauth2Proxy could decode the URI encoded path parameter /:entityRef known to contain the reserved path delimiter '/'.
+
+## 0.4.0
+
+### Minor Changes
+
+- 864d983: Bumped Backstage version to v.1.22.0
+
+## 0.3.0
+
+### Minor Changes
+
+- 23ff76a: Bumped Backstage version to v.1.21.0 in whole monorepo
+
+## 0.2.0
+
+### Minor Changes
+
+- a67c963: Bumped Backstage to version 1.20.3

package/README.md

@@ -21,45 +21,6 @@ yarn --cwd packages/backend add @axis-backstage/plugin-readme-backend
 
 Here's how to get the backend plugin up and running:
 
-1. Create a new file named `packages/backend/src/plugins/readme.ts`, and add the following to it:
-
-   ```ts
-   import { createRouter } from '@axis-backstage/plugin-readme-backend';
-   import { Router } from 'express';
-   import { PluginEnvironment } from '../types';
-
-   export default async function createPlugin(
-     env: PluginEnvironment,
-   ): Promise<Router> {
-     return await createRouter({
-       logger: env.logger,
-       config: env.config,
-       reader: env.reader,
-       discovery: env.discovery,
-       tokenManager: env.tokenManager,
-     });
-   }
-   ```
-
-2. Wire this into the overall backend router by adding the following to `packages/backend/src/index.ts`:
-
-   ```ts
-   import readme from './plugins/readme';
-   ...
-
-   async function main() {
-     // Add this line under the other lines that follow the useHotMemoize pattern
-    const readmeEnv = useHotMemoize(module, () => createEnv('readme'),
-
-     // Add this under the lines that add their routers to apiRouter
-    apiRouter.use('/readme', await readme(readmeEnv));
-   }
-   ```
-
-### New Backend System
-
-The Readme backend plugin has support for the [new backend system](https://backstage.io/docs/backend-system/). Here is how you can set it up:
-
 In your `packages/backend/src/index.ts` make the following changes:
 
 ```diff

package/dist/index.cjs.js

@@ -2,16 +2,15 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var backendPluginApi = require('@backstage/backend-plugin-api');
 var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
 var cache = require('@backstage/backend-defaults/cache');
-var backendCommon = require('@backstage/backend-common');
 var integration = require('@backstage/integration');
 var catalogModel = require('@backstage/catalog-model');
 var catalogClient = require('@backstage/catalog-client');
 var errors = require('@backstage/errors');
 var express = require('express');
 var Router = require('express-promise-router');
-var backendPluginApi = require('@backstage/backend-plugin-api');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -28,6 +27,7 @@ const isSymLink = (content) => {
   return regex.test(content);
 };
 
+const NOT_FOUND_PLACEHOLDER = "NOT_FOUND";
 const DEFAULT_TTL = 1800 * 1e3;
 const README_TYPES = [
   { name: "README", type: "text/plain" },
@@ -36,9 +36,9 @@ const README_TYPES = [
   { name: "README.txt", type: "text/plain" },
   { name: "README.MD", type: "text/markdown" }
 ];
+
 async function createRouter(options) {
-  const { logger, config, reader, discovery } = options;
-  const { auth } = backendCommon.createLegacyAuthAdapters(options);
+  const { auth, logger, config, reader, discovery } = options;
   const catalogClient$1 = new catalogClient.CatalogClient({ discoveryApi: discovery });
   const pluginCache = cache.CacheManager.fromConfig(config).forPlugin("readme");
   const cache$1 = pluginCache.getClient({ defaultTtl: DEFAULT_TTL });
@@ -53,6 +53,9 @@ async function createRouter(options) {
     const { kind, namespace, name } = request.params;
     const entityRef = catalogModel.stringifyEntityRef({ kind, namespace, name });
     const cacheDoc = await cache$1.get(entityRef);
+    if (cacheDoc && cacheDoc.name === NOT_FOUND_PLACEHOLDER) {
+      throw new errors.NotFoundError("Readme could not be found");
+    }
     if (cacheDoc) {
       logger.info(`Loading README for ${entityRef} from cache.`);
       response.type(cacheDoc.type);
@@ -88,7 +91,7 @@ async function createRouter(options) {
       });
       let content;
       try {
-        logger.info(`Fetch README ${entityRef}: ${url}, ${fileType.type} `);
+        logger.debug(`Trying README location: ${url} for ${entityRef} `);
         response.type(fileType.type);
         const urlResponse = await reader.readUrl(url);
         content = (await urlResponse.buffer()).toString("utf-8");
@@ -105,6 +108,9 @@ async function createRouter(options) {
           type: fileType.type,
           content
         });
+        logger.info(
+          `Found README for ${entityRef}: ${url} type ${fileType.type}`
+        );
         response.send(content);
         return;
       } catch (error) {
@@ -119,6 +125,11 @@ async function createRouter(options) {
       }
     }
     logger.info(`Readme not found for ${entityRef}`);
+    cache$1.set(entityRef, {
+      name: NOT_FOUND_PLACEHOLDER,
+      type: "",
+      content: ""
+    });
     throw new errors.NotFoundError("Readme could not be found");
   });
   const middleware = rootHttpRouter.MiddlewareFactory.create({ logger, config });
@@ -131,12 +142,12 @@ const readmePlugin = backendPluginApi.createBackendPlugin({
   register(env) {
     env.registerInit({
       deps: {
-        logger: backendPluginApi.coreServices.logger,
+        auth: backendPluginApi.coreServices.auth,
         config: backendPluginApi.coreServices.rootConfig,
-        reader: backendPluginApi.coreServices.urlReader,
         discovery: backendPluginApi.coreServices.discovery,
-        auth: backendPluginApi.coreServices.auth,
-        httpRouter: backendPluginApi.coreServices.httpRouter
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        logger: backendPluginApi.coreServices.logger,
+        reader: backendPluginApi.coreServices.urlReader
       },
       async init({ auth, logger, config, reader, discovery, httpRouter }) {
         httpRouter.use(
@@ -153,6 +164,5 @@ const readmePlugin = backendPluginApi.createBackendPlugin({
   }
 });
 
-exports.createRouter = createRouter;
 exports.default = readmePlugin;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/lib.ts","../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["const DETECT_SYMLINKS_REGEX = '^(w+|.|/|-)+$';\n\nexport const isSymLink = (content: string): boolean => {\n  const lines = content.split('\\n');\n  if (lines.length > 1) return false;\n  const line = lines[0];\n  if (line.includes(' ')) return false;\n\n  const regex = RegExp(DETECT_SYMLINKS_REGEX);\n  return regex.test(content);\n};\n","import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';\nimport { CacheManager } from '@backstage/backend-defaults/cache';\nimport {\n  AuthService,\n  DiscoveryService,\n  LoggerService,\n  RootConfigService,\n  UrlReaderService,\n  TokenManagerService,\n} from '@backstage/backend-plugin-api';\nimport { createLegacyAuthAdapters } from '@backstage/backend-common';\nimport { ScmIntegrations } from '@backstage/integration';\nimport {\n  getEntitySourceLocation,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { CatalogClient } from '@backstage/catalog-client';\nimport { isError, NotFoundError } from '@backstage/errors';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { isSymLink } from '../lib';\n\n/**\n * Constructs a readme router.\n * @deprecated Please migrate to the new backend system as this will be removed in the future.\n * @public\n */\nexport interface RouterOptions {\n  /**\n   * Implementation of Winston logger\n   */\n  logger: LoggerService;\n\n  /**\n   * Backstage config object\n   */\n  config: RootConfigService;\n\n  /**\n   * Backstage url reader instance\n   */\n  reader: UrlReaderService;\n  /**\n   * Backstage discovery service\n   */\n  discovery: DiscoveryService;\n  /**\n   * Backstage token manager service\n   */\n  tokenManager?: TokenManagerService;\n  /**\n   * Backstage auth service\n   */\n  auth?: AuthService;\n}\n\nconst DEFAULT_TTL = 1800 * 1000;\n\ninterface FileType {\n  name: string;\n  type: string;\n}\ninterface ReadmeFile extends FileType {\n  content: string;\n}\n\nconst README_TYPES: FileType[] = [\n  { name: 'README', type: 'text/plain' },\n  { name: 'README.md', type: 'text/markdown' },\n  { name: 'README.rst', type: 'text/plain' },\n  { name: 'README.txt', type: 'text/plain' },\n  { name: 'README.MD', type: 'text/markdown' },\n];\n\n/**\n * Constructs a readme router.\n *\n * @deprecated Please migrate to the new backend system as this will be removed in the future.\n * @public\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const { logger, config, reader, discovery } = options;\n  const { auth } = createLegacyAuthAdapters(options);\n  const catalogClient = new CatalogClient({ discoveryApi: discovery });\n\n  const pluginCache = CacheManager.fromConfig(config).forPlugin('readme');\n  const cache = pluginCache.getClient({ defaultTtl: DEFAULT_TTL });\n\n  logger.info('Initializing readme backend');\n  const integrations = ScmIntegrations.fromConfig(config);\n  const router = Router();\n  router.use(express.json());\n\n  router.get('/health', (_, response) => {\n    response.json({ status: 'ok' });\n  });\n\n  router.get('/:kind/:namespace/:name', async (request, response) => {\n    const { kind, namespace, name } = request.params;\n    const entityRef = stringifyEntityRef({ kind, namespace, name });\n    const cacheDoc = (await cache.get(entityRef)) as ReadmeFile | undefined;\n\n    if (cacheDoc) {\n      logger.info(`Loading README for ${entityRef} from cache.`);\n      response.type(cacheDoc.type);\n      response.send(cacheDoc.content);\n      return;\n    }\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: 'catalog',\n    });\n    const entity = await catalogClient.getEntityByRef(entityRef, { token });\n    if (!entity) {\n      logger.info(`No integration found for ${entityRef}`);\n      response\n        .status(500)\n        .json({ error: `No integration found for ${entityRef}` });\n      return;\n    }\n    const source = getEntitySourceLocation(entity);\n\n    if (!source || source.type !== 'url') {\n      const errorMessage = `Not valid location for ${source.target}`;\n      logger.info(errorMessage);\n      throw new NotFoundError(errorMessage);\n    }\n    const integration = integrations.byUrl(source.target);\n\n    if (!integration) {\n      logger.info(`No integration found for ${source.target}`);\n      response\n        .status(500)\n        .json({ error: `No integration found for ${source.target}` });\n      return;\n    }\n\n    for (const fileType of README_TYPES) {\n      const url = integration.resolveUrl({\n        url: fileType.name,\n        base: source.target,\n      });\n\n      let content;\n\n      try {\n        logger.info(`Fetch README ${entityRef}: ${url}, ${fileType.type} `);\n        response.type(fileType.type);\n\n        const urlResponse = await reader.readUrl(url);\n        content = (await urlResponse.buffer()).toString('utf-8');\n\n        if (isSymLink(content)) {\n          const symLinkUrl = integration.resolveUrl({\n            url: content,\n            base: source.target,\n          });\n          const symLinkUrlResponse = await reader.readUrl(symLinkUrl);\n          content = (await symLinkUrlResponse.buffer()).toString('utf-8');\n        }\n\n        cache.set(entityRef, {\n          name: fileType.name,\n          type: fileType.type,\n          content: content,\n        });\n        response.send(content);\n        return;\n      } catch (error: unknown) {\n        if (isError(error) && error.name === 'NotFoundError') {\n          continue;\n        } else {\n          response.status(500).json({\n            error: `Readme failure: ${error}`,\n          });\n          return;\n        }\n      }\n    }\n    logger.info(`Readme not found for ${entityRef}`);\n    throw new NotFoundError('Readme could not be found');\n  });\n\n  const middleware = MiddlewareFactory.create({ logger, config });\n  router.use(middleware.error());\n  return router;\n}\n","import {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * The Readme backend plugin.\n *\n * @public\n */\nexport const readmePlugin = createBackendPlugin({\n  pluginId: 'readme',\n  register(env) {\n    env.registerInit({\n      deps: {\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        reader: coreServices.urlReader,\n        discovery: coreServices.discovery,\n        auth: coreServices.auth,\n        httpRouter: coreServices.httpRouter,\n      },\n      async init({ auth, logger, config, reader, discovery, httpRouter }) {\n        httpRouter.use(\n          await createRouter({\n            auth,\n            logger,\n            config,\n            reader,\n            discovery,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createLegacyAuthAdapters","catalogClient","CatalogClient","CacheManager","cache","ScmIntegrations","Router","express","stringifyEntityRef","getEntitySourceLocation","NotFoundError","isError","MiddlewareFactory","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,MAAM,qBAAwB,GAAA,eAAA,CAAA;AAEjB,MAAA,SAAA,GAAY,CAAC,OAA6B,KAAA;AACrD,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAChC,EAAI,IAAA,KAAA,CAAM,MAAS,GAAA,CAAA,EAAU,OAAA,KAAA,CAAA;AAC7B,EAAM,MAAA,IAAA,GAAO,MAAM,CAAC,CAAA,CAAA;AACpB,EAAA,IAAI,IAAK,CAAA,QAAA,CAAS,GAAG,CAAA,EAAU,OAAA,KAAA,CAAA;AAE/B,EAAM,MAAA,KAAA,GAAQ,OAAO,qBAAqB,CAAA,CAAA;AAC1C,EAAO,OAAA,KAAA,CAAM,KAAK,OAAO,CAAA,CAAA;AAC3B,CAAA;;AC8CA,MAAM,cAAc,IAAO,GAAA,GAAA,CAAA;AAU3B,MAAM,YAA2B,GAAA;AAAA,EAC/B,EAAE,IAAA,EAAM,QAAU,EAAA,IAAA,EAAM,YAAa,EAAA;AAAA,EACrC,EAAE,IAAA,EAAM,WAAa,EAAA,IAAA,EAAM,eAAgB,EAAA;AAAA,EAC3C,EAAE,IAAA,EAAM,YAAc,EAAA,IAAA,EAAM,YAAa,EAAA;AAAA,EACzC,EAAE,IAAA,EAAM,YAAc,EAAA,IAAA,EAAM,YAAa,EAAA;AAAA,EACzC,EAAE,IAAA,EAAM,WAAa,EAAA,IAAA,EAAM,eAAgB,EAAA;AAC7C,CAAA,CAAA;AAQA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,MAAA,EAAQ,WAAc,GAAA,OAAA,CAAA;AAC9C,EAAA,MAAM,EAAE,IAAA,EAAS,GAAAA,sCAAA,CAAyB,OAAO,CAAA,CAAA;AACjD,EAAA,MAAMC,kBAAgB,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,WAAW,CAAA,CAAA;AAEnE,EAAA,MAAM,cAAcC,kBAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,QAAQ,CAAA,CAAA;AACtE,EAAA,MAAMC,UAAQ,WAAY,CAAA,SAAA,CAAU,EAAE,UAAA,EAAY,aAAa,CAAA,CAAA;AAE/D,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA,CAAA;AACzC,EAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,yBAAA,EAA2B,OAAO,OAAA,EAAS,QAAa,KAAA;AACjE,IAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,KAAS,OAAQ,CAAA,MAAA,CAAA;AAC1C,IAAA,MAAM,YAAYC,+BAAmB,CAAA,EAAE,IAAM,EAAA,SAAA,EAAW,MAAM,CAAA,CAAA;AAC9D,IAAA,MAAM,QAAY,GAAA,MAAMJ,OAAM,CAAA,GAAA,CAAI,SAAS,CAAA,CAAA;AAE3C,IAAA,IAAI,QAAU,EAAA;AACZ,MAAO,MAAA,CAAA,IAAA,CAAK,CAAsB,mBAAA,EAAA,SAAS,CAAc,YAAA,CAAA,CAAA,CAAA;AACzD,MAAS,QAAA,CAAA,IAAA,CAAK,SAAS,IAAI,CAAA,CAAA;AAC3B,MAAS,QAAA,CAAA,IAAA,CAAK,SAAS,OAAO,CAAA,CAAA;AAC9B,MAAA,OAAA;AAAA,KACF;AACA,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA,SAAA;AAAA,KACjB,CAAA,CAAA;AACD,IAAA,MAAM,SAAS,MAAMH,eAAA,CAAc,eAAe,SAAW,EAAA,EAAE,OAAO,CAAA,CAAA;AACtE,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAO,MAAA,CAAA,IAAA,CAAK,CAA4B,yBAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AACnD,MACG,QAAA,CAAA,MAAA,CAAO,GAAG,CACV,CAAA,IAAA,CAAK,EAAE,KAAO,EAAA,CAAA,yBAAA,EAA4B,SAAS,CAAA,CAAA,EAAI,CAAA,CAAA;AAC1D,MAAA,OAAA;AAAA,KACF;AACA,IAAM,MAAA,MAAA,GAASQ,qCAAwB,MAAM,CAAA,CAAA;AAE7C,IAAA,IAAI,CAAC,MAAA,IAAU,MAAO,CAAA,IAAA,KAAS,KAAO,EAAA;AACpC,MAAM,MAAA,YAAA,GAAe,CAA0B,uBAAA,EAAA,MAAA,CAAO,MAAM,CAAA,CAAA,CAAA;AAC5D,MAAA,MAAA,CAAO,KAAK,YAAY,CAAA,CAAA;AACxB,MAAM,MAAA,IAAIC,qBAAc,YAAY,CAAA,CAAA;AAAA,KACtC;AACA,IAAA,MAAM,WAAc,GAAA,YAAA,CAAa,KAAM,CAAA,MAAA,CAAO,MAAM,CAAA,CAAA;AAEpD,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAA,MAAA,CAAO,IAAK,CAAA,CAAA,yBAAA,EAA4B,MAAO,CAAA,MAAM,CAAE,CAAA,CAAA,CAAA;AACvD,MACG,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CACV,IAAK,CAAA,EAAE,OAAO,CAA4B,yBAAA,EAAA,MAAA,CAAO,MAAM,CAAA,CAAA,EAAI,CAAA,CAAA;AAC9D,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,KAAA,MAAW,YAAY,YAAc,EAAA;AACnC,MAAM,MAAA,GAAA,GAAM,YAAY,UAAW,CAAA;AAAA,QACjC,KAAK,QAAS,CAAA,IAAA;AAAA,QACd,MAAM,MAAO,CAAA,MAAA;AAAA,OACd,CAAA,CAAA;AAED,MAAI,IAAA,OAAA,CAAA;AAEJ,MAAI,IAAA;AACF,QAAO,MAAA,CAAA,IAAA,CAAK,gBAAgB,SAAS,CAAA,EAAA,EAAK,GAAG,CAAK,EAAA,EAAA,QAAA,CAAS,IAAI,CAAG,CAAA,CAAA,CAAA,CAAA;AAClE,QAAS,QAAA,CAAA,IAAA,CAAK,SAAS,IAAI,CAAA,CAAA;AAE3B,QAAA,MAAM,WAAc,GAAA,MAAM,MAAO,CAAA,OAAA,CAAQ,GAAG,CAAA,CAAA;AAC5C,QAAA,OAAA,GAAA,CAAW,MAAM,WAAA,CAAY,MAAO,EAAA,EAAG,SAAS,OAAO,CAAA,CAAA;AAEvD,QAAI,IAAA,SAAA,CAAU,OAAO,CAAG,EAAA;AACtB,UAAM,MAAA,UAAA,GAAa,YAAY,UAAW,CAAA;AAAA,YACxC,GAAK,EAAA,OAAA;AAAA,YACL,MAAM,MAAO,CAAA,MAAA;AAAA,WACd,CAAA,CAAA;AACD,UAAA,MAAM,kBAAqB,GAAA,MAAM,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AAC1D,UAAA,OAAA,GAAA,CAAW,MAAM,kBAAA,CAAmB,MAAO,EAAA,EAAG,SAAS,OAAO,CAAA,CAAA;AAAA,SAChE;AAEA,QAAAN,OAAA,CAAM,IAAI,SAAW,EAAA;AAAA,UACnB,MAAM,QAAS,CAAA,IAAA;AAAA,UACf,MAAM,QAAS,CAAA,IAAA;AAAA,UACf,OAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAA,QAAA,CAAS,KAAK,OAAO,CAAA,CAAA;AACrB,QAAA,OAAA;AAAA,eACO,KAAgB,EAAA;AACvB,QAAA,IAAIO,cAAQ,CAAA,KAAK,CAAK,IAAA,KAAA,CAAM,SAAS,eAAiB,EAAA;AACpD,UAAA,SAAA;AAAA,SACK,MAAA;AACL,UAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,YACxB,KAAA,EAAO,mBAAmB,KAAK,CAAA,CAAA;AAAA,WAChC,CAAA,CAAA;AACD,UAAA,OAAA;AAAA,SACF;AAAA,OACF;AAAA,KACF;AACA,IAAO,MAAA,CAAA,IAAA,CAAK,CAAwB,qBAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAC/C,IAAM,MAAA,IAAID,qBAAc,2BAA2B,CAAA,CAAA;AAAA,GACpD,CAAA,CAAA;AAED,EAAA,MAAM,aAAaE,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,QAAQ,CAAA,CAAA;AAC9D,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA,CAAA;AAC7B,EAAO,OAAA,MAAA,CAAA;AACT;;ACjLO,MAAM,eAAeC,oCAAoB,CAAA;AAAA,EAC9C,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,SAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,YAAYA,6BAAa,CAAA,UAAA;AAAA,OAC3B;AAAA,MACA,MAAM,KAAK,EAAE,IAAA,EAAM,QAAQ,MAAQ,EAAA,MAAA,EAAQ,SAAW,EAAA,UAAA,EAAc,EAAA;AAClE,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,IAAA;AAAA,YACA,MAAA;AAAA,YACA,MAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/lib.ts","../src/service/constants.ts","../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["const DETECT_SYMLINKS_REGEX = '^(w+|.|/|-)+$';\n\nexport const isSymLink = (content: string): boolean => {\n  const lines = content.split('\\n');\n  if (lines.length > 1) return false;\n  const line = lines[0];\n  if (line.includes(' ')) return false;\n\n  const regex = RegExp(DETECT_SYMLINKS_REGEX);\n  return regex.test(content);\n};\n","import { FileType } from './types';\n\n// Cache placeholder for entities where no readme\nexport const NOT_FOUND_PLACEHOLDER = 'NOT_FOUND';\nexport const DEFAULT_TTL = 1800 * 1000;\n\nexport const README_TYPES: FileType[] = [\n  { name: 'README', type: 'text/plain' },\n  { name: 'README.md', type: 'text/markdown' },\n  { name: 'README.rst', type: 'text/plain' },\n  { name: 'README.txt', type: 'text/plain' },\n  { name: 'README.MD', type: 'text/markdown' },\n];\n","import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';\nimport { CacheManager } from '@backstage/backend-defaults/cache';\nimport {\n  AuthService,\n  DiscoveryService,\n  LoggerService,\n  RootConfigService,\n  UrlReaderService,\n} from '@backstage/backend-plugin-api';\nimport { ScmIntegrations } from '@backstage/integration';\nimport {\n  getEntitySourceLocation,\n  stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport { CatalogClient } from '@backstage/catalog-client';\nimport { isError, NotFoundError } from '@backstage/errors';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { isSymLink } from '../lib';\nimport { DEFAULT_TTL, NOT_FOUND_PLACEHOLDER, README_TYPES } from './constants';\nimport { ReadmeFile } from './types';\n\n/**\n * Constructs a readme router.\n *\n */\ninterface RouterOptions {\n  auth: AuthService;\n  config: RootConfigService;\n  discovery: DiscoveryService;\n  logger: LoggerService;\n  reader: UrlReaderService;\n}\n\n/**\n * Constructs a readme router.\n *\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const { auth, logger, config, reader, discovery } = options;\n  const catalogClient = new CatalogClient({ discoveryApi: discovery });\n\n  const pluginCache = CacheManager.fromConfig(config).forPlugin('readme');\n  const cache = pluginCache.getClient({ defaultTtl: DEFAULT_TTL });\n\n  logger.info('Initializing readme backend');\n  const integrations = ScmIntegrations.fromConfig(config);\n  const router = Router();\n  router.use(express.json());\n\n  router.get('/health', (_, response) => {\n    response.json({ status: 'ok' });\n  });\n\n  router.get('/:kind/:namespace/:name', async (request, response) => {\n    const { kind, namespace, name } = request.params;\n    const entityRef = stringifyEntityRef({ kind, namespace, name });\n    const cacheDoc = (await cache.get(entityRef)) as ReadmeFile | undefined;\n\n    if (cacheDoc && cacheDoc.name === NOT_FOUND_PLACEHOLDER) {\n      throw new NotFoundError('Readme could not be found');\n    }\n    if (cacheDoc) {\n      logger.info(`Loading README for ${entityRef} from cache.`);\n      response.type(cacheDoc.type);\n      response.send(cacheDoc.content);\n      return;\n    }\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: 'catalog',\n    });\n    const entity = await catalogClient.getEntityByRef(entityRef, { token });\n    if (!entity) {\n      logger.info(`No integration found for ${entityRef}`);\n      response\n        .status(500)\n        .json({ error: `No integration found for ${entityRef}` });\n      return;\n    }\n    const source = getEntitySourceLocation(entity);\n\n    if (!source || source.type !== 'url') {\n      const errorMessage = `Not valid location for ${source.target}`;\n      logger.info(errorMessage);\n      throw new NotFoundError(errorMessage);\n    }\n    const integration = integrations.byUrl(source.target);\n\n    if (!integration) {\n      logger.info(`No integration found for ${source.target}`);\n      response\n        .status(500)\n        .json({ error: `No integration found for ${source.target}` });\n      return;\n    }\n\n    for (const fileType of README_TYPES) {\n      const url = integration.resolveUrl({\n        url: fileType.name,\n        base: source.target,\n      });\n\n      let content;\n\n      try {\n        logger.debug(`Trying README location: ${url} for ${entityRef} `);\n        response.type(fileType.type);\n\n        const urlResponse = await reader.readUrl(url);\n        content = (await urlResponse.buffer()).toString('utf-8');\n\n        if (isSymLink(content)) {\n          const symLinkUrl = integration.resolveUrl({\n            url: content,\n            base: source.target,\n          });\n          const symLinkUrlResponse = await reader.readUrl(symLinkUrl);\n          content = (await symLinkUrlResponse.buffer()).toString('utf-8');\n        }\n\n        cache.set(entityRef, {\n          name: fileType.name,\n          type: fileType.type,\n          content: content,\n        });\n        logger.info(\n          `Found README for ${entityRef}: ${url} type ${fileType.type}`,\n        );\n        response.send(content);\n        return;\n      } catch (error: unknown) {\n        if (isError(error) && error.name === 'NotFoundError') {\n          continue;\n        } else {\n          response.status(500).json({\n            error: `Readme failure: ${error}`,\n          });\n          return;\n        }\n      }\n    }\n    logger.info(`Readme not found for ${entityRef}`);\n    cache.set(entityRef, {\n      name: NOT_FOUND_PLACEHOLDER,\n      type: '',\n      content: '',\n    });\n    throw new NotFoundError('Readme could not be found');\n  });\n\n  const middleware = MiddlewareFactory.create({ logger, config });\n  router.use(middleware.error());\n  return router;\n}\n","import {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * The Readme backend plugin.\n *\n * @public\n */\nexport const readmePlugin = createBackendPlugin({\n  pluginId: 'readme',\n  register(env) {\n    env.registerInit({\n      deps: {\n        auth: coreServices.auth,\n        config: coreServices.rootConfig,\n        discovery: coreServices.discovery,\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        reader: coreServices.urlReader,\n      },\n      async init({ auth, logger, config, reader, discovery, httpRouter }) {\n        httpRouter.use(\n          await createRouter({\n            auth,\n            logger,\n            config,\n            reader,\n            discovery,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["catalogClient","CatalogClient","CacheManager","cache","ScmIntegrations","Router","express","stringifyEntityRef","NotFoundError","getEntitySourceLocation","isError","MiddlewareFactory","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,MAAM,qBAAwB,GAAA,eAAA,CAAA;AAEjB,MAAA,SAAA,GAAY,CAAC,OAA6B,KAAA;AACrD,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,KAAA,CAAM,IAAI,CAAA,CAAA;AAChC,EAAI,IAAA,KAAA,CAAM,MAAS,GAAA,CAAA,EAAU,OAAA,KAAA,CAAA;AAC7B,EAAM,MAAA,IAAA,GAAO,MAAM,CAAC,CAAA,CAAA;AACpB,EAAA,IAAI,IAAK,CAAA,QAAA,CAAS,GAAG,CAAA,EAAU,OAAA,KAAA,CAAA;AAE/B,EAAM,MAAA,KAAA,GAAQ,OAAO,qBAAqB,CAAA,CAAA;AAC1C,EAAO,OAAA,KAAA,CAAM,KAAK,OAAO,CAAA,CAAA;AAC3B,CAAA;;ACPO,MAAM,qBAAwB,GAAA,WAAA,CAAA;AAC9B,MAAM,cAAc,IAAO,GAAA,GAAA,CAAA;AAE3B,MAAM,YAA2B,GAAA;AAAA,EACtC,EAAE,IAAA,EAAM,QAAU,EAAA,IAAA,EAAM,YAAa,EAAA;AAAA,EACrC,EAAE,IAAA,EAAM,WAAa,EAAA,IAAA,EAAM,eAAgB,EAAA;AAAA,EAC3C,EAAE,IAAA,EAAM,YAAc,EAAA,IAAA,EAAM,YAAa,EAAA;AAAA,EACzC,EAAE,IAAA,EAAM,YAAc,EAAA,IAAA,EAAM,YAAa,EAAA;AAAA,EACzC,EAAE,IAAA,EAAM,WAAa,EAAA,IAAA,EAAM,eAAgB,EAAA;AAC7C,CAAA;;AC0BA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,IAAM,EAAA,MAAA,EAAQ,MAAQ,EAAA,MAAA,EAAQ,WAAc,GAAA,OAAA,CAAA;AACpD,EAAA,MAAMA,kBAAgB,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,WAAW,CAAA,CAAA;AAEnE,EAAA,MAAM,cAAcC,kBAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,QAAQ,CAAA,CAAA;AACtE,EAAA,MAAMC,UAAQ,WAAY,CAAA,SAAA,CAAU,EAAE,UAAA,EAAY,aAAa,CAAA,CAAA;AAE/D,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA,CAAA;AACzC,EAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,yBAAA,EAA2B,OAAO,OAAA,EAAS,QAAa,KAAA;AACjE,IAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,KAAS,OAAQ,CAAA,MAAA,CAAA;AAC1C,IAAA,MAAM,YAAYC,+BAAmB,CAAA,EAAE,IAAM,EAAA,SAAA,EAAW,MAAM,CAAA,CAAA;AAC9D,IAAA,MAAM,QAAY,GAAA,MAAMJ,OAAM,CAAA,GAAA,CAAI,SAAS,CAAA,CAAA;AAE3C,IAAI,IAAA,QAAA,IAAY,QAAS,CAAA,IAAA,KAAS,qBAAuB,EAAA;AACvD,MAAM,MAAA,IAAIK,qBAAc,2BAA2B,CAAA,CAAA;AAAA,KACrD;AACA,IAAA,IAAI,QAAU,EAAA;AACZ,MAAO,MAAA,CAAA,IAAA,CAAK,CAAsB,mBAAA,EAAA,SAAS,CAAc,YAAA,CAAA,CAAA,CAAA;AACzD,MAAS,QAAA,CAAA,IAAA,CAAK,SAAS,IAAI,CAAA,CAAA;AAC3B,MAAS,QAAA,CAAA,IAAA,CAAK,SAAS,OAAO,CAAA,CAAA;AAC9B,MAAA,OAAA;AAAA,KACF;AACA,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA,SAAA;AAAA,KACjB,CAAA,CAAA;AACD,IAAA,MAAM,SAAS,MAAMR,eAAA,CAAc,eAAe,SAAW,EAAA,EAAE,OAAO,CAAA,CAAA;AACtE,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAO,MAAA,CAAA,IAAA,CAAK,CAA4B,yBAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AACnD,MACG,QAAA,CAAA,MAAA,CAAO,GAAG,CACV,CAAA,IAAA,CAAK,EAAE,KAAO,EAAA,CAAA,yBAAA,EAA4B,SAAS,CAAA,CAAA,EAAI,CAAA,CAAA;AAC1D,MAAA,OAAA;AAAA,KACF;AACA,IAAM,MAAA,MAAA,GAASS,qCAAwB,MAAM,CAAA,CAAA;AAE7C,IAAA,IAAI,CAAC,MAAA,IAAU,MAAO,CAAA,IAAA,KAAS,KAAO,EAAA;AACpC,MAAM,MAAA,YAAA,GAAe,CAA0B,uBAAA,EAAA,MAAA,CAAO,MAAM,CAAA,CAAA,CAAA;AAC5D,MAAA,MAAA,CAAO,KAAK,YAAY,CAAA,CAAA;AACxB,MAAM,MAAA,IAAID,qBAAc,YAAY,CAAA,CAAA;AAAA,KACtC;AACA,IAAA,MAAM,WAAc,GAAA,YAAA,CAAa,KAAM,CAAA,MAAA,CAAO,MAAM,CAAA,CAAA;AAEpD,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAA,MAAA,CAAO,IAAK,CAAA,CAAA,yBAAA,EAA4B,MAAO,CAAA,MAAM,CAAE,CAAA,CAAA,CAAA;AACvD,MACG,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CACV,IAAK,CAAA,EAAE,OAAO,CAA4B,yBAAA,EAAA,MAAA,CAAO,MAAM,CAAA,CAAA,EAAI,CAAA,CAAA;AAC9D,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,KAAA,MAAW,YAAY,YAAc,EAAA;AACnC,MAAM,MAAA,GAAA,GAAM,YAAY,UAAW,CAAA;AAAA,QACjC,KAAK,QAAS,CAAA,IAAA;AAAA,QACd,MAAM,MAAO,CAAA,MAAA;AAAA,OACd,CAAA,CAAA;AAED,MAAI,IAAA,OAAA,CAAA;AAEJ,MAAI,IAAA;AACF,QAAA,MAAA,CAAO,KAAM,CAAA,CAAA,wBAAA,EAA2B,GAAG,CAAA,KAAA,EAAQ,SAAS,CAAG,CAAA,CAAA,CAAA,CAAA;AAC/D,QAAS,QAAA,CAAA,IAAA,CAAK,SAAS,IAAI,CAAA,CAAA;AAE3B,QAAA,MAAM,WAAc,GAAA,MAAM,MAAO,CAAA,OAAA,CAAQ,GAAG,CAAA,CAAA;AAC5C,QAAA,OAAA,GAAA,CAAW,MAAM,WAAA,CAAY,MAAO,EAAA,EAAG,SAAS,OAAO,CAAA,CAAA;AAEvD,QAAI,IAAA,SAAA,CAAU,OAAO,CAAG,EAAA;AACtB,UAAM,MAAA,UAAA,GAAa,YAAY,UAAW,CAAA;AAAA,YACxC,GAAK,EAAA,OAAA;AAAA,YACL,MAAM,MAAO,CAAA,MAAA;AAAA,WACd,CAAA,CAAA;AACD,UAAA,MAAM,kBAAqB,GAAA,MAAM,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AAC1D,UAAA,OAAA,GAAA,CAAW,MAAM,kBAAA,CAAmB,MAAO,EAAA,EAAG,SAAS,OAAO,CAAA,CAAA;AAAA,SAChE;AAEA,QAAAL,OAAA,CAAM,IAAI,SAAW,EAAA;AAAA,UACnB,MAAM,QAAS,CAAA,IAAA;AAAA,UACf,MAAM,QAAS,CAAA,IAAA;AAAA,UACf,OAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAO,MAAA,CAAA,IAAA;AAAA,UACL,oBAAoB,SAAS,CAAA,EAAA,EAAK,GAAG,CAAA,MAAA,EAAS,SAAS,IAAI,CAAA,CAAA;AAAA,SAC7D,CAAA;AACA,QAAA,QAAA,CAAS,KAAK,OAAO,CAAA,CAAA;AACrB,QAAA,OAAA;AAAA,eACO,KAAgB,EAAA;AACvB,QAAA,IAAIO,cAAQ,CAAA,KAAK,CAAK,IAAA,KAAA,CAAM,SAAS,eAAiB,EAAA;AACpD,UAAA,SAAA;AAAA,SACK,MAAA;AACL,UAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,YACxB,KAAA,EAAO,mBAAmB,KAAK,CAAA,CAAA;AAAA,WAChC,CAAA,CAAA;AACD,UAAA,OAAA;AAAA,SACF;AAAA,OACF;AAAA,KACF;AACA,IAAO,MAAA,CAAA,IAAA,CAAK,CAAwB,qBAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAC/C,IAAAP,OAAA,CAAM,IAAI,SAAW,EAAA;AAAA,MACnB,IAAM,EAAA,qBAAA;AAAA,MACN,IAAM,EAAA,EAAA;AAAA,MACN,OAAS,EAAA,EAAA;AAAA,KACV,CAAA,CAAA;AACD,IAAM,MAAA,IAAIK,qBAAc,2BAA2B,CAAA,CAAA;AAAA,GACpD,CAAA,CAAA;AAED,EAAA,MAAM,aAAaG,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,QAAQ,CAAA,CAAA;AAC9D,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA,CAAA;AAC7B,EAAO,OAAA,MAAA,CAAA;AACT;;ACjJO,MAAM,eAAeC,oCAAoB,CAAA;AAAA,EAC9C,QAAU,EAAA,QAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAMC,6BAAa,CAAA,IAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,SAAA;AAAA,OACvB;AAAA,MACA,MAAM,KAAK,EAAE,IAAA,EAAM,QAAQ,MAAQ,EAAA,MAAA,EAAQ,SAAW,EAAA,UAAA,EAAc,EAAA;AAClE,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,IAAA;AAAA,YACA,MAAA;AAAA,YACA,MAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/index.d.ts

@@ -1,45 +1,4 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { LoggerService, RootConfigService, UrlReaderService, DiscoveryService, TokenManagerService, AuthService } from '@backstage/backend-plugin-api';
-import express from 'express';
-
-/**
- * Constructs a readme router.
- * @deprecated Please migrate to the new backend system as this will be removed in the future.
- * @public
- */
-interface RouterOptions {
-    /**
-     * Implementation of Winston logger
-     */
-    logger: LoggerService;
-    /**
-     * Backstage config object
-     */
-    config: RootConfigService;
-    /**
-     * Backstage url reader instance
-     */
-    reader: UrlReaderService;
-    /**
-     * Backstage discovery service
-     */
-    discovery: DiscoveryService;
-    /**
-     * Backstage token manager service
-     */
-    tokenManager?: TokenManagerService;
-    /**
-     * Backstage auth service
-     */
-    auth?: AuthService;
-}
-/**
- * Constructs a readme router.
- *
- * @deprecated Please migrate to the new backend system as this will be removed in the future.
- * @public
- */
-declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
 /**
  * The Readme backend plugin.
@@ -48,4 +7,4 @@ declare function createRouter(options: RouterOptions): Promise<express.Router>;
  */
 declare const readmePlugin: _backstage_backend_plugin_api.BackendFeatureCompat;
 
-export { type RouterOptions, createRouter, readmePlugin as default };
+export { readmePlugin as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axis-backstage/plugin-readme-backend",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -28,7 +28,6 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.24.0",
     "@backstage/backend-defaults": "^0.4.3",
     "@backstage/backend-plugin-api": "^0.8.0",
     "@backstage/catalog-client": "^1.6.6",
@@ -50,4 +49,4 @@
     "dist"
   ],
   "directory": "_release/package"
-}
+}