lemmy-js-client 0.11.4-rc.9 → 0.12.3-rc.2

package/dist/interfaces/others.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchType = exports.ListingType = exports.SortType = exports.UserOperation = exports.VERSION = void 0;
 exports.VERSION = 'v3';
 /**
- * All of the websocket operations available
+ * All of the websocket operations available.
  */
 var UserOperation;
 (function (UserOperation) {
@@ -47,41 +47,83 @@ var UserOperation;
     UserOperation[UserOperation["AddAdmin"] = 37] = "AddAdmin";
     UserOperation[UserOperation["BanPerson"] = 38] = "BanPerson";
     UserOperation[UserOperation["Search"] = 39] = "Search";
-    UserOperation[UserOperation["MarkAllAsRead"] = 40] = "MarkAllAsRead";
-    UserOperation[UserOperation["SaveUserSettings"] = 41] = "SaveUserSettings";
-    UserOperation[UserOperation["TransferCommunity"] = 42] = "TransferCommunity";
-    UserOperation[UserOperation["TransferSite"] = 43] = "TransferSite";
-    UserOperation[UserOperation["DeleteAccount"] = 44] = "DeleteAccount";
-    UserOperation[UserOperation["PasswordReset"] = 45] = "PasswordReset";
-    UserOperation[UserOperation["PasswordChange"] = 46] = "PasswordChange";
-    UserOperation[UserOperation["CreatePrivateMessage"] = 47] = "CreatePrivateMessage";
-    UserOperation[UserOperation["EditPrivateMessage"] = 48] = "EditPrivateMessage";
-    UserOperation[UserOperation["DeletePrivateMessage"] = 49] = "DeletePrivateMessage";
-    UserOperation[UserOperation["MarkPrivateMessageAsRead"] = 50] = "MarkPrivateMessageAsRead";
-    UserOperation[UserOperation["GetPrivateMessages"] = 51] = "GetPrivateMessages";
-    UserOperation[UserOperation["UserJoin"] = 52] = "UserJoin";
-    UserOperation[UserOperation["GetComments"] = 53] = "GetComments";
-    UserOperation[UserOperation["GetSiteConfig"] = 54] = "GetSiteConfig";
-    UserOperation[UserOperation["SaveSiteConfig"] = 55] = "SaveSiteConfig";
-    UserOperation[UserOperation["PostJoin"] = 56] = "PostJoin";
-    UserOperation[UserOperation["CommunityJoin"] = 57] = "CommunityJoin";
-    UserOperation[UserOperation["ChangePassword"] = 58] = "ChangePassword";
-    UserOperation[UserOperation["BlockCommunity"] = 59] = "BlockCommunity";
-    UserOperation[UserOperation["BlockPerson"] = 60] = "BlockPerson";
+    UserOperation[UserOperation["ResolveObject"] = 40] = "ResolveObject";
+    UserOperation[UserOperation["MarkAllAsRead"] = 41] = "MarkAllAsRead";
+    UserOperation[UserOperation["SaveUserSettings"] = 42] = "SaveUserSettings";
+    UserOperation[UserOperation["TransferCommunity"] = 43] = "TransferCommunity";
+    UserOperation[UserOperation["TransferSite"] = 44] = "TransferSite";
+    UserOperation[UserOperation["DeleteAccount"] = 45] = "DeleteAccount";
+    UserOperation[UserOperation["PasswordReset"] = 46] = "PasswordReset";
+    UserOperation[UserOperation["PasswordChange"] = 47] = "PasswordChange";
+    UserOperation[UserOperation["CreatePrivateMessage"] = 48] = "CreatePrivateMessage";
+    UserOperation[UserOperation["EditPrivateMessage"] = 49] = "EditPrivateMessage";
+    UserOperation[UserOperation["DeletePrivateMessage"] = 50] = "DeletePrivateMessage";
+    UserOperation[UserOperation["MarkPrivateMessageAsRead"] = 51] = "MarkPrivateMessageAsRead";
+    UserOperation[UserOperation["GetPrivateMessages"] = 52] = "GetPrivateMessages";
+    UserOperation[UserOperation["UserJoin"] = 53] = "UserJoin";
+    UserOperation[UserOperation["GetComments"] = 54] = "GetComments";
+    UserOperation[UserOperation["GetSiteConfig"] = 55] = "GetSiteConfig";
+    UserOperation[UserOperation["SaveSiteConfig"] = 56] = "SaveSiteConfig";
+    UserOperation[UserOperation["PostJoin"] = 57] = "PostJoin";
+    UserOperation[UserOperation["CommunityJoin"] = 58] = "CommunityJoin";
+    UserOperation[UserOperation["ChangePassword"] = 59] = "ChangePassword";
+    UserOperation[UserOperation["GetSiteMetadata"] = 60] = "GetSiteMetadata";
+    UserOperation[UserOperation["BlockCommunity"] = 61] = "BlockCommunity";
+    UserOperation[UserOperation["BlockPerson"] = 62] = "BlockPerson";
+    UserOperation[UserOperation["CreateCommentReport"] = 63] = "CreateCommentReport";
+    UserOperation[UserOperation["ResolveCommentReport"] = 64] = "ResolveCommentReport";
+    UserOperation[UserOperation["ListCommentReports"] = 65] = "ListCommentReports";
+    UserOperation[UserOperation["CreatePostReport"] = 66] = "CreatePostReport";
+    UserOperation[UserOperation["ResolvePostReport"] = 67] = "ResolvePostReport";
+    UserOperation[UserOperation["ListPostReports"] = 68] = "ListPostReports";
+    UserOperation[UserOperation["GetReportCount"] = 69] = "GetReportCount";
 })(UserOperation = exports.UserOperation || (exports.UserOperation = {}));
+/**
+ * Different sort types used in lemmy.
+ */
 var SortType;
 (function (SortType) {
+    /**
+     * Posts sorted by the most recent comment.
+     */
     SortType["Active"] = "Active";
+    /**
+     * Posts sorted by the published time.
+     */
     SortType["Hot"] = "Hot";
     SortType["New"] = "New";
+    /**
+     * The top posts for this last day.
+     */
     SortType["TopDay"] = "TopDay";
+    /**
+     * The top posts for this last week.
+     */
     SortType["TopWeek"] = "TopWeek";
+    /**
+     * The top posts for this last month.
+     */
     SortType["TopMonth"] = "TopMonth";
+    /**
+     * The top posts for this last year.
+     */
     SortType["TopYear"] = "TopYear";
+    /**
+     * The top posts of all time.
+     */
     SortType["TopAll"] = "TopAll";
+    /**
+     * Posts sorted by the most comments.
+     */
     SortType["MostComments"] = "MostComments";
+    /**
+     * Posts sorted by the newest comments, with no necrobumping. IE a forum sort.
+     */
     SortType["NewComments"] = "NewComments";
 })(SortType = exports.SortType || (exports.SortType = {}));
+/**
+ * The different listing types for post and comment fetches.
+ */
 var ListingType;
 (function (ListingType) {
     ListingType["All"] = "All";
@@ -89,6 +131,9 @@ var ListingType;
     ListingType["Subscribed"] = "Subscribed";
     ListingType["Community"] = "Community";
 })(ListingType = exports.ListingType || (exports.ListingType = {}));
+/**
+ * Search types for lemmy's search.
+ */
 var SearchType;
 (function (SearchType) {
     SearchType["All"] = "All";

package/dist/interfaces/source.d.ts

@@ -166,6 +166,14 @@ export interface ModAddCommunity {
     removed?: boolean;
     when_: string;
 }
+export interface ModTransferCommunity {
+    id: number;
+    mod_person_id: number;
+    other_person_id: number;
+    community_id: number;
+    removed?: boolean;
+    when_: string;
+}
 export interface ModAdd {
     id: number;
     mod_person_id: number;

package/dist/interfaces/views.d.ts

@@ -1,5 +1,5 @@
 import { CommentAggregates, CommunityAggregates, PostAggregates, SiteAggregates, PersonAggregates } from './aggregates';
-import { Comment, CommentReport, CommunitySafe, ModAdd, ModAddCommunity, ModBan, ModBanFromCommunity, ModLockPost, ModRemoveComment, ModRemoveCommunity, ModRemovePost, ModStickyPost, Post, PostReport, PrivateMessage, Site, PersonMention, PersonSafe, LocalUserSettings } from './source';
+import { Comment, CommentReport, CommunitySafe, ModAdd, ModAddCommunity, ModTransferCommunity, ModBan, ModBanFromCommunity, ModLockPost, ModRemoveComment, ModRemoveCommunity, ModRemovePost, ModStickyPost, Post, PostReport, PrivateMessage, Site, PersonMention, PersonSafe, LocalUserSettings } from './source';
 export interface PersonViewSafe {
     person: PersonSafe;
     counts: PersonAggregates;
@@ -81,6 +81,12 @@ export interface ModAddCommunityView {
     community: CommunitySafe;
     modded_person: PersonSafe;
 }
+export interface ModTransferCommunityView {
+    mod_transfer_community: ModTransferCommunity;
+    moderator: PersonSafe;
+    community: CommunitySafe;
+    modded_person: PersonSafe;
+}
 export interface ModAddView {
     mod_add: ModAdd;
     moderator: PersonSafe;

package/dist/websocket.d.ts

@@ -1,73 +1,304 @@
-import { CreateComment, CreateCommentLike, DeleteComment, EditComment, GetComments, MarkCommentAsRead, RemoveComment, SaveComment } from './interfaces/api/comment';
+import { CreateComment, CreateCommentLike, CreateCommentReport, DeleteComment, EditComment, GetComments, ListCommentReports, MarkCommentAsRead, RemoveComment, ResolveCommentReport, SaveComment } from './interfaces/api/comment';
 import { AddModToCommunity, BanFromCommunity, BlockCommunity, CreateCommunity, DeleteCommunity, EditCommunity, FollowCommunity, GetCommunity, ListCommunities, RemoveCommunity, TransferCommunity } from './interfaces/api/community';
-import { CreatePost, CreatePostLike, DeletePost, EditPost, GetPost, GetPosts, LockPost, RemovePost, SavePost, StickyPost } from './interfaces/api/post';
-import { CreateSite, EditSite, GetModlog, GetSite, GetSiteConfig, SaveSiteConfig, Search, TransferSite } from './interfaces/api/site';
-import { AddAdmin, BanPerson, CreatePrivateMessage, DeleteAccount, DeletePrivateMessage, EditPrivateMessage, GetPrivateMessages, GetReplies, GetPersonDetails, GetPersonMentions, Login, MarkAllAsRead, MarkPrivateMessageAsRead, MarkPersonMentionAsRead, PasswordChange, PasswordReset, Register, SaveUserSettings, ChangePassword, BlockPerson } from './interfaces/api/person';
+import { CreatePost, CreatePostLike, CreatePostReport, DeletePost, EditPost, GetPost, GetPosts, GetSiteMetadata, ListPostReports, LockPost, RemovePost, ResolvePostReport, SavePost, StickyPost } from './interfaces/api/post';
+import { CreateSite, EditSite, GetModlog, GetSite, GetSiteConfig, ResolveObject, SaveSiteConfig, Search, TransferSite } from './interfaces/api/site';
+import { AddAdmin, BanPerson, CreatePrivateMessage, DeleteAccount, DeletePrivateMessage, EditPrivateMessage, GetPrivateMessages, GetReplies, GetPersonDetails, GetPersonMentions, Login, MarkAllAsRead, MarkPrivateMessageAsRead, MarkPersonMentionAsRead, PasswordChange, PasswordReset, Register, SaveUserSettings, ChangePassword, BlockPerson, GetReportCount } from './interfaces/api/person';
 import { UserJoin, PostJoin, CommunityJoin } from './interfaces/api/websocket';
 /**
- * Helps build lemmy websocket message requests, that you can use in your Websocket sends
+ * Helps build lemmy websocket message requests, that you can use in your Websocket sends.
+ *
+ * You'll receive back a [[WebSocketResponse]].
+ *
+ * The return types for these are given in [[LemmyHttp]]
  */
 export declare class LemmyWebsocket {
     constructor();
+    /**
+     * Log into lemmy.
+     */
     login(form: Login): string;
+    /**
+     * A websocket join for your user.
+     *
+     * Allows your user to receive private messages and notifications.
+     */
     userJoin(form: UserJoin): string;
+    /**
+     * A websocket join for the current post room.
+     *
+     * Allows your user to receive new comments and updates for that post.
+     */
     postJoin(form: PostJoin): string;
+    /**
+     * A websocket join for a given community.
+     *
+     * Allows your user to receive community updates.
+     *
+     * Note: community_id: 0, is your front page.
+     */
     communityJoin(form: CommunityJoin): string;
+    /**
+     * Register a new user.
+     */
     register(register: Register): string;
+    /**
+     * Fetch a Captcha.
+     */
     getCaptcha(): string;
+    /**
+     * Create a new community.
+     */
     createCommunity(form: CreateCommunity): string;
+    /**
+     * Edit a community.
+     */
     editCommunity(form: EditCommunity): string;
+    /**
+     * Delete a community.
+     */
     deleteCommunity(form: DeleteCommunity): string;
+    /**
+     * A moderator remove for a community.
+     */
     removeCommunity(form: RemoveCommunity): string;
+    /**
+     * Follow / subscribe to a community.
+     */
     followCommunity(form: FollowCommunity): string;
+    /**
+     * List communities, with various filters.
+     */
     listCommunities(form: ListCommunities): string;
+    /**
+     * Create a post.
+     */
     createPost(form: CreatePost): string;
+    /**
+     * Get / fetch a post.
+     */
     getPost(form: GetPost): string;
+    /**
+     * Get / fetch a community.
+     */
     getCommunity(form: GetCommunity): string;
+    /**
+     * Create a comment.
+     */
     createComment(form: CreateComment): string;
+    /**
+     * Edit a comment.
+     */
     editComment(form: EditComment): string;
+    /**
+     * Delete a comment.
+     */
     deleteComment(form: DeleteComment): string;
+    /**
+     * A moderator remove for a comment.
+     */
     removeComment(form: RemoveComment): string;
+    /**
+     * Mark a comment as read.
+     */
     markCommentAsRead(form: MarkCommentAsRead): string;
+    /**
+     * Like / vote on a comment.
+     */
     likeComment(form: CreateCommentLike): string;
+    /**
+     * Save a comment.
+     */
     saveComment(form: SaveComment): string;
+    /**
+     * Report a comment.
+     */
+    createCommentReport(form: CreateCommentReport): string;
+    /**
+     * Resolve a comment report. Only a mod can do this.
+     */
+    resolveCommentReport(form: ResolveCommentReport): string;
+    /**
+     * List comment reports.
+     */
+    listCommentReports(form: ListCommentReports): string;
+    /**
+     * Get / fetch posts, with various filters.
+     */
     getPosts(form: GetPosts): string;
+    /**
+     * Get / fetch comments.
+     */
     getComments(form: GetComments): string;
+    /**
+     * Like / vote on a post.
+     */
     likePost(form: CreatePostLike): string;
+    /**
+     * Edit a post.
+     */
     editPost(form: EditPost): string;
+    /**
+     * Delete a post.
+     */
     deletePost(form: DeletePost): string;
+    /**
+     * A moderator remove for a post.
+     */
     removePost(form: RemovePost): string;
+    /**
+     * A moderator can lock a post ( IE disable new comments ).
+     */
     lockPost(form: LockPost): string;
+    /**
+     * A moderator can sticky a post ( IE stick it to the top of a community ).
+     */
     stickyPost(form: StickyPost): string;
+    /**
+     * Save a post.
+     */
     savePost(form: SavePost): string;
+    /**
+     * Report a post.
+     */
+    createPostReport(form: CreatePostReport): string;
+    /**
+     * Resolve a post report. Only a mod can do this.
+     */
+    resolvePostReport(form: ResolvePostReport): string;
+    /**
+     * List post reports.
+     */
+    listPostReports(form: ListPostReports): string;
+    /**
+     * Fetch metadata for any given site.
+     */
+    getSiteMetadata(form: GetSiteMetadata): string;
+    /**
+     * Ban a user from a community.
+     */
     banFromCommunity(form: BanFromCommunity): string;
+    /**
+     * Add a moderator to your community.
+     */
     addModToCommunity(form: AddModToCommunity): string;
+    /**
+     * Transfer your community to an existing moderator.
+     */
     transferCommunity(form: TransferCommunity): string;
+    /**
+     * Transfer your site to another user.
+     */
     transferSite(form: TransferSite): string;
+    /**
+     * Ban a person from your site.
+     */
     banPerson(form: BanPerson): string;
+    /**
+     * Add an admin to your site.
+     */
     addAdmin(form: AddAdmin): string;
+    /**
+     * Get the details for a person.
+     */
     getPersonDetails(form: GetPersonDetails): string;
+    /**
+     * Get comment replies.
+     */
     getReplies(form: GetReplies): string;
+    /**
+     * Get mentions for your user.
+     */
     getPersonMentions(form: GetPersonMentions): string;
+    /**
+     * Mark a person mention as read.
+     */
     markPersonMentionAsRead(form: MarkPersonMentionAsRead): string;
+    /**
+     * Get the modlog.
+     */
     getModlog(form: GetModlog): string;
+    /**
+     * Create your site.
+     */
     createSite(form: CreateSite): string;
+    /**
+     * Edit your site.
+     */
     editSite(form: EditSite): string;
+    /**
+     * Gets the site, and your user data.
+     */
     getSite(form?: GetSite): string;
+    /**
+     * Get your site configuration.
+     */
     getSiteConfig(form: GetSiteConfig): string;
+    /**
+     * Search lemmy.
+     */
     search(form: Search): string;
+    /**
+     * Fetch a non-local / federated object.
+     */
+    resolveObject(form: ResolveObject): string;
+    /**
+     * Mark all replies as read.
+     */
     markAllAsRead(form: MarkAllAsRead): string;
+    /**
+     * Save your user settings.
+     */
     saveUserSettings(form: SaveUserSettings): string;
+    /**
+     * Change your user password.
+     */
     changePassword(form: ChangePassword): string;
+    /**
+     * Get counts for your reports
+     */
+    getReportCount(form: GetReportCount): string;
+    /**
+     * Delete your account.
+     */
     deleteAccount(form: DeleteAccount): string;
+    /**
+     * Reset your password.
+     */
     passwordReset(form: PasswordReset): string;
+    /**
+     * Change your password from an email / token based reset.
+     */
     passwordChange(form: PasswordChange): string;
+    /**
+     * Create a private message.
+     */
     createPrivateMessage(form: CreatePrivateMessage): string;
+    /**
+     * Edit a private message.
+     */
     editPrivateMessage(form: EditPrivateMessage): string;
+    /**
+     * Delete a private message.
+     */
     deletePrivateMessage(form: DeletePrivateMessage): string;
+    /**
+     * Mark a private message as read.
+     */
     markPrivateMessageAsRead(form: MarkPrivateMessageAsRead): string;
+    /**
+     * Get / fetch private messages.
+     */
     getPrivateMessages(form: GetPrivateMessages): string;
+    /**
+     * Save your site config.
+     */
     saveSiteConfig(form: SaveSiteConfig): string;
+    /**
+     * Block a person.
+     */
     blockPerson(form: BlockPerson): string;
+    /**
+     * Block a community.
+     */
     blockCommunity(form: BlockCommunity): string;
 }