@backstage-community/plugin-npm-backend 1.1.0

package/README.md

@@ -0,0 +1,324 @@
+# npm plugin for Backstage
+
+A Backstage plugin that shows information and latest releases/versions
+from a npm registry for catalog entities.
+
+The current version can show two cards and one additional tab for an catalog entity.
+
+1. The "Npm info card" shows general information like the latest version, description, etc.
+2. The "Npm release overview card" shows the latest tags of an npm package.
+3. The "Npm release tab" shows the version hisory in detail.
+
+## Screenshots
+
+### Npm info card
+
+![Screenshot](https://raw.githubusercontent.com/backstage/community-plugins/main/workspaces/npm/docs/npm-info-card.png)
+
+### Npm release overview card
+
+![Screenshot](https://raw.githubusercontent.com/backstage/community-plugins/main/workspaces/npm/docs/npm-release-overview-card.png)
+
+### Extended catalog entity overview tab (example)
+
+![Screenshot](https://raw.githubusercontent.com/backstage/community-plugins/main/workspaces/npm/docs/catalog-entity-overview-tab.png)
+
+### New catalog entity npm release tab
+
+![Screenshot](https://raw.githubusercontent.com/backstage/community-plugins/main/workspaces/npm/docs/catalog-entity-npm-release-tab.png)
+
+## Usage
+
+### Enable npm cards for a catalog entity
+
+To enable the different npm cards you must add the `npm/package` annotation
+with the name of the npm package:
+
+```yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: react
+  annotations:
+    npm/package: react
+```
+
+### Use other npm tag then `latest`
+
+The "npm info" card shows the information of the latest 'stable' npm release
+and use the common `latest` tag by default. This could be changed with `npm/stable-tag`:
+
+```yaml
+# catalog-info.yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: react
+  annotations:
+    npm/package: react
+    npm/stable-tag: latest, stable, next, etc.
+```
+
+### Use a custom registry
+
+To use another npm registry you need to specific a registry name in your
+catalog entity that exists in your `app-config.yaml`.
+
+```yaml
+# catalog-info.yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: react
+  annotations:
+    npm/package: another-package
+    npm/registry: github
+```
+
+```yaml
+# app-config.yaml
+npm:
+  registries:
+    - name: github
+      url: https://npm.pkg.github.com
+      token: ghp_...
+```
+
+## Installation
+
+To show information from a private package or an alternative npm registry
+you must install also the backend plugin and [configure it](./registries.md).
+
+### Frontend plugin
+
+1. Install the frontend dependency:
+
+   ```sh
+   yarn workspace app add @backstage-community/plugin-npm
+   ```
+
+2. Add cards based on your needs to `packages/app/src/components/catalog/EntityPage.tsx`:
+
+   After all other imports:
+
+   ```tsx
+   import {
+     isNpmAvailable,
+     EntityNpmInfoCard,
+     EntityNpmReleaseOverviewCard,
+     EntityNpmReleaseTableCard,
+   } from '@backstage-community/plugin-npm';
+   ```
+
+3. Add to `const overviewContent` after `EntityAboutCard`:
+
+   ```tsx
+   <EntitySwitch>
+     <EntitySwitch.Case if={isNpmAvailable}>
+       <Grid container item md={6} xs={12}>
+         <Grid item md={12}>
+           <EntityNpmInfoCard />
+         </Grid>
+         <Grid item md={12}>
+           <EntityNpmReleaseOverviewCard />
+         </Grid>
+       </Grid>
+     </EntitySwitch.Case>
+   </EntitySwitch>
+   ```
+
+4. Add to `const serviceEntityPage` and `const websiteEntityPage` after the `/ci-cd` case
+   and to `const defaultEntityPage` between the `/` and `/docs` routecase.
+
+   ```tsx
+   <EntityLayout.Route
+     if={isNpmAvailable}
+     path="/npm-releases"
+     title="NPM Releases"
+   >
+     <EntityNpmReleaseTableCard />
+   </EntityLayout.Route>
+   ```
+
+### Alternative: Use the new frontend system (alpha)
+
+For early adaopters of the new frontend system.
+
+Your Backstage frontend app must use that new frontend system which isn't the default at the moment.
+
+1. Install the frontend dependency:
+
+   ```sh
+   yarn workspace app-next add @backstage-community/plugin-npm
+   ```
+
+2. Add the package to your `packages/app[-next]/src/App.tsx`.
+
+   ```tsx
+   import npmPlugin from '@backstage-community/plugin-npm/alpha';
+   ```
+
+   And extend your createApp:
+
+   ```tsx
+   export const app = createApp({
+     features: [
+       catalogPlugin,
+       catalogImportPlugin,
+       userSettingsPlugin,
+       npmPlugin,
+       // ...
+     ],
+   });
+   ```
+
+### Optional: Backend plugin (req. for private packages or alternative registries)
+
+1. Install the backend plugin:
+
+   ```sh
+   yarn workspace backend add @backstage-community/plugin-npm
+   ```
+
+2. Add it to `packages/backend/src/index.ts`:
+
+   ```tsx
+   backend.add(import('@backstage-community/plugin-npm-backend'));
+   ```
+
+3. The backend is only used for catalog entities with a registry by default.
+
+   If no `npm/registry` annotation is defined, the npm plugin loads the
+   information directly from the frontend.
+   (The browser of the user will connect to https://registry.npmjs.com.)
+
+   You can enforce using the backend by defining a default registry:
+
+   ```yaml
+   # app-config.yaml
+   # optional to enforce the frontend to use the backend
+   npm:
+     defaultRegistry: npmjs
+   ```
+
+For more information, please checkout the [Registries](./registries.md) documentation.
+
+### Optional: Test with plugin-example catalog entities
+
+For testing purpose you can import this catalog entities:
+
+```yaml
+# catalog-info.yaml
+catalog:
+  locations:
+    - type: url
+      target: https://github.com/backstage/community-plugins/blob/main/workspaces/npm/examples/entities.yaml
+      rules:
+        - allow: [System, Component]
+```
+
+## Registries
+
+The npm plugin supports custom and private registries starting with v1.2.
+
+### Default Configuration
+
+The plugin loads information by default from https://registry.npmjs.com
+
+This works without any additional configuration in your `app-config.yaml`
+but only for public npm packages.
+
+```yaml
+npm:
+  registries:
+    - name: npmjs
+      url: https://registry.npmjs.com
+```
+
+### Use an auth token for npmjs
+
+To load information from another registry or to load information
+from a private package, you must [install the backend](./install.md).
+
+The catalog entity `npm/registry` annotation must be defined and match
+one of the registries in the `app-config.yaml`:
+
+Example:
+
+```yaml
+# catalog-info.yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: a-component
+  annotations:
+    npm/package: private-package
+    npm/registry: npmjs
+```
+
+```yaml
+# app-config.yaml
+npm:
+  registries:
+    - name: npmjs
+      url: https://registry.npmjs.com
+      token: ...
+```
+
+The `npm/registry: npmjs` annotation is required to use the npm backend.
+
+Alternativly you can setup a default registry (also for npmjs):
+
+```yaml
+# app-config.yaml
+npm:
+  defaultRegistry: npmjs
+```
+
+### Use an alternative registry
+
+Entity example:
+
+```yaml
+# catalog-info.yaml
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: a-component
+  annotations:
+    npm/package: private-package
+    npm/registry: private-registry
+```
+
+```yaml
+# app-config.yaml
+npm:
+  registries:
+    - name: private-registry
+      url: https://...
+      token: ...
+```
+
+### Use GitHub npm registry
+
+The GitHub npm registry reqires also a GitHub token for public entries.
+
+You need to create a token at https://github.com/settings/tokens
+
+```yaml
+# app-config.yaml
+npm:
+  registries:
+    - name: github
+      url: https://npm.pkg.github.com
+      token: ghp_...
+```
+
+### Other npm registries
+
+Other npm registries should work the same way.
+
+Please let us know if we should mention here another registry or
+if you find any issue.
+
+You can create a new [Issues on GitHub](https://github.com/backstage/community-plugins/issues/new?assignees=&labels=bug&projects=&template=1-bug.yaml&title=🐛+Npm%3A+<Title>)

package/config.d.ts

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2024 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export interface Config {
+  npm?: {
+    /**
+     * Use another default registry. This automatically enforce usage of the backend.
+     *
+     * @visibility frontend
+     */
+    defaultRegistry?: string;
+    /**
+     * List of registries that can be used to fetch packages from
+     */
+    registries?: {
+      /**
+       * Registry name
+       */
+      name?: string;
+      /**
+       * Registry base url
+       */
+      url?: string;
+      /**
+       * Registry auth token
+       * @visibility secret
+       */
+      token?: string;
+    }[];
+  };
+}

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var plugin = require('./plugin.cjs.js');
+
+
+
+exports.default = plugin.npmPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

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

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * npmPlugin backend plugin
+ *
+ * @public
+ */
+declare const npmPlugin: _backstage_backend_plugin_api.BackendFeature;
+
+export { npmPlugin as default };

package/dist/plugin.cjs.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+var router = require('./router.cjs.js');
+var NpmRegistryServiceImpl = require('./services/NpmRegistryServiceImpl.cjs.js');
+
+const npmPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "npm",
+  register(env) {
+    env.registerInit({
+      deps: {
+        logger: backendPluginApi.coreServices.logger,
+        auth: backendPluginApi.coreServices.auth,
+        config: backendPluginApi.coreServices.rootConfig,
+        httpAuth: backendPluginApi.coreServices.httpAuth,
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        catalog: alpha.catalogServiceRef
+      },
+      async init({ logger, auth, config, httpAuth, httpRouter, catalog }) {
+        const npmRegistryService = new NpmRegistryServiceImpl.NpmRegistryServiceImpl({
+          logger,
+          auth,
+          config,
+          catalog
+        });
+        httpRouter.use(
+          await router.createRouter({
+            httpAuth,
+            npmRegistryService
+          })
+        );
+      }
+    });
+  }
+});
+
+exports.npmPlugin = npmPlugin;
+//# 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":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\n\nimport { createRouter } from './router';\nimport { NpmRegistryServiceImpl } from './services/NpmRegistryServiceImpl';\n\n/**\n * npmPlugin backend plugin\n *\n * @public\n */\nexport const npmPlugin = createBackendPlugin({\n  pluginId: 'npm',\n  register(env) {\n    env.registerInit({\n      deps: {\n        logger: coreServices.logger,\n        auth: coreServices.auth,\n        config: coreServices.rootConfig,\n        httpAuth: coreServices.httpAuth,\n        httpRouter: coreServices.httpRouter,\n        catalog: catalogServiceRef,\n      },\n      async init({ logger, auth, config, httpAuth, httpRouter, catalog }) {\n        const npmRegistryService = new NpmRegistryServiceImpl({\n          logger,\n          auth,\n          config,\n          catalog,\n        });\n\n        httpRouter.use(\n          await createRouter({\n            httpAuth,\n            npmRegistryService,\n          }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","catalogServiceRef","NpmRegistryServiceImpl","createRouter"],"mappings":";;;;;;;AA6BO,MAAM,YAAYA,oCAAoB,CAAA;AAAA,EAC3C,QAAU,EAAA,KAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAMA,6BAAa,CAAA,IAAA;AAAA,QACnB,QAAQA,6BAAa,CAAA,UAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,OAAS,EAAAC;AAAA,OACX;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,MAAM,MAAQ,EAAA,QAAA,EAAU,UAAY,EAAA,OAAA,EAAW,EAAA;AAClE,QAAM,MAAA,kBAAA,GAAqB,IAAIC,6CAAuB,CAAA;AAAA,UACpD,MAAA;AAAA,UACA,IAAA;AAAA,UACA,MAAA;AAAA,UACA;AAAA,SACD,CAAA;AAED,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,QAAA;AAAA,YACA;AAAA,WACD;AAAA,SACH;AAAA;AACF,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/dist/router.cjs.js

@@ -0,0 +1,38 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var express = require('express');
+var Router = require('express-promise-router');
+
+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({
+  httpAuth,
+  npmRegistryService
+}) {
+  const router = Router__default.default();
+  router.use(express__default.default.json());
+  router.get("/:entityRef/package-info", async (req, res) => {
+    const entityRef = req.params.entityRef;
+    const credentials = await httpAuth.credentials(req, { allow: ["user"] });
+    try {
+      const packageInfo = await npmRegistryService.getPackageInfo(entityRef, {
+        credentials
+      });
+      res.json(packageInfo);
+    } catch (error) {
+      if (error instanceof errors.ResponseError) {
+        res.status(error.statusCode).json(error.response);
+      } else {
+        throw error;
+      }
+    }
+  });
+  return router;
+}
+
+exports.createRouter = createRouter;
+//# sourceMappingURL=router.cjs.js.map

package/dist/router.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.cjs.js","sources":["../src/router.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { HttpAuthService } from '@backstage/backend-plugin-api';\nimport { ResponseError } from '@backstage/errors';\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { NpmRegistryService } from './services';\n\nexport async function createRouter({\n  httpAuth,\n  npmRegistryService,\n}: {\n  httpAuth: HttpAuthService;\n  npmRegistryService: NpmRegistryService;\n}): Promise<express.Router> {\n  const router = Router();\n  router.use(express.json());\n\n  router.get('/:entityRef/package-info', async (req, res) => {\n    const entityRef = req.params.entityRef;\n    const credentials = await httpAuth.credentials(req, { allow: ['user'] });\n    try {\n      const packageInfo = await npmRegistryService.getPackageInfo(entityRef, {\n        credentials,\n      });\n      res.json(packageInfo);\n    } catch (error) {\n      if (error instanceof ResponseError) {\n        res.status(error.statusCode).json(error.response);\n      } else {\n        throw error;\n      }\n    }\n  });\n\n  return router;\n}\n"],"names":["Router","express","ResponseError"],"mappings":";;;;;;;;;;;AAqBA,eAAsB,YAAa,CAAA;AAAA,EACjC,QAAA;AAAA,EACA;AACF,CAG4B,EAAA;AAC1B,EAAA,MAAM,SAASA,uBAAO,EAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA;AAEzB,EAAA,MAAA,CAAO,GAAI,CAAA,0BAAA,EAA4B,OAAO,GAAA,EAAK,GAAQ,KAAA;AACzD,IAAM,MAAA,SAAA,GAAY,IAAI,MAAO,CAAA,SAAA;AAC7B,IAAM,MAAA,WAAA,GAAc,MAAM,QAAA,CAAS,WAAY,CAAA,GAAA,EAAK,EAAE,KAAO,EAAA,CAAC,MAAM,CAAA,EAAG,CAAA;AACvE,IAAI,IAAA;AACF,MAAA,MAAM,WAAc,GAAA,MAAM,kBAAmB,CAAA,cAAA,CAAe,SAAW,EAAA;AAAA,QACrE;AAAA,OACD,CAAA;AACD,MAAA,GAAA,CAAI,KAAK,WAAW,CAAA;AAAA,aACb,KAAO,EAAA;AACd,MAAA,IAAI,iBAAiBC,oBAAe,EAAA;AAClC,QAAA,GAAA,CAAI,OAAO,KAAM,CAAA,UAAU,CAAE,CAAA,IAAA,CAAK,MAAM,QAAQ,CAAA;AAAA,OAC3C,MAAA;AACL,QAAM,MAAA,KAAA;AAAA;AACR;AACF,GACD,CAAA;AAED,EAAO,OAAA,MAAA;AACT;;;;"}

package/dist/services/NpmRegistryServiceImpl.cjs.js

@@ -0,0 +1,60 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var pluginNpmCommon = require('@backstage-community/plugin-npm-common');
+
+class NpmRegistryServiceImpl {
+  logger;
+  auth;
+  config;
+  catalog;
+  constructor(options) {
+    this.logger = options.logger;
+    this.auth = options.auth;
+    this.config = options.config;
+    this.catalog = options.catalog;
+  }
+  async getPackageInfo(entityRef, options) {
+    const { token } = await this.auth.getPluginRequestToken({
+      onBehalfOf: options.credentials,
+      targetPluginId: "catalog"
+    });
+    const entity = await this.catalog.getEntityByRef(entityRef, {
+      token
+    });
+    if (!entity) {
+      throw new errors.NotFoundError(`No entity found for ref '${entityRef}'`);
+    }
+    const config = this.config.getOptional("npm");
+    const defaultRegistry = config?.defaultRegistry;
+    const packageName = entity.metadata.annotations?.[pluginNpmCommon.NpmAnnotation.PACKAGE_NAME];
+    const registryName = entity.metadata.annotations?.[pluginNpmCommon.NpmAnnotation.REGISTRY_NAME] || defaultRegistry;
+    if (!packageName) {
+      throw new errors.NotFoundError(
+        `Npm package name not defined at entity '${entityRef}'`
+      );
+    }
+    const registry = config?.registries?.find((r) => r.name === registryName);
+    if (!registry && registryName !== "default" && registryName !== "npmjs") {
+      throw new errors.NotFoundError(
+        `Npm registry config '${registryName}' not found as defined in entity '${entityRef}'`
+      );
+    }
+    this.logger.info("Will use npmjs package info:", {
+      entityRef,
+      packageName,
+      registryUrl: registry?.url,
+      registryToken: registry?.token ? "yes" : "no"
+    });
+    const client = new pluginNpmCommon.NpmRegistryClient({
+      // TODO pass apiFetch.fetch
+      baseUrl: registry?.url,
+      token: registry?.token
+    });
+    const packageInfo = await client.getPackageInfo(packageName);
+    return packageInfo;
+  }
+}
+
+exports.NpmRegistryServiceImpl = NpmRegistryServiceImpl;
+//# sourceMappingURL=NpmRegistryServiceImpl.cjs.js.map

package/dist/services/NpmRegistryServiceImpl.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NpmRegistryServiceImpl.cjs.js","sources":["../../src/services/NpmRegistryServiceImpl.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  AuthService,\n  BackstageCredentials,\n  BackstageUserPrincipal,\n  LoggerService,\n  RootConfigService,\n} from '@backstage/backend-plugin-api';\nimport { NotFoundError } from '@backstage/errors';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node/alpha';\n\nimport {\n  NpmAnnotation,\n  NpmRegistryClient,\n  NpmRegistryPackageInfo,\n} from '@backstage-community/plugin-npm-common';\n\nimport { NpmRegistryService } from './NpmRegistryService';\nimport { Config } from '../../config';\n\nexport type Options = {\n  logger: LoggerService;\n  auth: AuthService;\n  config: RootConfigService;\n  // TODO update CatalogService\n  catalog: typeof catalogServiceRef.T;\n};\n\nexport class NpmRegistryServiceImpl implements NpmRegistryService {\n  private readonly logger: LoggerService;\n  private readonly auth: AuthService;\n  private readonly config: RootConfigService;\n  private readonly catalog: typeof catalogServiceRef.T;\n\n  constructor(options: Options) {\n    this.logger = options.logger;\n    this.auth = options.auth;\n    this.config = options.config;\n    this.catalog = options.catalog;\n  }\n\n  async getPackageInfo(\n    entityRef: string,\n    options: { credentials: BackstageCredentials<BackstageUserPrincipal> },\n  ): Promise<NpmRegistryPackageInfo> {\n    const { token } = await this.auth.getPluginRequestToken({\n      onBehalfOf: options.credentials,\n      targetPluginId: 'catalog',\n    });\n    const entity = await this.catalog.getEntityByRef(entityRef, {\n      token,\n    });\n    if (!entity) {\n      throw new NotFoundError(`No entity found for ref '${entityRef}'`);\n    }\n\n    const config = this.config.getOptional<Config['npm']>('npm');\n    const defaultRegistry = config?.defaultRegistry;\n\n    const packageName =\n      entity.metadata.annotations?.[NpmAnnotation.PACKAGE_NAME];\n    const registryName =\n      entity.metadata.annotations?.[NpmAnnotation.REGISTRY_NAME] ||\n      defaultRegistry;\n    if (!packageName) {\n      throw new NotFoundError(\n        `Npm package name not defined at entity '${entityRef}'`,\n      );\n    }\n\n    const registry = config?.registries?.find(r => r.name === registryName);\n    if (!registry && registryName !== 'default' && registryName !== 'npmjs') {\n      throw new NotFoundError(\n        `Npm registry config '${registryName}' not found as defined in entity '${entityRef}'`,\n      );\n    }\n\n    this.logger.info('Will use npmjs package info:', {\n      entityRef,\n      packageName,\n      registryUrl: registry?.url,\n      registryToken: registry?.token ? 'yes' : 'no',\n    });\n\n    const client = new NpmRegistryClient({\n      // TODO pass apiFetch.fetch\n      baseUrl: registry?.url,\n      token: registry?.token,\n    });\n    const packageInfo = await client.getPackageInfo(packageName);\n    return packageInfo;\n  }\n}\n"],"names":["NotFoundError","NpmAnnotation","NpmRegistryClient"],"mappings":";;;;;AA0CO,MAAM,sBAAqD,CAAA;AAAA,EAC/C,MAAA;AAAA,EACA,IAAA;AAAA,EACA,MAAA;AAAA,EACA,OAAA;AAAA,EAEjB,YAAY,OAAkB,EAAA;AAC5B,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AACtB,IAAA,IAAA,CAAK,OAAO,OAAQ,CAAA,IAAA;AACpB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA;AACtB,IAAA,IAAA,CAAK,UAAU,OAAQ,CAAA,OAAA;AAAA;AACzB,EAEA,MAAM,cACJ,CAAA,SAAA,EACA,OACiC,EAAA;AACjC,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,KAAK,qBAAsB,CAAA;AAAA,MACtD,YAAY,OAAQ,CAAA,WAAA;AAAA,MACpB,cAAgB,EAAA;AAAA,KACjB,CAAA;AACD,IAAA,MAAM,MAAS,GAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,eAAe,SAAW,EAAA;AAAA,MAC1D;AAAA,KACD,CAAA;AACD,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAA,MAAM,IAAIA,oBAAA,CAAc,CAA4B,yBAAA,EAAA,SAAS,CAAG,CAAA,CAAA,CAAA;AAAA;AAGlE,IAAA,MAAM,MAAS,GAAA,IAAA,CAAK,MAAO,CAAA,WAAA,CAA2B,KAAK,CAAA;AAC3D,IAAA,MAAM,kBAAkB,MAAQ,EAAA,eAAA;AAEhC,IAAA,MAAM,WACJ,GAAA,MAAA,CAAO,QAAS,CAAA,WAAA,GAAcC,8BAAc,YAAY,CAAA;AAC1D,IAAA,MAAM,eACJ,MAAO,CAAA,QAAA,CAAS,WAAc,GAAAA,6BAAA,CAAc,aAAa,CACzD,IAAA,eAAA;AACF,IAAA,IAAI,CAAC,WAAa,EAAA;AAChB,MAAA,MAAM,IAAID,oBAAA;AAAA,QACR,2CAA2C,SAAS,CAAA,CAAA;AAAA,OACtD;AAAA;AAGF,IAAA,MAAM,WAAW,MAAQ,EAAA,UAAA,EAAY,KAAK,CAAK,CAAA,KAAA,CAAA,CAAE,SAAS,YAAY,CAAA;AACtE,IAAA,IAAI,CAAC,QAAA,IAAY,YAAiB,KAAA,SAAA,IAAa,iBAAiB,OAAS,EAAA;AACvE,MAAA,MAAM,IAAIA,oBAAA;AAAA,QACR,CAAA,qBAAA,EAAwB,YAAY,CAAA,kCAAA,EAAqC,SAAS,CAAA,CAAA;AAAA,OACpF;AAAA;AAGF,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,8BAAgC,EAAA;AAAA,MAC/C,SAAA;AAAA,MACA,WAAA;AAAA,MACA,aAAa,QAAU,EAAA,GAAA;AAAA,MACvB,aAAA,EAAe,QAAU,EAAA,KAAA,GAAQ,KAAQ,GAAA;AAAA,KAC1C,CAAA;AAED,IAAM,MAAA,MAAA,GAAS,IAAIE,iCAAkB,CAAA;AAAA;AAAA,MAEnC,SAAS,QAAU,EAAA,GAAA;AAAA,MACnB,OAAO,QAAU,EAAA;AAAA,KAClB,CAAA;AACD,IAAA,MAAM,WAAc,GAAA,MAAM,MAAO,CAAA,cAAA,CAAe,WAAW,CAAA;AAC3D,IAAO,OAAA,WAAA;AAAA;AAEX;;;;"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@backstage-community/plugin-npm-backend",
+  "version": "1.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",
+    "supported-versions": "1.28.0",
+    "pluginId": "npm",
+    "pluginPackage": "@backstage-community/plugin-npm-backend",
+    "pluginPackages": [
+      "@backstage-community/plugin-npm",
+      "@backstage-community/plugin-npm-backend",
+      "@backstage-community/plugin-npm-common"
+    ]
+  },
+  "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-community/plugin-npm-common": "^1.1.0",
+    "@backstage/backend-defaults": "^0.5.1",
+    "@backstage/backend-plugin-api": "^1.0.1",
+    "@backstage/catalog-client": "^1.7.1",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/plugin-catalog-node": "^1.13.1",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^1.0.1",
+    "@backstage/cli": "^0.28.0",
+    "@types/express": "*",
+    "@types/supertest": "^2.0.12",
+    "supertest": "^6.2.4"
+  },
+  "files": [
+    "config.d.ts",
+    "dist"
+  ],
+  "configSchema": "config.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/npm/plugins/npm-backend"
+  },
+  "keywords": [
+    "backstage",
+    "plugin",
+    "npm"
+  ],
+  "homepage": "https://github.com/backstage/community-plugins/tree/main/workspaces/npm/plugins/npm-backend",
+  "bugs": "https://github.com/backstage/community-plugins/issues",
+  "maintainers": [
+    "jerolimov",
+    "karthikjeeyar"
+  ],
+  "author": "Christoph Jerolimov"
+}