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

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @axis-backstage/plugin-readme-backend
 
+## 0.13.0
+
+### Minor Changes
+
+- 84e60e6: A configuration has been added to the readme backend that makes it possible to
+  configure which files to look for and the exact order. Example:
+
+  ```yaml
+  readme:
+    -fileNames:
+      - README.txt
+      - README.text
+      - README.markdown
+  ```
+
+## 0.12.0
+
+### Minor Changes
+
+- ede8341: Updated to Backstage v1.36.1.
+
 ## 0.11.0
 
 ### Minor Changes

package/README.md

@@ -32,6 +32,20 @@ const backend = createBackend();
 backend.start();
 ```
 
+### Configuration
+
+This plugin does not require any configuration. It has a default configuration
+with a set of README file names that it will look for in the entity source location. This actual file to use and the order to look for them can be
+configured in the `app-config.yaml` file using the "readme.fileNames" configuration key. This is a simple list of file names to look for in the entity source location.
+
+```yaml
+readme:
+  -fileNames:
+    - README.txt
+    - README.text
+    - README.markdown
+```
+
 ### Troubleshooting
 
 If the backend fails to provide README content for an entity, it could be due to several reasons.

package/config.d.ts

@@ -0,0 +1,12 @@
+export interface Config {
+  /**
+   * Configuration options for the Readme backend plugin
+   */
+  readme?: {
+    /**
+     * Optional list of file names to try. Specifies the file names to try
+     * when looking for a README file and which order to use.
+     */
+    fileNames?: string[];
+  };
+}

package/dist/index.cjs.js

@@ -2,167 +2,9 @@
 
 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 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 plugin = require('./plugin.cjs.js');
 
-function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
-var express__default = /*#__PURE__*/_interopDefaultCompat(express);
-var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
 
-const DETECT_SYMLINKS_REGEX = "^(w+|.|/|-)+$";
-const isSymLink = (content) => {
-  const lines = content.split("\n");
-  if (lines.length > 1) return false;
-  const line = lines[0];
-  if (line.includes(" ")) return false;
-  const regex = RegExp(DETECT_SYMLINKS_REGEX);
-  return regex.test(content);
-};
-
-const NOT_FOUND_PLACEHOLDER = "NOT_FOUND";
-const DEFAULT_TTL = 1800 * 1e3;
-const README_TYPES = [
-  { name: "README", type: "text/plain" },
-  { name: "README.md", type: "text/markdown" },
-  { name: "README.rst", type: "text/plain" },
-  { name: "README.txt", type: "text/plain" },
-  { name: "README.MD", type: "text/markdown" }
-];
-
-async function createRouter(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 });
-  logger.info("Initializing readme backend");
-  const integrations = integration.ScmIntegrations.fromConfig(config);
-  const router = Router__default.default();
-  router.use(express__default.default.json());
-  router.get("/health", (_, response) => {
-    response.json({ status: "ok" });
-  });
-  router.get("/:kind/:namespace/:name", async (request, response) => {
-    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);
-      response.send(cacheDoc.content);
-      return;
-    }
-    const { token } = await auth.getPluginRequestToken({
-      onBehalfOf: await auth.getOwnServiceCredentials(),
-      targetPluginId: "catalog"
-    });
-    const entity = await catalogClient$1.getEntityByRef(entityRef, { token });
-    if (!entity) {
-      logger.info(`No integration found for ${entityRef}`);
-      response.status(500).json({ error: `No integration found for ${entityRef}` });
-      return;
-    }
-    const source = catalogModel.getEntitySourceLocation(entity);
-    if (!source || source.type !== "url") {
-      const errorMessage = `Not valid location for ${source.target}`;
-      logger.info(errorMessage);
-      throw new errors.NotFoundError(errorMessage);
-    }
-    const integration = integrations.byUrl(source.target);
-    if (!integration) {
-      logger.info(`No integration found for ${source.target}`);
-      response.status(500).json({ error: `No integration found for ${source.target}` });
-      return;
-    }
-    for (const fileType of README_TYPES) {
-      const url = integration.resolveUrl({
-        url: fileType.name,
-        base: source.target
-      });
-      let content;
-      try {
-        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");
-        if (isSymLink(content)) {
-          const symLinkUrl = integration.resolveUrl({
-            url: content,
-            base: source.target
-          });
-          const symLinkUrlResponse = await reader.readUrl(symLinkUrl);
-          content = (await symLinkUrlResponse.buffer()).toString("utf-8");
-        }
-        cache$1.set(entityRef, {
-          name: fileType.name,
-          type: fileType.type,
-          content
-        });
-        logger.info(
-          `Found README for ${entityRef}: ${url} type ${fileType.type}`
-        );
-        response.send(content);
-        return;
-      } catch (error) {
-        if (errors.isError(error) && error.name === "NotFoundError") {
-          continue;
-        } else {
-          response.status(500).json({
-            error: `Readme failure: ${error}`
-          });
-          return;
-        }
-      }
-    }
-    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 });
-  router.use(middleware.error());
-  return router;
-}
-
-const readmePlugin = backendPluginApi.createBackendPlugin({
-  pluginId: "readme",
-  register(env) {
-    env.registerInit({
-      deps: {
-        auth: backendPluginApi.coreServices.auth,
-        config: backendPluginApi.coreServices.rootConfig,
-        discovery: backendPluginApi.coreServices.discovery,
-        httpRouter: backendPluginApi.coreServices.httpRouter,
-        logger: backendPluginApi.coreServices.logger,
-        reader: backendPluginApi.coreServices.urlReader
-      },
-      async init({ auth, logger, config, reader, discovery, httpRouter }) {
-        httpRouter.use(
-          await createRouter({
-            auth,
-            logger,
-            config,
-            reader,
-            discovery
-          })
-        );
-      }
-    });
-  }
-});
-
-exports.default = readmePlugin;
+exports.default = plugin.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/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;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/index.d.ts

@@ -5,6 +5,6 @@ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
  *
  * @public
  */
-declare const readmePlugin: _backstage_backend_plugin_api.BackendFeatureCompat;
+declare const readmePlugin: _backstage_backend_plugin_api.BackendFeature;
 
 export { readmePlugin as default };

package/dist/lib.cjs.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const DETECT_SYMLINKS_REGEX = "^(w+|.|/|-)+$";
+const isSymLink = (content) => {
+  const lines = content.split("\n");
+  if (lines.length > 1) return false;
+  const line = lines[0];
+  if (line.includes(" ")) return false;
+  const regex = RegExp(DETECT_SYMLINKS_REGEX);
+  return regex.test(content);
+};
+
+exports.isSymLink = isSymLink;
+//# sourceMappingURL=lib.cjs.js.map

package/dist/lib.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.cjs.js","sources":["../src/lib.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"],"names":[],"mappings":";;AAAA,MAAM,qBAAwB,GAAA,eAAA;AAEjB,MAAA,SAAA,GAAY,CAAC,OAA6B,KAAA;AACrD,EAAM,MAAA,KAAA,GAAQ,OAAQ,CAAA,KAAA,CAAM,IAAI,CAAA;AAChC,EAAI,IAAA,KAAA,CAAM,MAAS,GAAA,CAAA,EAAU,OAAA,KAAA;AAC7B,EAAM,MAAA,IAAA,GAAO,MAAM,CAAC,CAAA;AACpB,EAAA,IAAI,IAAK,CAAA,QAAA,CAAS,GAAG,CAAA,EAAU,OAAA,KAAA;AAE/B,EAAM,MAAA,KAAA,GAAQ,OAAO,qBAAqB,CAAA;AAC1C,EAAO,OAAA,KAAA,CAAM,KAAK,OAAO,CAAA;AAC3B;;;;"}

package/dist/plugin.cjs.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var router = require('./service/router.cjs.js');
+
+const readmePlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "readme",
+  register(env) {
+    env.registerInit({
+      deps: {
+        auth: backendPluginApi.coreServices.auth,
+        config: backendPluginApi.coreServices.rootConfig,
+        discovery: backendPluginApi.coreServices.discovery,
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        logger: backendPluginApi.coreServices.logger,
+        reader: backendPluginApi.coreServices.urlReader,
+        cache: backendPluginApi.coreServices.cache
+      },
+      async init({
+        auth,
+        logger,
+        config,
+        reader,
+        discovery,
+        httpRouter,
+        cache
+      }) {
+        httpRouter.use(
+          await router.createRouter({
+            auth,
+            logger,
+            config,
+            reader,
+            discovery,
+            cache
+          })
+        );
+      }
+    });
+  }
+});
+
+exports.readmePlugin = readmePlugin;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["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        cache: coreServices.cache,\n      },\n      async init({\n        auth,\n        logger,\n        config,\n        reader,\n        discovery,\n        httpRouter,\n        cache,\n      }) {\n        httpRouter.use(\n          await createRouter({\n            auth,\n            logger,\n            config,\n            reader,\n            discovery,\n            cache,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter"],"mappings":";;;;;AAWO,MAAM,eAAeA,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,QACrB,OAAOA,6BAAa,CAAA;AAAA,OACtB;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,IAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,UAAA;AAAA,QACA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,IAAA;AAAA,YACA,MAAA;AAAA,YACA,MAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/dist/service/constants.cjs.js

@@ -0,0 +1,25 @@
+'use strict';
+
+const CONFIG_PATH = "readme.fileNames";
+const NOT_FOUND_PLACEHOLDER = "NOT_FOUND";
+const DEFAULT_README_TYPES = [
+  { name: "README.md", type: "text/markdown" },
+  { name: "README.MD", type: "text/markdown" },
+  { name: "README", type: "text/plain" },
+  { name: "README.rst", type: "text/plain" },
+  { name: "README.txt", type: "text/plain" }
+];
+function getReadmeTypes(config) {
+  const readmeTypes = config.getOptionalStringArray(CONFIG_PATH);
+  if (!readmeTypes) {
+    return DEFAULT_README_TYPES;
+  }
+  return readmeTypes.map((name) => {
+    const type = name.endsWith(".md") || name.endsWith(".MD") ? "text/markdown" : "text/plain";
+    return { name, type };
+  });
+}
+
+exports.NOT_FOUND_PLACEHOLDER = NOT_FOUND_PLACEHOLDER;
+exports.getReadmeTypes = getReadmeTypes;
+//# sourceMappingURL=constants.cjs.js.map

package/dist/service/constants.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.cjs.js","sources":["../../src/service/constants.ts"],"sourcesContent":["import { RootConfigService } from '@backstage/backend-plugin-api';\nimport { FileType } from './types';\n\nconst CONFIG_PATH = 'readme.fileNames';\n\n// Cache placeholder for entities where no readme\nexport const NOT_FOUND_PLACEHOLDER = 'NOT_FOUND';\n\nconst DEFAULT_README_TYPES: FileType[] = [\n  { name: 'README.md', type: 'text/markdown' },\n  { name: 'README.MD', type: 'text/markdown' },\n  { name: 'README', type: 'text/plain' },\n  { name: 'README.rst', type: 'text/plain' },\n  { name: 'README.txt', type: 'text/plain' },\n];\n\nexport function getReadmeTypes(config: RootConfigService): FileType[] {\n  const readmeTypes = config.getOptionalStringArray(CONFIG_PATH);\n  if (!readmeTypes) {\n    return DEFAULT_README_TYPES;\n  }\n  return readmeTypes.map(name => {\n    const type =\n      name.endsWith('.md') || name.endsWith('.MD')\n        ? 'text/markdown'\n        : 'text/plain';\n    return { name, type };\n  });\n}\n"],"names":[],"mappings":";;AAGA,MAAM,WAAc,GAAA,kBAAA;AAGb,MAAM,qBAAwB,GAAA;AAErC,MAAM,oBAAmC,GAAA;AAAA,EACvC,EAAE,IAAA,EAAM,WAAa,EAAA,IAAA,EAAM,eAAgB,EAAA;AAAA,EAC3C,EAAE,IAAA,EAAM,WAAa,EAAA,IAAA,EAAM,eAAgB,EAAA;AAAA,EAC3C,EAAE,IAAA,EAAM,QAAU,EAAA,IAAA,EAAM,YAAa,EAAA;AAAA,EACrC,EAAE,IAAA,EAAM,YAAc,EAAA,IAAA,EAAM,YAAa,EAAA;AAAA,EACzC,EAAE,IAAA,EAAM,YAAc,EAAA,IAAA,EAAM,YAAa;AAC3C,CAAA;AAEO,SAAS,eAAe,MAAuC,EAAA;AACpE,EAAM,MAAA,WAAA,GAAc,MAAO,CAAA,sBAAA,CAAuB,WAAW,CAAA;AAC7D,EAAA,IAAI,CAAC,WAAa,EAAA;AAChB,IAAO,OAAA,oBAAA;AAAA;AAET,EAAO,OAAA,WAAA,CAAY,IAAI,CAAQ,IAAA,KAAA;AAC7B,IAAM,MAAA,IAAA,GACJ,KAAK,QAAS,CAAA,KAAK,KAAK,IAAK,CAAA,QAAA,CAAS,KAAK,CAAA,GACvC,eACA,GAAA,YAAA;AACN,IAAO,OAAA,EAAE,MAAM,IAAK,EAAA;AAAA,GACrB,CAAA;AACH;;;;;"}

package/dist/service/router.cjs.js

@@ -0,0 +1,118 @@
+'use strict';
+
+var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
+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 lib = require('../lib.cjs.js');
+var constants = require('./constants.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+
+async function createRouter(options) {
+  const { auth, logger, config, reader, discovery, cache } = options;
+  const catalogClient$1 = new catalogClient.CatalogClient({ discoveryApi: discovery });
+  logger.info("Initializing readme backend");
+  const integrations = integration.ScmIntegrations.fromConfig(config);
+  const router = Router__default.default();
+  router.use(express__default.default.json());
+  router.get("/health", (_, response) => {
+    response.json({ status: "ok" });
+  });
+  router.get("/:kind/:namespace/:name", async (request, response) => {
+    const { kind, namespace, name } = request.params;
+    const entityRef = catalogModel.stringifyEntityRef({ kind, namespace, name });
+    const cacheDoc = await cache.get(entityRef);
+    if (cacheDoc && cacheDoc.name === constants.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);
+      response.send(cacheDoc.content);
+      return;
+    }
+    const { token } = await auth.getPluginRequestToken({
+      onBehalfOf: await auth.getOwnServiceCredentials(),
+      targetPluginId: "catalog"
+    });
+    const entity = await catalogClient$1.getEntityByRef(entityRef, { token });
+    if (!entity) {
+      logger.info(`No integration found for ${entityRef}`);
+      response.status(500).json({ error: `No integration found for ${entityRef}` });
+      return;
+    }
+    const source = catalogModel.getEntitySourceLocation(entity);
+    if (!source || source.type !== "url") {
+      const errorMessage = `Not valid location for ${source.target}`;
+      logger.info(errorMessage);
+      throw new errors.NotFoundError(errorMessage);
+    }
+    const integration = integrations.byUrl(source.target);
+    if (!integration) {
+      logger.info(`No integration found for ${source.target}`);
+      response.status(500).json({ error: `No integration found for ${source.target}` });
+      return;
+    }
+    const readmeTypes = constants.getReadmeTypes(config);
+    for (const fileType of readmeTypes) {
+      const url = integration.resolveUrl({
+        url: fileType.name,
+        base: source.target
+      });
+      let content;
+      try {
+        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");
+        if (lib.isSymLink(content)) {
+          const symLinkUrl = integration.resolveUrl({
+            url: content,
+            base: source.target
+          });
+          const symLinkUrlResponse = await reader.readUrl(symLinkUrl);
+          content = (await symLinkUrlResponse.buffer()).toString("utf-8");
+        }
+        cache.set(entityRef, {
+          name: fileType.name,
+          type: fileType.type,
+          content
+        });
+        logger.info(
+          `Found README for ${entityRef}: ${url} type ${fileType.type}`
+        );
+        response.send(content);
+        return;
+      } catch (error) {
+        if (errors.isError(error) && error.name === "NotFoundError") {
+          continue;
+        } else {
+          response.status(500).json({
+            error: `Readme failure: ${error}`
+          });
+          return;
+        }
+      }
+    }
+    logger.info(`Readme not found for ${entityRef}`);
+    cache.set(entityRef, {
+      name: constants.NOT_FOUND_PLACEHOLDER,
+      type: "",
+      content: ""
+    });
+    throw new errors.NotFoundError("Readme could not be found");
+  });
+  const middleware = rootHttpRouter.MiddlewareFactory.create({ logger, config });
+  router.use(middleware.error());
+  return router;
+}
+
+exports.createRouter = createRouter;
+//# sourceMappingURL=router.cjs.js.map

package/dist/service/router.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';\nimport {\n  AuthService,\n  CacheService,\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 { NOT_FOUND_PLACEHOLDER, getReadmeTypes } 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  cache: CacheService;\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, cache } = options;\n  const catalogClient = new CatalogClient({ discoveryApi: discovery });\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    const readmeTypes = getReadmeTypes(config);\n\n    for (const fileType of readmeTypes) {\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"],"names":["catalogClient","CatalogClient","ScmIntegrations","Router","express","stringifyEntityRef","NOT_FOUND_PLACEHOLDER","NotFoundError","getEntitySourceLocation","getReadmeTypes","isSymLink","isError","MiddlewareFactory"],"mappings":";;;;;;;;;;;;;;;;;AAuCA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,IAAM,EAAA,MAAA,EAAQ,QAAQ,MAAQ,EAAA,SAAA,EAAW,OAAU,GAAA,OAAA;AAC3D,EAAA,MAAMA,kBAAgB,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,WAAW,CAAA;AAEnE,EAAA,MAAA,CAAO,KAAK,6BAA6B,CAAA;AACzC,EAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA;AACtD,EAAA,MAAM,SAASC,uBAAO,EAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,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;AAAA,GAC/B,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;AAC1C,IAAA,MAAM,YAAYC,+BAAmB,CAAA,EAAE,IAAM,EAAA,SAAA,EAAW,MAAM,CAAA;AAC9D,IAAA,MAAM,QAAY,GAAA,MAAM,KAAM,CAAA,GAAA,CAAI,SAAS,CAAA;AAE3C,IAAI,IAAA,QAAA,IAAY,QAAS,CAAA,IAAA,KAASC,+BAAuB,EAAA;AACvD,MAAM,MAAA,IAAIC,qBAAc,2BAA2B,CAAA;AAAA;AAErD,IAAA,IAAI,QAAU,EAAA;AACZ,MAAO,MAAA,CAAA,IAAA,CAAK,CAAsB,mBAAA,EAAA,SAAS,CAAc,YAAA,CAAA,CAAA;AACzD,MAAS,QAAA,CAAA,IAAA,CAAK,SAAS,IAAI,CAAA;AAC3B,MAAS,QAAA,CAAA,IAAA,CAAK,SAAS,OAAO,CAAA;AAC9B,MAAA;AAAA;AAEF,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,MACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,MAChD,cAAgB,EAAA;AAAA,KACjB,CAAA;AACD,IAAA,MAAM,SAAS,MAAMP,eAAA,CAAc,eAAe,SAAW,EAAA,EAAE,OAAO,CAAA;AACtE,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAO,MAAA,CAAA,IAAA,CAAK,CAA4B,yBAAA,EAAA,SAAS,CAAE,CAAA,CAAA;AACnD,MACG,QAAA,CAAA,MAAA,CAAO,GAAG,CACV,CAAA,IAAA,CAAK,EAAE,KAAO,EAAA,CAAA,yBAAA,EAA4B,SAAS,CAAA,CAAA,EAAI,CAAA;AAC1D,MAAA;AAAA;AAEF,IAAM,MAAA,MAAA,GAASQ,qCAAwB,MAAM,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;AAC5D,MAAA,MAAA,CAAO,KAAK,YAAY,CAAA;AACxB,MAAM,MAAA,IAAID,qBAAc,YAAY,CAAA;AAAA;AAEtC,IAAA,MAAM,WAAc,GAAA,YAAA,CAAa,KAAM,CAAA,MAAA,CAAO,MAAM,CAAA;AAEpD,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAA,MAAA,CAAO,IAAK,CAAA,CAAA,yBAAA,EAA4B,MAAO,CAAA,MAAM,CAAE,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;AAC9D,MAAA;AAAA;AAGF,IAAM,MAAA,WAAA,GAAcE,yBAAe,MAAM,CAAA;AAEzC,IAAA,KAAA,MAAW,YAAY,WAAa,EAAA;AAClC,MAAM,MAAA,GAAA,GAAM,YAAY,UAAW,CAAA;AAAA,QACjC,KAAK,QAAS,CAAA,IAAA;AAAA,QACd,MAAM,MAAO,CAAA;AAAA,OACd,CAAA;AAED,MAAI,IAAA,OAAA;AAEJ,MAAI,IAAA;AACF,QAAA,MAAA,CAAO,KAAM,CAAA,CAAA,wBAAA,EAA2B,GAAG,CAAA,KAAA,EAAQ,SAAS,CAAG,CAAA,CAAA,CAAA;AAC/D,QAAS,QAAA,CAAA,IAAA,CAAK,SAAS,IAAI,CAAA;AAE3B,QAAA,MAAM,WAAc,GAAA,MAAM,MAAO,CAAA,OAAA,CAAQ,GAAG,CAAA;AAC5C,QAAA,OAAA,GAAA,CAAW,MAAM,WAAA,CAAY,MAAO,EAAA,EAAG,SAAS,OAAO,CAAA;AAEvD,QAAI,IAAAC,aAAA,CAAU,OAAO,CAAG,EAAA;AACtB,UAAM,MAAA,UAAA,GAAa,YAAY,UAAW,CAAA;AAAA,YACxC,GAAK,EAAA,OAAA;AAAA,YACL,MAAM,MAAO,CAAA;AAAA,WACd,CAAA;AACD,UAAA,MAAM,kBAAqB,GAAA,MAAM,MAAO,CAAA,OAAA,CAAQ,UAAU,CAAA;AAC1D,UAAA,OAAA,GAAA,CAAW,MAAM,kBAAA,CAAmB,MAAO,EAAA,EAAG,SAAS,OAAO,CAAA;AAAA;AAGhE,QAAA,KAAA,CAAM,IAAI,SAAW,EAAA;AAAA,UACnB,MAAM,QAAS,CAAA,IAAA;AAAA,UACf,MAAM,QAAS,CAAA,IAAA;AAAA,UACf;AAAA,SACD,CAAA;AACD,QAAO,MAAA,CAAA,IAAA;AAAA,UACL,oBAAoB,SAAS,CAAA,EAAA,EAAK,GAAG,CAAA,MAAA,EAAS,SAAS,IAAI,CAAA;AAAA,SAC7D;AACA,QAAA,QAAA,CAAS,KAAK,OAAO,CAAA;AACrB,QAAA;AAAA,eACO,KAAgB,EAAA;AACvB,QAAA,IAAIC,cAAQ,CAAA,KAAK,CAAK,IAAA,KAAA,CAAM,SAAS,eAAiB,EAAA;AACpD,UAAA;AAAA,SACK,MAAA;AACL,UAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,YACxB,KAAA,EAAO,mBAAmB,KAAK,CAAA;AAAA,WAChC,CAAA;AACD,UAAA;AAAA;AACF;AACF;AAEF,IAAO,MAAA,CAAA,IAAA,CAAK,CAAwB,qBAAA,EAAA,SAAS,CAAE,CAAA,CAAA;AAC/C,IAAA,KAAA,CAAM,IAAI,SAAW,EAAA;AAAA,MACnB,IAAM,EAAAL,+BAAA;AAAA,MACN,IAAM,EAAA,EAAA;AAAA,MACN,OAAS,EAAA;AAAA,KACV,CAAA;AACD,IAAM,MAAA,IAAIC,qBAAc,2BAA2B,CAAA;AAAA,GACpD,CAAA;AAED,EAAA,MAAM,aAAaK,gCAAkB,CAAA,MAAA,CAAO,EAAE,MAAA,EAAQ,QAAQ,CAAA;AAC9D,EAAO,MAAA,CAAA,GAAA,CAAI,UAAW,CAAA,KAAA,EAAO,CAAA;AAC7B,EAAO,OAAA,MAAA;AACT;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axis-backstage/plugin-readme-backend",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -16,7 +16,10 @@
     "pluginPackages": [
       "@axis-backstage/plugin-readme",
       "@axis-backstage/plugin-readme-backend"
-    ]
+    ],
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
   },
   "scripts": {
     "start": "backstage-cli package start",
@@ -28,25 +31,35 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-defaults": "^0.4.3",
-    "@backstage/backend-plugin-api": "^0.8.0",
-    "@backstage/catalog-client": "^1.6.6",
-    "@backstage/catalog-model": "^1.6.0",
-    "@backstage/errors": "^1.2.4",
-    "@backstage/integration": "^1.14.0",
+    "@backstage/backend-defaults": "^0.8.1",
+    "@backstage/backend-plugin-api": "^1.2.0",
+    "@backstage/catalog-client": "^1.9.1",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/integration": "^1.16.1",
     "@types/express": "*",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.5.0",
-    "@backstage/cli": "^0.27.0",
+    "@backstage/backend-test-utils": "^1.3.0",
+    "@backstage/cli": "^0.30.0",
+    "@backstage/config": "^1.3.2",
     "@types/supertest": "^2.0.12",
-    "msw": "^1.0.0",
+    "msw": "^2.7.3",
     "supertest": "^6.2.4"
   },
   "files": [
-    "dist"
+    "dist",
+    "config.d.ts"
   ],
+  "configSchema": "config.d.ts",
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ]
+    }
+  },
   "directory": "_release/package"
 }