@banta/sdk 4.9.0 → 4.10.0

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

@@ -22,6 +22,15 @@ export declare class BantaChatComponent {
     set source(value: ChatSourceBase);
     get topicID(): string;
     set topicID(value: string);
+    private _metadata;
+    /**
+     * Arbitrary metadata to send to the chat server. This can be used to provide context about the client to the server
+     * for things like validating authorization and other uses.
+     */
+    get metadata(): Record<string, any>;
+    set metadata(value: Record<string, any>);
+    private _reloadSourceTimeout;
+    private reloadSource;
     private setSourceFromTopicID;
     signInLabel: string;
     sendLabel: string;
@@ -66,5 +75,5 @@ export declare class BantaChatComponent {
     newMessage: NewMessageForm;
     sendMessage(): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<BantaChatComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<BantaChatComponent, "banta-chat", never, { "shouldInterceptMessageSend": "shouldInterceptMessageSend"; "url": "url"; "source": "source"; "topicID": "topicID"; "signInLabel": "signInLabel"; "sendLabel": "sendLabel"; "permissionDeniedLabel": "permissionDeniedLabel"; "messageFieldPlaceholder": "messageFieldPlaceholder"; "emptyLabel": "emptyLabel"; }, { "selected": "selected"; "reported": "reported"; "upvoted": "upvoted"; "userSelected": "userSelected"; "permissionDeniedError": "permissionDeniedError"; "signInSelected": "signInSelected"; "received": "received"; }, never, never, false>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<BantaChatComponent, "banta-chat", never, { "shouldInterceptMessageSend": "shouldInterceptMessageSend"; "url": "url"; "source": "source"; "topicID": "topicID"; "metadata": "metadata"; "signInLabel": "signInLabel"; "sendLabel": "sendLabel"; "permissionDeniedLabel": "permissionDeniedLabel"; "messageFieldPlaceholder": "messageFieldPlaceholder"; "emptyLabel": "emptyLabel"; }, { "selected": "selected"; "reported": "reported"; "upvoted": "upvoted"; "userSelected": "userSelected"; "permissionDeniedError": "permissionDeniedError"; "signInSelected": "signInSelected"; "received": "received"; }, never, never, false>;
 }

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

@@ -9,6 +9,7 @@ export interface ChatSourceOptions {
      * How many messages should be loaded initially?
      */
     initialMessageCount?: number;
+    metadata?: Record<string, any>;
 }
 export declare abstract class ChatBackendBase {
     constructor();

package/lib/chat-source.d.ts

@@ -1,4 +1,4 @@
-import { ChatMessage, ChatPermissions, CommentsOrder, DurableSocket } from "@banta/common";
+import { ChatMessage, ChatPermissions, DurableSocket } from "@banta/common";
 import { SocketRPC } from "@banta/common";
 import { ChatSourceBase } from "./chat-source-base";
 import { ChatBackend } from "./chat-backend";
@@ -17,8 +17,8 @@ export declare class ChatSource extends SocketRPC implements ChatSourceBase {
     ready: Promise<void>;
     permissions: ChatPermissions;
     private _state;
-    get sortOrder(): CommentsOrder;
-    get filterMode(): import("@banta/common").FilterMode;
+    get sortOrder(): "newest" | "oldest" | "likes";
+    get filterMode(): string;
     get state(): "connected" | "connecting" | "lost" | "restored";
     set state(value: "connected" | "connecting" | "lost" | "restored");
     private _connectionStateChanged;

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

@@ -1,5 +1,5 @@
 import { ElementRef, NgZone, QueryList } from '@angular/core';
-import { User, ChatMessage, CommentsOrder, FilterMode } from '@banta/common';
+import { User, ChatMessage } from '@banta/common';
 import { HashTag } from '../comment-field/comment-field.component';
 import { Subject, Observable } from 'rxjs';
 import { ActivatedRoute } from '@angular/router';
@@ -147,19 +147,26 @@ export declare class BantaCommentsComponent {
     private _reloadSourceTimeout;
     private reloadSource;
     private _sortOrder;
-    get sortOrder(): CommentsOrder;
-    set sortOrder(value: CommentsOrder);
+    get sortOrder(): "newest" | "oldest" | "likes";
+    set sortOrder(value: "newest" | "oldest" | "likes");
     private _filterMode;
-    get filterMode(): FilterMode;
-    set filterMode(value: FilterMode);
-    get filterModes(): FilterMode[];
+    get filterMode(): string;
+    set filterMode(value: string);
+    private _metadata;
+    /**
+     * Arbitrary metadata to send to the chat server. This can be used to provide context about the client to the server
+     * for things like validating authorization and other uses.
+     */
+    get metadata(): Record<string, any>;
+    set metadata(value: Record<string, any>);
+    get filterModes(): ("all" | "mine" | "threads" | "my-likes")[];
     get filterModeLabels(): {
         all: string;
         mine: string;
         threads: string;
         "my-likes": string;
     };
-    get sortOrders(): CommentsOrder[];
+    get sortOrders(): ("newest" | "oldest" | "likes")[];
     get sortOrderLabels(): {
         newest: string;
         oldest: string;
@@ -192,5 +199,5 @@ export declare class BantaCommentsComponent {
     startEditing(message: ChatMessage): Promise<void>;
     saveEdit(message: ChatMessage, text: string): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<BantaCommentsComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<BantaCommentsComponent, "banta-comments", never, { "customMenuItems": "customMenuItems"; "url": "url"; "maxCommentLength": "maxCommentLength"; "loadingMessages": "loadingMessages"; "useInlineReplies": "useInlineReplies"; "signInLabel": "signInLabel"; "sendLabel": "sendLabel"; "signingInLabel": "signingInLabel"; "replyLabel": "replyLabel"; "sendingLabel": "sendingLabel"; "permissionDeniedLabel": "permissionDeniedLabel"; "postCommentLabel": "postCommentLabel"; "postReplyLabel": "postReplyLabel"; "allowAttachments": "allowAttachments"; "fixedHeight": "fixedHeight"; "maxMessages": "maxMessages"; "maxVisibleMessages": "maxVisibleMessages"; "genericAvatarUrl": "genericAvatarUrl"; "shouldInterceptMessageSend": "shouldInterceptMessageSend"; "participants": "participants"; "source": "source"; "hashtags": "hashtags"; "topicID": "topicID"; "sortOrder": "sortOrder"; "filterMode": "filterMode"; }, { "signInSelected": "signInSelected"; "editAvatarSelected": "editAvatarSelected"; "permissionDeniedError": "permissionDeniedError"; "upvoted": "upvoted"; "reported": "reported"; "selected": "selected"; "userSelected": "userSelected"; "usernameSelected": "usernameSelected"; "avatarSelected": "avatarSelected"; "shared": "shared"; }, ["sendReplyOptionsTemplate"], never, false>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<BantaCommentsComponent, "banta-comments", never, { "customMenuItems": "customMenuItems"; "url": "url"; "maxCommentLength": "maxCommentLength"; "loadingMessages": "loadingMessages"; "useInlineReplies": "useInlineReplies"; "signInLabel": "signInLabel"; "sendLabel": "sendLabel"; "signingInLabel": "signingInLabel"; "replyLabel": "replyLabel"; "sendingLabel": "sendingLabel"; "permissionDeniedLabel": "permissionDeniedLabel"; "postCommentLabel": "postCommentLabel"; "postReplyLabel": "postReplyLabel"; "allowAttachments": "allowAttachments"; "fixedHeight": "fixedHeight"; "maxMessages": "maxMessages"; "maxVisibleMessages": "maxVisibleMessages"; "genericAvatarUrl": "genericAvatarUrl"; "shouldInterceptMessageSend": "shouldInterceptMessageSend"; "participants": "participants"; "source": "source"; "hashtags": "hashtags"; "topicID": "topicID"; "sortOrder": "sortOrder"; "filterMode": "filterMode"; "metadata": "metadata"; }, { "signInSelected": "signInSelected"; "editAvatarSelected": "editAvatarSelected"; "permissionDeniedError": "permissionDeniedError"; "upvoted": "upvoted"; "reported": "reported"; "selected": "selected"; "userSelected": "userSelected"; "usernameSelected": "usernameSelected"; "avatarSelected": "avatarSelected"; "shared": "shared"; }, ["sendReplyOptionsTemplate"], never, false>;
 }

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

@@ -1,12 +1,16 @@
-import { CommentsOrder } from "@banta/common";
 import * as i0 from "@angular/core";
 export declare class CommentSortComponent {
-    commentsOrder: typeof CommentsOrder;
+    commentsOrder: {
+        readonly NEWEST: "newest";
+        readonly OLDEST: "oldest";
+        readonly LIKES: "likes";
+        readonly options: readonly ["newest", "oldest", "likes"];
+    };
     private _sortChange;
     private _sort;
-    get sort(): CommentsOrder;
-    set sort(value: CommentsOrder);
-    get sortChange(): import("rxjs").Observable<CommentsOrder>;
+    get sort(): "newest" | "oldest" | "likes";
+    set sort(value: "newest" | "oldest" | "likes");
+    get sortChange(): import("rxjs").Observable<"newest" | "oldest" | "likes">;
     static ɵfac: i0.ɵɵFactoryDeclaration<CommentSortComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<CommentSortComponent, "banta-comment-sort", never, { "sort": "sort"; }, { "sortChange": "sortChange"; }, never, never, false>;
 }

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

@@ -1,5 +1,5 @@
 import { ElementRef, QueryList } from "@angular/core";
-import { User, ChatMessage, CommentsOrder, FilterMode } from '@banta/common';
+import { User, ChatMessage } from '@banta/common';
 import { ChatBackendBase } from "../../chat-backend-base";
 import { ChatSourceBase } from "../../chat-source-base";
 import { MessageMenuItem } from "../../message-menu-item";
@@ -62,8 +62,8 @@ export declare class CommentViewComponent {
     readonly deleted: import("rxjs").Observable<ChatMessage>;
     readonly selected: import("rxjs").Observable<ChatMessage>;
     readonly messageEdited: import("rxjs").Observable<EditEvent>;
-    readonly sortOrderChanged: import("rxjs").Observable<CommentsOrder>;
-    readonly filterModeChanged: import("rxjs").Observable<FilterMode>;
+    readonly sortOrderChanged: import("rxjs").Observable<"newest" | "oldest" | "likes">;
+    readonly filterModeChanged: import("rxjs").Observable<string>;
     commentsQuery: QueryList<CommentComponent>;
     messageContainer: ElementRef<HTMLElement>;
     get comments(): CommentComponent[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@banta/sdk",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -17,7 +17,7 @@
     "@angular/router": "^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0 || ^14.0.0",
     "@astronautlabs/datastore": "^3.1.2",
     "@astronautlabs/datastore-firestore": "^3.1.2",
-    "@banta/common": "^2.2.21",
+    "@banta/common": "~2.3.1",
     "@types/marked": "^4.0.3",
     "@types/dompurify": "^2.3.3",
     "dompurify": "^2.3.10",