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

package/dist/types/GetComment.d.ts

@@ -1,4 +1,7 @@
 import type { CommentId } from "./CommentId";
-export interface GetComment {
+/**
+ * Fetch an individual comment.
+ */
+export type GetComment = {
     id: CommentId;
-}
+};

package/dist/types/GetComments.d.ts

@@ -3,7 +3,10 @@ import type { CommentSortType } from "./CommentSortType";
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { PostId } from "./PostId";
-export interface GetComments {
+/**
+ * Get a list of comments.
+ */
+export type GetComments = {
     type_?: ListingType;
     sort?: CommentSortType;
     max_depth?: number;
@@ -16,4 +19,4 @@ export interface GetComments {
     saved_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
-}
+};

package/dist/types/GetCommentsResponse.d.ts

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

package/dist/types/GetCommunity.d.ts

@@ -1,5 +1,11 @@
 import type { CommunityId } from "./CommunityId";
-export interface GetCommunity {
+/**
+ * Get a community. Must provide either an id, or a name.
+ */
+export type GetCommunity = {
     id?: CommunityId;
+    /**
+     * Example: star_trek , or star_trek@xyz.tld
+     */
     name?: string;
-}
+};

package/dist/types/GetCommunityPendingFollowsCount.d.ts

@@ -1,4 +1,4 @@
 import type { CommunityId } from "./CommunityId";
-export interface GetCommunityPendingFollowsCount {
+export type GetCommunityPendingFollowsCount = {
     community_id: CommunityId;
-}
+};

package/dist/types/GetCommunityPendingFollowsCountResponse.d.ts

@@ -1,3 +1,3 @@
-export interface GetCommunityPendingFollowsCountResponse {
+export type GetCommunityPendingFollowsCountResponse = {
     count: number;
-}
+};

package/dist/types/GetCommunityResponse.d.ts

@@ -2,9 +2,12 @@ import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { CommunityView } from "./CommunityView";
 import type { LanguageId } from "./LanguageId";
 import type { Site } from "./Site";
-export interface GetCommunityResponse {
+/**
+ * The community response.
+ */
+export type GetCommunityResponse = {
     community_view: CommunityView;
     site?: Site;
     moderators: Array<CommunityModeratorView>;
     discussion_languages: Array<LanguageId>;
-}
+};

package/dist/types/GetFederatedInstancesResponse.d.ts

@@ -1,4 +1,10 @@
 import type { FederatedInstances } from "./FederatedInstances";
-export interface GetFederatedInstancesResponse {
+/**
+ * A response of federated instances.
+ */
+export type GetFederatedInstancesResponse = {
+    /**
+     * Optional, because federation may be disabled.
+     */
     federated_instances?: FederatedInstances;
-}
+};

package/dist/types/GetModlog.d.ts

@@ -3,7 +3,10 @@ import type { CommunityId } from "./CommunityId";
 import type { ModlogActionType } from "./ModlogActionType";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface GetModlog {
+/**
+ * Fetches the modlog.
+ */
+export type GetModlog = {
     mod_person_id?: PersonId;
     community_id?: CommunityId;
     page?: number;
@@ -12,4 +15,4 @@ export interface GetModlog {
     other_person_id?: PersonId;
     post_id?: PostId;
     comment_id?: CommentId;
-}
+};

package/dist/types/GetModlogResponse.d.ts

@@ -1,3 +1,5 @@
+import type { AdminAllowInstanceView } from "./AdminAllowInstanceView";
+import type { AdminBlockInstanceView } from "./AdminBlockInstanceView";
 import type { AdminPurgeCommentView } from "./AdminPurgeCommentView";
 import type { AdminPurgeCommunityView } from "./AdminPurgeCommunityView";
 import type { AdminPurgePersonView } from "./AdminPurgePersonView";
@@ -13,7 +15,10 @@ import type { ModRemoveCommentView } from "./ModRemoveCommentView";
 import type { ModRemoveCommunityView } from "./ModRemoveCommunityView";
 import type { ModRemovePostView } from "./ModRemovePostView";
 import type { ModTransferCommunityView } from "./ModTransferCommunityView";
-export interface GetModlogResponse {
+/**
+ * The modlog fetch response.
+ */
+export type GetModlogResponse = {
     removed_posts: Array<ModRemovePostView>;
     locked_posts: Array<ModLockPostView>;
     featured_posts: Array<ModFeaturePostView>;
@@ -29,4 +34,6 @@ export interface GetModlogResponse {
     admin_purged_posts: Array<AdminPurgePostView>;
     admin_purged_comments: Array<AdminPurgeCommentView>;
     hidden_communities: Array<ModHideCommunityView>;
-}
+    admin_block_instance: Array<AdminBlockInstanceView>;
+    admin_allow_instance: Array<AdminAllowInstanceView>;
+};

package/dist/types/GetPersonDetails.d.ts

@@ -1,12 +1,20 @@
 import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
 import type { PostSortType } from "./PostSortType";
-export interface GetPersonDetails {
+/**
+ * Gets a person's details.
+ *
+ * Either person_id, or username are required.
+ */
+export type GetPersonDetails = {
     person_id?: PersonId;
+    /**
+     * Example: dessalines , or dessalines@xyz.tld
+     */
     username?: string;
     sort?: PostSortType;
     page?: number;
     limit?: number;
     community_id?: CommunityId;
     saved_only?: boolean;
-}
+};

package/dist/types/GetPersonDetailsResponse.d.ts

@@ -3,10 +3,13 @@ import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { PersonView } from "./PersonView";
 import type { PostView } from "./PostView";
 import type { Site } from "./Site";
-export interface GetPersonDetailsResponse {
+/**
+ * A person's details response.
+ */
+export type GetPersonDetailsResponse = {
     person_view: PersonView;
     site?: Site;
     comments: Array<CommentView>;
     posts: Array<PostView>;
     moderates: Array<CommunityModeratorView>;
-}
+};

package/dist/types/GetPersonMentions.d.ts

@@ -1,7 +1,10 @@
 import type { CommentSortType } from "./CommentSortType";
-export interface GetPersonMentions {
+/**
+ * Get mentions for your user.
+ */
+export type GetPersonMentions = {
     sort?: CommentSortType;
     page?: number;
     limit?: number;
     unread_only?: boolean;
-}
+};

package/dist/types/GetPersonMentionsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PersonMentionView } from "./PersonMentionView";
-export interface GetPersonMentionsResponse {
+/**
+ * The response of mentions for your user.
+ */
+export type GetPersonMentionsResponse = {
     mentions: Array<PersonMentionView>;
-}
+};

package/dist/types/GetPost.d.ts

@@ -1,6 +1,9 @@
 import type { CommentId } from "./CommentId";
 import type { PostId } from "./PostId";
-export interface GetPost {
+/**
+ * Get a post. Needs either the post id, or comment_id.
+ */
+export type GetPost = {
     id?: PostId;
     comment_id?: CommentId;
-}
+};

package/dist/types/GetPostResponse.d.ts

@@ -1,9 +1,15 @@
 import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { CommunityView } from "./CommunityView";
 import type { PostView } from "./PostView";
-export interface GetPostResponse {
+/**
+ * The post response.
+ */
+export type GetPostResponse = {
     post_view: PostView;
     community_view: CommunityView;
     moderators: Array<CommunityModeratorView>;
+    /**
+     * A list of cross-posts, or other times / communities this link has been posted to.
+     */
     cross_posts: Array<PostView>;
-}
+};

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,22 @@ 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;
+    /**
+     * Whether to automatically mark fetched posts as read.
+     */
+    mark_as_read?: boolean;
+    /**
+     * If true, then only show posts with no comments
+     */
+    no_comments_only?: boolean;
     page_cursor?: PaginationCursor;
-}
+    page_back?: boolean;
+};

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

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

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,6 @@
-import type { CommunityId } from "./CommunityId";
-export interface GetReportCountResponse {
-    community_id?: CommunityId;
-    comment_reports: number;
-    post_reports: number;
-    private_message_reports?: number;
-}
+/**
+ * A response for the number of reports.
+ */
+export type GetReportCountResponse = {
+    count: number;
+};

package/dist/types/GetReportCountResponse.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/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,17 +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 {
-    post_ids: Array<PostId>;
+/**
+ * Hide a post from list views
+ */
+export type HidePost = {
+    post_id: 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;