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

package/dist/websocket.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.11.4-rc.9",
+  "version": "0.12.3-rc.2",
   "author": "Dessalines <tyhou13@gmx.com>",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -10,6 +10,7 @@
   ],
   "scripts": {
     "build": "tsc",
+    "docs": "typedoc src/index.ts --sourcefile-url-prefix 'https://github.com/LemmyNet/lemmy-js-client/tree/main/src/'",
     "lint": "tsc --noEmit && eslint --report-unused-disable-directives --ext .js,.ts,.tsx src",
     "prepare": "yarn run build"
   },
@@ -23,6 +24,8 @@
     "node-fetch": "^2.6.1",
     "prettier": "^2.3.2",
     "sortpack": "^2.2.0",
+    "typedoc": "^0.21.6",
+    "typedoc-plugin-sourcefile-url": "^1.0.6",
     "typescript": "^4.3.5"
   },
   "types": "./dist/index.d.ts",