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

package/dist/types/GetPosts.d.ts

@@ -2,9 +2,15 @@ import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { PaginationCursor } from "./PaginationCursor";
 import type { PostSortType } from "./PostSortType";
-export interface GetPosts {
+/**
+ * Get a list of posts.
+ */
+export type GetPosts = {
     type_?: ListingType;
     sort?: PostSortType;
+    /**
+     * DEPRECATED, use page_cursor
+     */
     page?: number;
     limit?: number;
     community_id?: CommunityId;
@@ -13,7 +19,17 @@ export interface GetPosts {
     liked_only?: boolean;
     disliked_only?: boolean;
     show_hidden?: boolean;
+    /**
+     * If true, then show the read posts (even if your user setting is to hide them)
+     */
     show_read?: boolean;
+    /**
+     * If true, then show the nsfw posts (even if your user setting is to hide them)
+     */
     show_nsfw?: boolean;
+    /**
+     * If true, then only show posts with no comments
+     */
+    no_comments_only?: boolean;
     page_cursor?: PaginationCursor;
-}
+};

package/dist/types/GetPostsResponse.d.ts

@@ -1,6 +1,12 @@
 import type { PaginationCursor } from "./PaginationCursor";
 import type { PostView } from "./PostView";
-export interface GetPostsResponse {
+/**
+ * The post list response.
+ */
+export type GetPostsResponse = {
     posts: Array<PostView>;
+    /**
+     * the pagination cursor to use to fetch the next page
+     */
     next_page?: PaginationCursor;
-}
+};

package/dist/types/GetPrivateMessages.d.ts

@@ -1,7 +1,10 @@
 import type { PersonId } from "./PersonId";
-export interface GetPrivateMessages {
+/**
+ * Get your private messages.
+ */
+export type GetPrivateMessages = {
     unread_only?: boolean;
     page?: number;
     limit?: number;
     creator_id?: PersonId;
-}
+};

package/dist/types/GetRandomCommunity.d.ts

@@ -0,0 +1,7 @@
+import type { ListingType } from "./ListingType";
+/**
+ * Fetches a random community
+ */
+export type GetRandomCommunity = {
+    type_?: ListingType;
+};

package/dist/types/GetRandomCommunity.js

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

package/dist/types/GetRegistrationApplication.d.ts

@@ -1,4 +1,7 @@
 import type { PersonId } from "./PersonId";
-export interface GetRegistrationApplication {
+/**
+ * Gets a registration application for a person
+ */
+export type GetRegistrationApplication = {
     person_id: PersonId;
-}
+};

package/dist/types/GetReplies.d.ts

@@ -1,7 +1,10 @@
 import type { CommentSortType } from "./CommentSortType";
-export interface GetReplies {
+/**
+ * Get comment replies.
+ */
+export type GetReplies = {
     sort?: CommentSortType;
     page?: number;
     limit?: number;
     unread_only?: boolean;
-}
+};

package/dist/types/GetRepliesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommentReplyView } from "./CommentReplyView";
-export interface GetRepliesResponse {
+/**
+ * Fetches your replies.
+ */
+export type GetRepliesResponse = {
     replies: Array<CommentReplyView>;
-}
+};

package/dist/types/GetReportCount.d.ts

@@ -1,4 +1,7 @@
 import type { CommunityId } from "./CommunityId";
-export interface GetReportCount {
+/**
+ * Get a count of the number of reports.
+ */
+export type GetReportCount = {
     community_id?: CommunityId;
-}
+};

package/dist/types/GetReportCountResponse.d.ts

@@ -1,7 +1,10 @@
 import type { CommunityId } from "./CommunityId";
-export interface GetReportCountResponse {
+/**
+ * A response for the number of reports.
+ */
+export type GetReportCountResponse = {
     community_id?: CommunityId;
     comment_reports: number;
     post_reports: number;
     private_message_reports?: number;
-}
+};

package/dist/types/GetSiteMetadata.d.ts

@@ -1,3 +1,6 @@
-export interface GetSiteMetadata {
+/**
+ * Get metadata for a given site.
+ */
+export type GetSiteMetadata = {
     url: string;
-}
+};

package/dist/types/GetSiteMetadataResponse.d.ts

@@ -1,4 +1,7 @@
 import type { LinkMetadata } from "./LinkMetadata";
-export interface GetSiteMetadataResponse {
+/**
+ * The site metadata response.
+ */
+export type GetSiteMetadataResponse = {
     metadata: LinkMetadata;
-}
+};

package/dist/types/GetSiteResponse.d.ts

@@ -7,15 +7,32 @@ import type { PersonView } from "./PersonView";
 import type { PublicOAuthProvider } from "./PublicOAuthProvider";
 import type { SiteView } from "./SiteView";
 import type { Tagline } from "./Tagline";
-export interface GetSiteResponse {
+/**
+ * An expanded response for a site.
+ */
+export type GetSiteResponse = {
     site_view: SiteView;
     admins: Array<PersonView>;
     version: string;
     my_user?: MyUserInfo;
     all_languages: Array<Language>;
     discussion_languages: Array<LanguageId>;
+    /**
+     * deprecated, use field `tagline` or /api/v3/tagline/list
+     */
+    taglines: Array<null>;
+    /**
+     * deprecated, use /api/v3/custom_emoji/list
+     */
+    custom_emojis: Array<null>;
+    /**
+     * If the site has any taglines, a random one is included here for displaying
+     */
     tagline?: Tagline;
+    /**
+     * A list of external auth methods your site supports.
+     */
     oauth_providers?: Array<PublicOAuthProvider>;
     admin_oauth_providers?: Array<OAuthProvider>;
     blocked_urls: Array<LocalSiteUrlBlocklist>;
-}
+};

package/dist/types/GetUnreadCountResponse.d.ts

@@ -1,5 +1,8 @@
-export interface GetUnreadCountResponse {
+/**
+ * A response containing counts for your notifications.
+ */
+export type GetUnreadCountResponse = {
     replies: number;
     mentions: number;
     private_messages: number;
-}
+};

package/dist/types/GetUnreadRegistrationApplicationCountResponse.d.ts

@@ -1,3 +1,6 @@
-export interface GetUnreadRegistrationApplicationCountResponse {
+/**
+ * The count of unread registration applications.
+ */
+export type GetUnreadRegistrationApplicationCountResponse = {
     registration_applications: number;
-}
+};

package/dist/types/HideCommunity.d.ts

@@ -1,6 +1,9 @@
 import type { CommunityId } from "./CommunityId";
-export interface HideCommunity {
+/**
+ * Hide a community from the main view.
+ */
+export type HideCommunity = {
     community_id: CommunityId;
     hidden: boolean;
     reason?: string;
-}
+};

package/dist/types/HidePost.d.ts

@@ -1,5 +1,8 @@
 import type { PostId } from "./PostId";
-export interface HidePost {
+/**
+ * Hide a post from list views
+ */
+export type HidePost = {
     post_ids: Array<PostId>;
     hide: boolean;
-}
+};

package/dist/types/ImageDetails.d.ts

@@ -1,6 +1,7 @@
-export interface ImageDetails {
-    link: string;
+import type { DbUrl } from "./DbUrl";
+export type ImageDetails = {
+    link: DbUrl;
     width: number;
     height: number;
     content_type: string;
-}
+};

package/dist/types/ImageDetails.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/Instance.d.ts

@@ -1,9 +1,12 @@
 import type { InstanceId } from "./InstanceId";
-export interface Instance {
+/**
+ * A federated instance / site.
+ */
+export type Instance = {
     id: InstanceId;
     domain: string;
     published: string;
     updated?: string;
     software?: string;
     version?: string;
-}
+};

package/dist/types/InstanceId.d.ts

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

package/dist/types/InstanceWithFederationState.d.ts

@@ -1,11 +1,15 @@
 import type { InstanceId } from "./InstanceId";
 import type { ReadableFederationState } from "./ReadableFederationState";
-export interface InstanceWithFederationState {
+export type InstanceWithFederationState = {
+    /**
+     * if federation to this instance is or was active, show state of outgoing federation to this
+     * instance
+     */
+    federation_state?: ReadableFederationState;
     id: InstanceId;
     domain: string;
     published: string;
     updated?: string;
     software?: string;
     version?: string;
-    federation_state?: ReadableFederationState;
-}
+};

package/dist/types/Language.d.ts

@@ -1,6 +1,9 @@
 import type { LanguageId } from "./LanguageId";
-export interface Language {
+/**
+ * A language.
+ */
+export type Language = {
     id: LanguageId;
     code: string;
     name: string;
-}
+};

package/dist/types/LanguageId.d.ts

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

package/dist/types/LemmyErrorType.d.ts

@@ -1,3 +1,4 @@
+import type { FederationError } from "./FederationError";
 export type LemmyErrorType = {
     error: "report_reason_required";
 } | {
@@ -24,18 +25,12 @@ export type LemmyErrorType = {
     error: "couldnt_update_private_message";
 } | {
     error: "cannot_leave_admin";
-} | {
-    error: "no_lines_in_html";
-} | {
-    error: "site_metadata_page_is_not_doctype_html";
 } | {
     error: "pictrs_response_error";
     message: string;
 } | {
     error: "pictrs_purge_response_error";
     message: string;
-} | {
-    error: "pictrs_caching_disabled";
 } | {
     error: "image_url_missing_path_segments";
 } | {
@@ -48,10 +43,6 @@ export type LemmyErrorType = {
     error: "not_an_image_type";
 } | {
     error: "not_a_mod_or_admin";
-} | {
-    error: "no_admins";
-} | {
-    error: "not_top_admin";
 } | {
     error: "not_top_mod";
 } | {
@@ -64,16 +55,12 @@ export type LemmyErrorType = {
     error: "site_ban";
 } | {
     error: "deleted";
-} | {
-    error: "banned_from_community";
 } | {
     error: "person_is_blocked";
 } | {
     error: "community_is_blocked";
 } | {
     error: "instance_is_blocked";
-} | {
-    error: "downvotes_are_disabled";
 } | {
     error: "instance_is_private";
 } | {
@@ -100,8 +87,6 @@ export type LemmyErrorType = {
     error: "community_already_exists";
 } | {
     error: "language_not_allowed";
-} | {
-    error: "only_mods_can_post_in_community";
 } | {
     error: "couldnt_update_post";
 } | {
@@ -124,41 +109,14 @@ export type LemmyErrorType = {
     error: "email_already_exists";
 } | {
     error: "username_already_exists";
-} | {
-    error: "federation_forbidden_by_strict_allow_list";
 } | {
     error: "person_is_banned_from_community";
-} | {
-    error: "object_is_not_public";
-} | {
-    error: "invalid_community";
-} | {
-    error: "cannot_create_post_or_comment_in_deleted_or_removed_community";
-} | {
-    error: "cannot_receive_page";
-} | {
-    error: "new_post_cannot_be_locked";
-} | {
-    error: "only_local_admin_can_remove_community";
-} | {
-    error: "only_local_admin_can_restore_community";
 } | {
     error: "no_id_given";
 } | {
     error: "incorrect_login";
-} | {
-    error: "invalid_query";
 } | {
     error: "object_not_local";
-} | {
-    error: "post_is_locked";
-} | {
-    error: "person_is_banned_from_site";
-    message: string;
-} | {
-    error: "invalid_vote_value";
-} | {
-    error: "page_does_not_specify_creator";
 } | {
     error: "no_email_setup";
 } | {
@@ -231,8 +189,6 @@ export type LemmyErrorType = {
     error: "couldnt_update_replies";
 } | {
     error: "couldnt_update_person_mentions";
-} | {
-    error: "post_title_too_long";
 } | {
     error: "couldnt_create_post";
 } | {
@@ -261,17 +217,9 @@ export type LemmyErrorType = {
     error: "slurs";
 } | {
     error: "registration_denied";
-    message: string | null;
-} | {
-    error: "federation_disabled";
-} | {
-    error: "domain_blocked";
-    message: string;
-} | {
-    error: "domain_not_in_allow_list";
-    message: string;
-} | {
-    error: "federation_disabled_by_strict_allow_list";
+    message: {
+        reason?: string;
+    };
 } | {
     error: "site_name_required";
 } | {
@@ -294,8 +242,6 @@ export type LemmyErrorType = {
     error: "instance_block_already_exists";
 } | {
     error: "too_many_items";
-} | {
-    error: "community_has_no_followers";
 } | {
     error: "ban_expiration_in_past";
 } | {
@@ -305,9 +251,10 @@ export type LemmyErrorType = {
 } | {
     error: "cant_block_local_instance";
 } | {
-    error: "url_without_domain";
+    error: "unknown";
+    message: string;
 } | {
-    error: "inbox_timeout";
+    error: "url_length_overflow";
 } | {
     error: "oauth_authorization_invalid";
 } | {
@@ -317,16 +264,16 @@ export type LemmyErrorType = {
 } | {
     error: "couldnt_delete_oauth_provider";
 } | {
-    error: "unknown";
-    message: string;
-} | {
-    error: "cant_delete_site";
+    error: "not_found";
 } | {
-    error: "url_length_overflow";
+    error: "community_has_no_followers";
 } | {
     error: "post_schedule_time_must_be_in_future";
 } | {
     error: "too_many_scheduled_posts";
 } | {
-    error: "not_found";
+    error: "federation_error";
+    message: {
+        error?: FederationError;
+    };
 };

package/dist/types/LemmyErrorType.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/LinkMetadata.d.ts

@@ -1,7 +1,11 @@
-export interface LinkMetadata {
+import type { DbUrl } from "./DbUrl";
+/**
+ * Site metadata, from its opengraph tags.
+ */
+export type LinkMetadata = {
+    content_type?: string;
     title?: string;
     description?: string;
-    image?: string;
-    embed_video_url?: string;
-    content_type?: string;
-}
+    image?: DbUrl;
+    embed_video_url?: DbUrl;
+};

package/dist/types/LinkMetadata.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/ListCommentLikes.d.ts

@@ -1,6 +1,9 @@
 import type { CommentId } from "./CommentId";
-export interface ListCommentLikes {
+/**
+ * List comment likes. Admins-only.
+ */
+export type ListCommentLikes = {
     comment_id: CommentId;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListCommentLikesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { VoteView } from "./VoteView";
-export interface ListCommentLikesResponse {
+/**
+ * The comment likes response
+ */
+export type ListCommentLikesResponse = {
     comment_likes: Array<VoteView>;
-}
+};

package/dist/types/ListCommentReports.d.ts

@@ -1,9 +1,18 @@
 import type { CommentId } from "./CommentId";
 import type { CommunityId } from "./CommunityId";
-export interface ListCommentReports {
+/**
+ * List comment reports.
+ */
+export type ListCommentReports = {
     comment_id?: CommentId;
     page?: number;
     limit?: number;
+    /**
+     * Only shows the unresolved reports
+     */
     unresolved_only?: boolean;
+    /**
+     * if no community is given, it returns reports for all communities moderated by the auth user
+     */
     community_id?: CommunityId;
-}
+};

package/dist/types/ListCommentReportsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommentReportView } from "./CommentReportView";
-export interface ListCommentReportsResponse {
+/**
+ * The comment report list response.
+ */
+export type ListCommentReportsResponse = {
     comment_reports: Array<CommentReportView>;
-}
+};

package/dist/types/ListCommunities.d.ts

@@ -1,9 +1,12 @@
+import type { CommunitySortType } from "./CommunitySortType";
 import type { ListingType } from "./ListingType";
-import type { PostSortType } from "./PostSortType";
-export interface ListCommunities {
+/**
+ * Fetches a list of communities.
+ */
+export type ListCommunities = {
     type_?: ListingType;
-    sort?: PostSortType;
+    sort?: CommunitySortType;
     show_nsfw?: boolean;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListCommunitiesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommunityView } from "./CommunityView";
-export interface ListCommunitiesResponse {
+/**
+ * The response for listing communities.
+ */
+export type ListCommunitiesResponse = {
     communities: Array<CommunityView>;
-}
+};

package/dist/types/ListCommunityPendingFollows.d.ts

@@ -0,0 +1,9 @@
+export type ListCommunityPendingFollows = {
+    /**
+     * Only shows the unapproved applications
+     */
+    pending_only?: boolean;
+    all_communities?: boolean;
+    page?: number;
+    limit?: number;
+};

package/dist/types/ListCommunityPendingFollows.js

@@ -0,0 +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/ListCommunityPendingFollowsResponse.d.ts

@@ -0,0 +1,4 @@
+import type { PendingFollow } from "./PendingFollow";
+export type ListCommunityPendingFollowsResponse = {
+    items: Array<PendingFollow>;
+};

package/dist/types/ListCommunityPendingFollowsResponse.js

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

package/dist/types/ListCustomEmojis.d.ts

@@ -1,6 +1,9 @@
-export interface ListCustomEmojis {
+/**
+ * Fetches a list of custom emojis.
+ */
+export type ListCustomEmojis = {
     page?: number;
     limit?: number;
     category?: string;
     ignore_page_limits?: boolean;
-}
+};

package/dist/types/ListCustomEmojisResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CustomEmojiView } from "./CustomEmojiView";
-export interface ListCustomEmojisResponse {
+/**
+ * A response for custom emojis.
+ */
+export type ListCustomEmojisResponse = {
     custom_emojis: Array<CustomEmojiView>;
-}
+};

package/dist/types/ListLoginsResponse.d.ts

@@ -1,4 +1,4 @@
 import type { LoginToken } from "./LoginToken";
-export interface ListLoginsResponse {
+export type ListLoginsResponse = {
     logins: Array<LoginToken>;
-}
+};