lemmy-js-client 0.19.4-alpha.8 → 0.19.4

package/README.md

@@ -22,31 +22,34 @@ A javascript / typescript http client and type system for [Lemmy](https://github
 [LemmyHttp docs](https://join-lemmy.org/api/classes/LemmyHttp.html)
 
 ```ts
-import { LemmyHttp, Login } from 'lemmy-js-client';
+import { LemmyHttp, Login } from "lemmy-js-client";
 
-let baseUrl = 'https://lemmy.ml';
-let client: LemmyHttp = new LemmyHttp(baseUrl, headers?);
-let loginForm: Login = {
+// Build the client
+const baseUrl = "https://lemmy.ml";
+const client: LemmyHttp = new LemmyHttp(baseUrl);
+
+// Build the login form
+const loginForm: Login = {
   username_or_email: "my_name",
   password: "my_pass",
 };
-let jwt = await client.login(loginForm).jwt;
-```
-
-## Development
 
-You can use [yalc](https://github.com/wclr/yalc) to develop and test changes locally:
+// Login and set the client headers with your jwt
+const { jwt } = await client.login(loginForm);
+client.setHeaders({ Authorization: `Bearer ${jwt}` });
 
+// Fetch top posts for the day
+const getPostsForm: GetPosts = {
+  sort: "TopDay",
+  type_: "Local",
+};
+const posts = await client.getPosts(getPostsForm);
 ```
-pnpm i --global add yalc
 
-# Go to lemmy-js-client dir
-yalc publish --push
+## Development
 
-# Go to your client dir
-yalc add lemmy-js-client
+Use `pnpm add` to develop and test changes locally:
 
-# To do updates, go back to the lemmy-js-client dir
-# This also updates it, in every dir you've added it.
-yalc publish --push
+```
+pnpm add path/to/lemmy-js-client
 ```

package/dist/http.d.ts

@@ -1,4 +1,3 @@
-import fetch from "cross-fetch";
 import { AddAdmin } from "./types/AddAdmin";
 import { AddAdminResponse } from "./types/AddAdminResponse";
 import { AddModToCommunity } from "./types/AddModToCommunity";
@@ -211,9 +210,15 @@ export declare class LemmyHttp {
     /**
      * List all the media for your user
      *
-     * `HTTP.GET /user/list_media`
+     * `HTTP.GET /account/list_media`
      */
-    listMedia(form: ListMedia): Promise<ListMediaResponse>;
+    listMedia(form?: ListMedia): Promise<ListMediaResponse>;
+    /**
+     * List all the media known to your instance.
+     *
+     * `HTTP.GET /admin/list_all_media`
+     */
+    listAllMedia(form?: ListMedia): Promise<ListMediaResponse>;
     /**
      * Enable / Disable TOTP / two-factor authentication.
      *
@@ -560,6 +565,11 @@ export declare class LemmyHttp {
      * `HTTP.POST /user/login`
      */
     login(form: Login): Promise<LoginResponse>;
+    /**
+     * Invalidate the currently used auth token.
+     *
+     * `HTTP.POST /user/logout`
+     */
     logout(): Promise<SuccessResponse>;
     /**
      * Get the details for a person.

package/dist/http.js

@@ -19,14 +19,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 var _LemmyHttp_instances, _LemmyHttp_apiUrl, _LemmyHttp_headers, _LemmyHttp_pictrsUrl, _LemmyHttp_fetchFunction, _LemmyHttp_buildFullUrl, _LemmyHttp_wrapper;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LemmyHttp = void 0;
-const cross_fetch_1 = __importDefault(require("cross-fetch"));
-const form_data_1 = __importDefault(require("form-data"));
 const other_types_1 = require("./other_types");
 var HttpType;
 (function (HttpType) {
@@ -48,7 +43,7 @@ class LemmyHttp {
         _LemmyHttp_apiUrl.set(this, void 0);
         _LemmyHttp_headers.set(this, {});
         _LemmyHttp_pictrsUrl.set(this, void 0);
-        _LemmyHttp_fetchFunction.set(this, cross_fetch_1.default);
+        _LemmyHttp_fetchFunction.set(this, fetch.bind(globalThis));
         __classPrivateFieldSet(this, _LemmyHttp_apiUrl, `${baseUrl.replace(/\/+$/, "")}/api/${other_types_1.VERSION}`, "f");
         __classPrivateFieldSet(this, _LemmyHttp_pictrsUrl, `${baseUrl}/pictrs/image`, "f");
         if (options === null || options === void 0 ? void 0 : options.headers) {
@@ -136,10 +131,18 @@ class LemmyHttp {
     /**
      * List all the media for your user
      *
-     * `HTTP.GET /user/list_media`
+     * `HTTP.GET /account/list_media`
+     */
+    listMedia(form = {}) {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/account/list_media", form);
+    }
+    /**
+     * List all the media known to your instance.
+     *
+     * `HTTP.GET /admin/list_all_media`
      */
-    listMedia(form) {
-        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/user/list_media", form);
+    listAllMedia(form = {}) {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/admin/list_all_media", form);
     }
     /**
      * Enable / Disable TOTP / two-factor authentication.
@@ -601,6 +604,11 @@ class LemmyHttp {
     login(form) {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/user/login", form);
     }
+    /**
+     * Invalidate the currently used auth token.
+     *
+     * `HTTP.POST /user/logout`
+     */
     logout() {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/user/logout", {});
     }
@@ -847,8 +855,8 @@ class LemmyHttp {
     /**
      * Upload an image to the server.
      */
-    uploadImage({ image }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    uploadImage(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ image }) {
             const formData = createFormData(image);
             let url = undefined;
             let delete_url = undefined;
@@ -873,8 +881,8 @@ class LemmyHttp {
     /**
      * Delete a pictrs image
      */
-    deleteImage({ token, filename }) {
-        return __awaiter(this, void 0, void 0, function* () {
+    deleteImage(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ token, filename }) {
             const deleteUrl = `${__classPrivateFieldGet(this, _LemmyHttp_pictrsUrl, "f")}/delete/${token}/${filename}`;
             const response = yield __classPrivateFieldGet(this, _LemmyHttp_fetchFunction, "f").call(this, deleteUrl, {
                 method: HttpType.Get,
@@ -894,8 +902,8 @@ exports.LemmyHttp = LemmyHttp;
 _LemmyHttp_apiUrl = new WeakMap(), _LemmyHttp_headers = new WeakMap(), _LemmyHttp_pictrsUrl = new WeakMap(), _LemmyHttp_fetchFunction = new WeakMap(), _LemmyHttp_instances = new WeakSet(), _LemmyHttp_buildFullUrl = function _LemmyHttp_buildFullUrl(endpoint) {
     return `${__classPrivateFieldGet(this, _LemmyHttp_apiUrl, "f")}${endpoint}`;
 }, _LemmyHttp_wrapper = function _LemmyHttp_wrapper(type_, endpoint, form) {
-    var _a;
     return __awaiter(this, void 0, void 0, function* () {
+        var _a;
         let response;
         if (type_ === HttpType.Get) {
             const getUrl = `${__classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_buildFullUrl).call(this, endpoint)}?${encodeGetParams(form)}`;
@@ -928,18 +936,18 @@ _LemmyHttp_apiUrl = new WeakMap(), _LemmyHttp_headers = new WeakMap(), _LemmyHtt
 };
 function encodeGetParams(p) {
     return Object.entries(p)
-        .filter(kv => !!kv[1])
+        .filter(kv => kv[1] !== undefined && kv[1] !== null)
         .map(kv => kv.map(encodeURIComponent).join("="))
         .join("&");
 }
 function createFormData(image) {
-    let formData = new form_data_1.default();
-    if (image.constructor.name === "File") {
+    let formData = new FormData();
+    if (image instanceof File) {
         formData.append("images[]", image);
     }
     else {
         // The filename doesn't affect the file type or file name that ends up in pictrs
-        formData.append("images[]", image, { filename: "image.jpg" });
+        formData.append("images[]", new Blob([image], { type: "image/jpeg" }), "image.jpg");
     }
     return formData;
 }

package/dist/index.d.ts

@@ -137,6 +137,7 @@ export { ListRegistrationApplications } from "./types/ListRegistrationApplicatio
 export { ListRegistrationApplicationsResponse } from "./types/ListRegistrationApplicationsResponse";
 export { ListingType } from "./types/ListingType";
 export { LocalImage } from "./types/LocalImage";
+export { LocalImageView } from "./types/LocalImageView";
 export { LocalSite } from "./types/LocalSite";
 export { LocalSiteId } from "./types/LocalSiteId";
 export { LocalSiteRateLimit } from "./types/LocalSiteRateLimit";
@@ -144,6 +145,7 @@ export { LocalSiteUrlBlocklist } from "./types/LocalSiteUrlBlocklist";
 export { LocalUser } from "./types/LocalUser";
 export { LocalUserId } from "./types/LocalUserId";
 export { LocalUserView } from "./types/LocalUserView";
+export { LocalUserVoteDisplayMode } from "./types/LocalUserVoteDisplayMode";
 export { LockPost } from "./types/LockPost";
 export { Login } from "./types/Login";
 export { LoginResponse } from "./types/LoginResponse";

package/dist/types/CommentReplyView.d.ts

@@ -14,6 +14,7 @@ export interface CommentReplyView {
     recipient: Person;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
+    banned_from_community: boolean;
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;

package/dist/types/CommentReportView.d.ts

@@ -4,6 +4,7 @@ import type { CommentReport } from "./CommentReport";
 import type { Community } from "./Community";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
+import type { SubscribedType } from "./SubscribedType";
 export interface CommentReportView {
     comment_report: CommentReport;
     comment: Comment;
@@ -13,6 +14,11 @@ export interface CommentReportView {
     comment_creator: Person;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
+    creator_is_moderator: boolean;
+    creator_is_admin: boolean;
+    creator_blocked: boolean;
+    subscribed: SubscribedType;
+    saved: boolean;
     my_vote?: number;
     resolver?: Person;
 }

package/dist/types/CommentView.d.ts

@@ -11,6 +11,7 @@ export interface CommentView {
     community: Community;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
+    banned_from_community: boolean;
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;

package/dist/types/LemmyErrorType.d.ts

@@ -66,6 +66,26 @@ export type LemmyErrorType = {
     error: "couldnt_find_community";
 } | {
     error: "couldnt_find_person";
+} | {
+    error: "couldnt_find_comment";
+} | {
+    error: "couldnt_find_comment_report";
+} | {
+    error: "couldnt_find_post_report";
+} | {
+    error: "couldnt_find_private_message_report";
+} | {
+    error: "couldnt_find_local_user";
+} | {
+    error: "couldnt_find_person_mention";
+} | {
+    error: "couldnt_find_registration_application";
+} | {
+    error: "couldnt_find_comment_reply";
+} | {
+    error: "couldnt_find_private_message";
+} | {
+    error: "couldnt_find_activity";
 } | {
     error: "person_is_blocked";
 } | {
@@ -157,12 +177,10 @@ export type LemmyErrorType = {
     error: "invalid_vote_value";
 } | {
     error: "page_does_not_specify_creator";
-} | {
-    error: "page_does_not_specify_group";
-} | {
-    error: "no_community_found_in_cc";
 } | {
     error: "no_email_setup";
+} | {
+    error: "local_site_not_setup";
 } | {
     error: "email_smtp_server_needs_a_port";
 } | {
@@ -286,8 +304,6 @@ export type LemmyErrorType = {
     error: "invalid_regex";
 } | {
     error: "captcha_incorrect";
-} | {
-    error: "password_reset_limit_reached";
 } | {
     error: "couldnt_create_audio_captcha";
 } | {
@@ -310,6 +326,10 @@ export type LemmyErrorType = {
     error: "invalid_bot_action";
 } | {
     error: "cant_block_local_instance";
+} | {
+    error: "url_without_domain";
+} | {
+    error: "inbox_timeout";
 } | {
     error: "unknown";
     message: string;

package/dist/types/ListMediaResponse.d.ts

@@ -1,4 +1,4 @@
-import type { LocalImage } from "./LocalImage";
+import type { LocalImageView } from "./LocalImageView";
 export interface ListMediaResponse {
-    images: Array<LocalImage>;
+    images: Array<LocalImageView>;
 }

package/dist/types/LocalImage.d.ts

@@ -1,6 +1,6 @@
 import type { LocalUserId } from "./LocalUserId";
 export interface LocalImage {
-    local_user_id: LocalUserId;
+    local_user_id?: LocalUserId;
     pictrs_alias: string;
     pictrs_delete_token: string;
     published: string;

package/dist/types/LocalImageView.d.ts

@@ -0,0 +1,6 @@
+import type { LocalImage } from "./LocalImage";
+import type { Person } from "./Person";
+export interface LocalImageView {
+    local_image: LocalImage;
+    person: Person;
+}

package/dist/types/LocalImageView.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/LocalUserView.d.ts

@@ -1,8 +1,10 @@
 import type { LocalUser } from "./LocalUser";
+import type { LocalUserVoteDisplayMode } from "./LocalUserVoteDisplayMode";
 import type { Person } from "./Person";
 import type { PersonAggregates } from "./PersonAggregates";
 export interface LocalUserView {
     local_user: LocalUser;
+    local_user_vote_display_mode: LocalUserVoteDisplayMode;
     person: Person;
     counts: PersonAggregates;
 }

package/dist/types/LocalUserVoteDisplayMode.d.ts

@@ -0,0 +1,8 @@
+import type { LocalUserId } from "./LocalUserId";
+export interface LocalUserVoteDisplayMode {
+    local_user_id: LocalUserId;
+    score: boolean;
+    upvotes: boolean;
+    downvotes: boolean;
+    upvote_percentage: boolean;
+}

package/dist/types/LocalUserVoteDisplayMode.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/PersonMentionView.d.ts

@@ -14,6 +14,7 @@ export interface PersonMentionView {
     recipient: Person;
     counts: CommentAggregates;
     creator_banned_from_community: boolean;
+    banned_from_community: boolean;
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     subscribed: SubscribedType;

package/dist/types/PostReportView.d.ts

@@ -3,6 +3,7 @@ import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { PostAggregates } from "./PostAggregates";
 import type { PostReport } from "./PostReport";
+import type { SubscribedType } from "./SubscribedType";
 export interface PostReportView {
     post_report: PostReport;
     post: Post;
@@ -10,7 +11,15 @@ export interface PostReportView {
     creator: Person;
     post_creator: Person;
     creator_banned_from_community: boolean;
+    creator_is_moderator: boolean;
+    creator_is_admin: boolean;
+    subscribed: SubscribedType;
+    saved: boolean;
+    read: boolean;
+    hidden: boolean;
+    creator_blocked: boolean;
     my_vote?: number;
+    unread_comments: number;
     counts: PostAggregates;
     resolver?: Person;
 }

package/dist/types/PostView.d.ts

@@ -8,6 +8,7 @@ export interface PostView {
     creator: Person;
     community: Community;
     creator_banned_from_community: boolean;
+    banned_from_community: boolean;
     creator_is_moderator: boolean;
     creator_is_admin: boolean;
     counts: PostAggregates;

package/dist/types/Register.d.ts

@@ -2,7 +2,7 @@ export interface Register {
     username: string;
     password: string;
     password_verify: string;
-    show_nsfw: boolean;
+    show_nsfw?: boolean;
     email?: string;
     captcha_uuid?: string;
     captcha_answer?: string;

package/dist/types/SaveUserSettings.d.ts

@@ -6,7 +6,6 @@ export interface SaveUserSettings {
     show_nsfw?: boolean;
     blur_nsfw?: boolean;
     auto_expand?: boolean;
-    show_scores?: boolean;
     theme?: string;
     default_sort_type?: SortType;
     default_listing_type?: ListingType;
@@ -29,4 +28,8 @@ export interface SaveUserSettings {
     enable_keyboard_navigation?: boolean;
     enable_animated_images?: boolean;
     collapse_bot_comments?: boolean;
+    show_scores?: boolean;
+    show_upvotes?: boolean;
+    show_downvotes?: boolean;
+    show_upvote_percentage?: boolean;
 }

package/dist/types/Site.d.ts

@@ -12,7 +12,6 @@ export interface Site {
     actor_id: string;
     last_refreshed_at: string;
     inbox_url: string;
-    private_key?: string;
     public_key: string;
     instance_id: InstanceId;
     content_warning?: string;

package/dist/types/VoteView.d.ts

@@ -1,5 +1,6 @@
 import type { Person } from "./Person";
 export interface VoteView {
     creator: Person;
+    creator_banned_from_community: boolean;
     score: number;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "0.19.4-alpha.8",
+  "version": "0.19.4",
   "author": "Dessalines <tyhou13@gmx.com>",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -11,22 +11,18 @@
   "scripts": {
     "build": "tsc",
     "docs": "typedoc src/index.ts",
-    "lint": "tsc --noEmit && eslint --report-unused-disable-directives --ext .js,.ts,.tsx src && prettier --check src",
+    "lint": "tsc --noEmit && eslint --report-unused-disable-directives && prettier --check src",
     "prepare": "pnpm run build && husky"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/LemmyNet/lemmy-js-client.git"
   },
-  "dependencies": {
-    "cross-fetch": "^4.0.0",
-    "form-data": "^4.0.0"
-  },
   "devDependencies": {
     "@types/node": "^20.11.19",
     "@typescript-eslint/eslint-plugin": "^7.0.1",
     "@typescript-eslint/parser": "^7.0.1",
-    "eslint": "^8.56.0",
+    "eslint": "^9.0.0",
     "eslint-plugin-prettier": "^5.1.3",
     "husky": "^9.0.11",
     "lint-staged": "^15.2.2",
@@ -36,8 +32,10 @@
     "prettier-plugin-packagejson": "^2.4.11",
     "sortpack": "^2.4.0",
     "typedoc": "^0.25.8",
-    "typescript": "^5.3.3"
+    "typescript": "^5.3.3",
+    "typescript-eslint": "^7.9.0"
   },
+  "packageManager": "pnpm@9.1.4",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [