stream-chat-angular 2.14.0 → 2.15.0

package/fesm2015/stream-chat-angular.js

@@ -17,10 +17,10 @@ import transliterate from '@stream-io/transliterate';
 import * as i6$1 from 'angular-mentions';
 import { MentionModule } from 'angular-mentions';
 
-const version = '2.14.0';
+const version = '2.15.0';
 
 /**
- * The `NotificationService` can be used to add or remove notifications. By default the [`NotificationList`](../components/notifications.mdx) component displays the currently active notifications.
+ * The `NotificationService` can be used to add or remove notifications. By default the [`NotificationList`](../components/NotificationListComponent.mdx) component displays the currently active notifications.
  */
 class NotificationService {
     constructor() {
@@ -396,7 +396,7 @@ class ChannelService {
         });
     }
     /**
-     * Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](./chat-client.mdx/#disconnectuser).
+     * Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](./ChatClientService.mdx/#disconnectuser).
      */
     reset() {
         this.activeChannelMessagesSubject.next([]);
@@ -1481,8 +1481,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 }]
         }], ctorParameters: function () { return [{ type: i2.TranslateService }]; } });
 
+/**
+ * The `Avatar` component displays the provided image, with fallback to the first letter of the optional name input.
+ */
 class AvatarComponent {
     constructor() {
+        /**
+         * The size in pixels of the avatar image.
+         */
         this.size = 32;
         this.isLoaded = false;
         this.isError = false;
@@ -1509,6 +1515,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 type: Input
             }] } });
 
+/**
+ * The `Icon` component can be used to display different icons (i. e. message delivered icon).
+ */
 class IconComponent {
     constructor() { }
 }
@@ -1527,9 +1536,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 type: Input
             }] } });
 
+/**
+ * The `LoadingIndicator` component displays a spinner to indicate that an action is in progress.
+ */
 class LoadingIndicatorComponent {
     constructor() {
+        /**
+         * The size of the indicator (in pixels)
+         */
         this.size = 15;
+        /**
+         * The color of the indicator
+         */
         this.color = '#006CFF';
     }
 }
@@ -1655,7 +1673,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
         }], ctorParameters: function () { return []; } });
 
 /**
- * The `MessageInputConfigService` is used to keep a consistent configuration among the different [`MessageInput`](../components/message-input.mdx) components if your UI has more than one input component.
+ * The `MessageInputConfigService` is used to keep a consistent configuration among the different [`MessageInput`](../components/MessageInputComponent.mdx) components if your UI has more than one input component.
  */
 class MessageInputConfigService {
     constructor() {
@@ -1706,10 +1724,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 }]
         }], ctorParameters: function () { return []; } });
 
+/**
+ * The `AttachmentList` compontent displays the attachments of a message
+ */
 class AttachmentListComponent {
     constructor(imageLoadService, channelService) {
         this.imageLoadService = imageLoadService;
         this.channelService = channelService;
+        /**
+         * The attachments to display
+         */
         this.attachments = [];
         this.orderedAttachments = [];
     }
@@ -1776,6 +1800,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 type: Input
             }] } });
 
+/**
+ * The `AttachmentPreviewList` compontent 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.
+ */
 class AttachmentPreviewListComponent {
     constructor(attachmentService) {
         this.attachmentService = attachmentService;
@@ -1806,6 +1833,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 }]
         }], ctorParameters: function () { return [{ type: AttachmentService }]; } });
 
+/**
+ * The `MessageInput` component displays an input where users can type their messages and upload files, and sends the message to the active channel. The component can be used to compose new messages or update existing ones. To send messages, the chat user needs to have the necessary [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript).
+ */
 class MessageInputComponent {
     constructor(channelService, notificationService, attachmentService, configService, textareaType, componentFactoryResolver, cdRef, chatClient, emojiInputService) {
         this.channelService = channelService;
@@ -1817,7 +1847,13 @@ class MessageInputComponent {
         this.cdRef = cdRef;
         this.chatClient = chatClient;
         this.emojiInputService = emojiInputService;
+        /**
+         * Determines if the message is being dispalyed in a channel or in a [thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript).
+         */
         this.mode = 'main';
+        /**
+         * Emits when a message was successfuly sent or updated
+         */
         this.messageUpdate = new EventEmitter();
         this.textareaValue = '';
         this.mentionedUsers = [];
@@ -2117,9 +2153,18 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 args: [TextareaDirective, { static: false }]
             }] } });
 
+/**
+ * The `Modal` component displays its content in an overlay. The modal can be closed with a close button, if the user clicks outside of the modal content, or if the escape button is pressed. The modal can also be closed from outside.
+ */
 class ModalComponent {
     constructor() {
+        /**
+         * If `true` the modal will be displayed, if `false` the modal will be hidden
+         */
         this.isOpen = false;
+        /**
+         * Emits `true` if the modal becomes visible, and `false` if the modal is closed.
+         */
         this.isOpenChange = new EventEmitter();
         this.watchForEscPress = (event) => {
             if (event.key === 'Escape') {
@@ -2176,6 +2221,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 args: ['content']
             }] } });
 
+/**
+ * The `Notification` component displays a notification within the [`NotificationList`](./NotificationListComponent.mdx)
+ */
 class NotificationComponent {
     constructor() { }
 }
@@ -2192,6 +2240,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 type: Input
             }] } });
 
+/**
+ * The `NotificationList` component displays the list of active notifications.
+ */
 class NotificationListComponent {
     constructor(notificationService) {
         this.notificationService = notificationService;
@@ -2212,15 +2263,33 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 }]
         }], ctorParameters: function () { return [{ type: NotificationService }]; } });
 
+/**
+ * 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.
+ */
 class MessageActionsBoxComponent {
     constructor(chatClientService, notificationService, channelService) {
         this.chatClientService = chatClientService;
         this.notificationService = notificationService;
         this.channelService = channelService;
+        /**
+         * Indicates if the list should be opened or closed. Adding a UI element to open and close the list is the parent's component responsibility.
+         */
         this.isOpen = false;
+        /**
+         * Indicates if the message actions are belonging to a message that was sent by the current user or not.
+         */
         this.isMine = false;
+        /**
+         * 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.
+         */
         this.enabledActions = [];
+        /**
+         * The number of authorized actions (it can be less or equal than the number of enabled actions)
+         */
         this.displayedActionsCount = new EventEmitter();
+        /**
+         * An event which emits `true` if the edit message modal is open, and `false` when it is closed.
+         */
         this.isEditing = new EventEmitter();
         this.isEditModalOpen = false;
         this.modalClosed = () => {
@@ -2350,6 +2419,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 args: [MessageInputComponent]
             }] } });
 
+/**
+ * The `Channel` component is a container component that displays the [`ChannelHeader`](./ChannelHeaderComponent.mdx), [`MessageList`](./MessageListComponent.mdx), [`NotificationList`](./NotificationListComponent.mdx) and [`MessageInput`](./MessageInputComponent.mdx) components. You can also provide the [`Thread`](./ThreadComponent.mdx) component to use message [threads](https://getstream.io/chat/docs/javascript/threads/?language=javascript).
+ */
 class ChannelComponent {
     constructor(channelService) {
         this.channelService = channelService;
@@ -2450,6 +2522,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
             args: [{ providedIn: 'root' }]
         }], ctorParameters: function () { return []; } });
 
+/**
+ * The `ChannelHeader` component displays the avatar and name of the currently active channel along with member and watcher information. You can read about [the difference between members and watchers](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript#watchers-vs-members) in the platform documentation. Please note that number of watchers is only displayed if the user has [`connect-events` capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript)
+ */
 class ChannelHeaderComponent {
     constructor(channelService, channelListToggleService) {
         this.channelService = channelService;
@@ -2489,6 +2564,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 }]
         }], ctorParameters: function () { return [{ type: ChannelService }, { type: ChannelListToggleService }]; } });
 
+/**
+ * The `ChannelPreview` component displays a channel preview in the channel list, it consists of the image, name and latest message of the channel.
+ */
 class ChannelPreviewComponent {
     constructor(channelService, ngZone) {
         this.channelService = channelService;
@@ -2576,6 +2654,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 type: Input
             }] } });
 
+/**
+ * The `ChannelList` component renders the list of channels.
+ */
 class ChannelListComponent {
     constructor(channelService, channelListToggleService) {
         this.channelService = channelService;
@@ -2663,15 +2744,33 @@ const emojiReactionsMapping = {
     wow: '😮',
     sad: '😞',
 };
+/**
+ * The `MessageReactions` component displays the reactions of a message, the current user can add and remove reactions. You can read more about [message reactions](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript) in the platform documentation.
+ */
 class MessageReactionsComponent {
     constructor(cdRef, channelService) {
         this.cdRef = cdRef;
         this.channelService = channelService;
+        /**
+         * The number of reactions grouped by [reaction types](https://github.com/GetStream/stream-chat-angular/tree/master/projects/stream-chat-angular/src/lib/message-reactions/message-reactions.component.ts)
+         */
         this.messageReactionCounts = {};
+        /**
+         * Indicates if the selector should be opened or closed. Adding a UI element to open and close the selector is the parent's component responsibility.
+         */
         this.isSelectorOpen = false;
-        this.isSelectorOpenChange = new EventEmitter();
+        /**
+         * List of reactions of a [message](../types/stream-message.mdx), used to display the users of a reaction type.
+         */
         this.latestReactions = [];
+        /**
+         * List of the user's own reactions of a [message](../types/stream-message.mdx), used to display the users of a reaction type.
+         */
         this.ownReactions = [];
+        /**
+         * Indicates if the selector should be opened or closed. Adding a UI element to open and close the selector is the parent's component responsibility.
+         */
+        this.isSelectorOpenChange = new EventEmitter();
         this.eventHandler = (event) => {
             var _a;
             if (!((_a = this.selectorContainer) === null || _a === void 0 ? void 0 : _a.nativeElement.contains(event.target))) {
@@ -2770,12 +2869,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 type: Input
             }], isSelectorOpen: [{
                 type: Input
-            }], isSelectorOpenChange: [{
-                type: Output
             }], latestReactions: [{
                 type: Input
             }], ownReactions: [{
                 type: Input
+            }], isSelectorOpenChange: [{
+                type: Output
             }], selectorContainer: [{
                 type: ViewChild,
                 args: ['selectorContainer']
@@ -2784,11 +2883,20 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 args: ['selectorTooltip']
             }] } });
 
+/**
+ * The `Message` component displays a message with additional information such as sender and date, and enables [interaction with the message (i.e. edit or react)](../concepts/message-interactions.mdx).
+ */
 class MessageComponent {
     constructor(chatClientService, channelService) {
         this.chatClientService = chatClientService;
         this.channelService = channelService;
+        /**
+         * 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. The [`MessageList`](./MessageListComponent.mdx) component automatically sets this based on [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript).
+         */
         this.enabledMessageActions = [];
+        /**
+         * Determines if the message is being dispalyed in a channel or in a [thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript).
+         */
         this.mode = 'main';
         this.isActionBoxOpen = false;
         this.isReactionSelectorOpen = false;
@@ -2969,12 +3077,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 args: ['container']
             }] } });
 
+/**
+ * The `Textarea` component is used by the [`MessageInput`](./MessageInputComponent.mdx) component to display the input HTML element where users can type their message.
+ */
 class TextareaComponent {
     constructor(emojiInputService) {
         this.emojiInputService = emojiInputService;
         this.class = 'str-chat__textarea';
+        /**
+         * The value of the input HTML element.
+         */
         this.value = '';
+        /**
+         * Emits the current value of the input element when a user types.
+         */
         this.valueChange = new EventEmitter();
+        /**
+         * Emits when a user triggers a message send event (this happens when they hit the `Enter` key).
+         */
         this.send = new EventEmitter();
         this.subscriptions = [];
         this.subscriptions.push(this.emojiInputService.emojiInput$.subscribe((emoji) => {
@@ -3044,6 +3164,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
             args: [{ providedIn: 'root' }]
         }], ctorParameters: function () { return []; } });
 
+/**
+ * The `AutocompleteTextarea` component is used by the [`MessageInput`](./MessageInputComponent.mdx) component to display the input HTML element where users can type their message.
+ */
 class AutocompleteTextareaComponent {
     constructor(channelService, chatClientService, transliterationService, emojiInputService) {
         this.channelService = channelService;
@@ -3051,11 +3174,29 @@ class AutocompleteTextareaComponent {
         this.transliterationService = transliterationService;
         this.emojiInputService = emojiInputService;
         this.class = 'str-chat__textarea';
+        /**
+         * The value of the input HTML element.
+         */
         this.value = '';
+        /**
+         * If true, users can mention other users in messages. You can also set this input on the [`MessageInput`](./MessageInputComponent.mdx/#inputs-and-outputs) component.
+         */
         this.areMentionsEnabled = true;
+        /**
+         * The scope for user mentions, either members of the current channel of members of the application. You can also set this input on the [`MessageInput`](./MessageInputComponent.mdx/#inputs-and-outputs) component.
+         */
         this.mentionScope = 'channel';
+        /**
+         * Emits the current value of the input element when a user types.
+         */
         this.valueChange = new EventEmitter();
+        /**
+         * Emits when a user triggers a message send event (this happens when they hit the `Enter` key).
+         */
         this.send = new EventEmitter();
+        /**
+         * Emits the array of users that are mentioned in the message, it is updated when a user mentions a new user or deletes a mention.
+         */
         this.userMentions = new EventEmitter();
         this.autocompleteKey = 'autocompleteLabel';
         this.mentionTriggerChar = '@';
@@ -3277,20 +3418,26 @@ const isOnSameDay = (date1, date2) => {
         date1.getDate() === date2.getDate());
 };
 
+/**
+ * The `MessageList` component renders a scrollable list of messages.
+ */
 class MessageListComponent {
     constructor(channelService, chatClientService, imageLoadService) {
         this.channelService = channelService;
         this.chatClientService = chatClientService;
         this.imageLoadService = imageLoadService;
         /**
-         * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message_list/#caution-arereactionsenabled-deprecated
+         * @deprecated use [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) instead. If true, the message reactions are displayed. Users can also react to messages if they have the necessary [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript).
          */
         this.areReactionsEnabled = undefined;
         /**
-         * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message_list/#caution-enabledmessageactions-deprecated
+         * @deprecated use [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) instead. The list of [actions that are enabled](./MessageActionsBoxComponent.mdx), please note that the user also has to have the necessary [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) for actions to work. Unathorized actions won't be displayed on the UI. The `MessgaeList` component makes the necessary checks before passing the actions to the `Message` component.
          */
         /* eslint-disable-next-line @angular-eslint/no-input-rename */
         this.enabledMessageActionsInput = undefined;
+        /**
+         * Determines if the message list should display channel messages or [thread messages](https://getstream.io/chat/docs/javascript/threads/?language=javascript).
+         */
         this.mode = 'main';
         this.enabledMessageActions = [];
         this.class = 'str-chat-angular__main-panel-inner str-chat-angular__message-list-host';
@@ -3548,6 +3695,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.5", ngImpor
                 args: ['parentMessageElement']
             }] } });
 
+/**
+ * The `Thread` component represents a [message thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript), it is a container component that displays a thread with a header, [`MessageList`](./MessageListComponent.mdx) and [`MessageInput`](./MessageInputComponent.mdx) components.
+ */
 class ThreadComponent {
     constructor(channelService) {
         this.channelService = channelService;