lemmy-js-client 1.0.0-instance-user-blocking.7 → 1.0.0-invite.1

package/dist/types/PrivateMessage.d.ts

@@ -15,4 +15,5 @@ export type PrivateMessage = {
     ap_id: DbUrl;
     local: boolean;
     removed: boolean;
+    deleted_by_recipient: boolean;
 };

package/dist/types/PrivateMessageReport.d.ts

@@ -17,4 +17,5 @@ export type PrivateMessageReport = {
     resolver_id?: PersonId;
     published_at: string;
     updated_at?: string;
+    conclusion?: 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/PublicOAuthProvider.d.ts

@@ -1,2 +1,27 @@
-import type { OAuthProvider } from "./OAuthProvider";
-export type PublicOAuthProvider = OAuthProvider;
+import type { OAuthProviderId } from "./OAuthProviderId";
+export type PublicOAuthProvider = {
+    id: OAuthProviderId;
+    /**
+     * The OAuth 2.0 provider name displayed to the user on the Login page
+     */
+    display_name: string;
+    /**
+     * The authorization endpoint is used to interact with the resource owner and obtain an
+     * authorization grant. This is usually provided by the OAUTH provider.
+     */
+    authorization_endpoint: string;
+    /**
+     * The client_id is provided by the OAuth 2.0 provider and is a unique identifier to this
+     * service
+     */
+    client_id: string;
+    /**
+     * Lists the scopes requested from users. Users will have to grant access to the requested scope
+     * at sign up.
+     */
+    scopes: string;
+    /**
+     * switch to enable or disable PKCE
+     */
+    use_pkce: boolean;
+};

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

@@ -27,4 +27,12 @@ export type Register = {
      * An answer is mandatory if require application is enabled on the server
      */
     answer?: string;
+    /**
+     * If this is true the login is valid forever, otherwise it expires after one week.
+     */
+    stay_logged_in?: boolean;
+    /**
+     * Invitation token
+     */
+    token?: string;
 };

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" | "require_invitation" | "open";

package/dist/types/RemoveComment.d.ts

@@ -5,5 +5,10 @@ import type { CommentId } from "./CommentId";
 export type RemoveComment = {
     comment_id: CommentId;
     removed: boolean;
-    reason?: string;
+    reason: string;
+    /**
+     * Setting this will override whatever `removed` was set to,
+     * leave as null or unset to act just on the comment itself.
+     */
+    remove_children?: boolean;
 };

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,10 @@ import type { PostId } from "./PostId";
 export type RemovePost = {
     post_id: PostId;
     removed: boolean;
-    reason?: string;
+    reason: string;
+    /**
+     * Setting this will override whatever `removed` was set to,
+     * leave as null or unset to act just on the post itself.
+     */
+    remove_children?: boolean;
 };

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

@@ -0,0 +1,4 @@
+/**
+ * The Report sort type.
+ */
+export type ReportSortType = "default" | "new" | "old";

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/{PasswordReset.d.ts → ResetPassword.d.ts}

@@ -2,6 +2,6 @@ import type { SensitiveString } from "./SensitiveString";
 /**
  * Reset your password via email.
  */
-export type PasswordReset = {
+export type ResetPassword = {
     email: SensitiveString;
 };

package/dist/types/ResolveCommentReport.d.ts

@@ -5,4 +5,5 @@ import type { CommentReportId } from "./CommentReportId";
 export type ResolveCommentReport = {
     report_id: CommentReportId;
     resolved: boolean;
+    conclusion?: string;
 };

package/dist/types/ResolveCommunityReport.d.ts

@@ -5,4 +5,5 @@ import type { CommunityReportId } from "./CommunityReportId";
 export type ResolveCommunityReport = {
     report_id: CommunityReportId;
     resolved: boolean;
+    conclusion?: string;
 };

package/dist/types/{SearchCombinedView.d.ts → ResolveObjectView.d.ts}

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

package/dist/types/ResolvePostReport.d.ts

@@ -5,4 +5,5 @@ import type { PostReportId } from "./PostReportId";
 export type ResolvePostReport = {
     report_id: PostReportId;
     resolved: boolean;
+    conclusion?: string;
 };

package/dist/types/ResolvePrivateMessageReport.d.ts

@@ -5,4 +5,5 @@ import type { PrivateMessageReportId } from "./PrivateMessageReportId";
 export type ResolvePrivateMessageReport = {
     report_id: PrivateMessageReportId;
     resolved: boolean;
+    conclusion?: string;
 };

package/dist/types/RevokeInvitation.d.ts

@@ -0,0 +1,3 @@
+export type RevokeInvitation = {
+    token: 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"
      */
@@ -65,6 +69,10 @@ export type SaveUserSettings = {
      * Whether to show or hide avatars.
      */
     show_avatars?: boolean;
+    /**
+     * Whether to show media in the UI.
+     */
+    show_media?: boolean;
     /**
      * Sends notifications to your email.
      */
@@ -94,19 +102,15 @@ 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
      */
-    enable_animated_images?: boolean;
+    animated_images_enabled?: boolean;
     /**
      * Whether a user can send / receive private messages
      */
-    enable_private_messages?: boolean;
+    private_messages_enabled?: boolean;
     /**
      * Whether to auto-collapse bot comments.
      */
@@ -114,7 +118,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;
@@ -123,9 +127,9 @@ export type SaveUserSettings = {
      */
     auto_mark_fetched_posts_as_read?: boolean;
     /**
-     * Whether to hide posts containing images/videos.
+     * Whether to hide posts containing images/videos. Often labeled hide_memes.
      */
-    hide_media?: boolean;
+    hide_posts_with_media?: boolean;
     /**
      * Whether to show vote totals given to others.
      */

package/dist/types/Search.d.ts

@@ -2,18 +2,21 @@ import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { PaginationCursor } from "./PaginationCursor";
 import type { PersonId } from "./PersonId";
-import type { SearchSortType } from "./SearchSortType";
 import type { SearchType } from "./SearchType";
 /**
  * Searches the site, given a search term, and some optional filters.
  */
 export type Search = {
-    q: string;
+    /**
+     * 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`).
+     */
+    search_term: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;
+    creator_username?: string;
     type_?: SearchType;
-    sort?: SearchSortType;
     /**
      * Filter to within a given time range, in seconds.
      * IE 60 would give results for the past minute.
@@ -22,13 +25,10 @@ export type Search = {
     listing_type?: ListingType;
     title_only?: boolean;
     post_url_only?: boolean;
-    liked_only?: boolean;
-    disliked_only?: boolean;
     /**
      * If true, then show the nsfw posts (even if your user setting is to hide them)
      */
     show_nsfw?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/SearchResponse.d.ts

@@ -1,13 +1,25 @@
+import type { CommentView } from "./CommentView";
+import type { CommunityView } from "./CommunityView";
+import type { MultiCommunityView } from "./MultiCommunityView";
 import type { PaginationCursor } from "./PaginationCursor";
-import type { SearchCombinedView } from "./SearchCombinedView";
+import type { PersonView } from "./PersonView";
+import type { PostView } from "./PostView";
+import type { ResolveObjectView } from "./ResolveObjectView";
 /**
  * The search response, containing lists of the return type possibilities
  */
 export type SearchResponse = {
-    results: Array<SearchCombinedView>;
     /**
-     * the pagination cursor to use to fetch the next page
+     * If `Search.search_term` 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.
      */
-    next_page?: PaginationCursor;
+    resolve?: ResolveObjectView;
+    comments: Array<CommentView>;
+    posts: Array<PostView>;
+    communities: Array<CommunityView>;
+    persons: Array<PersonView>;
+    multi_communities: Array<MultiCommunityView>;
     prev_page?: PaginationCursor;
+    next_page?: PaginationCursor;
 };

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

@@ -23,9 +23,9 @@ export type Site = {
      */
     banner?: DbUrl;
     /**
-     * A shorter, one-line description of the site.
+     * A shorter, one-line summary of the site.
      */
-    description?: string;
+    summary?: string;
     /**
      * The federated ap_id.
      */
@@ -38,7 +38,6 @@ export type Site = {
      * The site inbox
      */
     inbox_url: DbUrl;
-    public_key: string;
     instance_id: InstanceId;
     /**
      * If present, nsfw content is visible by default. Should be displayed by frontends/clients

package/dist/types/TagColor.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Color of community tag.
+ */
+export type TagColor = "color01" | "color02" | "color03" | "color04" | "color05" | "color06" | "color07" | "color08" | "color09" | "color10";

package/dist/types/UnreadCountsResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Contains the amount of unread items of various types. For normal users this means the number of
+ * unread notifications, mods and admins get additional unread counts for reports, registration
+ * applications and pending follows to private communities.
+ */
+export type UnreadCountsResponse = {
+    notification_count: number;
+    report_count?: number;
+    pending_follow_count?: number;
+    registration_application_count?: number;
+};

package/dist/types/UserSettingsBackup.d.ts

@@ -22,10 +22,8 @@ export type UserSettingsBackup = {
     saved_comments: Array<string>;
     blocked_communities: Array<string>;
     blocked_users: Array<string>;
-    /**
-     * Only kept for v0.19 compatibility
-     */
-    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-instance-user-blocking.7",
+  "version": "1.0.0-invite.1",
   "author": "Dessalines",
   "license": "AGPL-3.0",
   "main": "./dist/index.js",
@@ -13,7 +13,7 @@
     "docs": "typedoc src/index.ts",
     "lint": "tsc --noEmit && eslint --report-unused-disable-directives && prettier --check src",
     "prepare": "pnpm run build && husky",
-    "tsoa": "tsoa spec-and-routes && tsc && redocly build-docs tsoa_build/swagger.json"
+    "tsoa": "./scripts/tsoa.sh"
   },
   "repository": {
     "type": "git",
@@ -23,27 +23,28 @@
     "@tsoa/runtime": "^6.6.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.20.0",
-    "@redocly/cli": "^1.27.2",
-    "@types/node": "^22.7.4",
+    "@eslint/js": "^10.0.0",
+    "@redocly/cli": "^2.0.0",
+    "@types/node": "^24.0.0",
     "@typescript-eslint/eslint-plugin": "^8.7.0",
     "@typescript-eslint/parser": "^8.7.0",
-    "eslint": "^9.11.1",
+    "ajv": "^8.17.1",
+    "eslint": "^10.0.0",
     "eslint-plugin-prettier": "^5.2.1",
     "husky": "^9.1.4",
-    "joi": "^17.13.3",
-    "lint-staged": "^16.0.0",
+    "joi": "^18.0.0",
+    "lint-staged": "^17.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",
+    "prettier-plugin-packagejson": "^3.0.0",
+    "sortpack": "^4.0.0",
     "tsoa": "^6.6.0",
     "typedoc": "^0.28.0",
-    "typescript": "^5.5.4",
+    "typescript": "^6.0.0",
     "typescript-eslint": "^8.7.0"
   },
-  "packageManager": "pnpm@10.13.1",
+  "packageManager": "pnpm@11.18.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;
-};