lemmy-js-client 0.17.2-rc.2 → 0.17.2-rc.21

package/README.md

@@ -43,7 +43,7 @@ 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;
+let jwt = await client.login(loginForm).jwt;
 ```
 
 ## Development

package/dist/http.d.ts

@@ -1,14 +1,141 @@
-import { CommentReportResponse, CommentResponse, CreateComment, CreateCommentLike, CreateCommentReport, DeleteComment, EditComment, GetComments, GetCommentsResponse, ListCommentReports, ListCommentReportsResponse, 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 { AddAdmin, AddAdminResponse, BannedPersonsResponse, BanPerson, BanPersonResponse, BlockPerson, BlockPersonResponse, ChangePassword, CreatePrivateMessage, CreatePrivateMessageReport, DeleteAccount, DeleteAccountResponse, DeletePrivateMessage, EditPrivateMessage, GetBannedPersons, GetCaptchaResponse, GetPersonDetails, GetPersonDetailsResponse, GetPersonMentions, GetPersonMentionsResponse, GetPrivateMessages, GetReplies, GetRepliesResponse, GetReportCount, GetReportCountResponse, GetUnreadCount, GetUnreadCountResponse, ListPrivateMessageReports, ListPrivateMessageReportsResponse, Login, LoginResponse, MarkAllAsRead, MarkCommentReplyAsRead, MarkPersonMentionAsRead, MarkPrivateMessageAsRead, PasswordChange, PasswordReset, PasswordResetResponse, PersonMentionResponse, PrivateMessageReportResponse, PrivateMessageResponse, PrivateMessagesResponse, Register, ResolvePrivateMessageReport, SaveUserSettings, VerifyEmail, VerifyEmailResponse } from "./interfaces/api/person";
-import { CreatePost, CreatePostLike, CreatePostReport, DeletePost, EditPost, FeaturePost, GetPost, GetPostResponse, GetPosts, GetPostsResponse, GetSiteMetadata, GetSiteMetadataResponse, ListPostReports, ListPostReportsResponse, LockPost, MarkPostAsRead, PostReportResponse, PostResponse, RemovePost, ResolvePostReport, SavePost } from "./interfaces/api/post";
-import { ApproveRegistrationApplication, CreateSite, EditSite, GetModlog, GetModlogResponse, GetSite, GetSiteResponse, GetUnreadRegistrationApplicationCount, GetUnreadRegistrationApplicationCountResponse, LeaveAdmin, ListRegistrationApplications, ListRegistrationApplicationsResponse, PurgeComment, PurgeCommunity, PurgeItemResponse, PurgePerson, PurgePost, RegistrationApplicationResponse, ResolveObject, ResolveObjectResponse, Search, SearchResponse, SiteResponse } from "./interfaces/api/site";
+import { AddAdmin } from "./types/AddAdmin";
+import { AddAdminResponse } from "./types/AddAdminResponse";
+import { AddModToCommunity } from "./types/AddModToCommunity";
+import { AddModToCommunityResponse } from "./types/AddModToCommunityResponse";
+import { ApproveRegistrationApplication } from "./types/ApproveRegistrationApplication";
+import { BanFromCommunity } from "./types/BanFromCommunity";
+import { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
+import { BanPerson } from "./types/BanPerson";
+import { BanPersonResponse } from "./types/BanPersonResponse";
+import { BannedPersonsResponse } from "./types/BannedPersonsResponse";
+import { BlockCommunity } from "./types/BlockCommunity";
+import { BlockCommunityResponse } from "./types/BlockCommunityResponse";
+import { BlockPerson } from "./types/BlockPerson";
+import { BlockPersonResponse } from "./types/BlockPersonResponse";
+import { ChangePassword } from "./types/ChangePassword";
+import { CommentReplyResponse } from "./types/CommentReplyResponse";
+import { CommentReportResponse } from "./types/CommentReportResponse";
+import { CommentResponse } from "./types/CommentResponse";
+import { CommunityResponse } from "./types/CommunityResponse";
+import { CreateComment } from "./types/CreateComment";
+import { CreateCommentLike } from "./types/CreateCommentLike";
+import { CreateCommentReport } from "./types/CreateCommentReport";
+import { CreateCommunity } from "./types/CreateCommunity";
+import { CreateCustomEmoji } from "./types/CreateCustomEmoji";
+import { CreatePost } from "./types/CreatePost";
+import { CreatePostLike } from "./types/CreatePostLike";
+import { CreatePostReport } from "./types/CreatePostReport";
+import { CreatePrivateMessage } from "./types/CreatePrivateMessage";
+import { CreatePrivateMessageReport } from "./types/CreatePrivateMessageReport";
+import { CreateSite } from "./types/CreateSite";
+import { CustomEmojiResponse } from "./types/CustomEmojiResponse";
+import { DeleteAccount } from "./types/DeleteAccount";
+import { DeleteComment } from "./types/DeleteComment";
+import { DeleteCommunity } from "./types/DeleteCommunity";
+import { DeleteCustomEmoji } from "./types/DeleteCustomEmoji";
+import { DeleteCustomEmojiResponse } from "./types/DeleteCustomEmojiResponse";
+import { DeletePost } from "./types/DeletePost";
+import { DeletePrivateMessage } from "./types/DeletePrivateMessage";
+import { DistinguishComment } from "./types/DistinguishComment";
+import { EditComment } from "./types/EditComment";
+import { EditCommunity } from "./types/EditCommunity";
+import { EditCustomEmoji } from "./types/EditCustomEmoji";
+import { EditPost } from "./types/EditPost";
+import { EditPrivateMessage } from "./types/EditPrivateMessage";
+import { EditSite } from "./types/EditSite";
+import { FeaturePost } from "./types/FeaturePost";
+import { FollowCommunity } from "./types/FollowCommunity";
+import { GetBannedPersons } from "./types/GetBannedPersons";
+import { GetCaptcha } from "./types/GetCaptcha";
+import { GetCaptchaResponse } from "./types/GetCaptchaResponse";
+import { GetComment } from "./types/GetComment";
+import { GetComments } from "./types/GetComments";
+import { GetCommentsResponse } from "./types/GetCommentsResponse";
+import { GetCommunity } from "./types/GetCommunity";
+import { GetCommunityResponse } from "./types/GetCommunityResponse";
+import { GetFederatedInstances } from "./types/GetFederatedInstances";
+import { GetFederatedInstancesResponse } from "./types/GetFederatedInstancesResponse";
+import { GetModlog } from "./types/GetModlog";
+import { GetModlogResponse } from "./types/GetModlogResponse";
+import { GetPersonDetails } from "./types/GetPersonDetails";
+import { GetPersonDetailsResponse } from "./types/GetPersonDetailsResponse";
+import { GetPersonMentions } from "./types/GetPersonMentions";
+import { GetPersonMentionsResponse } from "./types/GetPersonMentionsResponse";
+import { GetPost } from "./types/GetPost";
+import { GetPostResponse } from "./types/GetPostResponse";
+import { GetPosts } from "./types/GetPosts";
+import { GetPostsResponse } from "./types/GetPostsResponse";
+import { GetPrivateMessages } from "./types/GetPrivateMessages";
+import { GetReplies } from "./types/GetReplies";
+import { GetRepliesResponse } from "./types/GetRepliesResponse";
+import { GetReportCount } from "./types/GetReportCount";
+import { GetReportCountResponse } from "./types/GetReportCountResponse";
+import { GetSite } from "./types/GetSite";
+import { GetSiteMetadata } from "./types/GetSiteMetadata";
+import { GetSiteMetadataResponse } from "./types/GetSiteMetadataResponse";
+import { GetSiteResponse } from "./types/GetSiteResponse";
+import { GetUnreadCount } from "./types/GetUnreadCount";
+import { GetUnreadCountResponse } from "./types/GetUnreadCountResponse";
+import { GetUnreadRegistrationApplicationCount } from "./types/GetUnreadRegistrationApplicationCount";
+import { GetUnreadRegistrationApplicationCountResponse } from "./types/GetUnreadRegistrationApplicationCountResponse";
+import { LeaveAdmin } from "./types/LeaveAdmin";
+import { ListCommentReports } from "./types/ListCommentReports";
+import { ListCommentReportsResponse } from "./types/ListCommentReportsResponse";
+import { ListCommunities } from "./types/ListCommunities";
+import { ListCommunitiesResponse } from "./types/ListCommunitiesResponse";
+import { ListPostReports } from "./types/ListPostReports";
+import { ListPostReportsResponse } from "./types/ListPostReportsResponse";
+import { ListPrivateMessageReports } from "./types/ListPrivateMessageReports";
+import { ListPrivateMessageReportsResponse } from "./types/ListPrivateMessageReportsResponse";
+import { ListRegistrationApplications } from "./types/ListRegistrationApplications";
+import { ListRegistrationApplicationsResponse } from "./types/ListRegistrationApplicationsResponse";
+import { LockPost } from "./types/LockPost";
+import { Login } from "./types/Login";
+import { LoginResponse } from "./types/LoginResponse";
+import { MarkAllAsRead } from "./types/MarkAllAsRead";
+import { MarkCommentReplyAsRead } from "./types/MarkCommentReplyAsRead";
+import { MarkPersonMentionAsRead } from "./types/MarkPersonMentionAsRead";
+import { MarkPostAsRead } from "./types/MarkPostAsRead";
+import { MarkPrivateMessageAsRead } from "./types/MarkPrivateMessageAsRead";
+import { PasswordChangeAfterReset } from "./types/PasswordChangeAfterReset";
+import { PasswordReset } from "./types/PasswordReset";
+import { PersonMentionResponse } from "./types/PersonMentionResponse";
+import { PostReportResponse } from "./types/PostReportResponse";
+import { PostResponse } from "./types/PostResponse";
+import { PrivateMessageReportResponse } from "./types/PrivateMessageReportResponse";
+import { PrivateMessageResponse } from "./types/PrivateMessageResponse";
+import { PrivateMessagesResponse } from "./types/PrivateMessagesResponse";
+import { PurgeComment } from "./types/PurgeComment";
+import { PurgeCommunity } from "./types/PurgeCommunity";
+import { PurgeItemResponse } from "./types/PurgeItemResponse";
+import { PurgePerson } from "./types/PurgePerson";
+import { PurgePost } from "./types/PurgePost";
+import { Register } from "./types/Register";
+import { RegistrationApplicationResponse } from "./types/RegistrationApplicationResponse";
+import { RemoveComment } from "./types/RemoveComment";
+import { RemoveCommunity } from "./types/RemoveCommunity";
+import { RemovePost } from "./types/RemovePost";
+import { ResolveCommentReport } from "./types/ResolveCommentReport";
+import { ResolveObject } from "./types/ResolveObject";
+import { ResolveObjectResponse } from "./types/ResolveObjectResponse";
+import { ResolvePostReport } from "./types/ResolvePostReport";
+import { ResolvePrivateMessageReport } from "./types/ResolvePrivateMessageReport";
+import { SaveComment } from "./types/SaveComment";
+import { SavePost } from "./types/SavePost";
+import { SaveUserSettings } from "./types/SaveUserSettings";
+import { Search } from "./types/Search";
+import { SearchResponse } from "./types/SearchResponse";
+import { SiteResponse } from "./types/SiteResponse";
+import { TransferCommunity } from "./types/TransferCommunity";
+import { VerifyEmail } from "./types/VerifyEmail";
+import { UploadImage, UploadImageResponse } from "./types/others";
 /**
  * Helps build lemmy HTTP requests.
  */
 export declare class LemmyHttp {
     private apiUrl;
     private headers;
+    private pictrsUrl;
     /**
      * 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
@@ -244,7 +371,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /comment/mark_as_read`
      */
-    markCommentReplyAsRead(form: MarkCommentReplyAsRead): Promise<CommentResponse>;
+    markCommentReplyAsRead(form: MarkCommentReplyAsRead): Promise<CommentReplyResponse>;
     /**
      * Like / vote on a comment.
      *
@@ -257,12 +384,24 @@ export declare class LemmyHttp {
      * `HTTP.PUT /comment/save`
      */
     saveComment(form: SaveComment): Promise<CommentResponse>;
+    /**
+     * Distinguishes a comment (speak as moderator)
+     *
+     * `HTTP.POST /comment/distinguish`
+     */
+    distinguishComment(form: DistinguishComment): Promise<CommentResponse>;
     /**
      * Get / fetch comments.
      *
      * `HTTP.GET /comment/list`
      */
     getComments(form: GetComments): Promise<GetCommentsResponse>;
+    /**
+     * Get / fetch comment.
+     *
+     * `HTTP.GET /comment`
+     */
+    getComment(form: GetComment): Promise<CommentResponse>;
     /**
      * Report a comment.
      *
@@ -388,25 +527,25 @@ export declare class LemmyHttp {
      *
      * `HTTP.GET /user/get_captcha`
      */
-    getCaptcha(): Promise<GetCaptchaResponse>;
+    getCaptcha(form: GetCaptcha): Promise<GetCaptchaResponse>;
     /**
      * Delete your account.
      *
      * `HTTP.POST /user/delete_account`
      */
-    deleteAccount(form: DeleteAccount): Promise<DeleteAccountResponse>;
+    deleteAccount(form: DeleteAccount): Promise<null>;
     /**
      * Reset your password.
      *
      * `HTTP.POST /user/password_reset`
      */
-    passwordReset(form: PasswordReset): Promise<PasswordResetResponse>;
+    passwordReset(form: PasswordReset): Promise<null>;
     /**
      * Change your password from an email / token based reset.
      *
      * `HTTP.POST /user/password_change`
      */
-    passwordChange(form: PasswordChange): Promise<LoginResponse>;
+    passwordChangeAfterReset(form: PasswordChangeAfterReset): Promise<LoginResponse>;
     /**
      * Mark all replies as read.
      *
@@ -442,7 +581,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /user/verify_email`
      */
-    verifyEmail(form: VerifyEmail): Promise<VerifyEmailResponse>;
+    verifyEmail(form: VerifyEmail): Promise<null>;
     /**
      * Add an admin to your site.
      *
@@ -491,6 +630,34 @@ export declare class LemmyHttp {
      * `HTTP.POST /admin/purge/comment`
      */
     purgeComment(form: PurgeComment): Promise<PurgeItemResponse>;
+    /**
+     * Create a new custom emoji
+     *
+     * `HTTP.POST /custom_emoji`
+     */
+    createCustomEmoji(form: CreateCustomEmoji): Promise<CustomEmojiResponse>;
+    /**
+     * Edit an existing custom emoji
+     *
+     * `HTTP.PUT /custom_emoji`
+     */
+    editCustomEmoji(form: EditCustomEmoji): Promise<CustomEmojiResponse>;
+    /**
+     * Delete a custom emoji
+     *
+     * `HTTP.Post /custom_emoji/delete`
+     */
+    deleteCustomEmoji(form: DeleteCustomEmoji): Promise<DeleteCustomEmojiResponse>;
+    /**
+     * Fetch federated instances.
+     *
+     * `HTTP.Get /federated_instances`
+     */
+    getFederatedInstances(form: GetFederatedInstances): Promise<GetFederatedInstancesResponse>;
+    /**
+     * Upload an image to the server.
+     */
+    uploadImage({ image, auth, }: UploadImage): Promise<UploadImageResponse>;
     private buildFullUrl;
     private wrapper;
 }