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

package/dist/types/LocalUser.d.ts

@@ -63,37 +63,33 @@ 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;
+    animated_images_enabled: 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 to hide posts containing images/videos
+     * Whether a user can send / receive private messages
+     */
+    private_messages_enabled: boolean;
+    default_comment_sort_type: CommentSortType;
+    /**
+     * Whether to automatically mark fetched posts as read.
      */
-    hide_media: boolean;
+    auto_mark_fetched_posts_as_read: boolean;
+    /**
+     * Whether to hide posts containing images/videos. Often labeled hide_memes.
+     */
+    hide_posts_with_media: boolean;
     /**
      * A default time range limit to apply to post sorts, in seconds.
      */
@@ -103,4 +99,10 @@ export type LocalUser = {
     show_downvotes: VoteShow;
     show_upvote_percentage: boolean;
     show_person_votes: boolean;
+    default_items_per_page: number;
+    invited_by_local_user_id?: LocalUserId;
+    /**
+     * Whether to show media in the UI.
+     */
+    show_media: boolean;
 };

package/dist/types/LocalUserInvite.d.ts

@@ -0,0 +1,11 @@
+import type { InvitationId } from "./InvitationId";
+import type { LocalUserId } from "./LocalUserId";
+export type LocalUserInvite = {
+    id: InvitationId;
+    token: string;
+    local_user_id: LocalUserId;
+    max_uses?: number;
+    uses_count: number;
+    expires_at?: string;
+    published_at: string;
+};

package/dist/types/LocalUserSortType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The local user sort type.
+ */
+export type LocalUserSortType = "new" | "old";

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

@@ -1,10 +1,10 @@
+import type { CommunityTagId } from "./CommunityTagId";
 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>;
+    tags?: Array<CommunityTagId>;
 };

package/dist/types/Modlog.d.ts

@@ -0,0 +1,12 @@
+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;
+    bulk_action_parent_id?: ModlogId;
+    child_count: number;
+};

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" | "mod_warn_comment" | "mod_warn_post";

package/dist/types/ModlogKindFilter.d.ts

@@ -0,0 +1,5 @@
+import type { ModlogKind } from "./ModlogKind";
+/**
+ * A list of possible types for the various modlog actions.
+ */
+export type ModlogKindFilter = "all" | ModlogKind;

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

@@ -8,10 +8,21 @@ export type MultiCommunity = {
     instance_id: InstanceId;
     name: string;
     title?: string;
-    description?: string;
+    /**
+     * A shorter, one-line summary.
+     */
+    summary?: string;
     local: boolean;
     deleted: boolean;
     ap_id: DbUrl;
+    last_refreshed_at: string;
     published_at: string;
     updated_at?: string;
+    subscribers: number;
+    subscribers_local: number;
+    communities: number;
+    /**
+     * A sidebar in markdown.
+     */
+    sidebar?: string;
 };

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,6 +13,7 @@ export type MyUserInfo = {
     local_user_view: LocalUserView;
     follows: Array<CommunityFollowerView>;
     moderates: Array<CommunityModeratorView>;
+    multi_community_follows: Array<MultiCommunityView>;
     community_blocks: Array<Community>;
     instance_communities_blocks: Array<Instance>;
     instance_persons_blocks: Array<Instance>;

package/dist/types/NodeInfo.d.ts

@@ -0,0 +1,20 @@
+import type { NodeInfoServices } from "./NodeInfoServices";
+import type { NodeInfoSoftware } from "./NodeInfoSoftware";
+import type { NodeInfoUsage } from "./NodeInfoUsage";
+/**
+ * Nodeinfo spec: http://nodeinfo.diaspora.software/docson/index.html#/ns/schema/2.1
+ */
+export type NodeInfo = {
+    version?: string;
+    software?: NodeInfoSoftware;
+    protocols?: Array<string>;
+    usage?: NodeInfoUsage;
+    openRegistrations?: boolean;
+    /**
+     * These fields are required by the spec for no reason
+     */
+    services?: NodeInfoServices;
+    metadata?: {
+        [key in string]: string;
+    };
+};

package/dist/types/NodeInfoServices.d.ts

@@ -0,0 +1,4 @@
+export type NodeInfoServices = {
+    inbound?: Array<string>;
+    outbound?: Array<string>;
+};

package/dist/types/NodeInfoSoftware.d.ts

@@ -0,0 +1,6 @@
+export type NodeInfoSoftware = {
+    name?: string;
+    version?: string;
+    repository?: string;
+    homepage?: string;
+};

package/dist/types/NodeInfoUsage.d.ts

@@ -0,0 +1,6 @@
+import type { NodeInfoUsers } from "./NodeInfoUsers";
+export type NodeInfoUsage = {
+    users?: NodeInfoUsers;
+    localPosts?: number;
+    localComments?: number;
+};

package/dist/types/NodeInfoUsers.d.ts

@@ -0,0 +1,5 @@
+export type NodeInfoUsers = {
+    total?: number;
+    activeHalfyear?: number;
+    activeMonth?: number;
+};

package/dist/types/Notification.d.ts

@@ -1,6 +1,7 @@
 import type { CommentId } from "./CommentId";
+import type { ModlogId } from "./ModlogId";
 import type { NotificationId } from "./NotificationId";
-import type { NotificationTypes } from "./NotificationTypes";
+import type { NotificationType } from "./NotificationType";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
 import type { PrivateMessageId } from "./PrivateMessageId";
@@ -10,7 +11,9 @@ export type Notification = {
     comment_id?: CommentId;
     read: boolean;
     published_at: string;
-    kind: NotificationTypes;
+    kind: NotificationType;
     post_id?: PostId;
     private_message_id?: PrivateMessageId;
+    modlog_id?: ModlogId;
+    creator_id: PersonId;
 };

package/dist/types/NotificationData.d.ts

@@ -1,10 +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";
+    type_: "comment";
 } & CommentView) | ({
-    type_: "Post";
+    type_: "post";
 } & PostView) | ({
-    type_: "PrivateMessage";
-} & PrivateMessageView);
+    type_: "private_message";
+} & PrivateMessageView) | ({
+    type_: "mod_action";
+} & ModlogView);

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

@@ -0,0 +1,5 @@
+import type { NotificationType } from "./NotificationType";
+/**
+ * A list of possible types for the inbox.
+ */
+export type NotificationTypeFilter = "all" | NotificationType;

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

@@ -29,6 +29,7 @@ export type Person = {
      * Whether the person is local to our site.
      */
     local: boolean;
+    last_refreshed_at: string;
     /**
      * A URL for a banner.
      */

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

@@ -0,0 +1,4 @@
+/**
+ * A listing type for person fetches
+ */
+export type PersonListingType = "all" | "local";

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

@@ -0,0 +1,4 @@
+/**
+ * The person sort type.
+ */
+export type PersonSortType = "new" | "old" | "post_score" | "comment_score";

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;
 };

package/dist/types/PostActions.d.ts

@@ -8,26 +8,26 @@ export type PostActions = {
      * When was the last time you read the comments.
      */
     read_comments_at?: string;
-    /**
-     * The number of comments you read last. Subtract this from total comments to get an unread
-     * count.
-     */
-    read_comments_amount?: number;
     /**
      * When the post was saved.
      */
     saved_at?: string;
     /**
-     * When the post was liked.
-     */
-    liked_at?: string;
-    /**
-     * The like / score of the post.
+     * When the post was upvoted or downvoted.
      */
-    like_score?: number;
+    voted_at?: string;
     /**
      * When the post was hidden.
      */
     hidden_at?: string;
+    /**
+     * The number of comments you read last. Subtract this from total comments to get an unread
+     * count.
+     */
+    read_comments_amount?: number;
+    /**
+     * True if upvoted, false if downvoted. Upvote is greater than downvote.
+     */
+    vote_is_upvote?: boolean;
     notifications?: PostNotificationsMode;
 };

package/dist/types/{PersonSavedCombinedView.d.ts → PostCommentCombinedView.d.ts}

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

package/dist/types/PostFeatureType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The feature type for a post.
  */
-export type PostFeatureType = "Local" | "Community";
+export type PostFeatureType = "local" | "community";

package/dist/types/PostListingMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * A post-view mode that changes how multiple post listings look.
  */
-export type PostListingMode = "List" | "Card" | "SmallCard";
+export type PostListingMode = "list" | "card" | "small_card";

package/dist/types/PostNotificationsMode.d.ts

@@ -1,4 +1,4 @@
 /**
  * Available settings for post notifications
  */
-export type PostNotificationsMode = "AllComments" | "RepliesAndMentions" | "Mute";
+export type PostNotificationsMode = "all_comments" | "replies_and_mentions" | "mute";

package/dist/types/PostOrCommentOrPrivateMessage.d.ts

@@ -1,10 +1,10 @@
 import type { Comment } from "./Comment";
 import type { Post } from "./Post";
 import type { PrivateMessage } from "./PrivateMessage";
-export type PostOrCommentOrPrivateMessage = {
-    Post: Post;
-} | {
-    Comment: Comment;
-} | {
-    PrivateMessage: PrivateMessage;
-};
+export type PostOrCommentOrPrivateMessage = ({
+    type_: "post";
+} & Post) | ({
+    type_: "comment";
+} & Comment) | ({
+    type_: "private_message";
+} & PrivateMessage);

package/dist/types/PostReport.d.ts

@@ -27,4 +27,5 @@ export type PostReport = {
     published_at: string;
     updated_at?: string;
     violates_instance_rules: boolean;
+    conclusion?: string;
 };

package/dist/types/PostReportView.d.ts

@@ -1,5 +1,6 @@
 import type { Community } from "./Community";
 import type { CommunityActions } from "./CommunityActions";
+import type { CommunityTagsView } from "./CommunityTagsView";
 import type { Person } from "./Person";
 import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
@@ -21,5 +22,8 @@ export type PostReportView = {
     creator_is_admin: boolean;
     creator_is_moderator: boolean;
     creator_banned: boolean;
+    creator_ban_expires_at?: string;
     creator_banned_from_community: boolean;
+    creator_community_ban_expires_at?: string;
+    tags: CommunityTagsView;
 };

package/dist/types/PostSortType.d.ts

@@ -1,4 +1,4 @@
 /**
  * The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
  */
-export type PostSortType = "Active" | "Hot" | "New" | "Old" | "Top" | "MostComments" | "NewComments" | "Controversial" | "Scaled";
+export type PostSortType = "active" | "hot" | "new" | "old" | "top" | "most_comments" | "new_comments" | "controversial" | "scaled";

package/dist/types/PostView.d.ts

@@ -1,12 +1,11 @@
 import type { Community } from "./Community";
 import type { CommunityActions } from "./CommunityActions";
+import type { CommunityTagsView } from "./CommunityTagsView";
 import type { ImageDetails } from "./ImageDetails";
-import type { InstanceActions } from "./InstanceActions";
 import type { Person } from "./Person";
 import type { PersonActions } from "./PersonActions";
 import type { Post } from "./Post";
 import type { PostActions } from "./PostActions";
-import type { TagsView } from "./TagsView";
 /**
  * A post view.
  */
@@ -18,12 +17,12 @@ export type PostView = {
     community_actions?: CommunityActions;
     person_actions?: PersonActions;
     post_actions?: PostActions;
-    instance_communities_actions?: InstanceActions;
-    instance_persons_actions?: InstanceActions;
     creator_is_admin: boolean;
-    tags: TagsView;
+    tags: CommunityTagsView;
     can_mod: boolean;
     creator_banned: boolean;
+    creator_ban_expires_at?: string;
     creator_is_moderator: boolean;
     creator_banned_from_community: boolean;
+    creator_community_ban_expires_at?: string;
 };