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

package/dist/types/PersonMentionView.d.ts

@@ -5,7 +5,10 @@ import type { Person } from "./Person";
 import type { PersonMention } from "./PersonMention";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
-export interface PersonMentionView {
+/**
+ * A person mention view.
+ */
+export type PersonMentionView = {
     person_mention: PersonMention;
     comment: Comment;
     creator: Person;
@@ -21,4 +24,4 @@ export interface PersonMentionView {
     saved: boolean;
     creator_blocked: boolean;
     my_vote?: number;
-}
+};

package/dist/types/PersonView.d.ts

@@ -1,7 +1,10 @@
 import type { Person } from "./Person";
 import type { PersonAggregates } from "./PersonAggregates";
-export interface PersonView {
+/**
+ * A person view.
+ */
+export type PersonView = {
     person: Person;
     counts: PersonAggregates;
     is_admin: boolean;
-}
+};

package/dist/types/Post.d.ts

@@ -1,30 +1,82 @@
 import type { CommunityId } from "./CommunityId";
+import type { DbUrl } from "./DbUrl";
 import type { LanguageId } from "./LanguageId";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface Post {
+/**
+ * A post.
+ */
+export type Post = {
     id: PostId;
     name: string;
-    url?: string;
+    /**
+     * An optional link / url for the post.
+     */
+    url?: DbUrl;
+    /**
+     * An optional post body, in markdown.
+     */
     body?: string;
     creator_id: PersonId;
     community_id: CommunityId;
+    /**
+     * Whether the post is removed.
+     */
     removed: boolean;
+    /**
+     * Whether the post is locked.
+     */
     locked: boolean;
     published: string;
     updated?: string;
+    /**
+     * Whether the post is deleted.
+     */
     deleted: boolean;
+    /**
+     * Whether the post is NSFW.
+     */
     nsfw: boolean;
+    /**
+     * A title for the link.
+     */
     embed_title?: string;
+    /**
+     * A description for the link.
+     */
     embed_description?: string;
-    thumbnail_url?: string;
-    ap_id: string;
+    /**
+     * A thumbnail picture url.
+     */
+    thumbnail_url?: DbUrl;
+    /**
+     * The federated activity id / ap_id.
+     */
+    ap_id: DbUrl;
+    /**
+     * Whether the post is local.
+     */
     local: boolean;
-    embed_video_url?: string;
+    /**
+     * A video url for the link.
+     */
+    embed_video_url?: DbUrl;
     language_id: LanguageId;
+    /**
+     * Whether the post is featured to its community.
+     */
     featured_community: boolean;
+    /**
+     * Whether the post is featured to its site.
+     */
     featured_local: boolean;
     url_content_type?: string;
+    /**
+     * An optional alt_text, usable for image posts.
+     */
     alt_text?: string;
+    /**
+     * Time at which the post will be published. None means publish immediately.
+     */
     scheduled_publish_time?: string;
-}
+};

package/dist/types/PostAggregates.d.ts

@@ -1,10 +1,18 @@
 import type { PostId } from "./PostId";
-export interface PostAggregates {
+/**
+ * Aggregate data for a post.
+ */
+export type PostAggregates = {
     post_id: PostId;
     comments: number;
     score: number;
     upvotes: number;
     downvotes: number;
     published: string;
+    /**
+     * The time of the newest comment in the post.
+     */
     newest_comment_time: string;
-}
+    report_count: number;
+    unresolved_report_count: number;
+};

package/dist/types/PostFeatureType.d.ts

@@ -1 +1,4 @@
+/**
+ * The feature type for a post.
+ */
 export type PostFeatureType = "Local" | "Community";

package/dist/types/PostId.d.ts

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

package/dist/types/PostListingMode.d.ts

@@ -1 +1,4 @@
+/**
+ * A post-view mode that changes how multiple post listings look.
+ */
 export type PostListingMode = "List" | "Card" | "SmallCard";

package/dist/types/PostReport.d.ts

@@ -1,16 +1,29 @@
+import type { DbUrl } from "./DbUrl";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
 import type { PostReportId } from "./PostReportId";
-export interface PostReport {
+/**
+ * A post report.
+ */
+export type PostReport = {
     id: PostReportId;
     creator_id: PersonId;
     post_id: PostId;
+    /**
+     * The original post title.
+     */
     original_post_name: string;
-    original_post_url?: string;
+    /**
+     * The original post url.
+     */
+    original_post_url?: DbUrl;
+    /**
+     * The original post body.
+     */
     original_post_body?: string;
     reason: string;
     resolved: boolean;
     resolver_id?: PersonId;
     published: string;
     updated?: string;
-}
+};

package/dist/types/PostReportId.d.ts

@@ -1 +1,4 @@
+/**
+ * The post report id.
+ */
 export type PostReportId = number;

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

@@ -1 +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/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/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 });