lemmy-js-client 1.0.0-post-tags.1 → 1.0.0-post-comment-combined-view.0

package/dist/types/RegistrationApplication.d.ts

@@ -11,4 +11,5 @@ export type RegistrationApplication = {
     admin_id?: PersonId;
     deny_reason?: string;
     published_at: string;
+    updated_at?: string;
 };

package/dist/types/RegistrationMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * The registration mode for your site. Determines what happens after a user signs up.
  */
-export type RegistrationMode = "Closed" | "RequireApplication" | "Open";
+export type RegistrationMode = "closed" | "require_application" | "open";

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

@@ -3,11 +3,11 @@ import type { CommunityReportView } from "./CommunityReportView";
 import type { PostReportView } from "./PostReportView";
 import type { PrivateMessageReportView } from "./PrivateMessageReportView";
 export type ReportCombinedView = ({
-    type_: "Post";
+    type_: "post";
 } & PostReportView) | ({
-    type_: "Comment";
+    type_: "comment";
 } & CommentReportView) | ({
-    type_: "PrivateMessage";
+    type_: "private_message";
 } & PrivateMessageReportView) | ({
-    type_: "Community";
+    type_: "community";
 } & CommunityReportView);

package/dist/types/ReportType.d.ts

@@ -1,4 +1,4 @@
 /**
  * A list of possible types for reports.
  */
-export type ReportType = "All" | "Posts" | "Comments" | "PrivateMessages" | "Communities";
+export type ReportType = "all" | "posts" | "comments" | "private_messages" | "communities";

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

@@ -8,6 +8,10 @@ import type { SearchType } from "./SearchType";
  * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
+    /**
+     * The search query. Can be a plain text, or an object ID which will be resolved
+     * (eg `https://lemmy.world/comment/1` or `!fediverse@lemmy.ml`).
+     */
     q: string;
     community_id?: CommunityId;
     community_name?: string;
@@ -29,6 +33,5 @@ export type Search = {
      */
     show_nsfw?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/SearchCombinedView.d.ts

@@ -4,13 +4,13 @@ import type { MultiCommunityView } from "./MultiCommunityView";
 import type { PersonView } from "./PersonView";
 import type { PostView } from "./PostView";
 export type SearchCombinedView = ({
-    type_: "Post";
+    type_: "post";
 } & PostView) | ({
-    type_: "Comment";
+    type_: "comment";
 } & CommentView) | ({
-    type_: "Community";
+    type_: "community";
 } & CommunityView) | ({
-    type_: "Person";
+    type_: "person";
 } & PersonView) | ({
-    type_: "MultiCommunity";
+    type_: "multi_community";
 } & MultiCommunityView);

package/dist/types/SearchResponse.d.ts

@@ -4,7 +4,17 @@ import type { SearchCombinedView } from "./SearchCombinedView";
  * The search response, containing lists of the return type possibilities
  */
 export type SearchResponse = {
-    results: Array<SearchCombinedView>;
+    /**
+     * If `Search.q` contains an ActivityPub ID (eg `https://lemmy.world/comment/1`) or an
+     * identifier (eg `!fediverse@lemmy.ml`) then this field contains the resolved object.
+     * It should always be shown above other search results.
+     */
+    resolve?: SearchCombinedView;
+    /**
+     * Items which contain the search string in post body, comment text, community sidebar etc.
+     * This is always empty when calling `/api/v4/resolve_object`
+     */
+    search: Array<SearchCombinedView>;
     /**
      * the pagination cursor to use to fetch the next page
      */

package/dist/types/SearchSortType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The search sort types.
  */
-export type SearchSortType = "New" | "Top" | "Old";
+export type SearchSortType = "new" | "top" | "old";

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" | "MultiCommunities";
+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 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,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/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,8 @@ 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>;
+    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

@@ -6,5 +6,8 @@ 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-post-tags.1",
+  "version": "1.0.0-post-comment-combined-view.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.13.1",
+  "packageManager": "pnpm@10.24.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/AdminListUsersResponse.d.ts

@@ -1,10 +0,0 @@
-import type { LocalUserView } from "./LocalUserView";
-import type { PaginationCursor } from "./PaginationCursor";
-export type AdminListUsersResponse = {
-    users: Array<LocalUserView>;
-    /**
-     * the pagination cursor to use to fetch the next page
-     */
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

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/BlockPersonResponse.js

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

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/CommentReply.js

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

package/dist/types/CommentReplyId.d.ts

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

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/FederatedInstances.js

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

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

@@ -1,10 +0,0 @@
-import type { CommentView } from "./CommentView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * The comment list response.
- */
-export type GetCommentsResponse = {
-    comments: Array<CommentView>;
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};

package/dist/types/GetCommentsResponse.js

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

package/dist/types/GetCommentsSlimResponse.d.ts

@@ -1,10 +0,0 @@
-import type { CommentSlimView } from "./CommentSlimView";
-import type { PaginationCursor } from "./PaginationCursor";
-/**
- * A slimmer comment list response, without the post or community.
- */
-export type GetCommentsSlimResponse = {
-    comments: Array<CommentSlimView>;
-    next_page?: PaginationCursor;
-    prev_page?: PaginationCursor;
-};