lemmy-js-client 1.0.0-search-query-mandatory.1 → 1.0.0-search-resolve-field.0

package/dist/types/SearchType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The type of content returned from a search.
  */
-export type SearchType = "All" | "Comments" | "Posts" | "Communities" | "Users";
+export type SearchType = "all" | "comments" | "posts" | "communities" | "users" | "multi_communities";

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 federatable 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;
-    display_name: string;
+    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,14 @@
+/**
+ * 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: string;
+};

package/dist/types/UpdateCommunityNotifications.d.ts

@@ -0,0 +1,9 @@
+import type { CommunityId } from "./CommunityId";
+import type { CommunityNotificationsMode } from "./CommunityNotificationsMode";
+/**
+ * Change notification settings for a community
+ */
+export type UpdateCommunityNotifications = {
+    community_id: CommunityId;
+    mode: CommunityNotificationsMode;
+};

package/dist/types/UpdateCommunityTag.d.ts

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

package/dist/types/UpdateMultiCommunity.d.ts

@@ -0,0 +1,7 @@
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type UpdateMultiCommunity = {
+    id: MultiCommunityId;
+    title?: string;
+    description?: string;
+    deleted?: boolean;
+};

package/dist/types/UpdatePostNotifications.d.ts

@@ -0,0 +1,9 @@
+import type { PostId } from "./PostId";
+import type { PostNotificationsMode } from "./PostNotificationsMode";
+/**
+ * Change notification settings for a post
+ */
+export type UpdatePostNotifications = {
+    post_id: PostId;
+    mode: PostNotificationsMode;
+};

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

@@ -0,0 +1,29 @@
+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>;
+    blocking_keywords: Array<string>;
+    discussion_languages: Array<string>;
+};

package/dist/types/VoteShow.d.ts

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

package/dist/types/VoteView.d.ts

@@ -4,6 +4,10 @@ import type { Person } from "./Person";
  */
 export type VoteView = {
     creator: Person;
+    creator_banned: boolean;
     creator_banned_from_community: boolean;
-    score: number;
+    /**
+     * True means Upvote, False means Downvote.
+     */
+    is_upvote: boolean;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lemmy-js-client",
   "description": "A javascript / typescript client for Lemmy",
-  "version": "1.0.0-search-query-mandatory.1",
+  "version": "1.0.0-search-resolve-field.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/node": "^22.7.4",
+    "@redocly/cli": "^2.0.0",
+    "@types/node": "^24.0.0",
     "@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": "^4.0.0",
     "tsoa": "^6.6.0",
     "typedoc": "^0.28.0",
     "typescript": "^5.5.4",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.12.1",
+  "packageManager": "pnpm@10.20.0",
   "types": "./dist/index.d.ts",
   "lint-staged": {
     "*.{ts,tsx,js}": [

package/dist/types/AdminAllowInstance.d.ts

@@ -1,11 +0,0 @@
-import type { AdminAllowInstanceId } from "./AdminAllowInstanceId";
-import type { InstanceId } from "./InstanceId";
-import type { PersonId } from "./PersonId";
-export type AdminAllowInstance = {
-    id: AdminAllowInstanceId;
-    instance_id: InstanceId;
-    admin_person_id: PersonId;
-    allowed: boolean;
-    reason?: string;
-    published_at: string;
-};

package/dist/types/AdminAllowInstanceId.d.ts

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

package/dist/types/AdminAllowInstanceView.d.ts

@@ -1,11 +0,0 @@
-import type { AdminAllowInstance } from "./AdminAllowInstance";
-import type { Instance } from "./Instance";
-import type { Person } from "./Person";
-/**
- * When an admin purges a post.
- */
-export type AdminAllowInstanceView = {
-    admin_allow_instance: AdminAllowInstance;
-    instance: Instance;
-    admin?: Person;
-};

package/dist/types/AdminBlockInstance.d.ts

@@ -1,12 +0,0 @@
-import type { AdminBlockInstanceId } from "./AdminBlockInstanceId";
-import type { InstanceId } from "./InstanceId";
-import type { PersonId } from "./PersonId";
-export type AdminBlockInstance = {
-    id: AdminBlockInstanceId;
-    instance_id: InstanceId;
-    admin_person_id: PersonId;
-    blocked: boolean;
-    reason?: string;
-    expires_at?: string;
-    published_at: string;
-};

package/dist/types/AdminBlockInstanceId.d.ts

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

package/dist/types/AdminBlockInstanceView.d.ts

@@ -1,11 +0,0 @@
-import type { AdminBlockInstance } from "./AdminBlockInstance";
-import type { Instance } from "./Instance";
-import type { Person } from "./Person";
-/**
- * When an admin purges a post.
- */
-export type AdminBlockInstanceView = {
-    admin_block_instance: AdminBlockInstance;
-    instance: Instance;
-    admin?: Person;
-};

package/dist/types/AdminPurgeComment.d.ts

@@ -1,13 +0,0 @@
-import type { AdminPurgeCommentId } from "./AdminPurgeCommentId";
-import type { PersonId } from "./PersonId";
-import type { PostId } from "./PostId";
-/**
- * When an admin purges a comment.
- */
-export type AdminPurgeComment = {
-    id: AdminPurgeCommentId;
-    admin_person_id: PersonId;
-    post_id: PostId;
-    reason?: string;
-    published_at: string;
-};

package/dist/types/AdminPurgeCommentId.d.ts

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

package/dist/types/AdminPurgeCommentView.d.ts

@@ -1,11 +0,0 @@
-import type { AdminPurgeComment } from "./AdminPurgeComment";
-import type { Person } from "./Person";
-import type { Post } from "./Post";
-/**
- * When an admin purges a comment.
- */
-export type AdminPurgeCommentView = {
-    admin_purge_comment: AdminPurgeComment;
-    admin?: Person;
-    post: Post;
-};

package/dist/types/AdminPurgeCommunity.d.ts

@@ -1,11 +0,0 @@
-import type { AdminPurgeCommunityId } from "./AdminPurgeCommunityId";
-import type { PersonId } from "./PersonId";
-/**
- * When an admin purges a community.
- */
-export type AdminPurgeCommunity = {
-    id: AdminPurgeCommunityId;
-    admin_person_id: PersonId;
-    reason?: string;
-    published_at: string;
-};

package/dist/types/AdminPurgeCommunityId.d.ts

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

package/dist/types/AdminPurgeCommunityView.d.ts

@@ -1,9 +0,0 @@
-import type { AdminPurgeCommunity } from "./AdminPurgeCommunity";
-import type { Person } from "./Person";
-/**
- * When an admin purges a community.
- */
-export type AdminPurgeCommunityView = {
-    admin_purge_community: AdminPurgeCommunity;
-    admin?: Person;
-};

package/dist/types/AdminPurgePerson.d.ts

@@ -1,11 +0,0 @@
-import type { AdminPurgePersonId } from "./AdminPurgePersonId";
-import type { PersonId } from "./PersonId";
-/**
- * When an admin purges a person.
- */
-export type AdminPurgePerson = {
-    id: AdminPurgePersonId;
-    admin_person_id: PersonId;
-    reason?: string;
-    published_at: string;
-};

package/dist/types/AdminPurgePersonId.d.ts

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

package/dist/types/AdminPurgePersonView.d.ts

@@ -1,9 +0,0 @@
-import type { AdminPurgePerson } from "./AdminPurgePerson";
-import type { Person } from "./Person";
-/**
- * When an admin purges a person.
- */
-export type AdminPurgePersonView = {
-    admin_purge_person: AdminPurgePerson;
-    admin?: Person;
-};

package/dist/types/AdminPurgePost.d.ts

@@ -1,13 +0,0 @@
-import type { AdminPurgePostId } from "./AdminPurgePostId";
-import type { CommunityId } from "./CommunityId";
-import type { PersonId } from "./PersonId";
-/**
- * When an admin purges a post.
- */
-export type AdminPurgePost = {
-    id: AdminPurgePostId;
-    admin_person_id: PersonId;
-    community_id: CommunityId;
-    reason?: string;
-    published_at: string;
-};

package/dist/types/AdminPurgePostId.d.ts

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

package/dist/types/AdminPurgePostView.d.ts

@@ -1,11 +0,0 @@
-import type { AdminPurgePost } from "./AdminPurgePost";
-import type { Community } from "./Community";
-import type { Person } from "./Person";
-/**
- * When an admin purges a post.
- */
-export type AdminPurgePostView = {
-    admin_purge_post: AdminPurgePost;
-    admin?: Person;
-    community: Community;
-};

package/dist/types/BanFromCommunityResponse.d.ts

@@ -1,8 +0,0 @@
-import type { PersonView } from "./PersonView";
-/**
- * The response for banning a user from a community.
- */
-export type BanFromCommunityResponse = {
-    person_view: PersonView;
-    banned: boolean;
-};

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

@@ -1,9 +0,0 @@
-import type { InstanceWithFederationState } from "./InstanceWithFederationState";
-/**
- * A list of federated instances.
- */
-export type FederatedInstances = {
-    linked: Array<InstanceWithFederationState>;
-    allowed: Array<InstanceWithFederationState>;
-    blocked: Array<InstanceWithFederationState>;
-};

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

package/dist/types/ModAddCommunity.d.ts

@@ -1,14 +0,0 @@
-import type { CommunityId } from "./CommunityId";
-import type { ModAddCommunityId } from "./ModAddCommunityId";
-import type { PersonId } from "./PersonId";
-/**
- * When someone is added as a community moderator.
- */
-export type ModAddCommunity = {
-    id: ModAddCommunityId;
-    mod_person_id: PersonId;
-    other_person_id: PersonId;
-    community_id: CommunityId;
-    removed: boolean;
-    published_at: string;
-};

package/dist/types/ModAddCommunityId.d.ts

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

package/dist/types/ModAddCommunityView.d.ts

@@ -1,12 +0,0 @@
-import type { Community } from "./Community";
-import type { ModAddCommunity } from "./ModAddCommunity";
-import type { Person } from "./Person";
-/**
- * When someone is added as a community moderator.
- */
-export type ModAddCommunityView = {
-    mod_add_community: ModAddCommunity;
-    moderator?: Person;
-    community: Community;
-    other_person: Person;
-};

package/dist/types/ModAddId.d.ts

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

package/dist/types/ModAddView.d.ts

@@ -1,10 +0,0 @@
-import type { ModAdd } from "./ModAdd";
-import type { Person } from "./Person";
-/**
- * When someone is added as a site moderator.
- */
-export type ModAddView = {
-    mod_add: ModAdd;
-    moderator?: Person;
-    other_person: Person;
-};