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

package/dist/types/EditOAuthProvider.d.ts

@@ -1,14 +1,18 @@
 import type { OAuthProviderId } from "./OAuthProviderId";
-export interface EditOAuthProvider {
+/**
+ * Edit an external auth method.
+ */
+export type EditOAuthProvider = {
     id: OAuthProviderId;
-    display_name: string | null;
-    authorization_endpoint: string | null;
-    token_endpoint: string | null;
-    userinfo_endpoint: string | null;
-    id_claim: string | null;
-    client_secret: string | null;
-    scopes: string | null;
-    auto_verify_email: boolean | null;
-    account_linking_enabled: boolean | null;
-    enabled: boolean | null;
-}
+    display_name?: string;
+    authorization_endpoint?: string;
+    token_endpoint?: string;
+    userinfo_endpoint?: string;
+    id_claim?: string;
+    client_secret?: string;
+    scopes?: string;
+    auto_verify_email?: boolean;
+    account_linking_enabled?: boolean;
+    use_pkce?: boolean;
+    enabled?: boolean;
+};

package/dist/types/EditPost.d.ts

@@ -1,12 +1,30 @@
 import type { LanguageId } from "./LanguageId";
 import type { PostId } from "./PostId";
-export interface EditPost {
+import type { TagId } from "./TagId";
+/**
+ * Edit a post.
+ */
+export type EditPost = {
     post_id: PostId;
     name?: string;
     url?: string;
+    /**
+     * An optional body for the post in markdown.
+     */
     body?: string;
+    /**
+     * An optional alt_text, usable for image posts.
+     */
     alt_text?: 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/EditPrivateMessage.d.ts

@@ -1,5 +1,8 @@
 import type { PrivateMessageId } from "./PrivateMessageId";
-export interface EditPrivateMessage {
+/**
+ * Edit a private message.
+ */
+export type EditPrivateMessage = {
     private_message_id: PrivateMessageId;
     content: string;
-}
+};

package/dist/types/EditSite.d.ts

@@ -1,52 +1,162 @@
+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 EditSite {
+/**
+ * Edits a site.
+ */
+export type EditSite = {
     name?: string;
+    /**
+     * A sidebar for the site, in markdown.
+     */
     sidebar?: string;
+    /**
+     * A shorter, one line description of your site.
+     */
     description?: string;
-    icon?: string;
-    banner?: string;
-    enable_downvotes?: boolean;
-    enable_nsfw?: boolean;
+    /**
+     * Limits community creation to admins only.
+     */
     community_creation_admin_only?: boolean;
+    /**
+     * Whether to require email verification.
+     */
     require_email_verification?: boolean;
+    /**
+     * Your application question form. This is in markdown, and can be many questions.
+     */
     application_question?: string;
+    /**
+     * Whether your instance is public, or private.
+     */
     private_instance?: boolean;
+    /**
+     * The default theme. Usually "browser"
+     */
     default_theme?: string;
+    /**
+     * The default post listing type, usually "local"
+     */
     default_post_listing_type?: ListingType;
-    default_sort_type?: SortType;
+    /**
+     * Default value for listing mode, usually "list"
+     */
+    default_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;
+    /**
+     * An optional page of legal information
+     */
     legal_information?: string;
+    /**
+     * Whether to email admins when receiving a new application.
+     */
     application_email_admins?: boolean;
+    /**
+     * Whether to hide moderator names from the modlog.
+     */
     hide_modlog_mod_names?: boolean;
+    /**
+     * A list of allowed discussion languages.
+     */
     discussion_languages?: Array<LanguageId>;
+    /**
+     * A regex string of items to filter.
+     */
     slur_filter_regex?: string;
+    /**
+     * The max length of actor names.
+     */
     actor_name_max_length?: number;
+    /**
+     * The number of messages allowed in a given time frame.
+     */
     rate_limit_message?: number;
     rate_limit_message_per_second?: number;
+    /**
+     * The number of posts allowed in a given time frame.
+     */
     rate_limit_post?: number;
     rate_limit_post_per_second?: number;
+    /**
+     * The number of registrations allowed in a given time frame.
+     */
     rate_limit_register?: number;
     rate_limit_register_per_second?: number;
+    /**
+     * The number of image uploads allowed in a given time frame.
+     */
     rate_limit_image?: number;
     rate_limit_image_per_second?: number;
+    /**
+     * The number of comments allowed in a given time frame.
+     */
     rate_limit_comment?: number;
     rate_limit_comment_per_second?: number;
+    /**
+     * The number of searches allowed in a given time frame.
+     */
     rate_limit_search?: number;
     rate_limit_search_per_second?: number;
+    /**
+     * Whether to enable federation.
+     */
     federation_enabled?: boolean;
-    federation_debug?: boolean;
+    /**
+     * Whether to enable captchas for signups.
+     */
     captcha_enabled?: boolean;
+    /**
+     * The captcha difficulty. Can be easy, medium, or hard
+     */
     captcha_difficulty?: string;
-    allowed_instances?: Array<string>;
-    blocked_instances?: Array<string>;
+    /**
+     * A list of blocked URLs
+     */
     blocked_urls?: Array<string>;
-    taglines?: Array<string>;
     registration_mode?: RegistrationMode;
-    oauth_registration?: boolean;
+    /**
+     * Whether to email admins for new reports.
+     */
     reports_email_admins?: boolean;
+    /**
+     * 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;
-    default_post_listing_mode?: PostListingMode;
-}
+    /**
+     * 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;
+    /**
+     * If this is true, users will never see the dialog asking to support Lemmy development with
+     * donations.
+     */
+    disable_donation_dialog?: boolean;
+};

package/dist/types/FeaturePost.d.ts

@@ -1,7 +1,10 @@
 import type { PostFeatureType } from "./PostFeatureType";
 import type { PostId } from "./PostId";
-export interface FeaturePost {
+/**
+ * Feature a post (stickies / pins to the top).
+ */
+export type FeaturePost = {
     post_id: PostId;
     featured: boolean;
     feature_type: PostFeatureType;
-}
+};

package/dist/types/FederatedInstances.d.ts

@@ -1,6 +1,9 @@
 import type { InstanceWithFederationState } from "./InstanceWithFederationState";
-export interface FederatedInstances {
+/**
+ * A list of federated instances.
+ */
+export type FederatedInstances = {
     linked: Array<InstanceWithFederationState>;
     allowed: Array<InstanceWithFederationState>;
     blocked: Array<InstanceWithFederationState>;
-}
+};

package/dist/types/FederationBlockList.d.ts

@@ -0,0 +1,7 @@
+import type { InstanceId } from "./InstanceId";
+export type FederationBlockList = {
+    instance_id: InstanceId;
+    published: string;
+    updated?: string;
+    expires?: string;
+};

package/dist/types/FederationError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Federation related errors, these dont need to be translated.
+ */
+export type FederationError = "InvalidCommunity" | "CannotCreatePostOrCommentInDeletedOrRemovedCommunity" | "CannotReceivePage" | "OnlyLocalAdminCanRemoveCommunity" | "OnlyLocalAdminCanRestoreCommunity" | "PostIsLocked" | {
+    PersonIsBannedFromSite: string;
+} | "InvalidVoteValue" | "PageDoesNotSpecifyCreator" | "CouldntGetComments" | "CouldntGetPosts" | "FederationDisabled" | {
+    DomainBlocked: string;
+} | {
+    DomainNotInAllowList: string;
+} | "FederationDisabledByStrictAllowList" | "ContradictingFilters" | "UrlWithoutDomain" | "InboxTimeout" | "CantDeleteSite" | "ObjectIsNotPublic" | "ObjectIsNotPrivate" | "Unreachable";

package/dist/types/FederationError.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/FederationMode.d.ts

@@ -0,0 +1,4 @@
+/**
+ * The federation mode for an item
+ */
+export type FederationMode = "All" | "Local" | "Disable";

package/dist/types/FederationMode.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/FollowCommunity.d.ts

@@ -1,5 +1,8 @@
 import type { CommunityId } from "./CommunityId";
-export interface FollowCommunity {
+/**
+ * Follow / subscribe to a community.
+ */
+export type FollowCommunity = {
     community_id: CommunityId;
     follow: boolean;
-}
+};

package/dist/types/GenerateTotpSecretResponse.d.ts

@@ -1,3 +1,4 @@
-export interface GenerateTotpSecretResponse {
-    totp_secret_url: string;
-}
+import type { SensitiveString } from "./SensitiveString";
+export type GenerateTotpSecretResponse = {
+    totp_secret_url: SensitiveString;
+};

package/dist/types/GenerateTotpSecretResponse.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/GetCaptchaResponse.d.ts

@@ -1,4 +1,10 @@
 import type { CaptchaResponse } from "./CaptchaResponse";
-export interface GetCaptchaResponse {
+/**
+ * A wrapper for the captcha response.
+ */
+export type GetCaptchaResponse = {
+    /**
+     * Will be None if captchas are disabled.
+     */
     ok?: CaptchaResponse;
-}
+};

package/dist/types/GetComment.d.ts

@@ -1,4 +1,7 @@
 import type { CommentId } from "./CommentId";
-export interface GetComment {
+/**
+ * Fetch an individual comment.
+ */
+export type GetComment = {
     id: CommentId;
-}
+};

package/dist/types/GetComments.d.ts

@@ -3,7 +3,10 @@ import type { CommentSortType } from "./CommentSortType";
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { PostId } from "./PostId";
-export interface GetComments {
+/**
+ * Get a list of comments.
+ */
+export type GetComments = {
     type_?: ListingType;
     sort?: CommentSortType;
     max_depth?: number;
@@ -13,7 +16,6 @@ export interface GetComments {
     community_name?: string;
     post_id?: PostId;
     parent_id?: CommentId;
-    saved_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
-}
+};

package/dist/types/GetCommentsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommentView } from "./CommentView";
-export interface GetCommentsResponse {
+/**
+ * The comment list response.
+ */
+export type GetCommentsResponse = {
     comments: Array<CommentView>;
-}
+};

package/dist/types/GetCommentsSlimResponse.d.ts

@@ -0,0 +1,7 @@
+import type { CommentSlimView } from "./CommentSlimView";
+/**
+ * A slimmer comment list response, without the post or community.
+ */
+export type GetCommentsSlimResponse = {
+    comments: Array<CommentSlimView>;
+};

package/dist/types/GetCommunity.d.ts

@@ -1,5 +1,11 @@
 import type { CommunityId } from "./CommunityId";
-export interface GetCommunity {
+/**
+ * Get a community. Must provide either an id, or a name.
+ */
+export type GetCommunity = {
     id?: CommunityId;
+    /**
+     * Example: star_trek , or star_trek@xyz.tld
+     */
     name?: string;
-}
+};

package/dist/types/GetCommunityPendingFollowsCount.d.ts

@@ -0,0 +1,4 @@
+import type { CommunityId } from "./CommunityId";
+export type GetCommunityPendingFollowsCount = {
+    community_id: CommunityId;
+};

package/dist/types/GetCommunityPendingFollowsCountResponse.d.ts

@@ -0,0 +1,3 @@
+export type GetCommunityPendingFollowsCountResponse = {
+    count: number;
+};

package/dist/types/GetCommunityPendingFollowsCountResponse.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/GetCommunityResponse.d.ts

@@ -2,9 +2,12 @@ import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { CommunityView } from "./CommunityView";
 import type { LanguageId } from "./LanguageId";
 import type { Site } from "./Site";
-export interface GetCommunityResponse {
+/**
+ * The community response.
+ */
+export type GetCommunityResponse = {
     community_view: CommunityView;
     site?: Site;
     moderators: Array<CommunityModeratorView>;
     discussion_languages: Array<LanguageId>;
-}
+};

package/dist/types/GetFederatedInstancesResponse.d.ts

@@ -1,4 +1,10 @@
 import type { FederatedInstances } from "./FederatedInstances";
-export interface GetFederatedInstancesResponse {
+/**
+ * A response of federated instances.
+ */
+export type GetFederatedInstancesResponse = {
+    /**
+     * Optional, because federation may be disabled.
+     */
     federated_instances?: FederatedInstances;
-}
+};

package/dist/types/GetModlog.d.ts

@@ -1,15 +1,19 @@
 import type { CommentId } from "./CommentId";
 import type { CommunityId } from "./CommunityId";
 import type { ModlogActionType } from "./ModlogActionType";
+import type { ModlogCombinedPaginationCursor } from "./ModlogCombinedPaginationCursor";
 import type { PersonId } from "./PersonId";
 import type { PostId } from "./PostId";
-export interface GetModlog {
+/**
+ * Fetches the modlog.
+ */
+export type GetModlog = {
     mod_person_id?: PersonId;
     community_id?: CommunityId;
-    page?: number;
-    limit?: number;
     type_?: ModlogActionType;
     other_person_id?: PersonId;
     post_id?: PostId;
     comment_id?: CommentId;
-}
+    page_cursor?: ModlogCombinedPaginationCursor;
+    page_back?: boolean;
+};

package/dist/types/GetModlogResponse.d.ts

@@ -1,32 +1,7 @@
-import type { AdminPurgeCommentView } from "./AdminPurgeCommentView";
-import type { AdminPurgeCommunityView } from "./AdminPurgeCommunityView";
-import type { AdminPurgePersonView } from "./AdminPurgePersonView";
-import type { AdminPurgePostView } from "./AdminPurgePostView";
-import type { ModAddCommunityView } from "./ModAddCommunityView";
-import type { ModAddView } from "./ModAddView";
-import type { ModBanFromCommunityView } from "./ModBanFromCommunityView";
-import type { ModBanView } from "./ModBanView";
-import type { ModFeaturePostView } from "./ModFeaturePostView";
-import type { ModHideCommunityView } from "./ModHideCommunityView";
-import type { ModLockPostView } from "./ModLockPostView";
-import type { ModRemoveCommentView } from "./ModRemoveCommentView";
-import type { ModRemoveCommunityView } from "./ModRemoveCommunityView";
-import type { ModRemovePostView } from "./ModRemovePostView";
-import type { ModTransferCommunityView } from "./ModTransferCommunityView";
-export interface GetModlogResponse {
-    removed_posts: Array<ModRemovePostView>;
-    locked_posts: Array<ModLockPostView>;
-    featured_posts: Array<ModFeaturePostView>;
-    removed_comments: Array<ModRemoveCommentView>;
-    removed_communities: Array<ModRemoveCommunityView>;
-    banned_from_community: Array<ModBanFromCommunityView>;
-    banned: Array<ModBanView>;
-    added_to_community: Array<ModAddCommunityView>;
-    transferred_to_community: Array<ModTransferCommunityView>;
-    added: Array<ModAddView>;
-    admin_purged_persons: Array<AdminPurgePersonView>;
-    admin_purged_communities: Array<AdminPurgeCommunityView>;
-    admin_purged_posts: Array<AdminPurgePostView>;
-    admin_purged_comments: Array<AdminPurgeCommentView>;
-    hidden_communities: Array<ModHideCommunityView>;
-}
+import type { ModlogCombinedView } from "./ModlogCombinedView";
+/**
+ * The modlog fetch response.
+ */
+export type GetModlogResponse = {
+    modlog: Array<ModlogCombinedView>;
+};

package/dist/types/GetPersonDetails.d.ts

@@ -1,12 +1,13 @@
-import type { CommunityId } from "./CommunityId";
 import type { PersonId } from "./PersonId";
-import type { SortType } from "./SortType";
-export interface GetPersonDetails {
+/**
+ * Gets a person's details.
+ *
+ * Either person_id, or username are required.
+ */
+export type GetPersonDetails = {
     person_id?: PersonId;
+    /**
+     * Example: dessalines , or dessalines@xyz.tld
+     */
     username?: string;
-    sort?: SortType;
-    page?: number;
-    limit?: number;
-    community_id?: CommunityId;
-    saved_only?: boolean;
-}
+};

package/dist/types/GetPersonDetailsResponse.d.ts

@@ -1,12 +1,11 @@
-import type { CommentView } from "./CommentView";
 import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { PersonView } from "./PersonView";
-import type { PostView } from "./PostView";
 import type { Site } from "./Site";
-export interface GetPersonDetailsResponse {
+/**
+ * A person's details response.
+ */
+export type GetPersonDetailsResponse = {
     person_view: PersonView;
     site?: Site;
-    comments: Array<CommentView>;
-    posts: Array<PostView>;
     moderates: Array<CommunityModeratorView>;
-}
+};

package/dist/types/GetPost.d.ts

@@ -1,6 +1,9 @@
 import type { CommentId } from "./CommentId";
 import type { PostId } from "./PostId";
-export interface GetPost {
+/**
+ * Get a post. Needs either the post id, or comment_id.
+ */
+export type GetPost = {
     id?: PostId;
     comment_id?: CommentId;
-}
+};

package/dist/types/GetPostResponse.d.ts

@@ -1,9 +1,15 @@
 import type { CommunityModeratorView } from "./CommunityModeratorView";
 import type { CommunityView } from "./CommunityView";
 import type { PostView } from "./PostView";
-export interface GetPostResponse {
+/**
+ * The post response.
+ */
+export type GetPostResponse = {
     post_view: PostView;
     community_view: CommunityView;
     moderators: Array<CommunityModeratorView>;
+    /**
+     * A list of cross-posts, or other times / communities this link has been posted to.
+     */
     cross_posts: Array<PostView>;
-}
+};

package/dist/types/GetPosts.d.ts

@@ -1,19 +1,45 @@
 import type { CommunityId } from "./CommunityId";
 import type { ListingType } from "./ListingType";
 import type { PaginationCursor } from "./PaginationCursor";
-import type { SortType } from "./SortType";
-export interface GetPosts {
+import type { PostSortType } from "./PostSortType";
+/**
+ * Get a list of posts.
+ */
+export type GetPosts = {
     type_?: ListingType;
-    sort?: SortType;
+    sort?: PostSortType;
+    /**
+     * DEPRECATED, use page_cursor
+     */
     page?: number;
     limit?: number;
     community_id?: CommunityId;
     community_name?: string;
     saved_only?: boolean;
+    read_only?: boolean;
     liked_only?: boolean;
     disliked_only?: boolean;
     show_hidden?: boolean;
+    /**
+     * If true, then show the read posts (even if your user setting is to hide them)
+     */
     show_read?: boolean;
+    /**
+     * If true, then show the nsfw posts (even if your user setting is to hide them)
+     */
     show_nsfw?: boolean;
+    /**
+     * If false, then show posts with media attached (even if your user setting is to hide them)
+     */
+    hide_media?: boolean;
+    /**
+     * Whether to automatically mark fetched posts as read.
+     */
+    mark_as_read?: boolean;
+    /**
+     * If true, then only show posts with no comments
+     */
+    no_comments_only?: boolean;
     page_cursor?: PaginationCursor;
-}
+    page_back?: boolean;
+};