@banta/sdk 5.9.0 → 6.0.0

package/lib/chat-backend-base.d.ts

@@ -44,7 +44,7 @@ export declare abstract class ChatBackendBase {
      * @param topicId
      * @returns
      */
-    abstract getMessages(topicId: string, sort?: CommentsOrder, filter?: FilterMode, offset?: number, limit?: number): Promise<ChatMessage[]>;
+    abstract getMessages(topicId: string, sort?: CommentsOrder, filter?: FilterMode, offset?: number, limit?: number, pinned?: boolean): Promise<ChatMessage[]>;
     /**
      * Get a set of messages from the given topic.
      * @param topicId

package/lib/chat-backend.d.ts

@@ -47,13 +47,13 @@ export declare class ChatBackend extends ChatBackendBase {
      * @param topicId
      * @returns
      */
-    getMessages(topicId: string, sort?: CommentsOrder, filter?: FilterMode, offset?: number, limit?: number): Promise<ChatMessage[]>;
+    getMessages(topicId: string, sort?: CommentsOrder, filter?: FilterMode, offset?: number, limit?: number, pinned?: boolean): Promise<ChatMessage[]>;
     /**
      * Get a set of messages from the given topic.
      * @param topicId
      * @returns
      */
-    getReplies(parentMessageId: string, sort?: CommentsOrder, filter?: FilterMode, offset?: number, limit?: number): Promise<ChatMessage[]>;
+    getReplies(parentMessageId: string, sort?: CommentsOrder, filter?: FilterMode, offset?: number, limit?: number, pinned?: boolean): Promise<ChatMessage[]>;
     refreshMessage(message: ChatMessage): Promise<ChatMessage>;
     getMessage(topicId: string, messageId: string): Promise<ChatMessage>;
     getSubMessage(topicId: string, parentMessageId: string, messageId: string): Promise<ChatMessage>;

package/lib/chat-source-base.d.ts

@@ -25,11 +25,16 @@ export interface ChatSourceBase {
     getCount(): Promise<number>;
     loadSince(id: string): Promise<ChatMessage[]>;
     getExistingMessages(): Promise<ChatMessage[]>;
+    getPinnedMessages(): Promise<ChatMessage[]>;
     loadAfter(message: ChatMessage, count: number): Promise<ChatMessage[]>;
     get(id: string): Promise<ChatMessage>;
     getServerInfo(): Promise<ServerInfo>;
     likeMessage(messageId: string): Promise<void>;
     unlikeMessage(messageId: string): Promise<void>;
+    pinMessage(messageId: string, options?: {
+        until?: number;
+    }): Promise<void>;
+    unpinMessage(messageId: string): Promise<void>;
     editMessage(messageId: string, text: string): Promise<void>;
     deleteMessage(messageId: string): Promise<void>;
     connectionStateChanged?: Observable<'connected' | 'connecting' | 'lost' | 'restored'>;

package/lib/chat-source.d.ts

@@ -4,6 +4,9 @@ import { ChatSourceBase } from "./chat-source-base";
 import { ChatBackend } from "./chat-backend";
 import { ChatSourceOptions } from "./chat-backend-base";
 export type SignInState = 'signed-out' | 'signed-in' | 'signing-in';
+export interface PinOptions {
+    until?: number;
+}
 export declare class ChatSource extends SocketRPC implements ChatSourceBase {
     readonly backend: ChatBackend;
     readonly identifier: string;
@@ -19,11 +22,11 @@ export declare class ChatSource extends SocketRPC implements ChatSourceBase {
     private _state;
     get sortOrder(): "newest" | "oldest" | "likes";
     get filterMode(): string;
-    get state(): "connecting" | "connected" | "lost" | "restored";
-    set state(value: "connecting" | "connected" | "lost" | "restored");
+    get state(): "connected" | "connecting" | "lost" | "restored";
+    set state(value: "connected" | "connecting" | "lost" | "restored");
     private _connectionStateChanged;
     private _connectionStateChanged$;
-    get connectionStateChanged(): import("rxjs").Observable<"connecting" | "connected" | "lost" | "restored">;
+    get connectionStateChanged(): import("rxjs").Observable<"connected" | "connecting" | "lost" | "restored">;
     private wasRestored;
     bind(socket: DurableSocket): Promise<this>;
     private mapOrUpdateMessages;
@@ -42,6 +45,7 @@ export declare class ChatSource extends SocketRPC implements ChatSourceBase {
      */
     loadSince(id: string): Promise<ChatMessage[]>;
     getExistingMessages(): Promise<ChatMessage[]>;
+    getPinnedMessages(): Promise<ChatMessage[]>;
     private ensureConnection;
     editMessage(messageId: string, text: string): Promise<void>;
     private subscribeAttempt;
@@ -57,7 +61,7 @@ export declare class ChatSource extends SocketRPC implements ChatSourceBase {
     authenticate(): Promise<void>;
     close(): void;
     onPermissions(permissions: ChatPermissions): void;
-    onChatMessage(message: ChatMessage): ChatMessage;
+    onChatMessage(message: ChatMessage): void;
     private messageMap;
     private _messageReceived;
     private _messageUpdated;
@@ -74,6 +78,8 @@ export declare class ChatSource extends SocketRPC implements ChatSourceBase {
     get(id: string): Promise<ChatMessage>;
     getCount(): Promise<number>;
     likeMessage(messageId: string): Promise<void>;
+    pinMessage(messageId: string, options?: PinOptions): Promise<void>;
+    unpinMessage(messageId: string): Promise<void>;
     unlikeMessage(messageId: string): Promise<void>;
     deleteMessage(messageId: string): Promise<void>;
 }

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

@@ -9,6 +9,7 @@ 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';
+import { PinOptions } from '../../chat-source';
 import * as i0 from "@angular/core";
 /**
  * Comments component
@@ -88,7 +89,7 @@ export declare class BantaCommentsComponent {
     waitForThreadView(): Promise<CommentViewComponent>;
     markLoaded: () => void;
     loaded: Promise<void>;
-    get sourceState(): "no-source" | "connecting" | "connected" | "lost" | "restored";
+    get sourceState(): "connected" | "connecting" | "lost" | "restored" | "no-source";
     private updateLoading;
     private _signInSelected;
     private _permissionDeniedError;
@@ -193,6 +194,8 @@ export declare class BantaCommentsComponent {
     scrollToMessage(message: ChatMessage): void;
     private addParticipant;
     likeMessage(source: ChatSourceBase, message: ChatMessage): Promise<void>;
+    pinMessage(source: ChatSourceBase, message: ChatMessage, options: PinOptions): Promise<void>;
+    unpinMessage(source: ChatSourceBase, message: ChatMessage): Promise<void>;
     unlikeMessage(source: ChatSourceBase, message: ChatMessage): Promise<void>;
     reportMessage(message: ChatMessage): Promise<void>;
     unselectMessage(): Promise<void>;

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

@@ -1,6 +1,7 @@
 import { ElementRef } from "@angular/core";
 import { ChatMessage, ChatPermissions, User } from '@banta/common';
 import { MessageMenuItem } from "../../message-menu-item";
+import { PinOptions } from "../../chat-source";
 import * as i0 from "@angular/core";
 export declare class CommentComponent {
     private elementRef;
@@ -11,6 +12,11 @@ export declare class CommentComponent {
     private _message;
     private isLoaded;
     editedMessage: string;
+    pinFormVisible: boolean;
+    pinUntilDate: Date;
+    pinUntilTime: string;
+    pinMode: 'forever' | 'until';
+    today: Date;
     customMenuItems: MessageMenuItem[];
     showReplyAction: boolean;
     maxLength: number;
@@ -32,6 +38,8 @@ export declare class CommentComponent {
     private _editEnded;
     private _edited;
     private _loaded;
+    private _pinned;
+    private _unpinned;
     readonly liked: import("rxjs").Observable<void>;
     readonly unliked: import("rxjs").Observable<void>;
     readonly selected: import("rxjs").Observable<void>;
@@ -45,12 +53,19 @@ export declare class CommentComponent {
     readonly avatarSelected: import("rxjs").Observable<User>;
     readonly reported: import("rxjs").Observable<void>;
     readonly loaded: import("rxjs").Observable<void>;
+    readonly pinned: import("rxjs").Observable<{
+        message: ChatMessage;
+        options: PinOptions;
+    }>;
+    readonly unpinned: import("rxjs").Observable<ChatMessage>;
     get commentId(): string;
     isNew: boolean;
     get isHighlighted(): any;
     visible: boolean;
     get replyCount(): number;
     get element(): HTMLElement;
+    get isPinned(): boolean;
+    get pinFormValid(): boolean;
     avatarForUser(user: User): string;
     waitForLoad(): Promise<void>;
     private setMessage;
@@ -62,11 +77,14 @@ export declare class CommentComponent {
     like(): void;
     unlike(): void;
     share(): void;
+    unpin(): void;
     select(): void;
     selectUser(): void;
     startEdit(): void;
     selectUsername(user: User): void;
     selectAvatar(user: User): void;
+    showPinForm(): void;
+    submitPin(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<CommentComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<CommentComponent, "banta-comment", never, { "message": { "alias": "message"; "required": false; }; "customMenuItems": { "alias": "customMenuItems"; "required": false; }; "showReplyAction": { "alias": "showReplyAction"; "required": false; }; "maxLength": { "alias": "maxLength"; "required": false; }; "permissions": { "alias": "permissions"; "required": false; }; "mine": { "alias": "mine"; "required": false; }; "editing": { "alias": "editing"; "required": false; }; "genericAvatarUrl": { "alias": "genericAvatarUrl"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; }, { "liked": "liked"; "unliked": "unliked"; "selected": "selected"; "edited": "edited"; "deleted": "deleted"; "editStarted": "editStarted"; "editEnded": "editEnded"; "shared": "shared"; "userSelected": "userSelected"; "usernameSelected": "usernameSelected"; "avatarSelected": "avatarSelected"; "reported": "reported"; "loaded": "loaded"; }, never, never, false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CommentComponent, "banta-comment", never, { "message": { "alias": "message"; "required": false; }; "customMenuItems": { "alias": "customMenuItems"; "required": false; }; "showReplyAction": { "alias": "showReplyAction"; "required": false; }; "maxLength": { "alias": "maxLength"; "required": false; }; "permissions": { "alias": "permissions"; "required": false; }; "mine": { "alias": "mine"; "required": false; }; "editing": { "alias": "editing"; "required": false; }; "genericAvatarUrl": { "alias": "genericAvatarUrl"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; }, { "liked": "liked"; "unliked": "unliked"; "selected": "selected"; "edited": "edited"; "deleted": "deleted"; "editStarted": "editStarted"; "editEnded": "editEnded"; "shared": "shared"; "userSelected": "userSelected"; "usernameSelected": "usernameSelected"; "avatarSelected": "avatarSelected"; "reported": "reported"; "loaded": "loaded"; "pinned": "pinned"; "unpinned": "unpinned"; }, never, never, false, never>;
 }

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

@@ -4,6 +4,7 @@ import { ChatBackendBase } from "../../chat-backend-base";
 import { ChatSourceBase } from "../../chat-source-base";
 import { MessageMenuItem } from "../../message-menu-item";
 import { CommentComponent } from "../comment/comment.component";
+import { PinOptions } from "../../chat-source";
 import * as i0 from "@angular/core";
 export interface EditEvent {
     message: ChatMessage;
@@ -18,6 +19,7 @@ export declare class CommentViewComponent {
     set source(value: ChatSourceBase);
     private _sourceSubs;
     menuMessage: ChatMessage;
+    pinnedMessages: ChatMessage[];
     messages: ChatMessage[];
     currentUser: User;
     customSortEnabled: boolean;
@@ -57,6 +59,7 @@ export declare class CommentViewComponent {
     private _maxVisibleMessages;
     set maxVisibleMessages(value: number);
     get maxVisibleMessages(): number;
+    collapsePins: boolean;
     newestLast: boolean;
     holdNewMessages: boolean;
     showEmptyState: boolean;
@@ -70,6 +73,8 @@ export declare class CommentViewComponent {
     private _selected;
     private _liked;
     private _unliked;
+    private _pinned;
+    private _unpinned;
     private _reported;
     private _userSelected;
     private _usernameSelected;
@@ -83,6 +88,11 @@ export declare class CommentViewComponent {
     readonly reported: import("rxjs").Observable<ChatMessage>;
     readonly liked: import("rxjs").Observable<ChatMessage>;
     readonly unliked: import("rxjs").Observable<ChatMessage>;
+    readonly pinned: import("rxjs").Observable<{
+        message: ChatMessage;
+        options: PinOptions;
+    }>;
+    readonly unpinned: import("rxjs").Observable<ChatMessage>;
     readonly usernameSelected: import("rxjs").Observable<User>;
     readonly avatarSelected: import("rxjs").Observable<User>;
     readonly shared: import("rxjs").Observable<ChatMessage>;
@@ -114,6 +124,8 @@ export declare class CommentViewComponent {
     saveEdit(message: ChatMessage, newMessage: string): void;
     likeMessage(message: ChatMessage): void;
     unlikeMessage(message: ChatMessage): void;
+    pinMessage(message: ChatMessage, options: PinOptions): void;
+    unpinMessage(message: ChatMessage): void;
     reportMessage(message: ChatMessage): void;
     selectMessage(message: ChatMessage): void;
     selectMessageUser(message: ChatMessage): void;
@@ -179,11 +191,13 @@ export declare class CommentViewComponent {
     private messageReceived;
     isScrolledToLatest(): boolean;
     private messageSent;
+    private isPinned;
+    private messageUpdated;
     scrollToLatest(): void;
     get element(): HTMLElement;
     scrollToComment(commentId: ChatMessage['id']): Promise<void>;
     getElementForComment(commentId: string): Element;
     mentionsMe(message: ChatMessage): boolean;
     static ɵfac: i0.ɵɵFactoryDeclaration<CommentViewComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<CommentViewComponent, "banta-comment-view", never, { "source": { "alias": "source"; "required": false; }; "maxMessages": { "alias": "maxMessages"; "required": false; }; "maxVisibleMessages": { "alias": "maxVisibleMessages"; "required": false; }; "newestLast": { "alias": "newestLast"; "required": false; }; "holdNewMessages": { "alias": "holdNewMessages"; "required": false; }; "showEmptyState": { "alias": "showEmptyState"; "required": false; }; "allowReplies": { "alias": "allowReplies"; "required": false; }; "enableHoldOnClick": { "alias": "enableHoldOnClick"; "required": false; }; "enableHoldOnScroll": { "alias": "enableHoldOnScroll"; "required": false; }; "customMenuItems": { "alias": "customMenuItems"; "required": false; }; "fixedHeight": { "alias": "fixedHeight"; "required": false; }; "selectedMessage": { "alias": "selectedMessage"; "required": false; }; "genericAvatarUrl": { "alias": "genericAvatarUrl"; "required": false; }; }, { "userSelected": "userSelected"; "reported": "reported"; "liked": "liked"; "unliked": "unliked"; "usernameSelected": "usernameSelected"; "avatarSelected": "avatarSelected"; "shared": "shared"; "deleted": "deleted"; "selected": "selected"; "messageEdited": "messageEdited"; "sortOrderChanged": "sortOrderChanged"; "filterModeChanged": "filterModeChanged"; }, never, ["[data-before]", ".inline-replies", ":not([data-before]):not(.inline-replies)"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CommentViewComponent, "banta-comment-view", never, { "source": { "alias": "source"; "required": false; }; "maxMessages": { "alias": "maxMessages"; "required": false; }; "maxVisibleMessages": { "alias": "maxVisibleMessages"; "required": false; }; "collapsePins": { "alias": "collapsePins"; "required": false; }; "newestLast": { "alias": "newestLast"; "required": false; }; "holdNewMessages": { "alias": "holdNewMessages"; "required": false; }; "showEmptyState": { "alias": "showEmptyState"; "required": false; }; "allowReplies": { "alias": "allowReplies"; "required": false; }; "enableHoldOnClick": { "alias": "enableHoldOnClick"; "required": false; }; "enableHoldOnScroll": { "alias": "enableHoldOnScroll"; "required": false; }; "customMenuItems": { "alias": "customMenuItems"; "required": false; }; "fixedHeight": { "alias": "fixedHeight"; "required": false; }; "selectedMessage": { "alias": "selectedMessage"; "required": false; }; "genericAvatarUrl": { "alias": "genericAvatarUrl"; "required": false; }; }, { "userSelected": "userSelected"; "reported": "reported"; "liked": "liked"; "unliked": "unliked"; "pinned": "pinned"; "unpinned": "unpinned"; "usernameSelected": "usernameSelected"; "avatarSelected": "avatarSelected"; "shared": "shared"; "deleted": "deleted"; "selected": "selected"; "messageEdited": "messageEdited"; "sortOrderChanged": "sortOrderChanged"; "filterModeChanged": "filterModeChanged"; }, never, ["[data-before]", ".inline-replies", ".inline-replies", ":not([data-before]):not(.inline-replies)"], false, never>;
 }

package/lib/comments/comments.module.d.ts

@@ -16,15 +16,18 @@ import * as i14 from "@angular/material/form-field";
 import * as i15 from "@angular/material/input";
 import * as i16 from "@angular/material/button";
 import * as i17 from "@angular/material/menu";
-import * as i18 from "@angular/material/progress-spinner";
-import * as i19 from "../common/common.module";
-import * as i20 from "../emoji/emoji.module";
-import * as i21 from "@angular/material/tooltip";
-import * as i22 from "@angular/material/select";
-import * as i23 from "@angular/cdk/overlay";
-import * as i24 from "@angular/cdk/portal";
+import * as i18 from "@angular/material/divider";
+import * as i19 from "@angular/material/progress-spinner";
+import * as i20 from "../common/common.module";
+import * as i21 from "../emoji/emoji.module";
+import * as i22 from "@angular/material/tooltip";
+import * as i23 from "@angular/material/datepicker";
+import * as i24 from "@angular/material/select";
+import * as i25 from "@angular/material/radio";
+import * as i26 from "@angular/cdk/overlay";
+import * as i27 from "@angular/cdk/portal";
 export declare class CommentsModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<CommentsModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<CommentsModule, [typeof i1.CommentComponent, typeof i2.CommentViewComponent, typeof i3.BantaCommentsComponent, typeof i4.LiveCommentComponent, typeof i5.CommentFieldComponent, typeof i6.CommentSortComponent, typeof i7.AttachmentButtonComponent, typeof i8.BantaReplySendOptionsDirective, typeof i9.AttachmentScraperDirective], [typeof i10.CommonModule, typeof i11.TextFieldModule, typeof i12.FormsModule, typeof i13.MatIconModule, typeof i14.MatFormFieldModule, typeof i15.MatInputModule, typeof i16.MatButtonModule, typeof i17.MatMenuModule, typeof i18.MatProgressSpinnerModule, typeof i19.BantaCommonModule, typeof i20.EmojiModule, typeof i21.MatTooltipModule, typeof i22.MatSelectModule, typeof i23.OverlayModule, typeof i24.PortalModule], [typeof i1.CommentComponent, typeof i2.CommentViewComponent, typeof i3.BantaCommentsComponent, typeof i4.LiveCommentComponent, typeof i5.CommentFieldComponent, typeof i6.CommentSortComponent, typeof i7.AttachmentButtonComponent, typeof i8.BantaReplySendOptionsDirective, typeof i9.AttachmentScraperDirective]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<CommentsModule, [typeof i1.CommentComponent, typeof i2.CommentViewComponent, typeof i3.BantaCommentsComponent, typeof i4.LiveCommentComponent, typeof i5.CommentFieldComponent, typeof i6.CommentSortComponent, typeof i7.AttachmentButtonComponent, typeof i8.BantaReplySendOptionsDirective, typeof i9.AttachmentScraperDirective], [typeof i10.CommonModule, typeof i11.TextFieldModule, typeof i12.FormsModule, typeof i13.MatIconModule, typeof i14.MatFormFieldModule, typeof i15.MatInputModule, typeof i16.MatButtonModule, typeof i17.MatMenuModule, typeof i18.MatDividerModule, typeof i19.MatProgressSpinnerModule, typeof i20.BantaCommonModule, typeof i21.EmojiModule, typeof i22.MatTooltipModule, typeof i23.MatDatepickerModule, typeof i24.MatSelectModule, typeof i25.MatRadioModule, typeof i26.OverlayModule, typeof i27.PortalModule], [typeof i1.CommentComponent, typeof i2.CommentViewComponent, typeof i3.BantaCommentsComponent, typeof i4.LiveCommentComponent, typeof i5.CommentFieldComponent, typeof i6.CommentSortComponent, typeof i7.AttachmentButtonComponent, typeof i8.BantaReplySendOptionsDirective, typeof i9.AttachmentScraperDirective]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<CommentsModule>;
 }

package/lib/static-chat-source.d.ts

@@ -32,13 +32,18 @@ export declare class StaticChatSource implements ChatSourceBase {
     getCount(): Promise<number>;
     loadSince(id: string): Promise<any>;
     getExistingMessages(): Promise<ChatMessage[]>;
+    getPinnedMessages(): Promise<ChatMessage[]>;
     loadAfter(message: ChatMessage, count: number): Promise<ChatMessage[]>;
     get(id: string): Promise<ChatMessage>;
     likeMessage(messageId: string): Promise<void>;
     unlikeMessage(messageId: string): Promise<void>;
+    pinMessage(messageId: string, options?: {
+        until?: number;
+    }): Promise<void>;
+    unpinMessage(messageId: string): Promise<void>;
     editMessage(messageId: string, text: string): Promise<void>;
     deleteMessage(messageId: string): Promise<void>;
-    connectionStateChanged: Subject<"connecting" | "connected" | "lost" | "restored">;
+    connectionStateChanged: Subject<"connected" | "connecting" | "lost" | "restored">;
     state: 'connecting' | 'connected' | 'lost' | 'restored';
     get errorState(): any;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@banta/sdk",
-  "version": "5.9.0",
+  "version": "6.0.0",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -15,7 +15,7 @@
     "@angular/platform-browser": "^16 || ^17 || ^18 || ^19",
     "@angular/platform-browser-dynamic": "^16 || ^17 || ^18 || ^19",
     "@angular/router": "^16 || ^17 || ^18 || ^19",
-    "@banta/common": "^2.8.0",
+    "@banta/common": "^3.1.0",
     "@types/dompurify": "^3.0.5",
     "dompurify": "^3.1.5",
     "marked": "^13.0.1",