lemmy-js-client 0.17.2 → 0.18.0-rc.1

package/dist/types/others.d.ts

@@ -0,0 +1,114 @@
+/// <reference types="node" />
+export declare const VERSION = "v3";
+/**
+ * All of the websocket operations available.
+ */
+export declare enum UserOperation {
+    Login = 0,
+    Register = 1,
+    GetCaptcha = 2,
+    CreateCommunity = 3,
+    CreatePost = 4,
+    ListCommunities = 5,
+    GetPost = 6,
+    GetCommunity = 7,
+    CreateComment = 8,
+    EditComment = 9,
+    DeleteComment = 10,
+    RemoveComment = 11,
+    SaveComment = 12,
+    CreateCommentLike = 13,
+    GetPosts = 14,
+    CreatePostLike = 15,
+    EditPost = 16,
+    DeletePost = 17,
+    RemovePost = 18,
+    LockPost = 19,
+    FeaturePost = 20,
+    MarkPostAsRead = 21,
+    SavePost = 22,
+    EditCommunity = 23,
+    DeleteCommunity = 24,
+    RemoveCommunity = 25,
+    FollowCommunity = 26,
+    GetPersonDetails = 27,
+    GetReplies = 28,
+    GetPersonMentions = 29,
+    MarkPersonMentionAsRead = 30,
+    MarkCommentReplyAsRead = 31,
+    GetModlog = 32,
+    BanFromCommunity = 33,
+    AddModToCommunity = 34,
+    CreateSite = 35,
+    EditSite = 36,
+    GetSite = 37,
+    AddAdmin = 38,
+    GetUnreadRegistrationApplicationCount = 39,
+    ListRegistrationApplications = 40,
+    ApproveRegistrationApplication = 41,
+    BanPerson = 42,
+    GetBannedPersons = 43,
+    Search = 44,
+    ResolveObject = 45,
+    MarkAllAsRead = 46,
+    SaveUserSettings = 47,
+    TransferCommunity = 48,
+    LeaveAdmin = 49,
+    DeleteAccount = 50,
+    PasswordReset = 51,
+    PasswordChangeAfterReset = 52,
+    CreatePrivateMessage = 53,
+    EditPrivateMessage = 54,
+    DeletePrivateMessage = 55,
+    MarkPrivateMessageAsRead = 56,
+    CreatePrivateMessageReport = 57,
+    ResolvePrivateMessageReport = 58,
+    ListPrivateMessageReports = 59,
+    GetPrivateMessages = 60,
+    UserJoin = 61,
+    GetComments = 62,
+    GetComment = 63,
+    PostJoin = 64,
+    CommunityJoin = 65,
+    ChangePassword = 66,
+    GetSiteMetadata = 67,
+    BlockCommunity = 68,
+    BlockPerson = 69,
+    PurgePerson = 70,
+    PurgeCommunity = 71,
+    PurgePost = 72,
+    PurgeComment = 73,
+    CreateCommentReport = 74,
+    ResolveCommentReport = 75,
+    ListCommentReports = 76,
+    CreatePostReport = 77,
+    ResolvePostReport = 78,
+    ListPostReports = 79,
+    GetReportCount = 80,
+    GetUnreadCount = 81,
+    VerifyEmail = 82,
+    CreateCustomEmoji = 83,
+    EditCustomEmoji = 84,
+    DeleteCustomEmoji = 85,
+    GetFederatedInstances = 86
+}
+export interface UploadImage {
+    image: File | Buffer;
+    /**
+     * Optional if cookie with jwt set is already present. Otherwise, auth is required.
+     */
+    auth?: string;
+}
+export interface UploadImageResponse {
+    /**
+     * Is "ok" if the upload was successful; is something else otherwise.
+     */
+    msg: string;
+    files?: ImageFile[];
+    url?: string;
+    delete_url?: string;
+}
+export interface ImageFile {
+    file: string;
+    delete_token: string;
+}

package/dist/types/others.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserOperation = exports.VERSION = void 0;
+exports.VERSION = "v3";
+/**
+ * All of the websocket operations available.
+ */
+var UserOperation;
+(function (UserOperation) {
+    UserOperation[UserOperation["Login"] = 0] = "Login";
+    UserOperation[UserOperation["Register"] = 1] = "Register";
+    UserOperation[UserOperation["GetCaptcha"] = 2] = "GetCaptcha";
+    UserOperation[UserOperation["CreateCommunity"] = 3] = "CreateCommunity";
+    UserOperation[UserOperation["CreatePost"] = 4] = "CreatePost";
+    UserOperation[UserOperation["ListCommunities"] = 5] = "ListCommunities";
+    UserOperation[UserOperation["GetPost"] = 6] = "GetPost";
+    UserOperation[UserOperation["GetCommunity"] = 7] = "GetCommunity";
+    UserOperation[UserOperation["CreateComment"] = 8] = "CreateComment";
+    UserOperation[UserOperation["EditComment"] = 9] = "EditComment";
+    UserOperation[UserOperation["DeleteComment"] = 10] = "DeleteComment";
+    UserOperation[UserOperation["RemoveComment"] = 11] = "RemoveComment";
+    UserOperation[UserOperation["SaveComment"] = 12] = "SaveComment";
+    UserOperation[UserOperation["CreateCommentLike"] = 13] = "CreateCommentLike";
+    UserOperation[UserOperation["GetPosts"] = 14] = "GetPosts";
+    UserOperation[UserOperation["CreatePostLike"] = 15] = "CreatePostLike";
+    UserOperation[UserOperation["EditPost"] = 16] = "EditPost";
+    UserOperation[UserOperation["DeletePost"] = 17] = "DeletePost";
+    UserOperation[UserOperation["RemovePost"] = 18] = "RemovePost";
+    UserOperation[UserOperation["LockPost"] = 19] = "LockPost";
+    UserOperation[UserOperation["FeaturePost"] = 20] = "FeaturePost";
+    UserOperation[UserOperation["MarkPostAsRead"] = 21] = "MarkPostAsRead";
+    UserOperation[UserOperation["SavePost"] = 22] = "SavePost";
+    UserOperation[UserOperation["EditCommunity"] = 23] = "EditCommunity";
+    UserOperation[UserOperation["DeleteCommunity"] = 24] = "DeleteCommunity";
+    UserOperation[UserOperation["RemoveCommunity"] = 25] = "RemoveCommunity";
+    UserOperation[UserOperation["FollowCommunity"] = 26] = "FollowCommunity";
+    UserOperation[UserOperation["GetPersonDetails"] = 27] = "GetPersonDetails";
+    UserOperation[UserOperation["GetReplies"] = 28] = "GetReplies";
+    UserOperation[UserOperation["GetPersonMentions"] = 29] = "GetPersonMentions";
+    UserOperation[UserOperation["MarkPersonMentionAsRead"] = 30] = "MarkPersonMentionAsRead";
+    UserOperation[UserOperation["MarkCommentReplyAsRead"] = 31] = "MarkCommentReplyAsRead";
+    UserOperation[UserOperation["GetModlog"] = 32] = "GetModlog";
+    UserOperation[UserOperation["BanFromCommunity"] = 33] = "BanFromCommunity";
+    UserOperation[UserOperation["AddModToCommunity"] = 34] = "AddModToCommunity";
+    UserOperation[UserOperation["CreateSite"] = 35] = "CreateSite";
+    UserOperation[UserOperation["EditSite"] = 36] = "EditSite";
+    UserOperation[UserOperation["GetSite"] = 37] = "GetSite";
+    UserOperation[UserOperation["AddAdmin"] = 38] = "AddAdmin";
+    UserOperation[UserOperation["GetUnreadRegistrationApplicationCount"] = 39] = "GetUnreadRegistrationApplicationCount";
+    UserOperation[UserOperation["ListRegistrationApplications"] = 40] = "ListRegistrationApplications";
+    UserOperation[UserOperation["ApproveRegistrationApplication"] = 41] = "ApproveRegistrationApplication";
+    UserOperation[UserOperation["BanPerson"] = 42] = "BanPerson";
+    UserOperation[UserOperation["GetBannedPersons"] = 43] = "GetBannedPersons";
+    UserOperation[UserOperation["Search"] = 44] = "Search";
+    UserOperation[UserOperation["ResolveObject"] = 45] = "ResolveObject";
+    UserOperation[UserOperation["MarkAllAsRead"] = 46] = "MarkAllAsRead";
+    UserOperation[UserOperation["SaveUserSettings"] = 47] = "SaveUserSettings";
+    UserOperation[UserOperation["TransferCommunity"] = 48] = "TransferCommunity";
+    UserOperation[UserOperation["LeaveAdmin"] = 49] = "LeaveAdmin";
+    UserOperation[UserOperation["DeleteAccount"] = 50] = "DeleteAccount";
+    UserOperation[UserOperation["PasswordReset"] = 51] = "PasswordReset";
+    UserOperation[UserOperation["PasswordChangeAfterReset"] = 52] = "PasswordChangeAfterReset";
+    UserOperation[UserOperation["CreatePrivateMessage"] = 53] = "CreatePrivateMessage";
+    UserOperation[UserOperation["EditPrivateMessage"] = 54] = "EditPrivateMessage";
+    UserOperation[UserOperation["DeletePrivateMessage"] = 55] = "DeletePrivateMessage";
+    UserOperation[UserOperation["MarkPrivateMessageAsRead"] = 56] = "MarkPrivateMessageAsRead";
+    UserOperation[UserOperation["CreatePrivateMessageReport"] = 57] = "CreatePrivateMessageReport";
+    UserOperation[UserOperation["ResolvePrivateMessageReport"] = 58] = "ResolvePrivateMessageReport";
+    UserOperation[UserOperation["ListPrivateMessageReports"] = 59] = "ListPrivateMessageReports";
+    UserOperation[UserOperation["GetPrivateMessages"] = 60] = "GetPrivateMessages";
+    UserOperation[UserOperation["UserJoin"] = 61] = "UserJoin";
+    UserOperation[UserOperation["GetComments"] = 62] = "GetComments";
+    UserOperation[UserOperation["GetComment"] = 63] = "GetComment";
+    UserOperation[UserOperation["PostJoin"] = 64] = "PostJoin";
+    UserOperation[UserOperation["CommunityJoin"] = 65] = "CommunityJoin";
+    UserOperation[UserOperation["ChangePassword"] = 66] = "ChangePassword";
+    UserOperation[UserOperation["GetSiteMetadata"] = 67] = "GetSiteMetadata";
+    UserOperation[UserOperation["BlockCommunity"] = 68] = "BlockCommunity";
+    UserOperation[UserOperation["BlockPerson"] = 69] = "BlockPerson";
+    UserOperation[UserOperation["PurgePerson"] = 70] = "PurgePerson";
+    UserOperation[UserOperation["PurgeCommunity"] = 71] = "PurgeCommunity";
+    UserOperation[UserOperation["PurgePost"] = 72] = "PurgePost";
+    UserOperation[UserOperation["PurgeComment"] = 73] = "PurgeComment";
+    UserOperation[UserOperation["CreateCommentReport"] = 74] = "CreateCommentReport";
+    UserOperation[UserOperation["ResolveCommentReport"] = 75] = "ResolveCommentReport";
+    UserOperation[UserOperation["ListCommentReports"] = 76] = "ListCommentReports";
+    UserOperation[UserOperation["CreatePostReport"] = 77] = "CreatePostReport";
+    UserOperation[UserOperation["ResolvePostReport"] = 78] = "ResolvePostReport";
+    UserOperation[UserOperation["ListPostReports"] = 79] = "ListPostReports";
+    UserOperation[UserOperation["GetReportCount"] = 80] = "GetReportCount";
+    UserOperation[UserOperation["GetUnreadCount"] = 81] = "GetUnreadCount";
+    UserOperation[UserOperation["VerifyEmail"] = 82] = "VerifyEmail";
+    UserOperation[UserOperation["CreateCustomEmoji"] = 83] = "CreateCustomEmoji";
+    UserOperation[UserOperation["EditCustomEmoji"] = 84] = "EditCustomEmoji";
+    UserOperation[UserOperation["DeleteCustomEmoji"] = 85] = "DeleteCustomEmoji";
+    UserOperation[UserOperation["GetFederatedInstances"] = 86] = "GetFederatedInstances";
+})(UserOperation = exports.UserOperation || (exports.UserOperation = {}));

package/dist/websocket.d.ts

@@ -1,10 +1,91 @@
-import { CreateComment, CreateCommentLike, CreateCommentReport, DeleteComment, EditComment, GetComments, ListCommentReports, RemoveComment, ResolveCommentReport, SaveComment } from "./interfaces/api/comment";
-import { AddModToCommunity, BanFromCommunity, BlockCommunity, CreateCommunity, DeleteCommunity, EditCommunity, FollowCommunity, GetCommunity, ListCommunities, RemoveCommunity, TransferCommunity } from "./interfaces/api/community";
-import { AddAdmin, BanPerson, BlockPerson, ChangePassword, CreatePrivateMessage, CreatePrivateMessageReport, DeleteAccount, DeletePrivateMessage, EditPrivateMessage, GetBannedPersons, GetPersonDetails, GetPersonMentions, GetPrivateMessages, GetReplies, GetReportCount, GetUnreadCount, ListPrivateMessageReports, Login, MarkAllAsRead, MarkCommentReplyAsRead, MarkPersonMentionAsRead, MarkPrivateMessageAsRead, PasswordChange, PasswordReset, Register, ResolvePrivateMessageReport, SaveUserSettings, VerifyEmail } from "./interfaces/api/person";
-import { CreatePost, CreatePostLike, CreatePostReport, DeletePost, EditPost, FeaturePost, GetPost, GetPosts, GetSiteMetadata, ListPostReports, LockPost, MarkPostAsRead, RemovePost, ResolvePostReport, SavePost } from "./interfaces/api/post";
-import { ApproveRegistrationApplication, CreateSite, EditSite, GetModlog, GetSite, GetUnreadRegistrationApplicationCount, LeaveAdmin, ListRegistrationApplications, PurgeComment, PurgeCommunity, PurgePerson, PurgePost, ResolveObject, Search } from "./interfaces/api/site";
-import { CommunityJoin, PostJoin, UserJoin } from "./interfaces/api/websocket";
-import { UserOperation } from "./interfaces/others";
+import { AddAdmin } from "./types/AddAdmin";
+import { AddModToCommunity } from "./types/AddModToCommunity";
+import { ApproveRegistrationApplication } from "./types/ApproveRegistrationApplication";
+import { BanFromCommunity } from "./types/BanFromCommunity";
+import { BanPerson } from "./types/BanPerson";
+import { BlockCommunity } from "./types/BlockCommunity";
+import { BlockPerson } from "./types/BlockPerson";
+import { ChangePassword } from "./types/ChangePassword";
+import { CommunityJoin } from "./types/CommunityJoin";
+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 { DeleteAccount } from "./types/DeleteAccount";
+import { DeleteComment } from "./types/DeleteComment";
+import { DeleteCommunity } from "./types/DeleteCommunity";
+import { DeleteCustomEmoji } from "./types/DeleteCustomEmoji";
+import { DeletePost } from "./types/DeletePost";
+import { DeletePrivateMessage } from "./types/DeletePrivateMessage";
+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 { GetComment } from "./types/GetComment";
+import { GetComments } from "./types/GetComments";
+import { GetCommunity } from "./types/GetCommunity";
+import { GetFederatedInstances } from "./types/GetFederatedInstances";
+import { GetModlog } from "./types/GetModlog";
+import { GetPersonDetails } from "./types/GetPersonDetails";
+import { GetPersonMentions } from "./types/GetPersonMentions";
+import { GetPost } from "./types/GetPost";
+import { GetPosts } from "./types/GetPosts";
+import { GetPrivateMessages } from "./types/GetPrivateMessages";
+import { GetReplies } from "./types/GetReplies";
+import { GetReportCount } from "./types/GetReportCount";
+import { GetSite } from "./types/GetSite";
+import { GetSiteMetadata } from "./types/GetSiteMetadata";
+import { GetUnreadCount } from "./types/GetUnreadCount";
+import { GetUnreadRegistrationApplicationCount } from "./types/GetUnreadRegistrationApplicationCount";
+import { LeaveAdmin } from "./types/LeaveAdmin";
+import { ListCommentReports } from "./types/ListCommentReports";
+import { ListCommunities } from "./types/ListCommunities";
+import { ListPostReports } from "./types/ListPostReports";
+import { ListPrivateMessageReports } from "./types/ListPrivateMessageReports";
+import { ListRegistrationApplications } from "./types/ListRegistrationApplications";
+import { LockPost } from "./types/LockPost";
+import { Login } from "./types/Login";
+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 { UserOperation } from "./types/others";
+import { PasswordChangeAfterReset } from "./types/PasswordChangeAfterReset";
+import { PasswordReset } from "./types/PasswordReset";
+import { PostJoin } from "./types/PostJoin";
+import { PurgeComment } from "./types/PurgeComment";
+import { PurgeCommunity } from "./types/PurgeCommunity";
+import { PurgePerson } from "./types/PurgePerson";
+import { PurgePost } from "./types/PurgePost";
+import { Register } from "./types/Register";
+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 { 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 { TransferCommunity } from "./types/TransferCommunity";
+import { UserJoin } from "./types/UserJoin";
+import { VerifyEmail } from "./types/VerifyEmail";
 /**
  * Helps build lemmy websocket message requests, that you can use in your Websocket sends.
  *
@@ -45,7 +126,7 @@ export declare class LemmyWebsocket {
     /**
      * Fetch a Captcha.
      */
-    getCaptcha(): string;
+    getCaptcha(form: GetCaptcha): string;
     /**
      * Create a new community.
      */
@@ -130,6 +211,10 @@ export declare class LemmyWebsocket {
      * Get / fetch comments.
      */
     getComments(form: GetComments): string;
+    /**
+     * Get / fetch comment.
+     */
+    getComment(form: GetComment): string;
     /**
      * Like / vote on a post.
      */
@@ -293,7 +378,7 @@ export declare class LemmyWebsocket {
     /**
      * Change your password from an email / token based reset.
      */
-    passwordChange(form: PasswordChange): string;
+    passwordChange(form: PasswordChangeAfterReset): string;
     /**
      * Create a private message.
      */
@@ -350,6 +435,22 @@ export declare class LemmyWebsocket {
      * Purge / Delete a comment from the database.
      */
     purgeComment(form: PurgeComment): string;
+    /**
+     * Create a custom emoji
+     */
+    createCustomEmoji(form: CreateCustomEmoji): string;
+    /**
+     * Edit a custom emoji
+     */
+    editCustomEmoji(form: EditCustomEmoji): string;
+    /**
+     * Delete a custom emoji
+     */
+    deleteCustomEmoji(form: DeleteCustomEmoji): string;
+    /**
+     * Fetch federated instances.
+     */
+    getFederatedInstances(form: GetFederatedInstances): string;
 }
 export declare function wsUserOp(msg: any): UserOperation;
 /**