chore: signal type naming

Signed-off-by: Heikki Hellgren <heikki.hellgren@op.fi>

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<SignalType extends JsonObject = JsonObject>(
-    signal: SignalPayload<SignalType>,
+  publish<TMessage extends JsonObject = JsonObject>(
+    signal: SignalPayload<TMessage>,
   ): Promise<void>;
 }
 
@@ -20,13 +20,13 @@ export class DefaultSignalService implements SignalService {
 export type SignalPayload<TMessage extends JsonObject = JsonObject> = {
   recipients: string[] | string | null;
   channel: string;
-  message: SignalType;
+  message: TMessage;
 };
 
 // @public (undocumented)
 export interface SignalService {
-  publish<SignalType extends JsonObject = JsonObject>(
-    signal: SignalPayload<SignalType>,
+  publish<TMessage extends JsonObject = JsonObject>(
+    signal: SignalPayload<TMessage>,
   ): Promise<void>;
 }
 

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<SignalType extends JsonObject = JsonObject>(
-    signal: SignalPayload<SignalType>,
+  async publish<TMessage extends JsonObject = JsonObject>(
+    signal: SignalPayload<TMessage>,
   ) {
     await this.eventBroker?.publish({
       topic: 'signals',

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<SignalType extends JsonObject = JsonObject>(
-    signal: SignalPayload<SignalType>,
+  publish<TMessage extends JsonObject = JsonObject>(
+    signal: SignalPayload<TMessage>,
   ): Promise<void>;
 }

plugins/signals-node/src/types.ts

@@ -24,8 +24,8 @@ export type SignalServiceOptions = {
 };
 
 /** @public */
-export type SignalPayload<SignalType extends JsonObject = JsonObject> = {
+export type SignalPayload<TMessage extends JsonObject = JsonObject> = {
   recipients: string[] | string | null;
   channel: string;
-  message: SignalType;
+  message: TMessage;
 };

plugins/signals-react/api-report.md

@@ -9,9 +9,9 @@ import { JsonObject } from '@backstage/types';
 // @public (undocumented)
 export interface SignalApi {
   // (undocumented)
-  subscribe<SignalType extends JsonObject = JsonObject>(
+  subscribe<TMessage extends JsonObject = JsonObject>(
     channel: string,
-    onMessage: (message: SignalType) => void,
+    onMessage: (message: TMessage) => void,
   ): SignalSubscriber;
 }
 
@@ -25,10 +25,10 @@ export interface SignalSubscriber {
 }
 
 // @public (undocumented)
-export const useSignal: <SignalType extends JsonObject = JsonObject>(
+export const useSignal: <TMessage extends JsonObject = JsonObject>(
   channel: string,
 ) => {
-  lastSignal: SignalType | null;
+  lastSignal: TMessage | null;
   isSignalsAvailable: boolean;
 };
 

plugins/signals-react/src/api/SignalApi.ts

@@ -28,8 +28,8 @@ export interface SignalSubscriber {
 
 /** @public */
 export interface SignalApi {
-  subscribe<SignalType extends JsonObject = JsonObject>(
+  subscribe<TMessage extends JsonObject = JsonObject>(
     channel: string,
-    onMessage: (message: SignalType) => void,
+    onMessage: (message: TMessage) => void,
   ): SignalSubscriber;
 }

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 = <SignalType extends JsonObject = JsonObject>(
+export const useSignal = <TMessage extends JsonObject = JsonObject>(
   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<SignalType | null>(null);
+  const [lastSignal, setLastSignal] = useState<TMessage | null>(null);
   useEffect(() => {
     let unsub: null | (() => void) = null;
     if (signals) {
-      const { unsubscribe } = signals.subscribe<SignalType>(
+      const { unsubscribe } = signals.subscribe<TMessage>(
         channel,
-        (msg: SignalType) => {
+        (msg: TMessage) => {
           setLastSignal(msg);
         },
       );

plugins/signals/api-report.md

@@ -24,9 +24,9 @@ export class SignalClient implements SignalApi {
   // (undocumented)
   static readonly DEFAULT_RECONNECT_TIMEOUT_MS: number;
   // (undocumented)
-  subscribe<SignalType extends JsonObject = JsonObject>(
+  subscribe<TMessage extends JsonObject = JsonObject>(
     channel: string,
-    onMessage: (message: SignalType) => void,
+    onMessage: (message: TMessage) => void,
   ): SignalSubscriber;
 }
 

plugins/signals/src/api/SignalClient.ts

@@ -62,9 +62,9 @@ export class SignalClient implements SignalApi {
     private reconnectTimeout: number,
   ) {}
 
-  subscribe<SignalType extends JsonObject = JsonObject>(
+  subscribe<TMessage extends JsonObject = JsonObject>(
     channel: string,
-    onMessage: (message: SignalType) => void,
+    onMessage: (message: TMessage) => void,
   ): SignalSubscriber {
     const subscriptionId = uuid();
     const exists = [...this.subscriptions.values()].find(