lemmy-js-client 1.0.0-media-fixes.1 → 1.0.0-mod-reason-mandatory.0

package/dist/types/UserBlockInstancePersonsParams.js

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

package/dist/types/UserSettingsBackup.d.ts

@@ -0,0 +1,27 @@
+import type { LocalUser } from "./LocalUser";
+/**
+ * Backup of user data. This struct should never be changed so that the data can be used as a
+ * long-term backup in case the instance goes down unexpectedly. All fields are optional to allow
+ * importing partial backups.
+ *
+ * This data should not be parsed by apps/clients, but directly downloaded as a file.
+ *
+ * Be careful with any changes to this struct, to avoid breaking changes which could prevent
+ * importing older backups.
+ */
+export type UserSettingsBackup = {
+    display_name?: string;
+    bio?: string;
+    avatar?: string;
+    banner?: string;
+    matrix_id?: string;
+    bot_account?: boolean;
+    settings?: LocalUser;
+    followed_communities: Array<string>;
+    saved_posts: Array<string>;
+    saved_comments: Array<string>;
+    blocked_communities: Array<string>;
+    blocked_users: Array<string>;
+    blocked_instances_communities: Array<string>;
+    blocked_instances_persons: Array<string>;
+};

package/dist/types/UserSettingsBackup.js

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

package/dist/types/VoteShow.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Lets you show votes for others only, show all votes, or hide all votes.
+ */
+export type VoteShow = "Show" | "ShowForOthers" | "Hide";

package/dist/types/VoteShow.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/VoteView.d.ts

@@ -4,6 +4,7 @@ import type { Person } from "./Person";
  */
 export type VoteView = {
     creator: Person;
+    creator_banned: boolean;
     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": "1.0.0-media-fixes.1",
+  "version": "1.0.0-mod-reason-mandatory.0",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -24,26 +24,27 @@
   },
   "devDependencies": {
     "@eslint/js": "^9.20.0",
-    "@redocly/cli": "^1.27.2",
-    "@types/joi": "^17.2.3",
+    "@redocly/cli": "^2.0.0",
     "@types/node": "^22.7.4",
     "@typescript-eslint/eslint-plugin": "^8.7.0",
     "@typescript-eslint/parser": "^8.7.0",
+    "ajv": "^8.17.1",
     "eslint": "^9.11.1",
     "eslint-plugin-prettier": "^5.2.1",
     "husky": "^9.1.4",
-    "lint-staged": "^15.2.7",
+    "joi": "^18.0.0",
+    "lint-staged": "^16.0.0",
     "prettier": "^3.3.3",
     "prettier-plugin-import-sort": "^0.0.7",
     "prettier-plugin-organize-imports": "^4.0.0",
     "prettier-plugin-packagejson": "^2.5.1",
-    "sortpack": "^2.4.0",
+    "sortpack": "^3.0.0",
     "tsoa": "^6.6.0",
     "typedoc": "^0.28.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.7.1",
+  "packageManager": "pnpm@10.16.1",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/CommentReply.d.ts

@@ -1,13 +0,0 @@
-import type { CommentId } from "./CommentId";
-import type { CommentReplyId } from "./CommentReplyId";
-import type { PersonId } from "./PersonId";
-/**
- * A comment reply.
- */
-export type CommentReply = {
-    id: CommentReplyId;
-    recipient_id: PersonId;
-    comment_id: CommentId;
-    read: boolean;
-    published: string;
-};

package/dist/types/CommentReplyId.d.ts

@@ -1,4 +0,0 @@
-/**
- * The comment reply id.
- */
-export type CommentReplyId = number;

package/dist/types/CommentReplyView.d.ts

@@ -1,32 +0,0 @@
-import type { Comment } from "./Comment";
-import type { CommentActions } from "./CommentActions";
-import type { CommentReply } from "./CommentReply";
-import type { Community } from "./Community";
-import type { CommunityActions } from "./CommunityActions";
-import type { InstanceActions } from "./InstanceActions";
-import type { Person } from "./Person";
-import type { PersonActions } from "./PersonActions";
-import type { Post } from "./Post";
-import type { TagsView } from "./TagsView";
-/**
- * A comment reply view.
- */
-export type CommentReplyView = {
-    comment_reply: CommentReply;
-    recipient: Person;
-    comment: Comment;
-    creator: Person;
-    post: Post;
-    community: Community;
-    community_actions?: CommunityActions;
-    comment_actions?: CommentActions;
-    person_actions?: PersonActions;
-    instance_actions?: InstanceActions;
-    creator_home_instance_actions?: InstanceActions;
-    creator_local_instance_actions?: InstanceActions;
-    creator_community_actions?: CommunityActions;
-    creator_is_admin: boolean;
-    post_tags: TagsView;
-    can_mod: boolean;
-    creator_banned: boolean;
-};

package/dist/types/InboxCombinedView.d.ts

@@ -1,13 +0,0 @@
-import type { CommentReplyView } from "./CommentReplyView";
-import type { PersonCommentMentionView } from "./PersonCommentMentionView";
-import type { PersonPostMentionView } from "./PersonPostMentionView";
-import type { PrivateMessageView } from "./PrivateMessageView";
-export type InboxCombinedView = ({
-    type_: "CommentReply";
-} & CommentReplyView) | ({
-    type_: "CommentMention";
-} & PersonCommentMentionView) | ({
-    type_: "PostMention";
-} & PersonPostMentionView) | ({
-    type_: "PrivateMessage";
-} & PrivateMessageView);

package/dist/types/InboxDataType.d.ts

@@ -1,4 +0,0 @@
-/**
- * A list of possible types for the inbox.
- */
-export type InboxDataType = "All" | "CommentReply" | "CommentMention" | "PostMention" | "PrivateMessage";

package/dist/types/MarkCommentReplyAsRead.d.ts

@@ -1,8 +0,0 @@
-import type { CommentReplyId } from "./CommentReplyId";
-/**
- * Mark a comment reply as read.
- */
-export type MarkCommentReplyAsRead = {
-    comment_reply_id: CommentReplyId;
-    read: boolean;
-};

package/dist/types/MarkPersonCommentMentionAsRead.d.ts

@@ -1,8 +0,0 @@
-import type { PersonCommentMentionId } from "./PersonCommentMentionId";
-/**
- * Mark a person mention as read.
- */
-export type MarkPersonCommentMentionAsRead = {
-    person_comment_mention_id: PersonCommentMentionId;
-    read: boolean;
-};

package/dist/types/MarkPersonPostMentionAsRead.d.ts

@@ -1,8 +0,0 @@
-import type { PersonPostMentionId } from "./PersonPostMentionId";
-/**
- * Mark a person mention as read.
- */
-export type MarkPersonPostMentionAsRead = {
-    person_post_mention_id: PersonPostMentionId;
-    read: boolean;
-};

package/dist/types/MarkPrivateMessageAsRead.d.ts

@@ -1,8 +0,0 @@
-import type { PrivateMessageId } from "./PrivateMessageId";
-/**
- * Mark a private message as read.
- */
-export type MarkPrivateMessageAsRead = {
-    private_message_id: PrivateMessageId;
-    read: boolean;
-};

package/dist/types/ModAdd.d.ts

@@ -1,12 +0,0 @@
-import type { ModAddId } from "./ModAddId";
-import type { PersonId } from "./PersonId";
-/**
- * When someone is added as a site moderator.
- */
-export type ModAdd = {
-    id: ModAddId;
-    mod_person_id: PersonId;
-    other_person_id: PersonId;
-    removed: boolean;
-    published: string;
-};

package/dist/types/ModAddCommunityId.d.ts

@@ -1 +0,0 @@
-export type ModAddCommunityId = number;

package/dist/types/ModAddId.d.ts

@@ -1 +0,0 @@
-export type ModAddId = number;

package/dist/types/ModBanId.d.ts

@@ -1 +0,0 @@
-export type ModBanId = number;

package/dist/types/ModRemoveCommunityId.d.ts

@@ -1 +0,0 @@
-export type ModRemoveCommunityId = number;

package/dist/types/ModRemoveCommunityView.d.ts

@@ -1,11 +0,0 @@
-import type { Community } from "./Community";
-import type { ModRemoveCommunity } from "./ModRemoveCommunity";
-import type { Person } from "./Person";
-/**
- * When a moderator removes a community.
- */
-export type ModRemoveCommunityView = {
-    mod_remove_community: ModRemoveCommunity;
-    moderator?: Person;
-    community: Community;
-};

package/dist/types/PersonCommentMention.d.ts

@@ -1,13 +0,0 @@
-import type { CommentId } from "./CommentId";
-import type { PersonCommentMentionId } from "./PersonCommentMentionId";
-import type { PersonId } from "./PersonId";
-/**
- * A person mention.
- */
-export type PersonCommentMention = {
-    id: PersonCommentMentionId;
-    recipient_id: PersonId;
-    comment_id: CommentId;
-    read: boolean;
-    published: string;
-};

package/dist/types/PersonCommentMentionId.d.ts

@@ -1,4 +0,0 @@
-/**
- * The person comment mention id.
- */
-export type PersonCommentMentionId = number;

package/dist/types/PersonCommentMentionView.d.ts

@@ -1,30 +0,0 @@
-import type { Comment } from "./Comment";
-import type { CommentActions } from "./CommentActions";
-import type { Community } from "./Community";
-import type { CommunityActions } from "./CommunityActions";
-import type { InstanceActions } from "./InstanceActions";
-import type { Person } from "./Person";
-import type { PersonActions } from "./PersonActions";
-import type { PersonCommentMention } from "./PersonCommentMention";
-import type { Post } from "./Post";
-/**
- * A person comment mention view.
- */
-export type PersonCommentMentionView = {
-    person_comment_mention: PersonCommentMention;
-    recipient: Person;
-    comment: Comment;
-    creator: Person;
-    post: Post;
-    community: Community;
-    community_actions?: CommunityActions;
-    comment_actions?: CommentActions;
-    person_actions?: PersonActions;
-    instance_actions?: InstanceActions;
-    creator_home_instance_actions?: InstanceActions;
-    creator_local_instance_actions?: InstanceActions;
-    creator_community_actions?: CommunityActions;
-    creator_is_admin: boolean;
-    can_mod: boolean;
-    creator_banned: boolean;
-};

package/dist/types/PersonPostMention.d.ts

@@ -1,13 +0,0 @@
-import type { PersonId } from "./PersonId";
-import type { PersonPostMentionId } from "./PersonPostMentionId";
-import type { PostId } from "./PostId";
-/**
- * A person mention.
- */
-export type PersonPostMention = {
-    id: PersonPostMentionId;
-    recipient_id: PersonId;
-    post_id: PostId;
-    read: boolean;
-    published: string;
-};

package/dist/types/PersonPostMentionId.d.ts

@@ -1,4 +0,0 @@
-/**
- * The person post mention id.
- */
-export type PersonPostMentionId = number;

package/dist/types/PersonPostMentionView.d.ts

@@ -1,32 +0,0 @@
-import type { Community } from "./Community";
-import type { CommunityActions } from "./CommunityActions";
-import type { ImageDetails } from "./ImageDetails";
-import type { InstanceActions } from "./InstanceActions";
-import type { Person } from "./Person";
-import type { PersonActions } from "./PersonActions";
-import type { PersonPostMention } from "./PersonPostMention";
-import type { Post } from "./Post";
-import type { PostActions } from "./PostActions";
-import type { TagsView } from "./TagsView";
-/**
- * A person post mention view.
- */
-export type PersonPostMentionView = {
-    person_post_mention: PersonPostMention;
-    recipient: Person;
-    post: Post;
-    creator: Person;
-    community: Community;
-    image_details?: ImageDetails;
-    community_actions?: CommunityActions;
-    person_actions?: PersonActions;
-    post_actions?: PostActions;
-    instance_actions?: InstanceActions;
-    creator_home_instance_actions?: InstanceActions;
-    creator_local_instance_actions?: InstanceActions;
-    creator_community_actions?: CommunityActions;
-    post_tags: TagsView;
-    creator_is_admin: boolean;
-    can_mod: boolean;
-    creator_banned: boolean;
-};

package/dist/types/PostPaginationCursor.d.ts

@@ -1,7 +0,0 @@
-/**
- * currently this is just a wrapper around post id, but should be seen as opaque from the client's
- * perspective. stringified since we might want to use arbitrary info later, with a P prepended to
- * prevent ossification (api users love to make assumptions (e.g. parse stuff that looks like
- * numbers as numbers) about apis that aren't part of the spec
- */
-export type PostPaginationCursor = string;

package/dist/types/ResolveObjectResponse.d.ts

@@ -1,13 +0,0 @@
-import type { CommentView } from "./CommentView";
-import type { CommunityView } from "./CommunityView";
-import type { PersonView } from "./PersonView";
-import type { PostView } from "./PostView";
-/**
- * The response of an apub object fetch.
- */
-export type ResolveObjectResponse = {
-    comment?: CommentView;
-    post?: PostView;
-    community?: CommunityView;
-    person?: PersonView;
-};