lemmy-js-client 0.16.4-rc.1 → 0.17.0-rc.10

package/dist/interfaces/api/post.d.ts

@@ -1,4 +1,4 @@
-import { SiteMetadata } from "..";
+import { ListingType, SiteMetadata, SortType } from "../others";
 import { CommentView, CommunityModeratorView, CommunityView, PostReportView, PostView } from "../views";
 export interface CreatePost {
     name: string;
@@ -24,16 +24,8 @@ export interface GetPostResponse {
     online: number;
 }
 export interface GetPosts {
-    /**
-     * The [[ListingType]].
-     *
-     * Post listing types are `All, Subscribed, Community`
-     */
-    type_?: string;
-    /**
-     * The [[SortType]].
-     */
-    sort?: string;
+    type_?: ListingType;
+    sort?: SortType;
     page?: number;
     limit?: number;
     community_id?: number;
@@ -77,6 +69,14 @@ export interface RemovePost {
     reason?: string;
     auth: string;
 }
+/**
+ * Marks a post as read.
+ */
+export interface MarkPostAsRead {
+    post_id: number;
+    read: boolean;
+    auth: string;
+}
 /**
  * Only admins and mods can lock a post.
  */

package/dist/interfaces/api/site.d.ts

@@ -1,3 +1,4 @@
+import { ListingType, SearchType, SortType } from "../others";
 import { CommentView, CommunityBlockView, CommunityFollowerView, CommunityModeratorView, CommunityView, LocalUserSettingsView, ModAddCommunityView, ModAddView, ModBanFromCommunityView, ModBanView, ModLockPostView, ModRemoveCommentView, ModRemoveCommunityView, ModRemovePostView, ModStickyPostView, ModTransferCommunityView, PersonBlockView, PersonViewSafe, PostView, RegistrationApplicationView, SiteView } from "../views";
 /**
  * Search lemmy for different types of data.
@@ -7,21 +8,12 @@ export interface Search {
      * The search query string.
      */
     q: string;
-    /**
-     * The [[SearchType]].
-     */
-    type_?: string;
+    type_?: SearchType;
     community_id?: number;
     community_name?: string;
     creator_id?: number;
-    /**
-     * The [[SortType]].
-     */
-    sort?: string;
-    /**
-     * The [[ListingType]].
-     */
-    listing_type?: string;
+    sort?: SortType;
+    listing_type?: ListingType;
     page?: number;
     limit?: number;
     auth?: string;
@@ -70,6 +62,7 @@ export interface CreateSite {
     application_question?: string;
     private_instance?: boolean;
     default_theme?: string;
+    default_post_listing_type?: string;
     auth: string;
 }
 export interface EditSite {
@@ -87,6 +80,8 @@ export interface EditSite {
     application_question?: string;
     private_instance?: boolean;
     default_theme?: string;
+    legal_information?: string;
+    default_post_listing_type?: string;
     auth: string;
 }
 export interface GetSite {

package/dist/interfaces/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/interfaces/others.d.ts

@@ -25,60 +25,61 @@ export declare enum UserOperation {
     RemovePost = 19,
     LockPost = 20,
     StickyPost = 21,
-    SavePost = 22,
-    EditCommunity = 23,
-    DeleteCommunity = 24,
-    RemoveCommunity = 25,
-    FollowCommunity = 26,
-    GetPersonDetails = 27,
-    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
+    MarkPostAsRead = 22,
+    SavePost = 23,
+    EditCommunity = 24,
+    DeleteCommunity = 25,
+    RemoveCommunity = 26,
+    FollowCommunity = 27,
+    GetPersonDetails = 28,
+    GetReplies = 29,
+    GetPersonMentions = 30,
+    MarkPersonMentionAsRead = 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,
+    GetPrivateMessages = 57,
+    UserJoin = 58,
+    GetComments = 59,
+    GetSiteConfig = 60,
+    SaveSiteConfig = 61,
+    PostJoin = 62,
+    CommunityJoin = 63,
+    ChangePassword = 64,
+    GetSiteMetadata = 65,
+    BlockCommunity = 66,
+    BlockPerson = 67,
+    CreateCommentReport = 68,
+    ResolveCommentReport = 69,
+    ListCommentReports = 70,
+    CreatePostReport = 71,
+    ResolvePostReport = 72,
+    ListPostReports = 73,
+    GetReportCount = 74,
+    GetUnreadCount = 75,
+    VerifyEmail = 76
 }
 /**
  * Different sort types used in lemmy.

package/dist/interfaces/others.js

@@ -29,60 +29,61 @@ var UserOperation;
     UserOperation[UserOperation["RemovePost"] = 19] = "RemovePost";
     UserOperation[UserOperation["LockPost"] = 20] = "LockPost";
     UserOperation[UserOperation["StickyPost"] = 21] = "StickyPost";
-    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["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["MarkPostAsRead"] = 22] = "MarkPostAsRead";
+    UserOperation[UserOperation["SavePost"] = 23] = "SavePost";
+    UserOperation[UserOperation["EditCommunity"] = 24] = "EditCommunity";
+    UserOperation[UserOperation["DeleteCommunity"] = 25] = "DeleteCommunity";
+    UserOperation[UserOperation["RemoveCommunity"] = 26] = "RemoveCommunity";
+    UserOperation[UserOperation["FollowCommunity"] = 27] = "FollowCommunity";
+    UserOperation[UserOperation["GetPersonDetails"] = 28] = "GetPersonDetails";
+    UserOperation[UserOperation["GetReplies"] = 29] = "GetReplies";
+    UserOperation[UserOperation["GetPersonMentions"] = 30] = "GetPersonMentions";
+    UserOperation[UserOperation["MarkPersonMentionAsRead"] = 31] = "MarkPersonMentionAsRead";
+    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["GetPrivateMessages"] = 57] = "GetPrivateMessages";
+    UserOperation[UserOperation["UserJoin"] = 58] = "UserJoin";
+    UserOperation[UserOperation["GetComments"] = 59] = "GetComments";
+    UserOperation[UserOperation["GetSiteConfig"] = 60] = "GetSiteConfig";
+    UserOperation[UserOperation["SaveSiteConfig"] = 61] = "SaveSiteConfig";
+    UserOperation[UserOperation["PostJoin"] = 62] = "PostJoin";
+    UserOperation[UserOperation["CommunityJoin"] = 63] = "CommunityJoin";
+    UserOperation[UserOperation["ChangePassword"] = 64] = "ChangePassword";
+    UserOperation[UserOperation["GetSiteMetadata"] = 65] = "GetSiteMetadata";
+    UserOperation[UserOperation["BlockCommunity"] = 66] = "BlockCommunity";
+    UserOperation[UserOperation["BlockPerson"] = 67] = "BlockPerson";
+    UserOperation[UserOperation["CreateCommentReport"] = 68] = "CreateCommentReport";
+    UserOperation[UserOperation["ResolveCommentReport"] = 69] = "ResolveCommentReport";
+    UserOperation[UserOperation["ListCommentReports"] = 70] = "ListCommentReports";
+    UserOperation[UserOperation["CreatePostReport"] = 71] = "CreatePostReport";
+    UserOperation[UserOperation["ResolvePostReport"] = 72] = "ResolvePostReport";
+    UserOperation[UserOperation["ListPostReports"] = 73] = "ListPostReports";
+    UserOperation[UserOperation["GetReportCount"] = 74] = "GetReportCount";
+    UserOperation[UserOperation["GetUnreadCount"] = 75] = "GetUnreadCount";
+    UserOperation[UserOperation["VerifyEmail"] = 76] = "VerifyEmail";
 })(UserOperation = exports.UserOperation || (exports.UserOperation = {}));
 /**
  * Different sort types used in lemmy.

package/dist/interfaces/source.d.ts

@@ -54,10 +54,12 @@ export interface Site {
     application_question?: string;
     private_instance: boolean;
     default_theme: string;
+    default_post_listing_type: string;
     actor_id: string;
     last_refreshed_at: string;
     inbox_url: string;
     public_key: string;
+    legal_information?: string;
 }
 export interface PrivateMessage {
     id: number;
@@ -206,6 +208,7 @@ export interface CommunitySafe {
     local: boolean;
     icon?: string;
     banner?: string;
+    posting_restricted_to_mods: boolean;
 }
 export interface CommentReport {
     id: number;

package/dist/interfaces/views.d.ts

@@ -25,7 +25,6 @@ export interface LocalUserSettingsView {
 }
 export interface SiteView {
     site: Site;
-    creator: PersonSafe;
     counts: SiteAggregates;
 }
 export interface PrivateMessageView {
@@ -143,6 +142,7 @@ export interface ModStickyPostView {
 export interface CommunityFollowerView {
     community: CommunitySafe;
     follower: PersonSafe;
+    pending: boolean;
 }
 export interface CommunityBlockView {
     person: PersonSafe;

package/dist/websocket.d.ts

@@ -1,7 +1,7 @@
 import { CreateComment, CreateCommentLike, CreateCommentReport, DeleteComment, EditComment, GetComments, ListCommentReports, MarkCommentAsRead, 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, DeleteAccount, DeletePrivateMessage, EditPrivateMessage, GetBannedPersons, GetPersonDetails, GetPersonMentions, GetPrivateMessages, GetReplies, GetReportCount, GetUnreadCount, Login, MarkAllAsRead, MarkPersonMentionAsRead, MarkPrivateMessageAsRead, PasswordChange, PasswordReset, Register, SaveUserSettings, VerifyEmail } from "./interfaces/api/person";
-import { CreatePost, CreatePostLike, CreatePostReport, DeletePost, EditPost, GetPost, GetPosts, GetSiteMetadata, ListPostReports, LockPost, RemovePost, ResolvePostReport, SavePost, StickyPost } from "./interfaces/api/post";
+import { CreatePost, CreatePostLike, CreatePostReport, DeletePost, EditPost, GetPost, GetPosts, GetSiteMetadata, ListPostReports, LockPost, MarkPostAsRead, RemovePost, ResolvePostReport, SavePost, StickyPost } from "./interfaces/api/post";
 import { ApproveRegistrationApplication, CreateSite, EditSite, GetModlog, GetSite, GetSiteConfig, GetUnreadRegistrationApplicationCount, LeaveAdmin, ListRegistrationApplications, ResolveObject, SaveSiteConfig, Search } from "./interfaces/api/site";
 import { CommunityJoin, PostJoin, UserJoin } from "./interfaces/api/websocket";
 /**
@@ -153,6 +153,10 @@ export declare class LemmyWebsocket {
      * A moderator can sticky a post ( IE stick it to the top of a community ).
      */
     stickyPost(form: StickyPost): string;
+    /**
+     * Mark a post as read.
+     */
+    markPostAsRead(form: MarkPostAsRead): string;
     /**
      * Save a post.
      */

package/dist/websocket.js

@@ -218,6 +218,12 @@ var LemmyWebsocket = /** @class */ (function () {
     LemmyWebsocket.prototype.stickyPost = function (form) {
         return wrapper(others_1.UserOperation.StickyPost, form);
     };
+    /**
+     * Mark a post as read.
+     */
+    LemmyWebsocket.prototype.markPostAsRead = function (form) {
+        return wrapper(others_1.UserOperation.MarkPostAsRead, form);
+    };
     /**
      * Save a post.
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.16.4-rc.1",
+  "version": "0.17.0-rc.10",
   "author": "Dessalines <tyhou13@gmx.com>",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -16,23 +16,23 @@
   },
   "repository": "https://github.com/LemmyNet/lemmy-js-client",
   "devDependencies": {
-    "@types/node": "^17.0.10",
+    "@types/node": "^17.0.33",
     "@types/node-fetch": "^3.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.10.0",
-    "@typescript-eslint/parser": "^5.10.0",
-    "eslint": "^8.7.0",
+    "@typescript-eslint/eslint-plugin": "^5.23.0",
+    "@typescript-eslint/parser": "^5.23.0",
+    "eslint": "^8.15.0",
     "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^7.0.4",
-    "lint-staged": "^12.2.2",
-    "node-fetch": "^3.1.1",
-    "prettier": "^2.5.0",
+    "husky": "^8.0.1",
+    "lint-staged": "^12.4.1",
+    "node-fetch": "^3.2.4",
+    "prettier": "^2.6.2",
     "prettier-plugin-import-sort": "^0.0.7",
     "prettier-plugin-organize-imports": "^2.3.4",
-    "prettier-plugin-packagejson": "^2.2.15",
+    "prettier-plugin-packagejson": "^2.2.18",
     "sortpack": "^2.2.0",
     "typedoc": "^0.21.6",
     "typedoc-plugin-sourcefile-url": "^1.0.6",
-    "typescript": "^4.5.4"
+    "typescript": "^4.6.4"
   },
   "types": "./dist/index.d.ts",
   "lint-staged": {