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

package/dist/types/ListPersonLiked.d.ts

@@ -0,0 +1,13 @@
+import type { LikeType } from "./LikeType";
+import type { PaginationCursor } from "./PaginationCursor";
+import type { PersonContentType } from "./PersonContentType";
+/**
+ * Gets your liked / disliked posts
+ */
+export type ListPersonLiked = {
+    type_?: PersonContentType;
+    like_type?: LikeType;
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
+    limit?: number;
+};

package/dist/types/ListPersonLikedResponse.d.ts

@@ -0,0 +1,13 @@
+import type { PaginationCursor } from "./PaginationCursor";
+import type { PersonLikedCombinedView } from "./PersonLikedCombinedView";
+/**
+ * Your liked posts response.
+ */
+export type ListPersonLikedResponse = {
+    liked: Array<PersonLikedCombinedView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
+};

package/dist/types/ListPersonRead.d.ts

@@ -0,0 +1,9 @@
+import type { PaginationCursor } from "./PaginationCursor";
+/**
+ * Gets your read posts.
+ */
+export type ListPersonRead = {
+    page_cursor?: PaginationCursor;
+    page_back?: boolean;
+    limit?: number;
+};

package/dist/types/ListPersonReadResponse.d.ts

@@ -0,0 +1,13 @@
+import type { PaginationCursor } from "./PaginationCursor";
+import type { PostView } from "./PostView";
+/**
+ * You read posts response.
+ */
+export type ListPersonReadResponse = {
+    read: Array<PostView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
+    next_page?: PaginationCursor;
+    prev_page?: PaginationCursor;
+};

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

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

package/dist/types/LocalImageView.d.ts

@@ -1,9 +1,11 @@
 import type { LocalImage } from "./LocalImage";
 import type { Person } from "./Person";
+import type { Post } from "./Post";
 /**
  * A local image view.
  */
 export type LocalImageView = {
     local_image: LocalImage;
     person: Person;
+    post?: 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";
@@ -41,10 +42,6 @@ export type LocalSite = {
      * An optional legal disclaimer page.
      */
     legal_information?: string;
-    /**
-     * Whether to hide mod names on the modlog.
-     */
-    hide_modlog_mod_names: boolean;
     /**
      * Whether new applications email admins.
      */
@@ -53,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.
      */
@@ -69,8 +62,8 @@ export type LocalSite = {
      * The captcha difficulty.
      */
     captcha_difficulty: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
     registration_mode: RegistrationMode;
     /**
      * Whether to email admins on new reports.
@@ -145,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;
-    published: string;
-    updated?: string;
-    import_user_settings: number;
-    import_user_settings_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_max_requests: number;
+    import_user_settings_interval_seconds: number;
 };

package/dist/types/LocalSiteUrlBlocklist.d.ts

@@ -1,6 +1,6 @@
 export type LocalSiteUrlBlocklist = {
     id: number;
     url: string;
-    published: string;
-    updated?: string;
+    published_at: string;
+    updated_at?: string;
 };

package/dist/types/LocalUser.d.ts

@@ -5,6 +5,7 @@ import type { PersonId } from "./PersonId";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { SensitiveString } from "./SensitiveString";
+import type { VoteShow } from "./VoteShow";
 /**
  * A local user.
  */
@@ -62,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;
+    /**
+     * 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;
-    /**
-     * 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: string;
     /**
      * Whether to hide posts containing images/videos
      */
@@ -99,6 +96,8 @@ export type LocalUser = {
     default_post_time_range_seconds?: number;
     show_score: boolean;
     show_upvotes: boolean;
-    show_downvotes: 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,4 +5,5 @@ import type { PostId } from "./PostId";
 export type LockPost = {
     post_id: PostId;
     locked: boolean;
+    reason: string;
 };

package/dist/types/Login.d.ts

@@ -1,6 +1,9 @@
 import type { SensitiveString } from "./SensitiveString";
 /**
  * Logging into lemmy.
+ *
+ * Note: Banned users can still log in, to be able to do certain things like delete
+ * their account.
  */
 export type Login = {
     username_or_email: SensitiveString;

package/dist/types/LoginToken.d.ts

@@ -7,7 +7,7 @@ export type LoginToken = {
     /**
      * Time of login
      */
-    published: string;
+    published_at: string;
     /**
      * IP address where login was made from, allows invalidating logins by IP address.
      * Could be stored in truncated format, or store derived information for better privacy.

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/{ModAddCommunity.d.ts → ModAddToCommunity.d.ts}

@@ -1,14 +1,14 @@
 import type { CommunityId } from "./CommunityId";
-import type { ModAddCommunityId } from "./ModAddCommunityId";
+import type { ModAddToCommunityId } from "./ModAddToCommunityId";
 import type { PersonId } from "./PersonId";
 /**
  * When someone is added as a community moderator.
  */
-export type ModAddCommunity = {
-    id: ModAddCommunityId;
+export type ModAddToCommunity = {
+    id: ModAddToCommunityId;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
     removed: boolean;
-    published: string;
+    published_at: string;
 };

package/dist/types/ModAddToCommunityId.d.ts

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

package/dist/types/{ModAddCommunityView.d.ts → ModAddToCommunityView.d.ts}

@@ -1,11 +1,11 @@
 import type { Community } from "./Community";
-import type { ModAddCommunity } from "./ModAddCommunity";
+import type { ModAddToCommunity } from "./ModAddToCommunity";
 import type { Person } from "./Person";
 /**
  * When someone is added as a community moderator.
  */
-export type ModAddCommunityView = {
-    mod_add_community: ModAddCommunity;
+export type ModAddToCommunityView = {
+    mod_add_to_community: ModAddToCommunity;
     moderator?: Person;
     community: Community;
     other_person: Person;

package/dist/types/ModBanFromCommunity.d.ts

@@ -9,8 +9,8 @@ export type ModBanFromCommunity = {
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
-    reason?: string;
+    reason: string;
     banned: boolean;
-    expires?: string;
-    published: string;
+    expires_at?: string;
+    published_at: string;
 };

package/dist/types/ModChangeCommunityVisibility.d.ts

@@ -6,7 +6,6 @@ export type ModChangeCommunityVisibility = {
     id: ModChangeCommunityVisibilityId;
     community_id: CommunityId;
     mod_person_id: PersonId;
-    published: string;
-    reason?: string;
+    published_at: string;
     visibility: CommunityVisibility;
 };

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

@@ -9,6 +9,6 @@ export type ModFeaturePost = {
     mod_person_id: PersonId;
     post_id: PostId;
     featured: boolean;
-    published: string;
+    published_at: string;
     is_featured_community: boolean;
 };

package/dist/types/ModLockComment.d.ts

@@ -0,0 +1,14 @@
+import type { CommentId } from "./CommentId";
+import type { ModLockCommentId } from "./ModLockCommentId";
+import type { PersonId } from "./PersonId";
+/**
+ * When a moderator locks a comment (prevents new replies to a comment or its children).
+ */
+export type ModLockComment = {
+    id: ModLockCommentId;
+    mod_person_id: PersonId;
+    comment_id: CommentId;
+    locked: boolean;
+    reason: string;
+    published_at: string;
+};

package/dist/types/ModLockComment.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/ModLockCommentId.d.ts

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

package/dist/types/ModLockCommentView.d.ts

@@ -0,0 +1,16 @@
+import type { Comment } from "./Comment";
+import type { Community } from "./Community";
+import type { ModLockComment } from "./ModLockComment";
+import type { Person } from "./Person";
+import type { Post } from "./Post";
+/**
+ * When a moderator locks a comment (prevents replies to it or its children).
+ */
+export type ModLockCommentView = {
+    mod_lock_comment: ModLockComment;
+    moderator?: Person;
+    other_person: Person;
+    comment: Comment;
+    post: Post;
+    community: Community;
+};

package/dist/types/ModLockCommentView.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/ModLockPost.d.ts

@@ -9,5 +9,6 @@ export type ModLockPost = {
     mod_person_id: PersonId;
     post_id: PostId;
     locked: boolean;
-    published: string;
+    published_at: string;
+    reason: string;
 };

package/dist/types/ModRemoveComment.d.ts

@@ -8,7 +8,7 @@ export type ModRemoveComment = {
     id: ModRemoveCommentId;
     mod_person_id: PersonId;
     comment_id: CommentId;
-    reason?: string;
+    reason: string;
     removed: boolean;
-    published: string;
+    published_at: string;
 };

package/dist/types/ModRemovePost.d.ts

@@ -8,7 +8,7 @@ export type ModRemovePost = {
     id: ModRemovePostId;
     mod_person_id: PersonId;
     post_id: PostId;
-    reason?: string;
+    reason: string;
     removed: boolean;
-    published: string;
+    published_at: string;
 };

package/dist/types/ModTransferCommunity.d.ts

@@ -9,5 +9,5 @@ export type ModTransferCommunity = {
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
-    published: string;
+    published_at: string;
 };

package/dist/types/ModlogActionType.d.ts

@@ -1,4 +1,4 @@
 /**
  * A list of possible types for the various modlog actions.
  */
-export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModChangeCommunityVisibility" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment" | "AdminBlockInstance" | "AdminAllowInstance";
+export type ModlogActionType = "all" | "mod_remove_post" | "mod_lock_post" | "mod_feature_post" | "mod_remove_comment" | "mod_lock_comment" | "admin_remove_community" | "mod_ban_from_community" | "mod_add_to_community" | "mod_transfer_community" | "admin_add" | "admin_ban" | "mod_change_community_visibility" | "admin_purge_person" | "admin_purge_community" | "admin_purge_post" | "admin_purge_comment" | "admin_block_instance" | "admin_allow_instance";

package/dist/types/ModlogCombinedView.d.ts

@@ -1,18 +1,19 @@
+import type { AdminAddView } from "./AdminAddView";
 import type { AdminAllowInstanceView } from "./AdminAllowInstanceView";
+import type { AdminBanView } from "./AdminBanView";
 import type { AdminBlockInstanceView } from "./AdminBlockInstanceView";
 import type { AdminPurgeCommentView } from "./AdminPurgeCommentView";
 import type { AdminPurgeCommunityView } from "./AdminPurgeCommunityView";
 import type { AdminPurgePersonView } from "./AdminPurgePersonView";
 import type { AdminPurgePostView } from "./AdminPurgePostView";
-import type { ModAddCommunityView } from "./ModAddCommunityView";
-import type { ModAddView } from "./ModAddView";
+import type { AdminRemoveCommunityView } from "./AdminRemoveCommunityView";
+import type { ModAddToCommunityView } from "./ModAddToCommunityView";
 import type { ModBanFromCommunityView } from "./ModBanFromCommunityView";
-import type { ModBanView } from "./ModBanView";
 import type { ModChangeCommunityVisibilityView } from "./ModChangeCommunityVisibilityView";
 import type { ModFeaturePostView } from "./ModFeaturePostView";
+import type { ModLockCommentView } from "./ModLockCommentView";
 import type { ModLockPostView } from "./ModLockPostView";
 import type { ModRemoveCommentView } from "./ModRemoveCommentView";
-import type { ModRemoveCommunityView } from "./ModRemoveCommunityView";
 import type { ModRemovePostView } from "./ModRemovePostView";
 import type { ModTransferCommunityView } from "./ModTransferCommunityView";
 export type ModlogCombinedView = ({
@@ -28,12 +29,12 @@ export type ModlogCombinedView = ({
 } & AdminPurgePersonView) | ({
     type_: "AdminPurgePost";
 } & AdminPurgePostView) | ({
-    type_: "ModAdd";
-} & ModAddView) | ({
-    type_: "ModAddCommunity";
-} & ModAddCommunityView) | ({
-    type_: "ModBan";
-} & ModBanView) | ({
+    type_: "AdminAdd";
+} & AdminAddView) | ({
+    type_: "ModAddToCommunity";
+} & ModAddToCommunityView) | ({
+    type_: "AdminBan";
+} & AdminBanView) | ({
     type_: "ModBanFromCommunity";
 } & ModBanFromCommunityView) | ({
     type_: "ModFeaturePost";
@@ -44,9 +45,11 @@ export type ModlogCombinedView = ({
 } & ModLockPostView) | ({
     type_: "ModRemoveComment";
 } & ModRemoveCommentView) | ({
-    type_: "ModRemoveCommunity";
-} & ModRemoveCommunityView) | ({
+    type_: "AdminRemoveCommunity";
+} & AdminRemoveCommunityView) | ({
     type_: "ModRemovePost";
 } & ModRemovePostView) | ({
     type_: "ModTransferCommunity";
-} & ModTransferCommunityView);
+} & ModTransferCommunityView) | ({
+    type_: "ModLockComment";
+} & ModLockCommentView);

package/dist/types/MultiCommunity.d.ts

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

package/dist/types/MultiCommunity.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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/MultiCommunityEntry.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/MultiCommunityFollow.d.ts

@@ -0,0 +1,8 @@
+import type { CommunityFollowerState } from "./CommunityFollowerState";
+import type { MultiCommunityId } from "./MultiCommunityId";
+import type { PersonId } from "./PersonId";
+export type MultiCommunityFollow = {
+    multi_community_id: MultiCommunityId;
+    person_id: PersonId;
+    follow_state: CommunityFollowerState;
+};

package/dist/types/MultiCommunityFollow.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/MultiCommunityId.d.ts

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

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/MultiCommunityResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/MultiCommunityView.d.ts

@@ -0,0 +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/MultiCommunityView.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/MyUserInfo.d.ts

@@ -13,7 +13,8 @@ export type MyUserInfo = {
     follows: Array<CommunityFollowerView>;
     moderates: Array<CommunityModeratorView>;
     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>;