@backstage/plugin-events-backend-module-bitbucket-server 0.1.0-next.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @backstage/plugin-events-backend-module-bitbucket-server
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- 7b3ed9b: Added the ability for the plugin to receive events coming from Bitbucket Server push webhooks. It then performs a delta mutation on the catalog.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/plugin-events-node@0.4.9

package/README.md

@@ -0,0 +1,36 @@
+# events-backend-module-bitbucket-server
+
+Welcome to the `events-backend-module-bitbucket-server` backend plugin!
+
+This package is a module for the `events-backend` backend plugin
+and extends the event system with an `BitbucketServerEventRouter`.
+
+The event router will subscribe to the topic `bitbucketServer`
+and route the events to more concrete topics based on the value
+of the provided `x-event-key` metadata field.
+
+Examples:
+
+| x-event-key         | topic                               |
+| ------------------- | ----------------------------------- |
+| `repo:refs_changed` | `bitbucketServer.repo:refs_changed` |
+| `repo:modified`     | `bitbucketServer.repo:modified`     |
+
+Please find all possible webhook event types at the
+[official documentation](https://confluence.atlassian.com/bitbucketserver/event-payload-938025882.html).
+
+## Installation
+
+Install the [`events-backend` plugin](../events-backend/README.md).
+
+Install this module:
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-events-backend-module-bitbucket-server
+```
+
+```ts
+// packages/backend/src/index.ts
+backend.add(import('@backstage/plugin-events-backend-module-bitbucket-server'));
+```

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var eventsModuleBitbucketServerEventRouter = require('./service/eventsModuleBitbucketServerEventRouter.cjs.js');
+
+
+
+exports.default = eventsModuleBitbucketServerEventRouter.eventsModuleBitbucketServerEventRouter;
+//# 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,12 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * Module for the events-backend plugin, adding an event router for Bitbucket Server.
+ *
+ * Registers the `BitbucketServerEventRouter`.
+ *
+ * @public
+ */
+declare const eventsModuleBitbucketServerEventRouter: _backstage_backend_plugin_api.BackendFeature;
+
+export { eventsModuleBitbucketServerEventRouter as default };

package/dist/router/BitbucketServerEventRouter.cjs.js

@@ -0,0 +1,21 @@
+'use strict';
+
+var pluginEventsNode = require('@backstage/plugin-events-node');
+
+class BitbucketServerEventRouter extends pluginEventsNode.SubTopicEventRouter {
+  constructor(options) {
+    super({
+      events: options.events,
+      topic: "bitbucketServer"
+    });
+  }
+  getSubscriberId() {
+    return "BitbucketServerEventRouter";
+  }
+  determineSubTopic(params) {
+    return params.metadata?.["x-event-key"];
+  }
+}
+
+exports.BitbucketServerEventRouter = BitbucketServerEventRouter;
+//# sourceMappingURL=BitbucketServerEventRouter.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BitbucketServerEventRouter.cjs.js","sources":["../../src/router/BitbucketServerEventRouter.ts"],"sourcesContent":["/*\n * Copyright 2022 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  EventParams,\n  EventsService,\n  SubTopicEventRouter,\n} from '@backstage/plugin-events-node';\n\n/**\n * Subscribes to the generic `bitbucketServer` topic\n * and publishes the events under the more concrete sub-topic\n * depending on the `x-event-key` provided.\n *\n * @public\n */\nexport class BitbucketServerEventRouter extends SubTopicEventRouter {\n  constructor(options: { events: EventsService }) {\n    super({\n      events: options.events,\n      topic: 'bitbucketServer',\n    });\n  }\n\n  protected getSubscriberId(): string {\n    return 'BitbucketServerEventRouter';\n  }\n\n  protected determineSubTopic(params: EventParams): string | undefined {\n    return params.metadata?.['x-event-key'] as string | undefined;\n  }\n}\n"],"names":["SubTopicEventRouter"],"mappings":";;;;AA6BO,MAAM,mCAAmCA,oCAAoB,CAAA;AAAA,EAClE,YAAY,OAAoC,EAAA;AAC9C,IAAM,KAAA,CAAA;AAAA,MACJ,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,KAAO,EAAA;AAAA,KACR,CAAA;AAAA;AACH,EAEU,eAA0B,GAAA;AAClC,IAAO,OAAA,4BAAA;AAAA;AACT,EAEU,kBAAkB,MAAyC,EAAA;AACnE,IAAO,OAAA,MAAA,CAAO,WAAW,aAAa,CAAA;AAAA;AAE1C;;;;"}

package/dist/service/eventsModuleBitbucketServerEventRouter.cjs.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginEventsNode = require('@backstage/plugin-events-node');
+var BitbucketServerEventRouter = require('../router/BitbucketServerEventRouter.cjs.js');
+
+const eventsModuleBitbucketServerEventRouter = backendPluginApi.createBackendModule({
+  pluginId: "events",
+  moduleId: "bitbucket-server-event-router",
+  register(env) {
+    env.registerInit({
+      deps: {
+        events: pluginEventsNode.eventsServiceRef
+      },
+      async init({ events }) {
+        const eventRouter = new BitbucketServerEventRouter.BitbucketServerEventRouter({
+          events
+        });
+        await eventRouter.subscribe();
+      }
+    });
+  }
+});
+
+exports.eventsModuleBitbucketServerEventRouter = eventsModuleBitbucketServerEventRouter;
+//# sourceMappingURL=eventsModuleBitbucketServerEventRouter.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eventsModuleBitbucketServerEventRouter.cjs.js","sources":["../../src/service/eventsModuleBitbucketServerEventRouter.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { createBackendModule } from '@backstage/backend-plugin-api';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\nimport { BitbucketServerEventRouter } from '../router/BitbucketServerEventRouter';\n\n/**\n * Module for the events-backend plugin, adding an event router for Bitbucket Server.\n *\n * Registers the `BitbucketServerEventRouter`.\n *\n * @public\n */\nexport const eventsModuleBitbucketServerEventRouter = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'bitbucket-server-event-router',\n  register(env) {\n    env.registerInit({\n      deps: {\n        events: eventsServiceRef,\n      },\n      async init({ events }) {\n        const eventRouter = new BitbucketServerEventRouter({\n          events,\n        });\n        await eventRouter.subscribe();\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","eventsServiceRef","BitbucketServerEventRouter"],"mappings":";;;;;;AA2BO,MAAM,yCAAyCA,oCAAoB,CAAA;AAAA,EACxE,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,+BAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAAC;AAAA,OACV;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAU,EAAA;AACrB,QAAM,MAAA,WAAA,GAAc,IAAIC,qDAA2B,CAAA;AAAA,UACjD;AAAA,SACD,CAAA;AACD,QAAA,MAAM,YAAY,SAAU,EAAA;AAAA;AAC9B,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@backstage/plugin-events-backend-module-bitbucket-server",
+  "version": "0.1.0-next.0",
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "events",
+    "pluginPackage": "@backstage/plugin-events-backend",
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/events-backend-module-bitbucket-server"
+  },
+  "license": "Apache-2.0",
+  "exports": {
+    ".": {
+      "backstage": "@backstage/BackendFeature",
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "start": "backstage-cli package start",
+    "test": "backstage-cli package test"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "1.2.1",
+    "@backstage/plugin-events-node": "0.4.9"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "1.3.2-next.1",
+    "@backstage/cli": "0.32.0-next.1",
+    "@backstage/plugin-events-backend-test-utils": "0.1.42"
+  }
+}