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

package/dist/types/LemmyErrorType.d.ts

@@ -1,3 +1,4 @@
+import type { FederationError } from "./FederationError";
 export type LemmyErrorType = {
     error: "report_reason_required";
 } | {
@@ -24,18 +25,12 @@ export type LemmyErrorType = {
     error: "couldnt_update_private_message";
 } | {
     error: "cannot_leave_admin";
-} | {
-    error: "no_lines_in_html";
-} | {
-    error: "site_metadata_page_is_not_doctype_html";
 } | {
     error: "pictrs_response_error";
     message: string;
 } | {
     error: "pictrs_purge_response_error";
     message: string;
-} | {
-    error: "pictrs_caching_disabled";
 } | {
     error: "image_url_missing_path_segments";
 } | {
@@ -48,10 +43,6 @@ export type LemmyErrorType = {
     error: "not_an_image_type";
 } | {
     error: "not_a_mod_or_admin";
-} | {
-    error: "no_admins";
-} | {
-    error: "not_top_admin";
 } | {
     error: "not_top_mod";
 } | {
@@ -64,16 +55,12 @@ export type LemmyErrorType = {
     error: "site_ban";
 } | {
     error: "deleted";
-} | {
-    error: "banned_from_community";
 } | {
     error: "person_is_blocked";
 } | {
     error: "community_is_blocked";
 } | {
     error: "instance_is_blocked";
-} | {
-    error: "vote_not_allowed";
 } | {
     error: "instance_is_private";
 } | {
@@ -100,8 +87,6 @@ export type LemmyErrorType = {
     error: "community_already_exists";
 } | {
     error: "language_not_allowed";
-} | {
-    error: "only_mods_can_post_in_community";
 } | {
     error: "couldnt_update_post";
 } | {
@@ -124,43 +109,14 @@ export type LemmyErrorType = {
     error: "email_already_exists";
 } | {
     error: "username_already_exists";
-} | {
-    error: "federation_forbidden_by_strict_allow_list";
 } | {
     error: "person_is_banned_from_community";
-} | {
-    error: "object_is_not_public";
-} | {
-    error: "object_is_not_private";
-} | {
-    error: "invalid_community";
-} | {
-    error: "cannot_create_post_or_comment_in_deleted_or_removed_community";
-} | {
-    error: "cannot_receive_page";
-} | {
-    error: "new_post_cannot_be_locked";
-} | {
-    error: "only_local_admin_can_remove_community";
-} | {
-    error: "only_local_admin_can_restore_community";
 } | {
     error: "no_id_given";
 } | {
     error: "incorrect_login";
-} | {
-    error: "invalid_query";
 } | {
     error: "object_not_local";
-} | {
-    error: "post_is_locked";
-} | {
-    error: "person_is_banned_from_site";
-    message: string;
-} | {
-    error: "invalid_vote_value";
-} | {
-    error: "page_does_not_specify_creator";
 } | {
     error: "no_email_setup";
 } | {
@@ -168,11 +124,14 @@ export type LemmyErrorType = {
 } | {
     error: "email_smtp_server_needs_a_port";
 } | {
-    error: "missing_an_email";
+    error: "invalid_email_address";
+    message: string;
 } | {
     error: "rate_limit_error";
 } | {
     error: "invalid_name";
+} | {
+    error: "invalid_code_verifier";
 } | {
     error: "invalid_display_name";
 } | {
@@ -233,8 +192,6 @@ export type LemmyErrorType = {
     error: "couldnt_update_replies";
 } | {
     error: "couldnt_update_person_mentions";
-} | {
-    error: "post_title_too_long";
 } | {
     error: "couldnt_create_post";
 } | {
@@ -263,17 +220,9 @@ export type LemmyErrorType = {
     error: "slurs";
 } | {
     error: "registration_denied";
-    message: string | null;
-} | {
-    error: "federation_disabled";
-} | {
-    error: "domain_blocked";
-    message: string;
-} | {
-    error: "domain_not_in_allow_list";
-    message: string;
-} | {
-    error: "federation_disabled_by_strict_allow_list";
+    message: {
+        reason?: string;
+    };
 } | {
     error: "site_name_required";
 } | {
@@ -286,6 +235,8 @@ export type LemmyErrorType = {
     error: "captcha_incorrect";
 } | {
     error: "couldnt_create_audio_captcha";
+} | {
+    error: "couldnt_create_image_captcha";
 } | {
     error: "invalid_url_scheme";
 } | {
@@ -296,8 +247,6 @@ export type LemmyErrorType = {
     error: "instance_block_already_exists";
 } | {
     error: "too_many_items";
-} | {
-    error: "community_has_no_followers";
 } | {
     error: "ban_expiration_in_past";
 } | {
@@ -307,9 +256,10 @@ export type LemmyErrorType = {
 } | {
     error: "cant_block_local_instance";
 } | {
-    error: "url_without_domain";
+    error: "unknown";
+    message: string;
 } | {
-    error: "inbox_timeout";
+    error: "url_length_overflow";
 } | {
     error: "oauth_authorization_invalid";
 } | {
@@ -319,16 +269,18 @@ export type LemmyErrorType = {
 } | {
     error: "couldnt_delete_oauth_provider";
 } | {
-    error: "unknown";
-    message: string;
-} | {
-    error: "cant_delete_site";
+    error: "not_found";
 } | {
-    error: "url_length_overflow";
+    error: "community_has_no_followers";
 } | {
     error: "post_schedule_time_must_be_in_future";
 } | {
     error: "too_many_scheduled_posts";
 } | {
-    error: "not_found";
+    error: "cannot_combine_federation_blocklist_and_allowlist";
+} | {
+    error: "federation_error";
+    message: {
+        error?: FederationError;
+    };
 };

package/dist/types/LemmyErrorType.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/LinkMetadata.d.ts

@@ -1,7 +1,11 @@
-export interface LinkMetadata {
+import type { DbUrl } from "./DbUrl";
+/**
+ * Site metadata, from its opengraph tags.
+ */
+export type LinkMetadata = {
+    content_type?: string;
     title?: string;
     description?: string;
-    image?: string;
-    embed_video_url?: string;
-    content_type?: string;
-}
+    image?: DbUrl;
+    embed_video_url?: DbUrl;
+};

package/dist/types/LinkMetadata.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/ListCommentLikes.d.ts

@@ -1,6 +1,9 @@
 import type { CommentId } from "./CommentId";
-export interface ListCommentLikes {
+/**
+ * List comment likes. Admins-only.
+ */
+export type ListCommentLikes = {
     comment_id: CommentId;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListCommentLikesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { VoteView } from "./VoteView";
-export interface ListCommentLikesResponse {
+/**
+ * The comment likes response
+ */
+export type ListCommentLikesResponse = {
     comment_likes: Array<VoteView>;
-}
+};

package/dist/types/ListCommunities.d.ts

@@ -1,9 +1,12 @@
+import type { CommunitySortType } from "./CommunitySortType";
 import type { ListingType } from "./ListingType";
-import type { PostSortType } from "./PostSortType";
-export interface ListCommunities {
+/**
+ * Fetches a list of communities.
+ */
+export type ListCommunities = {
     type_?: ListingType;
-    sort?: PostSortType;
+    sort?: CommunitySortType;
     show_nsfw?: boolean;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListCommunitiesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommunityView } from "./CommunityView";
-export interface ListCommunitiesResponse {
+/**
+ * The response for listing communities.
+ */
+export type ListCommunitiesResponse = {
     communities: Array<CommunityView>;
-}
+};

package/dist/types/ListCommunityPendingFollows.d.ts

@@ -1,6 +1,9 @@
-export interface ListCommunityPendingFollows {
-    pending_only: boolean | null;
-    all_communities: boolean | null;
-    page: number | null;
-    limit: number | null;
-}
+export type ListCommunityPendingFollows = {
+    /**
+     * Only shows the unapproved applications
+     */
+    pending_only?: boolean;
+    all_communities?: boolean;
+    page?: number;
+    limit?: number;
+};

package/dist/types/ListCommunityPendingFollowsResponse.d.ts

@@ -1,4 +1,4 @@
 import type { PendingFollow } from "./PendingFollow";
-export interface ListCommunityPendingFollowsResponse {
+export type ListCommunityPendingFollowsResponse = {
     items: Array<PendingFollow>;
-}
+};

package/dist/types/ListCustomEmojis.d.ts

@@ -1,6 +1,9 @@
-export interface ListCustomEmojis {
+/**
+ * Fetches a list of custom emojis.
+ */
+export type ListCustomEmojis = {
     page?: number;
     limit?: number;
     category?: string;
     ignore_page_limits?: boolean;
-}
+};

package/dist/types/ListCustomEmojisResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CustomEmojiView } from "./CustomEmojiView";
-export interface ListCustomEmojisResponse {
+/**
+ * A response for custom emojis.
+ */
+export type ListCustomEmojisResponse = {
     custom_emojis: Array<CustomEmojiView>;
-}
+};

package/dist/types/ListLoginsResponse.d.ts

@@ -1,4 +1,4 @@
 import type { LoginToken } from "./LoginToken";
-export interface ListLoginsResponse {
+export type ListLoginsResponse = {
     logins: Array<LoginToken>;
-}
+};

package/dist/types/ListMedia.d.ts

@@ -1,4 +1,7 @@
-export interface ListMedia {
+/**
+ * Get your user's image / media uploads.
+ */
+export type ListMedia = {
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListMediaResponse.d.ts

@@ -1,4 +1,4 @@
 import type { LocalImageView } from "./LocalImageView";
-export interface ListMediaResponse {
+export type ListMediaResponse = {
     images: Array<LocalImageView>;
-}
+};

package/dist/types/ListPostLikes.d.ts

@@ -1,6 +1,9 @@
 import type { PostId } from "./PostId";
-export interface ListPostLikes {
+/**
+ * List post likes. Admins-only.
+ */
+export type ListPostLikes = {
     post_id: PostId;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListPostLikesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { VoteView } from "./VoteView";
-export interface ListPostLikesResponse {
+/**
+ * The post likes response
+ */
+export type ListPostLikesResponse = {
     post_likes: Array<VoteView>;
-}
+};

package/dist/types/ListRegistrationApplications.d.ts

@@ -1,5 +1,11 @@
-export interface ListRegistrationApplications {
+/**
+ * Fetches a list of registration applications.
+ */
+export type ListRegistrationApplications = {
+    /**
+     * Only shows the unread applications (IE those without an admin actor)
+     */
     unread_only?: boolean;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListRegistrationApplicationsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { RegistrationApplicationView } from "./RegistrationApplicationView";
-export interface ListRegistrationApplicationsResponse {
+/**
+ * The list of registration applications.
+ */
+export type ListRegistrationApplicationsResponse = {
     registration_applications: Array<RegistrationApplicationView>;
-}
+};

package/dist/types/ListReports.d.ts

@@ -0,0 +1,17 @@
+import type { CommunityId } from "./CommunityId";
+import type { ReportCombinedPaginationCursor } from "./ReportCombinedPaginationCursor";
+/**
+ * List reports.
+ */
+export type ListReports = {
+    /**
+     * Only shows the unresolved reports
+     */
+    unresolved_only?: boolean;
+    /**
+     * if no community is given, it returns reports for all communities moderated by the auth user
+     */
+    community_id?: CommunityId;
+    page_cursor?: ReportCombinedPaginationCursor;
+    page_back?: boolean;
+};

package/dist/types/ListReportsResponse.d.ts

@@ -0,0 +1,7 @@
+import type { ReportCombinedView } from "./ReportCombinedView";
+/**
+ * The post reports response.
+ */
+export type ListReportsResponse = {
+    reports: Array<ReportCombinedView>;
+};

package/dist/types/ListReportsResponse.js

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

package/dist/types/ListTaglines.d.ts

@@ -1,4 +1,7 @@
-export interface ListTaglines {
+/**
+ * Fetches a list of taglines.
+ */
+export type ListTaglines = {
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListTaglinesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { Tagline } from "./Tagline";
-export interface ListTaglinesResponse {
+/**
+ * A response for taglines.
+ */
+export type ListTaglinesResponse = {
     taglines: Array<Tagline>;
-}
+};

package/dist/types/ListingType.d.ts

@@ -1 +1,4 @@
+/**
+ * A listing type for post and comment list fetches.
+ */
 export type ListingType = "All" | "Local" | "Subscribed" | "ModeratorView";

package/dist/types/LocalImage.d.ts

@@ -1,7 +1,7 @@
 import type { LocalUserId } from "./LocalUserId";
-export interface LocalImage {
+export type LocalImage = {
     local_user_id?: LocalUserId;
     pictrs_alias: string;
     pictrs_delete_token: string;
     published: string;
-}
+};

package/dist/types/LocalImageView.d.ts

@@ -1,6 +1,9 @@
 import type { LocalImage } from "./LocalImage";
 import type { Person } from "./Person";
-export interface LocalImageView {
+/**
+ * A local image view.
+ */
+export type LocalImageView = {
     local_image: LocalImage;
     person: Person;
-}
+};

package/dist/types/LocalSite.d.ts

@@ -6,35 +6,111 @@ import type { PostListingMode } from "./PostListingMode";
 import type { PostSortType } from "./PostSortType";
 import type { RegistrationMode } from "./RegistrationMode";
 import type { SiteId } from "./SiteId";
-export interface LocalSite {
+/**
+ * The local site.
+ */
+export type LocalSite = {
     id: LocalSiteId;
     site_id: SiteId;
+    /**
+     * True if the site is set up.
+     */
     site_setup: boolean;
+    /**
+     * Whether only admins can create communities.
+     */
     community_creation_admin_only: boolean;
+    /**
+     * Whether emails are required.
+     */
     require_email_verification: boolean;
+    /**
+     * An optional registration application questionnaire in markdown.
+     */
     application_question?: string;
+    /**
+     * Whether the instance is private or public.
+     */
     private_instance: boolean;
+    /**
+     * The default front-end theme.
+     */
     default_theme: string;
     default_post_listing_type: ListingType;
+    /**
+     * An optional legal disclaimer page.
+     */
     legal_information?: string;
+    /**
+     * Whether to hide mod names on the modlog.
+     */
     hide_modlog_mod_names: boolean;
+    /**
+     * Whether new applications email admins.
+     */
     application_email_admins: boolean;
+    /**
+     * An optional regex to filter words.
+     */
     slur_filter_regex?: string;
+    /**
+     * The max actor name length.
+     */
     actor_name_max_length: number;
+    /**
+     * Whether federation is enabled.
+     */
     federation_enabled: boolean;
+    /**
+     * Whether captcha is enabled.
+     */
     captcha_enabled: boolean;
+    /**
+     * The captcha difficulty.
+     */
     captcha_difficulty: string;
     published: string;
     updated?: string;
     registration_mode: RegistrationMode;
+    /**
+     * Whether to email admins on new reports.
+     */
     reports_email_admins: boolean;
+    /**
+     * Whether to sign outgoing Activitypub fetches with private key of local instance. Some
+     * Fediverse instances and platforms require this.
+     */
     federation_signed_fetch: boolean;
+    /**
+     * Default value for [LocalSite.post_listing_mode]
+     */
     default_post_listing_mode: PostListingMode;
+    /**
+     * Default value for [LocalUser.post_sort_type]
+     */
     default_post_sort_type: PostSortType;
+    /**
+     * Default value for [LocalUser.comment_sort_type]
+     */
     default_comment_sort_type: CommentSortType;
+    /**
+     * Whether or not external auth methods can auto-register users.
+     */
     oauth_registration: boolean;
+    /**
+     * What kind of post upvotes your site allows.
+     */
     post_upvotes: FederationMode;
+    /**
+     * What kind of post downvotes your site allows.
+     */
     post_downvotes: FederationMode;
+    /**
+     * What kind of comment upvotes your site allows.
+     */
     comment_upvotes: FederationMode;
+    /**
+     * What kind of comment downvotes your site allows.
+     */
     comment_downvotes: FederationMode;
-}
+};

package/dist/types/LocalSiteId.d.ts

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

package/dist/types/LocalSiteRateLimit.d.ts

@@ -1,5 +1,8 @@
 import type { LocalSiteId } from "./LocalSiteId";
-export interface LocalSiteRateLimit {
+/**
+ * Rate limits for your site. Given in count / length of time.
+ */
+export type LocalSiteRateLimit = {
     local_site_id: LocalSiteId;
     message: number;
     message_per_second: number;
@@ -17,4 +20,4 @@ export interface LocalSiteRateLimit {
     updated?: string;
     import_user_settings: number;
     import_user_settings_per_second: number;
-}
+};

package/dist/types/LocalSiteUrlBlocklist.d.ts

@@ -1,6 +1,6 @@
-export interface LocalSiteUrlBlocklist {
+export type LocalSiteUrlBlocklist = {
     id: number;
     url: string;
     published: string;
     updated?: string;
-}
+};