@backstage-community/plugin-badges-backend 0.5.1 → 0.5.3

package/dist/lib/BadgeBuilder/DefaultBadgeBuilder.cjs.js

@@ -0,0 +1,63 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var badgeMaker = require('badge-maker');
+
+class DefaultBadgeBuilder {
+  constructor(factories) {
+    this.factories = factories;
+  }
+  async getBadges() {
+    return Object.keys(this.factories).map((id) => ({ id }));
+  }
+  async createBadgeJson(options) {
+    const factory = this.factories[options.badgeInfo.id];
+    const badge = factory ? factory.createBadge(options.context) : {
+      label: "unknown badge",
+      message: options.badgeInfo.id,
+      color: "red"
+    };
+    if (!badge) {
+      throw new errors.InputError(
+        `The badge factory failed to produce a "${options.badgeInfo.id}" badge with the provided context`
+      );
+    }
+    return {
+      badge,
+      id: options.badgeInfo.id,
+      url: options.context.badgeUrl,
+      markdown: this.getMarkdownCode(badge, options.context.badgeUrl)
+    };
+  }
+  async createBadgeSvg(options) {
+    const { badge } = await this.createBadgeJson(options);
+    try {
+      const format = {
+        message: badge.message,
+        color: badge.color || "#36BAA2",
+        label: badge.label || "",
+        labelColor: badge.labelColor || "",
+        style: badge.style || "flat-square"
+      };
+      return badgeMaker.makeBadge(format);
+    } catch (err) {
+      return badgeMaker.makeBadge({
+        label: "invalid badge",
+        message: `${err}`,
+        color: "red"
+      });
+    }
+  }
+  getMarkdownCode(params, badgeUrl) {
+    let altText = `${params.label}: ${params.message}`;
+    if (params.description && params.description !== params.label) {
+      altText = `${params.description}, ${altText}`;
+    }
+    const tooltip = params.description ? ` "${params.description}"` : "";
+    const img = `![${altText}](${badgeUrl}${tooltip})`;
+    return params.link ? `[${img}](${params.link})` : img;
+  }
+}
+
+exports.DefaultBadgeBuilder = DefaultBadgeBuilder;
+//# sourceMappingURL=DefaultBadgeBuilder.cjs.js.map

package/dist/lib/BadgeBuilder/DefaultBadgeBuilder.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultBadgeBuilder.cjs.js","sources":["../../../src/lib/BadgeBuilder/DefaultBadgeBuilder.ts"],"sourcesContent":["/*\n * Copyright 2021 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 */\n\nimport { InputError } from '@backstage/errors';\nimport { makeBadge, Format } from 'badge-maker';\nimport { BadgeBuilder, BadgeInfo, BadgeOptions, BadgeSpec } from './types';\nimport { Badge, BadgeFactories } from '../../types';\n\n/** @public */\nexport class DefaultBadgeBuilder implements BadgeBuilder {\n  constructor(private readonly factories: BadgeFactories) {}\n\n  public async getBadges(): Promise<BadgeInfo[]> {\n    return Object.keys(this.factories).map(id => ({ id }));\n  }\n\n  public async createBadgeJson(options: BadgeOptions): Promise<BadgeSpec> {\n    const factory = this.factories[options.badgeInfo.id];\n    const badge = factory\n      ? factory.createBadge(options.context)\n      : ({\n          label: 'unknown badge',\n          message: options.badgeInfo.id,\n          color: 'red',\n        } as Badge);\n\n    if (!badge) {\n      throw new InputError(\n        `The badge factory failed to produce a \"${options.badgeInfo.id}\" badge with the provided context`,\n      );\n    }\n\n    return {\n      badge,\n      id: options.badgeInfo.id,\n      url: options.context.badgeUrl,\n      markdown: this.getMarkdownCode(badge, options.context.badgeUrl),\n    };\n  }\n\n  public async createBadgeSvg(options: BadgeOptions): Promise<string> {\n    const { badge } = await this.createBadgeJson(options);\n    try {\n      const format = {\n        message: badge.message,\n        color: badge.color || '#36BAA2',\n        label: badge.label || '',\n        labelColor: badge.labelColor || '',\n        style: badge.style || 'flat-square',\n      } as Format;\n      return makeBadge(format);\n    } catch (err) {\n      return makeBadge({\n        label: 'invalid badge',\n        message: `${err}`,\n        color: 'red',\n      });\n    }\n  }\n\n  protected getMarkdownCode(params: Badge, badgeUrl: string): string {\n    let altText = `${params.label}: ${params.message}`;\n    if (params.description && params.description !== params.label) {\n      altText = `${params.description}, ${altText}`;\n    }\n    const tooltip = params.description ? ` \"${params.description}\"` : '';\n    const img = `![${altText}](${badgeUrl}${tooltip})`;\n    return params.link ? `[${img}](${params.link})` : img;\n  }\n}\n"],"names":["InputError","makeBadge"],"mappings":";;;;;AAsBO,MAAM,mBAA4C,CAAA;AAAA,EACvD,YAA6B,SAA2B,EAAA;AAA3B,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAAA,GAA4B;AAAA,EAEzD,MAAa,SAAkC,GAAA;AAC7C,IAAO,OAAA,MAAA,CAAO,KAAK,IAAK,CAAA,SAAS,EAAE,GAAI,CAAA,CAAA,EAAA,MAAO,EAAE,EAAA,EAAK,CAAA,CAAA,CAAA;AAAA,GACvD;AAAA,EAEA,MAAa,gBAAgB,OAA2C,EAAA;AACtE,IAAA,MAAM,OAAU,GAAA,IAAA,CAAK,SAAU,CAAA,OAAA,CAAQ,UAAU,EAAE,CAAA,CAAA;AACnD,IAAA,MAAM,QAAQ,OACV,GAAA,OAAA,CAAQ,WAAY,CAAA,OAAA,CAAQ,OAAO,CAClC,GAAA;AAAA,MACC,KAAO,EAAA,eAAA;AAAA,MACP,OAAA,EAAS,QAAQ,SAAU,CAAA,EAAA;AAAA,MAC3B,KAAO,EAAA,KAAA;AAAA,KACT,CAAA;AAEJ,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAA,MAAM,IAAIA,iBAAA;AAAA,QACR,CAAA,uCAAA,EAA0C,OAAQ,CAAA,SAAA,CAAU,EAAE,CAAA,iCAAA,CAAA;AAAA,OAChE,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,KAAA;AAAA,MACA,EAAA,EAAI,QAAQ,SAAU,CAAA,EAAA;AAAA,MACtB,GAAA,EAAK,QAAQ,OAAQ,CAAA,QAAA;AAAA,MACrB,UAAU,IAAK,CAAA,eAAA,CAAgB,KAAO,EAAA,OAAA,CAAQ,QAAQ,QAAQ,CAAA;AAAA,KAChE,CAAA;AAAA,GACF;AAAA,EAEA,MAAa,eAAe,OAAwC,EAAA;AAClE,IAAA,MAAM,EAAE,KAAM,EAAA,GAAI,MAAM,IAAA,CAAK,gBAAgB,OAAO,CAAA,CAAA;AACpD,IAAI,IAAA;AACF,MAAA,MAAM,MAAS,GAAA;AAAA,QACb,SAAS,KAAM,CAAA,OAAA;AAAA,QACf,KAAA,EAAO,MAAM,KAAS,IAAA,SAAA;AAAA,QACtB,KAAA,EAAO,MAAM,KAAS,IAAA,EAAA;AAAA,QACtB,UAAA,EAAY,MAAM,UAAc,IAAA,EAAA;AAAA,QAChC,KAAA,EAAO,MAAM,KAAS,IAAA,aAAA;AAAA,OACxB,CAAA;AACA,MAAA,OAAOC,qBAAU,MAAM,CAAA,CAAA;AAAA,aAChB,GAAK,EAAA;AACZ,MAAA,OAAOA,oBAAU,CAAA;AAAA,QACf,KAAO,EAAA,eAAA;AAAA,QACP,OAAA,EAAS,GAAG,GAAG,CAAA,CAAA;AAAA,QACf,KAAO,EAAA,KAAA;AAAA,OACR,CAAA,CAAA;AAAA,KACH;AAAA,GACF;AAAA,EAEU,eAAA,CAAgB,QAAe,QAA0B,EAAA;AACjE,IAAA,IAAI,UAAU,CAAG,EAAA,MAAA,CAAO,KAAK,CAAA,EAAA,EAAK,OAAO,OAAO,CAAA,CAAA,CAAA;AAChD,IAAA,IAAI,MAAO,CAAA,WAAA,IAAe,MAAO,CAAA,WAAA,KAAgB,OAAO,KAAO,EAAA;AAC7D,MAAA,OAAA,GAAU,CAAG,EAAA,MAAA,CAAO,WAAW,CAAA,EAAA,EAAK,OAAO,CAAA,CAAA,CAAA;AAAA,KAC7C;AACA,IAAA,MAAM,UAAU,MAAO,CAAA,WAAA,GAAc,CAAK,EAAA,EAAA,MAAA,CAAO,WAAW,CAAM,CAAA,CAAA,GAAA,EAAA,CAAA;AAClE,IAAA,MAAM,MAAM,CAAK,EAAA,EAAA,OAAO,CAAK,EAAA,EAAA,QAAQ,GAAG,OAAO,CAAA,CAAA,CAAA,CAAA;AAC/C,IAAA,OAAO,OAAO,IAAO,GAAA,CAAA,CAAA,EAAI,GAAG,CAAK,EAAA,EAAA,MAAA,CAAO,IAAI,CAAM,CAAA,CAAA,GAAA,GAAA,CAAA;AAAA,GACpD;AACF;;;;"}

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');
+var badges = require('./badges.cjs.js');
+
+const badgesPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "badges",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger,
+        discovery: backendPluginApi.coreServices.discovery,
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        httpAuth: backendPluginApi.coreServices.httpAuth,
+        auth: backendPluginApi.coreServices.auth
+      },
+      async init({ config, logger, discovery, httpRouter, httpAuth, auth }) {
+        httpRouter.use(
+          await router.createRouter({
+            config,
+            logger,
+            badgeFactories: badges.createDefaultBadgeFactories(),
+            discovery,
+            httpAuth,
+            auth
+          })
+        );
+        httpRouter.addAuthPolicy({
+          path: "/entity/:entityUuid/:badgeId",
+          allow: "unauthenticated"
+        });
+        httpRouter.addAuthPolicy({
+          path: "/entity/:namespace/:kind/:name/badge/:badgeId",
+          allow: "unauthenticated"
+        });
+      }
+    });
+  }
+});
+
+exports.badgesPlugin = badgesPlugin;
+//# 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 2023 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 */\n\nimport {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\nimport { createDefaultBadgeFactories } from './badges';\n\n/**\n * Badges backend plugin\n *\n * @public\n */\nexport const badgesPlugin = createBackendPlugin({\n  pluginId: 'badges',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        discovery: coreServices.discovery,\n        httpRouter: coreServices.httpRouter,\n        httpAuth: coreServices.httpAuth,\n        auth: coreServices.auth,\n      },\n      async init({ config, logger, discovery, httpRouter, httpAuth, auth }) {\n        httpRouter.use(\n          await createRouter({\n            config,\n            logger,\n            badgeFactories: createDefaultBadgeFactories(),\n            discovery,\n            httpAuth,\n            auth,\n          }),\n        );\n        httpRouter.addAuthPolicy({\n          path: '/entity/:entityUuid/:badgeId',\n          allow: 'unauthenticated',\n        });\n        httpRouter.addAuthPolicy({\n          path: '/entity/:namespace/:kind/:name/badge/:badgeId',\n          allow: 'unauthenticated',\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter","createDefaultBadgeFactories"],"mappings":";;;;;;AA4BO,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,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,MAAMA,6BAAa,CAAA,IAAA;AAAA,OACrB;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,QAAQ,SAAW,EAAA,UAAA,EAAY,QAAU,EAAA,IAAA,EAAQ,EAAA;AACpE,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,mBAAa,CAAA;AAAA,YACjB,MAAA;AAAA,YACA,MAAA;AAAA,YACA,gBAAgBC,kCAA4B,EAAA;AAAA,YAC5C,SAAA;AAAA,YACA,QAAA;AAAA,YACA,IAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,8BAAA;AAAA,UACN,KAAO,EAAA,iBAAA;AAAA,SACR,CAAA,CAAA;AACD,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,+CAAA;AAAA,UACN,KAAO,EAAA,iBAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/dist/service/router.cjs.js

@@ -0,0 +1,294 @@
+'use strict';
+
+var Router = require('express-promise-router');
+var backendCommon = require('@backstage/backend-common');
+var catalogClient = require('@backstage/catalog-client');
+var errors = require('@backstage/errors');
+var DefaultBadgeBuilder = require('../lib/BadgeBuilder/DefaultBadgeBuilder.cjs.js');
+var types = require('../types.cjs.js');
+var lodash = require('lodash');
+var badgesStore = require('../database/badgesStore.cjs.js');
+var badges = require('../badges.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+
+async function createRouter(options) {
+  const catalog = options.catalog || new catalogClient.CatalogClient({ discoveryApi: options.discovery });
+  const badgeBuilder = options.badgeBuilder || new DefaultBadgeBuilder.DefaultBadgeBuilder(
+    options.badgeFactories || badges.createDefaultBadgeFactories()
+  );
+  const router = Router__default.default();
+  const { config, logger, discovery } = options;
+  const baseUrl = await discovery.getExternalBaseUrl("badges");
+  const { auth, httpAuth } = backendCommon.createLegacyAuthAdapters(options);
+  if (config.getOptionalBoolean("app.badges.obfuscate")) {
+    return obfuscatedRoute(
+      router,
+      catalog,
+      badgeBuilder,
+      logger,
+      options,
+      config,
+      baseUrl,
+      auth,
+      httpAuth
+    );
+  }
+  return nonObfuscatedRoute(
+    router,
+    catalog,
+    badgeBuilder,
+    config,
+    baseUrl,
+    auth
+  );
+}
+async function obfuscatedRoute(router, catalog, badgeBuilder, logger, options, config, baseUrl, auth, httpAuth) {
+  logger.info("Badges obfuscation is enabled");
+  const store = options.badgeStore ? options.badgeStore : await badgesStore.DatabaseBadgesStore.create({
+    database: backendCommon.DatabaseManager.fromConfig(config).forPlugin("badges")
+  });
+  router.get("/entity/:entityUuid/badge-specs", async (req, res) => {
+    const { entityUuid } = req.params;
+    const badgeInfos = await store.getBadgeFromUuid(entityUuid);
+    if (lodash.isNil(badgeInfos)) {
+      throw new errors.NotFoundError(`No badge found for entity uuid "${entityUuid}"`);
+    }
+    const name = badgeInfos.name;
+    const namespace = badgeInfos.namespace;
+    const kind = badgeInfos.kind;
+    const { token } = await auth.getPluginRequestToken({
+      onBehalfOf: await auth.getOwnServiceCredentials(),
+      targetPluginId: "catalog"
+    });
+    const entity = await catalog.getEntityByRef(
+      { namespace, kind, name },
+      { token }
+    );
+    if (lodash.isNil(entity)) {
+      throw new errors.NotFoundError(
+        `No ${kind} entity in ${namespace} named "${name}"`
+      );
+    }
+    const bsOptions = parseBadgeStyleOptions(req.query);
+    const specs = [];
+    for (const badgeInfo of await badgeBuilder.getBadges()) {
+      const context = {
+        badgeUrl: `${baseUrl}/entity/${entityUuid}/${badgeInfo.id}${buildBadgeStyleOptionsQuery(bsOptions)}`,
+        config,
+        entity,
+        style: bsOptions.style,
+        color: bsOptions.style
+      };
+      const badge = await badgeBuilder.createBadgeJson({
+        badgeInfo,
+        context
+      });
+      specs.push(badge);
+    }
+    res.status(200).json(specs);
+  });
+  router.get("/entity/:entityUuid/:badgeId", async (req, res) => {
+    const { entityUuid, badgeId } = req.params;
+    const badgeInfo = await store.getBadgeFromUuid(entityUuid);
+    if (lodash.isNil(badgeInfo)) {
+      throw new errors.NotFoundError(`No badge found for entity uuid "${entityUuid}"`);
+    }
+    const name = badgeInfo.name;
+    const namespace = badgeInfo.namespace;
+    const kind = badgeInfo.kind;
+    const { token } = await auth.getPluginRequestToken({
+      onBehalfOf: await auth.getOwnServiceCredentials(),
+      targetPluginId: "catalog"
+    });
+    const entity = await catalog.getEntityByRef(
+      { namespace, kind, name },
+      { token }
+    );
+    if (lodash.isNil(entity)) {
+      throw new errors.NotFoundError(
+        `No ${kind} entity in ${namespace} named "${name}"`,
+        res.sendStatus(404)
+      );
+    }
+    let format = req.accepts(["image/svg+xml", "application/json"]) || "image/svg+xml";
+    if (req.query.format === "json") {
+      format = "application/json";
+    }
+    const bsOptions = parseBadgeStyleOptions(req.query);
+    const badgeOptions = {
+      badgeInfo: { id: badgeId },
+      context: {
+        badgeUrl: `${baseUrl}/entity/${entityUuid}/${badgeId}${buildBadgeStyleOptionsQuery(
+          bsOptions
+        )}`,
+        config,
+        entity,
+        style: bsOptions.style,
+        color: bsOptions.color
+      }
+    };
+    let data;
+    if (format === "application/json") {
+      data = JSON.stringify(
+        await badgeBuilder.createBadgeJson(badgeOptions),
+        null,
+        2
+      );
+    } else {
+      data = await badgeBuilder.createBadgeSvg(badgeOptions);
+    }
+    res.setHeader("Content-Type", format);
+    res.status(200).send(data);
+  });
+  router.get(
+    "/entity/:namespace/:kind/:name/obfuscated",
+    async function authenticate(req, _res, next) {
+      const { kind, namespace, name } = req.params;
+      const { token } = await auth.getPluginRequestToken({
+        onBehalfOf: await httpAuth.credentials(req),
+        targetPluginId: "catalog"
+      });
+      const entity = await catalog.getEntityByRef(
+        { kind, namespace, name },
+        { token }
+      );
+      if (!entity) {
+        throw new errors.NotFoundError(
+          `No ${kind} entity in ${namespace} named "${name}"`
+        );
+      } else {
+        next();
+      }
+    },
+    async (req, res) => {
+      const { namespace, kind, name } = req.params;
+      const storedEntityUuid = await store.getBadgeUuid(name, namespace, kind);
+      if (lodash.isNil(storedEntityUuid)) {
+        throw new errors.NotFoundError(
+          `No uuid found for entity "${namespace}/${kind}/${name}"`
+        );
+      }
+      return res.status(200).json(storedEntityUuid);
+    }
+  );
+  router.use(backendCommon.errorHandler());
+  return router;
+}
+async function nonObfuscatedRoute(router, catalog, badgeBuilder, config, baseUrl, auth) {
+  router.get("/entity/:namespace/:kind/:name/badge-specs", async (req, res) => {
+    const { token } = await auth.getPluginRequestToken({
+      onBehalfOf: await auth.getOwnServiceCredentials(),
+      targetPluginId: "catalog"
+    });
+    const { namespace, kind, name } = req.params;
+    const entity = await catalog.getEntityByRef(
+      { namespace, kind, name },
+      { token }
+    );
+    if (!entity) {
+      throw new errors.NotFoundError(
+        `No ${kind} entity in ${namespace} named "${name}"`
+      );
+    }
+    const bsOptions = parseBadgeStyleOptions(req.query);
+    const specs = [];
+    for (const badgeInfo of await badgeBuilder.getBadges()) {
+      const badgeId = badgeInfo.id;
+      const context = {
+        badgeUrl: `${baseUrl}/entity/${namespace}/${kind}/${name}/badge/${badgeId}${buildBadgeStyleOptionsQuery(
+          bsOptions
+        )}`,
+        config,
+        entity,
+        style: bsOptions.style,
+        color: bsOptions.color
+      };
+      const badge = await badgeBuilder.createBadgeJson({
+        badgeInfo,
+        context
+      });
+      specs.push(badge);
+    }
+    res.status(200).json(specs);
+  });
+  router.get(
+    "/entity/:namespace/:kind/:name/badge/:badgeId",
+    async (req, res) => {
+      const { namespace, kind, name, badgeId } = req.params;
+      const { token } = await auth.getPluginRequestToken({
+        onBehalfOf: await auth.getOwnServiceCredentials(),
+        targetPluginId: "catalog"
+      });
+      const entity = await catalog.getEntityByRef(
+        { namespace, kind, name },
+        { token }
+      );
+      if (!entity) {
+        throw new errors.NotFoundError(
+          `No ${kind} entity in ${namespace} named "${name}"`
+        );
+      }
+      let format = req.accepts(["image/svg+xml", "application/json"]) || "image/svg+xml";
+      if (req.query.format === "json") {
+        format = "application/json";
+      }
+      const bsOptions = parseBadgeStyleOptions(req.query);
+      const badgeOptions = {
+        badgeInfo: { id: badgeId },
+        context: {
+          badgeUrl: `${baseUrl}/entity/${namespace}/${kind}/${name}/badge/${badgeId}${buildBadgeStyleOptionsQuery(
+            bsOptions
+          )}`,
+          config,
+          entity,
+          style: bsOptions.style,
+          color: bsOptions.color
+        }
+      };
+      let data;
+      if (format === "application/json") {
+        data = JSON.stringify(
+          await badgeBuilder.createBadgeJson(badgeOptions),
+          null,
+          2
+        );
+      } else {
+        data = await badgeBuilder.createBadgeSvg(badgeOptions);
+      }
+      res.setHeader("Content-Type", format);
+      res.status(200).send(data);
+    }
+  );
+  router.use(backendCommon.errorHandler());
+  return router;
+}
+function parseBadgeStyleOptions(query) {
+  let style = void 0;
+  let color = void 0;
+  if (typeof query.style === "string" && types.BADGE_STYLES.includes(query.style)) {
+    style = query.style;
+  }
+  if (typeof query.color === "string") {
+    color = query.color;
+  }
+  return { style, color };
+}
+function buildBadgeStyleOptionsQuery({
+  style,
+  color
+}) {
+  const query = [];
+  if (style) {
+    query.push(`style=${style}`);
+  }
+  if (color) {
+    query.push(`color=${color}`);
+  }
+  return query.length > 0 ? `?${query.join("&")}` : "";
+}
+
+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":["/*\n * Copyright 2021 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 */\n\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport {\n  createLegacyAuthAdapters,\n  DatabaseManager,\n  errorHandler,\n  PluginEndpointDiscovery,\n  TokenManager,\n} from '@backstage/backend-common';\nimport { CatalogApi, CatalogClient } from '@backstage/catalog-client';\nimport { Config } from '@backstage/config';\nimport { NotFoundError } from '@backstage/errors';\nimport { BadgeBuilder, DefaultBadgeBuilder } from '../lib/BadgeBuilder';\nimport {\n  BADGE_STYLES,\n  BadgeContext,\n  BadgeFactories,\n  BadgeStyle,\n} from '../types';\nimport { isNil } from 'lodash';\nimport { IdentityApi } from '@backstage/plugin-auth-node';\nimport { BadgesStore, DatabaseBadgesStore } from '../database/badgesStore';\nimport { createDefaultBadgeFactories } from '../badges';\nimport {\n  AuthService,\n  HttpAuthService,\n  LoggerService,\n} from '@backstage/backend-plugin-api';\n\n/** @public */\nexport interface RouterOptions {\n  badgeBuilder?: BadgeBuilder;\n  badgeFactories?: BadgeFactories;\n  catalog?: CatalogApi;\n  config: Config;\n  discovery: PluginEndpointDiscovery;\n  tokenManager?: TokenManager;\n  auth?: AuthService;\n  httpAuth?: HttpAuthService;\n  logger: LoggerService;\n  identity?: IdentityApi;\n  badgeStore?: BadgesStore;\n}\n\n/** @public */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const catalog =\n    options.catalog || new CatalogClient({ discoveryApi: options.discovery });\n  const badgeBuilder =\n    options.badgeBuilder ||\n    new DefaultBadgeBuilder(\n      options.badgeFactories || createDefaultBadgeFactories(),\n    );\n  const router = Router();\n\n  const { config, logger, discovery } = options;\n  const baseUrl = await discovery.getExternalBaseUrl('badges');\n\n  const { auth, httpAuth } = createLegacyAuthAdapters(options);\n\n  if (config.getOptionalBoolean('app.badges.obfuscate')) {\n    return obfuscatedRoute(\n      router,\n      catalog,\n      badgeBuilder,\n      logger,\n      options,\n      config,\n      baseUrl,\n      auth,\n      httpAuth,\n    );\n  }\n  return nonObfuscatedRoute(\n    router,\n    catalog,\n    badgeBuilder,\n    config,\n    baseUrl,\n    auth,\n  );\n}\n\nasync function obfuscatedRoute(\n  router: express.Router,\n  catalog: CatalogApi,\n  badgeBuilder: BadgeBuilder,\n  logger: LoggerService,\n  options: RouterOptions,\n  config: Config,\n  baseUrl: string,\n  auth: AuthService,\n  httpAuth: HttpAuthService,\n) {\n  logger.info('Badges obfuscation is enabled');\n\n  const store = options.badgeStore\n    ? options.badgeStore\n    : await DatabaseBadgesStore.create({\n        database: DatabaseManager.fromConfig(config).forPlugin('badges'),\n      });\n\n  router.get('/entity/:entityUuid/badge-specs', async (req, res) => {\n    const { entityUuid } = req.params;\n\n    // Retrieve the badge info from the database\n    const badgeInfos = await store.getBadgeFromUuid(entityUuid);\n\n    if (isNil(badgeInfos)) {\n      throw new NotFoundError(`No badge found for entity uuid \"${entityUuid}\"`);\n    }\n\n    // If a mapping is found, map name, namespace and kind\n    const name = badgeInfos.name;\n    const namespace = badgeInfos.namespace;\n    const kind = badgeInfos.kind;\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: 'catalog',\n    });\n\n    // Query the catalog with the name, namespace, kind to get the entity information\n    const entity = await catalog.getEntityByRef(\n      { namespace, kind, name },\n      { token },\n    );\n\n    if (isNil(entity)) {\n      throw new NotFoundError(\n        `No ${kind} entity in ${namespace} named \"${name}\"`,\n      );\n    }\n\n    const bsOptions = parseBadgeStyleOptions(req.query);\n\n    // Create the badge specs\n    const specs = [];\n    for (const badgeInfo of await badgeBuilder.getBadges()) {\n      const context: BadgeContext = {\n        badgeUrl: `${baseUrl}/entity/${entityUuid}/${\n          badgeInfo.id\n        }${buildBadgeStyleOptionsQuery(bsOptions)}`,\n        config: config,\n        entity,\n        style: bsOptions.style,\n        color: bsOptions.style,\n      };\n\n      const badge = await badgeBuilder.createBadgeJson({\n        badgeInfo,\n        context,\n      });\n      specs.push(badge);\n    }\n\n    res.status(200).json(specs);\n  });\n\n  router.get('/entity/:entityUuid/:badgeId', async (req, res) => {\n    const { entityUuid, badgeId } = req.params;\n\n    // Retrieve the badge info from the database\n    const badgeInfo = await store.getBadgeFromUuid(entityUuid);\n\n    if (isNil(badgeInfo)) {\n      throw new NotFoundError(`No badge found for entity uuid \"${entityUuid}\"`);\n    }\n\n    // If a mapping is found, map name, namespace and kind\n    const name = badgeInfo.name;\n    const namespace = badgeInfo.namespace;\n    const kind = badgeInfo.kind;\n\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: 'catalog',\n    });\n\n    const entity = await catalog.getEntityByRef(\n      { namespace, kind, name },\n      { token },\n    );\n    if (isNil(entity)) {\n      throw new NotFoundError(\n        `No ${kind} entity in ${namespace} named \"${name}\"`,\n        res.sendStatus(404),\n      );\n    }\n\n    let format =\n      req.accepts(['image/svg+xml', 'application/json']) || 'image/svg+xml';\n    if (req.query.format === 'json') {\n      format = 'application/json';\n    }\n\n    const bsOptions = parseBadgeStyleOptions(req.query);\n\n    const badgeOptions = {\n      badgeInfo: { id: badgeId },\n      context: {\n        badgeUrl: `${baseUrl}/entity/${entityUuid}/${badgeId}${buildBadgeStyleOptionsQuery(\n          bsOptions,\n        )}`,\n        config: config,\n        entity,\n        style: bsOptions.style,\n        color: bsOptions.color,\n      },\n    };\n\n    let data: string;\n    if (format === 'application/json') {\n      data = JSON.stringify(\n        await badgeBuilder.createBadgeJson(badgeOptions),\n        null,\n        2,\n      );\n    } else {\n      data = await badgeBuilder.createBadgeSvg(badgeOptions);\n    }\n\n    res.setHeader('Content-Type', format);\n    res.status(200).send(data);\n  });\n\n  router.get(\n    '/entity/:namespace/:kind/:name/obfuscated',\n    async function authenticate(req, _res, next) {\n      const { kind, namespace, name } = req.params;\n\n      const { token } = await auth.getPluginRequestToken({\n        onBehalfOf: await httpAuth.credentials(req),\n        targetPluginId: 'catalog',\n      });\n\n      // check that the user has the correct permissions\n      // to view the catalog entity by forwarding the token\n      const entity = await catalog.getEntityByRef(\n        { kind, namespace, name },\n        { token },\n      );\n\n      if (!entity) {\n        throw new NotFoundError(\n          `No ${kind} entity in ${namespace} named \"${name}\"`,\n        );\n      } else {\n        next();\n      }\n    },\n    async (req, res) => {\n      const { namespace, kind, name } = req.params;\n      const storedEntityUuid: { uuid: string } | undefined =\n        await store.getBadgeUuid(name, namespace, kind);\n\n      if (isNil(storedEntityUuid)) {\n        throw new NotFoundError(\n          `No uuid found for entity \"${namespace}/${kind}/${name}\"`,\n        );\n      }\n\n      return res.status(200).json(storedEntityUuid);\n    },\n  );\n\n  router.use(errorHandler());\n\n  return router;\n}\n\nasync function nonObfuscatedRoute(\n  router: express.Router,\n  catalog: CatalogApi,\n  badgeBuilder: BadgeBuilder,\n  config: Config,\n  baseUrl: string,\n  auth: AuthService,\n) {\n  router.get('/entity/:namespace/:kind/:name/badge-specs', async (req, res) => {\n    const { token } = await auth.getPluginRequestToken({\n      onBehalfOf: await auth.getOwnServiceCredentials(),\n      targetPluginId: 'catalog',\n    });\n\n    const { namespace, kind, name } = req.params;\n    const entity = await catalog.getEntityByRef(\n      { namespace, kind, name },\n      { token },\n    );\n    if (!entity) {\n      throw new NotFoundError(\n        `No ${kind} entity in ${namespace} named \"${name}\"`,\n      );\n    }\n\n    const bsOptions = parseBadgeStyleOptions(req.query);\n\n    const specs = [];\n    for (const badgeInfo of await badgeBuilder.getBadges()) {\n      const badgeId = badgeInfo.id;\n      const context: BadgeContext = {\n        badgeUrl: `${baseUrl}/entity/${namespace}/${kind}/${name}/badge/${badgeId}${buildBadgeStyleOptionsQuery(\n          bsOptions,\n        )}`,\n        config: config,\n        entity,\n        style: bsOptions.style,\n        color: bsOptions.color,\n      };\n\n      const badge = await badgeBuilder.createBadgeJson({\n        badgeInfo,\n        context,\n      });\n      specs.push(badge);\n    }\n\n    res.status(200).json(specs);\n  });\n\n  router.get(\n    '/entity/:namespace/:kind/:name/badge/:badgeId',\n    async (req, res) => {\n      const { namespace, kind, name, badgeId } = req.params;\n      const { token } = await auth.getPluginRequestToken({\n        onBehalfOf: await auth.getOwnServiceCredentials(),\n        targetPluginId: 'catalog',\n      });\n\n      const entity = await catalog.getEntityByRef(\n        { namespace, kind, name },\n        { token },\n      );\n\n      if (!entity) {\n        throw new NotFoundError(\n          `No ${kind} entity in ${namespace} named \"${name}\"`,\n        );\n      }\n\n      let format =\n        req.accepts(['image/svg+xml', 'application/json']) || 'image/svg+xml';\n      if (req.query.format === 'json') {\n        format = 'application/json';\n      }\n\n      const bsOptions = parseBadgeStyleOptions(req.query);\n\n      const badgeOptions = {\n        badgeInfo: { id: badgeId },\n        context: {\n          badgeUrl: `${baseUrl}/entity/${namespace}/${kind}/${name}/badge/${badgeId}${buildBadgeStyleOptionsQuery(\n            bsOptions,\n          )}`,\n          config: config,\n          entity,\n          style: bsOptions.style,\n          color: bsOptions.color,\n        },\n      };\n\n      let data: string;\n      if (format === 'application/json') {\n        data = JSON.stringify(\n          await badgeBuilder.createBadgeJson(badgeOptions),\n          null,\n          2,\n        );\n      } else {\n        data = await badgeBuilder.createBadgeSvg(badgeOptions);\n      }\n\n      res.setHeader('Content-Type', format);\n      res.status(200).send(data);\n    },\n  );\n\n  router.use(errorHandler());\n\n  return router;\n}\n\ninterface BadgeStyleOptions {\n  style?: BadgeStyle;\n  color?: string;\n}\n\n// Parse common badge style options from query parameters.\n//\n// This function will parse the following query parameters:\n// - `style`: One of the supported badge styles.\n// - `color`: A custom color for the badge message.\nfunction parseBadgeStyleOptions(query: qs.ParsedQs): BadgeStyleOptions {\n  let style: BadgeStyle | undefined = undefined;\n  let color: string | undefined = undefined;\n\n  if (\n    typeof query.style === 'string' &&\n    BADGE_STYLES.includes(query.style as any)\n  ) {\n    style = query.style as BadgeStyle;\n  }\n\n  if (typeof query.color === 'string') {\n    color = query.color;\n  }\n\n  return { style, color };\n}\n\n// Build a query string including explanation mark if there are any options.\nfunction buildBadgeStyleOptionsQuery({\n  style,\n  color,\n}: BadgeStyleOptions): string {\n  const query: string[] = [];\n\n  if (style) {\n    query.push(`style=${style}`);\n  }\n\n  if (color) {\n    query.push(`color=${color}`);\n  }\n\n  return query.length > 0 ? `?${query.join('&')}` : '';\n}\n"],"names":["CatalogClient","DefaultBadgeBuilder","createDefaultBadgeFactories","Router","createLegacyAuthAdapters","DatabaseBadgesStore","DatabaseManager","isNil","NotFoundError","errorHandler","BADGE_STYLES"],"mappings":";;;;;;;;;;;;;;;;AA6DA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,OAAA,GACJ,QAAQ,OAAW,IAAA,IAAIA,4BAAc,EAAE,YAAA,EAAc,OAAQ,CAAA,SAAA,EAAW,CAAA,CAAA;AAC1E,EAAM,MAAA,YAAA,GACJ,OAAQ,CAAA,YAAA,IACR,IAAIC,uCAAA;AAAA,IACF,OAAA,CAAQ,kBAAkBC,kCAA4B,EAAA;AAAA,GACxD,CAAA;AACF,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AAEtB,EAAA,MAAM,EAAE,MAAA,EAAQ,MAAQ,EAAA,SAAA,EAAc,GAAA,OAAA,CAAA;AACtC,EAAA,MAAM,OAAU,GAAA,MAAM,SAAU,CAAA,kBAAA,CAAmB,QAAQ,CAAA,CAAA;AAE3D,EAAA,MAAM,EAAE,IAAA,EAAM,QAAS,EAAA,GAAIC,uCAAyB,OAAO,CAAA,CAAA;AAE3D,EAAI,IAAA,MAAA,CAAO,kBAAmB,CAAA,sBAAsB,CAAG,EAAA;AACrD,IAAO,OAAA,eAAA;AAAA,MACL,MAAA;AAAA,MACA,OAAA;AAAA,MACA,YAAA;AAAA,MACA,MAAA;AAAA,MACA,OAAA;AAAA,MACA,MAAA;AAAA,MACA,OAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA;AAAA,KACF,CAAA;AAAA,GACF;AACA,EAAO,OAAA,kBAAA;AAAA,IACL,MAAA;AAAA,IACA,OAAA;AAAA,IACA,YAAA;AAAA,IACA,MAAA;AAAA,IACA,OAAA;AAAA,IACA,IAAA;AAAA,GACF,CAAA;AACF,CAAA;AAEA,eAAe,eAAA,CACb,QACA,OACA,EAAA,YAAA,EACA,QACA,OACA,EAAA,MAAA,EACA,OACA,EAAA,IAAA,EACA,QACA,EAAA;AACA,EAAA,MAAA,CAAO,KAAK,+BAA+B,CAAA,CAAA;AAE3C,EAAA,MAAM,QAAQ,OAAQ,CAAA,UAAA,GAClB,QAAQ,UACR,GAAA,MAAMC,gCAAoB,MAAO,CAAA;AAAA,IAC/B,UAAUC,6BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAE,UAAU,QAAQ,CAAA;AAAA,GAChE,CAAA,CAAA;AAEL,EAAA,MAAA,CAAO,GAAI,CAAA,iCAAA,EAAmC,OAAO,GAAA,EAAK,GAAQ,KAAA;AAChE,IAAM,MAAA,EAAE,UAAW,EAAA,GAAI,GAAI,CAAA,MAAA,CAAA;AAG3B,IAAA,MAAM,UAAa,GAAA,MAAM,KAAM,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAE1D,IAAI,IAAAC,YAAA,CAAM,UAAU,CAAG,EAAA;AACrB,MAAA,MAAM,IAAIC,oBAAA,CAAc,CAAmC,gCAAA,EAAA,UAAU,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,KAC1E;AAGA,IAAA,MAAM,OAAO,UAAW,CAAA,IAAA,CAAA;AACxB,IAAA,MAAM,YAAY,UAAW,CAAA,SAAA,CAAA;AAC7B,IAAA,MAAM,OAAO,UAAW,CAAA,IAAA,CAAA;AACxB,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;AAGD,IAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,cAAA;AAAA,MAC3B,EAAE,SAAW,EAAA,IAAA,EAAM,IAAK,EAAA;AAAA,MACxB,EAAE,KAAM,EAAA;AAAA,KACV,CAAA;AAEA,IAAI,IAAAD,YAAA,CAAM,MAAM,CAAG,EAAA;AACjB,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,CAAM,GAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,OAClD,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,SAAA,GAAY,sBAAuB,CAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAGlD,IAAA,MAAM,QAAQ,EAAC,CAAA;AACf,IAAA,KAAA,MAAW,SAAa,IAAA,MAAM,YAAa,CAAA,SAAA,EAAa,EAAA;AACtD,MAAA,MAAM,OAAwB,GAAA;AAAA,QAC5B,QAAA,EAAU,CAAG,EAAA,OAAO,CAAW,QAAA,EAAA,UAAU,CACvC,CAAA,EAAA,SAAA,CAAU,EACZ,CAAA,EAAG,2BAA4B,CAAA,SAAS,CAAC,CAAA,CAAA;AAAA,QACzC,MAAA;AAAA,QACA,MAAA;AAAA,QACA,OAAO,SAAU,CAAA,KAAA;AAAA,QACjB,OAAO,SAAU,CAAA,KAAA;AAAA,OACnB,CAAA;AAEA,MAAM,MAAA,KAAA,GAAQ,MAAM,YAAA,CAAa,eAAgB,CAAA;AAAA,QAC/C,SAAA;AAAA,QACA,OAAA;AAAA,OACD,CAAA,CAAA;AACD,MAAA,KAAA,CAAM,KAAK,KAAK,CAAA,CAAA;AAAA,KAClB;AAEA,IAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,KAAK,CAAA,CAAA;AAAA,GAC3B,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,8BAAA,EAAgC,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC7D,IAAA,MAAM,EAAE,UAAA,EAAY,OAAQ,EAAA,GAAI,GAAI,CAAA,MAAA,CAAA;AAGpC,IAAA,MAAM,SAAY,GAAA,MAAM,KAAM,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAEzD,IAAI,IAAAD,YAAA,CAAM,SAAS,CAAG,EAAA;AACpB,MAAA,MAAM,IAAIC,oBAAA,CAAc,CAAmC,gCAAA,EAAA,UAAU,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,KAC1E;AAGA,IAAA,MAAM,OAAO,SAAU,CAAA,IAAA,CAAA;AACvB,IAAA,MAAM,YAAY,SAAU,CAAA,SAAA,CAAA;AAC5B,IAAA,MAAM,OAAO,SAAU,CAAA,IAAA,CAAA;AAEvB,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;AAED,IAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,cAAA;AAAA,MAC3B,EAAE,SAAW,EAAA,IAAA,EAAM,IAAK,EAAA;AAAA,MACxB,EAAE,KAAM,EAAA;AAAA,KACV,CAAA;AACA,IAAI,IAAAD,YAAA,CAAM,MAAM,CAAG,EAAA;AACjB,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,CAAM,GAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,QAChD,GAAA,CAAI,WAAW,GAAG,CAAA;AAAA,OACpB,CAAA;AAAA,KACF;AAEA,IAAA,IAAI,SACF,GAAI,CAAA,OAAA,CAAQ,CAAC,eAAiB,EAAA,kBAAkB,CAAC,CAAK,IAAA,eAAA,CAAA;AACxD,IAAI,IAAA,GAAA,CAAI,KAAM,CAAA,MAAA,KAAW,MAAQ,EAAA;AAC/B,MAAS,MAAA,GAAA,kBAAA,CAAA;AAAA,KACX;AAEA,IAAM,MAAA,SAAA,GAAY,sBAAuB,CAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAElD,IAAA,MAAM,YAAe,GAAA;AAAA,MACnB,SAAA,EAAW,EAAE,EAAA,EAAI,OAAQ,EAAA;AAAA,MACzB,OAAS,EAAA;AAAA,QACP,UAAU,CAAG,EAAA,OAAO,WAAW,UAAU,CAAA,CAAA,EAAI,OAAO,CAAG,EAAA,2BAAA;AAAA,UACrD,SAAA;AAAA,SACD,CAAA,CAAA;AAAA,QACD,MAAA;AAAA,QACA,MAAA;AAAA,QACA,OAAO,SAAU,CAAA,KAAA;AAAA,QACjB,OAAO,SAAU,CAAA,KAAA;AAAA,OACnB;AAAA,KACF,CAAA;AAEA,IAAI,IAAA,IAAA,CAAA;AACJ,IAAA,IAAI,WAAW,kBAAoB,EAAA;AACjC,MAAA,IAAA,GAAO,IAAK,CAAA,SAAA;AAAA,QACV,MAAM,YAAa,CAAA,eAAA,CAAgB,YAAY,CAAA;AAAA,QAC/C,IAAA;AAAA,QACA,CAAA;AAAA,OACF,CAAA;AAAA,KACK,MAAA;AACL,MAAO,IAAA,GAAA,MAAM,YAAa,CAAA,cAAA,CAAe,YAAY,CAAA,CAAA;AAAA,KACvD;AAEA,IAAI,GAAA,CAAA,SAAA,CAAU,gBAAgB,MAAM,CAAA,CAAA;AACpC,IAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAAA,GAC1B,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA;AAAA,IACL,2CAAA;AAAA,IACA,eAAe,YAAA,CAAa,GAAK,EAAA,IAAA,EAAM,IAAM,EAAA;AAC3C,MAAA,MAAM,EAAE,IAAA,EAAM,SAAW,EAAA,IAAA,KAAS,GAAI,CAAA,MAAA,CAAA;AAEtC,MAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,QACjD,UAAY,EAAA,MAAM,QAAS,CAAA,WAAA,CAAY,GAAG,CAAA;AAAA,QAC1C,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA,CAAA;AAID,MAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,cAAA;AAAA,QAC3B,EAAE,IAAM,EAAA,SAAA,EAAW,IAAK,EAAA;AAAA,QACxB,EAAE,KAAM,EAAA;AAAA,OACV,CAAA;AAEA,MAAA,IAAI,CAAC,MAAQ,EAAA;AACX,QAAA,MAAM,IAAIA,oBAAA;AAAA,UACR,CAAM,GAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,SAClD,CAAA;AAAA,OACK,MAAA;AACL,QAAK,IAAA,EAAA,CAAA;AAAA,OACP;AAAA,KACF;AAAA,IACA,OAAO,KAAK,GAAQ,KAAA;AAClB,MAAA,MAAM,EAAE,SAAA,EAAW,IAAM,EAAA,IAAA,KAAS,GAAI,CAAA,MAAA,CAAA;AACtC,MAAA,MAAM,mBACJ,MAAM,KAAA,CAAM,YAAa,CAAA,IAAA,EAAM,WAAW,IAAI,CAAA,CAAA;AAEhD,MAAI,IAAAD,YAAA,CAAM,gBAAgB,CAAG,EAAA;AAC3B,QAAA,MAAM,IAAIC,oBAAA;AAAA,UACR,CAA6B,0BAAA,EAAA,SAAS,CAAI,CAAA,EAAA,IAAI,IAAI,IAAI,CAAA,CAAA,CAAA;AAAA,SACxD,CAAA;AAAA,OACF;AAEA,MAAA,OAAO,GAAI,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,KAAK,gBAAgB,CAAA,CAAA;AAAA,KAC9C;AAAA,GACF,CAAA;AAEA,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AAEzB,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAEA,eAAe,mBACb,MACA,EAAA,OAAA,EACA,YACA,EAAA,MAAA,EACA,SACA,IACA,EAAA;AACA,EAAA,MAAA,CAAO,GAAI,CAAA,4CAAA,EAA8C,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC3E,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;AAED,IAAA,MAAM,EAAE,SAAA,EAAW,IAAM,EAAA,IAAA,KAAS,GAAI,CAAA,MAAA,CAAA;AACtC,IAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,cAAA;AAAA,MAC3B,EAAE,SAAW,EAAA,IAAA,EAAM,IAAK,EAAA;AAAA,MACxB,EAAE,KAAM,EAAA;AAAA,KACV,CAAA;AACA,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAA,MAAM,IAAID,oBAAA;AAAA,QACR,CAAM,GAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,OAClD,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,SAAA,GAAY,sBAAuB,CAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAElD,IAAA,MAAM,QAAQ,EAAC,CAAA;AACf,IAAA,KAAA,MAAW,SAAa,IAAA,MAAM,YAAa,CAAA,SAAA,EAAa,EAAA;AACtD,MAAA,MAAM,UAAU,SAAU,CAAA,EAAA,CAAA;AAC1B,MAAA,MAAM,OAAwB,GAAA;AAAA,QAC5B,QAAA,EAAU,CAAG,EAAA,OAAO,CAAW,QAAA,EAAA,SAAS,CAAI,CAAA,EAAA,IAAI,CAAI,CAAA,EAAA,IAAI,CAAU,OAAA,EAAA,OAAO,CAAG,EAAA,2BAAA;AAAA,UAC1E,SAAA;AAAA,SACD,CAAA,CAAA;AAAA,QACD,MAAA;AAAA,QACA,MAAA;AAAA,QACA,OAAO,SAAU,CAAA,KAAA;AAAA,QACjB,OAAO,SAAU,CAAA,KAAA;AAAA,OACnB,CAAA;AAEA,MAAM,MAAA,KAAA,GAAQ,MAAM,YAAA,CAAa,eAAgB,CAAA;AAAA,QAC/C,SAAA;AAAA,QACA,OAAA;AAAA,OACD,CAAA,CAAA;AACD,MAAA,KAAA,CAAM,KAAK,KAAK,CAAA,CAAA;AAAA,KAClB;AAEA,IAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,KAAK,CAAA,CAAA;AAAA,GAC3B,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA;AAAA,IACL,+CAAA;AAAA,IACA,OAAO,KAAK,GAAQ,KAAA;AAClB,MAAA,MAAM,EAAE,SAAW,EAAA,IAAA,EAAM,IAAM,EAAA,OAAA,KAAY,GAAI,CAAA,MAAA,CAAA;AAC/C,MAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,KAAK,qBAAsB,CAAA;AAAA,QACjD,UAAA,EAAY,MAAM,IAAA,CAAK,wBAAyB,EAAA;AAAA,QAChD,cAAgB,EAAA,SAAA;AAAA,OACjB,CAAA,CAAA;AAED,MAAM,MAAA,MAAA,GAAS,MAAM,OAAQ,CAAA,cAAA;AAAA,QAC3B,EAAE,SAAW,EAAA,IAAA,EAAM,IAAK,EAAA;AAAA,QACxB,EAAE,KAAM,EAAA;AAAA,OACV,CAAA;AAEA,MAAA,IAAI,CAAC,MAAQ,EAAA;AACX,QAAA,MAAM,IAAIA,oBAAA;AAAA,UACR,CAAM,GAAA,EAAA,IAAI,CAAc,WAAA,EAAA,SAAS,WAAW,IAAI,CAAA,CAAA,CAAA;AAAA,SAClD,CAAA;AAAA,OACF;AAEA,MAAA,IAAI,SACF,GAAI,CAAA,OAAA,CAAQ,CAAC,eAAiB,EAAA,kBAAkB,CAAC,CAAK,IAAA,eAAA,CAAA;AACxD,MAAI,IAAA,GAAA,CAAI,KAAM,CAAA,MAAA,KAAW,MAAQ,EAAA;AAC/B,QAAS,MAAA,GAAA,kBAAA,CAAA;AAAA,OACX;AAEA,MAAM,MAAA,SAAA,GAAY,sBAAuB,CAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAElD,MAAA,MAAM,YAAe,GAAA;AAAA,QACnB,SAAA,EAAW,EAAE,EAAA,EAAI,OAAQ,EAAA;AAAA,QACzB,OAAS,EAAA;AAAA,UACP,QAAA,EAAU,CAAG,EAAA,OAAO,CAAW,QAAA,EAAA,SAAS,CAAI,CAAA,EAAA,IAAI,CAAI,CAAA,EAAA,IAAI,CAAU,OAAA,EAAA,OAAO,CAAG,EAAA,2BAAA;AAAA,YAC1E,SAAA;AAAA,WACD,CAAA,CAAA;AAAA,UACD,MAAA;AAAA,UACA,MAAA;AAAA,UACA,OAAO,SAAU,CAAA,KAAA;AAAA,UACjB,OAAO,SAAU,CAAA,KAAA;AAAA,SACnB;AAAA,OACF,CAAA;AAEA,MAAI,IAAA,IAAA,CAAA;AACJ,MAAA,IAAI,WAAW,kBAAoB,EAAA;AACjC,QAAA,IAAA,GAAO,IAAK,CAAA,SAAA;AAAA,UACV,MAAM,YAAa,CAAA,eAAA,CAAgB,YAAY,CAAA;AAAA,UAC/C,IAAA;AAAA,UACA,CAAA;AAAA,SACF,CAAA;AAAA,OACK,MAAA;AACL,QAAO,IAAA,GAAA,MAAM,YAAa,CAAA,cAAA,CAAe,YAAY,CAAA,CAAA;AAAA,OACvD;AAEA,MAAI,GAAA,CAAA,SAAA,CAAU,gBAAgB,MAAM,CAAA,CAAA;AACpC,MAAA,GAAA,CAAI,MAAO,CAAA,GAAG,CAAE,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAAA,KAC3B;AAAA,GACF,CAAA;AAEA,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AAEzB,EAAO,OAAA,MAAA,CAAA;AACT,CAAA;AAYA,SAAS,uBAAuB,KAAuC,EAAA;AACrE,EAAA,IAAI,KAAgC,GAAA,KAAA,CAAA,CAAA;AACpC,EAAA,IAAI,KAA4B,GAAA,KAAA,CAAA,CAAA;AAEhC,EACE,IAAA,OAAO,MAAM,KAAU,KAAA,QAAA,IACvBC,mBAAa,QAAS,CAAA,KAAA,CAAM,KAAY,CACxC,EAAA;AACA,IAAA,KAAA,GAAQ,KAAM,CAAA,KAAA,CAAA;AAAA,GAChB;AAEA,EAAI,IAAA,OAAO,KAAM,CAAA,KAAA,KAAU,QAAU,EAAA;AACnC,IAAA,KAAA,GAAQ,KAAM,CAAA,KAAA,CAAA;AAAA,GAChB;AAEA,EAAO,OAAA,EAAE,OAAO,KAAM,EAAA,CAAA;AACxB,CAAA;AAGA,SAAS,2BAA4B,CAAA;AAAA,EACnC,KAAA;AAAA,EACA,KAAA;AACF,CAA8B,EAAA;AAC5B,EAAA,MAAM,QAAkB,EAAC,CAAA;AAEzB,EAAA,IAAI,KAAO,EAAA;AACT,IAAM,KAAA,CAAA,IAAA,CAAK,CAAS,MAAA,EAAA,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,GAC7B;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IAAM,KAAA,CAAA,IAAA,CAAK,CAAS,MAAA,EAAA,KAAK,CAAE,CAAA,CAAA,CAAA;AAAA,GAC7B;AAEA,EAAO,OAAA,KAAA,CAAM,SAAS,CAAI,GAAA,CAAA,CAAA,EAAI,MAAM,IAAK,CAAA,GAAG,CAAC,CAAK,CAAA,GAAA,EAAA,CAAA;AACpD;;;;"}

package/dist/types.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const BADGE_STYLES = [
+  "plastic",
+  "flat",
+  "flat-square",
+  "for-the-badge",
+  "social"
+];
+
+exports.BADGE_STYLES = BADGE_STYLES;
+//# sourceMappingURL=types.cjs.js.map

package/dist/types.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs.js","sources":["../src/types.ts"],"sourcesContent":["/*\n * Copyright 2021 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 */\n\nimport { Config } from '@backstage/config';\nimport { Entity } from '@backstage/catalog-model';\n\n/** @public */\nexport const BADGE_STYLES = [\n  'plastic',\n  'flat',\n  'flat-square',\n  'for-the-badge',\n  'social',\n] as const;\n\n/** @public */\nexport type BadgeStyle = (typeof BADGE_STYLES)[number];\n\n/** @public */\nexport interface Badge {\n  /** Badge message background color. */\n  color?: string;\n  /** Badge description (tooltip text) */\n  description?: string;\n  /** Kind of badge */\n  kind?: 'entity';\n  /**\n   * Badge label (should be a rather static value)\n   * ref. shields spec https://github.com/badges/shields/blob/master/spec/SPECIFICATION.md\n   */\n  label: string;\n  /** Badge label background color */\n  labelColor?: string;\n  /** Custom badge link */\n  link?: string;\n  /** Badge message */\n  message: string;\n  /** Badge style (appearance). One of \"plastic\", \"flat\", \"flat-square\", \"for-the-badge\" and \"social\" */\n  style?: BadgeStyle;\n}\n\n/** @public */\nexport interface BadgeContext {\n  badgeUrl: string;\n  config: Config;\n  entity?: Entity; // for entity badges\n\n  color?: string; // for custom badges\n  style?: BadgeStyle; // for custom badges\n}\n\n/** @public */\nexport interface BadgeFactory {\n  createBadge(context: BadgeContext): Badge;\n}\n\n/** @public */\nexport interface BadgeFactories {\n  [id: string]: BadgeFactory;\n}\n"],"names":[],"mappings":";;AAoBO,MAAM,YAAe,GAAA;AAAA,EAC1B,SAAA;AAAA,EACA,MAAA;AAAA,EACA,aAAA;AAAA,EACA,eAAA;AAAA,EACA,QAAA;AACF;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-badges-backend",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "A Backstage backend plugin that generates README badges for your entities",
   "backstage": {
     "role": "backend-plugin",
@@ -42,13 +42,13 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.24.0",
-    "@backstage/backend-plugin-api": "^0.8.0",
-    "@backstage/catalog-client": "^1.6.6",
-    "@backstage/catalog-model": "^1.6.0",
+    "@backstage/backend-common": "^0.25.0",
+    "@backstage/backend-plugin-api": "^1.0.1",
+    "@backstage/catalog-client": "^1.7.1",
+    "@backstage/catalog-model": "^1.7.0",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-auth-node": "^0.5.0",
+    "@backstage/plugin-auth-node": "^0.5.3",
     "@types/express": "^4.17.6",
     "badge-maker": "^3.3.0",
     "cors": "^2.8.5",
@@ -61,9 +61,9 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.5.0",
-    "@backstage/catalog-client": "^1.6.6",
-    "@backstage/cli": "^0.27.0",
+    "@backstage/backend-test-utils": "^1.0.2",
+    "@backstage/catalog-client": "^1.7.1",
+    "@backstage/cli": "^0.28.0",
     "@types/lodash": "^4.14.151",
     "@types/supertest": "^6.0.0",
     "@types/uuid": "^9.0.0",