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

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/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/ReportCombined.d.ts

@@ -0,0 +1,14 @@
+import type { CommentReportId } from "./CommentReportId";
+import type { PostReportId } from "./PostReportId";
+import type { PrivateMessageReportId } from "./PrivateMessageReportId";
+import type { ReportCombinedId } from "./ReportCombinedId";
+/**
+ * A combined reports table.
+ */
+export type ReportCombined = {
+    id: ReportCombinedId;
+    published: string;
+    post_report_id?: PostReportId;
+    comment_report_id?: CommentReportId;
+    private_message_report_id?: PrivateMessageReportId;
+};

package/dist/types/ReportCombined.js

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

package/dist/types/ReportCombinedId.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The report combined id
+ */
+export type ReportCombinedId = number;

package/dist/types/ReportCombinedId.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/ReportCombinedPaginationCursor.d.ts

@@ -0,0 +1,4 @@
+/**
+ * like PaginationCursor but for the report_combined table
+ */
+export type ReportCombinedPaginationCursor = string;

package/dist/types/ReportCombinedPaginationCursor.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/ReportCombinedView.d.ts

@@ -0,0 +1,10 @@
+import type { CommentReportView } from "./CommentReportView";
+import type { PostReportView } from "./PostReportView";
+import type { PrivateMessageReportView } from "./PrivateMessageReportView";
+export type ReportCombinedView = {
+    Post: PostReportView;
+} | {
+    Comment: CommentReportView;
+} | {
+    PrivateMessage: PrivateMessageReportView;
+};

package/dist/types/ReportCombinedView.js

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

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

@@ -3,34 +3,125 @@ import type { LanguageId } from "./LanguageId";
 import type { ListingType } from "./ListingType";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
-export interface SaveUserSettings {
+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;
+    /**
+     * Your user's theme.
+     */
     theme?: string;
+    /**
+     * 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;
+    /**
+     * 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 a user can send / receive private messages
+     */
+    enable_private_messages?: 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;
-}
+    /**
+     * Whether to automatically mark fetched posts as read.
+     */
+    auto_mark_fetched_posts_as_read?: boolean;
+};

package/dist/types/Search.d.ts

@@ -3,7 +3,10 @@ import type { ListingType } from "./ListingType";
 import type { PersonId } from "./PersonId";
 import type { PostSortType } from "./PostSortType";
 import type { SearchType } from "./SearchType";
-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;
@@ -18,4 +21,4 @@ export interface Search {
     saved_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
-}
+};

package/dist/types/SearchResponse.d.ts

@@ -3,10 +3,13 @@ import type { CommunityView } from "./CommunityView";
 import type { PersonView } from "./PersonView";
 import type { PostView } from "./PostView";
 import type { SearchType } from "./SearchType";
-export interface SearchResponse {
+/**
+ * The search response, containing lists of the return type possibilities
+ */
+export type SearchResponse = {
     type_: SearchType;
     comments: Array<CommentView>;
     posts: Array<PostView>;
     communities: Array<CommunityView>;
     users: Array<PersonView>;
-}
+};

package/dist/types/SearchType.d.ts

@@ -1 +1,4 @@
+/**
+ * The type of content returned from a search.
+ */
 export type SearchType = "All" | "Comments" | "Posts" | "Communities" | "Users";

package/dist/types/SensitiveString.d.ts

@@ -0,0 +1 @@
+export type SensitiveString = string;

package/dist/types/SensitiveString.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/Site.d.ts

@@ -1,18 +1,47 @@
+import type { DbUrl } from "./DbUrl";
 import type { InstanceId } from "./InstanceId";
 import type { SiteId } from "./SiteId";
-export interface Site {
+/**
+ * The site.
+ */
+export type Site = {
     id: SiteId;
     name: string;
+    /**
+     * A sidebar for the site in markdown.
+     */
     sidebar?: string;
     published: string;
     updated?: string;
-    icon?: string;
-    banner?: string;
+    /**
+     * An icon URL.
+     */
+    icon?: DbUrl;
+    /**
+     * A banner url.
+     */
+    banner?: DbUrl;
+    /**
+     * A shorter, one-line description of the site.
+     */
     description?: string;
-    actor_id: string;
+    /**
+     * The federated actor_id.
+     */
+    actor_id: DbUrl;
+    /**
+     * The time the site was last refreshed.
+     */
     last_refreshed_at: string;
-    inbox_url: string;
+    /**
+     * The site inbox
+     */
+    inbox_url: DbUrl;
     public_key: string;
     instance_id: InstanceId;
+    /**
+     * If present, nsfw content is visible by default. Should be displayed by frontends/clients
+     * when the site is first opened by a user.
+     */
     content_warning?: string;
-}
+};

package/dist/types/SiteAggregates.d.ts

@@ -1,12 +1,27 @@
 import type { SiteId } from "./SiteId";
-export interface SiteAggregates {
+/**
+ * Aggregate data for a site.
+ */
+export type SiteAggregates = {
     site_id: SiteId;
     users: number;
     posts: number;
     comments: number;
     communities: number;
+    /**
+     * The number of users with any activity in the last day.
+     */
     users_active_day: number;
+    /**
+     * The number of users with any activity in the last week.
+     */
     users_active_week: number;
+    /**
+     * The number of users with any activity in the last month.
+     */
     users_active_month: number;
+    /**
+     * The number of users with any activity in the last half year.
+     */
     users_active_half_year: number;
-}
+};

package/dist/types/SiteId.d.ts

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