lemmy-js-client 0.20.0-alpha.16 → 0.20.0-alpha.18

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export { AdminPurgePerson } from "./types/AdminPurgePerson";
 export { AdminPurgePersonView } from "./types/AdminPurgePersonView";
 export { AdminPurgePost } from "./types/AdminPurgePost";
 export { AdminPurgePostView } from "./types/AdminPurgePostView";
+export { ApproveCommunityPendingFollower } from "./types/ApproveCommunityPendingFollower";
 export { ApproveRegistrationApplication } from "./types/ApproveRegistrationApplication";
 export { AuthenticateWithOauth } from "./types/AuthenticateWithOauth";
 export { BanFromCommunity } from "./types/BanFromCommunity";
@@ -44,10 +45,12 @@ export { CommentSortType } from "./types/CommentSortType";
 export { CommentView } from "./types/CommentView";
 export { Community } from "./types/Community";
 export { CommunityAggregates } from "./types/CommunityAggregates";
+export { CommunityFollowerState } from "./types/CommunityFollowerState";
 export { CommunityFollowerView } from "./types/CommunityFollowerView";
 export { CommunityId } from "./types/CommunityId";
 export { CommunityModeratorView } from "./types/CommunityModeratorView";
 export { CommunityResponse } from "./types/CommunityResponse";
+export { CommunitySortType } from "./types/CommunitySortType";
 export { CommunityView } from "./types/CommunityView";
 export { CommunityVisibility } from "./types/CommunityVisibility";
 export { CreateComment } from "./types/CreateComment";
@@ -68,6 +71,7 @@ export { CustomEmojiId } from "./types/CustomEmojiId";
 export { CustomEmojiKeyword } from "./types/CustomEmojiKeyword";
 export { CustomEmojiResponse } from "./types/CustomEmojiResponse";
 export { CustomEmojiView } from "./types/CustomEmojiView";
+export { DbUrl } from "./types/DbUrl";
 export { DeleteAccount } from "./types/DeleteAccount";
 export { DeleteComment } from "./types/DeleteComment";
 export { DeleteCommunity } from "./types/DeleteCommunity";
@@ -86,6 +90,8 @@ export { EditPrivateMessage } from "./types/EditPrivateMessage";
 export { EditSite } from "./types/EditSite";
 export { FeaturePost } from "./types/FeaturePost";
 export { FederatedInstances } from "./types/FederatedInstances";
+export { FederationError } from "./types/FederationError";
+export { FederationMode } from "./types/FederationMode";
 export { FollowCommunity } from "./types/FollowCommunity";
 export { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
 export { GetCaptchaResponse } from "./types/GetCaptchaResponse";
@@ -93,6 +99,8 @@ export { GetComment } from "./types/GetComment";
 export { GetComments } from "./types/GetComments";
 export { GetCommentsResponse } from "./types/GetCommentsResponse";
 export { GetCommunity } from "./types/GetCommunity";
+export { GetCommunityPendingFollowsCount } from "./types/GetCommunityPendingFollowsCount";
+export { GetCommunityPendingFollowsCountResponse } from "./types/GetCommunityPendingFollowsCountResponse";
 export { GetCommunityResponse } from "./types/GetCommunityResponse";
 export { GetFederatedInstancesResponse } from "./types/GetFederatedInstancesResponse";
 export { GetModlog } from "./types/GetModlog";
@@ -106,6 +114,7 @@ export { GetPostResponse } from "./types/GetPostResponse";
 export { GetPosts } from "./types/GetPosts";
 export { GetPostsResponse } from "./types/GetPostsResponse";
 export { GetPrivateMessages } from "./types/GetPrivateMessages";
+export { GetRandomCommunity } from "./types/GetRandomCommunity";
 export { GetRegistrationApplication } from "./types/GetRegistrationApplication";
 export { GetReplies } from "./types/GetReplies";
 export { GetRepliesResponse } from "./types/GetRepliesResponse";
@@ -132,6 +141,8 @@ export { ListCommentReports } from "./types/ListCommentReports";
 export { ListCommentReportsResponse } from "./types/ListCommentReportsResponse";
 export { ListCommunities } from "./types/ListCommunities";
 export { ListCommunitiesResponse } from "./types/ListCommunitiesResponse";
+export { ListCommunityPendingFollows } from "./types/ListCommunityPendingFollows";
+export { ListCommunityPendingFollowsResponse } from "./types/ListCommunityPendingFollowsResponse";
 export { ListCustomEmojis } from "./types/ListCustomEmojis";
 export { ListCustomEmojisResponse } from "./types/ListCustomEmojisResponse";
 export { ListLoginsResponse } from "./types/ListLoginsResponse";
@@ -198,6 +209,7 @@ export { OpenGraphData } from "./types/OpenGraphData";
 export { PaginationCursor } from "./types/PaginationCursor";
 export { PasswordChangeAfterReset } from "./types/PasswordChangeAfterReset";
 export { PasswordReset } from "./types/PasswordReset";
+export { PendingFollow } from "./types/PendingFollow";
 export { Person } from "./types/Person";
 export { PersonAggregates } from "./types/PersonAggregates";
 export { PersonId } from "./types/PersonId";
@@ -253,6 +265,7 @@ export { SaveUserSettings } from "./types/SaveUserSettings";
 export { Search } from "./types/Search";
 export { SearchResponse } from "./types/SearchResponse";
 export { SearchType } from "./types/SearchType";
+export { SensitiveString } from "./types/SensitiveString";
 export { Site } from "./types/Site";
 export { SiteAggregates } from "./types/SiteAggregates";
 export { SiteId } from "./types/SiteId";

package/dist/types/AddAdmin.d.ts

@@ -1,5 +1,8 @@
 import type { PersonId } from "./PersonId";
-export interface AddAdmin {
+/**
+ * Adds an admin to a site.
+ */
+export type AddAdmin = {
     person_id: PersonId;
     added: boolean;
-}
+};

package/dist/types/AddAdminResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PersonView } from "./PersonView";
-export interface AddAdminResponse {
+/**
+ * The response of current admins.
+ */
+export type AddAdminResponse = {
     admins: Array<PersonView>;
-}
+};

package/dist/types/AddModToCommunity.d.ts

@@ -1,7 +1,10 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface AddModToCommunity {
+/**
+ * Add a moderator to a community.
+ */
+export type AddModToCommunity = {
     community_id: CommunityId;
     person_id: PersonId;
     added: boolean;
-}
+};

package/dist/types/AddModToCommunityResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommunityModeratorView } from "./CommunityModeratorView";
-export interface AddModToCommunityResponse {
+/**
+ * The response of adding a moderator to a community.
+ */
+export type AddModToCommunityResponse = {
     moderators: Array<CommunityModeratorView>;
-}
+};

package/dist/types/AdminPurgeComment.d.ts

@@ -1,9 +1,12 @@
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface AdminPurgeComment {
+/**
+ * When an admin purges a comment.
+ */
+export type AdminPurgeComment = {
     id: number;
     admin_person_id: PersonId;
     post_id: PostId;
     reason?: string;
     when_: string;
-}
+};

package/dist/types/AdminPurgeCommentView.d.ts

@@ -1,8 +1,11 @@
 import type { AdminPurgeComment } from "./AdminPurgeComment";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
-export interface AdminPurgeCommentView {
+/**
+ * When an admin purges a comment.
+ */
+export type AdminPurgeCommentView = {
     admin_purge_comment: AdminPurgeComment;
     admin?: Person;
     post: Post;
-}
+};

package/dist/types/AdminPurgeCommunity.d.ts

@@ -1,7 +1,10 @@
 import type { PersonId } from "./PersonId";
-export interface AdminPurgeCommunity {
+/**
+ * When an admin purges a community.
+ */
+export type AdminPurgeCommunity = {
     id: number;
     admin_person_id: PersonId;
     reason?: string;
     when_: string;
-}
+};

package/dist/types/AdminPurgeCommunityView.d.ts

@@ -1,6 +1,9 @@
 import type { AdminPurgeCommunity } from "./AdminPurgeCommunity";
 import type { Person } from "./Person";
-export interface AdminPurgeCommunityView {
+/**
+ * When an admin purges a community.
+ */
+export type AdminPurgeCommunityView = {
     admin_purge_community: AdminPurgeCommunity;
     admin?: Person;
-}
+};

package/dist/types/AdminPurgePerson.d.ts

@@ -1,7 +1,10 @@
 import type { PersonId } from "./PersonId";
-export interface AdminPurgePerson {
+/**
+ * When an admin purges a person.
+ */
+export type AdminPurgePerson = {
     id: number;
     admin_person_id: PersonId;
     reason?: string;
     when_: string;
-}
+};

package/dist/types/AdminPurgePersonView.d.ts

@@ -1,6 +1,9 @@
 import type { AdminPurgePerson } from "./AdminPurgePerson";
 import type { Person } from "./Person";
-export interface AdminPurgePersonView {
+/**
+ * When an admin purges a person.
+ */
+export type AdminPurgePersonView = {
     admin_purge_person: AdminPurgePerson;
     admin?: Person;
-}
+};

package/dist/types/AdminPurgePost.d.ts

@@ -1,9 +1,12 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface AdminPurgePost {
+/**
+ * When an admin purges a post.
+ */
+export type AdminPurgePost = {
     id: number;
     admin_person_id: PersonId;
     community_id: CommunityId;
     reason?: string;
     when_: string;
-}
+};

package/dist/types/AdminPurgePostView.d.ts

@@ -1,8 +1,11 @@
 import type { AdminPurgePost } from "./AdminPurgePost";
 import type { Community } from "./Community";
 import type { Person } from "./Person";
-export interface AdminPurgePostView {
+/**
+ * When an admin purges a post.
+ */
+export type AdminPurgePostView = {
     admin_purge_post: AdminPurgePost;
     admin?: Person;
     community: Community;
-}
+};

package/dist/types/ApproveCommunityPendingFollower.d.ts

@@ -0,0 +1,7 @@
+import type { CommunityId } from "./CommunityId";
+import type { PersonId } from "./PersonId";
+export type ApproveCommunityPendingFollower = {
+    community_id: CommunityId;
+    follower_id: PersonId;
+    approve: boolean;
+};

package/dist/types/ApproveCommunityPendingFollower.js

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

package/dist/types/ApproveRegistrationApplication.d.ts

@@ -1,6 +1,9 @@
 import type { RegistrationApplicationId } from "./RegistrationApplicationId";
-export interface ApproveRegistrationApplication {
+/**
+ * Approves a registration application.
+ */
+export type ApproveRegistrationApplication = {
     id: RegistrationApplicationId;
     approve: boolean;
     deny_reason?: string;
-}
+};

package/dist/types/AuthenticateWithOauth.d.ts

@@ -1,8 +1,18 @@
-export interface AuthenticateWithOauth {
+import type { OAuthProviderId } from "./OAuthProviderId";
+/**
+ * Logging in with an OAuth 2.0 authorization
+ */
+export type AuthenticateWithOauth = {
     code: string;
-    oauth_provider_id: string;
+    oauth_provider_id: OAuthProviderId;
     redirect_uri: string;
     show_nsfw?: boolean;
+    /**
+     * Username is mandatory at registration time
+     */
     username?: string;
+    /**
+     * An answer is mandatory if require application is enabled on the server
+     */
     answer?: string;
-}
+};

package/dist/types/AuthenticateWithOauth.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/BanFromCommunity.d.ts

@@ -1,10 +1,22 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-export interface BanFromCommunity {
+/**
+ * Ban a user from a community.
+ */
+export type BanFromCommunity = {
     community_id: CommunityId;
     person_id: PersonId;
     ban: boolean;
+    /**
+     * Optionally remove or restore all their data. Useful for new troll accounts.
+     * If ban is true, then this means remove. If ban is false, it means restore.
+     */
     remove_or_restore_data?: boolean;
     reason?: string;
+    /**
+     * A time that the ban will expire, in unix epoch seconds.
+     *
+     * An i64 unix timestamp is used for a simpler API client implementation.
+     */
     expires?: number;
-}
+};

package/dist/types/BanFromCommunityResponse.d.ts

@@ -1,5 +1,8 @@
 import type { PersonView } from "./PersonView";
-export interface BanFromCommunityResponse {
+/**
+ * The response for banning a user from a community.
+ */
+export type BanFromCommunityResponse = {
     person_view: PersonView;
     banned: boolean;
-}
+};

package/dist/types/BanPerson.d.ts

@@ -1,8 +1,20 @@
 import type { PersonId } from "./PersonId";
-export interface BanPerson {
+/**
+ * Ban a person from the site.
+ */
+export type BanPerson = {
     person_id: PersonId;
     ban: boolean;
+    /**
+     * Optionally remove or restore all their data. Useful for new troll accounts.
+     * If ban is true, then this means remove. If ban is false, it means restore.
+     */
     remove_or_restore_data?: boolean;
     reason?: string;
+    /**
+     * A time that the ban will expire, in unix epoch seconds.
+     *
+     * An i64 unix timestamp is used for a simpler API client implementation.
+     */
     expires?: number;
-}
+};

package/dist/types/BanPersonResponse.d.ts

@@ -1,5 +1,8 @@
 import type { PersonView } from "./PersonView";
-export interface BanPersonResponse {
+/**
+ * A response for a banned person.
+ */
+export type BanPersonResponse = {
     person_view: PersonView;
     banned: boolean;
-}
+};

package/dist/types/BannedPersonsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PersonView } from "./PersonView";
-export interface BannedPersonsResponse {
+/**
+ * The list of banned persons.
+ */
+export type BannedPersonsResponse = {
     banned: Array<PersonView>;
-}
+};

package/dist/types/BlockCommunity.d.ts

@@ -1,5 +1,8 @@
 import type { CommunityId } from "./CommunityId";
-export interface BlockCommunity {
+/**
+ * Block a community.
+ */
+export type BlockCommunity = {
     community_id: CommunityId;
     block: boolean;
-}
+};

package/dist/types/BlockCommunityResponse.d.ts

@@ -1,5 +1,8 @@
 import type { CommunityView } from "./CommunityView";
-export interface BlockCommunityResponse {
+/**
+ * The block community response.
+ */
+export type BlockCommunityResponse = {
     community_view: CommunityView;
     blocked: boolean;
-}
+};

package/dist/types/BlockInstance.d.ts

@@ -1,5 +1,8 @@
 import type { InstanceId } from "./InstanceId";
-export interface BlockInstance {
+/**
+ * Block an instance as user
+ */
+export type BlockInstance = {
     instance_id: InstanceId;
     block: boolean;
-}
+};

package/dist/types/BlockInstanceResponse.d.ts

@@ -1,3 +1,3 @@
-export interface BlockInstanceResponse {
+export type BlockInstanceResponse = {
     blocked: boolean;
-}
+};

package/dist/types/BlockPerson.d.ts

@@ -1,5 +1,8 @@
 import type { PersonId } from "./PersonId";
-export interface BlockPerson {
+/**
+ * Block a person.
+ */
+export type BlockPerson = {
     person_id: PersonId;
     block: boolean;
-}
+};

package/dist/types/BlockPersonResponse.d.ts

@@ -1,5 +1,8 @@
 import type { PersonView } from "./PersonView";
-export interface BlockPersonResponse {
+/**
+ * The response for a person block.
+ */
+export type BlockPersonResponse = {
     person_view: PersonView;
     blocked: boolean;
-}
+};

package/dist/types/CaptchaResponse.d.ts

@@ -1,5 +1,17 @@
-export interface CaptchaResponse {
+/**
+ * A captcha response.
+ */
+export type CaptchaResponse = {
+    /**
+     * A Base64 encoded png
+     */
     png: string;
+    /**
+     * A Base64 encoded wav audio
+     */
     wav: string;
+    /**
+     * The UUID for the captcha item.
+     */
     uuid: string;
-}
+};

package/dist/types/ChangePassword.d.ts

@@ -1,5 +1,9 @@
-export interface ChangePassword {
-    new_password: string;
-    new_password_verify: string;
-    old_password: string;
-}
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Changes your account password.
+ */
+export type ChangePassword = {
+    new_password: SensitiveString;
+    new_password_verify: SensitiveString;
+    old_password: SensitiveString;
+};

package/dist/types/ChangePassword.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/Comment.d.ts

@@ -1,19 +1,42 @@
 import type { CommentId } from "./CommentId";
+import type { DbUrl } from "./DbUrl";
 import type { LanguageId } from "./LanguageId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface Comment {
+/**
+ * A comment.
+ */
+export type Comment = {
     id: CommentId;
     creator_id: PersonId;
     post_id: PostId;
     content: string;
+    /**
+     * Whether the comment has been removed.
+     */
     removed: boolean;
     published: string;
     updated?: string;
+    /**
+     * Whether the comment has been deleted by its creator.
+     */
     deleted: boolean;
-    ap_id: string;
+    /**
+     * The federated activity id / ap_id.
+     */
+    ap_id: DbUrl;
+    /**
+     * Whether the comment is local.
+     */
     local: boolean;
+    /**
+     * The path / tree location of a comment, separated by dots, ending with the comment's id. Ex:
+     * 0.24.27
+     */
     path: string;
+    /**
+     * Whether the comment has been distinguished(speaking officially) by a mod.
+     */
     distinguished: boolean;
     language_id: LanguageId;
-}
+};

package/dist/types/CommentAggregates.d.ts

@@ -1,9 +1,15 @@
 import type { CommentId } from "./CommentId";
-export interface CommentAggregates {
+/**
+ * Aggregate data for a comment.
+ */
+export type CommentAggregates = {
     comment_id: CommentId;
     score: number;
     upvotes: number;
     downvotes: number;
     published: string;
+    /**
+     * The total number of children in this comment branch.
+     */
     child_count: number;
-}
+};

package/dist/types/CommentId.d.ts

@@ -1 +1,4 @@
+/**
+ * The comment id.
+ */
 export type CommentId = number;

package/dist/types/CommentReply.d.ts

@@ -1,10 +1,13 @@
 import type { CommentId } from "./CommentId";
 import type { CommentReplyId } from "./CommentReplyId";
 import type { PersonId } from "./PersonId";
-export interface CommentReply {
+/**
+ * A comment reply.
+ */
+export type CommentReply = {
     id: CommentReplyId;
     recipient_id: PersonId;
     comment_id: CommentId;
     read: boolean;
     published: string;
-}
+};

package/dist/types/CommentReplyId.d.ts

@@ -1 +1,4 @@
+/**
+ * The comment reply id.
+ */
 export type CommentReplyId = number;

package/dist/types/CommentReplyResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommentReplyView } from "./CommentReplyView";
-export interface CommentReplyResponse {
+/**
+ * The response for a comment reply action.
+ */
+export type CommentReplyResponse = {
     comment_reply_view: CommentReplyView;
-}
+};

package/dist/types/CommentReplyView.d.ts

@@ -5,7 +5,10 @@ import type { Community } from "./Community";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
-export interface CommentReplyView {
+/**
+ * A comment reply view.
+ */
+export type CommentReplyView = {
     comment_reply: CommentReply;
     comment: Comment;
     creator: Person;
@@ -21,4 +24,4 @@ export interface CommentReplyView {
     saved: boolean;
     creator_blocked: boolean;
     my_vote?: number;
-}
+};

package/dist/types/CommentReport.d.ts

@@ -1,7 +1,10 @@
 import type { CommentId } from "./CommentId";
 import type { CommentReportId } from "./CommentReportId";
 import type { PersonId } from "./PersonId";
-export interface CommentReport {
+/**
+ * A comment report.
+ */
+export type CommentReport = {
     id: CommentReportId;
     creator_id: PersonId;
     comment_id: CommentId;
@@ -11,4 +14,4 @@ export interface CommentReport {
     resolver_id?: PersonId;
     published: string;
     updated?: string;
-}
+};

package/dist/types/CommentReportId.d.ts

@@ -1 +1,4 @@
+/**
+ * The comment report id.
+ */
 export type CommentReportId = number;

package/dist/types/CommentReportResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommentReportView } from "./CommentReportView";
-export interface CommentReportResponse {
+/**
+ * The comment report response.
+ */
+export type CommentReportResponse = {
     comment_report_view: CommentReportView;
-}
+};