From 19d4abf72c9e35b5c7ffde16fd94cb026312afad Mon Sep 17 00:00:00 2001 From: Brian Fletcher Date: Thu, 2 Feb 2023 11:45:01 +0000 Subject: [PATCH 1/3] make `EventParams` typed for tidier event handling Signed-off-by: Brian Fletcher --- .changeset/thick-tables-travel.md | 5 +++++ plugins/events-node/src/api/EventParams.ts | 4 ++-- 2 files changed, 7 insertions(+), 2 deletions(-) create mode 100644 .changeset/thick-tables-travel.md diff --git a/.changeset/thick-tables-travel.md b/.changeset/thick-tables-travel.md new file mode 100644 index 0000000000..d74ed18b8a --- /dev/null +++ b/.changeset/thick-tables-travel.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-events-node': patch +--- + +Make `EventParams` typed for implementing tidier event handling. diff --git a/plugins/events-node/src/api/EventParams.ts b/plugins/events-node/src/api/EventParams.ts index 6912827281..80a81fc495 100644 --- a/plugins/events-node/src/api/EventParams.ts +++ b/plugins/events-node/src/api/EventParams.ts @@ -17,7 +17,7 @@ /** * @public */ -export interface EventParams { +export interface EventParams { /** * Topic for which this event should be published. */ @@ -25,7 +25,7 @@ export interface EventParams { /** * Event payload. */ - eventPayload: unknown; + eventPayload: PayloadType; /** * Metadata (e.g., HTTP headers and similar for events received from external). */ From 0d2336696d6beefb5cff7de2b7d352863bb60b33 Mon Sep 17 00:00:00 2001 From: Brian Fletcher Date: Thu, 2 Feb 2023 12:14:37 +0000 Subject: [PATCH 2/3] api-report Signed-off-by: Brian Fletcher --- plugins/events-node/api-report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/events-node/api-report.md b/plugins/events-node/api-report.md index 51136fd301..21d2926570 100644 --- a/plugins/events-node/api-report.md +++ b/plugins/events-node/api-report.md @@ -14,8 +14,8 @@ export interface EventBroker { } // @public (undocumented) -export interface EventParams { - eventPayload: unknown; +export interface EventParams { + eventPayload: PayloadType; metadata?: Record; topic: string; } From 02ac6ed2dbd4fd07e3e558a13b81729dd2ad62db Mon Sep 17 00:00:00 2001 From: Brian Fletcher Date: Thu, 2 Feb 2023 13:20:27 +0000 Subject: [PATCH 3/3] rename type to TPayload Signed-off-by: Brian Fletcher --- plugins/events-node/api-report.md | 4 ++-- plugins/events-node/src/api/EventParams.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/events-node/api-report.md b/plugins/events-node/api-report.md index 21d2926570..8428003b85 100644 --- a/plugins/events-node/api-report.md +++ b/plugins/events-node/api-report.md @@ -14,8 +14,8 @@ export interface EventBroker { } // @public (undocumented) -export interface EventParams { - eventPayload: PayloadType; +export interface EventParams { + eventPayload: TPayload; metadata?: Record; topic: string; } diff --git a/plugins/events-node/src/api/EventParams.ts b/plugins/events-node/src/api/EventParams.ts index 80a81fc495..19a562aee0 100644 --- a/plugins/events-node/src/api/EventParams.ts +++ b/plugins/events-node/src/api/EventParams.ts @@ -17,7 +17,7 @@ /** * @public */ -export interface EventParams { +export interface EventParams { /** * Topic for which this event should be published. */ @@ -25,7 +25,7 @@ export interface EventParams { /** * Event payload. */ - eventPayload: PayloadType; + eventPayload: TPayload; /** * Metadata (e.g., HTTP headers and similar for events received from external). */