stream-chat-angular 5.4.3 → 5.5.0

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

@@ -1,17 +1,19 @@
-import { EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
+import { EventEmitter, OnChanges, OnDestroy, OnInit, SimpleChanges, TemplateRef } from '@angular/core';
 import { Action, Attachment } from 'stream-chat';
-import { ModalContext, DefaultStreamChatGenerics, AttachmentConfigration, VideoAttachmentConfiguration, ImageAttachmentConfiguration, AttachmentContext } from '../types';
+import { ModalContext, DefaultStreamChatGenerics, AttachmentConfigration, VideoAttachmentConfiguration, ImageAttachmentConfiguration, AttachmentContext, CustomAttachmentListContext } from '../types';
 import { ChannelService } from '../channel.service';
 import { CustomTemplatesService } from '../custom-templates.service';
 import { AttachmentConfigurationService } from '../attachment-configuration.service';
+import { MessageService } from '../message.service';
 import * as i0 from "@angular/core";
 /**
  * The `AttachmentList` component displays the attachments of a message
  */
-export declare class AttachmentListComponent implements OnChanges {
+export declare class AttachmentListComponent implements OnChanges, OnInit, OnDestroy {
     readonly customTemplatesService: CustomTemplatesService;
     private channelService;
     private attachmentConfigurationService;
+    private messageService;
     /**
      * The id of the message the attachments belong to
      */
@@ -30,12 +32,17 @@ export declare class AttachmentListComponent implements OnChanges {
     readonly imageModalStateChange: EventEmitter<"closed" | "opened">;
     class: string;
     orderedAttachments: Attachment<DefaultStreamChatGenerics>[];
+    customAttachments: Attachment<DefaultStreamChatGenerics>[];
     imagesToView: Attachment<DefaultStreamChatGenerics>[];
     imagesToViewCurrentIndex: number;
+    customAttachmentsTemplate?: TemplateRef<CustomAttachmentListContext>;
     private modalContent;
     private attachmentConfigurations;
-    constructor(customTemplatesService: CustomTemplatesService, channelService: ChannelService, attachmentConfigurationService: AttachmentConfigurationService);
+    private subscriptions;
+    constructor(customTemplatesService: CustomTemplatesService, channelService: ChannelService, attachmentConfigurationService: AttachmentConfigurationService, messageService: MessageService);
+    ngOnInit(): void;
     ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
     trackByUrl(_: number, attachment: Attachment): {} | undefined;
     isImage(attachment: Attachment): boolean;
     isSvg(attachment: Attachment): boolean;

package/lib/attachment-preview-list/attachment-preview-list.component.d.ts

@@ -1,11 +1,16 @@
-import { EventEmitter } from '@angular/core';
+import { EventEmitter, OnDestroy, OnInit, TemplateRef } from '@angular/core';
 import { Observable } from 'rxjs';
-import { AttachmentUpload } from '../types';
+import { AttachmentUpload, CustomAttachmentPreviewListContext } from '../types';
+import { CustomTemplatesService } from '../custom-templates.service';
+import { AttachmentService } from '../attachment.service';
+import { Attachment } from 'stream-chat';
 import * as i0 from "@angular/core";
 /**
  * The `AttachmentPreviewList` component displays a preview of the attachments uploaded to a message. Users can delete attachments using the preview component, or retry upload if it failed previously.
  */
-export declare class AttachmentPreviewListComponent {
+export declare class AttachmentPreviewListComponent implements OnInit, OnDestroy {
+    private customTemplateService;
+    readonly attachmentService: AttachmentService;
     /**
      * A stream that emits the current file uploads and their states
      */
@@ -18,7 +23,12 @@ export declare class AttachmentPreviewListComponent {
      * An output to notify the parent component if the user wants to delete a file
      */
     readonly deleteAttachment: EventEmitter<AttachmentUpload<import("../types").DefaultStreamChatGenerics>>;
-    constructor();
+    customAttachments: Attachment[];
+    customAttachmentsPreview?: TemplateRef<CustomAttachmentPreviewListContext>;
+    private subscriptions;
+    constructor(customTemplateService: CustomTemplatesService, attachmentService: AttachmentService);
+    ngOnInit(): void;
+    ngOnDestroy(): void;
     attachmentUploadRetried(file: File): void;
     attachmentDeleted(upload: AttachmentUpload): void;
     trackByFile(_: number, item: AttachmentUpload): File;

package/lib/attachment.service.d.ts

@@ -1,9 +1,10 @@
-import { Observable } from 'rxjs';
+import { BehaviorSubject, Observable } from 'rxjs';
 import { Attachment } from 'stream-chat';
 import { ChannelService } from './channel.service';
 import { NotificationService } from './notification.service';
 import { AttachmentUpload, AudioRecording, DefaultStreamChatGenerics } from './types';
 import { ChatClientService } from './chat-client.service';
+import { MessageService } from './message.service';
 import * as i0 from "@angular/core";
 /**
  * The `AttachmentService` manages the uploads of a message input.
@@ -14,18 +15,28 @@ export declare class AttachmentService<T extends DefaultStreamChatGenerics = Def
     private channelService;
     private notificationService;
     private chatClientService;
+    private messageService;
     /**
      * Emits the number of uploads in progress.
+     *
+     * You can increment and decrement this counter if you're using custom attachments and want to disable message sending until all attachments are uploaded.
+     *
+     * The SDK will handle updating this counter for built-in attachments, but for custom attachments you should take care of this.
      */
-    attachmentUploadInProgressCounter$: Observable<number>;
+    attachmentUploadInProgressCounter$: BehaviorSubject<number>;
     /**
      * Emits the state of the uploads ([`AttachmentUpload[]`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/types.ts)), it adds a state (`success`, `error` or `uploading`) to each file the user selects for upload. It is used by the [`AttachmentPreviewList`](../components/AttachmentPreviewListComponent.mdx) to display the attachment previews.
      */
     attachmentUploads$: Observable<AttachmentUpload[]>;
-    private attachmentUploadInProgressCounterSubject;
+    /**
+     * You can get and set the list if uploaded custom attachments
+     *
+     * By default the SDK components won't display these, but you can provide your own `customAttachmentPreviewListTemplate$` and `customAttachmentListTemplate$` for the [`CustomTemplatesService`](../../services/CustomTemplatesService).
+     */
+    customAttachments$: BehaviorSubject<Attachment<T>[]>;
     private attachmentUploadsSubject;
     private appSettings;
-    constructor(channelService: ChannelService, notificationService: NotificationService, chatClientService: ChatClientService);
+    constructor(channelService: ChannelService, notificationService: NotificationService, chatClientService: ChatClientService, messageService: MessageService);
     /**
      * Resets the attachments uploads (for example after the message with the attachments sent successfully)
      */

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

@@ -1,6 +1,6 @@
 import { TemplateRef } from '@angular/core';
 import { BehaviorSubject } from 'rxjs';
-import { AttachmentContext, AttachmentListContext, AttachmentPreviewListContext, AvatarContext, ChannelActionsContext, ChannelHeaderInfoContext, ChannelPreviewContext, ChannelPreviewInfoContext, CommandAutocompleteListItemContext, CustomAttachmentUploadContext, CustomMetadataContext, DateSeparatorContext, DefaultStreamChatGenerics, DeliveredStatusContext, EmojiPickerContext, IconContext, MentionAutcompleteListItemContext, MentionTemplateContext, MessageActionBoxItemContext, MessageActionsBoxContext, MessageContext, MessageReactionsContext, MessageReactionsSelectorContext, ModalContext, NotificationContext, ReadStatusContext, SendingStatusContext, SystemMessageContext, ThreadHeaderContext, TypingIndicatorContext, UnreadMessagesIndicatorContext, UnreadMessagesNotificationContext } from './types';
+import { AttachmentContext, AttachmentListContext, AttachmentPreviewListContext, AvatarContext, ChannelActionsContext, ChannelHeaderInfoContext, ChannelPreviewContext, ChannelPreviewInfoContext, CommandAutocompleteListItemContext, CustomAttachmentListContext, CustomAttachmentPreviewListContext, CustomAttachmentUploadContext, CustomMetadataContext, DateSeparatorContext, DefaultStreamChatGenerics, DeliveredStatusContext, EmojiPickerContext, IconContext, MentionAutcompleteListItemContext, MentionTemplateContext, MessageActionBoxItemContext, MessageActionsBoxContext, MessageContext, MessageReactionsContext, MessageReactionsSelectorContext, ModalContext, NotificationContext, ReadStatusContext, SendingStatusContext, SystemMessageContext, ThreadHeaderContext, TypingIndicatorContext, UnreadMessagesIndicatorContext, UnreadMessagesNotificationContext } from './types';
 import * as i0 from "@angular/core";
 /**
  * A central location for registering your custom templates to override parts of the chat application.
@@ -209,6 +209,14 @@ export declare class CustomTemplatesService<T extends DefaultStreamChatGenerics
      *
      */
     channelPreviewInfoTemplate$: BehaviorSubject<TemplateRef<ChannelPreviewInfoContext<DefaultStreamChatGenerics>> | undefined>;
+    /**
+     * The template used to display custom attachment previews in the [message input component](../../components/MessageInputComponent.mdx)
+     */
+    customAttachmentPreviewListTemplate$: BehaviorSubject<TemplateRef<CustomAttachmentPreviewListContext<DefaultStreamChatGenerics>> | undefined>;
+    /**
+     * The template used to display custom attachments in the [message component](../../components/MessageComponent.mdx)
+     */
+    customAttachmentListTemplate$: BehaviorSubject<TemplateRef<CustomAttachmentListContext<DefaultStreamChatGenerics>> | undefined>;
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<CustomTemplatesService<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<CustomTemplatesService<any>>;

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

@@ -1,6 +1,6 @@
 import { AfterViewInit, ChangeDetectorRef, ComponentFactoryResolver, ComponentRef, EventEmitter, OnChanges, OnDestroy, OnInit, SimpleChanges, TemplateRef, Type } from '@angular/core';
 import { Observable, Subject } from 'rxjs';
-import { UserResponse } from 'stream-chat';
+import { Attachment, UserResponse } from 'stream-chat';
 import { AttachmentService } from '../attachment.service';
 import { ChannelService } from '../channel.service';
 import { NotificationService } from '../notification.service';
@@ -94,6 +94,7 @@ export declare class MessageInputComponent implements OnInit, OnChanges, OnDestr
     canSendLinks: boolean | undefined;
     canSendMessages: boolean | undefined;
     attachmentUploads$: Observable<AttachmentUpload[]>;
+    customAttachments$: Observable<Attachment[]>;
     attachmentUploadInProgressCounter$: Observable<number>;
     textareaValue: string;
     textareaRef: ComponentRef<TextareaInterface & Partial<OnChanges>> | undefined;
@@ -124,11 +125,11 @@ export declare class MessageInputComponent implements OnInit, OnChanges, OnDestr
     ngOnDestroy(): void;
     messageSent(): Promise<void>;
     get containsLinks(): boolean;
-    get quotedMessageAttachments(): import("stream-chat").Attachment<{
+    get quotedMessageAttachments(): Attachment<{
         attachmentType: import("stream-chat").UR & import("../types").UnknownType & {
             asset_url?: string | undefined;
             id?: string | undefined;
-            images?: import("stream-chat").Attachment<DefaultStreamChatGenerics>[] | undefined;
+            images?: Attachment<DefaultStreamChatGenerics>[] | undefined;
             mime_type?: string | undefined;
             isCustomAttachment?: boolean | undefined;
         };

package/lib/message.service.d.ts

@@ -1,8 +1,10 @@
+import { Attachment } from 'stream-chat';
+import { DefaultStreamChatGenerics } from './types';
 import * as i0 from "@angular/core";
 /**
  * The message service contains configuration options related to displaying the message content
  */
-export declare class MessageService {
+export declare class MessageService<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> {
     /**
      * Decides if the message content should be formatted as text or HTML
      *
@@ -17,7 +19,21 @@ export declare class MessageService {
      * @returns the HTML markup as a string for the link
      */
     customLinkRenderer?: (url: string) => string;
+    /**
+     * The SDK supports the following attachment types: `image`, `file`, `giphy`, `video` and `voiceRecording` attachments.
+     *
+     * All other types are treated as custom attachments, however it's possible to override this logic, and provide a custom filtering method which can be used to treat some built-in attachments as custom.
+     *
+     * Provide a method which retruns `true` if an attachment should be considered as custom.
+     */
+    filterCustomAttachment?: (attachment: Attachment<T>) => boolean;
     constructor();
-    static ɵfac: i0.ɵɵFactoryDeclaration<MessageService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<MessageService>;
+    /**
+     * Tells if an attachment is custom (you need to provide your own template to display them) or built-in (the SDK supports it out-of-the-box)
+     * @param attachment
+     * @returns `true` if the attachment is custom
+     */
+    isCustomAttachment(attachment: Attachment<T>): boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MessageService<any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MessageService<any>>;
 }

package/lib/types.d.ts

@@ -132,10 +132,12 @@ export declare type MessageContext = {
 export declare type ChannelActionsContext<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = {
     channel: Channel<T>;
 };
-export declare type AttachmentListContext = {
+export declare type CustomAttachmentListContext<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = {
     messageId: string;
-    attachments: Attachment<DefaultStreamChatGenerics>[];
+    attachments: Attachment<T>[];
     parentMessageId?: string;
+};
+export declare type AttachmentListContext = CustomAttachmentListContext & {
     imageModalStateChangeHandler?: (state: 'opened' | 'closed') => void;
 };
 export declare type AvatarType = 'channel' | 'user';
@@ -158,6 +160,7 @@ export declare type AttachmentPreviewListContext = {
     attachmentUploads$: Observable<AttachmentUpload[]> | undefined;
     retryUploadHandler: (f: File) => void;
     deleteUploadHandler: (u: AttachmentUpload) => void;
+    service: AttachmentService;
 };
 export declare type IconContext = {
     icon: Icon | undefined;
@@ -329,4 +332,7 @@ export declare type MediaRecording = {
     mime_type: string;
     asset_url: string | ArrayBuffer | undefined;
 };
+export declare type CustomAttachmentPreviewListContext<T extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> = {
+    attachmentService: AttachmentService<T>;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat-angular",
-  "version": "5.4.3",
+  "version": "5.5.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 = '5.4.3';
+export const version = '5.5.0';