@banta/sdk 4.5.2 → 4.6.0

package/lib/comments/banta-comments/banta-comments.component.d.ts

@@ -1,4 +1,4 @@
-import { ElementRef, NgZone } from '@angular/core';
+import { ElementRef, NgZone, QueryList } from '@angular/core';
 import { User, ChatMessage, CommentsOrder } from '@banta/common';
 import { HashTag } from '../comment-field/comment-field.component';
 import { Subject, Observable } from 'rxjs';
@@ -7,6 +7,8 @@ import { ChatBackendBase } from '../../chat-backend-base';
 import { ChatSourceBase } from '../../chat-source-base';
 import { MatSnackBar } from '@angular/material/snack-bar';
 import { MessageMenuItem } from '../../message-menu-item';
+import { CommentViewComponent } from '../comment-view/comment-view.component';
+import { CommentComponent } from '../comment/comment.component';
 /**
  * Comments component
  */
@@ -17,6 +19,7 @@ export declare class BantaCommentsComponent {
     private matSnackBar;
     private ngZone;
     constructor(backend: ChatBackendBase, elementRef: ElementRef<HTMLElement>, activatedRoute: ActivatedRoute, matSnackBar: MatSnackBar, ngZone: NgZone);
+    get element(): HTMLElement;
     private handleBackendExceptionAsAlert;
     private handleBackendException;
     ngOnInit(): void;
@@ -44,6 +47,34 @@ export declare class BantaCommentsComponent {
     maxCommentLength: number;
     loadingMessages: string[];
     useInlineReplies: boolean;
+    /**
+     * Access the CommentViewComponent for this BantaCommentsComponent.
+     * CommentViewComponent is responsible for interacting with the ChatSource
+     * object and rendering comments as CommentComponents. It is the source of
+     * truth for which CommentComponent corresponds to which ChatMessage.
+     *
+     * Note that this CommentViewComponent is only for the top level comments.
+     * Replies are handled by a separate CommentViewComponent which can be
+     * retrieved using the threadView property.
+     */
+    commentView: CommentViewComponent;
+    threadViewQuery: QueryList<CommentViewComponent>;
+    /**
+     * Attempts to find the CommentComponent that corresponds to the given ChatMessage.
+     * The ChatMessage could be a top-level message in this conversation, or a reply,
+     * but note that a CommentComponent will only exist for a reply if the user has
+     * the relevant reply thread open.
+     * @param message The message to look for
+     */
+    getCommentComponentForMessage(message: ChatMessage): CommentComponent;
+    /**
+     * Access the CommentViewComponent corresponding to the currently open reply thread.
+     * This is not the top level comments, but instead the reply thread that the user has
+     * opened (only one set of replies can be open at a time).
+     *
+     * For details about what CommentViewComponent affords you, see the commentView property.
+     */
+    get threadView(): CommentViewComponent;
     private updateLoading;
     private _signInSelected;
     private _permissionDeniedError;

package/lib/comments/comment/comment.component.d.ts

@@ -1,6 +1,10 @@
+import { ElementRef } from "@angular/core";
 import { ChatMessage, ChatPermissions, User } from '@banta/common';
 import { MessageMenuItem } from "../../message-menu-item";
 export declare class CommentComponent {
+    private elementRef;
+    constructor(elementRef: ElementRef<HTMLElement>);
+    get element(): HTMLElement;
     private _reported;
     private _selected;
     private _liked;

package/lib/comments/comment-view/comment-view.component.d.ts

@@ -1,9 +1,10 @@
-import { ElementRef } from "@angular/core";
+import { ElementRef, QueryList } from "@angular/core";
 import { User, ChatMessage, CommentsOrder } from '@banta/common';
 import { Subject } from 'rxjs';
 import { ChatBackendBase } from "../../chat-backend-base";
 import { ChatSourceBase } from "../../chat-source-base";
 import { MessageMenuItem } from "../../message-menu-item";
+import { CommentComponent } from "../comment/comment.component";
 export interface EditEvent {
     message: ChatMessage;
     newMessage: string;
@@ -26,6 +27,16 @@ export declare class CommentViewComponent {
     showEmptyState: boolean;
     allowReplies: boolean;
     customMenuItems: MessageMenuItem[];
+    commentsQuery: QueryList<CommentComponent>;
+    get comments(): CommentComponent[];
+    /**
+     * Get the CommentComponent instantiated for the given ChatMessage,
+     * if it exists in the current view. Note that messages which are not
+     * currently shown to the user will not return a CommentComponent.
+     * @param message
+     * @returns
+     */
+    getCommentComponentForMessage(message: ChatMessage): CommentComponent;
     fixedHeight: boolean;
     selectedMessage: ChatMessage;
     get selected(): Subject<ChatMessage>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@banta/sdk",
-  "version": "4.5.2",
+  "version": "4.6.0",
   "private": false,
   "publishConfig": {
     "access": "public"