diff --git a/plugins/signals-node/api-report.md b/plugins/signals-node/api-report.md index 6636ae2c31..9d67e24732 100644 --- a/plugins/signals-node/api-report.md +++ b/plugins/signals-node/api-report.md @@ -11,8 +11,8 @@ import { ServiceRef } from '@backstage/backend-plugin-api'; export class DefaultSignalService implements SignalService { // (undocumented) static create(options: SignalServiceOptions): DefaultSignalService; - publish( - signal: SignalPayload, + publish( + signal: SignalPayload, ): Promise; } @@ -20,13 +20,13 @@ export class DefaultSignalService implements SignalService { export type SignalPayload = { recipients: string[] | string | null; channel: string; - message: SignalType; + message: TMessage; }; // @public (undocumented) export interface SignalService { - publish( - signal: SignalPayload, + publish( + signal: SignalPayload, ): Promise; } diff --git a/plugins/signals-node/src/DefaultSignalService.ts b/plugins/signals-node/src/DefaultSignalService.ts index d99bae48ff..d1bc14e166 100644 --- a/plugins/signals-node/src/DefaultSignalService.ts +++ b/plugins/signals-node/src/DefaultSignalService.ts @@ -35,8 +35,8 @@ export class DefaultSignalService implements SignalService { * Publishes a signal to user refs to specific topic * @param signal - Signal to publish */ - async publish( - signal: SignalPayload, + async publish( + signal: SignalPayload, ) { await this.eventBroker?.publish({ topic: 'signals', diff --git a/plugins/signals-node/src/SignalService.ts b/plugins/signals-node/src/SignalService.ts index 383da51b4c..7011c6c525 100644 --- a/plugins/signals-node/src/SignalService.ts +++ b/plugins/signals-node/src/SignalService.ts @@ -22,7 +22,7 @@ export interface SignalService { * Publishes a signal to user refs to specific topic * @param signal - Signal to publish */ - publish( - signal: SignalPayload, + publish( + signal: SignalPayload, ): Promise; } diff --git a/plugins/signals-node/src/types.ts b/plugins/signals-node/src/types.ts index bebee835ed..ec6e815b29 100644 --- a/plugins/signals-node/src/types.ts +++ b/plugins/signals-node/src/types.ts @@ -24,8 +24,8 @@ export type SignalServiceOptions = { }; /** @public */ -export type SignalPayload = { +export type SignalPayload = { recipients: string[] | string | null; channel: string; - message: SignalType; + message: TMessage; }; diff --git a/plugins/signals-react/api-report.md b/plugins/signals-react/api-report.md index 0c555cd566..87d856288b 100644 --- a/plugins/signals-react/api-report.md +++ b/plugins/signals-react/api-report.md @@ -9,9 +9,9 @@ import { JsonObject } from '@backstage/types'; // @public (undocumented) export interface SignalApi { // (undocumented) - subscribe( + subscribe( channel: string, - onMessage: (message: SignalType) => void, + onMessage: (message: TMessage) => void, ): SignalSubscriber; } @@ -25,10 +25,10 @@ export interface SignalSubscriber { } // @public (undocumented) -export const useSignal: ( +export const useSignal: ( channel: string, ) => { - lastSignal: SignalType | null; + lastSignal: TMessage | null; isSignalsAvailable: boolean; }; diff --git a/plugins/signals-react/src/api/SignalApi.ts b/plugins/signals-react/src/api/SignalApi.ts index f27c8d46ee..66f2c7e881 100644 --- a/plugins/signals-react/src/api/SignalApi.ts +++ b/plugins/signals-react/src/api/SignalApi.ts @@ -28,8 +28,8 @@ export interface SignalSubscriber { /** @public */ export interface SignalApi { - subscribe( + subscribe( channel: string, - onMessage: (message: SignalType) => void, + onMessage: (message: TMessage) => void, ): SignalSubscriber; } diff --git a/plugins/signals-react/src/hooks/useSignal.ts b/plugins/signals-react/src/hooks/useSignal.ts index db65454e0b..6fb0f4696f 100644 --- a/plugins/signals-react/src/hooks/useSignal.ts +++ b/plugins/signals-react/src/hooks/useSignal.ts @@ -19,20 +19,20 @@ import { JsonObject } from '@backstage/types'; import { useEffect, useMemo, useState } from 'react'; /** @public */ -export const useSignal = ( +export const useSignal = ( channel: string, -): { lastSignal: SignalType | null; isSignalsAvailable: boolean } => { +): { lastSignal: TMessage | null; isSignalsAvailable: boolean } => { const apiHolder = useApiHolder(); // Use apiHolder instead useApi in case signalApi is not available in the // backstage instance this is used const signals = apiHolder.get(signalApiRef); - const [lastSignal, setLastSignal] = useState(null); + const [lastSignal, setLastSignal] = useState(null); useEffect(() => { let unsub: null | (() => void) = null; if (signals) { - const { unsubscribe } = signals.subscribe( + const { unsubscribe } = signals.subscribe( channel, - (msg: SignalType) => { + (msg: TMessage) => { setLastSignal(msg); }, ); diff --git a/plugins/signals/api-report.md b/plugins/signals/api-report.md index 180b3076ec..1af1063433 100644 --- a/plugins/signals/api-report.md +++ b/plugins/signals/api-report.md @@ -24,9 +24,9 @@ export class SignalClient implements SignalApi { // (undocumented) static readonly DEFAULT_RECONNECT_TIMEOUT_MS: number; // (undocumented) - subscribe( + subscribe( channel: string, - onMessage: (message: SignalType) => void, + onMessage: (message: TMessage) => void, ): SignalSubscriber; } diff --git a/plugins/signals/src/api/SignalClient.ts b/plugins/signals/src/api/SignalClient.ts index 806646c351..feccf4a105 100644 --- a/plugins/signals/src/api/SignalClient.ts +++ b/plugins/signals/src/api/SignalClient.ts @@ -62,9 +62,9 @@ export class SignalClient implements SignalApi { private reconnectTimeout: number, ) {} - subscribe( + subscribe( channel: string, - onMessage: (message: SignalType) => void, + onMessage: (message: TMessage) => void, ): SignalSubscriber { const subscriptionId = uuid(); const exists = [...this.subscriptions.values()].find(