lemmy-js-client 1.0.0-post-tags.1 → 1.0.0-private-community-fixes.0

package/dist/types/MultiCommunityResponse.d.ts

@@ -0,0 +1,4 @@
+import type { MultiCommunityView } from "./MultiCommunityView";
+export type MultiCommunityResponse = {
+    multi_community_view: MultiCommunityView;
+};

package/dist/types/MultiCommunityView.d.ts

@@ -1,6 +1,8 @@
+import type { CommunityFollowerState } from "./CommunityFollowerState";
 import type { MultiCommunity } from "./MultiCommunity";
 import type { Person } from "./Person";
 export type MultiCommunityView = {
     multi: MultiCommunity;
+    follow_state?: CommunityFollowerState;
     owner: Person;
 };

package/dist/types/MyUserInfo.d.ts

@@ -13,7 +13,8 @@ export type MyUserInfo = {
     follows: Array<CommunityFollowerView>;
     moderates: Array<CommunityModeratorView>;
     community_blocks: Array<Community>;
-    instance_blocks: Array<Instance>;
+    instance_communities_blocks: Array<Instance>;
+    instance_persons_blocks: Array<Instance>;
     person_blocks: Array<Person>;
     keyword_blocks: Array<string>;
     discussion_languages: Array<LanguageId>;

package/dist/types/Notification.d.ts

@@ -1,6 +1,16 @@
+import type { AdminAddId } from "./AdminAddId";
+import type { AdminBanId } from "./AdminBanId";
+import type { AdminRemoveCommunityId } from "./AdminRemoveCommunityId";
 import type { CommentId } from "./CommentId";
+import type { ModAddToCommunityId } from "./ModAddToCommunityId";
+import type { ModBanFromCommunityId } from "./ModBanFromCommunityId";
+import type { ModLockCommentId } from "./ModLockCommentId";
+import type { ModLockPostId } from "./ModLockPostId";
+import type { ModRemoveCommentId } from "./ModRemoveCommentId";
+import type { ModRemovePostId } from "./ModRemovePostId";
+import type { ModTransferCommunityId } from "./ModTransferCommunityId";
 import type { NotificationId } from "./NotificationId";
-import type { NotificationTypes } from "./NotificationTypes";
+import type { NotificationType } from "./NotificationType";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
 import type { PrivateMessageId } from "./PrivateMessageId";
@@ -10,7 +20,17 @@ export type Notification = {
     comment_id?: CommentId;
     read: boolean;
     published_at: string;
-    kind: NotificationTypes;
+    kind: NotificationType;
     post_id?: PostId;
     private_message_id?: PrivateMessageId;
+    admin_add_id?: AdminAddId;
+    mod_add_to_community_id?: ModAddToCommunityId;
+    admin_ban_id?: AdminBanId;
+    mod_ban_from_community_id?: ModBanFromCommunityId;
+    mod_lock_post_id?: ModLockPostId;
+    mod_remove_comment_id?: ModRemoveCommentId;
+    admin_remove_community_id?: AdminRemoveCommunityId;
+    mod_remove_post_id?: ModRemovePostId;
+    mod_lock_comment_id?: ModLockCommentId;
+    mod_transfer_community_id?: ModTransferCommunityId;
 };

package/dist/types/NotificationData.d.ts

@@ -1,4 +1,14 @@
+import type { AdminAdd } from "./AdminAdd";
+import type { AdminBan } from "./AdminBan";
+import type { AdminRemoveCommunity } from "./AdminRemoveCommunity";
 import type { CommentView } from "./CommentView";
+import type { ModAddToCommunity } from "./ModAddToCommunity";
+import type { ModBanFromCommunity } from "./ModBanFromCommunity";
+import type { ModLockComment } from "./ModLockComment";
+import type { ModLockPost } from "./ModLockPost";
+import type { ModRemoveComment } from "./ModRemoveComment";
+import type { ModRemovePost } from "./ModRemovePost";
+import type { ModTransferCommunity } from "./ModTransferCommunity";
 import type { PostView } from "./PostView";
 import type { PrivateMessageView } from "./PrivateMessageView";
 export type NotificationData = ({
@@ -7,4 +17,24 @@ export type NotificationData = ({
     type_: "Post";
 } & PostView) | ({
     type_: "PrivateMessage";
-} & PrivateMessageView);
+} & PrivateMessageView) | ({
+    type_: "AdminAdd";
+} & AdminAdd) | ({
+    type_: "ModAddToCommunity";
+} & ModAddToCommunity) | ({
+    type_: "AdminBan";
+} & AdminBan) | ({
+    type_: "ModBanFromCommunity";
+} & ModBanFromCommunity) | ({
+    type_: "ModLockPost";
+} & ModLockPost) | ({
+    type_: "ModLockComment";
+} & ModLockComment) | ({
+    type_: "ModRemovePost";
+} & ModRemovePost) | ({
+    type_: "ModRemoveComment";
+} & ModRemoveComment) | ({
+    type_: "AdminRemoveCommunity";
+} & AdminRemoveCommunity) | ({
+    type_: "ModTransferCommunity";
+} & ModTransferCommunity);

package/dist/types/NotificationType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Types of notifications which can be received in inbox
+ */
+export type NotificationType = "Mention" | "Reply" | "Subscribed" | "PrivateMessage" | "ModAction";

package/dist/types/OpenGraphData.d.ts

@@ -6,5 +6,9 @@ export type OpenGraphData = {
     title?: string;
     description?: string;
     image?: DbUrl;
+    image_width?: number;
+    image_height?: number;
     embed_video_url?: DbUrl;
+    video_width?: number;
+    video_height?: number;
 };

package/dist/types/PendingFollowerView.d.ts

@@ -0,0 +1,9 @@
+import type { Community } from "./Community";
+import type { CommunityFollowerState } from "./CommunityFollowerState";
+import type { Person } from "./Person";
+export type PendingFollowerView = {
+    person: Person;
+    community: Community;
+    is_new_instance: boolean;
+    follow_state?: CommunityFollowerState;
+};

package/dist/types/PersonResponse.d.ts

@@ -0,0 +1,7 @@
+import type { PersonView } from "./PersonView";
+/**
+ * A person response for actions done to a person.
+ */
+export type PersonResponse = {
+    person_view: PersonView;
+};

package/dist/types/PersonView.d.ts

@@ -7,5 +7,6 @@ export type PersonView = {
     person: Person;
     is_admin: boolean;
     person_actions?: PersonActions;
-    creator_banned: boolean;
+    banned: boolean;
+    ban_expires_at?: string;
 };

package/dist/types/Post.d.ts

@@ -94,4 +94,6 @@ export type Post = {
      * accepted by the community (by receiving it back via federation).
      */
     federation_pending: boolean;
+    embed_video_width?: number;
+    embed_video_height?: number;
 };

package/dist/types/PostOrCommentOrPrivateMessage.d.ts

@@ -1,10 +1,10 @@
 import type { Comment } from "./Comment";
 import type { Post } from "./Post";
 import type { PrivateMessage } from "./PrivateMessage";
-export type PostOrCommentOrPrivateMessage = {
-    Post: Post;
-} | {
-    Comment: Comment;
-} | {
-    PrivateMessage: PrivateMessage;
-};
+export type PostOrCommentOrPrivateMessage = ({
+    type_: "Post";
+} & Post) | ({
+    type_: "Comment";
+} & Comment) | ({
+    type_: "PrivateMessage";
+} & PrivateMessage);

package/dist/types/PostReportView.d.ts

@@ -21,5 +21,7 @@ export type PostReportView = {
     creator_is_admin: boolean;
     creator_is_moderator: boolean;
     creator_banned: boolean;
+    creator_ban_expires_at?: string;
     creator_banned_from_community: boolean;
+    creator_community_ban_expires_at?: string;
 };

package/dist/types/PostView.d.ts

@@ -1,7 +1,6 @@
 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 { Post } from "./Post";
@@ -18,11 +17,12 @@ export type PostView = {
     community_actions?: CommunityActions;
     person_actions?: PersonActions;
     post_actions?: PostActions;
-    instance_actions?: InstanceActions;
     creator_is_admin: boolean;
     tags: TagsView;
     can_mod: boolean;
     creator_banned: boolean;
+    creator_ban_expires_at?: string;
     creator_is_moderator: boolean;
     creator_banned_from_community: boolean;
+    creator_community_ban_expires_at?: string;
 };

package/dist/types/PrivateMessageReportView.d.ts

@@ -12,4 +12,5 @@ export type PrivateMessageReportView = {
     resolver?: Person;
     creator_is_admin: boolean;
     creator_banned: boolean;
+    creator_ban_expires_at?: string;
 };

package/dist/types/PurgeComment.d.ts

@@ -4,5 +4,5 @@ import type { CommentId } from "./CommentId";
  */
 export type PurgeComment = {
     comment_id: CommentId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgeCommunity.d.ts

@@ -4,5 +4,5 @@ import type { CommunityId } from "./CommunityId";
  */
 export type PurgeCommunity = {
     community_id: CommunityId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgePerson.d.ts

@@ -4,5 +4,5 @@ import type { PersonId } from "./PersonId";
  */
 export type PurgePerson = {
     person_id: PersonId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/PurgePost.d.ts

@@ -4,5 +4,5 @@ import type { PostId } from "./PostId";
  */
 export type PurgePost = {
     post_id: PostId;
-    reason?: string;
+    reason: string;
 };

package/dist/types/ReadableFederationState.d.ts

@@ -4,7 +4,7 @@ export type ReadableFederationState = {
     /**
      * timestamp of the next retry attempt (null if fail count is 0)
      */
-    next_retry?: string;
+    next_retry_at?: string;
     instance_id: InstanceId;
     /**
      * the last successfully sent activity id

package/dist/types/RemoveComment.d.ts

@@ -5,5 +5,5 @@ import type { CommentId } from "./CommentId";
 export type RemoveComment = {
     comment_id: CommentId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/RemoveCommunity.d.ts

@@ -5,5 +5,5 @@ import type { CommunityId } from "./CommunityId";
 export type RemoveCommunity = {
     community_id: CommunityId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/RemovePost.d.ts

@@ -5,5 +5,5 @@ import type { PostId } from "./PostId";
 export type RemovePost = {
     post_id: PostId;
     removed: boolean;
-    reason?: string;
+    reason: string;
 };

package/dist/types/SaveUserSettings.d.ts

@@ -37,6 +37,10 @@ export type SaveUserSettings = {
      * A default time range limit to apply to post sorts, in seconds. 0 means none.
      */
     default_post_time_range_seconds?: number;
+    /**
+     * A default fetch limit for number of items returned.
+     */
+    default_items_per_page?: number;
     /**
      * The default comment sort, usually "hot"
      */
@@ -94,10 +98,6 @@ export type SaveUserSettings = {
      * Enable infinite scroll
      */
     infinite_scroll_enabled?: boolean;
-    /**
-     * Whether to allow keyboard navigation (for browsing and interacting with posts and comments).
-     */
-    enable_keyboard_navigation?: boolean;
     /**
      * Whether user avatars or inline images in the UI that are gifs should be allowed to play or
      * should be paused
@@ -114,7 +114,7 @@ export type SaveUserSettings = {
     /**
      * Some vote display mode settings
      */
-    show_scores?: boolean;
+    show_score?: boolean;
     show_upvotes?: boolean;
     show_downvotes?: VoteShow;
     show_upvote_percentage?: boolean;

package/dist/types/Tag.d.ts

@@ -2,25 +2,17 @@ import type { CommunityId } from "./CommunityId";
 import type { DbUrl } from "./DbUrl";
 import type { TagId } from "./TagId";
 /**
- * A tag that can be assigned to a post within a community.
- * The tag object is created by the community moderators.
- * The assignment happens by the post creator and can be updated by the community moderators.
- *
- * A tag is a federated object that gives additional context to another object, which can be
- * displayed and filtered on. Currently, we only have community post tags, which is a tag that is
- * created by the mods of a community, then assigned to posts by post authors as well as mods of a
- * community, to categorize a post.
- *
- * In the future we may add more tag types, depending on the requirements, this will lead to either
- * expansion of this table (community_id optional, addition of tag_type enum) or split of this
- * table / creation of new tables.
+ * A tag that is created by community moderators, and assigned to posts by the creator
+ * or by mods.
  */
 export type Tag = {
     id: TagId;
     ap_id: DbUrl;
     name: string;
+    display_name?: string;
+    description?: string;
     /**
-     * the community that owns this tag
+     * The community that this tag belongs to
      */
     community_id: CommunityId;
     published_at: string;

package/dist/types/TagsView.d.ts

@@ -1,5 +1,5 @@
 import type { Tag } from "./Tag";
 /**
- * we wrap this in a struct so we can implement FromSqlRow<Json> for it
+ * We wrap this in a struct so we can implement FromSqlRow<Json> for it
  */
 export type TagsView = Array<Tag>;

package/dist/types/UntranslatedError.d.ts

@@ -0,0 +1,12 @@
+/**
+ * These errors are only used for federation or internally and dont need to be translated.
+ */
+export type UntranslatedError = "InvalidCommunity" | "CannotCreatePostOrCommentInDeletedOrRemovedCommunity" | "CannotReceivePage" | "OnlyLocalAdminCanRemoveCommunity" | "OnlyLocalAdminCanRestoreCommunity" | "PostIsLocked" | {
+    PersonIsBannedFromSite: string;
+} | "InvalidVoteValue" | "PageDoesNotSpecifyCreator" | "FederationDisabled" | {
+    DomainBlocked: string;
+} | {
+    DomainNotInAllowList: string;
+} | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | {
+    InvalidFollow: string;
+} | "PurgeInvalidImageUrl" | "Unreachable" | "CouldntSendWebmention" | "CommunityHasNoFollowers";

package/dist/types/UpdateCommunityTag.d.ts

@@ -0,0 +1,9 @@
+import type { TagId } from "./TagId";
+/**
+ * Make changes to a community tag
+ */
+export type UpdateCommunityTag = {
+    tag_id: TagId;
+    display_name?: string;
+    description?: string;
+};

package/dist/types/UserBlockInstanceCommunitiesParams.d.ts

@@ -0,0 +1,8 @@
+import type { InstanceId } from "./InstanceId";
+/**
+ * Block an instance's communities.
+ */
+export type UserBlockInstanceCommunitiesParams = {
+    instance_id: InstanceId;
+    block: boolean;
+};

package/dist/types/{UserBlockInstanceParams.d.ts → UserBlockInstancePersonsParams.d.ts}

@@ -1,8 +1,8 @@
 import type { InstanceId } from "./InstanceId";
 /**
- * Block an instance as user
+ * Block an instance's persons.
  */
-export type UserBlockInstanceParams = {
+export type UserBlockInstancePersonsParams = {
     instance_id: InstanceId;
     block: boolean;
 };

package/dist/types/UserSettingsBackup.d.ts

@@ -22,5 +22,6 @@ export type UserSettingsBackup = {
     saved_comments: Array<string>;
     blocked_communities: Array<string>;
     blocked_users: Array<string>;
-    blocked_instances: Array<string>;
+    blocked_instances_communities: Array<string>;
+    blocked_instances_persons: Array<string>;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-post-tags.1",
+  "version": "1.0.0-private-community-fixes.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",
+    "@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",
-    "joi": "^17.13.3",
+    "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.13.1",
+  "packageManager": "pnpm@10.18.2",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/BanPersonResponse.d.ts

@@ -1,8 +0,0 @@
-import type { PersonView } from "./PersonView";
-/**
- * A response for a banned person.
- */
-export type BanPersonResponse = {
-    person_view: PersonView;
-    banned: boolean;
-};

package/dist/types/BlockCommunityResponse.d.ts

@@ -1,8 +0,0 @@
-import type { CommunityView } from "./CommunityView";
-/**
- * The block community response.
- */
-export type BlockCommunityResponse = {
-    community_view: CommunityView;
-    blocked: boolean;
-};

package/dist/types/BlockPersonResponse.d.ts

@@ -1,8 +0,0 @@
-import type { PersonView } from "./PersonView";
-/**
- * The response for a person block.
- */
-export type BlockPersonResponse = {
-    person_view: PersonView;
-    blocked: boolean;
-};

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_at: string;
-};

package/dist/types/CommentReplyId.d.ts

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

package/dist/types/FederationError.d.ts

@@ -1,10 +0,0 @@
-/**
- * Federation related errors, these dont need to be translated.
- */
-export type FederationError = "InvalidCommunity" | "CannotCreatePostOrCommentInDeletedOrRemovedCommunity" | "CannotReceivePage" | "OnlyLocalAdminCanRemoveCommunity" | "OnlyLocalAdminCanRestoreCommunity" | "PostIsLocked" | {
-    PersonIsBannedFromSite: string;
-} | "InvalidVoteValue" | "PageDoesNotSpecifyCreator" | "CouldntGetComments" | "CouldntGetPosts" | "FederationDisabled" | {
-    DomainBlocked: string;
-} | {
-    DomainNotInAllowList: string;
-} | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | "PlatformLackingPrivateCommunitySupport" | "Unreachable";

package/dist/types/GetCommunityPendingFollowsCount.d.ts

@@ -1,4 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-export type GetCommunityPendingFollowsCount = {
-    community_id: CommunityId;
-};

package/dist/types/InboxDataType.d.ts

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

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/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/NotificationTypes.d.ts

@@ -1,4 +0,0 @@
-/**
- * Types of notifications which can be received in inbox
- */
-export type NotificationTypes = "Mention" | "Reply" | "Subscribed" | "PrivateMessage";

package/dist/types/NotificationTypes.js

@@ -1,3 +0,0 @@
-"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/NotificationsMode.d.ts

@@ -1,4 +0,0 @@
-/**
- * Lets you show votes for others only, show all votes, or hide all votes.
- */
-export type NotificationsMode = "RepliesAndMentions" | "AllComments" | "Mute";

package/dist/types/NotificationsMode.js

@@ -1,3 +0,0 @@
-"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/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_at: string;
-};

package/dist/types/PersonCommentMentionId.d.ts

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

package/dist/types/PersonCommentMentionId.js

@@ -1,3 +0,0 @@
-"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/PersonNotification.d.ts

@@ -1,9 +0,0 @@
-import type { NotificationId } from "./NotificationId";
-import type { NotificationTypes } from "./NotificationTypes";
-import type { PersonId } from "./PersonId";
-export type PersonNotification = {
-    notification_id: NotificationId;
-    recipient_id: PersonId;
-    kind: NotificationTypes;
-    read: 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_at: string;
-};