lemmy-js-client 0.17.0-rc.9 → 0.17.2-rc.2

package/dist/interfaces/others.d.ts

@@ -15,16 +15,16 @@ export declare enum UserOperation {
     EditComment = 9,
     DeleteComment = 10,
     RemoveComment = 11,
-    MarkCommentAsRead = 12,
-    SaveComment = 13,
-    CreateCommentLike = 14,
-    GetPosts = 15,
-    CreatePostLike = 16,
-    EditPost = 17,
-    DeletePost = 18,
-    RemovePost = 19,
-    LockPost = 20,
-    StickyPost = 21,
+    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,
@@ -34,65 +34,78 @@ export declare enum UserOperation {
     GetReplies = 28,
     GetPersonMentions = 29,
     MarkPersonMentionAsRead = 30,
-    GetModlog = 31,
-    BanFromCommunity = 32,
-    AddModToCommunity = 33,
-    CreateSite = 34,
-    EditSite = 35,
-    GetSite = 36,
-    AddAdmin = 37,
-    GetUnreadRegistrationApplicationCount = 38,
-    ListRegistrationApplications = 39,
-    ApproveRegistrationApplication = 40,
-    BanPerson = 41,
-    GetBannedPersons = 42,
-    Search = 43,
-    ResolveObject = 44,
-    MarkAllAsRead = 45,
-    SaveUserSettings = 46,
-    TransferCommunity = 47,
-    LeaveAdmin = 48,
-    DeleteAccount = 49,
-    PasswordReset = 50,
-    PasswordChange = 51,
-    CreatePrivateMessage = 52,
-    EditPrivateMessage = 53,
-    DeletePrivateMessage = 54,
-    MarkPrivateMessageAsRead = 55,
-    GetPrivateMessages = 56,
-    UserJoin = 57,
-    GetComments = 58,
-    GetSiteConfig = 59,
-    SaveSiteConfig = 60,
-    PostJoin = 61,
-    CommunityJoin = 62,
-    ChangePassword = 63,
-    GetSiteMetadata = 64,
-    BlockCommunity = 65,
-    BlockPerson = 66,
-    CreateCommentReport = 67,
-    ResolveCommentReport = 68,
-    ListCommentReports = 69,
-    CreatePostReport = 70,
-    ResolvePostReport = 71,
-    ListPostReports = 72,
-    GetReportCount = 73,
-    GetUnreadCount = 74,
-    VerifyEmail = 75
+    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,
+    PasswordChange = 52,
+    CreatePrivateMessage = 53,
+    EditPrivateMessage = 54,
+    DeletePrivateMessage = 55,
+    MarkPrivateMessageAsRead = 56,
+    CreatePrivateMessageReport = 57,
+    ResolvePrivateMessageReport = 58,
+    ListPrivateMessageReports = 59,
+    GetPrivateMessages = 60,
+    UserJoin = 61,
+    GetComments = 62,
+    PostJoin = 63,
+    CommunityJoin = 64,
+    ChangePassword = 65,
+    GetSiteMetadata = 66,
+    BlockCommunity = 67,
+    BlockPerson = 68,
+    PurgePerson = 69,
+    PurgeCommunity = 70,
+    PurgePost = 71,
+    PurgeComment = 72,
+    CreateCommentReport = 73,
+    ResolveCommentReport = 74,
+    ListCommentReports = 75,
+    CreatePostReport = 76,
+    ResolvePostReport = 77,
+    ListPostReports = 78,
+    GetReportCount = 79,
+    GetUnreadCount = 80,
+    VerifyEmail = 81
 }
 /**
- * Different sort types used in lemmy.
+ * Different post sort types used in lemmy.
  */
 export declare enum SortType {
     /**
-     * Posts sorted by the most recent comment.
+     * Posts sorted by hot, but bumped by new comments up to 2 days
      */
     Active = "Active",
     /**
-     * Posts sorted by the published time.
+     * Posts sorted by a decaying rank.
      */
     Hot = "Hot",
+    /**
+     * Posts sorted by the published time.
+     */
     New = "New",
+    /**
+     * Posts sorted by the published time ascending
+     */
+    Old = "Old",
     /**
      * The top posts for this last day.
      */
@@ -122,6 +135,27 @@ export declare enum SortType {
      */
     NewComments = "NewComments"
 }
+/**
+ * Different comment sort types used in lemmy.
+ */
+export declare enum CommentSortType {
+    /**
+     * Comments sorted by a decaying rank.
+     */
+    Hot = "Hot",
+    /**
+     * Comments sorted by top score.
+     */
+    Top = "Top",
+    /**
+     * Comments sorted by new.
+     */
+    New = "New",
+    /**
+     * Comments sorted by old.
+     */
+    Old = "Old"
+}
 /**
  * The different listing types for post and comment fetches.
  */
@@ -143,37 +177,40 @@ export declare enum SearchType {
     Url = "Url"
 }
 /**
- * A websocket response. Includes the return type.
- * Can be used like:
- *
- * ```ts
- * if (op == UserOperation.Search) {
- *   let data = wsJsonToRes<SearchResponse>(msg).data;
- * }
- * ```
+ * Mod log action types
  */
-export interface WebSocketResponse<ResponseType> {
-    op: UserOperation;
-    /**
-     * This contains the data for a websocket response.
-     *
-     * The correct response type if given is in [[LemmyHttp]].
-     */
-    data: ResponseType;
+export declare enum ModlogActionType {
+    All = "All",
+    ModRemovePost = "ModRemovePost",
+    ModLockPost = "ModLockPost",
+    ModFeaturePost = "ModFeaturePost",
+    ModRemoveComment = "ModRemoveComment",
+    ModRemoveCommunity = "ModRemoveCommunity",
+    ModBanFromCommunity = "ModBanFromCommunity",
+    ModAddCommunity = "ModAddCommunity",
+    ModTransferCommunity = "ModTransferCommunity",
+    ModAdd = "ModAdd",
+    ModBan = "ModBan",
+    ModHideCommunity = "ModHideCommunity",
+    AdminPurgePerson = "AdminPurgePerson",
+    AdminPurgeCommunity = "AdminPurgeCommunity",
+    AdminPurgePost = "AdminPurgePost",
+    AdminPurgeComment = "AdminPurgeComment"
 }
 /**
- * A websocket JSON response that includes the errors.
+ * Different Subscribed states
  */
-export interface WebSocketJsonResponse<ResponseType> {
-    op?: string;
-    /**
-     * This contains the data for a websocket response.
-     *
-     * The correct response type if given is in [[LemmyHttp]].
-     */
-    data?: ResponseType;
-    error?: string;
-    reconnect?: boolean;
+export declare enum SubscribedType {
+    Subscribed = "Subscribed",
+    NotSubscribed = "NotSubscribed",
+    Pending = "Pending"
+}
+/**
+ * Different Subscribed states
+ */
+export declare enum PostFeatureType {
+    Local = "Local",
+    Community = "Community"
 }
 /**
  * A holder for a site's metadata ( such as opengraph tags ), used for post links.

package/dist/interfaces/others.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchType = exports.ListingType = exports.SortType = exports.UserOperation = exports.VERSION = void 0;
+exports.PostFeatureType = exports.SubscribedType = exports.ModlogActionType = exports.SearchType = exports.ListingType = exports.CommentSortType = exports.SortType = exports.UserOperation = exports.VERSION = void 0;
 exports.VERSION = "v3";
 /**
  * All of the websocket operations available.
@@ -19,16 +19,16 @@ var UserOperation;
     UserOperation[UserOperation["EditComment"] = 9] = "EditComment";
     UserOperation[UserOperation["DeleteComment"] = 10] = "DeleteComment";
     UserOperation[UserOperation["RemoveComment"] = 11] = "RemoveComment";
-    UserOperation[UserOperation["MarkCommentAsRead"] = 12] = "MarkCommentAsRead";
-    UserOperation[UserOperation["SaveComment"] = 13] = "SaveComment";
-    UserOperation[UserOperation["CreateCommentLike"] = 14] = "CreateCommentLike";
-    UserOperation[UserOperation["GetPosts"] = 15] = "GetPosts";
-    UserOperation[UserOperation["CreatePostLike"] = 16] = "CreatePostLike";
-    UserOperation[UserOperation["EditPost"] = 17] = "EditPost";
-    UserOperation[UserOperation["DeletePost"] = 18] = "DeletePost";
-    UserOperation[UserOperation["RemovePost"] = 19] = "RemovePost";
-    UserOperation[UserOperation["LockPost"] = 20] = "LockPost";
-    UserOperation[UserOperation["StickyPost"] = 21] = "StickyPost";
+    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";
@@ -38,66 +38,79 @@ var UserOperation;
     UserOperation[UserOperation["GetReplies"] = 28] = "GetReplies";
     UserOperation[UserOperation["GetPersonMentions"] = 29] = "GetPersonMentions";
     UserOperation[UserOperation["MarkPersonMentionAsRead"] = 30] = "MarkPersonMentionAsRead";
-    UserOperation[UserOperation["GetModlog"] = 31] = "GetModlog";
-    UserOperation[UserOperation["BanFromCommunity"] = 32] = "BanFromCommunity";
-    UserOperation[UserOperation["AddModToCommunity"] = 33] = "AddModToCommunity";
-    UserOperation[UserOperation["CreateSite"] = 34] = "CreateSite";
-    UserOperation[UserOperation["EditSite"] = 35] = "EditSite";
-    UserOperation[UserOperation["GetSite"] = 36] = "GetSite";
-    UserOperation[UserOperation["AddAdmin"] = 37] = "AddAdmin";
-    UserOperation[UserOperation["GetUnreadRegistrationApplicationCount"] = 38] = "GetUnreadRegistrationApplicationCount";
-    UserOperation[UserOperation["ListRegistrationApplications"] = 39] = "ListRegistrationApplications";
-    UserOperation[UserOperation["ApproveRegistrationApplication"] = 40] = "ApproveRegistrationApplication";
-    UserOperation[UserOperation["BanPerson"] = 41] = "BanPerson";
-    UserOperation[UserOperation["GetBannedPersons"] = 42] = "GetBannedPersons";
-    UserOperation[UserOperation["Search"] = 43] = "Search";
-    UserOperation[UserOperation["ResolveObject"] = 44] = "ResolveObject";
-    UserOperation[UserOperation["MarkAllAsRead"] = 45] = "MarkAllAsRead";
-    UserOperation[UserOperation["SaveUserSettings"] = 46] = "SaveUserSettings";
-    UserOperation[UserOperation["TransferCommunity"] = 47] = "TransferCommunity";
-    UserOperation[UserOperation["LeaveAdmin"] = 48] = "LeaveAdmin";
-    UserOperation[UserOperation["DeleteAccount"] = 49] = "DeleteAccount";
-    UserOperation[UserOperation["PasswordReset"] = 50] = "PasswordReset";
-    UserOperation[UserOperation["PasswordChange"] = 51] = "PasswordChange";
-    UserOperation[UserOperation["CreatePrivateMessage"] = 52] = "CreatePrivateMessage";
-    UserOperation[UserOperation["EditPrivateMessage"] = 53] = "EditPrivateMessage";
-    UserOperation[UserOperation["DeletePrivateMessage"] = 54] = "DeletePrivateMessage";
-    UserOperation[UserOperation["MarkPrivateMessageAsRead"] = 55] = "MarkPrivateMessageAsRead";
-    UserOperation[UserOperation["GetPrivateMessages"] = 56] = "GetPrivateMessages";
-    UserOperation[UserOperation["UserJoin"] = 57] = "UserJoin";
-    UserOperation[UserOperation["GetComments"] = 58] = "GetComments";
-    UserOperation[UserOperation["GetSiteConfig"] = 59] = "GetSiteConfig";
-    UserOperation[UserOperation["SaveSiteConfig"] = 60] = "SaveSiteConfig";
-    UserOperation[UserOperation["PostJoin"] = 61] = "PostJoin";
-    UserOperation[UserOperation["CommunityJoin"] = 62] = "CommunityJoin";
-    UserOperation[UserOperation["ChangePassword"] = 63] = "ChangePassword";
-    UserOperation[UserOperation["GetSiteMetadata"] = 64] = "GetSiteMetadata";
-    UserOperation[UserOperation["BlockCommunity"] = 65] = "BlockCommunity";
-    UserOperation[UserOperation["BlockPerson"] = 66] = "BlockPerson";
-    UserOperation[UserOperation["CreateCommentReport"] = 67] = "CreateCommentReport";
-    UserOperation[UserOperation["ResolveCommentReport"] = 68] = "ResolveCommentReport";
-    UserOperation[UserOperation["ListCommentReports"] = 69] = "ListCommentReports";
-    UserOperation[UserOperation["CreatePostReport"] = 70] = "CreatePostReport";
-    UserOperation[UserOperation["ResolvePostReport"] = 71] = "ResolvePostReport";
-    UserOperation[UserOperation["ListPostReports"] = 72] = "ListPostReports";
-    UserOperation[UserOperation["GetReportCount"] = 73] = "GetReportCount";
-    UserOperation[UserOperation["GetUnreadCount"] = 74] = "GetUnreadCount";
-    UserOperation[UserOperation["VerifyEmail"] = 75] = "VerifyEmail";
+    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["PasswordChange"] = 52] = "PasswordChange";
+    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["PostJoin"] = 63] = "PostJoin";
+    UserOperation[UserOperation["CommunityJoin"] = 64] = "CommunityJoin";
+    UserOperation[UserOperation["ChangePassword"] = 65] = "ChangePassword";
+    UserOperation[UserOperation["GetSiteMetadata"] = 66] = "GetSiteMetadata";
+    UserOperation[UserOperation["BlockCommunity"] = 67] = "BlockCommunity";
+    UserOperation[UserOperation["BlockPerson"] = 68] = "BlockPerson";
+    UserOperation[UserOperation["PurgePerson"] = 69] = "PurgePerson";
+    UserOperation[UserOperation["PurgeCommunity"] = 70] = "PurgeCommunity";
+    UserOperation[UserOperation["PurgePost"] = 71] = "PurgePost";
+    UserOperation[UserOperation["PurgeComment"] = 72] = "PurgeComment";
+    UserOperation[UserOperation["CreateCommentReport"] = 73] = "CreateCommentReport";
+    UserOperation[UserOperation["ResolveCommentReport"] = 74] = "ResolveCommentReport";
+    UserOperation[UserOperation["ListCommentReports"] = 75] = "ListCommentReports";
+    UserOperation[UserOperation["CreatePostReport"] = 76] = "CreatePostReport";
+    UserOperation[UserOperation["ResolvePostReport"] = 77] = "ResolvePostReport";
+    UserOperation[UserOperation["ListPostReports"] = 78] = "ListPostReports";
+    UserOperation[UserOperation["GetReportCount"] = 79] = "GetReportCount";
+    UserOperation[UserOperation["GetUnreadCount"] = 80] = "GetUnreadCount";
+    UserOperation[UserOperation["VerifyEmail"] = 81] = "VerifyEmail";
 })(UserOperation = exports.UserOperation || (exports.UserOperation = {}));
 /**
- * Different sort types used in lemmy.
+ * Different post sort types used in lemmy.
  */
 var SortType;
 (function (SortType) {
     /**
-     * Posts sorted by the most recent comment.
+     * Posts sorted by hot, but bumped by new comments up to 2 days
      */
     SortType["Active"] = "Active";
     /**
-     * Posts sorted by the published time.
+     * Posts sorted by a decaying rank.
      */
     SortType["Hot"] = "Hot";
+    /**
+     * Posts sorted by the published time.
+     */
     SortType["New"] = "New";
+    /**
+     * Posts sorted by the published time ascending
+     */
+    SortType["Old"] = "Old";
     /**
      * The top posts for this last day.
      */
@@ -127,6 +140,28 @@ var SortType;
      */
     SortType["NewComments"] = "NewComments";
 })(SortType = exports.SortType || (exports.SortType = {}));
+/**
+ * Different comment sort types used in lemmy.
+ */
+var CommentSortType;
+(function (CommentSortType) {
+    /**
+     * Comments sorted by a decaying rank.
+     */
+    CommentSortType["Hot"] = "Hot";
+    /**
+     * Comments sorted by top score.
+     */
+    CommentSortType["Top"] = "Top";
+    /**
+     * Comments sorted by new.
+     */
+    CommentSortType["New"] = "New";
+    /**
+     * Comments sorted by old.
+     */
+    CommentSortType["Old"] = "Old";
+})(CommentSortType = exports.CommentSortType || (exports.CommentSortType = {}));
 /**
  * The different listing types for post and comment fetches.
  */
@@ -149,3 +184,42 @@ var SearchType;
     SearchType["Users"] = "Users";
     SearchType["Url"] = "Url";
 })(SearchType = exports.SearchType || (exports.SearchType = {}));
+/**
+ * Mod log action types
+ */
+var ModlogActionType;
+(function (ModlogActionType) {
+    ModlogActionType["All"] = "All";
+    ModlogActionType["ModRemovePost"] = "ModRemovePost";
+    ModlogActionType["ModLockPost"] = "ModLockPost";
+    ModlogActionType["ModFeaturePost"] = "ModFeaturePost";
+    ModlogActionType["ModRemoveComment"] = "ModRemoveComment";
+    ModlogActionType["ModRemoveCommunity"] = "ModRemoveCommunity";
+    ModlogActionType["ModBanFromCommunity"] = "ModBanFromCommunity";
+    ModlogActionType["ModAddCommunity"] = "ModAddCommunity";
+    ModlogActionType["ModTransferCommunity"] = "ModTransferCommunity";
+    ModlogActionType["ModAdd"] = "ModAdd";
+    ModlogActionType["ModBan"] = "ModBan";
+    ModlogActionType["ModHideCommunity"] = "ModHideCommunity";
+    ModlogActionType["AdminPurgePerson"] = "AdminPurgePerson";
+    ModlogActionType["AdminPurgeCommunity"] = "AdminPurgeCommunity";
+    ModlogActionType["AdminPurgePost"] = "AdminPurgePost";
+    ModlogActionType["AdminPurgeComment"] = "AdminPurgeComment";
+})(ModlogActionType = exports.ModlogActionType || (exports.ModlogActionType = {}));
+/**
+ * Different Subscribed states
+ */
+var SubscribedType;
+(function (SubscribedType) {
+    SubscribedType["Subscribed"] = "Subscribed";
+    SubscribedType["NotSubscribed"] = "NotSubscribed";
+    SubscribedType["Pending"] = "Pending";
+})(SubscribedType = exports.SubscribedType || (exports.SubscribedType = {}));
+/**
+ * Different Subscribed states
+ */
+var PostFeatureType;
+(function (PostFeatureType) {
+    PostFeatureType["Local"] = "Local";
+    PostFeatureType["Community"] = "Community";
+})(PostFeatureType = exports.PostFeatureType || (exports.PostFeatureType = {}));