@axis-backstage/plugin-readme-backend 0.1.0

package/README.md

@@ -0,0 +1,114 @@
+# Readme backend
+
+Welcome to the readme backend plugin!
+
+The plugin retrieves README.md files from the entity source location. The corresponding frontend plugin responsible for displaying this information is the [Readme plugin](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/readme).
+
+The plugin searches for a README file in the entity source location with any of the following file types:
+
+```ts
+{ 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' },
+```
+
+The plugin can also handle symlinks.
+
+## Setup
+
+The following sections will help you get the Readme Backend plugin setup and running.
+
+### Installation
+
+Install the plugin by following the example below:
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @axis-backstage/plugin-readme-backend
+```
+
+### Integrating
+
+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';
+
+   eexport 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));
+   }
+   ```
+
+3. Now run `yarn start-backend` from the repo root.
+
+4. In another terminal, run the command: `curl localhost:7007/api/readme/health`. The request should return `{"status":"ok"}`.
+
+### 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
++ import { readmePlugin } from '@axis-backstage/readme-backend';
+
+const backend = createBackend();
++ backend.add(readmePlugin());
+// ... other feature additions
+
+backend.start();
+```
+
+### Troubleshooting
+
+If the backend fails to provide README content for an entity, it could be due to several reasons.
+
+#### No Integration Found for Entity
+
+This error message indicates that there is no current integration with the external provider where the README file is located, such as GitHub, GitLab, or Gerrit. When the integration is missing, the backend does not have permission to access the README content.
+
+To resolve this issue, set up the integration for the external provider where the README file is located. You can find more information about Backstage integrations in the [Backstage upstream documentation](https://backstage.io/docs/integrations/).
+
+#### Not a Valid Location for Source Target
+
+This error means that the entity source location cannot be found or is not a valid URL. The `entity source location` is always the same directory as the catalog-info.yaml file.
+
+To debug this error, ensure that the entity source location is valid for the current entity. You can find the entity source location in the entity's catalog-info.yaml file. See the example below:
+
+```yaml
+annotations:
+  backstage.io/source-location: url:https://github.com/AxisCommunications/backstage-plugins/blob/main/
+```
+
+#### README Not Found for Entity
+
+This error indicates that no README, README.md, README.rst, README.txt, or README.MD file was found for that entity. To resolve this error, ensure that there is a README file located in the entity source location with one of the following formats: **md**, **rst**, or **txt**.

package/dist/index.cjs.js

@@ -0,0 +1,162 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendCommon = require('@backstage/backend-common');
+var express = require('express');
+var Router = require('express-promise-router');
+var integration = require('@backstage/integration');
+var catalogModel = require('@backstage/catalog-model');
+var catalogClient = require('@backstage/catalog-client');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
+var Router__default = /*#__PURE__*/_interopDefaultLegacy(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 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 { logger, config, reader, discovery, tokenManager } = options;
+  const catalogClient$1 = new catalogClient.CatalogClient({ discoveryApi: discovery });
+  const pluginCache = backendCommon.CacheManager.fromConfig(config).forPlugin("readme");
+  const cache = 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("/:entityRef", async (request, response) => {
+    const { entityRef } = request.params;
+    const cacheDoc = await cache.get(entityRef);
+    if (cacheDoc) {
+      logger.info(`Loading README for ${entityRef} from cache.`);
+      response.type(cacheDoc.type);
+      response.send(cacheDoc.content);
+      return;
+    }
+    const { token } = await tokenManager.getToken();
+    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") {
+      logger.info(`Not valid location for ${source.target}`);
+      response.status(404).json({
+        error: `Not valid location for ${source.target}`
+      });
+      return;
+    }
+    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.info(`Fetch README ${entityRef}: ${url}, ${fileType.type} `);
+        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.set(entityRef, {
+          name: fileType.name,
+          type: fileType.type,
+          content
+        });
+        response.send(content);
+        return;
+      } catch (error) {
+        if (error instanceof Error && error.name === "NotFoundError") {
+          continue;
+        } else {
+          response.status(500).json({
+            error: `Readme failure: ${error}`
+          });
+          break;
+        }
+      }
+    }
+    logger.info(`Readme not found for ${entityRef}`);
+    response.status(404).json({
+      error: "Readme not found."
+    });
+  });
+  router.use(backendCommon.errorHandler());
+  return router;
+}
+
+const readmePlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "readme",
+  register(env) {
+    env.registerInit({
+      deps: {
+        logger: backendPluginApi.coreServices.logger,
+        config: backendPluginApi.coreServices.rootConfig,
+        reader: backendPluginApi.coreServices.urlReader,
+        discovery: backendPluginApi.coreServices.discovery,
+        tokenManager: backendPluginApi.coreServices.tokenManager,
+        httpRouter: backendPluginApi.coreServices.httpRouter
+      },
+      async init({
+        logger,
+        config,
+        reader,
+        discovery,
+        tokenManager,
+        httpRouter
+      }) {
+        httpRouter.use(
+          await createRouter({
+            logger: backendCommon.loggerToWinstonLogger(logger),
+            config,
+            reader,
+            discovery,
+            tokenManager
+          })
+        );
+      }
+    });
+  }
+});
+
+exports.createRouter = createRouter;
+exports["default"] = readmePlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +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 {\n  errorHandler,\n  TokenManager,\n  UrlReader,\n} from '@backstage/backend-common';\nimport { Config } from '@backstage/config';\nimport { CacheManager } from '@backstage/backend-common';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { Logger } from 'winston';\nimport { ScmIntegrations } from '@backstage/integration';\nimport { getEntitySourceLocation } from '@backstage/catalog-model';\nimport { CatalogClient } from '@backstage/catalog-client';\nimport { DiscoveryApi } from '@backstage/plugin-permission-common';\nimport { isSymLink } from '../lib';\n\n/**\n * Constructs a readme router.\n * @public\n */\nexport interface RouterOptions {\n  /**\n   * Implementation of Winston logger\n   */\n  logger: Logger;\n\n  /**\n   * Backstage config object\n   */\n  config: Config;\n\n  /**\n   * Backstage url reader instance\n   */\n  reader: UrlReader;\n\n  /**\n   * Backstage discovery api instance\n   */\n  discovery: DiscoveryApi;\n\n  /**\n   * Backstage token manager instance\n   */\n  tokenManager: TokenManager;\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 * @public\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const { logger, config, reader, discovery, tokenManager } = 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('/:entityRef', async (request, response) => {\n    const { entityRef } = request.params;\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 tokenManager.getToken();\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      logger.info(`Not valid location for ${source.target}`);\n      response.status(404).json({\n        error: `Not valid location for ${source.target}`,\n      });\n      return;\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 (error instanceof Error && error.name === 'NotFoundError') {\n          // Try the next readme type\n          continue;\n        } else {\n          response.status(500).json({\n            error: `Readme failure: ${error}`,\n          });\n          break;\n        }\n      }\n    }\n    logger.info(`Readme not found for ${entityRef}`);\n    response.status(404).json({\n      error: 'Readme not found.',\n    });\n  });\n\n  router.use(errorHandler());\n  return router;\n}\n","import { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\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        tokenManager: coreServices.tokenManager,\n        httpRouter: coreServices.httpRouter,\n      },\n      async init({\n        logger,\n        config,\n        reader,\n        discovery,\n        tokenManager,\n        httpRouter,\n      }) {\n        httpRouter.use(\n          await createRouter({\n            logger: loggerToWinstonLogger(logger),\n            config,\n            reader,\n            discovery,\n            tokenManager,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["catalogClient","CatalogClient","CacheManager","ScmIntegrations","Router","express","getEntitySourceLocation","errorHandler","createBackendPlugin","coreServices","loggerToWinstonLogger"],"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,EAAA,IAAI,MAAM,MAAS,GAAA,CAAA;AAAG,IAAO,OAAA,KAAA,CAAA;AAC7B,EAAM,MAAA,IAAA,GAAO,MAAM,CAAC,CAAA,CAAA;AACpB,EAAI,IAAA,IAAA,CAAK,SAAS,GAAG,CAAA;AAAG,IAAO,OAAA,KAAA,CAAA;AAE/B,EAAM,MAAA,KAAA,GAAQ,OAAO,qBAAqB,CAAA,CAAA;AAC1C,EAAO,OAAA,KAAA,CAAM,KAAK,OAAO,CAAA,CAAA;AAC3B,CAAA;;ACqCA,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;AAOA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAQ,EAAA,MAAA,EAAQ,MAAQ,EAAA,SAAA,EAAW,cAAiB,GAAA,OAAA,CAAA;AAC5D,EAAA,MAAMA,kBAAgB,IAAIC,2BAAA,CAAc,EAAE,YAAA,EAAc,WAAW,CAAA,CAAA;AAEnE,EAAA,MAAM,cAAcC,0BAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,QAAQ,CAAA,CAAA;AACtE,EAAA,MAAM,QAAQ,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,0BAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,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,aAAA,EAAe,OAAO,OAAA,EAAS,QAAa,KAAA;AACrD,IAAM,MAAA,EAAE,SAAU,EAAA,GAAI,OAAQ,CAAA,MAAA,CAAA;AAC9B,IAAA,MAAM,QAAY,GAAA,MAAM,KAAM,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,aAAa,QAAS,EAAA,CAAA;AAC9C,IAAA,MAAM,SAAS,MAAML,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,GAASM,qCAAwB,MAAM,CAAA,CAAA;AAE7C,IAAA,IAAI,CAAC,MAAA,IAAU,MAAO,CAAA,IAAA,KAAS,KAAO,EAAA;AACpC,MAAA,MAAA,CAAO,IAAK,CAAA,CAAA,uBAAA,EAA0B,MAAO,CAAA,MAAM,CAAE,CAAA,CAAA,CAAA;AACrD,MAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,QACxB,KAAA,EAAO,CAA0B,uBAAA,EAAA,MAAA,CAAO,MAAM,CAAA,CAAA;AAAA,OAC/C,CAAA,CAAA;AACD,MAAA,OAAA;AAAA,KACF;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,QAAA,KAAA,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,IAAI,KAAiB,YAAA,KAAA,IAAS,KAAM,CAAA,IAAA,KAAS,eAAiB,EAAA;AAE5D,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,MAAA;AAAA,SACF;AAAA,OACF;AAAA,KACF;AACA,IAAO,MAAA,CAAA,IAAA,CAAK,CAAwB,qBAAA,EAAA,SAAS,CAAE,CAAA,CAAA,CAAA;AAC/C,IAAS,QAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,IAAK,CAAA;AAAA,MACxB,KAAO,EAAA,mBAAA;AAAA,KACR,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AACzB,EAAO,OAAA,MAAA,CAAA;AACT;;ACrKO,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,cAAcA,6BAAa,CAAA,YAAA;AAAA,QAC3B,YAAYA,6BAAa,CAAA,UAAA;AAAA,OAC3B;AAAA,MACA,MAAM,IAAK,CAAA;AAAA,QACT,MAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,QACA,SAAA;AAAA,QACA,YAAA;AAAA,QACA,UAAA;AAAA,OACC,EAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,YAAa,CAAA;AAAA,YACjB,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,YACpC,MAAA;AAAA,YACA,MAAA;AAAA,YACA,SAAA;AAAA,YACA,YAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { UrlReader, TokenManager } from '@backstage/backend-common';
+import { Config } from '@backstage/config';
+import express from 'express';
+import { Logger } from 'winston';
+import { DiscoveryApi } from '@backstage/plugin-permission-common';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * Constructs a readme router.
+ * @public
+ */
+interface RouterOptions {
+    /**
+     * Implementation of Winston logger
+     */
+    logger: Logger;
+    /**
+     * Backstage config object
+     */
+    config: Config;
+    /**
+     * Backstage url reader instance
+     */
+    reader: UrlReader;
+    /**
+     * Backstage discovery api instance
+     */
+    discovery: DiscoveryApi;
+    /**
+     * Backstage token manager instance
+     */
+    tokenManager: TokenManager;
+}
+/**
+ * Constructs a readme router.
+ *
+ * @public
+ */
+declare function createRouter(options: RouterOptions): Promise<express.Router>;
+
+/**
+ * The Readme backend plugin.
+ *
+ * @public
+ */
+declare const readmePlugin: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { RouterOptions, createRouter, readmePlugin as default };

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@axis-backstage/plugin-readme-backend",
+  "version": "0.1.0",
+  "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"
+  },
+  "backstage": {
+    "role": "backend-plugin"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.19.8",
+    "@backstage/backend-plugin-api": "^0.6.7",
+    "@backstage/catalog-client": "^1.4.6",
+    "@backstage/catalog-model": "^1.4.3",
+    "@backstage/config": "^1.1.1",
+    "@backstage/integration": "^1.7.2",
+    "@backstage/plugin-permission-common": "^0.7.10",
+    "@types/express": "*",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "node-fetch": "^2.6.7",
+    "winston": "^3.2.1",
+    "yn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.23.0",
+    "@types/supertest": "^2.0.12",
+    "msw": "^1.0.0",
+    "supertest": "^6.2.4"
+  },
+  "files": [
+    "dist"
+  ]
+}