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

package/README.md

@@ -16,39 +16,31 @@ A javascript / typescript http and websocket client and type system for [Lemmy](
 
 ## Usage
 
-Check out the [Lemmy HTTP / websocket API](https://dev.lemmy.ml/docs/contributing_websocket_http_api.html) for all the commands. 
+### Websocket Client
 
-### Websocket
+[LemmyWebsocket docs](classes/LemmyWebsocket.html)
 
-```js
-import { LoginForm, LemmyWebsocket } from 'lemmy-js-client';
+```ts
+import { Login, LemmyWebsocket } from 'lemmy-js-client';
 
 let client: LemmyWebsocket = new LemmyWebsocket();
+
+let form: Login {
+  username_or_email: "my_email@email.tld",
+  password: "my_pass",
+};
+
 this.ws.send(client.login(form));
 ```
 
-### HTTP
+### HTTP Client
+
+[LemmyHttp docs](classes/LemmyHttp.html)
 
-```js
+```ts
 import { LemmyHttp } from 'lemmy-js-client';
 
 let baseUrl = 'https://lemmy.ml';
 let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
 let jwt = await client.httpLogin(loginForm).jwt;
 ```
-
-## Support / Donate
-
-Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
-
-- [Support on Liberapay](https://liberapay.com/Lemmy).
-- [Support on Patreon](https://www.patreon.com/dessalines).
-- [Support on OpenCollective](https://opencollective.com/lemmy).
-- [List of Sponsors](https://dev.lemmy.ml/sponsors).
-
-### Crypto
-
-- bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
-- ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
-- monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
-

package/dist/http.d.ts

@@ -1,76 +1,289 @@
-import { CommentResponse, CreateComment, CreateCommentLike, DeleteComment, EditComment, GetComments, GetCommentsResponse, MarkCommentAsRead, RemoveComment, SaveComment } from './interfaces/api/comment';
+import { CommentReportResponse, CommentResponse, CreateComment, CreateCommentLike, CreateCommentReport, DeleteComment, EditComment, GetComments, GetCommentsResponse, ListCommentReports, ListCommentReportsResponse, MarkCommentAsRead, RemoveComment, ResolveCommentReport, SaveComment } from './interfaces/api/comment';
 import { AddModToCommunity, AddModToCommunityResponse, BanFromCommunity, BanFromCommunityResponse, BlockCommunity, BlockCommunityResponse, CommunityResponse, CreateCommunity, DeleteCommunity, EditCommunity, FollowCommunity, GetCommunity, GetCommunityResponse, ListCommunities, ListCommunitiesResponse, RemoveCommunity, TransferCommunity } from './interfaces/api/community';
-import { CreatePost, CreatePostLike, DeletePost, EditPost, GetPost, GetPostResponse, GetPosts, GetPostsResponse, LockPost, PostResponse, RemovePost, SavePost, StickyPost } from './interfaces/api/post';
-import { CreateSite, EditSite, GetModlog, GetModlogResponse, GetSite, GetSiteConfig, GetSiteConfigResponse, GetSiteResponse, SaveSiteConfig, Search, SearchResponse, SiteResponse, TransferSite } from './interfaces/api/site';
-import { AddAdmin, AddAdminResponse, BanPerson, BanPersonResponse, CreatePrivateMessage, DeleteAccount, DeletePrivateMessage, EditPrivateMessage, GetCaptchaResponse, GetPrivateMessages, GetReplies, GetRepliesResponse, GetPersonDetails, GetPersonDetailsResponse, GetPersonMentions, GetPersonMentionsResponse, Login, LoginResponse, MarkAllAsRead, MarkPrivateMessageAsRead, MarkPersonMentionAsRead, PasswordChange, PasswordReset, PasswordResetResponse, PrivateMessageResponse, PrivateMessagesResponse, Register, SaveUserSettings, ChangePassword, PersonMentionResponse, BlockPerson, BlockPersonResponse } from './interfaces/api/person';
+import { CreatePost, CreatePostLike, DeletePost, EditPost, GetPost, GetPostResponse, GetPosts, GetPostsResponse, GetSiteMetadata, GetSiteMetadataResponse, LockPost, CreatePostReport, PostReportResponse, PostResponse, RemovePost, SavePost, StickyPost, ResolvePostReport, ListPostReports, ListPostReportsResponse } from './interfaces/api/post';
+import { CreateSite, EditSite, GetModlog, GetModlogResponse, GetSite, GetSiteConfig, GetSiteConfigResponse, GetSiteResponse, ResolveObject, ResolveObjectResponse, SaveSiteConfig, Search, SearchResponse, SiteResponse, TransferSite } from './interfaces/api/site';
+import { AddAdmin, AddAdminResponse, BanPerson, BanPersonResponse, CreatePrivateMessage, DeleteAccount, DeletePrivateMessage, EditPrivateMessage, GetCaptchaResponse, GetPrivateMessages, GetReplies, GetRepliesResponse, GetPersonDetails, GetPersonDetailsResponse, GetPersonMentions, GetPersonMentionsResponse, Login, LoginResponse, MarkAllAsRead, MarkPrivateMessageAsRead, MarkPersonMentionAsRead, PasswordChange, PasswordReset, PasswordResetResponse, PrivateMessageResponse, PrivateMessagesResponse, Register, SaveUserSettings, ChangePassword, PersonMentionResponse, BlockPerson, BlockPersonResponse, GetReportCount, GetReportCountResponse } from './interfaces/api/person';
+/**
+ * Helps build lemmy HTTP requests.
+ */
 export declare class LemmyHttp {
     private apiUrl;
     private headers;
     /**
-     * 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` .
      */
     constructor(baseUrl: string, headers?: {
         [key: string]: string;
     });
+    /**
+     * Gets the site, and your user data.
+     */
     getSite(form: GetSite): Promise<GetSiteResponse>;
+    /**
+     * Create your site.
+     */
     createSite(form: CreateSite): Promise<SiteResponse>;
+    /**
+     * Edit your site.
+     */
     editSite(form: EditSite): Promise<SiteResponse>;
+    /**
+     * Transfer your site to another user.
+     */
     transferSite(form: TransferSite): Promise<GetSiteResponse>;
+    /**
+     * Get your site configuration.
+     */
     getSiteConfig(form: GetSiteConfig): Promise<GetSiteConfigResponse>;
+    /**
+     * Save your site config.
+     */
     saveSiteConfig(form: SaveSiteConfig): Promise<GetSiteConfigResponse>;
+    /**
+     * Get the modlog.
+     */
     getModlog(form: GetModlog): Promise<GetModlogResponse>;
+    /**
+     * Search lemmy.
+     */
     search(form: Search): Promise<SearchResponse>;
+    /**
+     * Fetch a non-local / federated object.
+     */
+    resolveObject(form: ResolveObject): Promise<ResolveObjectResponse>;
+    /**
+     * Create a new community.
+     */
     createCommunity(form: CreateCommunity): Promise<CommunityResponse>;
+    /**
+     * Get / fetch a community.
+     */
     getCommunity(form: GetCommunity): Promise<GetCommunityResponse>;
+    /**
+     * Edit a community.
+     */
     editCommunity(form: EditCommunity): Promise<CommunityResponse>;
+    /**
+     * List communities, with various filters.
+     */
     listCommunities(form: ListCommunities): Promise<ListCommunitiesResponse>;
+    /**
+     * Follow / subscribe to a community.
+     */
     followCommunity(form: FollowCommunity): Promise<CommunityResponse>;
+    /**
+     * Block a community.
+     */
     blockCommunity(form: BlockCommunity): Promise<BlockCommunityResponse>;
+    /**
+     * Delete a community.
+     */
     deleteCommunity(form: DeleteCommunity): Promise<CommunityResponse>;
+    /**
+     * A moderator remove for a community.
+     */
     removeCommunity(form: RemoveCommunity): Promise<CommunityResponse>;
+    /**
+     * Transfer your community to an existing moderator.
+     */
     transferCommunity(form: TransferCommunity): Promise<GetCommunityResponse>;
+    /**
+     * Ban a user from a community.
+     */
     banFromCommunity(form: BanFromCommunity): Promise<BanFromCommunityResponse>;
+    /**
+     * Add a moderator to your community.
+     */
     addModToCommunity(form: AddModToCommunity): Promise<AddModToCommunityResponse>;
+    /**
+     * Create a post.
+     */
     createPost(form: CreatePost): Promise<PostResponse>;
+    /**
+     * Get / fetch a post.
+     */
     getPost(form: GetPost): Promise<GetPostResponse>;
+    /**
+     * Edit a post.
+     */
     editPost(form: EditPost): Promise<PostResponse>;
+    /**
+     * Delete a post.
+     */
     deletePost(form: DeletePost): Promise<PostResponse>;
+    /**
+     * A moderator remove for a post.
+     */
     removePost(form: RemovePost): Promise<PostResponse>;
+    /**
+     * A moderator can lock a post ( IE disable new comments ).
+     */
     lockPost(form: LockPost): Promise<PostResponse>;
+    /**
+     * A moderator can sticky a post ( IE stick it to the top of a community ).
+     */
     stickyPost(form: StickyPost): Promise<PostResponse>;
+    /**
+     * Get / fetch posts, with various filters.
+     */
     getPosts(form: GetPosts): Promise<GetPostsResponse>;
+    /**
+     * Like / vote on a post.
+     */
     likePost(form: CreatePostLike): Promise<PostResponse>;
+    /**
+     * Save a post.
+     */
     savePost(form: SavePost): Promise<PostResponse>;
+    /**
+     * Report a post.
+     */
+    createPostReport(form: CreatePostReport): Promise<PostReportResponse>;
+    /**
+     * Resolve a post report. Only a mod can do this.
+     */
+    resolvePostReport(form: ResolvePostReport): Promise<PostReportResponse>;
+    /**
+     * List post reports.
+     */
+    listPostReports(form: ListPostReports): Promise<ListPostReportsResponse>;
+    /**
+     * Fetch metadata for any given site.
+     */
+    getSiteMetadata(form: GetSiteMetadata): Promise<GetSiteMetadataResponse>;
+    /**
+     * Create a comment.
+     */
     createComment(form: CreateComment): Promise<CommentResponse>;
+    /**
+     * Edit a comment.
+     */
     editComment(form: EditComment): Promise<CommentResponse>;
+    /**
+     * Delete a comment.
+     */
     deleteComment(form: DeleteComment): Promise<CommentResponse>;
+    /**
+     * A moderator remove for a comment.
+     */
     removeComment(form: RemoveComment): Promise<CommentResponse>;
+    /**
+     * Mark a comment as read.
+     */
     markCommentAsRead(form: MarkCommentAsRead): Promise<CommentResponse>;
+    /**
+     * Like / vote on a comment.
+     */
     likeComment(form: CreateCommentLike): Promise<CommentResponse>;
+    /**
+     * Save a comment.
+     */
     saveComment(form: SaveComment): Promise<CommentResponse>;
+    /**
+     * Get / fetch comments.
+     */
     getComments(form: GetComments): Promise<GetCommentsResponse>;
+    /**
+     * Report a comment.
+     */
+    createCommentReport(form: CreateCommentReport): Promise<CommentReportResponse>;
+    /**
+     * Resolve a comment report. Only a mod can do this.
+     */
+    resolveCommentReport(form: ResolveCommentReport): Promise<CommentReportResponse>;
+    /**
+     * List comment reports.
+     */
+    listCommentReports(form: ListCommentReports): Promise<ListCommentReportsResponse>;
+    /**
+     * Get / fetch private messages.
+     */
     getPrivateMessages(form: GetPrivateMessages): Promise<PrivateMessagesResponse>;
+    /**
+     * Create a private message.
+     */
     createPrivateMessage(form: CreatePrivateMessage): Promise<PrivateMessageResponse>;
+    /**
+     * Edit a private message.
+     */
     editPrivateMessage(form: EditPrivateMessage): Promise<PrivateMessageResponse>;
+    /**
+     * Delete a private message.
+     */
     deletePrivateMessage(form: DeletePrivateMessage): Promise<PrivateMessageResponse>;
+    /**
+     * Mark a private message as read.
+     */
     markPrivateMessageAsRead(form: MarkPrivateMessageAsRead): Promise<PrivateMessageResponse>;
+    /**
+     * Register a new user.
+     */
     register(form: Register): Promise<LoginResponse>;
+    /**
+     * Log into lemmy.
+     */
     login(form: Login): Promise<LoginResponse>;
+    /**
+     * Get the details for a person.
+     */
     getPersonDetails(form: GetPersonDetails): Promise<GetPersonDetailsResponse>;
+    /**
+     * Get mentions for your user.
+     */
     getPersonMentions(form: GetPersonMentions): Promise<GetPersonMentionsResponse>;
+    /**
+     * Mark a person mention as read.
+     */
     markPersonMentionAsRead(form: MarkPersonMentionAsRead): Promise<PersonMentionResponse>;
+    /**
+     * Get comment replies.
+     */
     getReplies(form: GetReplies): Promise<GetRepliesResponse>;
+    /**
+     * Ban a person from your site.
+     */
     banPerson(form: BanPerson): Promise<BanPersonResponse>;
+    /**
+     * Block a person.
+     */
     blockPerson(form: BlockPerson): Promise<BlockPersonResponse>;
+    /**
+     * Fetch a Captcha.
+     */
     getCaptcha(): Promise<GetCaptchaResponse>;
+    /**
+     * Delete your account.
+     */
     deleteAccount(form: DeleteAccount): Promise<LoginResponse>;
+    /**
+     * Reset your password.
+     */
     passwordReset(form: PasswordReset): Promise<PasswordResetResponse>;
+    /**
+     * Change your password from an email / token based reset.
+     */
     passwordChange(form: PasswordChange): Promise<LoginResponse>;
+    /**
+     * Mark all replies as read.
+     */
     markAllAsRead(form: MarkAllAsRead): Promise<GetRepliesResponse>;
+    /**
+     * Save your user settings.
+     */
     saveUserSettings(form: SaveUserSettings): Promise<LoginResponse>;
+    /**
+     * Change your user password.
+     */
     changePassword(form: ChangePassword): Promise<LoginResponse>;
+    /**
+     * Get counts for your reports
+     */
+    getReportCount(form: GetReportCount): Promise<GetReportCountResponse>;
+    /**
+     * Add an admin to your site.
+     */
     addAdmin(form: AddAdmin): Promise<AddAdminResponse>;
     private buildFullUrl;
     private wrapper;