lemmy-js-client 0.17.2-rc.6 → 0.17.2-rc.7

package/dist/types/others.d.ts

@@ -0,0 +1,113 @@
+/// <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
+}
+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/{interfaces → types}/others.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PostFeatureType = exports.SubscribedType = exports.ModlogActionType = exports.SearchType = exports.RegistrationMode = exports.ListingType = exports.CommentSortType = exports.SortType = exports.UserOperation = exports.VERSION = void 0;
+exports.UserOperation = exports.VERSION = void 0;
 exports.VERSION = "v3";
 /**
  * All of the websocket operations available.
@@ -59,7 +59,7 @@ var UserOperation;
     UserOperation[UserOperation["LeaveAdmin"] = 49] = "LeaveAdmin";
     UserOperation[UserOperation["DeleteAccount"] = 50] = "DeleteAccount";
     UserOperation[UserOperation["PasswordReset"] = 51] = "PasswordReset";
-    UserOperation[UserOperation["PasswordChange"] = 52] = "PasswordChange";
+    UserOperation[UserOperation["PasswordChangeAfterReset"] = 52] = "PasswordChangeAfterReset";
     UserOperation[UserOperation["CreatePrivateMessage"] = 53] = "CreatePrivateMessage";
     UserOperation[UserOperation["EditPrivateMessage"] = 54] = "EditPrivateMessage";
     UserOperation[UserOperation["DeletePrivateMessage"] = 55] = "DeletePrivateMessage";
@@ -94,146 +94,3 @@ var UserOperation;
     UserOperation[UserOperation["EditCustomEmoji"] = 84] = "EditCustomEmoji";
     UserOperation[UserOperation["DeleteCustomEmoji"] = 85] = "DeleteCustomEmoji";
 })(UserOperation = exports.UserOperation || (exports.UserOperation = {}));
-/**
- * Different post sort types used in lemmy.
- */
-var SortType;
-(function (SortType) {
-    /**
-     * Posts sorted by hot, but bumped by new comments up to 2 days
-     */
-    SortType["Active"] = "Active";
-    /**
-     * 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.
-     */
-    SortType["TopDay"] = "TopDay";
-    /**
-     * The top posts for this last week.
-     */
-    SortType["TopWeek"] = "TopWeek";
-    /**
-     * The top posts for this last month.
-     */
-    SortType["TopMonth"] = "TopMonth";
-    /**
-     * The top posts for this last year.
-     */
-    SortType["TopYear"] = "TopYear";
-    /**
-     * The top posts of all time.
-     */
-    SortType["TopAll"] = "TopAll";
-    /**
-     * Posts sorted by the most comments.
-     */
-    SortType["MostComments"] = "MostComments";
-    /**
-     * Posts sorted by the newest comments, with no necrobumping. IE a forum sort.
-     */
-    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.
- */
-var ListingType;
-(function (ListingType) {
-    // TODO do these need to be strings?
-    ListingType["All"] = "All";
-    ListingType["Local"] = "Local";
-    ListingType["Subscribed"] = "Subscribed";
-    ListingType["Community"] = "Community";
-})(ListingType = exports.ListingType || (exports.ListingType = {}));
-/**
- * The different types of registration modes
- */
-var RegistrationMode;
-(function (RegistrationMode) {
-    RegistrationMode["Closed"] = "Closed";
-    RegistrationMode["RequireApplication"] = "RequireApplication";
-    RegistrationMode["Open"] = "Open";
-})(RegistrationMode = exports.RegistrationMode || (exports.RegistrationMode = {}));
-/**
- * Search types for lemmy's search.
- */
-var SearchType;
-(function (SearchType) {
-    SearchType["All"] = "All";
-    SearchType["Comments"] = "Comments";
-    SearchType["Posts"] = "Posts";
-    SearchType["Communities"] = "Communities";
-    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 = {}));

package/dist/websocket.d.ts

@@ -1,11 +1,89 @@
-import { CreateComment, CreateCommentLike, CreateCommentReport, DeleteComment, EditComment, GetComment, 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 { CreateCustomEmoji, DeleteCustomEmoji, EditCustomEmoji } from "./interfaces/api/custom_emoji";
-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 { GetComment } from "./types/GetComment";
+import { GetComments } from "./types/GetComments";
+import { GetCommunity } from "./types/GetCommunity";
+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.
  *
@@ -298,7 +376,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.
      */

package/dist/websocket.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.wsJsonToRes = exports.wsUserOp = exports.LemmyWebsocket = void 0;
-var others_1 = require("./interfaces/others");
+var others_1 = require("./types/others");
 /**
  * Helps build lemmy websocket message requests, that you can use in your Websocket sends.
  *
@@ -432,7 +432,7 @@ var LemmyWebsocket = /** @class */ (function () {
      * Change your password from an email / token based reset.
      */
     LemmyWebsocket.prototype.passwordChange = function (form) {
-        return wrapper(others_1.UserOperation.PasswordChange, form);
+        return wrapper(others_1.UserOperation.PasswordChangeAfterReset, form);
     };
     /**
      * Create a private message.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lemmy-js-client",
-  "version": "0.17.2-rc.6",
+  "version": "0.17.2-rc.7",
   "description": "A javascript / typescript client for Lemmy",
   "repository": "https://github.com/LemmyNet/lemmy-js-client",
   "license": "AGPL-3.0",

package/dist/interfaces/aggregates.d.ts

@@ -1,93 +0,0 @@
-/**
- * Aggregate data for a person.
- */
-export interface PersonAggregates {
-    id: number;
-    person_id: number;
-    post_count: number;
-    post_score: number;
-    comment_count: number;
-    comment_score: number;
-}
-/**
- * Aggregate data for your site.
- */
-export interface SiteAggregates {
-    id: number;
-    site_id: number;
-    users: number;
-    posts: number;
-    comments: number;
-    communities: number;
-    /**
-     * Active users per day.
-     */
-    users_active_day: number;
-    /**
-     * Active users per week.
-     */
-    users_active_week: number;
-    /**
-     * Active users per month.
-     */
-    users_active_month: number;
-    /**
-     * Active users per year.
-     */
-    users_active_half_year: number;
-}
-/**
- * Aggregate data for your post.
- */
-export interface PostAggregates {
-    id: number;
-    post_id: number;
-    comments: number;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    /**
-     * Newest comment time, limited to 2 days, to prevent necrobumping.
-     */
-    newest_comment_time_necro: string;
-    newest_comment_time: string;
-    featured_community: boolean;
-    featured_local: boolean;
-}
-/**
- * Aggregate data for your community.
- */
-export interface CommunityAggregates {
-    id: number;
-    community_id: number;
-    subscribers: number;
-    posts: number;
-    comments: number;
-    /**
-     * Active users per day.
-     */
-    users_active_day: number;
-    /**
-     * Active users per week.
-     */
-    users_active_week: number;
-    /**
-     * Active users per month.
-     */
-    users_active_month: number;
-    /**
-     * Active users per year.
-     */
-    users_active_half_year: number;
-}
-/**
- * Aggregate data for your comment.
- */
-export interface CommentAggregates {
-    id: number;
-    comment_id: number;
-    score: number;
-    upvotes: number;
-    downvotes: number;
-    child_count: number;
-}

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

@@ -1,120 +0,0 @@
-import { CommentSortType, ListingType } from "../others";
-import { CommentReportView, CommentView } from "../views";
-export interface CreateComment {
-    content: string;
-    parent_id?: number;
-    language_id?: number;
-    post_id: number;
-    /**
-     * An optional front end ID, to tell which is comment is coming back.
-     */
-    form_id?: string;
-    auth: string;
-}
-export interface EditComment {
-    comment_id: number;
-    content?: string;
-    /**
-     * "Distinguishes" a comment, or speak officially. Only doable by community mods or admins.
-     */
-    distinguished?: boolean;
-    language_id?: number;
-    /**
-     * An optional front end ID, to tell which is comment is coming back.
-     */
-    form_id?: string;
-    auth: string;
-}
-/**
- * Only the creator can delete the comment.
- */
-export interface DeleteComment {
-    comment_id: number;
-    deleted: boolean;
-    auth: string;
-}
-/**
- * Only a mod or admin can remove the comment.
- */
-export interface RemoveComment {
-    comment_id: number;
-    removed: boolean;
-    reason?: string;
-    auth: string;
-}
-export interface SaveComment {
-    comment_id: number;
-    save: boolean;
-    auth: string;
-}
-export interface CommentResponse {
-    comment_view: CommentView;
-    recipient_ids: number[];
-    /**
-     * An optional front end ID, to tell which is comment is coming back.
-     */
-    form_id?: string;
-}
-export interface CreateCommentLike {
-    comment_id: number;
-    score: number;
-    auth: string;
-}
-/**
- * Comment listing types are `All, Subscribed, Community`
- *
- * You can use either `community_id` or `community_name` as an id.
- * To get posts for a federated community by name, use `name@instance.tld` .
- */
-export interface GetComments {
-    type_?: ListingType;
-    sort?: CommentSortType;
-    max_depth?: number;
-    page?: number;
-    limit?: number;
-    community_id?: number;
-    community_name?: string;
-    post_id?: number;
-    parent_id?: number;
-    saved_only?: boolean;
-    auth?: string;
-}
-export interface GetCommentsResponse {
-    comments: CommentView[];
-}
-export interface GetComment {
-    id: number;
-    auth?: string;
-}
-export interface CreateCommentReport {
-    comment_id: number;
-    reason: string;
-    auth: string;
-}
-export interface CommentReportResponse {
-    comment_report_view: CommentReportView;
-}
-export interface ResolveCommentReport {
-    report_id: number;
-    /**
-     * Either resolve or unresolve a report.
-     */
-    resolved: boolean;
-    auth: string;
-}
-export interface ListCommentReports {
-    page?: number;
-    limit?: number;
-    /**
-     * if no community is given, it returns reports for all communities moderated by the auth user.
-     */
-    community_id?: number;
-    /**
-     * Only shows the unresolved reports.
-     */
-    unresolved_only?: boolean;
-    auth: string;
-}
-export interface ListCommentReportsResponse {
-    comment_reports: CommentReportView[];
-}