lemmy-js-client 0.15.0-rc.2 → 0.15.0-rc.8

package/dist/http.d.ts

@@ -1,6 +1,6 @@
 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 { AddAdmin, AddAdminResponse, BanPerson, BanPersonResponse, BlockPerson, BlockPersonResponse, ChangePassword, CreatePrivateMessage, DeleteAccount, DeleteAccountResponse, DeletePrivateMessage, EditPrivateMessage, GetCaptchaResponse, GetPersonDetails, GetPersonDetailsResponse, GetPersonMentions, GetPersonMentionsResponse, GetPrivateMessages, GetReplies, GetRepliesResponse, GetReportCount, GetReportCountResponse, GetUnreadCount, GetUnreadCountResponse, Login, LoginResponse, MarkAllAsRead, MarkPersonMentionAsRead, MarkPrivateMessageAsRead, PasswordChange, PasswordReset, PasswordResetResponse, PersonMentionResponse, PrivateMessageResponse, PrivateMessagesResponse, Register, SaveUserSettings, VerifyEmail, VerifyEmailResponse } from "./interfaces/api/person";
+import { AddAdmin, AddAdminResponse, BannedPersonsResponse, BanPerson, BanPersonResponse, BlockPerson, BlockPersonResponse, ChangePassword, CreatePrivateMessage, DeleteAccount, DeleteAccountResponse, DeletePrivateMessage, EditPrivateMessage, GetBannedPersons, GetCaptchaResponse, GetPersonDetails, GetPersonDetailsResponse, GetPersonMentions, GetPersonMentionsResponse, GetPrivateMessages, GetReplies, GetRepliesResponse, GetReportCount, GetReportCountResponse, GetUnreadCount, GetUnreadCountResponse, Login, LoginResponse, MarkAllAsRead, MarkPersonMentionAsRead, MarkPrivateMessageAsRead, PasswordChange, PasswordReset, PasswordResetResponse, PersonMentionResponse, PrivateMessageResponse, PrivateMessagesResponse, Register, SaveUserSettings, VerifyEmail, VerifyEmailResponse } from "./interfaces/api/person";
 import { CreatePost, CreatePostLike, CreatePostReport, DeletePost, EditPost, GetPost, GetPostResponse, GetPosts, GetPostsResponse, GetSiteMetadata, GetSiteMetadataResponse, ListPostReports, ListPostReportsResponse, LockPost, PostReportResponse, PostResponse, RemovePost, ResolvePostReport, SavePost, StickyPost } from "./interfaces/api/post";
 import { ApproveRegistrationApplication, CreateSite, EditSite, GetModlog, GetModlogResponse, GetSite, GetSiteConfig, GetSiteConfigResponse, GetSiteResponse, GetUnreadRegistrationApplicationCount, GetUnreadRegistrationApplicationCountResponse, ListRegistrationApplications, ListRegistrationApplicationsResponse, RegistrationApplicationResponse, ResolveObject, ResolveObjectResponse, SaveSiteConfig, Search, SearchResponse, SiteResponse, TransferSite } from "./interfaces/api/site";
 /**
@@ -245,6 +245,10 @@ export declare class LemmyHttp {
      * Ban a person from your site.
      */
     banPerson(form: BanPerson): Promise<BanPersonResponse>;
+    /**
+     * Get a list of banned users
+     */
+    getBannedPersons(form: GetBannedPersons): Promise<BannedPersonsResponse>;
     /**
      * Block a person.
      */

package/dist/http.js

@@ -642,6 +642,16 @@ var LemmyHttp = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Get a list of banned users
+     */
+    LemmyHttp.prototype.getBannedPersons = function (form) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.wrapper(HttpType.Get, "/user/banned", form)];
+            });
+        });
+    };
     /**
      * Block a person.
      */

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

@@ -265,3 +265,9 @@ export interface BlockPersonResponse {
     person_view: PersonViewSafe;
     blocked: boolean;
 }
+export interface GetBannedPersons {
+    auth: string;
+}
+export interface BannedPersonsResponse {
+    banned: PersonViewSafe[];
+}

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

@@ -41,6 +41,7 @@ export interface GetModlog {
     community_id?: number;
     page?: number;
     limit?: number;
+    auth?: string;
 }
 export interface GetModlogResponse {
     removed_posts: ModRemovePostView[];
@@ -98,7 +99,6 @@ export interface GetSiteResponse {
      */
     site_view?: SiteView;
     admins: PersonViewSafe[];
-    banned: PersonViewSafe[];
     online: number;
     version: string;
     /**

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

@@ -0,0 +1,190 @@
+import {
+  CommentView,
+  CommunityFollowerView,
+  CommunityModeratorView,
+  PostView,
+  PrivateMessageView,
+  UserMentionView,
+  UserViewSafe,
+} from "../views";
+export interface Login {
+  username_or_email: string;
+  password: string;
+}
+/**
+ * Only the first user will be able to be the admin.
+ */
+export interface Register {
+  username: string;
+  email?: string;
+  password: string;
+  password_verify: string;
+  show_nsfw: boolean;
+  captcha_uuid?: string;
+  captcha_answer?: string;
+}
+export interface GetCaptcha {}
+export interface GetCaptchaResponse {
+  ok?: CaptchaResponse;
+}
+export interface CaptchaResponse {
+  png: string;
+  wav?: string;
+  uuid: string;
+}
+export interface SaveUserSettings {
+  show_nsfw: boolean;
+  theme: string;
+  default_sort_type: number;
+  default_listing_type: number;
+  lang: string;
+  avatar?: string;
+  banner?: string;
+  preferred_username?: string;
+  email?: string;
+  bio?: string;
+  matrix_user_id?: string;
+  new_password?: string;
+  new_password_verify?: string;
+  old_password?: string;
+  show_avatars: boolean;
+  send_notifications_to_email: boolean;
+  auth: string;
+}
+/**
+ * The `jwt` string should be stored and used anywhere `auth` is called for.
+ */
+export interface LoginResponse {
+  jwt: string;
+}
+/**
+ * `username` can only be used for local users. To get details for a federated user, pass `user_id` instead.
+ */
+export interface GetUserDetails {
+  user_id?: number;
+  username?: string;
+  sort: string;
+  page?: number;
+  limit?: number;
+  community_id?: number;
+  saved_only: boolean;
+  auth?: string;
+}
+export interface GetUserDetailsResponse {
+  user_view: UserViewSafe;
+  follows: CommunityFollowerView[];
+  moderates: CommunityModeratorView[];
+  comments: CommentView[];
+  posts: PostView[];
+}
+export interface GetRepliesResponse {
+  replies: CommentView[];
+}
+export interface GetUserMentionsResponse {
+  mentions: UserMentionView[];
+}
+export interface MarkAllAsRead {
+  auth: string;
+}
+export interface AddAdmin {
+  user_id: number;
+  added: boolean;
+  auth: string;
+}
+export interface AddAdminResponse {
+  admins: UserViewSafe[];
+}
+export interface BanUser {
+  user_id: number;
+  ban: boolean;
+  remove_data: boolean;
+  reason?: string;
+  expires?: number;
+  auth: string;
+}
+export interface BanUserResponse {
+  user_view: UserViewSafe;
+  banned: boolean;
+}
+export interface GetReplies {
+  sort: string;
+  page?: number;
+  limit?: number;
+  unread_only: boolean;
+  auth: string;
+}
+export interface GetUserMentions {
+  sort: string;
+  page?: number;
+  limit?: number;
+  unread_only: boolean;
+  auth: string;
+}
+export interface MarkUserMentionAsRead {
+  user_mention_id: number;
+  read: boolean;
+  auth: string;
+}
+export interface UserMentionResponse {
+  user_mention_view: UserMentionView;
+}
+/**
+ * Permanently deletes your posts and comments
+ */
+export interface DeleteAccount {
+  password: string;
+  auth: string;
+}
+export interface PasswordReset {
+  email: string;
+}
+export interface PasswordResetResponse {}
+export interface PasswordChange {
+  token: string;
+  password: string;
+  password_verify: string;
+}
+export interface CreatePrivateMessage {
+  content: string;
+  recipient_id: number;
+  auth: string;
+}
+export interface EditPrivateMessage {
+  private_message_id: number;
+  content: string;
+  auth: string;
+}
+export interface DeletePrivateMessage {
+  private_message_id: number;
+  deleted: boolean;
+  auth: string;
+}
+export interface MarkPrivateMessageAsRead {
+  private_message_id: number;
+  read: boolean;
+  auth: string;
+}
+export interface GetPrivateMessages {
+  unread_only: boolean;
+  page?: number;
+  limit?: number;
+  auth: string;
+}
+export interface PrivateMessagesResponse {
+  private_messages: PrivateMessageView[];
+}
+export interface PrivateMessageResponse {
+  private_message_view: PrivateMessageView;
+}
+/**
+ * If a community is supplied, returns the report count for only that community, otherwise returns the report count for all communities the user moderates.
+ */
+export interface GetReportCount {
+  community?: number;
+  auth: string;
+}
+export interface GetReportCountResponse {
+  community?: number;
+  comment_reports: number;
+  post_reports: number;
+}

package/dist/interfaces/api/user.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/others.d.ts

@@ -45,39 +45,40 @@ export declare enum UserOperation {
     ListRegistrationApplications = 39,
     ApproveRegistrationApplication = 40,
     BanPerson = 41,
-    Search = 42,
-    ResolveObject = 43,
-    MarkAllAsRead = 44,
-    SaveUserSettings = 45,
-    TransferCommunity = 46,
-    TransferSite = 47,
-    DeleteAccount = 48,
-    PasswordReset = 49,
-    PasswordChange = 50,
-    CreatePrivateMessage = 51,
-    EditPrivateMessage = 52,
-    DeletePrivateMessage = 53,
-    MarkPrivateMessageAsRead = 54,
-    GetPrivateMessages = 55,
-    UserJoin = 56,
-    GetComments = 57,
-    GetSiteConfig = 58,
-    SaveSiteConfig = 59,
-    PostJoin = 60,
-    CommunityJoin = 61,
-    ChangePassword = 62,
-    GetSiteMetadata = 63,
-    BlockCommunity = 64,
-    BlockPerson = 65,
-    CreateCommentReport = 66,
-    ResolveCommentReport = 67,
-    ListCommentReports = 68,
-    CreatePostReport = 69,
-    ResolvePostReport = 70,
-    ListPostReports = 71,
-    GetReportCount = 72,
-    GetUnreadCount = 73,
-    VerifyEmail = 74
+    GetBannedPersons = 42,
+    Search = 43,
+    ResolveObject = 44,
+    MarkAllAsRead = 45,
+    SaveUserSettings = 46,
+    TransferCommunity = 47,
+    TransferSite = 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
 }
 /**
  * Different sort types used in lemmy.

package/dist/interfaces/others.js

@@ -49,39 +49,40 @@ var UserOperation;
     UserOperation[UserOperation["ListRegistrationApplications"] = 39] = "ListRegistrationApplications";
     UserOperation[UserOperation["ApproveRegistrationApplication"] = 40] = "ApproveRegistrationApplication";
     UserOperation[UserOperation["BanPerson"] = 41] = "BanPerson";
-    UserOperation[UserOperation["Search"] = 42] = "Search";
-    UserOperation[UserOperation["ResolveObject"] = 43] = "ResolveObject";
-    UserOperation[UserOperation["MarkAllAsRead"] = 44] = "MarkAllAsRead";
-    UserOperation[UserOperation["SaveUserSettings"] = 45] = "SaveUserSettings";
-    UserOperation[UserOperation["TransferCommunity"] = 46] = "TransferCommunity";
-    UserOperation[UserOperation["TransferSite"] = 47] = "TransferSite";
-    UserOperation[UserOperation["DeleteAccount"] = 48] = "DeleteAccount";
-    UserOperation[UserOperation["PasswordReset"] = 49] = "PasswordReset";
-    UserOperation[UserOperation["PasswordChange"] = 50] = "PasswordChange";
-    UserOperation[UserOperation["CreatePrivateMessage"] = 51] = "CreatePrivateMessage";
-    UserOperation[UserOperation["EditPrivateMessage"] = 52] = "EditPrivateMessage";
-    UserOperation[UserOperation["DeletePrivateMessage"] = 53] = "DeletePrivateMessage";
-    UserOperation[UserOperation["MarkPrivateMessageAsRead"] = 54] = "MarkPrivateMessageAsRead";
-    UserOperation[UserOperation["GetPrivateMessages"] = 55] = "GetPrivateMessages";
-    UserOperation[UserOperation["UserJoin"] = 56] = "UserJoin";
-    UserOperation[UserOperation["GetComments"] = 57] = "GetComments";
-    UserOperation[UserOperation["GetSiteConfig"] = 58] = "GetSiteConfig";
-    UserOperation[UserOperation["SaveSiteConfig"] = 59] = "SaveSiteConfig";
-    UserOperation[UserOperation["PostJoin"] = 60] = "PostJoin";
-    UserOperation[UserOperation["CommunityJoin"] = 61] = "CommunityJoin";
-    UserOperation[UserOperation["ChangePassword"] = 62] = "ChangePassword";
-    UserOperation[UserOperation["GetSiteMetadata"] = 63] = "GetSiteMetadata";
-    UserOperation[UserOperation["BlockCommunity"] = 64] = "BlockCommunity";
-    UserOperation[UserOperation["BlockPerson"] = 65] = "BlockPerson";
-    UserOperation[UserOperation["CreateCommentReport"] = 66] = "CreateCommentReport";
-    UserOperation[UserOperation["ResolveCommentReport"] = 67] = "ResolveCommentReport";
-    UserOperation[UserOperation["ListCommentReports"] = 68] = "ListCommentReports";
-    UserOperation[UserOperation["CreatePostReport"] = 69] = "CreatePostReport";
-    UserOperation[UserOperation["ResolvePostReport"] = 70] = "ResolvePostReport";
-    UserOperation[UserOperation["ListPostReports"] = 71] = "ListPostReports";
-    UserOperation[UserOperation["GetReportCount"] = 72] = "GetReportCount";
-    UserOperation[UserOperation["GetUnreadCount"] = 73] = "GetUnreadCount";
-    UserOperation[UserOperation["VerifyEmail"] = 74] = "VerifyEmail";
+    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["TransferSite"] = 48] = "TransferSite";
+    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 = exports.UserOperation || (exports.UserOperation = {}));
 /**
  * Different sort types used in lemmy.

package/dist/websocket.d.ts

@@ -1,6 +1,6 @@
 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, GetPersonDetails, GetPersonMentions, GetPrivateMessages, GetReplies, GetReportCount, GetUnreadCount, Login, MarkAllAsRead, MarkPersonMentionAsRead, MarkPrivateMessageAsRead, PasswordChange, PasswordReset, Register, SaveUserSettings, VerifyEmail } from "./interfaces/api/person";
+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 { ApproveRegistrationApplication, CreateSite, EditSite, GetModlog, GetSite, GetSiteConfig, GetUnreadRegistrationApplicationCount, ListRegistrationApplications, ResolveObject, SaveSiteConfig, Search, TransferSite } from "./interfaces/api/site";
 import { CommunityJoin, PostJoin, UserJoin } from "./interfaces/api/websocket";
@@ -193,6 +193,10 @@ export declare class LemmyWebsocket {
      * Ban a person from your site.
      */
     banPerson(form: BanPerson): string;
+    /**
+     * Get a list of banned users
+     */
+    getBannedPersons(form: GetBannedPersons): string;
     /**
      * Add an admin to your site.
      */

package/dist/websocket.js

@@ -278,6 +278,12 @@ var LemmyWebsocket = /** @class */ (function () {
     LemmyWebsocket.prototype.banPerson = function (form) {
         return wrapper(others_1.UserOperation.BanPerson, form);
     };
+    /**
+     * Get a list of banned users
+     */
+    LemmyWebsocket.prototype.getBannedPersons = function (form) {
+        return wrapper(others_1.UserOperation.GetBannedPersons, form);
+    };
     /**
      * Add an admin to your site.
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.15.0-rc.2",
+  "version": "0.15.0-rc.8",
   "author": "Dessalines <tyhou13@gmx.com>",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",