lemmy-js-client 0.20.0-alpha.16 → 0.20.0-alpha.18

package/dist/types/CommentReportView.d.ts

@@ -5,7 +5,10 @@ import type { Community } from "./Community";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
-export interface CommentReportView {
+/**
+ * A comment report view.
+ */
+export type CommentReportView = {
     comment_report: CommentReport;
     comment: Comment;
     post: Post;
@@ -21,4 +24,4 @@ export interface CommentReportView {
     saved: boolean;
     my_vote?: number;
     resolver?: Person;
-}
+};

package/dist/types/CommentResponse.d.ts

@@ -1,6 +1,9 @@
 import type { CommentView } from "./CommentView";
 import type { LocalUserId } from "./LocalUserId";
-export interface CommentResponse {
+/**
+ * A comment response.
+ */
+export type CommentResponse = {
     comment_view: CommentView;
     recipient_ids: Array<LocalUserId>;
-}
+};

package/dist/types/CommentSortType.d.ts

@@ -1 +1,4 @@
+/**
+ * The comment sort types. See here for descriptions: https://join-lemmy.org/docs/en/users/03-votes-and-ranking.html
+ */
 export type CommentSortType = "Hot" | "Top" | "New" | "Old" | "Controversial";

package/dist/types/CommentView.d.ts

@@ -4,7 +4,10 @@ import type { Community } from "./Community";
 import type { Person } from "./Person";
 import type { Post } from "./Post";
 import type { SubscribedType } from "./SubscribedType";
-export interface CommentView {
+/**
+ * A comment view.
+ */
+export type CommentView = {
     comment: Comment;
     creator: Person;
     post: Post;
@@ -18,4 +21,4 @@ export interface CommentView {
     saved: boolean;
     creator_blocked: boolean;
     my_vote?: number;
-}
+};

package/dist/types/Community.d.ts

@@ -1,22 +1,63 @@
 import type { CommunityId } from "./CommunityId";
 import type { CommunityVisibility } from "./CommunityVisibility";
+import type { DbUrl } from "./DbUrl";
 import type { InstanceId } from "./InstanceId";
-export interface Community {
+/**
+ * A community.
+ */
+export type Community = {
     id: CommunityId;
     name: string;
+    /**
+     * A longer title, that can contain other characters, and doesn't have to be unique.
+     */
     title: string;
-    description?: string;
+    /**
+     * A sidebar for the community in markdown.
+     */
+    sidebar?: string;
+    /**
+     * Whether the community is removed by a mod.
+     */
     removed: boolean;
     published: string;
     updated?: string;
+    /**
+     * Whether the community has been deleted by its creator.
+     */
     deleted: boolean;
+    /**
+     * Whether its an NSFW community.
+     */
     nsfw: boolean;
-    actor_id: string;
+    /**
+     * The federated actor_id.
+     */
+    actor_id: DbUrl;
+    /**
+     * Whether the community is local.
+     */
     local: boolean;
-    icon?: string;
-    banner?: string;
+    /**
+     * A URL for an icon.
+     */
+    icon?: DbUrl;
+    /**
+     * A URL for a banner.
+     */
+    banner?: DbUrl;
+    /**
+     * Whether the community is hidden.
+     */
     hidden: boolean;
+    /**
+     * Whether posting is restricted to mods only.
+     */
     posting_restricted_to_mods: boolean;
     instance_id: InstanceId;
     visibility: CommunityVisibility;
-}
+    /**
+     * A shorter, one-line description of the site.
+     */
+    description?: string;
+};

package/dist/types/CommunityAggregates.d.ts

@@ -1,13 +1,28 @@
 import type { CommunityId } from "./CommunityId";
-export interface CommunityAggregates {
+/**
+ * Aggregate data for a community.
+ */
+export type CommunityAggregates = {
     community_id: CommunityId;
     subscribers: number;
     posts: number;
     comments: number;
     published: string;
+    /**
+     * 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 year.
+     */
     users_active_half_year: number;
     subscribers_local: number;
-}
+};

package/dist/types/CommunityFollowerState.d.ts

@@ -0,0 +1 @@
+export type CommunityFollowerState = "Accepted" | "Pending" | "ApprovalRequired";

package/dist/types/CommunityFollowerState.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/CommunityFollowerView.d.ts

@@ -1,6 +1,9 @@
 import type { Community } from "./Community";
 import type { Person } from "./Person";
-export interface CommunityFollowerView {
+/**
+ * A community follower.
+ */
+export type CommunityFollowerView = {
     community: Community;
     follower: Person;
-}
+};

package/dist/types/CommunityId.d.ts

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

package/dist/types/CommunityModeratorView.d.ts

@@ -1,6 +1,9 @@
 import type { Community } from "./Community";
 import type { Person } from "./Person";
-export interface CommunityModeratorView {
+/**
+ * A community moderator.
+ */
+export type CommunityModeratorView = {
     community: Community;
     moderator: Person;
-}
+};

package/dist/types/CommunityResponse.d.ts

@@ -1,6 +1,9 @@
 import type { CommunityView } from "./CommunityView";
 import type { LanguageId } from "./LanguageId";
-export interface CommunityResponse {
+/**
+ * A simple community response.
+ */
+export type CommunityResponse = {
     community_view: CommunityView;
     discussion_languages: Array<LanguageId>;
-}
+};

package/dist/types/CommunitySortType.d.ts

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

package/dist/types/CommunitySortType.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/CommunityView.d.ts

@@ -1,10 +1,13 @@
 import type { Community } from "./Community";
 import type { CommunityAggregates } from "./CommunityAggregates";
 import type { SubscribedType } from "./SubscribedType";
-export interface CommunityView {
+/**
+ * A community view.
+ */
+export type CommunityView = {
     community: Community;
     subscribed: SubscribedType;
     blocked: boolean;
     counts: CommunityAggregates;
     banned_from_community: boolean;
-}
+};

package/dist/types/CommunityVisibility.d.ts

@@ -1 +1,4 @@
-export type CommunityVisibility = "Public" | "LocalOnly";
+/**
+ * Defines who can browse and interact with content in a community.
+ */
+export type CommunityVisibility = "Public" | "LocalOnly" | "Private";

package/dist/types/CreateComment.d.ts

@@ -1,9 +1,12 @@
 import type { CommentId } from "./CommentId";
 import type { LanguageId } from "./LanguageId";
 import type { PostId } from "./PostId";
-export interface CreateComment {
+/**
+ * Create a comment.
+ */
+export type CreateComment = {
     content: string;
     post_id: PostId;
     parent_id?: CommentId;
     language_id?: LanguageId;
-}
+};

package/dist/types/CreateCommentLike.d.ts

@@ -1,5 +1,11 @@
 import type { CommentId } from "./CommentId";
-export interface CreateCommentLike {
+/**
+ * Like a comment.
+ */
+export type CreateCommentLike = {
     comment_id: CommentId;
+    /**
+     * Must be -1, 0, or 1 .
+     */
     score: number;
-}
+};

package/dist/types/CreateCommentReport.d.ts

@@ -1,5 +1,8 @@
 import type { CommentId } from "./CommentId";
-export interface CreateCommentReport {
+/**
+ * Report a comment.
+ */
+export type CreateCommentReport = {
     comment_id: CommentId;
     reason: string;
-}
+};

package/dist/types/CreateCommunity.d.ts

@@ -1,13 +1,41 @@
 import type { CommunityVisibility } from "./CommunityVisibility";
 import type { LanguageId } from "./LanguageId";
-export interface CreateCommunity {
+/**
+ * Create a community.
+ */
+export type CreateCommunity = {
+    /**
+     * The unique name.
+     */
     name: string;
+    /**
+     * A longer title.
+     */
     title: string;
+    /**
+     * A sidebar for the community in markdown.
+     */
+    sidebar?: string;
+    /**
+     * A shorter, one line description of your community.
+     */
     description?: string;
+    /**
+     * An icon URL.
+     */
     icon?: string;
+    /**
+     * A banner URL.
+     */
     banner?: string;
+    /**
+     * Whether its an NSFW community.
+     */
     nsfw?: boolean;
+    /**
+     * Whether to restrict posting only to moderators.
+     */
     posting_restricted_to_mods?: boolean;
     discussion_languages?: Array<LanguageId>;
     visibility?: CommunityVisibility;
-}
+};

package/dist/types/CreateCustomEmoji.d.ts

@@ -1,7 +1,10 @@
-export interface CreateCustomEmoji {
+/**
+ * Create a custom emoji.
+ */
+export type CreateCustomEmoji = {
     category: string;
     shortcode: string;
     image_url: string;
     alt_text: string;
     keywords: Array<string>;
-}
+};

package/dist/types/CreateOAuthProvider.d.ts

@@ -1,4 +1,7 @@
-export interface CreateOAuthProvider {
+/**
+ * Create an external auth method.
+ */
+export type CreateOAuthProvider = {
     display_name: string;
     issuer: string;
     authorization_endpoint: string;
@@ -11,4 +14,4 @@ export interface CreateOAuthProvider {
     auto_verify_email?: boolean;
     account_linking_enabled?: boolean;
     enabled?: boolean;
-}
+};

package/dist/types/CreatePost.d.ts

@@ -1,14 +1,32 @@
 import type { CommunityId } from "./CommunityId";
 import type { LanguageId } from "./LanguageId";
-export interface CreatePost {
+/**
+ * Create a post.
+ */
+export type CreatePost = {
     name: string;
     community_id: CommunityId;
     url?: string;
+    /**
+     * An optional body for the post in markdown.
+     */
     body?: string;
+    /**
+     * An optional alt_text, usable for image posts.
+     */
     alt_text?: string;
+    /**
+     * A honeypot to catch bots. Should be None.
+     */
     honeypot?: string;
     nsfw?: boolean;
     language_id?: LanguageId;
+    /**
+     * Instead of fetching a thumbnail, use a custom one.
+     */
     custom_thumbnail?: string;
+    /**
+     * Time when this post should be scheduled. Null means publish immediately.
+     */
     scheduled_publish_time?: number;
-}
+};

package/dist/types/CreatePostLike.d.ts

@@ -1,5 +1,11 @@
 import type { PostId } from "./PostId";
-export interface CreatePostLike {
+/**
+ * Like a post.
+ */
+export type CreatePostLike = {
     post_id: PostId;
+    /**
+     * Score must be -1, 0, or 1.
+     */
     score: number;
-}
+};

package/dist/types/CreatePostReport.d.ts

@@ -1,5 +1,8 @@
 import type { PostId } from "./PostId";
-export interface CreatePostReport {
+/**
+ * Create a post report.
+ */
+export type CreatePostReport = {
     post_id: PostId;
     reason: string;
-}
+};

package/dist/types/CreatePrivateMessage.d.ts

@@ -1,5 +1,8 @@
 import type { PersonId } from "./PersonId";
-export interface CreatePrivateMessage {
+/**
+ * Create a private message.
+ */
+export type CreatePrivateMessage = {
     content: string;
     recipient_id: PersonId;
-}
+};

package/dist/types/CreatePrivateMessageReport.d.ts

@@ -1,5 +1,8 @@
 import type { PrivateMessageId } from "./PrivateMessageId";
-export interface CreatePrivateMessageReport {
+/**
+ * Create a report for a private message.
+ */
+export type CreatePrivateMessageReport = {
     private_message_id: PrivateMessageId;
     reason: string;
-}
+};

package/dist/types/CreateSite.d.ts

@@ -1,16 +1,19 @@
 import type { CommentSortType } from "./CommentSortType";
+import type { FederationMode } from "./FederationMode";
 import type { LanguageId } from "./LanguageId";
 import type { ListingType } from "./ListingType";
 import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { RegistrationMode } from "./RegistrationMode";
-export interface CreateSite {
+/**
+ * Creates a site. Should be done after first running lemmy.
+ */
+export type CreateSite = {
     name: string;
     sidebar?: string;
     description?: string;
     icon?: string;
     banner?: string;
-    enable_downvotes?: boolean;
     enable_nsfw?: boolean;
     community_creation_admin_only?: boolean;
     require_email_verification?: boolean;
@@ -48,4 +51,8 @@ export interface CreateSite {
     registration_mode?: RegistrationMode;
     oauth_registration?: boolean;
     content_warning?: string;
-}
+    post_upvotes?: FederationMode;
+    post_downvotes?: FederationMode;
+    comment_upvotes?: FederationMode;
+    comment_downvotes?: FederationMode;
+};

package/dist/types/CreateTagline.d.ts

@@ -1,3 +1,6 @@
-export interface CreateTagline {
+/**
+ * Create a tagline
+ */
+export type CreateTagline = {
     content: string;
-}
+};

package/dist/types/CustomEmoji.d.ts

@@ -1,10 +1,14 @@
 import type { CustomEmojiId } from "./CustomEmojiId";
-export interface CustomEmoji {
+import type { DbUrl } from "./DbUrl";
+/**
+ * A custom emoji.
+ */
+export type CustomEmoji = {
     id: CustomEmojiId;
     shortcode: string;
-    image_url: string;
+    image_url: DbUrl;
     alt_text: string;
     category: string;
     published: string;
     updated?: string;
-}
+};

package/dist/types/CustomEmojiId.d.ts

@@ -1 +1,4 @@
+/**
+ * The custom emoji id.
+ */
 export type CustomEmojiId = number;

package/dist/types/CustomEmojiKeyword.d.ts

@@ -1,5 +1,8 @@
 import type { CustomEmojiId } from "./CustomEmojiId";
-export interface CustomEmojiKeyword {
+/**
+ * A custom keyword for an emoji.
+ */
+export type CustomEmojiKeyword = {
     custom_emoji_id: CustomEmojiId;
     keyword: string;
-}
+};

package/dist/types/CustomEmojiResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CustomEmojiView } from "./CustomEmojiView";
-export interface CustomEmojiResponse {
+/**
+ * A response for a custom emoji.
+ */
+export type CustomEmojiResponse = {
     custom_emoji: CustomEmojiView;
-}
+};

package/dist/types/CustomEmojiView.d.ts

@@ -1,6 +1,9 @@
 import type { CustomEmoji } from "./CustomEmoji";
 import type { CustomEmojiKeyword } from "./CustomEmojiKeyword";
-export interface CustomEmojiView {
+/**
+ * A custom emoji view.
+ */
+export type CustomEmojiView = {
     custom_emoji: CustomEmoji;
     keywords: Array<CustomEmojiKeyword>;
-}
+};

package/dist/types/DbUrl.d.ts

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

package/dist/types/DbUrl.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/DeleteAccount.d.ts

@@ -1,4 +1,8 @@
-export interface DeleteAccount {
-    password: string;
+import type { SensitiveString } from "./SensitiveString";
+/**
+ * Delete your account.
+ */
+export type DeleteAccount = {
+    password: SensitiveString;
     delete_content: boolean;
-}
+};

package/dist/types/DeleteAccount.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/DeleteComment.d.ts

@@ -1,5 +1,8 @@
 import type { CommentId } from "./CommentId";
-export interface DeleteComment {
+/**
+ * Delete your own comment.
+ */
+export type DeleteComment = {
     comment_id: CommentId;
     deleted: boolean;
-}
+};

package/dist/types/DeleteCommunity.d.ts

@@ -1,5 +1,8 @@
 import type { CommunityId } from "./CommunityId";
-export interface DeleteCommunity {
+/**
+ * Delete your own community.
+ */
+export type DeleteCommunity = {
     community_id: CommunityId;
     deleted: boolean;
-}
+};

package/dist/types/DeleteCustomEmoji.d.ts

@@ -1,4 +1,7 @@
 import type { CustomEmojiId } from "./CustomEmojiId";
-export interface DeleteCustomEmoji {
+/**
+ * Delete a custom emoji.
+ */
+export type DeleteCustomEmoji = {
     id: CustomEmojiId;
-}
+};

package/dist/types/DeleteOAuthProvider.d.ts

@@ -1,4 +1,7 @@
 import type { OAuthProviderId } from "./OAuthProviderId";
-export interface DeleteOAuthProvider {
+/**
+ * Delete an external auth method.
+ */
+export type DeleteOAuthProvider = {
     id: OAuthProviderId;
-}
+};

package/dist/types/DeletePost.d.ts

@@ -1,5 +1,8 @@
 import type { PostId } from "./PostId";
-export interface DeletePost {
+/**
+ * Delete a post.
+ */
+export type DeletePost = {
     post_id: PostId;
     deleted: boolean;
-}
+};

package/dist/types/DeletePrivateMessage.d.ts

@@ -1,5 +1,8 @@
 import type { PrivateMessageId } from "./PrivateMessageId";
-export interface DeletePrivateMessage {
+/**
+ * Delete a private message.
+ */
+export type DeletePrivateMessage = {
     private_message_id: PrivateMessageId;
     deleted: boolean;
-}
+};

package/dist/types/DeleteTagline.d.ts

@@ -1,4 +1,7 @@
 import type { TaglineId } from "./TaglineId";
-export interface DeleteTagline {
+/**
+ * Delete a tagline
+ */
+export type DeleteTagline = {
     id: TaglineId;
-}
+};