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

package/dist/http.js

@@ -56,11 +56,14 @@ var HttpType;
     HttpType["Post"] = "POST";
     HttpType["Put"] = "PUT";
 })(HttpType || (HttpType = {}));
+/**
+ * Helps build lemmy HTTP requests.
+ */
 var LemmyHttp = /** @class */ (function () {
     /**
-     * Generates a new instance of LemmyHttp
+     * Generates a new instance of LemmyHttp.
      * @param baseUrl the base url, without the vX version: https://lemmy.ml -> goes to https://lemmy.ml/api/vX
-     * @param headers optional headers. Should contain x-real-ip and x-forwarded-for
+     * @param headers optional headers. Should contain `x-real-ip` and `x-forwarded-for` .
      */
     function LemmyHttp(baseUrl, headers) {
         this.headers = {};
@@ -69,6 +72,9 @@ var LemmyHttp = /** @class */ (function () {
             this.headers = headers;
         }
     }
+    /**
+     * Gets the site, and your user data.
+     */
     LemmyHttp.prototype.getSite = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -76,6 +82,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Create your site.
+     */
     LemmyHttp.prototype.createSite = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -83,6 +92,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Edit your site.
+     */
     LemmyHttp.prototype.editSite = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -90,6 +102,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Transfer your site to another user.
+     */
     LemmyHttp.prototype.transferSite = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -97,6 +112,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get your site configuration.
+     */
     LemmyHttp.prototype.getSiteConfig = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -104,6 +122,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Save your site config.
+     */
     LemmyHttp.prototype.saveSiteConfig = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -111,6 +132,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get the modlog.
+     */
     LemmyHttp.prototype.getModlog = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -118,6 +142,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Search lemmy.
+     */
     LemmyHttp.prototype.search = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -125,6 +152,19 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Fetch a non-local / federated object.
+     */
+    LemmyHttp.prototype.resolveObject = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Get, '/resolve_object', form)];
+            });
+        });
+    };
+    /**
+     * Create a new community.
+     */
     LemmyHttp.prototype.createCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -132,6 +172,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get / fetch a community.
+     */
     LemmyHttp.prototype.getCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -139,6 +182,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Edit a community.
+     */
     LemmyHttp.prototype.editCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -146,6 +192,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * List communities, with various filters.
+     */
     LemmyHttp.prototype.listCommunities = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -153,6 +202,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Follow / subscribe to a community.
+     */
     LemmyHttp.prototype.followCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -160,6 +212,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Block a community.
+     */
     LemmyHttp.prototype.blockCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -167,6 +222,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Delete a community.
+     */
     LemmyHttp.prototype.deleteCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -174,6 +232,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * A moderator remove for a community.
+     */
     LemmyHttp.prototype.removeCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -181,6 +242,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Transfer your community to an existing moderator.
+     */
     LemmyHttp.prototype.transferCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -188,6 +252,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Ban a user from a community.
+     */
     LemmyHttp.prototype.banFromCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -195,6 +262,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Add a moderator to your community.
+     */
     LemmyHttp.prototype.addModToCommunity = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -202,6 +272,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Create a post.
+     */
     LemmyHttp.prototype.createPost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -209,6 +282,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get / fetch a post.
+     */
     LemmyHttp.prototype.getPost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -216,6 +292,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Edit a post.
+     */
     LemmyHttp.prototype.editPost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -223,6 +302,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Delete a post.
+     */
     LemmyHttp.prototype.deletePost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -230,6 +312,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * A moderator remove for a post.
+     */
     LemmyHttp.prototype.removePost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -237,6 +322,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * A moderator can lock a post ( IE disable new comments ).
+     */
     LemmyHttp.prototype.lockPost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -244,6 +332,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * A moderator can sticky a post ( IE stick it to the top of a community ).
+     */
     LemmyHttp.prototype.stickyPost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -251,6 +342,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get / fetch posts, with various filters.
+     */
     LemmyHttp.prototype.getPosts = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -258,6 +352,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Like / vote on a post.
+     */
     LemmyHttp.prototype.likePost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -265,6 +362,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Save a post.
+     */
     LemmyHttp.prototype.savePost = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -272,6 +372,49 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Report a post.
+     */
+    LemmyHttp.prototype.createPostReport = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Post, '/post/report', form)];
+            });
+        });
+    };
+    /**
+     * Resolve a post report. Only a mod can do this.
+     */
+    LemmyHttp.prototype.resolvePostReport = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Put, '/post/report/resolve', form)];
+            });
+        });
+    };
+    /**
+     * List post reports.
+     */
+    LemmyHttp.prototype.listPostReports = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Get, '/post/report/list', form)];
+            });
+        });
+    };
+    /**
+     * Fetch metadata for any given site.
+     */
+    LemmyHttp.prototype.getSiteMetadata = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Get, '/post/site_metadata', form)];
+            });
+        });
+    };
+    /**
+     * Create a comment.
+     */
     LemmyHttp.prototype.createComment = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -279,6 +422,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Edit a comment.
+     */
     LemmyHttp.prototype.editComment = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -286,6 +432,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Delete a comment.
+     */
     LemmyHttp.prototype.deleteComment = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -293,6 +442,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * A moderator remove for a comment.
+     */
     LemmyHttp.prototype.removeComment = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -300,6 +452,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Mark a comment as read.
+     */
     LemmyHttp.prototype.markCommentAsRead = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -307,6 +462,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Like / vote on a comment.
+     */
     LemmyHttp.prototype.likeComment = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -314,6 +472,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Save a comment.
+     */
     LemmyHttp.prototype.saveComment = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -321,6 +482,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get / fetch comments.
+     */
     LemmyHttp.prototype.getComments = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -328,6 +492,39 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Report a comment.
+     */
+    LemmyHttp.prototype.createCommentReport = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Post, '/comment/report', form)];
+            });
+        });
+    };
+    /**
+     * Resolve a comment report. Only a mod can do this.
+     */
+    LemmyHttp.prototype.resolveCommentReport = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Put, '/comment/report/resolve', form)];
+            });
+        });
+    };
+    /**
+     * List comment reports.
+     */
+    LemmyHttp.prototype.listCommentReports = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Get, '/comment/report/list', form)];
+            });
+        });
+    };
+    /**
+     * Get / fetch private messages.
+     */
     LemmyHttp.prototype.getPrivateMessages = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -335,6 +532,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Create a private message.
+     */
     LemmyHttp.prototype.createPrivateMessage = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -342,6 +542,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Edit a private message.
+     */
     LemmyHttp.prototype.editPrivateMessage = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -349,6 +552,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Delete a private message.
+     */
     LemmyHttp.prototype.deletePrivateMessage = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -356,6 +562,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Mark a private message as read.
+     */
     LemmyHttp.prototype.markPrivateMessageAsRead = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -363,6 +572,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Register a new user.
+     */
     LemmyHttp.prototype.register = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -370,6 +582,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Log into lemmy.
+     */
     LemmyHttp.prototype.login = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -377,6 +592,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get the details for a person.
+     */
     LemmyHttp.prototype.getPersonDetails = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -384,6 +602,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get mentions for your user.
+     */
     LemmyHttp.prototype.getPersonMentions = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -391,6 +612,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Mark a person mention as read.
+     */
     LemmyHttp.prototype.markPersonMentionAsRead = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -398,6 +622,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get comment replies.
+     */
     LemmyHttp.prototype.getReplies = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -405,6 +632,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Ban a person from your site.
+     */
     LemmyHttp.prototype.banPerson = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -412,6 +642,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Block a person.
+     */
     LemmyHttp.prototype.blockPerson = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -419,6 +652,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Fetch a Captcha.
+     */
     LemmyHttp.prototype.getCaptcha = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -426,6 +662,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Delete your account.
+     */
     LemmyHttp.prototype.deleteAccount = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -433,6 +672,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Reset your password.
+     */
     LemmyHttp.prototype.passwordReset = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -440,6 +682,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Change your password from an email / token based reset.
+     */
     LemmyHttp.prototype.passwordChange = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -447,6 +692,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Mark all replies as read.
+     */
     LemmyHttp.prototype.markAllAsRead = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -454,6 +702,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Save your user settings.
+     */
     LemmyHttp.prototype.saveUserSettings = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -461,6 +712,9 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Change your user password.
+     */
     LemmyHttp.prototype.changePassword = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -468,6 +722,19 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get counts for your reports
+     */
+    LemmyHttp.prototype.getReportCount = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Get, '/user/report_count', form)];
+            });
+        });
+    };
+    /**
+     * Add an admin to your site.
+     */
     LemmyHttp.prototype.addAdmin = function (form) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {