lemmy-js-client 1.0.0-alpha.0 → 1.0.0-api-updates-3.0

package/dist/types/EditSite.d.ts

@@ -2,6 +2,7 @@ import type { CommentSortType } from "./CommentSortType";
 import type { FederationMode } from "./FederationMode";
 import type { LanguageId } from "./LanguageId";
 import type { ListingType } from "./ListingType";
+import type { MultiCommunityId } from "./MultiCommunityId";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { RegistrationMode } from "./RegistrationMode";
@@ -54,6 +55,10 @@ export type EditSite = {
      * 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"
      */
@@ -66,10 +71,6 @@ export type EditSite = {
      * Whether to email admins when receiving a new application.
      */
     application_email_admins?: boolean;
-    /**
-     * Whether to hide moderator names from the modlog.
-     */
-    hide_modlog_mod_names?: boolean;
     /**
      * A list of allowed discussion languages.
      */
@@ -78,40 +79,41 @@ export type EditSite = {
      * A regex string of items to filter.
      */
     slur_filter_regex?: string;
-    /**
-     * The max length of actor names.
-     */
-    actor_name_max_length?: number;
     /**
      * The number of messages allowed in a given time frame.
      */
-    rate_limit_message?: number;
-    rate_limit_message_per_second?: number;
+    rate_limit_message_max_requests?: number;
+    rate_limit_message_interval_seconds?: number;
     /**
      * The number of posts allowed in a given time frame.
      */
-    rate_limit_post?: number;
-    rate_limit_post_per_second?: number;
+    rate_limit_post_max_requests?: number;
+    rate_limit_post_interval_seconds?: number;
     /**
      * The number of registrations allowed in a given time frame.
      */
-    rate_limit_register?: number;
-    rate_limit_register_per_second?: number;
+    rate_limit_register_max_requests?: number;
+    rate_limit_register_interval_seconds?: number;
     /**
      * The number of image uploads allowed in a given time frame.
      */
-    rate_limit_image?: number;
-    rate_limit_image_per_second?: number;
+    rate_limit_image_max_requests?: number;
+    rate_limit_image_interval_seconds?: number;
     /**
      * The number of comments allowed in a given time frame.
      */
-    rate_limit_comment?: number;
-    rate_limit_comment_per_second?: number;
+    rate_limit_comment_max_requests?: number;
+    rate_limit_comment_interval_seconds?: number;
     /**
      * The number of searches allowed in a given time frame.
      */
-    rate_limit_search?: number;
-    rate_limit_search_per_second?: number;
+    rate_limit_search_max_requests?: number;
+    rate_limit_search_interval_seconds?: number;
+    /**
+     * The number of settings imports or exports allowed in a given time frame.
+     */
+    rate_limit_import_user_settings_max_requests?: number;
+    rate_limit_import_user_settings_interval_seconds?: number;
     /**
      * Whether to enable federation.
      */
@@ -158,13 +160,16 @@ export type EditSite = {
      * What kind of comment downvotes your site allows.
      */
     comment_downvotes?: FederationMode;
-    /**
-     * If this is true, users will never see the dialog asking to support Lemmy development with
-     * donations.
-     */
-    disable_donation_dialog?: boolean;
     /**
      * Block NSFW content being created
      */
     disallow_nsfw_content?: boolean;
+    /**
+     * Dont send email notifications to users for new replies, mentions etc
+     */
+    disable_email_notifications?: boolean;
+    /**
+     * A multicommunity with suggested communities which is shown on the homepage
+     */
+    suggested_communities?: MultiCommunityId;
 };

package/dist/types/ExportDataResponse.d.ts

@@ -0,0 +1,13 @@
+import type { PostOrCommentOrPrivateMessage } from "./PostOrCommentOrPrivateMessage";
+import type { UserSettingsBackup } from "./UserSettingsBackup";
+/**
+ * Your exported data.
+ */
+export type ExportDataResponse = {
+    notifications: Array<PostOrCommentOrPrivateMessage>;
+    content: Array<PostOrCommentOrPrivateMessage>;
+    read_posts: Array<string>;
+    liked: Array<string>;
+    moderates: Array<string>;
+    settings: UserSettingsBackup;
+};

package/dist/types/FederationBlockList.d.ts

@@ -1,7 +1,7 @@
 import type { InstanceId } from "./InstanceId";
 export type FederationBlockList = {
     instance_id: InstanceId;
-    published: string;
-    updated?: string;
-    expires?: string;
+    published_at: string;
+    updated_at?: string;
+    expires_at?: string;
 };

package/dist/types/FederationMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * The federation mode for an item
  */
-export type FederationMode = "All" | "Local" | "Disable";
+export type FederationMode = "all" | "local" | "disable";

package/dist/types/FollowMultiCommunity.d.ts

@@ -0,0 +1,5 @@
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type FollowMultiCommunity = {
+    multi_community_id: MultiCommunityId;
+    follow: boolean;
+};

package/dist/types/GetComments.d.ts

@@ -2,6 +2,7 @@ import type { CommentId } from "./CommentId";
 import type { CommentSortType } from "./CommentSortType";
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PostId } from "./PostId";
 /**
  * Get a list of comments.
@@ -15,12 +16,11 @@ export type GetComments = {
      */
     time_range_seconds?: number;
     max_depth?: number;
-    page?: number;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
     limit?: number;
     community_id?: CommunityId;
     community_name?: string;
     post_id?: PostId;
     parent_id?: CommentId;
-    liked_only?: boolean;
-    disliked_only?: boolean;
 };

package/dist/types/GetCommentsResponse.d.ts

@@ -1,7 +1,10 @@
 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/GetCommentsSlimResponse.d.ts

@@ -1,7 +1,10 @@
 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;
 };

package/dist/types/GetModlog.d.ts

@@ -40,4 +40,5 @@ export type GetModlog = {
     comment_id?: CommentId;
     page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/GetModlogResponse.d.ts

@@ -9,4 +9,5 @@ export type GetModlogResponse = {
      * the pagination cursor to use to fetch the next page
      */
     next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/GetMultiCommunity.d.ts

@@ -0,0 +1,5 @@
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type GetMultiCommunity = {
+    id?: MultiCommunityId;
+    name?: string;
+};

package/dist/types/GetMultiCommunityResponse.d.ts

@@ -0,0 +1,6 @@
+import type { CommunityView } from "./CommunityView";
+import type { MultiCommunityView } from "./MultiCommunityView";
+export type GetMultiCommunityResponse = {
+    multi_community_view: MultiCommunityView;
+    communities: Array<CommunityView>;
+};

package/dist/types/GetPosts.d.ts

@@ -1,6 +1,7 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
-import type { PostPaginationCursor } from "./PostPaginationCursor";
+import type { MultiCommunityId } from "./MultiCommunityId";
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PostSortType } from "./PostSortType";
 /**
  * Get a list of posts.
@@ -14,17 +15,9 @@ export type GetPosts = {
      * Use Zero to override the local_site and local_user time_range.
      */
     time_range_seconds?: number;
-    /**
-     * DEPRECATED, use page_cursor
-     */
-    page?: number;
-    limit?: number;
     community_id?: CommunityId;
     community_name?: string;
-    saved_only?: boolean;
-    read_only?: boolean;
-    liked_only?: boolean;
-    disliked_only?: boolean;
+    multi_community_id?: MultiCommunityId;
     show_hidden?: boolean;
     /**
      * If true, then show the read posts (even if your user setting is to hide them)
@@ -46,6 +39,7 @@ export type GetPosts = {
      * If true, then only show posts with no comments
      */
     no_comments_only?: boolean;
-    page_cursor?: PostPaginationCursor;
+    page_cursor?: PaginationCursor;
     page_back?: boolean;
+    limit?: number;
 };

package/dist/types/GetPostsResponse.d.ts

@@ -1,4 +1,4 @@
-import type { PostPaginationCursor } from "./PostPaginationCursor";
+import type { PaginationCursor } from "./PaginationCursor";
 import type { PostView } from "./PostView";
 /**
  * The post list response.
@@ -8,5 +8,6 @@ export type GetPostsResponse = {
     /**
      * the pagination cursor to use to fetch the next page
      */
-    next_page?: PostPaginationCursor;
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };

package/dist/types/GetSiteResponse.d.ts

@@ -3,6 +3,7 @@ import type { LanguageId } from "./LanguageId";
 import type { LocalSiteUrlBlocklist } from "./LocalSiteUrlBlocklist";
 import type { OAuthProvider } from "./OAuthProvider";
 import type { PersonView } from "./PersonView";
+import type { PluginMetadata } from "./PluginMetadata";
 import type { PublicOAuthProvider } from "./PublicOAuthProvider";
 import type { SiteView } from "./SiteView";
 import type { Tagline } from "./Tagline";
@@ -26,4 +27,5 @@ export type GetSiteResponse = {
     admin_oauth_providers: Array<OAuthProvider>;
     blocked_urls: Array<LocalSiteUrlBlocklist>;
     image_upload_disabled: boolean;
+    active_plugins: Array<PluginMetadata>;
 };

package/dist/types/HideCommunity.d.ts

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

package/dist/types/Instance.d.ts

@@ -1,15 +1,16 @@
 import type { InstanceId } from "./InstanceId";
 /**
- * A federated instance / site.
+ * Basic data about a Fediverse instance which is available for every known domain. Additional
+ * data may be available in [[Site]].
  */
 export type Instance = {
     id: InstanceId;
     domain: string;
-    published: string;
+    published_at: string;
     /**
      * When the instance was updated.
      */
-    updated?: string;
+    updated_at?: string;
     /**
      * The software of the instance.
      */

package/dist/types/InstanceActions.d.ts

@@ -1,10 +1,18 @@
-import type { InstanceId } from "./InstanceId";
-import type { PersonId } from "./PersonId";
 export type InstanceActions = {
-    person_id: PersonId;
-    instance_id: InstanceId;
     /**
-     * When the instance was blocked.
+     * When the instance's communities were blocked.
      */
-    blocked?: string;
+    blocked_communities_at?: string;
+    /**
+     * When this user received a site ban.
+     */
+    received_ban_at?: string;
+    /**
+     * When their ban expires.
+     */
+    ban_expires_at?: string;
+    /**
+     * When the instance's persons were blocked.
+     */
+    blocked_persons_at?: string;
 };

package/dist/types/InstanceActions.js

@@ -1,2 +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/InstanceWithFederationState.d.ts

@@ -8,11 +8,11 @@ export type InstanceWithFederationState = {
     federation_state?: ReadableFederationState;
     id: InstanceId;
     domain: string;
-    published: string;
+    published_at: string;
     /**
      * When the instance was updated.
      */
-    updated?: string;
+    updated_at?: string;
     /**
      * The software of the instance.
      */

package/dist/types/LemmyErrorType.d.ts

@@ -1,5 +1,16 @@
-import type { FederationError } from "./FederationError";
+import type { UntranslatedError } from "./UntranslatedError";
+/**
+ * Errors used in the API, all of these are translated in lemmy-ui.
+ */
 export type LemmyErrorType = {
+    error: "block_keyword_too_short";
+} | {
+    error: "block_keyword_too_long";
+} | {
+    error: "couldnt_update";
+} | {
+    error: "couldnt_create";
+} | {
     error: "report_reason_required";
 } | {
     error: "report_too_long";
@@ -10,39 +21,34 @@ export type LemmyErrorType = {
 } | {
     error: "cant_block_yourself";
 } | {
-    error: "cant_block_admin";
+    error: "cant_note_yourself";
 } | {
-    error: "couldnt_update_user";
+    error: "cant_block_admin";
 } | {
     error: "passwords_do_not_match";
 } | {
     error: "email_not_verified";
 } | {
     error: "email_required";
-} | {
-    error: "couldnt_update_comment";
-} | {
-    error: "couldnt_update_private_message";
 } | {
     error: "cannot_leave_admin";
+} | {
+    error: "cannot_leave_mod";
 } | {
     error: "pictrs_response_error";
     message: string;
 } | {
     error: "pictrs_purge_response_error";
     message: string;
-} | {
-    error: "image_url_missing_path_segments";
-} | {
-    error: "image_url_missing_last_path_segment";
 } | {
     error: "pictrs_api_key_not_provided";
+} | {
+    error: "pictrs_invalid_image_upload";
+    message: string;
 } | {
     error: "no_content_type_header";
 } | {
     error: "not_an_image_type";
-} | {
-    error: "invalid_image_upload";
 } | {
     error: "image_upload_disabled";
 } | {
@@ -75,12 +81,8 @@ export type LemmyErrorType = {
     error: "honeypot_failed";
 } | {
     error: "registration_application_is_pending";
-} | {
-    error: "cant_enable_private_instance_and_federation_together";
 } | {
     error: "locked";
-} | {
-    error: "couldnt_create_comment";
 } | {
     error: "max_comment_depth_reached";
 } | {
@@ -88,19 +90,15 @@ export type LemmyErrorType = {
 } | {
     error: "only_admins_can_create_communities";
 } | {
-    error: "community_already_exists";
+    error: "already_exists";
 } | {
     error: "language_not_allowed";
-} | {
-    error: "couldnt_update_post";
 } | {
     error: "no_post_edit_allowed";
 } | {
     error: "nsfw_not_allowed";
 } | {
     error: "edit_private_message_not_allowed";
-} | {
-    error: "site_already_exists";
 } | {
     error: "application_question_required";
 } | {
@@ -112,17 +110,15 @@ export type LemmyErrorType = {
 } | {
     error: "registration_username_required";
 } | {
-    error: "email_already_exists";
+    error: "email_already_taken";
 } | {
-    error: "username_already_exists";
+    error: "username_already_taken";
 } | {
     error: "person_is_banned_from_community";
 } | {
     error: "no_id_given";
 } | {
     error: "incorrect_login";
-} | {
-    error: "object_not_local";
 } | {
     error: "no_email_setup";
 } | {
@@ -130,8 +126,6 @@ export type LemmyErrorType = {
 } | {
     error: "invalid_email_address";
     message: string;
-} | {
-    error: "rate_limit_error";
 } | {
     error: "invalid_name";
 } | {
@@ -148,72 +142,20 @@ export type LemmyErrorType = {
     error: "bio_length_overflow";
 } | {
     error: "alt_text_length_overflow";
-} | {
-    error: "missing_totp_token";
-} | {
-    error: "missing_totp_secret";
-} | {
-    error: "incorrect_totp_token";
 } | {
     error: "couldnt_parse_totp_secret";
 } | {
     error: "couldnt_generate_totp";
 } | {
-    error: "totp_already_enabled";
-} | {
-    error: "couldnt_like_comment";
-} | {
-    error: "couldnt_save_comment";
-} | {
-    error: "couldnt_create_report";
-} | {
-    error: "couldnt_resolve_report";
-} | {
-    error: "community_moderator_already_exists";
-} | {
-    error: "community_user_already_banned";
-} | {
-    error: "community_block_already_exists";
-} | {
-    error: "community_follower_already_exists";
-} | {
-    error: "person_block_already_exists";
-} | {
-    error: "user_already_exists";
-} | {
-    error: "couldnt_like_post";
-} | {
-    error: "couldnt_save_post";
-} | {
-    error: "couldnt_mark_post_as_read";
-} | {
-    error: "couldnt_update_read_comments";
-} | {
-    error: "couldnt_hide_post";
-} | {
-    error: "couldnt_update_community";
-} | {
-    error: "couldnt_update_replies";
-} | {
-    error: "couldnt_update_person_comment_mentions";
-} | {
-    error: "couldnt_create_post";
-} | {
-    error: "couldnt_create_private_message";
-} | {
-    error: "couldnt_update_private";
+    error: "missing_totp_token";
 } | {
-    error: "system_err_login";
+    error: "missing_totp_secret";
 } | {
-    error: "couldnt_set_all_registrations_accepted";
+    error: "incorrect_totp_token";
 } | {
-    error: "couldnt_set_all_email_verified";
+    error: "totp_already_enabled";
 } | {
     error: "blocked_url";
-} | {
-    error: "couldnt_get_comments";
-} | {
-    error: "couldnt_get_posts";
 } | {
     error: "invalid_url";
 } | {
@@ -241,12 +183,8 @@ export type LemmyErrorType = {
     error: "couldnt_create_image_captcha";
 } | {
     error: "invalid_url_scheme";
-} | {
-    error: "couldnt_send_webmention";
 } | {
     error: "contradicting_filters";
-} | {
-    error: "instance_block_already_exists";
 } | {
     error: "too_many_items";
 } | {
@@ -255,6 +193,8 @@ export type LemmyErrorType = {
     error: "invalid_unix_time";
 } | {
     error: "invalid_bot_action";
+} | {
+    error: "tag_not_in_community";
 } | {
     error: "cant_block_local_instance";
 } | {
@@ -268,12 +208,8 @@ export type LemmyErrorType = {
     error: "oauth_login_failed";
 } | {
     error: "oauth_registration_closed";
-} | {
-    error: "couldnt_delete_oauth_provider";
 } | {
     error: "not_found";
-} | {
-    error: "community_has_no_followers";
 } | {
     error: "post_schedule_time_must_be_in_future";
 } | {
@@ -281,10 +217,25 @@ export type LemmyErrorType = {
 } | {
     error: "cannot_combine_federation_blocklist_and_allowlist";
 } | {
-    error: "federation_error";
+    error: "untranslated_error";
     message: {
-        error?: FederationError;
+        error?: UntranslatedError;
     };
 } | {
     error: "couldnt_parse_pagination_token";
+} | {
+    error: "plugin_error";
+    message: string;
+} | {
+    error: "invalid_fetch_limit";
+} | {
+    error: "email_notifications_disabled";
+} | {
+    error: "multi_community_update_wrong_user";
+} | {
+    error: "cannot_combine_community_id_and_multi_community_id";
+} | {
+    error: "multi_community_entry_limit_reached";
+} | {
+    error: "too_many_requests";
 };

package/dist/types/LikeType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The like_type for a persons liked content.
+ */
+export type LikeType = "all" | "liked_only" | "disliked_only";

package/dist/types/LinkMetadata.d.ts

@@ -7,5 +7,9 @@ export type LinkMetadata = {
     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/ListCommentLikes.d.ts

@@ -1,9 +1,11 @@
 import type { CommentId } from "./CommentId";
+import type { PaginationCursor } from "./PaginationCursor";
 /**
  * List comment likes. Admins-only.
  */
 export type ListCommentLikes = {
     comment_id: CommentId;
-    page?: number;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListCommentLikesResponse.d.ts

@@ -1,7 +1,13 @@
+import type { PaginationCursor } from "./PaginationCursor";
 import type { VoteView } from "./VoteView";
 /**
  * The comment likes response
  */
 export type ListCommentLikesResponse = {
     comment_likes: Array<VoteView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
 };