lemmy-js-client 1.0.0-rename-rate-limit-columns.1 → 1.0.0-rename-paged-response-data.0

package/dist/types/ListCommentLikes.d.ts

@@ -6,6 +6,5 @@ import type { PaginationCursor } from "./PaginationCursor";
 export type ListCommentLikes = {
     comment_id: CommentId;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListCommunities.d.ts

@@ -14,6 +14,5 @@ export type ListCommunities = {
     time_range_seconds?: number;
     show_nsfw?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListCommunityPendingFollows.d.ts

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

package/dist/types/ListMedia.d.ts

@@ -4,6 +4,5 @@ import type { PaginationCursor } from "./PaginationCursor";
  */
 export type ListMedia = {
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListMultiCommunities.d.ts

@@ -1,5 +1,16 @@
+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;
-    followed_only?: boolean;
+    /**
+     * 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;
+    limit?: number;
 };

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

@@ -1,12 +1,11 @@
-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;
     limit?: number;
 };

package/dist/types/ListPersonContent.d.ts

@@ -14,6 +14,5 @@ export type ListPersonContent = {
      */
     username?: string;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonHidden.d.ts

@@ -4,6 +4,5 @@ import type { PaginationCursor } from "./PaginationCursor";
  */
 export type ListPersonHidden = {
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonLiked.d.ts

@@ -8,6 +8,5 @@ export type ListPersonLiked = {
     type_?: PersonContentType;
     like_type?: LikeType;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonRead.d.ts

@@ -4,6 +4,5 @@ import type { PaginationCursor } from "./PaginationCursor";
  */
 export type ListPersonRead = {
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPersonSaved.d.ts

@@ -6,6 +6,5 @@ import type { PersonContentType } from "./PersonContentType";
 export type ListPersonSaved = {
     type_?: PersonContentType;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListPostLikes.d.ts

@@ -6,6 +6,5 @@ import type { PostId } from "./PostId";
 export type ListPostLikes = {
     post_id: PostId;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListRegistrationApplications.d.ts

@@ -8,6 +8,5 @@ export type ListRegistrationApplications = {
      */
     unread_only?: boolean;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

package/dist/types/ListReports.d.ts

@@ -23,7 +23,6 @@ export type ListReports = {
      */
     community_id?: CommunityId;
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
     /**
      * Only for admins: also show reports with `violates_instance_rules=false`

package/dist/types/ListTaglines.d.ts

@@ -4,6 +4,5 @@ import type { PaginationCursor } from "./PaginationCursor";
  */
 export type ListTaglines = {
     page_cursor?: PaginationCursor;
-    page_back?: boolean;
     limit?: number;
 };

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" | "Suggested";
+export type ListingType = "all" | "local" | "subscribed" | "moderator_view" | "suggested";

package/dist/types/LocalSite.d.ts

@@ -3,7 +3,6 @@ import type { FederationMode } from "./FederationMode";
 import type { ListingType } from "./ListingType";
 import type { LocalSiteId } from "./LocalSiteId";
 import type { MultiCommunityId } from "./MultiCommunityId";
-import type { PersonId } from "./PersonId";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { RegistrationMode } from "./RegistrationMode";
@@ -51,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.
      */
@@ -144,5 +139,5 @@ export type LocalSite = {
      */
     disable_email_notifications: boolean;
     suggested_communities?: MultiCommunityId;
-    multi_comm_follower: PersonId;
+    default_items_per_page: 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

@@ -7,4 +7,5 @@ export type LocalUserView = {
     local_user: LocalUser;
     person: Person;
     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

@@ -14,4 +14,7 @@ export type MultiCommunity = {
     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;
+};

package/dist/types/MultiCommunityListingType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A listing type for multi-community fetches.
+ */
+export type MultiCommunityListingType = "all" | "local" | "subscribed";

package/dist/types/MultiCommunityResponse.d.ts

@@ -0,0 +1,4 @@
+import type { MultiCommunityView } from "./MultiCommunityView";
+export type MultiCommunityResponse = {
+    multi_community_view: MultiCommunityView;
+};

package/dist/types/MultiCommunitySortType.d.ts

@@ -0,0 +1 @@
+export type MultiCommunitySortType = "new" | "old" | "name_asc" | "name_desc" | "communities" | "subscribers" | "subscribers_local";

package/dist/types/MultiCommunityView.d.ts

@@ -1,6 +1,8 @@
+import type { CommunityFollowerState } from "./CommunityFollowerState";
 import type { MultiCommunity } from "./MultiCommunity";
 import type { Person } from "./Person";
 export type MultiCommunityView = {
     multi: MultiCommunity;
+    follow_state?: CommunityFollowerState;
     owner: Person;
 };

package/dist/types/MyUserInfo.d.ts

@@ -4,6 +4,7 @@ import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { Instance } from "./Instance";
 import type { LanguageId } from "./LanguageId";
 import type { LocalUserView } from "./LocalUserView";
+import type { MultiCommunityView } from "./MultiCommunityView";
 import type { Person } from "./Person";
 /**
  * Your user info.
@@ -12,8 +13,10 @@ export type MyUserInfo = {
     local_user_view: LocalUserView;
     follows: Array<CommunityFollowerView>;
     moderates: Array<CommunityModeratorView>;
+    multi_community_follows: Array<MultiCommunityView>;
     community_blocks: Array<Community>;
-    instance_blocks: Array<Instance>;
+    instance_communities_blocks: Array<Instance>;
+    instance_persons_blocks: Array<Instance>;
     person_blocks: Array<Person>;
     keyword_blocks: Array<string>;
     discussion_languages: Array<LanguageId>;

package/dist/types/Notification.d.ts

@@ -0,0 +1,18 @@
+import type { CommentId } from "./CommentId";
+import type { ModlogId } from "./ModlogId";
+import type { NotificationId } from "./NotificationId";
+import type { NotificationType } from "./NotificationType";
+import type { PersonId } from "./PersonId";
+import type { PostId } from "./PostId";
+import type { PrivateMessageId } from "./PrivateMessageId";
+export type Notification = {
+    id: NotificationId;
+    recipient_id: PersonId;
+    comment_id?: CommentId;
+    read: boolean;
+    published_at: string;
+    kind: NotificationType;
+    post_id?: PostId;
+    private_message_id?: PrivateMessageId;
+    modlog_id?: ModlogId;
+};

package/dist/types/NotificationData.d.ts

@@ -0,0 +1,13 @@
+import type { CommentView } from "./CommentView";
+import type { ModlogView } from "./ModlogView";
+import type { PostView } from "./PostView";
+import type { PrivateMessageView } from "./PrivateMessageView";
+export type NotificationData = ({
+    type_: "comment";
+} & CommentView) | ({
+    type_: "post";
+} & PostView) | ({
+    type_: "private_message";
+} & PrivateMessageView) | ({
+    type_: "mod_action";
+} & ModlogView);

package/dist/types/NotificationDataType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A list of possible types for the inbox.
+ */
+export type NotificationDataType = "all" | "reply" | "mention" | "private_message" | "subscribed" | "mod_action";

package/dist/types/NotificationId.d.ts

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

package/dist/types/NotificationType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Types of notifications which can be received in inbox
+ */
+export type NotificationType = "mention" | "reply" | "subscribed" | "private_message" | "mod_action";

package/dist/types/NotificationView.d.ts

@@ -0,0 +1,6 @@
+import type { Notification } from "./Notification";
+import type { NotificationData } from "./NotificationData";
+export type NotificationView = {
+    notification: Notification;
+    data: NotificationData;
+};

package/dist/types/OpenGraphData.d.ts

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

@@ -0,0 +1,11 @@
+import type { PaginationCursor } from "./PaginationCursor";
+/**
+ * This response contains only a single page of items. To get the next page, take the
+ * cursor string from `next_page` and pass it to the same API endpoint via `page_cursor`
+ * parameter. For going to the previous page, use `prev_page` instead.
+ */
+export type PagedResponse<T> = {
+    items: Array<T>;
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
+};

package/dist/types/PaginationCursor.d.ts

@@ -1,4 +1,8 @@
 /**
- * A pagination cursor
+ * To get the next or previous page, pass this string unchanged as `page_cursor` in a new request
+ * to the same endpoint.
+ *
+ * Do not attempt to parse or modify the cursor string. The format is internal and may change in
+ * minor Lemmy versions.
  */
 export type PaginationCursor = string;

package/dist/types/PendingFollowerView.d.ts

@@ -0,0 +1,9 @@
+import type { Community } from "./Community";
+import type { CommunityFollowerState } from "./CommunityFollowerState";
+import type { Person } from "./Person";
+export type PendingFollowerView = {
+    person: Person;
+    community: Community;
+    is_new_instance: boolean;
+    follow_state?: CommunityFollowerState;
+};

package/dist/types/PersonActions.d.ts

@@ -11,4 +11,16 @@ export type PersonActions = {
      * A note about the person.
      */
     note?: string;
+    /**
+     * When the person was voted on.
+     */
+    voted_at?: string;
+    /**
+     * A total of upvotes given to this person
+     */
+    upvotes?: number;
+    /**
+     * A total of downvotes given to this person
+     */
+    downvotes?: number;
 };

package/dist/types/PersonContentCombinedView.d.ts

@@ -1,7 +1,7 @@
 import type { CommentView } from "./CommentView";
 import type { PostView } from "./PostView";
 export type PersonContentCombinedView = ({
-    type_: "Post";
+    type_: "post";
 } & PostView) | ({
-    type_: "Comment";
+    type_: "comment";
 } & CommentView);

package/dist/types/PersonContentType.d.ts

@@ -1,4 +1,4 @@
 /**
  * A list of possible types for a person's content.
  */
-export type PersonContentType = "All" | "Comments" | "Posts";
+export type PersonContentType = "all" | "comments" | "posts";

package/dist/types/PersonLikedCombinedView.d.ts

@@ -1,7 +1,7 @@
 import type { CommentView } from "./CommentView";
 import type { PostView } from "./PostView";
 export type PersonLikedCombinedView = ({
-    type_: "Post";
+    type_: "post";
 } & PostView) | ({
-    type_: "Comment";
+    type_: "comment";
 } & CommentView);

package/dist/types/PersonResponse.d.ts

@@ -0,0 +1,7 @@
+import type { PersonView } from "./PersonView";
+/**
+ * A person response for actions done to a person.
+ */
+export type PersonResponse = {
+    person_view: PersonView;
+};

package/dist/types/PersonSavedCombinedView.d.ts

@@ -1,7 +1,7 @@
 import type { CommentView } from "./CommentView";
 import type { PostView } from "./PostView";
 export type PersonSavedCombinedView = ({
-    type_: "Post";
+    type_: "post";
 } & PostView) | ({
-    type_: "Comment";
+    type_: "comment";
 } & CommentView);

package/dist/types/PersonView.d.ts

@@ -7,5 +7,6 @@ export type PersonView = {
     person: Person;
     is_admin: boolean;
     person_actions?: PersonActions;
-    creator_banned: boolean;
+    banned: boolean;
+    ban_expires_at?: string;
 };

package/dist/types/PluginMetadata.d.ts

@@ -1,5 +1,5 @@
 export type PluginMetadata = {
     name: string;
-    url: string;
-    description: string;
+    url?: string;
+    description?: string;
 };

package/dist/types/Post.d.ts

@@ -79,14 +79,14 @@ export type Post = {
      * Time at which the post will be published. None means publish immediately.
      */
     scheduled_publish_time_at?: string;
+    /**
+     * The time of the newest comment in the post, if the post has any comments.
+     */
+    newest_comment_time_at?: string;
     comments: number;
     score: number;
     upvotes: number;
     downvotes: number;
-    /**
-     * The time of the newest comment in the post.
-     */
-    newest_comment_time_at: string;
     report_count: number;
     unresolved_report_count: number;
     /**
@@ -94,4 +94,6 @@ export type Post = {
      * accepted by the community (by receiving it back via federation).
      */
     federation_pending: boolean;
+    embed_video_width?: number;
+    embed_video_height?: number;
 };