@backstage/plugin-events-node 0.4.9-next.1 → 0.4.9-next.2

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @backstage/plugin-events-node
 
+## 0.4.9-next.2
+
+### Patch Changes
+
+- b95aa77: add `addHttpPostBodyParser` to events extension to allow body parse customization. This feature will enhance flexibility in handling HTTP POST requests in event-related operations.
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.2.1-next.1
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+
 ## 0.4.9-next.1
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -1,5 +1,5 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { EventBroker, EventPublisher, EventSubscriber, HttpPostIngressOptions } from '@backstage/plugin-events-node';
+import { EventBroker, EventPublisher, EventSubscriber, HttpPostIngressOptions, HttpBodyParserOptions } from '@backstage/plugin-events-node';
 
 /**
  * @alpha
@@ -18,6 +18,7 @@ interface EventsExtensionPoint {
      */
     addSubscribers(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
     addHttpPostIngress(options: HttpPostIngressOptions): void;
+    addHttpPostBodyParser(options: HttpBodyParserOptions): void;
 }
 /**
  * @alpha

package/dist/extensions.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  EventBroker,\n  EventPublisher,\n  EventSubscriber,\n  HttpPostIngressOptions,\n} from '@backstage/plugin-events-node';\n\n/**\n * @alpha\n */\nexport interface EventsExtensionPoint {\n  /**\n   * @deprecated use `eventsServiceRef` and `eventsServiceFactory` instead\n   */\n  setEventBroker(eventBroker: EventBroker): void;\n\n  /**\n   * @deprecated use `EventsService.publish` instead\n   */\n  addPublishers(\n    ...publishers: Array<EventPublisher | Array<EventPublisher>>\n  ): void;\n\n  /**\n   * @deprecated use `EventsService.subscribe` instead\n   */\n  addSubscribers(\n    ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n  ): void;\n\n  addHttpPostIngress(options: HttpPostIngressOptions): void;\n}\n\n/**\n * @alpha\n */\nexport const eventsExtensionPoint = createExtensionPoint<EventsExtensionPoint>({\n  id: 'events',\n});\n"],"names":["createExtensionPoint"],"mappings":";;;;AAqDO,MAAM,uBAAuBA,qCAA2C,CAAA;AAAA,EAC7E,EAAI,EAAA;AACN,CAAC;;;;"}
+{"version":3,"file":"extensions.cjs.js","sources":["../src/extensions.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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  EventBroker,\n  EventPublisher,\n  EventSubscriber,\n  HttpBodyParserOptions,\n  HttpPostIngressOptions,\n} from '@backstage/plugin-events-node';\n\n/**\n * @alpha\n */\nexport interface EventsExtensionPoint {\n  /**\n   * @deprecated use `eventsServiceRef` and `eventsServiceFactory` instead\n   */\n  setEventBroker(eventBroker: EventBroker): void;\n\n  /**\n   * @deprecated use `EventsService.publish` instead\n   */\n  addPublishers(\n    ...publishers: Array<EventPublisher | Array<EventPublisher>>\n  ): void;\n\n  /**\n   * @deprecated use `EventsService.subscribe` instead\n   */\n  addSubscribers(\n    ...subscribers: Array<EventSubscriber | Array<EventSubscriber>>\n  ): void;\n\n  addHttpPostIngress(options: HttpPostIngressOptions): void;\n\n  addHttpPostBodyParser(options: HttpBodyParserOptions): void;\n}\n\n/**\n * @alpha\n */\nexport const eventsExtensionPoint = createExtensionPoint<EventsExtensionPoint>({\n  id: 'events',\n});\n"],"names":["createExtensionPoint"],"mappings":";;;;AAwDO,MAAM,uBAAuBA,qCAA2C,CAAA;AAAA,EAC7E,EAAI,EAAA;AACN,CAAC;;;;"}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-/// <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';
+import { Request } from 'express';
+import { ParsedMediaType } from 'content-type';
 
 /**
  * @public
@@ -202,6 +203,27 @@ interface HttpPostIngressOptions {
     validator?: RequestValidator;
 }
 
+/**
+ * @public
+ */
+type HttpBodyParsed = {
+    bodyParsed: any;
+    bodyBuffer: Buffer;
+    encoding: string;
+};
+/**
+ * @public
+ */
+type HttpBodyParser = (request: Request, parsedMediaType: ParsedMediaType, topic: string) => Promise<HttpBodyParsed>;
+
+/**
+ * @public
+ */
+interface HttpBodyParserOptions {
+    contentType: string;
+    parser: HttpBodyParser;
+}
+
 /**
  * Subscribes to the provided (generic) topic
  * and publishes the events under the more concrete sub-topic
@@ -293,4 +315,4 @@ declare const eventsServiceRef: _backstage_backend_plugin_api.ServiceRef<EventsS
 /** @public */
 declare const eventsServiceFactory: _backstage_backend_plugin_api.ServiceFactory<EventsService, "plugin", "singleton">;
 
-export { DefaultEventsService, EVENTS_NOTIFY_TIMEOUT_HEADER, type EventBroker, type EventBusMode, type EventParams, type EventPublisher, EventRouter, type EventSubscriber, type EventsService, type EventsServiceEventHandler, type EventsServiceSubscribeOptions, type HttpPostIngressOptions, type RequestDetails, type RequestRejectionDetails, type RequestValidationContext, type RequestValidator, SubTopicEventRouter, eventsServiceFactory, eventsServiceRef };
+export { DefaultEventsService, EVENTS_NOTIFY_TIMEOUT_HEADER, type EventBroker, type EventBusMode, type EventParams, type EventPublisher, EventRouter, type EventSubscriber, type EventsService, type EventsServiceEventHandler, type EventsServiceSubscribeOptions, type HttpBodyParsed, type HttpBodyParser, type HttpBodyParserOptions, type HttpPostIngressOptions, type RequestDetails, type RequestRejectionDetails, type RequestValidationContext, type RequestValidator, SubTopicEventRouter, eventsServiceFactory, eventsServiceRef };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-node",
-  "version": "0.4.9-next.1",
+  "version": "0.4.9-next.2",
   "description": "The plugin-events-node module for @backstage/plugin-events-backend",
   "backstage": {
     "role": "node-library",
@@ -38,7 +38,7 @@
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
-      "index": [
+      "*": [
         "dist/index.d.ts"
       ],
       "alpha": [
@@ -63,12 +63,16 @@
     "@backstage/backend-plugin-api": "1.2.1-next.1",
     "@backstage/errors": "1.2.7",
     "@backstage/types": "1.2.1",
+    "@types/content-type": "^1.1.8",
+    "@types/express": "^4.17.6",
+    "content-type": "^1.0.5",
     "cross-fetch": "^4.0.0",
+    "express": "^4.17.1",
     "uri-template": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.3.1-next.1",
-    "@backstage/cli": "0.30.1-next.0",
+    "@backstage/backend-test-utils": "1.3.1-next.2",
+    "@backstage/cli": "0.31.0-next.1",
     "msw": "^1.0.0"
   },
   "configSchema": "config.d.ts"