lemmy-js-client 0.11.4-rc.9 → 0.12.3-rc.2

package/dist/interfaces/aggregates.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Aggregate data for a person.
+ */
 export interface PersonAggregates {
     id: number;
     person_id: number;
@@ -6,6 +9,9 @@ export interface PersonAggregates {
     comment_count: number;
     comment_score: number;
 }
+/**
+ * Aggregate data for your site.
+ */
 export interface SiteAggregates {
     id: number;
     site_id: number;
@@ -13,11 +19,26 @@ export interface SiteAggregates {
     posts: number;
     comments: number;
     communities: number;
+    /**
+     * Active users per day.
+     */
     users_active_day: number;
+    /**
+     * Active users per week.
+     */
     users_active_week: number;
+    /**
+     * Active users per month.
+     */
     users_active_month: number;
+    /**
+     * Active users per year.
+     */
     users_active_half_year: number;
 }
+/**
+ * Aggregate data for your post.
+ */
 export interface PostAggregates {
     id: number;
     post_id: number;
@@ -25,20 +46,41 @@ export interface PostAggregates {
     score: number;
     upvotes: number;
     downvotes: number;
+    /**
+     * Newest comment time, limited to 2 days, to prevent necrobumping.
+     */
     newest_comment_time_necro: string;
     newest_comment_time: string;
 }
+/**
+ * Aggregate data for your community.
+ */
 export interface CommunityAggregates {
     id: number;
     community_id: number;
     subscribers: number;
     posts: number;
     comments: number;
+    /**
+     * Active users per day.
+     */
     users_active_day: number;
+    /**
+     * Active users per week.
+     */
     users_active_week: number;
+    /**
+     * Active users per month.
+     */
     users_active_month: number;
+    /**
+     * Active users per year.
+     */
     users_active_half_year: number;
 }
+/**
+ * Aggregate data for your comment.
+ */
 export interface CommentAggregates {
     id: number;
     comment_id: number;

package/dist/interfaces/api/comment.d.ts

@@ -3,12 +3,18 @@ export interface CreateComment {
     content: string;
     parent_id?: number;
     post_id: number;
+    /**
+     * An optional front end ID, to tell which is comment is coming back.
+     */
     form_id?: string;
     auth: string;
 }
 export interface EditComment {
     content: string;
     comment_id: number;
+    /**
+     * An optional front end ID, to tell which is comment is coming back.
+     */
     form_id?: string;
     auth: string;
 }
@@ -45,6 +51,9 @@ export interface SaveComment {
 export interface CommentResponse {
     comment_view: CommentView;
     recipient_ids: number[];
+    /**
+     * An optional front end ID, to tell which is comment is coming back.
+     */
     form_id?: string;
 }
 export interface CreateCommentLike {
@@ -55,10 +64,17 @@ export interface CreateCommentLike {
 /**
  * Comment listing types are `All, Subscribed, Community`
  *
- * `community_name` can only be used for local communities. To get posts for a federated community, pass `community_id` instead.
+ * You can use either `community_id` or `community_name` as an id.
+ * To get posts for a federated community by name, use `name@instance.tld` .
  */
 export interface GetComments {
+    /**
+     * The [[ListingType]].
+     */
     type_?: string;
+    /**
+     * The [[SortType]].
+     */
     sort?: string;
     page?: number;
     limit?: number;
@@ -75,24 +91,23 @@ export interface CreateCommentReport {
     reason: string;
     auth: string;
 }
-export interface CreateCommentReportResponse {
-    success: boolean;
+export interface CommentReportResponse {
+    comment_report_view: CommentReportView;
 }
 export interface ResolveCommentReport {
     report_id: number;
     resolved: boolean;
     auth: string;
 }
-export interface ResolveCommentReportResponse {
-    report_id: number;
-    resolved: boolean;
-}
 export interface ListCommentReports {
     page?: number;
     limit?: number;
-    community?: number;
+    /**
+     * if no community is given, it returns reports for all communities moderated by the auth user.
+     */
+    community_id?: number;
     auth: string;
 }
 export interface ListCommentReportsResponse {
-    comments: CommentReportView[];
+    comment_reports: CommentReportView[];
 }

package/dist/interfaces/api/community.d.ts

@@ -1,4 +1,9 @@
 import { CommunityModeratorView, CommunityView, PersonViewSafe } from '../views';
+/**
+ * You can use either `id` or `name` as an id.
+ *
+ * To get a federated community by name, use `name@instance.tld` .
+ */
 export interface GetCommunity {
     id?: number;
     name?: string;
@@ -22,7 +27,13 @@ export interface CommunityResponse {
     community_view: CommunityView;
 }
 export interface ListCommunities {
+    /**
+     * The [[ListingType]].
+     */
     type_?: string;
+    /**
+     * The [[SortType]].
+     */
     sort?: string;
     page?: number;
     limit?: number;
@@ -35,6 +46,9 @@ export interface BanFromCommunity {
     community_id: number;
     person_id: number;
     ban: boolean;
+    /**
+     * Removes/Restores their comments and posts for that community.
+     */
     remove_data?: boolean;
     reason?: string;
     expires?: number;

package/dist/interfaces/api/person.d.ts

@@ -4,7 +4,9 @@ export interface Login {
     password: string;
 }
 /**
- * Only the first user will be able to be the admin.
+ * Register a new user.
+ *
+ * Only the first user to register will be able to be the admin.
  */
 export interface Register {
     username: string;
@@ -12,23 +14,51 @@ export interface Register {
     password: string;
     password_verify: string;
     show_nsfw: boolean;
+    /**
+     * Captcha is only checked if these are enabled in the server.
+     */
     captcha_uuid?: string;
     captcha_answer?: string;
 }
 export interface GetCaptcha {
 }
 export interface GetCaptchaResponse {
+    /**
+     * Will be undefined if captchas are disabled.
+     */
     ok?: CaptchaResponse;
 }
 export interface CaptchaResponse {
+    /**
+     * A Base64 encoded png.
+     */
     png: string;
+    /**
+     * A Base64 encoded wav file.
+     */
     wav?: string;
+    /**
+     * A UUID to match the one given on request.
+     */
     uuid: string;
 }
 export interface SaveUserSettings {
     show_nsfw?: boolean;
+    /**
+     * Default for this is `browser`.
+     */
     theme?: string;
+    /**
+     * The [[SortType]].
+     *
+     * The Sort types from above, zero indexed as a number
+     */
     default_sort_type?: number;
+    /**
+     * The [[ListingType]].
+     *
+     * Post listing types are `All, Subscribed, Community`
+     */
     default_listing_type?: number;
     lang?: string;
     avatar?: string;
@@ -58,11 +88,11 @@ export interface ChangePassword {
 export interface LoginResponse {
     jwt: string;
 }
-/**
- * `username` can only be used for local users. To get details for a federated user, pass `user_id` instead.
- */
 export interface GetPersonDetails {
     person_id?: number;
+    /**
+     * To get details for a federated user, use `person@instance.tld`.
+     */
     username?: string;
     sort?: string;
     page?: number;
@@ -97,6 +127,9 @@ export interface AddAdminResponse {
 export interface BanPerson {
     person_id: number;
     ban: boolean;
+    /**
+     * Removes/Restores their comments, posts, and communities
+     */
     remove_data?: boolean;
     reason?: string;
     expires?: number;
@@ -107,6 +140,9 @@ export interface BanPersonResponse {
     banned: boolean;
 }
 export interface GetReplies {
+    /**
+     * The [[SortType]].
+     */
     sort?: string;
     page?: number;
     limit?: number;
@@ -114,6 +150,9 @@ export interface GetReplies {
     auth: string;
 }
 export interface GetPersonMentions {
+    /**
+     * The [[SortType]].
+     */
     sort?: string;
     page?: number;
     limit?: number;
@@ -177,15 +216,15 @@ export interface PrivateMessagesResponse {
 export interface PrivateMessageResponse {
     private_message_view: PrivateMessageView;
 }
-/**
- * If a community is supplied, returns the report count for only that community, otherwise returns the report count for all communities the user moderates.
- */
 export interface GetReportCount {
-    community?: number;
+    /**
+     * If a community is supplied, returns the report count for only that community, otherwise returns the report count for all communities the user moderates.
+     */
+    community_id?: number;
     auth: string;
 }
 export interface GetReportCountResponse {
-    community?: number;
+    community_id?: number;
     comment_reports: number;
     post_reports: number;
 }

package/dist/interfaces/api/post.d.ts

@@ -1,3 +1,4 @@
+import { SiteMetadata } from '..';
 import { CommunityView, CommentView, CommunityModeratorView, PostReportView, PostView } from '../views';
 export interface CreatePost {
     name: string;
@@ -21,17 +22,23 @@ export interface GetPostResponse {
     moderators: CommunityModeratorView[];
     online: number;
 }
-/**
- * Post listing types are `All, Subscribed, Community`
- *
- * `community_name` can only be used for local communities. To get posts for a federated community, pass `community_id` instead.
- */
 export interface GetPosts {
+    /**
+     * The [[ListingType]].
+     *
+     * Post listing types are `All, Subscribed, Community`
+     */
     type_?: string;
+    /**
+     * The [[SortType]].
+     */
     sort?: string;
     page?: number;
     limit?: number;
     community_id?: number;
+    /**
+     * To get posts for a federated community by name, use `name@instance.tld` .
+     */
     community_name?: string;
     saved_only?: boolean;
     auth?: string;
@@ -39,11 +46,11 @@ export interface GetPosts {
 export interface GetPostsResponse {
     posts: PostView[];
 }
-/**
- * `score` can be 0, -1, or 1
- */
 export interface CreatePostLike {
     post_id: number;
+    /**
+     * `score` can be 0, -1, or 1. Anything else will be rejected.
+     */
     score: number;
     auth: string;
 }
@@ -95,24 +102,32 @@ export interface CreatePostReport {
     reason: string;
     auth: string;
 }
-export interface CreatePostReportResponse {
-    success: boolean;
+export interface PostReportResponse {
+    post_report_view: PostReportView;
 }
 export interface ResolvePostReport {
     report_id: number;
+    /**
+     * Either resolve or unresolve a report.
+     */
     resolved: boolean;
     auth: string;
 }
-export interface ResolvePostReportResponse {
-    report_id: number;
-    resolved: boolean;
-}
 export interface ListPostReports {
     page?: number;
     limit?: number;
+    /**
+     * if no community is given, it returns reports for all communities moderated by the auth user.
+     */
     community?: number;
     auth: string;
 }
 export interface ListPostReportsResponse {
-    posts: PostReportView[];
+    post_reports: PostReportView[];
+}
+export interface GetSiteMetadata {
+    url: string;
+}
+export interface GetSiteMetadataResponse {
+    metadata: SiteMetadata;
 }

package/dist/interfaces/api/site.d.ts

@@ -1,21 +1,36 @@
 import { CommunityBlockView, CommunityFollowerView, CommunityModeratorView, LocalUserSettingsView, PersonBlockView } from '../views';
-import { CommentView, CommunityView, ModAddCommunityView, ModAddView, ModBanFromCommunityView, ModBanView, ModLockPostView, ModRemoveCommentView, ModRemoveCommunityView, ModRemovePostView, ModStickyPostView, PostView, SiteView, PersonViewSafe } from '../views';
+import { CommentView, CommunityView, ModAddCommunityView, ModTransferCommunityView, ModAddView, ModBanFromCommunityView, ModBanView, ModLockPostView, ModRemoveCommentView, ModRemoveCommunityView, ModRemovePostView, ModStickyPostView, PostView, SiteView, PersonViewSafe } from '../views';
 /**
- * Search types are `All, Comments, Posts, Communities, Users, Url`
+ * Search lemmy for different types of data.
  */
 export interface Search {
+    /**
+     * The search query string.
+     */
     q: string;
+    /**
+     * The [[SearchType]].
+     */
     type_?: string;
     community_id?: number;
     community_name?: string;
     creator_id?: number;
+    /**
+     * The [[SortType]].
+     */
     sort?: string;
+    /**
+     * The [[ListingType]].
+     */
     listing_type?: string;
     page?: number;
     limit?: number;
     auth?: string;
 }
 export interface SearchResponse {
+    /**
+     * The [[SearchType]].
+     */
     type_: string;
     comments: CommentView[];
     posts: PostView[];
@@ -37,6 +52,7 @@ export interface GetModlogResponse {
     banned_from_community: ModBanFromCommunityView[];
     banned: ModBanView[];
     added_to_community: ModAddCommunityView[];
+    transferred_to_community: ModTransferCommunityView[];
     added: ModAddView[];
 }
 export interface CreateSite {
@@ -70,14 +86,23 @@ export interface SiteResponse {
     site_view: SiteView;
 }
 export interface GetSiteResponse {
+    /**
+     * Optional, because the site might not be set up yet.
+     */
     site_view?: SiteView;
     admins: PersonViewSafe[];
     banned: PersonViewSafe[];
     online: number;
     version: string;
+    /**
+     * If you're logged in, you'll get back extra user info.
+     */
     my_user?: MyUserInfo;
     federated_instances?: FederatedInstances;
 }
+/**
+ * Your user info, such as blocks, follows, etc.
+ */
 export interface MyUserInfo {
     local_user_view: LocalUserSettingsView;
     follows: CommunityFollowerView[];
@@ -104,3 +129,13 @@ export interface FederatedInstances {
     allowed?: string[];
     blocked?: string[];
 }
+export interface ResolveObject {
+    q: string;
+    auth?: string;
+}
+export interface ResolveObjectResponse {
+    comment?: CommentView;
+    post?: PostView;
+    community?: CommunityView;
+    person?: PersonViewSafe;
+}

package/dist/interfaces/others.d.ts

@@ -1,6 +1,6 @@
 export declare const VERSION = "v3";
 /**
- * All of the websocket operations available
+ * All of the websocket operations available.
  */
 export declare enum UserOperation {
     Login = 0,
@@ -43,46 +43,91 @@ export declare enum UserOperation {
     AddAdmin = 37,
     BanPerson = 38,
     Search = 39,
-    MarkAllAsRead = 40,
-    SaveUserSettings = 41,
-    TransferCommunity = 42,
-    TransferSite = 43,
-    DeleteAccount = 44,
-    PasswordReset = 45,
-    PasswordChange = 46,
-    CreatePrivateMessage = 47,
-    EditPrivateMessage = 48,
-    DeletePrivateMessage = 49,
-    MarkPrivateMessageAsRead = 50,
-    GetPrivateMessages = 51,
-    UserJoin = 52,
-    GetComments = 53,
-    GetSiteConfig = 54,
-    SaveSiteConfig = 55,
-    PostJoin = 56,
-    CommunityJoin = 57,
-    ChangePassword = 58,
-    BlockCommunity = 59,
-    BlockPerson = 60
+    ResolveObject = 40,
+    MarkAllAsRead = 41,
+    SaveUserSettings = 42,
+    TransferCommunity = 43,
+    TransferSite = 44,
+    DeleteAccount = 45,
+    PasswordReset = 46,
+    PasswordChange = 47,
+    CreatePrivateMessage = 48,
+    EditPrivateMessage = 49,
+    DeletePrivateMessage = 50,
+    MarkPrivateMessageAsRead = 51,
+    GetPrivateMessages = 52,
+    UserJoin = 53,
+    GetComments = 54,
+    GetSiteConfig = 55,
+    SaveSiteConfig = 56,
+    PostJoin = 57,
+    CommunityJoin = 58,
+    ChangePassword = 59,
+    GetSiteMetadata = 60,
+    BlockCommunity = 61,
+    BlockPerson = 62,
+    CreateCommentReport = 63,
+    ResolveCommentReport = 64,
+    ListCommentReports = 65,
+    CreatePostReport = 66,
+    ResolvePostReport = 67,
+    ListPostReports = 68,
+    GetReportCount = 69
 }
+/**
+ * Different sort types used in lemmy.
+ */
 export declare enum SortType {
+    /**
+     * Posts sorted by the most recent comment.
+     */
     Active = "Active",
+    /**
+     * Posts sorted by the published time.
+     */
     Hot = "Hot",
     New = "New",
+    /**
+     * The top posts for this last day.
+     */
     TopDay = "TopDay",
+    /**
+     * The top posts for this last week.
+     */
     TopWeek = "TopWeek",
+    /**
+     * The top posts for this last month.
+     */
     TopMonth = "TopMonth",
+    /**
+     * The top posts for this last year.
+     */
     TopYear = "TopYear",
+    /**
+     * The top posts of all time.
+     */
     TopAll = "TopAll",
+    /**
+     * Posts sorted by the most comments.
+     */
     MostComments = "MostComments",
+    /**
+     * Posts sorted by the newest comments, with no necrobumping. IE a forum sort.
+     */
     NewComments = "NewComments"
 }
+/**
+ * The different listing types for post and comment fetches.
+ */
 export declare enum ListingType {
     All = "All",
     Local = "Local",
     Subscribed = "Subscribed",
     Community = "Community"
 }
+/**
+ * Search types for lemmy's search.
+ */
 export declare enum SearchType {
     All = "All",
     Comments = "Comments",
@@ -91,13 +136,45 @@ export declare enum SearchType {
     Users = "Users",
     Url = "Url"
 }
+/**
+ * A websocket response. Includes the return type.
+ * Can be used like:
+ *
+ * ```ts
+ * if (op == UserOperation.Search) {
+ *   let data = wsJsonToRes<SearchResponse>(msg).data;
+ * }
+ * ```
+ */
 export interface WebSocketResponse<ResponseType> {
     op: UserOperation;
+    /**
+     * This contains the data for a websocket response.
+     *
+     * The correct response type if given is in [[LemmyHttp]].
+     */
     data: ResponseType;
 }
+/**
+ * A websocket JSON response that includes the errors.
+ */
 export interface WebSocketJsonResponse<ResponseType> {
     op?: string;
+    /**
+     * This contains the data for a websocket response.
+     *
+     * The correct response type if given is in [[LemmyHttp]].
+     */
     data?: ResponseType;
     error?: string;
     reconnect?: boolean;
 }
+/**
+ * A holder for a site's metadata ( such as opengraph tags ), used for post links.
+ */
+export interface SiteMetadata {
+    title?: string;
+    description?: string;
+    image?: string;
+    html?: string;
+}