stream-chat-angular 4.56.0 → 4.58.0

package/lib/custom-templates.service.d.ts

@@ -1,13 +1,13 @@
 import { TemplateRef } from '@angular/core';
 import { BehaviorSubject } from 'rxjs';
-import { AttachmentContext, AttachmentListContext, AttachmentPreviewListContext, AvatarContext, ChannelActionsContext, ChannelHeaderInfoContext, ChannelPreviewContext, CommandAutocompleteListItemContext, CustomAttachmentUploadContext, DateSeparatorContext, DeliveredStatusContext, EmojiPickerContext, IconContext, LoadingIndicatorContext, MentionAutcompleteListItemContext, MentionTemplateContext, MessageActionBoxItemContext, MessageActionsBoxContext, MessageContext, MessageInputContext, MessageReactionsContext, ModalContext, NotificationContext, ReadStatusContext, SendingStatusContext, SystemMessageContext, ThreadHeaderContext, TypingIndicatorContext } from './types';
+import { AttachmentContext, AttachmentListContext, AttachmentPreviewListContext, AvatarContext, ChannelActionsContext, ChannelHeaderInfoContext, ChannelPreviewContext, CommandAutocompleteListItemContext, CustomAttachmentUploadContext, CustomMetadataContext, DateSeparatorContext, DefaultStreamChatGenerics, DeliveredStatusContext, EmojiPickerContext, IconContext, LoadingIndicatorContext, MentionAutcompleteListItemContext, MentionTemplateContext, MessageActionBoxItemContext, MessageActionsBoxContext, MessageContext, MessageInputContext, MessageReactionsContext, ModalContext, NotificationContext, ReadStatusContext, SendingStatusContext, SystemMessageContext, ThreadHeaderContext, TypingIndicatorContext } from './types';
 import * as i0 from "@angular/core";
 /**
  * A central location for registering your custom templates to override parts of the chat application.
  *
  * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
  */
-export declare class CustomTemplatesService {
+export declare class CustomTemplatesService<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> {
     /**
      * The autocomplete list item template for mentioning users (used in the [`AutocompleteTextareaComponent`](../components/AutocompleteTextareaComponent.mdx))
      */
@@ -23,7 +23,7 @@ export declare class CustomTemplatesService {
      *
      * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
      */
-    channelPreviewTemplate$: BehaviorSubject<TemplateRef<ChannelPreviewContext<import("./types").DefaultStreamChatGenerics>> | undefined>;
+    channelPreviewTemplate$: BehaviorSubject<TemplateRef<ChannelPreviewContext<DefaultStreamChatGenerics>> | undefined>;
     /**
      * The message input template used when editing a message (instead of the [default message input](../components/MessageInputComponent.mdx))
      *
@@ -59,7 +59,7 @@ export declare class CustomTemplatesService {
      *
      * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
      */
-    channelActionsTemplate$: BehaviorSubject<TemplateRef<ChannelActionsContext<import("./types").DefaultStreamChatGenerics>> | undefined>;
+    channelActionsTemplate$: BehaviorSubject<TemplateRef<ChannelActionsContext<DefaultStreamChatGenerics>> | undefined>;
     /**
      * The template used to display attachments of a [message](../components/MessageComponent.mdx) (instead of the [default attachment list](../components/AttachmentListComponent.mdx))
      *
@@ -101,7 +101,7 @@ export declare class CustomTemplatesService {
      *
      * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
      */
-    messageActionsBoxItemTemplate$: BehaviorSubject<TemplateRef<MessageActionBoxItemContext<import("./types").DefaultStreamChatGenerics>> | undefined>;
+    messageActionsBoxItemTemplate$: BehaviorSubject<TemplateRef<MessageActionBoxItemContext<DefaultStreamChatGenerics>> | undefined>;
     /**
      * The template used to display the reactions of a [message](../components/MessageComponent.mdx), and the selector to add a reaction to a message (instead of the [default message reactions component](../components/MessageReactionsComponent.mdx))
      *
@@ -129,27 +129,39 @@ export declare class CustomTemplatesService {
     /**
      * The template used for displaying the delivered state of the message inside the [message component](../components/MessageComponent.mdx)
      *
+     * Displayed for the last message sent by the current user, if the message isn't yet read by anyone
+     *
      * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
      */
     deliveredStatusTemplate$: BehaviorSubject<TemplateRef<DeliveredStatusContext> | undefined>;
     /**
      * The template used for displaying the sending state of the message inside the [message component](../components/MessageComponent.mdx)
      *
+     * Displayed for the last message sent by the current user, if the message is currently being sent
+     *
      * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
      */
     sendingStatusTemplate$: BehaviorSubject<TemplateRef<SendingStatusContext> | undefined>;
     /**
      * The template used for displaying the sent state of the message inside the [message component](../components/MessageComponent.mdx)
      *
+     * Displayed for the last message sent by the current user, if the message is read at least by one user
+     *
      * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
      */
     readStatusTemplate$: BehaviorSubject<TemplateRef<ReadStatusContext> | undefined>;
+    /**
+     * Template to display custom metadata inside [message component](../components/MessageComponent.mdx)
+     *
+     * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
+     */
+    customMessageMetadataTemplate$: BehaviorSubject<TemplateRef<CustomMetadataContext<T>> | undefined>;
     /**
      * The template used to display additional information about a channel under the channel name inside the [channel header component](../components/ChannelHeaderComponent.mdx)
      *
      * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
      */
-    channelHeaderInfoTemplate$: BehaviorSubject<TemplateRef<ChannelHeaderInfoContext<import("./types").DefaultStreamChatGenerics>> | undefined>;
+    channelHeaderInfoTemplate$: BehaviorSubject<TemplateRef<ChannelHeaderInfoContext<DefaultStreamChatGenerics>> | undefined>;
     /**
      * The template used for displaying file upload/attachment selector inside the [message input](../components/MessageInputComponent.mdx)
      *
@@ -201,6 +213,6 @@ export declare class CustomTemplatesService {
      */
     emptyThreadMessageListPlaceholder$: BehaviorSubject<TemplateRef<void> | undefined>;
     constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<CustomTemplatesService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<CustomTemplatesService>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<CustomTemplatesService<any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<CustomTemplatesService<any>>;
 }

package/lib/message/message.component.d.ts

@@ -2,7 +2,7 @@ import { OnChanges, SimpleChanges, OnDestroy, OnInit, ChangeDetectorRef, NgZone,
 import { UserResponse } from 'stream-chat';
 import { ChannelService } from '../channel.service';
 import { ChatClientService } from '../chat-client.service';
-import { AttachmentListContext, MentionTemplateContext, MessageActionsBoxContext, MessageReactionsContext, DefaultStreamChatGenerics, StreamMessage, DeliveredStatusContext, SendingStatusContext, ReadStatusContext, CustomMessageActionItem, SystemMessageContext } from '../types';
+import { AttachmentListContext, MentionTemplateContext, MessageActionsBoxContext, MessageReactionsContext, DefaultStreamChatGenerics, StreamMessage, DeliveredStatusContext, SendingStatusContext, ReadStatusContext, CustomMessageActionItem, SystemMessageContext, CustomMetadataContext } from '../types';
 import { CustomTemplatesService } from '../custom-templates.service';
 import { ThemeService } from '../theme.service';
 import { NgxPopperjsTriggers, NgxPopperjsPlacements } from 'ngx-popperjs';
@@ -96,6 +96,7 @@ export declare class MessageComponent implements OnInit, OnChanges, OnDestroy, A
     ngOnChanges(changes: SimpleChanges): void;
     ngAfterViewInit(): void;
     ngOnDestroy(): void;
+    messageActionsClicked(): void;
     getAttachmentListContext(): AttachmentListContext;
     getMessageContext(): SystemMessageContext;
     getQuotedMessageAttachmentListContext(): AttachmentListContext;
@@ -107,10 +108,10 @@ export declare class MessageComponent implements OnInit, OnChanges, OnDestroy, A
     getDeliveredStatusContext(): DeliveredStatusContext;
     getSendingStatusContext(): SendingStatusContext;
     getReadStatusContext(): ReadStatusContext;
+    getMessageMetadataContext(): CustomMetadataContext;
     jumpToMessage(messageId: string, parentMessageId?: string): void;
     displayTranslatedMessage(): void;
     displayOriginalMessage(): void;
-    mouseLeft(): void;
     private createMessageParts;
     private getMessageContent;
     private fixEmojiDisplay;

package/lib/message-actions-box/message-actions-box.component.d.ts

@@ -47,7 +47,7 @@ export declare class MessageActionsBoxComponent implements OnInit, OnChanges, On
     /**
      * An event which emits `true` if the edit message modal is open, and `false` when it is closed.
      *
-     * @deprecated components should use `messageReactionsService.getAuthorizedMessageActionsCount` method
+     * @deprecated components should use `messageReactionsService.messageToEdit$` Observable
      *
      * More information: https://getstream.io/chat/docs/sdk/angular/services/MessageActionsService
      */

package/lib/message-actions.service.d.ts

@@ -1,5 +1,5 @@
 import { BehaviorSubject } from 'rxjs';
-import { CustomMessageActionItem, DefaultStreamChatGenerics, MessageActionItem, StreamMessage } from './types';
+import { CustomMessageActionItem, DefaultStreamChatGenerics, MessageActionItem, MessageActionsClickDetails, StreamMessage } from './types';
 import { ChatClientService } from './chat-client.service';
 import { NotificationService } from './notification.service';
 import { ChannelService } from './channel.service';
@@ -23,6 +23,10 @@ export declare class MessageActionsService<T extends DefaultStreamChatGenerics =
      * You can pass your own custom actions that will be displayed inside the built-in message actions component
      */
     customActions$: BehaviorSubject<CustomMessageActionItem<DefaultStreamChatGenerics>[]>;
+    /**
+     * By default the [`MessageComponent`](../../components/MessageComponent) will display the [`MessageActionsBoxComponent`](../../components/MessageActionsBoxComponent). You can override that behavior by providing your own event handler.
+     */
+    customActionClickHandler?: (details: MessageActionsClickDetails<T>) => void;
     constructor(chatClientService: ChatClientService, notificationService: NotificationService, channelService: ChannelService);
     /**
      * This method returns how many authorized actions are available to the given message

package/lib/types.d.ts

@@ -240,6 +240,9 @@ export declare type DeliveredStatusContext = {
 export declare type SendingStatusContext = {
     message: StreamMessage;
 };
+export declare type CustomMetadataContext<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = {
+    message: StreamMessage<T>;
+};
 export declare type ReadStatusContext = {
     message: StreamMessage;
     readByText: string;
@@ -287,4 +290,10 @@ export declare type MessageReactionClickDetails = {
     messageId: string;
     reactionType: string;
 };
+export declare type MessageActionsClickDetails<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = {
+    message: StreamMessage<T>;
+    enabledActions: string[];
+    isMine: boolean;
+    customActions: CustomMessageActionItem[];
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat-angular",
-  "version": "4.56.0",
+  "version": "4.58.0",
   "description": "Angular components to create chat conversations or livestream style chat",
   "author": "GetStream",
   "homepage": "https://getstream.io/chat/",