stream-chat-angular 4.23.2 → 4.25.0

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

@@ -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> | undefined>;
+    messageActionsBoxItemTemplate$: BehaviorSubject<TemplateRef<MessageActionBoxItemContext<import("./types").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))
      *

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

@@ -2,7 +2,7 @@ import { TemplateRef, OnChanges, SimpleChanges, OnDestroy, OnInit, ChangeDetecto
 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 } from '../types';
+import { AttachmentListContext, MentionTemplateContext, MessageActionsBoxContext, MessageReactionsContext, DefaultStreamChatGenerics, StreamMessage, DeliveredStatusContext, SendingStatusContext, ReadStatusContext, CustomMessageActionItem } from '../types';
 import { CustomTemplatesService } from '../custom-templates.service';
 import { ThemeService } from '../theme.service';
 import { NgxPopperjsTriggers, NgxPopperjsPlacements } from 'ngx-popperjs';
@@ -40,6 +40,10 @@ export declare class MessageComponent implements OnInit, OnChanges, OnDestroy {
      * Highlighting is used to add visual emphasize to a message when jumping to the message
      */
     isHighlighted: boolean;
+    /**
+     * A list of custom message actions to be displayed in the action box
+     */
+    customActions: CustomMessageActionItem[];
     readonly themeVersion: '1' | '2';
     canReceiveReadEvents: boolean | undefined;
     canReactToMessage: boolean | undefined;
@@ -102,6 +106,6 @@ export declare class MessageComponent implements OnInit, OnChanges, OnDestroy {
     private fixEmojiDisplay;
     private wrapLinskWithAnchorTag;
     static ɵfac: i0.ɵɵFactoryDeclaration<MessageComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<MessageComponent, "stream-message", never, { "message": "message"; "enabledMessageActions": "enabledMessageActions"; "isLastSentMessage": "isLastSentMessage"; "mode": "mode"; "isHighlighted": "isHighlighted"; }, {}, never, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MessageComponent, "stream-message", never, { "message": "message"; "enabledMessageActions": "enabledMessageActions"; "isLastSentMessage": "isLastSentMessage"; "mode": "mode"; "isHighlighted": "isHighlighted"; "customActions": "customActions"; }, {}, never, never>;
 }
 export {};

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

@@ -4,7 +4,7 @@ import { ChannelService } from '../channel.service';
 import { ChatClientService } from '../chat-client.service';
 import { CustomTemplatesService } from '../custom-templates.service';
 import { NotificationService } from '../notification.service';
-import { MessageActionBoxItemContext, MessageActionItem, MessageInputContext, ModalContext, StreamMessage } from '../types';
+import { CustomMessageActionItem, MessageActionBoxItemContext, MessageActionItem, MessageInputContext, ModalContext, StreamMessage } from '../types';
 import * as i0 from "@angular/core";
 /**
  * The `MessageActionsBox` component displays a list of message actions (i.e edit), that can be opened or closed. You can find the [list of the supported actions](../concepts/message-interactions.mdx) in the message interaction guide.
@@ -31,6 +31,10 @@ export declare class MessageActionsBoxComponent implements OnChanges, OnDestroy
      * The list of [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) that are enabled for the current user, the list of [supported interactions](../concepts/message-interactions.mdx) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI.
      */
     enabledActions: string[];
+    /**
+     * A list of custom message actions to be displayed in the action box
+     */
+    customActions: CustomMessageActionItem[];
     /**
      * The number of authorized actions (it can be less or equal than the number of enabled actions)
      */
@@ -44,7 +48,7 @@ export declare class MessageActionsBoxComponent implements OnChanges, OnDestroy
     messageActionItemTemplate: TemplateRef<MessageActionBoxItemContext> | undefined;
     modalTemplate: TemplateRef<ModalContext> | undefined;
     subscriptions: Subscription[];
-    visibleMessageActionItems: MessageActionItem[];
+    visibleMessageActionItems: (MessageActionItem | CustomMessageActionItem)[];
     sendMessage$: Observable<void>;
     private readonly messageActionItems;
     private modalContent;
@@ -52,12 +56,12 @@ export declare class MessageActionsBoxComponent implements OnChanges, OnDestroy
     constructor(chatClientService: ChatClientService, notificationService: NotificationService, channelService: ChannelService, customTemplatesService: CustomTemplatesService);
     ngOnChanges(changes: SimpleChanges): void;
     ngOnDestroy(): void;
-    getActionLabel(actionLabelOrTranslationKey: (() => string) | string): string;
+    getActionLabel(actionLabelOrTranslationKey: ((message: StreamMessage) => string) | string): string;
     sendClicked(): void;
     modalClosed: () => void;
     getMessageInputContext(): MessageInputContext;
     getEditModalContext(): ModalContext;
-    trackByActionName(_: number, item: MessageActionItem): "delete" | "flag" | "quote" | "pin" | "edit";
+    trackByActionName(_: number, item: MessageActionItem | CustomMessageActionItem): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<MessageActionsBoxComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<MessageActionsBoxComponent, "stream-message-actions-box", never, { "isOpen": "isOpen"; "isMine": "isMine"; "message": "message"; "enabledActions": "enabledActions"; }, { "displayedActionsCount": "displayedActionsCount"; "isEditing": "isEditing"; }, never, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MessageActionsBoxComponent, "stream-message-actions-box", never, { "isOpen": "isOpen"; "isMine": "isMine"; "message": "message"; "enabledActions": "enabledActions"; "customActions": "customActions"; }, { "displayedActionsCount": "displayedActionsCount"; "isEditing": "isEditing"; }, never, never>;
 }

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

@@ -1,7 +1,7 @@
 import { AfterViewChecked, AfterViewInit, OnChanges, OnDestroy, OnInit, SimpleChanges, TemplateRef } from '@angular/core';
 import { ChannelService } from '../channel.service';
 import { Observable } from 'rxjs';
-import { MessageContext, StreamMessage, TypingIndicatorContext } from '../types';
+import { MessageContext, StreamMessage, TypingIndicatorContext, CustomMessageActionItem } from '../types';
 import { ChatClientService } from '../chat-client.service';
 import { GroupStyle } from './group-styles';
 import { UserResponse } from 'stream-chat';
@@ -31,6 +31,10 @@ export declare class MessageListComponent implements AfterViewChecked, OnChanges
      * You can hide the "jump to latest" button while scrolling. A potential use-case for this input would be to [workaround a known issue on iOS Safar](https://github.com/GetStream/stream-chat-angular/issues/418)
      */
     hideJumpToLatestButtonDuringScroll: boolean;
+    /**
+     * A list of custom message actions to be displayed in the message action box
+     */
+    customMessageActions: CustomMessageActionItem<any>[];
     messageTemplate: TemplateRef<MessageContext> | undefined;
     messages$: Observable<StreamMessage[]>;
     enabledMessageActions: string[];
@@ -86,5 +90,5 @@ export declare class MessageListComponent implements AfterViewChecked, OnChanges
     private scrollToLatestMessage;
     private newMessageReceived;
     static ɵfac: i0.ɵɵFactoryDeclaration<MessageListComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<MessageListComponent, "stream-message-list", never, { "mode": "mode"; "direction": "direction"; "messageOptionsTrigger": "messageOptionsTrigger"; "hideJumpToLatestButtonDuringScroll": "hideJumpToLatestButtonDuringScroll"; }, {}, never, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<MessageListComponent, "stream-message-list", never, { "mode": "mode"; "direction": "direction"; "messageOptionsTrigger": "messageOptionsTrigger"; "hideJumpToLatestButtonDuringScroll": "hideJumpToLatestButtonDuringScroll"; "customMessageActions": "customMessageActions"; }, {}, never, never>;
 }

package/lib/types.d.ts

@@ -110,6 +110,7 @@ export declare type MessageContext = {
     isLastSentMessage: boolean | undefined;
     mode: 'thread' | 'main';
     isHighlighted: boolean;
+    customActions: CustomMessageActionItem[];
 };
 export declare type ChannelActionsContext<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = {
     channel: Channel<T>;
@@ -150,19 +151,29 @@ export declare type MessageActionsBoxContext = {
     isMine: boolean;
     message: StreamMessage | undefined;
     enabledActions: string[];
+    customActions: CustomMessageActionItem[];
+    /**
+     * @deprecated because the name contains typos, use the `displayedActionsCountChangeHandler` instead
+     */
     displayedActionsCountChaneHanler: (count: number) => any;
+    displayedActionsCountChangeHandler: (count: number) => any;
     isEditingChangeHandler: (isEditing: boolean) => any;
 };
-export declare type MessageActionBoxItemContext = {
-    actionName: 'quote' | 'pin' | 'flag' | 'edit' | 'delete';
-    actionLabelOrTranslationKey: (() => string) | string;
+export declare type MessageActionBoxItemContext<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = {
+    actionName: 'quote' | 'pin' | 'flag' | 'edit' | 'delete' | string;
+    actionLabelOrTranslationKey: ((message: StreamMessage<T>) => string) | string;
     actionHandler: () => any;
 };
-export declare type MessageActionItem = {
+declare type MessageActionItemBase<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = {
+    actionLabelOrTranslationKey: ((message: StreamMessage<T>) => string) | string;
+    isVisible: (enabledActions: string[], isMine: boolean, message: StreamMessage<T>) => boolean;
+    actionHandler: (message: StreamMessage<T>, isMine: boolean) => any;
+};
+export declare type MessageActionItem<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = MessageActionItemBase<T> & {
     actionName: 'quote' | 'pin' | 'flag' | 'edit' | 'delete';
-    actionLabelOrTranslationKey: (() => string) | string;
-    isVisible: (enabledActions: string[], isMine: boolean, message: StreamMessage) => boolean;
-    actionHandler: (message: StreamMessage, isMine: boolean) => any;
+};
+export declare type CustomMessageActionItem<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = MessageActionItemBase<T> & {
+    actionName: string;
 };
 export declare type MessageReactionsContext = {
     messageId: string | undefined;
@@ -220,3 +231,4 @@ export declare type CustomAttachmentUploadContext = {
 export declare type AttachmentContext = {
     attachment: Attachment<DefaultStreamChatGenerics>;
 };
+export {};

package/package.json

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

package/src/assets/version.ts

@@ -1 +1 @@
-export const version = '4.23.2';
+export const version = '4.25.0';