@backstage/plugin-events-backend-module-github 0.1.4-next.2 → 0.1.5-next.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @backstage/plugin-events-backend-module-github
 
+## 0.1.5-next.0
+
+### Patch Changes
+
+- 928a12a9b3: Internal refactor of `/alpha` exports.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.4.1-next.0
+  - @backstage/plugin-events-node@0.2.4-next.0
+  - @backstage/config@1.0.6
+
+## 0.1.4
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.4.0
+  - @backstage/plugin-events-node@0.2.3
+  - @backstage/config@1.0.6
+
 ## 0.1.4-next.2
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -0,0 +1,71 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var alpha = require('@backstage/plugin-events-node/alpha');
+var pluginEventsNode = require('@backstage/plugin-events-node');
+var webhooksMethods = require('@octokit/webhooks-methods');
+
+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: alpha.eventsExtensionPoint
+      },
+      async init({ events }) {
+        const eventRouter = new GithubEventRouter();
+        events.addPublishers(eventRouter);
+        events.addSubscribers(eventRouter);
+      }
+    });
+  }
+});
+
+function createGithubSignatureValidator(config) {
+  const secret = config.getString("events.modules.github.webhookSecret");
+  return async (request, context) => {
+    const signature = request.headers["x-hub-signature-256"];
+    if (!signature || !await webhooksMethods.verify(secret, JSON.stringify(request.body), signature)) {
+      context.reject({
+        status: 403,
+        payload: { message: "invalid signature" }
+      });
+    }
+  };
+}
+
+const githubWebhookEventsModule = backendPluginApi.createBackendModule({
+  pluginId: "events",
+  moduleId: "githubWebhook",
+  register(env) {
+    env.registerInit({
+      deps: {
+        config: backendPluginApi.coreServices.config,
+        events: alpha.eventsExtensionPoint
+      },
+      async init({ config, events }) {
+        events.addHttpPostIngress({
+          topic: "github",
+          validator: createGithubSignatureValidator(config)
+        });
+      }
+    });
+  }
+});
+
+exports.githubEventRouterEventsModule = githubEventRouterEventsModule;
+exports.githubWebhookEventsModule = githubWebhookEventsModule;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.cjs.js","sources":["../src/router/GithubEventRouter.ts","../src/service/GithubEventRouterEventsModule.ts","../src/http/createGithubSignatureValidator.ts","../src/service/GithubWebhookEventsModule.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/alpha';\nimport { GithubEventRouter } from '../router/GithubEventRouter';\n\n/**\n * Module for the events-backend plugin, adding an event router for GitHub.\n *\n * Registers the `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","/*\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 { Config } from '@backstage/config';\nimport {\n  RequestDetails,\n  RequestValidationContext,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport { verify } from '@octokit/webhooks-methods';\n\n/**\n * Validates that the request received is the expected GitHub request\n * using the signature received with the `x-hub-signature-256` header\n * which is based on a secret token configured at GitHub and here.\n *\n * See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks\n * for more details.\n *\n * @param config - root config\n * @public\n */\nexport function createGithubSignatureValidator(\n  config: Config,\n): RequestValidator {\n  const secret = config.getString('events.modules.github.webhookSecret');\n\n  return async (\n    request: RequestDetails,\n    context: RequestValidationContext,\n  ): Promise<void> => {\n    const signature = request.headers['x-hub-signature-256'] as\n      | string\n      | undefined;\n\n    if (\n      !signature ||\n      !(await verify(secret, JSON.stringify(request.body), signature))\n    ) {\n      context.reject({\n        status: 403,\n        payload: { message: 'invalid signature' },\n      });\n    }\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 {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { eventsExtensionPoint } from '@backstage/plugin-events-node/alpha';\nimport { createGithubSignatureValidator } from '../http/createGithubSignatureValidator';\n\n/**\n * Module for the events-backend plugin,\n * registering an HTTP POST ingress with request validator\n * which verifies the webhook signature based on a secret.\n *\n * @alpha\n */\nexport const githubWebhookEventsModule = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'githubWebhook',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.config,\n        events: eventsExtensionPoint,\n      },\n      async init({ config, events }) {\n        events.addHttpPostIngress({\n          topic: 'github',\n          validator: createGithubSignatureValidator(config),\n        });\n      },\n    });\n  },\n});\n"],"names":["SubTopicEventRouter","createBackendModule","eventsExtensionPoint","verify","coreServices"],"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,0BAAA;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;;ACRM,SAAS,+BACd,MACkB,EAAA;AAClB,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,SAAA,CAAU,qCAAqC,CAAA,CAAA;AAErE,EAAO,OAAA,OACL,SACA,OACkB,KAAA;AAClB,IAAM,MAAA,SAAA,GAAY,OAAQ,CAAA,OAAA,CAAQ,qBAAqB,CAAA,CAAA;AAIvD,IAAA,IACE,CAAC,SAAA,IACD,CAAE,MAAMC,sBAAO,CAAA,MAAA,EAAQ,IAAK,CAAA,SAAA,CAAU,OAAQ,CAAA,IAAI,CAAG,EAAA,SAAS,CAC9D,EAAA;AACA,MAAA,OAAA,CAAQ,MAAO,CAAA;AAAA,QACb,MAAQ,EAAA,GAAA;AAAA,QACR,OAAA,EAAS,EAAE,OAAA,EAAS,mBAAoB,EAAA;AAAA,OACzC,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;AC5BO,MAAM,4BAA4BF,oCAAoB,CAAA;AAAA,EAC3D,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,eAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQG,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAQ,EAAAF,0BAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC7B,QAAA,MAAA,CAAO,kBAAmB,CAAA;AAAA,UACxB,KAAO,EAAA,QAAA;AAAA,UACP,SAAA,EAAW,+BAA+B,MAAM,CAAA;AAAA,SACjD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,21 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * Module for the events-backend plugin, adding an event router for GitHub.
+ *
+ * Registers the `GithubEventRouter`.
+ *
+ * @alpha
+ */
+declare const githubEventRouterEventsModule: () => _backstage_backend_plugin_api.BackendFeature;
+
+/**
+ * Module for the events-backend plugin,
+ * registering an HTTP POST ingress with request validator
+ * which verifies the webhook signature based on a secret.
+ *
+ * @alpha
+ */
+declare const githubWebhookEventsModule: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { githubEventRouterEventsModule, githubWebhookEventsModule };

package/dist/index.cjs.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var webhooksMethods = require('@octokit/webhooks-methods');
 var pluginEventsNode = require('@backstage/plugin-events-node');
-var backendPluginApi = require('@backstage/backend-plugin-api');
 
 function createGithubSignatureValidator(config) {
   const secret = config.getString("events.modules.github.webhookSecret");
@@ -29,44 +28,6 @@ class GithubEventRouter extends pluginEventsNode.SubTopicEventRouter {
   }
 }
 
-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);
-      }
-    });
-  }
-});
-
-const githubWebhookEventsModule = backendPluginApi.createBackendModule({
-  pluginId: "events",
-  moduleId: "githubWebhook",
-  register(env) {
-    env.registerInit({
-      deps: {
-        config: backendPluginApi.coreServices.config,
-        events: pluginEventsNode.eventsExtensionPoint
-      },
-      async init({ config, events }) {
-        events.addHttpPostIngress({
-          topic: "github",
-          validator: createGithubSignatureValidator(config)
-        });
-      }
-    });
-  }
-});
-
 exports.GithubEventRouter = GithubEventRouter;
 exports.createGithubSignatureValidator = createGithubSignatureValidator;
-exports.githubEventRouterEventsModule = githubEventRouterEventsModule;
-exports.githubWebhookEventsModule = githubWebhookEventsModule;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/http/createGithubSignatureValidator.ts","../src/router/GithubEventRouter.ts","../src/service/GithubEventRouterEventsModule.ts","../src/service/GithubWebhookEventsModule.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 { Config } from '@backstage/config';\nimport {\n  RequestDetails,\n  RequestValidationContext,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport { verify } from '@octokit/webhooks-methods';\n\n/**\n * Validates that the request received is the expected GitHub request\n * using the signature received with the `x-hub-signature-256` header\n * which is based on a secret token configured at GitHub and here.\n *\n * See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks\n * for more details.\n *\n * @param config - root config\n * @public\n */\nexport function createGithubSignatureValidator(\n  config: Config,\n): RequestValidator {\n  const secret = config.getString('events.modules.github.webhookSecret');\n\n  return async (\n    request: RequestDetails,\n    context: RequestValidationContext,\n  ): Promise<void> => {\n    const signature = request.headers['x-hub-signature-256'] as\n      | string\n      | undefined;\n\n    if (\n      !signature ||\n      !(await verify(secret, JSON.stringify(request.body), signature))\n    ) {\n      context.reject({\n        status: 403,\n        payload: { message: 'invalid signature' },\n      });\n    }\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 {\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","/*\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  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { eventsExtensionPoint } from '@backstage/plugin-events-node';\nimport { createGithubSignatureValidator } from '../http/createGithubSignatureValidator';\n\n/**\n * Module for the events-backend plugin,\n * registering an HTTP POST ingress with request validator\n * which verifies the webhook signature based on a secret.\n *\n * @alpha\n */\nexport const githubWebhookEventsModule = createBackendModule({\n  pluginId: 'events',\n  moduleId: 'githubWebhook',\n  register(env) {\n    env.registerInit({\n      deps: {\n        config: coreServices.config,\n        events: eventsExtensionPoint,\n      },\n      async init({ config, events }) {\n        events.addHttpPostIngress({\n          topic: 'github',\n          validator: createGithubSignatureValidator(config),\n        });\n      },\n    });\n  },\n});\n"],"names":["verify","SubTopicEventRouter","createBackendModule","eventsExtensionPoint","coreServices"],"mappings":";;;;;;;;AAmCO,SAAS,+BACd,MACkB,EAAA;AAClB,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,SAAA,CAAU,qCAAqC,CAAA,CAAA;AAErE,EAAO,OAAA,OACL,SACA,OACkB,KAAA;AAClB,IAAM,MAAA,SAAA,GAAY,OAAQ,CAAA,OAAA,CAAQ,qBAAqB,CAAA,CAAA;AAIvD,IAAA,IACE,CAAC,SAAA,IACD,CAAE,MAAMA,sBAAO,CAAA,MAAA,EAAQ,IAAK,CAAA,SAAA,CAAU,OAAQ,CAAA,IAAI,CAAG,EAAA,SAAS,CAC9D,EAAA;AACA,MAAA,OAAA,CAAQ,MAAO,CAAA;AAAA,QACb,MAAQ,EAAA,GAAA;AAAA,QACR,OAAA,EAAS,EAAE,OAAA,EAAS,mBAAoB,EAAA;AAAA,OACzC,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;AC9BO,MAAM,0BAA0BC,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;;ACbM,MAAM,4BAA4BD,oCAAoB,CAAA;AAAA,EAC3D,QAAU,EAAA,QAAA;AAAA,EACV,QAAU,EAAA,eAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQE,6BAAa,CAAA,MAAA;AAAA,QACrB,MAAQ,EAAAD,qCAAA;AAAA,OACV;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,MAAA,EAAQ,QAAU,EAAA;AAC7B,QAAA,MAAA,CAAO,kBAAmB,CAAA;AAAA,UACxB,KAAO,EAAA,QAAA;AAAA,UACP,SAAA,EAAW,+BAA+B,MAAM,CAAA;AAAA,SACjD,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/http/createGithubSignatureValidator.ts","../src/router/GithubEventRouter.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 { Config } from '@backstage/config';\nimport {\n  RequestDetails,\n  RequestValidationContext,\n  RequestValidator,\n} from '@backstage/plugin-events-node';\nimport { verify } from '@octokit/webhooks-methods';\n\n/**\n * Validates that the request received is the expected GitHub request\n * using the signature received with the `x-hub-signature-256` header\n * which is based on a secret token configured at GitHub and here.\n *\n * See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks\n * for more details.\n *\n * @param config - root config\n * @public\n */\nexport function createGithubSignatureValidator(\n  config: Config,\n): RequestValidator {\n  const secret = config.getString('events.modules.github.webhookSecret');\n\n  return async (\n    request: RequestDetails,\n    context: RequestValidationContext,\n  ): Promise<void> => {\n    const signature = request.headers['x-hub-signature-256'] as\n      | string\n      | undefined;\n\n    if (\n      !signature ||\n      !(await verify(secret, JSON.stringify(request.body), signature))\n    ) {\n      context.reject({\n        status: 403,\n        payload: { message: 'invalid signature' },\n      });\n    }\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 {\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"],"names":["verify","SubTopicEventRouter"],"mappings":";;;;;;;AAmCO,SAAS,+BACd,MACkB,EAAA;AAClB,EAAM,MAAA,MAAA,GAAS,MAAO,CAAA,SAAA,CAAU,qCAAqC,CAAA,CAAA;AAErE,EAAO,OAAA,OACL,SACA,OACkB,KAAA;AAClB,IAAM,MAAA,SAAA,GAAY,OAAQ,CAAA,OAAA,CAAQ,qBAAqB,CAAA,CAAA;AAIvD,IAAA,IACE,CAAC,SAAA,IACD,CAAE,MAAMA,sBAAO,CAAA,MAAA,EAAQ,IAAK,CAAA,SAAA,CAAU,OAAQ,CAAA,IAAI,CAAG,EAAA,SAAS,CAC9D,EAAA;AACA,MAAA,OAAA,CAAQ,MAAO,CAAA;AAAA,QACb,MAAQ,EAAA,GAAA;AAAA,QACR,OAAA,EAAS,EAAE,OAAA,EAAS,mBAAoB,EAAA;AAAA,OACzC,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;AC9BO,MAAM,0BAA0BC,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;;;;;"}

package/dist/index.d.ts

@@ -1,15 +1,5 @@
-/**
- * The module `github` for the Backstage backend plugin "events-backend"
- * adding an event router and signature validator for GitHub.
- *
- * @packageDocumentation
- */
-
-import { BackendFeature } from '@backstage/backend-plugin-api';
 import { Config } from '@backstage/config';
-import { EventParams } from '@backstage/plugin-events-node';
-import { RequestValidator } from '@backstage/plugin-events-node';
-import { SubTopicEventRouter } from '@backstage/plugin-events-node';
+import { RequestValidator, SubTopicEventRouter, EventParams } from '@backstage/plugin-events-node';
 
 /**
  * Validates that the request received is the expected GitHub request
@@ -22,7 +12,7 @@ import { SubTopicEventRouter } from '@backstage/plugin-events-node';
  * @param config - root config
  * @public
  */
-export declare function createGithubSignatureValidator(config: Config): RequestValidator;
+declare function createGithubSignatureValidator(config: Config): RequestValidator;
 
 /**
  * Subscribes to the generic `github` topic
@@ -31,13 +21,9 @@ export declare function createGithubSignatureValidator(config: Config): RequestV
  *
  * @public
  */
-export declare class GithubEventRouter extends SubTopicEventRouter {
+declare class GithubEventRouter extends SubTopicEventRouter {
     constructor();
     protected determineSubTopic(params: EventParams): string | undefined;
 }
 
-/* Excluded from this release type: githubEventRouterEventsModule */
-
-/* Excluded from this release type: githubWebhookEventsModule */
-
-export { }
+export { GithubEventRouter, createGithubSignatureValidator };

package/package.json

@@ -1,21 +1,31 @@
 {
   "name": "@backstage/plugin-events-backend-module-github",
-  "version": "0.1.4-next.2",
-  "main": "dist/index.cjs.js",
-  "types": "dist/index.d.ts",
+  "version": "0.1.5-next.0",
+  "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"
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./alpha": {
+      "require": "./dist/alpha.cjs.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.cjs.js"
+    },
+    "./package.json": "./package.json"
   },
   "backstage": {
     "role": "backend-plugin-module"
   },
   "scripts": {
     "start": "backstage-cli package start",
-    "build": "backstage-cli package build --experimental-type-build",
+    "build": "backstage-cli package build",
     "lint": "backstage-cli package lint",
     "test": "backstage-cli package test",
     "clean": "backstage-cli package clean",
@@ -23,22 +33,22 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.4.0-next.2",
+    "@backstage/backend-plugin-api": "^0.4.1-next.0",
     "@backstage/config": "^1.0.6",
-    "@backstage/plugin-events-node": "^0.2.3-next.2",
+    "@backstage/plugin-events-node": "^0.2.4-next.0",
     "@octokit/webhooks-methods": "^3.0.0",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.34-next.2",
-    "@backstage/cli": "^0.22.2-next.1",
-    "@backstage/plugin-events-backend-test-utils": "^0.1.4-next.2",
+    "@backstage/backend-test-utils": "^0.1.35-next.0",
+    "@backstage/cli": "^0.22.4-next.0",
+    "@backstage/plugin-events-backend-test-utils": "^0.1.5-next.0",
     "supertest": "^6.1.3"
   },
   "files": [
-    "alpha",
     "config.d.ts",
-    "dist"
+    "dist",
+    "alpha"
   ],
   "configSchema": "config.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -1,57 +0,0 @@
-/**
- * The module `github` for the Backstage backend plugin "events-backend"
- * adding an event router and signature validator for GitHub.
- *
- * @packageDocumentation
- */
-
-import { BackendFeature } from '@backstage/backend-plugin-api';
-import { Config } from '@backstage/config';
-import { EventParams } from '@backstage/plugin-events-node';
-import { RequestValidator } from '@backstage/plugin-events-node';
-import { SubTopicEventRouter } from '@backstage/plugin-events-node';
-
-/**
- * Validates that the request received is the expected GitHub request
- * using the signature received with the `x-hub-signature-256` header
- * which is based on a secret token configured at GitHub and here.
- *
- * See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks
- * for more details.
- *
- * @param config - root config
- * @public
- */
-export declare function createGithubSignatureValidator(config: Config): RequestValidator;
-
-/**
- * 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: () => BackendFeature;
-
-/**
- * Module for the events-backend plugin,
- * registering an HTTP POST ingress with request validator
- * which verifies the webhook signature based on a secret.
- *
- * @alpha
- */
-export declare const githubWebhookEventsModule: () => BackendFeature;
-
-export { }

package/dist/index.beta.d.ts

@@ -1,43 +0,0 @@
-/**
- * The module `github` for the Backstage backend plugin "events-backend"
- * adding an event router and signature validator for GitHub.
- *
- * @packageDocumentation
- */
-
-import { BackendFeature } from '@backstage/backend-plugin-api';
-import { Config } from '@backstage/config';
-import { EventParams } from '@backstage/plugin-events-node';
-import { RequestValidator } from '@backstage/plugin-events-node';
-import { SubTopicEventRouter } from '@backstage/plugin-events-node';
-
-/**
- * Validates that the request received is the expected GitHub request
- * using the signature received with the `x-hub-signature-256` header
- * which is based on a secret token configured at GitHub and here.
- *
- * See https://docs.github.com/en/developers/webhooks-and-events/webhooks/securing-your-webhooks
- * for more details.
- *
- * @param config - root config
- * @public
- */
-export declare function createGithubSignatureValidator(config: Config): RequestValidator;
-
-/**
- * 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 */
-
-/* Excluded from this release type: githubWebhookEventsModule */
-
-export { }