lemmy-js-client 0.17.0-rc.6 → 0.17.0-rc.61

package/dist/interfaces/source.d.ts

@@ -1,4 +1,3 @@
-import { Option } from "@sniptt/monads";
 export interface LocalUserSettings {
     id: number;
     person_id: number;
@@ -7,9 +6,10 @@ export interface LocalUserSettings {
     theme: string;
     default_sort_type: number;
     default_listing_type: number;
-    lang: string;
+    interface_language: string;
     show_avatars: boolean;
     send_notifications_to_email: boolean;
+    validator_time: string;
     show_bot_accounts: boolean;
     show_scores: boolean;
     show_read_posts: boolean;
@@ -31,34 +31,77 @@ export interface PersonSafe {
     banner?: string;
     deleted: boolean;
     inbox_url: string;
-    shared_inbox_url: string;
+    shared_inbox_url?: string;
     matrix_user_id?: string;
     admin: boolean;
     bot_account: boolean;
     ban_expires?: string;
+    instance_id: number;
 }
 export interface Site {
     id: number;
     name: string;
-    sidebar: Option<string>;
+    sidebar?: string;
     published: string;
     updated?: string;
-    enable_downvotes: boolean;
-    open_registration: boolean;
-    enable_nsfw: boolean;
     icon?: string;
-    banner: Option<string>;
+    banner?: string;
     description?: string;
+    actor_id: string;
+    last_refreshed_at: string;
+    inbox_url: string;
+    private_key?: string;
+    public_key: string;
+    instance_id: number;
+}
+export declare enum RegistrationMode {
+    Closed = "closed",
+    RequireApplication = "require_application",
+    Open = "open"
+}
+export interface LocalSite {
+    id: number;
+    site_id: number;
+    site_setup: boolean;
+    enable_downvotes: boolean;
+    registration_mode: RegistrationMode;
+    enable_nsfw: boolean;
     community_creation_admin_only: boolean;
     require_email_verification: boolean;
-    require_application: boolean;
     application_question?: string;
     private_instance: boolean;
     default_theme: string;
-    actor_id: string;
-    last_refreshed_at: string;
-    inbox_url: string;
-    public_key: string;
+    default_post_listing_type: string;
+    legal_information?: string;
+    hide_modlog_mod_names: boolean;
+    application_email_admins: boolean;
+    slur_filter_regex?: string;
+    actor_name_max_length: number;
+    federation_enabled: boolean;
+    federation_debug: boolean;
+    federation_worker_count: number;
+    captcha_enabled: boolean;
+    captcha_difficulty: string;
+    published: string;
+    updated?: string;
+}
+export interface LocalSiteRateLimit {
+    id: number;
+    local_site_id: number;
+    message: number;
+    message_per_second: number;
+    post: number;
+    post_per_second: number;
+    register: number;
+    register_per_second: number;
+    image: number;
+    image_per_second: number;
+    comment: number;
+    comment_per_second: number;
+    search: number;
+    search_per_second: number;
+    published: string;
+    updated?: string;
 }
 export interface PrivateMessage {
     id: number;
@@ -98,13 +141,15 @@ export interface Post {
     updated?: string;
     deleted: boolean;
     nsfw: boolean;
-    stickied: boolean;
     embed_title?: string;
     embed_description?: string;
-    embed_html?: string;
+    embed_video_url?: string;
     thumbnail_url?: string;
     ap_id: string;
     local: boolean;
+    language_id: number;
+    featured_community: boolean;
+    featured_local: boolean;
 }
 export interface PasswordResetRequest {
     id: number;
@@ -127,11 +172,12 @@ export interface ModLockPost {
     locked?: boolean;
     when_: string;
 }
-export interface ModStickyPost {
+export interface ModFeaturePost {
     id: number;
     mod_person_id: number;
     post_id: number;
-    stickied?: boolean;
+    featured: boolean;
+    is_featured_community: boolean;
     when_: string;
 }
 export interface ModRemoveComment {
@@ -193,6 +239,32 @@ export interface ModAdd {
     removed?: boolean;
     when_: string;
 }
+export interface AdminPurgePerson {
+    id: number;
+    admin_person_id: number;
+    reason?: string;
+    when_: string;
+}
+export interface AdminPurgeCommunity {
+    id: number;
+    admin_person_id: number;
+    reason?: string;
+    when_: string;
+}
+export interface AdminPurgePost {
+    id: number;
+    admin_person_id: number;
+    community_id: number;
+    reason?: string;
+    when_: string;
+}
+export interface AdminPurgeComment {
+    id: number;
+    admin_person_id: number;
+    post_id: number;
+    reason?: string;
+    when_: string;
+}
 export interface CommunitySafe {
     id: number;
     name: string;
@@ -207,7 +279,9 @@ export interface CommunitySafe {
     local: boolean;
     icon?: string;
     banner?: string;
+    hidden: boolean;
     posting_restricted_to_mods: boolean;
+    instance_id: number;
 }
 export interface CommentReport {
     id: number;
@@ -224,15 +298,16 @@ export interface Comment {
     id: number;
     creator_id: number;
     post_id: number;
-    parent_id?: number;
     content: string;
     removed: boolean;
-    read: boolean;
     published: string;
     updated?: string;
     deleted: boolean;
     ap_id: string;
     local: boolean;
+    path: string;
+    distinguished: boolean;
+    language_id: number;
 }
 export interface PersonMention {
     id: number;
@@ -241,6 +316,13 @@ export interface PersonMention {
     read: boolean;
     published: string;
 }
+export interface CommentReply {
+    id: number;
+    recipient_id: number;
+    comment_id: number;
+    read: boolean;
+    published: string;
+}
 export interface RegistrationApplication {
     id: number;
     local_user_id: number;
@@ -249,3 +331,26 @@ export interface RegistrationApplication {
     deny_reason?: string;
     published: string;
 }
+export interface Language {
+    id: number;
+    code: string;
+    name: string;
+}
+export interface PrivateMessageReport {
+    id: number;
+    creator_id: number;
+    private_message_id: number;
+    original_pm_text: string;
+    reason: string;
+    resolved: boolean;
+    resolver_id?: number;
+    published: string;
+    updated?: string;
+}
+export interface Tagline {
+    id: number;
+    local_site_id: number;
+    content: string;
+    published: string;
+    updated?: string;
+}

package/dist/interfaces/source.js

@@ -1,2 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegistrationMode = void 0;
+var RegistrationMode;
+(function (RegistrationMode) {
+    RegistrationMode["Closed"] = "closed";
+    RegistrationMode["RequireApplication"] = "require_application";
+    RegistrationMode["Open"] = "open";
+})(RegistrationMode = exports.RegistrationMode || (exports.RegistrationMode = {}));

package/dist/interfaces/views.d.ts

@@ -1,5 +1,6 @@
 import { CommentAggregates, CommunityAggregates, PersonAggregates, PostAggregates, SiteAggregates } from "./aggregates";
-import { Comment, CommentReport, CommunitySafe, LocalUserSettings, ModAdd, ModAddCommunity, ModBan, ModBanFromCommunity, ModLockPost, ModRemoveComment, ModRemoveCommunity, ModRemovePost, ModStickyPost, ModTransferCommunity, PersonMention, PersonSafe, Post, PostReport, PrivateMessage, RegistrationApplication, Site } from "./source";
+import { SubscribedType } from "./others";
+import { AdminPurgeComment, AdminPurgeCommunity, AdminPurgePerson, AdminPurgePost, Comment, CommentReply, CommentReport, CommunitySafe, LocalSite, LocalSiteRateLimit, LocalUserSettings, ModAdd, ModAddCommunity, ModBan, ModBanFromCommunity, ModFeaturePost, ModLockPost, ModRemoveComment, ModRemoveCommunity, ModRemovePost, ModTransferCommunity, PersonMention, PersonSafe, Post, PostReport, PrivateMessage, PrivateMessageReport, RegistrationApplication, Site, Tagline } from "./source";
 export interface PersonViewSafe {
     person: PersonSafe;
     counts: PersonAggregates;
@@ -13,7 +14,7 @@ export interface PersonMentionView {
     recipient: PersonSafe;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
-    subscribed: boolean;
+    subscribed: SubscribedType;
     saved: boolean;
     creator_blocked: boolean;
     my_vote?: number;
@@ -25,6 +26,9 @@ export interface LocalUserSettingsView {
 }
 export interface SiteView {
     site: Site;
+    local_site: LocalSite;
+    local_site_rate_limit: LocalSiteRateLimit;
+    taglines?: Tagline[];
     counts: SiteAggregates;
 }
 export interface PrivateMessageView {
@@ -38,11 +42,12 @@ export interface PostView {
     community: CommunitySafe;
     creator_banned_from_community: boolean;
     counts: PostAggregates;
-    subscribed: boolean;
+    subscribed: SubscribedType;
     saved: boolean;
     read: boolean;
     creator_blocked: boolean;
     my_vote?: number;
+    unread_comments: number;
 }
 export interface PostReportView {
     post_report: PostReport;
@@ -58,12 +63,25 @@ export interface PostReportView {
 export interface CommentView {
     comment: Comment;
     creator: PersonSafe;
-    recipient?: PersonSafe;
     post: Post;
     community: CommunitySafe;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
-    subscribed: boolean;
+    subscribed: SubscribedType;
+    saved: boolean;
+    creator_blocked: boolean;
+    my_vote?: number;
+}
+export interface CommentReplyView {
+    comment_reply: CommentReply;
+    comment: Comment;
+    creator: PersonSafe;
+    post: Post;
+    community: CommunitySafe;
+    recipient: PersonSafe;
+    counts: CommentAggregates;
+    creator_banned_from_community: boolean;
+    subscribed: SubscribedType;
     saved: boolean;
     creator_blocked: boolean;
     my_vote?: number;
@@ -82,41 +100,41 @@ export interface CommentReportView {
 }
 export interface ModAddCommunityView {
     mod_add_community: ModAddCommunity;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     community: CommunitySafe;
     modded_person: PersonSafe;
 }
 export interface ModTransferCommunityView {
     mod_transfer_community: ModTransferCommunity;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     community: CommunitySafe;
     modded_person: PersonSafe;
 }
 export interface ModAddView {
     mod_add: ModAdd;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     modded_person: PersonSafe;
 }
 export interface ModBanFromCommunityView {
     mod_ban_from_community: ModBanFromCommunity;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     community: CommunitySafe;
     banned_person: PersonSafe;
 }
 export interface ModBanView {
     mod_ban: ModBan;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     banned_person: PersonSafe;
 }
 export interface ModLockPostView {
     mod_lock_post: ModLockPost;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     post: Post;
     community: CommunitySafe;
 }
 export interface ModRemoveCommentView {
     mod_remove_comment: ModRemoveComment;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     comment: Comment;
     commenter: PersonSafe;
     post: Post;
@@ -124,21 +142,39 @@ export interface ModRemoveCommentView {
 }
 export interface ModRemoveCommunityView {
     mod_remove_community: ModRemoveCommunity;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     community: CommunitySafe;
 }
 export interface ModRemovePostView {
     mod_remove_post: ModRemovePost;
-    moderator: PersonSafe;
+    moderator?: PersonSafe;
     post: Post;
     community: CommunitySafe;
 }
-export interface ModStickyPostView {
-    mod_sticky_post: ModStickyPost;
-    moderator: PersonSafe;
+export interface ModFeaturePostView {
+    mod_feature_post: ModFeaturePost;
+    moderator?: PersonSafe;
     post: Post;
     community: CommunitySafe;
 }
+export interface AdminPurgeCommunityView {
+    admin_purge_community: AdminPurgeCommunity;
+    admin?: PersonSafe;
+}
+export interface AdminPurgePersonView {
+    admin_purge_person: AdminPurgePerson;
+    admin?: PersonSafe;
+}
+export interface AdminPurgePostView {
+    admin_purge_post: AdminPurgePost;
+    admin?: PersonSafe;
+    community: CommunitySafe;
+}
+export interface AdminPurgeCommentView {
+    admin_purge_comment: AdminPurgeComment;
+    admin?: PersonSafe;
+    post: Post;
+}
 export interface CommunityFollowerView {
     community: CommunitySafe;
     follower: PersonSafe;
@@ -161,7 +197,7 @@ export interface PersonBlockView {
 }
 export interface CommunityView {
     community: CommunitySafe;
-    subscribed: boolean;
+    subscribed: SubscribedType;
     blocked: boolean;
     counts: CommunityAggregates;
 }
@@ -171,3 +207,15 @@ export interface RegistrationApplicationView {
     creator: PersonSafe;
     admin?: PersonSafe;
 }
+export interface CommentNode {
+    comment_view: CommentView | PersonMentionView | CommentReplyView;
+    children: CommentNode[];
+    depth: number;
+}
+export interface PrivateMessageReportView {
+    private_message_report: PrivateMessageReport;
+    private_message: PrivateMessage;
+    private_message_creator: PersonSafe;
+    creator: PersonSafe;
+    resolver?: PersonSafe;
+}

package/dist/websocket.d.ts

@@ -1,9 +1,10 @@
-import { CreateComment, CreateCommentLike, CreateCommentReport, DeleteComment, EditComment, GetComments, ListCommentReports, MarkCommentAsRead, RemoveComment, ResolveCommentReport, SaveComment } from "./interfaces/api/comment";
+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, 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, LeaveAdmin, ListRegistrationApplications, ResolveObject, SaveSiteConfig, Search } from "./interfaces/api/site";
+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";
 /**
  * Helps build lemmy websocket message requests, that you can use in your Websocket sends.
  *
@@ -100,7 +101,7 @@ export declare class LemmyWebsocket {
     /**
      * Mark a comment as read.
      */
-    markCommentAsRead(form: MarkCommentAsRead): string;
+    markCommentReplyAsRead(form: MarkCommentReplyAsRead): string;
     /**
      * Like / vote on a comment.
      */
@@ -150,9 +151,13 @@ export declare class LemmyWebsocket {
      */
     lockPost(form: LockPost): string;
     /**
-     * A moderator can sticky a post ( IE stick it to the top of a community ).
+     * A moderator can feature a post ( IE stick it to the top of a community ).
      */
-    stickyPost(form: StickyPost): string;
+    featurePost(form: FeaturePost): string;
+    /**
+     * Mark a post as read.
+     */
+    markPostAsRead(form: MarkPostAsRead): string;
     /**
      * Save a post.
      */
@@ -244,11 +249,7 @@ export declare class LemmyWebsocket {
     /**
      * Gets the site, and your user data.
      */
-    getSite(form?: GetSite): string;
-    /**
-     * Get your site configuration.
-     */
-    getSiteConfig(form: GetSiteConfig): string;
+    getSite(form: GetSite): string;
     /**
      * Search lemmy.
      */
@@ -314,9 +315,17 @@ export declare class LemmyWebsocket {
      */
     getPrivateMessages(form: GetPrivateMessages): string;
     /**
-     * Save your site config.
+     * Create a report for a private message.
      */
-    saveSiteConfig(form: SaveSiteConfig): string;
+    createPrivateMessageReport(form: CreatePrivateMessageReport): string;
+    /**
+     * Resolve a report for a private message.
+     */
+    resolvePrivateMessageReport(form: ResolvePrivateMessageReport): string;
+    /**
+     * List private message reports.
+     */
+    listPrivateMessageReports(form: ListPrivateMessageReports): string;
     /**
      * Block a person.
      */
@@ -325,4 +334,25 @@ export declare class LemmyWebsocket {
      * Block a community.
      */
     blockCommunity(form: BlockCommunity): string;
+    /**
+     * Purge / Delete a person from the database.
+     */
+    purgePerson(form: PurgePerson): string;
+    /**
+     * Purge / Delete a community from the database.
+     */
+    purgeCommunity(form: PurgeCommunity): string;
+    /**
+     * Purge / Delete a post from the database.
+     */
+    purgePost(form: PurgePost): string;
+    /**
+     * Purge / Delete a comment from the database.
+     */
+    purgeComment(form: PurgeComment): string;
 }
+export declare function wsUserOp(msg: any): UserOperation;
+/**
+ * Converts a websocket string response to a usable result
+ */
+export declare function wsJsonToRes<ResponseType>(msg: any): ResponseType;

package/dist/websocket.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LemmyWebsocket = void 0;
+exports.wsJsonToRes = exports.wsUserOp = exports.LemmyWebsocket = void 0;
 var others_1 = require("./interfaces/others");
 /**
  * Helps build lemmy websocket message requests, that you can use in your Websocket sends.
@@ -137,8 +137,8 @@ var LemmyWebsocket = /** @class */ (function () {
     /**
      * Mark a comment as read.
      */
-    LemmyWebsocket.prototype.markCommentAsRead = function (form) {
-        return wrapper(others_1.UserOperation.MarkCommentAsRead, form);
+    LemmyWebsocket.prototype.markCommentReplyAsRead = function (form) {
+        return wrapper(others_1.UserOperation.MarkCommentReplyAsRead, form);
     };
     /**
      * Like / vote on a comment.
@@ -213,10 +213,16 @@ var LemmyWebsocket = /** @class */ (function () {
         return wrapper(others_1.UserOperation.LockPost, form);
     };
     /**
-     * A moderator can sticky a post ( IE stick it to the top of a community ).
+     * A moderator can feature a post ( IE stick it to the top of a community ).
      */
-    LemmyWebsocket.prototype.stickyPost = function (form) {
-        return wrapper(others_1.UserOperation.StickyPost, form);
+    LemmyWebsocket.prototype.featurePost = function (form) {
+        return wrapper(others_1.UserOperation.FeaturePost, form);
+    };
+    /**
+     * Mark a post as read.
+     */
+    LemmyWebsocket.prototype.markPostAsRead = function (form) {
+        return wrapper(others_1.UserOperation.MarkPostAsRead, form);
     };
     /**
      * Save a post.
@@ -354,15 +360,8 @@ var LemmyWebsocket = /** @class */ (function () {
      * Gets the site, and your user data.
      */
     LemmyWebsocket.prototype.getSite = function (form) {
-        if (form === void 0) { form = {}; }
         return wrapper(others_1.UserOperation.GetSite, form);
     };
-    /**
-     * Get your site configuration.
-     */
-    LemmyWebsocket.prototype.getSiteConfig = function (form) {
-        return wrapper(others_1.UserOperation.GetSiteConfig, form);
-    };
     /**
      * Search lemmy.
      */
@@ -460,10 +459,22 @@ var LemmyWebsocket = /** @class */ (function () {
         return wrapper(others_1.UserOperation.GetPrivateMessages, form);
     };
     /**
-     * Save your site config.
+     * Create a report for a private message.
+     */
+    LemmyWebsocket.prototype.createPrivateMessageReport = function (form) {
+        return wrapper(others_1.UserOperation.CreatePrivateMessageReport, form);
+    };
+    /**
+     * Resolve a report for a private message.
      */
-    LemmyWebsocket.prototype.saveSiteConfig = function (form) {
-        return wrapper(others_1.UserOperation.SaveSiteConfig, form);
+    LemmyWebsocket.prototype.resolvePrivateMessageReport = function (form) {
+        return wrapper(others_1.UserOperation.ResolvePrivateMessageReport, form);
+    };
+    /**
+     * List private message reports.
+     */
+    LemmyWebsocket.prototype.listPrivateMessageReports = function (form) {
+        return wrapper(others_1.UserOperation.ListPrivateMessageReports, form);
     };
     /**
      * Block a person.
@@ -477,11 +488,48 @@ var LemmyWebsocket = /** @class */ (function () {
     LemmyWebsocket.prototype.blockCommunity = function (form) {
         return wrapper(others_1.UserOperation.BlockCommunity, form);
     };
+    /**
+     * Purge / Delete a person from the database.
+     */
+    LemmyWebsocket.prototype.purgePerson = function (form) {
+        return wrapper(others_1.UserOperation.PurgePerson, form);
+    };
+    /**
+     * Purge / Delete a community from the database.
+     */
+    LemmyWebsocket.prototype.purgeCommunity = function (form) {
+        return wrapper(others_1.UserOperation.PurgeCommunity, form);
+    };
+    /**
+     * Purge / Delete a post from the database.
+     */
+    LemmyWebsocket.prototype.purgePost = function (form) {
+        return wrapper(others_1.UserOperation.PurgePost, form);
+    };
+    /**
+     * Purge / Delete a comment from the database.
+     */
+    LemmyWebsocket.prototype.purgeComment = function (form) {
+        return wrapper(others_1.UserOperation.PurgeComment, form);
+    };
     return LemmyWebsocket;
 }());
 exports.LemmyWebsocket = LemmyWebsocket;
 function wrapper(op, data) {
-    var send = { op: others_1.UserOperation[op], data: data };
-    console.log(send);
-    return JSON.stringify(send);
+    var send = JSON.stringify({ op: others_1.UserOperation[op], data: data });
+    return send;
+}
+function wsUserOp(msg) {
+    var opStr = msg.op;
+    return others_1.UserOperation[opStr];
+}
+exports.wsUserOp = wsUserOp;
+/**
+ * Converts a websocket string response to a usable result
+ */
+// TODO is this still necessary?
+function wsJsonToRes(msg) {
+    // Have to deserialize the response again into the correct class
+    return msg.data;
 }
+exports.wsJsonToRes = wsJsonToRes;