@backstage/plugin-events-node 0.4.5-next.2 → 0.4.5-next.3

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @backstage/plugin-events-node
 
+## 0.4.5-next.3
+
+### Patch Changes
+
+- 9816f51: Add raw body information to `RequestDetails`
+  and use the raw body when validating incoming event requests.
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.2-next.2
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
 ## 0.4.5-next.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { LoggerService, RootConfigService, DiscoveryService, AuthService, LifecycleService } from '@backstage/backend-plugin-api';
 
@@ -121,6 +122,8 @@ declare class DefaultEventsService implements EventsService {
 }
 
 /**
+ * View on an incoming request that has to be validated.
+ *
  * @public
  */
 interface RequestDetails {
@@ -132,6 +135,20 @@ interface RequestDetails {
      * Key-value pairs of header names and values. Header names are lower-cased.
      */
     headers: Record<string, string | string[] | undefined>;
+    /**
+     * Raw request details.
+     */
+    raw: {
+        /**
+         * Raw request body (buffer).
+         */
+        body: Buffer;
+        /**
+         * Encoding of the raw request body.
+         * Can be used to decode the raw request body like `raw.body.toString(raw.encoding)`.
+         */
+        encoding: BufferEncoding;
+    };
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-node",
-  "version": "0.4.5-next.2",
+  "version": "0.4.5-next.3",
   "description": "The plugin-events-node module for @backstage/plugin-events-backend",
   "backstage": {
     "role": "node-library",
@@ -36,10 +36,19 @@
   },
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "index": [
+        "dist/index.d.ts"
+      ],
+      "alpha": [
+        "dist/alpha.d.ts"
+      ]
+    }
+  },
   "files": [
     "dist",
-    "config.d.ts",
-    "alpha"
+    "config.d.ts"
   ],
   "scripts": {
     "build": "backstage-cli package build",
@@ -59,8 +68,8 @@
   },
   "devDependencies": {
     "@backstage/backend-common": "^0.25.0",
-    "@backstage/backend-test-utils": "1.1.0-next.2",
-    "@backstage/cli": "0.29.0-next.2",
+    "@backstage/backend-test-utils": "1.1.0-next.3",
+    "@backstage/cli": "0.29.0-next.3",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts"

package/alpha/package.json

@@ -1,6 +0,0 @@
-{
-  "name": "@backstage/plugin-events-node__alpha",
-  "version": "0.4.5-next.2",
-  "main": "../dist/alpha.cjs.js",
-  "types": "../dist/alpha.d.ts"
-}