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

package/dist/types/LemmyErrorType.d.ts

@@ -1,10 +1,15 @@
-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_keywords";
+    error: "couldnt_update";
+} | {
+    error: "couldnt_create";
 } | {
     error: "report_reason_required";
 } | {
@@ -16,37 +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: "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";
 } | {
@@ -81,8 +83,6 @@ export type LemmyErrorType = {
     error: "registration_application_is_pending";
 } | {
     error: "locked";
-} | {
-    error: "couldnt_create_comment";
 } | {
     error: "max_comment_depth_reached";
 } | {
@@ -90,21 +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_languages";
-} | {
-    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";
 } | {
@@ -116,9 +110,9 @@ 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";
 } | {
@@ -132,8 +126,6 @@ export type LemmyErrorType = {
 } | {
     error: "invalid_email_address";
     message: string;
-} | {
-    error: "rate_limit_error";
 } | {
     error: "invalid_name";
 } | {
@@ -150,62 +142,18 @@ 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: "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_create_person_comment_mention";
-} | {
-    error: "couldnt_update_person_comment_mention";
-} | {
-    error: "couldnt_create_person_post_mention";
-} | {
-    error: "couldnt_update_person_post_mention";
+    error: "missing_totp_token";
 } | {
-    error: "couldnt_create_post";
+    error: "missing_totp_secret";
 } | {
-    error: "couldnt_create_private_message";
+    error: "incorrect_totp_token";
 } | {
-    error: "couldnt_update_private_message";
+    error: "totp_already_enabled";
 } | {
     error: "blocked_url";
 } | {
@@ -235,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";
 } | {
@@ -249,8 +193,6 @@ export type LemmyErrorType = {
     error: "invalid_unix_time";
 } | {
     error: "invalid_bot_action";
-} | {
-    error: "invalid_tag_name";
 } | {
     error: "tag_not_in_community";
 } | {
@@ -266,14 +208,8 @@ export type LemmyErrorType = {
     error: "oauth_login_failed";
 } | {
     error: "oauth_registration_closed";
-} | {
-    error: "couldnt_create_oauth_provider";
-} | {
-    error: "couldnt_update_oauth_provider";
 } | {
     error: "not_found";
-} | {
-    error: "community_has_no_followers";
 } | {
     error: "post_schedule_time_must_be_in_future";
 } | {
@@ -281,9 +217,9 @@ 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";
@@ -293,67 +229,13 @@ export type LemmyErrorType = {
 } | {
     error: "invalid_fetch_limit";
 } | {
-    error: "couldnt_create_comment_reply";
-} | {
-    error: "couldnt_update_comment_reply";
-} | {
-    error: "couldnt_mark_comment_reply_as_read";
-} | {
-    error: "couldnt_create_emoji";
-} | {
-    error: "couldnt_update_emoji";
-} | {
-    error: "couldnt_create_person";
-} | {
-    error: "couldnt_update_person";
-} | {
-    error: "couldnt_create_modlog";
-} | {
-    error: "couldnt_update_modlog";
-} | {
-    error: "couldnt_create_site";
-} | {
-    error: "couldnt_update_site";
-} | {
-    error: "couldnt_create_registration_application";
-} | {
-    error: "couldnt_update_registration_application";
-} | {
-    error: "couldnt_create_tag";
-} | {
-    error: "couldnt_update_tag";
-} | {
-    error: "couldnt_create_post_tag";
-} | {
-    error: "couldnt_update_post_tag";
-} | {
-    error: "couldnt_create_tagline";
-} | {
-    error: "couldnt_update_tagline";
-} | {
-    error: "couldnt_create_image";
-} | {
-    error: "couldnt_allow_instance";
-} | {
-    error: "couldnt_block_instance";
-} | {
-    error: "couldnt_insert_activity";
-} | {
-    error: "couldnt_create_rate_limit";
-} | {
-    error: "couldnt_create_captcha_answer";
-} | {
-    error: "couldnt_update_federation_queue_state";
-} | {
-    error: "couldnt_create_oauth_account";
-} | {
-    error: "couldnt_create_password_reset_request";
+    error: "email_notifications_disabled";
 } | {
-    error: "couldnt_create_login_token";
+    error: "multi_community_update_wrong_user";
 } | {
-    error: "couldnt_update_local_site_url_blocklist";
+    error: "cannot_combine_community_id_and_multi_community_id";
 } | {
-    error: "couldnt_create_email_verification";
+    error: "multi_community_entry_limit_reached";
 } | {
-    error: "email_notifications_disabled";
+    error: "too_many_requests";
 };

package/dist/types/LikeType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The like_type for a persons liked content.
  */
-export type LikeType = "All" | "LikedOnly" | "DislikedOnly";
+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/ListCommunityPendingFollows.d.ts

@@ -3,7 +3,7 @@ export type ListCommunityPendingFollows = {
     /**
      * Only shows the unapproved applications
      */
-    pending_only?: boolean;
+    unread_only?: boolean;
     all_communities?: boolean;
     page_cursor?: PaginationCursor;
     page_back?: boolean;

package/dist/types/ListCommunityPendingFollowsResponse.d.ts

@@ -1,7 +1,7 @@
 import type { PaginationCursor } from "./PaginationCursor";
-import type { PendingFollow } from "./PendingFollow";
+import type { PendingFollowerView } from "./PendingFollowerView";
 export type ListCommunityPendingFollowsResponse = {
-    items: Array<PendingFollow>;
+    items: Array<PendingFollowerView>;
     /**
      * the pagination cursor to use to fetch the next page
      */

package/dist/types/ListMultiCommunities.d.ts

@@ -0,0 +1,17 @@
+import type { MultiCommunityListingType } from "./MultiCommunityListingType";
+import type { MultiCommunitySortType } from "./MultiCommunitySortType";
+import type { PaginationCursor } from "./PaginationCursor";
+import type { PersonId } from "./PersonId";
+export type ListMultiCommunities = {
+    type_?: MultiCommunityListingType;
+    sort?: MultiCommunitySortType;
+    creator_id?: PersonId;
+    /**
+     * Filter to within a given time range, in seconds.
+     * IE 60 would give results for the past minute.
+     */
+    time_range_seconds?: number;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
+    limit?: number;
+};

package/dist/types/ListMultiCommunitiesResponse.d.ts

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

package/dist/types/{ListInbox.d.ts → ListNotifications.d.ts}

@@ -1,10 +1,10 @@
-import type { InboxDataType } from "./InboxDataType";
+import type { NotificationDataType } from "./NotificationDataType";
 import type { PaginationCursor } from "./PaginationCursor";
 /**
  * Get your inbox (replies, comment mentions, post mentions, and messages)
  */
-export type ListInbox = {
-    type_?: InboxDataType;
+export type ListNotifications = {
+    type_?: NotificationDataType;
     unread_only?: boolean;
     page_cursor?: PaginationCursor;
     page_back?: boolean;

package/dist/types/{ListInboxResponse.d.ts → ListNotificationsResponse.d.ts}

@@ -1,10 +1,10 @@
-import type { InboxCombinedView } from "./InboxCombinedView";
+import type { NotificationView } from "./NotificationView";
 import type { PaginationCursor } from "./PaginationCursor";
 /**
  * Get your inbox (replies, comment mentions, post mentions, and messages)
  */
-export type ListInboxResponse = {
-    inbox: Array<InboxCombinedView>;
+export type ListNotificationsResponse = {
+    notifications: Array<NotificationView>;
     /**
      * the pagination cursor to use to fetch the next page
      */

package/dist/types/ListingType.d.ts

@@ -1,4 +1,4 @@
 /**
  * A listing type for post and comment list fetches.
  */
-export type ListingType = "All" | "Local" | "Subscribed" | "ModeratorView";
+export type ListingType = "all" | "local" | "subscribed" | "moderator_view" | "suggested";

package/dist/types/LocalImage.d.ts

@@ -3,7 +3,7 @@ import type { PostId } from "./PostId";
 export type LocalImage = {
     pictrs_alias: string;
     published_at: string;
-    person_id: PersonId;
+    person_id?: PersonId;
     /**
      * This means the image is an auto-generated thumbnail, for a post.
      */

package/dist/types/LocalSite.d.ts

@@ -2,6 +2,7 @@ import type { CommentSortType } from "./CommentSortType";
 import type { FederationMode } from "./FederationMode";
 import type { ListingType } from "./ListingType";
 import type { LocalSiteId } from "./LocalSiteId";
+import type { MultiCommunityId } from "./MultiCommunityId";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { RegistrationMode } from "./RegistrationMode";
@@ -49,10 +50,6 @@ export type LocalSite = {
      * An optional regex to filter words.
      */
     slur_filter_regex?: string;
-    /**
-     * The max actor name length.
-     */
-    actor_name_max_length: number;
     /**
      * Whether federation is enabled.
      */
@@ -141,4 +138,6 @@ export type LocalSite = {
      * Dont send email notifications to users for new replies, mentions etc
      */
     disable_email_notifications: boolean;
+    suggested_communities?: MultiCommunityId;
+    default_items_per_page: number;
 };

package/dist/types/LocalSiteRateLimit.d.ts

@@ -4,20 +4,20 @@ import type { LocalSiteId } from "./LocalSiteId";
  */
 export type LocalSiteRateLimit = {
     local_site_id: LocalSiteId;
-    message: number;
-    message_per_second: number;
-    post: number;
-    post_per_second: number;
-    register: number;
-    register_per_second: number;
-    image: number;
-    image_per_second: number;
-    comment: number;
-    comment_per_second: number;
-    search: number;
-    search_per_second: number;
+    message_max_requests: number;
+    message_interval_seconds: number;
+    post_max_requests: number;
+    post_interval_seconds: number;
+    register_max_requests: number;
+    register_interval_seconds: number;
+    image_max_requests: number;
+    image_interval_seconds: number;
+    comment_max_requests: number;
+    comment_interval_seconds: number;
+    search_max_requests: number;
+    search_interval_seconds: number;
     published_at: string;
     updated_at?: string;
-    import_user_settings: number;
-    import_user_settings_per_second: number;
+    import_user_settings_max_requests: number;
+    import_user_settings_interval_seconds: number;
 };

package/dist/types/LocalUser.d.ts

@@ -63,33 +63,29 @@ export type LocalUser = {
      */
     post_listing_mode: PostListingMode;
     totp_2fa_enabled: boolean;
-    /**
-     * Whether to allow keyboard navigation (for browsing and interacting with posts and comments).
-     */
-    enable_keyboard_navigation: boolean;
     /**
      * Whether user avatars and inline images in the UI that are gifs should be allowed to play or
      * should be paused
      */
     enable_animated_images: boolean;
-    /**
-     * Whether a user can send / receive private messages
-     */
-    enable_private_messages: boolean;
     /**
      * Whether to auto-collapse bot comments.
      */
     collapse_bot_comments: boolean;
-    default_comment_sort_type: CommentSortType;
-    /**
-     * Whether to automatically mark fetched posts as read.
-     */
-    auto_mark_fetched_posts_as_read: boolean;
     /**
      * The last time a donation request was shown to this user. If this is more than a year ago,
      * a new notification request should be shown.
      */
     last_donation_notification_at: string;
+    /**
+     * Whether a user can send / receive private messages
+     */
+    enable_private_messages: boolean;
+    default_comment_sort_type: CommentSortType;
+    /**
+     * Whether to automatically mark fetched posts as read.
+     */
+    auto_mark_fetched_posts_as_read: boolean;
     /**
      * Whether to hide posts containing images/videos
      */
@@ -102,4 +98,6 @@ export type LocalUser = {
     show_upvotes: boolean;
     show_downvotes: VoteShow;
     show_upvote_percentage: boolean;
+    show_person_votes: boolean;
+    default_items_per_page: number;
 };

package/dist/types/LocalUserView.d.ts

@@ -1,4 +1,3 @@
-import type { InstanceActions } from "./InstanceActions";
 import type { LocalUser } from "./LocalUser";
 import type { Person } from "./Person";
 /**
@@ -7,5 +6,6 @@ import type { Person } from "./Person";
 export type LocalUserView = {
     local_user: LocalUser;
     person: Person;
-    instance_actions?: InstanceActions;
+    banned: boolean;
+    ban_expires_at?: string;
 };

package/dist/types/LockComment.d.ts

@@ -0,0 +1,9 @@
+import type { CommentId } from "./CommentId";
+/**
+ * Locks a comment and its children, IE prevents new replies.
+ */
+export type LockComment = {
+    comment_id: CommentId;
+    locked: boolean;
+    reason: string;
+};

package/dist/types/LockPost.d.ts

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

package/dist/types/Login.d.ts

@@ -12,4 +12,8 @@ export type Login = {
      * May be required, if totp is enabled for their account.
      */
     totp_2fa_token?: string;
+    /**
+     * If this is true the login is valid forever, otherwise it expires after one week.
+     */
+    stay_logged_in?: boolean;
 };

package/dist/types/MarkManyPostsAsRead.d.ts

@@ -4,4 +4,5 @@ import type { PostId } from "./PostId";
  */
 export type MarkManyPostsAsRead = {
     post_ids: Array<PostId>;
+    read: boolean;
 };

package/dist/types/MarkNotificationAsRead.d.ts

@@ -0,0 +1,8 @@
+import type { NotificationId } from "./NotificationId";
+/**
+ * Mark a comment reply as read.
+ */
+export type MarkNotificationAsRead = {
+    notification_id: NotificationId;
+    read: boolean;
+};

package/dist/types/ModEditPost.d.ts

@@ -0,0 +1,10 @@
+import type { PostId } from "./PostId";
+import type { TagId } from "./TagId";
+/**
+ * Mods can change some metadata for posts
+ */
+export type ModEditPost = {
+    post_id: PostId;
+    nsfw?: boolean;
+    tags?: Array<TagId>;
+};

package/dist/types/Modlog.d.ts

@@ -0,0 +1,10 @@
+import type { ModlogId } from "./ModlogId";
+import type { ModlogKind } from "./ModlogKind";
+export type Modlog = {
+    id: ModlogId;
+    kind: ModlogKind;
+    is_revert: boolean;
+    reason?: string;
+    expires_at?: string;
+    published_at: string;
+};

package/dist/types/ModlogId.d.ts

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

package/dist/types/ModlogKind.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A list of possible types for the various modlog actions.
+ */
+export type ModlogKind = "admin_add" | "admin_ban" | "admin_allow_instance" | "admin_block_instance" | "admin_purge_comment" | "admin_purge_community" | "admin_purge_person" | "admin_purge_post" | "mod_add_to_community" | "mod_ban_from_community" | "admin_feature_post_site" | "mod_feature_post_community" | "mod_change_community_visibility" | "mod_lock_post" | "mod_remove_comment" | "admin_remove_community" | "mod_remove_post" | "mod_transfer_community" | "mod_lock_comment";

package/dist/types/ModlogView.d.ts

@@ -0,0 +1,15 @@
+import type { Comment } from "./Comment";
+import type { Community } from "./Community";
+import type { Instance } from "./Instance";
+import type { Modlog } from "./Modlog";
+import type { Person } from "./Person";
+import type { Post } from "./Post";
+export type ModlogView = {
+    modlog: Modlog;
+    moderator?: Person;
+    target_person?: Person;
+    target_instance?: Instance;
+    target_community?: Community;
+    target_post?: Post;
+    target_comment?: Comment;
+};

package/dist/types/MultiCommunity.d.ts

@@ -0,0 +1,20 @@
+import type { DbUrl } from "./DbUrl";
+import type { InstanceId } from "./InstanceId";
+import type { MultiCommunityId } from "./MultiCommunityId";
+import type { PersonId } from "./PersonId";
+export type MultiCommunity = {
+    id: MultiCommunityId;
+    creator_id: PersonId;
+    instance_id: InstanceId;
+    name: string;
+    title?: string;
+    description?: string;
+    local: boolean;
+    deleted: boolean;
+    ap_id: DbUrl;
+    published_at: string;
+    updated_at?: string;
+    subscribers: number;
+    subscribers_local: number;
+    communities: number;
+};

package/dist/types/MultiCommunityEntry.d.ts

@@ -0,0 +1,6 @@
+import type { CommunityId } from "./CommunityId";
+import type { MultiCommunityId } from "./MultiCommunityId";
+export type MultiCommunityEntry = {
+    multi_community_id: MultiCommunityId;
+    community_id: CommunityId;
+};