lemmy-js-client 0.17.0-rc.3 → 0.17.0-rc.30

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

@@ -1,3 +1,4 @@
+import { Option } from "@sniptt/monads";
 export declare const VERSION = "v3";
 /**
  * All of the websocket operations available.
@@ -25,60 +26,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.
@@ -142,45 +144,13 @@ export declare enum SearchType {
     Users = "Users",
     Url = "Url"
 }
-/**
- * A websocket response. Includes the return type.
- * Can be used like:
- *
- * ```ts
- * if (op == UserOperation.Search) {
- *   let data = wsJsonToRes<SearchResponse>(msg).data;
- * }
- * ```
- */
-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;
-}
-/**
- * A websocket JSON response that includes the errors.
- */
-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;
-}
 /**
  * A holder for a site's metadata ( such as opengraph tags ), used for post links.
  */
-export interface SiteMetadata {
-    title?: string;
-    description?: string;
-    image?: string;
-    html?: string;
+export declare class SiteMetadata {
+    title: Option<string>;
+    description: Option<string>;
+    image: Option<string>;
+    html: Option<string>;
+    constructor(init: SiteMetadata);
 }

package/dist/interfaces/others.js

@@ -1,6 +1,14 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchType = exports.ListingType = exports.SortType = exports.UserOperation = exports.VERSION = void 0;
+exports.SiteMetadata = exports.SearchType = exports.ListingType = exports.SortType = exports.UserOperation = exports.VERSION = void 0;
+var class_transformer_1 = require("class-transformer");
+var utils_1 = require("../utils");
 exports.VERSION = "v3";
 /**
  * All of the websocket operations available.
@@ -29,60 +37,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.
@@ -149,3 +158,57 @@ var SearchType;
     SearchType["Users"] = "Users";
     SearchType["Url"] = "Url";
 })(SearchType = exports.SearchType || (exports.SearchType = {}));
+/**
+ * A holder for a site's metadata ( such as opengraph tags ), used for post links.
+ */
+var SiteMetadata = /** @class */ (function () {
+    function SiteMetadata(init) {
+        Object.assign(this, init);
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toOption)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], SiteMetadata.prototype, "title", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toOption)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], SiteMetadata.prototype, "description", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toOption)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], SiteMetadata.prototype, "image", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toOption)(value);
+        }, { toClassOnly: true }),
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, utils_1.toUndefined)(value);
+        }, { toPlainOnly: true }),
+        (0, class_transformer_1.Expose)()
+    ], SiteMetadata.prototype, "html", void 0);
+    return SiteMetadata;
+}());
+exports.SiteMetadata = SiteMetadata;