@axis-backstage/plugin-readme 0.1.0

package/README.md

@@ -0,0 +1,72 @@
+# Readme plugin
+
+Welcome to the readme plugin!
+
+![home](media/readme-card.png)
+
+## Introduction
+
+The `README-plugin` enables easy access and viewing of the README.md file. By having information such as the project's purpose, usage instructions, or installation details as a central part of the EntityPage, we hope to improve the `onboarding and understanding of entities`.
+
+The README.md file is always retrieved from the same directory as the `catalog-info.yaml file`, also known as the `entity source location`. If you wish to view the path where the plugin looks for your README.md file, you can find it in the backstage.io/source-location annotation in the catalog-info.yaml file (see the example below). This annotation is automatically added to your entity, so there is no need to add it manually.
+
+```yaml
+annotations:
+  backstage.io/source-location: url:https://github.com/AxisCommunications/backstage-plugins/blob/main/
+```
+
+Currently, placing your README.md file elsewhere than in the same directory as the `catalog-info.yaml file` repository is not supported.
+
+The displays README files with one 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 in the README file.
+
+## Note
+
+You will **need** to also perform the installation instructions in [Readme Backend](https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/readme-backend) in order for this plugin to work.
+
+## Getting started
+
+1. First, install the plugin into your app:
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/app @axis-backstage/plugin-readme
+```
+
+2. Then, modify your entity page in `EntityPage.tsx` to include the `ReadmeCard` component that is exported from the plugin to `overviewContent``.
+
+```tsx
+// In packages/app/src/components/catalog/Entity.tsx
+import { ReadmeCard } from '@axis-backstage/plugin-readme';
+
+const overviewContent = (
+...
+  <Grid item md={6} sx={12}>
+      <ReadmeCard />
+</Grid>
+  ...
+)
+```
+
+## Layout
+
+The readme card is located in the overview page on the entity page. From the card header it is also possible to open a dialog displaying the full README.md.
+
+![home](media/readme-card.png)
+
+![home](media/readme-dialog.png)
+
+### Troubleshooting
+
+#### "No README.md file found at the source location..."
+
+This message indicates that the backend cannot find your README.md file. Ensure that the README.md file is indeed located in the same directory as the `catalog-info.yaml file`. If you are still unable to locate it, try scheduling an entity refresh by clicking the "Schedule Entity Refresh" button in the AboutCard of the entity.

package/dist/esm/index-0b47704b.esm.js

@@ -0,0 +1,75 @@
+import { createRouteRef, createApiRef, createPlugin, createApiFactory, discoveryApiRef, fetchApiRef, identityApiRef, createRoutableExtension } from '@backstage/core-plugin-api';
+
+const rootRouteRef = createRouteRef({
+  id: "readme"
+});
+
+const readmeApiRef = createApiRef({
+  id: "plugin.readme"
+});
+
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
+class ReadmeClient {
+  constructor(options) {
+    __publicField(this, "discoveryApi");
+    __publicField(this, "fetchApi");
+    __publicField(this, "identityApi");
+    this.discoveryApi = options.discoveryApi;
+    this.fetchApi = options.fetchApi;
+    this.identityApi = options.identityApi;
+  }
+  async getReadmeContent(entityRef) {
+    const { token } = await this.identityApi.getCredentials();
+    const baseUrl = await this.discoveryApi.getBaseUrl("readme");
+    const resp = await this.fetchApi.fetch(
+      `${baseUrl}/${encodeURIComponent(entityRef)}`,
+      {
+        method: "GET",
+        headers: { Authorization: `Bearer ${token}` }
+      }
+    );
+    if (resp.ok) {
+      return [
+        await resp.text(),
+        resp.headers.get("Content-Type") || "text/plain"
+      ];
+    }
+    if (resp.status === 404) {
+      throw new Error("404");
+    }
+    throw new Error(`${resp.status}: ${resp.statusText}`);
+  }
+}
+
+const readmePlugin = createPlugin({
+  id: "readme",
+  apis: [
+    createApiFactory({
+      api: readmeApiRef,
+      deps: {
+        discoveryApi: discoveryApiRef,
+        fetchApi: fetchApiRef,
+        identityApi: identityApiRef
+      },
+      factory: ({ discoveryApi, fetchApi, identityApi }) => new ReadmeClient({ discoveryApi, fetchApi, identityApi })
+    })
+  ],
+  routes: {
+    root: rootRouteRef
+  }
+});
+const ReadmeCard = readmePlugin.provide(
+  createRoutableExtension({
+    name: "ReadmeCard",
+    component: () => import('./index-4c75dc93.esm.js').then((m) => m.ReadmeCard),
+    mountPoint: rootRouteRef
+  })
+);
+
+export { ReadmeCard as R, readmePlugin as a, readmeApiRef as r };
+//# sourceMappingURL=index-0b47704b.esm.js.map

package/dist/esm/index-0b47704b.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-0b47704b.esm.js","sources":["../../src/routes.ts","../../src/api/ReadmeApi.tsx","../../src/api/ReadmeClient.tsx","../../src/plugin.ts"],"sourcesContent":["import { createRouteRef } from '@backstage/core-plugin-api';\n\nexport const rootRouteRef = createRouteRef({\n  id: 'readme',\n});\n","import { createApiRef } from '@backstage/core-plugin-api';\n\nexport const readmeApiRef = createApiRef<ReadmeApi>({\n  id: 'plugin.readme',\n});\n\nexport type ReadmeApi = {\n  getReadmeContent(entityRef: string): Promise<[string, string]>;\n};\n","import {\n  DiscoveryApi,\n  FetchApi,\n  IdentityApi,\n} from '@backstage/core-plugin-api';\nimport { ReadmeApi } from './ReadmeApi';\n\nexport class ReadmeClient implements ReadmeApi {\n  private readonly discoveryApi: DiscoveryApi;\n  private readonly fetchApi: FetchApi;\n  private readonly identityApi: IdentityApi;\n\n  constructor(options: {\n    discoveryApi: DiscoveryApi;\n    fetchApi: FetchApi;\n    identityApi: IdentityApi;\n  }) {\n    this.discoveryApi = options.discoveryApi;\n    this.fetchApi = options.fetchApi;\n    this.identityApi = options.identityApi;\n  }\n\n  async getReadmeContent(entityRef: string): Promise<[string, string]> {\n    const { token } = await this.identityApi.getCredentials();\n    const baseUrl = await this.discoveryApi.getBaseUrl('readme');\n\n    const resp = await this.fetchApi.fetch(\n      `${baseUrl}/${encodeURIComponent(entityRef)}`,\n      {\n        method: 'GET',\n        headers: { Authorization: `Bearer ${token}` },\n      },\n    );\n    if (resp.ok) {\n      return [\n        await resp.text(),\n        resp.headers.get('Content-Type') || 'text/plain',\n      ];\n    }\n    if (resp.status === 404) {\n      throw new Error('404');\n    }\n    throw new Error(`${resp.status}: ${resp.statusText}`);\n  }\n}\n","import {\n  createApiFactory,\n  createPlugin,\n  createRoutableExtension,\n  discoveryApiRef,\n  fetchApiRef,\n  identityApiRef,\n} from '@backstage/core-plugin-api';\n\nimport { rootRouteRef } from './routes';\nimport { readmeApiRef } from './api/ReadmeApi';\nimport { ReadmeClient } from './api/ReadmeClient';\n\n/**\n * Plugin that provides the Readme api\n * @public */\nexport const readmePlugin = createPlugin({\n  id: 'readme',\n  apis: [\n    createApiFactory({\n      api: readmeApiRef,\n      deps: {\n        discoveryApi: discoveryApiRef,\n        fetchApi: fetchApiRef,\n        identityApi: identityApiRef,\n      },\n      factory: ({ discoveryApi, fetchApi, identityApi }) =>\n        new ReadmeClient({ discoveryApi, fetchApi, identityApi }),\n    }),\n  ],\n  routes: {\n    root: rootRouteRef,\n  },\n});\n\n/**\n * Readme card exported from the Readme plugin\n * @public */\nexport const ReadmeCard = readmePlugin.provide(\n  createRoutableExtension({\n    name: 'ReadmeCard',\n    component: () => import('./components/ReadmeCard').then(m => m.ReadmeCard),\n    mountPoint: rootRouteRef,\n  }),\n);\n"],"names":[],"mappings":";;AAEO,MAAM,eAAe,cAAe,CAAA;AAAA,EACzC,EAAI,EAAA,QAAA;AACN,CAAC,CAAA;;ACFM,MAAM,eAAe,YAAwB,CAAA;AAAA,EAClD,EAAI,EAAA,eAAA;AACN,CAAC;;;;;;;;ACGM,MAAM,YAAkC,CAAA;AAAA,EAK7C,YAAY,OAIT,EAAA;AARH,IAAiB,aAAA,CAAA,IAAA,EAAA,cAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,UAAA,CAAA,CAAA;AACjB,IAAiB,aAAA,CAAA,IAAA,EAAA,aAAA,CAAA,CAAA;AAOf,IAAA,IAAA,CAAK,eAAe,OAAQ,CAAA,YAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,WAAW,OAAQ,CAAA,QAAA,CAAA;AACxB,IAAA,IAAA,CAAK,cAAc,OAAQ,CAAA,WAAA,CAAA;AAAA,GAC7B;AAAA,EAEA,MAAM,iBAAiB,SAA8C,EAAA;AACnE,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,YAAY,cAAe,EAAA,CAAA;AACxD,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,QAAQ,CAAA,CAAA;AAE3D,IAAM,MAAA,IAAA,GAAO,MAAM,IAAA,CAAK,QAAS,CAAA,KAAA;AAAA,MAC/B,CAAG,EAAA,OAAO,CAAI,CAAA,EAAA,kBAAA,CAAmB,SAAS,CAAC,CAAA,CAAA;AAAA,MAC3C;AAAA,QACE,MAAQ,EAAA,KAAA;AAAA,QACR,OAAS,EAAA,EAAE,aAAe,EAAA,CAAA,OAAA,EAAU,KAAK,CAAG,CAAA,EAAA;AAAA,OAC9C;AAAA,KACF,CAAA;AACA,IAAA,IAAI,KAAK,EAAI,EAAA;AACX,MAAO,OAAA;AAAA,QACL,MAAM,KAAK,IAAK,EAAA;AAAA,QAChB,IAAK,CAAA,OAAA,CAAQ,GAAI,CAAA,cAAc,CAAK,IAAA,YAAA;AAAA,OACtC,CAAA;AAAA,KACF;AACA,IAAI,IAAA,IAAA,CAAK,WAAW,GAAK,EAAA;AACvB,MAAM,MAAA,IAAI,MAAM,KAAK,CAAA,CAAA;AAAA,KACvB;AACA,IAAM,MAAA,IAAI,MAAM,CAAG,EAAA,IAAA,CAAK,MAAM,CAAK,EAAA,EAAA,IAAA,CAAK,UAAU,CAAE,CAAA,CAAA,CAAA;AAAA,GACtD;AACF;;AC5BO,MAAM,eAAe,YAAa,CAAA;AAAA,EACvC,EAAI,EAAA,QAAA;AAAA,EACJ,IAAM,EAAA;AAAA,IACJ,gBAAiB,CAAA;AAAA,MACf,GAAK,EAAA,YAAA;AAAA,MACL,IAAM,EAAA;AAAA,QACJ,YAAc,EAAA,eAAA;AAAA,QACd,QAAU,EAAA,WAAA;AAAA,QACV,WAAa,EAAA,cAAA;AAAA,OACf;AAAA,MACA,OAAS,EAAA,CAAC,EAAE,YAAA,EAAc,QAAU,EAAA,WAAA,EAClC,KAAA,IAAI,YAAa,CAAA,EAAE,YAAc,EAAA,QAAA,EAAU,aAAa,CAAA;AAAA,KAC3D,CAAA;AAAA,GACH;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,YAAA;AAAA,GACR;AACF,CAAC,EAAA;AAKM,MAAM,aAAa,YAAa,CAAA,OAAA;AAAA,EACrC,uBAAwB,CAAA;AAAA,IACtB,IAAM,EAAA,YAAA;AAAA,IACN,SAAA,EAAW,MAAM,OAAO,yBAAyB,EAAE,IAAK,CAAA,CAAA,CAAA,KAAK,EAAE,UAAU,CAAA;AAAA,IACzE,UAAY,EAAA,YAAA;AAAA,GACb,CAAA;AACH;;;;"}

package/dist/esm/index-4c75dc93.esm.js

@@ -0,0 +1,103 @@
+import React, { useState } from 'react';
+import { Box, Typography, Dialog, DialogTitle, DialogContent, DialogActions, Button, IconButton } from '@material-ui/core';
+import { Progress, Link, ErrorPanel, MarkdownContent, CodeSnippet, InfoCard } from '@backstage/core-components';
+import { useEntity } from '@backstage/plugin-catalog-react';
+import { useApi } from '@backstage/core-plugin-api';
+import useAsync from 'react-use/lib/useAsync';
+import { r as readmeApiRef } from './index-0b47704b.esm.js';
+import { getEntitySourceLocation, stringifyEntityRef } from '@backstage/catalog-model';
+import OpenInNewIcon from '@material-ui/icons/OpenInNew';
+
+const FetchComponent = () => {
+  var _a;
+  const { entity } = useEntity();
+  const readmeApi = useApi(readmeApiRef);
+  let location;
+  try {
+    const { target } = getEntitySourceLocation(entity);
+    location = target != null ? target : target;
+  } catch (err) {
+    location = ": Unknown";
+  }
+  const {
+    value: content,
+    loading,
+    error
+  } = useAsync(
+    async () => await readmeApi.getReadmeContent(stringifyEntityRef(entity)),
+    [entity]
+  );
+  if (loading) {
+    return /* @__PURE__ */ React.createElement(Progress, null);
+  }
+  if ((error == null ? void 0 : error.message) === "404") {
+    return /* @__PURE__ */ React.createElement(Box, null, /* @__PURE__ */ React.createElement(Typography, { variant: "body2", style: { paddingBottom: 15 } }, "No README.md file found at source location:", " ", location && /* @__PURE__ */ React.createElement("strong", null, location)), /* @__PURE__ */ React.createElement(Typography, { variant: "body2" }, "Need help? Go to our", " ", /* @__PURE__ */ React.createElement(Link, { to: "https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/readme/README.md" }, "documentation")));
+  }
+  if (error) {
+    return /* @__PURE__ */ React.createElement(ErrorPanel, { error });
+  }
+  if (!content) {
+    return /* @__PURE__ */ React.createElement(ErrorPanel, { error: Error("Unknown error") });
+  }
+  if (!content[1] || content[1] === "error") {
+    return /* @__PURE__ */ React.createElement(ErrorPanel, { error: Error((_a = content[1]) != null ? _a : "Unknown error") });
+  } else if (content[1].startsWith("text/markdown")) {
+    return /* @__PURE__ */ React.createElement(MarkdownContent, { content: content[0] });
+  }
+  return /* @__PURE__ */ React.createElement("div", { "data-testid": "readme-content" }, /* @__PURE__ */ React.createElement(CodeSnippet, { text: content[0], language: "plaintext" }));
+};
+
+const ReadmeDialog = ({ open, onClose }) => {
+  return /* @__PURE__ */ React.createElement(
+    Dialog,
+    {
+      maxWidth: "md",
+      open,
+      onClose,
+      "data-testid": "content-dialog"
+    },
+    /* @__PURE__ */ React.createElement(DialogTitle, null, "README"),
+    /* @__PURE__ */ React.createElement(DialogContent, { dividers: true }, /* @__PURE__ */ React.createElement(FetchComponent, null)),
+    /* @__PURE__ */ React.createElement(DialogActions, null, /* @__PURE__ */ React.createElement(
+      Button,
+      {
+        variant: "contained",
+        color: "primary",
+        "aria-label": "close",
+        onClick: onClose
+      },
+      "Close"
+    ))
+  );
+};
+
+const ReadmeCard = () => {
+  const [displayDialog, setDisplayDialog] = useState(false);
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(
+    InfoCard,
+    {
+      title: "README",
+      variant: "flex",
+      action: /* @__PURE__ */ React.createElement(
+        IconButton,
+        {
+          onClick: () => setDisplayDialog(true),
+          "aria-label": "open dialog",
+          role: "button",
+          title: "Open in dialog"
+        },
+        /* @__PURE__ */ React.createElement(OpenInNewIcon, null)
+      )
+    },
+    /* @__PURE__ */ React.createElement("div", { style: { overflow: "auto" } }, /* @__PURE__ */ React.createElement(Box, { sx: { maxHeight: 235 } }, /* @__PURE__ */ React.createElement(FetchComponent, null)))
+  ), /* @__PURE__ */ React.createElement(
+    ReadmeDialog,
+    {
+      open: displayDialog,
+      onClose: () => setDisplayDialog(false)
+    }
+  ));
+};
+
+export { ReadmeCard };
+//# sourceMappingURL=index-4c75dc93.esm.js.map

package/dist/esm/index-4c75dc93.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-4c75dc93.esm.js","sources":["../../src/components/FetchComponent/FetchComponent.tsx","../../src/components/ReadmeDialog/ReadmeDialog.tsx","../../src/components/ReadmeCard/ReadmeCard.tsx"],"sourcesContent":["import React from 'react';\nimport { useEntity } from '@backstage/plugin-catalog-react';\nimport { useApi } from '@backstage/core-plugin-api';\nimport {\n  CodeSnippet,\n  ErrorPanel,\n  Link,\n  MarkdownContent,\n  Progress,\n} from '@backstage/core-components';\nimport useAsync from 'react-use/lib/useAsync';\nimport { readmeApiRef } from '../../api/ReadmeApi';\nimport { stringifyEntityRef } from '@backstage/catalog-model';\nimport { getEntitySourceLocation } from '@backstage/catalog-model';\nimport { Box, Typography } from '@material-ui/core';\n\nexport const FetchComponent = () => {\n  const { entity } = useEntity();\n  const readmeApi = useApi(readmeApiRef);\n  let location;\n\n  try {\n    const { target } = getEntitySourceLocation(entity);\n    location = target ?? target;\n  } catch (err) {\n    location = ': Unknown';\n  }\n\n  const {\n    value: content,\n    loading,\n    error,\n  } = useAsync(\n    async (): Promise<string[]> =>\n      await readmeApi.getReadmeContent(stringifyEntityRef(entity)),\n    [entity],\n  );\n\n  if (loading) {\n    return <Progress />;\n  }\n  if (error?.message === '404') {\n    return (\n      <Box>\n        <Typography variant=\"body2\" style={{ paddingBottom: 15 }}>\n          No README.md file found at source location:{' '}\n          {location && <strong>{location}</strong>}\n        </Typography>\n        <Typography variant=\"body2\">\n          Need help? Go to our{' '}\n          <Link to=\"https://github.com/AxisCommunications/backstage-plugins/blob/main/plugins/readme/README.md\">\n            documentation\n          </Link>\n        </Typography>\n      </Box>\n    );\n  }\n\n  if (error) {\n    return <ErrorPanel error={error} />;\n  }\n  if (!content) {\n    return <ErrorPanel error={Error('Unknown error')} />;\n  }\n  if (!content[1] || content[1] === 'error') {\n    return <ErrorPanel error={Error(content[1] ?? 'Unknown error')} />;\n  } else if (content[1].startsWith('text/markdown')) {\n    return <MarkdownContent content={content[0]} />;\n  }\n  // probably text/plain\n  return (\n    <div data-testid=\"readme-content\">\n      <CodeSnippet text={content[0]} language=\"plaintext\" />\n    </div>\n  );\n};\n","import React from 'react';\nimport {\n  Button,\n  Dialog,\n  DialogActions,\n  DialogContent,\n  DialogTitle,\n} from '@material-ui/core';\nimport { FetchComponent } from '../FetchComponent';\n\ntype Props = {\n  open: boolean;\n  onClose: () => void;\n};\n\nexport const ReadmeDialog = ({ open, onClose }: Props) => {\n  return (\n    <Dialog\n      maxWidth=\"md\"\n      open={open}\n      onClose={onClose}\n      data-testid=\"content-dialog\"\n    >\n      <DialogTitle>README</DialogTitle>\n      <DialogContent dividers>\n        <FetchComponent />\n      </DialogContent>\n      <DialogActions>\n        <Button\n          variant=\"contained\"\n          color=\"primary\"\n          aria-label=\"close\"\n          onClick={onClose}\n        >\n          Close\n        </Button>\n      </DialogActions>\n    </Dialog>\n  );\n};\n","import React, { useState } from 'react';\nimport { Box, IconButton } from '@material-ui/core';\nimport { InfoCard } from '@backstage/core-components';\nimport { FetchComponent } from '../FetchComponent';\nimport OpenInNewIcon from '@material-ui/icons/OpenInNew';\nimport { ReadmeDialog } from '../ReadmeDialog/ReadmeDialog';\n\nexport const ReadmeCard = () => {\n  const [displayDialog, setDisplayDialog] = useState(false);\n\n  return (\n    <>\n      <InfoCard\n        title=\"README\"\n        variant=\"flex\"\n        action={\n          <IconButton\n            onClick={() => setDisplayDialog(true)}\n            aria-label=\"open dialog\"\n            role=\"button\"\n            title=\"Open in dialog\"\n          >\n            <OpenInNewIcon />\n          </IconButton>\n        }\n      >\n        <div style={{ overflow: 'auto' }}>\n          <Box sx={{ maxHeight: 235 }}>\n            <FetchComponent />\n          </Box>\n        </div>\n      </InfoCard>\n\n      <ReadmeDialog\n        open={displayDialog}\n        onClose={() => setDisplayDialog(false)}\n      />\n    </>\n  );\n};\n"],"names":[],"mappings":";;;;;;;;;;AAgBO,MAAM,iBAAiB,MAAM;AAhBpC,EAAA,IAAA,EAAA,CAAA;AAiBE,EAAM,MAAA,EAAE,MAAO,EAAA,GAAI,SAAU,EAAA,CAAA;AAC7B,EAAM,MAAA,SAAA,GAAY,OAAO,YAAY,CAAA,CAAA;AACrC,EAAI,IAAA,QAAA,CAAA;AAEJ,EAAI,IAAA;AACF,IAAA,MAAM,EAAE,MAAA,EAAW,GAAA,uBAAA,CAAwB,MAAM,CAAA,CAAA;AACjD,IAAA,QAAA,GAAW,MAAU,IAAA,IAAA,GAAA,MAAA,GAAA,MAAA,CAAA;AAAA,WACd,GAAK,EAAA;AACZ,IAAW,QAAA,GAAA,WAAA,CAAA;AAAA,GACb;AAEA,EAAM,MAAA;AAAA,IACJ,KAAO,EAAA,OAAA;AAAA,IACP,OAAA;AAAA,IACA,KAAA;AAAA,GACE,GAAA,QAAA;AAAA,IACF,YACE,MAAM,SAAA,CAAU,gBAAiB,CAAA,kBAAA,CAAmB,MAAM,CAAC,CAAA;AAAA,IAC7D,CAAC,MAAM,CAAA;AAAA,GACT,CAAA;AAEA,EAAA,IAAI,OAAS,EAAA;AACX,IAAA,2CAAQ,QAAS,EAAA,IAAA,CAAA,CAAA;AAAA,GACnB;AACA,EAAI,IAAA,CAAA,KAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAO,aAAY,KAAO,EAAA;AAC5B,IAAA,uBACG,KAAA,CAAA,aAAA,CAAA,GAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,UAAA,EAAA,EAAW,OAAQ,EAAA,OAAA,EAAQ,KAAO,EAAA,EAAE,aAAe,EAAA,EAAA,EAAM,EAAA,EAAA,6CAAA,EACZ,KAC3C,QAAY,oBAAA,KAAA,CAAA,aAAA,CAAC,QAAQ,EAAA,IAAA,EAAA,QAAS,CACjC,CAAA,kBACC,KAAA,CAAA,aAAA,CAAA,UAAA,EAAA,EAAW,SAAQ,OAAQ,EAAA,EAAA,sBAAA,EACL,GACrB,kBAAA,KAAA,CAAA,aAAA,CAAC,IAAK,EAAA,EAAA,EAAA,EAAG,4FAA6F,EAAA,EAAA,eAEtG,CACF,CACF,CAAA,CAAA;AAAA,GAEJ;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IAAO,uBAAA,KAAA,CAAA,aAAA,CAAC,cAAW,KAAc,EAAA,CAAA,CAAA;AAAA,GACnC;AACA,EAAA,IAAI,CAAC,OAAS,EAAA;AACZ,IAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,UAAA,EAAA,EAAW,KAAO,EAAA,KAAA,CAAM,eAAe,CAAG,EAAA,CAAA,CAAA;AAAA,GACpD;AACA,EAAA,IAAI,CAAC,OAAQ,CAAA,CAAC,KAAK,OAAQ,CAAA,CAAC,MAAM,OAAS,EAAA;AACzC,IAAO,uBAAA,KAAA,CAAA,aAAA,CAAC,cAAW,KAAO,EAAA,KAAA,CAAA,CAAM,aAAQ,CAAC,CAAA,KAAT,IAAc,GAAA,EAAA,GAAA,eAAe,CAAG,EAAA,CAAA,CAAA;AAAA,aACvD,OAAQ,CAAA,CAAC,CAAE,CAAA,UAAA,CAAW,eAAe,CAAG,EAAA;AACjD,IAAA,uBAAQ,KAAA,CAAA,aAAA,CAAA,eAAA,EAAA,EAAgB,OAAS,EAAA,OAAA,CAAQ,CAAC,CAAG,EAAA,CAAA,CAAA;AAAA,GAC/C;AAEA,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA,EAAI,aAAY,EAAA,gBAAA,EAAA,kBACd,KAAA,CAAA,aAAA,CAAA,WAAA,EAAA,EAAY,IAAM,EAAA,OAAA,CAAQ,CAAC,CAAA,EAAG,QAAS,EAAA,WAAA,EAAY,CACtD,CAAA,CAAA;AAEJ,CAAA;;AC5DO,MAAM,YAAe,GAAA,CAAC,EAAE,IAAA,EAAM,SAAqB,KAAA;AACxD,EACE,uBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,MAAA;AAAA,IAAA;AAAA,MACC,QAAS,EAAA,IAAA;AAAA,MACT,IAAA;AAAA,MACA,OAAA;AAAA,MACA,aAAY,EAAA,gBAAA;AAAA,KAAA;AAAA,oBAEZ,KAAA,CAAA,aAAA,CAAC,mBAAY,QAAM,CAAA;AAAA,wCAClB,aAAc,EAAA,EAAA,QAAA,EAAQ,IACrB,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,oBAAe,CAClB,CAAA;AAAA,wCACC,aACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,MAAC,MAAA;AAAA,MAAA;AAAA,QACC,OAAQ,EAAA,WAAA;AAAA,QACR,KAAM,EAAA,SAAA;AAAA,QACN,YAAW,EAAA,OAAA;AAAA,QACX,OAAS,EAAA,OAAA;AAAA,OAAA;AAAA,MACV,OAAA;AAAA,KAGH,CAAA;AAAA,GACF,CAAA;AAEJ,CAAA;;AChCO,MAAM,aAAa,MAAM;AAC9B,EAAA,MAAM,CAAC,aAAA,EAAe,gBAAgB,CAAA,GAAI,SAAS,KAAK,CAAA,CAAA;AAExD,EAAA,uBAEI,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,QAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,QAAA;AAAA,MACN,OAAQ,EAAA,MAAA;AAAA,MACR,MACE,kBAAA,KAAA,CAAA,aAAA;AAAA,QAAC,UAAA;AAAA,QAAA;AAAA,UACC,OAAA,EAAS,MAAM,gBAAA,CAAiB,IAAI,CAAA;AAAA,UACpC,YAAW,EAAA,aAAA;AAAA,UACX,IAAK,EAAA,QAAA;AAAA,UACL,KAAM,EAAA,gBAAA;AAAA,SAAA;AAAA,4CAEL,aAAc,EAAA,IAAA,CAAA;AAAA,OACjB;AAAA,KAAA;AAAA,wCAGD,KAAI,EAAA,EAAA,KAAA,EAAO,EAAE,QAAA,EAAU,QACtB,EAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,GAAI,EAAA,EAAA,EAAA,EAAI,EAAE,SAAW,EAAA,GAAA,sBACnB,KAAA,CAAA,aAAA,CAAA,cAAA,EAAA,IAAe,CAClB,CACF,CAAA;AAAA,GAGF,kBAAA,KAAA,CAAA,aAAA;AAAA,IAAC,YAAA;AAAA,IAAA;AAAA,MACC,IAAM,EAAA,aAAA;AAAA,MACN,OAAA,EAAS,MAAM,gBAAA,CAAiB,KAAK,CAAA;AAAA,KAAA;AAAA,GAEzC,CAAA,CAAA;AAEJ;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="react" />
+import * as react from 'react';
+import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
+
+/**
+ * Plugin that provides the Readme api
+ * @public */
+declare const readmePlugin: _backstage_core_plugin_api.BackstagePlugin<{
+    root: _backstage_core_plugin_api.RouteRef<undefined>;
+}, {}, {}>;
+/**
+ * Readme card exported from the Readme plugin
+ * @public */
+declare const ReadmeCard: () => react.JSX.Element;
+
+export { ReadmeCard, readmePlugin };

package/dist/index.esm.js

@@ -0,0 +1,3 @@
+export { R as ReadmeCard, a as readmePlugin } from './esm/index-0b47704b.esm.js';
+import '@backstage/core-plugin-api';
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@axis-backstage/plugin-readme",
+  "version": "0.1.0",
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "frontend-plugin"
+  },
+  "sideEffects": false,
+  "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/catalog-model": "^1.4.3",
+    "@backstage/core-components": "^0.13.6",
+    "@backstage/core-plugin-api": "^1.7.0",
+    "@backstage/plugin-catalog-react": "^1.9.0",
+    "@backstage/theme": "^0.4.3",
+    "@material-ui/core": "^4.12.2",
+    "@material-ui/icons": "^4.9.1",
+    "@material-ui/lab": "4.0.0-alpha.61",
+    "react-use": "^17.2.4"
+  },
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.23.0",
+    "@backstage/core-app-api": "^1.11.0",
+    "@backstage/dev-utils": "^1.0.22",
+    "@backstage/test-utils": "^1.4.4",
+    "@testing-library/jest-dom": "^5.10.1",
+    "@testing-library/react": "^12.1.3",
+    "@testing-library/user-event": "^14.0.0",
+    "msw": "^1.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/index.esm.js"
+}