lemmy-js-client 0.20.0-alpha.7 → 0.20.0-ap-id.1

package/dist/types/CommunityReport.d.ts

@@ -0,0 +1,22 @@
+import type { CommunityId } from "./CommunityId";
+import type { CommunityReportId } from "./CommunityReportId";
+import type { PersonId } from "./PersonId";
+/**
+ * A comment report.
+ */
+export type CommunityReport = {
+    id: CommunityReportId;
+    creator_id: PersonId;
+    community_id: CommunityId;
+    original_community_name: string;
+    original_community_title: string;
+    original_community_description?: string;
+    original_community_sidebar?: string;
+    original_community_icon?: string;
+    original_community_banner?: string;
+    reason: string;
+    resolved: boolean;
+    resolver_id?: PersonId;
+    published: string;
+    updated?: string;
+};

package/dist/types/CommunityReportId.d.ts

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

package/dist/types/CommunityReportId.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/CommunityReportView.d.ts

@@ -0,0 +1,16 @@
+import type { Community } from "./Community";
+import type { CommunityAggregates } from "./CommunityAggregates";
+import type { CommunityReport } from "./CommunityReport";
+import type { Person } from "./Person";
+import type { SubscribedType } from "./SubscribedType";
+/**
+ * A community report view.
+ */
+export type CommunityReportView = {
+    community_report: CommunityReport;
+    community: Community;
+    creator: Person;
+    counts: CommunityAggregates;
+    subscribed: SubscribedType;
+    resolver?: 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;
@@ -8,7 +11,8 @@ export interface CreateOAuthProvider {
     client_id: string;
     client_secret: string;
     scopes: string;
-    auto_verify_email: boolean;
-    account_linking_enabled: boolean;
-    enabled: boolean;
-}
+    auto_verify_email?: boolean;
+    account_linking_enabled?: boolean;
+    use_pkce?: boolean;
+    enabled?: boolean;
+};

package/dist/types/CreatePost.d.ts

@@ -1,13 +1,34 @@
 import type { CommunityId } from "./CommunityId";
 import type { LanguageId } from "./LanguageId";
-export interface CreatePost {
+import type { TagId } from "./TagId";
+/**
+ * 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;
-}
+    tags?: Array<TagId>;
+    /**
+     * 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,23 +1,26 @@
+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";
-import type { SortType } from "./SortType";
-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;
     application_question?: string;
     private_instance?: boolean;
     default_theme?: string;
     default_post_listing_type?: ListingType;
-    default_sort_type?: SortType;
+    default_post_listing_mode?: PostListingMode;
+    default_post_sort_type?: PostSortType;
+    default_comment_sort_type?: CommentSortType;
     legal_information?: string;
     application_email_admins?: boolean;
     hide_modlog_mod_names?: boolean;
@@ -37,14 +40,14 @@ export interface CreateSite {
     rate_limit_search?: number;
     rate_limit_search_per_second?: number;
     federation_enabled?: boolean;
-    federation_debug?: boolean;
     captcha_enabled?: boolean;
     captcha_difficulty?: string;
-    allowed_instances?: Array<string>;
-    blocked_instances?: Array<string>;
-    taglines?: Array<string>;
     registration_mode?: RegistrationMode;
     oauth_registration?: boolean;
     content_warning?: string;
-    default_post_listing_mode?: PostListingMode;
-}
+    post_upvotes?: FederationMode;
+    post_downvotes?: FederationMode;
+    comment_upvotes?: FederationMode;
+    comment_downvotes?: FederationMode;
+    disable_donation_dialog?: boolean;
+};

package/dist/types/CreateTagline.d.ts

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

package/dist/types/CreateTagline.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/CustomEmoji.d.ts

@@ -1,12 +1,14 @@
 import type { CustomEmojiId } from "./CustomEmojiId";
-import type { LocalSiteId } from "./LocalSiteId";
-export interface CustomEmoji {
+import type { DbUrl } from "./DbUrl";
+/**
+ * A custom emoji.
+ */
+export type CustomEmoji = {
     id: CustomEmojiId;
-    local_site_id: LocalSiteId;
     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/DeleteImageParams.d.ts

@@ -0,0 +1,3 @@
+export type DeleteImageParams = {
+    filename: string;
+};

package/dist/types/DeleteImageParams.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/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

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

package/dist/types/DistinguishComment.d.ts

@@ -1,5 +1,8 @@
 import type { CommentId } from "./CommentId";
-export interface DistinguishComment {
+/**
+ * Distinguish a comment (IE speak as moderator).
+ */
+export type DistinguishComment = {
     comment_id: CommentId;
     distinguished: boolean;
-}
+};

package/dist/types/EditComment.d.ts

@@ -1,7 +1,10 @@
 import type { CommentId } from "./CommentId";
 import type { LanguageId } from "./LanguageId";
-export interface EditComment {
+/**
+ * Edit a comment.
+ */
+export type EditComment = {
     comment_id: CommentId;
     content?: string;
     language_id?: LanguageId;
-}
+};

package/dist/types/EditCommunity.d.ts

@@ -1,14 +1,31 @@
 import type { CommunityId } from "./CommunityId";
 import type { CommunityVisibility } from "./CommunityVisibility";
 import type { LanguageId } from "./LanguageId";
-export interface EditCommunity {
+/**
+ * Edit a community.
+ */
+export type EditCommunity = {
     community_id: CommunityId;
+    /**
+     * A longer title.
+     */
     title?: string;
+    /**
+     * A sidebar for the community in markdown.
+     */
+    sidebar?: string;
+    /**
+     * A shorter, one line description of your community.
+     */
     description?: string;
-    icon?: string;
-    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/EditCustomEmoji.d.ts

@@ -1,8 +1,11 @@
 import type { CustomEmojiId } from "./CustomEmojiId";
-export interface EditCustomEmoji {
+/**
+ * Edit  a custom emoji.
+ */
+export type EditCustomEmoji = {
     id: CustomEmojiId;
     category: string;
     image_url: string;
     alt_text: string;
     keywords: Array<string>;
-}
+};