lemmy-js-client 0.20.0-alpha.6 → 0.20.0-api-v4.0

package/dist/types/LocalSite.d.ts

@@ -1,34 +1,116 @@
+import type { CommentSortType } from "./CommentSortType";
+import type { FederationMode } from "./FederationMode";
 import type { ListingType } from "./ListingType";
 import type { LocalSiteId } from "./LocalSiteId";
 import type { PostListingMode } from "./PostListingMode";
+import type { PostSortType } from "./PostSortType";
 import type { RegistrationMode } from "./RegistrationMode";
 import type { SiteId } from "./SiteId";
-import type { SortType } from "./SortType";
-export interface LocalSite {
+/**
+ * The local site.
+ */
+export type LocalSite = {
     id: LocalSiteId;
     site_id: SiteId;
+    /**
+     * True if the site is set up.
+     */
     site_setup: boolean;
-    enable_downvotes: boolean;
-    enable_nsfw: boolean;
+    /**
+     * Whether only admins can create communities.
+     */
     community_creation_admin_only: boolean;
+    /**
+     * Whether emails are required.
+     */
     require_email_verification: boolean;
+    /**
+     * An optional registration application questionnaire in markdown.
+     */
     application_question?: string;
+    /**
+     * Whether the instance is private or public.
+     */
     private_instance: boolean;
+    /**
+     * The default front-end theme.
+     */
     default_theme: string;
     default_post_listing_type: ListingType;
+    /**
+     * 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.
+     */
     application_email_admins: boolean;
+    /**
+     * An optional regex to filter words.
+     */
     slur_filter_regex?: string;
+    /**
+     * The max actor name length.
+     */
     actor_name_max_length: number;
+    /**
+     * Whether federation is enabled.
+     */
     federation_enabled: boolean;
+    /**
+     * Whether captcha is enabled.
+     */
     captcha_enabled: boolean;
+    /**
+     * The captcha difficulty.
+     */
     captcha_difficulty: string;
     published: string;
     updated?: string;
     registration_mode: RegistrationMode;
+    /**
+     * Whether to email admins on new reports.
+     */
     reports_email_admins: boolean;
+    /**
+     * Whether to sign outgoing Activitypub fetches with private key of local instance. Some
+     * Fediverse instances and platforms require this.
+     */
     federation_signed_fetch: boolean;
+    /**
+     * Default value for [LocalSite.post_listing_mode]
+     */
     default_post_listing_mode: PostListingMode;
-    default_sort_type: SortType;
-}
+    /**
+     * Default value for [LocalUser.post_sort_type]
+     */
+    default_post_sort_type: PostSortType;
+    /**
+     * Default value for [LocalUser.comment_sort_type]
+     */
+    default_comment_sort_type: CommentSortType;
+    /**
+     * Whether or not external auth methods can auto-register users.
+     */
+    oauth_registration: boolean;
+    /**
+     * What kind of post upvotes your site allows.
+     */
+    post_upvotes: FederationMode;
+    /**
+     * What kind of post downvotes your site allows.
+     */
+    post_downvotes: FederationMode;
+    /**
+     * What kind of comment upvotes your site allows.
+     */
+    comment_upvotes: FederationMode;
+    /**
+     * What kind of comment downvotes your site allows.
+     */
+    comment_downvotes: FederationMode;
+};

package/dist/types/LocalSiteId.d.ts

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

package/dist/types/LocalSiteRateLimit.d.ts

@@ -1,5 +1,8 @@
 import type { LocalSiteId } from "./LocalSiteId";
-export interface LocalSiteRateLimit {
+/**
+ * Rate limits for your site. Given in count / length of time.
+ */
+export type LocalSiteRateLimit = {
     local_site_id: LocalSiteId;
     message: number;
     message_per_second: number;
@@ -17,4 +20,4 @@ export interface LocalSiteRateLimit {
     updated?: string;
     import_user_settings: number;
     import_user_settings_per_second: number;
-}
+};

package/dist/types/LocalSiteUrlBlocklist.d.ts

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

package/dist/types/LocalUser.d.ts

@@ -1,32 +1,79 @@
+import type { CommentSortType } from "./CommentSortType";
 import type { ListingType } from "./ListingType";
 import type { LocalUserId } from "./LocalUserId";
 import type { PersonId } from "./PersonId";
 import type { PostListingMode } from "./PostListingMode";
-import type { SortType } from "./SortType";
-export interface LocalUser {
+import type { PostSortType } from "./PostSortType";
+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_sort_type: SortType;
+    default_post_sort_type: PostSortType;
     default_listing_type: ListingType;
     interface_language: string;
+    /**
+     * Whether to show avatars.
+     */
     show_avatars: boolean;
     send_notifications_to_email: boolean;
-    show_scores: 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;
-    auto_expand: 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 to auto-collapse bot comments.
+     */
     collapse_bot_comments: boolean;
-}
+    default_comment_sort_type: CommentSortType;
+};

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,8 +1,9 @@
-import type { LocalUserId } from "./LocalUserId";
-export interface LocalUserVoteDisplayMode {
-    local_user_id: LocalUserId;
+/**
+ * The vote display settings for your user.
+ */
+export type LocalUserVoteDisplayMode = {
     score: boolean;
     upvotes: boolean;
     downvotes: boolean;
     upvote_percentage: boolean;
-}
+};

package/dist/types/LocalUserVoteDisplayMode.js

@@ -1,2 +1,3 @@
 "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/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/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 {
+/**
+ * Mark a post as read.
+ */
+export type MarkPostAsRead = {
     post_ids: Array<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;
-}
+};