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

package/dist/types/PostReportResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PostReportView } from "./PostReportView";
-export interface PostReportResponse {
+/**
+ * The post report response.
+ */
+export type PostReportResponse = {
     post_report_view: PostReportView;
-}
+};

package/dist/types/PostReportView.d.ts

@@ -4,7 +4,10 @@ import type { Post } from "./Post";
 import type { PostAggregates } from "./PostAggregates";
 import type { PostReport } from "./PostReport";
 import type { SubscribedType } from "./SubscribedType";
-export interface PostReportView {
+/**
+ * A post report view.
+ */
+export type PostReportView = {
     post_report: PostReport;
     post: Post;
     community: Community;
@@ -22,4 +25,4 @@ export interface PostReportView {
     unread_comments: number;
     counts: PostAggregates;
     resolver?: Person;
-}
+};

package/dist/types/PostResponse.d.ts

@@ -1,4 +1,4 @@
 import type { PostView } from "./PostView";
-export interface PostResponse {
+export type PostResponse = {
     post_view: PostView;
-}
+};

package/dist/types/PostSortType.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The post sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
+ */
+export type PostSortType = "Active" | "Hot" | "New" | "Old" | "TopDay" | "TopWeek" | "TopMonth" | "TopYear" | "TopAll" | "MostComments" | "NewComments" | "TopHour" | "TopSixHour" | "TopTwelveHour" | "TopThreeMonths" | "TopSixMonths" | "TopNineMonths" | "Controversial" | "Scaled";

package/dist/types/PostSortType.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/PostView.d.ts

@@ -4,7 +4,10 @@ import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { PostAggregates } from "./PostAggregates";
 import type { SubscribedType } from "./SubscribedType";
-export interface PostView {
+/**
+ * A post view.
+ */
+export type PostView = {
     post: Post;
     creator: Person;
     community: Community;
@@ -21,4 +24,4 @@ export interface PostView {
     creator_blocked: boolean;
     my_vote?: number;
     unread_comments: number;
-}
+};

package/dist/types/PrivateMessage.d.ts

@@ -1,6 +1,10 @@
+import type { DbUrl } from "./DbUrl";
 import type { PersonId } from "./PersonId";
 import type { PrivateMessageId } from "./PrivateMessageId";
-export interface PrivateMessage {
+/**
+ * A private message.
+ */
+export type PrivateMessage = {
     id: PrivateMessageId;
     creator_id: PersonId;
     recipient_id: PersonId;
@@ -9,6 +13,6 @@ export interface PrivateMessage {
     read: boolean;
     published: string;
     updated?: string;
-    ap_id: string;
+    ap_id: DbUrl;
     local: boolean;
-}
+};

package/dist/types/PrivateMessageId.d.ts

@@ -1 +1,4 @@
+/**
+ * The private message id.
+ */
 export type PrivateMessageId = number;

package/dist/types/PrivateMessageReport.d.ts

@@ -1,14 +1,20 @@
 import type { PersonId } from "./PersonId";
 import type { PrivateMessageId } from "./PrivateMessageId";
 import type { PrivateMessageReportId } from "./PrivateMessageReportId";
-export interface PrivateMessageReport {
+/**
+ * The private message report.
+ */
+export type PrivateMessageReport = {
     id: PrivateMessageReportId;
     creator_id: PersonId;
     private_message_id: PrivateMessageId;
+    /**
+     * The original text.
+     */
     original_pm_text: string;
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
     published: string;
     updated?: string;
-}
+};

package/dist/types/PrivateMessageReportId.d.ts

@@ -1 +1,4 @@
+/**
+ * The private message report id.
+ */
 export type PrivateMessageReportId = number;

package/dist/types/PrivateMessageReportResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PrivateMessageReportView } from "./PrivateMessageReportView";
-export interface PrivateMessageReportResponse {
+/**
+ * A private message report response.
+ */
+export type PrivateMessageReportResponse = {
     private_message_report_view: PrivateMessageReportView;
-}
+};

package/dist/types/PrivateMessageReportView.d.ts

@@ -1,10 +1,13 @@
 import type { Person } from "./Person";
 import type { PrivateMessage } from "./PrivateMessage";
 import type { PrivateMessageReport } from "./PrivateMessageReport";
-export interface PrivateMessageReportView {
+/**
+ * A private message report view.
+ */
+export type PrivateMessageReportView = {
     private_message_report: PrivateMessageReport;
     private_message: PrivateMessage;
     private_message_creator: Person;
     creator: Person;
     resolver?: Person;
-}
+};

package/dist/types/PrivateMessageResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PrivateMessageView } from "./PrivateMessageView";
-export interface PrivateMessageResponse {
+/**
+ * A single private message response.
+ */
+export type PrivateMessageResponse = {
     private_message_view: PrivateMessageView;
-}
+};

package/dist/types/PrivateMessageView.d.ts

@@ -1,7 +1,10 @@
 import type { Person } from "./Person";
 import type { PrivateMessage } from "./PrivateMessage";
-export interface PrivateMessageView {
+/**
+ * A private message view.
+ */
+export type PrivateMessageView = {
     private_message: PrivateMessage;
     creator: Person;
     recipient: Person;
-}
+};

package/dist/types/PrivateMessagesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PrivateMessageView } from "./PrivateMessageView";
-export interface PrivateMessagesResponse {
+/**
+ * The private messages response.
+ */
+export type PrivateMessagesResponse = {
     private_messages: Array<PrivateMessageView>;
-}
+};

package/dist/types/PublicOAuthProvider.d.ts

@@ -0,0 +1,2 @@
+import type { OAuthProvider } from "./OAuthProvider";
+export type PublicOAuthProvider = OAuthProvider;

package/dist/types/PublicOAuthProvider.js

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

package/dist/types/PurgeComment.d.ts

@@ -1,5 +1,8 @@
 import type { CommentId } from "./CommentId";
-export interface PurgeComment {
+/**
+ * Purges a comment from the database. This will delete all content attached to that comment.
+ */
+export type PurgeComment = {
     comment_id: CommentId;
     reason?: string;
-}
+};

package/dist/types/PurgeCommunity.d.ts

@@ -1,5 +1,8 @@
 import type { CommunityId } from "./CommunityId";
-export interface PurgeCommunity {
+/**
+ * Purges a community from the database. This will delete all content attached to that community.
+ */
+export type PurgeCommunity = {
     community_id: CommunityId;
     reason?: string;
-}
+};

package/dist/types/PurgePerson.d.ts

@@ -1,5 +1,8 @@
 import type { PersonId } from "./PersonId";
-export interface PurgePerson {
+/**
+ * Purges a person from the database. This will delete all content attached to that person.
+ */
+export type PurgePerson = {
     person_id: PersonId;
     reason?: string;
-}
+};

package/dist/types/PurgePost.d.ts

@@ -1,5 +1,8 @@
 import type { PostId } from "./PostId";
-export interface PurgePost {
+/**
+ * Purges a post from the database. This will delete all content attached to that post.
+ */
+export type PurgePost = {
     post_id: PostId;
     reason?: string;
-}
+};

package/dist/types/ReadableFederationState.d.ts

@@ -1,10 +1,22 @@
 import type { ActivityId } from "./ActivityId";
 import type { InstanceId } from "./InstanceId";
-export interface ReadableFederationState {
+export type ReadableFederationState = {
+    /**
+     * timestamp of the next retry attempt (null if fail count is 0)
+     */
+    next_retry?: string;
     instance_id: InstanceId;
+    /**
+     * the last successfully sent activity id
+     */
     last_successful_id?: ActivityId;
     last_successful_published_time?: string;
+    /**
+     * how many failed attempts have been made to send the next activity
+     */
     fail_count: number;
+    /**
+     * timestamp of the last retry attempt (when the last failing activity was resent)
+     */
     last_retry?: string;
-    next_retry?: string;
-}
+};

package/dist/types/Register.d.ts

@@ -1,11 +1,30 @@
-export interface Register {
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Register / Sign up to lemmy.
+ */
+export type Register = {
     username: string;
-    password: string;
-    password_verify: string;
+    password: SensitiveString;
+    password_verify: SensitiveString;
     show_nsfw?: boolean;
-    email?: string;
+    /**
+     * email is mandatory if email verification is enabled on the server
+     */
+    email?: SensitiveString;
+    /**
+     * The UUID of the captcha item.
+     */
     captcha_uuid?: string;
+    /**
+     * Your captcha answer.
+     */
     captcha_answer?: string;
+    /**
+     * A form field to trick signup bots. Should be None.
+     */
     honeypot?: string;
+    /**
+     * An answer is mandatory if require application is enabled on the server
+     */
     answer?: string;
-}
+};

package/dist/types/Register.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/RegistrationApplication.d.ts

@@ -1,11 +1,14 @@
 import type { LocalUserId } from "./LocalUserId";
 import type { PersonId } from "./PersonId";
 import type { RegistrationApplicationId } from "./RegistrationApplicationId";
-export interface RegistrationApplication {
+/**
+ * A registration application.
+ */
+export type RegistrationApplication = {
     id: RegistrationApplicationId;
     local_user_id: LocalUserId;
     answer: string;
     admin_id?: PersonId;
     deny_reason?: string;
     published: string;
-}
+};

package/dist/types/RegistrationApplicationId.d.ts

@@ -1 +1,4 @@
+/**
+ * The registration application id.
+ */
 export type RegistrationApplicationId = number;

package/dist/types/RegistrationApplicationResponse.d.ts

@@ -1,4 +1,7 @@
 import type { RegistrationApplicationView } from "./RegistrationApplicationView";
-export interface RegistrationApplicationResponse {
+/**
+ * The response of an action done to a registration application.
+ */
+export type RegistrationApplicationResponse = {
     registration_application: RegistrationApplicationView;
-}
+};

package/dist/types/RegistrationApplicationView.d.ts

@@ -1,9 +1,12 @@
 import type { LocalUser } from "./LocalUser";
 import type { Person } from "./Person";
 import type { RegistrationApplication } from "./RegistrationApplication";
-export interface RegistrationApplicationView {
+/**
+ * A registration application view.
+ */
+export type RegistrationApplicationView = {
     registration_application: RegistrationApplication;
     creator_local_user: LocalUser;
     creator: Person;
     admin?: Person;
-}
+};

package/dist/types/RegistrationMode.d.ts

@@ -1 +1,4 @@
+/**
+ * The registration mode for your site. Determines what happens after a user signs up.
+ */
 export type RegistrationMode = "Closed" | "RequireApplication" | "Open";

package/dist/types/RemoveComment.d.ts

@@ -1,6 +1,9 @@
 import type { CommentId } from "./CommentId";
-export interface RemoveComment {
+/**
+ * Remove a comment (only doable by mods).
+ */
+export type RemoveComment = {
     comment_id: CommentId;
     removed: boolean;
     reason?: string;
-}
+};

package/dist/types/RemoveCommunity.d.ts

@@ -1,6 +1,9 @@
 import type { CommunityId } from "./CommunityId";
-export interface RemoveCommunity {
+/**
+ * Remove a community (only doable by moderators).
+ */
+export type RemoveCommunity = {
     community_id: CommunityId;
     removed: boolean;
     reason?: string;
-}
+};

package/dist/types/RemovePost.d.ts

@@ -1,6 +1,9 @@
 import type { PostId } from "./PostId";
-export interface RemovePost {
+/**
+ * Remove a post (only doable by mods).
+ */
+export type RemovePost = {
     post_id: PostId;
     removed: boolean;
     reason?: string;
-}
+};

package/dist/types/ResolveCommentReport.d.ts

@@ -1,5 +1,8 @@
 import type { CommentReportId } from "./CommentReportId";
-export interface ResolveCommentReport {
+/**
+ * Resolve a comment report (only doable by mods).
+ */
+export type ResolveCommentReport = {
     report_id: CommentReportId;
     resolved: boolean;
-}
+};

package/dist/types/ResolveObject.d.ts

@@ -1,3 +1,9 @@
-export interface ResolveObject {
+/**
+ * Does an apub fetch for an object.
+ */
+export type ResolveObject = {
+    /**
+     * Can be the full url, or a shortened version like: !fediverse@lemmy.ml
+     */
     q: string;
-}
+};

package/dist/types/ResolveObjectResponse.d.ts

@@ -2,9 +2,12 @@ import type { CommentView } from "./CommentView";
 import type { CommunityView } from "./CommunityView";
 import type { PersonView } from "./PersonView";
 import type { PostView } from "./PostView";
-export interface ResolveObjectResponse {
+/**
+ * The response of an apub object fetch.
+ */
+export type ResolveObjectResponse = {
     comment?: CommentView;
     post?: PostView;
     community?: CommunityView;
     person?: PersonView;
-}
+};

package/dist/types/ResolvePostReport.d.ts

@@ -1,5 +1,8 @@
 import type { PostReportId } from "./PostReportId";
-export interface ResolvePostReport {
+/**
+ * Resolve a post report (mods only).
+ */
+export type ResolvePostReport = {
     report_id: PostReportId;
     resolved: boolean;
-}
+};

package/dist/types/ResolvePrivateMessageReport.d.ts

@@ -1,5 +1,8 @@
 import type { PrivateMessageReportId } from "./PrivateMessageReportId";
-export interface ResolvePrivateMessageReport {
+/**
+ * Resolve a private message report.
+ */
+export type ResolvePrivateMessageReport = {
     report_id: PrivateMessageReportId;
     resolved: boolean;
-}
+};

package/dist/types/SaveComment.d.ts

@@ -1,5 +1,8 @@
 import type { CommentId } from "./CommentId";
-export interface SaveComment {
+/**
+ * Save / bookmark a comment.
+ */
+export type SaveComment = {
     comment_id: CommentId;
     save: boolean;
-}
+};

package/dist/types/SavePost.d.ts

@@ -1,5 +1,8 @@
 import type { PostId } from "./PostId";
-export interface SavePost {
+/**
+ * Save / bookmark a post.
+ */
+export type SavePost = {
     post_id: PostId;
     save: boolean;
-}
+};

package/dist/types/SaveUserSettings.d.ts

@@ -1,35 +1,119 @@
+import type { CommentSortType } from "./CommentSortType";
 import type { LanguageId } from "./LanguageId";
 import type { ListingType } from "./ListingType";
 import type { PostListingMode } from "./PostListingMode";
-import type { SortType } from "./SortType";
-export interface SaveUserSettings {
+import type { PostSortType } from "./PostSortType";
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Saves settings for your user.
+ */
+export type SaveUserSettings = {
+    /**
+     * Show nsfw posts.
+     */
     show_nsfw?: boolean;
+    /**
+     * Blur nsfw posts.
+     */
     blur_nsfw?: boolean;
-    auto_expand?: boolean;
+    /**
+     * Your user's theme.
+     */
     theme?: string;
-    default_sort_type?: SortType;
+    /**
+     * The default post listing type, usually "local"
+     */
     default_listing_type?: ListingType;
+    /**
+     * A post-view mode that changes how multiple post listings look.
+     */
+    post_listing_mode?: PostListingMode;
+    /**
+     * The default post sort, usually "active"
+     */
+    default_post_sort_type?: PostSortType;
+    /**
+     * The default comment sort, usually "hot"
+     */
+    default_comment_sort_type?: CommentSortType;
+    /**
+     * The language of the lemmy interface
+     */
     interface_language?: string;
+    /**
+     * A URL for your avatar.
+     */
     avatar?: string;
+    /**
+     * A URL for your banner.
+     */
     banner?: string;
+    /**
+     * Your display name, which can contain strange characters, and does not need to be unique.
+     */
     display_name?: string;
-    email?: string;
+    /**
+     * Your email.
+     */
+    email?: SensitiveString;
+    /**
+     * Your bio / info, in markdown.
+     */
     bio?: string;
+    /**
+     * Your matrix user id. Ex: @my_user:matrix.org
+     */
     matrix_user_id?: string;
+    /**
+     * Whether to show or hide avatars.
+     */
     show_avatars?: boolean;
+    /**
+     * Sends notifications to your email.
+     */
     send_notifications_to_email?: boolean;
+    /**
+     * Whether this account is a bot account. Users can hide these accounts easily if they wish.
+     */
     bot_account?: boolean;
+    /**
+     * Whether to show bot accounts.
+     */
     show_bot_accounts?: boolean;
+    /**
+     * Whether to show read posts.
+     */
     show_read_posts?: boolean;
+    /**
+     * A list of languages you are able to see discussion in.
+     */
     discussion_languages?: Array<LanguageId>;
+    /**
+     * Open links in a new tab
+     */
     open_links_in_new_tab?: boolean;
+    /**
+     * Enable infinite scroll
+     */
     infinite_scroll_enabled?: boolean;
-    post_listing_mode?: PostListingMode;
+    /**
+     * Whether to allow keyboard navigation (for browsing and interacting with posts and comments).
+     */
     enable_keyboard_navigation?: boolean;
+    /**
+     * Whether user avatars or 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;
+    /**
+     * Some vote display mode settings
+     */
     show_scores?: boolean;
     show_upvotes?: boolean;
     show_downvotes?: boolean;
     show_upvote_percentage?: boolean;
-}
+};

package/dist/types/Search.d.ts

@@ -1,16 +1,24 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { PersonId } from "./PersonId";
+import type { PostSortType } from "./PostSortType";
 import type { SearchType } from "./SearchType";
-import type { SortType } from "./SortType";
-export interface Search {
+/**
+ * Searches the site, given a query string, and some optional filters.
+ */
+export type Search = {
     q: string;
     community_id?: CommunityId;
     community_name?: string;
     creator_id?: PersonId;
     type_?: SearchType;
-    sort?: SortType;
+    sort?: PostSortType;
     listing_type?: ListingType;
     page?: number;
     limit?: number;
-}
+    title_only?: boolean;
+    post_url_only?: boolean;
+    saved_only?: boolean;
+    liked_only?: boolean;
+    disliked_only?: boolean;
+};