feat: Rename ChatClient.notification$ to events$

**BREAKING CHANGE** `ChatClient.notification$` renamed to `events$`

Author: szuperaz

docusaurus/docs/Angular/basics/upgrade-v2.mdx

@@ -55,3 +55,11 @@ The following inputs are removed:
 | The autocomplete list item template for mentioning users    | `MessageInputConfigService.mentionAutocompleteItemTemplate`     | [`CustomTemplatesService.mentionAutocompleteItemTemplate$`](../services/CustomTemplatesService.mdx) |
 | The template for emoji picker                               | `MessageInputConfigService.emojiPickerTemplate`                 | [`CustomTemplatesService.emojiPickerTemplate$`](../services/CustomTemplatesService.mdx)             |
 | The template for channel actions                            | `ChannelHeaderComponent.channelActionsTemplate`                 | [`CustomTemplatesService.channelActionsTemplate$`](../services/CustomTemplatesService.mdx)          |
+
+## `ChatClient.notification$` renamed to `events$`
+
+The `notification$` stream on the [`ChatClientService`](../services/ChatClientService.mdx) was renamed to `events$` as it better represents what this Observable does.
+
+The `events$` stream emits the received [client, notification and user presence events](https://getstream.io/chat/docs/javascript/event_object/?language=javascript).
+
+The payload of this Observable was renamed from `Notification` to `ClientEvent`.

docusaurus/docs/Angular/code-examples/channel-invites.mdx

@@ -441,26 +441,20 @@ To override the default behavior create a custom event handler in `app.component
 
 ```typescript
 private customAddedToChannelNotificationHandler(
-    notification: Notification,
+    clientEvent: ClientEvent,
     channelListSetter: (channels: (Channel | ChannelResponse)[]) => void
   ): void {
     let channels!: Channel[];
     this.channelService.channels$
       .pipe(take(1))
       .subscribe((c) => (channels = c || []));
-    if (notification.event.member?.invited) {
+    if (clientEvent.event.member?.invited) {
       return;
     }
-    channelListSetter([notification!.event!.channel!, ...channels]);
+    channelListSetter([clientEvent!.event!.channel!, ...channels]);
   }
 ```
 
-:::important
-Make sure to add the following import to your code (your IDE might not be able to add this automatically):
-
-`import { Notification } from 'stream-chat-angular';`
-:::
-
 Now register the handler to the [channel service](../services/ChannelService.mdx) in the constructor of `app.component.ts`:
 
 ```
@@ -475,7 +469,7 @@ The `notification.invite_accepted` event emitted by the [`ChatClientService`](..
 Add this to the constructor of your `app.component.ts`:
 
 ```typescript
-this.chatService.notification$
+this.chatService.events$
   .pipe(filter((n) => n.eventType === "notification.invite_accepted"))
   .subscribe(() => {
     this.channelService.reset();

docusaurus/docs/Angular/concepts/change-detection.mdx

@@ -28,7 +28,7 @@ export class AppComponent implements OnInit {
   ) {}
 
   ngOnInit(): void {
-    this.chatService.notification$
+    this.chatService.events$
       .pipe(filter((n) => n.eventType === "notification.added_to_channel"))
       .subscribe((notification) => {
         // reenter Angular's change detection zone
@@ -49,7 +49,7 @@ If you were to display the notification without reentering Angular's zone, the `
 
 You need to reenter Angular's change detection zone when
 
-- you subscribe to events using the [`notification$`](../services/ChatClientService.mdx/#notification) Observable of the `ChatClientService`
+- you subscribe to events using the [`events$`](../services/ChatClientService.mdx/#notification) Observable of the `ChatClientService`
 - you subscribe to channel events
 
 For example the [`ChannelPreview`](../components/ChannelPreviewComponent.mdx) component needs to subscribe to the `message.read` channel events to know if the channel has unread messages and reenter Angular's zone when an event is received:

projects/stream-chat-angular/src/lib/channel.service.spec.ts

@@ -11,7 +11,7 @@ import {
   UserResponse,
 } from 'stream-chat';
 import { ChannelService } from './channel.service';
-import { ChatClientService, Notification } from './chat-client.service';
+import { ChatClientService, ClientEvent } from './chat-client.service';
 import {
   generateMockChannels,
   MockChannel,
@@ -29,7 +29,7 @@ describe('ChannelService', () => {
     deleteMessage: jasmine.Spy;
     userID: string;
   };
-  let notification$: Subject<Notification>;
+  let events$: Subject<ClientEvent>;
   let connectionState$: Subject<'online' | 'offline'>;
   let init: (
     c?: Channel[],
@@ -51,14 +51,14 @@ describe('ChannelService', () => {
       deleteMessage: jasmine.createSpy(),
       userID: user.id,
     };
-    notification$ = new Subject();
+    events$ = new Subject();
     TestBed.configureTestingModule({
       providers: [
         {
           provide: ChatClientService,
           useValue: {
             chatClient: { ...mockChatClient, user },
-            notification$,
+            events$,
             connectionState$,
           },
         },
@@ -625,7 +625,7 @@ describe('ChannelService', () => {
     spyOn(newChannel, 'on').and.callThrough();
     const spy = jasmine.createSpy();
     service.channels$.subscribe(spy);
-    notification$.next({
+    events$.next({
       eventType: 'notification.added_to_channel',
       event: { channel: newChannel } as any as Event,
     });
@@ -650,7 +650,7 @@ describe('ChannelService', () => {
     spyOn(channel, 'on').and.callThrough();
     const spy = jasmine.createSpy();
     service.channels$.subscribe(spy);
-    notification$.next({
+    events$.next({
       eventType: 'notification.message_new',
       event: { channel: channel } as any as Event,
     });
@@ -673,7 +673,7 @@ describe('ChannelService', () => {
     const spy = jasmine.createSpy();
     service.channels$.subscribe(spy);
     spyOn(service, 'setAsActiveChannel');
-    notification$.next({
+    events$.next({
       eventType: 'notification.removed_from_channel',
       event: { channel: channel } as any as Event,
     });
@@ -695,7 +695,7 @@ describe('ChannelService', () => {
     const spy = jasmine.createSpy();
     service.channels$.subscribe(spy);
     spyOn(service, 'setAsActiveChannel');
-    notification$.next({
+    events$.next({
       eventType: 'notification.removed_from_channel',
       event: { channel: channel } as any as Event,
     });
@@ -718,7 +718,7 @@ describe('ChannelService', () => {
     const channelsSpy = jasmine.createSpy();
     service.channels$.subscribe(channelsSpy);
     channelsSpy.calls.reset();
-    notification$.next({
+    events$.next({
       eventType: 'notification.message_new',
       event: event,
     });
@@ -735,7 +735,7 @@ describe('ChannelService', () => {
     await init();
     const spy = jasmine
       .createSpy()
-      .and.callFake((_: Notification, setter: (channels: Channel[]) => []) =>
+      .and.callFake((_: ClientEvent, setter: (channels: Channel[]) => []) =>
         setter([])
       );
     service.customAddedToChannelNotificationHandler = spy;
@@ -747,7 +747,7 @@ describe('ChannelService', () => {
     const channelsSpy = jasmine.createSpy();
     service.channels$.subscribe(channelsSpy);
     channelsSpy.calls.reset();
-    notification$.next({
+    events$.next({
       eventType: 'notification.added_to_channel',
       event: event,
     });
@@ -772,7 +772,7 @@ describe('ChannelService', () => {
     const channelsSpy = jasmine.createSpy();
     service.channels$.subscribe(channelsSpy);
     channelsSpy.calls.reset();
-    notification$.next({
+    events$.next({
       eventType: 'notification.removed_from_channel',
       event: event,
     });

projects/stream-chat-angular/src/lib/channel.service.thread.spec.ts

@@ -11,7 +11,7 @@ import {
   UserResponse,
 } from 'stream-chat';
 import { ChannelService } from './channel.service';
-import { ChatClientService, Notification } from './chat-client.service';
+import { ChatClientService, ClientEvent } from './chat-client.service';
 import {
   generateMockChannels,
   MockChannel,
@@ -29,7 +29,7 @@ describe('ChannelService - threads', () => {
     deleteMessage: jasmine.Spy;
     userID: string;
   };
-  let notification$: Subject<Notification>;
+  let events$: Subject<ClientEvent>;
   let connectionState$: Subject<'online' | 'offline'>;
   let init: (
     c?: Channel[],
@@ -51,14 +51,14 @@ describe('ChannelService - threads', () => {
       deleteMessage: jasmine.createSpy(),
       userID: user.id,
     };
-    notification$ = new Subject();
+    events$ = new Subject();
     TestBed.configureTestingModule({
       providers: [
         {
           provide: ChatClientService,
           useValue: {
             chatClient: { ...mockChatClient, user },
-            notification$,
+            events$,
             connectionState$,
           },
         },

projects/stream-chat-angular/src/lib/channel.service.ts

@@ -19,7 +19,7 @@ import {
   UpdatedMessage,
   UserResponse,
 } from 'stream-chat';
-import { ChatClientService, Notification } from './chat-client.service';
+import { ChatClientService, ClientEvent } from './chat-client.service';
 import { createMessagePreview } from './message-preview';
 import { getReadBy } from './read-by';
 import { AttachmentUpload, MessageReactionType, StreamMessage } from './types';
@@ -105,21 +105,21 @@ export class ChannelService {
    * Custom event handler to call if a new message received from a channel that is not being watched, provide an event handler if you want to override the [default channel list ordering](./ChannelService.mdx/#channels)
    */
   customNewMessageNotificationHandler?: (
-    notification: Notification,
+    clientEvent: ClientEvent,
     channelListSetter: (channels: (Channel | ChannelResponse)[]) => void
   ) => void;
   /**
    * Custom event handler to call when the user is added to a channel, provide an event handler if you want to override the [default channel list ordering](./ChannelService.mdx/#channels)
    */
   customAddedToChannelNotificationHandler?: (
-    notification: Notification,
+    clientEvent: ClientEvent,
     channelListSetter: (channels: (Channel | ChannelResponse)[]) => void
   ) => void;
   /**
    * Custom event handler to call when the user is removed from a channel, provide an event handler if you want to override the [default channel list ordering](./ChannelService.mdx/#channels)
    */
   customRemovedFromChannelNotificationHandler?: (
-    notification: Notification,
+    clientEvent: ClientEvent,
     channelListSetter: (channels: (Channel | ChannelResponse)[]) => void
   ) => void;
   /**
@@ -408,7 +408,7 @@ export class ChannelService {
     };
     this.sort = sort || { last_message_at: -1, updated_at: -1 };
     await this.queryChannels();
-    this.chatClientService.notification$.subscribe(
+    this.chatClientService.events$.subscribe(
       (notification) => void this.handleNotification(notification)
     );
   }
@@ -692,17 +692,17 @@ export class ChannelService {
     }
   }
 
-  private handleNotification(notification: Notification) {
-    switch (notification.eventType) {
+  private handleNotification(clientEvent: ClientEvent) {
+    switch (clientEvent.eventType) {
       case 'notification.message_new': {
         this.ngZone.run(() => {
           if (this.customNewMessageNotificationHandler) {
             this.customNewMessageNotificationHandler(
-              notification,
+              clientEvent,
               this.channelListSetter
             );
           } else {
-            this.handleNewMessageNotification(notification);
+            this.handleNewMessageNotification(clientEvent);
           }
         });
         break;
@@ -711,11 +711,11 @@ export class ChannelService {
         this.ngZone.run(() => {
           if (this.customAddedToChannelNotificationHandler) {
             this.customAddedToChannelNotificationHandler(
-              notification,
+              clientEvent,
               this.channelListSetter
             );
           } else {
-            this.handleAddedToChannelNotification(notification);
+            this.handleAddedToChannelNotification(clientEvent);
           }
         });
         break;
@@ -724,31 +724,31 @@ export class ChannelService {
         this.ngZone.run(() => {
           if (this.customRemovedFromChannelNotificationHandler) {
             this.customRemovedFromChannelNotificationHandler(
-              notification,
+              clientEvent,
               this.channelListSetter
             );
           } else {
-            this.handleRemovedFromChannelNotification(notification);
+            this.handleRemovedFromChannelNotification(clientEvent);
           }
         });
       }
     }
   }
 
-  private handleRemovedFromChannelNotification(notification: Notification) {
-    const channelIdToBeRemoved = notification.event.channel!.cid;
+  private handleRemovedFromChannelNotification(clientEvent: ClientEvent) {
+    const channelIdToBeRemoved = clientEvent.event.channel!.cid;
     this.removeChannelsFromChannelList([channelIdToBeRemoved]);
   }
 
-  private handleNewMessageNotification(notification: Notification) {
-    if (notification.event.channel) {
-      this.addChannelsFromNotification([notification.event.channel]);
+  private handleNewMessageNotification(clientEvent: ClientEvent) {
+    if (clientEvent.event.channel) {
+      this.addChannelsFromNotification([clientEvent.event.channel]);
     }
   }
 
-  private handleAddedToChannelNotification(notification: Notification) {
-    if (notification.event.channel) {
-      this.addChannelsFromNotification([notification.event.channel]);
+  private handleAddedToChannelNotification(clientEvent: ClientEvent) {
+    if (clientEvent.event.channel) {
+      this.addChannelsFromNotification([clientEvent.event.channel]);
     }
   }
 

projects/stream-chat-angular/src/lib/chat-client.service.spec.ts

@@ -87,7 +87,7 @@ describe('ChatClientService', () => {
 
   it('should watch for added to channel events', () => {
     const spy = jasmine.createSpy();
-    service.notification$.subscribe(spy);
+    service.events$.subscribe(spy);
     const event = {
       id: 'mockevent',
       type: 'notification.added_to_channel',
@@ -102,7 +102,7 @@ describe('ChatClientService', () => {
 
   it('should watch for new message events', () => {
     const spy = jasmine.createSpy();
-    service.notification$.subscribe(spy);
+    service.events$.subscribe(spy);
     const event = {
       id: 'mockevent',
       type: 'notification.message_new',
@@ -117,7 +117,7 @@ describe('ChatClientService', () => {
 
   it('should watch for removed from channel events', () => {
     const spy = jasmine.createSpy();
-    service.notification$.subscribe(spy);
+    service.events$.subscribe(spy);
     const event = {
       id: 'mockevent',
       type: 'notification.removed_from_channel',