lemmy-js-client 0.17.0-rc.13 → 0.17.0-rc.16

package/dist/interfaces/views.d.ts

@@ -1,10 +1,11 @@
+import { Option } from "@sniptt/monads";
 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";
-export interface PersonViewSafe {
+export declare class PersonViewSafe {
     person: PersonSafe;
     counts: PersonAggregates;
 }
-export interface PersonMentionView {
+export declare class PersonMentionView {
     person_mention: PersonMention;
     comment: Comment;
     creator: PersonSafe;
@@ -16,23 +17,23 @@ export interface PersonMentionView {
     subscribed: boolean;
     saved: boolean;
     creator_blocked: boolean;
-    my_vote?: number;
+    my_vote: Option<number>;
 }
-export interface LocalUserSettingsView {
+export declare class LocalUserSettingsView {
     local_user: LocalUserSettings;
     person: PersonSafe;
     counts: PersonAggregates;
 }
-export interface SiteView {
+export declare class SiteView {
     site: Site;
     counts: SiteAggregates;
 }
-export interface PrivateMessageView {
+export declare class PrivateMessageView {
     private_message: PrivateMessage;
     creator: PersonSafe;
     recipient: PersonSafe;
 }
-export interface PostView {
+export declare class PostView {
     post: Post;
     creator: PersonSafe;
     community: CommunitySafe;
@@ -42,23 +43,23 @@ export interface PostView {
     saved: boolean;
     read: boolean;
     creator_blocked: boolean;
-    my_vote?: number;
+    my_vote: Option<number>;
 }
-export interface PostReportView {
+export declare class PostReportView {
     post_report: PostReport;
     post: Post;
     community: CommunitySafe;
     creator: PersonSafe;
     post_creator: PersonSafe;
     creator_banned_from_community: boolean;
-    my_vote?: number;
+    my_vote: Option<number>;
     counts: PostAggregates;
-    resolver?: PersonSafe;
+    resolver: Option<PersonSafe>;
 }
-export interface CommentView {
+export declare class CommentView {
     comment: Comment;
     creator: PersonSafe;
-    recipient?: PersonSafe;
+    recipient: Option<PersonSafe>;
     post: Post;
     community: CommunitySafe;
     counts: CommentAggregates;
@@ -66,9 +67,9 @@ export interface CommentView {
     subscribed: boolean;
     saved: boolean;
     creator_blocked: boolean;
-    my_vote?: number;
+    my_vote: Option<number>;
 }
-export interface CommentReportView {
+export declare class CommentReportView {
     comment_report: CommentReport;
     comment: Comment;
     post: Post;
@@ -77,44 +78,44 @@ export interface CommentReportView {
     comment_creator: PersonSafe;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
-    my_vote?: number;
-    resolver?: PersonSafe;
+    my_vote: Option<number>;
+    resolver: Option<PersonSafe>;
 }
-export interface ModAddCommunityView {
+export declare class ModAddCommunityView {
     mod_add_community: ModAddCommunity;
     moderator: PersonSafe;
     community: CommunitySafe;
     modded_person: PersonSafe;
 }
-export interface ModTransferCommunityView {
+export declare class ModTransferCommunityView {
     mod_transfer_community: ModTransferCommunity;
     moderator: PersonSafe;
     community: CommunitySafe;
     modded_person: PersonSafe;
 }
-export interface ModAddView {
+export declare class ModAddView {
     mod_add: ModAdd;
     moderator: PersonSafe;
     modded_person: PersonSafe;
 }
-export interface ModBanFromCommunityView {
+export declare class ModBanFromCommunityView {
     mod_ban_from_community: ModBanFromCommunity;
     moderator: PersonSafe;
     community: CommunitySafe;
     banned_person: PersonSafe;
 }
-export interface ModBanView {
+export declare class ModBanView {
     mod_ban: ModBan;
     moderator: PersonSafe;
     banned_person: PersonSafe;
 }
-export interface ModLockPostView {
+export declare class ModLockPostView {
     mod_lock_post: ModLockPost;
     moderator: PersonSafe;
     post: Post;
     community: CommunitySafe;
 }
-export interface ModRemoveCommentView {
+export declare class ModRemoveCommentView {
     mod_remove_comment: ModRemoveComment;
     moderator: PersonSafe;
     comment: Comment;
@@ -122,52 +123,52 @@ export interface ModRemoveCommentView {
     post: Post;
     community: CommunitySafe;
 }
-export interface ModRemoveCommunityView {
+export declare class ModRemoveCommunityView {
     mod_remove_community: ModRemoveCommunity;
     moderator: PersonSafe;
     community: CommunitySafe;
 }
-export interface ModRemovePostView {
+export declare class ModRemovePostView {
     mod_remove_post: ModRemovePost;
     moderator: PersonSafe;
     post: Post;
     community: CommunitySafe;
 }
-export interface ModStickyPostView {
+export declare class ModStickyPostView {
     mod_sticky_post: ModStickyPost;
     moderator: PersonSafe;
     post: Post;
     community: CommunitySafe;
 }
-export interface CommunityFollowerView {
+export declare class CommunityFollowerView {
     community: CommunitySafe;
     follower: PersonSafe;
 }
-export interface CommunityBlockView {
+export declare class CommunityBlockView {
     person: PersonSafe;
     community: CommunitySafe;
 }
-export interface CommunityModeratorView {
+export declare class CommunityModeratorView {
     community: CommunitySafe;
     moderator: PersonSafe;
 }
-export interface CommunityPersonBanView {
+export declare class CommunityPersonBanView {
     community: CommunitySafe;
     person: PersonSafe;
 }
-export interface PersonBlockView {
+export declare class PersonBlockView {
     person: PersonSafe;
     target: PersonSafe;
 }
-export interface CommunityView {
+export declare class CommunityView {
     community: CommunitySafe;
     subscribed: boolean;
     blocked: boolean;
     counts: CommunityAggregates;
 }
-export interface RegistrationApplicationView {
+export declare class RegistrationApplicationView {
     registration_application: RegistrationApplication;
     creator_local_user: LocalUserSettings;
     creator: PersonSafe;
-    admin?: PersonSafe;
+    admin: Option<PersonSafe>;
 }

package/dist/interfaces/views.js

@@ -1,2 +1,267 @@
 "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.RegistrationApplicationView = exports.CommunityView = exports.PersonBlockView = exports.CommunityPersonBanView = exports.CommunityModeratorView = exports.CommunityBlockView = exports.CommunityFollowerView = exports.ModStickyPostView = exports.ModRemovePostView = exports.ModRemoveCommunityView = exports.ModRemoveCommentView = exports.ModLockPostView = exports.ModBanView = exports.ModBanFromCommunityView = exports.ModAddView = exports.ModTransferCommunityView = exports.ModAddCommunityView = exports.CommentReportView = exports.CommentView = exports.PostReportView = exports.PostView = exports.PrivateMessageView = exports.SiteView = exports.LocalUserSettingsView = exports.PersonMentionView = exports.PersonViewSafe = void 0;
+var monads_1 = require("@sniptt/monads");
+var class_transformer_1 = require("class-transformer");
+var utils_1 = require("../utils");
+var PersonViewSafe = /** @class */ (function () {
+    function PersonViewSafe() {
+    }
+    return PersonViewSafe;
+}());
+exports.PersonViewSafe = PersonViewSafe;
+var PersonMentionView = /** @class */ (function () {
+    function PersonMentionView() {
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], PersonMentionView.prototype, "my_vote", void 0);
+    return PersonMentionView;
+}());
+exports.PersonMentionView = PersonMentionView;
+var LocalUserSettingsView = /** @class */ (function () {
+    function LocalUserSettingsView() {
+    }
+    return LocalUserSettingsView;
+}());
+exports.LocalUserSettingsView = LocalUserSettingsView;
+var SiteView = /** @class */ (function () {
+    function SiteView() {
+    }
+    return SiteView;
+}());
+exports.SiteView = SiteView;
+var PrivateMessageView = /** @class */ (function () {
+    function PrivateMessageView() {
+    }
+    return PrivateMessageView;
+}());
+exports.PrivateMessageView = PrivateMessageView;
+var PostView = /** @class */ (function () {
+    function PostView() {
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], PostView.prototype, "my_vote", void 0);
+    return PostView;
+}());
+exports.PostView = PostView;
+var PostReportView = /** @class */ (function () {
+    function PostReportView() {
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], PostReportView.prototype, "my_vote", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], PostReportView.prototype, "resolver", void 0);
+    return PostReportView;
+}());
+exports.PostReportView = PostReportView;
+var CommentView = /** @class */ (function () {
+    function CommentView() {
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], CommentView.prototype, "recipient", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], CommentView.prototype, "my_vote", void 0);
+    return CommentView;
+}());
+exports.CommentView = CommentView;
+var CommentReportView = /** @class */ (function () {
+    function CommentReportView() {
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], CommentReportView.prototype, "my_vote", void 0);
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], CommentReportView.prototype, "resolver", void 0);
+    return CommentReportView;
+}());
+exports.CommentReportView = CommentReportView;
+var ModAddCommunityView = /** @class */ (function () {
+    function ModAddCommunityView() {
+    }
+    return ModAddCommunityView;
+}());
+exports.ModAddCommunityView = ModAddCommunityView;
+var ModTransferCommunityView = /** @class */ (function () {
+    function ModTransferCommunityView() {
+    }
+    return ModTransferCommunityView;
+}());
+exports.ModTransferCommunityView = ModTransferCommunityView;
+var ModAddView = /** @class */ (function () {
+    function ModAddView() {
+    }
+    return ModAddView;
+}());
+exports.ModAddView = ModAddView;
+var ModBanFromCommunityView = /** @class */ (function () {
+    function ModBanFromCommunityView() {
+    }
+    return ModBanFromCommunityView;
+}());
+exports.ModBanFromCommunityView = ModBanFromCommunityView;
+var ModBanView = /** @class */ (function () {
+    function ModBanView() {
+    }
+    return ModBanView;
+}());
+exports.ModBanView = ModBanView;
+var ModLockPostView = /** @class */ (function () {
+    function ModLockPostView() {
+    }
+    return ModLockPostView;
+}());
+exports.ModLockPostView = ModLockPostView;
+var ModRemoveCommentView = /** @class */ (function () {
+    function ModRemoveCommentView() {
+    }
+    return ModRemoveCommentView;
+}());
+exports.ModRemoveCommentView = ModRemoveCommentView;
+var ModRemoveCommunityView = /** @class */ (function () {
+    function ModRemoveCommunityView() {
+    }
+    return ModRemoveCommunityView;
+}());
+exports.ModRemoveCommunityView = ModRemoveCommunityView;
+var ModRemovePostView = /** @class */ (function () {
+    function ModRemovePostView() {
+    }
+    return ModRemovePostView;
+}());
+exports.ModRemovePostView = ModRemovePostView;
+var ModStickyPostView = /** @class */ (function () {
+    function ModStickyPostView() {
+    }
+    return ModStickyPostView;
+}());
+exports.ModStickyPostView = ModStickyPostView;
+var CommunityFollowerView = /** @class */ (function () {
+    function CommunityFollowerView() {
+    }
+    return CommunityFollowerView;
+}());
+exports.CommunityFollowerView = CommunityFollowerView;
+var CommunityBlockView = /** @class */ (function () {
+    function CommunityBlockView() {
+    }
+    return CommunityBlockView;
+}());
+exports.CommunityBlockView = CommunityBlockView;
+var CommunityModeratorView = /** @class */ (function () {
+    function CommunityModeratorView() {
+    }
+    return CommunityModeratorView;
+}());
+exports.CommunityModeratorView = CommunityModeratorView;
+var CommunityPersonBanView = /** @class */ (function () {
+    function CommunityPersonBanView() {
+    }
+    return CommunityPersonBanView;
+}());
+exports.CommunityPersonBanView = CommunityPersonBanView;
+var PersonBlockView = /** @class */ (function () {
+    function PersonBlockView() {
+    }
+    return PersonBlockView;
+}());
+exports.PersonBlockView = PersonBlockView;
+var CommunityView = /** @class */ (function () {
+    function CommunityView() {
+    }
+    return CommunityView;
+}());
+exports.CommunityView = CommunityView;
+var RegistrationApplicationView = /** @class */ (function () {
+    function RegistrationApplicationView() {
+    }
+    __decorate([
+        (0, class_transformer_1.Transform)(function (_a) {
+            var value = _a.value;
+            return (0, monads_1.Some)(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)()
+    ], RegistrationApplicationView.prototype, "admin", void 0);
+    return RegistrationApplicationView;
+}());
+exports.RegistrationApplicationView = RegistrationApplicationView;

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+import { Option } from "@sniptt/monads";
+/**
+ * Converts an option to an undefined. Necessary for API requests.
+ */
+export declare function toUndefined<T>(opt: Option<T>): T;

package/dist/utils.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toUndefined = void 0;
+/**
+ * Converts an option to an undefined. Necessary for API requests.
+ */
+function toUndefined(opt) {
+    return opt.isSome() ? opt.unwrap() : undefined;
+}
+exports.toUndefined = toUndefined;

package/dist/websocket.d.ts

@@ -1,9 +1,11 @@
+import { ClassConstructor } from "class-transformer";
 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, 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";
+import { UserOperation } from "./interfaces/others";
 /**
  * Helps build lemmy websocket message requests, that you can use in your Websocket sends.
  *
@@ -248,7 +250,7 @@ export declare class LemmyWebsocket {
     /**
      * Gets the site, and your user data.
      */
-    getSite(form?: GetSite): string;
+    getSite(form: GetSite): string;
     /**
      * Get your site configuration.
      */
@@ -330,3 +332,11 @@ export declare class LemmyWebsocket {
      */
     blockCommunity(form: BlockCommunity): string;
 }
+/**
+ * A websocket JSON response that includes the errors.
+ */
+export declare function wsUserOp(msg: any): UserOperation;
+/**
+ * Converts a websocket string response to a usable result
+ */
+export declare function wsJsonToRes<ResponseType>(msg: any, responseClass: ClassConstructor<ResponseType>): ResponseType;

package/dist/websocket.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LemmyWebsocket = void 0;
+exports.wsJsonToRes = exports.wsUserOp = exports.LemmyWebsocket = void 0;
+var class_transformer_1 = require("class-transformer");
 var others_1 = require("./interfaces/others");
 /**
  * Helps build lemmy websocket message requests, that you can use in your Websocket sends.
@@ -360,7 +361,6 @@ 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);
     };
     /**
@@ -487,7 +487,33 @@ var LemmyWebsocket = /** @class */ (function () {
 }());
 exports.LemmyWebsocket = LemmyWebsocket;
 function wrapper(op, data) {
-    var send = { op: others_1.UserOperation[op], data: data };
+    var send = { op: others_1.UserOperation[op], data: (0, class_transformer_1.serialize)(data) };
     console.log(send);
     return JSON.stringify(send);
 }
+/**
+ * A websocket JSON response that includes the errors.
+ */
+// interface WebSocketJsonResponse {
+//   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;
+// }
+function wsUserOp(msg) {
+    var opStr = msg.op;
+    return others_1.UserOperation[opStr];
+}
+exports.wsUserOp = wsUserOp;
+/**
+ * Converts a websocket string response to a usable result
+ */
+function wsJsonToRes(msg, responseClass) {
+    return (0, class_transformer_1.deserialize)(responseClass, msg.data);
+}
+exports.wsJsonToRes = wsJsonToRes;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.17.0-rc.13",
+  "version": "0.17.0-rc.16",
   "author": "Dessalines <tyhou13@gmx.com>",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -16,11 +16,12 @@
   },
   "repository": "https://github.com/LemmyNet/lemmy-js-client",
   "devDependencies": {
-    "@swan-io/boxed": "^0.9.0",
+    "@sniptt/monads": "^0.5.10",
     "@types/node": "^17.0.33",
     "@types/node-fetch": "^3.0.3",
     "@typescript-eslint/eslint-plugin": "^5.23.0",
     "@typescript-eslint/parser": "^5.23.0",
+    "class-transformer": "^0.5.1",
     "eslint": "^8.15.0",
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^8.0.1",