lemmy-js-client 0.17.0-rc.4 → 0.17.0-rc.42

package/dist/websocket.d.ts

@@ -1,9 +1,11 @@
-import { CreateComment, CreateCommentLike, CreateCommentReport, DeleteComment, EditComment, GetComments, ListCommentReports, MarkCommentAsRead, RemoveComment, ResolveCommentReport, SaveComment } from "./interfaces/api/comment";
+import { ClassConstructor } from "class-transformer";
+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, DeleteAccount, DeletePrivateMessage, EditPrivateMessage, GetBannedPersons, GetPersonDetails, GetPersonMentions, GetPrivateMessages, GetReplies, GetReportCount, GetUnreadCount, Login, MarkAllAsRead, MarkCommentReplyAsRead, 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, 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 +102,7 @@ export declare class LemmyWebsocket {
     /**
      * Mark a comment as read.
      */
-    markCommentAsRead(form: MarkCommentAsRead): string;
+    markCommentReplyAsRead(form: MarkCommentReplyAsRead): string;
     /**
      * Like / vote on a comment.
      */
@@ -153,6 +155,10 @@ export declare class LemmyWebsocket {
      * A moderator can sticky a post ( IE stick it to the top of a community ).
      */
     stickyPost(form: StickyPost): string;
+    /**
+     * Mark a post as read.
+     */
+    markPostAsRead(form: MarkPostAsRead): string;
     /**
      * Save a post.
      */
@@ -244,11 +250,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.
      */
@@ -313,10 +315,6 @@ export declare class LemmyWebsocket {
      * Get / fetch private messages.
      */
     getPrivateMessages(form: GetPrivateMessages): string;
-    /**
-     * Save your site config.
-     */
-    saveSiteConfig(form: SaveSiteConfig): string;
     /**
      * Block a person.
      */
@@ -325,4 +323,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, 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.
@@ -137,8 +138,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.
@@ -218,6 +219,12 @@ var LemmyWebsocket = /** @class */ (function () {
     LemmyWebsocket.prototype.stickyPost = function (form) {
         return wrapper(others_1.UserOperation.StickyPost, form);
     };
+    /**
+     * Mark a post as read.
+     */
+    LemmyWebsocket.prototype.markPostAsRead = function (form) {
+        return wrapper(others_1.UserOperation.MarkPostAsRead, form);
+    };
     /**
      * Save a post.
      */
@@ -354,15 +361,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.
      */
@@ -459,12 +459,6 @@ var LemmyWebsocket = /** @class */ (function () {
     LemmyWebsocket.prototype.getPrivateMessages = function (form) {
         return wrapper(others_1.UserOperation.GetPrivateMessages, form);
     };
-    /**
-     * Save your site config.
-     */
-    LemmyWebsocket.prototype.saveSiteConfig = function (form) {
-        return wrapper(others_1.UserOperation.SaveSiteConfig, form);
-    };
     /**
      * Block a person.
      */
@@ -477,11 +471,47 @@ 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 = (0, class_transformer_1.serialize)({ 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
+ */
+function wsJsonToRes(msg, responseClass) {
+    // Have to deserialize the response again into the correct class
+    return (0, class_transformer_1.deserialize)(responseClass, (0, class_transformer_1.serialize)(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.4",
+  "version": "0.17.0-rc.42",
   "author": "Dessalines <tyhou13@gmx.com>",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -16,23 +16,26 @@
   },
   "repository": "https://github.com/LemmyNet/lemmy-js-client",
   "devDependencies": {
-    "@types/node": "^17.0.10",
+    "@sniptt/monads": "^0.5.10",
+    "@types/node": "^18.6.2",
     "@types/node-fetch": "^3.0.3",
-    "@typescript-eslint/eslint-plugin": "^5.10.0",
-    "@typescript-eslint/parser": "^5.10.0",
-    "eslint": "^8.7.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "husky": "^7.0.4",
-    "lint-staged": "^12.2.2",
-    "node-fetch": "^3.1.1",
-    "prettier": "^2.5.0",
+    "@typescript-eslint/eslint-plugin": "^5.31.0",
+    "@typescript-eslint/parser": "^5.31.0",
+    "class-transformer": "^0.5.1",
+    "eslint": "^8.20.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
+    "node-fetch": "^3.2.9",
+    "prettier": "^2.7.1",
     "prettier-plugin-import-sort": "^0.0.7",
-    "prettier-plugin-organize-imports": "^2.3.4",
-    "prettier-plugin-packagejson": "^2.2.15",
-    "sortpack": "^2.2.0",
+    "prettier-plugin-organize-imports": "^3.0.0",
+    "prettier-plugin-packagejson": "^2.2.18",
+    "reflect-metadata": "^0.1.13",
+    "sortpack": "^2.3.0",
     "typedoc": "^0.21.6",
     "typedoc-plugin-sourcefile-url": "^1.0.6",
-    "typescript": "^4.5.4"
+    "typescript": "^4.7.4"
   },
   "types": "./dist/index.d.ts",
   "lint-staged": {