diff --git a/.changeset/dirty-hotels-sniff.md b/.changeset/dirty-hotels-sniff.md index 6d7e97da78..111232999a 100644 --- a/.changeset/dirty-hotels-sniff.md +++ b/.changeset/dirty-hotels-sniff.md @@ -6,5 +6,5 @@ **BREAKING** Type definition added to signal recipients -Update to use `{type: 'broadcast'}` instead `null` and `{type: 'user', entityRefs: ''}` +Update to use `{type: 'broadcast'}` instead `null` and `{type: 'user', entityRef: ''}` instead string entity references diff --git a/plugins/notifications-backend/src/service/router.ts b/plugins/notifications-backend/src/service/router.ts index 84960176ab..ffc3c3f1c0 100644 --- a/plugins/notifications-backend/src/service/router.ts +++ b/plugins/notifications-backend/src/service/router.ts @@ -286,7 +286,7 @@ export async function createRouter( if (signals) { await signals.publish({ - recipients: { type: 'user', entityRefs: [user] }, + recipients: { type: 'user', entityRef: [user] }, message: { action: 'notification_read', notification_ids: ids }, channel: 'notifications', }); @@ -296,7 +296,7 @@ export async function createRouter( if (signals) { await signals.publish({ - recipients: { type: 'user', entityRefs: [user] }, + recipients: { type: 'user', entityRef: [user] }, message: { action: 'notification_unread', notification_ids: ids }, channel: 'notifications', }); @@ -348,7 +348,7 @@ export async function createRouter( if (signals) { await signals.publish({ - recipients: null, + recipients: { type: 'broadcast' }, message: { action: 'new_notification', notification_id: ret.id, @@ -400,7 +400,7 @@ export async function createRouter( if (signals) { await signals.publish({ - recipients: { type: 'user', entityRefs: [user] }, + recipients: { type: 'user', entityRef: [user] }, message: { action: 'new_notification', notification_id: ret.id, diff --git a/plugins/signals-backend/src/service/SignalManager.test.ts b/plugins/signals-backend/src/service/SignalManager.test.ts index f76d18079a..3ee99bb34b 100644 --- a/plugins/signals-backend/src/service/SignalManager.test.ts +++ b/plugins/signals-backend/src/service/SignalManager.test.ts @@ -152,7 +152,7 @@ describe('SignalManager', () => { await onEvent({ topic: 'signals', eventPayload: { - recipients: { type: 'user', entityRefs: 'user:default/john.doe' }, + recipients: { type: 'user', entityRef: 'user:default/john.doe' }, channel: 'test', message: { msg: 'test' }, }, diff --git a/plugins/signals-backend/src/service/SignalManager.ts b/plugins/signals-backend/src/service/SignalManager.ts index 46995ee27c..3211c51c9c 100644 --- a/plugins/signals-backend/src/service/SignalManager.ts +++ b/plugins/signals-backend/src/service/SignalManager.ts @@ -135,9 +135,9 @@ export class SignalManager { const jsonMessage = JSON.stringify({ channel, message }); let users: string[] = []; if (recipients.type === 'user') { - users = Array.isArray(recipients.entityRefs) - ? recipients.entityRefs - : [recipients.entityRefs]; + users = Array.isArray(recipients.entityRef) + ? recipients.entityRef + : [recipients.entityRef]; } // Actual websocket message sending diff --git a/plugins/signals-node/README.md b/plugins/signals-node/README.md index 8d536e3955..9315e65680 100644 --- a/plugins/signals-node/README.md +++ b/plugins/signals-node/README.md @@ -118,7 +118,7 @@ to work: eventBroker.publish({ topic: 'signals', eventPayload: { - recipients: { type: 'user', entityRefs: ['user:default/user1'] }, + recipients: { type: 'user', entityRef: 'user:default/user1' }, message: { message: 'hello world', }, diff --git a/plugins/signals-node/api-report.md b/plugins/signals-node/api-report.md index 4d94fb07d9..cf4ab84aff 100644 --- a/plugins/signals-node/api-report.md +++ b/plugins/signals-node/api-report.md @@ -24,7 +24,7 @@ export type SignalPayload = { recipients: | { type: 'user'; - entityRefs: string | string[]; + entityRef: string | string[]; } | { type: 'broadcast'; diff --git a/plugins/signals-node/src/types.ts b/plugins/signals-node/src/types.ts index 0225e23916..4decef6272 100644 --- a/plugins/signals-node/src/types.ts +++ b/plugins/signals-node/src/types.ts @@ -26,7 +26,7 @@ export type SignalsServiceOptions = { /** @public */ export type SignalPayload = { recipients: - | { type: 'user'; entityRefs: string | string[] } + | { type: 'user'; entityRef: string | string[] } | { type: 'broadcast' }; channel: string; message: TMessage;