@backstage/plugin-events-backend-module-github 0.0.0-nightly-20221115024001

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# @backstage/plugin-events-backend-module-github
+
+## 0.0.0-nightly-20221115024001
+
+### Minor Changes
+
+- b3a4edb885: Adds a new module `github` to plugin-events-backend.
+
+  The module adds a new event router `GithubEventRouter`.
+
+  The event router will re-publish events received at topic `github`
+  under a more specific topic depending on their `x-github-event` value
+  (e.g., `github.push`).
+
+  Please find more information at
+  https://github.com/backstage/backstage/tree/master/plugins/events-backend-module-github/README.md.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-events-node@0.0.0-nightly-20221115024001
+  - @backstage/backend-plugin-api@0.0.0-nightly-20221115024001

package/README.md

@@ -0,0 +1,43 @@
+# events-backend-module-github
+
+Welcome to the `events-backend-module-github` backend plugin!
+
+This plugin is a module for the `events-backend` backend plugin
+and extends it with an `GithubEventRouter`.
+
+The event router will subscribe to the topic `github`
+and route the events to more concrete topics based on the value
+of the provided `x-github-event` metadata field.
+
+Examples:
+
+| `x-github-event` | topic                 |
+| ---------------- | --------------------- |
+| `pull_request`   | `github.pull_request` |
+| `push`           | `github.push`         |
+| `repository`     | `github.repository`   |
+
+Please find all possible webhook event types at the
+[official documentation](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads).
+
+## 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-github
+```
+
+Add the event router to the `EventsBackend`:
+
+```diff
++const githubEventRouter = new GithubEventRouter();
+
+ EventsBackend
++  .addPublishers(githubEventRouter)
++  .addSubscribers(githubEventRouter);
+// [...]
+```

package/alpha/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-events-backend-module-github",
+  "version": "0.0.0-nightly-20221115024001",
+  "main": "../dist/index.cjs.js",
+  "types": "../dist/index.alpha.d.ts"
+}

package/dist/index.alpha.d.ts

@@ -0,0 +1,33 @@
+/**
+ * The module `github` for the Backstage backend plugin "events-backend"
+ * adding an event router for GitHub.
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { EventParams } from '@backstage/plugin-events-node';
+import { SubTopicEventRouter } from '@backstage/plugin-events-node';
+
+/**
+ * Subscribes to the generic `github` topic
+ * and publishes the events under the more concrete sub-topic
+ * depending on the `x-github-event` provided.
+ *
+ * @public
+ */
+export declare class GithubEventRouter extends SubTopicEventRouter {
+    constructor();
+    protected determineSubTopic(params: EventParams): string | undefined;
+}
+
+/**
+ * Module for the events-backend plugin, adding an event router for GitHub.
+ *
+ * Registers the {@link GithubEventRouter}.
+ *
+ * @alpha
+ */
+export declare const githubEventRouterEventsModule: (options?: undefined) => BackendFeature;
+
+export { }

package/dist/index.beta.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The module `github` for the Backstage backend plugin "events-backend"
+ * adding an event router for GitHub.
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { EventParams } from '@backstage/plugin-events-node';
+import { SubTopicEventRouter } from '@backstage/plugin-events-node';
+
+/**
+ * Subscribes to the generic `github` topic
+ * and publishes the events under the more concrete sub-topic
+ * depending on the `x-github-event` provided.
+ *
+ * @public
+ */
+export declare class GithubEventRouter extends SubTopicEventRouter {
+    constructor();
+    protected determineSubTopic(params: EventParams): string | undefined;
+}
+
+/* Excluded from this release type: githubEventRouterEventsModule */
+
+export { }

package/dist/index.cjs.js

@@ -0,0 +1,37 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var pluginEventsNode = require('@backstage/plugin-events-node');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+class GithubEventRouter extends pluginEventsNode.SubTopicEventRouter {
+  constructor() {
+    super("github");
+  }
+  determineSubTopic(params) {
+    var _a;
+    return (_a = params.metadata) == null ? void 0 : _a["x-github-event"];
+  }
+}
+
+const githubEventRouterEventsModule = backendPluginApi.createBackendModule({
+  pluginId: "events",
+  moduleId: "githubEventRouter",
+  register(env) {
+    env.registerInit({
+      deps: {
+        events: pluginEventsNode.eventsExtensionPoint
+      },
+      async init({ events }) {
+        const eventRouter = new GithubEventRouter();
+        events.addPublishers(eventRouter);
+        events.addSubscribers(eventRouter);
+      }
+    });
+  }
+});
+
+exports.GithubEventRouter = GithubEventRouter;
+exports.githubEventRouterEventsModule = githubEventRouterEventsModule;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/router/GithubEventRouter.ts","../src/service/GithubEventRouterEventsModule.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  SubTopicEventRouter,\n} from '@backstage/plugin-events-node';\n\n/**\n * Subscribes to the generic `github` topic\n * and publishes the events under the more concrete sub-topic\n * depending on the `x-github-event` provided.\n *\n * @public\n */\nexport class GithubEventRouter extends SubTopicEventRouter {\n  constructor() {\n    super('github');\n  }\n\n  protected determineSubTopic(params: EventParams): string | undefined {\n    return params.metadata?.['x-github-event'] as string | undefined;\n  }\n}\n","/*\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 { eventsExtensionPoint } from '@backstage/plugin-events-node';\nimport { GithubEventRouter } from '../router/GithubEventRouter';\n\n/**\n * Module for the events-backend plugin, adding an event router for GitHub.\n *\n * Registers the {@link GithubEventRouter}.\n *\n * @alpha\n */\nexport const githubEventRouterEventsModule = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'githubEventRouter',\n  register(env) {\n    env.registerInit({\n      deps: {\n        events: eventsExtensionPoint,\n      },\n      async init({ events }) {\n        const eventRouter = new GithubEventRouter();\n\n        events.addPublishers(eventRouter);\n        events.addSubscribers(eventRouter);\n      },\n    });\n  },\n});\n"],"names":["SubTopicEventRouter","createBackendModule","eventsExtensionPoint"],"mappings":";;;;;;;AA4BO,MAAM,0BAA0BA,oCAAoB,CAAA;AAAA,EACzD,WAAc,GAAA;AACZ,IAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,GAChB;AAAA,EAEU,kBAAkB,MAAyC,EAAA;AAjCvE,IAAA,IAAA,EAAA,CAAA;AAkCI,IAAO,OAAA,CAAA,EAAA,GAAA,MAAA,CAAO,aAAP,IAAkB,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,gBAAA,CAAA,CAAA;AAAA,GAC3B;AACF;;ACTO,MAAM,gCAAgCC,oCAAoB,CAAA;AAAA,EAC/D,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,mBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,MAAQ,EAAAC,qCAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAU,EAAA;AACrB,QAAM,MAAA,WAAA,GAAc,IAAI,iBAAkB,EAAA,CAAA;AAE1C,QAAA,MAAA,CAAO,cAAc,WAAW,CAAA,CAAA;AAChC,QAAA,MAAA,CAAO,eAAe,WAAW,CAAA,CAAA;AAAA,OACnC;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The module `github` for the Backstage backend plugin "events-backend"
+ * adding an event router for GitHub.
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { EventParams } from '@backstage/plugin-events-node';
+import { SubTopicEventRouter } from '@backstage/plugin-events-node';
+
+/**
+ * Subscribes to the generic `github` topic
+ * and publishes the events under the more concrete sub-topic
+ * depending on the `x-github-event` provided.
+ *
+ * @public
+ */
+export declare class GithubEventRouter extends SubTopicEventRouter {
+    constructor();
+    protected determineSubTopic(params: EventParams): string | undefined;
+}
+
+/* Excluded from this release type: githubEventRouterEventsModule */
+
+export { }

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@backstage/plugin-events-backend-module-github",
+  "version": "0.0.0-nightly-20221115024001",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "alphaTypes": "dist/index.alpha.d.ts",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build --experimental-type-build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20221115024001",
+    "@backstage/plugin-events-node": "^0.0.0-nightly-20221115024001",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20221115024001",
+    "@backstage/cli": "^0.0.0-nightly-20221115024001",
+    "@backstage/plugin-events-backend-test-utils": "^0.0.0-nightly-20221115024001",
+    "supertest": "^6.1.3"
+  },
+  "files": [
+    "alpha",
+    "dist"
+  ]
+}