lemmy-js-client 0.20.0-private-community.9 → 0.20.0-reports-combined.2

package/dist/types/LocalUser.d.ts

@@ -4,29 +4,84 @@ import type { LocalUserId } from "./LocalUserId";
 import type { PersonId } from "./PersonId";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
-export interface LocalUser {
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * A local user.
+ */
+export type LocalUser = {
     id: LocalUserId;
+    /**
+     * The person_id for the local user.
+     */
     person_id: PersonId;
-    email?: string;
+    email?: SensitiveString;
+    /**
+     * Whether to show NSFW content.
+     */
     show_nsfw: boolean;
     theme: string;
     default_post_sort_type: PostSortType;
     default_listing_type: ListingType;
     interface_language: string;
+    /**
+     * Whether to show avatars.
+     */
     show_avatars: boolean;
     send_notifications_to_email: boolean;
+    /**
+     * Whether to show bot accounts.
+     */
     show_bot_accounts: boolean;
+    /**
+     * Whether to show read posts.
+     */
     show_read_posts: boolean;
+    /**
+     * Whether their email has been verified.
+     */
     email_verified: boolean;
+    /**
+     * Whether their registration application has been accepted.
+     */
     accepted_application: boolean;
+    /**
+     * Open links in a new tab.
+     */
     open_links_in_new_tab: boolean;
     blur_nsfw: boolean;
+    /**
+     * Whether infinite scroll is enabled.
+     */
     infinite_scroll_enabled: boolean;
+    /**
+     * Whether the person is an admin.
+     */
     admin: boolean;
+    /**
+     * A post-view mode that changes how multiple post listings look.
+     */
     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;
+};

package/dist/types/LocalUserId.d.ts

@@ -1 +1,4 @@
+/**
+ * The local user id.
+ */
 export type LocalUserId = number;

package/dist/types/LocalUserView.d.ts

@@ -2,9 +2,12 @@ import type { LocalUser } from "./LocalUser";
 import type { LocalUserVoteDisplayMode } from "./LocalUserVoteDisplayMode";
 import type { Person } from "./Person";
 import type { PersonAggregates } from "./PersonAggregates";
-export interface LocalUserView {
+/**
+ * A local user view.
+ */
+export type LocalUserView = {
     local_user: LocalUser;
     local_user_vote_display_mode: LocalUserVoteDisplayMode;
     person: Person;
     counts: PersonAggregates;
-}
+};

package/dist/types/LocalUserVoteDisplayMode.d.ts

@@ -1,6 +1,9 @@
-export interface LocalUserVoteDisplayMode {
+/**
+ * The vote display settings for your user.
+ */
+export type LocalUserVoteDisplayMode = {
     score: boolean;
     upvotes: boolean;
     downvotes: boolean;
     upvote_percentage: boolean;
-}
+};

package/dist/types/LockPost.d.ts

@@ -1,5 +1,8 @@
 import type { PostId } from "./PostId";
-export interface LockPost {
+/**
+ * Lock a post (prevent new comments).
+ */
+export type LockPost = {
     post_id: PostId;
     locked: boolean;
-}
+};

package/dist/types/Login.d.ts

@@ -1,5 +1,12 @@
-export interface Login {
-    username_or_email: string;
-    password: string;
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Logging into lemmy.
+ */
+export type Login = {
+    username_or_email: SensitiveString;
+    password: SensitiveString;
+    /**
+     * May be required, if totp is enabled for their account.
+     */
     totp_2fa_token?: string;
-}
+};

package/dist/types/Login.js

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

@@ -1,5 +1,19 @@
-export interface LoginResponse {
-    jwt?: string;
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * A response for your login.
+ */
+export type LoginResponse = {
+    /**
+     * This is None in response to `Register` if email verification is enabled, or the server
+     * requires registration applications.
+     */
+    jwt?: SensitiveString;
+    /**
+     * If registration applications are required, this will return true for a signup response.
+     */
     registration_created: boolean;
+    /**
+     * If email verifications are required, this will return true for a signup response.
+     */
     verify_email_sent: boolean;
-}
+};

package/dist/types/LoginResponse.js

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

@@ -1,7 +1,17 @@
 import type { LocalUserId } from "./LocalUserId";
-export interface LoginToken {
+/**
+ * Stores data related to a specific user login session.
+ */
+export type LoginToken = {
     user_id: LocalUserId;
+    /**
+     * Time of login
+     */
     published: 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.
+     */
     ip?: string;
     user_agent?: string;
-}
+};

package/dist/types/MarkCommentReplyAsRead.d.ts

@@ -1,5 +1,8 @@
 import type { CommentReplyId } from "./CommentReplyId";
-export interface MarkCommentReplyAsRead {
+/**
+ * Mark a comment reply as read.
+ */
+export type MarkCommentReplyAsRead = {
     comment_reply_id: CommentReplyId;
     read: boolean;
-}
+};

package/dist/types/MarkManyPostsAsRead.d.ts

@@ -0,0 +1,7 @@
+import type { PostId } from "./PostId";
+/**
+ * Mark several posts as read.
+ */
+export type MarkManyPostsAsRead = {
+    post_ids: Array<PostId>;
+};

package/dist/types/MarkManyPostsAsRead.js

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

package/dist/types/MarkPersonMentionAsRead.d.ts

@@ -1,5 +1,8 @@
 import type { PersonMentionId } from "./PersonMentionId";
-export interface MarkPersonMentionAsRead {
+/**
+ * Mark a person mention as read.
+ */
+export type MarkPersonMentionAsRead = {
     person_mention_id: PersonMentionId;
     read: boolean;
-}
+};

package/dist/types/MarkPostAsRead.d.ts

@@ -1,5 +1,8 @@
 import type { PostId } from "./PostId";
-export interface MarkPostAsRead {
-    post_ids: Array<PostId>;
+/**
+ * Mark a post as read.
+ */
+export type MarkPostAsRead = {
+    post_id: PostId;
     read: boolean;
-}
+};

package/dist/types/MarkPrivateMessageAsRead.d.ts

@@ -1,5 +1,8 @@
 import type { PrivateMessageId } from "./PrivateMessageId";
-export interface MarkPrivateMessageAsRead {
+/**
+ * Mark a private message as read.
+ */
+export type MarkPrivateMessageAsRead = {
     private_message_id: PrivateMessageId;
     read: boolean;
-}
+};

package/dist/types/ModAdd.d.ts

@@ -1,8 +1,11 @@
 import type { PersonId } from "./PersonId";
-export interface ModAdd {
+/**
+ * When someone is added as a site moderator.
+ */
+export type ModAdd = {
     id: number;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     removed: boolean;
     when_: string;
-}
+};

package/dist/types/ModAddCommunity.d.ts

@@ -1,10 +1,13 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModAddCommunity {
+/**
+ * When someone is added as a community moderator.
+ */
+export type ModAddCommunity = {
     id: number;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
     removed: boolean;
     when_: string;
-}
+};

package/dist/types/ModAddCommunityView.d.ts

@@ -1,9 +1,12 @@
 import type { Community } from "./Community";
 import type { ModAddCommunity } from "./ModAddCommunity";
 import type { Person } from "./Person";
-export interface ModAddCommunityView {
+/**
+ * When someone is added as a community moderator.
+ */
+export type ModAddCommunityView = {
     mod_add_community: ModAddCommunity;
     moderator?: Person;
     community: Community;
     modded_person: Person;
-}
+};

package/dist/types/ModAddView.d.ts

@@ -1,7 +1,10 @@
 import type { ModAdd } from "./ModAdd";
 import type { Person } from "./Person";
-export interface ModAddView {
+/**
+ * When someone is added as a site moderator.
+ */
+export type ModAddView = {
     mod_add: ModAdd;
     moderator?: Person;
     modded_person: Person;
-}
+};

package/dist/types/ModBan.d.ts

@@ -1,5 +1,8 @@
 import type { PersonId } from "./PersonId";
-export interface ModBan {
+/**
+ * When someone is banned from the site.
+ */
+export type ModBan = {
     id: number;
     mod_person_id: PersonId;
     other_person_id: PersonId;
@@ -7,4 +10,4 @@ export interface ModBan {
     banned: boolean;
     expires?: string;
     when_: string;
-}
+};

package/dist/types/ModBanFromCommunity.d.ts

@@ -1,6 +1,9 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModBanFromCommunity {
+/**
+ * When someone is banned from a community.
+ */
+export type ModBanFromCommunity = {
     id: number;
     mod_person_id: PersonId;
     other_person_id: PersonId;
@@ -9,4 +12,4 @@ export interface ModBanFromCommunity {
     banned: boolean;
     expires?: string;
     when_: string;
-}
+};

package/dist/types/ModBanFromCommunityView.d.ts

@@ -1,9 +1,12 @@
 import type { Community } from "./Community";
 import type { ModBanFromCommunity } from "./ModBanFromCommunity";
 import type { Person } from "./Person";
-export interface ModBanFromCommunityView {
+/**
+ * When someone is banned from a community.
+ */
+export type ModBanFromCommunityView = {
     mod_ban_from_community: ModBanFromCommunity;
     moderator?: Person;
     community: Community;
     banned_person: Person;
-}
+};

package/dist/types/ModBanView.d.ts

@@ -1,7 +1,10 @@
 import type { ModBan } from "./ModBan";
 import type { Person } from "./Person";
-export interface ModBanView {
+/**
+ * When someone is banned from the site.
+ */
+export type ModBanView = {
     mod_ban: ModBan;
     moderator?: Person;
     banned_person: Person;
-}
+};

package/dist/types/ModFeaturePost.d.ts

@@ -1,10 +1,13 @@
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModFeaturePost {
+/**
+ * When a moderator features a post on a community (pins it to the top).
+ */
+export type ModFeaturePost = {
     id: number;
     mod_person_id: PersonId;
     post_id: PostId;
     featured: boolean;
     when_: string;
     is_featured_community: boolean;
-}
+};

package/dist/types/ModFeaturePostView.d.ts

@@ -2,9 +2,12 @@ import type { Community } from "./Community";
 import type { ModFeaturePost } from "./ModFeaturePost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModFeaturePostView {
+/**
+ * When a moderator features a post on a community (pins it to the top).
+ */
+export type ModFeaturePostView = {
     mod_feature_post: ModFeaturePost;
     moderator?: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModHideCommunity.d.ts

@@ -1,10 +1,13 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModHideCommunity {
+/**
+ * When a community is hidden from public view.
+ */
+export type ModHideCommunity = {
     id: number;
     community_id: CommunityId;
     mod_person_id: PersonId;
     when_: string;
     reason?: string;
     hidden: boolean;
-}
+};

package/dist/types/ModHideCommunityView.d.ts

@@ -1,8 +1,11 @@
 import type { Community } from "./Community";
 import type { ModHideCommunity } from "./ModHideCommunity";
 import type { Person } from "./Person";
-export interface ModHideCommunityView {
+/**
+ * When a community is hidden from public view.
+ */
+export type ModHideCommunityView = {
     mod_hide_community: ModHideCommunity;
     admin?: Person;
     community: Community;
-}
+};

package/dist/types/ModLockPost.d.ts

@@ -1,9 +1,12 @@
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModLockPost {
+/**
+ * When a moderator locks a post (prevents new comments being made).
+ */
+export type ModLockPost = {
     id: number;
     mod_person_id: PersonId;
     post_id: PostId;
     locked: boolean;
     when_: string;
-}
+};

package/dist/types/ModLockPostView.d.ts

@@ -2,9 +2,12 @@ import type { Community } from "./Community";
 import type { ModLockPost } from "./ModLockPost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModLockPostView {
+/**
+ * When a moderator locks a post (prevents new comments being made).
+ */
+export type ModLockPostView = {
     mod_lock_post: ModLockPost;
     moderator?: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModRemoveComment.d.ts

@@ -1,10 +1,13 @@
 import type { CommentId } from "./CommentId";
 import type { PersonId } from "./PersonId";
-export interface ModRemoveComment {
+/**
+ * When a moderator removes a comment.
+ */
+export type ModRemoveComment = {
     id: number;
     mod_person_id: PersonId;
     comment_id: CommentId;
     reason?: string;
     removed: boolean;
     when_: string;
-}
+};

package/dist/types/ModRemoveCommentView.d.ts

@@ -3,11 +3,14 @@ import type { Community } from "./Community";
 import type { ModRemoveComment } from "./ModRemoveComment";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModRemoveCommentView {
+/**
+ * When a moderator removes a comment.
+ */
+export type ModRemoveCommentView = {
     mod_remove_comment: ModRemoveComment;
     moderator?: Person;
     comment: Comment;
     commenter: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModRemoveCommunity.d.ts

@@ -1,10 +1,13 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModRemoveCommunity {
+/**
+ * When a moderator removes a community.
+ */
+export type ModRemoveCommunity = {
     id: number;
     mod_person_id: PersonId;
     community_id: CommunityId;
     reason?: string;
     removed: boolean;
     when_: string;
-}
+};

package/dist/types/ModRemoveCommunityView.d.ts

@@ -1,8 +1,11 @@
 import type { Community } from "./Community";
 import type { ModRemoveCommunity } from "./ModRemoveCommunity";
 import type { Person } from "./Person";
-export interface ModRemoveCommunityView {
+/**
+ * When a moderator removes a community.
+ */
+export type ModRemoveCommunityView = {
     mod_remove_community: ModRemoveCommunity;
     moderator?: Person;
     community: Community;
-}
+};

package/dist/types/ModRemovePost.d.ts

@@ -1,10 +1,13 @@
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModRemovePost {
+/**
+ * When a moderator removes a post.
+ */
+export type ModRemovePost = {
     id: number;
     mod_person_id: PersonId;
     post_id: PostId;
     reason?: string;
     removed: boolean;
     when_: string;
-}
+};

package/dist/types/ModRemovePostView.d.ts

@@ -2,9 +2,12 @@ import type { Community } from "./Community";
 import type { ModRemovePost } from "./ModRemovePost";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface ModRemovePostView {
+/**
+ * When a moderator removes a post.
+ */
+export type ModRemovePostView = {
     mod_remove_post: ModRemovePost;
     moderator?: Person;
     post: Post;
     community: Community;
-}
+};

package/dist/types/ModTransferCommunity.d.ts

@@ -1,9 +1,12 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface ModTransferCommunity {
+/**
+ * When a moderator transfers a community to a new owner.
+ */
+export type ModTransferCommunity = {
     id: number;
     mod_person_id: PersonId;
     other_person_id: PersonId;
     community_id: CommunityId;
     when_: string;
-}
+};

package/dist/types/ModTransferCommunityView.d.ts

@@ -1,9 +1,12 @@
 import type { Community } from "./Community";
 import type { ModTransferCommunity } from "./ModTransferCommunity";
 import type { Person } from "./Person";
-export interface ModTransferCommunityView {
+/**
+ * When a moderator transfers a community to a new owner.
+ */
+export type ModTransferCommunityView = {
     mod_transfer_community: ModTransferCommunity;
     moderator?: Person;
     community: Community;
     modded_person: Person;
-}
+};

package/dist/types/ModlogActionType.d.ts

@@ -1 +1,4 @@
-export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModHideCommunity" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment";
+/**
+ * A list of possible types for the various modlog actions.
+ */
+export type ModlogActionType = "All" | "ModRemovePost" | "ModLockPost" | "ModFeaturePost" | "ModRemoveComment" | "ModRemoveCommunity" | "ModBanFromCommunity" | "ModAddCommunity" | "ModTransferCommunity" | "ModAdd" | "ModBan" | "ModHideCommunity" | "AdminPurgePerson" | "AdminPurgeCommunity" | "AdminPurgePost" | "AdminPurgeComment" | "AdminBlockInstance" | "AdminAllowInstance";

package/dist/types/ModlogListParams.d.ts

@@ -2,7 +2,10 @@ import type { CommentId } from "./CommentId";
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface ModlogListParams {
+/**
+ * Querying / filtering the modlog.
+ */
+export type ModlogListParams = {
     community_id?: CommunityId;
     mod_person_id?: PersonId;
     other_person_id?: PersonId;
@@ -11,4 +14,4 @@ export interface ModlogListParams {
     page?: number;
     limit?: number;
     hide_modlog_names: boolean;
-}
+};