Starting to add comment tree paging

package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.17.0-rc.33",
+  "version": "0.17.0-rc.37",
   "author": "Dessalines <tyhou13@gmx.com>",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -19,23 +19,23 @@
     "@sniptt/monads": "^0.5.10",
     "@types/node": "^17.0.33",
     "@types/node-fetch": "^3.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.23.0",
-    "@typescript-eslint/parser": "^5.23.0",
+    "@typescript-eslint/eslint-plugin": "^5.31.0",
+    "@typescript-eslint/parser": "^5.31.0",
     "class-transformer": "^0.5.1",
-    "eslint": "^8.15.0",
-    "eslint-plugin-prettier": "^4.0.0",
+    "eslint": "^8.20.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.1",
     "lint-staged": "^12.4.1",
-    "node-fetch": "^3.2.4",
-    "prettier": "^2.6.2",
+    "node-fetch": "^3.2.9",
+    "prettier": "^2.7.1",
     "prettier-plugin-import-sort": "^0.0.7",
-    "prettier-plugin-organize-imports": "^2.3.4",
+    "prettier-plugin-organize-imports": "^3.0.0",
     "prettier-plugin-packagejson": "^2.2.18",
     "reflect-metadata": "^0.1.13",
-    "sortpack": "^2.2.0",
+    "sortpack": "^2.3.0",
     "typedoc": "^0.21.6",
     "typedoc-plugin-sourcefile-url": "^1.0.6",
-    "typescript": "^4.6.4"
+    "typescript": "^4.7.4"
   },
   "types": "./dist/index.d.ts",
   "lint-staged": {

src/http.ts

@@ -12,7 +12,6 @@ import {
   GetCommentsResponse,
   ListCommentReports,
   ListCommentReportsResponse,
-  MarkCommentAsRead,
   RemoveComment,
   ResolveCommentReport,
   SaveComment,
@@ -66,6 +65,7 @@ import {
   Login,
   LoginResponse,
   MarkAllAsRead,
+  MarkCommentReplyAsRead,
   MarkPersonMentionAsRead,
   MarkPrivateMessageAsRead,
   PasswordChange,
@@ -578,7 +578,7 @@ export class LemmyHttp {
    *
    * `HTTP.POST /comment/mark_as_read`
    */
-  async markCommentAsRead(form: MarkCommentAsRead) {
+  async markCommentReplyAsRead(form: MarkCommentReplyAsRead) {
     return this.wrapper(
       HttpType.Post,
       "/comment/mark_as_read",
@@ -1098,20 +1098,14 @@ export class LemmyHttp {
   ): Promise<ResponseType> {
     if (type_ == HttpType.Get) {
       let getUrl = `${this.buildFullUrl(endpoint)}?${encodeGetParams(form)}`;
-      return (
-        fetch(getUrl, {
-          method: "GET",
-          headers: this.headers,
-        })
-          // TODO test this
-          .then(
-            d =>
-              d
-                .text()
-                .then(a =>
-                  deserialize(responseClass, a)
-                ) as Promise<ResponseType>
-          )
+      return fetch(getUrl, {
+        method: "GET",
+        headers: this.headers,
+      }).then(
+        d =>
+          d
+            .text()
+            .then(a => deserialize(responseClass, a)) as Promise<ResponseType>
       );
     } else {
       return fetch(this.buildFullUrl(endpoint), {
@@ -1121,18 +1115,20 @@ export class LemmyHttp {
           ...this.headers,
         },
         body: serialize(form),
-      }).then(d => d.json() as Promise<ResponseType>);
+      }).then(
+        d =>
+          d
+            .text()
+            .then(a => deserialize(responseClass, a)) as Promise<ResponseType>
+      );
     }
   }
 }
 
 function encodeGetParams<BodyType>(p: BodyType): string {
   // Necessary to remove the Options
   let serialized = JSON.parse(serialize(p));
-  return (
-    Object.entries(serialized)
-      // TODO test this, it might serialize the undefineds
-      .map(kv => kv.map(encodeURIComponent).join("="))
-      .join("&")
-  );
+  return Object.entries(serialized)
+    .map(kv => kv.map(encodeURIComponent).join("="))
+    .join("&");
 }

src/interfaces/aggregates.ts

@@ -91,4 +91,5 @@ export interface CommentAggregates {
   score: number;
   upvotes: number;
   downvotes: number;
+  child_count: number;
 }

src/interfaces/api/comment.ts

@@ -2,7 +2,7 @@ import { Option } from "@sniptt/monads";
 import { Expose, Transform, Type } from "class-transformer";
 import "reflect-metadata";
 import { toOption, toUndefined } from "../../utils";
-import { ListingType, SortType } from "../others";
+import { CommentSortType, ListingType } from "../others";
 import { CommentReportView, CommentView } from "../views";
 
 export class CreateComment {
@@ -73,19 +73,6 @@ export class RemoveComment {
   }
 }
 
-/**
- * Only the recipient can do this.
- */
-export class MarkCommentAsRead {
-  comment_id: number;
-  read: boolean;
-  auth: string;
-
-  constructor(init: MarkCommentAsRead) {
-    Object.assign(this, init);
-  }
-}
-
 export class SaveComment {
   comment_id: number;
   save: boolean;
@@ -133,7 +120,11 @@ export class GetComments {
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
   @Expose()
-  sort: Option<SortType>;
+  sort: Option<CommentSortType>;
+  @Transform(({ value }) => toOption(value), { toClassOnly: true })
+  @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
+  @Expose()
+  max_depth: Option<number>;
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
   @Expose()
@@ -153,6 +144,14 @@ export class GetComments {
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
   @Expose()
+  post_id: Option<number>;
+  @Transform(({ value }) => toOption(value), { toClassOnly: true })
+  @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
+  @Expose()
+  parent_id: Option<number>;
+  @Transform(({ value }) => toOption(value), { toClassOnly: true })
+  @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
+  @Expose()
   saved_only: Option<boolean>;
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })

src/interfaces/api/person.ts

@@ -2,8 +2,9 @@ import { Option } from "@sniptt/monads";
 import { Expose, Transform, Type } from "class-transformer";
 import "reflect-metadata";
 import { toOption, toUndefined } from "../../utils";
-import { SortType } from "../others";
+import { CommentSortType, SortType } from "../others";
 import {
+  CommentReplyView,
   CommentView,
   CommunityModeratorView,
   PersonMentionView,
@@ -275,8 +276,8 @@ export class GetPersonDetailsResponse {
 }
 
 export class GetRepliesResponse {
-  @Type(() => CommentView)
-  replies: CommentView[];
+  @Type(() => CommentReplyView)
+  replies: CommentReplyView[];
 }
 
 export class GetPersonMentionsResponse {
@@ -346,7 +347,7 @@ export class GetReplies {
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
   @Expose()
-  sort: Option<SortType>;
+  sort: Option<CommentSortType>;
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
   @Expose()
@@ -370,7 +371,7 @@ export class GetPersonMentions {
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
   @Expose()
-  sort: Option<SortType>;
+  sort: Option<CommentSortType>;
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
   @Expose()
@@ -405,6 +406,21 @@ export class PersonMentionResponse {
   person_mention_view: PersonMentionView;
 }
 
+export class MarkCommentReplyAsRead {
+  comment_reply_id: number;
+  read: boolean;
+  auth: string;
+
+  constructor(init: MarkCommentReplyAsRead) {
+    Object.assign(this, init);
+  }
+}
+
+export class CommentReplyResponse {
+  @Type(() => CommentReplyView)
+  comment_reply_view: CommentReplyView;
+}
+
 /**
  * Permanently deletes your posts and comments
  */

src/interfaces/api/post.ts

@@ -4,7 +4,6 @@ import "reflect-metadata";
 import { toOption, toUndefined } from "../../utils";
 import { ListingType, SiteMetadata, SortType } from "../others";
 import {
-  CommentView,
   CommunityModeratorView,
   CommunityView,
   PostReportView,
@@ -43,7 +42,14 @@ export class PostResponse {
 }
 
 export class GetPost {
-  id: number;
+  @Transform(({ value }) => toOption(value), { toClassOnly: true })
+  @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
+  @Expose()
+  id: Option<number>;
+  @Transform(({ value }) => toOption(value), { toClassOnly: true })
+  @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
+  @Expose()
+  comment_id: Option<number>;
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
   @Expose()
@@ -59,8 +65,6 @@ export class GetPostResponse {
   post_view: PostView;
   @Type(() => CommunityView)
   community_view: CommunityView;
-  @Type(() => CommentView)
-  comments: CommentView[];
   @Type(() => CommunityModeratorView)
   moderators: CommunityModeratorView[];
   online: number;

src/interfaces/others.ts

@@ -19,7 +19,6 @@ export enum UserOperation {
   EditComment,
   DeleteComment,
   RemoveComment,
-  MarkCommentAsRead,
   SaveComment,
   CreateCommentLike,
   GetPosts,
@@ -39,6 +38,7 @@ export enum UserOperation {
   GetReplies,
   GetPersonMentions,
   MarkPersonMentionAsRead,
+  MarkCommentReplyAsRead,
   GetModlog,
   BanFromCommunity,
   AddModToCommunity,
@@ -89,18 +89,25 @@ export enum UserOperation {
 }
 
 /**
- * Different sort types used in lemmy.
+ * Different post sort types used in lemmy.
  */
 export enum SortType {
   /**
-   * Posts sorted by the most recent comment.
+   * Posts sorted by hot, but bumped by new comments up to 2 days
    */
   Active = "Active",
   /**
-   * Posts sorted by the published time.
+   * Posts sorted by a decaying rank.
    */
   Hot = "Hot",
+  /**
+   * Posts sorted by the published time.
+   */
   New = "New",
+  /**
+   * Posts sorted by the published time ascending
+   */
+  Old = "Old",
   /**
    * The top posts for this last day.
    */
@@ -131,6 +138,28 @@ export enum SortType {
   NewComments = "NewComments",
 }
 
+/**
+ * Different comment sort types used in lemmy.
+ */
+export enum CommentSortType {
+  /**
+   * Comments sorted by a decaying rank.
+   */
+  Hot = "Hot",
+  /**
+   * Comments sorted by top score.
+   */
+  Top = "Top",
+  /**
+   * Comments sorted by new.
+   */
+  New = "New",
+  /**
+   * Comments sorted by old.
+   */
+  Old = "Old",
+}
+
 /**
  * The different listing types for post and comment fetches.
  */

src/interfaces/source.ts

@@ -443,13 +443,8 @@ export class Comment {
   id: number;
   creator_id: number;
   post_id: number;
-  @Transform(({ value }) => toOption(value), { toClassOnly: true })
-  @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
-  @Expose()
-  parent_id: Option<number>;
   content: string;
   removed: boolean;
-  read: boolean; // Whether the recipient has read the comment or not
   published: string;
   @Transform(({ value }) => toOption(value), { toClassOnly: true })
   @Transform(({ value }) => toUndefined(value), { toPlainOnly: true })
@@ -458,6 +453,7 @@ export class Comment {
   deleted: boolean;
   ap_id: string;
   local: boolean;
+  path: string;
 }
 
 export class PersonMention {
@@ -468,6 +464,14 @@ export class PersonMention {
   published: string;
 }
 
+export class CommentReply {
+  id: number;
+  recipient_id: number;
+  comment_id: number;
+  read: boolean;
+  published: string;
+}
+
 export class RegistrationApplication {
   id: number;
   local_user_id: number;