@backstage/plugin-events-node 0.2.3 → 0.2.4-next.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @backstage/plugin-events-node
 
+## 0.2.4-next.0
+
+### Patch Changes
+
+- 928a12a9b3: Internal refactor of `/alpha` exports.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.4.1-next.0
+
 ## 0.2.3
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-events-node",
-  "version": "0.2.3",
-  "main": "../dist/index.cjs.js",
-  "types": "../dist/index.alpha.d.ts"
+  "version": "0.2.4-next.0",
+  "main": "../dist/alpha.cjs.js",
+  "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+const eventsExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "events"
+});
+
+exports.eventsExtensionPoint = eventsExtensionPoint;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.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  setEventBroker(eventBroker: EventBroker): void;\n\n  addPublishers(\n    ...publishers: Array<EventPublisher | Array<EventPublisher>>\n  ): void;\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":";;;;;;AA4CO,MAAM,uBAAuBA,qCAA2C,CAAA;AAAA,EAC7E,EAAI,EAAA,QAAA;AACN,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,18 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { EventBroker, EventPublisher, EventSubscriber, HttpPostIngressOptions } from '@backstage/plugin-events-node';
+
+/**
+ * @alpha
+ */
+interface EventsExtensionPoint {
+    setEventBroker(eventBroker: EventBroker): void;
+    addPublishers(...publishers: Array<EventPublisher | Array<EventPublisher>>): void;
+    addSubscribers(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
+    addHttpPostIngress(options: HttpPostIngressOptions): void;
+}
+/**
+ * @alpha
+ */
+declare const eventsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<EventsExtensionPoint>;
+
+export { EventsExtensionPoint, eventsExtensionPoint };

package/dist/index.cjs.js

@@ -2,8 +2,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var backendPluginApi = require('@backstage/backend-plugin-api');
-
 class EventRouter {
   async onEvent(params) {
     var _a;
@@ -35,11 +33,6 @@ class SubTopicEventRouter extends EventRouter {
   }
 }
 
-const eventsExtensionPoint = backendPluginApi.createExtensionPoint({
-  id: "events"
-});
-
 exports.EventRouter = EventRouter;
 exports.SubTopicEventRouter = SubTopicEventRouter;
-exports.eventsExtensionPoint = eventsExtensionPoint;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/api/EventRouter.ts","../src/api/SubTopicEventRouter.ts","../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 { EventBroker } from './EventBroker';\nimport { EventParams } from './EventParams';\nimport { EventPublisher } from './EventPublisher';\nimport { EventSubscriber } from './EventSubscriber';\n\n/**\n * Subscribes to a topic and - depending on a set of conditions -\n * republishes the event to another topic.\n *\n * @see {@link https://www.enterpriseintegrationpatterns.com/MessageRouter.html | Message Router pattern}.\n * @public\n */\nexport abstract class EventRouter implements EventPublisher, EventSubscriber {\n  private eventBroker?: EventBroker;\n\n  protected abstract determineDestinationTopic(\n    params: EventParams,\n  ): string | undefined;\n\n  async onEvent(params: EventParams): Promise<void> {\n    const topic = this.determineDestinationTopic(params);\n\n    if (!topic) {\n      return;\n    }\n\n    // republish to different topic\n    this.eventBroker?.publish({\n      ...params,\n      topic,\n    });\n  }\n\n  async setEventBroker(eventBroker: EventBroker): Promise<void> {\n    this.eventBroker = eventBroker;\n  }\n\n  abstract supportsEventTopics(): string[];\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 { EventParams } from './EventParams';\nimport { EventRouter } from './EventRouter';\n\n/**\n * Subscribes to the provided (generic) topic\n * and publishes the events under the more concrete sub-topic\n * depending on the implemented logic for determining it.\n * Implementing classes might use information from `metadata`\n * and/or properties within the payload.\n *\n * @public\n */\nexport abstract class SubTopicEventRouter extends EventRouter {\n  protected constructor(private readonly topic: string) {\n    super();\n  }\n\n  protected abstract determineSubTopic(params: EventParams): string | undefined;\n\n  protected determineDestinationTopic(params: EventParams): string | undefined {\n    const subTopic = this.determineSubTopic(params);\n    return subTopic ? `${params.topic}.${subTopic}` : undefined;\n  }\n\n  supportsEventTopics(): string[] {\n    return [this.topic];\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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport {\n  EventBroker,\n  EventPublisher,\n  EventSubscriber,\n  HttpPostIngressOptions,\n} from './api';\n\n/**\n * @alpha\n */\nexport interface EventsExtensionPoint {\n  setEventBroker(eventBroker: EventBroker): void;\n\n  addPublishers(\n    ...publishers: Array<EventPublisher | Array<EventPublisher>>\n  ): void;\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":";;;;;;AA4BO,MAAe,WAAuD,CAAA;AAAA,EAO3E,MAAM,QAAQ,MAAoC,EAAA;AAnCpD,IAAA,IAAA,EAAA,CAAA;AAoCI,IAAM,MAAA,KAAA,GAAQ,IAAK,CAAA,yBAAA,CAA0B,MAAM,CAAA,CAAA;AAEnD,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAA,OAAA;AAAA,KACF;AAGA,IAAK,CAAA,EAAA,GAAA,IAAA,CAAA,WAAA,KAAL,mBAAkB,OAAQ,CAAA;AAAA,MACxB,GAAG,MAAA;AAAA,MACH,KAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,eAAe,WAAyC,EAAA;AAC5D,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACrB;AAGF;;AC1BO,MAAe,4BAA4B,WAAY,CAAA;AAAA,EAClD,YAA6B,KAAe,EAAA;AACpD,IAAM,KAAA,EAAA,CAAA;AAD+B,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA,CAAA;AAAA,GAEvC;AAAA,EAIU,0BAA0B,MAAyC,EAAA;AAC3E,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA,CAAA;AAC9C,IAAA,OAAO,QAAW,GAAA,CAAA,EAAG,MAAO,CAAA,KAAA,CAAA,CAAA,EAAS,QAAa,CAAA,CAAA,GAAA,KAAA,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,mBAAgC,GAAA;AAC9B,IAAO,OAAA,CAAC,KAAK,KAAK,CAAA,CAAA;AAAA,GACpB;AACF;;ACCO,MAAM,uBAAuBA,qCAA2C,CAAA;AAAA,EAC7E,EAAI,EAAA,QAAA;AACN,CAAC;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/api/EventRouter.ts","../src/api/SubTopicEventRouter.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 { EventBroker } from './EventBroker';\nimport { EventParams } from './EventParams';\nimport { EventPublisher } from './EventPublisher';\nimport { EventSubscriber } from './EventSubscriber';\n\n/**\n * Subscribes to a topic and - depending on a set of conditions -\n * republishes the event to another topic.\n *\n * @see {@link https://www.enterpriseintegrationpatterns.com/MessageRouter.html | Message Router pattern}.\n * @public\n */\nexport abstract class EventRouter implements EventPublisher, EventSubscriber {\n  private eventBroker?: EventBroker;\n\n  protected abstract determineDestinationTopic(\n    params: EventParams,\n  ): string | undefined;\n\n  async onEvent(params: EventParams): Promise<void> {\n    const topic = this.determineDestinationTopic(params);\n\n    if (!topic) {\n      return;\n    }\n\n    // republish to different topic\n    this.eventBroker?.publish({\n      ...params,\n      topic,\n    });\n  }\n\n  async setEventBroker(eventBroker: EventBroker): Promise<void> {\n    this.eventBroker = eventBroker;\n  }\n\n  abstract supportsEventTopics(): string[];\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 { EventParams } from './EventParams';\nimport { EventRouter } from './EventRouter';\n\n/**\n * Subscribes to the provided (generic) topic\n * and publishes the events under the more concrete sub-topic\n * depending on the implemented logic for determining it.\n * Implementing classes might use information from `metadata`\n * and/or properties within the payload.\n *\n * @public\n */\nexport abstract class SubTopicEventRouter extends EventRouter {\n  protected constructor(private readonly topic: string) {\n    super();\n  }\n\n  protected abstract determineSubTopic(params: EventParams): string | undefined;\n\n  protected determineDestinationTopic(params: EventParams): string | undefined {\n    const subTopic = this.determineSubTopic(params);\n    return subTopic ? `${params.topic}.${subTopic}` : undefined;\n  }\n\n  supportsEventTopics(): string[] {\n    return [this.topic];\n  }\n}\n"],"names":[],"mappings":";;;;AA4BO,MAAe,WAAuD,CAAA;AAAA,EAO3E,MAAM,QAAQ,MAAoC,EAAA;AAnCpD,IAAA,IAAA,EAAA,CAAA;AAoCI,IAAM,MAAA,KAAA,GAAQ,IAAK,CAAA,yBAAA,CAA0B,MAAM,CAAA,CAAA;AAEnD,IAAA,IAAI,CAAC,KAAO,EAAA;AACV,MAAA,OAAA;AAAA,KACF;AAGA,IAAK,CAAA,EAAA,GAAA,IAAA,CAAA,WAAA,KAAL,mBAAkB,OAAQ,CAAA;AAAA,MACxB,GAAG,MAAA;AAAA,MACH,KAAA;AAAA,KACF,CAAA,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,eAAe,WAAyC,EAAA;AAC5D,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACrB;AAGF;;AC1BO,MAAe,4BAA4B,WAAY,CAAA;AAAA,EAClD,YAA6B,KAAe,EAAA;AACpD,IAAM,KAAA,EAAA,CAAA;AAD+B,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA,CAAA;AAAA,GAEvC;AAAA,EAIU,0BAA0B,MAAyC,EAAA;AAC3E,IAAM,MAAA,QAAA,GAAW,IAAK,CAAA,iBAAA,CAAkB,MAAM,CAAA,CAAA;AAC9C,IAAA,OAAO,QAAW,GAAA,CAAA,EAAG,MAAO,CAAA,KAAA,CAAA,CAAA,EAAS,QAAa,CAAA,CAAA,GAAA,KAAA,CAAA,CAAA;AAAA,GACpD;AAAA,EAEA,mBAAgC,GAAA;AAC9B,IAAO,OAAA,CAAC,KAAK,KAAK,CAAA,CAAA;AAAA,GACpB;AACF;;;;;"}

package/dist/index.d.ts

@@ -1,10 +1,40 @@
 /**
- * The events-node module for `@backstage/plugin-events-backend`.
- *
- * @packageDocumentation
+ * @public
  */
+interface EventParams<TPayload = unknown> {
+    /**
+     * Topic for which this event should be published.
+     */
+    topic: string;
+    /**
+     * Event payload.
+     */
+    eventPayload: TPayload;
+    /**
+     * Metadata (e.g., HTTP headers and similar for events received from external).
+     */
+    metadata?: Record<string, string | string[] | undefined>;
+}
 
-import { ExtensionPoint } from '@backstage/backend-plugin-api';
+/**
+ * Handles received events.
+ * This may include triggering refreshes of catalog entities
+ * or other actions to react on events.
+ *
+ * @public
+ */
+interface EventSubscriber {
+    /**
+     * Supported event topics like "github", "bitbucketCloud", etc.
+     */
+    supportsEventTopics(): string[];
+    /**
+     * React on a received event.
+     *
+     * @param params - parameters for the to be received event.
+     */
+    onEvent(params: EventParams): Promise<void>;
+}
 
 /**
  * Allows a decoupled and asynchronous communication between components.
@@ -13,7 +43,7 @@ import { ExtensionPoint } from '@backstage/backend-plugin-api';
  *
  * @public
  */
-export declare interface EventBroker {
+interface EventBroker {
     /**
      * Publishes an event for the topic.
      *
@@ -28,24 +58,6 @@ export declare interface EventBroker {
     subscribe(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
 }
 
-/**
- * @public
- */
-export declare interface EventParams<TPayload = unknown> {
-    /**
-     * Topic for which this event should be published.
-     */
-    topic: string;
-    /**
-     * Event payload.
-     */
-    eventPayload: TPayload;
-    /**
-     * Metadata (e.g., HTTP headers and similar for events received from external).
-     */
-    metadata?: Record<string, string | string[] | undefined>;
-}
-
 /**
  * Publishes events to be consumed by subscribers for their topic.
  * The events can come from different (external) sources
@@ -54,7 +66,7 @@ export declare interface EventParams<TPayload = unknown> {
  *
  * @public
  */
-export declare interface EventPublisher {
+interface EventPublisher {
     setEventBroker(eventBroker: EventBroker): Promise<void>;
 }
 
@@ -65,7 +77,7 @@ export declare interface EventPublisher {
  * @see {@link https://www.enterpriseintegrationpatterns.com/MessageRouter.html | Message Router pattern}.
  * @public
  */
-export declare abstract class EventRouter implements EventPublisher, EventSubscriber {
+declare abstract class EventRouter implements EventPublisher, EventSubscriber {
     private eventBroker?;
     protected abstract determineDestinationTopic(params: EventParams): string | undefined;
     onEvent(params: EventParams): Promise<void>;
@@ -73,42 +85,10 @@ export declare abstract class EventRouter implements EventPublisher, EventSubscr
     abstract supportsEventTopics(): string[];
 }
 
-/* Excluded from this release type: EventsExtensionPoint */
-
-/* Excluded from this release type: eventsExtensionPoint */
-
-/**
- * Handles received events.
- * This may include triggering refreshes of catalog entities
- * or other actions to react on events.
- *
- * @public
- */
-export declare interface EventSubscriber {
-    /**
-     * Supported event topics like "github", "bitbucketCloud", etc.
-     */
-    supportsEventTopics(): string[];
-    /**
-     * React on a received event.
-     *
-     * @param params - parameters for the to be received event.
-     */
-    onEvent(params: EventParams): Promise<void>;
-}
-
 /**
  * @public
  */
-export declare interface HttpPostIngressOptions {
-    topic: string;
-    validator?: RequestValidator;
-}
-
-/**
- * @public
- */
-export declare interface RequestDetails {
+interface RequestDetails {
     /**
      * Request body. JSON payloads have been parsed already.
      */
@@ -125,7 +105,7 @@ export declare interface RequestDetails {
  *
  * @public
  */
-export declare interface RequestRejectionDetails {
+interface RequestRejectionDetails {
     status: number;
     payload: unknown;
 }
@@ -136,7 +116,7 @@ export declare interface RequestRejectionDetails {
  *
  * @public
  */
-export declare interface RequestValidationContext {
+interface RequestValidationContext {
     /**
      * Rejects the validated request
      *
@@ -156,7 +136,15 @@ export declare interface RequestValidationContext {
  *
  * @public
  */
-export declare type RequestValidator = (request: RequestDetails, context: RequestValidationContext) => Promise<void>;
+declare type RequestValidator = (request: RequestDetails, context: RequestValidationContext) => Promise<void>;
+
+/**
+ * @public
+ */
+interface HttpPostIngressOptions {
+    topic: string;
+    validator?: RequestValidator;
+}
 
 /**
  * Subscribes to the provided (generic) topic
@@ -167,7 +155,7 @@ export declare type RequestValidator = (request: RequestDetails, context: Reques
  *
  * @public
  */
-export declare abstract class SubTopicEventRouter extends EventRouter {
+declare abstract class SubTopicEventRouter extends EventRouter {
     private readonly topic;
     protected constructor(topic: string);
     protected abstract determineSubTopic(params: EventParams): string | undefined;
@@ -175,4 +163,4 @@ export declare abstract class SubTopicEventRouter extends EventRouter {
     supportsEventTopics(): string[];
 }
 
-export { }
+export { EventBroker, EventParams, EventPublisher, EventRouter, EventSubscriber, HttpPostIngressOptions, RequestDetails, RequestRejectionDetails, RequestValidationContext, RequestValidator, SubTopicEventRouter };

package/package.json

@@ -1,22 +1,32 @@
 {
   "name": "@backstage/plugin-events-node",
   "description": "The plugin-events-node module for @backstage/plugin-events-backend",
-  "version": "0.2.3",
-  "main": "dist/index.cjs.js",
-  "types": "dist/index.d.ts",
+  "version": "0.2.4-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": "node-library"
   },
   "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",
@@ -24,13 +34,13 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.4.0"
+    "@backstage/backend-plugin-api": "^0.4.1-next.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.2"
+    "@backstage/cli": "^0.22.4-next.0"
   },
   "files": [
-    "alpha",
-    "dist"
+    "dist",
+    "alpha"
   ]
 }

package/dist/index.alpha.d.ts

@@ -1,189 +0,0 @@
-/**
- * The events-node module for `@backstage/plugin-events-backend`.
- *
- * @packageDocumentation
- */
-
-import { ExtensionPoint } from '@backstage/backend-plugin-api';
-
-/**
- * Allows a decoupled and asynchronous communication between components.
- * Components can publish events for a given topic and
- * others can subscribe for future events for topics they are interested in.
- *
- * @public
- */
-export declare interface EventBroker {
-    /**
-     * Publishes an event for the topic.
-     *
-     * @param params - parameters for the to be published event.
-     */
-    publish(params: EventParams): Promise<void>;
-    /**
-     * Adds new subscribers for {@link EventSubscriber#supportsEventTopics | interested topics}.
-     *
-     * @param subscribers - interested in events of specified topics.
-     */
-    subscribe(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
-}
-
-/**
- * @public
- */
-export declare interface EventParams<TPayload = unknown> {
-    /**
-     * Topic for which this event should be published.
-     */
-    topic: string;
-    /**
-     * Event payload.
-     */
-    eventPayload: TPayload;
-    /**
-     * Metadata (e.g., HTTP headers and similar for events received from external).
-     */
-    metadata?: Record<string, string | string[] | undefined>;
-}
-
-/**
- * Publishes events to be consumed by subscribers for their topic.
- * The events can come from different (external) sources
- * like emitted themselves, received via HTTP endpoint (i.e. webhook)
- * or from event brokers, queues, etc.
- *
- * @public
- */
-export declare interface EventPublisher {
-    setEventBroker(eventBroker: EventBroker): Promise<void>;
-}
-
-/**
- * Subscribes to a topic and - depending on a set of conditions -
- * republishes the event to another topic.
- *
- * @see {@link https://www.enterpriseintegrationpatterns.com/MessageRouter.html | Message Router pattern}.
- * @public
- */
-export declare abstract class EventRouter implements EventPublisher, EventSubscriber {
-    private eventBroker?;
-    protected abstract determineDestinationTopic(params: EventParams): string | undefined;
-    onEvent(params: EventParams): Promise<void>;
-    setEventBroker(eventBroker: EventBroker): Promise<void>;
-    abstract supportsEventTopics(): string[];
-}
-
-/**
- * @alpha
- */
-export declare interface EventsExtensionPoint {
-    setEventBroker(eventBroker: EventBroker): void;
-    addPublishers(...publishers: Array<EventPublisher | Array<EventPublisher>>): void;
-    addSubscribers(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
-    addHttpPostIngress(options: HttpPostIngressOptions): void;
-}
-
-/**
- * @alpha
- */
-export declare const eventsExtensionPoint: ExtensionPoint<EventsExtensionPoint>;
-
-/**
- * Handles received events.
- * This may include triggering refreshes of catalog entities
- * or other actions to react on events.
- *
- * @public
- */
-export declare interface EventSubscriber {
-    /**
-     * Supported event topics like "github", "bitbucketCloud", etc.
-     */
-    supportsEventTopics(): string[];
-    /**
-     * React on a received event.
-     *
-     * @param params - parameters for the to be received event.
-     */
-    onEvent(params: EventParams): Promise<void>;
-}
-
-/**
- * @public
- */
-export declare interface HttpPostIngressOptions {
-    topic: string;
-    validator?: RequestValidator;
-}
-
-/**
- * @public
- */
-export declare interface RequestDetails {
-    /**
-     * Request body. JSON payloads have been parsed already.
-     */
-    body: unknown;
-    /**
-     * Key-value pairs of header names and values. Header names are lower-cased.
-     */
-    headers: Record<string, string | string[] | undefined>;
-}
-
-/**
- * Details for how to respond to the rejection
- * of the received HTTP request transmitting an event payload.
- *
- * @public
- */
-export declare interface RequestRejectionDetails {
-    status: number;
-    payload: unknown;
-}
-
-/**
- * Passed context for the validation
- * at which rejections can be expressed.
- *
- * @public
- */
-export declare interface RequestValidationContext {
-    /**
-     * Rejects the validated request
-     *
-     * @param details - Optional details about the rejection which will be provided to the sender.
-     */
-    reject(details?: Partial<RequestRejectionDetails>): void;
-}
-
-/**
- * Validator used to check the received HTTP request
- * transmitting an event payload.
- *
- * E.g., it can be used for signature verification like
- * for GitHub webhook events
- * (https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks#secret)
- * or other kinds of checks.
- *
- * @public
- */
-export declare type RequestValidator = (request: RequestDetails, context: RequestValidationContext) => Promise<void>;
-
-/**
- * Subscribes to the provided (generic) topic
- * and publishes the events under the more concrete sub-topic
- * depending on the implemented logic for determining it.
- * Implementing classes might use information from `metadata`
- * and/or properties within the payload.
- *
- * @public
- */
-export declare abstract class SubTopicEventRouter extends EventRouter {
-    private readonly topic;
-    protected constructor(topic: string);
-    protected abstract determineSubTopic(params: EventParams): string | undefined;
-    protected determineDestinationTopic(params: EventParams): string | undefined;
-    supportsEventTopics(): string[];
-}
-
-export { }

package/dist/index.beta.d.ts

@@ -1,178 +0,0 @@
-/**
- * The events-node module for `@backstage/plugin-events-backend`.
- *
- * @packageDocumentation
- */
-
-import { ExtensionPoint } from '@backstage/backend-plugin-api';
-
-/**
- * Allows a decoupled and asynchronous communication between components.
- * Components can publish events for a given topic and
- * others can subscribe for future events for topics they are interested in.
- *
- * @public
- */
-export declare interface EventBroker {
-    /**
-     * Publishes an event for the topic.
-     *
-     * @param params - parameters for the to be published event.
-     */
-    publish(params: EventParams): Promise<void>;
-    /**
-     * Adds new subscribers for {@link EventSubscriber#supportsEventTopics | interested topics}.
-     *
-     * @param subscribers - interested in events of specified topics.
-     */
-    subscribe(...subscribers: Array<EventSubscriber | Array<EventSubscriber>>): void;
-}
-
-/**
- * @public
- */
-export declare interface EventParams<TPayload = unknown> {
-    /**
-     * Topic for which this event should be published.
-     */
-    topic: string;
-    /**
-     * Event payload.
-     */
-    eventPayload: TPayload;
-    /**
-     * Metadata (e.g., HTTP headers and similar for events received from external).
-     */
-    metadata?: Record<string, string | string[] | undefined>;
-}
-
-/**
- * Publishes events to be consumed by subscribers for their topic.
- * The events can come from different (external) sources
- * like emitted themselves, received via HTTP endpoint (i.e. webhook)
- * or from event brokers, queues, etc.
- *
- * @public
- */
-export declare interface EventPublisher {
-    setEventBroker(eventBroker: EventBroker): Promise<void>;
-}
-
-/**
- * Subscribes to a topic and - depending on a set of conditions -
- * republishes the event to another topic.
- *
- * @see {@link https://www.enterpriseintegrationpatterns.com/MessageRouter.html | Message Router pattern}.
- * @public
- */
-export declare abstract class EventRouter implements EventPublisher, EventSubscriber {
-    private eventBroker?;
-    protected abstract determineDestinationTopic(params: EventParams): string | undefined;
-    onEvent(params: EventParams): Promise<void>;
-    setEventBroker(eventBroker: EventBroker): Promise<void>;
-    abstract supportsEventTopics(): string[];
-}
-
-/* Excluded from this release type: EventsExtensionPoint */
-
-/* Excluded from this release type: eventsExtensionPoint */
-
-/**
- * Handles received events.
- * This may include triggering refreshes of catalog entities
- * or other actions to react on events.
- *
- * @public
- */
-export declare interface EventSubscriber {
-    /**
-     * Supported event topics like "github", "bitbucketCloud", etc.
-     */
-    supportsEventTopics(): string[];
-    /**
-     * React on a received event.
-     *
-     * @param params - parameters for the to be received event.
-     */
-    onEvent(params: EventParams): Promise<void>;
-}
-
-/**
- * @public
- */
-export declare interface HttpPostIngressOptions {
-    topic: string;
-    validator?: RequestValidator;
-}
-
-/**
- * @public
- */
-export declare interface RequestDetails {
-    /**
-     * Request body. JSON payloads have been parsed already.
-     */
-    body: unknown;
-    /**
-     * Key-value pairs of header names and values. Header names are lower-cased.
-     */
-    headers: Record<string, string | string[] | undefined>;
-}
-
-/**
- * Details for how to respond to the rejection
- * of the received HTTP request transmitting an event payload.
- *
- * @public
- */
-export declare interface RequestRejectionDetails {
-    status: number;
-    payload: unknown;
-}
-
-/**
- * Passed context for the validation
- * at which rejections can be expressed.
- *
- * @public
- */
-export declare interface RequestValidationContext {
-    /**
-     * Rejects the validated request
-     *
-     * @param details - Optional details about the rejection which will be provided to the sender.
-     */
-    reject(details?: Partial<RequestRejectionDetails>): void;
-}
-
-/**
- * Validator used to check the received HTTP request
- * transmitting an event payload.
- *
- * E.g., it can be used for signature verification like
- * for GitHub webhook events
- * (https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks#secret)
- * or other kinds of checks.
- *
- * @public
- */
-export declare type RequestValidator = (request: RequestDetails, context: RequestValidationContext) => Promise<void>;
-
-/**
- * Subscribes to the provided (generic) topic
- * and publishes the events under the more concrete sub-topic
- * depending on the implemented logic for determining it.
- * Implementing classes might use information from `metadata`
- * and/or properties within the payload.
- *
- * @public
- */
-export declare abstract class SubTopicEventRouter extends EventRouter {
-    private readonly topic;
-    protected constructor(topic: string);
-    protected abstract determineSubTopic(params: EventParams): string | undefined;
-    protected determineDestinationTopic(params: EventParams): string | undefined;
-    supportsEventTopics(): string[];
-}
-
-export { }